xref: /openbmc/linux/mm/oom_kill.c (revision bbecb07f)
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  *  Copyright (C)  2010  Google, Inc.
8  *	Rewritten by David Rientjes
9  *
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.
13  *
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.
18  */
19 
20 #include <linux/oom.h>
21 #include <linux/mm.h>
22 #include <linux/err.h>
23 #include <linux/gfp.h>
24 #include <linux/sched.h>
25 #include <linux/sched/mm.h>
26 #include <linux/sched/coredump.h>
27 #include <linux/sched/task.h>
28 #include <linux/swap.h>
29 #include <linux/timex.h>
30 #include <linux/jiffies.h>
31 #include <linux/cpuset.h>
32 #include <linux/export.h>
33 #include <linux/notifier.h>
34 #include <linux/memcontrol.h>
35 #include <linux/mempolicy.h>
36 #include <linux/security.h>
37 #include <linux/ptrace.h>
38 #include <linux/freezer.h>
39 #include <linux/ftrace.h>
40 #include <linux/ratelimit.h>
41 #include <linux/kthread.h>
42 #include <linux/init.h>
43 #include <linux/mmu_notifier.h>
44 
45 #include <asm/tlb.h>
46 #include "internal.h"
47 #include "slab.h"
48 
49 #define CREATE_TRACE_POINTS
50 #include <trace/events/oom.h>
51 
52 int sysctl_panic_on_oom;
53 int sysctl_oom_kill_allocating_task;
54 int sysctl_oom_dump_tasks = 1;
55 
56 DEFINE_MUTEX(oom_lock);
57 
58 #ifdef CONFIG_NUMA
59 /**
60  * has_intersects_mems_allowed() - check task eligiblity for kill
61  * @start: task struct of which task to consider
62  * @mask: nodemask passed to page allocator for mempolicy ooms
63  *
64  * Task eligibility is determined by whether or not a candidate task, @tsk,
65  * shares the same mempolicy nodes as current if it is bound by such a policy
66  * and whether or not it has the same set of allowed cpuset nodes.
67  */
68 static bool has_intersects_mems_allowed(struct task_struct *start,
69 					const nodemask_t *mask)
70 {
71 	struct task_struct *tsk;
72 	bool ret = false;
73 
74 	rcu_read_lock();
75 	for_each_thread(start, tsk) {
76 		if (mask) {
77 			/*
78 			 * If this is a mempolicy constrained oom, tsk's
79 			 * cpuset is irrelevant.  Only return true if its
80 			 * mempolicy intersects current, otherwise it may be
81 			 * needlessly killed.
82 			 */
83 			ret = mempolicy_nodemask_intersects(tsk, mask);
84 		} else {
85 			/*
86 			 * This is not a mempolicy constrained oom, so only
87 			 * check the mems of tsk's cpuset.
88 			 */
89 			ret = cpuset_mems_allowed_intersects(current, tsk);
90 		}
91 		if (ret)
92 			break;
93 	}
94 	rcu_read_unlock();
95 
96 	return ret;
97 }
98 #else
99 static bool has_intersects_mems_allowed(struct task_struct *tsk,
100 					const nodemask_t *mask)
101 {
102 	return true;
103 }
104 #endif /* CONFIG_NUMA */
105 
106 /*
107  * The process p may have detached its own ->mm while exiting or through
108  * use_mm(), but one or more of its subthreads may still have a valid
109  * pointer.  Return p, or any of its subthreads with a valid ->mm, with
110  * task_lock() held.
111  */
112 struct task_struct *find_lock_task_mm(struct task_struct *p)
113 {
114 	struct task_struct *t;
115 
116 	rcu_read_lock();
117 
118 	for_each_thread(p, t) {
119 		task_lock(t);
120 		if (likely(t->mm))
121 			goto found;
122 		task_unlock(t);
123 	}
124 	t = NULL;
125 found:
126 	rcu_read_unlock();
127 
128 	return t;
129 }
130 
131 /*
132  * order == -1 means the oom kill is required by sysrq, otherwise only
133  * for display purposes.
134  */
135 static inline bool is_sysrq_oom(struct oom_control *oc)
136 {
137 	return oc->order == -1;
138 }
139 
140 static inline bool is_memcg_oom(struct oom_control *oc)
141 {
142 	return oc->memcg != NULL;
143 }
144 
145 /* return true if the task is not adequate as candidate victim task. */
146 static bool oom_unkillable_task(struct task_struct *p,
147 		struct mem_cgroup *memcg, const nodemask_t *nodemask)
148 {
149 	if (is_global_init(p))
150 		return true;
151 	if (p->flags & PF_KTHREAD)
152 		return true;
153 
154 	/* When mem_cgroup_out_of_memory() and p is not member of the group */
155 	if (memcg && !task_in_mem_cgroup(p, memcg))
156 		return true;
157 
158 	/* p may not have freeable memory in nodemask */
159 	if (!has_intersects_mems_allowed(p, nodemask))
160 		return true;
161 
162 	return false;
163 }
164 
165 /*
166  * Print out unreclaimble slabs info when unreclaimable slabs amount is greater
167  * than all user memory (LRU pages)
168  */
169 static bool is_dump_unreclaim_slabs(void)
170 {
171 	unsigned long nr_lru;
172 
173 	nr_lru = global_node_page_state(NR_ACTIVE_ANON) +
174 		 global_node_page_state(NR_INACTIVE_ANON) +
175 		 global_node_page_state(NR_ACTIVE_FILE) +
176 		 global_node_page_state(NR_INACTIVE_FILE) +
177 		 global_node_page_state(NR_ISOLATED_ANON) +
178 		 global_node_page_state(NR_ISOLATED_FILE) +
179 		 global_node_page_state(NR_UNEVICTABLE);
180 
181 	return (global_node_page_state(NR_SLAB_UNRECLAIMABLE) > nr_lru);
182 }
183 
184 /**
185  * oom_badness - heuristic function to determine which candidate task to kill
186  * @p: task struct of which task we should calculate
187  * @totalpages: total present RAM allowed for page allocation
188  *
189  * The heuristic for determining which task to kill is made to be as simple and
190  * predictable as possible.  The goal is to return the highest value for the
191  * task consuming the most memory to avoid subsequent oom failures.
192  */
193 unsigned long oom_badness(struct task_struct *p, struct mem_cgroup *memcg,
194 			  const nodemask_t *nodemask, unsigned long totalpages)
195 {
196 	long points;
197 	long adj;
198 
199 	if (oom_unkillable_task(p, memcg, nodemask))
200 		return 0;
201 
202 	p = find_lock_task_mm(p);
203 	if (!p)
204 		return 0;
205 
206 	/*
207 	 * Do not even consider tasks which are explicitly marked oom
208 	 * unkillable or have been already oom reaped or the are in
209 	 * the middle of vfork
210 	 */
211 	adj = (long)p->signal->oom_score_adj;
212 	if (adj == OOM_SCORE_ADJ_MIN ||
213 			test_bit(MMF_OOM_SKIP, &p->mm->flags) ||
214 			in_vfork(p)) {
215 		task_unlock(p);
216 		return 0;
217 	}
218 
219 	/*
220 	 * The baseline for the badness score is the proportion of RAM that each
221 	 * task's rss, pagetable and swap space use.
222 	 */
223 	points = get_mm_rss(p->mm) + get_mm_counter(p->mm, MM_SWAPENTS) +
224 		mm_pgtables_bytes(p->mm) / PAGE_SIZE;
225 	task_unlock(p);
226 
227 	/*
228 	 * Root processes get 3% bonus, just like the __vm_enough_memory()
229 	 * implementation used by LSMs.
230 	 */
231 	if (has_capability_noaudit(p, CAP_SYS_ADMIN))
232 		points -= (points * 3) / 100;
233 
234 	/* Normalize to oom_score_adj units */
235 	adj *= totalpages / 1000;
236 	points += adj;
237 
238 	/*
239 	 * Never return 0 for an eligible task regardless of the root bonus and
240 	 * oom_score_adj (oom_score_adj can't be OOM_SCORE_ADJ_MIN here).
241 	 */
242 	return points > 0 ? points : 1;
243 }
244 
245 enum oom_constraint {
246 	CONSTRAINT_NONE,
247 	CONSTRAINT_CPUSET,
248 	CONSTRAINT_MEMORY_POLICY,
249 	CONSTRAINT_MEMCG,
250 };
251 
252 /*
253  * Determine the type of allocation constraint.
254  */
255 static enum oom_constraint constrained_alloc(struct oom_control *oc)
256 {
257 	struct zone *zone;
258 	struct zoneref *z;
259 	enum zone_type high_zoneidx = gfp_zone(oc->gfp_mask);
260 	bool cpuset_limited = false;
261 	int nid;
262 
263 	if (is_memcg_oom(oc)) {
264 		oc->totalpages = mem_cgroup_get_limit(oc->memcg) ?: 1;
265 		return CONSTRAINT_MEMCG;
266 	}
267 
268 	/* Default to all available memory */
269 	oc->totalpages = totalram_pages + total_swap_pages;
270 
271 	if (!IS_ENABLED(CONFIG_NUMA))
272 		return CONSTRAINT_NONE;
273 
274 	if (!oc->zonelist)
275 		return CONSTRAINT_NONE;
276 	/*
277 	 * Reach here only when __GFP_NOFAIL is used. So, we should avoid
278 	 * to kill current.We have to random task kill in this case.
279 	 * Hopefully, CONSTRAINT_THISNODE...but no way to handle it, now.
280 	 */
281 	if (oc->gfp_mask & __GFP_THISNODE)
282 		return CONSTRAINT_NONE;
283 
284 	/*
285 	 * This is not a __GFP_THISNODE allocation, so a truncated nodemask in
286 	 * the page allocator means a mempolicy is in effect.  Cpuset policy
287 	 * is enforced in get_page_from_freelist().
288 	 */
289 	if (oc->nodemask &&
290 	    !nodes_subset(node_states[N_MEMORY], *oc->nodemask)) {
291 		oc->totalpages = total_swap_pages;
292 		for_each_node_mask(nid, *oc->nodemask)
293 			oc->totalpages += node_spanned_pages(nid);
294 		return CONSTRAINT_MEMORY_POLICY;
295 	}
296 
297 	/* Check this allocation failure is caused by cpuset's wall function */
298 	for_each_zone_zonelist_nodemask(zone, z, oc->zonelist,
299 			high_zoneidx, oc->nodemask)
300 		if (!cpuset_zone_allowed(zone, oc->gfp_mask))
301 			cpuset_limited = true;
302 
303 	if (cpuset_limited) {
304 		oc->totalpages = total_swap_pages;
305 		for_each_node_mask(nid, cpuset_current_mems_allowed)
306 			oc->totalpages += node_spanned_pages(nid);
307 		return CONSTRAINT_CPUSET;
308 	}
309 	return CONSTRAINT_NONE;
310 }
311 
312 static int oom_evaluate_task(struct task_struct *task, void *arg)
313 {
314 	struct oom_control *oc = arg;
315 	unsigned long points;
316 
317 	if (oom_unkillable_task(task, NULL, oc->nodemask))
318 		goto next;
319 
320 	/*
321 	 * This task already has access to memory reserves and is being killed.
322 	 * Don't allow any other task to have access to the reserves unless
323 	 * the task has MMF_OOM_SKIP because chances that it would release
324 	 * any memory is quite low.
325 	 */
326 	if (!is_sysrq_oom(oc) && tsk_is_oom_victim(task)) {
327 		if (test_bit(MMF_OOM_SKIP, &task->signal->oom_mm->flags))
328 			goto next;
329 		goto abort;
330 	}
331 
332 	/*
333 	 * If task is allocating a lot of memory and has been marked to be
334 	 * killed first if it triggers an oom, then select it.
335 	 */
336 	if (oom_task_origin(task)) {
337 		points = ULONG_MAX;
338 		goto select;
339 	}
340 
341 	points = oom_badness(task, NULL, oc->nodemask, oc->totalpages);
342 	if (!points || points < oc->chosen_points)
343 		goto next;
344 
345 	/* Prefer thread group leaders for display purposes */
346 	if (points == oc->chosen_points && thread_group_leader(oc->chosen))
347 		goto next;
348 select:
349 	if (oc->chosen)
350 		put_task_struct(oc->chosen);
351 	get_task_struct(task);
352 	oc->chosen = task;
353 	oc->chosen_points = points;
354 next:
355 	return 0;
356 abort:
357 	if (oc->chosen)
358 		put_task_struct(oc->chosen);
359 	oc->chosen = (void *)-1UL;
360 	return 1;
361 }
362 
363 /*
364  * Simple selection loop. We choose the process with the highest number of
365  * 'points'. In case scan was aborted, oc->chosen is set to -1.
366  */
367 static void select_bad_process(struct oom_control *oc)
368 {
369 	if (is_memcg_oom(oc))
370 		mem_cgroup_scan_tasks(oc->memcg, oom_evaluate_task, oc);
371 	else {
372 		struct task_struct *p;
373 
374 		rcu_read_lock();
375 		for_each_process(p)
376 			if (oom_evaluate_task(p, oc))
377 				break;
378 		rcu_read_unlock();
379 	}
380 
381 	oc->chosen_points = oc->chosen_points * 1000 / oc->totalpages;
382 }
383 
384 /**
385  * dump_tasks - dump current memory state of all system tasks
386  * @memcg: current's memory controller, if constrained
387  * @nodemask: nodemask passed to page allocator for mempolicy ooms
388  *
389  * Dumps the current memory state of all eligible tasks.  Tasks not in the same
390  * memcg, not in the same cpuset, or bound to a disjoint set of mempolicy nodes
391  * are not shown.
392  * State information includes task's pid, uid, tgid, vm size, rss,
393  * pgtables_bytes, swapents, oom_score_adj value, and name.
394  */
395 static void dump_tasks(struct mem_cgroup *memcg, const nodemask_t *nodemask)
396 {
397 	struct task_struct *p;
398 	struct task_struct *task;
399 
400 	pr_info("[ pid ]   uid  tgid total_vm      rss pgtables_bytes swapents oom_score_adj name\n");
401 	rcu_read_lock();
402 	for_each_process(p) {
403 		if (oom_unkillable_task(p, memcg, nodemask))
404 			continue;
405 
406 		task = find_lock_task_mm(p);
407 		if (!task) {
408 			/*
409 			 * This is a kthread or all of p's threads have already
410 			 * detached their mm's.  There's no need to report
411 			 * them; they can't be oom killed anyway.
412 			 */
413 			continue;
414 		}
415 
416 		pr_info("[%5d] %5d %5d %8lu %8lu %8ld %8lu         %5hd %s\n",
417 			task->pid, from_kuid(&init_user_ns, task_uid(task)),
418 			task->tgid, task->mm->total_vm, get_mm_rss(task->mm),
419 			mm_pgtables_bytes(task->mm),
420 			get_mm_counter(task->mm, MM_SWAPENTS),
421 			task->signal->oom_score_adj, task->comm);
422 		task_unlock(task);
423 	}
424 	rcu_read_unlock();
425 }
426 
427 static void dump_header(struct oom_control *oc, struct task_struct *p)
428 {
429 	pr_warn("%s invoked oom-killer: gfp_mask=%#x(%pGg), nodemask=%*pbl, order=%d, oom_score_adj=%hd\n",
430 		current->comm, oc->gfp_mask, &oc->gfp_mask,
431 		nodemask_pr_args(oc->nodemask), oc->order,
432 			current->signal->oom_score_adj);
433 	if (!IS_ENABLED(CONFIG_COMPACTION) && oc->order)
434 		pr_warn("COMPACTION is disabled!!!\n");
435 
436 	cpuset_print_current_mems_allowed();
437 	dump_stack();
438 	if (is_memcg_oom(oc))
439 		mem_cgroup_print_oom_info(oc->memcg, p);
440 	else {
441 		show_mem(SHOW_MEM_FILTER_NODES, oc->nodemask);
442 		if (is_dump_unreclaim_slabs())
443 			dump_unreclaimable_slab();
444 	}
445 	if (sysctl_oom_dump_tasks)
446 		dump_tasks(oc->memcg, oc->nodemask);
447 }
448 
449 /*
450  * Number of OOM victims in flight
451  */
452 static atomic_t oom_victims = ATOMIC_INIT(0);
453 static DECLARE_WAIT_QUEUE_HEAD(oom_victims_wait);
454 
455 static bool oom_killer_disabled __read_mostly;
456 
457 #define K(x) ((x) << (PAGE_SHIFT-10))
458 
459 /*
460  * task->mm can be NULL if the task is the exited group leader.  So to
461  * determine whether the task is using a particular mm, we examine all the
462  * task's threads: if one of those is using this mm then this task was also
463  * using it.
464  */
465 bool process_shares_mm(struct task_struct *p, struct mm_struct *mm)
466 {
467 	struct task_struct *t;
468 
469 	for_each_thread(p, t) {
470 		struct mm_struct *t_mm = READ_ONCE(t->mm);
471 		if (t_mm)
472 			return t_mm == mm;
473 	}
474 	return false;
475 }
476 
477 
478 #ifdef CONFIG_MMU
479 /*
480  * OOM Reaper kernel thread which tries to reap the memory used by the OOM
481  * victim (if that is possible) to help the OOM killer to move on.
482  */
483 static struct task_struct *oom_reaper_th;
484 static DECLARE_WAIT_QUEUE_HEAD(oom_reaper_wait);
485 static struct task_struct *oom_reaper_list;
486 static DEFINE_SPINLOCK(oom_reaper_lock);
487 
488 static bool __oom_reap_task_mm(struct task_struct *tsk, struct mm_struct *mm)
489 {
490 	struct mmu_gather tlb;
491 	struct vm_area_struct *vma;
492 	bool ret = true;
493 
494 	/*
495 	 * We have to make sure to not race with the victim exit path
496 	 * and cause premature new oom victim selection:
497 	 * __oom_reap_task_mm		exit_mm
498 	 *   mmget_not_zero
499 	 *				  mmput
500 	 *				    atomic_dec_and_test
501 	 *				  exit_oom_victim
502 	 *				[...]
503 	 *				out_of_memory
504 	 *				  select_bad_process
505 	 *				    # no TIF_MEMDIE task selects new victim
506 	 *  unmap_page_range # frees some memory
507 	 */
508 	mutex_lock(&oom_lock);
509 
510 	if (!down_read_trylock(&mm->mmap_sem)) {
511 		ret = false;
512 		trace_skip_task_reaping(tsk->pid);
513 		goto unlock_oom;
514 	}
515 
516 	/*
517 	 * If the mm has notifiers then we would need to invalidate them around
518 	 * unmap_page_range and that is risky because notifiers can sleep and
519 	 * what they do is basically undeterministic.  So let's have a short
520 	 * sleep to give the oom victim some more time.
521 	 * TODO: we really want to get rid of this ugly hack and make sure that
522 	 * notifiers cannot block for unbounded amount of time and add
523 	 * mmu_notifier_invalidate_range_{start,end} around unmap_page_range
524 	 */
525 	if (mm_has_notifiers(mm)) {
526 		up_read(&mm->mmap_sem);
527 		schedule_timeout_idle(HZ);
528 		goto unlock_oom;
529 	}
530 
531 	/*
532 	 * MMF_OOM_SKIP is set by exit_mmap when the OOM reaper can't
533 	 * work on the mm anymore. The check for MMF_OOM_SKIP must run
534 	 * under mmap_sem for reading because it serializes against the
535 	 * down_write();up_write() cycle in exit_mmap().
536 	 */
537 	if (test_bit(MMF_OOM_SKIP, &mm->flags)) {
538 		up_read(&mm->mmap_sem);
539 		trace_skip_task_reaping(tsk->pid);
540 		goto unlock_oom;
541 	}
542 
543 	trace_start_task_reaping(tsk->pid);
544 
545 	/*
546 	 * Tell all users of get_user/copy_from_user etc... that the content
547 	 * is no longer stable. No barriers really needed because unmapping
548 	 * should imply barriers already and the reader would hit a page fault
549 	 * if it stumbled over a reaped memory.
550 	 */
551 	set_bit(MMF_UNSTABLE, &mm->flags);
552 
553 	for (vma = mm->mmap ; vma; vma = vma->vm_next) {
554 		if (!can_madv_dontneed_vma(vma))
555 			continue;
556 
557 		/*
558 		 * Only anonymous pages have a good chance to be dropped
559 		 * without additional steps which we cannot afford as we
560 		 * are OOM already.
561 		 *
562 		 * We do not even care about fs backed pages because all
563 		 * which are reclaimable have already been reclaimed and
564 		 * we do not want to block exit_mmap by keeping mm ref
565 		 * count elevated without a good reason.
566 		 */
567 		if (vma_is_anonymous(vma) || !(vma->vm_flags & VM_SHARED)) {
568 			tlb_gather_mmu(&tlb, mm, vma->vm_start, vma->vm_end);
569 			unmap_page_range(&tlb, vma, vma->vm_start, vma->vm_end,
570 					 NULL);
571 			tlb_finish_mmu(&tlb, vma->vm_start, vma->vm_end);
572 		}
573 	}
574 	pr_info("oom_reaper: reaped process %d (%s), now anon-rss:%lukB, file-rss:%lukB, shmem-rss:%lukB\n",
575 			task_pid_nr(tsk), tsk->comm,
576 			K(get_mm_counter(mm, MM_ANONPAGES)),
577 			K(get_mm_counter(mm, MM_FILEPAGES)),
578 			K(get_mm_counter(mm, MM_SHMEMPAGES)));
579 	up_read(&mm->mmap_sem);
580 
581 	trace_finish_task_reaping(tsk->pid);
582 unlock_oom:
583 	mutex_unlock(&oom_lock);
584 	return ret;
585 }
586 
587 #define MAX_OOM_REAP_RETRIES 10
588 static void oom_reap_task(struct task_struct *tsk)
589 {
590 	int attempts = 0;
591 	struct mm_struct *mm = tsk->signal->oom_mm;
592 
593 	/* Retry the down_read_trylock(mmap_sem) a few times */
594 	while (attempts++ < MAX_OOM_REAP_RETRIES && !__oom_reap_task_mm(tsk, mm))
595 		schedule_timeout_idle(HZ/10);
596 
597 	if (attempts <= MAX_OOM_REAP_RETRIES)
598 		goto done;
599 
600 
601 	pr_info("oom_reaper: unable to reap pid:%d (%s)\n",
602 		task_pid_nr(tsk), tsk->comm);
603 	debug_show_all_locks();
604 
605 done:
606 	tsk->oom_reaper_list = NULL;
607 
608 	/*
609 	 * Hide this mm from OOM killer because it has been either reaped or
610 	 * somebody can't call up_write(mmap_sem).
611 	 */
612 	set_bit(MMF_OOM_SKIP, &mm->flags);
613 
614 	/* Drop a reference taken by wake_oom_reaper */
615 	put_task_struct(tsk);
616 }
617 
618 static int oom_reaper(void *unused)
619 {
620 	while (true) {
621 		struct task_struct *tsk = NULL;
622 
623 		wait_event_freezable(oom_reaper_wait, oom_reaper_list != NULL);
624 		spin_lock(&oom_reaper_lock);
625 		if (oom_reaper_list != NULL) {
626 			tsk = oom_reaper_list;
627 			oom_reaper_list = tsk->oom_reaper_list;
628 		}
629 		spin_unlock(&oom_reaper_lock);
630 
631 		if (tsk)
632 			oom_reap_task(tsk);
633 	}
634 
635 	return 0;
636 }
637 
638 static void wake_oom_reaper(struct task_struct *tsk)
639 {
640 	/* tsk is already queued? */
641 	if (tsk == oom_reaper_list || tsk->oom_reaper_list)
642 		return;
643 
644 	get_task_struct(tsk);
645 
646 	spin_lock(&oom_reaper_lock);
647 	tsk->oom_reaper_list = oom_reaper_list;
648 	oom_reaper_list = tsk;
649 	spin_unlock(&oom_reaper_lock);
650 	trace_wake_reaper(tsk->pid);
651 	wake_up(&oom_reaper_wait);
652 }
653 
654 static int __init oom_init(void)
655 {
656 	oom_reaper_th = kthread_run(oom_reaper, NULL, "oom_reaper");
657 	return 0;
658 }
659 subsys_initcall(oom_init)
660 #else
661 static inline void wake_oom_reaper(struct task_struct *tsk)
662 {
663 }
664 #endif /* CONFIG_MMU */
665 
666 /**
667  * mark_oom_victim - mark the given task as OOM victim
668  * @tsk: task to mark
669  *
670  * Has to be called with oom_lock held and never after
671  * oom has been disabled already.
672  *
673  * tsk->mm has to be non NULL and caller has to guarantee it is stable (either
674  * under task_lock or operate on the current).
675  */
676 static void mark_oom_victim(struct task_struct *tsk)
677 {
678 	struct mm_struct *mm = tsk->mm;
679 
680 	WARN_ON(oom_killer_disabled);
681 	/* OOM killer might race with memcg OOM */
682 	if (test_and_set_tsk_thread_flag(tsk, TIF_MEMDIE))
683 		return;
684 
685 	/* oom_mm is bound to the signal struct life time. */
686 	if (!cmpxchg(&tsk->signal->oom_mm, NULL, mm))
687 		mmgrab(tsk->signal->oom_mm);
688 
689 	/*
690 	 * Make sure that the task is woken up from uninterruptible sleep
691 	 * if it is frozen because OOM killer wouldn't be able to free
692 	 * any memory and livelock. freezing_slow_path will tell the freezer
693 	 * that TIF_MEMDIE tasks should be ignored.
694 	 */
695 	__thaw_task(tsk);
696 	atomic_inc(&oom_victims);
697 	trace_mark_victim(tsk->pid);
698 }
699 
700 /**
701  * exit_oom_victim - note the exit of an OOM victim
702  */
703 void exit_oom_victim(void)
704 {
705 	clear_thread_flag(TIF_MEMDIE);
706 
707 	if (!atomic_dec_return(&oom_victims))
708 		wake_up_all(&oom_victims_wait);
709 }
710 
711 /**
712  * oom_killer_enable - enable OOM killer
713  */
714 void oom_killer_enable(void)
715 {
716 	oom_killer_disabled = false;
717 	pr_info("OOM killer enabled.\n");
718 }
719 
720 /**
721  * oom_killer_disable - disable OOM killer
722  * @timeout: maximum timeout to wait for oom victims in jiffies
723  *
724  * Forces all page allocations to fail rather than trigger OOM killer.
725  * Will block and wait until all OOM victims are killed or the given
726  * timeout expires.
727  *
728  * The function cannot be called when there are runnable user tasks because
729  * the userspace would see unexpected allocation failures as a result. Any
730  * new usage of this function should be consulted with MM people.
731  *
732  * Returns true if successful and false if the OOM killer cannot be
733  * disabled.
734  */
735 bool oom_killer_disable(signed long timeout)
736 {
737 	signed long ret;
738 
739 	/*
740 	 * Make sure to not race with an ongoing OOM killer. Check that the
741 	 * current is not killed (possibly due to sharing the victim's memory).
742 	 */
743 	if (mutex_lock_killable(&oom_lock))
744 		return false;
745 	oom_killer_disabled = true;
746 	mutex_unlock(&oom_lock);
747 
748 	ret = wait_event_interruptible_timeout(oom_victims_wait,
749 			!atomic_read(&oom_victims), timeout);
750 	if (ret <= 0) {
751 		oom_killer_enable();
752 		return false;
753 	}
754 	pr_info("OOM killer disabled.\n");
755 
756 	return true;
757 }
758 
759 static inline bool __task_will_free_mem(struct task_struct *task)
760 {
761 	struct signal_struct *sig = task->signal;
762 
763 	/*
764 	 * A coredumping process may sleep for an extended period in exit_mm(),
765 	 * so the oom killer cannot assume that the process will promptly exit
766 	 * and release memory.
767 	 */
768 	if (sig->flags & SIGNAL_GROUP_COREDUMP)
769 		return false;
770 
771 	if (sig->flags & SIGNAL_GROUP_EXIT)
772 		return true;
773 
774 	if (thread_group_empty(task) && (task->flags & PF_EXITING))
775 		return true;
776 
777 	return false;
778 }
779 
780 /*
781  * Checks whether the given task is dying or exiting and likely to
782  * release its address space. This means that all threads and processes
783  * sharing the same mm have to be killed or exiting.
784  * Caller has to make sure that task->mm is stable (hold task_lock or
785  * it operates on the current).
786  */
787 static bool task_will_free_mem(struct task_struct *task)
788 {
789 	struct mm_struct *mm = task->mm;
790 	struct task_struct *p;
791 	bool ret = true;
792 
793 	/*
794 	 * Skip tasks without mm because it might have passed its exit_mm and
795 	 * exit_oom_victim. oom_reaper could have rescued that but do not rely
796 	 * on that for now. We can consider find_lock_task_mm in future.
797 	 */
798 	if (!mm)
799 		return false;
800 
801 	if (!__task_will_free_mem(task))
802 		return false;
803 
804 	/*
805 	 * This task has already been drained by the oom reaper so there are
806 	 * only small chances it will free some more
807 	 */
808 	if (test_bit(MMF_OOM_SKIP, &mm->flags))
809 		return false;
810 
811 	if (atomic_read(&mm->mm_users) <= 1)
812 		return true;
813 
814 	/*
815 	 * Make sure that all tasks which share the mm with the given tasks
816 	 * are dying as well to make sure that a) nobody pins its mm and
817 	 * b) the task is also reapable by the oom reaper.
818 	 */
819 	rcu_read_lock();
820 	for_each_process(p) {
821 		if (!process_shares_mm(p, mm))
822 			continue;
823 		if (same_thread_group(task, p))
824 			continue;
825 		ret = __task_will_free_mem(p);
826 		if (!ret)
827 			break;
828 	}
829 	rcu_read_unlock();
830 
831 	return ret;
832 }
833 
834 static void oom_kill_process(struct oom_control *oc, const char *message)
835 {
836 	struct task_struct *p = oc->chosen;
837 	unsigned int points = oc->chosen_points;
838 	struct task_struct *victim = p;
839 	struct task_struct *child;
840 	struct task_struct *t;
841 	struct mm_struct *mm;
842 	unsigned int victim_points = 0;
843 	static DEFINE_RATELIMIT_STATE(oom_rs, DEFAULT_RATELIMIT_INTERVAL,
844 					      DEFAULT_RATELIMIT_BURST);
845 	bool can_oom_reap = true;
846 
847 	/*
848 	 * If the task is already exiting, don't alarm the sysadmin or kill
849 	 * its children or threads, just give it access to memory reserves
850 	 * so it can die quickly
851 	 */
852 	task_lock(p);
853 	if (task_will_free_mem(p)) {
854 		mark_oom_victim(p);
855 		wake_oom_reaper(p);
856 		task_unlock(p);
857 		put_task_struct(p);
858 		return;
859 	}
860 	task_unlock(p);
861 
862 	if (__ratelimit(&oom_rs))
863 		dump_header(oc, p);
864 
865 	pr_err("%s: Kill process %d (%s) score %u or sacrifice child\n",
866 		message, task_pid_nr(p), p->comm, points);
867 
868 	/*
869 	 * If any of p's children has a different mm and is eligible for kill,
870 	 * the one with the highest oom_badness() score is sacrificed for its
871 	 * parent.  This attempts to lose the minimal amount of work done while
872 	 * still freeing memory.
873 	 */
874 	read_lock(&tasklist_lock);
875 	for_each_thread(p, t) {
876 		list_for_each_entry(child, &t->children, sibling) {
877 			unsigned int child_points;
878 
879 			if (process_shares_mm(child, p->mm))
880 				continue;
881 			/*
882 			 * oom_badness() returns 0 if the thread is unkillable
883 			 */
884 			child_points = oom_badness(child,
885 				oc->memcg, oc->nodemask, oc->totalpages);
886 			if (child_points > victim_points) {
887 				put_task_struct(victim);
888 				victim = child;
889 				victim_points = child_points;
890 				get_task_struct(victim);
891 			}
892 		}
893 	}
894 	read_unlock(&tasklist_lock);
895 
896 	p = find_lock_task_mm(victim);
897 	if (!p) {
898 		put_task_struct(victim);
899 		return;
900 	} else if (victim != p) {
901 		get_task_struct(p);
902 		put_task_struct(victim);
903 		victim = p;
904 	}
905 
906 	/* Get a reference to safely compare mm after task_unlock(victim) */
907 	mm = victim->mm;
908 	mmgrab(mm);
909 
910 	/* Raise event before sending signal: task reaper must see this */
911 	count_vm_event(OOM_KILL);
912 	count_memcg_event_mm(mm, OOM_KILL);
913 
914 	/*
915 	 * We should send SIGKILL before granting access to memory reserves
916 	 * in order to prevent the OOM victim from depleting the memory
917 	 * reserves from the user space under its control.
918 	 */
919 	do_send_sig_info(SIGKILL, SEND_SIG_FORCED, victim, true);
920 	mark_oom_victim(victim);
921 	pr_err("Killed process %d (%s) total-vm:%lukB, anon-rss:%lukB, file-rss:%lukB, shmem-rss:%lukB\n",
922 		task_pid_nr(victim), victim->comm, K(victim->mm->total_vm),
923 		K(get_mm_counter(victim->mm, MM_ANONPAGES)),
924 		K(get_mm_counter(victim->mm, MM_FILEPAGES)),
925 		K(get_mm_counter(victim->mm, MM_SHMEMPAGES)));
926 	task_unlock(victim);
927 
928 	/*
929 	 * Kill all user processes sharing victim->mm in other thread groups, if
930 	 * any.  They don't get access to memory reserves, though, to avoid
931 	 * depletion of all memory.  This prevents mm->mmap_sem livelock when an
932 	 * oom killed thread cannot exit because it requires the semaphore and
933 	 * its contended by another thread trying to allocate memory itself.
934 	 * That thread will now get access to memory reserves since it has a
935 	 * pending fatal signal.
936 	 */
937 	rcu_read_lock();
938 	for_each_process(p) {
939 		if (!process_shares_mm(p, mm))
940 			continue;
941 		if (same_thread_group(p, victim))
942 			continue;
943 		if (is_global_init(p)) {
944 			can_oom_reap = false;
945 			set_bit(MMF_OOM_SKIP, &mm->flags);
946 			pr_info("oom killer %d (%s) has mm pinned by %d (%s)\n",
947 					task_pid_nr(victim), victim->comm,
948 					task_pid_nr(p), p->comm);
949 			continue;
950 		}
951 		/*
952 		 * No use_mm() user needs to read from the userspace so we are
953 		 * ok to reap it.
954 		 */
955 		if (unlikely(p->flags & PF_KTHREAD))
956 			continue;
957 		do_send_sig_info(SIGKILL, SEND_SIG_FORCED, p, true);
958 	}
959 	rcu_read_unlock();
960 
961 	if (can_oom_reap)
962 		wake_oom_reaper(victim);
963 
964 	mmdrop(mm);
965 	put_task_struct(victim);
966 }
967 #undef K
968 
969 /*
970  * Determines whether the kernel must panic because of the panic_on_oom sysctl.
971  */
972 static void check_panic_on_oom(struct oom_control *oc,
973 			       enum oom_constraint constraint)
974 {
975 	if (likely(!sysctl_panic_on_oom))
976 		return;
977 	if (sysctl_panic_on_oom != 2) {
978 		/*
979 		 * panic_on_oom == 1 only affects CONSTRAINT_NONE, the kernel
980 		 * does not panic for cpuset, mempolicy, or memcg allocation
981 		 * failures.
982 		 */
983 		if (constraint != CONSTRAINT_NONE)
984 			return;
985 	}
986 	/* Do not panic for oom kills triggered by sysrq */
987 	if (is_sysrq_oom(oc))
988 		return;
989 	dump_header(oc, NULL);
990 	panic("Out of memory: %s panic_on_oom is enabled\n",
991 		sysctl_panic_on_oom == 2 ? "compulsory" : "system-wide");
992 }
993 
994 static BLOCKING_NOTIFIER_HEAD(oom_notify_list);
995 
996 int register_oom_notifier(struct notifier_block *nb)
997 {
998 	return blocking_notifier_chain_register(&oom_notify_list, nb);
999 }
1000 EXPORT_SYMBOL_GPL(register_oom_notifier);
1001 
1002 int unregister_oom_notifier(struct notifier_block *nb)
1003 {
1004 	return blocking_notifier_chain_unregister(&oom_notify_list, nb);
1005 }
1006 EXPORT_SYMBOL_GPL(unregister_oom_notifier);
1007 
1008 /**
1009  * out_of_memory - kill the "best" process when we run out of memory
1010  * @oc: pointer to struct oom_control
1011  *
1012  * If we run out of memory, we have the choice between either
1013  * killing a random task (bad), letting the system crash (worse)
1014  * OR try to be smart about which process to kill. Note that we
1015  * don't have to be perfect here, we just have to be good.
1016  */
1017 bool out_of_memory(struct oom_control *oc)
1018 {
1019 	unsigned long freed = 0;
1020 	enum oom_constraint constraint = CONSTRAINT_NONE;
1021 
1022 	if (oom_killer_disabled)
1023 		return false;
1024 
1025 	if (!is_memcg_oom(oc)) {
1026 		blocking_notifier_call_chain(&oom_notify_list, 0, &freed);
1027 		if (freed > 0)
1028 			/* Got some memory back in the last second. */
1029 			return true;
1030 	}
1031 
1032 	/*
1033 	 * If current has a pending SIGKILL or is exiting, then automatically
1034 	 * select it.  The goal is to allow it to allocate so that it may
1035 	 * quickly exit and free its memory.
1036 	 */
1037 	if (task_will_free_mem(current)) {
1038 		mark_oom_victim(current);
1039 		wake_oom_reaper(current);
1040 		return true;
1041 	}
1042 
1043 	/*
1044 	 * The OOM killer does not compensate for IO-less reclaim.
1045 	 * pagefault_out_of_memory lost its gfp context so we have to
1046 	 * make sure exclude 0 mask - all other users should have at least
1047 	 * ___GFP_DIRECT_RECLAIM to get here.
1048 	 */
1049 	if (oc->gfp_mask && !(oc->gfp_mask & __GFP_FS))
1050 		return true;
1051 
1052 	/*
1053 	 * Check if there were limitations on the allocation (only relevant for
1054 	 * NUMA and memcg) that may require different handling.
1055 	 */
1056 	constraint = constrained_alloc(oc);
1057 	if (constraint != CONSTRAINT_MEMORY_POLICY)
1058 		oc->nodemask = NULL;
1059 	check_panic_on_oom(oc, constraint);
1060 
1061 	if (!is_memcg_oom(oc) && sysctl_oom_kill_allocating_task &&
1062 	    current->mm && !oom_unkillable_task(current, NULL, oc->nodemask) &&
1063 	    current->signal->oom_score_adj != OOM_SCORE_ADJ_MIN) {
1064 		get_task_struct(current);
1065 		oc->chosen = current;
1066 		oom_kill_process(oc, "Out of memory (oom_kill_allocating_task)");
1067 		return true;
1068 	}
1069 
1070 	select_bad_process(oc);
1071 	/* Found nothing?!?! Either we hang forever, or we panic. */
1072 	if (!oc->chosen && !is_sysrq_oom(oc) && !is_memcg_oom(oc)) {
1073 		dump_header(oc, NULL);
1074 		panic("Out of memory and no killable processes...\n");
1075 	}
1076 	if (oc->chosen && oc->chosen != (void *)-1UL) {
1077 		oom_kill_process(oc, !is_memcg_oom(oc) ? "Out of memory" :
1078 				 "Memory cgroup out of memory");
1079 		/*
1080 		 * Give the killed process a good chance to exit before trying
1081 		 * to allocate memory again.
1082 		 */
1083 		schedule_timeout_killable(1);
1084 	}
1085 	return !!oc->chosen;
1086 }
1087 
1088 /*
1089  * The pagefault handler calls here because it is out of memory, so kill a
1090  * memory-hogging task. If oom_lock is held by somebody else, a parallel oom
1091  * killing is already in progress so do nothing.
1092  */
1093 void pagefault_out_of_memory(void)
1094 {
1095 	struct oom_control oc = {
1096 		.zonelist = NULL,
1097 		.nodemask = NULL,
1098 		.memcg = NULL,
1099 		.gfp_mask = 0,
1100 		.order = 0,
1101 	};
1102 
1103 	if (mem_cgroup_oom_synchronize(true))
1104 		return;
1105 
1106 	if (!mutex_trylock(&oom_lock))
1107 		return;
1108 	out_of_memory(&oc);
1109 	mutex_unlock(&oom_lock);
1110 }
1111