[PATCH] to nsproxy
[linux-2.6.git] / kernel / pid.c
1 /*
2  * Generic pidhash and scalable, time-bounded PID allocator
3  *
4  * (C) 2002-2003 William Irwin, IBM
5  * (C) 2004 William Irwin, Oracle
6  * (C) 2002-2004 Ingo Molnar, Red Hat
7  *
8  * pid-structures are backing objects for tasks sharing a given ID to chain
9  * against. There is very little to them aside from hashing them and
10  * parking tasks using given ID's on a list.
11  *
12  * The hash is always changed with the tasklist_lock write-acquired,
13  * and the hash is only accessed with the tasklist_lock at least
14  * read-acquired, so there's no additional SMP locking needed here.
15  *
16  * We have a list of bitmap pages, which bitmaps represent the PID space.
17  * Allocating and freeing PIDs is completely lockless. The worst-case
18  * allocation scenario when all but one out of 1 million PIDs possible are
19  * allocated already: the scanning of 32 list entries and at most PAGE_SIZE
20  * bytes. The typical fastpath is a single successful setbit. Freeing is O(1).
21  */
22
23 #include <linux/mm.h>
24 #include <linux/module.h>
25 #include <linux/slab.h>
26 #include <linux/init.h>
27 #include <linux/bootmem.h>
28 #include <linux/hash.h>
29 #include <linux/pid_namespace.h>
30
31 #define pid_hashfn(nr) hash_long((unsigned long)nr, pidhash_shift)
32 static struct hlist_head *pid_hash;
33 static int pidhash_shift;
34 static struct kmem_cache *pid_cachep;
35
36 int pid_max = PID_MAX_DEFAULT;
37
38 #define RESERVED_PIDS           300
39
40 int pid_max_min = RESERVED_PIDS + 1;
41 int pid_max_max = PID_MAX_LIMIT;
42
43 #define BITS_PER_PAGE           (PAGE_SIZE*8)
44 #define BITS_PER_PAGE_MASK      (BITS_PER_PAGE-1)
45
46 static inline int mk_pid(struct pid_namespace *pid_ns,
47                 struct pidmap *map, int off)
48 {
49         return (map - pid_ns->pidmap)*BITS_PER_PAGE + off;
50 }
51
52 #define find_next_offset(map, off)                                      \
53                 find_next_zero_bit((map)->page, BITS_PER_PAGE, off)
54
55 /*
56  * PID-map pages start out as NULL, they get allocated upon
57  * first use and are never deallocated. This way a low pid_max
58  * value does not cause lots of bitmaps to be allocated, but
59  * the scheme scales to up to 4 million PIDs, runtime.
60  */
61 struct pid_namespace init_pid_ns = {
62         .kref = {
63                 .refcount       = ATOMIC_INIT(2),
64         },
65         .pidmap = {
66                 [ 0 ... PIDMAP_ENTRIES-1] = { ATOMIC_INIT(BITS_PER_PAGE), NULL }
67         },
68         .last_pid = 0
69 };
70
71 /*
72  * Note: disable interrupts while the pidmap_lock is held as an
73  * interrupt might come in and do read_lock(&tasklist_lock).
74  *
75  * If we don't disable interrupts there is a nasty deadlock between
76  * detach_pid()->free_pid() and another cpu that does
77  * spin_lock(&pidmap_lock) followed by an interrupt routine that does
78  * read_lock(&tasklist_lock);
79  *
80  * After we clean up the tasklist_lock and know there are no
81  * irq handlers that take it we can leave the interrupts enabled.
82  * For now it is easier to be safe than to prove it can't happen.
83  */
84
85 static  __cacheline_aligned_in_smp DEFINE_SPINLOCK(pidmap_lock);
86
87 static fastcall void free_pidmap(struct pid_namespace *pid_ns, int pid)
88 {
89         struct pidmap *map = pid_ns->pidmap + pid / BITS_PER_PAGE;
90         int offset = pid & BITS_PER_PAGE_MASK;
91
92         clear_bit(offset, map->page);
93         atomic_inc(&map->nr_free);
94 }
95
96 static int alloc_pidmap(struct pid_namespace *pid_ns)
97 {
98         int i, offset, max_scan, pid, last = pid_ns->last_pid;
99         struct pidmap *map;
100
101         pid = last + 1;
102         if (pid >= pid_max)
103                 pid = RESERVED_PIDS;
104         offset = pid & BITS_PER_PAGE_MASK;
105         map = &pid_ns->pidmap[pid/BITS_PER_PAGE];
106         max_scan = (pid_max + BITS_PER_PAGE - 1)/BITS_PER_PAGE - !offset;
107         for (i = 0; i <= max_scan; ++i) {
108                 if (unlikely(!map->page)) {
109                         void *page = kzalloc(PAGE_SIZE, GFP_KERNEL);
110                         /*
111                          * Free the page if someone raced with us
112                          * installing it:
113                          */
114                         spin_lock_irq(&pidmap_lock);
115                         if (map->page)
116                                 kfree(page);
117                         else
118                                 map->page = page;
119                         spin_unlock_irq(&pidmap_lock);
120                         if (unlikely(!map->page))
121                                 break;
122                 }
123                 if (likely(atomic_read(&map->nr_free))) {
124                         do {
125                                 if (!test_and_set_bit(offset, map->page)) {
126                                         atomic_dec(&map->nr_free);
127                                         pid_ns->last_pid = pid;
128                                         return pid;
129                                 }
130                                 offset = find_next_offset(map, offset);
131                                 pid = mk_pid(pid_ns, map, offset);
132                         /*
133                          * find_next_offset() found a bit, the pid from it
134                          * is in-bounds, and if we fell back to the last
135                          * bitmap block and the final block was the same
136                          * as the starting point, pid is before last_pid.
137                          */
138                         } while (offset < BITS_PER_PAGE && pid < pid_max &&
139                                         (i != max_scan || pid < last ||
140                                             !((last+1) & BITS_PER_PAGE_MASK)));
141                 }
142                 if (map < &pid_ns->pidmap[(pid_max-1)/BITS_PER_PAGE]) {
143                         ++map;
144                         offset = 0;
145                 } else {
146                         map = &pid_ns->pidmap[0];
147                         offset = RESERVED_PIDS;
148                         if (unlikely(last == offset))
149                                 break;
150                 }
151                 pid = mk_pid(pid_ns, map, offset);
152         }
153         return -1;
154 }
155
156 static int next_pidmap(struct pid_namespace *pid_ns, int last)
157 {
158         int offset;
159         struct pidmap *map, *end;
160
161         offset = (last + 1) & BITS_PER_PAGE_MASK;
162         map = &pid_ns->pidmap[(last + 1)/BITS_PER_PAGE];
163         end = &pid_ns->pidmap[PIDMAP_ENTRIES];
164         for (; map < end; map++, offset = 0) {
165                 if (unlikely(!map->page))
166                         continue;
167                 offset = find_next_bit((map)->page, BITS_PER_PAGE, offset);
168                 if (offset < BITS_PER_PAGE)
169                         return mk_pid(pid_ns, map, offset);
170         }
171         return -1;
172 }
173
174 fastcall void put_pid(struct pid *pid)
175 {
176         if (!pid)
177                 return;
178         if ((atomic_read(&pid->count) == 1) ||
179              atomic_dec_and_test(&pid->count))
180                 kmem_cache_free(pid_cachep, pid);
181 }
182 EXPORT_SYMBOL_GPL(put_pid);
183
184 static void delayed_put_pid(struct rcu_head *rhp)
185 {
186         struct pid *pid = container_of(rhp, struct pid, rcu);
187         put_pid(pid);
188 }
189
190 fastcall void free_pid(struct pid *pid)
191 {
192         /* We can be called with write_lock_irq(&tasklist_lock) held */
193         unsigned long flags;
194
195         spin_lock_irqsave(&pidmap_lock, flags);
196         hlist_del_rcu(&pid->pid_chain);
197         spin_unlock_irqrestore(&pidmap_lock, flags);
198
199         free_pidmap(&init_pid_ns, pid->nr);
200         call_rcu(&pid->rcu, delayed_put_pid);
201 }
202
203 struct pid *alloc_pid(void)
204 {
205         struct pid *pid;
206         enum pid_type type;
207         int nr = -1;
208
209         pid = kmem_cache_alloc(pid_cachep, GFP_KERNEL);
210         if (!pid)
211                 goto out;
212
213         nr = alloc_pidmap(&init_pid_ns);
214         if (nr < 0)
215                 goto out_free;
216
217         atomic_set(&pid->count, 1);
218         pid->nr = nr;
219         for (type = 0; type < PIDTYPE_MAX; ++type)
220                 INIT_HLIST_HEAD(&pid->tasks[type]);
221
222         spin_lock_irq(&pidmap_lock);
223         hlist_add_head_rcu(&pid->pid_chain, &pid_hash[pid_hashfn(pid->nr)]);
224         spin_unlock_irq(&pidmap_lock);
225
226 out:
227         return pid;
228
229 out_free:
230         kmem_cache_free(pid_cachep, pid);
231         pid = NULL;
232         goto out;
233 }
234
235 struct pid * fastcall find_pid(int nr)
236 {
237         struct hlist_node *elem;
238         struct pid *pid;
239
240         hlist_for_each_entry_rcu(pid, elem,
241                         &pid_hash[pid_hashfn(nr)], pid_chain) {
242                 if (pid->nr == nr)
243                         return pid;
244         }
245         return NULL;
246 }
247 EXPORT_SYMBOL_GPL(find_pid);
248
249 int fastcall attach_pid(struct task_struct *task, enum pid_type type, int nr)
250 {
251         struct pid_link *link;
252         struct pid *pid;
253
254         link = &task->pids[type];
255         link->pid = pid = find_pid(nr);
256         hlist_add_head_rcu(&link->node, &pid->tasks[type]);
257
258         return 0;
259 }
260
261 void fastcall detach_pid(struct task_struct *task, enum pid_type type)
262 {
263         struct pid_link *link;
264         struct pid *pid;
265         int tmp;
266
267         link = &task->pids[type];
268         pid = link->pid;
269
270         hlist_del_rcu(&link->node);
271         link->pid = NULL;
272
273         for (tmp = PIDTYPE_MAX; --tmp >= 0; )
274                 if (!hlist_empty(&pid->tasks[tmp]))
275                         return;
276
277         free_pid(pid);
278 }
279
280 /* transfer_pid is an optimization of attach_pid(new), detach_pid(old) */
281 void fastcall transfer_pid(struct task_struct *old, struct task_struct *new,
282                            enum pid_type type)
283 {
284         new->pids[type].pid = old->pids[type].pid;
285         hlist_replace_rcu(&old->pids[type].node, &new->pids[type].node);
286         old->pids[type].pid = NULL;
287 }
288
289 struct task_struct * fastcall pid_task(struct pid *pid, enum pid_type type)
290 {
291         struct task_struct *result = NULL;
292         if (pid) {
293                 struct hlist_node *first;
294                 first = rcu_dereference(pid->tasks[type].first);
295                 if (first)
296                         result = hlist_entry(first, struct task_struct, pids[(type)].node);
297         }
298         return result;
299 }
300
301 /*
302  * Must be called under rcu_read_lock() or with tasklist_lock read-held.
303  */
304 struct task_struct *find_task_by_pid_type(int type, int nr)
305 {
306         return pid_task(find_pid(nr), type);
307 }
308
309 EXPORT_SYMBOL(find_task_by_pid_type);
310
311 struct pid *get_task_pid(struct task_struct *task, enum pid_type type)
312 {
313         struct pid *pid;
314         rcu_read_lock();
315         pid = get_pid(task->pids[type].pid);
316         rcu_read_unlock();
317         return pid;
318 }
319
320 struct task_struct *fastcall get_pid_task(struct pid *pid, enum pid_type type)
321 {
322         struct task_struct *result;
323         rcu_read_lock();
324         result = pid_task(pid, type);
325         if (result)
326                 get_task_struct(result);
327         rcu_read_unlock();
328         return result;
329 }
330
331 struct pid *find_get_pid(pid_t nr)
332 {
333         struct pid *pid;
334
335         rcu_read_lock();
336         pid = get_pid(find_pid(nr));
337         rcu_read_unlock();
338
339         return pid;
340 }
341
342 /*
343  * Used by proc to find the first pid that is greater then or equal to nr.
344  *
345  * If there is a pid at nr this function is exactly the same as find_pid.
346  */
347 struct pid *find_ge_pid(int nr)
348 {
349         struct pid *pid;
350
351         do {
352                 pid = find_pid(nr);
353                 if (pid)
354                         break;
355                 nr = next_pidmap(&init_pid_ns, nr);
356         } while (nr > 0);
357
358         return pid;
359 }
360 EXPORT_SYMBOL_GPL(find_get_pid);
361
362 int copy_pid_ns(int flags, struct task_struct *tsk)
363 {
364         struct pid_namespace *old_ns = tsk->nsproxy->pid_ns;
365         int err = 0;
366
367         if (!old_ns)
368                 return 0;
369
370         get_pid_ns(old_ns);
371         return err;
372 }
373
374 void free_pid_ns(struct kref *kref)
375 {
376         struct pid_namespace *ns;
377
378         ns = container_of(kref, struct pid_namespace, kref);
379         kfree(ns);
380 }
381
382 /*
383  * The pid hash table is scaled according to the amount of memory in the
384  * machine.  From a minimum of 16 slots up to 4096 slots at one gigabyte or
385  * more.
386  */
387 void __init pidhash_init(void)
388 {
389         int i, pidhash_size;
390         unsigned long megabytes = nr_kernel_pages >> (20 - PAGE_SHIFT);
391
392         pidhash_shift = max(4, fls(megabytes * 4));
393         pidhash_shift = min(12, pidhash_shift);
394         pidhash_size = 1 << pidhash_shift;
395
396         printk("PID hash table entries: %d (order: %d, %Zd bytes)\n",
397                 pidhash_size, pidhash_shift,
398                 pidhash_size * sizeof(struct hlist_head));
399
400         pid_hash = alloc_bootmem(pidhash_size * sizeof(*(pid_hash)));
401         if (!pid_hash)
402                 panic("Could not alloc pidhash!\n");
403         for (i = 0; i < pidhash_size; i++)
404                 INIT_HLIST_HEAD(&pid_hash[i]);
405 }
406
407 void __init pidmap_init(void)
408 {
409         init_pid_ns.pidmap[0].page = kzalloc(PAGE_SIZE, GFP_KERNEL);
410         /* Reserve PID 0. We never call free_pidmap(0) */
411         set_bit(0, init_pid_ns.pidmap[0].page);
412         atomic_dec(&init_pid_ns.pidmap[0].nr_free);
413
414         pid_cachep = kmem_cache_create("pid", sizeof(struct pid),
415                                         __alignof__(struct pid),
416                                         SLAB_PANIC, NULL, NULL);
417 }