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