src/basic/cgroup-util.h

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