[deliverable/linux.git] / tools / perf / tests / bpf.c

#include <stdio.h>
#include <sys/epoll.h>
#include <util/util.h>
#include <util/bpf-loader.h>
#include <util/evlist.h>
#include <linux/bpf.h>
#include <linux/filter.h>
#include <bpf/bpf.h>
#include "tests.h"
#include "llvm.h"
#include "debug.h"
#define NR_ITERS       111

#ifdef HAVE_LIBBPF_SUPPORT

static int epoll_pwait_loop(void)
{
	int i;

	/* Should fail NR_ITERS times */
	for (i = 0; i < NR_ITERS; i++)
		epoll_pwait(-(i + 1), NULL, 0, 0, NULL);
	return 0;
}

#ifdef HAVE_BPF_PROLOGUE

static int llseek_loop(void)
{
	int fds[2], i;

	fds[0] = open("/dev/null", O_RDONLY);
	fds[1] = open("/dev/null", O_RDWR);

	if (fds[0] < 0 || fds[1] < 0)
		return -1;

	for (i = 0; i < NR_ITERS; i++) {
		lseek(fds[i % 2], i, (i / 2) % 2 ? SEEK_CUR : SEEK_SET);
		lseek(fds[(i + 1) % 2], i, (i / 2) % 2 ? SEEK_CUR : SEEK_SET);
	}
	close(fds[0]);
	close(fds[1]);
	return 0;
}

#endif

static struct {
	enum test_llvm__testcase prog_id;
	const char *desc;
	const char *name;
	const char *msg_compile_fail;
	const char *msg_load_fail;
	int (*target_func)(void);
	int expect_result;
} bpf_testcase_table[] = {
	{
		LLVM_TESTCASE_BASE,
		"Test basic BPF filtering",
		"[basic_bpf_test]",
		"fix 'perf test LLVM' first",
		"load bpf object failed",
		&epoll_pwait_loop,
		(NR_ITERS + 1) / 2,
	},
#ifdef HAVE_BPF_PROLOGUE
	{
		LLVM_TESTCASE_BPF_PROLOGUE,
		"Test BPF prologue generation",
		"[bpf_prologue_test]",
		"fix kbuild first",
		"check your vmlinux setting?",
		&llseek_loop,
		(NR_ITERS + 1) / 4,
	},
#endif
	{
		LLVM_TESTCASE_BPF_RELOCATION,
		"Test BPF relocation checker",
		"[bpf_relocation_test]",
		"fix 'perf test LLVM' first",
		"libbpf error when dealing with relocation",
		NULL,
		0,
	},
};

static int do_test(struct bpf_object *obj, int (*func)(void),
		   int expect)
{
	struct record_opts opts = {
		.target = {
			.uid = UINT_MAX,
			.uses_mmap = true,
		},
		.freq	      = 0,
		.mmap_pages   = 256,
		.default_interval = 1,
	};

	char pid[16];
	char sbuf[STRERR_BUFSIZE];
	struct perf_evlist *evlist;
	int i, ret = TEST_FAIL, err = 0, count = 0;

	struct parse_events_evlist parse_evlist;
	struct parse_events_error parse_error;

	bzero(&parse_error, sizeof(parse_error));
	bzero(&parse_evlist, sizeof(parse_evlist));
	parse_evlist.error = &parse_error;
	INIT_LIST_HEAD(&parse_evlist.list);

	err = parse_events_load_bpf_obj(&parse_evlist, &parse_evlist.list, obj, NULL);
	if (err || list_empty(&parse_evlist.list)) {
		pr_debug("Failed to add events selected by BPF\n");
		return TEST_FAIL;
	}

	snprintf(pid, sizeof(pid), "%d", getpid());
	pid[sizeof(pid) - 1] = '\0';
	opts.target.tid = opts.target.pid = pid;

	/* Instead of perf_evlist__new_default, don't add default events */
	evlist = perf_evlist__new();
	if (!evlist) {
		pr_debug("No ehough memory to create evlist\n");
		return TEST_FAIL;
	}

	err = perf_evlist__create_maps(evlist, &opts.target);
	if (err < 0) {
		pr_debug("Not enough memory to create thread/cpu maps\n");
		goto out_delete_evlist;
	}

	perf_evlist__splice_list_tail(evlist, &parse_evlist.list);
	evlist->nr_groups = parse_evlist.nr_groups;

	perf_evlist__config(evlist, &opts);

	err = perf_evlist__open(evlist);
	if (err < 0) {
		pr_debug("perf_evlist__open: %s\n",
			 strerror_r(errno, sbuf, sizeof(sbuf)));
		goto out_delete_evlist;
	}

	err = perf_evlist__mmap(evlist, opts.mmap_pages, false);
	if (err < 0) {
		pr_debug("perf_evlist__mmap: %s\n",
			 strerror_r(errno, sbuf, sizeof(sbuf)));
		goto out_delete_evlist;
	}

	perf_evlist__enable(evlist);
	(*func)();
	perf_evlist__disable(evlist);

	for (i = 0; i < evlist->nr_mmaps; i++) {
		union perf_event *event;

		while ((event = perf_evlist__mmap_read(evlist, i)) != NULL) {
			const u32 type = event->header.type;

			if (type == PERF_RECORD_SAMPLE)
				count ++;
		}
	}

	if (count != expect) {
		pr_debug("BPF filter result incorrect\n");
		goto out_delete_evlist;
	}

	ret = TEST_OK;

out_delete_evlist:
	perf_evlist__delete(evlist);
	return ret;
}

