src/basic/cgroup-util.h

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