1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (c) 2017 Facebook
5 #include "test_progs.h"
6 #include "cgroup_helpers.h"
7 #include "bpf_rlimit.h"
13 #include <execinfo.h> /* backtrace */
14 #include <linux/membarrier.h>
16 #define EXIT_NO_TEST 2
17 #define EXIT_ERR_SETUP_INFRA 3
19 /* defined in test_progs.h */
20 struct test_env env = {};
22 struct prog_test_def {
23 const char *test_name;
25 void (*run_test)(void);
30 bool need_cgroup_cleanup;
35 /* store counts before subtest started */
39 /* Override C runtime library's usleep() implementation to ensure nanosleep()
40 * is always called. Usleep is frequently used in selftests as a way to
41 * trigger kprobe and tracepoints.
43 int usleep(useconds_t usec)
45 struct timespec ts = {
46 .tv_sec = usec / 1000000,
47 .tv_nsec = (usec % 1000000) * 1000,
50 return syscall(__NR_nanosleep, &ts, NULL);
53 static bool should_run(struct test_selector *sel, int num, const char *name)
57 for (i = 0; i < sel->blacklist.cnt; i++) {
58 if (strstr(name, sel->blacklist.strs[i]))
62 for (i = 0; i < sel->whitelist.cnt; i++) {
63 if (strstr(name, sel->whitelist.strs[i]))
67 if (!sel->whitelist.cnt && !sel->num_set)
70 return num < sel->num_set_len && sel->num_set[num];
73 static void dump_test_log(const struct prog_test_def *test, bool failed)
75 if (stdout == env.stdout)
78 fflush(stdout); /* exports env.log_buf & env.log_cnt */
80 if (env.verbosity > VERBOSE_NONE || test->force_log || failed) {
82 env.log_buf[env.log_cnt] = '\0';
83 fprintf(env.stdout, "%s", env.log_buf);
84 if (env.log_buf[env.log_cnt - 1] != '\n')
85 fprintf(env.stdout, "\n");
89 fseeko(stdout, 0, SEEK_SET); /* rewind */
92 static void skip_account(void)
94 if (env.test->skip_cnt) {
96 env.test->skip_cnt = 0;
100 static void stdio_restore(void);
102 /* A bunch of tests set custom affinity per-thread and/or per-process. Reset
103 * it after each test/sub-test.
105 static void reset_affinity() {
111 for (i = 0; i < env.nr_cpus; i++)
114 err = sched_setaffinity(0, sizeof(cpuset), &cpuset);
117 fprintf(stderr, "Failed to reset process affinity: %d!\n", err);
118 exit(EXIT_ERR_SETUP_INFRA);
120 err = pthread_setaffinity_np(pthread_self(), sizeof(cpuset), &cpuset);
123 fprintf(stderr, "Failed to reset thread affinity: %d!\n", err);
124 exit(EXIT_ERR_SETUP_INFRA);
128 static void save_netns(void)
130 env.saved_netns_fd = open("/proc/self/ns/net", O_RDONLY);
131 if (env.saved_netns_fd == -1) {
132 perror("open(/proc/self/ns/net)");
133 exit(EXIT_ERR_SETUP_INFRA);
137 static void restore_netns(void)
139 if (setns(env.saved_netns_fd, CLONE_NEWNET) == -1) {
141 perror("setns(CLONE_NEWNS)");
142 exit(EXIT_ERR_SETUP_INFRA);
146 void test__end_subtest()
148 struct prog_test_def *test = env.test;
149 int sub_error_cnt = test->error_cnt - test->old_error_cnt;
153 else if (test->skip_cnt == 0)
157 dump_test_log(test, sub_error_cnt);
159 fprintf(env.stdout, "#%d/%d %s:%s\n",
160 test->test_num, test->subtest_num, test->subtest_name,
161 sub_error_cnt ? "FAIL" : (test->skip_cnt ? "SKIP" : "OK"));
163 free(test->subtest_name);
164 test->subtest_name = NULL;
167 bool test__start_subtest(const char *name)
169 struct prog_test_def *test = env.test;
171 if (test->subtest_name)
176 if (!name || !name[0]) {
178 "Subtest #%d didn't provide sub-test name!\n",
183 if (!should_run(&env.subtest_selector, test->subtest_num, name))
186 test->subtest_name = strdup(name);
187 if (!test->subtest_name) {
189 "Subtest #%d: failed to copy subtest name!\n",
193 env.test->old_error_cnt = env.test->error_cnt;
198 void test__force_log() {
199 env.test->force_log = true;
202 void test__skip(void)
204 env.test->skip_cnt++;
207 void test__fail(void)
209 env.test->error_cnt++;
212 int test__join_cgroup(const char *path)
216 if (!env.test->need_cgroup_cleanup) {
217 if (setup_cgroup_environment()) {
219 "#%d %s: Failed to setup cgroup environment\n",
220 env.test->test_num, env.test->test_name);
224 env.test->need_cgroup_cleanup = true;
227 fd = create_and_get_cgroup(path);
230 "#%d %s: Failed to create cgroup '%s' (errno=%d)\n",
231 env.test->test_num, env.test->test_name, path, errno);
235 if (join_cgroup(path)) {
237 "#%d %s: Failed to join cgroup '%s' (errno=%d)\n",
238 env.test->test_num, env.test->test_name, path, errno);
245 int bpf_find_map(const char *test, struct bpf_object *obj, const char *name)
249 map = bpf_object__find_map_by_name(obj, name);
251 fprintf(stdout, "%s:FAIL:map '%s' not found\n", test, name);
255 return bpf_map__fd(map);
258 static bool is_jit_enabled(void)
260 const char *jit_sysctl = "/proc/sys/net/core/bpf_jit_enable";
261 bool enabled = false;
264 sysctl_fd = open(jit_sysctl, 0, O_RDONLY);
265 if (sysctl_fd != -1) {
268 if (read(sysctl_fd, &tmpc, sizeof(tmpc)) == 1)
269 enabled = (tmpc != '0');
276 int compare_map_keys(int map1_fd, int map2_fd)
279 char val_buf[PERF_MAX_STACK_DEPTH *
280 sizeof(struct bpf_stack_build_id)];
283 err = bpf_map_get_next_key(map1_fd, NULL, &key);
286 err = bpf_map_lookup_elem(map2_fd, &key, val_buf);
290 while (bpf_map_get_next_key(map1_fd, &key, &next_key) == 0) {
291 err = bpf_map_lookup_elem(map2_fd, &next_key, val_buf);
303 int compare_stack_ips(int smap_fd, int amap_fd, int stack_trace_len)
305 __u32 key, next_key, *cur_key_p, *next_key_p;
306 char *val_buf1, *val_buf2;
309 val_buf1 = malloc(stack_trace_len);
310 val_buf2 = malloc(stack_trace_len);
313 while (bpf_map_get_next_key(smap_fd, cur_key_p, next_key_p) == 0) {
314 err = bpf_map_lookup_elem(smap_fd, next_key_p, val_buf1);
317 err = bpf_map_lookup_elem(amap_fd, next_key_p, val_buf2);
320 for (i = 0; i < stack_trace_len; i++) {
321 if (val_buf1[i] != val_buf2[i]) {
328 next_key_p = &next_key;
339 int extract_build_id(char *build_id, size_t size)
345 fp = popen("readelf -n ./urandom_read | grep 'Build ID'", "r");
349 if (getline(&line, &len, fp) == -1)
355 memcpy(build_id, line, len);
356 build_id[len] = '\0';
364 static int finit_module(int fd, const char *param_values, int flags)
366 return syscall(__NR_finit_module, fd, param_values, flags);
369 static int delete_module(const char *name, int flags)
371 return syscall(__NR_delete_module, name, flags);
375 * Trigger synchronize_rcu() in kernel.
377 int kern_sync_rcu(void)
379 return syscall(__NR_membarrier, MEMBARRIER_CMD_SHARED, 0, 0);
382 static void unload_bpf_testmod(void)
385 fprintf(env.stderr, "Failed to trigger kernel-side RCU sync!\n");
386 if (delete_module("bpf_testmod", 0)) {
387 if (errno == ENOENT) {
388 if (env.verbosity > VERBOSE_NONE)
389 fprintf(stdout, "bpf_testmod.ko is already unloaded.\n");
392 fprintf(env.stderr, "Failed to unload bpf_testmod.ko from kernel: %d\n", -errno);
395 if (env.verbosity > VERBOSE_NONE)
396 fprintf(stdout, "Successfully unloaded bpf_testmod.ko.\n");
399 static int load_bpf_testmod(void)
403 /* ensure previous instance of the module is unloaded */
404 unload_bpf_testmod();
406 if (env.verbosity > VERBOSE_NONE)
407 fprintf(stdout, "Loading bpf_testmod.ko...\n");
409 fd = open("bpf_testmod.ko", O_RDONLY);
411 fprintf(env.stderr, "Can't find bpf_testmod.ko kernel module: %d\n", -errno);
414 if (finit_module(fd, "", 0)) {
415 fprintf(env.stderr, "Failed to load bpf_testmod.ko into the kernel: %d\n", -errno);
421 if (env.verbosity > VERBOSE_NONE)
422 fprintf(stdout, "Successfully loaded bpf_testmod.ko.\n");
426 /* extern declarations for test funcs */
427 #define DEFINE_TEST(name) extern void test_##name(void);
428 #include <prog_tests/tests.h>
431 static struct prog_test_def prog_test_defs[] = {
432 #define DEFINE_TEST(name) { \
433 .test_name = #name, \
434 .run_test = &test_##name, \
436 #include <prog_tests/tests.h>
439 const int prog_test_cnt = ARRAY_SIZE(prog_test_defs);
441 const char *argp_program_version = "test_progs 0.1";
442 const char *argp_program_bug_address = "<bpf@vger.kernel.org>";
443 const char argp_program_doc[] = "BPF selftests test runner";
448 ARG_TEST_NAME_BLACKLIST = 'b',
449 ARG_VERIFIER_STATS = 's',
451 ARG_GET_TEST_CNT = 'c',
452 ARG_LIST_TEST_NAMES = 'l',
455 static const struct argp_option opts[] = {
456 { "num", ARG_TEST_NUM, "NUM", 0,
457 "Run test number NUM only " },
458 { "name", ARG_TEST_NAME, "NAMES", 0,
459 "Run tests with names containing any string from NAMES list" },
460 { "name-blacklist", ARG_TEST_NAME_BLACKLIST, "NAMES", 0,
461 "Don't run tests with names containing any string from NAMES list" },
462 { "verifier-stats", ARG_VERIFIER_STATS, NULL, 0,
463 "Output verifier statistics", },
464 { "verbose", ARG_VERBOSE, "LEVEL", OPTION_ARG_OPTIONAL,
465 "Verbose output (use -vv or -vvv for progressively verbose output)" },
466 { "count", ARG_GET_TEST_CNT, NULL, 0,
467 "Get number of selected top-level tests " },
468 { "list", ARG_LIST_TEST_NAMES, NULL, 0,
469 "List test names that would run (without running them) " },
473 static int libbpf_print_fn(enum libbpf_print_level level,
474 const char *format, va_list args)
476 if (env.verbosity < VERBOSE_VERY && level == LIBBPF_DEBUG)
478 vfprintf(stdout, format, args);
482 static void free_str_set(const struct str_set *set)
489 for (i = 0; i < set->cnt; i++)
490 free((void *)set->strs[i]);
494 static int parse_str_list(const char *s, struct str_set *set)
496 char *input, *state = NULL, *next, **tmp, **strs = NULL;
506 while ((next = strtok_r(state ? NULL : input, ",", &state))) {
507 tmp = realloc(strs, sizeof(*strs) * (cnt + 1));
512 strs[cnt] = strdup(next);
520 set->strs = (const char **)strs;
529 extern int extra_prog_load_log_flags;
531 static error_t parse_arg(int key, char *arg, struct argp_state *state)
533 struct test_env *env = state->input;
537 char *subtest_str = strchr(arg, '/');
541 if (parse_num_list(subtest_str + 1,
542 &env->subtest_selector.num_set,
543 &env->subtest_selector.num_set_len)) {
545 "Failed to parse subtest numbers.\n");
549 if (parse_num_list(arg, &env->test_selector.num_set,
550 &env->test_selector.num_set_len)) {
551 fprintf(stderr, "Failed to parse test numbers.\n");
556 case ARG_TEST_NAME: {
557 char *subtest_str = strchr(arg, '/');
561 if (parse_str_list(subtest_str + 1,
562 &env->subtest_selector.whitelist))
565 if (parse_str_list(arg, &env->test_selector.whitelist))
569 case ARG_TEST_NAME_BLACKLIST: {
570 char *subtest_str = strchr(arg, '/');
574 if (parse_str_list(subtest_str + 1,
575 &env->subtest_selector.blacklist))
578 if (parse_str_list(arg, &env->test_selector.blacklist))
582 case ARG_VERIFIER_STATS:
583 env->verifier_stats = true;
586 env->verbosity = VERBOSE_NORMAL;
588 if (strcmp(arg, "v") == 0) {
589 env->verbosity = VERBOSE_VERY;
590 extra_prog_load_log_flags = 1;
591 } else if (strcmp(arg, "vv") == 0) {
592 env->verbosity = VERBOSE_SUPER;
593 extra_prog_load_log_flags = 2;
596 "Unrecognized verbosity setting ('%s'), only -v and -vv are supported\n",
602 if (env->verbosity > VERBOSE_NONE) {
603 if (setenv("SELFTESTS_VERBOSE", "1", 1) == -1) {
605 "Unable to setenv SELFTESTS_VERBOSE=1 (errno=%d)",
612 case ARG_GET_TEST_CNT:
613 env->get_test_cnt = true;
615 case ARG_LIST_TEST_NAMES:
616 env->list_test_names = true;
624 return ARGP_ERR_UNKNOWN;
629 static void stdio_hijack(void)
635 if (env.verbosity > VERBOSE_NONE) {
636 /* nothing to do, output to stdout by default */
640 /* stdout and stderr -> buffer */
643 stdout = open_memstream(&env.log_buf, &env.log_cnt);
646 perror("open_memstream");
654 static void stdio_restore(void)
657 if (stdout == env.stdout)
672 * Determine if test_progs is running as a "flavored" test runner and switch
673 * into corresponding sub-directory to load correct BPF objects.
675 * This is done by looking at executable name. If it contains "-flavor"
676 * suffix, then we are running as a flavored test runner.
678 int cd_flavor_subdir(const char *exec_name)
680 /* General form of argv[0] passed here is:
681 * some/path/to/test_progs[-flavor], where -flavor part is optional.
682 * First cut out "test_progs[-flavor]" part, then extract "flavor"
683 * part, if it's there.
685 const char *flavor = strrchr(exec_name, '/');
690 flavor = strrchr(flavor, '-');
694 if (env.verbosity > VERBOSE_NONE)
695 fprintf(stdout, "Switching to flavor '%s' subdirectory...\n", flavor);
697 return chdir(flavor);
700 #define MAX_BACKTRACE_SZ 128
701 void crash_handler(int signum)
703 void *bt[MAX_BACKTRACE_SZ];
706 sz = backtrace(bt, ARRAY_SIZE(bt));
709 dump_test_log(env.test, true);
713 fprintf(stderr, "Caught signal #%d!\nStack trace:\n", signum);
714 backtrace_symbols_fd(bt, sz, STDERR_FILENO);
717 int main(int argc, char **argv)
719 static const struct argp argp = {
722 .doc = argp_program_doc,
724 struct sigaction sigact = {
725 .sa_handler = crash_handler,
726 .sa_flags = SA_RESETHAND,
730 sigaction(SIGSEGV, &sigact, NULL);
732 err = argp_parse(&argp, argc, argv, 0, NULL, &env);
736 err = cd_flavor_subdir(argv[0]);
740 libbpf_set_print(libbpf_print_fn);
744 env.jit_enabled = is_jit_enabled();
745 env.nr_cpus = libbpf_num_possible_cpus();
746 if (env.nr_cpus < 0) {
747 fprintf(stderr, "Failed to get number of CPUs: %d!\n",
754 env.has_testmod = true;
755 if (load_bpf_testmod()) {
756 fprintf(env.stderr, "WARNING! Selftests relying on bpf_testmod.ko will be skipped.\n");
757 env.has_testmod = false;
759 for (i = 0; i < prog_test_cnt; i++) {
760 struct prog_test_def *test = &prog_test_defs[i];
763 test->test_num = i + 1;
765 if (!should_run(&env.test_selector,
766 test->test_num, test->test_name))
769 if (env.get_test_cnt) {
774 if (env.list_test_names) {
775 fprintf(env.stdout, "%s\n", test->test_name);
781 /* ensure last sub-test is finalized properly */
782 if (test->subtest_name)
792 dump_test_log(test, test->error_cnt);
794 fprintf(env.stdout, "#%d %s:%s\n",
795 test->test_num, test->test_name,
796 test->error_cnt ? "FAIL" : "OK");
800 if (test->need_cgroup_cleanup)
801 cleanup_cgroup_environment();
804 unload_bpf_testmod();
807 if (env.get_test_cnt) {
808 printf("%d\n", env.succ_cnt);
812 if (env.list_test_names)
815 fprintf(stdout, "Summary: %d/%d PASSED, %d SKIPPED, %d FAILED\n",
816 env.succ_cnt, env.sub_succ_cnt, env.skip_cnt, env.fail_cnt);
819 free_str_set(&env.test_selector.blacklist);
820 free_str_set(&env.test_selector.whitelist);
821 free(env.test_selector.num_set);
822 free_str_set(&env.subtest_selector.blacklist);
823 free_str_set(&env.subtest_selector.whitelist);
824 free(env.subtest_selector.num_set);
825 close(env.saved_netns_fd);
827 if (env.succ_cnt + env.fail_cnt + env.skip_cnt == 0)
830 return env.fail_cnt ? EXIT_FAILURE : EXIT_SUCCESS;