src/basic/cgroup-util.h

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