src/core/cgroup.h

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