src/basic/cgroup-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   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 "set.h"
  13
  14 #define SYSTEMD_CGROUP_CONTROLLER_LEGACY "name=systemd"
  15 #define SYSTEMD_CGROUP_CONTROLLER_HYBRID "name=unified"
  16 #define SYSTEMD_CGROUP_CONTROLLER "_systemd"
  17
  18 /* An enum of well known cgroup controllers */
  19 typedef enum CGroupController {
  20         /* Original cgroup controllers */
  21         CGROUP_CONTROLLER_CPU,
  22         CGROUP_CONTROLLER_CPUACCT,    /* v1 only */
  23         CGROUP_CONTROLLER_CPUSET,     /* v2 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
  30         /* BPF-based pseudo-controllers, v2 only */
  31         CGROUP_CONTROLLER_BPF_FIREWALL,
  32         CGROUP_CONTROLLER_BPF_DEVICES,
  33         CGROUP_CONTROLLER_BPF_FOREIGN,
  34         CGROUP_CONTROLLER_BPF_SOCKET_BIND,
  35
  36         _CGROUP_CONTROLLER_MAX,
  37         _CGROUP_CONTROLLER_INVALID = -EINVAL,
  38 } CGroupController;
  39
  40 #define CGROUP_CONTROLLER_TO_MASK(c) (1U << (c))
  41
  42 /* A bit mask of well known cgroup controllers */
  43 typedef enum CGroupMask {
  44         CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
  45         CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
  46         CGROUP_MASK_CPUSET = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUSET),
  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_BPF_FIREWALL = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FIREWALL),
  53         CGROUP_MASK_BPF_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_DEVICES),
  54         CGROUP_MASK_BPF_FOREIGN = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FOREIGN),
  55         CGROUP_MASK_BPF_SOCKET_BIND = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_SOCKET_BIND),
  56
  57         /* All real cgroup v1 controllers */
  58         CGROUP_MASK_V1 = CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT|CGROUP_MASK_BLKIO|CGROUP_MASK_MEMORY|CGROUP_MASK_DEVICES|CGROUP_MASK_PIDS,
  59
  60         /* All real cgroup v2 controllers */
  61         CGROUP_MASK_V2 = CGROUP_MASK_CPU|CGROUP_MASK_CPUSET|CGROUP_MASK_IO|CGROUP_MASK_MEMORY|CGROUP_MASK_PIDS,
  62
  63         /* All cgroup v2 BPF pseudo-controllers */
  64         CGROUP_MASK_BPF = CGROUP_MASK_BPF_FIREWALL|CGROUP_MASK_BPF_DEVICES|CGROUP_MASK_BPF_FOREIGN|CGROUP_MASK_BPF_SOCKET_BIND,
  65
  66         _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1
  67 } CGroupMask;
  68
  69 static inline CGroupMask CGROUP_MASK_EXTEND_JOINED(CGroupMask mask) {
  70         /* We always mount "cpu" and "cpuacct" in the same hierarchy. Hence, when one bit is set also set the other */
  71
  72         if (mask & (CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT))
  73                 mask |= (CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT);
  74
  75         return mask;
  76 }
  77
  78 CGroupMask get_cpu_accounting_mask(void);
  79 bool cpu_accounting_is_cheap(void);
  80
  81 /* Special values for all weight knobs on unified hierarchy */
  82 #define CGROUP_WEIGHT_INVALID UINT64_MAX
  83 #define CGROUP_WEIGHT_MIN UINT64_C(1)
  84 #define CGROUP_WEIGHT_MAX UINT64_C(10000)
  85 #define CGROUP_WEIGHT_DEFAULT UINT64_C(100)
  86
  87 #define CGROUP_LIMIT_MIN UINT64_C(0)
  88 #define CGROUP_LIMIT_MAX UINT64_MAX
  89
  90 static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) {
  91         return
  92             x == CGROUP_WEIGHT_INVALID ||
  93             (x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX);
  94 }
  95
  96 /* IO limits on unified hierarchy */
  97 typedef enum CGroupIOLimitType {
  98         CGROUP_IO_RBPS_MAX,
  99         CGROUP_IO_WBPS_MAX,
 100         CGROUP_IO_RIOPS_MAX,
 101         CGROUP_IO_WIOPS_MAX,
 102
 103         _CGROUP_IO_LIMIT_TYPE_MAX,
 104         _CGROUP_IO_LIMIT_TYPE_INVALID = -EINVAL,
 105 } CGroupIOLimitType;
 106
 107 extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX];
 108
 109 const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_;
 110 CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_;
 111
 112 /* Special values for the cpu.shares attribute */
 113 #define CGROUP_CPU_SHARES_INVALID UINT64_MAX
 114 #define CGROUP_CPU_SHARES_MIN UINT64_C(2)
 115 #define CGROUP_CPU_SHARES_MAX UINT64_C(262144)
 116 #define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024)
 117
 118 static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
 119         return
 120             x == CGROUP_CPU_SHARES_INVALID ||
 121             (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
 122 }
 123
 124 /* Special values for the blkio.weight attribute */
 125 #define CGROUP_BLKIO_WEIGHT_INVALID UINT64_MAX
 126 #define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
 127 #define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
 128 #define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)
 129
 130 static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
 131         return
 132             x == CGROUP_BLKIO_WEIGHT_INVALID ||
 133             (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
 134 }
 135
 136 typedef enum CGroupUnified {
 137         CGROUP_UNIFIED_UNKNOWN = -1,
 138         CGROUP_UNIFIED_NONE = 0,        /* Both systemd and controllers on legacy */
 139         CGROUP_UNIFIED_SYSTEMD = 1,     /* Only systemd on unified */
 140         CGROUP_UNIFIED_ALL = 2,         /* Both systemd and controllers on unified */
 141 } CGroupUnified;
 142
 143 /*
 144  * General rules:
 145  *
 146  * We accept named hierarchies in the syntax "foo" and "name=foo".
 147  *
 148  * We expect that named hierarchies do not conflict in name with a
 149  * kernel hierarchy, modulo the "name=" prefix.
 150  *
 151  * We always generate "normalized" controller names, i.e. without the
 152  * "name=" prefix.
 153  *
 154  * We require absolute cgroup paths. When returning, we will always
 155  * generate paths with multiple adjacent / removed.
 156  */
 157
 158 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
 159 int cg_read_pid(FILE *f, pid_t *_pid);
 160 int cg_read_event(const char *controller, const char *path, const char *event,
 161                   char **val);
 162
 163 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
 164 int cg_read_subgroup(DIR *d, char **fn);
 165
 166 typedef enum CGroupFlags {
 167         CGROUP_SIGCONT     = 1 << 0,
 168         CGROUP_IGNORE_SELF = 1 << 1,
 169         CGROUP_REMOVE      = 1 << 2,
 170 } CGroupFlags;
 171
 172 typedef int (*cg_kill_log_func_t)(pid_t pid, int sig, void *userdata);
 173
 174 int cg_kill(const char *controller, const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata);
 175 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);
 176
 177 int cg_split_spec(const char *spec, char **ret_controller, char **ret_path);
 178 int cg_mangle_path(const char *path, char **result);
 179
 180 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
 181 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
 182
 183 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
 184
 185 int cg_rmdir(const char *controller, const char *path);
 186
 187 typedef enum  {
 188         CG_KEY_MODE_GRACEFUL = 1 << 0,
 189 } CGroupKeyMode;
 190
 191 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
 192 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
 193 int cg_get_keyed_attribute_full(const char *controller, const char *path, const char *attribute, char **keys, char **values, CGroupKeyMode mode);
 194
 195 static inline int cg_get_keyed_attribute(
 196                 const char *controller,
 197                 const char *path,
 198                 const char *attribute,
 199                 char **keys,
 200                 char **ret_values) {
 201         return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, 0);
 202 }
 203
 204 static inline int cg_get_keyed_attribute_graceful(
 205                 const char *controller,
 206                 const char *path,
 207                 const char *attribute,
 208                 char **keys,
 209                 char **ret_values) {
 210         return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, CG_KEY_MODE_GRACEFUL);
 211 }
 212
 213 int cg_get_attribute_as_uint64(const char *controller, const char *path, const char *attribute, uint64_t *ret);
 214
 215 /* Does a parse_boolean() on the attribute contents and sets ret accordingly */
 216 int cg_get_attribute_as_bool(const char *controller, const char *path, const char *attribute, bool *ret);
 217
 218 int cg_set_access(const char *controller, const char *path, uid_t uid, gid_t gid);
 219 int cg_get_owner(const char *controller, const char *path, uid_t *ret_uid);
 220
 221 int cg_set_xattr(const char *controller, const char *path, const char *name, const void *value, size_t size, int flags);
 222 int cg_get_xattr(const char *controller, const char *path, const char *name, void *value, size_t size);
 223 int cg_get_xattr_malloc(const char *controller, const char *path, const char *name, char **ret);
 224 /* Returns negative on error, and 0 or 1 on success for the bool value */
 225 int cg_get_xattr_bool(const char *controller, const char *path, const char *name);
 226 int cg_remove_xattr(const char *controller, const char *path, const char *name);
 227
 228 int cg_install_release_agent(const char *controller, const char *agent);
 229 int cg_uninstall_release_agent(const char *controller);
 230
 231 int cg_is_empty(const char *controller, const char *path);
 232 int cg_is_empty_recursive(const char *controller, const char *path);
 233
 234 int cg_get_root_path(char **path);
 235
 236 int cg_path_get_session(const char *path, char **session);
 237 int cg_path_get_owner_uid(const char *path, uid_t *uid);
 238 int cg_path_get_unit(const char *path, char **unit);
 239 int cg_path_get_user_unit(const char *path, char **unit);
 240 int cg_path_get_machine_name(const char *path, char **machine);
 241 int cg_path_get_slice(const char *path, char **slice);
 242 int cg_path_get_user_slice(const char *path, char **slice);
 243
 244 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
 245 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
 246
 247 int cg_pid_get_session(pid_t pid, char **session);
 248 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid);
 249 int cg_pid_get_unit(pid_t pid, char **unit);
 250 int cg_pid_get_user_unit(pid_t pid, char **unit);
 251 int cg_pid_get_machine_name(pid_t pid, char **machine);
 252 int cg_pid_get_slice(pid_t pid, char **slice);
 253 int cg_pid_get_user_slice(pid_t pid, char **slice);
 254
 255 int cg_path_decode_unit(const char *cgroup, char **unit);
 256
 257 char *cg_escape(const char *p);
 258 char *cg_unescape(const char *p) _pure_;
 259
 260 bool cg_controller_is_valid(const char *p);
 261
 262 int cg_slice_to_path(const char *unit, char **ret);
 263
 264 typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata);
 265
 266 int cg_mask_supported(CGroupMask *ret);
 267 int cg_mask_supported_subtree(const char *root, CGroupMask *ret);
 268 int cg_mask_from_string(const char *s, CGroupMask *ret);
 269 int cg_mask_to_string(CGroupMask mask, char **ret);
 270
 271 int cg_kernel_controllers(Set **controllers);
 272
 273 bool cg_ns_supported(void);
 274 bool cg_freezer_supported(void);
 275
 276 int cg_all_unified(void);
 277 int cg_hybrid_unified(void);
 278 int cg_unified_controller(const char *controller);
 279 int cg_unified_cached(bool flush);
 280 static inline int cg_unified(void) {
 281         return cg_unified_cached(true);
 282 }
 283
 284 const char* cgroup_controller_to_string(CGroupController c) _const_;
 285 CGroupController cgroup_controller_from_string(const char *s) _pure_;
 286
 287 bool is_cgroup_fs(const struct statfs *s);
 288 bool fd_is_cgroup_fs(int fd);
 289
 290 typedef enum ManagedOOMMode {
 291         MANAGED_OOM_AUTO,
 292         MANAGED_OOM_KILL,
 293         _MANAGED_OOM_MODE_MAX,
 294         _MANAGED_OOM_MODE_INVALID = -EINVAL,
 295 } ManagedOOMMode;
 296
 297 const char* managed_oom_mode_to_string(ManagedOOMMode m) _const_;
 298 ManagedOOMMode managed_oom_mode_from_string(const char *s) _pure_;
 299
 300 typedef enum ManagedOOMPreference {
 301         MANAGED_OOM_PREFERENCE_NONE = 0,
 302         MANAGED_OOM_PREFERENCE_AVOID = 1,
 303         MANAGED_OOM_PREFERENCE_OMIT = 2,
 304         _MANAGED_OOM_PREFERENCE_MAX,
 305         _MANAGED_OOM_PREFERENCE_INVALID = -EINVAL,
 306 } ManagedOOMPreference;
 307
 308 const char* managed_oom_preference_to_string(ManagedOOMPreference a) _const_;
 309 ManagedOOMPreference managed_oom_preference_from_string(const char *s) _pure_;