linux 2.6.16.38 w/ vs2.0.3-rc1
[linux-2.6.git] / mm / oom_kill.c
1 /*
2  *  linux/mm/oom_kill.c
3  * 
4  *  Copyright (C)  1998,2000  Rik van Riel
5  *      Thanks go out to Claus Fischer for some serious inspiration and
6  *      for goading me into coding this file...
7  *
8  *  The routines in this file are used to kill a process when
9  *  we're seriously out of memory. This gets called from __alloc_pages()
10  *  in mm/page_alloc.c when we really run out of memory.
11  *
12  *  Since we won't call these routines often (on a well-configured
13  *  machine) this file will double as a 'coding guide' and a signpost
14  *  for newbie kernel hackers. It features several pointers to major
15  *  kernel subsystems and hints as to where to find out what things do.
16  */
17
18 #include <linux/config.h>
19 #include <linux/mm.h>
20 #include <linux/sched.h>
21 #include <linux/swap.h>
22 #include <linux/timex.h>
23 #include <linux/jiffies.h>
24 #include <linux/cpuset.h>
25
26 /* #define DEBUG */
27
28 /**
29  * oom_badness - calculate a numeric value for how bad this task has been
30  * @p: task struct of which task we should calculate
31  * @uptime: current uptime in seconds
32  *
33  * The formula used is relatively simple and documented inline in the
34  * function. The main rationale is that we want to select a good task
35  * to kill when we run out of memory.
36  *
37  * Good in this context means that:
38  * 1) we lose the minimum amount of work done
39  * 2) we recover a large amount of memory
40  * 3) we don't kill anything innocent of eating tons of memory
41  * 4) we want to kill the minimum amount of processes (one)
42  * 5) we try to kill the process the user expects us to kill, this
43  *    algorithm has been meticulously tuned to meet the principle
44  *    of least surprise ... (be careful when you change it)
45  */
46
47 unsigned long badness(struct task_struct *p, unsigned long uptime)
48 {
49         unsigned long points, cpu_time, run_time, s;
50         struct list_head *tsk;
51
52         if (!p->mm)
53                 return 0;
54
55         /*
56          * The memory size of the process is the basis for the badness.
57          */
58         points = p->mm->total_vm;
59         /* FIXME: add vserver badness ;) */
60
61         /*
62          * Processes which fork a lot of child processes are likely
63          * a good choice. We add half the vmsize of the children if they
64          * have an own mm. This prevents forking servers to flood the
65          * machine with an endless amount of children. In case a single
66          * child is eating the vast majority of memory, adding only half
67          * to the parents will make the child our kill candidate of choice.
68          */
69         list_for_each(tsk, &p->children) {
70                 struct task_struct *chld;
71                 chld = list_entry(tsk, struct task_struct, sibling);
72                 if (chld->mm != p->mm && chld->mm)
73                         points += chld->mm->total_vm/2 + 1;
74         }
75
76         /*
77          * CPU time is in tens of seconds and run time is in thousands
78          * of seconds. There is no particular reason for this other than
79          * that it turned out to work very well in practice.
80          */
81         cpu_time = (cputime_to_jiffies(p->utime) + cputime_to_jiffies(p->stime))
82                 >> (SHIFT_HZ + 3);
83
84         if (uptime >= p->start_time.tv_sec)
85                 run_time = (uptime - p->start_time.tv_sec) >> 10;
86         else
87                 run_time = 0;
88
89         s = int_sqrt(cpu_time);
90         if (s)
91                 points /= s;
92         s = int_sqrt(int_sqrt(run_time));
93         if (s)
94                 points /= s;
95
96         /*
97          * Niced processes are most likely less important, so double
98          * their badness points.
99          */
100         if (task_nice(p) > 0)
101                 points *= 2;
102
103         /*
104          * Superuser processes are usually more important, so we make it
105          * less likely that we kill those.
106          */
107         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_ADMIN) ||
108                                 p->uid == 0 || p->euid == 0)
109                 points /= 4;
110
111         /*
112          * We don't want to kill a process with direct hardware access.
113          * Not only could that mess up the hardware, but usually users
114          * tend to only have this flag set on applications they think
115          * of as important.
116          */
117         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_RAWIO))
118                 points /= 4;
119
120         /*
121          * Adjust the score by oomkilladj.
122          */
123         if (p->oomkilladj) {
124                 if (p->oomkilladj > 0)
125                         points <<= p->oomkilladj;
126                 else
127                         points >>= -(p->oomkilladj);
128         }
129
130 #ifdef DEBUG
131         printk(KERN_DEBUG "OOMkill: task %d (%s) got %d points\n",
132         p->pid, p->comm, points);
133 #endif
134         return points;
135 }
136
137 #if defined(CONFIG_OOM_PANIC) && defined(CONFIG_OOM_KILLER)
138 #warning Only define OOM_PANIC or OOM_KILLER; not both
139 #endif
140
141 #ifdef CONFIG_OOM_KILLER
142 /*
143  * Types of limitations to the nodes from which allocations may occur
144  */
145 #define CONSTRAINT_NONE 1
146 #define CONSTRAINT_MEMORY_POLICY 2
147 #define CONSTRAINT_CPUSET 3
148
149 /*
150  * Determine the type of allocation constraint.
151  */
152 static inline int constrained_alloc(struct zonelist *zonelist, gfp_t gfp_mask)
153 {
154 #ifdef CONFIG_NUMA
155         struct zone **z;
156         nodemask_t nodes = node_online_map;
157
158         for (z = zonelist->zones; *z; z++)
159                 if (cpuset_zone_allowed(*z, gfp_mask))
160                         node_clear((*z)->zone_pgdat->node_id,
161                                         nodes);
162                 else
163                         return CONSTRAINT_CPUSET;
164
165         if (!nodes_empty(nodes))
166                 return CONSTRAINT_MEMORY_POLICY;
167 #endif
168
169         return CONSTRAINT_NONE;
170 }
171
172 /*
173  * Simple selection loop. We chose the process with the highest
174  * number of 'points'. We expect the caller will lock the tasklist.
175  *
176  * (not docbooked, we don't want this one cluttering up the manual)
177  */
178 static struct task_struct *select_bad_process(unsigned long *ppoints)
179 {
180         struct task_struct *g, *p;
181         struct task_struct *chosen = NULL;
182         struct timespec uptime;
183         *ppoints = 0;
184
185         do_posix_clock_monotonic_gettime(&uptime);
186         do_each_thread(g, p) {
187                 unsigned long points;
188                 int releasing;
189
190                 /* skip the init task with pid == 1 */
191                 if (p->pid == 1)
192                         continue;
193                 if (p->oomkilladj == OOM_DISABLE)
194                         continue;
195                 /* If p's nodes don't overlap ours, it won't help to kill p. */
196                 if (!cpuset_excl_nodes_overlap(p))
197                         continue;
198
199                 /*
200                  * This is in the process of releasing memory so for wait it
201                  * to finish before killing some other task by mistake.
202                  */
203                 releasing = test_tsk_thread_flag(p, TIF_MEMDIE) ||
204                                                 p->flags & PF_EXITING;
205                 if (releasing && !(p->flags & PF_DEAD))
206                         return ERR_PTR(-1UL);
207                 if (p->flags & PF_SWAPOFF)
208                         return p;
209
210                 points = badness(p, uptime.tv_sec);
211                 if (points > *ppoints || !chosen) {
212                         chosen = p;
213                         *ppoints = points;
214                 }
215         } while_each_thread(g, p);
216         return chosen;
217 }
218
219 /**
220  * We must be careful though to never send SIGKILL a process with
221  * CAP_SYS_RAW_IO set, send SIGTERM instead (but it's unlikely that
222  * we select a process with CAP_SYS_RAW_IO set).
223  */
224 static void __oom_kill_task(task_t *p, const char *message)
225 {
226         if (p->pid == 1) {
227                 WARN_ON(1);
228                 printk(KERN_WARNING "tried to kill init!\n");
229                 return;
230         }
231
232         task_lock(p);
233         if (!p->mm || p->mm == &init_mm) {
234                 WARN_ON(1);
235                 printk(KERN_WARNING "tried to kill an mm-less task!\n");
236                 task_unlock(p);
237                 return;
238         }
239         task_unlock(p);
240         printk(KERN_ERR "%s: Killed process %d (%s).\n",
241                                 message, p->pid, p->comm);
242
243         /*
244          * We give our sacrificial lamb high priority and access to
245          * all the memory it needs. That way it should be able to
246          * exit() and clear out its resources quickly...
247          */
248         p->time_slice = HZ;
249         set_tsk_thread_flag(p, TIF_MEMDIE);
250
251         force_sig(SIGKILL, p);
252 }
253
254 static struct mm_struct *oom_kill_task(task_t *p, const char *message)
255 {
256         struct mm_struct *mm = get_task_mm(p);
257         task_t * g, * q;
258
259         if (!mm)
260                 return NULL;
261         if (mm == &init_mm) {
262                 mmput(mm);
263                 return NULL;
264         }
265
266         __oom_kill_task(p, message);
267         /*
268          * kill all processes that share the ->mm (i.e. all threads),
269          * but are in a different thread group
270          */
271         do_each_thread(g, q)
272                 if (q->mm == mm && q->tgid != p->tgid)
273                         __oom_kill_task(q, message);
274         while_each_thread(g, q);
275
276         return mm;
277 }
278
279 static struct mm_struct *oom_kill_process(struct task_struct *p,
280                                 unsigned long points, const char *message)
281 {
282         struct mm_struct *mm;
283         struct task_struct *c;
284         struct list_head *tsk;
285
286         printk(KERN_ERR "Out of Memory: Kill process %d (%s) score %li and "
287                 "children.\n", p->pid, p->comm, points);
288         /* Try to kill a child first */
289         list_for_each(tsk, &p->children) {
290                 c = list_entry(tsk, struct task_struct, sibling);
291                 if (c->mm == p->mm)
292                         continue;
293                 mm = oom_kill_task(c, message);
294                 if (mm)
295                         return mm;
296         }
297         return oom_kill_task(p, message);
298 }
299
300 /**
301  * oom_kill - kill the "best" process when we run out of memory
302  *
303  * If we run out of memory, we have the choice between either
304  * killing a random task (bad), letting the system crash (worse)
305  * OR try to be smart about which process to kill. Note that we
306  * don't have to be perfect here, we just have to be good.
307  */
308 void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order)
309 {
310         struct mm_struct *mm = NULL;
311         task_t *p;
312         unsigned long points = 0;
313
314         if (printk_ratelimit()) {
315                 printk("oom-killer: gfp_mask=0x%x, order=%d\n",
316                         gfp_mask, order);
317                 dump_stack();
318                 show_mem();
319         }
320
321         cpuset_lock();
322         read_lock(&tasklist_lock);
323
324         /*
325          * Check if there were limitations on the allocation (only relevant for
326          * NUMA) that may require different handling.
327          */
328         switch (constrained_alloc(zonelist, gfp_mask)) {
329         case CONSTRAINT_MEMORY_POLICY:
330                 mm = oom_kill_process(current, points,
331                                 "No available memory (MPOL_BIND)");
332                 break;
333
334         case CONSTRAINT_CPUSET:
335                 mm = oom_kill_process(current, points,
336                                 "No available memory in cpuset");
337                 break;
338
339         case CONSTRAINT_NONE:
340 retry:
341                 /*
342                  * Rambo mode: Shoot down a process and hope it solves whatever
343                  * issues we may have.
344                  */
345                 p = select_bad_process(&points);
346
347                 if (PTR_ERR(p) == -1UL)
348                         goto out;
349
350                 /* Found nothing?!?! Either we hang forever, or we panic. */
351                 if (!p) {
352                         read_unlock(&tasklist_lock);
353                         cpuset_unlock();
354                         panic("Out of memory and no killable processes...\n");
355                 }
356
357                 mm = oom_kill_process(p, points, "Out of memory");
358                 if (!mm)
359                         goto retry;
360
361                 break;
362         }
363
364 out:
365         read_unlock(&tasklist_lock);
366         cpuset_unlock();
367         if (mm)
368                 mmput(mm);
369
370         /*
371          * Give "p" a good chance of killing itself before we
372          * retry to allocate memory unless "p" is current
373          */
374         if (!test_thread_flag(TIF_MEMDIE))
375                 schedule_timeout_uninterruptible(1);
376 }
377 #endif /* CONFIG_OOM_KILLER */
378
379 #ifdef CONFIG_OOM_PANIC
380 /**
381  * out_of_memory - panic if the system out of memory?
382  */
383 void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order)
384 {
385         /*
386          * oom_lock protects out_of_memory()'s static variables.
387          * It's a global lock; this is not performance-critical.
388          */
389         static spinlock_t oom_lock = SPIN_LOCK_UNLOCKED;
390         static unsigned long count;
391
392         spin_lock(&oom_lock);
393
394         /*
395          * If we have gotten only a few failures,
396          * we're not really oom. 
397          */
398         if (++count >= 10) {
399                 /*
400                  * Ok, really out of memory. Panic.
401                  */
402
403                 printk("oom-killer: gfp_mask=0x%x\n", gfp_mask);
404                 show_free_areas();
405
406                 panic("Out Of Memory");
407         }
408         spin_unlock(&oom_lock);
409 }
410 #endif /*  CONFIG_OOM_PANIC */