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 */ 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 BPF_MAP_TYPE_PROG_ARRAY, 117 BPF_MAP_TYPE_PERF_EVENT_ARRAY, 118 }; 119 120 enum bpf_prog_type { 121 BPF_PROG_TYPE_UNSPEC, 122 BPF_PROG_TYPE_SOCKET_FILTER, 123 BPF_PROG_TYPE_KPROBE, 124 BPF_PROG_TYPE_SCHED_CLS, 125 BPF_PROG_TYPE_SCHED_ACT, 126 }; 127 128 #define BPF_PSEUDO_MAP_FD 1 129 130 /* flags for BPF_MAP_UPDATE_ELEM command */ 131 #define BPF_ANY 0 /* create new element or update existing */ 132 #define BPF_NOEXIST 1 /* create new element if it didn't exist */ 133 #define BPF_EXIST 2 /* update existing element */ 134 135 union bpf_attr { 136 struct { /* anonymous struct used by BPF_MAP_CREATE command */ 137 __u32 map_type; /* one of enum bpf_map_type */ 138 __u32 key_size; /* size of key in bytes */ 139 __u32 value_size; /* size of value in bytes */ 140 __u32 max_entries; /* max number of entries in a map */ 141 }; 142 143 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ 144 __u32 map_fd; 145 __aligned_u64 key; 146 union { 147 __aligned_u64 value; 148 __aligned_u64 next_key; 149 }; 150 __u64 flags; 151 }; 152 153 struct { /* anonymous struct used by BPF_PROG_LOAD command */ 154 __u32 prog_type; /* one of enum bpf_prog_type */ 155 __u32 insn_cnt; 156 __aligned_u64 insns; 157 __aligned_u64 license; 158 __u32 log_level; /* verbosity level of verifier */ 159 __u32 log_size; /* size of user buffer */ 160 __aligned_u64 log_buf; /* user supplied buffer */ 161 __u32 kern_version; /* checked when prog_type=kprobe */ 162 }; 163 } __attribute__((aligned(8))); 164 165 /* integer value in 'imm' field of BPF_CALL instruction selects which helper 166 * function eBPF program intends to call 167 */ 168 enum bpf_func_id { 169 BPF_FUNC_unspec, 170 BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */ 171 BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */ 172 BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */ 173 BPF_FUNC_probe_read, /* int bpf_probe_read(void *dst, int size, void *src) */ 174 BPF_FUNC_ktime_get_ns, /* u64 bpf_ktime_get_ns(void) */ 175 BPF_FUNC_trace_printk, /* int bpf_trace_printk(const char *fmt, int fmt_size, ...) */ 176 BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */ 177 BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */ 178 179 /** 180 * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet 181 * @skb: pointer to skb 182 * @offset: offset within packet from skb->mac_header 183 * @from: pointer where to copy bytes from 184 * @len: number of bytes to store into packet 185 * @flags: bit 0 - if true, recompute skb->csum 186 * other bits - reserved 187 * Return: 0 on success 188 */ 189 BPF_FUNC_skb_store_bytes, 190 191 /** 192 * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum 193 * @skb: pointer to skb 194 * @offset: offset within packet where IP checksum is located 195 * @from: old value of header field 196 * @to: new value of header field 197 * @flags: bits 0-3 - size of header field 198 * other bits - reserved 199 * Return: 0 on success 200 */ 201 BPF_FUNC_l3_csum_replace, 202 203 /** 204 * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum 205 * @skb: pointer to skb 206 * @offset: offset within packet where TCP/UDP checksum is located 207 * @from: old value of header field 208 * @to: new value of header field 209 * @flags: bits 0-3 - size of header field 210 * bit 4 - is pseudo header 211 * other bits - reserved 212 * Return: 0 on success 213 */ 214 BPF_FUNC_l4_csum_replace, 215 216 /** 217 * bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program 218 * @ctx: context pointer passed to next program 219 * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY 220 * @index: index inside array that selects specific program to run 221 * Return: 0 on success 222 */ 223 BPF_FUNC_tail_call, 224 225 /** 226 * bpf_clone_redirect(skb, ifindex, flags) - redirect to another netdev 227 * @skb: pointer to skb 228 * @ifindex: ifindex of the net device 229 * @flags: bit 0 - if set, redirect to ingress instead of egress 230 * other bits - reserved 231 * Return: 0 on success 232 */ 233 BPF_FUNC_clone_redirect, 234 235 /** 236 * u64 bpf_get_current_pid_tgid(void) 237 * Return: current->tgid << 32 | current->pid 238 */ 239 BPF_FUNC_get_current_pid_tgid, 240 241 /** 242 * u64 bpf_get_current_uid_gid(void) 243 * Return: current_gid << 32 | current_uid 244 */ 245 BPF_FUNC_get_current_uid_gid, 246 247 /** 248 * bpf_get_current_comm(char *buf, int size_of_buf) 249 * stores current->comm into buf 250 * Return: 0 on success 251 */ 252 BPF_FUNC_get_current_comm, 253 254 /** 255 * bpf_get_cgroup_classid(skb) - retrieve a proc's classid 256 * @skb: pointer to skb 257 * Return: classid if != 0 258 */ 259 BPF_FUNC_get_cgroup_classid, 260 BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */ 261 BPF_FUNC_skb_vlan_pop, /* bpf_skb_vlan_pop(skb) */ 262 263 /** 264 * bpf_skb_[gs]et_tunnel_key(skb, key, size, flags) 265 * retrieve or populate tunnel metadata 266 * @skb: pointer to skb 267 * @key: pointer to 'struct bpf_tunnel_key' 268 * @size: size of 'struct bpf_tunnel_key' 269 * @flags: room for future extensions 270 * Retrun: 0 on success 271 */ 272 BPF_FUNC_skb_get_tunnel_key, 273 BPF_FUNC_skb_set_tunnel_key, 274 BPF_FUNC_perf_event_read, /* u64 bpf_perf_event_read(&map, index) */ 275 __BPF_FUNC_MAX_ID, 276 }; 277 278 /* user accessible mirror of in-kernel sk_buff. 279 * new fields can only be added to the end of this structure 280 */ 281 struct __sk_buff { 282 __u32 len; 283 __u32 pkt_type; 284 __u32 mark; 285 __u32 queue_mapping; 286 __u32 protocol; 287 __u32 vlan_present; 288 __u32 vlan_tci; 289 __u32 vlan_proto; 290 __u32 priority; 291 __u32 ingress_ifindex; 292 __u32 ifindex; 293 __u32 tc_index; 294 __u32 cb[5]; 295 __u32 hash; 296 }; 297 298 struct bpf_tunnel_key { 299 __u32 tunnel_id; 300 __u32 remote_ipv4; 301 }; 302 303 #endif /* _UAPI__LINUX_BPF_H__ */ 304