[linux-block.git] / tools / testing / selftests / bpf / bpf_helpers.h

#ifndef __BPF_HELPERS_H
#define __BPF_HELPERS_H

/* helper macro to place programs, maps, license in
 * different sections in elf_bpf file. Section names
 * are interpreted by elf_bpf loader
 */
#define SEC(NAME) __attribute__((section(NAME), used))

/* helper functions called from eBPF programs written in C */
static void *(*bpf_map_lookup_elem)(void *map, void *key) =
	(void *) BPF_FUNC_map_lookup_elem;
static int (*bpf_map_update_elem)(void *map, void *key, void *value,
				  unsigned long long flags) =
	(void *) BPF_FUNC_map_update_elem;
static int (*bpf_map_delete_elem)(void *map, void *key) =
	(void *) BPF_FUNC_map_delete_elem;
static int (*bpf_probe_read)(void *dst, int size, void *unsafe_ptr) =
	(void *) BPF_FUNC_probe_read;
static unsigned long long (*bpf_ktime_get_ns)(void) =
	(void *) BPF_FUNC_ktime_get_ns;
static int (*bpf_trace_printk)(const char *fmt, int fmt_size, ...) =
	(void *) BPF_FUNC_trace_printk;
static void (*bpf_tail_call)(void *ctx, void *map, int index) =
	(void *) BPF_FUNC_tail_call;
static unsigned long long (*bpf_get_smp_processor_id)(void) =
	(void *) BPF_FUNC_get_smp_processor_id;
static unsigned long long (*bpf_get_current_pid_tgid)(void) =
	(void *) BPF_FUNC_get_current_pid_tgid;
static unsigned long long (*bpf_get_current_uid_gid)(void) =
	(void *) BPF_FUNC_get_current_uid_gid;
static int (*bpf_get_current_comm)(void *buf, int buf_size) =
	(void *) BPF_FUNC_get_current_comm;
static unsigned long long (*bpf_perf_event_read)(void *map,
						 unsigned long long flags) =
	(void *) BPF_FUNC_perf_event_read;
static int (*bpf_clone_redirect)(void *ctx, int ifindex, int flags) =
	(void *) BPF_FUNC_clone_redirect;
static int (*bpf_redirect)(int ifindex, int flags) =
	(void *) BPF_FUNC_redirect;
static int (*bpf_redirect_map)(void *map, int key, int flags) =
	(void *) BPF_FUNC_redirect_map;
static int (*bpf_perf_event_output)(void *ctx, void *map,
				    unsigned long long flags, void *data,
				    int size) =
	(void *) BPF_FUNC_perf_event_output;
static int (*bpf_get_stackid)(void *ctx, void *map, int flags) =
	(void *) BPF_FUNC_get_stackid;
static int (*bpf_probe_write_user)(void *dst, void *src, int size) =
	(void *) BPF_FUNC_probe_write_user;
static int (*bpf_current_task_under_cgroup)(void *map, int index) =
	(void *) BPF_FUNC_current_task_under_cgroup;
static int (*bpf_skb_get_tunnel_key)(void *ctx, void *key, int size, int flags) =
	(void *) BPF_FUNC_skb_get_tunnel_key;
static int (*bpf_skb_set_tunnel_key)(void *ctx, void *key, int size, int flags) =
	(void *) BPF_FUNC_skb_set_tunnel_key;
static int (*bpf_skb_get_tunnel_opt)(void *ctx, void *md, int size) =
	(void *) BPF_FUNC_skb_get_tunnel_opt;
static int (*bpf_skb_set_tunnel_opt)(void *ctx, void *md, int size) =
	(void *) BPF_FUNC_skb_set_tunnel_opt;
static unsigned long long (*bpf_get_prandom_u32)(void) =
	(void *) BPF_FUNC_get_prandom_u32;
static int (*bpf_xdp_adjust_head)(void *ctx, int offset) =
	(void *) BPF_FUNC_xdp_adjust_head;
static int (*bpf_setsockopt)(void *ctx, int level, int optname, void *optval,
			     int optlen) =
	(void *) BPF_FUNC_setsockopt;

