1*858ea5e5SAndroid Build Coastguard Worker /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2*858ea5e5SAndroid Build Coastguard Worker /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com 3*858ea5e5SAndroid Build Coastguard Worker * 4*858ea5e5SAndroid Build Coastguard Worker * This program is free software; you can redistribute it and/or 5*858ea5e5SAndroid Build Coastguard Worker * modify it under the terms of version 2 of the GNU General Public 6*858ea5e5SAndroid Build Coastguard Worker * License as published by the Free Software Foundation. 7*858ea5e5SAndroid Build Coastguard Worker */ 8*858ea5e5SAndroid Build Coastguard Worker #ifndef _UAPI__LINUX_BPF_H__ 9*858ea5e5SAndroid Build Coastguard Worker #define _UAPI__LINUX_BPF_H__ 10*858ea5e5SAndroid Build Coastguard Worker 11*858ea5e5SAndroid Build Coastguard Worker #include <linux/types.h> 12*858ea5e5SAndroid Build Coastguard Worker #include <linux/bpf_common.h> 13*858ea5e5SAndroid Build Coastguard Worker 14*858ea5e5SAndroid Build Coastguard Worker /* Extended instruction set based on top of classic BPF */ 15*858ea5e5SAndroid Build Coastguard Worker 16*858ea5e5SAndroid Build Coastguard Worker /* instruction classes */ 17*858ea5e5SAndroid Build Coastguard Worker #define BPF_JMP32 0x06 /* jmp mode in word width */ 18*858ea5e5SAndroid Build Coastguard Worker #define BPF_ALU64 0x07 /* alu mode in double word width */ 19*858ea5e5SAndroid Build Coastguard Worker 20*858ea5e5SAndroid Build Coastguard Worker /* ld/ldx fields */ 21*858ea5e5SAndroid Build Coastguard Worker #define BPF_DW 0x18 /* double word (64-bit) */ 22*858ea5e5SAndroid Build Coastguard Worker #define BPF_MEMSX 0x80 /* load with sign extension */ 23*858ea5e5SAndroid Build Coastguard Worker #define BPF_ATOMIC 0xc0 /* atomic memory ops - op type in immediate */ 24*858ea5e5SAndroid Build Coastguard Worker #define BPF_XADD 0xc0 /* exclusive add - legacy name */ 25*858ea5e5SAndroid Build Coastguard Worker 26*858ea5e5SAndroid Build Coastguard Worker /* alu/jmp fields */ 27*858ea5e5SAndroid Build Coastguard Worker #define BPF_MOV 0xb0 /* mov reg to reg */ 28*858ea5e5SAndroid Build Coastguard Worker #define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */ 29*858ea5e5SAndroid Build Coastguard Worker 30*858ea5e5SAndroid Build Coastguard Worker /* change endianness of a register */ 31*858ea5e5SAndroid Build Coastguard Worker #define BPF_END 0xd0 /* flags for endianness conversion: */ 32*858ea5e5SAndroid Build Coastguard Worker #define BPF_TO_LE 0x00 /* convert to little-endian */ 33*858ea5e5SAndroid Build Coastguard Worker #define BPF_TO_BE 0x08 /* convert to big-endian */ 34*858ea5e5SAndroid Build Coastguard Worker #define BPF_FROM_LE BPF_TO_LE 35*858ea5e5SAndroid Build Coastguard Worker #define BPF_FROM_BE BPF_TO_BE 36*858ea5e5SAndroid Build Coastguard Worker 37*858ea5e5SAndroid Build Coastguard Worker /* jmp encodings */ 38*858ea5e5SAndroid Build Coastguard Worker #define BPF_JNE 0x50 /* jump != */ 39*858ea5e5SAndroid Build Coastguard Worker #define BPF_JLT 0xa0 /* LT is unsigned, '<' */ 40*858ea5e5SAndroid Build Coastguard Worker #define BPF_JLE 0xb0 /* LE is unsigned, '<=' */ 41*858ea5e5SAndroid Build Coastguard Worker #define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */ 42*858ea5e5SAndroid Build Coastguard Worker #define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */ 43*858ea5e5SAndroid Build Coastguard Worker #define BPF_JSLT 0xc0 /* SLT is signed, '<' */ 44*858ea5e5SAndroid Build Coastguard Worker #define BPF_JSLE 0xd0 /* SLE is signed, '<=' */ 45*858ea5e5SAndroid Build Coastguard Worker #define BPF_JCOND 0xe0 /* conditional pseudo jumps: may_goto, goto_or_nop */ 46*858ea5e5SAndroid Build Coastguard Worker #define BPF_CALL 0x80 /* function call */ 47*858ea5e5SAndroid Build Coastguard Worker #define BPF_EXIT 0x90 /* function return */ 48*858ea5e5SAndroid Build Coastguard Worker 49*858ea5e5SAndroid Build Coastguard Worker /* atomic op type fields (stored in immediate) */ 50*858ea5e5SAndroid Build Coastguard Worker #define BPF_FETCH 0x01 /* not an opcode on its own, used to build others */ 51*858ea5e5SAndroid Build Coastguard Worker #define BPF_XCHG (0xe0 | BPF_FETCH) /* atomic exchange */ 52*858ea5e5SAndroid Build Coastguard Worker #define BPF_CMPXCHG (0xf0 | BPF_FETCH) /* atomic compare-and-write */ 53*858ea5e5SAndroid Build Coastguard Worker 54*858ea5e5SAndroid Build Coastguard Worker enum bpf_cond_pseudo_jmp { 55*858ea5e5SAndroid Build Coastguard Worker BPF_MAY_GOTO = 0, 56*858ea5e5SAndroid Build Coastguard Worker }; 57*858ea5e5SAndroid Build Coastguard Worker 58*858ea5e5SAndroid Build Coastguard Worker /* Register numbers */ 59*858ea5e5SAndroid Build Coastguard Worker enum { 60*858ea5e5SAndroid Build Coastguard Worker BPF_REG_0 = 0, 61*858ea5e5SAndroid Build Coastguard Worker BPF_REG_1, 62*858ea5e5SAndroid Build Coastguard Worker BPF_REG_2, 63*858ea5e5SAndroid Build Coastguard Worker BPF_REG_3, 64*858ea5e5SAndroid Build Coastguard Worker BPF_REG_4, 65*858ea5e5SAndroid Build Coastguard Worker BPF_REG_5, 66*858ea5e5SAndroid Build Coastguard Worker BPF_REG_6, 67*858ea5e5SAndroid Build Coastguard Worker BPF_REG_7, 68*858ea5e5SAndroid Build Coastguard Worker BPF_REG_8, 69*858ea5e5SAndroid Build Coastguard Worker BPF_REG_9, 70*858ea5e5SAndroid Build Coastguard Worker BPF_REG_10, 71*858ea5e5SAndroid Build Coastguard Worker __MAX_BPF_REG, 72*858ea5e5SAndroid Build Coastguard Worker }; 73*858ea5e5SAndroid Build Coastguard Worker 74*858ea5e5SAndroid Build Coastguard Worker /* BPF has 10 general purpose 64-bit registers and stack frame. */ 75*858ea5e5SAndroid Build Coastguard Worker #define MAX_BPF_REG __MAX_BPF_REG 76*858ea5e5SAndroid Build Coastguard Worker 77*858ea5e5SAndroid Build Coastguard Worker struct bpf_insn { 78*858ea5e5SAndroid Build Coastguard Worker __u8 code; /* opcode */ 79*858ea5e5SAndroid Build Coastguard Worker __u8 dst_reg:4; /* dest register */ 80*858ea5e5SAndroid Build Coastguard Worker __u8 src_reg:4; /* source register */ 81*858ea5e5SAndroid Build Coastguard Worker __s16 off; /* signed offset */ 82*858ea5e5SAndroid Build Coastguard Worker __s32 imm; /* signed immediate constant */ 83*858ea5e5SAndroid Build Coastguard Worker }; 84*858ea5e5SAndroid Build Coastguard Worker 85*858ea5e5SAndroid Build Coastguard Worker /* Deprecated: use struct bpf_lpm_trie_key_u8 (when the "data" member is needed for 86*858ea5e5SAndroid Build Coastguard Worker * byte access) or struct bpf_lpm_trie_key_hdr (when using an alternative type for 87*858ea5e5SAndroid Build Coastguard Worker * the trailing flexible array member) instead. 88*858ea5e5SAndroid Build Coastguard Worker */ 89*858ea5e5SAndroid Build Coastguard Worker struct bpf_lpm_trie_key { 90*858ea5e5SAndroid Build Coastguard Worker __u32 prefixlen; /* up to 32 for AF_INET, 128 for AF_INET6 */ 91*858ea5e5SAndroid Build Coastguard Worker __u8 data[0]; /* Arbitrary size */ 92*858ea5e5SAndroid Build Coastguard Worker }; 93*858ea5e5SAndroid Build Coastguard Worker 94*858ea5e5SAndroid Build Coastguard Worker /* Header for bpf_lpm_trie_key structs */ 95*858ea5e5SAndroid Build Coastguard Worker struct bpf_lpm_trie_key_hdr { 96*858ea5e5SAndroid Build Coastguard Worker __u32 prefixlen; 97*858ea5e5SAndroid Build Coastguard Worker }; 98*858ea5e5SAndroid Build Coastguard Worker 99*858ea5e5SAndroid Build Coastguard Worker /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry, with trailing byte array. */ 100*858ea5e5SAndroid Build Coastguard Worker struct bpf_lpm_trie_key_u8 { 101*858ea5e5SAndroid Build Coastguard Worker union { 102*858ea5e5SAndroid Build Coastguard Worker struct bpf_lpm_trie_key_hdr hdr; 103*858ea5e5SAndroid Build Coastguard Worker __u32 prefixlen; 104*858ea5e5SAndroid Build Coastguard Worker }; 105*858ea5e5SAndroid Build Coastguard Worker __u8 data[]; /* Arbitrary size */ 106*858ea5e5SAndroid Build Coastguard Worker }; 107*858ea5e5SAndroid Build Coastguard Worker 108*858ea5e5SAndroid Build Coastguard Worker struct bpf_cgroup_storage_key { 109*858ea5e5SAndroid Build Coastguard Worker __u64 cgroup_inode_id; /* cgroup inode id */ 110*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; /* program attach type (enum bpf_attach_type) */ 111*858ea5e5SAndroid Build Coastguard Worker }; 112*858ea5e5SAndroid Build Coastguard Worker 113*858ea5e5SAndroid Build Coastguard Worker enum bpf_cgroup_iter_order { 114*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_ITER_ORDER_UNSPEC = 0, 115*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_ITER_SELF_ONLY, /* process only a single object. */ 116*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_ITER_DESCENDANTS_PRE, /* walk descendants in pre-order. */ 117*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_ITER_DESCENDANTS_POST, /* walk descendants in post-order. */ 118*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_ITER_ANCESTORS_UP, /* walk ancestors upward. */ 119*858ea5e5SAndroid Build Coastguard Worker }; 120*858ea5e5SAndroid Build Coastguard Worker 121*858ea5e5SAndroid Build Coastguard Worker union bpf_iter_link_info { 122*858ea5e5SAndroid Build Coastguard Worker struct { 123*858ea5e5SAndroid Build Coastguard Worker __u32 map_fd; 124*858ea5e5SAndroid Build Coastguard Worker } map; 125*858ea5e5SAndroid Build Coastguard Worker struct { 126*858ea5e5SAndroid Build Coastguard Worker enum bpf_cgroup_iter_order order; 127*858ea5e5SAndroid Build Coastguard Worker 128*858ea5e5SAndroid Build Coastguard Worker /* At most one of cgroup_fd and cgroup_id can be non-zero. If 129*858ea5e5SAndroid Build Coastguard Worker * both are zero, the walk starts from the default cgroup v2 130*858ea5e5SAndroid Build Coastguard Worker * root. For walking v1 hierarchy, one should always explicitly 131*858ea5e5SAndroid Build Coastguard Worker * specify cgroup_fd. 132*858ea5e5SAndroid Build Coastguard Worker */ 133*858ea5e5SAndroid Build Coastguard Worker __u32 cgroup_fd; 134*858ea5e5SAndroid Build Coastguard Worker __u64 cgroup_id; 135*858ea5e5SAndroid Build Coastguard Worker } cgroup; 136*858ea5e5SAndroid Build Coastguard Worker /* Parameters of task iterators. */ 137*858ea5e5SAndroid Build Coastguard Worker struct { 138*858ea5e5SAndroid Build Coastguard Worker __u32 tid; 139*858ea5e5SAndroid Build Coastguard Worker __u32 pid; 140*858ea5e5SAndroid Build Coastguard Worker __u32 pid_fd; 141*858ea5e5SAndroid Build Coastguard Worker } task; 142*858ea5e5SAndroid Build Coastguard Worker }; 143*858ea5e5SAndroid Build Coastguard Worker 144*858ea5e5SAndroid Build Coastguard Worker /* BPF syscall commands, see bpf(2) man-page for more details. */ 145*858ea5e5SAndroid Build Coastguard Worker /** 146*858ea5e5SAndroid Build Coastguard Worker * DOC: eBPF Syscall Preamble 147*858ea5e5SAndroid Build Coastguard Worker * 148*858ea5e5SAndroid Build Coastguard Worker * The operation to be performed by the **bpf**\ () system call is determined 149*858ea5e5SAndroid Build Coastguard Worker * by the *cmd* argument. Each operation takes an accompanying argument, 150*858ea5e5SAndroid Build Coastguard Worker * provided via *attr*, which is a pointer to a union of type *bpf_attr* (see 151*858ea5e5SAndroid Build Coastguard Worker * below). The size argument is the size of the union pointed to by *attr*. 152*858ea5e5SAndroid Build Coastguard Worker */ 153*858ea5e5SAndroid Build Coastguard Worker /** 154*858ea5e5SAndroid Build Coastguard Worker * DOC: eBPF Syscall Commands 155*858ea5e5SAndroid Build Coastguard Worker * 156*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_CREATE 157*858ea5e5SAndroid Build Coastguard Worker * Description 158*858ea5e5SAndroid Build Coastguard Worker * Create a map and return a file descriptor that refers to the 159*858ea5e5SAndroid Build Coastguard Worker * map. The close-on-exec file descriptor flag (see **fcntl**\ (2)) 160*858ea5e5SAndroid Build Coastguard Worker * is automatically enabled for the new file descriptor. 161*858ea5e5SAndroid Build Coastguard Worker * 162*858ea5e5SAndroid Build Coastguard Worker * Applying **close**\ (2) to the file descriptor returned by 163*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_CREATE** will delete the map (but see NOTES). 164*858ea5e5SAndroid Build Coastguard Worker * 165*858ea5e5SAndroid Build Coastguard Worker * Return 166*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 167*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 168*858ea5e5SAndroid Build Coastguard Worker * 169*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_LOOKUP_ELEM 170*858ea5e5SAndroid Build Coastguard Worker * Description 171*858ea5e5SAndroid Build Coastguard Worker * Look up an element with a given *key* in the map referred to 172*858ea5e5SAndroid Build Coastguard Worker * by the file descriptor *map_fd*. 173*858ea5e5SAndroid Build Coastguard Worker * 174*858ea5e5SAndroid Build Coastguard Worker * The *flags* argument may be specified as one of the 175*858ea5e5SAndroid Build Coastguard Worker * following: 176*858ea5e5SAndroid Build Coastguard Worker * 177*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_LOCK** 178*858ea5e5SAndroid Build Coastguard Worker * Look up the value of a spin-locked map without 179*858ea5e5SAndroid Build Coastguard Worker * returning the lock. This must be specified if the 180*858ea5e5SAndroid Build Coastguard Worker * elements contain a spinlock. 181*858ea5e5SAndroid Build Coastguard Worker * 182*858ea5e5SAndroid Build Coastguard Worker * Return 183*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 184*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 185*858ea5e5SAndroid Build Coastguard Worker * 186*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_UPDATE_ELEM 187*858ea5e5SAndroid Build Coastguard Worker * Description 188*858ea5e5SAndroid Build Coastguard Worker * Create or update an element (key/value pair) in a specified map. 189*858ea5e5SAndroid Build Coastguard Worker * 190*858ea5e5SAndroid Build Coastguard Worker * The *flags* argument should be specified as one of the 191*858ea5e5SAndroid Build Coastguard Worker * following: 192*858ea5e5SAndroid Build Coastguard Worker * 193*858ea5e5SAndroid Build Coastguard Worker * **BPF_ANY** 194*858ea5e5SAndroid Build Coastguard Worker * Create a new element or update an existing element. 195*858ea5e5SAndroid Build Coastguard Worker * **BPF_NOEXIST** 196*858ea5e5SAndroid Build Coastguard Worker * Create a new element only if it did not exist. 197*858ea5e5SAndroid Build Coastguard Worker * **BPF_EXIST** 198*858ea5e5SAndroid Build Coastguard Worker * Update an existing element. 199*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_LOCK** 200*858ea5e5SAndroid Build Coastguard Worker * Update a spin_lock-ed map element. 201*858ea5e5SAndroid Build Coastguard Worker * 202*858ea5e5SAndroid Build Coastguard Worker * Return 203*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 204*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 205*858ea5e5SAndroid Build Coastguard Worker * 206*858ea5e5SAndroid Build Coastguard Worker * May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**, 207*858ea5e5SAndroid Build Coastguard Worker * **E2BIG**, **EEXIST**, or **ENOENT**. 208*858ea5e5SAndroid Build Coastguard Worker * 209*858ea5e5SAndroid Build Coastguard Worker * **E2BIG** 210*858ea5e5SAndroid Build Coastguard Worker * The number of elements in the map reached the 211*858ea5e5SAndroid Build Coastguard Worker * *max_entries* limit specified at map creation time. 212*858ea5e5SAndroid Build Coastguard Worker * **EEXIST** 213*858ea5e5SAndroid Build Coastguard Worker * If *flags* specifies **BPF_NOEXIST** and the element 214*858ea5e5SAndroid Build Coastguard Worker * with *key* already exists in the map. 215*858ea5e5SAndroid Build Coastguard Worker * **ENOENT** 216*858ea5e5SAndroid Build Coastguard Worker * If *flags* specifies **BPF_EXIST** and the element with 217*858ea5e5SAndroid Build Coastguard Worker * *key* does not exist in the map. 218*858ea5e5SAndroid Build Coastguard Worker * 219*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_DELETE_ELEM 220*858ea5e5SAndroid Build Coastguard Worker * Description 221*858ea5e5SAndroid Build Coastguard Worker * Look up and delete an element by key in a specified map. 222*858ea5e5SAndroid Build Coastguard Worker * 223*858ea5e5SAndroid Build Coastguard Worker * Return 224*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 225*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 226*858ea5e5SAndroid Build Coastguard Worker * 227*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_GET_NEXT_KEY 228*858ea5e5SAndroid Build Coastguard Worker * Description 229*858ea5e5SAndroid Build Coastguard Worker * Look up an element by key in a specified map and return the key 230*858ea5e5SAndroid Build Coastguard Worker * of the next element. Can be used to iterate over all elements 231*858ea5e5SAndroid Build Coastguard Worker * in the map. 232*858ea5e5SAndroid Build Coastguard Worker * 233*858ea5e5SAndroid Build Coastguard Worker * Return 234*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 235*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 236*858ea5e5SAndroid Build Coastguard Worker * 237*858ea5e5SAndroid Build Coastguard Worker * The following cases can be used to iterate over all elements of 238*858ea5e5SAndroid Build Coastguard Worker * the map: 239*858ea5e5SAndroid Build Coastguard Worker * 240*858ea5e5SAndroid Build Coastguard Worker * * If *key* is not found, the operation returns zero and sets 241*858ea5e5SAndroid Build Coastguard Worker * the *next_key* pointer to the key of the first element. 242*858ea5e5SAndroid Build Coastguard Worker * * If *key* is found, the operation returns zero and sets the 243*858ea5e5SAndroid Build Coastguard Worker * *next_key* pointer to the key of the next element. 244*858ea5e5SAndroid Build Coastguard Worker * * If *key* is the last element, returns -1 and *errno* is set 245*858ea5e5SAndroid Build Coastguard Worker * to **ENOENT**. 246*858ea5e5SAndroid Build Coastguard Worker * 247*858ea5e5SAndroid Build Coastguard Worker * May set *errno* to **ENOMEM**, **EFAULT**, **EPERM**, or 248*858ea5e5SAndroid Build Coastguard Worker * **EINVAL** on error. 249*858ea5e5SAndroid Build Coastguard Worker * 250*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_LOAD 251*858ea5e5SAndroid Build Coastguard Worker * Description 252*858ea5e5SAndroid Build Coastguard Worker * Verify and load an eBPF program, returning a new file 253*858ea5e5SAndroid Build Coastguard Worker * descriptor associated with the program. 254*858ea5e5SAndroid Build Coastguard Worker * 255*858ea5e5SAndroid Build Coastguard Worker * Applying **close**\ (2) to the file descriptor returned by 256*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_LOAD** will unload the eBPF program (but see NOTES). 257*858ea5e5SAndroid Build Coastguard Worker * 258*858ea5e5SAndroid Build Coastguard Worker * The close-on-exec file descriptor flag (see **fcntl**\ (2)) is 259*858ea5e5SAndroid Build Coastguard Worker * automatically enabled for the new file descriptor. 260*858ea5e5SAndroid Build Coastguard Worker * 261*858ea5e5SAndroid Build Coastguard Worker * Return 262*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 263*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 264*858ea5e5SAndroid Build Coastguard Worker * 265*858ea5e5SAndroid Build Coastguard Worker * BPF_OBJ_PIN 266*858ea5e5SAndroid Build Coastguard Worker * Description 267*858ea5e5SAndroid Build Coastguard Worker * Pin an eBPF program or map referred by the specified *bpf_fd* 268*858ea5e5SAndroid Build Coastguard Worker * to the provided *pathname* on the filesystem. 269*858ea5e5SAndroid Build Coastguard Worker * 270*858ea5e5SAndroid Build Coastguard Worker * The *pathname* argument must not contain a dot ("."). 271*858ea5e5SAndroid Build Coastguard Worker * 272*858ea5e5SAndroid Build Coastguard Worker * On success, *pathname* retains a reference to the eBPF object, 273*858ea5e5SAndroid Build Coastguard Worker * preventing deallocation of the object when the original 274*858ea5e5SAndroid Build Coastguard Worker * *bpf_fd* is closed. This allow the eBPF object to live beyond 275*858ea5e5SAndroid Build Coastguard Worker * **close**\ (\ *bpf_fd*\ ), and hence the lifetime of the parent 276*858ea5e5SAndroid Build Coastguard Worker * process. 277*858ea5e5SAndroid Build Coastguard Worker * 278*858ea5e5SAndroid Build Coastguard Worker * Applying **unlink**\ (2) or similar calls to the *pathname* 279*858ea5e5SAndroid Build Coastguard Worker * unpins the object from the filesystem, removing the reference. 280*858ea5e5SAndroid Build Coastguard Worker * If no other file descriptors or filesystem nodes refer to the 281*858ea5e5SAndroid Build Coastguard Worker * same object, it will be deallocated (see NOTES). 282*858ea5e5SAndroid Build Coastguard Worker * 283*858ea5e5SAndroid Build Coastguard Worker * The filesystem type for the parent directory of *pathname* must 284*858ea5e5SAndroid Build Coastguard Worker * be **BPF_FS_MAGIC**. 285*858ea5e5SAndroid Build Coastguard Worker * 286*858ea5e5SAndroid Build Coastguard Worker * Return 287*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 288*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 289*858ea5e5SAndroid Build Coastguard Worker * 290*858ea5e5SAndroid Build Coastguard Worker * BPF_OBJ_GET 291*858ea5e5SAndroid Build Coastguard Worker * Description 292*858ea5e5SAndroid Build Coastguard Worker * Open a file descriptor for the eBPF object pinned to the 293*858ea5e5SAndroid Build Coastguard Worker * specified *pathname*. 294*858ea5e5SAndroid Build Coastguard Worker * 295*858ea5e5SAndroid Build Coastguard Worker * Return 296*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 297*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 298*858ea5e5SAndroid Build Coastguard Worker * 299*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_ATTACH 300*858ea5e5SAndroid Build Coastguard Worker * Description 301*858ea5e5SAndroid Build Coastguard Worker * Attach an eBPF program to a *target_fd* at the specified 302*858ea5e5SAndroid Build Coastguard Worker * *attach_type* hook. 303*858ea5e5SAndroid Build Coastguard Worker * 304*858ea5e5SAndroid Build Coastguard Worker * The *attach_type* specifies the eBPF attachment point to 305*858ea5e5SAndroid Build Coastguard Worker * attach the program to, and must be one of *bpf_attach_type* 306*858ea5e5SAndroid Build Coastguard Worker * (see below). 307*858ea5e5SAndroid Build Coastguard Worker * 308*858ea5e5SAndroid Build Coastguard Worker * The *attach_bpf_fd* must be a valid file descriptor for a 309*858ea5e5SAndroid Build Coastguard Worker * loaded eBPF program of a cgroup, flow dissector, LIRC, sockmap 310*858ea5e5SAndroid Build Coastguard Worker * or sock_ops type corresponding to the specified *attach_type*. 311*858ea5e5SAndroid Build Coastguard Worker * 312*858ea5e5SAndroid Build Coastguard Worker * The *target_fd* must be a valid file descriptor for a kernel 313*858ea5e5SAndroid Build Coastguard Worker * object which depends on the attach type of *attach_bpf_fd*: 314*858ea5e5SAndroid Build Coastguard Worker * 315*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_DEVICE**, 316*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SKB**, 317*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SOCK**, 318*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**, 319*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SOCKOPT**, 320*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SYSCTL**, 321*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SOCK_OPS** 322*858ea5e5SAndroid Build Coastguard Worker * 323*858ea5e5SAndroid Build Coastguard Worker * Control Group v2 hierarchy with the eBPF controller 324*858ea5e5SAndroid Build Coastguard Worker * enabled. Requires the kernel to be compiled with 325*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_CGROUP_BPF**. 326*858ea5e5SAndroid Build Coastguard Worker * 327*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_FLOW_DISSECTOR** 328*858ea5e5SAndroid Build Coastguard Worker * 329*858ea5e5SAndroid Build Coastguard Worker * Network namespace (eg /proc/self/ns/net). 330*858ea5e5SAndroid Build Coastguard Worker * 331*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_LIRC_MODE2** 332*858ea5e5SAndroid Build Coastguard Worker * 333*858ea5e5SAndroid Build Coastguard Worker * LIRC device path (eg /dev/lircN). Requires the kernel 334*858ea5e5SAndroid Build Coastguard Worker * to be compiled with **CONFIG_BPF_LIRC_MODE2**. 335*858ea5e5SAndroid Build Coastguard Worker * 336*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SK_SKB**, 337*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SK_MSG** 338*858ea5e5SAndroid Build Coastguard Worker * 339*858ea5e5SAndroid Build Coastguard Worker * eBPF map of socket type (eg **BPF_MAP_TYPE_SOCKHASH**). 340*858ea5e5SAndroid Build Coastguard Worker * 341*858ea5e5SAndroid Build Coastguard Worker * Return 342*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 343*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 344*858ea5e5SAndroid Build Coastguard Worker * 345*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_DETACH 346*858ea5e5SAndroid Build Coastguard Worker * Description 347*858ea5e5SAndroid Build Coastguard Worker * Detach the eBPF program associated with the *target_fd* at the 348*858ea5e5SAndroid Build Coastguard Worker * hook specified by *attach_type*. The program must have been 349*858ea5e5SAndroid Build Coastguard Worker * previously attached using **BPF_PROG_ATTACH**. 350*858ea5e5SAndroid Build Coastguard Worker * 351*858ea5e5SAndroid Build Coastguard Worker * Return 352*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 353*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 354*858ea5e5SAndroid Build Coastguard Worker * 355*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_TEST_RUN 356*858ea5e5SAndroid Build Coastguard Worker * Description 357*858ea5e5SAndroid Build Coastguard Worker * Run the eBPF program associated with the *prog_fd* a *repeat* 358*858ea5e5SAndroid Build Coastguard Worker * number of times against a provided program context *ctx_in* and 359*858ea5e5SAndroid Build Coastguard Worker * data *data_in*, and return the modified program context 360*858ea5e5SAndroid Build Coastguard Worker * *ctx_out*, *data_out* (for example, packet data), result of the 361*858ea5e5SAndroid Build Coastguard Worker * execution *retval*, and *duration* of the test run. 362*858ea5e5SAndroid Build Coastguard Worker * 363*858ea5e5SAndroid Build Coastguard Worker * The sizes of the buffers provided as input and output 364*858ea5e5SAndroid Build Coastguard Worker * parameters *ctx_in*, *ctx_out*, *data_in*, and *data_out* must 365*858ea5e5SAndroid Build Coastguard Worker * be provided in the corresponding variables *ctx_size_in*, 366*858ea5e5SAndroid Build Coastguard Worker * *ctx_size_out*, *data_size_in*, and/or *data_size_out*. If any 367*858ea5e5SAndroid Build Coastguard Worker * of these parameters are not provided (ie set to NULL), the 368*858ea5e5SAndroid Build Coastguard Worker * corresponding size field must be zero. 369*858ea5e5SAndroid Build Coastguard Worker * 370*858ea5e5SAndroid Build Coastguard Worker * Some program types have particular requirements: 371*858ea5e5SAndroid Build Coastguard Worker * 372*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SK_LOOKUP** 373*858ea5e5SAndroid Build Coastguard Worker * *data_in* and *data_out* must be NULL. 374*858ea5e5SAndroid Build Coastguard Worker * 375*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_RAW_TRACEPOINT**, 376*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE** 377*858ea5e5SAndroid Build Coastguard Worker * 378*858ea5e5SAndroid Build Coastguard Worker * *ctx_out*, *data_in* and *data_out* must be NULL. 379*858ea5e5SAndroid Build Coastguard Worker * *repeat* must be zero. 380*858ea5e5SAndroid Build Coastguard Worker * 381*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_RUN is an alias for BPF_PROG_TEST_RUN. 382*858ea5e5SAndroid Build Coastguard Worker * 383*858ea5e5SAndroid Build Coastguard Worker * Return 384*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 385*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 386*858ea5e5SAndroid Build Coastguard Worker * 387*858ea5e5SAndroid Build Coastguard Worker * **ENOSPC** 388*858ea5e5SAndroid Build Coastguard Worker * Either *data_size_out* or *ctx_size_out* is too small. 389*858ea5e5SAndroid Build Coastguard Worker * **ENOTSUPP** 390*858ea5e5SAndroid Build Coastguard Worker * This command is not supported by the program type of 391*858ea5e5SAndroid Build Coastguard Worker * the program referred to by *prog_fd*. 392*858ea5e5SAndroid Build Coastguard Worker * 393*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_GET_NEXT_ID 394*858ea5e5SAndroid Build Coastguard Worker * Description 395*858ea5e5SAndroid Build Coastguard Worker * Fetch the next eBPF program currently loaded into the kernel. 396*858ea5e5SAndroid Build Coastguard Worker * 397*858ea5e5SAndroid Build Coastguard Worker * Looks for the eBPF program with an id greater than *start_id* 398*858ea5e5SAndroid Build Coastguard Worker * and updates *next_id* on success. If no other eBPF programs 399*858ea5e5SAndroid Build Coastguard Worker * remain with ids higher than *start_id*, returns -1 and sets 400*858ea5e5SAndroid Build Coastguard Worker * *errno* to **ENOENT**. 401*858ea5e5SAndroid Build Coastguard Worker * 402*858ea5e5SAndroid Build Coastguard Worker * Return 403*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, or when no id remains, -1 404*858ea5e5SAndroid Build Coastguard Worker * is returned and *errno* is set appropriately. 405*858ea5e5SAndroid Build Coastguard Worker * 406*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_GET_NEXT_ID 407*858ea5e5SAndroid Build Coastguard Worker * Description 408*858ea5e5SAndroid Build Coastguard Worker * Fetch the next eBPF map currently loaded into the kernel. 409*858ea5e5SAndroid Build Coastguard Worker * 410*858ea5e5SAndroid Build Coastguard Worker * Looks for the eBPF map with an id greater than *start_id* 411*858ea5e5SAndroid Build Coastguard Worker * and updates *next_id* on success. If no other eBPF maps 412*858ea5e5SAndroid Build Coastguard Worker * remain with ids higher than *start_id*, returns -1 and sets 413*858ea5e5SAndroid Build Coastguard Worker * *errno* to **ENOENT**. 414*858ea5e5SAndroid Build Coastguard Worker * 415*858ea5e5SAndroid Build Coastguard Worker * Return 416*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, or when no id remains, -1 417*858ea5e5SAndroid Build Coastguard Worker * is returned and *errno* is set appropriately. 418*858ea5e5SAndroid Build Coastguard Worker * 419*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_GET_FD_BY_ID 420*858ea5e5SAndroid Build Coastguard Worker * Description 421*858ea5e5SAndroid Build Coastguard Worker * Open a file descriptor for the eBPF program corresponding to 422*858ea5e5SAndroid Build Coastguard Worker * *prog_id*. 423*858ea5e5SAndroid Build Coastguard Worker * 424*858ea5e5SAndroid Build Coastguard Worker * Return 425*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 426*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 427*858ea5e5SAndroid Build Coastguard Worker * 428*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_GET_FD_BY_ID 429*858ea5e5SAndroid Build Coastguard Worker * Description 430*858ea5e5SAndroid Build Coastguard Worker * Open a file descriptor for the eBPF map corresponding to 431*858ea5e5SAndroid Build Coastguard Worker * *map_id*. 432*858ea5e5SAndroid Build Coastguard Worker * 433*858ea5e5SAndroid Build Coastguard Worker * Return 434*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 435*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 436*858ea5e5SAndroid Build Coastguard Worker * 437*858ea5e5SAndroid Build Coastguard Worker * BPF_OBJ_GET_INFO_BY_FD 438*858ea5e5SAndroid Build Coastguard Worker * Description 439*858ea5e5SAndroid Build Coastguard Worker * Obtain information about the eBPF object corresponding to 440*858ea5e5SAndroid Build Coastguard Worker * *bpf_fd*. 441*858ea5e5SAndroid Build Coastguard Worker * 442*858ea5e5SAndroid Build Coastguard Worker * Populates up to *info_len* bytes of *info*, which will be in 443*858ea5e5SAndroid Build Coastguard Worker * one of the following formats depending on the eBPF object type 444*858ea5e5SAndroid Build Coastguard Worker * of *bpf_fd*: 445*858ea5e5SAndroid Build Coastguard Worker * 446*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_prog_info** 447*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_map_info** 448*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_btf_info** 449*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_link_info** 450*858ea5e5SAndroid Build Coastguard Worker * 451*858ea5e5SAndroid Build Coastguard Worker * Return 452*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 453*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 454*858ea5e5SAndroid Build Coastguard Worker * 455*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_QUERY 456*858ea5e5SAndroid Build Coastguard Worker * Description 457*858ea5e5SAndroid Build Coastguard Worker * Obtain information about eBPF programs associated with the 458*858ea5e5SAndroid Build Coastguard Worker * specified *attach_type* hook. 459*858ea5e5SAndroid Build Coastguard Worker * 460*858ea5e5SAndroid Build Coastguard Worker * The *target_fd* must be a valid file descriptor for a kernel 461*858ea5e5SAndroid Build Coastguard Worker * object which depends on the attach type of *attach_bpf_fd*: 462*858ea5e5SAndroid Build Coastguard Worker * 463*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_DEVICE**, 464*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SKB**, 465*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SOCK**, 466*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**, 467*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SOCKOPT**, 468*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_CGROUP_SYSCTL**, 469*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SOCK_OPS** 470*858ea5e5SAndroid Build Coastguard Worker * 471*858ea5e5SAndroid Build Coastguard Worker * Control Group v2 hierarchy with the eBPF controller 472*858ea5e5SAndroid Build Coastguard Worker * enabled. Requires the kernel to be compiled with 473*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_CGROUP_BPF**. 474*858ea5e5SAndroid Build Coastguard Worker * 475*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_FLOW_DISSECTOR** 476*858ea5e5SAndroid Build Coastguard Worker * 477*858ea5e5SAndroid Build Coastguard Worker * Network namespace (eg /proc/self/ns/net). 478*858ea5e5SAndroid Build Coastguard Worker * 479*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_LIRC_MODE2** 480*858ea5e5SAndroid Build Coastguard Worker * 481*858ea5e5SAndroid Build Coastguard Worker * LIRC device path (eg /dev/lircN). Requires the kernel 482*858ea5e5SAndroid Build Coastguard Worker * to be compiled with **CONFIG_BPF_LIRC_MODE2**. 483*858ea5e5SAndroid Build Coastguard Worker * 484*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_QUERY** always fetches the number of programs 485*858ea5e5SAndroid Build Coastguard Worker * attached and the *attach_flags* which were used to attach those 486*858ea5e5SAndroid Build Coastguard Worker * programs. Additionally, if *prog_ids* is nonzero and the number 487*858ea5e5SAndroid Build Coastguard Worker * of attached programs is less than *prog_cnt*, populates 488*858ea5e5SAndroid Build Coastguard Worker * *prog_ids* with the eBPF program ids of the programs attached 489*858ea5e5SAndroid Build Coastguard Worker * at *target_fd*. 490*858ea5e5SAndroid Build Coastguard Worker * 491*858ea5e5SAndroid Build Coastguard Worker * The following flags may alter the result: 492*858ea5e5SAndroid Build Coastguard Worker * 493*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_QUERY_EFFECTIVE** 494*858ea5e5SAndroid Build Coastguard Worker * Only return information regarding programs which are 495*858ea5e5SAndroid Build Coastguard Worker * currently effective at the specified *target_fd*. 496*858ea5e5SAndroid Build Coastguard Worker * 497*858ea5e5SAndroid Build Coastguard Worker * Return 498*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 499*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 500*858ea5e5SAndroid Build Coastguard Worker * 501*858ea5e5SAndroid Build Coastguard Worker * BPF_RAW_TRACEPOINT_OPEN 502*858ea5e5SAndroid Build Coastguard Worker * Description 503*858ea5e5SAndroid Build Coastguard Worker * Attach an eBPF program to a tracepoint *name* to access kernel 504*858ea5e5SAndroid Build Coastguard Worker * internal arguments of the tracepoint in their raw form. 505*858ea5e5SAndroid Build Coastguard Worker * 506*858ea5e5SAndroid Build Coastguard Worker * The *prog_fd* must be a valid file descriptor associated with 507*858ea5e5SAndroid Build Coastguard Worker * a loaded eBPF program of type **BPF_PROG_TYPE_RAW_TRACEPOINT**. 508*858ea5e5SAndroid Build Coastguard Worker * 509*858ea5e5SAndroid Build Coastguard Worker * No ABI guarantees are made about the content of tracepoint 510*858ea5e5SAndroid Build Coastguard Worker * arguments exposed to the corresponding eBPF program. 511*858ea5e5SAndroid Build Coastguard Worker * 512*858ea5e5SAndroid Build Coastguard Worker * Applying **close**\ (2) to the file descriptor returned by 513*858ea5e5SAndroid Build Coastguard Worker * **BPF_RAW_TRACEPOINT_OPEN** will delete the map (but see NOTES). 514*858ea5e5SAndroid Build Coastguard Worker * 515*858ea5e5SAndroid Build Coastguard Worker * Return 516*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 517*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 518*858ea5e5SAndroid Build Coastguard Worker * 519*858ea5e5SAndroid Build Coastguard Worker * BPF_BTF_LOAD 520*858ea5e5SAndroid Build Coastguard Worker * Description 521*858ea5e5SAndroid Build Coastguard Worker * Verify and load BPF Type Format (BTF) metadata into the kernel, 522*858ea5e5SAndroid Build Coastguard Worker * returning a new file descriptor associated with the metadata. 523*858ea5e5SAndroid Build Coastguard Worker * BTF is described in more detail at 524*858ea5e5SAndroid Build Coastguard Worker * https://www.kernel.org/doc/html/latest/bpf/btf.html. 525*858ea5e5SAndroid Build Coastguard Worker * 526*858ea5e5SAndroid Build Coastguard Worker * The *btf* parameter must point to valid memory providing 527*858ea5e5SAndroid Build Coastguard Worker * *btf_size* bytes of BTF binary metadata. 528*858ea5e5SAndroid Build Coastguard Worker * 529*858ea5e5SAndroid Build Coastguard Worker * The returned file descriptor can be passed to other **bpf**\ () 530*858ea5e5SAndroid Build Coastguard Worker * subcommands such as **BPF_PROG_LOAD** or **BPF_MAP_CREATE** to 531*858ea5e5SAndroid Build Coastguard Worker * associate the BTF with those objects. 532*858ea5e5SAndroid Build Coastguard Worker * 533*858ea5e5SAndroid Build Coastguard Worker * Similar to **BPF_PROG_LOAD**, **BPF_BTF_LOAD** has optional 534*858ea5e5SAndroid Build Coastguard Worker * parameters to specify a *btf_log_buf*, *btf_log_size* and 535*858ea5e5SAndroid Build Coastguard Worker * *btf_log_level* which allow the kernel to return freeform log 536*858ea5e5SAndroid Build Coastguard Worker * output regarding the BTF verification process. 537*858ea5e5SAndroid Build Coastguard Worker * 538*858ea5e5SAndroid Build Coastguard Worker * Return 539*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 540*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 541*858ea5e5SAndroid Build Coastguard Worker * 542*858ea5e5SAndroid Build Coastguard Worker * BPF_BTF_GET_FD_BY_ID 543*858ea5e5SAndroid Build Coastguard Worker * Description 544*858ea5e5SAndroid Build Coastguard Worker * Open a file descriptor for the BPF Type Format (BTF) 545*858ea5e5SAndroid Build Coastguard Worker * corresponding to *btf_id*. 546*858ea5e5SAndroid Build Coastguard Worker * 547*858ea5e5SAndroid Build Coastguard Worker * Return 548*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 549*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 550*858ea5e5SAndroid Build Coastguard Worker * 551*858ea5e5SAndroid Build Coastguard Worker * BPF_TASK_FD_QUERY 552*858ea5e5SAndroid Build Coastguard Worker * Description 553*858ea5e5SAndroid Build Coastguard Worker * Obtain information about eBPF programs associated with the 554*858ea5e5SAndroid Build Coastguard Worker * target process identified by *pid* and *fd*. 555*858ea5e5SAndroid Build Coastguard Worker * 556*858ea5e5SAndroid Build Coastguard Worker * If the *pid* and *fd* are associated with a tracepoint, kprobe 557*858ea5e5SAndroid Build Coastguard Worker * or uprobe perf event, then the *prog_id* and *fd_type* will 558*858ea5e5SAndroid Build Coastguard Worker * be populated with the eBPF program id and file descriptor type 559*858ea5e5SAndroid Build Coastguard Worker * of type **bpf_task_fd_type**. If associated with a kprobe or 560*858ea5e5SAndroid Build Coastguard Worker * uprobe, the *probe_offset* and *probe_addr* will also be 561*858ea5e5SAndroid Build Coastguard Worker * populated. Optionally, if *buf* is provided, then up to 562*858ea5e5SAndroid Build Coastguard Worker * *buf_len* bytes of *buf* will be populated with the name of 563*858ea5e5SAndroid Build Coastguard Worker * the tracepoint, kprobe or uprobe. 564*858ea5e5SAndroid Build Coastguard Worker * 565*858ea5e5SAndroid Build Coastguard Worker * The resulting *prog_id* may be introspected in deeper detail 566*858ea5e5SAndroid Build Coastguard Worker * using **BPF_PROG_GET_FD_BY_ID** and **BPF_OBJ_GET_INFO_BY_FD**. 567*858ea5e5SAndroid Build Coastguard Worker * 568*858ea5e5SAndroid Build Coastguard Worker * Return 569*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 570*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 571*858ea5e5SAndroid Build Coastguard Worker * 572*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_LOOKUP_AND_DELETE_ELEM 573*858ea5e5SAndroid Build Coastguard Worker * Description 574*858ea5e5SAndroid Build Coastguard Worker * Look up an element with the given *key* in the map referred to 575*858ea5e5SAndroid Build Coastguard Worker * by the file descriptor *fd*, and if found, delete the element. 576*858ea5e5SAndroid Build Coastguard Worker * 577*858ea5e5SAndroid Build Coastguard Worker * For **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map 578*858ea5e5SAndroid Build Coastguard Worker * types, the *flags* argument needs to be set to 0, but for other 579*858ea5e5SAndroid Build Coastguard Worker * map types, it may be specified as: 580*858ea5e5SAndroid Build Coastguard Worker * 581*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_LOCK** 582*858ea5e5SAndroid Build Coastguard Worker * Look up and delete the value of a spin-locked map 583*858ea5e5SAndroid Build Coastguard Worker * without returning the lock. This must be specified if 584*858ea5e5SAndroid Build Coastguard Worker * the elements contain a spinlock. 585*858ea5e5SAndroid Build Coastguard Worker * 586*858ea5e5SAndroid Build Coastguard Worker * The **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map types 587*858ea5e5SAndroid Build Coastguard Worker * implement this command as a "pop" operation, deleting the top 588*858ea5e5SAndroid Build Coastguard Worker * element rather than one corresponding to *key*. 589*858ea5e5SAndroid Build Coastguard Worker * The *key* and *key_len* parameters should be zeroed when 590*858ea5e5SAndroid Build Coastguard Worker * issuing this operation for these map types. 591*858ea5e5SAndroid Build Coastguard Worker * 592*858ea5e5SAndroid Build Coastguard Worker * This command is only valid for the following map types: 593*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MAP_TYPE_QUEUE** 594*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MAP_TYPE_STACK** 595*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MAP_TYPE_HASH** 596*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MAP_TYPE_PERCPU_HASH** 597*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MAP_TYPE_LRU_HASH** 598*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MAP_TYPE_LRU_PERCPU_HASH** 599*858ea5e5SAndroid Build Coastguard Worker * 600*858ea5e5SAndroid Build Coastguard Worker * Return 601*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 602*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 603*858ea5e5SAndroid Build Coastguard Worker * 604*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_FREEZE 605*858ea5e5SAndroid Build Coastguard Worker * Description 606*858ea5e5SAndroid Build Coastguard Worker * Freeze the permissions of the specified map. 607*858ea5e5SAndroid Build Coastguard Worker * 608*858ea5e5SAndroid Build Coastguard Worker * Write permissions may be frozen by passing zero *flags*. 609*858ea5e5SAndroid Build Coastguard Worker * Upon success, no future syscall invocations may alter the 610*858ea5e5SAndroid Build Coastguard Worker * map state of *map_fd*. Write operations from eBPF programs 611*858ea5e5SAndroid Build Coastguard Worker * are still possible for a frozen map. 612*858ea5e5SAndroid Build Coastguard Worker * 613*858ea5e5SAndroid Build Coastguard Worker * Not supported for maps of type **BPF_MAP_TYPE_STRUCT_OPS**. 614*858ea5e5SAndroid Build Coastguard Worker * 615*858ea5e5SAndroid Build Coastguard Worker * Return 616*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 617*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 618*858ea5e5SAndroid Build Coastguard Worker * 619*858ea5e5SAndroid Build Coastguard Worker * BPF_BTF_GET_NEXT_ID 620*858ea5e5SAndroid Build Coastguard Worker * Description 621*858ea5e5SAndroid Build Coastguard Worker * Fetch the next BPF Type Format (BTF) object currently loaded 622*858ea5e5SAndroid Build Coastguard Worker * into the kernel. 623*858ea5e5SAndroid Build Coastguard Worker * 624*858ea5e5SAndroid Build Coastguard Worker * Looks for the BTF object with an id greater than *start_id* 625*858ea5e5SAndroid Build Coastguard Worker * and updates *next_id* on success. If no other BTF objects 626*858ea5e5SAndroid Build Coastguard Worker * remain with ids higher than *start_id*, returns -1 and sets 627*858ea5e5SAndroid Build Coastguard Worker * *errno* to **ENOENT**. 628*858ea5e5SAndroid Build Coastguard Worker * 629*858ea5e5SAndroid Build Coastguard Worker * Return 630*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, or when no id remains, -1 631*858ea5e5SAndroid Build Coastguard Worker * is returned and *errno* is set appropriately. 632*858ea5e5SAndroid Build Coastguard Worker * 633*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_LOOKUP_BATCH 634*858ea5e5SAndroid Build Coastguard Worker * Description 635*858ea5e5SAndroid Build Coastguard Worker * Iterate and fetch multiple elements in a map. 636*858ea5e5SAndroid Build Coastguard Worker * 637*858ea5e5SAndroid Build Coastguard Worker * Two opaque values are used to manage batch operations, 638*858ea5e5SAndroid Build Coastguard Worker * *in_batch* and *out_batch*. Initially, *in_batch* must be set 639*858ea5e5SAndroid Build Coastguard Worker * to NULL to begin the batched operation. After each subsequent 640*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_LOOKUP_BATCH**, the caller should pass the resultant 641*858ea5e5SAndroid Build Coastguard Worker * *out_batch* as the *in_batch* for the next operation to 642*858ea5e5SAndroid Build Coastguard Worker * continue iteration from the current point. Both *in_batch* and 643*858ea5e5SAndroid Build Coastguard Worker * *out_batch* must point to memory large enough to hold a key, 644*858ea5e5SAndroid Build Coastguard Worker * except for maps of type **BPF_MAP_TYPE_{HASH, PERCPU_HASH, 645*858ea5e5SAndroid Build Coastguard Worker * LRU_HASH, LRU_PERCPU_HASH}**, for which batch parameters 646*858ea5e5SAndroid Build Coastguard Worker * must be at least 4 bytes wide regardless of key size. 647*858ea5e5SAndroid Build Coastguard Worker * 648*858ea5e5SAndroid Build Coastguard Worker * The *keys* and *values* are output parameters which must point 649*858ea5e5SAndroid Build Coastguard Worker * to memory large enough to hold *count* items based on the key 650*858ea5e5SAndroid Build Coastguard Worker * and value size of the map *map_fd*. The *keys* buffer must be 651*858ea5e5SAndroid Build Coastguard Worker * of *key_size* * *count*. The *values* buffer must be of 652*858ea5e5SAndroid Build Coastguard Worker * *value_size* * *count*. 653*858ea5e5SAndroid Build Coastguard Worker * 654*858ea5e5SAndroid Build Coastguard Worker * The *elem_flags* argument may be specified as one of the 655*858ea5e5SAndroid Build Coastguard Worker * following: 656*858ea5e5SAndroid Build Coastguard Worker * 657*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_LOCK** 658*858ea5e5SAndroid Build Coastguard Worker * Look up the value of a spin-locked map without 659*858ea5e5SAndroid Build Coastguard Worker * returning the lock. This must be specified if the 660*858ea5e5SAndroid Build Coastguard Worker * elements contain a spinlock. 661*858ea5e5SAndroid Build Coastguard Worker * 662*858ea5e5SAndroid Build Coastguard Worker * On success, *count* elements from the map are copied into the 663*858ea5e5SAndroid Build Coastguard Worker * user buffer, with the keys copied into *keys* and the values 664*858ea5e5SAndroid Build Coastguard Worker * copied into the corresponding indices in *values*. 665*858ea5e5SAndroid Build Coastguard Worker * 666*858ea5e5SAndroid Build Coastguard Worker * If an error is returned and *errno* is not **EFAULT**, *count* 667*858ea5e5SAndroid Build Coastguard Worker * is set to the number of successfully processed elements. 668*858ea5e5SAndroid Build Coastguard Worker * 669*858ea5e5SAndroid Build Coastguard Worker * Return 670*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 671*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 672*858ea5e5SAndroid Build Coastguard Worker * 673*858ea5e5SAndroid Build Coastguard Worker * May set *errno* to **ENOSPC** to indicate that *keys* or 674*858ea5e5SAndroid Build Coastguard Worker * *values* is too small to dump an entire bucket during 675*858ea5e5SAndroid Build Coastguard Worker * iteration of a hash-based map type. 676*858ea5e5SAndroid Build Coastguard Worker * 677*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_LOOKUP_AND_DELETE_BATCH 678*858ea5e5SAndroid Build Coastguard Worker * Description 679*858ea5e5SAndroid Build Coastguard Worker * Iterate and delete all elements in a map. 680*858ea5e5SAndroid Build Coastguard Worker * 681*858ea5e5SAndroid Build Coastguard Worker * This operation has the same behavior as 682*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_LOOKUP_BATCH** with two exceptions: 683*858ea5e5SAndroid Build Coastguard Worker * 684*858ea5e5SAndroid Build Coastguard Worker * * Every element that is successfully returned is also deleted 685*858ea5e5SAndroid Build Coastguard Worker * from the map. This is at least *count* elements. Note that 686*858ea5e5SAndroid Build Coastguard Worker * *count* is both an input and an output parameter. 687*858ea5e5SAndroid Build Coastguard Worker * * Upon returning with *errno* set to **EFAULT**, up to 688*858ea5e5SAndroid Build Coastguard Worker * *count* elements may be deleted without returning the keys 689*858ea5e5SAndroid Build Coastguard Worker * and values of the deleted elements. 690*858ea5e5SAndroid Build Coastguard Worker * 691*858ea5e5SAndroid Build Coastguard Worker * Return 692*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 693*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 694*858ea5e5SAndroid Build Coastguard Worker * 695*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_UPDATE_BATCH 696*858ea5e5SAndroid Build Coastguard Worker * Description 697*858ea5e5SAndroid Build Coastguard Worker * Update multiple elements in a map by *key*. 698*858ea5e5SAndroid Build Coastguard Worker * 699*858ea5e5SAndroid Build Coastguard Worker * The *keys* and *values* are input parameters which must point 700*858ea5e5SAndroid Build Coastguard Worker * to memory large enough to hold *count* items based on the key 701*858ea5e5SAndroid Build Coastguard Worker * and value size of the map *map_fd*. The *keys* buffer must be 702*858ea5e5SAndroid Build Coastguard Worker * of *key_size* * *count*. The *values* buffer must be of 703*858ea5e5SAndroid Build Coastguard Worker * *value_size* * *count*. 704*858ea5e5SAndroid Build Coastguard Worker * 705*858ea5e5SAndroid Build Coastguard Worker * Each element specified in *keys* is sequentially updated to the 706*858ea5e5SAndroid Build Coastguard Worker * value in the corresponding index in *values*. The *in_batch* 707*858ea5e5SAndroid Build Coastguard Worker * and *out_batch* parameters are ignored and should be zeroed. 708*858ea5e5SAndroid Build Coastguard Worker * 709*858ea5e5SAndroid Build Coastguard Worker * The *elem_flags* argument should be specified as one of the 710*858ea5e5SAndroid Build Coastguard Worker * following: 711*858ea5e5SAndroid Build Coastguard Worker * 712*858ea5e5SAndroid Build Coastguard Worker * **BPF_ANY** 713*858ea5e5SAndroid Build Coastguard Worker * Create new elements or update a existing elements. 714*858ea5e5SAndroid Build Coastguard Worker * **BPF_NOEXIST** 715*858ea5e5SAndroid Build Coastguard Worker * Create new elements only if they do not exist. 716*858ea5e5SAndroid Build Coastguard Worker * **BPF_EXIST** 717*858ea5e5SAndroid Build Coastguard Worker * Update existing elements. 718*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_LOCK** 719*858ea5e5SAndroid Build Coastguard Worker * Update spin_lock-ed map elements. This must be 720*858ea5e5SAndroid Build Coastguard Worker * specified if the map value contains a spinlock. 721*858ea5e5SAndroid Build Coastguard Worker * 722*858ea5e5SAndroid Build Coastguard Worker * On success, *count* elements from the map are updated. 723*858ea5e5SAndroid Build Coastguard Worker * 724*858ea5e5SAndroid Build Coastguard Worker * If an error is returned and *errno* is not **EFAULT**, *count* 725*858ea5e5SAndroid Build Coastguard Worker * is set to the number of successfully processed elements. 726*858ea5e5SAndroid Build Coastguard Worker * 727*858ea5e5SAndroid Build Coastguard Worker * Return 728*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 729*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 730*858ea5e5SAndroid Build Coastguard Worker * 731*858ea5e5SAndroid Build Coastguard Worker * May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**, or 732*858ea5e5SAndroid Build Coastguard Worker * **E2BIG**. **E2BIG** indicates that the number of elements in 733*858ea5e5SAndroid Build Coastguard Worker * the map reached the *max_entries* limit specified at map 734*858ea5e5SAndroid Build Coastguard Worker * creation time. 735*858ea5e5SAndroid Build Coastguard Worker * 736*858ea5e5SAndroid Build Coastguard Worker * May set *errno* to one of the following error codes under 737*858ea5e5SAndroid Build Coastguard Worker * specific circumstances: 738*858ea5e5SAndroid Build Coastguard Worker * 739*858ea5e5SAndroid Build Coastguard Worker * **EEXIST** 740*858ea5e5SAndroid Build Coastguard Worker * If *flags* specifies **BPF_NOEXIST** and the element 741*858ea5e5SAndroid Build Coastguard Worker * with *key* already exists in the map. 742*858ea5e5SAndroid Build Coastguard Worker * **ENOENT** 743*858ea5e5SAndroid Build Coastguard Worker * If *flags* specifies **BPF_EXIST** and the element with 744*858ea5e5SAndroid Build Coastguard Worker * *key* does not exist in the map. 745*858ea5e5SAndroid Build Coastguard Worker * 746*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_DELETE_BATCH 747*858ea5e5SAndroid Build Coastguard Worker * Description 748*858ea5e5SAndroid Build Coastguard Worker * Delete multiple elements in a map by *key*. 749*858ea5e5SAndroid Build Coastguard Worker * 750*858ea5e5SAndroid Build Coastguard Worker * The *keys* parameter is an input parameter which must point 751*858ea5e5SAndroid Build Coastguard Worker * to memory large enough to hold *count* items based on the key 752*858ea5e5SAndroid Build Coastguard Worker * size of the map *map_fd*, that is, *key_size* * *count*. 753*858ea5e5SAndroid Build Coastguard Worker * 754*858ea5e5SAndroid Build Coastguard Worker * Each element specified in *keys* is sequentially deleted. The 755*858ea5e5SAndroid Build Coastguard Worker * *in_batch*, *out_batch*, and *values* parameters are ignored 756*858ea5e5SAndroid Build Coastguard Worker * and should be zeroed. 757*858ea5e5SAndroid Build Coastguard Worker * 758*858ea5e5SAndroid Build Coastguard Worker * The *elem_flags* argument may be specified as one of the 759*858ea5e5SAndroid Build Coastguard Worker * following: 760*858ea5e5SAndroid Build Coastguard Worker * 761*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_LOCK** 762*858ea5e5SAndroid Build Coastguard Worker * Look up the value of a spin-locked map without 763*858ea5e5SAndroid Build Coastguard Worker * returning the lock. This must be specified if the 764*858ea5e5SAndroid Build Coastguard Worker * elements contain a spinlock. 765*858ea5e5SAndroid Build Coastguard Worker * 766*858ea5e5SAndroid Build Coastguard Worker * On success, *count* elements from the map are updated. 767*858ea5e5SAndroid Build Coastguard Worker * 768*858ea5e5SAndroid Build Coastguard Worker * If an error is returned and *errno* is not **EFAULT**, *count* 769*858ea5e5SAndroid Build Coastguard Worker * is set to the number of successfully processed elements. If 770*858ea5e5SAndroid Build Coastguard Worker * *errno* is **EFAULT**, up to *count* elements may be been 771*858ea5e5SAndroid Build Coastguard Worker * deleted. 772*858ea5e5SAndroid Build Coastguard Worker * 773*858ea5e5SAndroid Build Coastguard Worker * Return 774*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 775*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 776*858ea5e5SAndroid Build Coastguard Worker * 777*858ea5e5SAndroid Build Coastguard Worker * BPF_LINK_CREATE 778*858ea5e5SAndroid Build Coastguard Worker * Description 779*858ea5e5SAndroid Build Coastguard Worker * Attach an eBPF program to a *target_fd* at the specified 780*858ea5e5SAndroid Build Coastguard Worker * *attach_type* hook and return a file descriptor handle for 781*858ea5e5SAndroid Build Coastguard Worker * managing the link. 782*858ea5e5SAndroid Build Coastguard Worker * 783*858ea5e5SAndroid Build Coastguard Worker * Return 784*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 785*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 786*858ea5e5SAndroid Build Coastguard Worker * 787*858ea5e5SAndroid Build Coastguard Worker * BPF_LINK_UPDATE 788*858ea5e5SAndroid Build Coastguard Worker * Description 789*858ea5e5SAndroid Build Coastguard Worker * Update the eBPF program in the specified *link_fd* to 790*858ea5e5SAndroid Build Coastguard Worker * *new_prog_fd*. 791*858ea5e5SAndroid Build Coastguard Worker * 792*858ea5e5SAndroid Build Coastguard Worker * Return 793*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 794*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 795*858ea5e5SAndroid Build Coastguard Worker * 796*858ea5e5SAndroid Build Coastguard Worker * BPF_LINK_GET_FD_BY_ID 797*858ea5e5SAndroid Build Coastguard Worker * Description 798*858ea5e5SAndroid Build Coastguard Worker * Open a file descriptor for the eBPF Link corresponding to 799*858ea5e5SAndroid Build Coastguard Worker * *link_id*. 800*858ea5e5SAndroid Build Coastguard Worker * 801*858ea5e5SAndroid Build Coastguard Worker * Return 802*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 803*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 804*858ea5e5SAndroid Build Coastguard Worker * 805*858ea5e5SAndroid Build Coastguard Worker * BPF_LINK_GET_NEXT_ID 806*858ea5e5SAndroid Build Coastguard Worker * Description 807*858ea5e5SAndroid Build Coastguard Worker * Fetch the next eBPF link currently loaded into the kernel. 808*858ea5e5SAndroid Build Coastguard Worker * 809*858ea5e5SAndroid Build Coastguard Worker * Looks for the eBPF link with an id greater than *start_id* 810*858ea5e5SAndroid Build Coastguard Worker * and updates *next_id* on success. If no other eBPF links 811*858ea5e5SAndroid Build Coastguard Worker * remain with ids higher than *start_id*, returns -1 and sets 812*858ea5e5SAndroid Build Coastguard Worker * *errno* to **ENOENT**. 813*858ea5e5SAndroid Build Coastguard Worker * 814*858ea5e5SAndroid Build Coastguard Worker * Return 815*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, or when no id remains, -1 816*858ea5e5SAndroid Build Coastguard Worker * is returned and *errno* is set appropriately. 817*858ea5e5SAndroid Build Coastguard Worker * 818*858ea5e5SAndroid Build Coastguard Worker * BPF_ENABLE_STATS 819*858ea5e5SAndroid Build Coastguard Worker * Description 820*858ea5e5SAndroid Build Coastguard Worker * Enable eBPF runtime statistics gathering. 821*858ea5e5SAndroid Build Coastguard Worker * 822*858ea5e5SAndroid Build Coastguard Worker * Runtime statistics gathering for the eBPF runtime is disabled 823*858ea5e5SAndroid Build Coastguard Worker * by default to minimize the corresponding performance overhead. 824*858ea5e5SAndroid Build Coastguard Worker * This command enables statistics globally. 825*858ea5e5SAndroid Build Coastguard Worker * 826*858ea5e5SAndroid Build Coastguard Worker * Multiple programs may independently enable statistics. 827*858ea5e5SAndroid Build Coastguard Worker * After gathering the desired statistics, eBPF runtime statistics 828*858ea5e5SAndroid Build Coastguard Worker * may be disabled again by calling **close**\ (2) for the file 829*858ea5e5SAndroid Build Coastguard Worker * descriptor returned by this function. Statistics will only be 830*858ea5e5SAndroid Build Coastguard Worker * disabled system-wide when all outstanding file descriptors 831*858ea5e5SAndroid Build Coastguard Worker * returned by prior calls for this subcommand are closed. 832*858ea5e5SAndroid Build Coastguard Worker * 833*858ea5e5SAndroid Build Coastguard Worker * Return 834*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 835*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 836*858ea5e5SAndroid Build Coastguard Worker * 837*858ea5e5SAndroid Build Coastguard Worker * BPF_ITER_CREATE 838*858ea5e5SAndroid Build Coastguard Worker * Description 839*858ea5e5SAndroid Build Coastguard Worker * Create an iterator on top of the specified *link_fd* (as 840*858ea5e5SAndroid Build Coastguard Worker * previously created using **BPF_LINK_CREATE**) and return a 841*858ea5e5SAndroid Build Coastguard Worker * file descriptor that can be used to trigger the iteration. 842*858ea5e5SAndroid Build Coastguard Worker * 843*858ea5e5SAndroid Build Coastguard Worker * If the resulting file descriptor is pinned to the filesystem 844*858ea5e5SAndroid Build Coastguard Worker * using **BPF_OBJ_PIN**, then subsequent **read**\ (2) syscalls 845*858ea5e5SAndroid Build Coastguard Worker * for that path will trigger the iterator to read kernel state 846*858ea5e5SAndroid Build Coastguard Worker * using the eBPF program attached to *link_fd*. 847*858ea5e5SAndroid Build Coastguard Worker * 848*858ea5e5SAndroid Build Coastguard Worker * Return 849*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 850*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 851*858ea5e5SAndroid Build Coastguard Worker * 852*858ea5e5SAndroid Build Coastguard Worker * BPF_LINK_DETACH 853*858ea5e5SAndroid Build Coastguard Worker * Description 854*858ea5e5SAndroid Build Coastguard Worker * Forcefully detach the specified *link_fd* from its 855*858ea5e5SAndroid Build Coastguard Worker * corresponding attachment point. 856*858ea5e5SAndroid Build Coastguard Worker * 857*858ea5e5SAndroid Build Coastguard Worker * Return 858*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 859*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 860*858ea5e5SAndroid Build Coastguard Worker * 861*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_BIND_MAP 862*858ea5e5SAndroid Build Coastguard Worker * Description 863*858ea5e5SAndroid Build Coastguard Worker * Bind a map to the lifetime of an eBPF program. 864*858ea5e5SAndroid Build Coastguard Worker * 865*858ea5e5SAndroid Build Coastguard Worker * The map identified by *map_fd* is bound to the program 866*858ea5e5SAndroid Build Coastguard Worker * identified by *prog_fd* and only released when *prog_fd* is 867*858ea5e5SAndroid Build Coastguard Worker * released. This may be used in cases where metadata should be 868*858ea5e5SAndroid Build Coastguard Worker * associated with a program which otherwise does not contain any 869*858ea5e5SAndroid Build Coastguard Worker * references to the map (for example, embedded in the eBPF 870*858ea5e5SAndroid Build Coastguard Worker * program instructions). 871*858ea5e5SAndroid Build Coastguard Worker * 872*858ea5e5SAndroid Build Coastguard Worker * Return 873*858ea5e5SAndroid Build Coastguard Worker * Returns zero on success. On error, -1 is returned and *errno* 874*858ea5e5SAndroid Build Coastguard Worker * is set appropriately. 875*858ea5e5SAndroid Build Coastguard Worker * 876*858ea5e5SAndroid Build Coastguard Worker * BPF_TOKEN_CREATE 877*858ea5e5SAndroid Build Coastguard Worker * Description 878*858ea5e5SAndroid Build Coastguard Worker * Create BPF token with embedded information about what 879*858ea5e5SAndroid Build Coastguard Worker * BPF-related functionality it allows: 880*858ea5e5SAndroid Build Coastguard Worker * - a set of allowed bpf() syscall commands; 881*858ea5e5SAndroid Build Coastguard Worker * - a set of allowed BPF map types to be created with 882*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_CREATE command, if BPF_MAP_CREATE itself is allowed; 883*858ea5e5SAndroid Build Coastguard Worker * - a set of allowed BPF program types and BPF program attach 884*858ea5e5SAndroid Build Coastguard Worker * types to be loaded with BPF_PROG_LOAD command, if 885*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_LOAD itself is allowed. 886*858ea5e5SAndroid Build Coastguard Worker * 887*858ea5e5SAndroid Build Coastguard Worker * BPF token is created (derived) from an instance of BPF FS, 888*858ea5e5SAndroid Build Coastguard Worker * assuming it has necessary delegation mount options specified. 889*858ea5e5SAndroid Build Coastguard Worker * This BPF token can be passed as an extra parameter to various 890*858ea5e5SAndroid Build Coastguard Worker * bpf() syscall commands to grant BPF subsystem functionality to 891*858ea5e5SAndroid Build Coastguard Worker * unprivileged processes. 892*858ea5e5SAndroid Build Coastguard Worker * 893*858ea5e5SAndroid Build Coastguard Worker * When created, BPF token is "associated" with the owning 894*858ea5e5SAndroid Build Coastguard Worker * user namespace of BPF FS instance (super block) that it was 895*858ea5e5SAndroid Build Coastguard Worker * derived from, and subsequent BPF operations performed with 896*858ea5e5SAndroid Build Coastguard Worker * BPF token would be performing capabilities checks (i.e., 897*858ea5e5SAndroid Build Coastguard Worker * CAP_BPF, CAP_PERFMON, CAP_NET_ADMIN, CAP_SYS_ADMIN) within 898*858ea5e5SAndroid Build Coastguard Worker * that user namespace. Without BPF token, such capabilities 899*858ea5e5SAndroid Build Coastguard Worker * have to be granted in init user namespace, making bpf() 900*858ea5e5SAndroid Build Coastguard Worker * syscall incompatible with user namespace, for the most part. 901*858ea5e5SAndroid Build Coastguard Worker * 902*858ea5e5SAndroid Build Coastguard Worker * Return 903*858ea5e5SAndroid Build Coastguard Worker * A new file descriptor (a nonnegative integer), or -1 if an 904*858ea5e5SAndroid Build Coastguard Worker * error occurred (in which case, *errno* is set appropriately). 905*858ea5e5SAndroid Build Coastguard Worker * 906*858ea5e5SAndroid Build Coastguard Worker * NOTES 907*858ea5e5SAndroid Build Coastguard Worker * eBPF objects (maps and programs) can be shared between processes. 908*858ea5e5SAndroid Build Coastguard Worker * 909*858ea5e5SAndroid Build Coastguard Worker * * After **fork**\ (2), the child inherits file descriptors 910*858ea5e5SAndroid Build Coastguard Worker * referring to the same eBPF objects. 911*858ea5e5SAndroid Build Coastguard Worker * * File descriptors referring to eBPF objects can be transferred over 912*858ea5e5SAndroid Build Coastguard Worker * **unix**\ (7) domain sockets. 913*858ea5e5SAndroid Build Coastguard Worker * * File descriptors referring to eBPF objects can be duplicated in the 914*858ea5e5SAndroid Build Coastguard Worker * usual way, using **dup**\ (2) and similar calls. 915*858ea5e5SAndroid Build Coastguard Worker * * File descriptors referring to eBPF objects can be pinned to the 916*858ea5e5SAndroid Build Coastguard Worker * filesystem using the **BPF_OBJ_PIN** command of **bpf**\ (2). 917*858ea5e5SAndroid Build Coastguard Worker * 918*858ea5e5SAndroid Build Coastguard Worker * An eBPF object is deallocated only after all file descriptors referring 919*858ea5e5SAndroid Build Coastguard Worker * to the object have been closed and no references remain pinned to the 920*858ea5e5SAndroid Build Coastguard Worker * filesystem or attached (for example, bound to a program or device). 921*858ea5e5SAndroid Build Coastguard Worker */ 922*858ea5e5SAndroid Build Coastguard Worker enum bpf_cmd { 923*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_CREATE, 924*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_LOOKUP_ELEM, 925*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_UPDATE_ELEM, 926*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_DELETE_ELEM, 927*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_GET_NEXT_KEY, 928*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_LOAD, 929*858ea5e5SAndroid Build Coastguard Worker BPF_OBJ_PIN, 930*858ea5e5SAndroid Build Coastguard Worker BPF_OBJ_GET, 931*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_ATTACH, 932*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_DETACH, 933*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TEST_RUN, 934*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_RUN = BPF_PROG_TEST_RUN, 935*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_GET_NEXT_ID, 936*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_GET_NEXT_ID, 937*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_GET_FD_BY_ID, 938*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_GET_FD_BY_ID, 939*858ea5e5SAndroid Build Coastguard Worker BPF_OBJ_GET_INFO_BY_FD, 940*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_QUERY, 941*858ea5e5SAndroid Build Coastguard Worker BPF_RAW_TRACEPOINT_OPEN, 942*858ea5e5SAndroid Build Coastguard Worker BPF_BTF_LOAD, 943*858ea5e5SAndroid Build Coastguard Worker BPF_BTF_GET_FD_BY_ID, 944*858ea5e5SAndroid Build Coastguard Worker BPF_TASK_FD_QUERY, 945*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_LOOKUP_AND_DELETE_ELEM, 946*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_FREEZE, 947*858ea5e5SAndroid Build Coastguard Worker BPF_BTF_GET_NEXT_ID, 948*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_LOOKUP_BATCH, 949*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_LOOKUP_AND_DELETE_BATCH, 950*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_UPDATE_BATCH, 951*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_DELETE_BATCH, 952*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_CREATE, 953*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_UPDATE, 954*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_GET_FD_BY_ID, 955*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_GET_NEXT_ID, 956*858ea5e5SAndroid Build Coastguard Worker BPF_ENABLE_STATS, 957*858ea5e5SAndroid Build Coastguard Worker BPF_ITER_CREATE, 958*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_DETACH, 959*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_BIND_MAP, 960*858ea5e5SAndroid Build Coastguard Worker BPF_TOKEN_CREATE, 961*858ea5e5SAndroid Build Coastguard Worker __MAX_BPF_CMD, 962*858ea5e5SAndroid Build Coastguard Worker }; 963*858ea5e5SAndroid Build Coastguard Worker 964*858ea5e5SAndroid Build Coastguard Worker enum bpf_map_type { 965*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_UNSPEC, 966*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_HASH, 967*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_ARRAY, 968*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_PROG_ARRAY, 969*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_PERF_EVENT_ARRAY, 970*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_PERCPU_HASH, 971*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_PERCPU_ARRAY, 972*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_STACK_TRACE, 973*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_CGROUP_ARRAY, 974*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_LRU_HASH, 975*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_LRU_PERCPU_HASH, 976*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_LPM_TRIE, 977*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_ARRAY_OF_MAPS, 978*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_HASH_OF_MAPS, 979*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_DEVMAP, 980*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_SOCKMAP, 981*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_CPUMAP, 982*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_XSKMAP, 983*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_SOCKHASH, 984*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_CGROUP_STORAGE_DEPRECATED, 985*858ea5e5SAndroid Build Coastguard Worker /* BPF_MAP_TYPE_CGROUP_STORAGE is available to bpf programs attaching 986*858ea5e5SAndroid Build Coastguard Worker * to a cgroup. The newer BPF_MAP_TYPE_CGRP_STORAGE is available to 987*858ea5e5SAndroid Build Coastguard Worker * both cgroup-attached and other progs and supports all functionality 988*858ea5e5SAndroid Build Coastguard Worker * provided by BPF_MAP_TYPE_CGROUP_STORAGE. So mark 989*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_CGROUP_STORAGE deprecated. 990*858ea5e5SAndroid Build Coastguard Worker */ 991*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_CGROUP_STORAGE = BPF_MAP_TYPE_CGROUP_STORAGE_DEPRECATED, 992*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_REUSEPORT_SOCKARRAY, 993*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE_DEPRECATED, 994*858ea5e5SAndroid Build Coastguard Worker /* BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE is available to bpf programs 995*858ea5e5SAndroid Build Coastguard Worker * attaching to a cgroup. The new mechanism (BPF_MAP_TYPE_CGRP_STORAGE + 996*858ea5e5SAndroid Build Coastguard Worker * local percpu kptr) supports all BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE 997*858ea5e5SAndroid Build Coastguard Worker * functionality and more. So mark * BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE 998*858ea5e5SAndroid Build Coastguard Worker * deprecated. 999*858ea5e5SAndroid Build Coastguard Worker */ 1000*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE = BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE_DEPRECATED, 1001*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_QUEUE, 1002*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_STACK, 1003*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_SK_STORAGE, 1004*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_DEVMAP_HASH, 1005*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_STRUCT_OPS, 1006*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_RINGBUF, 1007*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_INODE_STORAGE, 1008*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_TASK_STORAGE, 1009*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_BLOOM_FILTER, 1010*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_USER_RINGBUF, 1011*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_CGRP_STORAGE, 1012*858ea5e5SAndroid Build Coastguard Worker BPF_MAP_TYPE_ARENA, 1013*858ea5e5SAndroid Build Coastguard Worker __MAX_BPF_MAP_TYPE 1014*858ea5e5SAndroid Build Coastguard Worker }; 1015*858ea5e5SAndroid Build Coastguard Worker 1016*858ea5e5SAndroid Build Coastguard Worker /* Note that tracing related programs such as 1017*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT} 1018*858ea5e5SAndroid Build Coastguard Worker * are not subject to a stable API since kernel internal data 1019*858ea5e5SAndroid Build Coastguard Worker * structures can change from release to release and may 1020*858ea5e5SAndroid Build Coastguard Worker * therefore break existing tracing BPF programs. Tracing BPF 1021*858ea5e5SAndroid Build Coastguard Worker * programs correspond to /a/ specific kernel which is to be 1022*858ea5e5SAndroid Build Coastguard Worker * analyzed, and not /a/ specific kernel /and/ all future ones. 1023*858ea5e5SAndroid Build Coastguard Worker */ 1024*858ea5e5SAndroid Build Coastguard Worker enum bpf_prog_type { 1025*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_UNSPEC, 1026*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SOCKET_FILTER, 1027*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_KPROBE, 1028*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SCHED_CLS, 1029*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SCHED_ACT, 1030*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_TRACEPOINT, 1031*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_XDP, 1032*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_PERF_EVENT, 1033*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_CGROUP_SKB, 1034*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_CGROUP_SOCK, 1035*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_LWT_IN, 1036*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_LWT_OUT, 1037*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_LWT_XMIT, 1038*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SOCK_OPS, 1039*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SK_SKB, 1040*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_CGROUP_DEVICE, 1041*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SK_MSG, 1042*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_RAW_TRACEPOINT, 1043*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_CGROUP_SOCK_ADDR, 1044*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_LWT_SEG6LOCAL, 1045*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_LIRC_MODE2, 1046*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SK_REUSEPORT, 1047*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_FLOW_DISSECTOR, 1048*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_CGROUP_SYSCTL, 1049*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE, 1050*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_CGROUP_SOCKOPT, 1051*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_TRACING, 1052*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_STRUCT_OPS, 1053*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_EXT, 1054*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_LSM, 1055*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SK_LOOKUP, 1056*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_SYSCALL, /* a program that can execute syscalls */ 1057*858ea5e5SAndroid Build Coastguard Worker BPF_PROG_TYPE_NETFILTER, 1058*858ea5e5SAndroid Build Coastguard Worker __MAX_BPF_PROG_TYPE 1059*858ea5e5SAndroid Build Coastguard Worker }; 1060*858ea5e5SAndroid Build Coastguard Worker 1061*858ea5e5SAndroid Build Coastguard Worker enum bpf_attach_type { 1062*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET_INGRESS, 1063*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET_EGRESS, 1064*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET_SOCK_CREATE, 1065*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_SOCK_OPS, 1066*858ea5e5SAndroid Build Coastguard Worker BPF_SK_SKB_STREAM_PARSER, 1067*858ea5e5SAndroid Build Coastguard Worker BPF_SK_SKB_STREAM_VERDICT, 1068*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_DEVICE, 1069*858ea5e5SAndroid Build Coastguard Worker BPF_SK_MSG_VERDICT, 1070*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET4_BIND, 1071*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET6_BIND, 1072*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET4_CONNECT, 1073*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET6_CONNECT, 1074*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET4_POST_BIND, 1075*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET6_POST_BIND, 1076*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UDP4_SENDMSG, 1077*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UDP6_SENDMSG, 1078*858ea5e5SAndroid Build Coastguard Worker BPF_LIRC_MODE2, 1079*858ea5e5SAndroid Build Coastguard Worker BPF_FLOW_DISSECTOR, 1080*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_SYSCTL, 1081*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UDP4_RECVMSG, 1082*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UDP6_RECVMSG, 1083*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_GETSOCKOPT, 1084*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_SETSOCKOPT, 1085*858ea5e5SAndroid Build Coastguard Worker BPF_TRACE_RAW_TP, 1086*858ea5e5SAndroid Build Coastguard Worker BPF_TRACE_FENTRY, 1087*858ea5e5SAndroid Build Coastguard Worker BPF_TRACE_FEXIT, 1088*858ea5e5SAndroid Build Coastguard Worker BPF_MODIFY_RETURN, 1089*858ea5e5SAndroid Build Coastguard Worker BPF_LSM_MAC, 1090*858ea5e5SAndroid Build Coastguard Worker BPF_TRACE_ITER, 1091*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET4_GETPEERNAME, 1092*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET6_GETPEERNAME, 1093*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET4_GETSOCKNAME, 1094*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET6_GETSOCKNAME, 1095*858ea5e5SAndroid Build Coastguard Worker BPF_XDP_DEVMAP, 1096*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_INET_SOCK_RELEASE, 1097*858ea5e5SAndroid Build Coastguard Worker BPF_XDP_CPUMAP, 1098*858ea5e5SAndroid Build Coastguard Worker BPF_SK_LOOKUP, 1099*858ea5e5SAndroid Build Coastguard Worker BPF_XDP, 1100*858ea5e5SAndroid Build Coastguard Worker BPF_SK_SKB_VERDICT, 1101*858ea5e5SAndroid Build Coastguard Worker BPF_SK_REUSEPORT_SELECT, 1102*858ea5e5SAndroid Build Coastguard Worker BPF_SK_REUSEPORT_SELECT_OR_MIGRATE, 1103*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT, 1104*858ea5e5SAndroid Build Coastguard Worker BPF_TRACE_KPROBE_MULTI, 1105*858ea5e5SAndroid Build Coastguard Worker BPF_LSM_CGROUP, 1106*858ea5e5SAndroid Build Coastguard Worker BPF_STRUCT_OPS, 1107*858ea5e5SAndroid Build Coastguard Worker BPF_NETFILTER, 1108*858ea5e5SAndroid Build Coastguard Worker BPF_TCX_INGRESS, 1109*858ea5e5SAndroid Build Coastguard Worker BPF_TCX_EGRESS, 1110*858ea5e5SAndroid Build Coastguard Worker BPF_TRACE_UPROBE_MULTI, 1111*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UNIX_CONNECT, 1112*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UNIX_SENDMSG, 1113*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UNIX_RECVMSG, 1114*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UNIX_GETPEERNAME, 1115*858ea5e5SAndroid Build Coastguard Worker BPF_CGROUP_UNIX_GETSOCKNAME, 1116*858ea5e5SAndroid Build Coastguard Worker BPF_NETKIT_PRIMARY, 1117*858ea5e5SAndroid Build Coastguard Worker BPF_NETKIT_PEER, 1118*858ea5e5SAndroid Build Coastguard Worker __MAX_BPF_ATTACH_TYPE 1119*858ea5e5SAndroid Build Coastguard Worker }; 1120*858ea5e5SAndroid Build Coastguard Worker 1121*858ea5e5SAndroid Build Coastguard Worker #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE 1122*858ea5e5SAndroid Build Coastguard Worker 1123*858ea5e5SAndroid Build Coastguard Worker enum bpf_link_type { 1124*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_UNSPEC = 0, 1125*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_RAW_TRACEPOINT = 1, 1126*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_TRACING = 2, 1127*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_CGROUP = 3, 1128*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_ITER = 4, 1129*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_NETNS = 5, 1130*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_XDP = 6, 1131*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_PERF_EVENT = 7, 1132*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_KPROBE_MULTI = 8, 1133*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_STRUCT_OPS = 9, 1134*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_NETFILTER = 10, 1135*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_TCX = 11, 1136*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_UPROBE_MULTI = 12, 1137*858ea5e5SAndroid Build Coastguard Worker BPF_LINK_TYPE_NETKIT = 13, 1138*858ea5e5SAndroid Build Coastguard Worker __MAX_BPF_LINK_TYPE, 1139*858ea5e5SAndroid Build Coastguard Worker }; 1140*858ea5e5SAndroid Build Coastguard Worker 1141*858ea5e5SAndroid Build Coastguard Worker #define MAX_BPF_LINK_TYPE __MAX_BPF_LINK_TYPE 1142*858ea5e5SAndroid Build Coastguard Worker 1143*858ea5e5SAndroid Build Coastguard Worker enum bpf_perf_event_type { 1144*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_UNSPEC = 0, 1145*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_UPROBE = 1, 1146*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_URETPROBE = 2, 1147*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_KPROBE = 3, 1148*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_KRETPROBE = 4, 1149*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_TRACEPOINT = 5, 1150*858ea5e5SAndroid Build Coastguard Worker BPF_PERF_EVENT_EVENT = 6, 1151*858ea5e5SAndroid Build Coastguard Worker }; 1152*858ea5e5SAndroid Build Coastguard Worker 1153*858ea5e5SAndroid Build Coastguard Worker /* cgroup-bpf attach flags used in BPF_PROG_ATTACH command 1154*858ea5e5SAndroid Build Coastguard Worker * 1155*858ea5e5SAndroid Build Coastguard Worker * NONE(default): No further bpf programs allowed in the subtree. 1156*858ea5e5SAndroid Build Coastguard Worker * 1157*858ea5e5SAndroid Build Coastguard Worker * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program, 1158*858ea5e5SAndroid Build Coastguard Worker * the program in this cgroup yields to sub-cgroup program. 1159*858ea5e5SAndroid Build Coastguard Worker * 1160*858ea5e5SAndroid Build Coastguard Worker * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program, 1161*858ea5e5SAndroid Build Coastguard Worker * that cgroup program gets run in addition to the program in this cgroup. 1162*858ea5e5SAndroid Build Coastguard Worker * 1163*858ea5e5SAndroid Build Coastguard Worker * Only one program is allowed to be attached to a cgroup with 1164*858ea5e5SAndroid Build Coastguard Worker * NONE or BPF_F_ALLOW_OVERRIDE flag. 1165*858ea5e5SAndroid Build Coastguard Worker * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will 1166*858ea5e5SAndroid Build Coastguard Worker * release old program and attach the new one. Attach flags has to match. 1167*858ea5e5SAndroid Build Coastguard Worker * 1168*858ea5e5SAndroid Build Coastguard Worker * Multiple programs are allowed to be attached to a cgroup with 1169*858ea5e5SAndroid Build Coastguard Worker * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order 1170*858ea5e5SAndroid Build Coastguard Worker * (those that were attached first, run first) 1171*858ea5e5SAndroid Build Coastguard Worker * The programs of sub-cgroup are executed first, then programs of 1172*858ea5e5SAndroid Build Coastguard Worker * this cgroup and then programs of parent cgroup. 1173*858ea5e5SAndroid Build Coastguard Worker * When children program makes decision (like picking TCP CA or sock bind) 1174*858ea5e5SAndroid Build Coastguard Worker * parent program has a chance to override it. 1175*858ea5e5SAndroid Build Coastguard Worker * 1176*858ea5e5SAndroid Build Coastguard Worker * With BPF_F_ALLOW_MULTI a new program is added to the end of the list of 1177*858ea5e5SAndroid Build Coastguard Worker * programs for a cgroup. Though it's possible to replace an old program at 1178*858ea5e5SAndroid Build Coastguard Worker * any position by also specifying BPF_F_REPLACE flag and position itself in 1179*858ea5e5SAndroid Build Coastguard Worker * replace_bpf_fd attribute. Old program at this position will be released. 1180*858ea5e5SAndroid Build Coastguard Worker * 1181*858ea5e5SAndroid Build Coastguard Worker * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups. 1182*858ea5e5SAndroid Build Coastguard Worker * A cgroup with NONE doesn't allow any programs in sub-cgroups. 1183*858ea5e5SAndroid Build Coastguard Worker * Ex1: 1184*858ea5e5SAndroid Build Coastguard Worker * cgrp1 (MULTI progs A, B) -> 1185*858ea5e5SAndroid Build Coastguard Worker * cgrp2 (OVERRIDE prog C) -> 1186*858ea5e5SAndroid Build Coastguard Worker * cgrp3 (MULTI prog D) -> 1187*858ea5e5SAndroid Build Coastguard Worker * cgrp4 (OVERRIDE prog E) -> 1188*858ea5e5SAndroid Build Coastguard Worker * cgrp5 (NONE prog F) 1189*858ea5e5SAndroid Build Coastguard Worker * the event in cgrp5 triggers execution of F,D,A,B in that order. 1190*858ea5e5SAndroid Build Coastguard Worker * if prog F is detached, the execution is E,D,A,B 1191*858ea5e5SAndroid Build Coastguard Worker * if prog F and D are detached, the execution is E,A,B 1192*858ea5e5SAndroid Build Coastguard Worker * if prog F, E and D are detached, the execution is C,A,B 1193*858ea5e5SAndroid Build Coastguard Worker * 1194*858ea5e5SAndroid Build Coastguard Worker * All eligible programs are executed regardless of return code from 1195*858ea5e5SAndroid Build Coastguard Worker * earlier programs. 1196*858ea5e5SAndroid Build Coastguard Worker */ 1197*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_ALLOW_OVERRIDE (1U << 0) 1198*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_ALLOW_MULTI (1U << 1) 1199*858ea5e5SAndroid Build Coastguard Worker /* Generic attachment flags. */ 1200*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_REPLACE (1U << 2) 1201*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_BEFORE (1U << 3) 1202*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_AFTER (1U << 4) 1203*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_ID (1U << 5) 1204*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_LINK BPF_F_LINK /* 1 << 13 */ 1205*858ea5e5SAndroid Build Coastguard Worker 1206*858ea5e5SAndroid Build Coastguard Worker /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the 1207*858ea5e5SAndroid Build Coastguard Worker * verifier will perform strict alignment checking as if the kernel 1208*858ea5e5SAndroid Build Coastguard Worker * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set, 1209*858ea5e5SAndroid Build Coastguard Worker * and NET_IP_ALIGN defined to 2. 1210*858ea5e5SAndroid Build Coastguard Worker */ 1211*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_STRICT_ALIGNMENT (1U << 0) 1212*858ea5e5SAndroid Build Coastguard Worker 1213*858ea5e5SAndroid Build Coastguard Worker /* If BPF_F_ANY_ALIGNMENT is used in BPF_PROG_LOAD command, the 1214*858ea5e5SAndroid Build Coastguard Worker * verifier will allow any alignment whatsoever. On platforms 1215*858ea5e5SAndroid Build Coastguard Worker * with strict alignment requirements for loads ands stores (such 1216*858ea5e5SAndroid Build Coastguard Worker * as sparc and mips) the verifier validates that all loads and 1217*858ea5e5SAndroid Build Coastguard Worker * stores provably follow this requirement. This flag turns that 1218*858ea5e5SAndroid Build Coastguard Worker * checking and enforcement off. 1219*858ea5e5SAndroid Build Coastguard Worker * 1220*858ea5e5SAndroid Build Coastguard Worker * It is mostly used for testing when we want to validate the 1221*858ea5e5SAndroid Build Coastguard Worker * context and memory access aspects of the verifier, but because 1222*858ea5e5SAndroid Build Coastguard Worker * of an unaligned access the alignment check would trigger before 1223*858ea5e5SAndroid Build Coastguard Worker * the one we are interested in. 1224*858ea5e5SAndroid Build Coastguard Worker */ 1225*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_ANY_ALIGNMENT (1U << 1) 1226*858ea5e5SAndroid Build Coastguard Worker 1227*858ea5e5SAndroid Build Coastguard Worker /* BPF_F_TEST_RND_HI32 is used in BPF_PROG_LOAD command for testing purpose. 1228*858ea5e5SAndroid Build Coastguard Worker * Verifier does sub-register def/use analysis and identifies instructions whose 1229*858ea5e5SAndroid Build Coastguard Worker * def only matters for low 32-bit, high 32-bit is never referenced later 1230*858ea5e5SAndroid Build Coastguard Worker * through implicit zero extension. Therefore verifier notifies JIT back-ends 1231*858ea5e5SAndroid Build Coastguard Worker * that it is safe to ignore clearing high 32-bit for these instructions. This 1232*858ea5e5SAndroid Build Coastguard Worker * saves some back-ends a lot of code-gen. However such optimization is not 1233*858ea5e5SAndroid Build Coastguard Worker * necessary on some arches, for example x86_64, arm64 etc, whose JIT back-ends 1234*858ea5e5SAndroid Build Coastguard Worker * hence hasn't used verifier's analysis result. But, we really want to have a 1235*858ea5e5SAndroid Build Coastguard Worker * way to be able to verify the correctness of the described optimization on 1236*858ea5e5SAndroid Build Coastguard Worker * x86_64 on which testsuites are frequently exercised. 1237*858ea5e5SAndroid Build Coastguard Worker * 1238*858ea5e5SAndroid Build Coastguard Worker * So, this flag is introduced. Once it is set, verifier will randomize high 1239*858ea5e5SAndroid Build Coastguard Worker * 32-bit for those instructions who has been identified as safe to ignore them. 1240*858ea5e5SAndroid Build Coastguard Worker * Then, if verifier is not doing correct analysis, such randomization will 1241*858ea5e5SAndroid Build Coastguard Worker * regress tests to expose bugs. 1242*858ea5e5SAndroid Build Coastguard Worker */ 1243*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_TEST_RND_HI32 (1U << 2) 1244*858ea5e5SAndroid Build Coastguard Worker 1245*858ea5e5SAndroid Build Coastguard Worker /* The verifier internal test flag. Behavior is undefined */ 1246*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_TEST_STATE_FREQ (1U << 3) 1247*858ea5e5SAndroid Build Coastguard Worker 1248*858ea5e5SAndroid Build Coastguard Worker /* If BPF_F_SLEEPABLE is used in BPF_PROG_LOAD command, the verifier will 1249*858ea5e5SAndroid Build Coastguard Worker * restrict map and helper usage for such programs. Sleepable BPF programs can 1250*858ea5e5SAndroid Build Coastguard Worker * only be attached to hooks where kernel execution context allows sleeping. 1251*858ea5e5SAndroid Build Coastguard Worker * Such programs are allowed to use helpers that may sleep like 1252*858ea5e5SAndroid Build Coastguard Worker * bpf_copy_from_user(). 1253*858ea5e5SAndroid Build Coastguard Worker */ 1254*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_SLEEPABLE (1U << 4) 1255*858ea5e5SAndroid Build Coastguard Worker 1256*858ea5e5SAndroid Build Coastguard Worker /* If BPF_F_XDP_HAS_FRAGS is used in BPF_PROG_LOAD command, the loaded program 1257*858ea5e5SAndroid Build Coastguard Worker * fully support xdp frags. 1258*858ea5e5SAndroid Build Coastguard Worker */ 1259*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_XDP_HAS_FRAGS (1U << 5) 1260*858ea5e5SAndroid Build Coastguard Worker 1261*858ea5e5SAndroid Build Coastguard Worker /* If BPF_F_XDP_DEV_BOUND_ONLY is used in BPF_PROG_LOAD command, the loaded 1262*858ea5e5SAndroid Build Coastguard Worker * program becomes device-bound but can access XDP metadata. 1263*858ea5e5SAndroid Build Coastguard Worker */ 1264*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_XDP_DEV_BOUND_ONLY (1U << 6) 1265*858ea5e5SAndroid Build Coastguard Worker 1266*858ea5e5SAndroid Build Coastguard Worker /* The verifier internal test flag. Behavior is undefined */ 1267*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_TEST_REG_INVARIANTS (1U << 7) 1268*858ea5e5SAndroid Build Coastguard Worker 1269*858ea5e5SAndroid Build Coastguard Worker /* link_create.kprobe_multi.flags used in LINK_CREATE command for 1270*858ea5e5SAndroid Build Coastguard Worker * BPF_TRACE_KPROBE_MULTI attach type to create return probe. 1271*858ea5e5SAndroid Build Coastguard Worker */ 1272*858ea5e5SAndroid Build Coastguard Worker enum { 1273*858ea5e5SAndroid Build Coastguard Worker BPF_F_KPROBE_MULTI_RETURN = (1U << 0) 1274*858ea5e5SAndroid Build Coastguard Worker }; 1275*858ea5e5SAndroid Build Coastguard Worker 1276*858ea5e5SAndroid Build Coastguard Worker /* link_create.uprobe_multi.flags used in LINK_CREATE command for 1277*858ea5e5SAndroid Build Coastguard Worker * BPF_TRACE_UPROBE_MULTI attach type to create return probe. 1278*858ea5e5SAndroid Build Coastguard Worker */ 1279*858ea5e5SAndroid Build Coastguard Worker enum { 1280*858ea5e5SAndroid Build Coastguard Worker BPF_F_UPROBE_MULTI_RETURN = (1U << 0) 1281*858ea5e5SAndroid Build Coastguard Worker }; 1282*858ea5e5SAndroid Build Coastguard Worker 1283*858ea5e5SAndroid Build Coastguard Worker /* link_create.netfilter.flags used in LINK_CREATE command for 1284*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_TYPE_NETFILTER to enable IP packet defragmentation. 1285*858ea5e5SAndroid Build Coastguard Worker */ 1286*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_NETFILTER_IP_DEFRAG (1U << 0) 1287*858ea5e5SAndroid Build Coastguard Worker 1288*858ea5e5SAndroid Build Coastguard Worker /* When BPF ldimm64's insn[0].src_reg != 0 then this can have 1289*858ea5e5SAndroid Build Coastguard Worker * the following extensions: 1290*858ea5e5SAndroid Build Coastguard Worker * 1291*858ea5e5SAndroid Build Coastguard Worker * insn[0].src_reg: BPF_PSEUDO_MAP_[FD|IDX] 1292*858ea5e5SAndroid Build Coastguard Worker * insn[0].imm: map fd or fd_idx 1293*858ea5e5SAndroid Build Coastguard Worker * insn[1].imm: 0 1294*858ea5e5SAndroid Build Coastguard Worker * insn[0].off: 0 1295*858ea5e5SAndroid Build Coastguard Worker * insn[1].off: 0 1296*858ea5e5SAndroid Build Coastguard Worker * ldimm64 rewrite: address of map 1297*858ea5e5SAndroid Build Coastguard Worker * verifier type: CONST_PTR_TO_MAP 1298*858ea5e5SAndroid Build Coastguard Worker */ 1299*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_MAP_FD 1 1300*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_MAP_IDX 5 1301*858ea5e5SAndroid Build Coastguard Worker 1302*858ea5e5SAndroid Build Coastguard Worker /* insn[0].src_reg: BPF_PSEUDO_MAP_[IDX_]VALUE 1303*858ea5e5SAndroid Build Coastguard Worker * insn[0].imm: map fd or fd_idx 1304*858ea5e5SAndroid Build Coastguard Worker * insn[1].imm: offset into value 1305*858ea5e5SAndroid Build Coastguard Worker * insn[0].off: 0 1306*858ea5e5SAndroid Build Coastguard Worker * insn[1].off: 0 1307*858ea5e5SAndroid Build Coastguard Worker * ldimm64 rewrite: address of map[0]+offset 1308*858ea5e5SAndroid Build Coastguard Worker * verifier type: PTR_TO_MAP_VALUE 1309*858ea5e5SAndroid Build Coastguard Worker */ 1310*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_MAP_VALUE 2 1311*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_MAP_IDX_VALUE 6 1312*858ea5e5SAndroid Build Coastguard Worker 1313*858ea5e5SAndroid Build Coastguard Worker /* insn[0].src_reg: BPF_PSEUDO_BTF_ID 1314*858ea5e5SAndroid Build Coastguard Worker * insn[0].imm: kernel btd id of VAR 1315*858ea5e5SAndroid Build Coastguard Worker * insn[1].imm: 0 1316*858ea5e5SAndroid Build Coastguard Worker * insn[0].off: 0 1317*858ea5e5SAndroid Build Coastguard Worker * insn[1].off: 0 1318*858ea5e5SAndroid Build Coastguard Worker * ldimm64 rewrite: address of the kernel variable 1319*858ea5e5SAndroid Build Coastguard Worker * verifier type: PTR_TO_BTF_ID or PTR_TO_MEM, depending on whether the var 1320*858ea5e5SAndroid Build Coastguard Worker * is struct/union. 1321*858ea5e5SAndroid Build Coastguard Worker */ 1322*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_BTF_ID 3 1323*858ea5e5SAndroid Build Coastguard Worker /* insn[0].src_reg: BPF_PSEUDO_FUNC 1324*858ea5e5SAndroid Build Coastguard Worker * insn[0].imm: insn offset to the func 1325*858ea5e5SAndroid Build Coastguard Worker * insn[1].imm: 0 1326*858ea5e5SAndroid Build Coastguard Worker * insn[0].off: 0 1327*858ea5e5SAndroid Build Coastguard Worker * insn[1].off: 0 1328*858ea5e5SAndroid Build Coastguard Worker * ldimm64 rewrite: address of the function 1329*858ea5e5SAndroid Build Coastguard Worker * verifier type: PTR_TO_FUNC. 1330*858ea5e5SAndroid Build Coastguard Worker */ 1331*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_FUNC 4 1332*858ea5e5SAndroid Build Coastguard Worker 1333*858ea5e5SAndroid Build Coastguard Worker /* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative 1334*858ea5e5SAndroid Build Coastguard Worker * offset to another bpf function 1335*858ea5e5SAndroid Build Coastguard Worker */ 1336*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_CALL 1 1337*858ea5e5SAndroid Build Coastguard Worker /* when bpf_call->src_reg == BPF_PSEUDO_KFUNC_CALL, 1338*858ea5e5SAndroid Build Coastguard Worker * bpf_call->imm == btf_id of a BTF_KIND_FUNC in the running kernel 1339*858ea5e5SAndroid Build Coastguard Worker */ 1340*858ea5e5SAndroid Build Coastguard Worker #define BPF_PSEUDO_KFUNC_CALL 2 1341*858ea5e5SAndroid Build Coastguard Worker 1342*858ea5e5SAndroid Build Coastguard Worker enum bpf_addr_space_cast { 1343*858ea5e5SAndroid Build Coastguard Worker BPF_ADDR_SPACE_CAST = 1, 1344*858ea5e5SAndroid Build Coastguard Worker }; 1345*858ea5e5SAndroid Build Coastguard Worker 1346*858ea5e5SAndroid Build Coastguard Worker /* flags for BPF_MAP_UPDATE_ELEM command */ 1347*858ea5e5SAndroid Build Coastguard Worker enum { 1348*858ea5e5SAndroid Build Coastguard Worker BPF_ANY = 0, /* create new element or update existing */ 1349*858ea5e5SAndroid Build Coastguard Worker BPF_NOEXIST = 1, /* create new element if it didn't exist */ 1350*858ea5e5SAndroid Build Coastguard Worker BPF_EXIST = 2, /* update existing element */ 1351*858ea5e5SAndroid Build Coastguard Worker BPF_F_LOCK = 4, /* spin_lock-ed map_lookup/map_update */ 1352*858ea5e5SAndroid Build Coastguard Worker }; 1353*858ea5e5SAndroid Build Coastguard Worker 1354*858ea5e5SAndroid Build Coastguard Worker /* flags for BPF_MAP_CREATE command */ 1355*858ea5e5SAndroid Build Coastguard Worker enum { 1356*858ea5e5SAndroid Build Coastguard Worker BPF_F_NO_PREALLOC = (1U << 0), 1357*858ea5e5SAndroid Build Coastguard Worker /* Instead of having one common LRU list in the 1358*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list 1359*858ea5e5SAndroid Build Coastguard Worker * which can scale and perform better. 1360*858ea5e5SAndroid Build Coastguard Worker * Note, the LRU nodes (including free nodes) cannot be moved 1361*858ea5e5SAndroid Build Coastguard Worker * across different LRU lists. 1362*858ea5e5SAndroid Build Coastguard Worker */ 1363*858ea5e5SAndroid Build Coastguard Worker BPF_F_NO_COMMON_LRU = (1U << 1), 1364*858ea5e5SAndroid Build Coastguard Worker /* Specify numa node during map creation */ 1365*858ea5e5SAndroid Build Coastguard Worker BPF_F_NUMA_NODE = (1U << 2), 1366*858ea5e5SAndroid Build Coastguard Worker 1367*858ea5e5SAndroid Build Coastguard Worker /* Flags for accessing BPF object from syscall side. */ 1368*858ea5e5SAndroid Build Coastguard Worker BPF_F_RDONLY = (1U << 3), 1369*858ea5e5SAndroid Build Coastguard Worker BPF_F_WRONLY = (1U << 4), 1370*858ea5e5SAndroid Build Coastguard Worker 1371*858ea5e5SAndroid Build Coastguard Worker /* Flag for stack_map, store build_id+offset instead of pointer */ 1372*858ea5e5SAndroid Build Coastguard Worker BPF_F_STACK_BUILD_ID = (1U << 5), 1373*858ea5e5SAndroid Build Coastguard Worker 1374*858ea5e5SAndroid Build Coastguard Worker /* Zero-initialize hash function seed. This should only be used for testing. */ 1375*858ea5e5SAndroid Build Coastguard Worker BPF_F_ZERO_SEED = (1U << 6), 1376*858ea5e5SAndroid Build Coastguard Worker 1377*858ea5e5SAndroid Build Coastguard Worker /* Flags for accessing BPF object from program side. */ 1378*858ea5e5SAndroid Build Coastguard Worker BPF_F_RDONLY_PROG = (1U << 7), 1379*858ea5e5SAndroid Build Coastguard Worker BPF_F_WRONLY_PROG = (1U << 8), 1380*858ea5e5SAndroid Build Coastguard Worker 1381*858ea5e5SAndroid Build Coastguard Worker /* Clone map from listener for newly accepted socket */ 1382*858ea5e5SAndroid Build Coastguard Worker BPF_F_CLONE = (1U << 9), 1383*858ea5e5SAndroid Build Coastguard Worker 1384*858ea5e5SAndroid Build Coastguard Worker /* Enable memory-mapping BPF map */ 1385*858ea5e5SAndroid Build Coastguard Worker BPF_F_MMAPABLE = (1U << 10), 1386*858ea5e5SAndroid Build Coastguard Worker 1387*858ea5e5SAndroid Build Coastguard Worker /* Share perf_event among processes */ 1388*858ea5e5SAndroid Build Coastguard Worker BPF_F_PRESERVE_ELEMS = (1U << 11), 1389*858ea5e5SAndroid Build Coastguard Worker 1390*858ea5e5SAndroid Build Coastguard Worker /* Create a map that is suitable to be an inner map with dynamic max entries */ 1391*858ea5e5SAndroid Build Coastguard Worker BPF_F_INNER_MAP = (1U << 12), 1392*858ea5e5SAndroid Build Coastguard Worker 1393*858ea5e5SAndroid Build Coastguard Worker /* Create a map that will be registered/unregesitered by the backed bpf_link */ 1394*858ea5e5SAndroid Build Coastguard Worker BPF_F_LINK = (1U << 13), 1395*858ea5e5SAndroid Build Coastguard Worker 1396*858ea5e5SAndroid Build Coastguard Worker /* Get path from provided FD in BPF_OBJ_PIN/BPF_OBJ_GET commands */ 1397*858ea5e5SAndroid Build Coastguard Worker BPF_F_PATH_FD = (1U << 14), 1398*858ea5e5SAndroid Build Coastguard Worker 1399*858ea5e5SAndroid Build Coastguard Worker /* Flag for value_type_btf_obj_fd, the fd is available */ 1400*858ea5e5SAndroid Build Coastguard Worker BPF_F_VTYPE_BTF_OBJ_FD = (1U << 15), 1401*858ea5e5SAndroid Build Coastguard Worker 1402*858ea5e5SAndroid Build Coastguard Worker /* BPF token FD is passed in a corresponding command's token_fd field */ 1403*858ea5e5SAndroid Build Coastguard Worker BPF_F_TOKEN_FD = (1U << 16), 1404*858ea5e5SAndroid Build Coastguard Worker 1405*858ea5e5SAndroid Build Coastguard Worker /* When user space page faults in bpf_arena send SIGSEGV instead of inserting new page */ 1406*858ea5e5SAndroid Build Coastguard Worker BPF_F_SEGV_ON_FAULT = (1U << 17), 1407*858ea5e5SAndroid Build Coastguard Worker 1408*858ea5e5SAndroid Build Coastguard Worker /* Do not translate kernel bpf_arena pointers to user pointers */ 1409*858ea5e5SAndroid Build Coastguard Worker BPF_F_NO_USER_CONV = (1U << 18), 1410*858ea5e5SAndroid Build Coastguard Worker }; 1411*858ea5e5SAndroid Build Coastguard Worker 1412*858ea5e5SAndroid Build Coastguard Worker /* Flags for BPF_PROG_QUERY. */ 1413*858ea5e5SAndroid Build Coastguard Worker 1414*858ea5e5SAndroid Build Coastguard Worker /* Query effective (directly attached + inherited from ancestor cgroups) 1415*858ea5e5SAndroid Build Coastguard Worker * programs that will be executed for events within a cgroup. 1416*858ea5e5SAndroid Build Coastguard Worker * attach_flags with this flag are always returned 0. 1417*858ea5e5SAndroid Build Coastguard Worker */ 1418*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_QUERY_EFFECTIVE (1U << 0) 1419*858ea5e5SAndroid Build Coastguard Worker 1420*858ea5e5SAndroid Build Coastguard Worker /* Flags for BPF_PROG_TEST_RUN */ 1421*858ea5e5SAndroid Build Coastguard Worker 1422*858ea5e5SAndroid Build Coastguard Worker /* If set, run the test on the cpu specified by bpf_attr.test.cpu */ 1423*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_TEST_RUN_ON_CPU (1U << 0) 1424*858ea5e5SAndroid Build Coastguard Worker /* If set, XDP frames will be transmitted after processing */ 1425*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_TEST_XDP_LIVE_FRAMES (1U << 1) 1426*858ea5e5SAndroid Build Coastguard Worker 1427*858ea5e5SAndroid Build Coastguard Worker /* type for BPF_ENABLE_STATS */ 1428*858ea5e5SAndroid Build Coastguard Worker enum bpf_stats_type { 1429*858ea5e5SAndroid Build Coastguard Worker /* enabled run_time_ns and run_cnt */ 1430*858ea5e5SAndroid Build Coastguard Worker BPF_STATS_RUN_TIME = 0, 1431*858ea5e5SAndroid Build Coastguard Worker }; 1432*858ea5e5SAndroid Build Coastguard Worker 1433*858ea5e5SAndroid Build Coastguard Worker enum bpf_stack_build_id_status { 1434*858ea5e5SAndroid Build Coastguard Worker /* user space need an empty entry to identify end of a trace */ 1435*858ea5e5SAndroid Build Coastguard Worker BPF_STACK_BUILD_ID_EMPTY = 0, 1436*858ea5e5SAndroid Build Coastguard Worker /* with valid build_id and offset */ 1437*858ea5e5SAndroid Build Coastguard Worker BPF_STACK_BUILD_ID_VALID = 1, 1438*858ea5e5SAndroid Build Coastguard Worker /* couldn't get build_id, fallback to ip */ 1439*858ea5e5SAndroid Build Coastguard Worker BPF_STACK_BUILD_ID_IP = 2, 1440*858ea5e5SAndroid Build Coastguard Worker }; 1441*858ea5e5SAndroid Build Coastguard Worker 1442*858ea5e5SAndroid Build Coastguard Worker #define BPF_BUILD_ID_SIZE 20 1443*858ea5e5SAndroid Build Coastguard Worker struct bpf_stack_build_id { 1444*858ea5e5SAndroid Build Coastguard Worker __s32 status; 1445*858ea5e5SAndroid Build Coastguard Worker unsigned char build_id[BPF_BUILD_ID_SIZE]; 1446*858ea5e5SAndroid Build Coastguard Worker union { 1447*858ea5e5SAndroid Build Coastguard Worker __u64 offset; 1448*858ea5e5SAndroid Build Coastguard Worker __u64 ip; 1449*858ea5e5SAndroid Build Coastguard Worker }; 1450*858ea5e5SAndroid Build Coastguard Worker }; 1451*858ea5e5SAndroid Build Coastguard Worker 1452*858ea5e5SAndroid Build Coastguard Worker #define BPF_OBJ_NAME_LEN 16U 1453*858ea5e5SAndroid Build Coastguard Worker 1454*858ea5e5SAndroid Build Coastguard Worker union bpf_attr { 1455*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_MAP_CREATE command */ 1456*858ea5e5SAndroid Build Coastguard Worker __u32 map_type; /* one of enum bpf_map_type */ 1457*858ea5e5SAndroid Build Coastguard Worker __u32 key_size; /* size of key in bytes */ 1458*858ea5e5SAndroid Build Coastguard Worker __u32 value_size; /* size of value in bytes */ 1459*858ea5e5SAndroid Build Coastguard Worker __u32 max_entries; /* max number of entries in a map */ 1460*858ea5e5SAndroid Build Coastguard Worker __u32 map_flags; /* BPF_MAP_CREATE related 1461*858ea5e5SAndroid Build Coastguard Worker * flags defined above. 1462*858ea5e5SAndroid Build Coastguard Worker */ 1463*858ea5e5SAndroid Build Coastguard Worker __u32 inner_map_fd; /* fd pointing to the inner map */ 1464*858ea5e5SAndroid Build Coastguard Worker __u32 numa_node; /* numa node (effective only if 1465*858ea5e5SAndroid Build Coastguard Worker * BPF_F_NUMA_NODE is set). 1466*858ea5e5SAndroid Build Coastguard Worker */ 1467*858ea5e5SAndroid Build Coastguard Worker char map_name[BPF_OBJ_NAME_LEN]; 1468*858ea5e5SAndroid Build Coastguard Worker __u32 map_ifindex; /* ifindex of netdev to create on */ 1469*858ea5e5SAndroid Build Coastguard Worker __u32 btf_fd; /* fd pointing to a BTF type data */ 1470*858ea5e5SAndroid Build Coastguard Worker __u32 btf_key_type_id; /* BTF type_id of the key */ 1471*858ea5e5SAndroid Build Coastguard Worker __u32 btf_value_type_id; /* BTF type_id of the value */ 1472*858ea5e5SAndroid Build Coastguard Worker __u32 btf_vmlinux_value_type_id;/* BTF type_id of a kernel- 1473*858ea5e5SAndroid Build Coastguard Worker * struct stored as the 1474*858ea5e5SAndroid Build Coastguard Worker * map value 1475*858ea5e5SAndroid Build Coastguard Worker */ 1476*858ea5e5SAndroid Build Coastguard Worker /* Any per-map-type extra fields 1477*858ea5e5SAndroid Build Coastguard Worker * 1478*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_BLOOM_FILTER - the lowest 4 bits indicate the 1479*858ea5e5SAndroid Build Coastguard Worker * number of hash functions (if 0, the bloom filter will default 1480*858ea5e5SAndroid Build Coastguard Worker * to using 5 hash functions). 1481*858ea5e5SAndroid Build Coastguard Worker * 1482*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_ARENA - contains the address where user space 1483*858ea5e5SAndroid Build Coastguard Worker * is going to mmap() the arena. It has to be page aligned. 1484*858ea5e5SAndroid Build Coastguard Worker */ 1485*858ea5e5SAndroid Build Coastguard Worker __u64 map_extra; 1486*858ea5e5SAndroid Build Coastguard Worker 1487*858ea5e5SAndroid Build Coastguard Worker __s32 value_type_btf_obj_fd; /* fd pointing to a BTF 1488*858ea5e5SAndroid Build Coastguard Worker * type data for 1489*858ea5e5SAndroid Build Coastguard Worker * btf_vmlinux_value_type_id. 1490*858ea5e5SAndroid Build Coastguard Worker */ 1491*858ea5e5SAndroid Build Coastguard Worker /* BPF token FD to use with BPF_MAP_CREATE operation. 1492*858ea5e5SAndroid Build Coastguard Worker * If provided, map_flags should have BPF_F_TOKEN_FD flag set. 1493*858ea5e5SAndroid Build Coastguard Worker */ 1494*858ea5e5SAndroid Build Coastguard Worker __s32 map_token_fd; 1495*858ea5e5SAndroid Build Coastguard Worker }; 1496*858ea5e5SAndroid Build Coastguard Worker 1497*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ 1498*858ea5e5SAndroid Build Coastguard Worker __u32 map_fd; 1499*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 key; 1500*858ea5e5SAndroid Build Coastguard Worker union { 1501*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 value; 1502*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 next_key; 1503*858ea5e5SAndroid Build Coastguard Worker }; 1504*858ea5e5SAndroid Build Coastguard Worker __u64 flags; 1505*858ea5e5SAndroid Build Coastguard Worker }; 1506*858ea5e5SAndroid Build Coastguard Worker 1507*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_MAP_*_BATCH commands */ 1508*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 in_batch; /* start batch, 1509*858ea5e5SAndroid Build Coastguard Worker * NULL to start from beginning 1510*858ea5e5SAndroid Build Coastguard Worker */ 1511*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 out_batch; /* output: next start batch */ 1512*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 keys; 1513*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 values; 1514*858ea5e5SAndroid Build Coastguard Worker __u32 count; /* input/output: 1515*858ea5e5SAndroid Build Coastguard Worker * input: # of key/value 1516*858ea5e5SAndroid Build Coastguard Worker * elements 1517*858ea5e5SAndroid Build Coastguard Worker * output: # of filled elements 1518*858ea5e5SAndroid Build Coastguard Worker */ 1519*858ea5e5SAndroid Build Coastguard Worker __u32 map_fd; 1520*858ea5e5SAndroid Build Coastguard Worker __u64 elem_flags; 1521*858ea5e5SAndroid Build Coastguard Worker __u64 flags; 1522*858ea5e5SAndroid Build Coastguard Worker } batch; 1523*858ea5e5SAndroid Build Coastguard Worker 1524*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_PROG_LOAD command */ 1525*858ea5e5SAndroid Build Coastguard Worker __u32 prog_type; /* one of enum bpf_prog_type */ 1526*858ea5e5SAndroid Build Coastguard Worker __u32 insn_cnt; 1527*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 insns; 1528*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 license; 1529*858ea5e5SAndroid Build Coastguard Worker __u32 log_level; /* verbosity level of verifier */ 1530*858ea5e5SAndroid Build Coastguard Worker __u32 log_size; /* size of user buffer */ 1531*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 log_buf; /* user supplied buffer */ 1532*858ea5e5SAndroid Build Coastguard Worker __u32 kern_version; /* not used */ 1533*858ea5e5SAndroid Build Coastguard Worker __u32 prog_flags; 1534*858ea5e5SAndroid Build Coastguard Worker char prog_name[BPF_OBJ_NAME_LEN]; 1535*858ea5e5SAndroid Build Coastguard Worker __u32 prog_ifindex; /* ifindex of netdev to prep for */ 1536*858ea5e5SAndroid Build Coastguard Worker /* For some prog types expected attach type must be known at 1537*858ea5e5SAndroid Build Coastguard Worker * load time to verify attach type specific parts of prog 1538*858ea5e5SAndroid Build Coastguard Worker * (context accesses, allowed helpers, etc). 1539*858ea5e5SAndroid Build Coastguard Worker */ 1540*858ea5e5SAndroid Build Coastguard Worker __u32 expected_attach_type; 1541*858ea5e5SAndroid Build Coastguard Worker __u32 prog_btf_fd; /* fd pointing to BTF type data */ 1542*858ea5e5SAndroid Build Coastguard Worker __u32 func_info_rec_size; /* userspace bpf_func_info size */ 1543*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 func_info; /* func info */ 1544*858ea5e5SAndroid Build Coastguard Worker __u32 func_info_cnt; /* number of bpf_func_info records */ 1545*858ea5e5SAndroid Build Coastguard Worker __u32 line_info_rec_size; /* userspace bpf_line_info size */ 1546*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 line_info; /* line info */ 1547*858ea5e5SAndroid Build Coastguard Worker __u32 line_info_cnt; /* number of bpf_line_info records */ 1548*858ea5e5SAndroid Build Coastguard Worker __u32 attach_btf_id; /* in-kernel BTF type id to attach to */ 1549*858ea5e5SAndroid Build Coastguard Worker union { 1550*858ea5e5SAndroid Build Coastguard Worker /* valid prog_fd to attach to bpf prog */ 1551*858ea5e5SAndroid Build Coastguard Worker __u32 attach_prog_fd; 1552*858ea5e5SAndroid Build Coastguard Worker /* or valid module BTF object fd or 0 to attach to vmlinux */ 1553*858ea5e5SAndroid Build Coastguard Worker __u32 attach_btf_obj_fd; 1554*858ea5e5SAndroid Build Coastguard Worker }; 1555*858ea5e5SAndroid Build Coastguard Worker __u32 core_relo_cnt; /* number of bpf_core_relo */ 1556*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 fd_array; /* array of FDs */ 1557*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 core_relos; 1558*858ea5e5SAndroid Build Coastguard Worker __u32 core_relo_rec_size; /* sizeof(struct bpf_core_relo) */ 1559*858ea5e5SAndroid Build Coastguard Worker /* output: actual total log contents size (including termintaing zero). 1560*858ea5e5SAndroid Build Coastguard Worker * It could be both larger than original log_size (if log was 1561*858ea5e5SAndroid Build Coastguard Worker * truncated), or smaller (if log buffer wasn't filled completely). 1562*858ea5e5SAndroid Build Coastguard Worker */ 1563*858ea5e5SAndroid Build Coastguard Worker __u32 log_true_size; 1564*858ea5e5SAndroid Build Coastguard Worker /* BPF token FD to use with BPF_PROG_LOAD operation. 1565*858ea5e5SAndroid Build Coastguard Worker * If provided, prog_flags should have BPF_F_TOKEN_FD flag set. 1566*858ea5e5SAndroid Build Coastguard Worker */ 1567*858ea5e5SAndroid Build Coastguard Worker __s32 prog_token_fd; 1568*858ea5e5SAndroid Build Coastguard Worker }; 1569*858ea5e5SAndroid Build Coastguard Worker 1570*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_OBJ_* commands */ 1571*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 pathname; 1572*858ea5e5SAndroid Build Coastguard Worker __u32 bpf_fd; 1573*858ea5e5SAndroid Build Coastguard Worker __u32 file_flags; 1574*858ea5e5SAndroid Build Coastguard Worker /* Same as dirfd in openat() syscall; see openat(2) 1575*858ea5e5SAndroid Build Coastguard Worker * manpage for details of path FD and pathname semantics; 1576*858ea5e5SAndroid Build Coastguard Worker * path_fd should accompanied by BPF_F_PATH_FD flag set in 1577*858ea5e5SAndroid Build Coastguard Worker * file_flags field, otherwise it should be set to zero; 1578*858ea5e5SAndroid Build Coastguard Worker * if BPF_F_PATH_FD flag is not set, AT_FDCWD is assumed. 1579*858ea5e5SAndroid Build Coastguard Worker */ 1580*858ea5e5SAndroid Build Coastguard Worker __s32 path_fd; 1581*858ea5e5SAndroid Build Coastguard Worker }; 1582*858ea5e5SAndroid Build Coastguard Worker 1583*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */ 1584*858ea5e5SAndroid Build Coastguard Worker union { 1585*858ea5e5SAndroid Build Coastguard Worker __u32 target_fd; /* target object to attach to or ... */ 1586*858ea5e5SAndroid Build Coastguard Worker __u32 target_ifindex; /* target ifindex */ 1587*858ea5e5SAndroid Build Coastguard Worker }; 1588*858ea5e5SAndroid Build Coastguard Worker __u32 attach_bpf_fd; 1589*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 1590*858ea5e5SAndroid Build Coastguard Worker __u32 attach_flags; 1591*858ea5e5SAndroid Build Coastguard Worker __u32 replace_bpf_fd; 1592*858ea5e5SAndroid Build Coastguard Worker union { 1593*858ea5e5SAndroid Build Coastguard Worker __u32 relative_fd; 1594*858ea5e5SAndroid Build Coastguard Worker __u32 relative_id; 1595*858ea5e5SAndroid Build Coastguard Worker }; 1596*858ea5e5SAndroid Build Coastguard Worker __u64 expected_revision; 1597*858ea5e5SAndroid Build Coastguard Worker }; 1598*858ea5e5SAndroid Build Coastguard Worker 1599*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */ 1600*858ea5e5SAndroid Build Coastguard Worker __u32 prog_fd; 1601*858ea5e5SAndroid Build Coastguard Worker __u32 retval; 1602*858ea5e5SAndroid Build Coastguard Worker __u32 data_size_in; /* input: len of data_in */ 1603*858ea5e5SAndroid Build Coastguard Worker __u32 data_size_out; /* input/output: len of data_out 1604*858ea5e5SAndroid Build Coastguard Worker * returns ENOSPC if data_out 1605*858ea5e5SAndroid Build Coastguard Worker * is too small. 1606*858ea5e5SAndroid Build Coastguard Worker */ 1607*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 data_in; 1608*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 data_out; 1609*858ea5e5SAndroid Build Coastguard Worker __u32 repeat; 1610*858ea5e5SAndroid Build Coastguard Worker __u32 duration; 1611*858ea5e5SAndroid Build Coastguard Worker __u32 ctx_size_in; /* input: len of ctx_in */ 1612*858ea5e5SAndroid Build Coastguard Worker __u32 ctx_size_out; /* input/output: len of ctx_out 1613*858ea5e5SAndroid Build Coastguard Worker * returns ENOSPC if ctx_out 1614*858ea5e5SAndroid Build Coastguard Worker * is too small. 1615*858ea5e5SAndroid Build Coastguard Worker */ 1616*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 ctx_in; 1617*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 ctx_out; 1618*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 1619*858ea5e5SAndroid Build Coastguard Worker __u32 cpu; 1620*858ea5e5SAndroid Build Coastguard Worker __u32 batch_size; 1621*858ea5e5SAndroid Build Coastguard Worker } test; 1622*858ea5e5SAndroid Build Coastguard Worker 1623*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_*_GET_*_ID */ 1624*858ea5e5SAndroid Build Coastguard Worker union { 1625*858ea5e5SAndroid Build Coastguard Worker __u32 start_id; 1626*858ea5e5SAndroid Build Coastguard Worker __u32 prog_id; 1627*858ea5e5SAndroid Build Coastguard Worker __u32 map_id; 1628*858ea5e5SAndroid Build Coastguard Worker __u32 btf_id; 1629*858ea5e5SAndroid Build Coastguard Worker __u32 link_id; 1630*858ea5e5SAndroid Build Coastguard Worker }; 1631*858ea5e5SAndroid Build Coastguard Worker __u32 next_id; 1632*858ea5e5SAndroid Build Coastguard Worker __u32 open_flags; 1633*858ea5e5SAndroid Build Coastguard Worker }; 1634*858ea5e5SAndroid Build Coastguard Worker 1635*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */ 1636*858ea5e5SAndroid Build Coastguard Worker __u32 bpf_fd; 1637*858ea5e5SAndroid Build Coastguard Worker __u32 info_len; 1638*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 info; 1639*858ea5e5SAndroid Build Coastguard Worker } info; 1640*858ea5e5SAndroid Build Coastguard Worker 1641*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_PROG_QUERY command */ 1642*858ea5e5SAndroid Build Coastguard Worker union { 1643*858ea5e5SAndroid Build Coastguard Worker __u32 target_fd; /* target object to query or ... */ 1644*858ea5e5SAndroid Build Coastguard Worker __u32 target_ifindex; /* target ifindex */ 1645*858ea5e5SAndroid Build Coastguard Worker }; 1646*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 1647*858ea5e5SAndroid Build Coastguard Worker __u32 query_flags; 1648*858ea5e5SAndroid Build Coastguard Worker __u32 attach_flags; 1649*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 prog_ids; 1650*858ea5e5SAndroid Build Coastguard Worker union { 1651*858ea5e5SAndroid Build Coastguard Worker __u32 prog_cnt; 1652*858ea5e5SAndroid Build Coastguard Worker __u32 count; 1653*858ea5e5SAndroid Build Coastguard Worker }; 1654*858ea5e5SAndroid Build Coastguard Worker __u32 :32; 1655*858ea5e5SAndroid Build Coastguard Worker /* output: per-program attach_flags. 1656*858ea5e5SAndroid Build Coastguard Worker * not allowed to be set during effective query. 1657*858ea5e5SAndroid Build Coastguard Worker */ 1658*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 prog_attach_flags; 1659*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 link_ids; 1660*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 link_attach_flags; 1661*858ea5e5SAndroid Build Coastguard Worker __u64 revision; 1662*858ea5e5SAndroid Build Coastguard Worker } query; 1663*858ea5e5SAndroid Build Coastguard Worker 1664*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct used by BPF_RAW_TRACEPOINT_OPEN command */ 1665*858ea5e5SAndroid Build Coastguard Worker __u64 name; 1666*858ea5e5SAndroid Build Coastguard Worker __u32 prog_fd; 1667*858ea5e5SAndroid Build Coastguard Worker __u32 :32; 1668*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 cookie; 1669*858ea5e5SAndroid Build Coastguard Worker } raw_tracepoint; 1670*858ea5e5SAndroid Build Coastguard Worker 1671*858ea5e5SAndroid Build Coastguard Worker struct { /* anonymous struct for BPF_BTF_LOAD */ 1672*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 btf; 1673*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 btf_log_buf; 1674*858ea5e5SAndroid Build Coastguard Worker __u32 btf_size; 1675*858ea5e5SAndroid Build Coastguard Worker __u32 btf_log_size; 1676*858ea5e5SAndroid Build Coastguard Worker __u32 btf_log_level; 1677*858ea5e5SAndroid Build Coastguard Worker /* output: actual total log contents size (including termintaing zero). 1678*858ea5e5SAndroid Build Coastguard Worker * It could be both larger than original log_size (if log was 1679*858ea5e5SAndroid Build Coastguard Worker * truncated), or smaller (if log buffer wasn't filled completely). 1680*858ea5e5SAndroid Build Coastguard Worker */ 1681*858ea5e5SAndroid Build Coastguard Worker __u32 btf_log_true_size; 1682*858ea5e5SAndroid Build Coastguard Worker __u32 btf_flags; 1683*858ea5e5SAndroid Build Coastguard Worker /* BPF token FD to use with BPF_BTF_LOAD operation. 1684*858ea5e5SAndroid Build Coastguard Worker * If provided, btf_flags should have BPF_F_TOKEN_FD flag set. 1685*858ea5e5SAndroid Build Coastguard Worker */ 1686*858ea5e5SAndroid Build Coastguard Worker __s32 btf_token_fd; 1687*858ea5e5SAndroid Build Coastguard Worker }; 1688*858ea5e5SAndroid Build Coastguard Worker 1689*858ea5e5SAndroid Build Coastguard Worker struct { 1690*858ea5e5SAndroid Build Coastguard Worker __u32 pid; /* input: pid */ 1691*858ea5e5SAndroid Build Coastguard Worker __u32 fd; /* input: fd */ 1692*858ea5e5SAndroid Build Coastguard Worker __u32 flags; /* input: flags */ 1693*858ea5e5SAndroid Build Coastguard Worker __u32 buf_len; /* input/output: buf len */ 1694*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 buf; /* input/output: 1695*858ea5e5SAndroid Build Coastguard Worker * tp_name for tracepoint 1696*858ea5e5SAndroid Build Coastguard Worker * symbol for kprobe 1697*858ea5e5SAndroid Build Coastguard Worker * filename for uprobe 1698*858ea5e5SAndroid Build Coastguard Worker */ 1699*858ea5e5SAndroid Build Coastguard Worker __u32 prog_id; /* output: prod_id */ 1700*858ea5e5SAndroid Build Coastguard Worker __u32 fd_type; /* output: BPF_FD_TYPE_* */ 1701*858ea5e5SAndroid Build Coastguard Worker __u64 probe_offset; /* output: probe_offset */ 1702*858ea5e5SAndroid Build Coastguard Worker __u64 probe_addr; /* output: probe_addr */ 1703*858ea5e5SAndroid Build Coastguard Worker } task_fd_query; 1704*858ea5e5SAndroid Build Coastguard Worker 1705*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_LINK_CREATE command */ 1706*858ea5e5SAndroid Build Coastguard Worker union { 1707*858ea5e5SAndroid Build Coastguard Worker __u32 prog_fd; /* eBPF program to attach */ 1708*858ea5e5SAndroid Build Coastguard Worker __u32 map_fd; /* struct_ops to attach */ 1709*858ea5e5SAndroid Build Coastguard Worker }; 1710*858ea5e5SAndroid Build Coastguard Worker union { 1711*858ea5e5SAndroid Build Coastguard Worker __u32 target_fd; /* target object to attach to or ... */ 1712*858ea5e5SAndroid Build Coastguard Worker __u32 target_ifindex; /* target ifindex */ 1713*858ea5e5SAndroid Build Coastguard Worker }; 1714*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; /* attach type */ 1715*858ea5e5SAndroid Build Coastguard Worker __u32 flags; /* extra flags */ 1716*858ea5e5SAndroid Build Coastguard Worker union { 1717*858ea5e5SAndroid Build Coastguard Worker __u32 target_btf_id; /* btf_id of target to attach to */ 1718*858ea5e5SAndroid Build Coastguard Worker struct { 1719*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 iter_info; /* extra bpf_iter_link_info */ 1720*858ea5e5SAndroid Build Coastguard Worker __u32 iter_info_len; /* iter_info length */ 1721*858ea5e5SAndroid Build Coastguard Worker }; 1722*858ea5e5SAndroid Build Coastguard Worker struct { 1723*858ea5e5SAndroid Build Coastguard Worker /* black box user-provided value passed through 1724*858ea5e5SAndroid Build Coastguard Worker * to BPF program at the execution time and 1725*858ea5e5SAndroid Build Coastguard Worker * accessible through bpf_get_attach_cookie() BPF helper 1726*858ea5e5SAndroid Build Coastguard Worker */ 1727*858ea5e5SAndroid Build Coastguard Worker __u64 bpf_cookie; 1728*858ea5e5SAndroid Build Coastguard Worker } perf_event; 1729*858ea5e5SAndroid Build Coastguard Worker struct { 1730*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 1731*858ea5e5SAndroid Build Coastguard Worker __u32 cnt; 1732*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 syms; 1733*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 addrs; 1734*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 cookies; 1735*858ea5e5SAndroid Build Coastguard Worker } kprobe_multi; 1736*858ea5e5SAndroid Build Coastguard Worker struct { 1737*858ea5e5SAndroid Build Coastguard Worker /* this is overlaid with the target_btf_id above. */ 1738*858ea5e5SAndroid Build Coastguard Worker __u32 target_btf_id; 1739*858ea5e5SAndroid Build Coastguard Worker /* black box user-provided value passed through 1740*858ea5e5SAndroid Build Coastguard Worker * to BPF program at the execution time and 1741*858ea5e5SAndroid Build Coastguard Worker * accessible through bpf_get_attach_cookie() BPF helper 1742*858ea5e5SAndroid Build Coastguard Worker */ 1743*858ea5e5SAndroid Build Coastguard Worker __u64 cookie; 1744*858ea5e5SAndroid Build Coastguard Worker } tracing; 1745*858ea5e5SAndroid Build Coastguard Worker struct { 1746*858ea5e5SAndroid Build Coastguard Worker __u32 pf; 1747*858ea5e5SAndroid Build Coastguard Worker __u32 hooknum; 1748*858ea5e5SAndroid Build Coastguard Worker __s32 priority; 1749*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 1750*858ea5e5SAndroid Build Coastguard Worker } netfilter; 1751*858ea5e5SAndroid Build Coastguard Worker struct { 1752*858ea5e5SAndroid Build Coastguard Worker union { 1753*858ea5e5SAndroid Build Coastguard Worker __u32 relative_fd; 1754*858ea5e5SAndroid Build Coastguard Worker __u32 relative_id; 1755*858ea5e5SAndroid Build Coastguard Worker }; 1756*858ea5e5SAndroid Build Coastguard Worker __u64 expected_revision; 1757*858ea5e5SAndroid Build Coastguard Worker } tcx; 1758*858ea5e5SAndroid Build Coastguard Worker struct { 1759*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 path; 1760*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 offsets; 1761*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 ref_ctr_offsets; 1762*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 cookies; 1763*858ea5e5SAndroid Build Coastguard Worker __u32 cnt; 1764*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 1765*858ea5e5SAndroid Build Coastguard Worker __u32 pid; 1766*858ea5e5SAndroid Build Coastguard Worker } uprobe_multi; 1767*858ea5e5SAndroid Build Coastguard Worker struct { 1768*858ea5e5SAndroid Build Coastguard Worker union { 1769*858ea5e5SAndroid Build Coastguard Worker __u32 relative_fd; 1770*858ea5e5SAndroid Build Coastguard Worker __u32 relative_id; 1771*858ea5e5SAndroid Build Coastguard Worker }; 1772*858ea5e5SAndroid Build Coastguard Worker __u64 expected_revision; 1773*858ea5e5SAndroid Build Coastguard Worker } netkit; 1774*858ea5e5SAndroid Build Coastguard Worker }; 1775*858ea5e5SAndroid Build Coastguard Worker } link_create; 1776*858ea5e5SAndroid Build Coastguard Worker 1777*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_LINK_UPDATE command */ 1778*858ea5e5SAndroid Build Coastguard Worker __u32 link_fd; /* link fd */ 1779*858ea5e5SAndroid Build Coastguard Worker union { 1780*858ea5e5SAndroid Build Coastguard Worker /* new program fd to update link with */ 1781*858ea5e5SAndroid Build Coastguard Worker __u32 new_prog_fd; 1782*858ea5e5SAndroid Build Coastguard Worker /* new struct_ops map fd to update link with */ 1783*858ea5e5SAndroid Build Coastguard Worker __u32 new_map_fd; 1784*858ea5e5SAndroid Build Coastguard Worker }; 1785*858ea5e5SAndroid Build Coastguard Worker __u32 flags; /* extra flags */ 1786*858ea5e5SAndroid Build Coastguard Worker union { 1787*858ea5e5SAndroid Build Coastguard Worker /* expected link's program fd; is specified only if 1788*858ea5e5SAndroid Build Coastguard Worker * BPF_F_REPLACE flag is set in flags. 1789*858ea5e5SAndroid Build Coastguard Worker */ 1790*858ea5e5SAndroid Build Coastguard Worker __u32 old_prog_fd; 1791*858ea5e5SAndroid Build Coastguard Worker /* expected link's map fd; is specified only 1792*858ea5e5SAndroid Build Coastguard Worker * if BPF_F_REPLACE flag is set. 1793*858ea5e5SAndroid Build Coastguard Worker */ 1794*858ea5e5SAndroid Build Coastguard Worker __u32 old_map_fd; 1795*858ea5e5SAndroid Build Coastguard Worker }; 1796*858ea5e5SAndroid Build Coastguard Worker } link_update; 1797*858ea5e5SAndroid Build Coastguard Worker 1798*858ea5e5SAndroid Build Coastguard Worker struct { 1799*858ea5e5SAndroid Build Coastguard Worker __u32 link_fd; 1800*858ea5e5SAndroid Build Coastguard Worker } link_detach; 1801*858ea5e5SAndroid Build Coastguard Worker 1802*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_ENABLE_STATS command */ 1803*858ea5e5SAndroid Build Coastguard Worker __u32 type; 1804*858ea5e5SAndroid Build Coastguard Worker } enable_stats; 1805*858ea5e5SAndroid Build Coastguard Worker 1806*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_ITER_CREATE command */ 1807*858ea5e5SAndroid Build Coastguard Worker __u32 link_fd; 1808*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 1809*858ea5e5SAndroid Build Coastguard Worker } iter_create; 1810*858ea5e5SAndroid Build Coastguard Worker 1811*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_PROG_BIND_MAP command */ 1812*858ea5e5SAndroid Build Coastguard Worker __u32 prog_fd; 1813*858ea5e5SAndroid Build Coastguard Worker __u32 map_fd; 1814*858ea5e5SAndroid Build Coastguard Worker __u32 flags; /* extra flags */ 1815*858ea5e5SAndroid Build Coastguard Worker } prog_bind_map; 1816*858ea5e5SAndroid Build Coastguard Worker 1817*858ea5e5SAndroid Build Coastguard Worker struct { /* struct used by BPF_TOKEN_CREATE command */ 1818*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 1819*858ea5e5SAndroid Build Coastguard Worker __u32 bpffs_fd; 1820*858ea5e5SAndroid Build Coastguard Worker } token_create; 1821*858ea5e5SAndroid Build Coastguard Worker 1822*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 1823*858ea5e5SAndroid Build Coastguard Worker 1824*858ea5e5SAndroid Build Coastguard Worker /* The description below is an attempt at providing documentation to eBPF 1825*858ea5e5SAndroid Build Coastguard Worker * developers about the multiple available eBPF helper functions. It can be 1826*858ea5e5SAndroid Build Coastguard Worker * parsed and used to produce a manual page. The workflow is the following, 1827*858ea5e5SAndroid Build Coastguard Worker * and requires the rst2man utility: 1828*858ea5e5SAndroid Build Coastguard Worker * 1829*858ea5e5SAndroid Build Coastguard Worker * $ ./scripts/bpf_doc.py \ 1830*858ea5e5SAndroid Build Coastguard Worker * --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst 1831*858ea5e5SAndroid Build Coastguard Worker * $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7 1832*858ea5e5SAndroid Build Coastguard Worker * $ man /tmp/bpf-helpers.7 1833*858ea5e5SAndroid Build Coastguard Worker * 1834*858ea5e5SAndroid Build Coastguard Worker * Note that in order to produce this external documentation, some RST 1835*858ea5e5SAndroid Build Coastguard Worker * formatting is used in the descriptions to get "bold" and "italics" in 1836*858ea5e5SAndroid Build Coastguard Worker * manual pages. Also note that the few trailing white spaces are 1837*858ea5e5SAndroid Build Coastguard Worker * intentional, removing them would break paragraphs for rst2man. 1838*858ea5e5SAndroid Build Coastguard Worker * 1839*858ea5e5SAndroid Build Coastguard Worker * Start of BPF helper function descriptions: 1840*858ea5e5SAndroid Build Coastguard Worker * 1841*858ea5e5SAndroid Build Coastguard Worker * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key) 1842*858ea5e5SAndroid Build Coastguard Worker * Description 1843*858ea5e5SAndroid Build Coastguard Worker * Perform a lookup in *map* for an entry associated to *key*. 1844*858ea5e5SAndroid Build Coastguard Worker * Return 1845*858ea5e5SAndroid Build Coastguard Worker * Map value associated to *key*, or **NULL** if no entry was 1846*858ea5e5SAndroid Build Coastguard Worker * found. 1847*858ea5e5SAndroid Build Coastguard Worker * 1848*858ea5e5SAndroid Build Coastguard Worker * long bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags) 1849*858ea5e5SAndroid Build Coastguard Worker * Description 1850*858ea5e5SAndroid Build Coastguard Worker * Add or update the value of the entry associated to *key* in 1851*858ea5e5SAndroid Build Coastguard Worker * *map* with *value*. *flags* is one of: 1852*858ea5e5SAndroid Build Coastguard Worker * 1853*858ea5e5SAndroid Build Coastguard Worker * **BPF_NOEXIST** 1854*858ea5e5SAndroid Build Coastguard Worker * The entry for *key* must not exist in the map. 1855*858ea5e5SAndroid Build Coastguard Worker * **BPF_EXIST** 1856*858ea5e5SAndroid Build Coastguard Worker * The entry for *key* must already exist in the map. 1857*858ea5e5SAndroid Build Coastguard Worker * **BPF_ANY** 1858*858ea5e5SAndroid Build Coastguard Worker * No condition on the existence of the entry for *key*. 1859*858ea5e5SAndroid Build Coastguard Worker * 1860*858ea5e5SAndroid Build Coastguard Worker * Flag value **BPF_NOEXIST** cannot be used for maps of types 1861*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY** (all 1862*858ea5e5SAndroid Build Coastguard Worker * elements always exist), the helper would return an error. 1863*858ea5e5SAndroid Build Coastguard Worker * Return 1864*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 1865*858ea5e5SAndroid Build Coastguard Worker * 1866*858ea5e5SAndroid Build Coastguard Worker * long bpf_map_delete_elem(struct bpf_map *map, const void *key) 1867*858ea5e5SAndroid Build Coastguard Worker * Description 1868*858ea5e5SAndroid Build Coastguard Worker * Delete entry with *key* from *map*. 1869*858ea5e5SAndroid Build Coastguard Worker * Return 1870*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 1871*858ea5e5SAndroid Build Coastguard Worker * 1872*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_read(void *dst, u32 size, const void *unsafe_ptr) 1873*858ea5e5SAndroid Build Coastguard Worker * Description 1874*858ea5e5SAndroid Build Coastguard Worker * For tracing programs, safely attempt to read *size* bytes from 1875*858ea5e5SAndroid Build Coastguard Worker * kernel space address *unsafe_ptr* and store the data in *dst*. 1876*858ea5e5SAndroid Build Coastguard Worker * 1877*858ea5e5SAndroid Build Coastguard Worker * Generally, use **bpf_probe_read_user**\ () or 1878*858ea5e5SAndroid Build Coastguard Worker * **bpf_probe_read_kernel**\ () instead. 1879*858ea5e5SAndroid Build Coastguard Worker * Return 1880*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 1881*858ea5e5SAndroid Build Coastguard Worker * 1882*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_ktime_get_ns(void) 1883*858ea5e5SAndroid Build Coastguard Worker * Description 1884*858ea5e5SAndroid Build Coastguard Worker * Return the time elapsed since system boot, in nanoseconds. 1885*858ea5e5SAndroid Build Coastguard Worker * Does not include time the system was suspended. 1886*858ea5e5SAndroid Build Coastguard Worker * See: **clock_gettime**\ (**CLOCK_MONOTONIC**) 1887*858ea5e5SAndroid Build Coastguard Worker * Return 1888*858ea5e5SAndroid Build Coastguard Worker * Current *ktime*. 1889*858ea5e5SAndroid Build Coastguard Worker * 1890*858ea5e5SAndroid Build Coastguard Worker * long bpf_trace_printk(const char *fmt, u32 fmt_size, ...) 1891*858ea5e5SAndroid Build Coastguard Worker * Description 1892*858ea5e5SAndroid Build Coastguard Worker * This helper is a "printk()-like" facility for debugging. It 1893*858ea5e5SAndroid Build Coastguard Worker * prints a message defined by format *fmt* (of size *fmt_size*) 1894*858ea5e5SAndroid Build Coastguard Worker * to file *\/sys/kernel/tracing/trace* from TraceFS, if 1895*858ea5e5SAndroid Build Coastguard Worker * available. It can take up to three additional **u64** 1896*858ea5e5SAndroid Build Coastguard Worker * arguments (as an eBPF helpers, the total number of arguments is 1897*858ea5e5SAndroid Build Coastguard Worker * limited to five). 1898*858ea5e5SAndroid Build Coastguard Worker * 1899*858ea5e5SAndroid Build Coastguard Worker * Each time the helper is called, it appends a line to the trace. 1900*858ea5e5SAndroid Build Coastguard Worker * Lines are discarded while *\/sys/kernel/tracing/trace* is 1901*858ea5e5SAndroid Build Coastguard Worker * open, use *\/sys/kernel/tracing/trace_pipe* to avoid this. 1902*858ea5e5SAndroid Build Coastguard Worker * The format of the trace is customizable, and the exact output 1903*858ea5e5SAndroid Build Coastguard Worker * one will get depends on the options set in 1904*858ea5e5SAndroid Build Coastguard Worker * *\/sys/kernel/tracing/trace_options* (see also the 1905*858ea5e5SAndroid Build Coastguard Worker * *README* file under the same directory). However, it usually 1906*858ea5e5SAndroid Build Coastguard Worker * defaults to something like: 1907*858ea5e5SAndroid Build Coastguard Worker * 1908*858ea5e5SAndroid Build Coastguard Worker * :: 1909*858ea5e5SAndroid Build Coastguard Worker * 1910*858ea5e5SAndroid Build Coastguard Worker * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg> 1911*858ea5e5SAndroid Build Coastguard Worker * 1912*858ea5e5SAndroid Build Coastguard Worker * In the above: 1913*858ea5e5SAndroid Build Coastguard Worker * 1914*858ea5e5SAndroid Build Coastguard Worker * * ``telnet`` is the name of the current task. 1915*858ea5e5SAndroid Build Coastguard Worker * * ``470`` is the PID of the current task. 1916*858ea5e5SAndroid Build Coastguard Worker * * ``001`` is the CPU number on which the task is 1917*858ea5e5SAndroid Build Coastguard Worker * running. 1918*858ea5e5SAndroid Build Coastguard Worker * * In ``.N..``, each character refers to a set of 1919*858ea5e5SAndroid Build Coastguard Worker * options (whether irqs are enabled, scheduling 1920*858ea5e5SAndroid Build Coastguard Worker * options, whether hard/softirqs are running, level of 1921*858ea5e5SAndroid Build Coastguard Worker * preempt_disabled respectively). **N** means that 1922*858ea5e5SAndroid Build Coastguard Worker * **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED** 1923*858ea5e5SAndroid Build Coastguard Worker * are set. 1924*858ea5e5SAndroid Build Coastguard Worker * * ``419421.045894`` is a timestamp. 1925*858ea5e5SAndroid Build Coastguard Worker * * ``0x00000001`` is a fake value used by BPF for the 1926*858ea5e5SAndroid Build Coastguard Worker * instruction pointer register. 1927*858ea5e5SAndroid Build Coastguard Worker * * ``<formatted msg>`` is the message formatted with 1928*858ea5e5SAndroid Build Coastguard Worker * *fmt*. 1929*858ea5e5SAndroid Build Coastguard Worker * 1930*858ea5e5SAndroid Build Coastguard Worker * The conversion specifiers supported by *fmt* are similar, but 1931*858ea5e5SAndroid Build Coastguard Worker * more limited than for printk(). They are **%d**, **%i**, 1932*858ea5e5SAndroid Build Coastguard Worker * **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**, 1933*858ea5e5SAndroid Build Coastguard Worker * **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size 1934*858ea5e5SAndroid Build Coastguard Worker * of field, padding with zeroes, etc.) is available, and the 1935*858ea5e5SAndroid Build Coastguard Worker * helper will return **-EINVAL** (but print nothing) if it 1936*858ea5e5SAndroid Build Coastguard Worker * encounters an unknown specifier. 1937*858ea5e5SAndroid Build Coastguard Worker * 1938*858ea5e5SAndroid Build Coastguard Worker * Also, note that **bpf_trace_printk**\ () is slow, and should 1939*858ea5e5SAndroid Build Coastguard Worker * only be used for debugging purposes. For this reason, a notice 1940*858ea5e5SAndroid Build Coastguard Worker * block (spanning several lines) is printed to kernel logs and 1941*858ea5e5SAndroid Build Coastguard Worker * states that the helper should not be used "for production use" 1942*858ea5e5SAndroid Build Coastguard Worker * the first time this helper is used (or more precisely, when 1943*858ea5e5SAndroid Build Coastguard Worker * **trace_printk**\ () buffers are allocated). For passing values 1944*858ea5e5SAndroid Build Coastguard Worker * to user space, perf events should be preferred. 1945*858ea5e5SAndroid Build Coastguard Worker * Return 1946*858ea5e5SAndroid Build Coastguard Worker * The number of bytes written to the buffer, or a negative error 1947*858ea5e5SAndroid Build Coastguard Worker * in case of failure. 1948*858ea5e5SAndroid Build Coastguard Worker * 1949*858ea5e5SAndroid Build Coastguard Worker * u32 bpf_get_prandom_u32(void) 1950*858ea5e5SAndroid Build Coastguard Worker * Description 1951*858ea5e5SAndroid Build Coastguard Worker * Get a pseudo-random number. 1952*858ea5e5SAndroid Build Coastguard Worker * 1953*858ea5e5SAndroid Build Coastguard Worker * From a security point of view, this helper uses its own 1954*858ea5e5SAndroid Build Coastguard Worker * pseudo-random internal state, and cannot be used to infer the 1955*858ea5e5SAndroid Build Coastguard Worker * seed of other random functions in the kernel. However, it is 1956*858ea5e5SAndroid Build Coastguard Worker * essential to note that the generator used by the helper is not 1957*858ea5e5SAndroid Build Coastguard Worker * cryptographically secure. 1958*858ea5e5SAndroid Build Coastguard Worker * Return 1959*858ea5e5SAndroid Build Coastguard Worker * A random 32-bit unsigned value. 1960*858ea5e5SAndroid Build Coastguard Worker * 1961*858ea5e5SAndroid Build Coastguard Worker * u32 bpf_get_smp_processor_id(void) 1962*858ea5e5SAndroid Build Coastguard Worker * Description 1963*858ea5e5SAndroid Build Coastguard Worker * Get the SMP (symmetric multiprocessing) processor id. Note that 1964*858ea5e5SAndroid Build Coastguard Worker * all programs run with migration disabled, which means that the 1965*858ea5e5SAndroid Build Coastguard Worker * SMP processor id is stable during all the execution of the 1966*858ea5e5SAndroid Build Coastguard Worker * program. 1967*858ea5e5SAndroid Build Coastguard Worker * Return 1968*858ea5e5SAndroid Build Coastguard Worker * The SMP id of the processor running the program. 1969*858ea5e5SAndroid Build Coastguard Worker * 1970*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags) 1971*858ea5e5SAndroid Build Coastguard Worker * Description 1972*858ea5e5SAndroid Build Coastguard Worker * Store *len* bytes from address *from* into the packet 1973*858ea5e5SAndroid Build Coastguard Worker * associated to *skb*, at *offset*. *flags* are a combination of 1974*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_RECOMPUTE_CSUM** (automatically recompute the 1975*858ea5e5SAndroid Build Coastguard Worker * checksum for the packet after storing the bytes) and 1976*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\ 1977*858ea5e5SAndroid Build Coastguard Worker * **->swhash** and *skb*\ **->l4hash** to 0). 1978*858ea5e5SAndroid Build Coastguard Worker * 1979*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 1980*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 1981*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 1982*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 1983*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 1984*858ea5e5SAndroid Build Coastguard Worker * Return 1985*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 1986*858ea5e5SAndroid Build Coastguard Worker * 1987*858ea5e5SAndroid Build Coastguard Worker * long bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size) 1988*858ea5e5SAndroid Build Coastguard Worker * Description 1989*858ea5e5SAndroid Build Coastguard Worker * Recompute the layer 3 (e.g. IP) checksum for the packet 1990*858ea5e5SAndroid Build Coastguard Worker * associated to *skb*. Computation is incremental, so the helper 1991*858ea5e5SAndroid Build Coastguard Worker * must know the former value of the header field that was 1992*858ea5e5SAndroid Build Coastguard Worker * modified (*from*), the new value of this field (*to*), and the 1993*858ea5e5SAndroid Build Coastguard Worker * number of bytes (2 or 4) for this field, stored in *size*. 1994*858ea5e5SAndroid Build Coastguard Worker * Alternatively, it is possible to store the difference between 1995*858ea5e5SAndroid Build Coastguard Worker * the previous and the new values of the header field in *to*, by 1996*858ea5e5SAndroid Build Coastguard Worker * setting *from* and *size* to 0. For both methods, *offset* 1997*858ea5e5SAndroid Build Coastguard Worker * indicates the location of the IP checksum within the packet. 1998*858ea5e5SAndroid Build Coastguard Worker * 1999*858ea5e5SAndroid Build Coastguard Worker * This helper works in combination with **bpf_csum_diff**\ (), 2000*858ea5e5SAndroid Build Coastguard Worker * which does not update the checksum in-place, but offers more 2001*858ea5e5SAndroid Build Coastguard Worker * flexibility and can handle sizes larger than 2 or 4 for the 2002*858ea5e5SAndroid Build Coastguard Worker * checksum to update. 2003*858ea5e5SAndroid Build Coastguard Worker * 2004*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2005*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2006*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2007*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2008*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2009*858ea5e5SAndroid Build Coastguard Worker * Return 2010*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2011*858ea5e5SAndroid Build Coastguard Worker * 2012*858ea5e5SAndroid Build Coastguard Worker * long bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags) 2013*858ea5e5SAndroid Build Coastguard Worker * Description 2014*858ea5e5SAndroid Build Coastguard Worker * Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the 2015*858ea5e5SAndroid Build Coastguard Worker * packet associated to *skb*. Computation is incremental, so the 2016*858ea5e5SAndroid Build Coastguard Worker * helper must know the former value of the header field that was 2017*858ea5e5SAndroid Build Coastguard Worker * modified (*from*), the new value of this field (*to*), and the 2018*858ea5e5SAndroid Build Coastguard Worker * number of bytes (2 or 4) for this field, stored on the lowest 2019*858ea5e5SAndroid Build Coastguard Worker * four bits of *flags*. Alternatively, it is possible to store 2020*858ea5e5SAndroid Build Coastguard Worker * the difference between the previous and the new values of the 2021*858ea5e5SAndroid Build Coastguard Worker * header field in *to*, by setting *from* and the four lowest 2022*858ea5e5SAndroid Build Coastguard Worker * bits of *flags* to 0. For both methods, *offset* indicates the 2023*858ea5e5SAndroid Build Coastguard Worker * location of the IP checksum within the packet. In addition to 2024*858ea5e5SAndroid Build Coastguard Worker * the size of the field, *flags* can be added (bitwise OR) actual 2025*858ea5e5SAndroid Build Coastguard Worker * flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left 2026*858ea5e5SAndroid Build Coastguard Worker * untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and 2027*858ea5e5SAndroid Build Coastguard Worker * for updates resulting in a null checksum the value is set to 2028*858ea5e5SAndroid Build Coastguard Worker * **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates 2029*858ea5e5SAndroid Build Coastguard Worker * the checksum is to be computed against a pseudo-header. 2030*858ea5e5SAndroid Build Coastguard Worker * 2031*858ea5e5SAndroid Build Coastguard Worker * This helper works in combination with **bpf_csum_diff**\ (), 2032*858ea5e5SAndroid Build Coastguard Worker * which does not update the checksum in-place, but offers more 2033*858ea5e5SAndroid Build Coastguard Worker * flexibility and can handle sizes larger than 2 or 4 for the 2034*858ea5e5SAndroid Build Coastguard Worker * checksum to update. 2035*858ea5e5SAndroid Build Coastguard Worker * 2036*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2037*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2038*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2039*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2040*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2041*858ea5e5SAndroid Build Coastguard Worker * Return 2042*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2043*858ea5e5SAndroid Build Coastguard Worker * 2044*858ea5e5SAndroid Build Coastguard Worker * long bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index) 2045*858ea5e5SAndroid Build Coastguard Worker * Description 2046*858ea5e5SAndroid Build Coastguard Worker * This special helper is used to trigger a "tail call", or in 2047*858ea5e5SAndroid Build Coastguard Worker * other words, to jump into another eBPF program. The same stack 2048*858ea5e5SAndroid Build Coastguard Worker * frame is used (but values on stack and in registers for the 2049*858ea5e5SAndroid Build Coastguard Worker * caller are not accessible to the callee). This mechanism allows 2050*858ea5e5SAndroid Build Coastguard Worker * for program chaining, either for raising the maximum number of 2051*858ea5e5SAndroid Build Coastguard Worker * available eBPF instructions, or to execute given programs in 2052*858ea5e5SAndroid Build Coastguard Worker * conditional blocks. For security reasons, there is an upper 2053*858ea5e5SAndroid Build Coastguard Worker * limit to the number of successive tail calls that can be 2054*858ea5e5SAndroid Build Coastguard Worker * performed. 2055*858ea5e5SAndroid Build Coastguard Worker * 2056*858ea5e5SAndroid Build Coastguard Worker * Upon call of this helper, the program attempts to jump into a 2057*858ea5e5SAndroid Build Coastguard Worker * program referenced at index *index* in *prog_array_map*, a 2058*858ea5e5SAndroid Build Coastguard Worker * special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes 2059*858ea5e5SAndroid Build Coastguard Worker * *ctx*, a pointer to the context. 2060*858ea5e5SAndroid Build Coastguard Worker * 2061*858ea5e5SAndroid Build Coastguard Worker * If the call succeeds, the kernel immediately runs the first 2062*858ea5e5SAndroid Build Coastguard Worker * instruction of the new program. This is not a function call, 2063*858ea5e5SAndroid Build Coastguard Worker * and it never returns to the previous program. If the call 2064*858ea5e5SAndroid Build Coastguard Worker * fails, then the helper has no effect, and the caller continues 2065*858ea5e5SAndroid Build Coastguard Worker * to run its subsequent instructions. A call can fail if the 2066*858ea5e5SAndroid Build Coastguard Worker * destination program for the jump does not exist (i.e. *index* 2067*858ea5e5SAndroid Build Coastguard Worker * is superior to the number of entries in *prog_array_map*), or 2068*858ea5e5SAndroid Build Coastguard Worker * if the maximum number of tail calls has been reached for this 2069*858ea5e5SAndroid Build Coastguard Worker * chain of programs. This limit is defined in the kernel by the 2070*858ea5e5SAndroid Build Coastguard Worker * macro **MAX_TAIL_CALL_CNT** (not accessible to user space), 2071*858ea5e5SAndroid Build Coastguard Worker * which is currently set to 33. 2072*858ea5e5SAndroid Build Coastguard Worker * Return 2073*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2074*858ea5e5SAndroid Build Coastguard Worker * 2075*858ea5e5SAndroid Build Coastguard Worker * long bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags) 2076*858ea5e5SAndroid Build Coastguard Worker * Description 2077*858ea5e5SAndroid Build Coastguard Worker * Clone and redirect the packet associated to *skb* to another 2078*858ea5e5SAndroid Build Coastguard Worker * net device of index *ifindex*. Both ingress and egress 2079*858ea5e5SAndroid Build Coastguard Worker * interfaces can be used for redirection. The **BPF_F_INGRESS** 2080*858ea5e5SAndroid Build Coastguard Worker * value in *flags* is used to make the distinction (ingress path 2081*858ea5e5SAndroid Build Coastguard Worker * is selected if the flag is present, egress path otherwise). 2082*858ea5e5SAndroid Build Coastguard Worker * This is the only flag supported for now. 2083*858ea5e5SAndroid Build Coastguard Worker * 2084*858ea5e5SAndroid Build Coastguard Worker * In comparison with **bpf_redirect**\ () helper, 2085*858ea5e5SAndroid Build Coastguard Worker * **bpf_clone_redirect**\ () has the associated cost of 2086*858ea5e5SAndroid Build Coastguard Worker * duplicating the packet buffer, but this can be executed out of 2087*858ea5e5SAndroid Build Coastguard Worker * the eBPF program. Conversely, **bpf_redirect**\ () is more 2088*858ea5e5SAndroid Build Coastguard Worker * efficient, but it is handled through an action code where the 2089*858ea5e5SAndroid Build Coastguard Worker * redirection happens only after the eBPF program has returned. 2090*858ea5e5SAndroid Build Coastguard Worker * 2091*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2092*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2093*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2094*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2095*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2096*858ea5e5SAndroid Build Coastguard Worker * Return 2097*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. Positive 2098*858ea5e5SAndroid Build Coastguard Worker * error indicates a potential drop or congestion in the target 2099*858ea5e5SAndroid Build Coastguard Worker * device. The particular positive error codes are not defined. 2100*858ea5e5SAndroid Build Coastguard Worker * 2101*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_current_pid_tgid(void) 2102*858ea5e5SAndroid Build Coastguard Worker * Description 2103*858ea5e5SAndroid Build Coastguard Worker * Get the current pid and tgid. 2104*858ea5e5SAndroid Build Coastguard Worker * Return 2105*858ea5e5SAndroid Build Coastguard Worker * A 64-bit integer containing the current tgid and pid, and 2106*858ea5e5SAndroid Build Coastguard Worker * created as such: 2107*858ea5e5SAndroid Build Coastguard Worker * *current_task*\ **->tgid << 32 \|** 2108*858ea5e5SAndroid Build Coastguard Worker * *current_task*\ **->pid**. 2109*858ea5e5SAndroid Build Coastguard Worker * 2110*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_current_uid_gid(void) 2111*858ea5e5SAndroid Build Coastguard Worker * Description 2112*858ea5e5SAndroid Build Coastguard Worker * Get the current uid and gid. 2113*858ea5e5SAndroid Build Coastguard Worker * Return 2114*858ea5e5SAndroid Build Coastguard Worker * A 64-bit integer containing the current GID and UID, and 2115*858ea5e5SAndroid Build Coastguard Worker * created as such: *current_gid* **<< 32 \|** *current_uid*. 2116*858ea5e5SAndroid Build Coastguard Worker * 2117*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_current_comm(void *buf, u32 size_of_buf) 2118*858ea5e5SAndroid Build Coastguard Worker * Description 2119*858ea5e5SAndroid Build Coastguard Worker * Copy the **comm** attribute of the current task into *buf* of 2120*858ea5e5SAndroid Build Coastguard Worker * *size_of_buf*. The **comm** attribute contains the name of 2121*858ea5e5SAndroid Build Coastguard Worker * the executable (excluding the path) for the current task. The 2122*858ea5e5SAndroid Build Coastguard Worker * *size_of_buf* must be strictly positive. On success, the 2123*858ea5e5SAndroid Build Coastguard Worker * helper makes sure that the *buf* is NUL-terminated. On failure, 2124*858ea5e5SAndroid Build Coastguard Worker * it is filled with zeroes. 2125*858ea5e5SAndroid Build Coastguard Worker * Return 2126*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2127*858ea5e5SAndroid Build Coastguard Worker * 2128*858ea5e5SAndroid Build Coastguard Worker * u32 bpf_get_cgroup_classid(struct sk_buff *skb) 2129*858ea5e5SAndroid Build Coastguard Worker * Description 2130*858ea5e5SAndroid Build Coastguard Worker * Retrieve the classid for the current task, i.e. for the net_cls 2131*858ea5e5SAndroid Build Coastguard Worker * cgroup to which *skb* belongs. 2132*858ea5e5SAndroid Build Coastguard Worker * 2133*858ea5e5SAndroid Build Coastguard Worker * This helper can be used on TC egress path, but not on ingress. 2134*858ea5e5SAndroid Build Coastguard Worker * 2135*858ea5e5SAndroid Build Coastguard Worker * The net_cls cgroup provides an interface to tag network packets 2136*858ea5e5SAndroid Build Coastguard Worker * based on a user-provided identifier for all traffic coming from 2137*858ea5e5SAndroid Build Coastguard Worker * the tasks belonging to the related cgroup. See also the related 2138*858ea5e5SAndroid Build Coastguard Worker * kernel documentation, available from the Linux sources in file 2139*858ea5e5SAndroid Build Coastguard Worker * *Documentation/admin-guide/cgroup-v1/net_cls.rst*. 2140*858ea5e5SAndroid Build Coastguard Worker * 2141*858ea5e5SAndroid Build Coastguard Worker * The Linux kernel has two versions for cgroups: there are 2142*858ea5e5SAndroid Build Coastguard Worker * cgroups v1 and cgroups v2. Both are available to users, who can 2143*858ea5e5SAndroid Build Coastguard Worker * use a mixture of them, but note that the net_cls cgroup is for 2144*858ea5e5SAndroid Build Coastguard Worker * cgroup v1 only. This makes it incompatible with BPF programs 2145*858ea5e5SAndroid Build Coastguard Worker * run on cgroups, which is a cgroup-v2-only feature (a socket can 2146*858ea5e5SAndroid Build Coastguard Worker * only hold data for one version of cgroups at a time). 2147*858ea5e5SAndroid Build Coastguard Worker * 2148*858ea5e5SAndroid Build Coastguard Worker * This helper is only available is the kernel was compiled with 2149*858ea5e5SAndroid Build Coastguard Worker * the **CONFIG_CGROUP_NET_CLASSID** configuration option set to 2150*858ea5e5SAndroid Build Coastguard Worker * "**y**" or to "**m**". 2151*858ea5e5SAndroid Build Coastguard Worker * Return 2152*858ea5e5SAndroid Build Coastguard Worker * The classid, or 0 for the default unconfigured classid. 2153*858ea5e5SAndroid Build Coastguard Worker * 2154*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci) 2155*858ea5e5SAndroid Build Coastguard Worker * Description 2156*858ea5e5SAndroid Build Coastguard Worker * Push a *vlan_tci* (VLAN tag control information) of protocol 2157*858ea5e5SAndroid Build Coastguard Worker * *vlan_proto* to the packet associated to *skb*, then update 2158*858ea5e5SAndroid Build Coastguard Worker * the checksum. Note that if *vlan_proto* is different from 2159*858ea5e5SAndroid Build Coastguard Worker * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to 2160*858ea5e5SAndroid Build Coastguard Worker * be **ETH_P_8021Q**. 2161*858ea5e5SAndroid Build Coastguard Worker * 2162*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2163*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2164*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2165*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2166*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2167*858ea5e5SAndroid Build Coastguard Worker * Return 2168*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2169*858ea5e5SAndroid Build Coastguard Worker * 2170*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_vlan_pop(struct sk_buff *skb) 2171*858ea5e5SAndroid Build Coastguard Worker * Description 2172*858ea5e5SAndroid Build Coastguard Worker * Pop a VLAN header from the packet associated to *skb*. 2173*858ea5e5SAndroid Build Coastguard Worker * 2174*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2175*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2176*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2177*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2178*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2179*858ea5e5SAndroid Build Coastguard Worker * Return 2180*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2181*858ea5e5SAndroid Build Coastguard Worker * 2182*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags) 2183*858ea5e5SAndroid Build Coastguard Worker * Description 2184*858ea5e5SAndroid Build Coastguard Worker * Get tunnel metadata. This helper takes a pointer *key* to an 2185*858ea5e5SAndroid Build Coastguard Worker * empty **struct bpf_tunnel_key** of **size**, that will be 2186*858ea5e5SAndroid Build Coastguard Worker * filled with tunnel metadata for the packet associated to *skb*. 2187*858ea5e5SAndroid Build Coastguard Worker * The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which 2188*858ea5e5SAndroid Build Coastguard Worker * indicates that the tunnel is based on IPv6 protocol instead of 2189*858ea5e5SAndroid Build Coastguard Worker * IPv4. 2190*858ea5e5SAndroid Build Coastguard Worker * 2191*858ea5e5SAndroid Build Coastguard Worker * The **struct bpf_tunnel_key** is an object that generalizes the 2192*858ea5e5SAndroid Build Coastguard Worker * principal parameters used by various tunneling protocols into a 2193*858ea5e5SAndroid Build Coastguard Worker * single struct. This way, it can be used to easily make a 2194*858ea5e5SAndroid Build Coastguard Worker * decision based on the contents of the encapsulation header, 2195*858ea5e5SAndroid Build Coastguard Worker * "summarized" in this struct. In particular, it holds the IP 2196*858ea5e5SAndroid Build Coastguard Worker * address of the remote end (IPv4 or IPv6, depending on the case) 2197*858ea5e5SAndroid Build Coastguard Worker * in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also, 2198*858ea5e5SAndroid Build Coastguard Worker * this struct exposes the *key*\ **->tunnel_id**, which is 2199*858ea5e5SAndroid Build Coastguard Worker * generally mapped to a VNI (Virtual Network Identifier), making 2200*858ea5e5SAndroid Build Coastguard Worker * it programmable together with the **bpf_skb_set_tunnel_key**\ 2201*858ea5e5SAndroid Build Coastguard Worker * () helper. 2202*858ea5e5SAndroid Build Coastguard Worker * 2203*858ea5e5SAndroid Build Coastguard Worker * Let's imagine that the following code is part of a program 2204*858ea5e5SAndroid Build Coastguard Worker * attached to the TC ingress interface, on one end of a GRE 2205*858ea5e5SAndroid Build Coastguard Worker * tunnel, and is supposed to filter out all messages coming from 2206*858ea5e5SAndroid Build Coastguard Worker * remote ends with IPv4 address other than 10.0.0.1: 2207*858ea5e5SAndroid Build Coastguard Worker * 2208*858ea5e5SAndroid Build Coastguard Worker * :: 2209*858ea5e5SAndroid Build Coastguard Worker * 2210*858ea5e5SAndroid Build Coastguard Worker * int ret; 2211*858ea5e5SAndroid Build Coastguard Worker * struct bpf_tunnel_key key = {}; 2212*858ea5e5SAndroid Build Coastguard Worker * 2213*858ea5e5SAndroid Build Coastguard Worker * ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0); 2214*858ea5e5SAndroid Build Coastguard Worker * if (ret < 0) 2215*858ea5e5SAndroid Build Coastguard Worker * return TC_ACT_SHOT; // drop packet 2216*858ea5e5SAndroid Build Coastguard Worker * 2217*858ea5e5SAndroid Build Coastguard Worker * if (key.remote_ipv4 != 0x0a000001) 2218*858ea5e5SAndroid Build Coastguard Worker * return TC_ACT_SHOT; // drop packet 2219*858ea5e5SAndroid Build Coastguard Worker * 2220*858ea5e5SAndroid Build Coastguard Worker * return TC_ACT_OK; // accept packet 2221*858ea5e5SAndroid Build Coastguard Worker * 2222*858ea5e5SAndroid Build Coastguard Worker * This interface can also be used with all encapsulation devices 2223*858ea5e5SAndroid Build Coastguard Worker * that can operate in "collect metadata" mode: instead of having 2224*858ea5e5SAndroid Build Coastguard Worker * one network device per specific configuration, the "collect 2225*858ea5e5SAndroid Build Coastguard Worker * metadata" mode only requires a single device where the 2226*858ea5e5SAndroid Build Coastguard Worker * configuration can be extracted from this helper. 2227*858ea5e5SAndroid Build Coastguard Worker * 2228*858ea5e5SAndroid Build Coastguard Worker * This can be used together with various tunnels such as VXLan, 2229*858ea5e5SAndroid Build Coastguard Worker * Geneve, GRE or IP in IP (IPIP). 2230*858ea5e5SAndroid Build Coastguard Worker * Return 2231*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2232*858ea5e5SAndroid Build Coastguard Worker * 2233*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags) 2234*858ea5e5SAndroid Build Coastguard Worker * Description 2235*858ea5e5SAndroid Build Coastguard Worker * Populate tunnel metadata for packet associated to *skb.* The 2236*858ea5e5SAndroid Build Coastguard Worker * tunnel metadata is set to the contents of *key*, of *size*. The 2237*858ea5e5SAndroid Build Coastguard Worker * *flags* can be set to a combination of the following values: 2238*858ea5e5SAndroid Build Coastguard Worker * 2239*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_TUNINFO_IPV6** 2240*858ea5e5SAndroid Build Coastguard Worker * Indicate that the tunnel is based on IPv6 protocol 2241*858ea5e5SAndroid Build Coastguard Worker * instead of IPv4. 2242*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_ZERO_CSUM_TX** 2243*858ea5e5SAndroid Build Coastguard Worker * For IPv4 packets, add a flag to tunnel metadata 2244*858ea5e5SAndroid Build Coastguard Worker * indicating that checksum computation should be skipped 2245*858ea5e5SAndroid Build Coastguard Worker * and checksum set to zeroes. 2246*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_DONT_FRAGMENT** 2247*858ea5e5SAndroid Build Coastguard Worker * Add a flag to tunnel metadata indicating that the 2248*858ea5e5SAndroid Build Coastguard Worker * packet should not be fragmented. 2249*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_SEQ_NUMBER** 2250*858ea5e5SAndroid Build Coastguard Worker * Add a flag to tunnel metadata indicating that a 2251*858ea5e5SAndroid Build Coastguard Worker * sequence number should be added to tunnel header before 2252*858ea5e5SAndroid Build Coastguard Worker * sending the packet. This flag was added for GRE 2253*858ea5e5SAndroid Build Coastguard Worker * encapsulation, but might be used with other protocols 2254*858ea5e5SAndroid Build Coastguard Worker * as well in the future. 2255*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_NO_TUNNEL_KEY** 2256*858ea5e5SAndroid Build Coastguard Worker * Add a flag to tunnel metadata indicating that no tunnel 2257*858ea5e5SAndroid Build Coastguard Worker * key should be set in the resulting tunnel header. 2258*858ea5e5SAndroid Build Coastguard Worker * 2259*858ea5e5SAndroid Build Coastguard Worker * Here is a typical usage on the transmit path: 2260*858ea5e5SAndroid Build Coastguard Worker * 2261*858ea5e5SAndroid Build Coastguard Worker * :: 2262*858ea5e5SAndroid Build Coastguard Worker * 2263*858ea5e5SAndroid Build Coastguard Worker * struct bpf_tunnel_key key; 2264*858ea5e5SAndroid Build Coastguard Worker * populate key ... 2265*858ea5e5SAndroid Build Coastguard Worker * bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0); 2266*858ea5e5SAndroid Build Coastguard Worker * bpf_clone_redirect(skb, vxlan_dev_ifindex, 0); 2267*858ea5e5SAndroid Build Coastguard Worker * 2268*858ea5e5SAndroid Build Coastguard Worker * See also the description of the **bpf_skb_get_tunnel_key**\ () 2269*858ea5e5SAndroid Build Coastguard Worker * helper for additional information. 2270*858ea5e5SAndroid Build Coastguard Worker * Return 2271*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2272*858ea5e5SAndroid Build Coastguard Worker * 2273*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags) 2274*858ea5e5SAndroid Build Coastguard Worker * Description 2275*858ea5e5SAndroid Build Coastguard Worker * Read the value of a perf event counter. This helper relies on a 2276*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of 2277*858ea5e5SAndroid Build Coastguard Worker * the perf event counter is selected when *map* is updated with 2278*858ea5e5SAndroid Build Coastguard Worker * perf event file descriptors. The *map* is an array whose size 2279*858ea5e5SAndroid Build Coastguard Worker * is the number of available CPUs, and each cell contains a value 2280*858ea5e5SAndroid Build Coastguard Worker * relative to one CPU. The value to retrieve is indicated by 2281*858ea5e5SAndroid Build Coastguard Worker * *flags*, that contains the index of the CPU to look up, masked 2282*858ea5e5SAndroid Build Coastguard Worker * with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to 2283*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_CURRENT_CPU** to indicate that the value for the 2284*858ea5e5SAndroid Build Coastguard Worker * current CPU should be retrieved. 2285*858ea5e5SAndroid Build Coastguard Worker * 2286*858ea5e5SAndroid Build Coastguard Worker * Note that before Linux 4.13, only hardware perf event can be 2287*858ea5e5SAndroid Build Coastguard Worker * retrieved. 2288*858ea5e5SAndroid Build Coastguard Worker * 2289*858ea5e5SAndroid Build Coastguard Worker * Also, be aware that the newer helper 2290*858ea5e5SAndroid Build Coastguard Worker * **bpf_perf_event_read_value**\ () is recommended over 2291*858ea5e5SAndroid Build Coastguard Worker * **bpf_perf_event_read**\ () in general. The latter has some ABI 2292*858ea5e5SAndroid Build Coastguard Worker * quirks where error and counter value are used as a return code 2293*858ea5e5SAndroid Build Coastguard Worker * (which is wrong to do since ranges may overlap). This issue is 2294*858ea5e5SAndroid Build Coastguard Worker * fixed with **bpf_perf_event_read_value**\ (), which at the same 2295*858ea5e5SAndroid Build Coastguard Worker * time provides more features over the **bpf_perf_event_read**\ 2296*858ea5e5SAndroid Build Coastguard Worker * () interface. Please refer to the description of 2297*858ea5e5SAndroid Build Coastguard Worker * **bpf_perf_event_read_value**\ () for details. 2298*858ea5e5SAndroid Build Coastguard Worker * Return 2299*858ea5e5SAndroid Build Coastguard Worker * The value of the perf event counter read from the map, or a 2300*858ea5e5SAndroid Build Coastguard Worker * negative error code in case of failure. 2301*858ea5e5SAndroid Build Coastguard Worker * 2302*858ea5e5SAndroid Build Coastguard Worker * long bpf_redirect(u32 ifindex, u64 flags) 2303*858ea5e5SAndroid Build Coastguard Worker * Description 2304*858ea5e5SAndroid Build Coastguard Worker * Redirect the packet to another net device of index *ifindex*. 2305*858ea5e5SAndroid Build Coastguard Worker * This helper is somewhat similar to **bpf_clone_redirect**\ 2306*858ea5e5SAndroid Build Coastguard Worker * (), except that the packet is not cloned, which provides 2307*858ea5e5SAndroid Build Coastguard Worker * increased performance. 2308*858ea5e5SAndroid Build Coastguard Worker * 2309*858ea5e5SAndroid Build Coastguard Worker * Except for XDP, both ingress and egress interfaces can be used 2310*858ea5e5SAndroid Build Coastguard Worker * for redirection. The **BPF_F_INGRESS** value in *flags* is used 2311*858ea5e5SAndroid Build Coastguard Worker * to make the distinction (ingress path is selected if the flag 2312*858ea5e5SAndroid Build Coastguard Worker * is present, egress path otherwise). Currently, XDP only 2313*858ea5e5SAndroid Build Coastguard Worker * supports redirection to the egress interface, and accepts no 2314*858ea5e5SAndroid Build Coastguard Worker * flag at all. 2315*858ea5e5SAndroid Build Coastguard Worker * 2316*858ea5e5SAndroid Build Coastguard Worker * The same effect can also be attained with the more generic 2317*858ea5e5SAndroid Build Coastguard Worker * **bpf_redirect_map**\ (), which uses a BPF map to store the 2318*858ea5e5SAndroid Build Coastguard Worker * redirect target instead of providing it directly to the helper. 2319*858ea5e5SAndroid Build Coastguard Worker * Return 2320*858ea5e5SAndroid Build Coastguard Worker * For XDP, the helper returns **XDP_REDIRECT** on success or 2321*858ea5e5SAndroid Build Coastguard Worker * **XDP_ABORTED** on error. For other program types, the values 2322*858ea5e5SAndroid Build Coastguard Worker * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on 2323*858ea5e5SAndroid Build Coastguard Worker * error. 2324*858ea5e5SAndroid Build Coastguard Worker * 2325*858ea5e5SAndroid Build Coastguard Worker * u32 bpf_get_route_realm(struct sk_buff *skb) 2326*858ea5e5SAndroid Build Coastguard Worker * Description 2327*858ea5e5SAndroid Build Coastguard Worker * Retrieve the realm or the route, that is to say the 2328*858ea5e5SAndroid Build Coastguard Worker * **tclassid** field of the destination for the *skb*. The 2329*858ea5e5SAndroid Build Coastguard Worker * identifier retrieved is a user-provided tag, similar to the 2330*858ea5e5SAndroid Build Coastguard Worker * one used with the net_cls cgroup (see description for 2331*858ea5e5SAndroid Build Coastguard Worker * **bpf_get_cgroup_classid**\ () helper), but here this tag is 2332*858ea5e5SAndroid Build Coastguard Worker * held by a route (a destination entry), not by a task. 2333*858ea5e5SAndroid Build Coastguard Worker * 2334*858ea5e5SAndroid Build Coastguard Worker * Retrieving this identifier works with the clsact TC egress hook 2335*858ea5e5SAndroid Build Coastguard Worker * (see also **tc-bpf(8)**), or alternatively on conventional 2336*858ea5e5SAndroid Build Coastguard Worker * classful egress qdiscs, but not on TC ingress path. In case of 2337*858ea5e5SAndroid Build Coastguard Worker * clsact TC egress hook, this has the advantage that, internally, 2338*858ea5e5SAndroid Build Coastguard Worker * the destination entry has not been dropped yet in the transmit 2339*858ea5e5SAndroid Build Coastguard Worker * path. Therefore, the destination entry does not need to be 2340*858ea5e5SAndroid Build Coastguard Worker * artificially held via **netif_keep_dst**\ () for a classful 2341*858ea5e5SAndroid Build Coastguard Worker * qdisc until the *skb* is freed. 2342*858ea5e5SAndroid Build Coastguard Worker * 2343*858ea5e5SAndroid Build Coastguard Worker * This helper is available only if the kernel was compiled with 2344*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_IP_ROUTE_CLASSID** configuration option. 2345*858ea5e5SAndroid Build Coastguard Worker * Return 2346*858ea5e5SAndroid Build Coastguard Worker * The realm of the route for the packet associated to *skb*, or 0 2347*858ea5e5SAndroid Build Coastguard Worker * if none was found. 2348*858ea5e5SAndroid Build Coastguard Worker * 2349*858ea5e5SAndroid Build Coastguard Worker * long bpf_perf_event_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 2350*858ea5e5SAndroid Build Coastguard Worker * Description 2351*858ea5e5SAndroid Build Coastguard Worker * Write raw *data* blob into a special BPF perf event held by 2352*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 2353*858ea5e5SAndroid Build Coastguard Worker * event must have the following attributes: **PERF_SAMPLE_RAW** 2354*858ea5e5SAndroid Build Coastguard Worker * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 2355*858ea5e5SAndroid Build Coastguard Worker * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 2356*858ea5e5SAndroid Build Coastguard Worker * 2357*858ea5e5SAndroid Build Coastguard Worker * The *flags* are used to indicate the index in *map* for which 2358*858ea5e5SAndroid Build Coastguard Worker * the value must be put, masked with **BPF_F_INDEX_MASK**. 2359*858ea5e5SAndroid Build Coastguard Worker * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 2360*858ea5e5SAndroid Build Coastguard Worker * to indicate that the index of the current CPU core should be 2361*858ea5e5SAndroid Build Coastguard Worker * used. 2362*858ea5e5SAndroid Build Coastguard Worker * 2363*858ea5e5SAndroid Build Coastguard Worker * The value to write, of *size*, is passed through eBPF stack and 2364*858ea5e5SAndroid Build Coastguard Worker * pointed by *data*. 2365*858ea5e5SAndroid Build Coastguard Worker * 2366*858ea5e5SAndroid Build Coastguard Worker * The context of the program *ctx* needs also be passed to the 2367*858ea5e5SAndroid Build Coastguard Worker * helper. 2368*858ea5e5SAndroid Build Coastguard Worker * 2369*858ea5e5SAndroid Build Coastguard Worker * On user space, a program willing to read the values needs to 2370*858ea5e5SAndroid Build Coastguard Worker * call **perf_event_open**\ () on the perf event (either for 2371*858ea5e5SAndroid Build Coastguard Worker * one or for all CPUs) and to store the file descriptor into the 2372*858ea5e5SAndroid Build Coastguard Worker * *map*. This must be done before the eBPF program can send data 2373*858ea5e5SAndroid Build Coastguard Worker * into it. An example is available in file 2374*858ea5e5SAndroid Build Coastguard Worker * *samples/bpf/trace_output_user.c* in the Linux kernel source 2375*858ea5e5SAndroid Build Coastguard Worker * tree (the eBPF program counterpart is in 2376*858ea5e5SAndroid Build Coastguard Worker * *samples/bpf/trace_output_kern.c*). 2377*858ea5e5SAndroid Build Coastguard Worker * 2378*858ea5e5SAndroid Build Coastguard Worker * **bpf_perf_event_output**\ () achieves better performance 2379*858ea5e5SAndroid Build Coastguard Worker * than **bpf_trace_printk**\ () for sharing data with user 2380*858ea5e5SAndroid Build Coastguard Worker * space, and is much better suitable for streaming data from eBPF 2381*858ea5e5SAndroid Build Coastguard Worker * programs. 2382*858ea5e5SAndroid Build Coastguard Worker * 2383*858ea5e5SAndroid Build Coastguard Worker * Note that this helper is not restricted to tracing use cases 2384*858ea5e5SAndroid Build Coastguard Worker * and can be used with programs attached to TC or XDP as well, 2385*858ea5e5SAndroid Build Coastguard Worker * where it allows for passing data to user space listeners. Data 2386*858ea5e5SAndroid Build Coastguard Worker * can be: 2387*858ea5e5SAndroid Build Coastguard Worker * 2388*858ea5e5SAndroid Build Coastguard Worker * * Only custom structs, 2389*858ea5e5SAndroid Build Coastguard Worker * * Only the packet payload, or 2390*858ea5e5SAndroid Build Coastguard Worker * * A combination of both. 2391*858ea5e5SAndroid Build Coastguard Worker * Return 2392*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2393*858ea5e5SAndroid Build Coastguard Worker * 2394*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_load_bytes(const void *skb, u32 offset, void *to, u32 len) 2395*858ea5e5SAndroid Build Coastguard Worker * Description 2396*858ea5e5SAndroid Build Coastguard Worker * This helper was provided as an easy way to load data from a 2397*858ea5e5SAndroid Build Coastguard Worker * packet. It can be used to load *len* bytes from *offset* from 2398*858ea5e5SAndroid Build Coastguard Worker * the packet associated to *skb*, into the buffer pointed by 2399*858ea5e5SAndroid Build Coastguard Worker * *to*. 2400*858ea5e5SAndroid Build Coastguard Worker * 2401*858ea5e5SAndroid Build Coastguard Worker * Since Linux 4.7, usage of this helper has mostly been replaced 2402*858ea5e5SAndroid Build Coastguard Worker * by "direct packet access", enabling packet data to be 2403*858ea5e5SAndroid Build Coastguard Worker * manipulated with *skb*\ **->data** and *skb*\ **->data_end** 2404*858ea5e5SAndroid Build Coastguard Worker * pointing respectively to the first byte of packet data and to 2405*858ea5e5SAndroid Build Coastguard Worker * the byte after the last byte of packet data. However, it 2406*858ea5e5SAndroid Build Coastguard Worker * remains useful if one wishes to read large quantities of data 2407*858ea5e5SAndroid Build Coastguard Worker * at once from a packet into the eBPF stack. 2408*858ea5e5SAndroid Build Coastguard Worker * Return 2409*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2410*858ea5e5SAndroid Build Coastguard Worker * 2411*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_stackid(void *ctx, struct bpf_map *map, u64 flags) 2412*858ea5e5SAndroid Build Coastguard Worker * Description 2413*858ea5e5SAndroid Build Coastguard Worker * Walk a user or a kernel stack and return its id. To achieve 2414*858ea5e5SAndroid Build Coastguard Worker * this, the helper needs *ctx*, which is a pointer to the context 2415*858ea5e5SAndroid Build Coastguard Worker * on which the tracing program is executed, and a pointer to a 2416*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_STACK_TRACE**. 2417*858ea5e5SAndroid Build Coastguard Worker * 2418*858ea5e5SAndroid Build Coastguard Worker * The last argument, *flags*, holds the number of stack frames to 2419*858ea5e5SAndroid Build Coastguard Worker * skip (from 0 to 255), masked with 2420*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 2421*858ea5e5SAndroid Build Coastguard Worker * a combination of the following flags: 2422*858ea5e5SAndroid Build Coastguard Worker * 2423*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_USER_STACK** 2424*858ea5e5SAndroid Build Coastguard Worker * Collect a user space stack instead of a kernel stack. 2425*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_FAST_STACK_CMP** 2426*858ea5e5SAndroid Build Coastguard Worker * Compare stacks by hash only. 2427*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_REUSE_STACKID** 2428*858ea5e5SAndroid Build Coastguard Worker * If two different stacks hash into the same *stackid*, 2429*858ea5e5SAndroid Build Coastguard Worker * discard the old one. 2430*858ea5e5SAndroid Build Coastguard Worker * 2431*858ea5e5SAndroid Build Coastguard Worker * The stack id retrieved is a 32 bit long integer handle which 2432*858ea5e5SAndroid Build Coastguard Worker * can be further combined with other data (including other stack 2433*858ea5e5SAndroid Build Coastguard Worker * ids) and used as a key into maps. This can be useful for 2434*858ea5e5SAndroid Build Coastguard Worker * generating a variety of graphs (such as flame graphs or off-cpu 2435*858ea5e5SAndroid Build Coastguard Worker * graphs). 2436*858ea5e5SAndroid Build Coastguard Worker * 2437*858ea5e5SAndroid Build Coastguard Worker * For walking a stack, this helper is an improvement over 2438*858ea5e5SAndroid Build Coastguard Worker * **bpf_probe_read**\ (), which can be used with unrolled loops 2439*858ea5e5SAndroid Build Coastguard Worker * but is not efficient and consumes a lot of eBPF instructions. 2440*858ea5e5SAndroid Build Coastguard Worker * Instead, **bpf_get_stackid**\ () can collect up to 2441*858ea5e5SAndroid Build Coastguard Worker * **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that 2442*858ea5e5SAndroid Build Coastguard Worker * this limit can be controlled with the **sysctl** program, and 2443*858ea5e5SAndroid Build Coastguard Worker * that it should be manually increased in order to profile long 2444*858ea5e5SAndroid Build Coastguard Worker * user stacks (such as stacks for Java programs). To do so, use: 2445*858ea5e5SAndroid Build Coastguard Worker * 2446*858ea5e5SAndroid Build Coastguard Worker * :: 2447*858ea5e5SAndroid Build Coastguard Worker * 2448*858ea5e5SAndroid Build Coastguard Worker * # sysctl kernel.perf_event_max_stack=<new value> 2449*858ea5e5SAndroid Build Coastguard Worker * Return 2450*858ea5e5SAndroid Build Coastguard Worker * The positive or null stack id on success, or a negative error 2451*858ea5e5SAndroid Build Coastguard Worker * in case of failure. 2452*858ea5e5SAndroid Build Coastguard Worker * 2453*858ea5e5SAndroid Build Coastguard Worker * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed) 2454*858ea5e5SAndroid Build Coastguard Worker * Description 2455*858ea5e5SAndroid Build Coastguard Worker * Compute a checksum difference, from the raw buffer pointed by 2456*858ea5e5SAndroid Build Coastguard Worker * *from*, of length *from_size* (that must be a multiple of 4), 2457*858ea5e5SAndroid Build Coastguard Worker * towards the raw buffer pointed by *to*, of size *to_size* 2458*858ea5e5SAndroid Build Coastguard Worker * (same remark). An optional *seed* can be added to the value 2459*858ea5e5SAndroid Build Coastguard Worker * (this can be cascaded, the seed may come from a previous call 2460*858ea5e5SAndroid Build Coastguard Worker * to the helper). 2461*858ea5e5SAndroid Build Coastguard Worker * 2462*858ea5e5SAndroid Build Coastguard Worker * This is flexible enough to be used in several ways: 2463*858ea5e5SAndroid Build Coastguard Worker * 2464*858ea5e5SAndroid Build Coastguard Worker * * With *from_size* == 0, *to_size* > 0 and *seed* set to 2465*858ea5e5SAndroid Build Coastguard Worker * checksum, it can be used when pushing new data. 2466*858ea5e5SAndroid Build Coastguard Worker * * With *from_size* > 0, *to_size* == 0 and *seed* set to 2467*858ea5e5SAndroid Build Coastguard Worker * checksum, it can be used when removing data from a packet. 2468*858ea5e5SAndroid Build Coastguard Worker * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it 2469*858ea5e5SAndroid Build Coastguard Worker * can be used to compute a diff. Note that *from_size* and 2470*858ea5e5SAndroid Build Coastguard Worker * *to_size* do not need to be equal. 2471*858ea5e5SAndroid Build Coastguard Worker * 2472*858ea5e5SAndroid Build Coastguard Worker * This helper can be used in combination with 2473*858ea5e5SAndroid Build Coastguard Worker * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to 2474*858ea5e5SAndroid Build Coastguard Worker * which one can feed in the difference computed with 2475*858ea5e5SAndroid Build Coastguard Worker * **bpf_csum_diff**\ (). 2476*858ea5e5SAndroid Build Coastguard Worker * Return 2477*858ea5e5SAndroid Build Coastguard Worker * The checksum result, or a negative error code in case of 2478*858ea5e5SAndroid Build Coastguard Worker * failure. 2479*858ea5e5SAndroid Build Coastguard Worker * 2480*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_get_tunnel_opt(struct sk_buff *skb, void *opt, u32 size) 2481*858ea5e5SAndroid Build Coastguard Worker * Description 2482*858ea5e5SAndroid Build Coastguard Worker * Retrieve tunnel options metadata for the packet associated to 2483*858ea5e5SAndroid Build Coastguard Worker * *skb*, and store the raw tunnel option data to the buffer *opt* 2484*858ea5e5SAndroid Build Coastguard Worker * of *size*. 2485*858ea5e5SAndroid Build Coastguard Worker * 2486*858ea5e5SAndroid Build Coastguard Worker * This helper can be used with encapsulation devices that can 2487*858ea5e5SAndroid Build Coastguard Worker * operate in "collect metadata" mode (please refer to the related 2488*858ea5e5SAndroid Build Coastguard Worker * note in the description of **bpf_skb_get_tunnel_key**\ () for 2489*858ea5e5SAndroid Build Coastguard Worker * more details). A particular example where this can be used is 2490*858ea5e5SAndroid Build Coastguard Worker * in combination with the Geneve encapsulation protocol, where it 2491*858ea5e5SAndroid Build Coastguard Worker * allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper) 2492*858ea5e5SAndroid Build Coastguard Worker * and retrieving arbitrary TLVs (Type-Length-Value headers) from 2493*858ea5e5SAndroid Build Coastguard Worker * the eBPF program. This allows for full customization of these 2494*858ea5e5SAndroid Build Coastguard Worker * headers. 2495*858ea5e5SAndroid Build Coastguard Worker * Return 2496*858ea5e5SAndroid Build Coastguard Worker * The size of the option data retrieved. 2497*858ea5e5SAndroid Build Coastguard Worker * 2498*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_set_tunnel_opt(struct sk_buff *skb, void *opt, u32 size) 2499*858ea5e5SAndroid Build Coastguard Worker * Description 2500*858ea5e5SAndroid Build Coastguard Worker * Set tunnel options metadata for the packet associated to *skb* 2501*858ea5e5SAndroid Build Coastguard Worker * to the option data contained in the raw buffer *opt* of *size*. 2502*858ea5e5SAndroid Build Coastguard Worker * 2503*858ea5e5SAndroid Build Coastguard Worker * See also the description of the **bpf_skb_get_tunnel_opt**\ () 2504*858ea5e5SAndroid Build Coastguard Worker * helper for additional information. 2505*858ea5e5SAndroid Build Coastguard Worker * Return 2506*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2507*858ea5e5SAndroid Build Coastguard Worker * 2508*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags) 2509*858ea5e5SAndroid Build Coastguard Worker * Description 2510*858ea5e5SAndroid Build Coastguard Worker * Change the protocol of the *skb* to *proto*. Currently 2511*858ea5e5SAndroid Build Coastguard Worker * supported are transition from IPv4 to IPv6, and from IPv6 to 2512*858ea5e5SAndroid Build Coastguard Worker * IPv4. The helper takes care of the groundwork for the 2513*858ea5e5SAndroid Build Coastguard Worker * transition, including resizing the socket buffer. The eBPF 2514*858ea5e5SAndroid Build Coastguard Worker * program is expected to fill the new headers, if any, via 2515*858ea5e5SAndroid Build Coastguard Worker * **skb_store_bytes**\ () and to recompute the checksums with 2516*858ea5e5SAndroid Build Coastguard Worker * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ 2517*858ea5e5SAndroid Build Coastguard Worker * (). The main case for this helper is to perform NAT64 2518*858ea5e5SAndroid Build Coastguard Worker * operations out of an eBPF program. 2519*858ea5e5SAndroid Build Coastguard Worker * 2520*858ea5e5SAndroid Build Coastguard Worker * Internally, the GSO type is marked as dodgy so that headers are 2521*858ea5e5SAndroid Build Coastguard Worker * checked and segments are recalculated by the GSO/GRO engine. 2522*858ea5e5SAndroid Build Coastguard Worker * The size for GSO target is adapted as well. 2523*858ea5e5SAndroid Build Coastguard Worker * 2524*858ea5e5SAndroid Build Coastguard Worker * All values for *flags* are reserved for future usage, and must 2525*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 2526*858ea5e5SAndroid Build Coastguard Worker * 2527*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2528*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2529*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2530*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2531*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2532*858ea5e5SAndroid Build Coastguard Worker * Return 2533*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2534*858ea5e5SAndroid Build Coastguard Worker * 2535*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_change_type(struct sk_buff *skb, u32 type) 2536*858ea5e5SAndroid Build Coastguard Worker * Description 2537*858ea5e5SAndroid Build Coastguard Worker * Change the packet type for the packet associated to *skb*. This 2538*858ea5e5SAndroid Build Coastguard Worker * comes down to setting *skb*\ **->pkt_type** to *type*, except 2539*858ea5e5SAndroid Build Coastguard Worker * the eBPF program does not have a write access to *skb*\ 2540*858ea5e5SAndroid Build Coastguard Worker * **->pkt_type** beside this helper. Using a helper here allows 2541*858ea5e5SAndroid Build Coastguard Worker * for graceful handling of errors. 2542*858ea5e5SAndroid Build Coastguard Worker * 2543*858ea5e5SAndroid Build Coastguard Worker * The major use case is to change incoming *skb*s to 2544*858ea5e5SAndroid Build Coastguard Worker * **PACKET_HOST** in a programmatic way instead of having to 2545*858ea5e5SAndroid Build Coastguard Worker * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for 2546*858ea5e5SAndroid Build Coastguard Worker * example. 2547*858ea5e5SAndroid Build Coastguard Worker * 2548*858ea5e5SAndroid Build Coastguard Worker * Note that *type* only allows certain values. At this time, they 2549*858ea5e5SAndroid Build Coastguard Worker * are: 2550*858ea5e5SAndroid Build Coastguard Worker * 2551*858ea5e5SAndroid Build Coastguard Worker * **PACKET_HOST** 2552*858ea5e5SAndroid Build Coastguard Worker * Packet is for us. 2553*858ea5e5SAndroid Build Coastguard Worker * **PACKET_BROADCAST** 2554*858ea5e5SAndroid Build Coastguard Worker * Send packet to all. 2555*858ea5e5SAndroid Build Coastguard Worker * **PACKET_MULTICAST** 2556*858ea5e5SAndroid Build Coastguard Worker * Send packet to group. 2557*858ea5e5SAndroid Build Coastguard Worker * **PACKET_OTHERHOST** 2558*858ea5e5SAndroid Build Coastguard Worker * Send packet to someone else. 2559*858ea5e5SAndroid Build Coastguard Worker * Return 2560*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2561*858ea5e5SAndroid Build Coastguard Worker * 2562*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index) 2563*858ea5e5SAndroid Build Coastguard Worker * Description 2564*858ea5e5SAndroid Build Coastguard Worker * Check whether *skb* is a descendant of the cgroup2 held by 2565*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*. 2566*858ea5e5SAndroid Build Coastguard Worker * Return 2567*858ea5e5SAndroid Build Coastguard Worker * The return value depends on the result of the test, and can be: 2568*858ea5e5SAndroid Build Coastguard Worker * 2569*858ea5e5SAndroid Build Coastguard Worker * * 0, if the *skb* failed the cgroup2 descendant test. 2570*858ea5e5SAndroid Build Coastguard Worker * * 1, if the *skb* succeeded the cgroup2 descendant test. 2571*858ea5e5SAndroid Build Coastguard Worker * * A negative error code, if an error occurred. 2572*858ea5e5SAndroid Build Coastguard Worker * 2573*858ea5e5SAndroid Build Coastguard Worker * u32 bpf_get_hash_recalc(struct sk_buff *skb) 2574*858ea5e5SAndroid Build Coastguard Worker * Description 2575*858ea5e5SAndroid Build Coastguard Worker * Retrieve the hash of the packet, *skb*\ **->hash**. If it is 2576*858ea5e5SAndroid Build Coastguard Worker * not set, in particular if the hash was cleared due to mangling, 2577*858ea5e5SAndroid Build Coastguard Worker * recompute this hash. Later accesses to the hash can be done 2578*858ea5e5SAndroid Build Coastguard Worker * directly with *skb*\ **->hash**. 2579*858ea5e5SAndroid Build Coastguard Worker * 2580*858ea5e5SAndroid Build Coastguard Worker * Calling **bpf_set_hash_invalid**\ (), changing a packet 2581*858ea5e5SAndroid Build Coastguard Worker * prototype with **bpf_skb_change_proto**\ (), or calling 2582*858ea5e5SAndroid Build Coastguard Worker * **bpf_skb_store_bytes**\ () with the 2583*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INVALIDATE_HASH** are actions susceptible to clear 2584*858ea5e5SAndroid Build Coastguard Worker * the hash and to trigger a new computation for the next call to 2585*858ea5e5SAndroid Build Coastguard Worker * **bpf_get_hash_recalc**\ (). 2586*858ea5e5SAndroid Build Coastguard Worker * Return 2587*858ea5e5SAndroid Build Coastguard Worker * The 32-bit hash. 2588*858ea5e5SAndroid Build Coastguard Worker * 2589*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_current_task(void) 2590*858ea5e5SAndroid Build Coastguard Worker * Description 2591*858ea5e5SAndroid Build Coastguard Worker * Get the current task. 2592*858ea5e5SAndroid Build Coastguard Worker * Return 2593*858ea5e5SAndroid Build Coastguard Worker * A pointer to the current task struct. 2594*858ea5e5SAndroid Build Coastguard Worker * 2595*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_write_user(void *dst, const void *src, u32 len) 2596*858ea5e5SAndroid Build Coastguard Worker * Description 2597*858ea5e5SAndroid Build Coastguard Worker * Attempt in a safe way to write *len* bytes from the buffer 2598*858ea5e5SAndroid Build Coastguard Worker * *src* to *dst* in memory. It only works for threads that are in 2599*858ea5e5SAndroid Build Coastguard Worker * user context, and *dst* must be a valid user space address. 2600*858ea5e5SAndroid Build Coastguard Worker * 2601*858ea5e5SAndroid Build Coastguard Worker * This helper should not be used to implement any kind of 2602*858ea5e5SAndroid Build Coastguard Worker * security mechanism because of TOC-TOU attacks, but rather to 2603*858ea5e5SAndroid Build Coastguard Worker * debug, divert, and manipulate execution of semi-cooperative 2604*858ea5e5SAndroid Build Coastguard Worker * processes. 2605*858ea5e5SAndroid Build Coastguard Worker * 2606*858ea5e5SAndroid Build Coastguard Worker * Keep in mind that this feature is meant for experiments, and it 2607*858ea5e5SAndroid Build Coastguard Worker * has a risk of crashing the system and running programs. 2608*858ea5e5SAndroid Build Coastguard Worker * Therefore, when an eBPF program using this helper is attached, 2609*858ea5e5SAndroid Build Coastguard Worker * a warning including PID and process name is printed to kernel 2610*858ea5e5SAndroid Build Coastguard Worker * logs. 2611*858ea5e5SAndroid Build Coastguard Worker * Return 2612*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2613*858ea5e5SAndroid Build Coastguard Worker * 2614*858ea5e5SAndroid Build Coastguard Worker * long bpf_current_task_under_cgroup(struct bpf_map *map, u32 index) 2615*858ea5e5SAndroid Build Coastguard Worker * Description 2616*858ea5e5SAndroid Build Coastguard Worker * Check whether the probe is being run is the context of a given 2617*858ea5e5SAndroid Build Coastguard Worker * subset of the cgroup2 hierarchy. The cgroup2 to test is held by 2618*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*. 2619*858ea5e5SAndroid Build Coastguard Worker * Return 2620*858ea5e5SAndroid Build Coastguard Worker * The return value depends on the result of the test, and can be: 2621*858ea5e5SAndroid Build Coastguard Worker * 2622*858ea5e5SAndroid Build Coastguard Worker * * 1, if current task belongs to the cgroup2. 2623*858ea5e5SAndroid Build Coastguard Worker * * 0, if current task does not belong to the cgroup2. 2624*858ea5e5SAndroid Build Coastguard Worker * * A negative error code, if an error occurred. 2625*858ea5e5SAndroid Build Coastguard Worker * 2626*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags) 2627*858ea5e5SAndroid Build Coastguard Worker * Description 2628*858ea5e5SAndroid Build Coastguard Worker * Resize (trim or grow) the packet associated to *skb* to the 2629*858ea5e5SAndroid Build Coastguard Worker * new *len*. The *flags* are reserved for future usage, and must 2630*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 2631*858ea5e5SAndroid Build Coastguard Worker * 2632*858ea5e5SAndroid Build Coastguard Worker * The basic idea is that the helper performs the needed work to 2633*858ea5e5SAndroid Build Coastguard Worker * change the size of the packet, then the eBPF program rewrites 2634*858ea5e5SAndroid Build Coastguard Worker * the rest via helpers like **bpf_skb_store_bytes**\ (), 2635*858ea5e5SAndroid Build Coastguard Worker * **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ () 2636*858ea5e5SAndroid Build Coastguard Worker * and others. This helper is a slow path utility intended for 2637*858ea5e5SAndroid Build Coastguard Worker * replies with control messages. And because it is targeted for 2638*858ea5e5SAndroid Build Coastguard Worker * slow path, the helper itself can afford to be slow: it 2639*858ea5e5SAndroid Build Coastguard Worker * implicitly linearizes, unclones and drops offloads from the 2640*858ea5e5SAndroid Build Coastguard Worker * *skb*. 2641*858ea5e5SAndroid Build Coastguard Worker * 2642*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2643*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2644*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2645*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2646*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2647*858ea5e5SAndroid Build Coastguard Worker * Return 2648*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2649*858ea5e5SAndroid Build Coastguard Worker * 2650*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_pull_data(struct sk_buff *skb, u32 len) 2651*858ea5e5SAndroid Build Coastguard Worker * Description 2652*858ea5e5SAndroid Build Coastguard Worker * Pull in non-linear data in case the *skb* is non-linear and not 2653*858ea5e5SAndroid Build Coastguard Worker * all of *len* are part of the linear section. Make *len* bytes 2654*858ea5e5SAndroid Build Coastguard Worker * from *skb* readable and writable. If a zero value is passed for 2655*858ea5e5SAndroid Build Coastguard Worker * *len*, then all bytes in the linear part of *skb* will be made 2656*858ea5e5SAndroid Build Coastguard Worker * readable and writable. 2657*858ea5e5SAndroid Build Coastguard Worker * 2658*858ea5e5SAndroid Build Coastguard Worker * This helper is only needed for reading and writing with direct 2659*858ea5e5SAndroid Build Coastguard Worker * packet access. 2660*858ea5e5SAndroid Build Coastguard Worker * 2661*858ea5e5SAndroid Build Coastguard Worker * For direct packet access, testing that offsets to access 2662*858ea5e5SAndroid Build Coastguard Worker * are within packet boundaries (test on *skb*\ **->data_end**) is 2663*858ea5e5SAndroid Build Coastguard Worker * susceptible to fail if offsets are invalid, or if the requested 2664*858ea5e5SAndroid Build Coastguard Worker * data is in non-linear parts of the *skb*. On failure the 2665*858ea5e5SAndroid Build Coastguard Worker * program can just bail out, or in the case of a non-linear 2666*858ea5e5SAndroid Build Coastguard Worker * buffer, use a helper to make the data available. The 2667*858ea5e5SAndroid Build Coastguard Worker * **bpf_skb_load_bytes**\ () helper is a first solution to access 2668*858ea5e5SAndroid Build Coastguard Worker * the data. Another one consists in using **bpf_skb_pull_data** 2669*858ea5e5SAndroid Build Coastguard Worker * to pull in once the non-linear parts, then retesting and 2670*858ea5e5SAndroid Build Coastguard Worker * eventually access the data. 2671*858ea5e5SAndroid Build Coastguard Worker * 2672*858ea5e5SAndroid Build Coastguard Worker * At the same time, this also makes sure the *skb* is uncloned, 2673*858ea5e5SAndroid Build Coastguard Worker * which is a necessary condition for direct write. As this needs 2674*858ea5e5SAndroid Build Coastguard Worker * to be an invariant for the write part only, the verifier 2675*858ea5e5SAndroid Build Coastguard Worker * detects writes and adds a prologue that is calling 2676*858ea5e5SAndroid Build Coastguard Worker * **bpf_skb_pull_data()** to effectively unclone the *skb* from 2677*858ea5e5SAndroid Build Coastguard Worker * the very beginning in case it is indeed cloned. 2678*858ea5e5SAndroid Build Coastguard Worker * 2679*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2680*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2681*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2682*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2683*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2684*858ea5e5SAndroid Build Coastguard Worker * Return 2685*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2686*858ea5e5SAndroid Build Coastguard Worker * 2687*858ea5e5SAndroid Build Coastguard Worker * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum) 2688*858ea5e5SAndroid Build Coastguard Worker * Description 2689*858ea5e5SAndroid Build Coastguard Worker * Add the checksum *csum* into *skb*\ **->csum** in case the 2690*858ea5e5SAndroid Build Coastguard Worker * driver has supplied a checksum for the entire packet into that 2691*858ea5e5SAndroid Build Coastguard Worker * field. Return an error otherwise. This helper is intended to be 2692*858ea5e5SAndroid Build Coastguard Worker * used in combination with **bpf_csum_diff**\ (), in particular 2693*858ea5e5SAndroid Build Coastguard Worker * when the checksum needs to be updated after data has been 2694*858ea5e5SAndroid Build Coastguard Worker * written into the packet through direct packet access. 2695*858ea5e5SAndroid Build Coastguard Worker * Return 2696*858ea5e5SAndroid Build Coastguard Worker * The checksum on success, or a negative error code in case of 2697*858ea5e5SAndroid Build Coastguard Worker * failure. 2698*858ea5e5SAndroid Build Coastguard Worker * 2699*858ea5e5SAndroid Build Coastguard Worker * void bpf_set_hash_invalid(struct sk_buff *skb) 2700*858ea5e5SAndroid Build Coastguard Worker * Description 2701*858ea5e5SAndroid Build Coastguard Worker * Invalidate the current *skb*\ **->hash**. It can be used after 2702*858ea5e5SAndroid Build Coastguard Worker * mangling on headers through direct packet access, in order to 2703*858ea5e5SAndroid Build Coastguard Worker * indicate that the hash is outdated and to trigger a 2704*858ea5e5SAndroid Build Coastguard Worker * recalculation the next time the kernel tries to access this 2705*858ea5e5SAndroid Build Coastguard Worker * hash or when the **bpf_get_hash_recalc**\ () helper is called. 2706*858ea5e5SAndroid Build Coastguard Worker * Return 2707*858ea5e5SAndroid Build Coastguard Worker * void. 2708*858ea5e5SAndroid Build Coastguard Worker * 2709*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_numa_node_id(void) 2710*858ea5e5SAndroid Build Coastguard Worker * Description 2711*858ea5e5SAndroid Build Coastguard Worker * Return the id of the current NUMA node. The primary use case 2712*858ea5e5SAndroid Build Coastguard Worker * for this helper is the selection of sockets for the local NUMA 2713*858ea5e5SAndroid Build Coastguard Worker * node, when the program is attached to sockets using the 2714*858ea5e5SAndroid Build Coastguard Worker * **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**), 2715*858ea5e5SAndroid Build Coastguard Worker * but the helper is also available to other eBPF program types, 2716*858ea5e5SAndroid Build Coastguard Worker * similarly to **bpf_get_smp_processor_id**\ (). 2717*858ea5e5SAndroid Build Coastguard Worker * Return 2718*858ea5e5SAndroid Build Coastguard Worker * The id of current NUMA node. 2719*858ea5e5SAndroid Build Coastguard Worker * 2720*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags) 2721*858ea5e5SAndroid Build Coastguard Worker * Description 2722*858ea5e5SAndroid Build Coastguard Worker * Grows headroom of packet associated to *skb* and adjusts the 2723*858ea5e5SAndroid Build Coastguard Worker * offset of the MAC header accordingly, adding *len* bytes of 2724*858ea5e5SAndroid Build Coastguard Worker * space. It automatically extends and reallocates memory as 2725*858ea5e5SAndroid Build Coastguard Worker * required. 2726*858ea5e5SAndroid Build Coastguard Worker * 2727*858ea5e5SAndroid Build Coastguard Worker * This helper can be used on a layer 3 *skb* to push a MAC header 2728*858ea5e5SAndroid Build Coastguard Worker * for redirection into a layer 2 device. 2729*858ea5e5SAndroid Build Coastguard Worker * 2730*858ea5e5SAndroid Build Coastguard Worker * All values for *flags* are reserved for future usage, and must 2731*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 2732*858ea5e5SAndroid Build Coastguard Worker * 2733*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2734*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2735*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2736*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2737*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2738*858ea5e5SAndroid Build Coastguard Worker * Return 2739*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2740*858ea5e5SAndroid Build Coastguard Worker * 2741*858ea5e5SAndroid Build Coastguard Worker * long bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta) 2742*858ea5e5SAndroid Build Coastguard Worker * Description 2743*858ea5e5SAndroid Build Coastguard Worker * Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that 2744*858ea5e5SAndroid Build Coastguard Worker * it is possible to use a negative value for *delta*. This helper 2745*858ea5e5SAndroid Build Coastguard Worker * can be used to prepare the packet for pushing or popping 2746*858ea5e5SAndroid Build Coastguard Worker * headers. 2747*858ea5e5SAndroid Build Coastguard Worker * 2748*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2749*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2750*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2751*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2752*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2753*858ea5e5SAndroid Build Coastguard Worker * Return 2754*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2755*858ea5e5SAndroid Build Coastguard Worker * 2756*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_read_str(void *dst, u32 size, const void *unsafe_ptr) 2757*858ea5e5SAndroid Build Coastguard Worker * Description 2758*858ea5e5SAndroid Build Coastguard Worker * Copy a NUL terminated string from an unsafe kernel address 2759*858ea5e5SAndroid Build Coastguard Worker * *unsafe_ptr* to *dst*. See **bpf_probe_read_kernel_str**\ () for 2760*858ea5e5SAndroid Build Coastguard Worker * more details. 2761*858ea5e5SAndroid Build Coastguard Worker * 2762*858ea5e5SAndroid Build Coastguard Worker * Generally, use **bpf_probe_read_user_str**\ () or 2763*858ea5e5SAndroid Build Coastguard Worker * **bpf_probe_read_kernel_str**\ () instead. 2764*858ea5e5SAndroid Build Coastguard Worker * Return 2765*858ea5e5SAndroid Build Coastguard Worker * On success, the strictly positive length of the string, 2766*858ea5e5SAndroid Build Coastguard Worker * including the trailing NUL character. On error, a negative 2767*858ea5e5SAndroid Build Coastguard Worker * value. 2768*858ea5e5SAndroid Build Coastguard Worker * 2769*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_socket_cookie(struct sk_buff *skb) 2770*858ea5e5SAndroid Build Coastguard Worker * Description 2771*858ea5e5SAndroid Build Coastguard Worker * If the **struct sk_buff** pointed by *skb* has a known socket, 2772*858ea5e5SAndroid Build Coastguard Worker * retrieve the cookie (generated by the kernel) of this socket. 2773*858ea5e5SAndroid Build Coastguard Worker * If no cookie has been set yet, generate a new cookie. Once 2774*858ea5e5SAndroid Build Coastguard Worker * generated, the socket cookie remains stable for the life of the 2775*858ea5e5SAndroid Build Coastguard Worker * socket. This helper can be useful for monitoring per socket 2776*858ea5e5SAndroid Build Coastguard Worker * networking traffic statistics as it provides a global socket 2777*858ea5e5SAndroid Build Coastguard Worker * identifier that can be assumed unique. 2778*858ea5e5SAndroid Build Coastguard Worker * Return 2779*858ea5e5SAndroid Build Coastguard Worker * A 8-byte long unique number on success, or 0 if the socket 2780*858ea5e5SAndroid Build Coastguard Worker * field is missing inside *skb*. 2781*858ea5e5SAndroid Build Coastguard Worker * 2782*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx) 2783*858ea5e5SAndroid Build Coastguard Worker * Description 2784*858ea5e5SAndroid Build Coastguard Worker * Equivalent to bpf_get_socket_cookie() helper that accepts 2785*858ea5e5SAndroid Build Coastguard Worker * *skb*, but gets socket from **struct bpf_sock_addr** context. 2786*858ea5e5SAndroid Build Coastguard Worker * Return 2787*858ea5e5SAndroid Build Coastguard Worker * A 8-byte long unique number. 2788*858ea5e5SAndroid Build Coastguard Worker * 2789*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx) 2790*858ea5e5SAndroid Build Coastguard Worker * Description 2791*858ea5e5SAndroid Build Coastguard Worker * Equivalent to **bpf_get_socket_cookie**\ () helper that accepts 2792*858ea5e5SAndroid Build Coastguard Worker * *skb*, but gets socket from **struct bpf_sock_ops** context. 2793*858ea5e5SAndroid Build Coastguard Worker * Return 2794*858ea5e5SAndroid Build Coastguard Worker * A 8-byte long unique number. 2795*858ea5e5SAndroid Build Coastguard Worker * 2796*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_socket_cookie(struct sock *sk) 2797*858ea5e5SAndroid Build Coastguard Worker * Description 2798*858ea5e5SAndroid Build Coastguard Worker * Equivalent to **bpf_get_socket_cookie**\ () helper that accepts 2799*858ea5e5SAndroid Build Coastguard Worker * *sk*, but gets socket from a BTF **struct sock**. This helper 2800*858ea5e5SAndroid Build Coastguard Worker * also works for sleepable programs. 2801*858ea5e5SAndroid Build Coastguard Worker * Return 2802*858ea5e5SAndroid Build Coastguard Worker * A 8-byte long unique number or 0 if *sk* is NULL. 2803*858ea5e5SAndroid Build Coastguard Worker * 2804*858ea5e5SAndroid Build Coastguard Worker * u32 bpf_get_socket_uid(struct sk_buff *skb) 2805*858ea5e5SAndroid Build Coastguard Worker * Description 2806*858ea5e5SAndroid Build Coastguard Worker * Get the owner UID of the socked associated to *skb*. 2807*858ea5e5SAndroid Build Coastguard Worker * Return 2808*858ea5e5SAndroid Build Coastguard Worker * The owner UID of the socket associated to *skb*. If the socket 2809*858ea5e5SAndroid Build Coastguard Worker * is **NULL**, or if it is not a full socket (i.e. if it is a 2810*858ea5e5SAndroid Build Coastguard Worker * time-wait or a request socket instead), **overflowuid** value 2811*858ea5e5SAndroid Build Coastguard Worker * is returned (note that **overflowuid** might also be the actual 2812*858ea5e5SAndroid Build Coastguard Worker * UID value for the socket). 2813*858ea5e5SAndroid Build Coastguard Worker * 2814*858ea5e5SAndroid Build Coastguard Worker * long bpf_set_hash(struct sk_buff *skb, u32 hash) 2815*858ea5e5SAndroid Build Coastguard Worker * Description 2816*858ea5e5SAndroid Build Coastguard Worker * Set the full hash for *skb* (set the field *skb*\ **->hash**) 2817*858ea5e5SAndroid Build Coastguard Worker * to value *hash*. 2818*858ea5e5SAndroid Build Coastguard Worker * Return 2819*858ea5e5SAndroid Build Coastguard Worker * 0 2820*858ea5e5SAndroid Build Coastguard Worker * 2821*858ea5e5SAndroid Build Coastguard Worker * long bpf_setsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen) 2822*858ea5e5SAndroid Build Coastguard Worker * Description 2823*858ea5e5SAndroid Build Coastguard Worker * Emulate a call to **setsockopt()** on the socket associated to 2824*858ea5e5SAndroid Build Coastguard Worker * *bpf_socket*, which must be a full socket. The *level* at 2825*858ea5e5SAndroid Build Coastguard Worker * which the option resides and the name *optname* of the option 2826*858ea5e5SAndroid Build Coastguard Worker * must be specified, see **setsockopt(2)** for more information. 2827*858ea5e5SAndroid Build Coastguard Worker * The option value of length *optlen* is pointed by *optval*. 2828*858ea5e5SAndroid Build Coastguard Worker * 2829*858ea5e5SAndroid Build Coastguard Worker * *bpf_socket* should be one of the following: 2830*858ea5e5SAndroid Build Coastguard Worker * 2831*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**. 2832*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT**, 2833*858ea5e5SAndroid Build Coastguard Worker * **BPF_CGROUP_INET6_CONNECT** and **BPF_CGROUP_UNIX_CONNECT**. 2834*858ea5e5SAndroid Build Coastguard Worker * 2835*858ea5e5SAndroid Build Coastguard Worker * This helper actually implements a subset of **setsockopt()**. 2836*858ea5e5SAndroid Build Coastguard Worker * It supports the following *level*\ s: 2837*858ea5e5SAndroid Build Coastguard Worker * 2838*858ea5e5SAndroid Build Coastguard Worker * * **SOL_SOCKET**, which supports the following *optname*\ s: 2839*858ea5e5SAndroid Build Coastguard Worker * **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**, 2840*858ea5e5SAndroid Build Coastguard Worker * **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**, 2841*858ea5e5SAndroid Build Coastguard Worker * **SO_BINDTODEVICE**, **SO_KEEPALIVE**, **SO_REUSEADDR**, 2842*858ea5e5SAndroid Build Coastguard Worker * **SO_REUSEPORT**, **SO_BINDTOIFINDEX**, **SO_TXREHASH**. 2843*858ea5e5SAndroid Build Coastguard Worker * * **IPPROTO_TCP**, which supports the following *optname*\ s: 2844*858ea5e5SAndroid Build Coastguard Worker * **TCP_CONGESTION**, **TCP_BPF_IW**, 2845*858ea5e5SAndroid Build Coastguard Worker * **TCP_BPF_SNDCWND_CLAMP**, **TCP_SAVE_SYN**, 2846*858ea5e5SAndroid Build Coastguard Worker * **TCP_KEEPIDLE**, **TCP_KEEPINTVL**, **TCP_KEEPCNT**, 2847*858ea5e5SAndroid Build Coastguard Worker * **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**, 2848*858ea5e5SAndroid Build Coastguard Worker * **TCP_NODELAY**, **TCP_MAXSEG**, **TCP_WINDOW_CLAMP**, 2849*858ea5e5SAndroid Build Coastguard Worker * **TCP_THIN_LINEAR_TIMEOUTS**, **TCP_BPF_DELACK_MAX**, 2850*858ea5e5SAndroid Build Coastguard Worker * **TCP_BPF_RTO_MIN**. 2851*858ea5e5SAndroid Build Coastguard Worker * * **IPPROTO_IP**, which supports *optname* **IP_TOS**. 2852*858ea5e5SAndroid Build Coastguard Worker * * **IPPROTO_IPV6**, which supports the following *optname*\ s: 2853*858ea5e5SAndroid Build Coastguard Worker * **IPV6_TCLASS**, **IPV6_AUTOFLOWLABEL**. 2854*858ea5e5SAndroid Build Coastguard Worker * Return 2855*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2856*858ea5e5SAndroid Build Coastguard Worker * 2857*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags) 2858*858ea5e5SAndroid Build Coastguard Worker * Description 2859*858ea5e5SAndroid Build Coastguard Worker * Grow or shrink the room for data in the packet associated to 2860*858ea5e5SAndroid Build Coastguard Worker * *skb* by *len_diff*, and according to the selected *mode*. 2861*858ea5e5SAndroid Build Coastguard Worker * 2862*858ea5e5SAndroid Build Coastguard Worker * By default, the helper will reset any offloaded checksum 2863*858ea5e5SAndroid Build Coastguard Worker * indicator of the skb to CHECKSUM_NONE. This can be avoided 2864*858ea5e5SAndroid Build Coastguard Worker * by the following flag: 2865*858ea5e5SAndroid Build Coastguard Worker * 2866*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_NO_CSUM_RESET**: Do not reset offloaded 2867*858ea5e5SAndroid Build Coastguard Worker * checksum data of the skb to CHECKSUM_NONE. 2868*858ea5e5SAndroid Build Coastguard Worker * 2869*858ea5e5SAndroid Build Coastguard Worker * There are two supported modes at this time: 2870*858ea5e5SAndroid Build Coastguard Worker * 2871*858ea5e5SAndroid Build Coastguard Worker * * **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer 2872*858ea5e5SAndroid Build Coastguard Worker * (room space is added or removed between the layer 2 and 2873*858ea5e5SAndroid Build Coastguard Worker * layer 3 headers). 2874*858ea5e5SAndroid Build Coastguard Worker * 2875*858ea5e5SAndroid Build Coastguard Worker * * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer 2876*858ea5e5SAndroid Build Coastguard Worker * (room space is added or removed between the layer 3 and 2877*858ea5e5SAndroid Build Coastguard Worker * layer 4 headers). 2878*858ea5e5SAndroid Build Coastguard Worker * 2879*858ea5e5SAndroid Build Coastguard Worker * The following flags are supported at this time: 2880*858ea5e5SAndroid Build Coastguard Worker * 2881*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size. 2882*858ea5e5SAndroid Build Coastguard Worker * Adjusting mss in this way is not allowed for datagrams. 2883*858ea5e5SAndroid Build Coastguard Worker * 2884*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4**, 2885*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6**: 2886*858ea5e5SAndroid Build Coastguard Worker * Any new space is reserved to hold a tunnel header. 2887*858ea5e5SAndroid Build Coastguard Worker * Configure skb offsets and other fields accordingly. 2888*858ea5e5SAndroid Build Coastguard Worker * 2889*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_ENCAP_L4_GRE**, 2890*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_ADJ_ROOM_ENCAP_L4_UDP**: 2891*858ea5e5SAndroid Build Coastguard Worker * Use with ENCAP_L3 flags to further specify the tunnel type. 2892*858ea5e5SAndroid Build Coastguard Worker * 2893*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_ENCAP_L2**\ (*len*): 2894*858ea5e5SAndroid Build Coastguard Worker * Use with ENCAP_L3/L4 flags to further specify the tunnel 2895*858ea5e5SAndroid Build Coastguard Worker * type; *len* is the length of the inner MAC header. 2896*858ea5e5SAndroid Build Coastguard Worker * 2897*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_ENCAP_L2_ETH**: 2898*858ea5e5SAndroid Build Coastguard Worker * Use with BPF_F_ADJ_ROOM_ENCAP_L2 flag to further specify the 2899*858ea5e5SAndroid Build Coastguard Worker * L2 type as Ethernet. 2900*858ea5e5SAndroid Build Coastguard Worker * 2901*858ea5e5SAndroid Build Coastguard Worker * * **BPF_F_ADJ_ROOM_DECAP_L3_IPV4**, 2902*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_ADJ_ROOM_DECAP_L3_IPV6**: 2903*858ea5e5SAndroid Build Coastguard Worker * Indicate the new IP header version after decapsulating the outer 2904*858ea5e5SAndroid Build Coastguard Worker * IP header. Used when the inner and outer IP versions are different. 2905*858ea5e5SAndroid Build Coastguard Worker * 2906*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2907*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2908*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2909*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2910*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2911*858ea5e5SAndroid Build Coastguard Worker * Return 2912*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2913*858ea5e5SAndroid Build Coastguard Worker * 2914*858ea5e5SAndroid Build Coastguard Worker * long bpf_redirect_map(struct bpf_map *map, u64 key, u64 flags) 2915*858ea5e5SAndroid Build Coastguard Worker * Description 2916*858ea5e5SAndroid Build Coastguard Worker * Redirect the packet to the endpoint referenced by *map* at 2917*858ea5e5SAndroid Build Coastguard Worker * index *key*. Depending on its type, this *map* can contain 2918*858ea5e5SAndroid Build Coastguard Worker * references to net devices (for forwarding packets through other 2919*858ea5e5SAndroid Build Coastguard Worker * ports), or to CPUs (for redirecting XDP frames to another CPU; 2920*858ea5e5SAndroid Build Coastguard Worker * but this is only implemented for native XDP (with driver 2921*858ea5e5SAndroid Build Coastguard Worker * support) as of this writing). 2922*858ea5e5SAndroid Build Coastguard Worker * 2923*858ea5e5SAndroid Build Coastguard Worker * The lower two bits of *flags* are used as the return code if 2924*858ea5e5SAndroid Build Coastguard Worker * the map lookup fails. This is so that the return value can be 2925*858ea5e5SAndroid Build Coastguard Worker * one of the XDP program return codes up to **XDP_TX**, as chosen 2926*858ea5e5SAndroid Build Coastguard Worker * by the caller. The higher bits of *flags* can be set to 2927*858ea5e5SAndroid Build Coastguard Worker * BPF_F_BROADCAST or BPF_F_EXCLUDE_INGRESS as defined below. 2928*858ea5e5SAndroid Build Coastguard Worker * 2929*858ea5e5SAndroid Build Coastguard Worker * With BPF_F_BROADCAST the packet will be broadcasted to all the 2930*858ea5e5SAndroid Build Coastguard Worker * interfaces in the map, with BPF_F_EXCLUDE_INGRESS the ingress 2931*858ea5e5SAndroid Build Coastguard Worker * interface will be excluded when do broadcasting. 2932*858ea5e5SAndroid Build Coastguard Worker * 2933*858ea5e5SAndroid Build Coastguard Worker * See also **bpf_redirect**\ (), which only supports redirecting 2934*858ea5e5SAndroid Build Coastguard Worker * to an ifindex, but doesn't require a map to do so. 2935*858ea5e5SAndroid Build Coastguard Worker * Return 2936*858ea5e5SAndroid Build Coastguard Worker * **XDP_REDIRECT** on success, or the value of the two lower bits 2937*858ea5e5SAndroid Build Coastguard Worker * of the *flags* argument on error. 2938*858ea5e5SAndroid Build Coastguard Worker * 2939*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags) 2940*858ea5e5SAndroid Build Coastguard Worker * Description 2941*858ea5e5SAndroid Build Coastguard Worker * Redirect the packet to the socket referenced by *map* (of type 2942*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and 2943*858ea5e5SAndroid Build Coastguard Worker * egress interfaces can be used for redirection. The 2944*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INGRESS** value in *flags* is used to make the 2945*858ea5e5SAndroid Build Coastguard Worker * distinction (ingress path is selected if the flag is present, 2946*858ea5e5SAndroid Build Coastguard Worker * egress path otherwise). This is the only flag supported for now. 2947*858ea5e5SAndroid Build Coastguard Worker * Return 2948*858ea5e5SAndroid Build Coastguard Worker * **SK_PASS** on success, or **SK_DROP** on error. 2949*858ea5e5SAndroid Build Coastguard Worker * 2950*858ea5e5SAndroid Build Coastguard Worker * long bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags) 2951*858ea5e5SAndroid Build Coastguard Worker * Description 2952*858ea5e5SAndroid Build Coastguard Worker * Add an entry to, or update a *map* referencing sockets. The 2953*858ea5e5SAndroid Build Coastguard Worker * *skops* is used as a new value for the entry associated to 2954*858ea5e5SAndroid Build Coastguard Worker * *key*. *flags* is one of: 2955*858ea5e5SAndroid Build Coastguard Worker * 2956*858ea5e5SAndroid Build Coastguard Worker * **BPF_NOEXIST** 2957*858ea5e5SAndroid Build Coastguard Worker * The entry for *key* must not exist in the map. 2958*858ea5e5SAndroid Build Coastguard Worker * **BPF_EXIST** 2959*858ea5e5SAndroid Build Coastguard Worker * The entry for *key* must already exist in the map. 2960*858ea5e5SAndroid Build Coastguard Worker * **BPF_ANY** 2961*858ea5e5SAndroid Build Coastguard Worker * No condition on the existence of the entry for *key*. 2962*858ea5e5SAndroid Build Coastguard Worker * 2963*858ea5e5SAndroid Build Coastguard Worker * If the *map* has eBPF programs (parser and verdict), those will 2964*858ea5e5SAndroid Build Coastguard Worker * be inherited by the socket being added. If the socket is 2965*858ea5e5SAndroid Build Coastguard Worker * already attached to eBPF programs, this results in an error. 2966*858ea5e5SAndroid Build Coastguard Worker * Return 2967*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2968*858ea5e5SAndroid Build Coastguard Worker * 2969*858ea5e5SAndroid Build Coastguard Worker * long bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta) 2970*858ea5e5SAndroid Build Coastguard Worker * Description 2971*858ea5e5SAndroid Build Coastguard Worker * Adjust the address pointed by *xdp_md*\ **->data_meta** by 2972*858ea5e5SAndroid Build Coastguard Worker * *delta* (which can be positive or negative). Note that this 2973*858ea5e5SAndroid Build Coastguard Worker * operation modifies the address stored in *xdp_md*\ **->data**, 2974*858ea5e5SAndroid Build Coastguard Worker * so the latter must be loaded only after the helper has been 2975*858ea5e5SAndroid Build Coastguard Worker * called. 2976*858ea5e5SAndroid Build Coastguard Worker * 2977*858ea5e5SAndroid Build Coastguard Worker * The use of *xdp_md*\ **->data_meta** is optional and programs 2978*858ea5e5SAndroid Build Coastguard Worker * are not required to use it. The rationale is that when the 2979*858ea5e5SAndroid Build Coastguard Worker * packet is processed with XDP (e.g. as DoS filter), it is 2980*858ea5e5SAndroid Build Coastguard Worker * possible to push further meta data along with it before passing 2981*858ea5e5SAndroid Build Coastguard Worker * to the stack, and to give the guarantee that an ingress eBPF 2982*858ea5e5SAndroid Build Coastguard Worker * program attached as a TC classifier on the same device can pick 2983*858ea5e5SAndroid Build Coastguard Worker * this up for further post-processing. Since TC works with socket 2984*858ea5e5SAndroid Build Coastguard Worker * buffers, it remains possible to set from XDP the **mark** or 2985*858ea5e5SAndroid Build Coastguard Worker * **priority** pointers, or other pointers for the socket buffer. 2986*858ea5e5SAndroid Build Coastguard Worker * Having this scratch space generic and programmable allows for 2987*858ea5e5SAndroid Build Coastguard Worker * more flexibility as the user is free to store whatever meta 2988*858ea5e5SAndroid Build Coastguard Worker * data they need. 2989*858ea5e5SAndroid Build Coastguard Worker * 2990*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 2991*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 2992*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 2993*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 2994*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 2995*858ea5e5SAndroid Build Coastguard Worker * Return 2996*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 2997*858ea5e5SAndroid Build Coastguard Worker * 2998*858ea5e5SAndroid Build Coastguard Worker * long bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size) 2999*858ea5e5SAndroid Build Coastguard Worker * Description 3000*858ea5e5SAndroid Build Coastguard Worker * Read the value of a perf event counter, and store it into *buf* 3001*858ea5e5SAndroid Build Coastguard Worker * of size *buf_size*. This helper relies on a *map* of type 3002*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event 3003*858ea5e5SAndroid Build Coastguard Worker * counter is selected when *map* is updated with perf event file 3004*858ea5e5SAndroid Build Coastguard Worker * descriptors. The *map* is an array whose size is the number of 3005*858ea5e5SAndroid Build Coastguard Worker * available CPUs, and each cell contains a value relative to one 3006*858ea5e5SAndroid Build Coastguard Worker * CPU. The value to retrieve is indicated by *flags*, that 3007*858ea5e5SAndroid Build Coastguard Worker * contains the index of the CPU to look up, masked with 3008*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to 3009*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_CURRENT_CPU** to indicate that the value for the 3010*858ea5e5SAndroid Build Coastguard Worker * current CPU should be retrieved. 3011*858ea5e5SAndroid Build Coastguard Worker * 3012*858ea5e5SAndroid Build Coastguard Worker * This helper behaves in a way close to 3013*858ea5e5SAndroid Build Coastguard Worker * **bpf_perf_event_read**\ () helper, save that instead of 3014*858ea5e5SAndroid Build Coastguard Worker * just returning the value observed, it fills the *buf* 3015*858ea5e5SAndroid Build Coastguard Worker * structure. This allows for additional data to be retrieved: in 3016*858ea5e5SAndroid Build Coastguard Worker * particular, the enabled and running times (in *buf*\ 3017*858ea5e5SAndroid Build Coastguard Worker * **->enabled** and *buf*\ **->running**, respectively) are 3018*858ea5e5SAndroid Build Coastguard Worker * copied. In general, **bpf_perf_event_read_value**\ () is 3019*858ea5e5SAndroid Build Coastguard Worker * recommended over **bpf_perf_event_read**\ (), which has some 3020*858ea5e5SAndroid Build Coastguard Worker * ABI issues and provides fewer functionalities. 3021*858ea5e5SAndroid Build Coastguard Worker * 3022*858ea5e5SAndroid Build Coastguard Worker * These values are interesting, because hardware PMU (Performance 3023*858ea5e5SAndroid Build Coastguard Worker * Monitoring Unit) counters are limited resources. When there are 3024*858ea5e5SAndroid Build Coastguard Worker * more PMU based perf events opened than available counters, 3025*858ea5e5SAndroid Build Coastguard Worker * kernel will multiplex these events so each event gets certain 3026*858ea5e5SAndroid Build Coastguard Worker * percentage (but not all) of the PMU time. In case that 3027*858ea5e5SAndroid Build Coastguard Worker * multiplexing happens, the number of samples or counter value 3028*858ea5e5SAndroid Build Coastguard Worker * will not reflect the case compared to when no multiplexing 3029*858ea5e5SAndroid Build Coastguard Worker * occurs. This makes comparison between different runs difficult. 3030*858ea5e5SAndroid Build Coastguard Worker * Typically, the counter value should be normalized before 3031*858ea5e5SAndroid Build Coastguard Worker * comparing to other experiments. The usual normalization is done 3032*858ea5e5SAndroid Build Coastguard Worker * as follows. 3033*858ea5e5SAndroid Build Coastguard Worker * 3034*858ea5e5SAndroid Build Coastguard Worker * :: 3035*858ea5e5SAndroid Build Coastguard Worker * 3036*858ea5e5SAndroid Build Coastguard Worker * normalized_counter = counter * t_enabled / t_running 3037*858ea5e5SAndroid Build Coastguard Worker * 3038*858ea5e5SAndroid Build Coastguard Worker * Where t_enabled is the time enabled for event and t_running is 3039*858ea5e5SAndroid Build Coastguard Worker * the time running for event since last normalization. The 3040*858ea5e5SAndroid Build Coastguard Worker * enabled and running times are accumulated since the perf event 3041*858ea5e5SAndroid Build Coastguard Worker * open. To achieve scaling factor between two invocations of an 3042*858ea5e5SAndroid Build Coastguard Worker * eBPF program, users can use CPU id as the key (which is 3043*858ea5e5SAndroid Build Coastguard Worker * typical for perf array usage model) to remember the previous 3044*858ea5e5SAndroid Build Coastguard Worker * value and do the calculation inside the eBPF program. 3045*858ea5e5SAndroid Build Coastguard Worker * Return 3046*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3047*858ea5e5SAndroid Build Coastguard Worker * 3048*858ea5e5SAndroid Build Coastguard Worker * long bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size) 3049*858ea5e5SAndroid Build Coastguard Worker * Description 3050*858ea5e5SAndroid Build Coastguard Worker * For an eBPF program attached to a perf event, retrieve the 3051*858ea5e5SAndroid Build Coastguard Worker * value of the event counter associated to *ctx* and store it in 3052*858ea5e5SAndroid Build Coastguard Worker * the structure pointed by *buf* and of size *buf_size*. Enabled 3053*858ea5e5SAndroid Build Coastguard Worker * and running times are also stored in the structure (see 3054*858ea5e5SAndroid Build Coastguard Worker * description of helper **bpf_perf_event_read_value**\ () for 3055*858ea5e5SAndroid Build Coastguard Worker * more details). 3056*858ea5e5SAndroid Build Coastguard Worker * Return 3057*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3058*858ea5e5SAndroid Build Coastguard Worker * 3059*858ea5e5SAndroid Build Coastguard Worker * long bpf_getsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen) 3060*858ea5e5SAndroid Build Coastguard Worker * Description 3061*858ea5e5SAndroid Build Coastguard Worker * Emulate a call to **getsockopt()** on the socket associated to 3062*858ea5e5SAndroid Build Coastguard Worker * *bpf_socket*, which must be a full socket. The *level* at 3063*858ea5e5SAndroid Build Coastguard Worker * which the option resides and the name *optname* of the option 3064*858ea5e5SAndroid Build Coastguard Worker * must be specified, see **getsockopt(2)** for more information. 3065*858ea5e5SAndroid Build Coastguard Worker * The retrieved value is stored in the structure pointed by 3066*858ea5e5SAndroid Build Coastguard Worker * *opval* and of length *optlen*. 3067*858ea5e5SAndroid Build Coastguard Worker * 3068*858ea5e5SAndroid Build Coastguard Worker * *bpf_socket* should be one of the following: 3069*858ea5e5SAndroid Build Coastguard Worker * 3070*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**. 3071*858ea5e5SAndroid Build Coastguard Worker * * **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT**, 3072*858ea5e5SAndroid Build Coastguard Worker * **BPF_CGROUP_INET6_CONNECT** and **BPF_CGROUP_UNIX_CONNECT**. 3073*858ea5e5SAndroid Build Coastguard Worker * 3074*858ea5e5SAndroid Build Coastguard Worker * This helper actually implements a subset of **getsockopt()**. 3075*858ea5e5SAndroid Build Coastguard Worker * It supports the same set of *optname*\ s that is supported by 3076*858ea5e5SAndroid Build Coastguard Worker * the **bpf_setsockopt**\ () helper. The exceptions are 3077*858ea5e5SAndroid Build Coastguard Worker * **TCP_BPF_*** is **bpf_setsockopt**\ () only and 3078*858ea5e5SAndroid Build Coastguard Worker * **TCP_SAVED_SYN** is **bpf_getsockopt**\ () only. 3079*858ea5e5SAndroid Build Coastguard Worker * Return 3080*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3081*858ea5e5SAndroid Build Coastguard Worker * 3082*858ea5e5SAndroid Build Coastguard Worker * long bpf_override_return(struct pt_regs *regs, u64 rc) 3083*858ea5e5SAndroid Build Coastguard Worker * Description 3084*858ea5e5SAndroid Build Coastguard Worker * Used for error injection, this helper uses kprobes to override 3085*858ea5e5SAndroid Build Coastguard Worker * the return value of the probed function, and to set it to *rc*. 3086*858ea5e5SAndroid Build Coastguard Worker * The first argument is the context *regs* on which the kprobe 3087*858ea5e5SAndroid Build Coastguard Worker * works. 3088*858ea5e5SAndroid Build Coastguard Worker * 3089*858ea5e5SAndroid Build Coastguard Worker * This helper works by setting the PC (program counter) 3090*858ea5e5SAndroid Build Coastguard Worker * to an override function which is run in place of the original 3091*858ea5e5SAndroid Build Coastguard Worker * probed function. This means the probed function is not run at 3092*858ea5e5SAndroid Build Coastguard Worker * all. The replacement function just returns with the required 3093*858ea5e5SAndroid Build Coastguard Worker * value. 3094*858ea5e5SAndroid Build Coastguard Worker * 3095*858ea5e5SAndroid Build Coastguard Worker * This helper has security implications, and thus is subject to 3096*858ea5e5SAndroid Build Coastguard Worker * restrictions. It is only available if the kernel was compiled 3097*858ea5e5SAndroid Build Coastguard Worker * with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration 3098*858ea5e5SAndroid Build Coastguard Worker * option, and in this case it only works on functions tagged with 3099*858ea5e5SAndroid Build Coastguard Worker * **ALLOW_ERROR_INJECTION** in the kernel code. 3100*858ea5e5SAndroid Build Coastguard Worker * 3101*858ea5e5SAndroid Build Coastguard Worker * Also, the helper is only available for the architectures having 3102*858ea5e5SAndroid Build Coastguard Worker * the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing, 3103*858ea5e5SAndroid Build Coastguard Worker * x86 architecture is the only one to support this feature. 3104*858ea5e5SAndroid Build Coastguard Worker * Return 3105*858ea5e5SAndroid Build Coastguard Worker * 0 3106*858ea5e5SAndroid Build Coastguard Worker * 3107*858ea5e5SAndroid Build Coastguard Worker * long bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval) 3108*858ea5e5SAndroid Build Coastguard Worker * Description 3109*858ea5e5SAndroid Build Coastguard Worker * Attempt to set the value of the **bpf_sock_ops_cb_flags** field 3110*858ea5e5SAndroid Build Coastguard Worker * for the full TCP socket associated to *bpf_sock_ops* to 3111*858ea5e5SAndroid Build Coastguard Worker * *argval*. 3112*858ea5e5SAndroid Build Coastguard Worker * 3113*858ea5e5SAndroid Build Coastguard Worker * The primary use of this field is to determine if there should 3114*858ea5e5SAndroid Build Coastguard Worker * be calls to eBPF programs of type 3115*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP 3116*858ea5e5SAndroid Build Coastguard Worker * code. A program of the same type can change its value, per 3117*858ea5e5SAndroid Build Coastguard Worker * connection and as necessary, when the connection is 3118*858ea5e5SAndroid Build Coastguard Worker * established. This field is directly accessible for reading, but 3119*858ea5e5SAndroid Build Coastguard Worker * this helper must be used for updates in order to return an 3120*858ea5e5SAndroid Build Coastguard Worker * error if an eBPF program tries to set a callback that is not 3121*858ea5e5SAndroid Build Coastguard Worker * supported in the current kernel. 3122*858ea5e5SAndroid Build Coastguard Worker * 3123*858ea5e5SAndroid Build Coastguard Worker * *argval* is a flag array which can combine these flags: 3124*858ea5e5SAndroid Build Coastguard Worker * 3125*858ea5e5SAndroid Build Coastguard Worker * * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out) 3126*858ea5e5SAndroid Build Coastguard Worker * * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission) 3127*858ea5e5SAndroid Build Coastguard Worker * * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change) 3128*858ea5e5SAndroid Build Coastguard Worker * * **BPF_SOCK_OPS_RTT_CB_FLAG** (every RTT) 3129*858ea5e5SAndroid Build Coastguard Worker * 3130*858ea5e5SAndroid Build Coastguard Worker * Therefore, this function can be used to clear a callback flag by 3131*858ea5e5SAndroid Build Coastguard Worker * setting the appropriate bit to zero. e.g. to disable the RTO 3132*858ea5e5SAndroid Build Coastguard Worker * callback: 3133*858ea5e5SAndroid Build Coastguard Worker * 3134*858ea5e5SAndroid Build Coastguard Worker * **bpf_sock_ops_cb_flags_set(bpf_sock,** 3135*858ea5e5SAndroid Build Coastguard Worker * **bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)** 3136*858ea5e5SAndroid Build Coastguard Worker * 3137*858ea5e5SAndroid Build Coastguard Worker * Here are some examples of where one could call such eBPF 3138*858ea5e5SAndroid Build Coastguard Worker * program: 3139*858ea5e5SAndroid Build Coastguard Worker * 3140*858ea5e5SAndroid Build Coastguard Worker * * When RTO fires. 3141*858ea5e5SAndroid Build Coastguard Worker * * When a packet is retransmitted. 3142*858ea5e5SAndroid Build Coastguard Worker * * When the connection terminates. 3143*858ea5e5SAndroid Build Coastguard Worker * * When a packet is sent. 3144*858ea5e5SAndroid Build Coastguard Worker * * When a packet is received. 3145*858ea5e5SAndroid Build Coastguard Worker * Return 3146*858ea5e5SAndroid Build Coastguard Worker * Code **-EINVAL** if the socket is not a full TCP socket; 3147*858ea5e5SAndroid Build Coastguard Worker * otherwise, a positive number containing the bits that could not 3148*858ea5e5SAndroid Build Coastguard Worker * be set is returned (which comes down to 0 if all bits were set 3149*858ea5e5SAndroid Build Coastguard Worker * as required). 3150*858ea5e5SAndroid Build Coastguard Worker * 3151*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags) 3152*858ea5e5SAndroid Build Coastguard Worker * Description 3153*858ea5e5SAndroid Build Coastguard Worker * This helper is used in programs implementing policies at the 3154*858ea5e5SAndroid Build Coastguard Worker * socket level. If the message *msg* is allowed to pass (i.e. if 3155*858ea5e5SAndroid Build Coastguard Worker * the verdict eBPF program returns **SK_PASS**), redirect it to 3156*858ea5e5SAndroid Build Coastguard Worker * the socket referenced by *map* (of type 3157*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and 3158*858ea5e5SAndroid Build Coastguard Worker * egress interfaces can be used for redirection. The 3159*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INGRESS** value in *flags* is used to make the 3160*858ea5e5SAndroid Build Coastguard Worker * distinction (ingress path is selected if the flag is present, 3161*858ea5e5SAndroid Build Coastguard Worker * egress path otherwise). This is the only flag supported for now. 3162*858ea5e5SAndroid Build Coastguard Worker * Return 3163*858ea5e5SAndroid Build Coastguard Worker * **SK_PASS** on success, or **SK_DROP** on error. 3164*858ea5e5SAndroid Build Coastguard Worker * 3165*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes) 3166*858ea5e5SAndroid Build Coastguard Worker * Description 3167*858ea5e5SAndroid Build Coastguard Worker * For socket policies, apply the verdict of the eBPF program to 3168*858ea5e5SAndroid Build Coastguard Worker * the next *bytes* (number of bytes) of message *msg*. 3169*858ea5e5SAndroid Build Coastguard Worker * 3170*858ea5e5SAndroid Build Coastguard Worker * For example, this helper can be used in the following cases: 3171*858ea5e5SAndroid Build Coastguard Worker * 3172*858ea5e5SAndroid Build Coastguard Worker * * A single **sendmsg**\ () or **sendfile**\ () system call 3173*858ea5e5SAndroid Build Coastguard Worker * contains multiple logical messages that the eBPF program is 3174*858ea5e5SAndroid Build Coastguard Worker * supposed to read and for which it should apply a verdict. 3175*858ea5e5SAndroid Build Coastguard Worker * * An eBPF program only cares to read the first *bytes* of a 3176*858ea5e5SAndroid Build Coastguard Worker * *msg*. If the message has a large payload, then setting up 3177*858ea5e5SAndroid Build Coastguard Worker * and calling the eBPF program repeatedly for all bytes, even 3178*858ea5e5SAndroid Build Coastguard Worker * though the verdict is already known, would create unnecessary 3179*858ea5e5SAndroid Build Coastguard Worker * overhead. 3180*858ea5e5SAndroid Build Coastguard Worker * 3181*858ea5e5SAndroid Build Coastguard Worker * When called from within an eBPF program, the helper sets a 3182*858ea5e5SAndroid Build Coastguard Worker * counter internal to the BPF infrastructure, that is used to 3183*858ea5e5SAndroid Build Coastguard Worker * apply the last verdict to the next *bytes*. If *bytes* is 3184*858ea5e5SAndroid Build Coastguard Worker * smaller than the current data being processed from a 3185*858ea5e5SAndroid Build Coastguard Worker * **sendmsg**\ () or **sendfile**\ () system call, the first 3186*858ea5e5SAndroid Build Coastguard Worker * *bytes* will be sent and the eBPF program will be re-run with 3187*858ea5e5SAndroid Build Coastguard Worker * the pointer for start of data pointing to byte number *bytes* 3188*858ea5e5SAndroid Build Coastguard Worker * **+ 1**. If *bytes* is larger than the current data being 3189*858ea5e5SAndroid Build Coastguard Worker * processed, then the eBPF verdict will be applied to multiple 3190*858ea5e5SAndroid Build Coastguard Worker * **sendmsg**\ () or **sendfile**\ () calls until *bytes* are 3191*858ea5e5SAndroid Build Coastguard Worker * consumed. 3192*858ea5e5SAndroid Build Coastguard Worker * 3193*858ea5e5SAndroid Build Coastguard Worker * Note that if a socket closes with the internal counter holding 3194*858ea5e5SAndroid Build Coastguard Worker * a non-zero value, this is not a problem because data is not 3195*858ea5e5SAndroid Build Coastguard Worker * being buffered for *bytes* and is sent as it is received. 3196*858ea5e5SAndroid Build Coastguard Worker * Return 3197*858ea5e5SAndroid Build Coastguard Worker * 0 3198*858ea5e5SAndroid Build Coastguard Worker * 3199*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes) 3200*858ea5e5SAndroid Build Coastguard Worker * Description 3201*858ea5e5SAndroid Build Coastguard Worker * For socket policies, prevent the execution of the verdict eBPF 3202*858ea5e5SAndroid Build Coastguard Worker * program for message *msg* until *bytes* (byte number) have been 3203*858ea5e5SAndroid Build Coastguard Worker * accumulated. 3204*858ea5e5SAndroid Build Coastguard Worker * 3205*858ea5e5SAndroid Build Coastguard Worker * This can be used when one needs a specific number of bytes 3206*858ea5e5SAndroid Build Coastguard Worker * before a verdict can be assigned, even if the data spans 3207*858ea5e5SAndroid Build Coastguard Worker * multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme 3208*858ea5e5SAndroid Build Coastguard Worker * case would be a user calling **sendmsg**\ () repeatedly with 3209*858ea5e5SAndroid Build Coastguard Worker * 1-byte long message segments. Obviously, this is bad for 3210*858ea5e5SAndroid Build Coastguard Worker * performance, but it is still valid. If the eBPF program needs 3211*858ea5e5SAndroid Build Coastguard Worker * *bytes* bytes to validate a header, this helper can be used to 3212*858ea5e5SAndroid Build Coastguard Worker * prevent the eBPF program to be called again until *bytes* have 3213*858ea5e5SAndroid Build Coastguard Worker * been accumulated. 3214*858ea5e5SAndroid Build Coastguard Worker * Return 3215*858ea5e5SAndroid Build Coastguard Worker * 0 3216*858ea5e5SAndroid Build Coastguard Worker * 3217*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags) 3218*858ea5e5SAndroid Build Coastguard Worker * Description 3219*858ea5e5SAndroid Build Coastguard Worker * For socket policies, pull in non-linear data from user space 3220*858ea5e5SAndroid Build Coastguard Worker * for *msg* and set pointers *msg*\ **->data** and *msg*\ 3221*858ea5e5SAndroid Build Coastguard Worker * **->data_end** to *start* and *end* bytes offsets into *msg*, 3222*858ea5e5SAndroid Build Coastguard Worker * respectively. 3223*858ea5e5SAndroid Build Coastguard Worker * 3224*858ea5e5SAndroid Build Coastguard Worker * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a 3225*858ea5e5SAndroid Build Coastguard Worker * *msg* it can only parse data that the (**data**, **data_end**) 3226*858ea5e5SAndroid Build Coastguard Worker * pointers have already consumed. For **sendmsg**\ () hooks this 3227*858ea5e5SAndroid Build Coastguard Worker * is likely the first scatterlist element. But for calls relying 3228*858ea5e5SAndroid Build Coastguard Worker * on the **sendpage** handler (e.g. **sendfile**\ ()) this will 3229*858ea5e5SAndroid Build Coastguard Worker * be the range (**0**, **0**) because the data is shared with 3230*858ea5e5SAndroid Build Coastguard Worker * user space and by default the objective is to avoid allowing 3231*858ea5e5SAndroid Build Coastguard Worker * user space to modify data while (or after) eBPF verdict is 3232*858ea5e5SAndroid Build Coastguard Worker * being decided. This helper can be used to pull in data and to 3233*858ea5e5SAndroid Build Coastguard Worker * set the start and end pointer to given values. Data will be 3234*858ea5e5SAndroid Build Coastguard Worker * copied if necessary (i.e. if data was not linear and if start 3235*858ea5e5SAndroid Build Coastguard Worker * and end pointers do not point to the same chunk). 3236*858ea5e5SAndroid Build Coastguard Worker * 3237*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 3238*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 3239*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 3240*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 3241*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 3242*858ea5e5SAndroid Build Coastguard Worker * 3243*858ea5e5SAndroid Build Coastguard Worker * All values for *flags* are reserved for future usage, and must 3244*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 3245*858ea5e5SAndroid Build Coastguard Worker * Return 3246*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3247*858ea5e5SAndroid Build Coastguard Worker * 3248*858ea5e5SAndroid Build Coastguard Worker * long bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len) 3249*858ea5e5SAndroid Build Coastguard Worker * Description 3250*858ea5e5SAndroid Build Coastguard Worker * Bind the socket associated to *ctx* to the address pointed by 3251*858ea5e5SAndroid Build Coastguard Worker * *addr*, of length *addr_len*. This allows for making outgoing 3252*858ea5e5SAndroid Build Coastguard Worker * connection from the desired IP address, which can be useful for 3253*858ea5e5SAndroid Build Coastguard Worker * example when all processes inside a cgroup should use one 3254*858ea5e5SAndroid Build Coastguard Worker * single IP address on a host that has multiple IP configured. 3255*858ea5e5SAndroid Build Coastguard Worker * 3256*858ea5e5SAndroid Build Coastguard Worker * This helper works for IPv4 and IPv6, TCP and UDP sockets. The 3257*858ea5e5SAndroid Build Coastguard Worker * domain (*addr*\ **->sa_family**) must be **AF_INET** (or 3258*858ea5e5SAndroid Build Coastguard Worker * **AF_INET6**). It's advised to pass zero port (**sin_port** 3259*858ea5e5SAndroid Build Coastguard Worker * or **sin6_port**) which triggers IP_BIND_ADDRESS_NO_PORT-like 3260*858ea5e5SAndroid Build Coastguard Worker * behavior and lets the kernel efficiently pick up an unused 3261*858ea5e5SAndroid Build Coastguard Worker * port as long as 4-tuple is unique. Passing non-zero port might 3262*858ea5e5SAndroid Build Coastguard Worker * lead to degraded performance. 3263*858ea5e5SAndroid Build Coastguard Worker * Return 3264*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3265*858ea5e5SAndroid Build Coastguard Worker * 3266*858ea5e5SAndroid Build Coastguard Worker * long bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta) 3267*858ea5e5SAndroid Build Coastguard Worker * Description 3268*858ea5e5SAndroid Build Coastguard Worker * Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is 3269*858ea5e5SAndroid Build Coastguard Worker * possible to both shrink and grow the packet tail. 3270*858ea5e5SAndroid Build Coastguard Worker * Shrink done via *delta* being a negative integer. 3271*858ea5e5SAndroid Build Coastguard Worker * 3272*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 3273*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 3274*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 3275*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 3276*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 3277*858ea5e5SAndroid Build Coastguard Worker * Return 3278*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3279*858ea5e5SAndroid Build Coastguard Worker * 3280*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags) 3281*858ea5e5SAndroid Build Coastguard Worker * Description 3282*858ea5e5SAndroid Build Coastguard Worker * Retrieve the XFRM state (IP transform framework, see also 3283*858ea5e5SAndroid Build Coastguard Worker * **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*. 3284*858ea5e5SAndroid Build Coastguard Worker * 3285*858ea5e5SAndroid Build Coastguard Worker * The retrieved value is stored in the **struct bpf_xfrm_state** 3286*858ea5e5SAndroid Build Coastguard Worker * pointed by *xfrm_state* and of length *size*. 3287*858ea5e5SAndroid Build Coastguard Worker * 3288*858ea5e5SAndroid Build Coastguard Worker * All values for *flags* are reserved for future usage, and must 3289*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 3290*858ea5e5SAndroid Build Coastguard Worker * 3291*858ea5e5SAndroid Build Coastguard Worker * This helper is available only if the kernel was compiled with 3292*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_XFRM** configuration option. 3293*858ea5e5SAndroid Build Coastguard Worker * Return 3294*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3295*858ea5e5SAndroid Build Coastguard Worker * 3296*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_stack(void *ctx, void *buf, u32 size, u64 flags) 3297*858ea5e5SAndroid Build Coastguard Worker * Description 3298*858ea5e5SAndroid Build Coastguard Worker * Return a user or a kernel stack in bpf program provided buffer. 3299*858ea5e5SAndroid Build Coastguard Worker * To achieve this, the helper needs *ctx*, which is a pointer 3300*858ea5e5SAndroid Build Coastguard Worker * to the context on which the tracing program is executed. 3301*858ea5e5SAndroid Build Coastguard Worker * To store the stacktrace, the bpf program provides *buf* with 3302*858ea5e5SAndroid Build Coastguard Worker * a nonnegative *size*. 3303*858ea5e5SAndroid Build Coastguard Worker * 3304*858ea5e5SAndroid Build Coastguard Worker * The last argument, *flags*, holds the number of stack frames to 3305*858ea5e5SAndroid Build Coastguard Worker * skip (from 0 to 255), masked with 3306*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 3307*858ea5e5SAndroid Build Coastguard Worker * the following flags: 3308*858ea5e5SAndroid Build Coastguard Worker * 3309*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_USER_STACK** 3310*858ea5e5SAndroid Build Coastguard Worker * Collect a user space stack instead of a kernel stack. 3311*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_USER_BUILD_ID** 3312*858ea5e5SAndroid Build Coastguard Worker * Collect (build_id, file_offset) instead of ips for user 3313*858ea5e5SAndroid Build Coastguard Worker * stack, only valid if **BPF_F_USER_STACK** is also 3314*858ea5e5SAndroid Build Coastguard Worker * specified. 3315*858ea5e5SAndroid Build Coastguard Worker * 3316*858ea5e5SAndroid Build Coastguard Worker * *file_offset* is an offset relative to the beginning 3317*858ea5e5SAndroid Build Coastguard Worker * of the executable or shared object file backing the vma 3318*858ea5e5SAndroid Build Coastguard Worker * which the *ip* falls in. It is *not* an offset relative 3319*858ea5e5SAndroid Build Coastguard Worker * to that object's base address. Accordingly, it must be 3320*858ea5e5SAndroid Build Coastguard Worker * adjusted by adding (sh_addr - sh_offset), where 3321*858ea5e5SAndroid Build Coastguard Worker * sh_{addr,offset} correspond to the executable section 3322*858ea5e5SAndroid Build Coastguard Worker * containing *file_offset* in the object, for comparisons 3323*858ea5e5SAndroid Build Coastguard Worker * to symbols' st_value to be valid. 3324*858ea5e5SAndroid Build Coastguard Worker * 3325*858ea5e5SAndroid Build Coastguard Worker * **bpf_get_stack**\ () can collect up to 3326*858ea5e5SAndroid Build Coastguard Worker * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject 3327*858ea5e5SAndroid Build Coastguard Worker * to sufficient large buffer size. Note that 3328*858ea5e5SAndroid Build Coastguard Worker * this limit can be controlled with the **sysctl** program, and 3329*858ea5e5SAndroid Build Coastguard Worker * that it should be manually increased in order to profile long 3330*858ea5e5SAndroid Build Coastguard Worker * user stacks (such as stacks for Java programs). To do so, use: 3331*858ea5e5SAndroid Build Coastguard Worker * 3332*858ea5e5SAndroid Build Coastguard Worker * :: 3333*858ea5e5SAndroid Build Coastguard Worker * 3334*858ea5e5SAndroid Build Coastguard Worker * # sysctl kernel.perf_event_max_stack=<new value> 3335*858ea5e5SAndroid Build Coastguard Worker * Return 3336*858ea5e5SAndroid Build Coastguard Worker * The non-negative copied *buf* length equal to or less than 3337*858ea5e5SAndroid Build Coastguard Worker * *size* on success, or a negative error in case of failure. 3338*858ea5e5SAndroid Build Coastguard Worker * 3339*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_load_bytes_relative(const void *skb, u32 offset, void *to, u32 len, u32 start_header) 3340*858ea5e5SAndroid Build Coastguard Worker * Description 3341*858ea5e5SAndroid Build Coastguard Worker * This helper is similar to **bpf_skb_load_bytes**\ () in that 3342*858ea5e5SAndroid Build Coastguard Worker * it provides an easy way to load *len* bytes from *offset* 3343*858ea5e5SAndroid Build Coastguard Worker * from the packet associated to *skb*, into the buffer pointed 3344*858ea5e5SAndroid Build Coastguard Worker * by *to*. The difference to **bpf_skb_load_bytes**\ () is that 3345*858ea5e5SAndroid Build Coastguard Worker * a fifth argument *start_header* exists in order to select a 3346*858ea5e5SAndroid Build Coastguard Worker * base offset to start from. *start_header* can be one of: 3347*858ea5e5SAndroid Build Coastguard Worker * 3348*858ea5e5SAndroid Build Coastguard Worker * **BPF_HDR_START_MAC** 3349*858ea5e5SAndroid Build Coastguard Worker * Base offset to load data from is *skb*'s mac header. 3350*858ea5e5SAndroid Build Coastguard Worker * **BPF_HDR_START_NET** 3351*858ea5e5SAndroid Build Coastguard Worker * Base offset to load data from is *skb*'s network header. 3352*858ea5e5SAndroid Build Coastguard Worker * 3353*858ea5e5SAndroid Build Coastguard Worker * In general, "direct packet access" is the preferred method to 3354*858ea5e5SAndroid Build Coastguard Worker * access packet data, however, this helper is in particular useful 3355*858ea5e5SAndroid Build Coastguard Worker * in socket filters where *skb*\ **->data** does not always point 3356*858ea5e5SAndroid Build Coastguard Worker * to the start of the mac header and where "direct packet access" 3357*858ea5e5SAndroid Build Coastguard Worker * is not available. 3358*858ea5e5SAndroid Build Coastguard Worker * Return 3359*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3360*858ea5e5SAndroid Build Coastguard Worker * 3361*858ea5e5SAndroid Build Coastguard Worker * long bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags) 3362*858ea5e5SAndroid Build Coastguard Worker * Description 3363*858ea5e5SAndroid Build Coastguard Worker * Do FIB lookup in kernel tables using parameters in *params*. 3364*858ea5e5SAndroid Build Coastguard Worker * If lookup is successful and result shows packet is to be 3365*858ea5e5SAndroid Build Coastguard Worker * forwarded, the neighbor tables are searched for the nexthop. 3366*858ea5e5SAndroid Build Coastguard Worker * If successful (ie., FIB lookup shows forwarding and nexthop 3367*858ea5e5SAndroid Build Coastguard Worker * is resolved), the nexthop address is returned in ipv4_dst 3368*858ea5e5SAndroid Build Coastguard Worker * or ipv6_dst based on family, smac is set to mac address of 3369*858ea5e5SAndroid Build Coastguard Worker * egress device, dmac is set to nexthop mac address, rt_metric 3370*858ea5e5SAndroid Build Coastguard Worker * is set to metric from route (IPv4/IPv6 only), and ifindex 3371*858ea5e5SAndroid Build Coastguard Worker * is set to the device index of the nexthop from the FIB lookup. 3372*858ea5e5SAndroid Build Coastguard Worker * 3373*858ea5e5SAndroid Build Coastguard Worker * *plen* argument is the size of the passed in struct. 3374*858ea5e5SAndroid Build Coastguard Worker * *flags* argument can be a combination of one or more of the 3375*858ea5e5SAndroid Build Coastguard Worker * following values: 3376*858ea5e5SAndroid Build Coastguard Worker * 3377*858ea5e5SAndroid Build Coastguard Worker * **BPF_FIB_LOOKUP_DIRECT** 3378*858ea5e5SAndroid Build Coastguard Worker * Do a direct table lookup vs full lookup using FIB 3379*858ea5e5SAndroid Build Coastguard Worker * rules. 3380*858ea5e5SAndroid Build Coastguard Worker * **BPF_FIB_LOOKUP_TBID** 3381*858ea5e5SAndroid Build Coastguard Worker * Used with BPF_FIB_LOOKUP_DIRECT. 3382*858ea5e5SAndroid Build Coastguard Worker * Use the routing table ID present in *params*->tbid 3383*858ea5e5SAndroid Build Coastguard Worker * for the fib lookup. 3384*858ea5e5SAndroid Build Coastguard Worker * **BPF_FIB_LOOKUP_OUTPUT** 3385*858ea5e5SAndroid Build Coastguard Worker * Perform lookup from an egress perspective (default is 3386*858ea5e5SAndroid Build Coastguard Worker * ingress). 3387*858ea5e5SAndroid Build Coastguard Worker * **BPF_FIB_LOOKUP_SKIP_NEIGH** 3388*858ea5e5SAndroid Build Coastguard Worker * Skip the neighbour table lookup. *params*->dmac 3389*858ea5e5SAndroid Build Coastguard Worker * and *params*->smac will not be set as output. A common 3390*858ea5e5SAndroid Build Coastguard Worker * use case is to call **bpf_redirect_neigh**\ () after 3391*858ea5e5SAndroid Build Coastguard Worker * doing **bpf_fib_lookup**\ (). 3392*858ea5e5SAndroid Build Coastguard Worker * **BPF_FIB_LOOKUP_SRC** 3393*858ea5e5SAndroid Build Coastguard Worker * Derive and set source IP addr in *params*->ipv{4,6}_src 3394*858ea5e5SAndroid Build Coastguard Worker * for the nexthop. If the src addr cannot be derived, 3395*858ea5e5SAndroid Build Coastguard Worker * **BPF_FIB_LKUP_RET_NO_SRC_ADDR** is returned. In this 3396*858ea5e5SAndroid Build Coastguard Worker * case, *params*->dmac and *params*->smac are not set either. 3397*858ea5e5SAndroid Build Coastguard Worker * 3398*858ea5e5SAndroid Build Coastguard Worker * *ctx* is either **struct xdp_md** for XDP programs or 3399*858ea5e5SAndroid Build Coastguard Worker * **struct sk_buff** tc cls_act programs. 3400*858ea5e5SAndroid Build Coastguard Worker * Return 3401*858ea5e5SAndroid Build Coastguard Worker * * < 0 if any input argument is invalid 3402*858ea5e5SAndroid Build Coastguard Worker * * 0 on success (packet is forwarded, nexthop neighbor exists) 3403*858ea5e5SAndroid Build Coastguard Worker * * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the 3404*858ea5e5SAndroid Build Coastguard Worker * packet is not forwarded or needs assist from full stack 3405*858ea5e5SAndroid Build Coastguard Worker * 3406*858ea5e5SAndroid Build Coastguard Worker * If lookup fails with BPF_FIB_LKUP_RET_FRAG_NEEDED, then the MTU 3407*858ea5e5SAndroid Build Coastguard Worker * was exceeded and output params->mtu_result contains the MTU. 3408*858ea5e5SAndroid Build Coastguard Worker * 3409*858ea5e5SAndroid Build Coastguard Worker * long bpf_sock_hash_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags) 3410*858ea5e5SAndroid Build Coastguard Worker * Description 3411*858ea5e5SAndroid Build Coastguard Worker * Add an entry to, or update a sockhash *map* referencing sockets. 3412*858ea5e5SAndroid Build Coastguard Worker * The *skops* is used as a new value for the entry associated to 3413*858ea5e5SAndroid Build Coastguard Worker * *key*. *flags* is one of: 3414*858ea5e5SAndroid Build Coastguard Worker * 3415*858ea5e5SAndroid Build Coastguard Worker * **BPF_NOEXIST** 3416*858ea5e5SAndroid Build Coastguard Worker * The entry for *key* must not exist in the map. 3417*858ea5e5SAndroid Build Coastguard Worker * **BPF_EXIST** 3418*858ea5e5SAndroid Build Coastguard Worker * The entry for *key* must already exist in the map. 3419*858ea5e5SAndroid Build Coastguard Worker * **BPF_ANY** 3420*858ea5e5SAndroid Build Coastguard Worker * No condition on the existence of the entry for *key*. 3421*858ea5e5SAndroid Build Coastguard Worker * 3422*858ea5e5SAndroid Build Coastguard Worker * If the *map* has eBPF programs (parser and verdict), those will 3423*858ea5e5SAndroid Build Coastguard Worker * be inherited by the socket being added. If the socket is 3424*858ea5e5SAndroid Build Coastguard Worker * already attached to eBPF programs, this results in an error. 3425*858ea5e5SAndroid Build Coastguard Worker * Return 3426*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3427*858ea5e5SAndroid Build Coastguard Worker * 3428*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags) 3429*858ea5e5SAndroid Build Coastguard Worker * Description 3430*858ea5e5SAndroid Build Coastguard Worker * This helper is used in programs implementing policies at the 3431*858ea5e5SAndroid Build Coastguard Worker * socket level. If the message *msg* is allowed to pass (i.e. if 3432*858ea5e5SAndroid Build Coastguard Worker * the verdict eBPF program returns **SK_PASS**), redirect it to 3433*858ea5e5SAndroid Build Coastguard Worker * the socket referenced by *map* (of type 3434*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and 3435*858ea5e5SAndroid Build Coastguard Worker * egress interfaces can be used for redirection. The 3436*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INGRESS** value in *flags* is used to make the 3437*858ea5e5SAndroid Build Coastguard Worker * distinction (ingress path is selected if the flag is present, 3438*858ea5e5SAndroid Build Coastguard Worker * egress path otherwise). This is the only flag supported for now. 3439*858ea5e5SAndroid Build Coastguard Worker * Return 3440*858ea5e5SAndroid Build Coastguard Worker * **SK_PASS** on success, or **SK_DROP** on error. 3441*858ea5e5SAndroid Build Coastguard Worker * 3442*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags) 3443*858ea5e5SAndroid Build Coastguard Worker * Description 3444*858ea5e5SAndroid Build Coastguard Worker * This helper is used in programs implementing policies at the 3445*858ea5e5SAndroid Build Coastguard Worker * skb socket level. If the sk_buff *skb* is allowed to pass (i.e. 3446*858ea5e5SAndroid Build Coastguard Worker * if the verdict eBPF program returns **SK_PASS**), redirect it 3447*858ea5e5SAndroid Build Coastguard Worker * to the socket referenced by *map* (of type 3448*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and 3449*858ea5e5SAndroid Build Coastguard Worker * egress interfaces can be used for redirection. The 3450*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_INGRESS** value in *flags* is used to make the 3451*858ea5e5SAndroid Build Coastguard Worker * distinction (ingress path is selected if the flag is present, 3452*858ea5e5SAndroid Build Coastguard Worker * egress otherwise). This is the only flag supported for now. 3453*858ea5e5SAndroid Build Coastguard Worker * Return 3454*858ea5e5SAndroid Build Coastguard Worker * **SK_PASS** on success, or **SK_DROP** on error. 3455*858ea5e5SAndroid Build Coastguard Worker * 3456*858ea5e5SAndroid Build Coastguard Worker * long bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len) 3457*858ea5e5SAndroid Build Coastguard Worker * Description 3458*858ea5e5SAndroid Build Coastguard Worker * Encapsulate the packet associated to *skb* within a Layer 3 3459*858ea5e5SAndroid Build Coastguard Worker * protocol header. This header is provided in the buffer at 3460*858ea5e5SAndroid Build Coastguard Worker * address *hdr*, with *len* its size in bytes. *type* indicates 3461*858ea5e5SAndroid Build Coastguard Worker * the protocol of the header and can be one of: 3462*858ea5e5SAndroid Build Coastguard Worker * 3463*858ea5e5SAndroid Build Coastguard Worker * **BPF_LWT_ENCAP_SEG6** 3464*858ea5e5SAndroid Build Coastguard Worker * IPv6 encapsulation with Segment Routing Header 3465*858ea5e5SAndroid Build Coastguard Worker * (**struct ipv6_sr_hdr**). *hdr* only contains the SRH, 3466*858ea5e5SAndroid Build Coastguard Worker * the IPv6 header is computed by the kernel. 3467*858ea5e5SAndroid Build Coastguard Worker * **BPF_LWT_ENCAP_SEG6_INLINE** 3468*858ea5e5SAndroid Build Coastguard Worker * Only works if *skb* contains an IPv6 packet. Insert a 3469*858ea5e5SAndroid Build Coastguard Worker * Segment Routing Header (**struct ipv6_sr_hdr**) inside 3470*858ea5e5SAndroid Build Coastguard Worker * the IPv6 header. 3471*858ea5e5SAndroid Build Coastguard Worker * **BPF_LWT_ENCAP_IP** 3472*858ea5e5SAndroid Build Coastguard Worker * IP encapsulation (GRE/GUE/IPIP/etc). The outer header 3473*858ea5e5SAndroid Build Coastguard Worker * must be IPv4 or IPv6, followed by zero or more 3474*858ea5e5SAndroid Build Coastguard Worker * additional headers, up to **LWT_BPF_MAX_HEADROOM** 3475*858ea5e5SAndroid Build Coastguard Worker * total bytes in all prepended headers. Please note that 3476*858ea5e5SAndroid Build Coastguard Worker * if **skb_is_gso**\ (*skb*) is true, no more than two 3477*858ea5e5SAndroid Build Coastguard Worker * headers can be prepended, and the inner header, if 3478*858ea5e5SAndroid Build Coastguard Worker * present, should be either GRE or UDP/GUE. 3479*858ea5e5SAndroid Build Coastguard Worker * 3480*858ea5e5SAndroid Build Coastguard Worker * **BPF_LWT_ENCAP_SEG6**\ \* types can be called by BPF programs 3481*858ea5e5SAndroid Build Coastguard Worker * of type **BPF_PROG_TYPE_LWT_IN**; **BPF_LWT_ENCAP_IP** type can 3482*858ea5e5SAndroid Build Coastguard Worker * be called by bpf programs of types **BPF_PROG_TYPE_LWT_IN** and 3483*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_LWT_XMIT**. 3484*858ea5e5SAndroid Build Coastguard Worker * 3485*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 3486*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 3487*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 3488*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 3489*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 3490*858ea5e5SAndroid Build Coastguard Worker * Return 3491*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3492*858ea5e5SAndroid Build Coastguard Worker * 3493*858ea5e5SAndroid Build Coastguard Worker * long bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len) 3494*858ea5e5SAndroid Build Coastguard Worker * Description 3495*858ea5e5SAndroid Build Coastguard Worker * Store *len* bytes from address *from* into the packet 3496*858ea5e5SAndroid Build Coastguard Worker * associated to *skb*, at *offset*. Only the flags, tag and TLVs 3497*858ea5e5SAndroid Build Coastguard Worker * inside the outermost IPv6 Segment Routing Header can be 3498*858ea5e5SAndroid Build Coastguard Worker * modified through this helper. 3499*858ea5e5SAndroid Build Coastguard Worker * 3500*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 3501*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 3502*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 3503*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 3504*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 3505*858ea5e5SAndroid Build Coastguard Worker * Return 3506*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3507*858ea5e5SAndroid Build Coastguard Worker * 3508*858ea5e5SAndroid Build Coastguard Worker * long bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta) 3509*858ea5e5SAndroid Build Coastguard Worker * Description 3510*858ea5e5SAndroid Build Coastguard Worker * Adjust the size allocated to TLVs in the outermost IPv6 3511*858ea5e5SAndroid Build Coastguard Worker * Segment Routing Header contained in the packet associated to 3512*858ea5e5SAndroid Build Coastguard Worker * *skb*, at position *offset* by *delta* bytes. Only offsets 3513*858ea5e5SAndroid Build Coastguard Worker * after the segments are accepted. *delta* can be as well 3514*858ea5e5SAndroid Build Coastguard Worker * positive (growing) as negative (shrinking). 3515*858ea5e5SAndroid Build Coastguard Worker * 3516*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 3517*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 3518*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 3519*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 3520*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 3521*858ea5e5SAndroid Build Coastguard Worker * Return 3522*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3523*858ea5e5SAndroid Build Coastguard Worker * 3524*858ea5e5SAndroid Build Coastguard Worker * long bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len) 3525*858ea5e5SAndroid Build Coastguard Worker * Description 3526*858ea5e5SAndroid Build Coastguard Worker * Apply an IPv6 Segment Routing action of type *action* to the 3527*858ea5e5SAndroid Build Coastguard Worker * packet associated to *skb*. Each action takes a parameter 3528*858ea5e5SAndroid Build Coastguard Worker * contained at address *param*, and of length *param_len* bytes. 3529*858ea5e5SAndroid Build Coastguard Worker * *action* can be one of: 3530*858ea5e5SAndroid Build Coastguard Worker * 3531*858ea5e5SAndroid Build Coastguard Worker * **SEG6_LOCAL_ACTION_END_X** 3532*858ea5e5SAndroid Build Coastguard Worker * End.X action: Endpoint with Layer-3 cross-connect. 3533*858ea5e5SAndroid Build Coastguard Worker * Type of *param*: **struct in6_addr**. 3534*858ea5e5SAndroid Build Coastguard Worker * **SEG6_LOCAL_ACTION_END_T** 3535*858ea5e5SAndroid Build Coastguard Worker * End.T action: Endpoint with specific IPv6 table lookup. 3536*858ea5e5SAndroid Build Coastguard Worker * Type of *param*: **int**. 3537*858ea5e5SAndroid Build Coastguard Worker * **SEG6_LOCAL_ACTION_END_B6** 3538*858ea5e5SAndroid Build Coastguard Worker * End.B6 action: Endpoint bound to an SRv6 policy. 3539*858ea5e5SAndroid Build Coastguard Worker * Type of *param*: **struct ipv6_sr_hdr**. 3540*858ea5e5SAndroid Build Coastguard Worker * **SEG6_LOCAL_ACTION_END_B6_ENCAP** 3541*858ea5e5SAndroid Build Coastguard Worker * End.B6.Encap action: Endpoint bound to an SRv6 3542*858ea5e5SAndroid Build Coastguard Worker * encapsulation policy. 3543*858ea5e5SAndroid Build Coastguard Worker * Type of *param*: **struct ipv6_sr_hdr**. 3544*858ea5e5SAndroid Build Coastguard Worker * 3545*858ea5e5SAndroid Build Coastguard Worker * A call to this helper is susceptible to change the underlying 3546*858ea5e5SAndroid Build Coastguard Worker * packet buffer. Therefore, at load time, all checks on pointers 3547*858ea5e5SAndroid Build Coastguard Worker * previously done by the verifier are invalidated and must be 3548*858ea5e5SAndroid Build Coastguard Worker * performed again, if the helper is used in combination with 3549*858ea5e5SAndroid Build Coastguard Worker * direct packet access. 3550*858ea5e5SAndroid Build Coastguard Worker * Return 3551*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3552*858ea5e5SAndroid Build Coastguard Worker * 3553*858ea5e5SAndroid Build Coastguard Worker * long bpf_rc_repeat(void *ctx) 3554*858ea5e5SAndroid Build Coastguard Worker * Description 3555*858ea5e5SAndroid Build Coastguard Worker * This helper is used in programs implementing IR decoding, to 3556*858ea5e5SAndroid Build Coastguard Worker * report a successfully decoded repeat key message. This delays 3557*858ea5e5SAndroid Build Coastguard Worker * the generation of a key up event for previously generated 3558*858ea5e5SAndroid Build Coastguard Worker * key down event. 3559*858ea5e5SAndroid Build Coastguard Worker * 3560*858ea5e5SAndroid Build Coastguard Worker * Some IR protocols like NEC have a special IR message for 3561*858ea5e5SAndroid Build Coastguard Worker * repeating last button, for when a button is held down. 3562*858ea5e5SAndroid Build Coastguard Worker * 3563*858ea5e5SAndroid Build Coastguard Worker * The *ctx* should point to the lirc sample as passed into 3564*858ea5e5SAndroid Build Coastguard Worker * the program. 3565*858ea5e5SAndroid Build Coastguard Worker * 3566*858ea5e5SAndroid Build Coastguard Worker * This helper is only available is the kernel was compiled with 3567*858ea5e5SAndroid Build Coastguard Worker * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 3568*858ea5e5SAndroid Build Coastguard Worker * "**y**". 3569*858ea5e5SAndroid Build Coastguard Worker * Return 3570*858ea5e5SAndroid Build Coastguard Worker * 0 3571*858ea5e5SAndroid Build Coastguard Worker * 3572*858ea5e5SAndroid Build Coastguard Worker * long bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle) 3573*858ea5e5SAndroid Build Coastguard Worker * Description 3574*858ea5e5SAndroid Build Coastguard Worker * This helper is used in programs implementing IR decoding, to 3575*858ea5e5SAndroid Build Coastguard Worker * report a successfully decoded key press with *scancode*, 3576*858ea5e5SAndroid Build Coastguard Worker * *toggle* value in the given *protocol*. The scancode will be 3577*858ea5e5SAndroid Build Coastguard Worker * translated to a keycode using the rc keymap, and reported as 3578*858ea5e5SAndroid Build Coastguard Worker * an input key down event. After a period a key up event is 3579*858ea5e5SAndroid Build Coastguard Worker * generated. This period can be extended by calling either 3580*858ea5e5SAndroid Build Coastguard Worker * **bpf_rc_keydown**\ () again with the same values, or calling 3581*858ea5e5SAndroid Build Coastguard Worker * **bpf_rc_repeat**\ (). 3582*858ea5e5SAndroid Build Coastguard Worker * 3583*858ea5e5SAndroid Build Coastguard Worker * Some protocols include a toggle bit, in case the button was 3584*858ea5e5SAndroid Build Coastguard Worker * released and pressed again between consecutive scancodes. 3585*858ea5e5SAndroid Build Coastguard Worker * 3586*858ea5e5SAndroid Build Coastguard Worker * The *ctx* should point to the lirc sample as passed into 3587*858ea5e5SAndroid Build Coastguard Worker * the program. 3588*858ea5e5SAndroid Build Coastguard Worker * 3589*858ea5e5SAndroid Build Coastguard Worker * The *protocol* is the decoded protocol number (see 3590*858ea5e5SAndroid Build Coastguard Worker * **enum rc_proto** for some predefined values). 3591*858ea5e5SAndroid Build Coastguard Worker * 3592*858ea5e5SAndroid Build Coastguard Worker * This helper is only available is the kernel was compiled with 3593*858ea5e5SAndroid Build Coastguard Worker * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 3594*858ea5e5SAndroid Build Coastguard Worker * "**y**". 3595*858ea5e5SAndroid Build Coastguard Worker * Return 3596*858ea5e5SAndroid Build Coastguard Worker * 0 3597*858ea5e5SAndroid Build Coastguard Worker * 3598*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_skb_cgroup_id(struct sk_buff *skb) 3599*858ea5e5SAndroid Build Coastguard Worker * Description 3600*858ea5e5SAndroid Build Coastguard Worker * Return the cgroup v2 id of the socket associated with the *skb*. 3601*858ea5e5SAndroid Build Coastguard Worker * This is roughly similar to the **bpf_get_cgroup_classid**\ () 3602*858ea5e5SAndroid Build Coastguard Worker * helper for cgroup v1 by providing a tag resp. identifier that 3603*858ea5e5SAndroid Build Coastguard Worker * can be matched on or used for map lookups e.g. to implement 3604*858ea5e5SAndroid Build Coastguard Worker * policy. The cgroup v2 id of a given path in the hierarchy is 3605*858ea5e5SAndroid Build Coastguard Worker * exposed in user space through the f_handle API in order to get 3606*858ea5e5SAndroid Build Coastguard Worker * to the same 64-bit id. 3607*858ea5e5SAndroid Build Coastguard Worker * 3608*858ea5e5SAndroid Build Coastguard Worker * This helper can be used on TC egress path, but not on ingress, 3609*858ea5e5SAndroid Build Coastguard Worker * and is available only if the kernel was compiled with the 3610*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_SOCK_CGROUP_DATA** configuration option. 3611*858ea5e5SAndroid Build Coastguard Worker * Return 3612*858ea5e5SAndroid Build Coastguard Worker * The id is returned or 0 in case the id could not be retrieved. 3613*858ea5e5SAndroid Build Coastguard Worker * 3614*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_current_cgroup_id(void) 3615*858ea5e5SAndroid Build Coastguard Worker * Description 3616*858ea5e5SAndroid Build Coastguard Worker * Get the current cgroup id based on the cgroup within which 3617*858ea5e5SAndroid Build Coastguard Worker * the current task is running. 3618*858ea5e5SAndroid Build Coastguard Worker * Return 3619*858ea5e5SAndroid Build Coastguard Worker * A 64-bit integer containing the current cgroup id based 3620*858ea5e5SAndroid Build Coastguard Worker * on the cgroup within which the current task is running. 3621*858ea5e5SAndroid Build Coastguard Worker * 3622*858ea5e5SAndroid Build Coastguard Worker * void *bpf_get_local_storage(void *map, u64 flags) 3623*858ea5e5SAndroid Build Coastguard Worker * Description 3624*858ea5e5SAndroid Build Coastguard Worker * Get the pointer to the local storage area. 3625*858ea5e5SAndroid Build Coastguard Worker * The type and the size of the local storage is defined 3626*858ea5e5SAndroid Build Coastguard Worker * by the *map* argument. 3627*858ea5e5SAndroid Build Coastguard Worker * The *flags* meaning is specific for each map type, 3628*858ea5e5SAndroid Build Coastguard Worker * and has to be 0 for cgroup local storage. 3629*858ea5e5SAndroid Build Coastguard Worker * 3630*858ea5e5SAndroid Build Coastguard Worker * Depending on the BPF program type, a local storage area 3631*858ea5e5SAndroid Build Coastguard Worker * can be shared between multiple instances of the BPF program, 3632*858ea5e5SAndroid Build Coastguard Worker * running simultaneously. 3633*858ea5e5SAndroid Build Coastguard Worker * 3634*858ea5e5SAndroid Build Coastguard Worker * A user should care about the synchronization by himself. 3635*858ea5e5SAndroid Build Coastguard Worker * For example, by using the **BPF_ATOMIC** instructions to alter 3636*858ea5e5SAndroid Build Coastguard Worker * the shared data. 3637*858ea5e5SAndroid Build Coastguard Worker * Return 3638*858ea5e5SAndroid Build Coastguard Worker * A pointer to the local storage area. 3639*858ea5e5SAndroid Build Coastguard Worker * 3640*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags) 3641*858ea5e5SAndroid Build Coastguard Worker * Description 3642*858ea5e5SAndroid Build Coastguard Worker * Select a **SO_REUSEPORT** socket from a 3643*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_REUSEPORT_SOCKARRAY** *map*. 3644*858ea5e5SAndroid Build Coastguard Worker * It checks the selected socket is matching the incoming 3645*858ea5e5SAndroid Build Coastguard Worker * request in the socket buffer. 3646*858ea5e5SAndroid Build Coastguard Worker * Return 3647*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3648*858ea5e5SAndroid Build Coastguard Worker * 3649*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level) 3650*858ea5e5SAndroid Build Coastguard Worker * Description 3651*858ea5e5SAndroid Build Coastguard Worker * Return id of cgroup v2 that is ancestor of cgroup associated 3652*858ea5e5SAndroid Build Coastguard Worker * with the *skb* at the *ancestor_level*. The root cgroup is at 3653*858ea5e5SAndroid Build Coastguard Worker * *ancestor_level* zero and each step down the hierarchy 3654*858ea5e5SAndroid Build Coastguard Worker * increments the level. If *ancestor_level* == level of cgroup 3655*858ea5e5SAndroid Build Coastguard Worker * associated with *skb*, then return value will be same as that 3656*858ea5e5SAndroid Build Coastguard Worker * of **bpf_skb_cgroup_id**\ (). 3657*858ea5e5SAndroid Build Coastguard Worker * 3658*858ea5e5SAndroid Build Coastguard Worker * The helper is useful to implement policies based on cgroups 3659*858ea5e5SAndroid Build Coastguard Worker * that are upper in hierarchy than immediate cgroup associated 3660*858ea5e5SAndroid Build Coastguard Worker * with *skb*. 3661*858ea5e5SAndroid Build Coastguard Worker * 3662*858ea5e5SAndroid Build Coastguard Worker * The format of returned id and helper limitations are same as in 3663*858ea5e5SAndroid Build Coastguard Worker * **bpf_skb_cgroup_id**\ (). 3664*858ea5e5SAndroid Build Coastguard Worker * Return 3665*858ea5e5SAndroid Build Coastguard Worker * The id is returned or 0 in case the id could not be retrieved. 3666*858ea5e5SAndroid Build Coastguard Worker * 3667*858ea5e5SAndroid Build Coastguard Worker * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 3668*858ea5e5SAndroid Build Coastguard Worker * Description 3669*858ea5e5SAndroid Build Coastguard Worker * Look for TCP socket matching *tuple*, optionally in a child 3670*858ea5e5SAndroid Build Coastguard Worker * network namespace *netns*. The return value must be checked, 3671*858ea5e5SAndroid Build Coastguard Worker * and if non-**NULL**, released via **bpf_sk_release**\ (). 3672*858ea5e5SAndroid Build Coastguard Worker * 3673*858ea5e5SAndroid Build Coastguard Worker * The *ctx* should point to the context of the program, such as 3674*858ea5e5SAndroid Build Coastguard Worker * the skb or socket (depending on the hook in use). This is used 3675*858ea5e5SAndroid Build Coastguard Worker * to determine the base network namespace for the lookup. 3676*858ea5e5SAndroid Build Coastguard Worker * 3677*858ea5e5SAndroid Build Coastguard Worker * *tuple_size* must be one of: 3678*858ea5e5SAndroid Build Coastguard Worker * 3679*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (*tuple*\ **->ipv4**) 3680*858ea5e5SAndroid Build Coastguard Worker * Look for an IPv4 socket. 3681*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (*tuple*\ **->ipv6**) 3682*858ea5e5SAndroid Build Coastguard Worker * Look for an IPv6 socket. 3683*858ea5e5SAndroid Build Coastguard Worker * 3684*858ea5e5SAndroid Build Coastguard Worker * If the *netns* is a negative signed 32-bit integer, then the 3685*858ea5e5SAndroid Build Coastguard Worker * socket lookup table in the netns associated with the *ctx* 3686*858ea5e5SAndroid Build Coastguard Worker * will be used. For the TC hooks, this is the netns of the device 3687*858ea5e5SAndroid Build Coastguard Worker * in the skb. For socket hooks, this is the netns of the socket. 3688*858ea5e5SAndroid Build Coastguard Worker * If *netns* is any other signed 32-bit value greater than or 3689*858ea5e5SAndroid Build Coastguard Worker * equal to zero then it specifies the ID of the netns relative to 3690*858ea5e5SAndroid Build Coastguard Worker * the netns associated with the *ctx*. *netns* values beyond the 3691*858ea5e5SAndroid Build Coastguard Worker * range of 32-bit integers are reserved for future use. 3692*858ea5e5SAndroid Build Coastguard Worker * 3693*858ea5e5SAndroid Build Coastguard Worker * All values for *flags* are reserved for future usage, and must 3694*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 3695*858ea5e5SAndroid Build Coastguard Worker * 3696*858ea5e5SAndroid Build Coastguard Worker * This helper is available only if the kernel was compiled with 3697*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_NET** configuration option. 3698*858ea5e5SAndroid Build Coastguard Worker * Return 3699*858ea5e5SAndroid Build Coastguard Worker * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 3700*858ea5e5SAndroid Build Coastguard Worker * For sockets with reuseport option, the **struct bpf_sock** 3701*858ea5e5SAndroid Build Coastguard Worker * result is from *reuse*\ **->socks**\ [] using the hash of the 3702*858ea5e5SAndroid Build Coastguard Worker * tuple. 3703*858ea5e5SAndroid Build Coastguard Worker * 3704*858ea5e5SAndroid Build Coastguard Worker * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 3705*858ea5e5SAndroid Build Coastguard Worker * Description 3706*858ea5e5SAndroid Build Coastguard Worker * Look for UDP socket matching *tuple*, optionally in a child 3707*858ea5e5SAndroid Build Coastguard Worker * network namespace *netns*. The return value must be checked, 3708*858ea5e5SAndroid Build Coastguard Worker * and if non-**NULL**, released via **bpf_sk_release**\ (). 3709*858ea5e5SAndroid Build Coastguard Worker * 3710*858ea5e5SAndroid Build Coastguard Worker * The *ctx* should point to the context of the program, such as 3711*858ea5e5SAndroid Build Coastguard Worker * the skb or socket (depending on the hook in use). This is used 3712*858ea5e5SAndroid Build Coastguard Worker * to determine the base network namespace for the lookup. 3713*858ea5e5SAndroid Build Coastguard Worker * 3714*858ea5e5SAndroid Build Coastguard Worker * *tuple_size* must be one of: 3715*858ea5e5SAndroid Build Coastguard Worker * 3716*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (*tuple*\ **->ipv4**) 3717*858ea5e5SAndroid Build Coastguard Worker * Look for an IPv4 socket. 3718*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (*tuple*\ **->ipv6**) 3719*858ea5e5SAndroid Build Coastguard Worker * Look for an IPv6 socket. 3720*858ea5e5SAndroid Build Coastguard Worker * 3721*858ea5e5SAndroid Build Coastguard Worker * If the *netns* is a negative signed 32-bit integer, then the 3722*858ea5e5SAndroid Build Coastguard Worker * socket lookup table in the netns associated with the *ctx* 3723*858ea5e5SAndroid Build Coastguard Worker * will be used. For the TC hooks, this is the netns of the device 3724*858ea5e5SAndroid Build Coastguard Worker * in the skb. For socket hooks, this is the netns of the socket. 3725*858ea5e5SAndroid Build Coastguard Worker * If *netns* is any other signed 32-bit value greater than or 3726*858ea5e5SAndroid Build Coastguard Worker * equal to zero then it specifies the ID of the netns relative to 3727*858ea5e5SAndroid Build Coastguard Worker * the netns associated with the *ctx*. *netns* values beyond the 3728*858ea5e5SAndroid Build Coastguard Worker * range of 32-bit integers are reserved for future use. 3729*858ea5e5SAndroid Build Coastguard Worker * 3730*858ea5e5SAndroid Build Coastguard Worker * All values for *flags* are reserved for future usage, and must 3731*858ea5e5SAndroid Build Coastguard Worker * be left at zero. 3732*858ea5e5SAndroid Build Coastguard Worker * 3733*858ea5e5SAndroid Build Coastguard Worker * This helper is available only if the kernel was compiled with 3734*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_NET** configuration option. 3735*858ea5e5SAndroid Build Coastguard Worker * Return 3736*858ea5e5SAndroid Build Coastguard Worker * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 3737*858ea5e5SAndroid Build Coastguard Worker * For sockets with reuseport option, the **struct bpf_sock** 3738*858ea5e5SAndroid Build Coastguard Worker * result is from *reuse*\ **->socks**\ [] using the hash of the 3739*858ea5e5SAndroid Build Coastguard Worker * tuple. 3740*858ea5e5SAndroid Build Coastguard Worker * 3741*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_release(void *sock) 3742*858ea5e5SAndroid Build Coastguard Worker * Description 3743*858ea5e5SAndroid Build Coastguard Worker * Release the reference held by *sock*. *sock* must be a 3744*858ea5e5SAndroid Build Coastguard Worker * non-**NULL** pointer that was returned from 3745*858ea5e5SAndroid Build Coastguard Worker * **bpf_sk_lookup_xxx**\ (). 3746*858ea5e5SAndroid Build Coastguard Worker * Return 3747*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3748*858ea5e5SAndroid Build Coastguard Worker * 3749*858ea5e5SAndroid Build Coastguard Worker * long bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags) 3750*858ea5e5SAndroid Build Coastguard Worker * Description 3751*858ea5e5SAndroid Build Coastguard Worker * Push an element *value* in *map*. *flags* is one of: 3752*858ea5e5SAndroid Build Coastguard Worker * 3753*858ea5e5SAndroid Build Coastguard Worker * **BPF_EXIST** 3754*858ea5e5SAndroid Build Coastguard Worker * If the queue/stack is full, the oldest element is 3755*858ea5e5SAndroid Build Coastguard Worker * removed to make room for this. 3756*858ea5e5SAndroid Build Coastguard Worker * Return 3757*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3758*858ea5e5SAndroid Build Coastguard Worker * 3759*858ea5e5SAndroid Build Coastguard Worker * long bpf_map_pop_elem(struct bpf_map *map, void *value) 3760*858ea5e5SAndroid Build Coastguard Worker * Description 3761*858ea5e5SAndroid Build Coastguard Worker * Pop an element from *map*. 3762*858ea5e5SAndroid Build Coastguard Worker * Return 3763*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3764*858ea5e5SAndroid Build Coastguard Worker * 3765*858ea5e5SAndroid Build Coastguard Worker * long bpf_map_peek_elem(struct bpf_map *map, void *value) 3766*858ea5e5SAndroid Build Coastguard Worker * Description 3767*858ea5e5SAndroid Build Coastguard Worker * Get an element from *map* without removing it. 3768*858ea5e5SAndroid Build Coastguard Worker * Return 3769*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3770*858ea5e5SAndroid Build Coastguard Worker * 3771*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_push_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags) 3772*858ea5e5SAndroid Build Coastguard Worker * Description 3773*858ea5e5SAndroid Build Coastguard Worker * For socket policies, insert *len* bytes into *msg* at offset 3774*858ea5e5SAndroid Build Coastguard Worker * *start*. 3775*858ea5e5SAndroid Build Coastguard Worker * 3776*858ea5e5SAndroid Build Coastguard Worker * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a 3777*858ea5e5SAndroid Build Coastguard Worker * *msg* it may want to insert metadata or options into the *msg*. 3778*858ea5e5SAndroid Build Coastguard Worker * This can later be read and used by any of the lower layer BPF 3779*858ea5e5SAndroid Build Coastguard Worker * hooks. 3780*858ea5e5SAndroid Build Coastguard Worker * 3781*858ea5e5SAndroid Build Coastguard Worker * This helper may fail if under memory pressure (a malloc 3782*858ea5e5SAndroid Build Coastguard Worker * fails) in these cases BPF programs will get an appropriate 3783*858ea5e5SAndroid Build Coastguard Worker * error and BPF programs will need to handle them. 3784*858ea5e5SAndroid Build Coastguard Worker * Return 3785*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3786*858ea5e5SAndroid Build Coastguard Worker * 3787*858ea5e5SAndroid Build Coastguard Worker * long bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags) 3788*858ea5e5SAndroid Build Coastguard Worker * Description 3789*858ea5e5SAndroid Build Coastguard Worker * Will remove *len* bytes from a *msg* starting at byte *start*. 3790*858ea5e5SAndroid Build Coastguard Worker * This may result in **ENOMEM** errors under certain situations if 3791*858ea5e5SAndroid Build Coastguard Worker * an allocation and copy are required due to a full ring buffer. 3792*858ea5e5SAndroid Build Coastguard Worker * However, the helper will try to avoid doing the allocation 3793*858ea5e5SAndroid Build Coastguard Worker * if possible. Other errors can occur if input parameters are 3794*858ea5e5SAndroid Build Coastguard Worker * invalid either due to *start* byte not being valid part of *msg* 3795*858ea5e5SAndroid Build Coastguard Worker * payload and/or *pop* value being to large. 3796*858ea5e5SAndroid Build Coastguard Worker * Return 3797*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 3798*858ea5e5SAndroid Build Coastguard Worker * 3799*858ea5e5SAndroid Build Coastguard Worker * long bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y) 3800*858ea5e5SAndroid Build Coastguard Worker * Description 3801*858ea5e5SAndroid Build Coastguard Worker * This helper is used in programs implementing IR decoding, to 3802*858ea5e5SAndroid Build Coastguard Worker * report a successfully decoded pointer movement. 3803*858ea5e5SAndroid Build Coastguard Worker * 3804*858ea5e5SAndroid Build Coastguard Worker * The *ctx* should point to the lirc sample as passed into 3805*858ea5e5SAndroid Build Coastguard Worker * the program. 3806*858ea5e5SAndroid Build Coastguard Worker * 3807*858ea5e5SAndroid Build Coastguard Worker * This helper is only available is the kernel was compiled with 3808*858ea5e5SAndroid Build Coastguard Worker * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 3809*858ea5e5SAndroid Build Coastguard Worker * "**y**". 3810*858ea5e5SAndroid Build Coastguard Worker * Return 3811*858ea5e5SAndroid Build Coastguard Worker * 0 3812*858ea5e5SAndroid Build Coastguard Worker * 3813*858ea5e5SAndroid Build Coastguard Worker * long bpf_spin_lock(struct bpf_spin_lock *lock) 3814*858ea5e5SAndroid Build Coastguard Worker * Description 3815*858ea5e5SAndroid Build Coastguard Worker * Acquire a spinlock represented by the pointer *lock*, which is 3816*858ea5e5SAndroid Build Coastguard Worker * stored as part of a value of a map. Taking the lock allows to 3817*858ea5e5SAndroid Build Coastguard Worker * safely update the rest of the fields in that value. The 3818*858ea5e5SAndroid Build Coastguard Worker * spinlock can (and must) later be released with a call to 3819*858ea5e5SAndroid Build Coastguard Worker * **bpf_spin_unlock**\ (\ *lock*\ ). 3820*858ea5e5SAndroid Build Coastguard Worker * 3821*858ea5e5SAndroid Build Coastguard Worker * Spinlocks in BPF programs come with a number of restrictions 3822*858ea5e5SAndroid Build Coastguard Worker * and constraints: 3823*858ea5e5SAndroid Build Coastguard Worker * 3824*858ea5e5SAndroid Build Coastguard Worker * * **bpf_spin_lock** objects are only allowed inside maps of 3825*858ea5e5SAndroid Build Coastguard Worker * types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this 3826*858ea5e5SAndroid Build Coastguard Worker * list could be extended in the future). 3827*858ea5e5SAndroid Build Coastguard Worker * * BTF description of the map is mandatory. 3828*858ea5e5SAndroid Build Coastguard Worker * * The BPF program can take ONE lock at a time, since taking two 3829*858ea5e5SAndroid Build Coastguard Worker * or more could cause dead locks. 3830*858ea5e5SAndroid Build Coastguard Worker * * Only one **struct bpf_spin_lock** is allowed per map element. 3831*858ea5e5SAndroid Build Coastguard Worker * * When the lock is taken, calls (either BPF to BPF or helpers) 3832*858ea5e5SAndroid Build Coastguard Worker * are not allowed. 3833*858ea5e5SAndroid Build Coastguard Worker * * The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not 3834*858ea5e5SAndroid Build Coastguard Worker * allowed inside a spinlock-ed region. 3835*858ea5e5SAndroid Build Coastguard Worker * * The BPF program MUST call **bpf_spin_unlock**\ () to release 3836*858ea5e5SAndroid Build Coastguard Worker * the lock, on all execution paths, before it returns. 3837*858ea5e5SAndroid Build Coastguard Worker * * The BPF program can access **struct bpf_spin_lock** only via 3838*858ea5e5SAndroid Build Coastguard Worker * the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ () 3839*858ea5e5SAndroid Build Coastguard Worker * helpers. Loading or storing data into the **struct 3840*858ea5e5SAndroid Build Coastguard Worker * bpf_spin_lock** *lock*\ **;** field of a map is not allowed. 3841*858ea5e5SAndroid Build Coastguard Worker * * To use the **bpf_spin_lock**\ () helper, the BTF description 3842*858ea5e5SAndroid Build Coastguard Worker * of the map value must be a struct and have **struct 3843*858ea5e5SAndroid Build Coastguard Worker * bpf_spin_lock** *anyname*\ **;** field at the top level. 3844*858ea5e5SAndroid Build Coastguard Worker * Nested lock inside another struct is not allowed. 3845*858ea5e5SAndroid Build Coastguard Worker * * The **struct bpf_spin_lock** *lock* field in a map value must 3846*858ea5e5SAndroid Build Coastguard Worker * be aligned on a multiple of 4 bytes in that value. 3847*858ea5e5SAndroid Build Coastguard Worker * * Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy 3848*858ea5e5SAndroid Build Coastguard Worker * the **bpf_spin_lock** field to user space. 3849*858ea5e5SAndroid Build Coastguard Worker * * Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from 3850*858ea5e5SAndroid Build Coastguard Worker * a BPF program, do not update the **bpf_spin_lock** field. 3851*858ea5e5SAndroid Build Coastguard Worker * * **bpf_spin_lock** cannot be on the stack or inside a 3852*858ea5e5SAndroid Build Coastguard Worker * networking packet (it can only be inside of a map values). 3853*858ea5e5SAndroid Build Coastguard Worker * * **bpf_spin_lock** is available to root only. 3854*858ea5e5SAndroid Build Coastguard Worker * * Tracing programs and socket filter programs cannot use 3855*858ea5e5SAndroid Build Coastguard Worker * **bpf_spin_lock**\ () due to insufficient preemption checks 3856*858ea5e5SAndroid Build Coastguard Worker * (but this may change in the future). 3857*858ea5e5SAndroid Build Coastguard Worker * * **bpf_spin_lock** is not allowed in inner maps of map-in-map. 3858*858ea5e5SAndroid Build Coastguard Worker * Return 3859*858ea5e5SAndroid Build Coastguard Worker * 0 3860*858ea5e5SAndroid Build Coastguard Worker * 3861*858ea5e5SAndroid Build Coastguard Worker * long bpf_spin_unlock(struct bpf_spin_lock *lock) 3862*858ea5e5SAndroid Build Coastguard Worker * Description 3863*858ea5e5SAndroid Build Coastguard Worker * Release the *lock* previously locked by a call to 3864*858ea5e5SAndroid Build Coastguard Worker * **bpf_spin_lock**\ (\ *lock*\ ). 3865*858ea5e5SAndroid Build Coastguard Worker * Return 3866*858ea5e5SAndroid Build Coastguard Worker * 0 3867*858ea5e5SAndroid Build Coastguard Worker * 3868*858ea5e5SAndroid Build Coastguard Worker * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk) 3869*858ea5e5SAndroid Build Coastguard Worker * Description 3870*858ea5e5SAndroid Build Coastguard Worker * This helper gets a **struct bpf_sock** pointer such 3871*858ea5e5SAndroid Build Coastguard Worker * that all the fields in this **bpf_sock** can be accessed. 3872*858ea5e5SAndroid Build Coastguard Worker * Return 3873*858ea5e5SAndroid Build Coastguard Worker * A **struct bpf_sock** pointer on success, or **NULL** in 3874*858ea5e5SAndroid Build Coastguard Worker * case of failure. 3875*858ea5e5SAndroid Build Coastguard Worker * 3876*858ea5e5SAndroid Build Coastguard Worker * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk) 3877*858ea5e5SAndroid Build Coastguard Worker * Description 3878*858ea5e5SAndroid Build Coastguard Worker * This helper gets a **struct bpf_tcp_sock** pointer from a 3879*858ea5e5SAndroid Build Coastguard Worker * **struct bpf_sock** pointer. 3880*858ea5e5SAndroid Build Coastguard Worker * Return 3881*858ea5e5SAndroid Build Coastguard Worker * A **struct bpf_tcp_sock** pointer on success, or **NULL** in 3882*858ea5e5SAndroid Build Coastguard Worker * case of failure. 3883*858ea5e5SAndroid Build Coastguard Worker * 3884*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_ecn_set_ce(struct sk_buff *skb) 3885*858ea5e5SAndroid Build Coastguard Worker * Description 3886*858ea5e5SAndroid Build Coastguard Worker * Set ECN (Explicit Congestion Notification) field of IP header 3887*858ea5e5SAndroid Build Coastguard Worker * to **CE** (Congestion Encountered) if current value is **ECT** 3888*858ea5e5SAndroid Build Coastguard Worker * (ECN Capable Transport). Otherwise, do nothing. Works with IPv6 3889*858ea5e5SAndroid Build Coastguard Worker * and IPv4. 3890*858ea5e5SAndroid Build Coastguard Worker * Return 3891*858ea5e5SAndroid Build Coastguard Worker * 1 if the **CE** flag is set (either by the current helper call 3892*858ea5e5SAndroid Build Coastguard Worker * or because it was already present), 0 if it is not set. 3893*858ea5e5SAndroid Build Coastguard Worker * 3894*858ea5e5SAndroid Build Coastguard Worker * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk) 3895*858ea5e5SAndroid Build Coastguard Worker * Description 3896*858ea5e5SAndroid Build Coastguard Worker * Return a **struct bpf_sock** pointer in **TCP_LISTEN** state. 3897*858ea5e5SAndroid Build Coastguard Worker * **bpf_sk_release**\ () is unnecessary and not allowed. 3898*858ea5e5SAndroid Build Coastguard Worker * Return 3899*858ea5e5SAndroid Build Coastguard Worker * A **struct bpf_sock** pointer on success, or **NULL** in 3900*858ea5e5SAndroid Build Coastguard Worker * case of failure. 3901*858ea5e5SAndroid Build Coastguard Worker * 3902*858ea5e5SAndroid Build Coastguard Worker * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 3903*858ea5e5SAndroid Build Coastguard Worker * Description 3904*858ea5e5SAndroid Build Coastguard Worker * Look for TCP socket matching *tuple*, optionally in a child 3905*858ea5e5SAndroid Build Coastguard Worker * network namespace *netns*. The return value must be checked, 3906*858ea5e5SAndroid Build Coastguard Worker * and if non-**NULL**, released via **bpf_sk_release**\ (). 3907*858ea5e5SAndroid Build Coastguard Worker * 3908*858ea5e5SAndroid Build Coastguard Worker * This function is identical to **bpf_sk_lookup_tcp**\ (), except 3909*858ea5e5SAndroid Build Coastguard Worker * that it also returns timewait or request sockets. Use 3910*858ea5e5SAndroid Build Coastguard Worker * **bpf_sk_fullsock**\ () or **bpf_tcp_sock**\ () to access the 3911*858ea5e5SAndroid Build Coastguard Worker * full structure. 3912*858ea5e5SAndroid Build Coastguard Worker * 3913*858ea5e5SAndroid Build Coastguard Worker * This helper is available only if the kernel was compiled with 3914*858ea5e5SAndroid Build Coastguard Worker * **CONFIG_NET** configuration option. 3915*858ea5e5SAndroid Build Coastguard Worker * Return 3916*858ea5e5SAndroid Build Coastguard Worker * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 3917*858ea5e5SAndroid Build Coastguard Worker * For sockets with reuseport option, the **struct bpf_sock** 3918*858ea5e5SAndroid Build Coastguard Worker * result is from *reuse*\ **->socks**\ [] using the hash of the 3919*858ea5e5SAndroid Build Coastguard Worker * tuple. 3920*858ea5e5SAndroid Build Coastguard Worker * 3921*858ea5e5SAndroid Build Coastguard Worker * long bpf_tcp_check_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len) 3922*858ea5e5SAndroid Build Coastguard Worker * Description 3923*858ea5e5SAndroid Build Coastguard Worker * Check whether *iph* and *th* contain a valid SYN cookie ACK for 3924*858ea5e5SAndroid Build Coastguard Worker * the listening socket in *sk*. 3925*858ea5e5SAndroid Build Coastguard Worker * 3926*858ea5e5SAndroid Build Coastguard Worker * *iph* points to the start of the IPv4 or IPv6 header, while 3927*858ea5e5SAndroid Build Coastguard Worker * *iph_len* contains **sizeof**\ (**struct iphdr**) or 3928*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (**struct ipv6hdr**). 3929*858ea5e5SAndroid Build Coastguard Worker * 3930*858ea5e5SAndroid Build Coastguard Worker * *th* points to the start of the TCP header, while *th_len* 3931*858ea5e5SAndroid Build Coastguard Worker * contains the length of the TCP header (at least 3932*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (**struct tcphdr**)). 3933*858ea5e5SAndroid Build Coastguard Worker * Return 3934*858ea5e5SAndroid Build Coastguard Worker * 0 if *iph* and *th* are a valid SYN cookie ACK, or a negative 3935*858ea5e5SAndroid Build Coastguard Worker * error otherwise. 3936*858ea5e5SAndroid Build Coastguard Worker * 3937*858ea5e5SAndroid Build Coastguard Worker * long bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags) 3938*858ea5e5SAndroid Build Coastguard Worker * Description 3939*858ea5e5SAndroid Build Coastguard Worker * Get name of sysctl in /proc/sys/ and copy it into provided by 3940*858ea5e5SAndroid Build Coastguard Worker * program buffer *buf* of size *buf_len*. 3941*858ea5e5SAndroid Build Coastguard Worker * 3942*858ea5e5SAndroid Build Coastguard Worker * The buffer is always NUL terminated, unless it's zero-sized. 3943*858ea5e5SAndroid Build Coastguard Worker * 3944*858ea5e5SAndroid Build Coastguard Worker * If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is 3945*858ea5e5SAndroid Build Coastguard Worker * copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name 3946*858ea5e5SAndroid Build Coastguard Worker * only (e.g. "tcp_mem"). 3947*858ea5e5SAndroid Build Coastguard Worker * Return 3948*858ea5e5SAndroid Build Coastguard Worker * Number of character copied (not including the trailing NUL). 3949*858ea5e5SAndroid Build Coastguard Worker * 3950*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 3951*858ea5e5SAndroid Build Coastguard Worker * truncated name in this case). 3952*858ea5e5SAndroid Build Coastguard Worker * 3953*858ea5e5SAndroid Build Coastguard Worker * long bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len) 3954*858ea5e5SAndroid Build Coastguard Worker * Description 3955*858ea5e5SAndroid Build Coastguard Worker * Get current value of sysctl as it is presented in /proc/sys 3956*858ea5e5SAndroid Build Coastguard Worker * (incl. newline, etc), and copy it as a string into provided 3957*858ea5e5SAndroid Build Coastguard Worker * by program buffer *buf* of size *buf_len*. 3958*858ea5e5SAndroid Build Coastguard Worker * 3959*858ea5e5SAndroid Build Coastguard Worker * The whole value is copied, no matter what file position user 3960*858ea5e5SAndroid Build Coastguard Worker * space issued e.g. sys_read at. 3961*858ea5e5SAndroid Build Coastguard Worker * 3962*858ea5e5SAndroid Build Coastguard Worker * The buffer is always NUL terminated, unless it's zero-sized. 3963*858ea5e5SAndroid Build Coastguard Worker * Return 3964*858ea5e5SAndroid Build Coastguard Worker * Number of character copied (not including the trailing NUL). 3965*858ea5e5SAndroid Build Coastguard Worker * 3966*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 3967*858ea5e5SAndroid Build Coastguard Worker * truncated name in this case). 3968*858ea5e5SAndroid Build Coastguard Worker * 3969*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if current value was unavailable, e.g. because 3970*858ea5e5SAndroid Build Coastguard Worker * sysctl is uninitialized and read returns -EIO for it. 3971*858ea5e5SAndroid Build Coastguard Worker * 3972*858ea5e5SAndroid Build Coastguard Worker * long bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len) 3973*858ea5e5SAndroid Build Coastguard Worker * Description 3974*858ea5e5SAndroid Build Coastguard Worker * Get new value being written by user space to sysctl (before 3975*858ea5e5SAndroid Build Coastguard Worker * the actual write happens) and copy it as a string into 3976*858ea5e5SAndroid Build Coastguard Worker * provided by program buffer *buf* of size *buf_len*. 3977*858ea5e5SAndroid Build Coastguard Worker * 3978*858ea5e5SAndroid Build Coastguard Worker * User space may write new value at file position > 0. 3979*858ea5e5SAndroid Build Coastguard Worker * 3980*858ea5e5SAndroid Build Coastguard Worker * The buffer is always NUL terminated, unless it's zero-sized. 3981*858ea5e5SAndroid Build Coastguard Worker * Return 3982*858ea5e5SAndroid Build Coastguard Worker * Number of character copied (not including the trailing NUL). 3983*858ea5e5SAndroid Build Coastguard Worker * 3984*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 3985*858ea5e5SAndroid Build Coastguard Worker * truncated name in this case). 3986*858ea5e5SAndroid Build Coastguard Worker * 3987*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if sysctl is being read. 3988*858ea5e5SAndroid Build Coastguard Worker * 3989*858ea5e5SAndroid Build Coastguard Worker * long bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len) 3990*858ea5e5SAndroid Build Coastguard Worker * Description 3991*858ea5e5SAndroid Build Coastguard Worker * Override new value being written by user space to sysctl with 3992*858ea5e5SAndroid Build Coastguard Worker * value provided by program in buffer *buf* of size *buf_len*. 3993*858ea5e5SAndroid Build Coastguard Worker * 3994*858ea5e5SAndroid Build Coastguard Worker * *buf* should contain a string in same form as provided by user 3995*858ea5e5SAndroid Build Coastguard Worker * space on sysctl write. 3996*858ea5e5SAndroid Build Coastguard Worker * 3997*858ea5e5SAndroid Build Coastguard Worker * User space may write new value at file position > 0. To override 3998*858ea5e5SAndroid Build Coastguard Worker * the whole sysctl value file position should be set to zero. 3999*858ea5e5SAndroid Build Coastguard Worker * Return 4000*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 4001*858ea5e5SAndroid Build Coastguard Worker * 4002*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if the *buf_len* is too big. 4003*858ea5e5SAndroid Build Coastguard Worker * 4004*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if sysctl is being read. 4005*858ea5e5SAndroid Build Coastguard Worker * 4006*858ea5e5SAndroid Build Coastguard Worker * long bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res) 4007*858ea5e5SAndroid Build Coastguard Worker * Description 4008*858ea5e5SAndroid Build Coastguard Worker * Convert the initial part of the string from buffer *buf* of 4009*858ea5e5SAndroid Build Coastguard Worker * size *buf_len* to a long integer according to the given base 4010*858ea5e5SAndroid Build Coastguard Worker * and save the result in *res*. 4011*858ea5e5SAndroid Build Coastguard Worker * 4012*858ea5e5SAndroid Build Coastguard Worker * The string may begin with an arbitrary amount of white space 4013*858ea5e5SAndroid Build Coastguard Worker * (as determined by **isspace**\ (3)) followed by a single 4014*858ea5e5SAndroid Build Coastguard Worker * optional '**-**' sign. 4015*858ea5e5SAndroid Build Coastguard Worker * 4016*858ea5e5SAndroid Build Coastguard Worker * Five least significant bits of *flags* encode base, other bits 4017*858ea5e5SAndroid Build Coastguard Worker * are currently unused. 4018*858ea5e5SAndroid Build Coastguard Worker * 4019*858ea5e5SAndroid Build Coastguard Worker * Base must be either 8, 10, 16 or 0 to detect it automatically 4020*858ea5e5SAndroid Build Coastguard Worker * similar to user space **strtol**\ (3). 4021*858ea5e5SAndroid Build Coastguard Worker * Return 4022*858ea5e5SAndroid Build Coastguard Worker * Number of characters consumed on success. Must be positive but 4023*858ea5e5SAndroid Build Coastguard Worker * no more than *buf_len*. 4024*858ea5e5SAndroid Build Coastguard Worker * 4025*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if no valid digits were found or unsupported base 4026*858ea5e5SAndroid Build Coastguard Worker * was provided. 4027*858ea5e5SAndroid Build Coastguard Worker * 4028*858ea5e5SAndroid Build Coastguard Worker * **-ERANGE** if resulting value was out of range. 4029*858ea5e5SAndroid Build Coastguard Worker * 4030*858ea5e5SAndroid Build Coastguard Worker * long bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res) 4031*858ea5e5SAndroid Build Coastguard Worker * Description 4032*858ea5e5SAndroid Build Coastguard Worker * Convert the initial part of the string from buffer *buf* of 4033*858ea5e5SAndroid Build Coastguard Worker * size *buf_len* to an unsigned long integer according to the 4034*858ea5e5SAndroid Build Coastguard Worker * given base and save the result in *res*. 4035*858ea5e5SAndroid Build Coastguard Worker * 4036*858ea5e5SAndroid Build Coastguard Worker * The string may begin with an arbitrary amount of white space 4037*858ea5e5SAndroid Build Coastguard Worker * (as determined by **isspace**\ (3)). 4038*858ea5e5SAndroid Build Coastguard Worker * 4039*858ea5e5SAndroid Build Coastguard Worker * Five least significant bits of *flags* encode base, other bits 4040*858ea5e5SAndroid Build Coastguard Worker * are currently unused. 4041*858ea5e5SAndroid Build Coastguard Worker * 4042*858ea5e5SAndroid Build Coastguard Worker * Base must be either 8, 10, 16 or 0 to detect it automatically 4043*858ea5e5SAndroid Build Coastguard Worker * similar to user space **strtoul**\ (3). 4044*858ea5e5SAndroid Build Coastguard Worker * Return 4045*858ea5e5SAndroid Build Coastguard Worker * Number of characters consumed on success. Must be positive but 4046*858ea5e5SAndroid Build Coastguard Worker * no more than *buf_len*. 4047*858ea5e5SAndroid Build Coastguard Worker * 4048*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if no valid digits were found or unsupported base 4049*858ea5e5SAndroid Build Coastguard Worker * was provided. 4050*858ea5e5SAndroid Build Coastguard Worker * 4051*858ea5e5SAndroid Build Coastguard Worker * **-ERANGE** if resulting value was out of range. 4052*858ea5e5SAndroid Build Coastguard Worker * 4053*858ea5e5SAndroid Build Coastguard Worker * void *bpf_sk_storage_get(struct bpf_map *map, void *sk, void *value, u64 flags) 4054*858ea5e5SAndroid Build Coastguard Worker * Description 4055*858ea5e5SAndroid Build Coastguard Worker * Get a bpf-local-storage from a *sk*. 4056*858ea5e5SAndroid Build Coastguard Worker * 4057*858ea5e5SAndroid Build Coastguard Worker * Logically, it could be thought of getting the value from 4058*858ea5e5SAndroid Build Coastguard Worker * a *map* with *sk* as the **key**. From this 4059*858ea5e5SAndroid Build Coastguard Worker * perspective, the usage is not much different from 4060*858ea5e5SAndroid Build Coastguard Worker * **bpf_map_lookup_elem**\ (*map*, **&**\ *sk*) except this 4061*858ea5e5SAndroid Build Coastguard Worker * helper enforces the key must be a full socket and the map must 4062*858ea5e5SAndroid Build Coastguard Worker * be a **BPF_MAP_TYPE_SK_STORAGE** also. 4063*858ea5e5SAndroid Build Coastguard Worker * 4064*858ea5e5SAndroid Build Coastguard Worker * Underneath, the value is stored locally at *sk* instead of 4065*858ea5e5SAndroid Build Coastguard Worker * the *map*. The *map* is used as the bpf-local-storage 4066*858ea5e5SAndroid Build Coastguard Worker * "type". The bpf-local-storage "type" (i.e. the *map*) is 4067*858ea5e5SAndroid Build Coastguard Worker * searched against all bpf-local-storages residing at *sk*. 4068*858ea5e5SAndroid Build Coastguard Worker * 4069*858ea5e5SAndroid Build Coastguard Worker * *sk* is a kernel **struct sock** pointer for LSM program. 4070*858ea5e5SAndroid Build Coastguard Worker * *sk* is a **struct bpf_sock** pointer for other program types. 4071*858ea5e5SAndroid Build Coastguard Worker * 4072*858ea5e5SAndroid Build Coastguard Worker * An optional *flags* (**BPF_SK_STORAGE_GET_F_CREATE**) can be 4073*858ea5e5SAndroid Build Coastguard Worker * used such that a new bpf-local-storage will be 4074*858ea5e5SAndroid Build Coastguard Worker * created if one does not exist. *value* can be used 4075*858ea5e5SAndroid Build Coastguard Worker * together with **BPF_SK_STORAGE_GET_F_CREATE** to specify 4076*858ea5e5SAndroid Build Coastguard Worker * the initial value of a bpf-local-storage. If *value* is 4077*858ea5e5SAndroid Build Coastguard Worker * **NULL**, the new bpf-local-storage will be zero initialized. 4078*858ea5e5SAndroid Build Coastguard Worker * Return 4079*858ea5e5SAndroid Build Coastguard Worker * A bpf-local-storage pointer is returned on success. 4080*858ea5e5SAndroid Build Coastguard Worker * 4081*858ea5e5SAndroid Build Coastguard Worker * **NULL** if not found or there was an error in adding 4082*858ea5e5SAndroid Build Coastguard Worker * a new bpf-local-storage. 4083*858ea5e5SAndroid Build Coastguard Worker * 4084*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_storage_delete(struct bpf_map *map, void *sk) 4085*858ea5e5SAndroid Build Coastguard Worker * Description 4086*858ea5e5SAndroid Build Coastguard Worker * Delete a bpf-local-storage from a *sk*. 4087*858ea5e5SAndroid Build Coastguard Worker * Return 4088*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 4089*858ea5e5SAndroid Build Coastguard Worker * 4090*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if the bpf-local-storage cannot be found. 4091*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if sk is not a fullsock (e.g. a request_sock). 4092*858ea5e5SAndroid Build Coastguard Worker * 4093*858ea5e5SAndroid Build Coastguard Worker * long bpf_send_signal(u32 sig) 4094*858ea5e5SAndroid Build Coastguard Worker * Description 4095*858ea5e5SAndroid Build Coastguard Worker * Send signal *sig* to the process of the current task. 4096*858ea5e5SAndroid Build Coastguard Worker * The signal may be delivered to any of this process's threads. 4097*858ea5e5SAndroid Build Coastguard Worker * Return 4098*858ea5e5SAndroid Build Coastguard Worker * 0 on success or successfully queued. 4099*858ea5e5SAndroid Build Coastguard Worker * 4100*858ea5e5SAndroid Build Coastguard Worker * **-EBUSY** if work queue under nmi is full. 4101*858ea5e5SAndroid Build Coastguard Worker * 4102*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *sig* is invalid. 4103*858ea5e5SAndroid Build Coastguard Worker * 4104*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if no permission to send the *sig*. 4105*858ea5e5SAndroid Build Coastguard Worker * 4106*858ea5e5SAndroid Build Coastguard Worker * **-EAGAIN** if bpf program can try again. 4107*858ea5e5SAndroid Build Coastguard Worker * 4108*858ea5e5SAndroid Build Coastguard Worker * s64 bpf_tcp_gen_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len) 4109*858ea5e5SAndroid Build Coastguard Worker * Description 4110*858ea5e5SAndroid Build Coastguard Worker * Try to issue a SYN cookie for the packet with corresponding 4111*858ea5e5SAndroid Build Coastguard Worker * IP/TCP headers, *iph* and *th*, on the listening socket in *sk*. 4112*858ea5e5SAndroid Build Coastguard Worker * 4113*858ea5e5SAndroid Build Coastguard Worker * *iph* points to the start of the IPv4 or IPv6 header, while 4114*858ea5e5SAndroid Build Coastguard Worker * *iph_len* contains **sizeof**\ (**struct iphdr**) or 4115*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (**struct ipv6hdr**). 4116*858ea5e5SAndroid Build Coastguard Worker * 4117*858ea5e5SAndroid Build Coastguard Worker * *th* points to the start of the TCP header, while *th_len* 4118*858ea5e5SAndroid Build Coastguard Worker * contains the length of the TCP header with options (at least 4119*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (**struct tcphdr**)). 4120*858ea5e5SAndroid Build Coastguard Worker * Return 4121*858ea5e5SAndroid Build Coastguard Worker * On success, lower 32 bits hold the generated SYN cookie in 4122*858ea5e5SAndroid Build Coastguard Worker * followed by 16 bits which hold the MSS value for that cookie, 4123*858ea5e5SAndroid Build Coastguard Worker * and the top 16 bits are unused. 4124*858ea5e5SAndroid Build Coastguard Worker * 4125*858ea5e5SAndroid Build Coastguard Worker * On failure, the returned value is one of the following: 4126*858ea5e5SAndroid Build Coastguard Worker * 4127*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** SYN cookie cannot be issued due to error 4128*858ea5e5SAndroid Build Coastguard Worker * 4129*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** SYN cookie should not be issued (no SYN flood) 4130*858ea5e5SAndroid Build Coastguard Worker * 4131*858ea5e5SAndroid Build Coastguard Worker * **-EOPNOTSUPP** kernel configuration does not enable SYN cookies 4132*858ea5e5SAndroid Build Coastguard Worker * 4133*858ea5e5SAndroid Build Coastguard Worker * **-EPROTONOSUPPORT** IP packet version is not 4 or 6 4134*858ea5e5SAndroid Build Coastguard Worker * 4135*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 4136*858ea5e5SAndroid Build Coastguard Worker * Description 4137*858ea5e5SAndroid Build Coastguard Worker * Write raw *data* blob into a special BPF perf event held by 4138*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 4139*858ea5e5SAndroid Build Coastguard Worker * event must have the following attributes: **PERF_SAMPLE_RAW** 4140*858ea5e5SAndroid Build Coastguard Worker * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 4141*858ea5e5SAndroid Build Coastguard Worker * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 4142*858ea5e5SAndroid Build Coastguard Worker * 4143*858ea5e5SAndroid Build Coastguard Worker * The *flags* are used to indicate the index in *map* for which 4144*858ea5e5SAndroid Build Coastguard Worker * the value must be put, masked with **BPF_F_INDEX_MASK**. 4145*858ea5e5SAndroid Build Coastguard Worker * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 4146*858ea5e5SAndroid Build Coastguard Worker * to indicate that the index of the current CPU core should be 4147*858ea5e5SAndroid Build Coastguard Worker * used. 4148*858ea5e5SAndroid Build Coastguard Worker * 4149*858ea5e5SAndroid Build Coastguard Worker * The value to write, of *size*, is passed through eBPF stack and 4150*858ea5e5SAndroid Build Coastguard Worker * pointed by *data*. 4151*858ea5e5SAndroid Build Coastguard Worker * 4152*858ea5e5SAndroid Build Coastguard Worker * *ctx* is a pointer to in-kernel struct sk_buff. 4153*858ea5e5SAndroid Build Coastguard Worker * 4154*858ea5e5SAndroid Build Coastguard Worker * This helper is similar to **bpf_perf_event_output**\ () but 4155*858ea5e5SAndroid Build Coastguard Worker * restricted to raw_tracepoint bpf programs. 4156*858ea5e5SAndroid Build Coastguard Worker * Return 4157*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4158*858ea5e5SAndroid Build Coastguard Worker * 4159*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_read_user(void *dst, u32 size, const void *unsafe_ptr) 4160*858ea5e5SAndroid Build Coastguard Worker * Description 4161*858ea5e5SAndroid Build Coastguard Worker * Safely attempt to read *size* bytes from user space address 4162*858ea5e5SAndroid Build Coastguard Worker * *unsafe_ptr* and store the data in *dst*. 4163*858ea5e5SAndroid Build Coastguard Worker * Return 4164*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4165*858ea5e5SAndroid Build Coastguard Worker * 4166*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr) 4167*858ea5e5SAndroid Build Coastguard Worker * Description 4168*858ea5e5SAndroid Build Coastguard Worker * Safely attempt to read *size* bytes from kernel space address 4169*858ea5e5SAndroid Build Coastguard Worker * *unsafe_ptr* and store the data in *dst*. 4170*858ea5e5SAndroid Build Coastguard Worker * Return 4171*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4172*858ea5e5SAndroid Build Coastguard Worker * 4173*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_read_user_str(void *dst, u32 size, const void *unsafe_ptr) 4174*858ea5e5SAndroid Build Coastguard Worker * Description 4175*858ea5e5SAndroid Build Coastguard Worker * Copy a NUL terminated string from an unsafe user address 4176*858ea5e5SAndroid Build Coastguard Worker * *unsafe_ptr* to *dst*. The *size* should include the 4177*858ea5e5SAndroid Build Coastguard Worker * terminating NUL byte. In case the string length is smaller than 4178*858ea5e5SAndroid Build Coastguard Worker * *size*, the target is not padded with further NUL bytes. If the 4179*858ea5e5SAndroid Build Coastguard Worker * string length is larger than *size*, just *size*-1 bytes are 4180*858ea5e5SAndroid Build Coastguard Worker * copied and the last byte is set to NUL. 4181*858ea5e5SAndroid Build Coastguard Worker * 4182*858ea5e5SAndroid Build Coastguard Worker * On success, returns the number of bytes that were written, 4183*858ea5e5SAndroid Build Coastguard Worker * including the terminal NUL. This makes this helper useful in 4184*858ea5e5SAndroid Build Coastguard Worker * tracing programs for reading strings, and more importantly to 4185*858ea5e5SAndroid Build Coastguard Worker * get its length at runtime. See the following snippet: 4186*858ea5e5SAndroid Build Coastguard Worker * 4187*858ea5e5SAndroid Build Coastguard Worker * :: 4188*858ea5e5SAndroid Build Coastguard Worker * 4189*858ea5e5SAndroid Build Coastguard Worker * SEC("kprobe/sys_open") 4190*858ea5e5SAndroid Build Coastguard Worker * void bpf_sys_open(struct pt_regs *ctx) 4191*858ea5e5SAndroid Build Coastguard Worker * { 4192*858ea5e5SAndroid Build Coastguard Worker * char buf[PATHLEN]; // PATHLEN is defined to 256 4193*858ea5e5SAndroid Build Coastguard Worker * int res = bpf_probe_read_user_str(buf, sizeof(buf), 4194*858ea5e5SAndroid Build Coastguard Worker * ctx->di); 4195*858ea5e5SAndroid Build Coastguard Worker * 4196*858ea5e5SAndroid Build Coastguard Worker * // Consume buf, for example push it to 4197*858ea5e5SAndroid Build Coastguard Worker * // userspace via bpf_perf_event_output(); we 4198*858ea5e5SAndroid Build Coastguard Worker * // can use res (the string length) as event 4199*858ea5e5SAndroid Build Coastguard Worker * // size, after checking its boundaries. 4200*858ea5e5SAndroid Build Coastguard Worker * } 4201*858ea5e5SAndroid Build Coastguard Worker * 4202*858ea5e5SAndroid Build Coastguard Worker * In comparison, using **bpf_probe_read_user**\ () helper here 4203*858ea5e5SAndroid Build Coastguard Worker * instead to read the string would require to estimate the length 4204*858ea5e5SAndroid Build Coastguard Worker * at compile time, and would often result in copying more memory 4205*858ea5e5SAndroid Build Coastguard Worker * than necessary. 4206*858ea5e5SAndroid Build Coastguard Worker * 4207*858ea5e5SAndroid Build Coastguard Worker * Another useful use case is when parsing individual process 4208*858ea5e5SAndroid Build Coastguard Worker * arguments or individual environment variables navigating 4209*858ea5e5SAndroid Build Coastguard Worker * *current*\ **->mm->arg_start** and *current*\ 4210*858ea5e5SAndroid Build Coastguard Worker * **->mm->env_start**: using this helper and the return value, 4211*858ea5e5SAndroid Build Coastguard Worker * one can quickly iterate at the right offset of the memory area. 4212*858ea5e5SAndroid Build Coastguard Worker * Return 4213*858ea5e5SAndroid Build Coastguard Worker * On success, the strictly positive length of the output string, 4214*858ea5e5SAndroid Build Coastguard Worker * including the trailing NUL character. On error, a negative 4215*858ea5e5SAndroid Build Coastguard Worker * value. 4216*858ea5e5SAndroid Build Coastguard Worker * 4217*858ea5e5SAndroid Build Coastguard Worker * long bpf_probe_read_kernel_str(void *dst, u32 size, const void *unsafe_ptr) 4218*858ea5e5SAndroid Build Coastguard Worker * Description 4219*858ea5e5SAndroid Build Coastguard Worker * Copy a NUL terminated string from an unsafe kernel address *unsafe_ptr* 4220*858ea5e5SAndroid Build Coastguard Worker * to *dst*. Same semantics as with **bpf_probe_read_user_str**\ () apply. 4221*858ea5e5SAndroid Build Coastguard Worker * Return 4222*858ea5e5SAndroid Build Coastguard Worker * On success, the strictly positive length of the string, including 4223*858ea5e5SAndroid Build Coastguard Worker * the trailing NUL character. On error, a negative value. 4224*858ea5e5SAndroid Build Coastguard Worker * 4225*858ea5e5SAndroid Build Coastguard Worker * long bpf_tcp_send_ack(void *tp, u32 rcv_nxt) 4226*858ea5e5SAndroid Build Coastguard Worker * Description 4227*858ea5e5SAndroid Build Coastguard Worker * Send out a tcp-ack. *tp* is the in-kernel struct **tcp_sock**. 4228*858ea5e5SAndroid Build Coastguard Worker * *rcv_nxt* is the ack_seq to be sent out. 4229*858ea5e5SAndroid Build Coastguard Worker * Return 4230*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4231*858ea5e5SAndroid Build Coastguard Worker * 4232*858ea5e5SAndroid Build Coastguard Worker * long bpf_send_signal_thread(u32 sig) 4233*858ea5e5SAndroid Build Coastguard Worker * Description 4234*858ea5e5SAndroid Build Coastguard Worker * Send signal *sig* to the thread corresponding to the current task. 4235*858ea5e5SAndroid Build Coastguard Worker * Return 4236*858ea5e5SAndroid Build Coastguard Worker * 0 on success or successfully queued. 4237*858ea5e5SAndroid Build Coastguard Worker * 4238*858ea5e5SAndroid Build Coastguard Worker * **-EBUSY** if work queue under nmi is full. 4239*858ea5e5SAndroid Build Coastguard Worker * 4240*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *sig* is invalid. 4241*858ea5e5SAndroid Build Coastguard Worker * 4242*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if no permission to send the *sig*. 4243*858ea5e5SAndroid Build Coastguard Worker * 4244*858ea5e5SAndroid Build Coastguard Worker * **-EAGAIN** if bpf program can try again. 4245*858ea5e5SAndroid Build Coastguard Worker * 4246*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_jiffies64(void) 4247*858ea5e5SAndroid Build Coastguard Worker * Description 4248*858ea5e5SAndroid Build Coastguard Worker * Obtain the 64bit jiffies 4249*858ea5e5SAndroid Build Coastguard Worker * Return 4250*858ea5e5SAndroid Build Coastguard Worker * The 64 bit jiffies 4251*858ea5e5SAndroid Build Coastguard Worker * 4252*858ea5e5SAndroid Build Coastguard Worker * long bpf_read_branch_records(struct bpf_perf_event_data *ctx, void *buf, u32 size, u64 flags) 4253*858ea5e5SAndroid Build Coastguard Worker * Description 4254*858ea5e5SAndroid Build Coastguard Worker * For an eBPF program attached to a perf event, retrieve the 4255*858ea5e5SAndroid Build Coastguard Worker * branch records (**struct perf_branch_entry**) associated to *ctx* 4256*858ea5e5SAndroid Build Coastguard Worker * and store it in the buffer pointed by *buf* up to size 4257*858ea5e5SAndroid Build Coastguard Worker * *size* bytes. 4258*858ea5e5SAndroid Build Coastguard Worker * Return 4259*858ea5e5SAndroid Build Coastguard Worker * On success, number of bytes written to *buf*. On error, a 4260*858ea5e5SAndroid Build Coastguard Worker * negative value. 4261*858ea5e5SAndroid Build Coastguard Worker * 4262*858ea5e5SAndroid Build Coastguard Worker * The *flags* can be set to **BPF_F_GET_BRANCH_RECORDS_SIZE** to 4263*858ea5e5SAndroid Build Coastguard Worker * instead return the number of bytes required to store all the 4264*858ea5e5SAndroid Build Coastguard Worker * branch entries. If this flag is set, *buf* may be NULL. 4265*858ea5e5SAndroid Build Coastguard Worker * 4266*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if arguments invalid or **size** not a multiple 4267*858ea5e5SAndroid Build Coastguard Worker * of **sizeof**\ (**struct perf_branch_entry**\ ). 4268*858ea5e5SAndroid Build Coastguard Worker * 4269*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if architecture does not support branch records. 4270*858ea5e5SAndroid Build Coastguard Worker * 4271*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_ns_current_pid_tgid(u64 dev, u64 ino, struct bpf_pidns_info *nsdata, u32 size) 4272*858ea5e5SAndroid Build Coastguard Worker * Description 4273*858ea5e5SAndroid Build Coastguard Worker * Returns 0 on success, values for *pid* and *tgid* as seen from the current 4274*858ea5e5SAndroid Build Coastguard Worker * *namespace* will be returned in *nsdata*. 4275*858ea5e5SAndroid Build Coastguard Worker * Return 4276*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or one of the following in case of failure: 4277*858ea5e5SAndroid Build Coastguard Worker * 4278*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if dev and inum supplied don't match dev_t and inode number 4279*858ea5e5SAndroid Build Coastguard Worker * with nsfs of current task, or if dev conversion to dev_t lost high bits. 4280*858ea5e5SAndroid Build Coastguard Worker * 4281*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if pidns does not exists for the current task. 4282*858ea5e5SAndroid Build Coastguard Worker * 4283*858ea5e5SAndroid Build Coastguard Worker * long bpf_xdp_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 4284*858ea5e5SAndroid Build Coastguard Worker * Description 4285*858ea5e5SAndroid Build Coastguard Worker * Write raw *data* blob into a special BPF perf event held by 4286*858ea5e5SAndroid Build Coastguard Worker * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 4287*858ea5e5SAndroid Build Coastguard Worker * event must have the following attributes: **PERF_SAMPLE_RAW** 4288*858ea5e5SAndroid Build Coastguard Worker * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 4289*858ea5e5SAndroid Build Coastguard Worker * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 4290*858ea5e5SAndroid Build Coastguard Worker * 4291*858ea5e5SAndroid Build Coastguard Worker * The *flags* are used to indicate the index in *map* for which 4292*858ea5e5SAndroid Build Coastguard Worker * the value must be put, masked with **BPF_F_INDEX_MASK**. 4293*858ea5e5SAndroid Build Coastguard Worker * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 4294*858ea5e5SAndroid Build Coastguard Worker * to indicate that the index of the current CPU core should be 4295*858ea5e5SAndroid Build Coastguard Worker * used. 4296*858ea5e5SAndroid Build Coastguard Worker * 4297*858ea5e5SAndroid Build Coastguard Worker * The value to write, of *size*, is passed through eBPF stack and 4298*858ea5e5SAndroid Build Coastguard Worker * pointed by *data*. 4299*858ea5e5SAndroid Build Coastguard Worker * 4300*858ea5e5SAndroid Build Coastguard Worker * *ctx* is a pointer to in-kernel struct xdp_buff. 4301*858ea5e5SAndroid Build Coastguard Worker * 4302*858ea5e5SAndroid Build Coastguard Worker * This helper is similar to **bpf_perf_eventoutput**\ () but 4303*858ea5e5SAndroid Build Coastguard Worker * restricted to raw_tracepoint bpf programs. 4304*858ea5e5SAndroid Build Coastguard Worker * Return 4305*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4306*858ea5e5SAndroid Build Coastguard Worker * 4307*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_netns_cookie(void *ctx) 4308*858ea5e5SAndroid Build Coastguard Worker * Description 4309*858ea5e5SAndroid Build Coastguard Worker * Retrieve the cookie (generated by the kernel) of the network 4310*858ea5e5SAndroid Build Coastguard Worker * namespace the input *ctx* is associated with. The network 4311*858ea5e5SAndroid Build Coastguard Worker * namespace cookie remains stable for its lifetime and provides 4312*858ea5e5SAndroid Build Coastguard Worker * a global identifier that can be assumed unique. If *ctx* is 4313*858ea5e5SAndroid Build Coastguard Worker * NULL, then the helper returns the cookie for the initial 4314*858ea5e5SAndroid Build Coastguard Worker * network namespace. The cookie itself is very similar to that 4315*858ea5e5SAndroid Build Coastguard Worker * of **bpf_get_socket_cookie**\ () helper, but for network 4316*858ea5e5SAndroid Build Coastguard Worker * namespaces instead of sockets. 4317*858ea5e5SAndroid Build Coastguard Worker * Return 4318*858ea5e5SAndroid Build Coastguard Worker * A 8-byte long opaque number. 4319*858ea5e5SAndroid Build Coastguard Worker * 4320*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_current_ancestor_cgroup_id(int ancestor_level) 4321*858ea5e5SAndroid Build Coastguard Worker * Description 4322*858ea5e5SAndroid Build Coastguard Worker * Return id of cgroup v2 that is ancestor of the cgroup associated 4323*858ea5e5SAndroid Build Coastguard Worker * with the current task at the *ancestor_level*. The root cgroup 4324*858ea5e5SAndroid Build Coastguard Worker * is at *ancestor_level* zero and each step down the hierarchy 4325*858ea5e5SAndroid Build Coastguard Worker * increments the level. If *ancestor_level* == level of cgroup 4326*858ea5e5SAndroid Build Coastguard Worker * associated with the current task, then return value will be the 4327*858ea5e5SAndroid Build Coastguard Worker * same as that of **bpf_get_current_cgroup_id**\ (). 4328*858ea5e5SAndroid Build Coastguard Worker * 4329*858ea5e5SAndroid Build Coastguard Worker * The helper is useful to implement policies based on cgroups 4330*858ea5e5SAndroid Build Coastguard Worker * that are upper in hierarchy than immediate cgroup associated 4331*858ea5e5SAndroid Build Coastguard Worker * with the current task. 4332*858ea5e5SAndroid Build Coastguard Worker * 4333*858ea5e5SAndroid Build Coastguard Worker * The format of returned id and helper limitations are same as in 4334*858ea5e5SAndroid Build Coastguard Worker * **bpf_get_current_cgroup_id**\ (). 4335*858ea5e5SAndroid Build Coastguard Worker * Return 4336*858ea5e5SAndroid Build Coastguard Worker * The id is returned or 0 in case the id could not be retrieved. 4337*858ea5e5SAndroid Build Coastguard Worker * 4338*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_assign(struct sk_buff *skb, void *sk, u64 flags) 4339*858ea5e5SAndroid Build Coastguard Worker * Description 4340*858ea5e5SAndroid Build Coastguard Worker * Helper is overloaded depending on BPF program type. This 4341*858ea5e5SAndroid Build Coastguard Worker * description applies to **BPF_PROG_TYPE_SCHED_CLS** and 4342*858ea5e5SAndroid Build Coastguard Worker * **BPF_PROG_TYPE_SCHED_ACT** programs. 4343*858ea5e5SAndroid Build Coastguard Worker * 4344*858ea5e5SAndroid Build Coastguard Worker * Assign the *sk* to the *skb*. When combined with appropriate 4345*858ea5e5SAndroid Build Coastguard Worker * routing configuration to receive the packet towards the socket, 4346*858ea5e5SAndroid Build Coastguard Worker * will cause *skb* to be delivered to the specified socket. 4347*858ea5e5SAndroid Build Coastguard Worker * Subsequent redirection of *skb* via **bpf_redirect**\ (), 4348*858ea5e5SAndroid Build Coastguard Worker * **bpf_clone_redirect**\ () or other methods outside of BPF may 4349*858ea5e5SAndroid Build Coastguard Worker * interfere with successful delivery to the socket. 4350*858ea5e5SAndroid Build Coastguard Worker * 4351*858ea5e5SAndroid Build Coastguard Worker * This operation is only valid from TC ingress path. 4352*858ea5e5SAndroid Build Coastguard Worker * 4353*858ea5e5SAndroid Build Coastguard Worker * The *flags* argument must be zero. 4354*858ea5e5SAndroid Build Coastguard Worker * Return 4355*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure: 4356*858ea5e5SAndroid Build Coastguard Worker * 4357*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if specified *flags* are not supported. 4358*858ea5e5SAndroid Build Coastguard Worker * 4359*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if the socket is unavailable for assignment. 4360*858ea5e5SAndroid Build Coastguard Worker * 4361*858ea5e5SAndroid Build Coastguard Worker * **-ENETUNREACH** if the socket is unreachable (wrong netns). 4362*858ea5e5SAndroid Build Coastguard Worker * 4363*858ea5e5SAndroid Build Coastguard Worker * **-EOPNOTSUPP** if the operation is not supported, for example 4364*858ea5e5SAndroid Build Coastguard Worker * a call from outside of TC ingress. 4365*858ea5e5SAndroid Build Coastguard Worker * 4366*858ea5e5SAndroid Build Coastguard Worker * long bpf_sk_assign(struct bpf_sk_lookup *ctx, struct bpf_sock *sk, u64 flags) 4367*858ea5e5SAndroid Build Coastguard Worker * Description 4368*858ea5e5SAndroid Build Coastguard Worker * Helper is overloaded depending on BPF program type. This 4369*858ea5e5SAndroid Build Coastguard Worker * description applies to **BPF_PROG_TYPE_SK_LOOKUP** programs. 4370*858ea5e5SAndroid Build Coastguard Worker * 4371*858ea5e5SAndroid Build Coastguard Worker * Select the *sk* as a result of a socket lookup. 4372*858ea5e5SAndroid Build Coastguard Worker * 4373*858ea5e5SAndroid Build Coastguard Worker * For the operation to succeed passed socket must be compatible 4374*858ea5e5SAndroid Build Coastguard Worker * with the packet description provided by the *ctx* object. 4375*858ea5e5SAndroid Build Coastguard Worker * 4376*858ea5e5SAndroid Build Coastguard Worker * L4 protocol (**IPPROTO_TCP** or **IPPROTO_UDP**) must 4377*858ea5e5SAndroid Build Coastguard Worker * be an exact match. While IP family (**AF_INET** or 4378*858ea5e5SAndroid Build Coastguard Worker * **AF_INET6**) must be compatible, that is IPv6 sockets 4379*858ea5e5SAndroid Build Coastguard Worker * that are not v6-only can be selected for IPv4 packets. 4380*858ea5e5SAndroid Build Coastguard Worker * 4381*858ea5e5SAndroid Build Coastguard Worker * Only TCP listeners and UDP unconnected sockets can be 4382*858ea5e5SAndroid Build Coastguard Worker * selected. *sk* can also be NULL to reset any previous 4383*858ea5e5SAndroid Build Coastguard Worker * selection. 4384*858ea5e5SAndroid Build Coastguard Worker * 4385*858ea5e5SAndroid Build Coastguard Worker * *flags* argument can combination of following values: 4386*858ea5e5SAndroid Build Coastguard Worker * 4387*858ea5e5SAndroid Build Coastguard Worker * * **BPF_SK_LOOKUP_F_REPLACE** to override the previous 4388*858ea5e5SAndroid Build Coastguard Worker * socket selection, potentially done by a BPF program 4389*858ea5e5SAndroid Build Coastguard Worker * that ran before us. 4390*858ea5e5SAndroid Build Coastguard Worker * 4391*858ea5e5SAndroid Build Coastguard Worker * * **BPF_SK_LOOKUP_F_NO_REUSEPORT** to skip 4392*858ea5e5SAndroid Build Coastguard Worker * load-balancing within reuseport group for the socket 4393*858ea5e5SAndroid Build Coastguard Worker * being selected. 4394*858ea5e5SAndroid Build Coastguard Worker * 4395*858ea5e5SAndroid Build Coastguard Worker * On success *ctx->sk* will point to the selected socket. 4396*858ea5e5SAndroid Build Coastguard Worker * 4397*858ea5e5SAndroid Build Coastguard Worker * Return 4398*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative errno in case of failure. 4399*858ea5e5SAndroid Build Coastguard Worker * 4400*858ea5e5SAndroid Build Coastguard Worker * * **-EAFNOSUPPORT** if socket family (*sk->family*) is 4401*858ea5e5SAndroid Build Coastguard Worker * not compatible with packet family (*ctx->family*). 4402*858ea5e5SAndroid Build Coastguard Worker * 4403*858ea5e5SAndroid Build Coastguard Worker * * **-EEXIST** if socket has been already selected, 4404*858ea5e5SAndroid Build Coastguard Worker * potentially by another program, and 4405*858ea5e5SAndroid Build Coastguard Worker * **BPF_SK_LOOKUP_F_REPLACE** flag was not specified. 4406*858ea5e5SAndroid Build Coastguard Worker * 4407*858ea5e5SAndroid Build Coastguard Worker * * **-EINVAL** if unsupported flags were specified. 4408*858ea5e5SAndroid Build Coastguard Worker * 4409*858ea5e5SAndroid Build Coastguard Worker * * **-EPROTOTYPE** if socket L4 protocol 4410*858ea5e5SAndroid Build Coastguard Worker * (*sk->protocol*) doesn't match packet protocol 4411*858ea5e5SAndroid Build Coastguard Worker * (*ctx->protocol*). 4412*858ea5e5SAndroid Build Coastguard Worker * 4413*858ea5e5SAndroid Build Coastguard Worker * * **-ESOCKTNOSUPPORT** if socket is not in allowed 4414*858ea5e5SAndroid Build Coastguard Worker * state (TCP listening or UDP unconnected). 4415*858ea5e5SAndroid Build Coastguard Worker * 4416*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_ktime_get_boot_ns(void) 4417*858ea5e5SAndroid Build Coastguard Worker * Description 4418*858ea5e5SAndroid Build Coastguard Worker * Return the time elapsed since system boot, in nanoseconds. 4419*858ea5e5SAndroid Build Coastguard Worker * Does include the time the system was suspended. 4420*858ea5e5SAndroid Build Coastguard Worker * See: **clock_gettime**\ (**CLOCK_BOOTTIME**) 4421*858ea5e5SAndroid Build Coastguard Worker * Return 4422*858ea5e5SAndroid Build Coastguard Worker * Current *ktime*. 4423*858ea5e5SAndroid Build Coastguard Worker * 4424*858ea5e5SAndroid Build Coastguard Worker * long bpf_seq_printf(struct seq_file *m, const char *fmt, u32 fmt_size, const void *data, u32 data_len) 4425*858ea5e5SAndroid Build Coastguard Worker * Description 4426*858ea5e5SAndroid Build Coastguard Worker * **bpf_seq_printf**\ () uses seq_file **seq_printf**\ () to print 4427*858ea5e5SAndroid Build Coastguard Worker * out the format string. 4428*858ea5e5SAndroid Build Coastguard Worker * The *m* represents the seq_file. The *fmt* and *fmt_size* are for 4429*858ea5e5SAndroid Build Coastguard Worker * the format string itself. The *data* and *data_len* are format string 4430*858ea5e5SAndroid Build Coastguard Worker * arguments. The *data* are a **u64** array and corresponding format string 4431*858ea5e5SAndroid Build Coastguard Worker * values are stored in the array. For strings and pointers where pointees 4432*858ea5e5SAndroid Build Coastguard Worker * are accessed, only the pointer values are stored in the *data* array. 4433*858ea5e5SAndroid Build Coastguard Worker * The *data_len* is the size of *data* in bytes - must be a multiple of 8. 4434*858ea5e5SAndroid Build Coastguard Worker * 4435*858ea5e5SAndroid Build Coastguard Worker * Formats **%s**, **%p{i,I}{4,6}** requires to read kernel memory. 4436*858ea5e5SAndroid Build Coastguard Worker * Reading kernel memory may fail due to either invalid address or 4437*858ea5e5SAndroid Build Coastguard Worker * valid address but requiring a major memory fault. If reading kernel memory 4438*858ea5e5SAndroid Build Coastguard Worker * fails, the string for **%s** will be an empty string, and the ip 4439*858ea5e5SAndroid Build Coastguard Worker * address for **%p{i,I}{4,6}** will be 0. Not returning error to 4440*858ea5e5SAndroid Build Coastguard Worker * bpf program is consistent with what **bpf_trace_printk**\ () does for now. 4441*858ea5e5SAndroid Build Coastguard Worker * Return 4442*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure: 4443*858ea5e5SAndroid Build Coastguard Worker * 4444*858ea5e5SAndroid Build Coastguard Worker * **-EBUSY** if per-CPU memory copy buffer is busy, can try again 4445*858ea5e5SAndroid Build Coastguard Worker * by returning 1 from bpf program. 4446*858ea5e5SAndroid Build Coastguard Worker * 4447*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if arguments are invalid, or if *fmt* is invalid/unsupported. 4448*858ea5e5SAndroid Build Coastguard Worker * 4449*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if *fmt* contains too many format specifiers. 4450*858ea5e5SAndroid Build Coastguard Worker * 4451*858ea5e5SAndroid Build Coastguard Worker * **-EOVERFLOW** if an overflow happened: The same object will be tried again. 4452*858ea5e5SAndroid Build Coastguard Worker * 4453*858ea5e5SAndroid Build Coastguard Worker * long bpf_seq_write(struct seq_file *m, const void *data, u32 len) 4454*858ea5e5SAndroid Build Coastguard Worker * Description 4455*858ea5e5SAndroid Build Coastguard Worker * **bpf_seq_write**\ () uses seq_file **seq_write**\ () to write the data. 4456*858ea5e5SAndroid Build Coastguard Worker * The *m* represents the seq_file. The *data* and *len* represent the 4457*858ea5e5SAndroid Build Coastguard Worker * data to write in bytes. 4458*858ea5e5SAndroid Build Coastguard Worker * Return 4459*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure: 4460*858ea5e5SAndroid Build Coastguard Worker * 4461*858ea5e5SAndroid Build Coastguard Worker * **-EOVERFLOW** if an overflow happened: The same object will be tried again. 4462*858ea5e5SAndroid Build Coastguard Worker * 4463*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_sk_cgroup_id(void *sk) 4464*858ea5e5SAndroid Build Coastguard Worker * Description 4465*858ea5e5SAndroid Build Coastguard Worker * Return the cgroup v2 id of the socket *sk*. 4466*858ea5e5SAndroid Build Coastguard Worker * 4467*858ea5e5SAndroid Build Coastguard Worker * *sk* must be a non-**NULL** pointer to a socket, e.g. one 4468*858ea5e5SAndroid Build Coastguard Worker * returned from **bpf_sk_lookup_xxx**\ (), 4469*858ea5e5SAndroid Build Coastguard Worker * **bpf_sk_fullsock**\ (), etc. The format of returned id is 4470*858ea5e5SAndroid Build Coastguard Worker * same as in **bpf_skb_cgroup_id**\ (). 4471*858ea5e5SAndroid Build Coastguard Worker * 4472*858ea5e5SAndroid Build Coastguard Worker * This helper is available only if the kernel was compiled with 4473*858ea5e5SAndroid Build Coastguard Worker * the **CONFIG_SOCK_CGROUP_DATA** configuration option. 4474*858ea5e5SAndroid Build Coastguard Worker * Return 4475*858ea5e5SAndroid Build Coastguard Worker * The id is returned or 0 in case the id could not be retrieved. 4476*858ea5e5SAndroid Build Coastguard Worker * 4477*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_sk_ancestor_cgroup_id(void *sk, int ancestor_level) 4478*858ea5e5SAndroid Build Coastguard Worker * Description 4479*858ea5e5SAndroid Build Coastguard Worker * Return id of cgroup v2 that is ancestor of cgroup associated 4480*858ea5e5SAndroid Build Coastguard Worker * with the *sk* at the *ancestor_level*. The root cgroup is at 4481*858ea5e5SAndroid Build Coastguard Worker * *ancestor_level* zero and each step down the hierarchy 4482*858ea5e5SAndroid Build Coastguard Worker * increments the level. If *ancestor_level* == level of cgroup 4483*858ea5e5SAndroid Build Coastguard Worker * associated with *sk*, then return value will be same as that 4484*858ea5e5SAndroid Build Coastguard Worker * of **bpf_sk_cgroup_id**\ (). 4485*858ea5e5SAndroid Build Coastguard Worker * 4486*858ea5e5SAndroid Build Coastguard Worker * The helper is useful to implement policies based on cgroups 4487*858ea5e5SAndroid Build Coastguard Worker * that are upper in hierarchy than immediate cgroup associated 4488*858ea5e5SAndroid Build Coastguard Worker * with *sk*. 4489*858ea5e5SAndroid Build Coastguard Worker * 4490*858ea5e5SAndroid Build Coastguard Worker * The format of returned id and helper limitations are same as in 4491*858ea5e5SAndroid Build Coastguard Worker * **bpf_sk_cgroup_id**\ (). 4492*858ea5e5SAndroid Build Coastguard Worker * Return 4493*858ea5e5SAndroid Build Coastguard Worker * The id is returned or 0 in case the id could not be retrieved. 4494*858ea5e5SAndroid Build Coastguard Worker * 4495*858ea5e5SAndroid Build Coastguard Worker * long bpf_ringbuf_output(void *ringbuf, void *data, u64 size, u64 flags) 4496*858ea5e5SAndroid Build Coastguard Worker * Description 4497*858ea5e5SAndroid Build Coastguard Worker * Copy *size* bytes from *data* into a ring buffer *ringbuf*. 4498*858ea5e5SAndroid Build Coastguard Worker * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification 4499*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent. 4500*858ea5e5SAndroid Build Coastguard Worker * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification 4501*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent unconditionally. 4502*858ea5e5SAndroid Build Coastguard Worker * If **0** is specified in *flags*, an adaptive notification 4503*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent. 4504*858ea5e5SAndroid Build Coastguard Worker * 4505*858ea5e5SAndroid Build Coastguard Worker * An adaptive notification is a notification sent whenever the user-space 4506*858ea5e5SAndroid Build Coastguard Worker * process has caught up and consumed all available payloads. In case the user-space 4507*858ea5e5SAndroid Build Coastguard Worker * process is still processing a previous payload, then no notification is needed 4508*858ea5e5SAndroid Build Coastguard Worker * as it will process the newly added payload automatically. 4509*858ea5e5SAndroid Build Coastguard Worker * Return 4510*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4511*858ea5e5SAndroid Build Coastguard Worker * 4512*858ea5e5SAndroid Build Coastguard Worker * void *bpf_ringbuf_reserve(void *ringbuf, u64 size, u64 flags) 4513*858ea5e5SAndroid Build Coastguard Worker * Description 4514*858ea5e5SAndroid Build Coastguard Worker * Reserve *size* bytes of payload in a ring buffer *ringbuf*. 4515*858ea5e5SAndroid Build Coastguard Worker * *flags* must be 0. 4516*858ea5e5SAndroid Build Coastguard Worker * Return 4517*858ea5e5SAndroid Build Coastguard Worker * Valid pointer with *size* bytes of memory available; NULL, 4518*858ea5e5SAndroid Build Coastguard Worker * otherwise. 4519*858ea5e5SAndroid Build Coastguard Worker * 4520*858ea5e5SAndroid Build Coastguard Worker * void bpf_ringbuf_submit(void *data, u64 flags) 4521*858ea5e5SAndroid Build Coastguard Worker * Description 4522*858ea5e5SAndroid Build Coastguard Worker * Submit reserved ring buffer sample, pointed to by *data*. 4523*858ea5e5SAndroid Build Coastguard Worker * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification 4524*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent. 4525*858ea5e5SAndroid Build Coastguard Worker * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification 4526*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent unconditionally. 4527*858ea5e5SAndroid Build Coastguard Worker * If **0** is specified in *flags*, an adaptive notification 4528*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent. 4529*858ea5e5SAndroid Build Coastguard Worker * 4530*858ea5e5SAndroid Build Coastguard Worker * See 'bpf_ringbuf_output()' for the definition of adaptive notification. 4531*858ea5e5SAndroid Build Coastguard Worker * Return 4532*858ea5e5SAndroid Build Coastguard Worker * Nothing. Always succeeds. 4533*858ea5e5SAndroid Build Coastguard Worker * 4534*858ea5e5SAndroid Build Coastguard Worker * void bpf_ringbuf_discard(void *data, u64 flags) 4535*858ea5e5SAndroid Build Coastguard Worker * Description 4536*858ea5e5SAndroid Build Coastguard Worker * Discard reserved ring buffer sample, pointed to by *data*. 4537*858ea5e5SAndroid Build Coastguard Worker * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification 4538*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent. 4539*858ea5e5SAndroid Build Coastguard Worker * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification 4540*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent unconditionally. 4541*858ea5e5SAndroid Build Coastguard Worker * If **0** is specified in *flags*, an adaptive notification 4542*858ea5e5SAndroid Build Coastguard Worker * of new data availability is sent. 4543*858ea5e5SAndroid Build Coastguard Worker * 4544*858ea5e5SAndroid Build Coastguard Worker * See 'bpf_ringbuf_output()' for the definition of adaptive notification. 4545*858ea5e5SAndroid Build Coastguard Worker * Return 4546*858ea5e5SAndroid Build Coastguard Worker * Nothing. Always succeeds. 4547*858ea5e5SAndroid Build Coastguard Worker * 4548*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_ringbuf_query(void *ringbuf, u64 flags) 4549*858ea5e5SAndroid Build Coastguard Worker * Description 4550*858ea5e5SAndroid Build Coastguard Worker * Query various characteristics of provided ring buffer. What 4551*858ea5e5SAndroid Build Coastguard Worker * exactly is queries is determined by *flags*: 4552*858ea5e5SAndroid Build Coastguard Worker * 4553*858ea5e5SAndroid Build Coastguard Worker * * **BPF_RB_AVAIL_DATA**: Amount of data not yet consumed. 4554*858ea5e5SAndroid Build Coastguard Worker * * **BPF_RB_RING_SIZE**: The size of ring buffer. 4555*858ea5e5SAndroid Build Coastguard Worker * * **BPF_RB_CONS_POS**: Consumer position (can wrap around). 4556*858ea5e5SAndroid Build Coastguard Worker * * **BPF_RB_PROD_POS**: Producer(s) position (can wrap around). 4557*858ea5e5SAndroid Build Coastguard Worker * 4558*858ea5e5SAndroid Build Coastguard Worker * Data returned is just a momentary snapshot of actual values 4559*858ea5e5SAndroid Build Coastguard Worker * and could be inaccurate, so this facility should be used to 4560*858ea5e5SAndroid Build Coastguard Worker * power heuristics and for reporting, not to make 100% correct 4561*858ea5e5SAndroid Build Coastguard Worker * calculation. 4562*858ea5e5SAndroid Build Coastguard Worker * Return 4563*858ea5e5SAndroid Build Coastguard Worker * Requested value, or 0, if *flags* are not recognized. 4564*858ea5e5SAndroid Build Coastguard Worker * 4565*858ea5e5SAndroid Build Coastguard Worker * long bpf_csum_level(struct sk_buff *skb, u64 level) 4566*858ea5e5SAndroid Build Coastguard Worker * Description 4567*858ea5e5SAndroid Build Coastguard Worker * Change the skbs checksum level by one layer up or down, or 4568*858ea5e5SAndroid Build Coastguard Worker * reset it entirely to none in order to have the stack perform 4569*858ea5e5SAndroid Build Coastguard Worker * checksum validation. The level is applicable to the following 4570*858ea5e5SAndroid Build Coastguard Worker * protocols: TCP, UDP, GRE, SCTP, FCOE. For example, a decap of 4571*858ea5e5SAndroid Build Coastguard Worker * | ETH | IP | UDP | GUE | IP | TCP | into | ETH | IP | TCP | 4572*858ea5e5SAndroid Build Coastguard Worker * through **bpf_skb_adjust_room**\ () helper with passing in 4573*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_ADJ_ROOM_NO_CSUM_RESET** flag would require one call 4574*858ea5e5SAndroid Build Coastguard Worker * to **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_DEC** since 4575*858ea5e5SAndroid Build Coastguard Worker * the UDP header is removed. Similarly, an encap of the latter 4576*858ea5e5SAndroid Build Coastguard Worker * into the former could be accompanied by a helper call to 4577*858ea5e5SAndroid Build Coastguard Worker * **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_INC** if the 4578*858ea5e5SAndroid Build Coastguard Worker * skb is still intended to be processed in higher layers of the 4579*858ea5e5SAndroid Build Coastguard Worker * stack instead of just egressing at tc. 4580*858ea5e5SAndroid Build Coastguard Worker * 4581*858ea5e5SAndroid Build Coastguard Worker * There are three supported level settings at this time: 4582*858ea5e5SAndroid Build Coastguard Worker * 4583*858ea5e5SAndroid Build Coastguard Worker * * **BPF_CSUM_LEVEL_INC**: Increases skb->csum_level for skbs 4584*858ea5e5SAndroid Build Coastguard Worker * with CHECKSUM_UNNECESSARY. 4585*858ea5e5SAndroid Build Coastguard Worker * * **BPF_CSUM_LEVEL_DEC**: Decreases skb->csum_level for skbs 4586*858ea5e5SAndroid Build Coastguard Worker * with CHECKSUM_UNNECESSARY. 4587*858ea5e5SAndroid Build Coastguard Worker * * **BPF_CSUM_LEVEL_RESET**: Resets skb->csum_level to 0 and 4588*858ea5e5SAndroid Build Coastguard Worker * sets CHECKSUM_NONE to force checksum validation by the stack. 4589*858ea5e5SAndroid Build Coastguard Worker * * **BPF_CSUM_LEVEL_QUERY**: No-op, returns the current 4590*858ea5e5SAndroid Build Coastguard Worker * skb->csum_level. 4591*858ea5e5SAndroid Build Coastguard Worker * Return 4592*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. In the 4593*858ea5e5SAndroid Build Coastguard Worker * case of **BPF_CSUM_LEVEL_QUERY**, the current skb->csum_level 4594*858ea5e5SAndroid Build Coastguard Worker * is returned or the error code -EACCES in case the skb is not 4595*858ea5e5SAndroid Build Coastguard Worker * subject to CHECKSUM_UNNECESSARY. 4596*858ea5e5SAndroid Build Coastguard Worker * 4597*858ea5e5SAndroid Build Coastguard Worker * struct tcp6_sock *bpf_skc_to_tcp6_sock(void *sk) 4598*858ea5e5SAndroid Build Coastguard Worker * Description 4599*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *tcp6_sock* pointer. 4600*858ea5e5SAndroid Build Coastguard Worker * Return 4601*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 4602*858ea5e5SAndroid Build Coastguard Worker * 4603*858ea5e5SAndroid Build Coastguard Worker * struct tcp_sock *bpf_skc_to_tcp_sock(void *sk) 4604*858ea5e5SAndroid Build Coastguard Worker * Description 4605*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *tcp_sock* pointer. 4606*858ea5e5SAndroid Build Coastguard Worker * Return 4607*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 4608*858ea5e5SAndroid Build Coastguard Worker * 4609*858ea5e5SAndroid Build Coastguard Worker * struct tcp_timewait_sock *bpf_skc_to_tcp_timewait_sock(void *sk) 4610*858ea5e5SAndroid Build Coastguard Worker * Description 4611*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *tcp_timewait_sock* pointer. 4612*858ea5e5SAndroid Build Coastguard Worker * Return 4613*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 4614*858ea5e5SAndroid Build Coastguard Worker * 4615*858ea5e5SAndroid Build Coastguard Worker * struct tcp_request_sock *bpf_skc_to_tcp_request_sock(void *sk) 4616*858ea5e5SAndroid Build Coastguard Worker * Description 4617*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *tcp_request_sock* pointer. 4618*858ea5e5SAndroid Build Coastguard Worker * Return 4619*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 4620*858ea5e5SAndroid Build Coastguard Worker * 4621*858ea5e5SAndroid Build Coastguard Worker * struct udp6_sock *bpf_skc_to_udp6_sock(void *sk) 4622*858ea5e5SAndroid Build Coastguard Worker * Description 4623*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *udp6_sock* pointer. 4624*858ea5e5SAndroid Build Coastguard Worker * Return 4625*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 4626*858ea5e5SAndroid Build Coastguard Worker * 4627*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_task_stack(struct task_struct *task, void *buf, u32 size, u64 flags) 4628*858ea5e5SAndroid Build Coastguard Worker * Description 4629*858ea5e5SAndroid Build Coastguard Worker * Return a user or a kernel stack in bpf program provided buffer. 4630*858ea5e5SAndroid Build Coastguard Worker * Note: the user stack will only be populated if the *task* is 4631*858ea5e5SAndroid Build Coastguard Worker * the current task; all other tasks will return -EOPNOTSUPP. 4632*858ea5e5SAndroid Build Coastguard Worker * To achieve this, the helper needs *task*, which is a valid 4633*858ea5e5SAndroid Build Coastguard Worker * pointer to **struct task_struct**. To store the stacktrace, the 4634*858ea5e5SAndroid Build Coastguard Worker * bpf program provides *buf* with a nonnegative *size*. 4635*858ea5e5SAndroid Build Coastguard Worker * 4636*858ea5e5SAndroid Build Coastguard Worker * The last argument, *flags*, holds the number of stack frames to 4637*858ea5e5SAndroid Build Coastguard Worker * skip (from 0 to 255), masked with 4638*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 4639*858ea5e5SAndroid Build Coastguard Worker * the following flags: 4640*858ea5e5SAndroid Build Coastguard Worker * 4641*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_USER_STACK** 4642*858ea5e5SAndroid Build Coastguard Worker * Collect a user space stack instead of a kernel stack. 4643*858ea5e5SAndroid Build Coastguard Worker * The *task* must be the current task. 4644*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_USER_BUILD_ID** 4645*858ea5e5SAndroid Build Coastguard Worker * Collect buildid+offset instead of ips for user stack, 4646*858ea5e5SAndroid Build Coastguard Worker * only valid if **BPF_F_USER_STACK** is also specified. 4647*858ea5e5SAndroid Build Coastguard Worker * 4648*858ea5e5SAndroid Build Coastguard Worker * **bpf_get_task_stack**\ () can collect up to 4649*858ea5e5SAndroid Build Coastguard Worker * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject 4650*858ea5e5SAndroid Build Coastguard Worker * to sufficient large buffer size. Note that 4651*858ea5e5SAndroid Build Coastguard Worker * this limit can be controlled with the **sysctl** program, and 4652*858ea5e5SAndroid Build Coastguard Worker * that it should be manually increased in order to profile long 4653*858ea5e5SAndroid Build Coastguard Worker * user stacks (such as stacks for Java programs). To do so, use: 4654*858ea5e5SAndroid Build Coastguard Worker * 4655*858ea5e5SAndroid Build Coastguard Worker * :: 4656*858ea5e5SAndroid Build Coastguard Worker * 4657*858ea5e5SAndroid Build Coastguard Worker * # sysctl kernel.perf_event_max_stack=<new value> 4658*858ea5e5SAndroid Build Coastguard Worker * Return 4659*858ea5e5SAndroid Build Coastguard Worker * The non-negative copied *buf* length equal to or less than 4660*858ea5e5SAndroid Build Coastguard Worker * *size* on success, or a negative error in case of failure. 4661*858ea5e5SAndroid Build Coastguard Worker * 4662*858ea5e5SAndroid Build Coastguard Worker * long bpf_load_hdr_opt(struct bpf_sock_ops *skops, void *searchby_res, u32 len, u64 flags) 4663*858ea5e5SAndroid Build Coastguard Worker * Description 4664*858ea5e5SAndroid Build Coastguard Worker * Load header option. Support reading a particular TCP header 4665*858ea5e5SAndroid Build Coastguard Worker * option for bpf program (**BPF_PROG_TYPE_SOCK_OPS**). 4666*858ea5e5SAndroid Build Coastguard Worker * 4667*858ea5e5SAndroid Build Coastguard Worker * If *flags* is 0, it will search the option from the 4668*858ea5e5SAndroid Build Coastguard Worker * *skops*\ **->skb_data**. The comment in **struct bpf_sock_ops** 4669*858ea5e5SAndroid Build Coastguard Worker * has details on what skb_data contains under different 4670*858ea5e5SAndroid Build Coastguard Worker * *skops*\ **->op**. 4671*858ea5e5SAndroid Build Coastguard Worker * 4672*858ea5e5SAndroid Build Coastguard Worker * The first byte of the *searchby_res* specifies the 4673*858ea5e5SAndroid Build Coastguard Worker * kind that it wants to search. 4674*858ea5e5SAndroid Build Coastguard Worker * 4675*858ea5e5SAndroid Build Coastguard Worker * If the searching kind is an experimental kind 4676*858ea5e5SAndroid Build Coastguard Worker * (i.e. 253 or 254 according to RFC6994). It also 4677*858ea5e5SAndroid Build Coastguard Worker * needs to specify the "magic" which is either 4678*858ea5e5SAndroid Build Coastguard Worker * 2 bytes or 4 bytes. It then also needs to 4679*858ea5e5SAndroid Build Coastguard Worker * specify the size of the magic by using 4680*858ea5e5SAndroid Build Coastguard Worker * the 2nd byte which is "kind-length" of a TCP 4681*858ea5e5SAndroid Build Coastguard Worker * header option and the "kind-length" also 4682*858ea5e5SAndroid Build Coastguard Worker * includes the first 2 bytes "kind" and "kind-length" 4683*858ea5e5SAndroid Build Coastguard Worker * itself as a normal TCP header option also does. 4684*858ea5e5SAndroid Build Coastguard Worker * 4685*858ea5e5SAndroid Build Coastguard Worker * For example, to search experimental kind 254 with 4686*858ea5e5SAndroid Build Coastguard Worker * 2 byte magic 0xeB9F, the searchby_res should be 4687*858ea5e5SAndroid Build Coastguard Worker * [ 254, 4, 0xeB, 0x9F, 0, 0, .... 0 ]. 4688*858ea5e5SAndroid Build Coastguard Worker * 4689*858ea5e5SAndroid Build Coastguard Worker * To search for the standard window scale option (3), 4690*858ea5e5SAndroid Build Coastguard Worker * the *searchby_res* should be [ 3, 0, 0, .... 0 ]. 4691*858ea5e5SAndroid Build Coastguard Worker * Note, kind-length must be 0 for regular option. 4692*858ea5e5SAndroid Build Coastguard Worker * 4693*858ea5e5SAndroid Build Coastguard Worker * Searching for No-Op (0) and End-of-Option-List (1) are 4694*858ea5e5SAndroid Build Coastguard Worker * not supported. 4695*858ea5e5SAndroid Build Coastguard Worker * 4696*858ea5e5SAndroid Build Coastguard Worker * *len* must be at least 2 bytes which is the minimal size 4697*858ea5e5SAndroid Build Coastguard Worker * of a header option. 4698*858ea5e5SAndroid Build Coastguard Worker * 4699*858ea5e5SAndroid Build Coastguard Worker * Supported flags: 4700*858ea5e5SAndroid Build Coastguard Worker * 4701*858ea5e5SAndroid Build Coastguard Worker * * **BPF_LOAD_HDR_OPT_TCP_SYN** to search from the 4702*858ea5e5SAndroid Build Coastguard Worker * saved_syn packet or the just-received syn packet. 4703*858ea5e5SAndroid Build Coastguard Worker * 4704*858ea5e5SAndroid Build Coastguard Worker * Return 4705*858ea5e5SAndroid Build Coastguard Worker * > 0 when found, the header option is copied to *searchby_res*. 4706*858ea5e5SAndroid Build Coastguard Worker * The return value is the total length copied. On failure, a 4707*858ea5e5SAndroid Build Coastguard Worker * negative error code is returned: 4708*858ea5e5SAndroid Build Coastguard Worker * 4709*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if a parameter is invalid. 4710*858ea5e5SAndroid Build Coastguard Worker * 4711*858ea5e5SAndroid Build Coastguard Worker * **-ENOMSG** if the option is not found. 4712*858ea5e5SAndroid Build Coastguard Worker * 4713*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if no syn packet is available when 4714*858ea5e5SAndroid Build Coastguard Worker * **BPF_LOAD_HDR_OPT_TCP_SYN** is used. 4715*858ea5e5SAndroid Build Coastguard Worker * 4716*858ea5e5SAndroid Build Coastguard Worker * **-ENOSPC** if there is not enough space. Only *len* number of 4717*858ea5e5SAndroid Build Coastguard Worker * bytes are copied. 4718*858ea5e5SAndroid Build Coastguard Worker * 4719*858ea5e5SAndroid Build Coastguard Worker * **-EFAULT** on failure to parse the header options in the 4720*858ea5e5SAndroid Build Coastguard Worker * packet. 4721*858ea5e5SAndroid Build Coastguard Worker * 4722*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if the helper cannot be used under the current 4723*858ea5e5SAndroid Build Coastguard Worker * *skops*\ **->op**. 4724*858ea5e5SAndroid Build Coastguard Worker * 4725*858ea5e5SAndroid Build Coastguard Worker * long bpf_store_hdr_opt(struct bpf_sock_ops *skops, const void *from, u32 len, u64 flags) 4726*858ea5e5SAndroid Build Coastguard Worker * Description 4727*858ea5e5SAndroid Build Coastguard Worker * Store header option. The data will be copied 4728*858ea5e5SAndroid Build Coastguard Worker * from buffer *from* with length *len* to the TCP header. 4729*858ea5e5SAndroid Build Coastguard Worker * 4730*858ea5e5SAndroid Build Coastguard Worker * The buffer *from* should have the whole option that 4731*858ea5e5SAndroid Build Coastguard Worker * includes the kind, kind-length, and the actual 4732*858ea5e5SAndroid Build Coastguard Worker * option data. The *len* must be at least kind-length 4733*858ea5e5SAndroid Build Coastguard Worker * long. The kind-length does not have to be 4 byte 4734*858ea5e5SAndroid Build Coastguard Worker * aligned. The kernel will take care of the padding 4735*858ea5e5SAndroid Build Coastguard Worker * and setting the 4 bytes aligned value to th->doff. 4736*858ea5e5SAndroid Build Coastguard Worker * 4737*858ea5e5SAndroid Build Coastguard Worker * This helper will check for duplicated option 4738*858ea5e5SAndroid Build Coastguard Worker * by searching the same option in the outgoing skb. 4739*858ea5e5SAndroid Build Coastguard Worker * 4740*858ea5e5SAndroid Build Coastguard Worker * This helper can only be called during 4741*858ea5e5SAndroid Build Coastguard Worker * **BPF_SOCK_OPS_WRITE_HDR_OPT_CB**. 4742*858ea5e5SAndroid Build Coastguard Worker * 4743*858ea5e5SAndroid Build Coastguard Worker * Return 4744*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or negative error in case of failure: 4745*858ea5e5SAndroid Build Coastguard Worker * 4746*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** If param is invalid. 4747*858ea5e5SAndroid Build Coastguard Worker * 4748*858ea5e5SAndroid Build Coastguard Worker * **-ENOSPC** if there is not enough space in the header. 4749*858ea5e5SAndroid Build Coastguard Worker * Nothing has been written 4750*858ea5e5SAndroid Build Coastguard Worker * 4751*858ea5e5SAndroid Build Coastguard Worker * **-EEXIST** if the option already exists. 4752*858ea5e5SAndroid Build Coastguard Worker * 4753*858ea5e5SAndroid Build Coastguard Worker * **-EFAULT** on failure to parse the existing header options. 4754*858ea5e5SAndroid Build Coastguard Worker * 4755*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if the helper cannot be used under the current 4756*858ea5e5SAndroid Build Coastguard Worker * *skops*\ **->op**. 4757*858ea5e5SAndroid Build Coastguard Worker * 4758*858ea5e5SAndroid Build Coastguard Worker * long bpf_reserve_hdr_opt(struct bpf_sock_ops *skops, u32 len, u64 flags) 4759*858ea5e5SAndroid Build Coastguard Worker * Description 4760*858ea5e5SAndroid Build Coastguard Worker * Reserve *len* bytes for the bpf header option. The 4761*858ea5e5SAndroid Build Coastguard Worker * space will be used by **bpf_store_hdr_opt**\ () later in 4762*858ea5e5SAndroid Build Coastguard Worker * **BPF_SOCK_OPS_WRITE_HDR_OPT_CB**. 4763*858ea5e5SAndroid Build Coastguard Worker * 4764*858ea5e5SAndroid Build Coastguard Worker * If **bpf_reserve_hdr_opt**\ () is called multiple times, 4765*858ea5e5SAndroid Build Coastguard Worker * the total number of bytes will be reserved. 4766*858ea5e5SAndroid Build Coastguard Worker * 4767*858ea5e5SAndroid Build Coastguard Worker * This helper can only be called during 4768*858ea5e5SAndroid Build Coastguard Worker * **BPF_SOCK_OPS_HDR_OPT_LEN_CB**. 4769*858ea5e5SAndroid Build Coastguard Worker * 4770*858ea5e5SAndroid Build Coastguard Worker * Return 4771*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or negative error in case of failure: 4772*858ea5e5SAndroid Build Coastguard Worker * 4773*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if a parameter is invalid. 4774*858ea5e5SAndroid Build Coastguard Worker * 4775*858ea5e5SAndroid Build Coastguard Worker * **-ENOSPC** if there is not enough space in the header. 4776*858ea5e5SAndroid Build Coastguard Worker * 4777*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if the helper cannot be used under the current 4778*858ea5e5SAndroid Build Coastguard Worker * *skops*\ **->op**. 4779*858ea5e5SAndroid Build Coastguard Worker * 4780*858ea5e5SAndroid Build Coastguard Worker * void *bpf_inode_storage_get(struct bpf_map *map, void *inode, void *value, u64 flags) 4781*858ea5e5SAndroid Build Coastguard Worker * Description 4782*858ea5e5SAndroid Build Coastguard Worker * Get a bpf_local_storage from an *inode*. 4783*858ea5e5SAndroid Build Coastguard Worker * 4784*858ea5e5SAndroid Build Coastguard Worker * Logically, it could be thought of as getting the value from 4785*858ea5e5SAndroid Build Coastguard Worker * a *map* with *inode* as the **key**. From this 4786*858ea5e5SAndroid Build Coastguard Worker * perspective, the usage is not much different from 4787*858ea5e5SAndroid Build Coastguard Worker * **bpf_map_lookup_elem**\ (*map*, **&**\ *inode*) except this 4788*858ea5e5SAndroid Build Coastguard Worker * helper enforces the key must be an inode and the map must also 4789*858ea5e5SAndroid Build Coastguard Worker * be a **BPF_MAP_TYPE_INODE_STORAGE**. 4790*858ea5e5SAndroid Build Coastguard Worker * 4791*858ea5e5SAndroid Build Coastguard Worker * Underneath, the value is stored locally at *inode* instead of 4792*858ea5e5SAndroid Build Coastguard Worker * the *map*. The *map* is used as the bpf-local-storage 4793*858ea5e5SAndroid Build Coastguard Worker * "type". The bpf-local-storage "type" (i.e. the *map*) is 4794*858ea5e5SAndroid Build Coastguard Worker * searched against all bpf_local_storage residing at *inode*. 4795*858ea5e5SAndroid Build Coastguard Worker * 4796*858ea5e5SAndroid Build Coastguard Worker * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be 4797*858ea5e5SAndroid Build Coastguard Worker * used such that a new bpf_local_storage will be 4798*858ea5e5SAndroid Build Coastguard Worker * created if one does not exist. *value* can be used 4799*858ea5e5SAndroid Build Coastguard Worker * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify 4800*858ea5e5SAndroid Build Coastguard Worker * the initial value of a bpf_local_storage. If *value* is 4801*858ea5e5SAndroid Build Coastguard Worker * **NULL**, the new bpf_local_storage will be zero initialized. 4802*858ea5e5SAndroid Build Coastguard Worker * Return 4803*858ea5e5SAndroid Build Coastguard Worker * A bpf_local_storage pointer is returned on success. 4804*858ea5e5SAndroid Build Coastguard Worker * 4805*858ea5e5SAndroid Build Coastguard Worker * **NULL** if not found or there was an error in adding 4806*858ea5e5SAndroid Build Coastguard Worker * a new bpf_local_storage. 4807*858ea5e5SAndroid Build Coastguard Worker * 4808*858ea5e5SAndroid Build Coastguard Worker * int bpf_inode_storage_delete(struct bpf_map *map, void *inode) 4809*858ea5e5SAndroid Build Coastguard Worker * Description 4810*858ea5e5SAndroid Build Coastguard Worker * Delete a bpf_local_storage from an *inode*. 4811*858ea5e5SAndroid Build Coastguard Worker * Return 4812*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 4813*858ea5e5SAndroid Build Coastguard Worker * 4814*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if the bpf_local_storage cannot be found. 4815*858ea5e5SAndroid Build Coastguard Worker * 4816*858ea5e5SAndroid Build Coastguard Worker * long bpf_d_path(struct path *path, char *buf, u32 sz) 4817*858ea5e5SAndroid Build Coastguard Worker * Description 4818*858ea5e5SAndroid Build Coastguard Worker * Return full path for given **struct path** object, which 4819*858ea5e5SAndroid Build Coastguard Worker * needs to be the kernel BTF *path* object. The path is 4820*858ea5e5SAndroid Build Coastguard Worker * returned in the provided buffer *buf* of size *sz* and 4821*858ea5e5SAndroid Build Coastguard Worker * is zero terminated. 4822*858ea5e5SAndroid Build Coastguard Worker * 4823*858ea5e5SAndroid Build Coastguard Worker * Return 4824*858ea5e5SAndroid Build Coastguard Worker * On success, the strictly positive length of the string, 4825*858ea5e5SAndroid Build Coastguard Worker * including the trailing NUL character. On error, a negative 4826*858ea5e5SAndroid Build Coastguard Worker * value. 4827*858ea5e5SAndroid Build Coastguard Worker * 4828*858ea5e5SAndroid Build Coastguard Worker * long bpf_copy_from_user(void *dst, u32 size, const void *user_ptr) 4829*858ea5e5SAndroid Build Coastguard Worker * Description 4830*858ea5e5SAndroid Build Coastguard Worker * Read *size* bytes from user space address *user_ptr* and store 4831*858ea5e5SAndroid Build Coastguard Worker * the data in *dst*. This is a wrapper of **copy_from_user**\ (). 4832*858ea5e5SAndroid Build Coastguard Worker * Return 4833*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 4834*858ea5e5SAndroid Build Coastguard Worker * 4835*858ea5e5SAndroid Build Coastguard Worker * long bpf_snprintf_btf(char *str, u32 str_size, struct btf_ptr *ptr, u32 btf_ptr_size, u64 flags) 4836*858ea5e5SAndroid Build Coastguard Worker * Description 4837*858ea5e5SAndroid Build Coastguard Worker * Use BTF to store a string representation of *ptr*->ptr in *str*, 4838*858ea5e5SAndroid Build Coastguard Worker * using *ptr*->type_id. This value should specify the type 4839*858ea5e5SAndroid Build Coastguard Worker * that *ptr*->ptr points to. LLVM __builtin_btf_type_id(type, 1) 4840*858ea5e5SAndroid Build Coastguard Worker * can be used to look up vmlinux BTF type ids. Traversing the 4841*858ea5e5SAndroid Build Coastguard Worker * data structure using BTF, the type information and values are 4842*858ea5e5SAndroid Build Coastguard Worker * stored in the first *str_size* - 1 bytes of *str*. Safe copy of 4843*858ea5e5SAndroid Build Coastguard Worker * the pointer data is carried out to avoid kernel crashes during 4844*858ea5e5SAndroid Build Coastguard Worker * operation. Smaller types can use string space on the stack; 4845*858ea5e5SAndroid Build Coastguard Worker * larger programs can use map data to store the string 4846*858ea5e5SAndroid Build Coastguard Worker * representation. 4847*858ea5e5SAndroid Build Coastguard Worker * 4848*858ea5e5SAndroid Build Coastguard Worker * The string can be subsequently shared with userspace via 4849*858ea5e5SAndroid Build Coastguard Worker * bpf_perf_event_output() or ring buffer interfaces. 4850*858ea5e5SAndroid Build Coastguard Worker * bpf_trace_printk() is to be avoided as it places too small 4851*858ea5e5SAndroid Build Coastguard Worker * a limit on string size to be useful. 4852*858ea5e5SAndroid Build Coastguard Worker * 4853*858ea5e5SAndroid Build Coastguard Worker * *flags* is a combination of 4854*858ea5e5SAndroid Build Coastguard Worker * 4855*858ea5e5SAndroid Build Coastguard Worker * **BTF_F_COMPACT** 4856*858ea5e5SAndroid Build Coastguard Worker * no formatting around type information 4857*858ea5e5SAndroid Build Coastguard Worker * **BTF_F_NONAME** 4858*858ea5e5SAndroid Build Coastguard Worker * no struct/union member names/types 4859*858ea5e5SAndroid Build Coastguard Worker * **BTF_F_PTR_RAW** 4860*858ea5e5SAndroid Build Coastguard Worker * show raw (unobfuscated) pointer values; 4861*858ea5e5SAndroid Build Coastguard Worker * equivalent to printk specifier %px. 4862*858ea5e5SAndroid Build Coastguard Worker * **BTF_F_ZERO** 4863*858ea5e5SAndroid Build Coastguard Worker * show zero-valued struct/union members; they 4864*858ea5e5SAndroid Build Coastguard Worker * are not displayed by default 4865*858ea5e5SAndroid Build Coastguard Worker * 4866*858ea5e5SAndroid Build Coastguard Worker * Return 4867*858ea5e5SAndroid Build Coastguard Worker * The number of bytes that were written (or would have been 4868*858ea5e5SAndroid Build Coastguard Worker * written if output had to be truncated due to string size), 4869*858ea5e5SAndroid Build Coastguard Worker * or a negative error in cases of failure. 4870*858ea5e5SAndroid Build Coastguard Worker * 4871*858ea5e5SAndroid Build Coastguard Worker * long bpf_seq_printf_btf(struct seq_file *m, struct btf_ptr *ptr, u32 ptr_size, u64 flags) 4872*858ea5e5SAndroid Build Coastguard Worker * Description 4873*858ea5e5SAndroid Build Coastguard Worker * Use BTF to write to seq_write a string representation of 4874*858ea5e5SAndroid Build Coastguard Worker * *ptr*->ptr, using *ptr*->type_id as per bpf_snprintf_btf(). 4875*858ea5e5SAndroid Build Coastguard Worker * *flags* are identical to those used for bpf_snprintf_btf. 4876*858ea5e5SAndroid Build Coastguard Worker * Return 4877*858ea5e5SAndroid Build Coastguard Worker * 0 on success or a negative error in case of failure. 4878*858ea5e5SAndroid Build Coastguard Worker * 4879*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_skb_cgroup_classid(struct sk_buff *skb) 4880*858ea5e5SAndroid Build Coastguard Worker * Description 4881*858ea5e5SAndroid Build Coastguard Worker * See **bpf_get_cgroup_classid**\ () for the main description. 4882*858ea5e5SAndroid Build Coastguard Worker * This helper differs from **bpf_get_cgroup_classid**\ () in that 4883*858ea5e5SAndroid Build Coastguard Worker * the cgroup v1 net_cls class is retrieved only from the *skb*'s 4884*858ea5e5SAndroid Build Coastguard Worker * associated socket instead of the current process. 4885*858ea5e5SAndroid Build Coastguard Worker * Return 4886*858ea5e5SAndroid Build Coastguard Worker * The id is returned or 0 in case the id could not be retrieved. 4887*858ea5e5SAndroid Build Coastguard Worker * 4888*858ea5e5SAndroid Build Coastguard Worker * long bpf_redirect_neigh(u32 ifindex, struct bpf_redir_neigh *params, int plen, u64 flags) 4889*858ea5e5SAndroid Build Coastguard Worker * Description 4890*858ea5e5SAndroid Build Coastguard Worker * Redirect the packet to another net device of index *ifindex* 4891*858ea5e5SAndroid Build Coastguard Worker * and fill in L2 addresses from neighboring subsystem. This helper 4892*858ea5e5SAndroid Build Coastguard Worker * is somewhat similar to **bpf_redirect**\ (), except that it 4893*858ea5e5SAndroid Build Coastguard Worker * populates L2 addresses as well, meaning, internally, the helper 4894*858ea5e5SAndroid Build Coastguard Worker * relies on the neighbor lookup for the L2 address of the nexthop. 4895*858ea5e5SAndroid Build Coastguard Worker * 4896*858ea5e5SAndroid Build Coastguard Worker * The helper will perform a FIB lookup based on the skb's 4897*858ea5e5SAndroid Build Coastguard Worker * networking header to get the address of the next hop, unless 4898*858ea5e5SAndroid Build Coastguard Worker * this is supplied by the caller in the *params* argument. The 4899*858ea5e5SAndroid Build Coastguard Worker * *plen* argument indicates the len of *params* and should be set 4900*858ea5e5SAndroid Build Coastguard Worker * to 0 if *params* is NULL. 4901*858ea5e5SAndroid Build Coastguard Worker * 4902*858ea5e5SAndroid Build Coastguard Worker * The *flags* argument is reserved and must be 0. The helper is 4903*858ea5e5SAndroid Build Coastguard Worker * currently only supported for tc BPF program types, and enabled 4904*858ea5e5SAndroid Build Coastguard Worker * for IPv4 and IPv6 protocols. 4905*858ea5e5SAndroid Build Coastguard Worker * Return 4906*858ea5e5SAndroid Build Coastguard Worker * The helper returns **TC_ACT_REDIRECT** on success or 4907*858ea5e5SAndroid Build Coastguard Worker * **TC_ACT_SHOT** on error. 4908*858ea5e5SAndroid Build Coastguard Worker * 4909*858ea5e5SAndroid Build Coastguard Worker * void *bpf_per_cpu_ptr(const void *percpu_ptr, u32 cpu) 4910*858ea5e5SAndroid Build Coastguard Worker * Description 4911*858ea5e5SAndroid Build Coastguard Worker * Take a pointer to a percpu ksym, *percpu_ptr*, and return a 4912*858ea5e5SAndroid Build Coastguard Worker * pointer to the percpu kernel variable on *cpu*. A ksym is an 4913*858ea5e5SAndroid Build Coastguard Worker * extern variable decorated with '__ksym'. For ksym, there is a 4914*858ea5e5SAndroid Build Coastguard Worker * global var (either static or global) defined of the same name 4915*858ea5e5SAndroid Build Coastguard Worker * in the kernel. The ksym is percpu if the global var is percpu. 4916*858ea5e5SAndroid Build Coastguard Worker * The returned pointer points to the global percpu var on *cpu*. 4917*858ea5e5SAndroid Build Coastguard Worker * 4918*858ea5e5SAndroid Build Coastguard Worker * bpf_per_cpu_ptr() has the same semantic as per_cpu_ptr() in the 4919*858ea5e5SAndroid Build Coastguard Worker * kernel, except that bpf_per_cpu_ptr() may return NULL. This 4920*858ea5e5SAndroid Build Coastguard Worker * happens if *cpu* is larger than nr_cpu_ids. The caller of 4921*858ea5e5SAndroid Build Coastguard Worker * bpf_per_cpu_ptr() must check the returned value. 4922*858ea5e5SAndroid Build Coastguard Worker * Return 4923*858ea5e5SAndroid Build Coastguard Worker * A pointer pointing to the kernel percpu variable on *cpu*, or 4924*858ea5e5SAndroid Build Coastguard Worker * NULL, if *cpu* is invalid. 4925*858ea5e5SAndroid Build Coastguard Worker * 4926*858ea5e5SAndroid Build Coastguard Worker * void *bpf_this_cpu_ptr(const void *percpu_ptr) 4927*858ea5e5SAndroid Build Coastguard Worker * Description 4928*858ea5e5SAndroid Build Coastguard Worker * Take a pointer to a percpu ksym, *percpu_ptr*, and return a 4929*858ea5e5SAndroid Build Coastguard Worker * pointer to the percpu kernel variable on this cpu. See the 4930*858ea5e5SAndroid Build Coastguard Worker * description of 'ksym' in **bpf_per_cpu_ptr**\ (). 4931*858ea5e5SAndroid Build Coastguard Worker * 4932*858ea5e5SAndroid Build Coastguard Worker * bpf_this_cpu_ptr() has the same semantic as this_cpu_ptr() in 4933*858ea5e5SAndroid Build Coastguard Worker * the kernel. Different from **bpf_per_cpu_ptr**\ (), it would 4934*858ea5e5SAndroid Build Coastguard Worker * never return NULL. 4935*858ea5e5SAndroid Build Coastguard Worker * Return 4936*858ea5e5SAndroid Build Coastguard Worker * A pointer pointing to the kernel percpu variable on this cpu. 4937*858ea5e5SAndroid Build Coastguard Worker * 4938*858ea5e5SAndroid Build Coastguard Worker * long bpf_redirect_peer(u32 ifindex, u64 flags) 4939*858ea5e5SAndroid Build Coastguard Worker * Description 4940*858ea5e5SAndroid Build Coastguard Worker * Redirect the packet to another net device of index *ifindex*. 4941*858ea5e5SAndroid Build Coastguard Worker * This helper is somewhat similar to **bpf_redirect**\ (), except 4942*858ea5e5SAndroid Build Coastguard Worker * that the redirection happens to the *ifindex*' peer device and 4943*858ea5e5SAndroid Build Coastguard Worker * the netns switch takes place from ingress to ingress without 4944*858ea5e5SAndroid Build Coastguard Worker * going through the CPU's backlog queue. 4945*858ea5e5SAndroid Build Coastguard Worker * 4946*858ea5e5SAndroid Build Coastguard Worker * The *flags* argument is reserved and must be 0. The helper is 4947*858ea5e5SAndroid Build Coastguard Worker * currently only supported for tc BPF program types at the 4948*858ea5e5SAndroid Build Coastguard Worker * ingress hook and for veth and netkit target device types. The 4949*858ea5e5SAndroid Build Coastguard Worker * peer device must reside in a different network namespace. 4950*858ea5e5SAndroid Build Coastguard Worker * Return 4951*858ea5e5SAndroid Build Coastguard Worker * The helper returns **TC_ACT_REDIRECT** on success or 4952*858ea5e5SAndroid Build Coastguard Worker * **TC_ACT_SHOT** on error. 4953*858ea5e5SAndroid Build Coastguard Worker * 4954*858ea5e5SAndroid Build Coastguard Worker * void *bpf_task_storage_get(struct bpf_map *map, struct task_struct *task, void *value, u64 flags) 4955*858ea5e5SAndroid Build Coastguard Worker * Description 4956*858ea5e5SAndroid Build Coastguard Worker * Get a bpf_local_storage from the *task*. 4957*858ea5e5SAndroid Build Coastguard Worker * 4958*858ea5e5SAndroid Build Coastguard Worker * Logically, it could be thought of as getting the value from 4959*858ea5e5SAndroid Build Coastguard Worker * a *map* with *task* as the **key**. From this 4960*858ea5e5SAndroid Build Coastguard Worker * perspective, the usage is not much different from 4961*858ea5e5SAndroid Build Coastguard Worker * **bpf_map_lookup_elem**\ (*map*, **&**\ *task*) except this 4962*858ea5e5SAndroid Build Coastguard Worker * helper enforces the key must be a task_struct and the map must also 4963*858ea5e5SAndroid Build Coastguard Worker * be a **BPF_MAP_TYPE_TASK_STORAGE**. 4964*858ea5e5SAndroid Build Coastguard Worker * 4965*858ea5e5SAndroid Build Coastguard Worker * Underneath, the value is stored locally at *task* instead of 4966*858ea5e5SAndroid Build Coastguard Worker * the *map*. The *map* is used as the bpf-local-storage 4967*858ea5e5SAndroid Build Coastguard Worker * "type". The bpf-local-storage "type" (i.e. the *map*) is 4968*858ea5e5SAndroid Build Coastguard Worker * searched against all bpf_local_storage residing at *task*. 4969*858ea5e5SAndroid Build Coastguard Worker * 4970*858ea5e5SAndroid Build Coastguard Worker * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be 4971*858ea5e5SAndroid Build Coastguard Worker * used such that a new bpf_local_storage will be 4972*858ea5e5SAndroid Build Coastguard Worker * created if one does not exist. *value* can be used 4973*858ea5e5SAndroid Build Coastguard Worker * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify 4974*858ea5e5SAndroid Build Coastguard Worker * the initial value of a bpf_local_storage. If *value* is 4975*858ea5e5SAndroid Build Coastguard Worker * **NULL**, the new bpf_local_storage will be zero initialized. 4976*858ea5e5SAndroid Build Coastguard Worker * Return 4977*858ea5e5SAndroid Build Coastguard Worker * A bpf_local_storage pointer is returned on success. 4978*858ea5e5SAndroid Build Coastguard Worker * 4979*858ea5e5SAndroid Build Coastguard Worker * **NULL** if not found or there was an error in adding 4980*858ea5e5SAndroid Build Coastguard Worker * a new bpf_local_storage. 4981*858ea5e5SAndroid Build Coastguard Worker * 4982*858ea5e5SAndroid Build Coastguard Worker * long bpf_task_storage_delete(struct bpf_map *map, struct task_struct *task) 4983*858ea5e5SAndroid Build Coastguard Worker * Description 4984*858ea5e5SAndroid Build Coastguard Worker * Delete a bpf_local_storage from a *task*. 4985*858ea5e5SAndroid Build Coastguard Worker * Return 4986*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 4987*858ea5e5SAndroid Build Coastguard Worker * 4988*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if the bpf_local_storage cannot be found. 4989*858ea5e5SAndroid Build Coastguard Worker * 4990*858ea5e5SAndroid Build Coastguard Worker * struct task_struct *bpf_get_current_task_btf(void) 4991*858ea5e5SAndroid Build Coastguard Worker * Description 4992*858ea5e5SAndroid Build Coastguard Worker * Return a BTF pointer to the "current" task. 4993*858ea5e5SAndroid Build Coastguard Worker * This pointer can also be used in helpers that accept an 4994*858ea5e5SAndroid Build Coastguard Worker * *ARG_PTR_TO_BTF_ID* of type *task_struct*. 4995*858ea5e5SAndroid Build Coastguard Worker * Return 4996*858ea5e5SAndroid Build Coastguard Worker * Pointer to the current task. 4997*858ea5e5SAndroid Build Coastguard Worker * 4998*858ea5e5SAndroid Build Coastguard Worker * long bpf_bprm_opts_set(struct linux_binprm *bprm, u64 flags) 4999*858ea5e5SAndroid Build Coastguard Worker * Description 5000*858ea5e5SAndroid Build Coastguard Worker * Set or clear certain options on *bprm*: 5001*858ea5e5SAndroid Build Coastguard Worker * 5002*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_BPRM_SECUREEXEC** Set the secureexec bit 5003*858ea5e5SAndroid Build Coastguard Worker * which sets the **AT_SECURE** auxv for glibc. The bit 5004*858ea5e5SAndroid Build Coastguard Worker * is cleared if the flag is not specified. 5005*858ea5e5SAndroid Build Coastguard Worker * Return 5006*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if invalid *flags* are passed, zero otherwise. 5007*858ea5e5SAndroid Build Coastguard Worker * 5008*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_ktime_get_coarse_ns(void) 5009*858ea5e5SAndroid Build Coastguard Worker * Description 5010*858ea5e5SAndroid Build Coastguard Worker * Return a coarse-grained version of the time elapsed since 5011*858ea5e5SAndroid Build Coastguard Worker * system boot, in nanoseconds. Does not include time the system 5012*858ea5e5SAndroid Build Coastguard Worker * was suspended. 5013*858ea5e5SAndroid Build Coastguard Worker * 5014*858ea5e5SAndroid Build Coastguard Worker * See: **clock_gettime**\ (**CLOCK_MONOTONIC_COARSE**) 5015*858ea5e5SAndroid Build Coastguard Worker * Return 5016*858ea5e5SAndroid Build Coastguard Worker * Current *ktime*. 5017*858ea5e5SAndroid Build Coastguard Worker * 5018*858ea5e5SAndroid Build Coastguard Worker * long bpf_ima_inode_hash(struct inode *inode, void *dst, u32 size) 5019*858ea5e5SAndroid Build Coastguard Worker * Description 5020*858ea5e5SAndroid Build Coastguard Worker * Returns the stored IMA hash of the *inode* (if it's available). 5021*858ea5e5SAndroid Build Coastguard Worker * If the hash is larger than *size*, then only *size* 5022*858ea5e5SAndroid Build Coastguard Worker * bytes will be copied to *dst* 5023*858ea5e5SAndroid Build Coastguard Worker * Return 5024*858ea5e5SAndroid Build Coastguard Worker * The **hash_algo** is returned on success, 5025*858ea5e5SAndroid Build Coastguard Worker * **-EOPNOTSUP** if IMA is disabled or **-EINVAL** if 5026*858ea5e5SAndroid Build Coastguard Worker * invalid arguments are passed. 5027*858ea5e5SAndroid Build Coastguard Worker * 5028*858ea5e5SAndroid Build Coastguard Worker * struct socket *bpf_sock_from_file(struct file *file) 5029*858ea5e5SAndroid Build Coastguard Worker * Description 5030*858ea5e5SAndroid Build Coastguard Worker * If the given file represents a socket, returns the associated 5031*858ea5e5SAndroid Build Coastguard Worker * socket. 5032*858ea5e5SAndroid Build Coastguard Worker * Return 5033*858ea5e5SAndroid Build Coastguard Worker * A pointer to a struct socket on success or NULL if the file is 5034*858ea5e5SAndroid Build Coastguard Worker * not a socket. 5035*858ea5e5SAndroid Build Coastguard Worker * 5036*858ea5e5SAndroid Build Coastguard Worker * long bpf_check_mtu(void *ctx, u32 ifindex, u32 *mtu_len, s32 len_diff, u64 flags) 5037*858ea5e5SAndroid Build Coastguard Worker * Description 5038*858ea5e5SAndroid Build Coastguard Worker * Check packet size against exceeding MTU of net device (based 5039*858ea5e5SAndroid Build Coastguard Worker * on *ifindex*). This helper will likely be used in combination 5040*858ea5e5SAndroid Build Coastguard Worker * with helpers that adjust/change the packet size. 5041*858ea5e5SAndroid Build Coastguard Worker * 5042*858ea5e5SAndroid Build Coastguard Worker * The argument *len_diff* can be used for querying with a planned 5043*858ea5e5SAndroid Build Coastguard Worker * size change. This allows to check MTU prior to changing packet 5044*858ea5e5SAndroid Build Coastguard Worker * ctx. Providing a *len_diff* adjustment that is larger than the 5045*858ea5e5SAndroid Build Coastguard Worker * actual packet size (resulting in negative packet size) will in 5046*858ea5e5SAndroid Build Coastguard Worker * principle not exceed the MTU, which is why it is not considered 5047*858ea5e5SAndroid Build Coastguard Worker * a failure. Other BPF helpers are needed for performing the 5048*858ea5e5SAndroid Build Coastguard Worker * planned size change; therefore the responsibility for catching 5049*858ea5e5SAndroid Build Coastguard Worker * a negative packet size belongs in those helpers. 5050*858ea5e5SAndroid Build Coastguard Worker * 5051*858ea5e5SAndroid Build Coastguard Worker * Specifying *ifindex* zero means the MTU check is performed 5052*858ea5e5SAndroid Build Coastguard Worker * against the current net device. This is practical if this isn't 5053*858ea5e5SAndroid Build Coastguard Worker * used prior to redirect. 5054*858ea5e5SAndroid Build Coastguard Worker * 5055*858ea5e5SAndroid Build Coastguard Worker * On input *mtu_len* must be a valid pointer, else verifier will 5056*858ea5e5SAndroid Build Coastguard Worker * reject BPF program. If the value *mtu_len* is initialized to 5057*858ea5e5SAndroid Build Coastguard Worker * zero then the ctx packet size is use. When value *mtu_len* is 5058*858ea5e5SAndroid Build Coastguard Worker * provided as input this specify the L3 length that the MTU check 5059*858ea5e5SAndroid Build Coastguard Worker * is done against. Remember XDP and TC length operate at L2, but 5060*858ea5e5SAndroid Build Coastguard Worker * this value is L3 as this correlate to MTU and IP-header tot_len 5061*858ea5e5SAndroid Build Coastguard Worker * values which are L3 (similar behavior as bpf_fib_lookup). 5062*858ea5e5SAndroid Build Coastguard Worker * 5063*858ea5e5SAndroid Build Coastguard Worker * The Linux kernel route table can configure MTUs on a more 5064*858ea5e5SAndroid Build Coastguard Worker * specific per route level, which is not provided by this helper. 5065*858ea5e5SAndroid Build Coastguard Worker * For route level MTU checks use the **bpf_fib_lookup**\ () 5066*858ea5e5SAndroid Build Coastguard Worker * helper. 5067*858ea5e5SAndroid Build Coastguard Worker * 5068*858ea5e5SAndroid Build Coastguard Worker * *ctx* is either **struct xdp_md** for XDP programs or 5069*858ea5e5SAndroid Build Coastguard Worker * **struct sk_buff** for tc cls_act programs. 5070*858ea5e5SAndroid Build Coastguard Worker * 5071*858ea5e5SAndroid Build Coastguard Worker * The *flags* argument can be a combination of one or more of the 5072*858ea5e5SAndroid Build Coastguard Worker * following values: 5073*858ea5e5SAndroid Build Coastguard Worker * 5074*858ea5e5SAndroid Build Coastguard Worker * **BPF_MTU_CHK_SEGS** 5075*858ea5e5SAndroid Build Coastguard Worker * This flag will only works for *ctx* **struct sk_buff**. 5076*858ea5e5SAndroid Build Coastguard Worker * If packet context contains extra packet segment buffers 5077*858ea5e5SAndroid Build Coastguard Worker * (often knows as GSO skb), then MTU check is harder to 5078*858ea5e5SAndroid Build Coastguard Worker * check at this point, because in transmit path it is 5079*858ea5e5SAndroid Build Coastguard Worker * possible for the skb packet to get re-segmented 5080*858ea5e5SAndroid Build Coastguard Worker * (depending on net device features). This could still be 5081*858ea5e5SAndroid Build Coastguard Worker * a MTU violation, so this flag enables performing MTU 5082*858ea5e5SAndroid Build Coastguard Worker * check against segments, with a different violation 5083*858ea5e5SAndroid Build Coastguard Worker * return code to tell it apart. Check cannot use len_diff. 5084*858ea5e5SAndroid Build Coastguard Worker * 5085*858ea5e5SAndroid Build Coastguard Worker * On return *mtu_len* pointer contains the MTU value of the net 5086*858ea5e5SAndroid Build Coastguard Worker * device. Remember the net device configured MTU is the L3 size, 5087*858ea5e5SAndroid Build Coastguard Worker * which is returned here and XDP and TC length operate at L2. 5088*858ea5e5SAndroid Build Coastguard Worker * Helper take this into account for you, but remember when using 5089*858ea5e5SAndroid Build Coastguard Worker * MTU value in your BPF-code. 5090*858ea5e5SAndroid Build Coastguard Worker * 5091*858ea5e5SAndroid Build Coastguard Worker * Return 5092*858ea5e5SAndroid Build Coastguard Worker * * 0 on success, and populate MTU value in *mtu_len* pointer. 5093*858ea5e5SAndroid Build Coastguard Worker * 5094*858ea5e5SAndroid Build Coastguard Worker * * < 0 if any input argument is invalid (*mtu_len* not updated) 5095*858ea5e5SAndroid Build Coastguard Worker * 5096*858ea5e5SAndroid Build Coastguard Worker * MTU violations return positive values, but also populate MTU 5097*858ea5e5SAndroid Build Coastguard Worker * value in *mtu_len* pointer, as this can be needed for 5098*858ea5e5SAndroid Build Coastguard Worker * implementing PMTU handing: 5099*858ea5e5SAndroid Build Coastguard Worker * 5100*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MTU_CHK_RET_FRAG_NEEDED** 5101*858ea5e5SAndroid Build Coastguard Worker * * **BPF_MTU_CHK_RET_SEGS_TOOBIG** 5102*858ea5e5SAndroid Build Coastguard Worker * 5103*858ea5e5SAndroid Build Coastguard Worker * long bpf_for_each_map_elem(struct bpf_map *map, void *callback_fn, void *callback_ctx, u64 flags) 5104*858ea5e5SAndroid Build Coastguard Worker * Description 5105*858ea5e5SAndroid Build Coastguard Worker * For each element in **map**, call **callback_fn** function with 5106*858ea5e5SAndroid Build Coastguard Worker * **map**, **callback_ctx** and other map-specific parameters. 5107*858ea5e5SAndroid Build Coastguard Worker * The **callback_fn** should be a static function and 5108*858ea5e5SAndroid Build Coastguard Worker * the **callback_ctx** should be a pointer to the stack. 5109*858ea5e5SAndroid Build Coastguard Worker * The **flags** is used to control certain aspects of the helper. 5110*858ea5e5SAndroid Build Coastguard Worker * Currently, the **flags** must be 0. 5111*858ea5e5SAndroid Build Coastguard Worker * 5112*858ea5e5SAndroid Build Coastguard Worker * The following are a list of supported map types and their 5113*858ea5e5SAndroid Build Coastguard Worker * respective expected callback signatures: 5114*858ea5e5SAndroid Build Coastguard Worker * 5115*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_HASH, BPF_MAP_TYPE_PERCPU_HASH, 5116*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_LRU_HASH, BPF_MAP_TYPE_LRU_PERCPU_HASH, 5117*858ea5e5SAndroid Build Coastguard Worker * BPF_MAP_TYPE_ARRAY, BPF_MAP_TYPE_PERCPU_ARRAY 5118*858ea5e5SAndroid Build Coastguard Worker * 5119*858ea5e5SAndroid Build Coastguard Worker * long (\*callback_fn)(struct bpf_map \*map, const void \*key, void \*value, void \*ctx); 5120*858ea5e5SAndroid Build Coastguard Worker * 5121*858ea5e5SAndroid Build Coastguard Worker * For per_cpu maps, the map_value is the value on the cpu where the 5122*858ea5e5SAndroid Build Coastguard Worker * bpf_prog is running. 5123*858ea5e5SAndroid Build Coastguard Worker * 5124*858ea5e5SAndroid Build Coastguard Worker * If **callback_fn** return 0, the helper will continue to the next 5125*858ea5e5SAndroid Build Coastguard Worker * element. If return value is 1, the helper will skip the rest of 5126*858ea5e5SAndroid Build Coastguard Worker * elements and return. Other return values are not used now. 5127*858ea5e5SAndroid Build Coastguard Worker * 5128*858ea5e5SAndroid Build Coastguard Worker * Return 5129*858ea5e5SAndroid Build Coastguard Worker * The number of traversed map elements for success, **-EINVAL** for 5130*858ea5e5SAndroid Build Coastguard Worker * invalid **flags**. 5131*858ea5e5SAndroid Build Coastguard Worker * 5132*858ea5e5SAndroid Build Coastguard Worker * long bpf_snprintf(char *str, u32 str_size, const char *fmt, u64 *data, u32 data_len) 5133*858ea5e5SAndroid Build Coastguard Worker * Description 5134*858ea5e5SAndroid Build Coastguard Worker * Outputs a string into the **str** buffer of size **str_size** 5135*858ea5e5SAndroid Build Coastguard Worker * based on a format string stored in a read-only map pointed by 5136*858ea5e5SAndroid Build Coastguard Worker * **fmt**. 5137*858ea5e5SAndroid Build Coastguard Worker * 5138*858ea5e5SAndroid Build Coastguard Worker * Each format specifier in **fmt** corresponds to one u64 element 5139*858ea5e5SAndroid Build Coastguard Worker * in the **data** array. For strings and pointers where pointees 5140*858ea5e5SAndroid Build Coastguard Worker * are accessed, only the pointer values are stored in the *data* 5141*858ea5e5SAndroid Build Coastguard Worker * array. The *data_len* is the size of *data* in bytes - must be 5142*858ea5e5SAndroid Build Coastguard Worker * a multiple of 8. 5143*858ea5e5SAndroid Build Coastguard Worker * 5144*858ea5e5SAndroid Build Coastguard Worker * Formats **%s** and **%p{i,I}{4,6}** require to read kernel 5145*858ea5e5SAndroid Build Coastguard Worker * memory. Reading kernel memory may fail due to either invalid 5146*858ea5e5SAndroid Build Coastguard Worker * address or valid address but requiring a major memory fault. If 5147*858ea5e5SAndroid Build Coastguard Worker * reading kernel memory fails, the string for **%s** will be an 5148*858ea5e5SAndroid Build Coastguard Worker * empty string, and the ip address for **%p{i,I}{4,6}** will be 0. 5149*858ea5e5SAndroid Build Coastguard Worker * Not returning error to bpf program is consistent with what 5150*858ea5e5SAndroid Build Coastguard Worker * **bpf_trace_printk**\ () does for now. 5151*858ea5e5SAndroid Build Coastguard Worker * 5152*858ea5e5SAndroid Build Coastguard Worker * Return 5153*858ea5e5SAndroid Build Coastguard Worker * The strictly positive length of the formatted string, including 5154*858ea5e5SAndroid Build Coastguard Worker * the trailing zero character. If the return value is greater than 5155*858ea5e5SAndroid Build Coastguard Worker * **str_size**, **str** contains a truncated string, guaranteed to 5156*858ea5e5SAndroid Build Coastguard Worker * be zero-terminated except when **str_size** is 0. 5157*858ea5e5SAndroid Build Coastguard Worker * 5158*858ea5e5SAndroid Build Coastguard Worker * Or **-EBUSY** if the per-CPU memory copy buffer is busy. 5159*858ea5e5SAndroid Build Coastguard Worker * 5160*858ea5e5SAndroid Build Coastguard Worker * long bpf_sys_bpf(u32 cmd, void *attr, u32 attr_size) 5161*858ea5e5SAndroid Build Coastguard Worker * Description 5162*858ea5e5SAndroid Build Coastguard Worker * Execute bpf syscall with given arguments. 5163*858ea5e5SAndroid Build Coastguard Worker * Return 5164*858ea5e5SAndroid Build Coastguard Worker * A syscall result. 5165*858ea5e5SAndroid Build Coastguard Worker * 5166*858ea5e5SAndroid Build Coastguard Worker * long bpf_btf_find_by_name_kind(char *name, int name_sz, u32 kind, int flags) 5167*858ea5e5SAndroid Build Coastguard Worker * Description 5168*858ea5e5SAndroid Build Coastguard Worker * Find BTF type with given name and kind in vmlinux BTF or in module's BTFs. 5169*858ea5e5SAndroid Build Coastguard Worker * Return 5170*858ea5e5SAndroid Build Coastguard Worker * Returns btf_id and btf_obj_fd in lower and upper 32 bits. 5171*858ea5e5SAndroid Build Coastguard Worker * 5172*858ea5e5SAndroid Build Coastguard Worker * long bpf_sys_close(u32 fd) 5173*858ea5e5SAndroid Build Coastguard Worker * Description 5174*858ea5e5SAndroid Build Coastguard Worker * Execute close syscall for given FD. 5175*858ea5e5SAndroid Build Coastguard Worker * Return 5176*858ea5e5SAndroid Build Coastguard Worker * A syscall result. 5177*858ea5e5SAndroid Build Coastguard Worker * 5178*858ea5e5SAndroid Build Coastguard Worker * long bpf_timer_init(struct bpf_timer *timer, struct bpf_map *map, u64 flags) 5179*858ea5e5SAndroid Build Coastguard Worker * Description 5180*858ea5e5SAndroid Build Coastguard Worker * Initialize the timer. 5181*858ea5e5SAndroid Build Coastguard Worker * First 4 bits of *flags* specify clockid. 5182*858ea5e5SAndroid Build Coastguard Worker * Only CLOCK_MONOTONIC, CLOCK_REALTIME, CLOCK_BOOTTIME are allowed. 5183*858ea5e5SAndroid Build Coastguard Worker * All other bits of *flags* are reserved. 5184*858ea5e5SAndroid Build Coastguard Worker * The verifier will reject the program if *timer* is not from 5185*858ea5e5SAndroid Build Coastguard Worker * the same *map*. 5186*858ea5e5SAndroid Build Coastguard Worker * Return 5187*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5188*858ea5e5SAndroid Build Coastguard Worker * **-EBUSY** if *timer* is already initialized. 5189*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if invalid *flags* are passed. 5190*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if *timer* is in a map that doesn't have any user references. 5191*858ea5e5SAndroid Build Coastguard Worker * The user space should either hold a file descriptor to a map with timers 5192*858ea5e5SAndroid Build Coastguard Worker * or pin such map in bpffs. When map is unpinned or file descriptor is 5193*858ea5e5SAndroid Build Coastguard Worker * closed all timers in the map will be cancelled and freed. 5194*858ea5e5SAndroid Build Coastguard Worker * 5195*858ea5e5SAndroid Build Coastguard Worker * long bpf_timer_set_callback(struct bpf_timer *timer, void *callback_fn) 5196*858ea5e5SAndroid Build Coastguard Worker * Description 5197*858ea5e5SAndroid Build Coastguard Worker * Configure the timer to call *callback_fn* static function. 5198*858ea5e5SAndroid Build Coastguard Worker * Return 5199*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5200*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *timer* was not initialized with bpf_timer_init() earlier. 5201*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if *timer* is in a map that doesn't have any user references. 5202*858ea5e5SAndroid Build Coastguard Worker * The user space should either hold a file descriptor to a map with timers 5203*858ea5e5SAndroid Build Coastguard Worker * or pin such map in bpffs. When map is unpinned or file descriptor is 5204*858ea5e5SAndroid Build Coastguard Worker * closed all timers in the map will be cancelled and freed. 5205*858ea5e5SAndroid Build Coastguard Worker * 5206*858ea5e5SAndroid Build Coastguard Worker * long bpf_timer_start(struct bpf_timer *timer, u64 nsecs, u64 flags) 5207*858ea5e5SAndroid Build Coastguard Worker * Description 5208*858ea5e5SAndroid Build Coastguard Worker * Set timer expiration N nanoseconds from the current time. The 5209*858ea5e5SAndroid Build Coastguard Worker * configured callback will be invoked in soft irq context on some cpu 5210*858ea5e5SAndroid Build Coastguard Worker * and will not repeat unless another bpf_timer_start() is made. 5211*858ea5e5SAndroid Build Coastguard Worker * In such case the next invocation can migrate to a different cpu. 5212*858ea5e5SAndroid Build Coastguard Worker * Since struct bpf_timer is a field inside map element the map 5213*858ea5e5SAndroid Build Coastguard Worker * owns the timer. The bpf_timer_set_callback() will increment refcnt 5214*858ea5e5SAndroid Build Coastguard Worker * of BPF program to make sure that callback_fn code stays valid. 5215*858ea5e5SAndroid Build Coastguard Worker * When user space reference to a map reaches zero all timers 5216*858ea5e5SAndroid Build Coastguard Worker * in a map are cancelled and corresponding program's refcnts are 5217*858ea5e5SAndroid Build Coastguard Worker * decremented. This is done to make sure that Ctrl-C of a user 5218*858ea5e5SAndroid Build Coastguard Worker * process doesn't leave any timers running. If map is pinned in 5219*858ea5e5SAndroid Build Coastguard Worker * bpffs the callback_fn can re-arm itself indefinitely. 5220*858ea5e5SAndroid Build Coastguard Worker * bpf_map_update/delete_elem() helpers and user space sys_bpf commands 5221*858ea5e5SAndroid Build Coastguard Worker * cancel and free the timer in the given map element. 5222*858ea5e5SAndroid Build Coastguard Worker * The map can contain timers that invoke callback_fn-s from different 5223*858ea5e5SAndroid Build Coastguard Worker * programs. The same callback_fn can serve different timers from 5224*858ea5e5SAndroid Build Coastguard Worker * different maps if key/value layout matches across maps. 5225*858ea5e5SAndroid Build Coastguard Worker * Every bpf_timer_set_callback() can have different callback_fn. 5226*858ea5e5SAndroid Build Coastguard Worker * 5227*858ea5e5SAndroid Build Coastguard Worker * *flags* can be one of: 5228*858ea5e5SAndroid Build Coastguard Worker * 5229*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_TIMER_ABS** 5230*858ea5e5SAndroid Build Coastguard Worker * Start the timer in absolute expire value instead of the 5231*858ea5e5SAndroid Build Coastguard Worker * default relative one. 5232*858ea5e5SAndroid Build Coastguard Worker * **BPF_F_TIMER_CPU_PIN** 5233*858ea5e5SAndroid Build Coastguard Worker * Timer will be pinned to the CPU of the caller. 5234*858ea5e5SAndroid Build Coastguard Worker * 5235*858ea5e5SAndroid Build Coastguard Worker * Return 5236*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5237*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *timer* was not initialized with bpf_timer_init() earlier 5238*858ea5e5SAndroid Build Coastguard Worker * or invalid *flags* are passed. 5239*858ea5e5SAndroid Build Coastguard Worker * 5240*858ea5e5SAndroid Build Coastguard Worker * long bpf_timer_cancel(struct bpf_timer *timer) 5241*858ea5e5SAndroid Build Coastguard Worker * Description 5242*858ea5e5SAndroid Build Coastguard Worker * Cancel the timer and wait for callback_fn to finish if it was running. 5243*858ea5e5SAndroid Build Coastguard Worker * Return 5244*858ea5e5SAndroid Build Coastguard Worker * 0 if the timer was not active. 5245*858ea5e5SAndroid Build Coastguard Worker * 1 if the timer was active. 5246*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *timer* was not initialized with bpf_timer_init() earlier. 5247*858ea5e5SAndroid Build Coastguard Worker * **-EDEADLK** if callback_fn tried to call bpf_timer_cancel() on its 5248*858ea5e5SAndroid Build Coastguard Worker * own timer which would have led to a deadlock otherwise. 5249*858ea5e5SAndroid Build Coastguard Worker * 5250*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_func_ip(void *ctx) 5251*858ea5e5SAndroid Build Coastguard Worker * Description 5252*858ea5e5SAndroid Build Coastguard Worker * Get address of the traced function (for tracing and kprobe programs). 5253*858ea5e5SAndroid Build Coastguard Worker * 5254*858ea5e5SAndroid Build Coastguard Worker * When called for kprobe program attached as uprobe it returns 5255*858ea5e5SAndroid Build Coastguard Worker * probe address for both entry and return uprobe. 5256*858ea5e5SAndroid Build Coastguard Worker * 5257*858ea5e5SAndroid Build Coastguard Worker * Return 5258*858ea5e5SAndroid Build Coastguard Worker * Address of the traced function for kprobe. 5259*858ea5e5SAndroid Build Coastguard Worker * 0 for kprobes placed within the function (not at the entry). 5260*858ea5e5SAndroid Build Coastguard Worker * Address of the probe for uprobe and return uprobe. 5261*858ea5e5SAndroid Build Coastguard Worker * 5262*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_get_attach_cookie(void *ctx) 5263*858ea5e5SAndroid Build Coastguard Worker * Description 5264*858ea5e5SAndroid Build Coastguard Worker * Get bpf_cookie value provided (optionally) during the program 5265*858ea5e5SAndroid Build Coastguard Worker * attachment. It might be different for each individual 5266*858ea5e5SAndroid Build Coastguard Worker * attachment, even if BPF program itself is the same. 5267*858ea5e5SAndroid Build Coastguard Worker * Expects BPF program context *ctx* as a first argument. 5268*858ea5e5SAndroid Build Coastguard Worker * 5269*858ea5e5SAndroid Build Coastguard Worker * Supported for the following program types: 5270*858ea5e5SAndroid Build Coastguard Worker * - kprobe/uprobe; 5271*858ea5e5SAndroid Build Coastguard Worker * - tracepoint; 5272*858ea5e5SAndroid Build Coastguard Worker * - perf_event. 5273*858ea5e5SAndroid Build Coastguard Worker * Return 5274*858ea5e5SAndroid Build Coastguard Worker * Value specified by user at BPF link creation/attachment time 5275*858ea5e5SAndroid Build Coastguard Worker * or 0, if it was not specified. 5276*858ea5e5SAndroid Build Coastguard Worker * 5277*858ea5e5SAndroid Build Coastguard Worker * long bpf_task_pt_regs(struct task_struct *task) 5278*858ea5e5SAndroid Build Coastguard Worker * Description 5279*858ea5e5SAndroid Build Coastguard Worker * Get the struct pt_regs associated with **task**. 5280*858ea5e5SAndroid Build Coastguard Worker * Return 5281*858ea5e5SAndroid Build Coastguard Worker * A pointer to struct pt_regs. 5282*858ea5e5SAndroid Build Coastguard Worker * 5283*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_branch_snapshot(void *entries, u32 size, u64 flags) 5284*858ea5e5SAndroid Build Coastguard Worker * Description 5285*858ea5e5SAndroid Build Coastguard Worker * Get branch trace from hardware engines like Intel LBR. The 5286*858ea5e5SAndroid Build Coastguard Worker * hardware engine is stopped shortly after the helper is 5287*858ea5e5SAndroid Build Coastguard Worker * called. Therefore, the user need to filter branch entries 5288*858ea5e5SAndroid Build Coastguard Worker * based on the actual use case. To capture branch trace 5289*858ea5e5SAndroid Build Coastguard Worker * before the trigger point of the BPF program, the helper 5290*858ea5e5SAndroid Build Coastguard Worker * should be called at the beginning of the BPF program. 5291*858ea5e5SAndroid Build Coastguard Worker * 5292*858ea5e5SAndroid Build Coastguard Worker * The data is stored as struct perf_branch_entry into output 5293*858ea5e5SAndroid Build Coastguard Worker * buffer *entries*. *size* is the size of *entries* in bytes. 5294*858ea5e5SAndroid Build Coastguard Worker * *flags* is reserved for now and must be zero. 5295*858ea5e5SAndroid Build Coastguard Worker * 5296*858ea5e5SAndroid Build Coastguard Worker * Return 5297*858ea5e5SAndroid Build Coastguard Worker * On success, number of bytes written to *buf*. On error, a 5298*858ea5e5SAndroid Build Coastguard Worker * negative value. 5299*858ea5e5SAndroid Build Coastguard Worker * 5300*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *flags* is not zero. 5301*858ea5e5SAndroid Build Coastguard Worker * 5302*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if architecture does not support branch records. 5303*858ea5e5SAndroid Build Coastguard Worker * 5304*858ea5e5SAndroid Build Coastguard Worker * long bpf_trace_vprintk(const char *fmt, u32 fmt_size, const void *data, u32 data_len) 5305*858ea5e5SAndroid Build Coastguard Worker * Description 5306*858ea5e5SAndroid Build Coastguard Worker * Behaves like **bpf_trace_printk**\ () helper, but takes an array of u64 5307*858ea5e5SAndroid Build Coastguard Worker * to format and can handle more format args as a result. 5308*858ea5e5SAndroid Build Coastguard Worker * 5309*858ea5e5SAndroid Build Coastguard Worker * Arguments are to be used as in **bpf_seq_printf**\ () helper. 5310*858ea5e5SAndroid Build Coastguard Worker * Return 5311*858ea5e5SAndroid Build Coastguard Worker * The number of bytes written to the buffer, or a negative error 5312*858ea5e5SAndroid Build Coastguard Worker * in case of failure. 5313*858ea5e5SAndroid Build Coastguard Worker * 5314*858ea5e5SAndroid Build Coastguard Worker * struct unix_sock *bpf_skc_to_unix_sock(void *sk) 5315*858ea5e5SAndroid Build Coastguard Worker * Description 5316*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *unix_sock* pointer. 5317*858ea5e5SAndroid Build Coastguard Worker * Return 5318*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 5319*858ea5e5SAndroid Build Coastguard Worker * 5320*858ea5e5SAndroid Build Coastguard Worker * long bpf_kallsyms_lookup_name(const char *name, int name_sz, int flags, u64 *res) 5321*858ea5e5SAndroid Build Coastguard Worker * Description 5322*858ea5e5SAndroid Build Coastguard Worker * Get the address of a kernel symbol, returned in *res*. *res* is 5323*858ea5e5SAndroid Build Coastguard Worker * set to 0 if the symbol is not found. 5324*858ea5e5SAndroid Build Coastguard Worker * Return 5325*858ea5e5SAndroid Build Coastguard Worker * On success, zero. On error, a negative value. 5326*858ea5e5SAndroid Build Coastguard Worker * 5327*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *flags* is not zero. 5328*858ea5e5SAndroid Build Coastguard Worker * 5329*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if string *name* is not the same size as *name_sz*. 5330*858ea5e5SAndroid Build Coastguard Worker * 5331*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if symbol is not found. 5332*858ea5e5SAndroid Build Coastguard Worker * 5333*858ea5e5SAndroid Build Coastguard Worker * **-EPERM** if caller does not have permission to obtain kernel address. 5334*858ea5e5SAndroid Build Coastguard Worker * 5335*858ea5e5SAndroid Build Coastguard Worker * long bpf_find_vma(struct task_struct *task, u64 addr, void *callback_fn, void *callback_ctx, u64 flags) 5336*858ea5e5SAndroid Build Coastguard Worker * Description 5337*858ea5e5SAndroid Build Coastguard Worker * Find vma of *task* that contains *addr*, call *callback_fn* 5338*858ea5e5SAndroid Build Coastguard Worker * function with *task*, *vma*, and *callback_ctx*. 5339*858ea5e5SAndroid Build Coastguard Worker * The *callback_fn* should be a static function and 5340*858ea5e5SAndroid Build Coastguard Worker * the *callback_ctx* should be a pointer to the stack. 5341*858ea5e5SAndroid Build Coastguard Worker * The *flags* is used to control certain aspects of the helper. 5342*858ea5e5SAndroid Build Coastguard Worker * Currently, the *flags* must be 0. 5343*858ea5e5SAndroid Build Coastguard Worker * 5344*858ea5e5SAndroid Build Coastguard Worker * The expected callback signature is 5345*858ea5e5SAndroid Build Coastguard Worker * 5346*858ea5e5SAndroid Build Coastguard Worker * long (\*callback_fn)(struct task_struct \*task, struct vm_area_struct \*vma, void \*callback_ctx); 5347*858ea5e5SAndroid Build Coastguard Worker * 5348*858ea5e5SAndroid Build Coastguard Worker * Return 5349*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5350*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if *task->mm* is NULL, or no vma contains *addr*. 5351*858ea5e5SAndroid Build Coastguard Worker * **-EBUSY** if failed to try lock mmap_lock. 5352*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** for invalid **flags**. 5353*858ea5e5SAndroid Build Coastguard Worker * 5354*858ea5e5SAndroid Build Coastguard Worker * long bpf_loop(u32 nr_loops, void *callback_fn, void *callback_ctx, u64 flags) 5355*858ea5e5SAndroid Build Coastguard Worker * Description 5356*858ea5e5SAndroid Build Coastguard Worker * For **nr_loops**, call **callback_fn** function 5357*858ea5e5SAndroid Build Coastguard Worker * with **callback_ctx** as the context parameter. 5358*858ea5e5SAndroid Build Coastguard Worker * The **callback_fn** should be a static function and 5359*858ea5e5SAndroid Build Coastguard Worker * the **callback_ctx** should be a pointer to the stack. 5360*858ea5e5SAndroid Build Coastguard Worker * The **flags** is used to control certain aspects of the helper. 5361*858ea5e5SAndroid Build Coastguard Worker * Currently, the **flags** must be 0. Currently, nr_loops is 5362*858ea5e5SAndroid Build Coastguard Worker * limited to 1 << 23 (~8 million) loops. 5363*858ea5e5SAndroid Build Coastguard Worker * 5364*858ea5e5SAndroid Build Coastguard Worker * long (\*callback_fn)(u32 index, void \*ctx); 5365*858ea5e5SAndroid Build Coastguard Worker * 5366*858ea5e5SAndroid Build Coastguard Worker * where **index** is the current index in the loop. The index 5367*858ea5e5SAndroid Build Coastguard Worker * is zero-indexed. 5368*858ea5e5SAndroid Build Coastguard Worker * 5369*858ea5e5SAndroid Build Coastguard Worker * If **callback_fn** returns 0, the helper will continue to the next 5370*858ea5e5SAndroid Build Coastguard Worker * loop. If return value is 1, the helper will skip the rest of 5371*858ea5e5SAndroid Build Coastguard Worker * the loops and return. Other return values are not used now, 5372*858ea5e5SAndroid Build Coastguard Worker * and will be rejected by the verifier. 5373*858ea5e5SAndroid Build Coastguard Worker * 5374*858ea5e5SAndroid Build Coastguard Worker * Return 5375*858ea5e5SAndroid Build Coastguard Worker * The number of loops performed, **-EINVAL** for invalid **flags**, 5376*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if **nr_loops** exceeds the maximum number of loops. 5377*858ea5e5SAndroid Build Coastguard Worker * 5378*858ea5e5SAndroid Build Coastguard Worker * long bpf_strncmp(const char *s1, u32 s1_sz, const char *s2) 5379*858ea5e5SAndroid Build Coastguard Worker * Description 5380*858ea5e5SAndroid Build Coastguard Worker * Do strncmp() between **s1** and **s2**. **s1** doesn't need 5381*858ea5e5SAndroid Build Coastguard Worker * to be null-terminated and **s1_sz** is the maximum storage 5382*858ea5e5SAndroid Build Coastguard Worker * size of **s1**. **s2** must be a read-only string. 5383*858ea5e5SAndroid Build Coastguard Worker * Return 5384*858ea5e5SAndroid Build Coastguard Worker * An integer less than, equal to, or greater than zero 5385*858ea5e5SAndroid Build Coastguard Worker * if the first **s1_sz** bytes of **s1** is found to be 5386*858ea5e5SAndroid Build Coastguard Worker * less than, to match, or be greater than **s2**. 5387*858ea5e5SAndroid Build Coastguard Worker * 5388*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_func_arg(void *ctx, u32 n, u64 *value) 5389*858ea5e5SAndroid Build Coastguard Worker * Description 5390*858ea5e5SAndroid Build Coastguard Worker * Get **n**-th argument register (zero based) of the traced function (for tracing programs) 5391*858ea5e5SAndroid Build Coastguard Worker * returned in **value**. 5392*858ea5e5SAndroid Build Coastguard Worker * 5393*858ea5e5SAndroid Build Coastguard Worker * Return 5394*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5395*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if n >= argument register count of traced function. 5396*858ea5e5SAndroid Build Coastguard Worker * 5397*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_func_ret(void *ctx, u64 *value) 5398*858ea5e5SAndroid Build Coastguard Worker * Description 5399*858ea5e5SAndroid Build Coastguard Worker * Get return value of the traced function (for tracing programs) 5400*858ea5e5SAndroid Build Coastguard Worker * in **value**. 5401*858ea5e5SAndroid Build Coastguard Worker * 5402*858ea5e5SAndroid Build Coastguard Worker * Return 5403*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5404*858ea5e5SAndroid Build Coastguard Worker * **-EOPNOTSUPP** for tracing programs other than BPF_TRACE_FEXIT or BPF_MODIFY_RETURN. 5405*858ea5e5SAndroid Build Coastguard Worker * 5406*858ea5e5SAndroid Build Coastguard Worker * long bpf_get_func_arg_cnt(void *ctx) 5407*858ea5e5SAndroid Build Coastguard Worker * Description 5408*858ea5e5SAndroid Build Coastguard Worker * Get number of registers of the traced function (for tracing programs) where 5409*858ea5e5SAndroid Build Coastguard Worker * function arguments are stored in these registers. 5410*858ea5e5SAndroid Build Coastguard Worker * 5411*858ea5e5SAndroid Build Coastguard Worker * Return 5412*858ea5e5SAndroid Build Coastguard Worker * The number of argument registers of the traced function. 5413*858ea5e5SAndroid Build Coastguard Worker * 5414*858ea5e5SAndroid Build Coastguard Worker * int bpf_get_retval(void) 5415*858ea5e5SAndroid Build Coastguard Worker * Description 5416*858ea5e5SAndroid Build Coastguard Worker * Get the BPF program's return value that will be returned to the upper layers. 5417*858ea5e5SAndroid Build Coastguard Worker * 5418*858ea5e5SAndroid Build Coastguard Worker * This helper is currently supported by cgroup programs and only by the hooks 5419*858ea5e5SAndroid Build Coastguard Worker * where BPF program's return value is returned to the userspace via errno. 5420*858ea5e5SAndroid Build Coastguard Worker * Return 5421*858ea5e5SAndroid Build Coastguard Worker * The BPF program's return value. 5422*858ea5e5SAndroid Build Coastguard Worker * 5423*858ea5e5SAndroid Build Coastguard Worker * int bpf_set_retval(int retval) 5424*858ea5e5SAndroid Build Coastguard Worker * Description 5425*858ea5e5SAndroid Build Coastguard Worker * Set the BPF program's return value that will be returned to the upper layers. 5426*858ea5e5SAndroid Build Coastguard Worker * 5427*858ea5e5SAndroid Build Coastguard Worker * This helper is currently supported by cgroup programs and only by the hooks 5428*858ea5e5SAndroid Build Coastguard Worker * where BPF program's return value is returned to the userspace via errno. 5429*858ea5e5SAndroid Build Coastguard Worker * 5430*858ea5e5SAndroid Build Coastguard Worker * Note that there is the following corner case where the program exports an error 5431*858ea5e5SAndroid Build Coastguard Worker * via bpf_set_retval but signals success via 'return 1': 5432*858ea5e5SAndroid Build Coastguard Worker * 5433*858ea5e5SAndroid Build Coastguard Worker * bpf_set_retval(-EPERM); 5434*858ea5e5SAndroid Build Coastguard Worker * return 1; 5435*858ea5e5SAndroid Build Coastguard Worker * 5436*858ea5e5SAndroid Build Coastguard Worker * In this case, the BPF program's return value will use helper's -EPERM. This 5437*858ea5e5SAndroid Build Coastguard Worker * still holds true for cgroup/bind{4,6} which supports extra 'return 3' success case. 5438*858ea5e5SAndroid Build Coastguard Worker * 5439*858ea5e5SAndroid Build Coastguard Worker * Return 5440*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 5441*858ea5e5SAndroid Build Coastguard Worker * 5442*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_xdp_get_buff_len(struct xdp_buff *xdp_md) 5443*858ea5e5SAndroid Build Coastguard Worker * Description 5444*858ea5e5SAndroid Build Coastguard Worker * Get the total size of a given xdp buff (linear and paged area) 5445*858ea5e5SAndroid Build Coastguard Worker * Return 5446*858ea5e5SAndroid Build Coastguard Worker * The total size of a given xdp buffer. 5447*858ea5e5SAndroid Build Coastguard Worker * 5448*858ea5e5SAndroid Build Coastguard Worker * long bpf_xdp_load_bytes(struct xdp_buff *xdp_md, u32 offset, void *buf, u32 len) 5449*858ea5e5SAndroid Build Coastguard Worker * Description 5450*858ea5e5SAndroid Build Coastguard Worker * This helper is provided as an easy way to load data from a 5451*858ea5e5SAndroid Build Coastguard Worker * xdp buffer. It can be used to load *len* bytes from *offset* from 5452*858ea5e5SAndroid Build Coastguard Worker * the frame associated to *xdp_md*, into the buffer pointed by 5453*858ea5e5SAndroid Build Coastguard Worker * *buf*. 5454*858ea5e5SAndroid Build Coastguard Worker * Return 5455*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 5456*858ea5e5SAndroid Build Coastguard Worker * 5457*858ea5e5SAndroid Build Coastguard Worker * long bpf_xdp_store_bytes(struct xdp_buff *xdp_md, u32 offset, void *buf, u32 len) 5458*858ea5e5SAndroid Build Coastguard Worker * Description 5459*858ea5e5SAndroid Build Coastguard Worker * Store *len* bytes from buffer *buf* into the frame 5460*858ea5e5SAndroid Build Coastguard Worker * associated to *xdp_md*, at *offset*. 5461*858ea5e5SAndroid Build Coastguard Worker * Return 5462*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 5463*858ea5e5SAndroid Build Coastguard Worker * 5464*858ea5e5SAndroid Build Coastguard Worker * long bpf_copy_from_user_task(void *dst, u32 size, const void *user_ptr, struct task_struct *tsk, u64 flags) 5465*858ea5e5SAndroid Build Coastguard Worker * Description 5466*858ea5e5SAndroid Build Coastguard Worker * Read *size* bytes from user space address *user_ptr* in *tsk*'s 5467*858ea5e5SAndroid Build Coastguard Worker * address space, and stores the data in *dst*. *flags* is not 5468*858ea5e5SAndroid Build Coastguard Worker * used yet and is provided for future extensibility. This helper 5469*858ea5e5SAndroid Build Coastguard Worker * can only be used by sleepable programs. 5470*858ea5e5SAndroid Build Coastguard Worker * Return 5471*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. On error 5472*858ea5e5SAndroid Build Coastguard Worker * *dst* buffer is zeroed out. 5473*858ea5e5SAndroid Build Coastguard Worker * 5474*858ea5e5SAndroid Build Coastguard Worker * long bpf_skb_set_tstamp(struct sk_buff *skb, u64 tstamp, u32 tstamp_type) 5475*858ea5e5SAndroid Build Coastguard Worker * Description 5476*858ea5e5SAndroid Build Coastguard Worker * Change the __sk_buff->tstamp_type to *tstamp_type* 5477*858ea5e5SAndroid Build Coastguard Worker * and set *tstamp* to the __sk_buff->tstamp together. 5478*858ea5e5SAndroid Build Coastguard Worker * 5479*858ea5e5SAndroid Build Coastguard Worker * If there is no need to change the __sk_buff->tstamp_type, 5480*858ea5e5SAndroid Build Coastguard Worker * the tstamp value can be directly written to __sk_buff->tstamp 5481*858ea5e5SAndroid Build Coastguard Worker * instead. 5482*858ea5e5SAndroid Build Coastguard Worker * 5483*858ea5e5SAndroid Build Coastguard Worker * BPF_SKB_TSTAMP_DELIVERY_MONO is the only tstamp that 5484*858ea5e5SAndroid Build Coastguard Worker * will be kept during bpf_redirect_*(). A non zero 5485*858ea5e5SAndroid Build Coastguard Worker * *tstamp* must be used with the BPF_SKB_TSTAMP_DELIVERY_MONO 5486*858ea5e5SAndroid Build Coastguard Worker * *tstamp_type*. 5487*858ea5e5SAndroid Build Coastguard Worker * 5488*858ea5e5SAndroid Build Coastguard Worker * A BPF_SKB_TSTAMP_UNSPEC *tstamp_type* can only be used 5489*858ea5e5SAndroid Build Coastguard Worker * with a zero *tstamp*. 5490*858ea5e5SAndroid Build Coastguard Worker * 5491*858ea5e5SAndroid Build Coastguard Worker * Only IPv4 and IPv6 skb->protocol are supported. 5492*858ea5e5SAndroid Build Coastguard Worker * 5493*858ea5e5SAndroid Build Coastguard Worker * This function is most useful when it needs to set a 5494*858ea5e5SAndroid Build Coastguard Worker * mono delivery time to __sk_buff->tstamp and then 5495*858ea5e5SAndroid Build Coastguard Worker * bpf_redirect_*() to the egress of an iface. For example, 5496*858ea5e5SAndroid Build Coastguard Worker * changing the (rcv) timestamp in __sk_buff->tstamp at 5497*858ea5e5SAndroid Build Coastguard Worker * ingress to a mono delivery time and then bpf_redirect_*() 5498*858ea5e5SAndroid Build Coastguard Worker * to sch_fq@phy-dev. 5499*858ea5e5SAndroid Build Coastguard Worker * Return 5500*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5501*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** for invalid input 5502*858ea5e5SAndroid Build Coastguard Worker * **-EOPNOTSUPP** for unsupported protocol 5503*858ea5e5SAndroid Build Coastguard Worker * 5504*858ea5e5SAndroid Build Coastguard Worker * long bpf_ima_file_hash(struct file *file, void *dst, u32 size) 5505*858ea5e5SAndroid Build Coastguard Worker * Description 5506*858ea5e5SAndroid Build Coastguard Worker * Returns a calculated IMA hash of the *file*. 5507*858ea5e5SAndroid Build Coastguard Worker * If the hash is larger than *size*, then only *size* 5508*858ea5e5SAndroid Build Coastguard Worker * bytes will be copied to *dst* 5509*858ea5e5SAndroid Build Coastguard Worker * Return 5510*858ea5e5SAndroid Build Coastguard Worker * The **hash_algo** is returned on success, 5511*858ea5e5SAndroid Build Coastguard Worker * **-EOPNOTSUP** if the hash calculation failed or **-EINVAL** if 5512*858ea5e5SAndroid Build Coastguard Worker * invalid arguments are passed. 5513*858ea5e5SAndroid Build Coastguard Worker * 5514*858ea5e5SAndroid Build Coastguard Worker * void *bpf_kptr_xchg(void *map_value, void *ptr) 5515*858ea5e5SAndroid Build Coastguard Worker * Description 5516*858ea5e5SAndroid Build Coastguard Worker * Exchange kptr at pointer *map_value* with *ptr*, and return the 5517*858ea5e5SAndroid Build Coastguard Worker * old value. *ptr* can be NULL, otherwise it must be a referenced 5518*858ea5e5SAndroid Build Coastguard Worker * pointer which will be released when this helper is called. 5519*858ea5e5SAndroid Build Coastguard Worker * Return 5520*858ea5e5SAndroid Build Coastguard Worker * The old value of kptr (which can be NULL). The returned pointer 5521*858ea5e5SAndroid Build Coastguard Worker * if not NULL, is a reference which must be released using its 5522*858ea5e5SAndroid Build Coastguard Worker * corresponding release function, or moved into a BPF map before 5523*858ea5e5SAndroid Build Coastguard Worker * program exit. 5524*858ea5e5SAndroid Build Coastguard Worker * 5525*858ea5e5SAndroid Build Coastguard Worker * void *bpf_map_lookup_percpu_elem(struct bpf_map *map, const void *key, u32 cpu) 5526*858ea5e5SAndroid Build Coastguard Worker * Description 5527*858ea5e5SAndroid Build Coastguard Worker * Perform a lookup in *percpu map* for an entry associated to 5528*858ea5e5SAndroid Build Coastguard Worker * *key* on *cpu*. 5529*858ea5e5SAndroid Build Coastguard Worker * Return 5530*858ea5e5SAndroid Build Coastguard Worker * Map value associated to *key* on *cpu*, or **NULL** if no entry 5531*858ea5e5SAndroid Build Coastguard Worker * was found or *cpu* is invalid. 5532*858ea5e5SAndroid Build Coastguard Worker * 5533*858ea5e5SAndroid Build Coastguard Worker * struct mptcp_sock *bpf_skc_to_mptcp_sock(void *sk) 5534*858ea5e5SAndroid Build Coastguard Worker * Description 5535*858ea5e5SAndroid Build Coastguard Worker * Dynamically cast a *sk* pointer to a *mptcp_sock* pointer. 5536*858ea5e5SAndroid Build Coastguard Worker * Return 5537*858ea5e5SAndroid Build Coastguard Worker * *sk* if casting is valid, or **NULL** otherwise. 5538*858ea5e5SAndroid Build Coastguard Worker * 5539*858ea5e5SAndroid Build Coastguard Worker * long bpf_dynptr_from_mem(void *data, u32 size, u64 flags, struct bpf_dynptr *ptr) 5540*858ea5e5SAndroid Build Coastguard Worker * Description 5541*858ea5e5SAndroid Build Coastguard Worker * Get a dynptr to local memory *data*. 5542*858ea5e5SAndroid Build Coastguard Worker * 5543*858ea5e5SAndroid Build Coastguard Worker * *data* must be a ptr to a map value. 5544*858ea5e5SAndroid Build Coastguard Worker * The maximum *size* supported is DYNPTR_MAX_SIZE. 5545*858ea5e5SAndroid Build Coastguard Worker * *flags* is currently unused. 5546*858ea5e5SAndroid Build Coastguard Worker * Return 5547*858ea5e5SAndroid Build Coastguard Worker * 0 on success, -E2BIG if the size exceeds DYNPTR_MAX_SIZE, 5548*858ea5e5SAndroid Build Coastguard Worker * -EINVAL if flags is not 0. 5549*858ea5e5SAndroid Build Coastguard Worker * 5550*858ea5e5SAndroid Build Coastguard Worker * long bpf_ringbuf_reserve_dynptr(void *ringbuf, u32 size, u64 flags, struct bpf_dynptr *ptr) 5551*858ea5e5SAndroid Build Coastguard Worker * Description 5552*858ea5e5SAndroid Build Coastguard Worker * Reserve *size* bytes of payload in a ring buffer *ringbuf* 5553*858ea5e5SAndroid Build Coastguard Worker * through the dynptr interface. *flags* must be 0. 5554*858ea5e5SAndroid Build Coastguard Worker * 5555*858ea5e5SAndroid Build Coastguard Worker * Please note that a corresponding bpf_ringbuf_submit_dynptr or 5556*858ea5e5SAndroid Build Coastguard Worker * bpf_ringbuf_discard_dynptr must be called on *ptr*, even if the 5557*858ea5e5SAndroid Build Coastguard Worker * reservation fails. This is enforced by the verifier. 5558*858ea5e5SAndroid Build Coastguard Worker * Return 5559*858ea5e5SAndroid Build Coastguard Worker * 0 on success, or a negative error in case of failure. 5560*858ea5e5SAndroid Build Coastguard Worker * 5561*858ea5e5SAndroid Build Coastguard Worker * void bpf_ringbuf_submit_dynptr(struct bpf_dynptr *ptr, u64 flags) 5562*858ea5e5SAndroid Build Coastguard Worker * Description 5563*858ea5e5SAndroid Build Coastguard Worker * Submit reserved ring buffer sample, pointed to by *data*, 5564*858ea5e5SAndroid Build Coastguard Worker * through the dynptr interface. This is a no-op if the dynptr is 5565*858ea5e5SAndroid Build Coastguard Worker * invalid/null. 5566*858ea5e5SAndroid Build Coastguard Worker * 5567*858ea5e5SAndroid Build Coastguard Worker * For more information on *flags*, please see 5568*858ea5e5SAndroid Build Coastguard Worker * 'bpf_ringbuf_submit'. 5569*858ea5e5SAndroid Build Coastguard Worker * Return 5570*858ea5e5SAndroid Build Coastguard Worker * Nothing. Always succeeds. 5571*858ea5e5SAndroid Build Coastguard Worker * 5572*858ea5e5SAndroid Build Coastguard Worker * void bpf_ringbuf_discard_dynptr(struct bpf_dynptr *ptr, u64 flags) 5573*858ea5e5SAndroid Build Coastguard Worker * Description 5574*858ea5e5SAndroid Build Coastguard Worker * Discard reserved ring buffer sample through the dynptr 5575*858ea5e5SAndroid Build Coastguard Worker * interface. This is a no-op if the dynptr is invalid/null. 5576*858ea5e5SAndroid Build Coastguard Worker * 5577*858ea5e5SAndroid Build Coastguard Worker * For more information on *flags*, please see 5578*858ea5e5SAndroid Build Coastguard Worker * 'bpf_ringbuf_discard'. 5579*858ea5e5SAndroid Build Coastguard Worker * Return 5580*858ea5e5SAndroid Build Coastguard Worker * Nothing. Always succeeds. 5581*858ea5e5SAndroid Build Coastguard Worker * 5582*858ea5e5SAndroid Build Coastguard Worker * long bpf_dynptr_read(void *dst, u32 len, const struct bpf_dynptr *src, u32 offset, u64 flags) 5583*858ea5e5SAndroid Build Coastguard Worker * Description 5584*858ea5e5SAndroid Build Coastguard Worker * Read *len* bytes from *src* into *dst*, starting from *offset* 5585*858ea5e5SAndroid Build Coastguard Worker * into *src*. 5586*858ea5e5SAndroid Build Coastguard Worker * *flags* is currently unused. 5587*858ea5e5SAndroid Build Coastguard Worker * Return 5588*858ea5e5SAndroid Build Coastguard Worker * 0 on success, -E2BIG if *offset* + *len* exceeds the length 5589*858ea5e5SAndroid Build Coastguard Worker * of *src*'s data, -EINVAL if *src* is an invalid dynptr or if 5590*858ea5e5SAndroid Build Coastguard Worker * *flags* is not 0. 5591*858ea5e5SAndroid Build Coastguard Worker * 5592*858ea5e5SAndroid Build Coastguard Worker * long bpf_dynptr_write(const struct bpf_dynptr *dst, u32 offset, void *src, u32 len, u64 flags) 5593*858ea5e5SAndroid Build Coastguard Worker * Description 5594*858ea5e5SAndroid Build Coastguard Worker * Write *len* bytes from *src* into *dst*, starting from *offset* 5595*858ea5e5SAndroid Build Coastguard Worker * into *dst*. 5596*858ea5e5SAndroid Build Coastguard Worker * 5597*858ea5e5SAndroid Build Coastguard Worker * *flags* must be 0 except for skb-type dynptrs. 5598*858ea5e5SAndroid Build Coastguard Worker * 5599*858ea5e5SAndroid Build Coastguard Worker * For skb-type dynptrs: 5600*858ea5e5SAndroid Build Coastguard Worker * * All data slices of the dynptr are automatically 5601*858ea5e5SAndroid Build Coastguard Worker * invalidated after **bpf_dynptr_write**\ (). This is 5602*858ea5e5SAndroid Build Coastguard Worker * because writing may pull the skb and change the 5603*858ea5e5SAndroid Build Coastguard Worker * underlying packet buffer. 5604*858ea5e5SAndroid Build Coastguard Worker * 5605*858ea5e5SAndroid Build Coastguard Worker * * For *flags*, please see the flags accepted by 5606*858ea5e5SAndroid Build Coastguard Worker * **bpf_skb_store_bytes**\ (). 5607*858ea5e5SAndroid Build Coastguard Worker * Return 5608*858ea5e5SAndroid Build Coastguard Worker * 0 on success, -E2BIG if *offset* + *len* exceeds the length 5609*858ea5e5SAndroid Build Coastguard Worker * of *dst*'s data, -EINVAL if *dst* is an invalid dynptr or if *dst* 5610*858ea5e5SAndroid Build Coastguard Worker * is a read-only dynptr or if *flags* is not correct. For skb-type dynptrs, 5611*858ea5e5SAndroid Build Coastguard Worker * other errors correspond to errors returned by **bpf_skb_store_bytes**\ (). 5612*858ea5e5SAndroid Build Coastguard Worker * 5613*858ea5e5SAndroid Build Coastguard Worker * void *bpf_dynptr_data(const struct bpf_dynptr *ptr, u32 offset, u32 len) 5614*858ea5e5SAndroid Build Coastguard Worker * Description 5615*858ea5e5SAndroid Build Coastguard Worker * Get a pointer to the underlying dynptr data. 5616*858ea5e5SAndroid Build Coastguard Worker * 5617*858ea5e5SAndroid Build Coastguard Worker * *len* must be a statically known value. The returned data slice 5618*858ea5e5SAndroid Build Coastguard Worker * is invalidated whenever the dynptr is invalidated. 5619*858ea5e5SAndroid Build Coastguard Worker * 5620*858ea5e5SAndroid Build Coastguard Worker * skb and xdp type dynptrs may not use bpf_dynptr_data. They should 5621*858ea5e5SAndroid Build Coastguard Worker * instead use bpf_dynptr_slice and bpf_dynptr_slice_rdwr. 5622*858ea5e5SAndroid Build Coastguard Worker * Return 5623*858ea5e5SAndroid Build Coastguard Worker * Pointer to the underlying dynptr data, NULL if the dynptr is 5624*858ea5e5SAndroid Build Coastguard Worker * read-only, if the dynptr is invalid, or if the offset and length 5625*858ea5e5SAndroid Build Coastguard Worker * is out of bounds. 5626*858ea5e5SAndroid Build Coastguard Worker * 5627*858ea5e5SAndroid Build Coastguard Worker * s64 bpf_tcp_raw_gen_syncookie_ipv4(struct iphdr *iph, struct tcphdr *th, u32 th_len) 5628*858ea5e5SAndroid Build Coastguard Worker * Description 5629*858ea5e5SAndroid Build Coastguard Worker * Try to issue a SYN cookie for the packet with corresponding 5630*858ea5e5SAndroid Build Coastguard Worker * IPv4/TCP headers, *iph* and *th*, without depending on a 5631*858ea5e5SAndroid Build Coastguard Worker * listening socket. 5632*858ea5e5SAndroid Build Coastguard Worker * 5633*858ea5e5SAndroid Build Coastguard Worker * *iph* points to the IPv4 header. 5634*858ea5e5SAndroid Build Coastguard Worker * 5635*858ea5e5SAndroid Build Coastguard Worker * *th* points to the start of the TCP header, while *th_len* 5636*858ea5e5SAndroid Build Coastguard Worker * contains the length of the TCP header (at least 5637*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (**struct tcphdr**)). 5638*858ea5e5SAndroid Build Coastguard Worker * Return 5639*858ea5e5SAndroid Build Coastguard Worker * On success, lower 32 bits hold the generated SYN cookie in 5640*858ea5e5SAndroid Build Coastguard Worker * followed by 16 bits which hold the MSS value for that cookie, 5641*858ea5e5SAndroid Build Coastguard Worker * and the top 16 bits are unused. 5642*858ea5e5SAndroid Build Coastguard Worker * 5643*858ea5e5SAndroid Build Coastguard Worker * On failure, the returned value is one of the following: 5644*858ea5e5SAndroid Build Coastguard Worker * 5645*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *th_len* is invalid. 5646*858ea5e5SAndroid Build Coastguard Worker * 5647*858ea5e5SAndroid Build Coastguard Worker * s64 bpf_tcp_raw_gen_syncookie_ipv6(struct ipv6hdr *iph, struct tcphdr *th, u32 th_len) 5648*858ea5e5SAndroid Build Coastguard Worker * Description 5649*858ea5e5SAndroid Build Coastguard Worker * Try to issue a SYN cookie for the packet with corresponding 5650*858ea5e5SAndroid Build Coastguard Worker * IPv6/TCP headers, *iph* and *th*, without depending on a 5651*858ea5e5SAndroid Build Coastguard Worker * listening socket. 5652*858ea5e5SAndroid Build Coastguard Worker * 5653*858ea5e5SAndroid Build Coastguard Worker * *iph* points to the IPv6 header. 5654*858ea5e5SAndroid Build Coastguard Worker * 5655*858ea5e5SAndroid Build Coastguard Worker * *th* points to the start of the TCP header, while *th_len* 5656*858ea5e5SAndroid Build Coastguard Worker * contains the length of the TCP header (at least 5657*858ea5e5SAndroid Build Coastguard Worker * **sizeof**\ (**struct tcphdr**)). 5658*858ea5e5SAndroid Build Coastguard Worker * Return 5659*858ea5e5SAndroid Build Coastguard Worker * On success, lower 32 bits hold the generated SYN cookie in 5660*858ea5e5SAndroid Build Coastguard Worker * followed by 16 bits which hold the MSS value for that cookie, 5661*858ea5e5SAndroid Build Coastguard Worker * and the top 16 bits are unused. 5662*858ea5e5SAndroid Build Coastguard Worker * 5663*858ea5e5SAndroid Build Coastguard Worker * On failure, the returned value is one of the following: 5664*858ea5e5SAndroid Build Coastguard Worker * 5665*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if *th_len* is invalid. 5666*858ea5e5SAndroid Build Coastguard Worker * 5667*858ea5e5SAndroid Build Coastguard Worker * **-EPROTONOSUPPORT** if CONFIG_IPV6 is not builtin. 5668*858ea5e5SAndroid Build Coastguard Worker * 5669*858ea5e5SAndroid Build Coastguard Worker * long bpf_tcp_raw_check_syncookie_ipv4(struct iphdr *iph, struct tcphdr *th) 5670*858ea5e5SAndroid Build Coastguard Worker * Description 5671*858ea5e5SAndroid Build Coastguard Worker * Check whether *iph* and *th* contain a valid SYN cookie ACK 5672*858ea5e5SAndroid Build Coastguard Worker * without depending on a listening socket. 5673*858ea5e5SAndroid Build Coastguard Worker * 5674*858ea5e5SAndroid Build Coastguard Worker * *iph* points to the IPv4 header. 5675*858ea5e5SAndroid Build Coastguard Worker * 5676*858ea5e5SAndroid Build Coastguard Worker * *th* points to the TCP header. 5677*858ea5e5SAndroid Build Coastguard Worker * Return 5678*858ea5e5SAndroid Build Coastguard Worker * 0 if *iph* and *th* are a valid SYN cookie ACK. 5679*858ea5e5SAndroid Build Coastguard Worker * 5680*858ea5e5SAndroid Build Coastguard Worker * On failure, the returned value is one of the following: 5681*858ea5e5SAndroid Build Coastguard Worker * 5682*858ea5e5SAndroid Build Coastguard Worker * **-EACCES** if the SYN cookie is not valid. 5683*858ea5e5SAndroid Build Coastguard Worker * 5684*858ea5e5SAndroid Build Coastguard Worker * long bpf_tcp_raw_check_syncookie_ipv6(struct ipv6hdr *iph, struct tcphdr *th) 5685*858ea5e5SAndroid Build Coastguard Worker * Description 5686*858ea5e5SAndroid Build Coastguard Worker * Check whether *iph* and *th* contain a valid SYN cookie ACK 5687*858ea5e5SAndroid Build Coastguard Worker * without depending on a listening socket. 5688*858ea5e5SAndroid Build Coastguard Worker * 5689*858ea5e5SAndroid Build Coastguard Worker * *iph* points to the IPv6 header. 5690*858ea5e5SAndroid Build Coastguard Worker * 5691*858ea5e5SAndroid Build Coastguard Worker * *th* points to the TCP header. 5692*858ea5e5SAndroid Build Coastguard Worker * Return 5693*858ea5e5SAndroid Build Coastguard Worker * 0 if *iph* and *th* are a valid SYN cookie ACK. 5694*858ea5e5SAndroid Build Coastguard Worker * 5695*858ea5e5SAndroid Build Coastguard Worker * On failure, the returned value is one of the following: 5696*858ea5e5SAndroid Build Coastguard Worker * 5697*858ea5e5SAndroid Build Coastguard Worker * **-EACCES** if the SYN cookie is not valid. 5698*858ea5e5SAndroid Build Coastguard Worker * 5699*858ea5e5SAndroid Build Coastguard Worker * **-EPROTONOSUPPORT** if CONFIG_IPV6 is not builtin. 5700*858ea5e5SAndroid Build Coastguard Worker * 5701*858ea5e5SAndroid Build Coastguard Worker * u64 bpf_ktime_get_tai_ns(void) 5702*858ea5e5SAndroid Build Coastguard Worker * Description 5703*858ea5e5SAndroid Build Coastguard Worker * A nonsettable system-wide clock derived from wall-clock time but 5704*858ea5e5SAndroid Build Coastguard Worker * ignoring leap seconds. This clock does not experience 5705*858ea5e5SAndroid Build Coastguard Worker * discontinuities and backwards jumps caused by NTP inserting leap 5706*858ea5e5SAndroid Build Coastguard Worker * seconds as CLOCK_REALTIME does. 5707*858ea5e5SAndroid Build Coastguard Worker * 5708*858ea5e5SAndroid Build Coastguard Worker * See: **clock_gettime**\ (**CLOCK_TAI**) 5709*858ea5e5SAndroid Build Coastguard Worker * Return 5710*858ea5e5SAndroid Build Coastguard Worker * Current *ktime*. 5711*858ea5e5SAndroid Build Coastguard Worker * 5712*858ea5e5SAndroid Build Coastguard Worker * long bpf_user_ringbuf_drain(struct bpf_map *map, void *callback_fn, void *ctx, u64 flags) 5713*858ea5e5SAndroid Build Coastguard Worker * Description 5714*858ea5e5SAndroid Build Coastguard Worker * Drain samples from the specified user ring buffer, and invoke 5715*858ea5e5SAndroid Build Coastguard Worker * the provided callback for each such sample: 5716*858ea5e5SAndroid Build Coastguard Worker * 5717*858ea5e5SAndroid Build Coastguard Worker * long (\*callback_fn)(const struct bpf_dynptr \*dynptr, void \*ctx); 5718*858ea5e5SAndroid Build Coastguard Worker * 5719*858ea5e5SAndroid Build Coastguard Worker * If **callback_fn** returns 0, the helper will continue to try 5720*858ea5e5SAndroid Build Coastguard Worker * and drain the next sample, up to a maximum of 5721*858ea5e5SAndroid Build Coastguard Worker * BPF_MAX_USER_RINGBUF_SAMPLES samples. If the return value is 1, 5722*858ea5e5SAndroid Build Coastguard Worker * the helper will skip the rest of the samples and return. Other 5723*858ea5e5SAndroid Build Coastguard Worker * return values are not used now, and will be rejected by the 5724*858ea5e5SAndroid Build Coastguard Worker * verifier. 5725*858ea5e5SAndroid Build Coastguard Worker * Return 5726*858ea5e5SAndroid Build Coastguard Worker * The number of drained samples if no error was encountered while 5727*858ea5e5SAndroid Build Coastguard Worker * draining samples, or 0 if no samples were present in the ring 5728*858ea5e5SAndroid Build Coastguard Worker * buffer. If a user-space producer was epoll-waiting on this map, 5729*858ea5e5SAndroid Build Coastguard Worker * and at least one sample was drained, they will receive an event 5730*858ea5e5SAndroid Build Coastguard Worker * notification notifying them of available space in the ring 5731*858ea5e5SAndroid Build Coastguard Worker * buffer. If the BPF_RB_NO_WAKEUP flag is passed to this 5732*858ea5e5SAndroid Build Coastguard Worker * function, no wakeup notification will be sent. If the 5733*858ea5e5SAndroid Build Coastguard Worker * BPF_RB_FORCE_WAKEUP flag is passed, a wakeup notification will 5734*858ea5e5SAndroid Build Coastguard Worker * be sent even if no sample was drained. 5735*858ea5e5SAndroid Build Coastguard Worker * 5736*858ea5e5SAndroid Build Coastguard Worker * On failure, the returned value is one of the following: 5737*858ea5e5SAndroid Build Coastguard Worker * 5738*858ea5e5SAndroid Build Coastguard Worker * **-EBUSY** if the ring buffer is contended, and another calling 5739*858ea5e5SAndroid Build Coastguard Worker * context was concurrently draining the ring buffer. 5740*858ea5e5SAndroid Build Coastguard Worker * 5741*858ea5e5SAndroid Build Coastguard Worker * **-EINVAL** if user-space is not properly tracking the ring 5742*858ea5e5SAndroid Build Coastguard Worker * buffer due to the producer position not being aligned to 8 5743*858ea5e5SAndroid Build Coastguard Worker * bytes, a sample not being aligned to 8 bytes, or the producer 5744*858ea5e5SAndroid Build Coastguard Worker * position not matching the advertised length of a sample. 5745*858ea5e5SAndroid Build Coastguard Worker * 5746*858ea5e5SAndroid Build Coastguard Worker * **-E2BIG** if user-space has tried to publish a sample which is 5747*858ea5e5SAndroid Build Coastguard Worker * larger than the size of the ring buffer, or which cannot fit 5748*858ea5e5SAndroid Build Coastguard Worker * within a struct bpf_dynptr. 5749*858ea5e5SAndroid Build Coastguard Worker * 5750*858ea5e5SAndroid Build Coastguard Worker * void *bpf_cgrp_storage_get(struct bpf_map *map, struct cgroup *cgroup, void *value, u64 flags) 5751*858ea5e5SAndroid Build Coastguard Worker * Description 5752*858ea5e5SAndroid Build Coastguard Worker * Get a bpf_local_storage from the *cgroup*. 5753*858ea5e5SAndroid Build Coastguard Worker * 5754*858ea5e5SAndroid Build Coastguard Worker * Logically, it could be thought of as getting the value from 5755*858ea5e5SAndroid Build Coastguard Worker * a *map* with *cgroup* as the **key**. From this 5756*858ea5e5SAndroid Build Coastguard Worker * perspective, the usage is not much different from 5757*858ea5e5SAndroid Build Coastguard Worker * **bpf_map_lookup_elem**\ (*map*, **&**\ *cgroup*) except this 5758*858ea5e5SAndroid Build Coastguard Worker * helper enforces the key must be a cgroup struct and the map must also 5759*858ea5e5SAndroid Build Coastguard Worker * be a **BPF_MAP_TYPE_CGRP_STORAGE**. 5760*858ea5e5SAndroid Build Coastguard Worker * 5761*858ea5e5SAndroid Build Coastguard Worker * In reality, the local-storage value is embedded directly inside of the 5762*858ea5e5SAndroid Build Coastguard Worker * *cgroup* object itself, rather than being located in the 5763*858ea5e5SAndroid Build Coastguard Worker * **BPF_MAP_TYPE_CGRP_STORAGE** map. When the local-storage value is 5764*858ea5e5SAndroid Build Coastguard Worker * queried for some *map* on a *cgroup* object, the kernel will perform an 5765*858ea5e5SAndroid Build Coastguard Worker * O(n) iteration over all of the live local-storage values for that 5766*858ea5e5SAndroid Build Coastguard Worker * *cgroup* object until the local-storage value for the *map* is found. 5767*858ea5e5SAndroid Build Coastguard Worker * 5768*858ea5e5SAndroid Build Coastguard Worker * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be 5769*858ea5e5SAndroid Build Coastguard Worker * used such that a new bpf_local_storage will be 5770*858ea5e5SAndroid Build Coastguard Worker * created if one does not exist. *value* can be used 5771*858ea5e5SAndroid Build Coastguard Worker * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify 5772*858ea5e5SAndroid Build Coastguard Worker * the initial value of a bpf_local_storage. If *value* is 5773*858ea5e5SAndroid Build Coastguard Worker * **NULL**, the new bpf_local_storage will be zero initialized. 5774*858ea5e5SAndroid Build Coastguard Worker * Return 5775*858ea5e5SAndroid Build Coastguard Worker * A bpf_local_storage pointer is returned on success. 5776*858ea5e5SAndroid Build Coastguard Worker * 5777*858ea5e5SAndroid Build Coastguard Worker * **NULL** if not found or there was an error in adding 5778*858ea5e5SAndroid Build Coastguard Worker * a new bpf_local_storage. 5779*858ea5e5SAndroid Build Coastguard Worker * 5780*858ea5e5SAndroid Build Coastguard Worker * long bpf_cgrp_storage_delete(struct bpf_map *map, struct cgroup *cgroup) 5781*858ea5e5SAndroid Build Coastguard Worker * Description 5782*858ea5e5SAndroid Build Coastguard Worker * Delete a bpf_local_storage from a *cgroup*. 5783*858ea5e5SAndroid Build Coastguard Worker * Return 5784*858ea5e5SAndroid Build Coastguard Worker * 0 on success. 5785*858ea5e5SAndroid Build Coastguard Worker * 5786*858ea5e5SAndroid Build Coastguard Worker * **-ENOENT** if the bpf_local_storage cannot be found. 5787*858ea5e5SAndroid Build Coastguard Worker */ 5788*858ea5e5SAndroid Build Coastguard Worker #define ___BPF_FUNC_MAPPER(FN, ctx...) \ 5789*858ea5e5SAndroid Build Coastguard Worker FN(unspec, 0, ##ctx) \ 5790*858ea5e5SAndroid Build Coastguard Worker FN(map_lookup_elem, 1, ##ctx) \ 5791*858ea5e5SAndroid Build Coastguard Worker FN(map_update_elem, 2, ##ctx) \ 5792*858ea5e5SAndroid Build Coastguard Worker FN(map_delete_elem, 3, ##ctx) \ 5793*858ea5e5SAndroid Build Coastguard Worker FN(probe_read, 4, ##ctx) \ 5794*858ea5e5SAndroid Build Coastguard Worker FN(ktime_get_ns, 5, ##ctx) \ 5795*858ea5e5SAndroid Build Coastguard Worker FN(trace_printk, 6, ##ctx) \ 5796*858ea5e5SAndroid Build Coastguard Worker FN(get_prandom_u32, 7, ##ctx) \ 5797*858ea5e5SAndroid Build Coastguard Worker FN(get_smp_processor_id, 8, ##ctx) \ 5798*858ea5e5SAndroid Build Coastguard Worker FN(skb_store_bytes, 9, ##ctx) \ 5799*858ea5e5SAndroid Build Coastguard Worker FN(l3_csum_replace, 10, ##ctx) \ 5800*858ea5e5SAndroid Build Coastguard Worker FN(l4_csum_replace, 11, ##ctx) \ 5801*858ea5e5SAndroid Build Coastguard Worker FN(tail_call, 12, ##ctx) \ 5802*858ea5e5SAndroid Build Coastguard Worker FN(clone_redirect, 13, ##ctx) \ 5803*858ea5e5SAndroid Build Coastguard Worker FN(get_current_pid_tgid, 14, ##ctx) \ 5804*858ea5e5SAndroid Build Coastguard Worker FN(get_current_uid_gid, 15, ##ctx) \ 5805*858ea5e5SAndroid Build Coastguard Worker FN(get_current_comm, 16, ##ctx) \ 5806*858ea5e5SAndroid Build Coastguard Worker FN(get_cgroup_classid, 17, ##ctx) \ 5807*858ea5e5SAndroid Build Coastguard Worker FN(skb_vlan_push, 18, ##ctx) \ 5808*858ea5e5SAndroid Build Coastguard Worker FN(skb_vlan_pop, 19, ##ctx) \ 5809*858ea5e5SAndroid Build Coastguard Worker FN(skb_get_tunnel_key, 20, ##ctx) \ 5810*858ea5e5SAndroid Build Coastguard Worker FN(skb_set_tunnel_key, 21, ##ctx) \ 5811*858ea5e5SAndroid Build Coastguard Worker FN(perf_event_read, 22, ##ctx) \ 5812*858ea5e5SAndroid Build Coastguard Worker FN(redirect, 23, ##ctx) \ 5813*858ea5e5SAndroid Build Coastguard Worker FN(get_route_realm, 24, ##ctx) \ 5814*858ea5e5SAndroid Build Coastguard Worker FN(perf_event_output, 25, ##ctx) \ 5815*858ea5e5SAndroid Build Coastguard Worker FN(skb_load_bytes, 26, ##ctx) \ 5816*858ea5e5SAndroid Build Coastguard Worker FN(get_stackid, 27, ##ctx) \ 5817*858ea5e5SAndroid Build Coastguard Worker FN(csum_diff, 28, ##ctx) \ 5818*858ea5e5SAndroid Build Coastguard Worker FN(skb_get_tunnel_opt, 29, ##ctx) \ 5819*858ea5e5SAndroid Build Coastguard Worker FN(skb_set_tunnel_opt, 30, ##ctx) \ 5820*858ea5e5SAndroid Build Coastguard Worker FN(skb_change_proto, 31, ##ctx) \ 5821*858ea5e5SAndroid Build Coastguard Worker FN(skb_change_type, 32, ##ctx) \ 5822*858ea5e5SAndroid Build Coastguard Worker FN(skb_under_cgroup, 33, ##ctx) \ 5823*858ea5e5SAndroid Build Coastguard Worker FN(get_hash_recalc, 34, ##ctx) \ 5824*858ea5e5SAndroid Build Coastguard Worker FN(get_current_task, 35, ##ctx) \ 5825*858ea5e5SAndroid Build Coastguard Worker FN(probe_write_user, 36, ##ctx) \ 5826*858ea5e5SAndroid Build Coastguard Worker FN(current_task_under_cgroup, 37, ##ctx) \ 5827*858ea5e5SAndroid Build Coastguard Worker FN(skb_change_tail, 38, ##ctx) \ 5828*858ea5e5SAndroid Build Coastguard Worker FN(skb_pull_data, 39, ##ctx) \ 5829*858ea5e5SAndroid Build Coastguard Worker FN(csum_update, 40, ##ctx) \ 5830*858ea5e5SAndroid Build Coastguard Worker FN(set_hash_invalid, 41, ##ctx) \ 5831*858ea5e5SAndroid Build Coastguard Worker FN(get_numa_node_id, 42, ##ctx) \ 5832*858ea5e5SAndroid Build Coastguard Worker FN(skb_change_head, 43, ##ctx) \ 5833*858ea5e5SAndroid Build Coastguard Worker FN(xdp_adjust_head, 44, ##ctx) \ 5834*858ea5e5SAndroid Build Coastguard Worker FN(probe_read_str, 45, ##ctx) \ 5835*858ea5e5SAndroid Build Coastguard Worker FN(get_socket_cookie, 46, ##ctx) \ 5836*858ea5e5SAndroid Build Coastguard Worker FN(get_socket_uid, 47, ##ctx) \ 5837*858ea5e5SAndroid Build Coastguard Worker FN(set_hash, 48, ##ctx) \ 5838*858ea5e5SAndroid Build Coastguard Worker FN(setsockopt, 49, ##ctx) \ 5839*858ea5e5SAndroid Build Coastguard Worker FN(skb_adjust_room, 50, ##ctx) \ 5840*858ea5e5SAndroid Build Coastguard Worker FN(redirect_map, 51, ##ctx) \ 5841*858ea5e5SAndroid Build Coastguard Worker FN(sk_redirect_map, 52, ##ctx) \ 5842*858ea5e5SAndroid Build Coastguard Worker FN(sock_map_update, 53, ##ctx) \ 5843*858ea5e5SAndroid Build Coastguard Worker FN(xdp_adjust_meta, 54, ##ctx) \ 5844*858ea5e5SAndroid Build Coastguard Worker FN(perf_event_read_value, 55, ##ctx) \ 5845*858ea5e5SAndroid Build Coastguard Worker FN(perf_prog_read_value, 56, ##ctx) \ 5846*858ea5e5SAndroid Build Coastguard Worker FN(getsockopt, 57, ##ctx) \ 5847*858ea5e5SAndroid Build Coastguard Worker FN(override_return, 58, ##ctx) \ 5848*858ea5e5SAndroid Build Coastguard Worker FN(sock_ops_cb_flags_set, 59, ##ctx) \ 5849*858ea5e5SAndroid Build Coastguard Worker FN(msg_redirect_map, 60, ##ctx) \ 5850*858ea5e5SAndroid Build Coastguard Worker FN(msg_apply_bytes, 61, ##ctx) \ 5851*858ea5e5SAndroid Build Coastguard Worker FN(msg_cork_bytes, 62, ##ctx) \ 5852*858ea5e5SAndroid Build Coastguard Worker FN(msg_pull_data, 63, ##ctx) \ 5853*858ea5e5SAndroid Build Coastguard Worker FN(bind, 64, ##ctx) \ 5854*858ea5e5SAndroid Build Coastguard Worker FN(xdp_adjust_tail, 65, ##ctx) \ 5855*858ea5e5SAndroid Build Coastguard Worker FN(skb_get_xfrm_state, 66, ##ctx) \ 5856*858ea5e5SAndroid Build Coastguard Worker FN(get_stack, 67, ##ctx) \ 5857*858ea5e5SAndroid Build Coastguard Worker FN(skb_load_bytes_relative, 68, ##ctx) \ 5858*858ea5e5SAndroid Build Coastguard Worker FN(fib_lookup, 69, ##ctx) \ 5859*858ea5e5SAndroid Build Coastguard Worker FN(sock_hash_update, 70, ##ctx) \ 5860*858ea5e5SAndroid Build Coastguard Worker FN(msg_redirect_hash, 71, ##ctx) \ 5861*858ea5e5SAndroid Build Coastguard Worker FN(sk_redirect_hash, 72, ##ctx) \ 5862*858ea5e5SAndroid Build Coastguard Worker FN(lwt_push_encap, 73, ##ctx) \ 5863*858ea5e5SAndroid Build Coastguard Worker FN(lwt_seg6_store_bytes, 74, ##ctx) \ 5864*858ea5e5SAndroid Build Coastguard Worker FN(lwt_seg6_adjust_srh, 75, ##ctx) \ 5865*858ea5e5SAndroid Build Coastguard Worker FN(lwt_seg6_action, 76, ##ctx) \ 5866*858ea5e5SAndroid Build Coastguard Worker FN(rc_repeat, 77, ##ctx) \ 5867*858ea5e5SAndroid Build Coastguard Worker FN(rc_keydown, 78, ##ctx) \ 5868*858ea5e5SAndroid Build Coastguard Worker FN(skb_cgroup_id, 79, ##ctx) \ 5869*858ea5e5SAndroid Build Coastguard Worker FN(get_current_cgroup_id, 80, ##ctx) \ 5870*858ea5e5SAndroid Build Coastguard Worker FN(get_local_storage, 81, ##ctx) \ 5871*858ea5e5SAndroid Build Coastguard Worker FN(sk_select_reuseport, 82, ##ctx) \ 5872*858ea5e5SAndroid Build Coastguard Worker FN(skb_ancestor_cgroup_id, 83, ##ctx) \ 5873*858ea5e5SAndroid Build Coastguard Worker FN(sk_lookup_tcp, 84, ##ctx) \ 5874*858ea5e5SAndroid Build Coastguard Worker FN(sk_lookup_udp, 85, ##ctx) \ 5875*858ea5e5SAndroid Build Coastguard Worker FN(sk_release, 86, ##ctx) \ 5876*858ea5e5SAndroid Build Coastguard Worker FN(map_push_elem, 87, ##ctx) \ 5877*858ea5e5SAndroid Build Coastguard Worker FN(map_pop_elem, 88, ##ctx) \ 5878*858ea5e5SAndroid Build Coastguard Worker FN(map_peek_elem, 89, ##ctx) \ 5879*858ea5e5SAndroid Build Coastguard Worker FN(msg_push_data, 90, ##ctx) \ 5880*858ea5e5SAndroid Build Coastguard Worker FN(msg_pop_data, 91, ##ctx) \ 5881*858ea5e5SAndroid Build Coastguard Worker FN(rc_pointer_rel, 92, ##ctx) \ 5882*858ea5e5SAndroid Build Coastguard Worker FN(spin_lock, 93, ##ctx) \ 5883*858ea5e5SAndroid Build Coastguard Worker FN(spin_unlock, 94, ##ctx) \ 5884*858ea5e5SAndroid Build Coastguard Worker FN(sk_fullsock, 95, ##ctx) \ 5885*858ea5e5SAndroid Build Coastguard Worker FN(tcp_sock, 96, ##ctx) \ 5886*858ea5e5SAndroid Build Coastguard Worker FN(skb_ecn_set_ce, 97, ##ctx) \ 5887*858ea5e5SAndroid Build Coastguard Worker FN(get_listener_sock, 98, ##ctx) \ 5888*858ea5e5SAndroid Build Coastguard Worker FN(skc_lookup_tcp, 99, ##ctx) \ 5889*858ea5e5SAndroid Build Coastguard Worker FN(tcp_check_syncookie, 100, ##ctx) \ 5890*858ea5e5SAndroid Build Coastguard Worker FN(sysctl_get_name, 101, ##ctx) \ 5891*858ea5e5SAndroid Build Coastguard Worker FN(sysctl_get_current_value, 102, ##ctx) \ 5892*858ea5e5SAndroid Build Coastguard Worker FN(sysctl_get_new_value, 103, ##ctx) \ 5893*858ea5e5SAndroid Build Coastguard Worker FN(sysctl_set_new_value, 104, ##ctx) \ 5894*858ea5e5SAndroid Build Coastguard Worker FN(strtol, 105, ##ctx) \ 5895*858ea5e5SAndroid Build Coastguard Worker FN(strtoul, 106, ##ctx) \ 5896*858ea5e5SAndroid Build Coastguard Worker FN(sk_storage_get, 107, ##ctx) \ 5897*858ea5e5SAndroid Build Coastguard Worker FN(sk_storage_delete, 108, ##ctx) \ 5898*858ea5e5SAndroid Build Coastguard Worker FN(send_signal, 109, ##ctx) \ 5899*858ea5e5SAndroid Build Coastguard Worker FN(tcp_gen_syncookie, 110, ##ctx) \ 5900*858ea5e5SAndroid Build Coastguard Worker FN(skb_output, 111, ##ctx) \ 5901*858ea5e5SAndroid Build Coastguard Worker FN(probe_read_user, 112, ##ctx) \ 5902*858ea5e5SAndroid Build Coastguard Worker FN(probe_read_kernel, 113, ##ctx) \ 5903*858ea5e5SAndroid Build Coastguard Worker FN(probe_read_user_str, 114, ##ctx) \ 5904*858ea5e5SAndroid Build Coastguard Worker FN(probe_read_kernel_str, 115, ##ctx) \ 5905*858ea5e5SAndroid Build Coastguard Worker FN(tcp_send_ack, 116, ##ctx) \ 5906*858ea5e5SAndroid Build Coastguard Worker FN(send_signal_thread, 117, ##ctx) \ 5907*858ea5e5SAndroid Build Coastguard Worker FN(jiffies64, 118, ##ctx) \ 5908*858ea5e5SAndroid Build Coastguard Worker FN(read_branch_records, 119, ##ctx) \ 5909*858ea5e5SAndroid Build Coastguard Worker FN(get_ns_current_pid_tgid, 120, ##ctx) \ 5910*858ea5e5SAndroid Build Coastguard Worker FN(xdp_output, 121, ##ctx) \ 5911*858ea5e5SAndroid Build Coastguard Worker FN(get_netns_cookie, 122, ##ctx) \ 5912*858ea5e5SAndroid Build Coastguard Worker FN(get_current_ancestor_cgroup_id, 123, ##ctx) \ 5913*858ea5e5SAndroid Build Coastguard Worker FN(sk_assign, 124, ##ctx) \ 5914*858ea5e5SAndroid Build Coastguard Worker FN(ktime_get_boot_ns, 125, ##ctx) \ 5915*858ea5e5SAndroid Build Coastguard Worker FN(seq_printf, 126, ##ctx) \ 5916*858ea5e5SAndroid Build Coastguard Worker FN(seq_write, 127, ##ctx) \ 5917*858ea5e5SAndroid Build Coastguard Worker FN(sk_cgroup_id, 128, ##ctx) \ 5918*858ea5e5SAndroid Build Coastguard Worker FN(sk_ancestor_cgroup_id, 129, ##ctx) \ 5919*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_output, 130, ##ctx) \ 5920*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_reserve, 131, ##ctx) \ 5921*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_submit, 132, ##ctx) \ 5922*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_discard, 133, ##ctx) \ 5923*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_query, 134, ##ctx) \ 5924*858ea5e5SAndroid Build Coastguard Worker FN(csum_level, 135, ##ctx) \ 5925*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_tcp6_sock, 136, ##ctx) \ 5926*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_tcp_sock, 137, ##ctx) \ 5927*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_tcp_timewait_sock, 138, ##ctx) \ 5928*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_tcp_request_sock, 139, ##ctx) \ 5929*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_udp6_sock, 140, ##ctx) \ 5930*858ea5e5SAndroid Build Coastguard Worker FN(get_task_stack, 141, ##ctx) \ 5931*858ea5e5SAndroid Build Coastguard Worker FN(load_hdr_opt, 142, ##ctx) \ 5932*858ea5e5SAndroid Build Coastguard Worker FN(store_hdr_opt, 143, ##ctx) \ 5933*858ea5e5SAndroid Build Coastguard Worker FN(reserve_hdr_opt, 144, ##ctx) \ 5934*858ea5e5SAndroid Build Coastguard Worker FN(inode_storage_get, 145, ##ctx) \ 5935*858ea5e5SAndroid Build Coastguard Worker FN(inode_storage_delete, 146, ##ctx) \ 5936*858ea5e5SAndroid Build Coastguard Worker FN(d_path, 147, ##ctx) \ 5937*858ea5e5SAndroid Build Coastguard Worker FN(copy_from_user, 148, ##ctx) \ 5938*858ea5e5SAndroid Build Coastguard Worker FN(snprintf_btf, 149, ##ctx) \ 5939*858ea5e5SAndroid Build Coastguard Worker FN(seq_printf_btf, 150, ##ctx) \ 5940*858ea5e5SAndroid Build Coastguard Worker FN(skb_cgroup_classid, 151, ##ctx) \ 5941*858ea5e5SAndroid Build Coastguard Worker FN(redirect_neigh, 152, ##ctx) \ 5942*858ea5e5SAndroid Build Coastguard Worker FN(per_cpu_ptr, 153, ##ctx) \ 5943*858ea5e5SAndroid Build Coastguard Worker FN(this_cpu_ptr, 154, ##ctx) \ 5944*858ea5e5SAndroid Build Coastguard Worker FN(redirect_peer, 155, ##ctx) \ 5945*858ea5e5SAndroid Build Coastguard Worker FN(task_storage_get, 156, ##ctx) \ 5946*858ea5e5SAndroid Build Coastguard Worker FN(task_storage_delete, 157, ##ctx) \ 5947*858ea5e5SAndroid Build Coastguard Worker FN(get_current_task_btf, 158, ##ctx) \ 5948*858ea5e5SAndroid Build Coastguard Worker FN(bprm_opts_set, 159, ##ctx) \ 5949*858ea5e5SAndroid Build Coastguard Worker FN(ktime_get_coarse_ns, 160, ##ctx) \ 5950*858ea5e5SAndroid Build Coastguard Worker FN(ima_inode_hash, 161, ##ctx) \ 5951*858ea5e5SAndroid Build Coastguard Worker FN(sock_from_file, 162, ##ctx) \ 5952*858ea5e5SAndroid Build Coastguard Worker FN(check_mtu, 163, ##ctx) \ 5953*858ea5e5SAndroid Build Coastguard Worker FN(for_each_map_elem, 164, ##ctx) \ 5954*858ea5e5SAndroid Build Coastguard Worker FN(snprintf, 165, ##ctx) \ 5955*858ea5e5SAndroid Build Coastguard Worker FN(sys_bpf, 166, ##ctx) \ 5956*858ea5e5SAndroid Build Coastguard Worker FN(btf_find_by_name_kind, 167, ##ctx) \ 5957*858ea5e5SAndroid Build Coastguard Worker FN(sys_close, 168, ##ctx) \ 5958*858ea5e5SAndroid Build Coastguard Worker FN(timer_init, 169, ##ctx) \ 5959*858ea5e5SAndroid Build Coastguard Worker FN(timer_set_callback, 170, ##ctx) \ 5960*858ea5e5SAndroid Build Coastguard Worker FN(timer_start, 171, ##ctx) \ 5961*858ea5e5SAndroid Build Coastguard Worker FN(timer_cancel, 172, ##ctx) \ 5962*858ea5e5SAndroid Build Coastguard Worker FN(get_func_ip, 173, ##ctx) \ 5963*858ea5e5SAndroid Build Coastguard Worker FN(get_attach_cookie, 174, ##ctx) \ 5964*858ea5e5SAndroid Build Coastguard Worker FN(task_pt_regs, 175, ##ctx) \ 5965*858ea5e5SAndroid Build Coastguard Worker FN(get_branch_snapshot, 176, ##ctx) \ 5966*858ea5e5SAndroid Build Coastguard Worker FN(trace_vprintk, 177, ##ctx) \ 5967*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_unix_sock, 178, ##ctx) \ 5968*858ea5e5SAndroid Build Coastguard Worker FN(kallsyms_lookup_name, 179, ##ctx) \ 5969*858ea5e5SAndroid Build Coastguard Worker FN(find_vma, 180, ##ctx) \ 5970*858ea5e5SAndroid Build Coastguard Worker FN(loop, 181, ##ctx) \ 5971*858ea5e5SAndroid Build Coastguard Worker FN(strncmp, 182, ##ctx) \ 5972*858ea5e5SAndroid Build Coastguard Worker FN(get_func_arg, 183, ##ctx) \ 5973*858ea5e5SAndroid Build Coastguard Worker FN(get_func_ret, 184, ##ctx) \ 5974*858ea5e5SAndroid Build Coastguard Worker FN(get_func_arg_cnt, 185, ##ctx) \ 5975*858ea5e5SAndroid Build Coastguard Worker FN(get_retval, 186, ##ctx) \ 5976*858ea5e5SAndroid Build Coastguard Worker FN(set_retval, 187, ##ctx) \ 5977*858ea5e5SAndroid Build Coastguard Worker FN(xdp_get_buff_len, 188, ##ctx) \ 5978*858ea5e5SAndroid Build Coastguard Worker FN(xdp_load_bytes, 189, ##ctx) \ 5979*858ea5e5SAndroid Build Coastguard Worker FN(xdp_store_bytes, 190, ##ctx) \ 5980*858ea5e5SAndroid Build Coastguard Worker FN(copy_from_user_task, 191, ##ctx) \ 5981*858ea5e5SAndroid Build Coastguard Worker FN(skb_set_tstamp, 192, ##ctx) \ 5982*858ea5e5SAndroid Build Coastguard Worker FN(ima_file_hash, 193, ##ctx) \ 5983*858ea5e5SAndroid Build Coastguard Worker FN(kptr_xchg, 194, ##ctx) \ 5984*858ea5e5SAndroid Build Coastguard Worker FN(map_lookup_percpu_elem, 195, ##ctx) \ 5985*858ea5e5SAndroid Build Coastguard Worker FN(skc_to_mptcp_sock, 196, ##ctx) \ 5986*858ea5e5SAndroid Build Coastguard Worker FN(dynptr_from_mem, 197, ##ctx) \ 5987*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_reserve_dynptr, 198, ##ctx) \ 5988*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_submit_dynptr, 199, ##ctx) \ 5989*858ea5e5SAndroid Build Coastguard Worker FN(ringbuf_discard_dynptr, 200, ##ctx) \ 5990*858ea5e5SAndroid Build Coastguard Worker FN(dynptr_read, 201, ##ctx) \ 5991*858ea5e5SAndroid Build Coastguard Worker FN(dynptr_write, 202, ##ctx) \ 5992*858ea5e5SAndroid Build Coastguard Worker FN(dynptr_data, 203, ##ctx) \ 5993*858ea5e5SAndroid Build Coastguard Worker FN(tcp_raw_gen_syncookie_ipv4, 204, ##ctx) \ 5994*858ea5e5SAndroid Build Coastguard Worker FN(tcp_raw_gen_syncookie_ipv6, 205, ##ctx) \ 5995*858ea5e5SAndroid Build Coastguard Worker FN(tcp_raw_check_syncookie_ipv4, 206, ##ctx) \ 5996*858ea5e5SAndroid Build Coastguard Worker FN(tcp_raw_check_syncookie_ipv6, 207, ##ctx) \ 5997*858ea5e5SAndroid Build Coastguard Worker FN(ktime_get_tai_ns, 208, ##ctx) \ 5998*858ea5e5SAndroid Build Coastguard Worker FN(user_ringbuf_drain, 209, ##ctx) \ 5999*858ea5e5SAndroid Build Coastguard Worker FN(cgrp_storage_get, 210, ##ctx) \ 6000*858ea5e5SAndroid Build Coastguard Worker FN(cgrp_storage_delete, 211, ##ctx) \ 6001*858ea5e5SAndroid Build Coastguard Worker /* */ 6002*858ea5e5SAndroid Build Coastguard Worker 6003*858ea5e5SAndroid Build Coastguard Worker /* backwards-compatibility macros for users of __BPF_FUNC_MAPPER that don't 6004*858ea5e5SAndroid Build Coastguard Worker * know or care about integer value that is now passed as second argument 6005*858ea5e5SAndroid Build Coastguard Worker */ 6006*858ea5e5SAndroid Build Coastguard Worker #define __BPF_FUNC_MAPPER_APPLY(name, value, FN) FN(name), 6007*858ea5e5SAndroid Build Coastguard Worker #define __BPF_FUNC_MAPPER(FN) ___BPF_FUNC_MAPPER(__BPF_FUNC_MAPPER_APPLY, FN) 6008*858ea5e5SAndroid Build Coastguard Worker 6009*858ea5e5SAndroid Build Coastguard Worker /* integer value in 'imm' field of BPF_CALL instruction selects which helper 6010*858ea5e5SAndroid Build Coastguard Worker * function eBPF program intends to call 6011*858ea5e5SAndroid Build Coastguard Worker */ 6012*858ea5e5SAndroid Build Coastguard Worker #define __BPF_ENUM_FN(x, y) BPF_FUNC_ ## x = y, 6013*858ea5e5SAndroid Build Coastguard Worker enum bpf_func_id { 6014*858ea5e5SAndroid Build Coastguard Worker ___BPF_FUNC_MAPPER(__BPF_ENUM_FN) 6015*858ea5e5SAndroid Build Coastguard Worker __BPF_FUNC_MAX_ID, 6016*858ea5e5SAndroid Build Coastguard Worker }; 6017*858ea5e5SAndroid Build Coastguard Worker #undef __BPF_ENUM_FN 6018*858ea5e5SAndroid Build Coastguard Worker 6019*858ea5e5SAndroid Build Coastguard Worker /* All flags used by eBPF helper functions, placed here. */ 6020*858ea5e5SAndroid Build Coastguard Worker 6021*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_skb_store_bytes flags. */ 6022*858ea5e5SAndroid Build Coastguard Worker enum { 6023*858ea5e5SAndroid Build Coastguard Worker BPF_F_RECOMPUTE_CSUM = (1ULL << 0), 6024*858ea5e5SAndroid Build Coastguard Worker BPF_F_INVALIDATE_HASH = (1ULL << 1), 6025*858ea5e5SAndroid Build Coastguard Worker }; 6026*858ea5e5SAndroid Build Coastguard Worker 6027*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags. 6028*858ea5e5SAndroid Build Coastguard Worker * First 4 bits are for passing the header field size. 6029*858ea5e5SAndroid Build Coastguard Worker */ 6030*858ea5e5SAndroid Build Coastguard Worker enum { 6031*858ea5e5SAndroid Build Coastguard Worker BPF_F_HDR_FIELD_MASK = 0xfULL, 6032*858ea5e5SAndroid Build Coastguard Worker }; 6033*858ea5e5SAndroid Build Coastguard Worker 6034*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_l4_csum_replace flags. */ 6035*858ea5e5SAndroid Build Coastguard Worker enum { 6036*858ea5e5SAndroid Build Coastguard Worker BPF_F_PSEUDO_HDR = (1ULL << 4), 6037*858ea5e5SAndroid Build Coastguard Worker BPF_F_MARK_MANGLED_0 = (1ULL << 5), 6038*858ea5e5SAndroid Build Coastguard Worker BPF_F_MARK_ENFORCE = (1ULL << 6), 6039*858ea5e5SAndroid Build Coastguard Worker }; 6040*858ea5e5SAndroid Build Coastguard Worker 6041*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */ 6042*858ea5e5SAndroid Build Coastguard Worker enum { 6043*858ea5e5SAndroid Build Coastguard Worker BPF_F_INGRESS = (1ULL << 0), 6044*858ea5e5SAndroid Build Coastguard Worker }; 6045*858ea5e5SAndroid Build Coastguard Worker 6046*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */ 6047*858ea5e5SAndroid Build Coastguard Worker enum { 6048*858ea5e5SAndroid Build Coastguard Worker BPF_F_TUNINFO_IPV6 = (1ULL << 0), 6049*858ea5e5SAndroid Build Coastguard Worker }; 6050*858ea5e5SAndroid Build Coastguard Worker 6051*858ea5e5SAndroid Build Coastguard Worker /* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */ 6052*858ea5e5SAndroid Build Coastguard Worker enum { 6053*858ea5e5SAndroid Build Coastguard Worker BPF_F_SKIP_FIELD_MASK = 0xffULL, 6054*858ea5e5SAndroid Build Coastguard Worker BPF_F_USER_STACK = (1ULL << 8), 6055*858ea5e5SAndroid Build Coastguard Worker /* flags used by BPF_FUNC_get_stackid only. */ 6056*858ea5e5SAndroid Build Coastguard Worker BPF_F_FAST_STACK_CMP = (1ULL << 9), 6057*858ea5e5SAndroid Build Coastguard Worker BPF_F_REUSE_STACKID = (1ULL << 10), 6058*858ea5e5SAndroid Build Coastguard Worker /* flags used by BPF_FUNC_get_stack only. */ 6059*858ea5e5SAndroid Build Coastguard Worker BPF_F_USER_BUILD_ID = (1ULL << 11), 6060*858ea5e5SAndroid Build Coastguard Worker }; 6061*858ea5e5SAndroid Build Coastguard Worker 6062*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_skb_set_tunnel_key flags. */ 6063*858ea5e5SAndroid Build Coastguard Worker enum { 6064*858ea5e5SAndroid Build Coastguard Worker BPF_F_ZERO_CSUM_TX = (1ULL << 1), 6065*858ea5e5SAndroid Build Coastguard Worker BPF_F_DONT_FRAGMENT = (1ULL << 2), 6066*858ea5e5SAndroid Build Coastguard Worker BPF_F_SEQ_NUMBER = (1ULL << 3), 6067*858ea5e5SAndroid Build Coastguard Worker BPF_F_NO_TUNNEL_KEY = (1ULL << 4), 6068*858ea5e5SAndroid Build Coastguard Worker }; 6069*858ea5e5SAndroid Build Coastguard Worker 6070*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_skb_get_tunnel_key flags. */ 6071*858ea5e5SAndroid Build Coastguard Worker enum { 6072*858ea5e5SAndroid Build Coastguard Worker BPF_F_TUNINFO_FLAGS = (1ULL << 4), 6073*858ea5e5SAndroid Build Coastguard Worker }; 6074*858ea5e5SAndroid Build Coastguard Worker 6075*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and 6076*858ea5e5SAndroid Build Coastguard Worker * BPF_FUNC_perf_event_read_value flags. 6077*858ea5e5SAndroid Build Coastguard Worker */ 6078*858ea5e5SAndroid Build Coastguard Worker enum { 6079*858ea5e5SAndroid Build Coastguard Worker BPF_F_INDEX_MASK = 0xffffffffULL, 6080*858ea5e5SAndroid Build Coastguard Worker BPF_F_CURRENT_CPU = BPF_F_INDEX_MASK, 6081*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_perf_event_output for sk_buff input context. */ 6082*858ea5e5SAndroid Build Coastguard Worker BPF_F_CTXLEN_MASK = (0xfffffULL << 32), 6083*858ea5e5SAndroid Build Coastguard Worker }; 6084*858ea5e5SAndroid Build Coastguard Worker 6085*858ea5e5SAndroid Build Coastguard Worker /* Current network namespace */ 6086*858ea5e5SAndroid Build Coastguard Worker enum { 6087*858ea5e5SAndroid Build Coastguard Worker BPF_F_CURRENT_NETNS = (-1L), 6088*858ea5e5SAndroid Build Coastguard Worker }; 6089*858ea5e5SAndroid Build Coastguard Worker 6090*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_csum_level level values. */ 6091*858ea5e5SAndroid Build Coastguard Worker enum { 6092*858ea5e5SAndroid Build Coastguard Worker BPF_CSUM_LEVEL_QUERY, 6093*858ea5e5SAndroid Build Coastguard Worker BPF_CSUM_LEVEL_INC, 6094*858ea5e5SAndroid Build Coastguard Worker BPF_CSUM_LEVEL_DEC, 6095*858ea5e5SAndroid Build Coastguard Worker BPF_CSUM_LEVEL_RESET, 6096*858ea5e5SAndroid Build Coastguard Worker }; 6097*858ea5e5SAndroid Build Coastguard Worker 6098*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_skb_adjust_room flags. */ 6099*858ea5e5SAndroid Build Coastguard Worker enum { 6100*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_FIXED_GSO = (1ULL << 0), 6101*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 = (1ULL << 1), 6102*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 = (1ULL << 2), 6103*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_ENCAP_L4_GRE = (1ULL << 3), 6104*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_ENCAP_L4_UDP = (1ULL << 4), 6105*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_NO_CSUM_RESET = (1ULL << 5), 6106*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_ENCAP_L2_ETH = (1ULL << 6), 6107*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_DECAP_L3_IPV4 = (1ULL << 7), 6108*858ea5e5SAndroid Build Coastguard Worker BPF_F_ADJ_ROOM_DECAP_L3_IPV6 = (1ULL << 8), 6109*858ea5e5SAndroid Build Coastguard Worker }; 6110*858ea5e5SAndroid Build Coastguard Worker 6111*858ea5e5SAndroid Build Coastguard Worker enum { 6112*858ea5e5SAndroid Build Coastguard Worker BPF_ADJ_ROOM_ENCAP_L2_MASK = 0xff, 6113*858ea5e5SAndroid Build Coastguard Worker BPF_ADJ_ROOM_ENCAP_L2_SHIFT = 56, 6114*858ea5e5SAndroid Build Coastguard Worker }; 6115*858ea5e5SAndroid Build Coastguard Worker 6116*858ea5e5SAndroid Build Coastguard Worker #define BPF_F_ADJ_ROOM_ENCAP_L2(len) (((__u64)len & \ 6117*858ea5e5SAndroid Build Coastguard Worker BPF_ADJ_ROOM_ENCAP_L2_MASK) \ 6118*858ea5e5SAndroid Build Coastguard Worker << BPF_ADJ_ROOM_ENCAP_L2_SHIFT) 6119*858ea5e5SAndroid Build Coastguard Worker 6120*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_sysctl_get_name flags. */ 6121*858ea5e5SAndroid Build Coastguard Worker enum { 6122*858ea5e5SAndroid Build Coastguard Worker BPF_F_SYSCTL_BASE_NAME = (1ULL << 0), 6123*858ea5e5SAndroid Build Coastguard Worker }; 6124*858ea5e5SAndroid Build Coastguard Worker 6125*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_<kernel_obj>_storage_get flags */ 6126*858ea5e5SAndroid Build Coastguard Worker enum { 6127*858ea5e5SAndroid Build Coastguard Worker BPF_LOCAL_STORAGE_GET_F_CREATE = (1ULL << 0), 6128*858ea5e5SAndroid Build Coastguard Worker /* BPF_SK_STORAGE_GET_F_CREATE is only kept for backward compatibility 6129*858ea5e5SAndroid Build Coastguard Worker * and BPF_LOCAL_STORAGE_GET_F_CREATE must be used instead. 6130*858ea5e5SAndroid Build Coastguard Worker */ 6131*858ea5e5SAndroid Build Coastguard Worker BPF_SK_STORAGE_GET_F_CREATE = BPF_LOCAL_STORAGE_GET_F_CREATE, 6132*858ea5e5SAndroid Build Coastguard Worker }; 6133*858ea5e5SAndroid Build Coastguard Worker 6134*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_read_branch_records flags. */ 6135*858ea5e5SAndroid Build Coastguard Worker enum { 6136*858ea5e5SAndroid Build Coastguard Worker BPF_F_GET_BRANCH_RECORDS_SIZE = (1ULL << 0), 6137*858ea5e5SAndroid Build Coastguard Worker }; 6138*858ea5e5SAndroid Build Coastguard Worker 6139*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_bpf_ringbuf_commit, BPF_FUNC_bpf_ringbuf_discard, and 6140*858ea5e5SAndroid Build Coastguard Worker * BPF_FUNC_bpf_ringbuf_output flags. 6141*858ea5e5SAndroid Build Coastguard Worker */ 6142*858ea5e5SAndroid Build Coastguard Worker enum { 6143*858ea5e5SAndroid Build Coastguard Worker BPF_RB_NO_WAKEUP = (1ULL << 0), 6144*858ea5e5SAndroid Build Coastguard Worker BPF_RB_FORCE_WAKEUP = (1ULL << 1), 6145*858ea5e5SAndroid Build Coastguard Worker }; 6146*858ea5e5SAndroid Build Coastguard Worker 6147*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_bpf_ringbuf_query flags */ 6148*858ea5e5SAndroid Build Coastguard Worker enum { 6149*858ea5e5SAndroid Build Coastguard Worker BPF_RB_AVAIL_DATA = 0, 6150*858ea5e5SAndroid Build Coastguard Worker BPF_RB_RING_SIZE = 1, 6151*858ea5e5SAndroid Build Coastguard Worker BPF_RB_CONS_POS = 2, 6152*858ea5e5SAndroid Build Coastguard Worker BPF_RB_PROD_POS = 3, 6153*858ea5e5SAndroid Build Coastguard Worker }; 6154*858ea5e5SAndroid Build Coastguard Worker 6155*858ea5e5SAndroid Build Coastguard Worker /* BPF ring buffer constants */ 6156*858ea5e5SAndroid Build Coastguard Worker enum { 6157*858ea5e5SAndroid Build Coastguard Worker BPF_RINGBUF_BUSY_BIT = (1U << 31), 6158*858ea5e5SAndroid Build Coastguard Worker BPF_RINGBUF_DISCARD_BIT = (1U << 30), 6159*858ea5e5SAndroid Build Coastguard Worker BPF_RINGBUF_HDR_SZ = 8, 6160*858ea5e5SAndroid Build Coastguard Worker }; 6161*858ea5e5SAndroid Build Coastguard Worker 6162*858ea5e5SAndroid Build Coastguard Worker /* BPF_FUNC_sk_assign flags in bpf_sk_lookup context. */ 6163*858ea5e5SAndroid Build Coastguard Worker enum { 6164*858ea5e5SAndroid Build Coastguard Worker BPF_SK_LOOKUP_F_REPLACE = (1ULL << 0), 6165*858ea5e5SAndroid Build Coastguard Worker BPF_SK_LOOKUP_F_NO_REUSEPORT = (1ULL << 1), 6166*858ea5e5SAndroid Build Coastguard Worker }; 6167*858ea5e5SAndroid Build Coastguard Worker 6168*858ea5e5SAndroid Build Coastguard Worker /* Mode for BPF_FUNC_skb_adjust_room helper. */ 6169*858ea5e5SAndroid Build Coastguard Worker enum bpf_adj_room_mode { 6170*858ea5e5SAndroid Build Coastguard Worker BPF_ADJ_ROOM_NET, 6171*858ea5e5SAndroid Build Coastguard Worker BPF_ADJ_ROOM_MAC, 6172*858ea5e5SAndroid Build Coastguard Worker }; 6173*858ea5e5SAndroid Build Coastguard Worker 6174*858ea5e5SAndroid Build Coastguard Worker /* Mode for BPF_FUNC_skb_load_bytes_relative helper. */ 6175*858ea5e5SAndroid Build Coastguard Worker enum bpf_hdr_start_off { 6176*858ea5e5SAndroid Build Coastguard Worker BPF_HDR_START_MAC, 6177*858ea5e5SAndroid Build Coastguard Worker BPF_HDR_START_NET, 6178*858ea5e5SAndroid Build Coastguard Worker }; 6179*858ea5e5SAndroid Build Coastguard Worker 6180*858ea5e5SAndroid Build Coastguard Worker /* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */ 6181*858ea5e5SAndroid Build Coastguard Worker enum bpf_lwt_encap_mode { 6182*858ea5e5SAndroid Build Coastguard Worker BPF_LWT_ENCAP_SEG6, 6183*858ea5e5SAndroid Build Coastguard Worker BPF_LWT_ENCAP_SEG6_INLINE, 6184*858ea5e5SAndroid Build Coastguard Worker BPF_LWT_ENCAP_IP, 6185*858ea5e5SAndroid Build Coastguard Worker }; 6186*858ea5e5SAndroid Build Coastguard Worker 6187*858ea5e5SAndroid Build Coastguard Worker /* Flags for bpf_bprm_opts_set helper */ 6188*858ea5e5SAndroid Build Coastguard Worker enum { 6189*858ea5e5SAndroid Build Coastguard Worker BPF_F_BPRM_SECUREEXEC = (1ULL << 0), 6190*858ea5e5SAndroid Build Coastguard Worker }; 6191*858ea5e5SAndroid Build Coastguard Worker 6192*858ea5e5SAndroid Build Coastguard Worker /* Flags for bpf_redirect_map helper */ 6193*858ea5e5SAndroid Build Coastguard Worker enum { 6194*858ea5e5SAndroid Build Coastguard Worker BPF_F_BROADCAST = (1ULL << 3), 6195*858ea5e5SAndroid Build Coastguard Worker BPF_F_EXCLUDE_INGRESS = (1ULL << 4), 6196*858ea5e5SAndroid Build Coastguard Worker }; 6197*858ea5e5SAndroid Build Coastguard Worker 6198*858ea5e5SAndroid Build Coastguard Worker #define __bpf_md_ptr(type, name) \ 6199*858ea5e5SAndroid Build Coastguard Worker union { \ 6200*858ea5e5SAndroid Build Coastguard Worker type name; \ 6201*858ea5e5SAndroid Build Coastguard Worker __u64 :64; \ 6202*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))) 6203*858ea5e5SAndroid Build Coastguard Worker 6204*858ea5e5SAndroid Build Coastguard Worker enum { 6205*858ea5e5SAndroid Build Coastguard Worker BPF_SKB_TSTAMP_UNSPEC, 6206*858ea5e5SAndroid Build Coastguard Worker BPF_SKB_TSTAMP_DELIVERY_MONO, /* tstamp has mono delivery time */ 6207*858ea5e5SAndroid Build Coastguard Worker /* For any BPF_SKB_TSTAMP_* that the bpf prog cannot handle, 6208*858ea5e5SAndroid Build Coastguard Worker * the bpf prog should handle it like BPF_SKB_TSTAMP_UNSPEC 6209*858ea5e5SAndroid Build Coastguard Worker * and try to deduce it by ingress, egress or skb->sk->sk_clockid. 6210*858ea5e5SAndroid Build Coastguard Worker */ 6211*858ea5e5SAndroid Build Coastguard Worker }; 6212*858ea5e5SAndroid Build Coastguard Worker 6213*858ea5e5SAndroid Build Coastguard Worker /* user accessible mirror of in-kernel sk_buff. 6214*858ea5e5SAndroid Build Coastguard Worker * new fields can only be added to the end of this structure 6215*858ea5e5SAndroid Build Coastguard Worker */ 6216*858ea5e5SAndroid Build Coastguard Worker struct __sk_buff { 6217*858ea5e5SAndroid Build Coastguard Worker __u32 len; 6218*858ea5e5SAndroid Build Coastguard Worker __u32 pkt_type; 6219*858ea5e5SAndroid Build Coastguard Worker __u32 mark; 6220*858ea5e5SAndroid Build Coastguard Worker __u32 queue_mapping; 6221*858ea5e5SAndroid Build Coastguard Worker __u32 protocol; 6222*858ea5e5SAndroid Build Coastguard Worker __u32 vlan_present; 6223*858ea5e5SAndroid Build Coastguard Worker __u32 vlan_tci; 6224*858ea5e5SAndroid Build Coastguard Worker __u32 vlan_proto; 6225*858ea5e5SAndroid Build Coastguard Worker __u32 priority; 6226*858ea5e5SAndroid Build Coastguard Worker __u32 ingress_ifindex; 6227*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 6228*858ea5e5SAndroid Build Coastguard Worker __u32 tc_index; 6229*858ea5e5SAndroid Build Coastguard Worker __u32 cb[5]; 6230*858ea5e5SAndroid Build Coastguard Worker __u32 hash; 6231*858ea5e5SAndroid Build Coastguard Worker __u32 tc_classid; 6232*858ea5e5SAndroid Build Coastguard Worker __u32 data; 6233*858ea5e5SAndroid Build Coastguard Worker __u32 data_end; 6234*858ea5e5SAndroid Build Coastguard Worker __u32 napi_id; 6235*858ea5e5SAndroid Build Coastguard Worker 6236*858ea5e5SAndroid Build Coastguard Worker /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */ 6237*858ea5e5SAndroid Build Coastguard Worker __u32 family; 6238*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip4; /* Stored in network byte order */ 6239*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip4; /* Stored in network byte order */ 6240*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip6[4]; /* Stored in network byte order */ 6241*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip6[4]; /* Stored in network byte order */ 6242*858ea5e5SAndroid Build Coastguard Worker __u32 remote_port; /* Stored in network byte order */ 6243*858ea5e5SAndroid Build Coastguard Worker __u32 local_port; /* stored in host byte order */ 6244*858ea5e5SAndroid Build Coastguard Worker /* ... here. */ 6245*858ea5e5SAndroid Build Coastguard Worker 6246*858ea5e5SAndroid Build Coastguard Worker __u32 data_meta; 6247*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_flow_keys *, flow_keys); 6248*858ea5e5SAndroid Build Coastguard Worker __u64 tstamp; 6249*858ea5e5SAndroid Build Coastguard Worker __u32 wire_len; 6250*858ea5e5SAndroid Build Coastguard Worker __u32 gso_segs; 6251*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); 6252*858ea5e5SAndroid Build Coastguard Worker __u32 gso_size; 6253*858ea5e5SAndroid Build Coastguard Worker __u8 tstamp_type; 6254*858ea5e5SAndroid Build Coastguard Worker __u32 :24; /* Padding, future use. */ 6255*858ea5e5SAndroid Build Coastguard Worker __u64 hwtstamp; 6256*858ea5e5SAndroid Build Coastguard Worker }; 6257*858ea5e5SAndroid Build Coastguard Worker 6258*858ea5e5SAndroid Build Coastguard Worker struct bpf_tunnel_key { 6259*858ea5e5SAndroid Build Coastguard Worker __u32 tunnel_id; 6260*858ea5e5SAndroid Build Coastguard Worker union { 6261*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ipv4; 6262*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ipv6[4]; 6263*858ea5e5SAndroid Build Coastguard Worker }; 6264*858ea5e5SAndroid Build Coastguard Worker __u8 tunnel_tos; 6265*858ea5e5SAndroid Build Coastguard Worker __u8 tunnel_ttl; 6266*858ea5e5SAndroid Build Coastguard Worker union { 6267*858ea5e5SAndroid Build Coastguard Worker __u16 tunnel_ext; /* compat */ 6268*858ea5e5SAndroid Build Coastguard Worker __be16 tunnel_flags; 6269*858ea5e5SAndroid Build Coastguard Worker }; 6270*858ea5e5SAndroid Build Coastguard Worker __u32 tunnel_label; 6271*858ea5e5SAndroid Build Coastguard Worker union { 6272*858ea5e5SAndroid Build Coastguard Worker __u32 local_ipv4; 6273*858ea5e5SAndroid Build Coastguard Worker __u32 local_ipv6[4]; 6274*858ea5e5SAndroid Build Coastguard Worker }; 6275*858ea5e5SAndroid Build Coastguard Worker }; 6276*858ea5e5SAndroid Build Coastguard Worker 6277*858ea5e5SAndroid Build Coastguard Worker /* user accessible mirror of in-kernel xfrm_state. 6278*858ea5e5SAndroid Build Coastguard Worker * new fields can only be added to the end of this structure 6279*858ea5e5SAndroid Build Coastguard Worker */ 6280*858ea5e5SAndroid Build Coastguard Worker struct bpf_xfrm_state { 6281*858ea5e5SAndroid Build Coastguard Worker __u32 reqid; 6282*858ea5e5SAndroid Build Coastguard Worker __u32 spi; /* Stored in network byte order */ 6283*858ea5e5SAndroid Build Coastguard Worker __u16 family; 6284*858ea5e5SAndroid Build Coastguard Worker __u16 ext; /* Padding, future use. */ 6285*858ea5e5SAndroid Build Coastguard Worker union { 6286*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ipv4; /* Stored in network byte order */ 6287*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ipv6[4]; /* Stored in network byte order */ 6288*858ea5e5SAndroid Build Coastguard Worker }; 6289*858ea5e5SAndroid Build Coastguard Worker }; 6290*858ea5e5SAndroid Build Coastguard Worker 6291*858ea5e5SAndroid Build Coastguard Worker /* Generic BPF return codes which all BPF program types may support. 6292*858ea5e5SAndroid Build Coastguard Worker * The values are binary compatible with their TC_ACT_* counter-part to 6293*858ea5e5SAndroid Build Coastguard Worker * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT 6294*858ea5e5SAndroid Build Coastguard Worker * programs. 6295*858ea5e5SAndroid Build Coastguard Worker * 6296*858ea5e5SAndroid Build Coastguard Worker * XDP is handled seprately, see XDP_*. 6297*858ea5e5SAndroid Build Coastguard Worker */ 6298*858ea5e5SAndroid Build Coastguard Worker enum bpf_ret_code { 6299*858ea5e5SAndroid Build Coastguard Worker BPF_OK = 0, 6300*858ea5e5SAndroid Build Coastguard Worker /* 1 reserved */ 6301*858ea5e5SAndroid Build Coastguard Worker BPF_DROP = 2, 6302*858ea5e5SAndroid Build Coastguard Worker /* 3-6 reserved */ 6303*858ea5e5SAndroid Build Coastguard Worker BPF_REDIRECT = 7, 6304*858ea5e5SAndroid Build Coastguard Worker /* >127 are reserved for prog type specific return codes. 6305*858ea5e5SAndroid Build Coastguard Worker * 6306*858ea5e5SAndroid Build Coastguard Worker * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and 6307*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been 6308*858ea5e5SAndroid Build Coastguard Worker * changed and should be routed based on its new L3 header. 6309*858ea5e5SAndroid Build Coastguard Worker * (This is an L3 redirect, as opposed to L2 redirect 6310*858ea5e5SAndroid Build Coastguard Worker * represented by BPF_REDIRECT above). 6311*858ea5e5SAndroid Build Coastguard Worker */ 6312*858ea5e5SAndroid Build Coastguard Worker BPF_LWT_REROUTE = 128, 6313*858ea5e5SAndroid Build Coastguard Worker /* BPF_FLOW_DISSECTOR_CONTINUE: used by BPF_PROG_TYPE_FLOW_DISSECTOR 6314*858ea5e5SAndroid Build Coastguard Worker * to indicate that no custom dissection was performed, and 6315*858ea5e5SAndroid Build Coastguard Worker * fallback to standard dissector is requested. 6316*858ea5e5SAndroid Build Coastguard Worker */ 6317*858ea5e5SAndroid Build Coastguard Worker BPF_FLOW_DISSECTOR_CONTINUE = 129, 6318*858ea5e5SAndroid Build Coastguard Worker }; 6319*858ea5e5SAndroid Build Coastguard Worker 6320*858ea5e5SAndroid Build Coastguard Worker struct bpf_sock { 6321*858ea5e5SAndroid Build Coastguard Worker __u32 bound_dev_if; 6322*858ea5e5SAndroid Build Coastguard Worker __u32 family; 6323*858ea5e5SAndroid Build Coastguard Worker __u32 type; 6324*858ea5e5SAndroid Build Coastguard Worker __u32 protocol; 6325*858ea5e5SAndroid Build Coastguard Worker __u32 mark; 6326*858ea5e5SAndroid Build Coastguard Worker __u32 priority; 6327*858ea5e5SAndroid Build Coastguard Worker /* IP address also allows 1 and 2 bytes access */ 6328*858ea5e5SAndroid Build Coastguard Worker __u32 src_ip4; 6329*858ea5e5SAndroid Build Coastguard Worker __u32 src_ip6[4]; 6330*858ea5e5SAndroid Build Coastguard Worker __u32 src_port; /* host byte order */ 6331*858ea5e5SAndroid Build Coastguard Worker __be16 dst_port; /* network byte order */ 6332*858ea5e5SAndroid Build Coastguard Worker __u16 :16; /* zero padding */ 6333*858ea5e5SAndroid Build Coastguard Worker __u32 dst_ip4; 6334*858ea5e5SAndroid Build Coastguard Worker __u32 dst_ip6[4]; 6335*858ea5e5SAndroid Build Coastguard Worker __u32 state; 6336*858ea5e5SAndroid Build Coastguard Worker __s32 rx_queue_mapping; 6337*858ea5e5SAndroid Build Coastguard Worker }; 6338*858ea5e5SAndroid Build Coastguard Worker 6339*858ea5e5SAndroid Build Coastguard Worker struct bpf_tcp_sock { 6340*858ea5e5SAndroid Build Coastguard Worker __u32 snd_cwnd; /* Sending congestion window */ 6341*858ea5e5SAndroid Build Coastguard Worker __u32 srtt_us; /* smoothed round trip time << 3 in usecs */ 6342*858ea5e5SAndroid Build Coastguard Worker __u32 rtt_min; 6343*858ea5e5SAndroid Build Coastguard Worker __u32 snd_ssthresh; /* Slow start size threshold */ 6344*858ea5e5SAndroid Build Coastguard Worker __u32 rcv_nxt; /* What we want to receive next */ 6345*858ea5e5SAndroid Build Coastguard Worker __u32 snd_nxt; /* Next sequence we send */ 6346*858ea5e5SAndroid Build Coastguard Worker __u32 snd_una; /* First byte we want an ack for */ 6347*858ea5e5SAndroid Build Coastguard Worker __u32 mss_cache; /* Cached effective mss, not including SACKS */ 6348*858ea5e5SAndroid Build Coastguard Worker __u32 ecn_flags; /* ECN status bits. */ 6349*858ea5e5SAndroid Build Coastguard Worker __u32 rate_delivered; /* saved rate sample: packets delivered */ 6350*858ea5e5SAndroid Build Coastguard Worker __u32 rate_interval_us; /* saved rate sample: time elapsed */ 6351*858ea5e5SAndroid Build Coastguard Worker __u32 packets_out; /* Packets which are "in flight" */ 6352*858ea5e5SAndroid Build Coastguard Worker __u32 retrans_out; /* Retransmitted packets out */ 6353*858ea5e5SAndroid Build Coastguard Worker __u32 total_retrans; /* Total retransmits for entire connection */ 6354*858ea5e5SAndroid Build Coastguard Worker __u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn 6355*858ea5e5SAndroid Build Coastguard Worker * total number of segments in. 6356*858ea5e5SAndroid Build Coastguard Worker */ 6357*858ea5e5SAndroid Build Coastguard Worker __u32 data_segs_in; /* RFC4898 tcpEStatsPerfDataSegsIn 6358*858ea5e5SAndroid Build Coastguard Worker * total number of data segments in. 6359*858ea5e5SAndroid Build Coastguard Worker */ 6360*858ea5e5SAndroid Build Coastguard Worker __u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut 6361*858ea5e5SAndroid Build Coastguard Worker * The total number of segments sent. 6362*858ea5e5SAndroid Build Coastguard Worker */ 6363*858ea5e5SAndroid Build Coastguard Worker __u32 data_segs_out; /* RFC4898 tcpEStatsPerfDataSegsOut 6364*858ea5e5SAndroid Build Coastguard Worker * total number of data segments sent. 6365*858ea5e5SAndroid Build Coastguard Worker */ 6366*858ea5e5SAndroid Build Coastguard Worker __u32 lost_out; /* Lost packets */ 6367*858ea5e5SAndroid Build Coastguard Worker __u32 sacked_out; /* SACK'd packets */ 6368*858ea5e5SAndroid Build Coastguard Worker __u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived 6369*858ea5e5SAndroid Build Coastguard Worker * sum(delta(rcv_nxt)), or how many bytes 6370*858ea5e5SAndroid Build Coastguard Worker * were acked. 6371*858ea5e5SAndroid Build Coastguard Worker */ 6372*858ea5e5SAndroid Build Coastguard Worker __u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked 6373*858ea5e5SAndroid Build Coastguard Worker * sum(delta(snd_una)), or how many bytes 6374*858ea5e5SAndroid Build Coastguard Worker * were acked. 6375*858ea5e5SAndroid Build Coastguard Worker */ 6376*858ea5e5SAndroid Build Coastguard Worker __u32 dsack_dups; /* RFC4898 tcpEStatsStackDSACKDups 6377*858ea5e5SAndroid Build Coastguard Worker * total number of DSACK blocks received 6378*858ea5e5SAndroid Build Coastguard Worker */ 6379*858ea5e5SAndroid Build Coastguard Worker __u32 delivered; /* Total data packets delivered incl. rexmits */ 6380*858ea5e5SAndroid Build Coastguard Worker __u32 delivered_ce; /* Like the above but only ECE marked packets */ 6381*858ea5e5SAndroid Build Coastguard Worker __u32 icsk_retransmits; /* Number of unrecovered [RTO] timeouts */ 6382*858ea5e5SAndroid Build Coastguard Worker }; 6383*858ea5e5SAndroid Build Coastguard Worker 6384*858ea5e5SAndroid Build Coastguard Worker struct bpf_sock_tuple { 6385*858ea5e5SAndroid Build Coastguard Worker union { 6386*858ea5e5SAndroid Build Coastguard Worker struct { 6387*858ea5e5SAndroid Build Coastguard Worker __be32 saddr; 6388*858ea5e5SAndroid Build Coastguard Worker __be32 daddr; 6389*858ea5e5SAndroid Build Coastguard Worker __be16 sport; 6390*858ea5e5SAndroid Build Coastguard Worker __be16 dport; 6391*858ea5e5SAndroid Build Coastguard Worker } ipv4; 6392*858ea5e5SAndroid Build Coastguard Worker struct { 6393*858ea5e5SAndroid Build Coastguard Worker __be32 saddr[4]; 6394*858ea5e5SAndroid Build Coastguard Worker __be32 daddr[4]; 6395*858ea5e5SAndroid Build Coastguard Worker __be16 sport; 6396*858ea5e5SAndroid Build Coastguard Worker __be16 dport; 6397*858ea5e5SAndroid Build Coastguard Worker } ipv6; 6398*858ea5e5SAndroid Build Coastguard Worker }; 6399*858ea5e5SAndroid Build Coastguard Worker }; 6400*858ea5e5SAndroid Build Coastguard Worker 6401*858ea5e5SAndroid Build Coastguard Worker /* (Simplified) user return codes for tcx prog type. 6402*858ea5e5SAndroid Build Coastguard Worker * A valid tcx program must return one of these defined values. All other 6403*858ea5e5SAndroid Build Coastguard Worker * return codes are reserved for future use. Must remain compatible with 6404*858ea5e5SAndroid Build Coastguard Worker * their TC_ACT_* counter-parts. For compatibility in behavior, unknown 6405*858ea5e5SAndroid Build Coastguard Worker * return codes are mapped to TCX_NEXT. 6406*858ea5e5SAndroid Build Coastguard Worker */ 6407*858ea5e5SAndroid Build Coastguard Worker enum tcx_action_base { 6408*858ea5e5SAndroid Build Coastguard Worker TCX_NEXT = -1, 6409*858ea5e5SAndroid Build Coastguard Worker TCX_PASS = 0, 6410*858ea5e5SAndroid Build Coastguard Worker TCX_DROP = 2, 6411*858ea5e5SAndroid Build Coastguard Worker TCX_REDIRECT = 7, 6412*858ea5e5SAndroid Build Coastguard Worker }; 6413*858ea5e5SAndroid Build Coastguard Worker 6414*858ea5e5SAndroid Build Coastguard Worker struct bpf_xdp_sock { 6415*858ea5e5SAndroid Build Coastguard Worker __u32 queue_id; 6416*858ea5e5SAndroid Build Coastguard Worker }; 6417*858ea5e5SAndroid Build Coastguard Worker 6418*858ea5e5SAndroid Build Coastguard Worker #define XDP_PACKET_HEADROOM 256 6419*858ea5e5SAndroid Build Coastguard Worker 6420*858ea5e5SAndroid Build Coastguard Worker /* User return codes for XDP prog type. 6421*858ea5e5SAndroid Build Coastguard Worker * A valid XDP program must return one of these defined values. All other 6422*858ea5e5SAndroid Build Coastguard Worker * return codes are reserved for future use. Unknown return codes will 6423*858ea5e5SAndroid Build Coastguard Worker * result in packet drops and a warning via bpf_warn_invalid_xdp_action(). 6424*858ea5e5SAndroid Build Coastguard Worker */ 6425*858ea5e5SAndroid Build Coastguard Worker enum xdp_action { 6426*858ea5e5SAndroid Build Coastguard Worker XDP_ABORTED = 0, 6427*858ea5e5SAndroid Build Coastguard Worker XDP_DROP, 6428*858ea5e5SAndroid Build Coastguard Worker XDP_PASS, 6429*858ea5e5SAndroid Build Coastguard Worker XDP_TX, 6430*858ea5e5SAndroid Build Coastguard Worker XDP_REDIRECT, 6431*858ea5e5SAndroid Build Coastguard Worker }; 6432*858ea5e5SAndroid Build Coastguard Worker 6433*858ea5e5SAndroid Build Coastguard Worker /* user accessible metadata for XDP packet hook 6434*858ea5e5SAndroid Build Coastguard Worker * new fields must be added to the end of this structure 6435*858ea5e5SAndroid Build Coastguard Worker */ 6436*858ea5e5SAndroid Build Coastguard Worker struct xdp_md { 6437*858ea5e5SAndroid Build Coastguard Worker __u32 data; 6438*858ea5e5SAndroid Build Coastguard Worker __u32 data_end; 6439*858ea5e5SAndroid Build Coastguard Worker __u32 data_meta; 6440*858ea5e5SAndroid Build Coastguard Worker /* Below access go through struct xdp_rxq_info */ 6441*858ea5e5SAndroid Build Coastguard Worker __u32 ingress_ifindex; /* rxq->dev->ifindex */ 6442*858ea5e5SAndroid Build Coastguard Worker __u32 rx_queue_index; /* rxq->queue_index */ 6443*858ea5e5SAndroid Build Coastguard Worker 6444*858ea5e5SAndroid Build Coastguard Worker __u32 egress_ifindex; /* txq->dev->ifindex */ 6445*858ea5e5SAndroid Build Coastguard Worker }; 6446*858ea5e5SAndroid Build Coastguard Worker 6447*858ea5e5SAndroid Build Coastguard Worker /* DEVMAP map-value layout 6448*858ea5e5SAndroid Build Coastguard Worker * 6449*858ea5e5SAndroid Build Coastguard Worker * The struct data-layout of map-value is a configuration interface. 6450*858ea5e5SAndroid Build Coastguard Worker * New members can only be added to the end of this structure. 6451*858ea5e5SAndroid Build Coastguard Worker */ 6452*858ea5e5SAndroid Build Coastguard Worker struct bpf_devmap_val { 6453*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; /* device index */ 6454*858ea5e5SAndroid Build Coastguard Worker union { 6455*858ea5e5SAndroid Build Coastguard Worker int fd; /* prog fd on map write */ 6456*858ea5e5SAndroid Build Coastguard Worker __u32 id; /* prog id on map read */ 6457*858ea5e5SAndroid Build Coastguard Worker } bpf_prog; 6458*858ea5e5SAndroid Build Coastguard Worker }; 6459*858ea5e5SAndroid Build Coastguard Worker 6460*858ea5e5SAndroid Build Coastguard Worker /* CPUMAP map-value layout 6461*858ea5e5SAndroid Build Coastguard Worker * 6462*858ea5e5SAndroid Build Coastguard Worker * The struct data-layout of map-value is a configuration interface. 6463*858ea5e5SAndroid Build Coastguard Worker * New members can only be added to the end of this structure. 6464*858ea5e5SAndroid Build Coastguard Worker */ 6465*858ea5e5SAndroid Build Coastguard Worker struct bpf_cpumap_val { 6466*858ea5e5SAndroid Build Coastguard Worker __u32 qsize; /* queue size to remote target CPU */ 6467*858ea5e5SAndroid Build Coastguard Worker union { 6468*858ea5e5SAndroid Build Coastguard Worker int fd; /* prog fd on map write */ 6469*858ea5e5SAndroid Build Coastguard Worker __u32 id; /* prog id on map read */ 6470*858ea5e5SAndroid Build Coastguard Worker } bpf_prog; 6471*858ea5e5SAndroid Build Coastguard Worker }; 6472*858ea5e5SAndroid Build Coastguard Worker 6473*858ea5e5SAndroid Build Coastguard Worker enum sk_action { 6474*858ea5e5SAndroid Build Coastguard Worker SK_DROP = 0, 6475*858ea5e5SAndroid Build Coastguard Worker SK_PASS, 6476*858ea5e5SAndroid Build Coastguard Worker }; 6477*858ea5e5SAndroid Build Coastguard Worker 6478*858ea5e5SAndroid Build Coastguard Worker /* user accessible metadata for SK_MSG packet hook, new fields must 6479*858ea5e5SAndroid Build Coastguard Worker * be added to the end of this structure 6480*858ea5e5SAndroid Build Coastguard Worker */ 6481*858ea5e5SAndroid Build Coastguard Worker struct sk_msg_md { 6482*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, data); 6483*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, data_end); 6484*858ea5e5SAndroid Build Coastguard Worker 6485*858ea5e5SAndroid Build Coastguard Worker __u32 family; 6486*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip4; /* Stored in network byte order */ 6487*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip4; /* Stored in network byte order */ 6488*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip6[4]; /* Stored in network byte order */ 6489*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip6[4]; /* Stored in network byte order */ 6490*858ea5e5SAndroid Build Coastguard Worker __u32 remote_port; /* Stored in network byte order */ 6491*858ea5e5SAndroid Build Coastguard Worker __u32 local_port; /* stored in host byte order */ 6492*858ea5e5SAndroid Build Coastguard Worker __u32 size; /* Total size of sk_msg */ 6493*858ea5e5SAndroid Build Coastguard Worker 6494*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); /* current socket */ 6495*858ea5e5SAndroid Build Coastguard Worker }; 6496*858ea5e5SAndroid Build Coastguard Worker 6497*858ea5e5SAndroid Build Coastguard Worker struct sk_reuseport_md { 6498*858ea5e5SAndroid Build Coastguard Worker /* 6499*858ea5e5SAndroid Build Coastguard Worker * Start of directly accessible data. It begins from 6500*858ea5e5SAndroid Build Coastguard Worker * the tcp/udp header. 6501*858ea5e5SAndroid Build Coastguard Worker */ 6502*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, data); 6503*858ea5e5SAndroid Build Coastguard Worker /* End of directly accessible data */ 6504*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, data_end); 6505*858ea5e5SAndroid Build Coastguard Worker /* 6506*858ea5e5SAndroid Build Coastguard Worker * Total length of packet (starting from the tcp/udp header). 6507*858ea5e5SAndroid Build Coastguard Worker * Note that the directly accessible bytes (data_end - data) 6508*858ea5e5SAndroid Build Coastguard Worker * could be less than this "len". Those bytes could be 6509*858ea5e5SAndroid Build Coastguard Worker * indirectly read by a helper "bpf_skb_load_bytes()". 6510*858ea5e5SAndroid Build Coastguard Worker */ 6511*858ea5e5SAndroid Build Coastguard Worker __u32 len; 6512*858ea5e5SAndroid Build Coastguard Worker /* 6513*858ea5e5SAndroid Build Coastguard Worker * Eth protocol in the mac header (network byte order). e.g. 6514*858ea5e5SAndroid Build Coastguard Worker * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD) 6515*858ea5e5SAndroid Build Coastguard Worker */ 6516*858ea5e5SAndroid Build Coastguard Worker __u32 eth_protocol; 6517*858ea5e5SAndroid Build Coastguard Worker __u32 ip_protocol; /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */ 6518*858ea5e5SAndroid Build Coastguard Worker __u32 bind_inany; /* Is sock bound to an INANY address? */ 6519*858ea5e5SAndroid Build Coastguard Worker __u32 hash; /* A hash of the packet 4 tuples */ 6520*858ea5e5SAndroid Build Coastguard Worker /* When reuse->migrating_sk is NULL, it is selecting a sk for the 6521*858ea5e5SAndroid Build Coastguard Worker * new incoming connection request (e.g. selecting a listen sk for 6522*858ea5e5SAndroid Build Coastguard Worker * the received SYN in the TCP case). reuse->sk is one of the sk 6523*858ea5e5SAndroid Build Coastguard Worker * in the reuseport group. The bpf prog can use reuse->sk to learn 6524*858ea5e5SAndroid Build Coastguard Worker * the local listening ip/port without looking into the skb. 6525*858ea5e5SAndroid Build Coastguard Worker * 6526*858ea5e5SAndroid Build Coastguard Worker * When reuse->migrating_sk is not NULL, reuse->sk is closed and 6527*858ea5e5SAndroid Build Coastguard Worker * reuse->migrating_sk is the socket that needs to be migrated 6528*858ea5e5SAndroid Build Coastguard Worker * to another listening socket. migrating_sk could be a fullsock 6529*858ea5e5SAndroid Build Coastguard Worker * sk that is fully established or a reqsk that is in-the-middle 6530*858ea5e5SAndroid Build Coastguard Worker * of 3-way handshake. 6531*858ea5e5SAndroid Build Coastguard Worker */ 6532*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); 6533*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, migrating_sk); 6534*858ea5e5SAndroid Build Coastguard Worker }; 6535*858ea5e5SAndroid Build Coastguard Worker 6536*858ea5e5SAndroid Build Coastguard Worker #define BPF_TAG_SIZE 8 6537*858ea5e5SAndroid Build Coastguard Worker 6538*858ea5e5SAndroid Build Coastguard Worker struct bpf_prog_info { 6539*858ea5e5SAndroid Build Coastguard Worker __u32 type; 6540*858ea5e5SAndroid Build Coastguard Worker __u32 id; 6541*858ea5e5SAndroid Build Coastguard Worker __u8 tag[BPF_TAG_SIZE]; 6542*858ea5e5SAndroid Build Coastguard Worker __u32 jited_prog_len; 6543*858ea5e5SAndroid Build Coastguard Worker __u32 xlated_prog_len; 6544*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 jited_prog_insns; 6545*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 xlated_prog_insns; 6546*858ea5e5SAndroid Build Coastguard Worker __u64 load_time; /* ns since boottime */ 6547*858ea5e5SAndroid Build Coastguard Worker __u32 created_by_uid; 6548*858ea5e5SAndroid Build Coastguard Worker __u32 nr_map_ids; 6549*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 map_ids; 6550*858ea5e5SAndroid Build Coastguard Worker char name[BPF_OBJ_NAME_LEN]; 6551*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 6552*858ea5e5SAndroid Build Coastguard Worker __u32 gpl_compatible:1; 6553*858ea5e5SAndroid Build Coastguard Worker __u32 :31; /* alignment pad */ 6554*858ea5e5SAndroid Build Coastguard Worker __u64 netns_dev; 6555*858ea5e5SAndroid Build Coastguard Worker __u64 netns_ino; 6556*858ea5e5SAndroid Build Coastguard Worker __u32 nr_jited_ksyms; 6557*858ea5e5SAndroid Build Coastguard Worker __u32 nr_jited_func_lens; 6558*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 jited_ksyms; 6559*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 jited_func_lens; 6560*858ea5e5SAndroid Build Coastguard Worker __u32 btf_id; 6561*858ea5e5SAndroid Build Coastguard Worker __u32 func_info_rec_size; 6562*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 func_info; 6563*858ea5e5SAndroid Build Coastguard Worker __u32 nr_func_info; 6564*858ea5e5SAndroid Build Coastguard Worker __u32 nr_line_info; 6565*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 line_info; 6566*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 jited_line_info; 6567*858ea5e5SAndroid Build Coastguard Worker __u32 nr_jited_line_info; 6568*858ea5e5SAndroid Build Coastguard Worker __u32 line_info_rec_size; 6569*858ea5e5SAndroid Build Coastguard Worker __u32 jited_line_info_rec_size; 6570*858ea5e5SAndroid Build Coastguard Worker __u32 nr_prog_tags; 6571*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 prog_tags; 6572*858ea5e5SAndroid Build Coastguard Worker __u64 run_time_ns; 6573*858ea5e5SAndroid Build Coastguard Worker __u64 run_cnt; 6574*858ea5e5SAndroid Build Coastguard Worker __u64 recursion_misses; 6575*858ea5e5SAndroid Build Coastguard Worker __u32 verified_insns; 6576*858ea5e5SAndroid Build Coastguard Worker __u32 attach_btf_obj_id; 6577*858ea5e5SAndroid Build Coastguard Worker __u32 attach_btf_id; 6578*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 6579*858ea5e5SAndroid Build Coastguard Worker 6580*858ea5e5SAndroid Build Coastguard Worker struct bpf_map_info { 6581*858ea5e5SAndroid Build Coastguard Worker __u32 type; 6582*858ea5e5SAndroid Build Coastguard Worker __u32 id; 6583*858ea5e5SAndroid Build Coastguard Worker __u32 key_size; 6584*858ea5e5SAndroid Build Coastguard Worker __u32 value_size; 6585*858ea5e5SAndroid Build Coastguard Worker __u32 max_entries; 6586*858ea5e5SAndroid Build Coastguard Worker __u32 map_flags; 6587*858ea5e5SAndroid Build Coastguard Worker char name[BPF_OBJ_NAME_LEN]; 6588*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 6589*858ea5e5SAndroid Build Coastguard Worker __u32 btf_vmlinux_value_type_id; 6590*858ea5e5SAndroid Build Coastguard Worker __u64 netns_dev; 6591*858ea5e5SAndroid Build Coastguard Worker __u64 netns_ino; 6592*858ea5e5SAndroid Build Coastguard Worker __u32 btf_id; 6593*858ea5e5SAndroid Build Coastguard Worker __u32 btf_key_type_id; 6594*858ea5e5SAndroid Build Coastguard Worker __u32 btf_value_type_id; 6595*858ea5e5SAndroid Build Coastguard Worker __u32 btf_vmlinux_id; 6596*858ea5e5SAndroid Build Coastguard Worker __u64 map_extra; 6597*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 6598*858ea5e5SAndroid Build Coastguard Worker 6599*858ea5e5SAndroid Build Coastguard Worker struct bpf_btf_info { 6600*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 btf; 6601*858ea5e5SAndroid Build Coastguard Worker __u32 btf_size; 6602*858ea5e5SAndroid Build Coastguard Worker __u32 id; 6603*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 name; 6604*858ea5e5SAndroid Build Coastguard Worker __u32 name_len; 6605*858ea5e5SAndroid Build Coastguard Worker __u32 kernel_btf; 6606*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 6607*858ea5e5SAndroid Build Coastguard Worker 6608*858ea5e5SAndroid Build Coastguard Worker struct bpf_link_info { 6609*858ea5e5SAndroid Build Coastguard Worker __u32 type; 6610*858ea5e5SAndroid Build Coastguard Worker __u32 id; 6611*858ea5e5SAndroid Build Coastguard Worker __u32 prog_id; 6612*858ea5e5SAndroid Build Coastguard Worker union { 6613*858ea5e5SAndroid Build Coastguard Worker struct { 6614*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 tp_name; /* in/out: tp_name buffer ptr */ 6615*858ea5e5SAndroid Build Coastguard Worker __u32 tp_name_len; /* in/out: tp_name buffer len */ 6616*858ea5e5SAndroid Build Coastguard Worker } raw_tracepoint; 6617*858ea5e5SAndroid Build Coastguard Worker struct { 6618*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 6619*858ea5e5SAndroid Build Coastguard Worker __u32 target_obj_id; /* prog_id for PROG_EXT, otherwise btf object id */ 6620*858ea5e5SAndroid Build Coastguard Worker __u32 target_btf_id; /* BTF type id inside the object */ 6621*858ea5e5SAndroid Build Coastguard Worker } tracing; 6622*858ea5e5SAndroid Build Coastguard Worker struct { 6623*858ea5e5SAndroid Build Coastguard Worker __u64 cgroup_id; 6624*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 6625*858ea5e5SAndroid Build Coastguard Worker } cgroup; 6626*858ea5e5SAndroid Build Coastguard Worker struct { 6627*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 target_name; /* in/out: target_name buffer ptr */ 6628*858ea5e5SAndroid Build Coastguard Worker __u32 target_name_len; /* in/out: target_name buffer len */ 6629*858ea5e5SAndroid Build Coastguard Worker 6630*858ea5e5SAndroid Build Coastguard Worker /* If the iter specific field is 32 bits, it can be put 6631*858ea5e5SAndroid Build Coastguard Worker * in the first or second union. Otherwise it should be 6632*858ea5e5SAndroid Build Coastguard Worker * put in the second union. 6633*858ea5e5SAndroid Build Coastguard Worker */ 6634*858ea5e5SAndroid Build Coastguard Worker union { 6635*858ea5e5SAndroid Build Coastguard Worker struct { 6636*858ea5e5SAndroid Build Coastguard Worker __u32 map_id; 6637*858ea5e5SAndroid Build Coastguard Worker } map; 6638*858ea5e5SAndroid Build Coastguard Worker }; 6639*858ea5e5SAndroid Build Coastguard Worker union { 6640*858ea5e5SAndroid Build Coastguard Worker struct { 6641*858ea5e5SAndroid Build Coastguard Worker __u64 cgroup_id; 6642*858ea5e5SAndroid Build Coastguard Worker __u32 order; 6643*858ea5e5SAndroid Build Coastguard Worker } cgroup; 6644*858ea5e5SAndroid Build Coastguard Worker struct { 6645*858ea5e5SAndroid Build Coastguard Worker __u32 tid; 6646*858ea5e5SAndroid Build Coastguard Worker __u32 pid; 6647*858ea5e5SAndroid Build Coastguard Worker } task; 6648*858ea5e5SAndroid Build Coastguard Worker }; 6649*858ea5e5SAndroid Build Coastguard Worker } iter; 6650*858ea5e5SAndroid Build Coastguard Worker struct { 6651*858ea5e5SAndroid Build Coastguard Worker __u32 netns_ino; 6652*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 6653*858ea5e5SAndroid Build Coastguard Worker } netns; 6654*858ea5e5SAndroid Build Coastguard Worker struct { 6655*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 6656*858ea5e5SAndroid Build Coastguard Worker } xdp; 6657*858ea5e5SAndroid Build Coastguard Worker struct { 6658*858ea5e5SAndroid Build Coastguard Worker __u32 map_id; 6659*858ea5e5SAndroid Build Coastguard Worker } struct_ops; 6660*858ea5e5SAndroid Build Coastguard Worker struct { 6661*858ea5e5SAndroid Build Coastguard Worker __u32 pf; 6662*858ea5e5SAndroid Build Coastguard Worker __u32 hooknum; 6663*858ea5e5SAndroid Build Coastguard Worker __s32 priority; 6664*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 6665*858ea5e5SAndroid Build Coastguard Worker } netfilter; 6666*858ea5e5SAndroid Build Coastguard Worker struct { 6667*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 addrs; 6668*858ea5e5SAndroid Build Coastguard Worker __u32 count; /* in/out: kprobe_multi function count */ 6669*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 6670*858ea5e5SAndroid Build Coastguard Worker __u64 missed; 6671*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 cookies; 6672*858ea5e5SAndroid Build Coastguard Worker } kprobe_multi; 6673*858ea5e5SAndroid Build Coastguard Worker struct { 6674*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 path; 6675*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 offsets; 6676*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 ref_ctr_offsets; 6677*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 cookies; 6678*858ea5e5SAndroid Build Coastguard Worker __u32 path_size; /* in/out: real path size on success, including zero byte */ 6679*858ea5e5SAndroid Build Coastguard Worker __u32 count; /* in/out: uprobe_multi offsets/ref_ctr_offsets/cookies count */ 6680*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 6681*858ea5e5SAndroid Build Coastguard Worker __u32 pid; 6682*858ea5e5SAndroid Build Coastguard Worker } uprobe_multi; 6683*858ea5e5SAndroid Build Coastguard Worker struct { 6684*858ea5e5SAndroid Build Coastguard Worker __u32 type; /* enum bpf_perf_event_type */ 6685*858ea5e5SAndroid Build Coastguard Worker __u32 :32; 6686*858ea5e5SAndroid Build Coastguard Worker union { 6687*858ea5e5SAndroid Build Coastguard Worker struct { 6688*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 file_name; /* in/out */ 6689*858ea5e5SAndroid Build Coastguard Worker __u32 name_len; 6690*858ea5e5SAndroid Build Coastguard Worker __u32 offset; /* offset from file_name */ 6691*858ea5e5SAndroid Build Coastguard Worker __u64 cookie; 6692*858ea5e5SAndroid Build Coastguard Worker } uprobe; /* BPF_PERF_EVENT_UPROBE, BPF_PERF_EVENT_URETPROBE */ 6693*858ea5e5SAndroid Build Coastguard Worker struct { 6694*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 func_name; /* in/out */ 6695*858ea5e5SAndroid Build Coastguard Worker __u32 name_len; 6696*858ea5e5SAndroid Build Coastguard Worker __u32 offset; /* offset from func_name */ 6697*858ea5e5SAndroid Build Coastguard Worker __u64 addr; 6698*858ea5e5SAndroid Build Coastguard Worker __u64 missed; 6699*858ea5e5SAndroid Build Coastguard Worker __u64 cookie; 6700*858ea5e5SAndroid Build Coastguard Worker } kprobe; /* BPF_PERF_EVENT_KPROBE, BPF_PERF_EVENT_KRETPROBE */ 6701*858ea5e5SAndroid Build Coastguard Worker struct { 6702*858ea5e5SAndroid Build Coastguard Worker __aligned_u64 tp_name; /* in/out */ 6703*858ea5e5SAndroid Build Coastguard Worker __u32 name_len; 6704*858ea5e5SAndroid Build Coastguard Worker __u32 :32; 6705*858ea5e5SAndroid Build Coastguard Worker __u64 cookie; 6706*858ea5e5SAndroid Build Coastguard Worker } tracepoint; /* BPF_PERF_EVENT_TRACEPOINT */ 6707*858ea5e5SAndroid Build Coastguard Worker struct { 6708*858ea5e5SAndroid Build Coastguard Worker __u64 config; 6709*858ea5e5SAndroid Build Coastguard Worker __u32 type; 6710*858ea5e5SAndroid Build Coastguard Worker __u32 :32; 6711*858ea5e5SAndroid Build Coastguard Worker __u64 cookie; 6712*858ea5e5SAndroid Build Coastguard Worker } event; /* BPF_PERF_EVENT_EVENT */ 6713*858ea5e5SAndroid Build Coastguard Worker }; 6714*858ea5e5SAndroid Build Coastguard Worker } perf_event; 6715*858ea5e5SAndroid Build Coastguard Worker struct { 6716*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 6717*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 6718*858ea5e5SAndroid Build Coastguard Worker } tcx; 6719*858ea5e5SAndroid Build Coastguard Worker struct { 6720*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 6721*858ea5e5SAndroid Build Coastguard Worker __u32 attach_type; 6722*858ea5e5SAndroid Build Coastguard Worker } netkit; 6723*858ea5e5SAndroid Build Coastguard Worker }; 6724*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 6725*858ea5e5SAndroid Build Coastguard Worker 6726*858ea5e5SAndroid Build Coastguard Worker /* User bpf_sock_addr struct to access socket fields and sockaddr struct passed 6727*858ea5e5SAndroid Build Coastguard Worker * by user and intended to be used by socket (e.g. to bind to, depends on 6728*858ea5e5SAndroid Build Coastguard Worker * attach type). 6729*858ea5e5SAndroid Build Coastguard Worker */ 6730*858ea5e5SAndroid Build Coastguard Worker struct bpf_sock_addr { 6731*858ea5e5SAndroid Build Coastguard Worker __u32 user_family; /* Allows 4-byte read, but no write. */ 6732*858ea5e5SAndroid Build Coastguard Worker __u32 user_ip4; /* Allows 1,2,4-byte read and 4-byte write. 6733*858ea5e5SAndroid Build Coastguard Worker * Stored in network byte order. 6734*858ea5e5SAndroid Build Coastguard Worker */ 6735*858ea5e5SAndroid Build Coastguard Worker __u32 user_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write. 6736*858ea5e5SAndroid Build Coastguard Worker * Stored in network byte order. 6737*858ea5e5SAndroid Build Coastguard Worker */ 6738*858ea5e5SAndroid Build Coastguard Worker __u32 user_port; /* Allows 1,2,4-byte read and 4-byte write. 6739*858ea5e5SAndroid Build Coastguard Worker * Stored in network byte order 6740*858ea5e5SAndroid Build Coastguard Worker */ 6741*858ea5e5SAndroid Build Coastguard Worker __u32 family; /* Allows 4-byte read, but no write */ 6742*858ea5e5SAndroid Build Coastguard Worker __u32 type; /* Allows 4-byte read, but no write */ 6743*858ea5e5SAndroid Build Coastguard Worker __u32 protocol; /* Allows 4-byte read, but no write */ 6744*858ea5e5SAndroid Build Coastguard Worker __u32 msg_src_ip4; /* Allows 1,2,4-byte read and 4-byte write. 6745*858ea5e5SAndroid Build Coastguard Worker * Stored in network byte order. 6746*858ea5e5SAndroid Build Coastguard Worker */ 6747*858ea5e5SAndroid Build Coastguard Worker __u32 msg_src_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write. 6748*858ea5e5SAndroid Build Coastguard Worker * Stored in network byte order. 6749*858ea5e5SAndroid Build Coastguard Worker */ 6750*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); 6751*858ea5e5SAndroid Build Coastguard Worker }; 6752*858ea5e5SAndroid Build Coastguard Worker 6753*858ea5e5SAndroid Build Coastguard Worker /* User bpf_sock_ops struct to access socket values and specify request ops 6754*858ea5e5SAndroid Build Coastguard Worker * and their replies. 6755*858ea5e5SAndroid Build Coastguard Worker * Some of this fields are in network (bigendian) byte order and may need 6756*858ea5e5SAndroid Build Coastguard Worker * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h). 6757*858ea5e5SAndroid Build Coastguard Worker * New fields can only be added at the end of this structure 6758*858ea5e5SAndroid Build Coastguard Worker */ 6759*858ea5e5SAndroid Build Coastguard Worker struct bpf_sock_ops { 6760*858ea5e5SAndroid Build Coastguard Worker __u32 op; 6761*858ea5e5SAndroid Build Coastguard Worker union { 6762*858ea5e5SAndroid Build Coastguard Worker __u32 args[4]; /* Optionally passed to bpf program */ 6763*858ea5e5SAndroid Build Coastguard Worker __u32 reply; /* Returned by bpf program */ 6764*858ea5e5SAndroid Build Coastguard Worker __u32 replylong[4]; /* Optionally returned by bpf prog */ 6765*858ea5e5SAndroid Build Coastguard Worker }; 6766*858ea5e5SAndroid Build Coastguard Worker __u32 family; 6767*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip4; /* Stored in network byte order */ 6768*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip4; /* Stored in network byte order */ 6769*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip6[4]; /* Stored in network byte order */ 6770*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip6[4]; /* Stored in network byte order */ 6771*858ea5e5SAndroid Build Coastguard Worker __u32 remote_port; /* Stored in network byte order */ 6772*858ea5e5SAndroid Build Coastguard Worker __u32 local_port; /* stored in host byte order */ 6773*858ea5e5SAndroid Build Coastguard Worker __u32 is_fullsock; /* Some TCP fields are only valid if 6774*858ea5e5SAndroid Build Coastguard Worker * there is a full socket. If not, the 6775*858ea5e5SAndroid Build Coastguard Worker * fields read as zero. 6776*858ea5e5SAndroid Build Coastguard Worker */ 6777*858ea5e5SAndroid Build Coastguard Worker __u32 snd_cwnd; 6778*858ea5e5SAndroid Build Coastguard Worker __u32 srtt_us; /* Averaged RTT << 3 in usecs */ 6779*858ea5e5SAndroid Build Coastguard Worker __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */ 6780*858ea5e5SAndroid Build Coastguard Worker __u32 state; 6781*858ea5e5SAndroid Build Coastguard Worker __u32 rtt_min; 6782*858ea5e5SAndroid Build Coastguard Worker __u32 snd_ssthresh; 6783*858ea5e5SAndroid Build Coastguard Worker __u32 rcv_nxt; 6784*858ea5e5SAndroid Build Coastguard Worker __u32 snd_nxt; 6785*858ea5e5SAndroid Build Coastguard Worker __u32 snd_una; 6786*858ea5e5SAndroid Build Coastguard Worker __u32 mss_cache; 6787*858ea5e5SAndroid Build Coastguard Worker __u32 ecn_flags; 6788*858ea5e5SAndroid Build Coastguard Worker __u32 rate_delivered; 6789*858ea5e5SAndroid Build Coastguard Worker __u32 rate_interval_us; 6790*858ea5e5SAndroid Build Coastguard Worker __u32 packets_out; 6791*858ea5e5SAndroid Build Coastguard Worker __u32 retrans_out; 6792*858ea5e5SAndroid Build Coastguard Worker __u32 total_retrans; 6793*858ea5e5SAndroid Build Coastguard Worker __u32 segs_in; 6794*858ea5e5SAndroid Build Coastguard Worker __u32 data_segs_in; 6795*858ea5e5SAndroid Build Coastguard Worker __u32 segs_out; 6796*858ea5e5SAndroid Build Coastguard Worker __u32 data_segs_out; 6797*858ea5e5SAndroid Build Coastguard Worker __u32 lost_out; 6798*858ea5e5SAndroid Build Coastguard Worker __u32 sacked_out; 6799*858ea5e5SAndroid Build Coastguard Worker __u32 sk_txhash; 6800*858ea5e5SAndroid Build Coastguard Worker __u64 bytes_received; 6801*858ea5e5SAndroid Build Coastguard Worker __u64 bytes_acked; 6802*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); 6803*858ea5e5SAndroid Build Coastguard Worker /* [skb_data, skb_data_end) covers the whole TCP header. 6804*858ea5e5SAndroid Build Coastguard Worker * 6805*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_PARSE_HDR_OPT_CB: The packet received 6806*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_HDR_OPT_LEN_CB: Not useful because the 6807*858ea5e5SAndroid Build Coastguard Worker * header has not been written. 6808*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_WRITE_HDR_OPT_CB: The header and options have 6809*858ea5e5SAndroid Build Coastguard Worker * been written so far. 6810*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB: The SYNACK that concludes 6811*858ea5e5SAndroid Build Coastguard Worker * the 3WHS. 6812*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB: The ACK that concludes 6813*858ea5e5SAndroid Build Coastguard Worker * the 3WHS. 6814*858ea5e5SAndroid Build Coastguard Worker * 6815*858ea5e5SAndroid Build Coastguard Worker * bpf_load_hdr_opt() can also be used to read a particular option. 6816*858ea5e5SAndroid Build Coastguard Worker */ 6817*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, skb_data); 6818*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, skb_data_end); 6819*858ea5e5SAndroid Build Coastguard Worker __u32 skb_len; /* The total length of a packet. 6820*858ea5e5SAndroid Build Coastguard Worker * It includes the header, options, 6821*858ea5e5SAndroid Build Coastguard Worker * and payload. 6822*858ea5e5SAndroid Build Coastguard Worker */ 6823*858ea5e5SAndroid Build Coastguard Worker __u32 skb_tcp_flags; /* tcp_flags of the header. It provides 6824*858ea5e5SAndroid Build Coastguard Worker * an easy way to check for tcp_flags 6825*858ea5e5SAndroid Build Coastguard Worker * without parsing skb_data. 6826*858ea5e5SAndroid Build Coastguard Worker * 6827*858ea5e5SAndroid Build Coastguard Worker * In particular, the skb_tcp_flags 6828*858ea5e5SAndroid Build Coastguard Worker * will still be available in 6829*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_HDR_OPT_LEN even though 6830*858ea5e5SAndroid Build Coastguard Worker * the outgoing header has not 6831*858ea5e5SAndroid Build Coastguard Worker * been written yet. 6832*858ea5e5SAndroid Build Coastguard Worker */ 6833*858ea5e5SAndroid Build Coastguard Worker __u64 skb_hwtstamp; 6834*858ea5e5SAndroid Build Coastguard Worker }; 6835*858ea5e5SAndroid Build Coastguard Worker 6836*858ea5e5SAndroid Build Coastguard Worker /* Definitions for bpf_sock_ops_cb_flags */ 6837*858ea5e5SAndroid Build Coastguard Worker enum { 6838*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RTO_CB_FLAG = (1<<0), 6839*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RETRANS_CB_FLAG = (1<<1), 6840*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_STATE_CB_FLAG = (1<<2), 6841*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RTT_CB_FLAG = (1<<3), 6842*858ea5e5SAndroid Build Coastguard Worker /* Call bpf for all received TCP headers. The bpf prog will be 6843*858ea5e5SAndroid Build Coastguard Worker * called under sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB 6844*858ea5e5SAndroid Build Coastguard Worker * 6845*858ea5e5SAndroid Build Coastguard Worker * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB 6846*858ea5e5SAndroid Build Coastguard Worker * for the header option related helpers that will be useful 6847*858ea5e5SAndroid Build Coastguard Worker * to the bpf programs. 6848*858ea5e5SAndroid Build Coastguard Worker * 6849*858ea5e5SAndroid Build Coastguard Worker * It could be used at the client/active side (i.e. connect() side) 6850*858ea5e5SAndroid Build Coastguard Worker * when the server told it that the server was in syncookie 6851*858ea5e5SAndroid Build Coastguard Worker * mode and required the active side to resend the bpf-written 6852*858ea5e5SAndroid Build Coastguard Worker * options. The active side can keep writing the bpf-options until 6853*858ea5e5SAndroid Build Coastguard Worker * it received a valid packet from the server side to confirm 6854*858ea5e5SAndroid Build Coastguard Worker * the earlier packet (and options) has been received. The later 6855*858ea5e5SAndroid Build Coastguard Worker * example patch is using it like this at the active side when the 6856*858ea5e5SAndroid Build Coastguard Worker * server is in syncookie mode. 6857*858ea5e5SAndroid Build Coastguard Worker * 6858*858ea5e5SAndroid Build Coastguard Worker * The bpf prog will usually turn this off in the common cases. 6859*858ea5e5SAndroid Build Coastguard Worker */ 6860*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_PARSE_ALL_HDR_OPT_CB_FLAG = (1<<4), 6861*858ea5e5SAndroid Build Coastguard Worker /* Call bpf when kernel has received a header option that 6862*858ea5e5SAndroid Build Coastguard Worker * the kernel cannot handle. The bpf prog will be called under 6863*858ea5e5SAndroid Build Coastguard Worker * sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB. 6864*858ea5e5SAndroid Build Coastguard Worker * 6865*858ea5e5SAndroid Build Coastguard Worker * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB 6866*858ea5e5SAndroid Build Coastguard Worker * for the header option related helpers that will be useful 6867*858ea5e5SAndroid Build Coastguard Worker * to the bpf programs. 6868*858ea5e5SAndroid Build Coastguard Worker */ 6869*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_PARSE_UNKNOWN_HDR_OPT_CB_FLAG = (1<<5), 6870*858ea5e5SAndroid Build Coastguard Worker /* Call bpf when the kernel is writing header options for the 6871*858ea5e5SAndroid Build Coastguard Worker * outgoing packet. The bpf prog will first be called 6872*858ea5e5SAndroid Build Coastguard Worker * to reserve space in a skb under 6873*858ea5e5SAndroid Build Coastguard Worker * sock_ops->op == BPF_SOCK_OPS_HDR_OPT_LEN_CB. Then 6874*858ea5e5SAndroid Build Coastguard Worker * the bpf prog will be called to write the header option(s) 6875*858ea5e5SAndroid Build Coastguard Worker * under sock_ops->op == BPF_SOCK_OPS_WRITE_HDR_OPT_CB. 6876*858ea5e5SAndroid Build Coastguard Worker * 6877*858ea5e5SAndroid Build Coastguard Worker * Please refer to the comment in BPF_SOCK_OPS_HDR_OPT_LEN_CB 6878*858ea5e5SAndroid Build Coastguard Worker * and BPF_SOCK_OPS_WRITE_HDR_OPT_CB for the header option 6879*858ea5e5SAndroid Build Coastguard Worker * related helpers that will be useful to the bpf programs. 6880*858ea5e5SAndroid Build Coastguard Worker * 6881*858ea5e5SAndroid Build Coastguard Worker * The kernel gets its chance to reserve space and write 6882*858ea5e5SAndroid Build Coastguard Worker * options first before the BPF program does. 6883*858ea5e5SAndroid Build Coastguard Worker */ 6884*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_WRITE_HDR_OPT_CB_FLAG = (1<<6), 6885*858ea5e5SAndroid Build Coastguard Worker /* Mask of all currently supported cb flags */ 6886*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_ALL_CB_FLAGS = 0x7F, 6887*858ea5e5SAndroid Build Coastguard Worker }; 6888*858ea5e5SAndroid Build Coastguard Worker 6889*858ea5e5SAndroid Build Coastguard Worker /* List of known BPF sock_ops operators. 6890*858ea5e5SAndroid Build Coastguard Worker * New entries can only be added at the end 6891*858ea5e5SAndroid Build Coastguard Worker */ 6892*858ea5e5SAndroid Build Coastguard Worker enum { 6893*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_VOID, 6894*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or 6895*858ea5e5SAndroid Build Coastguard Worker * -1 if default value should be used 6896*858ea5e5SAndroid Build Coastguard Worker */ 6897*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized 6898*858ea5e5SAndroid Build Coastguard Worker * window (in packets) or -1 if default 6899*858ea5e5SAndroid Build Coastguard Worker * value should be used 6900*858ea5e5SAndroid Build Coastguard Worker */ 6901*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an 6902*858ea5e5SAndroid Build Coastguard Worker * active connection is initialized 6903*858ea5e5SAndroid Build Coastguard Worker */ 6904*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an 6905*858ea5e5SAndroid Build Coastguard Worker * active connection is 6906*858ea5e5SAndroid Build Coastguard Worker * established 6907*858ea5e5SAndroid Build Coastguard Worker */ 6908*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a 6909*858ea5e5SAndroid Build Coastguard Worker * passive connection is 6910*858ea5e5SAndroid Build Coastguard Worker * established 6911*858ea5e5SAndroid Build Coastguard Worker */ 6912*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control 6913*858ea5e5SAndroid Build Coastguard Worker * needs ECN 6914*858ea5e5SAndroid Build Coastguard Worker */ 6915*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_BASE_RTT, /* Get base RTT. The correct value is 6916*858ea5e5SAndroid Build Coastguard Worker * based on the path and may be 6917*858ea5e5SAndroid Build Coastguard Worker * dependent on the congestion control 6918*858ea5e5SAndroid Build Coastguard Worker * algorithm. In general it indicates 6919*858ea5e5SAndroid Build Coastguard Worker * a congestion threshold. RTTs above 6920*858ea5e5SAndroid Build Coastguard Worker * this indicate congestion 6921*858ea5e5SAndroid Build Coastguard Worker */ 6922*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered. 6923*858ea5e5SAndroid Build Coastguard Worker * Arg1: value of icsk_retransmits 6924*858ea5e5SAndroid Build Coastguard Worker * Arg2: value of icsk_rto 6925*858ea5e5SAndroid Build Coastguard Worker * Arg3: whether RTO has expired 6926*858ea5e5SAndroid Build Coastguard Worker */ 6927*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted. 6928*858ea5e5SAndroid Build Coastguard Worker * Arg1: sequence number of 1st byte 6929*858ea5e5SAndroid Build Coastguard Worker * Arg2: # segments 6930*858ea5e5SAndroid Build Coastguard Worker * Arg3: return value of 6931*858ea5e5SAndroid Build Coastguard Worker * tcp_transmit_skb (0 => success) 6932*858ea5e5SAndroid Build Coastguard Worker */ 6933*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state. 6934*858ea5e5SAndroid Build Coastguard Worker * Arg1: old_state 6935*858ea5e5SAndroid Build Coastguard Worker * Arg2: new_state 6936*858ea5e5SAndroid Build Coastguard Worker */ 6937*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_TCP_LISTEN_CB, /* Called on listen(2), right after 6938*858ea5e5SAndroid Build Coastguard Worker * socket transition to LISTEN state. 6939*858ea5e5SAndroid Build Coastguard Worker */ 6940*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_RTT_CB, /* Called on every RTT. 6941*858ea5e5SAndroid Build Coastguard Worker */ 6942*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_PARSE_HDR_OPT_CB, /* Parse the header option. 6943*858ea5e5SAndroid Build Coastguard Worker * It will be called to handle 6944*858ea5e5SAndroid Build Coastguard Worker * the packets received at 6945*858ea5e5SAndroid Build Coastguard Worker * an already established 6946*858ea5e5SAndroid Build Coastguard Worker * connection. 6947*858ea5e5SAndroid Build Coastguard Worker * 6948*858ea5e5SAndroid Build Coastguard Worker * sock_ops->skb_data: 6949*858ea5e5SAndroid Build Coastguard Worker * Referring to the received skb. 6950*858ea5e5SAndroid Build Coastguard Worker * It covers the TCP header only. 6951*858ea5e5SAndroid Build Coastguard Worker * 6952*858ea5e5SAndroid Build Coastguard Worker * bpf_load_hdr_opt() can also 6953*858ea5e5SAndroid Build Coastguard Worker * be used to search for a 6954*858ea5e5SAndroid Build Coastguard Worker * particular option. 6955*858ea5e5SAndroid Build Coastguard Worker */ 6956*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_HDR_OPT_LEN_CB, /* Reserve space for writing the 6957*858ea5e5SAndroid Build Coastguard Worker * header option later in 6958*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_WRITE_HDR_OPT_CB. 6959*858ea5e5SAndroid Build Coastguard Worker * Arg1: bool want_cookie. (in 6960*858ea5e5SAndroid Build Coastguard Worker * writing SYNACK only) 6961*858ea5e5SAndroid Build Coastguard Worker * 6962*858ea5e5SAndroid Build Coastguard Worker * sock_ops->skb_data: 6963*858ea5e5SAndroid Build Coastguard Worker * Not available because no header has 6964*858ea5e5SAndroid Build Coastguard Worker * been written yet. 6965*858ea5e5SAndroid Build Coastguard Worker * 6966*858ea5e5SAndroid Build Coastguard Worker * sock_ops->skb_tcp_flags: 6967*858ea5e5SAndroid Build Coastguard Worker * The tcp_flags of the 6968*858ea5e5SAndroid Build Coastguard Worker * outgoing skb. (e.g. SYN, ACK, FIN). 6969*858ea5e5SAndroid Build Coastguard Worker * 6970*858ea5e5SAndroid Build Coastguard Worker * bpf_reserve_hdr_opt() should 6971*858ea5e5SAndroid Build Coastguard Worker * be used to reserve space. 6972*858ea5e5SAndroid Build Coastguard Worker */ 6973*858ea5e5SAndroid Build Coastguard Worker BPF_SOCK_OPS_WRITE_HDR_OPT_CB, /* Write the header options 6974*858ea5e5SAndroid Build Coastguard Worker * Arg1: bool want_cookie. (in 6975*858ea5e5SAndroid Build Coastguard Worker * writing SYNACK only) 6976*858ea5e5SAndroid Build Coastguard Worker * 6977*858ea5e5SAndroid Build Coastguard Worker * sock_ops->skb_data: 6978*858ea5e5SAndroid Build Coastguard Worker * Referring to the outgoing skb. 6979*858ea5e5SAndroid Build Coastguard Worker * It covers the TCP header 6980*858ea5e5SAndroid Build Coastguard Worker * that has already been written 6981*858ea5e5SAndroid Build Coastguard Worker * by the kernel and the 6982*858ea5e5SAndroid Build Coastguard Worker * earlier bpf-progs. 6983*858ea5e5SAndroid Build Coastguard Worker * 6984*858ea5e5SAndroid Build Coastguard Worker * sock_ops->skb_tcp_flags: 6985*858ea5e5SAndroid Build Coastguard Worker * The tcp_flags of the outgoing 6986*858ea5e5SAndroid Build Coastguard Worker * skb. (e.g. SYN, ACK, FIN). 6987*858ea5e5SAndroid Build Coastguard Worker * 6988*858ea5e5SAndroid Build Coastguard Worker * bpf_store_hdr_opt() should 6989*858ea5e5SAndroid Build Coastguard Worker * be used to write the 6990*858ea5e5SAndroid Build Coastguard Worker * option. 6991*858ea5e5SAndroid Build Coastguard Worker * 6992*858ea5e5SAndroid Build Coastguard Worker * bpf_load_hdr_opt() can also 6993*858ea5e5SAndroid Build Coastguard Worker * be used to search for a 6994*858ea5e5SAndroid Build Coastguard Worker * particular option that 6995*858ea5e5SAndroid Build Coastguard Worker * has already been written 6996*858ea5e5SAndroid Build Coastguard Worker * by the kernel or the 6997*858ea5e5SAndroid Build Coastguard Worker * earlier bpf-progs. 6998*858ea5e5SAndroid Build Coastguard Worker */ 6999*858ea5e5SAndroid Build Coastguard Worker }; 7000*858ea5e5SAndroid Build Coastguard Worker 7001*858ea5e5SAndroid Build Coastguard Worker /* List of TCP states. There is a build check in net/ipv4/tcp.c to detect 7002*858ea5e5SAndroid Build Coastguard Worker * changes between the TCP and BPF versions. Ideally this should never happen. 7003*858ea5e5SAndroid Build Coastguard Worker * If it does, we need to add code to convert them before calling 7004*858ea5e5SAndroid Build Coastguard Worker * the BPF sock_ops function. 7005*858ea5e5SAndroid Build Coastguard Worker */ 7006*858ea5e5SAndroid Build Coastguard Worker enum { 7007*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_ESTABLISHED = 1, 7008*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_SYN_SENT, 7009*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_SYN_RECV, 7010*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_FIN_WAIT1, 7011*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_FIN_WAIT2, 7012*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_TIME_WAIT, 7013*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_CLOSE, 7014*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_CLOSE_WAIT, 7015*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_LAST_ACK, 7016*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_LISTEN, 7017*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_CLOSING, /* Now a valid state */ 7018*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_NEW_SYN_RECV, 7019*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_BOUND_INACTIVE, 7020*858ea5e5SAndroid Build Coastguard Worker 7021*858ea5e5SAndroid Build Coastguard Worker BPF_TCP_MAX_STATES /* Leave at the end! */ 7022*858ea5e5SAndroid Build Coastguard Worker }; 7023*858ea5e5SAndroid Build Coastguard Worker 7024*858ea5e5SAndroid Build Coastguard Worker enum { 7025*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_IW = 1001, /* Set TCP initial congestion window */ 7026*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_SNDCWND_CLAMP = 1002, /* Set sndcwnd_clamp */ 7027*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_DELACK_MAX = 1003, /* Max delay ack in usecs */ 7028*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_RTO_MIN = 1004, /* Min delay ack in usecs */ 7029*858ea5e5SAndroid Build Coastguard Worker /* Copy the SYN pkt to optval 7030*858ea5e5SAndroid Build Coastguard Worker * 7031*858ea5e5SAndroid Build Coastguard Worker * BPF_PROG_TYPE_SOCK_OPS only. It is similar to the 7032*858ea5e5SAndroid Build Coastguard Worker * bpf_getsockopt(TCP_SAVED_SYN) but it does not limit 7033*858ea5e5SAndroid Build Coastguard Worker * to only getting from the saved_syn. It can either get the 7034*858ea5e5SAndroid Build Coastguard Worker * syn packet from: 7035*858ea5e5SAndroid Build Coastguard Worker * 7036*858ea5e5SAndroid Build Coastguard Worker * 1. the just-received SYN packet (only available when writing the 7037*858ea5e5SAndroid Build Coastguard Worker * SYNACK). It will be useful when it is not necessary to 7038*858ea5e5SAndroid Build Coastguard Worker * save the SYN packet for latter use. It is also the only way 7039*858ea5e5SAndroid Build Coastguard Worker * to get the SYN during syncookie mode because the syn 7040*858ea5e5SAndroid Build Coastguard Worker * packet cannot be saved during syncookie. 7041*858ea5e5SAndroid Build Coastguard Worker * 7042*858ea5e5SAndroid Build Coastguard Worker * OR 7043*858ea5e5SAndroid Build Coastguard Worker * 7044*858ea5e5SAndroid Build Coastguard Worker * 2. the earlier saved syn which was done by 7045*858ea5e5SAndroid Build Coastguard Worker * bpf_setsockopt(TCP_SAVE_SYN). 7046*858ea5e5SAndroid Build Coastguard Worker * 7047*858ea5e5SAndroid Build Coastguard Worker * The bpf_getsockopt(TCP_BPF_SYN*) option will hide where the 7048*858ea5e5SAndroid Build Coastguard Worker * SYN packet is obtained. 7049*858ea5e5SAndroid Build Coastguard Worker * 7050*858ea5e5SAndroid Build Coastguard Worker * If the bpf-prog does not need the IP[46] header, the 7051*858ea5e5SAndroid Build Coastguard Worker * bpf-prog can avoid parsing the IP header by using 7052*858ea5e5SAndroid Build Coastguard Worker * TCP_BPF_SYN. Otherwise, the bpf-prog can get both 7053*858ea5e5SAndroid Build Coastguard Worker * IP[46] and TCP header by using TCP_BPF_SYN_IP. 7054*858ea5e5SAndroid Build Coastguard Worker * 7055*858ea5e5SAndroid Build Coastguard Worker * >0: Total number of bytes copied 7056*858ea5e5SAndroid Build Coastguard Worker * -ENOSPC: Not enough space in optval. Only optlen number of 7057*858ea5e5SAndroid Build Coastguard Worker * bytes is copied. 7058*858ea5e5SAndroid Build Coastguard Worker * -ENOENT: The SYN skb is not available now and the earlier SYN pkt 7059*858ea5e5SAndroid Build Coastguard Worker * is not saved by setsockopt(TCP_SAVE_SYN). 7060*858ea5e5SAndroid Build Coastguard Worker */ 7061*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_SYN = 1005, /* Copy the TCP header */ 7062*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_SYN_IP = 1006, /* Copy the IP[46] and TCP header */ 7063*858ea5e5SAndroid Build Coastguard Worker TCP_BPF_SYN_MAC = 1007, /* Copy the MAC, IP[46], and TCP header */ 7064*858ea5e5SAndroid Build Coastguard Worker }; 7065*858ea5e5SAndroid Build Coastguard Worker 7066*858ea5e5SAndroid Build Coastguard Worker enum { 7067*858ea5e5SAndroid Build Coastguard Worker BPF_LOAD_HDR_OPT_TCP_SYN = (1ULL << 0), 7068*858ea5e5SAndroid Build Coastguard Worker }; 7069*858ea5e5SAndroid Build Coastguard Worker 7070*858ea5e5SAndroid Build Coastguard Worker /* args[0] value during BPF_SOCK_OPS_HDR_OPT_LEN_CB and 7071*858ea5e5SAndroid Build Coastguard Worker * BPF_SOCK_OPS_WRITE_HDR_OPT_CB. 7072*858ea5e5SAndroid Build Coastguard Worker */ 7073*858ea5e5SAndroid Build Coastguard Worker enum { 7074*858ea5e5SAndroid Build Coastguard Worker BPF_WRITE_HDR_TCP_CURRENT_MSS = 1, /* Kernel is finding the 7075*858ea5e5SAndroid Build Coastguard Worker * total option spaces 7076*858ea5e5SAndroid Build Coastguard Worker * required for an established 7077*858ea5e5SAndroid Build Coastguard Worker * sk in order to calculate the 7078*858ea5e5SAndroid Build Coastguard Worker * MSS. No skb is actually 7079*858ea5e5SAndroid Build Coastguard Worker * sent. 7080*858ea5e5SAndroid Build Coastguard Worker */ 7081*858ea5e5SAndroid Build Coastguard Worker BPF_WRITE_HDR_TCP_SYNACK_COOKIE = 2, /* Kernel is in syncookie mode 7082*858ea5e5SAndroid Build Coastguard Worker * when sending a SYN. 7083*858ea5e5SAndroid Build Coastguard Worker */ 7084*858ea5e5SAndroid Build Coastguard Worker }; 7085*858ea5e5SAndroid Build Coastguard Worker 7086*858ea5e5SAndroid Build Coastguard Worker struct bpf_perf_event_value { 7087*858ea5e5SAndroid Build Coastguard Worker __u64 counter; 7088*858ea5e5SAndroid Build Coastguard Worker __u64 enabled; 7089*858ea5e5SAndroid Build Coastguard Worker __u64 running; 7090*858ea5e5SAndroid Build Coastguard Worker }; 7091*858ea5e5SAndroid Build Coastguard Worker 7092*858ea5e5SAndroid Build Coastguard Worker enum { 7093*858ea5e5SAndroid Build Coastguard Worker BPF_DEVCG_ACC_MKNOD = (1ULL << 0), 7094*858ea5e5SAndroid Build Coastguard Worker BPF_DEVCG_ACC_READ = (1ULL << 1), 7095*858ea5e5SAndroid Build Coastguard Worker BPF_DEVCG_ACC_WRITE = (1ULL << 2), 7096*858ea5e5SAndroid Build Coastguard Worker }; 7097*858ea5e5SAndroid Build Coastguard Worker 7098*858ea5e5SAndroid Build Coastguard Worker enum { 7099*858ea5e5SAndroid Build Coastguard Worker BPF_DEVCG_DEV_BLOCK = (1ULL << 0), 7100*858ea5e5SAndroid Build Coastguard Worker BPF_DEVCG_DEV_CHAR = (1ULL << 1), 7101*858ea5e5SAndroid Build Coastguard Worker }; 7102*858ea5e5SAndroid Build Coastguard Worker 7103*858ea5e5SAndroid Build Coastguard Worker struct bpf_cgroup_dev_ctx { 7104*858ea5e5SAndroid Build Coastguard Worker /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */ 7105*858ea5e5SAndroid Build Coastguard Worker __u32 access_type; 7106*858ea5e5SAndroid Build Coastguard Worker __u32 major; 7107*858ea5e5SAndroid Build Coastguard Worker __u32 minor; 7108*858ea5e5SAndroid Build Coastguard Worker }; 7109*858ea5e5SAndroid Build Coastguard Worker 7110*858ea5e5SAndroid Build Coastguard Worker struct bpf_raw_tracepoint_args { 7111*858ea5e5SAndroid Build Coastguard Worker __u64 args[0]; 7112*858ea5e5SAndroid Build Coastguard Worker }; 7113*858ea5e5SAndroid Build Coastguard Worker 7114*858ea5e5SAndroid Build Coastguard Worker /* DIRECT: Skip the FIB rules and go to FIB table associated with device 7115*858ea5e5SAndroid Build Coastguard Worker * OUTPUT: Do lookup from egress perspective; default is ingress 7116*858ea5e5SAndroid Build Coastguard Worker */ 7117*858ea5e5SAndroid Build Coastguard Worker enum { 7118*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LOOKUP_DIRECT = (1U << 0), 7119*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LOOKUP_OUTPUT = (1U << 1), 7120*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LOOKUP_SKIP_NEIGH = (1U << 2), 7121*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LOOKUP_TBID = (1U << 3), 7122*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LOOKUP_SRC = (1U << 4), 7123*858ea5e5SAndroid Build Coastguard Worker }; 7124*858ea5e5SAndroid Build Coastguard Worker 7125*858ea5e5SAndroid Build Coastguard Worker enum { 7126*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_SUCCESS, /* lookup successful */ 7127*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_BLACKHOLE, /* dest is blackholed; can be dropped */ 7128*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_UNREACHABLE, /* dest is unreachable; can be dropped */ 7129*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_PROHIBIT, /* dest not allowed; can be dropped */ 7130*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_NOT_FWDED, /* packet is not forwarded */ 7131*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */ 7132*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_UNSUPP_LWT, /* fwd requires encapsulation */ 7133*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_NO_NEIGH, /* no neighbor entry for nh */ 7134*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_FRAG_NEEDED, /* fragmentation required to fwd */ 7135*858ea5e5SAndroid Build Coastguard Worker BPF_FIB_LKUP_RET_NO_SRC_ADDR, /* failed to derive IP src addr */ 7136*858ea5e5SAndroid Build Coastguard Worker }; 7137*858ea5e5SAndroid Build Coastguard Worker 7138*858ea5e5SAndroid Build Coastguard Worker struct bpf_fib_lookup { 7139*858ea5e5SAndroid Build Coastguard Worker /* input: network family for lookup (AF_INET, AF_INET6) 7140*858ea5e5SAndroid Build Coastguard Worker * output: network family of egress nexthop 7141*858ea5e5SAndroid Build Coastguard Worker */ 7142*858ea5e5SAndroid Build Coastguard Worker __u8 family; 7143*858ea5e5SAndroid Build Coastguard Worker 7144*858ea5e5SAndroid Build Coastguard Worker /* set if lookup is to consider L4 data - e.g., FIB rules */ 7145*858ea5e5SAndroid Build Coastguard Worker __u8 l4_protocol; 7146*858ea5e5SAndroid Build Coastguard Worker __be16 sport; 7147*858ea5e5SAndroid Build Coastguard Worker __be16 dport; 7148*858ea5e5SAndroid Build Coastguard Worker 7149*858ea5e5SAndroid Build Coastguard Worker union { /* used for MTU check */ 7150*858ea5e5SAndroid Build Coastguard Worker /* input to lookup */ 7151*858ea5e5SAndroid Build Coastguard Worker __u16 tot_len; /* L3 length from network hdr (iph->tot_len) */ 7152*858ea5e5SAndroid Build Coastguard Worker 7153*858ea5e5SAndroid Build Coastguard Worker /* output: MTU value */ 7154*858ea5e5SAndroid Build Coastguard Worker __u16 mtu_result; 7155*858ea5e5SAndroid Build Coastguard Worker }; 7156*858ea5e5SAndroid Build Coastguard Worker /* input: L3 device index for lookup 7157*858ea5e5SAndroid Build Coastguard Worker * output: device index from FIB lookup 7158*858ea5e5SAndroid Build Coastguard Worker */ 7159*858ea5e5SAndroid Build Coastguard Worker __u32 ifindex; 7160*858ea5e5SAndroid Build Coastguard Worker 7161*858ea5e5SAndroid Build Coastguard Worker union { 7162*858ea5e5SAndroid Build Coastguard Worker /* inputs to lookup */ 7163*858ea5e5SAndroid Build Coastguard Worker __u8 tos; /* AF_INET */ 7164*858ea5e5SAndroid Build Coastguard Worker __be32 flowinfo; /* AF_INET6, flow_label + priority */ 7165*858ea5e5SAndroid Build Coastguard Worker 7166*858ea5e5SAndroid Build Coastguard Worker /* output: metric of fib result (IPv4/IPv6 only) */ 7167*858ea5e5SAndroid Build Coastguard Worker __u32 rt_metric; 7168*858ea5e5SAndroid Build Coastguard Worker }; 7169*858ea5e5SAndroid Build Coastguard Worker 7170*858ea5e5SAndroid Build Coastguard Worker /* input: source address to consider for lookup 7171*858ea5e5SAndroid Build Coastguard Worker * output: source address result from lookup 7172*858ea5e5SAndroid Build Coastguard Worker */ 7173*858ea5e5SAndroid Build Coastguard Worker union { 7174*858ea5e5SAndroid Build Coastguard Worker __be32 ipv4_src; 7175*858ea5e5SAndroid Build Coastguard Worker __u32 ipv6_src[4]; /* in6_addr; network order */ 7176*858ea5e5SAndroid Build Coastguard Worker }; 7177*858ea5e5SAndroid Build Coastguard Worker 7178*858ea5e5SAndroid Build Coastguard Worker /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in 7179*858ea5e5SAndroid Build Coastguard Worker * network header. output: bpf_fib_lookup sets to gateway address 7180*858ea5e5SAndroid Build Coastguard Worker * if FIB lookup returns gateway route 7181*858ea5e5SAndroid Build Coastguard Worker */ 7182*858ea5e5SAndroid Build Coastguard Worker union { 7183*858ea5e5SAndroid Build Coastguard Worker __be32 ipv4_dst; 7184*858ea5e5SAndroid Build Coastguard Worker __u32 ipv6_dst[4]; /* in6_addr; network order */ 7185*858ea5e5SAndroid Build Coastguard Worker }; 7186*858ea5e5SAndroid Build Coastguard Worker 7187*858ea5e5SAndroid Build Coastguard Worker union { 7188*858ea5e5SAndroid Build Coastguard Worker struct { 7189*858ea5e5SAndroid Build Coastguard Worker /* output */ 7190*858ea5e5SAndroid Build Coastguard Worker __be16 h_vlan_proto; 7191*858ea5e5SAndroid Build Coastguard Worker __be16 h_vlan_TCI; 7192*858ea5e5SAndroid Build Coastguard Worker }; 7193*858ea5e5SAndroid Build Coastguard Worker /* input: when accompanied with the 7194*858ea5e5SAndroid Build Coastguard Worker * 'BPF_FIB_LOOKUP_DIRECT | BPF_FIB_LOOKUP_TBID` flags, a 7195*858ea5e5SAndroid Build Coastguard Worker * specific routing table to use for the fib lookup. 7196*858ea5e5SAndroid Build Coastguard Worker */ 7197*858ea5e5SAndroid Build Coastguard Worker __u32 tbid; 7198*858ea5e5SAndroid Build Coastguard Worker }; 7199*858ea5e5SAndroid Build Coastguard Worker 7200*858ea5e5SAndroid Build Coastguard Worker __u8 smac[6]; /* ETH_ALEN */ 7201*858ea5e5SAndroid Build Coastguard Worker __u8 dmac[6]; /* ETH_ALEN */ 7202*858ea5e5SAndroid Build Coastguard Worker }; 7203*858ea5e5SAndroid Build Coastguard Worker 7204*858ea5e5SAndroid Build Coastguard Worker struct bpf_redir_neigh { 7205*858ea5e5SAndroid Build Coastguard Worker /* network family for lookup (AF_INET, AF_INET6) */ 7206*858ea5e5SAndroid Build Coastguard Worker __u32 nh_family; 7207*858ea5e5SAndroid Build Coastguard Worker /* network address of nexthop; skips fib lookup to find gateway */ 7208*858ea5e5SAndroid Build Coastguard Worker union { 7209*858ea5e5SAndroid Build Coastguard Worker __be32 ipv4_nh; 7210*858ea5e5SAndroid Build Coastguard Worker __u32 ipv6_nh[4]; /* in6_addr; network order */ 7211*858ea5e5SAndroid Build Coastguard Worker }; 7212*858ea5e5SAndroid Build Coastguard Worker }; 7213*858ea5e5SAndroid Build Coastguard Worker 7214*858ea5e5SAndroid Build Coastguard Worker /* bpf_check_mtu flags*/ 7215*858ea5e5SAndroid Build Coastguard Worker enum bpf_check_mtu_flags { 7216*858ea5e5SAndroid Build Coastguard Worker BPF_MTU_CHK_SEGS = (1U << 0), 7217*858ea5e5SAndroid Build Coastguard Worker }; 7218*858ea5e5SAndroid Build Coastguard Worker 7219*858ea5e5SAndroid Build Coastguard Worker enum bpf_check_mtu_ret { 7220*858ea5e5SAndroid Build Coastguard Worker BPF_MTU_CHK_RET_SUCCESS, /* check and lookup successful */ 7221*858ea5e5SAndroid Build Coastguard Worker BPF_MTU_CHK_RET_FRAG_NEEDED, /* fragmentation required to fwd */ 7222*858ea5e5SAndroid Build Coastguard Worker BPF_MTU_CHK_RET_SEGS_TOOBIG, /* GSO re-segmentation needed to fwd */ 7223*858ea5e5SAndroid Build Coastguard Worker }; 7224*858ea5e5SAndroid Build Coastguard Worker 7225*858ea5e5SAndroid Build Coastguard Worker enum bpf_task_fd_type { 7226*858ea5e5SAndroid Build Coastguard Worker BPF_FD_TYPE_RAW_TRACEPOINT, /* tp name */ 7227*858ea5e5SAndroid Build Coastguard Worker BPF_FD_TYPE_TRACEPOINT, /* tp name */ 7228*858ea5e5SAndroid Build Coastguard Worker BPF_FD_TYPE_KPROBE, /* (symbol + offset) or addr */ 7229*858ea5e5SAndroid Build Coastguard Worker BPF_FD_TYPE_KRETPROBE, /* (symbol + offset) or addr */ 7230*858ea5e5SAndroid Build Coastguard Worker BPF_FD_TYPE_UPROBE, /* filename + offset */ 7231*858ea5e5SAndroid Build Coastguard Worker BPF_FD_TYPE_URETPROBE, /* filename + offset */ 7232*858ea5e5SAndroid Build Coastguard Worker }; 7233*858ea5e5SAndroid Build Coastguard Worker 7234*858ea5e5SAndroid Build Coastguard Worker enum { 7235*858ea5e5SAndroid Build Coastguard Worker BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG = (1U << 0), 7236*858ea5e5SAndroid Build Coastguard Worker BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL = (1U << 1), 7237*858ea5e5SAndroid Build Coastguard Worker BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP = (1U << 2), 7238*858ea5e5SAndroid Build Coastguard Worker }; 7239*858ea5e5SAndroid Build Coastguard Worker 7240*858ea5e5SAndroid Build Coastguard Worker struct bpf_flow_keys { 7241*858ea5e5SAndroid Build Coastguard Worker __u16 nhoff; 7242*858ea5e5SAndroid Build Coastguard Worker __u16 thoff; 7243*858ea5e5SAndroid Build Coastguard Worker __u16 addr_proto; /* ETH_P_* of valid addrs */ 7244*858ea5e5SAndroid Build Coastguard Worker __u8 is_frag; 7245*858ea5e5SAndroid Build Coastguard Worker __u8 is_first_frag; 7246*858ea5e5SAndroid Build Coastguard Worker __u8 is_encap; 7247*858ea5e5SAndroid Build Coastguard Worker __u8 ip_proto; 7248*858ea5e5SAndroid Build Coastguard Worker __be16 n_proto; 7249*858ea5e5SAndroid Build Coastguard Worker __be16 sport; 7250*858ea5e5SAndroid Build Coastguard Worker __be16 dport; 7251*858ea5e5SAndroid Build Coastguard Worker union { 7252*858ea5e5SAndroid Build Coastguard Worker struct { 7253*858ea5e5SAndroid Build Coastguard Worker __be32 ipv4_src; 7254*858ea5e5SAndroid Build Coastguard Worker __be32 ipv4_dst; 7255*858ea5e5SAndroid Build Coastguard Worker }; 7256*858ea5e5SAndroid Build Coastguard Worker struct { 7257*858ea5e5SAndroid Build Coastguard Worker __u32 ipv6_src[4]; /* in6_addr; network order */ 7258*858ea5e5SAndroid Build Coastguard Worker __u32 ipv6_dst[4]; /* in6_addr; network order */ 7259*858ea5e5SAndroid Build Coastguard Worker }; 7260*858ea5e5SAndroid Build Coastguard Worker }; 7261*858ea5e5SAndroid Build Coastguard Worker __u32 flags; 7262*858ea5e5SAndroid Build Coastguard Worker __be32 flow_label; 7263*858ea5e5SAndroid Build Coastguard Worker }; 7264*858ea5e5SAndroid Build Coastguard Worker 7265*858ea5e5SAndroid Build Coastguard Worker struct bpf_func_info { 7266*858ea5e5SAndroid Build Coastguard Worker __u32 insn_off; 7267*858ea5e5SAndroid Build Coastguard Worker __u32 type_id; 7268*858ea5e5SAndroid Build Coastguard Worker }; 7269*858ea5e5SAndroid Build Coastguard Worker 7270*858ea5e5SAndroid Build Coastguard Worker #define BPF_LINE_INFO_LINE_NUM(line_col) ((line_col) >> 10) 7271*858ea5e5SAndroid Build Coastguard Worker #define BPF_LINE_INFO_LINE_COL(line_col) ((line_col) & 0x3ff) 7272*858ea5e5SAndroid Build Coastguard Worker 7273*858ea5e5SAndroid Build Coastguard Worker struct bpf_line_info { 7274*858ea5e5SAndroid Build Coastguard Worker __u32 insn_off; 7275*858ea5e5SAndroid Build Coastguard Worker __u32 file_name_off; 7276*858ea5e5SAndroid Build Coastguard Worker __u32 line_off; 7277*858ea5e5SAndroid Build Coastguard Worker __u32 line_col; 7278*858ea5e5SAndroid Build Coastguard Worker }; 7279*858ea5e5SAndroid Build Coastguard Worker 7280*858ea5e5SAndroid Build Coastguard Worker struct bpf_spin_lock { 7281*858ea5e5SAndroid Build Coastguard Worker __u32 val; 7282*858ea5e5SAndroid Build Coastguard Worker }; 7283*858ea5e5SAndroid Build Coastguard Worker 7284*858ea5e5SAndroid Build Coastguard Worker struct bpf_timer { 7285*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[2]; 7286*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7287*858ea5e5SAndroid Build Coastguard Worker 7288*858ea5e5SAndroid Build Coastguard Worker struct bpf_dynptr { 7289*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[2]; 7290*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7291*858ea5e5SAndroid Build Coastguard Worker 7292*858ea5e5SAndroid Build Coastguard Worker struct bpf_list_head { 7293*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[2]; 7294*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7295*858ea5e5SAndroid Build Coastguard Worker 7296*858ea5e5SAndroid Build Coastguard Worker struct bpf_list_node { 7297*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[3]; 7298*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7299*858ea5e5SAndroid Build Coastguard Worker 7300*858ea5e5SAndroid Build Coastguard Worker struct bpf_rb_root { 7301*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[2]; 7302*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7303*858ea5e5SAndroid Build Coastguard Worker 7304*858ea5e5SAndroid Build Coastguard Worker struct bpf_rb_node { 7305*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[4]; 7306*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7307*858ea5e5SAndroid Build Coastguard Worker 7308*858ea5e5SAndroid Build Coastguard Worker struct bpf_refcount { 7309*858ea5e5SAndroid Build Coastguard Worker __u32 __opaque[1]; 7310*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(4))); 7311*858ea5e5SAndroid Build Coastguard Worker 7312*858ea5e5SAndroid Build Coastguard Worker struct bpf_sysctl { 7313*858ea5e5SAndroid Build Coastguard Worker __u32 write; /* Sysctl is being read (= 0) or written (= 1). 7314*858ea5e5SAndroid Build Coastguard Worker * Allows 1,2,4-byte read, but no write. 7315*858ea5e5SAndroid Build Coastguard Worker */ 7316*858ea5e5SAndroid Build Coastguard Worker __u32 file_pos; /* Sysctl file position to read from, write to. 7317*858ea5e5SAndroid Build Coastguard Worker * Allows 1,2,4-byte read an 4-byte write. 7318*858ea5e5SAndroid Build Coastguard Worker */ 7319*858ea5e5SAndroid Build Coastguard Worker }; 7320*858ea5e5SAndroid Build Coastguard Worker 7321*858ea5e5SAndroid Build Coastguard Worker struct bpf_sockopt { 7322*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); 7323*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, optval); 7324*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(void *, optval_end); 7325*858ea5e5SAndroid Build Coastguard Worker 7326*858ea5e5SAndroid Build Coastguard Worker __s32 level; 7327*858ea5e5SAndroid Build Coastguard Worker __s32 optname; 7328*858ea5e5SAndroid Build Coastguard Worker __s32 optlen; 7329*858ea5e5SAndroid Build Coastguard Worker __s32 retval; 7330*858ea5e5SAndroid Build Coastguard Worker }; 7331*858ea5e5SAndroid Build Coastguard Worker 7332*858ea5e5SAndroid Build Coastguard Worker struct bpf_pidns_info { 7333*858ea5e5SAndroid Build Coastguard Worker __u32 pid; 7334*858ea5e5SAndroid Build Coastguard Worker __u32 tgid; 7335*858ea5e5SAndroid Build Coastguard Worker }; 7336*858ea5e5SAndroid Build Coastguard Worker 7337*858ea5e5SAndroid Build Coastguard Worker /* User accessible data for SK_LOOKUP programs. Add new fields at the end. */ 7338*858ea5e5SAndroid Build Coastguard Worker struct bpf_sk_lookup { 7339*858ea5e5SAndroid Build Coastguard Worker union { 7340*858ea5e5SAndroid Build Coastguard Worker __bpf_md_ptr(struct bpf_sock *, sk); /* Selected socket */ 7341*858ea5e5SAndroid Build Coastguard Worker __u64 cookie; /* Non-zero if socket was selected in PROG_TEST_RUN */ 7342*858ea5e5SAndroid Build Coastguard Worker }; 7343*858ea5e5SAndroid Build Coastguard Worker 7344*858ea5e5SAndroid Build Coastguard Worker __u32 family; /* Protocol family (AF_INET, AF_INET6) */ 7345*858ea5e5SAndroid Build Coastguard Worker __u32 protocol; /* IP protocol (IPPROTO_TCP, IPPROTO_UDP) */ 7346*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip4; /* Network byte order */ 7347*858ea5e5SAndroid Build Coastguard Worker __u32 remote_ip6[4]; /* Network byte order */ 7348*858ea5e5SAndroid Build Coastguard Worker __be16 remote_port; /* Network byte order */ 7349*858ea5e5SAndroid Build Coastguard Worker __u16 :16; /* Zero padding */ 7350*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip4; /* Network byte order */ 7351*858ea5e5SAndroid Build Coastguard Worker __u32 local_ip6[4]; /* Network byte order */ 7352*858ea5e5SAndroid Build Coastguard Worker __u32 local_port; /* Host byte order */ 7353*858ea5e5SAndroid Build Coastguard Worker __u32 ingress_ifindex; /* The arriving interface. Determined by inet_iif. */ 7354*858ea5e5SAndroid Build Coastguard Worker }; 7355*858ea5e5SAndroid Build Coastguard Worker 7356*858ea5e5SAndroid Build Coastguard Worker /* 7357*858ea5e5SAndroid Build Coastguard Worker * struct btf_ptr is used for typed pointer representation; the 7358*858ea5e5SAndroid Build Coastguard Worker * type id is used to render the pointer data as the appropriate type 7359*858ea5e5SAndroid Build Coastguard Worker * via the bpf_snprintf_btf() helper described above. A flags field - 7360*858ea5e5SAndroid Build Coastguard Worker * potentially to specify additional details about the BTF pointer 7361*858ea5e5SAndroid Build Coastguard Worker * (rather than its mode of display) - is included for future use. 7362*858ea5e5SAndroid Build Coastguard Worker * Display flags - BTF_F_* - are passed to bpf_snprintf_btf separately. 7363*858ea5e5SAndroid Build Coastguard Worker */ 7364*858ea5e5SAndroid Build Coastguard Worker struct btf_ptr { 7365*858ea5e5SAndroid Build Coastguard Worker void *ptr; 7366*858ea5e5SAndroid Build Coastguard Worker __u32 type_id; 7367*858ea5e5SAndroid Build Coastguard Worker __u32 flags; /* BTF ptr flags; unused at present. */ 7368*858ea5e5SAndroid Build Coastguard Worker }; 7369*858ea5e5SAndroid Build Coastguard Worker 7370*858ea5e5SAndroid Build Coastguard Worker /* 7371*858ea5e5SAndroid Build Coastguard Worker * Flags to control bpf_snprintf_btf() behaviour. 7372*858ea5e5SAndroid Build Coastguard Worker * - BTF_F_COMPACT: no formatting around type information 7373*858ea5e5SAndroid Build Coastguard Worker * - BTF_F_NONAME: no struct/union member names/types 7374*858ea5e5SAndroid Build Coastguard Worker * - BTF_F_PTR_RAW: show raw (unobfuscated) pointer values; 7375*858ea5e5SAndroid Build Coastguard Worker * equivalent to %px. 7376*858ea5e5SAndroid Build Coastguard Worker * - BTF_F_ZERO: show zero-valued struct/union members; they 7377*858ea5e5SAndroid Build Coastguard Worker * are not displayed by default 7378*858ea5e5SAndroid Build Coastguard Worker */ 7379*858ea5e5SAndroid Build Coastguard Worker enum { 7380*858ea5e5SAndroid Build Coastguard Worker BTF_F_COMPACT = (1ULL << 0), 7381*858ea5e5SAndroid Build Coastguard Worker BTF_F_NONAME = (1ULL << 1), 7382*858ea5e5SAndroid Build Coastguard Worker BTF_F_PTR_RAW = (1ULL << 2), 7383*858ea5e5SAndroid Build Coastguard Worker BTF_F_ZERO = (1ULL << 3), 7384*858ea5e5SAndroid Build Coastguard Worker }; 7385*858ea5e5SAndroid Build Coastguard Worker 7386*858ea5e5SAndroid Build Coastguard Worker /* bpf_core_relo_kind encodes which aspect of captured field/type/enum value 7387*858ea5e5SAndroid Build Coastguard Worker * has to be adjusted by relocations. It is emitted by llvm and passed to 7388*858ea5e5SAndroid Build Coastguard Worker * libbpf and later to the kernel. 7389*858ea5e5SAndroid Build Coastguard Worker */ 7390*858ea5e5SAndroid Build Coastguard Worker enum bpf_core_relo_kind { 7391*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_FIELD_BYTE_OFFSET = 0, /* field byte offset */ 7392*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_FIELD_BYTE_SIZE = 1, /* field size in bytes */ 7393*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_FIELD_EXISTS = 2, /* field existence in target kernel */ 7394*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_FIELD_SIGNED = 3, /* field signedness (0 - unsigned, 1 - signed) */ 7395*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_FIELD_LSHIFT_U64 = 4, /* bitfield-specific left bitshift */ 7396*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_FIELD_RSHIFT_U64 = 5, /* bitfield-specific right bitshift */ 7397*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_TYPE_ID_LOCAL = 6, /* type ID in local BPF object */ 7398*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_TYPE_ID_TARGET = 7, /* type ID in target kernel */ 7399*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_TYPE_EXISTS = 8, /* type existence in target kernel */ 7400*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_TYPE_SIZE = 9, /* type size in bytes */ 7401*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_ENUMVAL_EXISTS = 10, /* enum value existence in target kernel */ 7402*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_ENUMVAL_VALUE = 11, /* enum value integer value */ 7403*858ea5e5SAndroid Build Coastguard Worker BPF_CORE_TYPE_MATCHES = 12, /* type match in target kernel */ 7404*858ea5e5SAndroid Build Coastguard Worker }; 7405*858ea5e5SAndroid Build Coastguard Worker 7406*858ea5e5SAndroid Build Coastguard Worker /* 7407*858ea5e5SAndroid Build Coastguard Worker * "struct bpf_core_relo" is used to pass relocation data form LLVM to libbpf 7408*858ea5e5SAndroid Build Coastguard Worker * and from libbpf to the kernel. 7409*858ea5e5SAndroid Build Coastguard Worker * 7410*858ea5e5SAndroid Build Coastguard Worker * CO-RE relocation captures the following data: 7411*858ea5e5SAndroid Build Coastguard Worker * - insn_off - instruction offset (in bytes) within a BPF program that needs 7412*858ea5e5SAndroid Build Coastguard Worker * its insn->imm field to be relocated with actual field info; 7413*858ea5e5SAndroid Build Coastguard Worker * - type_id - BTF type ID of the "root" (containing) entity of a relocatable 7414*858ea5e5SAndroid Build Coastguard Worker * type or field; 7415*858ea5e5SAndroid Build Coastguard Worker * - access_str_off - offset into corresponding .BTF string section. String 7416*858ea5e5SAndroid Build Coastguard Worker * interpretation depends on specific relocation kind: 7417*858ea5e5SAndroid Build Coastguard Worker * - for field-based relocations, string encodes an accessed field using 7418*858ea5e5SAndroid Build Coastguard Worker * a sequence of field and array indices, separated by colon (:). It's 7419*858ea5e5SAndroid Build Coastguard Worker * conceptually very close to LLVM's getelementptr ([0]) instruction's 7420*858ea5e5SAndroid Build Coastguard Worker * arguments for identifying offset to a field. 7421*858ea5e5SAndroid Build Coastguard Worker * - for type-based relocations, strings is expected to be just "0"; 7422*858ea5e5SAndroid Build Coastguard Worker * - for enum value-based relocations, string contains an index of enum 7423*858ea5e5SAndroid Build Coastguard Worker * value within its enum type; 7424*858ea5e5SAndroid Build Coastguard Worker * - kind - one of enum bpf_core_relo_kind; 7425*858ea5e5SAndroid Build Coastguard Worker * 7426*858ea5e5SAndroid Build Coastguard Worker * Example: 7427*858ea5e5SAndroid Build Coastguard Worker * struct sample { 7428*858ea5e5SAndroid Build Coastguard Worker * int a; 7429*858ea5e5SAndroid Build Coastguard Worker * struct { 7430*858ea5e5SAndroid Build Coastguard Worker * int b[10]; 7431*858ea5e5SAndroid Build Coastguard Worker * }; 7432*858ea5e5SAndroid Build Coastguard Worker * }; 7433*858ea5e5SAndroid Build Coastguard Worker * 7434*858ea5e5SAndroid Build Coastguard Worker * struct sample *s = ...; 7435*858ea5e5SAndroid Build Coastguard Worker * int *x = &s->a; // encoded as "0:0" (a is field #0) 7436*858ea5e5SAndroid Build Coastguard Worker * int *y = &s->b[5]; // encoded as "0:1:0:5" (anon struct is field #1, 7437*858ea5e5SAndroid Build Coastguard Worker * // b is field #0 inside anon struct, accessing elem #5) 7438*858ea5e5SAndroid Build Coastguard Worker * int *z = &s[10]->b; // encoded as "10:1" (ptr is used as an array) 7439*858ea5e5SAndroid Build Coastguard Worker * 7440*858ea5e5SAndroid Build Coastguard Worker * type_id for all relocs in this example will capture BTF type id of 7441*858ea5e5SAndroid Build Coastguard Worker * `struct sample`. 7442*858ea5e5SAndroid Build Coastguard Worker * 7443*858ea5e5SAndroid Build Coastguard Worker * Such relocation is emitted when using __builtin_preserve_access_index() 7444*858ea5e5SAndroid Build Coastguard Worker * Clang built-in, passing expression that captures field address, e.g.: 7445*858ea5e5SAndroid Build Coastguard Worker * 7446*858ea5e5SAndroid Build Coastguard Worker * bpf_probe_read(&dst, sizeof(dst), 7447*858ea5e5SAndroid Build Coastguard Worker * __builtin_preserve_access_index(&src->a.b.c)); 7448*858ea5e5SAndroid Build Coastguard Worker * 7449*858ea5e5SAndroid Build Coastguard Worker * In this case Clang will emit field relocation recording necessary data to 7450*858ea5e5SAndroid Build Coastguard Worker * be able to find offset of embedded `a.b.c` field within `src` struct. 7451*858ea5e5SAndroid Build Coastguard Worker * 7452*858ea5e5SAndroid Build Coastguard Worker * [0] https://llvm.org/docs/LangRef.html#getelementptr-instruction 7453*858ea5e5SAndroid Build Coastguard Worker */ 7454*858ea5e5SAndroid Build Coastguard Worker struct bpf_core_relo { 7455*858ea5e5SAndroid Build Coastguard Worker __u32 insn_off; 7456*858ea5e5SAndroid Build Coastguard Worker __u32 type_id; 7457*858ea5e5SAndroid Build Coastguard Worker __u32 access_str_off; 7458*858ea5e5SAndroid Build Coastguard Worker enum bpf_core_relo_kind kind; 7459*858ea5e5SAndroid Build Coastguard Worker }; 7460*858ea5e5SAndroid Build Coastguard Worker 7461*858ea5e5SAndroid Build Coastguard Worker /* 7462*858ea5e5SAndroid Build Coastguard Worker * Flags to control bpf_timer_start() behaviour. 7463*858ea5e5SAndroid Build Coastguard Worker * - BPF_F_TIMER_ABS: Timeout passed is absolute time, by default it is 7464*858ea5e5SAndroid Build Coastguard Worker * relative to current time. 7465*858ea5e5SAndroid Build Coastguard Worker * - BPF_F_TIMER_CPU_PIN: Timer will be pinned to the CPU of the caller. 7466*858ea5e5SAndroid Build Coastguard Worker */ 7467*858ea5e5SAndroid Build Coastguard Worker enum { 7468*858ea5e5SAndroid Build Coastguard Worker BPF_F_TIMER_ABS = (1ULL << 0), 7469*858ea5e5SAndroid Build Coastguard Worker BPF_F_TIMER_CPU_PIN = (1ULL << 1), 7470*858ea5e5SAndroid Build Coastguard Worker }; 7471*858ea5e5SAndroid Build Coastguard Worker 7472*858ea5e5SAndroid Build Coastguard Worker /* BPF numbers iterator state */ 7473*858ea5e5SAndroid Build Coastguard Worker struct bpf_iter_num { 7474*858ea5e5SAndroid Build Coastguard Worker /* opaque iterator state; having __u64 here allows to preserve correct 7475*858ea5e5SAndroid Build Coastguard Worker * alignment requirements in vmlinux.h, generated from BTF 7476*858ea5e5SAndroid Build Coastguard Worker */ 7477*858ea5e5SAndroid Build Coastguard Worker __u64 __opaque[1]; 7478*858ea5e5SAndroid Build Coastguard Worker } __attribute__((aligned(8))); 7479*858ea5e5SAndroid Build Coastguard Worker 7480*858ea5e5SAndroid Build Coastguard Worker #endif /* _UAPI__LINUX_BPF_H__ */ 7481