chiark / gitweb /
tests: add tests for environment serialization
[elogind.git] / src / basic / cgroup-util.h
1 #pragma once
2
3 /***
4   This file is part of systemd.
5
6   Copyright 2010 Lennart Poettering
7
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.
12
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.
17
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/>.
20 ***/
21
22 #include <dirent.h>
23 #include <stdbool.h>
24 #include <stdint.h>
25 #include <stdio.h>
26 #include <sys/types.h>
27
28 #include "def.h"
29 //#include "hashmap.h"
30 //#include "macro.h"
31 #include "set.h"
32
33 /* An enum of well known cgroup controllers */
34 typedef enum CGroupController {
35         CGROUP_CONTROLLER_CPU,
36         CGROUP_CONTROLLER_CPUACCT,
37         CGROUP_CONTROLLER_IO,
38         CGROUP_CONTROLLER_BLKIO,
39         CGROUP_CONTROLLER_MEMORY,
40         CGROUP_CONTROLLER_DEVICES,
41         CGROUP_CONTROLLER_PIDS,
42         _CGROUP_CONTROLLER_MAX,
43         _CGROUP_CONTROLLER_INVALID = -1,
44 } CGroupController;
45
46 #define CGROUP_CONTROLLER_TO_MASK(c) (1 << (c))
47
48 /* A bit mask of well known cgroup controllers */
49 typedef enum CGroupMask {
50         CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
51         CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
52         CGROUP_MASK_IO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_IO),
53         CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
54         CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
55         CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
56         CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
57         _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1
58 } CGroupMask;
59
60 #if 0 /// UNNEEDED by elogind
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)
66 #endif // 0
67
68 #define CGROUP_LIMIT_MIN UINT64_C(0)
69 #define CGROUP_LIMIT_MAX ((uint64_t) -1)
70
71 #if 0 /// UNNEEDED by elogind
72 static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) {
73         return
74             x == CGROUP_WEIGHT_INVALID ||
75             (x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX);
76 }
77
78 /* IO limits on unified hierarchy */
79 typedef enum CGroupIOLimitType {
80         CGROUP_IO_RBPS_MAX,
81         CGROUP_IO_WBPS_MAX,
82         CGROUP_IO_RIOPS_MAX,
83         CGROUP_IO_WIOPS_MAX,
84
85         _CGROUP_IO_LIMIT_TYPE_MAX,
86         _CGROUP_IO_LIMIT_TYPE_INVALID = -1
87 } CGroupIOLimitType;
88
89 extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX];
90
91 const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_;
92 CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_;
93
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)
99
100 static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
101         return
102             x == CGROUP_CPU_SHARES_INVALID ||
103             (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
104 }
105
106 /* Special values for the blkio.weight attribute */
107 #define CGROUP_BLKIO_WEIGHT_INVALID ((uint64_t) -1)
108 #define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
109 #define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
110 #define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)
111
112 static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
113         return
114             x == CGROUP_BLKIO_WEIGHT_INVALID ||
115             (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
116 }
117 #endif // 0
118
119 /* Default resource limits */
120 #define DEFAULT_TASKS_MAX_PERCENTAGE            15U /* 15% of PIDs, 4915 on default settings */
121 #define DEFAULT_USER_TASKS_MAX_PERCENTAGE       33U /* 33% of PIDs, 10813 on default settings */
122
123 typedef enum CGroupUnified {
124         CGROUP_UNIFIED_UNKNOWN = -1,
125         CGROUP_UNIFIED_NONE = 0,        /* Both systemd and controllers on legacy */
126         CGROUP_UNIFIED_SYSTEMD = 1,     /* Only systemd on unified */
127         CGROUP_UNIFIED_ALL = 2,         /* Both systemd and controllers on unified */
128 } CGroupUnified;
129
130 /*
131  * General rules:
132  *
133  * We accept named hierarchies in the syntax "foo" and "name=foo".
134  *
135  * We expect that named hierarchies do not conflict in name with a
136  * kernel hierarchy, modulo the "name=" prefix.
137  *
138  * We always generate "normalized" controller names, i.e. without the
139  * "name=" prefix.
140  *
141  * We require absolute cgroup paths. When returning, we will always
142  * generate paths with multiple adjacent / removed.
143  */
144
145 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
146 int cg_read_pid(FILE *f, pid_t *_pid);
147 int cg_read_event(const char *controller, const char *path, const char *event,
148                   char **val);
149
150 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
151 int cg_read_subgroup(DIR *d, char **fn);
152
153 typedef enum CGroupFlags {
154         CGROUP_SIGCONT     = 1,
155         CGROUP_IGNORE_SELF = 2,
156         CGROUP_REMOVE      = 4,
157 } CGroupFlags;
158
159 typedef void (*cg_kill_log_func_t)(pid_t pid, int sig, void *userdata);
160
161 int cg_kill(const char *controller, const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata);
162 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);
163
164 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
165 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
166 int cg_migrate_recursive_fallback(const char *cfrom, const char *pfrom, const char *cto, const char *pto, CGroupFlags flags);
167
168 int cg_split_spec(const char *spec, char **controller, char **path);
169 int cg_mangle_path(const char *path, char **result);
170
171 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
172 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
173
174 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
175
176 int cg_trim(const char *controller, const char *path, bool delete_root);
177
178 int cg_rmdir(const char *controller, const char *path);
179
180 int cg_create(const char *controller, const char *path);
181 int cg_attach(const char *controller, const char *path, pid_t pid);
182 int cg_attach_fallback(const char *controller, const char *path, pid_t pid);
183 int cg_create_and_attach(const char *controller, const char *path, pid_t pid);
184
185 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
186 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
187 #if 0 /// UNNEEDED by elogind
188 int cg_get_keyed_attribute(const char *controller, const char *path, const char *attribute, const char **keys, char **values);
189
190 int cg_set_group_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
191 int cg_set_task_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
192
193 int cg_set_xattr(const char *controller, const char *path, const char *name, const void *value, size_t size, int flags);
194 int cg_get_xattr(const char *controller, const char *path, const char *name, void *value, size_t size);
195 #endif // 0
196
197 int cg_install_release_agent(const char *controller, const char *agent);
198 int cg_uninstall_release_agent(const char *controller);
199
200 int cg_is_empty(const char *controller, const char *path);
201 int cg_is_empty_recursive(const char *controller, const char *path);
202
203 int cg_get_root_path(char **path);
204
205 int cg_path_get_session(const char *path, char **session);
206 #if 0 /// UNNEEDED by elogind
207 int cg_path_get_owner_uid(const char *path, uid_t *uid);
208 int cg_path_get_unit(const char *path, char **unit);
209 int cg_path_get_user_unit(const char *path, char **unit);
210 int cg_path_get_machine_name(const char *path, char **machine);
211 int cg_path_get_slice(const char *path, char **slice);
212 int cg_path_get_user_slice(const char *path, char **slice);
213 #endif // 0
214
215 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
216 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
217
218 int cg_pid_get_session(pid_t pid, char **session);
219 #if 0 /// UNNEEDED by elogind
220 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid);
221 int cg_pid_get_unit(pid_t pid, char **unit);
222 int cg_pid_get_user_unit(pid_t pid, char **unit);
223 int cg_pid_get_machine_name(pid_t pid, char **machine);
224 int cg_pid_get_slice(pid_t pid, char **slice);
225 int cg_pid_get_user_slice(pid_t pid, char **slice);
226
227 int cg_path_decode_unit(const char *cgroup, char **unit);
228 #endif // 0
229
230 char *cg_escape(const char *p);
231 char *cg_unescape(const char *p) _pure_;
232
233 bool cg_controller_is_valid(const char *p);
234
235 #if 0 /// UNNEEDED by elogind
236 int cg_slice_to_path(const char *unit, char **ret);
237
238 typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata);
239
240 int cg_create_everywhere(CGroupMask supported, CGroupMask mask, const char *path);
241 int cg_attach_everywhere(CGroupMask supported, const char *path, pid_t pid, cg_migrate_callback_t callback, void *userdata);
242 int cg_attach_many_everywhere(CGroupMask supported, const char *path, Set* pids, cg_migrate_callback_t callback, void *userdata);
243 int cg_migrate_everywhere(CGroupMask supported, const char *from, const char *to, cg_migrate_callback_t callback, void *userdata);
244 int cg_trim_everywhere(CGroupMask supported, const char *path, bool delete_root);
245 int cg_enable_everywhere(CGroupMask supported, CGroupMask mask, const char *p);
246 #endif // 0
247
248 int cg_mask_supported(CGroupMask *ret);
249 int cg_mask_from_string(const char *s, CGroupMask *ret);
250 int cg_mask_to_string(CGroupMask mask, char **ret);
251
252 #if 0 /// UNNEEDED by elogind
253 int cg_kernel_controllers(Set *controllers);
254
255 bool cg_ns_supported(void);
256 #endif // 0
257
258 int cg_all_unified(void);
259 int cg_hybrid_unified(void);
260 int cg_unified_controller(const char *controller);
261 int cg_unified_flush(void);
262
263 bool cg_is_unified_wanted(void);
264 bool cg_is_legacy_wanted(void);
265 bool cg_is_hybrid_wanted(void);
266
267 const char* cgroup_controller_to_string(CGroupController c) _const_;
268 CGroupController cgroup_controller_from_string(const char *s) _pure_;
269
270 #if 0 /// UNNEEDED by elogind
271 int cg_weight_parse(const char *s, uint64_t *ret);
272 int cg_cpu_shares_parse(const char *s, uint64_t *ret);
273 int cg_blkio_weight_parse(const char *s, uint64_t *ret);
274 #endif // 0
275
276 bool is_cgroup_fs(const struct statfs *s);
277 bool fd_is_cgroup_fs(int fd);