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 #if 0 /// UNNEEDED by elogind
  56 int get_process_uid(pid_t pid, uid_t *uid);
  57 int get_process_gid(pid_t pid, gid_t *gid);
  58 int get_process_capeff(pid_t pid, char **capeff);
  59 int get_process_cwd(pid_t pid, char **cwd);
  60 int get_process_root(pid_t pid, char **root);
  61 int get_process_environ(pid_t pid, char **environ);
  62 int get_process_ppid(pid_t pid, pid_t *ppid);
  63 #endif // 0
  64
  65 int wait_for_terminate(pid_t pid, siginfo_t *status);
  66 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
  67 int wait_for_terminate_with_timeout(pid_t pid, usec_t timeout);
  68 #if 0 /// UNNEEDED by elogind
  69
  70 void sigkill_wait(pid_t pid);
  71 void sigkill_waitp(pid_t *pid);
  72
  73 int kill_and_sigcont(pid_t pid, int sig);
  74
  75 int rename_process(const char name[]);
  76 #endif // 0
  77 int is_kernel_thread(pid_t pid);
  78
  79 int getenv_for_pid(pid_t pid, const char *field, char **_value);
  80
  81 bool pid_is_alive(pid_t pid);
  82 bool pid_is_unwaited(pid_t pid);
  83 #if 0 /// UNNEEDED by elogind
  84 int pid_from_same_root_fs(pid_t pid);
  85 #endif // 0
  86
  87 bool is_main_thread(void);
  88
  89 #if 0 /// UNNEEDED by elogind
  90 noreturn void freeze(void);
  91
  92 bool oom_score_adjust_is_valid(int oa);
  93 #endif // 0
  94
  95 #ifndef PERSONALITY_INVALID
  96 /* personality(7) documents that 0xffffffffUL is used for querying the
  97  * current personality, hence let's use that here as error
  98  * indicator. */
  99 #define PERSONALITY_INVALID 0xffffffffLU
 100 #endif
 101
 102 #if 0 /// UNNEEDED by elogind
 103 unsigned long personality_from_string(const char *p);
 104 const char *personality_to_string(unsigned long);
 105
 106 int safe_personality(unsigned long p);
 107 int opinionated_personality(unsigned long *ret);
 108
 109 int ioprio_class_to_string_alloc(int i, char **s);
 110 int ioprio_class_from_string(const char *s);
 111
 112 const char *sigchld_code_to_string(int i) _const_;
 113 int sigchld_code_from_string(const char *s) _pure_;
 114
 115 int sched_policy_to_string_alloc(int i, char **s);
 116 int sched_policy_from_string(const char *s);
 117 #endif // 0
 118
 119 #define PTR_TO_PID(p) ((pid_t) ((uintptr_t) p))
 120 #define PID_TO_PTR(p) ((void*) ((uintptr_t) p))
 121
 122 void valgrind_summary_hack(void);
 123
 124 int pid_compare_func(const void *a, const void *b);
 125
 126 #if 0 /// UNNEEDED by elogind
 127 static inline bool nice_is_valid(int n) {
 128         return n >= PRIO_MIN && n < PRIO_MAX;
 129 }
 130
 131 static inline bool sched_policy_is_valid(int i) {
 132         return IN_SET(i, SCHED_OTHER, SCHED_BATCH, SCHED_IDLE, SCHED_FIFO, SCHED_RR);
 133 }
 134
 135 static inline bool sched_priority_is_valid(int i) {
 136         return i >= 0 && i <= sched_get_priority_max(SCHED_RR);
 137 }
 138
 139 static inline bool ioprio_class_is_valid(int i) {
 140         return IN_SET(i, IOPRIO_CLASS_NONE, IOPRIO_CLASS_RT, IOPRIO_CLASS_BE, IOPRIO_CLASS_IDLE);
 141 }
 142
 143 static inline bool ioprio_priority_is_valid(int i) {
 144         return i >= 0 && i < IOPRIO_BE_NR;
 145 }
 146 #endif // 0
 147
 148 static inline bool pid_is_valid(pid_t p) {
 149         return p > 0;
 150 }
 151
 152 #if 0 /// UNNEEDED by elogind
 153 int ioprio_parse_priority(const char *s, int *ret);
 154 #endif // 0
 155
 156 pid_t getpid_cached(void);
 157
 158 int must_be_root(void);
 159
 160 typedef enum ForkFlags {
 161         FORK_RESET_SIGNALS = 1U << 0,
 162         FORK_CLOSE_ALL_FDS = 1U << 1,
 163         FORK_DEATHSIG      = 1U << 2,
 164         FORK_NULL_STDIO    = 1U << 3,
 165         FORK_REOPEN_LOG    = 1U << 4,
 166 } ForkFlags;
 167
 168 int safe_fork_full(const char *name, const int except_fds[], size_t n_except_fds, ForkFlags flags, pid_t *ret_pid);
 169
 170 static inline int safe_fork(const char *name, ForkFlags flags, pid_t *ret_pid) {
 171         return safe_fork_full(name, NULL, 0, flags, ret_pid);
 172 }