static struct bpf_object *
prepare_bpf(void *obj_buf, size_t obj_buf_sz, const char *name)
{
	struct bpf_object *obj;

	obj = bpf__prepare_load_buffer(obj_buf, obj_buf_sz, name);
	if (IS_ERR(obj)) {
		pr_debug("Compile BPF program failed.\n");
		return NULL;
	}
	return obj;
}

static int __test__bpf(int idx)
{
	int ret;
	void *obj_buf;
	size_t obj_buf_sz;
	struct bpf_object *obj;

	ret = test_llvm__fetch_bpf_obj(&obj_buf, &obj_buf_sz,
				       bpf_testcase_table[idx].prog_id,
				       true, NULL);
	if (ret != TEST_OK || !obj_buf || !obj_buf_sz) {
		pr_debug("Unable to get BPF object, %s\n",
			 bpf_testcase_table[idx].msg_compile_fail);
		if (idx == 0)
			return TEST_SKIP;
		else
			return TEST_FAIL;
	}

	obj = prepare_bpf(obj_buf, obj_buf_sz,
			  bpf_testcase_table[idx].name);
	if ((!!bpf_testcase_table[idx].target_func) != (!!obj)) {
		if (!obj)
			pr_debug("Fail to load BPF object: %s\n",
				 bpf_testcase_table[idx].msg_load_fail);
		else
			pr_debug("Success unexpectedly: %s\n",
				 bpf_testcase_table[idx].msg_load_fail);
		ret = TEST_FAIL;
		goto out;
	}

	if (obj)
		ret = do_test(obj,
			      bpf_testcase_table[idx].target_func,
			      bpf_testcase_table[idx].expect_result);
out:
	bpf__clear();
	return ret;
}

int test__bpf_subtest_get_nr(void)
{
	return (int)ARRAY_SIZE(bpf_testcase_table);
}

const char *test__bpf_subtest_get_desc(int i)
{
	if (i < 0 || i >= (int)ARRAY_SIZE(bpf_testcase_table))
		return NULL;
	return bpf_testcase_table[i].desc;
}

static int check_env(void)
{
	int err;
	unsigned int kver_int;
	char license[] = "GPL";

	struct bpf_insn insns[] = {
		BPF_MOV64_IMM(BPF_REG_0, 1),
		BPF_EXIT_INSN(),
	};

	err = fetch_kernel_version(&kver_int, NULL, 0);
	if (err) {
		pr_debug("Unable to get kernel version\n");
		return err;
	}

	err = bpf_load_program(BPF_PROG_TYPE_KPROBE, insns,
			       sizeof(insns) / sizeof(insns[0]),
			       license, kver_int, NULL, 0);
	if (err < 0) {
		pr_err("Missing basic BPF support, skip this test: %s\n",
		       strerror(errno));
		return err;
	}
	close(err);

	return 0;
}

