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