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