14606977008

Committed 22 Apr 2025 11:53PM UTC coverage: 72.18% (+0.1%) from 72.043%

Build # 14606977008

Build Type

push

github

Committed by

web-flow

Commit Message

network: enable ARP when IPv4LL and/or IPv4ACD is enabled (#37190)

Coverage Stats

51 of 56 new or added lines in 5 files covered. (91.07%)

1842 existing lines in 57 files now uncovered.

297069 of 411566 relevant lines covered (72.18%)

691007.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

63.64

/src/basic/cgroup-util.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include <dirent.h>
#include <fcntl.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <sys/statfs.h>
#include <sys/types.h>

#include "constants.h"
#include "pidref.h"
#include "set.h"

#define SYSTEMD_CGROUP_CONTROLLER_LEGACY "name=systemd"
#define SYSTEMD_CGROUP_CONTROLLER_HYBRID "name=unified"
#define SYSTEMD_CGROUP_CONTROLLER "_systemd"

/* An enum of well known cgroup controllers */
typedef enum CGroupController {
        /* Original cgroup controllers */
        CGROUP_CONTROLLER_CPU,
        CGROUP_CONTROLLER_CPUACCT,    /* v1 only */
        CGROUP_CONTROLLER_CPUSET,     /* v2 only */
        CGROUP_CONTROLLER_IO,         /* v2 only */
        CGROUP_CONTROLLER_BLKIO,      /* v1 only */
        CGROUP_CONTROLLER_MEMORY,
        CGROUP_CONTROLLER_DEVICES,    /* v1 only */
        CGROUP_CONTROLLER_PIDS,

        /* BPF-based pseudo-controllers, v2 only */
        CGROUP_CONTROLLER_BPF_FIREWALL,
        CGROUP_CONTROLLER_BPF_DEVICES,
        CGROUP_CONTROLLER_BPF_FOREIGN,
        CGROUP_CONTROLLER_BPF_SOCKET_BIND,
        CGROUP_CONTROLLER_BPF_RESTRICT_NETWORK_INTERFACES,
        /* The BPF hook implementing RestrictFileSystems= is not defined here.
         * It's applied as late as possible in exec_invoke() so we don't block
         * our own unit setup code. */

        _CGROUP_CONTROLLER_MAX,
        _CGROUP_CONTROLLER_INVALID = -EINVAL,
} CGroupController;

#define CGROUP_CONTROLLER_TO_MASK(c) (1U << (c))

/* A bit mask of well known cgroup controllers */
typedef enum CGroupMask {
        CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
        CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
        CGROUP_MASK_CPUSET = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUSET),
        CGROUP_MASK_IO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_IO),
        CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
        CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
        CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
        CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
        CGROUP_MASK_BPF_FIREWALL = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FIREWALL),
        CGROUP_MASK_BPF_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_DEVICES),
        CGROUP_MASK_BPF_FOREIGN = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FOREIGN),
        CGROUP_MASK_BPF_SOCKET_BIND = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_SOCKET_BIND),
        CGROUP_MASK_BPF_RESTRICT_NETWORK_INTERFACES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_RESTRICT_NETWORK_INTERFACES),

        /* All real cgroup v1 controllers */
        CGROUP_MASK_V1 = CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT|CGROUP_MASK_BLKIO|CGROUP_MASK_MEMORY|CGROUP_MASK_DEVICES|CGROUP_MASK_PIDS,

        /* All real cgroup v2 controllers */
        CGROUP_MASK_V2 = CGROUP_MASK_CPU|CGROUP_MASK_CPUSET|CGROUP_MASK_IO|CGROUP_MASK_MEMORY|CGROUP_MASK_PIDS,

        /* All controllers we want to delegate in case of Delegate=yes. Which are pretty much the v2 controllers only, as delegation on v1 is not safe, and bpf stuff isn't a real controller */
        CGROUP_MASK_DELEGATE = CGROUP_MASK_V2,

        /* All cgroup v2 BPF pseudo-controllers */
        CGROUP_MASK_BPF = CGROUP_MASK_BPF_FIREWALL|CGROUP_MASK_BPF_DEVICES|CGROUP_MASK_BPF_FOREIGN|CGROUP_MASK_BPF_SOCKET_BIND|CGROUP_MASK_BPF_RESTRICT_NETWORK_INTERFACES,

        _CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1,
} CGroupMask;

static inline CGroupMask CGROUP_MASK_EXTEND_JOINED(CGroupMask mask) {
        /* We always mount "cpu" and "cpuacct" in the same hierarchy. Hence, when one bit is set also set the other */

        if (mask & (CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT))
                mask |= (CGROUP_MASK_CPU|CGROUP_MASK_CPUACCT);

        return mask;
}

