1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include <sys/statfs.h>
12 //#include "hashmap.h"
16 #if 0 /// elogind has them set through config.h
17 #define SYSTEMD_CGROUP_CONTROLLER_LEGACY "name=systemd"
18 #define SYSTEMD_CGROUP_CONTROLLER_HYBRID "name=unified"
19 #define SYSTEMD_CGROUP_CONTROLLER "_systemd"
22 /* An enum of well known cgroup controllers */
23 typedef enum CGroupController {
24 CGROUP_CONTROLLER_CPU,
25 CGROUP_CONTROLLER_CPUACCT, /* v1 only */
26 CGROUP_CONTROLLER_IO, /* v2 only */
27 CGROUP_CONTROLLER_BLKIO, /* v1 only */
28 CGROUP_CONTROLLER_MEMORY,
29 CGROUP_CONTROLLER_DEVICES, /* v1 only */
30 CGROUP_CONTROLLER_PIDS,
31 _CGROUP_CONTROLLER_MAX,
32 _CGROUP_CONTROLLER_INVALID = -1,
35 #define CGROUP_CONTROLLER_TO_MASK(c) (1 << (c))
37 /* A bit mask of well known cgroup controllers */
38 typedef enum CGroupMask {
39 CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
40 CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
41 CGROUP_MASK_IO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_IO),
42 CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
43 CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
44 CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
45 CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
46 _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1
49 /* Special values for all weight knobs on unified hierarchy */
50 #define CGROUP_WEIGHT_INVALID ((uint64_t) -1)
51 #define CGROUP_WEIGHT_MIN UINT64_C(1)
52 #define CGROUP_WEIGHT_MAX UINT64_C(10000)
53 #define CGROUP_WEIGHT_DEFAULT UINT64_C(100)
55 #define CGROUP_LIMIT_MIN UINT64_C(0)
56 #define CGROUP_LIMIT_MAX ((uint64_t) -1)
58 #if 0 /// UNNEEDED by elogind
59 static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) {
61 x == CGROUP_WEIGHT_INVALID ||
62 (x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX);
65 /* IO limits on unified hierarchy */
66 typedef enum CGroupIOLimitType {
72 _CGROUP_IO_LIMIT_TYPE_MAX,
73 _CGROUP_IO_LIMIT_TYPE_INVALID = -1
76 extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX];
78 const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_;
79 CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_;
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)
88 #if 0 /// UNNEEDED by elogind
89 static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
91 x == CGROUP_CPU_SHARES_INVALID ||
92 (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
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)
102 #if 0 /// UNNEEDED by elogind
103 static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
105 x == CGROUP_BLKIO_WEIGHT_INVALID ||
106 (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
110 /* Default resource limits */
111 #define DEFAULT_TASKS_MAX_PERCENTAGE 15U /* 15% of PIDs, 4915 on default settings */
112 #define DEFAULT_USER_TASKS_MAX_PERCENTAGE 33U /* 33% of PIDs, 10813 on default settings */
114 typedef enum CGroupUnified {
115 CGROUP_UNIFIED_UNKNOWN = -1,
116 CGROUP_UNIFIED_NONE = 0, /* Both systemd and controllers on legacy */
117 CGROUP_UNIFIED_SYSTEMD = 1, /* Only systemd on unified */
118 CGROUP_UNIFIED_ALL = 2, /* Both systemd and controllers on unified */
124 * We accept named hierarchies in the syntax "foo" and "name=foo".
126 * We expect that named hierarchies do not conflict in name with a
127 * kernel hierarchy, modulo the "name=" prefix.
129 * We always generate "normalized" controller names, i.e. without the
132 * We require absolute cgroup paths. When returning, we will always
133 * generate paths with multiple adjacent / removed.
136 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
137 int cg_read_pid(FILE *f, pid_t *_pid);
138 int cg_read_event(const char *controller, const char *path, const char *event,
141 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
142 int cg_read_subgroup(DIR *d, char **fn);
144 typedef enum CGroupFlags {
146 CGROUP_IGNORE_SELF = 2,
150 typedef void (*cg_kill_log_func_t)(pid_t pid, int sig, void *userdata);
152 int cg_kill(const char *controller, const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata);
153 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);
155 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
156 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
157 int cg_migrate_recursive_fallback(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
159 int cg_split_spec(const char *spec, char **controller, char **path);
160 int cg_mangle_path(const char *path, char **result);
162 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
163 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
165 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
167 int cg_trim(const char *controller, const char *path, bool delete_root);
169 int cg_rmdir(const char *controller, const char *path);
171 int cg_create(const char *controller, const char *path);
172 int cg_attach(const char *controller, const char *path, pid_t pid);
173 int cg_attach_fallback(const char *controller, const char *path, pid_t pid);
174 int cg_create_and_attach(const char *controller, const char *path, pid_t pid);
176 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
177 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
178 #if 0 /// UNNEEDED by elogind
179 int cg_get_keyed_attribute(const char *controller, const char *path, const char *attribute, char **keys, char **values);
181 int cg_set_access(const char *controller, const char *path, uid_t uid, gid_t gid);
183 int cg_set_xattr(const char *controller, const char *path, const char *name, const void *value, size_t size, int flags);
184 int cg_get_xattr(const char *controller, const char *path, const char *name, void *value, size_t size);
186 int cg_install_release_agent(const char *controller, const char *agent);
187 int cg_uninstall_release_agent(const char *controller);
190 int cg_is_empty(const char *controller, const char *path);
191 int cg_is_empty_recursive(const char *controller, const char *path);
193 int cg_get_root_path(char **path);
195 int cg_path_get_session(const char *path, char **session);
196 int cg_path_get_owner_uid(const char *path, uid_t *uid);
197 int cg_path_get_unit(const char *path, char **unit);
198 #if 0 /// UNNEEDED by elogind
199 int cg_path_get_user_unit(const char *path, char **unit);
200 int cg_path_get_machine_name(const char *path, char **machine);
202 int cg_path_get_slice(const char *path, char **slice);
203 int cg_path_get_user_slice(const char *path, char **slice);
205 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
206 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
208 int cg_pid_get_session(pid_t pid, char **session);
209 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid);
210 int cg_pid_get_unit(pid_t pid, char **unit);
211 #if 0 /// UNNEEDED by elogind
212 int cg_pid_get_user_unit(pid_t pid, char **unit);
213 int cg_pid_get_machine_name(pid_t pid, char **machine);
215 int cg_pid_get_slice(pid_t pid, char **slice);
216 int cg_pid_get_user_slice(pid_t pid, char **slice);
218 int cg_path_decode_unit(const char *cgroup, char **unit);
220 char *cg_escape(const char *p);
221 char *cg_unescape(const char *p) _pure_;
223 bool cg_controller_is_valid(const char *p);
225 #if 0 /// UNNEEDED by elogind
226 int cg_slice_to_path(const char *unit, char **ret);
228 typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata);
230 int cg_create_everywhere(CGroupMask supported, CGroupMask mask, const char *path);
231 int cg_attach_everywhere(CGroupMask supported, const char *path, pid_t pid, cg_migrate_callback_t callback, void *userdata);
232 int cg_attach_many_everywhere(CGroupMask supported, const char *path, Set* pids, cg_migrate_callback_t callback, void *userdata);
233 int cg_migrate_everywhere(CGroupMask supported, const char *from, const char *to, cg_migrate_callback_t callback, void *userdata);
234 int cg_trim_everywhere(CGroupMask supported, const char *path, bool delete_root);
235 int cg_enable_everywhere(CGroupMask supported, CGroupMask mask, const char *p);
238 int cg_mask_supported(CGroupMask *ret);
239 int cg_mask_from_string(const char *s, CGroupMask *ret);
240 int cg_mask_to_string(CGroupMask mask, char **ret);
242 #if 0 /// UNNEEDED by elogind
243 int cg_kernel_controllers(Set **controllers);
245 bool cg_ns_supported(void);
248 int cg_all_unified(void);
249 int cg_hybrid_unified(void);
250 int cg_unified_controller(const char *controller);
251 int cg_unified_flush(void);
253 bool cg_is_unified_wanted(void);
254 bool cg_is_legacy_wanted(void);
255 bool cg_is_hybrid_wanted(void);
257 const char* cgroup_controller_to_string(CGroupController c) _const_;
258 CGroupController cgroup_controller_from_string(const char *s) _pure_;
260 #if 0 /// UNNEEDED by elogind
261 int cg_weight_parse(const char *s, uint64_t *ret);
262 int cg_cpu_shares_parse(const char *s, uint64_t *ret);
263 int cg_blkio_weight_parse(const char *s, uint64_t *ret);
266 bool is_cgroup_fs(const struct statfs *s);
267 bool fd_is_cgroup_fs(int fd);