at v5.14 229 kB view raw
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com 3 * 4 * This program is free software; you can redistribute it and/or 5 * modify it under the terms of version 2 of the GNU General Public 6 * License as published by the Free Software Foundation. 7 */ 8#ifndef _UAPI__LINUX_BPF_H__ 9#define _UAPI__LINUX_BPF_H__ 10 11#include <linux/types.h> 12#include <linux/bpf_common.h> 13 14/* Extended instruction set based on top of classic BPF */ 15 16/* instruction classes */ 17#define BPF_JMP32 0x06 /* jmp mode in word width */ 18#define BPF_ALU64 0x07 /* alu mode in double word width */ 19 20/* ld/ldx fields */ 21#define BPF_DW 0x18 /* double word (64-bit) */ 22#define BPF_ATOMIC 0xc0 /* atomic memory ops - op type in immediate */ 23#define BPF_XADD 0xc0 /* exclusive add - legacy name */ 24 25/* alu/jmp fields */ 26#define BPF_MOV 0xb0 /* mov reg to reg */ 27#define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */ 28 29/* change endianness of a register */ 30#define BPF_END 0xd0 /* flags for endianness conversion: */ 31#define BPF_TO_LE 0x00 /* convert to little-endian */ 32#define BPF_TO_BE 0x08 /* convert to big-endian */ 33#define BPF_FROM_LE BPF_TO_LE 34#define BPF_FROM_BE BPF_TO_BE 35 36/* jmp encodings */ 37#define BPF_JNE 0x50 /* jump != */ 38#define BPF_JLT 0xa0 /* LT is unsigned, '<' */ 39#define BPF_JLE 0xb0 /* LE is unsigned, '<=' */ 40#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */ 41#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */ 42#define BPF_JSLT 0xc0 /* SLT is signed, '<' */ 43#define BPF_JSLE 0xd0 /* SLE is signed, '<=' */ 44#define BPF_CALL 0x80 /* function call */ 45#define BPF_EXIT 0x90 /* function return */ 46 47/* atomic op type fields (stored in immediate) */ 48#define BPF_FETCH 0x01 /* not an opcode on its own, used to build others */ 49#define BPF_XCHG (0xe0 | BPF_FETCH) /* atomic exchange */ 50#define BPF_CMPXCHG (0xf0 | BPF_FETCH) /* atomic compare-and-write */ 51 52/* Register numbers */ 53enum { 54 BPF_REG_0 = 0, 55 BPF_REG_1, 56 BPF_REG_2, 57 BPF_REG_3, 58 BPF_REG_4, 59 BPF_REG_5, 60 BPF_REG_6, 61 BPF_REG_7, 62 BPF_REG_8, 63 BPF_REG_9, 64 BPF_REG_10, 65 __MAX_BPF_REG, 66}; 67 68/* BPF has 10 general purpose 64-bit registers and stack frame. */ 69#define MAX_BPF_REG __MAX_BPF_REG 70 71struct bpf_insn { 72 __u8 code; /* opcode */ 73 __u8 dst_reg:4; /* dest register */ 74 __u8 src_reg:4; /* source register */ 75 __s16 off; /* signed offset */ 76 __s32 imm; /* signed immediate constant */ 77}; 78 79/* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */ 80struct bpf_lpm_trie_key { 81 __u32 prefixlen; /* up to 32 for AF_INET, 128 for AF_INET6 */ 82 __u8 data[0]; /* Arbitrary size */ 83}; 84 85struct bpf_cgroup_storage_key { 86 __u64 cgroup_inode_id; /* cgroup inode id */ 87 __u32 attach_type; /* program attach type */ 88}; 89 90union bpf_iter_link_info { 91 struct { 92 __u32 map_fd; 93 } map; 94}; 95 96/* BPF syscall commands, see bpf(2) man-page for more details. */ 97/** 98 * DOC: eBPF Syscall Preamble 99 * 100 * The operation to be performed by the **bpf**\ () system call is determined 101 * by the *cmd* argument. Each operation takes an accompanying argument, 102 * provided via *attr*, which is a pointer to a union of type *bpf_attr* (see 103 * below). The size argument is the size of the union pointed to by *attr*. 104 */ 105/** 106 * DOC: eBPF Syscall Commands 107 * 108 * BPF_MAP_CREATE 109 * Description 110 * Create a map and return a file descriptor that refers to the 111 * map. The close-on-exec file descriptor flag (see **fcntl**\ (2)) 112 * is automatically enabled for the new file descriptor. 113 * 114 * Applying **close**\ (2) to the file descriptor returned by 115 * **BPF_MAP_CREATE** will delete the map (but see NOTES). 116 * 117 * Return 118 * A new file descriptor (a nonnegative integer), or -1 if an 119 * error occurred (in which case, *errno* is set appropriately). 120 * 121 * BPF_MAP_LOOKUP_ELEM 122 * Description 123 * Look up an element with a given *key* in the map referred to 124 * by the file descriptor *map_fd*. 125 * 126 * The *flags* argument may be specified as one of the 127 * following: 128 * 129 * **BPF_F_LOCK** 130 * Look up the value of a spin-locked map without 131 * returning the lock. This must be specified if the 132 * elements contain a spinlock. 133 * 134 * Return 135 * Returns zero on success. On error, -1 is returned and *errno* 136 * is set appropriately. 137 * 138 * BPF_MAP_UPDATE_ELEM 139 * Description 140 * Create or update an element (key/value pair) in a specified map. 141 * 142 * The *flags* argument should be specified as one of the 143 * following: 144 * 145 * **BPF_ANY** 146 * Create a new element or update an existing element. 147 * **BPF_NOEXIST** 148 * Create a new element only if it did not exist. 149 * **BPF_EXIST** 150 * Update an existing element. 151 * **BPF_F_LOCK** 152 * Update a spin_lock-ed map element. 153 * 154 * Return 155 * Returns zero on success. On error, -1 is returned and *errno* 156 * is set appropriately. 157 * 158 * May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**, 159 * **E2BIG**, **EEXIST**, or **ENOENT**. 160 * 161 * **E2BIG** 162 * The number of elements in the map reached the 163 * *max_entries* limit specified at map creation time. 164 * **EEXIST** 165 * If *flags* specifies **BPF_NOEXIST** and the element 166 * with *key* already exists in the map. 167 * **ENOENT** 168 * If *flags* specifies **BPF_EXIST** and the element with 169 * *key* does not exist in the map. 170 * 171 * BPF_MAP_DELETE_ELEM 172 * Description 173 * Look up and delete an element by key in a specified map. 174 * 175 * Return 176 * Returns zero on success. On error, -1 is returned and *errno* 177 * is set appropriately. 178 * 179 * BPF_MAP_GET_NEXT_KEY 180 * Description 181 * Look up an element by key in a specified map and return the key 182 * of the next element. Can be used to iterate over all elements 183 * in the map. 184 * 185 * Return 186 * Returns zero on success. On error, -1 is returned and *errno* 187 * is set appropriately. 188 * 189 * The following cases can be used to iterate over all elements of 190 * the map: 191 * 192 * * If *key* is not found, the operation returns zero and sets 193 * the *next_key* pointer to the key of the first element. 194 * * If *key* is found, the operation returns zero and sets the 195 * *next_key* pointer to the key of the next element. 196 * * If *key* is the last element, returns -1 and *errno* is set 197 * to **ENOENT**. 198 * 199 * May set *errno* to **ENOMEM**, **EFAULT**, **EPERM**, or 200 * **EINVAL** on error. 201 * 202 * BPF_PROG_LOAD 203 * Description 204 * Verify and load an eBPF program, returning a new file 205 * descriptor associated with the program. 206 * 207 * Applying **close**\ (2) to the file descriptor returned by 208 * **BPF_PROG_LOAD** will unload the eBPF program (but see NOTES). 209 * 210 * The close-on-exec file descriptor flag (see **fcntl**\ (2)) is 211 * automatically enabled for the new file descriptor. 212 * 213 * Return 214 * A new file descriptor (a nonnegative integer), or -1 if an 215 * error occurred (in which case, *errno* is set appropriately). 216 * 217 * BPF_OBJ_PIN 218 * Description 219 * Pin an eBPF program or map referred by the specified *bpf_fd* 220 * to the provided *pathname* on the filesystem. 221 * 222 * The *pathname* argument must not contain a dot ("."). 223 * 224 * On success, *pathname* retains a reference to the eBPF object, 225 * preventing deallocation of the object when the original 226 * *bpf_fd* is closed. This allow the eBPF object to live beyond 227 * **close**\ (\ *bpf_fd*\ ), and hence the lifetime of the parent 228 * process. 229 * 230 * Applying **unlink**\ (2) or similar calls to the *pathname* 231 * unpins the object from the filesystem, removing the reference. 232 * If no other file descriptors or filesystem nodes refer to the 233 * same object, it will be deallocated (see NOTES). 234 * 235 * The filesystem type for the parent directory of *pathname* must 236 * be **BPF_FS_MAGIC**. 237 * 238 * Return 239 * Returns zero on success. On error, -1 is returned and *errno* 240 * is set appropriately. 241 * 242 * BPF_OBJ_GET 243 * Description 244 * Open a file descriptor for the eBPF object pinned to the 245 * specified *pathname*. 246 * 247 * Return 248 * A new file descriptor (a nonnegative integer), or -1 if an 249 * error occurred (in which case, *errno* is set appropriately). 250 * 251 * BPF_PROG_ATTACH 252 * Description 253 * Attach an eBPF program to a *target_fd* at the specified 254 * *attach_type* hook. 255 * 256 * The *attach_type* specifies the eBPF attachment point to 257 * attach the program to, and must be one of *bpf_attach_type* 258 * (see below). 259 * 260 * The *attach_bpf_fd* must be a valid file descriptor for a 261 * loaded eBPF program of a cgroup, flow dissector, LIRC, sockmap 262 * or sock_ops type corresponding to the specified *attach_type*. 263 * 264 * The *target_fd* must be a valid file descriptor for a kernel 265 * object which depends on the attach type of *attach_bpf_fd*: 266 * 267 * **BPF_PROG_TYPE_CGROUP_DEVICE**, 268 * **BPF_PROG_TYPE_CGROUP_SKB**, 269 * **BPF_PROG_TYPE_CGROUP_SOCK**, 270 * **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**, 271 * **BPF_PROG_TYPE_CGROUP_SOCKOPT**, 272 * **BPF_PROG_TYPE_CGROUP_SYSCTL**, 273 * **BPF_PROG_TYPE_SOCK_OPS** 274 * 275 * Control Group v2 hierarchy with the eBPF controller 276 * enabled. Requires the kernel to be compiled with 277 * **CONFIG_CGROUP_BPF**. 278 * 279 * **BPF_PROG_TYPE_FLOW_DISSECTOR** 280 * 281 * Network namespace (eg /proc/self/ns/net). 282 * 283 * **BPF_PROG_TYPE_LIRC_MODE2** 284 * 285 * LIRC device path (eg /dev/lircN). Requires the kernel 286 * to be compiled with **CONFIG_BPF_LIRC_MODE2**. 287 * 288 * **BPF_PROG_TYPE_SK_SKB**, 289 * **BPF_PROG_TYPE_SK_MSG** 290 * 291 * eBPF map of socket type (eg **BPF_MAP_TYPE_SOCKHASH**). 292 * 293 * Return 294 * Returns zero on success. On error, -1 is returned and *errno* 295 * is set appropriately. 296 * 297 * BPF_PROG_DETACH 298 * Description 299 * Detach the eBPF program associated with the *target_fd* at the 300 * hook specified by *attach_type*. The program must have been 301 * previously attached using **BPF_PROG_ATTACH**. 302 * 303 * Return 304 * Returns zero on success. On error, -1 is returned and *errno* 305 * is set appropriately. 306 * 307 * BPF_PROG_TEST_RUN 308 * Description 309 * Run the eBPF program associated with the *prog_fd* a *repeat* 310 * number of times against a provided program context *ctx_in* and 311 * data *data_in*, and return the modified program context 312 * *ctx_out*, *data_out* (for example, packet data), result of the 313 * execution *retval*, and *duration* of the test run. 314 * 315 * The sizes of the buffers provided as input and output 316 * parameters *ctx_in*, *ctx_out*, *data_in*, and *data_out* must 317 * be provided in the corresponding variables *ctx_size_in*, 318 * *ctx_size_out*, *data_size_in*, and/or *data_size_out*. If any 319 * of these parameters are not provided (ie set to NULL), the 320 * corresponding size field must be zero. 321 * 322 * Some program types have particular requirements: 323 * 324 * **BPF_PROG_TYPE_SK_LOOKUP** 325 * *data_in* and *data_out* must be NULL. 326 * 327 * **BPF_PROG_TYPE_XDP** 328 * *ctx_in* and *ctx_out* must be NULL. 329 * 330 * **BPF_PROG_TYPE_RAW_TRACEPOINT**, 331 * **BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE** 332 * 333 * *ctx_out*, *data_in* and *data_out* must be NULL. 334 * *repeat* must be zero. 335 * 336 * Return 337 * Returns zero on success. On error, -1 is returned and *errno* 338 * is set appropriately. 339 * 340 * **ENOSPC** 341 * Either *data_size_out* or *ctx_size_out* is too small. 342 * **ENOTSUPP** 343 * This command is not supported by the program type of 344 * the program referred to by *prog_fd*. 345 * 346 * BPF_PROG_GET_NEXT_ID 347 * Description 348 * Fetch the next eBPF program currently loaded into the kernel. 349 * 350 * Looks for the eBPF program with an id greater than *start_id* 351 * and updates *next_id* on success. If no other eBPF programs 352 * remain with ids higher than *start_id*, returns -1 and sets 353 * *errno* to **ENOENT**. 354 * 355 * Return 356 * Returns zero on success. On error, or when no id remains, -1 357 * is returned and *errno* is set appropriately. 358 * 359 * BPF_MAP_GET_NEXT_ID 360 * Description 361 * Fetch the next eBPF map currently loaded into the kernel. 362 * 363 * Looks for the eBPF map with an id greater than *start_id* 364 * and updates *next_id* on success. If no other eBPF maps 365 * remain with ids higher than *start_id*, returns -1 and sets 366 * *errno* to **ENOENT**. 367 * 368 * Return 369 * Returns zero on success. On error, or when no id remains, -1 370 * is returned and *errno* is set appropriately. 371 * 372 * BPF_PROG_GET_FD_BY_ID 373 * Description 374 * Open a file descriptor for the eBPF program corresponding to 375 * *prog_id*. 376 * 377 * Return 378 * A new file descriptor (a nonnegative integer), or -1 if an 379 * error occurred (in which case, *errno* is set appropriately). 380 * 381 * BPF_MAP_GET_FD_BY_ID 382 * Description 383 * Open a file descriptor for the eBPF map corresponding to 384 * *map_id*. 385 * 386 * Return 387 * A new file descriptor (a nonnegative integer), or -1 if an 388 * error occurred (in which case, *errno* is set appropriately). 389 * 390 * BPF_OBJ_GET_INFO_BY_FD 391 * Description 392 * Obtain information about the eBPF object corresponding to 393 * *bpf_fd*. 394 * 395 * Populates up to *info_len* bytes of *info*, which will be in 396 * one of the following formats depending on the eBPF object type 397 * of *bpf_fd*: 398 * 399 * * **struct bpf_prog_info** 400 * * **struct bpf_map_info** 401 * * **struct bpf_btf_info** 402 * * **struct bpf_link_info** 403 * 404 * Return 405 * Returns zero on success. On error, -1 is returned and *errno* 406 * is set appropriately. 407 * 408 * BPF_PROG_QUERY 409 * Description 410 * Obtain information about eBPF programs associated with the 411 * specified *attach_type* hook. 412 * 413 * The *target_fd* must be a valid file descriptor for a kernel 414 * object which depends on the attach type of *attach_bpf_fd*: 415 * 416 * **BPF_PROG_TYPE_CGROUP_DEVICE**, 417 * **BPF_PROG_TYPE_CGROUP_SKB**, 418 * **BPF_PROG_TYPE_CGROUP_SOCK**, 419 * **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**, 420 * **BPF_PROG_TYPE_CGROUP_SOCKOPT**, 421 * **BPF_PROG_TYPE_CGROUP_SYSCTL**, 422 * **BPF_PROG_TYPE_SOCK_OPS** 423 * 424 * Control Group v2 hierarchy with the eBPF controller 425 * enabled. Requires the kernel to be compiled with 426 * **CONFIG_CGROUP_BPF**. 427 * 428 * **BPF_PROG_TYPE_FLOW_DISSECTOR** 429 * 430 * Network namespace (eg /proc/self/ns/net). 431 * 432 * **BPF_PROG_TYPE_LIRC_MODE2** 433 * 434 * LIRC device path (eg /dev/lircN). Requires the kernel 435 * to be compiled with **CONFIG_BPF_LIRC_MODE2**. 436 * 437 * **BPF_PROG_QUERY** always fetches the number of programs 438 * attached and the *attach_flags* which were used to attach those 439 * programs. Additionally, if *prog_ids* is nonzero and the number 440 * of attached programs is less than *prog_cnt*, populates 441 * *prog_ids* with the eBPF program ids of the programs attached 442 * at *target_fd*. 443 * 444 * The following flags may alter the result: 445 * 446 * **BPF_F_QUERY_EFFECTIVE** 447 * Only return information regarding programs which are 448 * currently effective at the specified *target_fd*. 449 * 450 * Return 451 * Returns zero on success. On error, -1 is returned and *errno* 452 * is set appropriately. 453 * 454 * BPF_RAW_TRACEPOINT_OPEN 455 * Description 456 * Attach an eBPF program to a tracepoint *name* to access kernel 457 * internal arguments of the tracepoint in their raw form. 458 * 459 * The *prog_fd* must be a valid file descriptor associated with 460 * a loaded eBPF program of type **BPF_PROG_TYPE_RAW_TRACEPOINT**. 461 * 462 * No ABI guarantees are made about the content of tracepoint 463 * arguments exposed to the corresponding eBPF program. 464 * 465 * Applying **close**\ (2) to the file descriptor returned by 466 * **BPF_RAW_TRACEPOINT_OPEN** will delete the map (but see NOTES). 467 * 468 * Return 469 * A new file descriptor (a nonnegative integer), or -1 if an 470 * error occurred (in which case, *errno* is set appropriately). 471 * 472 * BPF_BTF_LOAD 473 * Description 474 * Verify and load BPF Type Format (BTF) metadata into the kernel, 475 * returning a new file descriptor associated with the metadata. 476 * BTF is described in more detail at 477 * https://www.kernel.org/doc/html/latest/bpf/btf.html. 478 * 479 * The *btf* parameter must point to valid memory providing 480 * *btf_size* bytes of BTF binary metadata. 481 * 482 * The returned file descriptor can be passed to other **bpf**\ () 483 * subcommands such as **BPF_PROG_LOAD** or **BPF_MAP_CREATE** to 484 * associate the BTF with those objects. 485 * 486 * Similar to **BPF_PROG_LOAD**, **BPF_BTF_LOAD** has optional 487 * parameters to specify a *btf_log_buf*, *btf_log_size* and 488 * *btf_log_level* which allow the kernel to return freeform log 489 * output regarding the BTF verification process. 490 * 491 * Return 492 * A new file descriptor (a nonnegative integer), or -1 if an 493 * error occurred (in which case, *errno* is set appropriately). 494 * 495 * BPF_BTF_GET_FD_BY_ID 496 * Description 497 * Open a file descriptor for the BPF Type Format (BTF) 498 * corresponding to *btf_id*. 499 * 500 * Return 501 * A new file descriptor (a nonnegative integer), or -1 if an 502 * error occurred (in which case, *errno* is set appropriately). 503 * 504 * BPF_TASK_FD_QUERY 505 * Description 506 * Obtain information about eBPF programs associated with the 507 * target process identified by *pid* and *fd*. 508 * 509 * If the *pid* and *fd* are associated with a tracepoint, kprobe 510 * or uprobe perf event, then the *prog_id* and *fd_type* will 511 * be populated with the eBPF program id and file descriptor type 512 * of type **bpf_task_fd_type**. If associated with a kprobe or 513 * uprobe, the *probe_offset* and *probe_addr* will also be 514 * populated. Optionally, if *buf* is provided, then up to 515 * *buf_len* bytes of *buf* will be populated with the name of 516 * the tracepoint, kprobe or uprobe. 517 * 518 * The resulting *prog_id* may be introspected in deeper detail 519 * using **BPF_PROG_GET_FD_BY_ID** and **BPF_OBJ_GET_INFO_BY_FD**. 520 * 521 * Return 522 * Returns zero on success. On error, -1 is returned and *errno* 523 * is set appropriately. 524 * 525 * BPF_MAP_LOOKUP_AND_DELETE_ELEM 526 * Description 527 * Look up an element with the given *key* in the map referred to 528 * by the file descriptor *fd*, and if found, delete the element. 529 * 530 * For **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map 531 * types, the *flags* argument needs to be set to 0, but for other 532 * map types, it may be specified as: 533 * 534 * **BPF_F_LOCK** 535 * Look up and delete the value of a spin-locked map 536 * without returning the lock. This must be specified if 537 * the elements contain a spinlock. 538 * 539 * The **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map types 540 * implement this command as a "pop" operation, deleting the top 541 * element rather than one corresponding to *key*. 542 * The *key* and *key_len* parameters should be zeroed when 543 * issuing this operation for these map types. 544 * 545 * This command is only valid for the following map types: 546 * * **BPF_MAP_TYPE_QUEUE** 547 * * **BPF_MAP_TYPE_STACK** 548 * * **BPF_MAP_TYPE_HASH** 549 * * **BPF_MAP_TYPE_PERCPU_HASH** 550 * * **BPF_MAP_TYPE_LRU_HASH** 551 * * **BPF_MAP_TYPE_LRU_PERCPU_HASH** 552 * 553 * Return 554 * Returns zero on success. On error, -1 is returned and *errno* 555 * is set appropriately. 556 * 557 * BPF_MAP_FREEZE 558 * Description 559 * Freeze the permissions of the specified map. 560 * 561 * Write permissions may be frozen by passing zero *flags*. 562 * Upon success, no future syscall invocations may alter the 563 * map state of *map_fd*. Write operations from eBPF programs 564 * are still possible for a frozen map. 565 * 566 * Not supported for maps of type **BPF_MAP_TYPE_STRUCT_OPS**. 567 * 568 * Return 569 * Returns zero on success. On error, -1 is returned and *errno* 570 * is set appropriately. 571 * 572 * BPF_BTF_GET_NEXT_ID 573 * Description 574 * Fetch the next BPF Type Format (BTF) object currently loaded 575 * into the kernel. 576 * 577 * Looks for the BTF object with an id greater than *start_id* 578 * and updates *next_id* on success. If no other BTF objects 579 * remain with ids higher than *start_id*, returns -1 and sets 580 * *errno* to **ENOENT**. 581 * 582 * Return 583 * Returns zero on success. On error, or when no id remains, -1 584 * is returned and *errno* is set appropriately. 585 * 586 * BPF_MAP_LOOKUP_BATCH 587 * Description 588 * Iterate and fetch multiple elements in a map. 589 * 590 * Two opaque values are used to manage batch operations, 591 * *in_batch* and *out_batch*. Initially, *in_batch* must be set 592 * to NULL to begin the batched operation. After each subsequent 593 * **BPF_MAP_LOOKUP_BATCH**, the caller should pass the resultant 594 * *out_batch* as the *in_batch* for the next operation to 595 * continue iteration from the current point. 596 * 597 * The *keys* and *values* are output parameters which must point 598 * to memory large enough to hold *count* items based on the key 599 * and value size of the map *map_fd*. The *keys* buffer must be 600 * of *key_size* * *count*. The *values* buffer must be of 601 * *value_size* * *count*. 602 * 603 * The *elem_flags* argument may be specified as one of the 604 * following: 605 * 606 * **BPF_F_LOCK** 607 * Look up the value of a spin-locked map without 608 * returning the lock. This must be specified if the 609 * elements contain a spinlock. 610 * 611 * On success, *count* elements from the map are copied into the 612 * user buffer, with the keys copied into *keys* and the values 613 * copied into the corresponding indices in *values*. 614 * 615 * If an error is returned and *errno* is not **EFAULT**, *count* 616 * is set to the number of successfully processed elements. 617 * 618 * Return 619 * Returns zero on success. On error, -1 is returned and *errno* 620 * is set appropriately. 621 * 622 * May set *errno* to **ENOSPC** to indicate that *keys* or 623 * *values* is too small to dump an entire bucket during 624 * iteration of a hash-based map type. 625 * 626 * BPF_MAP_LOOKUP_AND_DELETE_BATCH 627 * Description 628 * Iterate and delete all elements in a map. 629 * 630 * This operation has the same behavior as 631 * **BPF_MAP_LOOKUP_BATCH** with two exceptions: 632 * 633 * * Every element that is successfully returned is also deleted 634 * from the map. This is at least *count* elements. Note that 635 * *count* is both an input and an output parameter. 636 * * Upon returning with *errno* set to **EFAULT**, up to 637 * *count* elements may be deleted without returning the keys 638 * and values of the deleted elements. 639 * 640 * Return 641 * Returns zero on success. On error, -1 is returned and *errno* 642 * is set appropriately. 643 * 644 * BPF_MAP_UPDATE_BATCH 645 * Description 646 * Update multiple elements in a map by *key*. 647 * 648 * The *keys* and *values* are input parameters which must point 649 * to memory large enough to hold *count* items based on the key 650 * and value size of the map *map_fd*. The *keys* buffer must be 651 * of *key_size* * *count*. The *values* buffer must be of 652 * *value_size* * *count*. 653 * 654 * Each element specified in *keys* is sequentially updated to the 655 * value in the corresponding index in *values*. The *in_batch* 656 * and *out_batch* parameters are ignored and should be zeroed. 657 * 658 * The *elem_flags* argument should be specified as one of the 659 * following: 660 * 661 * **BPF_ANY** 662 * Create new elements or update a existing elements. 663 * **BPF_NOEXIST** 664 * Create new elements only if they do not exist. 665 * **BPF_EXIST** 666 * Update existing elements. 667 * **BPF_F_LOCK** 668 * Update spin_lock-ed map elements. This must be 669 * specified if the map value contains a spinlock. 670 * 671 * On success, *count* elements from the map are updated. 672 * 673 * If an error is returned and *errno* is not **EFAULT**, *count* 674 * is set to the number of successfully processed elements. 675 * 676 * Return 677 * Returns zero on success. On error, -1 is returned and *errno* 678 * is set appropriately. 679 * 680 * May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**, or 681 * **E2BIG**. **E2BIG** indicates that the number of elements in 682 * the map reached the *max_entries* limit specified at map 683 * creation time. 684 * 685 * May set *errno* to one of the following error codes under 686 * specific circumstances: 687 * 688 * **EEXIST** 689 * If *flags* specifies **BPF_NOEXIST** and the element 690 * with *key* already exists in the map. 691 * **ENOENT** 692 * If *flags* specifies **BPF_EXIST** and the element with 693 * *key* does not exist in the map. 694 * 695 * BPF_MAP_DELETE_BATCH 696 * Description 697 * Delete multiple elements in a map by *key*. 698 * 699 * The *keys* parameter is an input parameter which must point 700 * to memory large enough to hold *count* items based on the key 701 * size of the map *map_fd*, that is, *key_size* * *count*. 702 * 703 * Each element specified in *keys* is sequentially deleted. The 704 * *in_batch*, *out_batch*, and *values* parameters are ignored 705 * and should be zeroed. 706 * 707 * The *elem_flags* argument may be specified as one of the 708 * following: 709 * 710 * **BPF_F_LOCK** 711 * Look up the value of a spin-locked map without 712 * returning the lock. This must be specified if the 713 * elements contain a spinlock. 714 * 715 * On success, *count* elements from the map are updated. 716 * 717 * If an error is returned and *errno* is not **EFAULT**, *count* 718 * is set to the number of successfully processed elements. If 719 * *errno* is **EFAULT**, up to *count* elements may be been 720 * deleted. 721 * 722 * Return 723 * Returns zero on success. On error, -1 is returned and *errno* 724 * is set appropriately. 725 * 726 * BPF_LINK_CREATE 727 * Description 728 * Attach an eBPF program to a *target_fd* at the specified 729 * *attach_type* hook and return a file descriptor handle for 730 * managing the link. 731 * 732 * Return 733 * A new file descriptor (a nonnegative integer), or -1 if an 734 * error occurred (in which case, *errno* is set appropriately). 735 * 736 * BPF_LINK_UPDATE 737 * Description 738 * Update the eBPF program in the specified *link_fd* to 739 * *new_prog_fd*. 740 * 741 * Return 742 * Returns zero on success. On error, -1 is returned and *errno* 743 * is set appropriately. 744 * 745 * BPF_LINK_GET_FD_BY_ID 746 * Description 747 * Open a file descriptor for the eBPF Link corresponding to 748 * *link_id*. 749 * 750 * Return 751 * A new file descriptor (a nonnegative integer), or -1 if an 752 * error occurred (in which case, *errno* is set appropriately). 753 * 754 * BPF_LINK_GET_NEXT_ID 755 * Description 756 * Fetch the next eBPF link currently loaded into the kernel. 757 * 758 * Looks for the eBPF link with an id greater than *start_id* 759 * and updates *next_id* on success. If no other eBPF links 760 * remain with ids higher than *start_id*, returns -1 and sets 761 * *errno* to **ENOENT**. 762 * 763 * Return 764 * Returns zero on success. On error, or when no id remains, -1 765 * is returned and *errno* is set appropriately. 766 * 767 * BPF_ENABLE_STATS 768 * Description 769 * Enable eBPF runtime statistics gathering. 770 * 771 * Runtime statistics gathering for the eBPF runtime is disabled 772 * by default to minimize the corresponding performance overhead. 773 * This command enables statistics globally. 774 * 775 * Multiple programs may independently enable statistics. 776 * After gathering the desired statistics, eBPF runtime statistics 777 * may be disabled again by calling **close**\ (2) for the file 778 * descriptor returned by this function. Statistics will only be 779 * disabled system-wide when all outstanding file descriptors 780 * returned by prior calls for this subcommand are closed. 781 * 782 * Return 783 * A new file descriptor (a nonnegative integer), or -1 if an 784 * error occurred (in which case, *errno* is set appropriately). 785 * 786 * BPF_ITER_CREATE 787 * Description 788 * Create an iterator on top of the specified *link_fd* (as 789 * previously created using **BPF_LINK_CREATE**) and return a 790 * file descriptor that can be used to trigger the iteration. 791 * 792 * If the resulting file descriptor is pinned to the filesystem 793 * using **BPF_OBJ_PIN**, then subsequent **read**\ (2) syscalls 794 * for that path will trigger the iterator to read kernel state 795 * using the eBPF program attached to *link_fd*. 796 * 797 * Return 798 * A new file descriptor (a nonnegative integer), or -1 if an 799 * error occurred (in which case, *errno* is set appropriately). 800 * 801 * BPF_LINK_DETACH 802 * Description 803 * Forcefully detach the specified *link_fd* from its 804 * corresponding attachment point. 805 * 806 * Return 807 * Returns zero on success. On error, -1 is returned and *errno* 808 * is set appropriately. 809 * 810 * BPF_PROG_BIND_MAP 811 * Description 812 * Bind a map to the lifetime of an eBPF program. 813 * 814 * The map identified by *map_fd* is bound to the program 815 * identified by *prog_fd* and only released when *prog_fd* is 816 * released. This may be used in cases where metadata should be 817 * associated with a program which otherwise does not contain any 818 * references to the map (for example, embedded in the eBPF 819 * program instructions). 820 * 821 * Return 822 * Returns zero on success. On error, -1 is returned and *errno* 823 * is set appropriately. 824 * 825 * NOTES 826 * eBPF objects (maps and programs) can be shared between processes. 827 * 828 * * After **fork**\ (2), the child inherits file descriptors 829 * referring to the same eBPF objects. 830 * * File descriptors referring to eBPF objects can be transferred over 831 * **unix**\ (7) domain sockets. 832 * * File descriptors referring to eBPF objects can be duplicated in the 833 * usual way, using **dup**\ (2) and similar calls. 834 * * File descriptors referring to eBPF objects can be pinned to the 835 * filesystem using the **BPF_OBJ_PIN** command of **bpf**\ (2). 836 * 837 * An eBPF object is deallocated only after all file descriptors referring 838 * to the object have been closed and no references remain pinned to the 839 * filesystem or attached (for example, bound to a program or device). 840 */ 841enum bpf_cmd { 842 BPF_MAP_CREATE, 843 BPF_MAP_LOOKUP_ELEM, 844 BPF_MAP_UPDATE_ELEM, 845 BPF_MAP_DELETE_ELEM, 846 BPF_MAP_GET_NEXT_KEY, 847 BPF_PROG_LOAD, 848 BPF_OBJ_PIN, 849 BPF_OBJ_GET, 850 BPF_PROG_ATTACH, 851 BPF_PROG_DETACH, 852 BPF_PROG_TEST_RUN, 853 BPF_PROG_RUN = BPF_PROG_TEST_RUN, 854 BPF_PROG_GET_NEXT_ID, 855 BPF_MAP_GET_NEXT_ID, 856 BPF_PROG_GET_FD_BY_ID, 857 BPF_MAP_GET_FD_BY_ID, 858 BPF_OBJ_GET_INFO_BY_FD, 859 BPF_PROG_QUERY, 860 BPF_RAW_TRACEPOINT_OPEN, 861 BPF_BTF_LOAD, 862 BPF_BTF_GET_FD_BY_ID, 863 BPF_TASK_FD_QUERY, 864 BPF_MAP_LOOKUP_AND_DELETE_ELEM, 865 BPF_MAP_FREEZE, 866 BPF_BTF_GET_NEXT_ID, 867 BPF_MAP_LOOKUP_BATCH, 868 BPF_MAP_LOOKUP_AND_DELETE_BATCH, 869 BPF_MAP_UPDATE_BATCH, 870 BPF_MAP_DELETE_BATCH, 871 BPF_LINK_CREATE, 872 BPF_LINK_UPDATE, 873 BPF_LINK_GET_FD_BY_ID, 874 BPF_LINK_GET_NEXT_ID, 875 BPF_ENABLE_STATS, 876 BPF_ITER_CREATE, 877 BPF_LINK_DETACH, 878 BPF_PROG_BIND_MAP, 879}; 880 881enum bpf_map_type { 882 BPF_MAP_TYPE_UNSPEC, 883 BPF_MAP_TYPE_HASH, 884 BPF_MAP_TYPE_ARRAY, 885 BPF_MAP_TYPE_PROG_ARRAY, 886 BPF_MAP_TYPE_PERF_EVENT_ARRAY, 887 BPF_MAP_TYPE_PERCPU_HASH, 888 BPF_MAP_TYPE_PERCPU_ARRAY, 889 BPF_MAP_TYPE_STACK_TRACE, 890 BPF_MAP_TYPE_CGROUP_ARRAY, 891 BPF_MAP_TYPE_LRU_HASH, 892 BPF_MAP_TYPE_LRU_PERCPU_HASH, 893 BPF_MAP_TYPE_LPM_TRIE, 894 BPF_MAP_TYPE_ARRAY_OF_MAPS, 895 BPF_MAP_TYPE_HASH_OF_MAPS, 896 BPF_MAP_TYPE_DEVMAP, 897 BPF_MAP_TYPE_SOCKMAP, 898 BPF_MAP_TYPE_CPUMAP, 899 BPF_MAP_TYPE_XSKMAP, 900 BPF_MAP_TYPE_SOCKHASH, 901 BPF_MAP_TYPE_CGROUP_STORAGE, 902 BPF_MAP_TYPE_REUSEPORT_SOCKARRAY, 903 BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE, 904 BPF_MAP_TYPE_QUEUE, 905 BPF_MAP_TYPE_STACK, 906 BPF_MAP_TYPE_SK_STORAGE, 907 BPF_MAP_TYPE_DEVMAP_HASH, 908 BPF_MAP_TYPE_STRUCT_OPS, 909 BPF_MAP_TYPE_RINGBUF, 910 BPF_MAP_TYPE_INODE_STORAGE, 911 BPF_MAP_TYPE_TASK_STORAGE, 912}; 913 914/* Note that tracing related programs such as 915 * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT} 916 * are not subject to a stable API since kernel internal data 917 * structures can change from release to release and may 918 * therefore break existing tracing BPF programs. Tracing BPF 919 * programs correspond to /a/ specific kernel which is to be 920 * analyzed, and not /a/ specific kernel /and/ all future ones. 921 */ 922enum bpf_prog_type { 923 BPF_PROG_TYPE_UNSPEC, 924 BPF_PROG_TYPE_SOCKET_FILTER, 925 BPF_PROG_TYPE_KPROBE, 926 BPF_PROG_TYPE_SCHED_CLS, 927 BPF_PROG_TYPE_SCHED_ACT, 928 BPF_PROG_TYPE_TRACEPOINT, 929 BPF_PROG_TYPE_XDP, 930 BPF_PROG_TYPE_PERF_EVENT, 931 BPF_PROG_TYPE_CGROUP_SKB, 932 BPF_PROG_TYPE_CGROUP_SOCK, 933 BPF_PROG_TYPE_LWT_IN, 934 BPF_PROG_TYPE_LWT_OUT, 935 BPF_PROG_TYPE_LWT_XMIT, 936 BPF_PROG_TYPE_SOCK_OPS, 937 BPF_PROG_TYPE_SK_SKB, 938 BPF_PROG_TYPE_CGROUP_DEVICE, 939 BPF_PROG_TYPE_SK_MSG, 940 BPF_PROG_TYPE_RAW_TRACEPOINT, 941 BPF_PROG_TYPE_CGROUP_SOCK_ADDR, 942 BPF_PROG_TYPE_LWT_SEG6LOCAL, 943 BPF_PROG_TYPE_LIRC_MODE2, 944 BPF_PROG_TYPE_SK_REUSEPORT, 945 BPF_PROG_TYPE_FLOW_DISSECTOR, 946 BPF_PROG_TYPE_CGROUP_SYSCTL, 947 BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE, 948 BPF_PROG_TYPE_CGROUP_SOCKOPT, 949 BPF_PROG_TYPE_TRACING, 950 BPF_PROG_TYPE_STRUCT_OPS, 951 BPF_PROG_TYPE_EXT, 952 BPF_PROG_TYPE_LSM, 953 BPF_PROG_TYPE_SK_LOOKUP, 954 BPF_PROG_TYPE_SYSCALL, /* a program that can execute syscalls */ 955}; 956 957enum bpf_attach_type { 958 BPF_CGROUP_INET_INGRESS, 959 BPF_CGROUP_INET_EGRESS, 960 BPF_CGROUP_INET_SOCK_CREATE, 961 BPF_CGROUP_SOCK_OPS, 962 BPF_SK_SKB_STREAM_PARSER, 963 BPF_SK_SKB_STREAM_VERDICT, 964 BPF_CGROUP_DEVICE, 965 BPF_SK_MSG_VERDICT, 966 BPF_CGROUP_INET4_BIND, 967 BPF_CGROUP_INET6_BIND, 968 BPF_CGROUP_INET4_CONNECT, 969 BPF_CGROUP_INET6_CONNECT, 970 BPF_CGROUP_INET4_POST_BIND, 971 BPF_CGROUP_INET6_POST_BIND, 972 BPF_CGROUP_UDP4_SENDMSG, 973 BPF_CGROUP_UDP6_SENDMSG, 974 BPF_LIRC_MODE2, 975 BPF_FLOW_DISSECTOR, 976 BPF_CGROUP_SYSCTL, 977 BPF_CGROUP_UDP4_RECVMSG, 978 BPF_CGROUP_UDP6_RECVMSG, 979 BPF_CGROUP_GETSOCKOPT, 980 BPF_CGROUP_SETSOCKOPT, 981 BPF_TRACE_RAW_TP, 982 BPF_TRACE_FENTRY, 983 BPF_TRACE_FEXIT, 984 BPF_MODIFY_RETURN, 985 BPF_LSM_MAC, 986 BPF_TRACE_ITER, 987 BPF_CGROUP_INET4_GETPEERNAME, 988 BPF_CGROUP_INET6_GETPEERNAME, 989 BPF_CGROUP_INET4_GETSOCKNAME, 990 BPF_CGROUP_INET6_GETSOCKNAME, 991 BPF_XDP_DEVMAP, 992 BPF_CGROUP_INET_SOCK_RELEASE, 993 BPF_XDP_CPUMAP, 994 BPF_SK_LOOKUP, 995 BPF_XDP, 996 BPF_SK_SKB_VERDICT, 997 BPF_SK_REUSEPORT_SELECT, 998 BPF_SK_REUSEPORT_SELECT_OR_MIGRATE, 999 __MAX_BPF_ATTACH_TYPE 1000}; 1001 1002#define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE 1003 1004enum bpf_link_type { 1005 BPF_LINK_TYPE_UNSPEC = 0, 1006 BPF_LINK_TYPE_RAW_TRACEPOINT = 1, 1007 BPF_LINK_TYPE_TRACING = 2, 1008 BPF_LINK_TYPE_CGROUP = 3, 1009 BPF_LINK_TYPE_ITER = 4, 1010 BPF_LINK_TYPE_NETNS = 5, 1011 BPF_LINK_TYPE_XDP = 6, 1012 1013 MAX_BPF_LINK_TYPE, 1014}; 1015 1016/* cgroup-bpf attach flags used in BPF_PROG_ATTACH command 1017 * 1018 * NONE(default): No further bpf programs allowed in the subtree. 1019 * 1020 * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program, 1021 * the program in this cgroup yields to sub-cgroup program. 1022 * 1023 * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program, 1024 * that cgroup program gets run in addition to the program in this cgroup. 1025 * 1026 * Only one program is allowed to be attached to a cgroup with 1027 * NONE or BPF_F_ALLOW_OVERRIDE flag. 1028 * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will 1029 * release old program and attach the new one. Attach flags has to match. 1030 * 1031 * Multiple programs are allowed to be attached to a cgroup with 1032 * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order 1033 * (those that were attached first, run first) 1034 * The programs of sub-cgroup are executed first, then programs of 1035 * this cgroup and then programs of parent cgroup. 1036 * When children program makes decision (like picking TCP CA or sock bind) 1037 * parent program has a chance to override it. 1038 * 1039 * With BPF_F_ALLOW_MULTI a new program is added to the end of the list of 1040 * programs for a cgroup. Though it's possible to replace an old program at 1041 * any position by also specifying BPF_F_REPLACE flag and position itself in 1042 * replace_bpf_fd attribute. Old program at this position will be released. 1043 * 1044 * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups. 1045 * A cgroup with NONE doesn't allow any programs in sub-cgroups. 1046 * Ex1: 1047 * cgrp1 (MULTI progs A, B) -> 1048 * cgrp2 (OVERRIDE prog C) -> 1049 * cgrp3 (MULTI prog D) -> 1050 * cgrp4 (OVERRIDE prog E) -> 1051 * cgrp5 (NONE prog F) 1052 * the event in cgrp5 triggers execution of F,D,A,B in that order. 1053 * if prog F is detached, the execution is E,D,A,B 1054 * if prog F and D are detached, the execution is E,A,B 1055 * if prog F, E and D are detached, the execution is C,A,B 1056 * 1057 * All eligible programs are executed regardless of return code from 1058 * earlier programs. 1059 */ 1060#define BPF_F_ALLOW_OVERRIDE (1U << 0) 1061#define BPF_F_ALLOW_MULTI (1U << 1) 1062#define BPF_F_REPLACE (1U << 2) 1063 1064/* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the 1065 * verifier will perform strict alignment checking as if the kernel 1066 * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set, 1067 * and NET_IP_ALIGN defined to 2. 1068 */ 1069#define BPF_F_STRICT_ALIGNMENT (1U << 0) 1070 1071/* If BPF_F_ANY_ALIGNMENT is used in BPF_PROF_LOAD command, the 1072 * verifier will allow any alignment whatsoever. On platforms 1073 * with strict alignment requirements for loads ands stores (such 1074 * as sparc and mips) the verifier validates that all loads and 1075 * stores provably follow this requirement. This flag turns that 1076 * checking and enforcement off. 1077 * 1078 * It is mostly used for testing when we want to validate the 1079 * context and memory access aspects of the verifier, but because 1080 * of an unaligned access the alignment check would trigger before 1081 * the one we are interested in. 1082 */ 1083#define BPF_F_ANY_ALIGNMENT (1U << 1) 1084 1085/* BPF_F_TEST_RND_HI32 is used in BPF_PROG_LOAD command for testing purpose. 1086 * Verifier does sub-register def/use analysis and identifies instructions whose 1087 * def only matters for low 32-bit, high 32-bit is never referenced later 1088 * through implicit zero extension. Therefore verifier notifies JIT back-ends 1089 * that it is safe to ignore clearing high 32-bit for these instructions. This 1090 * saves some back-ends a lot of code-gen. However such optimization is not 1091 * necessary on some arches, for example x86_64, arm64 etc, whose JIT back-ends 1092 * hence hasn't used verifier's analysis result. But, we really want to have a 1093 * way to be able to verify the correctness of the described optimization on 1094 * x86_64 on which testsuites are frequently exercised. 1095 * 1096 * So, this flag is introduced. Once it is set, verifier will randomize high 1097 * 32-bit for those instructions who has been identified as safe to ignore them. 1098 * Then, if verifier is not doing correct analysis, such randomization will 1099 * regress tests to expose bugs. 1100 */ 1101#define BPF_F_TEST_RND_HI32 (1U << 2) 1102 1103/* The verifier internal test flag. Behavior is undefined */ 1104#define BPF_F_TEST_STATE_FREQ (1U << 3) 1105 1106/* If BPF_F_SLEEPABLE is used in BPF_PROG_LOAD command, the verifier will 1107 * restrict map and helper usage for such programs. Sleepable BPF programs can 1108 * only be attached to hooks where kernel execution context allows sleeping. 1109 * Such programs are allowed to use helpers that may sleep like 1110 * bpf_copy_from_user(). 1111 */ 1112#define BPF_F_SLEEPABLE (1U << 4) 1113 1114/* When BPF ldimm64's insn[0].src_reg != 0 then this can have 1115 * the following extensions: 1116 * 1117 * insn[0].src_reg: BPF_PSEUDO_MAP_[FD|IDX] 1118 * insn[0].imm: map fd or fd_idx 1119 * insn[1].imm: 0 1120 * insn[0].off: 0 1121 * insn[1].off: 0 1122 * ldimm64 rewrite: address of map 1123 * verifier type: CONST_PTR_TO_MAP 1124 */ 1125#define BPF_PSEUDO_MAP_FD 1 1126#define BPF_PSEUDO_MAP_IDX 5 1127 1128/* insn[0].src_reg: BPF_PSEUDO_MAP_[IDX_]VALUE 1129 * insn[0].imm: map fd or fd_idx 1130 * insn[1].imm: offset into value 1131 * insn[0].off: 0 1132 * insn[1].off: 0 1133 * ldimm64 rewrite: address of map[0]+offset 1134 * verifier type: PTR_TO_MAP_VALUE 1135 */ 1136#define BPF_PSEUDO_MAP_VALUE 2 1137#define BPF_PSEUDO_MAP_IDX_VALUE 6 1138 1139/* insn[0].src_reg: BPF_PSEUDO_BTF_ID 1140 * insn[0].imm: kernel btd id of VAR 1141 * insn[1].imm: 0 1142 * insn[0].off: 0 1143 * insn[1].off: 0 1144 * ldimm64 rewrite: address of the kernel variable 1145 * verifier type: PTR_TO_BTF_ID or PTR_TO_MEM, depending on whether the var 1146 * is struct/union. 1147 */ 1148#define BPF_PSEUDO_BTF_ID 3 1149/* insn[0].src_reg: BPF_PSEUDO_FUNC 1150 * insn[0].imm: insn offset to the func 1151 * insn[1].imm: 0 1152 * insn[0].off: 0 1153 * insn[1].off: 0 1154 * ldimm64 rewrite: address of the function 1155 * verifier type: PTR_TO_FUNC. 1156 */ 1157#define BPF_PSEUDO_FUNC 4 1158 1159/* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative 1160 * offset to another bpf function 1161 */ 1162#define BPF_PSEUDO_CALL 1 1163/* when bpf_call->src_reg == BPF_PSEUDO_KFUNC_CALL, 1164 * bpf_call->imm == btf_id of a BTF_KIND_FUNC in the running kernel 1165 */ 1166#define BPF_PSEUDO_KFUNC_CALL 2 1167 1168/* flags for BPF_MAP_UPDATE_ELEM command */ 1169enum { 1170 BPF_ANY = 0, /* create new element or update existing */ 1171 BPF_NOEXIST = 1, /* create new element if it didn't exist */ 1172 BPF_EXIST = 2, /* update existing element */ 1173 BPF_F_LOCK = 4, /* spin_lock-ed map_lookup/map_update */ 1174}; 1175 1176/* flags for BPF_MAP_CREATE command */ 1177enum { 1178 BPF_F_NO_PREALLOC = (1U << 0), 1179/* Instead of having one common LRU list in the 1180 * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list 1181 * which can scale and perform better. 1182 * Note, the LRU nodes (including free nodes) cannot be moved 1183 * across different LRU lists. 1184 */ 1185 BPF_F_NO_COMMON_LRU = (1U << 1), 1186/* Specify numa node during map creation */ 1187 BPF_F_NUMA_NODE = (1U << 2), 1188 1189/* Flags for accessing BPF object from syscall side. */ 1190 BPF_F_RDONLY = (1U << 3), 1191 BPF_F_WRONLY = (1U << 4), 1192 1193/* Flag for stack_map, store build_id+offset instead of pointer */ 1194 BPF_F_STACK_BUILD_ID = (1U << 5), 1195 1196/* Zero-initialize hash function seed. This should only be used for testing. */ 1197 BPF_F_ZERO_SEED = (1U << 6), 1198 1199/* Flags for accessing BPF object from program side. */ 1200 BPF_F_RDONLY_PROG = (1U << 7), 1201 BPF_F_WRONLY_PROG = (1U << 8), 1202 1203/* Clone map from listener for newly accepted socket */ 1204 BPF_F_CLONE = (1U << 9), 1205 1206/* Enable memory-mapping BPF map */ 1207 BPF_F_MMAPABLE = (1U << 10), 1208 1209/* Share perf_event among processes */ 1210 BPF_F_PRESERVE_ELEMS = (1U << 11), 1211 1212/* Create a map that is suitable to be an inner map with dynamic max entries */ 1213 BPF_F_INNER_MAP = (1U << 12), 1214}; 1215 1216/* Flags for BPF_PROG_QUERY. */ 1217 1218/* Query effective (directly attached + inherited from ancestor cgroups) 1219 * programs that will be executed for events within a cgroup. 1220 * attach_flags with this flag are returned only for directly attached programs. 1221 */ 1222#define BPF_F_QUERY_EFFECTIVE (1U << 0) 1223 1224/* Flags for BPF_PROG_TEST_RUN */ 1225 1226/* If set, run the test on the cpu specified by bpf_attr.test.cpu */ 1227#define BPF_F_TEST_RUN_ON_CPU (1U << 0) 1228 1229/* type for BPF_ENABLE_STATS */ 1230enum bpf_stats_type { 1231 /* enabled run_time_ns and run_cnt */ 1232 BPF_STATS_RUN_TIME = 0, 1233}; 1234 1235enum bpf_stack_build_id_status { 1236 /* user space need an empty entry to identify end of a trace */ 1237 BPF_STACK_BUILD_ID_EMPTY = 0, 1238 /* with valid build_id and offset */ 1239 BPF_STACK_BUILD_ID_VALID = 1, 1240 /* couldn't get build_id, fallback to ip */ 1241 BPF_STACK_BUILD_ID_IP = 2, 1242}; 1243 1244#define BPF_BUILD_ID_SIZE 20 1245struct bpf_stack_build_id { 1246 __s32 status; 1247 unsigned char build_id[BPF_BUILD_ID_SIZE]; 1248 union { 1249 __u64 offset; 1250 __u64 ip; 1251 }; 1252}; 1253 1254#define BPF_OBJ_NAME_LEN 16U 1255 1256union bpf_attr { 1257 struct { /* anonymous struct used by BPF_MAP_CREATE command */ 1258 __u32 map_type; /* one of enum bpf_map_type */ 1259 __u32 key_size; /* size of key in bytes */ 1260 __u32 value_size; /* size of value in bytes */ 1261 __u32 max_entries; /* max number of entries in a map */ 1262 __u32 map_flags; /* BPF_MAP_CREATE related 1263 * flags defined above. 1264 */ 1265 __u32 inner_map_fd; /* fd pointing to the inner map */ 1266 __u32 numa_node; /* numa node (effective only if 1267 * BPF_F_NUMA_NODE is set). 1268 */ 1269 char map_name[BPF_OBJ_NAME_LEN]; 1270 __u32 map_ifindex; /* ifindex of netdev to create on */ 1271 __u32 btf_fd; /* fd pointing to a BTF type data */ 1272 __u32 btf_key_type_id; /* BTF type_id of the key */ 1273 __u32 btf_value_type_id; /* BTF type_id of the value */ 1274 __u32 btf_vmlinux_value_type_id;/* BTF type_id of a kernel- 1275 * struct stored as the 1276 * map value 1277 */ 1278 }; 1279 1280 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ 1281 __u32 map_fd; 1282 __aligned_u64 key; 1283 union { 1284 __aligned_u64 value; 1285 __aligned_u64 next_key; 1286 }; 1287 __u64 flags; 1288 }; 1289 1290 struct { /* struct used by BPF_MAP_*_BATCH commands */ 1291 __aligned_u64 in_batch; /* start batch, 1292 * NULL to start from beginning 1293 */ 1294 __aligned_u64 out_batch; /* output: next start batch */ 1295 __aligned_u64 keys; 1296 __aligned_u64 values; 1297 __u32 count; /* input/output: 1298 * input: # of key/value 1299 * elements 1300 * output: # of filled elements 1301 */ 1302 __u32 map_fd; 1303 __u64 elem_flags; 1304 __u64 flags; 1305 } batch; 1306 1307 struct { /* anonymous struct used by BPF_PROG_LOAD command */ 1308 __u32 prog_type; /* one of enum bpf_prog_type */ 1309 __u32 insn_cnt; 1310 __aligned_u64 insns; 1311 __aligned_u64 license; 1312 __u32 log_level; /* verbosity level of verifier */ 1313 __u32 log_size; /* size of user buffer */ 1314 __aligned_u64 log_buf; /* user supplied buffer */ 1315 __u32 kern_version; /* not used */ 1316 __u32 prog_flags; 1317 char prog_name[BPF_OBJ_NAME_LEN]; 1318 __u32 prog_ifindex; /* ifindex of netdev to prep for */ 1319 /* For some prog types expected attach type must be known at 1320 * load time to verify attach type specific parts of prog 1321 * (context accesses, allowed helpers, etc). 1322 */ 1323 __u32 expected_attach_type; 1324 __u32 prog_btf_fd; /* fd pointing to BTF type data */ 1325 __u32 func_info_rec_size; /* userspace bpf_func_info size */ 1326 __aligned_u64 func_info; /* func info */ 1327 __u32 func_info_cnt; /* number of bpf_func_info records */ 1328 __u32 line_info_rec_size; /* userspace bpf_line_info size */ 1329 __aligned_u64 line_info; /* line info */ 1330 __u32 line_info_cnt; /* number of bpf_line_info records */ 1331 __u32 attach_btf_id; /* in-kernel BTF type id to attach to */ 1332 union { 1333 /* valid prog_fd to attach to bpf prog */ 1334 __u32 attach_prog_fd; 1335 /* or valid module BTF object fd or 0 to attach to vmlinux */ 1336 __u32 attach_btf_obj_fd; 1337 }; 1338 __u32 :32; /* pad */ 1339 __aligned_u64 fd_array; /* array of FDs */ 1340 }; 1341 1342 struct { /* anonymous struct used by BPF_OBJ_* commands */ 1343 __aligned_u64 pathname; 1344 __u32 bpf_fd; 1345 __u32 file_flags; 1346 }; 1347 1348 struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */ 1349 __u32 target_fd; /* container object to attach to */ 1350 __u32 attach_bpf_fd; /* eBPF program to attach */ 1351 __u32 attach_type; 1352 __u32 attach_flags; 1353 __u32 replace_bpf_fd; /* previously attached eBPF 1354 * program to replace if 1355 * BPF_F_REPLACE is used 1356 */ 1357 }; 1358 1359 struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */ 1360 __u32 prog_fd; 1361 __u32 retval; 1362 __u32 data_size_in; /* input: len of data_in */ 1363 __u32 data_size_out; /* input/output: len of data_out 1364 * returns ENOSPC if data_out 1365 * is too small. 1366 */ 1367 __aligned_u64 data_in; 1368 __aligned_u64 data_out; 1369 __u32 repeat; 1370 __u32 duration; 1371 __u32 ctx_size_in; /* input: len of ctx_in */ 1372 __u32 ctx_size_out; /* input/output: len of ctx_out 1373 * returns ENOSPC if ctx_out 1374 * is too small. 1375 */ 1376 __aligned_u64 ctx_in; 1377 __aligned_u64 ctx_out; 1378 __u32 flags; 1379 __u32 cpu; 1380 } test; 1381 1382 struct { /* anonymous struct used by BPF_*_GET_*_ID */ 1383 union { 1384 __u32 start_id; 1385 __u32 prog_id; 1386 __u32 map_id; 1387 __u32 btf_id; 1388 __u32 link_id; 1389 }; 1390 __u32 next_id; 1391 __u32 open_flags; 1392 }; 1393 1394 struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */ 1395 __u32 bpf_fd; 1396 __u32 info_len; 1397 __aligned_u64 info; 1398 } info; 1399 1400 struct { /* anonymous struct used by BPF_PROG_QUERY command */ 1401 __u32 target_fd; /* container object to query */ 1402 __u32 attach_type; 1403 __u32 query_flags; 1404 __u32 attach_flags; 1405 __aligned_u64 prog_ids; 1406 __u32 prog_cnt; 1407 } query; 1408 1409 struct { /* anonymous struct used by BPF_RAW_TRACEPOINT_OPEN command */ 1410 __u64 name; 1411 __u32 prog_fd; 1412 } raw_tracepoint; 1413 1414 struct { /* anonymous struct for BPF_BTF_LOAD */ 1415 __aligned_u64 btf; 1416 __aligned_u64 btf_log_buf; 1417 __u32 btf_size; 1418 __u32 btf_log_size; 1419 __u32 btf_log_level; 1420 }; 1421 1422 struct { 1423 __u32 pid; /* input: pid */ 1424 __u32 fd; /* input: fd */ 1425 __u32 flags; /* input: flags */ 1426 __u32 buf_len; /* input/output: buf len */ 1427 __aligned_u64 buf; /* input/output: 1428 * tp_name for tracepoint 1429 * symbol for kprobe 1430 * filename for uprobe 1431 */ 1432 __u32 prog_id; /* output: prod_id */ 1433 __u32 fd_type; /* output: BPF_FD_TYPE_* */ 1434 __u64 probe_offset; /* output: probe_offset */ 1435 __u64 probe_addr; /* output: probe_addr */ 1436 } task_fd_query; 1437 1438 struct { /* struct used by BPF_LINK_CREATE command */ 1439 __u32 prog_fd; /* eBPF program to attach */ 1440 union { 1441 __u32 target_fd; /* object to attach to */ 1442 __u32 target_ifindex; /* target ifindex */ 1443 }; 1444 __u32 attach_type; /* attach type */ 1445 __u32 flags; /* extra flags */ 1446 union { 1447 __u32 target_btf_id; /* btf_id of target to attach to */ 1448 struct { 1449 __aligned_u64 iter_info; /* extra bpf_iter_link_info */ 1450 __u32 iter_info_len; /* iter_info length */ 1451 }; 1452 }; 1453 } link_create; 1454 1455 struct { /* struct used by BPF_LINK_UPDATE command */ 1456 __u32 link_fd; /* link fd */ 1457 /* new program fd to update link with */ 1458 __u32 new_prog_fd; 1459 __u32 flags; /* extra flags */ 1460 /* expected link's program fd; is specified only if 1461 * BPF_F_REPLACE flag is set in flags */ 1462 __u32 old_prog_fd; 1463 } link_update; 1464 1465 struct { 1466 __u32 link_fd; 1467 } link_detach; 1468 1469 struct { /* struct used by BPF_ENABLE_STATS command */ 1470 __u32 type; 1471 } enable_stats; 1472 1473 struct { /* struct used by BPF_ITER_CREATE command */ 1474 __u32 link_fd; 1475 __u32 flags; 1476 } iter_create; 1477 1478 struct { /* struct used by BPF_PROG_BIND_MAP command */ 1479 __u32 prog_fd; 1480 __u32 map_fd; 1481 __u32 flags; /* extra flags */ 1482 } prog_bind_map; 1483 1484} __attribute__((aligned(8))); 1485 1486/* The description below is an attempt at providing documentation to eBPF 1487 * developers about the multiple available eBPF helper functions. It can be 1488 * parsed and used to produce a manual page. The workflow is the following, 1489 * and requires the rst2man utility: 1490 * 1491 * $ ./scripts/bpf_doc.py \ 1492 * --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst 1493 * $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7 1494 * $ man /tmp/bpf-helpers.7 1495 * 1496 * Note that in order to produce this external documentation, some RST 1497 * formatting is used in the descriptions to get "bold" and "italics" in 1498 * manual pages. Also note that the few trailing white spaces are 1499 * intentional, removing them would break paragraphs for rst2man. 1500 * 1501 * Start of BPF helper function descriptions: 1502 * 1503 * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key) 1504 * Description 1505 * Perform a lookup in *map* for an entry associated to *key*. 1506 * Return 1507 * Map value associated to *key*, or **NULL** if no entry was 1508 * found. 1509 * 1510 * long bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags) 1511 * Description 1512 * Add or update the value of the entry associated to *key* in 1513 * *map* with *value*. *flags* is one of: 1514 * 1515 * **BPF_NOEXIST** 1516 * The entry for *key* must not exist in the map. 1517 * **BPF_EXIST** 1518 * The entry for *key* must already exist in the map. 1519 * **BPF_ANY** 1520 * No condition on the existence of the entry for *key*. 1521 * 1522 * Flag value **BPF_NOEXIST** cannot be used for maps of types 1523 * **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY** (all 1524 * elements always exist), the helper would return an error. 1525 * Return 1526 * 0 on success, or a negative error in case of failure. 1527 * 1528 * long bpf_map_delete_elem(struct bpf_map *map, const void *key) 1529 * Description 1530 * Delete entry with *key* from *map*. 1531 * Return 1532 * 0 on success, or a negative error in case of failure. 1533 * 1534 * long bpf_probe_read(void *dst, u32 size, const void *unsafe_ptr) 1535 * Description 1536 * For tracing programs, safely attempt to read *size* bytes from 1537 * kernel space address *unsafe_ptr* and store the data in *dst*. 1538 * 1539 * Generally, use **bpf_probe_read_user**\ () or 1540 * **bpf_probe_read_kernel**\ () instead. 1541 * Return 1542 * 0 on success, or a negative error in case of failure. 1543 * 1544 * u64 bpf_ktime_get_ns(void) 1545 * Description 1546 * Return the time elapsed since system boot, in nanoseconds. 1547 * Does not include time the system was suspended. 1548 * See: **clock_gettime**\ (**CLOCK_MONOTONIC**) 1549 * Return 1550 * Current *ktime*. 1551 * 1552 * long bpf_trace_printk(const char *fmt, u32 fmt_size, ...) 1553 * Description 1554 * This helper is a "printk()-like" facility for debugging. It 1555 * prints a message defined by format *fmt* (of size *fmt_size*) 1556 * to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if 1557 * available. It can take up to three additional **u64** 1558 * arguments (as an eBPF helpers, the total number of arguments is 1559 * limited to five). 1560 * 1561 * Each time the helper is called, it appends a line to the trace. 1562 * Lines are discarded while *\/sys/kernel/debug/tracing/trace* is 1563 * open, use *\/sys/kernel/debug/tracing/trace_pipe* to avoid this. 1564 * The format of the trace is customizable, and the exact output 1565 * one will get depends on the options set in 1566 * *\/sys/kernel/debug/tracing/trace_options* (see also the 1567 * *README* file under the same directory). However, it usually 1568 * defaults to something like: 1569 * 1570 * :: 1571 * 1572 * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg> 1573 * 1574 * In the above: 1575 * 1576 * * ``telnet`` is the name of the current task. 1577 * * ``470`` is the PID of the current task. 1578 * * ``001`` is the CPU number on which the task is 1579 * running. 1580 * * In ``.N..``, each character refers to a set of 1581 * options (whether irqs are enabled, scheduling 1582 * options, whether hard/softirqs are running, level of 1583 * preempt_disabled respectively). **N** means that 1584 * **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED** 1585 * are set. 1586 * * ``419421.045894`` is a timestamp. 1587 * * ``0x00000001`` is a fake value used by BPF for the 1588 * instruction pointer register. 1589 * * ``<formatted msg>`` is the message formatted with 1590 * *fmt*. 1591 * 1592 * The conversion specifiers supported by *fmt* are similar, but 1593 * more limited than for printk(). They are **%d**, **%i**, 1594 * **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**, 1595 * **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size 1596 * of field, padding with zeroes, etc.) is available, and the 1597 * helper will return **-EINVAL** (but print nothing) if it 1598 * encounters an unknown specifier. 1599 * 1600 * Also, note that **bpf_trace_printk**\ () is slow, and should 1601 * only be used for debugging purposes. For this reason, a notice 1602 * block (spanning several lines) is printed to kernel logs and 1603 * states that the helper should not be used "for production use" 1604 * the first time this helper is used (or more precisely, when 1605 * **trace_printk**\ () buffers are allocated). For passing values 1606 * to user space, perf events should be preferred. 1607 * Return 1608 * The number of bytes written to the buffer, or a negative error 1609 * in case of failure. 1610 * 1611 * u32 bpf_get_prandom_u32(void) 1612 * Description 1613 * Get a pseudo-random number. 1614 * 1615 * From a security point of view, this helper uses its own 1616 * pseudo-random internal state, and cannot be used to infer the 1617 * seed of other random functions in the kernel. However, it is 1618 * essential to note that the generator used by the helper is not 1619 * cryptographically secure. 1620 * Return 1621 * A random 32-bit unsigned value. 1622 * 1623 * u32 bpf_get_smp_processor_id(void) 1624 * Description 1625 * Get the SMP (symmetric multiprocessing) processor id. Note that 1626 * all programs run with preemption disabled, which means that the 1627 * SMP processor id is stable during all the execution of the 1628 * program. 1629 * Return 1630 * The SMP id of the processor running the program. 1631 * 1632 * long bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags) 1633 * Description 1634 * Store *len* bytes from address *from* into the packet 1635 * associated to *skb*, at *offset*. *flags* are a combination of 1636 * **BPF_F_RECOMPUTE_CSUM** (automatically recompute the 1637 * checksum for the packet after storing the bytes) and 1638 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\ 1639 * **->swhash** and *skb*\ **->l4hash** to 0). 1640 * 1641 * A call to this helper is susceptible to change the underlying 1642 * packet buffer. Therefore, at load time, all checks on pointers 1643 * previously done by the verifier are invalidated and must be 1644 * performed again, if the helper is used in combination with 1645 * direct packet access. 1646 * Return 1647 * 0 on success, or a negative error in case of failure. 1648 * 1649 * long bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size) 1650 * Description 1651 * Recompute the layer 3 (e.g. IP) checksum for the packet 1652 * associated to *skb*. Computation is incremental, so the helper 1653 * must know the former value of the header field that was 1654 * modified (*from*), the new value of this field (*to*), and the 1655 * number of bytes (2 or 4) for this field, stored in *size*. 1656 * Alternatively, it is possible to store the difference between 1657 * the previous and the new values of the header field in *to*, by 1658 * setting *from* and *size* to 0. For both methods, *offset* 1659 * indicates the location of the IP checksum within the packet. 1660 * 1661 * This helper works in combination with **bpf_csum_diff**\ (), 1662 * which does not update the checksum in-place, but offers more 1663 * flexibility and can handle sizes larger than 2 or 4 for the 1664 * checksum to update. 1665 * 1666 * A call to this helper is susceptible to change the underlying 1667 * packet buffer. Therefore, at load time, all checks on pointers 1668 * previously done by the verifier are invalidated and must be 1669 * performed again, if the helper is used in combination with 1670 * direct packet access. 1671 * Return 1672 * 0 on success, or a negative error in case of failure. 1673 * 1674 * long bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags) 1675 * Description 1676 * Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the 1677 * packet associated to *skb*. Computation is incremental, so the 1678 * helper must know the former value of the header field that was 1679 * modified (*from*), the new value of this field (*to*), and the 1680 * number of bytes (2 or 4) for this field, stored on the lowest 1681 * four bits of *flags*. Alternatively, it is possible to store 1682 * the difference between the previous and the new values of the 1683 * header field in *to*, by setting *from* and the four lowest 1684 * bits of *flags* to 0. For both methods, *offset* indicates the 1685 * location of the IP checksum within the packet. In addition to 1686 * the size of the field, *flags* can be added (bitwise OR) actual 1687 * flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left 1688 * untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and 1689 * for updates resulting in a null checksum the value is set to 1690 * **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates 1691 * the checksum is to be computed against a pseudo-header. 1692 * 1693 * This helper works in combination with **bpf_csum_diff**\ (), 1694 * which does not update the checksum in-place, but offers more 1695 * flexibility and can handle sizes larger than 2 or 4 for the 1696 * checksum to update. 1697 * 1698 * A call to this helper is susceptible to change the underlying 1699 * packet buffer. Therefore, at load time, all checks on pointers 1700 * previously done by the verifier are invalidated and must be 1701 * performed again, if the helper is used in combination with 1702 * direct packet access. 1703 * Return 1704 * 0 on success, or a negative error in case of failure. 1705 * 1706 * long bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index) 1707 * Description 1708 * This special helper is used to trigger a "tail call", or in 1709 * other words, to jump into another eBPF program. The same stack 1710 * frame is used (but values on stack and in registers for the 1711 * caller are not accessible to the callee). This mechanism allows 1712 * for program chaining, either for raising the maximum number of 1713 * available eBPF instructions, or to execute given programs in 1714 * conditional blocks. For security reasons, there is an upper 1715 * limit to the number of successive tail calls that can be 1716 * performed. 1717 * 1718 * Upon call of this helper, the program attempts to jump into a 1719 * program referenced at index *index* in *prog_array_map*, a 1720 * special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes 1721 * *ctx*, a pointer to the context. 1722 * 1723 * If the call succeeds, the kernel immediately runs the first 1724 * instruction of the new program. This is not a function call, 1725 * and it never returns to the previous program. If the call 1726 * fails, then the helper has no effect, and the caller continues 1727 * to run its subsequent instructions. A call can fail if the 1728 * destination program for the jump does not exist (i.e. *index* 1729 * is superior to the number of entries in *prog_array_map*), or 1730 * if the maximum number of tail calls has been reached for this 1731 * chain of programs. This limit is defined in the kernel by the 1732 * macro **MAX_TAIL_CALL_CNT** (not accessible to user space), 1733 * which is currently set to 32. 1734 * Return 1735 * 0 on success, or a negative error in case of failure. 1736 * 1737 * long bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags) 1738 * Description 1739 * Clone and redirect the packet associated to *skb* to another 1740 * net device of index *ifindex*. Both ingress and egress 1741 * interfaces can be used for redirection. The **BPF_F_INGRESS** 1742 * value in *flags* is used to make the distinction (ingress path 1743 * is selected if the flag is present, egress path otherwise). 1744 * This is the only flag supported for now. 1745 * 1746 * In comparison with **bpf_redirect**\ () helper, 1747 * **bpf_clone_redirect**\ () has the associated cost of 1748 * duplicating the packet buffer, but this can be executed out of 1749 * the eBPF program. Conversely, **bpf_redirect**\ () is more 1750 * efficient, but it is handled through an action code where the 1751 * redirection happens only after the eBPF program has returned. 1752 * 1753 * A call to this helper is susceptible to change the underlying 1754 * packet buffer. Therefore, at load time, all checks on pointers 1755 * previously done by the verifier are invalidated and must be 1756 * performed again, if the helper is used in combination with 1757 * direct packet access. 1758 * Return 1759 * 0 on success, or a negative error in case of failure. 1760 * 1761 * u64 bpf_get_current_pid_tgid(void) 1762 * Return 1763 * A 64-bit integer containing the current tgid and pid, and 1764 * created as such: 1765 * *current_task*\ **->tgid << 32 \|** 1766 * *current_task*\ **->pid**. 1767 * 1768 * u64 bpf_get_current_uid_gid(void) 1769 * Return 1770 * A 64-bit integer containing the current GID and UID, and 1771 * created as such: *current_gid* **<< 32 \|** *current_uid*. 1772 * 1773 * long bpf_get_current_comm(void *buf, u32 size_of_buf) 1774 * Description 1775 * Copy the **comm** attribute of the current task into *buf* of 1776 * *size_of_buf*. The **comm** attribute contains the name of 1777 * the executable (excluding the path) for the current task. The 1778 * *size_of_buf* must be strictly positive. On success, the 1779 * helper makes sure that the *buf* is NUL-terminated. On failure, 1780 * it is filled with zeroes. 1781 * Return 1782 * 0 on success, or a negative error in case of failure. 1783 * 1784 * u32 bpf_get_cgroup_classid(struct sk_buff *skb) 1785 * Description 1786 * Retrieve the classid for the current task, i.e. for the net_cls 1787 * cgroup to which *skb* belongs. 1788 * 1789 * This helper can be used on TC egress path, but not on ingress. 1790 * 1791 * The net_cls cgroup provides an interface to tag network packets 1792 * based on a user-provided identifier for all traffic coming from 1793 * the tasks belonging to the related cgroup. See also the related 1794 * kernel documentation, available from the Linux sources in file 1795 * *Documentation/admin-guide/cgroup-v1/net_cls.rst*. 1796 * 1797 * The Linux kernel has two versions for cgroups: there are 1798 * cgroups v1 and cgroups v2. Both are available to users, who can 1799 * use a mixture of them, but note that the net_cls cgroup is for 1800 * cgroup v1 only. This makes it incompatible with BPF programs 1801 * run on cgroups, which is a cgroup-v2-only feature (a socket can 1802 * only hold data for one version of cgroups at a time). 1803 * 1804 * This helper is only available is the kernel was compiled with 1805 * the **CONFIG_CGROUP_NET_CLASSID** configuration option set to 1806 * "**y**" or to "**m**". 1807 * Return 1808 * The classid, or 0 for the default unconfigured classid. 1809 * 1810 * long bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci) 1811 * Description 1812 * Push a *vlan_tci* (VLAN tag control information) of protocol 1813 * *vlan_proto* to the packet associated to *skb*, then update 1814 * the checksum. Note that if *vlan_proto* is different from 1815 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to 1816 * be **ETH_P_8021Q**. 1817 * 1818 * A call to this helper is susceptible to change the underlying 1819 * packet buffer. Therefore, at load time, all checks on pointers 1820 * previously done by the verifier are invalidated and must be 1821 * performed again, if the helper is used in combination with 1822 * direct packet access. 1823 * Return 1824 * 0 on success, or a negative error in case of failure. 1825 * 1826 * long bpf_skb_vlan_pop(struct sk_buff *skb) 1827 * Description 1828 * Pop a VLAN header from the packet associated to *skb*. 1829 * 1830 * A call to this helper is susceptible to change the underlying 1831 * packet buffer. Therefore, at load time, all checks on pointers 1832 * previously done by the verifier are invalidated and must be 1833 * performed again, if the helper is used in combination with 1834 * direct packet access. 1835 * Return 1836 * 0 on success, or a negative error in case of failure. 1837 * 1838 * long bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags) 1839 * Description 1840 * Get tunnel metadata. This helper takes a pointer *key* to an 1841 * empty **struct bpf_tunnel_key** of **size**, that will be 1842 * filled with tunnel metadata for the packet associated to *skb*. 1843 * The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which 1844 * indicates that the tunnel is based on IPv6 protocol instead of 1845 * IPv4. 1846 * 1847 * The **struct bpf_tunnel_key** is an object that generalizes the 1848 * principal parameters used by various tunneling protocols into a 1849 * single struct. This way, it can be used to easily make a 1850 * decision based on the contents of the encapsulation header, 1851 * "summarized" in this struct. In particular, it holds the IP 1852 * address of the remote end (IPv4 or IPv6, depending on the case) 1853 * in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also, 1854 * this struct exposes the *key*\ **->tunnel_id**, which is 1855 * generally mapped to a VNI (Virtual Network Identifier), making 1856 * it programmable together with the **bpf_skb_set_tunnel_key**\ 1857 * () helper. 1858 * 1859 * Let's imagine that the following code is part of a program 1860 * attached to the TC ingress interface, on one end of a GRE 1861 * tunnel, and is supposed to filter out all messages coming from 1862 * remote ends with IPv4 address other than 10.0.0.1: 1863 * 1864 * :: 1865 * 1866 * int ret; 1867 * struct bpf_tunnel_key key = {}; 1868 * 1869 * ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0); 1870 * if (ret < 0) 1871 * return TC_ACT_SHOT; // drop packet 1872 * 1873 * if (key.remote_ipv4 != 0x0a000001) 1874 * return TC_ACT_SHOT; // drop packet 1875 * 1876 * return TC_ACT_OK; // accept packet 1877 * 1878 * This interface can also be used with all encapsulation devices 1879 * that can operate in "collect metadata" mode: instead of having 1880 * one network device per specific configuration, the "collect 1881 * metadata" mode only requires a single device where the 1882 * configuration can be extracted from this helper. 1883 * 1884 * This can be used together with various tunnels such as VXLan, 1885 * Geneve, GRE or IP in IP (IPIP). 1886 * Return 1887 * 0 on success, or a negative error in case of failure. 1888 * 1889 * long bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags) 1890 * Description 1891 * Populate tunnel metadata for packet associated to *skb.* The 1892 * tunnel metadata is set to the contents of *key*, of *size*. The 1893 * *flags* can be set to a combination of the following values: 1894 * 1895 * **BPF_F_TUNINFO_IPV6** 1896 * Indicate that the tunnel is based on IPv6 protocol 1897 * instead of IPv4. 1898 * **BPF_F_ZERO_CSUM_TX** 1899 * For IPv4 packets, add a flag to tunnel metadata 1900 * indicating that checksum computation should be skipped 1901 * and checksum set to zeroes. 1902 * **BPF_F_DONT_FRAGMENT** 1903 * Add a flag to tunnel metadata indicating that the 1904 * packet should not be fragmented. 1905 * **BPF_F_SEQ_NUMBER** 1906 * Add a flag to tunnel metadata indicating that a 1907 * sequence number should be added to tunnel header before 1908 * sending the packet. This flag was added for GRE 1909 * encapsulation, but might be used with other protocols 1910 * as well in the future. 1911 * 1912 * Here is a typical usage on the transmit path: 1913 * 1914 * :: 1915 * 1916 * struct bpf_tunnel_key key; 1917 * populate key ... 1918 * bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0); 1919 * bpf_clone_redirect(skb, vxlan_dev_ifindex, 0); 1920 * 1921 * See also the description of the **bpf_skb_get_tunnel_key**\ () 1922 * helper for additional information. 1923 * Return 1924 * 0 on success, or a negative error in case of failure. 1925 * 1926 * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags) 1927 * Description 1928 * Read the value of a perf event counter. This helper relies on a 1929 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of 1930 * the perf event counter is selected when *map* is updated with 1931 * perf event file descriptors. The *map* is an array whose size 1932 * is the number of available CPUs, and each cell contains a value 1933 * relative to one CPU. The value to retrieve is indicated by 1934 * *flags*, that contains the index of the CPU to look up, masked 1935 * with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to 1936 * **BPF_F_CURRENT_CPU** to indicate that the value for the 1937 * current CPU should be retrieved. 1938 * 1939 * Note that before Linux 4.13, only hardware perf event can be 1940 * retrieved. 1941 * 1942 * Also, be aware that the newer helper 1943 * **bpf_perf_event_read_value**\ () is recommended over 1944 * **bpf_perf_event_read**\ () in general. The latter has some ABI 1945 * quirks where error and counter value are used as a return code 1946 * (which is wrong to do since ranges may overlap). This issue is 1947 * fixed with **bpf_perf_event_read_value**\ (), which at the same 1948 * time provides more features over the **bpf_perf_event_read**\ 1949 * () interface. Please refer to the description of 1950 * **bpf_perf_event_read_value**\ () for details. 1951 * Return 1952 * The value of the perf event counter read from the map, or a 1953 * negative error code in case of failure. 1954 * 1955 * long bpf_redirect(u32 ifindex, u64 flags) 1956 * Description 1957 * Redirect the packet to another net device of index *ifindex*. 1958 * This helper is somewhat similar to **bpf_clone_redirect**\ 1959 * (), except that the packet is not cloned, which provides 1960 * increased performance. 1961 * 1962 * Except for XDP, both ingress and egress interfaces can be used 1963 * for redirection. The **BPF_F_INGRESS** value in *flags* is used 1964 * to make the distinction (ingress path is selected if the flag 1965 * is present, egress path otherwise). Currently, XDP only 1966 * supports redirection to the egress interface, and accepts no 1967 * flag at all. 1968 * 1969 * The same effect can also be attained with the more generic 1970 * **bpf_redirect_map**\ (), which uses a BPF map to store the 1971 * redirect target instead of providing it directly to the helper. 1972 * Return 1973 * For XDP, the helper returns **XDP_REDIRECT** on success or 1974 * **XDP_ABORTED** on error. For other program types, the values 1975 * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on 1976 * error. 1977 * 1978 * u32 bpf_get_route_realm(struct sk_buff *skb) 1979 * Description 1980 * Retrieve the realm or the route, that is to say the 1981 * **tclassid** field of the destination for the *skb*. The 1982 * identifier retrieved is a user-provided tag, similar to the 1983 * one used with the net_cls cgroup (see description for 1984 * **bpf_get_cgroup_classid**\ () helper), but here this tag is 1985 * held by a route (a destination entry), not by a task. 1986 * 1987 * Retrieving this identifier works with the clsact TC egress hook 1988 * (see also **tc-bpf(8)**), or alternatively on conventional 1989 * classful egress qdiscs, but not on TC ingress path. In case of 1990 * clsact TC egress hook, this has the advantage that, internally, 1991 * the destination entry has not been dropped yet in the transmit 1992 * path. Therefore, the destination entry does not need to be 1993 * artificially held via **netif_keep_dst**\ () for a classful 1994 * qdisc until the *skb* is freed. 1995 * 1996 * This helper is available only if the kernel was compiled with 1997 * **CONFIG_IP_ROUTE_CLASSID** configuration option. 1998 * Return 1999 * The realm of the route for the packet associated to *skb*, or 0 2000 * if none was found. 2001 * 2002 * long bpf_perf_event_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 2003 * Description 2004 * Write raw *data* blob into a special BPF perf event held by 2005 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 2006 * event must have the following attributes: **PERF_SAMPLE_RAW** 2007 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 2008 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 2009 * 2010 * The *flags* are used to indicate the index in *map* for which 2011 * the value must be put, masked with **BPF_F_INDEX_MASK**. 2012 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 2013 * to indicate that the index of the current CPU core should be 2014 * used. 2015 * 2016 * The value to write, of *size*, is passed through eBPF stack and 2017 * pointed by *data*. 2018 * 2019 * The context of the program *ctx* needs also be passed to the 2020 * helper. 2021 * 2022 * On user space, a program willing to read the values needs to 2023 * call **perf_event_open**\ () on the perf event (either for 2024 * one or for all CPUs) and to store the file descriptor into the 2025 * *map*. This must be done before the eBPF program can send data 2026 * into it. An example is available in file 2027 * *samples/bpf/trace_output_user.c* in the Linux kernel source 2028 * tree (the eBPF program counterpart is in 2029 * *samples/bpf/trace_output_kern.c*). 2030 * 2031 * **bpf_perf_event_output**\ () achieves better performance 2032 * than **bpf_trace_printk**\ () for sharing data with user 2033 * space, and is much better suitable for streaming data from eBPF 2034 * programs. 2035 * 2036 * Note that this helper is not restricted to tracing use cases 2037 * and can be used with programs attached to TC or XDP as well, 2038 * where it allows for passing data to user space listeners. Data 2039 * can be: 2040 * 2041 * * Only custom structs, 2042 * * Only the packet payload, or 2043 * * A combination of both. 2044 * Return 2045 * 0 on success, or a negative error in case of failure. 2046 * 2047 * long bpf_skb_load_bytes(const void *skb, u32 offset, void *to, u32 len) 2048 * Description 2049 * This helper was provided as an easy way to load data from a 2050 * packet. It can be used to load *len* bytes from *offset* from 2051 * the packet associated to *skb*, into the buffer pointed by 2052 * *to*. 2053 * 2054 * Since Linux 4.7, usage of this helper has mostly been replaced 2055 * by "direct packet access", enabling packet data to be 2056 * manipulated with *skb*\ **->data** and *skb*\ **->data_end** 2057 * pointing respectively to the first byte of packet data and to 2058 * the byte after the last byte of packet data. However, it 2059 * remains useful if one wishes to read large quantities of data 2060 * at once from a packet into the eBPF stack. 2061 * Return 2062 * 0 on success, or a negative error in case of failure. 2063 * 2064 * long bpf_get_stackid(void *ctx, struct bpf_map *map, u64 flags) 2065 * Description 2066 * Walk a user or a kernel stack and return its id. To achieve 2067 * this, the helper needs *ctx*, which is a pointer to the context 2068 * on which the tracing program is executed, and a pointer to a 2069 * *map* of type **BPF_MAP_TYPE_STACK_TRACE**. 2070 * 2071 * The last argument, *flags*, holds the number of stack frames to 2072 * skip (from 0 to 255), masked with 2073 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 2074 * a combination of the following flags: 2075 * 2076 * **BPF_F_USER_STACK** 2077 * Collect a user space stack instead of a kernel stack. 2078 * **BPF_F_FAST_STACK_CMP** 2079 * Compare stacks by hash only. 2080 * **BPF_F_REUSE_STACKID** 2081 * If two different stacks hash into the same *stackid*, 2082 * discard the old one. 2083 * 2084 * The stack id retrieved is a 32 bit long integer handle which 2085 * can be further combined with other data (including other stack 2086 * ids) and used as a key into maps. This can be useful for 2087 * generating a variety of graphs (such as flame graphs or off-cpu 2088 * graphs). 2089 * 2090 * For walking a stack, this helper is an improvement over 2091 * **bpf_probe_read**\ (), which can be used with unrolled loops 2092 * but is not efficient and consumes a lot of eBPF instructions. 2093 * Instead, **bpf_get_stackid**\ () can collect up to 2094 * **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that 2095 * this limit can be controlled with the **sysctl** program, and 2096 * that it should be manually increased in order to profile long 2097 * user stacks (such as stacks for Java programs). To do so, use: 2098 * 2099 * :: 2100 * 2101 * # sysctl kernel.perf_event_max_stack=<new value> 2102 * Return 2103 * The positive or null stack id on success, or a negative error 2104 * in case of failure. 2105 * 2106 * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed) 2107 * Description 2108 * Compute a checksum difference, from the raw buffer pointed by 2109 * *from*, of length *from_size* (that must be a multiple of 4), 2110 * towards the raw buffer pointed by *to*, of size *to_size* 2111 * (same remark). An optional *seed* can be added to the value 2112 * (this can be cascaded, the seed may come from a previous call 2113 * to the helper). 2114 * 2115 * This is flexible enough to be used in several ways: 2116 * 2117 * * With *from_size* == 0, *to_size* > 0 and *seed* set to 2118 * checksum, it can be used when pushing new data. 2119 * * With *from_size* > 0, *to_size* == 0 and *seed* set to 2120 * checksum, it can be used when removing data from a packet. 2121 * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it 2122 * can be used to compute a diff. Note that *from_size* and 2123 * *to_size* do not need to be equal. 2124 * 2125 * This helper can be used in combination with 2126 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to 2127 * which one can feed in the difference computed with 2128 * **bpf_csum_diff**\ (). 2129 * Return 2130 * The checksum result, or a negative error code in case of 2131 * failure. 2132 * 2133 * long bpf_skb_get_tunnel_opt(struct sk_buff *skb, void *opt, u32 size) 2134 * Description 2135 * Retrieve tunnel options metadata for the packet associated to 2136 * *skb*, and store the raw tunnel option data to the buffer *opt* 2137 * of *size*. 2138 * 2139 * This helper can be used with encapsulation devices that can 2140 * operate in "collect metadata" mode (please refer to the related 2141 * note in the description of **bpf_skb_get_tunnel_key**\ () for 2142 * more details). A particular example where this can be used is 2143 * in combination with the Geneve encapsulation protocol, where it 2144 * allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper) 2145 * and retrieving arbitrary TLVs (Type-Length-Value headers) from 2146 * the eBPF program. This allows for full customization of these 2147 * headers. 2148 * Return 2149 * The size of the option data retrieved. 2150 * 2151 * long bpf_skb_set_tunnel_opt(struct sk_buff *skb, void *opt, u32 size) 2152 * Description 2153 * Set tunnel options metadata for the packet associated to *skb* 2154 * to the option data contained in the raw buffer *opt* of *size*. 2155 * 2156 * See also the description of the **bpf_skb_get_tunnel_opt**\ () 2157 * helper for additional information. 2158 * Return 2159 * 0 on success, or a negative error in case of failure. 2160 * 2161 * long bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags) 2162 * Description 2163 * Change the protocol of the *skb* to *proto*. Currently 2164 * supported are transition from IPv4 to IPv6, and from IPv6 to 2165 * IPv4. The helper takes care of the groundwork for the 2166 * transition, including resizing the socket buffer. The eBPF 2167 * program is expected to fill the new headers, if any, via 2168 * **skb_store_bytes**\ () and to recompute the checksums with 2169 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ 2170 * (). The main case for this helper is to perform NAT64 2171 * operations out of an eBPF program. 2172 * 2173 * Internally, the GSO type is marked as dodgy so that headers are 2174 * checked and segments are recalculated by the GSO/GRO engine. 2175 * The size for GSO target is adapted as well. 2176 * 2177 * All values for *flags* are reserved for future usage, and must 2178 * be left at zero. 2179 * 2180 * A call to this helper is susceptible to change the underlying 2181 * packet buffer. Therefore, at load time, all checks on pointers 2182 * previously done by the verifier are invalidated and must be 2183 * performed again, if the helper is used in combination with 2184 * direct packet access. 2185 * Return 2186 * 0 on success, or a negative error in case of failure. 2187 * 2188 * long bpf_skb_change_type(struct sk_buff *skb, u32 type) 2189 * Description 2190 * Change the packet type for the packet associated to *skb*. This 2191 * comes down to setting *skb*\ **->pkt_type** to *type*, except 2192 * the eBPF program does not have a write access to *skb*\ 2193 * **->pkt_type** beside this helper. Using a helper here allows 2194 * for graceful handling of errors. 2195 * 2196 * The major use case is to change incoming *skb*s to 2197 * **PACKET_HOST** in a programmatic way instead of having to 2198 * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for 2199 * example. 2200 * 2201 * Note that *type* only allows certain values. At this time, they 2202 * are: 2203 * 2204 * **PACKET_HOST** 2205 * Packet is for us. 2206 * **PACKET_BROADCAST** 2207 * Send packet to all. 2208 * **PACKET_MULTICAST** 2209 * Send packet to group. 2210 * **PACKET_OTHERHOST** 2211 * Send packet to someone else. 2212 * Return 2213 * 0 on success, or a negative error in case of failure. 2214 * 2215 * long bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index) 2216 * Description 2217 * Check whether *skb* is a descendant of the cgroup2 held by 2218 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*. 2219 * Return 2220 * The return value depends on the result of the test, and can be: 2221 * 2222 * * 0, if the *skb* failed the cgroup2 descendant test. 2223 * * 1, if the *skb* succeeded the cgroup2 descendant test. 2224 * * A negative error code, if an error occurred. 2225 * 2226 * u32 bpf_get_hash_recalc(struct sk_buff *skb) 2227 * Description 2228 * Retrieve the hash of the packet, *skb*\ **->hash**. If it is 2229 * not set, in particular if the hash was cleared due to mangling, 2230 * recompute this hash. Later accesses to the hash can be done 2231 * directly with *skb*\ **->hash**. 2232 * 2233 * Calling **bpf_set_hash_invalid**\ (), changing a packet 2234 * prototype with **bpf_skb_change_proto**\ (), or calling 2235 * **bpf_skb_store_bytes**\ () with the 2236 * **BPF_F_INVALIDATE_HASH** are actions susceptible to clear 2237 * the hash and to trigger a new computation for the next call to 2238 * **bpf_get_hash_recalc**\ (). 2239 * Return 2240 * The 32-bit hash. 2241 * 2242 * u64 bpf_get_current_task(void) 2243 * Return 2244 * A pointer to the current task struct. 2245 * 2246 * long bpf_probe_write_user(void *dst, const void *src, u32 len) 2247 * Description 2248 * Attempt in a safe way to write *len* bytes from the buffer 2249 * *src* to *dst* in memory. It only works for threads that are in 2250 * user context, and *dst* must be a valid user space address. 2251 * 2252 * This helper should not be used to implement any kind of 2253 * security mechanism because of TOC-TOU attacks, but rather to 2254 * debug, divert, and manipulate execution of semi-cooperative 2255 * processes. 2256 * 2257 * Keep in mind that this feature is meant for experiments, and it 2258 * has a risk of crashing the system and running programs. 2259 * Therefore, when an eBPF program using this helper is attached, 2260 * a warning including PID and process name is printed to kernel 2261 * logs. 2262 * Return 2263 * 0 on success, or a negative error in case of failure. 2264 * 2265 * long bpf_current_task_under_cgroup(struct bpf_map *map, u32 index) 2266 * Description 2267 * Check whether the probe is being run is the context of a given 2268 * subset of the cgroup2 hierarchy. The cgroup2 to test is held by 2269 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*. 2270 * Return 2271 * The return value depends on the result of the test, and can be: 2272 * 2273 * * 0, if current task belongs to the cgroup2. 2274 * * 1, if current task does not belong to the cgroup2. 2275 * * A negative error code, if an error occurred. 2276 * 2277 * long bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags) 2278 * Description 2279 * Resize (trim or grow) the packet associated to *skb* to the 2280 * new *len*. The *flags* are reserved for future usage, and must 2281 * be left at zero. 2282 * 2283 * The basic idea is that the helper performs the needed work to 2284 * change the size of the packet, then the eBPF program rewrites 2285 * the rest via helpers like **bpf_skb_store_bytes**\ (), 2286 * **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ () 2287 * and others. This helper is a slow path utility intended for 2288 * replies with control messages. And because it is targeted for 2289 * slow path, the helper itself can afford to be slow: it 2290 * implicitly linearizes, unclones and drops offloads from the 2291 * *skb*. 2292 * 2293 * A call to this helper is susceptible to change the underlying 2294 * packet buffer. Therefore, at load time, all checks on pointers 2295 * previously done by the verifier are invalidated and must be 2296 * performed again, if the helper is used in combination with 2297 * direct packet access. 2298 * Return 2299 * 0 on success, or a negative error in case of failure. 2300 * 2301 * long bpf_skb_pull_data(struct sk_buff *skb, u32 len) 2302 * Description 2303 * Pull in non-linear data in case the *skb* is non-linear and not 2304 * all of *len* are part of the linear section. Make *len* bytes 2305 * from *skb* readable and writable. If a zero value is passed for 2306 * *len*, then the whole length of the *skb* is pulled. 2307 * 2308 * This helper is only needed for reading and writing with direct 2309 * packet access. 2310 * 2311 * For direct packet access, testing that offsets to access 2312 * are within packet boundaries (test on *skb*\ **->data_end**) is 2313 * susceptible to fail if offsets are invalid, or if the requested 2314 * data is in non-linear parts of the *skb*. On failure the 2315 * program can just bail out, or in the case of a non-linear 2316 * buffer, use a helper to make the data available. The 2317 * **bpf_skb_load_bytes**\ () helper is a first solution to access 2318 * the data. Another one consists in using **bpf_skb_pull_data** 2319 * to pull in once the non-linear parts, then retesting and 2320 * eventually access the data. 2321 * 2322 * At the same time, this also makes sure the *skb* is uncloned, 2323 * which is a necessary condition for direct write. As this needs 2324 * to be an invariant for the write part only, the verifier 2325 * detects writes and adds a prologue that is calling 2326 * **bpf_skb_pull_data()** to effectively unclone the *skb* from 2327 * the very beginning in case it is indeed cloned. 2328 * 2329 * A call to this helper is susceptible to change the underlying 2330 * packet buffer. Therefore, at load time, all checks on pointers 2331 * previously done by the verifier are invalidated and must be 2332 * performed again, if the helper is used in combination with 2333 * direct packet access. 2334 * Return 2335 * 0 on success, or a negative error in case of failure. 2336 * 2337 * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum) 2338 * Description 2339 * Add the checksum *csum* into *skb*\ **->csum** in case the 2340 * driver has supplied a checksum for the entire packet into that 2341 * field. Return an error otherwise. This helper is intended to be 2342 * used in combination with **bpf_csum_diff**\ (), in particular 2343 * when the checksum needs to be updated after data has been 2344 * written into the packet through direct packet access. 2345 * Return 2346 * The checksum on success, or a negative error code in case of 2347 * failure. 2348 * 2349 * void bpf_set_hash_invalid(struct sk_buff *skb) 2350 * Description 2351 * Invalidate the current *skb*\ **->hash**. It can be used after 2352 * mangling on headers through direct packet access, in order to 2353 * indicate that the hash is outdated and to trigger a 2354 * recalculation the next time the kernel tries to access this 2355 * hash or when the **bpf_get_hash_recalc**\ () helper is called. 2356 * 2357 * long bpf_get_numa_node_id(void) 2358 * Description 2359 * Return the id of the current NUMA node. The primary use case 2360 * for this helper is the selection of sockets for the local NUMA 2361 * node, when the program is attached to sockets using the 2362 * **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**), 2363 * but the helper is also available to other eBPF program types, 2364 * similarly to **bpf_get_smp_processor_id**\ (). 2365 * Return 2366 * The id of current NUMA node. 2367 * 2368 * long bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags) 2369 * Description 2370 * Grows headroom of packet associated to *skb* and adjusts the 2371 * offset of the MAC header accordingly, adding *len* bytes of 2372 * space. It automatically extends and reallocates memory as 2373 * required. 2374 * 2375 * This helper can be used on a layer 3 *skb* to push a MAC header 2376 * for redirection into a layer 2 device. 2377 * 2378 * All values for *flags* are reserved for future usage, and must 2379 * be left at zero. 2380 * 2381 * A call to this helper is susceptible to change the underlying 2382 * packet buffer. Therefore, at load time, all checks on pointers 2383 * previously done by the verifier are invalidated and must be 2384 * performed again, if the helper is used in combination with 2385 * direct packet access. 2386 * Return 2387 * 0 on success, or a negative error in case of failure. 2388 * 2389 * long bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta) 2390 * Description 2391 * Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that 2392 * it is possible to use a negative value for *delta*. This helper 2393 * can be used to prepare the packet for pushing or popping 2394 * headers. 2395 * 2396 * A call to this helper is susceptible to change the underlying 2397 * packet buffer. Therefore, at load time, all checks on pointers 2398 * previously done by the verifier are invalidated and must be 2399 * performed again, if the helper is used in combination with 2400 * direct packet access. 2401 * Return 2402 * 0 on success, or a negative error in case of failure. 2403 * 2404 * long bpf_probe_read_str(void *dst, u32 size, const void *unsafe_ptr) 2405 * Description 2406 * Copy a NUL terminated string from an unsafe kernel address 2407 * *unsafe_ptr* to *dst*. See **bpf_probe_read_kernel_str**\ () for 2408 * more details. 2409 * 2410 * Generally, use **bpf_probe_read_user_str**\ () or 2411 * **bpf_probe_read_kernel_str**\ () instead. 2412 * Return 2413 * On success, the strictly positive length of the string, 2414 * including the trailing NUL character. On error, a negative 2415 * value. 2416 * 2417 * u64 bpf_get_socket_cookie(struct sk_buff *skb) 2418 * Description 2419 * If the **struct sk_buff** pointed by *skb* has a known socket, 2420 * retrieve the cookie (generated by the kernel) of this socket. 2421 * If no cookie has been set yet, generate a new cookie. Once 2422 * generated, the socket cookie remains stable for the life of the 2423 * socket. This helper can be useful for monitoring per socket 2424 * networking traffic statistics as it provides a global socket 2425 * identifier that can be assumed unique. 2426 * Return 2427 * A 8-byte long unique number on success, or 0 if the socket 2428 * field is missing inside *skb*. 2429 * 2430 * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx) 2431 * Description 2432 * Equivalent to bpf_get_socket_cookie() helper that accepts 2433 * *skb*, but gets socket from **struct bpf_sock_addr** context. 2434 * Return 2435 * A 8-byte long unique number. 2436 * 2437 * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx) 2438 * Description 2439 * Equivalent to **bpf_get_socket_cookie**\ () helper that accepts 2440 * *skb*, but gets socket from **struct bpf_sock_ops** context. 2441 * Return 2442 * A 8-byte long unique number. 2443 * 2444 * u64 bpf_get_socket_cookie(struct sock *sk) 2445 * Description 2446 * Equivalent to **bpf_get_socket_cookie**\ () helper that accepts 2447 * *sk*, but gets socket from a BTF **struct sock**. This helper 2448 * also works for sleepable programs. 2449 * Return 2450 * A 8-byte long unique number or 0 if *sk* is NULL. 2451 * 2452 * u32 bpf_get_socket_uid(struct sk_buff *skb) 2453 * Return 2454 * The owner UID of the socket associated to *skb*. If the socket 2455 * is **NULL**, or if it is not a full socket (i.e. if it is a 2456 * time-wait or a request socket instead), **overflowuid** value 2457 * is returned (note that **overflowuid** might also be the actual 2458 * UID value for the socket). 2459 * 2460 * long bpf_set_hash(struct sk_buff *skb, u32 hash) 2461 * Description 2462 * Set the full hash for *skb* (set the field *skb*\ **->hash**) 2463 * to value *hash*. 2464 * Return 2465 * 0 2466 * 2467 * long bpf_setsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen) 2468 * Description 2469 * Emulate a call to **setsockopt()** on the socket associated to 2470 * *bpf_socket*, which must be a full socket. The *level* at 2471 * which the option resides and the name *optname* of the option 2472 * must be specified, see **setsockopt(2)** for more information. 2473 * The option value of length *optlen* is pointed by *optval*. 2474 * 2475 * *bpf_socket* should be one of the following: 2476 * 2477 * * **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**. 2478 * * **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT** 2479 * and **BPF_CGROUP_INET6_CONNECT**. 2480 * 2481 * This helper actually implements a subset of **setsockopt()**. 2482 * It supports the following *level*\ s: 2483 * 2484 * * **SOL_SOCKET**, which supports the following *optname*\ s: 2485 * **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**, 2486 * **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**, 2487 * **SO_BINDTODEVICE**, **SO_KEEPALIVE**. 2488 * * **IPPROTO_TCP**, which supports the following *optname*\ s: 2489 * **TCP_CONGESTION**, **TCP_BPF_IW**, 2490 * **TCP_BPF_SNDCWND_CLAMP**, **TCP_SAVE_SYN**, 2491 * **TCP_KEEPIDLE**, **TCP_KEEPINTVL**, **TCP_KEEPCNT**, 2492 * **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**. 2493 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**. 2494 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**. 2495 * Return 2496 * 0 on success, or a negative error in case of failure. 2497 * 2498 * long bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags) 2499 * Description 2500 * Grow or shrink the room for data in the packet associated to 2501 * *skb* by *len_diff*, and according to the selected *mode*. 2502 * 2503 * By default, the helper will reset any offloaded checksum 2504 * indicator of the skb to CHECKSUM_NONE. This can be avoided 2505 * by the following flag: 2506 * 2507 * * **BPF_F_ADJ_ROOM_NO_CSUM_RESET**: Do not reset offloaded 2508 * checksum data of the skb to CHECKSUM_NONE. 2509 * 2510 * There are two supported modes at this time: 2511 * 2512 * * **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer 2513 * (room space is added or removed below the layer 2 header). 2514 * 2515 * * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer 2516 * (room space is added or removed below the layer 3 header). 2517 * 2518 * The following flags are supported at this time: 2519 * 2520 * * **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size. 2521 * Adjusting mss in this way is not allowed for datagrams. 2522 * 2523 * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4**, 2524 * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6**: 2525 * Any new space is reserved to hold a tunnel header. 2526 * Configure skb offsets and other fields accordingly. 2527 * 2528 * * **BPF_F_ADJ_ROOM_ENCAP_L4_GRE**, 2529 * **BPF_F_ADJ_ROOM_ENCAP_L4_UDP**: 2530 * Use with ENCAP_L3 flags to further specify the tunnel type. 2531 * 2532 * * **BPF_F_ADJ_ROOM_ENCAP_L2**\ (*len*): 2533 * Use with ENCAP_L3/L4 flags to further specify the tunnel 2534 * type; *len* is the length of the inner MAC header. 2535 * 2536 * * **BPF_F_ADJ_ROOM_ENCAP_L2_ETH**: 2537 * Use with BPF_F_ADJ_ROOM_ENCAP_L2 flag to further specify the 2538 * L2 type as Ethernet. 2539 * 2540 * A call to this helper is susceptible to change the underlying 2541 * packet buffer. Therefore, at load time, all checks on pointers 2542 * previously done by the verifier are invalidated and must be 2543 * performed again, if the helper is used in combination with 2544 * direct packet access. 2545 * Return 2546 * 0 on success, or a negative error in case of failure. 2547 * 2548 * long bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags) 2549 * Description 2550 * Redirect the packet to the endpoint referenced by *map* at 2551 * index *key*. Depending on its type, this *map* can contain 2552 * references to net devices (for forwarding packets through other 2553 * ports), or to CPUs (for redirecting XDP frames to another CPU; 2554 * but this is only implemented for native XDP (with driver 2555 * support) as of this writing). 2556 * 2557 * The lower two bits of *flags* are used as the return code if 2558 * the map lookup fails. This is so that the return value can be 2559 * one of the XDP program return codes up to **XDP_TX**, as chosen 2560 * by the caller. The higher bits of *flags* can be set to 2561 * BPF_F_BROADCAST or BPF_F_EXCLUDE_INGRESS as defined below. 2562 * 2563 * With BPF_F_BROADCAST the packet will be broadcasted to all the 2564 * interfaces in the map, with BPF_F_EXCLUDE_INGRESS the ingress 2565 * interface will be excluded when do broadcasting. 2566 * 2567 * See also **bpf_redirect**\ (), which only supports redirecting 2568 * to an ifindex, but doesn't require a map to do so. 2569 * Return 2570 * **XDP_REDIRECT** on success, or the value of the two lower bits 2571 * of the *flags* argument on error. 2572 * 2573 * long bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags) 2574 * Description 2575 * Redirect the packet to the socket referenced by *map* (of type 2576 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and 2577 * egress interfaces can be used for redirection. The 2578 * **BPF_F_INGRESS** value in *flags* is used to make the 2579 * distinction (ingress path is selected if the flag is present, 2580 * egress path otherwise). This is the only flag supported for now. 2581 * Return 2582 * **SK_PASS** on success, or **SK_DROP** on error. 2583 * 2584 * long bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags) 2585 * Description 2586 * Add an entry to, or update a *map* referencing sockets. The 2587 * *skops* is used as a new value for the entry associated to 2588 * *key*. *flags* is one of: 2589 * 2590 * **BPF_NOEXIST** 2591 * The entry for *key* must not exist in the map. 2592 * **BPF_EXIST** 2593 * The entry for *key* must already exist in the map. 2594 * **BPF_ANY** 2595 * No condition on the existence of the entry for *key*. 2596 * 2597 * If the *map* has eBPF programs (parser and verdict), those will 2598 * be inherited by the socket being added. If the socket is 2599 * already attached to eBPF programs, this results in an error. 2600 * Return 2601 * 0 on success, or a negative error in case of failure. 2602 * 2603 * long bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta) 2604 * Description 2605 * Adjust the address pointed by *xdp_md*\ **->data_meta** by 2606 * *delta* (which can be positive or negative). Note that this 2607 * operation modifies the address stored in *xdp_md*\ **->data**, 2608 * so the latter must be loaded only after the helper has been 2609 * called. 2610 * 2611 * The use of *xdp_md*\ **->data_meta** is optional and programs 2612 * are not required to use it. The rationale is that when the 2613 * packet is processed with XDP (e.g. as DoS filter), it is 2614 * possible to push further meta data along with it before passing 2615 * to the stack, and to give the guarantee that an ingress eBPF 2616 * program attached as a TC classifier on the same device can pick 2617 * this up for further post-processing. Since TC works with socket 2618 * buffers, it remains possible to set from XDP the **mark** or 2619 * **priority** pointers, or other pointers for the socket buffer. 2620 * Having this scratch space generic and programmable allows for 2621 * more flexibility as the user is free to store whatever meta 2622 * data they need. 2623 * 2624 * A call to this helper is susceptible to change the underlying 2625 * packet buffer. Therefore, at load time, all checks on pointers 2626 * previously done by the verifier are invalidated and must be 2627 * performed again, if the helper is used in combination with 2628 * direct packet access. 2629 * Return 2630 * 0 on success, or a negative error in case of failure. 2631 * 2632 * long bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size) 2633 * Description 2634 * Read the value of a perf event counter, and store it into *buf* 2635 * of size *buf_size*. This helper relies on a *map* of type 2636 * **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event 2637 * counter is selected when *map* is updated with perf event file 2638 * descriptors. The *map* is an array whose size is the number of 2639 * available CPUs, and each cell contains a value relative to one 2640 * CPU. The value to retrieve is indicated by *flags*, that 2641 * contains the index of the CPU to look up, masked with 2642 * **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to 2643 * **BPF_F_CURRENT_CPU** to indicate that the value for the 2644 * current CPU should be retrieved. 2645 * 2646 * This helper behaves in a way close to 2647 * **bpf_perf_event_read**\ () helper, save that instead of 2648 * just returning the value observed, it fills the *buf* 2649 * structure. This allows for additional data to be retrieved: in 2650 * particular, the enabled and running times (in *buf*\ 2651 * **->enabled** and *buf*\ **->running**, respectively) are 2652 * copied. In general, **bpf_perf_event_read_value**\ () is 2653 * recommended over **bpf_perf_event_read**\ (), which has some 2654 * ABI issues and provides fewer functionalities. 2655 * 2656 * These values are interesting, because hardware PMU (Performance 2657 * Monitoring Unit) counters are limited resources. When there are 2658 * more PMU based perf events opened than available counters, 2659 * kernel will multiplex these events so each event gets certain 2660 * percentage (but not all) of the PMU time. In case that 2661 * multiplexing happens, the number of samples or counter value 2662 * will not reflect the case compared to when no multiplexing 2663 * occurs. This makes comparison between different runs difficult. 2664 * Typically, the counter value should be normalized before 2665 * comparing to other experiments. The usual normalization is done 2666 * as follows. 2667 * 2668 * :: 2669 * 2670 * normalized_counter = counter * t_enabled / t_running 2671 * 2672 * Where t_enabled is the time enabled for event and t_running is 2673 * the time running for event since last normalization. The 2674 * enabled and running times are accumulated since the perf event 2675 * open. To achieve scaling factor between two invocations of an 2676 * eBPF program, users can use CPU id as the key (which is 2677 * typical for perf array usage model) to remember the previous 2678 * value and do the calculation inside the eBPF program. 2679 * Return 2680 * 0 on success, or a negative error in case of failure. 2681 * 2682 * long bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size) 2683 * Description 2684 * For en eBPF program attached to a perf event, retrieve the 2685 * value of the event counter associated to *ctx* and store it in 2686 * the structure pointed by *buf* and of size *buf_size*. Enabled 2687 * and running times are also stored in the structure (see 2688 * description of helper **bpf_perf_event_read_value**\ () for 2689 * more details). 2690 * Return 2691 * 0 on success, or a negative error in case of failure. 2692 * 2693 * long bpf_getsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen) 2694 * Description 2695 * Emulate a call to **getsockopt()** on the socket associated to 2696 * *bpf_socket*, which must be a full socket. The *level* at 2697 * which the option resides and the name *optname* of the option 2698 * must be specified, see **getsockopt(2)** for more information. 2699 * The retrieved value is stored in the structure pointed by 2700 * *opval* and of length *optlen*. 2701 * 2702 * *bpf_socket* should be one of the following: 2703 * 2704 * * **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**. 2705 * * **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT** 2706 * and **BPF_CGROUP_INET6_CONNECT**. 2707 * 2708 * This helper actually implements a subset of **getsockopt()**. 2709 * It supports the following *level*\ s: 2710 * 2711 * * **IPPROTO_TCP**, which supports *optname* 2712 * **TCP_CONGESTION**. 2713 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**. 2714 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**. 2715 * Return 2716 * 0 on success, or a negative error in case of failure. 2717 * 2718 * long bpf_override_return(struct pt_regs *regs, u64 rc) 2719 * Description 2720 * Used for error injection, this helper uses kprobes to override 2721 * the return value of the probed function, and to set it to *rc*. 2722 * The first argument is the context *regs* on which the kprobe 2723 * works. 2724 * 2725 * This helper works by setting the PC (program counter) 2726 * to an override function which is run in place of the original 2727 * probed function. This means the probed function is not run at 2728 * all. The replacement function just returns with the required 2729 * value. 2730 * 2731 * This helper has security implications, and thus is subject to 2732 * restrictions. It is only available if the kernel was compiled 2733 * with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration 2734 * option, and in this case it only works on functions tagged with 2735 * **ALLOW_ERROR_INJECTION** in the kernel code. 2736 * 2737 * Also, the helper is only available for the architectures having 2738 * the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing, 2739 * x86 architecture is the only one to support this feature. 2740 * Return 2741 * 0 2742 * 2743 * long bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval) 2744 * Description 2745 * Attempt to set the value of the **bpf_sock_ops_cb_flags** field 2746 * for the full TCP socket associated to *bpf_sock_ops* to 2747 * *argval*. 2748 * 2749 * The primary use of this field is to determine if there should 2750 * be calls to eBPF programs of type 2751 * **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP 2752 * code. A program of the same type can change its value, per 2753 * connection and as necessary, when the connection is 2754 * established. This field is directly accessible for reading, but 2755 * this helper must be used for updates in order to return an 2756 * error if an eBPF program tries to set a callback that is not 2757 * supported in the current kernel. 2758 * 2759 * *argval* is a flag array which can combine these flags: 2760 * 2761 * * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out) 2762 * * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission) 2763 * * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change) 2764 * * **BPF_SOCK_OPS_RTT_CB_FLAG** (every RTT) 2765 * 2766 * Therefore, this function can be used to clear a callback flag by 2767 * setting the appropriate bit to zero. e.g. to disable the RTO 2768 * callback: 2769 * 2770 * **bpf_sock_ops_cb_flags_set(bpf_sock,** 2771 * **bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)** 2772 * 2773 * Here are some examples of where one could call such eBPF 2774 * program: 2775 * 2776 * * When RTO fires. 2777 * * When a packet is retransmitted. 2778 * * When the connection terminates. 2779 * * When a packet is sent. 2780 * * When a packet is received. 2781 * Return 2782 * Code **-EINVAL** if the socket is not a full TCP socket; 2783 * otherwise, a positive number containing the bits that could not 2784 * be set is returned (which comes down to 0 if all bits were set 2785 * as required). 2786 * 2787 * long bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags) 2788 * Description 2789 * This helper is used in programs implementing policies at the 2790 * socket level. If the message *msg* is allowed to pass (i.e. if 2791 * the verdict eBPF program returns **SK_PASS**), redirect it to 2792 * the socket referenced by *map* (of type 2793 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and 2794 * egress interfaces can be used for redirection. The 2795 * **BPF_F_INGRESS** value in *flags* is used to make the 2796 * distinction (ingress path is selected if the flag is present, 2797 * egress path otherwise). This is the only flag supported for now. 2798 * Return 2799 * **SK_PASS** on success, or **SK_DROP** on error. 2800 * 2801 * long bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes) 2802 * Description 2803 * For socket policies, apply the verdict of the eBPF program to 2804 * the next *bytes* (number of bytes) of message *msg*. 2805 * 2806 * For example, this helper can be used in the following cases: 2807 * 2808 * * A single **sendmsg**\ () or **sendfile**\ () system call 2809 * contains multiple logical messages that the eBPF program is 2810 * supposed to read and for which it should apply a verdict. 2811 * * An eBPF program only cares to read the first *bytes* of a 2812 * *msg*. If the message has a large payload, then setting up 2813 * and calling the eBPF program repeatedly for all bytes, even 2814 * though the verdict is already known, would create unnecessary 2815 * overhead. 2816 * 2817 * When called from within an eBPF program, the helper sets a 2818 * counter internal to the BPF infrastructure, that is used to 2819 * apply the last verdict to the next *bytes*. If *bytes* is 2820 * smaller than the current data being processed from a 2821 * **sendmsg**\ () or **sendfile**\ () system call, the first 2822 * *bytes* will be sent and the eBPF program will be re-run with 2823 * the pointer for start of data pointing to byte number *bytes* 2824 * **+ 1**. If *bytes* is larger than the current data being 2825 * processed, then the eBPF verdict will be applied to multiple 2826 * **sendmsg**\ () or **sendfile**\ () calls until *bytes* are 2827 * consumed. 2828 * 2829 * Note that if a socket closes with the internal counter holding 2830 * a non-zero value, this is not a problem because data is not 2831 * being buffered for *bytes* and is sent as it is received. 2832 * Return 2833 * 0 2834 * 2835 * long bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes) 2836 * Description 2837 * For socket policies, prevent the execution of the verdict eBPF 2838 * program for message *msg* until *bytes* (byte number) have been 2839 * accumulated. 2840 * 2841 * This can be used when one needs a specific number of bytes 2842 * before a verdict can be assigned, even if the data spans 2843 * multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme 2844 * case would be a user calling **sendmsg**\ () repeatedly with 2845 * 1-byte long message segments. Obviously, this is bad for 2846 * performance, but it is still valid. If the eBPF program needs 2847 * *bytes* bytes to validate a header, this helper can be used to 2848 * prevent the eBPF program to be called again until *bytes* have 2849 * been accumulated. 2850 * Return 2851 * 0 2852 * 2853 * long bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags) 2854 * Description 2855 * For socket policies, pull in non-linear data from user space 2856 * for *msg* and set pointers *msg*\ **->data** and *msg*\ 2857 * **->data_end** to *start* and *end* bytes offsets into *msg*, 2858 * respectively. 2859 * 2860 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a 2861 * *msg* it can only parse data that the (**data**, **data_end**) 2862 * pointers have already consumed. For **sendmsg**\ () hooks this 2863 * is likely the first scatterlist element. But for calls relying 2864 * on the **sendpage** handler (e.g. **sendfile**\ ()) this will 2865 * be the range (**0**, **0**) because the data is shared with 2866 * user space and by default the objective is to avoid allowing 2867 * user space to modify data while (or after) eBPF verdict is 2868 * being decided. This helper can be used to pull in data and to 2869 * set the start and end pointer to given values. Data will be 2870 * copied if necessary (i.e. if data was not linear and if start 2871 * and end pointers do not point to the same chunk). 2872 * 2873 * A call to this helper is susceptible to change the underlying 2874 * packet buffer. Therefore, at load time, all checks on pointers 2875 * previously done by the verifier are invalidated and must be 2876 * performed again, if the helper is used in combination with 2877 * direct packet access. 2878 * 2879 * All values for *flags* are reserved for future usage, and must 2880 * be left at zero. 2881 * Return 2882 * 0 on success, or a negative error in case of failure. 2883 * 2884 * long bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len) 2885 * Description 2886 * Bind the socket associated to *ctx* to the address pointed by 2887 * *addr*, of length *addr_len*. This allows for making outgoing 2888 * connection from the desired IP address, which can be useful for 2889 * example when all processes inside a cgroup should use one 2890 * single IP address on a host that has multiple IP configured. 2891 * 2892 * This helper works for IPv4 and IPv6, TCP and UDP sockets. The 2893 * domain (*addr*\ **->sa_family**) must be **AF_INET** (or 2894 * **AF_INET6**). It's advised to pass zero port (**sin_port** 2895 * or **sin6_port**) which triggers IP_BIND_ADDRESS_NO_PORT-like 2896 * behavior and lets the kernel efficiently pick up an unused 2897 * port as long as 4-tuple is unique. Passing non-zero port might 2898 * lead to degraded performance. 2899 * Return 2900 * 0 on success, or a negative error in case of failure. 2901 * 2902 * long bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta) 2903 * Description 2904 * Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is 2905 * possible to both shrink and grow the packet tail. 2906 * Shrink done via *delta* being a negative integer. 2907 * 2908 * A call to this helper is susceptible to change the underlying 2909 * packet buffer. Therefore, at load time, all checks on pointers 2910 * previously done by the verifier are invalidated and must be 2911 * performed again, if the helper is used in combination with 2912 * direct packet access. 2913 * Return 2914 * 0 on success, or a negative error in case of failure. 2915 * 2916 * long bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags) 2917 * Description 2918 * Retrieve the XFRM state (IP transform framework, see also 2919 * **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*. 2920 * 2921 * The retrieved value is stored in the **struct bpf_xfrm_state** 2922 * pointed by *xfrm_state* and of length *size*. 2923 * 2924 * All values for *flags* are reserved for future usage, and must 2925 * be left at zero. 2926 * 2927 * This helper is available only if the kernel was compiled with 2928 * **CONFIG_XFRM** configuration option. 2929 * Return 2930 * 0 on success, or a negative error in case of failure. 2931 * 2932 * long bpf_get_stack(void *ctx, void *buf, u32 size, u64 flags) 2933 * Description 2934 * Return a user or a kernel stack in bpf program provided buffer. 2935 * To achieve this, the helper needs *ctx*, which is a pointer 2936 * to the context on which the tracing program is executed. 2937 * To store the stacktrace, the bpf program provides *buf* with 2938 * a nonnegative *size*. 2939 * 2940 * The last argument, *flags*, holds the number of stack frames to 2941 * skip (from 0 to 255), masked with 2942 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 2943 * the following flags: 2944 * 2945 * **BPF_F_USER_STACK** 2946 * Collect a user space stack instead of a kernel stack. 2947 * **BPF_F_USER_BUILD_ID** 2948 * Collect buildid+offset instead of ips for user stack, 2949 * only valid if **BPF_F_USER_STACK** is also specified. 2950 * 2951 * **bpf_get_stack**\ () can collect up to 2952 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject 2953 * to sufficient large buffer size. Note that 2954 * this limit can be controlled with the **sysctl** program, and 2955 * that it should be manually increased in order to profile long 2956 * user stacks (such as stacks for Java programs). To do so, use: 2957 * 2958 * :: 2959 * 2960 * # sysctl kernel.perf_event_max_stack=<new value> 2961 * Return 2962 * A non-negative value equal to or less than *size* on success, 2963 * or a negative error in case of failure. 2964 * 2965 * long bpf_skb_load_bytes_relative(const void *skb, u32 offset, void *to, u32 len, u32 start_header) 2966 * Description 2967 * This helper is similar to **bpf_skb_load_bytes**\ () in that 2968 * it provides an easy way to load *len* bytes from *offset* 2969 * from the packet associated to *skb*, into the buffer pointed 2970 * by *to*. The difference to **bpf_skb_load_bytes**\ () is that 2971 * a fifth argument *start_header* exists in order to select a 2972 * base offset to start from. *start_header* can be one of: 2973 * 2974 * **BPF_HDR_START_MAC** 2975 * Base offset to load data from is *skb*'s mac header. 2976 * **BPF_HDR_START_NET** 2977 * Base offset to load data from is *skb*'s network header. 2978 * 2979 * In general, "direct packet access" is the preferred method to 2980 * access packet data, however, this helper is in particular useful 2981 * in socket filters where *skb*\ **->data** does not always point 2982 * to the start of the mac header and where "direct packet access" 2983 * is not available. 2984 * Return 2985 * 0 on success, or a negative error in case of failure. 2986 * 2987 * long bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags) 2988 * Description 2989 * Do FIB lookup in kernel tables using parameters in *params*. 2990 * If lookup is successful and result shows packet is to be 2991 * forwarded, the neighbor tables are searched for the nexthop. 2992 * If successful (ie., FIB lookup shows forwarding and nexthop 2993 * is resolved), the nexthop address is returned in ipv4_dst 2994 * or ipv6_dst based on family, smac is set to mac address of 2995 * egress device, dmac is set to nexthop mac address, rt_metric 2996 * is set to metric from route (IPv4/IPv6 only), and ifindex 2997 * is set to the device index of the nexthop from the FIB lookup. 2998 * 2999 * *plen* argument is the size of the passed in struct. 3000 * *flags* argument can be a combination of one or more of the 3001 * following values: 3002 * 3003 * **BPF_FIB_LOOKUP_DIRECT** 3004 * Do a direct table lookup vs full lookup using FIB 3005 * rules. 3006 * **BPF_FIB_LOOKUP_OUTPUT** 3007 * Perform lookup from an egress perspective (default is 3008 * ingress). 3009 * 3010 * *ctx* is either **struct xdp_md** for XDP programs or 3011 * **struct sk_buff** tc cls_act programs. 3012 * Return 3013 * * < 0 if any input argument is invalid 3014 * * 0 on success (packet is forwarded, nexthop neighbor exists) 3015 * * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the 3016 * packet is not forwarded or needs assist from full stack 3017 * 3018 * If lookup fails with BPF_FIB_LKUP_RET_FRAG_NEEDED, then the MTU 3019 * was exceeded and output params->mtu_result contains the MTU. 3020 * 3021 * long bpf_sock_hash_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags) 3022 * Description 3023 * Add an entry to, or update a sockhash *map* referencing sockets. 3024 * The *skops* is used as a new value for the entry associated to 3025 * *key*. *flags* is one of: 3026 * 3027 * **BPF_NOEXIST** 3028 * The entry for *key* must not exist in the map. 3029 * **BPF_EXIST** 3030 * The entry for *key* must already exist in the map. 3031 * **BPF_ANY** 3032 * No condition on the existence of the entry for *key*. 3033 * 3034 * If the *map* has eBPF programs (parser and verdict), those will 3035 * be inherited by the socket being added. If the socket is 3036 * already attached to eBPF programs, this results in an error. 3037 * Return 3038 * 0 on success, or a negative error in case of failure. 3039 * 3040 * long bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags) 3041 * Description 3042 * This helper is used in programs implementing policies at the 3043 * socket level. If the message *msg* is allowed to pass (i.e. if 3044 * the verdict eBPF program returns **SK_PASS**), redirect it to 3045 * the socket referenced by *map* (of type 3046 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and 3047 * egress interfaces can be used for redirection. The 3048 * **BPF_F_INGRESS** value in *flags* is used to make the 3049 * distinction (ingress path is selected if the flag is present, 3050 * egress path otherwise). This is the only flag supported for now. 3051 * Return 3052 * **SK_PASS** on success, or **SK_DROP** on error. 3053 * 3054 * long bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags) 3055 * Description 3056 * This helper is used in programs implementing policies at the 3057 * skb socket level. If the sk_buff *skb* is allowed to pass (i.e. 3058 * if the verdict eBPF program returns **SK_PASS**), redirect it 3059 * to the socket referenced by *map* (of type 3060 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and 3061 * egress interfaces can be used for redirection. The 3062 * **BPF_F_INGRESS** value in *flags* is used to make the 3063 * distinction (ingress path is selected if the flag is present, 3064 * egress otherwise). This is the only flag supported for now. 3065 * Return 3066 * **SK_PASS** on success, or **SK_DROP** on error. 3067 * 3068 * long bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len) 3069 * Description 3070 * Encapsulate the packet associated to *skb* within a Layer 3 3071 * protocol header. This header is provided in the buffer at 3072 * address *hdr*, with *len* its size in bytes. *type* indicates 3073 * the protocol of the header and can be one of: 3074 * 3075 * **BPF_LWT_ENCAP_SEG6** 3076 * IPv6 encapsulation with Segment Routing Header 3077 * (**struct ipv6_sr_hdr**). *hdr* only contains the SRH, 3078 * the IPv6 header is computed by the kernel. 3079 * **BPF_LWT_ENCAP_SEG6_INLINE** 3080 * Only works if *skb* contains an IPv6 packet. Insert a 3081 * Segment Routing Header (**struct ipv6_sr_hdr**) inside 3082 * the IPv6 header. 3083 * **BPF_LWT_ENCAP_IP** 3084 * IP encapsulation (GRE/GUE/IPIP/etc). The outer header 3085 * must be IPv4 or IPv6, followed by zero or more 3086 * additional headers, up to **LWT_BPF_MAX_HEADROOM** 3087 * total bytes in all prepended headers. Please note that 3088 * if **skb_is_gso**\ (*skb*) is true, no more than two 3089 * headers can be prepended, and the inner header, if 3090 * present, should be either GRE or UDP/GUE. 3091 * 3092 * **BPF_LWT_ENCAP_SEG6**\ \* types can be called by BPF programs 3093 * of type **BPF_PROG_TYPE_LWT_IN**; **BPF_LWT_ENCAP_IP** type can 3094 * be called by bpf programs of types **BPF_PROG_TYPE_LWT_IN** and 3095 * **BPF_PROG_TYPE_LWT_XMIT**. 3096 * 3097 * A call to this helper is susceptible to change the underlying 3098 * packet buffer. Therefore, at load time, all checks on pointers 3099 * previously done by the verifier are invalidated and must be 3100 * performed again, if the helper is used in combination with 3101 * direct packet access. 3102 * Return 3103 * 0 on success, or a negative error in case of failure. 3104 * 3105 * long bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len) 3106 * Description 3107 * Store *len* bytes from address *from* into the packet 3108 * associated to *skb*, at *offset*. Only the flags, tag and TLVs 3109 * inside the outermost IPv6 Segment Routing Header can be 3110 * modified through this helper. 3111 * 3112 * A call to this helper is susceptible to change the underlying 3113 * packet buffer. Therefore, at load time, all checks on pointers 3114 * previously done by the verifier are invalidated and must be 3115 * performed again, if the helper is used in combination with 3116 * direct packet access. 3117 * Return 3118 * 0 on success, or a negative error in case of failure. 3119 * 3120 * long bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta) 3121 * Description 3122 * Adjust the size allocated to TLVs in the outermost IPv6 3123 * Segment Routing Header contained in the packet associated to 3124 * *skb*, at position *offset* by *delta* bytes. Only offsets 3125 * after the segments are accepted. *delta* can be as well 3126 * positive (growing) as negative (shrinking). 3127 * 3128 * A call to this helper is susceptible to change the underlying 3129 * packet buffer. Therefore, at load time, all checks on pointers 3130 * previously done by the verifier are invalidated and must be 3131 * performed again, if the helper is used in combination with 3132 * direct packet access. 3133 * Return 3134 * 0 on success, or a negative error in case of failure. 3135 * 3136 * long bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len) 3137 * Description 3138 * Apply an IPv6 Segment Routing action of type *action* to the 3139 * packet associated to *skb*. Each action takes a parameter 3140 * contained at address *param*, and of length *param_len* bytes. 3141 * *action* can be one of: 3142 * 3143 * **SEG6_LOCAL_ACTION_END_X** 3144 * End.X action: Endpoint with Layer-3 cross-connect. 3145 * Type of *param*: **struct in6_addr**. 3146 * **SEG6_LOCAL_ACTION_END_T** 3147 * End.T action: Endpoint with specific IPv6 table lookup. 3148 * Type of *param*: **int**. 3149 * **SEG6_LOCAL_ACTION_END_B6** 3150 * End.B6 action: Endpoint bound to an SRv6 policy. 3151 * Type of *param*: **struct ipv6_sr_hdr**. 3152 * **SEG6_LOCAL_ACTION_END_B6_ENCAP** 3153 * End.B6.Encap action: Endpoint bound to an SRv6 3154 * encapsulation policy. 3155 * Type of *param*: **struct ipv6_sr_hdr**. 3156 * 3157 * A call to this helper is susceptible to change the underlying 3158 * packet buffer. Therefore, at load time, all checks on pointers 3159 * previously done by the verifier are invalidated and must be 3160 * performed again, if the helper is used in combination with 3161 * direct packet access. 3162 * Return 3163 * 0 on success, or a negative error in case of failure. 3164 * 3165 * long bpf_rc_repeat(void *ctx) 3166 * Description 3167 * This helper is used in programs implementing IR decoding, to 3168 * report a successfully decoded repeat key message. This delays 3169 * the generation of a key up event for previously generated 3170 * key down event. 3171 * 3172 * Some IR protocols like NEC have a special IR message for 3173 * repeating last button, for when a button is held down. 3174 * 3175 * The *ctx* should point to the lirc sample as passed into 3176 * the program. 3177 * 3178 * This helper is only available is the kernel was compiled with 3179 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 3180 * "**y**". 3181 * Return 3182 * 0 3183 * 3184 * long bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle) 3185 * Description 3186 * This helper is used in programs implementing IR decoding, to 3187 * report a successfully decoded key press with *scancode*, 3188 * *toggle* value in the given *protocol*. The scancode will be 3189 * translated to a keycode using the rc keymap, and reported as 3190 * an input key down event. After a period a key up event is 3191 * generated. This period can be extended by calling either 3192 * **bpf_rc_keydown**\ () again with the same values, or calling 3193 * **bpf_rc_repeat**\ (). 3194 * 3195 * Some protocols include a toggle bit, in case the button was 3196 * released and pressed again between consecutive scancodes. 3197 * 3198 * The *ctx* should point to the lirc sample as passed into 3199 * the program. 3200 * 3201 * The *protocol* is the decoded protocol number (see 3202 * **enum rc_proto** for some predefined values). 3203 * 3204 * This helper is only available is the kernel was compiled with 3205 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 3206 * "**y**". 3207 * Return 3208 * 0 3209 * 3210 * u64 bpf_skb_cgroup_id(struct sk_buff *skb) 3211 * Description 3212 * Return the cgroup v2 id of the socket associated with the *skb*. 3213 * This is roughly similar to the **bpf_get_cgroup_classid**\ () 3214 * helper for cgroup v1 by providing a tag resp. identifier that 3215 * can be matched on or used for map lookups e.g. to implement 3216 * policy. The cgroup v2 id of a given path in the hierarchy is 3217 * exposed in user space through the f_handle API in order to get 3218 * to the same 64-bit id. 3219 * 3220 * This helper can be used on TC egress path, but not on ingress, 3221 * and is available only if the kernel was compiled with the 3222 * **CONFIG_SOCK_CGROUP_DATA** configuration option. 3223 * Return 3224 * The id is returned or 0 in case the id could not be retrieved. 3225 * 3226 * u64 bpf_get_current_cgroup_id(void) 3227 * Return 3228 * A 64-bit integer containing the current cgroup id based 3229 * on the cgroup within which the current task is running. 3230 * 3231 * void *bpf_get_local_storage(void *map, u64 flags) 3232 * Description 3233 * Get the pointer to the local storage area. 3234 * The type and the size of the local storage is defined 3235 * by the *map* argument. 3236 * The *flags* meaning is specific for each map type, 3237 * and has to be 0 for cgroup local storage. 3238 * 3239 * Depending on the BPF program type, a local storage area 3240 * can be shared between multiple instances of the BPF program, 3241 * running simultaneously. 3242 * 3243 * A user should care about the synchronization by himself. 3244 * For example, by using the **BPF_ATOMIC** instructions to alter 3245 * the shared data. 3246 * Return 3247 * A pointer to the local storage area. 3248 * 3249 * long bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags) 3250 * Description 3251 * Select a **SO_REUSEPORT** socket from a 3252 * **BPF_MAP_TYPE_REUSEPORT_ARRAY** *map*. 3253 * It checks the selected socket is matching the incoming 3254 * request in the socket buffer. 3255 * Return 3256 * 0 on success, or a negative error in case of failure. 3257 * 3258 * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level) 3259 * Description 3260 * Return id of cgroup v2 that is ancestor of cgroup associated 3261 * with the *skb* at the *ancestor_level*. The root cgroup is at 3262 * *ancestor_level* zero and each step down the hierarchy 3263 * increments the level. If *ancestor_level* == level of cgroup 3264 * associated with *skb*, then return value will be same as that 3265 * of **bpf_skb_cgroup_id**\ (). 3266 * 3267 * The helper is useful to implement policies based on cgroups 3268 * that are upper in hierarchy than immediate cgroup associated 3269 * with *skb*. 3270 * 3271 * The format of returned id and helper limitations are same as in 3272 * **bpf_skb_cgroup_id**\ (). 3273 * Return 3274 * The id is returned or 0 in case the id could not be retrieved. 3275 * 3276 * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 3277 * Description 3278 * Look for TCP socket matching *tuple*, optionally in a child 3279 * network namespace *netns*. The return value must be checked, 3280 * and if non-**NULL**, released via **bpf_sk_release**\ (). 3281 * 3282 * The *ctx* should point to the context of the program, such as 3283 * the skb or socket (depending on the hook in use). This is used 3284 * to determine the base network namespace for the lookup. 3285 * 3286 * *tuple_size* must be one of: 3287 * 3288 * **sizeof**\ (*tuple*\ **->ipv4**) 3289 * Look for an IPv4 socket. 3290 * **sizeof**\ (*tuple*\ **->ipv6**) 3291 * Look for an IPv6 socket. 3292 * 3293 * If the *netns* is a negative signed 32-bit integer, then the 3294 * socket lookup table in the netns associated with the *ctx* 3295 * will be used. For the TC hooks, this is the netns of the device 3296 * in the skb. For socket hooks, this is the netns of the socket. 3297 * If *netns* is any other signed 32-bit value greater than or 3298 * equal to zero then it specifies the ID of the netns relative to 3299 * the netns associated with the *ctx*. *netns* values beyond the 3300 * range of 32-bit integers are reserved for future use. 3301 * 3302 * All values for *flags* are reserved for future usage, and must 3303 * be left at zero. 3304 * 3305 * This helper is available only if the kernel was compiled with 3306 * **CONFIG_NET** configuration option. 3307 * Return 3308 * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 3309 * For sockets with reuseport option, the **struct bpf_sock** 3310 * result is from *reuse*\ **->socks**\ [] using the hash of the 3311 * tuple. 3312 * 3313 * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 3314 * Description 3315 * Look for UDP socket matching *tuple*, optionally in a child 3316 * network namespace *netns*. The return value must be checked, 3317 * and if non-**NULL**, released via **bpf_sk_release**\ (). 3318 * 3319 * The *ctx* should point to the context of the program, such as 3320 * the skb or socket (depending on the hook in use). This is used 3321 * to determine the base network namespace for the lookup. 3322 * 3323 * *tuple_size* must be one of: 3324 * 3325 * **sizeof**\ (*tuple*\ **->ipv4**) 3326 * Look for an IPv4 socket. 3327 * **sizeof**\ (*tuple*\ **->ipv6**) 3328 * Look for an IPv6 socket. 3329 * 3330 * If the *netns* is a negative signed 32-bit integer, then the 3331 * socket lookup table in the netns associated with the *ctx* 3332 * will be used. For the TC hooks, this is the netns of the device 3333 * in the skb. For socket hooks, this is the netns of the socket. 3334 * If *netns* is any other signed 32-bit value greater than or 3335 * equal to zero then it specifies the ID of the netns relative to 3336 * the netns associated with the *ctx*. *netns* values beyond the 3337 * range of 32-bit integers are reserved for future use. 3338 * 3339 * All values for *flags* are reserved for future usage, and must 3340 * be left at zero. 3341 * 3342 * This helper is available only if the kernel was compiled with 3343 * **CONFIG_NET** configuration option. 3344 * Return 3345 * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 3346 * For sockets with reuseport option, the **struct bpf_sock** 3347 * result is from *reuse*\ **->socks**\ [] using the hash of the 3348 * tuple. 3349 * 3350 * long bpf_sk_release(void *sock) 3351 * Description 3352 * Release the reference held by *sock*. *sock* must be a 3353 * non-**NULL** pointer that was returned from 3354 * **bpf_sk_lookup_xxx**\ (). 3355 * Return 3356 * 0 on success, or a negative error in case of failure. 3357 * 3358 * long bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags) 3359 * Description 3360 * Push an element *value* in *map*. *flags* is one of: 3361 * 3362 * **BPF_EXIST** 3363 * If the queue/stack is full, the oldest element is 3364 * removed to make room for this. 3365 * Return 3366 * 0 on success, or a negative error in case of failure. 3367 * 3368 * long bpf_map_pop_elem(struct bpf_map *map, void *value) 3369 * Description 3370 * Pop an element from *map*. 3371 * Return 3372 * 0 on success, or a negative error in case of failure. 3373 * 3374 * long bpf_map_peek_elem(struct bpf_map *map, void *value) 3375 * Description 3376 * Get an element from *map* without removing it. 3377 * Return 3378 * 0 on success, or a negative error in case of failure. 3379 * 3380 * long bpf_msg_push_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags) 3381 * Description 3382 * For socket policies, insert *len* bytes into *msg* at offset 3383 * *start*. 3384 * 3385 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a 3386 * *msg* it may want to insert metadata or options into the *msg*. 3387 * This can later be read and used by any of the lower layer BPF 3388 * hooks. 3389 * 3390 * This helper may fail if under memory pressure (a malloc 3391 * fails) in these cases BPF programs will get an appropriate 3392 * error and BPF programs will need to handle them. 3393 * Return 3394 * 0 on success, or a negative error in case of failure. 3395 * 3396 * long bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags) 3397 * Description 3398 * Will remove *len* bytes from a *msg* starting at byte *start*. 3399 * This may result in **ENOMEM** errors under certain situations if 3400 * an allocation and copy are required due to a full ring buffer. 3401 * However, the helper will try to avoid doing the allocation 3402 * if possible. Other errors can occur if input parameters are 3403 * invalid either due to *start* byte not being valid part of *msg* 3404 * payload and/or *pop* value being to large. 3405 * Return 3406 * 0 on success, or a negative error in case of failure. 3407 * 3408 * long bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y) 3409 * Description 3410 * This helper is used in programs implementing IR decoding, to 3411 * report a successfully decoded pointer movement. 3412 * 3413 * The *ctx* should point to the lirc sample as passed into 3414 * the program. 3415 * 3416 * This helper is only available is the kernel was compiled with 3417 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 3418 * "**y**". 3419 * Return 3420 * 0 3421 * 3422 * long bpf_spin_lock(struct bpf_spin_lock *lock) 3423 * Description 3424 * Acquire a spinlock represented by the pointer *lock*, which is 3425 * stored as part of a value of a map. Taking the lock allows to 3426 * safely update the rest of the fields in that value. The 3427 * spinlock can (and must) later be released with a call to 3428 * **bpf_spin_unlock**\ (\ *lock*\ ). 3429 * 3430 * Spinlocks in BPF programs come with a number of restrictions 3431 * and constraints: 3432 * 3433 * * **bpf_spin_lock** objects are only allowed inside maps of 3434 * types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this 3435 * list could be extended in the future). 3436 * * BTF description of the map is mandatory. 3437 * * The BPF program can take ONE lock at a time, since taking two 3438 * or more could cause dead locks. 3439 * * Only one **struct bpf_spin_lock** is allowed per map element. 3440 * * When the lock is taken, calls (either BPF to BPF or helpers) 3441 * are not allowed. 3442 * * The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not 3443 * allowed inside a spinlock-ed region. 3444 * * The BPF program MUST call **bpf_spin_unlock**\ () to release 3445 * the lock, on all execution paths, before it returns. 3446 * * The BPF program can access **struct bpf_spin_lock** only via 3447 * the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ () 3448 * helpers. Loading or storing data into the **struct 3449 * bpf_spin_lock** *lock*\ **;** field of a map is not allowed. 3450 * * To use the **bpf_spin_lock**\ () helper, the BTF description 3451 * of the map value must be a struct and have **struct 3452 * bpf_spin_lock** *anyname*\ **;** field at the top level. 3453 * Nested lock inside another struct is not allowed. 3454 * * The **struct bpf_spin_lock** *lock* field in a map value must 3455 * be aligned on a multiple of 4 bytes in that value. 3456 * * Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy 3457 * the **bpf_spin_lock** field to user space. 3458 * * Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from 3459 * a BPF program, do not update the **bpf_spin_lock** field. 3460 * * **bpf_spin_lock** cannot be on the stack or inside a 3461 * networking packet (it can only be inside of a map values). 3462 * * **bpf_spin_lock** is available to root only. 3463 * * Tracing programs and socket filter programs cannot use 3464 * **bpf_spin_lock**\ () due to insufficient preemption checks 3465 * (but this may change in the future). 3466 * * **bpf_spin_lock** is not allowed in inner maps of map-in-map. 3467 * Return 3468 * 0 3469 * 3470 * long bpf_spin_unlock(struct bpf_spin_lock *lock) 3471 * Description 3472 * Release the *lock* previously locked by a call to 3473 * **bpf_spin_lock**\ (\ *lock*\ ). 3474 * Return 3475 * 0 3476 * 3477 * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk) 3478 * Description 3479 * This helper gets a **struct bpf_sock** pointer such 3480 * that all the fields in this **bpf_sock** can be accessed. 3481 * Return 3482 * A **struct bpf_sock** pointer on success, or **NULL** in 3483 * case of failure. 3484 * 3485 * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk) 3486 * Description 3487 * This helper gets a **struct bpf_tcp_sock** pointer from a 3488 * **struct bpf_sock** pointer. 3489 * Return 3490 * A **struct bpf_tcp_sock** pointer on success, or **NULL** in 3491 * case of failure. 3492 * 3493 * long bpf_skb_ecn_set_ce(struct sk_buff *skb) 3494 * Description 3495 * Set ECN (Explicit Congestion Notification) field of IP header 3496 * to **CE** (Congestion Encountered) if current value is **ECT** 3497 * (ECN Capable Transport). Otherwise, do nothing. Works with IPv6 3498 * and IPv4. 3499 * Return 3500 * 1 if the **CE** flag is set (either by the current helper call 3501 * or because it was already present), 0 if it is not set. 3502 * 3503 * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk) 3504 * Description 3505 * Return a **struct bpf_sock** pointer in **TCP_LISTEN** state. 3506 * **bpf_sk_release**\ () is unnecessary and not allowed. 3507 * Return 3508 * A **struct bpf_sock** pointer on success, or **NULL** in 3509 * case of failure. 3510 * 3511 * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 3512 * Description 3513 * Look for TCP socket matching *tuple*, optionally in a child 3514 * network namespace *netns*. The return value must be checked, 3515 * and if non-**NULL**, released via **bpf_sk_release**\ (). 3516 * 3517 * This function is identical to **bpf_sk_lookup_tcp**\ (), except 3518 * that it also returns timewait or request sockets. Use 3519 * **bpf_sk_fullsock**\ () or **bpf_tcp_sock**\ () to access the 3520 * full structure. 3521 * 3522 * This helper is available only if the kernel was compiled with 3523 * **CONFIG_NET** configuration option. 3524 * Return 3525 * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 3526 * For sockets with reuseport option, the **struct bpf_sock** 3527 * result is from *reuse*\ **->socks**\ [] using the hash of the 3528 * tuple. 3529 * 3530 * long bpf_tcp_check_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len) 3531 * Description 3532 * Check whether *iph* and *th* contain a valid SYN cookie ACK for 3533 * the listening socket in *sk*. 3534 * 3535 * *iph* points to the start of the IPv4 or IPv6 header, while 3536 * *iph_len* contains **sizeof**\ (**struct iphdr**) or 3537 * **sizeof**\ (**struct ip6hdr**). 3538 * 3539 * *th* points to the start of the TCP header, while *th_len* 3540 * contains **sizeof**\ (**struct tcphdr**). 3541 * Return 3542 * 0 if *iph* and *th* are a valid SYN cookie ACK, or a negative 3543 * error otherwise. 3544 * 3545 * long bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags) 3546 * Description 3547 * Get name of sysctl in /proc/sys/ and copy it into provided by 3548 * program buffer *buf* of size *buf_len*. 3549 * 3550 * The buffer is always NUL terminated, unless it's zero-sized. 3551 * 3552 * If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is 3553 * copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name 3554 * only (e.g. "tcp_mem"). 3555 * Return 3556 * Number of character copied (not including the trailing NUL). 3557 * 3558 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 3559 * truncated name in this case). 3560 * 3561 * long bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len) 3562 * Description 3563 * Get current value of sysctl as it is presented in /proc/sys 3564 * (incl. newline, etc), and copy it as a string into provided 3565 * by program buffer *buf* of size *buf_len*. 3566 * 3567 * The whole value is copied, no matter what file position user 3568 * space issued e.g. sys_read at. 3569 * 3570 * The buffer is always NUL terminated, unless it's zero-sized. 3571 * Return 3572 * Number of character copied (not including the trailing NUL). 3573 * 3574 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 3575 * truncated name in this case). 3576 * 3577 * **-EINVAL** if current value was unavailable, e.g. because 3578 * sysctl is uninitialized and read returns -EIO for it. 3579 * 3580 * long bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len) 3581 * Description 3582 * Get new value being written by user space to sysctl (before 3583 * the actual write happens) and copy it as a string into 3584 * provided by program buffer *buf* of size *buf_len*. 3585 * 3586 * User space may write new value at file position > 0. 3587 * 3588 * The buffer is always NUL terminated, unless it's zero-sized. 3589 * Return 3590 * Number of character copied (not including the trailing NUL). 3591 * 3592 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 3593 * truncated name in this case). 3594 * 3595 * **-EINVAL** if sysctl is being read. 3596 * 3597 * long bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len) 3598 * Description 3599 * Override new value being written by user space to sysctl with 3600 * value provided by program in buffer *buf* of size *buf_len*. 3601 * 3602 * *buf* should contain a string in same form as provided by user 3603 * space on sysctl write. 3604 * 3605 * User space may write new value at file position > 0. To override 3606 * the whole sysctl value file position should be set to zero. 3607 * Return 3608 * 0 on success. 3609 * 3610 * **-E2BIG** if the *buf_len* is too big. 3611 * 3612 * **-EINVAL** if sysctl is being read. 3613 * 3614 * long bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res) 3615 * Description 3616 * Convert the initial part of the string from buffer *buf* of 3617 * size *buf_len* to a long integer according to the given base 3618 * and save the result in *res*. 3619 * 3620 * The string may begin with an arbitrary amount of white space 3621 * (as determined by **isspace**\ (3)) followed by a single 3622 * optional '**-**' sign. 3623 * 3624 * Five least significant bits of *flags* encode base, other bits 3625 * are currently unused. 3626 * 3627 * Base must be either 8, 10, 16 or 0 to detect it automatically 3628 * similar to user space **strtol**\ (3). 3629 * Return 3630 * Number of characters consumed on success. Must be positive but 3631 * no more than *buf_len*. 3632 * 3633 * **-EINVAL** if no valid digits were found or unsupported base 3634 * was provided. 3635 * 3636 * **-ERANGE** if resulting value was out of range. 3637 * 3638 * long bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res) 3639 * Description 3640 * Convert the initial part of the string from buffer *buf* of 3641 * size *buf_len* to an unsigned long integer according to the 3642 * given base and save the result in *res*. 3643 * 3644 * The string may begin with an arbitrary amount of white space 3645 * (as determined by **isspace**\ (3)). 3646 * 3647 * Five least significant bits of *flags* encode base, other bits 3648 * are currently unused. 3649 * 3650 * Base must be either 8, 10, 16 or 0 to detect it automatically 3651 * similar to user space **strtoul**\ (3). 3652 * Return 3653 * Number of characters consumed on success. Must be positive but 3654 * no more than *buf_len*. 3655 * 3656 * **-EINVAL** if no valid digits were found or unsupported base 3657 * was provided. 3658 * 3659 * **-ERANGE** if resulting value was out of range. 3660 * 3661 * void *bpf_sk_storage_get(struct bpf_map *map, void *sk, void *value, u64 flags) 3662 * Description 3663 * Get a bpf-local-storage from a *sk*. 3664 * 3665 * Logically, it could be thought of getting the value from 3666 * a *map* with *sk* as the **key**. From this 3667 * perspective, the usage is not much different from 3668 * **bpf_map_lookup_elem**\ (*map*, **&**\ *sk*) except this 3669 * helper enforces the key must be a full socket and the map must 3670 * be a **BPF_MAP_TYPE_SK_STORAGE** also. 3671 * 3672 * Underneath, the value is stored locally at *sk* instead of 3673 * the *map*. The *map* is used as the bpf-local-storage 3674 * "type". The bpf-local-storage "type" (i.e. the *map*) is 3675 * searched against all bpf-local-storages residing at *sk*. 3676 * 3677 * *sk* is a kernel **struct sock** pointer for LSM program. 3678 * *sk* is a **struct bpf_sock** pointer for other program types. 3679 * 3680 * An optional *flags* (**BPF_SK_STORAGE_GET_F_CREATE**) can be 3681 * used such that a new bpf-local-storage will be 3682 * created if one does not exist. *value* can be used 3683 * together with **BPF_SK_STORAGE_GET_F_CREATE** to specify 3684 * the initial value of a bpf-local-storage. If *value* is 3685 * **NULL**, the new bpf-local-storage will be zero initialized. 3686 * Return 3687 * A bpf-local-storage pointer is returned on success. 3688 * 3689 * **NULL** if not found or there was an error in adding 3690 * a new bpf-local-storage. 3691 * 3692 * long bpf_sk_storage_delete(struct bpf_map *map, void *sk) 3693 * Description 3694 * Delete a bpf-local-storage from a *sk*. 3695 * Return 3696 * 0 on success. 3697 * 3698 * **-ENOENT** if the bpf-local-storage cannot be found. 3699 * **-EINVAL** if sk is not a fullsock (e.g. a request_sock). 3700 * 3701 * long bpf_send_signal(u32 sig) 3702 * Description 3703 * Send signal *sig* to the process of the current task. 3704 * The signal may be delivered to any of this process's threads. 3705 * Return 3706 * 0 on success or successfully queued. 3707 * 3708 * **-EBUSY** if work queue under nmi is full. 3709 * 3710 * **-EINVAL** if *sig* is invalid. 3711 * 3712 * **-EPERM** if no permission to send the *sig*. 3713 * 3714 * **-EAGAIN** if bpf program can try again. 3715 * 3716 * s64 bpf_tcp_gen_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len) 3717 * Description 3718 * Try to issue a SYN cookie for the packet with corresponding 3719 * IP/TCP headers, *iph* and *th*, on the listening socket in *sk*. 3720 * 3721 * *iph* points to the start of the IPv4 or IPv6 header, while 3722 * *iph_len* contains **sizeof**\ (**struct iphdr**) or 3723 * **sizeof**\ (**struct ip6hdr**). 3724 * 3725 * *th* points to the start of the TCP header, while *th_len* 3726 * contains the length of the TCP header. 3727 * Return 3728 * On success, lower 32 bits hold the generated SYN cookie in 3729 * followed by 16 bits which hold the MSS value for that cookie, 3730 * and the top 16 bits are unused. 3731 * 3732 * On failure, the returned value is one of the following: 3733 * 3734 * **-EINVAL** SYN cookie cannot be issued due to error 3735 * 3736 * **-ENOENT** SYN cookie should not be issued (no SYN flood) 3737 * 3738 * **-EOPNOTSUPP** kernel configuration does not enable SYN cookies 3739 * 3740 * **-EPROTONOSUPPORT** IP packet version is not 4 or 6 3741 * 3742 * long bpf_skb_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 3743 * Description 3744 * Write raw *data* blob into a special BPF perf event held by 3745 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 3746 * event must have the following attributes: **PERF_SAMPLE_RAW** 3747 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 3748 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 3749 * 3750 * The *flags* are used to indicate the index in *map* for which 3751 * the value must be put, masked with **BPF_F_INDEX_MASK**. 3752 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 3753 * to indicate that the index of the current CPU core should be 3754 * used. 3755 * 3756 * The value to write, of *size*, is passed through eBPF stack and 3757 * pointed by *data*. 3758 * 3759 * *ctx* is a pointer to in-kernel struct sk_buff. 3760 * 3761 * This helper is similar to **bpf_perf_event_output**\ () but 3762 * restricted to raw_tracepoint bpf programs. 3763 * Return 3764 * 0 on success, or a negative error in case of failure. 3765 * 3766 * long bpf_probe_read_user(void *dst, u32 size, const void *unsafe_ptr) 3767 * Description 3768 * Safely attempt to read *size* bytes from user space address 3769 * *unsafe_ptr* and store the data in *dst*. 3770 * Return 3771 * 0 on success, or a negative error in case of failure. 3772 * 3773 * long bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr) 3774 * Description 3775 * Safely attempt to read *size* bytes from kernel space address 3776 * *unsafe_ptr* and store the data in *dst*. 3777 * Return 3778 * 0 on success, or a negative error in case of failure. 3779 * 3780 * long bpf_probe_read_user_str(void *dst, u32 size, const void *unsafe_ptr) 3781 * Description 3782 * Copy a NUL terminated string from an unsafe user address 3783 * *unsafe_ptr* to *dst*. The *size* should include the 3784 * terminating NUL byte. In case the string length is smaller than 3785 * *size*, the target is not padded with further NUL bytes. If the 3786 * string length is larger than *size*, just *size*-1 bytes are 3787 * copied and the last byte is set to NUL. 3788 * 3789 * On success, returns the number of bytes that were written, 3790 * including the terminal NUL. This makes this helper useful in 3791 * tracing programs for reading strings, and more importantly to 3792 * get its length at runtime. See the following snippet: 3793 * 3794 * :: 3795 * 3796 * SEC("kprobe/sys_open") 3797 * void bpf_sys_open(struct pt_regs *ctx) 3798 * { 3799 * char buf[PATHLEN]; // PATHLEN is defined to 256 3800 * int res = bpf_probe_read_user_str(buf, sizeof(buf), 3801 * ctx->di); 3802 * 3803 * // Consume buf, for example push it to 3804 * // userspace via bpf_perf_event_output(); we 3805 * // can use res (the string length) as event 3806 * // size, after checking its boundaries. 3807 * } 3808 * 3809 * In comparison, using **bpf_probe_read_user**\ () helper here 3810 * instead to read the string would require to estimate the length 3811 * at compile time, and would often result in copying more memory 3812 * than necessary. 3813 * 3814 * Another useful use case is when parsing individual process 3815 * arguments or individual environment variables navigating 3816 * *current*\ **->mm->arg_start** and *current*\ 3817 * **->mm->env_start**: using this helper and the return value, 3818 * one can quickly iterate at the right offset of the memory area. 3819 * Return 3820 * On success, the strictly positive length of the output string, 3821 * including the trailing NUL character. On error, a negative 3822 * value. 3823 * 3824 * long bpf_probe_read_kernel_str(void *dst, u32 size, const void *unsafe_ptr) 3825 * Description 3826 * Copy a NUL terminated string from an unsafe kernel address *unsafe_ptr* 3827 * to *dst*. Same semantics as with **bpf_probe_read_user_str**\ () apply. 3828 * Return 3829 * On success, the strictly positive length of the string, including 3830 * the trailing NUL character. On error, a negative value. 3831 * 3832 * long bpf_tcp_send_ack(void *tp, u32 rcv_nxt) 3833 * Description 3834 * Send out a tcp-ack. *tp* is the in-kernel struct **tcp_sock**. 3835 * *rcv_nxt* is the ack_seq to be sent out. 3836 * Return 3837 * 0 on success, or a negative error in case of failure. 3838 * 3839 * long bpf_send_signal_thread(u32 sig) 3840 * Description 3841 * Send signal *sig* to the thread corresponding to the current task. 3842 * Return 3843 * 0 on success or successfully queued. 3844 * 3845 * **-EBUSY** if work queue under nmi is full. 3846 * 3847 * **-EINVAL** if *sig* is invalid. 3848 * 3849 * **-EPERM** if no permission to send the *sig*. 3850 * 3851 * **-EAGAIN** if bpf program can try again. 3852 * 3853 * u64 bpf_jiffies64(void) 3854 * Description 3855 * Obtain the 64bit jiffies 3856 * Return 3857 * The 64 bit jiffies 3858 * 3859 * long bpf_read_branch_records(struct bpf_perf_event_data *ctx, void *buf, u32 size, u64 flags) 3860 * Description 3861 * For an eBPF program attached to a perf event, retrieve the 3862 * branch records (**struct perf_branch_entry**) associated to *ctx* 3863 * and store it in the buffer pointed by *buf* up to size 3864 * *size* bytes. 3865 * Return 3866 * On success, number of bytes written to *buf*. On error, a 3867 * negative value. 3868 * 3869 * The *flags* can be set to **BPF_F_GET_BRANCH_RECORDS_SIZE** to 3870 * instead return the number of bytes required to store all the 3871 * branch entries. If this flag is set, *buf* may be NULL. 3872 * 3873 * **-EINVAL** if arguments invalid or **size** not a multiple 3874 * of **sizeof**\ (**struct perf_branch_entry**\ ). 3875 * 3876 * **-ENOENT** if architecture does not support branch records. 3877 * 3878 * long bpf_get_ns_current_pid_tgid(u64 dev, u64 ino, struct bpf_pidns_info *nsdata, u32 size) 3879 * Description 3880 * Returns 0 on success, values for *pid* and *tgid* as seen from the current 3881 * *namespace* will be returned in *nsdata*. 3882 * Return 3883 * 0 on success, or one of the following in case of failure: 3884 * 3885 * **-EINVAL** if dev and inum supplied don't match dev_t and inode number 3886 * with nsfs of current task, or if dev conversion to dev_t lost high bits. 3887 * 3888 * **-ENOENT** if pidns does not exists for the current task. 3889 * 3890 * long bpf_xdp_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 3891 * Description 3892 * Write raw *data* blob into a special BPF perf event held by 3893 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 3894 * event must have the following attributes: **PERF_SAMPLE_RAW** 3895 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 3896 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 3897 * 3898 * The *flags* are used to indicate the index in *map* for which 3899 * the value must be put, masked with **BPF_F_INDEX_MASK**. 3900 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 3901 * to indicate that the index of the current CPU core should be 3902 * used. 3903 * 3904 * The value to write, of *size*, is passed through eBPF stack and 3905 * pointed by *data*. 3906 * 3907 * *ctx* is a pointer to in-kernel struct xdp_buff. 3908 * 3909 * This helper is similar to **bpf_perf_eventoutput**\ () but 3910 * restricted to raw_tracepoint bpf programs. 3911 * Return 3912 * 0 on success, or a negative error in case of failure. 3913 * 3914 * u64 bpf_get_netns_cookie(void *ctx) 3915 * Description 3916 * Retrieve the cookie (generated by the kernel) of the network 3917 * namespace the input *ctx* is associated with. The network 3918 * namespace cookie remains stable for its lifetime and provides 3919 * a global identifier that can be assumed unique. If *ctx* is 3920 * NULL, then the helper returns the cookie for the initial 3921 * network namespace. The cookie itself is very similar to that 3922 * of **bpf_get_socket_cookie**\ () helper, but for network 3923 * namespaces instead of sockets. 3924 * Return 3925 * A 8-byte long opaque number. 3926 * 3927 * u64 bpf_get_current_ancestor_cgroup_id(int ancestor_level) 3928 * Description 3929 * Return id of cgroup v2 that is ancestor of the cgroup associated 3930 * with the current task at the *ancestor_level*. The root cgroup 3931 * is at *ancestor_level* zero and each step down the hierarchy 3932 * increments the level. If *ancestor_level* == level of cgroup 3933 * associated with the current task, then return value will be the 3934 * same as that of **bpf_get_current_cgroup_id**\ (). 3935 * 3936 * The helper is useful to implement policies based on cgroups 3937 * that are upper in hierarchy than immediate cgroup associated 3938 * with the current task. 3939 * 3940 * The format of returned id and helper limitations are same as in 3941 * **bpf_get_current_cgroup_id**\ (). 3942 * Return 3943 * The id is returned or 0 in case the id could not be retrieved. 3944 * 3945 * long bpf_sk_assign(struct sk_buff *skb, void *sk, u64 flags) 3946 * Description 3947 * Helper is overloaded depending on BPF program type. This 3948 * description applies to **BPF_PROG_TYPE_SCHED_CLS** and 3949 * **BPF_PROG_TYPE_SCHED_ACT** programs. 3950 * 3951 * Assign the *sk* to the *skb*. When combined with appropriate 3952 * routing configuration to receive the packet towards the socket, 3953 * will cause *skb* to be delivered to the specified socket. 3954 * Subsequent redirection of *skb* via **bpf_redirect**\ (), 3955 * **bpf_clone_redirect**\ () or other methods outside of BPF may 3956 * interfere with successful delivery to the socket. 3957 * 3958 * This operation is only valid from TC ingress path. 3959 * 3960 * The *flags* argument must be zero. 3961 * Return 3962 * 0 on success, or a negative error in case of failure: 3963 * 3964 * **-EINVAL** if specified *flags* are not supported. 3965 * 3966 * **-ENOENT** if the socket is unavailable for assignment. 3967 * 3968 * **-ENETUNREACH** if the socket is unreachable (wrong netns). 3969 * 3970 * **-EOPNOTSUPP** if the operation is not supported, for example 3971 * a call from outside of TC ingress. 3972 * 3973 * **-ESOCKTNOSUPPORT** if the socket type is not supported 3974 * (reuseport). 3975 * 3976 * long bpf_sk_assign(struct bpf_sk_lookup *ctx, struct bpf_sock *sk, u64 flags) 3977 * Description 3978 * Helper is overloaded depending on BPF program type. This 3979 * description applies to **BPF_PROG_TYPE_SK_LOOKUP** programs. 3980 * 3981 * Select the *sk* as a result of a socket lookup. 3982 * 3983 * For the operation to succeed passed socket must be compatible 3984 * with the packet description provided by the *ctx* object. 3985 * 3986 * L4 protocol (**IPPROTO_TCP** or **IPPROTO_UDP**) must 3987 * be an exact match. While IP family (**AF_INET** or 3988 * **AF_INET6**) must be compatible, that is IPv6 sockets 3989 * that are not v6-only can be selected for IPv4 packets. 3990 * 3991 * Only TCP listeners and UDP unconnected sockets can be 3992 * selected. *sk* can also be NULL to reset any previous 3993 * selection. 3994 * 3995 * *flags* argument can combination of following values: 3996 * 3997 * * **BPF_SK_LOOKUP_F_REPLACE** to override the previous 3998 * socket selection, potentially done by a BPF program 3999 * that ran before us. 4000 * 4001 * * **BPF_SK_LOOKUP_F_NO_REUSEPORT** to skip 4002 * load-balancing within reuseport group for the socket 4003 * being selected. 4004 * 4005 * On success *ctx->sk* will point to the selected socket. 4006 * 4007 * Return 4008 * 0 on success, or a negative errno in case of failure. 4009 * 4010 * * **-EAFNOSUPPORT** if socket family (*sk->family*) is 4011 * not compatible with packet family (*ctx->family*). 4012 * 4013 * * **-EEXIST** if socket has been already selected, 4014 * potentially by another program, and 4015 * **BPF_SK_LOOKUP_F_REPLACE** flag was not specified. 4016 * 4017 * * **-EINVAL** if unsupported flags were specified. 4018 * 4019 * * **-EPROTOTYPE** if socket L4 protocol 4020 * (*sk->protocol*) doesn't match packet protocol 4021 * (*ctx->protocol*). 4022 * 4023 * * **-ESOCKTNOSUPPORT** if socket is not in allowed 4024 * state (TCP listening or UDP unconnected). 4025 * 4026 * u64 bpf_ktime_get_boot_ns(void) 4027 * Description 4028 * Return the time elapsed since system boot, in nanoseconds. 4029 * Does include the time the system was suspended. 4030 * See: **clock_gettime**\ (**CLOCK_BOOTTIME**) 4031 * Return 4032 * Current *ktime*. 4033 * 4034 * long bpf_seq_printf(struct seq_file *m, const char *fmt, u32 fmt_size, const void *data, u32 data_len) 4035 * Description 4036 * **bpf_seq_printf**\ () uses seq_file **seq_printf**\ () to print 4037 * out the format string. 4038 * The *m* represents the seq_file. The *fmt* and *fmt_size* are for 4039 * the format string itself. The *data* and *data_len* are format string 4040 * arguments. The *data* are a **u64** array and corresponding format string 4041 * values are stored in the array. For strings and pointers where pointees 4042 * are accessed, only the pointer values are stored in the *data* array. 4043 * The *data_len* is the size of *data* in bytes. 4044 * 4045 * Formats **%s**, **%p{i,I}{4,6}** requires to read kernel memory. 4046 * Reading kernel memory may fail due to either invalid address or 4047 * valid address but requiring a major memory fault. If reading kernel memory 4048 * fails, the string for **%s** will be an empty string, and the ip 4049 * address for **%p{i,I}{4,6}** will be 0. Not returning error to 4050 * bpf program is consistent with what **bpf_trace_printk**\ () does for now. 4051 * Return 4052 * 0 on success, or a negative error in case of failure: 4053 * 4054 * **-EBUSY** if per-CPU memory copy buffer is busy, can try again 4055 * by returning 1 from bpf program. 4056 * 4057 * **-EINVAL** if arguments are invalid, or if *fmt* is invalid/unsupported. 4058 * 4059 * **-E2BIG** if *fmt* contains too many format specifiers. 4060 * 4061 * **-EOVERFLOW** if an overflow happened: The same object will be tried again. 4062 * 4063 * long bpf_seq_write(struct seq_file *m, const void *data, u32 len) 4064 * Description 4065 * **bpf_seq_write**\ () uses seq_file **seq_write**\ () to write the data. 4066 * The *m* represents the seq_file. The *data* and *len* represent the 4067 * data to write in bytes. 4068 * Return 4069 * 0 on success, or a negative error in case of failure: 4070 * 4071 * **-EOVERFLOW** if an overflow happened: The same object will be tried again. 4072 * 4073 * u64 bpf_sk_cgroup_id(void *sk) 4074 * Description 4075 * Return the cgroup v2 id of the socket *sk*. 4076 * 4077 * *sk* must be a non-**NULL** pointer to a socket, e.g. one 4078 * returned from **bpf_sk_lookup_xxx**\ (), 4079 * **bpf_sk_fullsock**\ (), etc. The format of returned id is 4080 * same as in **bpf_skb_cgroup_id**\ (). 4081 * 4082 * This helper is available only if the kernel was compiled with 4083 * the **CONFIG_SOCK_CGROUP_DATA** configuration option. 4084 * Return 4085 * The id is returned or 0 in case the id could not be retrieved. 4086 * 4087 * u64 bpf_sk_ancestor_cgroup_id(void *sk, int ancestor_level) 4088 * Description 4089 * Return id of cgroup v2 that is ancestor of cgroup associated 4090 * with the *sk* at the *ancestor_level*. The root cgroup is at 4091 * *ancestor_level* zero and each step down the hierarchy 4092 * increments the level. If *ancestor_level* == level of cgroup 4093 * associated with *sk*, then return value will be same as that 4094 * of **bpf_sk_cgroup_id**\ (). 4095 * 4096 * The helper is useful to implement policies based on cgroups 4097 * that are upper in hierarchy than immediate cgroup associated 4098 * with *sk*. 4099 * 4100 * The format of returned id and helper limitations are same as in 4101 * **bpf_sk_cgroup_id**\ (). 4102 * Return 4103 * The id is returned or 0 in case the id could not be retrieved. 4104 * 4105 * long bpf_ringbuf_output(void *ringbuf, void *data, u64 size, u64 flags) 4106 * Description 4107 * Copy *size* bytes from *data* into a ring buffer *ringbuf*. 4108 * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification 4109 * of new data availability is sent. 4110 * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification 4111 * of new data availability is sent unconditionally. 4112 * If **0** is specified in *flags*, an adaptive notification 4113 * of new data availability is sent. 4114 * 4115 * An adaptive notification is a notification sent whenever the user-space 4116 * process has caught up and consumed all available payloads. In case the user-space 4117 * process is still processing a previous payload, then no notification is needed 4118 * as it will process the newly added payload automatically. 4119 * Return 4120 * 0 on success, or a negative error in case of failure. 4121 * 4122 * void *bpf_ringbuf_reserve(void *ringbuf, u64 size, u64 flags) 4123 * Description 4124 * Reserve *size* bytes of payload in a ring buffer *ringbuf*. 4125 * *flags* must be 0. 4126 * Return 4127 * Valid pointer with *size* bytes of memory available; NULL, 4128 * otherwise. 4129 * 4130 * void bpf_ringbuf_submit(void *data, u64 flags) 4131 * Description 4132 * Submit reserved ring buffer sample, pointed to by *data*. 4133 * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification 4134 * of new data availability is sent. 4135 * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification 4136 * of new data availability is sent unconditionally. 4137 * If **0** is specified in *flags*, an adaptive notification 4138 * of new data availability is sent. 4139 * 4140 * See 'bpf_ringbuf_output()' for the definition of adaptive notification. 4141 * Return 4142 * Nothing. Always succeeds. 4143 * 4144 * void bpf_ringbuf_discard(void *data, u64 flags) 4145 * Description 4146 * Discard reserved ring buffer sample, pointed to by *data*. 4147 * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification 4148 * of new data availability is sent. 4149 * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification 4150 * of new data availability is sent unconditionally. 4151 * If **0** is specified in *flags*, an adaptive notification 4152 * of new data availability is sent. 4153 * 4154 * See 'bpf_ringbuf_output()' for the definition of adaptive notification. 4155 * Return 4156 * Nothing. Always succeeds. 4157 * 4158 * u64 bpf_ringbuf_query(void *ringbuf, u64 flags) 4159 * Description 4160 * Query various characteristics of provided ring buffer. What 4161 * exactly is queries is determined by *flags*: 4162 * 4163 * * **BPF_RB_AVAIL_DATA**: Amount of data not yet consumed. 4164 * * **BPF_RB_RING_SIZE**: The size of ring buffer. 4165 * * **BPF_RB_CONS_POS**: Consumer position (can wrap around). 4166 * * **BPF_RB_PROD_POS**: Producer(s) position (can wrap around). 4167 * 4168 * Data returned is just a momentary snapshot of actual values 4169 * and could be inaccurate, so this facility should be used to 4170 * power heuristics and for reporting, not to make 100% correct 4171 * calculation. 4172 * Return 4173 * Requested value, or 0, if *flags* are not recognized. 4174 * 4175 * long bpf_csum_level(struct sk_buff *skb, u64 level) 4176 * Description 4177 * Change the skbs checksum level by one layer up or down, or 4178 * reset it entirely to none in order to have the stack perform 4179 * checksum validation. The level is applicable to the following 4180 * protocols: TCP, UDP, GRE, SCTP, FCOE. For example, a decap of 4181 * | ETH | IP | UDP | GUE | IP | TCP | into | ETH | IP | TCP | 4182 * through **bpf_skb_adjust_room**\ () helper with passing in 4183 * **BPF_F_ADJ_ROOM_NO_CSUM_RESET** flag would require one call 4184 * to **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_DEC** since 4185 * the UDP header is removed. Similarly, an encap of the latter 4186 * into the former could be accompanied by a helper call to 4187 * **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_INC** if the 4188 * skb is still intended to be processed in higher layers of the 4189 * stack instead of just egressing at tc. 4190 * 4191 * There are three supported level settings at this time: 4192 * 4193 * * **BPF_CSUM_LEVEL_INC**: Increases skb->csum_level for skbs 4194 * with CHECKSUM_UNNECESSARY. 4195 * * **BPF_CSUM_LEVEL_DEC**: Decreases skb->csum_level for skbs 4196 * with CHECKSUM_UNNECESSARY. 4197 * * **BPF_CSUM_LEVEL_RESET**: Resets skb->csum_level to 0 and 4198 * sets CHECKSUM_NONE to force checksum validation by the stack. 4199 * * **BPF_CSUM_LEVEL_QUERY**: No-op, returns the current 4200 * skb->csum_level. 4201 * Return 4202 * 0 on success, or a negative error in case of failure. In the 4203 * case of **BPF_CSUM_LEVEL_QUERY**, the current skb->csum_level 4204 * is returned or the error code -EACCES in case the skb is not 4205 * subject to CHECKSUM_UNNECESSARY. 4206 * 4207 * struct tcp6_sock *bpf_skc_to_tcp6_sock(void *sk) 4208 * Description 4209 * Dynamically cast a *sk* pointer to a *tcp6_sock* pointer. 4210 * Return 4211 * *sk* if casting is valid, or **NULL** otherwise. 4212 * 4213 * struct tcp_sock *bpf_skc_to_tcp_sock(void *sk) 4214 * Description 4215 * Dynamically cast a *sk* pointer to a *tcp_sock* pointer. 4216 * Return 4217 * *sk* if casting is valid, or **NULL** otherwise. 4218 * 4219 * struct tcp_timewait_sock *bpf_skc_to_tcp_timewait_sock(void *sk) 4220 * Description 4221 * Dynamically cast a *sk* pointer to a *tcp_timewait_sock* pointer. 4222 * Return 4223 * *sk* if casting is valid, or **NULL** otherwise. 4224 * 4225 * struct tcp_request_sock *bpf_skc_to_tcp_request_sock(void *sk) 4226 * Description 4227 * Dynamically cast a *sk* pointer to a *tcp_request_sock* pointer. 4228 * Return 4229 * *sk* if casting is valid, or **NULL** otherwise. 4230 * 4231 * struct udp6_sock *bpf_skc_to_udp6_sock(void *sk) 4232 * Description 4233 * Dynamically cast a *sk* pointer to a *udp6_sock* pointer. 4234 * Return 4235 * *sk* if casting is valid, or **NULL** otherwise. 4236 * 4237 * long bpf_get_task_stack(struct task_struct *task, void *buf, u32 size, u64 flags) 4238 * Description 4239 * Return a user or a kernel stack in bpf program provided buffer. 4240 * To achieve this, the helper needs *task*, which is a valid 4241 * pointer to **struct task_struct**. To store the stacktrace, the 4242 * bpf program provides *buf* with a nonnegative *size*. 4243 * 4244 * The last argument, *flags*, holds the number of stack frames to 4245 * skip (from 0 to 255), masked with 4246 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 4247 * the following flags: 4248 * 4249 * **BPF_F_USER_STACK** 4250 * Collect a user space stack instead of a kernel stack. 4251 * **BPF_F_USER_BUILD_ID** 4252 * Collect buildid+offset instead of ips for user stack, 4253 * only valid if **BPF_F_USER_STACK** is also specified. 4254 * 4255 * **bpf_get_task_stack**\ () can collect up to 4256 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject 4257 * to sufficient large buffer size. Note that 4258 * this limit can be controlled with the **sysctl** program, and 4259 * that it should be manually increased in order to profile long 4260 * user stacks (such as stacks for Java programs). To do so, use: 4261 * 4262 * :: 4263 * 4264 * # sysctl kernel.perf_event_max_stack=<new value> 4265 * Return 4266 * A non-negative value equal to or less than *size* on success, 4267 * or a negative error in case of failure. 4268 * 4269 * long bpf_load_hdr_opt(struct bpf_sock_ops *skops, void *searchby_res, u32 len, u64 flags) 4270 * Description 4271 * Load header option. Support reading a particular TCP header 4272 * option for bpf program (**BPF_PROG_TYPE_SOCK_OPS**). 4273 * 4274 * If *flags* is 0, it will search the option from the 4275 * *skops*\ **->skb_data**. The comment in **struct bpf_sock_ops** 4276 * has details on what skb_data contains under different 4277 * *skops*\ **->op**. 4278 * 4279 * The first byte of the *searchby_res* specifies the 4280 * kind that it wants to search. 4281 * 4282 * If the searching kind is an experimental kind 4283 * (i.e. 253 or 254 according to RFC6994). It also 4284 * needs to specify the "magic" which is either 4285 * 2 bytes or 4 bytes. It then also needs to 4286 * specify the size of the magic by using 4287 * the 2nd byte which is "kind-length" of a TCP 4288 * header option and the "kind-length" also 4289 * includes the first 2 bytes "kind" and "kind-length" 4290 * itself as a normal TCP header option also does. 4291 * 4292 * For example, to search experimental kind 254 with 4293 * 2 byte magic 0xeB9F, the searchby_res should be 4294 * [ 254, 4, 0xeB, 0x9F, 0, 0, .... 0 ]. 4295 * 4296 * To search for the standard window scale option (3), 4297 * the *searchby_res* should be [ 3, 0, 0, .... 0 ]. 4298 * Note, kind-length must be 0 for regular option. 4299 * 4300 * Searching for No-Op (0) and End-of-Option-List (1) are 4301 * not supported. 4302 * 4303 * *len* must be at least 2 bytes which is the minimal size 4304 * of a header option. 4305 * 4306 * Supported flags: 4307 * 4308 * * **BPF_LOAD_HDR_OPT_TCP_SYN** to search from the 4309 * saved_syn packet or the just-received syn packet. 4310 * 4311 * Return 4312 * > 0 when found, the header option is copied to *searchby_res*. 4313 * The return value is the total length copied. On failure, a 4314 * negative error code is returned: 4315 * 4316 * **-EINVAL** if a parameter is invalid. 4317 * 4318 * **-ENOMSG** if the option is not found. 4319 * 4320 * **-ENOENT** if no syn packet is available when 4321 * **BPF_LOAD_HDR_OPT_TCP_SYN** is used. 4322 * 4323 * **-ENOSPC** if there is not enough space. Only *len* number of 4324 * bytes are copied. 4325 * 4326 * **-EFAULT** on failure to parse the header options in the 4327 * packet. 4328 * 4329 * **-EPERM** if the helper cannot be used under the current 4330 * *skops*\ **->op**. 4331 * 4332 * long bpf_store_hdr_opt(struct bpf_sock_ops *skops, const void *from, u32 len, u64 flags) 4333 * Description 4334 * Store header option. The data will be copied 4335 * from buffer *from* with length *len* to the TCP header. 4336 * 4337 * The buffer *from* should have the whole option that 4338 * includes the kind, kind-length, and the actual 4339 * option data. The *len* must be at least kind-length 4340 * long. The kind-length does not have to be 4 byte 4341 * aligned. The kernel will take care of the padding 4342 * and setting the 4 bytes aligned value to th->doff. 4343 * 4344 * This helper will check for duplicated option 4345 * by searching the same option in the outgoing skb. 4346 * 4347 * This helper can only be called during 4348 * **BPF_SOCK_OPS_WRITE_HDR_OPT_CB**. 4349 * 4350 * Return 4351 * 0 on success, or negative error in case of failure: 4352 * 4353 * **-EINVAL** If param is invalid. 4354 * 4355 * **-ENOSPC** if there is not enough space in the header. 4356 * Nothing has been written 4357 * 4358 * **-EEXIST** if the option already exists. 4359 * 4360 * **-EFAULT** on failrue to parse the existing header options. 4361 * 4362 * **-EPERM** if the helper cannot be used under the current 4363 * *skops*\ **->op**. 4364 * 4365 * long bpf_reserve_hdr_opt(struct bpf_sock_ops *skops, u32 len, u64 flags) 4366 * Description 4367 * Reserve *len* bytes for the bpf header option. The 4368 * space will be used by **bpf_store_hdr_opt**\ () later in 4369 * **BPF_SOCK_OPS_WRITE_HDR_OPT_CB**. 4370 * 4371 * If **bpf_reserve_hdr_opt**\ () is called multiple times, 4372 * the total number of bytes will be reserved. 4373 * 4374 * This helper can only be called during 4375 * **BPF_SOCK_OPS_HDR_OPT_LEN_CB**. 4376 * 4377 * Return 4378 * 0 on success, or negative error in case of failure: 4379 * 4380 * **-EINVAL** if a parameter is invalid. 4381 * 4382 * **-ENOSPC** if there is not enough space in the header. 4383 * 4384 * **-EPERM** if the helper cannot be used under the current 4385 * *skops*\ **->op**. 4386 * 4387 * void *bpf_inode_storage_get(struct bpf_map *map, void *inode, void *value, u64 flags) 4388 * Description 4389 * Get a bpf_local_storage from an *inode*. 4390 * 4391 * Logically, it could be thought of as getting the value from 4392 * a *map* with *inode* as the **key**. From this 4393 * perspective, the usage is not much different from 4394 * **bpf_map_lookup_elem**\ (*map*, **&**\ *inode*) except this 4395 * helper enforces the key must be an inode and the map must also 4396 * be a **BPF_MAP_TYPE_INODE_STORAGE**. 4397 * 4398 * Underneath, the value is stored locally at *inode* instead of 4399 * the *map*. The *map* is used as the bpf-local-storage 4400 * "type". The bpf-local-storage "type" (i.e. the *map*) is 4401 * searched against all bpf_local_storage residing at *inode*. 4402 * 4403 * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be 4404 * used such that a new bpf_local_storage will be 4405 * created if one does not exist. *value* can be used 4406 * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify 4407 * the initial value of a bpf_local_storage. If *value* is 4408 * **NULL**, the new bpf_local_storage will be zero initialized. 4409 * Return 4410 * A bpf_local_storage pointer is returned on success. 4411 * 4412 * **NULL** if not found or there was an error in adding 4413 * a new bpf_local_storage. 4414 * 4415 * int bpf_inode_storage_delete(struct bpf_map *map, void *inode) 4416 * Description 4417 * Delete a bpf_local_storage from an *inode*. 4418 * Return 4419 * 0 on success. 4420 * 4421 * **-ENOENT** if the bpf_local_storage cannot be found. 4422 * 4423 * long bpf_d_path(struct path *path, char *buf, u32 sz) 4424 * Description 4425 * Return full path for given **struct path** object, which 4426 * needs to be the kernel BTF *path* object. The path is 4427 * returned in the provided buffer *buf* of size *sz* and 4428 * is zero terminated. 4429 * 4430 * Return 4431 * On success, the strictly positive length of the string, 4432 * including the trailing NUL character. On error, a negative 4433 * value. 4434 * 4435 * long bpf_copy_from_user(void *dst, u32 size, const void *user_ptr) 4436 * Description 4437 * Read *size* bytes from user space address *user_ptr* and store 4438 * the data in *dst*. This is a wrapper of **copy_from_user**\ (). 4439 * Return 4440 * 0 on success, or a negative error in case of failure. 4441 * 4442 * long bpf_snprintf_btf(char *str, u32 str_size, struct btf_ptr *ptr, u32 btf_ptr_size, u64 flags) 4443 * Description 4444 * Use BTF to store a string representation of *ptr*->ptr in *str*, 4445 * using *ptr*->type_id. This value should specify the type 4446 * that *ptr*->ptr points to. LLVM __builtin_btf_type_id(type, 1) 4447 * can be used to look up vmlinux BTF type ids. Traversing the 4448 * data structure using BTF, the type information and values are 4449 * stored in the first *str_size* - 1 bytes of *str*. Safe copy of 4450 * the pointer data is carried out to avoid kernel crashes during 4451 * operation. Smaller types can use string space on the stack; 4452 * larger programs can use map data to store the string 4453 * representation. 4454 * 4455 * The string can be subsequently shared with userspace via 4456 * bpf_perf_event_output() or ring buffer interfaces. 4457 * bpf_trace_printk() is to be avoided as it places too small 4458 * a limit on string size to be useful. 4459 * 4460 * *flags* is a combination of 4461 * 4462 * **BTF_F_COMPACT** 4463 * no formatting around type information 4464 * **BTF_F_NONAME** 4465 * no struct/union member names/types 4466 * **BTF_F_PTR_RAW** 4467 * show raw (unobfuscated) pointer values; 4468 * equivalent to printk specifier %px. 4469 * **BTF_F_ZERO** 4470 * show zero-valued struct/union members; they 4471 * are not displayed by default 4472 * 4473 * Return 4474 * The number of bytes that were written (or would have been 4475 * written if output had to be truncated due to string size), 4476 * or a negative error in cases of failure. 4477 * 4478 * long bpf_seq_printf_btf(struct seq_file *m, struct btf_ptr *ptr, u32 ptr_size, u64 flags) 4479 * Description 4480 * Use BTF to write to seq_write a string representation of 4481 * *ptr*->ptr, using *ptr*->type_id as per bpf_snprintf_btf(). 4482 * *flags* are identical to those used for bpf_snprintf_btf. 4483 * Return 4484 * 0 on success or a negative error in case of failure. 4485 * 4486 * u64 bpf_skb_cgroup_classid(struct sk_buff *skb) 4487 * Description 4488 * See **bpf_get_cgroup_classid**\ () for the main description. 4489 * This helper differs from **bpf_get_cgroup_classid**\ () in that 4490 * the cgroup v1 net_cls class is retrieved only from the *skb*'s 4491 * associated socket instead of the current process. 4492 * Return 4493 * The id is returned or 0 in case the id could not be retrieved. 4494 * 4495 * long bpf_redirect_neigh(u32 ifindex, struct bpf_redir_neigh *params, int plen, u64 flags) 4496 * Description 4497 * Redirect the packet to another net device of index *ifindex* 4498 * and fill in L2 addresses from neighboring subsystem. This helper 4499 * is somewhat similar to **bpf_redirect**\ (), except that it 4500 * populates L2 addresses as well, meaning, internally, the helper 4501 * relies on the neighbor lookup for the L2 address of the nexthop. 4502 * 4503 * The helper will perform a FIB lookup based on the skb's 4504 * networking header to get the address of the next hop, unless 4505 * this is supplied by the caller in the *params* argument. The 4506 * *plen* argument indicates the len of *params* and should be set 4507 * to 0 if *params* is NULL. 4508 * 4509 * The *flags* argument is reserved and must be 0. The helper is 4510 * currently only supported for tc BPF program types, and enabled 4511 * for IPv4 and IPv6 protocols. 4512 * Return 4513 * The helper returns **TC_ACT_REDIRECT** on success or 4514 * **TC_ACT_SHOT** on error. 4515 * 4516 * void *bpf_per_cpu_ptr(const void *percpu_ptr, u32 cpu) 4517 * Description 4518 * Take a pointer to a percpu ksym, *percpu_ptr*, and return a 4519 * pointer to the percpu kernel variable on *cpu*. A ksym is an 4520 * extern variable decorated with '__ksym'. For ksym, there is a 4521 * global var (either static or global) defined of the same name 4522 * in the kernel. The ksym is percpu if the global var is percpu. 4523 * The returned pointer points to the global percpu var on *cpu*. 4524 * 4525 * bpf_per_cpu_ptr() has the same semantic as per_cpu_ptr() in the 4526 * kernel, except that bpf_per_cpu_ptr() may return NULL. This 4527 * happens if *cpu* is larger than nr_cpu_ids. The caller of 4528 * bpf_per_cpu_ptr() must check the returned value. 4529 * Return 4530 * A pointer pointing to the kernel percpu variable on *cpu*, or 4531 * NULL, if *cpu* is invalid. 4532 * 4533 * void *bpf_this_cpu_ptr(const void *percpu_ptr) 4534 * Description 4535 * Take a pointer to a percpu ksym, *percpu_ptr*, and return a 4536 * pointer to the percpu kernel variable on this cpu. See the 4537 * description of 'ksym' in **bpf_per_cpu_ptr**\ (). 4538 * 4539 * bpf_this_cpu_ptr() has the same semantic as this_cpu_ptr() in 4540 * the kernel. Different from **bpf_per_cpu_ptr**\ (), it would 4541 * never return NULL. 4542 * Return 4543 * A pointer pointing to the kernel percpu variable on this cpu. 4544 * 4545 * long bpf_redirect_peer(u32 ifindex, u64 flags) 4546 * Description 4547 * Redirect the packet to another net device of index *ifindex*. 4548 * This helper is somewhat similar to **bpf_redirect**\ (), except 4549 * that the redirection happens to the *ifindex*' peer device and 4550 * the netns switch takes place from ingress to ingress without 4551 * going through the CPU's backlog queue. 4552 * 4553 * The *flags* argument is reserved and must be 0. The helper is 4554 * currently only supported for tc BPF program types at the ingress 4555 * hook and for veth device types. The peer device must reside in a 4556 * different network namespace. 4557 * Return 4558 * The helper returns **TC_ACT_REDIRECT** on success or 4559 * **TC_ACT_SHOT** on error. 4560 * 4561 * void *bpf_task_storage_get(struct bpf_map *map, struct task_struct *task, void *value, u64 flags) 4562 * Description 4563 * Get a bpf_local_storage from the *task*. 4564 * 4565 * Logically, it could be thought of as getting the value from 4566 * a *map* with *task* as the **key**. From this 4567 * perspective, the usage is not much different from 4568 * **bpf_map_lookup_elem**\ (*map*, **&**\ *task*) except this 4569 * helper enforces the key must be an task_struct and the map must also 4570 * be a **BPF_MAP_TYPE_TASK_STORAGE**. 4571 * 4572 * Underneath, the value is stored locally at *task* instead of 4573 * the *map*. The *map* is used as the bpf-local-storage 4574 * "type". The bpf-local-storage "type" (i.e. the *map*) is 4575 * searched against all bpf_local_storage residing at *task*. 4576 * 4577 * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be 4578 * used such that a new bpf_local_storage will be 4579 * created if one does not exist. *value* can be used 4580 * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify 4581 * the initial value of a bpf_local_storage. If *value* is 4582 * **NULL**, the new bpf_local_storage will be zero initialized. 4583 * Return 4584 * A bpf_local_storage pointer is returned on success. 4585 * 4586 * **NULL** if not found or there was an error in adding 4587 * a new bpf_local_storage. 4588 * 4589 * long bpf_task_storage_delete(struct bpf_map *map, struct task_struct *task) 4590 * Description 4591 * Delete a bpf_local_storage from a *task*. 4592 * Return 4593 * 0 on success. 4594 * 4595 * **-ENOENT** if the bpf_local_storage cannot be found. 4596 * 4597 * struct task_struct *bpf_get_current_task_btf(void) 4598 * Description 4599 * Return a BTF pointer to the "current" task. 4600 * This pointer can also be used in helpers that accept an 4601 * *ARG_PTR_TO_BTF_ID* of type *task_struct*. 4602 * Return 4603 * Pointer to the current task. 4604 * 4605 * long bpf_bprm_opts_set(struct linux_binprm *bprm, u64 flags) 4606 * Description 4607 * Set or clear certain options on *bprm*: 4608 * 4609 * **BPF_F_BPRM_SECUREEXEC** Set the secureexec bit 4610 * which sets the **AT_SECURE** auxv for glibc. The bit 4611 * is cleared if the flag is not specified. 4612 * Return 4613 * **-EINVAL** if invalid *flags* are passed, zero otherwise. 4614 * 4615 * u64 bpf_ktime_get_coarse_ns(void) 4616 * Description 4617 * Return a coarse-grained version of the time elapsed since 4618 * system boot, in nanoseconds. Does not include time the system 4619 * was suspended. 4620 * 4621 * See: **clock_gettime**\ (**CLOCK_MONOTONIC_COARSE**) 4622 * Return 4623 * Current *ktime*. 4624 * 4625 * long bpf_ima_inode_hash(struct inode *inode, void *dst, u32 size) 4626 * Description 4627 * Returns the stored IMA hash of the *inode* (if it's avaialable). 4628 * If the hash is larger than *size*, then only *size* 4629 * bytes will be copied to *dst* 4630 * Return 4631 * The **hash_algo** is returned on success, 4632 * **-EOPNOTSUP** if IMA is disabled or **-EINVAL** if 4633 * invalid arguments are passed. 4634 * 4635 * struct socket *bpf_sock_from_file(struct file *file) 4636 * Description 4637 * If the given file represents a socket, returns the associated 4638 * socket. 4639 * Return 4640 * A pointer to a struct socket on success or NULL if the file is 4641 * not a socket. 4642 * 4643 * long bpf_check_mtu(void *ctx, u32 ifindex, u32 *mtu_len, s32 len_diff, u64 flags) 4644 * Description 4645 * Check packet size against exceeding MTU of net device (based 4646 * on *ifindex*). This helper will likely be used in combination 4647 * with helpers that adjust/change the packet size. 4648 * 4649 * The argument *len_diff* can be used for querying with a planned 4650 * size change. This allows to check MTU prior to changing packet 4651 * ctx. Providing an *len_diff* adjustment that is larger than the 4652 * actual packet size (resulting in negative packet size) will in 4653 * principle not exceed the MTU, why it is not considered a 4654 * failure. Other BPF-helpers are needed for performing the 4655 * planned size change, why the responsability for catch a negative 4656 * packet size belong in those helpers. 4657 * 4658 * Specifying *ifindex* zero means the MTU check is performed 4659 * against the current net device. This is practical if this isn't 4660 * used prior to redirect. 4661 * 4662 * On input *mtu_len* must be a valid pointer, else verifier will 4663 * reject BPF program. If the value *mtu_len* is initialized to 4664 * zero then the ctx packet size is use. When value *mtu_len* is 4665 * provided as input this specify the L3 length that the MTU check 4666 * is done against. Remember XDP and TC length operate at L2, but 4667 * this value is L3 as this correlate to MTU and IP-header tot_len 4668 * values which are L3 (similar behavior as bpf_fib_lookup). 4669 * 4670 * The Linux kernel route table can configure MTUs on a more 4671 * specific per route level, which is not provided by this helper. 4672 * For route level MTU checks use the **bpf_fib_lookup**\ () 4673 * helper. 4674 * 4675 * *ctx* is either **struct xdp_md** for XDP programs or 4676 * **struct sk_buff** for tc cls_act programs. 4677 * 4678 * The *flags* argument can be a combination of one or more of the 4679 * following values: 4680 * 4681 * **BPF_MTU_CHK_SEGS** 4682 * This flag will only works for *ctx* **struct sk_buff**. 4683 * If packet context contains extra packet segment buffers 4684 * (often knows as GSO skb), then MTU check is harder to 4685 * check at this point, because in transmit path it is 4686 * possible for the skb packet to get re-segmented 4687 * (depending on net device features). This could still be 4688 * a MTU violation, so this flag enables performing MTU 4689 * check against segments, with a different violation 4690 * return code to tell it apart. Check cannot use len_diff. 4691 * 4692 * On return *mtu_len* pointer contains the MTU value of the net 4693 * device. Remember the net device configured MTU is the L3 size, 4694 * which is returned here and XDP and TC length operate at L2. 4695 * Helper take this into account for you, but remember when using 4696 * MTU value in your BPF-code. 4697 * 4698 * Return 4699 * * 0 on success, and populate MTU value in *mtu_len* pointer. 4700 * 4701 * * < 0 if any input argument is invalid (*mtu_len* not updated) 4702 * 4703 * MTU violations return positive values, but also populate MTU 4704 * value in *mtu_len* pointer, as this can be needed for 4705 * implementing PMTU handing: 4706 * 4707 * * **BPF_MTU_CHK_RET_FRAG_NEEDED** 4708 * * **BPF_MTU_CHK_RET_SEGS_TOOBIG** 4709 * 4710 * long bpf_for_each_map_elem(struct bpf_map *map, void *callback_fn, void *callback_ctx, u64 flags) 4711 * Description 4712 * For each element in **map**, call **callback_fn** function with 4713 * **map**, **callback_ctx** and other map-specific parameters. 4714 * The **callback_fn** should be a static function and 4715 * the **callback_ctx** should be a pointer to the stack. 4716 * The **flags** is used to control certain aspects of the helper. 4717 * Currently, the **flags** must be 0. 4718 * 4719 * The following are a list of supported map types and their 4720 * respective expected callback signatures: 4721 * 4722 * BPF_MAP_TYPE_HASH, BPF_MAP_TYPE_PERCPU_HASH, 4723 * BPF_MAP_TYPE_LRU_HASH, BPF_MAP_TYPE_LRU_PERCPU_HASH, 4724 * BPF_MAP_TYPE_ARRAY, BPF_MAP_TYPE_PERCPU_ARRAY 4725 * 4726 * long (\*callback_fn)(struct bpf_map \*map, const void \*key, void \*value, void \*ctx); 4727 * 4728 * For per_cpu maps, the map_value is the value on the cpu where the 4729 * bpf_prog is running. 4730 * 4731 * If **callback_fn** return 0, the helper will continue to the next 4732 * element. If return value is 1, the helper will skip the rest of 4733 * elements and return. Other return values are not used now. 4734 * 4735 * Return 4736 * The number of traversed map elements for success, **-EINVAL** for 4737 * invalid **flags**. 4738 * 4739 * long bpf_snprintf(char *str, u32 str_size, const char *fmt, u64 *data, u32 data_len) 4740 * Description 4741 * Outputs a string into the **str** buffer of size **str_size** 4742 * based on a format string stored in a read-only map pointed by 4743 * **fmt**. 4744 * 4745 * Each format specifier in **fmt** corresponds to one u64 element 4746 * in the **data** array. For strings and pointers where pointees 4747 * are accessed, only the pointer values are stored in the *data* 4748 * array. The *data_len* is the size of *data* in bytes. 4749 * 4750 * Formats **%s** and **%p{i,I}{4,6}** require to read kernel 4751 * memory. Reading kernel memory may fail due to either invalid 4752 * address or valid address but requiring a major memory fault. If 4753 * reading kernel memory fails, the string for **%s** will be an 4754 * empty string, and the ip address for **%p{i,I}{4,6}** will be 0. 4755 * Not returning error to bpf program is consistent with what 4756 * **bpf_trace_printk**\ () does for now. 4757 * 4758 * Return 4759 * The strictly positive length of the formatted string, including 4760 * the trailing zero character. If the return value is greater than 4761 * **str_size**, **str** contains a truncated string, guaranteed to 4762 * be zero-terminated except when **str_size** is 0. 4763 * 4764 * Or **-EBUSY** if the per-CPU memory copy buffer is busy. 4765 * 4766 * long bpf_sys_bpf(u32 cmd, void *attr, u32 attr_size) 4767 * Description 4768 * Execute bpf syscall with given arguments. 4769 * Return 4770 * A syscall result. 4771 * 4772 * long bpf_btf_find_by_name_kind(char *name, int name_sz, u32 kind, int flags) 4773 * Description 4774 * Find BTF type with given name and kind in vmlinux BTF or in module's BTFs. 4775 * Return 4776 * Returns btf_id and btf_obj_fd in lower and upper 32 bits. 4777 * 4778 * long bpf_sys_close(u32 fd) 4779 * Description 4780 * Execute close syscall for given FD. 4781 * Return 4782 * A syscall result. 4783 */ 4784#define __BPF_FUNC_MAPPER(FN) \ 4785 FN(unspec), \ 4786 FN(map_lookup_elem), \ 4787 FN(map_update_elem), \ 4788 FN(map_delete_elem), \ 4789 FN(probe_read), \ 4790 FN(ktime_get_ns), \ 4791 FN(trace_printk), \ 4792 FN(get_prandom_u32), \ 4793 FN(get_smp_processor_id), \ 4794 FN(skb_store_bytes), \ 4795 FN(l3_csum_replace), \ 4796 FN(l4_csum_replace), \ 4797 FN(tail_call), \ 4798 FN(clone_redirect), \ 4799 FN(get_current_pid_tgid), \ 4800 FN(get_current_uid_gid), \ 4801 FN(get_current_comm), \ 4802 FN(get_cgroup_classid), \ 4803 FN(skb_vlan_push), \ 4804 FN(skb_vlan_pop), \ 4805 FN(skb_get_tunnel_key), \ 4806 FN(skb_set_tunnel_key), \ 4807 FN(perf_event_read), \ 4808 FN(redirect), \ 4809 FN(get_route_realm), \ 4810 FN(perf_event_output), \ 4811 FN(skb_load_bytes), \ 4812 FN(get_stackid), \ 4813 FN(csum_diff), \ 4814 FN(skb_get_tunnel_opt), \ 4815 FN(skb_set_tunnel_opt), \ 4816 FN(skb_change_proto), \ 4817 FN(skb_change_type), \ 4818 FN(skb_under_cgroup), \ 4819 FN(get_hash_recalc), \ 4820 FN(get_current_task), \ 4821 FN(probe_write_user), \ 4822 FN(current_task_under_cgroup), \ 4823 FN(skb_change_tail), \ 4824 FN(skb_pull_data), \ 4825 FN(csum_update), \ 4826 FN(set_hash_invalid), \ 4827 FN(get_numa_node_id), \ 4828 FN(skb_change_head), \ 4829 FN(xdp_adjust_head), \ 4830 FN(probe_read_str), \ 4831 FN(get_socket_cookie), \ 4832 FN(get_socket_uid), \ 4833 FN(set_hash), \ 4834 FN(setsockopt), \ 4835 FN(skb_adjust_room), \ 4836 FN(redirect_map), \ 4837 FN(sk_redirect_map), \ 4838 FN(sock_map_update), \ 4839 FN(xdp_adjust_meta), \ 4840 FN(perf_event_read_value), \ 4841 FN(perf_prog_read_value), \ 4842 FN(getsockopt), \ 4843 FN(override_return), \ 4844 FN(sock_ops_cb_flags_set), \ 4845 FN(msg_redirect_map), \ 4846 FN(msg_apply_bytes), \ 4847 FN(msg_cork_bytes), \ 4848 FN(msg_pull_data), \ 4849 FN(bind), \ 4850 FN(xdp_adjust_tail), \ 4851 FN(skb_get_xfrm_state), \ 4852 FN(get_stack), \ 4853 FN(skb_load_bytes_relative), \ 4854 FN(fib_lookup), \ 4855 FN(sock_hash_update), \ 4856 FN(msg_redirect_hash), \ 4857 FN(sk_redirect_hash), \ 4858 FN(lwt_push_encap), \ 4859 FN(lwt_seg6_store_bytes), \ 4860 FN(lwt_seg6_adjust_srh), \ 4861 FN(lwt_seg6_action), \ 4862 FN(rc_repeat), \ 4863 FN(rc_keydown), \ 4864 FN(skb_cgroup_id), \ 4865 FN(get_current_cgroup_id), \ 4866 FN(get_local_storage), \ 4867 FN(sk_select_reuseport), \ 4868 FN(skb_ancestor_cgroup_id), \ 4869 FN(sk_lookup_tcp), \ 4870 FN(sk_lookup_udp), \ 4871 FN(sk_release), \ 4872 FN(map_push_elem), \ 4873 FN(map_pop_elem), \ 4874 FN(map_peek_elem), \ 4875 FN(msg_push_data), \ 4876 FN(msg_pop_data), \ 4877 FN(rc_pointer_rel), \ 4878 FN(spin_lock), \ 4879 FN(spin_unlock), \ 4880 FN(sk_fullsock), \ 4881 FN(tcp_sock), \ 4882 FN(skb_ecn_set_ce), \ 4883 FN(get_listener_sock), \ 4884 FN(skc_lookup_tcp), \ 4885 FN(tcp_check_syncookie), \ 4886 FN(sysctl_get_name), \ 4887 FN(sysctl_get_current_value), \ 4888 FN(sysctl_get_new_value), \ 4889 FN(sysctl_set_new_value), \ 4890 FN(strtol), \ 4891 FN(strtoul), \ 4892 FN(sk_storage_get), \ 4893 FN(sk_storage_delete), \ 4894 FN(send_signal), \ 4895 FN(tcp_gen_syncookie), \ 4896 FN(skb_output), \ 4897 FN(probe_read_user), \ 4898 FN(probe_read_kernel), \ 4899 FN(probe_read_user_str), \ 4900 FN(probe_read_kernel_str), \ 4901 FN(tcp_send_ack), \ 4902 FN(send_signal_thread), \ 4903 FN(jiffies64), \ 4904 FN(read_branch_records), \ 4905 FN(get_ns_current_pid_tgid), \ 4906 FN(xdp_output), \ 4907 FN(get_netns_cookie), \ 4908 FN(get_current_ancestor_cgroup_id), \ 4909 FN(sk_assign), \ 4910 FN(ktime_get_boot_ns), \ 4911 FN(seq_printf), \ 4912 FN(seq_write), \ 4913 FN(sk_cgroup_id), \ 4914 FN(sk_ancestor_cgroup_id), \ 4915 FN(ringbuf_output), \ 4916 FN(ringbuf_reserve), \ 4917 FN(ringbuf_submit), \ 4918 FN(ringbuf_discard), \ 4919 FN(ringbuf_query), \ 4920 FN(csum_level), \ 4921 FN(skc_to_tcp6_sock), \ 4922 FN(skc_to_tcp_sock), \ 4923 FN(skc_to_tcp_timewait_sock), \ 4924 FN(skc_to_tcp_request_sock), \ 4925 FN(skc_to_udp6_sock), \ 4926 FN(get_task_stack), \ 4927 FN(load_hdr_opt), \ 4928 FN(store_hdr_opt), \ 4929 FN(reserve_hdr_opt), \ 4930 FN(inode_storage_get), \ 4931 FN(inode_storage_delete), \ 4932 FN(d_path), \ 4933 FN(copy_from_user), \ 4934 FN(snprintf_btf), \ 4935 FN(seq_printf_btf), \ 4936 FN(skb_cgroup_classid), \ 4937 FN(redirect_neigh), \ 4938 FN(per_cpu_ptr), \ 4939 FN(this_cpu_ptr), \ 4940 FN(redirect_peer), \ 4941 FN(task_storage_get), \ 4942 FN(task_storage_delete), \ 4943 FN(get_current_task_btf), \ 4944 FN(bprm_opts_set), \ 4945 FN(ktime_get_coarse_ns), \ 4946 FN(ima_inode_hash), \ 4947 FN(sock_from_file), \ 4948 FN(check_mtu), \ 4949 FN(for_each_map_elem), \ 4950 FN(snprintf), \ 4951 FN(sys_bpf), \ 4952 FN(btf_find_by_name_kind), \ 4953 FN(sys_close), \ 4954 /* */ 4955 4956/* integer value in 'imm' field of BPF_CALL instruction selects which helper 4957 * function eBPF program intends to call 4958 */ 4959#define __BPF_ENUM_FN(x) BPF_FUNC_ ## x 4960enum bpf_func_id { 4961 __BPF_FUNC_MAPPER(__BPF_ENUM_FN) 4962 __BPF_FUNC_MAX_ID, 4963}; 4964#undef __BPF_ENUM_FN 4965 4966/* All flags used by eBPF helper functions, placed here. */ 4967 4968/* BPF_FUNC_skb_store_bytes flags. */ 4969enum { 4970 BPF_F_RECOMPUTE_CSUM = (1ULL << 0), 4971 BPF_F_INVALIDATE_HASH = (1ULL << 1), 4972}; 4973 4974/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags. 4975 * First 4 bits are for passing the header field size. 4976 */ 4977enum { 4978 BPF_F_HDR_FIELD_MASK = 0xfULL, 4979}; 4980 4981/* BPF_FUNC_l4_csum_replace flags. */ 4982enum { 4983 BPF_F_PSEUDO_HDR = (1ULL << 4), 4984 BPF_F_MARK_MANGLED_0 = (1ULL << 5), 4985 BPF_F_MARK_ENFORCE = (1ULL << 6), 4986}; 4987 4988/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */ 4989enum { 4990 BPF_F_INGRESS = (1ULL << 0), 4991}; 4992 4993/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */ 4994enum { 4995 BPF_F_TUNINFO_IPV6 = (1ULL << 0), 4996}; 4997 4998/* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */ 4999enum { 5000 BPF_F_SKIP_FIELD_MASK = 0xffULL, 5001 BPF_F_USER_STACK = (1ULL << 8), 5002/* flags used by BPF_FUNC_get_stackid only. */ 5003 BPF_F_FAST_STACK_CMP = (1ULL << 9), 5004 BPF_F_REUSE_STACKID = (1ULL << 10), 5005/* flags used by BPF_FUNC_get_stack only. */ 5006 BPF_F_USER_BUILD_ID = (1ULL << 11), 5007}; 5008 5009/* BPF_FUNC_skb_set_tunnel_key flags. */ 5010enum { 5011 BPF_F_ZERO_CSUM_TX = (1ULL << 1), 5012 BPF_F_DONT_FRAGMENT = (1ULL << 2), 5013 BPF_F_SEQ_NUMBER = (1ULL << 3), 5014}; 5015 5016/* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and 5017 * BPF_FUNC_perf_event_read_value flags. 5018 */ 5019enum { 5020 BPF_F_INDEX_MASK = 0xffffffffULL, 5021 BPF_F_CURRENT_CPU = BPF_F_INDEX_MASK, 5022/* BPF_FUNC_perf_event_output for sk_buff input context. */ 5023 BPF_F_CTXLEN_MASK = (0xfffffULL << 32), 5024}; 5025 5026/* Current network namespace */ 5027enum { 5028 BPF_F_CURRENT_NETNS = (-1L), 5029}; 5030 5031/* BPF_FUNC_csum_level level values. */ 5032enum { 5033 BPF_CSUM_LEVEL_QUERY, 5034 BPF_CSUM_LEVEL_INC, 5035 BPF_CSUM_LEVEL_DEC, 5036 BPF_CSUM_LEVEL_RESET, 5037}; 5038 5039/* BPF_FUNC_skb_adjust_room flags. */ 5040enum { 5041 BPF_F_ADJ_ROOM_FIXED_GSO = (1ULL << 0), 5042 BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 = (1ULL << 1), 5043 BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 = (1ULL << 2), 5044 BPF_F_ADJ_ROOM_ENCAP_L4_GRE = (1ULL << 3), 5045 BPF_F_ADJ_ROOM_ENCAP_L4_UDP = (1ULL << 4), 5046 BPF_F_ADJ_ROOM_NO_CSUM_RESET = (1ULL << 5), 5047 BPF_F_ADJ_ROOM_ENCAP_L2_ETH = (1ULL << 6), 5048}; 5049 5050enum { 5051 BPF_ADJ_ROOM_ENCAP_L2_MASK = 0xff, 5052 BPF_ADJ_ROOM_ENCAP_L2_SHIFT = 56, 5053}; 5054 5055#define BPF_F_ADJ_ROOM_ENCAP_L2(len) (((__u64)len & \ 5056 BPF_ADJ_ROOM_ENCAP_L2_MASK) \ 5057 << BPF_ADJ_ROOM_ENCAP_L2_SHIFT) 5058 5059/* BPF_FUNC_sysctl_get_name flags. */ 5060enum { 5061 BPF_F_SYSCTL_BASE_NAME = (1ULL << 0), 5062}; 5063 5064/* BPF_FUNC_<kernel_obj>_storage_get flags */ 5065enum { 5066 BPF_LOCAL_STORAGE_GET_F_CREATE = (1ULL << 0), 5067 /* BPF_SK_STORAGE_GET_F_CREATE is only kept for backward compatibility 5068 * and BPF_LOCAL_STORAGE_GET_F_CREATE must be used instead. 5069 */ 5070 BPF_SK_STORAGE_GET_F_CREATE = BPF_LOCAL_STORAGE_GET_F_CREATE, 5071}; 5072 5073/* BPF_FUNC_read_branch_records flags. */ 5074enum { 5075 BPF_F_GET_BRANCH_RECORDS_SIZE = (1ULL << 0), 5076}; 5077 5078/* BPF_FUNC_bpf_ringbuf_commit, BPF_FUNC_bpf_ringbuf_discard, and 5079 * BPF_FUNC_bpf_ringbuf_output flags. 5080 */ 5081enum { 5082 BPF_RB_NO_WAKEUP = (1ULL << 0), 5083 BPF_RB_FORCE_WAKEUP = (1ULL << 1), 5084}; 5085 5086/* BPF_FUNC_bpf_ringbuf_query flags */ 5087enum { 5088 BPF_RB_AVAIL_DATA = 0, 5089 BPF_RB_RING_SIZE = 1, 5090 BPF_RB_CONS_POS = 2, 5091 BPF_RB_PROD_POS = 3, 5092}; 5093 5094/* BPF ring buffer constants */ 5095enum { 5096 BPF_RINGBUF_BUSY_BIT = (1U << 31), 5097 BPF_RINGBUF_DISCARD_BIT = (1U << 30), 5098 BPF_RINGBUF_HDR_SZ = 8, 5099}; 5100 5101/* BPF_FUNC_sk_assign flags in bpf_sk_lookup context. */ 5102enum { 5103 BPF_SK_LOOKUP_F_REPLACE = (1ULL << 0), 5104 BPF_SK_LOOKUP_F_NO_REUSEPORT = (1ULL << 1), 5105}; 5106 5107/* Mode for BPF_FUNC_skb_adjust_room helper. */ 5108enum bpf_adj_room_mode { 5109 BPF_ADJ_ROOM_NET, 5110 BPF_ADJ_ROOM_MAC, 5111}; 5112 5113/* Mode for BPF_FUNC_skb_load_bytes_relative helper. */ 5114enum bpf_hdr_start_off { 5115 BPF_HDR_START_MAC, 5116 BPF_HDR_START_NET, 5117}; 5118 5119/* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */ 5120enum bpf_lwt_encap_mode { 5121 BPF_LWT_ENCAP_SEG6, 5122 BPF_LWT_ENCAP_SEG6_INLINE, 5123 BPF_LWT_ENCAP_IP, 5124}; 5125 5126/* Flags for bpf_bprm_opts_set helper */ 5127enum { 5128 BPF_F_BPRM_SECUREEXEC = (1ULL << 0), 5129}; 5130 5131/* Flags for bpf_redirect_map helper */ 5132enum { 5133 BPF_F_BROADCAST = (1ULL << 3), 5134 BPF_F_EXCLUDE_INGRESS = (1ULL << 4), 5135}; 5136 5137#define __bpf_md_ptr(type, name) \ 5138union { \ 5139 type name; \ 5140 __u64 :64; \ 5141} __attribute__((aligned(8))) 5142 5143/* user accessible mirror of in-kernel sk_buff. 5144 * new fields can only be added to the end of this structure 5145 */ 5146struct __sk_buff { 5147 __u32 len; 5148 __u32 pkt_type; 5149 __u32 mark; 5150 __u32 queue_mapping; 5151 __u32 protocol; 5152 __u32 vlan_present; 5153 __u32 vlan_tci; 5154 __u32 vlan_proto; 5155 __u32 priority; 5156 __u32 ingress_ifindex; 5157 __u32 ifindex; 5158 __u32 tc_index; 5159 __u32 cb[5]; 5160 __u32 hash; 5161 __u32 tc_classid; 5162 __u32 data; 5163 __u32 data_end; 5164 __u32 napi_id; 5165 5166 /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */ 5167 __u32 family; 5168 __u32 remote_ip4; /* Stored in network byte order */ 5169 __u32 local_ip4; /* Stored in network byte order */ 5170 __u32 remote_ip6[4]; /* Stored in network byte order */ 5171 __u32 local_ip6[4]; /* Stored in network byte order */ 5172 __u32 remote_port; /* Stored in network byte order */ 5173 __u32 local_port; /* stored in host byte order */ 5174 /* ... here. */ 5175 5176 __u32 data_meta; 5177 __bpf_md_ptr(struct bpf_flow_keys *, flow_keys); 5178 __u64 tstamp; 5179 __u32 wire_len; 5180 __u32 gso_segs; 5181 __bpf_md_ptr(struct bpf_sock *, sk); 5182 __u32 gso_size; 5183}; 5184 5185struct bpf_tunnel_key { 5186 __u32 tunnel_id; 5187 union { 5188 __u32 remote_ipv4; 5189 __u32 remote_ipv6[4]; 5190 }; 5191 __u8 tunnel_tos; 5192 __u8 tunnel_ttl; 5193 __u16 tunnel_ext; /* Padding, future use. */ 5194 __u32 tunnel_label; 5195}; 5196 5197/* user accessible mirror of in-kernel xfrm_state. 5198 * new fields can only be added to the end of this structure 5199 */ 5200struct bpf_xfrm_state { 5201 __u32 reqid; 5202 __u32 spi; /* Stored in network byte order */ 5203 __u16 family; 5204 __u16 ext; /* Padding, future use. */ 5205 union { 5206 __u32 remote_ipv4; /* Stored in network byte order */ 5207 __u32 remote_ipv6[4]; /* Stored in network byte order */ 5208 }; 5209}; 5210 5211/* Generic BPF return codes which all BPF program types may support. 5212 * The values are binary compatible with their TC_ACT_* counter-part to 5213 * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT 5214 * programs. 5215 * 5216 * XDP is handled seprately, see XDP_*. 5217 */ 5218enum bpf_ret_code { 5219 BPF_OK = 0, 5220 /* 1 reserved */ 5221 BPF_DROP = 2, 5222 /* 3-6 reserved */ 5223 BPF_REDIRECT = 7, 5224 /* >127 are reserved for prog type specific return codes. 5225 * 5226 * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and 5227 * BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been 5228 * changed and should be routed based on its new L3 header. 5229 * (This is an L3 redirect, as opposed to L2 redirect 5230 * represented by BPF_REDIRECT above). 5231 */ 5232 BPF_LWT_REROUTE = 128, 5233}; 5234 5235struct bpf_sock { 5236 __u32 bound_dev_if; 5237 __u32 family; 5238 __u32 type; 5239 __u32 protocol; 5240 __u32 mark; 5241 __u32 priority; 5242 /* IP address also allows 1 and 2 bytes access */ 5243 __u32 src_ip4; 5244 __u32 src_ip6[4]; 5245 __u32 src_port; /* host byte order */ 5246 __u32 dst_port; /* network byte order */ 5247 __u32 dst_ip4; 5248 __u32 dst_ip6[4]; 5249 __u32 state; 5250 __s32 rx_queue_mapping; 5251}; 5252 5253struct bpf_tcp_sock { 5254 __u32 snd_cwnd; /* Sending congestion window */ 5255 __u32 srtt_us; /* smoothed round trip time << 3 in usecs */ 5256 __u32 rtt_min; 5257 __u32 snd_ssthresh; /* Slow start size threshold */ 5258 __u32 rcv_nxt; /* What we want to receive next */ 5259 __u32 snd_nxt; /* Next sequence we send */ 5260 __u32 snd_una; /* First byte we want an ack for */ 5261 __u32 mss_cache; /* Cached effective mss, not including SACKS */ 5262 __u32 ecn_flags; /* ECN status bits. */ 5263 __u32 rate_delivered; /* saved rate sample: packets delivered */ 5264 __u32 rate_interval_us; /* saved rate sample: time elapsed */ 5265 __u32 packets_out; /* Packets which are "in flight" */ 5266 __u32 retrans_out; /* Retransmitted packets out */ 5267 __u32 total_retrans; /* Total retransmits for entire connection */ 5268 __u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn 5269 * total number of segments in. 5270 */ 5271 __u32 data_segs_in; /* RFC4898 tcpEStatsPerfDataSegsIn 5272 * total number of data segments in. 5273 */ 5274 __u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut 5275 * The total number of segments sent. 5276 */ 5277 __u32 data_segs_out; /* RFC4898 tcpEStatsPerfDataSegsOut 5278 * total number of data segments sent. 5279 */ 5280 __u32 lost_out; /* Lost packets */ 5281 __u32 sacked_out; /* SACK'd packets */ 5282 __u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived 5283 * sum(delta(rcv_nxt)), or how many bytes 5284 * were acked. 5285 */ 5286 __u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked 5287 * sum(delta(snd_una)), or how many bytes 5288 * were acked. 5289 */ 5290 __u32 dsack_dups; /* RFC4898 tcpEStatsStackDSACKDups 5291 * total number of DSACK blocks received 5292 */ 5293 __u32 delivered; /* Total data packets delivered incl. rexmits */ 5294 __u32 delivered_ce; /* Like the above but only ECE marked packets */ 5295 __u32 icsk_retransmits; /* Number of unrecovered [RTO] timeouts */ 5296}; 5297 5298struct bpf_sock_tuple { 5299 union { 5300 struct { 5301 __be32 saddr; 5302 __be32 daddr; 5303 __be16 sport; 5304 __be16 dport; 5305 } ipv4; 5306 struct { 5307 __be32 saddr[4]; 5308 __be32 daddr[4]; 5309 __be16 sport; 5310 __be16 dport; 5311 } ipv6; 5312 }; 5313}; 5314 5315struct bpf_xdp_sock { 5316 __u32 queue_id; 5317}; 5318 5319#define XDP_PACKET_HEADROOM 256 5320 5321/* User return codes for XDP prog type. 5322 * A valid XDP program must return one of these defined values. All other 5323 * return codes are reserved for future use. Unknown return codes will 5324 * result in packet drops and a warning via bpf_warn_invalid_xdp_action(). 5325 */ 5326enum xdp_action { 5327 XDP_ABORTED = 0, 5328 XDP_DROP, 5329 XDP_PASS, 5330 XDP_TX, 5331 XDP_REDIRECT, 5332}; 5333 5334/* user accessible metadata for XDP packet hook 5335 * new fields must be added to the end of this structure 5336 */ 5337struct xdp_md { 5338 __u32 data; 5339 __u32 data_end; 5340 __u32 data_meta; 5341 /* Below access go through struct xdp_rxq_info */ 5342 __u32 ingress_ifindex; /* rxq->dev->ifindex */ 5343 __u32 rx_queue_index; /* rxq->queue_index */ 5344 5345 __u32 egress_ifindex; /* txq->dev->ifindex */ 5346}; 5347 5348/* DEVMAP map-value layout 5349 * 5350 * The struct data-layout of map-value is a configuration interface. 5351 * New members can only be added to the end of this structure. 5352 */ 5353struct bpf_devmap_val { 5354 __u32 ifindex; /* device index */ 5355 union { 5356 int fd; /* prog fd on map write */ 5357 __u32 id; /* prog id on map read */ 5358 } bpf_prog; 5359}; 5360 5361/* CPUMAP map-value layout 5362 * 5363 * The struct data-layout of map-value is a configuration interface. 5364 * New members can only be added to the end of this structure. 5365 */ 5366struct bpf_cpumap_val { 5367 __u32 qsize; /* queue size to remote target CPU */ 5368 union { 5369 int fd; /* prog fd on map write */ 5370 __u32 id; /* prog id on map read */ 5371 } bpf_prog; 5372}; 5373 5374enum sk_action { 5375 SK_DROP = 0, 5376 SK_PASS, 5377}; 5378 5379/* user accessible metadata for SK_MSG packet hook, new fields must 5380 * be added to the end of this structure 5381 */ 5382struct sk_msg_md { 5383 __bpf_md_ptr(void *, data); 5384 __bpf_md_ptr(void *, data_end); 5385 5386 __u32 family; 5387 __u32 remote_ip4; /* Stored in network byte order */ 5388 __u32 local_ip4; /* Stored in network byte order */ 5389 __u32 remote_ip6[4]; /* Stored in network byte order */ 5390 __u32 local_ip6[4]; /* Stored in network byte order */ 5391 __u32 remote_port; /* Stored in network byte order */ 5392 __u32 local_port; /* stored in host byte order */ 5393 __u32 size; /* Total size of sk_msg */ 5394 5395 __bpf_md_ptr(struct bpf_sock *, sk); /* current socket */ 5396}; 5397 5398struct sk_reuseport_md { 5399 /* 5400 * Start of directly accessible data. It begins from 5401 * the tcp/udp header. 5402 */ 5403 __bpf_md_ptr(void *, data); 5404 /* End of directly accessible data */ 5405 __bpf_md_ptr(void *, data_end); 5406 /* 5407 * Total length of packet (starting from the tcp/udp header). 5408 * Note that the directly accessible bytes (data_end - data) 5409 * could be less than this "len". Those bytes could be 5410 * indirectly read by a helper "bpf_skb_load_bytes()". 5411 */ 5412 __u32 len; 5413 /* 5414 * Eth protocol in the mac header (network byte order). e.g. 5415 * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD) 5416 */ 5417 __u32 eth_protocol; 5418 __u32 ip_protocol; /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */ 5419 __u32 bind_inany; /* Is sock bound to an INANY address? */ 5420 __u32 hash; /* A hash of the packet 4 tuples */ 5421 /* When reuse->migrating_sk is NULL, it is selecting a sk for the 5422 * new incoming connection request (e.g. selecting a listen sk for 5423 * the received SYN in the TCP case). reuse->sk is one of the sk 5424 * in the reuseport group. The bpf prog can use reuse->sk to learn 5425 * the local listening ip/port without looking into the skb. 5426 * 5427 * When reuse->migrating_sk is not NULL, reuse->sk is closed and 5428 * reuse->migrating_sk is the socket that needs to be migrated 5429 * to another listening socket. migrating_sk could be a fullsock 5430 * sk that is fully established or a reqsk that is in-the-middle 5431 * of 3-way handshake. 5432 */ 5433 __bpf_md_ptr(struct bpf_sock *, sk); 5434 __bpf_md_ptr(struct bpf_sock *, migrating_sk); 5435}; 5436 5437#define BPF_TAG_SIZE 8 5438 5439struct bpf_prog_info { 5440 __u32 type; 5441 __u32 id; 5442 __u8 tag[BPF_TAG_SIZE]; 5443 __u32 jited_prog_len; 5444 __u32 xlated_prog_len; 5445 __aligned_u64 jited_prog_insns; 5446 __aligned_u64 xlated_prog_insns; 5447 __u64 load_time; /* ns since boottime */ 5448 __u32 created_by_uid; 5449 __u32 nr_map_ids; 5450 __aligned_u64 map_ids; 5451 char name[BPF_OBJ_NAME_LEN]; 5452 __u32 ifindex; 5453 __u32 gpl_compatible:1; 5454 __u32 :31; /* alignment pad */ 5455 __u64 netns_dev; 5456 __u64 netns_ino; 5457 __u32 nr_jited_ksyms; 5458 __u32 nr_jited_func_lens; 5459 __aligned_u64 jited_ksyms; 5460 __aligned_u64 jited_func_lens; 5461 __u32 btf_id; 5462 __u32 func_info_rec_size; 5463 __aligned_u64 func_info; 5464 __u32 nr_func_info; 5465 __u32 nr_line_info; 5466 __aligned_u64 line_info; 5467 __aligned_u64 jited_line_info; 5468 __u32 nr_jited_line_info; 5469 __u32 line_info_rec_size; 5470 __u32 jited_line_info_rec_size; 5471 __u32 nr_prog_tags; 5472 __aligned_u64 prog_tags; 5473 __u64 run_time_ns; 5474 __u64 run_cnt; 5475 __u64 recursion_misses; 5476} __attribute__((aligned(8))); 5477 5478struct bpf_map_info { 5479 __u32 type; 5480 __u32 id; 5481 __u32 key_size; 5482 __u32 value_size; 5483 __u32 max_entries; 5484 __u32 map_flags; 5485 char name[BPF_OBJ_NAME_LEN]; 5486 __u32 ifindex; 5487 __u32 btf_vmlinux_value_type_id; 5488 __u64 netns_dev; 5489 __u64 netns_ino; 5490 __u32 btf_id; 5491 __u32 btf_key_type_id; 5492 __u32 btf_value_type_id; 5493} __attribute__((aligned(8))); 5494 5495struct bpf_btf_info { 5496 __aligned_u64 btf; 5497 __u32 btf_size; 5498 __u32 id; 5499 __aligned_u64 name; 5500 __u32 name_len; 5501 __u32 kernel_btf; 5502} __attribute__((aligned(8))); 5503 5504struct bpf_link_info { 5505 __u32 type; 5506 __u32 id; 5507 __u32 prog_id; 5508 union { 5509 struct { 5510 __aligned_u64 tp_name; /* in/out: tp_name buffer ptr */ 5511 __u32 tp_name_len; /* in/out: tp_name buffer len */ 5512 } raw_tracepoint; 5513 struct { 5514 __u32 attach_type; 5515 __u32 target_obj_id; /* prog_id for PROG_EXT, otherwise btf object id */ 5516 __u32 target_btf_id; /* BTF type id inside the object */ 5517 } tracing; 5518 struct { 5519 __u64 cgroup_id; 5520 __u32 attach_type; 5521 } cgroup; 5522 struct { 5523 __aligned_u64 target_name; /* in/out: target_name buffer ptr */ 5524 __u32 target_name_len; /* in/out: target_name buffer len */ 5525 union { 5526 struct { 5527 __u32 map_id; 5528 } map; 5529 }; 5530 } iter; 5531 struct { 5532 __u32 netns_ino; 5533 __u32 attach_type; 5534 } netns; 5535 struct { 5536 __u32 ifindex; 5537 } xdp; 5538 }; 5539} __attribute__((aligned(8))); 5540 5541/* User bpf_sock_addr struct to access socket fields and sockaddr struct passed 5542 * by user and intended to be used by socket (e.g. to bind to, depends on 5543 * attach type). 5544 */ 5545struct bpf_sock_addr { 5546 __u32 user_family; /* Allows 4-byte read, but no write. */ 5547 __u32 user_ip4; /* Allows 1,2,4-byte read and 4-byte write. 5548 * Stored in network byte order. 5549 */ 5550 __u32 user_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write. 5551 * Stored in network byte order. 5552 */ 5553 __u32 user_port; /* Allows 1,2,4-byte read and 4-byte write. 5554 * Stored in network byte order 5555 */ 5556 __u32 family; /* Allows 4-byte read, but no write */ 5557 __u32 type; /* Allows 4-byte read, but no write */ 5558 __u32 protocol; /* Allows 4-byte read, but no write */ 5559 __u32 msg_src_ip4; /* Allows 1,2,4-byte read and 4-byte write. 5560 * Stored in network byte order. 5561 */ 5562 __u32 msg_src_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write. 5563 * Stored in network byte order. 5564 */ 5565 __bpf_md_ptr(struct bpf_sock *, sk); 5566}; 5567 5568/* User bpf_sock_ops struct to access socket values and specify request ops 5569 * and their replies. 5570 * Some of this fields are in network (bigendian) byte order and may need 5571 * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h). 5572 * New fields can only be added at the end of this structure 5573 */ 5574struct bpf_sock_ops { 5575 __u32 op; 5576 union { 5577 __u32 args[4]; /* Optionally passed to bpf program */ 5578 __u32 reply; /* Returned by bpf program */ 5579 __u32 replylong[4]; /* Optionally returned by bpf prog */ 5580 }; 5581 __u32 family; 5582 __u32 remote_ip4; /* Stored in network byte order */ 5583 __u32 local_ip4; /* Stored in network byte order */ 5584 __u32 remote_ip6[4]; /* Stored in network byte order */ 5585 __u32 local_ip6[4]; /* Stored in network byte order */ 5586 __u32 remote_port; /* Stored in network byte order */ 5587 __u32 local_port; /* stored in host byte order */ 5588 __u32 is_fullsock; /* Some TCP fields are only valid if 5589 * there is a full socket. If not, the 5590 * fields read as zero. 5591 */ 5592 __u32 snd_cwnd; 5593 __u32 srtt_us; /* Averaged RTT << 3 in usecs */ 5594 __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */ 5595 __u32 state; 5596 __u32 rtt_min; 5597 __u32 snd_ssthresh; 5598 __u32 rcv_nxt; 5599 __u32 snd_nxt; 5600 __u32 snd_una; 5601 __u32 mss_cache; 5602 __u32 ecn_flags; 5603 __u32 rate_delivered; 5604 __u32 rate_interval_us; 5605 __u32 packets_out; 5606 __u32 retrans_out; 5607 __u32 total_retrans; 5608 __u32 segs_in; 5609 __u32 data_segs_in; 5610 __u32 segs_out; 5611 __u32 data_segs_out; 5612 __u32 lost_out; 5613 __u32 sacked_out; 5614 __u32 sk_txhash; 5615 __u64 bytes_received; 5616 __u64 bytes_acked; 5617 __bpf_md_ptr(struct bpf_sock *, sk); 5618 /* [skb_data, skb_data_end) covers the whole TCP header. 5619 * 5620 * BPF_SOCK_OPS_PARSE_HDR_OPT_CB: The packet received 5621 * BPF_SOCK_OPS_HDR_OPT_LEN_CB: Not useful because the 5622 * header has not been written. 5623 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB: The header and options have 5624 * been written so far. 5625 * BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB: The SYNACK that concludes 5626 * the 3WHS. 5627 * BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB: The ACK that concludes 5628 * the 3WHS. 5629 * 5630 * bpf_load_hdr_opt() can also be used to read a particular option. 5631 */ 5632 __bpf_md_ptr(void *, skb_data); 5633 __bpf_md_ptr(void *, skb_data_end); 5634 __u32 skb_len; /* The total length of a packet. 5635 * It includes the header, options, 5636 * and payload. 5637 */ 5638 __u32 skb_tcp_flags; /* tcp_flags of the header. It provides 5639 * an easy way to check for tcp_flags 5640 * without parsing skb_data. 5641 * 5642 * In particular, the skb_tcp_flags 5643 * will still be available in 5644 * BPF_SOCK_OPS_HDR_OPT_LEN even though 5645 * the outgoing header has not 5646 * been written yet. 5647 */ 5648}; 5649 5650/* Definitions for bpf_sock_ops_cb_flags */ 5651enum { 5652 BPF_SOCK_OPS_RTO_CB_FLAG = (1<<0), 5653 BPF_SOCK_OPS_RETRANS_CB_FLAG = (1<<1), 5654 BPF_SOCK_OPS_STATE_CB_FLAG = (1<<2), 5655 BPF_SOCK_OPS_RTT_CB_FLAG = (1<<3), 5656 /* Call bpf for all received TCP headers. The bpf prog will be 5657 * called under sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB 5658 * 5659 * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB 5660 * for the header option related helpers that will be useful 5661 * to the bpf programs. 5662 * 5663 * It could be used at the client/active side (i.e. connect() side) 5664 * when the server told it that the server was in syncookie 5665 * mode and required the active side to resend the bpf-written 5666 * options. The active side can keep writing the bpf-options until 5667 * it received a valid packet from the server side to confirm 5668 * the earlier packet (and options) has been received. The later 5669 * example patch is using it like this at the active side when the 5670 * server is in syncookie mode. 5671 * 5672 * The bpf prog will usually turn this off in the common cases. 5673 */ 5674 BPF_SOCK_OPS_PARSE_ALL_HDR_OPT_CB_FLAG = (1<<4), 5675 /* Call bpf when kernel has received a header option that 5676 * the kernel cannot handle. The bpf prog will be called under 5677 * sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB. 5678 * 5679 * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB 5680 * for the header option related helpers that will be useful 5681 * to the bpf programs. 5682 */ 5683 BPF_SOCK_OPS_PARSE_UNKNOWN_HDR_OPT_CB_FLAG = (1<<5), 5684 /* Call bpf when the kernel is writing header options for the 5685 * outgoing packet. The bpf prog will first be called 5686 * to reserve space in a skb under 5687 * sock_ops->op == BPF_SOCK_OPS_HDR_OPT_LEN_CB. Then 5688 * the bpf prog will be called to write the header option(s) 5689 * under sock_ops->op == BPF_SOCK_OPS_WRITE_HDR_OPT_CB. 5690 * 5691 * Please refer to the comment in BPF_SOCK_OPS_HDR_OPT_LEN_CB 5692 * and BPF_SOCK_OPS_WRITE_HDR_OPT_CB for the header option 5693 * related helpers that will be useful to the bpf programs. 5694 * 5695 * The kernel gets its chance to reserve space and write 5696 * options first before the BPF program does. 5697 */ 5698 BPF_SOCK_OPS_WRITE_HDR_OPT_CB_FLAG = (1<<6), 5699/* Mask of all currently supported cb flags */ 5700 BPF_SOCK_OPS_ALL_CB_FLAGS = 0x7F, 5701}; 5702 5703/* List of known BPF sock_ops operators. 5704 * New entries can only be added at the end 5705 */ 5706enum { 5707 BPF_SOCK_OPS_VOID, 5708 BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or 5709 * -1 if default value should be used 5710 */ 5711 BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized 5712 * window (in packets) or -1 if default 5713 * value should be used 5714 */ 5715 BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an 5716 * active connection is initialized 5717 */ 5718 BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an 5719 * active connection is 5720 * established 5721 */ 5722 BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a 5723 * passive connection is 5724 * established 5725 */ 5726 BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control 5727 * needs ECN 5728 */ 5729 BPF_SOCK_OPS_BASE_RTT, /* Get base RTT. The correct value is 5730 * based on the path and may be 5731 * dependent on the congestion control 5732 * algorithm. In general it indicates 5733 * a congestion threshold. RTTs above 5734 * this indicate congestion 5735 */ 5736 BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered. 5737 * Arg1: value of icsk_retransmits 5738 * Arg2: value of icsk_rto 5739 * Arg3: whether RTO has expired 5740 */ 5741 BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted. 5742 * Arg1: sequence number of 1st byte 5743 * Arg2: # segments 5744 * Arg3: return value of 5745 * tcp_transmit_skb (0 => success) 5746 */ 5747 BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state. 5748 * Arg1: old_state 5749 * Arg2: new_state 5750 */ 5751 BPF_SOCK_OPS_TCP_LISTEN_CB, /* Called on listen(2), right after 5752 * socket transition to LISTEN state. 5753 */ 5754 BPF_SOCK_OPS_RTT_CB, /* Called on every RTT. 5755 */ 5756 BPF_SOCK_OPS_PARSE_HDR_OPT_CB, /* Parse the header option. 5757 * It will be called to handle 5758 * the packets received at 5759 * an already established 5760 * connection. 5761 * 5762 * sock_ops->skb_data: 5763 * Referring to the received skb. 5764 * It covers the TCP header only. 5765 * 5766 * bpf_load_hdr_opt() can also 5767 * be used to search for a 5768 * particular option. 5769 */ 5770 BPF_SOCK_OPS_HDR_OPT_LEN_CB, /* Reserve space for writing the 5771 * header option later in 5772 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB. 5773 * Arg1: bool want_cookie. (in 5774 * writing SYNACK only) 5775 * 5776 * sock_ops->skb_data: 5777 * Not available because no header has 5778 * been written yet. 5779 * 5780 * sock_ops->skb_tcp_flags: 5781 * The tcp_flags of the 5782 * outgoing skb. (e.g. SYN, ACK, FIN). 5783 * 5784 * bpf_reserve_hdr_opt() should 5785 * be used to reserve space. 5786 */ 5787 BPF_SOCK_OPS_WRITE_HDR_OPT_CB, /* Write the header options 5788 * Arg1: bool want_cookie. (in 5789 * writing SYNACK only) 5790 * 5791 * sock_ops->skb_data: 5792 * Referring to the outgoing skb. 5793 * It covers the TCP header 5794 * that has already been written 5795 * by the kernel and the 5796 * earlier bpf-progs. 5797 * 5798 * sock_ops->skb_tcp_flags: 5799 * The tcp_flags of the outgoing 5800 * skb. (e.g. SYN, ACK, FIN). 5801 * 5802 * bpf_store_hdr_opt() should 5803 * be used to write the 5804 * option. 5805 * 5806 * bpf_load_hdr_opt() can also 5807 * be used to search for a 5808 * particular option that 5809 * has already been written 5810 * by the kernel or the 5811 * earlier bpf-progs. 5812 */ 5813}; 5814 5815/* List of TCP states. There is a build check in net/ipv4/tcp.c to detect 5816 * changes between the TCP and BPF versions. Ideally this should never happen. 5817 * If it does, we need to add code to convert them before calling 5818 * the BPF sock_ops function. 5819 */ 5820enum { 5821 BPF_TCP_ESTABLISHED = 1, 5822 BPF_TCP_SYN_SENT, 5823 BPF_TCP_SYN_RECV, 5824 BPF_TCP_FIN_WAIT1, 5825 BPF_TCP_FIN_WAIT2, 5826 BPF_TCP_TIME_WAIT, 5827 BPF_TCP_CLOSE, 5828 BPF_TCP_CLOSE_WAIT, 5829 BPF_TCP_LAST_ACK, 5830 BPF_TCP_LISTEN, 5831 BPF_TCP_CLOSING, /* Now a valid state */ 5832 BPF_TCP_NEW_SYN_RECV, 5833 5834 BPF_TCP_MAX_STATES /* Leave at the end! */ 5835}; 5836 5837enum { 5838 TCP_BPF_IW = 1001, /* Set TCP initial congestion window */ 5839 TCP_BPF_SNDCWND_CLAMP = 1002, /* Set sndcwnd_clamp */ 5840 TCP_BPF_DELACK_MAX = 1003, /* Max delay ack in usecs */ 5841 TCP_BPF_RTO_MIN = 1004, /* Min delay ack in usecs */ 5842 /* Copy the SYN pkt to optval 5843 * 5844 * BPF_PROG_TYPE_SOCK_OPS only. It is similar to the 5845 * bpf_getsockopt(TCP_SAVED_SYN) but it does not limit 5846 * to only getting from the saved_syn. It can either get the 5847 * syn packet from: 5848 * 5849 * 1. the just-received SYN packet (only available when writing the 5850 * SYNACK). It will be useful when it is not necessary to 5851 * save the SYN packet for latter use. It is also the only way 5852 * to get the SYN during syncookie mode because the syn 5853 * packet cannot be saved during syncookie. 5854 * 5855 * OR 5856 * 5857 * 2. the earlier saved syn which was done by 5858 * bpf_setsockopt(TCP_SAVE_SYN). 5859 * 5860 * The bpf_getsockopt(TCP_BPF_SYN*) option will hide where the 5861 * SYN packet is obtained. 5862 * 5863 * If the bpf-prog does not need the IP[46] header, the 5864 * bpf-prog can avoid parsing the IP header by using 5865 * TCP_BPF_SYN. Otherwise, the bpf-prog can get both 5866 * IP[46] and TCP header by using TCP_BPF_SYN_IP. 5867 * 5868 * >0: Total number of bytes copied 5869 * -ENOSPC: Not enough space in optval. Only optlen number of 5870 * bytes is copied. 5871 * -ENOENT: The SYN skb is not available now and the earlier SYN pkt 5872 * is not saved by setsockopt(TCP_SAVE_SYN). 5873 */ 5874 TCP_BPF_SYN = 1005, /* Copy the TCP header */ 5875 TCP_BPF_SYN_IP = 1006, /* Copy the IP[46] and TCP header */ 5876 TCP_BPF_SYN_MAC = 1007, /* Copy the MAC, IP[46], and TCP header */ 5877}; 5878 5879enum { 5880 BPF_LOAD_HDR_OPT_TCP_SYN = (1ULL << 0), 5881}; 5882 5883/* args[0] value during BPF_SOCK_OPS_HDR_OPT_LEN_CB and 5884 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB. 5885 */ 5886enum { 5887 BPF_WRITE_HDR_TCP_CURRENT_MSS = 1, /* Kernel is finding the 5888 * total option spaces 5889 * required for an established 5890 * sk in order to calculate the 5891 * MSS. No skb is actually 5892 * sent. 5893 */ 5894 BPF_WRITE_HDR_TCP_SYNACK_COOKIE = 2, /* Kernel is in syncookie mode 5895 * when sending a SYN. 5896 */ 5897}; 5898 5899struct bpf_perf_event_value { 5900 __u64 counter; 5901 __u64 enabled; 5902 __u64 running; 5903}; 5904 5905enum { 5906 BPF_DEVCG_ACC_MKNOD = (1ULL << 0), 5907 BPF_DEVCG_ACC_READ = (1ULL << 1), 5908 BPF_DEVCG_ACC_WRITE = (1ULL << 2), 5909}; 5910 5911enum { 5912 BPF_DEVCG_DEV_BLOCK = (1ULL << 0), 5913 BPF_DEVCG_DEV_CHAR = (1ULL << 1), 5914}; 5915 5916struct bpf_cgroup_dev_ctx { 5917 /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */ 5918 __u32 access_type; 5919 __u32 major; 5920 __u32 minor; 5921}; 5922 5923struct bpf_raw_tracepoint_args { 5924 __u64 args[0]; 5925}; 5926 5927/* DIRECT: Skip the FIB rules and go to FIB table associated with device 5928 * OUTPUT: Do lookup from egress perspective; default is ingress 5929 */ 5930enum { 5931 BPF_FIB_LOOKUP_DIRECT = (1U << 0), 5932 BPF_FIB_LOOKUP_OUTPUT = (1U << 1), 5933}; 5934 5935enum { 5936 BPF_FIB_LKUP_RET_SUCCESS, /* lookup successful */ 5937 BPF_FIB_LKUP_RET_BLACKHOLE, /* dest is blackholed; can be dropped */ 5938 BPF_FIB_LKUP_RET_UNREACHABLE, /* dest is unreachable; can be dropped */ 5939 BPF_FIB_LKUP_RET_PROHIBIT, /* dest not allowed; can be dropped */ 5940 BPF_FIB_LKUP_RET_NOT_FWDED, /* packet is not forwarded */ 5941 BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */ 5942 BPF_FIB_LKUP_RET_UNSUPP_LWT, /* fwd requires encapsulation */ 5943 BPF_FIB_LKUP_RET_NO_NEIGH, /* no neighbor entry for nh */ 5944 BPF_FIB_LKUP_RET_FRAG_NEEDED, /* fragmentation required to fwd */ 5945}; 5946 5947struct bpf_fib_lookup { 5948 /* input: network family for lookup (AF_INET, AF_INET6) 5949 * output: network family of egress nexthop 5950 */ 5951 __u8 family; 5952 5953 /* set if lookup is to consider L4 data - e.g., FIB rules */ 5954 __u8 l4_protocol; 5955 __be16 sport; 5956 __be16 dport; 5957 5958 union { /* used for MTU check */ 5959 /* input to lookup */ 5960 __u16 tot_len; /* L3 length from network hdr (iph->tot_len) */ 5961 5962 /* output: MTU value */ 5963 __u16 mtu_result; 5964 }; 5965 /* input: L3 device index for lookup 5966 * output: device index from FIB lookup 5967 */ 5968 __u32 ifindex; 5969 5970 union { 5971 /* inputs to lookup */ 5972 __u8 tos; /* AF_INET */ 5973 __be32 flowinfo; /* AF_INET6, flow_label + priority */ 5974 5975 /* output: metric of fib result (IPv4/IPv6 only) */ 5976 __u32 rt_metric; 5977 }; 5978 5979 union { 5980 __be32 ipv4_src; 5981 __u32 ipv6_src[4]; /* in6_addr; network order */ 5982 }; 5983 5984 /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in 5985 * network header. output: bpf_fib_lookup sets to gateway address 5986 * if FIB lookup returns gateway route 5987 */ 5988 union { 5989 __be32 ipv4_dst; 5990 __u32 ipv6_dst[4]; /* in6_addr; network order */ 5991 }; 5992 5993 /* output */ 5994 __be16 h_vlan_proto; 5995 __be16 h_vlan_TCI; 5996 __u8 smac[6]; /* ETH_ALEN */ 5997 __u8 dmac[6]; /* ETH_ALEN */ 5998}; 5999 6000struct bpf_redir_neigh { 6001 /* network family for lookup (AF_INET, AF_INET6) */ 6002 __u32 nh_family; 6003 /* network address of nexthop; skips fib lookup to find gateway */ 6004 union { 6005 __be32 ipv4_nh; 6006 __u32 ipv6_nh[4]; /* in6_addr; network order */ 6007 }; 6008}; 6009 6010/* bpf_check_mtu flags*/ 6011enum bpf_check_mtu_flags { 6012 BPF_MTU_CHK_SEGS = (1U << 0), 6013}; 6014 6015enum bpf_check_mtu_ret { 6016 BPF_MTU_CHK_RET_SUCCESS, /* check and lookup successful */ 6017 BPF_MTU_CHK_RET_FRAG_NEEDED, /* fragmentation required to fwd */ 6018 BPF_MTU_CHK_RET_SEGS_TOOBIG, /* GSO re-segmentation needed to fwd */ 6019}; 6020 6021enum bpf_task_fd_type { 6022 BPF_FD_TYPE_RAW_TRACEPOINT, /* tp name */ 6023 BPF_FD_TYPE_TRACEPOINT, /* tp name */ 6024 BPF_FD_TYPE_KPROBE, /* (symbol + offset) or addr */ 6025 BPF_FD_TYPE_KRETPROBE, /* (symbol + offset) or addr */ 6026 BPF_FD_TYPE_UPROBE, /* filename + offset */ 6027 BPF_FD_TYPE_URETPROBE, /* filename + offset */ 6028}; 6029 6030enum { 6031 BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG = (1U << 0), 6032 BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL = (1U << 1), 6033 BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP = (1U << 2), 6034}; 6035 6036struct bpf_flow_keys { 6037 __u16 nhoff; 6038 __u16 thoff; 6039 __u16 addr_proto; /* ETH_P_* of valid addrs */ 6040 __u8 is_frag; 6041 __u8 is_first_frag; 6042 __u8 is_encap; 6043 __u8 ip_proto; 6044 __be16 n_proto; 6045 __be16 sport; 6046 __be16 dport; 6047 union { 6048 struct { 6049 __be32 ipv4_src; 6050 __be32 ipv4_dst; 6051 }; 6052 struct { 6053 __u32 ipv6_src[4]; /* in6_addr; network order */ 6054 __u32 ipv6_dst[4]; /* in6_addr; network order */ 6055 }; 6056 }; 6057 __u32 flags; 6058 __be32 flow_label; 6059}; 6060 6061struct bpf_func_info { 6062 __u32 insn_off; 6063 __u32 type_id; 6064}; 6065 6066#define BPF_LINE_INFO_LINE_NUM(line_col) ((line_col) >> 10) 6067#define BPF_LINE_INFO_LINE_COL(line_col) ((line_col) & 0x3ff) 6068 6069struct bpf_line_info { 6070 __u32 insn_off; 6071 __u32 file_name_off; 6072 __u32 line_off; 6073 __u32 line_col; 6074}; 6075 6076struct bpf_spin_lock { 6077 __u32 val; 6078}; 6079 6080struct bpf_sysctl { 6081 __u32 write; /* Sysctl is being read (= 0) or written (= 1). 6082 * Allows 1,2,4-byte read, but no write. 6083 */ 6084 __u32 file_pos; /* Sysctl file position to read from, write to. 6085 * Allows 1,2,4-byte read an 4-byte write. 6086 */ 6087}; 6088 6089struct bpf_sockopt { 6090 __bpf_md_ptr(struct bpf_sock *, sk); 6091 __bpf_md_ptr(void *, optval); 6092 __bpf_md_ptr(void *, optval_end); 6093 6094 __s32 level; 6095 __s32 optname; 6096 __s32 optlen; 6097 __s32 retval; 6098}; 6099 6100struct bpf_pidns_info { 6101 __u32 pid; 6102 __u32 tgid; 6103}; 6104 6105/* User accessible data for SK_LOOKUP programs. Add new fields at the end. */ 6106struct bpf_sk_lookup { 6107 union { 6108 __bpf_md_ptr(struct bpf_sock *, sk); /* Selected socket */ 6109 __u64 cookie; /* Non-zero if socket was selected in PROG_TEST_RUN */ 6110 }; 6111 6112 __u32 family; /* Protocol family (AF_INET, AF_INET6) */ 6113 __u32 protocol; /* IP protocol (IPPROTO_TCP, IPPROTO_UDP) */ 6114 __u32 remote_ip4; /* Network byte order */ 6115 __u32 remote_ip6[4]; /* Network byte order */ 6116 __u32 remote_port; /* Network byte order */ 6117 __u32 local_ip4; /* Network byte order */ 6118 __u32 local_ip6[4]; /* Network byte order */ 6119 __u32 local_port; /* Host byte order */ 6120}; 6121 6122/* 6123 * struct btf_ptr is used for typed pointer representation; the 6124 * type id is used to render the pointer data as the appropriate type 6125 * via the bpf_snprintf_btf() helper described above. A flags field - 6126 * potentially to specify additional details about the BTF pointer 6127 * (rather than its mode of display) - is included for future use. 6128 * Display flags - BTF_F_* - are passed to bpf_snprintf_btf separately. 6129 */ 6130struct btf_ptr { 6131 void *ptr; 6132 __u32 type_id; 6133 __u32 flags; /* BTF ptr flags; unused at present. */ 6134}; 6135 6136/* 6137 * Flags to control bpf_snprintf_btf() behaviour. 6138 * - BTF_F_COMPACT: no formatting around type information 6139 * - BTF_F_NONAME: no struct/union member names/types 6140 * - BTF_F_PTR_RAW: show raw (unobfuscated) pointer values; 6141 * equivalent to %px. 6142 * - BTF_F_ZERO: show zero-valued struct/union members; they 6143 * are not displayed by default 6144 */ 6145enum { 6146 BTF_F_COMPACT = (1ULL << 0), 6147 BTF_F_NONAME = (1ULL << 1), 6148 BTF_F_PTR_RAW = (1ULL << 2), 6149 BTF_F_ZERO = (1ULL << 3), 6150}; 6151 6152#endif /* _UAPI__LINUX_BPF_H__ */