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 "cpu-set-util.h"
   8 #include "ip-address-access.h"
   9 #include "list.h"
  10 #include "time-util.h"
  11
  12 typedef struct CGroupContext CGroupContext;
  13 typedef struct CGroupDeviceAllow CGroupDeviceAllow;
  14 typedef struct CGroupIODeviceWeight CGroupIODeviceWeight;
  15 typedef struct CGroupIODeviceLimit CGroupIODeviceLimit;
  16 typedef struct CGroupIODeviceLatency CGroupIODeviceLatency;
  17 typedef struct CGroupBlockIODeviceWeight CGroupBlockIODeviceWeight;
  18 typedef struct CGroupBlockIODeviceBandwidth CGroupBlockIODeviceBandwidth;
  19
  20 typedef enum CGroupDevicePolicy {
  21         /* When devices listed, will allow those, plus built-in ones, if none are listed will allow
  22          * everything. */
  23         CGROUP_DEVICE_POLICY_AUTO,
  24
  25         /* Everything forbidden, except built-in ones and listed ones. */
  26         CGROUP_DEVICE_POLICY_CLOSED,
  27
  28         /* Everything forbidden, except for the listed devices */
  29         CGROUP_DEVICE_POLICY_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         CPUSet cpuset_cpus;
  96         CPUSet cpuset_mems;
  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         LIST_HEAD(CGroupIODeviceLatency, io_device_latencies);
 103
 104         uint64_t default_memory_min;
 105         uint64_t default_memory_low;
 106         uint64_t memory_min;
 107         uint64_t memory_low;
 108         uint64_t memory_high;
 109         uint64_t memory_max;
 110         uint64_t memory_swap_max;
 111
 112         bool default_memory_min_set;
 113         bool default_memory_low_set;
 114         bool memory_min_set;
 115         bool memory_low_set;
 116
 117         LIST_HEAD(IPAddressAccessItem, ip_address_allow);
 118         LIST_HEAD(IPAddressAccessItem, ip_address_deny);
 119
 120         char **ip_filters_ingress;
 121         char **ip_filters_egress;
 122
 123         /* For legacy hierarchies */
 124         uint64_t cpu_shares;
 125         uint64_t startup_cpu_shares;
 126
 127         uint64_t blockio_weight;
 128         uint64_t startup_blockio_weight;
 129         LIST_HEAD(CGroupBlockIODeviceWeight, blockio_device_weights);
 130         LIST_HEAD(CGroupBlockIODeviceBandwidth, blockio_device_bandwidths);
 131
 132         uint64_t memory_limit;
 133
 134         CGroupDevicePolicy device_policy;
 135         LIST_HEAD(CGroupDeviceAllow, device_allow);
 136
 137         /* Common */
 138         uint64_t tasks_max;
 139 };
 140
 141 /* Used when querying IP accounting data */
 142 typedef enum CGroupIPAccountingMetric {
 143         CGROUP_IP_INGRESS_BYTES,
 144         CGROUP_IP_INGRESS_PACKETS,
 145         CGROUP_IP_EGRESS_BYTES,
 146         CGROUP_IP_EGRESS_PACKETS,
 147         _CGROUP_IP_ACCOUNTING_METRIC_MAX,
 148         _CGROUP_IP_ACCOUNTING_METRIC_INVALID = -1,
 149 } CGroupIPAccountingMetric;
 150
 151 /* Used when querying IO accounting data */
 152 typedef enum CGroupIOAccountingMetric {
 153         CGROUP_IO_READ_BYTES,
 154         CGROUP_IO_WRITE_BYTES,
 155         CGROUP_IO_READ_OPERATIONS,
 156         CGROUP_IO_WRITE_OPERATIONS,
 157         _CGROUP_IO_ACCOUNTING_METRIC_MAX,
 158         _CGROUP_IO_ACCOUNTING_METRIC_INVALID = -1,
 159 } CGroupIOAccountingMetric;
 160
 161 typedef struct Unit Unit;
 162 typedef struct Manager Manager;
 163
 164 usec_t cgroup_cpu_adjust_period(usec_t period, usec_t quota, usec_t resolution, usec_t max_period);
 165
 166 void cgroup_context_init(CGroupContext *c);
 167 void cgroup_context_done(CGroupContext *c);
 168 void cgroup_context_dump(Unit *u, FILE* f, const char *prefix);
 169
 170 void cgroup_context_free_device_allow(CGroupContext *c, CGroupDeviceAllow *a);
 171 void cgroup_context_free_io_device_weight(CGroupContext *c, CGroupIODeviceWeight *w);
 172 void cgroup_context_free_io_device_limit(CGroupContext *c, CGroupIODeviceLimit *l);
 173 void cgroup_context_free_io_device_latency(CGroupContext *c, CGroupIODeviceLatency *l);
 174 void cgroup_context_free_blockio_device_weight(CGroupContext *c, CGroupBlockIODeviceWeight *w);
 175 void cgroup_context_free_blockio_device_bandwidth(CGroupContext *c, CGroupBlockIODeviceBandwidth *b);
 176
 177 int cgroup_add_device_allow(CGroupContext *c, const char *dev, const char *mode);
 178
 179 CGroupMask unit_get_own_mask(Unit *u);
 180 CGroupMask unit_get_delegate_mask(Unit *u);
 181 CGroupMask unit_get_members_mask(Unit *u);
 182 CGroupMask unit_get_siblings_mask(Unit *u);
 183 CGroupMask unit_get_subtree_mask(Unit *u);
 184 CGroupMask unit_get_disable_mask(Unit *u);
 185 CGroupMask unit_get_ancestor_disable_mask(Unit *u);
 186
 187 CGroupMask unit_get_target_mask(Unit *u);
 188 CGroupMask unit_get_enable_mask(Unit *u);
 189
 190 void unit_invalidate_cgroup_members_masks(Unit *u);
 191
 192 void unit_add_to_cgroup_realize_queue(Unit *u);
 193
 194 const char *unit_get_realized_cgroup_path(Unit *u, CGroupMask mask);
 195 char *unit_default_cgroup_path(const Unit *u);
 196 int unit_set_cgroup_path(Unit *u, const char *path);
 197 int unit_pick_cgroup_path(Unit *u);
 198
 199 int unit_realize_cgroup(Unit *u);
 200 void unit_release_cgroup(Unit *u);
 201 void unit_prune_cgroup(Unit *u);
 202 int unit_watch_cgroup(Unit *u);
 203 int unit_watch_cgroup_memory(Unit *u);
 204
 205 void unit_add_to_cgroup_empty_queue(Unit *u);
 206 int unit_check_oom(Unit *u);
 207
 208 int unit_attach_pids_to_cgroup(Unit *u, Set *pids, const char *suffix_path);
 209
 210 int manager_setup_cgroup(Manager *m);
 211 void manager_shutdown_cgroup(Manager *m, bool delete);
 212
 213 unsigned manager_dispatch_cgroup_realize_queue(Manager *m);
 214
 215 Unit *manager_get_unit_by_cgroup(Manager *m, const char *cgroup);
 216 Unit *manager_get_unit_by_pid_cgroup(Manager *m, pid_t pid);
 217 Unit* manager_get_unit_by_pid(Manager *m, pid_t pid);
 218
 219 uint64_t unit_get_ancestor_memory_min(Unit *u);
 220 uint64_t unit_get_ancestor_memory_low(Unit *u);
 221
 222 int unit_search_main_pid(Unit *u, pid_t *ret);
 223 int unit_watch_all_pids(Unit *u);
 224
 225 int unit_synthesize_cgroup_empty_event(Unit *u);
 226
 227 int unit_get_memory_current(Unit *u, uint64_t *ret);
 228 int unit_get_tasks_current(Unit *u, uint64_t *ret);
 229 int unit_get_cpu_usage(Unit *u, nsec_t *ret);
 230 int unit_get_io_accounting(Unit *u, CGroupIOAccountingMetric metric, bool allow_cache, uint64_t *ret);
 231 int unit_get_ip_accounting(Unit *u, CGroupIPAccountingMetric metric, uint64_t *ret);
 232
 233 int unit_reset_cpu_accounting(Unit *u);
 234 int unit_reset_ip_accounting(Unit *u);
 235 int unit_reset_io_accounting(Unit *u);
 236 int unit_reset_accounting(Unit *u);
 237
 238 #define UNIT_CGROUP_BOOL(u, name)                       \
 239         ({                                              \
 240         CGroupContext *cc = unit_get_cgroup_context(u); \
 241         cc ? cc->name : false;                          \
 242         })
 243
 244 bool manager_owns_host_root_cgroup(Manager *m);
 245 bool unit_has_host_root_cgroup(Unit *u);
 246
 247 int manager_notify_cgroup_empty(Manager *m, const char *group);
 248
 249 void unit_invalidate_cgroup(Unit *u, CGroupMask m);
 250 void unit_invalidate_cgroup_bpf(Unit *u);
 251
 252 void manager_invalidate_startup_units(Manager *m);
 253
 254 const char* cgroup_device_policy_to_string(CGroupDevicePolicy i) _const_;
 255 CGroupDevicePolicy cgroup_device_policy_from_string(const char *s) _pure_;
 256
 257 bool unit_cgroup_delegate(Unit *u);
 258
 259 int compare_job_priority(const void *a, const void *b);
 260
 261 int unit_get_cpuset(Unit *u, CPUSet *cpus, const char *name);