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