pid namespaces: helpers to find the task by its numerical ids
[safe/jmp/linux-2.6] / 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 #include <linux/init_task.h>
31
32 #define pid_hashfn(nr, ns)      \
33         hash_long((unsigned long)nr + (unsigned long)ns, pidhash_shift)
34 static struct hlist_head *pid_hash;
35 static int pidhash_shift;
36 struct pid init_struct_pid = INIT_STRUCT_PID;
37
38 int pid_max = PID_MAX_DEFAULT;
39
40 #define RESERVED_PIDS           300
41
42 int pid_max_min = RESERVED_PIDS + 1;
43 int pid_max_max = PID_MAX_LIMIT;
44
45 #define BITS_PER_PAGE           (PAGE_SIZE*8)
46 #define BITS_PER_PAGE_MASK      (BITS_PER_PAGE-1)
47
48 static inline int mk_pid(struct pid_namespace *pid_ns,
49                 struct pidmap *map, int off)
50 {
51         return (map - pid_ns->pidmap)*BITS_PER_PAGE + off;
52 }
53
54 #define find_next_offset(map, off)                                      \
55                 find_next_zero_bit((map)->page, BITS_PER_PAGE, off)
56
57 /*
58  * PID-map pages start out as NULL, they get allocated upon
59  * first use and are never deallocated. This way a low pid_max
60  * value does not cause lots of bitmaps to be allocated, but
61  * the scheme scales to up to 4 million PIDs, runtime.
62  */
63 struct pid_namespace init_pid_ns = {
64         .kref = {
65                 .refcount       = ATOMIC_INIT(2),
66         },
67         .pidmap = {
68                 [ 0 ... PIDMAP_ENTRIES-1] = { ATOMIC_INIT(BITS_PER_PAGE), NULL }
69         },
70         .last_pid = 0,
71         .level = 0,
72         .child_reaper = &init_task,
73 };
74 EXPORT_SYMBOL_GPL(init_pid_ns);
75
76 int is_global_init(struct task_struct *tsk)
77 {
78         return tsk == init_pid_ns.child_reaper;
79 }
80
81 /*
82  * Note: disable interrupts while the pidmap_lock is held as an
83  * interrupt might come in and do read_lock(&tasklist_lock).
84  *
85  * If we don't disable interrupts there is a nasty deadlock between
86  * detach_pid()->free_pid() and another cpu that does
87  * spin_lock(&pidmap_lock) followed by an interrupt routine that does
88  * read_lock(&tasklist_lock);
89  *
90  * After we clean up the tasklist_lock and know there are no
91  * irq handlers that take it we can leave the interrupts enabled.
92  * For now it is easier to be safe than to prove it can't happen.
93  */
94
95 static  __cacheline_aligned_in_smp DEFINE_SPINLOCK(pidmap_lock);
96
97 static fastcall void free_pidmap(struct pid_namespace *pid_ns, int pid)
98 {
99         struct pidmap *map = pid_ns->pidmap + pid / BITS_PER_PAGE;
100         int offset = pid & BITS_PER_PAGE_MASK;
101
102         clear_bit(offset, map->page);
103         atomic_inc(&map->nr_free);
104 }
105
106 static int alloc_pidmap(struct pid_namespace *pid_ns)
107 {
108         int i, offset, max_scan, pid, last = pid_ns->last_pid;
109         struct pidmap *map;
110
111         pid = last + 1;
112         if (pid >= pid_max)
113                 pid = RESERVED_PIDS;
114         offset = pid & BITS_PER_PAGE_MASK;
115         map = &pid_ns->pidmap[pid/BITS_PER_PAGE];
116         max_scan = (pid_max + BITS_PER_PAGE - 1)/BITS_PER_PAGE - !offset;
117         for (i = 0; i <= max_scan; ++i) {
118                 if (unlikely(!map->page)) {
119                         void *page = kzalloc(PAGE_SIZE, GFP_KERNEL);
120                         /*
121                          * Free the page if someone raced with us
122                          * installing it:
123                          */
124                         spin_lock_irq(&pidmap_lock);
125                         if (map->page)
126                                 kfree(page);
127                         else
128                                 map->page = page;
129                         spin_unlock_irq(&pidmap_lock);
130                         if (unlikely(!map->page))
131                                 break;
132                 }
133                 if (likely(atomic_read(&map->nr_free))) {
134                         do {
135                                 if (!test_and_set_bit(offset, map->page)) {
136                                         atomic_dec(&map->nr_free);
137                                         pid_ns->last_pid = pid;
138                                         return pid;
139                                 }
140                                 offset = find_next_offset(map, offset);
141                                 pid = mk_pid(pid_ns, map, offset);
142                         /*
143                          * find_next_offset() found a bit, the pid from it
144                          * is in-bounds, and if we fell back to the last
145                          * bitmap block and the final block was the same
146                          * as the starting point, pid is before last_pid.
147                          */
148                         } while (offset < BITS_PER_PAGE && pid < pid_max &&
149                                         (i != max_scan || pid < last ||
150                                             !((last+1) & BITS_PER_PAGE_MASK)));
151                 }
152                 if (map < &pid_ns->pidmap[(pid_max-1)/BITS_PER_PAGE]) {
153                         ++map;
154                         offset = 0;
155                 } else {
156                         map = &pid_ns->pidmap[0];
157                         offset = RESERVED_PIDS;
158                         if (unlikely(last == offset))
159                                 break;
160                 }
161                 pid = mk_pid(pid_ns, map, offset);
162         }
163         return -1;
164 }
165
166 static int next_pidmap(struct pid_namespace *pid_ns, int last)
167 {
168         int offset;
169         struct pidmap *map, *end;
170
171         offset = (last + 1) & BITS_PER_PAGE_MASK;
172         map = &pid_ns->pidmap[(last + 1)/BITS_PER_PAGE];
173         end = &pid_ns->pidmap[PIDMAP_ENTRIES];
174         for (; map < end; map++, offset = 0) {
175                 if (unlikely(!map->page))
176                         continue;
177                 offset = find_next_bit((map)->page, BITS_PER_PAGE, offset);
178                 if (offset < BITS_PER_PAGE)
179                         return mk_pid(pid_ns, map, offset);
180         }
181         return -1;
182 }
183
184 fastcall void put_pid(struct pid *pid)
185 {
186         struct pid_namespace *ns;
187
188         if (!pid)
189                 return;
190
191         ns = pid->numbers[pid->level].ns;
192         if ((atomic_read(&pid->count) == 1) ||
193              atomic_dec_and_test(&pid->count)) {
194                 kmem_cache_free(ns->pid_cachep, pid);
195                 if (ns != &init_pid_ns)
196                         put_pid_ns(ns);
197         }
198 }
199 EXPORT_SYMBOL_GPL(put_pid);
200
201 static void delayed_put_pid(struct rcu_head *rhp)
202 {
203         struct pid *pid = container_of(rhp, struct pid, rcu);
204         put_pid(pid);
205 }
206
207 fastcall void free_pid(struct pid *pid)
208 {
209         /* We can be called with write_lock_irq(&tasklist_lock) held */
210         int i;
211         unsigned long flags;
212
213         spin_lock_irqsave(&pidmap_lock, flags);
214         for (i = 0; i <= pid->level; i++)
215                 hlist_del_rcu(&pid->numbers[i].pid_chain);
216         spin_unlock_irqrestore(&pidmap_lock, flags);
217
218         for (i = 0; i <= pid->level; i++)
219                 free_pidmap(pid->numbers[i].ns, pid->numbers[i].nr);
220
221         call_rcu(&pid->rcu, delayed_put_pid);
222 }
223
224 struct pid *alloc_pid(struct pid_namespace *ns)
225 {
226         struct pid *pid;
227         enum pid_type type;
228         int i, nr;
229         struct pid_namespace *tmp;
230         struct upid *upid;
231
232         pid = kmem_cache_alloc(ns->pid_cachep, GFP_KERNEL);
233         if (!pid)
234                 goto out;
235
236         tmp = ns;
237         for (i = ns->level; i >= 0; i--) {
238                 nr = alloc_pidmap(tmp);
239                 if (nr < 0)
240                         goto out_free;
241
242                 pid->numbers[i].nr = nr;
243                 pid->numbers[i].ns = tmp;
244                 tmp = tmp->parent;
245         }
246
247         if (ns != &init_pid_ns)
248                 get_pid_ns(ns);
249
250         pid->level = ns->level;
251         pid->nr = pid->numbers[0].nr;
252         atomic_set(&pid->count, 1);
253         for (type = 0; type < PIDTYPE_MAX; ++type)
254                 INIT_HLIST_HEAD(&pid->tasks[type]);
255
256         spin_lock_irq(&pidmap_lock);
257         for (i = ns->level; i >= 0; i--) {
258                 upid = &pid->numbers[i];
259                 hlist_add_head_rcu(&upid->pid_chain,
260                                 &pid_hash[pid_hashfn(upid->nr, upid->ns)]);
261         }
262         spin_unlock_irq(&pidmap_lock);
263
264 out:
265         return pid;
266
267 out_free:
268         for (i++; i <= ns->level; i++)
269                 free_pidmap(pid->numbers[i].ns, pid->numbers[i].nr);
270
271         kmem_cache_free(ns->pid_cachep, pid);
272         pid = NULL;
273         goto out;
274 }
275
276 struct pid * fastcall find_pid_ns(int nr, struct pid_namespace *ns)
277 {
278         struct hlist_node *elem;
279         struct upid *pnr;
280
281         hlist_for_each_entry_rcu(pnr, elem,
282                         &pid_hash[pid_hashfn(nr, ns)], pid_chain)
283                 if (pnr->nr == nr && pnr->ns == ns)
284                         return container_of(pnr, struct pid,
285                                         numbers[ns->level]);
286
287         return NULL;
288 }
289 EXPORT_SYMBOL_GPL(find_pid_ns);
290
291 /*
292  * attach_pid() must be called with the tasklist_lock write-held.
293  */
294 int fastcall attach_pid(struct task_struct *task, enum pid_type type,
295                 struct pid *pid)
296 {
297         struct pid_link *link;
298
299         link = &task->pids[type];
300         link->pid = pid;
301         hlist_add_head_rcu(&link->node, &pid->tasks[type]);
302
303         return 0;
304 }
305
306 void fastcall detach_pid(struct task_struct *task, enum pid_type type)
307 {
308         struct pid_link *link;
309         struct pid *pid;
310         int tmp;
311
312         link = &task->pids[type];
313         pid = link->pid;
314
315         hlist_del_rcu(&link->node);
316         link->pid = NULL;
317
318         for (tmp = PIDTYPE_MAX; --tmp >= 0; )
319                 if (!hlist_empty(&pid->tasks[tmp]))
320                         return;
321
322         free_pid(pid);
323 }
324
325 /* transfer_pid is an optimization of attach_pid(new), detach_pid(old) */
326 void fastcall transfer_pid(struct task_struct *old, struct task_struct *new,
327                            enum pid_type type)
328 {
329         new->pids[type].pid = old->pids[type].pid;
330         hlist_replace_rcu(&old->pids[type].node, &new->pids[type].node);
331         old->pids[type].pid = NULL;
332 }
333
334 struct task_struct * fastcall pid_task(struct pid *pid, enum pid_type type)
335 {
336         struct task_struct *result = NULL;
337         if (pid) {
338                 struct hlist_node *first;
339                 first = rcu_dereference(pid->tasks[type].first);
340                 if (first)
341                         result = hlist_entry(first, struct task_struct, pids[(type)].node);
342         }
343         return result;
344 }
345
346 /*
347  * Must be called under rcu_read_lock() or with tasklist_lock read-held.
348  */
349 struct task_struct *find_task_by_pid_type_ns(int type, int nr,
350                 struct pid_namespace *ns)
351 {
352         return pid_task(find_pid_ns(nr, ns), type);
353 }
354
355 EXPORT_SYMBOL(find_task_by_pid_type_ns);
356
357 struct pid *get_task_pid(struct task_struct *task, enum pid_type type)
358 {
359         struct pid *pid;
360         rcu_read_lock();
361         pid = get_pid(task->pids[type].pid);
362         rcu_read_unlock();
363         return pid;
364 }
365
366 struct task_struct *fastcall get_pid_task(struct pid *pid, enum pid_type type)
367 {
368         struct task_struct *result;
369         rcu_read_lock();
370         result = pid_task(pid, type);
371         if (result)
372                 get_task_struct(result);
373         rcu_read_unlock();
374         return result;
375 }
376
377 struct pid *find_get_pid(pid_t nr)
378 {
379         struct pid *pid;
380
381         rcu_read_lock();
382         pid = get_pid(find_vpid(nr));
383         rcu_read_unlock();
384
385         return pid;
386 }
387
388 pid_t pid_nr_ns(struct pid *pid, struct pid_namespace *ns)
389 {
390         struct upid *upid;
391         pid_t nr = 0;
392
393         if (pid && ns->level <= pid->level) {
394                 upid = &pid->numbers[ns->level];
395                 if (upid->ns == ns)
396                         nr = upid->nr;
397         }
398         return nr;
399 }
400
401 /*
402  * Used by proc to find the first pid that is greater then or equal to nr.
403  *
404  * If there is a pid at nr this function is exactly the same as find_pid.
405  */
406 struct pid *find_ge_pid(int nr, struct pid_namespace *ns)
407 {
408         struct pid *pid;
409
410         do {
411                 pid = find_pid_ns(nr, ns);
412                 if (pid)
413                         break;
414                 nr = next_pidmap(ns, nr);
415         } while (nr > 0);
416
417         return pid;
418 }
419 EXPORT_SYMBOL_GPL(find_get_pid);
420
421 struct pid_cache {
422         int nr_ids;
423         char name[16];
424         struct kmem_cache *cachep;
425         struct list_head list;
426 };
427
428 static LIST_HEAD(pid_caches_lh);
429 static DEFINE_MUTEX(pid_caches_mutex);
430
431 /*
432  * creates the kmem cache to allocate pids from.
433  * @nr_ids: the number of numerical ids this pid will have to carry
434  */
435
436 static struct kmem_cache *create_pid_cachep(int nr_ids)
437 {
438         struct pid_cache *pcache;
439         struct kmem_cache *cachep;
440
441         mutex_lock(&pid_caches_mutex);
442         list_for_each_entry (pcache, &pid_caches_lh, list)
443                 if (pcache->nr_ids == nr_ids)
444                         goto out;
445
446         pcache = kmalloc(sizeof(struct pid_cache), GFP_KERNEL);
447         if (pcache == NULL)
448                 goto err_alloc;
449
450         snprintf(pcache->name, sizeof(pcache->name), "pid_%d", nr_ids);
451         cachep = kmem_cache_create(pcache->name,
452                         /* FIXME add numerical ids here */
453                         sizeof(struct pid), 0, SLAB_HWCACHE_ALIGN, NULL);
454         if (cachep == NULL)
455                 goto err_cachep;
456
457         pcache->nr_ids = nr_ids;
458         pcache->cachep = cachep;
459         list_add(&pcache->list, &pid_caches_lh);
460 out:
461         mutex_unlock(&pid_caches_mutex);
462         return pcache->cachep;
463
464 err_cachep:
465         kfree(pcache);
466 err_alloc:
467         mutex_unlock(&pid_caches_mutex);
468         return NULL;
469 }
470
471 struct pid_namespace *copy_pid_ns(unsigned long flags, struct pid_namespace *old_ns)
472 {
473         BUG_ON(!old_ns);
474         get_pid_ns(old_ns);
475         return old_ns;
476 }
477
478 void free_pid_ns(struct kref *kref)
479 {
480         struct pid_namespace *ns;
481
482         ns = container_of(kref, struct pid_namespace, kref);
483         kfree(ns);
484 }
485
486 /*
487  * The pid hash table is scaled according to the amount of memory in the
488  * machine.  From a minimum of 16 slots up to 4096 slots at one gigabyte or
489  * more.
490  */
491 void __init pidhash_init(void)
492 {
493         int i, pidhash_size;
494         unsigned long megabytes = nr_kernel_pages >> (20 - PAGE_SHIFT);
495
496         pidhash_shift = max(4, fls(megabytes * 4));
497         pidhash_shift = min(12, pidhash_shift);
498         pidhash_size = 1 << pidhash_shift;
499
500         printk("PID hash table entries: %d (order: %d, %Zd bytes)\n",
501                 pidhash_size, pidhash_shift,
502                 pidhash_size * sizeof(struct hlist_head));
503
504         pid_hash = alloc_bootmem(pidhash_size * sizeof(*(pid_hash)));
505         if (!pid_hash)
506                 panic("Could not alloc pidhash!\n");
507         for (i = 0; i < pidhash_size; i++)
508                 INIT_HLIST_HEAD(&pid_hash[i]);
509 }
510
511 void __init pidmap_init(void)
512 {
513         init_pid_ns.pidmap[0].page = kzalloc(PAGE_SIZE, GFP_KERNEL);
514         /* Reserve PID 0. We never call free_pidmap(0) */
515         set_bit(0, init_pid_ns.pidmap[0].page);
516         atomic_dec(&init_pid_ns.pidmap[0].nr_free);
517
518         init_pid_ns.pid_cachep = create_pid_cachep(1);
519         if (init_pid_ns.pid_cachep == NULL)
520                 panic("Can't create pid_1 cachep\n");
521 }