include/uapi/linux/bpf.h

   1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  */
   8 #ifndef _UAPI__LINUX_BPF_H__
   9 #define _UAPI__LINUX_BPF_H__
  10
  11 #include <linux/types.h>
  12 #include <linux/bpf_common.h>
  13
  14 /* Extended instruction set based on top of classic BPF */
  15
  16 /* instruction classes */
  17 #define BPF_ALU64       0x07    /* alu mode in double word width */
  18
  19 /* ld/ldx fields */
  20 #define BPF_DW          0x18    /* double word */
  21 #define BPF_XADD        0xc0    /* exclusive add */
  22
  23 /* alu/jmp fields */
  24 #define BPF_MOV         0xb0    /* mov reg to reg */
  25 #define BPF_ARSH        0xc0    /* sign extending arithmetic shift right */
  26
  27 /* change endianness of a register */
  28 #define BPF_END         0xd0    /* flags for endianness conversion: */
  29 #define BPF_TO_LE       0x00    /* convert to little-endian */
  30 #define BPF_TO_BE       0x08    /* convert to big-endian */
  31 #define BPF_FROM_LE     BPF_TO_LE
  32 #define BPF_FROM_BE     BPF_TO_BE
  33
  34 /* jmp encodings */
  35 #define BPF_JNE         0x50    /* jump != */
  36 #define BPF_JLT         0xa0    /* LT is unsigned, '<' */
  37 #define BPF_JLE         0xb0    /* LE is unsigned, '<=' */
  38 #define BPF_JSGT        0x60    /* SGT is signed '>', GT in x86 */
  39 #define BPF_JSGE        0x70    /* SGE is signed '>=', GE in x86 */
  40 #define BPF_JSLT        0xc0    /* SLT is signed, '<' */
  41 #define BPF_JSLE        0xd0    /* SLE is signed, '<=' */
  42 #define BPF_CALL        0x80    /* function call */
  43 #define BPF_EXIT        0x90    /* function return */
  44
  45 /* Register numbers */
  46 enum {
  47         BPF_REG_0 = 0,
  48         BPF_REG_1,
  49         BPF_REG_2,
  50         BPF_REG_3,
  51         BPF_REG_4,
  52         BPF_REG_5,
  53         BPF_REG_6,
  54         BPF_REG_7,
  55         BPF_REG_8,
  56         BPF_REG_9,
  57         BPF_REG_10,
  58         __MAX_BPF_REG,
  59 };
  60
  61 /* BPF has 10 general purpose 64-bit registers and stack frame. */
  62 #define MAX_BPF_REG     __MAX_BPF_REG
  63
  64 struct bpf_insn {
  65         __u8    code;           /* opcode */
  66         __u8    dst_reg:4;      /* dest register */
  67         __u8    src_reg:4;      /* source register */
  68         __s16   off;            /* signed offset */
  69         __s32   imm;            /* signed immediate constant */
  70 };
  71
  72 /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
  73 struct bpf_lpm_trie_key {
  74         __u32   prefixlen;      /* up to 32 for AF_INET, 128 for AF_INET6 */
  75         __u8    data[0];        /* Arbitrary size */
  76 };
  77
  78 /* BPF syscall commands, see bpf(2) man-page for details. */
  79 enum bpf_cmd {
  80         BPF_MAP_CREATE,
  81         BPF_MAP_LOOKUP_ELEM,
  82         BPF_MAP_UPDATE_ELEM,
  83         BPF_MAP_DELETE_ELEM,
  84         BPF_MAP_GET_NEXT_KEY,
  85         BPF_PROG_LOAD,
  86         BPF_OBJ_PIN,
  87         BPF_OBJ_GET,
  88         BPF_PROG_ATTACH,
  89         BPF_PROG_DETACH,
  90         BPF_PROG_TEST_RUN,
  91         BPF_PROG_GET_NEXT_ID,
  92         BPF_MAP_GET_NEXT_ID,
  93         BPF_PROG_GET_FD_BY_ID,
  94         BPF_MAP_GET_FD_BY_ID,
  95         BPF_OBJ_GET_INFO_BY_FD,
  96         BPF_PROG_QUERY,
  97 };
  98
  99 enum bpf_map_type {
 100         BPF_MAP_TYPE_UNSPEC,
 101         BPF_MAP_TYPE_HASH,
 102         BPF_MAP_TYPE_ARRAY,
 103         BPF_MAP_TYPE_PROG_ARRAY,
 104         BPF_MAP_TYPE_PERF_EVENT_ARRAY,
 105         BPF_MAP_TYPE_PERCPU_HASH,
 106         BPF_MAP_TYPE_PERCPU_ARRAY,
 107         BPF_MAP_TYPE_STACK_TRACE,
 108         BPF_MAP_TYPE_CGROUP_ARRAY,
 109         BPF_MAP_TYPE_LRU_HASH,
 110         BPF_MAP_TYPE_LRU_PERCPU_HASH,
 111         BPF_MAP_TYPE_LPM_TRIE,
 112         BPF_MAP_TYPE_ARRAY_OF_MAPS,
 113         BPF_MAP_TYPE_HASH_OF_MAPS,
 114         BPF_MAP_TYPE_DEVMAP,
 115         BPF_MAP_TYPE_SOCKMAP,
 116         BPF_MAP_TYPE_CPUMAP,
 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         BPF_PROG_TYPE_TRACEPOINT,
 126         BPF_PROG_TYPE_XDP,
 127         BPF_PROG_TYPE_PERF_EVENT,
 128         BPF_PROG_TYPE_CGROUP_SKB,
 129         BPF_PROG_TYPE_CGROUP_SOCK,
 130         BPF_PROG_TYPE_LWT_IN,
 131         BPF_PROG_TYPE_LWT_OUT,
 132         BPF_PROG_TYPE_LWT_XMIT,
 133         BPF_PROG_TYPE_SOCK_OPS,
 134         BPF_PROG_TYPE_SK_SKB,
 135 };
 136
 137 enum bpf_attach_type {
 138         BPF_CGROUP_INET_INGRESS,
 139         BPF_CGROUP_INET_EGRESS,
 140         BPF_CGROUP_INET_SOCK_CREATE,
 141         BPF_CGROUP_SOCK_OPS,
 142         BPF_SK_SKB_STREAM_PARSER,
 143         BPF_SK_SKB_STREAM_VERDICT,
 144         __MAX_BPF_ATTACH_TYPE
 145 };
 146
 147 #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
 148
 149 /* cgroup-bpf attach flags used in BPF_PROG_ATTACH command
 150  *
 151  * NONE(default): No further bpf programs allowed in the subtree.
 152  *
 153  * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program,
 154  * the program in this cgroup yields to sub-cgroup program.
 155  *
 156  * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program,
 157  * that cgroup program gets run in addition to the program in this cgroup.
 158  *
 159  * Only one program is allowed to be attached to a cgroup with
 160  * NONE or BPF_F_ALLOW_OVERRIDE flag.
 161  * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will
 162  * release old program and attach the new one. Attach flags has to match.
 163  *
 164  * Multiple programs are allowed to be attached to a cgroup with
 165  * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order
 166  * (those that were attached first, run first)
 167  * The programs of sub-cgroup are executed first, then programs of
 168  * this cgroup and then programs of parent cgroup.
 169  * When children program makes decision (like picking TCP CA or sock bind)
 170  * parent program has a chance to override it.
 171  *
 172  * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups.
 173  * A cgroup with NONE doesn't allow any programs in sub-cgroups.
 174  * Ex1:
 175  * cgrp1 (MULTI progs A, B) ->
 176  *    cgrp2 (OVERRIDE prog C) ->
 177  *      cgrp3 (MULTI prog D) ->
 178  *        cgrp4 (OVERRIDE prog E) ->
 179  *          cgrp5 (NONE prog F)
 180  * the event in cgrp5 triggers execution of F,D,A,B in that order.
 181  * if prog F is detached, the execution is E,D,A,B
 182  * if prog F and D are detached, the execution is E,A,B
 183  * if prog F, E and D are detached, the execution is C,A,B
 184  *
 185  * All eligible programs are executed regardless of return code from
 186  * earlier programs.
 187  */
 188 #define BPF_F_ALLOW_OVERRIDE    (1U << 0)
 189 #define BPF_F_ALLOW_MULTI       (1U << 1)
 190
 191 /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
 192  * verifier will perform strict alignment checking as if the kernel
 193  * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
 194  * and NET_IP_ALIGN defined to 2.
 195  */
 196 #define BPF_F_STRICT_ALIGNMENT  (1U << 0)
 197
 198 #define BPF_PSEUDO_MAP_FD       1
 199
 200 /* flags for BPF_MAP_UPDATE_ELEM command */
 201 #define BPF_ANY         0 /* create new element or update existing */
 202 #define BPF_NOEXIST     1 /* create new element if it didn't exist */
 203 #define BPF_EXIST       2 /* update existing element */
 204
 205 /* flags for BPF_MAP_CREATE command */
 206 #define BPF_F_NO_PREALLOC       (1U << 0)
 207 /* Instead of having one common LRU list in the
 208  * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
 209  * which can scale and perform better.
 210  * Note, the LRU nodes (including free nodes) cannot be moved
 211  * across different LRU lists.
 212  */
 213 #define BPF_F_NO_COMMON_LRU     (1U << 1)
 214 /* Specify numa node during map creation */
 215 #define BPF_F_NUMA_NODE         (1U << 2)
 216
 217 /* flags for BPF_PROG_QUERY */
 218 #define BPF_F_QUERY_EFFECTIVE   (1U << 0)
 219
 220 #define BPF_OBJ_NAME_LEN 16U
 221
 222 /* Flags for accessing BPF object */
 223 #define BPF_F_RDONLY            (1U << 3)
 224 #define BPF_F_WRONLY            (1U << 4)
 225
 226 union bpf_attr {
 227         struct { /* anonymous struct used by BPF_MAP_CREATE command */
 228                 __u32   map_type;       /* one of enum bpf_map_type */
 229                 __u32   key_size;       /* size of key in bytes */
 230                 __u32   value_size;     /* size of value in bytes */
 231                 __u32   max_entries;    /* max number of entries in a map */
 232                 __u32   map_flags;      /* BPF_MAP_CREATE related
 233                                          * flags defined above.
 234                                          */
 235                 __u32   inner_map_fd;   /* fd pointing to the inner map */
 236                 __u32   numa_node;      /* numa node (effective only if
 237                                          * BPF_F_NUMA_NODE is set).
 238                                          */
 239                 char    map_name[BPF_OBJ_NAME_LEN];
 240         };
 241
 242         struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
 243                 __u32           map_fd;
 244                 __aligned_u64   key;
 245                 union {
 246                         __aligned_u64 value;
 247                         __aligned_u64 next_key;
 248                 };
 249                 __u64           flags;
 250         };
 251
 252         struct { /* anonymous struct used by BPF_PROG_LOAD command */
 253                 __u32           prog_type;      /* one of enum bpf_prog_type */
 254                 __u32           insn_cnt;
 255                 __aligned_u64   insns;
 256                 __aligned_u64   license;
 257                 __u32           log_level;      /* verbosity level of verifier */
 258                 __u32           log_size;       /* size of user buffer */
 259                 __aligned_u64   log_buf;        /* user supplied buffer */
 260                 __u32           kern_version;   /* checked when prog_type=kprobe */
 261                 __u32           prog_flags;
 262                 char            prog_name[BPF_OBJ_NAME_LEN];
 263                 __u32           prog_target_ifindex;    /* ifindex of netdev to prep for */
 264         };
 265
 266         struct { /* anonymous struct used by BPF_OBJ_* commands */
 267                 __aligned_u64   pathname;
 268                 __u32           bpf_fd;
 269                 __u32           file_flags;
 270         };
 271
 272         struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
 273                 __u32           target_fd;      /* container object to attach to */
 274                 __u32           attach_bpf_fd;  /* eBPF program to attach */
 275                 __u32           attach_type;
 276                 __u32           attach_flags;
 277         };
 278
 279         struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
 280                 __u32           prog_fd;
 281                 __u32           retval;
 282                 __u32           data_size_in;
 283                 __u32           data_size_out;
 284                 __aligned_u64   data_in;
 285                 __aligned_u64   data_out;
 286                 __u32           repeat;
 287                 __u32           duration;
 288         } test;
 289
 290         struct { /* anonymous struct used by BPF_*_GET_*_ID */
 291                 union {
 292                         __u32           start_id;
 293                         __u32           prog_id;
 294                         __u32           map_id;
 295                 };
 296                 __u32           next_id;
 297                 __u32           open_flags;
 298         };
 299
 300         struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
 301                 __u32           bpf_fd;
 302                 __u32           info_len;
 303                 __aligned_u64   info;
 304         } info;
 305
 306         struct { /* anonymous struct used by BPF_PROG_QUERY command */
 307                 __u32           target_fd;      /* container object to query */
 308                 __u32           attach_type;
 309                 __u32           query_flags;
 310                 __u32           attach_flags;
 311                 __aligned_u64   prog_ids;
 312                 __u32           prog_cnt;
 313         } query;
 314 } __attribute__((aligned(8)));
 315
 316 /* BPF helper function descriptions:
 317  *
 318  * void *bpf_map_lookup_elem(&map, &key)
 319  *     Return: Map value or NULL
 320  *
 321  * int bpf_map_update_elem(&map, &key, &value, flags)
 322  *     Return: 0 on success or negative error
 323  *
 324  * int bpf_map_delete_elem(&map, &key)
 325  *     Return: 0 on success or negative error
 326  *
 327  * int bpf_probe_read(void *dst, int size, void *src)
 328  *     Return: 0 on success or negative error
 329  *
 330  * u64 bpf_ktime_get_ns(void)
 331  *     Return: current ktime
 332  *
 333  * int bpf_trace_printk(const char *fmt, int fmt_size, ...)
 334  *     Return: length of buffer written or negative error
 335  *
 336  * u32 bpf_prandom_u32(void)
 337  *     Return: random value
 338  *
 339  * u32 bpf_raw_smp_processor_id(void)
 340  *     Return: SMP processor ID
 341  *
 342  * int bpf_skb_store_bytes(skb, offset, from, len, flags)
 343  *     store bytes into packet
 344  *     @skb: pointer to skb
 345  *     @offset: offset within packet from skb->mac_header
 346  *     @from: pointer where to copy bytes from
 347  *     @len: number of bytes to store into packet
 348  *     @flags: bit 0 - if true, recompute skb->csum
 349  *             other bits - reserved
 350  *     Return: 0 on success or negative error
 351  *
 352  * int bpf_l3_csum_replace(skb, offset, from, to, flags)
 353  *     recompute IP checksum
 354  *     @skb: pointer to skb
 355  *     @offset: offset within packet where IP checksum is located
 356  *     @from: old value of header field
 357  *     @to: new value of header field
 358  *     @flags: bits 0-3 - size of header field
 359  *             other bits - reserved
 360  *     Return: 0 on success or negative error
 361  *
 362  * int bpf_l4_csum_replace(skb, offset, from, to, flags)
 363  *     recompute TCP/UDP checksum
 364  *     @skb: pointer to skb
 365  *     @offset: offset within packet where TCP/UDP checksum is located
 366  *     @from: old value of header field
 367  *     @to: new value of header field
 368  *     @flags: bits 0-3 - size of header field
 369  *             bit 4 - is pseudo header
 370  *             other bits - reserved
 371  *     Return: 0 on success or negative error
 372  *
 373  * int bpf_tail_call(ctx, prog_array_map, index)
 374  *     jump into another BPF program
 375  *     @ctx: context pointer passed to next program
 376  *     @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
 377  *     @index: 32-bit index inside array that selects specific program to run
 378  *     Return: 0 on success or negative error
 379  *
 380  * int bpf_clone_redirect(skb, ifindex, flags)
 381  *     redirect to another netdev
 382  *     @skb: pointer to skb
 383  *     @ifindex: ifindex of the net device
 384  *     @flags: bit 0 - if set, redirect to ingress instead of egress
 385  *             other bits - reserved
 386  *     Return: 0 on success or negative error
 387  *
 388  * u64 bpf_get_current_pid_tgid(void)
 389  *     Return: current->tgid << 32 | current->pid
 390  *
 391  * u64 bpf_get_current_uid_gid(void)
 392  *     Return: current_gid << 32 | current_uid
 393  *
 394  * int bpf_get_current_comm(char *buf, int size_of_buf)
 395  *     stores current->comm into buf
 396  *     Return: 0 on success or negative error
 397  *
 398  * u32 bpf_get_cgroup_classid(skb)
 399  *     retrieve a proc's classid
 400  *     @skb: pointer to skb
 401  *     Return: classid if != 0
 402  *
 403  * int bpf_skb_vlan_push(skb, vlan_proto, vlan_tci)
 404  *     Return: 0 on success or negative error
 405  *
 406  * int bpf_skb_vlan_pop(skb)
 407  *     Return: 0 on success or negative error
 408  *
 409  * int bpf_skb_get_tunnel_key(skb, key, size, flags)
 410  * int bpf_skb_set_tunnel_key(skb, key, size, flags)
 411  *     retrieve or populate tunnel metadata
 412  *     @skb: pointer to skb
 413  *     @key: pointer to 'struct bpf_tunnel_key'
 414  *     @size: size of 'struct bpf_tunnel_key'
 415  *     @flags: room for future extensions
 416  *     Return: 0 on success or negative error
 417  *
 418  * u64 bpf_perf_event_read(map, flags)
 419  *     read perf event counter value
 420  *     @map: pointer to perf_event_array map
 421  *     @flags: index of event in the map or bitmask flags
 422  *     Return: value of perf event counter read or error code
 423  *
 424  * int bpf_redirect(ifindex, flags)
 425  *     redirect to another netdev
 426  *     @ifindex: ifindex of the net device
 427  *     @flags:
 428  *        cls_bpf:
 429  *          bit 0 - if set, redirect to ingress instead of egress
 430  *          other bits - reserved
 431  *        xdp_bpf:
 432  *          all bits - reserved
 433  *     Return: cls_bpf: TC_ACT_REDIRECT on success or TC_ACT_SHOT on error
 434  *             xdp_bfp: XDP_REDIRECT on success or XDP_ABORT on error
 435  * int bpf_redirect_map(map, key, flags)
 436  *     redirect to endpoint in map
 437  *     @map: pointer to dev map
 438  *     @key: index in map to lookup
 439  *     @flags: --
 440  *     Return: XDP_REDIRECT on success or XDP_ABORT on error
 441  *
 442  * u32 bpf_get_route_realm(skb)
 443  *     retrieve a dst's tclassid
 444  *     @skb: pointer to skb
 445  *     Return: realm if != 0
 446  *
 447  * int bpf_perf_event_output(ctx, map, flags, data, size)
 448  *     output perf raw sample
 449  *     @ctx: struct pt_regs*
 450  *     @map: pointer to perf_event_array map
 451  *     @flags: index of event in the map or bitmask flags
 452  *     @data: data on stack to be output as raw data
 453  *     @size: size of data
 454  *     Return: 0 on success or negative error
 455  *
 456  * int bpf_get_stackid(ctx, map, flags)
 457  *     walk user or kernel stack and return id
 458  *     @ctx: struct pt_regs*
 459  *     @map: pointer to stack_trace map
 460  *     @flags: bits 0-7 - numer of stack frames to skip
 461  *             bit 8 - collect user stack instead of kernel
 462  *             bit 9 - compare stacks by hash only
 463  *             bit 10 - if two different stacks hash into the same stackid
 464  *                      discard old
 465  *             other bits - reserved
 466  *     Return: >= 0 stackid on success or negative error
 467  *
 468  * s64 bpf_csum_diff(from, from_size, to, to_size, seed)
 469  *     calculate csum diff
 470  *     @from: raw from buffer
 471  *     @from_size: length of from buffer
 472  *     @to: raw to buffer
 473  *     @to_size: length of to buffer
 474  *     @seed: optional seed
 475  *     Return: csum result or negative error code
 476  *
 477  * int bpf_skb_get_tunnel_opt(skb, opt, size)
 478  *     retrieve tunnel options metadata
 479  *     @skb: pointer to skb
 480  *     @opt: pointer to raw tunnel option data
 481  *     @size: size of @opt
 482  *     Return: option size
 483  *
 484  * int bpf_skb_set_tunnel_opt(skb, opt, size)
 485  *     populate tunnel options metadata
 486  *     @skb: pointer to skb
 487  *     @opt: pointer to raw tunnel option data
 488  *     @size: size of @opt
 489  *     Return: 0 on success or negative error
 490  *
 491  * int bpf_skb_change_proto(skb, proto, flags)
 492  *     Change protocol of the skb. Currently supported is v4 -> v6,
 493  *     v6 -> v4 transitions. The helper will also resize the skb. eBPF
 494  *     program is expected to fill the new headers via skb_store_bytes
 495  *     and lX_csum_replace.
 496  *     @skb: pointer to skb
 497  *     @proto: new skb->protocol type
 498  *     @flags: reserved
 499  *     Return: 0 on success or negative error
 500  *
 501  * int bpf_skb_change_type(skb, type)
 502  *     Change packet type of skb.
 503  *     @skb: pointer to skb
 504  *     @type: new skb->pkt_type type
 505  *     Return: 0 on success or negative error
 506  *
 507  * int bpf_skb_under_cgroup(skb, map, index)
 508  *     Check cgroup2 membership of skb
 509  *     @skb: pointer to skb
 510  *     @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
 511  *     @index: index of the cgroup in the bpf_map
 512  *     Return:
 513  *       == 0 skb failed the cgroup2 descendant test
 514  *       == 1 skb succeeded the cgroup2 descendant test
 515  *        < 0 error
 516  *
 517  * u32 bpf_get_hash_recalc(skb)
 518  *     Retrieve and possibly recalculate skb->hash.
 519  *     @skb: pointer to skb
 520  *     Return: hash
 521  *
 522  * u64 bpf_get_current_task(void)
 523  *     Returns current task_struct
 524  *     Return: current
 525  *
 526  * int bpf_probe_write_user(void *dst, void *src, int len)
 527  *     safely attempt to write to a location
 528  *     @dst: destination address in userspace
 529  *     @src: source address on stack
 530  *     @len: number of bytes to copy
 531  *     Return: 0 on success or negative error
 532  *
 533  * int bpf_current_task_under_cgroup(map, index)
 534  *     Check cgroup2 membership of current task
 535  *     @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
 536  *     @index: index of the cgroup in the bpf_map
 537  *     Return:
 538  *       == 0 current failed the cgroup2 descendant test
 539  *       == 1 current succeeded the cgroup2 descendant test
 540  *        < 0 error
 541  *
 542  * int bpf_skb_change_tail(skb, len, flags)
 543  *     The helper will resize the skb to the given new size, to be used f.e.
 544  *     with control messages.
 545  *     @skb: pointer to skb
 546  *     @len: new skb length
 547  *     @flags: reserved
 548  *     Return: 0 on success or negative error
 549  *
 550  * int bpf_skb_pull_data(skb, len)
 551  *     The helper will pull in non-linear data in case the skb is non-linear
 552  *     and not all of len are part of the linear section. Only needed for
 553  *     read/write with direct packet access.
 554  *     @skb: pointer to skb
 555  *     @len: len to make read/writeable
 556  *     Return: 0 on success or negative error
 557  *
 558  * s64 bpf_csum_update(skb, csum)
 559  *     Adds csum into skb->csum in case of CHECKSUM_COMPLETE.
 560  *     @skb: pointer to skb
 561  *     @csum: csum to add
 562  *     Return: csum on success or negative error
 563  *
 564  * void bpf_set_hash_invalid(skb)
 565  *     Invalidate current skb->hash.
 566  *     @skb: pointer to skb
 567  *
 568  * int bpf_get_numa_node_id()
 569  *     Return: Id of current NUMA node.
 570  *
 571  * int bpf_skb_change_head()
 572  *     Grows headroom of skb and adjusts MAC header offset accordingly.
 573  *     Will extends/reallocae as required automatically.
 574  *     May change skb data pointer and will thus invalidate any check
 575  *     performed for direct packet access.
 576  *     @skb: pointer to skb
 577  *     @len: length of header to be pushed in front
 578  *     @flags: Flags (unused for now)
 579  *     Return: 0 on success or negative error
 580  *
 581  * int bpf_xdp_adjust_head(xdp_md, delta)
 582  *     Adjust the xdp_md.data by delta
 583  *     @xdp_md: pointer to xdp_md
 584  *     @delta: An positive/negative integer to be added to xdp_md.data
 585  *     Return: 0 on success or negative on error
 586  *
 587  * int bpf_probe_read_str(void *dst, int size, const void *unsafe_ptr)
 588  *     Copy a NUL terminated string from unsafe address. In case the string
 589  *     length is smaller than size, the target is not padded with further NUL
 590  *     bytes. In case the string length is larger than size, just count-1
 591  *     bytes are copied and the last byte is set to NUL.
 592  *     @dst: destination address
 593  *     @size: maximum number of bytes to copy, including the trailing NUL
 594  *     @unsafe_ptr: unsafe address
 595  *     Return:
 596  *       > 0 length of the string including the trailing NUL on success
 597  *       < 0 error
 598  *
 599  * u64 bpf_get_socket_cookie(skb)
 600  *     Get the cookie for the socket stored inside sk_buff.
 601  *     @skb: pointer to skb
 602  *     Return: 8 Bytes non-decreasing number on success or 0 if the socket
 603  *     field is missing inside sk_buff
 604  *
 605  * u32 bpf_get_socket_uid(skb)
 606  *     Get the owner uid of the socket stored inside sk_buff.
 607  *     @skb: pointer to skb
 608  *     Return: uid of the socket owner on success or overflowuid if failed.
 609  *
 610  * u32 bpf_set_hash(skb, hash)
 611  *     Set full skb->hash.
 612  *     @skb: pointer to skb
 613  *     @hash: hash to set
 614  *
 615  * int bpf_setsockopt(bpf_socket, level, optname, optval, optlen)
 616  *     Calls setsockopt. Not all opts are available, only those with
 617  *     integer optvals plus TCP_CONGESTION.
 618  *     Supported levels: SOL_SOCKET and IPPROTO_TCP
 619  *     @bpf_socket: pointer to bpf_socket
 620  *     @level: SOL_SOCKET or IPPROTO_TCP
 621  *     @optname: option name
 622  *     @optval: pointer to option value
 623  *     @optlen: length of optval in bytes
 624  *     Return: 0 or negative error
 625  *
 626  * int bpf_getsockopt(bpf_socket, level, optname, optval, optlen)
 627  *     Calls getsockopt. Not all opts are available.
 628  *     Supported levels: IPPROTO_TCP
 629  *     @bpf_socket: pointer to bpf_socket
 630  *     @level: IPPROTO_TCP
 631  *     @optname: option name
 632  *     @optval: pointer to option value
 633  *     @optlen: length of optval in bytes
 634  *     Return: 0 or negative error
 635  *
 636  * int bpf_skb_adjust_room(skb, len_diff, mode, flags)
 637  *     Grow or shrink room in sk_buff.
 638  *     @skb: pointer to skb
 639  *     @len_diff: (signed) amount of room to grow/shrink
 640  *     @mode: operation mode (enum bpf_adj_room_mode)
 641  *     @flags: reserved for future use
 642  *     Return: 0 on success or negative error code
 643  *
 644  * int bpf_sk_redirect_map(map, key, flags)
 645  *     Redirect skb to a sock in map using key as a lookup key for the
 646  *     sock in map.
 647  *     @map: pointer to sockmap
 648  *     @key: key to lookup sock in map
 649  *     @flags: reserved for future use
 650  *     Return: SK_PASS
 651  *
 652  * int bpf_sock_map_update(skops, map, key, flags)
 653  *      @skops: pointer to bpf_sock_ops
 654  *      @map: pointer to sockmap to update
 655  *      @key: key to insert/update sock in map
 656  *      @flags: same flags as map update elem
 657  *
 658  * int bpf_xdp_adjust_meta(xdp_md, delta)
 659  *     Adjust the xdp_md.data_meta by delta
 660  *     @xdp_md: pointer to xdp_md
 661  *     @delta: An positive/negative integer to be added to xdp_md.data_meta
 662  *     Return: 0 on success or negative on error
 663  *
 664  * int bpf_perf_event_read_value(map, flags, buf, buf_size)
 665  *     read perf event counter value and perf event enabled/running time
 666  *     @map: pointer to perf_event_array map
 667  *     @flags: index of event in the map or bitmask flags
 668  *     @buf: buf to fill
 669  *     @buf_size: size of the buf
 670  *     Return: 0 on success or negative error code
 671  *
 672  * int bpf_perf_prog_read_value(ctx, buf, buf_size)
 673  *     read perf prog attached perf event counter and enabled/running time
 674  *     @ctx: pointer to ctx
 675  *     @buf: buf to fill
 676  *     @buf_size: size of the buf
 677  *     Return : 0 on success or negative error code
 678  */
 679 #define __BPF_FUNC_MAPPER(FN)           \
 680         FN(unspec),                     \
 681         FN(map_lookup_elem),            \
 682         FN(map_update_elem),            \
 683         FN(map_delete_elem),            \
 684         FN(probe_read),                 \
 685         FN(ktime_get_ns),               \
 686         FN(trace_printk),               \
 687         FN(get_prandom_u32),            \
 688         FN(get_smp_processor_id),       \
 689         FN(skb_store_bytes),            \
 690         FN(l3_csum_replace),            \
 691         FN(l4_csum_replace),            \
 692         FN(tail_call),                  \
 693         FN(clone_redirect),             \
 694         FN(get_current_pid_tgid),       \
 695         FN(get_current_uid_gid),        \
 696         FN(get_current_comm),           \
 697         FN(get_cgroup_classid),         \
 698         FN(skb_vlan_push),              \
 699         FN(skb_vlan_pop),               \
 700         FN(skb_get_tunnel_key),         \
 701         FN(skb_set_tunnel_key),         \
 702         FN(perf_event_read),            \
 703         FN(redirect),                   \
 704         FN(get_route_realm),            \
 705         FN(perf_event_output),          \
 706         FN(skb_load_bytes),             \
 707         FN(get_stackid),                \
 708         FN(csum_diff),                  \
 709         FN(skb_get_tunnel_opt),         \
 710         FN(skb_set_tunnel_opt),         \
 711         FN(skb_change_proto),           \
 712         FN(skb_change_type),            \
 713         FN(skb_under_cgroup),           \
 714         FN(get_hash_recalc),            \
 715         FN(get_current_task),           \
 716         FN(probe_write_user),           \
 717         FN(current_task_under_cgroup),  \
 718         FN(skb_change_tail),            \
 719         FN(skb_pull_data),              \
 720         FN(csum_update),                \
 721         FN(set_hash_invalid),           \
 722         FN(get_numa_node_id),           \
 723         FN(skb_change_head),            \
 724         FN(xdp_adjust_head),            \
 725         FN(probe_read_str),             \
 726         FN(get_socket_cookie),          \
 727         FN(get_socket_uid),             \
 728         FN(set_hash),                   \
 729         FN(setsockopt),                 \
 730         FN(skb_adjust_room),            \
 731         FN(redirect_map),               \
 732         FN(sk_redirect_map),            \
 733         FN(sock_map_update),            \
 734         FN(xdp_adjust_meta),            \
 735         FN(perf_event_read_value),      \
 736         FN(perf_prog_read_value),       \
 737         FN(getsockopt),
 738
 739 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
 740  * function eBPF program intends to call
 741  */
 742 #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
 743 enum bpf_func_id {
 744         __BPF_FUNC_MAPPER(__BPF_ENUM_FN)
 745         __BPF_FUNC_MAX_ID,
 746 };
 747 #undef __BPF_ENUM_FN
 748
 749 /* All flags used by eBPF helper functions, placed here. */
 750
 751 /* BPF_FUNC_skb_store_bytes flags. */
 752 #define BPF_F_RECOMPUTE_CSUM            (1ULL << 0)
 753 #define BPF_F_INVALIDATE_HASH           (1ULL << 1)
 754
 755 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
 756  * First 4 bits are for passing the header field size.
 757  */
 758 #define BPF_F_HDR_FIELD_MASK            0xfULL
 759
 760 /* BPF_FUNC_l4_csum_replace flags. */
 761 #define BPF_F_PSEUDO_HDR                (1ULL << 4)
 762 #define BPF_F_MARK_MANGLED_0            (1ULL << 5)
 763 #define BPF_F_MARK_ENFORCE              (1ULL << 6)
 764
 765 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
 766 #define BPF_F_INGRESS                   (1ULL << 0)
 767
 768 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
 769 #define BPF_F_TUNINFO_IPV6              (1ULL << 0)
 770
 771 /* BPF_FUNC_get_stackid flags. */
 772 #define BPF_F_SKIP_FIELD_MASK           0xffULL
 773 #define BPF_F_USER_STACK                (1ULL << 8)
 774 #define BPF_F_FAST_STACK_CMP            (1ULL << 9)
 775 #define BPF_F_REUSE_STACKID             (1ULL << 10)
 776
 777 /* BPF_FUNC_skb_set_tunnel_key flags. */
 778 #define BPF_F_ZERO_CSUM_TX              (1ULL << 1)
 779 #define BPF_F_DONT_FRAGMENT             (1ULL << 2)
 780
 781 /* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and
 782  * BPF_FUNC_perf_event_read_value flags.
 783  */
 784 #define BPF_F_INDEX_MASK                0xffffffffULL
 785 #define BPF_F_CURRENT_CPU               BPF_F_INDEX_MASK
 786 /* BPF_FUNC_perf_event_output for sk_buff input context. */
 787 #define BPF_F_CTXLEN_MASK               (0xfffffULL << 32)
 788
 789 /* Mode for BPF_FUNC_skb_adjust_room helper. */
 790 enum bpf_adj_room_mode {
 791         BPF_ADJ_ROOM_NET,
 792 };
 793
 794 /* user accessible mirror of in-kernel sk_buff.
 795  * new fields can only be added to the end of this structure
 796  */
 797 struct __sk_buff {
 798         __u32 len;
 799         __u32 pkt_type;
 800         __u32 mark;
 801         __u32 queue_mapping;
 802         __u32 protocol;
 803         __u32 vlan_present;
 804         __u32 vlan_tci;
 805         __u32 vlan_proto;
 806         __u32 priority;
 807         __u32 ingress_ifindex;
 808         __u32 ifindex;
 809         __u32 tc_index;
 810         __u32 cb[5];
 811         __u32 hash;
 812         __u32 tc_classid;
 813         __u32 data;
 814         __u32 data_end;
 815         __u32 napi_id;
 816
 817         /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */
 818         __u32 family;
 819         __u32 remote_ip4;       /* Stored in network byte order */
 820         __u32 local_ip4;        /* Stored in network byte order */
 821         __u32 remote_ip6[4];    /* Stored in network byte order */
 822         __u32 local_ip6[4];     /* Stored in network byte order */
 823         __u32 remote_port;      /* Stored in network byte order */
 824         __u32 local_port;       /* stored in host byte order */
 825         /* ... here. */
 826
 827         __u32 data_meta;
 828 };
 829
 830 struct bpf_tunnel_key {
 831         __u32 tunnel_id;
 832         union {
 833                 __u32 remote_ipv4;
 834                 __u32 remote_ipv6[4];
 835         };
 836         __u8 tunnel_tos;
 837         __u8 tunnel_ttl;
 838         __u16 tunnel_ext;
 839         __u32 tunnel_label;
 840 };
 841
 842 /* Generic BPF return codes which all BPF program types may support.
 843  * The values are binary compatible with their TC_ACT_* counter-part to
 844  * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
 845  * programs.
 846  *
 847  * XDP is handled seprately, see XDP_*.
 848  */
 849 enum bpf_ret_code {
 850         BPF_OK = 0,
 851         /* 1 reserved */
 852         BPF_DROP = 2,
 853         /* 3-6 reserved */
 854         BPF_REDIRECT = 7,
 855         /* >127 are reserved for prog type specific return codes */
 856 };
 857
 858 struct bpf_sock {
 859         __u32 bound_dev_if;
 860         __u32 family;
 861         __u32 type;
 862         __u32 protocol;
 863         __u32 mark;
 864         __u32 priority;
 865 };
 866
 867 #define XDP_PACKET_HEADROOM 256
 868
 869 /* User return codes for XDP prog type.
 870  * A valid XDP program must return one of these defined values. All other
 871  * return codes are reserved for future use. Unknown return codes will
 872  * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
 873  */
 874 enum xdp_action {
 875         XDP_ABORTED = 0,
 876         XDP_DROP,
 877         XDP_PASS,
 878         XDP_TX,
 879         XDP_REDIRECT,
 880 };
 881
 882 /* user accessible metadata for XDP packet hook
 883  * new fields must be added to the end of this structure
 884  */
 885 struct xdp_md {
 886         __u32 data;
 887         __u32 data_end;
 888         __u32 data_meta;
 889 };
 890
 891 enum sk_action {
 892         SK_DROP = 0,
 893         SK_PASS,
 894 };
 895
 896 #define BPF_TAG_SIZE    8
 897
 898 enum bpf_prog_status {
 899         BPF_PROG_STATUS_DEV_BOUND       = (1 << 0),
 900 };
 901
 902 struct bpf_prog_info {
 903         __u32 type;
 904         __u32 id;
 905         __u8  tag[BPF_TAG_SIZE];
 906         __u32 jited_prog_len;
 907         __u32 xlated_prog_len;
 908         __aligned_u64 jited_prog_insns;
 909         __aligned_u64 xlated_prog_insns;
 910         __u64 load_time;        /* ns since boottime */
 911         __u32 created_by_uid;
 912         __u32 nr_map_ids;
 913         __aligned_u64 map_ids;
 914         char name[BPF_OBJ_NAME_LEN];
 915         __u32 ifindex;
 916         __u32 status;
 917 } __attribute__((aligned(8)));
 918
 919 struct bpf_map_info {
 920         __u32 type;
 921         __u32 id;
 922         __u32 key_size;
 923         __u32 value_size;
 924         __u32 max_entries;
 925         __u32 map_flags;
 926         char  name[BPF_OBJ_NAME_LEN];
 927 } __attribute__((aligned(8)));
 928
 929 /* User bpf_sock_ops struct to access socket values and specify request ops
 930  * and their replies.
 931  * Some of this fields are in network (bigendian) byte order and may need
 932  * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
 933  * New fields can only be added at the end of this structure
 934  */
 935 struct bpf_sock_ops {
 936         __u32 op;
 937         union {
 938                 __u32 reply;
 939                 __u32 replylong[4];
 940         };
 941         __u32 family;
 942         __u32 remote_ip4;       /* Stored in network byte order */
 943         __u32 local_ip4;        /* Stored in network byte order */
 944         __u32 remote_ip6[4];    /* Stored in network byte order */
 945         __u32 local_ip6[4];     /* Stored in network byte order */
 946         __u32 remote_port;      /* Stored in network byte order */
 947         __u32 local_port;       /* stored in host byte order */
 948 };
 949
 950 /* List of known BPF sock_ops operators.
 951  * New entries can only be added at the end
 952  */
 953 enum {
 954         BPF_SOCK_OPS_VOID,
 955         BPF_SOCK_OPS_TIMEOUT_INIT,      /* Should return SYN-RTO value to use or
 956                                          * -1 if default value should be used
 957                                          */
 958         BPF_SOCK_OPS_RWND_INIT,         /* Should return initial advertized
 959                                          * window (in packets) or -1 if default
 960                                          * value should be used
 961                                          */
 962         BPF_SOCK_OPS_TCP_CONNECT_CB,    /* Calls BPF program right before an
 963                                          * active connection is initialized
 964                                          */
 965         BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB,     /* Calls BPF program when an
 966                                                  * active connection is
 967                                                  * established
 968                                                  */
 969         BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB,    /* Calls BPF program when a
 970                                                  * passive connection is
 971                                                  * established
 972                                                  */
 973         BPF_SOCK_OPS_NEEDS_ECN,         /* If connection's congestion control
 974                                          * needs ECN
 975                                          */
 976         BPF_SOCK_OPS_BASE_RTT,          /* Get base RTT. The correct value is
 977                                          * based on the path and may be
 978                                          * dependent on the congestion control
 979                                          * algorithm. In general it indicates
 980                                          * a congestion threshold. RTTs above
 981                                          * this indicate congestion
 982                                          */
 983 };
 984
 985 #define TCP_BPF_IW              1001    /* Set TCP initial congestion window */
 986 #define TCP_BPF_SNDCWND_CLAMP   1002    /* Set sndcwnd_clamp */
 987
 988 struct bpf_perf_event_value {
 989         __u64 counter;
 990         __u64 enabled;
 991         __u64 running;
 992 };
 993
 994 #endif /* _UAPI__LINUX_BPF_H__ */