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 <sys/types.h>
  23 #include <stdio.h>
  24 #include <dirent.h>
  25
  26 #include "set.h"
  27 #include "def.h"
  28
  29 /* An enum of well known cgroup controllers */
  30 typedef enum CGroupController {
  31         CGROUP_CONTROLLER_CPU,
  32         CGROUP_CONTROLLER_CPUACCT,
  33         CGROUP_CONTROLLER_BLKIO,
  34         CGROUP_CONTROLLER_MEMORY,
  35         CGROUP_CONTROLLER_DEVICES,
  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_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
  48         CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
  49         CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
  50         CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
  51         _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1
  52 } CGroupMask;
  53
  54 #if 0 /// UNNEEDED by elogind
  55 /* Special values for the cpu.shares attribute */
  56 #define CGROUP_CPU_SHARES_INVALID ((uint64_t) -1)
  57 #define CGROUP_CPU_SHARES_MIN UINT64_C(2)
  58 #define CGROUP_CPU_SHARES_MAX UINT64_C(262144)
  59 #define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024)
  60
  61 static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
  62         return
  63             x == CGROUP_CPU_SHARES_INVALID ||
  64             (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
  65 }
  66
  67 /* Special values for the blkio.weight attribute */
  68 #define CGROUP_BLKIO_WEIGHT_INVALID ((uint64_t) -1)
  69 #define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
  70 #define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
  71 #define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)
  72
  73 static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
  74         return
  75             x == CGROUP_BLKIO_WEIGHT_INVALID ||
  76             (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
  77 }
  78 #endif // 0
  79
  80 /*
  81  * General rules:
  82  *
  83  * We accept named hierarchies in the syntax "foo" and "name=foo".
  84  *
  85  * We expect that named hierarchies do not conflict in name with a
  86  * kernel hierarchy, modulo the "name=" prefix.
  87  *
  88  * We always generate "normalized" controller names, i.e. without the
  89  * "name=" prefix.
  90  *
  91  * We require absolute cgroup paths. When returning, we will always
  92  * generate paths with multiple adjacent / removed.
  93  */
  94
  95 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
  96 int cg_read_pid(FILE *f, pid_t *_pid);
  97
  98 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
  99 int cg_read_subgroup(DIR *d, char **fn);
 100
 101 int cg_kill(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, Set *s);
 102 int cg_kill_recursive(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, bool remove, Set *s);
 103
 104 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self);
 105 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool remove);
 106 int cg_migrate_recursive_fallback(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool rem);
 107
 108 int cg_split_spec(const char *spec, char **controller, char **path);
 109 int cg_mangle_path(const char *path, char **result);
 110
 111 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
 112 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
 113
 114 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
 115
 116 int cg_trim(const char *controller, const char *path, bool delete_root);
 117
 118 int cg_rmdir(const char *controller, const char *path);
 119
 120 int cg_create(const char *controller, const char *path);
 121 int cg_attach(const char *controller, const char *path, pid_t pid);
 122 int cg_attach_fallback(const char *controller, const char *path, pid_t pid);
 123 int cg_create_and_attach(const char *controller, const char *path, pid_t pid);
 124
 125 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
 126 #if 0 /// UNNEEDED by elogind
 127 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
 128
 129 int cg_set_group_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
 130 int cg_set_task_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
 131 #endif // 0
 132 int cg_install_release_agent(const char *controller, const char *agent);
 133 int cg_uninstall_release_agent(const char *controller);
 134
 135 int cg_is_empty(const char *controller, const char *path);
 136 int cg_is_empty_recursive(const char *controller, const char *path);
 137
 138 int cg_get_root_path(char **path);
 139
 140 int cg_path_get_session(const char *path, char **session);
 141 #if 0 /// UNNEEDED by elogind
 142 int cg_path_get_owner_uid(const char *path, uid_t *uid);
 143 int cg_path_get_unit(const char *path, char **unit);
 144 int cg_path_get_user_unit(const char *path, char **unit);
 145 int cg_path_get_machine_name(const char *path, char **machine);
 146 int cg_path_get_slice(const char *path, char **slice);
 147 int cg_path_get_user_slice(const char *path, char **slice);
 148 #endif // 0
 149 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
 150 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
 151
 152 int cg_pid_get_session(pid_t pid, char **session);
 153 #if 0 /// UNNEEDED by elogind
 154 int cg_pid_get_owner_uid(pid_t pid, uid_t *uid);
 155 int cg_pid_get_unit(pid_t pid, char **unit);
 156 int cg_pid_get_user_unit(pid_t pid, char **unit);
 157 int cg_pid_get_machine_name(pid_t pid, char **machine);
 158 int cg_pid_get_slice(pid_t pid, char **slice);
 159 int cg_pid_get_user_slice(pid_t pid, char **slice);
 160
 161 int cg_path_decode_unit(const char *cgroup, char **unit);
 162 #endif // 0
 163 char *cg_escape(const char *p);
 164 char *cg_unescape(const char *p) _pure_;
 165
 166 bool cg_controller_is_valid(const char *p);
 167 #if 0 /// UNNEEDED by elogind
 168 int cg_slice_to_path(const char *unit, char **ret);
 169
 170 typedef const char* (*cg_migrate_callback_t)(CGroupMask mask, void *userdata);
 171
 172 int cg_create_everywhere(CGroupMask supported, CGroupMask mask, const char *path);
 173 int cg_attach_everywhere(CGroupMask supported, const char *path, pid_t pid, cg_migrate_callback_t callback, void *userdata);
 174 int cg_attach_many_everywhere(CGroupMask supported, const char *path, Set* pids, cg_migrate_callback_t callback, void *userdata);
 175 int cg_migrate_everywhere(CGroupMask supported, const char *from, const char *to, cg_migrate_callback_t callback, void *userdata);
 176 int cg_trim_everywhere(CGroupMask supported, const char *path, bool delete_root);
 177 int cg_enable_everywhere(CGroupMask supported, CGroupMask mask, const char *p);
 178 #endif // 0
 179 int cg_mask_supported(CGroupMask *ret);
 180 #if 0 /// UNNEEDED by elogind
 181 int cg_kernel_controllers(Set *controllers);
 182 #endif // 0
 183 int cg_unified(void);
 184 #if 0 /// UNNEEDED by elogind
 185 void cg_unified_flush(void);
 186
 187 bool cg_is_unified_wanted(void);
 188 #endif // 0
 189 bool cg_is_legacy_wanted(void);
 190
 191 const char* cgroup_controller_to_string(CGroupController c) _const_;
 192 CGroupController cgroup_controller_from_string(const char *s) _pure_;
 193 #if 0 /// UNNEEDED by elogind
 194 int cg_cpu_shares_parse(const char *s, uint64_t *ret);
 195 int cg_blkio_weight_parse(const char *s, uint64_t *ret);
 196 #endif // 0