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 #if 0 /// UNNEEDED by elogind
  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 #endif // 0
  50
  51 int wait_for_terminate(pid_t pid, siginfo_t *status);
  52
  53 typedef enum WaitFlags {
  54         WAIT_LOG_ABNORMAL             = 1 << 0,
  55         WAIT_LOG_NON_ZERO_EXIT_STATUS = 1 << 1,
  56
  57         /* A shortcut for requesting the most complete logging */
  58         WAIT_LOG = WAIT_LOG_ABNORMAL|WAIT_LOG_NON_ZERO_EXIT_STATUS,
  59 } WaitFlags;
  60
  61 int wait_for_terminate_and_check(const char *name, pid_t pid, WaitFlags flags);
  62 int wait_for_terminate_with_timeout(pid_t pid, usec_t timeout);
  63 #if 0 /// UNNEEDED by elogind
  64
  65 void sigkill_wait(pid_t pid);
  66 void sigkill_waitp(pid_t *pid);
  67 #endif // 0
  68 void sigterm_wait(pid_t pid);
  69
  70 int kill_and_sigcont(pid_t pid, int sig);
  71
  72 int rename_process(const char name[]);
  73 int is_kernel_thread(pid_t pid);
  74
  75 int getenv_for_pid(pid_t pid, const char *field, char **_value);
  76
  77 bool pid_is_alive(pid_t pid);
  78 bool pid_is_unwaited(pid_t pid);
  79 #if 0 /// UNNEEDED by elogind
  80 int pid_from_same_root_fs(pid_t pid);
  81 #endif // 0
  82
  83 bool is_main_thread(void);
  84
  85 #if 0 /// UNNEEDED by elogind
  86 _noreturn_ void freeze(void);
  87
  88 bool oom_score_adjust_is_valid(int oa);
  89 #endif // 0
  90
  91 #ifndef PERSONALITY_INVALID
  92 /* personality(7) documents that 0xffffffffUL is used for querying the
  93  * current personality, hence let's use that here as error
  94  * indicator. */
  95 #define PERSONALITY_INVALID 0xffffffffLU
  96 #endif
  97
  98 #if 0 /// UNNEEDED by elogind
  99 unsigned long personality_from_string(const char *p);
 100 const char *personality_to_string(unsigned long);
 101
 102 int safe_personality(unsigned long p);
 103 int opinionated_personality(unsigned long *ret);
 104
 105 int ioprio_class_to_string_alloc(int i, char **s);
 106 int ioprio_class_from_string(const char *s);
 107
 108 const char *sigchld_code_to_string(int i) _const_;
 109 int sigchld_code_from_string(const char *s) _pure_;
 110 #endif // 0
 111
 112 int sched_policy_to_string_alloc(int i, char **s);
 113 #if 0 /// UNNEEDED by elogind
 114 int sched_policy_from_string(const char *s);
 115 #endif // 0
 116
 117 static inline pid_t PTR_TO_PID(const void *p) {
 118         return (pid_t) ((uintptr_t) p);
 119 }
 120
 121 static inline void* PID_TO_PTR(pid_t pid) {
 122         return (void*) ((uintptr_t) pid);
 123 }
 124
 125 void valgrind_summary_hack(void);
 126
 127 int pid_compare_func(const void *a, const void *b);
 128
 129 #if 0 /// UNNEEDED by elogind
 130 static inline bool nice_is_valid(int n) {
 131         return n >= PRIO_MIN && n < PRIO_MAX;
 132 }
 133 #endif // 0
 134
 135 static inline bool sched_policy_is_valid(int i) {
 136         return IN_SET(i, SCHED_OTHER, SCHED_BATCH, SCHED_IDLE, SCHED_FIFO, SCHED_RR);
 137 }
 138
 139 #if 0 /// UNNEEDED by elogind
 140 static inline bool sched_priority_is_valid(int i) {
 141         return i >= 0 && i <= sched_get_priority_max(SCHED_RR);
 142 }
 143
 144 static inline bool ioprio_class_is_valid(int i) {
 145         return IN_SET(i, IOPRIO_CLASS_NONE, IOPRIO_CLASS_RT, IOPRIO_CLASS_BE, IOPRIO_CLASS_IDLE);
 146 }
 147
 148 static inline bool ioprio_priority_is_valid(int i) {
 149         return i >= 0 && i < IOPRIO_BE_NR;
 150 }
 151 #endif // 0
 152
 153 static inline bool pid_is_valid(pid_t p) {
 154         return p > 0;
 155 }
 156
 157 static inline int sched_policy_to_string_alloc_with_check(int n, char **s) {
 158         if (!sched_policy_is_valid(n))
 159                 return -EINVAL;
 160
 161         return sched_policy_to_string_alloc(n, s);
 162 }
 163
 164 #if 0 /// UNNEEDED by elogind
 165 int ioprio_parse_priority(const char *s, int *ret);
 166 #endif // 0
 167
 168 pid_t getpid_cached(void);
 169 void reset_cached_pid(void);
 170
 171 int must_be_root(void);
 172
 173 typedef enum ForkFlags {
 174         FORK_RESET_SIGNALS = 1 << 0,
 175         FORK_CLOSE_ALL_FDS = 1 << 1,
 176         FORK_DEATHSIG      = 1 << 2,
 177         FORK_NULL_STDIO    = 1 << 3,
 178         FORK_REOPEN_LOG    = 1 << 4,
 179         FORK_LOG           = 1 << 5,
 180         FORK_WAIT          = 1 << 6,
 181         FORK_NEW_MOUNTNS   = 1 << 7,
 182         FORK_MOUNTNS_SLAVE = 1 << 8,
 183 } ForkFlags;
 184
 185 int safe_fork_full(const char *name, const int except_fds[], size_t n_except_fds, ForkFlags flags, pid_t *ret_pid);
 186
 187 static inline int safe_fork(const char *name, ForkFlags flags, pid_t *ret_pid) {
 188         return safe_fork_full(name, NULL, 0, flags, ret_pid);
 189 }
 190
 191 int fork_agent(const char *name, const int except[], size_t n_except, pid_t *pid, const char *path, ...);
 192
 193 int set_oom_score_adjust(int value);
 194
 195 #if SIZEOF_PID_T == 4
 196 /* The highest possibly (theoretic) pid_t value on this architecture. */
 197 #define PID_T_MAX ((pid_t) INT32_MAX)
 198 /* The maximum number of concurrent processes Linux allows on this architecture, as well as the highest valid PID value
 199  * the kernel will potentially assign. This reflects a value compiled into the kernel (PID_MAX_LIMIT), and sets the
 200  * upper boundary on what may be written to the /proc/sys/kernel/pid_max sysctl (but do note that the sysctl is off by
 201  * 1, since PID 0 can never exist and there can hence only be one process less than the limit would suggest). Since
 202  * these values are documented in proc(5) we feel quite confident that they are stable enough for the near future at
 203  * least to define them here too. */
 204 #define TASKS_MAX 4194303U
 205 #elif SIZEOF_PID_T == 2
 206 #define PID_T_MAX ((pid_t) INT16_MAX)
 207 #define TASKS_MAX 32767U
 208 #else
 209 #error "Unknown pid_t size"
 210 #endif
 211
 212 assert_cc(TASKS_MAX <= (unsigned long) PID_T_MAX)
 213
 214 /* Like TAKE_PTR() but for child PIDs, resetting them to 0 */
 215 #define TAKE_PID(pid)                           \
 216         ({                                      \
 217                 pid_t _pid_ = (pid);            \
 218                 (pid) = 0;                      \
 219                 _pid_;                          \
 220         })