/* llvm builtin functions that eBPF C program may use to
 * emit BPF_LD_ABS and BPF_LD_IND instructions
 */
struct sk_buff;
unsigned long long load_byte(void *skb,
			     unsigned long long off) asm("llvm.bpf.load.byte");
unsigned long long load_half(void *skb,
			     unsigned long long off) asm("llvm.bpf.load.half");
unsigned long long load_word(void *skb,
			     unsigned long long off) asm("llvm.bpf.load.word");

/* a helper structure used by eBPF C program
 * to describe map attributes to elf_bpf loader
 */
struct bpf_map_def {
	unsigned int type;
	unsigned int key_size;
	unsigned int value_size;
	unsigned int max_entries;
	unsigned int map_flags;
	unsigned int inner_map_idx;
};

static int (*bpf_skb_load_bytes)(void *ctx, int off, void *to, int len) =
	(void *) BPF_FUNC_skb_load_bytes;
static int (*bpf_skb_store_bytes)(void *ctx, int off, void *from, int len, int flags) =
	(void *) BPF_FUNC_skb_store_bytes;
static int (*bpf_l3_csum_replace)(void *ctx, int off, int from, int to, int flags) =
	(void *) BPF_FUNC_l3_csum_replace;
static int (*bpf_l4_csum_replace)(void *ctx, int off, int from, int to, int flags) =
	(void *) BPF_FUNC_l4_csum_replace;
static int (*bpf_skb_under_cgroup)(void *ctx, void *map, int index) =
	(void *) BPF_FUNC_skb_under_cgroup;
static int (*bpf_skb_change_head)(void *, int len, int flags) =
	(void *) BPF_FUNC_skb_change_head;

#if defined(__x86_64__)

#define PT_REGS_PARM1(x) ((x)->di)
#define PT_REGS_PARM2(x) ((x)->si)
#define PT_REGS_PARM3(x) ((x)->dx)
#define PT_REGS_PARM4(x) ((x)->cx)
#define PT_REGS_PARM5(x) ((x)->r8)
#define PT_REGS_RET(x) ((x)->sp)
#define PT_REGS_FP(x) ((x)->bp)
#define PT_REGS_RC(x) ((x)->ax)
#define PT_REGS_SP(x) ((x)->sp)
#define PT_REGS_IP(x) ((x)->ip)

#elif defined(__s390x__)

#define PT_REGS_PARM1(x) ((x)->gprs[2])
#define PT_REGS_PARM2(x) ((x)->gprs[3])
#define PT_REGS_PARM3(x) ((x)->gprs[4])
#define PT_REGS_PARM4(x) ((x)->gprs[5])
#define PT_REGS_PARM5(x) ((x)->gprs[6])
#define PT_REGS_RET(x) ((x)->gprs[14])
#define PT_REGS_FP(x) ((x)->gprs[11]) /* Works only with CONFIG_FRAME_POINTER */
#define PT_REGS_RC(x) ((x)->gprs[2])
#define PT_REGS_SP(x) ((x)->gprs[15])
#define PT_REGS_IP(x) ((x)->psw.addr)

#elif defined(__aarch64__)

#define PT_REGS_PARM1(x) ((x)->regs[0])
#define PT_REGS_PARM2(x) ((x)->regs[1])
#define PT_REGS_PARM3(x) ((x)->regs[2])
#define PT_REGS_PARM4(x) ((x)->regs[3])
#define PT_REGS_PARM5(x) ((x)->regs[4])
#define PT_REGS_RET(x) ((x)->regs[30])
#define PT_REGS_FP(x) ((x)->regs[29]) /* Works only with CONFIG_FRAME_POINTER */
#define PT_REGS_RC(x) ((x)->regs[0])
#define PT_REGS_SP(x) ((x)->sp)
#define PT_REGS_IP(x) ((x)->pc)

#elif defined(__mips__)

