src/basic/process-util.h

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