[mirror_ubuntu-artful-kernel.git] / tools / perf / tests / bpf.c

#include <errno.h>
#include <stdio.h>
#include <sys/epoll.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <util/util.h>
#include <util/bpf-loader.h>
#include <util/evlist.h>
#include <linux/bpf.h>
#include <linux/filter.h>
#include <linux/kernel.h>
#include <api/fs/fs.h>
#include <bpf/bpf.h>
#include "tests.h"
#include "llvm.h"
#include "debug.h"
#define NR_ITERS       111
#define PERF_TEST_BPF_PATH "/sys/fs/bpf/perf_test"

#ifdef HAVE_LIBBPF_SUPPORT

static int epoll_wait_loop(void)
{
	int i;

	/* Should fail NR_ITERS times */
	for (i = 0; i < NR_ITERS; i++)
		epoll_wait(-(i + 1), NULL, 0, 0);
	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;
	bool	pin;
} bpf_testcase_table[] = {
	{
		LLVM_TESTCASE_BASE,
		"Basic BPF filtering",
		"[basic_bpf_test]",
		"fix 'perf test LLVM' first",
		"load bpf object failed",
		&epoll_wait_loop,
		(NR_ITERS + 1) / 2,
		false,
	},
	{
		LLVM_TESTCASE_BASE,
		"BPF pinning",
		"[bpf_pinning]",
		"fix kbuild first",
		"check your vmlinux setting?",
		&epoll_wait_loop,
		(NR_ITERS + 1) / 2,
		true,
	},
#ifdef HAVE_BPF_PROLOGUE
	{
		LLVM_TESTCASE_BPF_PROLOGUE,
		"BPF prologue generation",
		"[bpf_prologue_test]",
		"fix kbuild first",
		"check your vmlinux setting?",
		&llseek_loop,
		(NR_ITERS + 1) / 4,
		false,
	},
#endif
	{
		LLVM_TESTCASE_BPF_RELOCATION,
		"BPF relocation checker",
		"[bpf_relocation_test]",
		"fix 'perf test LLVM' first",
		"libbpf error when dealing with relocation",
		NULL,
		0,
		false,
	},
};

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("Not enough 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, NULL);

	err = perf_evlist__open(evlist);
	if (err < 0) {
		pr_debug("perf_evlist__open: %s\n",
			 str_error_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",
			 str_error_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);
		if (ret != TEST_OK)
			goto out;
		if (bpf_testcase_table[idx].pin) {
			int err;

			if (!bpf_fs__mount()) {
				pr_debug("BPF filesystem not mounted\n");
				ret = TEST_FAIL;
				goto out;
			}
			err = mkdir(PERF_TEST_BPF_PATH, 0777);
			if (err && errno != EEXIST) {
				pr_debug("Failed to make perf_test dir: %s\n",
					 strerror(errno));
				ret = TEST_FAIL;
				goto out;
			}
			if (bpf_object__pin(obj, PERF_TEST_BPF_PATH))
				ret = TEST_FAIL;
			if (rm_rf(PERF_TEST_BPF_PATH))
				ret = TEST_FAIL;
		}
	}

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