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 * Copyright (C) 2010 Google, Inc.
8 * Rewritten by David Rientjes
10 * The routines in this file are used to kill a process when
11 * we're seriously out of memory. This gets called from __alloc_pages()
12 * in mm/page_alloc.c when we really run out of memory.
14 * Since we won't call these routines often (on a well-configured
15 * machine) this file will double as a 'coding guide' and a signpost
16 * for newbie kernel hackers. It features several pointers to major
17 * kernel subsystems and hints as to where to find out what things do.
20 #include <linux/oom.h>
22 #include <linux/err.h>
23 #include <linux/gfp.h>
24 #include <linux/sched.h>
25 #include <linux/swap.h>
26 #include <linux/timex.h>
27 #include <linux/jiffies.h>
28 #include <linux/cpuset.h>
29 #include <linux/module.h>
30 #include <linux/notifier.h>
31 #include <linux/memcontrol.h>
32 #include <linux/mempolicy.h>
33 #include <linux/security.h>
34 #include <linux/ptrace.h>
36 int sysctl_panic_on_oom
;
37 int sysctl_oom_kill_allocating_task
;
38 int sysctl_oom_dump_tasks
= 1;
39 static DEFINE_SPINLOCK(zone_scan_lock
);
42 * test_set_oom_score_adj() - set current's oom_score_adj and return old value
43 * @new_val: new oom_score_adj value
45 * Sets the oom_score_adj value for current to @new_val with proper
46 * synchronization and returns the old value. Usually used to temporarily
47 * set a value, save the old value in the caller, and then reinstate it later.
49 int test_set_oom_score_adj(int new_val
)
51 struct sighand_struct
*sighand
= current
->sighand
;
54 spin_lock_irq(&sighand
->siglock
);
55 old_val
= current
->signal
->oom_score_adj
;
56 if (new_val
!= old_val
) {
57 if (new_val
== OOM_SCORE_ADJ_MIN
)
58 atomic_inc(¤t
->mm
->oom_disable_count
);
59 else if (old_val
== OOM_SCORE_ADJ_MIN
)
60 atomic_dec(¤t
->mm
->oom_disable_count
);
61 current
->signal
->oom_score_adj
= new_val
;
63 spin_unlock_irq(&sighand
->siglock
);
70 * has_intersects_mems_allowed() - check task eligiblity for kill
71 * @tsk: task struct of which task to consider
72 * @mask: nodemask passed to page allocator for mempolicy ooms
74 * Task eligibility is determined by whether or not a candidate task, @tsk,
75 * shares the same mempolicy nodes as current if it is bound by such a policy
76 * and whether or not it has the same set of allowed cpuset nodes.
78 static bool has_intersects_mems_allowed(struct task_struct
*tsk
,
79 const nodemask_t
*mask
)
81 struct task_struct
*start
= tsk
;
86 * If this is a mempolicy constrained oom, tsk's
87 * cpuset is irrelevant. Only return true if its
88 * mempolicy intersects current, otherwise it may be
91 if (mempolicy_nodemask_intersects(tsk
, mask
))
95 * This is not a mempolicy constrained oom, so only
96 * check the mems of tsk's cpuset.
98 if (cpuset_mems_allowed_intersects(current
, tsk
))
101 } while_each_thread(start
, tsk
);
106 static bool has_intersects_mems_allowed(struct task_struct
*tsk
,
107 const nodemask_t
*mask
)
111 #endif /* CONFIG_NUMA */
114 * The process p may have detached its own ->mm while exiting or through
115 * use_mm(), but one or more of its subthreads may still have a valid
116 * pointer. Return p, or any of its subthreads with a valid ->mm, with
119 struct task_struct
*find_lock_task_mm(struct task_struct
*p
)
121 struct task_struct
*t
= p
;
128 } while_each_thread(p
, t
);
133 /* return true if the task is not adequate as candidate victim task. */
134 static bool oom_unkillable_task(struct task_struct
*p
,
135 const struct mem_cgroup
*mem
, const nodemask_t
*nodemask
)
137 if (is_global_init(p
))
139 if (p
->flags
& PF_KTHREAD
)
142 /* When mem_cgroup_out_of_memory() and p is not member of the group */
143 if (mem
&& !task_in_mem_cgroup(p
, mem
))
146 /* p may not have freeable memory in nodemask */
147 if (!has_intersects_mems_allowed(p
, nodemask
))
154 * oom_badness - heuristic function to determine which candidate task to kill
155 * @p: task struct of which task we should calculate
156 * @totalpages: total present RAM allowed for page allocation
158 * The heuristic for determining which task to kill is made to be as simple and
159 * predictable as possible. The goal is to return the highest value for the
160 * task consuming the most memory to avoid subsequent oom failures.
162 unsigned int oom_badness(struct task_struct
*p
, struct mem_cgroup
*mem
,
163 const nodemask_t
*nodemask
, unsigned long totalpages
)
167 if (oom_unkillable_task(p
, mem
, nodemask
))
170 p
= find_lock_task_mm(p
);
175 * Shortcut check for a thread sharing p->mm that is OOM_SCORE_ADJ_MIN
176 * so the entire heuristic doesn't need to be executed for something
177 * that cannot be killed.
179 if (atomic_read(&p
->mm
->oom_disable_count
)) {
185 * The memory controller may have a limit of 0 bytes, so avoid a divide
186 * by zero, if necessary.
192 * The baseline for the badness score is the proportion of RAM that each
193 * task's rss, pagetable and swap space use.
195 points
= get_mm_rss(p
->mm
) + p
->mm
->nr_ptes
;
196 points
+= get_mm_counter(p
->mm
, MM_SWAPENTS
);
199 points
/= totalpages
;
203 * Root processes get 3% bonus, just like the __vm_enough_memory()
204 * implementation used by LSMs.
206 if (has_capability_noaudit(p
, CAP_SYS_ADMIN
))
210 * /proc/pid/oom_score_adj ranges from -1000 to +1000 such that it may
211 * either completely disable oom killing or always prefer a certain
214 points
+= p
->signal
->oom_score_adj
;
217 * Never return 0 for an eligible task that may be killed since it's
218 * possible that no single user task uses more than 0.1% of memory and
219 * no single admin tasks uses more than 3.0%.
223 return (points
< 1000) ? points
: 1000;
227 * Determine the type of allocation constraint.
230 static enum oom_constraint
constrained_alloc(struct zonelist
*zonelist
,
231 gfp_t gfp_mask
, nodemask_t
*nodemask
,
232 unsigned long *totalpages
)
236 enum zone_type high_zoneidx
= gfp_zone(gfp_mask
);
237 bool cpuset_limited
= false;
240 /* Default to all available memory */
241 *totalpages
= totalram_pages
+ total_swap_pages
;
244 return CONSTRAINT_NONE
;
246 * Reach here only when __GFP_NOFAIL is used. So, we should avoid
247 * to kill current.We have to random task kill in this case.
248 * Hopefully, CONSTRAINT_THISNODE...but no way to handle it, now.
250 if (gfp_mask
& __GFP_THISNODE
)
251 return CONSTRAINT_NONE
;
254 * This is not a __GFP_THISNODE allocation, so a truncated nodemask in
255 * the page allocator means a mempolicy is in effect. Cpuset policy
256 * is enforced in get_page_from_freelist().
258 if (nodemask
&& !nodes_subset(node_states
[N_HIGH_MEMORY
], *nodemask
)) {
259 *totalpages
= total_swap_pages
;
260 for_each_node_mask(nid
, *nodemask
)
261 *totalpages
+= node_spanned_pages(nid
);
262 return CONSTRAINT_MEMORY_POLICY
;
265 /* Check this allocation failure is caused by cpuset's wall function */
266 for_each_zone_zonelist_nodemask(zone
, z
, zonelist
,
267 high_zoneidx
, nodemask
)
268 if (!cpuset_zone_allowed_softwall(zone
, gfp_mask
))
269 cpuset_limited
= true;
271 if (cpuset_limited
) {
272 *totalpages
= total_swap_pages
;
273 for_each_node_mask(nid
, cpuset_current_mems_allowed
)
274 *totalpages
+= node_spanned_pages(nid
);
275 return CONSTRAINT_CPUSET
;
277 return CONSTRAINT_NONE
;
280 static enum oom_constraint
constrained_alloc(struct zonelist
*zonelist
,
281 gfp_t gfp_mask
, nodemask_t
*nodemask
,
282 unsigned long *totalpages
)
284 *totalpages
= totalram_pages
+ total_swap_pages
;
285 return CONSTRAINT_NONE
;
290 * Simple selection loop. We chose the process with the highest
291 * number of 'points'. We expect the caller will lock the tasklist.
293 * (not docbooked, we don't want this one cluttering up the manual)
295 static struct task_struct
*select_bad_process(unsigned int *ppoints
,
296 unsigned long totalpages
, struct mem_cgroup
*mem
,
297 const nodemask_t
*nodemask
)
299 struct task_struct
*g
, *p
;
300 struct task_struct
*chosen
= NULL
;
303 do_each_thread(g
, p
) {
308 if (oom_unkillable_task(p
, mem
, nodemask
))
312 * This task already has access to memory reserves and is
313 * being killed. Don't allow any other task access to the
316 * Note: this may have a chance of deadlock if it gets
317 * blocked waiting for another task which itself is waiting
318 * for memory. Is there a better alternative?
320 if (test_tsk_thread_flag(p
, TIF_MEMDIE
))
321 return ERR_PTR(-1UL);
325 if (p
->flags
& PF_EXITING
) {
327 * If p is the current task and is in the process of
328 * releasing memory, we allow the "kill" to set
329 * TIF_MEMDIE, which will allow it to gain access to
330 * memory reserves. Otherwise, it may stall forever.
332 * The loop isn't broken here, however, in case other
333 * threads are found to have already been oom killed.
340 * If this task is not being ptraced on exit,
341 * then wait for it to finish before killing
342 * some other task unnecessarily.
344 if (!(p
->group_leader
->ptrace
& PT_TRACE_EXIT
))
345 return ERR_PTR(-1UL);
349 points
= oom_badness(p
, mem
, nodemask
, totalpages
);
350 if (points
> *ppoints
) {
354 } while_each_thread(g
, p
);
360 * dump_tasks - dump current memory state of all system tasks
361 * @mem: current's memory controller, if constrained
362 * @nodemask: nodemask passed to page allocator for mempolicy ooms
364 * Dumps the current memory state of all eligible tasks. Tasks not in the same
365 * memcg, not in the same cpuset, or bound to a disjoint set of mempolicy nodes
367 * State information includes task's pid, uid, tgid, vm size, rss, cpu, oom_adj
368 * value, oom_score_adj value, and name.
370 * Call with tasklist_lock read-locked.
372 static void dump_tasks(const struct mem_cgroup
*mem
, const nodemask_t
*nodemask
)
374 struct task_struct
*p
;
375 struct task_struct
*task
;
377 pr_info("[ pid ] uid tgid total_vm rss cpu oom_adj oom_score_adj name\n");
378 for_each_process(p
) {
379 if (oom_unkillable_task(p
, mem
, nodemask
))
382 task
= find_lock_task_mm(p
);
385 * This is a kthread or all of p's threads have already
386 * detached their mm's. There's no need to report
387 * them; they can't be oom killed anyway.
392 pr_info("[%5d] %5d %5d %8lu %8lu %3u %3d %5d %s\n",
393 task
->pid
, task_uid(task
), task
->tgid
,
394 task
->mm
->total_vm
, get_mm_rss(task
->mm
),
395 task_cpu(task
), task
->signal
->oom_adj
,
396 task
->signal
->oom_score_adj
, task
->comm
);
401 static void dump_header(struct task_struct
*p
, gfp_t gfp_mask
, int order
,
402 struct mem_cgroup
*mem
, const nodemask_t
*nodemask
)
405 pr_warning("%s invoked oom-killer: gfp_mask=0x%x, order=%d, "
406 "oom_adj=%d, oom_score_adj=%d\n",
407 current
->comm
, gfp_mask
, order
, current
->signal
->oom_adj
,
408 current
->signal
->oom_score_adj
);
409 cpuset_print_task_mems_allowed(current
);
410 task_unlock(current
);
412 mem_cgroup_print_oom_info(mem
, p
);
413 show_mem(SHOW_MEM_FILTER_NODES
);
414 if (sysctl_oom_dump_tasks
)
415 dump_tasks(mem
, nodemask
);
418 #define K(x) ((x) << (PAGE_SHIFT-10))
419 static int oom_kill_task(struct task_struct
*p
, struct mem_cgroup
*mem
)
421 struct task_struct
*q
;
422 struct mm_struct
*mm
;
424 p
= find_lock_task_mm(p
);
428 /* mm cannot be safely dereferenced after task_unlock(p) */
431 pr_err("Killed process %d (%s) total-vm:%lukB, anon-rss:%lukB, file-rss:%lukB\n",
432 task_pid_nr(p
), p
->comm
, K(p
->mm
->total_vm
),
433 K(get_mm_counter(p
->mm
, MM_ANONPAGES
)),
434 K(get_mm_counter(p
->mm
, MM_FILEPAGES
)));
438 * Kill all processes sharing p->mm in other thread groups, if any.
439 * They don't get access to memory reserves or a higher scheduler
440 * priority, though, to avoid depletion of all memory or task
441 * starvation. This prevents mm->mmap_sem livelock when an oom killed
442 * task cannot exit because it requires the semaphore and its contended
443 * by another thread trying to allocate memory itself. That thread will
444 * now get access to memory reserves since it has a pending fatal
448 if (q
->mm
== mm
&& !same_thread_group(q
, p
)) {
449 task_lock(q
); /* Protect ->comm from prctl() */
450 pr_err("Kill process %d (%s) sharing same memory\n",
451 task_pid_nr(q
), q
->comm
);
453 force_sig(SIGKILL
, q
);
456 set_tsk_thread_flag(p
, TIF_MEMDIE
);
457 force_sig(SIGKILL
, p
);
463 static int oom_kill_process(struct task_struct
*p
, gfp_t gfp_mask
, int order
,
464 unsigned int points
, unsigned long totalpages
,
465 struct mem_cgroup
*mem
, nodemask_t
*nodemask
,
468 struct task_struct
*victim
= p
;
469 struct task_struct
*child
;
470 struct task_struct
*t
= p
;
471 unsigned int victim_points
= 0;
473 if (printk_ratelimit())
474 dump_header(p
, gfp_mask
, order
, mem
, nodemask
);
477 * If the task is already exiting, don't alarm the sysadmin or kill
478 * its children or threads, just set TIF_MEMDIE so it can die quickly
480 if (p
->flags
& PF_EXITING
) {
481 set_tsk_thread_flag(p
, TIF_MEMDIE
);
486 pr_err("%s: Kill process %d (%s) score %d or sacrifice child\n",
487 message
, task_pid_nr(p
), p
->comm
, points
);
491 * If any of p's children has a different mm and is eligible for kill,
492 * the one with the highest oom_badness() score is sacrificed for its
493 * parent. This attempts to lose the minimal amount of work done while
494 * still freeing memory.
497 list_for_each_entry(child
, &t
->children
, sibling
) {
498 unsigned int child_points
;
500 if (child
->mm
== p
->mm
)
503 * oom_badness() returns 0 if the thread is unkillable
505 child_points
= oom_badness(child
, mem
, nodemask
,
507 if (child_points
> victim_points
) {
509 victim_points
= child_points
;
512 } while_each_thread(p
, t
);
514 return oom_kill_task(victim
, mem
);
518 * Determines whether the kernel must panic because of the panic_on_oom sysctl.
520 static void check_panic_on_oom(enum oom_constraint constraint
, gfp_t gfp_mask
,
521 int order
, const nodemask_t
*nodemask
)
523 if (likely(!sysctl_panic_on_oom
))
525 if (sysctl_panic_on_oom
!= 2) {
527 * panic_on_oom == 1 only affects CONSTRAINT_NONE, the kernel
528 * does not panic for cpuset, mempolicy, or memcg allocation
531 if (constraint
!= CONSTRAINT_NONE
)
534 read_lock(&tasklist_lock
);
535 dump_header(NULL
, gfp_mask
, order
, NULL
, nodemask
);
536 read_unlock(&tasklist_lock
);
537 panic("Out of memory: %s panic_on_oom is enabled\n",
538 sysctl_panic_on_oom
== 2 ? "compulsory" : "system-wide");
541 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
542 void mem_cgroup_out_of_memory(struct mem_cgroup
*mem
, gfp_t gfp_mask
)
545 unsigned int points
= 0;
546 struct task_struct
*p
;
549 * If current has a pending SIGKILL, then automatically select it. The
550 * goal is to allow it to allocate so that it may quickly exit and free
553 if (fatal_signal_pending(current
)) {
554 set_thread_flag(TIF_MEMDIE
);
558 check_panic_on_oom(CONSTRAINT_MEMCG
, gfp_mask
, 0, NULL
);
559 limit
= mem_cgroup_get_limit(mem
) >> PAGE_SHIFT
;
560 read_lock(&tasklist_lock
);
562 p
= select_bad_process(&points
, limit
, mem
, NULL
);
563 if (!p
|| PTR_ERR(p
) == -1UL)
566 if (oom_kill_process(p
, gfp_mask
, 0, points
, limit
, mem
, NULL
,
567 "Memory cgroup out of memory"))
570 read_unlock(&tasklist_lock
);
574 static BLOCKING_NOTIFIER_HEAD(oom_notify_list
);
576 int register_oom_notifier(struct notifier_block
*nb
)
578 return blocking_notifier_chain_register(&oom_notify_list
, nb
);
580 EXPORT_SYMBOL_GPL(register_oom_notifier
);
582 int unregister_oom_notifier(struct notifier_block
*nb
)
584 return blocking_notifier_chain_unregister(&oom_notify_list
, nb
);
586 EXPORT_SYMBOL_GPL(unregister_oom_notifier
);
589 * Try to acquire the OOM killer lock for the zones in zonelist. Returns zero
590 * if a parallel OOM killing is already taking place that includes a zone in
591 * the zonelist. Otherwise, locks all zones in the zonelist and returns 1.
593 int try_set_zonelist_oom(struct zonelist
*zonelist
, gfp_t gfp_mask
)
599 spin_lock(&zone_scan_lock
);
600 for_each_zone_zonelist(zone
, z
, zonelist
, gfp_zone(gfp_mask
)) {
601 if (zone_is_oom_locked(zone
)) {
607 for_each_zone_zonelist(zone
, z
, zonelist
, gfp_zone(gfp_mask
)) {
609 * Lock each zone in the zonelist under zone_scan_lock so a
610 * parallel invocation of try_set_zonelist_oom() doesn't succeed
613 zone_set_flag(zone
, ZONE_OOM_LOCKED
);
617 spin_unlock(&zone_scan_lock
);
622 * Clears the ZONE_OOM_LOCKED flag for all zones in the zonelist so that failed
623 * allocation attempts with zonelists containing them may now recall the OOM
624 * killer, if necessary.
626 void clear_zonelist_oom(struct zonelist
*zonelist
, gfp_t gfp_mask
)
631 spin_lock(&zone_scan_lock
);
632 for_each_zone_zonelist(zone
, z
, zonelist
, gfp_zone(gfp_mask
)) {
633 zone_clear_flag(zone
, ZONE_OOM_LOCKED
);
635 spin_unlock(&zone_scan_lock
);
639 * Try to acquire the oom killer lock for all system zones. Returns zero if a
640 * parallel oom killing is taking place, otherwise locks all zones and returns
643 static int try_set_system_oom(void)
648 spin_lock(&zone_scan_lock
);
649 for_each_populated_zone(zone
)
650 if (zone_is_oom_locked(zone
)) {
654 for_each_populated_zone(zone
)
655 zone_set_flag(zone
, ZONE_OOM_LOCKED
);
657 spin_unlock(&zone_scan_lock
);
662 * Clears ZONE_OOM_LOCKED for all system zones so that failed allocation
663 * attempts or page faults may now recall the oom killer, if necessary.
665 static void clear_system_oom(void)
669 spin_lock(&zone_scan_lock
);
670 for_each_populated_zone(zone
)
671 zone_clear_flag(zone
, ZONE_OOM_LOCKED
);
672 spin_unlock(&zone_scan_lock
);
676 * out_of_memory - kill the "best" process when we run out of memory
677 * @zonelist: zonelist pointer
678 * @gfp_mask: memory allocation flags
679 * @order: amount of memory being requested as a power of 2
680 * @nodemask: nodemask passed to page allocator
682 * If we run out of memory, we have the choice between either
683 * killing a random task (bad), letting the system crash (worse)
684 * OR try to be smart about which process to kill. Note that we
685 * don't have to be perfect here, we just have to be good.
687 void out_of_memory(struct zonelist
*zonelist
, gfp_t gfp_mask
,
688 int order
, nodemask_t
*nodemask
)
690 const nodemask_t
*mpol_mask
;
691 struct task_struct
*p
;
692 unsigned long totalpages
;
693 unsigned long freed
= 0;
695 enum oom_constraint constraint
= CONSTRAINT_NONE
;
698 blocking_notifier_call_chain(&oom_notify_list
, 0, &freed
);
700 /* Got some memory back in the last second. */
704 * If current has a pending SIGKILL, then automatically select it. The
705 * goal is to allow it to allocate so that it may quickly exit and free
708 if (fatal_signal_pending(current
)) {
709 set_thread_flag(TIF_MEMDIE
);
714 * Check if there were limitations on the allocation (only relevant for
715 * NUMA) that may require different handling.
717 constraint
= constrained_alloc(zonelist
, gfp_mask
, nodemask
,
719 mpol_mask
= (constraint
== CONSTRAINT_MEMORY_POLICY
) ? nodemask
: NULL
;
720 check_panic_on_oom(constraint
, gfp_mask
, order
, mpol_mask
);
722 read_lock(&tasklist_lock
);
723 if (sysctl_oom_kill_allocating_task
&&
724 !oom_unkillable_task(current
, NULL
, nodemask
) &&
725 current
->mm
&& !atomic_read(¤t
->mm
->oom_disable_count
)) {
727 * oom_kill_process() needs tasklist_lock held. If it returns
728 * non-zero, current could not be killed so we must fallback to
731 if (!oom_kill_process(current
, gfp_mask
, order
, 0, totalpages
,
733 "Out of memory (oom_kill_allocating_task)"))
738 p
= select_bad_process(&points
, totalpages
, NULL
, mpol_mask
);
739 if (PTR_ERR(p
) == -1UL)
742 /* Found nothing?!?! Either we hang forever, or we panic. */
744 dump_header(NULL
, gfp_mask
, order
, NULL
, mpol_mask
);
745 read_unlock(&tasklist_lock
);
746 panic("Out of memory and no killable processes...\n");
749 if (oom_kill_process(p
, gfp_mask
, order
, points
, totalpages
, NULL
,
750 nodemask
, "Out of memory"))
754 read_unlock(&tasklist_lock
);
757 * Give "p" a good chance of killing itself before we
758 * retry to allocate memory unless "p" is current
760 if (killed
&& !test_thread_flag(TIF_MEMDIE
))
761 schedule_timeout_uninterruptible(1);
765 * The pagefault handler calls here because it is out of memory, so kill a
766 * memory-hogging task. If a populated zone has ZONE_OOM_LOCKED set, a parallel
767 * oom killing is already in progress so do nothing. If a task is found with
768 * TIF_MEMDIE set, it has been killed so do nothing and allow it to exit.
770 void pagefault_out_of_memory(void)
772 if (try_set_system_oom()) {
773 out_of_memory(NULL
, 0, 0, NULL
);
776 if (!test_thread_flag(TIF_MEMDIE
))
777 schedule_timeout_uninterruptible(1);