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