]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/include/uapi/linux/bpf.h
bpf: Support attaching tracing BPF program to other BPF programs
[mirror_ubuntu-hirsute-kernel.git] / tools / include / uapi / linux / bpf.h
CommitLineData
fb7df12d 1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
971e827b
ACM
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 */
d405c740 17#define BPF_JMP32 0x06 /* jmp mode in word width */
971e827b
ACM
18#define BPF_ALU64 0x07 /* alu mode in double word width */
19
20/* ld/ldx fields */
d6d4f60c 21#define BPF_DW 0x18 /* double word (64-bit) */
971e827b
ACM
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
92b31a9a 35/* jmp encodings */
971e827b 36#define BPF_JNE 0x50 /* jump != */
92b31a9a
DB
37#define BPF_JLT 0xa0 /* LT is unsigned, '<' */
38#define BPF_JLE 0xb0 /* LE is unsigned, '<=' */
971e827b
ACM
39#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
40#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
92b31a9a
DB
41#define BPF_JSLT 0xc0 /* SLT is signed, '<' */
42#define BPF_JSLE 0xd0 /* SLE is signed, '<=' */
971e827b
ACM
43#define BPF_CALL 0x80 /* function call */
44#define BPF_EXIT 0x90 /* function return */
45
46/* Register numbers */
47enum {
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
65struct 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
9a738266
MS
73/* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
74struct 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
c419cf52
RG
79struct bpf_cgroup_storage_key {
80 __u64 cgroup_inode_id; /* cgroup inode id */
81 __u32 attach_type; /* program attach type */
82};
83
971e827b
ACM
84/* BPF syscall commands, see bpf(2) man-page for details. */
85enum bpf_cmd {
86 BPF_MAP_CREATE,
87 BPF_MAP_LOOKUP_ELEM,
88 BPF_MAP_UPDATE_ELEM,
89 BPF_MAP_DELETE_ELEM,
90 BPF_MAP_GET_NEXT_KEY,
91 BPF_PROG_LOAD,
92 BPF_OBJ_PIN,
93 BPF_OBJ_GET,
0cb34dc2
JS
94 BPF_PROG_ATTACH,
95 BPF_PROG_DETACH,
30848873 96 BPF_PROG_TEST_RUN,
95b9afd3
MKL
97 BPF_PROG_GET_NEXT_ID,
98 BPF_MAP_GET_NEXT_ID,
99 BPF_PROG_GET_FD_BY_ID,
100 BPF_MAP_GET_FD_BY_ID,
101 BPF_OBJ_GET_INFO_BY_FD,
defd9c47 102 BPF_PROG_QUERY,
a0fe3e57 103 BPF_RAW_TRACEPOINT_OPEN,
3bd86a84 104 BPF_BTF_LOAD,
7a01f6a3 105 BPF_BTF_GET_FD_BY_ID,
30687ad9 106 BPF_TASK_FD_QUERY,
da4e1b15 107 BPF_MAP_LOOKUP_AND_DELETE_ELEM,
c83fef6b 108 BPF_MAP_FREEZE,
d2648e1e 109 BPF_BTF_GET_NEXT_ID,
971e827b
ACM
110};
111
112enum bpf_map_type {
113 BPF_MAP_TYPE_UNSPEC,
114 BPF_MAP_TYPE_HASH,
115 BPF_MAP_TYPE_ARRAY,
116 BPF_MAP_TYPE_PROG_ARRAY,
117 BPF_MAP_TYPE_PERF_EVENT_ARRAY,
118 BPF_MAP_TYPE_PERCPU_HASH,
119 BPF_MAP_TYPE_PERCPU_ARRAY,
120 BPF_MAP_TYPE_STACK_TRACE,
791cceb8 121 BPF_MAP_TYPE_CGROUP_ARRAY,
0cb34dc2
JS
122 BPF_MAP_TYPE_LRU_HASH,
123 BPF_MAP_TYPE_LRU_PERCPU_HASH,
9a738266 124 BPF_MAP_TYPE_LPM_TRIE,
fb30d4b7
MKL
125 BPF_MAP_TYPE_ARRAY_OF_MAPS,
126 BPF_MAP_TYPE_HASH_OF_MAPS,
81f6bf81 127 BPF_MAP_TYPE_DEVMAP,
69e8cc13 128 BPF_MAP_TYPE_SOCKMAP,
6710e112 129 BPF_MAP_TYPE_CPUMAP,
cb9c28ef 130 BPF_MAP_TYPE_XSKMAP,
b8b394fa 131 BPF_MAP_TYPE_SOCKHASH,
c419cf52 132 BPF_MAP_TYPE_CGROUP_STORAGE,
3bd43a8c 133 BPF_MAP_TYPE_REUSEPORT_SOCKARRAY,
25025e0a 134 BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE,
da4e1b15
MV
135 BPF_MAP_TYPE_QUEUE,
136 BPF_MAP_TYPE_STACK,
948d930e 137 BPF_MAP_TYPE_SK_STORAGE,
10fbe211 138 BPF_MAP_TYPE_DEVMAP_HASH,
971e827b
ACM
139};
140
6c4fc209
DB
141/* Note that tracing related programs such as
142 * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT}
143 * are not subject to a stable API since kernel internal data
144 * structures can change from release to release and may
145 * therefore break existing tracing BPF programs. Tracing BPF
146 * programs correspond to /a/ specific kernel which is to be
147 * analyzed, and not /a/ specific kernel /and/ all future ones.
148 */
971e827b
ACM
149enum bpf_prog_type {
150 BPF_PROG_TYPE_UNSPEC,
151 BPF_PROG_TYPE_SOCKET_FILTER,
152 BPF_PROG_TYPE_KPROBE,
153 BPF_PROG_TYPE_SCHED_CLS,
154 BPF_PROG_TYPE_SCHED_ACT,
155 BPF_PROG_TYPE_TRACEPOINT,
791cceb8 156 BPF_PROG_TYPE_XDP,
0cb34dc2
JS
157 BPF_PROG_TYPE_PERF_EVENT,
158 BPF_PROG_TYPE_CGROUP_SKB,
159 BPF_PROG_TYPE_CGROUP_SOCK,
160 BPF_PROG_TYPE_LWT_IN,
161 BPF_PROG_TYPE_LWT_OUT,
162 BPF_PROG_TYPE_LWT_XMIT,
04df41e3 163 BPF_PROG_TYPE_SOCK_OPS,
69e8cc13 164 BPF_PROG_TYPE_SK_SKB,
ebc614f6 165 BPF_PROG_TYPE_CGROUP_DEVICE,
82a86168 166 BPF_PROG_TYPE_SK_MSG,
a0fe3e57 167 BPF_PROG_TYPE_RAW_TRACEPOINT,
e50b0a6f 168 BPF_PROG_TYPE_CGROUP_SOCK_ADDR,
c99a84ea 169 BPF_PROG_TYPE_LWT_SEG6LOCAL,
6bdd533c 170 BPF_PROG_TYPE_LIRC_MODE2,
3bd43a8c 171 BPF_PROG_TYPE_SK_REUSEPORT,
2f965e3f 172 BPF_PROG_TYPE_FLOW_DISSECTOR,
196398d4 173 BPF_PROG_TYPE_CGROUP_SYSCTL,
4635b0ae 174 BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE,
aa6ab647 175 BPF_PROG_TYPE_CGROUP_SOCKOPT,
12a8654b 176 BPF_PROG_TYPE_TRACING,
971e827b
ACM
177};
178
0cb34dc2
JS
179enum bpf_attach_type {
180 BPF_CGROUP_INET_INGRESS,
181 BPF_CGROUP_INET_EGRESS,
182 BPF_CGROUP_INET_SOCK_CREATE,
04df41e3 183 BPF_CGROUP_SOCK_OPS,
464bc0fd
JF
184 BPF_SK_SKB_STREAM_PARSER,
185 BPF_SK_SKB_STREAM_VERDICT,
ebc614f6 186 BPF_CGROUP_DEVICE,
82a86168 187 BPF_SK_MSG_VERDICT,
e50b0a6f
AI
188 BPF_CGROUP_INET4_BIND,
189 BPF_CGROUP_INET6_BIND,
622adafb
AI
190 BPF_CGROUP_INET4_CONNECT,
191 BPF_CGROUP_INET6_CONNECT,
1d436885
AI
192 BPF_CGROUP_INET4_POST_BIND,
193 BPF_CGROUP_INET6_POST_BIND,
3024cf82
AI
194 BPF_CGROUP_UDP4_SENDMSG,
195 BPF_CGROUP_UDP6_SENDMSG,
6bdd533c 196 BPF_LIRC_MODE2,
2f965e3f 197 BPF_FLOW_DISSECTOR,
196398d4 198 BPF_CGROUP_SYSCTL,
3dbc6ada
DB
199 BPF_CGROUP_UDP4_RECVMSG,
200 BPF_CGROUP_UDP6_RECVMSG,
aa6ab647
SF
201 BPF_CGROUP_GETSOCKOPT,
202 BPF_CGROUP_SETSOCKOPT,
12a8654b 203 BPF_TRACE_RAW_TP,
b8c54ea4
AS
204 BPF_TRACE_FENTRY,
205 BPF_TRACE_FEXIT,
0cb34dc2
JS
206 __MAX_BPF_ATTACH_TYPE
207};
208
209#define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
210
defd9c47
AS
211/* cgroup-bpf attach flags used in BPF_PROG_ATTACH command
212 *
213 * NONE(default): No further bpf programs allowed in the subtree.
214 *
215 * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program,
216 * the program in this cgroup yields to sub-cgroup program.
217 *
218 * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program,
219 * that cgroup program gets run in addition to the program in this cgroup.
220 *
221 * Only one program is allowed to be attached to a cgroup with
222 * NONE or BPF_F_ALLOW_OVERRIDE flag.
223 * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will
224 * release old program and attach the new one. Attach flags has to match.
225 *
226 * Multiple programs are allowed to be attached to a cgroup with
227 * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order
228 * (those that were attached first, run first)
229 * The programs of sub-cgroup are executed first, then programs of
230 * this cgroup and then programs of parent cgroup.
231 * When children program makes decision (like picking TCP CA or sock bind)
232 * parent program has a chance to override it.
233 *
234 * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups.
235 * A cgroup with NONE doesn't allow any programs in sub-cgroups.
236 * Ex1:
237 * cgrp1 (MULTI progs A, B) ->
238 * cgrp2 (OVERRIDE prog C) ->
239 * cgrp3 (MULTI prog D) ->
240 * cgrp4 (OVERRIDE prog E) ->
241 * cgrp5 (NONE prog F)
242 * the event in cgrp5 triggers execution of F,D,A,B in that order.
243 * if prog F is detached, the execution is E,D,A,B
244 * if prog F and D are detached, the execution is E,A,B
245 * if prog F, E and D are detached, the execution is C,A,B
246 *
247 * All eligible programs are executed regardless of return code from
248 * earlier programs.
5463b3d0
SR
249 */
250#define BPF_F_ALLOW_OVERRIDE (1U << 0)
defd9c47 251#define BPF_F_ALLOW_MULTI (1U << 1)
5463b3d0 252
e07b98d9
DM
253/* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
254 * verifier will perform strict alignment checking as if the kernel
255 * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
256 * and NET_IP_ALIGN defined to 2.
257 */
258#define BPF_F_STRICT_ALIGNMENT (1U << 0)
259
e9ee9efc
DM
260/* If BPF_F_ANY_ALIGNMENT is used in BPF_PROF_LOAD command, the
261 * verifier will allow any alignment whatsoever. On platforms
262 * with strict alignment requirements for loads ands stores (such
263 * as sparc and mips) the verifier validates that all loads and
264 * stores provably follow this requirement. This flag turns that
265 * checking and enforcement off.
266 *
267 * It is mostly used for testing when we want to validate the
268 * context and memory access aspects of the verifier, but because
269 * of an unaligned access the alignment check would trigger before
270 * the one we are interested in.
271 */
272#define BPF_F_ANY_ALIGNMENT (1U << 1)
273
9ce33e33
JW
274/* BPF_F_TEST_RND_HI32 is used in BPF_PROG_LOAD command for testing purpose.
275 * Verifier does sub-register def/use analysis and identifies instructions whose
276 * def only matters for low 32-bit, high 32-bit is never referenced later
277 * through implicit zero extension. Therefore verifier notifies JIT back-ends
278 * that it is safe to ignore clearing high 32-bit for these instructions. This
279 * saves some back-ends a lot of code-gen. However such optimization is not
280 * necessary on some arches, for example x86_64, arm64 etc, whose JIT back-ends
281 * hence hasn't used verifier's analysis result. But, we really want to have a
282 * way to be able to verify the correctness of the described optimization on
283 * x86_64 on which testsuites are frequently exercised.
284 *
285 * So, this flag is introduced. Once it is set, verifier will randomize high
286 * 32-bit for those instructions who has been identified as safe to ignore them.
287 * Then, if verifier is not doing correct analysis, such randomization will
288 * regress tests to expose bugs.
289 */
290#define BPF_F_TEST_RND_HI32 (1U << 2)
291
0fc2e0b8
AS
292/* The verifier internal test flag. Behavior is undefined */
293#define BPF_F_TEST_STATE_FREQ (1U << 3)
294
c83fef6b
DB
295/* When BPF ldimm64's insn[0].src_reg != 0 then this can have
296 * two extensions:
297 *
298 * insn[0].src_reg: BPF_PSEUDO_MAP_FD BPF_PSEUDO_MAP_VALUE
299 * insn[0].imm: map fd map fd
300 * insn[1].imm: 0 offset into value
301 * insn[0].off: 0 0
302 * insn[1].off: 0 0
303 * ldimm64 rewrite: address of map address of map[0]+offset
304 * verifier type: CONST_PTR_TO_MAP PTR_TO_MAP_VALUE
305 */
971e827b 306#define BPF_PSEUDO_MAP_FD 1
c83fef6b 307#define BPF_PSEUDO_MAP_VALUE 2
971e827b 308
48cca7e4
AS
309/* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative
310 * offset to another bpf function
311 */
312#define BPF_PSEUDO_CALL 1
313
971e827b
ACM
314/* flags for BPF_MAP_UPDATE_ELEM command */
315#define BPF_ANY 0 /* create new element or update existing */
316#define BPF_NOEXIST 1 /* create new element if it didn't exist */
317#define BPF_EXIST 2 /* update existing element */
e44ac9a2 318#define BPF_F_LOCK 4 /* spin_lock-ed map_lookup/map_update */
971e827b 319
ad17d0e6 320/* flags for BPF_MAP_CREATE command */
971e827b 321#define BPF_F_NO_PREALLOC (1U << 0)
0cb34dc2
JS
322/* Instead of having one common LRU list in the
323 * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
324 * which can scale and perform better.
325 * Note, the LRU nodes (including free nodes) cannot be moved
326 * across different LRU lists.
327 */
328#define BPF_F_NO_COMMON_LRU (1U << 1)
ad17d0e6
MKL
329/* Specify numa node during map creation */
330#define BPF_F_NUMA_NODE (1U << 2)
971e827b 331
88cda1c9
MKL
332#define BPF_OBJ_NAME_LEN 16U
333
c83fef6b 334/* Flags for accessing BPF object from syscall side. */
e27afb84
AS
335#define BPF_F_RDONLY (1U << 3)
336#define BPF_F_WRONLY (1U << 4)
337
81f77fd0
SL
338/* Flag for stack_map, store build_id+offset instead of pointer */
339#define BPF_F_STACK_BUILD_ID (1U << 5)
340
608114e4
LB
341/* Zero-initialize hash function seed. This should only be used for testing. */
342#define BPF_F_ZERO_SEED (1U << 6)
343
c83fef6b
DB
344/* Flags for accessing BPF object from program side. */
345#define BPF_F_RDONLY_PROG (1U << 7)
346#define BPF_F_WRONLY_PROG (1U << 8)
347
9e819ffc
SF
348/* Clone map from listener for newly accepted socket */
349#define BPF_F_CLONE (1U << 9)
350
608114e4
LB
351/* flags for BPF_PROG_QUERY */
352#define BPF_F_QUERY_EFFECTIVE (1U << 0)
353
81f77fd0
SL
354enum bpf_stack_build_id_status {
355 /* user space need an empty entry to identify end of a trace */
356 BPF_STACK_BUILD_ID_EMPTY = 0,
357 /* with valid build_id and offset */
358 BPF_STACK_BUILD_ID_VALID = 1,
359 /* couldn't get build_id, fallback to ip */
360 BPF_STACK_BUILD_ID_IP = 2,
361};
362
363#define BPF_BUILD_ID_SIZE 20
364struct bpf_stack_build_id {
365 __s32 status;
366 unsigned char build_id[BPF_BUILD_ID_SIZE];
367 union {
368 __u64 offset;
369 __u64 ip;
370 };
371};
372
971e827b
ACM
373union bpf_attr {
374 struct { /* anonymous struct used by BPF_MAP_CREATE command */
375 __u32 map_type; /* one of enum bpf_map_type */
376 __u32 key_size; /* size of key in bytes */
377 __u32 value_size; /* size of value in bytes */
378 __u32 max_entries; /* max number of entries in a map */
ad17d0e6
MKL
379 __u32 map_flags; /* BPF_MAP_CREATE related
380 * flags defined above.
381 */
fb30d4b7 382 __u32 inner_map_fd; /* fd pointing to the inner map */
ad17d0e6
MKL
383 __u32 numa_node; /* numa node (effective only if
384 * BPF_F_NUMA_NODE is set).
385 */
067cae47 386 char map_name[BPF_OBJ_NAME_LEN];
a3884572 387 __u32 map_ifindex; /* ifindex of netdev to create on */
3bd86a84 388 __u32 btf_fd; /* fd pointing to a BTF type data */
f03b15d3
MKL
389 __u32 btf_key_type_id; /* BTF type_id of the key */
390 __u32 btf_value_type_id; /* BTF type_id of the value */
971e827b
ACM
391 };
392
393 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
394 __u32 map_fd;
395 __aligned_u64 key;
396 union {
397 __aligned_u64 value;
398 __aligned_u64 next_key;
399 };
400 __u64 flags;
401 };
402
403 struct { /* anonymous struct used by BPF_PROG_LOAD command */
404 __u32 prog_type; /* one of enum bpf_prog_type */
405 __u32 insn_cnt;
406 __aligned_u64 insns;
407 __aligned_u64 license;
408 __u32 log_level; /* verbosity level of verifier */
409 __u32 log_size; /* size of user buffer */
410 __aligned_u64 log_buf; /* user supplied buffer */
6c4fc209 411 __u32 kern_version; /* not used */
e07b98d9 412 __u32 prog_flags;
067cae47 413 char prog_name[BPF_OBJ_NAME_LEN];
1f6f4cb7 414 __u32 prog_ifindex; /* ifindex of netdev to prep for */
d7be143b
AI
415 /* For some prog types expected attach type must be known at
416 * load time to verify attach type specific parts of prog
417 * (context accesses, allowed helpers, etc).
418 */
419 __u32 expected_attach_type;
cc19435c
YS
420 __u32 prog_btf_fd; /* fd pointing to BTF type data */
421 __u32 func_info_rec_size; /* userspace bpf_func_info size */
422 __aligned_u64 func_info; /* func info */
423 __u32 func_info_cnt; /* number of bpf_func_info records */
ee491d8d
MKL
424 __u32 line_info_rec_size; /* userspace bpf_line_info size */
425 __aligned_u64 line_info; /* line info */
426 __u32 line_info_cnt; /* number of bpf_line_info records */
ccfe29eb 427 __u32 attach_btf_id; /* in-kernel BTF type id to attach to */
971e827b
ACM
428 };
429
430 struct { /* anonymous struct used by BPF_OBJ_* commands */
431 __aligned_u64 pathname;
432 __u32 bpf_fd;
e27afb84 433 __u32 file_flags;
971e827b 434 };
0cb34dc2
JS
435
436 struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
437 __u32 target_fd; /* container object to attach to */
438 __u32 attach_bpf_fd; /* eBPF program to attach */
439 __u32 attach_type;
5463b3d0 440 __u32 attach_flags;
0cb34dc2 441 };
30848873
AS
442
443 struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
444 __u32 prog_fd;
445 __u32 retval;
2587a974
LB
446 __u32 data_size_in; /* input: len of data_in */
447 __u32 data_size_out; /* input/output: len of data_out
448 * returns ENOSPC if data_out
449 * is too small.
450 */
30848873
AS
451 __aligned_u64 data_in;
452 __aligned_u64 data_out;
453 __u32 repeat;
454 __u32 duration;
5e903c65
SF
455 __u32 ctx_size_in; /* input: len of ctx_in */
456 __u32 ctx_size_out; /* input/output: len of ctx_out
457 * returns ENOSPC if ctx_out
458 * is too small.
459 */
460 __aligned_u64 ctx_in;
461 __aligned_u64 ctx_out;
30848873 462 } test;
95b9afd3
MKL
463
464 struct { /* anonymous struct used by BPF_*_GET_*_ID */
465 union {
466 __u32 start_id;
467 __u32 prog_id;
468 __u32 map_id;
7a01f6a3 469 __u32 btf_id;
95b9afd3
MKL
470 };
471 __u32 next_id;
e27afb84 472 __u32 open_flags;
95b9afd3
MKL
473 };
474
475 struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
476 __u32 bpf_fd;
477 __u32 info_len;
478 __aligned_u64 info;
479 } info;
defd9c47
AS
480
481 struct { /* anonymous struct used by BPF_PROG_QUERY command */
482 __u32 target_fd; /* container object to query */
483 __u32 attach_type;
484 __u32 query_flags;
485 __u32 attach_flags;
486 __aligned_u64 prog_ids;
487 __u32 prog_cnt;
488 } query;
a0fe3e57
AS
489
490 struct {
491 __u64 name;
492 __u32 prog_fd;
493 } raw_tracepoint;
3bd86a84
MKL
494
495 struct { /* anonymous struct for BPF_BTF_LOAD */
496 __aligned_u64 btf;
497 __aligned_u64 btf_log_buf;
498 __u32 btf_size;
499 __u32 btf_log_size;
500 __u32 btf_log_level;
501 };
30687ad9
YS
502
503 struct {
504 __u32 pid; /* input: pid */
505 __u32 fd; /* input: fd */
506 __u32 flags; /* input: flags */
507 __u32 buf_len; /* input/output: buf len */
508 __aligned_u64 buf; /* input/output:
509 * tp_name for tracepoint
510 * symbol for kprobe
511 * filename for uprobe
512 */
513 __u32 prog_id; /* output: prod_id */
514 __u32 fd_type; /* output: BPF_FD_TYPE_* */
515 __u64 probe_offset; /* output: probe_offset */
516 __u64 probe_addr; /* output: probe_addr */
517 } task_fd_query;
971e827b
ACM
518} __attribute__((aligned(8)));
519
9cde0c88
QM
520/* The description below is an attempt at providing documentation to eBPF
521 * developers about the multiple available eBPF helper functions. It can be
522 * parsed and used to produce a manual page. The workflow is the following,
523 * and requires the rst2man utility:
524 *
525 * $ ./scripts/bpf_helpers_doc.py \
526 * --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst
527 * $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7
528 * $ man /tmp/bpf-helpers.7
529 *
530 * Note that in order to produce this external documentation, some RST
531 * formatting is used in the descriptions to get "bold" and "italics" in
532 * manual pages. Also note that the few trailing white spaces are
533 * intentional, removing them would break paragraphs for rst2man.
534 *
535 * Start of BPF helper function descriptions:
536 *
537 * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key)
538 * Description
539 * Perform a lookup in *map* for an entry associated to *key*.
540 * Return
541 * Map value associated to *key*, or **NULL** if no entry was
542 * found.
543 *
544 * int bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags)
545 * Description
546 * Add or update the value of the entry associated to *key* in
547 * *map* with *value*. *flags* is one of:
548 *
549 * **BPF_NOEXIST**
550 * The entry for *key* must not exist in the map.
551 * **BPF_EXIST**
552 * The entry for *key* must already exist in the map.
553 * **BPF_ANY**
554 * No condition on the existence of the entry for *key*.
555 *
556 * Flag value **BPF_NOEXIST** cannot be used for maps of types
557 * **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY** (all
558 * elements always exist), the helper would return an error.
559 * Return
560 * 0 on success, or a negative error in case of failure.
561 *
562 * int bpf_map_delete_elem(struct bpf_map *map, const void *key)
563 * Description
564 * Delete entry with *key* from *map*.
565 * Return
566 * 0 on success, or a negative error in case of failure.
567 *
6ae08ae3 568 * int bpf_probe_read(void *dst, u32 size, const void *unsafe_ptr)
9cde0c88
QM
569 * Description
570 * For tracing programs, safely attempt to read *size* bytes from
6ae08ae3
DB
571 * kernel space address *unsafe_ptr* and store the data in *dst*.
572 *
573 * Generally, use bpf_probe_read_user() or bpf_probe_read_kernel()
574 * instead.
9cde0c88
QM
575 * Return
576 * 0 on success, or a negative error in case of failure.
0cb34dc2
JS
577 *
578 * u64 bpf_ktime_get_ns(void)
9cde0c88
QM
579 * Description
580 * Return the time elapsed since system boot, in nanoseconds.
581 * Return
582 * Current *ktime*.
583 *
584 * int bpf_trace_printk(const char *fmt, u32 fmt_size, ...)
585 * Description
586 * This helper is a "printk()-like" facility for debugging. It
587 * prints a message defined by format *fmt* (of size *fmt_size*)
588 * to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if
589 * available. It can take up to three additional **u64**
590 * arguments (as an eBPF helpers, the total number of arguments is
591 * limited to five).
592 *
593 * Each time the helper is called, it appends a line to the trace.
1f8919b1
PW
594 * Lines are discarded while *\/sys/kernel/debug/tracing/trace* is
595 * open, use *\/sys/kernel/debug/tracing/trace_pipe* to avoid this.
9cde0c88
QM
596 * The format of the trace is customizable, and the exact output
597 * one will get depends on the options set in
598 * *\/sys/kernel/debug/tracing/trace_options* (see also the
599 * *README* file under the same directory). However, it usually
600 * defaults to something like:
601 *
602 * ::
603 *
604 * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg>
605 *
606 * In the above:
607 *
608 * * ``telnet`` is the name of the current task.
609 * * ``470`` is the PID of the current task.
610 * * ``001`` is the CPU number on which the task is
611 * running.
612 * * In ``.N..``, each character refers to a set of
613 * options (whether irqs are enabled, scheduling
614 * options, whether hard/softirqs are running, level of
615 * preempt_disabled respectively). **N** means that
616 * **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED**
617 * are set.
618 * * ``419421.045894`` is a timestamp.
619 * * ``0x00000001`` is a fake value used by BPF for the
620 * instruction pointer register.
621 * * ``<formatted msg>`` is the message formatted with
622 * *fmt*.
623 *
624 * The conversion specifiers supported by *fmt* are similar, but
625 * more limited than for printk(). They are **%d**, **%i**,
626 * **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**,
627 * **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size
628 * of field, padding with zeroes, etc.) is available, and the
629 * helper will return **-EINVAL** (but print nothing) if it
630 * encounters an unknown specifier.
631 *
632 * Also, note that **bpf_trace_printk**\ () is slow, and should
633 * only be used for debugging purposes. For this reason, a notice
634 * bloc (spanning several lines) is printed to kernel logs and
635 * states that the helper should not be used "for production use"
636 * the first time this helper is used (or more precisely, when
637 * **trace_printk**\ () buffers are allocated). For passing values
638 * to user space, perf events should be preferred.
639 * Return
640 * The number of bytes written to the buffer, or a negative error
641 * in case of failure.
642 *
643 * u32 bpf_get_prandom_u32(void)
644 * Description
645 * Get a pseudo-random number.
646 *
647 * From a security point of view, this helper uses its own
648 * pseudo-random internal state, and cannot be used to infer the
649 * seed of other random functions in the kernel. However, it is
650 * essential to note that the generator used by the helper is not
651 * cryptographically secure.
652 * Return
653 * A random 32-bit unsigned value.
654 *
655 * u32 bpf_get_smp_processor_id(void)
656 * Description
657 * Get the SMP (symmetric multiprocessing) processor id. Note that
658 * all programs run with preemption disabled, which means that the
659 * SMP processor id is stable during all the execution of the
660 * program.
661 * Return
662 * The SMP id of the processor running the program.
663 *
664 * int bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags)
665 * Description
666 * Store *len* bytes from address *from* into the packet
667 * associated to *skb*, at *offset*. *flags* are a combination of
668 * **BPF_F_RECOMPUTE_CSUM** (automatically recompute the
669 * checksum for the packet after storing the bytes) and
670 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
671 * **->swhash** and *skb*\ **->l4hash** to 0).
672 *
c1fe1e70 673 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
674 * packet buffer. Therefore, at load time, all checks on pointers
675 * previously done by the verifier are invalidated and must be
676 * performed again, if the helper is used in combination with
677 * direct packet access.
678 * Return
679 * 0 on success, or a negative error in case of failure.
680 *
681 * int bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size)
682 * Description
683 * Recompute the layer 3 (e.g. IP) checksum for the packet
684 * associated to *skb*. Computation is incremental, so the helper
685 * must know the former value of the header field that was
686 * modified (*from*), the new value of this field (*to*), and the
687 * number of bytes (2 or 4) for this field, stored in *size*.
688 * Alternatively, it is possible to store the difference between
689 * the previous and the new values of the header field in *to*, by
690 * setting *from* and *size* to 0. For both methods, *offset*
691 * indicates the location of the IP checksum within the packet.
692 *
693 * This helper works in combination with **bpf_csum_diff**\ (),
694 * which does not update the checksum in-place, but offers more
695 * flexibility and can handle sizes larger than 2 or 4 for the
696 * checksum to update.
697 *
c1fe1e70 698 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
699 * packet buffer. Therefore, at load time, all checks on pointers
700 * previously done by the verifier are invalidated and must be
701 * performed again, if the helper is used in combination with
702 * direct packet access.
703 * Return
704 * 0 on success, or a negative error in case of failure.
705 *
706 * int bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags)
707 * Description
708 * Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the
709 * packet associated to *skb*. Computation is incremental, so the
710 * helper must know the former value of the header field that was
711 * modified (*from*), the new value of this field (*to*), and the
712 * number of bytes (2 or 4) for this field, stored on the lowest
713 * four bits of *flags*. Alternatively, it is possible to store
714 * the difference between the previous and the new values of the
715 * header field in *to*, by setting *from* and the four lowest
716 * bits of *flags* to 0. For both methods, *offset* indicates the
717 * location of the IP checksum within the packet. In addition to
718 * the size of the field, *flags* can be added (bitwise OR) actual
719 * flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left
720 * untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and
721 * for updates resulting in a null checksum the value is set to
722 * **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates
723 * the checksum is to be computed against a pseudo-header.
724 *
725 * This helper works in combination with **bpf_csum_diff**\ (),
726 * which does not update the checksum in-place, but offers more
727 * flexibility and can handle sizes larger than 2 or 4 for the
728 * checksum to update.
729 *
c1fe1e70 730 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
731 * packet buffer. Therefore, at load time, all checks on pointers
732 * previously done by the verifier are invalidated and must be
733 * performed again, if the helper is used in combination with
734 * direct packet access.
735 * Return
736 * 0 on success, or a negative error in case of failure.
737 *
738 * int bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index)
739 * Description
740 * This special helper is used to trigger a "tail call", or in
741 * other words, to jump into another eBPF program. The same stack
742 * frame is used (but values on stack and in registers for the
743 * caller are not accessible to the callee). This mechanism allows
744 * for program chaining, either for raising the maximum number of
745 * available eBPF instructions, or to execute given programs in
746 * conditional blocks. For security reasons, there is an upper
747 * limit to the number of successive tail calls that can be
748 * performed.
749 *
750 * Upon call of this helper, the program attempts to jump into a
751 * program referenced at index *index* in *prog_array_map*, a
752 * special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes
753 * *ctx*, a pointer to the context.
754 *
755 * If the call succeeds, the kernel immediately runs the first
756 * instruction of the new program. This is not a function call,
757 * and it never returns to the previous program. If the call
758 * fails, then the helper has no effect, and the caller continues
759 * to run its subsequent instructions. A call can fail if the
760 * destination program for the jump does not exist (i.e. *index*
761 * is superior to the number of entries in *prog_array_map*), or
762 * if the maximum number of tail calls has been reached for this
763 * chain of programs. This limit is defined in the kernel by the
764 * macro **MAX_TAIL_CALL_CNT** (not accessible to user space),
765 * which is currently set to 32.
766 * Return
767 * 0 on success, or a negative error in case of failure.
768 *
769 * int bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags)
770 * Description
771 * Clone and redirect the packet associated to *skb* to another
772 * net device of index *ifindex*. Both ingress and egress
773 * interfaces can be used for redirection. The **BPF_F_INGRESS**
774 * value in *flags* is used to make the distinction (ingress path
775 * is selected if the flag is present, egress path otherwise).
776 * This is the only flag supported for now.
777 *
778 * In comparison with **bpf_redirect**\ () helper,
779 * **bpf_clone_redirect**\ () has the associated cost of
780 * duplicating the packet buffer, but this can be executed out of
781 * the eBPF program. Conversely, **bpf_redirect**\ () is more
782 * efficient, but it is handled through an action code where the
783 * redirection happens only after the eBPF program has returned.
784 *
c1fe1e70 785 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
786 * packet buffer. Therefore, at load time, all checks on pointers
787 * previously done by the verifier are invalidated and must be
788 * performed again, if the helper is used in combination with
789 * direct packet access.
790 * Return
791 * 0 on success, or a negative error in case of failure.
0cb34dc2
JS
792 *
793 * u64 bpf_get_current_pid_tgid(void)
9cde0c88
QM
794 * Return
795 * A 64-bit integer containing the current tgid and pid, and
796 * created as such:
797 * *current_task*\ **->tgid << 32 \|**
798 * *current_task*\ **->pid**.
0cb34dc2
JS
799 *
800 * u64 bpf_get_current_uid_gid(void)
9cde0c88
QM
801 * Return
802 * A 64-bit integer containing the current GID and UID, and
803 * created as such: *current_gid* **<< 32 \|** *current_uid*.
804 *
5f0e5412 805 * int bpf_get_current_comm(void *buf, u32 size_of_buf)
9cde0c88
QM
806 * Description
807 * Copy the **comm** attribute of the current task into *buf* of
808 * *size_of_buf*. The **comm** attribute contains the name of
809 * the executable (excluding the path) for the current task. The
810 * *size_of_buf* must be strictly positive. On success, the
811 * helper makes sure that the *buf* is NUL-terminated. On failure,
812 * it is filled with zeroes.
813 * Return
814 * 0 on success, or a negative error in case of failure.
815 *
816 * u32 bpf_get_cgroup_classid(struct sk_buff *skb)
817 * Description
818 * Retrieve the classid for the current task, i.e. for the net_cls
819 * cgroup to which *skb* belongs.
820 *
821 * This helper can be used on TC egress path, but not on ingress.
822 *
823 * The net_cls cgroup provides an interface to tag network packets
824 * based on a user-provided identifier for all traffic coming from
825 * the tasks belonging to the related cgroup. See also the related
826 * kernel documentation, available from the Linux sources in file
da82c92f 827 * *Documentation/admin-guide/cgroup-v1/net_cls.rst*.
9cde0c88
QM
828 *
829 * The Linux kernel has two versions for cgroups: there are
830 * cgroups v1 and cgroups v2. Both are available to users, who can
831 * use a mixture of them, but note that the net_cls cgroup is for
832 * cgroup v1 only. This makes it incompatible with BPF programs
833 * run on cgroups, which is a cgroup-v2-only feature (a socket can
834 * only hold data for one version of cgroups at a time).
835 *
836 * This helper is only available is the kernel was compiled with
837 * the **CONFIG_CGROUP_NET_CLASSID** configuration option set to
838 * "**y**" or to "**m**".
839 * Return
840 * The classid, or 0 for the default unconfigured classid.
841 *
842 * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci)
843 * Description
844 * Push a *vlan_tci* (VLAN tag control information) of protocol
845 * *vlan_proto* to the packet associated to *skb*, then update
846 * the checksum. Note that if *vlan_proto* is different from
847 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
848 * be **ETH_P_8021Q**.
849 *
c1fe1e70 850 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
851 * packet buffer. Therefore, at load time, all checks on pointers
852 * previously done by the verifier are invalidated and must be
853 * performed again, if the helper is used in combination with
854 * direct packet access.
855 * Return
856 * 0 on success, or a negative error in case of failure.
857 *
858 * int bpf_skb_vlan_pop(struct sk_buff *skb)
859 * Description
860 * Pop a VLAN header from the packet associated to *skb*.
861 *
c1fe1e70 862 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
863 * packet buffer. Therefore, at load time, all checks on pointers
864 * previously done by the verifier are invalidated and must be
865 * performed again, if the helper is used in combination with
866 * direct packet access.
867 * Return
868 * 0 on success, or a negative error in case of failure.
869 *
870 * int bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
871 * Description
872 * Get tunnel metadata. This helper takes a pointer *key* to an
873 * empty **struct bpf_tunnel_key** of **size**, that will be
874 * filled with tunnel metadata for the packet associated to *skb*.
875 * The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which
876 * indicates that the tunnel is based on IPv6 protocol instead of
877 * IPv4.
878 *
879 * The **struct bpf_tunnel_key** is an object that generalizes the
880 * principal parameters used by various tunneling protocols into a
881 * single struct. This way, it can be used to easily make a
882 * decision based on the contents of the encapsulation header,
883 * "summarized" in this struct. In particular, it holds the IP
884 * address of the remote end (IPv4 or IPv6, depending on the case)
885 * in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also,
886 * this struct exposes the *key*\ **->tunnel_id**, which is
887 * generally mapped to a VNI (Virtual Network Identifier), making
888 * it programmable together with the **bpf_skb_set_tunnel_key**\
889 * () helper.
890 *
891 * Let's imagine that the following code is part of a program
892 * attached to the TC ingress interface, on one end of a GRE
893 * tunnel, and is supposed to filter out all messages coming from
894 * remote ends with IPv4 address other than 10.0.0.1:
895 *
896 * ::
897 *
898 * int ret;
899 * struct bpf_tunnel_key key = {};
900 *
901 * ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0);
902 * if (ret < 0)
903 * return TC_ACT_SHOT; // drop packet
904 *
905 * if (key.remote_ipv4 != 0x0a000001)
906 * return TC_ACT_SHOT; // drop packet
907 *
908 * return TC_ACT_OK; // accept packet
909 *
910 * This interface can also be used with all encapsulation devices
911 * that can operate in "collect metadata" mode: instead of having
912 * one network device per specific configuration, the "collect
913 * metadata" mode only requires a single device where the
914 * configuration can be extracted from this helper.
915 *
916 * This can be used together with various tunnels such as VXLan,
917 * Geneve, GRE or IP in IP (IPIP).
918 * Return
919 * 0 on success, or a negative error in case of failure.
920 *
921 * int bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
922 * Description
923 * Populate tunnel metadata for packet associated to *skb.* The
924 * tunnel metadata is set to the contents of *key*, of *size*. The
925 * *flags* can be set to a combination of the following values:
926 *
927 * **BPF_F_TUNINFO_IPV6**
928 * Indicate that the tunnel is based on IPv6 protocol
929 * instead of IPv4.
930 * **BPF_F_ZERO_CSUM_TX**
931 * For IPv4 packets, add a flag to tunnel metadata
932 * indicating that checksum computation should be skipped
933 * and checksum set to zeroes.
934 * **BPF_F_DONT_FRAGMENT**
935 * Add a flag to tunnel metadata indicating that the
936 * packet should not be fragmented.
937 * **BPF_F_SEQ_NUMBER**
938 * Add a flag to tunnel metadata indicating that a
939 * sequence number should be added to tunnel header before
940 * sending the packet. This flag was added for GRE
941 * encapsulation, but might be used with other protocols
942 * as well in the future.
943 *
944 * Here is a typical usage on the transmit path:
945 *
946 * ::
947 *
948 * struct bpf_tunnel_key key;
949 * populate key ...
950 * bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0);
951 * bpf_clone_redirect(skb, vxlan_dev_ifindex, 0);
952 *
953 * See also the description of the **bpf_skb_get_tunnel_key**\ ()
954 * helper for additional information.
955 * Return
956 * 0 on success, or a negative error in case of failure.
957 *
958 * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags)
959 * Description
960 * Read the value of a perf event counter. This helper relies on a
961 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of
962 * the perf event counter is selected when *map* is updated with
963 * perf event file descriptors. The *map* is an array whose size
964 * is the number of available CPUs, and each cell contains a value
965 * relative to one CPU. The value to retrieve is indicated by
966 * *flags*, that contains the index of the CPU to look up, masked
967 * with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
968 * **BPF_F_CURRENT_CPU** to indicate that the value for the
969 * current CPU should be retrieved.
970 *
971 * Note that before Linux 4.13, only hardware perf event can be
972 * retrieved.
973 *
974 * Also, be aware that the newer helper
975 * **bpf_perf_event_read_value**\ () is recommended over
a56497d3 976 * **bpf_perf_event_read**\ () in general. The latter has some ABI
9cde0c88
QM
977 * quirks where error and counter value are used as a return code
978 * (which is wrong to do since ranges may overlap). This issue is
a56497d3
QM
979 * fixed with **bpf_perf_event_read_value**\ (), which at the same
980 * time provides more features over the **bpf_perf_event_read**\
981 * () interface. Please refer to the description of
9cde0c88
QM
982 * **bpf_perf_event_read_value**\ () for details.
983 * Return
984 * The value of the perf event counter read from the map, or a
985 * negative error code in case of failure.
986 *
987 * int bpf_redirect(u32 ifindex, u64 flags)
988 * Description
989 * Redirect the packet to another net device of index *ifindex*.
990 * This helper is somewhat similar to **bpf_clone_redirect**\
991 * (), except that the packet is not cloned, which provides
992 * increased performance.
993 *
994 * Except for XDP, both ingress and egress interfaces can be used
995 * for redirection. The **BPF_F_INGRESS** value in *flags* is used
996 * to make the distinction (ingress path is selected if the flag
997 * is present, egress path otherwise). Currently, XDP only
998 * supports redirection to the egress interface, and accepts no
999 * flag at all.
1000 *
1001 * The same effect can be attained with the more generic
1002 * **bpf_redirect_map**\ (), which requires specific maps to be
1003 * used but offers better performance.
1004 * Return
1005 * For XDP, the helper returns **XDP_REDIRECT** on success or
1006 * **XDP_ABORTED** on error. For other program types, the values
1007 * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on
1008 * error.
1009 *
1010 * u32 bpf_get_route_realm(struct sk_buff *skb)
1011 * Description
1012 * Retrieve the realm or the route, that is to say the
1013 * **tclassid** field of the destination for the *skb*. The
1014 * indentifier retrieved is a user-provided tag, similar to the
1015 * one used with the net_cls cgroup (see description for
1016 * **bpf_get_cgroup_classid**\ () helper), but here this tag is
1017 * held by a route (a destination entry), not by a task.
1018 *
1019 * Retrieving this identifier works with the clsact TC egress hook
1020 * (see also **tc-bpf(8)**), or alternatively on conventional
1021 * classful egress qdiscs, but not on TC ingress path. In case of
1022 * clsact TC egress hook, this has the advantage that, internally,
1023 * the destination entry has not been dropped yet in the transmit
1024 * path. Therefore, the destination entry does not need to be
1025 * artificially held via **netif_keep_dst**\ () for a classful
1026 * qdisc until the *skb* is freed.
1027 *
1028 * This helper is available only if the kernel was compiled with
1029 * **CONFIG_IP_ROUTE_CLASSID** configuration option.
1030 * Return
1031 * The realm of the route for the packet associated to *skb*, or 0
1032 * if none was found.
1033 *
5f0e5412 1034 * int bpf_perf_event_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
9cde0c88
QM
1035 * Description
1036 * Write raw *data* blob into a special BPF perf event held by
1037 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
1038 * event must have the following attributes: **PERF_SAMPLE_RAW**
1039 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
1040 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
1041 *
1042 * The *flags* are used to indicate the index in *map* for which
1043 * the value must be put, masked with **BPF_F_INDEX_MASK**.
1044 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
1045 * to indicate that the index of the current CPU core should be
1046 * used.
1047 *
1048 * The value to write, of *size*, is passed through eBPF stack and
1049 * pointed by *data*.
1050 *
1051 * The context of the program *ctx* needs also be passed to the
1052 * helper.
1053 *
1054 * On user space, a program willing to read the values needs to
1055 * call **perf_event_open**\ () on the perf event (either for
1056 * one or for all CPUs) and to store the file descriptor into the
1057 * *map*. This must be done before the eBPF program can send data
1058 * into it. An example is available in file
1059 * *samples/bpf/trace_output_user.c* in the Linux kernel source
1060 * tree (the eBPF program counterpart is in
1061 * *samples/bpf/trace_output_kern.c*).
1062 *
1063 * **bpf_perf_event_output**\ () achieves better performance
1064 * than **bpf_trace_printk**\ () for sharing data with user
1065 * space, and is much better suitable for streaming data from eBPF
1066 * programs.
1067 *
1068 * Note that this helper is not restricted to tracing use cases
1069 * and can be used with programs attached to TC or XDP as well,
1070 * where it allows for passing data to user space listeners. Data
1071 * can be:
1072 *
1073 * * Only custom structs,
1074 * * Only the packet payload, or
1075 * * A combination of both.
1076 * Return
1077 * 0 on success, or a negative error in case of failure.
1078 *
5f0e5412 1079 * int bpf_skb_load_bytes(const void *skb, u32 offset, void *to, u32 len)
9cde0c88
QM
1080 * Description
1081 * This helper was provided as an easy way to load data from a
1082 * packet. It can be used to load *len* bytes from *offset* from
1083 * the packet associated to *skb*, into the buffer pointed by
1084 * *to*.
1085 *
1086 * Since Linux 4.7, usage of this helper has mostly been replaced
1087 * by "direct packet access", enabling packet data to be
1088 * manipulated with *skb*\ **->data** and *skb*\ **->data_end**
1089 * pointing respectively to the first byte of packet data and to
1090 * the byte after the last byte of packet data. However, it
1091 * remains useful if one wishes to read large quantities of data
1092 * at once from a packet into the eBPF stack.
1093 * Return
1094 * 0 on success, or a negative error in case of failure.
1095 *
5f0e5412 1096 * int bpf_get_stackid(void *ctx, struct bpf_map *map, u64 flags)
9cde0c88
QM
1097 * Description
1098 * Walk a user or a kernel stack and return its id. To achieve
1099 * this, the helper needs *ctx*, which is a pointer to the context
1100 * on which the tracing program is executed, and a pointer to a
1101 * *map* of type **BPF_MAP_TYPE_STACK_TRACE**.
1102 *
1103 * The last argument, *flags*, holds the number of stack frames to
1104 * skip (from 0 to 255), masked with
1105 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
1106 * a combination of the following flags:
1107 *
1108 * **BPF_F_USER_STACK**
1109 * Collect a user space stack instead of a kernel stack.
1110 * **BPF_F_FAST_STACK_CMP**
1111 * Compare stacks by hash only.
1112 * **BPF_F_REUSE_STACKID**
1113 * If two different stacks hash into the same *stackid*,
1114 * discard the old one.
1115 *
1116 * The stack id retrieved is a 32 bit long integer handle which
1117 * can be further combined with other data (including other stack
1118 * ids) and used as a key into maps. This can be useful for
1119 * generating a variety of graphs (such as flame graphs or off-cpu
1120 * graphs).
1121 *
1122 * For walking a stack, this helper is an improvement over
1123 * **bpf_probe_read**\ (), which can be used with unrolled loops
1124 * but is not efficient and consumes a lot of eBPF instructions.
1125 * Instead, **bpf_get_stackid**\ () can collect up to
1126 * **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that
1127 * this limit can be controlled with the **sysctl** program, and
1128 * that it should be manually increased in order to profile long
1129 * user stacks (such as stacks for Java programs). To do so, use:
1130 *
1131 * ::
1132 *
1133 * # sysctl kernel.perf_event_max_stack=<new value>
9cde0c88
QM
1134 * Return
1135 * The positive or null stack id on success, or a negative error
1136 * in case of failure.
1137 *
1138 * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed)
1139 * Description
1140 * Compute a checksum difference, from the raw buffer pointed by
1141 * *from*, of length *from_size* (that must be a multiple of 4),
1142 * towards the raw buffer pointed by *to*, of size *to_size*
1143 * (same remark). An optional *seed* can be added to the value
1144 * (this can be cascaded, the seed may come from a previous call
1145 * to the helper).
1146 *
1147 * This is flexible enough to be used in several ways:
1148 *
1149 * * With *from_size* == 0, *to_size* > 0 and *seed* set to
1150 * checksum, it can be used when pushing new data.
1151 * * With *from_size* > 0, *to_size* == 0 and *seed* set to
1152 * checksum, it can be used when removing data from a packet.
1153 * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it
1154 * can be used to compute a diff. Note that *from_size* and
1155 * *to_size* do not need to be equal.
1156 *
1157 * This helper can be used in combination with
1158 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to
1159 * which one can feed in the difference computed with
1160 * **bpf_csum_diff**\ ().
1161 * Return
1162 * The checksum result, or a negative error code in case of
1163 * failure.
1164 *
5f0e5412 1165 * int bpf_skb_get_tunnel_opt(struct sk_buff *skb, void *opt, u32 size)
9cde0c88
QM
1166 * Description
1167 * Retrieve tunnel options metadata for the packet associated to
1168 * *skb*, and store the raw tunnel option data to the buffer *opt*
1169 * of *size*.
1170 *
1171 * This helper can be used with encapsulation devices that can
1172 * operate in "collect metadata" mode (please refer to the related
1173 * note in the description of **bpf_skb_get_tunnel_key**\ () for
1174 * more details). A particular example where this can be used is
1175 * in combination with the Geneve encapsulation protocol, where it
1176 * allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper)
1177 * and retrieving arbitrary TLVs (Type-Length-Value headers) from
1178 * the eBPF program. This allows for full customization of these
1179 * headers.
1180 * Return
1181 * The size of the option data retrieved.
1182 *
5f0e5412 1183 * int bpf_skb_set_tunnel_opt(struct sk_buff *skb, void *opt, u32 size)
9cde0c88
QM
1184 * Description
1185 * Set tunnel options metadata for the packet associated to *skb*
1186 * to the option data contained in the raw buffer *opt* of *size*.
1187 *
1188 * See also the description of the **bpf_skb_get_tunnel_opt**\ ()
1189 * helper for additional information.
1190 * Return
1191 * 0 on success, or a negative error in case of failure.
1192 *
1193 * int bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags)
1194 * Description
1195 * Change the protocol of the *skb* to *proto*. Currently
1196 * supported are transition from IPv4 to IPv6, and from IPv6 to
1197 * IPv4. The helper takes care of the groundwork for the
1198 * transition, including resizing the socket buffer. The eBPF
1199 * program is expected to fill the new headers, if any, via
1200 * **skb_store_bytes**\ () and to recompute the checksums with
1201 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\
1202 * (). The main case for this helper is to perform NAT64
1203 * operations out of an eBPF program.
1204 *
1205 * Internally, the GSO type is marked as dodgy so that headers are
1206 * checked and segments are recalculated by the GSO/GRO engine.
1207 * The size for GSO target is adapted as well.
1208 *
1209 * All values for *flags* are reserved for future usage, and must
1210 * be left at zero.
1211 *
c1fe1e70 1212 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1213 * packet buffer. Therefore, at load time, all checks on pointers
1214 * previously done by the verifier are invalidated and must be
1215 * performed again, if the helper is used in combination with
1216 * direct packet access.
1217 * Return
1218 * 0 on success, or a negative error in case of failure.
1219 *
1220 * int bpf_skb_change_type(struct sk_buff *skb, u32 type)
1221 * Description
1222 * Change the packet type for the packet associated to *skb*. This
1223 * comes down to setting *skb*\ **->pkt_type** to *type*, except
1224 * the eBPF program does not have a write access to *skb*\
1225 * **->pkt_type** beside this helper. Using a helper here allows
1226 * for graceful handling of errors.
1227 *
1228 * The major use case is to change incoming *skb*s to
1229 * **PACKET_HOST** in a programmatic way instead of having to
1230 * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for
1231 * example.
1232 *
1233 * Note that *type* only allows certain values. At this time, they
1234 * are:
1235 *
1236 * **PACKET_HOST**
1237 * Packet is for us.
1238 * **PACKET_BROADCAST**
1239 * Send packet to all.
1240 * **PACKET_MULTICAST**
1241 * Send packet to group.
1242 * **PACKET_OTHERHOST**
1243 * Send packet to someone else.
1244 * Return
1245 * 0 on success, or a negative error in case of failure.
1246 *
1247 * int bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index)
1248 * Description
1249 * Check whether *skb* is a descendant of the cgroup2 held by
1250 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
1251 * Return
1252 * The return value depends on the result of the test, and can be:
1253 *
1254 * * 0, if the *skb* failed the cgroup2 descendant test.
1255 * * 1, if the *skb* succeeded the cgroup2 descendant test.
1256 * * A negative error code, if an error occurred.
1257 *
1258 * u32 bpf_get_hash_recalc(struct sk_buff *skb)
1259 * Description
1260 * Retrieve the hash of the packet, *skb*\ **->hash**. If it is
1261 * not set, in particular if the hash was cleared due to mangling,
1262 * recompute this hash. Later accesses to the hash can be done
1263 * directly with *skb*\ **->hash**.
1264 *
1265 * Calling **bpf_set_hash_invalid**\ (), changing a packet
1266 * prototype with **bpf_skb_change_proto**\ (), or calling
1267 * **bpf_skb_store_bytes**\ () with the
1268 * **BPF_F_INVALIDATE_HASH** are actions susceptible to clear
1269 * the hash and to trigger a new computation for the next call to
1270 * **bpf_get_hash_recalc**\ ().
1271 * Return
1272 * The 32-bit hash.
0cb34dc2
JS
1273 *
1274 * u64 bpf_get_current_task(void)
9cde0c88
QM
1275 * Return
1276 * A pointer to the current task struct.
1277 *
1278 * int bpf_probe_write_user(void *dst, const void *src, u32 len)
1279 * Description
1280 * Attempt in a safe way to write *len* bytes from the buffer
1281 * *src* to *dst* in memory. It only works for threads that are in
1282 * user context, and *dst* must be a valid user space address.
1283 *
1284 * This helper should not be used to implement any kind of
1285 * security mechanism because of TOC-TOU attacks, but rather to
1286 * debug, divert, and manipulate execution of semi-cooperative
1287 * processes.
1288 *
1289 * Keep in mind that this feature is meant for experiments, and it
1290 * has a risk of crashing the system and running programs.
1291 * Therefore, when an eBPF program using this helper is attached,
1292 * a warning including PID and process name is printed to kernel
1293 * logs.
1294 * Return
1295 * 0 on success, or a negative error in case of failure.
1296 *
1297 * int bpf_current_task_under_cgroup(struct bpf_map *map, u32 index)
1298 * Description
1299 * Check whether the probe is being run is the context of a given
1300 * subset of the cgroup2 hierarchy. The cgroup2 to test is held by
1301 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
1302 * Return
1303 * The return value depends on the result of the test, and can be:
1304 *
1305 * * 0, if the *skb* task belongs to the cgroup2.
1306 * * 1, if the *skb* task does not belong to the cgroup2.
1307 * * A negative error code, if an error occurred.
1308 *
1309 * int bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags)
1310 * Description
1311 * Resize (trim or grow) the packet associated to *skb* to the
1312 * new *len*. The *flags* are reserved for future usage, and must
1313 * be left at zero.
1314 *
1315 * The basic idea is that the helper performs the needed work to
1316 * change the size of the packet, then the eBPF program rewrites
1317 * the rest via helpers like **bpf_skb_store_bytes**\ (),
1318 * **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ ()
1319 * and others. This helper is a slow path utility intended for
1320 * replies with control messages. And because it is targeted for
1321 * slow path, the helper itself can afford to be slow: it
1322 * implicitly linearizes, unclones and drops offloads from the
1323 * *skb*.
1324 *
c1fe1e70 1325 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1326 * packet buffer. Therefore, at load time, all checks on pointers
1327 * previously done by the verifier are invalidated and must be
1328 * performed again, if the helper is used in combination with
1329 * direct packet access.
1330 * Return
1331 * 0 on success, or a negative error in case of failure.
1332 *
1333 * int bpf_skb_pull_data(struct sk_buff *skb, u32 len)
1334 * Description
1335 * Pull in non-linear data in case the *skb* is non-linear and not
1336 * all of *len* are part of the linear section. Make *len* bytes
1337 * from *skb* readable and writable. If a zero value is passed for
1338 * *len*, then the whole length of the *skb* is pulled.
1339 *
1340 * This helper is only needed for reading and writing with direct
1341 * packet access.
1342 *
1343 * For direct packet access, testing that offsets to access
1344 * are within packet boundaries (test on *skb*\ **->data_end**) is
1345 * susceptible to fail if offsets are invalid, or if the requested
1346 * data is in non-linear parts of the *skb*. On failure the
1347 * program can just bail out, or in the case of a non-linear
1348 * buffer, use a helper to make the data available. The
1349 * **bpf_skb_load_bytes**\ () helper is a first solution to access
1350 * the data. Another one consists in using **bpf_skb_pull_data**
1351 * to pull in once the non-linear parts, then retesting and
1352 * eventually access the data.
1353 *
1354 * At the same time, this also makes sure the *skb* is uncloned,
1355 * which is a necessary condition for direct write. As this needs
1356 * to be an invariant for the write part only, the verifier
1357 * detects writes and adds a prologue that is calling
1358 * **bpf_skb_pull_data()** to effectively unclone the *skb* from
1359 * the very beginning in case it is indeed cloned.
1360 *
c1fe1e70 1361 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1362 * packet buffer. Therefore, at load time, all checks on pointers
1363 * previously done by the verifier are invalidated and must be
1364 * performed again, if the helper is used in combination with
1365 * direct packet access.
1366 * Return
1367 * 0 on success, or a negative error in case of failure.
1368 *
1369 * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum)
1370 * Description
1371 * Add the checksum *csum* into *skb*\ **->csum** in case the
1372 * driver has supplied a checksum for the entire packet into that
1373 * field. Return an error otherwise. This helper is intended to be
1374 * used in combination with **bpf_csum_diff**\ (), in particular
1375 * when the checksum needs to be updated after data has been
1376 * written into the packet through direct packet access.
1377 * Return
1378 * The checksum on success, or a negative error code in case of
1379 * failure.
1380 *
1381 * void bpf_set_hash_invalid(struct sk_buff *skb)
1382 * Description
1383 * Invalidate the current *skb*\ **->hash**. It can be used after
1384 * mangling on headers through direct packet access, in order to
1385 * indicate that the hash is outdated and to trigger a
1386 * recalculation the next time the kernel tries to access this
1387 * hash or when the **bpf_get_hash_recalc**\ () helper is called.
1388 *
1389 * int bpf_get_numa_node_id(void)
1390 * Description
1391 * Return the id of the current NUMA node. The primary use case
1392 * for this helper is the selection of sockets for the local NUMA
1393 * node, when the program is attached to sockets using the
1394 * **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**),
1395 * but the helper is also available to other eBPF program types,
1396 * similarly to **bpf_get_smp_processor_id**\ ().
1397 * Return
1398 * The id of current NUMA node.
1399 *
1400 * int bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags)
1401 * Description
1402 * Grows headroom of packet associated to *skb* and adjusts the
1403 * offset of the MAC header accordingly, adding *len* bytes of
1404 * space. It automatically extends and reallocates memory as
1405 * required.
1406 *
1407 * This helper can be used on a layer 3 *skb* to push a MAC header
1408 * for redirection into a layer 2 device.
1409 *
1410 * All values for *flags* are reserved for future usage, and must
1411 * be left at zero.
1412 *
c1fe1e70 1413 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1414 * packet buffer. Therefore, at load time, all checks on pointers
1415 * previously done by the verifier are invalidated and must be
1416 * performed again, if the helper is used in combination with
1417 * direct packet access.
1418 * Return
1419 * 0 on success, or a negative error in case of failure.
1420 *
1421 * int bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta)
1422 * Description
1423 * Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that
1424 * it is possible to use a negative value for *delta*. This helper
1425 * can be used to prepare the packet for pushing or popping
1426 * headers.
1427 *
c1fe1e70 1428 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1429 * packet buffer. Therefore, at load time, all checks on pointers
1430 * previously done by the verifier are invalidated and must be
1431 * performed again, if the helper is used in combination with
1432 * direct packet access.
1433 * Return
1434 * 0 on success, or a negative error in case of failure.
9a738266 1435 *
6ae08ae3 1436 * int bpf_probe_read_str(void *dst, u32 size, const void *unsafe_ptr)
9cde0c88 1437 * Description
6ae08ae3
DB
1438 * Copy a NUL terminated string from an unsafe kernel address
1439 * *unsafe_ptr* to *dst*. See bpf_probe_read_kernel_str() for
1440 * more details.
9cde0c88 1441 *
6ae08ae3
DB
1442 * Generally, use bpf_probe_read_user_str() or bpf_probe_read_kernel_str()
1443 * instead.
9cde0c88
QM
1444 * Return
1445 * On success, the strictly positive length of the string,
1446 * including the trailing NUL character. On error, a negative
1447 * value.
1448 *
1449 * u64 bpf_get_socket_cookie(struct sk_buff *skb)
1450 * Description
1451 * If the **struct sk_buff** pointed by *skb* has a known socket,
1452 * retrieve the cookie (generated by the kernel) of this socket.
1453 * If no cookie has been set yet, generate a new cookie. Once
1454 * generated, the socket cookie remains stable for the life of the
1455 * socket. This helper can be useful for monitoring per socket
609a2ca5
DB
1456 * networking traffic statistics as it provides a global socket
1457 * identifier that can be assumed unique.
9cde0c88
QM
1458 * Return
1459 * A 8-byte long non-decreasing number on success, or 0 if the
1460 * socket field is missing inside *skb*.
1461 *
a40b712e
AI
1462 * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx)
1463 * Description
1464 * Equivalent to bpf_get_socket_cookie() helper that accepts
ea6eced0 1465 * *skb*, but gets socket from **struct bpf_sock_addr** context.
a40b712e
AI
1466 * Return
1467 * A 8-byte long non-decreasing number.
1468 *
1469 * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx)
1470 * Description
1471 * Equivalent to bpf_get_socket_cookie() helper that accepts
ea6eced0 1472 * *skb*, but gets socket from **struct bpf_sock_ops** context.
a40b712e
AI
1473 * Return
1474 * A 8-byte long non-decreasing number.
1475 *
9cde0c88
QM
1476 * u32 bpf_get_socket_uid(struct sk_buff *skb)
1477 * Return
1478 * The owner UID of the socket associated to *skb*. If the socket
1479 * is **NULL**, or if it is not a full socket (i.e. if it is a
1480 * time-wait or a request socket instead), **overflowuid** value
1481 * is returned (note that **overflowuid** might also be the actual
1482 * UID value for the socket).
1483 *
1484 * u32 bpf_set_hash(struct sk_buff *skb, u32 hash)
1485 * Description
1486 * Set the full hash for *skb* (set the field *skb*\ **->hash**)
1487 * to value *hash*.
1488 * Return
1489 * 0
1490 *
5f0e5412 1491 * int bpf_setsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, void *optval, int optlen)
9cde0c88
QM
1492 * Description
1493 * Emulate a call to **setsockopt()** on the socket associated to
1494 * *bpf_socket*, which must be a full socket. The *level* at
1495 * which the option resides and the name *optname* of the option
1496 * must be specified, see **setsockopt(2)** for more information.
1497 * The option value of length *optlen* is pointed by *optval*.
1498 *
1499 * This helper actually implements a subset of **setsockopt()**.
1500 * It supports the following *level*\ s:
1501 *
1502 * * **SOL_SOCKET**, which supports the following *optname*\ s:
1503 * **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,
1504 * **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**.
1505 * * **IPPROTO_TCP**, which supports the following *optname*\ s:
1506 * **TCP_CONGESTION**, **TCP_BPF_IW**,
1507 * **TCP_BPF_SNDCWND_CLAMP**.
1508 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
1509 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
1510 * Return
1511 * 0 on success, or a negative error in case of failure.
1512 *
b55cbc8d 1513 * int bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags)
9cde0c88
QM
1514 * Description
1515 * Grow or shrink the room for data in the packet associated to
1516 * *skb* by *len_diff*, and according to the selected *mode*.
1517 *
6c408dec
WB
1518 * There are two supported modes at this time:
1519 *
1520 * * **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer
1521 * (room space is added or removed below the layer 2 header).
9cde0c88
QM
1522 *
1523 * * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer
1524 * (room space is added or removed below the layer 3 header).
1525 *
6c408dec
WB
1526 * The following flags are supported at this time:
1527 *
1528 * * **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size.
1529 * Adjusting mss in this way is not allowed for datagrams.
1530 *
c1fe1e70
QM
1531 * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4**,
1532 * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6**:
6c408dec
WB
1533 * Any new space is reserved to hold a tunnel header.
1534 * Configure skb offsets and other fields accordingly.
1535 *
c1fe1e70
QM
1536 * * **BPF_F_ADJ_ROOM_ENCAP_L4_GRE**,
1537 * **BPF_F_ADJ_ROOM_ENCAP_L4_UDP**:
6c408dec 1538 * Use with ENCAP_L3 flags to further specify the tunnel type.
9cde0c88 1539 *
c1fe1e70 1540 * * **BPF_F_ADJ_ROOM_ENCAP_L2**\ (*len*):
1db04c30 1541 * Use with ENCAP_L3/L4 flags to further specify the tunnel
c1fe1e70 1542 * type; *len* is the length of the inner MAC header.
1db04c30 1543 *
c1fe1e70 1544 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1545 * packet buffer. Therefore, at load time, all checks on pointers
1546 * previously done by the verifier are invalidated and must be
1547 * performed again, if the helper is used in combination with
1548 * direct packet access.
1549 * Return
1550 * 0 on success, or a negative error in case of failure.
1551 *
1552 * int bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
1553 * Description
1554 * Redirect the packet to the endpoint referenced by *map* at
1555 * index *key*. Depending on its type, this *map* can contain
1556 * references to net devices (for forwarding packets through other
1557 * ports), or to CPUs (for redirecting XDP frames to another CPU;
1558 * but this is only implemented for native XDP (with driver
1559 * support) as of this writing).
1560 *
3745ee18
PP
1561 * The lower two bits of *flags* are used as the return code if
1562 * the map lookup fails. This is so that the return value can be
1563 * one of the XDP program return codes up to XDP_TX, as chosen by
1564 * the caller. Any higher bits in the *flags* argument must be
1565 * unset.
9cde0c88
QM
1566 *
1567 * When used to redirect packets to net devices, this helper
1568 * provides a high performance increase over **bpf_redirect**\ ().
1569 * This is due to various implementation details of the underlying
1570 * mechanisms, one of which is the fact that **bpf_redirect_map**\
1571 * () tries to send packet as a "bulk" to the device.
1572 * Return
1573 * **XDP_REDIRECT** on success, or **XDP_ABORTED** on error.
1574 *
5f0e5412 1575 * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
9cde0c88
QM
1576 * Description
1577 * Redirect the packet to the socket referenced by *map* (of type
1578 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
1579 * egress interfaces can be used for redirection. The
1580 * **BPF_F_INGRESS** value in *flags* is used to make the
1581 * distinction (ingress path is selected if the flag is present,
1582 * egress path otherwise). This is the only flag supported for now.
1583 * Return
1584 * **SK_PASS** on success, or **SK_DROP** on error.
1585 *
96871b9f 1586 * int bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
9cde0c88
QM
1587 * Description
1588 * Add an entry to, or update a *map* referencing sockets. The
1589 * *skops* is used as a new value for the entry associated to
1590 * *key*. *flags* is one of:
1591 *
1592 * **BPF_NOEXIST**
1593 * The entry for *key* must not exist in the map.
1594 * **BPF_EXIST**
1595 * The entry for *key* must already exist in the map.
1596 * **BPF_ANY**
1597 * No condition on the existence of the entry for *key*.
1598 *
1599 * If the *map* has eBPF programs (parser and verdict), those will
1600 * be inherited by the socket being added. If the socket is
1601 * already attached to eBPF programs, this results in an error.
1602 * Return
1603 * 0 on success, or a negative error in case of failure.
1604 *
1605 * int bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta)
1606 * Description
1607 * Adjust the address pointed by *xdp_md*\ **->data_meta** by
1608 * *delta* (which can be positive or negative). Note that this
1609 * operation modifies the address stored in *xdp_md*\ **->data**,
1610 * so the latter must be loaded only after the helper has been
1611 * called.
1612 *
1613 * The use of *xdp_md*\ **->data_meta** is optional and programs
1614 * are not required to use it. The rationale is that when the
1615 * packet is processed with XDP (e.g. as DoS filter), it is
1616 * possible to push further meta data along with it before passing
1617 * to the stack, and to give the guarantee that an ingress eBPF
1618 * program attached as a TC classifier on the same device can pick
1619 * this up for further post-processing. Since TC works with socket
1620 * buffers, it remains possible to set from XDP the **mark** or
1621 * **priority** pointers, or other pointers for the socket buffer.
1622 * Having this scratch space generic and programmable allows for
1623 * more flexibility as the user is free to store whatever meta
1624 * data they need.
1625 *
c1fe1e70 1626 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1627 * packet buffer. Therefore, at load time, all checks on pointers
1628 * previously done by the verifier are invalidated and must be
1629 * performed again, if the helper is used in combination with
1630 * direct packet access.
1631 * Return
1632 * 0 on success, or a negative error in case of failure.
1633 *
1634 * int bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size)
1635 * Description
1636 * Read the value of a perf event counter, and store it into *buf*
1637 * of size *buf_size*. This helper relies on a *map* of type
1638 * **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event
1639 * counter is selected when *map* is updated with perf event file
1640 * descriptors. The *map* is an array whose size is the number of
1641 * available CPUs, and each cell contains a value relative to one
1642 * CPU. The value to retrieve is indicated by *flags*, that
1643 * contains the index of the CPU to look up, masked with
1644 * **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
1645 * **BPF_F_CURRENT_CPU** to indicate that the value for the
1646 * current CPU should be retrieved.
1647 *
1648 * This helper behaves in a way close to
1649 * **bpf_perf_event_read**\ () helper, save that instead of
1650 * just returning the value observed, it fills the *buf*
1651 * structure. This allows for additional data to be retrieved: in
1652 * particular, the enabled and running times (in *buf*\
1653 * **->enabled** and *buf*\ **->running**, respectively) are
1654 * copied. In general, **bpf_perf_event_read_value**\ () is
1655 * recommended over **bpf_perf_event_read**\ (), which has some
1656 * ABI issues and provides fewer functionalities.
1657 *
1658 * These values are interesting, because hardware PMU (Performance
1659 * Monitoring Unit) counters are limited resources. When there are
1660 * more PMU based perf events opened than available counters,
1661 * kernel will multiplex these events so each event gets certain
1662 * percentage (but not all) of the PMU time. In case that
1663 * multiplexing happens, the number of samples or counter value
1664 * will not reflect the case compared to when no multiplexing
1665 * occurs. This makes comparison between different runs difficult.
1666 * Typically, the counter value should be normalized before
1667 * comparing to other experiments. The usual normalization is done
1668 * as follows.
1669 *
1670 * ::
1671 *
1672 * normalized_counter = counter * t_enabled / t_running
1673 *
1674 * Where t_enabled is the time enabled for event and t_running is
1675 * the time running for event since last normalization. The
1676 * enabled and running times are accumulated since the perf event
1677 * open. To achieve scaling factor between two invocations of an
1678 * eBPF program, users can can use CPU id as the key (which is
1679 * typical for perf array usage model) to remember the previous
1680 * value and do the calculation inside the eBPF program.
1681 * Return
1682 * 0 on success, or a negative error in case of failure.
1683 *
96871b9f 1684 * int bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size)
9cde0c88
QM
1685 * Description
1686 * For en eBPF program attached to a perf event, retrieve the
1687 * value of the event counter associated to *ctx* and store it in
1688 * the structure pointed by *buf* and of size *buf_size*. Enabled
1689 * and running times are also stored in the structure (see
1690 * description of helper **bpf_perf_event_read_value**\ () for
1691 * more details).
1692 * Return
1693 * 0 on success, or a negative error in case of failure.
1694 *
5f0e5412 1695 * int bpf_getsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, void *optval, int optlen)
9cde0c88
QM
1696 * Description
1697 * Emulate a call to **getsockopt()** on the socket associated to
1698 * *bpf_socket*, which must be a full socket. The *level* at
1699 * which the option resides and the name *optname* of the option
1700 * must be specified, see **getsockopt(2)** for more information.
1701 * The retrieved value is stored in the structure pointed by
1702 * *opval* and of length *optlen*.
1703 *
1704 * This helper actually implements a subset of **getsockopt()**.
1705 * It supports the following *level*\ s:
1706 *
1707 * * **IPPROTO_TCP**, which supports *optname*
1708 * **TCP_CONGESTION**.
1709 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
1710 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
1711 * Return
1712 * 0 on success, or a negative error in case of failure.
1713 *
1f8919b1 1714 * int bpf_override_return(struct pt_regs *regs, u64 rc)
9cde0c88
QM
1715 * Description
1716 * Used for error injection, this helper uses kprobes to override
1717 * the return value of the probed function, and to set it to *rc*.
1718 * The first argument is the context *regs* on which the kprobe
1719 * works.
1720 *
1721 * This helper works by setting setting the PC (program counter)
1722 * to an override function which is run in place of the original
1723 * probed function. This means the probed function is not run at
1724 * all. The replacement function just returns with the required
1725 * value.
1726 *
1727 * This helper has security implications, and thus is subject to
1728 * restrictions. It is only available if the kernel was compiled
1729 * with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration
1730 * option, and in this case it only works on functions tagged with
1731 * **ALLOW_ERROR_INJECTION** in the kernel code.
1732 *
1733 * Also, the helper is only available for the architectures having
1734 * the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing,
1735 * x86 architecture is the only one to support this feature.
1736 * Return
1737 * 0
1738 *
96871b9f 1739 * int bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval)
9cde0c88
QM
1740 * Description
1741 * Attempt to set the value of the **bpf_sock_ops_cb_flags** field
1742 * for the full TCP socket associated to *bpf_sock_ops* to
1743 * *argval*.
1744 *
1745 * The primary use of this field is to determine if there should
1746 * be calls to eBPF programs of type
1747 * **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP
1748 * code. A program of the same type can change its value, per
1749 * connection and as necessary, when the connection is
1750 * established. This field is directly accessible for reading, but
1751 * this helper must be used for updates in order to return an
1752 * error if an eBPF program tries to set a callback that is not
1753 * supported in the current kernel.
1754 *
4635b0ae 1755 * *argval* is a flag array which can combine these flags:
9cde0c88
QM
1756 *
1757 * * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out)
1758 * * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission)
1759 * * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change)
692cbaa9 1760 * * **BPF_SOCK_OPS_RTT_CB_FLAG** (every RTT)
9cde0c88 1761 *
4635b0ae
MM
1762 * Therefore, this function can be used to clear a callback flag by
1763 * setting the appropriate bit to zero. e.g. to disable the RTO
1764 * callback:
1765 *
1766 * **bpf_sock_ops_cb_flags_set(bpf_sock,**
1767 * **bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)**
1768 *
9cde0c88
QM
1769 * Here are some examples of where one could call such eBPF
1770 * program:
1771 *
1772 * * When RTO fires.
1773 * * When a packet is retransmitted.
1774 * * When the connection terminates.
1775 * * When a packet is sent.
1776 * * When a packet is received.
1777 * Return
1778 * Code **-EINVAL** if the socket is not a full TCP socket;
1779 * otherwise, a positive number containing the bits that could not
1780 * be set is returned (which comes down to 0 if all bits were set
1781 * as required).
1782 *
1783 * int bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags)
1784 * Description
1785 * This helper is used in programs implementing policies at the
1786 * socket level. If the message *msg* is allowed to pass (i.e. if
1787 * the verdict eBPF program returns **SK_PASS**), redirect it to
1788 * the socket referenced by *map* (of type
1789 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
1790 * egress interfaces can be used for redirection. The
1791 * **BPF_F_INGRESS** value in *flags* is used to make the
1792 * distinction (ingress path is selected if the flag is present,
1793 * egress path otherwise). This is the only flag supported for now.
1794 * Return
1795 * **SK_PASS** on success, or **SK_DROP** on error.
1796 *
1797 * int bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes)
1798 * Description
1799 * For socket policies, apply the verdict of the eBPF program to
1800 * the next *bytes* (number of bytes) of message *msg*.
1801 *
1802 * For example, this helper can be used in the following cases:
1803 *
1804 * * A single **sendmsg**\ () or **sendfile**\ () system call
1805 * contains multiple logical messages that the eBPF program is
1806 * supposed to read and for which it should apply a verdict.
1807 * * An eBPF program only cares to read the first *bytes* of a
1808 * *msg*. If the message has a large payload, then setting up
1809 * and calling the eBPF program repeatedly for all bytes, even
1810 * though the verdict is already known, would create unnecessary
1811 * overhead.
1812 *
1813 * When called from within an eBPF program, the helper sets a
1814 * counter internal to the BPF infrastructure, that is used to
1815 * apply the last verdict to the next *bytes*. If *bytes* is
1816 * smaller than the current data being processed from a
1817 * **sendmsg**\ () or **sendfile**\ () system call, the first
1818 * *bytes* will be sent and the eBPF program will be re-run with
1819 * the pointer for start of data pointing to byte number *bytes*
1820 * **+ 1**. If *bytes* is larger than the current data being
1821 * processed, then the eBPF verdict will be applied to multiple
1822 * **sendmsg**\ () or **sendfile**\ () calls until *bytes* are
1823 * consumed.
1824 *
1825 * Note that if a socket closes with the internal counter holding
1826 * a non-zero value, this is not a problem because data is not
1827 * being buffered for *bytes* and is sent as it is received.
1828 * Return
1829 * 0
1830 *
1831 * int bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes)
1832 * Description
1833 * For socket policies, prevent the execution of the verdict eBPF
1834 * program for message *msg* until *bytes* (byte number) have been
1835 * accumulated.
1836 *
1837 * This can be used when one needs a specific number of bytes
1838 * before a verdict can be assigned, even if the data spans
1839 * multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme
1840 * case would be a user calling **sendmsg**\ () repeatedly with
1841 * 1-byte long message segments. Obviously, this is bad for
1842 * performance, but it is still valid. If the eBPF program needs
1843 * *bytes* bytes to validate a header, this helper can be used to
1844 * prevent the eBPF program to be called again until *bytes* have
1845 * been accumulated.
1846 * Return
1847 * 0
1848 *
1849 * int bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags)
1850 * Description
1851 * For socket policies, pull in non-linear data from user space
1852 * for *msg* and set pointers *msg*\ **->data** and *msg*\
1853 * **->data_end** to *start* and *end* bytes offsets into *msg*,
1854 * respectively.
1855 *
1856 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
1857 * *msg* it can only parse data that the (**data**, **data_end**)
1858 * pointers have already consumed. For **sendmsg**\ () hooks this
1859 * is likely the first scatterlist element. But for calls relying
1860 * on the **sendpage** handler (e.g. **sendfile**\ ()) this will
1861 * be the range (**0**, **0**) because the data is shared with
1862 * user space and by default the objective is to avoid allowing
1863 * user space to modify data while (or after) eBPF verdict is
1864 * being decided. This helper can be used to pull in data and to
1865 * set the start and end pointer to given values. Data will be
1866 * copied if necessary (i.e. if data was not linear and if start
1867 * and end pointers do not point to the same chunk).
1868 *
c1fe1e70 1869 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1870 * packet buffer. Therefore, at load time, all checks on pointers
1871 * previously done by the verifier are invalidated and must be
1872 * performed again, if the helper is used in combination with
1873 * direct packet access.
1874 *
1875 * All values for *flags* are reserved for future usage, and must
1876 * be left at zero.
1877 * Return
1878 * 0 on success, or a negative error in case of failure.
1879 *
96871b9f 1880 * int bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len)
9cde0c88
QM
1881 * Description
1882 * Bind the socket associated to *ctx* to the address pointed by
1883 * *addr*, of length *addr_len*. This allows for making outgoing
1884 * connection from the desired IP address, which can be useful for
1885 * example when all processes inside a cgroup should use one
1886 * single IP address on a host that has multiple IP configured.
1887 *
1888 * This helper works for IPv4 and IPv6, TCP and UDP sockets. The
1889 * domain (*addr*\ **->sa_family**) must be **AF_INET** (or
1890 * **AF_INET6**). Looking for a free port to bind to can be
1891 * expensive, therefore binding to port is not permitted by the
1892 * helper: *addr*\ **->sin_port** (or **sin6_port**, respectively)
1893 * must be set to zero.
1894 * Return
1895 * 0 on success, or a negative error in case of failure.
1896 *
1897 * int bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta)
1898 * Description
1899 * Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is
1900 * only possible to shrink the packet as of this writing,
1901 * therefore *delta* must be a negative integer.
1902 *
c1fe1e70 1903 * A call to this helper is susceptible to change the underlying
9cde0c88
QM
1904 * packet buffer. Therefore, at load time, all checks on pointers
1905 * previously done by the verifier are invalidated and must be
1906 * performed again, if the helper is used in combination with
1907 * direct packet access.
1908 * Return
1909 * 0 on success, or a negative error in case of failure.
1910 *
1911 * int bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags)
1912 * Description
1913 * Retrieve the XFRM state (IP transform framework, see also
1914 * **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*.
1915 *
1916 * The retrieved value is stored in the **struct bpf_xfrm_state**
1917 * pointed by *xfrm_state* and of length *size*.
1918 *
1919 * All values for *flags* are reserved for future usage, and must
1920 * be left at zero.
1921 *
1922 * This helper is available only if the kernel was compiled with
1923 * **CONFIG_XFRM** configuration option.
1924 * Return
1925 * 0 on success, or a negative error in case of failure.
de2ff05f 1926 *
5f0e5412 1927 * int bpf_get_stack(void *ctx, void *buf, u32 size, u64 flags)
de2ff05f 1928 * Description
a56497d3
QM
1929 * Return a user or a kernel stack in bpf program provided buffer.
1930 * To achieve this, the helper needs *ctx*, which is a pointer
1931 * to the context on which the tracing program is executed.
1932 * To store the stacktrace, the bpf program provides *buf* with
1933 * a nonnegative *size*.
1934 *
1935 * The last argument, *flags*, holds the number of stack frames to
1936 * skip (from 0 to 255), masked with
1937 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
1938 * the following flags:
1939 *
1940 * **BPF_F_USER_STACK**
1941 * Collect a user space stack instead of a kernel stack.
1942 * **BPF_F_USER_BUILD_ID**
1943 * Collect buildid+offset instead of ips for user stack,
1944 * only valid if **BPF_F_USER_STACK** is also specified.
1945 *
1946 * **bpf_get_stack**\ () can collect up to
1947 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
1948 * to sufficient large buffer size. Note that
1949 * this limit can be controlled with the **sysctl** program, and
1950 * that it should be manually increased in order to profile long
1951 * user stacks (such as stacks for Java programs). To do so, use:
1952 *
1953 * ::
1954 *
1955 * # sysctl kernel.perf_event_max_stack=<new value>
de2ff05f 1956 * Return
7a279e93
QM
1957 * A non-negative value equal to or less than *size* on success,
1958 * or a negative error in case of failure.
32b3652c 1959 *
5f0e5412 1960 * int bpf_skb_load_bytes_relative(const void *skb, u32 offset, void *to, u32 len, u32 start_header)
32b3652c
DB
1961 * Description
1962 * This helper is similar to **bpf_skb_load_bytes**\ () in that
1963 * it provides an easy way to load *len* bytes from *offset*
1964 * from the packet associated to *skb*, into the buffer pointed
1965 * by *to*. The difference to **bpf_skb_load_bytes**\ () is that
1966 * a fifth argument *start_header* exists in order to select a
1967 * base offset to start from. *start_header* can be one of:
1968 *
1969 * **BPF_HDR_START_MAC**
1970 * Base offset to load data from is *skb*'s mac header.
1971 * **BPF_HDR_START_NET**
1972 * Base offset to load data from is *skb*'s network header.
1973 *
1974 * In general, "direct packet access" is the preferred method to
1975 * access packet data, however, this helper is in particular useful
1976 * in socket filters where *skb*\ **->data** does not always point
1977 * to the start of the mac header and where "direct packet access"
1978 * is not available.
32b3652c
DB
1979 * Return
1980 * 0 on success, or a negative error in case of failure.
1981 *
cb9c28ef
PB
1982 * int bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags)
1983 * Description
1984 * Do FIB lookup in kernel tables using parameters in *params*.
1985 * If lookup is successful and result shows packet is to be
1986 * forwarded, the neighbor tables are searched for the nexthop.
1987 * If successful (ie., FIB lookup shows forwarding and nexthop
6bdd533c
SY
1988 * is resolved), the nexthop address is returned in ipv4_dst
1989 * or ipv6_dst based on family, smac is set to mac address of
1990 * egress device, dmac is set to nexthop mac address, rt_metric
9b8ca379
QM
1991 * is set to metric from route (IPv4/IPv6 only), and ifindex
1992 * is set to the device index of the nexthop from the FIB lookup.
cb9c28ef 1993 *
0bd72117
DB
1994 * *plen* argument is the size of the passed in struct.
1995 * *flags* argument can be a combination of one or more of the
1996 * following values:
cb9c28ef 1997 *
7a279e93
QM
1998 * **BPF_FIB_LOOKUP_DIRECT**
1999 * Do a direct table lookup vs full lookup using FIB
2000 * rules.
2001 * **BPF_FIB_LOOKUP_OUTPUT**
2002 * Perform lookup from an egress perspective (default is
2003 * ingress).
cb9c28ef 2004 *
0bd72117
DB
2005 * *ctx* is either **struct xdp_md** for XDP programs or
2006 * **struct sk_buff** tc cls_act programs.
2007 * Return
9b8ca379
QM
2008 * * < 0 if any input argument is invalid
2009 * * 0 on success (packet is forwarded, nexthop neighbor exists)
2010 * * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the
2011 * packet is not forwarded or needs assist from full stack
b8b394fa 2012 *
5f0e5412 2013 * int bpf_sock_hash_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
b8b394fa
JF
2014 * Description
2015 * Add an entry to, or update a sockhash *map* referencing sockets.
2016 * The *skops* is used as a new value for the entry associated to
2017 * *key*. *flags* is one of:
2018 *
2019 * **BPF_NOEXIST**
2020 * The entry for *key* must not exist in the map.
2021 * **BPF_EXIST**
2022 * The entry for *key* must already exist in the map.
2023 * **BPF_ANY**
2024 * No condition on the existence of the entry for *key*.
2025 *
2026 * If the *map* has eBPF programs (parser and verdict), those will
2027 * be inherited by the socket being added. If the socket is
2028 * already attached to eBPF programs, this results in an error.
2029 * Return
2030 * 0 on success, or a negative error in case of failure.
2031 *
2032 * int bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags)
2033 * Description
2034 * This helper is used in programs implementing policies at the
2035 * socket level. If the message *msg* is allowed to pass (i.e. if
2036 * the verdict eBPF program returns **SK_PASS**), redirect it to
2037 * the socket referenced by *map* (of type
2038 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
2039 * egress interfaces can be used for redirection. The
2040 * **BPF_F_INGRESS** value in *flags* is used to make the
2041 * distinction (ingress path is selected if the flag is present,
2042 * egress path otherwise). This is the only flag supported for now.
2043 * Return
2044 * **SK_PASS** on success, or **SK_DROP** on error.
2045 *
2046 * int bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags)
2047 * Description
2048 * This helper is used in programs implementing policies at the
2049 * skb socket level. If the sk_buff *skb* is allowed to pass (i.e.
2050 * if the verdeict eBPF program returns **SK_PASS**), redirect it
2051 * to the socket referenced by *map* (of type
2052 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
2053 * egress interfaces can be used for redirection. The
2054 * **BPF_F_INGRESS** value in *flags* is used to make the
2055 * distinction (ingress path is selected if the flag is present,
2056 * egress otherwise). This is the only flag supported for now.
2057 * Return
2058 * **SK_PASS** on success, or **SK_DROP** on error.
c99a84ea
MX
2059 *
2060 * int bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len)
2061 * Description
2062 * Encapsulate the packet associated to *skb* within a Layer 3
2063 * protocol header. This header is provided in the buffer at
2064 * address *hdr*, with *len* its size in bytes. *type* indicates
2065 * the protocol of the header and can be one of:
2066 *
2067 * **BPF_LWT_ENCAP_SEG6**
2068 * IPv6 encapsulation with Segment Routing Header
2069 * (**struct ipv6_sr_hdr**). *hdr* only contains the SRH,
2070 * the IPv6 header is computed by the kernel.
2071 * **BPF_LWT_ENCAP_SEG6_INLINE**
2072 * Only works if *skb* contains an IPv6 packet. Insert a
2073 * Segment Routing Header (**struct ipv6_sr_hdr**) inside
2074 * the IPv6 header.
755db477
PO
2075 * **BPF_LWT_ENCAP_IP**
2076 * IP encapsulation (GRE/GUE/IPIP/etc). The outer header
2077 * must be IPv4 or IPv6, followed by zero or more
c1fe1e70
QM
2078 * additional headers, up to **LWT_BPF_MAX_HEADROOM**
2079 * total bytes in all prepended headers. Please note that
2080 * if **skb_is_gso**\ (*skb*) is true, no more than two
2081 * headers can be prepended, and the inner header, if
2082 * present, should be either GRE or UDP/GUE.
2083 *
2084 * **BPF_LWT_ENCAP_SEG6**\ \* types can be called by BPF programs
2085 * of type **BPF_PROG_TYPE_LWT_IN**; **BPF_LWT_ENCAP_IP** type can
2086 * be called by bpf programs of types **BPF_PROG_TYPE_LWT_IN** and
2087 * **BPF_PROG_TYPE_LWT_XMIT**.
2088 *
2089 * A call to this helper is susceptible to change the underlying
c99a84ea
MX
2090 * packet buffer. Therefore, at load time, all checks on pointers
2091 * previously done by the verifier are invalidated and must be
2092 * performed again, if the helper is used in combination with
2093 * direct packet access.
2094 * Return
2095 * 0 on success, or a negative error in case of failure.
2096 *
2097 * int bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len)
2098 * Description
2099 * Store *len* bytes from address *from* into the packet
2100 * associated to *skb*, at *offset*. Only the flags, tag and TLVs
2101 * inside the outermost IPv6 Segment Routing Header can be
2102 * modified through this helper.
2103 *
c1fe1e70 2104 * A call to this helper is susceptible to change the underlying
c99a84ea
MX
2105 * packet buffer. Therefore, at load time, all checks on pointers
2106 * previously done by the verifier are invalidated and must be
2107 * performed again, if the helper is used in combination with
2108 * direct packet access.
2109 * Return
2110 * 0 on success, or a negative error in case of failure.
2111 *
2112 * int bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta)
2113 * Description
2114 * Adjust the size allocated to TLVs in the outermost IPv6
2115 * Segment Routing Header contained in the packet associated to
2116 * *skb*, at position *offset* by *delta* bytes. Only offsets
2117 * after the segments are accepted. *delta* can be as well
2118 * positive (growing) as negative (shrinking).
2119 *
c1fe1e70 2120 * A call to this helper is susceptible to change the underlying
c99a84ea
MX
2121 * packet buffer. Therefore, at load time, all checks on pointers
2122 * previously done by the verifier are invalidated and must be
2123 * performed again, if the helper is used in combination with
2124 * direct packet access.
2125 * Return
2126 * 0 on success, or a negative error in case of failure.
2127 *
2128 * int bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len)
2129 * Description
2130 * Apply an IPv6 Segment Routing action of type *action* to the
2131 * packet associated to *skb*. Each action takes a parameter
2132 * contained at address *param*, and of length *param_len* bytes.
2133 * *action* can be one of:
2134 *
2135 * **SEG6_LOCAL_ACTION_END_X**
2136 * End.X action: Endpoint with Layer-3 cross-connect.
2137 * Type of *param*: **struct in6_addr**.
2138 * **SEG6_LOCAL_ACTION_END_T**
2139 * End.T action: Endpoint with specific IPv6 table lookup.
2140 * Type of *param*: **int**.
2141 * **SEG6_LOCAL_ACTION_END_B6**
2142 * End.B6 action: Endpoint bound to an SRv6 policy.
c1fe1e70 2143 * Type of *param*: **struct ipv6_sr_hdr**.
c99a84ea
MX
2144 * **SEG6_LOCAL_ACTION_END_B6_ENCAP**
2145 * End.B6.Encap action: Endpoint bound to an SRv6
2146 * encapsulation policy.
c1fe1e70 2147 * Type of *param*: **struct ipv6_sr_hdr**.
c99a84ea 2148 *
c1fe1e70 2149 * A call to this helper is susceptible to change the underlying
c99a84ea
MX
2150 * packet buffer. Therefore, at load time, all checks on pointers
2151 * previously done by the verifier are invalidated and must be
2152 * performed again, if the helper is used in combination with
2153 * direct packet access.
2154 * Return
2155 * 0 on success, or a negative error in case of failure.
6bdd533c 2156 *
ea6eced0 2157 * int bpf_rc_repeat(void *ctx)
6bdd533c
SY
2158 * Description
2159 * This helper is used in programs implementing IR decoding, to
ea6eced0
QM
2160 * report a successfully decoded repeat key message. This delays
2161 * the generation of a key up event for previously generated
2162 * key down event.
6bdd533c 2163 *
ea6eced0
QM
2164 * Some IR protocols like NEC have a special IR message for
2165 * repeating last button, for when a button is held down.
6bdd533c
SY
2166 *
2167 * The *ctx* should point to the lirc sample as passed into
2168 * the program.
2169 *
6bdd533c
SY
2170 * This helper is only available is the kernel was compiled with
2171 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2172 * "**y**".
6bdd533c
SY
2173 * Return
2174 * 0
2175 *
ea6eced0 2176 * int bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle)
6bdd533c
SY
2177 * Description
2178 * This helper is used in programs implementing IR decoding, to
ea6eced0
QM
2179 * report a successfully decoded key press with *scancode*,
2180 * *toggle* value in the given *protocol*. The scancode will be
2181 * translated to a keycode using the rc keymap, and reported as
2182 * an input key down event. After a period a key up event is
2183 * generated. This period can be extended by calling either
2184 * **bpf_rc_keydown**\ () again with the same values, or calling
2185 * **bpf_rc_repeat**\ ().
6bdd533c 2186 *
ea6eced0
QM
2187 * Some protocols include a toggle bit, in case the button was
2188 * released and pressed again between consecutive scancodes.
6bdd533c
SY
2189 *
2190 * The *ctx* should point to the lirc sample as passed into
2191 * the program.
2192 *
ea6eced0
QM
2193 * The *protocol* is the decoded protocol number (see
2194 * **enum rc_proto** for some predefined values).
2195 *
6bdd533c
SY
2196 * This helper is only available is the kernel was compiled with
2197 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2198 * "**y**".
6bdd533c
SY
2199 * Return
2200 * 0
6b6a1925 2201 *
ea6eced0 2202 * u64 bpf_skb_cgroup_id(struct sk_buff *skb)
6b6a1925
DB
2203 * Description
2204 * Return the cgroup v2 id of the socket associated with the *skb*.
2205 * This is roughly similar to the **bpf_get_cgroup_classid**\ ()
2206 * helper for cgroup v1 by providing a tag resp. identifier that
2207 * can be matched on or used for map lookups e.g. to implement
2208 * policy. The cgroup v2 id of a given path in the hierarchy is
2209 * exposed in user space through the f_handle API in order to get
2210 * to the same 64-bit id.
2211 *
2212 * This helper can be used on TC egress path, but not on ingress,
2213 * and is available only if the kernel was compiled with the
2214 * **CONFIG_SOCK_CGROUP_DATA** configuration option.
2215 * Return
2216 * The id is returned or 0 in case the id could not be retrieved.
c7ddbbaf
YS
2217 *
2218 * u64 bpf_get_current_cgroup_id(void)
2219 * Return
2220 * A 64-bit integer containing the current cgroup id based
2221 * on the cgroup within which the current task is running.
c419cf52 2222 *
ea6eced0 2223 * void *bpf_get_local_storage(void *map, u64 flags)
c419cf52
RG
2224 * Description
2225 * Get the pointer to the local storage area.
2226 * The type and the size of the local storage is defined
2227 * by the *map* argument.
2228 * The *flags* meaning is specific for each map type,
2229 * and has to be 0 for cgroup local storage.
2230 *
0bd72117
DB
2231 * Depending on the BPF program type, a local storage area
2232 * can be shared between multiple instances of the BPF program,
c419cf52
RG
2233 * running simultaneously.
2234 *
2235 * A user should care about the synchronization by himself.
0bd72117 2236 * For example, by using the **BPF_STX_XADD** instruction to alter
c419cf52
RG
2237 * the shared data.
2238 * Return
0bd72117 2239 * A pointer to the local storage area.
3bd43a8c
MKL
2240 *
2241 * int bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags)
2242 * Description
0bd72117
DB
2243 * Select a **SO_REUSEPORT** socket from a
2244 * **BPF_MAP_TYPE_REUSEPORT_ARRAY** *map*.
2245 * It checks the selected socket is matching the incoming
2246 * request in the socket buffer.
3bd43a8c
MKL
2247 * Return
2248 * 0 on success, or a negative error in case of failure.
6acc9b43 2249 *
ea6eced0
QM
2250 * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level)
2251 * Description
2252 * Return id of cgroup v2 that is ancestor of cgroup associated
2253 * with the *skb* at the *ancestor_level*. The root cgroup is at
2254 * *ancestor_level* zero and each step down the hierarchy
2255 * increments the level. If *ancestor_level* == level of cgroup
2256 * associated with *skb*, then return value will be same as that
2257 * of **bpf_skb_cgroup_id**\ ().
2258 *
2259 * The helper is useful to implement policies based on cgroups
2260 * that are upper in hierarchy than immediate cgroup associated
2261 * with *skb*.
2262 *
2263 * The format of returned id and helper limitations are same as in
2264 * **bpf_skb_cgroup_id**\ ().
2265 * Return
2266 * The id is returned or 0 in case the id could not be retrieved.
2267 *
f71c6143 2268 * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
6acc9b43
JS
2269 * Description
2270 * Look for TCP socket matching *tuple*, optionally in a child
2271 * network namespace *netns*. The return value must be checked,
0bd72117 2272 * and if non-**NULL**, released via **bpf_sk_release**\ ().
6acc9b43
JS
2273 *
2274 * The *ctx* should point to the context of the program, such as
2275 * the skb or socket (depending on the hook in use). This is used
2276 * to determine the base network namespace for the lookup.
2277 *
2278 * *tuple_size* must be one of:
2279 *
2280 * **sizeof**\ (*tuple*\ **->ipv4**)
2281 * Look for an IPv4 socket.
2282 * **sizeof**\ (*tuple*\ **->ipv6**)
2283 * Look for an IPv6 socket.
2284 *
f71c6143
JS
2285 * If the *netns* is a negative signed 32-bit integer, then the
2286 * socket lookup table in the netns associated with the *ctx* will
2287 * will be used. For the TC hooks, this is the netns of the device
2288 * in the skb. For socket hooks, this is the netns of the socket.
2289 * If *netns* is any other signed 32-bit value greater than or
2290 * equal to zero then it specifies the ID of the netns relative to
2291 * the netns associated with the *ctx*. *netns* values beyond the
2292 * range of 32-bit integers are reserved for future use.
6acc9b43
JS
2293 *
2294 * All values for *flags* are reserved for future usage, and must
2295 * be left at zero.
2296 *
2297 * This helper is available only if the kernel was compiled with
2298 * **CONFIG_NET** configuration option.
2299 * Return
0bd72117
DB
2300 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
2301 * For sockets with reuseport option, the **struct bpf_sock**
c1fe1e70
QM
2302 * result is from *reuse*\ **->socks**\ [] using the hash of the
2303 * tuple.
6acc9b43 2304 *
f71c6143 2305 * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
6acc9b43
JS
2306 * Description
2307 * Look for UDP socket matching *tuple*, optionally in a child
2308 * network namespace *netns*. The return value must be checked,
0bd72117 2309 * and if non-**NULL**, released via **bpf_sk_release**\ ().
6acc9b43
JS
2310 *
2311 * The *ctx* should point to the context of the program, such as
2312 * the skb or socket (depending on the hook in use). This is used
2313 * to determine the base network namespace for the lookup.
2314 *
2315 * *tuple_size* must be one of:
2316 *
2317 * **sizeof**\ (*tuple*\ **->ipv4**)
2318 * Look for an IPv4 socket.
2319 * **sizeof**\ (*tuple*\ **->ipv6**)
2320 * Look for an IPv6 socket.
2321 *
f71c6143
JS
2322 * If the *netns* is a negative signed 32-bit integer, then the
2323 * socket lookup table in the netns associated with the *ctx* will
2324 * will be used. For the TC hooks, this is the netns of the device
2325 * in the skb. For socket hooks, this is the netns of the socket.
2326 * If *netns* is any other signed 32-bit value greater than or
2327 * equal to zero then it specifies the ID of the netns relative to
2328 * the netns associated with the *ctx*. *netns* values beyond the
2329 * range of 32-bit integers are reserved for future use.
6acc9b43
JS
2330 *
2331 * All values for *flags* are reserved for future usage, and must
2332 * be left at zero.
2333 *
2334 * This helper is available only if the kernel was compiled with
2335 * **CONFIG_NET** configuration option.
2336 * Return
0bd72117
DB
2337 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
2338 * For sockets with reuseport option, the **struct bpf_sock**
c1fe1e70
QM
2339 * result is from *reuse*\ **->socks**\ [] using the hash of the
2340 * tuple.
6acc9b43 2341 *
0bd72117 2342 * int bpf_sk_release(struct bpf_sock *sock)
6acc9b43 2343 * Description
0bd72117
DB
2344 * Release the reference held by *sock*. *sock* must be a
2345 * non-**NULL** pointer that was returned from
2346 * **bpf_sk_lookup_xxx**\ ().
6acc9b43
JS
2347 * Return
2348 * 0 on success, or a negative error in case of failure.
f908d26b 2349 *
ea6eced0
QM
2350 * int bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags)
2351 * Description
2352 * Push an element *value* in *map*. *flags* is one of:
2353 *
2354 * **BPF_EXIST**
2355 * If the queue/stack is full, the oldest element is
2356 * removed to make room for this.
2357 * Return
2358 * 0 on success, or a negative error in case of failure.
2359 *
0bd72117
DB
2360 * int bpf_map_pop_elem(struct bpf_map *map, void *value)
2361 * Description
2362 * Pop an element from *map*.
2363 * Return
2364 * 0 on success, or a negative error in case of failure.
2365 *
2366 * int bpf_map_peek_elem(struct bpf_map *map, void *value)
2367 * Description
2368 * Get an element from *map* without removing it.
2369 * Return
2370 * 0 on success, or a negative error in case of failure.
2371 *
5f0e5412 2372 * int bpf_msg_push_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags)
f908d26b 2373 * Description
0bd72117 2374 * For socket policies, insert *len* bytes into *msg* at offset
f908d26b
JF
2375 * *start*.
2376 *
2377 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
0bd72117 2378 * *msg* it may want to insert metadata or options into the *msg*.
f908d26b
JF
2379 * This can later be read and used by any of the lower layer BPF
2380 * hooks.
2381 *
2382 * This helper may fail if under memory pressure (a malloc
2383 * fails) in these cases BPF programs will get an appropriate
2384 * error and BPF programs will need to handle them.
f908d26b
JF
2385 * Return
2386 * 0 on success, or a negative error in case of failure.
d913a227 2387 *
5f0e5412 2388 * int bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags)
0bd72117 2389 * Description
5f0e5412 2390 * Will remove *len* bytes from a *msg* starting at byte *start*.
d913a227
JF
2391 * This may result in **ENOMEM** errors under certain situations if
2392 * an allocation and copy are required due to a full ring buffer.
2393 * However, the helper will try to avoid doing the allocation
2394 * if possible. Other errors can occur if input parameters are
0bd72117 2395 * invalid either due to *start* byte not being valid part of *msg*
d913a227 2396 * payload and/or *pop* value being to large.
01d3240a
SY
2397 * Return
2398 * 0 on success, or a negative error in case of failure.
2399 *
2400 * int bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y)
2401 * Description
2402 * This helper is used in programs implementing IR decoding, to
2403 * report a successfully decoded pointer movement.
2404 *
2405 * The *ctx* should point to the lirc sample as passed into
2406 * the program.
d913a227 2407 *
01d3240a
SY
2408 * This helper is only available is the kernel was compiled with
2409 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2410 * "**y**".
d913a227 2411 * Return
01d3240a 2412 * 0
281f9e75 2413 *
ea6eced0
QM
2414 * int bpf_spin_lock(struct bpf_spin_lock *lock)
2415 * Description
2416 * Acquire a spinlock represented by the pointer *lock*, which is
2417 * stored as part of a value of a map. Taking the lock allows to
2418 * safely update the rest of the fields in that value. The
2419 * spinlock can (and must) later be released with a call to
2420 * **bpf_spin_unlock**\ (\ *lock*\ ).
2421 *
2422 * Spinlocks in BPF programs come with a number of restrictions
2423 * and constraints:
2424 *
2425 * * **bpf_spin_lock** objects are only allowed inside maps of
2426 * types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this
2427 * list could be extended in the future).
2428 * * BTF description of the map is mandatory.
2429 * * The BPF program can take ONE lock at a time, since taking two
2430 * or more could cause dead locks.
2431 * * Only one **struct bpf_spin_lock** is allowed per map element.
2432 * * When the lock is taken, calls (either BPF to BPF or helpers)
2433 * are not allowed.
2434 * * The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not
2435 * allowed inside a spinlock-ed region.
2436 * * The BPF program MUST call **bpf_spin_unlock**\ () to release
2437 * the lock, on all execution paths, before it returns.
2438 * * The BPF program can access **struct bpf_spin_lock** only via
2439 * the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ ()
2440 * helpers. Loading or storing data into the **struct
2441 * bpf_spin_lock** *lock*\ **;** field of a map is not allowed.
2442 * * To use the **bpf_spin_lock**\ () helper, the BTF description
2443 * of the map value must be a struct and have **struct
2444 * bpf_spin_lock** *anyname*\ **;** field at the top level.
2445 * Nested lock inside another struct is not allowed.
2446 * * The **struct bpf_spin_lock** *lock* field in a map value must
2447 * be aligned on a multiple of 4 bytes in that value.
2448 * * Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy
2449 * the **bpf_spin_lock** field to user space.
2450 * * Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from
2451 * a BPF program, do not update the **bpf_spin_lock** field.
2452 * * **bpf_spin_lock** cannot be on the stack or inside a
2453 * networking packet (it can only be inside of a map values).
2454 * * **bpf_spin_lock** is available to root only.
2455 * * Tracing programs and socket filter programs cannot use
2456 * **bpf_spin_lock**\ () due to insufficient preemption checks
2457 * (but this may change in the future).
2458 * * **bpf_spin_lock** is not allowed in inner maps of map-in-map.
2459 * Return
2460 * 0
2461 *
2462 * int bpf_spin_unlock(struct bpf_spin_lock *lock)
2463 * Description
2464 * Release the *lock* previously locked by a call to
2465 * **bpf_spin_lock**\ (\ *lock*\ ).
2466 * Return
2467 * 0
2468 *
281f9e75
MKL
2469 * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk)
2470 * Description
2471 * This helper gets a **struct bpf_sock** pointer such
ea6eced0 2472 * that all the fields in this **bpf_sock** can be accessed.
281f9e75 2473 * Return
ea6eced0 2474 * A **struct bpf_sock** pointer on success, or **NULL** in
281f9e75
MKL
2475 * case of failure.
2476 *
2477 * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk)
2478 * Description
2479 * This helper gets a **struct bpf_tcp_sock** pointer from a
2480 * **struct bpf_sock** pointer.
281f9e75 2481 * Return
ea6eced0 2482 * A **struct bpf_tcp_sock** pointer on success, or **NULL** in
281f9e75 2483 * case of failure.
5cce85c6 2484 *
5f0e5412 2485 * int bpf_skb_ecn_set_ce(struct sk_buff *skb)
ea6eced0
QM
2486 * Description
2487 * Set ECN (Explicit Congestion Notification) field of IP header
2488 * to **CE** (Congestion Encountered) if current value is **ECT**
2489 * (ECN Capable Transport). Otherwise, do nothing. Works with IPv6
2490 * and IPv4.
2491 * Return
2492 * 1 if the **CE** flag is set (either by the current helper call
2493 * or because it was already present), 0 if it is not set.
ef776a27
MKL
2494 *
2495 * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk)
2496 * Description
ea6eced0
QM
2497 * Return a **struct bpf_sock** pointer in **TCP_LISTEN** state.
2498 * **bpf_sk_release**\ () is unnecessary and not allowed.
ef776a27 2499 * Return
ea6eced0 2500 * A **struct bpf_sock** pointer on success, or **NULL** in
ef776a27 2501 * case of failure.
253c8dde
LB
2502 *
2503 * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
2504 * Description
2505 * Look for TCP socket matching *tuple*, optionally in a child
2506 * network namespace *netns*. The return value must be checked,
2507 * and if non-**NULL**, released via **bpf_sk_release**\ ().
2508 *
c1fe1e70
QM
2509 * This function is identical to **bpf_sk_lookup_tcp**\ (), except
2510 * that it also returns timewait or request sockets. Use
2511 * **bpf_sk_fullsock**\ () or **bpf_tcp_sock**\ () to access the
2512 * full structure.
253c8dde
LB
2513 *
2514 * This helper is available only if the kernel was compiled with
2515 * **CONFIG_NET** configuration option.
2516 * Return
2517 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
2518 * For sockets with reuseport option, the **struct bpf_sock**
c1fe1e70
QM
2519 * result is from *reuse*\ **->socks**\ [] using the hash of the
2520 * tuple.
253c8dde
LB
2521 *
2522 * int bpf_tcp_check_syncookie(struct bpf_sock *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
2523 * Description
c1fe1e70
QM
2524 * Check whether *iph* and *th* contain a valid SYN cookie ACK for
2525 * the listening socket in *sk*.
253c8dde 2526 *
c1fe1e70
QM
2527 * *iph* points to the start of the IPv4 or IPv6 header, while
2528 * *iph_len* contains **sizeof**\ (**struct iphdr**) or
2529 * **sizeof**\ (**struct ip6hdr**).
253c8dde 2530 *
c1fe1e70
QM
2531 * *th* points to the start of the TCP header, while *th_len*
2532 * contains **sizeof**\ (**struct tcphdr**).
253c8dde
LB
2533 *
2534 * Return
c1fe1e70
QM
2535 * 0 if *iph* and *th* are a valid SYN cookie ACK, or a negative
2536 * error otherwise.
196398d4
AI
2537 *
2538 * int bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags)
2539 * Description
2540 * Get name of sysctl in /proc/sys/ and copy it into provided by
2541 * program buffer *buf* of size *buf_len*.
2542 *
2543 * The buffer is always NUL terminated, unless it's zero-sized.
2544 *
2545 * If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is
2546 * copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name
2547 * only (e.g. "tcp_mem").
2548 * Return
2549 * Number of character copied (not including the trailing NUL).
2550 *
2551 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
2552 * truncated name in this case).
2553 *
2554 * int bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
2555 * Description
2556 * Get current value of sysctl as it is presented in /proc/sys
2557 * (incl. newline, etc), and copy it as a string into provided
2558 * by program buffer *buf* of size *buf_len*.
2559 *
2560 * The whole value is copied, no matter what file position user
2561 * space issued e.g. sys_read at.
2562 *
2563 * The buffer is always NUL terminated, unless it's zero-sized.
2564 * Return
2565 * Number of character copied (not including the trailing NUL).
2566 *
2567 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
2568 * truncated name in this case).
2569 *
2570 * **-EINVAL** if current value was unavailable, e.g. because
2571 * sysctl is uninitialized and read returns -EIO for it.
2572 *
2573 * int bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
2574 * Description
2575 * Get new value being written by user space to sysctl (before
2576 * the actual write happens) and copy it as a string into
2577 * provided by program buffer *buf* of size *buf_len*.
2578 *
2579 * User space may write new value at file position > 0.
2580 *
2581 * The buffer is always NUL terminated, unless it's zero-sized.
2582 * Return
2583 * Number of character copied (not including the trailing NUL).
2584 *
2585 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
2586 * truncated name in this case).
2587 *
2588 * **-EINVAL** if sysctl is being read.
2589 *
2590 * int bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len)
2591 * Description
2592 * Override new value being written by user space to sysctl with
2593 * value provided by program in buffer *buf* of size *buf_len*.
2594 *
2595 * *buf* should contain a string in same form as provided by user
2596 * space on sysctl write.
2597 *
2598 * User space may write new value at file position > 0. To override
2599 * the whole sysctl value file position should be set to zero.
2600 * Return
2601 * 0 on success.
2602 *
2603 * **-E2BIG** if the *buf_len* is too big.
2604 *
2605 * **-EINVAL** if sysctl is being read.
b457e553
AI
2606 *
2607 * int bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res)
2608 * Description
2609 * Convert the initial part of the string from buffer *buf* of
2610 * size *buf_len* to a long integer according to the given base
2611 * and save the result in *res*.
2612 *
2613 * The string may begin with an arbitrary amount of white space
c1fe1e70
QM
2614 * (as determined by **isspace**\ (3)) followed by a single
2615 * optional '**-**' sign.
b457e553
AI
2616 *
2617 * Five least significant bits of *flags* encode base, other bits
2618 * are currently unused.
2619 *
2620 * Base must be either 8, 10, 16 or 0 to detect it automatically
c1fe1e70 2621 * similar to user space **strtol**\ (3).
b457e553
AI
2622 * Return
2623 * Number of characters consumed on success. Must be positive but
c1fe1e70 2624 * no more than *buf_len*.
b457e553
AI
2625 *
2626 * **-EINVAL** if no valid digits were found or unsupported base
2627 * was provided.
2628 *
2629 * **-ERANGE** if resulting value was out of range.
2630 *
2631 * int bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res)
2632 * Description
2633 * Convert the initial part of the string from buffer *buf* of
2634 * size *buf_len* to an unsigned long integer according to the
2635 * given base and save the result in *res*.
2636 *
2637 * The string may begin with an arbitrary amount of white space
c1fe1e70 2638 * (as determined by **isspace**\ (3)).
b457e553
AI
2639 *
2640 * Five least significant bits of *flags* encode base, other bits
2641 * are currently unused.
2642 *
2643 * Base must be either 8, 10, 16 or 0 to detect it automatically
c1fe1e70 2644 * similar to user space **strtoul**\ (3).
b457e553
AI
2645 * Return
2646 * Number of characters consumed on success. Must be positive but
c1fe1e70 2647 * no more than *buf_len*.
b457e553
AI
2648 *
2649 * **-EINVAL** if no valid digits were found or unsupported base
2650 * was provided.
2651 *
2652 * **-ERANGE** if resulting value was out of range.
948d930e
MKL
2653 *
2654 * void *bpf_sk_storage_get(struct bpf_map *map, struct bpf_sock *sk, void *value, u64 flags)
2655 * Description
c1fe1e70 2656 * Get a bpf-local-storage from a *sk*.
948d930e
MKL
2657 *
2658 * Logically, it could be thought of getting the value from
2659 * a *map* with *sk* as the **key**. From this
2660 * perspective, the usage is not much different from
c1fe1e70
QM
2661 * **bpf_map_lookup_elem**\ (*map*, **&**\ *sk*) except this
2662 * helper enforces the key must be a full socket and the map must
2663 * be a **BPF_MAP_TYPE_SK_STORAGE** also.
948d930e
MKL
2664 *
2665 * Underneath, the value is stored locally at *sk* instead of
c1fe1e70
QM
2666 * the *map*. The *map* is used as the bpf-local-storage
2667 * "type". The bpf-local-storage "type" (i.e. the *map*) is
2668 * searched against all bpf-local-storages residing at *sk*.
948d930e 2669 *
c1fe1e70 2670 * An optional *flags* (**BPF_SK_STORAGE_GET_F_CREATE**) can be
948d930e
MKL
2671 * used such that a new bpf-local-storage will be
2672 * created if one does not exist. *value* can be used
c1fe1e70 2673 * together with **BPF_SK_STORAGE_GET_F_CREATE** to specify
948d930e 2674 * the initial value of a bpf-local-storage. If *value* is
c1fe1e70 2675 * **NULL**, the new bpf-local-storage will be zero initialized.
948d930e
MKL
2676 * Return
2677 * A bpf-local-storage pointer is returned on success.
2678 *
2679 * **NULL** if not found or there was an error in adding
2680 * a new bpf-local-storage.
2681 *
2682 * int bpf_sk_storage_delete(struct bpf_map *map, struct bpf_sock *sk)
2683 * Description
c1fe1e70 2684 * Delete a bpf-local-storage from a *sk*.
948d930e
MKL
2685 * Return
2686 * 0 on success.
2687 *
2688 * **-ENOENT** if the bpf-local-storage cannot be found.
edaccf89
YS
2689 *
2690 * int bpf_send_signal(u32 sig)
2691 * Description
2692 * Send signal *sig* to the current task.
2693 * Return
2694 * 0 on success or successfully queued.
2695 *
2696 * **-EBUSY** if work queue under nmi is full.
2697 *
2698 * **-EINVAL** if *sig* is invalid.
2699 *
2700 * **-EPERM** if no permission to send the *sig*.
2701 *
2702 * **-EAGAIN** if bpf program can try again.
3745ee18
PP
2703 *
2704 * s64 bpf_tcp_gen_syncookie(struct bpf_sock *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
2705 * Description
2706 * Try to issue a SYN cookie for the packet with corresponding
2707 * IP/TCP headers, *iph* and *th*, on the listening socket in *sk*.
2708 *
2709 * *iph* points to the start of the IPv4 or IPv6 header, while
2710 * *iph_len* contains **sizeof**\ (**struct iphdr**) or
2711 * **sizeof**\ (**struct ip6hdr**).
2712 *
2713 * *th* points to the start of the TCP header, while *th_len*
2714 * contains the length of the TCP header.
2715 *
2716 * Return
2717 * On success, lower 32 bits hold the generated SYN cookie in
2718 * followed by 16 bits which hold the MSS value for that cookie,
2719 * and the top 16 bits are unused.
2720 *
2721 * On failure, the returned value is one of the following:
2722 *
2723 * **-EINVAL** SYN cookie cannot be issued due to error
2724 *
2725 * **-ENOENT** SYN cookie should not be issued (no SYN flood)
2726 *
2727 * **-EOPNOTSUPP** kernel configuration does not enable SYN cookies
2728 *
2729 * **-EPROTONOSUPPORT** IP packet version is not 4 or 6
a7658e1a
AS
2730 *
2731 * int bpf_skb_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
2732 * Description
2733 * Write raw *data* blob into a special BPF perf event held by
2734 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
2735 * event must have the following attributes: **PERF_SAMPLE_RAW**
2736 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
2737 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
2738 *
2739 * The *flags* are used to indicate the index in *map* for which
2740 * the value must be put, masked with **BPF_F_INDEX_MASK**.
2741 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
2742 * to indicate that the index of the current CPU core should be
2743 * used.
2744 *
2745 * The value to write, of *size*, is passed through eBPF stack and
2746 * pointed by *data*.
2747 *
2748 * *ctx* is a pointer to in-kernel struct sk_buff.
2749 *
2750 * This helper is similar to **bpf_perf_event_output**\ () but
2751 * restricted to raw_tracepoint bpf programs.
2752 * Return
2753 * 0 on success, or a negative error in case of failure.
6ae08ae3
DB
2754 *
2755 * int bpf_probe_read_user(void *dst, u32 size, const void *unsafe_ptr)
2756 * Description
2757 * Safely attempt to read *size* bytes from user space address
2758 * *unsafe_ptr* and store the data in *dst*.
2759 * Return
2760 * 0 on success, or a negative error in case of failure.
2761 *
2762 * int bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr)
2763 * Description
2764 * Safely attempt to read *size* bytes from kernel space address
2765 * *unsafe_ptr* and store the data in *dst*.
2766 * Return
2767 * 0 on success, or a negative error in case of failure.
2768 *
2769 * int bpf_probe_read_user_str(void *dst, u32 size, const void *unsafe_ptr)
2770 * Description
2771 * Copy a NUL terminated string from an unsafe user address
2772 * *unsafe_ptr* to *dst*. The *size* should include the
2773 * terminating NUL byte. In case the string length is smaller than
2774 * *size*, the target is not padded with further NUL bytes. If the
2775 * string length is larger than *size*, just *size*-1 bytes are
2776 * copied and the last byte is set to NUL.
2777 *
2778 * On success, the length of the copied string is returned. This
2779 * makes this helper useful in tracing programs for reading
2780 * strings, and more importantly to get its length at runtime. See
2781 * the following snippet:
2782 *
2783 * ::
2784 *
2785 * SEC("kprobe/sys_open")
2786 * void bpf_sys_open(struct pt_regs *ctx)
2787 * {
2788 * char buf[PATHLEN]; // PATHLEN is defined to 256
2789 * int res = bpf_probe_read_user_str(buf, sizeof(buf),
2790 * ctx->di);
2791 *
2792 * // Consume buf, for example push it to
2793 * // userspace via bpf_perf_event_output(); we
2794 * // can use res (the string length) as event
2795 * // size, after checking its boundaries.
2796 * }
2797 *
2798 * In comparison, using **bpf_probe_read_user()** helper here
2799 * instead to read the string would require to estimate the length
2800 * at compile time, and would often result in copying more memory
2801 * than necessary.
2802 *
2803 * Another useful use case is when parsing individual process
2804 * arguments or individual environment variables navigating
2805 * *current*\ **->mm->arg_start** and *current*\
2806 * **->mm->env_start**: using this helper and the return value,
2807 * one can quickly iterate at the right offset of the memory area.
2808 * Return
2809 * On success, the strictly positive length of the string,
2810 * including the trailing NUL character. On error, a negative
2811 * value.
2812 *
2813 * int bpf_probe_read_kernel_str(void *dst, u32 size, const void *unsafe_ptr)
2814 * Description
2815 * Copy a NUL terminated string from an unsafe kernel address *unsafe_ptr*
2816 * to *dst*. Same semantics as with bpf_probe_read_user_str() apply.
2817 * Return
2818 * On success, the strictly positive length of the string, including
2819 * the trailing NUL character. On error, a negative value.
0cb34dc2
JS
2820 */
2821#define __BPF_FUNC_MAPPER(FN) \
2822 FN(unspec), \
2823 FN(map_lookup_elem), \
2824 FN(map_update_elem), \
2825 FN(map_delete_elem), \
2826 FN(probe_read), \
2827 FN(ktime_get_ns), \
2828 FN(trace_printk), \
2829 FN(get_prandom_u32), \
2830 FN(get_smp_processor_id), \
2831 FN(skb_store_bytes), \
2832 FN(l3_csum_replace), \
2833 FN(l4_csum_replace), \
2834 FN(tail_call), \
2835 FN(clone_redirect), \
2836 FN(get_current_pid_tgid), \
2837 FN(get_current_uid_gid), \
2838 FN(get_current_comm), \
2839 FN(get_cgroup_classid), \
2840 FN(skb_vlan_push), \
2841 FN(skb_vlan_pop), \
2842 FN(skb_get_tunnel_key), \
2843 FN(skb_set_tunnel_key), \
2844 FN(perf_event_read), \
2845 FN(redirect), \
2846 FN(get_route_realm), \
2847 FN(perf_event_output), \
2848 FN(skb_load_bytes), \
2849 FN(get_stackid), \
2850 FN(csum_diff), \
2851 FN(skb_get_tunnel_opt), \
2852 FN(skb_set_tunnel_opt), \
2853 FN(skb_change_proto), \
2854 FN(skb_change_type), \
2855 FN(skb_under_cgroup), \
2856 FN(get_hash_recalc), \
2857 FN(get_current_task), \
2858 FN(probe_write_user), \
2859 FN(current_task_under_cgroup), \
2860 FN(skb_change_tail), \
2861 FN(skb_pull_data), \
2862 FN(csum_update), \
2863 FN(set_hash_invalid), \
2864 FN(get_numa_node_id), \
2865 FN(skb_change_head), \
9a738266 2866 FN(xdp_adjust_head), \
91b8270f 2867 FN(probe_read_str), \
6acc5c29 2868 FN(get_socket_cookie), \
ded092cd 2869 FN(get_socket_uid), \
04df41e3 2870 FN(set_hash), \
2be7e212 2871 FN(setsockopt), \
996139e8 2872 FN(skb_adjust_room), \
69e8cc13
JF
2873 FN(redirect_map), \
2874 FN(sk_redirect_map), \
ac29991b 2875 FN(sock_map_update), \
020a32d9 2876 FN(xdp_adjust_meta), \
81b9cf80 2877 FN(perf_event_read_value), \
e27afb84 2878 FN(perf_prog_read_value), \
965de87e 2879 FN(getsockopt), \
d6d4f60c 2880 FN(override_return), \
4c4c3c27
JF
2881 FN(sock_ops_cb_flags_set), \
2882 FN(msg_redirect_map), \
468b3fde 2883 FN(msg_apply_bytes), \
0dcbbf67 2884 FN(msg_cork_bytes), \
622adafb 2885 FN(msg_pull_data), \
0367d0a2 2886 FN(bind), \
29a36f9e 2887 FN(xdp_adjust_tail), \
de2ff05f 2888 FN(skb_get_xfrm_state), \
32b3652c 2889 FN(get_stack), \
cb9c28ef 2890 FN(skb_load_bytes_relative), \
b8b394fa
JF
2891 FN(fib_lookup), \
2892 FN(sock_hash_update), \
2893 FN(msg_redirect_hash), \
c99a84ea
MX
2894 FN(sk_redirect_hash), \
2895 FN(lwt_push_encap), \
2896 FN(lwt_seg6_store_bytes), \
2897 FN(lwt_seg6_adjust_srh), \
6bdd533c
SY
2898 FN(lwt_seg6_action), \
2899 FN(rc_repeat), \
6b6a1925 2900 FN(rc_keydown), \
c7ddbbaf 2901 FN(skb_cgroup_id), \
c419cf52 2902 FN(get_current_cgroup_id), \
3bd43a8c 2903 FN(get_local_storage), \
539764d0 2904 FN(sk_select_reuseport), \
6acc9b43
JS
2905 FN(skb_ancestor_cgroup_id), \
2906 FN(sk_lookup_tcp), \
2907 FN(sk_lookup_udp), \
da4e1b15
MV
2908 FN(sk_release), \
2909 FN(map_push_elem), \
2910 FN(map_pop_elem), \
f908d26b 2911 FN(map_peek_elem), \
d913a227 2912 FN(msg_push_data), \
01d3240a 2913 FN(msg_pop_data), \
7dac3ae4
AS
2914 FN(rc_pointer_rel), \
2915 FN(spin_lock), \
281f9e75
MKL
2916 FN(spin_unlock), \
2917 FN(sk_fullsock), \
5cce85c6 2918 FN(tcp_sock), \
ef776a27 2919 FN(skb_ecn_set_ce), \
253c8dde
LB
2920 FN(get_listener_sock), \
2921 FN(skc_lookup_tcp), \
196398d4
AI
2922 FN(tcp_check_syncookie), \
2923 FN(sysctl_get_name), \
2924 FN(sysctl_get_current_value), \
2925 FN(sysctl_get_new_value), \
b457e553
AI
2926 FN(sysctl_set_new_value), \
2927 FN(strtol), \
948d930e
MKL
2928 FN(strtoul), \
2929 FN(sk_storage_get), \
edaccf89 2930 FN(sk_storage_delete), \
3745ee18 2931 FN(send_signal), \
a7658e1a 2932 FN(tcp_gen_syncookie), \
6ae08ae3
DB
2933 FN(skb_output), \
2934 FN(probe_read_user), \
2935 FN(probe_read_kernel), \
2936 FN(probe_read_user_str), \
2937 FN(probe_read_kernel_str),
0cb34dc2 2938
971e827b
ACM
2939/* integer value in 'imm' field of BPF_CALL instruction selects which helper
2940 * function eBPF program intends to call
2941 */
0cb34dc2 2942#define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
971e827b 2943enum bpf_func_id {
0cb34dc2 2944 __BPF_FUNC_MAPPER(__BPF_ENUM_FN)
971e827b
ACM
2945 __BPF_FUNC_MAX_ID,
2946};
0cb34dc2 2947#undef __BPF_ENUM_FN
971e827b
ACM
2948
2949/* All flags used by eBPF helper functions, placed here. */
2950
2951/* BPF_FUNC_skb_store_bytes flags. */
2952#define BPF_F_RECOMPUTE_CSUM (1ULL << 0)
2953#define BPF_F_INVALIDATE_HASH (1ULL << 1)
2954
2955/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
2956 * First 4 bits are for passing the header field size.
2957 */
2958#define BPF_F_HDR_FIELD_MASK 0xfULL
2959
2960/* BPF_FUNC_l4_csum_replace flags. */
2961#define BPF_F_PSEUDO_HDR (1ULL << 4)
2962#define BPF_F_MARK_MANGLED_0 (1ULL << 5)
9a738266 2963#define BPF_F_MARK_ENFORCE (1ULL << 6)
971e827b
ACM
2964
2965/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
2966#define BPF_F_INGRESS (1ULL << 0)
2967
2968/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
2969#define BPF_F_TUNINFO_IPV6 (1ULL << 0)
2970
de2ff05f 2971/* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */
971e827b
ACM
2972#define BPF_F_SKIP_FIELD_MASK 0xffULL
2973#define BPF_F_USER_STACK (1ULL << 8)
de2ff05f 2974/* flags used by BPF_FUNC_get_stackid only. */
971e827b
ACM
2975#define BPF_F_FAST_STACK_CMP (1ULL << 9)
2976#define BPF_F_REUSE_STACKID (1ULL << 10)
de2ff05f
YS
2977/* flags used by BPF_FUNC_get_stack only. */
2978#define BPF_F_USER_BUILD_ID (1ULL << 11)
971e827b
ACM
2979
2980/* BPF_FUNC_skb_set_tunnel_key flags. */
2981#define BPF_F_ZERO_CSUM_TX (1ULL << 1)
2982#define BPF_F_DONT_FRAGMENT (1ULL << 2)
16962b24 2983#define BPF_F_SEQ_NUMBER (1ULL << 3)
971e827b 2984
e27afb84
AS
2985/* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and
2986 * BPF_FUNC_perf_event_read_value flags.
2987 */
971e827b
ACM
2988#define BPF_F_INDEX_MASK 0xffffffffULL
2989#define BPF_F_CURRENT_CPU BPF_F_INDEX_MASK
791cceb8
ACM
2990/* BPF_FUNC_perf_event_output for sk_buff input context. */
2991#define BPF_F_CTXLEN_MASK (0xfffffULL << 32)
971e827b 2992
f71c6143
JS
2993/* Current network namespace */
2994#define BPF_F_CURRENT_NETNS (-1L)
2995
6c408dec
WB
2996/* BPF_FUNC_skb_adjust_room flags. */
2997#define BPF_F_ADJ_ROOM_FIXED_GSO (1ULL << 0)
2998
bfb35c27
AM
2999#define BPF_ADJ_ROOM_ENCAP_L2_MASK 0xff
3000#define BPF_ADJ_ROOM_ENCAP_L2_SHIFT 56
1db04c30 3001
6c408dec
WB
3002#define BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 (1ULL << 1)
3003#define BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 (1ULL << 2)
3004#define BPF_F_ADJ_ROOM_ENCAP_L4_GRE (1ULL << 3)
3005#define BPF_F_ADJ_ROOM_ENCAP_L4_UDP (1ULL << 4)
bfb35c27 3006#define BPF_F_ADJ_ROOM_ENCAP_L2(len) (((__u64)len & \
1db04c30
AM
3007 BPF_ADJ_ROOM_ENCAP_L2_MASK) \
3008 << BPF_ADJ_ROOM_ENCAP_L2_SHIFT)
6c408dec 3009
196398d4
AI
3010/* BPF_FUNC_sysctl_get_name flags. */
3011#define BPF_F_SYSCTL_BASE_NAME (1ULL << 0)
3012
948d930e
MKL
3013/* BPF_FUNC_sk_storage_get flags */
3014#define BPF_SK_STORAGE_GET_F_CREATE (1ULL << 0)
3015
2be7e212
DB
3016/* Mode for BPF_FUNC_skb_adjust_room helper. */
3017enum bpf_adj_room_mode {
d62c1d72 3018 BPF_ADJ_ROOM_NET,
6c408dec 3019 BPF_ADJ_ROOM_MAC,
2be7e212
DB
3020};
3021
32b3652c
DB
3022/* Mode for BPF_FUNC_skb_load_bytes_relative helper. */
3023enum bpf_hdr_start_off {
3024 BPF_HDR_START_MAC,
3025 BPF_HDR_START_NET,
3026};
3027
c99a84ea
MX
3028/* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */
3029enum bpf_lwt_encap_mode {
3030 BPF_LWT_ENCAP_SEG6,
755db477
PO
3031 BPF_LWT_ENCAP_SEG6_INLINE,
3032 BPF_LWT_ENCAP_IP,
c99a84ea
MX
3033};
3034
b7df9ada
DB
3035#define __bpf_md_ptr(type, name) \
3036union { \
3037 type name; \
3038 __u64 :64; \
3039} __attribute__((aligned(8)))
3040
971e827b
ACM
3041/* user accessible mirror of in-kernel sk_buff.
3042 * new fields can only be added to the end of this structure
3043 */
3044struct __sk_buff {
3045 __u32 len;
3046 __u32 pkt_type;
3047 __u32 mark;
3048 __u32 queue_mapping;
3049 __u32 protocol;
3050 __u32 vlan_present;
3051 __u32 vlan_tci;
3052 __u32 vlan_proto;
3053 __u32 priority;
3054 __u32 ingress_ifindex;
3055 __u32 ifindex;
3056 __u32 tc_index;
3057 __u32 cb[5];
3058 __u32 hash;
3059 __u32 tc_classid;
3060 __u32 data;
3061 __u32 data_end;
b1d9fc41 3062 __u32 napi_id;
69e8cc13 3063
ac29991b 3064 /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */
69e8cc13
JF
3065 __u32 family;
3066 __u32 remote_ip4; /* Stored in network byte order */
3067 __u32 local_ip4; /* Stored in network byte order */
3068 __u32 remote_ip6[4]; /* Stored in network byte order */
3069 __u32 local_ip6[4]; /* Stored in network byte order */
3070 __u32 remote_port; /* Stored in network byte order */
3071 __u32 local_port; /* stored in host byte order */
ac29991b
DB
3072 /* ... here. */
3073
3074 __u32 data_meta;
b7df9ada 3075 __bpf_md_ptr(struct bpf_flow_keys *, flow_keys);
f11216b2 3076 __u64 tstamp;
e3da08d0 3077 __u32 wire_len;
d9ff286a 3078 __u32 gso_segs;
281f9e75 3079 __bpf_md_ptr(struct bpf_sock *, sk);
971e827b
ACM
3080};
3081
3082struct bpf_tunnel_key {
3083 __u32 tunnel_id;
3084 union {
3085 __u32 remote_ipv4;
3086 __u32 remote_ipv6[4];
3087 };
3088 __u8 tunnel_tos;
3089 __u8 tunnel_ttl;
6b6a1925 3090 __u16 tunnel_ext; /* Padding, future use. */
971e827b
ACM
3091 __u32 tunnel_label;
3092};
3093
29a36f9e
EB
3094/* user accessible mirror of in-kernel xfrm_state.
3095 * new fields can only be added to the end of this structure
3096 */
3097struct bpf_xfrm_state {
3098 __u32 reqid;
3099 __u32 spi; /* Stored in network byte order */
3100 __u16 family;
6b6a1925 3101 __u16 ext; /* Padding, future use. */
29a36f9e
EB
3102 union {
3103 __u32 remote_ipv4; /* Stored in network byte order */
3104 __u32 remote_ipv6[4]; /* Stored in network byte order */
3105 };
3106};
3107
0cb34dc2
JS
3108/* Generic BPF return codes which all BPF program types may support.
3109 * The values are binary compatible with their TC_ACT_* counter-part to
3110 * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
3111 * programs.
3112 *
3113 * XDP is handled seprately, see XDP_*.
3114 */
3115enum bpf_ret_code {
3116 BPF_OK = 0,
3117 /* 1 reserved */
3118 BPF_DROP = 2,
3119 /* 3-6 reserved */
3120 BPF_REDIRECT = 7,
755db477
PO
3121 /* >127 are reserved for prog type specific return codes.
3122 *
3123 * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and
3124 * BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been
3125 * changed and should be routed based on its new L3 header.
3126 * (This is an L3 redirect, as opposed to L2 redirect
3127 * represented by BPF_REDIRECT above).
3128 */
3129 BPF_LWT_REROUTE = 128,
0cb34dc2
JS
3130};
3131
3132struct bpf_sock {
3133 __u32 bound_dev_if;
3134 __u32 family;
3135 __u32 type;
3136 __u32 protocol;
ac29991b
DB
3137 __u32 mark;
3138 __u32 priority;
281f9e75
MKL
3139 /* IP address also allows 1 and 2 bytes access */
3140 __u32 src_ip4;
3141 __u32 src_ip6[4];
3142 __u32 src_port; /* host byte order */
3143 __u32 dst_port; /* network byte order */
3144 __u32 dst_ip4;
3145 __u32 dst_ip6[4];
3146 __u32 state;
3147};
3148
3149struct bpf_tcp_sock {
3150 __u32 snd_cwnd; /* Sending congestion window */
3151 __u32 srtt_us; /* smoothed round trip time << 3 in usecs */
3152 __u32 rtt_min;
3153 __u32 snd_ssthresh; /* Slow start size threshold */
3154 __u32 rcv_nxt; /* What we want to receive next */
3155 __u32 snd_nxt; /* Next sequence we send */
3156 __u32 snd_una; /* First byte we want an ack for */
3157 __u32 mss_cache; /* Cached effective mss, not including SACKS */
3158 __u32 ecn_flags; /* ECN status bits. */
3159 __u32 rate_delivered; /* saved rate sample: packets delivered */
3160 __u32 rate_interval_us; /* saved rate sample: time elapsed */
3161 __u32 packets_out; /* Packets which are "in flight" */
3162 __u32 retrans_out; /* Retransmitted packets out */
3163 __u32 total_retrans; /* Total retransmits for entire connection */
3164 __u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn
3165 * total number of segments in.
3166 */
3167 __u32 data_segs_in; /* RFC4898 tcpEStatsPerfDataSegsIn
3168 * total number of data segments in.
3169 */
3170 __u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut
3171 * The total number of segments sent.
3172 */
3173 __u32 data_segs_out; /* RFC4898 tcpEStatsPerfDataSegsOut
3174 * total number of data segments sent.
1d436885 3175 */
281f9e75
MKL
3176 __u32 lost_out; /* Lost packets */
3177 __u32 sacked_out; /* SACK'd packets */
3178 __u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived
3179 * sum(delta(rcv_nxt)), or how many bytes
3180 * were acked.
1d436885 3181 */
281f9e75
MKL
3182 __u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked
3183 * sum(delta(snd_una)), or how many bytes
3184 * were acked.
1d436885 3185 */
692cbaa9
SF
3186 __u32 dsack_dups; /* RFC4898 tcpEStatsStackDSACKDups
3187 * total number of DSACK blocks received
3188 */
3189 __u32 delivered; /* Total data packets delivered incl. rexmits */
3190 __u32 delivered_ce; /* Like the above but only ECE marked packets */
3191 __u32 icsk_retransmits; /* Number of unrecovered [RTO] timeouts */
0cb34dc2
JS
3192};
3193
6acc9b43
JS
3194struct bpf_sock_tuple {
3195 union {
3196 struct {
3197 __be32 saddr;
3198 __be32 daddr;
3199 __be16 sport;
3200 __be16 dport;
3201 } ipv4;
3202 struct {
3203 __be32 saddr[4];
3204 __be32 daddr[4];
3205 __be16 sport;
3206 __be16 dport;
3207 } ipv6;
3208 };
3209};
3210
91eda599
JL
3211struct bpf_xdp_sock {
3212 __u32 queue_id;
3213};
3214
0cb34dc2
JS
3215#define XDP_PACKET_HEADROOM 256
3216
791cceb8
ACM
3217/* User return codes for XDP prog type.
3218 * A valid XDP program must return one of these defined values. All other
ac29991b
DB
3219 * return codes are reserved for future use. Unknown return codes will
3220 * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
791cceb8
ACM
3221 */
3222enum xdp_action {
3223 XDP_ABORTED = 0,
3224 XDP_DROP,
3225 XDP_PASS,
3226 XDP_TX,
ac29991b 3227 XDP_REDIRECT,
791cceb8
ACM
3228};
3229
3230/* user accessible metadata for XDP packet hook
3231 * new fields must be added to the end of this structure
3232 */
3233struct xdp_md {
3234 __u32 data;
3235 __u32 data_end;
ac29991b 3236 __u32 data_meta;
e7b2823a
JDB
3237 /* Below access go through struct xdp_rxq_info */
3238 __u32 ingress_ifindex; /* rxq->dev->ifindex */
3239 __u32 rx_queue_index; /* rxq->queue_index */
791cceb8
ACM
3240};
3241
69e8cc13 3242enum sk_action {
bfa64075
JF
3243 SK_DROP = 0,
3244 SK_PASS,
69e8cc13
JF
3245};
3246
82a86168
JF
3247/* user accessible metadata for SK_MSG packet hook, new fields must
3248 * be added to the end of this structure
3249 */
3250struct sk_msg_md {
b7df9ada
DB
3251 __bpf_md_ptr(void *, data);
3252 __bpf_md_ptr(void *, data_end);
4da0dcab
JF
3253
3254 __u32 family;
3255 __u32 remote_ip4; /* Stored in network byte order */
3256 __u32 local_ip4; /* Stored in network byte order */
3257 __u32 remote_ip6[4]; /* Stored in network byte order */
3258 __u32 local_ip6[4]; /* Stored in network byte order */
3259 __u32 remote_port; /* Stored in network byte order */
3260 __u32 local_port; /* stored in host byte order */
584e4681 3261 __u32 size; /* Total size of sk_msg */
82a86168
JF
3262};
3263
3bd43a8c
MKL
3264struct sk_reuseport_md {
3265 /*
3266 * Start of directly accessible data. It begins from
3267 * the tcp/udp header.
3268 */
b7df9ada
DB
3269 __bpf_md_ptr(void *, data);
3270 /* End of directly accessible data */
3271 __bpf_md_ptr(void *, data_end);
3bd43a8c
MKL
3272 /*
3273 * Total length of packet (starting from the tcp/udp header).
3274 * Note that the directly accessible bytes (data_end - data)
3275 * could be less than this "len". Those bytes could be
3276 * indirectly read by a helper "bpf_skb_load_bytes()".
3277 */
3278 __u32 len;
3279 /*
3280 * Eth protocol in the mac header (network byte order). e.g.
3281 * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD)
3282 */
3283 __u32 eth_protocol;
3284 __u32 ip_protocol; /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */
3285 __u32 bind_inany; /* Is sock bound to an INANY address? */
3286 __u32 hash; /* A hash of the packet 4 tuples */
3287};
3288
95b9afd3
MKL
3289#define BPF_TAG_SIZE 8
3290
3291struct bpf_prog_info {
3292 __u32 type;
3293 __u32 id;
3294 __u8 tag[BPF_TAG_SIZE];
3295 __u32 jited_prog_len;
3296 __u32 xlated_prog_len;
3297 __aligned_u64 jited_prog_insns;
3298 __aligned_u64 xlated_prog_insns;
88cda1c9
MKL
3299 __u64 load_time; /* ns since boottime */
3300 __u32 created_by_uid;
3301 __u32 nr_map_ids;
3302 __aligned_u64 map_ids;
e27afb84 3303 char name[BPF_OBJ_NAME_LEN];
675fc275 3304 __u32 ifindex;
fb6ef42b 3305 __u32 gpl_compatible:1;
0472301a 3306 __u32 :31; /* alignment pad */
675fc275
JK
3307 __u64 netns_dev;
3308 __u64 netns_ino;
dd0c5f07 3309 __u32 nr_jited_ksyms;
bd980d43 3310 __u32 nr_jited_func_lens;
dd0c5f07 3311 __aligned_u64 jited_ksyms;
bd980d43 3312 __aligned_u64 jited_func_lens;
cc19435c
YS
3313 __u32 btf_id;
3314 __u32 func_info_rec_size;
3315 __aligned_u64 func_info;
b4f8623c
YS
3316 __u32 nr_func_info;
3317 __u32 nr_line_info;
ee491d8d
MKL
3318 __aligned_u64 line_info;
3319 __aligned_u64 jited_line_info;
b4f8623c 3320 __u32 nr_jited_line_info;
ee491d8d
MKL
3321 __u32 line_info_rec_size;
3322 __u32 jited_line_info_rec_size;
eb896a69
SL
3323 __u32 nr_prog_tags;
3324 __aligned_u64 prog_tags;
b1eca86d
AS
3325 __u64 run_time_ns;
3326 __u64 run_cnt;
95b9afd3
MKL
3327} __attribute__((aligned(8)));
3328
3329struct bpf_map_info {
3330 __u32 type;
3331 __u32 id;
3332 __u32 key_size;
3333 __u32 value_size;
3334 __u32 max_entries;
3335 __u32 map_flags;
067cae47 3336 char name[BPF_OBJ_NAME_LEN];
52775b33 3337 __u32 ifindex;
36f9814a 3338 __u32 :32;
52775b33
JK
3339 __u64 netns_dev;
3340 __u64 netns_ino;
7a01f6a3 3341 __u32 btf_id;
f03b15d3
MKL
3342 __u32 btf_key_type_id;
3343 __u32 btf_value_type_id;
7a01f6a3
MKL
3344} __attribute__((aligned(8)));
3345
3346struct bpf_btf_info {
3347 __aligned_u64 btf;
3348 __u32 btf_size;
3349 __u32 id;
95b9afd3
MKL
3350} __attribute__((aligned(8)));
3351
e50b0a6f
AI
3352/* User bpf_sock_addr struct to access socket fields and sockaddr struct passed
3353 * by user and intended to be used by socket (e.g. to bind to, depends on
3354 * attach attach type).
3355 */
3356struct bpf_sock_addr {
3357 __u32 user_family; /* Allows 4-byte read, but no write. */
3358 __u32 user_ip4; /* Allows 1,2,4-byte read and 4-byte write.
3359 * Stored in network byte order.
3360 */
073a4834 3361 __u32 user_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write.
e50b0a6f
AI
3362 * Stored in network byte order.
3363 */
3364 __u32 user_port; /* Allows 4-byte read and write.
3365 * Stored in network byte order
3366 */
3367 __u32 family; /* Allows 4-byte read, but no write */
3368 __u32 type; /* Allows 4-byte read, but no write */
3369 __u32 protocol; /* Allows 4-byte read, but no write */
4cfacbe6 3370 __u32 msg_src_ip4; /* Allows 1,2,4-byte read and 4-byte write.
3024cf82
AI
3371 * Stored in network byte order.
3372 */
073a4834 3373 __u32 msg_src_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write.
3024cf82
AI
3374 * Stored in network byte order.
3375 */
cd17d777 3376 __bpf_md_ptr(struct bpf_sock *, sk);
e50b0a6f
AI
3377};
3378
04df41e3
LB
3379/* User bpf_sock_ops struct to access socket values and specify request ops
3380 * and their replies.
f1d6cb2d
ACM
3381 * Some of this fields are in network (bigendian) byte order and may need
3382 * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
04df41e3
LB
3383 * New fields can only be added at the end of this structure
3384 */
3385struct bpf_sock_ops {
3386 __u32 op;
3387 union {
d6d4f60c
LB
3388 __u32 args[4]; /* Optionally passed to bpf program */
3389 __u32 reply; /* Returned by bpf program */
3390 __u32 replylong[4]; /* Optionally returned by bpf prog */
04df41e3
LB
3391 };
3392 __u32 family;
f1d6cb2d
ACM
3393 __u32 remote_ip4; /* Stored in network byte order */
3394 __u32 local_ip4; /* Stored in network byte order */
3395 __u32 remote_ip6[4]; /* Stored in network byte order */
3396 __u32 local_ip6[4]; /* Stored in network byte order */
3397 __u32 remote_port; /* Stored in network byte order */
3398 __u32 local_port; /* stored in host byte order */
e7b2823a
JDB
3399 __u32 is_fullsock; /* Some TCP fields are only valid if
3400 * there is a full socket. If not, the
3401 * fields read as zero.
3402 */
3403 __u32 snd_cwnd;
3404 __u32 srtt_us; /* Averaged RTT << 3 in usecs */
d6d4f60c
LB
3405 __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */
3406 __u32 state;
3407 __u32 rtt_min;
3408 __u32 snd_ssthresh;
3409 __u32 rcv_nxt;
3410 __u32 snd_nxt;
3411 __u32 snd_una;
3412 __u32 mss_cache;
3413 __u32 ecn_flags;
3414 __u32 rate_delivered;
3415 __u32 rate_interval_us;
3416 __u32 packets_out;
3417 __u32 retrans_out;
3418 __u32 total_retrans;
3419 __u32 segs_in;
3420 __u32 data_segs_in;
3421 __u32 segs_out;
3422 __u32 data_segs_out;
3423 __u32 lost_out;
3424 __u32 sacked_out;
3425 __u32 sk_txhash;
3426 __u64 bytes_received;
3427 __u64 bytes_acked;
cd17d777 3428 __bpf_md_ptr(struct bpf_sock *, sk);
04df41e3
LB
3429};
3430
d6d4f60c
LB
3431/* Definitions for bpf_sock_ops_cb_flags */
3432#define BPF_SOCK_OPS_RTO_CB_FLAG (1<<0)
3433#define BPF_SOCK_OPS_RETRANS_CB_FLAG (1<<1)
3434#define BPF_SOCK_OPS_STATE_CB_FLAG (1<<2)
692cbaa9
SF
3435#define BPF_SOCK_OPS_RTT_CB_FLAG (1<<3)
3436#define BPF_SOCK_OPS_ALL_CB_FLAGS 0xF /* Mask of all currently
d6d4f60c
LB
3437 * supported cb flags
3438 */
3439
04df41e3
LB
3440/* List of known BPF sock_ops operators.
3441 * New entries can only be added at the end
3442 */
3443enum {
3444 BPF_SOCK_OPS_VOID,
3445 BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or
3446 * -1 if default value should be used
3447 */
3448 BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized
3449 * window (in packets) or -1 if default
3450 * value should be used
3451 */
3452 BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an
3453 * active connection is initialized
3454 */
3455 BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an
3456 * active connection is
3457 * established
3458 */
3459 BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a
3460 * passive connection is
3461 * established
3462 */
3463 BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control
3464 * needs ECN
3465 */
e27afb84
AS
3466 BPF_SOCK_OPS_BASE_RTT, /* Get base RTT. The correct value is
3467 * based on the path and may be
3468 * dependent on the congestion control
3469 * algorithm. In general it indicates
3470 * a congestion threshold. RTTs above
3471 * this indicate congestion
3472 */
d6d4f60c
LB
3473 BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered.
3474 * Arg1: value of icsk_retransmits
3475 * Arg2: value of icsk_rto
3476 * Arg3: whether RTO has expired
3477 */
3478 BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted.
3479 * Arg1: sequence number of 1st byte
3480 * Arg2: # segments
3481 * Arg3: return value of
3482 * tcp_transmit_skb (0 => success)
3483 */
3484 BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state.
3485 * Arg1: old_state
3486 * Arg2: new_state
3487 */
060a7fcc
AI
3488 BPF_SOCK_OPS_TCP_LISTEN_CB, /* Called on listen(2), right after
3489 * socket transition to LISTEN state.
3490 */
692cbaa9
SF
3491 BPF_SOCK_OPS_RTT_CB, /* Called on every RTT.
3492 */
d6d4f60c
LB
3493};
3494
3495/* List of TCP states. There is a build check in net/ipv4/tcp.c to detect
3496 * changes between the TCP and BPF versions. Ideally this should never happen.
3497 * If it does, we need to add code to convert them before calling
3498 * the BPF sock_ops function.
3499 */
3500enum {
3501 BPF_TCP_ESTABLISHED = 1,
3502 BPF_TCP_SYN_SENT,
3503 BPF_TCP_SYN_RECV,
3504 BPF_TCP_FIN_WAIT1,
3505 BPF_TCP_FIN_WAIT2,
3506 BPF_TCP_TIME_WAIT,
3507 BPF_TCP_CLOSE,
3508 BPF_TCP_CLOSE_WAIT,
3509 BPF_TCP_LAST_ACK,
3510 BPF_TCP_LISTEN,
3511 BPF_TCP_CLOSING, /* Now a valid state */
3512 BPF_TCP_NEW_SYN_RECV,
3513
3514 BPF_TCP_MAX_STATES /* Leave at the end! */
04df41e3
LB
3515};
3516
3517#define TCP_BPF_IW 1001 /* Set TCP initial congestion window */
3518#define TCP_BPF_SNDCWND_CLAMP 1002 /* Set sndcwnd_clamp */
3519
e27afb84
AS
3520struct bpf_perf_event_value {
3521 __u64 counter;
3522 __u64 enabled;
3523 __u64 running;
3524};
3525
ebc614f6
RG
3526#define BPF_DEVCG_ACC_MKNOD (1ULL << 0)
3527#define BPF_DEVCG_ACC_READ (1ULL << 1)
3528#define BPF_DEVCG_ACC_WRITE (1ULL << 2)
3529
3530#define BPF_DEVCG_DEV_BLOCK (1ULL << 0)
3531#define BPF_DEVCG_DEV_CHAR (1ULL << 1)
3532
3533struct bpf_cgroup_dev_ctx {
e7b2823a
JDB
3534 /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */
3535 __u32 access_type;
ebc614f6
RG
3536 __u32 major;
3537 __u32 minor;
3538};
3539
a0fe3e57
AS
3540struct bpf_raw_tracepoint_args {
3541 __u64 args[0];
3542};
3543
cb9c28ef
PB
3544/* DIRECT: Skip the FIB rules and go to FIB table associated with device
3545 * OUTPUT: Do lookup from egress perspective; default is ingress
3546 */
0e265747
MP
3547#define BPF_FIB_LOOKUP_DIRECT (1U << 0)
3548#define BPF_FIB_LOOKUP_OUTPUT (1U << 1)
cb9c28ef 3549
9b8ca379
QM
3550enum {
3551 BPF_FIB_LKUP_RET_SUCCESS, /* lookup successful */
3552 BPF_FIB_LKUP_RET_BLACKHOLE, /* dest is blackholed; can be dropped */
3553 BPF_FIB_LKUP_RET_UNREACHABLE, /* dest is unreachable; can be dropped */
3554 BPF_FIB_LKUP_RET_PROHIBIT, /* dest not allowed; can be dropped */
3555 BPF_FIB_LKUP_RET_NOT_FWDED, /* packet is not forwarded */
3556 BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */
3557 BPF_FIB_LKUP_RET_UNSUPP_LWT, /* fwd requires encapsulation */
3558 BPF_FIB_LKUP_RET_NO_NEIGH, /* no neighbor entry for nh */
3559 BPF_FIB_LKUP_RET_FRAG_NEEDED, /* fragmentation required to fwd */
3560};
3561
cb9c28ef 3562struct bpf_fib_lookup {
6bdd533c
SY
3563 /* input: network family for lookup (AF_INET, AF_INET6)
3564 * output: network family of egress nexthop
3565 */
3566 __u8 family;
cb9c28ef
PB
3567
3568 /* set if lookup is to consider L4 data - e.g., FIB rules */
3569 __u8 l4_protocol;
3570 __be16 sport;
3571 __be16 dport;
3572
3573 /* total length of packet from network header - used for MTU check */
3574 __u16 tot_len;
9b8ca379
QM
3575
3576 /* input: L3 device index for lookup
3577 * output: device index from FIB lookup
3578 */
3579 __u32 ifindex;
cb9c28ef
PB
3580
3581 union {
3582 /* inputs to lookup */
3583 __u8 tos; /* AF_INET */
f568b472 3584 __be32 flowinfo; /* AF_INET6, flow_label + priority */
cb9c28ef 3585
6bdd533c
SY
3586 /* output: metric of fib result (IPv4/IPv6 only) */
3587 __u32 rt_metric;
cb9c28ef
PB
3588 };
3589
3590 union {
cb9c28ef
PB
3591 __be32 ipv4_src;
3592 __u32 ipv6_src[4]; /* in6_addr; network order */
3593 };
3594
6bdd533c
SY
3595 /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in
3596 * network header. output: bpf_fib_lookup sets to gateway address
3597 * if FIB lookup returns gateway route
cb9c28ef
PB
3598 */
3599 union {
cb9c28ef
PB
3600 __be32 ipv4_dst;
3601 __u32 ipv6_dst[4]; /* in6_addr; network order */
3602 };
3603
3604 /* output */
3605 __be16 h_vlan_proto;
3606 __be16 h_vlan_TCI;
3607 __u8 smac[6]; /* ETH_ALEN */
3608 __u8 dmac[6]; /* ETH_ALEN */
3609};
3610
30687ad9
YS
3611enum bpf_task_fd_type {
3612 BPF_FD_TYPE_RAW_TRACEPOINT, /* tp name */
3613 BPF_FD_TYPE_TRACEPOINT, /* tp name */
3614 BPF_FD_TYPE_KPROBE, /* (symbol + offset) or addr */
3615 BPF_FD_TYPE_KRETPROBE, /* (symbol + offset) or addr */
3616 BPF_FD_TYPE_UPROBE, /* filename + offset */
3617 BPF_FD_TYPE_URETPROBE, /* filename + offset */
3618};
3619
57debff2
SF
3620#define BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG (1U << 0)
3621#define BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL (1U << 1)
3622#define BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP (1U << 2)
3623
2f965e3f
PP
3624struct bpf_flow_keys {
3625 __u16 nhoff;
3626 __u16 thoff;
3627 __u16 addr_proto; /* ETH_P_* of valid addrs */
3628 __u8 is_frag;
3629 __u8 is_first_frag;
3630 __u8 is_encap;
3631 __u8 ip_proto;
3632 __be16 n_proto;
3633 __be16 sport;
3634 __be16 dport;
3635 union {
3636 struct {
3637 __be32 ipv4_src;
3638 __be32 ipv4_dst;
3639 };
3640 struct {
3641 __u32 ipv6_src[4]; /* in6_addr; network order */
3642 __u32 ipv6_dst[4]; /* in6_addr; network order */
3643 };
3644 };
57debff2 3645 __u32 flags;
71c99e32 3646 __be32 flow_label;
2f965e3f
PP
3647};
3648
cc19435c 3649struct bpf_func_info {
555249df 3650 __u32 insn_off;
cc19435c
YS
3651 __u32 type_id;
3652};
3653
ee491d8d
MKL
3654#define BPF_LINE_INFO_LINE_NUM(line_col) ((line_col) >> 10)
3655#define BPF_LINE_INFO_LINE_COL(line_col) ((line_col) & 0x3ff)
3656
3657struct bpf_line_info {
3658 __u32 insn_off;
3659 __u32 file_name_off;
3660 __u32 line_off;
3661 __u32 line_col;
3662};
3663
7dac3ae4
AS
3664struct bpf_spin_lock {
3665 __u32 val;
3666};
196398d4
AI
3667
3668struct bpf_sysctl {
3669 __u32 write; /* Sysctl is being read (= 0) or written (= 1).
3670 * Allows 1,2,4-byte read, but no write.
3671 */
3672 __u32 file_pos; /* Sysctl file position to read from, write to.
3673 * Allows 1,2,4-byte read an 4-byte write.
3674 */
3675};
3676
aa6ab647
SF
3677struct bpf_sockopt {
3678 __bpf_md_ptr(struct bpf_sock *, sk);
3679 __bpf_md_ptr(void *, optval);
3680 __bpf_md_ptr(void *, optval_end);
3681
3682 __s32 level;
3683 __s32 optname;
3684 __s32 optlen;
3685 __s32 retval;
3686};
3687
971e827b 3688#endif /* _UAPI__LINUX_BPF_H__ */