Revert "HOWTO: bug report addition" (or "HOWTO: mention bughunting")
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / mm / oom_kill.c
bloba7001410ab15964449f2b7188be3ecf05a9876eb
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...
8 * The routines in this file are used to kill a process when
9 * we're seriously out of memory. This gets called from __alloc_pages()
10 * in mm/page_alloc.c when we really run out of memory.
12 * Since we won't call these routines often (on a well-configured
13 * machine) this file will double as a 'coding guide' and a signpost
14 * for newbie kernel hackers. It features several pointers to major
15 * kernel subsystems and hints as to where to find out what things do.
18 #include <linux/oom.h>
19 #include <linux/mm.h>
20 #include <linux/sched.h>
21 #include <linux/swap.h>
22 #include <linux/timex.h>
23 #include <linux/jiffies.h>
24 #include <linux/cpuset.h>
25 #include <linux/module.h>
26 #include <linux/notifier.h>
28 int sysctl_panic_on_oom;
29 /* #define DEBUG */
31 /**
32 * badness - calculate a numeric value for how bad this task has been
33 * @p: task struct of which task we should calculate
34 * @uptime: current uptime in seconds
36 * The formula used is relatively simple and documented inline in the
37 * function. The main rationale is that we want to select a good task
38 * to kill when we run out of memory.
40 * Good in this context means that:
41 * 1) we lose the minimum amount of work done
42 * 2) we recover a large amount of memory
43 * 3) we don't kill anything innocent of eating tons of memory
44 * 4) we want to kill the minimum amount of processes (one)
45 * 5) we try to kill the process the user expects us to kill, this
46 * algorithm has been meticulously tuned to meet the principle
47 * of least surprise ... (be careful when you change it)
50 unsigned long badness(struct task_struct *p, unsigned long uptime)
52 unsigned long points, cpu_time, run_time, s;
53 struct mm_struct *mm;
54 struct task_struct *child;
56 task_lock(p);
57 mm = p->mm;
58 if (!mm) {
59 task_unlock(p);
60 return 0;
64 * The memory size of the process is the basis for the badness.
66 points = mm->total_vm;
69 * After this unlock we can no longer dereference local variable `mm'
71 task_unlock(p);
74 * swapoff can easily use up all memory, so kill those first.
76 if (p->flags & PF_SWAPOFF)
77 return ULONG_MAX;
80 * Processes which fork a lot of child processes are likely
81 * a good choice. We add half the vmsize of the children if they
82 * have an own mm. This prevents forking servers to flood the
83 * machine with an endless amount of children. In case a single
84 * child is eating the vast majority of memory, adding only half
85 * to the parents will make the child our kill candidate of choice.
87 list_for_each_entry(child, &p->children, sibling) {
88 task_lock(child);
89 if (child->mm != mm && child->mm)
90 points += child->mm->total_vm/2 + 1;
91 task_unlock(child);
95 * CPU time is in tens of seconds and run time is in thousands
96 * of seconds. There is no particular reason for this other than
97 * that it turned out to work very well in practice.
99 cpu_time = (cputime_to_jiffies(p->utime) + cputime_to_jiffies(p->stime))
100 >> (SHIFT_HZ + 3);
102 if (uptime >= p->start_time.tv_sec)
103 run_time = (uptime - p->start_time.tv_sec) >> 10;
104 else
105 run_time = 0;
107 s = int_sqrt(cpu_time);
108 if (s)
109 points /= s;
110 s = int_sqrt(int_sqrt(run_time));
111 if (s)
112 points /= s;
115 * Niced processes are most likely less important, so double
116 * their badness points.
118 if (task_nice(p) > 0)
119 points *= 2;
122 * Superuser processes are usually more important, so we make it
123 * less likely that we kill those.
125 if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_ADMIN) ||
126 p->uid == 0 || p->euid == 0)
127 points /= 4;
130 * We don't want to kill a process with direct hardware access.
131 * Not only could that mess up the hardware, but usually users
132 * tend to only have this flag set on applications they think
133 * of as important.
135 if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_RAWIO))
136 points /= 4;
139 * If p's nodes don't overlap ours, it may still help to kill p
140 * because p may have allocated or otherwise mapped memory on
141 * this node before. However it will be less likely.
143 if (!cpuset_excl_nodes_overlap(p))
144 points /= 8;
147 * Adjust the score by oomkilladj.
149 if (p->oomkilladj) {
150 if (p->oomkilladj > 0) {
151 if (!points)
152 points = 1;
153 points <<= p->oomkilladj;
154 } else
155 points >>= -(p->oomkilladj);
158 #ifdef DEBUG
159 printk(KERN_DEBUG "OOMkill: task %d (%s) got %d points\n",
160 p->pid, p->comm, points);
161 #endif
162 return points;
166 * Types of limitations to the nodes from which allocations may occur
168 #define CONSTRAINT_NONE 1
169 #define CONSTRAINT_MEMORY_POLICY 2
170 #define CONSTRAINT_CPUSET 3
173 * Determine the type of allocation constraint.
175 static inline int constrained_alloc(struct zonelist *zonelist, gfp_t gfp_mask)
177 #ifdef CONFIG_NUMA
178 struct zone **z;
179 nodemask_t nodes;
180 int node;
182 nodes_clear(nodes);
183 /* node has memory ? */
184 for_each_online_node(node)
185 if (NODE_DATA(node)->node_present_pages)
186 node_set(node, nodes);
188 for (z = zonelist->zones; *z; z++)
189 if (cpuset_zone_allowed_softwall(*z, gfp_mask))
190 node_clear(zone_to_nid(*z), nodes);
191 else
192 return CONSTRAINT_CPUSET;
194 if (!nodes_empty(nodes))
195 return CONSTRAINT_MEMORY_POLICY;
196 #endif
198 return CONSTRAINT_NONE;
202 * Simple selection loop. We chose the process with the highest
203 * number of 'points'. We expect the caller will lock the tasklist.
205 * (not docbooked, we don't want this one cluttering up the manual)
207 static struct task_struct *select_bad_process(unsigned long *ppoints)
209 struct task_struct *g, *p;
210 struct task_struct *chosen = NULL;
211 struct timespec uptime;
212 *ppoints = 0;
214 do_posix_clock_monotonic_gettime(&uptime);
215 do_each_thread(g, p) {
216 unsigned long points;
219 * skip kernel threads and tasks which have already released
220 * their mm.
222 if (!p->mm)
223 continue;
224 /* skip the init task */
225 if (is_init(p))
226 continue;
229 * This task already has access to memory reserves and is
230 * being killed. Don't allow any other task access to the
231 * memory reserve.
233 * Note: this may have a chance of deadlock if it gets
234 * blocked waiting for another task which itself is waiting
235 * for memory. Is there a better alternative?
237 if (test_tsk_thread_flag(p, TIF_MEMDIE))
238 return ERR_PTR(-1UL);
241 * This is in the process of releasing memory so wait for it
242 * to finish before killing some other task by mistake.
244 * However, if p is the current task, we allow the 'kill' to
245 * go ahead if it is exiting: this will simply set TIF_MEMDIE,
246 * which will allow it to gain access to memory reserves in
247 * the process of exiting and releasing its resources.
248 * Otherwise we could get an easy OOM deadlock.
250 if (p->flags & PF_EXITING) {
251 if (p != current)
252 return ERR_PTR(-1UL);
254 chosen = p;
255 *ppoints = ULONG_MAX;
258 if (p->oomkilladj == OOM_DISABLE)
259 continue;
261 points = badness(p, uptime.tv_sec);
262 if (points > *ppoints || !chosen) {
263 chosen = p;
264 *ppoints = points;
266 } while_each_thread(g, p);
268 return chosen;
272 * Send SIGKILL to the selected process irrespective of CAP_SYS_RAW_IO
273 * flag though it's unlikely that we select a process with CAP_SYS_RAW_IO
274 * set.
276 static void __oom_kill_task(struct task_struct *p, int verbose)
278 if (is_init(p)) {
279 WARN_ON(1);
280 printk(KERN_WARNING "tried to kill init!\n");
281 return;
284 if (!p->mm) {
285 WARN_ON(1);
286 printk(KERN_WARNING "tried to kill an mm-less task!\n");
287 return;
290 if (verbose)
291 printk(KERN_ERR "Killed process %d (%s)\n", p->pid, p->comm);
294 * We give our sacrificial lamb high priority and access to
295 * all the memory it needs. That way it should be able to
296 * exit() and clear out its resources quickly...
298 p->time_slice = HZ;
299 set_tsk_thread_flag(p, TIF_MEMDIE);
301 force_sig(SIGKILL, p);
304 static int oom_kill_task(struct task_struct *p)
306 struct mm_struct *mm;
307 struct task_struct *g, *q;
309 mm = p->mm;
311 /* WARNING: mm may not be dereferenced since we did not obtain its
312 * value from get_task_mm(p). This is OK since all we need to do is
313 * compare mm to q->mm below.
315 * Furthermore, even if mm contains a non-NULL value, p->mm may
316 * change to NULL at any time since we do not hold task_lock(p).
317 * However, this is of no concern to us.
320 if (mm == NULL)
321 return 1;
324 * Don't kill the process if any threads are set to OOM_DISABLE
326 do_each_thread(g, q) {
327 if (q->mm == mm && q->oomkilladj == OOM_DISABLE)
328 return 1;
329 } while_each_thread(g, q);
331 __oom_kill_task(p, 1);
334 * kill all processes that share the ->mm (i.e. all threads),
335 * but are in a different thread group. Don't let them have access
336 * to memory reserves though, otherwise we might deplete all memory.
338 do_each_thread(g, q) {
339 if (q->mm == mm && q->tgid != p->tgid)
340 force_sig(SIGKILL, q);
341 } while_each_thread(g, q);
343 return 0;
346 static int oom_kill_process(struct task_struct *p, unsigned long points,
347 const char *message)
349 struct task_struct *c;
350 struct list_head *tsk;
353 * If the task is already exiting, don't alarm the sysadmin or kill
354 * its children or threads, just set TIF_MEMDIE so it can die quickly
356 if (p->flags & PF_EXITING) {
357 __oom_kill_task(p, 0);
358 return 0;
361 printk(KERN_ERR "%s: kill process %d (%s) score %li or a child\n",
362 message, p->pid, p->comm, points);
364 /* Try to kill a child first */
365 list_for_each(tsk, &p->children) {
366 c = list_entry(tsk, struct task_struct, sibling);
367 if (c->mm == p->mm)
368 continue;
369 if (!oom_kill_task(c))
370 return 0;
372 return oom_kill_task(p);
375 static BLOCKING_NOTIFIER_HEAD(oom_notify_list);
377 int register_oom_notifier(struct notifier_block *nb)
379 return blocking_notifier_chain_register(&oom_notify_list, nb);
381 EXPORT_SYMBOL_GPL(register_oom_notifier);
383 int unregister_oom_notifier(struct notifier_block *nb)
385 return blocking_notifier_chain_unregister(&oom_notify_list, nb);
387 EXPORT_SYMBOL_GPL(unregister_oom_notifier);
390 * out_of_memory - kill the "best" process when we run out of memory
392 * If we run out of memory, we have the choice between either
393 * killing a random task (bad), letting the system crash (worse)
394 * OR try to be smart about which process to kill. Note that we
395 * don't have to be perfect here, we just have to be good.
397 void out_of_memory(struct zonelist *zonelist, gfp_t gfp_mask, int order)
399 struct task_struct *p;
400 unsigned long points = 0;
401 unsigned long freed = 0;
402 int constraint;
404 blocking_notifier_call_chain(&oom_notify_list, 0, &freed);
405 if (freed > 0)
406 /* Got some memory back in the last second. */
407 return;
409 if (printk_ratelimit()) {
410 printk(KERN_WARNING "%s invoked oom-killer: "
411 "gfp_mask=0x%x, order=%d, oomkilladj=%d\n",
412 current->comm, gfp_mask, order, current->oomkilladj);
413 dump_stack();
414 show_mem();
417 if (sysctl_panic_on_oom == 2)
418 panic("out of memory. Compulsory panic_on_oom is selected.\n");
421 * Check if there were limitations on the allocation (only relevant for
422 * NUMA) that may require different handling.
424 constraint = constrained_alloc(zonelist, gfp_mask);
425 cpuset_lock();
426 read_lock(&tasklist_lock);
428 switch (constraint) {
429 case CONSTRAINT_MEMORY_POLICY:
430 oom_kill_process(current, points,
431 "No available memory (MPOL_BIND)");
432 break;
434 case CONSTRAINT_CPUSET:
435 oom_kill_process(current, points,
436 "No available memory in cpuset");
437 break;
439 case CONSTRAINT_NONE:
440 if (sysctl_panic_on_oom)
441 panic("out of memory. panic_on_oom is selected\n");
442 retry:
444 * Rambo mode: Shoot down a process and hope it solves whatever
445 * issues we may have.
447 p = select_bad_process(&points);
449 if (PTR_ERR(p) == -1UL)
450 goto out;
452 /* Found nothing?!?! Either we hang forever, or we panic. */
453 if (!p) {
454 read_unlock(&tasklist_lock);
455 cpuset_unlock();
456 panic("Out of memory and no killable processes...\n");
459 if (oom_kill_process(p, points, "Out of memory"))
460 goto retry;
462 break;
465 out:
466 read_unlock(&tasklist_lock);
467 cpuset_unlock();
470 * Give "p" a good chance of killing itself before we
471 * retry to allocate memory unless "p" is current
473 if (!test_thread_flag(TIF_MEMDIE))
474 schedule_timeout_uninterruptible(1);