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/vs_pid.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 static struct kmem_cache *pid_cachep;
  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 /*
  74  * Note: disable interrupts while the pidmap_lock is held as an
  75  * interrupt might come in and do read_lock(&tasklist_lock).
  76  *
  77  * If we don't disable interrupts there is a nasty deadlock between
  78  * detach_pid()->free_pid() and another cpu that does
  79  * spin_lock(&pidmap_lock) followed by an interrupt routine that does
  80  * read_lock(&tasklist_lock);
  81  *
  82  * After we clean up the tasklist_lock and know there are no
  83  * irq handlers that take it we can leave the interrupts enabled.
  84  * For now it is easier to be safe than to prove it can't happen.
  85  */
  86
  87 static  __cacheline_aligned_in_smp DEFINE_SPINLOCK(pidmap_lock);
  88
  89 static fastcall void free_pidmap(struct pid_namespace *pid_ns, int pid)
  90 {
  91         struct pidmap *map = pid_ns->pidmap + pid / BITS_PER_PAGE;
  92         int offset = pid & BITS_PER_PAGE_MASK;
  93
  94         clear_bit(offset, map->page);
  95         atomic_inc(&map->nr_free);
  96 }
  97
  98 static int alloc_pidmap(struct pid_namespace *pid_ns)
  99 {
 100         int i, offset, max_scan, pid, last = pid_ns->last_pid;
 101         struct pidmap *map;
 102
 103         pid = last + 1;
 104         if (pid >= pid_max)
 105                 pid = RESERVED_PIDS;
 106         offset = pid & BITS_PER_PAGE_MASK;
 107         map = &pid_ns->pidmap[pid/BITS_PER_PAGE];
 108         max_scan = (pid_max + BITS_PER_PAGE - 1)/BITS_PER_PAGE - !offset;
 109         for (i = 0; i <= max_scan; ++i) {
 110                 if (unlikely(!map->page)) {
 111                         void *page = kzalloc(PAGE_SIZE, GFP_KERNEL);
 112                         /*
 113                          * Free the page if someone raced with us
 114                          * installing it:
 115                          */
 116                         spin_lock_irq(&pidmap_lock);
 117                         if (map->page)
 118                                 kfree(page);
 119                         else
 120                                 map->page = page;
 121                         spin_unlock_irq(&pidmap_lock);
 122                         if (unlikely(!map->page))
 123                                 break;
 124                 }
 125                 if (likely(atomic_read(&map->nr_free))) {
 126                         do {
 127                                 if (!test_and_set_bit(offset, map->page)) {
 128                                         atomic_dec(&map->nr_free);
 129                                         pid_ns->last_pid = pid;
 130                                         return pid;
 131                                 }
 132                                 offset = find_next_offset(map, offset);
 133                                 pid = mk_pid(pid_ns, map, offset);
 134                         /*
 135                          * find_next_offset() found a bit, the pid from it
 136                          * is in-bounds, and if we fell back to the last
 137                          * bitmap block and the final block was the same
 138                          * as the starting point, pid is before last_pid.
 139                          */
 140                         } while (offset < BITS_PER_PAGE && pid < pid_max &&
 141                                         (i != max_scan || pid < last ||
 142                                             !((last+1) & BITS_PER_PAGE_MASK)));
 143                 }
 144                 if (map < &pid_ns->pidmap[(pid_max-1)/BITS_PER_PAGE]) {
 145                         ++map;
 146                         offset = 0;
 147                 } else {
 148                         map = &pid_ns->pidmap[0];
 149                         offset = RESERVED_PIDS;
 150                         if (unlikely(last == offset))
 151                                 break;
 152                 }
 153                 pid = mk_pid(pid_ns, map, offset);
 154         }
 155         return -1;
 156 }
 157
 158 static int next_pidmap(struct pid_namespace *pid_ns, int last)
 159 {
 160         int offset;
 161         struct pidmap *map, *end;
 162
 163         offset = (last + 1) & BITS_PER_PAGE_MASK;
 164         map = &pid_ns->pidmap[(last + 1)/BITS_PER_PAGE];
 165         end = &pid_ns->pidmap[PIDMAP_ENTRIES];
 166         for (; map < end; map++, offset = 0) {
 167                 if (unlikely(!map->page))
 168                         continue;
 169                 offset = find_next_bit((map)->page, BITS_PER_PAGE, offset);
 170                 if (offset < BITS_PER_PAGE)
 171                         return mk_pid(pid_ns, map, offset);
 172         }
 173         return -1;
 174 }
 175
 176 fastcall void put_pid(struct pid *pid)
 177 {
 178         if (!pid)
 179                 return;
 180         if ((atomic_read(&pid->count) == 1) ||
 181              atomic_dec_and_test(&pid->count))
 182                 kmem_cache_free(pid_cachep, pid);
 183 }
 184 EXPORT_SYMBOL_GPL(put_pid);
 185
 186 static void delayed_put_pid(struct rcu_head *rhp)
 187 {
 188         struct pid *pid = container_of(rhp, struct pid, rcu);
 189         put_pid(pid);
 190 }
 191
 192 fastcall void free_pid(struct pid *pid)
 193 {
 194         /* We can be called with write_lock_irq(&tasklist_lock) held */
 195         unsigned long flags;
 196
 197         spin_lock_irqsave(&pidmap_lock, flags);
 198         hlist_del_rcu(&pid->pid_chain);
 199         spin_unlock_irqrestore(&pidmap_lock, flags);
 200
 201         free_pidmap(&init_pid_ns, pid->nr);
 202         call_rcu(&pid->rcu, delayed_put_pid);
 203 }
 204
 205 struct pid *alloc_pid(void)
 206 {
 207         struct pid *pid;
 208         enum pid_type type;
 209         int nr = -1;
 210
 211         pid = kmem_cache_alloc(pid_cachep, GFP_KERNEL);
 212         if (!pid)
 213                 goto out;
 214
 215         nr = alloc_pidmap(current->nsproxy->pid_ns);
 216         if (nr < 0)
 217                 goto out_free;
 218
 219         atomic_set(&pid->count, 1);
 220         pid->nr = nr;
 221         for (type = 0; type < PIDTYPE_MAX; ++type)
 222                 INIT_HLIST_HEAD(&pid->tasks[type]);
 223
 224         spin_lock_irq(&pidmap_lock);
 225         hlist_add_head_rcu(&pid->pid_chain, &pid_hash[pid_hashfn(pid->nr)]);
 226         spin_unlock_irq(&pidmap_lock);
 227
 228 out:
 229         return pid;
 230
 231 out_free:
 232         kmem_cache_free(pid_cachep, pid);
 233         pid = NULL;
 234         goto out;
 235 }
 236
 237 struct pid * fastcall find_pid(int nr)
 238 {
 239         struct hlist_node *elem;
 240         struct pid *pid;
 241
 242         hlist_for_each_entry_rcu(pid, elem,
 243                         &pid_hash[pid_hashfn(nr)], pid_chain) {
 244                 if (pid->nr == nr)
 245                         return pid;
 246         }
 247         return NULL;
 248 }
 249 EXPORT_SYMBOL_GPL(find_pid);
 250
 251 int fastcall attach_pid(struct task_struct *task, enum pid_type type, int nr)
 252 {
 253         struct pid_link *link;
 254         struct pid *pid;
 255
 256         link = &task->pids[type];
 257         link->pid = pid = find_pid(nr);
 258         hlist_add_head_rcu(&link->node, &pid->tasks[type]);
 259
 260         return 0;
 261 }
 262
 263 void fastcall detach_pid(struct task_struct *task, enum pid_type type)
 264 {
 265         struct pid_link *link;
 266         struct pid *pid;
 267         int tmp;
 268
 269         link = &task->pids[type];
 270         pid = link->pid;
 271
 272         hlist_del_rcu(&link->node);
 273         link->pid = NULL;
 274
 275         for (tmp = PIDTYPE_MAX; --tmp >= 0; )
 276                 if (!hlist_empty(&pid->tasks[tmp]))
 277                         return;
 278
 279         free_pid(pid);
 280 }
 281
 282 /* transfer_pid is an optimization of attach_pid(new), detach_pid(old) */
 283 void fastcall transfer_pid(struct task_struct *old, struct task_struct *new,
 284                            enum pid_type type)
 285 {
 286         new->pids[type].pid = old->pids[type].pid;
 287         hlist_replace_rcu(&old->pids[type].node, &new->pids[type].node);
 288         old->pids[type].pid = NULL;
 289 }
 290
 291 struct task_struct * fastcall pid_task(struct pid *pid, enum pid_type type)
 292 {
 293         struct task_struct *result = NULL;
 294
 295         if (type == PIDTYPE_REALPID)
 296                 type = PIDTYPE_PID;
 297         if (pid) {
 298                 struct hlist_node *first;
 299                 first = rcu_dereference(pid->tasks[type].first);
 300                 if (first)
 301                         result = hlist_entry(first, struct task_struct, pids[(type)].node);
 302         }
 303         return result;
 304 }
 305
 306 /*
 307  * Must be called under rcu_read_lock() or with tasklist_lock read-held.
 308  */
 309 struct task_struct *find_task_by_pid_type(int type, int nr)
 310 {
 311         struct task_struct *task;
 312
 313         if (type == PIDTYPE_PID)
 314                 nr = vx_rmap_pid(nr);
 315
 316         task = pid_task(find_pid(nr), type);
 317         if (task && (type != PIDTYPE_REALPID) &&
 318                 /* maybe VS_WATCH_P in the future? */
 319                 !vx_check(task->xid, VS_WATCH|VS_IDENT))
 320                 return NULL;
 321         return task;
 322 }
 323
 324 EXPORT_SYMBOL(find_task_by_pid_type);
 325
 326 struct pid *get_task_pid(struct task_struct *task, enum pid_type type)
 327 {
 328         struct pid *pid;
 329         rcu_read_lock();
 330         pid = get_pid(task->pids[type].pid);
 331         rcu_read_unlock();
 332         return pid;
 333 }
 334
 335 struct task_struct *fastcall get_pid_task(struct pid *pid, enum pid_type type)
 336 {
 337         struct task_struct *result;
 338         rcu_read_lock();
 339         result = pid_task(pid, type);
 340         if (result)
 341                 get_task_struct(result);
 342         rcu_read_unlock();
 343         return result;
 344 }
 345
 346 struct pid *find_get_pid(pid_t nr)
 347 {
 348         struct pid *pid;
 349
 350         rcu_read_lock();
 351         pid = get_pid(find_pid(nr));
 352         rcu_read_unlock();
 353
 354         return pid;
 355 }
 356
 357 /*
 358  * Used by proc to find the first pid that is greater then or equal to nr.
 359  *
 360  * If there is a pid at nr this function is exactly the same as find_pid.
 361  */
 362 struct pid *find_ge_pid(int nr)
 363 {
 364         struct pid *pid;
 365
 366         do {
 367                 pid = find_pid(nr);
 368                 if (pid)
 369                         break;
 370                 nr = next_pidmap(current->nsproxy->pid_ns, nr);
 371         } while (nr > 0);
 372
 373         return pid;
 374 }
 375 EXPORT_SYMBOL_GPL(find_get_pid);
 376
 377 int copy_pid_ns(int flags, struct task_struct *tsk)
 378 {
 379         struct pid_namespace *old_ns = tsk->nsproxy->pid_ns;
 380         int err = 0;
 381
 382         if (!old_ns)
 383                 return 0;
 384
 385         get_pid_ns(old_ns);
 386         return err;
 387 }
 388
 389 void free_pid_ns(struct kref *kref)
 390 {
 391         struct pid_namespace *ns;
 392
 393         ns = container_of(kref, struct pid_namespace, kref);
 394         kfree(ns);
 395 }
 396
 397 /*
 398  * The pid hash table is scaled according to the amount of memory in the
 399  * machine.  From a minimum of 16 slots up to 4096 slots at one gigabyte or
 400  * more.
 401  */
 402 void __init pidhash_init(void)
 403 {
 404         int i, pidhash_size;
 405         unsigned long megabytes = nr_kernel_pages >> (20 - PAGE_SHIFT);
 406
 407         pidhash_shift = max(4, fls(megabytes * 4));
 408         pidhash_shift = min(12, pidhash_shift);
 409         pidhash_size = 1 << pidhash_shift;
 410
 411         printk("PID hash table entries: %d (order: %d, %Zd bytes)\n",
 412                 pidhash_size, pidhash_shift,
 413                 pidhash_size * sizeof(struct hlist_head));
 414
 415         pid_hash = alloc_bootmem(pidhash_size * sizeof(*(pid_hash)));
 416         if (!pid_hash)
 417                 panic("Could not alloc pidhash!\n");
 418         for (i = 0; i < pidhash_size; i++)
 419                 INIT_HLIST_HEAD(&pid_hash[i]);
 420 }
 421
 422 void __init pidmap_init(void)
 423 {
 424         init_pid_ns.pidmap[0].page = kzalloc(PAGE_SIZE, GFP_KERNEL);
 425         /* Reserve PID 0. We never call free_pidmap(0) */
 426         set_bit(0, init_pid_ns.pidmap[0].page);
 427         atomic_dec(&init_pid_ns.pidmap[0].nr_free);
 428
 429         pid_cachep = kmem_cache_create("pid", sizeof(struct pid),
 430                                         __alignof__(struct pid),
 431                                         SLAB_PANIC, NULL, NULL);
 432 }