include/uapi/linux/bpf.h

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