cleanup
[linux-2.4.21-pre4.git] / 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 kswapd()
10  *  in linux/mm/vmscan.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/mm.h>
19 #include <linux/sched.h>
20 #include <linux/swap.h>
21 #include <linux/swapctl.h>
22 #include <linux/timex.h>
23
24 /* #define DEBUG */
25
26 /**
27  * int_sqrt - oom_kill.c internal function, rough approximation to sqrt
28  * @x: integer of which to calculate the sqrt
29  * 
30  * A very rough approximation to the sqrt() function.
31  */
32 static unsigned int int_sqrt(unsigned int x)
33 {
34         unsigned int out = x;
35         while (x & ~(unsigned int)1) x >>=2, out >>=1;
36         if (x) out -= out >> 2;
37         return (out ? out : 1);
38 }       
39
40 /**
41  * oom_badness - calculate a numeric value for how bad this task has been
42  * @p: task struct of which task we should calculate
43  *
44  * The formula used is relatively simple and documented inline in the
45  * function. The main rationale is that we want to select a good task
46  * to kill when we run out of memory.
47  *
48  * Good in this context means that:
49  * 1) we lose the minimum amount of work done
50  * 2) we recover a large amount of memory
51  * 3) we don't kill anything innocent of eating tons of memory
52  * 4) we want to kill the minimum amount of processes (one)
53  * 5) we try to kill the process the user expects us to kill, this
54  *    algorithm has been meticulously tuned to meet the priniciple
55  *    of least surprise ... (be careful when you change it)
56  */
57
58 static int badness(struct task_struct *p)
59 {
60         int points, cpu_time, run_time;
61
62         if (!p->mm)
63                 return 0;
64         /*
65          * The memory size of the process is the basis for the badness.
66          */
67         points = p->mm->total_vm;
68
69         /*
70          * CPU time is in seconds and run time is in minutes. There is no
71          * particular reason for this other than that it turned out to work
72          * very well in practice. This is not safe against jiffie wraps
73          * but we don't care _that_ much...
74          */
75         cpu_time = (p->times.tms_utime + p->times.tms_stime) >> (SHIFT_HZ + 3);
76         run_time = (jiffies - p->start_time) >> (SHIFT_HZ + 10);
77
78         points /= int_sqrt(cpu_time);
79         points /= int_sqrt(int_sqrt(run_time));
80
81         /*
82          * Niced processes are most likely less important, so double
83          * their badness points.
84          */
85         if (p->nice > 0)
86                 points *= 2;
87
88         /*
89          * Superuser processes are usually more important, so we make it
90          * less likely that we kill those.
91          */
92         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_ADMIN) ||
93                                 p->uid == 0 || p->euid == 0)
94                 points /= 4;
95
96         /*
97          * We don't want to kill a process with direct hardware access.
98          * Not only could that mess up the hardware, but usually users
99          * tend to only have this flag set on applications they think
100          * of as important.
101          */
102         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_RAWIO))
103                 points /= 4;
104 #ifdef DEBUG
105         printk(KERN_DEBUG "OOMkill: task %d (%s) got %d points\n",
106         p->pid, p->comm, points);
107 #endif
108         return points;
109 }
110
111 /*
112  * Simple selection loop. We chose the process with the highest
113  * number of 'points'. We expect the caller will lock the tasklist.
114  *
115  * (not docbooked, we don't want this one cluttering up the manual)
116  */
117 static struct task_struct * select_bad_process(void)
118 {
119         int maxpoints = 0;
120         struct task_struct *p = NULL;
121         struct task_struct *chosen = NULL;
122
123         for_each_task(p) {
124                 if (p->pid) {
125                         int points = badness(p);
126                         if (points > maxpoints) {
127                                 chosen = p;
128                                 maxpoints = points;
129                         }
130                 }
131         }
132         return chosen;
133 }
134
135 /**
136  * We must be careful though to never send SIGKILL a process with
137  * CAP_SYS_RAW_IO set, send SIGTERM instead (but it's unlikely that
138  * we select a process with CAP_SYS_RAW_IO set).
139  */
140 void oom_kill_task(struct task_struct *p)
141 {
142         printk(KERN_ERR "Out of Memory: Killed process %d (%s).\n", p->pid, p->comm);
143
144         /*
145          * We give our sacrificial lamb high priority and access to
146          * all the memory it needs. That way it should be able to
147          * exit() and clear out its resources quickly...
148          */
149         p->counter = 5 * HZ;
150         p->flags |= PF_MEMALLOC | PF_MEMDIE;
151
152         /* This process has hardware access, be more careful. */
153         if (cap_t(p->cap_effective) & CAP_TO_MASK(CAP_SYS_RAWIO)) {
154                 force_sig(SIGTERM, p);
155         } else {
156                 force_sig(SIGKILL, p);
157         }
158 }
159
160 /**
161  * oom_kill - kill the "best" process when we run out of memory
162  *
163  * If we run out of memory, we have the choice between either
164  * killing a random task (bad), letting the system crash (worse)
165  * OR try to be smart about which process to kill. Note that we
166  * don't have to be perfect here, we just have to be good.
167  */
168 static void oom_kill(void)
169 {
170         struct task_struct *p, *q;
171
172         read_lock(&tasklist_lock);
173         p = select_bad_process();
174
175         /* Found nothing?!?! Either we hang forever, or we panic. */
176         if (p == NULL)
177                 panic("Out of memory and no killable processes...\n");
178
179         /* kill all processes that share the ->mm (i.e. all threads) */
180         for_each_task(q) {
181                 if (q->mm == p->mm)
182                         oom_kill_task(q);
183         }
184         read_unlock(&tasklist_lock);
185
186         /*
187          * Make kswapd go out of the way, so "p" has a good chance of
188          * killing itself before someone else gets the chance to ask
189          * for more memory.
190          */
191         yield();
192         return;
193 }
194
195 /**
196  * out_of_memory - is the system out of memory?
197  */
198 void out_of_memory(void)
199 {
200         static unsigned long first, last, count, lastkill;
201         unsigned long now, since;
202
203         /*
204          * Enough swap space left?  Not OOM.
205          */
206         if (nr_swap_pages > 0)
207                 return;
208
209         now = jiffies;
210         since = now - last;
211         last = now;
212
213         /*
214          * If it's been a long time since last failure,
215          * we're not oom.
216          */
217         last = now;
218         if (since > 5*HZ)
219                 goto reset;
220
221         /*
222          * If we haven't tried for at least one second,
223          * we're not really oom.
224          */
225         since = now - first;
226         if (since < HZ)
227                 return;
228
229         /*
230          * If we have gotten only a few failures,
231          * we're not really oom. 
232          */
233         if (++count < 10)
234                 return;
235
236         /*
237          * If we just killed a process, wait a while
238          * to give that task a chance to exit. This
239          * avoids killing multiple processes needlessly.
240          */
241         since = now - lastkill;
242         if (since < HZ*5)
243                 return;
244
245         /*
246          * Ok, really out of memory. Kill something.
247          */
248         lastkill = now;
249         oom_kill();
250
251 reset:
252         first = now;
253         count = 0;
254 }