xref: /linux/include/uapi/linux/sched.h (revision ead5d1f4d877e92c051e1a1ade623d0d30e71619)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _UAPI_LINUX_SCHED_H
3 #define _UAPI_LINUX_SCHED_H
4 
5 #include <linux/types.h>
6 
7 /*
8  * cloning flags:
9  */
10 #define CSIGNAL		0x000000ff	/* signal mask to be sent at exit */
11 #define CLONE_VM	0x00000100	/* set if VM shared between processes */
12 #define CLONE_FS	0x00000200	/* set if fs info shared between processes */
13 #define CLONE_FILES	0x00000400	/* set if open files shared between processes */
14 #define CLONE_SIGHAND	0x00000800	/* set if signal handlers and blocked signals shared */
15 #define CLONE_PIDFD	0x00001000	/* set if a pidfd should be placed in parent */
16 #define CLONE_PTRACE	0x00002000	/* set if we want to let tracing continue on the child too */
17 #define CLONE_VFORK	0x00004000	/* set if the parent wants the child to wake it up on mm_release */
18 #define CLONE_PARENT	0x00008000	/* set if we want to have the same parent as the cloner */
19 #define CLONE_THREAD	0x00010000	/* Same thread group? */
20 #define CLONE_NEWNS	0x00020000	/* New mount namespace group */
21 #define CLONE_SYSVSEM	0x00040000	/* share system V SEM_UNDO semantics */
22 #define CLONE_SETTLS	0x00080000	/* create a new TLS for the child */
23 #define CLONE_PARENT_SETTID	0x00100000	/* set the TID in the parent */
24 #define CLONE_CHILD_CLEARTID	0x00200000	/* clear the TID in the child */
25 #define CLONE_DETACHED		0x00400000	/* Unused, ignored */
26 #define CLONE_UNTRACED		0x00800000	/* set if the tracing process can't force CLONE_PTRACE on this clone */
27 #define CLONE_CHILD_SETTID	0x01000000	/* set the TID in the child */
28 #define CLONE_NEWCGROUP		0x02000000	/* New cgroup namespace */
29 #define CLONE_NEWUTS		0x04000000	/* New utsname namespace */
30 #define CLONE_NEWIPC		0x08000000	/* New ipc namespace */
31 #define CLONE_NEWUSER		0x10000000	/* New user namespace */
32 #define CLONE_NEWPID		0x20000000	/* New pid namespace */
33 #define CLONE_NEWNET		0x40000000	/* New network namespace */
34 #define CLONE_IO		0x80000000	/* Clone io context */
35 
36 /* Flags for the clone3() syscall. */
37 #define CLONE_CLEAR_SIGHAND 0x100000000ULL /* Clear any signal handler and reset to SIG_DFL. */
38 #define CLONE_INTO_CGROUP 0x200000000ULL /* Clone into a specific cgroup given the right permissions. */
39 
40 /*
41  * cloning flags intersect with CSIGNAL so can be used with unshare and clone3
42  * syscalls only:
43  */
44 #define CLONE_NEWTIME	0x00000080	/* New time namespace */
45 
46 #ifndef __ASSEMBLY__
47 /**
48  * struct clone_args - arguments for the clone3 syscall
49  * @flags:        Flags for the new process as listed above.
50  *                All flags are valid except for CSIGNAL and
51  *                CLONE_DETACHED.
52  * @pidfd:        If CLONE_PIDFD is set, a pidfd will be
53  *                returned in this argument.
54  * @child_tid:    If CLONE_CHILD_SETTID is set, the TID of the
55  *                child process will be returned in the child's
56  *                memory.
57  * @parent_tid:   If CLONE_PARENT_SETTID is set, the TID of
58  *                the child process will be returned in the
59  *                parent's memory.
60  * @exit_signal:  The exit_signal the parent process will be
61  *                sent when the child exits.
62  * @stack:        Specify the location of the stack for the
63  *                child process.
64  *                Note, @stack is expected to point to the
65  *                lowest address. The stack direction will be
66  *                determined by the kernel and set up
67  *                appropriately based on @stack_size.
68  * @stack_size:   The size of the stack for the child process.
69  * @tls:          If CLONE_SETTLS is set, the tls descriptor
70  *                is set to tls.
71  * @set_tid:      Pointer to an array of type *pid_t. The size
72  *                of the array is defined using @set_tid_size.
73  *                This array is used to select PIDs/TIDs for
74  *                newly created processes. The first element in
75  *                this defines the PID in the most nested PID
76  *                namespace. Each additional element in the array
77  *                defines the PID in the parent PID namespace of
78  *                the original PID namespace. If the array has
79  *                less entries than the number of currently
80  *                nested PID namespaces only the PIDs in the
81  *                corresponding namespaces are set.
82  * @set_tid_size: This defines the size of the array referenced
83  *                in @set_tid. This cannot be larger than the
84  *                kernel's limit of nested PID namespaces.
85  * @cgroup:       If CLONE_INTO_CGROUP is specified set this to
86  *                a file descriptor for the cgroup.
87  *
88  * The structure is versioned by size and thus extensible.
89  * New struct members must go at the end of the struct and
90  * must be properly 64bit aligned.
91  */
92 struct clone_args {
93 	__aligned_u64 flags;
94 	__aligned_u64 pidfd;
95 	__aligned_u64 child_tid;
96 	__aligned_u64 parent_tid;
97 	__aligned_u64 exit_signal;
98 	__aligned_u64 stack;
99 	__aligned_u64 stack_size;
100 	__aligned_u64 tls;
101 	__aligned_u64 set_tid;
102 	__aligned_u64 set_tid_size;
103 	__aligned_u64 cgroup;
104 };
105 #endif
106 
107 #define CLONE_ARGS_SIZE_VER0 64 /* sizeof first published struct */
108 #define CLONE_ARGS_SIZE_VER1 80 /* sizeof second published struct */
109 #define CLONE_ARGS_SIZE_VER2 88 /* sizeof third published struct */
110 
111 /*
112  * Scheduling policies
113  */
114 #define SCHED_NORMAL		0
115 #define SCHED_FIFO		1
116 #define SCHED_RR		2
117 #define SCHED_BATCH		3
118 /* SCHED_ISO: reserved but not implemented yet */
119 #define SCHED_IDLE		5
120 #define SCHED_DEADLINE		6
121 
122 /* Can be ORed in to make sure the process is reverted back to SCHED_NORMAL on fork */
123 #define SCHED_RESET_ON_FORK     0x40000000
124 
125 /*
126  * For the sched_{set,get}attr() calls
127  */
128 #define SCHED_FLAG_RESET_ON_FORK	0x01
129 #define SCHED_FLAG_RECLAIM		0x02
130 #define SCHED_FLAG_DL_OVERRUN		0x04
131 #define SCHED_FLAG_KEEP_POLICY		0x08
132 #define SCHED_FLAG_KEEP_PARAMS		0x10
133 #define SCHED_FLAG_UTIL_CLAMP_MIN	0x20
134 #define SCHED_FLAG_UTIL_CLAMP_MAX	0x40
135 
136 #define SCHED_FLAG_KEEP_ALL	(SCHED_FLAG_KEEP_POLICY | \
137 				 SCHED_FLAG_KEEP_PARAMS)
138 
139 #define SCHED_FLAG_UTIL_CLAMP	(SCHED_FLAG_UTIL_CLAMP_MIN | \
140 				 SCHED_FLAG_UTIL_CLAMP_MAX)
141 
142 #define SCHED_FLAG_ALL	(SCHED_FLAG_RESET_ON_FORK	| \
143 			 SCHED_FLAG_RECLAIM		| \
144 			 SCHED_FLAG_DL_OVERRUN		| \
145 			 SCHED_FLAG_KEEP_ALL		| \
146 			 SCHED_FLAG_UTIL_CLAMP)
147 
148 #endif /* _UAPI_LINUX_SCHED_H */
149