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