CGroupMask get_cpu_accounting_mask(void);
bool cpu_accounting_is_cheap(void);

/* Special values for all weight knobs on unified hierarchy */
#define CGROUP_WEIGHT_INVALID UINT64_MAX
#define CGROUP_WEIGHT_IDLE UINT64_C(0)
#define CGROUP_WEIGHT_MIN UINT64_C(1)
#define CGROUP_WEIGHT_MAX UINT64_C(10000)
#define CGROUP_WEIGHT_DEFAULT UINT64_C(100)

#define CGROUP_LIMIT_MIN UINT64_C(0)
#define CGROUP_LIMIT_MAX UINT64_MAX

static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) {
        return
            x == CGROUP_WEIGHT_INVALID ||
            (x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX);
}

/* IO limits on unified hierarchy */
typedef enum CGroupIOLimitType {
        CGROUP_IO_RBPS_MAX,
        CGROUP_IO_WBPS_MAX,
        CGROUP_IO_RIOPS_MAX,
        CGROUP_IO_WIOPS_MAX,

        _CGROUP_IO_LIMIT_TYPE_MAX,
        _CGROUP_IO_LIMIT_TYPE_INVALID = -EINVAL,
} CGroupIOLimitType;

extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX];

const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_;
CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_;

/* Special values for the cpu.shares attribute */
#define CGROUP_CPU_SHARES_INVALID UINT64_MAX
#define CGROUP_CPU_SHARES_MIN UINT64_C(2)
#define CGROUP_CPU_SHARES_MAX UINT64_C(262144)
#define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024)

static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
        return
            x == CGROUP_CPU_SHARES_INVALID ||
            (x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
}

/* Special values for the special {blkio,io}.bfq.weight attribute */
#define CGROUP_BFQ_WEIGHT_INVALID UINT64_MAX
#define CGROUP_BFQ_WEIGHT_MIN UINT64_C(1)
#define CGROUP_BFQ_WEIGHT_MAX UINT64_C(1000)
#define CGROUP_BFQ_WEIGHT_DEFAULT UINT64_C(100)

/* Convert the normal io.weight value to io.bfq.weight */
static inline uint64_t BFQ_WEIGHT(uint64_t io_weight) {
        return
            io_weight <= CGROUP_WEIGHT_DEFAULT ?
            CGROUP_BFQ_WEIGHT_DEFAULT - (CGROUP_WEIGHT_DEFAULT - io_weight) * (CGROUP_BFQ_WEIGHT_DEFAULT - CGROUP_BFQ_WEIGHT_MIN) / (CGROUP_WEIGHT_DEFAULT - CGROUP_WEIGHT_MIN) :
            CGROUP_BFQ_WEIGHT_DEFAULT + (io_weight - CGROUP_WEIGHT_DEFAULT) * (CGROUP_BFQ_WEIGHT_MAX - CGROUP_BFQ_WEIGHT_DEFAULT) / (CGROUP_WEIGHT_MAX - CGROUP_WEIGHT_DEFAULT);
}

/* Special values for the blkio.weight attribute */
#define CGROUP_BLKIO_WEIGHT_INVALID UINT64_MAX
#define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
#define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
#define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)

static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
        return
            x == CGROUP_BLKIO_WEIGHT_INVALID ||
            (x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
}

typedef enum CGroupUnified {
        CGROUP_UNIFIED_UNKNOWN = -1,
        CGROUP_UNIFIED_NONE = 0,        /* Both systemd and controllers on legacy */
        CGROUP_UNIFIED_SYSTEMD = 1,     /* Only systemd on unified */
        CGROUP_UNIFIED_ALL = 2,         /* Both systemd and controllers on unified */
} CGroupUnified;

/*
 * General rules:
 *
 * We accept named hierarchies in the syntax "foo" and "name=foo".
 *
 * We expect that named hierarchies do not conflict in name with a
 * kernel hierarchy, modulo the "name=" prefix.
 *
 * We always generate "normalized" controller names, i.e. without the
 * "name=" prefix.
 *
 * We require absolute cgroup paths. When returning, we will always
 * generate paths with multiple adjacent / removed.
 */

int cg_path_open(const char *controller, const char *path);
int cg_cgroupid_open(int fsfd, uint64_t id);

int cg_path_from_cgroupid(int cgroupfs_fd, uint64_t id, char **ret);
int cg_get_cgroupid_at(int dfd, const char *path, uint64_t *ret);
static inline int cg_path_get_cgroupid(const char *path, uint64_t *ret) {
        return cg_get_cgroupid_at(AT_FDCWD, path, ret);
}
static inline int cg_fd_get_cgroupid(int fd, uint64_t *ret) {
        return cg_get_cgroupid_at(fd, NULL, ret);
}

