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