src/basic/process-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <alloca.h>
  24 #include <sched.h>
  25 #include <signal.h>
  26 #include <stdbool.h>
  27 #include <stddef.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30 #include <sys/resource.h>
  31 #include <sys/types.h>
  32
  33 #include "format-util.h"
  34 #include "ioprio.h"
  35 #include "macro.h"
  36 #include "time-util.h"
  37
  38 #define procfs_file_alloca(pid, field)                                  \
  39         ({                                                              \
  40                 pid_t _pid_ = (pid);                                    \
  41                 const char *_r_;                                        \
  42                 if (_pid_ == 0) {                                       \
  43                         _r_ = ("/proc/self/" field);                    \
  44                 } else {                                                \
  45                         _r_ = alloca(STRLEN("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
  46                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
  47                 }                                                       \
  48                 _r_;                                                    \
  49         })
  50
  51 int get_process_state(pid_t pid);
  52 int get_process_comm(pid_t pid, char **name);
  53 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
  54 int get_process_exe(pid_t pid, char **name);
  55 int get_process_uid(pid_t pid, uid_t *uid);
  56 int get_process_gid(pid_t pid, gid_t *gid);
  57 int get_process_capeff(pid_t pid, char **capeff);
  58 int get_process_cwd(pid_t pid, char **cwd);
  59 int get_process_root(pid_t pid, char **root);
  60 int get_process_environ(pid_t pid, char **environ);
  61 int get_process_ppid(pid_t pid, pid_t *ppid);
  62
  63 int wait_for_terminate(pid_t pid, siginfo_t *status);
  64 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
  65 int wait_for_terminate_with_timeout(pid_t pid, usec_t timeout);
  66
  67 void sigkill_wait(pid_t pid);
  68 void sigkill_waitp(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 int pid_from_same_root_fs(pid_t pid);
  80
  81 bool is_main_thread(void);
  82
  83 noreturn void freeze(void);
  84
  85 bool oom_score_adjust_is_valid(int oa);
  86
  87 #ifndef PERSONALITY_INVALID
  88 /* personality(7) documents that 0xffffffffUL is used for querying the
  89  * current personality, hence let's use that here as error
  90  * indicator. */
  91 #define PERSONALITY_INVALID 0xffffffffLU
  92 #endif
  93
  94 unsigned long personality_from_string(const char *p);
  95 const char *personality_to_string(unsigned long);
  96
  97 int safe_personality(unsigned long p);
  98 int opinionated_personality(unsigned long *ret);
  99
 100 int ioprio_class_to_string_alloc(int i, char **s);
 101 int ioprio_class_from_string(const char *s);
 102
 103 const char *sigchld_code_to_string(int i) _const_;
 104 int sigchld_code_from_string(const char *s) _pure_;
 105
 106 int sched_policy_to_string_alloc(int i, char **s);
 107 int sched_policy_from_string(const char *s);
 108
 109 #define PTR_TO_PID(p) ((pid_t) ((uintptr_t) p))
 110 #define PID_TO_PTR(p) ((void*) ((uintptr_t) p))
 111
 112 void valgrind_summary_hack(void);
 113
 114 int pid_compare_func(const void *a, const void *b);
 115
 116 static inline bool nice_is_valid(int n) {
 117         return n >= PRIO_MIN && n < PRIO_MAX;
 118 }
 119
 120 static inline bool sched_policy_is_valid(int i) {
 121         return IN_SET(i, SCHED_OTHER, SCHED_BATCH, SCHED_IDLE, SCHED_FIFO, SCHED_RR);
 122 }
 123
 124 static inline bool sched_priority_is_valid(int i) {
 125         return i >= 0 && i <= sched_get_priority_max(SCHED_RR);
 126 }
 127
 128 static inline bool ioprio_class_is_valid(int i) {
 129         return IN_SET(i, IOPRIO_CLASS_NONE, IOPRIO_CLASS_RT, IOPRIO_CLASS_BE, IOPRIO_CLASS_IDLE);
 130 }
 131
 132 static inline bool ioprio_priority_is_valid(int i) {
 133         return i >= 0 && i < IOPRIO_BE_NR;
 134 }
 135
 136 static inline bool pid_is_valid(pid_t p) {
 137         return p > 0;
 138 }
 139
 140 int ioprio_parse_priority(const char *s, int *ret);
 141
 142 pid_t getpid_cached(void);
 143
 144 int must_be_root(void);
 145
 146 typedef enum ForkFlags {
 147         FORK_RESET_SIGNALS = 1U << 0,
 148         FORK_CLOSE_ALL_FDS = 1U << 1,
 149         FORK_DEATHSIG      = 1U << 2,
 150         FORK_NULL_STDIO    = 1U << 3,
 151         FORK_REOPEN_LOG    = 1U << 4,
 152 } ForkFlags;
 153
 154 int safe_fork_full(const char *name, const int except_fds[], size_t n_except_fds, ForkFlags flags, pid_t *ret_pid);
 155
 156 static inline int safe_fork(const char *name, ForkFlags flags, pid_t *ret_pid) {
 157         return safe_fork_full(name, NULL, 0, flags, ret_pid);
 158 }