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