[deliverable/linux.git] / tools / perf / util / bpf-loader.h

/*
 * Copyright (C) 2015, Wang Nan <wangnan0@huawei.com>
 * Copyright (C) 2015, Huawei Inc.
 */
#ifndef __BPF_LOADER_H
#define __BPF_LOADER_H

#include <linux/compiler.h>
#include <linux/err.h>
#include <string.h>
#include <bpf/libbpf.h>
#include "probe-event.h"
#include "evlist.h"
#include "debug.h"

enum bpf_loader_errno {
	__BPF_LOADER_ERRNO__START = __LIBBPF_ERRNO__START - 100,
	/* Invalid config string */
	BPF_LOADER_ERRNO__CONFIG = __BPF_LOADER_ERRNO__START,
	BPF_LOADER_ERRNO__GROUP,	/* Invalid group name */
	BPF_LOADER_ERRNO__EVENTNAME,	/* Event name is missing */
	BPF_LOADER_ERRNO__INTERNAL,	/* BPF loader internal error */
	BPF_LOADER_ERRNO__COMPILE,	/* Error when compiling BPF scriptlet */
	BPF_LOADER_ERRNO__PROGCONF_TERM,/* Invalid program config term in config string */
	BPF_LOADER_ERRNO__PROLOGUE,	/* Failed to generate prologue */
	BPF_LOADER_ERRNO__PROLOGUE2BIG,	/* Prologue too big for program */
	BPF_LOADER_ERRNO__PROLOGUEOOB,	/* Offset out of bound for prologue */
	BPF_LOADER_ERRNO__OBJCONF_OPT,	/* Invalid object config option */
	BPF_LOADER_ERRNO__OBJCONF_CONF,	/* Config value not set (lost '=')) */
	BPF_LOADER_ERRNO__OBJCONF_MAP_OPT,	/* Invalid object map config option */
	BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST,	/* Target map not exist */
	BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE,	/* Incorrect value type for map */
	BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE,	/* Incorrect map type */
	BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE,	/* Incorrect map key size */
	BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE,/* Incorrect map value size */
	__BPF_LOADER_ERRNO__END,
};

struct bpf_object;
struct parse_events_term;
#define PERF_BPF_PROBE_GROUP "perf_bpf_probe"

typedef int (*bpf_prog_iter_callback_t)(struct probe_trace_event *tev,
					int fd, void *arg);

#ifdef HAVE_LIBBPF_SUPPORT
struct bpf_object *bpf__prepare_load(const char *filename, bool source);
int bpf__strerror_prepare_load(const char *filename, bool source,
			       int err, char *buf, size_t size);

struct bpf_object *bpf__prepare_load_buffer(void *obj_buf, size_t obj_buf_sz,
					    const char *name);

void bpf__clear(void);

int bpf__probe(struct bpf_object *obj);
int bpf__unprobe(struct bpf_object *obj);
int bpf__strerror_probe(struct bpf_object *obj, int err,
			char *buf, size_t size);

int bpf__load(struct bpf_object *obj);
int bpf__strerror_load(struct bpf_object *obj, int err,
		       char *buf, size_t size);
int bpf__foreach_tev(struct bpf_object *obj,
		     bpf_prog_iter_callback_t func, void *arg);

int bpf__config_obj(struct bpf_object *obj, struct parse_events_term *term,
		    struct perf_evlist *evlist, int *error_pos);
int bpf__strerror_config_obj(struct bpf_object *obj,
			     struct parse_events_term *term,
			     struct perf_evlist *evlist,
			     int *error_pos, int err, char *buf,
			     size_t size);
#else
static inline struct bpf_object *
bpf__prepare_load(const char *filename __maybe_unused,
		  bool source __maybe_unused)
{
	pr_debug("ERROR: eBPF object loading is disabled during compiling.\n");
	return ERR_PTR(-ENOTSUP);
}

static inline struct bpf_object *
bpf__prepare_load_buffer(void *obj_buf __maybe_unused,
					   size_t obj_buf_sz __maybe_unused)
{
	return ERR_PTR(-ENOTSUP);
}

static inline void bpf__clear(void) { }

static inline int bpf__probe(struct bpf_object *obj __maybe_unused) { return 0;}
static inline int bpf__unprobe(struct bpf_object *obj __maybe_unused) { return 0;}
static inline int bpf__load(struct bpf_object *obj __maybe_unused) { return 0; }

static inline int
bpf__foreach_tev(struct bpf_object *obj __maybe_unused,
		 bpf_prog_iter_callback_t func __maybe_unused,
		 void *arg __maybe_unused)
{
	return 0;
}

static inline int
bpf__config_obj(struct bpf_object *obj __maybe_unused,
		struct parse_events_term *term __maybe_unused,
		struct perf_evlist *evlist __maybe_unused,
		int *error_pos __maybe_unused)
{
	return 0;
}

