bpf: allow zero-initializing hash map seed
[platform/kernel/linux-rpi.git] / include / uapi / linux / bpf.h
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of version 2 of the GNU General Public
6  * License as published by the Free Software Foundation.
7  */
8 #ifndef _UAPI__LINUX_BPF_H__
9 #define _UAPI__LINUX_BPF_H__
10
11 #include <linux/types.h>
12 #include <linux/bpf_common.h>
13
14 /* Extended instruction set based on top of classic BPF */
15
16 /* instruction classes */
17 #define BPF_ALU64       0x07    /* alu mode in double word width */
18
19 /* ld/ldx fields */
20 #define BPF_DW          0x18    /* double word (64-bit) */
21 #define BPF_XADD        0xc0    /* exclusive add */
22
23 /* alu/jmp fields */
24 #define BPF_MOV         0xb0    /* mov reg to reg */
25 #define BPF_ARSH        0xc0    /* sign extending arithmetic shift right */
26
27 /* change endianness of a register */
28 #define BPF_END         0xd0    /* flags for endianness conversion: */
29 #define BPF_TO_LE       0x00    /* convert to little-endian */
30 #define BPF_TO_BE       0x08    /* convert to big-endian */
31 #define BPF_FROM_LE     BPF_TO_LE
32 #define BPF_FROM_BE     BPF_TO_BE
33
34 /* jmp encodings */
35 #define BPF_JNE         0x50    /* jump != */
36 #define BPF_JLT         0xa0    /* LT is unsigned, '<' */
37 #define BPF_JLE         0xb0    /* LE is unsigned, '<=' */
38 #define BPF_JSGT        0x60    /* SGT is signed '>', GT in x86 */
39 #define BPF_JSGE        0x70    /* SGE is signed '>=', GE in x86 */
40 #define BPF_JSLT        0xc0    /* SLT is signed, '<' */
41 #define BPF_JSLE        0xd0    /* SLE is signed, '<=' */
42 #define BPF_CALL        0x80    /* function call */
43 #define BPF_EXIT        0x90    /* function return */
44
45 /* Register numbers */
46 enum {
47         BPF_REG_0 = 0,
48         BPF_REG_1,
49         BPF_REG_2,
50         BPF_REG_3,
51         BPF_REG_4,
52         BPF_REG_5,
53         BPF_REG_6,
54         BPF_REG_7,
55         BPF_REG_8,
56         BPF_REG_9,
57         BPF_REG_10,
58         __MAX_BPF_REG,
59 };
60
61 /* BPF has 10 general purpose 64-bit registers and stack frame. */
62 #define MAX_BPF_REG     __MAX_BPF_REG
63
64 struct bpf_insn {
65         __u8    code;           /* opcode */
66         __u8    dst_reg:4;      /* dest register */
67         __u8    src_reg:4;      /* source register */
68         __s16   off;            /* signed offset */
69         __s32   imm;            /* signed immediate constant */
70 };
71
72 /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
73 struct bpf_lpm_trie_key {
74         __u32   prefixlen;      /* up to 32 for AF_INET, 128 for AF_INET6 */
75         __u8    data[0];        /* Arbitrary size */
76 };
77
78 struct bpf_cgroup_storage_key {
79         __u64   cgroup_inode_id;        /* cgroup inode id */
80         __u32   attach_type;            /* program attach type */
81 };
82
83 /* BPF syscall commands, see bpf(2) man-page for details. */
84 enum bpf_cmd {
85         BPF_MAP_CREATE,
86         BPF_MAP_LOOKUP_ELEM,
87         BPF_MAP_UPDATE_ELEM,
88         BPF_MAP_DELETE_ELEM,
89         BPF_MAP_GET_NEXT_KEY,
90         BPF_PROG_LOAD,
91         BPF_OBJ_PIN,
92         BPF_OBJ_GET,
93         BPF_PROG_ATTACH,
94         BPF_PROG_DETACH,
95         BPF_PROG_TEST_RUN,
96         BPF_PROG_GET_NEXT_ID,
97         BPF_MAP_GET_NEXT_ID,
98         BPF_PROG_GET_FD_BY_ID,
99         BPF_MAP_GET_FD_BY_ID,
100         BPF_OBJ_GET_INFO_BY_FD,
101         BPF_PROG_QUERY,
102         BPF_RAW_TRACEPOINT_OPEN,
103         BPF_BTF_LOAD,
104         BPF_BTF_GET_FD_BY_ID,
105         BPF_TASK_FD_QUERY,
106         BPF_MAP_LOOKUP_AND_DELETE_ELEM,
107 };
108
109 enum bpf_map_type {
110         BPF_MAP_TYPE_UNSPEC,
111         BPF_MAP_TYPE_HASH,
112         BPF_MAP_TYPE_ARRAY,
113         BPF_MAP_TYPE_PROG_ARRAY,
114         BPF_MAP_TYPE_PERF_EVENT_ARRAY,
115         BPF_MAP_TYPE_PERCPU_HASH,
116         BPF_MAP_TYPE_PERCPU_ARRAY,
117         BPF_MAP_TYPE_STACK_TRACE,
118         BPF_MAP_TYPE_CGROUP_ARRAY,
119         BPF_MAP_TYPE_LRU_HASH,
120         BPF_MAP_TYPE_LRU_PERCPU_HASH,
121         BPF_MAP_TYPE_LPM_TRIE,
122         BPF_MAP_TYPE_ARRAY_OF_MAPS,
123         BPF_MAP_TYPE_HASH_OF_MAPS,
124         BPF_MAP_TYPE_DEVMAP,
125         BPF_MAP_TYPE_SOCKMAP,
126         BPF_MAP_TYPE_CPUMAP,
127         BPF_MAP_TYPE_XSKMAP,
128         BPF_MAP_TYPE_SOCKHASH,
129         BPF_MAP_TYPE_CGROUP_STORAGE,
130         BPF_MAP_TYPE_REUSEPORT_SOCKARRAY,
131         BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE,
132         BPF_MAP_TYPE_QUEUE,
133         BPF_MAP_TYPE_STACK,
134 };
135
136 enum bpf_prog_type {
137         BPF_PROG_TYPE_UNSPEC,
138         BPF_PROG_TYPE_SOCKET_FILTER,
139         BPF_PROG_TYPE_KPROBE,
140         BPF_PROG_TYPE_SCHED_CLS,
141         BPF_PROG_TYPE_SCHED_ACT,
142         BPF_PROG_TYPE_TRACEPOINT,
143         BPF_PROG_TYPE_XDP,
144         BPF_PROG_TYPE_PERF_EVENT,
145         BPF_PROG_TYPE_CGROUP_SKB,
146         BPF_PROG_TYPE_CGROUP_SOCK,
147         BPF_PROG_TYPE_LWT_IN,
148         BPF_PROG_TYPE_LWT_OUT,
149         BPF_PROG_TYPE_LWT_XMIT,
150         BPF_PROG_TYPE_SOCK_OPS,
151         BPF_PROG_TYPE_SK_SKB,
152         BPF_PROG_TYPE_CGROUP_DEVICE,
153         BPF_PROG_TYPE_SK_MSG,
154         BPF_PROG_TYPE_RAW_TRACEPOINT,
155         BPF_PROG_TYPE_CGROUP_SOCK_ADDR,
156         BPF_PROG_TYPE_LWT_SEG6LOCAL,
157         BPF_PROG_TYPE_LIRC_MODE2,
158         BPF_PROG_TYPE_SK_REUSEPORT,
159         BPF_PROG_TYPE_FLOW_DISSECTOR,
160 };
161
162 enum bpf_attach_type {
163         BPF_CGROUP_INET_INGRESS,
164         BPF_CGROUP_INET_EGRESS,
165         BPF_CGROUP_INET_SOCK_CREATE,
166         BPF_CGROUP_SOCK_OPS,
167         BPF_SK_SKB_STREAM_PARSER,
168         BPF_SK_SKB_STREAM_VERDICT,
169         BPF_CGROUP_DEVICE,
170         BPF_SK_MSG_VERDICT,
171         BPF_CGROUP_INET4_BIND,
172         BPF_CGROUP_INET6_BIND,
173         BPF_CGROUP_INET4_CONNECT,
174         BPF_CGROUP_INET6_CONNECT,
175         BPF_CGROUP_INET4_POST_BIND,
176         BPF_CGROUP_INET6_POST_BIND,
177         BPF_CGROUP_UDP4_SENDMSG,
178         BPF_CGROUP_UDP6_SENDMSG,
179         BPF_LIRC_MODE2,
180         BPF_FLOW_DISSECTOR,
181         __MAX_BPF_ATTACH_TYPE
182 };
183
184 #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
185
186 /* cgroup-bpf attach flags used in BPF_PROG_ATTACH command
187  *
188  * NONE(default): No further bpf programs allowed in the subtree.
189  *
190  * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program,
191  * the program in this cgroup yields to sub-cgroup program.
192  *
193  * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program,
194  * that cgroup program gets run in addition to the program in this cgroup.
195  *
196  * Only one program is allowed to be attached to a cgroup with
197  * NONE or BPF_F_ALLOW_OVERRIDE flag.
198  * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will
199  * release old program and attach the new one. Attach flags has to match.
200  *
201  * Multiple programs are allowed to be attached to a cgroup with
202  * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order
203  * (those that were attached first, run first)
204  * The programs of sub-cgroup are executed first, then programs of
205  * this cgroup and then programs of parent cgroup.
206  * When children program makes decision (like picking TCP CA or sock bind)
207  * parent program has a chance to override it.
208  *
209  * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups.
210  * A cgroup with NONE doesn't allow any programs in sub-cgroups.
211  * Ex1:
212  * cgrp1 (MULTI progs A, B) ->
213  *    cgrp2 (OVERRIDE prog C) ->
214  *      cgrp3 (MULTI prog D) ->
215  *        cgrp4 (OVERRIDE prog E) ->
216  *          cgrp5 (NONE prog F)
217  * the event in cgrp5 triggers execution of F,D,A,B in that order.
218  * if prog F is detached, the execution is E,D,A,B
219  * if prog F and D are detached, the execution is E,A,B
220  * if prog F, E and D are detached, the execution is C,A,B
221  *
222  * All eligible programs are executed regardless of return code from
223  * earlier programs.
224  */
225 #define BPF_F_ALLOW_OVERRIDE    (1U << 0)
226 #define BPF_F_ALLOW_MULTI       (1U << 1)
227
228 /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
229  * verifier will perform strict alignment checking as if the kernel
230  * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
231  * and NET_IP_ALIGN defined to 2.
232  */
233 #define BPF_F_STRICT_ALIGNMENT  (1U << 0)
234
235 /* when bpf_ldimm64->src_reg == BPF_PSEUDO_MAP_FD, bpf_ldimm64->imm == fd */
236 #define BPF_PSEUDO_MAP_FD       1
237
238 /* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative
239  * offset to another bpf function
240  */
241 #define BPF_PSEUDO_CALL         1
242
243 /* flags for BPF_MAP_UPDATE_ELEM command */
244 #define BPF_ANY         0 /* create new element or update existing */
245 #define BPF_NOEXIST     1 /* create new element if it didn't exist */
246 #define BPF_EXIST       2 /* update existing element */
247
248 /* flags for BPF_MAP_CREATE command */
249 #define BPF_F_NO_PREALLOC       (1U << 0)
250 /* Instead of having one common LRU list in the
251  * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
252  * which can scale and perform better.
253  * Note, the LRU nodes (including free nodes) cannot be moved
254  * across different LRU lists.
255  */
256 #define BPF_F_NO_COMMON_LRU     (1U << 1)
257 /* Specify numa node during map creation */
258 #define BPF_F_NUMA_NODE         (1U << 2)
259
260 /* flags for BPF_PROG_QUERY */
261 #define BPF_F_QUERY_EFFECTIVE   (1U << 0)
262
263 #define BPF_OBJ_NAME_LEN 16U
264
265 /* Flags for accessing BPF object */
266 #define BPF_F_RDONLY            (1U << 3)
267 #define BPF_F_WRONLY            (1U << 4)
268
269 /* Flag for stack_map, store build_id+offset instead of pointer */
270 #define BPF_F_STACK_BUILD_ID    (1U << 5)
271
272 /* Zero-initialize hash function seed. This should only be used for testing. */
273 #define BPF_F_ZERO_SEED         (1U << 6)
274
275 enum bpf_stack_build_id_status {
276         /* user space need an empty entry to identify end of a trace */
277         BPF_STACK_BUILD_ID_EMPTY = 0,
278         /* with valid build_id and offset */
279         BPF_STACK_BUILD_ID_VALID = 1,
280         /* couldn't get build_id, fallback to ip */
281         BPF_STACK_BUILD_ID_IP = 2,
282 };
283
284 #define BPF_BUILD_ID_SIZE 20
285 struct bpf_stack_build_id {
286         __s32           status;
287         unsigned char   build_id[BPF_BUILD_ID_SIZE];
288         union {
289                 __u64   offset;
290                 __u64   ip;
291         };
292 };
293
294 union bpf_attr {
295         struct { /* anonymous struct used by BPF_MAP_CREATE command */
296                 __u32   map_type;       /* one of enum bpf_map_type */
297                 __u32   key_size;       /* size of key in bytes */
298                 __u32   value_size;     /* size of value in bytes */
299                 __u32   max_entries;    /* max number of entries in a map */
300                 __u32   map_flags;      /* BPF_MAP_CREATE related
301                                          * flags defined above.
302                                          */
303                 __u32   inner_map_fd;   /* fd pointing to the inner map */
304                 __u32   numa_node;      /* numa node (effective only if
305                                          * BPF_F_NUMA_NODE is set).
306                                          */
307                 char    map_name[BPF_OBJ_NAME_LEN];
308                 __u32   map_ifindex;    /* ifindex of netdev to create on */
309                 __u32   btf_fd;         /* fd pointing to a BTF type data */
310                 __u32   btf_key_type_id;        /* BTF type_id of the key */
311                 __u32   btf_value_type_id;      /* BTF type_id of the value */
312         };
313
314         struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
315                 __u32           map_fd;
316                 __aligned_u64   key;
317                 union {
318                         __aligned_u64 value;
319                         __aligned_u64 next_key;
320                 };
321                 __u64           flags;
322         };
323
324         struct { /* anonymous struct used by BPF_PROG_LOAD command */
325                 __u32           prog_type;      /* one of enum bpf_prog_type */
326                 __u32           insn_cnt;
327                 __aligned_u64   insns;
328                 __aligned_u64   license;
329                 __u32           log_level;      /* verbosity level of verifier */
330                 __u32           log_size;       /* size of user buffer */
331                 __aligned_u64   log_buf;        /* user supplied buffer */
332                 __u32           kern_version;   /* checked when prog_type=kprobe */
333                 __u32           prog_flags;
334                 char            prog_name[BPF_OBJ_NAME_LEN];
335                 __u32           prog_ifindex;   /* ifindex of netdev to prep for */
336                 /* For some prog types expected attach type must be known at
337                  * load time to verify attach type specific parts of prog
338                  * (context accesses, allowed helpers, etc).
339                  */
340                 __u32           expected_attach_type;
341         };
342
343         struct { /* anonymous struct used by BPF_OBJ_* commands */
344                 __aligned_u64   pathname;
345                 __u32           bpf_fd;
346                 __u32           file_flags;
347         };
348
349         struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
350                 __u32           target_fd;      /* container object to attach to */
351                 __u32           attach_bpf_fd;  /* eBPF program to attach */
352                 __u32           attach_type;
353                 __u32           attach_flags;
354         };
355
356         struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
357                 __u32           prog_fd;
358                 __u32           retval;
359                 __u32           data_size_in;
360                 __u32           data_size_out;
361                 __aligned_u64   data_in;
362                 __aligned_u64   data_out;
363                 __u32           repeat;
364                 __u32           duration;
365         } test;
366
367         struct { /* anonymous struct used by BPF_*_GET_*_ID */
368                 union {
369                         __u32           start_id;
370                         __u32           prog_id;
371                         __u32           map_id;
372                         __u32           btf_id;
373                 };
374                 __u32           next_id;
375                 __u32           open_flags;
376         };
377
378         struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
379                 __u32           bpf_fd;
380                 __u32           info_len;
381                 __aligned_u64   info;
382         } info;
383
384         struct { /* anonymous struct used by BPF_PROG_QUERY command */
385                 __u32           target_fd;      /* container object to query */
386                 __u32           attach_type;
387                 __u32           query_flags;
388                 __u32           attach_flags;
389                 __aligned_u64   prog_ids;
390                 __u32           prog_cnt;
391         } query;
392
393         struct {
394                 __u64 name;
395                 __u32 prog_fd;
396         } raw_tracepoint;
397
398         struct { /* anonymous struct for BPF_BTF_LOAD */
399                 __aligned_u64   btf;
400                 __aligned_u64   btf_log_buf;
401                 __u32           btf_size;
402                 __u32           btf_log_size;
403                 __u32           btf_log_level;
404         };
405
406         struct {
407                 __u32           pid;            /* input: pid */
408                 __u32           fd;             /* input: fd */
409                 __u32           flags;          /* input: flags */
410                 __u32           buf_len;        /* input/output: buf len */
411                 __aligned_u64   buf;            /* input/output:
412                                                  *   tp_name for tracepoint
413                                                  *   symbol for kprobe
414                                                  *   filename for uprobe
415                                                  */
416                 __u32           prog_id;        /* output: prod_id */
417                 __u32           fd_type;        /* output: BPF_FD_TYPE_* */
418                 __u64           probe_offset;   /* output: probe_offset */
419                 __u64           probe_addr;     /* output: probe_addr */
420         } task_fd_query;
421 } __attribute__((aligned(8)));
422
423 /* The description below is an attempt at providing documentation to eBPF
424  * developers about the multiple available eBPF helper functions. It can be
425  * parsed and used to produce a manual page. The workflow is the following,
426  * and requires the rst2man utility:
427  *
428  *     $ ./scripts/bpf_helpers_doc.py \
429  *             --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst
430  *     $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7
431  *     $ man /tmp/bpf-helpers.7
432  *
433  * Note that in order to produce this external documentation, some RST
434  * formatting is used in the descriptions to get "bold" and "italics" in
435  * manual pages. Also note that the few trailing white spaces are
436  * intentional, removing them would break paragraphs for rst2man.
437  *
438  * Start of BPF helper function descriptions:
439  *
440  * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key)
441  *      Description
442  *              Perform a lookup in *map* for an entry associated to *key*.
443  *      Return
444  *              Map value associated to *key*, or **NULL** if no entry was
445  *              found.
446  *
447  * int bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags)
448  *      Description
449  *              Add or update the value of the entry associated to *key* in
450  *              *map* with *value*. *flags* is one of:
451  *
452  *              **BPF_NOEXIST**
453  *                      The entry for *key* must not exist in the map.
454  *              **BPF_EXIST**
455  *                      The entry for *key* must already exist in the map.
456  *              **BPF_ANY**
457  *                      No condition on the existence of the entry for *key*.
458  *
459  *              Flag value **BPF_NOEXIST** cannot be used for maps of types
460  *              **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY**  (all
461  *              elements always exist), the helper would return an error.
462  *      Return
463  *              0 on success, or a negative error in case of failure.
464  *
465  * int bpf_map_delete_elem(struct bpf_map *map, const void *key)
466  *      Description
467  *              Delete entry with *key* from *map*.
468  *      Return
469  *              0 on success, or a negative error in case of failure.
470  *
471  * int bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags)
472  *      Description
473  *              Push an element *value* in *map*. *flags* is one of:
474  *
475  *              **BPF_EXIST**
476  *              If the queue/stack is full, the oldest element is removed to
477  *              make room for this.
478  *      Return
479  *              0 on success, or a negative error in case of failure.
480  *
481  * int bpf_map_pop_elem(struct bpf_map *map, void *value)
482  *      Description
483  *              Pop an element from *map*.
484  * Return
485  *              0 on success, or a negative error in case of failure.
486  *
487  * int bpf_map_peek_elem(struct bpf_map *map, void *value)
488  *      Description
489  *              Get an element from *map* without removing it.
490  * Return
491  *              0 on success, or a negative error in case of failure.
492  *
493  * int bpf_probe_read(void *dst, u32 size, const void *src)
494  *      Description
495  *              For tracing programs, safely attempt to read *size* bytes from
496  *              address *src* and store the data in *dst*.
497  *      Return
498  *              0 on success, or a negative error in case of failure.
499  *
500  * u64 bpf_ktime_get_ns(void)
501  *      Description
502  *              Return the time elapsed since system boot, in nanoseconds.
503  *      Return
504  *              Current *ktime*.
505  *
506  * int bpf_trace_printk(const char *fmt, u32 fmt_size, ...)
507  *      Description
508  *              This helper is a "printk()-like" facility for debugging. It
509  *              prints a message defined by format *fmt* (of size *fmt_size*)
510  *              to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if
511  *              available. It can take up to three additional **u64**
512  *              arguments (as an eBPF helpers, the total number of arguments is
513  *              limited to five).
514  *
515  *              Each time the helper is called, it appends a line to the trace.
516  *              The format of the trace is customizable, and the exact output
517  *              one will get depends on the options set in
518  *              *\/sys/kernel/debug/tracing/trace_options* (see also the
519  *              *README* file under the same directory). However, it usually
520  *              defaults to something like:
521  *
522  *              ::
523  *
524  *                      telnet-470   [001] .N.. 419421.045894: 0x00000001: <formatted msg>
525  *
526  *              In the above:
527  *
528  *                      * ``telnet`` is the name of the current task.
529  *                      * ``470`` is the PID of the current task.
530  *                      * ``001`` is the CPU number on which the task is
531  *                        running.
532  *                      * In ``.N..``, each character refers to a set of
533  *                        options (whether irqs are enabled, scheduling
534  *                        options, whether hard/softirqs are running, level of
535  *                        preempt_disabled respectively). **N** means that
536  *                        **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED**
537  *                        are set.
538  *                      * ``419421.045894`` is a timestamp.
539  *                      * ``0x00000001`` is a fake value used by BPF for the
540  *                        instruction pointer register.
541  *                      * ``<formatted msg>`` is the message formatted with
542  *                        *fmt*.
543  *
544  *              The conversion specifiers supported by *fmt* are similar, but
545  *              more limited than for printk(). They are **%d**, **%i**,
546  *              **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**,
547  *              **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size
548  *              of field, padding with zeroes, etc.) is available, and the
549  *              helper will return **-EINVAL** (but print nothing) if it
550  *              encounters an unknown specifier.
551  *
552  *              Also, note that **bpf_trace_printk**\ () is slow, and should
553  *              only be used for debugging purposes. For this reason, a notice
554  *              bloc (spanning several lines) is printed to kernel logs and
555  *              states that the helper should not be used "for production use"
556  *              the first time this helper is used (or more precisely, when
557  *              **trace_printk**\ () buffers are allocated). For passing values
558  *              to user space, perf events should be preferred.
559  *      Return
560  *              The number of bytes written to the buffer, or a negative error
561  *              in case of failure.
562  *
563  * u32 bpf_get_prandom_u32(void)
564  *      Description
565  *              Get a pseudo-random number.
566  *
567  *              From a security point of view, this helper uses its own
568  *              pseudo-random internal state, and cannot be used to infer the
569  *              seed of other random functions in the kernel. However, it is
570  *              essential to note that the generator used by the helper is not
571  *              cryptographically secure.
572  *      Return
573  *              A random 32-bit unsigned value.
574  *
575  * u32 bpf_get_smp_processor_id(void)
576  *      Description
577  *              Get the SMP (symmetric multiprocessing) processor id. Note that
578  *              all programs run with preemption disabled, which means that the
579  *              SMP processor id is stable during all the execution of the
580  *              program.
581  *      Return
582  *              The SMP id of the processor running the program.
583  *
584  * int bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags)
585  *      Description
586  *              Store *len* bytes from address *from* into the packet
587  *              associated to *skb*, at *offset*. *flags* are a combination of
588  *              **BPF_F_RECOMPUTE_CSUM** (automatically recompute the
589  *              checksum for the packet after storing the bytes) and
590  *              **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
591  *              **->swhash** and *skb*\ **->l4hash** to 0).
592  *
593  *              A call to this helper is susceptible to change the underlaying
594  *              packet buffer. Therefore, at load time, all checks on pointers
595  *              previously done by the verifier are invalidated and must be
596  *              performed again, if the helper is used in combination with
597  *              direct packet access.
598  *      Return
599  *              0 on success, or a negative error in case of failure.
600  *
601  * int bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size)
602  *      Description
603  *              Recompute the layer 3 (e.g. IP) checksum for the packet
604  *              associated to *skb*. Computation is incremental, so the helper
605  *              must know the former value of the header field that was
606  *              modified (*from*), the new value of this field (*to*), and the
607  *              number of bytes (2 or 4) for this field, stored in *size*.
608  *              Alternatively, it is possible to store the difference between
609  *              the previous and the new values of the header field in *to*, by
610  *              setting *from* and *size* to 0. For both methods, *offset*
611  *              indicates the location of the IP checksum within the packet.
612  *
613  *              This helper works in combination with **bpf_csum_diff**\ (),
614  *              which does not update the checksum in-place, but offers more
615  *              flexibility and can handle sizes larger than 2 or 4 for the
616  *              checksum to update.
617  *
618  *              A call to this helper is susceptible to change the underlaying
619  *              packet buffer. Therefore, at load time, all checks on pointers
620  *              previously done by the verifier are invalidated and must be
621  *              performed again, if the helper is used in combination with
622  *              direct packet access.
623  *      Return
624  *              0 on success, or a negative error in case of failure.
625  *
626  * int bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags)
627  *      Description
628  *              Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the
629  *              packet associated to *skb*. Computation is incremental, so the
630  *              helper must know the former value of the header field that was
631  *              modified (*from*), the new value of this field (*to*), and the
632  *              number of bytes (2 or 4) for this field, stored on the lowest
633  *              four bits of *flags*. Alternatively, it is possible to store
634  *              the difference between the previous and the new values of the
635  *              header field in *to*, by setting *from* and the four lowest
636  *              bits of *flags* to 0. For both methods, *offset* indicates the
637  *              location of the IP checksum within the packet. In addition to
638  *              the size of the field, *flags* can be added (bitwise OR) actual
639  *              flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left
640  *              untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and
641  *              for updates resulting in a null checksum the value is set to
642  *              **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates
643  *              the checksum is to be computed against a pseudo-header.
644  *
645  *              This helper works in combination with **bpf_csum_diff**\ (),
646  *              which does not update the checksum in-place, but offers more
647  *              flexibility and can handle sizes larger than 2 or 4 for the
648  *              checksum to update.
649  *
650  *              A call to this helper is susceptible to change the underlaying
651  *              packet buffer. Therefore, at load time, all checks on pointers
652  *              previously done by the verifier are invalidated and must be
653  *              performed again, if the helper is used in combination with
654  *              direct packet access.
655  *      Return
656  *              0 on success, or a negative error in case of failure.
657  *
658  * int bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index)
659  *      Description
660  *              This special helper is used to trigger a "tail call", or in
661  *              other words, to jump into another eBPF program. The same stack
662  *              frame is used (but values on stack and in registers for the
663  *              caller are not accessible to the callee). This mechanism allows
664  *              for program chaining, either for raising the maximum number of
665  *              available eBPF instructions, or to execute given programs in
666  *              conditional blocks. For security reasons, there is an upper
667  *              limit to the number of successive tail calls that can be
668  *              performed.
669  *
670  *              Upon call of this helper, the program attempts to jump into a
671  *              program referenced at index *index* in *prog_array_map*, a
672  *              special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes
673  *              *ctx*, a pointer to the context.
674  *
675  *              If the call succeeds, the kernel immediately runs the first
676  *              instruction of the new program. This is not a function call,
677  *              and it never returns to the previous program. If the call
678  *              fails, then the helper has no effect, and the caller continues
679  *              to run its subsequent instructions. A call can fail if the
680  *              destination program for the jump does not exist (i.e. *index*
681  *              is superior to the number of entries in *prog_array_map*), or
682  *              if the maximum number of tail calls has been reached for this
683  *              chain of programs. This limit is defined in the kernel by the
684  *              macro **MAX_TAIL_CALL_CNT** (not accessible to user space),
685  *              which is currently set to 32.
686  *      Return
687  *              0 on success, or a negative error in case of failure.
688  *
689  * int bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags)
690  *      Description
691  *              Clone and redirect the packet associated to *skb* to another
692  *              net device of index *ifindex*. Both ingress and egress
693  *              interfaces can be used for redirection. The **BPF_F_INGRESS**
694  *              value in *flags* is used to make the distinction (ingress path
695  *              is selected if the flag is present, egress path otherwise).
696  *              This is the only flag supported for now.
697  *
698  *              In comparison with **bpf_redirect**\ () helper,
699  *              **bpf_clone_redirect**\ () has the associated cost of
700  *              duplicating the packet buffer, but this can be executed out of
701  *              the eBPF program. Conversely, **bpf_redirect**\ () is more
702  *              efficient, but it is handled through an action code where the
703  *              redirection happens only after the eBPF program has returned.
704  *
705  *              A call to this helper is susceptible to change the underlaying
706  *              packet buffer. Therefore, at load time, all checks on pointers
707  *              previously done by the verifier are invalidated and must be
708  *              performed again, if the helper is used in combination with
709  *              direct packet access.
710  *      Return
711  *              0 on success, or a negative error in case of failure.
712  *
713  * u64 bpf_get_current_pid_tgid(void)
714  *      Return
715  *              A 64-bit integer containing the current tgid and pid, and
716  *              created as such:
717  *              *current_task*\ **->tgid << 32 \|**
718  *              *current_task*\ **->pid**.
719  *
720  * u64 bpf_get_current_uid_gid(void)
721  *      Return
722  *              A 64-bit integer containing the current GID and UID, and
723  *              created as such: *current_gid* **<< 32 \|** *current_uid*.
724  *
725  * int bpf_get_current_comm(char *buf, u32 size_of_buf)
726  *      Description
727  *              Copy the **comm** attribute of the current task into *buf* of
728  *              *size_of_buf*. The **comm** attribute contains the name of
729  *              the executable (excluding the path) for the current task. The
730  *              *size_of_buf* must be strictly positive. On success, the
731  *              helper makes sure that the *buf* is NUL-terminated. On failure,
732  *              it is filled with zeroes.
733  *      Return
734  *              0 on success, or a negative error in case of failure.
735  *
736  * u32 bpf_get_cgroup_classid(struct sk_buff *skb)
737  *      Description
738  *              Retrieve the classid for the current task, i.e. for the net_cls
739  *              cgroup to which *skb* belongs.
740  *
741  *              This helper can be used on TC egress path, but not on ingress.
742  *
743  *              The net_cls cgroup provides an interface to tag network packets
744  *              based on a user-provided identifier for all traffic coming from
745  *              the tasks belonging to the related cgroup. See also the related
746  *              kernel documentation, available from the Linux sources in file
747  *              *Documentation/cgroup-v1/net_cls.txt*.
748  *
749  *              The Linux kernel has two versions for cgroups: there are
750  *              cgroups v1 and cgroups v2. Both are available to users, who can
751  *              use a mixture of them, but note that the net_cls cgroup is for
752  *              cgroup v1 only. This makes it incompatible with BPF programs
753  *              run on cgroups, which is a cgroup-v2-only feature (a socket can
754  *              only hold data for one version of cgroups at a time).
755  *
756  *              This helper is only available is the kernel was compiled with
757  *              the **CONFIG_CGROUP_NET_CLASSID** configuration option set to
758  *              "**y**" or to "**m**".
759  *      Return
760  *              The classid, or 0 for the default unconfigured classid.
761  *
762  * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci)
763  *      Description
764  *              Push a *vlan_tci* (VLAN tag control information) of protocol
765  *              *vlan_proto* to the packet associated to *skb*, then update
766  *              the checksum. Note that if *vlan_proto* is different from
767  *              **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
768  *              be **ETH_P_8021Q**.
769  *
770  *              A call to this helper is susceptible to change the underlaying
771  *              packet buffer. Therefore, at load time, all checks on pointers
772  *              previously done by the verifier are invalidated and must be
773  *              performed again, if the helper is used in combination with
774  *              direct packet access.
775  *      Return
776  *              0 on success, or a negative error in case of failure.
777  *
778  * int bpf_skb_vlan_pop(struct sk_buff *skb)
779  *      Description
780  *              Pop a VLAN header from the packet associated to *skb*.
781  *
782  *              A call to this helper is susceptible to change the underlaying
783  *              packet buffer. Therefore, at load time, all checks on pointers
784  *              previously done by the verifier are invalidated and must be
785  *              performed again, if the helper is used in combination with
786  *              direct packet access.
787  *      Return
788  *              0 on success, or a negative error in case of failure.
789  *
790  * int bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
791  *      Description
792  *              Get tunnel metadata. This helper takes a pointer *key* to an
793  *              empty **struct bpf_tunnel_key** of **size**, that will be
794  *              filled with tunnel metadata for the packet associated to *skb*.
795  *              The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which
796  *              indicates that the tunnel is based on IPv6 protocol instead of
797  *              IPv4.
798  *
799  *              The **struct bpf_tunnel_key** is an object that generalizes the
800  *              principal parameters used by various tunneling protocols into a
801  *              single struct. This way, it can be used to easily make a
802  *              decision based on the contents of the encapsulation header,
803  *              "summarized" in this struct. In particular, it holds the IP
804  *              address of the remote end (IPv4 or IPv6, depending on the case)
805  *              in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also,
806  *              this struct exposes the *key*\ **->tunnel_id**, which is
807  *              generally mapped to a VNI (Virtual Network Identifier), making
808  *              it programmable together with the **bpf_skb_set_tunnel_key**\
809  *              () helper.
810  *
811  *              Let's imagine that the following code is part of a program
812  *              attached to the TC ingress interface, on one end of a GRE
813  *              tunnel, and is supposed to filter out all messages coming from
814  *              remote ends with IPv4 address other than 10.0.0.1:
815  *
816  *              ::
817  *
818  *                      int ret;
819  *                      struct bpf_tunnel_key key = {};
820  *                      
821  *                      ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0);
822  *                      if (ret < 0)
823  *                              return TC_ACT_SHOT;     // drop packet
824  *                      
825  *                      if (key.remote_ipv4 != 0x0a000001)
826  *                              return TC_ACT_SHOT;     // drop packet
827  *                      
828  *                      return TC_ACT_OK;               // accept packet
829  *
830  *              This interface can also be used with all encapsulation devices
831  *              that can operate in "collect metadata" mode: instead of having
832  *              one network device per specific configuration, the "collect
833  *              metadata" mode only requires a single device where the
834  *              configuration can be extracted from this helper.
835  *
836  *              This can be used together with various tunnels such as VXLan,
837  *              Geneve, GRE or IP in IP (IPIP).
838  *      Return
839  *              0 on success, or a negative error in case of failure.
840  *
841  * int bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
842  *      Description
843  *              Populate tunnel metadata for packet associated to *skb.* The
844  *              tunnel metadata is set to the contents of *key*, of *size*. The
845  *              *flags* can be set to a combination of the following values:
846  *
847  *              **BPF_F_TUNINFO_IPV6**
848  *                      Indicate that the tunnel is based on IPv6 protocol
849  *                      instead of IPv4.
850  *              **BPF_F_ZERO_CSUM_TX**
851  *                      For IPv4 packets, add a flag to tunnel metadata
852  *                      indicating that checksum computation should be skipped
853  *                      and checksum set to zeroes.
854  *              **BPF_F_DONT_FRAGMENT**
855  *                      Add a flag to tunnel metadata indicating that the
856  *                      packet should not be fragmented.
857  *              **BPF_F_SEQ_NUMBER**
858  *                      Add a flag to tunnel metadata indicating that a
859  *                      sequence number should be added to tunnel header before
860  *                      sending the packet. This flag was added for GRE
861  *                      encapsulation, but might be used with other protocols
862  *                      as well in the future.
863  *
864  *              Here is a typical usage on the transmit path:
865  *
866  *              ::
867  *
868  *                      struct bpf_tunnel_key key;
869  *                           populate key ...
870  *                      bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0);
871  *                      bpf_clone_redirect(skb, vxlan_dev_ifindex, 0);
872  *
873  *              See also the description of the **bpf_skb_get_tunnel_key**\ ()
874  *              helper for additional information.
875  *      Return
876  *              0 on success, or a negative error in case of failure.
877  *
878  * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags)
879  *      Description
880  *              Read the value of a perf event counter. This helper relies on a
881  *              *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of
882  *              the perf event counter is selected when *map* is updated with
883  *              perf event file descriptors. The *map* is an array whose size
884  *              is the number of available CPUs, and each cell contains a value
885  *              relative to one CPU. The value to retrieve is indicated by
886  *              *flags*, that contains the index of the CPU to look up, masked
887  *              with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
888  *              **BPF_F_CURRENT_CPU** to indicate that the value for the
889  *              current CPU should be retrieved.
890  *
891  *              Note that before Linux 4.13, only hardware perf event can be
892  *              retrieved.
893  *
894  *              Also, be aware that the newer helper
895  *              **bpf_perf_event_read_value**\ () is recommended over
896  *              **bpf_perf_event_read**\ () in general. The latter has some ABI
897  *              quirks where error and counter value are used as a return code
898  *              (which is wrong to do since ranges may overlap). This issue is
899  *              fixed with **bpf_perf_event_read_value**\ (), which at the same
900  *              time provides more features over the **bpf_perf_event_read**\
901  *              () interface. Please refer to the description of
902  *              **bpf_perf_event_read_value**\ () for details.
903  *      Return
904  *              The value of the perf event counter read from the map, or a
905  *              negative error code in case of failure.
906  *
907  * int bpf_redirect(u32 ifindex, u64 flags)
908  *      Description
909  *              Redirect the packet to another net device of index *ifindex*.
910  *              This helper is somewhat similar to **bpf_clone_redirect**\
911  *              (), except that the packet is not cloned, which provides
912  *              increased performance.
913  *
914  *              Except for XDP, both ingress and egress interfaces can be used
915  *              for redirection. The **BPF_F_INGRESS** value in *flags* is used
916  *              to make the distinction (ingress path is selected if the flag
917  *              is present, egress path otherwise). Currently, XDP only
918  *              supports redirection to the egress interface, and accepts no
919  *              flag at all.
920  *
921  *              The same effect can be attained with the more generic
922  *              **bpf_redirect_map**\ (), which requires specific maps to be
923  *              used but offers better performance.
924  *      Return
925  *              For XDP, the helper returns **XDP_REDIRECT** on success or
926  *              **XDP_ABORTED** on error. For other program types, the values
927  *              are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on
928  *              error.
929  *
930  * u32 bpf_get_route_realm(struct sk_buff *skb)
931  *      Description
932  *              Retrieve the realm or the route, that is to say the
933  *              **tclassid** field of the destination for the *skb*. The
934  *              indentifier retrieved is a user-provided tag, similar to the
935  *              one used with the net_cls cgroup (see description for
936  *              **bpf_get_cgroup_classid**\ () helper), but here this tag is
937  *              held by a route (a destination entry), not by a task.
938  *
939  *              Retrieving this identifier works with the clsact TC egress hook
940  *              (see also **tc-bpf(8)**), or alternatively on conventional
941  *              classful egress qdiscs, but not on TC ingress path. In case of
942  *              clsact TC egress hook, this has the advantage that, internally,
943  *              the destination entry has not been dropped yet in the transmit
944  *              path. Therefore, the destination entry does not need to be
945  *              artificially held via **netif_keep_dst**\ () for a classful
946  *              qdisc until the *skb* is freed.
947  *
948  *              This helper is available only if the kernel was compiled with
949  *              **CONFIG_IP_ROUTE_CLASSID** configuration option.
950  *      Return
951  *              The realm of the route for the packet associated to *skb*, or 0
952  *              if none was found.
953  *
954  * int bpf_perf_event_output(struct pt_reg *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
955  *      Description
956  *              Write raw *data* blob into a special BPF perf event held by
957  *              *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
958  *              event must have the following attributes: **PERF_SAMPLE_RAW**
959  *              as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
960  *              **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
961  *
962  *              The *flags* are used to indicate the index in *map* for which
963  *              the value must be put, masked with **BPF_F_INDEX_MASK**.
964  *              Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
965  *              to indicate that the index of the current CPU core should be
966  *              used.
967  *
968  *              The value to write, of *size*, is passed through eBPF stack and
969  *              pointed by *data*.
970  *
971  *              The context of the program *ctx* needs also be passed to the
972  *              helper.
973  *
974  *              On user space, a program willing to read the values needs to
975  *              call **perf_event_open**\ () on the perf event (either for
976  *              one or for all CPUs) and to store the file descriptor into the
977  *              *map*. This must be done before the eBPF program can send data
978  *              into it. An example is available in file
979  *              *samples/bpf/trace_output_user.c* in the Linux kernel source
980  *              tree (the eBPF program counterpart is in
981  *              *samples/bpf/trace_output_kern.c*).
982  *
983  *              **bpf_perf_event_output**\ () achieves better performance
984  *              than **bpf_trace_printk**\ () for sharing data with user
985  *              space, and is much better suitable for streaming data from eBPF
986  *              programs.
987  *
988  *              Note that this helper is not restricted to tracing use cases
989  *              and can be used with programs attached to TC or XDP as well,
990  *              where it allows for passing data to user space listeners. Data
991  *              can be:
992  *
993  *              * Only custom structs,
994  *              * Only the packet payload, or
995  *              * A combination of both.
996  *      Return
997  *              0 on success, or a negative error in case of failure.
998  *
999  * int bpf_skb_load_bytes(const struct sk_buff *skb, u32 offset, void *to, u32 len)
1000  *      Description
1001  *              This helper was provided as an easy way to load data from a
1002  *              packet. It can be used to load *len* bytes from *offset* from
1003  *              the packet associated to *skb*, into the buffer pointed by
1004  *              *to*.
1005  *
1006  *              Since Linux 4.7, usage of this helper has mostly been replaced
1007  *              by "direct packet access", enabling packet data to be
1008  *              manipulated with *skb*\ **->data** and *skb*\ **->data_end**
1009  *              pointing respectively to the first byte of packet data and to
1010  *              the byte after the last byte of packet data. However, it
1011  *              remains useful if one wishes to read large quantities of data
1012  *              at once from a packet into the eBPF stack.
1013  *      Return
1014  *              0 on success, or a negative error in case of failure.
1015  *
1016  * int bpf_get_stackid(struct pt_reg *ctx, struct bpf_map *map, u64 flags)
1017  *      Description
1018  *              Walk a user or a kernel stack and return its id. To achieve
1019  *              this, the helper needs *ctx*, which is a pointer to the context
1020  *              on which the tracing program is executed, and a pointer to a
1021  *              *map* of type **BPF_MAP_TYPE_STACK_TRACE**.
1022  *
1023  *              The last argument, *flags*, holds the number of stack frames to
1024  *              skip (from 0 to 255), masked with
1025  *              **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
1026  *              a combination of the following flags:
1027  *
1028  *              **BPF_F_USER_STACK**
1029  *                      Collect a user space stack instead of a kernel stack.
1030  *              **BPF_F_FAST_STACK_CMP**
1031  *                      Compare stacks by hash only.
1032  *              **BPF_F_REUSE_STACKID**
1033  *                      If two different stacks hash into the same *stackid*,
1034  *                      discard the old one.
1035  *
1036  *              The stack id retrieved is a 32 bit long integer handle which
1037  *              can be further combined with other data (including other stack
1038  *              ids) and used as a key into maps. This can be useful for
1039  *              generating a variety of graphs (such as flame graphs or off-cpu
1040  *              graphs).
1041  *
1042  *              For walking a stack, this helper is an improvement over
1043  *              **bpf_probe_read**\ (), which can be used with unrolled loops
1044  *              but is not efficient and consumes a lot of eBPF instructions.
1045  *              Instead, **bpf_get_stackid**\ () can collect up to
1046  *              **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that
1047  *              this limit can be controlled with the **sysctl** program, and
1048  *              that it should be manually increased in order to profile long
1049  *              user stacks (such as stacks for Java programs). To do so, use:
1050  *
1051  *              ::
1052  *
1053  *                      # sysctl kernel.perf_event_max_stack=<new value>
1054  *      Return
1055  *              The positive or null stack id on success, or a negative error
1056  *              in case of failure.
1057  *
1058  * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed)
1059  *      Description
1060  *              Compute a checksum difference, from the raw buffer pointed by
1061  *              *from*, of length *from_size* (that must be a multiple of 4),
1062  *              towards the raw buffer pointed by *to*, of size *to_size*
1063  *              (same remark). An optional *seed* can be added to the value
1064  *              (this can be cascaded, the seed may come from a previous call
1065  *              to the helper).
1066  *
1067  *              This is flexible enough to be used in several ways:
1068  *
1069  *              * With *from_size* == 0, *to_size* > 0 and *seed* set to
1070  *                checksum, it can be used when pushing new data.
1071  *              * With *from_size* > 0, *to_size* == 0 and *seed* set to
1072  *                checksum, it can be used when removing data from a packet.
1073  *              * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it
1074  *                can be used to compute a diff. Note that *from_size* and
1075  *                *to_size* do not need to be equal.
1076  *
1077  *              This helper can be used in combination with
1078  *              **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to
1079  *              which one can feed in the difference computed with
1080  *              **bpf_csum_diff**\ ().
1081  *      Return
1082  *              The checksum result, or a negative error code in case of
1083  *              failure.
1084  *
1085  * int bpf_skb_get_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size)
1086  *      Description
1087  *              Retrieve tunnel options metadata for the packet associated to
1088  *              *skb*, and store the raw tunnel option data to the buffer *opt*
1089  *              of *size*.
1090  *
1091  *              This helper can be used with encapsulation devices that can
1092  *              operate in "collect metadata" mode (please refer to the related
1093  *              note in the description of **bpf_skb_get_tunnel_key**\ () for
1094  *              more details). A particular example where this can be used is
1095  *              in combination with the Geneve encapsulation protocol, where it
1096  *              allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper)
1097  *              and retrieving arbitrary TLVs (Type-Length-Value headers) from
1098  *              the eBPF program. This allows for full customization of these
1099  *              headers.
1100  *      Return
1101  *              The size of the option data retrieved.
1102  *
1103  * int bpf_skb_set_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size)
1104  *      Description
1105  *              Set tunnel options metadata for the packet associated to *skb*
1106  *              to the option data contained in the raw buffer *opt* of *size*.
1107  *
1108  *              See also the description of the **bpf_skb_get_tunnel_opt**\ ()
1109  *              helper for additional information.
1110  *      Return
1111  *              0 on success, or a negative error in case of failure.
1112  *
1113  * int bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags)
1114  *      Description
1115  *              Change the protocol of the *skb* to *proto*. Currently
1116  *              supported are transition from IPv4 to IPv6, and from IPv6 to
1117  *              IPv4. The helper takes care of the groundwork for the
1118  *              transition, including resizing the socket buffer. The eBPF
1119  *              program is expected to fill the new headers, if any, via
1120  *              **skb_store_bytes**\ () and to recompute the checksums with
1121  *              **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\
1122  *              (). The main case for this helper is to perform NAT64
1123  *              operations out of an eBPF program.
1124  *
1125  *              Internally, the GSO type is marked as dodgy so that headers are
1126  *              checked and segments are recalculated by the GSO/GRO engine.
1127  *              The size for GSO target is adapted as well.
1128  *
1129  *              All values for *flags* are reserved for future usage, and must
1130  *              be left at zero.
1131  *
1132  *              A call to this helper is susceptible to change the underlaying
1133  *              packet buffer. Therefore, at load time, all checks on pointers
1134  *              previously done by the verifier are invalidated and must be
1135  *              performed again, if the helper is used in combination with
1136  *              direct packet access.
1137  *      Return
1138  *              0 on success, or a negative error in case of failure.
1139  *
1140  * int bpf_skb_change_type(struct sk_buff *skb, u32 type)
1141  *      Description
1142  *              Change the packet type for the packet associated to *skb*. This
1143  *              comes down to setting *skb*\ **->pkt_type** to *type*, except
1144  *              the eBPF program does not have a write access to *skb*\
1145  *              **->pkt_type** beside this helper. Using a helper here allows
1146  *              for graceful handling of errors.
1147  *
1148  *              The major use case is to change incoming *skb*s to
1149  *              **PACKET_HOST** in a programmatic way instead of having to
1150  *              recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for
1151  *              example.
1152  *
1153  *              Note that *type* only allows certain values. At this time, they
1154  *              are:
1155  *
1156  *              **PACKET_HOST**
1157  *                      Packet is for us.
1158  *              **PACKET_BROADCAST**
1159  *                      Send packet to all.
1160  *              **PACKET_MULTICAST**
1161  *                      Send packet to group.
1162  *              **PACKET_OTHERHOST**
1163  *                      Send packet to someone else.
1164  *      Return
1165  *              0 on success, or a negative error in case of failure.
1166  *
1167  * int bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index)
1168  *      Description
1169  *              Check whether *skb* is a descendant of the cgroup2 held by
1170  *              *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
1171  *      Return
1172  *              The return value depends on the result of the test, and can be:
1173  *
1174  *              * 0, if the *skb* failed the cgroup2 descendant test.
1175  *              * 1, if the *skb* succeeded the cgroup2 descendant test.
1176  *              * A negative error code, if an error occurred.
1177  *
1178  * u32 bpf_get_hash_recalc(struct sk_buff *skb)
1179  *      Description
1180  *              Retrieve the hash of the packet, *skb*\ **->hash**. If it is
1181  *              not set, in particular if the hash was cleared due to mangling,
1182  *              recompute this hash. Later accesses to the hash can be done
1183  *              directly with *skb*\ **->hash**.
1184  *
1185  *              Calling **bpf_set_hash_invalid**\ (), changing a packet
1186  *              prototype with **bpf_skb_change_proto**\ (), or calling
1187  *              **bpf_skb_store_bytes**\ () with the
1188  *              **BPF_F_INVALIDATE_HASH** are actions susceptible to clear
1189  *              the hash and to trigger a new computation for the next call to
1190  *              **bpf_get_hash_recalc**\ ().
1191  *      Return
1192  *              The 32-bit hash.
1193  *
1194  * u64 bpf_get_current_task(void)
1195  *      Return
1196  *              A pointer to the current task struct.
1197  *
1198  * int bpf_probe_write_user(void *dst, const void *src, u32 len)
1199  *      Description
1200  *              Attempt in a safe way to write *len* bytes from the buffer
1201  *              *src* to *dst* in memory. It only works for threads that are in
1202  *              user context, and *dst* must be a valid user space address.
1203  *
1204  *              This helper should not be used to implement any kind of
1205  *              security mechanism because of TOC-TOU attacks, but rather to
1206  *              debug, divert, and manipulate execution of semi-cooperative
1207  *              processes.
1208  *
1209  *              Keep in mind that this feature is meant for experiments, and it
1210  *              has a risk of crashing the system and running programs.
1211  *              Therefore, when an eBPF program using this helper is attached,
1212  *              a warning including PID and process name is printed to kernel
1213  *              logs.
1214  *      Return
1215  *              0 on success, or a negative error in case of failure.
1216  *
1217  * int bpf_current_task_under_cgroup(struct bpf_map *map, u32 index)
1218  *      Description
1219  *              Check whether the probe is being run is the context of a given
1220  *              subset of the cgroup2 hierarchy. The cgroup2 to test is held by
1221  *              *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
1222  *      Return
1223  *              The return value depends on the result of the test, and can be:
1224  *
1225  *              * 0, if the *skb* task belongs to the cgroup2.
1226  *              * 1, if the *skb* task does not belong to the cgroup2.
1227  *              * A negative error code, if an error occurred.
1228  *
1229  * int bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags)
1230  *      Description
1231  *              Resize (trim or grow) the packet associated to *skb* to the
1232  *              new *len*. The *flags* are reserved for future usage, and must
1233  *              be left at zero.
1234  *
1235  *              The basic idea is that the helper performs the needed work to
1236  *              change the size of the packet, then the eBPF program rewrites
1237  *              the rest via helpers like **bpf_skb_store_bytes**\ (),
1238  *              **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ ()
1239  *              and others. This helper is a slow path utility intended for
1240  *              replies with control messages. And because it is targeted for
1241  *              slow path, the helper itself can afford to be slow: it
1242  *              implicitly linearizes, unclones and drops offloads from the
1243  *              *skb*.
1244  *
1245  *              A call to this helper is susceptible to change the underlaying
1246  *              packet buffer. Therefore, at load time, all checks on pointers
1247  *              previously done by the verifier are invalidated and must be
1248  *              performed again, if the helper is used in combination with
1249  *              direct packet access.
1250  *      Return
1251  *              0 on success, or a negative error in case of failure.
1252  *
1253  * int bpf_skb_pull_data(struct sk_buff *skb, u32 len)
1254  *      Description
1255  *              Pull in non-linear data in case the *skb* is non-linear and not
1256  *              all of *len* are part of the linear section. Make *len* bytes
1257  *              from *skb* readable and writable. If a zero value is passed for
1258  *              *len*, then the whole length of the *skb* is pulled.
1259  *
1260  *              This helper is only needed for reading and writing with direct
1261  *              packet access.
1262  *
1263  *              For direct packet access, testing that offsets to access
1264  *              are within packet boundaries (test on *skb*\ **->data_end**) is
1265  *              susceptible to fail if offsets are invalid, or if the requested
1266  *              data is in non-linear parts of the *skb*. On failure the
1267  *              program can just bail out, or in the case of a non-linear
1268  *              buffer, use a helper to make the data available. The
1269  *              **bpf_skb_load_bytes**\ () helper is a first solution to access
1270  *              the data. Another one consists in using **bpf_skb_pull_data**
1271  *              to pull in once the non-linear parts, then retesting and
1272  *              eventually access the data.
1273  *
1274  *              At the same time, this also makes sure the *skb* is uncloned,
1275  *              which is a necessary condition for direct write. As this needs
1276  *              to be an invariant for the write part only, the verifier
1277  *              detects writes and adds a prologue that is calling
1278  *              **bpf_skb_pull_data()** to effectively unclone the *skb* from
1279  *              the very beginning in case it is indeed cloned.
1280  *
1281  *              A call to this helper is susceptible to change the underlaying
1282  *              packet buffer. Therefore, at load time, all checks on pointers
1283  *              previously done by the verifier are invalidated and must be
1284  *              performed again, if the helper is used in combination with
1285  *              direct packet access.
1286  *      Return
1287  *              0 on success, or a negative error in case of failure.
1288  *
1289  * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum)
1290  *      Description
1291  *              Add the checksum *csum* into *skb*\ **->csum** in case the
1292  *              driver has supplied a checksum for the entire packet into that
1293  *              field. Return an error otherwise. This helper is intended to be
1294  *              used in combination with **bpf_csum_diff**\ (), in particular
1295  *              when the checksum needs to be updated after data has been
1296  *              written into the packet through direct packet access.
1297  *      Return
1298  *              The checksum on success, or a negative error code in case of
1299  *              failure.
1300  *
1301  * void bpf_set_hash_invalid(struct sk_buff *skb)
1302  *      Description
1303  *              Invalidate the current *skb*\ **->hash**. It can be used after
1304  *              mangling on headers through direct packet access, in order to
1305  *              indicate that the hash is outdated and to trigger a
1306  *              recalculation the next time the kernel tries to access this
1307  *              hash or when the **bpf_get_hash_recalc**\ () helper is called.
1308  *
1309  * int bpf_get_numa_node_id(void)
1310  *      Description
1311  *              Return the id of the current NUMA node. The primary use case
1312  *              for this helper is the selection of sockets for the local NUMA
1313  *              node, when the program is attached to sockets using the
1314  *              **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**),
1315  *              but the helper is also available to other eBPF program types,
1316  *              similarly to **bpf_get_smp_processor_id**\ ().
1317  *      Return
1318  *              The id of current NUMA node.
1319  *
1320  * int bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags)
1321  *      Description
1322  *              Grows headroom of packet associated to *skb* and adjusts the
1323  *              offset of the MAC header accordingly, adding *len* bytes of
1324  *              space. It automatically extends and reallocates memory as
1325  *              required.
1326  *
1327  *              This helper can be used on a layer 3 *skb* to push a MAC header
1328  *              for redirection into a layer 2 device.
1329  *
1330  *              All values for *flags* are reserved for future usage, and must
1331  *              be left at zero.
1332  *
1333  *              A call to this helper is susceptible to change the underlaying
1334  *              packet buffer. Therefore, at load time, all checks on pointers
1335  *              previously done by the verifier are invalidated and must be
1336  *              performed again, if the helper is used in combination with
1337  *              direct packet access.
1338  *      Return
1339  *              0 on success, or a negative error in case of failure.
1340  *
1341  * int bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta)
1342  *      Description
1343  *              Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that
1344  *              it is possible to use a negative value for *delta*. This helper
1345  *              can be used to prepare the packet for pushing or popping
1346  *              headers.
1347  *
1348  *              A call to this helper is susceptible to change the underlaying
1349  *              packet buffer. Therefore, at load time, all checks on pointers
1350  *              previously done by the verifier are invalidated and must be
1351  *              performed again, if the helper is used in combination with
1352  *              direct packet access.
1353  *      Return
1354  *              0 on success, or a negative error in case of failure.
1355  *
1356  * int bpf_probe_read_str(void *dst, int size, const void *unsafe_ptr)
1357  *      Description
1358  *              Copy a NUL terminated string from an unsafe address
1359  *              *unsafe_ptr* to *dst*. The *size* should include the
1360  *              terminating NUL byte. In case the string length is smaller than
1361  *              *size*, the target is not padded with further NUL bytes. If the
1362  *              string length is larger than *size*, just *size*-1 bytes are
1363  *              copied and the last byte is set to NUL.
1364  *
1365  *              On success, the length of the copied string is returned. This
1366  *              makes this helper useful in tracing programs for reading
1367  *              strings, and more importantly to get its length at runtime. See
1368  *              the following snippet:
1369  *
1370  *              ::
1371  *
1372  *                      SEC("kprobe/sys_open")
1373  *                      void bpf_sys_open(struct pt_regs *ctx)
1374  *                      {
1375  *                              char buf[PATHLEN]; // PATHLEN is defined to 256
1376  *                              int res = bpf_probe_read_str(buf, sizeof(buf),
1377  *                                                           ctx->di);
1378  *
1379  *                              // Consume buf, for example push it to
1380  *                              // userspace via bpf_perf_event_output(); we
1381  *                              // can use res (the string length) as event
1382  *                              // size, after checking its boundaries.
1383  *                      }
1384  *
1385  *              In comparison, using **bpf_probe_read()** helper here instead
1386  *              to read the string would require to estimate the length at
1387  *              compile time, and would often result in copying more memory
1388  *              than necessary.
1389  *
1390  *              Another useful use case is when parsing individual process
1391  *              arguments or individual environment variables navigating
1392  *              *current*\ **->mm->arg_start** and *current*\
1393  *              **->mm->env_start**: using this helper and the return value,
1394  *              one can quickly iterate at the right offset of the memory area.
1395  *      Return
1396  *              On success, the strictly positive length of the string,
1397  *              including the trailing NUL character. On error, a negative
1398  *              value.
1399  *
1400  * u64 bpf_get_socket_cookie(struct sk_buff *skb)
1401  *      Description
1402  *              If the **struct sk_buff** pointed by *skb* has a known socket,
1403  *              retrieve the cookie (generated by the kernel) of this socket.
1404  *              If no cookie has been set yet, generate a new cookie. Once
1405  *              generated, the socket cookie remains stable for the life of the
1406  *              socket. This helper can be useful for monitoring per socket
1407  *              networking traffic statistics as it provides a unique socket
1408  *              identifier per namespace.
1409  *      Return
1410  *              A 8-byte long non-decreasing number on success, or 0 if the
1411  *              socket field is missing inside *skb*.
1412  *
1413  * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx)
1414  *      Description
1415  *              Equivalent to bpf_get_socket_cookie() helper that accepts
1416  *              *skb*, but gets socket from **struct bpf_sock_addr** contex.
1417  *      Return
1418  *              A 8-byte long non-decreasing number.
1419  *
1420  * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx)
1421  *      Description
1422  *              Equivalent to bpf_get_socket_cookie() helper that accepts
1423  *              *skb*, but gets socket from **struct bpf_sock_ops** contex.
1424  *      Return
1425  *              A 8-byte long non-decreasing number.
1426  *
1427  * u32 bpf_get_socket_uid(struct sk_buff *skb)
1428  *      Return
1429  *              The owner UID of the socket associated to *skb*. If the socket
1430  *              is **NULL**, or if it is not a full socket (i.e. if it is a
1431  *              time-wait or a request socket instead), **overflowuid** value
1432  *              is returned (note that **overflowuid** might also be the actual
1433  *              UID value for the socket).
1434  *
1435  * u32 bpf_set_hash(struct sk_buff *skb, u32 hash)
1436  *      Description
1437  *              Set the full hash for *skb* (set the field *skb*\ **->hash**)
1438  *              to value *hash*.
1439  *      Return
1440  *              0
1441  *
1442  * int bpf_setsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, char *optval, int optlen)
1443  *      Description
1444  *              Emulate a call to **setsockopt()** on the socket associated to
1445  *              *bpf_socket*, which must be a full socket. The *level* at
1446  *              which the option resides and the name *optname* of the option
1447  *              must be specified, see **setsockopt(2)** for more information.
1448  *              The option value of length *optlen* is pointed by *optval*.
1449  *
1450  *              This helper actually implements a subset of **setsockopt()**.
1451  *              It supports the following *level*\ s:
1452  *
1453  *              * **SOL_SOCKET**, which supports the following *optname*\ s:
1454  *                **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,
1455  *                **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**.
1456  *              * **IPPROTO_TCP**, which supports the following *optname*\ s:
1457  *                **TCP_CONGESTION**, **TCP_BPF_IW**,
1458  *                **TCP_BPF_SNDCWND_CLAMP**.
1459  *              * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
1460  *              * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
1461  *      Return
1462  *              0 on success, or a negative error in case of failure.
1463  *
1464  * int bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags)
1465  *      Description
1466  *              Grow or shrink the room for data in the packet associated to
1467  *              *skb* by *len_diff*, and according to the selected *mode*.
1468  *
1469  *              There is a single supported mode at this time:
1470  *
1471  *              * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer
1472  *                (room space is added or removed below the layer 3 header).
1473  *
1474  *              All values for *flags* are reserved for future usage, and must
1475  *              be left at zero.
1476  *
1477  *              A call to this helper is susceptible to change the underlaying
1478  *              packet buffer. Therefore, at load time, all checks on pointers
1479  *              previously done by the verifier are invalidated and must be
1480  *              performed again, if the helper is used in combination with
1481  *              direct packet access.
1482  *      Return
1483  *              0 on success, or a negative error in case of failure.
1484  *
1485  * int bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
1486  *      Description
1487  *              Redirect the packet to the endpoint referenced by *map* at
1488  *              index *key*. Depending on its type, this *map* can contain
1489  *              references to net devices (for forwarding packets through other
1490  *              ports), or to CPUs (for redirecting XDP frames to another CPU;
1491  *              but this is only implemented for native XDP (with driver
1492  *              support) as of this writing).
1493  *
1494  *              All values for *flags* are reserved for future usage, and must
1495  *              be left at zero.
1496  *
1497  *              When used to redirect packets to net devices, this helper
1498  *              provides a high performance increase over **bpf_redirect**\ ().
1499  *              This is due to various implementation details of the underlying
1500  *              mechanisms, one of which is the fact that **bpf_redirect_map**\
1501  *              () tries to send packet as a "bulk" to the device.
1502  *      Return
1503  *              **XDP_REDIRECT** on success, or **XDP_ABORTED** on error.
1504  *
1505  * int bpf_sk_redirect_map(struct bpf_map *map, u32 key, u64 flags)
1506  *      Description
1507  *              Redirect the packet to the socket referenced by *map* (of type
1508  *              **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
1509  *              egress interfaces can be used for redirection. The
1510  *              **BPF_F_INGRESS** value in *flags* is used to make the
1511  *              distinction (ingress path is selected if the flag is present,
1512  *              egress path otherwise). This is the only flag supported for now.
1513  *      Return
1514  *              **SK_PASS** on success, or **SK_DROP** on error.
1515  *
1516  * int bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
1517  *      Description
1518  *              Add an entry to, or update a *map* referencing sockets. The
1519  *              *skops* is used as a new value for the entry associated to
1520  *              *key*. *flags* is one of:
1521  *
1522  *              **BPF_NOEXIST**
1523  *                      The entry for *key* must not exist in the map.
1524  *              **BPF_EXIST**
1525  *                      The entry for *key* must already exist in the map.
1526  *              **BPF_ANY**
1527  *                      No condition on the existence of the entry for *key*.
1528  *
1529  *              If the *map* has eBPF programs (parser and verdict), those will
1530  *              be inherited by the socket being added. If the socket is
1531  *              already attached to eBPF programs, this results in an error.
1532  *      Return
1533  *              0 on success, or a negative error in case of failure.
1534  *
1535  * int bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta)
1536  *      Description
1537  *              Adjust the address pointed by *xdp_md*\ **->data_meta** by
1538  *              *delta* (which can be positive or negative). Note that this
1539  *              operation modifies the address stored in *xdp_md*\ **->data**,
1540  *              so the latter must be loaded only after the helper has been
1541  *              called.
1542  *
1543  *              The use of *xdp_md*\ **->data_meta** is optional and programs
1544  *              are not required to use it. The rationale is that when the
1545  *              packet is processed with XDP (e.g. as DoS filter), it is
1546  *              possible to push further meta data along with it before passing
1547  *              to the stack, and to give the guarantee that an ingress eBPF
1548  *              program attached as a TC classifier on the same device can pick
1549  *              this up for further post-processing. Since TC works with socket
1550  *              buffers, it remains possible to set from XDP the **mark** or
1551  *              **priority** pointers, or other pointers for the socket buffer.
1552  *              Having this scratch space generic and programmable allows for
1553  *              more flexibility as the user is free to store whatever meta
1554  *              data they need.
1555  *
1556  *              A call to this helper is susceptible to change the underlaying
1557  *              packet buffer. Therefore, at load time, all checks on pointers
1558  *              previously done by the verifier are invalidated and must be
1559  *              performed again, if the helper is used in combination with
1560  *              direct packet access.
1561  *      Return
1562  *              0 on success, or a negative error in case of failure.
1563  *
1564  * int bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size)
1565  *      Description
1566  *              Read the value of a perf event counter, and store it into *buf*
1567  *              of size *buf_size*. This helper relies on a *map* of type
1568  *              **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event
1569  *              counter is selected when *map* is updated with perf event file
1570  *              descriptors. The *map* is an array whose size is the number of
1571  *              available CPUs, and each cell contains a value relative to one
1572  *              CPU. The value to retrieve is indicated by *flags*, that
1573  *              contains the index of the CPU to look up, masked with
1574  *              **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
1575  *              **BPF_F_CURRENT_CPU** to indicate that the value for the
1576  *              current CPU should be retrieved.
1577  *
1578  *              This helper behaves in a way close to
1579  *              **bpf_perf_event_read**\ () helper, save that instead of
1580  *              just returning the value observed, it fills the *buf*
1581  *              structure. This allows for additional data to be retrieved: in
1582  *              particular, the enabled and running times (in *buf*\
1583  *              **->enabled** and *buf*\ **->running**, respectively) are
1584  *              copied. In general, **bpf_perf_event_read_value**\ () is
1585  *              recommended over **bpf_perf_event_read**\ (), which has some
1586  *              ABI issues and provides fewer functionalities.
1587  *
1588  *              These values are interesting, because hardware PMU (Performance
1589  *              Monitoring Unit) counters are limited resources. When there are
1590  *              more PMU based perf events opened than available counters,
1591  *              kernel will multiplex these events so each event gets certain
1592  *              percentage (but not all) of the PMU time. In case that
1593  *              multiplexing happens, the number of samples or counter value
1594  *              will not reflect the case compared to when no multiplexing
1595  *              occurs. This makes comparison between different runs difficult.
1596  *              Typically, the counter value should be normalized before
1597  *              comparing to other experiments. The usual normalization is done
1598  *              as follows.
1599  *
1600  *              ::
1601  *
1602  *                      normalized_counter = counter * t_enabled / t_running
1603  *
1604  *              Where t_enabled is the time enabled for event and t_running is
1605  *              the time running for event since last normalization. The
1606  *              enabled and running times are accumulated since the perf event
1607  *              open. To achieve scaling factor between two invocations of an
1608  *              eBPF program, users can can use CPU id as the key (which is
1609  *              typical for perf array usage model) to remember the previous
1610  *              value and do the calculation inside the eBPF program.
1611  *      Return
1612  *              0 on success, or a negative error in case of failure.
1613  *
1614  * int bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size)
1615  *      Description
1616  *              For en eBPF program attached to a perf event, retrieve the
1617  *              value of the event counter associated to *ctx* and store it in
1618  *              the structure pointed by *buf* and of size *buf_size*. Enabled
1619  *              and running times are also stored in the structure (see
1620  *              description of helper **bpf_perf_event_read_value**\ () for
1621  *              more details).
1622  *      Return
1623  *              0 on success, or a negative error in case of failure.
1624  *
1625  * int bpf_getsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, char *optval, int optlen)
1626  *      Description
1627  *              Emulate a call to **getsockopt()** on the socket associated to
1628  *              *bpf_socket*, which must be a full socket. The *level* at
1629  *              which the option resides and the name *optname* of the option
1630  *              must be specified, see **getsockopt(2)** for more information.
1631  *              The retrieved value is stored in the structure pointed by
1632  *              *opval* and of length *optlen*.
1633  *
1634  *              This helper actually implements a subset of **getsockopt()**.
1635  *              It supports the following *level*\ s:
1636  *
1637  *              * **IPPROTO_TCP**, which supports *optname*
1638  *                **TCP_CONGESTION**.
1639  *              * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
1640  *              * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
1641  *      Return
1642  *              0 on success, or a negative error in case of failure.
1643  *
1644  * int bpf_override_return(struct pt_reg *regs, u64 rc)
1645  *      Description
1646  *              Used for error injection, this helper uses kprobes to override
1647  *              the return value of the probed function, and to set it to *rc*.
1648  *              The first argument is the context *regs* on which the kprobe
1649  *              works.
1650  *
1651  *              This helper works by setting setting the PC (program counter)
1652  *              to an override function which is run in place of the original
1653  *              probed function. This means the probed function is not run at
1654  *              all. The replacement function just returns with the required
1655  *              value.
1656  *
1657  *              This helper has security implications, and thus is subject to
1658  *              restrictions. It is only available if the kernel was compiled
1659  *              with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration
1660  *              option, and in this case it only works on functions tagged with
1661  *              **ALLOW_ERROR_INJECTION** in the kernel code.
1662  *
1663  *              Also, the helper is only available for the architectures having
1664  *              the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing,
1665  *              x86 architecture is the only one to support this feature.
1666  *      Return
1667  *              0
1668  *
1669  * int bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval)
1670  *      Description
1671  *              Attempt to set the value of the **bpf_sock_ops_cb_flags** field
1672  *              for the full TCP socket associated to *bpf_sock_ops* to
1673  *              *argval*.
1674  *
1675  *              The primary use of this field is to determine if there should
1676  *              be calls to eBPF programs of type
1677  *              **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP
1678  *              code. A program of the same type can change its value, per
1679  *              connection and as necessary, when the connection is
1680  *              established. This field is directly accessible for reading, but
1681  *              this helper must be used for updates in order to return an
1682  *              error if an eBPF program tries to set a callback that is not
1683  *              supported in the current kernel.
1684  *
1685  *              The supported callback values that *argval* can combine are:
1686  *
1687  *              * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out)
1688  *              * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission)
1689  *              * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change)
1690  *
1691  *              Here are some examples of where one could call such eBPF
1692  *              program:
1693  *
1694  *              * When RTO fires.
1695  *              * When a packet is retransmitted.
1696  *              * When the connection terminates.
1697  *              * When a packet is sent.
1698  *              * When a packet is received.
1699  *      Return
1700  *              Code **-EINVAL** if the socket is not a full TCP socket;
1701  *              otherwise, a positive number containing the bits that could not
1702  *              be set is returned (which comes down to 0 if all bits were set
1703  *              as required).
1704  *
1705  * int bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags)
1706  *      Description
1707  *              This helper is used in programs implementing policies at the
1708  *              socket level. If the message *msg* is allowed to pass (i.e. if
1709  *              the verdict eBPF program returns **SK_PASS**), redirect it to
1710  *              the socket referenced by *map* (of type
1711  *              **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
1712  *              egress interfaces can be used for redirection. The
1713  *              **BPF_F_INGRESS** value in *flags* is used to make the
1714  *              distinction (ingress path is selected if the flag is present,
1715  *              egress path otherwise). This is the only flag supported for now.
1716  *      Return
1717  *              **SK_PASS** on success, or **SK_DROP** on error.
1718  *
1719  * int bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes)
1720  *      Description
1721  *              For socket policies, apply the verdict of the eBPF program to
1722  *              the next *bytes* (number of bytes) of message *msg*.
1723  *
1724  *              For example, this helper can be used in the following cases:
1725  *
1726  *              * A single **sendmsg**\ () or **sendfile**\ () system call
1727  *                contains multiple logical messages that the eBPF program is
1728  *                supposed to read and for which it should apply a verdict.
1729  *              * An eBPF program only cares to read the first *bytes* of a
1730  *                *msg*. If the message has a large payload, then setting up
1731  *                and calling the eBPF program repeatedly for all bytes, even
1732  *                though the verdict is already known, would create unnecessary
1733  *                overhead.
1734  *
1735  *              When called from within an eBPF program, the helper sets a
1736  *              counter internal to the BPF infrastructure, that is used to
1737  *              apply the last verdict to the next *bytes*. If *bytes* is
1738  *              smaller than the current data being processed from a
1739  *              **sendmsg**\ () or **sendfile**\ () system call, the first
1740  *              *bytes* will be sent and the eBPF program will be re-run with
1741  *              the pointer for start of data pointing to byte number *bytes*
1742  *              **+ 1**. If *bytes* is larger than the current data being
1743  *              processed, then the eBPF verdict will be applied to multiple
1744  *              **sendmsg**\ () or **sendfile**\ () calls until *bytes* are
1745  *              consumed.
1746  *
1747  *              Note that if a socket closes with the internal counter holding
1748  *              a non-zero value, this is not a problem because data is not
1749  *              being buffered for *bytes* and is sent as it is received.
1750  *      Return
1751  *              0
1752  *
1753  * int bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes)
1754  *      Description
1755  *              For socket policies, prevent the execution of the verdict eBPF
1756  *              program for message *msg* until *bytes* (byte number) have been
1757  *              accumulated.
1758  *
1759  *              This can be used when one needs a specific number of bytes
1760  *              before a verdict can be assigned, even if the data spans
1761  *              multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme
1762  *              case would be a user calling **sendmsg**\ () repeatedly with
1763  *              1-byte long message segments. Obviously, this is bad for
1764  *              performance, but it is still valid. If the eBPF program needs
1765  *              *bytes* bytes to validate a header, this helper can be used to
1766  *              prevent the eBPF program to be called again until *bytes* have
1767  *              been accumulated.
1768  *      Return
1769  *              0
1770  *
1771  * int bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags)
1772  *      Description
1773  *              For socket policies, pull in non-linear data from user space
1774  *              for *msg* and set pointers *msg*\ **->data** and *msg*\
1775  *              **->data_end** to *start* and *end* bytes offsets into *msg*,
1776  *              respectively.
1777  *
1778  *              If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
1779  *              *msg* it can only parse data that the (**data**, **data_end**)
1780  *              pointers have already consumed. For **sendmsg**\ () hooks this
1781  *              is likely the first scatterlist element. But for calls relying
1782  *              on the **sendpage** handler (e.g. **sendfile**\ ()) this will
1783  *              be the range (**0**, **0**) because the data is shared with
1784  *              user space and by default the objective is to avoid allowing
1785  *              user space to modify data while (or after) eBPF verdict is
1786  *              being decided. This helper can be used to pull in data and to
1787  *              set the start and end pointer to given values. Data will be
1788  *              copied if necessary (i.e. if data was not linear and if start
1789  *              and end pointers do not point to the same chunk).
1790  *
1791  *              A call to this helper is susceptible to change the underlaying
1792  *              packet buffer. Therefore, at load time, all checks on pointers
1793  *              previously done by the verifier are invalidated and must be
1794  *              performed again, if the helper is used in combination with
1795  *              direct packet access.
1796  *
1797  *              All values for *flags* are reserved for future usage, and must
1798  *              be left at zero.
1799  *      Return
1800  *              0 on success, or a negative error in case of failure.
1801  *
1802  * int bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len)
1803  *      Description
1804  *              Bind the socket associated to *ctx* to the address pointed by
1805  *              *addr*, of length *addr_len*. This allows for making outgoing
1806  *              connection from the desired IP address, which can be useful for
1807  *              example when all processes inside a cgroup should use one
1808  *              single IP address on a host that has multiple IP configured.
1809  *
1810  *              This helper works for IPv4 and IPv6, TCP and UDP sockets. The
1811  *              domain (*addr*\ **->sa_family**) must be **AF_INET** (or
1812  *              **AF_INET6**). Looking for a free port to bind to can be
1813  *              expensive, therefore binding to port is not permitted by the
1814  *              helper: *addr*\ **->sin_port** (or **sin6_port**, respectively)
1815  *              must be set to zero.
1816  *      Return
1817  *              0 on success, or a negative error in case of failure.
1818  *
1819  * int bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta)
1820  *      Description
1821  *              Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is
1822  *              only possible to shrink the packet as of this writing,
1823  *              therefore *delta* must be a negative integer.
1824  *
1825  *              A call to this helper is susceptible to change the underlaying
1826  *              packet buffer. Therefore, at load time, all checks on pointers
1827  *              previously done by the verifier are invalidated and must be
1828  *              performed again, if the helper is used in combination with
1829  *              direct packet access.
1830  *      Return
1831  *              0 on success, or a negative error in case of failure.
1832  *
1833  * int bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags)
1834  *      Description
1835  *              Retrieve the XFRM state (IP transform framework, see also
1836  *              **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*.
1837  *
1838  *              The retrieved value is stored in the **struct bpf_xfrm_state**
1839  *              pointed by *xfrm_state* and of length *size*.
1840  *
1841  *              All values for *flags* are reserved for future usage, and must
1842  *              be left at zero.
1843  *
1844  *              This helper is available only if the kernel was compiled with
1845  *              **CONFIG_XFRM** configuration option.
1846  *      Return
1847  *              0 on success, or a negative error in case of failure.
1848  *
1849  * int bpf_get_stack(struct pt_regs *regs, void *buf, u32 size, u64 flags)
1850  *      Description
1851  *              Return a user or a kernel stack in bpf program provided buffer.
1852  *              To achieve this, the helper needs *ctx*, which is a pointer
1853  *              to the context on which the tracing program is executed.
1854  *              To store the stacktrace, the bpf program provides *buf* with
1855  *              a nonnegative *size*.
1856  *
1857  *              The last argument, *flags*, holds the number of stack frames to
1858  *              skip (from 0 to 255), masked with
1859  *              **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
1860  *              the following flags:
1861  *
1862  *              **BPF_F_USER_STACK**
1863  *                      Collect a user space stack instead of a kernel stack.
1864  *              **BPF_F_USER_BUILD_ID**
1865  *                      Collect buildid+offset instead of ips for user stack,
1866  *                      only valid if **BPF_F_USER_STACK** is also specified.
1867  *
1868  *              **bpf_get_stack**\ () can collect up to
1869  *              **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
1870  *              to sufficient large buffer size. Note that
1871  *              this limit can be controlled with the **sysctl** program, and
1872  *              that it should be manually increased in order to profile long
1873  *              user stacks (such as stacks for Java programs). To do so, use:
1874  *
1875  *              ::
1876  *
1877  *                      # sysctl kernel.perf_event_max_stack=<new value>
1878  *      Return
1879  *              A non-negative value equal to or less than *size* on success,
1880  *              or a negative error in case of failure.
1881  *
1882  * int bpf_skb_load_bytes_relative(const struct sk_buff *skb, u32 offset, void *to, u32 len, u32 start_header)
1883  *      Description
1884  *              This helper is similar to **bpf_skb_load_bytes**\ () in that
1885  *              it provides an easy way to load *len* bytes from *offset*
1886  *              from the packet associated to *skb*, into the buffer pointed
1887  *              by *to*. The difference to **bpf_skb_load_bytes**\ () is that
1888  *              a fifth argument *start_header* exists in order to select a
1889  *              base offset to start from. *start_header* can be one of:
1890  *
1891  *              **BPF_HDR_START_MAC**
1892  *                      Base offset to load data from is *skb*'s mac header.
1893  *              **BPF_HDR_START_NET**
1894  *                      Base offset to load data from is *skb*'s network header.
1895  *
1896  *              In general, "direct packet access" is the preferred method to
1897  *              access packet data, however, this helper is in particular useful
1898  *              in socket filters where *skb*\ **->data** does not always point
1899  *              to the start of the mac header and where "direct packet access"
1900  *              is not available.
1901  *      Return
1902  *              0 on success, or a negative error in case of failure.
1903  *
1904  * int bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags)
1905  *      Description
1906  *              Do FIB lookup in kernel tables using parameters in *params*.
1907  *              If lookup is successful and result shows packet is to be
1908  *              forwarded, the neighbor tables are searched for the nexthop.
1909  *              If successful (ie., FIB lookup shows forwarding and nexthop
1910  *              is resolved), the nexthop address is returned in ipv4_dst
1911  *              or ipv6_dst based on family, smac is set to mac address of
1912  *              egress device, dmac is set to nexthop mac address, rt_metric
1913  *              is set to metric from route (IPv4/IPv6 only), and ifindex
1914  *              is set to the device index of the nexthop from the FIB lookup.
1915  *
1916  *             *plen* argument is the size of the passed in struct.
1917  *             *flags* argument can be a combination of one or more of the
1918  *             following values:
1919  *
1920  *              **BPF_FIB_LOOKUP_DIRECT**
1921  *                      Do a direct table lookup vs full lookup using FIB
1922  *                      rules.
1923  *              **BPF_FIB_LOOKUP_OUTPUT**
1924  *                      Perform lookup from an egress perspective (default is
1925  *                      ingress).
1926  *
1927  *             *ctx* is either **struct xdp_md** for XDP programs or
1928  *             **struct sk_buff** tc cls_act programs.
1929  *     Return
1930  *              * < 0 if any input argument is invalid
1931  *              *   0 on success (packet is forwarded, nexthop neighbor exists)
1932  *              * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the
1933  *                packet is not forwarded or needs assist from full stack
1934  *
1935  * int bpf_sock_hash_update(struct bpf_sock_ops_kern *skops, struct bpf_map *map, void *key, u64 flags)
1936  *      Description
1937  *              Add an entry to, or update a sockhash *map* referencing sockets.
1938  *              The *skops* is used as a new value for the entry associated to
1939  *              *key*. *flags* is one of:
1940  *
1941  *              **BPF_NOEXIST**
1942  *                      The entry for *key* must not exist in the map.
1943  *              **BPF_EXIST**
1944  *                      The entry for *key* must already exist in the map.
1945  *              **BPF_ANY**
1946  *                      No condition on the existence of the entry for *key*.
1947  *
1948  *              If the *map* has eBPF programs (parser and verdict), those will
1949  *              be inherited by the socket being added. If the socket is
1950  *              already attached to eBPF programs, this results in an error.
1951  *      Return
1952  *              0 on success, or a negative error in case of failure.
1953  *
1954  * int bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags)
1955  *      Description
1956  *              This helper is used in programs implementing policies at the
1957  *              socket level. If the message *msg* is allowed to pass (i.e. if
1958  *              the verdict eBPF program returns **SK_PASS**), redirect it to
1959  *              the socket referenced by *map* (of type
1960  *              **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
1961  *              egress interfaces can be used for redirection. The
1962  *              **BPF_F_INGRESS** value in *flags* is used to make the
1963  *              distinction (ingress path is selected if the flag is present,
1964  *              egress path otherwise). This is the only flag supported for now.
1965  *      Return
1966  *              **SK_PASS** on success, or **SK_DROP** on error.
1967  *
1968  * int bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags)
1969  *      Description
1970  *              This helper is used in programs implementing policies at the
1971  *              skb socket level. If the sk_buff *skb* is allowed to pass (i.e.
1972  *              if the verdeict eBPF program returns **SK_PASS**), redirect it
1973  *              to the socket referenced by *map* (of type
1974  *              **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
1975  *              egress interfaces can be used for redirection. The
1976  *              **BPF_F_INGRESS** value in *flags* is used to make the
1977  *              distinction (ingress path is selected if the flag is present,
1978  *              egress otherwise). This is the only flag supported for now.
1979  *      Return
1980  *              **SK_PASS** on success, or **SK_DROP** on error.
1981  *
1982  * int bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len)
1983  *      Description
1984  *              Encapsulate the packet associated to *skb* within a Layer 3
1985  *              protocol header. This header is provided in the buffer at
1986  *              address *hdr*, with *len* its size in bytes. *type* indicates
1987  *              the protocol of the header and can be one of:
1988  *
1989  *              **BPF_LWT_ENCAP_SEG6**
1990  *                      IPv6 encapsulation with Segment Routing Header
1991  *                      (**struct ipv6_sr_hdr**). *hdr* only contains the SRH,
1992  *                      the IPv6 header is computed by the kernel.
1993  *              **BPF_LWT_ENCAP_SEG6_INLINE**
1994  *                      Only works if *skb* contains an IPv6 packet. Insert a
1995  *                      Segment Routing Header (**struct ipv6_sr_hdr**) inside
1996  *                      the IPv6 header.
1997  *
1998  *              A call to this helper is susceptible to change the underlaying
1999  *              packet buffer. Therefore, at load time, all checks on pointers
2000  *              previously done by the verifier are invalidated and must be
2001  *              performed again, if the helper is used in combination with
2002  *              direct packet access.
2003  *      Return
2004  *              0 on success, or a negative error in case of failure.
2005  *
2006  * int bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len)
2007  *      Description
2008  *              Store *len* bytes from address *from* into the packet
2009  *              associated to *skb*, at *offset*. Only the flags, tag and TLVs
2010  *              inside the outermost IPv6 Segment Routing Header can be
2011  *              modified through this helper.
2012  *
2013  *              A call to this helper is susceptible to change the underlaying
2014  *              packet buffer. Therefore, at load time, all checks on pointers
2015  *              previously done by the verifier are invalidated and must be
2016  *              performed again, if the helper is used in combination with
2017  *              direct packet access.
2018  *      Return
2019  *              0 on success, or a negative error in case of failure.
2020  *
2021  * int bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta)
2022  *      Description
2023  *              Adjust the size allocated to TLVs in the outermost IPv6
2024  *              Segment Routing Header contained in the packet associated to
2025  *              *skb*, at position *offset* by *delta* bytes. Only offsets
2026  *              after the segments are accepted. *delta* can be as well
2027  *              positive (growing) as negative (shrinking).
2028  *
2029  *              A call to this helper is susceptible to change the underlaying
2030  *              packet buffer. Therefore, at load time, all checks on pointers
2031  *              previously done by the verifier are invalidated and must be
2032  *              performed again, if the helper is used in combination with
2033  *              direct packet access.
2034  *      Return
2035  *              0 on success, or a negative error in case of failure.
2036  *
2037  * int bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len)
2038  *      Description
2039  *              Apply an IPv6 Segment Routing action of type *action* to the
2040  *              packet associated to *skb*. Each action takes a parameter
2041  *              contained at address *param*, and of length *param_len* bytes.
2042  *              *action* can be one of:
2043  *
2044  *              **SEG6_LOCAL_ACTION_END_X**
2045  *                      End.X action: Endpoint with Layer-3 cross-connect.
2046  *                      Type of *param*: **struct in6_addr**.
2047  *              **SEG6_LOCAL_ACTION_END_T**
2048  *                      End.T action: Endpoint with specific IPv6 table lookup.
2049  *                      Type of *param*: **int**.
2050  *              **SEG6_LOCAL_ACTION_END_B6**
2051  *                      End.B6 action: Endpoint bound to an SRv6 policy.
2052  *                      Type of param: **struct ipv6_sr_hdr**.
2053  *              **SEG6_LOCAL_ACTION_END_B6_ENCAP**
2054  *                      End.B6.Encap action: Endpoint bound to an SRv6
2055  *                      encapsulation policy.
2056  *                      Type of param: **struct ipv6_sr_hdr**.
2057  *
2058  *              A call to this helper is susceptible to change the underlaying
2059  *              packet buffer. Therefore, at load time, all checks on pointers
2060  *              previously done by the verifier are invalidated and must be
2061  *              performed again, if the helper is used in combination with
2062  *              direct packet access.
2063  *      Return
2064  *              0 on success, or a negative error in case of failure.
2065  *
2066  * int bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle)
2067  *      Description
2068  *              This helper is used in programs implementing IR decoding, to
2069  *              report a successfully decoded key press with *scancode*,
2070  *              *toggle* value in the given *protocol*. The scancode will be
2071  *              translated to a keycode using the rc keymap, and reported as
2072  *              an input key down event. After a period a key up event is
2073  *              generated. This period can be extended by calling either
2074  *              **bpf_rc_keydown** () again with the same values, or calling
2075  *              **bpf_rc_repeat** ().
2076  *
2077  *              Some protocols include a toggle bit, in case the button was
2078  *              released and pressed again between consecutive scancodes.
2079  *
2080  *              The *ctx* should point to the lirc sample as passed into
2081  *              the program.
2082  *
2083  *              The *protocol* is the decoded protocol number (see
2084  *              **enum rc_proto** for some predefined values).
2085  *
2086  *              This helper is only available is the kernel was compiled with
2087  *              the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2088  *              "**y**".
2089  *      Return
2090  *              0
2091  *
2092  * int bpf_rc_repeat(void *ctx)
2093  *      Description
2094  *              This helper is used in programs implementing IR decoding, to
2095  *              report a successfully decoded repeat key message. This delays
2096  *              the generation of a key up event for previously generated
2097  *              key down event.
2098  *
2099  *              Some IR protocols like NEC have a special IR message for
2100  *              repeating last button, for when a button is held down.
2101  *
2102  *              The *ctx* should point to the lirc sample as passed into
2103  *              the program.
2104  *
2105  *              This helper is only available is the kernel was compiled with
2106  *              the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2107  *              "**y**".
2108  *      Return
2109  *              0
2110  *
2111  * uint64_t bpf_skb_cgroup_id(struct sk_buff *skb)
2112  *      Description
2113  *              Return the cgroup v2 id of the socket associated with the *skb*.
2114  *              This is roughly similar to the **bpf_get_cgroup_classid**\ ()
2115  *              helper for cgroup v1 by providing a tag resp. identifier that
2116  *              can be matched on or used for map lookups e.g. to implement
2117  *              policy. The cgroup v2 id of a given path in the hierarchy is
2118  *              exposed in user space through the f_handle API in order to get
2119  *              to the same 64-bit id.
2120  *
2121  *              This helper can be used on TC egress path, but not on ingress,
2122  *              and is available only if the kernel was compiled with the
2123  *              **CONFIG_SOCK_CGROUP_DATA** configuration option.
2124  *      Return
2125  *              The id is returned or 0 in case the id could not be retrieved.
2126  *
2127  * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level)
2128  *      Description
2129  *              Return id of cgroup v2 that is ancestor of cgroup associated
2130  *              with the *skb* at the *ancestor_level*.  The root cgroup is at
2131  *              *ancestor_level* zero and each step down the hierarchy
2132  *              increments the level. If *ancestor_level* == level of cgroup
2133  *              associated with *skb*, then return value will be same as that
2134  *              of **bpf_skb_cgroup_id**\ ().
2135  *
2136  *              The helper is useful to implement policies based on cgroups
2137  *              that are upper in hierarchy than immediate cgroup associated
2138  *              with *skb*.
2139  *
2140  *              The format of returned id and helper limitations are same as in
2141  *              **bpf_skb_cgroup_id**\ ().
2142  *      Return
2143  *              The id is returned or 0 in case the id could not be retrieved.
2144  *
2145  * u64 bpf_get_current_cgroup_id(void)
2146  *      Return
2147  *              A 64-bit integer containing the current cgroup id based
2148  *              on the cgroup within which the current task is running.
2149  *
2150  * void* get_local_storage(void *map, u64 flags)
2151  *      Description
2152  *              Get the pointer to the local storage area.
2153  *              The type and the size of the local storage is defined
2154  *              by the *map* argument.
2155  *              The *flags* meaning is specific for each map type,
2156  *              and has to be 0 for cgroup local storage.
2157  *
2158  *              Depending on the bpf program type, a local storage area
2159  *              can be shared between multiple instances of the bpf program,
2160  *              running simultaneously.
2161  *
2162  *              A user should care about the synchronization by himself.
2163  *              For example, by using the BPF_STX_XADD instruction to alter
2164  *              the shared data.
2165  *      Return
2166  *              Pointer to the local storage area.
2167  *
2168  * int bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags)
2169  *      Description
2170  *              Select a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY map
2171  *              It checks the selected sk is matching the incoming
2172  *              request in the skb.
2173  *      Return
2174  *              0 on success, or a negative error in case of failure.
2175  *
2176  * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u32 netns, u64 flags)
2177  *      Description
2178  *              Look for TCP socket matching *tuple*, optionally in a child
2179  *              network namespace *netns*. The return value must be checked,
2180  *              and if non-NULL, released via **bpf_sk_release**\ ().
2181  *
2182  *              The *ctx* should point to the context of the program, such as
2183  *              the skb or socket (depending on the hook in use). This is used
2184  *              to determine the base network namespace for the lookup.
2185  *
2186  *              *tuple_size* must be one of:
2187  *
2188  *              **sizeof**\ (*tuple*\ **->ipv4**)
2189  *                      Look for an IPv4 socket.
2190  *              **sizeof**\ (*tuple*\ **->ipv6**)
2191  *                      Look for an IPv6 socket.
2192  *
2193  *              If the *netns* is zero, then the socket lookup table in the
2194  *              netns associated with the *ctx* will be used. For the TC hooks,
2195  *              this in the netns of the device in the skb. For socket hooks,
2196  *              this in the netns of the socket. If *netns* is non-zero, then
2197  *              it specifies the ID of the netns relative to the netns
2198  *              associated with the *ctx*.
2199  *
2200  *              All values for *flags* are reserved for future usage, and must
2201  *              be left at zero.
2202  *
2203  *              This helper is available only if the kernel was compiled with
2204  *              **CONFIG_NET** configuration option.
2205  *      Return
2206  *              Pointer to *struct bpf_sock*, or NULL in case of failure.
2207  *              For sockets with reuseport option, *struct bpf_sock*
2208  *              return is from reuse->socks[] using hash of the packet.
2209  *
2210  * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u32 netns, u64 flags)
2211  *      Description
2212  *              Look for UDP socket matching *tuple*, optionally in a child
2213  *              network namespace *netns*. The return value must be checked,
2214  *              and if non-NULL, released via **bpf_sk_release**\ ().
2215  *
2216  *              The *ctx* should point to the context of the program, such as
2217  *              the skb or socket (depending on the hook in use). This is used
2218  *              to determine the base network namespace for the lookup.
2219  *
2220  *              *tuple_size* must be one of:
2221  *
2222  *              **sizeof**\ (*tuple*\ **->ipv4**)
2223  *                      Look for an IPv4 socket.
2224  *              **sizeof**\ (*tuple*\ **->ipv6**)
2225  *                      Look for an IPv6 socket.
2226  *
2227  *              If the *netns* is zero, then the socket lookup table in the
2228  *              netns associated with the *ctx* will be used. For the TC hooks,
2229  *              this in the netns of the device in the skb. For socket hooks,
2230  *              this in the netns of the socket. If *netns* is non-zero, then
2231  *              it specifies the ID of the netns relative to the netns
2232  *              associated with the *ctx*.
2233  *
2234  *              All values for *flags* are reserved for future usage, and must
2235  *              be left at zero.
2236  *
2237  *              This helper is available only if the kernel was compiled with
2238  *              **CONFIG_NET** configuration option.
2239  *      Return
2240  *              Pointer to *struct bpf_sock*, or NULL in case of failure.
2241  *              For sockets with reuseport option, *struct bpf_sock*
2242  *              return is from reuse->socks[] using hash of the packet.
2243  *
2244  * int bpf_sk_release(struct bpf_sock *sk)
2245  *      Description
2246  *              Release the reference held by *sock*. *sock* must be a non-NULL
2247  *              pointer that was returned from bpf_sk_lookup_xxx\ ().
2248  *      Return
2249  *              0 on success, or a negative error in case of failure.
2250  *
2251  * int bpf_msg_push_data(struct sk_buff *skb, u32 start, u32 len, u64 flags)
2252  *      Description
2253  *              For socket policies, insert *len* bytes into msg at offset
2254  *              *start*.
2255  *
2256  *              If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
2257  *              *msg* it may want to insert metadata or options into the msg.
2258  *              This can later be read and used by any of the lower layer BPF
2259  *              hooks.
2260  *
2261  *              This helper may fail if under memory pressure (a malloc
2262  *              fails) in these cases BPF programs will get an appropriate
2263  *              error and BPF programs will need to handle them.
2264  *
2265  *      Return
2266  *              0 on success, or a negative error in case of failure.
2267  */
2268 #define __BPF_FUNC_MAPPER(FN)           \
2269         FN(unspec),                     \
2270         FN(map_lookup_elem),            \
2271         FN(map_update_elem),            \
2272         FN(map_delete_elem),            \
2273         FN(probe_read),                 \
2274         FN(ktime_get_ns),               \
2275         FN(trace_printk),               \
2276         FN(get_prandom_u32),            \
2277         FN(get_smp_processor_id),       \
2278         FN(skb_store_bytes),            \
2279         FN(l3_csum_replace),            \
2280         FN(l4_csum_replace),            \
2281         FN(tail_call),                  \
2282         FN(clone_redirect),             \
2283         FN(get_current_pid_tgid),       \
2284         FN(get_current_uid_gid),        \
2285         FN(get_current_comm),           \
2286         FN(get_cgroup_classid),         \
2287         FN(skb_vlan_push),              \
2288         FN(skb_vlan_pop),               \
2289         FN(skb_get_tunnel_key),         \
2290         FN(skb_set_tunnel_key),         \
2291         FN(perf_event_read),            \
2292         FN(redirect),                   \
2293         FN(get_route_realm),            \
2294         FN(perf_event_output),          \
2295         FN(skb_load_bytes),             \
2296         FN(get_stackid),                \
2297         FN(csum_diff),                  \
2298         FN(skb_get_tunnel_opt),         \
2299         FN(skb_set_tunnel_opt),         \
2300         FN(skb_change_proto),           \
2301         FN(skb_change_type),            \
2302         FN(skb_under_cgroup),           \
2303         FN(get_hash_recalc),            \
2304         FN(get_current_task),           \
2305         FN(probe_write_user),           \
2306         FN(current_task_under_cgroup),  \
2307         FN(skb_change_tail),            \
2308         FN(skb_pull_data),              \
2309         FN(csum_update),                \
2310         FN(set_hash_invalid),           \
2311         FN(get_numa_node_id),           \
2312         FN(skb_change_head),            \
2313         FN(xdp_adjust_head),            \
2314         FN(probe_read_str),             \
2315         FN(get_socket_cookie),          \
2316         FN(get_socket_uid),             \
2317         FN(set_hash),                   \
2318         FN(setsockopt),                 \
2319         FN(skb_adjust_room),            \
2320         FN(redirect_map),               \
2321         FN(sk_redirect_map),            \
2322         FN(sock_map_update),            \
2323         FN(xdp_adjust_meta),            \
2324         FN(perf_event_read_value),      \
2325         FN(perf_prog_read_value),       \
2326         FN(getsockopt),                 \
2327         FN(override_return),            \
2328         FN(sock_ops_cb_flags_set),      \
2329         FN(msg_redirect_map),           \
2330         FN(msg_apply_bytes),            \
2331         FN(msg_cork_bytes),             \
2332         FN(msg_pull_data),              \
2333         FN(bind),                       \
2334         FN(xdp_adjust_tail),            \
2335         FN(skb_get_xfrm_state),         \
2336         FN(get_stack),                  \
2337         FN(skb_load_bytes_relative),    \
2338         FN(fib_lookup),                 \
2339         FN(sock_hash_update),           \
2340         FN(msg_redirect_hash),          \
2341         FN(sk_redirect_hash),           \
2342         FN(lwt_push_encap),             \
2343         FN(lwt_seg6_store_bytes),       \
2344         FN(lwt_seg6_adjust_srh),        \
2345         FN(lwt_seg6_action),            \
2346         FN(rc_repeat),                  \
2347         FN(rc_keydown),                 \
2348         FN(skb_cgroup_id),              \
2349         FN(get_current_cgroup_id),      \
2350         FN(get_local_storage),          \
2351         FN(sk_select_reuseport),        \
2352         FN(skb_ancestor_cgroup_id),     \
2353         FN(sk_lookup_tcp),              \
2354         FN(sk_lookup_udp),              \
2355         FN(sk_release),                 \
2356         FN(map_push_elem),              \
2357         FN(map_pop_elem),               \
2358         FN(map_peek_elem),              \
2359         FN(msg_push_data),
2360
2361 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
2362  * function eBPF program intends to call
2363  */
2364 #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
2365 enum bpf_func_id {
2366         __BPF_FUNC_MAPPER(__BPF_ENUM_FN)
2367         __BPF_FUNC_MAX_ID,
2368 };
2369 #undef __BPF_ENUM_FN
2370
2371 /* All flags used by eBPF helper functions, placed here. */
2372
2373 /* BPF_FUNC_skb_store_bytes flags. */
2374 #define BPF_F_RECOMPUTE_CSUM            (1ULL << 0)
2375 #define BPF_F_INVALIDATE_HASH           (1ULL << 1)
2376
2377 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
2378  * First 4 bits are for passing the header field size.
2379  */
2380 #define BPF_F_HDR_FIELD_MASK            0xfULL
2381
2382 /* BPF_FUNC_l4_csum_replace flags. */
2383 #define BPF_F_PSEUDO_HDR                (1ULL << 4)
2384 #define BPF_F_MARK_MANGLED_0            (1ULL << 5)
2385 #define BPF_F_MARK_ENFORCE              (1ULL << 6)
2386
2387 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
2388 #define BPF_F_INGRESS                   (1ULL << 0)
2389
2390 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
2391 #define BPF_F_TUNINFO_IPV6              (1ULL << 0)
2392
2393 /* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */
2394 #define BPF_F_SKIP_FIELD_MASK           0xffULL
2395 #define BPF_F_USER_STACK                (1ULL << 8)
2396 /* flags used by BPF_FUNC_get_stackid only. */
2397 #define BPF_F_FAST_STACK_CMP            (1ULL << 9)
2398 #define BPF_F_REUSE_STACKID             (1ULL << 10)
2399 /* flags used by BPF_FUNC_get_stack only. */
2400 #define BPF_F_USER_BUILD_ID             (1ULL << 11)
2401
2402 /* BPF_FUNC_skb_set_tunnel_key flags. */
2403 #define BPF_F_ZERO_CSUM_TX              (1ULL << 1)
2404 #define BPF_F_DONT_FRAGMENT             (1ULL << 2)
2405 #define BPF_F_SEQ_NUMBER                (1ULL << 3)
2406
2407 /* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and
2408  * BPF_FUNC_perf_event_read_value flags.
2409  */
2410 #define BPF_F_INDEX_MASK                0xffffffffULL
2411 #define BPF_F_CURRENT_CPU               BPF_F_INDEX_MASK
2412 /* BPF_FUNC_perf_event_output for sk_buff input context. */
2413 #define BPF_F_CTXLEN_MASK               (0xfffffULL << 32)
2414
2415 /* Mode for BPF_FUNC_skb_adjust_room helper. */
2416 enum bpf_adj_room_mode {
2417         BPF_ADJ_ROOM_NET,
2418 };
2419
2420 /* Mode for BPF_FUNC_skb_load_bytes_relative helper. */
2421 enum bpf_hdr_start_off {
2422         BPF_HDR_START_MAC,
2423         BPF_HDR_START_NET,
2424 };
2425
2426 /* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */
2427 enum bpf_lwt_encap_mode {
2428         BPF_LWT_ENCAP_SEG6,
2429         BPF_LWT_ENCAP_SEG6_INLINE
2430 };
2431
2432 /* user accessible mirror of in-kernel sk_buff.
2433  * new fields can only be added to the end of this structure
2434  */
2435 struct __sk_buff {
2436         __u32 len;
2437         __u32 pkt_type;
2438         __u32 mark;
2439         __u32 queue_mapping;
2440         __u32 protocol;
2441         __u32 vlan_present;
2442         __u32 vlan_tci;
2443         __u32 vlan_proto;
2444         __u32 priority;
2445         __u32 ingress_ifindex;
2446         __u32 ifindex;
2447         __u32 tc_index;
2448         __u32 cb[5];
2449         __u32 hash;
2450         __u32 tc_classid;
2451         __u32 data;
2452         __u32 data_end;
2453         __u32 napi_id;
2454
2455         /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */
2456         __u32 family;
2457         __u32 remote_ip4;       /* Stored in network byte order */
2458         __u32 local_ip4;        /* Stored in network byte order */
2459         __u32 remote_ip6[4];    /* Stored in network byte order */
2460         __u32 local_ip6[4];     /* Stored in network byte order */
2461         __u32 remote_port;      /* Stored in network byte order */
2462         __u32 local_port;       /* stored in host byte order */
2463         /* ... here. */
2464
2465         __u32 data_meta;
2466         struct bpf_flow_keys *flow_keys;
2467 };
2468
2469 struct bpf_tunnel_key {
2470         __u32 tunnel_id;
2471         union {
2472                 __u32 remote_ipv4;
2473                 __u32 remote_ipv6[4];
2474         };
2475         __u8 tunnel_tos;
2476         __u8 tunnel_ttl;
2477         __u16 tunnel_ext;       /* Padding, future use. */
2478         __u32 tunnel_label;
2479 };
2480
2481 /* user accessible mirror of in-kernel xfrm_state.
2482  * new fields can only be added to the end of this structure
2483  */
2484 struct bpf_xfrm_state {
2485         __u32 reqid;
2486         __u32 spi;      /* Stored in network byte order */
2487         __u16 family;
2488         __u16 ext;      /* Padding, future use. */
2489         union {
2490                 __u32 remote_ipv4;      /* Stored in network byte order */
2491                 __u32 remote_ipv6[4];   /* Stored in network byte order */
2492         };
2493 };
2494
2495 /* Generic BPF return codes which all BPF program types may support.
2496  * The values are binary compatible with their TC_ACT_* counter-part to
2497  * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
2498  * programs.
2499  *
2500  * XDP is handled seprately, see XDP_*.
2501  */
2502 enum bpf_ret_code {
2503         BPF_OK = 0,
2504         /* 1 reserved */
2505         BPF_DROP = 2,
2506         /* 3-6 reserved */
2507         BPF_REDIRECT = 7,
2508         /* >127 are reserved for prog type specific return codes */
2509 };
2510
2511 struct bpf_sock {
2512         __u32 bound_dev_if;
2513         __u32 family;
2514         __u32 type;
2515         __u32 protocol;
2516         __u32 mark;
2517         __u32 priority;
2518         __u32 src_ip4;          /* Allows 1,2,4-byte read.
2519                                  * Stored in network byte order.
2520                                  */
2521         __u32 src_ip6[4];       /* Allows 1,2,4-byte read.
2522                                  * Stored in network byte order.
2523                                  */
2524         __u32 src_port;         /* Allows 4-byte read.
2525                                  * Stored in host byte order
2526                                  */
2527 };
2528
2529 struct bpf_sock_tuple {
2530         union {
2531                 struct {
2532                         __be32 saddr;
2533                         __be32 daddr;
2534                         __be16 sport;
2535                         __be16 dport;
2536                 } ipv4;
2537                 struct {
2538                         __be32 saddr[4];
2539                         __be32 daddr[4];
2540                         __be16 sport;
2541                         __be16 dport;
2542                 } ipv6;
2543         };
2544 };
2545
2546 #define XDP_PACKET_HEADROOM 256
2547
2548 /* User return codes for XDP prog type.
2549  * A valid XDP program must return one of these defined values. All other
2550  * return codes are reserved for future use. Unknown return codes will
2551  * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
2552  */
2553 enum xdp_action {
2554         XDP_ABORTED = 0,
2555         XDP_DROP,
2556         XDP_PASS,
2557         XDP_TX,
2558         XDP_REDIRECT,
2559 };
2560
2561 /* user accessible metadata for XDP packet hook
2562  * new fields must be added to the end of this structure
2563  */
2564 struct xdp_md {
2565         __u32 data;
2566         __u32 data_end;
2567         __u32 data_meta;
2568         /* Below access go through struct xdp_rxq_info */
2569         __u32 ingress_ifindex; /* rxq->dev->ifindex */
2570         __u32 rx_queue_index;  /* rxq->queue_index  */
2571 };
2572
2573 enum sk_action {
2574         SK_DROP = 0,
2575         SK_PASS,
2576 };
2577
2578 /* user accessible metadata for SK_MSG packet hook, new fields must
2579  * be added to the end of this structure
2580  */
2581 struct sk_msg_md {
2582         void *data;
2583         void *data_end;
2584
2585         __u32 family;
2586         __u32 remote_ip4;       /* Stored in network byte order */
2587         __u32 local_ip4;        /* Stored in network byte order */
2588         __u32 remote_ip6[4];    /* Stored in network byte order */
2589         __u32 local_ip6[4];     /* Stored in network byte order */
2590         __u32 remote_port;      /* Stored in network byte order */
2591         __u32 local_port;       /* stored in host byte order */
2592 };
2593
2594 struct sk_reuseport_md {
2595         /*
2596          * Start of directly accessible data. It begins from
2597          * the tcp/udp header.
2598          */
2599         void *data;
2600         void *data_end;         /* End of directly accessible data */
2601         /*
2602          * Total length of packet (starting from the tcp/udp header).
2603          * Note that the directly accessible bytes (data_end - data)
2604          * could be less than this "len".  Those bytes could be
2605          * indirectly read by a helper "bpf_skb_load_bytes()".
2606          */
2607         __u32 len;
2608         /*
2609          * Eth protocol in the mac header (network byte order). e.g.
2610          * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD)
2611          */
2612         __u32 eth_protocol;
2613         __u32 ip_protocol;      /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */
2614         __u32 bind_inany;       /* Is sock bound to an INANY address? */
2615         __u32 hash;             /* A hash of the packet 4 tuples */
2616 };
2617
2618 #define BPF_TAG_SIZE    8
2619
2620 struct bpf_prog_info {
2621         __u32 type;
2622         __u32 id;
2623         __u8  tag[BPF_TAG_SIZE];
2624         __u32 jited_prog_len;
2625         __u32 xlated_prog_len;
2626         __aligned_u64 jited_prog_insns;
2627         __aligned_u64 xlated_prog_insns;
2628         __u64 load_time;        /* ns since boottime */
2629         __u32 created_by_uid;
2630         __u32 nr_map_ids;
2631         __aligned_u64 map_ids;
2632         char name[BPF_OBJ_NAME_LEN];
2633         __u32 ifindex;
2634         __u32 gpl_compatible:1;
2635         __u64 netns_dev;
2636         __u64 netns_ino;
2637         __u32 nr_jited_ksyms;
2638         __u32 nr_jited_func_lens;
2639         __aligned_u64 jited_ksyms;
2640         __aligned_u64 jited_func_lens;
2641 } __attribute__((aligned(8)));
2642
2643 struct bpf_map_info {
2644         __u32 type;
2645         __u32 id;
2646         __u32 key_size;
2647         __u32 value_size;
2648         __u32 max_entries;
2649         __u32 map_flags;
2650         char  name[BPF_OBJ_NAME_LEN];
2651         __u32 ifindex;
2652         __u32 :32;
2653         __u64 netns_dev;
2654         __u64 netns_ino;
2655         __u32 btf_id;
2656         __u32 btf_key_type_id;
2657         __u32 btf_value_type_id;
2658 } __attribute__((aligned(8)));
2659
2660 struct bpf_btf_info {
2661         __aligned_u64 btf;
2662         __u32 btf_size;
2663         __u32 id;
2664 } __attribute__((aligned(8)));
2665
2666 /* User bpf_sock_addr struct to access socket fields and sockaddr struct passed
2667  * by user and intended to be used by socket (e.g. to bind to, depends on
2668  * attach attach type).
2669  */
2670 struct bpf_sock_addr {
2671         __u32 user_family;      /* Allows 4-byte read, but no write. */
2672         __u32 user_ip4;         /* Allows 1,2,4-byte read and 4-byte write.
2673                                  * Stored in network byte order.
2674                                  */
2675         __u32 user_ip6[4];      /* Allows 1,2,4-byte read an 4-byte write.
2676                                  * Stored in network byte order.
2677                                  */
2678         __u32 user_port;        /* Allows 4-byte read and write.
2679                                  * Stored in network byte order
2680                                  */
2681         __u32 family;           /* Allows 4-byte read, but no write */
2682         __u32 type;             /* Allows 4-byte read, but no write */
2683         __u32 protocol;         /* Allows 4-byte read, but no write */
2684         __u32 msg_src_ip4;      /* Allows 1,2,4-byte read an 4-byte write.
2685                                  * Stored in network byte order.
2686                                  */
2687         __u32 msg_src_ip6[4];   /* Allows 1,2,4-byte read an 4-byte write.
2688                                  * Stored in network byte order.
2689                                  */
2690 };
2691
2692 /* User bpf_sock_ops struct to access socket values and specify request ops
2693  * and their replies.
2694  * Some of this fields are in network (bigendian) byte order and may need
2695  * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
2696  * New fields can only be added at the end of this structure
2697  */
2698 struct bpf_sock_ops {
2699         __u32 op;
2700         union {
2701                 __u32 args[4];          /* Optionally passed to bpf program */
2702                 __u32 reply;            /* Returned by bpf program          */
2703                 __u32 replylong[4];     /* Optionally returned by bpf prog  */
2704         };
2705         __u32 family;
2706         __u32 remote_ip4;       /* Stored in network byte order */
2707         __u32 local_ip4;        /* Stored in network byte order */
2708         __u32 remote_ip6[4];    /* Stored in network byte order */
2709         __u32 local_ip6[4];     /* Stored in network byte order */
2710         __u32 remote_port;      /* Stored in network byte order */
2711         __u32 local_port;       /* stored in host byte order */
2712         __u32 is_fullsock;      /* Some TCP fields are only valid if
2713                                  * there is a full socket. If not, the
2714                                  * fields read as zero.
2715                                  */
2716         __u32 snd_cwnd;
2717         __u32 srtt_us;          /* Averaged RTT << 3 in usecs */
2718         __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */
2719         __u32 state;
2720         __u32 rtt_min;
2721         __u32 snd_ssthresh;
2722         __u32 rcv_nxt;
2723         __u32 snd_nxt;
2724         __u32 snd_una;
2725         __u32 mss_cache;
2726         __u32 ecn_flags;
2727         __u32 rate_delivered;
2728         __u32 rate_interval_us;
2729         __u32 packets_out;
2730         __u32 retrans_out;
2731         __u32 total_retrans;
2732         __u32 segs_in;
2733         __u32 data_segs_in;
2734         __u32 segs_out;
2735         __u32 data_segs_out;
2736         __u32 lost_out;
2737         __u32 sacked_out;
2738         __u32 sk_txhash;
2739         __u64 bytes_received;
2740         __u64 bytes_acked;
2741 };
2742
2743 /* Definitions for bpf_sock_ops_cb_flags */
2744 #define BPF_SOCK_OPS_RTO_CB_FLAG        (1<<0)
2745 #define BPF_SOCK_OPS_RETRANS_CB_FLAG    (1<<1)
2746 #define BPF_SOCK_OPS_STATE_CB_FLAG      (1<<2)
2747 #define BPF_SOCK_OPS_ALL_CB_FLAGS       0x7             /* Mask of all currently
2748                                                          * supported cb flags
2749                                                          */
2750
2751 /* List of known BPF sock_ops operators.
2752  * New entries can only be added at the end
2753  */
2754 enum {
2755         BPF_SOCK_OPS_VOID,
2756         BPF_SOCK_OPS_TIMEOUT_INIT,      /* Should return SYN-RTO value to use or
2757                                          * -1 if default value should be used
2758                                          */
2759         BPF_SOCK_OPS_RWND_INIT,         /* Should return initial advertized
2760                                          * window (in packets) or -1 if default
2761                                          * value should be used
2762                                          */
2763         BPF_SOCK_OPS_TCP_CONNECT_CB,    /* Calls BPF program right before an
2764                                          * active connection is initialized
2765                                          */
2766         BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB,     /* Calls BPF program when an
2767                                                  * active connection is
2768                                                  * established
2769                                                  */
2770         BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB,    /* Calls BPF program when a
2771                                                  * passive connection is
2772                                                  * established
2773                                                  */
2774         BPF_SOCK_OPS_NEEDS_ECN,         /* If connection's congestion control
2775                                          * needs ECN
2776                                          */
2777         BPF_SOCK_OPS_BASE_RTT,          /* Get base RTT. The correct value is
2778                                          * based on the path and may be
2779                                          * dependent on the congestion control
2780                                          * algorithm. In general it indicates
2781                                          * a congestion threshold. RTTs above
2782                                          * this indicate congestion
2783                                          */
2784         BPF_SOCK_OPS_RTO_CB,            /* Called when an RTO has triggered.
2785                                          * Arg1: value of icsk_retransmits
2786                                          * Arg2: value of icsk_rto
2787                                          * Arg3: whether RTO has expired
2788                                          */
2789         BPF_SOCK_OPS_RETRANS_CB,        /* Called when skb is retransmitted.
2790                                          * Arg1: sequence number of 1st byte
2791                                          * Arg2: # segments
2792                                          * Arg3: return value of
2793                                          *       tcp_transmit_skb (0 => success)
2794                                          */
2795         BPF_SOCK_OPS_STATE_CB,          /* Called when TCP changes state.
2796                                          * Arg1: old_state
2797                                          * Arg2: new_state
2798                                          */
2799         BPF_SOCK_OPS_TCP_LISTEN_CB,     /* Called on listen(2), right after
2800                                          * socket transition to LISTEN state.
2801                                          */
2802 };
2803
2804 /* List of TCP states. There is a build check in net/ipv4/tcp.c to detect
2805  * changes between the TCP and BPF versions. Ideally this should never happen.
2806  * If it does, we need to add code to convert them before calling
2807  * the BPF sock_ops function.
2808  */
2809 enum {
2810         BPF_TCP_ESTABLISHED = 1,
2811         BPF_TCP_SYN_SENT,
2812         BPF_TCP_SYN_RECV,
2813         BPF_TCP_FIN_WAIT1,
2814         BPF_TCP_FIN_WAIT2,
2815         BPF_TCP_TIME_WAIT,
2816         BPF_TCP_CLOSE,
2817         BPF_TCP_CLOSE_WAIT,
2818         BPF_TCP_LAST_ACK,
2819         BPF_TCP_LISTEN,
2820         BPF_TCP_CLOSING,        /* Now a valid state */
2821         BPF_TCP_NEW_SYN_RECV,
2822
2823         BPF_TCP_MAX_STATES      /* Leave at the end! */
2824 };
2825
2826 #define TCP_BPF_IW              1001    /* Set TCP initial congestion window */
2827 #define TCP_BPF_SNDCWND_CLAMP   1002    /* Set sndcwnd_clamp */
2828
2829 struct bpf_perf_event_value {
2830         __u64 counter;
2831         __u64 enabled;
2832         __u64 running;
2833 };
2834
2835 #define BPF_DEVCG_ACC_MKNOD     (1ULL << 0)
2836 #define BPF_DEVCG_ACC_READ      (1ULL << 1)
2837 #define BPF_DEVCG_ACC_WRITE     (1ULL << 2)
2838
2839 #define BPF_DEVCG_DEV_BLOCK     (1ULL << 0)
2840 #define BPF_DEVCG_DEV_CHAR      (1ULL << 1)
2841
2842 struct bpf_cgroup_dev_ctx {
2843         /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */
2844         __u32 access_type;
2845         __u32 major;
2846         __u32 minor;
2847 };
2848
2849 struct bpf_raw_tracepoint_args {
2850         __u64 args[0];
2851 };
2852
2853 /* DIRECT:  Skip the FIB rules and go to FIB table associated with device
2854  * OUTPUT:  Do lookup from egress perspective; default is ingress
2855  */
2856 #define BPF_FIB_LOOKUP_DIRECT  BIT(0)
2857 #define BPF_FIB_LOOKUP_OUTPUT  BIT(1)
2858
2859 enum {
2860         BPF_FIB_LKUP_RET_SUCCESS,      /* lookup successful */
2861         BPF_FIB_LKUP_RET_BLACKHOLE,    /* dest is blackholed; can be dropped */
2862         BPF_FIB_LKUP_RET_UNREACHABLE,  /* dest is unreachable; can be dropped */
2863         BPF_FIB_LKUP_RET_PROHIBIT,     /* dest not allowed; can be dropped */
2864         BPF_FIB_LKUP_RET_NOT_FWDED,    /* packet is not forwarded */
2865         BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */
2866         BPF_FIB_LKUP_RET_UNSUPP_LWT,   /* fwd requires encapsulation */
2867         BPF_FIB_LKUP_RET_NO_NEIGH,     /* no neighbor entry for nh */
2868         BPF_FIB_LKUP_RET_FRAG_NEEDED,  /* fragmentation required to fwd */
2869 };
2870
2871 struct bpf_fib_lookup {
2872         /* input:  network family for lookup (AF_INET, AF_INET6)
2873          * output: network family of egress nexthop
2874          */
2875         __u8    family;
2876
2877         /* set if lookup is to consider L4 data - e.g., FIB rules */
2878         __u8    l4_protocol;
2879         __be16  sport;
2880         __be16  dport;
2881
2882         /* total length of packet from network header - used for MTU check */
2883         __u16   tot_len;
2884
2885         /* input: L3 device index for lookup
2886          * output: device index from FIB lookup
2887          */
2888         __u32   ifindex;
2889
2890         union {
2891                 /* inputs to lookup */
2892                 __u8    tos;            /* AF_INET  */
2893                 __be32  flowinfo;       /* AF_INET6, flow_label + priority */
2894
2895                 /* output: metric of fib result (IPv4/IPv6 only) */
2896                 __u32   rt_metric;
2897         };
2898
2899         union {
2900                 __be32          ipv4_src;
2901                 __u32           ipv6_src[4];  /* in6_addr; network order */
2902         };
2903
2904         /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in
2905          * network header. output: bpf_fib_lookup sets to gateway address
2906          * if FIB lookup returns gateway route
2907          */
2908         union {
2909                 __be32          ipv4_dst;
2910                 __u32           ipv6_dst[4];  /* in6_addr; network order */
2911         };
2912
2913         /* output */
2914         __be16  h_vlan_proto;
2915         __be16  h_vlan_TCI;
2916         __u8    smac[6];     /* ETH_ALEN */
2917         __u8    dmac[6];     /* ETH_ALEN */
2918 };
2919
2920 enum bpf_task_fd_type {
2921         BPF_FD_TYPE_RAW_TRACEPOINT,     /* tp name */
2922         BPF_FD_TYPE_TRACEPOINT,         /* tp name */
2923         BPF_FD_TYPE_KPROBE,             /* (symbol + offset) or addr */
2924         BPF_FD_TYPE_KRETPROBE,          /* (symbol + offset) or addr */
2925         BPF_FD_TYPE_UPROBE,             /* filename + offset */
2926         BPF_FD_TYPE_URETPROBE,          /* filename + offset */
2927 };
2928
2929 struct bpf_flow_keys {
2930         __u16   nhoff;
2931         __u16   thoff;
2932         __u16   addr_proto;                     /* ETH_P_* of valid addrs */
2933         __u8    is_frag;
2934         __u8    is_first_frag;
2935         __u8    is_encap;
2936         __u8    ip_proto;
2937         __be16  n_proto;
2938         __be16  sport;
2939         __be16  dport;
2940         union {
2941                 struct {
2942                         __be32  ipv4_src;
2943                         __be32  ipv4_dst;
2944                 };
2945                 struct {
2946                         __u32   ipv6_src[4];    /* in6_addr; network order */
2947                         __u32   ipv6_dst[4];    /* in6_addr; network order */
2948                 };
2949         };
2950 };
2951
2952 #endif /* _UAPI__LINUX_BPF_H__ */