int test__bpf(int i)
{
	int err;

	if (i < 0 || i >= (int)ARRAY_SIZE(bpf_testcase_table))
		return TEST_FAIL;

	if (geteuid() != 0) {
		pr_debug("Only root can run BPF test\n");
		return TEST_SKIP;
	}

	if (check_env())
		return TEST_SKIP;

	err = __test__bpf(i);
	return err;
}

#else
int test__bpf_subtest_get_nr(void)
{
	return 0;
}

const char *test__bpf_subtest_get_desc(int i __maybe_unused)
{
	return NULL;
}

int test__bpf(int i __maybe_unused)
{
	pr_debug("Skip BPF test because BPF support is not compiled\n");
	return TEST_SKIP;
}
#endif
Commit	Line	Data
ba1fae43 WN	1	#include <stdio.h>
ba1fae43 WN	2	#include <sys/epoll.h>
6a7d550e	3	#include <util/util.h>
ba1fae43 WN	4	#include <util/bpf-loader.h>
ba1fae43 WN	5	#include <util/evlist.h>
6a7d550e WN	6	#include <linux/bpf.h>
	7	#include <linux/filter.h>
	8	#include <bpf/bpf.h>
ba1fae43 WN	9	#include "tests.h"
	10	#include "llvm.h"
	11	#include "debug.h"
	12	#define NR_ITERS 111
	13
	14	#ifdef HAVE_LIBBPF_SUPPORT
	15
	16	static int epoll_pwait_loop(void)
	17	{
	18	int i;
	19
	20	/* Should fail NR_ITERS times */
	21	for (i = 0; i < NR_ITERS; i++)
	22	epoll_pwait(-(i + 1), NULL, 0, 0, NULL);
	23	return 0;
	24	}
	25
bbb7d492 WN	26	#ifdef HAVE_BPF_PROLOGUE
	27
	28	static int llseek_loop(void)
	29	{
	30	int fds[2], i;
	31
	32	fds[0] = open("/dev/null", O_RDONLY);
	33	fds[1] = open("/dev/null", O_RDWR);
	34
	35	if (fds[0] < 0 \|\| fds[1] < 0)
	36	return -1;
	37
	38	for (i = 0; i < NR_ITERS; i++) {
	39	lseek(fds[i % 2], i, (i / 2) % 2 ? SEEK_CUR : SEEK_SET);
	40	lseek(fds[(i + 1) % 2], i, (i / 2) % 2 ? SEEK_CUR : SEEK_SET);
	41	}
	42	close(fds[0]);
	43	close(fds[1]);
	44	return 0;
	45	}
	46
	47	#endif
	48
