blob: f7fa7a34a62d0e2e8a2173f9442215b3e4677b49 [file] [log] [blame]
Greg Kroah-Hartmane2be04c2017-11-01 15:09:13 +01001/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -07002/* 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>
Alexei Starovoitovc15952d2014-10-14 02:08:54 -070012#include <linux/bpf_common.h>
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070013
14/* Extended instruction set based on top of classic BPF */
15
16/* instruction classes */
Jiong Wangd405c742019-01-26 12:25:59 -050017#define BPF_JMP32 0x06 /* jmp mode in word width */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070018#define BPF_ALU64 0x07 /* alu mode in double word width */
19
20/* ld/ldx fields */
Jesper Dangaard Brouercb5f7332018-01-17 12:05:36 +010021#define BPF_DW 0x18 /* double word (64-bit) */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070022#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
Daniel Borkmann92b31a92017-08-10 01:39:55 +020035/* jmp encodings */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070036#define BPF_JNE 0x50 /* jump != */
Daniel Borkmann92b31a92017-08-10 01:39:55 +020037#define BPF_JLT 0xa0 /* LT is unsigned, '<' */
38#define BPF_JLE 0xb0 /* LE is unsigned, '<=' */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070039#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
40#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
Daniel Borkmann92b31a92017-08-10 01:39:55 +020041#define BPF_JSLT 0xc0 /* SLT is signed, '<' */
42#define BPF_JSLE 0xd0 /* SLE is signed, '<=' */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070043#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
Daniel Mackb95a5c42017-01-21 17:26:11 +010073/* 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
Roman Gushchinde9cbba2018-08-02 14:27:18 -070079struct bpf_cgroup_storage_key {
80 __u64 cgroup_inode_id; /* cgroup inode id */
81 __u32 attach_type; /* program attach type */
82};
83
Daniel Borkmannb2197752015-10-29 14:58:09 +010084/* BPF syscall commands, see bpf(2) man-page for details. */
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070085enum bpf_cmd {
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070086 BPF_MAP_CREATE,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070087 BPF_MAP_LOOKUP_ELEM,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070088 BPF_MAP_UPDATE_ELEM,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070089 BPF_MAP_DELETE_ELEM,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070090 BPF_MAP_GET_NEXT_KEY,
Alexei Starovoitov09756af2014-09-26 00:17:00 -070091 BPF_PROG_LOAD,
Daniel Borkmannb2197752015-10-29 14:58:09 +010092 BPF_OBJ_PIN,
93 BPF_OBJ_GET,
Daniel Mackf4324552016-11-23 16:52:27 +010094 BPF_PROG_ATTACH,
95 BPF_PROG_DETACH,
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -070096 BPF_PROG_TEST_RUN,
Martin KaFai Lau34ad5582017-06-05 12:15:48 -070097 BPF_PROG_GET_NEXT_ID,
98 BPF_MAP_GET_NEXT_ID,
Martin KaFai Laub16d9aa2017-06-05 12:15:49 -070099 BPF_PROG_GET_FD_BY_ID,
Martin KaFai Laubd5f5f4e2017-06-05 12:15:50 -0700100 BPF_MAP_GET_FD_BY_ID,
Martin KaFai Lau1e270972017-06-05 12:15:52 -0700101 BPF_OBJ_GET_INFO_BY_FD,
Alexei Starovoitov468e2f62017-10-02 22:50:22 -0700102 BPF_PROG_QUERY,
Alexei Starovoitovc4f66992018-03-28 12:05:37 -0700103 BPF_RAW_TRACEPOINT_OPEN,
Martin KaFai Lauf56a6532018-04-18 15:56:01 -0700104 BPF_BTF_LOAD,
Martin KaFai Lau78958fc2018-05-04 14:49:51 -0700105 BPF_BTF_GET_FD_BY_ID,
Yonghong Song41bdc4b2018-05-24 11:21:09 -0700106 BPF_TASK_FD_QUERY,
Mauricio Vasquez Bbd513cd2018-10-18 15:16:30 +0200107 BPF_MAP_LOOKUP_AND_DELETE_ELEM,
Daniel Borkmann87df15d2019-04-09 23:20:06 +0200108 BPF_MAP_FREEZE,
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700109};
110
111enum bpf_map_type {
112 BPF_MAP_TYPE_UNSPEC,
Alexei Starovoitov0f8e4bd2014-11-13 17:36:45 -0800113 BPF_MAP_TYPE_HASH,
Alexei Starovoitov28fbcfa2014-11-13 17:36:46 -0800114 BPF_MAP_TYPE_ARRAY,
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700115 BPF_MAP_TYPE_PROG_ARRAY,
Kaixu Xiaea317b22015-08-06 07:02:34 +0000116 BPF_MAP_TYPE_PERF_EVENT_ARRAY,
Alexei Starovoitov824bd0c2016-02-01 22:39:53 -0800117 BPF_MAP_TYPE_PERCPU_HASH,
Alexei Starovoitova10423b2016-02-01 22:39:54 -0800118 BPF_MAP_TYPE_PERCPU_ARRAY,
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -0800119 BPF_MAP_TYPE_STACK_TRACE,
Martin KaFai Lau4ed8ec52016-06-30 10:28:43 -0700120 BPF_MAP_TYPE_CGROUP_ARRAY,
Martin KaFai Lau29ba7322016-11-11 10:55:09 -0800121 BPF_MAP_TYPE_LRU_HASH,
Martin KaFai Lau8f844932016-11-11 10:55:10 -0800122 BPF_MAP_TYPE_LRU_PERCPU_HASH,
Daniel Mackb95a5c42017-01-21 17:26:11 +0100123 BPF_MAP_TYPE_LPM_TRIE,
Martin KaFai Lau56f668d2017-03-22 10:00:33 -0700124 BPF_MAP_TYPE_ARRAY_OF_MAPS,
Martin KaFai Laubcc6b1b2017-03-22 10:00:34 -0700125 BPF_MAP_TYPE_HASH_OF_MAPS,
John Fastabend546ac1f2017-07-17 09:28:56 -0700126 BPF_MAP_TYPE_DEVMAP,
John Fastabend174a79f2017-08-15 22:32:47 -0700127 BPF_MAP_TYPE_SOCKMAP,
Jesper Dangaard Brouer6710e112017-10-16 12:19:28 +0200128 BPF_MAP_TYPE_CPUMAP,
Björn Töpelfbfc504a2018-05-02 13:01:28 +0200129 BPF_MAP_TYPE_XSKMAP,
John Fastabend81110382018-05-14 10:00:17 -0700130 BPF_MAP_TYPE_SOCKHASH,
Roman Gushchinde9cbba2018-08-02 14:27:18 -0700131 BPF_MAP_TYPE_CGROUP_STORAGE,
Martin KaFai Lau5dc4c4b2018-08-08 01:01:24 -0700132 BPF_MAP_TYPE_REUSEPORT_SOCKARRAY,
Roman Gushchinb741f162018-09-28 14:45:43 +0000133 BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE,
Mauricio Vasquez Bf1a2e442018-10-18 15:16:25 +0200134 BPF_MAP_TYPE_QUEUE,
135 BPF_MAP_TYPE_STACK,
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700136};
137
Daniel Borkmann6c4fc202018-12-16 00:49:47 +0100138/* Note that tracing related programs such as
139 * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT}
140 * are not subject to a stable API since kernel internal data
141 * structures can change from release to release and may
142 * therefore break existing tracing BPF programs. Tracing BPF
143 * programs correspond to /a/ specific kernel which is to be
144 * analyzed, and not /a/ specific kernel /and/ all future ones.
145 */
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700146enum bpf_prog_type {
147 BPF_PROG_TYPE_UNSPEC,
Alexei Starovoitovddd872b2014-12-01 15:06:34 -0800148 BPF_PROG_TYPE_SOCKET_FILTER,
Alexei Starovoitov25415172015-03-25 12:49:20 -0700149 BPF_PROG_TYPE_KPROBE,
Daniel Borkmann96be4322015-03-01 12:31:46 +0100150 BPF_PROG_TYPE_SCHED_CLS,
Daniel Borkmann94caee8c2015-03-20 15:11:11 +0100151 BPF_PROG_TYPE_SCHED_ACT,
Alexei Starovoitov98b5c2c2016-04-06 18:43:25 -0700152 BPF_PROG_TYPE_TRACEPOINT,
Brenden Blanco6a773a12016-07-19 12:16:47 -0700153 BPF_PROG_TYPE_XDP,
Alexei Starovoitov0515e592016-09-01 18:37:22 -0700154 BPF_PROG_TYPE_PERF_EVENT,
Daniel Mack0e336612016-11-23 16:52:25 +0100155 BPF_PROG_TYPE_CGROUP_SKB,
David Ahern610236582016-12-01 08:48:04 -0800156 BPF_PROG_TYPE_CGROUP_SOCK,
Thomas Graf3a0af8f2016-11-30 17:10:10 +0100157 BPF_PROG_TYPE_LWT_IN,
158 BPF_PROG_TYPE_LWT_OUT,
159 BPF_PROG_TYPE_LWT_XMIT,
Lawrence Brakmo40304b22017-06-30 20:02:40 -0700160 BPF_PROG_TYPE_SOCK_OPS,
John Fastabendb005fd12017-08-15 22:31:58 -0700161 BPF_PROG_TYPE_SK_SKB,
Roman Gushchinebc614f2017-11-05 08:15:32 -0500162 BPF_PROG_TYPE_CGROUP_DEVICE,
John Fastabend4f738ad2018-03-18 12:57:10 -0700163 BPF_PROG_TYPE_SK_MSG,
Alexei Starovoitovc4f66992018-03-28 12:05:37 -0700164 BPF_PROG_TYPE_RAW_TRACEPOINT,
Andrey Ignatov4fbac772018-03-30 15:08:02 -0700165 BPF_PROG_TYPE_CGROUP_SOCK_ADDR,
Mathieu Xhonneux004d4b22018-05-20 14:58:16 +0100166 BPF_PROG_TYPE_LWT_SEG6LOCAL,
Sean Youngf4364dc2018-05-27 12:24:09 +0100167 BPF_PROG_TYPE_LIRC_MODE2,
Martin KaFai Lau2dbb9b92018-08-08 01:01:25 -0700168 BPF_PROG_TYPE_SK_REUSEPORT,
Petar Penkovd58e4682018-09-14 07:46:18 -0700169 BPF_PROG_TYPE_FLOW_DISSECTOR,
Andrey Ignatov7b146ce2019-02-27 12:59:24 -0800170 BPF_PROG_TYPE_CGROUP_SYSCTL,
Matt Mullins9df1c282019-04-26 11:49:47 -0700171 BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE,
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700172};
173
Daniel Mack0e336612016-11-23 16:52:25 +0100174enum bpf_attach_type {
175 BPF_CGROUP_INET_INGRESS,
176 BPF_CGROUP_INET_EGRESS,
David Ahern610236582016-12-01 08:48:04 -0800177 BPF_CGROUP_INET_SOCK_CREATE,
Lawrence Brakmo40304b22017-06-30 20:02:40 -0700178 BPF_CGROUP_SOCK_OPS,
John Fastabend464bc0f2017-08-28 07:10:04 -0700179 BPF_SK_SKB_STREAM_PARSER,
180 BPF_SK_SKB_STREAM_VERDICT,
Roman Gushchinebc614f2017-11-05 08:15:32 -0500181 BPF_CGROUP_DEVICE,
John Fastabend4f738ad2018-03-18 12:57:10 -0700182 BPF_SK_MSG_VERDICT,
Andrey Ignatov4fbac772018-03-30 15:08:02 -0700183 BPF_CGROUP_INET4_BIND,
184 BPF_CGROUP_INET6_BIND,
Andrey Ignatovd74bad42018-03-30 15:08:05 -0700185 BPF_CGROUP_INET4_CONNECT,
186 BPF_CGROUP_INET6_CONNECT,
Andrey Ignatovaac3fc32018-03-30 15:08:07 -0700187 BPF_CGROUP_INET4_POST_BIND,
188 BPF_CGROUP_INET6_POST_BIND,
Andrey Ignatov1cedee12018-05-25 08:55:23 -0700189 BPF_CGROUP_UDP4_SENDMSG,
190 BPF_CGROUP_UDP6_SENDMSG,
Sean Youngf4364dc2018-05-27 12:24:09 +0100191 BPF_LIRC_MODE2,
Petar Penkovd58e4682018-09-14 07:46:18 -0700192 BPF_FLOW_DISSECTOR,
Andrey Ignatov7b146ce2019-02-27 12:59:24 -0800193 BPF_CGROUP_SYSCTL,
Daniel Mack0e336612016-11-23 16:52:25 +0100194 __MAX_BPF_ATTACH_TYPE
195};
196
197#define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
198
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700199/* cgroup-bpf attach flags used in BPF_PROG_ATTACH command
200 *
201 * NONE(default): No further bpf programs allowed in the subtree.
202 *
203 * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program,
204 * the program in this cgroup yields to sub-cgroup program.
205 *
206 * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program,
207 * that cgroup program gets run in addition to the program in this cgroup.
208 *
209 * Only one program is allowed to be attached to a cgroup with
210 * NONE or BPF_F_ALLOW_OVERRIDE flag.
211 * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will
212 * release old program and attach the new one. Attach flags has to match.
213 *
214 * Multiple programs are allowed to be attached to a cgroup with
215 * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order
216 * (those that were attached first, run first)
217 * The programs of sub-cgroup are executed first, then programs of
218 * this cgroup and then programs of parent cgroup.
219 * When children program makes decision (like picking TCP CA or sock bind)
220 * parent program has a chance to override it.
221 *
222 * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups.
223 * A cgroup with NONE doesn't allow any programs in sub-cgroups.
224 * Ex1:
225 * cgrp1 (MULTI progs A, B) ->
226 * cgrp2 (OVERRIDE prog C) ->
227 * cgrp3 (MULTI prog D) ->
228 * cgrp4 (OVERRIDE prog E) ->
229 * cgrp5 (NONE prog F)
230 * the event in cgrp5 triggers execution of F,D,A,B in that order.
231 * if prog F is detached, the execution is E,D,A,B
232 * if prog F and D are detached, the execution is E,A,B
233 * if prog F, E and D are detached, the execution is C,A,B
234 *
235 * All eligible programs are executed regardless of return code from
236 * earlier programs.
Alexei Starovoitov7f677632017-02-10 20:28:24 -0800237 */
238#define BPF_F_ALLOW_OVERRIDE (1U << 0)
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700239#define BPF_F_ALLOW_MULTI (1U << 1)
Alexei Starovoitov7f677632017-02-10 20:28:24 -0800240
David S. Millere07b98d2017-05-10 11:38:07 -0700241/* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
242 * verifier will perform strict alignment checking as if the kernel
243 * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
244 * and NET_IP_ALIGN defined to 2.
245 */
246#define BPF_F_STRICT_ALIGNMENT (1U << 0)
247
David Millere9ee9ef2018-11-30 21:08:14 -0800248/* If BPF_F_ANY_ALIGNMENT is used in BPF_PROF_LOAD command, the
249 * verifier will allow any alignment whatsoever. On platforms
250 * with strict alignment requirements for loads ands stores (such
251 * as sparc and mips) the verifier validates that all loads and
252 * stores provably follow this requirement. This flag turns that
253 * checking and enforcement off.
254 *
255 * It is mostly used for testing when we want to validate the
256 * context and memory access aspects of the verifier, but because
257 * of an unaligned access the alignment check would trigger before
258 * the one we are interested in.
259 */
260#define BPF_F_ANY_ALIGNMENT (1U << 1)
261
Daniel Borkmannd8eca5b2019-04-09 23:20:03 +0200262/* When BPF ldimm64's insn[0].src_reg != 0 then this can have
263 * two extensions:
264 *
265 * insn[0].src_reg: BPF_PSEUDO_MAP_FD BPF_PSEUDO_MAP_VALUE
266 * insn[0].imm: map fd map fd
267 * insn[1].imm: 0 offset into value
268 * insn[0].off: 0 0
269 * insn[1].off: 0 0
270 * ldimm64 rewrite: address of map address of map[0]+offset
271 * verifier type: CONST_PTR_TO_MAP PTR_TO_MAP_VALUE
272 */
Daniel Borkmannf1a66f82015-03-01 12:31:43 +0100273#define BPF_PSEUDO_MAP_FD 1
Daniel Borkmannd8eca5b2019-04-09 23:20:03 +0200274#define BPF_PSEUDO_MAP_VALUE 2
Daniel Borkmannf1a66f82015-03-01 12:31:43 +0100275
Alexei Starovoitovcc8b0b92017-12-14 17:55:05 -0800276/* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative
277 * offset to another bpf function
278 */
279#define BPF_PSEUDO_CALL 1
280
Alexei Starovoitov3274f522014-11-13 17:36:44 -0800281/* flags for BPF_MAP_UPDATE_ELEM command */
282#define BPF_ANY 0 /* create new element or update existing */
283#define BPF_NOEXIST 1 /* create new element if it didn't exist */
284#define BPF_EXIST 2 /* update existing element */
Alexei Starovoitov96049f32019-01-31 15:40:09 -0800285#define BPF_F_LOCK 4 /* spin_lock-ed map_lookup/map_update */
Alexei Starovoitov3274f522014-11-13 17:36:44 -0800286
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700287/* flags for BPF_MAP_CREATE command */
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800288#define BPF_F_NO_PREALLOC (1U << 0)
Martin KaFai Lau29ba7322016-11-11 10:55:09 -0800289/* Instead of having one common LRU list in the
Martin KaFai Lau8f844932016-11-11 10:55:10 -0800290 * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
Martin KaFai Lau29ba7322016-11-11 10:55:09 -0800291 * which can scale and perform better.
292 * Note, the LRU nodes (including free nodes) cannot be moved
293 * across different LRU lists.
294 */
295#define BPF_F_NO_COMMON_LRU (1U << 1)
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700296/* Specify numa node during map creation */
297#define BPF_F_NUMA_NODE (1U << 2)
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800298
Martin KaFai Laucb4d2b32017-09-27 14:37:52 -0700299#define BPF_OBJ_NAME_LEN 16U
300
Daniel Borkmann591fe982019-04-09 23:20:05 +0200301/* Flags for accessing BPF object from syscall side. */
Chenbo Feng6e71b042017-10-18 13:00:22 -0700302#define BPF_F_RDONLY (1U << 3)
303#define BPF_F_WRONLY (1U << 4)
304
Song Liu615755a2018-03-14 10:23:21 -0700305/* Flag for stack_map, store build_id+offset instead of pointer */
306#define BPF_F_STACK_BUILD_ID (1U << 5)
307
Lorenz Bauer96b3b6c2018-11-16 11:41:08 +0000308/* Zero-initialize hash function seed. This should only be used for testing. */
309#define BPF_F_ZERO_SEED (1U << 6)
310
Daniel Borkmann591fe982019-04-09 23:20:05 +0200311/* Flags for accessing BPF object from program side. */
312#define BPF_F_RDONLY_PROG (1U << 7)
313#define BPF_F_WRONLY_PROG (1U << 8)
314
Lorenz Bauer2f183362018-11-16 11:41:09 +0000315/* flags for BPF_PROG_QUERY */
316#define BPF_F_QUERY_EFFECTIVE (1U << 0)
317
Song Liu615755a2018-03-14 10:23:21 -0700318enum bpf_stack_build_id_status {
319 /* user space need an empty entry to identify end of a trace */
320 BPF_STACK_BUILD_ID_EMPTY = 0,
321 /* with valid build_id and offset */
322 BPF_STACK_BUILD_ID_VALID = 1,
323 /* couldn't get build_id, fallback to ip */
324 BPF_STACK_BUILD_ID_IP = 2,
325};
326
327#define BPF_BUILD_ID_SIZE 20
328struct bpf_stack_build_id {
329 __s32 status;
330 unsigned char build_id[BPF_BUILD_ID_SIZE];
331 union {
332 __u64 offset;
333 __u64 ip;
334 };
335};
336
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700337union bpf_attr {
338 struct { /* anonymous struct used by BPF_MAP_CREATE command */
339 __u32 map_type; /* one of enum bpf_map_type */
340 __u32 key_size; /* size of key in bytes */
341 __u32 value_size; /* size of value in bytes */
342 __u32 max_entries; /* max number of entries in a map */
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700343 __u32 map_flags; /* BPF_MAP_CREATE related
344 * flags defined above.
345 */
Martin KaFai Lau56f668d2017-03-22 10:00:33 -0700346 __u32 inner_map_fd; /* fd pointing to the inner map */
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700347 __u32 numa_node; /* numa node (effective only if
348 * BPF_F_NUMA_NODE is set).
349 */
Martin KaFai Lau067cae42017-10-05 21:52:12 -0700350 char map_name[BPF_OBJ_NAME_LEN];
Jakub Kicinskia3884572018-01-11 20:29:09 -0800351 __u32 map_ifindex; /* ifindex of netdev to create on */
Martin KaFai Laua26ca7c2018-04-18 15:56:03 -0700352 __u32 btf_fd; /* fd pointing to a BTF type data */
Martin KaFai Lau9b2cf322018-05-22 14:57:21 -0700353 __u32 btf_key_type_id; /* BTF type_id of the key */
354 __u32 btf_value_type_id; /* BTF type_id of the value */
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700355 };
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -0700356
357 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
358 __u32 map_fd;
359 __aligned_u64 key;
360 union {
361 __aligned_u64 value;
362 __aligned_u64 next_key;
363 };
Alexei Starovoitov3274f522014-11-13 17:36:44 -0800364 __u64 flags;
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -0700365 };
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700366
367 struct { /* anonymous struct used by BPF_PROG_LOAD command */
368 __u32 prog_type; /* one of enum bpf_prog_type */
369 __u32 insn_cnt;
370 __aligned_u64 insns;
371 __aligned_u64 license;
Alexei Starovoitovcbd35702014-09-26 00:17:03 -0700372 __u32 log_level; /* verbosity level of verifier */
373 __u32 log_size; /* size of user buffer */
374 __aligned_u64 log_buf; /* user supplied buffer */
Daniel Borkmann6c4fc202018-12-16 00:49:47 +0100375 __u32 kern_version; /* not used */
David S. Millere07b98d2017-05-10 11:38:07 -0700376 __u32 prog_flags;
Martin KaFai Lau067cae42017-10-05 21:52:12 -0700377 char prog_name[BPF_OBJ_NAME_LEN];
Jakub Kicinski1f6f4cb2017-11-20 15:21:53 -0800378 __u32 prog_ifindex; /* ifindex of netdev to prep for */
Andrey Ignatov5e43f892018-03-30 15:08:00 -0700379 /* For some prog types expected attach type must be known at
380 * load time to verify attach type specific parts of prog
381 * (context accesses, allowed helpers, etc).
382 */
383 __u32 expected_attach_type;
Yonghong Song838e9692018-11-19 15:29:11 -0800384 __u32 prog_btf_fd; /* fd pointing to BTF type data */
385 __u32 func_info_rec_size; /* userspace bpf_func_info size */
386 __aligned_u64 func_info; /* func info */
387 __u32 func_info_cnt; /* number of bpf_func_info records */
Martin KaFai Lauc454a462018-12-07 16:42:25 -0800388 __u32 line_info_rec_size; /* userspace bpf_line_info size */
389 __aligned_u64 line_info; /* line info */
390 __u32 line_info_cnt; /* number of bpf_line_info records */
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700391 };
Daniel Borkmannb2197752015-10-29 14:58:09 +0100392
393 struct { /* anonymous struct used by BPF_OBJ_* commands */
394 __aligned_u64 pathname;
395 __u32 bpf_fd;
Chenbo Feng6e71b042017-10-18 13:00:22 -0700396 __u32 file_flags;
Daniel Borkmannb2197752015-10-29 14:58:09 +0100397 };
Daniel Mackf4324552016-11-23 16:52:27 +0100398
399 struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
400 __u32 target_fd; /* container object to attach to */
401 __u32 attach_bpf_fd; /* eBPF program to attach */
402 __u32 attach_type;
Alexei Starovoitov7f677632017-02-10 20:28:24 -0800403 __u32 attach_flags;
Daniel Mackf4324552016-11-23 16:52:27 +0100404 };
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700405
406 struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
407 __u32 prog_fd;
408 __u32 retval;
Lorenz Bauerb5a36b12018-12-03 11:31:23 +0000409 __u32 data_size_in; /* input: len of data_in */
410 __u32 data_size_out; /* input/output: len of data_out
411 * returns ENOSPC if data_out
412 * is too small.
413 */
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700414 __aligned_u64 data_in;
415 __aligned_u64 data_out;
416 __u32 repeat;
417 __u32 duration;
Stanislav Fomichevb0b93952019-04-09 11:49:09 -0700418 __u32 ctx_size_in; /* input: len of ctx_in */
419 __u32 ctx_size_out; /* input/output: len of ctx_out
420 * returns ENOSPC if ctx_out
421 * is too small.
422 */
423 __aligned_u64 ctx_in;
424 __aligned_u64 ctx_out;
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700425 } test;
Martin KaFai Lau34ad5582017-06-05 12:15:48 -0700426
Martin KaFai Laub16d9aa2017-06-05 12:15:49 -0700427 struct { /* anonymous struct used by BPF_*_GET_*_ID */
428 union {
429 __u32 start_id;
430 __u32 prog_id;
Martin KaFai Laubd5f5f4e2017-06-05 12:15:50 -0700431 __u32 map_id;
Martin KaFai Lau78958fc2018-05-04 14:49:51 -0700432 __u32 btf_id;
Martin KaFai Laub16d9aa2017-06-05 12:15:49 -0700433 };
Martin KaFai Lau34ad5582017-06-05 12:15:48 -0700434 __u32 next_id;
Chenbo Feng6e71b042017-10-18 13:00:22 -0700435 __u32 open_flags;
Martin KaFai Lau34ad5582017-06-05 12:15:48 -0700436 };
Martin KaFai Lau1e270972017-06-05 12:15:52 -0700437
438 struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
439 __u32 bpf_fd;
440 __u32 info_len;
441 __aligned_u64 info;
442 } info;
Alexei Starovoitov468e2f62017-10-02 22:50:22 -0700443
444 struct { /* anonymous struct used by BPF_PROG_QUERY command */
445 __u32 target_fd; /* container object to query */
446 __u32 attach_type;
447 __u32 query_flags;
448 __u32 attach_flags;
449 __aligned_u64 prog_ids;
450 __u32 prog_cnt;
451 } query;
Alexei Starovoitovc4f66992018-03-28 12:05:37 -0700452
453 struct {
454 __u64 name;
455 __u32 prog_fd;
456 } raw_tracepoint;
Martin KaFai Lauf56a6532018-04-18 15:56:01 -0700457
458 struct { /* anonymous struct for BPF_BTF_LOAD */
459 __aligned_u64 btf;
460 __aligned_u64 btf_log_buf;
461 __u32 btf_size;
462 __u32 btf_log_size;
463 __u32 btf_log_level;
464 };
Yonghong Song41bdc4b2018-05-24 11:21:09 -0700465
466 struct {
467 __u32 pid; /* input: pid */
468 __u32 fd; /* input: fd */
469 __u32 flags; /* input: flags */
470 __u32 buf_len; /* input/output: buf len */
471 __aligned_u64 buf; /* input/output:
472 * tp_name for tracepoint
473 * symbol for kprobe
474 * filename for uprobe
475 */
476 __u32 prog_id; /* output: prod_id */
477 __u32 fd_type; /* output: BPF_FD_TYPE_* */
478 __u64 probe_offset; /* output: probe_offset */
479 __u64 probe_addr; /* output: probe_addr */
480 } task_fd_query;
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700481} __attribute__((aligned(8)));
482
Quentin Monnet56a092c2018-04-25 18:16:52 +0100483/* The description below is an attempt at providing documentation to eBPF
484 * developers about the multiple available eBPF helper functions. It can be
485 * parsed and used to produce a manual page. The workflow is the following,
486 * and requires the rst2man utility:
Thomas Grafebb676d2016-10-27 11:23:51 +0200487 *
Quentin Monnet56a092c2018-04-25 18:16:52 +0100488 * $ ./scripts/bpf_helpers_doc.py \
489 * --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst
490 * $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7
491 * $ man /tmp/bpf-helpers.7
Thomas Grafebb676d2016-10-27 11:23:51 +0200492 *
Quentin Monnet56a092c2018-04-25 18:16:52 +0100493 * Note that in order to produce this external documentation, some RST
494 * formatting is used in the descriptions to get "bold" and "italics" in
495 * manual pages. Also note that the few trailing white spaces are
496 * intentional, removing them would break paragraphs for rst2man.
Thomas Grafebb676d2016-10-27 11:23:51 +0200497 *
Quentin Monnet56a092c2018-04-25 18:16:52 +0100498 * Start of BPF helper function descriptions:
Quentin Monnetad4a5222018-04-25 18:16:53 +0100499 *
500 * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key)
501 * Description
502 * Perform a lookup in *map* for an entry associated to *key*.
503 * Return
504 * Map value associated to *key*, or **NULL** if no entry was
505 * found.
506 *
507 * int bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags)
508 * Description
509 * Add or update the value of the entry associated to *key* in
510 * *map* with *value*. *flags* is one of:
511 *
512 * **BPF_NOEXIST**
513 * The entry for *key* must not exist in the map.
514 * **BPF_EXIST**
515 * The entry for *key* must already exist in the map.
516 * **BPF_ANY**
517 * No condition on the existence of the entry for *key*.
518 *
519 * Flag value **BPF_NOEXIST** cannot be used for maps of types
520 * **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY** (all
521 * elements always exist), the helper would return an error.
522 * Return
523 * 0 on success, or a negative error in case of failure.
524 *
525 * int bpf_map_delete_elem(struct bpf_map *map, const void *key)
526 * Description
527 * Delete entry with *key* from *map*.
528 * Return
529 * 0 on success, or a negative error in case of failure.
530 *
531 * int bpf_probe_read(void *dst, u32 size, const void *src)
532 * Description
533 * For tracing programs, safely attempt to read *size* bytes from
534 * address *src* and store the data in *dst*.
535 * Return
536 * 0 on success, or a negative error in case of failure.
537 *
538 * u64 bpf_ktime_get_ns(void)
539 * Description
540 * Return the time elapsed since system boot, in nanoseconds.
541 * Return
542 * Current *ktime*.
543 *
544 * int bpf_trace_printk(const char *fmt, u32 fmt_size, ...)
545 * Description
546 * This helper is a "printk()-like" facility for debugging. It
547 * prints a message defined by format *fmt* (of size *fmt_size*)
548 * to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if
549 * available. It can take up to three additional **u64**
550 * arguments (as an eBPF helpers, the total number of arguments is
551 * limited to five).
552 *
553 * Each time the helper is called, it appends a line to the trace.
554 * The format of the trace is customizable, and the exact output
555 * one will get depends on the options set in
556 * *\/sys/kernel/debug/tracing/trace_options* (see also the
557 * *README* file under the same directory). However, it usually
558 * defaults to something like:
559 *
560 * ::
561 *
562 * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg>
563 *
564 * In the above:
565 *
566 * * ``telnet`` is the name of the current task.
567 * * ``470`` is the PID of the current task.
568 * * ``001`` is the CPU number on which the task is
569 * running.
570 * * In ``.N..``, each character refers to a set of
571 * options (whether irqs are enabled, scheduling
572 * options, whether hard/softirqs are running, level of
573 * preempt_disabled respectively). **N** means that
574 * **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED**
575 * are set.
576 * * ``419421.045894`` is a timestamp.
577 * * ``0x00000001`` is a fake value used by BPF for the
578 * instruction pointer register.
579 * * ``<formatted msg>`` is the message formatted with
580 * *fmt*.
581 *
582 * The conversion specifiers supported by *fmt* are similar, but
583 * more limited than for printk(). They are **%d**, **%i**,
584 * **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**,
585 * **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size
586 * of field, padding with zeroes, etc.) is available, and the
587 * helper will return **-EINVAL** (but print nothing) if it
588 * encounters an unknown specifier.
589 *
590 * Also, note that **bpf_trace_printk**\ () is slow, and should
591 * only be used for debugging purposes. For this reason, a notice
592 * bloc (spanning several lines) is printed to kernel logs and
593 * states that the helper should not be used "for production use"
594 * the first time this helper is used (or more precisely, when
595 * **trace_printk**\ () buffers are allocated). For passing values
596 * to user space, perf events should be preferred.
597 * Return
598 * The number of bytes written to the buffer, or a negative error
599 * in case of failure.
600 *
Quentin Monnet1fdd08b2018-04-25 18:16:55 +0100601 * u32 bpf_get_prandom_u32(void)
602 * Description
603 * Get a pseudo-random number.
604 *
605 * From a security point of view, this helper uses its own
606 * pseudo-random internal state, and cannot be used to infer the
607 * seed of other random functions in the kernel. However, it is
608 * essential to note that the generator used by the helper is not
609 * cryptographically secure.
610 * Return
611 * A random 32-bit unsigned value.
612 *
613 * u32 bpf_get_smp_processor_id(void)
614 * Description
615 * Get the SMP (symmetric multiprocessing) processor id. Note that
616 * all programs run with preemption disabled, which means that the
617 * SMP processor id is stable during all the execution of the
618 * program.
619 * Return
620 * The SMP id of the processor running the program.
621 *
Quentin Monnetad4a5222018-04-25 18:16:53 +0100622 * int bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags)
623 * Description
624 * Store *len* bytes from address *from* into the packet
625 * associated to *skb*, at *offset*. *flags* are a combination of
626 * **BPF_F_RECOMPUTE_CSUM** (automatically recompute the
627 * checksum for the packet after storing the bytes) and
628 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
629 * **->swhash** and *skb*\ **->l4hash** to 0).
630 *
631 * A call to this helper is susceptible to change the underlaying
632 * packet buffer. Therefore, at load time, all checks on pointers
633 * previously done by the verifier are invalidated and must be
634 * performed again, if the helper is used in combination with
635 * direct packet access.
636 * Return
637 * 0 on success, or a negative error in case of failure.
638 *
639 * int bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size)
640 * Description
641 * Recompute the layer 3 (e.g. IP) checksum for the packet
642 * associated to *skb*. Computation is incremental, so the helper
643 * must know the former value of the header field that was
644 * modified (*from*), the new value of this field (*to*), and the
645 * number of bytes (2 or 4) for this field, stored in *size*.
646 * Alternatively, it is possible to store the difference between
647 * the previous and the new values of the header field in *to*, by
648 * setting *from* and *size* to 0. For both methods, *offset*
649 * indicates the location of the IP checksum within the packet.
650 *
651 * This helper works in combination with **bpf_csum_diff**\ (),
652 * which does not update the checksum in-place, but offers more
653 * flexibility and can handle sizes larger than 2 or 4 for the
654 * checksum to update.
655 *
656 * A call to this helper is susceptible to change the underlaying
657 * packet buffer. Therefore, at load time, all checks on pointers
658 * previously done by the verifier are invalidated and must be
659 * performed again, if the helper is used in combination with
660 * direct packet access.
661 * Return
662 * 0 on success, or a negative error in case of failure.
663 *
664 * int bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags)
665 * Description
666 * Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the
667 * packet associated to *skb*. Computation is incremental, so the
668 * helper must know the former value of the header field that was
669 * modified (*from*), the new value of this field (*to*), and the
670 * number of bytes (2 or 4) for this field, stored on the lowest
671 * four bits of *flags*. Alternatively, it is possible to store
672 * the difference between the previous and the new values of the
673 * header field in *to*, by setting *from* and the four lowest
674 * bits of *flags* to 0. For both methods, *offset* indicates the
675 * location of the IP checksum within the packet. In addition to
676 * the size of the field, *flags* can be added (bitwise OR) actual
677 * flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left
678 * untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and
679 * for updates resulting in a null checksum the value is set to
680 * **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates
681 * the checksum is to be computed against a pseudo-header.
682 *
683 * This helper works in combination with **bpf_csum_diff**\ (),
684 * which does not update the checksum in-place, but offers more
685 * flexibility and can handle sizes larger than 2 or 4 for the
686 * checksum to update.
687 *
688 * A call to this helper is susceptible to change the underlaying
689 * packet buffer. Therefore, at load time, all checks on pointers
690 * previously done by the verifier are invalidated and must be
691 * performed again, if the helper is used in combination with
692 * direct packet access.
693 * Return
694 * 0 on success, or a negative error in case of failure.
695 *
696 * int bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index)
697 * Description
698 * This special helper is used to trigger a "tail call", or in
699 * other words, to jump into another eBPF program. The same stack
700 * frame is used (but values on stack and in registers for the
701 * caller are not accessible to the callee). This mechanism allows
702 * for program chaining, either for raising the maximum number of
703 * available eBPF instructions, or to execute given programs in
704 * conditional blocks. For security reasons, there is an upper
705 * limit to the number of successive tail calls that can be
706 * performed.
707 *
708 * Upon call of this helper, the program attempts to jump into a
709 * program referenced at index *index* in *prog_array_map*, a
710 * special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes
711 * *ctx*, a pointer to the context.
712 *
713 * If the call succeeds, the kernel immediately runs the first
714 * instruction of the new program. This is not a function call,
715 * and it never returns to the previous program. If the call
716 * fails, then the helper has no effect, and the caller continues
717 * to run its subsequent instructions. A call can fail if the
718 * destination program for the jump does not exist (i.e. *index*
719 * is superior to the number of entries in *prog_array_map*), or
720 * if the maximum number of tail calls has been reached for this
721 * chain of programs. This limit is defined in the kernel by the
722 * macro **MAX_TAIL_CALL_CNT** (not accessible to user space),
723 * which is currently set to 32.
724 * Return
725 * 0 on success, or a negative error in case of failure.
726 *
727 * int bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags)
728 * Description
729 * Clone and redirect the packet associated to *skb* to another
730 * net device of index *ifindex*. Both ingress and egress
731 * interfaces can be used for redirection. The **BPF_F_INGRESS**
732 * value in *flags* is used to make the distinction (ingress path
733 * is selected if the flag is present, egress path otherwise).
734 * This is the only flag supported for now.
735 *
736 * In comparison with **bpf_redirect**\ () helper,
737 * **bpf_clone_redirect**\ () has the associated cost of
738 * duplicating the packet buffer, but this can be executed out of
739 * the eBPF program. Conversely, **bpf_redirect**\ () is more
740 * efficient, but it is handled through an action code where the
741 * redirection happens only after the eBPF program has returned.
742 *
743 * A call to this helper is susceptible to change the underlaying
744 * packet buffer. Therefore, at load time, all checks on pointers
745 * previously done by the verifier are invalidated and must be
746 * performed again, if the helper is used in combination with
747 * direct packet access.
748 * Return
749 * 0 on success, or a negative error in case of failure.
Quentin Monnetc456dec2018-04-25 18:16:54 +0100750 *
751 * u64 bpf_get_current_pid_tgid(void)
752 * Return
753 * A 64-bit integer containing the current tgid and pid, and
754 * created as such:
755 * *current_task*\ **->tgid << 32 \|**
756 * *current_task*\ **->pid**.
757 *
758 * u64 bpf_get_current_uid_gid(void)
759 * Return
760 * A 64-bit integer containing the current GID and UID, and
761 * created as such: *current_gid* **<< 32 \|** *current_uid*.
762 *
763 * int bpf_get_current_comm(char *buf, u32 size_of_buf)
764 * Description
765 * Copy the **comm** attribute of the current task into *buf* of
766 * *size_of_buf*. The **comm** attribute contains the name of
767 * the executable (excluding the path) for the current task. The
768 * *size_of_buf* must be strictly positive. On success, the
769 * helper makes sure that the *buf* is NUL-terminated. On failure,
770 * it is filled with zeroes.
771 * Return
772 * 0 on success, or a negative error in case of failure.
773 *
Quentin Monnet1fdd08b2018-04-25 18:16:55 +0100774 * u32 bpf_get_cgroup_classid(struct sk_buff *skb)
775 * Description
776 * Retrieve the classid for the current task, i.e. for the net_cls
777 * cgroup to which *skb* belongs.
778 *
779 * This helper can be used on TC egress path, but not on ingress.
780 *
781 * The net_cls cgroup provides an interface to tag network packets
782 * based on a user-provided identifier for all traffic coming from
783 * the tasks belonging to the related cgroup. See also the related
784 * kernel documentation, available from the Linux sources in file
785 * *Documentation/cgroup-v1/net_cls.txt*.
786 *
787 * The Linux kernel has two versions for cgroups: there are
788 * cgroups v1 and cgroups v2. Both are available to users, who can
789 * use a mixture of them, but note that the net_cls cgroup is for
790 * cgroup v1 only. This makes it incompatible with BPF programs
791 * run on cgroups, which is a cgroup-v2-only feature (a socket can
792 * only hold data for one version of cgroups at a time).
793 *
794 * This helper is only available is the kernel was compiled with
795 * the **CONFIG_CGROUP_NET_CLASSID** configuration option set to
796 * "**y**" or to "**m**".
797 * Return
798 * The classid, or 0 for the default unconfigured classid.
799 *
Quentin Monnetc456dec2018-04-25 18:16:54 +0100800 * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci)
801 * Description
802 * Push a *vlan_tci* (VLAN tag control information) of protocol
803 * *vlan_proto* to the packet associated to *skb*, then update
804 * the checksum. Note that if *vlan_proto* is different from
805 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
806 * be **ETH_P_8021Q**.
807 *
808 * A call to this helper is susceptible to change the underlaying
809 * packet buffer. Therefore, at load time, all checks on pointers
810 * previously done by the verifier are invalidated and must be
811 * performed again, if the helper is used in combination with
812 * direct packet access.
813 * Return
814 * 0 on success, or a negative error in case of failure.
815 *
816 * int bpf_skb_vlan_pop(struct sk_buff *skb)
817 * Description
818 * Pop a VLAN header from the packet associated to *skb*.
819 *
820 * A call to this helper is susceptible to change the underlaying
821 * packet buffer. Therefore, at load time, all checks on pointers
822 * previously done by the verifier are invalidated and must be
823 * performed again, if the helper is used in combination with
824 * direct packet access.
825 * Return
826 * 0 on success, or a negative error in case of failure.
827 *
828 * int bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
829 * Description
830 * Get tunnel metadata. This helper takes a pointer *key* to an
831 * empty **struct bpf_tunnel_key** of **size**, that will be
832 * filled with tunnel metadata for the packet associated to *skb*.
833 * The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which
834 * indicates that the tunnel is based on IPv6 protocol instead of
835 * IPv4.
836 *
837 * The **struct bpf_tunnel_key** is an object that generalizes the
838 * principal parameters used by various tunneling protocols into a
839 * single struct. This way, it can be used to easily make a
840 * decision based on the contents of the encapsulation header,
841 * "summarized" in this struct. In particular, it holds the IP
842 * address of the remote end (IPv4 or IPv6, depending on the case)
843 * in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also,
844 * this struct exposes the *key*\ **->tunnel_id**, which is
845 * generally mapped to a VNI (Virtual Network Identifier), making
846 * it programmable together with the **bpf_skb_set_tunnel_key**\
847 * () helper.
848 *
849 * Let's imagine that the following code is part of a program
850 * attached to the TC ingress interface, on one end of a GRE
851 * tunnel, and is supposed to filter out all messages coming from
852 * remote ends with IPv4 address other than 10.0.0.1:
853 *
854 * ::
855 *
856 * int ret;
857 * struct bpf_tunnel_key key = {};
858 *
859 * ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0);
860 * if (ret < 0)
861 * return TC_ACT_SHOT; // drop packet
862 *
863 * if (key.remote_ipv4 != 0x0a000001)
864 * return TC_ACT_SHOT; // drop packet
865 *
866 * return TC_ACT_OK; // accept packet
867 *
868 * This interface can also be used with all encapsulation devices
869 * that can operate in "collect metadata" mode: instead of having
870 * one network device per specific configuration, the "collect
871 * metadata" mode only requires a single device where the
872 * configuration can be extracted from this helper.
873 *
874 * This can be used together with various tunnels such as VXLan,
875 * Geneve, GRE or IP in IP (IPIP).
876 * Return
877 * 0 on success, or a negative error in case of failure.
878 *
879 * int bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
880 * Description
881 * Populate tunnel metadata for packet associated to *skb.* The
882 * tunnel metadata is set to the contents of *key*, of *size*. The
883 * *flags* can be set to a combination of the following values:
884 *
885 * **BPF_F_TUNINFO_IPV6**
886 * Indicate that the tunnel is based on IPv6 protocol
887 * instead of IPv4.
888 * **BPF_F_ZERO_CSUM_TX**
889 * For IPv4 packets, add a flag to tunnel metadata
890 * indicating that checksum computation should be skipped
891 * and checksum set to zeroes.
892 * **BPF_F_DONT_FRAGMENT**
893 * Add a flag to tunnel metadata indicating that the
894 * packet should not be fragmented.
895 * **BPF_F_SEQ_NUMBER**
896 * Add a flag to tunnel metadata indicating that a
897 * sequence number should be added to tunnel header before
898 * sending the packet. This flag was added for GRE
899 * encapsulation, but might be used with other protocols
900 * as well in the future.
901 *
902 * Here is a typical usage on the transmit path:
903 *
904 * ::
905 *
906 * struct bpf_tunnel_key key;
907 * populate key ...
908 * bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0);
909 * bpf_clone_redirect(skb, vxlan_dev_ifindex, 0);
910 *
911 * See also the description of the **bpf_skb_get_tunnel_key**\ ()
912 * helper for additional information.
913 * Return
914 * 0 on success, or a negative error in case of failure.
915 *
Quentin Monnetc6b5fb82018-04-25 18:16:57 +0100916 * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags)
917 * Description
918 * Read the value of a perf event counter. This helper relies on a
919 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of
920 * the perf event counter is selected when *map* is updated with
921 * perf event file descriptors. The *map* is an array whose size
922 * is the number of available CPUs, and each cell contains a value
923 * relative to one CPU. The value to retrieve is indicated by
924 * *flags*, that contains the index of the CPU to look up, masked
925 * with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
926 * **BPF_F_CURRENT_CPU** to indicate that the value for the
927 * current CPU should be retrieved.
928 *
929 * Note that before Linux 4.13, only hardware perf event can be
930 * retrieved.
931 *
932 * Also, be aware that the newer helper
933 * **bpf_perf_event_read_value**\ () is recommended over
Quentin Monnet3bd5a092018-04-30 11:39:03 +0100934 * **bpf_perf_event_read**\ () in general. The latter has some ABI
Quentin Monnetc6b5fb82018-04-25 18:16:57 +0100935 * quirks where error and counter value are used as a return code
936 * (which is wrong to do since ranges may overlap). This issue is
Quentin Monnet3bd5a092018-04-30 11:39:03 +0100937 * fixed with **bpf_perf_event_read_value**\ (), which at the same
938 * time provides more features over the **bpf_perf_event_read**\
939 * () interface. Please refer to the description of
Quentin Monnetc6b5fb82018-04-25 18:16:57 +0100940 * **bpf_perf_event_read_value**\ () for details.
941 * Return
942 * The value of the perf event counter read from the map, or a
943 * negative error code in case of failure.
944 *
Quentin Monnetc456dec2018-04-25 18:16:54 +0100945 * int bpf_redirect(u32 ifindex, u64 flags)
946 * Description
947 * Redirect the packet to another net device of index *ifindex*.
948 * This helper is somewhat similar to **bpf_clone_redirect**\
949 * (), except that the packet is not cloned, which provides
950 * increased performance.
951 *
952 * Except for XDP, both ingress and egress interfaces can be used
953 * for redirection. The **BPF_F_INGRESS** value in *flags* is used
954 * to make the distinction (ingress path is selected if the flag
955 * is present, egress path otherwise). Currently, XDP only
956 * supports redirection to the egress interface, and accepts no
957 * flag at all.
958 *
959 * The same effect can be attained with the more generic
960 * **bpf_redirect_map**\ (), which requires specific maps to be
961 * used but offers better performance.
962 * Return
963 * For XDP, the helper returns **XDP_REDIRECT** on success or
964 * **XDP_ABORTED** on error. For other program types, the values
965 * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on
966 * error.
967 *
Quentin Monnet1fdd08b2018-04-25 18:16:55 +0100968 * u32 bpf_get_route_realm(struct sk_buff *skb)
969 * Description
970 * Retrieve the realm or the route, that is to say the
971 * **tclassid** field of the destination for the *skb*. The
972 * indentifier retrieved is a user-provided tag, similar to the
973 * one used with the net_cls cgroup (see description for
974 * **bpf_get_cgroup_classid**\ () helper), but here this tag is
975 * held by a route (a destination entry), not by a task.
976 *
977 * Retrieving this identifier works with the clsact TC egress hook
978 * (see also **tc-bpf(8)**), or alternatively on conventional
979 * classful egress qdiscs, but not on TC ingress path. In case of
980 * clsact TC egress hook, this has the advantage that, internally,
981 * the destination entry has not been dropped yet in the transmit
982 * path. Therefore, the destination entry does not need to be
983 * artificially held via **netif_keep_dst**\ () for a classful
984 * qdisc until the *skb* is freed.
985 *
986 * This helper is available only if the kernel was compiled with
987 * **CONFIG_IP_ROUTE_CLASSID** configuration option.
988 * Return
989 * The realm of the route for the packet associated to *skb*, or 0
990 * if none was found.
991 *
Quentin Monnetc456dec2018-04-25 18:16:54 +0100992 * int bpf_perf_event_output(struct pt_reg *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
993 * Description
994 * Write raw *data* blob into a special BPF perf event held by
995 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
996 * event must have the following attributes: **PERF_SAMPLE_RAW**
997 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
998 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
999 *
1000 * The *flags* are used to indicate the index in *map* for which
1001 * the value must be put, masked with **BPF_F_INDEX_MASK**.
1002 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
1003 * to indicate that the index of the current CPU core should be
1004 * used.
1005 *
1006 * The value to write, of *size*, is passed through eBPF stack and
1007 * pointed by *data*.
1008 *
1009 * The context of the program *ctx* needs also be passed to the
1010 * helper.
1011 *
1012 * On user space, a program willing to read the values needs to
1013 * call **perf_event_open**\ () on the perf event (either for
1014 * one or for all CPUs) and to store the file descriptor into the
1015 * *map*. This must be done before the eBPF program can send data
1016 * into it. An example is available in file
1017 * *samples/bpf/trace_output_user.c* in the Linux kernel source
1018 * tree (the eBPF program counterpart is in
1019 * *samples/bpf/trace_output_kern.c*).
1020 *
1021 * **bpf_perf_event_output**\ () achieves better performance
1022 * than **bpf_trace_printk**\ () for sharing data with user
1023 * space, and is much better suitable for streaming data from eBPF
1024 * programs.
1025 *
1026 * Note that this helper is not restricted to tracing use cases
1027 * and can be used with programs attached to TC or XDP as well,
1028 * where it allows for passing data to user space listeners. Data
1029 * can be:
1030 *
1031 * * Only custom structs,
1032 * * Only the packet payload, or
1033 * * A combination of both.
1034 * Return
1035 * 0 on success, or a negative error in case of failure.
1036 *
Quentin Monnet1fdd08b2018-04-25 18:16:55 +01001037 * int bpf_skb_load_bytes(const struct sk_buff *skb, u32 offset, void *to, u32 len)
1038 * Description
1039 * This helper was provided as an easy way to load data from a
1040 * packet. It can be used to load *len* bytes from *offset* from
1041 * the packet associated to *skb*, into the buffer pointed by
1042 * *to*.
1043 *
1044 * Since Linux 4.7, usage of this helper has mostly been replaced
1045 * by "direct packet access", enabling packet data to be
1046 * manipulated with *skb*\ **->data** and *skb*\ **->data_end**
1047 * pointing respectively to the first byte of packet data and to
1048 * the byte after the last byte of packet data. However, it
1049 * remains useful if one wishes to read large quantities of data
1050 * at once from a packet into the eBPF stack.
1051 * Return
1052 * 0 on success, or a negative error in case of failure.
1053 *
Quentin Monnetc456dec2018-04-25 18:16:54 +01001054 * int bpf_get_stackid(struct pt_reg *ctx, struct bpf_map *map, u64 flags)
1055 * Description
1056 * Walk a user or a kernel stack and return its id. To achieve
1057 * this, the helper needs *ctx*, which is a pointer to the context
1058 * on which the tracing program is executed, and a pointer to a
1059 * *map* of type **BPF_MAP_TYPE_STACK_TRACE**.
1060 *
1061 * The last argument, *flags*, holds the number of stack frames to
1062 * skip (from 0 to 255), masked with
1063 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
1064 * a combination of the following flags:
1065 *
1066 * **BPF_F_USER_STACK**
1067 * Collect a user space stack instead of a kernel stack.
1068 * **BPF_F_FAST_STACK_CMP**
1069 * Compare stacks by hash only.
1070 * **BPF_F_REUSE_STACKID**
1071 * If two different stacks hash into the same *stackid*,
1072 * discard the old one.
1073 *
1074 * The stack id retrieved is a 32 bit long integer handle which
1075 * can be further combined with other data (including other stack
1076 * ids) and used as a key into maps. This can be useful for
1077 * generating a variety of graphs (such as flame graphs or off-cpu
1078 * graphs).
1079 *
1080 * For walking a stack, this helper is an improvement over
1081 * **bpf_probe_read**\ (), which can be used with unrolled loops
1082 * but is not efficient and consumes a lot of eBPF instructions.
1083 * Instead, **bpf_get_stackid**\ () can collect up to
1084 * **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that
1085 * this limit can be controlled with the **sysctl** program, and
1086 * that it should be manually increased in order to profile long
1087 * user stacks (such as stacks for Java programs). To do so, use:
1088 *
1089 * ::
1090 *
1091 * # sysctl kernel.perf_event_max_stack=<new value>
Quentin Monnetc456dec2018-04-25 18:16:54 +01001092 * Return
1093 * The positive or null stack id on success, or a negative error
1094 * in case of failure.
1095 *
Quentin Monnet1fdd08b2018-04-25 18:16:55 +01001096 * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed)
1097 * Description
1098 * Compute a checksum difference, from the raw buffer pointed by
1099 * *from*, of length *from_size* (that must be a multiple of 4),
1100 * towards the raw buffer pointed by *to*, of size *to_size*
1101 * (same remark). An optional *seed* can be added to the value
1102 * (this can be cascaded, the seed may come from a previous call
1103 * to the helper).
1104 *
1105 * This is flexible enough to be used in several ways:
1106 *
1107 * * With *from_size* == 0, *to_size* > 0 and *seed* set to
1108 * checksum, it can be used when pushing new data.
1109 * * With *from_size* > 0, *to_size* == 0 and *seed* set to
1110 * checksum, it can be used when removing data from a packet.
1111 * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it
1112 * can be used to compute a diff. Note that *from_size* and
1113 * *to_size* do not need to be equal.
1114 *
1115 * This helper can be used in combination with
1116 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to
1117 * which one can feed in the difference computed with
1118 * **bpf_csum_diff**\ ().
1119 * Return
1120 * The checksum result, or a negative error code in case of
1121 * failure.
1122 *
1123 * int bpf_skb_get_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size)
1124 * Description
1125 * Retrieve tunnel options metadata for the packet associated to
1126 * *skb*, and store the raw tunnel option data to the buffer *opt*
1127 * of *size*.
1128 *
1129 * This helper can be used with encapsulation devices that can
1130 * operate in "collect metadata" mode (please refer to the related
1131 * note in the description of **bpf_skb_get_tunnel_key**\ () for
1132 * more details). A particular example where this can be used is
1133 * in combination with the Geneve encapsulation protocol, where it
1134 * allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper)
1135 * and retrieving arbitrary TLVs (Type-Length-Value headers) from
1136 * the eBPF program. This allows for full customization of these
1137 * headers.
1138 * Return
1139 * The size of the option data retrieved.
1140 *
1141 * int bpf_skb_set_tunnel_opt(struct sk_buff *skb, u8 *opt, u32 size)
1142 * Description
1143 * Set tunnel options metadata for the packet associated to *skb*
1144 * to the option data contained in the raw buffer *opt* of *size*.
1145 *
1146 * See also the description of the **bpf_skb_get_tunnel_opt**\ ()
1147 * helper for additional information.
1148 * Return
1149 * 0 on success, or a negative error in case of failure.
1150 *
1151 * int bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags)
1152 * Description
1153 * Change the protocol of the *skb* to *proto*. Currently
1154 * supported are transition from IPv4 to IPv6, and from IPv6 to
1155 * IPv4. The helper takes care of the groundwork for the
1156 * transition, including resizing the socket buffer. The eBPF
1157 * program is expected to fill the new headers, if any, via
1158 * **skb_store_bytes**\ () and to recompute the checksums with
1159 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\
1160 * (). The main case for this helper is to perform NAT64
1161 * operations out of an eBPF program.
1162 *
1163 * Internally, the GSO type is marked as dodgy so that headers are
1164 * checked and segments are recalculated by the GSO/GRO engine.
1165 * The size for GSO target is adapted as well.
1166 *
1167 * All values for *flags* are reserved for future usage, and must
1168 * be left at zero.
1169 *
1170 * A call to this helper is susceptible to change the underlaying
1171 * packet buffer. Therefore, at load time, all checks on pointers
1172 * previously done by the verifier are invalidated and must be
1173 * performed again, if the helper is used in combination with
1174 * direct packet access.
1175 * Return
1176 * 0 on success, or a negative error in case of failure.
1177 *
1178 * int bpf_skb_change_type(struct sk_buff *skb, u32 type)
1179 * Description
1180 * Change the packet type for the packet associated to *skb*. This
1181 * comes down to setting *skb*\ **->pkt_type** to *type*, except
1182 * the eBPF program does not have a write access to *skb*\
1183 * **->pkt_type** beside this helper. Using a helper here allows
1184 * for graceful handling of errors.
1185 *
1186 * The major use case is to change incoming *skb*s to
1187 * **PACKET_HOST** in a programmatic way instead of having to
1188 * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for
1189 * example.
1190 *
1191 * Note that *type* only allows certain values. At this time, they
1192 * are:
1193 *
1194 * **PACKET_HOST**
1195 * Packet is for us.
1196 * **PACKET_BROADCAST**
1197 * Send packet to all.
1198 * **PACKET_MULTICAST**
1199 * Send packet to group.
1200 * **PACKET_OTHERHOST**
1201 * Send packet to someone else.
1202 * Return
1203 * 0 on success, or a negative error in case of failure.
1204 *
Quentin Monnetc6b5fb82018-04-25 18:16:57 +01001205 * int bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index)
1206 * Description
1207 * Check whether *skb* is a descendant of the cgroup2 held by
1208 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
1209 * Return
1210 * The return value depends on the result of the test, and can be:
1211 *
1212 * * 0, if the *skb* failed the cgroup2 descendant test.
1213 * * 1, if the *skb* succeeded the cgroup2 descendant test.
1214 * * A negative error code, if an error occurred.
1215 *
Quentin Monnetfa156012018-04-25 18:16:56 +01001216 * u32 bpf_get_hash_recalc(struct sk_buff *skb)
1217 * Description
1218 * Retrieve the hash of the packet, *skb*\ **->hash**. If it is
1219 * not set, in particular if the hash was cleared due to mangling,
1220 * recompute this hash. Later accesses to the hash can be done
1221 * directly with *skb*\ **->hash**.
1222 *
1223 * Calling **bpf_set_hash_invalid**\ (), changing a packet
1224 * prototype with **bpf_skb_change_proto**\ (), or calling
1225 * **bpf_skb_store_bytes**\ () with the
1226 * **BPF_F_INVALIDATE_HASH** are actions susceptible to clear
1227 * the hash and to trigger a new computation for the next call to
1228 * **bpf_get_hash_recalc**\ ().
1229 * Return
1230 * The 32-bit hash.
1231 *
Quentin Monnetc456dec2018-04-25 18:16:54 +01001232 * u64 bpf_get_current_task(void)
1233 * Return
1234 * A pointer to the current task struct.
Quentin Monnetfa156012018-04-25 18:16:56 +01001235 *
Quentin Monnetc6b5fb82018-04-25 18:16:57 +01001236 * int bpf_probe_write_user(void *dst, const void *src, u32 len)
1237 * Description
1238 * Attempt in a safe way to write *len* bytes from the buffer
1239 * *src* to *dst* in memory. It only works for threads that are in
1240 * user context, and *dst* must be a valid user space address.
1241 *
1242 * This helper should not be used to implement any kind of
1243 * security mechanism because of TOC-TOU attacks, but rather to
1244 * debug, divert, and manipulate execution of semi-cooperative
1245 * processes.
1246 *
1247 * Keep in mind that this feature is meant for experiments, and it
1248 * has a risk of crashing the system and running programs.
1249 * Therefore, when an eBPF program using this helper is attached,
1250 * a warning including PID and process name is printed to kernel
1251 * logs.
1252 * Return
1253 * 0 on success, or a negative error in case of failure.
1254 *
1255 * int bpf_current_task_under_cgroup(struct bpf_map *map, u32 index)
1256 * Description
1257 * Check whether the probe is being run is the context of a given
1258 * subset of the cgroup2 hierarchy. The cgroup2 to test is held by
1259 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
1260 * Return
1261 * The return value depends on the result of the test, and can be:
1262 *
1263 * * 0, if the *skb* task belongs to the cgroup2.
1264 * * 1, if the *skb* task does not belong to the cgroup2.
1265 * * A negative error code, if an error occurred.
1266 *
Quentin Monnetfa156012018-04-25 18:16:56 +01001267 * int bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags)
1268 * Description
1269 * Resize (trim or grow) the packet associated to *skb* to the
1270 * new *len*. The *flags* are reserved for future usage, and must
1271 * be left at zero.
1272 *
1273 * The basic idea is that the helper performs the needed work to
1274 * change the size of the packet, then the eBPF program rewrites
1275 * the rest via helpers like **bpf_skb_store_bytes**\ (),
1276 * **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ ()
1277 * and others. This helper is a slow path utility intended for
1278 * replies with control messages. And because it is targeted for
1279 * slow path, the helper itself can afford to be slow: it
1280 * implicitly linearizes, unclones and drops offloads from the
1281 * *skb*.
1282 *
1283 * A call to this helper is susceptible to change the underlaying
1284 * packet buffer. Therefore, at load time, all checks on pointers
1285 * previously done by the verifier are invalidated and must be
1286 * performed again, if the helper is used in combination with
1287 * direct packet access.
1288 * Return
1289 * 0 on success, or a negative error in case of failure.
1290 *
1291 * int bpf_skb_pull_data(struct sk_buff *skb, u32 len)
1292 * Description
1293 * Pull in non-linear data in case the *skb* is non-linear and not
1294 * all of *len* are part of the linear section. Make *len* bytes
1295 * from *skb* readable and writable. If a zero value is passed for
1296 * *len*, then the whole length of the *skb* is pulled.
1297 *
1298 * This helper is only needed for reading and writing with direct
1299 * packet access.
1300 *
1301 * For direct packet access, testing that offsets to access
1302 * are within packet boundaries (test on *skb*\ **->data_end**) is
1303 * susceptible to fail if offsets are invalid, or if the requested
1304 * data is in non-linear parts of the *skb*. On failure the
1305 * program can just bail out, or in the case of a non-linear
1306 * buffer, use a helper to make the data available. The
1307 * **bpf_skb_load_bytes**\ () helper is a first solution to access
1308 * the data. Another one consists in using **bpf_skb_pull_data**
1309 * to pull in once the non-linear parts, then retesting and
1310 * eventually access the data.
1311 *
1312 * At the same time, this also makes sure the *skb* is uncloned,
1313 * which is a necessary condition for direct write. As this needs
1314 * to be an invariant for the write part only, the verifier
1315 * detects writes and adds a prologue that is calling
1316 * **bpf_skb_pull_data()** to effectively unclone the *skb* from
1317 * the very beginning in case it is indeed cloned.
1318 *
1319 * A call to this helper is susceptible to change the underlaying
1320 * packet buffer. Therefore, at load time, all checks on pointers
1321 * previously done by the verifier are invalidated and must be
1322 * performed again, if the helper is used in combination with
1323 * direct packet access.
1324 * Return
1325 * 0 on success, or a negative error in case of failure.
1326 *
1327 * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum)
1328 * Description
1329 * Add the checksum *csum* into *skb*\ **->csum** in case the
1330 * driver has supplied a checksum for the entire packet into that
1331 * field. Return an error otherwise. This helper is intended to be
1332 * used in combination with **bpf_csum_diff**\ (), in particular
1333 * when the checksum needs to be updated after data has been
1334 * written into the packet through direct packet access.
1335 * Return
1336 * The checksum on success, or a negative error code in case of
1337 * failure.
1338 *
1339 * void bpf_set_hash_invalid(struct sk_buff *skb)
1340 * Description
1341 * Invalidate the current *skb*\ **->hash**. It can be used after
1342 * mangling on headers through direct packet access, in order to
1343 * indicate that the hash is outdated and to trigger a
1344 * recalculation the next time the kernel tries to access this
1345 * hash or when the **bpf_get_hash_recalc**\ () helper is called.
1346 *
1347 * int bpf_get_numa_node_id(void)
1348 * Description
1349 * Return the id of the current NUMA node. The primary use case
1350 * for this helper is the selection of sockets for the local NUMA
1351 * node, when the program is attached to sockets using the
1352 * **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**),
1353 * but the helper is also available to other eBPF program types,
1354 * similarly to **bpf_get_smp_processor_id**\ ().
1355 * Return
1356 * The id of current NUMA node.
1357 *
Quentin Monnetc6b5fb82018-04-25 18:16:57 +01001358 * int bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags)
1359 * Description
1360 * Grows headroom of packet associated to *skb* and adjusts the
1361 * offset of the MAC header accordingly, adding *len* bytes of
1362 * space. It automatically extends and reallocates memory as
1363 * required.
1364 *
1365 * This helper can be used on a layer 3 *skb* to push a MAC header
1366 * for redirection into a layer 2 device.
1367 *
1368 * All values for *flags* are reserved for future usage, and must
1369 * be left at zero.
1370 *
1371 * A call to this helper is susceptible to change the underlaying
1372 * packet buffer. Therefore, at load time, all checks on pointers
1373 * previously done by the verifier are invalidated and must be
1374 * performed again, if the helper is used in combination with
1375 * direct packet access.
1376 * Return
1377 * 0 on success, or a negative error in case of failure.
1378 *
1379 * int bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta)
1380 * Description
1381 * Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that
1382 * it is possible to use a negative value for *delta*. This helper
1383 * can be used to prepare the packet for pushing or popping
1384 * headers.
1385 *
1386 * A call to this helper is susceptible to change the underlaying
1387 * packet buffer. Therefore, at load time, all checks on pointers
1388 * previously done by the verifier are invalidated and must be
1389 * performed again, if the helper is used in combination with
1390 * direct packet access.
1391 * Return
1392 * 0 on success, or a negative error in case of failure.
1393 *
1394 * int bpf_probe_read_str(void *dst, int size, const void *unsafe_ptr)
1395 * Description
1396 * Copy a NUL terminated string from an unsafe address
1397 * *unsafe_ptr* to *dst*. The *size* should include the
1398 * terminating NUL byte. In case the string length is smaller than
1399 * *size*, the target is not padded with further NUL bytes. If the
1400 * string length is larger than *size*, just *size*-1 bytes are
1401 * copied and the last byte is set to NUL.
1402 *
1403 * On success, the length of the copied string is returned. This
1404 * makes this helper useful in tracing programs for reading
1405 * strings, and more importantly to get its length at runtime. See
1406 * the following snippet:
1407 *
1408 * ::
1409 *
1410 * SEC("kprobe/sys_open")
1411 * void bpf_sys_open(struct pt_regs *ctx)
1412 * {
1413 * char buf[PATHLEN]; // PATHLEN is defined to 256
1414 * int res = bpf_probe_read_str(buf, sizeof(buf),
1415 * ctx->di);
1416 *
1417 * // Consume buf, for example push it to
1418 * // userspace via bpf_perf_event_output(); we
1419 * // can use res (the string length) as event
1420 * // size, after checking its boundaries.
1421 * }
1422 *
1423 * In comparison, using **bpf_probe_read()** helper here instead
1424 * to read the string would require to estimate the length at
1425 * compile time, and would often result in copying more memory
1426 * than necessary.
1427 *
1428 * Another useful use case is when parsing individual process
1429 * arguments or individual environment variables navigating
1430 * *current*\ **->mm->arg_start** and *current*\
1431 * **->mm->env_start**: using this helper and the return value,
1432 * one can quickly iterate at the right offset of the memory area.
1433 * Return
1434 * On success, the strictly positive length of the string,
1435 * including the trailing NUL character. On error, a negative
1436 * value.
1437 *
1438 * u64 bpf_get_socket_cookie(struct sk_buff *skb)
1439 * Description
1440 * If the **struct sk_buff** pointed by *skb* has a known socket,
1441 * retrieve the cookie (generated by the kernel) of this socket.
1442 * If no cookie has been set yet, generate a new cookie. Once
1443 * generated, the socket cookie remains stable for the life of the
1444 * socket. This helper can be useful for monitoring per socket
1445 * networking traffic statistics as it provides a unique socket
1446 * identifier per namespace.
1447 * Return
1448 * A 8-byte long non-decreasing number on success, or 0 if the
1449 * socket field is missing inside *skb*.
1450 *
Andrey Ignatovd692f112018-07-30 17:42:28 -07001451 * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx)
1452 * Description
1453 * Equivalent to bpf_get_socket_cookie() helper that accepts
Quentin Monnet62369db2019-03-14 12:38:39 +00001454 * *skb*, but gets socket from **struct bpf_sock_addr** context.
Andrey Ignatovd692f112018-07-30 17:42:28 -07001455 * Return
1456 * A 8-byte long non-decreasing number.
1457 *
1458 * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx)
1459 * Description
1460 * Equivalent to bpf_get_socket_cookie() helper that accepts
Quentin Monnet62369db2019-03-14 12:38:39 +00001461 * *skb*, but gets socket from **struct bpf_sock_ops** context.
Andrey Ignatovd692f112018-07-30 17:42:28 -07001462 * Return
1463 * A 8-byte long non-decreasing number.
1464 *
Quentin Monnetc6b5fb82018-04-25 18:16:57 +01001465 * u32 bpf_get_socket_uid(struct sk_buff *skb)
1466 * Return
1467 * The owner UID of the socket associated to *skb*. If the socket
1468 * is **NULL**, or if it is not a full socket (i.e. if it is a
1469 * time-wait or a request socket instead), **overflowuid** value
1470 * is returned (note that **overflowuid** might also be the actual
1471 * UID value for the socket).
1472 *
Quentin Monnetfa156012018-04-25 18:16:56 +01001473 * u32 bpf_set_hash(struct sk_buff *skb, u32 hash)
1474 * Description
1475 * Set the full hash for *skb* (set the field *skb*\ **->hash**)
1476 * to value *hash*.
1477 * Return
1478 * 0
1479 *
Andrey Ignatova3ef8e92018-04-28 16:06:19 -07001480 * int bpf_setsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, char *optval, int optlen)
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001481 * Description
1482 * Emulate a call to **setsockopt()** on the socket associated to
1483 * *bpf_socket*, which must be a full socket. The *level* at
1484 * which the option resides and the name *optname* of the option
1485 * must be specified, see **setsockopt(2)** for more information.
1486 * The option value of length *optlen* is pointed by *optval*.
1487 *
1488 * This helper actually implements a subset of **setsockopt()**.
1489 * It supports the following *level*\ s:
1490 *
1491 * * **SOL_SOCKET**, which supports the following *optname*\ s:
1492 * **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,
1493 * **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**.
1494 * * **IPPROTO_TCP**, which supports the following *optname*\ s:
1495 * **TCP_CONGESTION**, **TCP_BPF_IW**,
1496 * **TCP_BPF_SNDCWND_CLAMP**.
1497 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
1498 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
1499 * Return
1500 * 0 on success, or a negative error in case of failure.
1501 *
Nicolas Dichtelb55cbc82018-10-17 16:24:48 +02001502 * int bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags)
Quentin Monnetfa156012018-04-25 18:16:56 +01001503 * Description
1504 * Grow or shrink the room for data in the packet associated to
1505 * *skb* by *len_diff*, and according to the selected *mode*.
1506 *
Willem de Bruijn14aa3192019-03-22 14:32:54 -04001507 * There are two supported modes at this time:
1508 *
1509 * * **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer
1510 * (room space is added or removed below the layer 2 header).
Quentin Monnetfa156012018-04-25 18:16:56 +01001511 *
1512 * * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer
1513 * (room space is added or removed below the layer 3 header).
1514 *
Willem de Bruijn868d5232019-03-22 14:32:56 -04001515 * The following flags are supported at this time:
Willem de Bruijn2278f6c2019-03-22 14:32:55 -04001516 *
1517 * * **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size.
1518 * Adjusting mss in this way is not allowed for datagrams.
Quentin Monnetfa156012018-04-25 18:16:56 +01001519 *
Willem de Bruijn868d5232019-03-22 14:32:56 -04001520 * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 **:
1521 * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 **:
1522 * Any new space is reserved to hold a tunnel header.
1523 * Configure skb offsets and other fields accordingly.
1524 *
1525 * * **BPF_F_ADJ_ROOM_ENCAP_L4_GRE **:
1526 * * **BPF_F_ADJ_ROOM_ENCAP_L4_UDP **:
1527 * Use with ENCAP_L3 flags to further specify the tunnel type.
1528 *
Alan Maguire58dfc902019-04-09 15:06:41 +01001529 * * **BPF_F_ADJ_ROOM_ENCAP_L2(len) **:
1530 * Use with ENCAP_L3/L4 flags to further specify the tunnel
1531 * type; **len** is the length of the inner MAC header.
1532 *
Quentin Monnetfa156012018-04-25 18:16:56 +01001533 * A call to this helper is susceptible to change the underlaying
1534 * packet buffer. Therefore, at load time, all checks on pointers
1535 * previously done by the verifier are invalidated and must be
1536 * performed again, if the helper is used in combination with
1537 * direct packet access.
1538 * Return
1539 * 0 on success, or a negative error in case of failure.
1540 *
Quentin Monnetab127042018-04-25 18:16:59 +01001541 * int bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
1542 * Description
1543 * Redirect the packet to the endpoint referenced by *map* at
1544 * index *key*. Depending on its type, this *map* can contain
1545 * references to net devices (for forwarding packets through other
1546 * ports), or to CPUs (for redirecting XDP frames to another CPU;
1547 * but this is only implemented for native XDP (with driver
1548 * support) as of this writing).
1549 *
1550 * All values for *flags* are reserved for future usage, and must
1551 * be left at zero.
1552 *
1553 * When used to redirect packets to net devices, this helper
1554 * provides a high performance increase over **bpf_redirect**\ ().
1555 * This is due to various implementation details of the underlying
1556 * mechanisms, one of which is the fact that **bpf_redirect_map**\
1557 * () tries to send packet as a "bulk" to the device.
1558 * Return
1559 * **XDP_REDIRECT** on success, or **XDP_ABORTED** on error.
1560 *
1561 * int bpf_sk_redirect_map(struct bpf_map *map, u32 key, u64 flags)
1562 * Description
1563 * Redirect the packet to the socket referenced by *map* (of type
1564 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
1565 * egress interfaces can be used for redirection. The
1566 * **BPF_F_INGRESS** value in *flags* is used to make the
1567 * distinction (ingress path is selected if the flag is present,
1568 * egress path otherwise). This is the only flag supported for now.
1569 * Return
1570 * **SK_PASS** on success, or **SK_DROP** on error.
1571 *
Andrey Ignatova3ef8e92018-04-28 16:06:19 -07001572 * int bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
Quentin Monnetab127042018-04-25 18:16:59 +01001573 * Description
1574 * Add an entry to, or update a *map* referencing sockets. The
1575 * *skops* is used as a new value for the entry associated to
1576 * *key*. *flags* is one of:
1577 *
1578 * **BPF_NOEXIST**
1579 * The entry for *key* must not exist in the map.
1580 * **BPF_EXIST**
1581 * The entry for *key* must already exist in the map.
1582 * **BPF_ANY**
1583 * No condition on the existence of the entry for *key*.
1584 *
1585 * If the *map* has eBPF programs (parser and verdict), those will
1586 * be inherited by the socket being added. If the socket is
1587 * already attached to eBPF programs, this results in an error.
1588 * Return
1589 * 0 on success, or a negative error in case of failure.
1590 *
Quentin Monnetfa156012018-04-25 18:16:56 +01001591 * int bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta)
1592 * Description
1593 * Adjust the address pointed by *xdp_md*\ **->data_meta** by
1594 * *delta* (which can be positive or negative). Note that this
1595 * operation modifies the address stored in *xdp_md*\ **->data**,
1596 * so the latter must be loaded only after the helper has been
1597 * called.
1598 *
1599 * The use of *xdp_md*\ **->data_meta** is optional and programs
1600 * are not required to use it. The rationale is that when the
1601 * packet is processed with XDP (e.g. as DoS filter), it is
1602 * possible to push further meta data along with it before passing
1603 * to the stack, and to give the guarantee that an ingress eBPF
1604 * program attached as a TC classifier on the same device can pick
1605 * this up for further post-processing. Since TC works with socket
1606 * buffers, it remains possible to set from XDP the **mark** or
1607 * **priority** pointers, or other pointers for the socket buffer.
1608 * Having this scratch space generic and programmable allows for
1609 * more flexibility as the user is free to store whatever meta
1610 * data they need.
1611 *
1612 * A call to this helper is susceptible to change the underlaying
1613 * packet buffer. Therefore, at load time, all checks on pointers
1614 * previously done by the verifier are invalidated and must be
1615 * performed again, if the helper is used in combination with
1616 * direct packet access.
1617 * Return
1618 * 0 on success, or a negative error in case of failure.
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001619 *
1620 * int bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size)
1621 * Description
1622 * Read the value of a perf event counter, and store it into *buf*
1623 * of size *buf_size*. This helper relies on a *map* of type
1624 * **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event
1625 * counter is selected when *map* is updated with perf event file
1626 * descriptors. The *map* is an array whose size is the number of
1627 * available CPUs, and each cell contains a value relative to one
1628 * CPU. The value to retrieve is indicated by *flags*, that
1629 * contains the index of the CPU to look up, masked with
1630 * **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
1631 * **BPF_F_CURRENT_CPU** to indicate that the value for the
1632 * current CPU should be retrieved.
1633 *
1634 * This helper behaves in a way close to
1635 * **bpf_perf_event_read**\ () helper, save that instead of
1636 * just returning the value observed, it fills the *buf*
1637 * structure. This allows for additional data to be retrieved: in
1638 * particular, the enabled and running times (in *buf*\
1639 * **->enabled** and *buf*\ **->running**, respectively) are
1640 * copied. In general, **bpf_perf_event_read_value**\ () is
1641 * recommended over **bpf_perf_event_read**\ (), which has some
1642 * ABI issues and provides fewer functionalities.
1643 *
1644 * These values are interesting, because hardware PMU (Performance
1645 * Monitoring Unit) counters are limited resources. When there are
1646 * more PMU based perf events opened than available counters,
1647 * kernel will multiplex these events so each event gets certain
1648 * percentage (but not all) of the PMU time. In case that
1649 * multiplexing happens, the number of samples or counter value
1650 * will not reflect the case compared to when no multiplexing
1651 * occurs. This makes comparison between different runs difficult.
1652 * Typically, the counter value should be normalized before
1653 * comparing to other experiments. The usual normalization is done
1654 * as follows.
1655 *
1656 * ::
1657 *
1658 * normalized_counter = counter * t_enabled / t_running
1659 *
1660 * Where t_enabled is the time enabled for event and t_running is
1661 * the time running for event since last normalization. The
1662 * enabled and running times are accumulated since the perf event
1663 * open. To achieve scaling factor between two invocations of an
1664 * eBPF program, users can can use CPU id as the key (which is
1665 * typical for perf array usage model) to remember the previous
1666 * value and do the calculation inside the eBPF program.
1667 * Return
1668 * 0 on success, or a negative error in case of failure.
1669 *
Andrey Ignatova3ef8e92018-04-28 16:06:19 -07001670 * int bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size)
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001671 * Description
1672 * For en eBPF program attached to a perf event, retrieve the
1673 * value of the event counter associated to *ctx* and store it in
1674 * the structure pointed by *buf* and of size *buf_size*. Enabled
1675 * and running times are also stored in the structure (see
1676 * description of helper **bpf_perf_event_read_value**\ () for
1677 * more details).
1678 * Return
1679 * 0 on success, or a negative error in case of failure.
1680 *
Andrey Ignatova3ef8e92018-04-28 16:06:19 -07001681 * int bpf_getsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, char *optval, int optlen)
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001682 * Description
1683 * Emulate a call to **getsockopt()** on the socket associated to
1684 * *bpf_socket*, which must be a full socket. The *level* at
1685 * which the option resides and the name *optname* of the option
1686 * must be specified, see **getsockopt(2)** for more information.
1687 * The retrieved value is stored in the structure pointed by
1688 * *opval* and of length *optlen*.
1689 *
1690 * This helper actually implements a subset of **getsockopt()**.
1691 * It supports the following *level*\ s:
1692 *
1693 * * **IPPROTO_TCP**, which supports *optname*
1694 * **TCP_CONGESTION**.
1695 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
1696 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
1697 * Return
1698 * 0 on success, or a negative error in case of failure.
1699 *
1700 * int bpf_override_return(struct pt_reg *regs, u64 rc)
1701 * Description
1702 * Used for error injection, this helper uses kprobes to override
1703 * the return value of the probed function, and to set it to *rc*.
1704 * The first argument is the context *regs* on which the kprobe
1705 * works.
1706 *
1707 * This helper works by setting setting the PC (program counter)
1708 * to an override function which is run in place of the original
1709 * probed function. This means the probed function is not run at
1710 * all. The replacement function just returns with the required
1711 * value.
1712 *
1713 * This helper has security implications, and thus is subject to
1714 * restrictions. It is only available if the kernel was compiled
1715 * with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration
1716 * option, and in this case it only works on functions tagged with
1717 * **ALLOW_ERROR_INJECTION** in the kernel code.
1718 *
1719 * Also, the helper is only available for the architectures having
1720 * the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing,
1721 * x86 architecture is the only one to support this feature.
1722 * Return
1723 * 0
1724 *
Andrey Ignatova3ef8e92018-04-28 16:06:19 -07001725 * int bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval)
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001726 * Description
1727 * Attempt to set the value of the **bpf_sock_ops_cb_flags** field
1728 * for the full TCP socket associated to *bpf_sock_ops* to
1729 * *argval*.
1730 *
1731 * The primary use of this field is to determine if there should
1732 * be calls to eBPF programs of type
1733 * **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP
1734 * code. A program of the same type can change its value, per
1735 * connection and as necessary, when the connection is
1736 * established. This field is directly accessible for reading, but
1737 * this helper must be used for updates in order to return an
1738 * error if an eBPF program tries to set a callback that is not
1739 * supported in the current kernel.
1740 *
Viet Hoang Tran725721a2019-04-15 09:54:55 +00001741 * *argval* is a flag array which can combine these flags:
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001742 *
1743 * * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out)
1744 * * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission)
1745 * * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change)
1746 *
Viet Hoang Tran725721a2019-04-15 09:54:55 +00001747 * Therefore, this function can be used to clear a callback flag by
1748 * setting the appropriate bit to zero. e.g. to disable the RTO
1749 * callback:
1750 *
1751 * **bpf_sock_ops_cb_flags_set(bpf_sock,**
1752 * **bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)**
1753 *
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001754 * Here are some examples of where one could call such eBPF
1755 * program:
1756 *
1757 * * When RTO fires.
1758 * * When a packet is retransmitted.
1759 * * When the connection terminates.
1760 * * When a packet is sent.
1761 * * When a packet is received.
1762 * Return
1763 * Code **-EINVAL** if the socket is not a full TCP socket;
1764 * otherwise, a positive number containing the bits that could not
1765 * be set is returned (which comes down to 0 if all bits were set
1766 * as required).
1767 *
Quentin Monnetab127042018-04-25 18:16:59 +01001768 * int bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags)
1769 * Description
1770 * This helper is used in programs implementing policies at the
1771 * socket level. If the message *msg* is allowed to pass (i.e. if
1772 * the verdict eBPF program returns **SK_PASS**), redirect it to
1773 * the socket referenced by *map* (of type
1774 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
1775 * egress interfaces can be used for redirection. The
1776 * **BPF_F_INGRESS** value in *flags* is used to make the
1777 * distinction (ingress path is selected if the flag is present,
1778 * egress path otherwise). This is the only flag supported for now.
1779 * Return
1780 * **SK_PASS** on success, or **SK_DROP** on error.
1781 *
1782 * int bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes)
1783 * Description
1784 * For socket policies, apply the verdict of the eBPF program to
1785 * the next *bytes* (number of bytes) of message *msg*.
1786 *
1787 * For example, this helper can be used in the following cases:
1788 *
1789 * * A single **sendmsg**\ () or **sendfile**\ () system call
1790 * contains multiple logical messages that the eBPF program is
1791 * supposed to read and for which it should apply a verdict.
1792 * * An eBPF program only cares to read the first *bytes* of a
1793 * *msg*. If the message has a large payload, then setting up
1794 * and calling the eBPF program repeatedly for all bytes, even
1795 * though the verdict is already known, would create unnecessary
1796 * overhead.
1797 *
1798 * When called from within an eBPF program, the helper sets a
1799 * counter internal to the BPF infrastructure, that is used to
1800 * apply the last verdict to the next *bytes*. If *bytes* is
1801 * smaller than the current data being processed from a
1802 * **sendmsg**\ () or **sendfile**\ () system call, the first
1803 * *bytes* will be sent and the eBPF program will be re-run with
1804 * the pointer for start of data pointing to byte number *bytes*
1805 * **+ 1**. If *bytes* is larger than the current data being
1806 * processed, then the eBPF verdict will be applied to multiple
1807 * **sendmsg**\ () or **sendfile**\ () calls until *bytes* are
1808 * consumed.
1809 *
1810 * Note that if a socket closes with the internal counter holding
1811 * a non-zero value, this is not a problem because data is not
1812 * being buffered for *bytes* and is sent as it is received.
1813 * Return
1814 * 0
1815 *
1816 * int bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes)
1817 * Description
1818 * For socket policies, prevent the execution of the verdict eBPF
1819 * program for message *msg* until *bytes* (byte number) have been
1820 * accumulated.
1821 *
1822 * This can be used when one needs a specific number of bytes
1823 * before a verdict can be assigned, even if the data spans
1824 * multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme
1825 * case would be a user calling **sendmsg**\ () repeatedly with
1826 * 1-byte long message segments. Obviously, this is bad for
1827 * performance, but it is still valid. If the eBPF program needs
1828 * *bytes* bytes to validate a header, this helper can be used to
1829 * prevent the eBPF program to be called again until *bytes* have
1830 * been accumulated.
1831 * Return
1832 * 0
1833 *
1834 * int bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags)
1835 * Description
1836 * For socket policies, pull in non-linear data from user space
1837 * for *msg* and set pointers *msg*\ **->data** and *msg*\
1838 * **->data_end** to *start* and *end* bytes offsets into *msg*,
1839 * respectively.
1840 *
1841 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
1842 * *msg* it can only parse data that the (**data**, **data_end**)
1843 * pointers have already consumed. For **sendmsg**\ () hooks this
1844 * is likely the first scatterlist element. But for calls relying
1845 * on the **sendpage** handler (e.g. **sendfile**\ ()) this will
1846 * be the range (**0**, **0**) because the data is shared with
1847 * user space and by default the objective is to avoid allowing
1848 * user space to modify data while (or after) eBPF verdict is
1849 * being decided. This helper can be used to pull in data and to
1850 * set the start and end pointer to given values. Data will be
1851 * copied if necessary (i.e. if data was not linear and if start
1852 * and end pointers do not point to the same chunk).
1853 *
1854 * A call to this helper is susceptible to change the underlaying
1855 * packet buffer. Therefore, at load time, all checks on pointers
1856 * previously done by the verifier are invalidated and must be
1857 * performed again, if the helper is used in combination with
1858 * direct packet access.
1859 *
1860 * All values for *flags* are reserved for future usage, and must
1861 * be left at zero.
1862 * Return
1863 * 0 on success, or a negative error in case of failure.
1864 *
Andrey Ignatova3ef8e92018-04-28 16:06:19 -07001865 * int bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len)
Quentin Monnet7aa79a82018-04-25 18:16:58 +01001866 * Description
1867 * Bind the socket associated to *ctx* to the address pointed by
1868 * *addr*, of length *addr_len*. This allows for making outgoing
1869 * connection from the desired IP address, which can be useful for
1870 * example when all processes inside a cgroup should use one
1871 * single IP address on a host that has multiple IP configured.
1872 *
1873 * This helper works for IPv4 and IPv6, TCP and UDP sockets. The
1874 * domain (*addr*\ **->sa_family**) must be **AF_INET** (or
1875 * **AF_INET6**). Looking for a free port to bind to can be
1876 * expensive, therefore binding to port is not permitted by the
1877 * helper: *addr*\ **->sin_port** (or **sin6_port**, respectively)
1878 * must be set to zero.
1879 * Return
1880 * 0 on success, or a negative error in case of failure.
Quentin Monnet2d020dd2018-04-25 18:17:00 +01001881 *
1882 * int bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta)
1883 * Description
1884 * Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is
1885 * only possible to shrink the packet as of this writing,
1886 * therefore *delta* must be a negative integer.
1887 *
1888 * A call to this helper is susceptible to change the underlaying
1889 * packet buffer. Therefore, at load time, all checks on pointers
1890 * previously done by the verifier are invalidated and must be
1891 * performed again, if the helper is used in combination with
1892 * direct packet access.
1893 * Return
1894 * 0 on success, or a negative error in case of failure.
1895 *
1896 * int bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags)
1897 * Description
1898 * Retrieve the XFRM state (IP transform framework, see also
1899 * **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*.
1900 *
1901 * The retrieved value is stored in the **struct bpf_xfrm_state**
1902 * pointed by *xfrm_state* and of length *size*.
1903 *
1904 * All values for *flags* are reserved for future usage, and must
1905 * be left at zero.
1906 *
1907 * This helper is available only if the kernel was compiled with
1908 * **CONFIG_XFRM** configuration option.
1909 * Return
1910 * 0 on success, or a negative error in case of failure.
Yonghong Songc195651e2018-04-28 22:28:08 -07001911 *
1912 * int bpf_get_stack(struct pt_regs *regs, void *buf, u32 size, u64 flags)
1913 * Description
Quentin Monnet79552fb2018-04-30 11:39:04 +01001914 * Return a user or a kernel stack in bpf program provided buffer.
1915 * To achieve this, the helper needs *ctx*, which is a pointer
1916 * to the context on which the tracing program is executed.
1917 * To store the stacktrace, the bpf program provides *buf* with
1918 * a nonnegative *size*.
Yonghong Songc195651e2018-04-28 22:28:08 -07001919 *
Quentin Monnet79552fb2018-04-30 11:39:04 +01001920 * The last argument, *flags*, holds the number of stack frames to
1921 * skip (from 0 to 255), masked with
1922 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
1923 * the following flags:
Yonghong Songc195651e2018-04-28 22:28:08 -07001924 *
Quentin Monnet79552fb2018-04-30 11:39:04 +01001925 * **BPF_F_USER_STACK**
1926 * Collect a user space stack instead of a kernel stack.
1927 * **BPF_F_USER_BUILD_ID**
1928 * Collect buildid+offset instead of ips for user stack,
1929 * only valid if **BPF_F_USER_STACK** is also specified.
Yonghong Songc195651e2018-04-28 22:28:08 -07001930 *
Quentin Monnet79552fb2018-04-30 11:39:04 +01001931 * **bpf_get_stack**\ () can collect up to
1932 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
1933 * to sufficient large buffer size. Note that
1934 * this limit can be controlled with the **sysctl** program, and
1935 * that it should be manually increased in order to profile long
1936 * user stacks (such as stacks for Java programs). To do so, use:
Yonghong Songc195651e2018-04-28 22:28:08 -07001937 *
Quentin Monnet79552fb2018-04-30 11:39:04 +01001938 * ::
Yonghong Songc195651e2018-04-28 22:28:08 -07001939 *
Quentin Monnet79552fb2018-04-30 11:39:04 +01001940 * # sysctl kernel.perf_event_max_stack=<new value>
Yonghong Songc195651e2018-04-28 22:28:08 -07001941 * Return
Quentin Monnet7a279e92018-05-29 12:27:44 +01001942 * A non-negative value equal to or less than *size* on success,
1943 * or a negative error in case of failure.
Daniel Borkmann4e1ec562018-05-04 01:08:15 +02001944 *
Quentin Monnet2bae79d2018-07-12 12:52:22 +01001945 * int bpf_skb_load_bytes_relative(const struct sk_buff *skb, u32 offset, void *to, u32 len, u32 start_header)
Daniel Borkmann4e1ec562018-05-04 01:08:15 +02001946 * Description
1947 * This helper is similar to **bpf_skb_load_bytes**\ () in that
1948 * it provides an easy way to load *len* bytes from *offset*
1949 * from the packet associated to *skb*, into the buffer pointed
1950 * by *to*. The difference to **bpf_skb_load_bytes**\ () is that
1951 * a fifth argument *start_header* exists in order to select a
1952 * base offset to start from. *start_header* can be one of:
1953 *
1954 * **BPF_HDR_START_MAC**
1955 * Base offset to load data from is *skb*'s mac header.
1956 * **BPF_HDR_START_NET**
1957 * Base offset to load data from is *skb*'s network header.
1958 *
1959 * In general, "direct packet access" is the preferred method to
1960 * access packet data, however, this helper is in particular useful
1961 * in socket filters where *skb*\ **->data** does not always point
1962 * to the start of the mac header and where "direct packet access"
1963 * is not available.
Daniel Borkmann4e1ec562018-05-04 01:08:15 +02001964 * Return
1965 * 0 on success, or a negative error in case of failure.
1966 *
David Ahern87f5fc72018-05-09 20:34:26 -07001967 * int bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags)
1968 * Description
1969 * Do FIB lookup in kernel tables using parameters in *params*.
1970 * If lookup is successful and result shows packet is to be
1971 * forwarded, the neighbor tables are searched for the nexthop.
1972 * If successful (ie., FIB lookup shows forwarding and nexthop
David Ahernfa898d72018-05-29 10:58:07 -07001973 * is resolved), the nexthop address is returned in ipv4_dst
1974 * or ipv6_dst based on family, smac is set to mac address of
1975 * egress device, dmac is set to nexthop mac address, rt_metric
David Ahern4c795792018-06-26 16:21:18 -07001976 * is set to metric from route (IPv4/IPv6 only), and ifindex
1977 * is set to the device index of the nexthop from the FIB lookup.
David Ahern87f5fc72018-05-09 20:34:26 -07001978 *
Quentin Monnet90b10232018-12-03 12:13:35 +00001979 * *plen* argument is the size of the passed in struct.
1980 * *flags* argument can be a combination of one or more of the
1981 * following values:
David Ahern87f5fc72018-05-09 20:34:26 -07001982 *
Quentin Monnet7a279e92018-05-29 12:27:44 +01001983 * **BPF_FIB_LOOKUP_DIRECT**
1984 * Do a direct table lookup vs full lookup using FIB
1985 * rules.
1986 * **BPF_FIB_LOOKUP_OUTPUT**
1987 * Perform lookup from an egress perspective (default is
1988 * ingress).
David Ahern87f5fc72018-05-09 20:34:26 -07001989 *
Quentin Monnet90b10232018-12-03 12:13:35 +00001990 * *ctx* is either **struct xdp_md** for XDP programs or
1991 * **struct sk_buff** tc cls_act programs.
1992 * Return
David Ahern4c795792018-06-26 16:21:18 -07001993 * * < 0 if any input argument is invalid
1994 * * 0 on success (packet is forwarded, nexthop neighbor exists)
1995 * * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the
Quentin Monnet2bae79d2018-07-12 12:52:22 +01001996 * packet is not forwarded or needs assist from full stack
John Fastabend81110382018-05-14 10:00:17 -07001997 *
1998 * int bpf_sock_hash_update(struct bpf_sock_ops_kern *skops, struct bpf_map *map, void *key, u64 flags)
1999 * Description
2000 * Add an entry to, or update a sockhash *map* referencing sockets.
2001 * The *skops* is used as a new value for the entry associated to
2002 * *key*. *flags* is one of:
2003 *
2004 * **BPF_NOEXIST**
2005 * The entry for *key* must not exist in the map.
2006 * **BPF_EXIST**
2007 * The entry for *key* must already exist in the map.
2008 * **BPF_ANY**
2009 * No condition on the existence of the entry for *key*.
2010 *
2011 * If the *map* has eBPF programs (parser and verdict), those will
2012 * be inherited by the socket being added. If the socket is
2013 * already attached to eBPF programs, this results in an error.
2014 * Return
2015 * 0 on success, or a negative error in case of failure.
2016 *
2017 * int bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags)
2018 * Description
2019 * This helper is used in programs implementing policies at the
2020 * socket level. If the message *msg* is allowed to pass (i.e. if
2021 * the verdict eBPF program returns **SK_PASS**), redirect it to
2022 * the socket referenced by *map* (of type
2023 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
2024 * egress interfaces can be used for redirection. The
2025 * **BPF_F_INGRESS** value in *flags* is used to make the
2026 * distinction (ingress path is selected if the flag is present,
2027 * egress path otherwise). This is the only flag supported for now.
2028 * Return
2029 * **SK_PASS** on success, or **SK_DROP** on error.
2030 *
2031 * int bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags)
2032 * Description
2033 * This helper is used in programs implementing policies at the
2034 * skb socket level. If the sk_buff *skb* is allowed to pass (i.e.
2035 * if the verdeict eBPF program returns **SK_PASS**), redirect it
2036 * to the socket referenced by *map* (of type
2037 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
2038 * egress interfaces can be used for redirection. The
2039 * **BPF_F_INGRESS** value in *flags* is used to make the
2040 * distinction (ingress path is selected if the flag is present,
2041 * egress otherwise). This is the only flag supported for now.
2042 * Return
2043 * **SK_PASS** on success, or **SK_DROP** on error.
Mathieu Xhonneuxfe94cc22018-05-20 14:58:14 +01002044 *
2045 * int bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len)
2046 * Description
2047 * Encapsulate the packet associated to *skb* within a Layer 3
2048 * protocol header. This header is provided in the buffer at
2049 * address *hdr*, with *len* its size in bytes. *type* indicates
2050 * the protocol of the header and can be one of:
2051 *
2052 * **BPF_LWT_ENCAP_SEG6**
2053 * IPv6 encapsulation with Segment Routing Header
2054 * (**struct ipv6_sr_hdr**). *hdr* only contains the SRH,
2055 * the IPv6 header is computed by the kernel.
2056 * **BPF_LWT_ENCAP_SEG6_INLINE**
2057 * Only works if *skb* contains an IPv6 packet. Insert a
2058 * Segment Routing Header (**struct ipv6_sr_hdr**) inside
2059 * the IPv6 header.
Peter Oskolkov3e0bd372019-02-13 11:53:35 -08002060 * **BPF_LWT_ENCAP_IP**
2061 * IP encapsulation (GRE/GUE/IPIP/etc). The outer header
2062 * must be IPv4 or IPv6, followed by zero or more
2063 * additional headers, up to LWT_BPF_MAX_HEADROOM total
2064 * bytes in all prepended headers. Please note that
2065 * if skb_is_gso(skb) is true, no more than two headers
2066 * can be prepended, and the inner header, if present,
2067 * should be either GRE or UDP/GUE.
2068 *
2069 * BPF_LWT_ENCAP_SEG6*** types can be called by bpf programs of
2070 * type BPF_PROG_TYPE_LWT_IN; BPF_LWT_ENCAP_IP type can be called
2071 * by bpf programs of types BPF_PROG_TYPE_LWT_IN and
2072 * BPF_PROG_TYPE_LWT_XMIT.
Mathieu Xhonneuxfe94cc22018-05-20 14:58:14 +01002073 *
2074 * A call to this helper is susceptible to change the underlaying
2075 * packet buffer. Therefore, at load time, all checks on pointers
2076 * previously done by the verifier are invalidated and must be
2077 * performed again, if the helper is used in combination with
2078 * direct packet access.
2079 * Return
2080 * 0 on success, or a negative error in case of failure.
2081 *
2082 * int bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len)
2083 * Description
2084 * Store *len* bytes from address *from* into the packet
2085 * associated to *skb*, at *offset*. Only the flags, tag and TLVs
2086 * inside the outermost IPv6 Segment Routing Header can be
2087 * modified through this helper.
2088 *
2089 * A call to this helper is susceptible to change the underlaying
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_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta)
2098 * Description
2099 * Adjust the size allocated to TLVs in the outermost IPv6
2100 * Segment Routing Header contained in the packet associated to
2101 * *skb*, at position *offset* by *delta* bytes. Only offsets
2102 * after the segments are accepted. *delta* can be as well
2103 * positive (growing) as negative (shrinking).
2104 *
2105 * A call to this helper is susceptible to change the underlaying
2106 * packet buffer. Therefore, at load time, all checks on pointers
2107 * previously done by the verifier are invalidated and must be
2108 * performed again, if the helper is used in combination with
2109 * direct packet access.
2110 * Return
2111 * 0 on success, or a negative error in case of failure.
2112 *
2113 * int bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len)
2114 * Description
2115 * Apply an IPv6 Segment Routing action of type *action* to the
2116 * packet associated to *skb*. Each action takes a parameter
2117 * contained at address *param*, and of length *param_len* bytes.
2118 * *action* can be one of:
2119 *
2120 * **SEG6_LOCAL_ACTION_END_X**
2121 * End.X action: Endpoint with Layer-3 cross-connect.
2122 * Type of *param*: **struct in6_addr**.
2123 * **SEG6_LOCAL_ACTION_END_T**
2124 * End.T action: Endpoint with specific IPv6 table lookup.
2125 * Type of *param*: **int**.
2126 * **SEG6_LOCAL_ACTION_END_B6**
2127 * End.B6 action: Endpoint bound to an SRv6 policy.
2128 * Type of param: **struct ipv6_sr_hdr**.
2129 * **SEG6_LOCAL_ACTION_END_B6_ENCAP**
2130 * End.B6.Encap action: Endpoint bound to an SRv6
2131 * encapsulation policy.
2132 * Type of param: **struct ipv6_sr_hdr**.
2133 *
2134 * A call to this helper is susceptible to change the underlaying
2135 * packet buffer. Therefore, at load time, all checks on pointers
2136 * previously done by the verifier are invalidated and must be
2137 * performed again, if the helper is used in combination with
2138 * direct packet access.
2139 * Return
2140 * 0 on success, or a negative error in case of failure.
Sean Youngf4364dc2018-05-27 12:24:09 +01002141 *
Quentin Monnet62369db2019-03-14 12:38:39 +00002142 * int bpf_rc_repeat(void *ctx)
2143 * Description
2144 * This helper is used in programs implementing IR decoding, to
2145 * report a successfully decoded repeat key message. This delays
2146 * the generation of a key up event for previously generated
2147 * key down event.
2148 *
2149 * Some IR protocols like NEC have a special IR message for
2150 * repeating last button, for when a button is held down.
2151 *
2152 * The *ctx* should point to the lirc sample as passed into
2153 * the program.
2154 *
2155 * This helper is only available is the kernel was compiled with
2156 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2157 * "**y**".
2158 * Return
2159 * 0
2160 *
Sean Youngf4364dc2018-05-27 12:24:09 +01002161 * int bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle)
2162 * Description
2163 * This helper is used in programs implementing IR decoding, to
2164 * report a successfully decoded key press with *scancode*,
2165 * *toggle* value in the given *protocol*. The scancode will be
2166 * translated to a keycode using the rc keymap, and reported as
2167 * an input key down event. After a period a key up event is
2168 * generated. This period can be extended by calling either
Quentin Monnet90b10232018-12-03 12:13:35 +00002169 * **bpf_rc_keydown**\ () again with the same values, or calling
2170 * **bpf_rc_repeat**\ ().
Sean Youngf4364dc2018-05-27 12:24:09 +01002171 *
2172 * Some protocols include a toggle bit, in case the button was
2173 * released and pressed again between consecutive scancodes.
2174 *
2175 * The *ctx* should point to the lirc sample as passed into
2176 * the program.
2177 *
2178 * The *protocol* is the decoded protocol number (see
2179 * **enum rc_proto** for some predefined values).
2180 *
2181 * This helper is only available is the kernel was compiled with
2182 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2183 * "**y**".
Sean Youngf4364dc2018-05-27 12:24:09 +01002184 * Return
2185 * 0
2186 *
Quentin Monnet62369db2019-03-14 12:38:39 +00002187 * u64 bpf_skb_cgroup_id(struct sk_buff *skb)
Daniel Borkmanncb20b082018-06-02 23:06:36 +02002188 * Description
2189 * Return the cgroup v2 id of the socket associated with the *skb*.
2190 * This is roughly similar to the **bpf_get_cgroup_classid**\ ()
2191 * helper for cgroup v1 by providing a tag resp. identifier that
2192 * can be matched on or used for map lookups e.g. to implement
2193 * policy. The cgroup v2 id of a given path in the hierarchy is
2194 * exposed in user space through the f_handle API in order to get
2195 * to the same 64-bit id.
2196 *
2197 * This helper can be used on TC egress path, but not on ingress,
2198 * and is available only if the kernel was compiled with the
2199 * **CONFIG_SOCK_CGROUP_DATA** configuration option.
2200 * Return
2201 * The id is returned or 0 in case the id could not be retrieved.
Yonghong Songbf6fa2c2018-06-03 15:59:41 -07002202 *
2203 * u64 bpf_get_current_cgroup_id(void)
2204 * Return
2205 * A 64-bit integer containing the current cgroup id based
2206 * on the cgroup within which the current task is running.
Roman Gushchincd339432018-08-02 14:27:24 -07002207 *
Quentin Monnet62369db2019-03-14 12:38:39 +00002208 * void *bpf_get_local_storage(void *map, u64 flags)
Roman Gushchincd339432018-08-02 14:27:24 -07002209 * Description
2210 * Get the pointer to the local storage area.
2211 * The type and the size of the local storage is defined
2212 * by the *map* argument.
2213 * The *flags* meaning is specific for each map type,
2214 * and has to be 0 for cgroup local storage.
2215 *
Quentin Monnet90b10232018-12-03 12:13:35 +00002216 * Depending on the BPF program type, a local storage area
2217 * can be shared between multiple instances of the BPF program,
Roman Gushchincd339432018-08-02 14:27:24 -07002218 * running simultaneously.
2219 *
2220 * A user should care about the synchronization by himself.
Quentin Monnet90b10232018-12-03 12:13:35 +00002221 * For example, by using the **BPF_STX_XADD** instruction to alter
Roman Gushchincd339432018-08-02 14:27:24 -07002222 * the shared data.
2223 * Return
Quentin Monnet90b10232018-12-03 12:13:35 +00002224 * A pointer to the local storage area.
Martin KaFai Lau2dbb9b92018-08-08 01:01:25 -07002225 *
2226 * int bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags)
2227 * Description
Quentin Monnet90b10232018-12-03 12:13:35 +00002228 * Select a **SO_REUSEPORT** socket from a
2229 * **BPF_MAP_TYPE_REUSEPORT_ARRAY** *map*.
2230 * It checks the selected socket is matching the incoming
2231 * request in the socket buffer.
Martin KaFai Lau2dbb9b92018-08-08 01:01:25 -07002232 * Return
2233 * 0 on success, or a negative error in case of failure.
Joe Stringer6acc9b42018-10-02 13:35:36 -07002234 *
Quentin Monnet62369db2019-03-14 12:38:39 +00002235 * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level)
2236 * Description
2237 * Return id of cgroup v2 that is ancestor of cgroup associated
2238 * with the *skb* at the *ancestor_level*. The root cgroup is at
2239 * *ancestor_level* zero and each step down the hierarchy
2240 * increments the level. If *ancestor_level* == level of cgroup
2241 * associated with *skb*, then return value will be same as that
2242 * of **bpf_skb_cgroup_id**\ ().
2243 *
2244 * The helper is useful to implement policies based on cgroups
2245 * that are upper in hierarchy than immediate cgroup associated
2246 * with *skb*.
2247 *
2248 * The format of returned id and helper limitations are same as in
2249 * **bpf_skb_cgroup_id**\ ().
2250 * Return
2251 * The id is returned or 0 in case the id could not be retrieved.
2252 *
Joe Stringerf71c6142018-11-30 15:32:20 -08002253 * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
Joe Stringer6acc9b42018-10-02 13:35:36 -07002254 * Description
2255 * Look for TCP socket matching *tuple*, optionally in a child
2256 * network namespace *netns*. The return value must be checked,
Quentin Monnet90b10232018-12-03 12:13:35 +00002257 * and if non-**NULL**, released via **bpf_sk_release**\ ().
Joe Stringer6acc9b42018-10-02 13:35:36 -07002258 *
2259 * The *ctx* should point to the context of the program, such as
2260 * the skb or socket (depending on the hook in use). This is used
2261 * to determine the base network namespace for the lookup.
2262 *
2263 * *tuple_size* must be one of:
2264 *
2265 * **sizeof**\ (*tuple*\ **->ipv4**)
2266 * Look for an IPv4 socket.
2267 * **sizeof**\ (*tuple*\ **->ipv6**)
2268 * Look for an IPv6 socket.
2269 *
Joe Stringerf71c6142018-11-30 15:32:20 -08002270 * If the *netns* is a negative signed 32-bit integer, then the
2271 * socket lookup table in the netns associated with the *ctx* will
2272 * will be used. For the TC hooks, this is the netns of the device
2273 * in the skb. For socket hooks, this is the netns of the socket.
2274 * If *netns* is any other signed 32-bit value greater than or
2275 * equal to zero then it specifies the ID of the netns relative to
2276 * the netns associated with the *ctx*. *netns* values beyond the
2277 * range of 32-bit integers are reserved for future use.
Joe Stringer6acc9b42018-10-02 13:35:36 -07002278 *
2279 * All values for *flags* are reserved for future usage, and must
2280 * be left at zero.
2281 *
2282 * This helper is available only if the kernel was compiled with
2283 * **CONFIG_NET** configuration option.
2284 * Return
Daniel Borkmann0bd72112018-12-11 10:26:33 +01002285 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
2286 * For sockets with reuseport option, the **struct bpf_sock**
2287 * result is from **reuse->socks**\ [] using the hash of the tuple.
Joe Stringer6acc9b42018-10-02 13:35:36 -07002288 *
Joe Stringerf71c6142018-11-30 15:32:20 -08002289 * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
Joe Stringer6acc9b42018-10-02 13:35:36 -07002290 * Description
2291 * Look for UDP socket matching *tuple*, optionally in a child
2292 * network namespace *netns*. The return value must be checked,
Quentin Monnet90b10232018-12-03 12:13:35 +00002293 * and if non-**NULL**, released via **bpf_sk_release**\ ().
Joe Stringer6acc9b42018-10-02 13:35:36 -07002294 *
2295 * The *ctx* should point to the context of the program, such as
2296 * the skb or socket (depending on the hook in use). This is used
2297 * to determine the base network namespace for the lookup.
2298 *
2299 * *tuple_size* must be one of:
2300 *
2301 * **sizeof**\ (*tuple*\ **->ipv4**)
2302 * Look for an IPv4 socket.
2303 * **sizeof**\ (*tuple*\ **->ipv6**)
2304 * Look for an IPv6 socket.
2305 *
Joe Stringerf71c6142018-11-30 15:32:20 -08002306 * If the *netns* is a negative signed 32-bit integer, then the
2307 * socket lookup table in the netns associated with the *ctx* will
2308 * will be used. For the TC hooks, this is the netns of the device
2309 * in the skb. For socket hooks, this is the netns of the socket.
2310 * If *netns* is any other signed 32-bit value greater than or
2311 * equal to zero then it specifies the ID of the netns relative to
2312 * the netns associated with the *ctx*. *netns* values beyond the
2313 * range of 32-bit integers are reserved for future use.
Joe Stringer6acc9b42018-10-02 13:35:36 -07002314 *
2315 * All values for *flags* are reserved for future usage, and must
2316 * be left at zero.
2317 *
2318 * This helper is available only if the kernel was compiled with
2319 * **CONFIG_NET** configuration option.
2320 * Return
Daniel Borkmann0bd72112018-12-11 10:26:33 +01002321 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
2322 * For sockets with reuseport option, the **struct bpf_sock**
2323 * result is from **reuse->socks**\ [] using the hash of the tuple.
Joe Stringer6acc9b42018-10-02 13:35:36 -07002324 *
Quentin Monnet90b10232018-12-03 12:13:35 +00002325 * int bpf_sk_release(struct bpf_sock *sock)
Joe Stringer6acc9b42018-10-02 13:35:36 -07002326 * Description
Quentin Monnet90b10232018-12-03 12:13:35 +00002327 * Release the reference held by *sock*. *sock* must be a
2328 * non-**NULL** pointer that was returned from
2329 * **bpf_sk_lookup_xxx**\ ().
Joe Stringer6acc9b42018-10-02 13:35:36 -07002330 * Return
2331 * 0 on success, or a negative error in case of failure.
John Fastabend6fff6072018-10-19 19:56:49 -07002332 *
Quentin Monnet62369db2019-03-14 12:38:39 +00002333 * int bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags)
2334 * Description
2335 * Push an element *value* in *map*. *flags* is one of:
2336 *
2337 * **BPF_EXIST**
2338 * If the queue/stack is full, the oldest element is
2339 * removed to make room for this.
2340 * Return
2341 * 0 on success, or a negative error in case of failure.
2342 *
Quentin Monnet90b10232018-12-03 12:13:35 +00002343 * int bpf_map_pop_elem(struct bpf_map *map, void *value)
2344 * Description
2345 * Pop an element from *map*.
2346 * Return
2347 * 0 on success, or a negative error in case of failure.
2348 *
2349 * int bpf_map_peek_elem(struct bpf_map *map, void *value)
2350 * Description
2351 * Get an element from *map* without removing it.
2352 * Return
2353 * 0 on success, or a negative error in case of failure.
2354 *
John Fastabend6fff6072018-10-19 19:56:49 -07002355 * int bpf_msg_push_data(struct sk_buff *skb, u32 start, u32 len, u64 flags)
2356 * Description
Quentin Monnet90b10232018-12-03 12:13:35 +00002357 * For socket policies, insert *len* bytes into *msg* at offset
John Fastabend6fff6072018-10-19 19:56:49 -07002358 * *start*.
2359 *
2360 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
Quentin Monnet90b10232018-12-03 12:13:35 +00002361 * *msg* it may want to insert metadata or options into the *msg*.
John Fastabend6fff6072018-10-19 19:56:49 -07002362 * This can later be read and used by any of the lower layer BPF
2363 * hooks.
2364 *
2365 * This helper may fail if under memory pressure (a malloc
2366 * fails) in these cases BPF programs will get an appropriate
2367 * error and BPF programs will need to handle them.
John Fastabend6fff6072018-10-19 19:56:49 -07002368 * Return
2369 * 0 on success, or a negative error in case of failure.
John Fastabend7246d8e2018-11-26 14:16:17 -08002370 *
2371 * int bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 pop, u64 flags)
Quentin Monnet90b10232018-12-03 12:13:35 +00002372 * Description
John Fastabend7246d8e2018-11-26 14:16:17 -08002373 * Will remove *pop* bytes from a *msg* starting at byte *start*.
2374 * This may result in **ENOMEM** errors under certain situations if
2375 * an allocation and copy are required due to a full ring buffer.
2376 * However, the helper will try to avoid doing the allocation
2377 * if possible. Other errors can occur if input parameters are
Quentin Monnet90b10232018-12-03 12:13:35 +00002378 * invalid either due to *start* byte not being valid part of *msg*
John Fastabend7246d8e2018-11-26 14:16:17 -08002379 * payload and/or *pop* value being to large.
John Fastabend7246d8e2018-11-26 14:16:17 -08002380 * Return
Quentin Monnet90b10232018-12-03 12:13:35 +00002381 * 0 on success, or a negative error in case of failure.
Sean Young01d32402018-12-06 13:01:03 +00002382 *
2383 * int bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y)
2384 * Description
2385 * This helper is used in programs implementing IR decoding, to
2386 * report a successfully decoded pointer movement.
2387 *
2388 * The *ctx* should point to the lirc sample as passed into
2389 * the program.
2390 *
2391 * This helper is only available is the kernel was compiled with
2392 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
2393 * "**y**".
2394 * Return
2395 * 0
Martin KaFai Lau46f8bc92019-02-09 23:22:20 -08002396 *
Quentin Monnet0eb09782019-03-14 12:38:40 +00002397 * int bpf_spin_lock(struct bpf_spin_lock *lock)
2398 * Description
2399 * Acquire a spinlock represented by the pointer *lock*, which is
2400 * stored as part of a value of a map. Taking the lock allows to
2401 * safely update the rest of the fields in that value. The
2402 * spinlock can (and must) later be released with a call to
2403 * **bpf_spin_unlock**\ (\ *lock*\ ).
2404 *
2405 * Spinlocks in BPF programs come with a number of restrictions
2406 * and constraints:
2407 *
2408 * * **bpf_spin_lock** objects are only allowed inside maps of
2409 * types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this
2410 * list could be extended in the future).
2411 * * BTF description of the map is mandatory.
2412 * * The BPF program can take ONE lock at a time, since taking two
2413 * or more could cause dead locks.
2414 * * Only one **struct bpf_spin_lock** is allowed per map element.
2415 * * When the lock is taken, calls (either BPF to BPF or helpers)
2416 * are not allowed.
2417 * * The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not
2418 * allowed inside a spinlock-ed region.
2419 * * The BPF program MUST call **bpf_spin_unlock**\ () to release
2420 * the lock, on all execution paths, before it returns.
2421 * * The BPF program can access **struct bpf_spin_lock** only via
2422 * the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ ()
2423 * helpers. Loading or storing data into the **struct
2424 * bpf_spin_lock** *lock*\ **;** field of a map is not allowed.
2425 * * To use the **bpf_spin_lock**\ () helper, the BTF description
2426 * of the map value must be a struct and have **struct
2427 * bpf_spin_lock** *anyname*\ **;** field at the top level.
2428 * Nested lock inside another struct is not allowed.
2429 * * The **struct bpf_spin_lock** *lock* field in a map value must
2430 * be aligned on a multiple of 4 bytes in that value.
2431 * * Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy
2432 * the **bpf_spin_lock** field to user space.
2433 * * Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from
2434 * a BPF program, do not update the **bpf_spin_lock** field.
2435 * * **bpf_spin_lock** cannot be on the stack or inside a
2436 * networking packet (it can only be inside of a map values).
2437 * * **bpf_spin_lock** is available to root only.
2438 * * Tracing programs and socket filter programs cannot use
2439 * **bpf_spin_lock**\ () due to insufficient preemption checks
2440 * (but this may change in the future).
2441 * * **bpf_spin_lock** is not allowed in inner maps of map-in-map.
2442 * Return
2443 * 0
2444 *
2445 * int bpf_spin_unlock(struct bpf_spin_lock *lock)
2446 * Description
2447 * Release the *lock* previously locked by a call to
2448 * **bpf_spin_lock**\ (\ *lock*\ ).
2449 * Return
2450 * 0
2451 *
Martin KaFai Lau46f8bc92019-02-09 23:22:20 -08002452 * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk)
2453 * Description
2454 * This helper gets a **struct bpf_sock** pointer such
Quentin Monnet62369db2019-03-14 12:38:39 +00002455 * that all the fields in this **bpf_sock** can be accessed.
Martin KaFai Lau46f8bc92019-02-09 23:22:20 -08002456 * Return
Quentin Monnet62369db2019-03-14 12:38:39 +00002457 * A **struct bpf_sock** pointer on success, or **NULL** in
Martin KaFai Lau46f8bc92019-02-09 23:22:20 -08002458 * case of failure.
Martin KaFai Lau655a51e2019-02-09 23:22:24 -08002459 *
2460 * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk)
2461 * Description
2462 * This helper gets a **struct bpf_tcp_sock** pointer from a
2463 * **struct bpf_sock** pointer.
Martin KaFai Lau655a51e2019-02-09 23:22:24 -08002464 * Return
Quentin Monnet62369db2019-03-14 12:38:39 +00002465 * A **struct bpf_tcp_sock** pointer on success, or **NULL** in
Martin KaFai Lau655a51e2019-02-09 23:22:24 -08002466 * case of failure.
brakmof7c917b2019-03-01 12:38:46 -08002467 *
2468 * int bpf_skb_ecn_set_ce(struct sk_buf *skb)
Quentin Monnet62369db2019-03-14 12:38:39 +00002469 * Description
2470 * Set ECN (Explicit Congestion Notification) field of IP header
2471 * to **CE** (Congestion Encountered) if current value is **ECT**
2472 * (ECN Capable Transport). Otherwise, do nothing. Works with IPv6
2473 * and IPv4.
2474 * Return
2475 * 1 if the **CE** flag is set (either by the current helper call
2476 * or because it was already present), 0 if it is not set.
Martin KaFai Laudbafd7d2019-03-12 10:23:04 -07002477 *
2478 * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk)
2479 * Description
Quentin Monnet62369db2019-03-14 12:38:39 +00002480 * Return a **struct bpf_sock** pointer in **TCP_LISTEN** state.
2481 * **bpf_sk_release**\ () is unnecessary and not allowed.
Martin KaFai Laudbafd7d2019-03-12 10:23:04 -07002482 * Return
Quentin Monnet62369db2019-03-14 12:38:39 +00002483 * A **struct bpf_sock** pointer on success, or **NULL** in
Martin KaFai Laudbafd7d2019-03-12 10:23:04 -07002484 * case of failure.
Lorenz Baueredbf8c02019-03-22 09:54:01 +08002485 *
2486 * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
2487 * Description
2488 * Look for TCP socket matching *tuple*, optionally in a child
2489 * network namespace *netns*. The return value must be checked,
2490 * and if non-**NULL**, released via **bpf_sk_release**\ ().
2491 *
2492 * This function is identical to bpf_sk_lookup_tcp, except that it
2493 * also returns timewait or request sockets. Use bpf_sk_fullsock
2494 * or bpf_tcp_socket to access the full structure.
2495 *
2496 * This helper is available only if the kernel was compiled with
2497 * **CONFIG_NET** configuration option.
2498 * Return
2499 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
2500 * For sockets with reuseport option, the **struct bpf_sock**
2501 * result is from **reuse->socks**\ [] using the hash of the tuple.
Lorenz Bauer39904082019-03-22 09:54:02 +08002502 *
2503 * int bpf_tcp_check_syncookie(struct bpf_sock *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
2504 * Description
2505 * Check whether iph and th contain a valid SYN cookie ACK for
2506 * the listening socket in sk.
2507 *
2508 * iph points to the start of the IPv4 or IPv6 header, while
2509 * iph_len contains sizeof(struct iphdr) or sizeof(struct ip6hdr).
2510 *
2511 * th points to the start of the TCP header, while th_len contains
2512 * sizeof(struct tcphdr).
2513 *
2514 * Return
2515 * 0 if iph and th are a valid SYN cookie ACK, or a negative error
2516 * otherwise.
Andrey Ignatov808649f2019-02-27 13:28:48 -08002517 *
2518 * int bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags)
2519 * Description
2520 * Get name of sysctl in /proc/sys/ and copy it into provided by
2521 * program buffer *buf* of size *buf_len*.
2522 *
2523 * The buffer is always NUL terminated, unless it's zero-sized.
2524 *
2525 * If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is
2526 * copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name
2527 * only (e.g. "tcp_mem").
2528 * Return
2529 * Number of character copied (not including the trailing NUL).
2530 *
2531 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
2532 * truncated name in this case).
Andrey Ignatov1d11b302019-02-28 19:22:15 -08002533 *
2534 * int bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
2535 * Description
2536 * Get current value of sysctl as it is presented in /proc/sys
2537 * (incl. newline, etc), and copy it as a string into provided
2538 * by program buffer *buf* of size *buf_len*.
2539 *
2540 * The whole value is copied, no matter what file position user
2541 * space issued e.g. sys_read at.
2542 *
2543 * The buffer is always NUL terminated, unless it's zero-sized.
2544 * Return
2545 * Number of character copied (not including the trailing NUL).
2546 *
2547 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
2548 * truncated name in this case).
2549 *
2550 * **-EINVAL** if current value was unavailable, e.g. because
2551 * sysctl is uninitialized and read returns -EIO for it.
Andrey Ignatov4e63acd2019-03-07 18:38:43 -08002552 *
2553 * int bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
2554 * Description
2555 * Get new value being written by user space to sysctl (before
2556 * the actual write happens) and copy it as a string into
2557 * provided by program buffer *buf* of size *buf_len*.
2558 *
2559 * User space may write new value at file position > 0.
2560 *
2561 * The buffer is always NUL terminated, unless it's zero-sized.
2562 * Return
2563 * Number of character copied (not including the trailing NUL).
2564 *
2565 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
2566 * truncated name in this case).
2567 *
2568 * **-EINVAL** if sysctl is being read.
2569 *
2570 * int bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len)
2571 * Description
2572 * Override new value being written by user space to sysctl with
2573 * value provided by program in buffer *buf* of size *buf_len*.
2574 *
2575 * *buf* should contain a string in same form as provided by user
2576 * space on sysctl write.
2577 *
2578 * User space may write new value at file position > 0. To override
2579 * the whole sysctl value file position should be set to zero.
2580 * Return
2581 * 0 on success.
2582 *
2583 * **-E2BIG** if the *buf_len* is too big.
2584 *
2585 * **-EINVAL** if sysctl is being read.
Andrey Ignatovd7a4cb92019-03-18 17:55:26 -07002586 *
2587 * int bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res)
2588 * Description
2589 * Convert the initial part of the string from buffer *buf* of
2590 * size *buf_len* to a long integer according to the given base
2591 * and save the result in *res*.
2592 *
2593 * The string may begin with an arbitrary amount of white space
2594 * (as determined by isspace(3)) followed by a single optional '-'
2595 * sign.
2596 *
2597 * Five least significant bits of *flags* encode base, other bits
2598 * are currently unused.
2599 *
2600 * Base must be either 8, 10, 16 or 0 to detect it automatically
2601 * similar to user space strtol(3).
2602 * Return
2603 * Number of characters consumed on success. Must be positive but
2604 * no more than buf_len.
2605 *
2606 * **-EINVAL** if no valid digits were found or unsupported base
2607 * was provided.
2608 *
2609 * **-ERANGE** if resulting value was out of range.
2610 *
2611 * int bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res)
2612 * Description
2613 * Convert the initial part of the string from buffer *buf* of
2614 * size *buf_len* to an unsigned long integer according to the
2615 * given base and save the result in *res*.
2616 *
2617 * The string may begin with an arbitrary amount of white space
2618 * (as determined by isspace(3)).
2619 *
2620 * Five least significant bits of *flags* encode base, other bits
2621 * are currently unused.
2622 *
2623 * Base must be either 8, 10, 16 or 0 to detect it automatically
2624 * similar to user space strtoul(3).
2625 * Return
2626 * Number of characters consumed on success. Must be positive but
2627 * no more than buf_len.
2628 *
2629 * **-EINVAL** if no valid digits were found or unsupported base
2630 * was provided.
2631 *
2632 * **-ERANGE** if resulting value was out of range.
Thomas Grafebb676d2016-10-27 11:23:51 +02002633 */
2634#define __BPF_FUNC_MAPPER(FN) \
2635 FN(unspec), \
2636 FN(map_lookup_elem), \
2637 FN(map_update_elem), \
2638 FN(map_delete_elem), \
2639 FN(probe_read), \
2640 FN(ktime_get_ns), \
2641 FN(trace_printk), \
2642 FN(get_prandom_u32), \
2643 FN(get_smp_processor_id), \
2644 FN(skb_store_bytes), \
2645 FN(l3_csum_replace), \
2646 FN(l4_csum_replace), \
2647 FN(tail_call), \
2648 FN(clone_redirect), \
2649 FN(get_current_pid_tgid), \
2650 FN(get_current_uid_gid), \
2651 FN(get_current_comm), \
2652 FN(get_cgroup_classid), \
2653 FN(skb_vlan_push), \
2654 FN(skb_vlan_pop), \
2655 FN(skb_get_tunnel_key), \
2656 FN(skb_set_tunnel_key), \
2657 FN(perf_event_read), \
2658 FN(redirect), \
2659 FN(get_route_realm), \
2660 FN(perf_event_output), \
2661 FN(skb_load_bytes), \
2662 FN(get_stackid), \
2663 FN(csum_diff), \
2664 FN(skb_get_tunnel_opt), \
2665 FN(skb_set_tunnel_opt), \
2666 FN(skb_change_proto), \
2667 FN(skb_change_type), \
2668 FN(skb_under_cgroup), \
2669 FN(get_hash_recalc), \
2670 FN(get_current_task), \
2671 FN(probe_write_user), \
2672 FN(current_task_under_cgroup), \
2673 FN(skb_change_tail), \
2674 FN(skb_pull_data), \
2675 FN(csum_update), \
2676 FN(set_hash_invalid), \
Thomas Graf3a0af8f2016-11-30 17:10:10 +01002677 FN(get_numa_node_id), \
Martin KaFai Lau17bedab2016-12-07 15:53:11 -08002678 FN(skb_change_head), \
Gianluca Borelloa5e8c072017-01-18 17:55:49 +00002679 FN(xdp_adjust_head), \
Chenbo Feng91b82702017-03-22 17:27:34 -07002680 FN(probe_read_str), \
Chenbo Feng6acc5c22017-03-22 17:27:35 -07002681 FN(get_socket_cookie), \
Daniel Borkmannded092c2017-06-11 00:50:47 +02002682 FN(get_socket_uid), \
Lawrence Brakmo8c4b4c72017-06-30 20:02:46 -07002683 FN(set_hash), \
Daniel Borkmann2be7e212017-07-02 02:13:26 +02002684 FN(setsockopt), \
John Fastabend97f91a72017-07-17 09:29:18 -07002685 FN(skb_adjust_room), \
John Fastabend174a79f2017-08-15 22:32:47 -07002686 FN(redirect_map), \
2687 FN(sk_redirect_map), \
2688 FN(sock_map_update), \
Yonghong Song908432c2017-10-05 09:19:20 -07002689 FN(xdp_adjust_meta), \
Yonghong Song4bebdc72017-10-05 09:19:22 -07002690 FN(perf_event_read_value), \
Lawrence Brakmocd86d1f2017-10-20 11:05:40 -07002691 FN(perf_prog_read_value), \
Josef Bacik9802d862017-12-11 11:36:48 -05002692 FN(getsockopt), \
Lawrence Brakmob13d8802018-01-25 16:14:10 -08002693 FN(override_return), \
John Fastabend4f738ad2018-03-18 12:57:10 -07002694 FN(sock_ops_cb_flags_set), \
John Fastabend2a100312018-03-18 12:57:15 -07002695 FN(msg_redirect_map), \
John Fastabend91843d52018-03-18 12:57:20 -07002696 FN(msg_apply_bytes), \
John Fastabend015632b2018-03-18 12:57:25 -07002697 FN(msg_cork_bytes), \
Andrey Ignatovd74bad42018-03-30 15:08:05 -07002698 FN(msg_pull_data), \
Nikita V. Shirokovb32cc5b2018-04-17 21:42:13 -07002699 FN(bind), \
Eyal Birger12bed762018-04-24 17:50:29 +03002700 FN(xdp_adjust_tail), \
Yonghong Songc195651e2018-04-28 22:28:08 -07002701 FN(skb_get_xfrm_state), \
Daniel Borkmann4e1ec562018-05-04 01:08:15 +02002702 FN(get_stack), \
David Ahern87f5fc72018-05-09 20:34:26 -07002703 FN(skb_load_bytes_relative), \
John Fastabend81110382018-05-14 10:00:17 -07002704 FN(fib_lookup), \
2705 FN(sock_hash_update), \
2706 FN(msg_redirect_hash), \
Mathieu Xhonneuxfe94cc22018-05-20 14:58:14 +01002707 FN(sk_redirect_hash), \
2708 FN(lwt_push_encap), \
2709 FN(lwt_seg6_store_bytes), \
2710 FN(lwt_seg6_adjust_srh), \
Sean Youngf4364dc2018-05-27 12:24:09 +01002711 FN(lwt_seg6_action), \
2712 FN(rc_repeat), \
Daniel Borkmanncb20b082018-06-02 23:06:36 +02002713 FN(rc_keydown), \
Yonghong Songbf6fa2c2018-06-03 15:59:41 -07002714 FN(skb_cgroup_id), \
Roman Gushchincd339432018-08-02 14:27:24 -07002715 FN(get_current_cgroup_id), \
Martin KaFai Lau2dbb9b92018-08-08 01:01:25 -07002716 FN(get_local_storage), \
Andrey Ignatov77236282018-08-12 10:49:27 -07002717 FN(sk_select_reuseport), \
Joe Stringer6acc9b42018-10-02 13:35:36 -07002718 FN(skb_ancestor_cgroup_id), \
2719 FN(sk_lookup_tcp), \
2720 FN(sk_lookup_udp), \
Mauricio Vasquez Bf1a2e442018-10-18 15:16:25 +02002721 FN(sk_release), \
2722 FN(map_push_elem), \
2723 FN(map_pop_elem), \
John Fastabend6fff6072018-10-19 19:56:49 -07002724 FN(map_peek_elem), \
John Fastabend7246d8e2018-11-26 14:16:17 -08002725 FN(msg_push_data), \
Sean Young01d32402018-12-06 13:01:03 +00002726 FN(msg_pop_data), \
Alexei Starovoitovd83525c2019-01-31 15:40:04 -08002727 FN(rc_pointer_rel), \
2728 FN(spin_lock), \
Martin KaFai Lau46f8bc92019-02-09 23:22:20 -08002729 FN(spin_unlock), \
Martin KaFai Lau655a51e2019-02-09 23:22:24 -08002730 FN(sk_fullsock), \
brakmof7c917b2019-03-01 12:38:46 -08002731 FN(tcp_sock), \
Martin KaFai Laudbafd7d2019-03-12 10:23:04 -07002732 FN(skb_ecn_set_ce), \
Lorenz Baueredbf8c02019-03-22 09:54:01 +08002733 FN(get_listener_sock), \
Lorenz Bauer39904082019-03-22 09:54:02 +08002734 FN(skc_lookup_tcp), \
Andrey Ignatov808649f2019-02-27 13:28:48 -08002735 FN(tcp_check_syncookie), \
Andrey Ignatov1d11b302019-02-28 19:22:15 -08002736 FN(sysctl_get_name), \
Andrey Ignatov4e63acd2019-03-07 18:38:43 -08002737 FN(sysctl_get_current_value), \
2738 FN(sysctl_get_new_value), \
Andrey Ignatovd7a4cb92019-03-18 17:55:26 -07002739 FN(sysctl_set_new_value), \
2740 FN(strtol), \
2741 FN(strtoul),
Thomas Grafebb676d2016-10-27 11:23:51 +02002742
Alexei Starovoitov09756af2014-09-26 00:17:00 -07002743/* integer value in 'imm' field of BPF_CALL instruction selects which helper
2744 * function eBPF program intends to call
2745 */
Thomas Grafebb676d2016-10-27 11:23:51 +02002746#define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
Alexei Starovoitov09756af2014-09-26 00:17:00 -07002747enum bpf_func_id {
Thomas Grafebb676d2016-10-27 11:23:51 +02002748 __BPF_FUNC_MAPPER(__BPF_ENUM_FN)
Alexei Starovoitov09756af2014-09-26 00:17:00 -07002749 __BPF_FUNC_MAX_ID,
2750};
Thomas Grafebb676d2016-10-27 11:23:51 +02002751#undef __BPF_ENUM_FN
Alexei Starovoitov09756af2014-09-26 00:17:00 -07002752
Daniel Borkmann781c53b2016-01-11 01:16:38 +01002753/* All flags used by eBPF helper functions, placed here. */
2754
2755/* BPF_FUNC_skb_store_bytes flags. */
2756#define BPF_F_RECOMPUTE_CSUM (1ULL << 0)
Daniel Borkmann8afd54c2016-03-04 15:15:03 +01002757#define BPF_F_INVALIDATE_HASH (1ULL << 1)
Daniel Borkmann781c53b2016-01-11 01:16:38 +01002758
2759/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
2760 * First 4 bits are for passing the header field size.
2761 */
2762#define BPF_F_HDR_FIELD_MASK 0xfULL
2763
2764/* BPF_FUNC_l4_csum_replace flags. */
2765#define BPF_F_PSEUDO_HDR (1ULL << 4)
Daniel Borkmann2f729592016-02-19 23:05:26 +01002766#define BPF_F_MARK_MANGLED_0 (1ULL << 5)
Daniel Borkmannd1b662a2017-01-24 01:06:28 +01002767#define BPF_F_MARK_ENFORCE (1ULL << 6)
Daniel Borkmann781c53b2016-01-11 01:16:38 +01002768
2769/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
2770#define BPF_F_INGRESS (1ULL << 0)
2771
Daniel Borkmannc6c33452016-01-11 01:16:39 +01002772/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
2773#define BPF_F_TUNINFO_IPV6 (1ULL << 0)
2774
Yonghong Songc195651e2018-04-28 22:28:08 -07002775/* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -08002776#define BPF_F_SKIP_FIELD_MASK 0xffULL
2777#define BPF_F_USER_STACK (1ULL << 8)
Yonghong Songc195651e2018-04-28 22:28:08 -07002778/* flags used by BPF_FUNC_get_stackid only. */
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -08002779#define BPF_F_FAST_STACK_CMP (1ULL << 9)
2780#define BPF_F_REUSE_STACKID (1ULL << 10)
Yonghong Songc195651e2018-04-28 22:28:08 -07002781/* flags used by BPF_FUNC_get_stack only. */
2782#define BPF_F_USER_BUILD_ID (1ULL << 11)
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -08002783
Daniel Borkmann2da897e2016-02-23 02:05:26 +01002784/* BPF_FUNC_skb_set_tunnel_key flags. */
2785#define BPF_F_ZERO_CSUM_TX (1ULL << 1)
Daniel Borkmann22080872016-03-04 15:15:05 +01002786#define BPF_F_DONT_FRAGMENT (1ULL << 2)
William Tu77a51962018-03-01 13:49:57 -08002787#define BPF_F_SEQ_NUMBER (1ULL << 3)
Daniel Borkmann2da897e2016-02-23 02:05:26 +01002788
Yonghong Song908432c2017-10-05 09:19:20 -07002789/* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and
2790 * BPF_FUNC_perf_event_read_value flags.
2791 */
Daniel Borkmann1e337592016-04-18 21:01:23 +02002792#define BPF_F_INDEX_MASK 0xffffffffULL
2793#define BPF_F_CURRENT_CPU BPF_F_INDEX_MASK
Daniel Borkmann555c8a82016-07-14 18:08:05 +02002794/* BPF_FUNC_perf_event_output for sk_buff input context. */
2795#define BPF_F_CTXLEN_MASK (0xfffffULL << 32)
Daniel Borkmann1e337592016-04-18 21:01:23 +02002796
Joe Stringerf71c6142018-11-30 15:32:20 -08002797/* Current network namespace */
2798#define BPF_F_CURRENT_NETNS (-1L)
2799
Willem de Bruijn2278f6c2019-03-22 14:32:55 -04002800/* BPF_FUNC_skb_adjust_room flags. */
2801#define BPF_F_ADJ_ROOM_FIXED_GSO (1ULL << 0)
2802
Alan Maguirebfb35c22019-04-12 12:27:34 +01002803#define BPF_ADJ_ROOM_ENCAP_L2_MASK 0xff
2804#define BPF_ADJ_ROOM_ENCAP_L2_SHIFT 56
Alan Maguire58dfc902019-04-09 15:06:41 +01002805
Willem de Bruijn868d5232019-03-22 14:32:56 -04002806#define BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 (1ULL << 1)
2807#define BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 (1ULL << 2)
2808#define BPF_F_ADJ_ROOM_ENCAP_L4_GRE (1ULL << 3)
2809#define BPF_F_ADJ_ROOM_ENCAP_L4_UDP (1ULL << 4)
Alan Maguirebfb35c22019-04-12 12:27:34 +01002810#define BPF_F_ADJ_ROOM_ENCAP_L2(len) (((__u64)len & \
Alan Maguire58dfc902019-04-09 15:06:41 +01002811 BPF_ADJ_ROOM_ENCAP_L2_MASK) \
2812 << BPF_ADJ_ROOM_ENCAP_L2_SHIFT)
Willem de Bruijn868d5232019-03-22 14:32:56 -04002813
Andrey Ignatov808649f2019-02-27 13:28:48 -08002814/* BPF_FUNC_sysctl_get_name flags. */
2815#define BPF_F_SYSCTL_BASE_NAME (1ULL << 0)
2816
Daniel Borkmann2be7e212017-07-02 02:13:26 +02002817/* Mode for BPF_FUNC_skb_adjust_room helper. */
2818enum bpf_adj_room_mode {
2819 BPF_ADJ_ROOM_NET,
Willem de Bruijn14aa3192019-03-22 14:32:54 -04002820 BPF_ADJ_ROOM_MAC,
Daniel Borkmann2be7e212017-07-02 02:13:26 +02002821};
2822
Daniel Borkmann4e1ec562018-05-04 01:08:15 +02002823/* Mode for BPF_FUNC_skb_load_bytes_relative helper. */
2824enum bpf_hdr_start_off {
2825 BPF_HDR_START_MAC,
2826 BPF_HDR_START_NET,
2827};
2828
Mathieu Xhonneuxfe94cc22018-05-20 14:58:14 +01002829/* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */
2830enum bpf_lwt_encap_mode {
2831 BPF_LWT_ENCAP_SEG6,
Peter Oskolkov3e0bd372019-02-13 11:53:35 -08002832 BPF_LWT_ENCAP_SEG6_INLINE,
2833 BPF_LWT_ENCAP_IP,
Mathieu Xhonneuxfe94cc22018-05-20 14:58:14 +01002834};
2835
Daniel Borkmannb7df9ada2018-12-01 01:18:53 +01002836#define __bpf_md_ptr(type, name) \
2837union { \
2838 type name; \
2839 __u64 :64; \
2840} __attribute__((aligned(8)))
2841
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -07002842/* user accessible mirror of in-kernel sk_buff.
2843 * new fields can only be added to the end of this structure
2844 */
2845struct __sk_buff {
2846 __u32 len;
2847 __u32 pkt_type;
2848 __u32 mark;
2849 __u32 queue_mapping;
Alexei Starovoitovc2497392015-03-16 18:06:02 -07002850 __u32 protocol;
2851 __u32 vlan_present;
2852 __u32 vlan_tci;
Michal Sekletar27cd5452015-03-24 14:48:41 +01002853 __u32 vlan_proto;
Daniel Borkmannbcad5712015-04-03 20:52:24 +02002854 __u32 priority;
Alexei Starovoitov37e82c22015-05-27 15:30:39 -07002855 __u32 ingress_ifindex;
2856 __u32 ifindex;
Alexei Starovoitovd691f9e2015-06-04 10:11:54 -07002857 __u32 tc_index;
2858 __u32 cb[5];
Daniel Borkmannba7591d2015-08-01 00:46:29 +02002859 __u32 hash;
Daniel Borkmann045efa82015-09-15 23:05:42 -07002860 __u32 tc_classid;
Alexei Starovoitov969bf052016-05-05 19:49:10 -07002861 __u32 data;
2862 __u32 data_end;
Daniel Borkmannb1d9fc42017-04-19 23:01:17 +02002863 __u32 napi_id;
John Fastabend8a31db52017-08-15 22:33:09 -07002864
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02002865 /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */
John Fastabend8a31db52017-08-15 22:33:09 -07002866 __u32 family;
2867 __u32 remote_ip4; /* Stored in network byte order */
2868 __u32 local_ip4; /* Stored in network byte order */
2869 __u32 remote_ip6[4]; /* Stored in network byte order */
2870 __u32 local_ip6[4]; /* Stored in network byte order */
2871 __u32 remote_port; /* Stored in network byte order */
2872 __u32 local_port; /* stored in host byte order */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02002873 /* ... here. */
2874
2875 __u32 data_meta;
Daniel Borkmannb7df9ada2018-12-01 01:18:53 +01002876 __bpf_md_ptr(struct bpf_flow_keys *, flow_keys);
Vlad Dumitrescuf11216b2018-11-22 14:39:16 -05002877 __u64 tstamp;
Petar Penkove3da08d2018-12-02 20:18:19 -05002878 __u32 wire_len;
Eric Dumazetd9ff2862019-01-23 09:22:27 -08002879 __u32 gso_segs;
Martin KaFai Lau46f8bc92019-02-09 23:22:20 -08002880 __bpf_md_ptr(struct bpf_sock *, sk);
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -07002881};
2882
Alexei Starovoitovd3aa45c2015-07-30 15:36:57 -07002883struct bpf_tunnel_key {
2884 __u32 tunnel_id;
Daniel Borkmannc6c33452016-01-11 01:16:39 +01002885 union {
2886 __u32 remote_ipv4;
2887 __u32 remote_ipv6[4];
2888 };
2889 __u8 tunnel_tos;
2890 __u8 tunnel_ttl;
Daniel Borkmann1fbc2e02018-06-02 23:06:37 +02002891 __u16 tunnel_ext; /* Padding, future use. */
Daniel Borkmann4018ab12016-03-09 03:00:05 +01002892 __u32 tunnel_label;
Alexei Starovoitovd3aa45c2015-07-30 15:36:57 -07002893};
2894
Eyal Birger12bed762018-04-24 17:50:29 +03002895/* user accessible mirror of in-kernel xfrm_state.
2896 * new fields can only be added to the end of this structure
2897 */
2898struct bpf_xfrm_state {
2899 __u32 reqid;
2900 __u32 spi; /* Stored in network byte order */
2901 __u16 family;
Daniel Borkmann1fbc2e02018-06-02 23:06:37 +02002902 __u16 ext; /* Padding, future use. */
Eyal Birger12bed762018-04-24 17:50:29 +03002903 union {
2904 __u32 remote_ipv4; /* Stored in network byte order */
2905 __u32 remote_ipv6[4]; /* Stored in network byte order */
2906 };
2907};
2908
Thomas Graf3a0af8f2016-11-30 17:10:10 +01002909/* Generic BPF return codes which all BPF program types may support.
2910 * The values are binary compatible with their TC_ACT_* counter-part to
2911 * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
2912 * programs.
2913 *
2914 * XDP is handled seprately, see XDP_*.
2915 */
2916enum bpf_ret_code {
2917 BPF_OK = 0,
2918 /* 1 reserved */
2919 BPF_DROP = 2,
2920 /* 3-6 reserved */
2921 BPF_REDIRECT = 7,
Peter Oskolkov3e0bd372019-02-13 11:53:35 -08002922 /* >127 are reserved for prog type specific return codes.
2923 *
2924 * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and
2925 * BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been
2926 * changed and should be routed based on its new L3 header.
2927 * (This is an L3 redirect, as opposed to L2 redirect
2928 * represented by BPF_REDIRECT above).
2929 */
2930 BPF_LWT_REROUTE = 128,
Thomas Graf3a0af8f2016-11-30 17:10:10 +01002931};
2932
David Ahern610236582016-12-01 08:48:04 -08002933struct bpf_sock {
2934 __u32 bound_dev_if;
David Ahernaa4c1032016-12-01 08:48:06 -08002935 __u32 family;
2936 __u32 type;
2937 __u32 protocol;
David Ahern482dca92017-08-31 15:05:44 -07002938 __u32 mark;
2939 __u32 priority;
Martin KaFai Lauaa65d692019-02-09 23:22:21 -08002940 /* IP address also allows 1 and 2 bytes access */
2941 __u32 src_ip4;
2942 __u32 src_ip6[4];
2943 __u32 src_port; /* host byte order */
2944 __u32 dst_port; /* network byte order */
2945 __u32 dst_ip4;
2946 __u32 dst_ip6[4];
2947 __u32 state;
David Ahern610236582016-12-01 08:48:04 -08002948};
2949
Martin KaFai Lau655a51e2019-02-09 23:22:24 -08002950struct bpf_tcp_sock {
2951 __u32 snd_cwnd; /* Sending congestion window */
2952 __u32 srtt_us; /* smoothed round trip time << 3 in usecs */
2953 __u32 rtt_min;
2954 __u32 snd_ssthresh; /* Slow start size threshold */
2955 __u32 rcv_nxt; /* What we want to receive next */
2956 __u32 snd_nxt; /* Next sequence we send */
2957 __u32 snd_una; /* First byte we want an ack for */
2958 __u32 mss_cache; /* Cached effective mss, not including SACKS */
2959 __u32 ecn_flags; /* ECN status bits. */
2960 __u32 rate_delivered; /* saved rate sample: packets delivered */
2961 __u32 rate_interval_us; /* saved rate sample: time elapsed */
2962 __u32 packets_out; /* Packets which are "in flight" */
2963 __u32 retrans_out; /* Retransmitted packets out */
2964 __u32 total_retrans; /* Total retransmits for entire connection */
2965 __u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn
2966 * total number of segments in.
2967 */
2968 __u32 data_segs_in; /* RFC4898 tcpEStatsPerfDataSegsIn
2969 * total number of data segments in.
2970 */
2971 __u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut
2972 * The total number of segments sent.
2973 */
2974 __u32 data_segs_out; /* RFC4898 tcpEStatsPerfDataSegsOut
2975 * total number of data segments sent.
2976 */
2977 __u32 lost_out; /* Lost packets */
2978 __u32 sacked_out; /* SACK'd packets */
2979 __u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived
2980 * sum(delta(rcv_nxt)), or how many bytes
2981 * were acked.
2982 */
2983 __u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked
2984 * sum(delta(snd_una)), or how many bytes
2985 * were acked.
2986 */
2987};
2988
Joe Stringer6acc9b42018-10-02 13:35:36 -07002989struct bpf_sock_tuple {
2990 union {
2991 struct {
2992 __be32 saddr;
2993 __be32 daddr;
2994 __be16 sport;
2995 __be16 dport;
2996 } ipv4;
2997 struct {
2998 __be32 saddr[4];
2999 __be32 daddr[4];
3000 __be16 sport;
3001 __be16 dport;
3002 } ipv6;
3003 };
3004};
3005
Martin KaFai Lau17bedab2016-12-07 15:53:11 -08003006#define XDP_PACKET_HEADROOM 256
3007
Brenden Blanco6a773a12016-07-19 12:16:47 -07003008/* User return codes for XDP prog type.
3009 * A valid XDP program must return one of these defined values. All other
Daniel Borkmann9beb8be2017-09-09 01:40:35 +02003010 * return codes are reserved for future use. Unknown return codes will
3011 * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
Brenden Blanco6a773a12016-07-19 12:16:47 -07003012 */
3013enum xdp_action {
3014 XDP_ABORTED = 0,
3015 XDP_DROP,
3016 XDP_PASS,
Brenden Blanco6ce96ca2016-07-19 12:16:53 -07003017 XDP_TX,
John Fastabend814abfa2017-07-17 09:27:07 -07003018 XDP_REDIRECT,
Brenden Blanco6a773a12016-07-19 12:16:47 -07003019};
3020
3021/* user accessible metadata for XDP packet hook
3022 * new fields must be added to the end of this structure
3023 */
3024struct xdp_md {
3025 __u32 data;
3026 __u32 data_end;
Daniel Borkmannde8f3a82017-09-25 02:25:51 +02003027 __u32 data_meta;
Jesper Dangaard Brouerdaaf24c2018-01-11 17:39:09 +01003028 /* Below access go through struct xdp_rxq_info */
Jesper Dangaard Brouer02dd3292018-01-03 11:26:14 +01003029 __u32 ingress_ifindex; /* rxq->dev->ifindex */
3030 __u32 rx_queue_index; /* rxq->queue_index */
Brenden Blanco6a773a12016-07-19 12:16:47 -07003031};
3032
John Fastabend174a79f2017-08-15 22:32:47 -07003033enum sk_action {
John Fastabendbfa640752017-10-27 09:45:53 -07003034 SK_DROP = 0,
3035 SK_PASS,
John Fastabend174a79f2017-08-15 22:32:47 -07003036};
3037
John Fastabend4f738ad2018-03-18 12:57:10 -07003038/* user accessible metadata for SK_MSG packet hook, new fields must
3039 * be added to the end of this structure
3040 */
3041struct sk_msg_md {
Daniel Borkmannb7df9ada2018-12-01 01:18:53 +01003042 __bpf_md_ptr(void *, data);
3043 __bpf_md_ptr(void *, data_end);
John Fastabend303def32018-05-17 14:16:58 -07003044
3045 __u32 family;
3046 __u32 remote_ip4; /* Stored in network byte order */
3047 __u32 local_ip4; /* Stored in network byte order */
3048 __u32 remote_ip6[4]; /* Stored in network byte order */
3049 __u32 local_ip6[4]; /* Stored in network byte order */
3050 __u32 remote_port; /* Stored in network byte order */
3051 __u32 local_port; /* stored in host byte order */
John Fastabend3bdbd022018-12-16 15:47:04 -08003052 __u32 size; /* Total size of sk_msg */
John Fastabend4f738ad2018-03-18 12:57:10 -07003053};
3054
Martin KaFai Lau2dbb9b92018-08-08 01:01:25 -07003055struct sk_reuseport_md {
3056 /*
3057 * Start of directly accessible data. It begins from
3058 * the tcp/udp header.
3059 */
Daniel Borkmannb7df9ada2018-12-01 01:18:53 +01003060 __bpf_md_ptr(void *, data);
3061 /* End of directly accessible data */
3062 __bpf_md_ptr(void *, data_end);
Martin KaFai Lau2dbb9b92018-08-08 01:01:25 -07003063 /*
3064 * Total length of packet (starting from the tcp/udp header).
3065 * Note that the directly accessible bytes (data_end - data)
3066 * could be less than this "len". Those bytes could be
3067 * indirectly read by a helper "bpf_skb_load_bytes()".
3068 */
3069 __u32 len;
3070 /*
3071 * Eth protocol in the mac header (network byte order). e.g.
3072 * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD)
3073 */
3074 __u32 eth_protocol;
3075 __u32 ip_protocol; /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */
3076 __u32 bind_inany; /* Is sock bound to an INANY address? */
3077 __u32 hash; /* A hash of the packet 4 tuples */
3078};
3079
Martin KaFai Lau1e270972017-06-05 12:15:52 -07003080#define BPF_TAG_SIZE 8
3081
3082struct bpf_prog_info {
3083 __u32 type;
3084 __u32 id;
3085 __u8 tag[BPF_TAG_SIZE];
3086 __u32 jited_prog_len;
3087 __u32 xlated_prog_len;
3088 __aligned_u64 jited_prog_insns;
3089 __aligned_u64 xlated_prog_insns;
Martin KaFai Laucb4d2b32017-09-27 14:37:52 -07003090 __u64 load_time; /* ns since boottime */
3091 __u32 created_by_uid;
3092 __u32 nr_map_ids;
3093 __aligned_u64 map_ids;
Martin KaFai Lau067cae42017-10-05 21:52:12 -07003094 char name[BPF_OBJ_NAME_LEN];
Jakub Kicinski675fc272017-12-27 18:39:09 -08003095 __u32 ifindex;
Jiri Olsab85fab02018-04-25 19:41:06 +02003096 __u32 gpl_compatible:1;
Jakub Kicinski675fc272017-12-27 18:39:09 -08003097 __u64 netns_dev;
3098 __u64 netns_ino;
Sandipan Dasdbecd732018-05-24 12:26:48 +05303099 __u32 nr_jited_ksyms;
Sandipan Das815581c2018-05-24 12:26:52 +05303100 __u32 nr_jited_func_lens;
Sandipan Dasdbecd732018-05-24 12:26:48 +05303101 __aligned_u64 jited_ksyms;
Sandipan Das815581c2018-05-24 12:26:52 +05303102 __aligned_u64 jited_func_lens;
Yonghong Song838e9692018-11-19 15:29:11 -08003103 __u32 btf_id;
3104 __u32 func_info_rec_size;
3105 __aligned_u64 func_info;
Yonghong Song11d8b822018-12-10 14:14:08 -08003106 __u32 nr_func_info;
3107 __u32 nr_line_info;
Martin KaFai Lauc454a462018-12-07 16:42:25 -08003108 __aligned_u64 line_info;
3109 __aligned_u64 jited_line_info;
Yonghong Song11d8b822018-12-10 14:14:08 -08003110 __u32 nr_jited_line_info;
Martin KaFai Lauc454a462018-12-07 16:42:25 -08003111 __u32 line_info_rec_size;
3112 __u32 jited_line_info_rec_size;
Song Liuc872bdb2018-12-12 09:37:46 -08003113 __u32 nr_prog_tags;
3114 __aligned_u64 prog_tags;
Alexei Starovoitov5f8f8b92019-02-25 14:28:40 -08003115 __u64 run_time_ns;
3116 __u64 run_cnt;
Martin KaFai Lau1e270972017-06-05 12:15:52 -07003117} __attribute__((aligned(8)));
3118
3119struct bpf_map_info {
3120 __u32 type;
3121 __u32 id;
3122 __u32 key_size;
3123 __u32 value_size;
3124 __u32 max_entries;
3125 __u32 map_flags;
Martin KaFai Lau067cae42017-10-05 21:52:12 -07003126 char name[BPF_OBJ_NAME_LEN];
Jakub Kicinski52775b32018-01-17 19:13:28 -08003127 __u32 ifindex;
Daniel Borkmann36f98142018-06-02 05:21:59 +02003128 __u32 :32;
Jakub Kicinski52775b32018-01-17 19:13:28 -08003129 __u64 netns_dev;
3130 __u64 netns_ino;
Martin KaFai Lau78958fc2018-05-04 14:49:51 -07003131 __u32 btf_id;
Martin KaFai Lau9b2cf322018-05-22 14:57:21 -07003132 __u32 btf_key_type_id;
3133 __u32 btf_value_type_id;
Martin KaFai Lau1e270972017-06-05 12:15:52 -07003134} __attribute__((aligned(8)));
3135
Martin KaFai Lau62dab842018-05-04 14:49:52 -07003136struct bpf_btf_info {
3137 __aligned_u64 btf;
3138 __u32 btf_size;
3139 __u32 id;
3140} __attribute__((aligned(8)));
3141
Andrey Ignatov4fbac772018-03-30 15:08:02 -07003142/* User bpf_sock_addr struct to access socket fields and sockaddr struct passed
3143 * by user and intended to be used by socket (e.g. to bind to, depends on
3144 * attach attach type).
3145 */
3146struct bpf_sock_addr {
3147 __u32 user_family; /* Allows 4-byte read, but no write. */
3148 __u32 user_ip4; /* Allows 1,2,4-byte read and 4-byte write.
3149 * Stored in network byte order.
3150 */
3151 __u32 user_ip6[4]; /* Allows 1,2,4-byte read an 4-byte write.
3152 * Stored in network byte order.
3153 */
3154 __u32 user_port; /* Allows 4-byte read and write.
3155 * Stored in network byte order
3156 */
3157 __u32 family; /* Allows 4-byte read, but no write */
3158 __u32 type; /* Allows 4-byte read, but no write */
3159 __u32 protocol; /* Allows 4-byte read, but no write */
Andrey Ignatov1cedee12018-05-25 08:55:23 -07003160 __u32 msg_src_ip4; /* Allows 1,2,4-byte read an 4-byte write.
3161 * Stored in network byte order.
3162 */
3163 __u32 msg_src_ip6[4]; /* Allows 1,2,4-byte read an 4-byte write.
3164 * Stored in network byte order.
3165 */
Andrey Ignatov4fbac772018-03-30 15:08:02 -07003166};
3167
Lawrence Brakmo40304b22017-06-30 20:02:40 -07003168/* User bpf_sock_ops struct to access socket values and specify request ops
3169 * and their replies.
3170 * Some of this fields are in network (bigendian) byte order and may need
3171 * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
3172 * New fields can only be added at the end of this structure
3173 */
3174struct bpf_sock_ops {
3175 __u32 op;
3176 union {
Lawrence Brakmode525be2018-01-25 16:14:09 -08003177 __u32 args[4]; /* Optionally passed to bpf program */
3178 __u32 reply; /* Returned by bpf program */
3179 __u32 replylong[4]; /* Optionally returned by bpf prog */
Lawrence Brakmo40304b22017-06-30 20:02:40 -07003180 };
3181 __u32 family;
3182 __u32 remote_ip4; /* Stored in network byte order */
3183 __u32 local_ip4; /* Stored in network byte order */
3184 __u32 remote_ip6[4]; /* Stored in network byte order */
3185 __u32 local_ip6[4]; /* Stored in network byte order */
3186 __u32 remote_port; /* Stored in network byte order */
3187 __u32 local_port; /* stored in host byte order */
Lawrence Brakmof19397a2017-12-01 10:15:04 -08003188 __u32 is_fullsock; /* Some TCP fields are only valid if
3189 * there is a full socket. If not, the
3190 * fields read as zero.
3191 */
3192 __u32 snd_cwnd;
3193 __u32 srtt_us; /* Averaged RTT << 3 in usecs */
Lawrence Brakmob13d8802018-01-25 16:14:10 -08003194 __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */
Lawrence Brakmo44f0e432018-01-25 16:14:12 -08003195 __u32 state;
3196 __u32 rtt_min;
3197 __u32 snd_ssthresh;
3198 __u32 rcv_nxt;
3199 __u32 snd_nxt;
3200 __u32 snd_una;
3201 __u32 mss_cache;
3202 __u32 ecn_flags;
3203 __u32 rate_delivered;
3204 __u32 rate_interval_us;
3205 __u32 packets_out;
3206 __u32 retrans_out;
3207 __u32 total_retrans;
3208 __u32 segs_in;
3209 __u32 data_segs_in;
3210 __u32 segs_out;
3211 __u32 data_segs_out;
3212 __u32 lost_out;
3213 __u32 sacked_out;
3214 __u32 sk_txhash;
3215 __u64 bytes_received;
3216 __u64 bytes_acked;
Lawrence Brakmo40304b22017-06-30 20:02:40 -07003217};
3218
Lawrence Brakmob13d8802018-01-25 16:14:10 -08003219/* Definitions for bpf_sock_ops_cb_flags */
Lawrence Brakmof89013f2018-01-25 16:14:11 -08003220#define BPF_SOCK_OPS_RTO_CB_FLAG (1<<0)
Lawrence Brakmoa31ad292018-01-25 16:14:14 -08003221#define BPF_SOCK_OPS_RETRANS_CB_FLAG (1<<1)
Lawrence Brakmod4487492018-01-25 16:14:15 -08003222#define BPF_SOCK_OPS_STATE_CB_FLAG (1<<2)
3223#define BPF_SOCK_OPS_ALL_CB_FLAGS 0x7 /* Mask of all currently
Lawrence Brakmob13d8802018-01-25 16:14:10 -08003224 * supported cb flags
3225 */
3226
Lawrence Brakmo40304b22017-06-30 20:02:40 -07003227/* List of known BPF sock_ops operators.
3228 * New entries can only be added at the end
3229 */
3230enum {
3231 BPF_SOCK_OPS_VOID,
Lawrence Brakmo8550f322017-06-30 20:02:42 -07003232 BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or
3233 * -1 if default value should be used
3234 */
Lawrence Brakmo13d3b1e2017-06-30 20:02:44 -07003235 BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized
3236 * window (in packets) or -1 if default
3237 * value should be used
3238 */
Lawrence Brakmo9872a4b2017-06-30 20:02:47 -07003239 BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an
3240 * active connection is initialized
3241 */
3242 BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an
3243 * active connection is
3244 * established
3245 */
3246 BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a
3247 * passive connection is
3248 * established
3249 */
Lawrence Brakmo91b5b212017-06-30 20:02:49 -07003250 BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control
3251 * needs ECN
3252 */
Lawrence Brakmoe6546ef2017-10-20 11:05:39 -07003253 BPF_SOCK_OPS_BASE_RTT, /* Get base RTT. The correct value is
3254 * based on the path and may be
3255 * dependent on the congestion control
3256 * algorithm. In general it indicates
3257 * a congestion threshold. RTTs above
3258 * this indicate congestion
3259 */
Lawrence Brakmof89013f2018-01-25 16:14:11 -08003260 BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered.
3261 * Arg1: value of icsk_retransmits
3262 * Arg2: value of icsk_rto
3263 * Arg3: whether RTO has expired
3264 */
Lawrence Brakmoa31ad292018-01-25 16:14:14 -08003265 BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted.
3266 * Arg1: sequence number of 1st byte
3267 * Arg2: # segments
3268 * Arg3: return value of
3269 * tcp_transmit_skb (0 => success)
3270 */
Lawrence Brakmod4487492018-01-25 16:14:15 -08003271 BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state.
3272 * Arg1: old_state
3273 * Arg2: new_state
3274 */
Andrey Ignatovf333ee02018-07-11 17:33:32 -07003275 BPF_SOCK_OPS_TCP_LISTEN_CB, /* Called on listen(2), right after
3276 * socket transition to LISTEN state.
3277 */
Lawrence Brakmod4487492018-01-25 16:14:15 -08003278};
3279
3280/* List of TCP states. There is a build check in net/ipv4/tcp.c to detect
3281 * changes between the TCP and BPF versions. Ideally this should never happen.
3282 * If it does, we need to add code to convert them before calling
3283 * the BPF sock_ops function.
3284 */
3285enum {
3286 BPF_TCP_ESTABLISHED = 1,
3287 BPF_TCP_SYN_SENT,
3288 BPF_TCP_SYN_RECV,
3289 BPF_TCP_FIN_WAIT1,
3290 BPF_TCP_FIN_WAIT2,
3291 BPF_TCP_TIME_WAIT,
3292 BPF_TCP_CLOSE,
3293 BPF_TCP_CLOSE_WAIT,
3294 BPF_TCP_LAST_ACK,
3295 BPF_TCP_LISTEN,
3296 BPF_TCP_CLOSING, /* Now a valid state */
3297 BPF_TCP_NEW_SYN_RECV,
3298
3299 BPF_TCP_MAX_STATES /* Leave at the end! */
Lawrence Brakmo40304b22017-06-30 20:02:40 -07003300};
3301
Lawrence Brakmofc747812017-06-30 20:02:51 -07003302#define TCP_BPF_IW 1001 /* Set TCP initial congestion window */
Lawrence Brakmo13bf9642017-06-30 20:02:53 -07003303#define TCP_BPF_SNDCWND_CLAMP 1002 /* Set sndcwnd_clamp */
Lawrence Brakmofc747812017-06-30 20:02:51 -07003304
Yonghong Song908432c2017-10-05 09:19:20 -07003305struct bpf_perf_event_value {
3306 __u64 counter;
3307 __u64 enabled;
3308 __u64 running;
3309};
3310
Roman Gushchinebc614f2017-11-05 08:15:32 -05003311#define BPF_DEVCG_ACC_MKNOD (1ULL << 0)
3312#define BPF_DEVCG_ACC_READ (1ULL << 1)
3313#define BPF_DEVCG_ACC_WRITE (1ULL << 2)
3314
3315#define BPF_DEVCG_DEV_BLOCK (1ULL << 0)
3316#define BPF_DEVCG_DEV_CHAR (1ULL << 1)
3317
3318struct bpf_cgroup_dev_ctx {
Yonghong Song06ef0cc2017-12-18 10:13:44 -08003319 /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */
3320 __u32 access_type;
Roman Gushchinebc614f2017-11-05 08:15:32 -05003321 __u32 major;
3322 __u32 minor;
3323};
3324
Alexei Starovoitovc4f66992018-03-28 12:05:37 -07003325struct bpf_raw_tracepoint_args {
3326 __u64 args[0];
3327};
3328
David Ahern87f5fc72018-05-09 20:34:26 -07003329/* DIRECT: Skip the FIB rules and go to FIB table associated with device
3330 * OUTPUT: Do lookup from egress perspective; default is ingress
3331 */
3332#define BPF_FIB_LOOKUP_DIRECT BIT(0)
3333#define BPF_FIB_LOOKUP_OUTPUT BIT(1)
3334
David Ahern4c795792018-06-26 16:21:18 -07003335enum {
3336 BPF_FIB_LKUP_RET_SUCCESS, /* lookup successful */
3337 BPF_FIB_LKUP_RET_BLACKHOLE, /* dest is blackholed; can be dropped */
3338 BPF_FIB_LKUP_RET_UNREACHABLE, /* dest is unreachable; can be dropped */
3339 BPF_FIB_LKUP_RET_PROHIBIT, /* dest not allowed; can be dropped */
3340 BPF_FIB_LKUP_RET_NOT_FWDED, /* packet is not forwarded */
3341 BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */
3342 BPF_FIB_LKUP_RET_UNSUPP_LWT, /* fwd requires encapsulation */
3343 BPF_FIB_LKUP_RET_NO_NEIGH, /* no neighbor entry for nh */
3344 BPF_FIB_LKUP_RET_FRAG_NEEDED, /* fragmentation required to fwd */
3345};
3346
David Ahern87f5fc72018-05-09 20:34:26 -07003347struct bpf_fib_lookup {
David Ahernfa898d72018-05-29 10:58:07 -07003348 /* input: network family for lookup (AF_INET, AF_INET6)
3349 * output: network family of egress nexthop
3350 */
3351 __u8 family;
David Ahern87f5fc72018-05-09 20:34:26 -07003352
3353 /* set if lookup is to consider L4 data - e.g., FIB rules */
3354 __u8 l4_protocol;
3355 __be16 sport;
3356 __be16 dport;
3357
3358 /* total length of packet from network header - used for MTU check */
3359 __u16 tot_len;
David Ahern4c795792018-06-26 16:21:18 -07003360
3361 /* input: L3 device index for lookup
3362 * output: device index from FIB lookup
3363 */
3364 __u32 ifindex;
David Ahern87f5fc72018-05-09 20:34:26 -07003365
3366 union {
3367 /* inputs to lookup */
3368 __u8 tos; /* AF_INET */
David Ahernbd3a08a2018-06-03 08:15:19 -07003369 __be32 flowinfo; /* AF_INET6, flow_label + priority */
David Ahern87f5fc72018-05-09 20:34:26 -07003370
David Ahernfa898d72018-05-29 10:58:07 -07003371 /* output: metric of fib result (IPv4/IPv6 only) */
3372 __u32 rt_metric;
David Ahern87f5fc72018-05-09 20:34:26 -07003373 };
3374
3375 union {
David Ahern87f5fc72018-05-09 20:34:26 -07003376 __be32 ipv4_src;
3377 __u32 ipv6_src[4]; /* in6_addr; network order */
3378 };
3379
David Ahernfa898d72018-05-29 10:58:07 -07003380 /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in
3381 * network header. output: bpf_fib_lookup sets to gateway address
3382 * if FIB lookup returns gateway route
David Ahern87f5fc72018-05-09 20:34:26 -07003383 */
3384 union {
David Ahern87f5fc72018-05-09 20:34:26 -07003385 __be32 ipv4_dst;
3386 __u32 ipv6_dst[4]; /* in6_addr; network order */
3387 };
3388
3389 /* output */
3390 __be16 h_vlan_proto;
3391 __be16 h_vlan_TCI;
3392 __u8 smac[6]; /* ETH_ALEN */
3393 __u8 dmac[6]; /* ETH_ALEN */
3394};
3395
Yonghong Song41bdc4b2018-05-24 11:21:09 -07003396enum bpf_task_fd_type {
3397 BPF_FD_TYPE_RAW_TRACEPOINT, /* tp name */
3398 BPF_FD_TYPE_TRACEPOINT, /* tp name */
3399 BPF_FD_TYPE_KPROBE, /* (symbol + offset) or addr */
3400 BPF_FD_TYPE_KRETPROBE, /* (symbol + offset) or addr */
3401 BPF_FD_TYPE_UPROBE, /* filename + offset */
3402 BPF_FD_TYPE_URETPROBE, /* filename + offset */
3403};
3404
Petar Penkovd58e4682018-09-14 07:46:18 -07003405struct bpf_flow_keys {
3406 __u16 nhoff;
3407 __u16 thoff;
3408 __u16 addr_proto; /* ETH_P_* of valid addrs */
3409 __u8 is_frag;
3410 __u8 is_first_frag;
3411 __u8 is_encap;
3412 __u8 ip_proto;
3413 __be16 n_proto;
3414 __be16 sport;
3415 __be16 dport;
3416 union {
3417 struct {
3418 __be32 ipv4_src;
3419 __be32 ipv4_dst;
3420 };
3421 struct {
3422 __u32 ipv6_src[4]; /* in6_addr; network order */
3423 __u32 ipv6_dst[4]; /* in6_addr; network order */
3424 };
3425 };
3426};
3427
Yonghong Song838e9692018-11-19 15:29:11 -08003428struct bpf_func_info {
Martin KaFai Laud30d42e2018-12-05 17:35:44 -08003429 __u32 insn_off;
Yonghong Song838e9692018-11-19 15:29:11 -08003430 __u32 type_id;
3431};
3432
Martin KaFai Lauc454a462018-12-07 16:42:25 -08003433#define BPF_LINE_INFO_LINE_NUM(line_col) ((line_col) >> 10)
3434#define BPF_LINE_INFO_LINE_COL(line_col) ((line_col) & 0x3ff)
3435
3436struct bpf_line_info {
3437 __u32 insn_off;
3438 __u32 file_name_off;
3439 __u32 line_off;
3440 __u32 line_col;
3441};
3442
Alexei Starovoitovd83525c2019-01-31 15:40:04 -08003443struct bpf_spin_lock {
3444 __u32 val;
3445};
Andrey Ignatov7b146ce2019-02-27 12:59:24 -08003446
3447struct bpf_sysctl {
3448 __u32 write; /* Sysctl is being read (= 0) or written (= 1).
3449 * Allows 1,2,4-byte read, but no write.
3450 */
Andrey Ignatove1550bf2019-03-07 18:50:52 -08003451 __u32 file_pos; /* Sysctl file position to read from, write to.
3452 * Allows 1,2,4-byte read an 4-byte write.
3453 */
Andrey Ignatov7b146ce2019-02-27 12:59:24 -08003454};
3455
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -07003456#endif /* _UAPI__LINUX_BPF_H__ */