tools/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, 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         BPF_MAP_TYPE_CGROUP_ARRAY,
  88 };
  89
  90 enum bpf_prog_type {
  91         BPF_PROG_TYPE_UNSPEC,
  92         BPF_PROG_TYPE_SOCKET_FILTER,
  93         BPF_PROG_TYPE_KPROBE,
  94         BPF_PROG_TYPE_SCHED_CLS,
  95         BPF_PROG_TYPE_SCHED_ACT,
  96         BPF_PROG_TYPE_TRACEPOINT,
  97         BPF_PROG_TYPE_XDP,
  98         BPF_PROG_TYPE_PERF_EVENT,
  99 };
 100
 101 #define BPF_PSEUDO_MAP_FD       1
 102
 103 /* flags for BPF_MAP_UPDATE_ELEM command */
 104 #define BPF_ANY         0 /* create new element or update existing */
 105 #define BPF_NOEXIST     1 /* create new element if it didn't exist */
 106 #define BPF_EXIST       2 /* update existing element */
 107
 108 #define BPF_F_NO_PREALLOC       (1U << 0)
 109
 110 union bpf_attr {
 111         struct { /* anonymous struct used by BPF_MAP_CREATE command */
 112                 __u32   map_type;       /* one of enum bpf_map_type */
 113                 __u32   key_size;       /* size of key in bytes */
 114                 __u32   value_size;     /* size of value in bytes */
 115                 __u32   max_entries;    /* max number of entries in a map */
 116                 __u32   map_flags;      /* prealloc or not */
 117         };
 118
 119         struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
 120                 __u32           map_fd;
 121                 __aligned_u64   key;
 122                 union {
 123                         __aligned_u64 value;
 124                         __aligned_u64 next_key;
 125                 };
 126                 __u64           flags;
 127         };
 128
 129         struct { /* anonymous struct used by BPF_PROG_LOAD command */
 130                 __u32           prog_type;      /* one of enum bpf_prog_type */
 131                 __u32           insn_cnt;
 132                 __aligned_u64   insns;
 133                 __aligned_u64   license;
 134                 __u32           log_level;      /* verbosity level of verifier */
 135                 __u32           log_size;       /* size of user buffer */
 136                 __aligned_u64   log_buf;        /* user supplied buffer */
 137                 __u32           kern_version;   /* checked when prog_type=kprobe */
 138         };
 139
 140         struct { /* anonymous struct used by BPF_OBJ_* commands */
 141                 __aligned_u64   pathname;
 142                 __u32           bpf_fd;
 143         };
 144 } __attribute__((aligned(8)));
 145
 146 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
 147  * function eBPF program intends to call
 148  */
 149 enum bpf_func_id {
 150         BPF_FUNC_unspec,
 151         BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */
 152         BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */
 153         BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */
 154         BPF_FUNC_probe_read,      /* int bpf_probe_read(void *dst, int size, void *src) */
 155         BPF_FUNC_ktime_get_ns,    /* u64 bpf_ktime_get_ns(void) */
 156         BPF_FUNC_trace_printk,    /* int bpf_trace_printk(const char *fmt, int fmt_size, ...) */
 157         BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */
 158         BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */
 159
 160         /**
 161          * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet
 162          * @skb: pointer to skb
 163          * @offset: offset within packet from skb->mac_header
 164          * @from: pointer where to copy bytes from
 165          * @len: number of bytes to store into packet
 166          * @flags: bit 0 - if true, recompute skb->csum
 167          *         other bits - reserved
 168          * Return: 0 on success
 169          */
 170         BPF_FUNC_skb_store_bytes,
 171
 172         /**
 173          * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum
 174          * @skb: pointer to skb
 175          * @offset: offset within packet where IP checksum is located
 176          * @from: old value of header field
 177          * @to: new value of header field
 178          * @flags: bits 0-3 - size of header field
 179          *         other bits - reserved
 180          * Return: 0 on success
 181          */
 182         BPF_FUNC_l3_csum_replace,
 183
 184         /**
 185          * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum
 186          * @skb: pointer to skb
 187          * @offset: offset within packet where TCP/UDP 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          *         bit 4 - is pseudo header
 192          *         other bits - reserved
 193          * Return: 0 on success
 194          */
 195         BPF_FUNC_l4_csum_replace,
 196
 197         /**
 198          * bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program
 199          * @ctx: context pointer passed to next program
 200          * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
 201          * @index: index inside array that selects specific program to run
 202          * Return: 0 on success
 203          */
 204         BPF_FUNC_tail_call,
 205
 206         /**
 207          * bpf_clone_redirect(skb, ifindex, flags) - redirect to another netdev
 208          * @skb: pointer to skb
 209          * @ifindex: ifindex of the net device
 210          * @flags: bit 0 - if set, redirect to ingress instead of egress
 211          *         other bits - reserved
 212          * Return: 0 on success
 213          */
 214         BPF_FUNC_clone_redirect,
 215
 216         /**
 217          * u64 bpf_get_current_pid_tgid(void)
 218          * Return: current->tgid << 32 | current->pid
 219          */
 220         BPF_FUNC_get_current_pid_tgid,
 221
 222         /**
 223          * u64 bpf_get_current_uid_gid(void)
 224          * Return: current_gid << 32 | current_uid
 225          */
 226         BPF_FUNC_get_current_uid_gid,
 227
 228         /**
 229          * bpf_get_current_comm(char *buf, int size_of_buf)
 230          * stores current->comm into buf
 231          * Return: 0 on success
 232          */
 233         BPF_FUNC_get_current_comm,
 234
 235         /**
 236          * bpf_get_cgroup_classid(skb) - retrieve a proc's classid
 237          * @skb: pointer to skb
 238          * Return: classid if != 0
 239          */
 240         BPF_FUNC_get_cgroup_classid,
 241         BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */
 242         BPF_FUNC_skb_vlan_pop,  /* bpf_skb_vlan_pop(skb) */
 243
 244         /**
 245          * bpf_skb_[gs]et_tunnel_key(skb, key, size, flags)
 246          * retrieve or populate tunnel metadata
 247          * @skb: pointer to skb
 248          * @key: pointer to 'struct bpf_tunnel_key'
 249          * @size: size of 'struct bpf_tunnel_key'
 250          * @flags: room for future extensions
 251          * Retrun: 0 on success
 252          */
 253         BPF_FUNC_skb_get_tunnel_key,
 254         BPF_FUNC_skb_set_tunnel_key,
 255         BPF_FUNC_perf_event_read,       /* u64 bpf_perf_event_read(&map, index) */
 256         /**
 257          * bpf_redirect(ifindex, flags) - redirect to another netdev
 258          * @ifindex: ifindex of the net device
 259          * @flags: bit 0 - if set, redirect to ingress instead of egress
 260          *         other bits - reserved
 261          * Return: TC_ACT_REDIRECT
 262          */
 263         BPF_FUNC_redirect,
 264
 265         /**
 266          * bpf_get_route_realm(skb) - retrieve a dst's tclassid
 267          * @skb: pointer to skb
 268          * Return: realm if != 0
 269          */
 270         BPF_FUNC_get_route_realm,
 271
 272         /**
 273          * bpf_perf_event_output(ctx, map, index, data, size) - output perf raw sample
 274          * @ctx: struct pt_regs*
 275          * @map: pointer to perf_event_array map
 276          * @index: index of event in the map
 277          * @data: data on stack to be output as raw data
 278          * @size: size of data
 279          * Return: 0 on success
 280          */
 281         BPF_FUNC_perf_event_output,
 282         BPF_FUNC_skb_load_bytes,
 283
 284         /**
 285          * bpf_get_stackid(ctx, map, flags) - walk user or kernel stack and return id
 286          * @ctx: struct pt_regs*
 287          * @map: pointer to stack_trace map
 288          * @flags: bits 0-7 - numer of stack frames to skip
 289          *         bit 8 - collect user stack instead of kernel
 290          *         bit 9 - compare stacks by hash only
 291          *         bit 10 - if two different stacks hash into the same stackid
 292          *                  discard old
 293          *         other bits - reserved
 294          * Return: >= 0 stackid on success or negative error
 295          */
 296         BPF_FUNC_get_stackid,
 297
 298         /**
 299          * bpf_csum_diff(from, from_size, to, to_size, seed) - calculate csum diff
 300          * @from: raw from buffer
 301          * @from_size: length of from buffer
 302          * @to: raw to buffer
 303          * @to_size: length of to buffer
 304          * @seed: optional seed
 305          * Return: csum result
 306          */
 307         BPF_FUNC_csum_diff,
 308
 309         /**
 310          * bpf_skb_[gs]et_tunnel_opt(skb, opt, size)
 311          * retrieve or populate tunnel options metadata
 312          * @skb: pointer to skb
 313          * @opt: pointer to raw tunnel option data
 314          * @size: size of @opt
 315          * Return: 0 on success for set, option size for get
 316          */
 317         BPF_FUNC_skb_get_tunnel_opt,
 318         BPF_FUNC_skb_set_tunnel_opt,
 319
 320         /**
 321          * bpf_skb_change_proto(skb, proto, flags)
 322          * Change protocol of the skb. Currently supported is
 323          * v4 -> v6, v6 -> v4 transitions. The helper will also
 324          * resize the skb. eBPF program is expected to fill the
 325          * new headers via skb_store_bytes and lX_csum_replace.
 326          * @skb: pointer to skb
 327          * @proto: new skb->protocol type
 328          * @flags: reserved
 329          * Return: 0 on success or negative error
 330          */
 331         BPF_FUNC_skb_change_proto,
 332
 333         /**
 334          * bpf_skb_change_type(skb, type)
 335          * Change packet type of skb.
 336          * @skb: pointer to skb
 337          * @type: new skb->pkt_type type
 338          * Return: 0 on success or negative error
 339          */
 340         BPF_FUNC_skb_change_type,
 341
 342         /**
 343          * bpf_skb_under_cgroup(skb, map, index) - Check cgroup2 membership of skb
 344          * @skb: pointer to skb
 345          * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
 346          * @index: index of the cgroup in the bpf_map
 347          * Return:
 348          *   == 0 skb failed the cgroup2 descendant test
 349          *   == 1 skb succeeded the cgroup2 descendant test
 350          *    < 0 error
 351          */
 352         BPF_FUNC_skb_under_cgroup,
 353
 354         /**
 355          * bpf_get_hash_recalc(skb)
 356          * Retrieve and possibly recalculate skb->hash.
 357          * @skb: pointer to skb
 358          * Return: hash
 359          */
 360         BPF_FUNC_get_hash_recalc,
 361
 362         /**
 363          * u64 bpf_get_current_task(void)
 364          * Returns current task_struct
 365          * Return: current
 366          */
 367         BPF_FUNC_get_current_task,
 368
 369         /**
 370          * bpf_probe_write_user(void *dst, void *src, int len)
 371          * safely attempt to write to a location
 372          * @dst: destination address in userspace
 373          * @src: source address on stack
 374          * @len: number of bytes to copy
 375          * Return: 0 on success or negative error
 376          */
 377         BPF_FUNC_probe_write_user,
 378
 379         /**
 380          * bpf_current_task_under_cgroup(map, index) - Check cgroup2 membership of current task
 381          * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
 382          * @index: index of the cgroup in the bpf_map
 383          * Return:
 384          *   == 0 current failed the cgroup2 descendant test
 385          *   == 1 current succeeded the cgroup2 descendant test
 386          *    < 0 error
 387          */
 388         BPF_FUNC_current_task_under_cgroup,
 389
 390         /**
 391          * bpf_skb_change_tail(skb, len, flags)
 392          * The helper will resize the skb to the given new size,
 393          * to be used f.e. with control messages.
 394          * @skb: pointer to skb
 395          * @len: new skb length
 396          * @flags: reserved
 397          * Return: 0 on success or negative error
 398          */
 399         BPF_FUNC_skb_change_tail,
 400
 401         /**
 402          * bpf_skb_pull_data(skb, len)
 403          * The helper will pull in non-linear data in case the
 404          * skb is non-linear and not all of len are part of the
 405          * linear section. Only needed for read/write with direct
 406          * packet access.
 407          * @skb: pointer to skb
 408          * @len: len to make read/writeable
 409          * Return: 0 on success or negative error
 410          */
 411         BPF_FUNC_skb_pull_data,
 412
 413         /**
 414          * bpf_csum_update(skb, csum)
 415          * Adds csum into skb->csum in case of CHECKSUM_COMPLETE.
 416          * @skb: pointer to skb
 417          * @csum: csum to add
 418          * Return: csum on success or negative error
 419          */
 420         BPF_FUNC_csum_update,
 421
 422         /**
 423          * bpf_set_hash_invalid(skb)
 424          * Invalidate current skb>hash.
 425          * @skb: pointer to skb
 426          */
 427         BPF_FUNC_set_hash_invalid,
 428
 429         __BPF_FUNC_MAX_ID,
 430 };
 431
 432 /* All flags used by eBPF helper functions, placed here. */
 433
 434 /* BPF_FUNC_skb_store_bytes flags. */
 435 #define BPF_F_RECOMPUTE_CSUM            (1ULL << 0)
 436 #define BPF_F_INVALIDATE_HASH           (1ULL << 1)
 437
 438 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
 439  * First 4 bits are for passing the header field size.
 440  */
 441 #define BPF_F_HDR_FIELD_MASK            0xfULL
 442
 443 /* BPF_FUNC_l4_csum_replace flags. */
 444 #define BPF_F_PSEUDO_HDR                (1ULL << 4)
 445 #define BPF_F_MARK_MANGLED_0            (1ULL << 5)
 446
 447 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
 448 #define BPF_F_INGRESS                   (1ULL << 0)
 449
 450 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
 451 #define BPF_F_TUNINFO_IPV6              (1ULL << 0)
 452
 453 /* BPF_FUNC_get_stackid flags. */
 454 #define BPF_F_SKIP_FIELD_MASK           0xffULL
 455 #define BPF_F_USER_STACK                (1ULL << 8)
 456 #define BPF_F_FAST_STACK_CMP            (1ULL << 9)
 457 #define BPF_F_REUSE_STACKID             (1ULL << 10)
 458
 459 /* BPF_FUNC_skb_set_tunnel_key flags. */
 460 #define BPF_F_ZERO_CSUM_TX              (1ULL << 1)
 461 #define BPF_F_DONT_FRAGMENT             (1ULL << 2)
 462
 463 /* BPF_FUNC_perf_event_output and BPF_FUNC_perf_event_read flags. */
 464 #define BPF_F_INDEX_MASK                0xffffffffULL
 465 #define BPF_F_CURRENT_CPU               BPF_F_INDEX_MASK
 466 /* BPF_FUNC_perf_event_output for sk_buff input context. */
 467 #define BPF_F_CTXLEN_MASK               (0xfffffULL << 32)
 468
 469 /* user accessible mirror of in-kernel sk_buff.
 470  * new fields can only be added to the end of this structure
 471  */
 472 struct __sk_buff {
 473         __u32 len;
 474         __u32 pkt_type;
 475         __u32 mark;
 476         __u32 queue_mapping;
 477         __u32 protocol;
 478         __u32 vlan_present;
 479         __u32 vlan_tci;
 480         __u32 vlan_proto;
 481         __u32 priority;
 482         __u32 ingress_ifindex;
 483         __u32 ifindex;
 484         __u32 tc_index;
 485         __u32 cb[5];
 486         __u32 hash;
 487         __u32 tc_classid;
 488         __u32 data;
 489         __u32 data_end;
 490 };
 491
 492 struct bpf_tunnel_key {
 493         __u32 tunnel_id;
 494         union {
 495                 __u32 remote_ipv4;
 496                 __u32 remote_ipv6[4];
 497         };
 498         __u8 tunnel_tos;
 499         __u8 tunnel_ttl;
 500         __u16 tunnel_ext;
 501         __u32 tunnel_label;
 502 };
 503
 504 /* User return codes for XDP prog type.
 505  * A valid XDP program must return one of these defined values. All other
 506  * return codes are reserved for future use. Unknown return codes will result
 507  * in packet drop.
 508  */
 509 enum xdp_action {
 510         XDP_ABORTED = 0,
 511         XDP_DROP,
 512         XDP_PASS,
 513         XDP_TX,
 514 };
 515
 516 /* user accessible metadata for XDP packet hook
 517  * new fields must be added to the end of this structure
 518  */
 519 struct xdp_md {
 520         __u32 data;
 521         __u32 data_end;
 522 };
 523
 524 #endif /* _UAPI__LINUX_BPF_H__ */