1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
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.
7 #ifndef _UAPI__LINUX_BPF_H__
8 #define _UAPI__LINUX_BPF_H__
10 #include <linux/types.h>
11 #include <linux/bpf_common.h>
13 /* Extended instruction set based on top of classic BPF */
15 /* instruction classes */
16 #define BPF_ALU64 0x07 /* alu mode in double word width */
19 #define BPF_DW 0x18 /* double word */
20 #define BPF_XADD 0xc0 /* exclusive add */
23 #define BPF_MOV 0xb0 /* mov reg to reg */
24 #define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */
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
33 #define BPF_JNE 0x50 /* jump != */
34 #define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
35 #define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
36 #define BPF_CALL 0x80 /* function call */
37 #define BPF_EXIT 0x90 /* function return */
39 /* Register numbers */
55 /* BPF has 10 general purpose 64-bit registers and stack frame. */
56 #define MAX_BPF_REG __MAX_BPF_REG
59 __u8 code; /* opcode */
60 __u8 dst_reg:4; /* dest register */
61 __u8 src_reg:4; /* source register */
62 __s16 off; /* signed offset */
63 __s32 imm; /* signed immediate constant */
66 /* BPF syscall commands, see bpf(2) man-page for details. */
82 BPF_MAP_TYPE_PROG_ARRAY,
83 BPF_MAP_TYPE_PERF_EVENT_ARRAY,
84 BPF_MAP_TYPE_PERCPU_HASH,
85 BPF_MAP_TYPE_PERCPU_ARRAY,
86 BPF_MAP_TYPE_STACK_TRACE,
91 BPF_PROG_TYPE_SOCKET_FILTER,
93 BPF_PROG_TYPE_SCHED_CLS,
94 BPF_PROG_TYPE_SCHED_ACT,
97 #define BPF_PSEUDO_MAP_FD 1
99 /* flags for BPF_MAP_UPDATE_ELEM command */
100 #define BPF_ANY 0 /* create new element or update existing */
101 #define BPF_NOEXIST 1 /* create new element if it didn't exist */
102 #define BPF_EXIST 2 /* update existing element */
104 #define BPF_F_NO_PREALLOC (1U << 0)
107 struct { /* anonymous struct used by BPF_MAP_CREATE command */
108 __u32 map_type; /* one of enum bpf_map_type */
109 __u32 key_size; /* size of key in bytes */
110 __u32 value_size; /* size of value in bytes */
111 __u32 max_entries; /* max number of entries in a map */
112 __u32 map_flags; /* prealloc or not */
115 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
120 __aligned_u64 next_key;
125 struct { /* anonymous struct used by BPF_PROG_LOAD command */
126 __u32 prog_type; /* one of enum bpf_prog_type */
129 __aligned_u64 license;
130 __u32 log_level; /* verbosity level of verifier */
131 __u32 log_size; /* size of user buffer */
132 __aligned_u64 log_buf; /* user supplied buffer */
133 __u32 kern_version; /* checked when prog_type=kprobe */
136 struct { /* anonymous struct used by BPF_OBJ_* commands */
137 __aligned_u64 pathname;
140 } __attribute__((aligned(8)));
142 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
143 * function eBPF program intends to call
147 BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */
148 BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */
149 BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */
150 BPF_FUNC_probe_read, /* int bpf_probe_read(void *dst, int size, void *src) */
151 BPF_FUNC_ktime_get_ns, /* u64 bpf_ktime_get_ns(void) */
152 BPF_FUNC_trace_printk, /* int bpf_trace_printk(const char *fmt, int fmt_size, ...) */
153 BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */
154 BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */
157 * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet
158 * @skb: pointer to skb
159 * @offset: offset within packet from skb->mac_header
160 * @from: pointer where to copy bytes from
161 * @len: number of bytes to store into packet
162 * @flags: bit 0 - if true, recompute skb->csum
163 * other bits - reserved
164 * Return: 0 on success
166 BPF_FUNC_skb_store_bytes,
169 * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum
170 * @skb: pointer to skb
171 * @offset: offset within packet where IP checksum is located
172 * @from: old value of header field
173 * @to: new value of header field
174 * @flags: bits 0-3 - size of header field
175 * other bits - reserved
176 * Return: 0 on success
178 BPF_FUNC_l3_csum_replace,
181 * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum
182 * @skb: pointer to skb
183 * @offset: offset within packet where TCP/UDP checksum is located
184 * @from: old value of header field
185 * @to: new value of header field
186 * @flags: bits 0-3 - size of header field
187 * bit 4 - is pseudo header
188 * other bits - reserved
189 * Return: 0 on success
191 BPF_FUNC_l4_csum_replace,
194 * bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program
195 * @ctx: context pointer passed to next program
196 * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
197 * @index: index inside array that selects specific program to run
198 * Return: 0 on success
203 * bpf_clone_redirect(skb, ifindex, flags) - redirect to another netdev
204 * @skb: pointer to skb
205 * @ifindex: ifindex of the net device
206 * @flags: bit 0 - if set, redirect to ingress instead of egress
207 * other bits - reserved
208 * Return: 0 on success
210 BPF_FUNC_clone_redirect,
213 * u64 bpf_get_current_pid_tgid(void)
214 * Return: current->tgid << 32 | current->pid
216 BPF_FUNC_get_current_pid_tgid,
219 * u64 bpf_get_current_uid_gid(void)
220 * Return: current_gid << 32 | current_uid
222 BPF_FUNC_get_current_uid_gid,
225 * bpf_get_current_comm(char *buf, int size_of_buf)
226 * stores current->comm into buf
227 * Return: 0 on success
229 BPF_FUNC_get_current_comm,
232 * bpf_get_cgroup_classid(skb) - retrieve a proc's classid
233 * @skb: pointer to skb
234 * Return: classid if != 0
236 BPF_FUNC_get_cgroup_classid,
237 BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */
238 BPF_FUNC_skb_vlan_pop, /* bpf_skb_vlan_pop(skb) */
241 * bpf_skb_[gs]et_tunnel_key(skb, key, size, flags)
242 * retrieve or populate tunnel metadata
243 * @skb: pointer to skb
244 * @key: pointer to 'struct bpf_tunnel_key'
245 * @size: size of 'struct bpf_tunnel_key'
246 * @flags: room for future extensions
247 * Retrun: 0 on success
249 BPF_FUNC_skb_get_tunnel_key,
250 BPF_FUNC_skb_set_tunnel_key,
251 BPF_FUNC_perf_event_read, /* u64 bpf_perf_event_read(&map, index) */
253 * bpf_redirect(ifindex, flags) - redirect to another netdev
254 * @ifindex: ifindex of the net device
255 * @flags: bit 0 - if set, redirect to ingress instead of egress
256 * other bits - reserved
257 * Return: TC_ACT_REDIRECT
262 * bpf_get_route_realm(skb) - retrieve a dst's tclassid
263 * @skb: pointer to skb
264 * Return: realm if != 0
266 BPF_FUNC_get_route_realm,
269 * bpf_perf_event_output(ctx, map, index, data, size) - output perf raw sample
270 * @ctx: struct pt_regs*
271 * @map: pointer to perf_event_array map
272 * @index: index of event in the map
273 * @data: data on stack to be output as raw data
274 * @size: size of data
275 * Return: 0 on success
277 BPF_FUNC_perf_event_output,
278 BPF_FUNC_skb_load_bytes,
281 * bpf_get_stackid(ctx, map, flags) - walk user or kernel stack and return id
282 * @ctx: struct pt_regs*
283 * @map: pointer to stack_trace map
284 * @flags: bits 0-7 - numer of stack frames to skip
285 * bit 8 - collect user stack instead of kernel
286 * bit 9 - compare stacks by hash only
287 * bit 10 - if two different stacks hash into the same stackid
289 * other bits - reserved
290 * Return: >= 0 stackid on success or negative error
292 BPF_FUNC_get_stackid,
295 * bpf_csum_diff(from, from_size, to, to_size, seed) - calculate csum diff
296 * @from: raw from buffer
297 * @from_size: length of from buffer
299 * @to_size: length of to buffer
300 * @seed: optional seed
301 * Return: csum result
306 * bpf_skb_[gs]et_tunnel_opt(skb, opt, size)
307 * retrieve or populate tunnel options metadata
308 * @skb: pointer to skb
309 * @opt: pointer to raw tunnel option data
310 * @size: size of @opt
311 * Return: 0 on success for set, option size for get
313 BPF_FUNC_skb_get_tunnel_opt,
314 BPF_FUNC_skb_set_tunnel_opt,
318 /* All flags used by eBPF helper functions, placed here. */
320 /* BPF_FUNC_skb_store_bytes flags. */
321 #define BPF_F_RECOMPUTE_CSUM (1ULL << 0)
322 #define BPF_F_INVALIDATE_HASH (1ULL << 1)
324 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
325 * First 4 bits are for passing the header field size.
327 #define BPF_F_HDR_FIELD_MASK 0xfULL
329 /* BPF_FUNC_l4_csum_replace flags. */
330 #define BPF_F_PSEUDO_HDR (1ULL << 4)
331 #define BPF_F_MARK_MANGLED_0 (1ULL << 5)
333 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
334 #define BPF_F_INGRESS (1ULL << 0)
336 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
337 #define BPF_F_TUNINFO_IPV6 (1ULL << 0)
339 /* BPF_FUNC_get_stackid flags. */
340 #define BPF_F_SKIP_FIELD_MASK 0xffULL
341 #define BPF_F_USER_STACK (1ULL << 8)
342 #define BPF_F_FAST_STACK_CMP (1ULL << 9)
343 #define BPF_F_REUSE_STACKID (1ULL << 10)
345 /* BPF_FUNC_skb_set_tunnel_key flags. */
346 #define BPF_F_ZERO_CSUM_TX (1ULL << 1)
347 #define BPF_F_DONT_FRAGMENT (1ULL << 2)
349 /* user accessible mirror of in-kernel sk_buff.
350 * new fields can only be added to the end of this structure
362 __u32 ingress_ifindex;
370 struct bpf_tunnel_key {
374 __u32 remote_ipv6[4];
382 #endif /* _UAPI__LINUX_BPF_H__ */