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