4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 #include <sys/statfs.h>
27 #include <sys/types.h>
30 //#include "hashmap.h"
34 /* An enum of well known cgroup controllers */
35 typedef enum CGroupController {
36 CGROUP_CONTROLLER_CPU,
37 CGROUP_CONTROLLER_CPUACCT,
39 CGROUP_CONTROLLER_BLKIO,
40 CGROUP_CONTROLLER_MEMORY,
41 CGROUP_CONTROLLER_DEVICES,
42 CGROUP_CONTROLLER_PIDS,
43 _CGROUP_CONTROLLER_MAX,
44 _CGROUP_CONTROLLER_INVALID = -1,
47 #define CGROUP_CONTROLLER_TO_MASK(c) (1 << (c))
49 /* A bit mask of well known cgroup controllers */
50 typedef enum CGroupMask {
51 CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
52 CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
53 CGROUP_MASK_IO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_IO),
54 CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
55 CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
56 CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
57 CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
58 _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1
61 /* Special values for all weight knobs on unified hierarchy */
62 #define CGROUP_WEIGHT_INVALID ((uint64_t) -1)
63 #define CGROUP_WEIGHT_MIN UINT64_C(1)
64 #define CGROUP_WEIGHT_MAX UINT64_C(10000)
65 #define CGROUP_WEIGHT_DEFAULT UINT64_C(100)
67 #define CGROUP_LIMIT_MIN UINT64_C(0)
68 #define CGROUP_LIMIT_MAX ((uint64_t) -1)
70 #if 0 /// UNNEEDED by elogind
71 static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) {
73 x == CGROUP_WEIGHT_INVALID ||
74 (x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX);
77 /* IO limits on unified hierarchy */
78 typedef enum CGroupIOLimitType {
84 _CGROUP_IO_LIMIT_TYPE_MAX,
85 _CGROUP_IO_LIMIT_TYPE_INVALID = -1
88 extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX];
90 const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_;
91 CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_;
94 /* Special values for the cpu.shares attribute */
95 #define CGROUP_CPU_SHARES_INVALID ((uint64_t) -1)
96 #define CGROUP_CPU_SHARES_MIN UINT64_C(2)
97 #define CGROUP_CPU_SHARES_MAX UINT64_C(262144)
98 #define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024)
100 #if 0 /// UNNEEDED by elogind
101 static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
103 x == CGROUP_CPU_SHARES_INVALID ||
104 (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
108 /* Special values for the blkio.weight attribute */
109 #define CGROUP_BLKIO_WEIGHT_INVALID ((uint64_t) -1)
110 #define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
111 #define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
112 #define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)
114 #if 0 /// UNNEEDED by elogind
115 static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
117 x == CGROUP_BLKIO_WEIGHT_INVALID ||
118 (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
122 /* Default resource limits */
123 #define DEFAULT_TASKS_MAX_PERCENTAGE 15U /* 15% of PIDs, 4915 on default settings */
124 #define DEFAULT_USER_TASKS_MAX_PERCENTAGE 33U /* 33% of PIDs, 10813 on default settings */
126 typedef enum CGroupUnified {
127 CGROUP_UNIFIED_UNKNOWN = -1,
128 CGROUP_UNIFIED_NONE = 0, /* Both systemd and controllers on legacy */
129 CGROUP_UNIFIED_SYSTEMD = 1, /* Only systemd on unified */
130 CGROUP_UNIFIED_ALL = 2, /* Both systemd and controllers on unified */
136 * We accept named hierarchies in the syntax "foo" and "name=foo".
138 * We expect that named hierarchies do not conflict in name with a
139 * kernel hierarchy, modulo the "name=" prefix.
141 * We always generate "normalized" controller names, i.e. without the
144 * We require absolute cgroup paths. When returning, we will always
145 * generate paths with multiple adjacent / removed.
148 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
149 int cg_read_pid(FILE *f, pid_t *_pid);
150 int cg_read_event(const char *controller, const char *path, const char *event,
153 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
154 int cg_read_subgroup(DIR *d, char **fn);
156 typedef enum CGroupFlags {
158 CGROUP_IGNORE_SELF = 2,
162 typedef void (*cg_kill_log_func_t)(pid_t pid, int sig, void *userdata);
164 int cg_kill(const char *controller, const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata);
165 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);
167 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
168 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
169 int cg_migrate_recursive_fallback(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
171 int cg_split_spec(const char *spec, char **controller, char **path);
172 int cg_mangle_path(const char *path, char **result);
174 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
175 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
177 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
179 int cg_trim(const char *controller, const char *path, bool delete_root);
181 int cg_rmdir(const char *controller, const char *path);
183 int cg_create(const char *controller, const char *path);
184 int cg_attach(const char *controller, const char *path, pid_t pid);
185 int cg_attach_fallback(const char *controller, const char *path, pid_t pid);
186 int cg_create_and_attach(const char *controller, const char *path, pid_t pid);
188 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
189 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
190 #if 0 /// UNNEEDED by elogind
191 int cg_get_keyed_attribute(const char *controller, const char *path, const char *attribute, const char **keys, char **values);
193 int cg_set_group_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
194 int cg_set_task_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
196 int cg_set_xattr(const char *controller, const char *path, const char *name, const void *value, size_t size, int flags);
197 int cg_get_xattr(const char *controller, const char *path, const char *name, void *value, size_t size);
199 int cg_install_release_agent(const char *controller, const char *agent);
200 int cg_uninstall_release_agent(const char *controller);
203 int cg_is_empty(const char *controller, const char *path);
204 int cg_is_empty_recursive(const char *controller, const char *path);
206 int cg_get_root_path(char **path);
208 int cg_path_get_session(const char *path, char **session);
209 #if 0 /// UNNEEDED by elogind
210 int cg_path_get_owner_uid(const char *path, uid_t *uid);
211 int cg_path_get_unit(const char *path, char **unit);
212 int cg_path_get_user_unit(const char *path, char **unit);
213 int cg_path_get_machine_name(const char *path, char **machine);
214 int cg_path_get_slice(const char *path, char **slice);
215 int cg_path_get_user_slice(const char *path, char **slice);
218 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
219 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
221 int cg_pid_get_session(pid_t pid, char **session);
222 #if 0 /// UNNEEDED by elogind
223 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid);
224 int cg_pid_get_unit(pid_t pid, char **unit);
225 int cg_pid_get_user_unit(pid_t pid, char **unit);
226 int cg_pid_get_machine_name(pid_t pid, char **machine);
227 int cg_pid_get_slice(pid_t pid, char **slice);
228 int cg_pid_get_user_slice(pid_t pid, char **slice);
230 int cg_path_decode_unit(const char *cgroup, char **unit);
233 char *cg_escape(const char *p);
234 char *cg_unescape(const char *p) _pure_;
236 bool cg_controller_is_valid(const char *p);
238 #if 0 /// UNNEEDED by elogind
239 int cg_slice_to_path(const char *unit, char **ret);
241 typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata);
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);
248 int cg_enable_everywhere(CGroupMask supported, CGroupMask mask, const char *p);
251 int cg_mask_supported(CGroupMask *ret);
252 int cg_mask_from_string(const char *s, CGroupMask *ret);
253 int cg_mask_to_string(CGroupMask mask, char **ret);
255 #if 0 /// UNNEEDED by elogind
256 int cg_kernel_controllers(Set *controllers);
258 bool cg_ns_supported(void);
261 int cg_all_unified(void);
262 int cg_hybrid_unified(void);
263 int cg_unified_controller(const char *controller);
264 int cg_unified_flush(void);
266 bool cg_is_unified_wanted(void);
267 bool cg_is_legacy_wanted(void);
268 bool cg_is_hybrid_wanted(void);
270 const char* cgroup_controller_to_string(CGroupController c) _const_;
271 CGroupController cgroup_controller_from_string(const char *s) _pure_;
273 #if 0 /// UNNEEDED by elogind
274 int cg_weight_parse(const char *s, uint64_t *ret);
275 int cg_cpu_shares_parse(const char *s, uint64_t *ret);
276 int cg_blkio_weight_parse(const char *s, uint64_t *ret);
279 bool is_cgroup_fs(const struct statfs *s);
280 bool fd_is_cgroup_fs(int fd);