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 typedef struct CGroupContext CGroupContext;
  18 typedef struct CGroupDeviceAllow CGroupDeviceAllow;
  19 typedef struct CGroupIODeviceWeight CGroupIODeviceWeight;
  20 typedef struct CGroupIODeviceLimit CGroupIODeviceLimit;
  21 typedef struct CGroupBlockIODeviceWeight CGroupBlockIODeviceWeight;
  22 typedef struct CGroupBlockIODeviceBandwidth CGroupBlockIODeviceBandwidth;
  23
  24 typedef enum CGroupDevicePolicy {
  25
  26         /* When devices listed, will allow those, plus built-in ones,
  27         if none are listed will allow everything. */
  28         CGROUP_AUTO,
  29
  30         /* Everything forbidden, except built-in ones and listed ones. */
  31         CGROUP_CLOSED,
  32
  33         /* Everythings forbidden, except for the listed devices */
  34         CGROUP_STRICT,
  35
  36         _CGROUP_DEVICE_POLICY_MAX,
  37         _CGROUP_DEVICE_POLICY_INVALID = -1
  38 } CGroupDevicePolicy;
  39
  40 struct CGroupDeviceAllow {
  41         LIST_FIELDS(CGroupDeviceAllow, device_allow);
  42         char *path;
  43         bool r:1;
  44         bool w:1;
  45         bool m:1;
  46 };
  47
  48 struct CGroupIODeviceWeight {
  49         LIST_FIELDS(CGroupIODeviceWeight, device_weights);
  50         char *path;
  51         uint64_t weight;
  52 };
  53
  54 struct CGroupIODeviceLimit {
  55         LIST_FIELDS(CGroupIODeviceLimit, device_limits);
  56         char *path;
  57         uint64_t limits[_CGROUP_IO_LIMIT_TYPE_MAX];
  58 };
  59
  60 struct CGroupBlockIODeviceWeight {
  61         LIST_FIELDS(CGroupBlockIODeviceWeight, device_weights);
  62         char *path;
  63         uint64_t weight;
  64 };
  65
  66 struct CGroupBlockIODeviceBandwidth {
  67         LIST_FIELDS(CGroupBlockIODeviceBandwidth, device_bandwidths);
  68         char *path;
  69         uint64_t rbps;
  70         uint64_t wbps;
  71 };
  72
  73 struct CGroupContext {
  74         bool cpu_accounting;
  75         bool io_accounting;
  76         bool blockio_accounting;
  77         bool memory_accounting;
  78         bool tasks_accounting;
  79         bool ip_accounting;
  80
  81         /* For unified hierarchy */
  82         uint64_t cpu_weight;
  83         uint64_t startup_cpu_weight;
  84         usec_t cpu_quota_per_sec_usec;
  85
  86         uint64_t io_weight;
  87         uint64_t startup_io_weight;
  88         LIST_HEAD(CGroupIODeviceWeight, io_device_weights);
  89         LIST_HEAD(CGroupIODeviceLimit, io_device_limits);
  90
  91         uint64_t memory_low;
  92         uint64_t memory_high;
  93         uint64_t memory_max;
  94         uint64_t memory_swap_max;
  95
  96         LIST_HEAD(IPAddressAccessItem, ip_address_allow);
  97         LIST_HEAD(IPAddressAccessItem, ip_address_deny);
  98
  99         /* For legacy hierarchies */
 100         uint64_t cpu_shares;
 101         uint64_t startup_cpu_shares;
 102
 103         uint64_t blockio_weight;
 104         uint64_t startup_blockio_weight;
 105         LIST_HEAD(CGroupBlockIODeviceWeight, blockio_device_weights);
 106         LIST_HEAD(CGroupBlockIODeviceBandwidth, blockio_device_bandwidths);
 107
 108         uint64_t memory_limit;
 109
 110         CGroupDevicePolicy device_policy;
 111         LIST_HEAD(CGroupDeviceAllow, device_allow);
 112
 113         /* Common */
 114         uint64_t tasks_max;
 115
 116         bool delegate;
 117         CGroupMask delegate_controllers;
 118 };
 119
 120 /* Used when querying IP accounting data */
 121 typedef enum CGroupIPAccountingMetric {
 122         CGROUP_IP_INGRESS_BYTES,
 123         CGROUP_IP_INGRESS_PACKETS,
 124         CGROUP_IP_EGRESS_BYTES,
 125         CGROUP_IP_EGRESS_PACKETS,
 126         _CGROUP_IP_ACCOUNTING_METRIC_MAX,
 127         _CGROUP_IP_ACCOUNTING_METRIC_INVALID = -1,
 128 } CGroupIPAccountingMetric;
 129
 130 #include "unit.h"
 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
 171 int manager_setup_cgroup(Manager *m);
 172 void manager_shutdown_cgroup(Manager *m, bool delete);
 173
 174 unsigned manager_dispatch_cgroup_realize_queue(Manager *m);
 175
 176 Unit *manager_get_unit_by_cgroup(Manager *m, const char *cgroup);
 177 Unit *manager_get_unit_by_pid_cgroup(Manager *m, pid_t pid);
 178 Unit* manager_get_unit_by_pid(Manager *m, pid_t pid);
 179
 180 int unit_search_main_pid(Unit *u, pid_t *ret);
 181 int unit_watch_all_pids(Unit *u);
 182
 183 int unit_synthesize_cgroup_empty_event(Unit *u);
 184
 185 int unit_get_memory_current(Unit *u, uint64_t *ret);
 186 int unit_get_tasks_current(Unit *u, uint64_t *ret);
 187 int unit_get_cpu_usage(Unit *u, nsec_t *ret);
 188 int unit_get_ip_accounting(Unit *u, CGroupIPAccountingMetric metric, uint64_t *ret);
 189
 190 int unit_reset_cpu_accounting(Unit *u);
 191 int unit_reset_ip_accounting(Unit *u);
 192
 193 #define UNIT_CGROUP_BOOL(u, name)                       \
 194         ({                                              \
 195         CGroupContext *cc = unit_get_cgroup_context(u); \
 196         cc ? cc->name : false;                          \
 197         })
 198
 199 bool manager_owns_root_cgroup(Manager *m);
 200 bool unit_has_root_cgroup(Unit *u);
 201
 202 int manager_notify_cgroup_empty(Manager *m, const char *group);
 203
 204 void unit_invalidate_cgroup(Unit *u, CGroupMask m);
 205 void unit_invalidate_cgroup_bpf(Unit *u);
 206
 207 void manager_invalidate_startup_units(Manager *m);
 208
 209 const char* cgroup_device_policy_to_string(CGroupDevicePolicy i) _const_;
 210 CGroupDevicePolicy cgroup_device_policy_from_string(const char *s) _pure_;
 211
 212 bool unit_cgroup_delegate(Unit *u);