Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Generic pidhash and scalable, time-bounded PID allocator
4 *
5 * (C) 2002-2003 Nadia Yvette Chambers, IBM
6 * (C) 2004 Nadia Yvette Chambers, Oracle
7 * (C) 2002-2004 Ingo Molnar, Red Hat
8 *
9 * pid-structures are backing objects for tasks sharing a given ID to chain
10 * against. There is very little to them aside from hashing them and
11 * parking tasks using given ID's on a list.
12 *
13 * The hash is always changed with the tasklist_lock write-acquired,
14 * and the hash is only accessed with the tasklist_lock at least
15 * read-acquired, so there's no additional SMP locking needed here.
16 *
17 * We have a list of bitmap pages, which bitmaps represent the PID space.
18 * Allocating and freeing PIDs is completely lockless. The worst-case
19 * allocation scenario when all but one out of 1 million PIDs possible are
20 * allocated already: the scanning of 32 list entries and at most PAGE_SIZE
21 * bytes. The typical fastpath is a single successful setbit. Freeing is O(1).
22 *
23 * Pid namespaces:
24 * (C) 2007 Pavel Emelyanov <xemul@openvz.org>, OpenVZ, SWsoft Inc.
25 * (C) 2007 Sukadev Bhattiprolu <sukadev@us.ibm.com>, IBM
26 * Many thanks to Oleg Nesterov for comments and help
27 *
28 */
29
30#include <linux/mm.h>
31#include <linux/export.h>
32#include <linux/slab.h>
33#include <linux/init.h>
34#include <linux/rculist.h>
35#include <linux/memblock.h>
36#include <linux/pid_namespace.h>
37#include <linux/init_task.h>
38#include <linux/syscalls.h>
39#include <linux/proc_ns.h>
40#include <linux/refcount.h>
41#include <linux/anon_inodes.h>
42#include <linux/sched/signal.h>
43#include <linux/sched/task.h>
44#include <linux/idr.h>
45#include <linux/pidfs.h>
46#include <net/sock.h>
47#include <uapi/linux/pidfd.h>
48
49struct pid init_struct_pid = {
50 .count = REFCOUNT_INIT(1),
51 .tasks = {
52 { .first = NULL },
53 { .first = NULL },
54 { .first = NULL },
55 },
56 .level = 0,
57 .numbers = { {
58 .nr = 0,
59 .ns = &init_pid_ns,
60 }, }
61};
62
63int pid_max = PID_MAX_DEFAULT;
64
65int pid_max_min = RESERVED_PIDS + 1;
66int pid_max_max = PID_MAX_LIMIT;
67/*
68 * Pseudo filesystems start inode numbering after one. We use Reserved
69 * PIDs as a natural offset.
70 */
71static u64 pidfs_ino = RESERVED_PIDS;
72
73/*
74 * PID-map pages start out as NULL, they get allocated upon
75 * first use and are never deallocated. This way a low pid_max
76 * value does not cause lots of bitmaps to be allocated, but
77 * the scheme scales to up to 4 million PIDs, runtime.
78 */
79struct pid_namespace init_pid_ns = {
80 .ns.count = REFCOUNT_INIT(2),
81 .idr = IDR_INIT(init_pid_ns.idr),
82 .pid_allocated = PIDNS_ADDING,
83 .level = 0,
84 .child_reaper = &init_task,
85 .user_ns = &init_user_ns,
86 .ns.inum = PROC_PID_INIT_INO,
87#ifdef CONFIG_PID_NS
88 .ns.ops = &pidns_operations,
89#endif
90#if defined(CONFIG_SYSCTL) && defined(CONFIG_MEMFD_CREATE)
91 .memfd_noexec_scope = MEMFD_NOEXEC_SCOPE_EXEC,
92#endif
93};
94EXPORT_SYMBOL_GPL(init_pid_ns);
95
96/*
97 * Note: disable interrupts while the pidmap_lock is held as an
98 * interrupt might come in and do read_lock(&tasklist_lock).
99 *
100 * If we don't disable interrupts there is a nasty deadlock between
101 * detach_pid()->free_pid() and another cpu that does
102 * spin_lock(&pidmap_lock) followed by an interrupt routine that does
103 * read_lock(&tasklist_lock);
104 *
105 * After we clean up the tasklist_lock and know there are no
106 * irq handlers that take it we can leave the interrupts enabled.
107 * For now it is easier to be safe than to prove it can't happen.
108 */
109
110static __cacheline_aligned_in_smp DEFINE_SPINLOCK(pidmap_lock);
111
112void put_pid(struct pid *pid)
113{
114 struct pid_namespace *ns;
115
116 if (!pid)
117 return;
118
119 ns = pid->numbers[pid->level].ns;
120 if (refcount_dec_and_test(&pid->count)) {
121 kmem_cache_free(ns->pid_cachep, pid);
122 put_pid_ns(ns);
123 }
124}
125EXPORT_SYMBOL_GPL(put_pid);
126
127static void delayed_put_pid(struct rcu_head *rhp)
128{
129 struct pid *pid = container_of(rhp, struct pid, rcu);
130 put_pid(pid);
131}
132
133void free_pid(struct pid *pid)
134{
135 /* We can be called with write_lock_irq(&tasklist_lock) held */
136 int i;
137 unsigned long flags;
138
139 spin_lock_irqsave(&pidmap_lock, flags);
140 for (i = 0; i <= pid->level; i++) {
141 struct upid *upid = pid->numbers + i;
142 struct pid_namespace *ns = upid->ns;
143 switch (--ns->pid_allocated) {
144 case 2:
145 case 1:
146 /* When all that is left in the pid namespace
147 * is the reaper wake up the reaper. The reaper
148 * may be sleeping in zap_pid_ns_processes().
149 */
150 wake_up_process(ns->child_reaper);
151 break;
152 case PIDNS_ADDING:
153 /* Handle a fork failure of the first process */
154 WARN_ON(ns->child_reaper);
155 ns->pid_allocated = 0;
156 break;
157 }
158
159 idr_remove(&ns->idr, upid->nr);
160 }
161 spin_unlock_irqrestore(&pidmap_lock, flags);
162
163 call_rcu(&pid->rcu, delayed_put_pid);
164}
165
166struct pid *alloc_pid(struct pid_namespace *ns, pid_t *set_tid,
167 size_t set_tid_size)
168{
169 struct pid *pid;
170 enum pid_type type;
171 int i, nr;
172 struct pid_namespace *tmp;
173 struct upid *upid;
174 int retval = -ENOMEM;
175
176 /*
177 * set_tid_size contains the size of the set_tid array. Starting at
178 * the most nested currently active PID namespace it tells alloc_pid()
179 * which PID to set for a process in that most nested PID namespace
180 * up to set_tid_size PID namespaces. It does not have to set the PID
181 * for a process in all nested PID namespaces but set_tid_size must
182 * never be greater than the current ns->level + 1.
183 */
184 if (set_tid_size > ns->level + 1)
185 return ERR_PTR(-EINVAL);
186
187 pid = kmem_cache_alloc(ns->pid_cachep, GFP_KERNEL);
188 if (!pid)
189 return ERR_PTR(retval);
190
191 tmp = ns;
192 pid->level = ns->level;
193
194 for (i = ns->level; i >= 0; i--) {
195 int tid = 0;
196
197 if (set_tid_size) {
198 tid = set_tid[ns->level - i];
199
200 retval = -EINVAL;
201 if (tid < 1 || tid >= pid_max)
202 goto out_free;
203 /*
204 * Also fail if a PID != 1 is requested and
205 * no PID 1 exists.
206 */
207 if (tid != 1 && !tmp->child_reaper)
208 goto out_free;
209 retval = -EPERM;
210 if (!checkpoint_restore_ns_capable(tmp->user_ns))
211 goto out_free;
212 set_tid_size--;
213 }
214
215 idr_preload(GFP_KERNEL);
216 spin_lock_irq(&pidmap_lock);
217
218 if (tid) {
219 nr = idr_alloc(&tmp->idr, NULL, tid,
220 tid + 1, GFP_ATOMIC);
221 /*
222 * If ENOSPC is returned it means that the PID is
223 * alreay in use. Return EEXIST in that case.
224 */
225 if (nr == -ENOSPC)
226 nr = -EEXIST;
227 } else {
228 int pid_min = 1;
229 /*
230 * init really needs pid 1, but after reaching the
231 * maximum wrap back to RESERVED_PIDS
232 */
233 if (idr_get_cursor(&tmp->idr) > RESERVED_PIDS)
234 pid_min = RESERVED_PIDS;
235
236 /*
237 * Store a null pointer so find_pid_ns does not find
238 * a partially initialized PID (see below).
239 */
240 nr = idr_alloc_cyclic(&tmp->idr, NULL, pid_min,
241 pid_max, GFP_ATOMIC);
242 }
243 spin_unlock_irq(&pidmap_lock);
244 idr_preload_end();
245
246 if (nr < 0) {
247 retval = (nr == -ENOSPC) ? -EAGAIN : nr;
248 goto out_free;
249 }
250
251 pid->numbers[i].nr = nr;
252 pid->numbers[i].ns = tmp;
253 tmp = tmp->parent;
254 }
255
256 /*
257 * ENOMEM is not the most obvious choice especially for the case
258 * where the child subreaper has already exited and the pid
259 * namespace denies the creation of any new processes. But ENOMEM
260 * is what we have exposed to userspace for a long time and it is
261 * documented behavior for pid namespaces. So we can't easily
262 * change it even if there were an error code better suited.
263 */
264 retval = -ENOMEM;
265
266 get_pid_ns(ns);
267 refcount_set(&pid->count, 1);
268 spin_lock_init(&pid->lock);
269 for (type = 0; type < PIDTYPE_MAX; ++type)
270 INIT_HLIST_HEAD(&pid->tasks[type]);
271
272 init_waitqueue_head(&pid->wait_pidfd);
273 INIT_HLIST_HEAD(&pid->inodes);
274
275 upid = pid->numbers + ns->level;
276 spin_lock_irq(&pidmap_lock);
277 if (!(ns->pid_allocated & PIDNS_ADDING))
278 goto out_unlock;
279 pid->stashed = NULL;
280 pid->ino = ++pidfs_ino;
281 for ( ; upid >= pid->numbers; --upid) {
282 /* Make the PID visible to find_pid_ns. */
283 idr_replace(&upid->ns->idr, pid, upid->nr);
284 upid->ns->pid_allocated++;
285 }
286 spin_unlock_irq(&pidmap_lock);
287
288 return pid;
289
290out_unlock:
291 spin_unlock_irq(&pidmap_lock);
292 put_pid_ns(ns);
293
294out_free:
295 spin_lock_irq(&pidmap_lock);
296 while (++i <= ns->level) {
297 upid = pid->numbers + i;
298 idr_remove(&upid->ns->idr, upid->nr);
299 }
300
301 /* On failure to allocate the first pid, reset the state */
302 if (ns->pid_allocated == PIDNS_ADDING)
303 idr_set_cursor(&ns->idr, 0);
304
305 spin_unlock_irq(&pidmap_lock);
306
307 kmem_cache_free(ns->pid_cachep, pid);
308 return ERR_PTR(retval);
309}
310
311void disable_pid_allocation(struct pid_namespace *ns)
312{
313 spin_lock_irq(&pidmap_lock);
314 ns->pid_allocated &= ~PIDNS_ADDING;
315 spin_unlock_irq(&pidmap_lock);
316}
317
318struct pid *find_pid_ns(int nr, struct pid_namespace *ns)
319{
320 return idr_find(&ns->idr, nr);
321}
322EXPORT_SYMBOL_GPL(find_pid_ns);
323
324struct pid *find_vpid(int nr)
325{
326 return find_pid_ns(nr, task_active_pid_ns(current));
327}
328EXPORT_SYMBOL_GPL(find_vpid);
329
330static struct pid **task_pid_ptr(struct task_struct *task, enum pid_type type)
331{
332 return (type == PIDTYPE_PID) ?
333 &task->thread_pid :
334 &task->signal->pids[type];
335}
336
337/*
338 * attach_pid() must be called with the tasklist_lock write-held.
339 */
340void attach_pid(struct task_struct *task, enum pid_type type)
341{
342 struct pid *pid = *task_pid_ptr(task, type);
343 hlist_add_head_rcu(&task->pid_links[type], &pid->tasks[type]);
344}
345
346static void __change_pid(struct task_struct *task, enum pid_type type,
347 struct pid *new)
348{
349 struct pid **pid_ptr = task_pid_ptr(task, type);
350 struct pid *pid;
351 int tmp;
352
353 pid = *pid_ptr;
354
355 hlist_del_rcu(&task->pid_links[type]);
356 *pid_ptr = new;
357
358 if (type == PIDTYPE_PID) {
359 WARN_ON_ONCE(pid_has_task(pid, PIDTYPE_PID));
360 wake_up_all(&pid->wait_pidfd);
361 }
362
363 for (tmp = PIDTYPE_MAX; --tmp >= 0; )
364 if (pid_has_task(pid, tmp))
365 return;
366
367 free_pid(pid);
368}
369
370void detach_pid(struct task_struct *task, enum pid_type type)
371{
372 __change_pid(task, type, NULL);
373}
374
375void change_pid(struct task_struct *task, enum pid_type type,
376 struct pid *pid)
377{
378 __change_pid(task, type, pid);
379 attach_pid(task, type);
380}
381
382void exchange_tids(struct task_struct *left, struct task_struct *right)
383{
384 struct pid *pid1 = left->thread_pid;
385 struct pid *pid2 = right->thread_pid;
386 struct hlist_head *head1 = &pid1->tasks[PIDTYPE_PID];
387 struct hlist_head *head2 = &pid2->tasks[PIDTYPE_PID];
388
389 /* Swap the single entry tid lists */
390 hlists_swap_heads_rcu(head1, head2);
391
392 /* Swap the per task_struct pid */
393 rcu_assign_pointer(left->thread_pid, pid2);
394 rcu_assign_pointer(right->thread_pid, pid1);
395
396 /* Swap the cached value */
397 WRITE_ONCE(left->pid, pid_nr(pid2));
398 WRITE_ONCE(right->pid, pid_nr(pid1));
399}
400
401/* transfer_pid is an optimization of attach_pid(new), detach_pid(old) */
402void transfer_pid(struct task_struct *old, struct task_struct *new,
403 enum pid_type type)
404{
405 WARN_ON_ONCE(type == PIDTYPE_PID);
406 hlist_replace_rcu(&old->pid_links[type], &new->pid_links[type]);
407}
408
409struct 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, pid_links[(type)]);
418 }
419 return result;
420}
421EXPORT_SYMBOL(pid_task);
422
423/*
424 * Must be called under rcu_read_lock().
425 */
426struct task_struct *find_task_by_pid_ns(pid_t nr, struct pid_namespace *ns)
427{
428 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
429 "find_task_by_pid_ns() needs rcu_read_lock() protection");
430 return pid_task(find_pid_ns(nr, ns), PIDTYPE_PID);
431}
432
433struct task_struct *find_task_by_vpid(pid_t vnr)
434{
435 return find_task_by_pid_ns(vnr, task_active_pid_ns(current));
436}
437
438struct task_struct *find_get_task_by_vpid(pid_t nr)
439{
440 struct task_struct *task;
441
442 rcu_read_lock();
443 task = find_task_by_vpid(nr);
444 if (task)
445 get_task_struct(task);
446 rcu_read_unlock();
447
448 return task;
449}
450
451struct pid *get_task_pid(struct task_struct *task, enum pid_type type)
452{
453 struct pid *pid;
454 rcu_read_lock();
455 pid = get_pid(rcu_dereference(*task_pid_ptr(task, type)));
456 rcu_read_unlock();
457 return pid;
458}
459EXPORT_SYMBOL_GPL(get_task_pid);
460
461struct task_struct *get_pid_task(struct pid *pid, enum pid_type type)
462{
463 struct task_struct *result;
464 rcu_read_lock();
465 result = pid_task(pid, type);
466 if (result)
467 get_task_struct(result);
468 rcu_read_unlock();
469 return result;
470}
471EXPORT_SYMBOL_GPL(get_pid_task);
472
473struct pid *find_get_pid(pid_t nr)
474{
475 struct pid *pid;
476
477 rcu_read_lock();
478 pid = get_pid(find_vpid(nr));
479 rcu_read_unlock();
480
481 return pid;
482}
483EXPORT_SYMBOL_GPL(find_get_pid);
484
485pid_t pid_nr_ns(struct pid *pid, struct pid_namespace *ns)
486{
487 struct upid *upid;
488 pid_t nr = 0;
489
490 if (pid && ns->level <= pid->level) {
491 upid = &pid->numbers[ns->level];
492 if (upid->ns == ns)
493 nr = upid->nr;
494 }
495 return nr;
496}
497EXPORT_SYMBOL_GPL(pid_nr_ns);
498
499pid_t pid_vnr(struct pid *pid)
500{
501 return pid_nr_ns(pid, task_active_pid_ns(current));
502}
503EXPORT_SYMBOL_GPL(pid_vnr);
504
505pid_t __task_pid_nr_ns(struct task_struct *task, enum pid_type type,
506 struct pid_namespace *ns)
507{
508 pid_t nr = 0;
509
510 rcu_read_lock();
511 if (!ns)
512 ns = task_active_pid_ns(current);
513 nr = pid_nr_ns(rcu_dereference(*task_pid_ptr(task, type)), ns);
514 rcu_read_unlock();
515
516 return nr;
517}
518EXPORT_SYMBOL(__task_pid_nr_ns);
519
520struct pid_namespace *task_active_pid_ns(struct task_struct *tsk)
521{
522 return ns_of_pid(task_pid(tsk));
523}
524EXPORT_SYMBOL_GPL(task_active_pid_ns);
525
526/*
527 * Used by proc to find the first pid that is greater than or equal to nr.
528 *
529 * If there is a pid at nr this function is exactly the same as find_pid_ns.
530 */
531struct pid *find_ge_pid(int nr, struct pid_namespace *ns)
532{
533 return idr_get_next(&ns->idr, &nr);
534}
535EXPORT_SYMBOL_GPL(find_ge_pid);
536
537struct pid *pidfd_get_pid(unsigned int fd, unsigned int *flags)
538{
539 CLASS(fd, f)(fd);
540 struct pid *pid;
541
542 if (fd_empty(f))
543 return ERR_PTR(-EBADF);
544
545 pid = pidfd_pid(fd_file(f));
546 if (!IS_ERR(pid)) {
547 get_pid(pid);
548 *flags = fd_file(f)->f_flags;
549 }
550 return pid;
551}
552
553/**
554 * pidfd_get_task() - Get the task associated with a pidfd
555 *
556 * @pidfd: pidfd for which to get the task
557 * @flags: flags associated with this pidfd
558 *
559 * Return the task associated with @pidfd. The function takes a reference on
560 * the returned task. The caller is responsible for releasing that reference.
561 *
562 * Return: On success, the task_struct associated with the pidfd.
563 * On error, a negative errno number will be returned.
564 */
565struct task_struct *pidfd_get_task(int pidfd, unsigned int *flags)
566{
567 unsigned int f_flags;
568 struct pid *pid;
569 struct task_struct *task;
570
571 pid = pidfd_get_pid(pidfd, &f_flags);
572 if (IS_ERR(pid))
573 return ERR_CAST(pid);
574
575 task = get_pid_task(pid, PIDTYPE_TGID);
576 put_pid(pid);
577 if (!task)
578 return ERR_PTR(-ESRCH);
579
580 *flags = f_flags;
581 return task;
582}
583
584/**
585 * pidfd_create() - Create a new pid file descriptor.
586 *
587 * @pid: struct pid that the pidfd will reference
588 * @flags: flags to pass
589 *
590 * This creates a new pid file descriptor with the O_CLOEXEC flag set.
591 *
592 * Note, that this function can only be called after the fd table has
593 * been unshared to avoid leaking the pidfd to the new process.
594 *
595 * This symbol should not be explicitly exported to loadable modules.
596 *
597 * Return: On success, a cloexec pidfd is returned.
598 * On error, a negative errno number will be returned.
599 */
600static int pidfd_create(struct pid *pid, unsigned int flags)
601{
602 int pidfd;
603 struct file *pidfd_file;
604
605 pidfd = pidfd_prepare(pid, flags, &pidfd_file);
606 if (pidfd < 0)
607 return pidfd;
608
609 fd_install(pidfd, pidfd_file);
610 return pidfd;
611}
612
613/**
614 * sys_pidfd_open() - Open new pid file descriptor.
615 *
616 * @pid: pid for which to retrieve a pidfd
617 * @flags: flags to pass
618 *
619 * This creates a new pid file descriptor with the O_CLOEXEC flag set for
620 * the task identified by @pid. Without PIDFD_THREAD flag the target task
621 * must be a thread-group leader.
622 *
623 * Return: On success, a cloexec pidfd is returned.
624 * On error, a negative errno number will be returned.
625 */
626SYSCALL_DEFINE2(pidfd_open, pid_t, pid, unsigned int, flags)
627{
628 int fd;
629 struct pid *p;
630
631 if (flags & ~(PIDFD_NONBLOCK | PIDFD_THREAD))
632 return -EINVAL;
633
634 if (pid <= 0)
635 return -EINVAL;
636
637 p = find_get_pid(pid);
638 if (!p)
639 return -ESRCH;
640
641 fd = pidfd_create(p, flags);
642
643 put_pid(p);
644 return fd;
645}
646
647void __init pid_idr_init(void)
648{
649 /* Verify no one has done anything silly: */
650 BUILD_BUG_ON(PID_MAX_LIMIT >= PIDNS_ADDING);
651
652 /* bump default and minimum pid_max based on number of cpus */
653 pid_max = min(pid_max_max, max_t(int, pid_max,
654 PIDS_PER_CPU_DEFAULT * num_possible_cpus()));
655 pid_max_min = max_t(int, pid_max_min,
656 PIDS_PER_CPU_MIN * num_possible_cpus());
657 pr_info("pid_max: default: %u minimum: %u\n", pid_max, pid_max_min);
658
659 idr_init(&init_pid_ns.idr);
660
661 init_pid_ns.pid_cachep = kmem_cache_create("pid",
662 struct_size_t(struct pid, numbers, 1),
663 __alignof__(struct pid),
664 SLAB_HWCACHE_ALIGN | SLAB_PANIC | SLAB_ACCOUNT,
665 NULL);
666}
667
668static struct file *__pidfd_fget(struct task_struct *task, int fd)
669{
670 struct file *file;
671 int ret;
672
673 ret = down_read_killable(&task->signal->exec_update_lock);
674 if (ret)
675 return ERR_PTR(ret);
676
677 if (ptrace_may_access(task, PTRACE_MODE_ATTACH_REALCREDS))
678 file = fget_task(task, fd);
679 else
680 file = ERR_PTR(-EPERM);
681
682 up_read(&task->signal->exec_update_lock);
683
684 if (!file) {
685 /*
686 * It is possible that the target thread is exiting; it can be
687 * either:
688 * 1. before exit_signals(), which gives a real fd
689 * 2. before exit_files() takes the task_lock() gives a real fd
690 * 3. after exit_files() releases task_lock(), ->files is NULL;
691 * this has PF_EXITING, since it was set in exit_signals(),
692 * __pidfd_fget() returns EBADF.
693 * In case 3 we get EBADF, but that really means ESRCH, since
694 * the task is currently exiting and has freed its files
695 * struct, so we fix it up.
696 */
697 if (task->flags & PF_EXITING)
698 file = ERR_PTR(-ESRCH);
699 else
700 file = ERR_PTR(-EBADF);
701 }
702
703 return file;
704}
705
706static int pidfd_getfd(struct pid *pid, int fd)
707{
708 struct task_struct *task;
709 struct file *file;
710 int ret;
711
712 task = get_pid_task(pid, PIDTYPE_PID);
713 if (!task)
714 return -ESRCH;
715
716 file = __pidfd_fget(task, fd);
717 put_task_struct(task);
718 if (IS_ERR(file))
719 return PTR_ERR(file);
720
721 ret = receive_fd(file, NULL, O_CLOEXEC);
722 fput(file);
723
724 return ret;
725}
726
727/**
728 * sys_pidfd_getfd() - Get a file descriptor from another process
729 *
730 * @pidfd: the pidfd file descriptor of the process
731 * @fd: the file descriptor number to get
732 * @flags: flags on how to get the fd (reserved)
733 *
734 * This syscall gets a copy of a file descriptor from another process
735 * based on the pidfd, and file descriptor number. It requires that
736 * the calling process has the ability to ptrace the process represented
737 * by the pidfd. The process which is having its file descriptor copied
738 * is otherwise unaffected.
739 *
740 * Return: On success, a cloexec file descriptor is returned.
741 * On error, a negative errno number will be returned.
742 */
743SYSCALL_DEFINE3(pidfd_getfd, int, pidfd, int, fd,
744 unsigned int, flags)
745{
746 struct pid *pid;
747
748 /* flags is currently unused - make sure it's unset */
749 if (flags)
750 return -EINVAL;
751
752 CLASS(fd, f)(pidfd);
753 if (fd_empty(f))
754 return -EBADF;
755
756 pid = pidfd_pid(fd_file(f));
757 if (IS_ERR(pid))
758 return PTR_ERR(pid);
759
760 return pidfd_getfd(pid, fd);
761}
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Generic pidhash and scalable, time-bounded PID allocator
4 *
5 * (C) 2002-2003 Nadia Yvette Chambers, IBM
6 * (C) 2004 Nadia Yvette Chambers, Oracle
7 * (C) 2002-2004 Ingo Molnar, Red Hat
8 *
9 * pid-structures are backing objects for tasks sharing a given ID to chain
10 * against. There is very little to them aside from hashing them and
11 * parking tasks using given ID's on a list.
12 *
13 * The hash is always changed with the tasklist_lock write-acquired,
14 * and the hash is only accessed with the tasklist_lock at least
15 * read-acquired, so there's no additional SMP locking needed here.
16 *
17 * We have a list of bitmap pages, which bitmaps represent the PID space.
18 * Allocating and freeing PIDs is completely lockless. The worst-case
19 * allocation scenario when all but one out of 1 million PIDs possible are
20 * allocated already: the scanning of 32 list entries and at most PAGE_SIZE
21 * bytes. The typical fastpath is a single successful setbit. Freeing is O(1).
22 *
23 * Pid namespaces:
24 * (C) 2007 Pavel Emelyanov <xemul@openvz.org>, OpenVZ, SWsoft Inc.
25 * (C) 2007 Sukadev Bhattiprolu <sukadev@us.ibm.com>, IBM
26 * Many thanks to Oleg Nesterov for comments and help
27 *
28 */
29
30#include <linux/mm.h>
31#include <linux/export.h>
32#include <linux/slab.h>
33#include <linux/init.h>
34#include <linux/rculist.h>
35#include <linux/memblock.h>
36#include <linux/pid_namespace.h>
37#include <linux/init_task.h>
38#include <linux/syscalls.h>
39#include <linux/proc_ns.h>
40#include <linux/refcount.h>
41#include <linux/anon_inodes.h>
42#include <linux/sched/signal.h>
43#include <linux/sched/task.h>
44#include <linux/idr.h>
45#include <net/sock.h>
46
47struct pid init_struct_pid = {
48 .count = REFCOUNT_INIT(1),
49 .tasks = {
50 { .first = NULL },
51 { .first = NULL },
52 { .first = NULL },
53 },
54 .level = 0,
55 .numbers = { {
56 .nr = 0,
57 .ns = &init_pid_ns,
58 }, }
59};
60
61int pid_max = PID_MAX_DEFAULT;
62
63#define RESERVED_PIDS 300
64
65int pid_max_min = RESERVED_PIDS + 1;
66int pid_max_max = PID_MAX_LIMIT;
67
68/*
69 * PID-map pages start out as NULL, they get allocated upon
70 * first use and are never deallocated. This way a low pid_max
71 * value does not cause lots of bitmaps to be allocated, but
72 * the scheme scales to up to 4 million PIDs, runtime.
73 */
74struct pid_namespace init_pid_ns = {
75 .kref = KREF_INIT(2),
76 .idr = IDR_INIT(init_pid_ns.idr),
77 .pid_allocated = PIDNS_ADDING,
78 .level = 0,
79 .child_reaper = &init_task,
80 .user_ns = &init_user_ns,
81 .ns.inum = PROC_PID_INIT_INO,
82#ifdef CONFIG_PID_NS
83 .ns.ops = &pidns_operations,
84#endif
85};
86EXPORT_SYMBOL_GPL(init_pid_ns);
87
88/*
89 * Note: disable interrupts while the pidmap_lock is held as an
90 * interrupt might come in and do read_lock(&tasklist_lock).
91 *
92 * If we don't disable interrupts there is a nasty deadlock between
93 * detach_pid()->free_pid() and another cpu that does
94 * spin_lock(&pidmap_lock) followed by an interrupt routine that does
95 * read_lock(&tasklist_lock);
96 *
97 * After we clean up the tasklist_lock and know there are no
98 * irq handlers that take it we can leave the interrupts enabled.
99 * For now it is easier to be safe than to prove it can't happen.
100 */
101
102static __cacheline_aligned_in_smp DEFINE_SPINLOCK(pidmap_lock);
103
104void put_pid(struct pid *pid)
105{
106 struct pid_namespace *ns;
107
108 if (!pid)
109 return;
110
111 ns = pid->numbers[pid->level].ns;
112 if (refcount_dec_and_test(&pid->count)) {
113 kmem_cache_free(ns->pid_cachep, pid);
114 put_pid_ns(ns);
115 }
116}
117EXPORT_SYMBOL_GPL(put_pid);
118
119static void delayed_put_pid(struct rcu_head *rhp)
120{
121 struct pid *pid = container_of(rhp, struct pid, rcu);
122 put_pid(pid);
123}
124
125void free_pid(struct pid *pid)
126{
127 /* We can be called with write_lock_irq(&tasklist_lock) held */
128 int i;
129 unsigned long flags;
130
131 spin_lock_irqsave(&pidmap_lock, flags);
132 for (i = 0; i <= pid->level; i++) {
133 struct upid *upid = pid->numbers + i;
134 struct pid_namespace *ns = upid->ns;
135 switch (--ns->pid_allocated) {
136 case 2:
137 case 1:
138 /* When all that is left in the pid namespace
139 * is the reaper wake up the reaper. The reaper
140 * may be sleeping in zap_pid_ns_processes().
141 */
142 wake_up_process(ns->child_reaper);
143 break;
144 case PIDNS_ADDING:
145 /* Handle a fork failure of the first process */
146 WARN_ON(ns->child_reaper);
147 ns->pid_allocated = 0;
148 break;
149 }
150
151 idr_remove(&ns->idr, upid->nr);
152 }
153 spin_unlock_irqrestore(&pidmap_lock, flags);
154
155 call_rcu(&pid->rcu, delayed_put_pid);
156}
157
158struct pid *alloc_pid(struct pid_namespace *ns, pid_t *set_tid,
159 size_t set_tid_size)
160{
161 struct pid *pid;
162 enum pid_type type;
163 int i, nr;
164 struct pid_namespace *tmp;
165 struct upid *upid;
166 int retval = -ENOMEM;
167
168 /*
169 * set_tid_size contains the size of the set_tid array. Starting at
170 * the most nested currently active PID namespace it tells alloc_pid()
171 * which PID to set for a process in that most nested PID namespace
172 * up to set_tid_size PID namespaces. It does not have to set the PID
173 * for a process in all nested PID namespaces but set_tid_size must
174 * never be greater than the current ns->level + 1.
175 */
176 if (set_tid_size > ns->level + 1)
177 return ERR_PTR(-EINVAL);
178
179 pid = kmem_cache_alloc(ns->pid_cachep, GFP_KERNEL);
180 if (!pid)
181 return ERR_PTR(retval);
182
183 tmp = ns;
184 pid->level = ns->level;
185
186 for (i = ns->level; i >= 0; i--) {
187 int tid = 0;
188
189 if (set_tid_size) {
190 tid = set_tid[ns->level - i];
191
192 retval = -EINVAL;
193 if (tid < 1 || tid >= pid_max)
194 goto out_free;
195 /*
196 * Also fail if a PID != 1 is requested and
197 * no PID 1 exists.
198 */
199 if (tid != 1 && !tmp->child_reaper)
200 goto out_free;
201 retval = -EPERM;
202 if (!checkpoint_restore_ns_capable(tmp->user_ns))
203 goto out_free;
204 set_tid_size--;
205 }
206
207 idr_preload(GFP_KERNEL);
208 spin_lock_irq(&pidmap_lock);
209
210 if (tid) {
211 nr = idr_alloc(&tmp->idr, NULL, tid,
212 tid + 1, GFP_ATOMIC);
213 /*
214 * If ENOSPC is returned it means that the PID is
215 * alreay in use. Return EEXIST in that case.
216 */
217 if (nr == -ENOSPC)
218 nr = -EEXIST;
219 } else {
220 int pid_min = 1;
221 /*
222 * init really needs pid 1, but after reaching the
223 * maximum wrap back to RESERVED_PIDS
224 */
225 if (idr_get_cursor(&tmp->idr) > RESERVED_PIDS)
226 pid_min = RESERVED_PIDS;
227
228 /*
229 * Store a null pointer so find_pid_ns does not find
230 * a partially initialized PID (see below).
231 */
232 nr = idr_alloc_cyclic(&tmp->idr, NULL, pid_min,
233 pid_max, GFP_ATOMIC);
234 }
235 spin_unlock_irq(&pidmap_lock);
236 idr_preload_end();
237
238 if (nr < 0) {
239 retval = (nr == -ENOSPC) ? -EAGAIN : nr;
240 goto out_free;
241 }
242
243 pid->numbers[i].nr = nr;
244 pid->numbers[i].ns = tmp;
245 tmp = tmp->parent;
246 }
247
248 /*
249 * ENOMEM is not the most obvious choice especially for the case
250 * where the child subreaper has already exited and the pid
251 * namespace denies the creation of any new processes. But ENOMEM
252 * is what we have exposed to userspace for a long time and it is
253 * documented behavior for pid namespaces. So we can't easily
254 * change it even if there were an error code better suited.
255 */
256 retval = -ENOMEM;
257
258 get_pid_ns(ns);
259 refcount_set(&pid->count, 1);
260 spin_lock_init(&pid->lock);
261 for (type = 0; type < PIDTYPE_MAX; ++type)
262 INIT_HLIST_HEAD(&pid->tasks[type]);
263
264 init_waitqueue_head(&pid->wait_pidfd);
265 INIT_HLIST_HEAD(&pid->inodes);
266
267 upid = pid->numbers + ns->level;
268 spin_lock_irq(&pidmap_lock);
269 if (!(ns->pid_allocated & PIDNS_ADDING))
270 goto out_unlock;
271 for ( ; upid >= pid->numbers; --upid) {
272 /* Make the PID visible to find_pid_ns. */
273 idr_replace(&upid->ns->idr, pid, upid->nr);
274 upid->ns->pid_allocated++;
275 }
276 spin_unlock_irq(&pidmap_lock);
277
278 return pid;
279
280out_unlock:
281 spin_unlock_irq(&pidmap_lock);
282 put_pid_ns(ns);
283
284out_free:
285 spin_lock_irq(&pidmap_lock);
286 while (++i <= ns->level) {
287 upid = pid->numbers + i;
288 idr_remove(&upid->ns->idr, upid->nr);
289 }
290
291 /* On failure to allocate the first pid, reset the state */
292 if (ns->pid_allocated == PIDNS_ADDING)
293 idr_set_cursor(&ns->idr, 0);
294
295 spin_unlock_irq(&pidmap_lock);
296
297 kmem_cache_free(ns->pid_cachep, pid);
298 return ERR_PTR(retval);
299}
300
301void disable_pid_allocation(struct pid_namespace *ns)
302{
303 spin_lock_irq(&pidmap_lock);
304 ns->pid_allocated &= ~PIDNS_ADDING;
305 spin_unlock_irq(&pidmap_lock);
306}
307
308struct pid *find_pid_ns(int nr, struct pid_namespace *ns)
309{
310 return idr_find(&ns->idr, nr);
311}
312EXPORT_SYMBOL_GPL(find_pid_ns);
313
314struct pid *find_vpid(int nr)
315{
316 return find_pid_ns(nr, task_active_pid_ns(current));
317}
318EXPORT_SYMBOL_GPL(find_vpid);
319
320static struct pid **task_pid_ptr(struct task_struct *task, enum pid_type type)
321{
322 return (type == PIDTYPE_PID) ?
323 &task->thread_pid :
324 &task->signal->pids[type];
325}
326
327/*
328 * attach_pid() must be called with the tasklist_lock write-held.
329 */
330void attach_pid(struct task_struct *task, enum pid_type type)
331{
332 struct pid *pid = *task_pid_ptr(task, type);
333 hlist_add_head_rcu(&task->pid_links[type], &pid->tasks[type]);
334}
335
336static void __change_pid(struct task_struct *task, enum pid_type type,
337 struct pid *new)
338{
339 struct pid **pid_ptr = task_pid_ptr(task, type);
340 struct pid *pid;
341 int tmp;
342
343 pid = *pid_ptr;
344
345 hlist_del_rcu(&task->pid_links[type]);
346 *pid_ptr = new;
347
348 for (tmp = PIDTYPE_MAX; --tmp >= 0; )
349 if (pid_has_task(pid, tmp))
350 return;
351
352 free_pid(pid);
353}
354
355void detach_pid(struct task_struct *task, enum pid_type type)
356{
357 __change_pid(task, type, NULL);
358}
359
360void change_pid(struct task_struct *task, enum pid_type type,
361 struct pid *pid)
362{
363 __change_pid(task, type, pid);
364 attach_pid(task, type);
365}
366
367void exchange_tids(struct task_struct *left, struct task_struct *right)
368{
369 struct pid *pid1 = left->thread_pid;
370 struct pid *pid2 = right->thread_pid;
371 struct hlist_head *head1 = &pid1->tasks[PIDTYPE_PID];
372 struct hlist_head *head2 = &pid2->tasks[PIDTYPE_PID];
373
374 /* Swap the single entry tid lists */
375 hlists_swap_heads_rcu(head1, head2);
376
377 /* Swap the per task_struct pid */
378 rcu_assign_pointer(left->thread_pid, pid2);
379 rcu_assign_pointer(right->thread_pid, pid1);
380
381 /* Swap the cached value */
382 WRITE_ONCE(left->pid, pid_nr(pid2));
383 WRITE_ONCE(right->pid, pid_nr(pid1));
384}
385
386/* transfer_pid is an optimization of attach_pid(new), detach_pid(old) */
387void transfer_pid(struct task_struct *old, struct task_struct *new,
388 enum pid_type type)
389{
390 if (type == PIDTYPE_PID)
391 new->thread_pid = old->thread_pid;
392 hlist_replace_rcu(&old->pid_links[type], &new->pid_links[type]);
393}
394
395struct task_struct *pid_task(struct pid *pid, enum pid_type type)
396{
397 struct task_struct *result = NULL;
398 if (pid) {
399 struct hlist_node *first;
400 first = rcu_dereference_check(hlist_first_rcu(&pid->tasks[type]),
401 lockdep_tasklist_lock_is_held());
402 if (first)
403 result = hlist_entry(first, struct task_struct, pid_links[(type)]);
404 }
405 return result;
406}
407EXPORT_SYMBOL(pid_task);
408
409/*
410 * Must be called under rcu_read_lock().
411 */
412struct task_struct *find_task_by_pid_ns(pid_t nr, struct pid_namespace *ns)
413{
414 RCU_LOCKDEP_WARN(!rcu_read_lock_held(),
415 "find_task_by_pid_ns() needs rcu_read_lock() protection");
416 return pid_task(find_pid_ns(nr, ns), PIDTYPE_PID);
417}
418
419struct task_struct *find_task_by_vpid(pid_t vnr)
420{
421 return find_task_by_pid_ns(vnr, task_active_pid_ns(current));
422}
423
424struct task_struct *find_get_task_by_vpid(pid_t nr)
425{
426 struct task_struct *task;
427
428 rcu_read_lock();
429 task = find_task_by_vpid(nr);
430 if (task)
431 get_task_struct(task);
432 rcu_read_unlock();
433
434 return task;
435}
436
437struct pid *get_task_pid(struct task_struct *task, enum pid_type type)
438{
439 struct pid *pid;
440 rcu_read_lock();
441 pid = get_pid(rcu_dereference(*task_pid_ptr(task, type)));
442 rcu_read_unlock();
443 return pid;
444}
445EXPORT_SYMBOL_GPL(get_task_pid);
446
447struct task_struct *get_pid_task(struct pid *pid, enum pid_type type)
448{
449 struct task_struct *result;
450 rcu_read_lock();
451 result = pid_task(pid, type);
452 if (result)
453 get_task_struct(result);
454 rcu_read_unlock();
455 return result;
456}
457EXPORT_SYMBOL_GPL(get_pid_task);
458
459struct pid *find_get_pid(pid_t nr)
460{
461 struct pid *pid;
462
463 rcu_read_lock();
464 pid = get_pid(find_vpid(nr));
465 rcu_read_unlock();
466
467 return pid;
468}
469EXPORT_SYMBOL_GPL(find_get_pid);
470
471pid_t pid_nr_ns(struct pid *pid, struct pid_namespace *ns)
472{
473 struct upid *upid;
474 pid_t nr = 0;
475
476 if (pid && ns->level <= pid->level) {
477 upid = &pid->numbers[ns->level];
478 if (upid->ns == ns)
479 nr = upid->nr;
480 }
481 return nr;
482}
483EXPORT_SYMBOL_GPL(pid_nr_ns);
484
485pid_t pid_vnr(struct pid *pid)
486{
487 return pid_nr_ns(pid, task_active_pid_ns(current));
488}
489EXPORT_SYMBOL_GPL(pid_vnr);
490
491pid_t __task_pid_nr_ns(struct task_struct *task, enum pid_type type,
492 struct pid_namespace *ns)
493{
494 pid_t nr = 0;
495
496 rcu_read_lock();
497 if (!ns)
498 ns = task_active_pid_ns(current);
499 nr = pid_nr_ns(rcu_dereference(*task_pid_ptr(task, type)), ns);
500 rcu_read_unlock();
501
502 return nr;
503}
504EXPORT_SYMBOL(__task_pid_nr_ns);
505
506struct pid_namespace *task_active_pid_ns(struct task_struct *tsk)
507{
508 return ns_of_pid(task_pid(tsk));
509}
510EXPORT_SYMBOL_GPL(task_active_pid_ns);
511
512/*
513 * Used by proc to find the first pid that is greater than or equal to nr.
514 *
515 * If there is a pid at nr this function is exactly the same as find_pid_ns.
516 */
517struct pid *find_ge_pid(int nr, struct pid_namespace *ns)
518{
519 return idr_get_next(&ns->idr, &nr);
520}
521
522/**
523 * pidfd_create() - Create a new pid file descriptor.
524 *
525 * @pid: struct pid that the pidfd will reference
526 *
527 * This creates a new pid file descriptor with the O_CLOEXEC flag set.
528 *
529 * Note, that this function can only be called after the fd table has
530 * been unshared to avoid leaking the pidfd to the new process.
531 *
532 * Return: On success, a cloexec pidfd is returned.
533 * On error, a negative errno number will be returned.
534 */
535static int pidfd_create(struct pid *pid)
536{
537 int fd;
538
539 fd = anon_inode_getfd("[pidfd]", &pidfd_fops, get_pid(pid),
540 O_RDWR | O_CLOEXEC);
541 if (fd < 0)
542 put_pid(pid);
543
544 return fd;
545}
546
547/**
548 * pidfd_open() - Open new pid file descriptor.
549 *
550 * @pid: pid for which to retrieve a pidfd
551 * @flags: flags to pass
552 *
553 * This creates a new pid file descriptor with the O_CLOEXEC flag set for
554 * the process identified by @pid. Currently, the process identified by
555 * @pid must be a thread-group leader. This restriction currently exists
556 * for all aspects of pidfds including pidfd creation (CLONE_PIDFD cannot
557 * be used with CLONE_THREAD) and pidfd polling (only supports thread group
558 * leaders).
559 *
560 * Return: On success, a cloexec pidfd is returned.
561 * On error, a negative errno number will be returned.
562 */
563SYSCALL_DEFINE2(pidfd_open, pid_t, pid, unsigned int, flags)
564{
565 int fd;
566 struct pid *p;
567
568 if (flags)
569 return -EINVAL;
570
571 if (pid <= 0)
572 return -EINVAL;
573
574 p = find_get_pid(pid);
575 if (!p)
576 return -ESRCH;
577
578 if (pid_has_task(p, PIDTYPE_TGID))
579 fd = pidfd_create(p);
580 else
581 fd = -EINVAL;
582
583 put_pid(p);
584 return fd;
585}
586
587void __init pid_idr_init(void)
588{
589 /* Verify no one has done anything silly: */
590 BUILD_BUG_ON(PID_MAX_LIMIT >= PIDNS_ADDING);
591
592 /* bump default and minimum pid_max based on number of cpus */
593 pid_max = min(pid_max_max, max_t(int, pid_max,
594 PIDS_PER_CPU_DEFAULT * num_possible_cpus()));
595 pid_max_min = max_t(int, pid_max_min,
596 PIDS_PER_CPU_MIN * num_possible_cpus());
597 pr_info("pid_max: default: %u minimum: %u\n", pid_max, pid_max_min);
598
599 idr_init(&init_pid_ns.idr);
600
601 init_pid_ns.pid_cachep = KMEM_CACHE(pid,
602 SLAB_HWCACHE_ALIGN | SLAB_PANIC | SLAB_ACCOUNT);
603}
604
605static struct file *__pidfd_fget(struct task_struct *task, int fd)
606{
607 struct file *file;
608 int ret;
609
610 ret = mutex_lock_killable(&task->signal->exec_update_mutex);
611 if (ret)
612 return ERR_PTR(ret);
613
614 if (ptrace_may_access(task, PTRACE_MODE_ATTACH_REALCREDS))
615 file = fget_task(task, fd);
616 else
617 file = ERR_PTR(-EPERM);
618
619 mutex_unlock(&task->signal->exec_update_mutex);
620
621 return file ?: ERR_PTR(-EBADF);
622}
623
624static int pidfd_getfd(struct pid *pid, int fd)
625{
626 struct task_struct *task;
627 struct file *file;
628 int ret;
629
630 task = get_pid_task(pid, PIDTYPE_PID);
631 if (!task)
632 return -ESRCH;
633
634 file = __pidfd_fget(task, fd);
635 put_task_struct(task);
636 if (IS_ERR(file))
637 return PTR_ERR(file);
638
639 ret = receive_fd(file, O_CLOEXEC);
640 fput(file);
641
642 return ret;
643}
644
645/**
646 * sys_pidfd_getfd() - Get a file descriptor from another process
647 *
648 * @pidfd: the pidfd file descriptor of the process
649 * @fd: the file descriptor number to get
650 * @flags: flags on how to get the fd (reserved)
651 *
652 * This syscall gets a copy of a file descriptor from another process
653 * based on the pidfd, and file descriptor number. It requires that
654 * the calling process has the ability to ptrace the process represented
655 * by the pidfd. The process which is having its file descriptor copied
656 * is otherwise unaffected.
657 *
658 * Return: On success, a cloexec file descriptor is returned.
659 * On error, a negative errno number will be returned.
660 */
661SYSCALL_DEFINE3(pidfd_getfd, int, pidfd, int, fd,
662 unsigned int, flags)
663{
664 struct pid *pid;
665 struct fd f;
666 int ret;
667
668 /* flags is currently unused - make sure it's unset */
669 if (flags)
670 return -EINVAL;
671
672 f = fdget(pidfd);
673 if (!f.file)
674 return -EBADF;
675
676 pid = pidfd_pid(f.file);
677 if (IS_ERR(pid))
678 ret = PTR_ERR(pid);
679 else
680 ret = pidfd_getfd(pid, fd);
681
682 fdput(f);
683 return ret;
684}