ba1fae43 WN	49	static struct {
	50	enum test_llvm__testcase prog_id;
	51	const char *desc;
	52	const char *name;
	53	const char *msg_compile_fail;
	54	const char *msg_load_fail;
	55	int (*target_func)(void);
	56	int expect_result;
	57	} bpf_testcase_table[] = {
	58	{
	59	LLVM_TESTCASE_BASE,
	60	"Test basic BPF filtering",
	61	"[basic_bpf_test]",
	62	"fix 'perf test LLVM' first",
	63	"load bpf object failed",
	64	&epoll_pwait_loop,
	65	(NR_ITERS + 1) / 2,
	66	},
bbb7d492 WN	67	#ifdef HAVE_BPF_PROLOGUE
	68	{
	69	LLVM_TESTCASE_BPF_PROLOGUE,
	70	"Test BPF prologue generation",
	71	"[bpf_prologue_test]",
	72	"fix kbuild first",
	73	"check your vmlinux setting?",
	74	&llseek_loop,
	75	(NR_ITERS + 1) / 4,
	76	},
	77	#endif
7b6982ce WN	78	{
	79	LLVM_TESTCASE_BPF_RELOCATION,
	80	"Test BPF relocation checker",
	81	"[bpf_relocation_test]",
	82	"fix 'perf test LLVM' first",
	83	"libbpf error when dealing with relocation",
	84	NULL,
	85	0,
	86	},
ba1fae43 WN	87	};
	88
	89	static int do_test(struct bpf_object obj, int (func)(void),
	90	int expect)
	91	{
	92	struct record_opts opts = {
	93	.target = {
	94	.uid = UINT_MAX,
	95	.uses_mmap = true,
	96	},
	97	.freq = 0,
	98	.mmap_pages = 256,
	99	.default_interval = 1,
	100	};
	101
	102	char pid[16];
	103	char sbuf[STRERR_BUFSIZE];
	104	struct perf_evlist *evlist;
	105	int i, ret = TEST_FAIL, err = 0, count = 0;
	106
	107	struct parse_events_evlist parse_evlist;
	108	struct parse_events_error parse_error;
	109
	110	bzero(&parse_error, sizeof(parse_error));
	111	bzero(&parse_evlist, sizeof(parse_evlist));
	112	parse_evlist.error = &parse_error;
	113	INIT_LIST_HEAD(&parse_evlist.list);
	114
95088a59	115	err = parse_events_load_bpf_obj(&parse_evlist, &parse_evlist.list, obj, NULL);
ba1fae43 WN	116	if (err \|\| list_empty(&parse_evlist.list)) {
ba1fae43 WN	117	pr_debug("Failed to add events selected by BPF\n");
ad0dd7ae	118	return TEST_FAIL;
ba1fae43 WN	119	}
	120
	121	snprintf(pid, sizeof(pid), "%d", getpid());
	122	pid[sizeof(pid) - 1] = '\0';
	123	opts.target.tid = opts.target.pid = pid;
	124
	125	/* Instead of perf_evlist__new_default, don't add default events */
	126	evlist = perf_evlist__new();
	127	if (!evlist) {
	128	pr_debug("No ehough memory to create evlist\n");
	129	return TEST_FAIL;
	130	}
	131
	132	err = perf_evlist__create_maps(evlist, &opts.target);
	133	if (err < 0) {
	134	pr_debug("Not enough memory to create thread/cpu maps\n");
	135	goto out_delete_evlist;
	136	}
	137
	138	perf_evlist__splice_list_tail(evlist, &parse_evlist.list);
	139	evlist->nr_groups = parse_evlist.nr_groups;
	140
	141	perf_evlist__config(evlist, &opts);
	142
	143	err = perf_evlist__open(evlist);
	144	if (err < 0) {
	145	pr_debug("perf_evlist__open: %s\n",
	146	strerror_r(errno, sbuf, sizeof(sbuf)));
	147	goto out_delete_evlist;
	148	}
	149
	150	err = perf_evlist__mmap(evlist, opts.mmap_pages, false);
	151	if (err < 0) {
	152	pr_debug("perf_evlist__mmap: %s\n",
	153	strerror_r(errno, sbuf, sizeof(sbuf)));
	154	goto out_delete_evlist;
	155	}
	156
	157	perf_evlist__enable(evlist);
	158	(*func)();
	159	perf_evlist__disable(evlist);
	160
	161	for (i = 0; i < evlist->nr_mmaps; i++) {
	162	union perf_event *event;
	163
	164	while ((event = perf_evlist__mmap_read(evlist, i)) != NULL) {
	165	const u32 type = event->header.type;
	166
	167	if (type == PERF_RECORD_SAMPLE)
	168	count ++;
	169	}
	170	}
	171
ad0dd7ae	172	if (count != expect) {
ba1fae43	173	pr_debug("BPF filter result incorrect\n");
ad0dd7ae WN	174	goto out_delete_evlist;
ad0dd7ae WN	175	}
ba1fae43 WN	176
	177	ret = TEST_OK;
	178
	179	out_delete_evlist:
	180	perf_evlist__delete(evlist);
	181	return ret;
	182	}
	183
	184	static struct bpf_object *
	185	prepare_bpf(void obj_buf, size_t obj_buf_sz, const char name)
	186	{
	187	struct bpf_object *obj;
	188
	189	obj = bpf__prepare_load_buffer(obj_buf, obj_buf_sz, name);
	190	if (IS_ERR(obj)) {
	191	pr_debug("Compile BPF program failed.\n");
	192	return NULL;
	193	}
	194	return obj;
	195	}
	196