typedef enum CGroupFlags {
        CGROUP_SIGCONT            = 1 << 0,
        CGROUP_IGNORE_SELF        = 1 << 1,
        CGROUP_DONT_SKIP_UNMAPPED = 1 << 2,
        CGROUP_NO_PIDFD           = 1 << 3,
} CGroupFlags;

int cg_enumerate_processes(const char *controller, const char *path, FILE **ret);
int cg_read_pid(FILE *f, pid_t *ret, CGroupFlags flags);
int cg_read_pidref(FILE *f, PidRef *ret, CGroupFlags flags);
int cg_read_event(const char *controller, const char *path, const char *event, char **ret);

int cg_enumerate_subgroups(const char *controller, const char *path, DIR **ret);
int cg_read_subgroup(DIR *d, char **ret);

typedef int (*cg_kill_log_func_t)(const PidRef *pid, int sig, void *userdata);

int cg_kill(const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata);
int cg_kill_kernel_sigkill(const char *path);
int cg_kill_recursive(const char *path, int sig, CGroupFlags flags, Set *s, cg_kill_log_func_t kill_log, void *userdata);

int cg_split_spec(const char *spec, char **ret_controller, char **ret_path);
int cg_mangle_path(const char *path, char **ret);

int cg_get_path(const char *controller, const char *path, const char *suffix, char **ret);
int cg_get_path_and_check(const char *controller, const char *path, const char *suffix, char **ret);

int cg_pid_get_path(const char *controller, pid_t pid, char **ret);
int cg_pidref_get_path(const char *controller, const PidRef *pidref, char **ret);

int cg_is_threaded(const char *path);

int cg_is_delegated(const char *path);
int cg_is_delegated_fd(int fd);

int cg_has_coredump_receive(const char *path);

typedef enum {
        CG_KEY_MODE_GRACEFUL = 1 << 0,
} CGroupKeyMode;

int cg_set_attribute(const char *controller, const char *path, const char *attribute, const char *value);
int cg_get_attribute(const char *controller, const char *path, const char *attribute, char **ret);
int cg_get_keyed_attribute_full(const char *controller, const char *path, const char *attribute, char **keys, char **values, CGroupKeyMode mode);

static inline int cg_get_keyed_attribute(
                const char *controller,
                const char *path,
                const char *attribute,
                char **keys,
                char **ret_values) {
        return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, 0);
}

static inline int cg_get_keyed_attribute_graceful(
                const char *controller,
                const char *path,
                const char *attribute,
                char **keys,
                char **ret_values) {
        return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, CG_KEY_MODE_GRACEFUL);
}

int cg_get_attribute_as_uint64(const char *controller, const char *path, const char *attribute, uint64_t *ret);

/* Does a parse_boolean() on the attribute contents and sets ret accordingly */
int cg_get_attribute_as_bool(const char *controller, const char *path, const char *attribute, bool *ret);

int cg_get_owner(const char *path, uid_t *ret_uid);

int cg_set_xattr(const char *path, const char *name, const void *value, size_t size, int flags);
int cg_get_xattr_malloc(const char *path, const char *name, char **ret, size_t *ret_size);
/* Returns negative on error, and 0 or 1 on success for the bool value */
int cg_get_xattr_bool(const char *path, const char *name);
int cg_remove_xattr(const char *path, const char *name);

int cg_is_empty(const char *controller, const char *path);
int cg_is_empty_recursive(const char *controller, const char *path);

int cg_get_root_path(char **path);

int cg_path_get_session(const char *path, char **ret_session);
int cg_path_get_owner_uid(const char *path, uid_t *ret_uid);
int cg_path_get_unit(const char *path, char **ret_unit);
int cg_path_get_unit_path(const char *path, char **ret_unit);
int cg_path_get_user_unit(const char *path, char **ret_unit);
int cg_path_get_machine_name(const char *path, char **ret_machine);
int cg_path_get_slice(const char *path, char **ret_slice);
int cg_path_get_user_slice(const char *path, char **ret_slice);

int cg_shift_path(const char *cgroup, const char *cached_root, const char **ret_shifted);
int cg_pid_get_path_shifted(pid_t pid, const char *cached_root, char **ret_cgroup);

