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 #define BPF_F_NO_PREALLOC (1U << 0) 105 106 union bpf_attr { 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 */ 113 }; 114 115 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ 116 __u32 map_fd; 117 __aligned_u64 key; 118 union { 119 __aligned_u64 value; 120 __aligned_u64 next_key; 121 }; 122 __u64 flags; 123 }; 124 125 struct { /* anonymous struct used by BPF_PROG_LOAD command */ 126 __u32 prog_type; /* one of enum bpf_prog_type */ 127 __u32 insn_cnt; 128 __aligned_u64 insns; 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 */ 134 }; 135 136 struct { /* anonymous struct used by BPF_OBJ_* commands */ 137 __aligned_u64 pathname; 138 __u32 bpf_fd; 139 }; 140 } __attribute__((aligned(8))); 141 142 /* integer value in 'imm' field of BPF_CALL instruction selects which helper 143 * function eBPF program intends to call 144 */ 145 enum bpf_func_id { 146 BPF_FUNC_unspec, 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) */ 155 156 /** 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 165 */ 166 BPF_FUNC_skb_store_bytes, 167 168 /** 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 177 */ 178 BPF_FUNC_l3_csum_replace, 179 180 /** 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 190 */ 191 BPF_FUNC_l4_csum_replace, 192 193 /** 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 199 */ 200 BPF_FUNC_tail_call, 201 202 /** 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 209 */ 210 BPF_FUNC_clone_redirect, 211 212 /** 213 * u64 bpf_get_current_pid_tgid(void) 214 * Return: current->tgid << 32 | current->pid 215 */ 216 BPF_FUNC_get_current_pid_tgid, 217 218 /** 219 * u64 bpf_get_current_uid_gid(void) 220 * Return: current_gid << 32 | current_uid 221 */ 222 BPF_FUNC_get_current_uid_gid, 223 224 /** 225 * bpf_get_current_comm(char *buf, int size_of_buf) 226 * stores current->comm into buf 227 * Return: 0 on success 228 */ 229 BPF_FUNC_get_current_comm, 230 231 /** 232 * bpf_get_cgroup_classid(skb) - retrieve a proc's classid 233 * @skb: pointer to skb 234 * Return: classid if != 0 235 */ 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) */ 239 240 /** 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 248 */ 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) */ 252 /** 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 258 */ 259 BPF_FUNC_redirect, 260 261 /** 262 * bpf_get_route_realm(skb) - retrieve a dst's tclassid 263 * @skb: pointer to skb 264 * Return: realm if != 0 265 */ 266 BPF_FUNC_get_route_realm, 267 268 /** 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 276 */ 277 BPF_FUNC_perf_event_output, 278 BPF_FUNC_skb_load_bytes, 279 280 /** 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 288 * discard old 289 * other bits - reserved 290 * Return: >= 0 stackid on success or negative error 291 */ 292 BPF_FUNC_get_stackid, 293 294 /** 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 298 * @to: raw to buffer 299 * @to_size: length of to buffer 300 * @seed: optional seed 301 * Return: csum result 302 */ 303 BPF_FUNC_csum_diff, 304 305 /** 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 312 */ 313 BPF_FUNC_skb_get_tunnel_opt, 314 BPF_FUNC_skb_set_tunnel_opt, 315 __BPF_FUNC_MAX_ID, 316 }; 317 318 /* All flags used by eBPF helper functions, placed here. */ 319 320 /* BPF_FUNC_skb_store_bytes flags. */ 321 #define BPF_F_RECOMPUTE_CSUM (1ULL << 0) 322 #define BPF_F_INVALIDATE_HASH (1ULL << 1) 323 324 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags. 325 * First 4 bits are for passing the header field size. 326 */ 327 #define BPF_F_HDR_FIELD_MASK 0xfULL 328 329 /* BPF_FUNC_l4_csum_replace flags. */ 330 #define BPF_F_PSEUDO_HDR (1ULL << 4) 331 #define BPF_F_MARK_MANGLED_0 (1ULL << 5) 332 333 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */ 334 #define BPF_F_INGRESS (1ULL << 0) 335 336 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */ 337 #define BPF_F_TUNINFO_IPV6 (1ULL << 0) 338 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) 344 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) 348 349 /* user accessible mirror of in-kernel sk_buff. 350 * new fields can only be added to the end of this structure 351 */ 352 struct __sk_buff { 353 __u32 len; 354 __u32 pkt_type; 355 __u32 mark; 356 __u32 queue_mapping; 357 __u32 protocol; 358 __u32 vlan_present; 359 __u32 vlan_tci; 360 __u32 vlan_proto; 361 __u32 priority; 362 __u32 ingress_ifindex; 363 __u32 ifindex; 364 __u32 tc_index; 365 __u32 cb[5]; 366 __u32 hash; 367 __u32 tc_classid; 368 }; 369 370 struct bpf_tunnel_key { 371 __u32 tunnel_id; 372 union { 373 __u32 remote_ipv4; 374 __u32 remote_ipv6[4]; 375 }; 376 __u8 tunnel_tos; 377 __u8 tunnel_ttl; 378 __u16 tunnel_ext; 379 __u32 tunnel_label; 380 }; 381 382 #endif /* _UAPI__LINUX_BPF_H__ */ 383