mm/oom_kill.c

   1 /*
   2  *  linux/mm/oom_kill.c
   3  *
   4  *  Copyright (C)  1998,2000  Rik van Riel
   5  *      Thanks go out to Claus Fischer for some serious inspiration and
   6  *      for goading me into coding this file...
   7  *
   8  *  The routines in this file are used to kill a process when
   9  *  we're seriously out of memory. This gets called from __alloc_pages()
  10  *  in mm/page_alloc.c when we really run out of memory.
  11  *
  12  *  Since we won't call these routines often (on a well-configured
  13  *  machine) this file will double as a 'coding guide' and a signpost
  14  *  for newbie kernel hackers. It features several pointers to major
  15  *  kernel subsystems and hints as to where to find out what things do.
  16  */
  17
  18 #include <linux/oom.h>
  19 #include <linux/mm.h>
  20 #include <linux/err.h>
  21 #include <linux/sched.h>
  22 #include <linux/swap.h>
  23 #include <linux/timex.h>
  24 #include <linux/jiffies.h>
  25 #include <linux/cpuset.h>
  26 #include <linux/module.h>
  27 #include <linux/notifier.h>
  28
  29 int sysctl_panic_on_oom;
  30 int sysctl_oom_kill_allocating_task;
  31 static DEFINE_SPINLOCK(zone_scan_mutex);
  32 /* #define DEBUG */
  33
  34 /**
  35  * badness - calculate a numeric value for how bad this task has been
  36  * @p: task struct of which task we should calculate
  37  * @uptime: current uptime in seconds
  38  *
  39  * The formula used is relatively simple and documented inline in the
  40  * function. The main rationale is that we want to select a good task
  41  * to kill when we run out of memory.
  42  *
  43  * Good in this context means that:
  44  * 1) we lose the minimum amount of work done
  45  * 2) we recover a large amount of memory
  46  * 3) we don't kill anything innocent of eating tons of memory
  47  * 4) we want to kill the minimum amount of processes (one)
  48  * 5) we try to kill the process the user expects us to kill, this
  49  *    algorithm has been meticulously tuned to meet the principle
  50  *    of least surprise ... (be careful when you change it)
  51  */
  52
  53 unsigned long badness(struct task_struct *p, unsigned long uptime)
  54 {
  55         unsigned long points, cpu_time, run_time, s;
  56         struct mm_struct *mm;
  57         struct task_struct *child;
  58
  59         task_lock(p);
  60         mm = p->mm;
  61         if (!mm) {
  62                 task_unlock(p);
  63                 return 0;
  64         }
  65
  66         /*
  67          * The memory size of the process is the basis for the badness.
  68          */
  69         points = mm->total_vm;
  70
  71         /*
  72          * After this unlock we can no longer dereference local variable `mm'
  73          */
  74         task_unlock(p);
  75
  76         /*
  77          * swapoff can easily use up all memory, so kill those first.
  78          */
  79         if (p->flags & PF_SWAPOFF)
  80                 return ULONG_MAX;
  81
  82         /*
  83          * Processes which fork a lot of child processes are likely
  84          * a good choice. We add half the vmsize of the children if they
  85          * have an own mm. This prevents forking servers to flood the
  86          * machine with an endless amount of children. In case a single
  87          * child is eating the vast majority of memory, adding only half
  88          * to the parents will make the child our kill candidate of choice.
  89          */
  90         list_for_each_entry(child, &p->children, sibling) {
  91                 task_lock(child);
  92                 if (child->mm != mm && child->mm)
  93                         points += child->mm->total_vm/2 + 1;
  94                 task_unlock(child);
  95         }
  96
  97         /*
  98          * CPU time is in tens of seconds and run time is in thousands
  99          * of seconds. There is no particular reason for this other than
 100          * that it turned out to work very well in practice.
 101          */
 102         cpu_time = (cputime_to_jiffies(p->utime) + cputime_to_jiffies(p->stime))
 103                 >> (SHIFT_HZ + 3);
 104
 105         if (uptime >= p->start_time.tv_sec)
 106                 run_time = (uptime - p->start_time.tv_sec) >> 10;
 107         else
 108                 run_time = 0;
 109
 110         s = int_sqrt(cpu_time);
 111         if (s)
 112                 points /= s;
 113         s = int_sqrt(int_sqrt(run_time));
 114         if (s)
 115                 points /= s;
 116
 117         /*
 118          * Niced processes are most likely less important, so double
 119          * their badness points.
 120          */
 121         if (task_nice(p) > 0)
 122                 points *= 2;
 123
 124         /*
 125          * Superuser processes are usually more important, so we make it
 126          * less likely that we kill those.
 127          */
 128         if (__capable(p, CAP_SYS_ADMIN) || __capable(p, CAP_SYS_RESOURCE))
 129                 points /= 4;
 130
 131         /*
 132          * We don't want to kill a process with direct hardware access.
 133          * Not only could that mess up the hardware, but usually users
 134          * tend to only have this flag set on applications they think
 135          * of as important.
 136          */
 137         if (__capable(p, CAP_SYS_RAWIO))
 138                 points /= 4;
 139
 140         /*
 141          * If p's nodes don't overlap ours, it may still help to kill p
 142          * because p may have allocated or otherwise mapped memory on
 143          * this node before. However it will be less likely.
 144          */
 145         if (!cpuset_mems_allowed_intersects(current, p))
 146                 points /= 8;
 147
 148         /*
 149          * Adjust the score by oomkilladj.
 150          */
 151         if (p->oomkilladj) {
 152                 if (p->oomkilladj > 0) {
 153                         if (!points)
 154                                 points = 1;
 155                         points <<= p->oomkilladj;
 156                 } else
 157                         points >>= -(p->oomkilladj);
 158         }
 159
 160 #ifdef DEBUG
 161         printk(KERN_DEBUG "OOMkill: task %d (%s) got %lu points\n",
 162         p->pid, p->comm, points);
 163 #endif
 164         return points;
 165 }
 166
 167 /*
 168  * Determine the type of allocation constraint.
 169  */
 170 static inline enum oom_constraint constrained_alloc(struct zonelist *zonelist,
 171                                                     gfp_t gfp_mask)
 172 {
 173 #ifdef CONFIG_NUMA
 174         struct zone **z;
 175         nodemask_t nodes = node_states[N_HIGH_MEMORY];
 176
 177         for (z = zonelist->zones; *z; z++)
 178                 if (cpuset_zone_allowed_softwall(*z, gfp_mask))
 179                         node_clear(zone_to_nid(*z), nodes);
 180                 else
 181                         return CONSTRAINT_CPUSET;
 182
 183         if (!nodes_empty(nodes))
 184                 return CONSTRAINT_MEMORY_POLICY;
 185 #endif
 186
 187         return CONSTRAINT_NONE;
 188 }
 189
 190 /*
 191  * Simple selection loop. We chose the process with the highest
 192  * number of 'points'. We expect the caller will lock the tasklist.
 193  *
 194  * (not docbooked, we don't want this one cluttering up the manual)
 195  */
 196 static struct task_struct *select_bad_process(unsigned long *ppoints)
 197 {
 198         struct task_struct *g, *p;
 199         struct task_struct *chosen = NULL;
 200         struct timespec uptime;
 201         *ppoints = 0;
 202
 203         do_posix_clock_monotonic_gettime(&uptime);
 204         do_each_thread(g, p) {
 205                 unsigned long points;
 206
 207                 /*
 208                  * skip kernel threads and tasks which have already released
 209                  * their mm.
 210                  */
 211                 if (!p->mm)
 212                         continue;
 213                 /* skip the init task */
 214                 if (is_global_init(p))
 215                         continue;
 216
 217                 /*
 218                  * This task already has access to memory reserves and is
 219                  * being killed. Don't allow any other task access to the
 220                  * memory reserve.
 221                  *
 222                  * Note: this may have a chance of deadlock if it gets
 223                  * blocked waiting for another task which itself is waiting
 224                  * for memory. Is there a better alternative?
 225                  */
 226                 if (test_tsk_thread_flag(p, TIF_MEMDIE))
 227                         return ERR_PTR(-1UL);
 228
 229                 /*
 230                  * This is in the process of releasing memory so wait for it
 231                  * to finish before killing some other task by mistake.
 232                  *
 233                  * However, if p is the current task, we allow the 'kill' to
 234                  * go ahead if it is exiting: this will simply set TIF_MEMDIE,
 235                  * which will allow it to gain access to memory reserves in
 236                  * the process of exiting and releasing its resources.
 237                  * Otherwise we could get an easy OOM deadlock.
 238                  */
 239                 if (p->flags & PF_EXITING) {
 240                         if (p != current)
 241                                 return ERR_PTR(-1UL);
 242
 243                         chosen = p;
 244                         *ppoints = ULONG_MAX;
 245                 }
 246
 247                 if (p->oomkilladj == OOM_DISABLE)
 248                         continue;
 249
 250                 points = badness(p, uptime.tv_sec);
 251                 if (points > *ppoints || !chosen) {
 252                         chosen = p;
 253                         *ppoints = points;
 254                 }
 255         } while_each_thread(g, p);
 256
 257         return chosen;
 258 }
 259
 260 /**
 261  * Send SIGKILL to the selected  process irrespective of  CAP_SYS_RAW_IO
 262  * flag though it's unlikely that  we select a process with CAP_SYS_RAW_IO
 263  * set.
 264  */
 265 static void __oom_kill_task(struct task_struct *p, int verbose)
 266 {
 267         if (is_global_init(p)) {
 268                 WARN_ON(1);
 269                 printk(KERN_WARNING "tried to kill init!\n");
 270                 return;
 271         }
 272
 273         if (!p->mm) {
 274                 WARN_ON(1);
 275                 printk(KERN_WARNING "tried to kill an mm-less task!\n");
 276                 return;
 277         }
 278
 279         if (verbose)
 280                 printk(KERN_ERR "Killed process %d (%s)\n",
 281                                 task_pid_nr(p), p->comm);
 282
 283         /*
 284          * We give our sacrificial lamb high priority and access to
 285          * all the memory it needs. That way it should be able to
 286          * exit() and clear out its resources quickly...
 287          */
 288         p->rt.time_slice = HZ;
 289         set_tsk_thread_flag(p, TIF_MEMDIE);
 290
 291         force_sig(SIGKILL, p);
 292 }
 293
 294 static int oom_kill_task(struct task_struct *p)
 295 {
 296         struct mm_struct *mm;
 297         struct task_struct *g, *q;
 298
 299         mm = p->mm;
 300
 301         /* WARNING: mm may not be dereferenced since we did not obtain its
 302          * value from get_task_mm(p).  This is OK since all we need to do is
 303          * compare mm to q->mm below.
 304          *
 305          * Furthermore, even if mm contains a non-NULL value, p->mm may
 306          * change to NULL at any time since we do not hold task_lock(p).
 307          * However, this is of no concern to us.
 308          */
 309
 310         if (mm == NULL)
 311                 return 1;
 312
 313         /*
 314          * Don't kill the process if any threads are set to OOM_DISABLE
 315          */
 316         do_each_thread(g, q) {
 317                 if (q->mm == mm && q->oomkilladj == OOM_DISABLE)
 318                         return 1;
 319         } while_each_thread(g, q);
 320
 321         __oom_kill_task(p, 1);
 322
 323         /*
 324          * kill all processes that share the ->mm (i.e. all threads),
 325          * but are in a different thread group. Don't let them have access
 326          * to memory reserves though, otherwise we might deplete all memory.
 327          */
 328         do_each_thread(g, q) {
 329                 if (q->mm == mm && !same_thread_group(q, p))
 330                         force_sig(SIGKILL, q);
 331         } while_each_thread(g, q);
 332
 333         return 0;
 334 }
 335
 336 static int oom_kill_process(struct task_struct *p, gfp_t gfp_mask, int order,
 337                             unsigned long points, const char *message)
 338 {
 339         struct task_struct *c;
 340
 341         if (printk_ratelimit()) {
 342                 printk(KERN_WARNING "%s invoked oom-killer: "
 343                         "gfp_mask=0x%x, order=%d, oomkilladj=%d\n",
 344                         current->comm, gfp_mask, order, current->oomkilladj);
 345                 dump_stack();
 346                 show_mem();
 347         }
 348
 349         /*
 350          * If the task is already exiting, don't alarm the sysadmin or kill
 351          * its children or threads, just set TIF_MEMDIE so it can die quickly
 352          */
 353         if (p->flags & PF_EXITING) {
 354                 __oom_kill_task(p, 0);
 355                 return 0;
 356         }
 357
 358         printk(KERN_ERR "%s: kill process %d (%s) score %li or a child\n",
 359                                         message, task_pid_nr(p), p->comm, points);
 360
 361         /* Try to kill a child first */
 362         list_for_each_entry(c, &p->children, sibling) {
 363                 if (c->mm == p->mm)
 364                         continue;
 365                 if (!oom_kill_task(c))
 366                         return 0;
 367         }
 368         return oom_kill_task(p);
 369 }
 370
 371 static BLOCKING_NOTIFIER_HEAD(oom_notify_list);
 372
 373 int register_oom_notifier(struct notifier_block *nb)
 374 {
 375         return blocking_notifier_chain_register(&oom_notify_list, nb);
 376 }
 377 EXPORT_SYMBOL_GPL(register_oom_notifier);
 378
 379 int unregister_oom_notifier(struct notifier_block *nb)
 380 {
 381         return blocking_notifier_chain_unregister(&oom_notify_list, nb);
 382 }
 383 EXPORT_SYMBOL_GPL(unregister_oom_notifier);
 384
 385 /*
 386  * Try to acquire the OOM killer lock for the zones in zonelist.  Returns zero
 387  * if a parallel OOM killing is already taking place that includes a zone in
 388  * the zonelist.  Otherwise, locks all zones in the zonelist and returns 1.
 389  */
 390 int try_set_zone_oom(struct zonelist *zonelist)
 391 {
 392         struct zone **z;
 393         int ret = 1;
 394
 395         z = zonelist->zones;
 396
 397         spin_lock(&zone_scan_mutex);
 398         do {
 399                 if (zone_is_oom_locked(*z)) {
 400                         ret = 0;
 401                         goto out;
 402                 }
 403         } while (*(++z) != NULL);
 404
 405         /*
 406          * Lock each zone in the zonelist under zone_scan_mutex so a parallel
 407          * invocation of try_set_zone_oom() doesn't succeed when it shouldn't.
 408          */
 409         z = zonelist->zones;
 410         do {
 411                 zone_set_flag(*z, ZONE_OOM_LOCKED);
 412         } while (*(++z) != NULL);
 413 out:
 414         spin_unlock(&zone_scan_mutex);
 415         return ret;
 416 }
 417
 418 /*
 419  * Clears the ZONE_OOM_LOCKED flag for all zones in the zonelist so that failed
 420  * allocation attempts with zonelists containing them may now recall the OOM
 421  * killer, if necessary.
 422  */
 423 void clear_zonelist_oom(struct zonelist *zonelist)
 424 {
 425         struct zone **z;
 426
 427         z = zonelist->zones;
 428
 429         spin_lock(&zone_scan_mutex);
 430         do {
 431                 zone_clear_flag(*z, ZONE_OOM_LOCKED);
 432         } while (*(++z) != NULL);
 433         spin_unlock(&zone_scan_mutex);
 434 }
 435
 436 /**
 437  * out_of_memory - kill the "best" process when we run out of memory
 438  *
 439  * If we run out of memory, we have the choice between either
 440  * killing a random task (bad), letting the system crash (worse)
 441  * OR try to be smart about which process to kill. Note that we
 442  * don't have to be perfect here, we just have to be good.
 443  */
 444 void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order)
 445 {
 446         struct task_struct *p;
 447         unsigned long points = 0;
 448         unsigned long freed = 0;
 449         enum oom_constraint constraint;
 450
 451         blocking_notifier_call_chain(&oom_notify_list, 0, &freed);
 452         if (freed > 0)
 453                 /* Got some memory back in the last second. */
 454                 return;
 455
 456         if (sysctl_panic_on_oom == 2)
 457                 panic("out of memory. Compulsory panic_on_oom is selected.\n");
 458
 459         /*
 460          * Check if there were limitations on the allocation (only relevant for
 461          * NUMA) that may require different handling.
 462          */
 463         constraint = constrained_alloc(zonelist, gfp_mask);
 464         read_lock(&tasklist_lock);
 465
 466         switch (constraint) {
 467         case CONSTRAINT_MEMORY_POLICY:
 468                 oom_kill_process(current, gfp_mask, order, points,
 469                                 "No available memory (MPOL_BIND)");
 470                 break;
 471
 472         case CONSTRAINT_NONE:
 473                 if (sysctl_panic_on_oom)
 474                         panic("out of memory. panic_on_oom is selected\n");
 475                 /* Fall-through */
 476         case CONSTRAINT_CPUSET:
 477                 if (sysctl_oom_kill_allocating_task) {
 478                         oom_kill_process(current, gfp_mask, order, points,
 479                                         "Out of memory (oom_kill_allocating_task)");
 480                         break;
 481                 }
 482 retry:
 483                 /*
 484                  * Rambo mode: Shoot down a process and hope it solves whatever
 485                  * issues we may have.
 486                  */
 487                 p = select_bad_process(&points);
 488
 489                 if (PTR_ERR(p) == -1UL)
 490                         goto out;
 491
 492                 /* Found nothing?!?! Either we hang forever, or we panic. */
 493                 if (!p) {
 494                         read_unlock(&tasklist_lock);
 495                         panic("Out of memory and no killable processes...\n");
 496                 }
 497
 498                 if (oom_kill_process(p, gfp_mask, order, points,
 499                                      "Out of memory"))
 500                         goto retry;
 501
 502                 break;
 503         }
 504
 505 out:
 506         read_unlock(&tasklist_lock);
 507
 508         /*
 509          * Give "p" a good chance of killing itself before we
 510          * retry to allocate memory unless "p" is current
 511          */
 512         if (!test_thread_flag(TIF_MEMDIE))
 513                 schedule_timeout_uninterruptible(1);
 514 }