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 "cgroup-util.h"
  25 #include "ip-address-access.h"
  26 #include "list.h"
  27 #include "time-util.h"
  28
  29 typedef struct CGroupContext CGroupContext;
  30 typedef struct CGroupDeviceAllow CGroupDeviceAllow;
  31 typedef struct CGroupIODeviceWeight CGroupIODeviceWeight;
  32 typedef struct CGroupIODeviceLimit CGroupIODeviceLimit;
  33 typedef struct CGroupBlockIODeviceWeight CGroupBlockIODeviceWeight;
  34 typedef struct CGroupBlockIODeviceBandwidth CGroupBlockIODeviceBandwidth;
  35
  36 typedef enum CGroupDevicePolicy {
  37
  38         /* When devices listed, will allow those, plus built-in ones,
  39         if none are listed will allow everything. */
  40         CGROUP_AUTO,
  41
  42         /* Everything forbidden, except built-in ones and listed ones. */
  43         CGROUP_CLOSED,
  44
  45         /* Everythings forbidden, except for the listed devices */
  46         CGROUP_STRICT,
  47
  48         _CGROUP_DEVICE_POLICY_MAX,
  49         _CGROUP_DEVICE_POLICY_INVALID = -1
  50 } CGroupDevicePolicy;
  51
  52 struct CGroupDeviceAllow {
  53         LIST_FIELDS(CGroupDeviceAllow, device_allow);
  54         char *path;
  55         bool r:1;
  56         bool w:1;
  57         bool m:1;
  58 };
  59
  60 struct CGroupIODeviceWeight {
  61         LIST_FIELDS(CGroupIODeviceWeight, device_weights);
  62         char *path;
  63         uint64_t weight;
  64 };
  65
  66 struct CGroupIODeviceLimit {
  67         LIST_FIELDS(CGroupIODeviceLimit, device_limits);
  68         char *path;
  69         uint64_t limits[_CGROUP_IO_LIMIT_TYPE_MAX];
  70 };
  71
  72 struct CGroupBlockIODeviceWeight {
  73         LIST_FIELDS(CGroupBlockIODeviceWeight, device_weights);
  74         char *path;
  75         uint64_t weight;
  76 };
  77
  78 struct CGroupBlockIODeviceBandwidth {
  79         LIST_FIELDS(CGroupBlockIODeviceBandwidth, device_bandwidths);
  80         char *path;
  81         uint64_t rbps;
  82         uint64_t wbps;
  83 };
  84
  85 struct CGroupContext {
  86         bool cpu_accounting;
  87         bool io_accounting;
  88         bool blockio_accounting;
  89         bool memory_accounting;
  90         bool tasks_accounting;
  91         bool ip_accounting;
  92
  93         /* For unified hierarchy */
  94         uint64_t cpu_weight;
  95         uint64_t startup_cpu_weight;
  96         usec_t cpu_quota_per_sec_usec;
  97
  98         uint64_t io_weight;
  99         uint64_t startup_io_weight;
 100         LIST_HEAD(CGroupIODeviceWeight, io_device_weights);
 101         LIST_HEAD(CGroupIODeviceLimit, io_device_limits);
 102
 103         uint64_t memory_low;
 104         uint64_t memory_high;
 105         uint64_t memory_max;
 106         uint64_t memory_swap_max;
 107
 108         LIST_HEAD(IPAddressAccessItem, ip_address_allow);
 109         LIST_HEAD(IPAddressAccessItem, ip_address_deny);
 110
 111         /* For legacy hierarchies */
 112         uint64_t cpu_shares;
 113         uint64_t startup_cpu_shares;
 114
 115         uint64_t blockio_weight;
 116         uint64_t startup_blockio_weight;
 117         LIST_HEAD(CGroupBlockIODeviceWeight, blockio_device_weights);
 118         LIST_HEAD(CGroupBlockIODeviceBandwidth, blockio_device_bandwidths);
 119
 120         uint64_t memory_limit;
 121
 122         CGroupDevicePolicy device_policy;
 123         LIST_HEAD(CGroupDeviceAllow, device_allow);
 124
 125         /* Common */
 126         uint64_t tasks_max;
 127
 128         bool delegate;
 129 };
 130
 131 /* Used when querying IP accounting data */
 132 typedef enum CGroupIPAccountingMetric {
 133         CGROUP_IP_INGRESS_BYTES,
 134         CGROUP_IP_INGRESS_PACKETS,
 135         CGROUP_IP_EGRESS_BYTES,
 136         CGROUP_IP_EGRESS_PACKETS,
 137         _CGROUP_IP_ACCOUNTING_METRIC_MAX,
 138         _CGROUP_IP_ACCOUNTING_METRIC_INVALID = -1,
 139 } CGroupIPAccountingMetric;
 140
 141 #include "unit.h"
 142
 143 void cgroup_context_init(CGroupContext *c);
 144 void cgroup_context_done(CGroupContext *c);
 145 void cgroup_context_dump(CGroupContext *c, FILE* f, const char *prefix);
 146
 147 CGroupMask cgroup_context_get_mask(CGroupContext *c);
 148
 149 void cgroup_context_free_device_allow(CGroupContext *c, CGroupDeviceAllow *a);
 150 void cgroup_context_free_io_device_weight(CGroupContext *c, CGroupIODeviceWeight *w);
 151 void cgroup_context_free_io_device_limit(CGroupContext *c, CGroupIODeviceLimit *l);
 152 void cgroup_context_free_blockio_device_weight(CGroupContext *c, CGroupBlockIODeviceWeight *w);
 153 void cgroup_context_free_blockio_device_bandwidth(CGroupContext *c, CGroupBlockIODeviceBandwidth *b);
 154
 155 CGroupMask unit_get_own_mask(Unit *u);
 156 CGroupMask unit_get_siblings_mask(Unit *u);
 157 CGroupMask unit_get_members_mask(Unit *u);
 158 CGroupMask unit_get_subtree_mask(Unit *u);
 159
 160 CGroupMask unit_get_target_mask(Unit *u);
 161 CGroupMask unit_get_enable_mask(Unit *u);
 162
 163 bool unit_get_needs_bpf(Unit *u);
 164
 165 void unit_update_cgroup_members_masks(Unit *u);
 166
 167 char *unit_default_cgroup_path(Unit *u);
 168 int unit_set_cgroup_path(Unit *u, const char *path);
 169
 170 int unit_realize_cgroup(Unit *u);
 171 void unit_release_cgroup(Unit *u);
 172 void unit_prune_cgroup(Unit *u);
 173 int unit_watch_cgroup(Unit *u);
 174
 175 int unit_attach_pids_to_cgroup(Unit *u);
 176
 177 int manager_setup_cgroup(Manager *m);
 178 void manager_shutdown_cgroup(Manager *m, bool delete);
 179
 180 unsigned manager_dispatch_cgroup_queue(Manager *m);
 181
 182 Unit *manager_get_unit_by_cgroup(Manager *m, const char *cgroup);
 183 Unit *manager_get_unit_by_pid_cgroup(Manager *m, pid_t pid);
 184 Unit* manager_get_unit_by_pid(Manager *m, pid_t pid);
 185
 186 int unit_search_main_pid(Unit *u, pid_t *ret);
 187 int unit_watch_all_pids(Unit *u);
 188
 189 int unit_get_memory_current(Unit *u, uint64_t *ret);
 190 int unit_get_tasks_current(Unit *u, uint64_t *ret);
 191 int unit_get_cpu_usage(Unit *u, nsec_t *ret);
 192 int unit_get_ip_accounting(Unit *u, CGroupIPAccountingMetric metric, uint64_t *ret);
 193
 194 int unit_reset_cpu_accounting(Unit *u);
 195 int unit_reset_ip_accounting(Unit *u);
 196
 197 bool unit_cgroup_delegate(Unit *u);
 198
 199 int unit_notify_cgroup_empty(Unit *u);
 200 int manager_notify_cgroup_empty(Manager *m, const char *group);
 201
 202 void unit_invalidate_cgroup(Unit *u, CGroupMask m);
 203 void unit_invalidate_cgroup_bpf(Unit *u);
 204
 205 void manager_invalidate_startup_units(Manager *m);
 206
 207 const char* cgroup_device_policy_to_string(CGroupDevicePolicy i) _const_;
 208 CGroupDevicePolicy cgroup_device_policy_from_string(const char *s) _pure_;