#define PT_REGS_PARM1(x) ((x)->regs[4])
#define PT_REGS_PARM2(x) ((x)->regs[5])
#define PT_REGS_PARM3(x) ((x)->regs[6])
#define PT_REGS_PARM4(x) ((x)->regs[7])
#define PT_REGS_PARM5(x) ((x)->regs[8])
#define PT_REGS_RET(x) ((x)->regs[31])
#define PT_REGS_FP(x) ((x)->regs[30]) /* Works only with CONFIG_FRAME_POINTER */
#define PT_REGS_RC(x) ((x)->regs[1])
#define PT_REGS_SP(x) ((x)->regs[29])
#define PT_REGS_IP(x) ((x)->cp0_epc)

#elif defined(__powerpc__)

#define PT_REGS_PARM1(x) ((x)->gpr[3])
#define PT_REGS_PARM2(x) ((x)->gpr[4])
#define PT_REGS_PARM3(x) ((x)->gpr[5])
#define PT_REGS_PARM4(x) ((x)->gpr[6])
#define PT_REGS_PARM5(x) ((x)->gpr[7])
#define PT_REGS_RC(x) ((x)->gpr[3])
#define PT_REGS_SP(x) ((x)->sp)
#define PT_REGS_IP(x) ((x)->nip)

#elif defined(__sparc__)

#define PT_REGS_PARM1(x) ((x)->u_regs[UREG_I0])
#define PT_REGS_PARM2(x) ((x)->u_regs[UREG_I1])
#define PT_REGS_PARM3(x) ((x)->u_regs[UREG_I2])
#define PT_REGS_PARM4(x) ((x)->u_regs[UREG_I3])
#define PT_REGS_PARM5(x) ((x)->u_regs[UREG_I4])
#define PT_REGS_RET(x) ((x)->u_regs[UREG_I7])
#define PT_REGS_RC(x) ((x)->u_regs[UREG_I0])
#define PT_REGS_SP(x) ((x)->u_regs[UREG_FP])
#if defined(__arch64__)
#define PT_REGS_IP(x) ((x)->tpc)
#else
#define PT_REGS_IP(x) ((x)->pc)
#endif

#endif

#ifdef __powerpc__
#define BPF_KPROBE_READ_RET_IP(ip, ctx)		({ (ip) = (ctx)->link; })
#define BPF_KRETPROBE_READ_RET_IP		BPF_KPROBE_READ_RET_IP
#elif defined(__sparc__)
#define BPF_KPROBE_READ_RET_IP(ip, ctx)		({ (ip) = PT_REGS_RET(ctx); })
#define BPF_KRETPROBE_READ_RET_IP		BPF_KPROBE_READ_RET_IP
#else
#define BPF_KPROBE_READ_RET_IP(ip, ctx)		({				\
		bpf_probe_read(&(ip), sizeof(ip), (void *)PT_REGS_RET(ctx)); })
#define BPF_KRETPROBE_READ_RET_IP(ip, ctx)	({				\
		bpf_probe_read(&(ip), sizeof(ip),				\
				(void *)(PT_REGS_FP(ctx) + sizeof(ip))); })
#endif

#endif
Commit	Line	Data
249b812d AS	1	#ifndef __BPF_HELPERS_H
	2	#define __BPF_HELPERS_H
	3
	4	/* helper macro to place programs, maps, license in
	5	* different sections in elf_bpf file. Section names
	6	* are interpreted by elf_bpf loader
	7	*/
	8	#define SEC(NAME) __attribute__((section(NAME), used))
	9
	10	/* helper functions called from eBPF programs written in C */
	11	static void (bpf_map_lookup_elem)(void map, void key) =
	12	(void *) BPF_FUNC_map_lookup_elem;
	13	static int (bpf_map_update_elem)(void map, void key, void value,
	14	unsigned long long flags) =
	15	(void *) BPF_FUNC_map_update_elem;
	16	static int (bpf_map_delete_elem)(void map, void *key) =
	17	(void *) BPF_FUNC_map_delete_elem;
