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