src/core/cgroup.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5
   6 #include "cgroup-util.h"
   7 #include "ip-address-access.h"
   8 #include "list.h"
   9 #include "time-util.h"
  10
  11 typedef struct CGroupContext CGroupContext;
  12 typedef struct CGroupDeviceAllow CGroupDeviceAllow;
  13 typedef struct CGroupIODeviceWeight CGroupIODeviceWeight;
  14 typedef struct CGroupIODeviceLimit CGroupIODeviceLimit;
  15 typedef struct CGroupIODeviceLatency CGroupIODeviceLatency;
  16 typedef struct CGroupBlockIODeviceWeight CGroupBlockIODeviceWeight;
  17 typedef struct CGroupBlockIODeviceBandwidth CGroupBlockIODeviceBandwidth;
  18
  19 typedef enum CGroupDevicePolicy {
  20
  21         /* When devices listed, will allow those, plus built-in ones,
  22         if none are listed will allow everything. */
  23         CGROUP_AUTO,
  24
  25         /* Everything forbidden, except built-in ones and listed ones. */
  26         CGROUP_CLOSED,
  27
  28         /* Everything forbidden, except for the listed devices */
  29         CGROUP_STRICT,
  30
  31         _CGROUP_DEVICE_POLICY_MAX,
  32         _CGROUP_DEVICE_POLICY_INVALID = -1
  33 } CGroupDevicePolicy;
  34
  35 struct CGroupDeviceAllow {
  36         LIST_FIELDS(CGroupDeviceAllow, device_allow);
  37         char *path;
  38         bool r:1;
  39         bool w:1;
  40         bool m:1;
  41 };
  42
  43 struct CGroupIODeviceWeight {
  44         LIST_FIELDS(CGroupIODeviceWeight, device_weights);
  45         char *path;
  46         uint64_t weight;
  47 };
  48
  49 struct CGroupIODeviceLimit {
  50         LIST_FIELDS(CGroupIODeviceLimit, device_limits);
  51         char *path;
  52         uint64_t limits[_CGROUP_IO_LIMIT_TYPE_MAX];
  53 };
  54
  55 struct CGroupIODeviceLatency {
  56         LIST_FIELDS(CGroupIODeviceLatency, device_latencies);
  57         char *path;
  58         usec_t target_usec;
  59 };
  60
  61 struct CGroupBlockIODeviceWeight {
  62         LIST_FIELDS(CGroupBlockIODeviceWeight, device_weights);
  63         char *path;
  64         uint64_t weight;
  65 };
  66
  67 struct CGroupBlockIODeviceBandwidth {
  68         LIST_FIELDS(CGroupBlockIODeviceBandwidth, device_bandwidths);
  69         char *path;
  70         uint64_t rbps;
  71         uint64_t wbps;
  72 };
  73
  74 struct CGroupContext {
  75         bool cpu_accounting;
  76         bool io_accounting;
  77         bool blockio_accounting;
  78         bool memory_accounting;
  79         bool tasks_accounting;
  80         bool ip_accounting;
  81
  82         /* Configures the memory.oom.group attribute (on unified) */
  83         bool memory_oom_group;
  84
  85         bool delegate;
  86         CGroupMask delegate_controllers;
  87         CGroupMask disable_controllers;
  88
  89         /* For unified hierarchy */
  90         uint64_t cpu_weight;
  91         uint64_t startup_cpu_weight;
  92         usec_t cpu_quota_per_sec_usec;
  93         usec_t cpu_quota_period_usec;
  94
  95         uint64_t io_weight;
  96         uint64_t startup_io_weight;
  97         LIST_HEAD(CGroupIODeviceWeight, io_device_weights);
  98         LIST_HEAD(CGroupIODeviceLimit, io_device_limits);
  99         LIST_HEAD(CGroupIODeviceLatency, io_device_latencies);
 100
 101         uint64_t default_memory_min;
 102         uint64_t default_memory_low;
 103         uint64_t memory_min;
 104         uint64_t memory_low;
 105         uint64_t memory_high;
 106         uint64_t memory_max;
 107         uint64_t memory_swap_max;
 108
 109         bool default_memory_min_set;
 110         bool default_memory_low_set;
 111         bool memory_min_set;
 112         bool memory_low_set;
 113
 114         LIST_HEAD(IPAddressAccessItem, ip_address_allow);
 115         LIST_HEAD(IPAddressAccessItem, ip_address_deny);
 116
 117         /* For legacy hierarchies */
 118         uint64_t cpu_shares;
 119         uint64_t startup_cpu_shares;
 120
 121         uint64_t blockio_weight;
 122         uint64_t startup_blockio_weight;
 123         LIST_HEAD(CGroupBlockIODeviceWeight, blockio_device_weights);
 124         LIST_HEAD(CGroupBlockIODeviceBandwidth, blockio_device_bandwidths);
 125
 126         uint64_t memory_limit;
 127
 128         CGroupDevicePolicy device_policy;
 129         LIST_HEAD(CGroupDeviceAllow, device_allow);
 130
 131         /* Common */
 132         uint64_t tasks_max;
 133 };
 134
 135 /* Used when querying IP accounting data */
 136 typedef enum CGroupIPAccountingMetric {
 137         CGROUP_IP_INGRESS_BYTES,
 138         CGROUP_IP_INGRESS_PACKETS,
 139         CGROUP_IP_EGRESS_BYTES,
 140         CGROUP_IP_EGRESS_PACKETS,
 141         _CGROUP_IP_ACCOUNTING_METRIC_MAX,
 142         _CGROUP_IP_ACCOUNTING_METRIC_INVALID = -1,
 143 } CGroupIPAccountingMetric;
 144
 145 /* Used when querying IO accounting data */
 146 typedef enum CGroupIOAccountingMetric {
 147         CGROUP_IO_READ_BYTES,
 148         CGROUP_IO_WRITE_BYTES,
 149         CGROUP_IO_READ_OPERATIONS,
 150         CGROUP_IO_WRITE_OPERATIONS,
 151         _CGROUP_IO_ACCOUNTING_METRIC_MAX,
 152         _CGROUP_IO_ACCOUNTING_METRIC_INVALID = -1,
 153 } CGroupIOAccountingMetric;
 154
 155 typedef struct Unit Unit;
 156 typedef struct Manager Manager;
 157
 158 usec_t cgroup_cpu_adjust_period(usec_t period, usec_t quota, usec_t resolution, usec_t max_period);
 159
 160 void cgroup_context_init(CGroupContext *c);
 161 void cgroup_context_done(CGroupContext *c);
 162 void cgroup_context_dump(CGroupContext *c, FILE* f, const char *prefix);
 163
 164 void cgroup_context_free_device_allow(CGroupContext *c, CGroupDeviceAllow *a);
 165 void cgroup_context_free_io_device_weight(CGroupContext *c, CGroupIODeviceWeight *w);
 166 void cgroup_context_free_io_device_limit(CGroupContext *c, CGroupIODeviceLimit *l);
 167 void cgroup_context_free_io_device_latency(CGroupContext *c, CGroupIODeviceLatency *l);
 168 void cgroup_context_free_blockio_device_weight(CGroupContext *c, CGroupBlockIODeviceWeight *w);
 169 void cgroup_context_free_blockio_device_bandwidth(CGroupContext *c, CGroupBlockIODeviceBandwidth *b);
 170
 171 int cgroup_add_device_allow(CGroupContext *c, const char *dev, const char *mode);
 172
 173 CGroupMask unit_get_own_mask(Unit *u);
 174 CGroupMask unit_get_delegate_mask(Unit *u);
 175 CGroupMask unit_get_members_mask(Unit *u);
 176 CGroupMask unit_get_siblings_mask(Unit *u);
 177 CGroupMask unit_get_subtree_mask(Unit *u);
 178 CGroupMask unit_get_disable_mask(Unit *u);
 179 CGroupMask unit_get_ancestor_disable_mask(Unit *u);
 180
 181 CGroupMask unit_get_target_mask(Unit *u);
 182 CGroupMask unit_get_enable_mask(Unit *u);
 183
 184 void unit_invalidate_cgroup_members_masks(Unit *u);
 185
 186 void unit_add_to_cgroup_realize_queue(Unit *u);
 187
 188 const char *unit_get_realized_cgroup_path(Unit *u, CGroupMask mask);
 189 char *unit_default_cgroup_path(const Unit *u);
 190 int unit_set_cgroup_path(Unit *u, const char *path);
 191 int unit_pick_cgroup_path(Unit *u);
 192
 193 int unit_realize_cgroup(Unit *u);
 194 void unit_release_cgroup(Unit *u);
 195 void unit_prune_cgroup(Unit *u);
 196 int unit_watch_cgroup(Unit *u);
 197 int unit_watch_cgroup_memory(Unit *u);
 198
 199 void unit_add_to_cgroup_empty_queue(Unit *u);
 200 int unit_check_oom(Unit *u);
 201
 202 int unit_attach_pids_to_cgroup(Unit *u, Set *pids, const char *suffix_path);
 203
 204 int manager_setup_cgroup(Manager *m);
 205 void manager_shutdown_cgroup(Manager *m, bool delete);
 206
 207 unsigned manager_dispatch_cgroup_realize_queue(Manager *m);
 208
 209 Unit *manager_get_unit_by_cgroup(Manager *m, const char *cgroup);
 210 Unit *manager_get_unit_by_pid_cgroup(Manager *m, pid_t pid);
 211 Unit* manager_get_unit_by_pid(Manager *m, pid_t pid);
 212
 213 uint64_t unit_get_ancestor_memory_min(Unit *u);
 214 uint64_t unit_get_ancestor_memory_low(Unit *u);
 215
 216 int unit_search_main_pid(Unit *u, pid_t *ret);
 217 int unit_watch_all_pids(Unit *u);
 218
 219 int unit_synthesize_cgroup_empty_event(Unit *u);
 220
 221 int unit_get_memory_current(Unit *u, uint64_t *ret);
 222 int unit_get_tasks_current(Unit *u, uint64_t *ret);
 223 int unit_get_cpu_usage(Unit *u, nsec_t *ret);
 224 int unit_get_io_accounting(Unit *u, CGroupIOAccountingMetric metric, bool allow_cache, uint64_t *ret);
 225 int unit_get_ip_accounting(Unit *u, CGroupIPAccountingMetric metric, uint64_t *ret);
 226
 227 int unit_reset_cpu_accounting(Unit *u);
 228 int unit_reset_ip_accounting(Unit *u);
 229 int unit_reset_io_accounting(Unit *u);
 230 int unit_reset_accounting(Unit *u);
 231
 232 #define UNIT_CGROUP_BOOL(u, name)                       \
 233         ({                                              \
 234         CGroupContext *cc = unit_get_cgroup_context(u); \
 235         cc ? cc->name : false;                          \
 236         })
 237
 238 bool manager_owns_host_root_cgroup(Manager *m);
 239 bool unit_has_host_root_cgroup(Unit *u);
 240
 241 int manager_notify_cgroup_empty(Manager *m, const char *group);
 242
 243 void unit_invalidate_cgroup(Unit *u, CGroupMask m);
 244 void unit_invalidate_cgroup_bpf(Unit *u);
 245
 246 void manager_invalidate_startup_units(Manager *m);
 247
 248 const char* cgroup_device_policy_to_string(CGroupDevicePolicy i) _const_;
 249 CGroupDevicePolicy cgroup_device_policy_from_string(const char *s) _pure_;
 250
 251 bool unit_cgroup_delegate(Unit *u);