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         /* Everythings 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         /* For unified hierarchy */
  83         uint64_t cpu_weight;
  84         uint64_t startup_cpu_weight;
  85         usec_t cpu_quota_per_sec_usec;
  86         usec_t cpu_quota_period_usec;
  87
  88         uint64_t io_weight;
  89         uint64_t startup_io_weight;
  90         LIST_HEAD(CGroupIODeviceWeight, io_device_weights);
  91         LIST_HEAD(CGroupIODeviceLimit, io_device_limits);
  92         LIST_HEAD(CGroupIODeviceLatency, io_device_latencies);
  93
  94         uint64_t memory_min;
  95         uint64_t memory_low;
  96         uint64_t memory_high;
  97         uint64_t memory_max;
  98         uint64_t memory_swap_max;
  99
 100         LIST_HEAD(IPAddressAccessItem, ip_address_allow);
 101         LIST_HEAD(IPAddressAccessItem, ip_address_deny);
 102
 103         /* For legacy hierarchies */
 104         uint64_t cpu_shares;
 105         uint64_t startup_cpu_shares;
 106
 107         uint64_t blockio_weight;
 108         uint64_t startup_blockio_weight;
 109         LIST_HEAD(CGroupBlockIODeviceWeight, blockio_device_weights);
 110         LIST_HEAD(CGroupBlockIODeviceBandwidth, blockio_device_bandwidths);
 111
 112         uint64_t memory_limit;
 113
 114         CGroupDevicePolicy device_policy;
 115         LIST_HEAD(CGroupDeviceAllow, device_allow);
 116
 117         /* Common */
 118         uint64_t tasks_max;
 119
 120         bool delegate;
 121         CGroupMask delegate_controllers;
 122
 123         CGroupMask disable_controllers;
 124 };
 125
 126 /* Used when querying IP accounting data */
 127 typedef enum CGroupIPAccountingMetric {
 128         CGROUP_IP_INGRESS_BYTES,
 129         CGROUP_IP_INGRESS_PACKETS,
 130         CGROUP_IP_EGRESS_BYTES,
 131         CGROUP_IP_EGRESS_PACKETS,
 132         _CGROUP_IP_ACCOUNTING_METRIC_MAX,
 133         _CGROUP_IP_ACCOUNTING_METRIC_INVALID = -1,
 134 } CGroupIPAccountingMetric;
 135
 136 typedef struct Unit Unit;
 137 typedef struct Manager Manager;
 138
 139 usec_t cgroup_cpu_adjust_period(usec_t period, usec_t quota, usec_t resolution, usec_t max_period);
 140
 141 void cgroup_context_init(CGroupContext *c);
 142 void cgroup_context_done(CGroupContext *c);
 143 void cgroup_context_dump(CGroupContext *c, FILE* f, const char *prefix);
 144
 145 void cgroup_context_free_device_allow(CGroupContext *c, CGroupDeviceAllow *a);
 146 void cgroup_context_free_io_device_weight(CGroupContext *c, CGroupIODeviceWeight *w);
 147 void cgroup_context_free_io_device_limit(CGroupContext *c, CGroupIODeviceLimit *l);
 148 void cgroup_context_free_io_device_latency(CGroupContext *c, CGroupIODeviceLatency *l);
 149 void cgroup_context_free_blockio_device_weight(CGroupContext *c, CGroupBlockIODeviceWeight *w);
 150 void cgroup_context_free_blockio_device_bandwidth(CGroupContext *c, CGroupBlockIODeviceBandwidth *b);
 151
 152 int cgroup_add_device_allow(CGroupContext *c, const char *dev, const char *mode);
 153
 154 CGroupMask unit_get_own_mask(Unit *u);
 155 CGroupMask unit_get_delegate_mask(Unit *u);
 156 CGroupMask unit_get_members_mask(Unit *u);
 157 CGroupMask unit_get_siblings_mask(Unit *u);
 158 CGroupMask unit_get_subtree_mask(Unit *u);
 159 CGroupMask unit_get_disable_mask(Unit *u);
 160 CGroupMask unit_get_ancestor_disable_mask(Unit *u);
 161
 162 CGroupMask unit_get_target_mask(Unit *u);
 163 CGroupMask unit_get_enable_mask(Unit *u);
 164
 165 void unit_invalidate_cgroup_members_masks(Unit *u);
 166
 167 void unit_add_to_cgroup_realize_queue(Unit *u);
 168
 169 const char *unit_get_realized_cgroup_path(Unit *u, CGroupMask mask);
 170 char *unit_default_cgroup_path(const Unit *u);
 171 int unit_set_cgroup_path(Unit *u, const char *path);
 172 int unit_pick_cgroup_path(Unit *u);
 173
 174 int unit_realize_cgroup(Unit *u);
 175 void unit_release_cgroup(Unit *u);
 176 void unit_prune_cgroup(Unit *u);
 177 int unit_watch_cgroup(Unit *u);
 178
 179 void unit_add_to_cgroup_empty_queue(Unit *u);
 180
 181 int unit_attach_pids_to_cgroup(Unit *u, Set *pids, const char *suffix_path);
 182
 183 int manager_setup_cgroup(Manager *m);
 184 void manager_shutdown_cgroup(Manager *m, bool delete);
 185
 186 unsigned manager_dispatch_cgroup_realize_queue(Manager *m);
 187
 188 Unit *manager_get_unit_by_cgroup(Manager *m, const char *cgroup);
 189 Unit *manager_get_unit_by_pid_cgroup(Manager *m, pid_t pid);
 190 Unit* manager_get_unit_by_pid(Manager *m, pid_t pid);
 191
 192 int unit_search_main_pid(Unit *u, pid_t *ret);
 193 int unit_watch_all_pids(Unit *u);
 194
 195 int unit_synthesize_cgroup_empty_event(Unit *u);
 196
 197 int unit_get_memory_current(Unit *u, uint64_t *ret);
 198 int unit_get_tasks_current(Unit *u, uint64_t *ret);
 199 int unit_get_cpu_usage(Unit *u, nsec_t *ret);
 200 int unit_get_ip_accounting(Unit *u, CGroupIPAccountingMetric metric, uint64_t *ret);
 201
 202 int unit_reset_cpu_accounting(Unit *u);
 203 int unit_reset_ip_accounting(Unit *u);
 204
 205 #define UNIT_CGROUP_BOOL(u, name)                       \
 206         ({                                              \
 207         CGroupContext *cc = unit_get_cgroup_context(u); \
 208         cc ? cc->name : false;                          \
 209         })
 210
 211 bool manager_owns_host_root_cgroup(Manager *m);
 212 bool unit_has_host_root_cgroup(Unit *u);
 213
 214 int manager_notify_cgroup_empty(Manager *m, const char *group);
 215
 216 void unit_invalidate_cgroup(Unit *u, CGroupMask m);
 217 void unit_invalidate_cgroup_bpf(Unit *u);
 218
 219 void manager_invalidate_startup_units(Manager *m);
 220
 221 const char* cgroup_device_policy_to_string(CGroupDevicePolicy i) _const_;
 222 CGroupDevicePolicy cgroup_device_policy_from_string(const char *s) _pure_;
 223
 224 bool unit_cgroup_delegate(Unit *u);