src/basic/cgroup-util.h

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