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