kernel/pid.c

   1 /*
   2  * Generic pidhash and scalable, time-bounded PID allocator
   3  *
   4  * (C) 2002-2003 Nadia Yvette Chambers, IBM
   5  * (C) 2004 Nadia Yvette Chambers, 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  * Pid namespaces:
  23  *    (C) 2007 Pavel Emelyanov <xemul@openvz.org>, OpenVZ, SWsoft Inc.
  24  *    (C) 2007 Sukadev Bhattiprolu <sukadev@us.ibm.com>, IBM
  25  *     Many thanks to Oleg Nesterov for comments and help
  26  *
  27  */
  28
  29 #include <linux/mm.h>
  30 #include <linux/export.h>
  31 #include <linux/slab.h>
  32 #include <linux/init.h>
  33 #include <linux/rculist.h>
  34 #include <linux/bootmem.h>
  35 #include <linux/hash.h>
  36 #include <linux/pid_namespace.h>
  37 #include <linux/init_task.h>
  38 #include <linux/syscalls.h>
  39 #include <linux/proc_fs.h>
  40
  41 #define pid_hashfn(nr, ns)      \
  42         hash_long((unsigned long)nr + (unsigned long)ns, pidhash_shift)
  43 static struct hlist_head *pid_hash;
  44 static unsigned int pidhash_shift = 4;
  45 struct pid init_struct_pid = INIT_STRUCT_PID;
  46
  47 int pid_max = PID_MAX_DEFAULT;
  48
  49 #define RESERVED_PIDS           300
  50
  51 int pid_max_min = RESERVED_PIDS + 1;
  52 int pid_max_max = PID_MAX_LIMIT;
  53
  54 #define BITS_PER_PAGE           (PAGE_SIZE*8)
  55 #define BITS_PER_PAGE_MASK      (BITS_PER_PAGE-1)
  56
  57 static inline int mk_pid(struct pid_namespace *pid_ns,
  58                 struct pidmap *map, int off)
  59 {
  60         return (map - pid_ns->pidmap)*BITS_PER_PAGE + off;
  61 }
  62
  63 #define find_next_offset(map, off)                                      \
  64                 find_next_zero_bit((map)->page, BITS_PER_PAGE, off)
  65
  66 /*
  67  * PID-map pages start out as NULL, they get allocated upon
  68  * first use and are never deallocated. This way a low pid_max
  69  * value does not cause lots of bitmaps to be allocated, but
  70  * the scheme scales to up to 4 million PIDs, runtime.
  71  */
  72 struct pid_namespace init_pid_ns = {
  73         .kref = {
  74                 .refcount       = ATOMIC_INIT(2),
  75         },
  76         .pidmap = {
  77                 [ 0 ... PIDMAP_ENTRIES-1] = { ATOMIC_INIT(BITS_PER_PAGE), NULL }
  78         },
  79         .last_pid = 0,
  80         .level = 0,
  81         .child_reaper = &init_task,
  82         .user_ns = &init_user_ns,
  83         .proc_inum = PROC_PID_INIT_INO,
  84 };
  85 EXPORT_SYMBOL_GPL(init_pid_ns);
  86
  87 int is_container_init(struct task_struct *tsk)
  88 {
  89         int ret = 0;
  90         struct pid *pid;
  91
  92         rcu_read_lock();
  93         pid = task_pid(tsk);
  94         if (pid != NULL && pid->numbers[pid->level].nr == 1)
  95                 ret = 1;
  96         rcu_read_unlock();
  97
  98         return ret;
  99 }
 100 EXPORT_SYMBOL(is_container_init);
 101
 102 /*
 103  * Note: disable interrupts while the pidmap_lock is held as an
 104  * interrupt might come in and do read_lock(&tasklist_lock).
 105  *
 106  * If we don't disable interrupts there is a nasty deadlock between
 107  * detach_pid()->free_pid() and another cpu that does
 108  * spin_lock(&pidmap_lock) followed by an interrupt routine that does
 109  * read_lock(&tasklist_lock);
 110  *
 111  * After we clean up the tasklist_lock and know there are no
 112  * irq handlers that take it we can leave the interrupts enabled.
 113  * For now it is easier to be safe than to prove it can't happen.
 114  */
 115
 116 static  __cacheline_aligned_in_smp DEFINE_SPINLOCK(pidmap_lock);
 117
 118 static void free_pidmap(struct upid *upid)
 119 {
 120         int nr = upid->nr;
 121         struct pidmap *map = upid->ns->pidmap + nr / BITS_PER_PAGE;
 122         int offset = nr & BITS_PER_PAGE_MASK;
 123
 124         clear_bit(offset, map->page);
 125         atomic_inc(&map->nr_free);
 126 }
 127
 128 /*
 129  * If we started walking pids at 'base', is 'a' seen before 'b'?
 130  */
 131 static int pid_before(int base, int a, int b)
 132 {
 133         /*
 134          * This is the same as saying
 135          *
 136          * (a - base + MAXUINT) % MAXUINT < (b - base + MAXUINT) % MAXUINT
 137          * and that mapping orders 'a' and 'b' with respect to 'base'.
 138          */
 139         return (unsigned)(a - base) < (unsigned)(b - base);
 140 }
 141
 142 /*
 143  * We might be racing with someone else trying to set pid_ns->last_pid
 144  * at the pid allocation time (there's also a sysctl for this, but racing
 145  * with this one is OK, see comment in kernel/pid_namespace.c about it).
 146  * We want the winner to have the "later" value, because if the
 147  * "earlier" value prevails, then a pid may get reused immediately.
 148  *
 149  * Since pids rollover, it is not sufficient to just pick the bigger
 150  * value.  We have to consider where we started counting from.
 151  *
 152  * 'base' is the value of pid_ns->last_pid that we observed when
 153  * we started looking for a pid.
 154  *
 155  * 'pid' is the pid that we eventually found.
 156  */
 157 static void set_last_pid(struct pid_namespace *pid_ns, int base, int pid)
 158 {
 159         int prev;
 160         int last_write = base;
 161         do {
 162                 prev = last_write;
 163                 last_write = cmpxchg(&pid_ns->last_pid, prev, pid);
 164         } while ((prev != last_write) && (pid_before(base, last_write, pid)));
 165 }
 166
 167 static int alloc_pidmap(struct pid_namespace *pid_ns)
 168 {
 169         int i, offset, max_scan, pid, last = pid_ns->last_pid;
 170         struct pidmap *map;
 171
 172         pid = last + 1;
 173         if (pid >= pid_max)
 174                 pid = RESERVED_PIDS;
 175         offset = pid & BITS_PER_PAGE_MASK;
 176         map = &pid_ns->pidmap[pid/BITS_PER_PAGE];
 177         /*
 178          * If last_pid points into the middle of the map->page we
 179          * want to scan this bitmap block twice, the second time
 180          * we start with offset == 0 (or RESERVED_PIDS).
 181          */
 182         max_scan = DIV_ROUND_UP(pid_max, BITS_PER_PAGE) - !offset;
 183         for (i = 0; i <= max_scan; ++i) {
 184                 if (unlikely(!map->page)) {
 185                         void *page = kzalloc(PAGE_SIZE, GFP_KERNEL);
 186                         /*
 187                          * Free the page if someone raced with us
 188                          * installing it:
 189                          */
 190                         spin_lock_irq(&pidmap_lock);
 191                         if (!map->page) {
 192                                 map->page = page;
 193                                 page = NULL;
 194                         }
 195                         spin_unlock_irq(&pidmap_lock);
 196                         kfree(page);
 197                         if (unlikely(!map->page))
 198                                 break;
 199                 }
 200                 if (likely(atomic_read(&map->nr_free))) {
 201                         do {
 202                                 if (!test_and_set_bit(offset, map->page)) {
 203                                         atomic_dec(&map->nr_free);
 204                                         set_last_pid(pid_ns, last, pid);
 205                                         return pid;
 206                                 }
 207                                 offset = find_next_offset(map, offset);
 208                                 pid = mk_pid(pid_ns, map, offset);
 209                         } while (offset < BITS_PER_PAGE && pid < pid_max);
 210                 }
 211                 if (map < &pid_ns->pidmap[(pid_max-1)/BITS_PER_PAGE]) {
 212                         ++map;
 213                         offset = 0;
 214                 } else {
 215                         map = &pid_ns->pidmap[0];
 216                         offset = RESERVED_PIDS;
 217                         if (unlikely(last == offset))
 218                                 break;
 219                 }
 220                 pid = mk_pid(pid_ns, map, offset);
 221         }
 222         return -1;
 223 }
 224
 225 int next_pidmap(struct pid_namespace *pid_ns, unsigned int last)
 226 {
 227         int offset;
 228         struct pidmap *map, *end;
 229
 230         if (last >= PID_MAX_LIMIT)
 231                 return -1;
 232
 233         offset = (last + 1) & BITS_PER_PAGE_MASK;
 234         map = &pid_ns->pidmap[(last + 1)/BITS_PER_PAGE];
 235         end = &pid_ns->pidmap[PIDMAP_ENTRIES];
 236         for (; map < end; map++, offset = 0) {
 237                 if (unlikely(!map->page))
 238                         continue;
 239                 offset = find_next_bit((map)->page, BITS_PER_PAGE, offset);
 240                 if (offset < BITS_PER_PAGE)
 241                         return mk_pid(pid_ns, map, offset);
 242         }
 243         return -1;
 244 }
 245
 246 void put_pid(struct pid *pid)
 247 {
 248         struct pid_namespace *ns;
 249
 250         if (!pid)
 251                 return;
 252
 253         ns = pid->numbers[pid->level].ns;
 254         if ((atomic_read(&pid->count) == 1) ||
 255              atomic_dec_and_test(&pid->count)) {
 256                 kmem_cache_free(ns->pid_cachep, pid);
 257                 put_pid_ns(ns);
 258         }
 259 }
 260 EXPORT_SYMBOL_GPL(put_pid);
 261
 262 static void delayed_put_pid(struct rcu_head *rhp)
 263 {
 264         struct pid *pid = container_of(rhp, struct pid, rcu);
 265         put_pid(pid);
 266 }
 267
 268 void free_pid(struct pid *pid)
 269 {
 270         /* We can be called with write_lock_irq(&tasklist_lock) held */
 271         int i;
 272         unsigned long flags;
 273
 274         spin_lock_irqsave(&pidmap_lock, flags);
 275         for (i = 0; i <= pid->level; i++) {
 276                 struct upid *upid = pid->numbers + i;
 277                 struct pid_namespace *ns = upid->ns;
 278                 hlist_del_rcu(&upid->pid_chain);
 279                 switch(--ns->nr_hashed) {
 280                 case 1:
 281                         /* When all that is left in the pid namespace
 282                          * is the reaper wake up the reaper.  The reaper
 283                          * may be sleeping in zap_pid_ns_processes().
 284                          */
 285                         wake_up_process(ns->child_reaper);
 286                         break;
 287                 case 0:
 288                         ns->nr_hashed = -1;
 289                         schedule_work(&ns->proc_work);
 290                         break;
 291                 }
 292         }
 293         spin_unlock_irqrestore(&pidmap_lock, flags);
 294
 295         for (i = 0; i <= pid->level; i++)
 296                 free_pidmap(pid->numbers + i);
 297
 298         call_rcu(&pid->rcu, delayed_put_pid);
 299 }
 300
 301 struct pid *alloc_pid(struct pid_namespace *ns)
 302 {
 303         struct pid *pid;
 304         enum pid_type type;
 305         int i, nr;
 306         struct pid_namespace *tmp;
 307         struct upid *upid;
 308
 309         pid = kmem_cache_alloc(ns->pid_cachep, GFP_KERNEL);
 310         if (!pid)
 311                 goto out;
 312
 313         tmp = ns;
 314         pid->level = ns->level;
 315         for (i = ns->level; i >= 0; i--) {
 316                 nr = alloc_pidmap(tmp);
 317                 if (nr < 0)
 318                         goto out_free;
 319
 320                 pid->numbers[i].nr = nr;
 321                 pid->numbers[i].ns = tmp;
 322                 tmp = tmp->parent;
 323         }
 324
 325         if (unlikely(is_child_reaper(pid))) {
 326                 if (pid_ns_prepare_proc(ns))
 327                         goto out_free;
 328         }
 329
 330         get_pid_ns(ns);
 331         atomic_set(&pid->count, 1);
 332         for (type = 0; type < PIDTYPE_MAX; ++type)
 333                 INIT_HLIST_HEAD(&pid->tasks[type]);
 334
 335         upid = pid->numbers + ns->level;
 336         spin_lock_irq(&pidmap_lock);
 337         if (ns->nr_hashed < 0)
 338                 goto out_unlock;
 339         for ( ; upid >= pid->numbers; --upid) {
 340                 hlist_add_head_rcu(&upid->pid_chain,
 341                                 &pid_hash[pid_hashfn(upid->nr, upid->ns)]);
 342                 upid->ns->nr_hashed++;
 343         }
 344         spin_unlock_irq(&pidmap_lock);
 345
 346 out:
 347         return pid;
 348
 349 out_unlock:
 350         spin_unlock(&pidmap_lock);
 351 out_free:
 352         while (++i <= ns->level)
 353                 free_pidmap(pid->numbers + i);
 354
 355         kmem_cache_free(ns->pid_cachep, pid);
 356         pid = NULL;
 357         goto out;
 358 }
 359
 360 struct pid *find_pid_ns(int nr, struct pid_namespace *ns)
 361 {
 362         struct hlist_node *elem;
 363         struct upid *pnr;
 364
 365         hlist_for_each_entry_rcu(pnr, elem,
 366                         &pid_hash[pid_hashfn(nr, ns)], pid_chain)
 367                 if (pnr->nr == nr && pnr->ns == ns)
 368                         return container_of(pnr, struct pid,
 369                                         numbers[ns->level]);
 370
 371         return NULL;
 372 }
 373 EXPORT_SYMBOL_GPL(find_pid_ns);
 374
 375 struct pid *find_vpid(int nr)
 376 {
 377         return find_pid_ns(nr, task_active_pid_ns(current));
 378 }
 379 EXPORT_SYMBOL_GPL(find_vpid);
 380
 381 /*
 382  * attach_pid() must be called with the tasklist_lock write-held.
 383  */
 384 void attach_pid(struct task_struct *task, enum pid_type type,
 385                 struct pid *pid)
 386 {
 387         struct pid_link *link;
 388
 389         link = &task->pids[type];
 390         link->pid = pid;
 391         hlist_add_head_rcu(&link->node, &pid->tasks[type]);
 392 }
 393
 394 static void __change_pid(struct task_struct *task, enum pid_type type,
 395                         struct pid *new)
 396 {
 397         struct pid_link *link;
 398         struct pid *pid;
 399         int tmp;
 400
 401         link = &task->pids[type];
 402         pid = link->pid;
 403
 404         hlist_del_rcu(&link->node);
 405         link->pid = new;
 406
 407         for (tmp = PIDTYPE_MAX; --tmp >= 0; )
 408                 if (!hlist_empty(&pid->tasks[tmp]))
 409                         return;
 410
 411         free_pid(pid);
 412 }
 413
 414 void detach_pid(struct task_struct *task, enum pid_type type)
 415 {
 416         __change_pid(task, type, NULL);
 417 }
 418
 419 void change_pid(struct task_struct *task, enum pid_type type,
 420                 struct pid *pid)
 421 {
 422         __change_pid(task, type, pid);
 423         attach_pid(task, type, pid);
 424 }
 425
 426 /* transfer_pid is an optimization of attach_pid(new), detach_pid(old) */
 427 void transfer_pid(struct task_struct *old, struct task_struct *new,
 428                            enum pid_type type)
 429 {
 430         new->pids[type].pid = old->pids[type].pid;
 431         hlist_replace_rcu(&old->pids[type].node, &new->pids[type].node);
 432 }
 433
 434 struct task_struct *pid_task(struct pid *pid, enum pid_type type)
 435 {
 436         struct task_struct *result = NULL;
 437         if (pid) {
 438                 struct hlist_node *first;
 439                 first = rcu_dereference_check(hlist_first_rcu(&pid->tasks[type]),
 440                                               lockdep_tasklist_lock_is_held());
 441                 if (first)
 442                         result = hlist_entry(first, struct task_struct, pids[(type)].node);
 443         }
 444         return result;
 445 }
 446 EXPORT_SYMBOL(pid_task);
 447
 448 /*
 449  * Must be called under rcu_read_lock().
 450  */
 451 struct task_struct *find_task_by_pid_ns(pid_t nr, struct pid_namespace *ns)
 452 {
 453         rcu_lockdep_assert(rcu_read_lock_held(),
 454                            "find_task_by_pid_ns() needs rcu_read_lock()"
 455                            " protection");
 456         return pid_task(find_pid_ns(nr, ns), PIDTYPE_PID);
 457 }
 458
 459 struct task_struct *find_task_by_vpid(pid_t vnr)
 460 {
 461         return find_task_by_pid_ns(vnr, task_active_pid_ns(current));
 462 }
 463
 464 struct pid *get_task_pid(struct task_struct *task, enum pid_type type)
 465 {
 466         struct pid *pid;
 467         rcu_read_lock();
 468         if (type != PIDTYPE_PID)
 469                 task = task->group_leader;
 470         pid = get_pid(task->pids[type].pid);
 471         rcu_read_unlock();
 472         return pid;
 473 }
 474 EXPORT_SYMBOL_GPL(get_task_pid);
 475
 476 struct task_struct *get_pid_task(struct pid *pid, enum pid_type type)
 477 {
 478         struct task_struct *result;
 479         rcu_read_lock();
 480         result = pid_task(pid, type);
 481         if (result)
 482                 get_task_struct(result);
 483         rcu_read_unlock();
 484         return result;
 485 }
 486 EXPORT_SYMBOL_GPL(get_pid_task);
 487
 488 struct pid *find_get_pid(pid_t nr)
 489 {
 490         struct pid *pid;
 491
 492         rcu_read_lock();
 493         pid = get_pid(find_vpid(nr));
 494         rcu_read_unlock();
 495
 496         return pid;
 497 }
 498 EXPORT_SYMBOL_GPL(find_get_pid);
 499
 500 pid_t pid_nr_ns(struct pid *pid, struct pid_namespace *ns)
 501 {
 502         struct upid *upid;
 503         pid_t nr = 0;
 504
 505         if (pid && ns->level <= pid->level) {
 506                 upid = &pid->numbers[ns->level];
 507                 if (upid->ns == ns)
 508                         nr = upid->nr;
 509         }
 510         return nr;
 511 }
 512 EXPORT_SYMBOL_GPL(pid_nr_ns);
 513
 514 pid_t pid_vnr(struct pid *pid)
 515 {
 516         return pid_nr_ns(pid, task_active_pid_ns(current));
 517 }
 518 EXPORT_SYMBOL_GPL(pid_vnr);
 519
 520 pid_t __task_pid_nr_ns(struct task_struct *task, enum pid_type type,
 521                         struct pid_namespace *ns)
 522 {
 523         pid_t nr = 0;
 524
 525         rcu_read_lock();
 526         if (!ns)
 527                 ns = task_active_pid_ns(current);
 528         if (likely(pid_alive(task))) {
 529                 if (type != PIDTYPE_PID)
 530                         task = task->group_leader;
 531                 nr = pid_nr_ns(task->pids[type].pid, ns);
 532         }
 533         rcu_read_unlock();
 534
 535         return nr;
 536 }
 537 EXPORT_SYMBOL(__task_pid_nr_ns);
 538
 539 pid_t task_tgid_nr_ns(struct task_struct *tsk, struct pid_namespace *ns)
 540 {
 541         return pid_nr_ns(task_tgid(tsk), ns);
 542 }
 543 EXPORT_SYMBOL(task_tgid_nr_ns);
 544
 545 struct pid_namespace *task_active_pid_ns(struct task_struct *tsk)
 546 {
 547         return ns_of_pid(task_pid(tsk));
 548 }
 549 EXPORT_SYMBOL_GPL(task_active_pid_ns);
 550
 551 /*
 552  * Used by proc to find the first pid that is greater than or equal to nr.
 553  *
 554  * If there is a pid at nr this function is exactly the same as find_pid_ns.
 555  */
 556 struct pid *find_ge_pid(int nr, struct pid_namespace *ns)
 557 {
 558         struct pid *pid;
 559
 560         do {
 561                 pid = find_pid_ns(nr, ns);
 562                 if (pid)
 563                         break;
 564                 nr = next_pidmap(ns, nr);
 565         } while (nr > 0);
 566
 567         return pid;
 568 }
 569
 570 /*
 571  * The pid hash table is scaled according to the amount of memory in the
 572  * machine.  From a minimum of 16 slots up to 4096 slots at one gigabyte or
 573  * more.
 574  */
 575 void __init pidhash_init(void)
 576 {
 577         unsigned int i, pidhash_size;
 578
 579         pid_hash = alloc_large_system_hash("PID", sizeof(*pid_hash), 0, 18,
 580                                            HASH_EARLY | HASH_SMALL,
 581                                            &pidhash_shift, NULL,
 582                                            0, 4096);
 583         pidhash_size = 1U << pidhash_shift;
 584
 585         for (i = 0; i < pidhash_size; i++)
 586                 INIT_HLIST_HEAD(&pid_hash[i]);
 587 }
 588
 589 void __init pidmap_init(void)
 590 {
 591         /* bump default and minimum pid_max based on number of cpus */
 592         pid_max = min(pid_max_max, max_t(int, pid_max,
 593                                 PIDS_PER_CPU_DEFAULT * num_possible_cpus()));
 594         pid_max_min = max_t(int, pid_max_min,
 595                                 PIDS_PER_CPU_MIN * num_possible_cpus());
 596         pr_info("pid_max: default: %u minimum: %u\n", pid_max, pid_max_min);
 597
 598         init_pid_ns.pidmap[0].page = kzalloc(PAGE_SIZE, GFP_KERNEL);
 599         /* Reserve PID 0. We never call free_pidmap(0) */
 600         set_bit(0, init_pid_ns.pidmap[0].page);
 601         atomic_dec(&init_pid_ns.pidmap[0].nr_free);
 602         init_pid_ns.nr_hashed = 1;
 603
 604         init_pid_ns.pid_cachep = KMEM_CACHE(pid,
 605                         SLAB_HWCACHE_ALIGN | SLAB_PANIC);
 606 }