blob: f90860d1f8979e03b10063a04179bed44c137e5a [file] [log] [blame]
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -07001/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
2 *
3 * This program is free software; you can redistribute it and/or
4 * modify it under the terms of version 2 of the GNU General Public
5 * License as published by the Free Software Foundation.
6 */
7#ifndef _UAPI__LINUX_BPF_H__
8#define _UAPI__LINUX_BPF_H__
9
10#include <linux/types.h>
Alexei Starovoitovc15952d2014-10-14 02:08:54 -070011#include <linux/bpf_common.h>
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070012
13/* Extended instruction set based on top of classic BPF */
14
15/* instruction classes */
16#define BPF_ALU64 0x07 /* alu mode in double word width */
17
18/* ld/ldx fields */
19#define BPF_DW 0x18 /* double word */
20#define BPF_XADD 0xc0 /* exclusive add */
21
22/* alu/jmp fields */
23#define BPF_MOV 0xb0 /* mov reg to reg */
24#define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */
25
26/* change endianness of a register */
27#define BPF_END 0xd0 /* flags for endianness conversion: */
28#define BPF_TO_LE 0x00 /* convert to little-endian */
29#define BPF_TO_BE 0x08 /* convert to big-endian */
30#define BPF_FROM_LE BPF_TO_LE
31#define BPF_FROM_BE BPF_TO_BE
32
Daniel Borkmann92b31a92017-08-10 01:39:55 +020033/* jmp encodings */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070034#define BPF_JNE 0x50 /* jump != */
Daniel Borkmann92b31a92017-08-10 01:39:55 +020035#define BPF_JLT 0xa0 /* LT is unsigned, '<' */
36#define BPF_JLE 0xb0 /* LE is unsigned, '<=' */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070037#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
38#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
Daniel Borkmann92b31a92017-08-10 01:39:55 +020039#define BPF_JSLT 0xc0 /* SLT is signed, '<' */
40#define BPF_JSLE 0xd0 /* SLE is signed, '<=' */
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -070041#define BPF_CALL 0x80 /* function call */
42#define BPF_EXIT 0x90 /* function return */
43
44/* Register numbers */
45enum {
46 BPF_REG_0 = 0,
47 BPF_REG_1,
48 BPF_REG_2,
49 BPF_REG_3,
50 BPF_REG_4,
51 BPF_REG_5,
52 BPF_REG_6,
53 BPF_REG_7,
54 BPF_REG_8,
55 BPF_REG_9,
56 BPF_REG_10,
57 __MAX_BPF_REG,
58};
59
60/* BPF has 10 general purpose 64-bit registers and stack frame. */
61#define MAX_BPF_REG __MAX_BPF_REG
62
63struct bpf_insn {
64 __u8 code; /* opcode */
65 __u8 dst_reg:4; /* dest register */
66 __u8 src_reg:4; /* source register */
67 __s16 off; /* signed offset */
68 __s32 imm; /* signed immediate constant */
69};
70
Daniel Mackb95a5c42017-01-21 17:26:11 +010071/* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
72struct bpf_lpm_trie_key {
73 __u32 prefixlen; /* up to 32 for AF_INET, 128 for AF_INET6 */
74 __u8 data[0]; /* Arbitrary size */
75};
76
Daniel Borkmannb2197752015-10-29 14:58:09 +010077/* BPF syscall commands, see bpf(2) man-page for details. */
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070078enum bpf_cmd {
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070079 BPF_MAP_CREATE,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070080 BPF_MAP_LOOKUP_ELEM,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070081 BPF_MAP_UPDATE_ELEM,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070082 BPF_MAP_DELETE_ELEM,
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070083 BPF_MAP_GET_NEXT_KEY,
Alexei Starovoitov09756af2014-09-26 00:17:00 -070084 BPF_PROG_LOAD,
Daniel Borkmannb2197752015-10-29 14:58:09 +010085 BPF_OBJ_PIN,
86 BPF_OBJ_GET,
Daniel Mackf4324552016-11-23 16:52:27 +010087 BPF_PROG_ATTACH,
88 BPF_PROG_DETACH,
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -070089 BPF_PROG_TEST_RUN,
Martin KaFai Lau34ad5582017-06-05 12:15:48 -070090 BPF_PROG_GET_NEXT_ID,
91 BPF_MAP_GET_NEXT_ID,
Martin KaFai Laub16d9aa2017-06-05 12:15:49 -070092 BPF_PROG_GET_FD_BY_ID,
Martin KaFai Laubd5f5f42017-06-05 12:15:50 -070093 BPF_MAP_GET_FD_BY_ID,
Martin KaFai Lau1e270972017-06-05 12:15:52 -070094 BPF_OBJ_GET_INFO_BY_FD,
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070095};
96
97enum bpf_map_type {
98 BPF_MAP_TYPE_UNSPEC,
Alexei Starovoitov0f8e4bd2014-11-13 17:36:45 -080099 BPF_MAP_TYPE_HASH,
Alexei Starovoitov28fbcfa2014-11-13 17:36:46 -0800100 BPF_MAP_TYPE_ARRAY,
Alexei Starovoitov04fd61a2015-05-19 16:59:03 -0700101 BPF_MAP_TYPE_PROG_ARRAY,
Kaixu Xiaea317b22015-08-06 07:02:34 +0000102 BPF_MAP_TYPE_PERF_EVENT_ARRAY,
Alexei Starovoitov824bd0c2016-02-01 22:39:53 -0800103 BPF_MAP_TYPE_PERCPU_HASH,
Alexei Starovoitova10423b2016-02-01 22:39:54 -0800104 BPF_MAP_TYPE_PERCPU_ARRAY,
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -0800105 BPF_MAP_TYPE_STACK_TRACE,
Martin KaFai Lau4ed8ec52016-06-30 10:28:43 -0700106 BPF_MAP_TYPE_CGROUP_ARRAY,
Martin KaFai Lau29ba7322016-11-11 10:55:09 -0800107 BPF_MAP_TYPE_LRU_HASH,
Martin KaFai Lau8f844932016-11-11 10:55:10 -0800108 BPF_MAP_TYPE_LRU_PERCPU_HASH,
Daniel Mackb95a5c42017-01-21 17:26:11 +0100109 BPF_MAP_TYPE_LPM_TRIE,
Martin KaFai Lau56f668d2017-03-22 10:00:33 -0700110 BPF_MAP_TYPE_ARRAY_OF_MAPS,
Martin KaFai Laubcc6b1b2017-03-22 10:00:34 -0700111 BPF_MAP_TYPE_HASH_OF_MAPS,
John Fastabend546ac1f2017-07-17 09:28:56 -0700112 BPF_MAP_TYPE_DEVMAP,
John Fastabend174a79f2017-08-15 22:32:47 -0700113 BPF_MAP_TYPE_SOCKMAP,
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700114};
115
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700116enum bpf_prog_type {
117 BPF_PROG_TYPE_UNSPEC,
Alexei Starovoitovddd872b2014-12-01 15:06:34 -0800118 BPF_PROG_TYPE_SOCKET_FILTER,
Alexei Starovoitov25415172015-03-25 12:49:20 -0700119 BPF_PROG_TYPE_KPROBE,
Daniel Borkmann96be4322015-03-01 12:31:46 +0100120 BPF_PROG_TYPE_SCHED_CLS,
Daniel Borkmann94caee82015-03-20 15:11:11 +0100121 BPF_PROG_TYPE_SCHED_ACT,
Alexei Starovoitov98b5c2c2016-04-06 18:43:25 -0700122 BPF_PROG_TYPE_TRACEPOINT,
Brenden Blanco6a773a12016-07-19 12:16:47 -0700123 BPF_PROG_TYPE_XDP,
Alexei Starovoitov0515e592016-09-01 18:37:22 -0700124 BPF_PROG_TYPE_PERF_EVENT,
Daniel Mack0e336612016-11-23 16:52:25 +0100125 BPF_PROG_TYPE_CGROUP_SKB,
David Ahern610236582016-12-01 08:48:04 -0800126 BPF_PROG_TYPE_CGROUP_SOCK,
Thomas Graf3a0af8f2016-11-30 17:10:10 +0100127 BPF_PROG_TYPE_LWT_IN,
128 BPF_PROG_TYPE_LWT_OUT,
129 BPF_PROG_TYPE_LWT_XMIT,
Lawrence Brakmo40304b22017-06-30 20:02:40 -0700130 BPF_PROG_TYPE_SOCK_OPS,
John Fastabendb005fd12017-08-15 22:31:58 -0700131 BPF_PROG_TYPE_SK_SKB,
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700132};
133
Daniel Mack0e336612016-11-23 16:52:25 +0100134enum bpf_attach_type {
135 BPF_CGROUP_INET_INGRESS,
136 BPF_CGROUP_INET_EGRESS,
David Ahern610236582016-12-01 08:48:04 -0800137 BPF_CGROUP_INET_SOCK_CREATE,
Lawrence Brakmo40304b22017-06-30 20:02:40 -0700138 BPF_CGROUP_SOCK_OPS,
John Fastabend464bc0f2017-08-28 07:10:04 -0700139 BPF_SK_SKB_STREAM_PARSER,
140 BPF_SK_SKB_STREAM_VERDICT,
Daniel Mack0e336612016-11-23 16:52:25 +0100141 __MAX_BPF_ATTACH_TYPE
142};
143
144#define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
145
Alexei Starovoitov7f677632017-02-10 20:28:24 -0800146/* If BPF_F_ALLOW_OVERRIDE flag is used in BPF_PROG_ATTACH command
147 * to the given target_fd cgroup the descendent cgroup will be able to
148 * override effective bpf program that was inherited from this cgroup
149 */
150#define BPF_F_ALLOW_OVERRIDE (1U << 0)
151
David S. Millere07b98d2017-05-10 11:38:07 -0700152/* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
153 * verifier will perform strict alignment checking as if the kernel
154 * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
155 * and NET_IP_ALIGN defined to 2.
156 */
157#define BPF_F_STRICT_ALIGNMENT (1U << 0)
158
Daniel Borkmannf1a66f82015-03-01 12:31:43 +0100159#define BPF_PSEUDO_MAP_FD 1
160
Alexei Starovoitov3274f522014-11-13 17:36:44 -0800161/* flags for BPF_MAP_UPDATE_ELEM command */
162#define BPF_ANY 0 /* create new element or update existing */
163#define BPF_NOEXIST 1 /* create new element if it didn't exist */
164#define BPF_EXIST 2 /* update existing element */
165
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700166/* flags for BPF_MAP_CREATE command */
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800167#define BPF_F_NO_PREALLOC (1U << 0)
Martin KaFai Lau29ba7322016-11-11 10:55:09 -0800168/* Instead of having one common LRU list in the
Martin KaFai Lau8f844932016-11-11 10:55:10 -0800169 * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
Martin KaFai Lau29ba7322016-11-11 10:55:09 -0800170 * which can scale and perform better.
171 * Note, the LRU nodes (including free nodes) cannot be moved
172 * across different LRU lists.
173 */
174#define BPF_F_NO_COMMON_LRU (1U << 1)
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700175/* Specify numa node during map creation */
176#define BPF_F_NUMA_NODE (1U << 2)
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800177
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700178union bpf_attr {
179 struct { /* anonymous struct used by BPF_MAP_CREATE command */
180 __u32 map_type; /* one of enum bpf_map_type */
181 __u32 key_size; /* size of key in bytes */
182 __u32 value_size; /* size of value in bytes */
183 __u32 max_entries; /* max number of entries in a map */
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700184 __u32 map_flags; /* BPF_MAP_CREATE related
185 * flags defined above.
186 */
Martin KaFai Lau56f668d2017-03-22 10:00:33 -0700187 __u32 inner_map_fd; /* fd pointing to the inner map */
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700188 __u32 numa_node; /* numa node (effective only if
189 * BPF_F_NUMA_NODE is set).
190 */
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700191 };
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -0700192
193 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
194 __u32 map_fd;
195 __aligned_u64 key;
196 union {
197 __aligned_u64 value;
198 __aligned_u64 next_key;
199 };
Alexei Starovoitov3274f522014-11-13 17:36:44 -0800200 __u64 flags;
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -0700201 };
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700202
203 struct { /* anonymous struct used by BPF_PROG_LOAD command */
204 __u32 prog_type; /* one of enum bpf_prog_type */
205 __u32 insn_cnt;
206 __aligned_u64 insns;
207 __aligned_u64 license;
Alexei Starovoitovcbd35702014-09-26 00:17:03 -0700208 __u32 log_level; /* verbosity level of verifier */
209 __u32 log_size; /* size of user buffer */
210 __aligned_u64 log_buf; /* user supplied buffer */
Alexei Starovoitov25415172015-03-25 12:49:20 -0700211 __u32 kern_version; /* checked when prog_type=kprobe */
David S. Millere07b98d2017-05-10 11:38:07 -0700212 __u32 prog_flags;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700213 };
Daniel Borkmannb2197752015-10-29 14:58:09 +0100214
215 struct { /* anonymous struct used by BPF_OBJ_* commands */
216 __aligned_u64 pathname;
217 __u32 bpf_fd;
218 };
Daniel Mackf4324552016-11-23 16:52:27 +0100219
220 struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
221 __u32 target_fd; /* container object to attach to */
222 __u32 attach_bpf_fd; /* eBPF program to attach */
223 __u32 attach_type;
Alexei Starovoitov7f677632017-02-10 20:28:24 -0800224 __u32 attach_flags;
Daniel Mackf4324552016-11-23 16:52:27 +0100225 };
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700226
227 struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
228 __u32 prog_fd;
229 __u32 retval;
230 __u32 data_size_in;
231 __u32 data_size_out;
232 __aligned_u64 data_in;
233 __aligned_u64 data_out;
234 __u32 repeat;
235 __u32 duration;
236 } test;
Martin KaFai Lau34ad5582017-06-05 12:15:48 -0700237
Martin KaFai Laub16d9aa2017-06-05 12:15:49 -0700238 struct { /* anonymous struct used by BPF_*_GET_*_ID */
239 union {
240 __u32 start_id;
241 __u32 prog_id;
Martin KaFai Laubd5f5f42017-06-05 12:15:50 -0700242 __u32 map_id;
Martin KaFai Laub16d9aa2017-06-05 12:15:49 -0700243 };
Martin KaFai Lau34ad5582017-06-05 12:15:48 -0700244 __u32 next_id;
245 };
Martin KaFai Lau1e270972017-06-05 12:15:52 -0700246
247 struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
248 __u32 bpf_fd;
249 __u32 info_len;
250 __aligned_u64 info;
251 } info;
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700252} __attribute__((aligned(8)));
253
Thomas Grafebb676d2016-10-27 11:23:51 +0200254/* BPF helper function descriptions:
255 *
256 * void *bpf_map_lookup_elem(&map, &key)
257 * Return: Map value or NULL
258 *
259 * int bpf_map_update_elem(&map, &key, &value, flags)
260 * Return: 0 on success or negative error
261 *
262 * int bpf_map_delete_elem(&map, &key)
263 * Return: 0 on success or negative error
264 *
265 * int bpf_probe_read(void *dst, int size, void *src)
266 * Return: 0 on success or negative error
267 *
268 * u64 bpf_ktime_get_ns(void)
269 * Return: current ktime
270 *
271 * int bpf_trace_printk(const char *fmt, int fmt_size, ...)
272 * Return: length of buffer written or negative error
273 *
274 * u32 bpf_prandom_u32(void)
275 * Return: random value
276 *
277 * u32 bpf_raw_smp_processor_id(void)
278 * Return: SMP processor ID
279 *
280 * int bpf_skb_store_bytes(skb, offset, from, len, flags)
281 * store bytes into packet
282 * @skb: pointer to skb
283 * @offset: offset within packet from skb->mac_header
284 * @from: pointer where to copy bytes from
285 * @len: number of bytes to store into packet
286 * @flags: bit 0 - if true, recompute skb->csum
287 * other bits - reserved
288 * Return: 0 on success or negative error
289 *
290 * int bpf_l3_csum_replace(skb, offset, from, to, flags)
291 * recompute IP checksum
292 * @skb: pointer to skb
293 * @offset: offset within packet where IP checksum is located
294 * @from: old value of header field
295 * @to: new value of header field
296 * @flags: bits 0-3 - size of header field
297 * other bits - reserved
298 * Return: 0 on success or negative error
299 *
300 * int bpf_l4_csum_replace(skb, offset, from, to, flags)
301 * recompute TCP/UDP checksum
302 * @skb: pointer to skb
303 * @offset: offset within packet where TCP/UDP checksum is located
304 * @from: old value of header field
305 * @to: new value of header field
306 * @flags: bits 0-3 - size of header field
307 * bit 4 - is pseudo header
308 * other bits - reserved
309 * Return: 0 on success or negative error
310 *
311 * int bpf_tail_call(ctx, prog_array_map, index)
312 * jump into another BPF program
313 * @ctx: context pointer passed to next program
314 * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
Alexei Starovoitov90caccd2017-10-03 15:37:20 -0700315 * @index: 32-bit index inside array that selects specific program to run
Thomas Grafebb676d2016-10-27 11:23:51 +0200316 * Return: 0 on success or negative error
317 *
318 * int bpf_clone_redirect(skb, ifindex, flags)
319 * redirect to another netdev
320 * @skb: pointer to skb
321 * @ifindex: ifindex of the net device
322 * @flags: bit 0 - if set, redirect to ingress instead of egress
323 * other bits - reserved
324 * Return: 0 on success or negative error
325 *
326 * u64 bpf_get_current_pid_tgid(void)
327 * Return: current->tgid << 32 | current->pid
328 *
329 * u64 bpf_get_current_uid_gid(void)
330 * Return: current_gid << 32 | current_uid
331 *
332 * int bpf_get_current_comm(char *buf, int size_of_buf)
333 * stores current->comm into buf
334 * Return: 0 on success or negative error
335 *
336 * u32 bpf_get_cgroup_classid(skb)
337 * retrieve a proc's classid
338 * @skb: pointer to skb
339 * Return: classid if != 0
340 *
341 * int bpf_skb_vlan_push(skb, vlan_proto, vlan_tci)
342 * Return: 0 on success or negative error
343 *
344 * int bpf_skb_vlan_pop(skb)
345 * Return: 0 on success or negative error
346 *
347 * int bpf_skb_get_tunnel_key(skb, key, size, flags)
348 * int bpf_skb_set_tunnel_key(skb, key, size, flags)
349 * retrieve or populate tunnel metadata
350 * @skb: pointer to skb
351 * @key: pointer to 'struct bpf_tunnel_key'
352 * @size: size of 'struct bpf_tunnel_key'
353 * @flags: room for future extensions
354 * Return: 0 on success or negative error
355 *
Teng Qinb7d3ed52017-06-02 21:03:54 -0700356 * u64 bpf_perf_event_read(map, flags)
357 * read perf event counter value
358 * @map: pointer to perf_event_array map
359 * @flags: index of event in the map or bitmask flags
360 * Return: value of perf event counter read or error code
Thomas Grafebb676d2016-10-27 11:23:51 +0200361 *
362 * int bpf_redirect(ifindex, flags)
363 * redirect to another netdev
364 * @ifindex: ifindex of the net device
John Fastabend56ce0972017-08-04 08:24:05 -0700365 * @flags:
366 * cls_bpf:
367 * bit 0 - if set, redirect to ingress instead of egress
368 * other bits - reserved
369 * xdp_bpf:
370 * all bits - reserved
371 * Return: cls_bpf: TC_ACT_REDIRECT on success or TC_ACT_SHOT on error
372 * xdp_bfp: XDP_REDIRECT on success or XDP_ABORT on error
373 * int bpf_redirect_map(map, key, flags)
John Fastabend97f91a72017-07-17 09:29:18 -0700374 * redirect to endpoint in map
John Fastabend56ce0972017-08-04 08:24:05 -0700375 * @map: pointer to dev map
John Fastabend97f91a72017-07-17 09:29:18 -0700376 * @key: index in map to lookup
John Fastabend97f91a72017-07-17 09:29:18 -0700377 * @flags: --
John Fastabend56ce0972017-08-04 08:24:05 -0700378 * Return: XDP_REDIRECT on success or XDP_ABORT on error
Thomas Grafebb676d2016-10-27 11:23:51 +0200379 *
380 * u32 bpf_get_route_realm(skb)
381 * retrieve a dst's tclassid
382 * @skb: pointer to skb
383 * Return: realm if != 0
384 *
Teng Qinb7d3ed52017-06-02 21:03:54 -0700385 * int bpf_perf_event_output(ctx, map, flags, data, size)
Thomas Grafebb676d2016-10-27 11:23:51 +0200386 * output perf raw sample
387 * @ctx: struct pt_regs*
388 * @map: pointer to perf_event_array map
Teng Qinb7d3ed52017-06-02 21:03:54 -0700389 * @flags: index of event in the map or bitmask flags
Thomas Grafebb676d2016-10-27 11:23:51 +0200390 * @data: data on stack to be output as raw data
391 * @size: size of data
392 * Return: 0 on success or negative error
393 *
394 * int bpf_get_stackid(ctx, map, flags)
395 * walk user or kernel stack and return id
396 * @ctx: struct pt_regs*
397 * @map: pointer to stack_trace map
398 * @flags: bits 0-7 - numer of stack frames to skip
399 * bit 8 - collect user stack instead of kernel
400 * bit 9 - compare stacks by hash only
401 * bit 10 - if two different stacks hash into the same stackid
402 * discard old
403 * other bits - reserved
404 * Return: >= 0 stackid on success or negative error
405 *
406 * s64 bpf_csum_diff(from, from_size, to, to_size, seed)
407 * calculate csum diff
408 * @from: raw from buffer
409 * @from_size: length of from buffer
410 * @to: raw to buffer
411 * @to_size: length of to buffer
412 * @seed: optional seed
413 * Return: csum result or negative error code
414 *
415 * int bpf_skb_get_tunnel_opt(skb, opt, size)
416 * retrieve tunnel options metadata
417 * @skb: pointer to skb
418 * @opt: pointer to raw tunnel option data
419 * @size: size of @opt
420 * Return: option size
421 *
422 * int bpf_skb_set_tunnel_opt(skb, opt, size)
423 * populate tunnel options metadata
424 * @skb: pointer to skb
425 * @opt: pointer to raw tunnel option data
426 * @size: size of @opt
427 * Return: 0 on success or negative error
428 *
429 * int bpf_skb_change_proto(skb, proto, flags)
430 * Change protocol of the skb. Currently supported is v4 -> v6,
431 * v6 -> v4 transitions. The helper will also resize the skb. eBPF
432 * program is expected to fill the new headers via skb_store_bytes
433 * and lX_csum_replace.
434 * @skb: pointer to skb
435 * @proto: new skb->protocol type
436 * @flags: reserved
437 * Return: 0 on success or negative error
438 *
439 * int bpf_skb_change_type(skb, type)
440 * Change packet type of skb.
441 * @skb: pointer to skb
442 * @type: new skb->pkt_type type
443 * Return: 0 on success or negative error
444 *
445 * int bpf_skb_under_cgroup(skb, map, index)
446 * Check cgroup2 membership of skb
447 * @skb: pointer to skb
448 * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
449 * @index: index of the cgroup in the bpf_map
450 * Return:
451 * == 0 skb failed the cgroup2 descendant test
452 * == 1 skb succeeded the cgroup2 descendant test
453 * < 0 error
454 *
455 * u32 bpf_get_hash_recalc(skb)
456 * Retrieve and possibly recalculate skb->hash.
457 * @skb: pointer to skb
458 * Return: hash
459 *
460 * u64 bpf_get_current_task(void)
461 * Returns current task_struct
462 * Return: current
463 *
464 * int bpf_probe_write_user(void *dst, void *src, int len)
465 * safely attempt to write to a location
466 * @dst: destination address in userspace
467 * @src: source address on stack
468 * @len: number of bytes to copy
469 * Return: 0 on success or negative error
470 *
471 * int bpf_current_task_under_cgroup(map, index)
472 * Check cgroup2 membership of current task
473 * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
474 * @index: index of the cgroup in the bpf_map
475 * Return:
476 * == 0 current failed the cgroup2 descendant test
477 * == 1 current succeeded the cgroup2 descendant test
478 * < 0 error
479 *
480 * int bpf_skb_change_tail(skb, len, flags)
481 * The helper will resize the skb to the given new size, to be used f.e.
482 * with control messages.
483 * @skb: pointer to skb
484 * @len: new skb length
485 * @flags: reserved
486 * Return: 0 on success or negative error
487 *
488 * int bpf_skb_pull_data(skb, len)
489 * The helper will pull in non-linear data in case the skb is non-linear
490 * and not all of len are part of the linear section. Only needed for
491 * read/write with direct packet access.
492 * @skb: pointer to skb
493 * @len: len to make read/writeable
494 * Return: 0 on success or negative error
495 *
496 * s64 bpf_csum_update(skb, csum)
497 * Adds csum into skb->csum in case of CHECKSUM_COMPLETE.
498 * @skb: pointer to skb
499 * @csum: csum to add
500 * Return: csum on success or negative error
501 *
502 * void bpf_set_hash_invalid(skb)
503 * Invalidate current skb->hash.
504 * @skb: pointer to skb
505 *
506 * int bpf_get_numa_node_id()
507 * Return: Id of current NUMA node.
Thomas Graf3a0af8f2016-11-30 17:10:10 +0100508 *
509 * int bpf_skb_change_head()
510 * Grows headroom of skb and adjusts MAC header offset accordingly.
511 * Will extends/reallocae as required automatically.
512 * May change skb data pointer and will thus invalidate any check
513 * performed for direct packet access.
514 * @skb: pointer to skb
515 * @len: length of header to be pushed in front
516 * @flags: Flags (unused for now)
517 * Return: 0 on success or negative error
Martin KaFai Lau17bedab2016-12-07 15:53:11 -0800518 *
519 * int bpf_xdp_adjust_head(xdp_md, delta)
520 * Adjust the xdp_md.data by delta
521 * @xdp_md: pointer to xdp_md
522 * @delta: An positive/negative integer to be added to xdp_md.data
523 * Return: 0 on success or negative on error
Gianluca Borelloa5e8c072017-01-18 17:55:49 +0000524 *
525 * int bpf_probe_read_str(void *dst, int size, const void *unsafe_ptr)
526 * Copy a NUL terminated string from unsafe address. In case the string
527 * length is smaller than size, the target is not padded with further NUL
528 * bytes. In case the string length is larger than size, just count-1
529 * bytes are copied and the last byte is set to NUL.
530 * @dst: destination address
531 * @size: maximum number of bytes to copy, including the trailing NUL
532 * @unsafe_ptr: unsafe address
533 * Return:
534 * > 0 length of the string including the trailing NUL on success
535 * < 0 error
Chenbo Feng91b82702017-03-22 17:27:34 -0700536 *
Alexander Alemayhu3c60a532017-04-08 22:08:10 +0200537 * u64 bpf_get_socket_cookie(skb)
Chenbo Feng91b82702017-03-22 17:27:34 -0700538 * Get the cookie for the socket stored inside sk_buff.
539 * @skb: pointer to skb
540 * Return: 8 Bytes non-decreasing number on success or 0 if the socket
541 * field is missing inside sk_buff
Chenbo Feng6acc5c22017-03-22 17:27:35 -0700542 *
543 * u32 bpf_get_socket_uid(skb)
544 * Get the owner uid of the socket stored inside sk_buff.
545 * @skb: pointer to skb
Chenbo Feng5d4e3442017-04-26 16:41:23 -0700546 * Return: uid of the socket owner on success or overflowuid if failed.
Daniel Borkmannded092c2017-06-11 00:50:47 +0200547 *
548 * u32 bpf_set_hash(skb, hash)
549 * Set full skb->hash.
550 * @skb: pointer to skb
551 * @hash: hash to set
Lawrence Brakmo8c4b4c72017-06-30 20:02:46 -0700552 *
553 * int bpf_setsockopt(bpf_socket, level, optname, optval, optlen)
554 * Calls setsockopt. Not all opts are available, only those with
555 * integer optvals plus TCP_CONGESTION.
556 * Supported levels: SOL_SOCKET and IPROTO_TCP
557 * @bpf_socket: pointer to bpf_socket
558 * @level: SOL_SOCKET or IPROTO_TCP
559 * @optname: option name
560 * @optval: pointer to option value
561 * @optlen: length of optval in byes
562 * Return: 0 or negative error
Daniel Borkmann2be7e212017-07-02 02:13:26 +0200563 *
564 * int bpf_skb_adjust_room(skb, len_diff, mode, flags)
565 * Grow or shrink room in sk_buff.
566 * @skb: pointer to skb
567 * @len_diff: (signed) amount of room to grow/shrink
568 * @mode: operation mode (enum bpf_adj_room_mode)
569 * @flags: reserved for future use
570 * Return: 0 on success or negative error code
John Fastabend174a79f2017-08-15 22:32:47 -0700571 *
572 * int bpf_sk_redirect_map(map, key, flags)
573 * Redirect skb to a sock in map using key as a lookup key for the
574 * sock in map.
575 * @map: pointer to sockmap
576 * @key: key to lookup sock in map
577 * @flags: reserved for future use
578 * Return: SK_REDIRECT
579 *
John Fastabend464bc0f2017-08-28 07:10:04 -0700580 * int bpf_sock_map_update(skops, map, key, flags)
John Fastabend174a79f2017-08-15 22:32:47 -0700581 * @skops: pointer to bpf_sock_ops
582 * @map: pointer to sockmap to update
583 * @key: key to insert/update sock in map
584 * @flags: same flags as map update elem
Thomas Grafebb676d2016-10-27 11:23:51 +0200585 */
586#define __BPF_FUNC_MAPPER(FN) \
587 FN(unspec), \
588 FN(map_lookup_elem), \
589 FN(map_update_elem), \
590 FN(map_delete_elem), \
591 FN(probe_read), \
592 FN(ktime_get_ns), \
593 FN(trace_printk), \
594 FN(get_prandom_u32), \
595 FN(get_smp_processor_id), \
596 FN(skb_store_bytes), \
597 FN(l3_csum_replace), \
598 FN(l4_csum_replace), \
599 FN(tail_call), \
600 FN(clone_redirect), \
601 FN(get_current_pid_tgid), \
602 FN(get_current_uid_gid), \
603 FN(get_current_comm), \
604 FN(get_cgroup_classid), \
605 FN(skb_vlan_push), \
606 FN(skb_vlan_pop), \
607 FN(skb_get_tunnel_key), \
608 FN(skb_set_tunnel_key), \
609 FN(perf_event_read), \
610 FN(redirect), \
611 FN(get_route_realm), \
612 FN(perf_event_output), \
613 FN(skb_load_bytes), \
614 FN(get_stackid), \
615 FN(csum_diff), \
616 FN(skb_get_tunnel_opt), \
617 FN(skb_set_tunnel_opt), \
618 FN(skb_change_proto), \
619 FN(skb_change_type), \
620 FN(skb_under_cgroup), \
621 FN(get_hash_recalc), \
622 FN(get_current_task), \
623 FN(probe_write_user), \
624 FN(current_task_under_cgroup), \
625 FN(skb_change_tail), \
626 FN(skb_pull_data), \
627 FN(csum_update), \
628 FN(set_hash_invalid), \
Thomas Graf3a0af8f2016-11-30 17:10:10 +0100629 FN(get_numa_node_id), \
Martin KaFai Lau17bedab2016-12-07 15:53:11 -0800630 FN(skb_change_head), \
Gianluca Borelloa5e8c072017-01-18 17:55:49 +0000631 FN(xdp_adjust_head), \
Chenbo Feng91b82702017-03-22 17:27:34 -0700632 FN(probe_read_str), \
Chenbo Feng6acc5c22017-03-22 17:27:35 -0700633 FN(get_socket_cookie), \
Daniel Borkmannded092c2017-06-11 00:50:47 +0200634 FN(get_socket_uid), \
Lawrence Brakmo8c4b4c72017-06-30 20:02:46 -0700635 FN(set_hash), \
Daniel Borkmann2be7e212017-07-02 02:13:26 +0200636 FN(setsockopt), \
John Fastabend97f91a72017-07-17 09:29:18 -0700637 FN(skb_adjust_room), \
John Fastabend174a79f2017-08-15 22:32:47 -0700638 FN(redirect_map), \
639 FN(sk_redirect_map), \
640 FN(sock_map_update), \
Thomas Grafebb676d2016-10-27 11:23:51 +0200641
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700642/* integer value in 'imm' field of BPF_CALL instruction selects which helper
643 * function eBPF program intends to call
644 */
Thomas Grafebb676d2016-10-27 11:23:51 +0200645#define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700646enum bpf_func_id {
Thomas Grafebb676d2016-10-27 11:23:51 +0200647 __BPF_FUNC_MAPPER(__BPF_ENUM_FN)
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700648 __BPF_FUNC_MAX_ID,
649};
Thomas Grafebb676d2016-10-27 11:23:51 +0200650#undef __BPF_ENUM_FN
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700651
Daniel Borkmann781c53b2016-01-11 01:16:38 +0100652/* All flags used by eBPF helper functions, placed here. */
653
654/* BPF_FUNC_skb_store_bytes flags. */
655#define BPF_F_RECOMPUTE_CSUM (1ULL << 0)
Daniel Borkmann8afd54c2016-03-04 15:15:03 +0100656#define BPF_F_INVALIDATE_HASH (1ULL << 1)
Daniel Borkmann781c53b2016-01-11 01:16:38 +0100657
658/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
659 * First 4 bits are for passing the header field size.
660 */
661#define BPF_F_HDR_FIELD_MASK 0xfULL
662
663/* BPF_FUNC_l4_csum_replace flags. */
664#define BPF_F_PSEUDO_HDR (1ULL << 4)
Daniel Borkmann2f729592016-02-19 23:05:26 +0100665#define BPF_F_MARK_MANGLED_0 (1ULL << 5)
Daniel Borkmannd1b662a2017-01-24 01:06:28 +0100666#define BPF_F_MARK_ENFORCE (1ULL << 6)
Daniel Borkmann781c53b2016-01-11 01:16:38 +0100667
668/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
669#define BPF_F_INGRESS (1ULL << 0)
670
Daniel Borkmannc6c33452016-01-11 01:16:39 +0100671/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
672#define BPF_F_TUNINFO_IPV6 (1ULL << 0)
673
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -0800674/* BPF_FUNC_get_stackid flags. */
675#define BPF_F_SKIP_FIELD_MASK 0xffULL
676#define BPF_F_USER_STACK (1ULL << 8)
677#define BPF_F_FAST_STACK_CMP (1ULL << 9)
678#define BPF_F_REUSE_STACKID (1ULL << 10)
679
Daniel Borkmann2da897e2016-02-23 02:05:26 +0100680/* BPF_FUNC_skb_set_tunnel_key flags. */
681#define BPF_F_ZERO_CSUM_TX (1ULL << 1)
Daniel Borkmann22080872016-03-04 15:15:05 +0100682#define BPF_F_DONT_FRAGMENT (1ULL << 2)
Daniel Borkmann2da897e2016-02-23 02:05:26 +0100683
Daniel Borkmann6816a7f2016-06-28 12:18:25 +0200684/* BPF_FUNC_perf_event_output and BPF_FUNC_perf_event_read flags. */
Daniel Borkmann1e337592016-04-18 21:01:23 +0200685#define BPF_F_INDEX_MASK 0xffffffffULL
686#define BPF_F_CURRENT_CPU BPF_F_INDEX_MASK
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200687/* BPF_FUNC_perf_event_output for sk_buff input context. */
688#define BPF_F_CTXLEN_MASK (0xfffffULL << 32)
Daniel Borkmann1e337592016-04-18 21:01:23 +0200689
Daniel Borkmann2be7e212017-07-02 02:13:26 +0200690/* Mode for BPF_FUNC_skb_adjust_room helper. */
691enum bpf_adj_room_mode {
692 BPF_ADJ_ROOM_NET,
693};
694
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700695/* user accessible mirror of in-kernel sk_buff.
696 * new fields can only be added to the end of this structure
697 */
698struct __sk_buff {
699 __u32 len;
700 __u32 pkt_type;
701 __u32 mark;
702 __u32 queue_mapping;
Alexei Starovoitovc2497392015-03-16 18:06:02 -0700703 __u32 protocol;
704 __u32 vlan_present;
705 __u32 vlan_tci;
Michal Sekletar27cd5452015-03-24 14:48:41 +0100706 __u32 vlan_proto;
Daniel Borkmannbcad5712015-04-03 20:52:24 +0200707 __u32 priority;
Alexei Starovoitov37e82c22015-05-27 15:30:39 -0700708 __u32 ingress_ifindex;
709 __u32 ifindex;
Alexei Starovoitovd691f9e2015-06-04 10:11:54 -0700710 __u32 tc_index;
711 __u32 cb[5];
Daniel Borkmannba7591d2015-08-01 00:46:29 +0200712 __u32 hash;
Daniel Borkmann045efa82015-09-15 23:05:42 -0700713 __u32 tc_classid;
Alexei Starovoitov969bf052016-05-05 19:49:10 -0700714 __u32 data;
715 __u32 data_end;
Daniel Borkmannb1d9fc42017-04-19 23:01:17 +0200716 __u32 napi_id;
John Fastabend8a31db52017-08-15 22:33:09 -0700717
718 /* accessed by BPF_PROG_TYPE_sk_skb types */
719 __u32 family;
720 __u32 remote_ip4; /* Stored in network byte order */
721 __u32 local_ip4; /* Stored in network byte order */
722 __u32 remote_ip6[4]; /* Stored in network byte order */
723 __u32 local_ip6[4]; /* Stored in network byte order */
724 __u32 remote_port; /* Stored in network byte order */
725 __u32 local_port; /* stored in host byte order */
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700726};
727
Alexei Starovoitovd3aa45c2015-07-30 15:36:57 -0700728struct bpf_tunnel_key {
729 __u32 tunnel_id;
Daniel Borkmannc6c33452016-01-11 01:16:39 +0100730 union {
731 __u32 remote_ipv4;
732 __u32 remote_ipv6[4];
733 };
734 __u8 tunnel_tos;
735 __u8 tunnel_ttl;
Daniel Borkmannc0e760c2016-03-30 00:02:00 +0200736 __u16 tunnel_ext;
Daniel Borkmann4018ab12016-03-09 03:00:05 +0100737 __u32 tunnel_label;
Alexei Starovoitovd3aa45c2015-07-30 15:36:57 -0700738};
739
Thomas Graf3a0af8f2016-11-30 17:10:10 +0100740/* Generic BPF return codes which all BPF program types may support.
741 * The values are binary compatible with their TC_ACT_* counter-part to
742 * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
743 * programs.
744 *
745 * XDP is handled seprately, see XDP_*.
746 */
747enum bpf_ret_code {
748 BPF_OK = 0,
749 /* 1 reserved */
750 BPF_DROP = 2,
751 /* 3-6 reserved */
752 BPF_REDIRECT = 7,
753 /* >127 are reserved for prog type specific return codes */
754};
755
David Ahern610236582016-12-01 08:48:04 -0800756struct bpf_sock {
757 __u32 bound_dev_if;
David Ahernaa4c1032016-12-01 08:48:06 -0800758 __u32 family;
759 __u32 type;
760 __u32 protocol;
David Ahern482dca92017-08-31 15:05:44 -0700761 __u32 mark;
762 __u32 priority;
David Ahern610236582016-12-01 08:48:04 -0800763};
764
Martin KaFai Lau17bedab2016-12-07 15:53:11 -0800765#define XDP_PACKET_HEADROOM 256
766
Brenden Blanco6a773a12016-07-19 12:16:47 -0700767/* User return codes for XDP prog type.
768 * A valid XDP program must return one of these defined values. All other
Daniel Borkmann9beb8be2017-09-09 01:40:35 +0200769 * return codes are reserved for future use. Unknown return codes will
770 * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
Brenden Blanco6a773a12016-07-19 12:16:47 -0700771 */
772enum xdp_action {
773 XDP_ABORTED = 0,
774 XDP_DROP,
775 XDP_PASS,
Brenden Blanco6ce96ca2016-07-19 12:16:53 -0700776 XDP_TX,
John Fastabend814abfa2017-07-17 09:27:07 -0700777 XDP_REDIRECT,
Brenden Blanco6a773a12016-07-19 12:16:47 -0700778};
779
780/* user accessible metadata for XDP packet hook
781 * new fields must be added to the end of this structure
782 */
783struct xdp_md {
784 __u32 data;
785 __u32 data_end;
786};
787
John Fastabend174a79f2017-08-15 22:32:47 -0700788enum sk_action {
789 SK_ABORTED = 0,
790 SK_DROP,
791 SK_REDIRECT,
792};
793
Martin KaFai Lau1e270972017-06-05 12:15:52 -0700794#define BPF_TAG_SIZE 8
795
796struct bpf_prog_info {
797 __u32 type;
798 __u32 id;
799 __u8 tag[BPF_TAG_SIZE];
800 __u32 jited_prog_len;
801 __u32 xlated_prog_len;
802 __aligned_u64 jited_prog_insns;
803 __aligned_u64 xlated_prog_insns;
804} __attribute__((aligned(8)));
805
806struct bpf_map_info {
807 __u32 type;
808 __u32 id;
809 __u32 key_size;
810 __u32 value_size;
811 __u32 max_entries;
812 __u32 map_flags;
813} __attribute__((aligned(8)));
814
Lawrence Brakmo40304b22017-06-30 20:02:40 -0700815/* User bpf_sock_ops struct to access socket values and specify request ops
816 * and their replies.
817 * Some of this fields are in network (bigendian) byte order and may need
818 * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
819 * New fields can only be added at the end of this structure
820 */
821struct bpf_sock_ops {
822 __u32 op;
823 union {
824 __u32 reply;
825 __u32 replylong[4];
826 };
827 __u32 family;
828 __u32 remote_ip4; /* Stored in network byte order */
829 __u32 local_ip4; /* Stored in network byte order */
830 __u32 remote_ip6[4]; /* Stored in network byte order */
831 __u32 local_ip6[4]; /* Stored in network byte order */
832 __u32 remote_port; /* Stored in network byte order */
833 __u32 local_port; /* stored in host byte order */
834};
835
836/* List of known BPF sock_ops operators.
837 * New entries can only be added at the end
838 */
839enum {
840 BPF_SOCK_OPS_VOID,
Lawrence Brakmo8550f322017-06-30 20:02:42 -0700841 BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or
842 * -1 if default value should be used
843 */
Lawrence Brakmo13d3b1e2017-06-30 20:02:44 -0700844 BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized
845 * window (in packets) or -1 if default
846 * value should be used
847 */
Lawrence Brakmo9872a4b2017-06-30 20:02:47 -0700848 BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an
849 * active connection is initialized
850 */
851 BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an
852 * active connection is
853 * established
854 */
855 BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a
856 * passive connection is
857 * established
858 */
Lawrence Brakmo91b5b212017-06-30 20:02:49 -0700859 BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control
860 * needs ECN
861 */
Lawrence Brakmo40304b22017-06-30 20:02:40 -0700862};
863
Lawrence Brakmofc747812017-06-30 20:02:51 -0700864#define TCP_BPF_IW 1001 /* Set TCP initial congestion window */
Lawrence Brakmo13bf9642017-06-30 20:02:53 -0700865#define TCP_BPF_SNDCWND_CLAMP 1002 /* Set sndcwnd_clamp */
Lawrence Brakmofc747812017-06-30 20:02:51 -0700866
Alexei Starovoitovdaedfb22014-09-04 22:17:18 -0700867#endif /* _UAPI__LINUX_BPF_H__ */