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