b896c4f9 AS	18	static int (bpf_probe_read)(void dst, int size, void *unsafe_ptr) =
	19	(void *) BPF_FUNC_probe_read;
	20	static unsigned long long (*bpf_ktime_get_ns)(void) =
	21	(void *) BPF_FUNC_ktime_get_ns;
	22	static int (bpf_trace_printk)(const char fmt, int fmt_size, ...) =
	23	(void *) BPF_FUNC_trace_printk;
5bacd780 AS	24	static void (bpf_tail_call)(void ctx, void *map, int index) =
5bacd780 AS	25	(void *) BPF_FUNC_tail_call;
530b2c86 AS	26	static unsigned long long (*bpf_get_smp_processor_id)(void) =
530b2c86 AS	27	(void *) BPF_FUNC_get_smp_processor_id;
ffeedafb AS	28	static unsigned long long (*bpf_get_current_pid_tgid)(void) =
	29	(void *) BPF_FUNC_get_current_pid_tgid;
	30	static unsigned long long (*bpf_get_current_uid_gid)(void) =
	31	(void *) BPF_FUNC_get_current_uid_gid;
	32	static int (bpf_get_current_comm)(void buf, int buf_size) =
	33	(void *) BPF_FUNC_get_current_comm;
41e9a804 TQ	34	static unsigned long long (bpf_perf_event_read)(void map,
41e9a804 TQ	35	unsigned long long flags) =
47efb302	36	(void *) BPF_FUNC_perf_event_read;
27b29f63 AS	37	static int (bpf_clone_redirect)(void ctx, int ifindex, int flags) =
	38	(void *) BPF_FUNC_clone_redirect;
	39	static int (*bpf_redirect)(int ifindex, int flags) =
	40	(void *) BPF_FUNC_redirect;
9d6e0052 JF	41	static int (bpf_redirect_map)(void map, int key, int flags) =
9d6e0052 JF	42	(void *) BPF_FUNC_redirect_map;
05b8ad25 AB	43	static int (bpf_perf_event_output)(void ctx, void *map,
	44	unsigned long long flags, void *data,
	45	int size) =
39111695	46	(void *) BPF_FUNC_perf_event_output;
a6ffe7b9 AS	47	static int (bpf_get_stackid)(void ctx, void *map, int flags) =
a6ffe7b9 AS	48	(void *) BPF_FUNC_get_stackid;
96ae5227 SD	49	static int (bpf_probe_write_user)(void dst, void *src, int size) =
96ae5227 SD	50	(void *) BPF_FUNC_probe_write_user;
9e6e60ec SD	51	static int (bpf_current_task_under_cgroup)(void map, int index) =
9e6e60ec SD	52	(void *) BPF_FUNC_current_task_under_cgroup;
6afb1e28 WT	53	static int (bpf_skb_get_tunnel_key)(void ctx, void *key, int size, int flags) =
	54	(void *) BPF_FUNC_skb_get_tunnel_key;
	55	static int (bpf_skb_set_tunnel_key)(void ctx, void *key, int size, int flags) =
	56	(void *) BPF_FUNC_skb_set_tunnel_key;
	57	static int (bpf_skb_get_tunnel_opt)(void ctx, void *md, int size) =
	58	(void *) BPF_FUNC_skb_get_tunnel_opt;
	59	static int (bpf_skb_set_tunnel_opt)(void ctx, void *md, int size) =
	60	(void *) BPF_FUNC_skb_set_tunnel_opt;
1c47910e AS	61	static unsigned long long (*bpf_get_prandom_u32)(void) =
1c47910e AS	62	(void *) BPF_FUNC_get_prandom_u32;
12d8bb64 MKL	63	static int (bpf_xdp_adjust_head)(void ctx, int offset) =
12d8bb64 MKL	64	(void *) BPF_FUNC_xdp_adjust_head;
8c4b4c7e LB	65	static int (bpf_setsockopt)(void ctx, int level, int optname, void *optval,
	66	int optlen) =
	67	(void *) BPF_FUNC_setsockopt;
