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