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