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