xref: /linux-6.15/include/uapi/linux/bpf.h (revision 6197e5b7)
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of version 2 of the GNU General Public
6  * License as published by the Free Software Foundation.
7  */
8 #ifndef _UAPI__LINUX_BPF_H__
9 #define _UAPI__LINUX_BPF_H__
10 
11 #include <linux/types.h>
12 #include <linux/bpf_common.h>
13 
14 /* Extended instruction set based on top of classic BPF */
15 
16 /* instruction classes */
17 #define BPF_JMP32	0x06	/* jmp mode in word width */
18 #define BPF_ALU64	0x07	/* alu mode in double word width */
19 
20 /* ld/ldx fields */
21 #define BPF_DW		0x18	/* double word (64-bit) */
22 #define BPF_ATOMIC	0xc0	/* atomic memory ops - op type in immediate */
23 #define BPF_XADD	0xc0	/* exclusive add - legacy name */
24 
25 /* alu/jmp fields */
26 #define BPF_MOV		0xb0	/* mov reg to reg */
27 #define BPF_ARSH	0xc0	/* sign extending arithmetic shift right */
28 
29 /* change endianness of a register */
30 #define BPF_END		0xd0	/* flags for endianness conversion: */
31 #define BPF_TO_LE	0x00	/* convert to little-endian */
32 #define BPF_TO_BE	0x08	/* convert to big-endian */
33 #define BPF_FROM_LE	BPF_TO_LE
34 #define BPF_FROM_BE	BPF_TO_BE
35 
36 /* jmp encodings */
37 #define BPF_JNE		0x50	/* jump != */
38 #define BPF_JLT		0xa0	/* LT is unsigned, '<' */
39 #define BPF_JLE		0xb0	/* LE is unsigned, '<=' */
40 #define BPF_JSGT	0x60	/* SGT is signed '>', GT in x86 */
41 #define BPF_JSGE	0x70	/* SGE is signed '>=', GE in x86 */
42 #define BPF_JSLT	0xc0	/* SLT is signed, '<' */
43 #define BPF_JSLE	0xd0	/* SLE is signed, '<=' */
44 #define BPF_CALL	0x80	/* function call */
45 #define BPF_EXIT	0x90	/* function return */
46 
47 /* atomic op type fields (stored in immediate) */
48 #define BPF_FETCH	0x01	/* not an opcode on its own, used to build others */
49 #define BPF_XCHG	(0xe0 | BPF_FETCH)	/* atomic exchange */
50 #define BPF_CMPXCHG	(0xf0 | BPF_FETCH)	/* atomic compare-and-write */
51 
52 /* Register numbers */
53 enum {
54 	BPF_REG_0 = 0,
55 	BPF_REG_1,
56 	BPF_REG_2,
57 	BPF_REG_3,
58 	BPF_REG_4,
59 	BPF_REG_5,
60 	BPF_REG_6,
61 	BPF_REG_7,
62 	BPF_REG_8,
63 	BPF_REG_9,
64 	BPF_REG_10,
65 	__MAX_BPF_REG,
66 };
67 
68 /* BPF has 10 general purpose 64-bit registers and stack frame. */
69 #define MAX_BPF_REG	__MAX_BPF_REG
70 
71 struct bpf_insn {
72 	__u8	code;		/* opcode */
73 	__u8	dst_reg:4;	/* dest register */
74 	__u8	src_reg:4;	/* source register */
75 	__s16	off;		/* signed offset */
76 	__s32	imm;		/* signed immediate constant */
77 };
78 
79 /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
80 struct bpf_lpm_trie_key {
81 	__u32	prefixlen;	/* up to 32 for AF_INET, 128 for AF_INET6 */
82 	__u8	data[0];	/* Arbitrary size */
83 };
84 
85 struct bpf_cgroup_storage_key {
86 	__u64	cgroup_inode_id;	/* cgroup inode id */
87 	__u32	attach_type;		/* program attach type */
88 };
89 
90 union bpf_iter_link_info {
91 	struct {
92 		__u32	map_fd;
93 	} map;
94 };
95 
96 /* BPF syscall commands, see bpf(2) man-page for more details. */
97 /**
98  * DOC: eBPF Syscall Preamble
99  *
100  * The operation to be performed by the **bpf**\ () system call is determined
101  * by the *cmd* argument. Each operation takes an accompanying argument,
102  * provided via *attr*, which is a pointer to a union of type *bpf_attr* (see
103  * below). The size argument is the size of the union pointed to by *attr*.
104  */
105 /**
106  * DOC: eBPF Syscall Commands
107  *
108  * BPF_MAP_CREATE
109  *	Description
110  *		Create a map and return a file descriptor that refers to the
111  *		map. The close-on-exec file descriptor flag (see **fcntl**\ (2))
112  *		is automatically enabled for the new file descriptor.
113  *
114  *		Applying **close**\ (2) to the file descriptor returned by
115  *		**BPF_MAP_CREATE** will delete the map (but see NOTES).
116  *
117  *	Return
118  *		A new file descriptor (a nonnegative integer), or -1 if an
119  *		error occurred (in which case, *errno* is set appropriately).
120  *
121  * BPF_MAP_LOOKUP_ELEM
122  *	Description
123  *		Look up an element with a given *key* in the map referred to
124  *		by the file descriptor *map_fd*.
125  *
126  *		The *flags* argument may be specified as one of the
127  *		following:
128  *
129  *		**BPF_F_LOCK**
130  *			Look up the value of a spin-locked map without
131  *			returning the lock. This must be specified if the
132  *			elements contain a spinlock.
133  *
134  *	Return
135  *		Returns zero on success. On error, -1 is returned and *errno*
136  *		is set appropriately.
137  *
138  * BPF_MAP_UPDATE_ELEM
139  *	Description
140  *		Create or update an element (key/value pair) in a specified map.
141  *
142  *		The *flags* argument should be specified as one of the
143  *		following:
144  *
145  *		**BPF_ANY**
146  *			Create a new element or update an existing element.
147  *		**BPF_NOEXIST**
148  *			Create a new element only if it did not exist.
149  *		**BPF_EXIST**
150  *			Update an existing element.
151  *		**BPF_F_LOCK**
152  *			Update a spin_lock-ed map element.
153  *
154  *	Return
155  *		Returns zero on success. On error, -1 is returned and *errno*
156  *		is set appropriately.
157  *
158  *		May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**,
159  *		**E2BIG**, **EEXIST**, or **ENOENT**.
160  *
161  *		**E2BIG**
162  *			The number of elements in the map reached the
163  *			*max_entries* limit specified at map creation time.
164  *		**EEXIST**
165  *			If *flags* specifies **BPF_NOEXIST** and the element
166  *			with *key* already exists in the map.
167  *		**ENOENT**
168  *			If *flags* specifies **BPF_EXIST** and the element with
169  *			*key* does not exist in the map.
170  *
171  * BPF_MAP_DELETE_ELEM
172  *	Description
173  *		Look up and delete an element by key in a specified map.
174  *
175  *	Return
176  *		Returns zero on success. On error, -1 is returned and *errno*
177  *		is set appropriately.
178  *
179  * BPF_MAP_GET_NEXT_KEY
180  *	Description
181  *		Look up an element by key in a specified map and return the key
182  *		of the next element. Can be used to iterate over all elements
183  *		in the map.
184  *
185  *	Return
186  *		Returns zero on success. On error, -1 is returned and *errno*
187  *		is set appropriately.
188  *
189  *		The following cases can be used to iterate over all elements of
190  *		the map:
191  *
192  *		* If *key* is not found, the operation returns zero and sets
193  *		  the *next_key* pointer to the key of the first element.
194  *		* If *key* is found, the operation returns zero and sets the
195  *		  *next_key* pointer to the key of the next element.
196  *		* If *key* is the last element, returns -1 and *errno* is set
197  *		  to **ENOENT**.
198  *
199  *		May set *errno* to **ENOMEM**, **EFAULT**, **EPERM**, or
200  *		**EINVAL** on error.
201  *
202  * BPF_PROG_LOAD
203  *	Description
204  *		Verify and load an eBPF program, returning a new file
205  *		descriptor associated with the program.
206  *
207  *		Applying **close**\ (2) to the file descriptor returned by
208  *		**BPF_PROG_LOAD** will unload the eBPF program (but see NOTES).
209  *
210  *		The close-on-exec file descriptor flag (see **fcntl**\ (2)) is
211  *		automatically enabled for the new file descriptor.
212  *
213  *	Return
214  *		A new file descriptor (a nonnegative integer), or -1 if an
215  *		error occurred (in which case, *errno* is set appropriately).
216  *
217  * BPF_OBJ_PIN
218  *	Description
219  *		Pin an eBPF program or map referred by the specified *bpf_fd*
220  *		to the provided *pathname* on the filesystem.
221  *
222  *		The *pathname* argument must not contain a dot (".").
223  *
224  *		On success, *pathname* retains a reference to the eBPF object,
225  *		preventing deallocation of the object when the original
226  *		*bpf_fd* is closed. This allow the eBPF object to live beyond
227  *		**close**\ (\ *bpf_fd*\ ), and hence the lifetime of the parent
228  *		process.
229  *
230  *		Applying **unlink**\ (2) or similar calls to the *pathname*
231  *		unpins the object from the filesystem, removing the reference.
232  *		If no other file descriptors or filesystem nodes refer to the
233  *		same object, it will be deallocated (see NOTES).
234  *
235  *		The filesystem type for the parent directory of *pathname* must
236  *		be **BPF_FS_MAGIC**.
237  *
238  *	Return
239  *		Returns zero on success. On error, -1 is returned and *errno*
240  *		is set appropriately.
241  *
242  * BPF_OBJ_GET
243  *	Description
244  *		Open a file descriptor for the eBPF object pinned to the
245  *		specified *pathname*.
246  *
247  *	Return
248  *		A new file descriptor (a nonnegative integer), or -1 if an
249  *		error occurred (in which case, *errno* is set appropriately).
250  *
251  * BPF_PROG_ATTACH
252  *	Description
253  *		Attach an eBPF program to a *target_fd* at the specified
254  *		*attach_type* hook.
255  *
256  *		The *attach_type* specifies the eBPF attachment point to
257  *		attach the program to, and must be one of *bpf_attach_type*
258  *		(see below).
259  *
260  *		The *attach_bpf_fd* must be a valid file descriptor for a
261  *		loaded eBPF program of a cgroup, flow dissector, LIRC, sockmap
262  *		or sock_ops type corresponding to the specified *attach_type*.
263  *
264  *		The *target_fd* must be a valid file descriptor for a kernel
265  *		object which depends on the attach type of *attach_bpf_fd*:
266  *
267  *		**BPF_PROG_TYPE_CGROUP_DEVICE**,
268  *		**BPF_PROG_TYPE_CGROUP_SKB**,
269  *		**BPF_PROG_TYPE_CGROUP_SOCK**,
270  *		**BPF_PROG_TYPE_CGROUP_SOCK_ADDR**,
271  *		**BPF_PROG_TYPE_CGROUP_SOCKOPT**,
272  *		**BPF_PROG_TYPE_CGROUP_SYSCTL**,
273  *		**BPF_PROG_TYPE_SOCK_OPS**
274  *
275  *			Control Group v2 hierarchy with the eBPF controller
276  *			enabled. Requires the kernel to be compiled with
277  *			**CONFIG_CGROUP_BPF**.
278  *
279  *		**BPF_PROG_TYPE_FLOW_DISSECTOR**
280  *
281  *			Network namespace (eg /proc/self/ns/net).
282  *
283  *		**BPF_PROG_TYPE_LIRC_MODE2**
284  *
285  *			LIRC device path (eg /dev/lircN). Requires the kernel
286  *			to be compiled with **CONFIG_BPF_LIRC_MODE2**.
287  *
288  *		**BPF_PROG_TYPE_SK_SKB**,
289  *		**BPF_PROG_TYPE_SK_MSG**
290  *
291  *			eBPF map of socket type (eg **BPF_MAP_TYPE_SOCKHASH**).
292  *
293  *	Return
294  *		Returns zero on success. On error, -1 is returned and *errno*
295  *		is set appropriately.
296  *
297  * BPF_PROG_DETACH
298  *	Description
299  *		Detach the eBPF program associated with the *target_fd* at the
300  *		hook specified by *attach_type*. The program must have been
301  *		previously attached using **BPF_PROG_ATTACH**.
302  *
303  *	Return
304  *		Returns zero on success. On error, -1 is returned and *errno*
305  *		is set appropriately.
306  *
307  * BPF_PROG_TEST_RUN
308  *	Description
309  *		Run the eBPF program associated with the *prog_fd* a *repeat*
310  *		number of times against a provided program context *ctx_in* and
311  *		data *data_in*, and return the modified program context
312  *		*ctx_out*, *data_out* (for example, packet data), result of the
313  *		execution *retval*, and *duration* of the test run.
314  *
315  *	Return
316  *		Returns zero on success. On error, -1 is returned and *errno*
317  *		is set appropriately.
318  *
319  *		**ENOSPC**
320  *			Either *data_size_out* or *ctx_size_out* is too small.
321  *		**ENOTSUPP**
322  *			This command is not supported by the program type of
323  *			the program referred to by *prog_fd*.
324  *
325  * BPF_PROG_GET_NEXT_ID
326  *	Description
327  *		Fetch the next eBPF program currently loaded into the kernel.
328  *
329  *		Looks for the eBPF program with an id greater than *start_id*
330  *		and updates *next_id* on success. If no other eBPF programs
331  *		remain with ids higher than *start_id*, returns -1 and sets
332  *		*errno* to **ENOENT**.
333  *
334  *	Return
335  *		Returns zero on success. On error, or when no id remains, -1
336  *		is returned and *errno* is set appropriately.
337  *
338  * BPF_MAP_GET_NEXT_ID
339  *	Description
340  *		Fetch the next eBPF map currently loaded into the kernel.
341  *
342  *		Looks for the eBPF map with an id greater than *start_id*
343  *		and updates *next_id* on success. If no other eBPF maps
344  *		remain with ids higher than *start_id*, returns -1 and sets
345  *		*errno* to **ENOENT**.
346  *
347  *	Return
348  *		Returns zero on success. On error, or when no id remains, -1
349  *		is returned and *errno* is set appropriately.
350  *
351  * BPF_PROG_GET_FD_BY_ID
352  *	Description
353  *		Open a file descriptor for the eBPF program corresponding to
354  *		*prog_id*.
355  *
356  *	Return
357  *		A new file descriptor (a nonnegative integer), or -1 if an
358  *		error occurred (in which case, *errno* is set appropriately).
359  *
360  * BPF_MAP_GET_FD_BY_ID
361  *	Description
362  *		Open a file descriptor for the eBPF map corresponding to
363  *		*map_id*.
364  *
365  *	Return
366  *		A new file descriptor (a nonnegative integer), or -1 if an
367  *		error occurred (in which case, *errno* is set appropriately).
368  *
369  * BPF_OBJ_GET_INFO_BY_FD
370  *	Description
371  *		Obtain information about the eBPF object corresponding to
372  *		*bpf_fd*.
373  *
374  *		Populates up to *info_len* bytes of *info*, which will be in
375  *		one of the following formats depending on the eBPF object type
376  *		of *bpf_fd*:
377  *
378  *		* **struct bpf_prog_info**
379  *		* **struct bpf_map_info**
380  *		* **struct bpf_btf_info**
381  *		* **struct bpf_link_info**
382  *
383  *	Return
384  *		Returns zero on success. On error, -1 is returned and *errno*
385  *		is set appropriately.
386  *
387  * BPF_PROG_QUERY
388  *	Description
389  *		Obtain information about eBPF programs associated with the
390  *		specified *attach_type* hook.
391  *
392  *		The *target_fd* must be a valid file descriptor for a kernel
393  *		object which depends on the attach type of *attach_bpf_fd*:
394  *
395  *		**BPF_PROG_TYPE_CGROUP_DEVICE**,
396  *		**BPF_PROG_TYPE_CGROUP_SKB**,
397  *		**BPF_PROG_TYPE_CGROUP_SOCK**,
398  *		**BPF_PROG_TYPE_CGROUP_SOCK_ADDR**,
399  *		**BPF_PROG_TYPE_CGROUP_SOCKOPT**,
400  *		**BPF_PROG_TYPE_CGROUP_SYSCTL**,
401  *		**BPF_PROG_TYPE_SOCK_OPS**
402  *
403  *			Control Group v2 hierarchy with the eBPF controller
404  *			enabled. Requires the kernel to be compiled with
405  *			**CONFIG_CGROUP_BPF**.
406  *
407  *		**BPF_PROG_TYPE_FLOW_DISSECTOR**
408  *
409  *			Network namespace (eg /proc/self/ns/net).
410  *
411  *		**BPF_PROG_TYPE_LIRC_MODE2**
412  *
413  *			LIRC device path (eg /dev/lircN). Requires the kernel
414  *			to be compiled with **CONFIG_BPF_LIRC_MODE2**.
415  *
416  *		**BPF_PROG_QUERY** always fetches the number of programs
417  *		attached and the *attach_flags* which were used to attach those
418  *		programs. Additionally, if *prog_ids* is nonzero and the number
419  *		of attached programs is less than *prog_cnt*, populates
420  *		*prog_ids* with the eBPF program ids of the programs attached
421  *		at *target_fd*.
422  *
423  *		The following flags may alter the result:
424  *
425  *		**BPF_F_QUERY_EFFECTIVE**
426  *			Only return information regarding programs which are
427  *			currently effective at the specified *target_fd*.
428  *
429  *	Return
430  *		Returns zero on success. On error, -1 is returned and *errno*
431  *		is set appropriately.
432  *
433  * BPF_RAW_TRACEPOINT_OPEN
434  *	Description
435  *		Attach an eBPF program to a tracepoint *name* to access kernel
436  *		internal arguments of the tracepoint in their raw form.
437  *
438  *		The *prog_fd* must be a valid file descriptor associated with
439  *		a loaded eBPF program of type **BPF_PROG_TYPE_RAW_TRACEPOINT**.
440  *
441  *		No ABI guarantees are made about the content of tracepoint
442  *		arguments exposed to the corresponding eBPF program.
443  *
444  *		Applying **close**\ (2) to the file descriptor returned by
445  *		**BPF_RAW_TRACEPOINT_OPEN** will delete the map (but see NOTES).
446  *
447  *	Return
448  *		A new file descriptor (a nonnegative integer), or -1 if an
449  *		error occurred (in which case, *errno* is set appropriately).
450  *
451  * BPF_BTF_LOAD
452  *	Description
453  *		Verify and load BPF Type Format (BTF) metadata into the kernel,
454  *		returning a new file descriptor associated with the metadata.
455  *		BTF is described in more detail at
456  *		https://www.kernel.org/doc/html/latest/bpf/btf.html.
457  *
458  *		The *btf* parameter must point to valid memory providing
459  *		*btf_size* bytes of BTF binary metadata.
460  *
461  *		The returned file descriptor can be passed to other **bpf**\ ()
462  *		subcommands such as **BPF_PROG_LOAD** or **BPF_MAP_CREATE** to
463  *		associate the BTF with those objects.
464  *
465  *		Similar to **BPF_PROG_LOAD**, **BPF_BTF_LOAD** has optional
466  *		parameters to specify a *btf_log_buf*, *btf_log_size* and
467  *		*btf_log_level* which allow the kernel to return freeform log
468  *		output regarding the BTF verification process.
469  *
470  *	Return
471  *		A new file descriptor (a nonnegative integer), or -1 if an
472  *		error occurred (in which case, *errno* is set appropriately).
473  *
474  * BPF_BTF_GET_FD_BY_ID
475  *	Description
476  *		Open a file descriptor for the BPF Type Format (BTF)
477  *		corresponding to *btf_id*.
478  *
479  *	Return
480  *		A new file descriptor (a nonnegative integer), or -1 if an
481  *		error occurred (in which case, *errno* is set appropriately).
482  *
483  * BPF_TASK_FD_QUERY
484  *	Description
485  *		Obtain information about eBPF programs associated with the
486  *		target process identified by *pid* and *fd*.
487  *
488  *		If the *pid* and *fd* are associated with a tracepoint, kprobe
489  *		or uprobe perf event, then the *prog_id* and *fd_type* will
490  *		be populated with the eBPF program id and file descriptor type
491  *		of type **bpf_task_fd_type**. If associated with a kprobe or
492  *		uprobe, the  *probe_offset* and *probe_addr* will also be
493  *		populated. Optionally, if *buf* is provided, then up to
494  *		*buf_len* bytes of *buf* will be populated with the name of
495  *		the tracepoint, kprobe or uprobe.
496  *
497  *		The resulting *prog_id* may be introspected in deeper detail
498  *		using **BPF_PROG_GET_FD_BY_ID** and **BPF_OBJ_GET_INFO_BY_FD**.
499  *
500  *	Return
501  *		Returns zero on success. On error, -1 is returned and *errno*
502  *		is set appropriately.
503  *
504  * BPF_MAP_LOOKUP_AND_DELETE_ELEM
505  *	Description
506  *		Look up an element with the given *key* in the map referred to
507  *		by the file descriptor *fd*, and if found, delete the element.
508  *
509  *		The **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map types
510  *		implement this command as a "pop" operation, deleting the top
511  *		element rather than one corresponding to *key*.
512  *		The *key* and *key_len* parameters should be zeroed when
513  *		issuing this operation for these map types.
514  *
515  *		This command is only valid for the following map types:
516  *		* **BPF_MAP_TYPE_QUEUE**
517  *		* **BPF_MAP_TYPE_STACK**
518  *
519  *	Return
520  *		Returns zero on success. On error, -1 is returned and *errno*
521  *		is set appropriately.
522  *
523  * BPF_MAP_FREEZE
524  *	Description
525  *		Freeze the permissions of the specified map.
526  *
527  *		Write permissions may be frozen by passing zero *flags*.
528  *		Upon success, no future syscall invocations may alter the
529  *		map state of *map_fd*. Write operations from eBPF programs
530  *		are still possible for a frozen map.
531  *
532  *		Not supported for maps of type **BPF_MAP_TYPE_STRUCT_OPS**.
533  *
534  *	Return
535  *		Returns zero on success. On error, -1 is returned and *errno*
536  *		is set appropriately.
537  *
538  * BPF_BTF_GET_NEXT_ID
539  *	Description
540  *		Fetch the next BPF Type Format (BTF) object currently loaded
541  *		into the kernel.
542  *
543  *		Looks for the BTF object with an id greater than *start_id*
544  *		and updates *next_id* on success. If no other BTF objects
545  *		remain with ids higher than *start_id*, returns -1 and sets
546  *		*errno* to **ENOENT**.
547  *
548  *	Return
549  *		Returns zero on success. On error, or when no id remains, -1
550  *		is returned and *errno* is set appropriately.
551  *
552  * BPF_MAP_LOOKUP_BATCH
553  *	Description
554  *		Iterate and fetch multiple elements in a map.
555  *
556  *		Two opaque values are used to manage batch operations,
557  *		*in_batch* and *out_batch*. Initially, *in_batch* must be set
558  *		to NULL to begin the batched operation. After each subsequent
559  *		**BPF_MAP_LOOKUP_BATCH**, the caller should pass the resultant
560  *		*out_batch* as the *in_batch* for the next operation to
561  *		continue iteration from the current point.
562  *
563  *		The *keys* and *values* are output parameters which must point
564  *		to memory large enough to hold *count* items based on the key
565  *		and value size of the map *map_fd*. The *keys* buffer must be
566  *		of *key_size* * *count*. The *values* buffer must be of
567  *		*value_size* * *count*.
568  *
569  *		The *elem_flags* argument may be specified as one of the
570  *		following:
571  *
572  *		**BPF_F_LOCK**
573  *			Look up the value of a spin-locked map without
574  *			returning the lock. This must be specified if the
575  *			elements contain a spinlock.
576  *
577  *		On success, *count* elements from the map are copied into the
578  *		user buffer, with the keys copied into *keys* and the values
579  *		copied into the corresponding indices in *values*.
580  *
581  *		If an error is returned and *errno* is not **EFAULT**, *count*
582  *		is set to the number of successfully processed elements.
583  *
584  *	Return
585  *		Returns zero on success. On error, -1 is returned and *errno*
586  *		is set appropriately.
587  *
588  *		May set *errno* to **ENOSPC** to indicate that *keys* or
589  *		*values* is too small to dump an entire bucket during
590  *		iteration of a hash-based map type.
591  *
592  * BPF_MAP_LOOKUP_AND_DELETE_BATCH
593  *	Description
594  *		Iterate and delete all elements in a map.
595  *
596  *		This operation has the same behavior as
597  *		**BPF_MAP_LOOKUP_BATCH** with two exceptions:
598  *
599  *		* Every element that is successfully returned is also deleted
600  *		  from the map. This is at least *count* elements. Note that
601  *		  *count* is both an input and an output parameter.
602  *		* Upon returning with *errno* set to **EFAULT**, up to
603  *		  *count* elements may be deleted without returning the keys
604  *		  and values of the deleted elements.
605  *
606  *	Return
607  *		Returns zero on success. On error, -1 is returned and *errno*
608  *		is set appropriately.
609  *
610  * BPF_MAP_UPDATE_BATCH
611  *	Description
612  *		Update multiple elements in a map by *key*.
613  *
614  *		The *keys* and *values* are input parameters which must point
615  *		to memory large enough to hold *count* items based on the key
616  *		and value size of the map *map_fd*. The *keys* buffer must be
617  *		of *key_size* * *count*. The *values* buffer must be of
618  *		*value_size* * *count*.
619  *
620  *		Each element specified in *keys* is sequentially updated to the
621  *		value in the corresponding index in *values*. The *in_batch*
622  *		and *out_batch* parameters are ignored and should be zeroed.
623  *
624  *		The *elem_flags* argument should be specified as one of the
625  *		following:
626  *
627  *		**BPF_ANY**
628  *			Create new elements or update a existing elements.
629  *		**BPF_NOEXIST**
630  *			Create new elements only if they do not exist.
631  *		**BPF_EXIST**
632  *			Update existing elements.
633  *		**BPF_F_LOCK**
634  *			Update spin_lock-ed map elements. This must be
635  *			specified if the map value contains a spinlock.
636  *
637  *		On success, *count* elements from the map are updated.
638  *
639  *		If an error is returned and *errno* is not **EFAULT**, *count*
640  *		is set to the number of successfully processed elements.
641  *
642  *	Return
643  *		Returns zero on success. On error, -1 is returned and *errno*
644  *		is set appropriately.
645  *
646  *		May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**, or
647  *		**E2BIG**. **E2BIG** indicates that the number of elements in
648  *		the map reached the *max_entries* limit specified at map
649  *		creation time.
650  *
651  *		May set *errno* to one of the following error codes under
652  *		specific circumstances:
653  *
654  *		**EEXIST**
655  *			If *flags* specifies **BPF_NOEXIST** and the element
656  *			with *key* already exists in the map.
657  *		**ENOENT**
658  *			If *flags* specifies **BPF_EXIST** and the element with
659  *			*key* does not exist in the map.
660  *
661  * BPF_MAP_DELETE_BATCH
662  *	Description
663  *		Delete multiple elements in a map by *key*.
664  *
665  *		The *keys* parameter is an input parameter which must point
666  *		to memory large enough to hold *count* items based on the key
667  *		size of the map *map_fd*, that is, *key_size* * *count*.
668  *
669  *		Each element specified in *keys* is sequentially deleted. The
670  *		*in_batch*, *out_batch*, and *values* parameters are ignored
671  *		and should be zeroed.
672  *
673  *		The *elem_flags* argument may be specified as one of the
674  *		following:
675  *
676  *		**BPF_F_LOCK**
677  *			Look up the value of a spin-locked map without
678  *			returning the lock. This must be specified if the
679  *			elements contain a spinlock.
680  *
681  *		On success, *count* elements from the map are updated.
682  *
683  *		If an error is returned and *errno* is not **EFAULT**, *count*
684  *		is set to the number of successfully processed elements. If
685  *		*errno* is **EFAULT**, up to *count* elements may be been
686  *		deleted.
687  *
688  *	Return
689  *		Returns zero on success. On error, -1 is returned and *errno*
690  *		is set appropriately.
691  *
692  * BPF_LINK_CREATE
693  *	Description
694  *		Attach an eBPF program to a *target_fd* at the specified
695  *		*attach_type* hook and return a file descriptor handle for
696  *		managing the link.
697  *
698  *	Return
699  *		A new file descriptor (a nonnegative integer), or -1 if an
700  *		error occurred (in which case, *errno* is set appropriately).
701  *
702  * BPF_LINK_UPDATE
703  *	Description
704  *		Update the eBPF program in the specified *link_fd* to
705  *		*new_prog_fd*.
706  *
707  *	Return
708  *		Returns zero on success. On error, -1 is returned and *errno*
709  *		is set appropriately.
710  *
711  * BPF_LINK_GET_FD_BY_ID
712  *	Description
713  *		Open a file descriptor for the eBPF Link corresponding to
714  *		*link_id*.
715  *
716  *	Return
717  *		A new file descriptor (a nonnegative integer), or -1 if an
718  *		error occurred (in which case, *errno* is set appropriately).
719  *
720  * BPF_LINK_GET_NEXT_ID
721  *	Description
722  *		Fetch the next eBPF link currently loaded into the kernel.
723  *
724  *		Looks for the eBPF link with an id greater than *start_id*
725  *		and updates *next_id* on success. If no other eBPF links
726  *		remain with ids higher than *start_id*, returns -1 and sets
727  *		*errno* to **ENOENT**.
728  *
729  *	Return
730  *		Returns zero on success. On error, or when no id remains, -1
731  *		is returned and *errno* is set appropriately.
732  *
733  * BPF_ENABLE_STATS
734  *	Description
735  *		Enable eBPF runtime statistics gathering.
736  *
737  *		Runtime statistics gathering for the eBPF runtime is disabled
738  *		by default to minimize the corresponding performance overhead.
739  *		This command enables statistics globally.
740  *
741  *		Multiple programs may independently enable statistics.
742  *		After gathering the desired statistics, eBPF runtime statistics
743  *		may be disabled again by calling **close**\ (2) for the file
744  *		descriptor returned by this function. Statistics will only be
745  *		disabled system-wide when all outstanding file descriptors
746  *		returned by prior calls for this subcommand are closed.
747  *
748  *	Return
749  *		A new file descriptor (a nonnegative integer), or -1 if an
750  *		error occurred (in which case, *errno* is set appropriately).
751  *
752  * BPF_ITER_CREATE
753  *	Description
754  *		Create an iterator on top of the specified *link_fd* (as
755  *		previously created using **BPF_LINK_CREATE**) and return a
756  *		file descriptor that can be used to trigger the iteration.
757  *
758  *		If the resulting file descriptor is pinned to the filesystem
759  *		using  **BPF_OBJ_PIN**, then subsequent **read**\ (2) syscalls
760  *		for that path will trigger the iterator to read kernel state
761  *		using the eBPF program attached to *link_fd*.
762  *
763  *	Return
764  *		A new file descriptor (a nonnegative integer), or -1 if an
765  *		error occurred (in which case, *errno* is set appropriately).
766  *
767  * BPF_LINK_DETACH
768  *	Description
769  *		Forcefully detach the specified *link_fd* from its
770  *		corresponding attachment point.
771  *
772  *	Return
773  *		Returns zero on success. On error, -1 is returned and *errno*
774  *		is set appropriately.
775  *
776  * BPF_PROG_BIND_MAP
777  *	Description
778  *		Bind a map to the lifetime of an eBPF program.
779  *
780  *		The map identified by *map_fd* is bound to the program
781  *		identified by *prog_fd* and only released when *prog_fd* is
782  *		released. This may be used in cases where metadata should be
783  *		associated with a program which otherwise does not contain any
784  *		references to the map (for example, embedded in the eBPF
785  *		program instructions).
786  *
787  *	Return
788  *		Returns zero on success. On error, -1 is returned and *errno*
789  *		is set appropriately.
790  *
791  * NOTES
792  *	eBPF objects (maps and programs) can be shared between processes.
793  *
794  *	* After **fork**\ (2), the child inherits file descriptors
795  *	  referring to the same eBPF objects.
796  *	* File descriptors referring to eBPF objects can be transferred over
797  *	  **unix**\ (7) domain sockets.
798  *	* File descriptors referring to eBPF objects can be duplicated in the
799  *	  usual way, using **dup**\ (2) and similar calls.
800  *	* File descriptors referring to eBPF objects can be pinned to the
801  *	  filesystem using the **BPF_OBJ_PIN** command of **bpf**\ (2).
802  *
803  *	An eBPF object is deallocated only after all file descriptors referring
804  *	to the object have been closed and no references remain pinned to the
805  *	filesystem or attached (for example, bound to a program or device).
806  */
807 enum bpf_cmd {
808 	BPF_MAP_CREATE,
809 	BPF_MAP_LOOKUP_ELEM,
810 	BPF_MAP_UPDATE_ELEM,
811 	BPF_MAP_DELETE_ELEM,
812 	BPF_MAP_GET_NEXT_KEY,
813 	BPF_PROG_LOAD,
814 	BPF_OBJ_PIN,
815 	BPF_OBJ_GET,
816 	BPF_PROG_ATTACH,
817 	BPF_PROG_DETACH,
818 	BPF_PROG_TEST_RUN,
819 	BPF_PROG_GET_NEXT_ID,
820 	BPF_MAP_GET_NEXT_ID,
821 	BPF_PROG_GET_FD_BY_ID,
822 	BPF_MAP_GET_FD_BY_ID,
823 	BPF_OBJ_GET_INFO_BY_FD,
824 	BPF_PROG_QUERY,
825 	BPF_RAW_TRACEPOINT_OPEN,
826 	BPF_BTF_LOAD,
827 	BPF_BTF_GET_FD_BY_ID,
828 	BPF_TASK_FD_QUERY,
829 	BPF_MAP_LOOKUP_AND_DELETE_ELEM,
830 	BPF_MAP_FREEZE,
831 	BPF_BTF_GET_NEXT_ID,
832 	BPF_MAP_LOOKUP_BATCH,
833 	BPF_MAP_LOOKUP_AND_DELETE_BATCH,
834 	BPF_MAP_UPDATE_BATCH,
835 	BPF_MAP_DELETE_BATCH,
836 	BPF_LINK_CREATE,
837 	BPF_LINK_UPDATE,
838 	BPF_LINK_GET_FD_BY_ID,
839 	BPF_LINK_GET_NEXT_ID,
840 	BPF_ENABLE_STATS,
841 	BPF_ITER_CREATE,
842 	BPF_LINK_DETACH,
843 	BPF_PROG_BIND_MAP,
844 };
845 
846 enum bpf_map_type {
847 	BPF_MAP_TYPE_UNSPEC,
848 	BPF_MAP_TYPE_HASH,
849 	BPF_MAP_TYPE_ARRAY,
850 	BPF_MAP_TYPE_PROG_ARRAY,
851 	BPF_MAP_TYPE_PERF_EVENT_ARRAY,
852 	BPF_MAP_TYPE_PERCPU_HASH,
853 	BPF_MAP_TYPE_PERCPU_ARRAY,
854 	BPF_MAP_TYPE_STACK_TRACE,
855 	BPF_MAP_TYPE_CGROUP_ARRAY,
856 	BPF_MAP_TYPE_LRU_HASH,
857 	BPF_MAP_TYPE_LRU_PERCPU_HASH,
858 	BPF_MAP_TYPE_LPM_TRIE,
859 	BPF_MAP_TYPE_ARRAY_OF_MAPS,
860 	BPF_MAP_TYPE_HASH_OF_MAPS,
861 	BPF_MAP_TYPE_DEVMAP,
862 	BPF_MAP_TYPE_SOCKMAP,
863 	BPF_MAP_TYPE_CPUMAP,
864 	BPF_MAP_TYPE_XSKMAP,
865 	BPF_MAP_TYPE_SOCKHASH,
866 	BPF_MAP_TYPE_CGROUP_STORAGE,
867 	BPF_MAP_TYPE_REUSEPORT_SOCKARRAY,
868 	BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE,
869 	BPF_MAP_TYPE_QUEUE,
870 	BPF_MAP_TYPE_STACK,
871 	BPF_MAP_TYPE_SK_STORAGE,
872 	BPF_MAP_TYPE_DEVMAP_HASH,
873 	BPF_MAP_TYPE_STRUCT_OPS,
874 	BPF_MAP_TYPE_RINGBUF,
875 	BPF_MAP_TYPE_INODE_STORAGE,
876 	BPF_MAP_TYPE_TASK_STORAGE,
877 };
878 
879 /* Note that tracing related programs such as
880  * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT}
881  * are not subject to a stable API since kernel internal data
882  * structures can change from release to release and may
883  * therefore break existing tracing BPF programs. Tracing BPF
884  * programs correspond to /a/ specific kernel which is to be
885  * analyzed, and not /a/ specific kernel /and/ all future ones.
886  */
887 enum bpf_prog_type {
888 	BPF_PROG_TYPE_UNSPEC,
889 	BPF_PROG_TYPE_SOCKET_FILTER,
890 	BPF_PROG_TYPE_KPROBE,
891 	BPF_PROG_TYPE_SCHED_CLS,
892 	BPF_PROG_TYPE_SCHED_ACT,
893 	BPF_PROG_TYPE_TRACEPOINT,
894 	BPF_PROG_TYPE_XDP,
895 	BPF_PROG_TYPE_PERF_EVENT,
896 	BPF_PROG_TYPE_CGROUP_SKB,
897 	BPF_PROG_TYPE_CGROUP_SOCK,
898 	BPF_PROG_TYPE_LWT_IN,
899 	BPF_PROG_TYPE_LWT_OUT,
900 	BPF_PROG_TYPE_LWT_XMIT,
901 	BPF_PROG_TYPE_SOCK_OPS,
902 	BPF_PROG_TYPE_SK_SKB,
903 	BPF_PROG_TYPE_CGROUP_DEVICE,
904 	BPF_PROG_TYPE_SK_MSG,
905 	BPF_PROG_TYPE_RAW_TRACEPOINT,
906 	BPF_PROG_TYPE_CGROUP_SOCK_ADDR,
907 	BPF_PROG_TYPE_LWT_SEG6LOCAL,
908 	BPF_PROG_TYPE_LIRC_MODE2,
909 	BPF_PROG_TYPE_SK_REUSEPORT,
910 	BPF_PROG_TYPE_FLOW_DISSECTOR,
911 	BPF_PROG_TYPE_CGROUP_SYSCTL,
912 	BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE,
913 	BPF_PROG_TYPE_CGROUP_SOCKOPT,
914 	BPF_PROG_TYPE_TRACING,
915 	BPF_PROG_TYPE_STRUCT_OPS,
916 	BPF_PROG_TYPE_EXT,
917 	BPF_PROG_TYPE_LSM,
918 	BPF_PROG_TYPE_SK_LOOKUP,
919 };
920 
921 enum bpf_attach_type {
922 	BPF_CGROUP_INET_INGRESS,
923 	BPF_CGROUP_INET_EGRESS,
924 	BPF_CGROUP_INET_SOCK_CREATE,
925 	BPF_CGROUP_SOCK_OPS,
926 	BPF_SK_SKB_STREAM_PARSER,
927 	BPF_SK_SKB_STREAM_VERDICT,
928 	BPF_CGROUP_DEVICE,
929 	BPF_SK_MSG_VERDICT,
930 	BPF_CGROUP_INET4_BIND,
931 	BPF_CGROUP_INET6_BIND,
932 	BPF_CGROUP_INET4_CONNECT,
933 	BPF_CGROUP_INET6_CONNECT,
934 	BPF_CGROUP_INET4_POST_BIND,
935 	BPF_CGROUP_INET6_POST_BIND,
936 	BPF_CGROUP_UDP4_SENDMSG,
937 	BPF_CGROUP_UDP6_SENDMSG,
938 	BPF_LIRC_MODE2,
939 	BPF_FLOW_DISSECTOR,
940 	BPF_CGROUP_SYSCTL,
941 	BPF_CGROUP_UDP4_RECVMSG,
942 	BPF_CGROUP_UDP6_RECVMSG,
943 	BPF_CGROUP_GETSOCKOPT,
944 	BPF_CGROUP_SETSOCKOPT,
945 	BPF_TRACE_RAW_TP,
946 	BPF_TRACE_FENTRY,
947 	BPF_TRACE_FEXIT,
948 	BPF_MODIFY_RETURN,
949 	BPF_LSM_MAC,
950 	BPF_TRACE_ITER,
951 	BPF_CGROUP_INET4_GETPEERNAME,
952 	BPF_CGROUP_INET6_GETPEERNAME,
953 	BPF_CGROUP_INET4_GETSOCKNAME,
954 	BPF_CGROUP_INET6_GETSOCKNAME,
955 	BPF_XDP_DEVMAP,
956 	BPF_CGROUP_INET_SOCK_RELEASE,
957 	BPF_XDP_CPUMAP,
958 	BPF_SK_LOOKUP,
959 	BPF_XDP,
960 	__MAX_BPF_ATTACH_TYPE
961 };
962 
963 #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
964 
965 enum bpf_link_type {
966 	BPF_LINK_TYPE_UNSPEC = 0,
967 	BPF_LINK_TYPE_RAW_TRACEPOINT = 1,
968 	BPF_LINK_TYPE_TRACING = 2,
969 	BPF_LINK_TYPE_CGROUP = 3,
970 	BPF_LINK_TYPE_ITER = 4,
971 	BPF_LINK_TYPE_NETNS = 5,
972 	BPF_LINK_TYPE_XDP = 6,
973 
974 	MAX_BPF_LINK_TYPE,
975 };
976 
977 /* cgroup-bpf attach flags used in BPF_PROG_ATTACH command
978  *
979  * NONE(default): No further bpf programs allowed in the subtree.
980  *
981  * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program,
982  * the program in this cgroup yields to sub-cgroup program.
983  *
984  * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program,
985  * that cgroup program gets run in addition to the program in this cgroup.
986  *
987  * Only one program is allowed to be attached to a cgroup with
988  * NONE or BPF_F_ALLOW_OVERRIDE flag.
989  * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will
990  * release old program and attach the new one. Attach flags has to match.
991  *
992  * Multiple programs are allowed to be attached to a cgroup with
993  * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order
994  * (those that were attached first, run first)
995  * The programs of sub-cgroup are executed first, then programs of
996  * this cgroup and then programs of parent cgroup.
997  * When children program makes decision (like picking TCP CA or sock bind)
998  * parent program has a chance to override it.
999  *
1000  * With BPF_F_ALLOW_MULTI a new program is added to the end of the list of
1001  * programs for a cgroup. Though it's possible to replace an old program at
1002  * any position by also specifying BPF_F_REPLACE flag and position itself in
1003  * replace_bpf_fd attribute. Old program at this position will be released.
1004  *
1005  * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups.
1006  * A cgroup with NONE doesn't allow any programs in sub-cgroups.
1007  * Ex1:
1008  * cgrp1 (MULTI progs A, B) ->
1009  *    cgrp2 (OVERRIDE prog C) ->
1010  *      cgrp3 (MULTI prog D) ->
1011  *        cgrp4 (OVERRIDE prog E) ->
1012  *          cgrp5 (NONE prog F)
1013  * the event in cgrp5 triggers execution of F,D,A,B in that order.
1014  * if prog F is detached, the execution is E,D,A,B
1015  * if prog F and D are detached, the execution is E,A,B
1016  * if prog F, E and D are detached, the execution is C,A,B
1017  *
1018  * All eligible programs are executed regardless of return code from
1019  * earlier programs.
1020  */
1021 #define BPF_F_ALLOW_OVERRIDE	(1U << 0)
1022 #define BPF_F_ALLOW_MULTI	(1U << 1)
1023 #define BPF_F_REPLACE		(1U << 2)
1024 
1025 /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
1026  * verifier will perform strict alignment checking as if the kernel
1027  * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
1028  * and NET_IP_ALIGN defined to 2.
1029  */
1030 #define BPF_F_STRICT_ALIGNMENT	(1U << 0)
1031 
1032 /* If BPF_F_ANY_ALIGNMENT is used in BPF_PROF_LOAD command, the
1033  * verifier will allow any alignment whatsoever.  On platforms
1034  * with strict alignment requirements for loads ands stores (such
1035  * as sparc and mips) the verifier validates that all loads and
1036  * stores provably follow this requirement.  This flag turns that
1037  * checking and enforcement off.
1038  *
1039  * It is mostly used for testing when we want to validate the
1040  * context and memory access aspects of the verifier, but because
1041  * of an unaligned access the alignment check would trigger before
1042  * the one we are interested in.
1043  */
1044 #define BPF_F_ANY_ALIGNMENT	(1U << 1)
1045 
1046 /* BPF_F_TEST_RND_HI32 is used in BPF_PROG_LOAD command for testing purpose.
1047  * Verifier does sub-register def/use analysis and identifies instructions whose
1048  * def only matters for low 32-bit, high 32-bit is never referenced later
1049  * through implicit zero extension. Therefore verifier notifies JIT back-ends
1050  * that it is safe to ignore clearing high 32-bit for these instructions. This
1051  * saves some back-ends a lot of code-gen. However such optimization is not
1052  * necessary on some arches, for example x86_64, arm64 etc, whose JIT back-ends
1053  * hence hasn't used verifier's analysis result. But, we really want to have a
1054  * way to be able to verify the correctness of the described optimization on
1055  * x86_64 on which testsuites are frequently exercised.
1056  *
1057  * So, this flag is introduced. Once it is set, verifier will randomize high
1058  * 32-bit for those instructions who has been identified as safe to ignore them.
1059  * Then, if verifier is not doing correct analysis, such randomization will
1060  * regress tests to expose bugs.
1061  */
1062 #define BPF_F_TEST_RND_HI32	(1U << 2)
1063 
1064 /* The verifier internal test flag. Behavior is undefined */
1065 #define BPF_F_TEST_STATE_FREQ	(1U << 3)
1066 
1067 /* If BPF_F_SLEEPABLE is used in BPF_PROG_LOAD command, the verifier will
1068  * restrict map and helper usage for such programs. Sleepable BPF programs can
1069  * only be attached to hooks where kernel execution context allows sleeping.
1070  * Such programs are allowed to use helpers that may sleep like
1071  * bpf_copy_from_user().
1072  */
1073 #define BPF_F_SLEEPABLE		(1U << 4)
1074 
1075 /* When BPF ldimm64's insn[0].src_reg != 0 then this can have
1076  * the following extensions:
1077  *
1078  * insn[0].src_reg:  BPF_PSEUDO_MAP_FD
1079  * insn[0].imm:      map fd
1080  * insn[1].imm:      0
1081  * insn[0].off:      0
1082  * insn[1].off:      0
1083  * ldimm64 rewrite:  address of map
1084  * verifier type:    CONST_PTR_TO_MAP
1085  */
1086 #define BPF_PSEUDO_MAP_FD	1
1087 /* insn[0].src_reg:  BPF_PSEUDO_MAP_VALUE
1088  * insn[0].imm:      map fd
1089  * insn[1].imm:      offset into value
1090  * insn[0].off:      0
1091  * insn[1].off:      0
1092  * ldimm64 rewrite:  address of map[0]+offset
1093  * verifier type:    PTR_TO_MAP_VALUE
1094  */
1095 #define BPF_PSEUDO_MAP_VALUE	2
1096 /* insn[0].src_reg:  BPF_PSEUDO_BTF_ID
1097  * insn[0].imm:      kernel btd id of VAR
1098  * insn[1].imm:      0
1099  * insn[0].off:      0
1100  * insn[1].off:      0
1101  * ldimm64 rewrite:  address of the kernel variable
1102  * verifier type:    PTR_TO_BTF_ID or PTR_TO_MEM, depending on whether the var
1103  *                   is struct/union.
1104  */
1105 #define BPF_PSEUDO_BTF_ID	3
1106 /* insn[0].src_reg:  BPF_PSEUDO_FUNC
1107  * insn[0].imm:      insn offset to the func
1108  * insn[1].imm:      0
1109  * insn[0].off:      0
1110  * insn[1].off:      0
1111  * ldimm64 rewrite:  address of the function
1112  * verifier type:    PTR_TO_FUNC.
1113  */
1114 #define BPF_PSEUDO_FUNC		4
1115 
1116 /* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative
1117  * offset to another bpf function
1118  */
1119 #define BPF_PSEUDO_CALL		1
1120 
1121 /* flags for BPF_MAP_UPDATE_ELEM command */
1122 enum {
1123 	BPF_ANY		= 0, /* create new element or update existing */
1124 	BPF_NOEXIST	= 1, /* create new element if it didn't exist */
1125 	BPF_EXIST	= 2, /* update existing element */
1126 	BPF_F_LOCK	= 4, /* spin_lock-ed map_lookup/map_update */
1127 };
1128 
1129 /* flags for BPF_MAP_CREATE command */
1130 enum {
1131 	BPF_F_NO_PREALLOC	= (1U << 0),
1132 /* Instead of having one common LRU list in the
1133  * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
1134  * which can scale and perform better.
1135  * Note, the LRU nodes (including free nodes) cannot be moved
1136  * across different LRU lists.
1137  */
1138 	BPF_F_NO_COMMON_LRU	= (1U << 1),
1139 /* Specify numa node during map creation */
1140 	BPF_F_NUMA_NODE		= (1U << 2),
1141 
1142 /* Flags for accessing BPF object from syscall side. */
1143 	BPF_F_RDONLY		= (1U << 3),
1144 	BPF_F_WRONLY		= (1U << 4),
1145 
1146 /* Flag for stack_map, store build_id+offset instead of pointer */
1147 	BPF_F_STACK_BUILD_ID	= (1U << 5),
1148 
1149 /* Zero-initialize hash function seed. This should only be used for testing. */
1150 	BPF_F_ZERO_SEED		= (1U << 6),
1151 
1152 /* Flags for accessing BPF object from program side. */
1153 	BPF_F_RDONLY_PROG	= (1U << 7),
1154 	BPF_F_WRONLY_PROG	= (1U << 8),
1155 
1156 /* Clone map from listener for newly accepted socket */
1157 	BPF_F_CLONE		= (1U << 9),
1158 
1159 /* Enable memory-mapping BPF map */
1160 	BPF_F_MMAPABLE		= (1U << 10),
1161 
1162 /* Share perf_event among processes */
1163 	BPF_F_PRESERVE_ELEMS	= (1U << 11),
1164 
1165 /* Create a map that is suitable to be an inner map with dynamic max entries */
1166 	BPF_F_INNER_MAP		= (1U << 12),
1167 };
1168 
1169 /* Flags for BPF_PROG_QUERY. */
1170 
1171 /* Query effective (directly attached + inherited from ancestor cgroups)
1172  * programs that will be executed for events within a cgroup.
1173  * attach_flags with this flag are returned only for directly attached programs.
1174  */
1175 #define BPF_F_QUERY_EFFECTIVE	(1U << 0)
1176 
1177 /* Flags for BPF_PROG_TEST_RUN */
1178 
1179 /* If set, run the test on the cpu specified by bpf_attr.test.cpu */
1180 #define BPF_F_TEST_RUN_ON_CPU	(1U << 0)
1181 
1182 /* type for BPF_ENABLE_STATS */
1183 enum bpf_stats_type {
1184 	/* enabled run_time_ns and run_cnt */
1185 	BPF_STATS_RUN_TIME = 0,
1186 };
1187 
1188 enum bpf_stack_build_id_status {
1189 	/* user space need an empty entry to identify end of a trace */
1190 	BPF_STACK_BUILD_ID_EMPTY = 0,
1191 	/* with valid build_id and offset */
1192 	BPF_STACK_BUILD_ID_VALID = 1,
1193 	/* couldn't get build_id, fallback to ip */
1194 	BPF_STACK_BUILD_ID_IP = 2,
1195 };
1196 
1197 #define BPF_BUILD_ID_SIZE 20
1198 struct bpf_stack_build_id {
1199 	__s32		status;
1200 	unsigned char	build_id[BPF_BUILD_ID_SIZE];
1201 	union {
1202 		__u64	offset;
1203 		__u64	ip;
1204 	};
1205 };
1206 
1207 #define BPF_OBJ_NAME_LEN 16U
1208 
1209 union bpf_attr {
1210 	struct { /* anonymous struct used by BPF_MAP_CREATE command */
1211 		__u32	map_type;	/* one of enum bpf_map_type */
1212 		__u32	key_size;	/* size of key in bytes */
1213 		__u32	value_size;	/* size of value in bytes */
1214 		__u32	max_entries;	/* max number of entries in a map */
1215 		__u32	map_flags;	/* BPF_MAP_CREATE related
1216 					 * flags defined above.
1217 					 */
1218 		__u32	inner_map_fd;	/* fd pointing to the inner map */
1219 		__u32	numa_node;	/* numa node (effective only if
1220 					 * BPF_F_NUMA_NODE is set).
1221 					 */
1222 		char	map_name[BPF_OBJ_NAME_LEN];
1223 		__u32	map_ifindex;	/* ifindex of netdev to create on */
1224 		__u32	btf_fd;		/* fd pointing to a BTF type data */
1225 		__u32	btf_key_type_id;	/* BTF type_id of the key */
1226 		__u32	btf_value_type_id;	/* BTF type_id of the value */
1227 		__u32	btf_vmlinux_value_type_id;/* BTF type_id of a kernel-
1228 						   * struct stored as the
1229 						   * map value
1230 						   */
1231 	};
1232 
1233 	struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
1234 		__u32		map_fd;
1235 		__aligned_u64	key;
1236 		union {
1237 			__aligned_u64 value;
1238 			__aligned_u64 next_key;
1239 		};
1240 		__u64		flags;
1241 	};
1242 
1243 	struct { /* struct used by BPF_MAP_*_BATCH commands */
1244 		__aligned_u64	in_batch;	/* start batch,
1245 						 * NULL to start from beginning
1246 						 */
1247 		__aligned_u64	out_batch;	/* output: next start batch */
1248 		__aligned_u64	keys;
1249 		__aligned_u64	values;
1250 		__u32		count;		/* input/output:
1251 						 * input: # of key/value
1252 						 * elements
1253 						 * output: # of filled elements
1254 						 */
1255 		__u32		map_fd;
1256 		__u64		elem_flags;
1257 		__u64		flags;
1258 	} batch;
1259 
1260 	struct { /* anonymous struct used by BPF_PROG_LOAD command */
1261 		__u32		prog_type;	/* one of enum bpf_prog_type */
1262 		__u32		insn_cnt;
1263 		__aligned_u64	insns;
1264 		__aligned_u64	license;
1265 		__u32		log_level;	/* verbosity level of verifier */
1266 		__u32		log_size;	/* size of user buffer */
1267 		__aligned_u64	log_buf;	/* user supplied buffer */
1268 		__u32		kern_version;	/* not used */
1269 		__u32		prog_flags;
1270 		char		prog_name[BPF_OBJ_NAME_LEN];
1271 		__u32		prog_ifindex;	/* ifindex of netdev to prep for */
1272 		/* For some prog types expected attach type must be known at
1273 		 * load time to verify attach type specific parts of prog
1274 		 * (context accesses, allowed helpers, etc).
1275 		 */
1276 		__u32		expected_attach_type;
1277 		__u32		prog_btf_fd;	/* fd pointing to BTF type data */
1278 		__u32		func_info_rec_size;	/* userspace bpf_func_info size */
1279 		__aligned_u64	func_info;	/* func info */
1280 		__u32		func_info_cnt;	/* number of bpf_func_info records */
1281 		__u32		line_info_rec_size;	/* userspace bpf_line_info size */
1282 		__aligned_u64	line_info;	/* line info */
1283 		__u32		line_info_cnt;	/* number of bpf_line_info records */
1284 		__u32		attach_btf_id;	/* in-kernel BTF type id to attach to */
1285 		union {
1286 			/* valid prog_fd to attach to bpf prog */
1287 			__u32		attach_prog_fd;
1288 			/* or valid module BTF object fd or 0 to attach to vmlinux */
1289 			__u32		attach_btf_obj_fd;
1290 		};
1291 	};
1292 
1293 	struct { /* anonymous struct used by BPF_OBJ_* commands */
1294 		__aligned_u64	pathname;
1295 		__u32		bpf_fd;
1296 		__u32		file_flags;
1297 	};
1298 
1299 	struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
1300 		__u32		target_fd;	/* container object to attach to */
1301 		__u32		attach_bpf_fd;	/* eBPF program to attach */
1302 		__u32		attach_type;
1303 		__u32		attach_flags;
1304 		__u32		replace_bpf_fd;	/* previously attached eBPF
1305 						 * program to replace if
1306 						 * BPF_F_REPLACE is used
1307 						 */
1308 	};
1309 
1310 	struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
1311 		__u32		prog_fd;
1312 		__u32		retval;
1313 		__u32		data_size_in;	/* input: len of data_in */
1314 		__u32		data_size_out;	/* input/output: len of data_out
1315 						 *   returns ENOSPC if data_out
1316 						 *   is too small.
1317 						 */
1318 		__aligned_u64	data_in;
1319 		__aligned_u64	data_out;
1320 		__u32		repeat;
1321 		__u32		duration;
1322 		__u32		ctx_size_in;	/* input: len of ctx_in */
1323 		__u32		ctx_size_out;	/* input/output: len of ctx_out
1324 						 *   returns ENOSPC if ctx_out
1325 						 *   is too small.
1326 						 */
1327 		__aligned_u64	ctx_in;
1328 		__aligned_u64	ctx_out;
1329 		__u32		flags;
1330 		__u32		cpu;
1331 	} test;
1332 
1333 	struct { /* anonymous struct used by BPF_*_GET_*_ID */
1334 		union {
1335 			__u32		start_id;
1336 			__u32		prog_id;
1337 			__u32		map_id;
1338 			__u32		btf_id;
1339 			__u32		link_id;
1340 		};
1341 		__u32		next_id;
1342 		__u32		open_flags;
1343 	};
1344 
1345 	struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
1346 		__u32		bpf_fd;
1347 		__u32		info_len;
1348 		__aligned_u64	info;
1349 	} info;
1350 
1351 	struct { /* anonymous struct used by BPF_PROG_QUERY command */
1352 		__u32		target_fd;	/* container object to query */
1353 		__u32		attach_type;
1354 		__u32		query_flags;
1355 		__u32		attach_flags;
1356 		__aligned_u64	prog_ids;
1357 		__u32		prog_cnt;
1358 	} query;
1359 
1360 	struct { /* anonymous struct used by BPF_RAW_TRACEPOINT_OPEN command */
1361 		__u64 name;
1362 		__u32 prog_fd;
1363 	} raw_tracepoint;
1364 
1365 	struct { /* anonymous struct for BPF_BTF_LOAD */
1366 		__aligned_u64	btf;
1367 		__aligned_u64	btf_log_buf;
1368 		__u32		btf_size;
1369 		__u32		btf_log_size;
1370 		__u32		btf_log_level;
1371 	};
1372 
1373 	struct {
1374 		__u32		pid;		/* input: pid */
1375 		__u32		fd;		/* input: fd */
1376 		__u32		flags;		/* input: flags */
1377 		__u32		buf_len;	/* input/output: buf len */
1378 		__aligned_u64	buf;		/* input/output:
1379 						 *   tp_name for tracepoint
1380 						 *   symbol for kprobe
1381 						 *   filename for uprobe
1382 						 */
1383 		__u32		prog_id;	/* output: prod_id */
1384 		__u32		fd_type;	/* output: BPF_FD_TYPE_* */
1385 		__u64		probe_offset;	/* output: probe_offset */
1386 		__u64		probe_addr;	/* output: probe_addr */
1387 	} task_fd_query;
1388 
1389 	struct { /* struct used by BPF_LINK_CREATE command */
1390 		__u32		prog_fd;	/* eBPF program to attach */
1391 		union {
1392 			__u32		target_fd;	/* object to attach to */
1393 			__u32		target_ifindex; /* target ifindex */
1394 		};
1395 		__u32		attach_type;	/* attach type */
1396 		__u32		flags;		/* extra flags */
1397 		union {
1398 			__u32		target_btf_id;	/* btf_id of target to attach to */
1399 			struct {
1400 				__aligned_u64	iter_info;	/* extra bpf_iter_link_info */
1401 				__u32		iter_info_len;	/* iter_info length */
1402 			};
1403 		};
1404 	} link_create;
1405 
1406 	struct { /* struct used by BPF_LINK_UPDATE command */
1407 		__u32		link_fd;	/* link fd */
1408 		/* new program fd to update link with */
1409 		__u32		new_prog_fd;
1410 		__u32		flags;		/* extra flags */
1411 		/* expected link's program fd; is specified only if
1412 		 * BPF_F_REPLACE flag is set in flags */
1413 		__u32		old_prog_fd;
1414 	} link_update;
1415 
1416 	struct {
1417 		__u32		link_fd;
1418 	} link_detach;
1419 
1420 	struct { /* struct used by BPF_ENABLE_STATS command */
1421 		__u32		type;
1422 	} enable_stats;
1423 
1424 	struct { /* struct used by BPF_ITER_CREATE command */
1425 		__u32		link_fd;
1426 		__u32		flags;
1427 	} iter_create;
1428 
1429 	struct { /* struct used by BPF_PROG_BIND_MAP command */
1430 		__u32		prog_fd;
1431 		__u32		map_fd;
1432 		__u32		flags;		/* extra flags */
1433 	} prog_bind_map;
1434 
1435 } __attribute__((aligned(8)));
1436 
1437 /* The description below is an attempt at providing documentation to eBPF
1438  * developers about the multiple available eBPF helper functions. It can be
1439  * parsed and used to produce a manual page. The workflow is the following,
1440  * and requires the rst2man utility:
1441  *
1442  *     $ ./scripts/bpf_doc.py \
1443  *             --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst
1444  *     $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7
1445  *     $ man /tmp/bpf-helpers.7
1446  *
1447  * Note that in order to produce this external documentation, some RST
1448  * formatting is used in the descriptions to get "bold" and "italics" in
1449  * manual pages. Also note that the few trailing white spaces are
1450  * intentional, removing them would break paragraphs for rst2man.
1451  *
1452  * Start of BPF helper function descriptions:
1453  *
1454  * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key)
1455  * 	Description
1456  * 		Perform a lookup in *map* for an entry associated to *key*.
1457  * 	Return
1458  * 		Map value associated to *key*, or **NULL** if no entry was
1459  * 		found.
1460  *
1461  * long bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags)
1462  * 	Description
1463  * 		Add or update the value of the entry associated to *key* in
1464  * 		*map* with *value*. *flags* is one of:
1465  *
1466  * 		**BPF_NOEXIST**
1467  * 			The entry for *key* must not exist in the map.
1468  * 		**BPF_EXIST**
1469  * 			The entry for *key* must already exist in the map.
1470  * 		**BPF_ANY**
1471  * 			No condition on the existence of the entry for *key*.
1472  *
1473  * 		Flag value **BPF_NOEXIST** cannot be used for maps of types
1474  * 		**BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY**  (all
1475  * 		elements always exist), the helper would return an error.
1476  * 	Return
1477  * 		0 on success, or a negative error in case of failure.
1478  *
1479  * long bpf_map_delete_elem(struct bpf_map *map, const void *key)
1480  * 	Description
1481  * 		Delete entry with *key* from *map*.
1482  * 	Return
1483  * 		0 on success, or a negative error in case of failure.
1484  *
1485  * long bpf_probe_read(void *dst, u32 size, const void *unsafe_ptr)
1486  * 	Description
1487  * 		For tracing programs, safely attempt to read *size* bytes from
1488  * 		kernel space address *unsafe_ptr* and store the data in *dst*.
1489  *
1490  * 		Generally, use **bpf_probe_read_user**\ () or
1491  * 		**bpf_probe_read_kernel**\ () instead.
1492  * 	Return
1493  * 		0 on success, or a negative error in case of failure.
1494  *
1495  * u64 bpf_ktime_get_ns(void)
1496  * 	Description
1497  * 		Return the time elapsed since system boot, in nanoseconds.
1498  * 		Does not include time the system was suspended.
1499  * 		See: **clock_gettime**\ (**CLOCK_MONOTONIC**)
1500  * 	Return
1501  * 		Current *ktime*.
1502  *
1503  * long bpf_trace_printk(const char *fmt, u32 fmt_size, ...)
1504  * 	Description
1505  * 		This helper is a "printk()-like" facility for debugging. It
1506  * 		prints a message defined by format *fmt* (of size *fmt_size*)
1507  * 		to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if
1508  * 		available. It can take up to three additional **u64**
1509  * 		arguments (as an eBPF helpers, the total number of arguments is
1510  * 		limited to five).
1511  *
1512  * 		Each time the helper is called, it appends a line to the trace.
1513  * 		Lines are discarded while *\/sys/kernel/debug/tracing/trace* is
1514  * 		open, use *\/sys/kernel/debug/tracing/trace_pipe* to avoid this.
1515  * 		The format of the trace is customizable, and the exact output
1516  * 		one will get depends on the options set in
1517  * 		*\/sys/kernel/debug/tracing/trace_options* (see also the
1518  * 		*README* file under the same directory). However, it usually
1519  * 		defaults to something like:
1520  *
1521  * 		::
1522  *
1523  * 			telnet-470   [001] .N.. 419421.045894: 0x00000001: <formatted msg>
1524  *
1525  * 		In the above:
1526  *
1527  * 			* ``telnet`` is the name of the current task.
1528  * 			* ``470`` is the PID of the current task.
1529  * 			* ``001`` is the CPU number on which the task is
1530  * 			  running.
1531  * 			* In ``.N..``, each character refers to a set of
1532  * 			  options (whether irqs are enabled, scheduling
1533  * 			  options, whether hard/softirqs are running, level of
1534  * 			  preempt_disabled respectively). **N** means that
1535  * 			  **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED**
1536  * 			  are set.
1537  * 			* ``419421.045894`` is a timestamp.
1538  * 			* ``0x00000001`` is a fake value used by BPF for the
1539  * 			  instruction pointer register.
1540  * 			* ``<formatted msg>`` is the message formatted with
1541  * 			  *fmt*.
1542  *
1543  * 		The conversion specifiers supported by *fmt* are similar, but
1544  * 		more limited than for printk(). They are **%d**, **%i**,
1545  * 		**%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**,
1546  * 		**%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size
1547  * 		of field, padding with zeroes, etc.) is available, and the
1548  * 		helper will return **-EINVAL** (but print nothing) if it
1549  * 		encounters an unknown specifier.
1550  *
1551  * 		Also, note that **bpf_trace_printk**\ () is slow, and should
1552  * 		only be used for debugging purposes. For this reason, a notice
1553  * 		block (spanning several lines) is printed to kernel logs and
1554  * 		states that the helper should not be used "for production use"
1555  * 		the first time this helper is used (or more precisely, when
1556  * 		**trace_printk**\ () buffers are allocated). For passing values
1557  * 		to user space, perf events should be preferred.
1558  * 	Return
1559  * 		The number of bytes written to the buffer, or a negative error
1560  * 		in case of failure.
1561  *
1562  * u32 bpf_get_prandom_u32(void)
1563  * 	Description
1564  * 		Get a pseudo-random number.
1565  *
1566  * 		From a security point of view, this helper uses its own
1567  * 		pseudo-random internal state, and cannot be used to infer the
1568  * 		seed of other random functions in the kernel. However, it is
1569  * 		essential to note that the generator used by the helper is not
1570  * 		cryptographically secure.
1571  * 	Return
1572  * 		A random 32-bit unsigned value.
1573  *
1574  * u32 bpf_get_smp_processor_id(void)
1575  * 	Description
1576  * 		Get the SMP (symmetric multiprocessing) processor id. Note that
1577  * 		all programs run with preemption disabled, which means that the
1578  * 		SMP processor id is stable during all the execution of the
1579  * 		program.
1580  * 	Return
1581  * 		The SMP id of the processor running the program.
1582  *
1583  * long bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags)
1584  * 	Description
1585  * 		Store *len* bytes from address *from* into the packet
1586  * 		associated to *skb*, at *offset*. *flags* are a combination of
1587  * 		**BPF_F_RECOMPUTE_CSUM** (automatically recompute the
1588  * 		checksum for the packet after storing the bytes) and
1589  * 		**BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
1590  * 		**->swhash** and *skb*\ **->l4hash** to 0).
1591  *
1592  * 		A call to this helper is susceptible to change the underlying
1593  * 		packet buffer. Therefore, at load time, all checks on pointers
1594  * 		previously done by the verifier are invalidated and must be
1595  * 		performed again, if the helper is used in combination with
1596  * 		direct packet access.
1597  * 	Return
1598  * 		0 on success, or a negative error in case of failure.
1599  *
1600  * long bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size)
1601  * 	Description
1602  * 		Recompute the layer 3 (e.g. IP) checksum for the packet
1603  * 		associated to *skb*. Computation is incremental, so the helper
1604  * 		must know the former value of the header field that was
1605  * 		modified (*from*), the new value of this field (*to*), and the
1606  * 		number of bytes (2 or 4) for this field, stored in *size*.
1607  * 		Alternatively, it is possible to store the difference between
1608  * 		the previous and the new values of the header field in *to*, by
1609  * 		setting *from* and *size* to 0. For both methods, *offset*
1610  * 		indicates the location of the IP checksum within the packet.
1611  *
1612  * 		This helper works in combination with **bpf_csum_diff**\ (),
1613  * 		which does not update the checksum in-place, but offers more
1614  * 		flexibility and can handle sizes larger than 2 or 4 for the
1615  * 		checksum to update.
1616  *
1617  * 		A call to this helper is susceptible to change the underlying
1618  * 		packet buffer. Therefore, at load time, all checks on pointers
1619  * 		previously done by the verifier are invalidated and must be
1620  * 		performed again, if the helper is used in combination with
1621  * 		direct packet access.
1622  * 	Return
1623  * 		0 on success, or a negative error in case of failure.
1624  *
1625  * long bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags)
1626  * 	Description
1627  * 		Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the
1628  * 		packet associated to *skb*. Computation is incremental, so the
1629  * 		helper must know the former value of the header field that was
1630  * 		modified (*from*), the new value of this field (*to*), and the
1631  * 		number of bytes (2 or 4) for this field, stored on the lowest
1632  * 		four bits of *flags*. Alternatively, it is possible to store
1633  * 		the difference between the previous and the new values of the
1634  * 		header field in *to*, by setting *from* and the four lowest
1635  * 		bits of *flags* to 0. For both methods, *offset* indicates the
1636  * 		location of the IP checksum within the packet. In addition to
1637  * 		the size of the field, *flags* can be added (bitwise OR) actual
1638  * 		flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left
1639  * 		untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and
1640  * 		for updates resulting in a null checksum the value is set to
1641  * 		**CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates
1642  * 		the checksum is to be computed against a pseudo-header.
1643  *
1644  * 		This helper works in combination with **bpf_csum_diff**\ (),
1645  * 		which does not update the checksum in-place, but offers more
1646  * 		flexibility and can handle sizes larger than 2 or 4 for the
1647  * 		checksum to update.
1648  *
1649  * 		A call to this helper is susceptible to change the underlying
1650  * 		packet buffer. Therefore, at load time, all checks on pointers
1651  * 		previously done by the verifier are invalidated and must be
1652  * 		performed again, if the helper is used in combination with
1653  * 		direct packet access.
1654  * 	Return
1655  * 		0 on success, or a negative error in case of failure.
1656  *
1657  * long bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index)
1658  * 	Description
1659  * 		This special helper is used to trigger a "tail call", or in
1660  * 		other words, to jump into another eBPF program. The same stack
1661  * 		frame is used (but values on stack and in registers for the
1662  * 		caller are not accessible to the callee). This mechanism allows
1663  * 		for program chaining, either for raising the maximum number of
1664  * 		available eBPF instructions, or to execute given programs in
1665  * 		conditional blocks. For security reasons, there is an upper
1666  * 		limit to the number of successive tail calls that can be
1667  * 		performed.
1668  *
1669  * 		Upon call of this helper, the program attempts to jump into a
1670  * 		program referenced at index *index* in *prog_array_map*, a
1671  * 		special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes
1672  * 		*ctx*, a pointer to the context.
1673  *
1674  * 		If the call succeeds, the kernel immediately runs the first
1675  * 		instruction of the new program. This is not a function call,
1676  * 		and it never returns to the previous program. If the call
1677  * 		fails, then the helper has no effect, and the caller continues
1678  * 		to run its subsequent instructions. A call can fail if the
1679  * 		destination program for the jump does not exist (i.e. *index*
1680  * 		is superior to the number of entries in *prog_array_map*), or
1681  * 		if the maximum number of tail calls has been reached for this
1682  * 		chain of programs. This limit is defined in the kernel by the
1683  * 		macro **MAX_TAIL_CALL_CNT** (not accessible to user space),
1684  * 		which is currently set to 32.
1685  * 	Return
1686  * 		0 on success, or a negative error in case of failure.
1687  *
1688  * long bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags)
1689  * 	Description
1690  * 		Clone and redirect the packet associated to *skb* to another
1691  * 		net device of index *ifindex*. Both ingress and egress
1692  * 		interfaces can be used for redirection. The **BPF_F_INGRESS**
1693  * 		value in *flags* is used to make the distinction (ingress path
1694  * 		is selected if the flag is present, egress path otherwise).
1695  * 		This is the only flag supported for now.
1696  *
1697  * 		In comparison with **bpf_redirect**\ () helper,
1698  * 		**bpf_clone_redirect**\ () has the associated cost of
1699  * 		duplicating the packet buffer, but this can be executed out of
1700  * 		the eBPF program. Conversely, **bpf_redirect**\ () is more
1701  * 		efficient, but it is handled through an action code where the
1702  * 		redirection happens only after the eBPF program has returned.
1703  *
1704  * 		A call to this helper is susceptible to change the underlying
1705  * 		packet buffer. Therefore, at load time, all checks on pointers
1706  * 		previously done by the verifier are invalidated and must be
1707  * 		performed again, if the helper is used in combination with
1708  * 		direct packet access.
1709  * 	Return
1710  * 		0 on success, or a negative error in case of failure.
1711  *
1712  * u64 bpf_get_current_pid_tgid(void)
1713  * 	Return
1714  * 		A 64-bit integer containing the current tgid and pid, and
1715  * 		created as such:
1716  * 		*current_task*\ **->tgid << 32 \|**
1717  * 		*current_task*\ **->pid**.
1718  *
1719  * u64 bpf_get_current_uid_gid(void)
1720  * 	Return
1721  * 		A 64-bit integer containing the current GID and UID, and
1722  * 		created as such: *current_gid* **<< 32 \|** *current_uid*.
1723  *
1724  * long bpf_get_current_comm(void *buf, u32 size_of_buf)
1725  * 	Description
1726  * 		Copy the **comm** attribute of the current task into *buf* of
1727  * 		*size_of_buf*. The **comm** attribute contains the name of
1728  * 		the executable (excluding the path) for the current task. The
1729  * 		*size_of_buf* must be strictly positive. On success, the
1730  * 		helper makes sure that the *buf* is NUL-terminated. On failure,
1731  * 		it is filled with zeroes.
1732  * 	Return
1733  * 		0 on success, or a negative error in case of failure.
1734  *
1735  * u32 bpf_get_cgroup_classid(struct sk_buff *skb)
1736  * 	Description
1737  * 		Retrieve the classid for the current task, i.e. for the net_cls
1738  * 		cgroup to which *skb* belongs.
1739  *
1740  * 		This helper can be used on TC egress path, but not on ingress.
1741  *
1742  * 		The net_cls cgroup provides an interface to tag network packets
1743  * 		based on a user-provided identifier for all traffic coming from
1744  * 		the tasks belonging to the related cgroup. See also the related
1745  * 		kernel documentation, available from the Linux sources in file
1746  * 		*Documentation/admin-guide/cgroup-v1/net_cls.rst*.
1747  *
1748  * 		The Linux kernel has two versions for cgroups: there are
1749  * 		cgroups v1 and cgroups v2. Both are available to users, who can
1750  * 		use a mixture of them, but note that the net_cls cgroup is for
1751  * 		cgroup v1 only. This makes it incompatible with BPF programs
1752  * 		run on cgroups, which is a cgroup-v2-only feature (a socket can
1753  * 		only hold data for one version of cgroups at a time).
1754  *
1755  * 		This helper is only available is the kernel was compiled with
1756  * 		the **CONFIG_CGROUP_NET_CLASSID** configuration option set to
1757  * 		"**y**" or to "**m**".
1758  * 	Return
1759  * 		The classid, or 0 for the default unconfigured classid.
1760  *
1761  * long bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci)
1762  * 	Description
1763  * 		Push a *vlan_tci* (VLAN tag control information) of protocol
1764  * 		*vlan_proto* to the packet associated to *skb*, then update
1765  * 		the checksum. Note that if *vlan_proto* is different from
1766  * 		**ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
1767  * 		be **ETH_P_8021Q**.
1768  *
1769  * 		A call to this helper is susceptible to change the underlying
1770  * 		packet buffer. Therefore, at load time, all checks on pointers
1771  * 		previously done by the verifier are invalidated and must be
1772  * 		performed again, if the helper is used in combination with
1773  * 		direct packet access.
1774  * 	Return
1775  * 		0 on success, or a negative error in case of failure.
1776  *
1777  * long bpf_skb_vlan_pop(struct sk_buff *skb)
1778  * 	Description
1779  * 		Pop a VLAN header from the packet associated to *skb*.
1780  *
1781  * 		A call to this helper is susceptible to change the underlying
1782  * 		packet buffer. Therefore, at load time, all checks on pointers
1783  * 		previously done by the verifier are invalidated and must be
1784  * 		performed again, if the helper is used in combination with
1785  * 		direct packet access.
1786  * 	Return
1787  * 		0 on success, or a negative error in case of failure.
1788  *
1789  * long bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
1790  * 	Description
1791  * 		Get tunnel metadata. This helper takes a pointer *key* to an
1792  * 		empty **struct bpf_tunnel_key** of **size**, that will be
1793  * 		filled with tunnel metadata for the packet associated to *skb*.
1794  * 		The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which
1795  * 		indicates that the tunnel is based on IPv6 protocol instead of
1796  * 		IPv4.
1797  *
1798  * 		The **struct bpf_tunnel_key** is an object that generalizes the
1799  * 		principal parameters used by various tunneling protocols into a
1800  * 		single struct. This way, it can be used to easily make a
1801  * 		decision based on the contents of the encapsulation header,
1802  * 		"summarized" in this struct. In particular, it holds the IP
1803  * 		address of the remote end (IPv4 or IPv6, depending on the case)
1804  * 		in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also,
1805  * 		this struct exposes the *key*\ **->tunnel_id**, which is
1806  * 		generally mapped to a VNI (Virtual Network Identifier), making
1807  * 		it programmable together with the **bpf_skb_set_tunnel_key**\
1808  * 		() helper.
1809  *
1810  * 		Let's imagine that the following code is part of a program
1811  * 		attached to the TC ingress interface, on one end of a GRE
1812  * 		tunnel, and is supposed to filter out all messages coming from
1813  * 		remote ends with IPv4 address other than 10.0.0.1:
1814  *
1815  * 		::
1816  *
1817  * 			int ret;
1818  * 			struct bpf_tunnel_key key = {};
1819  *
1820  * 			ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0);
1821  * 			if (ret < 0)
1822  * 				return TC_ACT_SHOT;	// drop packet
1823  *
1824  * 			if (key.remote_ipv4 != 0x0a000001)
1825  * 				return TC_ACT_SHOT;	// drop packet
1826  *
1827  * 			return TC_ACT_OK;		// accept packet
1828  *
1829  * 		This interface can also be used with all encapsulation devices
1830  * 		that can operate in "collect metadata" mode: instead of having
1831  * 		one network device per specific configuration, the "collect
1832  * 		metadata" mode only requires a single device where the
1833  * 		configuration can be extracted from this helper.
1834  *
1835  * 		This can be used together with various tunnels such as VXLan,
1836  * 		Geneve, GRE or IP in IP (IPIP).
1837  * 	Return
1838  * 		0 on success, or a negative error in case of failure.
1839  *
1840  * long bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
1841  * 	Description
1842  * 		Populate tunnel metadata for packet associated to *skb.* The
1843  * 		tunnel metadata is set to the contents of *key*, of *size*. The
1844  * 		*flags* can be set to a combination of the following values:
1845  *
1846  * 		**BPF_F_TUNINFO_IPV6**
1847  * 			Indicate that the tunnel is based on IPv6 protocol
1848  * 			instead of IPv4.
1849  * 		**BPF_F_ZERO_CSUM_TX**
1850  * 			For IPv4 packets, add a flag to tunnel metadata
1851  * 			indicating that checksum computation should be skipped
1852  * 			and checksum set to zeroes.
1853  * 		**BPF_F_DONT_FRAGMENT**
1854  * 			Add a flag to tunnel metadata indicating that the
1855  * 			packet should not be fragmented.
1856  * 		**BPF_F_SEQ_NUMBER**
1857  * 			Add a flag to tunnel metadata indicating that a
1858  * 			sequence number should be added to tunnel header before
1859  * 			sending the packet. This flag was added for GRE
1860  * 			encapsulation, but might be used with other protocols
1861  * 			as well in the future.
1862  *
1863  * 		Here is a typical usage on the transmit path:
1864  *
1865  * 		::
1866  *
1867  * 			struct bpf_tunnel_key key;
1868  * 			     populate key ...
1869  * 			bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0);
1870  * 			bpf_clone_redirect(skb, vxlan_dev_ifindex, 0);
1871  *
1872  * 		See also the description of the **bpf_skb_get_tunnel_key**\ ()
1873  * 		helper for additional information.
1874  * 	Return
1875  * 		0 on success, or a negative error in case of failure.
1876  *
1877  * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags)
1878  * 	Description
1879  * 		Read the value of a perf event counter. This helper relies on a
1880  * 		*map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of
1881  * 		the perf event counter is selected when *map* is updated with
1882  * 		perf event file descriptors. The *map* is an array whose size
1883  * 		is the number of available CPUs, and each cell contains a value
1884  * 		relative to one CPU. The value to retrieve is indicated by
1885  * 		*flags*, that contains the index of the CPU to look up, masked
1886  * 		with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
1887  * 		**BPF_F_CURRENT_CPU** to indicate that the value for the
1888  * 		current CPU should be retrieved.
1889  *
1890  * 		Note that before Linux 4.13, only hardware perf event can be
1891  * 		retrieved.
1892  *
1893  * 		Also, be aware that the newer helper
1894  * 		**bpf_perf_event_read_value**\ () is recommended over
1895  * 		**bpf_perf_event_read**\ () in general. The latter has some ABI
1896  * 		quirks where error and counter value are used as a return code
1897  * 		(which is wrong to do since ranges may overlap). This issue is
1898  * 		fixed with **bpf_perf_event_read_value**\ (), which at the same
1899  * 		time provides more features over the **bpf_perf_event_read**\
1900  * 		() interface. Please refer to the description of
1901  * 		**bpf_perf_event_read_value**\ () for details.
1902  * 	Return
1903  * 		The value of the perf event counter read from the map, or a
1904  * 		negative error code in case of failure.
1905  *
1906  * long bpf_redirect(u32 ifindex, u64 flags)
1907  * 	Description
1908  * 		Redirect the packet to another net device of index *ifindex*.
1909  * 		This helper is somewhat similar to **bpf_clone_redirect**\
1910  * 		(), except that the packet is not cloned, which provides
1911  * 		increased performance.
1912  *
1913  * 		Except for XDP, both ingress and egress interfaces can be used
1914  * 		for redirection. The **BPF_F_INGRESS** value in *flags* is used
1915  * 		to make the distinction (ingress path is selected if the flag
1916  * 		is present, egress path otherwise). Currently, XDP only
1917  * 		supports redirection to the egress interface, and accepts no
1918  * 		flag at all.
1919  *
1920  * 		The same effect can also be attained with the more generic
1921  * 		**bpf_redirect_map**\ (), which uses a BPF map to store the
1922  * 		redirect target instead of providing it directly to the helper.
1923  * 	Return
1924  * 		For XDP, the helper returns **XDP_REDIRECT** on success or
1925  * 		**XDP_ABORTED** on error. For other program types, the values
1926  * 		are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on
1927  * 		error.
1928  *
1929  * u32 bpf_get_route_realm(struct sk_buff *skb)
1930  * 	Description
1931  * 		Retrieve the realm or the route, that is to say the
1932  * 		**tclassid** field of the destination for the *skb*. The
1933  * 		identifier retrieved is a user-provided tag, similar to the
1934  * 		one used with the net_cls cgroup (see description for
1935  * 		**bpf_get_cgroup_classid**\ () helper), but here this tag is
1936  * 		held by a route (a destination entry), not by a task.
1937  *
1938  * 		Retrieving this identifier works with the clsact TC egress hook
1939  * 		(see also **tc-bpf(8)**), or alternatively on conventional
1940  * 		classful egress qdiscs, but not on TC ingress path. In case of
1941  * 		clsact TC egress hook, this has the advantage that, internally,
1942  * 		the destination entry has not been dropped yet in the transmit
1943  * 		path. Therefore, the destination entry does not need to be
1944  * 		artificially held via **netif_keep_dst**\ () for a classful
1945  * 		qdisc until the *skb* is freed.
1946  *
1947  * 		This helper is available only if the kernel was compiled with
1948  * 		**CONFIG_IP_ROUTE_CLASSID** configuration option.
1949  * 	Return
1950  * 		The realm of the route for the packet associated to *skb*, or 0
1951  * 		if none was found.
1952  *
1953  * long bpf_perf_event_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
1954  * 	Description
1955  * 		Write raw *data* blob into a special BPF perf event held by
1956  * 		*map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
1957  * 		event must have the following attributes: **PERF_SAMPLE_RAW**
1958  * 		as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
1959  * 		**PERF_COUNT_SW_BPF_OUTPUT** as **config**.
1960  *
1961  * 		The *flags* are used to indicate the index in *map* for which
1962  * 		the value must be put, masked with **BPF_F_INDEX_MASK**.
1963  * 		Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
1964  * 		to indicate that the index of the current CPU core should be
1965  * 		used.
1966  *
1967  * 		The value to write, of *size*, is passed through eBPF stack and
1968  * 		pointed by *data*.
1969  *
1970  * 		The context of the program *ctx* needs also be passed to the
1971  * 		helper.
1972  *
1973  * 		On user space, a program willing to read the values needs to
1974  * 		call **perf_event_open**\ () on the perf event (either for
1975  * 		one or for all CPUs) and to store the file descriptor into the
1976  * 		*map*. This must be done before the eBPF program can send data
1977  * 		into it. An example is available in file
1978  * 		*samples/bpf/trace_output_user.c* in the Linux kernel source
1979  * 		tree (the eBPF program counterpart is in
1980  * 		*samples/bpf/trace_output_kern.c*).
1981  *
1982  * 		**bpf_perf_event_output**\ () achieves better performance
1983  * 		than **bpf_trace_printk**\ () for sharing data with user
1984  * 		space, and is much better suitable for streaming data from eBPF
1985  * 		programs.
1986  *
1987  * 		Note that this helper is not restricted to tracing use cases
1988  * 		and can be used with programs attached to TC or XDP as well,
1989  * 		where it allows for passing data to user space listeners. Data
1990  * 		can be:
1991  *
1992  * 		* Only custom structs,
1993  * 		* Only the packet payload, or
1994  * 		* A combination of both.
1995  * 	Return
1996  * 		0 on success, or a negative error in case of failure.
1997  *
1998  * long bpf_skb_load_bytes(const void *skb, u32 offset, void *to, u32 len)
1999  * 	Description
2000  * 		This helper was provided as an easy way to load data from a
2001  * 		packet. It can be used to load *len* bytes from *offset* from
2002  * 		the packet associated to *skb*, into the buffer pointed by
2003  * 		*to*.
2004  *
2005  * 		Since Linux 4.7, usage of this helper has mostly been replaced
2006  * 		by "direct packet access", enabling packet data to be
2007  * 		manipulated with *skb*\ **->data** and *skb*\ **->data_end**
2008  * 		pointing respectively to the first byte of packet data and to
2009  * 		the byte after the last byte of packet data. However, it
2010  * 		remains useful if one wishes to read large quantities of data
2011  * 		at once from a packet into the eBPF stack.
2012  * 	Return
2013  * 		0 on success, or a negative error in case of failure.
2014  *
2015  * long bpf_get_stackid(void *ctx, struct bpf_map *map, u64 flags)
2016  * 	Description
2017  * 		Walk a user or a kernel stack and return its id. To achieve
2018  * 		this, the helper needs *ctx*, which is a pointer to the context
2019  * 		on which the tracing program is executed, and a pointer to a
2020  * 		*map* of type **BPF_MAP_TYPE_STACK_TRACE**.
2021  *
2022  * 		The last argument, *flags*, holds the number of stack frames to
2023  * 		skip (from 0 to 255), masked with
2024  * 		**BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
2025  * 		a combination of the following flags:
2026  *
2027  * 		**BPF_F_USER_STACK**
2028  * 			Collect a user space stack instead of a kernel stack.
2029  * 		**BPF_F_FAST_STACK_CMP**
2030  * 			Compare stacks by hash only.
2031  * 		**BPF_F_REUSE_STACKID**
2032  * 			If two different stacks hash into the same *stackid*,
2033  * 			discard the old one.
2034  *
2035  * 		The stack id retrieved is a 32 bit long integer handle which
2036  * 		can be further combined with other data (including other stack
2037  * 		ids) and used as a key into maps. This can be useful for
2038  * 		generating a variety of graphs (such as flame graphs or off-cpu
2039  * 		graphs).
2040  *
2041  * 		For walking a stack, this helper is an improvement over
2042  * 		**bpf_probe_read**\ (), which can be used with unrolled loops
2043  * 		but is not efficient and consumes a lot of eBPF instructions.
2044  * 		Instead, **bpf_get_stackid**\ () can collect up to
2045  * 		**PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that
2046  * 		this limit can be controlled with the **sysctl** program, and
2047  * 		that it should be manually increased in order to profile long
2048  * 		user stacks (such as stacks for Java programs). To do so, use:
2049  *
2050  * 		::
2051  *
2052  * 			# sysctl kernel.perf_event_max_stack=<new value>
2053  * 	Return
2054  * 		The positive or null stack id on success, or a negative error
2055  * 		in case of failure.
2056  *
2057  * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed)
2058  * 	Description
2059  * 		Compute a checksum difference, from the raw buffer pointed by
2060  * 		*from*, of length *from_size* (that must be a multiple of 4),
2061  * 		towards the raw buffer pointed by *to*, of size *to_size*
2062  * 		(same remark). An optional *seed* can be added to the value
2063  * 		(this can be cascaded, the seed may come from a previous call
2064  * 		to the helper).
2065  *
2066  * 		This is flexible enough to be used in several ways:
2067  *
2068  * 		* With *from_size* == 0, *to_size* > 0 and *seed* set to
2069  * 		  checksum, it can be used when pushing new data.
2070  * 		* With *from_size* > 0, *to_size* == 0 and *seed* set to
2071  * 		  checksum, it can be used when removing data from a packet.
2072  * 		* With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it
2073  * 		  can be used to compute a diff. Note that *from_size* and
2074  * 		  *to_size* do not need to be equal.
2075  *
2076  * 		This helper can be used in combination with
2077  * 		**bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to
2078  * 		which one can feed in the difference computed with
2079  * 		**bpf_csum_diff**\ ().
2080  * 	Return
2081  * 		The checksum result, or a negative error code in case of
2082  * 		failure.
2083  *
2084  * long bpf_skb_get_tunnel_opt(struct sk_buff *skb, void *opt, u32 size)
2085  * 	Description
2086  * 		Retrieve tunnel options metadata for the packet associated to
2087  * 		*skb*, and store the raw tunnel option data to the buffer *opt*
2088  * 		of *size*.
2089  *
2090  * 		This helper can be used with encapsulation devices that can
2091  * 		operate in "collect metadata" mode (please refer to the related
2092  * 		note in the description of **bpf_skb_get_tunnel_key**\ () for
2093  * 		more details). A particular example where this can be used is
2094  * 		in combination with the Geneve encapsulation protocol, where it
2095  * 		allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper)
2096  * 		and retrieving arbitrary TLVs (Type-Length-Value headers) from
2097  * 		the eBPF program. This allows for full customization of these
2098  * 		headers.
2099  * 	Return
2100  * 		The size of the option data retrieved.
2101  *
2102  * long bpf_skb_set_tunnel_opt(struct sk_buff *skb, void *opt, u32 size)
2103  * 	Description
2104  * 		Set tunnel options metadata for the packet associated to *skb*
2105  * 		to the option data contained in the raw buffer *opt* of *size*.
2106  *
2107  * 		See also the description of the **bpf_skb_get_tunnel_opt**\ ()
2108  * 		helper for additional information.
2109  * 	Return
2110  * 		0 on success, or a negative error in case of failure.
2111  *
2112  * long bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags)
2113  * 	Description
2114  * 		Change the protocol of the *skb* to *proto*. Currently
2115  * 		supported are transition from IPv4 to IPv6, and from IPv6 to
2116  * 		IPv4. The helper takes care of the groundwork for the
2117  * 		transition, including resizing the socket buffer. The eBPF
2118  * 		program is expected to fill the new headers, if any, via
2119  * 		**skb_store_bytes**\ () and to recompute the checksums with
2120  * 		**bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\
2121  * 		(). The main case for this helper is to perform NAT64
2122  * 		operations out of an eBPF program.
2123  *
2124  * 		Internally, the GSO type is marked as dodgy so that headers are
2125  * 		checked and segments are recalculated by the GSO/GRO engine.
2126  * 		The size for GSO target is adapted as well.
2127  *
2128  * 		All values for *flags* are reserved for future usage, and must
2129  * 		be left at zero.
2130  *
2131  * 		A call to this helper is susceptible to change the underlying
2132  * 		packet buffer. Therefore, at load time, all checks on pointers
2133  * 		previously done by the verifier are invalidated and must be
2134  * 		performed again, if the helper is used in combination with
2135  * 		direct packet access.
2136  * 	Return
2137  * 		0 on success, or a negative error in case of failure.
2138  *
2139  * long bpf_skb_change_type(struct sk_buff *skb, u32 type)
2140  * 	Description
2141  * 		Change the packet type for the packet associated to *skb*. This
2142  * 		comes down to setting *skb*\ **->pkt_type** to *type*, except
2143  * 		the eBPF program does not have a write access to *skb*\
2144  * 		**->pkt_type** beside this helper. Using a helper here allows
2145  * 		for graceful handling of errors.
2146  *
2147  * 		The major use case is to change incoming *skb*s to
2148  * 		**PACKET_HOST** in a programmatic way instead of having to
2149  * 		recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for
2150  * 		example.
2151  *
2152  * 		Note that *type* only allows certain values. At this time, they
2153  * 		are:
2154  *
2155  * 		**PACKET_HOST**
2156  * 			Packet is for us.
2157  * 		**PACKET_BROADCAST**
2158  * 			Send packet to all.
2159  * 		**PACKET_MULTICAST**
2160  * 			Send packet to group.
2161  * 		**PACKET_OTHERHOST**
2162  * 			Send packet to someone else.
2163  * 	Return
2164  * 		0 on success, or a negative error in case of failure.
2165  *
2166  * long bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index)
2167  * 	Description
2168  * 		Check whether *skb* is a descendant of the cgroup2 held by
2169  * 		*map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
2170  * 	Return
2171  * 		The return value depends on the result of the test, and can be:
2172  *
2173  * 		* 0, if the *skb* failed the cgroup2 descendant test.
2174  * 		* 1, if the *skb* succeeded the cgroup2 descendant test.
2175  * 		* A negative error code, if an error occurred.
2176  *
2177  * u32 bpf_get_hash_recalc(struct sk_buff *skb)
2178  * 	Description
2179  * 		Retrieve the hash of the packet, *skb*\ **->hash**. If it is
2180  * 		not set, in particular if the hash was cleared due to mangling,
2181  * 		recompute this hash. Later accesses to the hash can be done
2182  * 		directly with *skb*\ **->hash**.
2183  *
2184  * 		Calling **bpf_set_hash_invalid**\ (), changing a packet
2185  * 		prototype with **bpf_skb_change_proto**\ (), or calling
2186  * 		**bpf_skb_store_bytes**\ () with the
2187  * 		**BPF_F_INVALIDATE_HASH** are actions susceptible to clear
2188  * 		the hash and to trigger a new computation for the next call to
2189  * 		**bpf_get_hash_recalc**\ ().
2190  * 	Return
2191  * 		The 32-bit hash.
2192  *
2193  * u64 bpf_get_current_task(void)
2194  * 	Return
2195  * 		A pointer to the current task struct.
2196  *
2197  * long bpf_probe_write_user(void *dst, const void *src, u32 len)
2198  * 	Description
2199  * 		Attempt in a safe way to write *len* bytes from the buffer
2200  * 		*src* to *dst* in memory. It only works for threads that are in
2201  * 		user context, and *dst* must be a valid user space address.
2202  *
2203  * 		This helper should not be used to implement any kind of
2204  * 		security mechanism because of TOC-TOU attacks, but rather to
2205  * 		debug, divert, and manipulate execution of semi-cooperative
2206  * 		processes.
2207  *
2208  * 		Keep in mind that this feature is meant for experiments, and it
2209  * 		has a risk of crashing the system and running programs.
2210  * 		Therefore, when an eBPF program using this helper is attached,
2211  * 		a warning including PID and process name is printed to kernel
2212  * 		logs.
2213  * 	Return
2214  * 		0 on success, or a negative error in case of failure.
2215  *
2216  * long bpf_current_task_under_cgroup(struct bpf_map *map, u32 index)
2217  * 	Description
2218  * 		Check whether the probe is being run is the context of a given
2219  * 		subset of the cgroup2 hierarchy. The cgroup2 to test is held by
2220  * 		*map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
2221  * 	Return
2222  * 		The return value depends on the result of the test, and can be:
2223  *
2224  *		* 0, if current task belongs to the cgroup2.
2225  *		* 1, if current task does not belong to the cgroup2.
2226  * 		* A negative error code, if an error occurred.
2227  *
2228  * long bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags)
2229  * 	Description
2230  * 		Resize (trim or grow) the packet associated to *skb* to the
2231  * 		new *len*. The *flags* are reserved for future usage, and must
2232  * 		be left at zero.
2233  *
2234  * 		The basic idea is that the helper performs the needed work to
2235  * 		change the size of the packet, then the eBPF program rewrites
2236  * 		the rest via helpers like **bpf_skb_store_bytes**\ (),
2237  * 		**bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ ()
2238  * 		and others. This helper is a slow path utility intended for
2239  * 		replies with control messages. And because it is targeted for
2240  * 		slow path, the helper itself can afford to be slow: it
2241  * 		implicitly linearizes, unclones and drops offloads from the
2242  * 		*skb*.
2243  *
2244  * 		A call to this helper is susceptible to change the underlying
2245  * 		packet buffer. Therefore, at load time, all checks on pointers
2246  * 		previously done by the verifier are invalidated and must be
2247  * 		performed again, if the helper is used in combination with
2248  * 		direct packet access.
2249  * 	Return
2250  * 		0 on success, or a negative error in case of failure.
2251  *
2252  * long bpf_skb_pull_data(struct sk_buff *skb, u32 len)
2253  * 	Description
2254  * 		Pull in non-linear data in case the *skb* is non-linear and not
2255  * 		all of *len* are part of the linear section. Make *len* bytes
2256  * 		from *skb* readable and writable. If a zero value is passed for
2257  * 		*len*, then the whole length of the *skb* is pulled.
2258  *
2259  * 		This helper is only needed for reading and writing with direct
2260  * 		packet access.
2261  *
2262  * 		For direct packet access, testing that offsets to access
2263  * 		are within packet boundaries (test on *skb*\ **->data_end**) is
2264  * 		susceptible to fail if offsets are invalid, or if the requested
2265  * 		data is in non-linear parts of the *skb*. On failure the
2266  * 		program can just bail out, or in the case of a non-linear
2267  * 		buffer, use a helper to make the data available. The
2268  * 		**bpf_skb_load_bytes**\ () helper is a first solution to access
2269  * 		the data. Another one consists in using **bpf_skb_pull_data**
2270  * 		to pull in once the non-linear parts, then retesting and
2271  * 		eventually access the data.
2272  *
2273  * 		At the same time, this also makes sure the *skb* is uncloned,
2274  * 		which is a necessary condition for direct write. As this needs
2275  * 		to be an invariant for the write part only, the verifier
2276  * 		detects writes and adds a prologue that is calling
2277  * 		**bpf_skb_pull_data()** to effectively unclone the *skb* from
2278  * 		the very beginning in case it is indeed cloned.
2279  *
2280  * 		A call to this helper is susceptible to change the underlying
2281  * 		packet buffer. Therefore, at load time, all checks on pointers
2282  * 		previously done by the verifier are invalidated and must be
2283  * 		performed again, if the helper is used in combination with
2284  * 		direct packet access.
2285  * 	Return
2286  * 		0 on success, or a negative error in case of failure.
2287  *
2288  * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum)
2289  * 	Description
2290  * 		Add the checksum *csum* into *skb*\ **->csum** in case the
2291  * 		driver has supplied a checksum for the entire packet into that
2292  * 		field. Return an error otherwise. This helper is intended to be
2293  * 		used in combination with **bpf_csum_diff**\ (), in particular
2294  * 		when the checksum needs to be updated after data has been
2295  * 		written into the packet through direct packet access.
2296  * 	Return
2297  * 		The checksum on success, or a negative error code in case of
2298  * 		failure.
2299  *
2300  * void bpf_set_hash_invalid(struct sk_buff *skb)
2301  * 	Description
2302  * 		Invalidate the current *skb*\ **->hash**. It can be used after
2303  * 		mangling on headers through direct packet access, in order to
2304  * 		indicate that the hash is outdated and to trigger a
2305  * 		recalculation the next time the kernel tries to access this
2306  * 		hash or when the **bpf_get_hash_recalc**\ () helper is called.
2307  *
2308  * long bpf_get_numa_node_id(void)
2309  * 	Description
2310  * 		Return the id of the current NUMA node. The primary use case
2311  * 		for this helper is the selection of sockets for the local NUMA
2312  * 		node, when the program is attached to sockets using the
2313  * 		**SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**),
2314  * 		but the helper is also available to other eBPF program types,
2315  * 		similarly to **bpf_get_smp_processor_id**\ ().
2316  * 	Return
2317  * 		The id of current NUMA node.
2318  *
2319  * long bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags)
2320  * 	Description
2321  * 		Grows headroom of packet associated to *skb* and adjusts the
2322  * 		offset of the MAC header accordingly, adding *len* bytes of
2323  * 		space. It automatically extends and reallocates memory as
2324  * 		required.
2325  *
2326  * 		This helper can be used on a layer 3 *skb* to push a MAC header
2327  * 		for redirection into a layer 2 device.
2328  *
2329  * 		All values for *flags* are reserved for future usage, and must
2330  * 		be left at zero.
2331  *
2332  * 		A call to this helper is susceptible to change the underlying
2333  * 		packet buffer. Therefore, at load time, all checks on pointers
2334  * 		previously done by the verifier are invalidated and must be
2335  * 		performed again, if the helper is used in combination with
2336  * 		direct packet access.
2337  * 	Return
2338  * 		0 on success, or a negative error in case of failure.
2339  *
2340  * long bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta)
2341  * 	Description
2342  * 		Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that
2343  * 		it is possible to use a negative value for *delta*. This helper
2344  * 		can be used to prepare the packet for pushing or popping
2345  * 		headers.
2346  *
2347  * 		A call to this helper is susceptible to change the underlying
2348  * 		packet buffer. Therefore, at load time, all checks on pointers
2349  * 		previously done by the verifier are invalidated and must be
2350  * 		performed again, if the helper is used in combination with
2351  * 		direct packet access.
2352  * 	Return
2353  * 		0 on success, or a negative error in case of failure.
2354  *
2355  * long bpf_probe_read_str(void *dst, u32 size, const void *unsafe_ptr)
2356  * 	Description
2357  * 		Copy a NUL terminated string from an unsafe kernel address
2358  * 		*unsafe_ptr* to *dst*. See **bpf_probe_read_kernel_str**\ () for
2359  * 		more details.
2360  *
2361  * 		Generally, use **bpf_probe_read_user_str**\ () or
2362  * 		**bpf_probe_read_kernel_str**\ () instead.
2363  * 	Return
2364  * 		On success, the strictly positive length of the string,
2365  * 		including the trailing NUL character. On error, a negative
2366  * 		value.
2367  *
2368  * u64 bpf_get_socket_cookie(struct sk_buff *skb)
2369  * 	Description
2370  * 		If the **struct sk_buff** pointed by *skb* has a known socket,
2371  * 		retrieve the cookie (generated by the kernel) of this socket.
2372  * 		If no cookie has been set yet, generate a new cookie. Once
2373  * 		generated, the socket cookie remains stable for the life of the
2374  * 		socket. This helper can be useful for monitoring per socket
2375  * 		networking traffic statistics as it provides a global socket
2376  * 		identifier that can be assumed unique.
2377  * 	Return
2378  * 		A 8-byte long unique number on success, or 0 if the socket
2379  * 		field is missing inside *skb*.
2380  *
2381  * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx)
2382  * 	Description
2383  * 		Equivalent to bpf_get_socket_cookie() helper that accepts
2384  * 		*skb*, but gets socket from **struct bpf_sock_addr** context.
2385  * 	Return
2386  * 		A 8-byte long unique number.
2387  *
2388  * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx)
2389  * 	Description
2390  * 		Equivalent to **bpf_get_socket_cookie**\ () helper that accepts
2391  * 		*skb*, but gets socket from **struct bpf_sock_ops** context.
2392  * 	Return
2393  * 		A 8-byte long unique number.
2394  *
2395  * u64 bpf_get_socket_cookie(struct sock *sk)
2396  * 	Description
2397  * 		Equivalent to **bpf_get_socket_cookie**\ () helper that accepts
2398  * 		*sk*, but gets socket from a BTF **struct sock**. This helper
2399  * 		also works for sleepable programs.
2400  * 	Return
2401  * 		A 8-byte long unique number or 0 if *sk* is NULL.
2402  *
2403  * u32 bpf_get_socket_uid(struct sk_buff *skb)
2404  * 	Return
2405  * 		The owner UID of the socket associated to *skb*. If the socket
2406  * 		is **NULL**, or if it is not a full socket (i.e. if it is a
2407  * 		time-wait or a request socket instead), **overflowuid** value
2408  * 		is returned (note that **overflowuid** might also be the actual
2409  * 		UID value for the socket).
2410  *
2411  * long bpf_set_hash(struct sk_buff *skb, u32 hash)
2412  * 	Description
2413  * 		Set the full hash for *skb* (set the field *skb*\ **->hash**)
2414  * 		to value *hash*.
2415  * 	Return
2416  * 		0
2417  *
2418  * long bpf_setsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen)
2419  * 	Description
2420  * 		Emulate a call to **setsockopt()** on the socket associated to
2421  * 		*bpf_socket*, which must be a full socket. The *level* at
2422  * 		which the option resides and the name *optname* of the option
2423  * 		must be specified, see **setsockopt(2)** for more information.
2424  * 		The option value of length *optlen* is pointed by *optval*.
2425  *
2426  * 		*bpf_socket* should be one of the following:
2427  *
2428  * 		* **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**.
2429  * 		* **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT**
2430  * 		  and **BPF_CGROUP_INET6_CONNECT**.
2431  *
2432  * 		This helper actually implements a subset of **setsockopt()**.
2433  * 		It supports the following *level*\ s:
2434  *
2435  * 		* **SOL_SOCKET**, which supports the following *optname*\ s:
2436  * 		  **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,
2437  * 		  **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**,
2438  * 		  **SO_BINDTODEVICE**, **SO_KEEPALIVE**.
2439  * 		* **IPPROTO_TCP**, which supports the following *optname*\ s:
2440  * 		  **TCP_CONGESTION**, **TCP_BPF_IW**,
2441  * 		  **TCP_BPF_SNDCWND_CLAMP**, **TCP_SAVE_SYN**,
2442  * 		  **TCP_KEEPIDLE**, **TCP_KEEPINTVL**, **TCP_KEEPCNT**,
2443  *		  **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**.
2444  * 		* **IPPROTO_IP**, which supports *optname* **IP_TOS**.
2445  * 		* **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
2446  * 	Return
2447  * 		0 on success, or a negative error in case of failure.
2448  *
2449  * long bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags)
2450  * 	Description
2451  * 		Grow or shrink the room for data in the packet associated to
2452  * 		*skb* by *len_diff*, and according to the selected *mode*.
2453  *
2454  * 		By default, the helper will reset any offloaded checksum
2455  * 		indicator of the skb to CHECKSUM_NONE. This can be avoided
2456  * 		by the following flag:
2457  *
2458  * 		* **BPF_F_ADJ_ROOM_NO_CSUM_RESET**: Do not reset offloaded
2459  * 		  checksum data of the skb to CHECKSUM_NONE.
2460  *
2461  *		There are two supported modes at this time:
2462  *
2463  *		* **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer
2464  *		  (room space is added or removed below the layer 2 header).
2465  *
2466  * 		* **BPF_ADJ_ROOM_NET**: Adjust room at the network layer
2467  * 		  (room space is added or removed below the layer 3 header).
2468  *
2469  *		The following flags are supported at this time:
2470  *
2471  *		* **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size.
2472  *		  Adjusting mss in this way is not allowed for datagrams.
2473  *
2474  *		* **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4**,
2475  *		  **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6**:
2476  *		  Any new space is reserved to hold a tunnel header.
2477  *		  Configure skb offsets and other fields accordingly.
2478  *
2479  *		* **BPF_F_ADJ_ROOM_ENCAP_L4_GRE**,
2480  *		  **BPF_F_ADJ_ROOM_ENCAP_L4_UDP**:
2481  *		  Use with ENCAP_L3 flags to further specify the tunnel type.
2482  *
2483  *		* **BPF_F_ADJ_ROOM_ENCAP_L2**\ (*len*):
2484  *		  Use with ENCAP_L3/L4 flags to further specify the tunnel
2485  *		  type; *len* is the length of the inner MAC header.
2486  *
2487  * 		A call to this helper is susceptible to change the underlying
2488  * 		packet buffer. Therefore, at load time, all checks on pointers
2489  * 		previously done by the verifier are invalidated and must be
2490  * 		performed again, if the helper is used in combination with
2491  * 		direct packet access.
2492  * 	Return
2493  * 		0 on success, or a negative error in case of failure.
2494  *
2495  * long bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
2496  * 	Description
2497  * 		Redirect the packet to the endpoint referenced by *map* at
2498  * 		index *key*. Depending on its type, this *map* can contain
2499  * 		references to net devices (for forwarding packets through other
2500  * 		ports), or to CPUs (for redirecting XDP frames to another CPU;
2501  * 		but this is only implemented for native XDP (with driver
2502  * 		support) as of this writing).
2503  *
2504  * 		The lower two bits of *flags* are used as the return code if
2505  * 		the map lookup fails. This is so that the return value can be
2506  * 		one of the XDP program return codes up to **XDP_TX**, as chosen
2507  * 		by the caller. Any higher bits in the *flags* argument must be
2508  * 		unset.
2509  *
2510  * 		See also **bpf_redirect**\ (), which only supports redirecting
2511  * 		to an ifindex, but doesn't require a map to do so.
2512  * 	Return
2513  * 		**XDP_REDIRECT** on success, or the value of the two lower bits
2514  * 		of the *flags* argument on error.
2515  *
2516  * long bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
2517  * 	Description
2518  * 		Redirect the packet to the socket referenced by *map* (of type
2519  * 		**BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
2520  * 		egress interfaces can be used for redirection. The
2521  * 		**BPF_F_INGRESS** value in *flags* is used to make the
2522  * 		distinction (ingress path is selected if the flag is present,
2523  * 		egress path otherwise). This is the only flag supported for now.
2524  * 	Return
2525  * 		**SK_PASS** on success, or **SK_DROP** on error.
2526  *
2527  * long bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
2528  * 	Description
2529  * 		Add an entry to, or update a *map* referencing sockets. The
2530  * 		*skops* is used as a new value for the entry associated to
2531  * 		*key*. *flags* is one of:
2532  *
2533  * 		**BPF_NOEXIST**
2534  * 			The entry for *key* must not exist in the map.
2535  * 		**BPF_EXIST**
2536  * 			The entry for *key* must already exist in the map.
2537  * 		**BPF_ANY**
2538  * 			No condition on the existence of the entry for *key*.
2539  *
2540  * 		If the *map* has eBPF programs (parser and verdict), those will
2541  * 		be inherited by the socket being added. If the socket is
2542  * 		already attached to eBPF programs, this results in an error.
2543  * 	Return
2544  * 		0 on success, or a negative error in case of failure.
2545  *
2546  * long bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta)
2547  * 	Description
2548  * 		Adjust the address pointed by *xdp_md*\ **->data_meta** by
2549  * 		*delta* (which can be positive or negative). Note that this
2550  * 		operation modifies the address stored in *xdp_md*\ **->data**,
2551  * 		so the latter must be loaded only after the helper has been
2552  * 		called.
2553  *
2554  * 		The use of *xdp_md*\ **->data_meta** is optional and programs
2555  * 		are not required to use it. The rationale is that when the
2556  * 		packet is processed with XDP (e.g. as DoS filter), it is
2557  * 		possible to push further meta data along with it before passing
2558  * 		to the stack, and to give the guarantee that an ingress eBPF
2559  * 		program attached as a TC classifier on the same device can pick
2560  * 		this up for further post-processing. Since TC works with socket
2561  * 		buffers, it remains possible to set from XDP the **mark** or
2562  * 		**priority** pointers, or other pointers for the socket buffer.
2563  * 		Having this scratch space generic and programmable allows for
2564  * 		more flexibility as the user is free to store whatever meta
2565  * 		data they need.
2566  *
2567  * 		A call to this helper is susceptible to change the underlying
2568  * 		packet buffer. Therefore, at load time, all checks on pointers
2569  * 		previously done by the verifier are invalidated and must be
2570  * 		performed again, if the helper is used in combination with
2571  * 		direct packet access.
2572  * 	Return
2573  * 		0 on success, or a negative error in case of failure.
2574  *
2575  * long bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size)
2576  * 	Description
2577  * 		Read the value of a perf event counter, and store it into *buf*
2578  * 		of size *buf_size*. This helper relies on a *map* of type
2579  * 		**BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event
2580  * 		counter is selected when *map* is updated with perf event file
2581  * 		descriptors. The *map* is an array whose size is the number of
2582  * 		available CPUs, and each cell contains a value relative to one
2583  * 		CPU. The value to retrieve is indicated by *flags*, that
2584  * 		contains the index of the CPU to look up, masked with
2585  * 		**BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
2586  * 		**BPF_F_CURRENT_CPU** to indicate that the value for the
2587  * 		current CPU should be retrieved.
2588  *
2589  * 		This helper behaves in a way close to
2590  * 		**bpf_perf_event_read**\ () helper, save that instead of
2591  * 		just returning the value observed, it fills the *buf*
2592  * 		structure. This allows for additional data to be retrieved: in
2593  * 		particular, the enabled and running times (in *buf*\
2594  * 		**->enabled** and *buf*\ **->running**, respectively) are
2595  * 		copied. In general, **bpf_perf_event_read_value**\ () is
2596  * 		recommended over **bpf_perf_event_read**\ (), which has some
2597  * 		ABI issues and provides fewer functionalities.
2598  *
2599  * 		These values are interesting, because hardware PMU (Performance
2600  * 		Monitoring Unit) counters are limited resources. When there are
2601  * 		more PMU based perf events opened than available counters,
2602  * 		kernel will multiplex these events so each event gets certain
2603  * 		percentage (but not all) of the PMU time. In case that
2604  * 		multiplexing happens, the number of samples or counter value
2605  * 		will not reflect the case compared to when no multiplexing
2606  * 		occurs. This makes comparison between different runs difficult.
2607  * 		Typically, the counter value should be normalized before
2608  * 		comparing to other experiments. The usual normalization is done
2609  * 		as follows.
2610  *
2611  * 		::
2612  *
2613  * 			normalized_counter = counter * t_enabled / t_running
2614  *
2615  * 		Where t_enabled is the time enabled for event and t_running is
2616  * 		the time running for event since last normalization. The
2617  * 		enabled and running times are accumulated since the perf event
2618  * 		open. To achieve scaling factor between two invocations of an
2619  * 		eBPF program, users can use CPU id as the key (which is
2620  * 		typical for perf array usage model) to remember the previous
2621  * 		value and do the calculation inside the eBPF program.
2622  * 	Return
2623  * 		0 on success, or a negative error in case of failure.
2624  *
2625  * long bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size)
2626  * 	Description
2627  * 		For en eBPF program attached to a perf event, retrieve the
2628  * 		value of the event counter associated to *ctx* and store it in
2629  * 		the structure pointed by *buf* and of size *buf_size*. Enabled
2630  * 		and running times are also stored in the structure (see
2631  * 		description of helper **bpf_perf_event_read_value**\ () for
2632  * 		more details).
2633  * 	Return
2634  * 		0 on success, or a negative error in case of failure.
2635  *
2636  * long bpf_getsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen)
2637  * 	Description
2638  * 		Emulate a call to **getsockopt()** on the socket associated to
2639  * 		*bpf_socket*, which must be a full socket. The *level* at
2640  * 		which the option resides and the name *optname* of the option
2641  * 		must be specified, see **getsockopt(2)** for more information.
2642  * 		The retrieved value is stored in the structure pointed by
2643  * 		*opval* and of length *optlen*.
2644  *
2645  * 		*bpf_socket* should be one of the following:
2646  *
2647  * 		* **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**.
2648  * 		* **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT**
2649  * 		  and **BPF_CGROUP_INET6_CONNECT**.
2650  *
2651  * 		This helper actually implements a subset of **getsockopt()**.
2652  * 		It supports the following *level*\ s:
2653  *
2654  * 		* **IPPROTO_TCP**, which supports *optname*
2655  * 		  **TCP_CONGESTION**.
2656  * 		* **IPPROTO_IP**, which supports *optname* **IP_TOS**.
2657  * 		* **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
2658  * 	Return
2659  * 		0 on success, or a negative error in case of failure.
2660  *
2661  * long bpf_override_return(struct pt_regs *regs, u64 rc)
2662  * 	Description
2663  * 		Used for error injection, this helper uses kprobes to override
2664  * 		the return value of the probed function, and to set it to *rc*.
2665  * 		The first argument is the context *regs* on which the kprobe
2666  * 		works.
2667  *
2668  * 		This helper works by setting the PC (program counter)
2669  * 		to an override function which is run in place of the original
2670  * 		probed function. This means the probed function is not run at
2671  * 		all. The replacement function just returns with the required
2672  * 		value.
2673  *
2674  * 		This helper has security implications, and thus is subject to
2675  * 		restrictions. It is only available if the kernel was compiled
2676  * 		with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration
2677  * 		option, and in this case it only works on functions tagged with
2678  * 		**ALLOW_ERROR_INJECTION** in the kernel code.
2679  *
2680  * 		Also, the helper is only available for the architectures having
2681  * 		the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing,
2682  * 		x86 architecture is the only one to support this feature.
2683  * 	Return
2684  * 		0
2685  *
2686  * long bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval)
2687  * 	Description
2688  * 		Attempt to set the value of the **bpf_sock_ops_cb_flags** field
2689  * 		for the full TCP socket associated to *bpf_sock_ops* to
2690  * 		*argval*.
2691  *
2692  * 		The primary use of this field is to determine if there should
2693  * 		be calls to eBPF programs of type
2694  * 		**BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP
2695  * 		code. A program of the same type can change its value, per
2696  * 		connection and as necessary, when the connection is
2697  * 		established. This field is directly accessible for reading, but
2698  * 		this helper must be used for updates in order to return an
2699  * 		error if an eBPF program tries to set a callback that is not
2700  * 		supported in the current kernel.
2701  *
2702  * 		*argval* is a flag array which can combine these flags:
2703  *
2704  * 		* **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out)
2705  * 		* **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission)
2706  * 		* **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change)
2707  * 		* **BPF_SOCK_OPS_RTT_CB_FLAG** (every RTT)
2708  *
2709  * 		Therefore, this function can be used to clear a callback flag by
2710  * 		setting the appropriate bit to zero. e.g. to disable the RTO
2711  * 		callback:
2712  *
2713  * 		**bpf_sock_ops_cb_flags_set(bpf_sock,**
2714  * 			**bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)**
2715  *
2716  * 		Here are some examples of where one could call such eBPF
2717  * 		program:
2718  *
2719  * 		* When RTO fires.
2720  * 		* When a packet is retransmitted.
2721  * 		* When the connection terminates.
2722  * 		* When a packet is sent.
2723  * 		* When a packet is received.
2724  * 	Return
2725  * 		Code **-EINVAL** if the socket is not a full TCP socket;
2726  * 		otherwise, a positive number containing the bits that could not
2727  * 		be set is returned (which comes down to 0 if all bits were set
2728  * 		as required).
2729  *
2730  * long bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags)
2731  * 	Description
2732  * 		This helper is used in programs implementing policies at the
2733  * 		socket level. If the message *msg* is allowed to pass (i.e. if
2734  * 		the verdict eBPF program returns **SK_PASS**), redirect it to
2735  * 		the socket referenced by *map* (of type
2736  * 		**BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
2737  * 		egress interfaces can be used for redirection. The
2738  * 		**BPF_F_INGRESS** value in *flags* is used to make the
2739  * 		distinction (ingress path is selected if the flag is present,
2740  * 		egress path otherwise). This is the only flag supported for now.
2741  * 	Return
2742  * 		**SK_PASS** on success, or **SK_DROP** on error.
2743  *
2744  * long bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes)
2745  * 	Description
2746  * 		For socket policies, apply the verdict of the eBPF program to
2747  * 		the next *bytes* (number of bytes) of message *msg*.
2748  *
2749  * 		For example, this helper can be used in the following cases:
2750  *
2751  * 		* A single **sendmsg**\ () or **sendfile**\ () system call
2752  * 		  contains multiple logical messages that the eBPF program is
2753  * 		  supposed to read and for which it should apply a verdict.
2754  * 		* An eBPF program only cares to read the first *bytes* of a
2755  * 		  *msg*. If the message has a large payload, then setting up
2756  * 		  and calling the eBPF program repeatedly for all bytes, even
2757  * 		  though the verdict is already known, would create unnecessary
2758  * 		  overhead.
2759  *
2760  * 		When called from within an eBPF program, the helper sets a
2761  * 		counter internal to the BPF infrastructure, that is used to
2762  * 		apply the last verdict to the next *bytes*. If *bytes* is
2763  * 		smaller than the current data being processed from a
2764  * 		**sendmsg**\ () or **sendfile**\ () system call, the first
2765  * 		*bytes* will be sent and the eBPF program will be re-run with
2766  * 		the pointer for start of data pointing to byte number *bytes*
2767  * 		**+ 1**. If *bytes* is larger than the current data being
2768  * 		processed, then the eBPF verdict will be applied to multiple
2769  * 		**sendmsg**\ () or **sendfile**\ () calls until *bytes* are
2770  * 		consumed.
2771  *
2772  * 		Note that if a socket closes with the internal counter holding
2773  * 		a non-zero value, this is not a problem because data is not
2774  * 		being buffered for *bytes* and is sent as it is received.
2775  * 	Return
2776  * 		0
2777  *
2778  * long bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes)
2779  * 	Description
2780  * 		For socket policies, prevent the execution of the verdict eBPF
2781  * 		program for message *msg* until *bytes* (byte number) have been
2782  * 		accumulated.
2783  *
2784  * 		This can be used when one needs a specific number of bytes
2785  * 		before a verdict can be assigned, even if the data spans
2786  * 		multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme
2787  * 		case would be a user calling **sendmsg**\ () repeatedly with
2788  * 		1-byte long message segments. Obviously, this is bad for
2789  * 		performance, but it is still valid. If the eBPF program needs
2790  * 		*bytes* bytes to validate a header, this helper can be used to
2791  * 		prevent the eBPF program to be called again until *bytes* have
2792  * 		been accumulated.
2793  * 	Return
2794  * 		0
2795  *
2796  * long bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags)
2797  * 	Description
2798  * 		For socket policies, pull in non-linear data from user space
2799  * 		for *msg* and set pointers *msg*\ **->data** and *msg*\
2800  * 		**->data_end** to *start* and *end* bytes offsets into *msg*,
2801  * 		respectively.
2802  *
2803  * 		If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
2804  * 		*msg* it can only parse data that the (**data**, **data_end**)
2805  * 		pointers have already consumed. For **sendmsg**\ () hooks this
2806  * 		is likely the first scatterlist element. But for calls relying
2807  * 		on the **sendpage** handler (e.g. **sendfile**\ ()) this will
2808  * 		be the range (**0**, **0**) because the data is shared with
2809  * 		user space and by default the objective is to avoid allowing
2810  * 		user space to modify data while (or after) eBPF verdict is
2811  * 		being decided. This helper can be used to pull in data and to
2812  * 		set the start and end pointer to given values. Data will be
2813  * 		copied if necessary (i.e. if data was not linear and if start
2814  * 		and end pointers do not point to the same chunk).
2815  *
2816  * 		A call to this helper is susceptible to change the underlying
2817  * 		packet buffer. Therefore, at load time, all checks on pointers
2818  * 		previously done by the verifier are invalidated and must be
2819  * 		performed again, if the helper is used in combination with
2820  * 		direct packet access.
2821  *
2822  * 		All values for *flags* are reserved for future usage, and must
2823  * 		be left at zero.
2824  * 	Return
2825  * 		0 on success, or a negative error in case of failure.
2826  *
2827  * long bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len)
2828  * 	Description
2829  * 		Bind the socket associated to *ctx* to the address pointed by
2830  * 		*addr*, of length *addr_len*. This allows for making outgoing
2831  * 		connection from the desired IP address, which can be useful for
2832  * 		example when all processes inside a cgroup should use one
2833  * 		single IP address on a host that has multiple IP configured.
2834  *
2835  * 		This helper works for IPv4 and IPv6, TCP and UDP sockets. The
2836  * 		domain (*addr*\ **->sa_family**) must be **AF_INET** (or
2837  * 		**AF_INET6**). It's advised to pass zero port (**sin_port**
2838  * 		or **sin6_port**) which triggers IP_BIND_ADDRESS_NO_PORT-like
2839  * 		behavior and lets the kernel efficiently pick up an unused
2840  * 		port as long as 4-tuple is unique. Passing non-zero port might
2841  * 		lead to degraded performance.
2842  * 	Return
2843  * 		0 on success, or a negative error in case of failure.
2844  *
2845  * long bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta)
2846  * 	Description
2847  * 		Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is
2848  * 		possible to both shrink and grow the packet tail.
2849  * 		Shrink done via *delta* being a negative integer.
2850  *
2851  * 		A call to this helper is susceptible to change the underlying
2852  * 		packet buffer. Therefore, at load time, all checks on pointers
2853  * 		previously done by the verifier are invalidated and must be
2854  * 		performed again, if the helper is used in combination with
2855  * 		direct packet access.
2856  * 	Return
2857  * 		0 on success, or a negative error in case of failure.
2858  *
2859  * long bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags)
2860  * 	Description
2861  * 		Retrieve the XFRM state (IP transform framework, see also
2862  * 		**ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*.
2863  *
2864  * 		The retrieved value is stored in the **struct bpf_xfrm_state**
2865  * 		pointed by *xfrm_state* and of length *size*.
2866  *
2867  * 		All values for *flags* are reserved for future usage, and must
2868  * 		be left at zero.
2869  *
2870  * 		This helper is available only if the kernel was compiled with
2871  * 		**CONFIG_XFRM** configuration option.
2872  * 	Return
2873  * 		0 on success, or a negative error in case of failure.
2874  *
2875  * long bpf_get_stack(void *ctx, void *buf, u32 size, u64 flags)
2876  * 	Description
2877  * 		Return a user or a kernel stack in bpf program provided buffer.
2878  * 		To achieve this, the helper needs *ctx*, which is a pointer
2879  * 		to the context on which the tracing program is executed.
2880  * 		To store the stacktrace, the bpf program provides *buf* with
2881  * 		a nonnegative *size*.
2882  *
2883  * 		The last argument, *flags*, holds the number of stack frames to
2884  * 		skip (from 0 to 255), masked with
2885  * 		**BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
2886  * 		the following flags:
2887  *
2888  * 		**BPF_F_USER_STACK**
2889  * 			Collect a user space stack instead of a kernel stack.
2890  * 		**BPF_F_USER_BUILD_ID**
2891  * 			Collect buildid+offset instead of ips for user stack,
2892  * 			only valid if **BPF_F_USER_STACK** is also specified.
2893  *
2894  * 		**bpf_get_stack**\ () can collect up to
2895  * 		**PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
2896  * 		to sufficient large buffer size. Note that
2897  * 		this limit can be controlled with the **sysctl** program, and
2898  * 		that it should be manually increased in order to profile long
2899  * 		user stacks (such as stacks for Java programs). To do so, use:
2900  *
2901  * 		::
2902  *
2903  * 			# sysctl kernel.perf_event_max_stack=<new value>
2904  * 	Return
2905  * 		A non-negative value equal to or less than *size* on success,
2906  * 		or a negative error in case of failure.
2907  *
2908  * long bpf_skb_load_bytes_relative(const void *skb, u32 offset, void *to, u32 len, u32 start_header)
2909  * 	Description
2910  * 		This helper is similar to **bpf_skb_load_bytes**\ () in that
2911  * 		it provides an easy way to load *len* bytes from *offset*
2912  * 		from the packet associated to *skb*, into the buffer pointed
2913  * 		by *to*. The difference to **bpf_skb_load_bytes**\ () is that
2914  * 		a fifth argument *start_header* exists in order to select a
2915  * 		base offset to start from. *start_header* can be one of:
2916  *
2917  * 		**BPF_HDR_START_MAC**
2918  * 			Base offset to load data from is *skb*'s mac header.
2919  * 		**BPF_HDR_START_NET**
2920  * 			Base offset to load data from is *skb*'s network header.
2921  *
2922  * 		In general, "direct packet access" is the preferred method to
2923  * 		access packet data, however, this helper is in particular useful
2924  * 		in socket filters where *skb*\ **->data** does not always point
2925  * 		to the start of the mac header and where "direct packet access"
2926  * 		is not available.
2927  * 	Return
2928  * 		0 on success, or a negative error in case of failure.
2929  *
2930  * long bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags)
2931  *	Description
2932  *		Do FIB lookup in kernel tables using parameters in *params*.
2933  *		If lookup is successful and result shows packet is to be
2934  *		forwarded, the neighbor tables are searched for the nexthop.
2935  *		If successful (ie., FIB lookup shows forwarding and nexthop
2936  *		is resolved), the nexthop address is returned in ipv4_dst
2937  *		or ipv6_dst based on family, smac is set to mac address of
2938  *		egress device, dmac is set to nexthop mac address, rt_metric
2939  *		is set to metric from route (IPv4/IPv6 only), and ifindex
2940  *		is set to the device index of the nexthop from the FIB lookup.
2941  *
2942  *		*plen* argument is the size of the passed in struct.
2943  *		*flags* argument can be a combination of one or more of the
2944  *		following values:
2945  *
2946  *		**BPF_FIB_LOOKUP_DIRECT**
2947  *			Do a direct table lookup vs full lookup using FIB
2948  *			rules.
2949  *		**BPF_FIB_LOOKUP_OUTPUT**
2950  *			Perform lookup from an egress perspective (default is
2951  *			ingress).
2952  *
2953  *		*ctx* is either **struct xdp_md** for XDP programs or
2954  *		**struct sk_buff** tc cls_act programs.
2955  *	Return
2956  *		* < 0 if any input argument is invalid
2957  *		*   0 on success (packet is forwarded, nexthop neighbor exists)
2958  *		* > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the
2959  *		  packet is not forwarded or needs assist from full stack
2960  *
2961  *		If lookup fails with BPF_FIB_LKUP_RET_FRAG_NEEDED, then the MTU
2962  *		was exceeded and output params->mtu_result contains the MTU.
2963  *
2964  * long bpf_sock_hash_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
2965  *	Description
2966  *		Add an entry to, or update a sockhash *map* referencing sockets.
2967  *		The *skops* is used as a new value for the entry associated to
2968  *		*key*. *flags* is one of:
2969  *
2970  *		**BPF_NOEXIST**
2971  *			The entry for *key* must not exist in the map.
2972  *		**BPF_EXIST**
2973  *			The entry for *key* must already exist in the map.
2974  *		**BPF_ANY**
2975  *			No condition on the existence of the entry for *key*.
2976  *
2977  *		If the *map* has eBPF programs (parser and verdict), those will
2978  *		be inherited by the socket being added. If the socket is
2979  *		already attached to eBPF programs, this results in an error.
2980  *	Return
2981  *		0 on success, or a negative error in case of failure.
2982  *
2983  * long bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags)
2984  *	Description
2985  *		This helper is used in programs implementing policies at the
2986  *		socket level. If the message *msg* is allowed to pass (i.e. if
2987  *		the verdict eBPF program returns **SK_PASS**), redirect it to
2988  *		the socket referenced by *map* (of type
2989  *		**BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
2990  *		egress interfaces can be used for redirection. The
2991  *		**BPF_F_INGRESS** value in *flags* is used to make the
2992  *		distinction (ingress path is selected if the flag is present,
2993  *		egress path otherwise). This is the only flag supported for now.
2994  *	Return
2995  *		**SK_PASS** on success, or **SK_DROP** on error.
2996  *
2997  * long bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags)
2998  *	Description
2999  *		This helper is used in programs implementing policies at the
3000  *		skb socket level. If the sk_buff *skb* is allowed to pass (i.e.
3001  *		if the verdict eBPF program returns **SK_PASS**), redirect it
3002  *		to the socket referenced by *map* (of type
3003  *		**BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
3004  *		egress interfaces can be used for redirection. The
3005  *		**BPF_F_INGRESS** value in *flags* is used to make the
3006  *		distinction (ingress path is selected if the flag is present,
3007  *		egress otherwise). This is the only flag supported for now.
3008  *	Return
3009  *		**SK_PASS** on success, or **SK_DROP** on error.
3010  *
3011  * long bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len)
3012  *	Description
3013  *		Encapsulate the packet associated to *skb* within a Layer 3
3014  *		protocol header. This header is provided in the buffer at
3015  *		address *hdr*, with *len* its size in bytes. *type* indicates
3016  *		the protocol of the header and can be one of:
3017  *
3018  *		**BPF_LWT_ENCAP_SEG6**
3019  *			IPv6 encapsulation with Segment Routing Header
3020  *			(**struct ipv6_sr_hdr**). *hdr* only contains the SRH,
3021  *			the IPv6 header is computed by the kernel.
3022  *		**BPF_LWT_ENCAP_SEG6_INLINE**
3023  *			Only works if *skb* contains an IPv6 packet. Insert a
3024  *			Segment Routing Header (**struct ipv6_sr_hdr**) inside
3025  *			the IPv6 header.
3026  *		**BPF_LWT_ENCAP_IP**
3027  *			IP encapsulation (GRE/GUE/IPIP/etc). The outer header
3028  *			must be IPv4 or IPv6, followed by zero or more
3029  *			additional headers, up to **LWT_BPF_MAX_HEADROOM**
3030  *			total bytes in all prepended headers. Please note that
3031  *			if **skb_is_gso**\ (*skb*) is true, no more than two
3032  *			headers can be prepended, and the inner header, if
3033  *			present, should be either GRE or UDP/GUE.
3034  *
3035  *		**BPF_LWT_ENCAP_SEG6**\ \* types can be called by BPF programs
3036  *		of type **BPF_PROG_TYPE_LWT_IN**; **BPF_LWT_ENCAP_IP** type can
3037  *		be called by bpf programs of types **BPF_PROG_TYPE_LWT_IN** and
3038  *		**BPF_PROG_TYPE_LWT_XMIT**.
3039  *
3040  * 		A call to this helper is susceptible to change the underlying
3041  * 		packet buffer. Therefore, at load time, all checks on pointers
3042  * 		previously done by the verifier are invalidated and must be
3043  * 		performed again, if the helper is used in combination with
3044  * 		direct packet access.
3045  *	Return
3046  * 		0 on success, or a negative error in case of failure.
3047  *
3048  * long bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len)
3049  *	Description
3050  *		Store *len* bytes from address *from* into the packet
3051  *		associated to *skb*, at *offset*. Only the flags, tag and TLVs
3052  *		inside the outermost IPv6 Segment Routing Header can be
3053  *		modified through this helper.
3054  *
3055  * 		A call to this helper is susceptible to change the underlying
3056  * 		packet buffer. Therefore, at load time, all checks on pointers
3057  * 		previously done by the verifier are invalidated and must be
3058  * 		performed again, if the helper is used in combination with
3059  * 		direct packet access.
3060  *	Return
3061  * 		0 on success, or a negative error in case of failure.
3062  *
3063  * long bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta)
3064  *	Description
3065  *		Adjust the size allocated to TLVs in the outermost IPv6
3066  *		Segment Routing Header contained in the packet associated to
3067  *		*skb*, at position *offset* by *delta* bytes. Only offsets
3068  *		after the segments are accepted. *delta* can be as well
3069  *		positive (growing) as negative (shrinking).
3070  *
3071  * 		A call to this helper is susceptible to change the underlying
3072  * 		packet buffer. Therefore, at load time, all checks on pointers
3073  * 		previously done by the verifier are invalidated and must be
3074  * 		performed again, if the helper is used in combination with
3075  * 		direct packet access.
3076  *	Return
3077  * 		0 on success, or a negative error in case of failure.
3078  *
3079  * long bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len)
3080  *	Description
3081  *		Apply an IPv6 Segment Routing action of type *action* to the
3082  *		packet associated to *skb*. Each action takes a parameter
3083  *		contained at address *param*, and of length *param_len* bytes.
3084  *		*action* can be one of:
3085  *
3086  *		**SEG6_LOCAL_ACTION_END_X**
3087  *			End.X action: Endpoint with Layer-3 cross-connect.
3088  *			Type of *param*: **struct in6_addr**.
3089  *		**SEG6_LOCAL_ACTION_END_T**
3090  *			End.T action: Endpoint with specific IPv6 table lookup.
3091  *			Type of *param*: **int**.
3092  *		**SEG6_LOCAL_ACTION_END_B6**
3093  *			End.B6 action: Endpoint bound to an SRv6 policy.
3094  *			Type of *param*: **struct ipv6_sr_hdr**.
3095  *		**SEG6_LOCAL_ACTION_END_B6_ENCAP**
3096  *			End.B6.Encap action: Endpoint bound to an SRv6
3097  *			encapsulation policy.
3098  *			Type of *param*: **struct ipv6_sr_hdr**.
3099  *
3100  * 		A call to this helper is susceptible to change the underlying
3101  * 		packet buffer. Therefore, at load time, all checks on pointers
3102  * 		previously done by the verifier are invalidated and must be
3103  * 		performed again, if the helper is used in combination with
3104  * 		direct packet access.
3105  *	Return
3106  * 		0 on success, or a negative error in case of failure.
3107  *
3108  * long bpf_rc_repeat(void *ctx)
3109  *	Description
3110  *		This helper is used in programs implementing IR decoding, to
3111  *		report a successfully decoded repeat key message. This delays
3112  *		the generation of a key up event for previously generated
3113  *		key down event.
3114  *
3115  *		Some IR protocols like NEC have a special IR message for
3116  *		repeating last button, for when a button is held down.
3117  *
3118  *		The *ctx* should point to the lirc sample as passed into
3119  *		the program.
3120  *
3121  *		This helper is only available is the kernel was compiled with
3122  *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to
3123  *		"**y**".
3124  *	Return
3125  *		0
3126  *
3127  * long bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle)
3128  *	Description
3129  *		This helper is used in programs implementing IR decoding, to
3130  *		report a successfully decoded key press with *scancode*,
3131  *		*toggle* value in the given *protocol*. The scancode will be
3132  *		translated to a keycode using the rc keymap, and reported as
3133  *		an input key down event. After a period a key up event is
3134  *		generated. This period can be extended by calling either
3135  *		**bpf_rc_keydown**\ () again with the same values, or calling
3136  *		**bpf_rc_repeat**\ ().
3137  *
3138  *		Some protocols include a toggle bit, in case the button was
3139  *		released and pressed again between consecutive scancodes.
3140  *
3141  *		The *ctx* should point to the lirc sample as passed into
3142  *		the program.
3143  *
3144  *		The *protocol* is the decoded protocol number (see
3145  *		**enum rc_proto** for some predefined values).
3146  *
3147  *		This helper is only available is the kernel was compiled with
3148  *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to
3149  *		"**y**".
3150  *	Return
3151  *		0
3152  *
3153  * u64 bpf_skb_cgroup_id(struct sk_buff *skb)
3154  * 	Description
3155  * 		Return the cgroup v2 id of the socket associated with the *skb*.
3156  * 		This is roughly similar to the **bpf_get_cgroup_classid**\ ()
3157  * 		helper for cgroup v1 by providing a tag resp. identifier that
3158  * 		can be matched on or used for map lookups e.g. to implement
3159  * 		policy. The cgroup v2 id of a given path in the hierarchy is
3160  * 		exposed in user space through the f_handle API in order to get
3161  * 		to the same 64-bit id.
3162  *
3163  * 		This helper can be used on TC egress path, but not on ingress,
3164  * 		and is available only if the kernel was compiled with the
3165  * 		**CONFIG_SOCK_CGROUP_DATA** configuration option.
3166  * 	Return
3167  * 		The id is returned or 0 in case the id could not be retrieved.
3168  *
3169  * u64 bpf_get_current_cgroup_id(void)
3170  * 	Return
3171  * 		A 64-bit integer containing the current cgroup id based
3172  * 		on the cgroup within which the current task is running.
3173  *
3174  * void *bpf_get_local_storage(void *map, u64 flags)
3175  *	Description
3176  *		Get the pointer to the local storage area.
3177  *		The type and the size of the local storage is defined
3178  *		by the *map* argument.
3179  *		The *flags* meaning is specific for each map type,
3180  *		and has to be 0 for cgroup local storage.
3181  *
3182  *		Depending on the BPF program type, a local storage area
3183  *		can be shared between multiple instances of the BPF program,
3184  *		running simultaneously.
3185  *
3186  *		A user should care about the synchronization by himself.
3187  *		For example, by using the **BPF_ATOMIC** instructions to alter
3188  *		the shared data.
3189  *	Return
3190  *		A pointer to the local storage area.
3191  *
3192  * long bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags)
3193  *	Description
3194  *		Select a **SO_REUSEPORT** socket from a
3195  *		**BPF_MAP_TYPE_REUSEPORT_ARRAY** *map*.
3196  *		It checks the selected socket is matching the incoming
3197  *		request in the socket buffer.
3198  *	Return
3199  *		0 on success, or a negative error in case of failure.
3200  *
3201  * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level)
3202  *	Description
3203  *		Return id of cgroup v2 that is ancestor of cgroup associated
3204  *		with the *skb* at the *ancestor_level*.  The root cgroup is at
3205  *		*ancestor_level* zero and each step down the hierarchy
3206  *		increments the level. If *ancestor_level* == level of cgroup
3207  *		associated with *skb*, then return value will be same as that
3208  *		of **bpf_skb_cgroup_id**\ ().
3209  *
3210  *		The helper is useful to implement policies based on cgroups
3211  *		that are upper in hierarchy than immediate cgroup associated
3212  *		with *skb*.
3213  *
3214  *		The format of returned id and helper limitations are same as in
3215  *		**bpf_skb_cgroup_id**\ ().
3216  *	Return
3217  *		The id is returned or 0 in case the id could not be retrieved.
3218  *
3219  * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
3220  *	Description
3221  *		Look for TCP socket matching *tuple*, optionally in a child
3222  *		network namespace *netns*. The return value must be checked,
3223  *		and if non-**NULL**, released via **bpf_sk_release**\ ().
3224  *
3225  *		The *ctx* should point to the context of the program, such as
3226  *		the skb or socket (depending on the hook in use). This is used
3227  *		to determine the base network namespace for the lookup.
3228  *
3229  *		*tuple_size* must be one of:
3230  *
3231  *		**sizeof**\ (*tuple*\ **->ipv4**)
3232  *			Look for an IPv4 socket.
3233  *		**sizeof**\ (*tuple*\ **->ipv6**)
3234  *			Look for an IPv6 socket.
3235  *
3236  *		If the *netns* is a negative signed 32-bit integer, then the
3237  *		socket lookup table in the netns associated with the *ctx*
3238  *		will be used. For the TC hooks, this is the netns of the device
3239  *		in the skb. For socket hooks, this is the netns of the socket.
3240  *		If *netns* is any other signed 32-bit value greater than or
3241  *		equal to zero then it specifies the ID of the netns relative to
3242  *		the netns associated with the *ctx*. *netns* values beyond the
3243  *		range of 32-bit integers are reserved for future use.
3244  *
3245  *		All values for *flags* are reserved for future usage, and must
3246  *		be left at zero.
3247  *
3248  *		This helper is available only if the kernel was compiled with
3249  *		**CONFIG_NET** configuration option.
3250  *	Return
3251  *		Pointer to **struct bpf_sock**, or **NULL** in case of failure.
3252  *		For sockets with reuseport option, the **struct bpf_sock**
3253  *		result is from *reuse*\ **->socks**\ [] using the hash of the
3254  *		tuple.
3255  *
3256  * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
3257  *	Description
3258  *		Look for UDP socket matching *tuple*, optionally in a child
3259  *		network namespace *netns*. The return value must be checked,
3260  *		and if non-**NULL**, released via **bpf_sk_release**\ ().
3261  *
3262  *		The *ctx* should point to the context of the program, such as
3263  *		the skb or socket (depending on the hook in use). This is used
3264  *		to determine the base network namespace for the lookup.
3265  *
3266  *		*tuple_size* must be one of:
3267  *
3268  *		**sizeof**\ (*tuple*\ **->ipv4**)
3269  *			Look for an IPv4 socket.
3270  *		**sizeof**\ (*tuple*\ **->ipv6**)
3271  *			Look for an IPv6 socket.
3272  *
3273  *		If the *netns* is a negative signed 32-bit integer, then the
3274  *		socket lookup table in the netns associated with the *ctx*
3275  *		will be used. For the TC hooks, this is the netns of the device
3276  *		in the skb. For socket hooks, this is the netns of the socket.
3277  *		If *netns* is any other signed 32-bit value greater than or
3278  *		equal to zero then it specifies the ID of the netns relative to
3279  *		the netns associated with the *ctx*. *netns* values beyond the
3280  *		range of 32-bit integers are reserved for future use.
3281  *
3282  *		All values for *flags* are reserved for future usage, and must
3283  *		be left at zero.
3284  *
3285  *		This helper is available only if the kernel was compiled with
3286  *		**CONFIG_NET** configuration option.
3287  *	Return
3288  *		Pointer to **struct bpf_sock**, or **NULL** in case of failure.
3289  *		For sockets with reuseport option, the **struct bpf_sock**
3290  *		result is from *reuse*\ **->socks**\ [] using the hash of the
3291  *		tuple.
3292  *
3293  * long bpf_sk_release(void *sock)
3294  *	Description
3295  *		Release the reference held by *sock*. *sock* must be a
3296  *		non-**NULL** pointer that was returned from
3297  *		**bpf_sk_lookup_xxx**\ ().
3298  *	Return
3299  *		0 on success, or a negative error in case of failure.
3300  *
3301  * long bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags)
3302  * 	Description
3303  * 		Push an element *value* in *map*. *flags* is one of:
3304  *
3305  * 		**BPF_EXIST**
3306  * 			If the queue/stack is full, the oldest element is
3307  * 			removed to make room for this.
3308  * 	Return
3309  * 		0 on success, or a negative error in case of failure.
3310  *
3311  * long bpf_map_pop_elem(struct bpf_map *map, void *value)
3312  * 	Description
3313  * 		Pop an element from *map*.
3314  * 	Return
3315  * 		0 on success, or a negative error in case of failure.
3316  *
3317  * long bpf_map_peek_elem(struct bpf_map *map, void *value)
3318  * 	Description
3319  * 		Get an element from *map* without removing it.
3320  * 	Return
3321  * 		0 on success, or a negative error in case of failure.
3322  *
3323  * long bpf_msg_push_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags)
3324  *	Description
3325  *		For socket policies, insert *len* bytes into *msg* at offset
3326  *		*start*.
3327  *
3328  *		If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
3329  *		*msg* it may want to insert metadata or options into the *msg*.
3330  *		This can later be read and used by any of the lower layer BPF
3331  *		hooks.
3332  *
3333  *		This helper may fail if under memory pressure (a malloc
3334  *		fails) in these cases BPF programs will get an appropriate
3335  *		error and BPF programs will need to handle them.
3336  *	Return
3337  *		0 on success, or a negative error in case of failure.
3338  *
3339  * long bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags)
3340  *	Description
3341  *		Will remove *len* bytes from a *msg* starting at byte *start*.
3342  *		This may result in **ENOMEM** errors under certain situations if
3343  *		an allocation and copy are required due to a full ring buffer.
3344  *		However, the helper will try to avoid doing the allocation
3345  *		if possible. Other errors can occur if input parameters are
3346  *		invalid either due to *start* byte not being valid part of *msg*
3347  *		payload and/or *pop* value being to large.
3348  *	Return
3349  *		0 on success, or a negative error in case of failure.
3350  *
3351  * long bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y)
3352  *	Description
3353  *		This helper is used in programs implementing IR decoding, to
3354  *		report a successfully decoded pointer movement.
3355  *
3356  *		The *ctx* should point to the lirc sample as passed into
3357  *		the program.
3358  *
3359  *		This helper is only available is the kernel was compiled with
3360  *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to
3361  *		"**y**".
3362  *	Return
3363  *		0
3364  *
3365  * long bpf_spin_lock(struct bpf_spin_lock *lock)
3366  *	Description
3367  *		Acquire a spinlock represented by the pointer *lock*, which is
3368  *		stored as part of a value of a map. Taking the lock allows to
3369  *		safely update the rest of the fields in that value. The
3370  *		spinlock can (and must) later be released with a call to
3371  *		**bpf_spin_unlock**\ (\ *lock*\ ).
3372  *
3373  *		Spinlocks in BPF programs come with a number of restrictions
3374  *		and constraints:
3375  *
3376  *		* **bpf_spin_lock** objects are only allowed inside maps of
3377  *		  types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this
3378  *		  list could be extended in the future).
3379  *		* BTF description of the map is mandatory.
3380  *		* The BPF program can take ONE lock at a time, since taking two
3381  *		  or more could cause dead locks.
3382  *		* Only one **struct bpf_spin_lock** is allowed per map element.
3383  *		* When the lock is taken, calls (either BPF to BPF or helpers)
3384  *		  are not allowed.
3385  *		* The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not
3386  *		  allowed inside a spinlock-ed region.
3387  *		* The BPF program MUST call **bpf_spin_unlock**\ () to release
3388  *		  the lock, on all execution paths, before it returns.
3389  *		* The BPF program can access **struct bpf_spin_lock** only via
3390  *		  the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ ()
3391  *		  helpers. Loading or storing data into the **struct
3392  *		  bpf_spin_lock** *lock*\ **;** field of a map is not allowed.
3393  *		* To use the **bpf_spin_lock**\ () helper, the BTF description
3394  *		  of the map value must be a struct and have **struct
3395  *		  bpf_spin_lock** *anyname*\ **;** field at the top level.
3396  *		  Nested lock inside another struct is not allowed.
3397  *		* The **struct bpf_spin_lock** *lock* field in a map value must
3398  *		  be aligned on a multiple of 4 bytes in that value.
3399  *		* Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy
3400  *		  the **bpf_spin_lock** field to user space.
3401  *		* Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from
3402  *		  a BPF program, do not update the **bpf_spin_lock** field.
3403  *		* **bpf_spin_lock** cannot be on the stack or inside a
3404  *		  networking packet (it can only be inside of a map values).
3405  *		* **bpf_spin_lock** is available to root only.
3406  *		* Tracing programs and socket filter programs cannot use
3407  *		  **bpf_spin_lock**\ () due to insufficient preemption checks
3408  *		  (but this may change in the future).
3409  *		* **bpf_spin_lock** is not allowed in inner maps of map-in-map.
3410  *	Return
3411  *		0
3412  *
3413  * long bpf_spin_unlock(struct bpf_spin_lock *lock)
3414  *	Description
3415  *		Release the *lock* previously locked by a call to
3416  *		**bpf_spin_lock**\ (\ *lock*\ ).
3417  *	Return
3418  *		0
3419  *
3420  * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk)
3421  *	Description
3422  *		This helper gets a **struct bpf_sock** pointer such
3423  *		that all the fields in this **bpf_sock** can be accessed.
3424  *	Return
3425  *		A **struct bpf_sock** pointer on success, or **NULL** in
3426  *		case of failure.
3427  *
3428  * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk)
3429  *	Description
3430  *		This helper gets a **struct bpf_tcp_sock** pointer from a
3431  *		**struct bpf_sock** pointer.
3432  *	Return
3433  *		A **struct bpf_tcp_sock** pointer on success, or **NULL** in
3434  *		case of failure.
3435  *
3436  * long bpf_skb_ecn_set_ce(struct sk_buff *skb)
3437  *	Description
3438  *		Set ECN (Explicit Congestion Notification) field of IP header
3439  *		to **CE** (Congestion Encountered) if current value is **ECT**
3440  *		(ECN Capable Transport). Otherwise, do nothing. Works with IPv6
3441  *		and IPv4.
3442  *	Return
3443  *		1 if the **CE** flag is set (either by the current helper call
3444  *		or because it was already present), 0 if it is not set.
3445  *
3446  * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk)
3447  *	Description
3448  *		Return a **struct bpf_sock** pointer in **TCP_LISTEN** state.
3449  *		**bpf_sk_release**\ () is unnecessary and not allowed.
3450  *	Return
3451  *		A **struct bpf_sock** pointer on success, or **NULL** in
3452  *		case of failure.
3453  *
3454  * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
3455  *	Description
3456  *		Look for TCP socket matching *tuple*, optionally in a child
3457  *		network namespace *netns*. The return value must be checked,
3458  *		and if non-**NULL**, released via **bpf_sk_release**\ ().
3459  *
3460  *		This function is identical to **bpf_sk_lookup_tcp**\ (), except
3461  *		that it also returns timewait or request sockets. Use
3462  *		**bpf_sk_fullsock**\ () or **bpf_tcp_sock**\ () to access the
3463  *		full structure.
3464  *
3465  *		This helper is available only if the kernel was compiled with
3466  *		**CONFIG_NET** configuration option.
3467  *	Return
3468  *		Pointer to **struct bpf_sock**, or **NULL** in case of failure.
3469  *		For sockets with reuseport option, the **struct bpf_sock**
3470  *		result is from *reuse*\ **->socks**\ [] using the hash of the
3471  *		tuple.
3472  *
3473  * long bpf_tcp_check_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
3474  * 	Description
3475  * 		Check whether *iph* and *th* contain a valid SYN cookie ACK for
3476  * 		the listening socket in *sk*.
3477  *
3478  * 		*iph* points to the start of the IPv4 or IPv6 header, while
3479  * 		*iph_len* contains **sizeof**\ (**struct iphdr**) or
3480  * 		**sizeof**\ (**struct ip6hdr**).
3481  *
3482  * 		*th* points to the start of the TCP header, while *th_len*
3483  * 		contains **sizeof**\ (**struct tcphdr**).
3484  * 	Return
3485  * 		0 if *iph* and *th* are a valid SYN cookie ACK, or a negative
3486  * 		error otherwise.
3487  *
3488  * long bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags)
3489  *	Description
3490  *		Get name of sysctl in /proc/sys/ and copy it into provided by
3491  *		program buffer *buf* of size *buf_len*.
3492  *
3493  *		The buffer is always NUL terminated, unless it's zero-sized.
3494  *
3495  *		If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is
3496  *		copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name
3497  *		only (e.g. "tcp_mem").
3498  *	Return
3499  *		Number of character copied (not including the trailing NUL).
3500  *
3501  *		**-E2BIG** if the buffer wasn't big enough (*buf* will contain
3502  *		truncated name in this case).
3503  *
3504  * long bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
3505  *	Description
3506  *		Get current value of sysctl as it is presented in /proc/sys
3507  *		(incl. newline, etc), and copy it as a string into provided
3508  *		by program buffer *buf* of size *buf_len*.
3509  *
3510  *		The whole value is copied, no matter what file position user
3511  *		space issued e.g. sys_read at.
3512  *
3513  *		The buffer is always NUL terminated, unless it's zero-sized.
3514  *	Return
3515  *		Number of character copied (not including the trailing NUL).
3516  *
3517  *		**-E2BIG** if the buffer wasn't big enough (*buf* will contain
3518  *		truncated name in this case).
3519  *
3520  *		**-EINVAL** if current value was unavailable, e.g. because
3521  *		sysctl is uninitialized and read returns -EIO for it.
3522  *
3523  * long bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
3524  *	Description
3525  *		Get new value being written by user space to sysctl (before
3526  *		the actual write happens) and copy it as a string into
3527  *		provided by program buffer *buf* of size *buf_len*.
3528  *
3529  *		User space may write new value at file position > 0.
3530  *
3531  *		The buffer is always NUL terminated, unless it's zero-sized.
3532  *	Return
3533  *		Number of character copied (not including the trailing NUL).
3534  *
3535  *		**-E2BIG** if the buffer wasn't big enough (*buf* will contain
3536  *		truncated name in this case).
3537  *
3538  *		**-EINVAL** if sysctl is being read.
3539  *
3540  * long bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len)
3541  *	Description
3542  *		Override new value being written by user space to sysctl with
3543  *		value provided by program in buffer *buf* of size *buf_len*.
3544  *
3545  *		*buf* should contain a string in same form as provided by user
3546  *		space on sysctl write.
3547  *
3548  *		User space may write new value at file position > 0. To override
3549  *		the whole sysctl value file position should be set to zero.
3550  *	Return
3551  *		0 on success.
3552  *
3553  *		**-E2BIG** if the *buf_len* is too big.
3554  *
3555  *		**-EINVAL** if sysctl is being read.
3556  *
3557  * long bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res)
3558  *	Description
3559  *		Convert the initial part of the string from buffer *buf* of
3560  *		size *buf_len* to a long integer according to the given base
3561  *		and save the result in *res*.
3562  *
3563  *		The string may begin with an arbitrary amount of white space
3564  *		(as determined by **isspace**\ (3)) followed by a single
3565  *		optional '**-**' sign.
3566  *
3567  *		Five least significant bits of *flags* encode base, other bits
3568  *		are currently unused.
3569  *
3570  *		Base must be either 8, 10, 16 or 0 to detect it automatically
3571  *		similar to user space **strtol**\ (3).
3572  *	Return
3573  *		Number of characters consumed on success. Must be positive but
3574  *		no more than *buf_len*.
3575  *
3576  *		**-EINVAL** if no valid digits were found or unsupported base
3577  *		was provided.
3578  *
3579  *		**-ERANGE** if resulting value was out of range.
3580  *
3581  * long bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res)
3582  *	Description
3583  *		Convert the initial part of the string from buffer *buf* of
3584  *		size *buf_len* to an unsigned long integer according to the
3585  *		given base and save the result in *res*.
3586  *
3587  *		The string may begin with an arbitrary amount of white space
3588  *		(as determined by **isspace**\ (3)).
3589  *
3590  *		Five least significant bits of *flags* encode base, other bits
3591  *		are currently unused.
3592  *
3593  *		Base must be either 8, 10, 16 or 0 to detect it automatically
3594  *		similar to user space **strtoul**\ (3).
3595  *	Return
3596  *		Number of characters consumed on success. Must be positive but
3597  *		no more than *buf_len*.
3598  *
3599  *		**-EINVAL** if no valid digits were found or unsupported base
3600  *		was provided.
3601  *
3602  *		**-ERANGE** if resulting value was out of range.
3603  *
3604  * void *bpf_sk_storage_get(struct bpf_map *map, void *sk, void *value, u64 flags)
3605  *	Description
3606  *		Get a bpf-local-storage from a *sk*.
3607  *
3608  *		Logically, it could be thought of getting the value from
3609  *		a *map* with *sk* as the **key**.  From this
3610  *		perspective,  the usage is not much different from
3611  *		**bpf_map_lookup_elem**\ (*map*, **&**\ *sk*) except this
3612  *		helper enforces the key must be a full socket and the map must
3613  *		be a **BPF_MAP_TYPE_SK_STORAGE** also.
3614  *
3615  *		Underneath, the value is stored locally at *sk* instead of
3616  *		the *map*.  The *map* is used as the bpf-local-storage
3617  *		"type". The bpf-local-storage "type" (i.e. the *map*) is
3618  *		searched against all bpf-local-storages residing at *sk*.
3619  *
3620  *		*sk* is a kernel **struct sock** pointer for LSM program.
3621  *		*sk* is a **struct bpf_sock** pointer for other program types.
3622  *
3623  *		An optional *flags* (**BPF_SK_STORAGE_GET_F_CREATE**) can be
3624  *		used such that a new bpf-local-storage will be
3625  *		created if one does not exist.  *value* can be used
3626  *		together with **BPF_SK_STORAGE_GET_F_CREATE** to specify
3627  *		the initial value of a bpf-local-storage.  If *value* is
3628  *		**NULL**, the new bpf-local-storage will be zero initialized.
3629  *	Return
3630  *		A bpf-local-storage pointer is returned on success.
3631  *
3632  *		**NULL** if not found or there was an error in adding
3633  *		a new bpf-local-storage.
3634  *
3635  * long bpf_sk_storage_delete(struct bpf_map *map, void *sk)
3636  *	Description
3637  *		Delete a bpf-local-storage from a *sk*.
3638  *	Return
3639  *		0 on success.
3640  *
3641  *		**-ENOENT** if the bpf-local-storage cannot be found.
3642  *		**-EINVAL** if sk is not a fullsock (e.g. a request_sock).
3643  *
3644  * long bpf_send_signal(u32 sig)
3645  *	Description
3646  *		Send signal *sig* to the process of the current task.
3647  *		The signal may be delivered to any of this process's threads.
3648  *	Return
3649  *		0 on success or successfully queued.
3650  *
3651  *		**-EBUSY** if work queue under nmi is full.
3652  *
3653  *		**-EINVAL** if *sig* is invalid.
3654  *
3655  *		**-EPERM** if no permission to send the *sig*.
3656  *
3657  *		**-EAGAIN** if bpf program can try again.
3658  *
3659  * s64 bpf_tcp_gen_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
3660  *	Description
3661  *		Try to issue a SYN cookie for the packet with corresponding
3662  *		IP/TCP headers, *iph* and *th*, on the listening socket in *sk*.
3663  *
3664  *		*iph* points to the start of the IPv4 or IPv6 header, while
3665  *		*iph_len* contains **sizeof**\ (**struct iphdr**) or
3666  *		**sizeof**\ (**struct ip6hdr**).
3667  *
3668  *		*th* points to the start of the TCP header, while *th_len*
3669  *		contains the length of the TCP header.
3670  *	Return
3671  *		On success, lower 32 bits hold the generated SYN cookie in
3672  *		followed by 16 bits which hold the MSS value for that cookie,
3673  *		and the top 16 bits are unused.
3674  *
3675  *		On failure, the returned value is one of the following:
3676  *
3677  *		**-EINVAL** SYN cookie cannot be issued due to error
3678  *
3679  *		**-ENOENT** SYN cookie should not be issued (no SYN flood)
3680  *
3681  *		**-EOPNOTSUPP** kernel configuration does not enable SYN cookies
3682  *
3683  *		**-EPROTONOSUPPORT** IP packet version is not 4 or 6
3684  *
3685  * long bpf_skb_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
3686  * 	Description
3687  * 		Write raw *data* blob into a special BPF perf event held by
3688  * 		*map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
3689  * 		event must have the following attributes: **PERF_SAMPLE_RAW**
3690  * 		as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
3691  * 		**PERF_COUNT_SW_BPF_OUTPUT** as **config**.
3692  *
3693  * 		The *flags* are used to indicate the index in *map* for which
3694  * 		the value must be put, masked with **BPF_F_INDEX_MASK**.
3695  * 		Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
3696  * 		to indicate that the index of the current CPU core should be
3697  * 		used.
3698  *
3699  * 		The value to write, of *size*, is passed through eBPF stack and
3700  * 		pointed by *data*.
3701  *
3702  * 		*ctx* is a pointer to in-kernel struct sk_buff.
3703  *
3704  * 		This helper is similar to **bpf_perf_event_output**\ () but
3705  * 		restricted to raw_tracepoint bpf programs.
3706  * 	Return
3707  * 		0 on success, or a negative error in case of failure.
3708  *
3709  * long bpf_probe_read_user(void *dst, u32 size, const void *unsafe_ptr)
3710  * 	Description
3711  * 		Safely attempt to read *size* bytes from user space address
3712  * 		*unsafe_ptr* and store the data in *dst*.
3713  * 	Return
3714  * 		0 on success, or a negative error in case of failure.
3715  *
3716  * long bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr)
3717  * 	Description
3718  * 		Safely attempt to read *size* bytes from kernel space address
3719  * 		*unsafe_ptr* and store the data in *dst*.
3720  * 	Return
3721  * 		0 on success, or a negative error in case of failure.
3722  *
3723  * long bpf_probe_read_user_str(void *dst, u32 size, const void *unsafe_ptr)
3724  * 	Description
3725  * 		Copy a NUL terminated string from an unsafe user address
3726  * 		*unsafe_ptr* to *dst*. The *size* should include the
3727  * 		terminating NUL byte. In case the string length is smaller than
3728  * 		*size*, the target is not padded with further NUL bytes. If the
3729  * 		string length is larger than *size*, just *size*-1 bytes are
3730  * 		copied and the last byte is set to NUL.
3731  *
3732  * 		On success, returns the number of bytes that were written,
3733  * 		including the terminal NUL. This makes this helper useful in
3734  * 		tracing programs for reading strings, and more importantly to
3735  * 		get its length at runtime. See the following snippet:
3736  *
3737  * 		::
3738  *
3739  * 			SEC("kprobe/sys_open")
3740  * 			void bpf_sys_open(struct pt_regs *ctx)
3741  * 			{
3742  * 			        char buf[PATHLEN]; // PATHLEN is defined to 256
3743  * 			        int res = bpf_probe_read_user_str(buf, sizeof(buf),
3744  * 				                                  ctx->di);
3745  *
3746  * 				// Consume buf, for example push it to
3747  * 				// userspace via bpf_perf_event_output(); we
3748  * 				// can use res (the string length) as event
3749  * 				// size, after checking its boundaries.
3750  * 			}
3751  *
3752  * 		In comparison, using **bpf_probe_read_user**\ () helper here
3753  * 		instead to read the string would require to estimate the length
3754  * 		at compile time, and would often result in copying more memory
3755  * 		than necessary.
3756  *
3757  * 		Another useful use case is when parsing individual process
3758  * 		arguments or individual environment variables navigating
3759  * 		*current*\ **->mm->arg_start** and *current*\
3760  * 		**->mm->env_start**: using this helper and the return value,
3761  * 		one can quickly iterate at the right offset of the memory area.
3762  * 	Return
3763  * 		On success, the strictly positive length of the output string,
3764  * 		including the trailing NUL character. On error, a negative
3765  * 		value.
3766  *
3767  * long bpf_probe_read_kernel_str(void *dst, u32 size, const void *unsafe_ptr)
3768  * 	Description
3769  * 		Copy a NUL terminated string from an unsafe kernel address *unsafe_ptr*
3770  * 		to *dst*. Same semantics as with **bpf_probe_read_user_str**\ () apply.
3771  * 	Return
3772  * 		On success, the strictly positive length of the string, including
3773  * 		the trailing NUL character. On error, a negative value.
3774  *
3775  * long bpf_tcp_send_ack(void *tp, u32 rcv_nxt)
3776  *	Description
3777  *		Send out a tcp-ack. *tp* is the in-kernel struct **tcp_sock**.
3778  *		*rcv_nxt* is the ack_seq to be sent out.
3779  *	Return
3780  *		0 on success, or a negative error in case of failure.
3781  *
3782  * long bpf_send_signal_thread(u32 sig)
3783  *	Description
3784  *		Send signal *sig* to the thread corresponding to the current task.
3785  *	Return
3786  *		0 on success or successfully queued.
3787  *
3788  *		**-EBUSY** if work queue under nmi is full.
3789  *
3790  *		**-EINVAL** if *sig* is invalid.
3791  *
3792  *		**-EPERM** if no permission to send the *sig*.
3793  *
3794  *		**-EAGAIN** if bpf program can try again.
3795  *
3796  * u64 bpf_jiffies64(void)
3797  *	Description
3798  *		Obtain the 64bit jiffies
3799  *	Return
3800  *		The 64 bit jiffies
3801  *
3802  * long bpf_read_branch_records(struct bpf_perf_event_data *ctx, void *buf, u32 size, u64 flags)
3803  *	Description
3804  *		For an eBPF program attached to a perf event, retrieve the
3805  *		branch records (**struct perf_branch_entry**) associated to *ctx*
3806  *		and store it in the buffer pointed by *buf* up to size
3807  *		*size* bytes.
3808  *	Return
3809  *		On success, number of bytes written to *buf*. On error, a
3810  *		negative value.
3811  *
3812  *		The *flags* can be set to **BPF_F_GET_BRANCH_RECORDS_SIZE** to
3813  *		instead return the number of bytes required to store all the
3814  *		branch entries. If this flag is set, *buf* may be NULL.
3815  *
3816  *		**-EINVAL** if arguments invalid or **size** not a multiple
3817  *		of **sizeof**\ (**struct perf_branch_entry**\ ).
3818  *
3819  *		**-ENOENT** if architecture does not support branch records.
3820  *
3821  * long bpf_get_ns_current_pid_tgid(u64 dev, u64 ino, struct bpf_pidns_info *nsdata, u32 size)
3822  *	Description
3823  *		Returns 0 on success, values for *pid* and *tgid* as seen from the current
3824  *		*namespace* will be returned in *nsdata*.
3825  *	Return
3826  *		0 on success, or one of the following in case of failure:
3827  *
3828  *		**-EINVAL** if dev and inum supplied don't match dev_t and inode number
3829  *              with nsfs of current task, or if dev conversion to dev_t lost high bits.
3830  *
3831  *		**-ENOENT** if pidns does not exists for the current task.
3832  *
3833  * long bpf_xdp_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
3834  *	Description
3835  *		Write raw *data* blob into a special BPF perf event held by
3836  *		*map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
3837  *		event must have the following attributes: **PERF_SAMPLE_RAW**
3838  *		as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
3839  *		**PERF_COUNT_SW_BPF_OUTPUT** as **config**.
3840  *
3841  *		The *flags* are used to indicate the index in *map* for which
3842  *		the value must be put, masked with **BPF_F_INDEX_MASK**.
3843  *		Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
3844  *		to indicate that the index of the current CPU core should be
3845  *		used.
3846  *
3847  *		The value to write, of *size*, is passed through eBPF stack and
3848  *		pointed by *data*.
3849  *
3850  *		*ctx* is a pointer to in-kernel struct xdp_buff.
3851  *
3852  *		This helper is similar to **bpf_perf_eventoutput**\ () but
3853  *		restricted to raw_tracepoint bpf programs.
3854  *	Return
3855  *		0 on success, or a negative error in case of failure.
3856  *
3857  * u64 bpf_get_netns_cookie(void *ctx)
3858  * 	Description
3859  * 		Retrieve the cookie (generated by the kernel) of the network
3860  * 		namespace the input *ctx* is associated with. The network
3861  * 		namespace cookie remains stable for its lifetime and provides
3862  * 		a global identifier that can be assumed unique. If *ctx* is
3863  * 		NULL, then the helper returns the cookie for the initial
3864  * 		network namespace. The cookie itself is very similar to that
3865  * 		of **bpf_get_socket_cookie**\ () helper, but for network
3866  * 		namespaces instead of sockets.
3867  * 	Return
3868  * 		A 8-byte long opaque number.
3869  *
3870  * u64 bpf_get_current_ancestor_cgroup_id(int ancestor_level)
3871  * 	Description
3872  * 		Return id of cgroup v2 that is ancestor of the cgroup associated
3873  * 		with the current task at the *ancestor_level*. The root cgroup
3874  * 		is at *ancestor_level* zero and each step down the hierarchy
3875  * 		increments the level. If *ancestor_level* == level of cgroup
3876  * 		associated with the current task, then return value will be the
3877  * 		same as that of **bpf_get_current_cgroup_id**\ ().
3878  *
3879  * 		The helper is useful to implement policies based on cgroups
3880  * 		that are upper in hierarchy than immediate cgroup associated
3881  * 		with the current task.
3882  *
3883  * 		The format of returned id and helper limitations are same as in
3884  * 		**bpf_get_current_cgroup_id**\ ().
3885  * 	Return
3886  * 		The id is returned or 0 in case the id could not be retrieved.
3887  *
3888  * long bpf_sk_assign(struct sk_buff *skb, void *sk, u64 flags)
3889  *	Description
3890  *		Helper is overloaded depending on BPF program type. This
3891  *		description applies to **BPF_PROG_TYPE_SCHED_CLS** and
3892  *		**BPF_PROG_TYPE_SCHED_ACT** programs.
3893  *
3894  *		Assign the *sk* to the *skb*. When combined with appropriate
3895  *		routing configuration to receive the packet towards the socket,
3896  *		will cause *skb* to be delivered to the specified socket.
3897  *		Subsequent redirection of *skb* via  **bpf_redirect**\ (),
3898  *		**bpf_clone_redirect**\ () or other methods outside of BPF may
3899  *		interfere with successful delivery to the socket.
3900  *
3901  *		This operation is only valid from TC ingress path.
3902  *
3903  *		The *flags* argument must be zero.
3904  *	Return
3905  *		0 on success, or a negative error in case of failure:
3906  *
3907  *		**-EINVAL** if specified *flags* are not supported.
3908  *
3909  *		**-ENOENT** if the socket is unavailable for assignment.
3910  *
3911  *		**-ENETUNREACH** if the socket is unreachable (wrong netns).
3912  *
3913  *		**-EOPNOTSUPP** if the operation is not supported, for example
3914  *		a call from outside of TC ingress.
3915  *
3916  *		**-ESOCKTNOSUPPORT** if the socket type is not supported
3917  *		(reuseport).
3918  *
3919  * long bpf_sk_assign(struct bpf_sk_lookup *ctx, struct bpf_sock *sk, u64 flags)
3920  *	Description
3921  *		Helper is overloaded depending on BPF program type. This
3922  *		description applies to **BPF_PROG_TYPE_SK_LOOKUP** programs.
3923  *
3924  *		Select the *sk* as a result of a socket lookup.
3925  *
3926  *		For the operation to succeed passed socket must be compatible
3927  *		with the packet description provided by the *ctx* object.
3928  *
3929  *		L4 protocol (**IPPROTO_TCP** or **IPPROTO_UDP**) must
3930  *		be an exact match. While IP family (**AF_INET** or
3931  *		**AF_INET6**) must be compatible, that is IPv6 sockets
3932  *		that are not v6-only can be selected for IPv4 packets.
3933  *
3934  *		Only TCP listeners and UDP unconnected sockets can be
3935  *		selected. *sk* can also be NULL to reset any previous
3936  *		selection.
3937  *
3938  *		*flags* argument can combination of following values:
3939  *
3940  *		* **BPF_SK_LOOKUP_F_REPLACE** to override the previous
3941  *		  socket selection, potentially done by a BPF program
3942  *		  that ran before us.
3943  *
3944  *		* **BPF_SK_LOOKUP_F_NO_REUSEPORT** to skip
3945  *		  load-balancing within reuseport group for the socket
3946  *		  being selected.
3947  *
3948  *		On success *ctx->sk* will point to the selected socket.
3949  *
3950  *	Return
3951  *		0 on success, or a negative errno in case of failure.
3952  *
3953  *		* **-EAFNOSUPPORT** if socket family (*sk->family*) is
3954  *		  not compatible with packet family (*ctx->family*).
3955  *
3956  *		* **-EEXIST** if socket has been already selected,
3957  *		  potentially by another program, and
3958  *		  **BPF_SK_LOOKUP_F_REPLACE** flag was not specified.
3959  *
3960  *		* **-EINVAL** if unsupported flags were specified.
3961  *
3962  *		* **-EPROTOTYPE** if socket L4 protocol
3963  *		  (*sk->protocol*) doesn't match packet protocol
3964  *		  (*ctx->protocol*).
3965  *
3966  *		* **-ESOCKTNOSUPPORT** if socket is not in allowed
3967  *		  state (TCP listening or UDP unconnected).
3968  *
3969  * u64 bpf_ktime_get_boot_ns(void)
3970  * 	Description
3971  * 		Return the time elapsed since system boot, in nanoseconds.
3972  * 		Does include the time the system was suspended.
3973  * 		See: **clock_gettime**\ (**CLOCK_BOOTTIME**)
3974  * 	Return
3975  * 		Current *ktime*.
3976  *
3977  * long bpf_seq_printf(struct seq_file *m, const char *fmt, u32 fmt_size, const void *data, u32 data_len)
3978  * 	Description
3979  * 		**bpf_seq_printf**\ () uses seq_file **seq_printf**\ () to print
3980  * 		out the format string.
3981  * 		The *m* represents the seq_file. The *fmt* and *fmt_size* are for
3982  * 		the format string itself. The *data* and *data_len* are format string
3983  * 		arguments. The *data* are a **u64** array and corresponding format string
3984  * 		values are stored in the array. For strings and pointers where pointees
3985  * 		are accessed, only the pointer values are stored in the *data* array.
3986  * 		The *data_len* is the size of *data* in bytes.
3987  *
3988  *		Formats **%s**, **%p{i,I}{4,6}** requires to read kernel memory.
3989  *		Reading kernel memory may fail due to either invalid address or
3990  *		valid address but requiring a major memory fault. If reading kernel memory
3991  *		fails, the string for **%s** will be an empty string, and the ip
3992  *		address for **%p{i,I}{4,6}** will be 0. Not returning error to
3993  *		bpf program is consistent with what **bpf_trace_printk**\ () does for now.
3994  * 	Return
3995  * 		0 on success, or a negative error in case of failure:
3996  *
3997  *		**-EBUSY** if per-CPU memory copy buffer is busy, can try again
3998  *		by returning 1 from bpf program.
3999  *
4000  *		**-EINVAL** if arguments are invalid, or if *fmt* is invalid/unsupported.
4001  *
4002  *		**-E2BIG** if *fmt* contains too many format specifiers.
4003  *
4004  *		**-EOVERFLOW** if an overflow happened: The same object will be tried again.
4005  *
4006  * long bpf_seq_write(struct seq_file *m, const void *data, u32 len)
4007  * 	Description
4008  * 		**bpf_seq_write**\ () uses seq_file **seq_write**\ () to write the data.
4009  * 		The *m* represents the seq_file. The *data* and *len* represent the
4010  * 		data to write in bytes.
4011  * 	Return
4012  * 		0 on success, or a negative error in case of failure:
4013  *
4014  *		**-EOVERFLOW** if an overflow happened: The same object will be tried again.
4015  *
4016  * u64 bpf_sk_cgroup_id(void *sk)
4017  *	Description
4018  *		Return the cgroup v2 id of the socket *sk*.
4019  *
4020  *		*sk* must be a non-**NULL** pointer to a socket, e.g. one
4021  *		returned from **bpf_sk_lookup_xxx**\ (),
4022  *		**bpf_sk_fullsock**\ (), etc. The format of returned id is
4023  *		same as in **bpf_skb_cgroup_id**\ ().
4024  *
4025  *		This helper is available only if the kernel was compiled with
4026  *		the **CONFIG_SOCK_CGROUP_DATA** configuration option.
4027  *	Return
4028  *		The id is returned or 0 in case the id could not be retrieved.
4029  *
4030  * u64 bpf_sk_ancestor_cgroup_id(void *sk, int ancestor_level)
4031  *	Description
4032  *		Return id of cgroup v2 that is ancestor of cgroup associated
4033  *		with the *sk* at the *ancestor_level*.  The root cgroup is at
4034  *		*ancestor_level* zero and each step down the hierarchy
4035  *		increments the level. If *ancestor_level* == level of cgroup
4036  *		associated with *sk*, then return value will be same as that
4037  *		of **bpf_sk_cgroup_id**\ ().
4038  *
4039  *		The helper is useful to implement policies based on cgroups
4040  *		that are upper in hierarchy than immediate cgroup associated
4041  *		with *sk*.
4042  *
4043  *		The format of returned id and helper limitations are same as in
4044  *		**bpf_sk_cgroup_id**\ ().
4045  *	Return
4046  *		The id is returned or 0 in case the id could not be retrieved.
4047  *
4048  * long bpf_ringbuf_output(void *ringbuf, void *data, u64 size, u64 flags)
4049  * 	Description
4050  * 		Copy *size* bytes from *data* into a ring buffer *ringbuf*.
4051  * 		If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification
4052  * 		of new data availability is sent.
4053  * 		If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification
4054  * 		of new data availability is sent unconditionally.
4055  * 	Return
4056  * 		0 on success, or a negative error in case of failure.
4057  *
4058  * void *bpf_ringbuf_reserve(void *ringbuf, u64 size, u64 flags)
4059  * 	Description
4060  * 		Reserve *size* bytes of payload in a ring buffer *ringbuf*.
4061  * 	Return
4062  * 		Valid pointer with *size* bytes of memory available; NULL,
4063  * 		otherwise.
4064  *
4065  * void bpf_ringbuf_submit(void *data, u64 flags)
4066  * 	Description
4067  * 		Submit reserved ring buffer sample, pointed to by *data*.
4068  * 		If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification
4069  * 		of new data availability is sent.
4070  * 		If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification
4071  * 		of new data availability is sent unconditionally.
4072  * 	Return
4073  * 		Nothing. Always succeeds.
4074  *
4075  * void bpf_ringbuf_discard(void *data, u64 flags)
4076  * 	Description
4077  * 		Discard reserved ring buffer sample, pointed to by *data*.
4078  * 		If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification
4079  * 		of new data availability is sent.
4080  * 		If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification
4081  * 		of new data availability is sent unconditionally.
4082  * 	Return
4083  * 		Nothing. Always succeeds.
4084  *
4085  * u64 bpf_ringbuf_query(void *ringbuf, u64 flags)
4086  *	Description
4087  *		Query various characteristics of provided ring buffer. What
4088  *		exactly is queries is determined by *flags*:
4089  *
4090  *		* **BPF_RB_AVAIL_DATA**: Amount of data not yet consumed.
4091  *		* **BPF_RB_RING_SIZE**: The size of ring buffer.
4092  *		* **BPF_RB_CONS_POS**: Consumer position (can wrap around).
4093  *		* **BPF_RB_PROD_POS**: Producer(s) position (can wrap around).
4094  *
4095  *		Data returned is just a momentary snapshot of actual values
4096  *		and could be inaccurate, so this facility should be used to
4097  *		power heuristics and for reporting, not to make 100% correct
4098  *		calculation.
4099  *	Return
4100  *		Requested value, or 0, if *flags* are not recognized.
4101  *
4102  * long bpf_csum_level(struct sk_buff *skb, u64 level)
4103  * 	Description
4104  * 		Change the skbs checksum level by one layer up or down, or
4105  * 		reset it entirely to none in order to have the stack perform
4106  * 		checksum validation. The level is applicable to the following
4107  * 		protocols: TCP, UDP, GRE, SCTP, FCOE. For example, a decap of
4108  * 		| ETH | IP | UDP | GUE | IP | TCP | into | ETH | IP | TCP |
4109  * 		through **bpf_skb_adjust_room**\ () helper with passing in
4110  * 		**BPF_F_ADJ_ROOM_NO_CSUM_RESET** flag would require one	call
4111  * 		to **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_DEC** since
4112  * 		the UDP header is removed. Similarly, an encap of the latter
4113  * 		into the former could be accompanied by a helper call to
4114  * 		**bpf_csum_level**\ () with **BPF_CSUM_LEVEL_INC** if the
4115  * 		skb is still intended to be processed in higher layers of the
4116  * 		stack instead of just egressing at tc.
4117  *
4118  * 		There are three supported level settings at this time:
4119  *
4120  * 		* **BPF_CSUM_LEVEL_INC**: Increases skb->csum_level for skbs
4121  * 		  with CHECKSUM_UNNECESSARY.
4122  * 		* **BPF_CSUM_LEVEL_DEC**: Decreases skb->csum_level for skbs
4123  * 		  with CHECKSUM_UNNECESSARY.
4124  * 		* **BPF_CSUM_LEVEL_RESET**: Resets skb->csum_level to 0 and
4125  * 		  sets CHECKSUM_NONE to force checksum validation by the stack.
4126  * 		* **BPF_CSUM_LEVEL_QUERY**: No-op, returns the current
4127  * 		  skb->csum_level.
4128  * 	Return
4129  * 		0 on success, or a negative error in case of failure. In the
4130  * 		case of **BPF_CSUM_LEVEL_QUERY**, the current skb->csum_level
4131  * 		is returned or the error code -EACCES in case the skb is not
4132  * 		subject to CHECKSUM_UNNECESSARY.
4133  *
4134  * struct tcp6_sock *bpf_skc_to_tcp6_sock(void *sk)
4135  *	Description
4136  *		Dynamically cast a *sk* pointer to a *tcp6_sock* pointer.
4137  *	Return
4138  *		*sk* if casting is valid, or **NULL** otherwise.
4139  *
4140  * struct tcp_sock *bpf_skc_to_tcp_sock(void *sk)
4141  *	Description
4142  *		Dynamically cast a *sk* pointer to a *tcp_sock* pointer.
4143  *	Return
4144  *		*sk* if casting is valid, or **NULL** otherwise.
4145  *
4146  * struct tcp_timewait_sock *bpf_skc_to_tcp_timewait_sock(void *sk)
4147  * 	Description
4148  *		Dynamically cast a *sk* pointer to a *tcp_timewait_sock* pointer.
4149  *	Return
4150  *		*sk* if casting is valid, or **NULL** otherwise.
4151  *
4152  * struct tcp_request_sock *bpf_skc_to_tcp_request_sock(void *sk)
4153  * 	Description
4154  *		Dynamically cast a *sk* pointer to a *tcp_request_sock* pointer.
4155  *	Return
4156  *		*sk* if casting is valid, or **NULL** otherwise.
4157  *
4158  * struct udp6_sock *bpf_skc_to_udp6_sock(void *sk)
4159  * 	Description
4160  *		Dynamically cast a *sk* pointer to a *udp6_sock* pointer.
4161  *	Return
4162  *		*sk* if casting is valid, or **NULL** otherwise.
4163  *
4164  * long bpf_get_task_stack(struct task_struct *task, void *buf, u32 size, u64 flags)
4165  *	Description
4166  *		Return a user or a kernel stack in bpf program provided buffer.
4167  *		To achieve this, the helper needs *task*, which is a valid
4168  *		pointer to **struct task_struct**. To store the stacktrace, the
4169  *		bpf program provides *buf* with a nonnegative *size*.
4170  *
4171  *		The last argument, *flags*, holds the number of stack frames to
4172  *		skip (from 0 to 255), masked with
4173  *		**BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
4174  *		the following flags:
4175  *
4176  *		**BPF_F_USER_STACK**
4177  *			Collect a user space stack instead of a kernel stack.
4178  *		**BPF_F_USER_BUILD_ID**
4179  *			Collect buildid+offset instead of ips for user stack,
4180  *			only valid if **BPF_F_USER_STACK** is also specified.
4181  *
4182  *		**bpf_get_task_stack**\ () can collect up to
4183  *		**PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
4184  *		to sufficient large buffer size. Note that
4185  *		this limit can be controlled with the **sysctl** program, and
4186  *		that it should be manually increased in order to profile long
4187  *		user stacks (such as stacks for Java programs). To do so, use:
4188  *
4189  *		::
4190  *
4191  *			# sysctl kernel.perf_event_max_stack=<new value>
4192  *	Return
4193  *		A non-negative value equal to or less than *size* on success,
4194  *		or a negative error in case of failure.
4195  *
4196  * long bpf_load_hdr_opt(struct bpf_sock_ops *skops, void *searchby_res, u32 len, u64 flags)
4197  *	Description
4198  *		Load header option.  Support reading a particular TCP header
4199  *		option for bpf program (**BPF_PROG_TYPE_SOCK_OPS**).
4200  *
4201  *		If *flags* is 0, it will search the option from the
4202  *		*skops*\ **->skb_data**.  The comment in **struct bpf_sock_ops**
4203  *		has details on what skb_data contains under different
4204  *		*skops*\ **->op**.
4205  *
4206  *		The first byte of the *searchby_res* specifies the
4207  *		kind that it wants to search.
4208  *
4209  *		If the searching kind is an experimental kind
4210  *		(i.e. 253 or 254 according to RFC6994).  It also
4211  *		needs to specify the "magic" which is either
4212  *		2 bytes or 4 bytes.  It then also needs to
4213  *		specify the size of the magic by using
4214  *		the 2nd byte which is "kind-length" of a TCP
4215  *		header option and the "kind-length" also
4216  *		includes the first 2 bytes "kind" and "kind-length"
4217  *		itself as a normal TCP header option also does.
4218  *
4219  *		For example, to search experimental kind 254 with
4220  *		2 byte magic 0xeB9F, the searchby_res should be
4221  *		[ 254, 4, 0xeB, 0x9F, 0, 0, .... 0 ].
4222  *
4223  *		To search for the standard window scale option (3),
4224  *		the *searchby_res* should be [ 3, 0, 0, .... 0 ].
4225  *		Note, kind-length must be 0 for regular option.
4226  *
4227  *		Searching for No-Op (0) and End-of-Option-List (1) are
4228  *		not supported.
4229  *
4230  *		*len* must be at least 2 bytes which is the minimal size
4231  *		of a header option.
4232  *
4233  *		Supported flags:
4234  *
4235  *		* **BPF_LOAD_HDR_OPT_TCP_SYN** to search from the
4236  *		  saved_syn packet or the just-received syn packet.
4237  *
4238  *	Return
4239  *		> 0 when found, the header option is copied to *searchby_res*.
4240  *		The return value is the total length copied. On failure, a
4241  *		negative error code is returned:
4242  *
4243  *		**-EINVAL** if a parameter is invalid.
4244  *
4245  *		**-ENOMSG** if the option is not found.
4246  *
4247  *		**-ENOENT** if no syn packet is available when
4248  *		**BPF_LOAD_HDR_OPT_TCP_SYN** is used.
4249  *
4250  *		**-ENOSPC** if there is not enough space.  Only *len* number of
4251  *		bytes are copied.
4252  *
4253  *		**-EFAULT** on failure to parse the header options in the
4254  *		packet.
4255  *
4256  *		**-EPERM** if the helper cannot be used under the current
4257  *		*skops*\ **->op**.
4258  *
4259  * long bpf_store_hdr_opt(struct bpf_sock_ops *skops, const void *from, u32 len, u64 flags)
4260  *	Description
4261  *		Store header option.  The data will be copied
4262  *		from buffer *from* with length *len* to the TCP header.
4263  *
4264  *		The buffer *from* should have the whole option that
4265  *		includes the kind, kind-length, and the actual
4266  *		option data.  The *len* must be at least kind-length
4267  *		long.  The kind-length does not have to be 4 byte
4268  *		aligned.  The kernel will take care of the padding
4269  *		and setting the 4 bytes aligned value to th->doff.
4270  *
4271  *		This helper will check for duplicated option
4272  *		by searching the same option in the outgoing skb.
4273  *
4274  *		This helper can only be called during
4275  *		**BPF_SOCK_OPS_WRITE_HDR_OPT_CB**.
4276  *
4277  *	Return
4278  *		0 on success, or negative error in case of failure:
4279  *
4280  *		**-EINVAL** If param is invalid.
4281  *
4282  *		**-ENOSPC** if there is not enough space in the header.
4283  *		Nothing has been written
4284  *
4285  *		**-EEXIST** if the option already exists.
4286  *
4287  *		**-EFAULT** on failrue to parse the existing header options.
4288  *
4289  *		**-EPERM** if the helper cannot be used under the current
4290  *		*skops*\ **->op**.
4291  *
4292  * long bpf_reserve_hdr_opt(struct bpf_sock_ops *skops, u32 len, u64 flags)
4293  *	Description
4294  *		Reserve *len* bytes for the bpf header option.  The
4295  *		space will be used by **bpf_store_hdr_opt**\ () later in
4296  *		**BPF_SOCK_OPS_WRITE_HDR_OPT_CB**.
4297  *
4298  *		If **bpf_reserve_hdr_opt**\ () is called multiple times,
4299  *		the total number of bytes will be reserved.
4300  *
4301  *		This helper can only be called during
4302  *		**BPF_SOCK_OPS_HDR_OPT_LEN_CB**.
4303  *
4304  *	Return
4305  *		0 on success, or negative error in case of failure:
4306  *
4307  *		**-EINVAL** if a parameter is invalid.
4308  *
4309  *		**-ENOSPC** if there is not enough space in the header.
4310  *
4311  *		**-EPERM** if the helper cannot be used under the current
4312  *		*skops*\ **->op**.
4313  *
4314  * void *bpf_inode_storage_get(struct bpf_map *map, void *inode, void *value, u64 flags)
4315  *	Description
4316  *		Get a bpf_local_storage from an *inode*.
4317  *
4318  *		Logically, it could be thought of as getting the value from
4319  *		a *map* with *inode* as the **key**.  From this
4320  *		perspective,  the usage is not much different from
4321  *		**bpf_map_lookup_elem**\ (*map*, **&**\ *inode*) except this
4322  *		helper enforces the key must be an inode and the map must also
4323  *		be a **BPF_MAP_TYPE_INODE_STORAGE**.
4324  *
4325  *		Underneath, the value is stored locally at *inode* instead of
4326  *		the *map*.  The *map* is used as the bpf-local-storage
4327  *		"type". The bpf-local-storage "type" (i.e. the *map*) is
4328  *		searched against all bpf_local_storage residing at *inode*.
4329  *
4330  *		An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be
4331  *		used such that a new bpf_local_storage will be
4332  *		created if one does not exist.  *value* can be used
4333  *		together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify
4334  *		the initial value of a bpf_local_storage.  If *value* is
4335  *		**NULL**, the new bpf_local_storage will be zero initialized.
4336  *	Return
4337  *		A bpf_local_storage pointer is returned on success.
4338  *
4339  *		**NULL** if not found or there was an error in adding
4340  *		a new bpf_local_storage.
4341  *
4342  * int bpf_inode_storage_delete(struct bpf_map *map, void *inode)
4343  *	Description
4344  *		Delete a bpf_local_storage from an *inode*.
4345  *	Return
4346  *		0 on success.
4347  *
4348  *		**-ENOENT** if the bpf_local_storage cannot be found.
4349  *
4350  * long bpf_d_path(struct path *path, char *buf, u32 sz)
4351  *	Description
4352  *		Return full path for given **struct path** object, which
4353  *		needs to be the kernel BTF *path* object. The path is
4354  *		returned in the provided buffer *buf* of size *sz* and
4355  *		is zero terminated.
4356  *
4357  *	Return
4358  *		On success, the strictly positive length of the string,
4359  *		including the trailing NUL character. On error, a negative
4360  *		value.
4361  *
4362  * long bpf_copy_from_user(void *dst, u32 size, const void *user_ptr)
4363  * 	Description
4364  * 		Read *size* bytes from user space address *user_ptr* and store
4365  * 		the data in *dst*. This is a wrapper of **copy_from_user**\ ().
4366  * 	Return
4367  * 		0 on success, or a negative error in case of failure.
4368  *
4369  * long bpf_snprintf_btf(char *str, u32 str_size, struct btf_ptr *ptr, u32 btf_ptr_size, u64 flags)
4370  *	Description
4371  *		Use BTF to store a string representation of *ptr*->ptr in *str*,
4372  *		using *ptr*->type_id.  This value should specify the type
4373  *		that *ptr*->ptr points to. LLVM __builtin_btf_type_id(type, 1)
4374  *		can be used to look up vmlinux BTF type ids. Traversing the
4375  *		data structure using BTF, the type information and values are
4376  *		stored in the first *str_size* - 1 bytes of *str*.  Safe copy of
4377  *		the pointer data is carried out to avoid kernel crashes during
4378  *		operation.  Smaller types can use string space on the stack;
4379  *		larger programs can use map data to store the string
4380  *		representation.
4381  *
4382  *		The string can be subsequently shared with userspace via
4383  *		bpf_perf_event_output() or ring buffer interfaces.
4384  *		bpf_trace_printk() is to be avoided as it places too small
4385  *		a limit on string size to be useful.
4386  *
4387  *		*flags* is a combination of
4388  *
4389  *		**BTF_F_COMPACT**
4390  *			no formatting around type information
4391  *		**BTF_F_NONAME**
4392  *			no struct/union member names/types
4393  *		**BTF_F_PTR_RAW**
4394  *			show raw (unobfuscated) pointer values;
4395  *			equivalent to printk specifier %px.
4396  *		**BTF_F_ZERO**
4397  *			show zero-valued struct/union members; they
4398  *			are not displayed by default
4399  *
4400  *	Return
4401  *		The number of bytes that were written (or would have been
4402  *		written if output had to be truncated due to string size),
4403  *		or a negative error in cases of failure.
4404  *
4405  * long bpf_seq_printf_btf(struct seq_file *m, struct btf_ptr *ptr, u32 ptr_size, u64 flags)
4406  *	Description
4407  *		Use BTF to write to seq_write a string representation of
4408  *		*ptr*->ptr, using *ptr*->type_id as per bpf_snprintf_btf().
4409  *		*flags* are identical to those used for bpf_snprintf_btf.
4410  *	Return
4411  *		0 on success or a negative error in case of failure.
4412  *
4413  * u64 bpf_skb_cgroup_classid(struct sk_buff *skb)
4414  * 	Description
4415  * 		See **bpf_get_cgroup_classid**\ () for the main description.
4416  * 		This helper differs from **bpf_get_cgroup_classid**\ () in that
4417  * 		the cgroup v1 net_cls class is retrieved only from the *skb*'s
4418  * 		associated socket instead of the current process.
4419  * 	Return
4420  * 		The id is returned or 0 in case the id could not be retrieved.
4421  *
4422  * long bpf_redirect_neigh(u32 ifindex, struct bpf_redir_neigh *params, int plen, u64 flags)
4423  * 	Description
4424  * 		Redirect the packet to another net device of index *ifindex*
4425  * 		and fill in L2 addresses from neighboring subsystem. This helper
4426  * 		is somewhat similar to **bpf_redirect**\ (), except that it
4427  * 		populates L2 addresses as well, meaning, internally, the helper
4428  * 		relies on the neighbor lookup for the L2 address of the nexthop.
4429  *
4430  * 		The helper will perform a FIB lookup based on the skb's
4431  * 		networking header to get the address of the next hop, unless
4432  * 		this is supplied by the caller in the *params* argument. The
4433  * 		*plen* argument indicates the len of *params* and should be set
4434  * 		to 0 if *params* is NULL.
4435  *
4436  * 		The *flags* argument is reserved and must be 0. The helper is
4437  * 		currently only supported for tc BPF program types, and enabled
4438  * 		for IPv4 and IPv6 protocols.
4439  * 	Return
4440  * 		The helper returns **TC_ACT_REDIRECT** on success or
4441  * 		**TC_ACT_SHOT** on error.
4442  *
4443  * void *bpf_per_cpu_ptr(const void *percpu_ptr, u32 cpu)
4444  *     Description
4445  *             Take a pointer to a percpu ksym, *percpu_ptr*, and return a
4446  *             pointer to the percpu kernel variable on *cpu*. A ksym is an
4447  *             extern variable decorated with '__ksym'. For ksym, there is a
4448  *             global var (either static or global) defined of the same name
4449  *             in the kernel. The ksym is percpu if the global var is percpu.
4450  *             The returned pointer points to the global percpu var on *cpu*.
4451  *
4452  *             bpf_per_cpu_ptr() has the same semantic as per_cpu_ptr() in the
4453  *             kernel, except that bpf_per_cpu_ptr() may return NULL. This
4454  *             happens if *cpu* is larger than nr_cpu_ids. The caller of
4455  *             bpf_per_cpu_ptr() must check the returned value.
4456  *     Return
4457  *             A pointer pointing to the kernel percpu variable on *cpu*, or
4458  *             NULL, if *cpu* is invalid.
4459  *
4460  * void *bpf_this_cpu_ptr(const void *percpu_ptr)
4461  *	Description
4462  *		Take a pointer to a percpu ksym, *percpu_ptr*, and return a
4463  *		pointer to the percpu kernel variable on this cpu. See the
4464  *		description of 'ksym' in **bpf_per_cpu_ptr**\ ().
4465  *
4466  *		bpf_this_cpu_ptr() has the same semantic as this_cpu_ptr() in
4467  *		the kernel. Different from **bpf_per_cpu_ptr**\ (), it would
4468  *		never return NULL.
4469  *	Return
4470  *		A pointer pointing to the kernel percpu variable on this cpu.
4471  *
4472  * long bpf_redirect_peer(u32 ifindex, u64 flags)
4473  * 	Description
4474  * 		Redirect the packet to another net device of index *ifindex*.
4475  * 		This helper is somewhat similar to **bpf_redirect**\ (), except
4476  * 		that the redirection happens to the *ifindex*' peer device and
4477  * 		the netns switch takes place from ingress to ingress without
4478  * 		going through the CPU's backlog queue.
4479  *
4480  * 		The *flags* argument is reserved and must be 0. The helper is
4481  * 		currently only supported for tc BPF program types at the ingress
4482  * 		hook and for veth device types. The peer device must reside in a
4483  * 		different network namespace.
4484  * 	Return
4485  * 		The helper returns **TC_ACT_REDIRECT** on success or
4486  * 		**TC_ACT_SHOT** on error.
4487  *
4488  * void *bpf_task_storage_get(struct bpf_map *map, struct task_struct *task, void *value, u64 flags)
4489  *	Description
4490  *		Get a bpf_local_storage from the *task*.
4491  *
4492  *		Logically, it could be thought of as getting the value from
4493  *		a *map* with *task* as the **key**.  From this
4494  *		perspective,  the usage is not much different from
4495  *		**bpf_map_lookup_elem**\ (*map*, **&**\ *task*) except this
4496  *		helper enforces the key must be an task_struct and the map must also
4497  *		be a **BPF_MAP_TYPE_TASK_STORAGE**.
4498  *
4499  *		Underneath, the value is stored locally at *task* instead of
4500  *		the *map*.  The *map* is used as the bpf-local-storage
4501  *		"type". The bpf-local-storage "type" (i.e. the *map*) is
4502  *		searched against all bpf_local_storage residing at *task*.
4503  *
4504  *		An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be
4505  *		used such that a new bpf_local_storage will be
4506  *		created if one does not exist.  *value* can be used
4507  *		together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify
4508  *		the initial value of a bpf_local_storage.  If *value* is
4509  *		**NULL**, the new bpf_local_storage will be zero initialized.
4510  *	Return
4511  *		A bpf_local_storage pointer is returned on success.
4512  *
4513  *		**NULL** if not found or there was an error in adding
4514  *		a new bpf_local_storage.
4515  *
4516  * long bpf_task_storage_delete(struct bpf_map *map, struct task_struct *task)
4517  *	Description
4518  *		Delete a bpf_local_storage from a *task*.
4519  *	Return
4520  *		0 on success.
4521  *
4522  *		**-ENOENT** if the bpf_local_storage cannot be found.
4523  *
4524  * struct task_struct *bpf_get_current_task_btf(void)
4525  *	Description
4526  *		Return a BTF pointer to the "current" task.
4527  *		This pointer can also be used in helpers that accept an
4528  *		*ARG_PTR_TO_BTF_ID* of type *task_struct*.
4529  *	Return
4530  *		Pointer to the current task.
4531  *
4532  * long bpf_bprm_opts_set(struct linux_binprm *bprm, u64 flags)
4533  *	Description
4534  *		Set or clear certain options on *bprm*:
4535  *
4536  *		**BPF_F_BPRM_SECUREEXEC** Set the secureexec bit
4537  *		which sets the **AT_SECURE** auxv for glibc. The bit
4538  *		is cleared if the flag is not specified.
4539  *	Return
4540  *		**-EINVAL** if invalid *flags* are passed, zero otherwise.
4541  *
4542  * u64 bpf_ktime_get_coarse_ns(void)
4543  * 	Description
4544  * 		Return a coarse-grained version of the time elapsed since
4545  * 		system boot, in nanoseconds. Does not include time the system
4546  * 		was suspended.
4547  *
4548  * 		See: **clock_gettime**\ (**CLOCK_MONOTONIC_COARSE**)
4549  * 	Return
4550  * 		Current *ktime*.
4551  *
4552  * long bpf_ima_inode_hash(struct inode *inode, void *dst, u32 size)
4553  *	Description
4554  *		Returns the stored IMA hash of the *inode* (if it's avaialable).
4555  *		If the hash is larger than *size*, then only *size*
4556  *		bytes will be copied to *dst*
4557  *	Return
4558  *		The **hash_algo** is returned on success,
4559  *		**-EOPNOTSUP** if IMA is disabled or **-EINVAL** if
4560  *		invalid arguments are passed.
4561  *
4562  * struct socket *bpf_sock_from_file(struct file *file)
4563  *	Description
4564  *		If the given file represents a socket, returns the associated
4565  *		socket.
4566  *	Return
4567  *		A pointer to a struct socket on success or NULL if the file is
4568  *		not a socket.
4569  *
4570  * long bpf_check_mtu(void *ctx, u32 ifindex, u32 *mtu_len, s32 len_diff, u64 flags)
4571  *	Description
4572  *		Check ctx packet size against exceeding MTU of net device (based
4573  *		on *ifindex*).  This helper will likely be used in combination
4574  *		with helpers that adjust/change the packet size.
4575  *
4576  *		The argument *len_diff* can be used for querying with a planned
4577  *		size change. This allows to check MTU prior to changing packet
4578  *		ctx. Providing an *len_diff* adjustment that is larger than the
4579  *		actual packet size (resulting in negative packet size) will in
4580  *		principle not exceed the MTU, why it is not considered a
4581  *		failure.  Other BPF-helpers are needed for performing the
4582  *		planned size change, why the responsability for catch a negative
4583  *		packet size belong in those helpers.
4584  *
4585  *		Specifying *ifindex* zero means the MTU check is performed
4586  *		against the current net device.  This is practical if this isn't
4587  *		used prior to redirect.
4588  *
4589  *		The Linux kernel route table can configure MTUs on a more
4590  *		specific per route level, which is not provided by this helper.
4591  *		For route level MTU checks use the **bpf_fib_lookup**\ ()
4592  *		helper.
4593  *
4594  *		*ctx* is either **struct xdp_md** for XDP programs or
4595  *		**struct sk_buff** for tc cls_act programs.
4596  *
4597  *		The *flags* argument can be a combination of one or more of the
4598  *		following values:
4599  *
4600  *		**BPF_MTU_CHK_SEGS**
4601  *			This flag will only works for *ctx* **struct sk_buff**.
4602  *			If packet context contains extra packet segment buffers
4603  *			(often knows as GSO skb), then MTU check is harder to
4604  *			check at this point, because in transmit path it is
4605  *			possible for the skb packet to get re-segmented
4606  *			(depending on net device features).  This could still be
4607  *			a MTU violation, so this flag enables performing MTU
4608  *			check against segments, with a different violation
4609  *			return code to tell it apart. Check cannot use len_diff.
4610  *
4611  *		On return *mtu_len* pointer contains the MTU value of the net
4612  *		device.  Remember the net device configured MTU is the L3 size,
4613  *		which is returned here and XDP and TX length operate at L2.
4614  *		Helper take this into account for you, but remember when using
4615  *		MTU value in your BPF-code.  On input *mtu_len* must be a valid
4616  *		pointer and be initialized (to zero), else verifier will reject
4617  *		BPF program.
4618  *
4619  *	Return
4620  *		* 0 on success, and populate MTU value in *mtu_len* pointer.
4621  *
4622  *		* < 0 if any input argument is invalid (*mtu_len* not updated)
4623  *
4624  *		MTU violations return positive values, but also populate MTU
4625  *		value in *mtu_len* pointer, as this can be needed for
4626  *		implementing PMTU handing:
4627  *
4628  *		* **BPF_MTU_CHK_RET_FRAG_NEEDED**
4629  *		* **BPF_MTU_CHK_RET_SEGS_TOOBIG**
4630  *
4631  * long bpf_for_each_map_elem(struct bpf_map *map, void *callback_fn, void *callback_ctx, u64 flags)
4632  *	Description
4633  *		For each element in **map**, call **callback_fn** function with
4634  *		**map**, **callback_ctx** and other map-specific parameters.
4635  *		The **callback_fn** should be a static function and
4636  *		the **callback_ctx** should be a pointer to the stack.
4637  *		The **flags** is used to control certain aspects of the helper.
4638  *		Currently, the **flags** must be 0.
4639  *
4640  *		The following are a list of supported map types and their
4641  *		respective expected callback signatures:
4642  *
4643  *		BPF_MAP_TYPE_HASH, BPF_MAP_TYPE_PERCPU_HASH,
4644  *		BPF_MAP_TYPE_LRU_HASH, BPF_MAP_TYPE_LRU_PERCPU_HASH,
4645  *		BPF_MAP_TYPE_ARRAY, BPF_MAP_TYPE_PERCPU_ARRAY
4646  *
4647  *		long (\*callback_fn)(struct bpf_map \*map, const void \*key, void \*value, void \*ctx);
4648  *
4649  *		For per_cpu maps, the map_value is the value on the cpu where the
4650  *		bpf_prog is running.
4651  *
4652  *		If **callback_fn** return 0, the helper will continue to the next
4653  *		element. If return value is 1, the helper will skip the rest of
4654  *		elements and return. Other return values are not used now.
4655  *
4656  *	Return
4657  *		The number of traversed map elements for success, **-EINVAL** for
4658  *		invalid **flags**.
4659  */
4660 #define __BPF_FUNC_MAPPER(FN)		\
4661 	FN(unspec),			\
4662 	FN(map_lookup_elem),		\
4663 	FN(map_update_elem),		\
4664 	FN(map_delete_elem),		\
4665 	FN(probe_read),			\
4666 	FN(ktime_get_ns),		\
4667 	FN(trace_printk),		\
4668 	FN(get_prandom_u32),		\
4669 	FN(get_smp_processor_id),	\
4670 	FN(skb_store_bytes),		\
4671 	FN(l3_csum_replace),		\
4672 	FN(l4_csum_replace),		\
4673 	FN(tail_call),			\
4674 	FN(clone_redirect),		\
4675 	FN(get_current_pid_tgid),	\
4676 	FN(get_current_uid_gid),	\
4677 	FN(get_current_comm),		\
4678 	FN(get_cgroup_classid),		\
4679 	FN(skb_vlan_push),		\
4680 	FN(skb_vlan_pop),		\
4681 	FN(skb_get_tunnel_key),		\
4682 	FN(skb_set_tunnel_key),		\
4683 	FN(perf_event_read),		\
4684 	FN(redirect),			\
4685 	FN(get_route_realm),		\
4686 	FN(perf_event_output),		\
4687 	FN(skb_load_bytes),		\
4688 	FN(get_stackid),		\
4689 	FN(csum_diff),			\
4690 	FN(skb_get_tunnel_opt),		\
4691 	FN(skb_set_tunnel_opt),		\
4692 	FN(skb_change_proto),		\
4693 	FN(skb_change_type),		\
4694 	FN(skb_under_cgroup),		\
4695 	FN(get_hash_recalc),		\
4696 	FN(get_current_task),		\
4697 	FN(probe_write_user),		\
4698 	FN(current_task_under_cgroup),	\
4699 	FN(skb_change_tail),		\
4700 	FN(skb_pull_data),		\
4701 	FN(csum_update),		\
4702 	FN(set_hash_invalid),		\
4703 	FN(get_numa_node_id),		\
4704 	FN(skb_change_head),		\
4705 	FN(xdp_adjust_head),		\
4706 	FN(probe_read_str),		\
4707 	FN(get_socket_cookie),		\
4708 	FN(get_socket_uid),		\
4709 	FN(set_hash),			\
4710 	FN(setsockopt),			\
4711 	FN(skb_adjust_room),		\
4712 	FN(redirect_map),		\
4713 	FN(sk_redirect_map),		\
4714 	FN(sock_map_update),		\
4715 	FN(xdp_adjust_meta),		\
4716 	FN(perf_event_read_value),	\
4717 	FN(perf_prog_read_value),	\
4718 	FN(getsockopt),			\
4719 	FN(override_return),		\
4720 	FN(sock_ops_cb_flags_set),	\
4721 	FN(msg_redirect_map),		\
4722 	FN(msg_apply_bytes),		\
4723 	FN(msg_cork_bytes),		\
4724 	FN(msg_pull_data),		\
4725 	FN(bind),			\
4726 	FN(xdp_adjust_tail),		\
4727 	FN(skb_get_xfrm_state),		\
4728 	FN(get_stack),			\
4729 	FN(skb_load_bytes_relative),	\
4730 	FN(fib_lookup),			\
4731 	FN(sock_hash_update),		\
4732 	FN(msg_redirect_hash),		\
4733 	FN(sk_redirect_hash),		\
4734 	FN(lwt_push_encap),		\
4735 	FN(lwt_seg6_store_bytes),	\
4736 	FN(lwt_seg6_adjust_srh),	\
4737 	FN(lwt_seg6_action),		\
4738 	FN(rc_repeat),			\
4739 	FN(rc_keydown),			\
4740 	FN(skb_cgroup_id),		\
4741 	FN(get_current_cgroup_id),	\
4742 	FN(get_local_storage),		\
4743 	FN(sk_select_reuseport),	\
4744 	FN(skb_ancestor_cgroup_id),	\
4745 	FN(sk_lookup_tcp),		\
4746 	FN(sk_lookup_udp),		\
4747 	FN(sk_release),			\
4748 	FN(map_push_elem),		\
4749 	FN(map_pop_elem),		\
4750 	FN(map_peek_elem),		\
4751 	FN(msg_push_data),		\
4752 	FN(msg_pop_data),		\
4753 	FN(rc_pointer_rel),		\
4754 	FN(spin_lock),			\
4755 	FN(spin_unlock),		\
4756 	FN(sk_fullsock),		\
4757 	FN(tcp_sock),			\
4758 	FN(skb_ecn_set_ce),		\
4759 	FN(get_listener_sock),		\
4760 	FN(skc_lookup_tcp),		\
4761 	FN(tcp_check_syncookie),	\
4762 	FN(sysctl_get_name),		\
4763 	FN(sysctl_get_current_value),	\
4764 	FN(sysctl_get_new_value),	\
4765 	FN(sysctl_set_new_value),	\
4766 	FN(strtol),			\
4767 	FN(strtoul),			\
4768 	FN(sk_storage_get),		\
4769 	FN(sk_storage_delete),		\
4770 	FN(send_signal),		\
4771 	FN(tcp_gen_syncookie),		\
4772 	FN(skb_output),			\
4773 	FN(probe_read_user),		\
4774 	FN(probe_read_kernel),		\
4775 	FN(probe_read_user_str),	\
4776 	FN(probe_read_kernel_str),	\
4777 	FN(tcp_send_ack),		\
4778 	FN(send_signal_thread),		\
4779 	FN(jiffies64),			\
4780 	FN(read_branch_records),	\
4781 	FN(get_ns_current_pid_tgid),	\
4782 	FN(xdp_output),			\
4783 	FN(get_netns_cookie),		\
4784 	FN(get_current_ancestor_cgroup_id),	\
4785 	FN(sk_assign),			\
4786 	FN(ktime_get_boot_ns),		\
4787 	FN(seq_printf),			\
4788 	FN(seq_write),			\
4789 	FN(sk_cgroup_id),		\
4790 	FN(sk_ancestor_cgroup_id),	\
4791 	FN(ringbuf_output),		\
4792 	FN(ringbuf_reserve),		\
4793 	FN(ringbuf_submit),		\
4794 	FN(ringbuf_discard),		\
4795 	FN(ringbuf_query),		\
4796 	FN(csum_level),			\
4797 	FN(skc_to_tcp6_sock),		\
4798 	FN(skc_to_tcp_sock),		\
4799 	FN(skc_to_tcp_timewait_sock),	\
4800 	FN(skc_to_tcp_request_sock),	\
4801 	FN(skc_to_udp6_sock),		\
4802 	FN(get_task_stack),		\
4803 	FN(load_hdr_opt),		\
4804 	FN(store_hdr_opt),		\
4805 	FN(reserve_hdr_opt),		\
4806 	FN(inode_storage_get),		\
4807 	FN(inode_storage_delete),	\
4808 	FN(d_path),			\
4809 	FN(copy_from_user),		\
4810 	FN(snprintf_btf),		\
4811 	FN(seq_printf_btf),		\
4812 	FN(skb_cgroup_classid),		\
4813 	FN(redirect_neigh),		\
4814 	FN(per_cpu_ptr),		\
4815 	FN(this_cpu_ptr),		\
4816 	FN(redirect_peer),		\
4817 	FN(task_storage_get),		\
4818 	FN(task_storage_delete),	\
4819 	FN(get_current_task_btf),	\
4820 	FN(bprm_opts_set),		\
4821 	FN(ktime_get_coarse_ns),	\
4822 	FN(ima_inode_hash),		\
4823 	FN(sock_from_file),		\
4824 	FN(check_mtu),			\
4825 	FN(for_each_map_elem),		\
4826 	/* */
4827 
4828 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
4829  * function eBPF program intends to call
4830  */
4831 #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
4832 enum bpf_func_id {
4833 	__BPF_FUNC_MAPPER(__BPF_ENUM_FN)
4834 	__BPF_FUNC_MAX_ID,
4835 };
4836 #undef __BPF_ENUM_FN
4837 
4838 /* All flags used by eBPF helper functions, placed here. */
4839 
4840 /* BPF_FUNC_skb_store_bytes flags. */
4841 enum {
4842 	BPF_F_RECOMPUTE_CSUM		= (1ULL << 0),
4843 	BPF_F_INVALIDATE_HASH		= (1ULL << 1),
4844 };
4845 
4846 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
4847  * First 4 bits are for passing the header field size.
4848  */
4849 enum {
4850 	BPF_F_HDR_FIELD_MASK		= 0xfULL,
4851 };
4852 
4853 /* BPF_FUNC_l4_csum_replace flags. */
4854 enum {
4855 	BPF_F_PSEUDO_HDR		= (1ULL << 4),
4856 	BPF_F_MARK_MANGLED_0		= (1ULL << 5),
4857 	BPF_F_MARK_ENFORCE		= (1ULL << 6),
4858 };
4859 
4860 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
4861 enum {
4862 	BPF_F_INGRESS			= (1ULL << 0),
4863 };
4864 
4865 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
4866 enum {
4867 	BPF_F_TUNINFO_IPV6		= (1ULL << 0),
4868 };
4869 
4870 /* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */
4871 enum {
4872 	BPF_F_SKIP_FIELD_MASK		= 0xffULL,
4873 	BPF_F_USER_STACK		= (1ULL << 8),
4874 /* flags used by BPF_FUNC_get_stackid only. */
4875 	BPF_F_FAST_STACK_CMP		= (1ULL << 9),
4876 	BPF_F_REUSE_STACKID		= (1ULL << 10),
4877 /* flags used by BPF_FUNC_get_stack only. */
4878 	BPF_F_USER_BUILD_ID		= (1ULL << 11),
4879 };
4880 
4881 /* BPF_FUNC_skb_set_tunnel_key flags. */
4882 enum {
4883 	BPF_F_ZERO_CSUM_TX		= (1ULL << 1),
4884 	BPF_F_DONT_FRAGMENT		= (1ULL << 2),
4885 	BPF_F_SEQ_NUMBER		= (1ULL << 3),
4886 };
4887 
4888 /* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and
4889  * BPF_FUNC_perf_event_read_value flags.
4890  */
4891 enum {
4892 	BPF_F_INDEX_MASK		= 0xffffffffULL,
4893 	BPF_F_CURRENT_CPU		= BPF_F_INDEX_MASK,
4894 /* BPF_FUNC_perf_event_output for sk_buff input context. */
4895 	BPF_F_CTXLEN_MASK		= (0xfffffULL << 32),
4896 };
4897 
4898 /* Current network namespace */
4899 enum {
4900 	BPF_F_CURRENT_NETNS		= (-1L),
4901 };
4902 
4903 /* BPF_FUNC_csum_level level values. */
4904 enum {
4905 	BPF_CSUM_LEVEL_QUERY,
4906 	BPF_CSUM_LEVEL_INC,
4907 	BPF_CSUM_LEVEL_DEC,
4908 	BPF_CSUM_LEVEL_RESET,
4909 };
4910 
4911 /* BPF_FUNC_skb_adjust_room flags. */
4912 enum {
4913 	BPF_F_ADJ_ROOM_FIXED_GSO	= (1ULL << 0),
4914 	BPF_F_ADJ_ROOM_ENCAP_L3_IPV4	= (1ULL << 1),
4915 	BPF_F_ADJ_ROOM_ENCAP_L3_IPV6	= (1ULL << 2),
4916 	BPF_F_ADJ_ROOM_ENCAP_L4_GRE	= (1ULL << 3),
4917 	BPF_F_ADJ_ROOM_ENCAP_L4_UDP	= (1ULL << 4),
4918 	BPF_F_ADJ_ROOM_NO_CSUM_RESET	= (1ULL << 5),
4919 };
4920 
4921 enum {
4922 	BPF_ADJ_ROOM_ENCAP_L2_MASK	= 0xff,
4923 	BPF_ADJ_ROOM_ENCAP_L2_SHIFT	= 56,
4924 };
4925 
4926 #define BPF_F_ADJ_ROOM_ENCAP_L2(len)	(((__u64)len & \
4927 					  BPF_ADJ_ROOM_ENCAP_L2_MASK) \
4928 					 << BPF_ADJ_ROOM_ENCAP_L2_SHIFT)
4929 
4930 /* BPF_FUNC_sysctl_get_name flags. */
4931 enum {
4932 	BPF_F_SYSCTL_BASE_NAME		= (1ULL << 0),
4933 };
4934 
4935 /* BPF_FUNC_<kernel_obj>_storage_get flags */
4936 enum {
4937 	BPF_LOCAL_STORAGE_GET_F_CREATE	= (1ULL << 0),
4938 	/* BPF_SK_STORAGE_GET_F_CREATE is only kept for backward compatibility
4939 	 * and BPF_LOCAL_STORAGE_GET_F_CREATE must be used instead.
4940 	 */
4941 	BPF_SK_STORAGE_GET_F_CREATE  = BPF_LOCAL_STORAGE_GET_F_CREATE,
4942 };
4943 
4944 /* BPF_FUNC_read_branch_records flags. */
4945 enum {
4946 	BPF_F_GET_BRANCH_RECORDS_SIZE	= (1ULL << 0),
4947 };
4948 
4949 /* BPF_FUNC_bpf_ringbuf_commit, BPF_FUNC_bpf_ringbuf_discard, and
4950  * BPF_FUNC_bpf_ringbuf_output flags.
4951  */
4952 enum {
4953 	BPF_RB_NO_WAKEUP		= (1ULL << 0),
4954 	BPF_RB_FORCE_WAKEUP		= (1ULL << 1),
4955 };
4956 
4957 /* BPF_FUNC_bpf_ringbuf_query flags */
4958 enum {
4959 	BPF_RB_AVAIL_DATA = 0,
4960 	BPF_RB_RING_SIZE = 1,
4961 	BPF_RB_CONS_POS = 2,
4962 	BPF_RB_PROD_POS = 3,
4963 };
4964 
4965 /* BPF ring buffer constants */
4966 enum {
4967 	BPF_RINGBUF_BUSY_BIT		= (1U << 31),
4968 	BPF_RINGBUF_DISCARD_BIT		= (1U << 30),
4969 	BPF_RINGBUF_HDR_SZ		= 8,
4970 };
4971 
4972 /* BPF_FUNC_sk_assign flags in bpf_sk_lookup context. */
4973 enum {
4974 	BPF_SK_LOOKUP_F_REPLACE		= (1ULL << 0),
4975 	BPF_SK_LOOKUP_F_NO_REUSEPORT	= (1ULL << 1),
4976 };
4977 
4978 /* Mode for BPF_FUNC_skb_adjust_room helper. */
4979 enum bpf_adj_room_mode {
4980 	BPF_ADJ_ROOM_NET,
4981 	BPF_ADJ_ROOM_MAC,
4982 };
4983 
4984 /* Mode for BPF_FUNC_skb_load_bytes_relative helper. */
4985 enum bpf_hdr_start_off {
4986 	BPF_HDR_START_MAC,
4987 	BPF_HDR_START_NET,
4988 };
4989 
4990 /* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */
4991 enum bpf_lwt_encap_mode {
4992 	BPF_LWT_ENCAP_SEG6,
4993 	BPF_LWT_ENCAP_SEG6_INLINE,
4994 	BPF_LWT_ENCAP_IP,
4995 };
4996 
4997 /* Flags for bpf_bprm_opts_set helper */
4998 enum {
4999 	BPF_F_BPRM_SECUREEXEC	= (1ULL << 0),
5000 };
5001 
5002 #define __bpf_md_ptr(type, name)	\
5003 union {					\
5004 	type name;			\
5005 	__u64 :64;			\
5006 } __attribute__((aligned(8)))
5007 
5008 /* user accessible mirror of in-kernel sk_buff.
5009  * new fields can only be added to the end of this structure
5010  */
5011 struct __sk_buff {
5012 	__u32 len;
5013 	__u32 pkt_type;
5014 	__u32 mark;
5015 	__u32 queue_mapping;
5016 	__u32 protocol;
5017 	__u32 vlan_present;
5018 	__u32 vlan_tci;
5019 	__u32 vlan_proto;
5020 	__u32 priority;
5021 	__u32 ingress_ifindex;
5022 	__u32 ifindex;
5023 	__u32 tc_index;
5024 	__u32 cb[5];
5025 	__u32 hash;
5026 	__u32 tc_classid;
5027 	__u32 data;
5028 	__u32 data_end;
5029 	__u32 napi_id;
5030 
5031 	/* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */
5032 	__u32 family;
5033 	__u32 remote_ip4;	/* Stored in network byte order */
5034 	__u32 local_ip4;	/* Stored in network byte order */
5035 	__u32 remote_ip6[4];	/* Stored in network byte order */
5036 	__u32 local_ip6[4];	/* Stored in network byte order */
5037 	__u32 remote_port;	/* Stored in network byte order */
5038 	__u32 local_port;	/* stored in host byte order */
5039 	/* ... here. */
5040 
5041 	__u32 data_meta;
5042 	__bpf_md_ptr(struct bpf_flow_keys *, flow_keys);
5043 	__u64 tstamp;
5044 	__u32 wire_len;
5045 	__u32 gso_segs;
5046 	__bpf_md_ptr(struct bpf_sock *, sk);
5047 	__u32 gso_size;
5048 };
5049 
5050 struct bpf_tunnel_key {
5051 	__u32 tunnel_id;
5052 	union {
5053 		__u32 remote_ipv4;
5054 		__u32 remote_ipv6[4];
5055 	};
5056 	__u8 tunnel_tos;
5057 	__u8 tunnel_ttl;
5058 	__u16 tunnel_ext;	/* Padding, future use. */
5059 	__u32 tunnel_label;
5060 };
5061 
5062 /* user accessible mirror of in-kernel xfrm_state.
5063  * new fields can only be added to the end of this structure
5064  */
5065 struct bpf_xfrm_state {
5066 	__u32 reqid;
5067 	__u32 spi;	/* Stored in network byte order */
5068 	__u16 family;
5069 	__u16 ext;	/* Padding, future use. */
5070 	union {
5071 		__u32 remote_ipv4;	/* Stored in network byte order */
5072 		__u32 remote_ipv6[4];	/* Stored in network byte order */
5073 	};
5074 };
5075 
5076 /* Generic BPF return codes which all BPF program types may support.
5077  * The values are binary compatible with their TC_ACT_* counter-part to
5078  * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
5079  * programs.
5080  *
5081  * XDP is handled seprately, see XDP_*.
5082  */
5083 enum bpf_ret_code {
5084 	BPF_OK = 0,
5085 	/* 1 reserved */
5086 	BPF_DROP = 2,
5087 	/* 3-6 reserved */
5088 	BPF_REDIRECT = 7,
5089 	/* >127 are reserved for prog type specific return codes.
5090 	 *
5091 	 * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and
5092 	 *    BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been
5093 	 *    changed and should be routed based on its new L3 header.
5094 	 *    (This is an L3 redirect, as opposed to L2 redirect
5095 	 *    represented by BPF_REDIRECT above).
5096 	 */
5097 	BPF_LWT_REROUTE = 128,
5098 };
5099 
5100 struct bpf_sock {
5101 	__u32 bound_dev_if;
5102 	__u32 family;
5103 	__u32 type;
5104 	__u32 protocol;
5105 	__u32 mark;
5106 	__u32 priority;
5107 	/* IP address also allows 1 and 2 bytes access */
5108 	__u32 src_ip4;
5109 	__u32 src_ip6[4];
5110 	__u32 src_port;		/* host byte order */
5111 	__u32 dst_port;		/* network byte order */
5112 	__u32 dst_ip4;
5113 	__u32 dst_ip6[4];
5114 	__u32 state;
5115 	__s32 rx_queue_mapping;
5116 };
5117 
5118 struct bpf_tcp_sock {
5119 	__u32 snd_cwnd;		/* Sending congestion window		*/
5120 	__u32 srtt_us;		/* smoothed round trip time << 3 in usecs */
5121 	__u32 rtt_min;
5122 	__u32 snd_ssthresh;	/* Slow start size threshold		*/
5123 	__u32 rcv_nxt;		/* What we want to receive next		*/
5124 	__u32 snd_nxt;		/* Next sequence we send		*/
5125 	__u32 snd_una;		/* First byte we want an ack for	*/
5126 	__u32 mss_cache;	/* Cached effective mss, not including SACKS */
5127 	__u32 ecn_flags;	/* ECN status bits.			*/
5128 	__u32 rate_delivered;	/* saved rate sample: packets delivered */
5129 	__u32 rate_interval_us;	/* saved rate sample: time elapsed */
5130 	__u32 packets_out;	/* Packets which are "in flight"	*/
5131 	__u32 retrans_out;	/* Retransmitted packets out		*/
5132 	__u32 total_retrans;	/* Total retransmits for entire connection */
5133 	__u32 segs_in;		/* RFC4898 tcpEStatsPerfSegsIn
5134 				 * total number of segments in.
5135 				 */
5136 	__u32 data_segs_in;	/* RFC4898 tcpEStatsPerfDataSegsIn
5137 				 * total number of data segments in.
5138 				 */
5139 	__u32 segs_out;		/* RFC4898 tcpEStatsPerfSegsOut
5140 				 * The total number of segments sent.
5141 				 */
5142 	__u32 data_segs_out;	/* RFC4898 tcpEStatsPerfDataSegsOut
5143 				 * total number of data segments sent.
5144 				 */
5145 	__u32 lost_out;		/* Lost packets			*/
5146 	__u32 sacked_out;	/* SACK'd packets			*/
5147 	__u64 bytes_received;	/* RFC4898 tcpEStatsAppHCThruOctetsReceived
5148 				 * sum(delta(rcv_nxt)), or how many bytes
5149 				 * were acked.
5150 				 */
5151 	__u64 bytes_acked;	/* RFC4898 tcpEStatsAppHCThruOctetsAcked
5152 				 * sum(delta(snd_una)), or how many bytes
5153 				 * were acked.
5154 				 */
5155 	__u32 dsack_dups;	/* RFC4898 tcpEStatsStackDSACKDups
5156 				 * total number of DSACK blocks received
5157 				 */
5158 	__u32 delivered;	/* Total data packets delivered incl. rexmits */
5159 	__u32 delivered_ce;	/* Like the above but only ECE marked packets */
5160 	__u32 icsk_retransmits;	/* Number of unrecovered [RTO] timeouts */
5161 };
5162 
5163 struct bpf_sock_tuple {
5164 	union {
5165 		struct {
5166 			__be32 saddr;
5167 			__be32 daddr;
5168 			__be16 sport;
5169 			__be16 dport;
5170 		} ipv4;
5171 		struct {
5172 			__be32 saddr[4];
5173 			__be32 daddr[4];
5174 			__be16 sport;
5175 			__be16 dport;
5176 		} ipv6;
5177 	};
5178 };
5179 
5180 struct bpf_xdp_sock {
5181 	__u32 queue_id;
5182 };
5183 
5184 #define XDP_PACKET_HEADROOM 256
5185 
5186 /* User return codes for XDP prog type.
5187  * A valid XDP program must return one of these defined values. All other
5188  * return codes are reserved for future use. Unknown return codes will
5189  * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
5190  */
5191 enum xdp_action {
5192 	XDP_ABORTED = 0,
5193 	XDP_DROP,
5194 	XDP_PASS,
5195 	XDP_TX,
5196 	XDP_REDIRECT,
5197 };
5198 
5199 /* user accessible metadata for XDP packet hook
5200  * new fields must be added to the end of this structure
5201  */
5202 struct xdp_md {
5203 	__u32 data;
5204 	__u32 data_end;
5205 	__u32 data_meta;
5206 	/* Below access go through struct xdp_rxq_info */
5207 	__u32 ingress_ifindex; /* rxq->dev->ifindex */
5208 	__u32 rx_queue_index;  /* rxq->queue_index  */
5209 
5210 	__u32 egress_ifindex;  /* txq->dev->ifindex */
5211 };
5212 
5213 /* DEVMAP map-value layout
5214  *
5215  * The struct data-layout of map-value is a configuration interface.
5216  * New members can only be added to the end of this structure.
5217  */
5218 struct bpf_devmap_val {
5219 	__u32 ifindex;   /* device index */
5220 	union {
5221 		int   fd;  /* prog fd on map write */
5222 		__u32 id;  /* prog id on map read */
5223 	} bpf_prog;
5224 };
5225 
5226 /* CPUMAP map-value layout
5227  *
5228  * The struct data-layout of map-value is a configuration interface.
5229  * New members can only be added to the end of this structure.
5230  */
5231 struct bpf_cpumap_val {
5232 	__u32 qsize;	/* queue size to remote target CPU */
5233 	union {
5234 		int   fd;	/* prog fd on map write */
5235 		__u32 id;	/* prog id on map read */
5236 	} bpf_prog;
5237 };
5238 
5239 enum sk_action {
5240 	SK_DROP = 0,
5241 	SK_PASS,
5242 };
5243 
5244 /* user accessible metadata for SK_MSG packet hook, new fields must
5245  * be added to the end of this structure
5246  */
5247 struct sk_msg_md {
5248 	__bpf_md_ptr(void *, data);
5249 	__bpf_md_ptr(void *, data_end);
5250 
5251 	__u32 family;
5252 	__u32 remote_ip4;	/* Stored in network byte order */
5253 	__u32 local_ip4;	/* Stored in network byte order */
5254 	__u32 remote_ip6[4];	/* Stored in network byte order */
5255 	__u32 local_ip6[4];	/* Stored in network byte order */
5256 	__u32 remote_port;	/* Stored in network byte order */
5257 	__u32 local_port;	/* stored in host byte order */
5258 	__u32 size;		/* Total size of sk_msg */
5259 
5260 	__bpf_md_ptr(struct bpf_sock *, sk); /* current socket */
5261 };
5262 
5263 struct sk_reuseport_md {
5264 	/*
5265 	 * Start of directly accessible data. It begins from
5266 	 * the tcp/udp header.
5267 	 */
5268 	__bpf_md_ptr(void *, data);
5269 	/* End of directly accessible data */
5270 	__bpf_md_ptr(void *, data_end);
5271 	/*
5272 	 * Total length of packet (starting from the tcp/udp header).
5273 	 * Note that the directly accessible bytes (data_end - data)
5274 	 * could be less than this "len".  Those bytes could be
5275 	 * indirectly read by a helper "bpf_skb_load_bytes()".
5276 	 */
5277 	__u32 len;
5278 	/*
5279 	 * Eth protocol in the mac header (network byte order). e.g.
5280 	 * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD)
5281 	 */
5282 	__u32 eth_protocol;
5283 	__u32 ip_protocol;	/* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */
5284 	__u32 bind_inany;	/* Is sock bound to an INANY address? */
5285 	__u32 hash;		/* A hash of the packet 4 tuples */
5286 };
5287 
5288 #define BPF_TAG_SIZE	8
5289 
5290 struct bpf_prog_info {
5291 	__u32 type;
5292 	__u32 id;
5293 	__u8  tag[BPF_TAG_SIZE];
5294 	__u32 jited_prog_len;
5295 	__u32 xlated_prog_len;
5296 	__aligned_u64 jited_prog_insns;
5297 	__aligned_u64 xlated_prog_insns;
5298 	__u64 load_time;	/* ns since boottime */
5299 	__u32 created_by_uid;
5300 	__u32 nr_map_ids;
5301 	__aligned_u64 map_ids;
5302 	char name[BPF_OBJ_NAME_LEN];
5303 	__u32 ifindex;
5304 	__u32 gpl_compatible:1;
5305 	__u32 :31; /* alignment pad */
5306 	__u64 netns_dev;
5307 	__u64 netns_ino;
5308 	__u32 nr_jited_ksyms;
5309 	__u32 nr_jited_func_lens;
5310 	__aligned_u64 jited_ksyms;
5311 	__aligned_u64 jited_func_lens;
5312 	__u32 btf_id;
5313 	__u32 func_info_rec_size;
5314 	__aligned_u64 func_info;
5315 	__u32 nr_func_info;
5316 	__u32 nr_line_info;
5317 	__aligned_u64 line_info;
5318 	__aligned_u64 jited_line_info;
5319 	__u32 nr_jited_line_info;
5320 	__u32 line_info_rec_size;
5321 	__u32 jited_line_info_rec_size;
5322 	__u32 nr_prog_tags;
5323 	__aligned_u64 prog_tags;
5324 	__u64 run_time_ns;
5325 	__u64 run_cnt;
5326 	__u64 recursion_misses;
5327 } __attribute__((aligned(8)));
5328 
5329 struct bpf_map_info {
5330 	__u32 type;
5331 	__u32 id;
5332 	__u32 key_size;
5333 	__u32 value_size;
5334 	__u32 max_entries;
5335 	__u32 map_flags;
5336 	char  name[BPF_OBJ_NAME_LEN];
5337 	__u32 ifindex;
5338 	__u32 btf_vmlinux_value_type_id;
5339 	__u64 netns_dev;
5340 	__u64 netns_ino;
5341 	__u32 btf_id;
5342 	__u32 btf_key_type_id;
5343 	__u32 btf_value_type_id;
5344 } __attribute__((aligned(8)));
5345 
5346 struct bpf_btf_info {
5347 	__aligned_u64 btf;
5348 	__u32 btf_size;
5349 	__u32 id;
5350 	__aligned_u64 name;
5351 	__u32 name_len;
5352 	__u32 kernel_btf;
5353 } __attribute__((aligned(8)));
5354 
5355 struct bpf_link_info {
5356 	__u32 type;
5357 	__u32 id;
5358 	__u32 prog_id;
5359 	union {
5360 		struct {
5361 			__aligned_u64 tp_name; /* in/out: tp_name buffer ptr */
5362 			__u32 tp_name_len;     /* in/out: tp_name buffer len */
5363 		} raw_tracepoint;
5364 		struct {
5365 			__u32 attach_type;
5366 		} tracing;
5367 		struct {
5368 			__u64 cgroup_id;
5369 			__u32 attach_type;
5370 		} cgroup;
5371 		struct {
5372 			__aligned_u64 target_name; /* in/out: target_name buffer ptr */
5373 			__u32 target_name_len;	   /* in/out: target_name buffer len */
5374 			union {
5375 				struct {
5376 					__u32 map_id;
5377 				} map;
5378 			};
5379 		} iter;
5380 		struct  {
5381 			__u32 netns_ino;
5382 			__u32 attach_type;
5383 		} netns;
5384 		struct {
5385 			__u32 ifindex;
5386 		} xdp;
5387 	};
5388 } __attribute__((aligned(8)));
5389 
5390 /* User bpf_sock_addr struct to access socket fields and sockaddr struct passed
5391  * by user and intended to be used by socket (e.g. to bind to, depends on
5392  * attach type).
5393  */
5394 struct bpf_sock_addr {
5395 	__u32 user_family;	/* Allows 4-byte read, but no write. */
5396 	__u32 user_ip4;		/* Allows 1,2,4-byte read and 4-byte write.
5397 				 * Stored in network byte order.
5398 				 */
5399 	__u32 user_ip6[4];	/* Allows 1,2,4,8-byte read and 4,8-byte write.
5400 				 * Stored in network byte order.
5401 				 */
5402 	__u32 user_port;	/* Allows 1,2,4-byte read and 4-byte write.
5403 				 * Stored in network byte order
5404 				 */
5405 	__u32 family;		/* Allows 4-byte read, but no write */
5406 	__u32 type;		/* Allows 4-byte read, but no write */
5407 	__u32 protocol;		/* Allows 4-byte read, but no write */
5408 	__u32 msg_src_ip4;	/* Allows 1,2,4-byte read and 4-byte write.
5409 				 * Stored in network byte order.
5410 				 */
5411 	__u32 msg_src_ip6[4];	/* Allows 1,2,4,8-byte read and 4,8-byte write.
5412 				 * Stored in network byte order.
5413 				 */
5414 	__bpf_md_ptr(struct bpf_sock *, sk);
5415 };
5416 
5417 /* User bpf_sock_ops struct to access socket values and specify request ops
5418  * and their replies.
5419  * Some of this fields are in network (bigendian) byte order and may need
5420  * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
5421  * New fields can only be added at the end of this structure
5422  */
5423 struct bpf_sock_ops {
5424 	__u32 op;
5425 	union {
5426 		__u32 args[4];		/* Optionally passed to bpf program */
5427 		__u32 reply;		/* Returned by bpf program	    */
5428 		__u32 replylong[4];	/* Optionally returned by bpf prog  */
5429 	};
5430 	__u32 family;
5431 	__u32 remote_ip4;	/* Stored in network byte order */
5432 	__u32 local_ip4;	/* Stored in network byte order */
5433 	__u32 remote_ip6[4];	/* Stored in network byte order */
5434 	__u32 local_ip6[4];	/* Stored in network byte order */
5435 	__u32 remote_port;	/* Stored in network byte order */
5436 	__u32 local_port;	/* stored in host byte order */
5437 	__u32 is_fullsock;	/* Some TCP fields are only valid if
5438 				 * there is a full socket. If not, the
5439 				 * fields read as zero.
5440 				 */
5441 	__u32 snd_cwnd;
5442 	__u32 srtt_us;		/* Averaged RTT << 3 in usecs */
5443 	__u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */
5444 	__u32 state;
5445 	__u32 rtt_min;
5446 	__u32 snd_ssthresh;
5447 	__u32 rcv_nxt;
5448 	__u32 snd_nxt;
5449 	__u32 snd_una;
5450 	__u32 mss_cache;
5451 	__u32 ecn_flags;
5452 	__u32 rate_delivered;
5453 	__u32 rate_interval_us;
5454 	__u32 packets_out;
5455 	__u32 retrans_out;
5456 	__u32 total_retrans;
5457 	__u32 segs_in;
5458 	__u32 data_segs_in;
5459 	__u32 segs_out;
5460 	__u32 data_segs_out;
5461 	__u32 lost_out;
5462 	__u32 sacked_out;
5463 	__u32 sk_txhash;
5464 	__u64 bytes_received;
5465 	__u64 bytes_acked;
5466 	__bpf_md_ptr(struct bpf_sock *, sk);
5467 	/* [skb_data, skb_data_end) covers the whole TCP header.
5468 	 *
5469 	 * BPF_SOCK_OPS_PARSE_HDR_OPT_CB: The packet received
5470 	 * BPF_SOCK_OPS_HDR_OPT_LEN_CB:   Not useful because the
5471 	 *                                header has not been written.
5472 	 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB: The header and options have
5473 	 *				  been written so far.
5474 	 * BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB:  The SYNACK that concludes
5475 	 *					the 3WHS.
5476 	 * BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB: The ACK that concludes
5477 	 *					the 3WHS.
5478 	 *
5479 	 * bpf_load_hdr_opt() can also be used to read a particular option.
5480 	 */
5481 	__bpf_md_ptr(void *, skb_data);
5482 	__bpf_md_ptr(void *, skb_data_end);
5483 	__u32 skb_len;		/* The total length of a packet.
5484 				 * It includes the header, options,
5485 				 * and payload.
5486 				 */
5487 	__u32 skb_tcp_flags;	/* tcp_flags of the header.  It provides
5488 				 * an easy way to check for tcp_flags
5489 				 * without parsing skb_data.
5490 				 *
5491 				 * In particular, the skb_tcp_flags
5492 				 * will still be available in
5493 				 * BPF_SOCK_OPS_HDR_OPT_LEN even though
5494 				 * the outgoing header has not
5495 				 * been written yet.
5496 				 */
5497 };
5498 
5499 /* Definitions for bpf_sock_ops_cb_flags */
5500 enum {
5501 	BPF_SOCK_OPS_RTO_CB_FLAG	= (1<<0),
5502 	BPF_SOCK_OPS_RETRANS_CB_FLAG	= (1<<1),
5503 	BPF_SOCK_OPS_STATE_CB_FLAG	= (1<<2),
5504 	BPF_SOCK_OPS_RTT_CB_FLAG	= (1<<3),
5505 	/* Call bpf for all received TCP headers.  The bpf prog will be
5506 	 * called under sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB
5507 	 *
5508 	 * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB
5509 	 * for the header option related helpers that will be useful
5510 	 * to the bpf programs.
5511 	 *
5512 	 * It could be used at the client/active side (i.e. connect() side)
5513 	 * when the server told it that the server was in syncookie
5514 	 * mode and required the active side to resend the bpf-written
5515 	 * options.  The active side can keep writing the bpf-options until
5516 	 * it received a valid packet from the server side to confirm
5517 	 * the earlier packet (and options) has been received.  The later
5518 	 * example patch is using it like this at the active side when the
5519 	 * server is in syncookie mode.
5520 	 *
5521 	 * The bpf prog will usually turn this off in the common cases.
5522 	 */
5523 	BPF_SOCK_OPS_PARSE_ALL_HDR_OPT_CB_FLAG	= (1<<4),
5524 	/* Call bpf when kernel has received a header option that
5525 	 * the kernel cannot handle.  The bpf prog will be called under
5526 	 * sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB.
5527 	 *
5528 	 * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB
5529 	 * for the header option related helpers that will be useful
5530 	 * to the bpf programs.
5531 	 */
5532 	BPF_SOCK_OPS_PARSE_UNKNOWN_HDR_OPT_CB_FLAG = (1<<5),
5533 	/* Call bpf when the kernel is writing header options for the
5534 	 * outgoing packet.  The bpf prog will first be called
5535 	 * to reserve space in a skb under
5536 	 * sock_ops->op == BPF_SOCK_OPS_HDR_OPT_LEN_CB.  Then
5537 	 * the bpf prog will be called to write the header option(s)
5538 	 * under sock_ops->op == BPF_SOCK_OPS_WRITE_HDR_OPT_CB.
5539 	 *
5540 	 * Please refer to the comment in BPF_SOCK_OPS_HDR_OPT_LEN_CB
5541 	 * and BPF_SOCK_OPS_WRITE_HDR_OPT_CB for the header option
5542 	 * related helpers that will be useful to the bpf programs.
5543 	 *
5544 	 * The kernel gets its chance to reserve space and write
5545 	 * options first before the BPF program does.
5546 	 */
5547 	BPF_SOCK_OPS_WRITE_HDR_OPT_CB_FLAG = (1<<6),
5548 /* Mask of all currently supported cb flags */
5549 	BPF_SOCK_OPS_ALL_CB_FLAGS       = 0x7F,
5550 };
5551 
5552 /* List of known BPF sock_ops operators.
5553  * New entries can only be added at the end
5554  */
5555 enum {
5556 	BPF_SOCK_OPS_VOID,
5557 	BPF_SOCK_OPS_TIMEOUT_INIT,	/* Should return SYN-RTO value to use or
5558 					 * -1 if default value should be used
5559 					 */
5560 	BPF_SOCK_OPS_RWND_INIT,		/* Should return initial advertized
5561 					 * window (in packets) or -1 if default
5562 					 * value should be used
5563 					 */
5564 	BPF_SOCK_OPS_TCP_CONNECT_CB,	/* Calls BPF program right before an
5565 					 * active connection is initialized
5566 					 */
5567 	BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB,	/* Calls BPF program when an
5568 						 * active connection is
5569 						 * established
5570 						 */
5571 	BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB,	/* Calls BPF program when a
5572 						 * passive connection is
5573 						 * established
5574 						 */
5575 	BPF_SOCK_OPS_NEEDS_ECN,		/* If connection's congestion control
5576 					 * needs ECN
5577 					 */
5578 	BPF_SOCK_OPS_BASE_RTT,		/* Get base RTT. The correct value is
5579 					 * based on the path and may be
5580 					 * dependent on the congestion control
5581 					 * algorithm. In general it indicates
5582 					 * a congestion threshold. RTTs above
5583 					 * this indicate congestion
5584 					 */
5585 	BPF_SOCK_OPS_RTO_CB,		/* Called when an RTO has triggered.
5586 					 * Arg1: value of icsk_retransmits
5587 					 * Arg2: value of icsk_rto
5588 					 * Arg3: whether RTO has expired
5589 					 */
5590 	BPF_SOCK_OPS_RETRANS_CB,	/* Called when skb is retransmitted.
5591 					 * Arg1: sequence number of 1st byte
5592 					 * Arg2: # segments
5593 					 * Arg3: return value of
5594 					 *       tcp_transmit_skb (0 => success)
5595 					 */
5596 	BPF_SOCK_OPS_STATE_CB,		/* Called when TCP changes state.
5597 					 * Arg1: old_state
5598 					 * Arg2: new_state
5599 					 */
5600 	BPF_SOCK_OPS_TCP_LISTEN_CB,	/* Called on listen(2), right after
5601 					 * socket transition to LISTEN state.
5602 					 */
5603 	BPF_SOCK_OPS_RTT_CB,		/* Called on every RTT.
5604 					 */
5605 	BPF_SOCK_OPS_PARSE_HDR_OPT_CB,	/* Parse the header option.
5606 					 * It will be called to handle
5607 					 * the packets received at
5608 					 * an already established
5609 					 * connection.
5610 					 *
5611 					 * sock_ops->skb_data:
5612 					 * Referring to the received skb.
5613 					 * It covers the TCP header only.
5614 					 *
5615 					 * bpf_load_hdr_opt() can also
5616 					 * be used to search for a
5617 					 * particular option.
5618 					 */
5619 	BPF_SOCK_OPS_HDR_OPT_LEN_CB,	/* Reserve space for writing the
5620 					 * header option later in
5621 					 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB.
5622 					 * Arg1: bool want_cookie. (in
5623 					 *       writing SYNACK only)
5624 					 *
5625 					 * sock_ops->skb_data:
5626 					 * Not available because no header has
5627 					 * been	written yet.
5628 					 *
5629 					 * sock_ops->skb_tcp_flags:
5630 					 * The tcp_flags of the
5631 					 * outgoing skb. (e.g. SYN, ACK, FIN).
5632 					 *
5633 					 * bpf_reserve_hdr_opt() should
5634 					 * be used to reserve space.
5635 					 */
5636 	BPF_SOCK_OPS_WRITE_HDR_OPT_CB,	/* Write the header options
5637 					 * Arg1: bool want_cookie. (in
5638 					 *       writing SYNACK only)
5639 					 *
5640 					 * sock_ops->skb_data:
5641 					 * Referring to the outgoing skb.
5642 					 * It covers the TCP header
5643 					 * that has already been written
5644 					 * by the kernel and the
5645 					 * earlier bpf-progs.
5646 					 *
5647 					 * sock_ops->skb_tcp_flags:
5648 					 * The tcp_flags of the outgoing
5649 					 * skb. (e.g. SYN, ACK, FIN).
5650 					 *
5651 					 * bpf_store_hdr_opt() should
5652 					 * be used to write the
5653 					 * option.
5654 					 *
5655 					 * bpf_load_hdr_opt() can also
5656 					 * be used to search for a
5657 					 * particular option that
5658 					 * has already been written
5659 					 * by the kernel or the
5660 					 * earlier bpf-progs.
5661 					 */
5662 };
5663 
5664 /* List of TCP states. There is a build check in net/ipv4/tcp.c to detect
5665  * changes between the TCP and BPF versions. Ideally this should never happen.
5666  * If it does, we need to add code to convert them before calling
5667  * the BPF sock_ops function.
5668  */
5669 enum {
5670 	BPF_TCP_ESTABLISHED = 1,
5671 	BPF_TCP_SYN_SENT,
5672 	BPF_TCP_SYN_RECV,
5673 	BPF_TCP_FIN_WAIT1,
5674 	BPF_TCP_FIN_WAIT2,
5675 	BPF_TCP_TIME_WAIT,
5676 	BPF_TCP_CLOSE,
5677 	BPF_TCP_CLOSE_WAIT,
5678 	BPF_TCP_LAST_ACK,
5679 	BPF_TCP_LISTEN,
5680 	BPF_TCP_CLOSING,	/* Now a valid state */
5681 	BPF_TCP_NEW_SYN_RECV,
5682 
5683 	BPF_TCP_MAX_STATES	/* Leave at the end! */
5684 };
5685 
5686 enum {
5687 	TCP_BPF_IW		= 1001,	/* Set TCP initial congestion window */
5688 	TCP_BPF_SNDCWND_CLAMP	= 1002,	/* Set sndcwnd_clamp */
5689 	TCP_BPF_DELACK_MAX	= 1003, /* Max delay ack in usecs */
5690 	TCP_BPF_RTO_MIN		= 1004, /* Min delay ack in usecs */
5691 	/* Copy the SYN pkt to optval
5692 	 *
5693 	 * BPF_PROG_TYPE_SOCK_OPS only.  It is similar to the
5694 	 * bpf_getsockopt(TCP_SAVED_SYN) but it does not limit
5695 	 * to only getting from the saved_syn.  It can either get the
5696 	 * syn packet from:
5697 	 *
5698 	 * 1. the just-received SYN packet (only available when writing the
5699 	 *    SYNACK).  It will be useful when it is not necessary to
5700 	 *    save the SYN packet for latter use.  It is also the only way
5701 	 *    to get the SYN during syncookie mode because the syn
5702 	 *    packet cannot be saved during syncookie.
5703 	 *
5704 	 * OR
5705 	 *
5706 	 * 2. the earlier saved syn which was done by
5707 	 *    bpf_setsockopt(TCP_SAVE_SYN).
5708 	 *
5709 	 * The bpf_getsockopt(TCP_BPF_SYN*) option will hide where the
5710 	 * SYN packet is obtained.
5711 	 *
5712 	 * If the bpf-prog does not need the IP[46] header,  the
5713 	 * bpf-prog can avoid parsing the IP header by using
5714 	 * TCP_BPF_SYN.  Otherwise, the bpf-prog can get both
5715 	 * IP[46] and TCP header by using TCP_BPF_SYN_IP.
5716 	 *
5717 	 *      >0: Total number of bytes copied
5718 	 * -ENOSPC: Not enough space in optval. Only optlen number of
5719 	 *          bytes is copied.
5720 	 * -ENOENT: The SYN skb is not available now and the earlier SYN pkt
5721 	 *	    is not saved by setsockopt(TCP_SAVE_SYN).
5722 	 */
5723 	TCP_BPF_SYN		= 1005, /* Copy the TCP header */
5724 	TCP_BPF_SYN_IP		= 1006, /* Copy the IP[46] and TCP header */
5725 	TCP_BPF_SYN_MAC         = 1007, /* Copy the MAC, IP[46], and TCP header */
5726 };
5727 
5728 enum {
5729 	BPF_LOAD_HDR_OPT_TCP_SYN = (1ULL << 0),
5730 };
5731 
5732 /* args[0] value during BPF_SOCK_OPS_HDR_OPT_LEN_CB and
5733  * BPF_SOCK_OPS_WRITE_HDR_OPT_CB.
5734  */
5735 enum {
5736 	BPF_WRITE_HDR_TCP_CURRENT_MSS = 1,	/* Kernel is finding the
5737 						 * total option spaces
5738 						 * required for an established
5739 						 * sk in order to calculate the
5740 						 * MSS.  No skb is actually
5741 						 * sent.
5742 						 */
5743 	BPF_WRITE_HDR_TCP_SYNACK_COOKIE = 2,	/* Kernel is in syncookie mode
5744 						 * when sending a SYN.
5745 						 */
5746 };
5747 
5748 struct bpf_perf_event_value {
5749 	__u64 counter;
5750 	__u64 enabled;
5751 	__u64 running;
5752 };
5753 
5754 enum {
5755 	BPF_DEVCG_ACC_MKNOD	= (1ULL << 0),
5756 	BPF_DEVCG_ACC_READ	= (1ULL << 1),
5757 	BPF_DEVCG_ACC_WRITE	= (1ULL << 2),
5758 };
5759 
5760 enum {
5761 	BPF_DEVCG_DEV_BLOCK	= (1ULL << 0),
5762 	BPF_DEVCG_DEV_CHAR	= (1ULL << 1),
5763 };
5764 
5765 struct bpf_cgroup_dev_ctx {
5766 	/* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */
5767 	__u32 access_type;
5768 	__u32 major;
5769 	__u32 minor;
5770 };
5771 
5772 struct bpf_raw_tracepoint_args {
5773 	__u64 args[0];
5774 };
5775 
5776 /* DIRECT:  Skip the FIB rules and go to FIB table associated with device
5777  * OUTPUT:  Do lookup from egress perspective; default is ingress
5778  */
5779 enum {
5780 	BPF_FIB_LOOKUP_DIRECT  = (1U << 0),
5781 	BPF_FIB_LOOKUP_OUTPUT  = (1U << 1),
5782 };
5783 
5784 enum {
5785 	BPF_FIB_LKUP_RET_SUCCESS,      /* lookup successful */
5786 	BPF_FIB_LKUP_RET_BLACKHOLE,    /* dest is blackholed; can be dropped */
5787 	BPF_FIB_LKUP_RET_UNREACHABLE,  /* dest is unreachable; can be dropped */
5788 	BPF_FIB_LKUP_RET_PROHIBIT,     /* dest not allowed; can be dropped */
5789 	BPF_FIB_LKUP_RET_NOT_FWDED,    /* packet is not forwarded */
5790 	BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */
5791 	BPF_FIB_LKUP_RET_UNSUPP_LWT,   /* fwd requires encapsulation */
5792 	BPF_FIB_LKUP_RET_NO_NEIGH,     /* no neighbor entry for nh */
5793 	BPF_FIB_LKUP_RET_FRAG_NEEDED,  /* fragmentation required to fwd */
5794 };
5795 
5796 struct bpf_fib_lookup {
5797 	/* input:  network family for lookup (AF_INET, AF_INET6)
5798 	 * output: network family of egress nexthop
5799 	 */
5800 	__u8	family;
5801 
5802 	/* set if lookup is to consider L4 data - e.g., FIB rules */
5803 	__u8	l4_protocol;
5804 	__be16	sport;
5805 	__be16	dport;
5806 
5807 	union {	/* used for MTU check */
5808 		/* input to lookup */
5809 		__u16	tot_len; /* L3 length from network hdr (iph->tot_len) */
5810 
5811 		/* output: MTU value */
5812 		__u16	mtu_result;
5813 	};
5814 	/* input: L3 device index for lookup
5815 	 * output: device index from FIB lookup
5816 	 */
5817 	__u32	ifindex;
5818 
5819 	union {
5820 		/* inputs to lookup */
5821 		__u8	tos;		/* AF_INET  */
5822 		__be32	flowinfo;	/* AF_INET6, flow_label + priority */
5823 
5824 		/* output: metric of fib result (IPv4/IPv6 only) */
5825 		__u32	rt_metric;
5826 	};
5827 
5828 	union {
5829 		__be32		ipv4_src;
5830 		__u32		ipv6_src[4];  /* in6_addr; network order */
5831 	};
5832 
5833 	/* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in
5834 	 * network header. output: bpf_fib_lookup sets to gateway address
5835 	 * if FIB lookup returns gateway route
5836 	 */
5837 	union {
5838 		__be32		ipv4_dst;
5839 		__u32		ipv6_dst[4];  /* in6_addr; network order */
5840 	};
5841 
5842 	/* output */
5843 	__be16	h_vlan_proto;
5844 	__be16	h_vlan_TCI;
5845 	__u8	smac[6];     /* ETH_ALEN */
5846 	__u8	dmac[6];     /* ETH_ALEN */
5847 };
5848 
5849 struct bpf_redir_neigh {
5850 	/* network family for lookup (AF_INET, AF_INET6) */
5851 	__u32 nh_family;
5852 	/* network address of nexthop; skips fib lookup to find gateway */
5853 	union {
5854 		__be32		ipv4_nh;
5855 		__u32		ipv6_nh[4];  /* in6_addr; network order */
5856 	};
5857 };
5858 
5859 /* bpf_check_mtu flags*/
5860 enum  bpf_check_mtu_flags {
5861 	BPF_MTU_CHK_SEGS  = (1U << 0),
5862 };
5863 
5864 enum bpf_check_mtu_ret {
5865 	BPF_MTU_CHK_RET_SUCCESS,      /* check and lookup successful */
5866 	BPF_MTU_CHK_RET_FRAG_NEEDED,  /* fragmentation required to fwd */
5867 	BPF_MTU_CHK_RET_SEGS_TOOBIG,  /* GSO re-segmentation needed to fwd */
5868 };
5869 
5870 enum bpf_task_fd_type {
5871 	BPF_FD_TYPE_RAW_TRACEPOINT,	/* tp name */
5872 	BPF_FD_TYPE_TRACEPOINT,		/* tp name */
5873 	BPF_FD_TYPE_KPROBE,		/* (symbol + offset) or addr */
5874 	BPF_FD_TYPE_KRETPROBE,		/* (symbol + offset) or addr */
5875 	BPF_FD_TYPE_UPROBE,		/* filename + offset */
5876 	BPF_FD_TYPE_URETPROBE,		/* filename + offset */
5877 };
5878 
5879 enum {
5880 	BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG		= (1U << 0),
5881 	BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL		= (1U << 1),
5882 	BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP		= (1U << 2),
5883 };
5884 
5885 struct bpf_flow_keys {
5886 	__u16	nhoff;
5887 	__u16	thoff;
5888 	__u16	addr_proto;			/* ETH_P_* of valid addrs */
5889 	__u8	is_frag;
5890 	__u8	is_first_frag;
5891 	__u8	is_encap;
5892 	__u8	ip_proto;
5893 	__be16	n_proto;
5894 	__be16	sport;
5895 	__be16	dport;
5896 	union {
5897 		struct {
5898 			__be32	ipv4_src;
5899 			__be32	ipv4_dst;
5900 		};
5901 		struct {
5902 			__u32	ipv6_src[4];	/* in6_addr; network order */
5903 			__u32	ipv6_dst[4];	/* in6_addr; network order */
5904 		};
5905 	};
5906 	__u32	flags;
5907 	__be32	flow_label;
5908 };
5909 
5910 struct bpf_func_info {
5911 	__u32	insn_off;
5912 	__u32	type_id;
5913 };
5914 
5915 #define BPF_LINE_INFO_LINE_NUM(line_col)	((line_col) >> 10)
5916 #define BPF_LINE_INFO_LINE_COL(line_col)	((line_col) & 0x3ff)
5917 
5918 struct bpf_line_info {
5919 	__u32	insn_off;
5920 	__u32	file_name_off;
5921 	__u32	line_off;
5922 	__u32	line_col;
5923 };
5924 
5925 struct bpf_spin_lock {
5926 	__u32	val;
5927 };
5928 
5929 struct bpf_sysctl {
5930 	__u32	write;		/* Sysctl is being read (= 0) or written (= 1).
5931 				 * Allows 1,2,4-byte read, but no write.
5932 				 */
5933 	__u32	file_pos;	/* Sysctl file position to read from, write to.
5934 				 * Allows 1,2,4-byte read an 4-byte write.
5935 				 */
5936 };
5937 
5938 struct bpf_sockopt {
5939 	__bpf_md_ptr(struct bpf_sock *, sk);
5940 	__bpf_md_ptr(void *, optval);
5941 	__bpf_md_ptr(void *, optval_end);
5942 
5943 	__s32	level;
5944 	__s32	optname;
5945 	__s32	optlen;
5946 	__s32	retval;
5947 };
5948 
5949 struct bpf_pidns_info {
5950 	__u32 pid;
5951 	__u32 tgid;
5952 };
5953 
5954 /* User accessible data for SK_LOOKUP programs. Add new fields at the end. */
5955 struct bpf_sk_lookup {
5956 	__bpf_md_ptr(struct bpf_sock *, sk); /* Selected socket */
5957 
5958 	__u32 family;		/* Protocol family (AF_INET, AF_INET6) */
5959 	__u32 protocol;		/* IP protocol (IPPROTO_TCP, IPPROTO_UDP) */
5960 	__u32 remote_ip4;	/* Network byte order */
5961 	__u32 remote_ip6[4];	/* Network byte order */
5962 	__u32 remote_port;	/* Network byte order */
5963 	__u32 local_ip4;	/* Network byte order */
5964 	__u32 local_ip6[4];	/* Network byte order */
5965 	__u32 local_port;	/* Host byte order */
5966 };
5967 
5968 /*
5969  * struct btf_ptr is used for typed pointer representation; the
5970  * type id is used to render the pointer data as the appropriate type
5971  * via the bpf_snprintf_btf() helper described above.  A flags field -
5972  * potentially to specify additional details about the BTF pointer
5973  * (rather than its mode of display) - is included for future use.
5974  * Display flags - BTF_F_* - are passed to bpf_snprintf_btf separately.
5975  */
5976 struct btf_ptr {
5977 	void *ptr;
5978 	__u32 type_id;
5979 	__u32 flags;		/* BTF ptr flags; unused at present. */
5980 };
5981 
5982 /*
5983  * Flags to control bpf_snprintf_btf() behaviour.
5984  *     - BTF_F_COMPACT: no formatting around type information
5985  *     - BTF_F_NONAME: no struct/union member names/types
5986  *     - BTF_F_PTR_RAW: show raw (unobfuscated) pointer values;
5987  *       equivalent to %px.
5988  *     - BTF_F_ZERO: show zero-valued struct/union members; they
5989  *       are not displayed by default
5990  */
5991 enum {
5992 	BTF_F_COMPACT	=	(1ULL << 0),
5993 	BTF_F_NONAME	=	(1ULL << 1),
5994 	BTF_F_PTR_RAW	=	(1ULL << 2),
5995 	BTF_F_ZERO	=	(1ULL << 3),
5996 };
5997 
5998 #endif /* _UAPI__LINUX_BPF_H__ */
5999