[mirror_ubuntu-bionic-kernel.git] / tools / include / linux / filter.h

/*
 * Linux Socket Filter Data Structures
 */
#ifndef __TOOLS_LINUX_FILTER_H
#define __TOOLS_LINUX_FILTER_H

#include <linux/bpf.h>

/* ArgX, context and stack frame pointer register positions. Note,
 * Arg1, Arg2, Arg3, etc are used as argument mappings of function
 * calls in BPF_CALL instruction.
 */
#define BPF_REG_ARG1	BPF_REG_1
#define BPF_REG_ARG2	BPF_REG_2
#define BPF_REG_ARG3	BPF_REG_3
#define BPF_REG_ARG4	BPF_REG_4
#define BPF_REG_ARG5	BPF_REG_5
#define BPF_REG_CTX	BPF_REG_6
#define BPF_REG_FP	BPF_REG_10

/* Additional register mappings for converted user programs. */
#define BPF_REG_A	BPF_REG_0
#define BPF_REG_X	BPF_REG_7
#define BPF_REG_TMP	BPF_REG_8

/* BPF program can access up to 512 bytes of stack space. */
#define MAX_BPF_STACK	512

/* Helper macros for filter block array initializers. */

/* ALU ops on registers, bpf_add|sub|...: dst_reg += src_reg */

#define BPF_ALU64_REG(OP, DST, SRC)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_OP(OP) | BPF_X,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

#define BPF_ALU32_REG(OP, DST, SRC)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_OP(OP) | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

/* ALU ops on immediates, bpf_add|sub|...: dst_reg += imm32 */

#define BPF_ALU64_IMM(OP, DST, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_OP(OP) | BPF_K,	\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_ALU32_IMM(OP, DST, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_OP(OP) | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Endianess conversion, cpu_to_{l,b}e(), {l,b}e_to_cpu() */

#define BPF_ENDIAN(TYPE, DST, LEN)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_END | BPF_SRC(TYPE),	\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = LEN })

/* Short form of mov, dst_reg = src_reg */

#define BPF_MOV64_REG(DST, SRC)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_MOV | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

#define BPF_MOV32_REG(DST, SRC)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_MOV | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

/* Short form of mov, dst_reg = imm32 */

#define BPF_MOV64_IMM(DST, IMM)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_MOV | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_MOV32_IMM(DST, IMM)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_MOV | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Short form of mov based on type,  BPF_X: dst_reg = src_reg, BPF_K: dst_reg = imm32 */

#define BPF_MOV64_RAW(TYPE, DST, SRC, IMM)			\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_MOV | BPF_SRC(TYPE),	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_MOV32_RAW(TYPE, DST, SRC, IMM)			\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_MOV | BPF_SRC(TYPE),	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = IMM })

/* Direct packet access, R0 = *(uint *) (skb->data + imm32) */

#define BPF_LD_ABS(SIZE, IMM)					\
	((struct bpf_insn) {					\
		.code  = BPF_LD | BPF_SIZE(SIZE) | BPF_ABS,	\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Indirect packet access, R0 = *(uint *) (skb->data + src_reg + imm32) */

#define BPF_LD_IND(SIZE, SRC, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_LD | BPF_SIZE(SIZE) | BPF_IND,	\
		.dst_reg = 0,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = IMM })

/* Memory load, dst_reg = *(uint *) (src_reg + off16) */