int cg_pid_get_session(pid_t pid, char **ret_session);
int cg_pidref_get_session(const PidRef *pidref, char **ret);
int cg_pid_get_owner_uid(pid_t pid, uid_t *ret_uid);
int cg_pidref_get_owner_uid(const PidRef *pidref, uid_t *ret);
int cg_pid_get_unit(pid_t pid, char **ret_unit);
int cg_pidref_get_unit(const PidRef *pidref, char **ret);
int cg_pid_get_user_unit(pid_t pid, char **ret_unit);
int cg_pid_get_machine_name(pid_t pid, char **ret_machine);
int cg_pid_get_slice(pid_t pid, char **ret_slice);
int cg_pid_get_user_slice(pid_t pid, char **ret_slice);

int cg_path_decode_unit(const char *cgroup, char **ret_unit);

bool cg_needs_escape(const char *p);
int cg_escape(const char *p, char **ret);
char* cg_unescape(const char *p) _pure_;

bool cg_controller_is_valid(const char *p);

int cg_slice_to_path(const char *unit, char **ret);

int cg_mask_supported(CGroupMask *ret);
int cg_mask_supported_subtree(const char *root, CGroupMask *ret);
int cg_mask_from_string(const char *s, CGroupMask *ret);
int cg_mask_to_string(CGroupMask mask, char **ret);

bool cg_kill_supported(void);

int cg_all_unified(void);
int cg_hybrid_unified(void);
int cg_unified_controller(const char *controller);
int cg_unified_cached(bool flush);
static inline int cg_unified(void) {
        return cg_unified_cached(true);
}

const char* cgroup_controller_to_string(CGroupController c) _const_;
CGroupController cgroup_controller_from_string(const char *s) _pure_;

typedef enum ManagedOOMMode {
        MANAGED_OOM_AUTO,
        MANAGED_OOM_KILL,
        _MANAGED_OOM_MODE_MAX,
        _MANAGED_OOM_MODE_INVALID = -EINVAL,
} ManagedOOMMode;

const char* managed_oom_mode_to_string(ManagedOOMMode m) _const_;
ManagedOOMMode managed_oom_mode_from_string(const char *s) _pure_;

typedef enum ManagedOOMPreference {
        MANAGED_OOM_PREFERENCE_NONE = 0,
        MANAGED_OOM_PREFERENCE_AVOID = 1,
        MANAGED_OOM_PREFERENCE_OMIT = 2,
        _MANAGED_OOM_PREFERENCE_MAX,
        _MANAGED_OOM_PREFERENCE_INVALID = -EINVAL,
} ManagedOOMPreference;

const char* managed_oom_preference_to_string(ManagedOOMPreference a) _const_;
ManagedOOMPreference managed_oom_preference_from_string(const char *s) _pure_;

/* The structure to pass to name_to_handle_at() on cgroupfs2 */
typedef union {
        struct file_handle file_handle;
        uint8_t space[offsetof(struct file_handle, f_handle) + sizeof(uint64_t)];
} cg_file_handle;

#define CG_FILE_HANDLE_INIT                                     \
        (cg_file_handle) {                                      \
                .file_handle.handle_bytes = sizeof(uint64_t),   \
                .file_handle.handle_type = FILEID_KERNFS,       \
        }

#define CG_FILE_HANDLE_CGROUPID(fh) (*(uint64_t*) (fh).file_handle.f_handle)

