Branch data Line data Source code
1 : : /* SPDX-License-Identifier: LGPL-2.1+ */
2 : : #pragma once
3 : :
4 : : #include <alloca.h>
5 : : #include <errno.h>
6 : : #include <sched.h>
7 : : #include <signal.h>
8 : : #include <stdbool.h>
9 : : #include <stddef.h>
10 : : #include <stdio.h>
11 : : #include <string.h>
12 : : #include <sys/resource.h>
13 : : #include <sys/types.h>
14 : :
15 : : #include "alloc-util.h"
16 : : #include "format-util.h"
17 : : #include "ioprio.h"
18 : : #include "macro.h"
19 : : #include "time-util.h"
20 : :
21 : : #define procfs_file_alloca(pid, field) \
22 : : ({ \
23 : : pid_t _pid_ = (pid); \
24 : : const char *_r_; \
25 : : if (_pid_ == 0) { \
26 : : _r_ = ("/proc/self/" field); \
27 : : } else { \
28 : : _r_ = newa(char, STRLEN("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
29 : : sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
30 : : } \
31 : : _r_; \
32 : : })
33 : :
34 : : typedef enum ProcessCmdlineFlags {
35 : : PROCESS_CMDLINE_COMM_FALLBACK = 1 << 0,
36 : : PROCESS_CMDLINE_USE_LOCALE = 1 << 1,
37 : : } ProcessCmdlineFlags;
38 : :
39 : : int get_process_comm(pid_t pid, char **name);
40 : : int get_process_cmdline(pid_t pid, size_t max_columns, ProcessCmdlineFlags flags, char **line);
41 : : int get_process_exe(pid_t pid, char **name);
42 : : int get_process_uid(pid_t pid, uid_t *uid);
43 : : int get_process_gid(pid_t pid, gid_t *gid);
44 : : int get_process_capeff(pid_t pid, char **capeff);
45 : : int get_process_cwd(pid_t pid, char **cwd);
46 : : int get_process_root(pid_t pid, char **root);
47 : : int get_process_environ(pid_t pid, char **environ);
48 : : int get_process_ppid(pid_t pid, pid_t *ppid);
49 : :
50 : : int wait_for_terminate(pid_t pid, siginfo_t *status);
51 : :
52 : : typedef enum WaitFlags {
53 : : WAIT_LOG_ABNORMAL = 1 << 0,
54 : : WAIT_LOG_NON_ZERO_EXIT_STATUS = 1 << 1,
55 : :
56 : : /* A shortcut for requesting the most complete logging */
57 : : WAIT_LOG = WAIT_LOG_ABNORMAL|WAIT_LOG_NON_ZERO_EXIT_STATUS,
58 : : } WaitFlags;
59 : :
60 : : int wait_for_terminate_and_check(const char *name, pid_t pid, WaitFlags flags);
61 : : int wait_for_terminate_with_timeout(pid_t pid, usec_t timeout);
62 : :
63 : : void sigkill_wait(pid_t pid);
64 : : void sigkill_waitp(pid_t *pid);
65 : : void sigterm_wait(pid_t pid);
66 : :
67 : : int kill_and_sigcont(pid_t pid, int sig);
68 : :
69 : : int rename_process(const char name[]);
70 : : int is_kernel_thread(pid_t pid);
71 : :
72 : : int getenv_for_pid(pid_t pid, const char *field, char **_value);
73 : :
74 : : bool pid_is_alive(pid_t pid);
75 : : bool pid_is_unwaited(pid_t pid);
76 : : int pid_is_my_child(pid_t pid);
77 : : int pid_from_same_root_fs(pid_t pid);
78 : :
79 : : bool is_main_thread(void);
80 : :
81 : : _noreturn_ void freeze(void);
82 : :
83 : : bool oom_score_adjust_is_valid(int oa);
84 : :
85 : : #ifndef PERSONALITY_INVALID
86 : : /* personality(7) documents that 0xffffffffUL is used for querying the
87 : : * current personality, hence let's use that here as error
88 : : * indicator. */
89 : : #define PERSONALITY_INVALID 0xffffffffLU
90 : : #endif
91 : :
92 : : unsigned long personality_from_string(const char *p);
93 : : const char *personality_to_string(unsigned long);
94 : :
95 : : int safe_personality(unsigned long p);
96 : : int opinionated_personality(unsigned long *ret);
97 : :
98 : : int ioprio_class_to_string_alloc(int i, char **s);
99 : : int ioprio_class_from_string(const char *s);
100 : :
101 : : const char *sigchld_code_to_string(int i) _const_;
102 : : int sigchld_code_from_string(const char *s) _pure_;
103 : :
104 : : int sched_policy_to_string_alloc(int i, char **s);
105 : : int sched_policy_from_string(const char *s);
106 : :
107 : 36 : static inline pid_t PTR_TO_PID(const void *p) {
108 : 36 : return (pid_t) ((uintptr_t) p);
109 : : }
110 : :
111 : 240 : static inline void* PID_TO_PTR(pid_t pid) {
112 : 240 : return (void*) ((uintptr_t) pid);
113 : : }
114 : :
115 : : void valgrind_summary_hack(void);
116 : :
117 : : int pid_compare_func(const pid_t *a, const pid_t *b);
118 : :
119 : 68 : static inline bool nice_is_valid(int n) {
120 [ + + + + ]: 68 : return n >= PRIO_MIN && n < PRIO_MAX;
121 : : }
122 : :
123 : 0 : static inline bool sched_policy_is_valid(int i) {
124 [ # # ]: 0 : return IN_SET(i, SCHED_OTHER, SCHED_BATCH, SCHED_IDLE, SCHED_FIFO, SCHED_RR);
125 : : }
126 : :
127 : : static inline bool sched_priority_is_valid(int i) {
128 : : return i >= 0 && i <= sched_get_priority_max(SCHED_RR);
129 : : }
130 : :
131 : 0 : static inline bool ioprio_class_is_valid(int i) {
132 [ # # ]: 0 : return IN_SET(i, IOPRIO_CLASS_NONE, IOPRIO_CLASS_RT, IOPRIO_CLASS_BE, IOPRIO_CLASS_IDLE);
133 : : }
134 : :
135 : 0 : static inline bool ioprio_priority_is_valid(int i) {
136 [ # # # # ]: 0 : return i >= 0 && i < IOPRIO_BE_NR;
137 : : }
138 : :
139 : 5067 : static inline bool pid_is_valid(pid_t p) {
140 : 5067 : return p > 0;
141 : : }
142 : :
143 : : int ioprio_parse_priority(const char *s, int *ret);
144 : :
145 : : pid_t getpid_cached(void);
146 : : void reset_cached_pid(void);
147 : :
148 : : int must_be_root(void);
149 : :
150 : : typedef enum ForkFlags {
151 : : FORK_RESET_SIGNALS = 1 << 0, /* Reset all signal handlers and signal mask */
152 : : FORK_CLOSE_ALL_FDS = 1 << 1, /* Close all open file descriptors in the child, except for 0,1,2 */
153 : : FORK_DEATHSIG = 1 << 2, /* Set PR_DEATHSIG in the child */
154 : : FORK_NULL_STDIO = 1 << 3, /* Connect 0,1,2 to /dev/null */
155 : : FORK_REOPEN_LOG = 1 << 4, /* Reopen log connection */
156 : : FORK_LOG = 1 << 5, /* Log above LOG_DEBUG log level about failures */
157 : : FORK_WAIT = 1 << 6, /* Wait until child exited */
158 : : FORK_NEW_MOUNTNS = 1 << 7, /* Run child in its own mount namespace */
159 : : FORK_MOUNTNS_SLAVE = 1 << 8, /* Make child's mount namespace MS_SLAVE */
160 : : FORK_RLIMIT_NOFILE_SAFE = 1 << 9, /* Set RLIMIT_NOFILE soft limit to 1K for select() compat */
161 : : } ForkFlags;
162 : :
163 : : int safe_fork_full(const char *name, const int except_fds[], size_t n_except_fds, ForkFlags flags, pid_t *ret_pid);
164 : :
165 : 646 : static inline int safe_fork(const char *name, ForkFlags flags, pid_t *ret_pid) {
166 : 646 : return safe_fork_full(name, NULL, 0, flags, ret_pid);
167 : : }
168 : :
169 : : int namespace_fork(const char *outer_name, const char *inner_name, const int except_fds[], size_t n_except_fds, ForkFlags flags, int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd, pid_t *ret_pid);
170 : :
171 : : int fork_agent(const char *name, const int except[], size_t n_except, pid_t *pid, const char *path, ...) _sentinel_;
172 : :
173 : : int set_oom_score_adjust(int value);
174 : :
175 : : #if SIZEOF_PID_T == 4
176 : : /* The highest possibly (theoretic) pid_t value on this architecture. */
177 : : #define PID_T_MAX ((pid_t) INT32_MAX)
178 : : /* The maximum number of concurrent processes Linux allows on this architecture, as well as the highest valid PID value
179 : : * the kernel will potentially assign. This reflects a value compiled into the kernel (PID_MAX_LIMIT), and sets the
180 : : * upper boundary on what may be written to the /proc/sys/kernel/pid_max sysctl (but do note that the sysctl is off by
181 : : * 1, since PID 0 can never exist and there can hence only be one process less than the limit would suggest). Since
182 : : * these values are documented in proc(5) we feel quite confident that they are stable enough for the near future at
183 : : * least to define them here too. */
184 : : #define TASKS_MAX 4194303U
185 : : #elif SIZEOF_PID_T == 2
186 : : #define PID_T_MAX ((pid_t) INT16_MAX)
187 : : #define TASKS_MAX 32767U
188 : : #else
189 : : #error "Unknown pid_t size"
190 : : #endif
191 : :
192 : : assert_cc(TASKS_MAX <= (unsigned long) PID_T_MAX);
193 : :
194 : : /* Like TAKE_PTR() but for child PIDs, resetting them to 0 */
195 : : #define TAKE_PID(pid) \
196 : : ({ \
197 : : pid_t _pid_ = (pid); \
198 : : (pid) = 0; \
199 : : _pid_; \
200 : : })
|
