xref: /linux/tools/testing/selftests/cgroup/lib/include/cgroup_util.h (revision eb69e955de7bdea6aa932fc4cce413ca439a4a5d)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #include <stdbool.h>
3 #include <stdlib.h>
4 
5 #ifndef BUF_SIZE
6 #define BUF_SIZE 4096
7 #endif
8 
9 #define MB(x) (x << 20)
10 #define GB(x) ((unsigned long long)(x) << 30)
11 
12 #define NSEC_PER_USEC	1000L
13 #define USEC_PER_SEC	1000000L
14 #define NSEC_PER_SEC	1000000000L
15 
16 #define TEST_UID	65534 /* usually nobody, any !root is fine */
17 
18 #define CG_THREADS_FILE (!cg_test_v1_named ? "cgroup.threads" : "tasks")
19 #define CG_NAMED_NAME "selftest"
20 #define CG_PATH_FORMAT (!cg_test_v1_named ? "0::%s" : (":name=" CG_NAMED_NAME ":%s"))
21 
22 #define DEFAULT_WAIT_INTERVAL_US (100 * 1000) /* 100 ms */
23 
24 /* from include/linux/memcontrol.h, which userspace cannot include */
25 #define MEMCG_CHARGE_BATCH	64
26 
27 /*
28  * Checks if two given values differ by less than err% of their sum.
29  */
30 static inline int values_close(long a, long b, int err)
31 {
32 	return labs(a - b) <= (a + b) / 100 * err;
33 }
34 
35 /*
36  * Checks if two given values differ by less than err% of their sum and assert
37  * with detailed debug info if not.
38  */
39 static inline int values_close_report(long a, long b, int err)
40 {
41 	long diff  = labs(a - b);
42 	long limit = (a + b) / 100 * err;
43 	double actual_err = (a + b) ? (100.0 * diff / (a + b)) : 0.0;
44 	int close = diff <= limit;
45 
46 	if (!close)
47 		fprintf(stderr,
48 			"[FAIL] actual=%ld expected=%ld | diff=%ld | limit=%ld | "
49 			"tolerance=%d%% | actual_error=%.2f%%\n",
50 			a, b, diff, limit, err, actual_err);
51 
52 	return close;
53 }
54 
55 extern ssize_t read_text(const char *path, char *buf, size_t max_len);
56 extern ssize_t write_text(const char *path, char *buf, ssize_t len);
57 
58 extern int cg_find_controller_root(char *root, size_t len, const char *controller);
59 extern int cg_find_unified_root(char *root, size_t len, bool *nsdelegate);
60 extern char *cg_name(const char *root, const char *name);
61 extern char *cg_name_indexed(const char *root, const char *name, int index);
62 extern char *cg_control(const char *cgroup, const char *control);
63 extern int cg_create(const char *cgroup);
64 extern int cg_destroy(const char *cgroup);
65 extern int cg_read(const char *cgroup, const char *control,
66 		   char *buf, size_t len);
67 extern int cg_read_strcmp(const char *cgroup, const char *control,
68 			  const char *expected);
69 extern int cg_read_strcmp_wait(const char *cgroup, const char *control,
70 				   const char *expected);
71 extern int cg_read_strstr(const char *cgroup, const char *control,
72 			  const char *needle);
73 extern long cg_read_long(const char *cgroup, const char *control);
74 extern long cg_read_long_fd(int fd);
75 long cg_read_key_long(const char *cgroup, const char *control, const char *key);
76 long cg_read_key_long_poll(const char *cgroup, const char *control,
77 			   const char *key, long expected, int retries,
78 			   useconds_t wait_interval_us);
79 extern long cg_read_lc(const char *cgroup, const char *control);
80 extern int cg_write(const char *cgroup, const char *control, char *buf);
81 extern int cg_open(const char *cgroup, const char *control, int flags);
82 int cg_write_numeric(const char *cgroup, const char *control, long value);
83 extern int cg_run(const char *cgroup,
84 		  int (*fn)(const char *cgroup, void *arg),
85 		  void *arg);
86 extern int cg_enter(const char *cgroup, int pid);
87 extern int cg_enter_current(const char *cgroup);
88 extern int cg_enter_current_thread(const char *cgroup);
89 extern int cg_run_nowait(const char *cgroup,
90 			 int (*fn)(const char *cgroup, void *arg),
91 			 void *arg);
92 extern int cg_wait_for_proc_count(const char *cgroup, int count);
93 extern int cg_killall(const char *cgroup);
94 int proc_mount_contains(const char *option);
95 int cgroup_feature(const char *feature);
96 extern ssize_t proc_read_text(int pid, bool thread, const char *item, char *buf, size_t size);
97 extern int proc_read_strstr(int pid, bool thread, const char *item, const char *needle);
98 extern pid_t clone_into_cgroup(int cgroup_fd);
99 extern int clone_reap(pid_t pid, int options);
100 extern int clone_into_cgroup_run_wait(const char *cgroup);
101 extern int dirfd_open_opath(const char *dir);
102 extern int cg_prepare_for_wait(const char *cgroup);
103 extern int memcg_prepare_for_wait(const char *cgroup);
104 extern int cg_wait_for(int fd);
105 extern bool cg_test_v1_named;
106