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