bpf: introduce BPF_MAP_TYPE_PERCPU_HASH map
[deliverable/linux.git] / include / uapi / linux / bpf.h
CommitLineData
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
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 */
38
39/* Register numbers */
40enum {
41 BPF_REG_0 = 0,
42 BPF_REG_1,
43 BPF_REG_2,
44 BPF_REG_3,
45 BPF_REG_4,
46 BPF_REG_5,
47 BPF_REG_6,
48 BPF_REG_7,
49 BPF_REG_8,
50 BPF_REG_9,
51 BPF_REG_10,
52 __MAX_BPF_REG,
53};
54
55/* BPF has 10 general purpose 64-bit registers and stack frame. */
56#define MAX_BPF_REG __MAX_BPF_REG
57
58struct bpf_insn {
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 */
64};
65
b2197755 66/* BPF syscall commands, see bpf(2) man-page for details. */
99c55f7d 67enum bpf_cmd {
99c55f7d 68 BPF_MAP_CREATE,
db20fd2b 69 BPF_MAP_LOOKUP_ELEM,
db20fd2b 70 BPF_MAP_UPDATE_ELEM,
db20fd2b 71 BPF_MAP_DELETE_ELEM,
db20fd2b 72 BPF_MAP_GET_NEXT_KEY,
09756af4 73 BPF_PROG_LOAD,
b2197755
DB
74 BPF_OBJ_PIN,
75 BPF_OBJ_GET,
99c55f7d
AS
76};
77
78enum bpf_map_type {
79 BPF_MAP_TYPE_UNSPEC,
0f8e4bd8 80 BPF_MAP_TYPE_HASH,
28fbcfa0 81 BPF_MAP_TYPE_ARRAY,
04fd61ab 82 BPF_MAP_TYPE_PROG_ARRAY,
ea317b26 83 BPF_MAP_TYPE_PERF_EVENT_ARRAY,
824bd0ce 84 BPF_MAP_TYPE_PERCPU_HASH,
99c55f7d
AS
85};
86
09756af4
AS
87enum bpf_prog_type {
88 BPF_PROG_TYPE_UNSPEC,
ddd872bc 89 BPF_PROG_TYPE_SOCKET_FILTER,
2541517c 90 BPF_PROG_TYPE_KPROBE,
96be4325 91 BPF_PROG_TYPE_SCHED_CLS,
94caee8c 92 BPF_PROG_TYPE_SCHED_ACT,
09756af4
AS
93};
94
f1a66f85
DB
95#define BPF_PSEUDO_MAP_FD 1
96
3274f520
AS
97/* flags for BPF_MAP_UPDATE_ELEM command */
98#define BPF_ANY 0 /* create new element or update existing */
99#define BPF_NOEXIST 1 /* create new element if it didn't exist */
100#define BPF_EXIST 2 /* update existing element */
101
99c55f7d
AS
102union bpf_attr {
103 struct { /* anonymous struct used by BPF_MAP_CREATE command */
104 __u32 map_type; /* one of enum bpf_map_type */
105 __u32 key_size; /* size of key in bytes */
106 __u32 value_size; /* size of value in bytes */
107 __u32 max_entries; /* max number of entries in a map */
108 };
db20fd2b
AS
109
110 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
111 __u32 map_fd;
112 __aligned_u64 key;
113 union {
114 __aligned_u64 value;
115 __aligned_u64 next_key;
116 };
3274f520 117 __u64 flags;
db20fd2b 118 };
09756af4
AS
119
120 struct { /* anonymous struct used by BPF_PROG_LOAD command */
121 __u32 prog_type; /* one of enum bpf_prog_type */
122 __u32 insn_cnt;
123 __aligned_u64 insns;
124 __aligned_u64 license;
cbd35700
AS
125 __u32 log_level; /* verbosity level of verifier */
126 __u32 log_size; /* size of user buffer */
127 __aligned_u64 log_buf; /* user supplied buffer */
2541517c 128 __u32 kern_version; /* checked when prog_type=kprobe */
09756af4 129 };
b2197755
DB
130
131 struct { /* anonymous struct used by BPF_OBJ_* commands */
132 __aligned_u64 pathname;
133 __u32 bpf_fd;
134 };
99c55f7d
AS
135} __attribute__((aligned(8)));
136
09756af4
AS
137/* integer value in 'imm' field of BPF_CALL instruction selects which helper
138 * function eBPF program intends to call
139 */
140enum bpf_func_id {
141 BPF_FUNC_unspec,
d0003ec0
AS
142 BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */
143 BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */
144 BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */
2541517c 145 BPF_FUNC_probe_read, /* int bpf_probe_read(void *dst, int size, void *src) */
d9847d31 146 BPF_FUNC_ktime_get_ns, /* u64 bpf_ktime_get_ns(void) */
9c959c86 147 BPF_FUNC_trace_printk, /* int bpf_trace_printk(const char *fmt, int fmt_size, ...) */
03e69b50 148 BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */
c04167ce 149 BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */
91bc4822
AS
150
151 /**
152 * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet
153 * @skb: pointer to skb
a166151c 154 * @offset: offset within packet from skb->mac_header
91bc4822
AS
155 * @from: pointer where to copy bytes from
156 * @len: number of bytes to store into packet
157 * @flags: bit 0 - if true, recompute skb->csum
158 * other bits - reserved
159 * Return: 0 on success
160 */
161 BPF_FUNC_skb_store_bytes,
162
163 /**
164 * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum
165 * @skb: pointer to skb
166 * @offset: offset within packet where IP checksum is located
167 * @from: old value of header field
168 * @to: new value of header field
169 * @flags: bits 0-3 - size of header field
170 * other bits - reserved
171 * Return: 0 on success
172 */
173 BPF_FUNC_l3_csum_replace,
174
175 /**
176 * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum
177 * @skb: pointer to skb
178 * @offset: offset within packet where TCP/UDP checksum is located
179 * @from: old value of header field
180 * @to: new value of header field
181 * @flags: bits 0-3 - size of header field
182 * bit 4 - is pseudo header
183 * other bits - reserved
184 * Return: 0 on success
185 */
186 BPF_FUNC_l4_csum_replace,
04fd61ab
AS
187
188 /**
189 * bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program
190 * @ctx: context pointer passed to next program
191 * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
192 * @index: index inside array that selects specific program to run
193 * Return: 0 on success
194 */
195 BPF_FUNC_tail_call,
3896d655
AS
196
197 /**
198 * bpf_clone_redirect(skb, ifindex, flags) - redirect to another netdev
199 * @skb: pointer to skb
200 * @ifindex: ifindex of the net device
201 * @flags: bit 0 - if set, redirect to ingress instead of egress
202 * other bits - reserved
203 * Return: 0 on success
204 */
205 BPF_FUNC_clone_redirect,
ffeedafb
AS
206
207 /**
208 * u64 bpf_get_current_pid_tgid(void)
209 * Return: current->tgid << 32 | current->pid
210 */
211 BPF_FUNC_get_current_pid_tgid,
212
213 /**
214 * u64 bpf_get_current_uid_gid(void)
215 * Return: current_gid << 32 | current_uid
216 */
217 BPF_FUNC_get_current_uid_gid,
218
219 /**
220 * bpf_get_current_comm(char *buf, int size_of_buf)
221 * stores current->comm into buf
222 * Return: 0 on success
223 */
224 BPF_FUNC_get_current_comm,
8d20aabe
DB
225
226 /**
227 * bpf_get_cgroup_classid(skb) - retrieve a proc's classid
228 * @skb: pointer to skb
229 * Return: classid if != 0
230 */
231 BPF_FUNC_get_cgroup_classid,
4e10df9a
AS
232 BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */
233 BPF_FUNC_skb_vlan_pop, /* bpf_skb_vlan_pop(skb) */
d3aa45ce
AS
234
235 /**
236 * bpf_skb_[gs]et_tunnel_key(skb, key, size, flags)
237 * retrieve or populate tunnel metadata
238 * @skb: pointer to skb
239 * @key: pointer to 'struct bpf_tunnel_key'
240 * @size: size of 'struct bpf_tunnel_key'
241 * @flags: room for future extensions
242 * Retrun: 0 on success
243 */
244 BPF_FUNC_skb_get_tunnel_key,
245 BPF_FUNC_skb_set_tunnel_key,
35578d79 246 BPF_FUNC_perf_event_read, /* u64 bpf_perf_event_read(&map, index) */
27b29f63
AS
247 /**
248 * bpf_redirect(ifindex, flags) - redirect to another netdev
249 * @ifindex: ifindex of the net device
250 * @flags: bit 0 - if set, redirect to ingress instead of egress
251 * other bits - reserved
252 * Return: TC_ACT_REDIRECT
253 */
254 BPF_FUNC_redirect,
c46646d0
DB
255
256 /**
257 * bpf_get_route_realm(skb) - retrieve a dst's tclassid
258 * @skb: pointer to skb
259 * Return: realm if != 0
260 */
261 BPF_FUNC_get_route_realm,
a43eec30
AS
262
263 /**
264 * bpf_perf_event_output(ctx, map, index, data, size) - output perf raw sample
265 * @ctx: struct pt_regs*
266 * @map: pointer to perf_event_array map
267 * @index: index of event in the map
268 * @data: data on stack to be output as raw data
269 * @size: size of data
270 * Return: 0 on success
271 */
272 BPF_FUNC_perf_event_output,
05c74e5e 273 BPF_FUNC_skb_load_bytes,
09756af4
AS
274 __BPF_FUNC_MAX_ID,
275};
276
781c53bc
DB
277/* All flags used by eBPF helper functions, placed here. */
278
279/* BPF_FUNC_skb_store_bytes flags. */
280#define BPF_F_RECOMPUTE_CSUM (1ULL << 0)
281
282/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
283 * First 4 bits are for passing the header field size.
284 */
285#define BPF_F_HDR_FIELD_MASK 0xfULL
286
287/* BPF_FUNC_l4_csum_replace flags. */
288#define BPF_F_PSEUDO_HDR (1ULL << 4)
289
290/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
291#define BPF_F_INGRESS (1ULL << 0)
292
c6c33454
DB
293/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
294#define BPF_F_TUNINFO_IPV6 (1ULL << 0)
295
9bac3d6d
AS
296/* user accessible mirror of in-kernel sk_buff.
297 * new fields can only be added to the end of this structure
298 */
299struct __sk_buff {
300 __u32 len;
301 __u32 pkt_type;
302 __u32 mark;
303 __u32 queue_mapping;
c2497395
AS
304 __u32 protocol;
305 __u32 vlan_present;
306 __u32 vlan_tci;
27cd5452 307 __u32 vlan_proto;
bcad5718 308 __u32 priority;
37e82c2f
AS
309 __u32 ingress_ifindex;
310 __u32 ifindex;
d691f9e8
AS
311 __u32 tc_index;
312 __u32 cb[5];
ba7591d8 313 __u32 hash;
045efa82 314 __u32 tc_classid;
9bac3d6d
AS
315};
316
d3aa45ce
AS
317struct bpf_tunnel_key {
318 __u32 tunnel_id;
c6c33454
DB
319 union {
320 __u32 remote_ipv4;
321 __u32 remote_ipv6[4];
322 };
323 __u8 tunnel_tos;
324 __u8 tunnel_ttl;
d3aa45ce
AS
325};
326
daedfb22 327#endif /* _UAPI__LINUX_BPF_H__ */
This page took 0.115349 seconds and 5 git commands to generate.