1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
2	#pragma once
3
4	#include <dirent.h>
5	#include <fcntl.h>
6	#include <stdbool.h>
7	#include <stdint.h>
8	#include <stdio.h>
9	#include <sys/statfs.h>
10	#include <sys/types.h>
11
12	#include "constants.h"
13	#include "pidref.h"
14	#include "set.h"
15
16	#define SYSTEMD_CGROUP_CONTROLLER_LEGACY "name=systemd"
17	#define SYSTEMD_CGROUP_CONTROLLER_HYBRID "name=unified"
18	#define SYSTEMD_CGROUP_CONTROLLER "_systemd"
19
20	/* An enum of well known cgroup controllers */
21	typedef enum CGroupController {
22	/* Original cgroup controllers */
23	CGROUP_CONTROLLER_CPU,
24	CGROUP_CONTROLLER_CPUACCT, /* v1 only */
25	CGROUP_CONTROLLER_CPUSET, /* v2 only */
26	CGROUP_CONTROLLER_IO, /* v2 only */
27	CGROUP_CONTROLLER_BLKIO, /* v1 only */
28	CGROUP_CONTROLLER_MEMORY,
29	CGROUP_CONTROLLER_DEVICES, /* v1 only */
30	CGROUP_CONTROLLER_PIDS,
31
32	/* BPF-based pseudo-controllers, v2 only */
33	CGROUP_CONTROLLER_BPF_FIREWALL,
34	CGROUP_CONTROLLER_BPF_DEVICES,
35	CGROUP_CONTROLLER_BPF_FOREIGN,
36	CGROUP_CONTROLLER_BPF_SOCKET_BIND,
37	CGROUP_CONTROLLER_BPF_RESTRICT_NETWORK_INTERFACES,
38	/* The BPF hook implementing RestrictFileSystems= is not defined here.
39	* It's applied as late as possible in exec_invoke() so we don't block
40	* our own unit setup code. */
41
42	_CGROUP_CONTROLLER_MAX,
43	_CGROUP_CONTROLLER_INVALID = -EINVAL,
44	} CGroupController;
45
46	#define CGROUP_CONTROLLER_TO_MASK(c) (1U << (c))
47
48	/* A bit mask of well known cgroup controllers */
49	typedef enum CGroupMask {
50	CGROUP_MASK_CPU = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPU),
51	CGROUP_MASK_CPUACCT = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUACCT),
52	CGROUP_MASK_CPUSET = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_CPUSET),
53	CGROUP_MASK_IO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_IO),
54	CGROUP_MASK_BLKIO = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BLKIO),
55	CGROUP_MASK_MEMORY = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_MEMORY),
56	CGROUP_MASK_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_DEVICES),
57	CGROUP_MASK_PIDS = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_PIDS),
58	CGROUP_MASK_BPF_FIREWALL = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FIREWALL),
59	CGROUP_MASK_BPF_DEVICES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_DEVICES),
60	CGROUP_MASK_BPF_FOREIGN = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_FOREIGN),
61	CGROUP_MASK_BPF_SOCKET_BIND = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_SOCKET_BIND),
62	CGROUP_MASK_BPF_RESTRICT_NETWORK_INTERFACES = CGROUP_CONTROLLER_TO_MASK(CGROUP_CONTROLLER_BPF_RESTRICT_NETWORK_INTERFACES),
63
64	/* All real cgroup v1 controllers */
65	CGROUP_MASK_V1 = CGROUP_MASK_CPU\|CGROUP_MASK_CPUACCT\|CGROUP_MASK_BLKIO\|CGROUP_MASK_MEMORY\|CGROUP_MASK_DEVICES\|CGROUP_MASK_PIDS,
66
67	/* All real cgroup v2 controllers */
68	CGROUP_MASK_V2 = CGROUP_MASK_CPU\|CGROUP_MASK_CPUSET\|CGROUP_MASK_IO\|CGROUP_MASK_MEMORY\|CGROUP_MASK_PIDS,
69
70	/* All controllers we want to delegate in case of Delegate=yes. Which are pretty much the v2 controllers only, as delegation on v1 is not safe, and bpf stuff isn't a real controller */
71	CGROUP_MASK_DELEGATE = CGROUP_MASK_V2,
72
73	/* All cgroup v2 BPF pseudo-controllers */
74	CGROUP_MASK_BPF = CGROUP_MASK_BPF_FIREWALL\|CGROUP_MASK_BPF_DEVICES\|CGROUP_MASK_BPF_FOREIGN\|CGROUP_MASK_BPF_SOCKET_BIND\|CGROUP_MASK_BPF_RESTRICT_NETWORK_INTERFACES,
75
76	_CGROUP_MASK_ALL = CGROUP_CONTROLLER_TO_MASK(_CGROUP_CONTROLLER_MAX) - 1,
77	} CGroupMask;
78
79	static inline CGroupMask CGROUP_MASK_EXTEND_JOINED(CGroupMask mask) {	1,291,215✔
80	/* We always mount "cpu" and "cpuacct" in the same hierarchy. Hence, when one bit is set also set the other */
81
82	if (mask & (CGROUP_MASK_CPU\|CGROUP_MASK_CPUACCT))	1,291,213✔
83	mask \|= (CGROUP_MASK_CPU\|CGROUP_MASK_CPUACCT);	21,302✔
84
85	return mask;	1,282,732✔
86	}
87
88	CGroupMask get_cpu_accounting_mask(void);
89	bool cpu_accounting_is_cheap(void);
90
91	/* Special values for all weight knobs on unified hierarchy */
92	#define CGROUP_WEIGHT_INVALID UINT64_MAX
93	#define CGROUP_WEIGHT_IDLE UINT64_C(0)
94	#define CGROUP_WEIGHT_MIN UINT64_C(1)
95	#define CGROUP_WEIGHT_MAX UINT64_C(10000)
96	#define CGROUP_WEIGHT_DEFAULT UINT64_C(100)
97
98	#define CGROUP_LIMIT_MIN UINT64_C(0)
99	#define CGROUP_LIMIT_MAX UINT64_MAX
100
UNCOV 101	static inline bool CGROUP_WEIGHT_IS_OK(uint64_t x) {	×
UNCOV 102	return	×
UNCOV 103	x == CGROUP_WEIGHT_INVALID \|\|	×
UNCOV 104	(x >= CGROUP_WEIGHT_MIN && x <= CGROUP_WEIGHT_MAX);	×
105	}
106
107	/* IO limits on unified hierarchy */
108	typedef enum CGroupIOLimitType {
109	CGROUP_IO_RBPS_MAX,
110	CGROUP_IO_WBPS_MAX,
111	CGROUP_IO_RIOPS_MAX,
112	CGROUP_IO_WIOPS_MAX,
113
114	_CGROUP_IO_LIMIT_TYPE_MAX,
115	_CGROUP_IO_LIMIT_TYPE_INVALID = -EINVAL,
116	} CGroupIOLimitType;
117
118	extern const uint64_t cgroup_io_limit_defaults[_CGROUP_IO_LIMIT_TYPE_MAX];
119
120	const char* cgroup_io_limit_type_to_string(CGroupIOLimitType t) _const_;
121	CGroupIOLimitType cgroup_io_limit_type_from_string(const char *s) _pure_;
122
123	/* Special values for the cpu.shares attribute */
124	#define CGROUP_CPU_SHARES_INVALID UINT64_MAX
125	#define CGROUP_CPU_SHARES_MIN UINT64_C(2)
126	#define CGROUP_CPU_SHARES_MAX UINT64_C(262144)
127	#define CGROUP_CPU_SHARES_DEFAULT UINT64_C(1024)
128
129	static inline bool CGROUP_CPU_SHARES_IS_OK(uint64_t x) {
130	return
131	x == CGROUP_CPU_SHARES_INVALID \|\|
132	(x >= CGROUP_CPU_SHARES_MIN && x <= CGROUP_CPU_SHARES_MAX);
133	}
134
135	/* Special values for the special {blkio,io}.bfq.weight attribute */
136	#define CGROUP_BFQ_WEIGHT_INVALID UINT64_MAX
137	#define CGROUP_BFQ_WEIGHT_MIN UINT64_C(1)
138	#define CGROUP_BFQ_WEIGHT_MAX UINT64_C(1000)
139	#define CGROUP_BFQ_WEIGHT_DEFAULT UINT64_C(100)
140
141	/* Convert the normal io.weight value to io.bfq.weight */
142	static inline uint64_t BFQ_WEIGHT(uint64_t io_weight) {	×
143	return	×
144	io_weight <= CGROUP_WEIGHT_DEFAULT ?
145	CGROUP_BFQ_WEIGHT_DEFAULT - (CGROUP_WEIGHT_DEFAULT - io_weight) * (CGROUP_BFQ_WEIGHT_DEFAULT - CGROUP_BFQ_WEIGHT_MIN) / (CGROUP_WEIGHT_DEFAULT - CGROUP_WEIGHT_MIN) :	×
146	CGROUP_BFQ_WEIGHT_DEFAULT + (io_weight - CGROUP_WEIGHT_DEFAULT) * (CGROUP_BFQ_WEIGHT_MAX - CGROUP_BFQ_WEIGHT_DEFAULT) / (CGROUP_WEIGHT_MAX - CGROUP_WEIGHT_DEFAULT);	×
147	}
148
149	/* Special values for the blkio.weight attribute */
150	#define CGROUP_BLKIO_WEIGHT_INVALID UINT64_MAX
151	#define CGROUP_BLKIO_WEIGHT_MIN UINT64_C(10)
152	#define CGROUP_BLKIO_WEIGHT_MAX UINT64_C(1000)
153	#define CGROUP_BLKIO_WEIGHT_DEFAULT UINT64_C(500)
154
155	static inline bool CGROUP_BLKIO_WEIGHT_IS_OK(uint64_t x) {
156	return
157	x == CGROUP_BLKIO_WEIGHT_INVALID \|\|
158	(x >= CGROUP_BLKIO_WEIGHT_MIN && x <= CGROUP_BLKIO_WEIGHT_MAX);
159	}
160
161	typedef enum CGroupUnified {
162	CGROUP_UNIFIED_UNKNOWN = -1,
163	CGROUP_UNIFIED_NONE = 0, /* Both systemd and controllers on legacy */
164	CGROUP_UNIFIED_SYSTEMD = 1, /* Only systemd on unified */
165	CGROUP_UNIFIED_ALL = 2, /* Both systemd and controllers on unified */
166	} CGroupUnified;
167
168	/*
169	* General rules:
170	*
171	* We accept named hierarchies in the syntax "foo" and "name=foo".
172	*
173	* We expect that named hierarchies do not conflict in name with a
174	* kernel hierarchy, modulo the "name=" prefix.
175	*
176	* We always generate "normalized" controller names, i.e. without the
177	* "name=" prefix.
178	*
179	* We require absolute cgroup paths. When returning, we will always
180	* generate paths with multiple adjacent / removed.
181	*/
182
183	int cg_path_open(const char controller, const char path);
184	int cg_cgroupid_open(int fsfd, uint64_t id);
185
186	int cg_path_from_cgroupid(int cgroupfs_fd, uint64_t id, char **ret);
187	int cg_get_cgroupid_at(int dfd, const char path, uint64_t ret);
188	static inline int cg_path_get_cgroupid(const char path, uint64_t ret) {	3,997✔
189	return cg_get_cgroupid_at(AT_FDCWD, path, ret);	3,997✔
190	}
191	static inline int cg_fd_get_cgroupid(int fd, uint64_t *ret) {	34✔
192	return cg_get_cgroupid_at(fd, NULL, ret);	34✔
193	}
194
195	typedef enum CGroupFlags {
196	CGROUP_SIGCONT = 1 << 0,
197	CGROUP_IGNORE_SELF = 1 << 1,
198	CGROUP_DONT_SKIP_UNMAPPED = 1 << 2,
199	CGROUP_NO_PIDFD = 1 << 3,
200	} CGroupFlags;
201
202	int cg_enumerate_processes(const char controller, const char path, FILE **ret);
203	int cg_read_pid(FILE f, pid_t ret, CGroupFlags flags);
204	int cg_read_pidref(FILE f, PidRef ret, CGroupFlags flags);
205	int cg_read_event(const char controller, const char path, const char event, char *ret);
206
207	int cg_enumerate_subgroups(const char controller, const char path, DIR **ret);
208	int cg_read_subgroup(DIR d, char *ret);
209
210	typedef int (cg_kill_log_func_t)(const PidRef pid, int sig, void *userdata);
211
212	int cg_kill(const char path, int sig, CGroupFlags flags, Set s, cg_kill_log_func_t kill_log, void *userdata);
213	int cg_kill_kernel_sigkill(const char *path);
214	int cg_kill_recursive(const char path, int sig, CGroupFlags flags, Set s, cg_kill_log_func_t kill_log, void *userdata);
215
216	int cg_split_spec(const char spec, char ret_controller, char *ret_path);
217	int cg_mangle_path(const char path, char *ret);
218
219	int cg_get_path(const char controller, const char path, const char suffix, char *ret);
220	int cg_get_path_and_check(const char controller, const char path, const char suffix, char *ret);
221
222	int cg_pid_get_path(const char controller, pid_t pid, char *ret);
223	int cg_pidref_get_path(const char controller, const PidRef pidref, char **ret);
224
225	int cg_is_threaded(const char *path);
226
227	int cg_is_delegated(const char *path);
228	int cg_is_delegated_fd(int fd);
229
230	int cg_has_coredump_receive(const char *path);
231
232	typedef enum {
233	CG_KEY_MODE_GRACEFUL = 1 << 0,
234	} CGroupKeyMode;
235
236	int cg_set_attribute(const char controller, const char path, const char attribute, const char value);
237	int cg_get_attribute(const char controller, const char path, const char attribute, char *ret);
238	int cg_get_keyed_attribute_full(const char controller, const char path, const char attribute, char keys, char *values, CGroupKeyMode mode);
239
240	static inline int cg_get_keyed_attribute(	18,317✔
241	const char *controller,
242	const char *path,
243	const char *attribute,
244	char **keys,
245	char **ret_values) {
246	return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, 0);	18,317✔
247	}
248
249	static inline int cg_get_keyed_attribute_graceful(	8,070✔
250	const char *controller,
251	const char *path,
252	const char *attribute,
253	char **keys,
254	char **ret_values) {
255	return cg_get_keyed_attribute_full(controller, path, attribute, keys, ret_values, CG_KEY_MODE_GRACEFUL);	8,070✔
256	}
257
258	int cg_get_attribute_as_uint64(const char controller, const char path, const char attribute, uint64_t ret);
259
260	/* Does a parse_boolean() on the attribute contents and sets ret accordingly */
261	int cg_get_attribute_as_bool(const char controller, const char path, const char attribute, bool ret);
262
263	int cg_get_owner(const char path, uid_t ret_uid);
264
265	int cg_set_xattr(const char path, const char name, const void *value, size_t size, int flags);
266	int cg_get_xattr_malloc(const char path, const char name, char *ret, size_t ret_size);
267	/* Returns negative on error, and 0 or 1 on success for the bool value */
268	int cg_get_xattr_bool(const char path, const char name);
269	int cg_remove_xattr(const char path, const char name);
270
271	int cg_is_empty(const char controller, const char path);
272	int cg_is_empty_recursive(const char controller, const char path);
273
274	int cg_get_root_path(char **path);
275
276	int cg_path_get_session(const char path, char *ret_session);
277	int cg_path_get_owner_uid(const char path, uid_t ret_uid);
278	int cg_path_get_unit(const char path, char *ret_unit);
279	int cg_path_get_unit_path(const char path, char *ret_unit);
280	int cg_path_get_user_unit(const char path, char *ret_unit);
281	int cg_path_get_machine_name(const char path, char *ret_machine);
282	int cg_path_get_slice(const char path, char *ret_slice);
283	int cg_path_get_user_slice(const char path, char *ret_slice);
284
285	int cg_shift_path(const char cgroup, const char cached_root, const char **ret_shifted);
286	int cg_pid_get_path_shifted(pid_t pid, const char cached_root, char *ret_cgroup);
287
288	int cg_pid_get_session(pid_t pid, char **ret_session);
289	int cg_pidref_get_session(const PidRef pidref, char *ret);
290	int cg_pid_get_owner_uid(pid_t pid, uid_t *ret_uid);
291	int cg_pidref_get_owner_uid(const PidRef pidref, uid_t ret);
292	int cg_pid_get_unit(pid_t pid, char **ret_unit);
293	int cg_pidref_get_unit(const PidRef pidref, char *ret);
294	int cg_pid_get_user_unit(pid_t pid, char **ret_unit);
295	int cg_pid_get_machine_name(pid_t pid, char **ret_machine);
296	int cg_pid_get_slice(pid_t pid, char **ret_slice);
297	int cg_pid_get_user_slice(pid_t pid, char **ret_slice);
298
299	int cg_path_decode_unit(const char cgroup, char *ret_unit);
300
301	bool cg_needs_escape(const char *p);
302	int cg_escape(const char p, char *ret);
303	char* cg_unescape(const char *p) _pure_;
304
305	bool cg_controller_is_valid(const char *p);
306
307	int cg_slice_to_path(const char unit, char *ret);
308
309	int cg_mask_supported(CGroupMask *ret);
310	int cg_mask_supported_subtree(const char root, CGroupMask ret);
311	int cg_mask_from_string(const char s, CGroupMask ret);
312	int cg_mask_to_string(CGroupMask mask, char **ret);
313
314	bool cg_kill_supported(void);
315
316	int cg_all_unified(void);
317	int cg_hybrid_unified(void);
318	int cg_unified_controller(const char *controller);
319	int cg_unified_cached(bool flush);
320	static inline int cg_unified(void) {	4✔
321	return cg_unified_cached(true);	4✔
322	}
323
324	const char* cgroup_controller_to_string(CGroupController c) _const_;
325	CGroupController cgroup_controller_from_string(const char *s) _pure_;
326
327	typedef enum ManagedOOMMode {
328	MANAGED_OOM_AUTO,
329	MANAGED_OOM_KILL,
330	_MANAGED_OOM_MODE_MAX,
331	_MANAGED_OOM_MODE_INVALID = -EINVAL,
332	} ManagedOOMMode;
333
334	const char* managed_oom_mode_to_string(ManagedOOMMode m) _const_;
335	ManagedOOMMode managed_oom_mode_from_string(const char *s) _pure_;
336
337	typedef enum ManagedOOMPreference {
338	MANAGED_OOM_PREFERENCE_NONE = 0,
339	MANAGED_OOM_PREFERENCE_AVOID = 1,
340	MANAGED_OOM_PREFERENCE_OMIT = 2,
341	_MANAGED_OOM_PREFERENCE_MAX,
342	_MANAGED_OOM_PREFERENCE_INVALID = -EINVAL,
343	} ManagedOOMPreference;
344
345	const char* managed_oom_preference_to_string(ManagedOOMPreference a) _const_;
346	ManagedOOMPreference managed_oom_preference_from_string(const char *s) _pure_;
347
348	/* The structure to pass to name_to_handle_at() on cgroupfs2 */
349	typedef union {
350	struct file_handle file_handle;
351	uint8_t space[offsetof(struct file_handle, f_handle) + sizeof(uint64_t)];
352	} cg_file_handle;
353
354	#define CG_FILE_HANDLE_INIT \
355	(cg_file_handle) { \
356	.file_handle.handle_bytes = sizeof(uint64_t), \
357	.file_handle.handle_type = FILEID_KERNFS, \
358	}
359
360	#define CG_FILE_HANDLE_CGROUPID(fh) ((uint64_t) (fh).file_handle.f_handle)

systemd / systemd / 14606977008

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous