xref: /linux-6.15/tools/include/uapi/linux/bpf.h (revision 3fd87127)
1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
2  *
3  * This program is free software; you can redistribute it and/or
4  * modify it under the terms of version 2 of the GNU General Public
5  * License as published by the Free Software Foundation.
6  */
7 #ifndef _UAPI__LINUX_BPF_H__
8 #define _UAPI__LINUX_BPF_H__
9 
10 #include <linux/types.h>
11 #include <linux/bpf_common.h>
12 
13 /* Extended instruction set based on top of classic BPF */
14 
15 /* instruction classes */
16 #define BPF_ALU64	0x07	/* alu mode in double word width */
17 
18 /* ld/ldx fields */
19 #define BPF_DW		0x18	/* double word */
20 #define BPF_XADD	0xc0	/* exclusive add */
21 
22 /* alu/jmp fields */
23 #define BPF_MOV		0xb0	/* mov reg to reg */
24 #define BPF_ARSH	0xc0	/* sign extending arithmetic shift right */
25 
26 /* change endianness of a register */
27 #define BPF_END		0xd0	/* flags for endianness conversion: */
28 #define BPF_TO_LE	0x00	/* convert to little-endian */
29 #define BPF_TO_BE	0x08	/* convert to big-endian */
30 #define BPF_FROM_LE	BPF_TO_LE
31 #define BPF_FROM_BE	BPF_TO_BE
32 
33 /* jmp encodings */
34 #define BPF_JNE		0x50	/* jump != */
35 #define BPF_JLT		0xa0	/* LT is unsigned, '<' */
36 #define BPF_JLE		0xb0	/* LE is unsigned, '<=' */
37 #define BPF_JSGT	0x60	/* SGT is signed '>', GT in x86 */
38 #define BPF_JSGE	0x70	/* SGE is signed '>=', GE in x86 */
39 #define BPF_JSLT	0xc0	/* SLT is signed, '<' */
40 #define BPF_JSLE	0xd0	/* SLE is signed, '<=' */
41 #define BPF_CALL	0x80	/* function call */
42 #define BPF_EXIT	0x90	/* function return */
43 
44 /* Register numbers */
45 enum {
46 	BPF_REG_0 = 0,
47 	BPF_REG_1,
48 	BPF_REG_2,
49 	BPF_REG_3,
50 	BPF_REG_4,
51 	BPF_REG_5,
52 	BPF_REG_6,
53 	BPF_REG_7,
54 	BPF_REG_8,
55 	BPF_REG_9,
56 	BPF_REG_10,
57 	__MAX_BPF_REG,
58 };
59 
60 /* BPF has 10 general purpose 64-bit registers and stack frame. */
61 #define MAX_BPF_REG	__MAX_BPF_REG
62 
63 struct bpf_insn {
64 	__u8	code;		/* opcode */
65 	__u8	dst_reg:4;	/* dest register */
66 	__u8	src_reg:4;	/* source register */
67 	__s16	off;		/* signed offset */
68 	__s32	imm;		/* signed immediate constant */
69 };
70 
71 /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
72 struct bpf_lpm_trie_key {
73 	__u32	prefixlen;	/* up to 32 for AF_INET, 128 for AF_INET6 */
74 	__u8	data[0];	/* Arbitrary size */
75 };
76 
77 /* BPF syscall commands, see bpf(2) man-page for details. */
78 enum bpf_cmd {
79 	BPF_MAP_CREATE,
80 	BPF_MAP_LOOKUP_ELEM,
81 	BPF_MAP_UPDATE_ELEM,
82 	BPF_MAP_DELETE_ELEM,
83 	BPF_MAP_GET_NEXT_KEY,
84 	BPF_PROG_LOAD,
85 	BPF_OBJ_PIN,
86 	BPF_OBJ_GET,
87 	BPF_PROG_ATTACH,
88 	BPF_PROG_DETACH,
89 	BPF_PROG_TEST_RUN,
90 	BPF_PROG_GET_NEXT_ID,
91 	BPF_MAP_GET_NEXT_ID,
92 	BPF_PROG_GET_FD_BY_ID,
93 	BPF_MAP_GET_FD_BY_ID,
94 	BPF_OBJ_GET_INFO_BY_FD,
95 };
96 
97 enum bpf_map_type {
98 	BPF_MAP_TYPE_UNSPEC,
99 	BPF_MAP_TYPE_HASH,
100 	BPF_MAP_TYPE_ARRAY,
101 	BPF_MAP_TYPE_PROG_ARRAY,
102 	BPF_MAP_TYPE_PERF_EVENT_ARRAY,
103 	BPF_MAP_TYPE_PERCPU_HASH,
104 	BPF_MAP_TYPE_PERCPU_ARRAY,
105 	BPF_MAP_TYPE_STACK_TRACE,
106 	BPF_MAP_TYPE_CGROUP_ARRAY,
107 	BPF_MAP_TYPE_LRU_HASH,
108 	BPF_MAP_TYPE_LRU_PERCPU_HASH,
109 	BPF_MAP_TYPE_LPM_TRIE,
110 	BPF_MAP_TYPE_ARRAY_OF_MAPS,
111 	BPF_MAP_TYPE_HASH_OF_MAPS,
112 	BPF_MAP_TYPE_DEVMAP,
113 	BPF_MAP_TYPE_SOCKMAP,
114 };
115 
116 enum bpf_prog_type {
117 	BPF_PROG_TYPE_UNSPEC,
118 	BPF_PROG_TYPE_SOCKET_FILTER,
119 	BPF_PROG_TYPE_KPROBE,
120 	BPF_PROG_TYPE_SCHED_CLS,
121 	BPF_PROG_TYPE_SCHED_ACT,
122 	BPF_PROG_TYPE_TRACEPOINT,
123 	BPF_PROG_TYPE_XDP,
124 	BPF_PROG_TYPE_PERF_EVENT,
125 	BPF_PROG_TYPE_CGROUP_SKB,
126 	BPF_PROG_TYPE_CGROUP_SOCK,
127 	BPF_PROG_TYPE_LWT_IN,
128 	BPF_PROG_TYPE_LWT_OUT,
129 	BPF_PROG_TYPE_LWT_XMIT,
130 	BPF_PROG_TYPE_SOCK_OPS,
131 	BPF_PROG_TYPE_SK_SKB,
132 };
133 
134 enum bpf_attach_type {
135 	BPF_CGROUP_INET_INGRESS,
136 	BPF_CGROUP_INET_EGRESS,
137 	BPF_CGROUP_INET_SOCK_CREATE,
138 	BPF_CGROUP_SOCK_OPS,
139 	BPF_CGROUP_SMAP_INGRESS,
140 	__MAX_BPF_ATTACH_TYPE
141 };
142 
143 #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
144 
145 enum bpf_sockmap_flags {
146 	BPF_SOCKMAP_UNSPEC,
147 	BPF_SOCKMAP_STRPARSER,
148 	__MAX_BPF_SOCKMAP_FLAG
149 };
150 
151 /* If BPF_F_ALLOW_OVERRIDE flag is used in BPF_PROG_ATTACH command
152  * to the given target_fd cgroup the descendent cgroup will be able to
153  * override effective bpf program that was inherited from this cgroup
154  */
155 #define BPF_F_ALLOW_OVERRIDE	(1U << 0)
156 
157 /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
158  * verifier will perform strict alignment checking as if the kernel
159  * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
160  * and NET_IP_ALIGN defined to 2.
161  */
162 #define BPF_F_STRICT_ALIGNMENT	(1U << 0)
163 
164 #define BPF_PSEUDO_MAP_FD	1
165 
166 /* flags for BPF_MAP_UPDATE_ELEM command */
167 #define BPF_ANY		0 /* create new element or update existing */
168 #define BPF_NOEXIST	1 /* create new element if it didn't exist */
169 #define BPF_EXIST	2 /* update existing element */
170 
171 /* flags for BPF_MAP_CREATE command */
172 #define BPF_F_NO_PREALLOC	(1U << 0)
173 /* Instead of having one common LRU list in the
174  * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
175  * which can scale and perform better.
176  * Note, the LRU nodes (including free nodes) cannot be moved
177  * across different LRU lists.
178  */
179 #define BPF_F_NO_COMMON_LRU	(1U << 1)
180 /* Specify numa node during map creation */
181 #define BPF_F_NUMA_NODE		(1U << 2)
182 
183 union bpf_attr {
184 	struct { /* anonymous struct used by BPF_MAP_CREATE command */
185 		__u32	map_type;	/* one of enum bpf_map_type */
186 		__u32	key_size;	/* size of key in bytes */
187 		__u32	value_size;	/* size of value in bytes */
188 		__u32	max_entries;	/* max number of entries in a map */
189 		__u32	map_flags;	/* BPF_MAP_CREATE related
190 					 * flags defined above.
191 					 */
192 		__u32	inner_map_fd;	/* fd pointing to the inner map */
193 		__u32	numa_node;	/* numa node (effective only if
194 					 * BPF_F_NUMA_NODE is set).
195 					 */
196 	};
197 
198 	struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
199 		__u32		map_fd;
200 		__aligned_u64	key;
201 		union {
202 			__aligned_u64 value;
203 			__aligned_u64 next_key;
204 		};
205 		__u64		flags;
206 	};
207 
208 	struct { /* anonymous struct used by BPF_PROG_LOAD command */
209 		__u32		prog_type;	/* one of enum bpf_prog_type */
210 		__u32		insn_cnt;
211 		__aligned_u64	insns;
212 		__aligned_u64	license;
213 		__u32		log_level;	/* verbosity level of verifier */
214 		__u32		log_size;	/* size of user buffer */
215 		__aligned_u64	log_buf;	/* user supplied buffer */
216 		__u32		kern_version;	/* checked when prog_type=kprobe */
217 		__u32		prog_flags;
218 	};
219 
220 	struct { /* anonymous struct used by BPF_OBJ_* commands */
221 		__aligned_u64	pathname;
222 		__u32		bpf_fd;
223 	};
224 
225 	struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
226 		__u32		target_fd;	/* container object to attach to */
227 		__u32		attach_bpf_fd;	/* eBPF program to attach */
228 		__u32		attach_type;
229 		__u32		attach_flags;
230 		__u32		attach_bpf_fd2;
231 	};
232 
233 	struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
234 		__u32		prog_fd;
235 		__u32		retval;
236 		__u32		data_size_in;
237 		__u32		data_size_out;
238 		__aligned_u64	data_in;
239 		__aligned_u64	data_out;
240 		__u32		repeat;
241 		__u32		duration;
242 	} test;
243 
244 	struct { /* anonymous struct used by BPF_*_GET_*_ID */
245 		union {
246 			__u32		start_id;
247 			__u32		prog_id;
248 			__u32		map_id;
249 		};
250 		__u32		next_id;
251 	};
252 
253 	struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
254 		__u32		bpf_fd;
255 		__u32		info_len;
256 		__aligned_u64	info;
257 	} info;
258 } __attribute__((aligned(8)));
259 
260 /* BPF helper function descriptions:
261  *
262  * void *bpf_map_lookup_elem(&map, &key)
263  *     Return: Map value or NULL
264  *
265  * int bpf_map_update_elem(&map, &key, &value, flags)
266  *     Return: 0 on success or negative error
267  *
268  * int bpf_map_delete_elem(&map, &key)
269  *     Return: 0 on success or negative error
270  *
271  * int bpf_probe_read(void *dst, int size, void *src)
272  *     Return: 0 on success or negative error
273  *
274  * u64 bpf_ktime_get_ns(void)
275  *     Return: current ktime
276  *
277  * int bpf_trace_printk(const char *fmt, int fmt_size, ...)
278  *     Return: length of buffer written or negative error
279  *
280  * u32 bpf_prandom_u32(void)
281  *     Return: random value
282  *
283  * u32 bpf_raw_smp_processor_id(void)
284  *     Return: SMP processor ID
285  *
286  * int bpf_skb_store_bytes(skb, offset, from, len, flags)
287  *     store bytes into packet
288  *     @skb: pointer to skb
289  *     @offset: offset within packet from skb->mac_header
290  *     @from: pointer where to copy bytes from
291  *     @len: number of bytes to store into packet
292  *     @flags: bit 0 - if true, recompute skb->csum
293  *             other bits - reserved
294  *     Return: 0 on success or negative error
295  *
296  * int bpf_l3_csum_replace(skb, offset, from, to, flags)
297  *     recompute IP checksum
298  *     @skb: pointer to skb
299  *     @offset: offset within packet where IP checksum is located
300  *     @from: old value of header field
301  *     @to: new value of header field
302  *     @flags: bits 0-3 - size of header field
303  *             other bits - reserved
304  *     Return: 0 on success or negative error
305  *
306  * int bpf_l4_csum_replace(skb, offset, from, to, flags)
307  *     recompute TCP/UDP checksum
308  *     @skb: pointer to skb
309  *     @offset: offset within packet where TCP/UDP checksum is located
310  *     @from: old value of header field
311  *     @to: new value of header field
312  *     @flags: bits 0-3 - size of header field
313  *             bit 4 - is pseudo header
314  *             other bits - reserved
315  *     Return: 0 on success or negative error
316  *
317  * int bpf_tail_call(ctx, prog_array_map, index)
318  *     jump into another BPF program
319  *     @ctx: context pointer passed to next program
320  *     @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
321  *     @index: index inside array that selects specific program to run
322  *     Return: 0 on success or negative error
323  *
324  * int bpf_clone_redirect(skb, ifindex, flags)
325  *     redirect to another netdev
326  *     @skb: pointer to skb
327  *     @ifindex: ifindex of the net device
328  *     @flags: bit 0 - if set, redirect to ingress instead of egress
329  *             other bits - reserved
330  *     Return: 0 on success or negative error
331  *
332  * u64 bpf_get_current_pid_tgid(void)
333  *     Return: current->tgid << 32 | current->pid
334  *
335  * u64 bpf_get_current_uid_gid(void)
336  *     Return: current_gid << 32 | current_uid
337  *
338  * int bpf_get_current_comm(char *buf, int size_of_buf)
339  *     stores current->comm into buf
340  *     Return: 0 on success or negative error
341  *
342  * u32 bpf_get_cgroup_classid(skb)
343  *     retrieve a proc's classid
344  *     @skb: pointer to skb
345  *     Return: classid if != 0
346  *
347  * int bpf_skb_vlan_push(skb, vlan_proto, vlan_tci)
348  *     Return: 0 on success or negative error
349  *
350  * int bpf_skb_vlan_pop(skb)
351  *     Return: 0 on success or negative error
352  *
353  * int bpf_skb_get_tunnel_key(skb, key, size, flags)
354  * int bpf_skb_set_tunnel_key(skb, key, size, flags)
355  *     retrieve or populate tunnel metadata
356  *     @skb: pointer to skb
357  *     @key: pointer to 'struct bpf_tunnel_key'
358  *     @size: size of 'struct bpf_tunnel_key'
359  *     @flags: room for future extensions
360  *     Return: 0 on success or negative error
361  *
362  * u64 bpf_perf_event_read(map, flags)
363  *     read perf event counter value
364  *     @map: pointer to perf_event_array map
365  *     @flags: index of event in the map or bitmask flags
366  *     Return: value of perf event counter read or error code
367  *
368  * int bpf_redirect(ifindex, flags)
369  *     redirect to another netdev
370  *     @ifindex: ifindex of the net device
371  *     @flags: bit 0 - if set, redirect to ingress instead of egress
372  *             other bits - reserved
373  *     Return: TC_ACT_REDIRECT
374  *
375  * u32 bpf_get_route_realm(skb)
376  *     retrieve a dst's tclassid
377  *     @skb: pointer to skb
378  *     Return: realm if != 0
379  *
380  * int bpf_perf_event_output(ctx, map, flags, data, size)
381  *     output perf raw sample
382  *     @ctx: struct pt_regs*
383  *     @map: pointer to perf_event_array map
384  *     @flags: index of event in the map or bitmask flags
385  *     @data: data on stack to be output as raw data
386  *     @size: size of data
387  *     Return: 0 on success or negative error
388  *
389  * int bpf_get_stackid(ctx, map, flags)
390  *     walk user or kernel stack and return id
391  *     @ctx: struct pt_regs*
392  *     @map: pointer to stack_trace map
393  *     @flags: bits 0-7 - numer of stack frames to skip
394  *             bit 8 - collect user stack instead of kernel
395  *             bit 9 - compare stacks by hash only
396  *             bit 10 - if two different stacks hash into the same stackid
397  *                      discard old
398  *             other bits - reserved
399  *     Return: >= 0 stackid on success or negative error
400  *
401  * s64 bpf_csum_diff(from, from_size, to, to_size, seed)
402  *     calculate csum diff
403  *     @from: raw from buffer
404  *     @from_size: length of from buffer
405  *     @to: raw to buffer
406  *     @to_size: length of to buffer
407  *     @seed: optional seed
408  *     Return: csum result or negative error code
409  *
410  * int bpf_skb_get_tunnel_opt(skb, opt, size)
411  *     retrieve tunnel options metadata
412  *     @skb: pointer to skb
413  *     @opt: pointer to raw tunnel option data
414  *     @size: size of @opt
415  *     Return: option size
416  *
417  * int bpf_skb_set_tunnel_opt(skb, opt, size)
418  *     populate tunnel options metadata
419  *     @skb: pointer to skb
420  *     @opt: pointer to raw tunnel option data
421  *     @size: size of @opt
422  *     Return: 0 on success or negative error
423  *
424  * int bpf_skb_change_proto(skb, proto, flags)
425  *     Change protocol of the skb. Currently supported is v4 -> v6,
426  *     v6 -> v4 transitions. The helper will also resize the skb. eBPF
427  *     program is expected to fill the new headers via skb_store_bytes
428  *     and lX_csum_replace.
429  *     @skb: pointer to skb
430  *     @proto: new skb->protocol type
431  *     @flags: reserved
432  *     Return: 0 on success or negative error
433  *
434  * int bpf_skb_change_type(skb, type)
435  *     Change packet type of skb.
436  *     @skb: pointer to skb
437  *     @type: new skb->pkt_type type
438  *     Return: 0 on success or negative error
439  *
440  * int bpf_skb_under_cgroup(skb, map, index)
441  *     Check cgroup2 membership of skb
442  *     @skb: pointer to skb
443  *     @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
444  *     @index: index of the cgroup in the bpf_map
445  *     Return:
446  *       == 0 skb failed the cgroup2 descendant test
447  *       == 1 skb succeeded the cgroup2 descendant test
448  *        < 0 error
449  *
450  * u32 bpf_get_hash_recalc(skb)
451  *     Retrieve and possibly recalculate skb->hash.
452  *     @skb: pointer to skb
453  *     Return: hash
454  *
455  * u64 bpf_get_current_task(void)
456  *     Returns current task_struct
457  *     Return: current
458  *
459  * int bpf_probe_write_user(void *dst, void *src, int len)
460  *     safely attempt to write to a location
461  *     @dst: destination address in userspace
462  *     @src: source address on stack
463  *     @len: number of bytes to copy
464  *     Return: 0 on success or negative error
465  *
466  * int bpf_current_task_under_cgroup(map, index)
467  *     Check cgroup2 membership of current task
468  *     @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
469  *     @index: index of the cgroup in the bpf_map
470  *     Return:
471  *       == 0 current failed the cgroup2 descendant test
472  *       == 1 current succeeded the cgroup2 descendant test
473  *        < 0 error
474  *
475  * int bpf_skb_change_tail(skb, len, flags)
476  *     The helper will resize the skb to the given new size, to be used f.e.
477  *     with control messages.
478  *     @skb: pointer to skb
479  *     @len: new skb length
480  *     @flags: reserved
481  *     Return: 0 on success or negative error
482  *
483  * int bpf_skb_pull_data(skb, len)
484  *     The helper will pull in non-linear data in case the skb is non-linear
485  *     and not all of len are part of the linear section. Only needed for
486  *     read/write with direct packet access.
487  *     @skb: pointer to skb
488  *     @len: len to make read/writeable
489  *     Return: 0 on success or negative error
490  *
491  * s64 bpf_csum_update(skb, csum)
492  *     Adds csum into skb->csum in case of CHECKSUM_COMPLETE.
493  *     @skb: pointer to skb
494  *     @csum: csum to add
495  *     Return: csum on success or negative error
496  *
497  * void bpf_set_hash_invalid(skb)
498  *     Invalidate current skb->hash.
499  *     @skb: pointer to skb
500  *
501  * int bpf_get_numa_node_id()
502  *     Return: Id of current NUMA node.
503  *
504  * int bpf_skb_change_head()
505  *     Grows headroom of skb and adjusts MAC header offset accordingly.
506  *     Will extends/reallocae as required automatically.
507  *     May change skb data pointer and will thus invalidate any check
508  *     performed for direct packet access.
509  *     @skb: pointer to skb
510  *     @len: length of header to be pushed in front
511  *     @flags: Flags (unused for now)
512  *     Return: 0 on success or negative error
513  *
514  * int bpf_xdp_adjust_head(xdp_md, delta)
515  *     Adjust the xdp_md.data by delta
516  *     @xdp_md: pointer to xdp_md
517  *     @delta: An positive/negative integer to be added to xdp_md.data
518  *     Return: 0 on success or negative on error
519  *
520  * int bpf_probe_read_str(void *dst, int size, const void *unsafe_ptr)
521  *     Copy a NUL terminated string from unsafe address. In case the string
522  *     length is smaller than size, the target is not padded with further NUL
523  *     bytes. In case the string length is larger than size, just count-1
524  *     bytes are copied and the last byte is set to NUL.
525  *     @dst: destination address
526  *     @size: maximum number of bytes to copy, including the trailing NUL
527  *     @unsafe_ptr: unsafe address
528  *     Return:
529  *       > 0 length of the string including the trailing NUL on success
530  *       < 0 error
531  *
532  * u64 bpf_get_socket_cookie(skb)
533  *     Get the cookie for the socket stored inside sk_buff.
534  *     @skb: pointer to skb
535  *     Return: 8 Bytes non-decreasing number on success or 0 if the socket
536  *     field is missing inside sk_buff
537  *
538  * u32 bpf_get_socket_uid(skb)
539  *     Get the owner uid of the socket stored inside sk_buff.
540  *     @skb: pointer to skb
541  *     Return: uid of the socket owner on success or overflowuid if failed.
542  *
543  * u32 bpf_set_hash(skb, hash)
544  *     Set full skb->hash.
545  *     @skb: pointer to skb
546  *     @hash: hash to set
547  *
548  * int bpf_setsockopt(bpf_socket, level, optname, optval, optlen)
549  *     Calls setsockopt. Not all opts are available, only those with
550  *     integer optvals plus TCP_CONGESTION.
551  *     Supported levels: SOL_SOCKET and IPROTO_TCP
552  *     @bpf_socket: pointer to bpf_socket
553  *     @level: SOL_SOCKET or IPROTO_TCP
554  *     @optname: option name
555  *     @optval: pointer to option value
556  *     @optlen: length of optval in byes
557  *     Return: 0 or negative error
558  *
559  * int bpf_skb_adjust_room(skb, len_diff, mode, flags)
560  *     Grow or shrink room in sk_buff.
561  *     @skb: pointer to skb
562  *     @len_diff: (signed) amount of room to grow/shrink
563  *     @mode: operation mode (enum bpf_adj_room_mode)
564  *     @flags: reserved for future use
565  *     Return: 0 on success or negative error code
566  *
567  * int bpf_sk_redirect_map(map, key, flags)
568  *     Redirect skb to a sock in map using key as a lookup key for the
569  *     sock in map.
570  *     @map: pointer to sockmap
571  *     @key: key to lookup sock in map
572  *     @flags: reserved for future use
573  *     Return: SK_REDIRECT
574  *
575  * int bpf_sock_map_update(skops, map, key, flags, map_flags)
576  *	@skops: pointer to bpf_sock_ops
577  *	@map: pointer to sockmap to update
578  *	@key: key to insert/update sock in map
579  *	@flags: same flags as map update elem
580  *	@map_flags: sock map specific flags
581  *	   bit 1: Enable strparser
582  *	   other bits: reserved
583  */
584 #define __BPF_FUNC_MAPPER(FN)		\
585 	FN(unspec),			\
586 	FN(map_lookup_elem),		\
587 	FN(map_update_elem),		\
588 	FN(map_delete_elem),		\
589 	FN(probe_read),			\
590 	FN(ktime_get_ns),		\
591 	FN(trace_printk),		\
592 	FN(get_prandom_u32),		\
593 	FN(get_smp_processor_id),	\
594 	FN(skb_store_bytes),		\
595 	FN(l3_csum_replace),		\
596 	FN(l4_csum_replace),		\
597 	FN(tail_call),			\
598 	FN(clone_redirect),		\
599 	FN(get_current_pid_tgid),	\
600 	FN(get_current_uid_gid),	\
601 	FN(get_current_comm),		\
602 	FN(get_cgroup_classid),		\
603 	FN(skb_vlan_push),		\
604 	FN(skb_vlan_pop),		\
605 	FN(skb_get_tunnel_key),		\
606 	FN(skb_set_tunnel_key),		\
607 	FN(perf_event_read),		\
608 	FN(redirect),			\
609 	FN(get_route_realm),		\
610 	FN(perf_event_output),		\
611 	FN(skb_load_bytes),		\
612 	FN(get_stackid),		\
613 	FN(csum_diff),			\
614 	FN(skb_get_tunnel_opt),		\
615 	FN(skb_set_tunnel_opt),		\
616 	FN(skb_change_proto),		\
617 	FN(skb_change_type),		\
618 	FN(skb_under_cgroup),		\
619 	FN(get_hash_recalc),		\
620 	FN(get_current_task),		\
621 	FN(probe_write_user),		\
622 	FN(current_task_under_cgroup),	\
623 	FN(skb_change_tail),		\
624 	FN(skb_pull_data),		\
625 	FN(csum_update),		\
626 	FN(set_hash_invalid),		\
627 	FN(get_numa_node_id),		\
628 	FN(skb_change_head),		\
629 	FN(xdp_adjust_head),		\
630 	FN(probe_read_str),		\
631 	FN(get_socket_cookie),		\
632 	FN(get_socket_uid),		\
633 	FN(set_hash),			\
634 	FN(setsockopt),			\
635 	FN(skb_adjust_room),		\
636 	FN(redirect_map),		\
637 	FN(sk_redirect_map),		\
638 	FN(sock_map_update),
639 
640 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
641  * function eBPF program intends to call
642  */
643 #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
644 enum bpf_func_id {
645 	__BPF_FUNC_MAPPER(__BPF_ENUM_FN)
646 	__BPF_FUNC_MAX_ID,
647 };
648 #undef __BPF_ENUM_FN
649 
650 /* All flags used by eBPF helper functions, placed here. */
651 
652 /* BPF_FUNC_skb_store_bytes flags. */
653 #define BPF_F_RECOMPUTE_CSUM		(1ULL << 0)
654 #define BPF_F_INVALIDATE_HASH		(1ULL << 1)
655 
656 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
657  * First 4 bits are for passing the header field size.
658  */
659 #define BPF_F_HDR_FIELD_MASK		0xfULL
660 
661 /* BPF_FUNC_l4_csum_replace flags. */
662 #define BPF_F_PSEUDO_HDR		(1ULL << 4)
663 #define BPF_F_MARK_MANGLED_0		(1ULL << 5)
664 #define BPF_F_MARK_ENFORCE		(1ULL << 6)
665 
666 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
667 #define BPF_F_INGRESS			(1ULL << 0)
668 
669 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
670 #define BPF_F_TUNINFO_IPV6		(1ULL << 0)
671 
672 /* BPF_FUNC_get_stackid flags. */
673 #define BPF_F_SKIP_FIELD_MASK		0xffULL
674 #define BPF_F_USER_STACK		(1ULL << 8)
675 #define BPF_F_FAST_STACK_CMP		(1ULL << 9)
676 #define BPF_F_REUSE_STACKID		(1ULL << 10)
677 
678 /* BPF_FUNC_skb_set_tunnel_key flags. */
679 #define BPF_F_ZERO_CSUM_TX		(1ULL << 1)
680 #define BPF_F_DONT_FRAGMENT		(1ULL << 2)
681 
682 /* BPF_FUNC_perf_event_output and BPF_FUNC_perf_event_read flags. */
683 #define BPF_F_INDEX_MASK		0xffffffffULL
684 #define BPF_F_CURRENT_CPU		BPF_F_INDEX_MASK
685 /* BPF_FUNC_perf_event_output for sk_buff input context. */
686 #define BPF_F_CTXLEN_MASK		(0xfffffULL << 32)
687 
688 /* Mode for BPF_FUNC_skb_adjust_room helper. */
689 enum bpf_adj_room_mode {
690 	BPF_ADJ_ROOM_NET_OPTS,
691 };
692 
693 /* user accessible mirror of in-kernel sk_buff.
694  * new fields can only be added to the end of this structure
695  */
696 struct __sk_buff {
697 	__u32 len;
698 	__u32 pkt_type;
699 	__u32 mark;
700 	__u32 queue_mapping;
701 	__u32 protocol;
702 	__u32 vlan_present;
703 	__u32 vlan_tci;
704 	__u32 vlan_proto;
705 	__u32 priority;
706 	__u32 ingress_ifindex;
707 	__u32 ifindex;
708 	__u32 tc_index;
709 	__u32 cb[5];
710 	__u32 hash;
711 	__u32 tc_classid;
712 	__u32 data;
713 	__u32 data_end;
714 	__u32 napi_id;
715 
716 	/* accessed by BPF_PROG_TYPE_sk_skb types */
717 	__u32 family;
718 	__u32 remote_ip4;	/* Stored in network byte order */
719 	__u32 local_ip4;	/* Stored in network byte order */
720 	__u32 remote_ip6[4];	/* Stored in network byte order */
721 	__u32 local_ip6[4];	/* Stored in network byte order */
722 	__u32 remote_port;	/* Stored in network byte order */
723 	__u32 local_port;	/* stored in host byte order */
724 };
725 
726 struct bpf_tunnel_key {
727 	__u32 tunnel_id;
728 	union {
729 		__u32 remote_ipv4;
730 		__u32 remote_ipv6[4];
731 	};
732 	__u8 tunnel_tos;
733 	__u8 tunnel_ttl;
734 	__u16 tunnel_ext;
735 	__u32 tunnel_label;
736 };
737 
738 /* Generic BPF return codes which all BPF program types may support.
739  * The values are binary compatible with their TC_ACT_* counter-part to
740  * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
741  * programs.
742  *
743  * XDP is handled seprately, see XDP_*.
744  */
745 enum bpf_ret_code {
746 	BPF_OK = 0,
747 	/* 1 reserved */
748 	BPF_DROP = 2,
749 	/* 3-6 reserved */
750 	BPF_REDIRECT = 7,
751 	/* >127 are reserved for prog type specific return codes */
752 };
753 
754 struct bpf_sock {
755 	__u32 bound_dev_if;
756 	__u32 family;
757 	__u32 type;
758 	__u32 protocol;
759 };
760 
761 #define XDP_PACKET_HEADROOM 256
762 
763 /* User return codes for XDP prog type.
764  * A valid XDP program must return one of these defined values. All other
765  * return codes are reserved for future use. Unknown return codes will result
766  * in packet drop.
767  */
768 enum xdp_action {
769 	XDP_ABORTED = 0,
770 	XDP_DROP,
771 	XDP_PASS,
772 	XDP_TX,
773 };
774 
775 /* user accessible metadata for XDP packet hook
776  * new fields must be added to the end of this structure
777  */
778 struct xdp_md {
779 	__u32 data;
780 	__u32 data_end;
781 };
782 
783 enum sk_action {
784 	SK_ABORTED = 0,
785 	SK_DROP,
786 	SK_REDIRECT,
787 };
788 
789 #define BPF_TAG_SIZE	8
790 
791 struct bpf_prog_info {
792 	__u32 type;
793 	__u32 id;
794 	__u8  tag[BPF_TAG_SIZE];
795 	__u32 jited_prog_len;
796 	__u32 xlated_prog_len;
797 	__aligned_u64 jited_prog_insns;
798 	__aligned_u64 xlated_prog_insns;
799 } __attribute__((aligned(8)));
800 
801 struct bpf_map_info {
802 	__u32 type;
803 	__u32 id;
804 	__u32 key_size;
805 	__u32 value_size;
806 	__u32 max_entries;
807 	__u32 map_flags;
808 } __attribute__((aligned(8)));
809 
810 /* User bpf_sock_ops struct to access socket values and specify request ops
811  * and their replies.
812  * New fields can only be added at the end of this structure
813  */
814 struct bpf_sock_ops {
815 	__u32 op;
816 	union {
817 		__u32 reply;
818 		__u32 replylong[4];
819 	};
820 	__u32 family;
821 	__u32 remote_ip4;
822 	__u32 local_ip4;
823 	__u32 remote_ip6[4];
824 	__u32 local_ip6[4];
825 	__u32 remote_port;
826 	__u32 local_port;
827 };
828 
829 /* List of known BPF sock_ops operators.
830  * New entries can only be added at the end
831  */
832 enum {
833 	BPF_SOCK_OPS_VOID,
834 	BPF_SOCK_OPS_TIMEOUT_INIT,	/* Should return SYN-RTO value to use or
835 					 * -1 if default value should be used
836 					 */
837 	BPF_SOCK_OPS_RWND_INIT,		/* Should return initial advertized
838 					 * window (in packets) or -1 if default
839 					 * value should be used
840 					 */
841 	BPF_SOCK_OPS_TCP_CONNECT_CB,	/* Calls BPF program right before an
842 					 * active connection is initialized
843 					 */
844 	BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB,	/* Calls BPF program when an
845 						 * active connection is
846 						 * established
847 						 */
848 	BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB,	/* Calls BPF program when a
849 						 * passive connection is
850 						 * established
851 						 */
852 	BPF_SOCK_OPS_NEEDS_ECN,		/* If connection's congestion control
853 					 * needs ECN
854 					 */
855 };
856 
857 #define TCP_BPF_IW		1001	/* Set TCP initial congestion window */
858 #define TCP_BPF_SNDCWND_CLAMP	1002	/* Set sndcwnd_clamp */
859 
860 #endif /* _UAPI__LINUX_BPF_H__ */
861