src/shared/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 /* A bit mask of well known cgroup controllers */
  32 typedef enum CGroupControllerMask {
  33         CGROUP_CPU = 1,
  34         CGROUP_CPUACCT = 2,
  35         CGROUP_BLKIO = 4,
  36         CGROUP_MEMORY = 8,
  37         CGROUP_DEVICE = 16,
  38         _CGROUP_CONTROLLER_MASK_ALL = 31
  39 } CGroupControllerMask;
  40
  41 /*
  42  * General rules:
  43  *
  44  * We accept named hierarchies in the syntax "foo" and "name=foo".
  45  *
  46  * We expect that named hierarchies do not conflict in name with a
  47  * kernel hierarchy, modulo the "name=" prefix.
  48  *
  49  * We always generate "normalized" controller names, i.e. without the
  50  * "name=" prefix.
  51  *
  52  * We require absolute cgroup paths. When returning, we will always
  53  * generate paths with multiple adjacent / removed.
  54  */
  55
  56 int cg_enumerate_processes(const char *controller, const char *path, FILE **_f);
  57 int cg_read_pid(FILE *f, pid_t *_pid);
  58
  59 int cg_enumerate_subgroups(const char *controller, const char *path, DIR **_d);
  60 int cg_read_subgroup(DIR *d, char **fn);
  61
  62 int cg_kill(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, Set *s);
  63 int cg_kill_recursive(const char *controller, const char *path, int sig, bool sigcont, bool ignore_self, bool remove, Set *s);
  64
  65 int cg_migrate(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self);
  66 int cg_migrate_recursive(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool remove);
  67 int cg_migrate_recursive_fallback(const char *cfrom, const char *pfrom, const char *cto, const char *pto, bool ignore_self, bool rem);
  68
  69 int cg_split_spec(const char *spec, char **controller, char **path);
  70 int cg_mangle_path(const char *path, char **result);
  71
  72 int cg_get_path(const char *controller, const char *path, const char *suffix, char **fs);
  73 int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **fs);
  74
  75 int cg_pid_get_path(const char *controller, pid_t pid, char **path);
  76
  77 int cg_trim(const char *controller, const char *path, bool delete_root);
  78
  79 int cg_rmdir(const char *controller, const char *path);
  80 int cg_delete(const char *controller, const char *path);
  81
  82 int cg_create(const char *controller, const char *path);
  83 int cg_attach(const char *controller, const char *path, pid_t pid);
  84 int cg_attach_fallback(const char *controller, const char *path, pid_t pid);
  85 int cg_create_and_attach(const char *controller, const char *path, pid_t pid);
  86
  87 int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
  88 int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
  89
  90 int cg_set_group_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
  91 int cg_set_task_access(const char *controller, const char *path, mode_t mode, uid_t uid, gid_t gid);
  92
  93 int cg_install_release_agent(const char *controller, const char *agent);
  94 int cg_uninstall_release_agent(const char *controller);
  95
  96 int cg_is_empty(const char *controller, const char *path, bool ignore_self);
  97 int cg_is_empty_recursive(const char *controller, const char *path, bool ignore_self);
  98
  99 int cg_get_root_path(char **path);
 100
 101 int cg_path_get_session(const char *path, char **session);
 102
 103 int cg_shift_path(const char *cgroup, const char *cached_root, const char **shifted);
 104 int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **cgroup);
 105
 106 int cg_pid_get_session(pid_t pid, char **session);
 107
 108 char *cg_escape(const char *p);
 109 char *cg_unescape(const char *p) _pure_;
 110
 111 bool cg_controller_is_valid(const char *p, bool allow_named);
 112
 113 typedef const char* (*cg_migrate_callback_t)(CGroupControllerMask mask, void *userdata);
 114
 115 int cg_create_everywhere(CGroupControllerMask supported, CGroupControllerMask mask, const char *path);
 116 int cg_attach_everywhere(CGroupControllerMask supported, const char *path, pid_t pid, cg_migrate_callback_t callback, void *userdata);
 117 int cg_attach_many_everywhere(CGroupControllerMask supported, const char *path, Set* pids, cg_migrate_callback_t callback, void *userdata);
 118 int cg_migrate_everywhere(CGroupControllerMask supported, const char *from, const char *to, cg_migrate_callback_t callback, void *userdata);
 119 int cg_trim_everywhere(CGroupControllerMask supported, const char *path, bool delete_root);
 120
 121 CGroupControllerMask cg_mask_supported(void);
 122
 123 int cg_kernel_controllers(Set *controllers);