916d4092	197	static int __test__bpf(int idx)
ba1fae43 WN	198	{
	199	int ret;
	200	void *obj_buf;
	201	size_t obj_buf_sz;
	202	struct bpf_object *obj;
	203
	204	ret = test_llvm__fetch_bpf_obj(&obj_buf, &obj_buf_sz,
916d4092	205	bpf_testcase_table[idx].prog_id,
7b6982ce	206	true, NULL);
ba1fae43 WN	207	if (ret != TEST_OK \|\| !obj_buf \|\| !obj_buf_sz) {
ba1fae43 WN	208	pr_debug("Unable to get BPF object, %s\n",
916d4092 ACM	209	bpf_testcase_table[idx].msg_compile_fail);
916d4092 ACM	210	if (idx == 0)
ba1fae43 WN	211	return TEST_SKIP;
	212	else
	213	return TEST_FAIL;
	214	}
	215
	216	obj = prepare_bpf(obj_buf, obj_buf_sz,
916d4092	217	bpf_testcase_table[idx].name);
7b6982ce WN	218	if ((!!bpf_testcase_table[idx].target_func) != (!!obj)) {
	219	if (!obj)
	220	pr_debug("Fail to load BPF object: %s\n",
	221	bpf_testcase_table[idx].msg_load_fail);
	222	else
	223	pr_debug("Success unexpectedly: %s\n",
	224	bpf_testcase_table[idx].msg_load_fail);
ba1fae43 WN	225	ret = TEST_FAIL;
	226	goto out;
	227	}
	228
7b6982ce WN	229	if (obj)
	230	ret = do_test(obj,
	231	bpf_testcase_table[idx].target_func,
	232	bpf_testcase_table[idx].expect_result);
ba1fae43 WN	233	out:
	234	bpf__clear();
	235	return ret;
	236	}
	237
77a0cf68 WN	238	int test__bpf_subtest_get_nr(void)
	239	{
	240	return (int)ARRAY_SIZE(bpf_testcase_table);
	241	}
	242
	243	const char *test__bpf_subtest_get_desc(int i)
	244	{
	245	if (i < 0 \|\| i >= (int)ARRAY_SIZE(bpf_testcase_table))
	246	return NULL;
	247	return bpf_testcase_table[i].desc;
	248	}
	249
6a7d550e WN	250	static int check_env(void)
	251	{
	252	int err;
	253	unsigned int kver_int;
	254	char license[] = "GPL";
	255
	256	struct bpf_insn insns[] = {
	257	BPF_MOV64_IMM(BPF_REG_0, 1),
	258	BPF_EXIT_INSN(),
	259	};
	260
	261	err = fetch_kernel_version(&kver_int, NULL, 0);
	262	if (err) {
	263	pr_debug("Unable to get kernel version\n");
	264	return err;
	265	}
	266
	267	err = bpf_load_program(BPF_PROG_TYPE_KPROBE, insns,
	268	sizeof(insns) / sizeof(insns[0]),
	269	license, kver_int, NULL, 0);
	270	if (err < 0) {
	271	pr_err("Missing basic BPF support, skip this test: %s\n",
	272	strerror(errno));
	273	return err;
	274	}
	275	close(err);
	276
	277	return 0;
	278	}
	279
77a0cf68	280	int test__bpf(int i)
ba1fae43	281	{
ba1fae43 WN	282	int err;
ba1fae43 WN	283
77a0cf68 WN	284	if (i < 0 \|\| i >= (int)ARRAY_SIZE(bpf_testcase_table))
	285	return TEST_FAIL;
	286
ba1fae43 WN	287	if (geteuid() != 0) {
	288	pr_debug("Only root can run BPF test\n");
	289	return TEST_SKIP;
	290	}
	291
6a7d550e WN	292	if (check_env())
	293	return TEST_SKIP;
	294
77a0cf68 WN	295	err = __test__bpf(i);
	296	return err;
	297	}
ba1fae43	298
77a0cf68 WN	299	#else
	300	int test__bpf_subtest_get_nr(void)
	301	{
	302	return 0;
	303	}
ba1fae43	304
77a0cf68 WN	305	const char *test__bpf_subtest_get_desc(int i __maybe_unused)
	306	{
	307	return NULL;
ba1fae43 WN	308	}
ba1fae43 WN	309
77a0cf68	310	int test__bpf(int i __maybe_unused)
ba1fae43 WN	311	{
	312	pr_debug("Skip BPF test because BPF support is not compiled\n");
	313	return TEST_SKIP;
	314	}
	315	#endif