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