[PATCH] OOM killer meets userspace headers
[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/oom.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 #include <linux/module.h>
26 #include <linux/notifier.h>
27
28 int sysctl_panic_on_oom;
29 /* #define DEBUG */
30
31 /**
32  * badness - calculate a numeric value for how bad this task has been
33  * @p: task struct of which task we should calculate
34  * @uptime: current uptime in seconds
35  *
36  * The formula used is relatively simple and documented inline in the
37  * function. The main rationale is that we want to select a good task
38  * to kill when we run out of memory.
39  *
40  * Good in this context means that:
41  * 1) we lose the minimum amount of work done
42  * 2) we recover a large amount of memory
43  * 3) we don't kill anything innocent of eating tons of memory
44  * 4) we want to kill the minimum amount of processes (one)
45  * 5) we try to kill the process the user expects us to kill, this
46  *    algorithm has been meticulously tuned to meet the principle
47  *    of least surprise ... (be careful when you change it)
48  */
49
50 unsigned long badness(struct task_struct *p, unsigned long uptime)
51 {
52         unsigned long points, cpu_time, run_time, s;
53         struct mm_struct *mm;
54         struct task_struct *child;
55
56         task_lock(p);
57         mm = p->mm;
58         if (!mm) {
59                 task_unlock(p);
60                 return 0;
61         }
62
63         /*
64          * swapoff can easily use up all memory, so kill those first.
65          */
66         if (p->flags & PF_SWAPOFF)
67                 return ULONG_MAX;
68
69         /*
70          * The memory size of the process is the basis for the badness.
71          */
72         points = mm->total_vm;
73
74         /*
75          * After this unlock we can no longer dereference local variable `mm'
76          */
77         task_unlock(p);
78
79         /*
80          * Processes which fork a lot of child processes are likely
81          * a good choice. We add half the vmsize of the children if they
82          * have an own mm. This prevents forking servers to flood the
83          * machine with an endless amount of children. In case a single
84          * child is eating the vast majority of memory, adding only half
85          * to the parents will make the child our kill candidate of choice.
86          */
87         list_for_each_entry(child, &p->children, sibling) {
88                 task_lock(child);
89                 if (child->mm != mm && child->mm)
90                         points += child->mm->total_vm/2 + 1;
91                 task_unlock(child);
92         }
93
94         /*
95          * CPU time is in tens of seconds and run time is in thousands
96          * of seconds. There is no particular reason for this other than
97          * that it turned out to work very well in practice.
98          */
99         cpu_time = (cputime_to_jiffies(p->utime) + cputime_to_jiffies(p->stime))
100                 >> (SHIFT_HZ + 3);
101
102         if (uptime >= p->start_time.tv_sec)
103                 run_time = (uptime - p->start_time.tv_sec) >> 10;
104         else
105                 run_time = 0;
106
107         s = int_sqrt(cpu_time);
108         if (s)
109                 points /= s;
110         s = int_sqrt(int_sqrt(run_time));
111         if (s)
112                 points /= s;
113
114         /*
115          * Niced processes are most likely less important, so double
116          * their badness points.
117          */
118         if (task_nice(p) > 0)
119                 points *= 2;
120
121         /*
122          * Superuser processes are usually more important, so we make it
123          * less likely that we kill those.
124          */
125         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_ADMIN) ||
126                                 p->uid == 0 || p->euid == 0)
127                 points /= 4;
128
129         /*
130          * We don't want to kill a process with direct hardware access.
131          * Not only could that mess up the hardware, but usually users
132          * tend to only have this flag set on applications they think
133          * of as important.
134          */
135         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_RAWIO))
136                 points /= 4;
137
138         /*
139          * If p's nodes don't overlap ours, it may still help to kill p
140          * because p may have allocated or otherwise mapped memory on
141          * this node before. However it will be less likely.
142          */
143         if (!cpuset_excl_nodes_overlap(p))
144                 points /= 8;
145
146         /*
147          * Adjust the score by oomkilladj.
148          */
149         if (p->oomkilladj) {
150                 if (p->oomkilladj > 0)
151                         points <<= p->oomkilladj;
152                 else
153                         points >>= -(p->oomkilladj);
154         }
155
156 #ifdef DEBUG
157         printk(KERN_DEBUG "OOMkill: task %d (%s) got %d points\n",
158         p->pid, p->comm, points);
159 #endif
160         return points;
161 }
162
163 /*
164  * Types of limitations to the nodes from which allocations may occur
165  */
166 #define CONSTRAINT_NONE 1
167 #define CONSTRAINT_MEMORY_POLICY 2
168 #define CONSTRAINT_CPUSET 3
169
170 /*
171  * Determine the type of allocation constraint.
172  */
173 static inline int constrained_alloc(struct zonelist *zonelist, gfp_t gfp_mask)
174 {
175 #ifdef CONFIG_NUMA
176         struct zone **z;
177         nodemask_t nodes = node_online_map;
178
179         for (z = zonelist->zones; *z; z++)
180                 if (cpuset_zone_allowed(*z, gfp_mask))
181                         node_clear(zone_to_nid(*z), nodes);
182                 else
183                         return CONSTRAINT_CPUSET;
184
185         if (!nodes_empty(nodes))
186                 return CONSTRAINT_MEMORY_POLICY;
187 #endif
188
189         return CONSTRAINT_NONE;
190 }
191
192 /*
193  * Simple selection loop. We chose the process with the highest
194  * number of 'points'. We expect the caller will lock the tasklist.
195  *
196  * (not docbooked, we don't want this one cluttering up the manual)
197  */
198 static struct task_struct *select_bad_process(unsigned long *ppoints)
199 {
200         struct task_struct *g, *p;
201         struct task_struct *chosen = NULL;
202         struct timespec uptime;
203         *ppoints = 0;
204
205         do_posix_clock_monotonic_gettime(&uptime);
206         do_each_thread(g, p) {
207                 unsigned long points;
208
209                 /*
210                  * skip kernel threads and tasks which have already released
211                  * their mm.
212                  */
213                 if (!p->mm)
214                         continue;
215                 /* skip the init task */
216                 if (is_init(p))
217                         continue;
218
219                 /*
220                  * This task already has access to memory reserves and is
221                  * being killed. Don't allow any other task access to the
222                  * memory reserve.
223                  *
224                  * Note: this may have a chance of deadlock if it gets
225                  * blocked waiting for another task which itself is waiting
226                  * for memory. Is there a better alternative?
227                  */
228                 if (test_tsk_thread_flag(p, TIF_MEMDIE))
229                         return ERR_PTR(-1UL);
230
231                 /*
232                  * This is in the process of releasing memory so wait for it
233                  * to finish before killing some other task by mistake.
234                  *
235                  * However, if p is the current task, we allow the 'kill' to
236                  * go ahead if it is exiting: this will simply set TIF_MEMDIE,
237                  * which will allow it to gain access to memory reserves in
238                  * the process of exiting and releasing its resources.
239                  * Otherwise we could get an easy OOM deadlock.
240                  */
241                 if (p->flags & PF_EXITING) {
242                         if (p != current)
243                                 return ERR_PTR(-1UL);
244
245                         chosen = p;
246                         *ppoints = ULONG_MAX;
247                 }
248
249                 if (p->oomkilladj == OOM_DISABLE)
250                         continue;
251
252                 points = badness(p, uptime.tv_sec);
253                 if (points > *ppoints || !chosen) {
254                         chosen = p;
255                         *ppoints = points;
256                 }
257         } while_each_thread(g, p);
258
259         return chosen;
260 }
261
262 /**
263  * Send SIGKILL to the selected  process irrespective of  CAP_SYS_RAW_IO
264  * flag though it's unlikely that  we select a process with CAP_SYS_RAW_IO
265  * set.
266  */
267 static void __oom_kill_task(struct task_struct *p, const char *message)
268 {
269         if (is_init(p)) {
270                 WARN_ON(1);
271                 printk(KERN_WARNING "tried to kill init!\n");
272                 return;
273         }
274
275         if (!p->mm) {
276                 WARN_ON(1);
277                 printk(KERN_WARNING "tried to kill an mm-less task!\n");
278                 return;
279         }
280
281         if (message) {
282                 printk(KERN_ERR "%s: Killed process %d (%s).\n",
283                                 message, p->pid, p->comm);
284         }
285
286         /*
287          * We give our sacrificial lamb high priority and access to
288          * all the memory it needs. That way it should be able to
289          * exit() and clear out its resources quickly...
290          */
291         p->time_slice = HZ;
292         set_tsk_thread_flag(p, TIF_MEMDIE);
293
294         force_sig(SIGKILL, p);
295 }
296
297 static int oom_kill_task(struct task_struct *p, const char *message)
298 {
299         struct mm_struct *mm;
300         struct task_struct *g, *q;
301
302         mm = p->mm;
303
304         /* WARNING: mm may not be dereferenced since we did not obtain its
305          * value from get_task_mm(p).  This is OK since all we need to do is
306          * compare mm to q->mm below.
307          *
308          * Furthermore, even if mm contains a non-NULL value, p->mm may
309          * change to NULL at any time since we do not hold task_lock(p).
310          * However, this is of no concern to us.
311          */
312
313         if (mm == NULL)
314                 return 1;
315
316         __oom_kill_task(p, message);
317         /*
318          * kill all processes that share the ->mm (i.e. all threads),
319          * but are in a different thread group
320          */
321         do_each_thread(g, q)
322                 if (q->mm == mm && q->tgid != p->tgid)
323                         __oom_kill_task(q, message);
324         while_each_thread(g, q);
325
326         return 0;
327 }
328
329 static int oom_kill_process(struct task_struct *p, unsigned long points,
330                 const char *message)
331 {
332         struct task_struct *c;
333         struct list_head *tsk;
334
335         /*
336          * If the task is already exiting, don't alarm the sysadmin or kill
337          * its children or threads, just set TIF_MEMDIE so it can die quickly
338          */
339         if (p->flags & PF_EXITING) {
340                 __oom_kill_task(p, NULL);
341                 return 0;
342         }
343
344         printk(KERN_ERR "Out of Memory: Kill process %d (%s) score %li"
345                         " and children.\n", p->pid, p->comm, points);
346         /* Try to kill a child first */
347         list_for_each(tsk, &p->children) {
348                 c = list_entry(tsk, struct task_struct, sibling);
349                 if (c->mm == p->mm)
350                         continue;
351                 if (!oom_kill_task(c, message))
352                         return 0;
353         }
354         return oom_kill_task(p, message);
355 }
356
357 static BLOCKING_NOTIFIER_HEAD(oom_notify_list);
358
359 int register_oom_notifier(struct notifier_block *nb)
360 {
361         return blocking_notifier_chain_register(&oom_notify_list, nb);
362 }
363 EXPORT_SYMBOL_GPL(register_oom_notifier);
364
365 int unregister_oom_notifier(struct notifier_block *nb)
366 {
367         return blocking_notifier_chain_unregister(&oom_notify_list, nb);
368 }
369 EXPORT_SYMBOL_GPL(unregister_oom_notifier);
370
371 /**
372  * out_of_memory - kill the "best" process when we run out of memory
373  *
374  * If we run out of memory, we have the choice between either
375  * killing a random task (bad), letting the system crash (worse)
376  * OR try to be smart about which process to kill. Note that we
377  * don't have to be perfect here, we just have to be good.
378  */
379 void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order)
380 {
381         struct task_struct *p;
382         unsigned long points = 0;
383         unsigned long freed = 0;
384
385         blocking_notifier_call_chain(&oom_notify_list, 0, &freed);
386         if (freed > 0)
387                 /* Got some memory back in the last second. */
388                 return;
389
390         if (printk_ratelimit()) {
391                 printk(KERN_WARNING "%s invoked oom-killer: "
392                         "gfp_mask=0x%x, order=%d, oomkilladj=%d\n",
393                         current->comm, gfp_mask, order, current->oomkilladj);
394                 dump_stack();
395                 show_mem();
396         }
397
398         cpuset_lock();
399         read_lock(&tasklist_lock);
400
401         /*
402          * Check if there were limitations on the allocation (only relevant for
403          * NUMA) that may require different handling.
404          */
405         switch (constrained_alloc(zonelist, gfp_mask)) {
406         case CONSTRAINT_MEMORY_POLICY:
407                 oom_kill_process(current, points,
408                                 "No available memory (MPOL_BIND)");
409                 break;
410
411         case CONSTRAINT_CPUSET:
412                 oom_kill_process(current, points,
413                                 "No available memory in cpuset");
414                 break;
415
416         case CONSTRAINT_NONE:
417                 if (sysctl_panic_on_oom)
418                         panic("out of memory. panic_on_oom is selected\n");
419 retry:
420                 /*
421                  * Rambo mode: Shoot down a process and hope it solves whatever
422                  * issues we may have.
423                  */
424                 p = select_bad_process(&points);
425
426                 if (PTR_ERR(p) == -1UL)
427                         goto out;
428
429                 /* Found nothing?!?! Either we hang forever, or we panic. */
430                 if (!p) {
431                         read_unlock(&tasklist_lock);
432                         cpuset_unlock();
433                         panic("Out of memory and no killable processes...\n");
434                 }
435
436                 if (oom_kill_process(p, points, "Out of memory"))
437                         goto retry;
438
439                 break;
440         }
441
442 out:
443         read_unlock(&tasklist_lock);
444         cpuset_unlock();
445
446         /*
447          * Give "p" a good chance of killing itself before we
448          * retry to allocate memory unless "p" is current
449          */
450         if (!test_thread_flag(TIF_MEMDIE))
451                 schedule_timeout_uninterruptible(1);
452 }