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
  37 #define procfs_file_alloca(pid, field)                                  \
  38         ({                                                              \
  39                 pid_t _pid_ = (pid);                                    \
  40                 const char *_r_;                                        \
  41                 if (_pid_ == 0) {                                       \
  42                         _r_ = ("/proc/self/" field);                    \
  43                 } else {                                                \
  44                         _r_ = alloca(STRLEN("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
  45                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
  46                 }                                                       \
  47                 _r_;                                                    \
  48         })
  49
  50 int get_process_state(pid_t pid);
  51 int get_process_comm(pid_t pid, char **name);
  52 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
  53 int get_process_exe(pid_t pid, char **name);
  54 int get_process_uid(pid_t pid, uid_t *uid);
  55 int get_process_gid(pid_t pid, gid_t *gid);
  56 int get_process_capeff(pid_t pid, char **capeff);
  57 int get_process_cwd(pid_t pid, char **cwd);
  58 int get_process_root(pid_t pid, char **root);
  59 int get_process_environ(pid_t pid, char **environ);
  60 int get_process_ppid(pid_t pid, pid_t *ppid);
  61
  62 int wait_for_terminate(pid_t pid, siginfo_t *status);
  63 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
  64
  65 void sigkill_wait(pid_t pid);
  66 void sigkill_waitp(pid_t *pid);
  67
  68 int kill_and_sigcont(pid_t pid, int sig);
  69
  70 int rename_process(const char name[]);
  71 int is_kernel_thread(pid_t pid);
  72
  73 int getenv_for_pid(pid_t pid, const char *field, char **_value);
  74
  75 bool pid_is_alive(pid_t pid);
  76 bool pid_is_unwaited(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 #define PTR_TO_PID(p) ((pid_t) ((uintptr_t) p))
 108 #define PID_TO_PTR(p) ((void*) ((uintptr_t) p))
 109
 110 void valgrind_summary_hack(void);
 111
 112 int pid_compare_func(const void *a, const void *b);
 113
 114 static inline bool nice_is_valid(int n) {
 115         return n >= PRIO_MIN && n < PRIO_MAX;
 116 }
 117
 118 static inline bool sched_policy_is_valid(int i) {
 119         return IN_SET(i, SCHED_OTHER, SCHED_BATCH, SCHED_IDLE, SCHED_FIFO, SCHED_RR);
 120 }
 121
 122 static inline bool sched_priority_is_valid(int i) {
 123         return i >= 0 && i <= sched_get_priority_max(SCHED_RR);
 124 }
 125
 126 static inline bool ioprio_class_is_valid(int i) {
 127         return IN_SET(i, IOPRIO_CLASS_NONE, IOPRIO_CLASS_RT, IOPRIO_CLASS_BE, IOPRIO_CLASS_IDLE);
 128 }
 129
 130 static inline bool ioprio_priority_is_valid(int i) {
 131         return i >= 0 && i < IOPRIO_BE_NR;
 132 }
 133
 134 static inline bool pid_is_valid(pid_t p) {
 135         return p > 0;
 136 }
 137
 138 int ioprio_parse_priority(const char *s, int *ret);
 139
 140 pid_t getpid_cached(void);
 141
 142 int must_be_root(void);