#define BPF_LDX_MEM(SIZE, DST, SRC, OFF)			\
	((struct bpf_insn) {					\
		.code  = BPF_LDX | BPF_SIZE(SIZE) | BPF_MEM,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Memory store, *(uint *) (dst_reg + off16) = src_reg */

#define BPF_STX_MEM(SIZE, DST, SRC, OFF)			\
	((struct bpf_insn) {					\
		.code  = BPF_STX | BPF_SIZE(SIZE) | BPF_MEM,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Atomic memory add, *(uint *)(dst_reg + off16) += src_reg */

#define BPF_STX_XADD(SIZE, DST, SRC, OFF)			\
	((struct bpf_insn) {					\
		.code  = BPF_STX | BPF_SIZE(SIZE) | BPF_XADD,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Memory store, *(uint *) (dst_reg + off16) = imm32 */

#define BPF_ST_MEM(SIZE, DST, OFF, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_ST | BPF_SIZE(SIZE) | BPF_MEM,	\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Conditional jumps against registers, if (dst_reg 'op' src_reg) goto pc + off16 */

#define BPF_JMP_REG(OP, DST, SRC, OFF)				\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_OP(OP) | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Conditional jumps against immediates, if (dst_reg 'op' imm32) goto pc + off16 */

#define BPF_JMP_IMM(OP, DST, IMM, OFF)				\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_OP(OP) | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Function call */

#define BPF_EMIT_CALL(FUNC)					\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_CALL,			\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = ((FUNC) - BPF_FUNC_unspec) })

/* Raw code statement block */

#define BPF_RAW_INSN(CODE, DST, SRC, OFF, IMM)			\
	((struct bpf_insn) {					\
		.code  = CODE,					\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = IMM })

/* BPF_LD_IMM64 macro encodes single 'load 64-bit immediate' insn */

#define BPF_LD_IMM64(DST, IMM)					\
	BPF_LD_IMM64_RAW(DST, 0, IMM)

#define BPF_LD_IMM64_RAW(DST, SRC, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_LD | BPF_DW | BPF_IMM,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = (__u32) (IMM) }),			\
	((struct bpf_insn) {					\
		.code  = 0, /* zero is reserved opcode */	\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = ((__u64) (IMM)) >> 32 })

/* pseudo BPF_LD_IMM64 insn used to refer to process-local map_fd */

#define BPF_LD_MAP_FD(DST, MAP_FD)				\
	BPF_LD_IMM64_RAW(DST, BPF_PSEUDO_MAP_FD, MAP_FD)

/* Program exit */

#define BPF_EXIT_INSN()						\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_EXIT,			\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = 0 })

#endif /* __TOOLS_LINUX_FILTER_H */
Commit	Line	Data
dabf626f HK	1	/*
	2	* Linux Socket Filter Data Structures
	3	*/
	4	#ifndef __TOOLS_LINUX_FILTER_H
	5	#define __TOOLS_LINUX_FILTER_H
	6
	7	#include <linux/bpf.h>
	8
	9	/* ArgX, context and stack frame pointer register positions. Note,
	10	* Arg1, Arg2, Arg3, etc are used as argument mappings of function
	11	* calls in BPF_CALL instruction.
	12	*/
	13	#define BPF_REG_ARG1 BPF_REG_1
	14	#define BPF_REG_ARG2 BPF_REG_2
	15	#define BPF_REG_ARG3 BPF_REG_3
	16	#define BPF_REG_ARG4 BPF_REG_4
	17	#define BPF_REG_ARG5 BPF_REG_5
	18	#define BPF_REG_CTX BPF_REG_6
	19	#define BPF_REG_FP BPF_REG_10
	20
	21	/* Additional register mappings for converted user programs. */
	22	#define BPF_REG_A BPF_REG_0
	23	#define BPF_REG_X BPF_REG_7
	24	#define BPF_REG_TMP BPF_REG_8
	25
	26	/* BPF program can access up to 512 bytes of stack space. */
	27	#define MAX_BPF_STACK 512
	28
	29	/* Helper macros for filter block array initializers. */
	30
	31	/* ALU ops on registers, bpf_add\|sub\|...: dst_reg += src_reg */
	32
	33	#define BPF_ALU64_REG(OP, DST, SRC) \
	34	((struct bpf_insn) { \
	35	.code = BPF_ALU64 \| BPF_OP(OP) \| BPF_X, \
	36	.dst_reg = DST, \
	37	.src_reg = SRC, \
	38	.off = 0, \
	39	.imm = 0 })
	40
	41	#define BPF_ALU32_REG(OP, DST, SRC) \
	42	((struct bpf_insn) { \
	43	.code = BPF_ALU \| BPF_OP(OP) \| BPF_X, \
	44	.dst_reg = DST, \
	45	.src_reg = SRC, \
	46	.off = 0, \
	47	.imm = 0 })
	48
	49	/* ALU ops on immediates, bpf_add\|sub\|...: dst_reg += imm32 */
	50
	51	#define BPF_ALU64_IMM(OP, DST, IMM) \
	52	((struct bpf_insn) { \
	53	.code = BPF_ALU64 \| BPF_OP(OP) \| BPF_K, \
	54	.dst_reg = DST, \
	55	.src_reg = 0, \
	56	.off = 0, \
	57	.imm = IMM })
	58
	59	#define BPF_ALU32_IMM(OP, DST, IMM) \
	60	((struct bpf_insn) { \
	61	.code = BPF_ALU \| BPF_OP(OP) \| BPF_K, \
	62	.dst_reg = DST, \
	63	.src_reg = 0, \
	64	.off = 0, \
65	.imm = IMM })
66
67	/* Endianess conversion, cpu_to_{l,b}e(), {l,b}e_to_cpu() */
68
69	#define BPF_ENDIAN(TYPE, DST, LEN) \
70	((struct bpf_insn) { \
71	.code = BPF_ALU \| BPF_END \| BPF_SRC(TYPE), \
72	.dst_reg = DST, \
73	.src_reg = 0, \
74	.off = 0, \
75	.imm = LEN })
76
77	/* Short form of mov, dst_reg = src_reg */
78
79	#define BPF_MOV64_REG(DST, SRC) \
80	((struct bpf_insn) { \
81	.code = BPF_ALU64 \| BPF_MOV \| BPF_X, \
82	.dst_reg = DST, \
83	.src_reg = SRC, \
84	.off = 0, \
85	.imm = 0 })
86
87	#define BPF_MOV32_REG(DST, SRC) \
88	((struct bpf_insn) { \
89	.code = BPF_ALU \| BPF_MOV \| BPF_X, \
90	.dst_reg = DST, \
91	.src_reg = SRC, \
92	.off = 0, \
93	.imm = 0 })
94
95	/* Short form of mov, dst_reg = imm32 */
96
97	#define BPF_MOV64_IMM(DST, IMM) \
98	((struct bpf_insn) { \
99	.code = BPF_ALU64 \| BPF_MOV \| BPF_K, \
100	.dst_reg = DST, \
101	.src_reg = 0, \
102	.off = 0, \
103	.imm = IMM })
104
105	#define BPF_MOV32_IMM(DST, IMM) \
106	((struct bpf_insn) { \
107	.code = BPF_ALU \| BPF_MOV \| BPF_K, \
108	.dst_reg = DST, \
109	.src_reg = 0, \
110	.off = 0, \
111	.imm = IMM })
112
113	/* Short form of mov based on type, BPF_X: dst_reg = src_reg, BPF_K: dst_reg = imm32 */
114
115	#define BPF_MOV64_RAW(TYPE, DST, SRC, IMM) \
116	((struct bpf_insn) { \
117	.code = BPF_ALU64 \| BPF_MOV \| BPF_SRC(TYPE), \
118	.dst_reg = DST, \
119	.src_reg = SRC, \
120	.off = 0, \
121	.imm = IMM })
122
123	#define BPF_MOV32_RAW(TYPE, DST, SRC, IMM) \
124	((struct bpf_insn) { \
125	.code = BPF_ALU \| BPF_MOV \| BPF_SRC(TYPE), \
126	.dst_reg = DST, \
127	.src_reg = SRC, \
128	.off = 0, \
129	.imm = IMM })
130
131	/* Direct packet access, R0 = (uint ) (skb->data + imm32) */
132
133	#define BPF_LD_ABS(SIZE, IMM) \
134	((struct bpf_insn) { \
135	.code = BPF_LD \| BPF_SIZE(SIZE) \| BPF_ABS, \
136	.dst_reg = 0, \
137	.src_reg = 0, \
138	.off = 0, \
139	.imm = IMM })
140
141	/* Indirect packet access, R0 = (uint ) (skb->data + src_reg + imm32) */
142
143	#define BPF_LD_IND(SIZE, SRC, IMM) \
144	((struct bpf_insn) { \
145	.code = BPF_LD \| BPF_SIZE(SIZE) \| BPF_IND, \
146	.dst_reg = 0, \
147	.src_reg = SRC, \
148	.off = 0, \
149	.imm = IMM })
150
151	/* Memory load, dst_reg = (uint ) (src_reg + off16) */
152
153	#define BPF_LDX_MEM(SIZE, DST, SRC, OFF) \
154	((struct bpf_insn) { \
155	.code = BPF_LDX \| BPF_SIZE(SIZE) \| BPF_MEM, \
156	.dst_reg = DST, \
157	.src_reg = SRC, \
158	.off = OFF, \
159	.imm = 0 })
160
161	/* Memory store, (uint ) (dst_reg + off16) = src_reg */
162
163	#define BPF_STX_MEM(SIZE, DST, SRC, OFF) \
164	((struct bpf_insn) { \
165	.code = BPF_STX \| BPF_SIZE(SIZE) \| BPF_MEM, \
166	.dst_reg = DST, \
167	.src_reg = SRC, \
168	.off = OFF, \
169	.imm = 0 })
170
02ea80b1 DB	171	/* Atomic memory add, (uint )(dst_reg + off16) += src_reg */
	172
	173	#define BPF_STX_XADD(SIZE, DST, SRC, OFF) \
	174	((struct bpf_insn) { \
	175	.code = BPF_STX \| BPF_SIZE(SIZE) \| BPF_XADD, \
	176	.dst_reg = DST, \
	177	.src_reg = SRC, \
	178	.off = OFF, \
	179	.imm = 0 })
	180
dabf626f HK	181	/* Memory store, (uint ) (dst_reg + off16) = imm32 */
	182
	183	#define BPF_ST_MEM(SIZE, DST, OFF, IMM) \
	184	((struct bpf_insn) { \
	185	.code = BPF_ST \| BPF_SIZE(SIZE) \| BPF_MEM, \
	186	.dst_reg = DST, \
	187	.src_reg = 0, \
	188	.off = OFF, \
	189	.imm = IMM })
	190
	191	/* Conditional jumps against registers, if (dst_reg 'op' src_reg) goto pc + off16 */
	192
	193	#define BPF_JMP_REG(OP, DST, SRC, OFF) \
	194	((struct bpf_insn) { \
	195	.code = BPF_JMP \| BPF_OP(OP) \| BPF_X, \
	196	.dst_reg = DST, \
	197	.src_reg = SRC, \
	198	.off = OFF, \
	199	.imm = 0 })
	200
	201	/* Conditional jumps against immediates, if (dst_reg 'op' imm32) goto pc + off16 */
	202
	203	#define BPF_JMP_IMM(OP, DST, IMM, OFF) \
	204	((struct bpf_insn) { \
	205	.code = BPF_JMP \| BPF_OP(OP) \| BPF_K, \
	206	.dst_reg = DST, \
	207	.src_reg = 0, \
	208	.off = OFF, \
	209	.imm = IMM })
	210
	211	/* Function call */
	212
	213	#define BPF_EMIT_CALL(FUNC) \
	214	((struct bpf_insn) { \
	215	.code = BPF_JMP \| BPF_CALL, \
	216	.dst_reg = 0, \
	217	.src_reg = 0, \
	218	.off = 0, \
	219	.imm = ((FUNC) - BPF_FUNC_unspec) })
	220
	221	/* Raw code statement block */
	222
	223	#define BPF_RAW_INSN(CODE, DST, SRC, OFF, IMM) \
	224	((struct bpf_insn) { \
	225	.code = CODE, \
	226	.dst_reg = DST, \
	227	.src_reg = SRC, \
	228	.off = OFF, \
	229	.imm = IMM })
	230
5aa5bd14 DB	231	/* BPF_LD_IMM64 macro encodes single 'load 64-bit immediate' insn */
	232
	233	#define BPF_LD_IMM64(DST, IMM) \
	234	BPF_LD_IMM64_RAW(DST, 0, IMM)
	235
	236	#define BPF_LD_IMM64_RAW(DST, SRC, IMM) \
	237	((struct bpf_insn) { \
	238	.code = BPF_LD \| BPF_DW \| BPF_IMM, \
	239	.dst_reg = DST, \
	240	.src_reg = SRC, \
	241	.off = 0, \
	242	.imm = (__u32) (IMM) }), \
	243	((struct bpf_insn) { \
	244	.code = 0, /* zero is reserved opcode */ \
	245	.dst_reg = 0, \
	246	.src_reg = 0, \
	247	.off = 0, \
	248	.imm = ((__u64) (IMM)) >> 32 })
	249
	250	/* pseudo BPF_LD_IMM64 insn used to refer to process-local map_fd */
	251
	252	#define BPF_LD_MAP_FD(DST, MAP_FD) \
	253	BPF_LD_IMM64_RAW(DST, BPF_PSEUDO_MAP_FD, MAP_FD)
	254
dabf626f HK	255	/* Program exit */
	256
	257	#define BPF_EXIT_INSN() \
	258	((struct bpf_insn) { \
	259	.code = BPF_JMP \| BPF_EXIT, \
	260	.dst_reg = 0, \
	261	.src_reg = 0, \
	262	.off = 0, \
	263	.imm = 0 })
	264
	265	#endif /* __TOOLS_LINUX_FILTER_H */