static inline int
__bpf_strerror(char *buf, size_t size)
{
	if (!size)
		return 0;
	strncpy(buf,
		"ERROR: eBPF object loading is disabled during compiling.\n",
		size);
	buf[size - 1] = '\0';
	return 0;
}

static inline
int bpf__strerror_prepare_load(const char *filename __maybe_unused,
			       bool source __maybe_unused,
			       int err __maybe_unused,
			       char *buf, size_t size)
{
	return __bpf_strerror(buf, size);
}

static inline int
bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
		    int err __maybe_unused,
		    char *buf, size_t size)
{
	return __bpf_strerror(buf, size);
}

static inline int bpf__strerror_load(struct bpf_object *obj __maybe_unused,
				     int err __maybe_unused,
				     char *buf, size_t size)
{
	return __bpf_strerror(buf, size);
}

static inline int
bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
			 struct parse_events_term *term __maybe_unused,
			 struct perf_evlist *evlist __maybe_unused,
			 int *error_pos __maybe_unused,
			 int err __maybe_unused,
			 char *buf, size_t size)
{
	return __bpf_strerror(buf, size);
}
#endif
#endif
Commit	Line	Data
69d262a9 WN	1	/*
	2	* Copyright (C) 2015, Wang Nan <wangnan0@huawei.com>
	3	* Copyright (C) 2015, Huawei Inc.
	4	*/
	5	#ifndef __BPF_LOADER_H
	6	#define __BPF_LOADER_H
	7
	8	#include <linux/compiler.h>
	9	#include <linux/err.h>
	10	#include <string.h>
d3e0ce39	11	#include <bpf/libbpf.h>
4edf30e3	12	#include "probe-event.h"
066dacbf	13	#include "evlist.h"
69d262a9 WN	14	#include "debug.h"
69d262a9 WN	15
d3e0ce39 WN	16	enum bpf_loader_errno {
	17	__BPF_LOADER_ERRNO__START = __LIBBPF_ERRNO__START - 100,
	18	/* Invalid config string */
	19	BPF_LOADER_ERRNO__CONFIG = __BPF_LOADER_ERRNO__START,
	20	BPF_LOADER_ERRNO__GROUP, /* Invalid group name */
	21	BPF_LOADER_ERRNO__EVENTNAME, /* Event name is missing */
	22	BPF_LOADER_ERRNO__INTERNAL, /* BPF loader internal error */
	23	BPF_LOADER_ERRNO__COMPILE, /* Error when compiling BPF scriptlet */
0bb93490	24	BPF_LOADER_ERRNO__PROGCONF_TERM,/* Invalid program config term in config string */
bfc077b4 HK	25	BPF_LOADER_ERRNO__PROLOGUE, /* Failed to generate prologue */
	26	BPF_LOADER_ERRNO__PROLOGUE2BIG, /* Prologue too big for program */
	27	BPF_LOADER_ERRNO__PROLOGUEOOB, /* Offset out of bound for prologue */
066dacbf WN	28	BPF_LOADER_ERRNO__OBJCONF_OPT, /* Invalid object config option */
	29	BPF_LOADER_ERRNO__OBJCONF_CONF, /* Config value not set (lost '=')) */
	30	BPF_LOADER_ERRNO__OBJCONF_MAP_OPT, /* Invalid object map config option */
	31	BPF_LOADER_ERRNO__OBJCONF_MAP_NOTEXIST, /* Target map not exist */
	32	BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE, /* Incorrect value type for map */
	33	BPF_LOADER_ERRNO__OBJCONF_MAP_TYPE, /* Incorrect map type */
	34	BPF_LOADER_ERRNO__OBJCONF_MAP_KEYSIZE, /* Incorrect map key size */
	35	BPF_LOADER_ERRNO__OBJCONF_MAP_VALUESIZE,/* Incorrect map value size */
d3e0ce39 WN	36	__BPF_LOADER_ERRNO__END,
	37	};
	38
69d262a9	39	struct bpf_object;
066dacbf	40	struct parse_events_term;
aa3abf30	41	#define PERF_BPF_PROBE_GROUP "perf_bpf_probe"
69d262a9	42
4edf30e3 WN	43	typedef int (bpf_prog_iter_callback_t)(struct probe_trace_event tev,
	44	int fd, void *arg);
	45
69d262a9	46	#ifdef HAVE_LIBBPF_SUPPORT
d509db04	47	struct bpf_object bpf__prepare_load(const char filename, bool source);
d3e0ce39 WN	48	int bpf__strerror_prepare_load(const char *filename, bool source,
d3e0ce39 WN	49	int err, char *buf, size_t size);
69d262a9	50
ba1fae43 WN	51	struct bpf_object bpf__prepare_load_buffer(void obj_buf, size_t obj_buf_sz,
	52	const char *name);
	53
