src/basic/cgroup-util.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <sys/types.h>
  25 #include <stdio.h>
  26 #include <dirent.h>
  27
  28 #include "set.h"
  29 #include "def.h"
  30
  31 /* An enum of well known cgroup controllers */
  32 typedef enum CGroupController {
  33         CGROUP_CONTROLLER_CPU,
  34         CGROUP_CONTROLLER_CPUACCT,
  35         CGROUP_CONTROLLER_BLKIO,
  36         CGROUP_CONTROLLER_MEMORY,
  37         CGROUP_CONTROLLER_DEVICES,
  38         CGROUP_CONTROLLER_PIDS,
  39         CGROUP_CONTROLLER_NET_CLS,
  40         _CGROUP_CONTROLLER_MAX,
  41         _CGROUP_CONTROLLER_INVALID = -1,
  42 } CGroupController;
  43
  44 #define CGROUP_CONTROLLER_TO_MASK(c) (1 << (c))
  45
  46 /* A bit mask of well known cgroup controllers */
  47 typedef enum CGroupMask {
  48         CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
  49         CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
  50         CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
  51         CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
  52         CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
  53         CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
  54         CGROUP_MASK_NET_CLS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_NET_CLS),
  55         _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1
  56 } CGroupMask;
  57
  58 /* Special values for the cpu.shares attribute */
  59 #define CGROUP_CPU_SHARES_INVALID ((uint64_t) -1)
  60 #define CGROUP_CPU_SHARES_MIN UINT64_C(2)
  61 #define CGROUP_CPU_SHARES_MAX UINT64_C(262144)
  62 #define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024)
  63
  64 static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
  65         return
  66             x == CGROUP_CPU_SHARES_INVALID ||
  67             (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
  68 }
  69
  70 /* Special values for the blkio.weight attribute */
  71 #define CGROUP_BLKIO_WEIGHT_INVALID ((uint64_t) -1)
  72 #define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
  73 #define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
  74 #define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)
  75
  76 static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
  77         return
  78             x == CGROUP_BLKIO_WEIGHT_INVALID ||
  79             (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
  80 }
  81
  82 /*
  83  * General rules:
  84  *
  85  * We accept named hierarchies in the syntax "foo" and "name=foo".
  86  *
  87  * We expect that named hierarchies do not conflict in name with a
  88  * kernel hierarchy, modulo the "name=" prefix.
  89  *
  90  * We always generate "normalized" controller names, i.e. without the
  91  * "name=" prefix.
  92  *
  93  * We require absolute cgroup paths. When returning, we will always
  94  * generate paths with multiple adjacent / removed.
  95  */
  96
  97 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
  98 int cg_read_pid(FILE *f, pid_t *_pid);
  99
 100 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
 101 int cg_read_subgroup(DIR *d, char **fn);
 102
 103 int cg_kill(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, Set *s);
 104 int cg_kill_recursive(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, bool remove, Set *s);
 105
 106 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self);
 107 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool remove);
 108 int cg_migrate_recursive_fallback(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool rem);
 109
 110 int cg_split_spec(const char *spec, char **controller, char **path);
 111 int cg_mangle_path(const char *path, char **result);
 112
 113 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
 114 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
 115
 116 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
 117
 118 int cg_trim(const char *controller, const char *path, bool delete_root);
 119
 120 int cg_rmdir(const char *controller, const char *path);
 121
 122 int cg_create(const char *controller, const char *path);
 123 int cg_attach(const char *controller, const char *path, pid_t pid);
 124 int cg_attach_fallback(const char *controller, const char *path, pid_t pid);
 125 int cg_create_and_attach(const char *controller, const char *path, pid_t pid);
 126
 127 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
 128 #if 0 /// UNNEEDED by elogind
 129 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
 130
 131 int cg_set_group_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
 132 int cg_set_task_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
 133 #endif // 0
 134 int cg_install_release_agent(const char *controller, const char *agent);
 135 int cg_uninstall_release_agent(const char *controller);
 136
 137 int cg_is_empty(const char *controller, const char *path);
 138 int cg_is_empty_recursive(const char *controller, const char *path);
 139
 140 int cg_get_root_path(char **path);
 141
 142 int cg_path_get_session(const char *path, char **session);
 143 #if 0 /// UNNEEDED by elogind
 144 int cg_path_get_owner_uid(const char *path, uid_t *uid);
 145 int cg_path_get_unit(const char *path, char **unit);
 146 int cg_path_get_user_unit(const char *path, char **unit);
 147 int cg_path_get_machine_name(const char *path, char **machine);
 148 int cg_path_get_slice(const char *path, char **slice);
 149 int cg_path_get_user_slice(const char *path, char **slice);
 150 #endif // 0
 151 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
 152 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
 153
 154 int cg_pid_get_session(pid_t pid, char **session);
 155 #if 0 /// UNNEEDED by elogind
 156 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid);
 157 int cg_pid_get_unit(pid_t pid, char **unit);
 158 int cg_pid_get_user_unit(pid_t pid, char **unit);
 159 int cg_pid_get_machine_name(pid_t pid, char **machine);
 160 int cg_pid_get_slice(pid_t pid, char **slice);
 161 int cg_pid_get_user_slice(pid_t pid, char **slice);
 162
 163 int cg_path_decode_unit(const char *cgroup, char **unit);
 164 #endif // 0
 165 char *cg_escape(const char *p);
 166 char *cg_unescape(const char *p) _pure_;
 167
 168 bool cg_controller_is_valid(const char *p);
 169 #if 0 /// UNNEEDED by elogind
 170 int cg_slice_to_path(const char *unit, char **ret);
 171
 172 typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata);
 173
 174 int cg_create_everywhere(CGroupMask supported, CGroupMask mask, const char *path);
 175 int cg_attach_everywhere(CGroupMask supported, const char *path, pid_t pid, cg_migrate_callback_t callback, void *userdata);
 176 int cg_attach_many_everywhere(CGroupMask supported, const char *path, Set* pids, cg_migrate_callback_t callback, void *userdata);
 177 int cg_migrate_everywhere(CGroupMask supported, const char *from, const char *to, cg_migrate_callback_t callback, void *userdata);
 178 int cg_trim_everywhere(CGroupMask supported, const char *path, bool delete_root);
 179 int cg_enable_everywhere(CGroupMask supported, CGroupMask mask, const char *p);
 180 #endif // 0
 181 int cg_mask_supported(CGroupMask *ret);
 182 #if 0 /// UNNEEDED by elogind
 183 int cg_kernel_controllers(Set *controllers);
 184 #endif // 0
 185 int cg_unified(void);
 186 #if 0 /// UNNEEDED by elogind
 187 void cg_unified_flush(void);
 188
 189 bool cg_is_unified_wanted(void);
 190 #endif // 0
 191 bool cg_is_legacy_wanted(void);
 192
 193 const char* cgroup_controller_to_string(CGroupController c) _const_;
 194 CGroupController cgroup_controller_from_string(const char *s) _pure_;
 195 #if 0 /// UNNEEDED by elogind
 196 int cg_cpu_shares_parse(const char *s, uint64_t *ret);
 197 int cg_blkio_weight_parse(const char *s, uint64_t *ret);
 198 #endif // 0