Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2
3#ifndef _UAPI_LINUX_PIDFD_H
4#define _UAPI_LINUX_PIDFD_H
5
6#include <linux/types.h>
7#include <linux/fcntl.h>
8#include <linux/ioctl.h>
9
10/* Flags for pidfd_open(). */
11#define PIDFD_NONBLOCK O_NONBLOCK
12#define PIDFD_THREAD O_EXCL
13#ifdef __KERNEL__
14#include <linux/sched.h>
15#define PIDFD_STALE CLONE_PIDFD
16#define PIDFD_AUTOKILL O_TRUNC
17#endif
18
19/* Flags for pidfd_send_signal(). */
20#define PIDFD_SIGNAL_THREAD (1UL << 0)
21#define PIDFD_SIGNAL_THREAD_GROUP (1UL << 1)
22#define PIDFD_SIGNAL_PROCESS_GROUP (1UL << 2)
23
24/* Flags for pidfd_info. */
25#define PIDFD_INFO_PID (1UL << 0) /* Always returned, even if not requested */
26#define PIDFD_INFO_CREDS (1UL << 1) /* Always returned, even if not requested */
27#define PIDFD_INFO_CGROUPID (1UL << 2) /* Always returned if available, even if not requested */
28#define PIDFD_INFO_EXIT (1UL << 3) /* Only returned if requested. */
29#define PIDFD_INFO_COREDUMP (1UL << 4) /* Only returned if requested. */
30#define PIDFD_INFO_SUPPORTED_MASK (1UL << 5) /* Want/got supported mask flags */
31#define PIDFD_INFO_COREDUMP_SIGNAL (1UL << 6) /* Always returned if PIDFD_INFO_COREDUMP is requested. */
32#define PIDFD_INFO_COREDUMP_CODE (1UL << 7) /* Always returned if PIDFD_INFO_COREDUMP is requested. */
33
34#define PIDFD_INFO_SIZE_VER0 64 /* sizeof first published struct */
35#define PIDFD_INFO_SIZE_VER1 72 /* sizeof second published struct */
36#define PIDFD_INFO_SIZE_VER2 80 /* sizeof third published struct */
37#define PIDFD_INFO_SIZE_VER3 88 /* sizeof fourth published struct */
38
39/*
40 * Values for @coredump_mask in pidfd_info.
41 * Only valid if PIDFD_INFO_COREDUMP is set in @mask.
42 *
43 * Note, the @PIDFD_COREDUMP_ROOT flag indicates that the generated
44 * coredump should be treated as sensitive and access should only be
45 * granted to privileged users.
46 */
47#define PIDFD_COREDUMPED (1U << 0) /* Did crash and... */
48#define PIDFD_COREDUMP_SKIP (1U << 1) /* coredumping generation was skipped. */
49#define PIDFD_COREDUMP_USER (1U << 2) /* coredump was done as the user. */
50#define PIDFD_COREDUMP_ROOT (1U << 3) /* coredump was done as root. */
51
52/*
53 * ...and for userland we make life simpler - PIDFD_SELF refers to the current
54 * thread, PIDFD_SELF_PROCESS refers to the process thread group leader.
55 *
56 * For nearly all practical uses, a user will want to use PIDFD_SELF.
57 */
58#define PIDFD_SELF PIDFD_SELF_THREAD
59#define PIDFD_SELF_PROCESS PIDFD_SELF_THREAD_GROUP
60
61struct pidfd_info {
62 /*
63 * This mask is similar to the request_mask in statx(2).
64 *
65 * Userspace indicates what extensions or expensive-to-calculate fields
66 * they want by setting the corresponding bits in mask. The kernel
67 * will ignore bits that it does not know about.
68 *
69 * When filling the structure, the kernel will only set bits
70 * corresponding to the fields that were actually filled by the kernel.
71 * This also includes any future extensions that might be automatically
72 * filled. If the structure size is too small to contain a field
73 * (requested or not), to avoid confusion the mask will not
74 * contain a bit for that field.
75 *
76 * As such, userspace MUST verify that mask contains the
77 * corresponding flags after the ioctl(2) returns to ensure that it is
78 * using valid data.
79 */
80 __u64 mask;
81 /*
82 * The information contained in the following fields might be stale at the
83 * time it is received, as the target process might have exited as soon as
84 * the IOCTL was processed, and there is no way to avoid that. However, it
85 * is guaranteed that if the call was successful, then the information was
86 * correct and referred to the intended process at the time the work was
87 * performed. */
88 __u64 cgroupid;
89 __u32 pid;
90 __u32 tgid;
91 __u32 ppid;
92 __u32 ruid;
93 __u32 rgid;
94 __u32 euid;
95 __u32 egid;
96 __u32 suid;
97 __u32 sgid;
98 __u32 fsuid;
99 __u32 fsgid;
100 __s32 exit_code;
101 struct /* coredump info */ {
102 __u32 coredump_mask;
103 __u32 coredump_signal;
104 __u32 coredump_code;
105 __u32 coredump_pad; /* align supported_mask to 8 bytes */
106 };
107 __u64 supported_mask; /* Mask flags that this kernel supports */
108};
109
110#define PIDFS_IOCTL_MAGIC 0xFF
111
112#define PIDFD_GET_CGROUP_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 1)
113#define PIDFD_GET_IPC_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 2)
114#define PIDFD_GET_MNT_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 3)
115#define PIDFD_GET_NET_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 4)
116#define PIDFD_GET_PID_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 5)
117#define PIDFD_GET_PID_FOR_CHILDREN_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 6)
118#define PIDFD_GET_TIME_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 7)
119#define PIDFD_GET_TIME_FOR_CHILDREN_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 8)
120#define PIDFD_GET_USER_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 9)
121#define PIDFD_GET_UTS_NAMESPACE _IO(PIDFS_IOCTL_MAGIC, 10)
122#define PIDFD_GET_INFO _IOWR(PIDFS_IOCTL_MAGIC, 11, struct pidfd_info)
123
124#endif /* _UAPI_LINUX_PIDFD_H */