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