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> 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, see bpf(2) man-page for details. */ 67 enum bpf_cmd { 68 BPF_MAP_CREATE, 69 BPF_MAP_LOOKUP_ELEM, 70 BPF_MAP_UPDATE_ELEM, 71 BPF_MAP_DELETE_ELEM, 72 BPF_MAP_GET_NEXT_KEY, 73 BPF_PROG_LOAD, 74 BPF_OBJ_PIN, 75 BPF_OBJ_GET, 76 }; 77 78 enum bpf_map_type { 79 BPF_MAP_TYPE_UNSPEC, 80 BPF_MAP_TYPE_HASH, 81 BPF_MAP_TYPE_ARRAY, 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, 87 }; 88 89 enum bpf_prog_type { 90 BPF_PROG_TYPE_UNSPEC, 91 BPF_PROG_TYPE_SOCKET_FILTER, 92 BPF_PROG_TYPE_KPROBE, 93 BPF_PROG_TYPE_SCHED_CLS, 94 BPF_PROG_TYPE_SCHED_ACT, 95 }; 96 97 #define BPF_PSEUDO_MAP_FD 1 98 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 */ 103 104 union bpf_attr { 105 struct { /* anonymous struct used by BPF_MAP_CREATE command */ 106 __u32 map_type; /* one of enum bpf_map_type */ 107 __u32 key_size; /* size of key in bytes */ 108 __u32 value_size; /* size of value in bytes */ 109 __u32 max_entries; /* max number of entries in a map */ 110 }; 111 112 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ 113 __u32 map_fd; 114 __aligned_u64 key; 115 union { 116 __aligned_u64 value; 117 __aligned_u64 next_key; 118 }; 119 __u64 flags; 120 }; 121 122 struct { /* anonymous struct used by BPF_PROG_LOAD command */ 123 __u32 prog_type; /* one of enum bpf_prog_type */ 124 __u32 insn_cnt; 125 __aligned_u64 insns; 126 __aligned_u64 license; 127 __u32 log_level; /* verbosity level of verifier */ 128 __u32 log_size; /* size of user buffer */ 129 __aligned_u64 log_buf; /* user supplied buffer */ 130 __u32 kern_version; /* checked when prog_type=kprobe */ 131 }; 132 133 struct { /* anonymous struct used by BPF_OBJ_* commands */ 134 __aligned_u64 pathname; 135 __u32 bpf_fd; 136 }; 137 } __attribute__((aligned(8))); 138 139 /* integer value in 'imm' field of BPF_CALL instruction selects which helper 140 * function eBPF program intends to call 141 */ 142 enum bpf_func_id { 143 BPF_FUNC_unspec, 144 BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */ 145 BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */ 146 BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */ 147 BPF_FUNC_probe_read, /* int bpf_probe_read(void *dst, int size, void *src) */ 148 BPF_FUNC_ktime_get_ns, /* u64 bpf_ktime_get_ns(void) */ 149 BPF_FUNC_trace_printk, /* int bpf_trace_printk(const char *fmt, int fmt_size, ...) */ 150 BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */ 151 BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */ 152 153 /** 154 * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet 155 * @skb: pointer to skb 156 * @offset: offset within packet from skb->mac_header 157 * @from: pointer where to copy bytes from 158 * @len: number of bytes to store into packet 159 * @flags: bit 0 - if true, recompute skb->csum 160 * other bits - reserved 161 * Return: 0 on success 162 */ 163 BPF_FUNC_skb_store_bytes, 164 165 /** 166 * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum 167 * @skb: pointer to skb 168 * @offset: offset within packet where IP checksum is located 169 * @from: old value of header field 170 * @to: new value of header field 171 * @flags: bits 0-3 - size of header field 172 * other bits - reserved 173 * Return: 0 on success 174 */ 175 BPF_FUNC_l3_csum_replace, 176 177 /** 178 * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum 179 * @skb: pointer to skb 180 * @offset: offset within packet where TCP/UDP checksum is located 181 * @from: old value of header field 182 * @to: new value of header field 183 * @flags: bits 0-3 - size of header field 184 * bit 4 - is pseudo header 185 * other bits - reserved 186 * Return: 0 on success 187 */ 188 BPF_FUNC_l4_csum_replace, 189 190 /** 191 * bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program 192 * @ctx: context pointer passed to next program 193 * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY 194 * @index: index inside array that selects specific program to run 195 * Return: 0 on success 196 */ 197 BPF_FUNC_tail_call, 198 199 /** 200 * bpf_clone_redirect(skb, ifindex, flags) - redirect to another netdev 201 * @skb: pointer to skb 202 * @ifindex: ifindex of the net device 203 * @flags: bit 0 - if set, redirect to ingress instead of egress 204 * other bits - reserved 205 * Return: 0 on success 206 */ 207 BPF_FUNC_clone_redirect, 208 209 /** 210 * u64 bpf_get_current_pid_tgid(void) 211 * Return: current->tgid << 32 | current->pid 212 */ 213 BPF_FUNC_get_current_pid_tgid, 214 215 /** 216 * u64 bpf_get_current_uid_gid(void) 217 * Return: current_gid << 32 | current_uid 218 */ 219 BPF_FUNC_get_current_uid_gid, 220 221 /** 222 * bpf_get_current_comm(char *buf, int size_of_buf) 223 * stores current->comm into buf 224 * Return: 0 on success 225 */ 226 BPF_FUNC_get_current_comm, 227 228 /** 229 * bpf_get_cgroup_classid(skb) - retrieve a proc's classid 230 * @skb: pointer to skb 231 * Return: classid if != 0 232 */ 233 BPF_FUNC_get_cgroup_classid, 234 BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */ 235 BPF_FUNC_skb_vlan_pop, /* bpf_skb_vlan_pop(skb) */ 236 237 /** 238 * bpf_skb_[gs]et_tunnel_key(skb, key, size, flags) 239 * retrieve or populate tunnel metadata 240 * @skb: pointer to skb 241 * @key: pointer to 'struct bpf_tunnel_key' 242 * @size: size of 'struct bpf_tunnel_key' 243 * @flags: room for future extensions 244 * Retrun: 0 on success 245 */ 246 BPF_FUNC_skb_get_tunnel_key, 247 BPF_FUNC_skb_set_tunnel_key, 248 BPF_FUNC_perf_event_read, /* u64 bpf_perf_event_read(&map, index) */ 249 /** 250 * bpf_redirect(ifindex, flags) - redirect to another netdev 251 * @ifindex: ifindex of the net device 252 * @flags: bit 0 - if set, redirect to ingress instead of egress 253 * other bits - reserved 254 * Return: TC_ACT_REDIRECT 255 */ 256 BPF_FUNC_redirect, 257 258 /** 259 * bpf_get_route_realm(skb) - retrieve a dst's tclassid 260 * @skb: pointer to skb 261 * Return: realm if != 0 262 */ 263 BPF_FUNC_get_route_realm, 264 265 /** 266 * bpf_perf_event_output(ctx, map, index, data, size) - output perf raw sample 267 * @ctx: struct pt_regs* 268 * @map: pointer to perf_event_array map 269 * @index: index of event in the map 270 * @data: data on stack to be output as raw data 271 * @size: size of data 272 * Return: 0 on success 273 */ 274 BPF_FUNC_perf_event_output, 275 BPF_FUNC_skb_load_bytes, 276 277 /** 278 * bpf_get_stackid(ctx, map, flags) - walk user or kernel stack and return id 279 * @ctx: struct pt_regs* 280 * @map: pointer to stack_trace map 281 * @flags: bits 0-7 - numer of stack frames to skip 282 * bit 8 - collect user stack instead of kernel 283 * bit 9 - compare stacks by hash only 284 * bit 10 - if two different stacks hash into the same stackid 285 * discard old 286 * other bits - reserved 287 * Return: >= 0 stackid on success or negative error 288 */ 289 BPF_FUNC_get_stackid, 290 291 /** 292 * bpf_csum_diff(from, from_size, to, to_size, seed) - calculate csum diff 293 * @from: raw from buffer 294 * @from_size: length of from buffer 295 * @to: raw to buffer 296 * @to_size: length of to buffer 297 * @seed: optional seed 298 * Return: csum result 299 */ 300 BPF_FUNC_csum_diff, 301 __BPF_FUNC_MAX_ID, 302 }; 303 304 /* All flags used by eBPF helper functions, placed here. */ 305 306 /* BPF_FUNC_skb_store_bytes flags. */ 307 #define BPF_F_RECOMPUTE_CSUM (1ULL << 0) 308 309 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags. 310 * First 4 bits are for passing the header field size. 311 */ 312 #define BPF_F_HDR_FIELD_MASK 0xfULL 313 314 /* BPF_FUNC_l4_csum_replace flags. */ 315 #define BPF_F_PSEUDO_HDR (1ULL << 4) 316 #define BPF_F_MARK_MANGLED_0 (1ULL << 5) 317 318 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */ 319 #define BPF_F_INGRESS (1ULL << 0) 320 321 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */ 322 #define BPF_F_TUNINFO_IPV6 (1ULL << 0) 323 324 /* BPF_FUNC_get_stackid flags. */ 325 #define BPF_F_SKIP_FIELD_MASK 0xffULL 326 #define BPF_F_USER_STACK (1ULL << 8) 327 #define BPF_F_FAST_STACK_CMP (1ULL << 9) 328 #define BPF_F_REUSE_STACKID (1ULL << 10) 329 330 /* user accessible mirror of in-kernel sk_buff. 331 * new fields can only be added to the end of this structure 332 */ 333 struct __sk_buff { 334 __u32 len; 335 __u32 pkt_type; 336 __u32 mark; 337 __u32 queue_mapping; 338 __u32 protocol; 339 __u32 vlan_present; 340 __u32 vlan_tci; 341 __u32 vlan_proto; 342 __u32 priority; 343 __u32 ingress_ifindex; 344 __u32 ifindex; 345 __u32 tc_index; 346 __u32 cb[5]; 347 __u32 hash; 348 __u32 tc_classid; 349 }; 350 351 struct bpf_tunnel_key { 352 __u32 tunnel_id; 353 union { 354 __u32 remote_ipv4; 355 __u32 remote_ipv6[4]; 356 }; 357 __u8 tunnel_tos; 358 __u8 tunnel_ttl; 359 }; 360 361 #endif /* _UAPI__LINUX_BPF_H__ */ 362