]>
Commit | Line | Data |
---|---|---|
b54ac87e DB |
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 __LINUX_BPF_H__ | |
8 | #define __LINUX_BPF_H__ | |
9 | ||
10 | #include <linux/types.h> | |
11 | #include <linux/bpf_common.h> | |
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 */ | |
40 | enum { | |
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 | ||
58 | struct 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 | ||
66 | /* BPF syscall commands */ | |
67 | enum bpf_cmd { | |
68 | /* create a map with given type and attributes | |
69 | * fd = bpf(BPF_MAP_CREATE, union bpf_attr *, u32 size) | |
70 | * returns fd or negative error | |
71 | * map is deleted when fd is closed | |
72 | */ | |
73 | BPF_MAP_CREATE, | |
74 | ||
75 | /* lookup key in a given map | |
76 | * err = bpf(BPF_MAP_LOOKUP_ELEM, union bpf_attr *attr, u32 size) | |
77 | * Using attr->map_fd, attr->key, attr->value | |
78 | * returns zero and stores found elem into value | |
79 | * or negative error | |
80 | */ | |
81 | BPF_MAP_LOOKUP_ELEM, | |
82 | ||
83 | /* create or update key/value pair in a given map | |
84 | * err = bpf(BPF_MAP_UPDATE_ELEM, union bpf_attr *attr, u32 size) | |
85 | * Using attr->map_fd, attr->key, attr->value, attr->flags | |
86 | * returns zero or negative error | |
87 | */ | |
88 | BPF_MAP_UPDATE_ELEM, | |
89 | ||
90 | /* find and delete elem by key in a given map | |
91 | * err = bpf(BPF_MAP_DELETE_ELEM, union bpf_attr *attr, u32 size) | |
92 | * Using attr->map_fd, attr->key | |
93 | * returns zero or negative error | |
94 | */ | |
95 | BPF_MAP_DELETE_ELEM, | |
96 | ||
97 | /* lookup key in a given map and return next key | |
98 | * err = bpf(BPF_MAP_GET_NEXT_KEY, union bpf_attr *attr, u32 size) | |
99 | * Using attr->map_fd, attr->key, attr->next_key | |
100 | * returns zero and stores next key or negative error | |
101 | */ | |
102 | BPF_MAP_GET_NEXT_KEY, | |
103 | ||
104 | /* verify and load eBPF program | |
105 | * prog_fd = bpf(BPF_PROG_LOAD, union bpf_attr *attr, u32 size) | |
106 | * Using attr->prog_type, attr->insns, attr->license | |
107 | * returns fd or negative error | |
108 | */ | |
109 | BPF_PROG_LOAD, | |
110 | }; | |
111 | ||
112 | enum bpf_map_type { | |
113 | BPF_MAP_TYPE_UNSPEC, | |
114 | BPF_MAP_TYPE_HASH, | |
115 | BPF_MAP_TYPE_ARRAY, | |
116 | }; | |
117 | ||
118 | enum bpf_prog_type { | |
119 | BPF_PROG_TYPE_UNSPEC, | |
120 | BPF_PROG_TYPE_SOCKET_FILTER, | |
121 | BPF_PROG_TYPE_SCHED_CLS, | |
cbdc3ed8 | 122 | BPF_PROG_TYPE_SCHED_ACT, |
b54ac87e DB |
123 | }; |
124 | ||
125 | #define BPF_PSEUDO_MAP_FD 1 | |
126 | ||
127 | /* flags for BPF_MAP_UPDATE_ELEM command */ | |
128 | #define BPF_ANY 0 /* create new element or update existing */ | |
129 | #define BPF_NOEXIST 1 /* create new element if it didn't exist */ | |
130 | #define BPF_EXIST 2 /* update existing element */ | |
131 | ||
132 | union bpf_attr { | |
133 | struct { /* anonymous struct used by BPF_MAP_CREATE command */ | |
134 | __u32 map_type; /* one of enum bpf_map_type */ | |
135 | __u32 key_size; /* size of key in bytes */ | |
136 | __u32 value_size; /* size of value in bytes */ | |
137 | __u32 max_entries; /* max number of entries in a map */ | |
138 | }; | |
139 | ||
140 | struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ | |
141 | __u32 map_fd; | |
142 | __aligned_u64 key; | |
143 | union { | |
144 | __aligned_u64 value; | |
145 | __aligned_u64 next_key; | |
146 | }; | |
147 | __u64 flags; | |
148 | }; | |
149 | ||
150 | struct { /* anonymous struct used by BPF_PROG_LOAD command */ | |
151 | __u32 prog_type; /* one of enum bpf_prog_type */ | |
152 | __u32 insn_cnt; | |
153 | __aligned_u64 insns; | |
154 | __aligned_u64 license; | |
155 | __u32 log_level; /* verbosity level of verifier */ | |
156 | __u32 log_size; /* size of user buffer */ | |
157 | __aligned_u64 log_buf; /* user supplied buffer */ | |
158 | }; | |
159 | } __attribute__((aligned(8))); | |
160 | ||
161 | /* integer value in 'imm' field of BPF_CALL instruction selects which helper | |
162 | * function eBPF program intends to call | |
163 | */ | |
164 | enum bpf_func_id { | |
165 | BPF_FUNC_unspec, | |
166 | BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */ | |
167 | BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */ | |
168 | BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */ | |
169 | BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */ | |
170 | BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */ | |
e46efaed SH |
171 | |
172 | /** | |
173 | * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet | |
174 | * @skb: pointer to skb | |
175 | * @offset: offset within packet from skb->data | |
176 | * @from: pointer where to copy bytes from | |
177 | * @len: number of bytes to store into packet | |
178 | * @flags: bit 0 - if true, recompute skb->csum | |
179 | * other bits - reserved | |
180 | * Return: 0 on success | |
181 | */ | |
182 | BPF_FUNC_skb_store_bytes, | |
183 | ||
184 | /** | |
185 | * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum | |
186 | * @skb: pointer to skb | |
187 | * @offset: offset within packet where IP checksum is located | |
188 | * @from: old value of header field | |
189 | * @to: new value of header field | |
190 | * @flags: bits 0-3 - size of header field | |
191 | * other bits - reserved | |
192 | * Return: 0 on success | |
193 | */ | |
194 | BPF_FUNC_l3_csum_replace, | |
195 | ||
196 | /** | |
197 | * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum | |
198 | * @skb: pointer to skb | |
199 | * @offset: offset within packet where TCP/UDP checksum is located | |
200 | * @from: old value of header field | |
201 | * @to: new value of header field | |
202 | * @flags: bits 0-3 - size of header field | |
203 | * bit 4 - is pseudo header | |
204 | * other bits - reserved | |
205 | * Return: 0 on success | |
206 | */ | |
207 | BPF_FUNC_l4_csum_replace, | |
b54ac87e DB |
208 | __BPF_FUNC_MAX_ID, |
209 | }; | |
210 | ||
211 | /* user accessible mirror of in-kernel sk_buff. | |
212 | * new fields can only be added to the end of this structure | |
213 | */ | |
214 | struct __sk_buff { | |
215 | __u32 len; | |
216 | __u32 pkt_type; | |
217 | __u32 mark; | |
218 | __u32 queue_mapping; | |
cbdc3ed8 SH |
219 | __u32 protocol; |
220 | __u32 vlan_present; | |
221 | __u32 vlan_tci; | |
222 | __u32 vlan_proto; | |
e46efaed | 223 | __u32 priority; |
b54ac87e DB |
224 | }; |
225 | ||
226 | #endif /* __LINUX_BPF_H__ */ |