src/core/cgroup.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2013 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 <stdbool.h>
  23
  24 // #include "list.h"
  25 // #include "time-util.h"
  26 #include "logind.h"
  27
  28 #if 0 /// UNNEEDED by elogind
  29 typedef struct CGroupContext CGroupContext;
  30 Stypedef struct CGroupDeviceAllow CGroupDeviceAllow;
  31 typedef struct CGroupBlockIODeviceWeight CGroupBlockIODeviceWeight;
  32 typedef struct CGroupBlockIODeviceBandwidth CGroupBlockIODeviceBandwidth;
  33
  34 /* Maximum value for fixed (manual) net class ID assignment,
  35  * and also the value at which the range of automatic assignments starts
  36  */
  37 #define CGROUP_NETCLASS_FIXED_MAX UINT32_C(65535)
  38
  39 typedef struct CGroupContext CGroupContext;
  40 typedef struct CGroupDeviceAllow CGroupDeviceAllow;
  41 typedef struct CGroupBlockIODeviceWeight CGroupBlockIODeviceWeight;
  42 typedef struct CGroupBlockIODeviceBandwidth CGroupBlockIODeviceBandwidth;
  43
  44 typedef enum CGroupDevicePolicy {
  45
  46         /* When devices listed, will allow those, plus built-in ones,
  47         if none are listed will allow everything. */
  48         CGROUP_AUTO,
  49
  50         /* Everything forbidden, except built-in ones and listed ones. */
  51         CGROUP_CLOSED,
  52
  53         /* Everythings forbidden, except for the listed devices */
  54         CGROUP_STRICT,
  55
  56         _CGROUP_DEVICE_POLICY_MAX,
  57         _CGROUP_DEVICE_POLICY_INVALID = -1
  58 } CGroupDevicePolicy;
  59
  60 typedef enum CGroupNetClassType {
  61         /* Default - do not assign a net class */
  62         CGROUP_NETCLASS_TYPE_NONE,
  63
  64         /* Automatically assign a net class */
  65         CGROUP_NETCLASS_TYPE_AUTO,
  66
  67         /* Assign the net class that was provided by the user */
  68         CGROUP_NETCLASS_TYPE_FIXED,
  69 } CGroupNetClassType;
  70
  71 struct CGroupDeviceAllow {
  72         LIST_FIELDS(CGroupDeviceAllow, device_allow);
  73         char *path;
  74         bool r:1;
  75         bool w:1;
  76         bool m:1;
  77 };
  78
  79 struct CGroupBlockIODeviceWeight {
  80         LIST_FIELDS(CGroupBlockIODeviceWeight, device_weights);
  81         char *path;
  82         uint64_t weight;
  83 };
  84
  85 struct CGroupBlockIODeviceBandwidth {
  86         LIST_FIELDS(CGroupBlockIODeviceBandwidth, device_bandwidths);
  87         char *path;
  88         uint64_t bandwidth;
  89         bool read;
  90 };
  91
  92 struct CGroupContext {
  93         bool cpu_accounting;
  94         bool blockio_accounting;
  95         bool memory_accounting;
  96         bool tasks_accounting;
  97
  98         uint64_t cpu_shares;
  99         uint64_t startup_cpu_shares;
 100         usec_t cpu_quota_per_sec_usec;
 101
 102         uint64_t blockio_weight;
 103         uint64_t startup_blockio_weight;
 104         LIST_HEAD(CGroupBlockIODeviceWeight, blockio_device_weights);
 105         LIST_HEAD(CGroupBlockIODeviceBandwidth, blockio_device_bandwidths);
 106
 107         uint64_t memory_limit;
 108
 109         CGroupDevicePolicy device_policy;
 110         LIST_HEAD(CGroupDeviceAllow, device_allow);
 111
 112         CGroupNetClassType netclass_type;
 113         uint32_t netclass_id;
 114
 115         uint64_t tasks_max;
 116
 117         bool delegate;
 118 };
 119
 120 #include "cgroup-util.h"
 121 #include "unit.h"
 122
 123 void cgroup_context_init(CGroupContext *c);
 124 void cgroup_context_done(CGroupContext *c);
 125 void cgroup_context_dump(CGroupContext *c, FILE* f, const char *prefix);
 126 void cgroup_context_apply(CGroupContext *c, CGroupMask mask, const char *path, uint32_t netclass_id, ManagerState state);
 127
 128 CGroupMask cgroup_context_get_mask(CGroupContext *c);
 129
 130 void cgroup_context_free_device_allow(CGroupContext *c, CGroupDeviceAllow *a);
 131 void cgroup_context_free_blockio_device_weight(CGroupContext *c, CGroupBlockIODeviceWeight *w);
 132 void cgroup_context_free_blockio_device_bandwidth(CGroupContext *c, CGroupBlockIODeviceBandwidth *b);
 133
 134 CGroupMask unit_get_own_mask(Unit *u);
 135 CGroupMask unit_get_siblings_mask(Unit *u);
 136 CGroupMask unit_get_members_mask(Unit *u);
 137 CGroupMask unit_get_subtree_mask(Unit *u);
 138
 139 vCGroupMask unit_get_target_mask(Unit *u);
 140 CGroupMask unit_get_enable_mask(Unit *u);
 141
 142 void unit_update_cgroup_members_masks(Unit *u);
 143
 144 har *unit_default_cgroup_path(Unit *u);
 145 int unit_set_cgroup_path(Unit *u, const char *path);
 146
 147 int unit_realize_cgroup(Unit *u);
 148 void unit_release_cgroup(Unit *u);
 149 void unit_prune_cgroup(Unit *u);
 150 int unit_watch_cgroup(Unit *u);
 151
 152 int unit_attach_pids_to_cgroup(Unit *u);
 153
 154 int unit_add_to_netclass_cgroup(Unit *u);
 155 int unit_remove_from_netclass_cgroup(Unit *u);
 156 #endif // 0
 157
 158 int manager_setup_cgroup(Manager *m);
 159 void manager_shutdown_cgroup(Manager *m, bool delete);
 160
 161 #if 0 /// UNNEEDED by elogind
 162 unsigned manager_dispatch_cgroup_queue(Manager *m);
 163
 164 Unit *manager_get_unit_by_cgroup(Manager *m, const char *cgroup);
 165 Unit *manager_get_unit_by_pid_cgroup(Manager *m, pid_t pid);
 166 Unit* manager_get_unit_by_pid(Manager *m, pid_t pid);
 167
 168 int unit_search_main_pid(Unit *u, pid_t *ret);
 169 int unit_watch_all_pids(Unit *u);
 170
 171 int unit_get_memory_current(Unit *u, uint64_t *ret);
 172 int unit_get_tasks_current(Unit *u, uint64_t *ret);
 173 int unit_get_cpu_usage(Unit *u, nsec_t *ret);
 174 int unit_reset_cpu_usage(Unit *u);
 175
 176 bool unit_cgroup_delegate(Unit *u);
 177
 178 int unit_notify_cgroup_empty(Unit *u);
 179 int manager_notify_cgroup_empty(Manager *m, const char *group);
 180
 181 void unit_invalidate_cgroup(Unit *u, CGroupMask m);
 182
 183 void manager_invalidate_startup_units(Manager *m);
 184
 185 const char* cgroup_device_policy_to_string(CGroupDevicePolicy i) _const_;
 186 CGroupDevicePolicy cgroup_device_policy_from_string(const char *s) _pure_;
 187 #endif // 0