oom: prevent livelock when oom_kill_allocating_task is set
[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/err.h>
21 #include <linux/sched.h>
22 #include <linux/swap.h>
23 #include <linux/timex.h>
24 #include <linux/jiffies.h>
25 #include <linux/cpuset.h>
26 #include <linux/module.h>
27 #include <linux/notifier.h>
28 #include <linux/memcontrol.h>
29 #include <linux/security.h>
30
31 int sysctl_panic_on_oom;
32 int sysctl_oom_kill_allocating_task;
33 int sysctl_oom_dump_tasks;
34 static DEFINE_SPINLOCK(zone_scan_lock);
35 /* #define DEBUG */
36
37 /**
38  * badness - calculate a numeric value for how bad this task has been
39  * @p: task struct of which task we should calculate
40  * @uptime: current uptime in seconds
41  *
42  * The formula used is relatively simple and documented inline in the
43  * function. The main rationale is that we want to select a good task
44  * to kill when we run out of memory.
45  *
46  * Good in this context means that:
47  * 1) we lose the minimum amount of work done
48  * 2) we recover a large amount of memory
49  * 3) we don't kill anything innocent of eating tons of memory
50  * 4) we want to kill the minimum amount of processes (one)
51  * 5) we try to kill the process the user expects us to kill, this
52  *    algorithm has been meticulously tuned to meet the principle
53  *    of least surprise ... (be careful when you change it)
54  */
55
56 unsigned long badness(struct task_struct *p, unsigned long uptime)
57 {
58         unsigned long points, cpu_time, run_time;
59         struct mm_struct *mm;
60         struct task_struct *child;
61
62         task_lock(p);
63         mm = p->mm;
64         if (!mm) {
65                 task_unlock(p);
66                 return 0;
67         }
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          * swapoff can easily use up all memory, so kill those first.
81          */
82         if (p->flags & PF_SWAPOFF)
83                 return ULONG_MAX;
84
85         /*
86          * Processes which fork a lot of child processes are likely
87          * a good choice. We add half the vmsize of the children if they
88          * have an own mm. This prevents forking servers to flood the
89          * machine with an endless amount of children. In case a single
90          * child is eating the vast majority of memory, adding only half
91          * to the parents will make the child our kill candidate of choice.
92          */
93         list_for_each_entry(child, &p->children, sibling) {
94                 task_lock(child);
95                 if (child->mm != mm && child->mm)
96                         points += child->mm->total_vm/2 + 1;
97                 task_unlock(child);
98         }
99
100         /*
101          * CPU time is in tens of seconds and run time is in thousands
102          * of seconds. There is no particular reason for this other than
103          * that it turned out to work very well in practice.
104          */
105         cpu_time = (cputime_to_jiffies(p->utime) + cputime_to_jiffies(p->stime))
106                 >> (SHIFT_HZ + 3);
107
108         if (uptime >= p->start_time.tv_sec)
109                 run_time = (uptime - p->start_time.tv_sec) >> 10;
110         else
111                 run_time = 0;
112
113         if (cpu_time)
114                 points /= int_sqrt(cpu_time);
115         if (run_time)
116                 points /= int_sqrt(int_sqrt(run_time));
117
118         /*
119          * Niced processes are most likely less important, so double
120          * their badness points.
121          */
122         if (task_nice(p) > 0)
123                 points *= 2;
124
125         /*
126          * Superuser processes are usually more important, so we make it
127          * less likely that we kill those.
128          */
129         if (has_capability_noaudit(p, CAP_SYS_ADMIN) ||
130             has_capability_noaudit(p, CAP_SYS_RESOURCE))
131                 points /= 4;
132
133         /*
134          * We don't want to kill a process with direct hardware access.
135          * Not only could that mess up the hardware, but usually users
136          * tend to only have this flag set on applications they think
137          * of as important.
138          */
139         if (has_capability_noaudit(p, CAP_SYS_RAWIO))
140                 points /= 4;
141
142         /*
143          * If p's nodes don't overlap ours, it may still help to kill p
144          * because p may have allocated or otherwise mapped memory on
145          * this node before. However it will be less likely.
146          */
147         if (!cpuset_mems_allowed_intersects(current, p))
148                 points /= 8;
149
150         /*
151          * Adjust the score by oomkilladj.
152          */
153         if (p->oomkilladj) {
154                 if (p->oomkilladj > 0) {
155                         if (!points)
156                                 points = 1;
157                         points <<= p->oomkilladj;
158                 } else
159                         points >>= -(p->oomkilladj);
160         }
161
162 #ifdef DEBUG
163         printk(KERN_DEBUG "OOMkill: task %d (%s) got %lu points\n",
164         p->pid, p->comm, points);
165 #endif
166         return points;
167 }
168
169 /*
170  * Determine the type of allocation constraint.
171  */
172 static inline enum oom_constraint constrained_alloc(struct zonelist *zonelist,
173                                                     gfp_t gfp_mask)
174 {
175 #ifdef CONFIG_NUMA
176         struct zone *zone;
177         struct zoneref *z;
178         enum zone_type high_zoneidx = gfp_zone(gfp_mask);
179         nodemask_t nodes = node_states[N_HIGH_MEMORY];
180
181         for_each_zone_zonelist(zone, z, zonelist, high_zoneidx)
182                 if (cpuset_zone_allowed_softwall(zone, gfp_mask))
183                         node_clear(zone_to_nid(zone), nodes);
184                 else
185                         return CONSTRAINT_CPUSET;
186
187         if (!nodes_empty(nodes))
188                 return CONSTRAINT_MEMORY_POLICY;
189 #endif
190
191         return CONSTRAINT_NONE;
192 }
193
194 /*
195  * Simple selection loop. We chose the process with the highest
196  * number of 'points'. We expect the caller will lock the tasklist.
197  *
198  * (not docbooked, we don't want this one cluttering up the manual)
199  */
200 static struct task_struct *select_bad_process(unsigned long *ppoints,
201                                                 struct mem_cgroup *mem)
202 {
203         struct task_struct *g, *p;
204         struct task_struct *chosen = NULL;
205         struct timespec uptime;
206         *ppoints = 0;
207
208         do_posix_clock_monotonic_gettime(&uptime);
209         do_each_thread(g, p) {
210                 unsigned long points;
211
212                 /*
213                  * skip kernel threads and tasks which have already released
214                  * their mm.
215                  */
216                 if (!p->mm)
217                         continue;
218                 /* skip the init task */
219                 if (is_global_init(p))
220                         continue;
221                 if (mem && !task_in_mem_cgroup(p, mem))
222                         continue;
223
224                 /*
225                  * This task already has access to memory reserves and is
226                  * being killed. Don't allow any other task access to the
227                  * memory reserve.
228                  *
229                  * Note: this may have a chance of deadlock if it gets
230                  * blocked waiting for another task which itself is waiting
231                  * for memory. Is there a better alternative?
232                  */
233                 if (test_tsk_thread_flag(p, TIF_MEMDIE))
234                         return ERR_PTR(-1UL);
235
236                 /*
237                  * This is in the process of releasing memory so wait for it
238                  * to finish before killing some other task by mistake.
239                  *
240                  * However, if p is the current task, we allow the 'kill' to
241                  * go ahead if it is exiting: this will simply set TIF_MEMDIE,
242                  * which will allow it to gain access to memory reserves in
243                  * the process of exiting and releasing its resources.
244                  * Otherwise we could get an easy OOM deadlock.
245                  */
246                 if (p->flags & PF_EXITING) {
247                         if (p != current)
248                                 return ERR_PTR(-1UL);
249
250                         chosen = p;
251                         *ppoints = ULONG_MAX;
252                 }
253
254                 if (p->oomkilladj == OOM_DISABLE)
255                         continue;
256
257                 points = badness(p, uptime.tv_sec);
258                 if (points > *ppoints || !chosen) {
259                         chosen = p;
260                         *ppoints = points;
261                 }
262         } while_each_thread(g, p);
263
264         return chosen;
265 }
266
267 /**
268  * dump_tasks - dump current memory state of all system tasks
269  * @mem: target memory controller
270  *
271  * Dumps the current memory state of all system tasks, excluding kernel threads.
272  * State information includes task's pid, uid, tgid, vm size, rss, cpu, oom_adj
273  * score, and name.
274  *
275  * If the actual is non-NULL, only tasks that are a member of the mem_cgroup are
276  * shown.
277  *
278  * Call with tasklist_lock read-locked.
279  */
280 static void dump_tasks(const struct mem_cgroup *mem)
281 {
282         struct task_struct *g, *p;
283
284         printk(KERN_INFO "[ pid ]   uid  tgid total_vm      rss cpu oom_adj "
285                "name\n");
286         do_each_thread(g, p) {
287                 /*
288                  * total_vm and rss sizes do not exist for tasks with a
289                  * detached mm so there's no need to report them.
290                  */
291                 if (!p->mm)
292                         continue;
293                 if (mem && !task_in_mem_cgroup(p, mem))
294                         continue;
295                 if (!thread_group_leader(p))
296                         continue;
297
298                 task_lock(p);
299                 printk(KERN_INFO "[%5d] %5d %5d %8lu %8lu %3d     %3d %s\n",
300                        p->pid, __task_cred(p)->uid, p->tgid,
301                        p->mm->total_vm, get_mm_rss(p->mm), (int)task_cpu(p),
302                        p->oomkilladj, p->comm);
303                 task_unlock(p);
304         } while_each_thread(g, p);
305 }
306
307 /*
308  * Send SIGKILL to the selected  process irrespective of  CAP_SYS_RAW_IO
309  * flag though it's unlikely that  we select a process with CAP_SYS_RAW_IO
310  * set.
311  */
312 static void __oom_kill_task(struct task_struct *p, int verbose)
313 {
314         if (is_global_init(p)) {
315                 WARN_ON(1);
316                 printk(KERN_WARNING "tried to kill init!\n");
317                 return;
318         }
319
320         if (!p->mm) {
321                 WARN_ON(1);
322                 printk(KERN_WARNING "tried to kill an mm-less task!\n");
323                 return;
324         }
325
326         if (verbose)
327                 printk(KERN_ERR "Killed process %d (%s)\n",
328                                 task_pid_nr(p), p->comm);
329
330         /*
331          * We give our sacrificial lamb high priority and access to
332          * all the memory it needs. That way it should be able to
333          * exit() and clear out its resources quickly...
334          */
335         p->rt.time_slice = HZ;
336         set_tsk_thread_flag(p, TIF_MEMDIE);
337
338         force_sig(SIGKILL, p);
339 }
340
341 static int oom_kill_task(struct task_struct *p)
342 {
343         struct mm_struct *mm;
344         struct task_struct *g, *q;
345
346         mm = p->mm;
347
348         /* WARNING: mm may not be dereferenced since we did not obtain its
349          * value from get_task_mm(p).  This is OK since all we need to do is
350          * compare mm to q->mm below.
351          *
352          * Furthermore, even if mm contains a non-NULL value, p->mm may
353          * change to NULL at any time since we do not hold task_lock(p).
354          * However, this is of no concern to us.
355          */
356
357         if (mm == NULL)
358                 return 1;
359
360         /*
361          * Don't kill the process if any threads are set to OOM_DISABLE
362          */
363         do_each_thread(g, q) {
364                 if (q->mm == mm && q->oomkilladj == OOM_DISABLE)
365                         return 1;
366         } while_each_thread(g, q);
367
368         __oom_kill_task(p, 1);
369
370         /*
371          * kill all processes that share the ->mm (i.e. all threads),
372          * but are in a different thread group. Don't let them have access
373          * to memory reserves though, otherwise we might deplete all memory.
374          */
375         do_each_thread(g, q) {
376                 if (q->mm == mm && !same_thread_group(q, p))
377                         force_sig(SIGKILL, q);
378         } while_each_thread(g, q);
379
380         return 0;
381 }
382
383 static int oom_kill_process(struct task_struct *p, gfp_t gfp_mask, int order,
384                             unsigned long points, struct mem_cgroup *mem,
385                             const char *message)
386 {
387         struct task_struct *c;
388
389         if (printk_ratelimit()) {
390                 printk(KERN_WARNING "%s invoked oom-killer: "
391                         "gfp_mask=0x%x, order=%d, oomkilladj=%d\n",
392                         current->comm, gfp_mask, order, current->oomkilladj);
393                 task_lock(current);
394                 cpuset_print_task_mems_allowed(current);
395                 task_unlock(current);
396                 dump_stack();
397                 mem_cgroup_print_oom_info(mem, current);
398                 show_mem();
399                 if (sysctl_oom_dump_tasks)
400                         dump_tasks(mem);
401         }
402
403         /*
404          * If the task is already exiting, don't alarm the sysadmin or kill
405          * its children or threads, just set TIF_MEMDIE so it can die quickly
406          */
407         if (p->flags & PF_EXITING) {
408                 __oom_kill_task(p, 0);
409                 return 0;
410         }
411
412         printk(KERN_ERR "%s: kill process %d (%s) score %li or a child\n",
413                                         message, task_pid_nr(p), p->comm, points);
414
415         /* Try to kill a child first */
416         list_for_each_entry(c, &p->children, sibling) {
417                 if (c->mm == p->mm)
418                         continue;
419                 if (!oom_kill_task(c))
420                         return 0;
421         }
422         return oom_kill_task(p);
423 }
424
425 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
426 void mem_cgroup_out_of_memory(struct mem_cgroup *mem, gfp_t gfp_mask)
427 {
428         unsigned long points = 0;
429         struct task_struct *p;
430
431         read_lock(&tasklist_lock);
432 retry:
433         p = select_bad_process(&points, mem);
434         if (PTR_ERR(p) == -1UL)
435                 goto out;
436
437         if (!p)
438                 p = current;
439
440         if (oom_kill_process(p, gfp_mask, 0, points, mem,
441                                 "Memory cgroup out of memory"))
442                 goto retry;
443 out:
444         read_unlock(&tasklist_lock);
445 }
446 #endif
447
448 static BLOCKING_NOTIFIER_HEAD(oom_notify_list);
449
450 int register_oom_notifier(struct notifier_block *nb)
451 {
452         return blocking_notifier_chain_register(&oom_notify_list, nb);
453 }
454 EXPORT_SYMBOL_GPL(register_oom_notifier);
455
456 int unregister_oom_notifier(struct notifier_block *nb)
457 {
458         return blocking_notifier_chain_unregister(&oom_notify_list, nb);
459 }
460 EXPORT_SYMBOL_GPL(unregister_oom_notifier);
461
462 /*
463  * Try to acquire the OOM killer lock for the zones in zonelist.  Returns zero
464  * if a parallel OOM killing is already taking place that includes a zone in
465  * the zonelist.  Otherwise, locks all zones in the zonelist and returns 1.
466  */
467 int try_set_zone_oom(struct zonelist *zonelist, gfp_t gfp_mask)
468 {
469         struct zoneref *z;
470         struct zone *zone;
471         int ret = 1;
472
473         spin_lock(&zone_scan_lock);
474         for_each_zone_zonelist(zone, z, zonelist, gfp_zone(gfp_mask)) {
475                 if (zone_is_oom_locked(zone)) {
476                         ret = 0;
477                         goto out;
478                 }
479         }
480
481         for_each_zone_zonelist(zone, z, zonelist, gfp_zone(gfp_mask)) {
482                 /*
483                  * Lock each zone in the zonelist under zone_scan_lock so a
484                  * parallel invocation of try_set_zone_oom() doesn't succeed
485                  * when it shouldn't.
486                  */
487                 zone_set_flag(zone, ZONE_OOM_LOCKED);
488         }
489
490 out:
491         spin_unlock(&zone_scan_lock);
492         return ret;
493 }
494
495 /*
496  * Clears the ZONE_OOM_LOCKED flag for all zones in the zonelist so that failed
497  * allocation attempts with zonelists containing them may now recall the OOM
498  * killer, if necessary.
499  */
500 void clear_zonelist_oom(struct zonelist *zonelist, gfp_t gfp_mask)
501 {
502         struct zoneref *z;
503         struct zone *zone;
504
505         spin_lock(&zone_scan_lock);
506         for_each_zone_zonelist(zone, z, zonelist, gfp_zone(gfp_mask)) {
507                 zone_clear_flag(zone, ZONE_OOM_LOCKED);
508         }
509         spin_unlock(&zone_scan_lock);
510 }
511
512 /*
513  * Must be called with tasklist_lock held for read.
514  */
515 static void __out_of_memory(gfp_t gfp_mask, int order)
516 {
517         struct task_struct *p;
518         unsigned long points;
519
520         if (sysctl_oom_kill_allocating_task)
521                 if (!oom_kill_process(current, gfp_mask, order, 0, NULL,
522                                 "Out of memory (oom_kill_allocating_task)"))
523                         return;
524 retry:
525         /*
526          * Rambo mode: Shoot down a process and hope it solves whatever
527          * issues we may have.
528          */
529         p = select_bad_process(&points, NULL);
530
531         if (PTR_ERR(p) == -1UL)
532                 return;
533
534         /* Found nothing?!?! Either we hang forever, or we panic. */
535         if (!p) {
536                 read_unlock(&tasklist_lock);
537                 panic("Out of memory and no killable processes...\n");
538         }
539
540         if (oom_kill_process(p, gfp_mask, order, points, NULL,
541                              "Out of memory"))
542                 goto retry;
543 }
544
545 /*
546  * pagefault handler calls into here because it is out of memory but
547  * doesn't know exactly how or why.
548  */
549 void pagefault_out_of_memory(void)
550 {
551         unsigned long freed = 0;
552
553         blocking_notifier_call_chain(&oom_notify_list, 0, &freed);
554         if (freed > 0)
555                 /* Got some memory back in the last second. */
556                 return;
557
558         /*
559          * If this is from memcg, oom-killer is already invoked.
560          * and not worth to go system-wide-oom.
561          */
562         if (mem_cgroup_oom_called(current))
563                 goto rest_and_return;
564
565         if (sysctl_panic_on_oom)
566                 panic("out of memory from page fault. panic_on_oom is selected.\n");
567
568         read_lock(&tasklist_lock);
569         __out_of_memory(0, 0); /* unknown gfp_mask and order */
570         read_unlock(&tasklist_lock);
571
572         /*
573          * Give "p" a good chance of killing itself before we
574          * retry to allocate memory.
575          */
576 rest_and_return:
577         if (!test_thread_flag(TIF_MEMDIE))
578                 schedule_timeout_uninterruptible(1);
579 }
580
581 /**
582  * out_of_memory - kill the "best" process when we run out of memory
583  * @zonelist: zonelist pointer
584  * @gfp_mask: memory allocation flags
585  * @order: amount of memory being requested as a power of 2
586  *
587  * If we run out of memory, we have the choice between either
588  * killing a random task (bad), letting the system crash (worse)
589  * OR try to be smart about which process to kill. Note that we
590  * don't have to be perfect here, we just have to be good.
591  */
592 void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order)
593 {
594         unsigned long freed = 0;
595         enum oom_constraint constraint;
596
597         blocking_notifier_call_chain(&oom_notify_list, 0, &freed);
598         if (freed > 0)
599                 /* Got some memory back in the last second. */
600                 return;
601
602         if (sysctl_panic_on_oom == 2)
603                 panic("out of memory. Compulsory panic_on_oom is selected.\n");
604
605         /*
606          * Check if there were limitations on the allocation (only relevant for
607          * NUMA) that may require different handling.
608          */
609         constraint = constrained_alloc(zonelist, gfp_mask);
610         read_lock(&tasklist_lock);
611
612         switch (constraint) {
613         case CONSTRAINT_MEMORY_POLICY:
614                 oom_kill_process(current, gfp_mask, order, 0, NULL,
615                                 "No available memory (MPOL_BIND)");
616                 break;
617
618         case CONSTRAINT_NONE:
619                 if (sysctl_panic_on_oom)
620                         panic("out of memory. panic_on_oom is selected\n");
621                 /* Fall-through */
622         case CONSTRAINT_CPUSET:
623                 __out_of_memory(gfp_mask, order);
624                 break;
625         }
626
627         read_unlock(&tasklist_lock);
628
629         /*
630          * Give "p" a good chance of killing itself before we
631          * retry to allocate memory unless "p" is current
632          */
633         if (!test_thread_flag(TIF_MEMDIE))
634                 schedule_timeout_uninterruptible(1);
635 }