249b812d AS	68
	69	/* llvm builtin functions that eBPF C program may use to
	70	* emit BPF_LD_ABS and BPF_LD_IND instructions
	71	*/
	72	struct sk_buff;
	73	unsigned long long load_byte(void *skb,
	74	unsigned long long off) asm("llvm.bpf.load.byte");
	75	unsigned long long load_half(void *skb,
	76	unsigned long long off) asm("llvm.bpf.load.half");
	77	unsigned long long load_word(void *skb,
	78	unsigned long long off) asm("llvm.bpf.load.word");
	79
	80	/* a helper structure used by eBPF C program
	81	* to describe map attributes to elf_bpf loader
	82	*/
	83	struct bpf_map_def {
	84	unsigned int type;
	85	unsigned int key_size;
	86	unsigned int value_size;
	87	unsigned int max_entries;
89b97607	88	unsigned int map_flags;
fb30d4b7	89	unsigned int inner_map_idx;
249b812d AS	90	};
249b812d AS	91
f74599f7 TG	92	static int (bpf_skb_load_bytes)(void ctx, int off, void *to, int len) =
f74599f7 TG	93	(void *) BPF_FUNC_skb_load_bytes;
91bc4822 AS	94	static int (bpf_skb_store_bytes)(void ctx, int off, void *from, int len, int flags) =
	95	(void *) BPF_FUNC_skb_store_bytes;
	96	static int (bpf_l3_csum_replace)(void ctx, int off, int from, int to, int flags) =
	97	(void *) BPF_FUNC_l3_csum_replace;
	98	static int (bpf_l4_csum_replace)(void ctx, int off, int from, int to, int flags) =
	99	(void *) BPF_FUNC_l4_csum_replace;
747ea55e DB	100	static int (bpf_skb_under_cgroup)(void ctx, void *map, int index) =
747ea55e DB	101	(void *) BPF_FUNC_skb_under_cgroup;
f74599f7 TG	102	static int (bpf_skb_change_head)(void , int len, int flags) =
f74599f7 TG	103	(void *) BPF_FUNC_skb_change_head;
91bc4822	104
d912557b MH	105	#if defined(__x86_64__)
	106
	107	#define PT_REGS_PARM1(x) ((x)->di)
	108	#define PT_REGS_PARM2(x) ((x)->si)
	109	#define PT_REGS_PARM3(x) ((x)->dx)
	110	#define PT_REGS_PARM4(x) ((x)->cx)
	111	#define PT_REGS_PARM5(x) ((x)->r8)
	112	#define PT_REGS_RET(x) ((x)->sp)
	113	#define PT_REGS_FP(x) ((x)->bp)
	114	#define PT_REGS_RC(x) ((x)->ax)
	115	#define PT_REGS_SP(x) ((x)->sp)
138d6153	116	#define PT_REGS_IP(x) ((x)->ip)
d912557b MH	117
	118	#elif defined(__s390x__)
	119
	120	#define PT_REGS_PARM1(x) ((x)->gprs[2])
	121	#define PT_REGS_PARM2(x) ((x)->gprs[3])
	122	#define PT_REGS_PARM3(x) ((x)->gprs[4])
	123	#define PT_REGS_PARM4(x) ((x)->gprs[5])
	124	#define PT_REGS_PARM5(x) ((x)->gprs[6])
	125	#define PT_REGS_RET(x) ((x)->gprs[14])
	126	#define PT_REGS_FP(x) ((x)->gprs[11]) /* Works only with CONFIG_FRAME_POINTER */
	127	#define PT_REGS_RC(x) ((x)->gprs[2])
	128	#define PT_REGS_SP(x) ((x)->gprs[15])
2dbb4c05	129	#define PT_REGS_IP(x) ((x)->psw.addr)
d912557b	130
85ff8a43 YS	131	#elif defined(__aarch64__)
	132
	133	#define PT_REGS_PARM1(x) ((x)->regs[0])
	134	#define PT_REGS_PARM2(x) ((x)->regs[1])
	135	#define PT_REGS_PARM3(x) ((x)->regs[2])
	136	#define PT_REGS_PARM4(x) ((x)->regs[3])
	137	#define PT_REGS_PARM5(x) ((x)->regs[4])
	138	#define PT_REGS_RET(x) ((x)->regs[30])
	139	#define PT_REGS_FP(x) ((x)->regs[29]) /* Works only with CONFIG_FRAME_POINTER */
	140	#define PT_REGS_RC(x) ((x)->regs[0])
	141	#define PT_REGS_SP(x) ((x)->sp)
