]>
Commit | Line | Data |
---|---|---|
daedfb22 AS |
1 | /* 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> | |
c15952dc | 11 | #include <linux/bpf_common.h> |
daedfb22 AS |
12 | |
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 | ||
92b31a9a | 33 | /* jmp encodings */ |
daedfb22 | 34 | #define BPF_JNE 0x50 /* jump != */ |
92b31a9a DB |
35 | #define BPF_JLT 0xa0 /* LT is unsigned, '<' */ |
36 | #define BPF_JLE 0xb0 /* LE is unsigned, '<=' */ | |
daedfb22 AS |
37 | #define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */ |
38 | #define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */ | |
92b31a9a DB |
39 | #define BPF_JSLT 0xc0 /* SLT is signed, '<' */ |
40 | #define BPF_JSLE 0xd0 /* SLE is signed, '<=' */ | |
daedfb22 AS |
41 | #define BPF_CALL 0x80 /* function call */ |
42 | #define BPF_EXIT 0x90 /* function return */ | |
43 | ||
44 | /* Register numbers */ | |
45 | enum { | |
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 | ||
63 | struct 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 | ||
b95a5c4d DM |
71 | /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */ |
72 | struct 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 | ||
b2197755 | 77 | /* BPF syscall commands, see bpf(2) man-page for details. */ |
99c55f7d | 78 | enum bpf_cmd { |
99c55f7d | 79 | BPF_MAP_CREATE, |
db20fd2b | 80 | BPF_MAP_LOOKUP_ELEM, |
db20fd2b | 81 | BPF_MAP_UPDATE_ELEM, |
db20fd2b | 82 | BPF_MAP_DELETE_ELEM, |
db20fd2b | 83 | BPF_MAP_GET_NEXT_KEY, |
09756af4 | 84 | BPF_PROG_LOAD, |
b2197755 DB |
85 | BPF_OBJ_PIN, |
86 | BPF_OBJ_GET, | |
f4324551 DM |
87 | BPF_PROG_ATTACH, |
88 | BPF_PROG_DETACH, | |
1cf1cae9 | 89 | BPF_PROG_TEST_RUN, |
34ad5580 MKL |
90 | BPF_PROG_GET_NEXT_ID, |
91 | BPF_MAP_GET_NEXT_ID, | |
b16d9aa4 | 92 | BPF_PROG_GET_FD_BY_ID, |
bd5f5f4e | 93 | BPF_MAP_GET_FD_BY_ID, |
1e270976 | 94 | BPF_OBJ_GET_INFO_BY_FD, |
99c55f7d AS |
95 | }; |
96 | ||
97 | enum bpf_map_type { | |
98 | BPF_MAP_TYPE_UNSPEC, | |
0f8e4bd8 | 99 | BPF_MAP_TYPE_HASH, |
28fbcfa0 | 100 | BPF_MAP_TYPE_ARRAY, |
04fd61ab | 101 | BPF_MAP_TYPE_PROG_ARRAY, |
ea317b26 | 102 | BPF_MAP_TYPE_PERF_EVENT_ARRAY, |
824bd0ce | 103 | BPF_MAP_TYPE_PERCPU_HASH, |
a10423b8 | 104 | BPF_MAP_TYPE_PERCPU_ARRAY, |
d5a3b1f6 | 105 | BPF_MAP_TYPE_STACK_TRACE, |
4ed8ec52 | 106 | BPF_MAP_TYPE_CGROUP_ARRAY, |
29ba732a | 107 | BPF_MAP_TYPE_LRU_HASH, |
8f844938 | 108 | BPF_MAP_TYPE_LRU_PERCPU_HASH, |
b95a5c4d | 109 | BPF_MAP_TYPE_LPM_TRIE, |
56f668df | 110 | BPF_MAP_TYPE_ARRAY_OF_MAPS, |
bcc6b1b7 | 111 | BPF_MAP_TYPE_HASH_OF_MAPS, |
546ac1ff | 112 | BPF_MAP_TYPE_DEVMAP, |
99c55f7d AS |
113 | }; |
114 | ||
09756af4 AS |
115 | enum bpf_prog_type { |
116 | BPF_PROG_TYPE_UNSPEC, | |
ddd872bc | 117 | BPF_PROG_TYPE_SOCKET_FILTER, |
2541517c | 118 | BPF_PROG_TYPE_KPROBE, |
96be4325 | 119 | BPF_PROG_TYPE_SCHED_CLS, |
94caee8c | 120 | BPF_PROG_TYPE_SCHED_ACT, |
98b5c2c6 | 121 | BPF_PROG_TYPE_TRACEPOINT, |
6a773a15 | 122 | BPF_PROG_TYPE_XDP, |
0515e599 | 123 | BPF_PROG_TYPE_PERF_EVENT, |
0e33661d | 124 | BPF_PROG_TYPE_CGROUP_SKB, |
61023658 | 125 | BPF_PROG_TYPE_CGROUP_SOCK, |
3a0af8fd TG |
126 | BPF_PROG_TYPE_LWT_IN, |
127 | BPF_PROG_TYPE_LWT_OUT, | |
128 | BPF_PROG_TYPE_LWT_XMIT, | |
40304b2a | 129 | BPF_PROG_TYPE_SOCK_OPS, |
b005fd18 | 130 | BPF_PROG_TYPE_SK_SKB, |
09756af4 AS |
131 | }; |
132 | ||
0e33661d DM |
133 | enum bpf_attach_type { |
134 | BPF_CGROUP_INET_INGRESS, | |
135 | BPF_CGROUP_INET_EGRESS, | |
61023658 | 136 | BPF_CGROUP_INET_SOCK_CREATE, |
40304b2a | 137 | BPF_CGROUP_SOCK_OPS, |
0e33661d DM |
138 | __MAX_BPF_ATTACH_TYPE |
139 | }; | |
140 | ||
141 | #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE | |
142 | ||
7f677633 AS |
143 | /* If BPF_F_ALLOW_OVERRIDE flag is used in BPF_PROG_ATTACH command |
144 | * to the given target_fd cgroup the descendent cgroup will be able to | |
145 | * override effective bpf program that was inherited from this cgroup | |
146 | */ | |
147 | #define BPF_F_ALLOW_OVERRIDE (1U << 0) | |
148 | ||
e07b98d9 DM |
149 | /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the |
150 | * verifier will perform strict alignment checking as if the kernel | |
151 | * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set, | |
152 | * and NET_IP_ALIGN defined to 2. | |
153 | */ | |
154 | #define BPF_F_STRICT_ALIGNMENT (1U << 0) | |
155 | ||
f1a66f85 DB |
156 | #define BPF_PSEUDO_MAP_FD 1 |
157 | ||
3274f520 AS |
158 | /* flags for BPF_MAP_UPDATE_ELEM command */ |
159 | #define BPF_ANY 0 /* create new element or update existing */ | |
160 | #define BPF_NOEXIST 1 /* create new element if it didn't exist */ | |
161 | #define BPF_EXIST 2 /* update existing element */ | |
162 | ||
6c905981 | 163 | #define BPF_F_NO_PREALLOC (1U << 0) |
29ba732a | 164 | /* Instead of having one common LRU list in the |
8f844938 | 165 | * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list |
29ba732a MKL |
166 | * which can scale and perform better. |
167 | * Note, the LRU nodes (including free nodes) cannot be moved | |
168 | * across different LRU lists. | |
169 | */ | |
170 | #define BPF_F_NO_COMMON_LRU (1U << 1) | |
6c905981 | 171 | |
99c55f7d AS |
172 | union bpf_attr { |
173 | struct { /* anonymous struct used by BPF_MAP_CREATE command */ | |
174 | __u32 map_type; /* one of enum bpf_map_type */ | |
175 | __u32 key_size; /* size of key in bytes */ | |
176 | __u32 value_size; /* size of value in bytes */ | |
177 | __u32 max_entries; /* max number of entries in a map */ | |
6c905981 | 178 | __u32 map_flags; /* prealloc or not */ |
56f668df | 179 | __u32 inner_map_fd; /* fd pointing to the inner map */ |
99c55f7d | 180 | }; |
db20fd2b AS |
181 | |
182 | struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ | |
183 | __u32 map_fd; | |
184 | __aligned_u64 key; | |
185 | union { | |
186 | __aligned_u64 value; | |
187 | __aligned_u64 next_key; | |
188 | }; | |
3274f520 | 189 | __u64 flags; |
db20fd2b | 190 | }; |
09756af4 AS |
191 | |
192 | struct { /* anonymous struct used by BPF_PROG_LOAD command */ | |
193 | __u32 prog_type; /* one of enum bpf_prog_type */ | |
194 | __u32 insn_cnt; | |
195 | __aligned_u64 insns; | |
196 | __aligned_u64 license; | |
cbd35700 AS |
197 | __u32 log_level; /* verbosity level of verifier */ |
198 | __u32 log_size; /* size of user buffer */ | |
199 | __aligned_u64 log_buf; /* user supplied buffer */ | |
2541517c | 200 | __u32 kern_version; /* checked when prog_type=kprobe */ |
e07b98d9 | 201 | __u32 prog_flags; |
09756af4 | 202 | }; |
b2197755 DB |
203 | |
204 | struct { /* anonymous struct used by BPF_OBJ_* commands */ | |
205 | __aligned_u64 pathname; | |
206 | __u32 bpf_fd; | |
207 | }; | |
f4324551 DM |
208 | |
209 | struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */ | |
210 | __u32 target_fd; /* container object to attach to */ | |
211 | __u32 attach_bpf_fd; /* eBPF program to attach */ | |
212 | __u32 attach_type; | |
7f677633 | 213 | __u32 attach_flags; |
f4324551 | 214 | }; |
1cf1cae9 AS |
215 | |
216 | struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */ | |
217 | __u32 prog_fd; | |
218 | __u32 retval; | |
219 | __u32 data_size_in; | |
220 | __u32 data_size_out; | |
221 | __aligned_u64 data_in; | |
222 | __aligned_u64 data_out; | |
223 | __u32 repeat; | |
224 | __u32 duration; | |
225 | } test; | |
34ad5580 | 226 | |
b16d9aa4 MKL |
227 | struct { /* anonymous struct used by BPF_*_GET_*_ID */ |
228 | union { | |
229 | __u32 start_id; | |
230 | __u32 prog_id; | |
bd5f5f4e | 231 | __u32 map_id; |
b16d9aa4 | 232 | }; |
34ad5580 MKL |
233 | __u32 next_id; |
234 | }; | |
1e270976 MKL |
235 | |
236 | struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */ | |
237 | __u32 bpf_fd; | |
238 | __u32 info_len; | |
239 | __aligned_u64 info; | |
240 | } info; | |
99c55f7d AS |
241 | } __attribute__((aligned(8))); |
242 | ||
ebb676da TG |
243 | /* BPF helper function descriptions: |
244 | * | |
245 | * void *bpf_map_lookup_elem(&map, &key) | |
246 | * Return: Map value or NULL | |
247 | * | |
248 | * int bpf_map_update_elem(&map, &key, &value, flags) | |
249 | * Return: 0 on success or negative error | |
250 | * | |
251 | * int bpf_map_delete_elem(&map, &key) | |
252 | * Return: 0 on success or negative error | |
253 | * | |
254 | * int bpf_probe_read(void *dst, int size, void *src) | |
255 | * Return: 0 on success or negative error | |
256 | * | |
257 | * u64 bpf_ktime_get_ns(void) | |
258 | * Return: current ktime | |
259 | * | |
260 | * int bpf_trace_printk(const char *fmt, int fmt_size, ...) | |
261 | * Return: length of buffer written or negative error | |
262 | * | |
263 | * u32 bpf_prandom_u32(void) | |
264 | * Return: random value | |
265 | * | |
266 | * u32 bpf_raw_smp_processor_id(void) | |
267 | * Return: SMP processor ID | |
268 | * | |
269 | * int bpf_skb_store_bytes(skb, offset, from, len, flags) | |
270 | * store bytes into packet | |
271 | * @skb: pointer to skb | |
272 | * @offset: offset within packet from skb->mac_header | |
273 | * @from: pointer where to copy bytes from | |
274 | * @len: number of bytes to store into packet | |
275 | * @flags: bit 0 - if true, recompute skb->csum | |
276 | * other bits - reserved | |
277 | * Return: 0 on success or negative error | |
278 | * | |
279 | * int bpf_l3_csum_replace(skb, offset, from, to, flags) | |
280 | * recompute IP checksum | |
281 | * @skb: pointer to skb | |
282 | * @offset: offset within packet where IP checksum is located | |
283 | * @from: old value of header field | |
284 | * @to: new value of header field | |
285 | * @flags: bits 0-3 - size of header field | |
286 | * other bits - reserved | |
287 | * Return: 0 on success or negative error | |
288 | * | |
289 | * int bpf_l4_csum_replace(skb, offset, from, to, flags) | |
290 | * recompute TCP/UDP checksum | |
291 | * @skb: pointer to skb | |
292 | * @offset: offset within packet where TCP/UDP checksum is located | |
293 | * @from: old value of header field | |
294 | * @to: new value of header field | |
295 | * @flags: bits 0-3 - size of header field | |
296 | * bit 4 - is pseudo header | |
297 | * other bits - reserved | |
298 | * Return: 0 on success or negative error | |
299 | * | |
300 | * int bpf_tail_call(ctx, prog_array_map, index) | |
301 | * jump into another BPF program | |
302 | * @ctx: context pointer passed to next program | |
303 | * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY | |
304 | * @index: index inside array that selects specific program to run | |
305 | * Return: 0 on success or negative error | |
306 | * | |
307 | * int bpf_clone_redirect(skb, ifindex, flags) | |
308 | * redirect to another netdev | |
309 | * @skb: pointer to skb | |
310 | * @ifindex: ifindex of the net device | |
311 | * @flags: bit 0 - if set, redirect to ingress instead of egress | |
312 | * other bits - reserved | |
313 | * Return: 0 on success or negative error | |
314 | * | |
315 | * u64 bpf_get_current_pid_tgid(void) | |
316 | * Return: current->tgid << 32 | current->pid | |
317 | * | |
318 | * u64 bpf_get_current_uid_gid(void) | |
319 | * Return: current_gid << 32 | current_uid | |
320 | * | |
321 | * int bpf_get_current_comm(char *buf, int size_of_buf) | |
322 | * stores current->comm into buf | |
323 | * Return: 0 on success or negative error | |
324 | * | |
325 | * u32 bpf_get_cgroup_classid(skb) | |
326 | * retrieve a proc's classid | |
327 | * @skb: pointer to skb | |
328 | * Return: classid if != 0 | |
329 | * | |
330 | * int bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) | |
331 | * Return: 0 on success or negative error | |
332 | * | |
333 | * int bpf_skb_vlan_pop(skb) | |
334 | * Return: 0 on success or negative error | |
335 | * | |
336 | * int bpf_skb_get_tunnel_key(skb, key, size, flags) | |
337 | * int bpf_skb_set_tunnel_key(skb, key, size, flags) | |
338 | * retrieve or populate tunnel metadata | |
339 | * @skb: pointer to skb | |
340 | * @key: pointer to 'struct bpf_tunnel_key' | |
341 | * @size: size of 'struct bpf_tunnel_key' | |
342 | * @flags: room for future extensions | |
343 | * Return: 0 on success or negative error | |
344 | * | |
b7d3ed5b TQ |
345 | * u64 bpf_perf_event_read(map, flags) |
346 | * read perf event counter value | |
347 | * @map: pointer to perf_event_array map | |
348 | * @flags: index of event in the map or bitmask flags | |
349 | * Return: value of perf event counter read or error code | |
ebb676da TG |
350 | * |
351 | * int bpf_redirect(ifindex, flags) | |
352 | * redirect to another netdev | |
353 | * @ifindex: ifindex of the net device | |
56ce097c JF |
354 | * @flags: |
355 | * cls_bpf: | |
356 | * bit 0 - if set, redirect to ingress instead of egress | |
357 | * other bits - reserved | |
358 | * xdp_bpf: | |
359 | * all bits - reserved | |
360 | * Return: cls_bpf: TC_ACT_REDIRECT on success or TC_ACT_SHOT on error | |
361 | * xdp_bfp: XDP_REDIRECT on success or XDP_ABORT on error | |
362 | * int bpf_redirect_map(map, key, flags) | |
97f91a7c | 363 | * redirect to endpoint in map |
56ce097c | 364 | * @map: pointer to dev map |
97f91a7c | 365 | * @key: index in map to lookup |
97f91a7c | 366 | * @flags: -- |
56ce097c | 367 | * Return: XDP_REDIRECT on success or XDP_ABORT on error |
ebb676da TG |
368 | * |
369 | * u32 bpf_get_route_realm(skb) | |
370 | * retrieve a dst's tclassid | |
371 | * @skb: pointer to skb | |
372 | * Return: realm if != 0 | |
373 | * | |
b7d3ed5b | 374 | * int bpf_perf_event_output(ctx, map, flags, data, size) |
ebb676da TG |
375 | * output perf raw sample |
376 | * @ctx: struct pt_regs* | |
377 | * @map: pointer to perf_event_array map | |
b7d3ed5b | 378 | * @flags: index of event in the map or bitmask flags |
ebb676da TG |
379 | * @data: data on stack to be output as raw data |
380 | * @size: size of data | |
381 | * Return: 0 on success or negative error | |
382 | * | |
383 | * int bpf_get_stackid(ctx, map, flags) | |
384 | * walk user or kernel stack and return id | |
385 | * @ctx: struct pt_regs* | |
386 | * @map: pointer to stack_trace map | |
387 | * @flags: bits 0-7 - numer of stack frames to skip | |
388 | * bit 8 - collect user stack instead of kernel | |
389 | * bit 9 - compare stacks by hash only | |
390 | * bit 10 - if two different stacks hash into the same stackid | |
391 | * discard old | |
392 | * other bits - reserved | |
393 | * Return: >= 0 stackid on success or negative error | |
394 | * | |
395 | * s64 bpf_csum_diff(from, from_size, to, to_size, seed) | |
396 | * calculate csum diff | |
397 | * @from: raw from buffer | |
398 | * @from_size: length of from buffer | |
399 | * @to: raw to buffer | |
400 | * @to_size: length of to buffer | |
401 | * @seed: optional seed | |
402 | * Return: csum result or negative error code | |
403 | * | |
404 | * int bpf_skb_get_tunnel_opt(skb, opt, size) | |
405 | * retrieve tunnel options metadata | |
406 | * @skb: pointer to skb | |
407 | * @opt: pointer to raw tunnel option data | |
408 | * @size: size of @opt | |
409 | * Return: option size | |
410 | * | |
411 | * int bpf_skb_set_tunnel_opt(skb, opt, size) | |
412 | * populate tunnel options metadata | |
413 | * @skb: pointer to skb | |
414 | * @opt: pointer to raw tunnel option data | |
415 | * @size: size of @opt | |
416 | * Return: 0 on success or negative error | |
417 | * | |
418 | * int bpf_skb_change_proto(skb, proto, flags) | |
419 | * Change protocol of the skb. Currently supported is v4 -> v6, | |
420 | * v6 -> v4 transitions. The helper will also resize the skb. eBPF | |
421 | * program is expected to fill the new headers via skb_store_bytes | |
422 | * and lX_csum_replace. | |
423 | * @skb: pointer to skb | |
424 | * @proto: new skb->protocol type | |
425 | * @flags: reserved | |
426 | * Return: 0 on success or negative error | |
427 | * | |
428 | * int bpf_skb_change_type(skb, type) | |
429 | * Change packet type of skb. | |
430 | * @skb: pointer to skb | |
431 | * @type: new skb->pkt_type type | |
432 | * Return: 0 on success or negative error | |
433 | * | |
434 | * int bpf_skb_under_cgroup(skb, map, index) | |
435 | * Check cgroup2 membership of skb | |
436 | * @skb: pointer to skb | |
437 | * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type | |
438 | * @index: index of the cgroup in the bpf_map | |
439 | * Return: | |
440 | * == 0 skb failed the cgroup2 descendant test | |
441 | * == 1 skb succeeded the cgroup2 descendant test | |
442 | * < 0 error | |
443 | * | |
444 | * u32 bpf_get_hash_recalc(skb) | |
445 | * Retrieve and possibly recalculate skb->hash. | |
446 | * @skb: pointer to skb | |
447 | * Return: hash | |
448 | * | |
449 | * u64 bpf_get_current_task(void) | |
450 | * Returns current task_struct | |
451 | * Return: current | |
452 | * | |
453 | * int bpf_probe_write_user(void *dst, void *src, int len) | |
454 | * safely attempt to write to a location | |
455 | * @dst: destination address in userspace | |
456 | * @src: source address on stack | |
457 | * @len: number of bytes to copy | |
458 | * Return: 0 on success or negative error | |
459 | * | |
460 | * int bpf_current_task_under_cgroup(map, index) | |
461 | * Check cgroup2 membership of current task | |
462 | * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type | |
463 | * @index: index of the cgroup in the bpf_map | |
464 | * Return: | |
465 | * == 0 current failed the cgroup2 descendant test | |
466 | * == 1 current succeeded the cgroup2 descendant test | |
467 | * < 0 error | |
468 | * | |
469 | * int bpf_skb_change_tail(skb, len, flags) | |
470 | * The helper will resize the skb to the given new size, to be used f.e. | |
471 | * with control messages. | |
472 | * @skb: pointer to skb | |
473 | * @len: new skb length | |
474 | * @flags: reserved | |
475 | * Return: 0 on success or negative error | |
476 | * | |
477 | * int bpf_skb_pull_data(skb, len) | |
478 | * The helper will pull in non-linear data in case the skb is non-linear | |
479 | * and not all of len are part of the linear section. Only needed for | |
480 | * read/write with direct packet access. | |
481 | * @skb: pointer to skb | |
482 | * @len: len to make read/writeable | |
483 | * Return: 0 on success or negative error | |
484 | * | |
485 | * s64 bpf_csum_update(skb, csum) | |
486 | * Adds csum into skb->csum in case of CHECKSUM_COMPLETE. | |
487 | * @skb: pointer to skb | |
488 | * @csum: csum to add | |
489 | * Return: csum on success or negative error | |
490 | * | |
491 | * void bpf_set_hash_invalid(skb) | |
492 | * Invalidate current skb->hash. | |
493 | * @skb: pointer to skb | |
494 | * | |
495 | * int bpf_get_numa_node_id() | |
496 | * Return: Id of current NUMA node. | |
3a0af8fd TG |
497 | * |
498 | * int bpf_skb_change_head() | |
499 | * Grows headroom of skb and adjusts MAC header offset accordingly. | |
500 | * Will extends/reallocae as required automatically. | |
501 | * May change skb data pointer and will thus invalidate any check | |
502 | * performed for direct packet access. | |
503 | * @skb: pointer to skb | |
504 | * @len: length of header to be pushed in front | |
505 | * @flags: Flags (unused for now) | |
506 | * Return: 0 on success or negative error | |
17bedab2 MKL |
507 | * |
508 | * int bpf_xdp_adjust_head(xdp_md, delta) | |
509 | * Adjust the xdp_md.data by delta | |
510 | * @xdp_md: pointer to xdp_md | |
511 | * @delta: An positive/negative integer to be added to xdp_md.data | |
512 | * Return: 0 on success or negative on error | |
a5e8c070 GB |
513 | * |
514 | * int bpf_probe_read_str(void *dst, int size, const void *unsafe_ptr) | |
515 | * Copy a NUL terminated string from unsafe address. In case the string | |
516 | * length is smaller than size, the target is not padded with further NUL | |
517 | * bytes. In case the string length is larger than size, just count-1 | |
518 | * bytes are copied and the last byte is set to NUL. | |
519 | * @dst: destination address | |
520 | * @size: maximum number of bytes to copy, including the trailing NUL | |
521 | * @unsafe_ptr: unsafe address | |
522 | * Return: | |
523 | * > 0 length of the string including the trailing NUL on success | |
524 | * < 0 error | |
91b8270f | 525 | * |
3c60a531 | 526 | * u64 bpf_get_socket_cookie(skb) |
91b8270f CF |
527 | * Get the cookie for the socket stored inside sk_buff. |
528 | * @skb: pointer to skb | |
529 | * Return: 8 Bytes non-decreasing number on success or 0 if the socket | |
530 | * field is missing inside sk_buff | |
6acc5c29 CF |
531 | * |
532 | * u32 bpf_get_socket_uid(skb) | |
533 | * Get the owner uid of the socket stored inside sk_buff. | |
534 | * @skb: pointer to skb | |
5d4e3443 | 535 | * Return: uid of the socket owner on success or overflowuid if failed. |
ded092cd DB |
536 | * |
537 | * u32 bpf_set_hash(skb, hash) | |
538 | * Set full skb->hash. | |
539 | * @skb: pointer to skb | |
540 | * @hash: hash to set | |
8c4b4c7e LB |
541 | * |
542 | * int bpf_setsockopt(bpf_socket, level, optname, optval, optlen) | |
543 | * Calls setsockopt. Not all opts are available, only those with | |
544 | * integer optvals plus TCP_CONGESTION. | |
545 | * Supported levels: SOL_SOCKET and IPROTO_TCP | |
546 | * @bpf_socket: pointer to bpf_socket | |
547 | * @level: SOL_SOCKET or IPROTO_TCP | |
548 | * @optname: option name | |
549 | * @optval: pointer to option value | |
550 | * @optlen: length of optval in byes | |
551 | * Return: 0 or negative error | |
2be7e212 DB |
552 | * |
553 | * int bpf_skb_adjust_room(skb, len_diff, mode, flags) | |
554 | * Grow or shrink room in sk_buff. | |
555 | * @skb: pointer to skb | |
556 | * @len_diff: (signed) amount of room to grow/shrink | |
557 | * @mode: operation mode (enum bpf_adj_room_mode) | |
558 | * @flags: reserved for future use | |
559 | * Return: 0 on success or negative error code | |
ebb676da TG |
560 | */ |
561 | #define __BPF_FUNC_MAPPER(FN) \ | |
562 | FN(unspec), \ | |
563 | FN(map_lookup_elem), \ | |
564 | FN(map_update_elem), \ | |
565 | FN(map_delete_elem), \ | |
566 | FN(probe_read), \ | |
567 | FN(ktime_get_ns), \ | |
568 | FN(trace_printk), \ | |
569 | FN(get_prandom_u32), \ | |
570 | FN(get_smp_processor_id), \ | |
571 | FN(skb_store_bytes), \ | |
572 | FN(l3_csum_replace), \ | |
573 | FN(l4_csum_replace), \ | |
574 | FN(tail_call), \ | |
575 | FN(clone_redirect), \ | |
576 | FN(get_current_pid_tgid), \ | |
577 | FN(get_current_uid_gid), \ | |
578 | FN(get_current_comm), \ | |
579 | FN(get_cgroup_classid), \ | |
580 | FN(skb_vlan_push), \ | |
581 | FN(skb_vlan_pop), \ | |
582 | FN(skb_get_tunnel_key), \ | |
583 | FN(skb_set_tunnel_key), \ | |
584 | FN(perf_event_read), \ | |
585 | FN(redirect), \ | |
586 | FN(get_route_realm), \ | |
587 | FN(perf_event_output), \ | |
588 | FN(skb_load_bytes), \ | |
589 | FN(get_stackid), \ | |
590 | FN(csum_diff), \ | |
591 | FN(skb_get_tunnel_opt), \ | |
592 | FN(skb_set_tunnel_opt), \ | |
593 | FN(skb_change_proto), \ | |
594 | FN(skb_change_type), \ | |
595 | FN(skb_under_cgroup), \ | |
596 | FN(get_hash_recalc), \ | |
597 | FN(get_current_task), \ | |
598 | FN(probe_write_user), \ | |
599 | FN(current_task_under_cgroup), \ | |
600 | FN(skb_change_tail), \ | |
601 | FN(skb_pull_data), \ | |
602 | FN(csum_update), \ | |
603 | FN(set_hash_invalid), \ | |
3a0af8fd | 604 | FN(get_numa_node_id), \ |
17bedab2 | 605 | FN(skb_change_head), \ |
a5e8c070 | 606 | FN(xdp_adjust_head), \ |
91b8270f | 607 | FN(probe_read_str), \ |
6acc5c29 | 608 | FN(get_socket_cookie), \ |
ded092cd | 609 | FN(get_socket_uid), \ |
8c4b4c7e | 610 | FN(set_hash), \ |
2be7e212 | 611 | FN(setsockopt), \ |
97f91a7c JF |
612 | FN(skb_adjust_room), \ |
613 | FN(redirect_map), | |
ebb676da | 614 | |
09756af4 AS |
615 | /* integer value in 'imm' field of BPF_CALL instruction selects which helper |
616 | * function eBPF program intends to call | |
617 | */ | |
ebb676da | 618 | #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x |
09756af4 | 619 | enum bpf_func_id { |
ebb676da | 620 | __BPF_FUNC_MAPPER(__BPF_ENUM_FN) |
09756af4 AS |
621 | __BPF_FUNC_MAX_ID, |
622 | }; | |
ebb676da | 623 | #undef __BPF_ENUM_FN |
09756af4 | 624 | |
781c53bc DB |
625 | /* All flags used by eBPF helper functions, placed here. */ |
626 | ||
627 | /* BPF_FUNC_skb_store_bytes flags. */ | |
628 | #define BPF_F_RECOMPUTE_CSUM (1ULL << 0) | |
8afd54c8 | 629 | #define BPF_F_INVALIDATE_HASH (1ULL << 1) |
781c53bc DB |
630 | |
631 | /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags. | |
632 | * First 4 bits are for passing the header field size. | |
633 | */ | |
634 | #define BPF_F_HDR_FIELD_MASK 0xfULL | |
635 | ||
636 | /* BPF_FUNC_l4_csum_replace flags. */ | |
637 | #define BPF_F_PSEUDO_HDR (1ULL << 4) | |
2f72959a | 638 | #define BPF_F_MARK_MANGLED_0 (1ULL << 5) |
d1b662ad | 639 | #define BPF_F_MARK_ENFORCE (1ULL << 6) |
781c53bc DB |
640 | |
641 | /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */ | |
642 | #define BPF_F_INGRESS (1ULL << 0) | |
643 | ||
c6c33454 DB |
644 | /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */ |
645 | #define BPF_F_TUNINFO_IPV6 (1ULL << 0) | |
646 | ||
d5a3b1f6 AS |
647 | /* BPF_FUNC_get_stackid flags. */ |
648 | #define BPF_F_SKIP_FIELD_MASK 0xffULL | |
649 | #define BPF_F_USER_STACK (1ULL << 8) | |
650 | #define BPF_F_FAST_STACK_CMP (1ULL << 9) | |
651 | #define BPF_F_REUSE_STACKID (1ULL << 10) | |
652 | ||
2da897e5 DB |
653 | /* BPF_FUNC_skb_set_tunnel_key flags. */ |
654 | #define BPF_F_ZERO_CSUM_TX (1ULL << 1) | |
22080870 | 655 | #define BPF_F_DONT_FRAGMENT (1ULL << 2) |
2da897e5 | 656 | |
6816a7ff | 657 | /* BPF_FUNC_perf_event_output and BPF_FUNC_perf_event_read flags. */ |
1e33759c DB |
658 | #define BPF_F_INDEX_MASK 0xffffffffULL |
659 | #define BPF_F_CURRENT_CPU BPF_F_INDEX_MASK | |
555c8a86 DB |
660 | /* BPF_FUNC_perf_event_output for sk_buff input context. */ |
661 | #define BPF_F_CTXLEN_MASK (0xfffffULL << 32) | |
1e33759c | 662 | |
2be7e212 DB |
663 | /* Mode for BPF_FUNC_skb_adjust_room helper. */ |
664 | enum bpf_adj_room_mode { | |
665 | BPF_ADJ_ROOM_NET, | |
666 | }; | |
667 | ||
9bac3d6d AS |
668 | /* user accessible mirror of in-kernel sk_buff. |
669 | * new fields can only be added to the end of this structure | |
670 | */ | |
671 | struct __sk_buff { | |
672 | __u32 len; | |
673 | __u32 pkt_type; | |
674 | __u32 mark; | |
675 | __u32 queue_mapping; | |
c2497395 AS |
676 | __u32 protocol; |
677 | __u32 vlan_present; | |
678 | __u32 vlan_tci; | |
27cd5452 | 679 | __u32 vlan_proto; |
bcad5718 | 680 | __u32 priority; |
37e82c2f AS |
681 | __u32 ingress_ifindex; |
682 | __u32 ifindex; | |
d691f9e8 AS |
683 | __u32 tc_index; |
684 | __u32 cb[5]; | |
ba7591d8 | 685 | __u32 hash; |
045efa82 | 686 | __u32 tc_classid; |
969bf05e AS |
687 | __u32 data; |
688 | __u32 data_end; | |
b1d9fc41 | 689 | __u32 napi_id; |
9bac3d6d AS |
690 | }; |
691 | ||
d3aa45ce AS |
692 | struct bpf_tunnel_key { |
693 | __u32 tunnel_id; | |
c6c33454 DB |
694 | union { |
695 | __u32 remote_ipv4; | |
696 | __u32 remote_ipv6[4]; | |
697 | }; | |
698 | __u8 tunnel_tos; | |
699 | __u8 tunnel_ttl; | |
c0e760c9 | 700 | __u16 tunnel_ext; |
4018ab18 | 701 | __u32 tunnel_label; |
d3aa45ce AS |
702 | }; |
703 | ||
3a0af8fd TG |
704 | /* Generic BPF return codes which all BPF program types may support. |
705 | * The values are binary compatible with their TC_ACT_* counter-part to | |
706 | * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT | |
707 | * programs. | |
708 | * | |
709 | * XDP is handled seprately, see XDP_*. | |
710 | */ | |
711 | enum bpf_ret_code { | |
712 | BPF_OK = 0, | |
713 | /* 1 reserved */ | |
714 | BPF_DROP = 2, | |
715 | /* 3-6 reserved */ | |
716 | BPF_REDIRECT = 7, | |
717 | /* >127 are reserved for prog type specific return codes */ | |
718 | }; | |
719 | ||
61023658 DA |
720 | struct bpf_sock { |
721 | __u32 bound_dev_if; | |
aa4c1037 DA |
722 | __u32 family; |
723 | __u32 type; | |
724 | __u32 protocol; | |
61023658 DA |
725 | }; |
726 | ||
17bedab2 MKL |
727 | #define XDP_PACKET_HEADROOM 256 |
728 | ||
6a773a15 BB |
729 | /* User return codes for XDP prog type. |
730 | * A valid XDP program must return one of these defined values. All other | |
731 | * return codes are reserved for future use. Unknown return codes will result | |
732 | * in packet drop. | |
733 | */ | |
734 | enum xdp_action { | |
735 | XDP_ABORTED = 0, | |
736 | XDP_DROP, | |
737 | XDP_PASS, | |
6ce96ca3 | 738 | XDP_TX, |
814abfab | 739 | XDP_REDIRECT, |
6a773a15 BB |
740 | }; |
741 | ||
742 | /* user accessible metadata for XDP packet hook | |
743 | * new fields must be added to the end of this structure | |
744 | */ | |
745 | struct xdp_md { | |
746 | __u32 data; | |
747 | __u32 data_end; | |
748 | }; | |
749 | ||
1e270976 MKL |
750 | #define BPF_TAG_SIZE 8 |
751 | ||
752 | struct bpf_prog_info { | |
753 | __u32 type; | |
754 | __u32 id; | |
755 | __u8 tag[BPF_TAG_SIZE]; | |
756 | __u32 jited_prog_len; | |
757 | __u32 xlated_prog_len; | |
758 | __aligned_u64 jited_prog_insns; | |
759 | __aligned_u64 xlated_prog_insns; | |
760 | } __attribute__((aligned(8))); | |
761 | ||
762 | struct bpf_map_info { | |
763 | __u32 type; | |
764 | __u32 id; | |
765 | __u32 key_size; | |
766 | __u32 value_size; | |
767 | __u32 max_entries; | |
768 | __u32 map_flags; | |
769 | } __attribute__((aligned(8))); | |
770 | ||
40304b2a LB |
771 | /* User bpf_sock_ops struct to access socket values and specify request ops |
772 | * and their replies. | |
773 | * Some of this fields are in network (bigendian) byte order and may need | |
774 | * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h). | |
775 | * New fields can only be added at the end of this structure | |
776 | */ | |
777 | struct bpf_sock_ops { | |
778 | __u32 op; | |
779 | union { | |
780 | __u32 reply; | |
781 | __u32 replylong[4]; | |
782 | }; | |
783 | __u32 family; | |
784 | __u32 remote_ip4; /* Stored in network byte order */ | |
785 | __u32 local_ip4; /* Stored in network byte order */ | |
786 | __u32 remote_ip6[4]; /* Stored in network byte order */ | |
787 | __u32 local_ip6[4]; /* Stored in network byte order */ | |
788 | __u32 remote_port; /* Stored in network byte order */ | |
789 | __u32 local_port; /* stored in host byte order */ | |
790 | }; | |
791 | ||
792 | /* List of known BPF sock_ops operators. | |
793 | * New entries can only be added at the end | |
794 | */ | |
795 | enum { | |
796 | BPF_SOCK_OPS_VOID, | |
8550f328 LB |
797 | BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or |
798 | * -1 if default value should be used | |
799 | */ | |
13d3b1eb LB |
800 | BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized |
801 | * window (in packets) or -1 if default | |
802 | * value should be used | |
803 | */ | |
9872a4bd LB |
804 | BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an |
805 | * active connection is initialized | |
806 | */ | |
807 | BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an | |
808 | * active connection is | |
809 | * established | |
810 | */ | |
811 | BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a | |
812 | * passive connection is | |
813 | * established | |
814 | */ | |
91b5b21c LB |
815 | BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control |
816 | * needs ECN | |
817 | */ | |
40304b2a LB |
818 | }; |
819 | ||
fc747810 | 820 | #define TCP_BPF_IW 1001 /* Set TCP initial congestion window */ |
13bf9641 | 821 | #define TCP_BPF_SNDCWND_CLAMP 1002 /* Set sndcwnd_clamp */ |
fc747810 | 822 | |
daedfb22 | 823 | #endif /* _UAPI__LINUX_BPF_H__ */ |