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