src/core/cgroup.h

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