69d262a9	54	void bpf__clear(void);
aa3abf30 WN	55
	56	int bpf__probe(struct bpf_object *obj);
	57	int bpf__unprobe(struct bpf_object *obj);
	58	int bpf__strerror_probe(struct bpf_object *obj, int err,
	59	char *buf, size_t size);
	60
1e5e3ee8 WN	61	int bpf__load(struct bpf_object *obj);
	62	int bpf__strerror_load(struct bpf_object *obj, int err,
	63	char *buf, size_t size);
4edf30e3 WN	64	int bpf__foreach_tev(struct bpf_object *obj,
4edf30e3 WN	65	bpf_prog_iter_callback_t func, void *arg);
066dacbf WN	66
	67	int bpf__config_obj(struct bpf_object obj, struct parse_events_term term,
	68	struct perf_evlist evlist, int error_pos);
	69	int bpf__strerror_config_obj(struct bpf_object *obj,
	70	struct parse_events_term *term,
	71	struct perf_evlist *evlist,
	72	int error_pos, int err, char buf,
	73	size_t size);
69d262a9 WN	74	#else
69d262a9 WN	75	static inline struct bpf_object *
d509db04 WN	76	bpf__prepare_load(const char *filename __maybe_unused,
d509db04 WN	77	bool source __maybe_unused)
69d262a9 WN	78	{
	79	pr_debug("ERROR: eBPF object loading is disabled during compiling.\n");
	80	return ERR_PTR(-ENOTSUP);
	81	}
	82
ba1fae43 WN	83	static inline struct bpf_object *
	84	bpf__prepare_load_buffer(void *obj_buf __maybe_unused,
	85	size_t obj_buf_sz __maybe_unused)
	86	{
	87	return ERR_PTR(-ENOTSUP);
	88	}
	89
69d262a9	90	static inline void bpf__clear(void) { }
aa3abf30 WN	91
	92	static inline int bpf__probe(struct bpf_object *obj __maybe_unused) { return 0;}
	93	static inline int bpf__unprobe(struct bpf_object *obj __maybe_unused) { return 0;}
1e5e3ee8	94	static inline int bpf__load(struct bpf_object *obj __maybe_unused) { return 0; }
aa3abf30	95
4edf30e3 WN	96	static inline int
	97	bpf__foreach_tev(struct bpf_object *obj __maybe_unused,
	98	bpf_prog_iter_callback_t func __maybe_unused,
	99	void *arg __maybe_unused)
	100	{
	101	return 0;
	102	}
	103
066dacbf WN	104	static inline int
	105	bpf__config_obj(struct bpf_object *obj __maybe_unused,
	106	struct parse_events_term *term __maybe_unused,
	107	struct perf_evlist *evlist __maybe_unused,
	108	int *error_pos __maybe_unused)
	109	{
	110	return 0;
	111	}
	112
aa3abf30 WN	113	static inline int
	114	__bpf_strerror(char *buf, size_t size)
	115	{
	116	if (!size)
	117	return 0;
	118	strncpy(buf,
	119	"ERROR: eBPF object loading is disabled during compiling.\n",
	120	size);
	121	buf[size - 1] = '\0';
	122	return 0;
	123	}
	124
d3e0ce39 WN	125	static inline
	126	int bpf__strerror_prepare_load(const char *filename __maybe_unused,
	127	bool source __maybe_unused,
	128	int err __maybe_unused,
	129	char *buf, size_t size)
	130	{
	131	return __bpf_strerror(buf, size);
	132	}
	133
aa3abf30 WN	134	static inline int
	135	bpf__strerror_probe(struct bpf_object *obj __maybe_unused,
	136	int err __maybe_unused,
	137	char *buf, size_t size)
	138	{
	139	return __bpf_strerror(buf, size);
	140	}
1e5e3ee8 WN	141
	142	static inline int bpf__strerror_load(struct bpf_object *obj __maybe_unused,
	143	int err __maybe_unused,
	144	char *buf, size_t size)
	145	{
	146	return __bpf_strerror(buf, size);
	147	}
066dacbf WN	148
	149	static inline int
	150	bpf__strerror_config_obj(struct bpf_object *obj __maybe_unused,
	151	struct parse_events_term *term __maybe_unused,
	152	struct perf_evlist *evlist __maybe_unused,
	153	int *error_pos __maybe_unused,
	154	int err __maybe_unused,
	155	char *buf, size_t size)
	156	{
	157	return __bpf_strerror(buf, size);
	158	}
69d262a9 WN	159	#endif
69d262a9 WN	160	#endif