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...
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.
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.
18 #include <linux/oom.h>
20 #include <linux/err.h>
21 #include <linux/gfp.h>
22 #include <linux/sched.h>
23 #include <linux/swap.h>
24 #include <linux/timex.h>
25 #include <linux/jiffies.h>
26 #include <linux/cpuset.h>
27 #include <linux/module.h>
28 #include <linux/notifier.h>
29 #include <linux/memcontrol.h>
30 #include <linux/mempolicy.h>
31 #include <linux/security.h>
33 int sysctl_panic_on_oom
;
34 int sysctl_oom_kill_allocating_task
;
35 int sysctl_oom_dump_tasks
= 1;
36 static DEFINE_SPINLOCK(zone_scan_lock
);
41 * has_intersects_mems_allowed() - check task eligiblity for kill
42 * @tsk: task struct of which task to consider
43 * @mask: nodemask passed to page allocator for mempolicy ooms
45 * Task eligibility is determined by whether or not a candidate task, @tsk,
46 * shares the same mempolicy nodes as current if it is bound by such a policy
47 * and whether or not it has the same set of allowed cpuset nodes.
49 static bool has_intersects_mems_allowed(struct task_struct
*tsk
,
50 const nodemask_t
*mask
)
52 struct task_struct
*start
= tsk
;
57 * If this is a mempolicy constrained oom, tsk's
58 * cpuset is irrelevant. Only return true if its
59 * mempolicy intersects current, otherwise it may be
62 if (mempolicy_nodemask_intersects(tsk
, mask
))
66 * This is not a mempolicy constrained oom, so only
67 * check the mems of tsk's cpuset.
69 if (cpuset_mems_allowed_intersects(current
, tsk
))
72 tsk
= next_thread(tsk
);
73 } while (tsk
!= start
);
77 static bool has_intersects_mems_allowed(struct task_struct
*tsk
,
78 const nodemask_t
*mask
)
82 #endif /* CONFIG_NUMA */
85 * The process p may have detached its own ->mm while exiting or through
86 * use_mm(), but one or more of its subthreads may still have a valid
87 * pointer. Return p, or any of its subthreads with a valid ->mm, with
90 static struct task_struct
*find_lock_task_mm(struct task_struct
*p
)
92 struct task_struct
*t
= p
;
99 } while_each_thread(p
, t
);
105 * badness - calculate a numeric value for how bad this task has been
106 * @p: task struct of which task we should calculate
107 * @uptime: current uptime in seconds
109 * The formula used is relatively simple and documented inline in the
110 * function. The main rationale is that we want to select a good task
111 * to kill when we run out of memory.
113 * Good in this context means that:
114 * 1) we lose the minimum amount of work done
115 * 2) we recover a large amount of memory
116 * 3) we don't kill anything innocent of eating tons of memory
117 * 4) we want to kill the minimum amount of processes (one)
118 * 5) we try to kill the process the user expects us to kill, this
119 * algorithm has been meticulously tuned to meet the principle
120 * of least surprise ... (be careful when you change it)
123 unsigned long badness(struct task_struct
*p
, unsigned long uptime
)
125 unsigned long points
, cpu_time
, run_time
;
126 struct task_struct
*child
;
127 struct task_struct
*c
, *t
;
128 int oom_adj
= p
->signal
->oom_adj
;
129 struct task_cputime task_time
;
133 if (oom_adj
== OOM_DISABLE
)
136 p
= find_lock_task_mm(p
);
141 * The memory size of the process is the basis for the badness.
143 points
= p
->mm
->total_vm
;
147 * swapoff can easily use up all memory, so kill those first.
149 if (p
->flags
& PF_OOM_ORIGIN
)
153 * Processes which fork a lot of child processes are likely
154 * a good choice. We add half the vmsize of the children if they
155 * have an own mm. This prevents forking servers to flood the
156 * machine with an endless amount of children. In case a single
157 * child is eating the vast majority of memory, adding only half
158 * to the parents will make the child our kill candidate of choice.
162 list_for_each_entry(c
, &t
->children
, sibling
) {
163 child
= find_lock_task_mm(c
);
165 if (child
->mm
!= p
->mm
)
166 points
+= child
->mm
->total_vm
/2 + 1;
170 } while_each_thread(p
, t
);
173 * CPU time is in tens of seconds and run time is in thousands
174 * of seconds. There is no particular reason for this other than
175 * that it turned out to work very well in practice.
177 thread_group_cputime(p
, &task_time
);
178 utime
= cputime_to_jiffies(task_time
.utime
);
179 stime
= cputime_to_jiffies(task_time
.stime
);
180 cpu_time
= (utime
+ stime
) >> (SHIFT_HZ
+ 3);
183 if (uptime
>= p
->start_time
.tv_sec
)
184 run_time
= (uptime
- p
->start_time
.tv_sec
) >> 10;
189 points
/= int_sqrt(cpu_time
);
191 points
/= int_sqrt(int_sqrt(run_time
));
194 * Niced processes are most likely less important, so double
195 * their badness points.
197 if (task_nice(p
) > 0)
201 * Superuser processes are usually more important, so we make it
202 * less likely that we kill those.
204 if (has_capability_noaudit(p
, CAP_SYS_ADMIN
) ||
205 has_capability_noaudit(p
, CAP_SYS_RESOURCE
))
209 * We don't want to kill a process with direct hardware access.
210 * Not only could that mess up the hardware, but usually users
211 * tend to only have this flag set on applications they think
214 if (has_capability_noaudit(p
, CAP_SYS_RAWIO
))
218 * Adjust the score by oom_adj.
226 points
>>= -(oom_adj
);
230 printk(KERN_DEBUG
"OOMkill: task %d (%s) got %lu points\n",
231 p
->pid
, p
->comm
, points
);
237 * Determine the type of allocation constraint.
240 static enum oom_constraint
constrained_alloc(struct zonelist
*zonelist
,
241 gfp_t gfp_mask
, nodemask_t
*nodemask
)
245 enum zone_type high_zoneidx
= gfp_zone(gfp_mask
);
248 * Reach here only when __GFP_NOFAIL is used. So, we should avoid
249 * to kill current.We have to random task kill in this case.
250 * Hopefully, CONSTRAINT_THISNODE...but no way to handle it, now.
252 if (gfp_mask
& __GFP_THISNODE
)
253 return CONSTRAINT_NONE
;
256 * The nodemask here is a nodemask passed to alloc_pages(). Now,
257 * cpuset doesn't use this nodemask for its hardwall/softwall/hierarchy
258 * feature. mempolicy is an only user of nodemask here.
259 * check mempolicy's nodemask contains all N_HIGH_MEMORY
261 if (nodemask
&& !nodes_subset(node_states
[N_HIGH_MEMORY
], *nodemask
))
262 return CONSTRAINT_MEMORY_POLICY
;
264 /* Check this allocation failure is caused by cpuset's wall function */
265 for_each_zone_zonelist_nodemask(zone
, z
, zonelist
,
266 high_zoneidx
, nodemask
)
267 if (!cpuset_zone_allowed_softwall(zone
, gfp_mask
))
268 return CONSTRAINT_CPUSET
;
270 return CONSTRAINT_NONE
;
273 static enum oom_constraint
constrained_alloc(struct zonelist
*zonelist
,
274 gfp_t gfp_mask
, nodemask_t
*nodemask
)
276 return CONSTRAINT_NONE
;
281 * Simple selection loop. We chose the process with the highest
282 * number of 'points'. We expect the caller will lock the tasklist.
284 * (not docbooked, we don't want this one cluttering up the manual)
286 static struct task_struct
*select_bad_process(unsigned long *ppoints
,
287 struct mem_cgroup
*mem
, const nodemask_t
*nodemask
)
289 struct task_struct
*p
;
290 struct task_struct
*chosen
= NULL
;
291 struct timespec uptime
;
294 do_posix_clock_monotonic_gettime(&uptime
);
295 for_each_process(p
) {
296 unsigned long points
;
298 /* skip the init task and kthreads */
299 if (is_global_init(p
) || (p
->flags
& PF_KTHREAD
))
301 if (mem
&& !task_in_mem_cgroup(p
, mem
))
303 if (!has_intersects_mems_allowed(p
, nodemask
))
307 * This task already has access to memory reserves and is
308 * being killed. Don't allow any other task access to the
311 * Note: this may have a chance of deadlock if it gets
312 * blocked waiting for another task which itself is waiting
313 * for memory. Is there a better alternative?
315 if (test_tsk_thread_flag(p
, TIF_MEMDIE
))
316 return ERR_PTR(-1UL);
319 * This is in the process of releasing memory so wait for it
320 * to finish before killing some other task by mistake.
322 * However, if p is the current task, we allow the 'kill' to
323 * go ahead if it is exiting: this will simply set TIF_MEMDIE,
324 * which will allow it to gain access to memory reserves in
325 * the process of exiting and releasing its resources.
326 * Otherwise we could get an easy OOM deadlock.
328 if ((p
->flags
& PF_EXITING
) && p
->mm
) {
330 return ERR_PTR(-1UL);
333 *ppoints
= ULONG_MAX
;
336 if (p
->signal
->oom_adj
== OOM_DISABLE
)
339 points
= badness(p
, uptime
.tv_sec
);
340 if (points
> *ppoints
|| !chosen
) {
350 * dump_tasks - dump current memory state of all system tasks
351 * @mem: current's memory controller, if constrained
353 * Dumps the current memory state of all system tasks, excluding kernel threads.
354 * State information includes task's pid, uid, tgid, vm size, rss, cpu, oom_adj
357 * If the actual is non-NULL, only tasks that are a member of the mem_cgroup are
360 * Call with tasklist_lock read-locked.
362 static void dump_tasks(const struct mem_cgroup
*mem
)
364 struct task_struct
*p
;
365 struct task_struct
*task
;
367 printk(KERN_INFO
"[ pid ] uid tgid total_vm rss cpu oom_adj "
369 for_each_process(p
) {
370 if (p
->flags
& PF_KTHREAD
)
372 if (mem
&& !task_in_mem_cgroup(p
, mem
))
375 task
= find_lock_task_mm(p
);
378 * This is a kthread or all of p's threads have already
379 * detached their mm's. There's no need to report
380 * them; they can't be oom killed anyway.
385 printk(KERN_INFO
"[%5d] %5d %5d %8lu %8lu %3u %3d %s\n",
386 task
->pid
, __task_cred(task
)->uid
, task
->tgid
,
387 task
->mm
->total_vm
, get_mm_rss(task
->mm
),
388 task_cpu(task
), task
->signal
->oom_adj
, task
->comm
);
393 static void dump_header(struct task_struct
*p
, gfp_t gfp_mask
, int order
,
394 struct mem_cgroup
*mem
)
397 pr_warning("%s invoked oom-killer: gfp_mask=0x%x, order=%d, "
399 current
->comm
, gfp_mask
, order
, current
->signal
->oom_adj
);
400 cpuset_print_task_mems_allowed(current
);
401 task_unlock(current
);
403 mem_cgroup_print_oom_info(mem
, p
);
405 if (sysctl_oom_dump_tasks
)
409 #define K(x) ((x) << (PAGE_SHIFT-10))
410 static int oom_kill_task(struct task_struct
*p
)
412 p
= find_lock_task_mm(p
);
413 if (!p
|| p
->signal
->oom_adj
== OOM_DISABLE
) {
417 pr_err("Killed process %d (%s) total-vm:%lukB, anon-rss:%lukB, file-rss:%lukB\n",
418 task_pid_nr(p
), p
->comm
, K(p
->mm
->total_vm
),
419 K(get_mm_counter(p
->mm
, MM_ANONPAGES
)),
420 K(get_mm_counter(p
->mm
, MM_FILEPAGES
)));
423 p
->rt
.time_slice
= HZ
;
424 set_tsk_thread_flag(p
, TIF_MEMDIE
);
425 force_sig(SIGKILL
, p
);
430 static int oom_kill_process(struct task_struct
*p
, gfp_t gfp_mask
, int order
,
431 unsigned long points
, struct mem_cgroup
*mem
,
434 struct task_struct
*victim
= p
;
435 struct task_struct
*child
;
436 struct task_struct
*t
= p
;
437 unsigned long victim_points
= 0;
438 struct timespec uptime
;
440 if (printk_ratelimit())
441 dump_header(p
, gfp_mask
, order
, mem
);
444 * If the task is already exiting, don't alarm the sysadmin or kill
445 * its children or threads, just set TIF_MEMDIE so it can die quickly
447 if (p
->flags
& PF_EXITING
) {
448 set_tsk_thread_flag(p
, TIF_MEMDIE
);
453 pr_err("%s: Kill process %d (%s) score %lu or sacrifice child\n",
454 message
, task_pid_nr(p
), p
->comm
, points
);
458 * If any of p's children has a different mm and is eligible for kill,
459 * the one with the highest badness() score is sacrificed for its
460 * parent. This attempts to lose the minimal amount of work done while
461 * still freeing memory.
463 do_posix_clock_monotonic_gettime(&uptime
);
465 list_for_each_entry(child
, &t
->children
, sibling
) {
466 unsigned long child_points
;
468 if (child
->mm
== p
->mm
)
470 if (mem
&& !task_in_mem_cgroup(child
, mem
))
473 /* badness() returns 0 if the thread is unkillable */
474 child_points
= badness(child
, uptime
.tv_sec
);
475 if (child_points
> victim_points
) {
477 victim_points
= child_points
;
480 } while_each_thread(p
, t
);
482 return oom_kill_task(victim
);
486 * Determines whether the kernel must panic because of the panic_on_oom sysctl.
488 static void check_panic_on_oom(enum oom_constraint constraint
, gfp_t gfp_mask
,
491 if (likely(!sysctl_panic_on_oom
))
493 if (sysctl_panic_on_oom
!= 2) {
495 * panic_on_oom == 1 only affects CONSTRAINT_NONE, the kernel
496 * does not panic for cpuset, mempolicy, or memcg allocation
499 if (constraint
!= CONSTRAINT_NONE
)
502 read_lock(&tasklist_lock
);
503 dump_header(NULL
, gfp_mask
, order
, NULL
);
504 read_unlock(&tasklist_lock
);
505 panic("Out of memory: %s panic_on_oom is enabled\n",
506 sysctl_panic_on_oom
== 2 ? "compulsory" : "system-wide");
509 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
510 void mem_cgroup_out_of_memory(struct mem_cgroup
*mem
, gfp_t gfp_mask
)
512 unsigned long points
= 0;
513 struct task_struct
*p
;
515 check_panic_on_oom(CONSTRAINT_MEMCG
, gfp_mask
, 0);
516 read_lock(&tasklist_lock
);
518 p
= select_bad_process(&points
, mem
, NULL
);
519 if (!p
|| PTR_ERR(p
) == -1UL)
522 if (oom_kill_process(p
, gfp_mask
, 0, points
, mem
,
523 "Memory cgroup out of memory"))
526 read_unlock(&tasklist_lock
);
530 static BLOCKING_NOTIFIER_HEAD(oom_notify_list
);
532 int register_oom_notifier(struct notifier_block
*nb
)
534 return blocking_notifier_chain_register(&oom_notify_list
, nb
);
536 EXPORT_SYMBOL_GPL(register_oom_notifier
);
538 int unregister_oom_notifier(struct notifier_block
*nb
)
540 return blocking_notifier_chain_unregister(&oom_notify_list
, nb
);
542 EXPORT_SYMBOL_GPL(unregister_oom_notifier
);
545 * Try to acquire the OOM killer lock for the zones in zonelist. Returns zero
546 * if a parallel OOM killing is already taking place that includes a zone in
547 * the zonelist. Otherwise, locks all zones in the zonelist and returns 1.
549 int try_set_zonelist_oom(struct zonelist
*zonelist
, gfp_t gfp_mask
)
555 spin_lock(&zone_scan_lock
);
556 for_each_zone_zonelist(zone
, z
, zonelist
, gfp_zone(gfp_mask
)) {
557 if (zone_is_oom_locked(zone
)) {
563 for_each_zone_zonelist(zone
, z
, zonelist
, gfp_zone(gfp_mask
)) {
565 * Lock each zone in the zonelist under zone_scan_lock so a
566 * parallel invocation of try_set_zonelist_oom() doesn't succeed
569 zone_set_flag(zone
, ZONE_OOM_LOCKED
);
573 spin_unlock(&zone_scan_lock
);
578 * Clears the ZONE_OOM_LOCKED flag for all zones in the zonelist so that failed
579 * allocation attempts with zonelists containing them may now recall the OOM
580 * killer, if necessary.
582 void clear_zonelist_oom(struct zonelist
*zonelist
, gfp_t gfp_mask
)
587 spin_lock(&zone_scan_lock
);
588 for_each_zone_zonelist(zone
, z
, zonelist
, gfp_zone(gfp_mask
)) {
589 zone_clear_flag(zone
, ZONE_OOM_LOCKED
);
591 spin_unlock(&zone_scan_lock
);
595 * Try to acquire the oom killer lock for all system zones. Returns zero if a
596 * parallel oom killing is taking place, otherwise locks all zones and returns
599 static int try_set_system_oom(void)
604 spin_lock(&zone_scan_lock
);
605 for_each_populated_zone(zone
)
606 if (zone_is_oom_locked(zone
)) {
610 for_each_populated_zone(zone
)
611 zone_set_flag(zone
, ZONE_OOM_LOCKED
);
613 spin_unlock(&zone_scan_lock
);
618 * Clears ZONE_OOM_LOCKED for all system zones so that failed allocation
619 * attempts or page faults may now recall the oom killer, if necessary.
621 static void clear_system_oom(void)
625 spin_lock(&zone_scan_lock
);
626 for_each_populated_zone(zone
)
627 zone_clear_flag(zone
, ZONE_OOM_LOCKED
);
628 spin_unlock(&zone_scan_lock
);
632 * out_of_memory - kill the "best" process when we run out of memory
633 * @zonelist: zonelist pointer
634 * @gfp_mask: memory allocation flags
635 * @order: amount of memory being requested as a power of 2
636 * @nodemask: nodemask passed to page allocator
638 * If we run out of memory, we have the choice between either
639 * killing a random task (bad), letting the system crash (worse)
640 * OR try to be smart about which process to kill. Note that we
641 * don't have to be perfect here, we just have to be good.
643 void out_of_memory(struct zonelist
*zonelist
, gfp_t gfp_mask
,
644 int order
, nodemask_t
*nodemask
)
646 struct task_struct
*p
;
647 unsigned long freed
= 0;
648 unsigned long points
;
649 enum oom_constraint constraint
= CONSTRAINT_NONE
;
651 blocking_notifier_call_chain(&oom_notify_list
, 0, &freed
);
653 /* Got some memory back in the last second. */
657 * If current has a pending SIGKILL, then automatically select it. The
658 * goal is to allow it to allocate so that it may quickly exit and free
661 if (fatal_signal_pending(current
)) {
662 set_thread_flag(TIF_MEMDIE
);
667 * Check if there were limitations on the allocation (only relevant for
668 * NUMA) that may require different handling.
671 constraint
= constrained_alloc(zonelist
, gfp_mask
, nodemask
);
672 check_panic_on_oom(constraint
, gfp_mask
, order
);
674 read_lock(&tasklist_lock
);
675 if (sysctl_oom_kill_allocating_task
) {
677 * oom_kill_process() needs tasklist_lock held. If it returns
678 * non-zero, current could not be killed so we must fallback to
681 if (!oom_kill_process(current
, gfp_mask
, order
, 0, NULL
,
682 "Out of memory (oom_kill_allocating_task)"))
687 p
= select_bad_process(&points
, NULL
,
688 constraint
== CONSTRAINT_MEMORY_POLICY
? nodemask
:
690 if (PTR_ERR(p
) == -1UL)
693 /* Found nothing?!?! Either we hang forever, or we panic. */
695 dump_header(NULL
, gfp_mask
, order
, NULL
);
696 read_unlock(&tasklist_lock
);
697 panic("Out of memory and no killable processes...\n");
700 if (oom_kill_process(p
, gfp_mask
, order
, points
, NULL
,
703 read_unlock(&tasklist_lock
);
706 * Give "p" a good chance of killing itself before we
707 * retry to allocate memory unless "p" is current
709 if (!test_thread_flag(TIF_MEMDIE
))
710 schedule_timeout_uninterruptible(1);
714 * The pagefault handler calls here because it is out of memory, so kill a
715 * memory-hogging task. If a populated zone has ZONE_OOM_LOCKED set, a parallel
716 * oom killing is already in progress so do nothing. If a task is found with
717 * TIF_MEMDIE set, it has been killed so do nothing and allow it to exit.
719 void pagefault_out_of_memory(void)
721 if (try_set_system_oom()) {
722 out_of_memory(NULL
, 0, 0, NULL
);
725 if (!test_thread_flag(TIF_MEMDIE
))
726 schedule_timeout_uninterruptible(1);