138d6153 NR	142	#define PT_REGS_IP(x) ((x)->pc)
138d6153 NR	143
c1932cdb DD	144	#elif defined(__mips__)
	145
	146	#define PT_REGS_PARM1(x) ((x)->regs[4])
	147	#define PT_REGS_PARM2(x) ((x)->regs[5])
	148	#define PT_REGS_PARM3(x) ((x)->regs[6])
	149	#define PT_REGS_PARM4(x) ((x)->regs[7])
	150	#define PT_REGS_PARM5(x) ((x)->regs[8])
	151	#define PT_REGS_RET(x) ((x)->regs[31])
	152	#define PT_REGS_FP(x) ((x)->regs[30]) /* Works only with CONFIG_FRAME_POINTER */
	153	#define PT_REGS_RC(x) ((x)->regs[1])
	154	#define PT_REGS_SP(x) ((x)->regs[29])
	155	#define PT_REGS_IP(x) ((x)->cp0_epc)
	156
138d6153 NR	157	#elif defined(__powerpc__)
	158
	159	#define PT_REGS_PARM1(x) ((x)->gpr[3])
	160	#define PT_REGS_PARM2(x) ((x)->gpr[4])
	161	#define PT_REGS_PARM3(x) ((x)->gpr[5])
	162	#define PT_REGS_PARM4(x) ((x)->gpr[6])
	163	#define PT_REGS_PARM5(x) ((x)->gpr[7])
	164	#define PT_REGS_RC(x) ((x)->gpr[3])
	165	#define PT_REGS_SP(x) ((x)->sp)
	166	#define PT_REGS_IP(x) ((x)->nip)
85ff8a43	167
b0c47807 DM	168	#elif defined(__sparc__)
	169
	170	#define PT_REGS_PARM1(x) ((x)->u_regs[UREG_I0])
	171	#define PT_REGS_PARM2(x) ((x)->u_regs[UREG_I1])
	172	#define PT_REGS_PARM3(x) ((x)->u_regs[UREG_I2])
	173	#define PT_REGS_PARM4(x) ((x)->u_regs[UREG_I3])
	174	#define PT_REGS_PARM5(x) ((x)->u_regs[UREG_I4])
	175	#define PT_REGS_RET(x) ((x)->u_regs[UREG_I7])
	176	#define PT_REGS_RC(x) ((x)->u_regs[UREG_I0])
	177	#define PT_REGS_SP(x) ((x)->u_regs[UREG_FP])
	178	#if defined(__arch64__)
	179	#define PT_REGS_IP(x) ((x)->tpc)
	180	#else
	181	#define PT_REGS_IP(x) ((x)->pc)
	182	#endif
	183
d912557b	184	#endif
138d6153 NR	185
	186	#ifdef __powerpc__
	187	#define BPF_KPROBE_READ_RET_IP(ip, ctx) ({ (ip) = (ctx)->link; })
	188	#define BPF_KRETPROBE_READ_RET_IP BPF_KPROBE_READ_RET_IP
b0c47807 DM	189	#elif defined(__sparc__)
	190	#define BPF_KPROBE_READ_RET_IP(ip, ctx) ({ (ip) = PT_REGS_RET(ctx); })
	191	#define BPF_KRETPROBE_READ_RET_IP BPF_KPROBE_READ_RET_IP
138d6153 NR	192	#else
	193	#define BPF_KPROBE_READ_RET_IP(ip, ctx) ({ \
	194	bpf_probe_read(&(ip), sizeof(ip), (void *)PT_REGS_RET(ctx)); })
	195	#define BPF_KRETPROBE_READ_RET_IP(ip, ctx) ({ \
	196	bpf_probe_read(&(ip), sizeof(ip), \
	197	(void *)(PT_REGS_FP(ctx) + sizeof(ip))); })
	198	#endif
	199
249b812d	200	#endif