]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
c2f1db8f | 2 | #pragma once |
8c6db833 | 3 | |
35d2e7ec | 4 | #include <dirent.h> |
11c3a366 TA |
5 | #include <stdbool.h> |
6 | #include <stdint.h> | |
71d35b6b | 7 | #include <stdio.h> |
f0bef277 | 8 | #include <sys/statfs.h> |
71d35b6b | 9 | #include <sys/types.h> |
c6c18be3 | 10 | |
f6a6225e | 11 | #include "def.h" |
93cc7779 | 12 | #include "set.h" |
8c6db833 | 13 | |
68ac0d05 LP |
14 | #define SYSTEMD_CGROUP_CONTROLLER_LEGACY "name=systemd" |
15 | #define SYSTEMD_CGROUP_CONTROLLER_HYBRID "name=unified" | |
16 | #define SYSTEMD_CGROUP_CONTROLLER "_systemd" | |
17 | ||
efdb0237 LP |
18 | /* An enum of well known cgroup controllers */ |
19 | typedef enum CGroupController { | |
17f14955 | 20 | /* Original cgroup controllers */ |
efdb0237 | 21 | CGROUP_CONTROLLER_CPU, |
00b4a247 | 22 | CGROUP_CONTROLLER_CPUACCT, /* v1 only */ |
047f5d63 | 23 | CGROUP_CONTROLLER_CPUSET, /* v2 only */ |
00b4a247 LP |
24 | CGROUP_CONTROLLER_IO, /* v2 only */ |
25 | CGROUP_CONTROLLER_BLKIO, /* v1 only */ | |
efdb0237 | 26 | CGROUP_CONTROLLER_MEMORY, |
00b4a247 | 27 | CGROUP_CONTROLLER_DEVICES, /* v1 only */ |
03a7b521 | 28 | CGROUP_CONTROLLER_PIDS, |
17f14955 RG |
29 | |
30 | /* BPF-based pseudo-controllers, v2 only */ | |
31 | CGROUP_CONTROLLER_BPF_FIREWALL, | |
084c7007 | 32 | CGROUP_CONTROLLER_BPF_DEVICES, |
17f14955 | 33 | |
efdb0237 | 34 | _CGROUP_CONTROLLER_MAX, |
2d93c20e | 35 | _CGROUP_CONTROLLER_INVALID = -EINVAL, |
efdb0237 LP |
36 | } CGroupController; |
37 | ||
46f84f95 | 38 | #define CGROUP_CONTROLLER_TO_MASK(c) (1U << (c)) |
efdb0237 | 39 | |
4ad49000 | 40 | /* A bit mask of well known cgroup controllers */ |
efdb0237 LP |
41 | typedef enum CGroupMask { |
42 | CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU), | |
43 | CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT), | |
047f5d63 | 44 | CGROUP_MASK_CPUSET = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUSET), |
13c31542 | 45 | CGROUP_MASK_IO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_IO), |
efdb0237 LP |
46 | CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO), |
47 | CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY), | |
3905f127 | 48 | CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES), |
03a7b521 | 49 | CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS), |
17f14955 | 50 | CGROUP_MASK_BPF_FIREWALL = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FIREWALL), |
084c7007 | 51 | CGROUP_MASK_BPF_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_DEVICES), |
4edd65e4 | 52 | |
4e1dfa45 | 53 | /* All real cgroup v1 controllers */ |
4edd65e4 LP |
54 | CGROUP_MASK_V1 = CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT|CGROUP_MASK_BLKIO|CGROUP_MASK_MEMORY|CGROUP_MASK_DEVICES|CGROUP_MASK_PIDS, |
55 | ||
4e1dfa45 | 56 | /* All real cgroup v2 controllers */ |
047f5d63 | 57 | CGROUP_MASK_V2 = CGROUP_MASK_CPU|CGROUP_MASK_CPUSET|CGROUP_MASK_IO|CGROUP_MASK_MEMORY|CGROUP_MASK_PIDS, |
4edd65e4 | 58 | |
4e1dfa45 | 59 | /* All cgroup v2 BPF pseudo-controllers */ |
4edd65e4 LP |
60 | CGROUP_MASK_BPF = CGROUP_MASK_BPF_FIREWALL|CGROUP_MASK_BPF_DEVICES, |
61 | ||
efdb0237 LP |
62 | _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1 |
63 | } CGroupMask; | |
4ad49000 | 64 | |
c01ef321 LP |
65 | static inline CGroupMask CGROUP_MASK_EXTEND_JOINED(CGroupMask mask) { |
66 | /* We always mount "cpu" and "cpuacct" in the same hierarchy. Hence, when one bit is set also set the other */ | |
67 | ||
68 | if (mask & (CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT)) | |
69 | mask |= (CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT); | |
70 | ||
71 | return mask; | |
72 | } | |
73 | ||
f98c2585 CD |
74 | CGroupMask get_cpu_accounting_mask(void); |
75 | bool cpu_accounting_is_cheap(void); | |
76 | ||
13c31542 TH |
77 | /* Special values for all weight knobs on unified hierarchy */ |
78 | #define CGROUP_WEIGHT_INVALID ((uint64_t) -1) | |
79 | #define CGROUP_WEIGHT_MIN UINT64_C(1) | |
80 | #define CGROUP_WEIGHT_MAX UINT64_C(10000) | |
81 | #define CGROUP_WEIGHT_DEFAULT UINT64_C(100) | |
82 | ||
83 | #define CGROUP_LIMIT_MIN UINT64_C(0) | |
84 | #define CGROUP_LIMIT_MAX ((uint64_t) -1) | |
85 | ||
86 | static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) { | |
87 | return | |
88 | x == CGROUP_WEIGHT_INVALID || | |
89 | (x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX); | |
90 | } | |
91 | ||
9be57249 TH |
92 | /* IO limits on unified hierarchy */ |
93 | typedef enum CGroupIOLimitType { | |
94 | CGROUP_IO_RBPS_MAX, | |
95 | CGROUP_IO_WBPS_MAX, | |
ac06a0cf TH |
96 | CGROUP_IO_RIOPS_MAX, |
97 | CGROUP_IO_WIOPS_MAX, | |
9be57249 TH |
98 | |
99 | _CGROUP_IO_LIMIT_TYPE_MAX, | |
2d93c20e | 100 | _CGROUP_IO_LIMIT_TYPE_INVALID = -EINVAL, |
9be57249 TH |
101 | } CGroupIOLimitType; |
102 | ||
103 | extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX]; | |
104 | ||
105 | const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_; | |
106 | CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_; | |
107 | ||
d53d9474 LP |
108 | /* Special values for the cpu.shares attribute */ |
109 | #define CGROUP_CPU_SHARES_INVALID ((uint64_t) -1) | |
110 | #define CGROUP_CPU_SHARES_MIN UINT64_C(2) | |
111 | #define CGROUP_CPU_SHARES_MAX UINT64_C(262144) | |
112 | #define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024) | |
113 | ||
114 | static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) { | |
115 | return | |
116 | x == CGROUP_CPU_SHARES_INVALID || | |
117 | (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX); | |
118 | } | |
119 | ||
120 | /* Special values for the blkio.weight attribute */ | |
121 | #define CGROUP_BLKIO_WEIGHT_INVALID ((uint64_t) -1) | |
122 | #define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10) | |
123 | #define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000) | |
124 | #define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500) | |
125 | ||
126 | static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) { | |
127 | return | |
128 | x == CGROUP_BLKIO_WEIGHT_INVALID || | |
129 | (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX); | |
130 | } | |
131 | ||
5da38d07 TH |
132 | typedef enum CGroupUnified { |
133 | CGROUP_UNIFIED_UNKNOWN = -1, | |
134 | CGROUP_UNIFIED_NONE = 0, /* Both systemd and controllers on legacy */ | |
135 | CGROUP_UNIFIED_SYSTEMD = 1, /* Only systemd on unified */ | |
136 | CGROUP_UNIFIED_ALL = 2, /* Both systemd and controllers on unified */ | |
137 | } CGroupUnified; | |
138 | ||
5954c074 LP |
139 | /* |
140 | * General rules: | |
141 | * | |
142 | * We accept named hierarchies in the syntax "foo" and "name=foo". | |
143 | * | |
144 | * We expect that named hierarchies do not conflict in name with a | |
145 | * kernel hierarchy, modulo the "name=" prefix. | |
146 | * | |
147 | * We always generate "normalized" controller names, i.e. without the | |
148 | * "name=" prefix. | |
149 | * | |
150 | * We require absolute cgroup paths. When returning, we will always | |
151 | * generate paths with multiple adjacent / removed. | |
152 | */ | |
153 | ||
c6c18be3 | 154 | int cg_enumerate_processes(const char *controller, const char *path, FILE **_f); |
c6c18be3 | 155 | int cg_read_pid(FILE *f, pid_t *_pid); |
ab2c3861 TH |
156 | int cg_read_event(const char *controller, const char *path, const char *event, |
157 | char **val); | |
c6c18be3 | 158 | |
35d2e7ec LP |
159 | int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d); |
160 | int cg_read_subgroup(DIR *d, char **fn); | |
161 | ||
1d98fef1 | 162 | typedef enum CGroupFlags { |
be0b7a1a LP |
163 | CGROUP_SIGCONT = 1 << 0, |
164 | CGROUP_IGNORE_SELF = 1 << 1, | |
165 | CGROUP_REMOVE = 1 << 2, | |
1d98fef1 | 166 | } CGroupFlags; |
8c6db833 | 167 | |
c53d2d54 | 168 | typedef int (*cg_kill_log_func_t)(pid_t pid, int sig, void *userdata); |
1d98fef1 LP |
169 | |
170 | int cg_kill(const char *controller, const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata); | |
171 | int cg_kill_recursive(const char *controller, const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata); | |
172 | ||
2a8020fe | 173 | int cg_split_spec(const char *spec, char **ret_controller, char **ret_path); |
7027ff61 | 174 | int cg_mangle_path(const char *path, char **result); |
8c6db833 LP |
175 | |
176 | int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs); | |
3474ae3c | 177 | int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs); |
7027ff61 LP |
178 | |
179 | int cg_pid_get_path(const char *controller, pid_t pid, char **path); | |
8c6db833 | 180 | |
4ad49000 | 181 | int cg_rmdir(const char *controller, const char *path); |
8c6db833 | 182 | |
25a1f04c MS |
183 | typedef enum { |
184 | CG_KEY_MODE_GRACEFUL = 1 << 0, | |
185 | } CGroupKeyMode; | |
186 | ||
4ad49000 | 187 | int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value); |
934277fe | 188 | int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret); |
25a1f04c MS |
189 | int cg_get_keyed_attribute_full(const char *controller, const char *path, const char *attribute, char **keys, char **values, CGroupKeyMode mode); |
190 | ||
191 | static inline int cg_get_keyed_attribute( | |
192 | const char *controller, | |
193 | const char *path, | |
194 | const char *attribute, | |
195 | char **keys, | |
196 | char **ret_values) { | |
197 | return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, 0); | |
198 | } | |
199 | ||
200 | static inline int cg_get_keyed_attribute_graceful( | |
201 | const char *controller, | |
202 | const char *path, | |
203 | const char *attribute, | |
204 | char **keys, | |
205 | char **ret_values) { | |
206 | return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, CG_KEY_MODE_GRACEFUL); | |
207 | } | |
4ad49000 | 208 | |
613328c3 AZ |
209 | int cg_get_attribute_as_uint64(const char *controller, const char *path, const char *attribute, uint64_t *ret); |
210 | ||
b41dcc51 AZ |
211 | /* Does a parse_boolean() on the attribute contents and sets ret accordingly */ |
212 | int cg_get_attribute_as_bool(const char *controller, const char *path, const char *attribute, bool *ret); | |
213 | ||
62b9bb26 | 214 | int cg_set_access(const char *controller, const char *path, uid_t uid, gid_t gid); |
8c6db833 | 215 | |
4b58153d LP |
216 | int cg_set_xattr(const char *controller, const char *path, const char *name, const void *value, size_t size, int flags); |
217 | int cg_get_xattr(const char *controller, const char *path, const char *name, void *value, size_t size); | |
baa358df | 218 | int cg_get_xattr_malloc(const char *controller, const char *path, const char *name, char **ret); |
bf25f165 | 219 | int cg_remove_xattr(const char *controller, const char *path, const char *name); |
4b58153d | 220 | |
8c6db833 | 221 | int cg_install_release_agent(const char *controller, const char *agent); |
ad929bcc | 222 | int cg_uninstall_release_agent(const char *controller); |
8c6db833 | 223 | |
6f883237 LP |
224 | int cg_is_empty(const char *controller, const char *path); |
225 | int cg_is_empty_recursive(const char *controller, const char *path); | |
8c6db833 | 226 | |
7027ff61 | 227 | int cg_get_root_path(char **path); |
6c03089c | 228 | |
7027ff61 | 229 | int cg_path_get_session(const char *path, char **session); |
ae018d9b | 230 | int cg_path_get_owner_uid(const char *path, uid_t *uid); |
6c03089c LP |
231 | int cg_path_get_unit(const char *path, char **unit); |
232 | int cg_path_get_user_unit(const char *path, char **unit); | |
7027ff61 | 233 | int cg_path_get_machine_name(const char *path, char **machine); |
1021b21b | 234 | int cg_path_get_slice(const char *path, char **slice); |
329ac4bc | 235 | int cg_path_get_user_slice(const char *path, char **slice); |
7027ff61 | 236 | |
751bc6ac | 237 | int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted); |
e9174f29 | 238 | int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup); |
6c03089c | 239 | |
7027ff61 | 240 | int cg_pid_get_session(pid_t pid, char **session); |
ae018d9b | 241 | int cg_pid_get_owner_uid(pid_t pid, uid_t *uid); |
ba1261bc | 242 | int cg_pid_get_unit(pid_t pid, char **unit); |
ef1673d1 | 243 | int cg_pid_get_user_unit(pid_t pid, char **unit); |
7027ff61 | 244 | int cg_pid_get_machine_name(pid_t pid, char **machine); |
1021b21b | 245 | int cg_pid_get_slice(pid_t pid, char **slice); |
329ac4bc | 246 | int cg_pid_get_user_slice(pid_t pid, char **slice); |
1f73f0f1 | 247 | |
7027ff61 | 248 | int cg_path_decode_unit(const char *cgroup, char **unit); |
96cde13a | 249 | |
ae018d9b | 250 | char *cg_escape(const char *p); |
44a6b1b6 | 251 | char *cg_unescape(const char *p) _pure_; |
78edb35a | 252 | |
185a0874 | 253 | bool cg_controller_is_valid(const char *p); |
a016b922 LP |
254 | |
255 | int cg_slice_to_path(const char *unit, char **ret); | |
4ad49000 | 256 | |
efdb0237 | 257 | typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata); |
03b90d4b | 258 | |
efdb0237 | 259 | int cg_mask_supported(CGroupMask *ret); |
aae7e17f FB |
260 | int cg_mask_from_string(const char *s, CGroupMask *ret); |
261 | int cg_mask_to_string(CGroupMask mask, char **ret); | |
b12afc8c | 262 | |
6925a0de | 263 | int cg_kernel_controllers(Set **controllers); |
efdb0237 | 264 | |
3228995c | 265 | bool cg_ns_supported(void); |
d9e45bc3 | 266 | bool cg_freezer_supported(void); |
3228995c | 267 | |
b4cccbc1 LP |
268 | int cg_all_unified(void); |
269 | int cg_hybrid_unified(void); | |
c22800e4 | 270 | int cg_unified_controller(const char *controller); |
d4d99bc6 ZJS |
271 | int cg_unified_cached(bool flush); |
272 | static inline int cg_unified(void) { | |
273 | return cg_unified_cached(true); | |
274 | } | |
efdb0237 LP |
275 | |
276 | const char* cgroup_controller_to_string(CGroupController c) _const_; | |
277 | CGroupController cgroup_controller_from_string(const char *s) _pure_; | |
d53d9474 | 278 | |
f0bef277 EV |
279 | bool is_cgroup_fs(const struct statfs *s); |
280 | bool fd_is_cgroup_fs(int fd); | |
4d824a4e AZ |
281 | |
282 | typedef enum ManagedOOMMode { | |
283 | MANAGED_OOM_AUTO, | |
284 | MANAGED_OOM_KILL, | |
285 | _MANAGED_OOM_MODE_MAX, | |
2d93c20e | 286 | _MANAGED_OOM_MODE_INVALID = -EINVAL, |
4d824a4e AZ |
287 | } ManagedOOMMode; |
288 | ||
289 | const char* managed_oom_mode_to_string(ManagedOOMMode m) _const_; | |
290 | ManagedOOMMode managed_oom_mode_from_string(const char *s) _pure_; |