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_XADD 0xc0 /* exclusive add */ 23 24 /* alu/jmp fields */ 25 #define BPF_MOV 0xb0 /* mov reg to reg */ 26 #define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */ 27 28 /* change endianness of a register */ 29 #define BPF_END 0xd0 /* flags for endianness conversion: */ 30 #define BPF_TO_LE 0x00 /* convert to little-endian */ 31 #define BPF_TO_BE 0x08 /* convert to big-endian */ 32 #define BPF_FROM_LE BPF_TO_LE 33 #define BPF_FROM_BE BPF_TO_BE 34 35 /* jmp encodings */ 36 #define BPF_JNE 0x50 /* jump != */ 37 #define BPF_JLT 0xa0 /* LT is unsigned, '<' */ 38 #define BPF_JLE 0xb0 /* LE is unsigned, '<=' */ 39 #define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */ 40 #define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */ 41 #define BPF_JSLT 0xc0 /* SLT is signed, '<' */ 42 #define BPF_JSLE 0xd0 /* SLE is signed, '<=' */ 43 #define BPF_CALL 0x80 /* function call */ 44 #define BPF_EXIT 0x90 /* function return */ 45 46 /* Register numbers */ 47 enum { 48 BPF_REG_0 = 0, 49 BPF_REG_1, 50 BPF_REG_2, 51 BPF_REG_3, 52 BPF_REG_4, 53 BPF_REG_5, 54 BPF_REG_6, 55 BPF_REG_7, 56 BPF_REG_8, 57 BPF_REG_9, 58 BPF_REG_10, 59 __MAX_BPF_REG, 60 }; 61 62 /* BPF has 10 general purpose 64-bit registers and stack frame. */ 63 #define MAX_BPF_REG __MAX_BPF_REG 64 65 struct bpf_insn { 66 __u8 code; /* opcode */ 67 __u8 dst_reg:4; /* dest register */ 68 __u8 src_reg:4; /* source register */ 69 __s16 off; /* signed offset */ 70 __s32 imm; /* signed immediate constant */ 71 }; 72 73 /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */ 74 struct bpf_lpm_trie_key { 75 __u32 prefixlen; /* up to 32 for AF_INET, 128 for AF_INET6 */ 76 __u8 data[0]; /* Arbitrary size */ 77 }; 78 79 struct bpf_cgroup_storage_key { 80 __u64 cgroup_inode_id; /* cgroup inode id */ 81 __u32 attach_type; /* program attach type */ 82 }; 83 84 /* BPF syscall commands, see bpf(2) man-page for details. */ 85 enum bpf_cmd { 86 BPF_MAP_CREATE, 87 BPF_MAP_LOOKUP_ELEM, 88 BPF_MAP_UPDATE_ELEM, 89 BPF_MAP_DELETE_ELEM, 90 BPF_MAP_GET_NEXT_KEY, 91 BPF_PROG_LOAD, 92 BPF_OBJ_PIN, 93 BPF_OBJ_GET, 94 BPF_PROG_ATTACH, 95 BPF_PROG_DETACH, 96 BPF_PROG_TEST_RUN, 97 BPF_PROG_GET_NEXT_ID, 98 BPF_MAP_GET_NEXT_ID, 99 BPF_PROG_GET_FD_BY_ID, 100 BPF_MAP_GET_FD_BY_ID, 101 BPF_OBJ_GET_INFO_BY_FD, 102 BPF_PROG_QUERY, 103 BPF_RAW_TRACEPOINT_OPEN, 104 BPF_BTF_LOAD, 105 BPF_BTF_GET_FD_BY_ID, 106 BPF_TASK_FD_QUERY, 107 BPF_MAP_LOOKUP_AND_DELETE_ELEM, 108 BPF_MAP_FREEZE, 109 BPF_BTF_GET_NEXT_ID, 110 }; 111 112 enum bpf_map_type { 113 BPF_MAP_TYPE_UNSPEC, 114 BPF_MAP_TYPE_HASH, 115 BPF_MAP_TYPE_ARRAY, 116 BPF_MAP_TYPE_PROG_ARRAY, 117 BPF_MAP_TYPE_PERF_EVENT_ARRAY, 118 BPF_MAP_TYPE_PERCPU_HASH, 119 BPF_MAP_TYPE_PERCPU_ARRAY, 120 BPF_MAP_TYPE_STACK_TRACE, 121 BPF_MAP_TYPE_CGROUP_ARRAY, 122 BPF_MAP_TYPE_LRU_HASH, 123 BPF_MAP_TYPE_LRU_PERCPU_HASH, 124 BPF_MAP_TYPE_LPM_TRIE, 125 BPF_MAP_TYPE_ARRAY_OF_MAPS, 126 BPF_MAP_TYPE_HASH_OF_MAPS, 127 BPF_MAP_TYPE_DEVMAP, 128 BPF_MAP_TYPE_SOCKMAP, 129 BPF_MAP_TYPE_CPUMAP, 130 BPF_MAP_TYPE_XSKMAP, 131 BPF_MAP_TYPE_SOCKHASH, 132 BPF_MAP_TYPE_CGROUP_STORAGE, 133 BPF_MAP_TYPE_REUSEPORT_SOCKARRAY, 134 BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE, 135 BPF_MAP_TYPE_QUEUE, 136 BPF_MAP_TYPE_STACK, 137 BPF_MAP_TYPE_SK_STORAGE, 138 BPF_MAP_TYPE_DEVMAP_HASH, 139 }; 140 141 /* Note that tracing related programs such as 142 * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT} 143 * are not subject to a stable API since kernel internal data 144 * structures can change from release to release and may 145 * therefore break existing tracing BPF programs. Tracing BPF 146 * programs correspond to /a/ specific kernel which is to be 147 * analyzed, and not /a/ specific kernel /and/ all future ones. 148 */ 149 enum bpf_prog_type { 150 BPF_PROG_TYPE_UNSPEC, 151 BPF_PROG_TYPE_SOCKET_FILTER, 152 BPF_PROG_TYPE_KPROBE, 153 BPF_PROG_TYPE_SCHED_CLS, 154 BPF_PROG_TYPE_SCHED_ACT, 155 BPF_PROG_TYPE_TRACEPOINT, 156 BPF_PROG_TYPE_XDP, 157 BPF_PROG_TYPE_PERF_EVENT, 158 BPF_PROG_TYPE_CGROUP_SKB, 159 BPF_PROG_TYPE_CGROUP_SOCK, 160 BPF_PROG_TYPE_LWT_IN, 161 BPF_PROG_TYPE_LWT_OUT, 162 BPF_PROG_TYPE_LWT_XMIT, 163 BPF_PROG_TYPE_SOCK_OPS, 164 BPF_PROG_TYPE_SK_SKB, 165 BPF_PROG_TYPE_CGROUP_DEVICE, 166 BPF_PROG_TYPE_SK_MSG, 167 BPF_PROG_TYPE_RAW_TRACEPOINT, 168 BPF_PROG_TYPE_CGROUP_SOCK_ADDR, 169 BPF_PROG_TYPE_LWT_SEG6LOCAL, 170 BPF_PROG_TYPE_LIRC_MODE2, 171 BPF_PROG_TYPE_SK_REUSEPORT, 172 BPF_PROG_TYPE_FLOW_DISSECTOR, 173 BPF_PROG_TYPE_CGROUP_SYSCTL, 174 BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE, 175 BPF_PROG_TYPE_CGROUP_SOCKOPT, 176 BPF_PROG_TYPE_TRACING, 177 }; 178 179 enum bpf_attach_type { 180 BPF_CGROUP_INET_INGRESS, 181 BPF_CGROUP_INET_EGRESS, 182 BPF_CGROUP_INET_SOCK_CREATE, 183 BPF_CGROUP_SOCK_OPS, 184 BPF_SK_SKB_STREAM_PARSER, 185 BPF_SK_SKB_STREAM_VERDICT, 186 BPF_CGROUP_DEVICE, 187 BPF_SK_MSG_VERDICT, 188 BPF_CGROUP_INET4_BIND, 189 BPF_CGROUP_INET6_BIND, 190 BPF_CGROUP_INET4_CONNECT, 191 BPF_CGROUP_INET6_CONNECT, 192 BPF_CGROUP_INET4_POST_BIND, 193 BPF_CGROUP_INET6_POST_BIND, 194 BPF_CGROUP_UDP4_SENDMSG, 195 BPF_CGROUP_UDP6_SENDMSG, 196 BPF_LIRC_MODE2, 197 BPF_FLOW_DISSECTOR, 198 BPF_CGROUP_SYSCTL, 199 BPF_CGROUP_UDP4_RECVMSG, 200 BPF_CGROUP_UDP6_RECVMSG, 201 BPF_CGROUP_GETSOCKOPT, 202 BPF_CGROUP_SETSOCKOPT, 203 BPF_TRACE_RAW_TP, 204 BPF_TRACE_FENTRY, 205 BPF_TRACE_FEXIT, 206 __MAX_BPF_ATTACH_TYPE 207 }; 208 209 #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE 210 211 /* cgroup-bpf attach flags used in BPF_PROG_ATTACH command 212 * 213 * NONE(default): No further bpf programs allowed in the subtree. 214 * 215 * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program, 216 * the program in this cgroup yields to sub-cgroup program. 217 * 218 * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program, 219 * that cgroup program gets run in addition to the program in this cgroup. 220 * 221 * Only one program is allowed to be attached to a cgroup with 222 * NONE or BPF_F_ALLOW_OVERRIDE flag. 223 * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will 224 * release old program and attach the new one. Attach flags has to match. 225 * 226 * Multiple programs are allowed to be attached to a cgroup with 227 * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order 228 * (those that were attached first, run first) 229 * The programs of sub-cgroup are executed first, then programs of 230 * this cgroup and then programs of parent cgroup. 231 * When children program makes decision (like picking TCP CA or sock bind) 232 * parent program has a chance to override it. 233 * 234 * With BPF_F_ALLOW_MULTI a new program is added to the end of the list of 235 * programs for a cgroup. Though it's possible to replace an old program at 236 * any position by also specifying BPF_F_REPLACE flag and position itself in 237 * replace_bpf_fd attribute. Old program at this position will be released. 238 * 239 * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups. 240 * A cgroup with NONE doesn't allow any programs in sub-cgroups. 241 * Ex1: 242 * cgrp1 (MULTI progs A, B) -> 243 * cgrp2 (OVERRIDE prog C) -> 244 * cgrp3 (MULTI prog D) -> 245 * cgrp4 (OVERRIDE prog E) -> 246 * cgrp5 (NONE prog F) 247 * the event in cgrp5 triggers execution of F,D,A,B in that order. 248 * if prog F is detached, the execution is E,D,A,B 249 * if prog F and D are detached, the execution is E,A,B 250 * if prog F, E and D are detached, the execution is C,A,B 251 * 252 * All eligible programs are executed regardless of return code from 253 * earlier programs. 254 */ 255 #define BPF_F_ALLOW_OVERRIDE (1U << 0) 256 #define BPF_F_ALLOW_MULTI (1U << 1) 257 #define BPF_F_REPLACE (1U << 2) 258 259 /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the 260 * verifier will perform strict alignment checking as if the kernel 261 * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set, 262 * and NET_IP_ALIGN defined to 2. 263 */ 264 #define BPF_F_STRICT_ALIGNMENT (1U << 0) 265 266 /* If BPF_F_ANY_ALIGNMENT is used in BPF_PROF_LOAD command, the 267 * verifier will allow any alignment whatsoever. On platforms 268 * with strict alignment requirements for loads ands stores (such 269 * as sparc and mips) the verifier validates that all loads and 270 * stores provably follow this requirement. This flag turns that 271 * checking and enforcement off. 272 * 273 * It is mostly used for testing when we want to validate the 274 * context and memory access aspects of the verifier, but because 275 * of an unaligned access the alignment check would trigger before 276 * the one we are interested in. 277 */ 278 #define BPF_F_ANY_ALIGNMENT (1U << 1) 279 280 /* BPF_F_TEST_RND_HI32 is used in BPF_PROG_LOAD command for testing purpose. 281 * Verifier does sub-register def/use analysis and identifies instructions whose 282 * def only matters for low 32-bit, high 32-bit is never referenced later 283 * through implicit zero extension. Therefore verifier notifies JIT back-ends 284 * that it is safe to ignore clearing high 32-bit for these instructions. This 285 * saves some back-ends a lot of code-gen. However such optimization is not 286 * necessary on some arches, for example x86_64, arm64 etc, whose JIT back-ends 287 * hence hasn't used verifier's analysis result. But, we really want to have a 288 * way to be able to verify the correctness of the described optimization on 289 * x86_64 on which testsuites are frequently exercised. 290 * 291 * So, this flag is introduced. Once it is set, verifier will randomize high 292 * 32-bit for those instructions who has been identified as safe to ignore them. 293 * Then, if verifier is not doing correct analysis, such randomization will 294 * regress tests to expose bugs. 295 */ 296 #define BPF_F_TEST_RND_HI32 (1U << 2) 297 298 /* The verifier internal test flag. Behavior is undefined */ 299 #define BPF_F_TEST_STATE_FREQ (1U << 3) 300 301 /* When BPF ldimm64's insn[0].src_reg != 0 then this can have 302 * two extensions: 303 * 304 * insn[0].src_reg: BPF_PSEUDO_MAP_FD BPF_PSEUDO_MAP_VALUE 305 * insn[0].imm: map fd map fd 306 * insn[1].imm: 0 offset into value 307 * insn[0].off: 0 0 308 * insn[1].off: 0 0 309 * ldimm64 rewrite: address of map address of map[0]+offset 310 * verifier type: CONST_PTR_TO_MAP PTR_TO_MAP_VALUE 311 */ 312 #define BPF_PSEUDO_MAP_FD 1 313 #define BPF_PSEUDO_MAP_VALUE 2 314 315 /* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative 316 * offset to another bpf function 317 */ 318 #define BPF_PSEUDO_CALL 1 319 320 /* flags for BPF_MAP_UPDATE_ELEM command */ 321 #define BPF_ANY 0 /* create new element or update existing */ 322 #define BPF_NOEXIST 1 /* create new element if it didn't exist */ 323 #define BPF_EXIST 2 /* update existing element */ 324 #define BPF_F_LOCK 4 /* spin_lock-ed map_lookup/map_update */ 325 326 /* flags for BPF_MAP_CREATE command */ 327 #define BPF_F_NO_PREALLOC (1U << 0) 328 /* Instead of having one common LRU list in the 329 * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list 330 * which can scale and perform better. 331 * Note, the LRU nodes (including free nodes) cannot be moved 332 * across different LRU lists. 333 */ 334 #define BPF_F_NO_COMMON_LRU (1U << 1) 335 /* Specify numa node during map creation */ 336 #define BPF_F_NUMA_NODE (1U << 2) 337 338 #define BPF_OBJ_NAME_LEN 16U 339 340 /* Flags for accessing BPF object from syscall side. */ 341 #define BPF_F_RDONLY (1U << 3) 342 #define BPF_F_WRONLY (1U << 4) 343 344 /* Flag for stack_map, store build_id+offset instead of pointer */ 345 #define BPF_F_STACK_BUILD_ID (1U << 5) 346 347 /* Zero-initialize hash function seed. This should only be used for testing. */ 348 #define BPF_F_ZERO_SEED (1U << 6) 349 350 /* Flags for accessing BPF object from program side. */ 351 #define BPF_F_RDONLY_PROG (1U << 7) 352 #define BPF_F_WRONLY_PROG (1U << 8) 353 354 /* Clone map from listener for newly accepted socket */ 355 #define BPF_F_CLONE (1U << 9) 356 357 /* Enable memory-mapping BPF map */ 358 #define BPF_F_MMAPABLE (1U << 10) 359 360 /* flags for BPF_PROG_QUERY */ 361 #define BPF_F_QUERY_EFFECTIVE (1U << 0) 362 363 enum bpf_stack_build_id_status { 364 /* user space need an empty entry to identify end of a trace */ 365 BPF_STACK_BUILD_ID_EMPTY = 0, 366 /* with valid build_id and offset */ 367 BPF_STACK_BUILD_ID_VALID = 1, 368 /* couldn't get build_id, fallback to ip */ 369 BPF_STACK_BUILD_ID_IP = 2, 370 }; 371 372 #define BPF_BUILD_ID_SIZE 20 373 struct bpf_stack_build_id { 374 __s32 status; 375 unsigned char build_id[BPF_BUILD_ID_SIZE]; 376 union { 377 __u64 offset; 378 __u64 ip; 379 }; 380 }; 381 382 union bpf_attr { 383 struct { /* anonymous struct used by BPF_MAP_CREATE command */ 384 __u32 map_type; /* one of enum bpf_map_type */ 385 __u32 key_size; /* size of key in bytes */ 386 __u32 value_size; /* size of value in bytes */ 387 __u32 max_entries; /* max number of entries in a map */ 388 __u32 map_flags; /* BPF_MAP_CREATE related 389 * flags defined above. 390 */ 391 __u32 inner_map_fd; /* fd pointing to the inner map */ 392 __u32 numa_node; /* numa node (effective only if 393 * BPF_F_NUMA_NODE is set). 394 */ 395 char map_name[BPF_OBJ_NAME_LEN]; 396 __u32 map_ifindex; /* ifindex of netdev to create on */ 397 __u32 btf_fd; /* fd pointing to a BTF type data */ 398 __u32 btf_key_type_id; /* BTF type_id of the key */ 399 __u32 btf_value_type_id; /* BTF type_id of the value */ 400 }; 401 402 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */ 403 __u32 map_fd; 404 __aligned_u64 key; 405 union { 406 __aligned_u64 value; 407 __aligned_u64 next_key; 408 }; 409 __u64 flags; 410 }; 411 412 struct { /* anonymous struct used by BPF_PROG_LOAD command */ 413 __u32 prog_type; /* one of enum bpf_prog_type */ 414 __u32 insn_cnt; 415 __aligned_u64 insns; 416 __aligned_u64 license; 417 __u32 log_level; /* verbosity level of verifier */ 418 __u32 log_size; /* size of user buffer */ 419 __aligned_u64 log_buf; /* user supplied buffer */ 420 __u32 kern_version; /* not used */ 421 __u32 prog_flags; 422 char prog_name[BPF_OBJ_NAME_LEN]; 423 __u32 prog_ifindex; /* ifindex of netdev to prep for */ 424 /* For some prog types expected attach type must be known at 425 * load time to verify attach type specific parts of prog 426 * (context accesses, allowed helpers, etc). 427 */ 428 __u32 expected_attach_type; 429 __u32 prog_btf_fd; /* fd pointing to BTF type data */ 430 __u32 func_info_rec_size; /* userspace bpf_func_info size */ 431 __aligned_u64 func_info; /* func info */ 432 __u32 func_info_cnt; /* number of bpf_func_info records */ 433 __u32 line_info_rec_size; /* userspace bpf_line_info size */ 434 __aligned_u64 line_info; /* line info */ 435 __u32 line_info_cnt; /* number of bpf_line_info records */ 436 __u32 attach_btf_id; /* in-kernel BTF type id to attach to */ 437 __u32 attach_prog_fd; /* 0 to attach to vmlinux */ 438 }; 439 440 struct { /* anonymous struct used by BPF_OBJ_* commands */ 441 __aligned_u64 pathname; 442 __u32 bpf_fd; 443 __u32 file_flags; 444 }; 445 446 struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */ 447 __u32 target_fd; /* container object to attach to */ 448 __u32 attach_bpf_fd; /* eBPF program to attach */ 449 __u32 attach_type; 450 __u32 attach_flags; 451 __u32 replace_bpf_fd; /* previously attached eBPF 452 * program to replace if 453 * BPF_F_REPLACE is used 454 */ 455 }; 456 457 struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */ 458 __u32 prog_fd; 459 __u32 retval; 460 __u32 data_size_in; /* input: len of data_in */ 461 __u32 data_size_out; /* input/output: len of data_out 462 * returns ENOSPC if data_out 463 * is too small. 464 */ 465 __aligned_u64 data_in; 466 __aligned_u64 data_out; 467 __u32 repeat; 468 __u32 duration; 469 __u32 ctx_size_in; /* input: len of ctx_in */ 470 __u32 ctx_size_out; /* input/output: len of ctx_out 471 * returns ENOSPC if ctx_out 472 * is too small. 473 */ 474 __aligned_u64 ctx_in; 475 __aligned_u64 ctx_out; 476 } test; 477 478 struct { /* anonymous struct used by BPF_*_GET_*_ID */ 479 union { 480 __u32 start_id; 481 __u32 prog_id; 482 __u32 map_id; 483 __u32 btf_id; 484 }; 485 __u32 next_id; 486 __u32 open_flags; 487 }; 488 489 struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */ 490 __u32 bpf_fd; 491 __u32 info_len; 492 __aligned_u64 info; 493 } info; 494 495 struct { /* anonymous struct used by BPF_PROG_QUERY command */ 496 __u32 target_fd; /* container object to query */ 497 __u32 attach_type; 498 __u32 query_flags; 499 __u32 attach_flags; 500 __aligned_u64 prog_ids; 501 __u32 prog_cnt; 502 } query; 503 504 struct { 505 __u64 name; 506 __u32 prog_fd; 507 } raw_tracepoint; 508 509 struct { /* anonymous struct for BPF_BTF_LOAD */ 510 __aligned_u64 btf; 511 __aligned_u64 btf_log_buf; 512 __u32 btf_size; 513 __u32 btf_log_size; 514 __u32 btf_log_level; 515 }; 516 517 struct { 518 __u32 pid; /* input: pid */ 519 __u32 fd; /* input: fd */ 520 __u32 flags; /* input: flags */ 521 __u32 buf_len; /* input/output: buf len */ 522 __aligned_u64 buf; /* input/output: 523 * tp_name for tracepoint 524 * symbol for kprobe 525 * filename for uprobe 526 */ 527 __u32 prog_id; /* output: prod_id */ 528 __u32 fd_type; /* output: BPF_FD_TYPE_* */ 529 __u64 probe_offset; /* output: probe_offset */ 530 __u64 probe_addr; /* output: probe_addr */ 531 } task_fd_query; 532 } __attribute__((aligned(8))); 533 534 /* The description below is an attempt at providing documentation to eBPF 535 * developers about the multiple available eBPF helper functions. It can be 536 * parsed and used to produce a manual page. The workflow is the following, 537 * and requires the rst2man utility: 538 * 539 * $ ./scripts/bpf_helpers_doc.py \ 540 * --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst 541 * $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7 542 * $ man /tmp/bpf-helpers.7 543 * 544 * Note that in order to produce this external documentation, some RST 545 * formatting is used in the descriptions to get "bold" and "italics" in 546 * manual pages. Also note that the few trailing white spaces are 547 * intentional, removing them would break paragraphs for rst2man. 548 * 549 * Start of BPF helper function descriptions: 550 * 551 * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key) 552 * Description 553 * Perform a lookup in *map* for an entry associated to *key*. 554 * Return 555 * Map value associated to *key*, or **NULL** if no entry was 556 * found. 557 * 558 * int bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags) 559 * Description 560 * Add or update the value of the entry associated to *key* in 561 * *map* with *value*. *flags* is one of: 562 * 563 * **BPF_NOEXIST** 564 * The entry for *key* must not exist in the map. 565 * **BPF_EXIST** 566 * The entry for *key* must already exist in the map. 567 * **BPF_ANY** 568 * No condition on the existence of the entry for *key*. 569 * 570 * Flag value **BPF_NOEXIST** cannot be used for maps of types 571 * **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY** (all 572 * elements always exist), the helper would return an error. 573 * Return 574 * 0 on success, or a negative error in case of failure. 575 * 576 * int bpf_map_delete_elem(struct bpf_map *map, const void *key) 577 * Description 578 * Delete entry with *key* from *map*. 579 * Return 580 * 0 on success, or a negative error in case of failure. 581 * 582 * int bpf_probe_read(void *dst, u32 size, const void *unsafe_ptr) 583 * Description 584 * For tracing programs, safely attempt to read *size* bytes from 585 * kernel space address *unsafe_ptr* and store the data in *dst*. 586 * 587 * Generally, use bpf_probe_read_user() or bpf_probe_read_kernel() 588 * instead. 589 * Return 590 * 0 on success, or a negative error in case of failure. 591 * 592 * u64 bpf_ktime_get_ns(void) 593 * Description 594 * Return the time elapsed since system boot, in nanoseconds. 595 * Return 596 * Current *ktime*. 597 * 598 * int bpf_trace_printk(const char *fmt, u32 fmt_size, ...) 599 * Description 600 * This helper is a "printk()-like" facility for debugging. It 601 * prints a message defined by format *fmt* (of size *fmt_size*) 602 * to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if 603 * available. It can take up to three additional **u64** 604 * arguments (as an eBPF helpers, the total number of arguments is 605 * limited to five). 606 * 607 * Each time the helper is called, it appends a line to the trace. 608 * Lines are discarded while *\/sys/kernel/debug/tracing/trace* is 609 * open, use *\/sys/kernel/debug/tracing/trace_pipe* to avoid this. 610 * The format of the trace is customizable, and the exact output 611 * one will get depends on the options set in 612 * *\/sys/kernel/debug/tracing/trace_options* (see also the 613 * *README* file under the same directory). However, it usually 614 * defaults to something like: 615 * 616 * :: 617 * 618 * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg> 619 * 620 * In the above: 621 * 622 * * ``telnet`` is the name of the current task. 623 * * ``470`` is the PID of the current task. 624 * * ``001`` is the CPU number on which the task is 625 * running. 626 * * In ``.N..``, each character refers to a set of 627 * options (whether irqs are enabled, scheduling 628 * options, whether hard/softirqs are running, level of 629 * preempt_disabled respectively). **N** means that 630 * **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED** 631 * are set. 632 * * ``419421.045894`` is a timestamp. 633 * * ``0x00000001`` is a fake value used by BPF for the 634 * instruction pointer register. 635 * * ``<formatted msg>`` is the message formatted with 636 * *fmt*. 637 * 638 * The conversion specifiers supported by *fmt* are similar, but 639 * more limited than for printk(). They are **%d**, **%i**, 640 * **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**, 641 * **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size 642 * of field, padding with zeroes, etc.) is available, and the 643 * helper will return **-EINVAL** (but print nothing) if it 644 * encounters an unknown specifier. 645 * 646 * Also, note that **bpf_trace_printk**\ () is slow, and should 647 * only be used for debugging purposes. For this reason, a notice 648 * bloc (spanning several lines) is printed to kernel logs and 649 * states that the helper should not be used "for production use" 650 * the first time this helper is used (or more precisely, when 651 * **trace_printk**\ () buffers are allocated). For passing values 652 * to user space, perf events should be preferred. 653 * Return 654 * The number of bytes written to the buffer, or a negative error 655 * in case of failure. 656 * 657 * u32 bpf_get_prandom_u32(void) 658 * Description 659 * Get a pseudo-random number. 660 * 661 * From a security point of view, this helper uses its own 662 * pseudo-random internal state, and cannot be used to infer the 663 * seed of other random functions in the kernel. However, it is 664 * essential to note that the generator used by the helper is not 665 * cryptographically secure. 666 * Return 667 * A random 32-bit unsigned value. 668 * 669 * u32 bpf_get_smp_processor_id(void) 670 * Description 671 * Get the SMP (symmetric multiprocessing) processor id. Note that 672 * all programs run with preemption disabled, which means that the 673 * SMP processor id is stable during all the execution of the 674 * program. 675 * Return 676 * The SMP id of the processor running the program. 677 * 678 * int bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags) 679 * Description 680 * Store *len* bytes from address *from* into the packet 681 * associated to *skb*, at *offset*. *flags* are a combination of 682 * **BPF_F_RECOMPUTE_CSUM** (automatically recompute the 683 * checksum for the packet after storing the bytes) and 684 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\ 685 * **->swhash** and *skb*\ **->l4hash** to 0). 686 * 687 * A call to this helper is susceptible to change the underlying 688 * packet buffer. Therefore, at load time, all checks on pointers 689 * previously done by the verifier are invalidated and must be 690 * performed again, if the helper is used in combination with 691 * direct packet access. 692 * Return 693 * 0 on success, or a negative error in case of failure. 694 * 695 * int bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size) 696 * Description 697 * Recompute the layer 3 (e.g. IP) checksum for the packet 698 * associated to *skb*. Computation is incremental, so the helper 699 * must know the former value of the header field that was 700 * modified (*from*), the new value of this field (*to*), and the 701 * number of bytes (2 or 4) for this field, stored in *size*. 702 * Alternatively, it is possible to store the difference between 703 * the previous and the new values of the header field in *to*, by 704 * setting *from* and *size* to 0. For both methods, *offset* 705 * indicates the location of the IP checksum within the packet. 706 * 707 * This helper works in combination with **bpf_csum_diff**\ (), 708 * which does not update the checksum in-place, but offers more 709 * flexibility and can handle sizes larger than 2 or 4 for the 710 * checksum to update. 711 * 712 * A call to this helper is susceptible to change the underlying 713 * packet buffer. Therefore, at load time, all checks on pointers 714 * previously done by the verifier are invalidated and must be 715 * performed again, if the helper is used in combination with 716 * direct packet access. 717 * Return 718 * 0 on success, or a negative error in case of failure. 719 * 720 * int bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags) 721 * Description 722 * Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the 723 * packet associated to *skb*. Computation is incremental, so the 724 * helper must know the former value of the header field that was 725 * modified (*from*), the new value of this field (*to*), and the 726 * number of bytes (2 or 4) for this field, stored on the lowest 727 * four bits of *flags*. Alternatively, it is possible to store 728 * the difference between the previous and the new values of the 729 * header field in *to*, by setting *from* and the four lowest 730 * bits of *flags* to 0. For both methods, *offset* indicates the 731 * location of the IP checksum within the packet. In addition to 732 * the size of the field, *flags* can be added (bitwise OR) actual 733 * flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left 734 * untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and 735 * for updates resulting in a null checksum the value is set to 736 * **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates 737 * the checksum is to be computed against a pseudo-header. 738 * 739 * This helper works in combination with **bpf_csum_diff**\ (), 740 * which does not update the checksum in-place, but offers more 741 * flexibility and can handle sizes larger than 2 or 4 for the 742 * checksum to update. 743 * 744 * A call to this helper is susceptible to change the underlying 745 * packet buffer. Therefore, at load time, all checks on pointers 746 * previously done by the verifier are invalidated and must be 747 * performed again, if the helper is used in combination with 748 * direct packet access. 749 * Return 750 * 0 on success, or a negative error in case of failure. 751 * 752 * int bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index) 753 * Description 754 * This special helper is used to trigger a "tail call", or in 755 * other words, to jump into another eBPF program. The same stack 756 * frame is used (but values on stack and in registers for the 757 * caller are not accessible to the callee). This mechanism allows 758 * for program chaining, either for raising the maximum number of 759 * available eBPF instructions, or to execute given programs in 760 * conditional blocks. For security reasons, there is an upper 761 * limit to the number of successive tail calls that can be 762 * performed. 763 * 764 * Upon call of this helper, the program attempts to jump into a 765 * program referenced at index *index* in *prog_array_map*, a 766 * special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes 767 * *ctx*, a pointer to the context. 768 * 769 * If the call succeeds, the kernel immediately runs the first 770 * instruction of the new program. This is not a function call, 771 * and it never returns to the previous program. If the call 772 * fails, then the helper has no effect, and the caller continues 773 * to run its subsequent instructions. A call can fail if the 774 * destination program for the jump does not exist (i.e. *index* 775 * is superior to the number of entries in *prog_array_map*), or 776 * if the maximum number of tail calls has been reached for this 777 * chain of programs. This limit is defined in the kernel by the 778 * macro **MAX_TAIL_CALL_CNT** (not accessible to user space), 779 * which is currently set to 32. 780 * Return 781 * 0 on success, or a negative error in case of failure. 782 * 783 * int bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags) 784 * Description 785 * Clone and redirect the packet associated to *skb* to another 786 * net device of index *ifindex*. Both ingress and egress 787 * interfaces can be used for redirection. The **BPF_F_INGRESS** 788 * value in *flags* is used to make the distinction (ingress path 789 * is selected if the flag is present, egress path otherwise). 790 * This is the only flag supported for now. 791 * 792 * In comparison with **bpf_redirect**\ () helper, 793 * **bpf_clone_redirect**\ () has the associated cost of 794 * duplicating the packet buffer, but this can be executed out of 795 * the eBPF program. Conversely, **bpf_redirect**\ () is more 796 * efficient, but it is handled through an action code where the 797 * redirection happens only after the eBPF program has returned. 798 * 799 * A call to this helper is susceptible to change the underlying 800 * packet buffer. Therefore, at load time, all checks on pointers 801 * previously done by the verifier are invalidated and must be 802 * performed again, if the helper is used in combination with 803 * direct packet access. 804 * Return 805 * 0 on success, or a negative error in case of failure. 806 * 807 * u64 bpf_get_current_pid_tgid(void) 808 * Return 809 * A 64-bit integer containing the current tgid and pid, and 810 * created as such: 811 * *current_task*\ **->tgid << 32 \|** 812 * *current_task*\ **->pid**. 813 * 814 * u64 bpf_get_current_uid_gid(void) 815 * Return 816 * A 64-bit integer containing the current GID and UID, and 817 * created as such: *current_gid* **<< 32 \|** *current_uid*. 818 * 819 * int bpf_get_current_comm(void *buf, u32 size_of_buf) 820 * Description 821 * Copy the **comm** attribute of the current task into *buf* of 822 * *size_of_buf*. The **comm** attribute contains the name of 823 * the executable (excluding the path) for the current task. The 824 * *size_of_buf* must be strictly positive. On success, the 825 * helper makes sure that the *buf* is NUL-terminated. On failure, 826 * it is filled with zeroes. 827 * Return 828 * 0 on success, or a negative error in case of failure. 829 * 830 * u32 bpf_get_cgroup_classid(struct sk_buff *skb) 831 * Description 832 * Retrieve the classid for the current task, i.e. for the net_cls 833 * cgroup to which *skb* belongs. 834 * 835 * This helper can be used on TC egress path, but not on ingress. 836 * 837 * The net_cls cgroup provides an interface to tag network packets 838 * based on a user-provided identifier for all traffic coming from 839 * the tasks belonging to the related cgroup. See also the related 840 * kernel documentation, available from the Linux sources in file 841 * *Documentation/admin-guide/cgroup-v1/net_cls.rst*. 842 * 843 * The Linux kernel has two versions for cgroups: there are 844 * cgroups v1 and cgroups v2. Both are available to users, who can 845 * use a mixture of them, but note that the net_cls cgroup is for 846 * cgroup v1 only. This makes it incompatible with BPF programs 847 * run on cgroups, which is a cgroup-v2-only feature (a socket can 848 * only hold data for one version of cgroups at a time). 849 * 850 * This helper is only available is the kernel was compiled with 851 * the **CONFIG_CGROUP_NET_CLASSID** configuration option set to 852 * "**y**" or to "**m**". 853 * Return 854 * The classid, or 0 for the default unconfigured classid. 855 * 856 * int bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci) 857 * Description 858 * Push a *vlan_tci* (VLAN tag control information) of protocol 859 * *vlan_proto* to the packet associated to *skb*, then update 860 * the checksum. Note that if *vlan_proto* is different from 861 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to 862 * be **ETH_P_8021Q**. 863 * 864 * A call to this helper is susceptible to change the underlying 865 * packet buffer. Therefore, at load time, all checks on pointers 866 * previously done by the verifier are invalidated and must be 867 * performed again, if the helper is used in combination with 868 * direct packet access. 869 * Return 870 * 0 on success, or a negative error in case of failure. 871 * 872 * int bpf_skb_vlan_pop(struct sk_buff *skb) 873 * Description 874 * Pop a VLAN header from the packet associated to *skb*. 875 * 876 * A call to this helper is susceptible to change the underlying 877 * packet buffer. Therefore, at load time, all checks on pointers 878 * previously done by the verifier are invalidated and must be 879 * performed again, if the helper is used in combination with 880 * direct packet access. 881 * Return 882 * 0 on success, or a negative error in case of failure. 883 * 884 * int bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags) 885 * Description 886 * Get tunnel metadata. This helper takes a pointer *key* to an 887 * empty **struct bpf_tunnel_key** of **size**, that will be 888 * filled with tunnel metadata for the packet associated to *skb*. 889 * The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which 890 * indicates that the tunnel is based on IPv6 protocol instead of 891 * IPv4. 892 * 893 * The **struct bpf_tunnel_key** is an object that generalizes the 894 * principal parameters used by various tunneling protocols into a 895 * single struct. This way, it can be used to easily make a 896 * decision based on the contents of the encapsulation header, 897 * "summarized" in this struct. In particular, it holds the IP 898 * address of the remote end (IPv4 or IPv6, depending on the case) 899 * in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also, 900 * this struct exposes the *key*\ **->tunnel_id**, which is 901 * generally mapped to a VNI (Virtual Network Identifier), making 902 * it programmable together with the **bpf_skb_set_tunnel_key**\ 903 * () helper. 904 * 905 * Let's imagine that the following code is part of a program 906 * attached to the TC ingress interface, on one end of a GRE 907 * tunnel, and is supposed to filter out all messages coming from 908 * remote ends with IPv4 address other than 10.0.0.1: 909 * 910 * :: 911 * 912 * int ret; 913 * struct bpf_tunnel_key key = {}; 914 * 915 * ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0); 916 * if (ret < 0) 917 * return TC_ACT_SHOT; // drop packet 918 * 919 * if (key.remote_ipv4 != 0x0a000001) 920 * return TC_ACT_SHOT; // drop packet 921 * 922 * return TC_ACT_OK; // accept packet 923 * 924 * This interface can also be used with all encapsulation devices 925 * that can operate in "collect metadata" mode: instead of having 926 * one network device per specific configuration, the "collect 927 * metadata" mode only requires a single device where the 928 * configuration can be extracted from this helper. 929 * 930 * This can be used together with various tunnels such as VXLan, 931 * Geneve, GRE or IP in IP (IPIP). 932 * Return 933 * 0 on success, or a negative error in case of failure. 934 * 935 * int bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags) 936 * Description 937 * Populate tunnel metadata for packet associated to *skb.* The 938 * tunnel metadata is set to the contents of *key*, of *size*. The 939 * *flags* can be set to a combination of the following values: 940 * 941 * **BPF_F_TUNINFO_IPV6** 942 * Indicate that the tunnel is based on IPv6 protocol 943 * instead of IPv4. 944 * **BPF_F_ZERO_CSUM_TX** 945 * For IPv4 packets, add a flag to tunnel metadata 946 * indicating that checksum computation should be skipped 947 * and checksum set to zeroes. 948 * **BPF_F_DONT_FRAGMENT** 949 * Add a flag to tunnel metadata indicating that the 950 * packet should not be fragmented. 951 * **BPF_F_SEQ_NUMBER** 952 * Add a flag to tunnel metadata indicating that a 953 * sequence number should be added to tunnel header before 954 * sending the packet. This flag was added for GRE 955 * encapsulation, but might be used with other protocols 956 * as well in the future. 957 * 958 * Here is a typical usage on the transmit path: 959 * 960 * :: 961 * 962 * struct bpf_tunnel_key key; 963 * populate key ... 964 * bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0); 965 * bpf_clone_redirect(skb, vxlan_dev_ifindex, 0); 966 * 967 * See also the description of the **bpf_skb_get_tunnel_key**\ () 968 * helper for additional information. 969 * Return 970 * 0 on success, or a negative error in case of failure. 971 * 972 * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags) 973 * Description 974 * Read the value of a perf event counter. This helper relies on a 975 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of 976 * the perf event counter is selected when *map* is updated with 977 * perf event file descriptors. The *map* is an array whose size 978 * is the number of available CPUs, and each cell contains a value 979 * relative to one CPU. The value to retrieve is indicated by 980 * *flags*, that contains the index of the CPU to look up, masked 981 * with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to 982 * **BPF_F_CURRENT_CPU** to indicate that the value for the 983 * current CPU should be retrieved. 984 * 985 * Note that before Linux 4.13, only hardware perf event can be 986 * retrieved. 987 * 988 * Also, be aware that the newer helper 989 * **bpf_perf_event_read_value**\ () is recommended over 990 * **bpf_perf_event_read**\ () in general. The latter has some ABI 991 * quirks where error and counter value are used as a return code 992 * (which is wrong to do since ranges may overlap). This issue is 993 * fixed with **bpf_perf_event_read_value**\ (), which at the same 994 * time provides more features over the **bpf_perf_event_read**\ 995 * () interface. Please refer to the description of 996 * **bpf_perf_event_read_value**\ () for details. 997 * Return 998 * The value of the perf event counter read from the map, or a 999 * negative error code in case of failure. 1000 * 1001 * int bpf_redirect(u32 ifindex, u64 flags) 1002 * Description 1003 * Redirect the packet to another net device of index *ifindex*. 1004 * This helper is somewhat similar to **bpf_clone_redirect**\ 1005 * (), except that the packet is not cloned, which provides 1006 * increased performance. 1007 * 1008 * Except for XDP, both ingress and egress interfaces can be used 1009 * for redirection. The **BPF_F_INGRESS** value in *flags* is used 1010 * to make the distinction (ingress path is selected if the flag 1011 * is present, egress path otherwise). Currently, XDP only 1012 * supports redirection to the egress interface, and accepts no 1013 * flag at all. 1014 * 1015 * The same effect can be attained with the more generic 1016 * **bpf_redirect_map**\ (), which requires specific maps to be 1017 * used but offers better performance. 1018 * Return 1019 * For XDP, the helper returns **XDP_REDIRECT** on success or 1020 * **XDP_ABORTED** on error. For other program types, the values 1021 * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on 1022 * error. 1023 * 1024 * u32 bpf_get_route_realm(struct sk_buff *skb) 1025 * Description 1026 * Retrieve the realm or the route, that is to say the 1027 * **tclassid** field of the destination for the *skb*. The 1028 * indentifier retrieved is a user-provided tag, similar to the 1029 * one used with the net_cls cgroup (see description for 1030 * **bpf_get_cgroup_classid**\ () helper), but here this tag is 1031 * held by a route (a destination entry), not by a task. 1032 * 1033 * Retrieving this identifier works with the clsact TC egress hook 1034 * (see also **tc-bpf(8)**), or alternatively on conventional 1035 * classful egress qdiscs, but not on TC ingress path. In case of 1036 * clsact TC egress hook, this has the advantage that, internally, 1037 * the destination entry has not been dropped yet in the transmit 1038 * path. Therefore, the destination entry does not need to be 1039 * artificially held via **netif_keep_dst**\ () for a classful 1040 * qdisc until the *skb* is freed. 1041 * 1042 * This helper is available only if the kernel was compiled with 1043 * **CONFIG_IP_ROUTE_CLASSID** configuration option. 1044 * Return 1045 * The realm of the route for the packet associated to *skb*, or 0 1046 * if none was found. 1047 * 1048 * int bpf_perf_event_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 1049 * Description 1050 * Write raw *data* blob into a special BPF perf event held by 1051 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 1052 * event must have the following attributes: **PERF_SAMPLE_RAW** 1053 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 1054 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 1055 * 1056 * The *flags* are used to indicate the index in *map* for which 1057 * the value must be put, masked with **BPF_F_INDEX_MASK**. 1058 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 1059 * to indicate that the index of the current CPU core should be 1060 * used. 1061 * 1062 * The value to write, of *size*, is passed through eBPF stack and 1063 * pointed by *data*. 1064 * 1065 * The context of the program *ctx* needs also be passed to the 1066 * helper. 1067 * 1068 * On user space, a program willing to read the values needs to 1069 * call **perf_event_open**\ () on the perf event (either for 1070 * one or for all CPUs) and to store the file descriptor into the 1071 * *map*. This must be done before the eBPF program can send data 1072 * into it. An example is available in file 1073 * *samples/bpf/trace_output_user.c* in the Linux kernel source 1074 * tree (the eBPF program counterpart is in 1075 * *samples/bpf/trace_output_kern.c*). 1076 * 1077 * **bpf_perf_event_output**\ () achieves better performance 1078 * than **bpf_trace_printk**\ () for sharing data with user 1079 * space, and is much better suitable for streaming data from eBPF 1080 * programs. 1081 * 1082 * Note that this helper is not restricted to tracing use cases 1083 * and can be used with programs attached to TC or XDP as well, 1084 * where it allows for passing data to user space listeners. Data 1085 * can be: 1086 * 1087 * * Only custom structs, 1088 * * Only the packet payload, or 1089 * * A combination of both. 1090 * Return 1091 * 0 on success, or a negative error in case of failure. 1092 * 1093 * int bpf_skb_load_bytes(const void *skb, u32 offset, void *to, u32 len) 1094 * Description 1095 * This helper was provided as an easy way to load data from a 1096 * packet. It can be used to load *len* bytes from *offset* from 1097 * the packet associated to *skb*, into the buffer pointed by 1098 * *to*. 1099 * 1100 * Since Linux 4.7, usage of this helper has mostly been replaced 1101 * by "direct packet access", enabling packet data to be 1102 * manipulated with *skb*\ **->data** and *skb*\ **->data_end** 1103 * pointing respectively to the first byte of packet data and to 1104 * the byte after the last byte of packet data. However, it 1105 * remains useful if one wishes to read large quantities of data 1106 * at once from a packet into the eBPF stack. 1107 * Return 1108 * 0 on success, or a negative error in case of failure. 1109 * 1110 * int bpf_get_stackid(void *ctx, struct bpf_map *map, u64 flags) 1111 * Description 1112 * Walk a user or a kernel stack and return its id. To achieve 1113 * this, the helper needs *ctx*, which is a pointer to the context 1114 * on which the tracing program is executed, and a pointer to a 1115 * *map* of type **BPF_MAP_TYPE_STACK_TRACE**. 1116 * 1117 * The last argument, *flags*, holds the number of stack frames to 1118 * skip (from 0 to 255), masked with 1119 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 1120 * a combination of the following flags: 1121 * 1122 * **BPF_F_USER_STACK** 1123 * Collect a user space stack instead of a kernel stack. 1124 * **BPF_F_FAST_STACK_CMP** 1125 * Compare stacks by hash only. 1126 * **BPF_F_REUSE_STACKID** 1127 * If two different stacks hash into the same *stackid*, 1128 * discard the old one. 1129 * 1130 * The stack id retrieved is a 32 bit long integer handle which 1131 * can be further combined with other data (including other stack 1132 * ids) and used as a key into maps. This can be useful for 1133 * generating a variety of graphs (such as flame graphs or off-cpu 1134 * graphs). 1135 * 1136 * For walking a stack, this helper is an improvement over 1137 * **bpf_probe_read**\ (), which can be used with unrolled loops 1138 * but is not efficient and consumes a lot of eBPF instructions. 1139 * Instead, **bpf_get_stackid**\ () can collect up to 1140 * **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that 1141 * this limit can be controlled with the **sysctl** program, and 1142 * that it should be manually increased in order to profile long 1143 * user stacks (such as stacks for Java programs). To do so, use: 1144 * 1145 * :: 1146 * 1147 * # sysctl kernel.perf_event_max_stack=<new value> 1148 * Return 1149 * The positive or null stack id on success, or a negative error 1150 * in case of failure. 1151 * 1152 * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed) 1153 * Description 1154 * Compute a checksum difference, from the raw buffer pointed by 1155 * *from*, of length *from_size* (that must be a multiple of 4), 1156 * towards the raw buffer pointed by *to*, of size *to_size* 1157 * (same remark). An optional *seed* can be added to the value 1158 * (this can be cascaded, the seed may come from a previous call 1159 * to the helper). 1160 * 1161 * This is flexible enough to be used in several ways: 1162 * 1163 * * With *from_size* == 0, *to_size* > 0 and *seed* set to 1164 * checksum, it can be used when pushing new data. 1165 * * With *from_size* > 0, *to_size* == 0 and *seed* set to 1166 * checksum, it can be used when removing data from a packet. 1167 * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it 1168 * can be used to compute a diff. Note that *from_size* and 1169 * *to_size* do not need to be equal. 1170 * 1171 * This helper can be used in combination with 1172 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to 1173 * which one can feed in the difference computed with 1174 * **bpf_csum_diff**\ (). 1175 * Return 1176 * The checksum result, or a negative error code in case of 1177 * failure. 1178 * 1179 * int bpf_skb_get_tunnel_opt(struct sk_buff *skb, void *opt, u32 size) 1180 * Description 1181 * Retrieve tunnel options metadata for the packet associated to 1182 * *skb*, and store the raw tunnel option data to the buffer *opt* 1183 * of *size*. 1184 * 1185 * This helper can be used with encapsulation devices that can 1186 * operate in "collect metadata" mode (please refer to the related 1187 * note in the description of **bpf_skb_get_tunnel_key**\ () for 1188 * more details). A particular example where this can be used is 1189 * in combination with the Geneve encapsulation protocol, where it 1190 * allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper) 1191 * and retrieving arbitrary TLVs (Type-Length-Value headers) from 1192 * the eBPF program. This allows for full customization of these 1193 * headers. 1194 * Return 1195 * The size of the option data retrieved. 1196 * 1197 * int bpf_skb_set_tunnel_opt(struct sk_buff *skb, void *opt, u32 size) 1198 * Description 1199 * Set tunnel options metadata for the packet associated to *skb* 1200 * to the option data contained in the raw buffer *opt* of *size*. 1201 * 1202 * See also the description of the **bpf_skb_get_tunnel_opt**\ () 1203 * helper for additional information. 1204 * Return 1205 * 0 on success, or a negative error in case of failure. 1206 * 1207 * int bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags) 1208 * Description 1209 * Change the protocol of the *skb* to *proto*. Currently 1210 * supported are transition from IPv4 to IPv6, and from IPv6 to 1211 * IPv4. The helper takes care of the groundwork for the 1212 * transition, including resizing the socket buffer. The eBPF 1213 * program is expected to fill the new headers, if any, via 1214 * **skb_store_bytes**\ () and to recompute the checksums with 1215 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ 1216 * (). The main case for this helper is to perform NAT64 1217 * operations out of an eBPF program. 1218 * 1219 * Internally, the GSO type is marked as dodgy so that headers are 1220 * checked and segments are recalculated by the GSO/GRO engine. 1221 * The size for GSO target is adapted as well. 1222 * 1223 * All values for *flags* are reserved for future usage, and must 1224 * be left at zero. 1225 * 1226 * A call to this helper is susceptible to change the underlying 1227 * packet buffer. Therefore, at load time, all checks on pointers 1228 * previously done by the verifier are invalidated and must be 1229 * performed again, if the helper is used in combination with 1230 * direct packet access. 1231 * Return 1232 * 0 on success, or a negative error in case of failure. 1233 * 1234 * int bpf_skb_change_type(struct sk_buff *skb, u32 type) 1235 * Description 1236 * Change the packet type for the packet associated to *skb*. This 1237 * comes down to setting *skb*\ **->pkt_type** to *type*, except 1238 * the eBPF program does not have a write access to *skb*\ 1239 * **->pkt_type** beside this helper. Using a helper here allows 1240 * for graceful handling of errors. 1241 * 1242 * The major use case is to change incoming *skb*s to 1243 * **PACKET_HOST** in a programmatic way instead of having to 1244 * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for 1245 * example. 1246 * 1247 * Note that *type* only allows certain values. At this time, they 1248 * are: 1249 * 1250 * **PACKET_HOST** 1251 * Packet is for us. 1252 * **PACKET_BROADCAST** 1253 * Send packet to all. 1254 * **PACKET_MULTICAST** 1255 * Send packet to group. 1256 * **PACKET_OTHERHOST** 1257 * Send packet to someone else. 1258 * Return 1259 * 0 on success, or a negative error in case of failure. 1260 * 1261 * int bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index) 1262 * Description 1263 * Check whether *skb* is a descendant of the cgroup2 held by 1264 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*. 1265 * Return 1266 * The return value depends on the result of the test, and can be: 1267 * 1268 * * 0, if the *skb* failed the cgroup2 descendant test. 1269 * * 1, if the *skb* succeeded the cgroup2 descendant test. 1270 * * A negative error code, if an error occurred. 1271 * 1272 * u32 bpf_get_hash_recalc(struct sk_buff *skb) 1273 * Description 1274 * Retrieve the hash of the packet, *skb*\ **->hash**. If it is 1275 * not set, in particular if the hash was cleared due to mangling, 1276 * recompute this hash. Later accesses to the hash can be done 1277 * directly with *skb*\ **->hash**. 1278 * 1279 * Calling **bpf_set_hash_invalid**\ (), changing a packet 1280 * prototype with **bpf_skb_change_proto**\ (), or calling 1281 * **bpf_skb_store_bytes**\ () with the 1282 * **BPF_F_INVALIDATE_HASH** are actions susceptible to clear 1283 * the hash and to trigger a new computation for the next call to 1284 * **bpf_get_hash_recalc**\ (). 1285 * Return 1286 * The 32-bit hash. 1287 * 1288 * u64 bpf_get_current_task(void) 1289 * Return 1290 * A pointer to the current task struct. 1291 * 1292 * int bpf_probe_write_user(void *dst, const void *src, u32 len) 1293 * Description 1294 * Attempt in a safe way to write *len* bytes from the buffer 1295 * *src* to *dst* in memory. It only works for threads that are in 1296 * user context, and *dst* must be a valid user space address. 1297 * 1298 * This helper should not be used to implement any kind of 1299 * security mechanism because of TOC-TOU attacks, but rather to 1300 * debug, divert, and manipulate execution of semi-cooperative 1301 * processes. 1302 * 1303 * Keep in mind that this feature is meant for experiments, and it 1304 * has a risk of crashing the system and running programs. 1305 * Therefore, when an eBPF program using this helper is attached, 1306 * a warning including PID and process name is printed to kernel 1307 * logs. 1308 * Return 1309 * 0 on success, or a negative error in case of failure. 1310 * 1311 * int bpf_current_task_under_cgroup(struct bpf_map *map, u32 index) 1312 * Description 1313 * Check whether the probe is being run is the context of a given 1314 * subset of the cgroup2 hierarchy. The cgroup2 to test is held by 1315 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*. 1316 * Return 1317 * The return value depends on the result of the test, and can be: 1318 * 1319 * * 0, if the *skb* task belongs to the cgroup2. 1320 * * 1, if the *skb* task does not belong to the cgroup2. 1321 * * A negative error code, if an error occurred. 1322 * 1323 * int bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags) 1324 * Description 1325 * Resize (trim or grow) the packet associated to *skb* to the 1326 * new *len*. The *flags* are reserved for future usage, and must 1327 * be left at zero. 1328 * 1329 * The basic idea is that the helper performs the needed work to 1330 * change the size of the packet, then the eBPF program rewrites 1331 * the rest via helpers like **bpf_skb_store_bytes**\ (), 1332 * **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ () 1333 * and others. This helper is a slow path utility intended for 1334 * replies with control messages. And because it is targeted for 1335 * slow path, the helper itself can afford to be slow: it 1336 * implicitly linearizes, unclones and drops offloads from the 1337 * *skb*. 1338 * 1339 * A call to this helper is susceptible to change the underlying 1340 * packet buffer. Therefore, at load time, all checks on pointers 1341 * previously done by the verifier are invalidated and must be 1342 * performed again, if the helper is used in combination with 1343 * direct packet access. 1344 * Return 1345 * 0 on success, or a negative error in case of failure. 1346 * 1347 * int bpf_skb_pull_data(struct sk_buff *skb, u32 len) 1348 * Description 1349 * Pull in non-linear data in case the *skb* is non-linear and not 1350 * all of *len* are part of the linear section. Make *len* bytes 1351 * from *skb* readable and writable. If a zero value is passed for 1352 * *len*, then the whole length of the *skb* is pulled. 1353 * 1354 * This helper is only needed for reading and writing with direct 1355 * packet access. 1356 * 1357 * For direct packet access, testing that offsets to access 1358 * are within packet boundaries (test on *skb*\ **->data_end**) is 1359 * susceptible to fail if offsets are invalid, or if the requested 1360 * data is in non-linear parts of the *skb*. On failure the 1361 * program can just bail out, or in the case of a non-linear 1362 * buffer, use a helper to make the data available. The 1363 * **bpf_skb_load_bytes**\ () helper is a first solution to access 1364 * the data. Another one consists in using **bpf_skb_pull_data** 1365 * to pull in once the non-linear parts, then retesting and 1366 * eventually access the data. 1367 * 1368 * At the same time, this also makes sure the *skb* is uncloned, 1369 * which is a necessary condition for direct write. As this needs 1370 * to be an invariant for the write part only, the verifier 1371 * detects writes and adds a prologue that is calling 1372 * **bpf_skb_pull_data()** to effectively unclone the *skb* from 1373 * the very beginning in case it is indeed cloned. 1374 * 1375 * A call to this helper is susceptible to change the underlying 1376 * packet buffer. Therefore, at load time, all checks on pointers 1377 * previously done by the verifier are invalidated and must be 1378 * performed again, if the helper is used in combination with 1379 * direct packet access. 1380 * Return 1381 * 0 on success, or a negative error in case of failure. 1382 * 1383 * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum) 1384 * Description 1385 * Add the checksum *csum* into *skb*\ **->csum** in case the 1386 * driver has supplied a checksum for the entire packet into that 1387 * field. Return an error otherwise. This helper is intended to be 1388 * used in combination with **bpf_csum_diff**\ (), in particular 1389 * when the checksum needs to be updated after data has been 1390 * written into the packet through direct packet access. 1391 * Return 1392 * The checksum on success, or a negative error code in case of 1393 * failure. 1394 * 1395 * void bpf_set_hash_invalid(struct sk_buff *skb) 1396 * Description 1397 * Invalidate the current *skb*\ **->hash**. It can be used after 1398 * mangling on headers through direct packet access, in order to 1399 * indicate that the hash is outdated and to trigger a 1400 * recalculation the next time the kernel tries to access this 1401 * hash or when the **bpf_get_hash_recalc**\ () helper is called. 1402 * 1403 * int bpf_get_numa_node_id(void) 1404 * Description 1405 * Return the id of the current NUMA node. The primary use case 1406 * for this helper is the selection of sockets for the local NUMA 1407 * node, when the program is attached to sockets using the 1408 * **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**), 1409 * but the helper is also available to other eBPF program types, 1410 * similarly to **bpf_get_smp_processor_id**\ (). 1411 * Return 1412 * The id of current NUMA node. 1413 * 1414 * int bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags) 1415 * Description 1416 * Grows headroom of packet associated to *skb* and adjusts the 1417 * offset of the MAC header accordingly, adding *len* bytes of 1418 * space. It automatically extends and reallocates memory as 1419 * required. 1420 * 1421 * This helper can be used on a layer 3 *skb* to push a MAC header 1422 * for redirection into a layer 2 device. 1423 * 1424 * All values for *flags* are reserved for future usage, and must 1425 * be left at zero. 1426 * 1427 * A call to this helper is susceptible to change the underlying 1428 * packet buffer. Therefore, at load time, all checks on pointers 1429 * previously done by the verifier are invalidated and must be 1430 * performed again, if the helper is used in combination with 1431 * direct packet access. 1432 * Return 1433 * 0 on success, or a negative error in case of failure. 1434 * 1435 * int bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta) 1436 * Description 1437 * Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that 1438 * it is possible to use a negative value for *delta*. This helper 1439 * can be used to prepare the packet for pushing or popping 1440 * headers. 1441 * 1442 * A call to this helper is susceptible to change the underlying 1443 * packet buffer. Therefore, at load time, all checks on pointers 1444 * previously done by the verifier are invalidated and must be 1445 * performed again, if the helper is used in combination with 1446 * direct packet access. 1447 * Return 1448 * 0 on success, or a negative error in case of failure. 1449 * 1450 * int bpf_probe_read_str(void *dst, u32 size, const void *unsafe_ptr) 1451 * Description 1452 * Copy a NUL terminated string from an unsafe kernel address 1453 * *unsafe_ptr* to *dst*. See bpf_probe_read_kernel_str() for 1454 * more details. 1455 * 1456 * Generally, use bpf_probe_read_user_str() or bpf_probe_read_kernel_str() 1457 * instead. 1458 * Return 1459 * On success, the strictly positive length of the string, 1460 * including the trailing NUL character. On error, a negative 1461 * value. 1462 * 1463 * u64 bpf_get_socket_cookie(struct sk_buff *skb) 1464 * Description 1465 * If the **struct sk_buff** pointed by *skb* has a known socket, 1466 * retrieve the cookie (generated by the kernel) of this socket. 1467 * If no cookie has been set yet, generate a new cookie. Once 1468 * generated, the socket cookie remains stable for the life of the 1469 * socket. This helper can be useful for monitoring per socket 1470 * networking traffic statistics as it provides a global socket 1471 * identifier that can be assumed unique. 1472 * Return 1473 * A 8-byte long non-decreasing number on success, or 0 if the 1474 * socket field is missing inside *skb*. 1475 * 1476 * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx) 1477 * Description 1478 * Equivalent to bpf_get_socket_cookie() helper that accepts 1479 * *skb*, but gets socket from **struct bpf_sock_addr** context. 1480 * Return 1481 * A 8-byte long non-decreasing number. 1482 * 1483 * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx) 1484 * Description 1485 * Equivalent to bpf_get_socket_cookie() helper that accepts 1486 * *skb*, but gets socket from **struct bpf_sock_ops** context. 1487 * Return 1488 * A 8-byte long non-decreasing number. 1489 * 1490 * u32 bpf_get_socket_uid(struct sk_buff *skb) 1491 * Return 1492 * The owner UID of the socket associated to *skb*. If the socket 1493 * is **NULL**, or if it is not a full socket (i.e. if it is a 1494 * time-wait or a request socket instead), **overflowuid** value 1495 * is returned (note that **overflowuid** might also be the actual 1496 * UID value for the socket). 1497 * 1498 * u32 bpf_set_hash(struct sk_buff *skb, u32 hash) 1499 * Description 1500 * Set the full hash for *skb* (set the field *skb*\ **->hash**) 1501 * to value *hash*. 1502 * Return 1503 * 0 1504 * 1505 * int bpf_setsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, void *optval, int optlen) 1506 * Description 1507 * Emulate a call to **setsockopt()** on the socket associated to 1508 * *bpf_socket*, which must be a full socket. The *level* at 1509 * which the option resides and the name *optname* of the option 1510 * must be specified, see **setsockopt(2)** for more information. 1511 * The option value of length *optlen* is pointed by *optval*. 1512 * 1513 * This helper actually implements a subset of **setsockopt()**. 1514 * It supports the following *level*\ s: 1515 * 1516 * * **SOL_SOCKET**, which supports the following *optname*\ s: 1517 * **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**, 1518 * **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**. 1519 * * **IPPROTO_TCP**, which supports the following *optname*\ s: 1520 * **TCP_CONGESTION**, **TCP_BPF_IW**, 1521 * **TCP_BPF_SNDCWND_CLAMP**. 1522 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**. 1523 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**. 1524 * Return 1525 * 0 on success, or a negative error in case of failure. 1526 * 1527 * int bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags) 1528 * Description 1529 * Grow or shrink the room for data in the packet associated to 1530 * *skb* by *len_diff*, and according to the selected *mode*. 1531 * 1532 * There are two supported modes at this time: 1533 * 1534 * * **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer 1535 * (room space is added or removed below the layer 2 header). 1536 * 1537 * * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer 1538 * (room space is added or removed below the layer 3 header). 1539 * 1540 * The following flags are supported at this time: 1541 * 1542 * * **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size. 1543 * Adjusting mss in this way is not allowed for datagrams. 1544 * 1545 * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4**, 1546 * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6**: 1547 * Any new space is reserved to hold a tunnel header. 1548 * Configure skb offsets and other fields accordingly. 1549 * 1550 * * **BPF_F_ADJ_ROOM_ENCAP_L4_GRE**, 1551 * **BPF_F_ADJ_ROOM_ENCAP_L4_UDP**: 1552 * Use with ENCAP_L3 flags to further specify the tunnel type. 1553 * 1554 * * **BPF_F_ADJ_ROOM_ENCAP_L2**\ (*len*): 1555 * Use with ENCAP_L3/L4 flags to further specify the tunnel 1556 * type; *len* is the length of the inner MAC header. 1557 * 1558 * A call to this helper is susceptible to change the underlying 1559 * packet buffer. Therefore, at load time, all checks on pointers 1560 * previously done by the verifier are invalidated and must be 1561 * performed again, if the helper is used in combination with 1562 * direct packet access. 1563 * Return 1564 * 0 on success, or a negative error in case of failure. 1565 * 1566 * int bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags) 1567 * Description 1568 * Redirect the packet to the endpoint referenced by *map* at 1569 * index *key*. Depending on its type, this *map* can contain 1570 * references to net devices (for forwarding packets through other 1571 * ports), or to CPUs (for redirecting XDP frames to another CPU; 1572 * but this is only implemented for native XDP (with driver 1573 * support) as of this writing). 1574 * 1575 * The lower two bits of *flags* are used as the return code if 1576 * the map lookup fails. This is so that the return value can be 1577 * one of the XDP program return codes up to XDP_TX, as chosen by 1578 * the caller. Any higher bits in the *flags* argument must be 1579 * unset. 1580 * 1581 * When used to redirect packets to net devices, this helper 1582 * provides a high performance increase over **bpf_redirect**\ (). 1583 * This is due to various implementation details of the underlying 1584 * mechanisms, one of which is the fact that **bpf_redirect_map**\ 1585 * () tries to send packet as a "bulk" to the device. 1586 * Return 1587 * **XDP_REDIRECT** on success, or **XDP_ABORTED** on error. 1588 * 1589 * int bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags) 1590 * Description 1591 * Redirect the packet to the socket referenced by *map* (of type 1592 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and 1593 * egress interfaces can be used for redirection. The 1594 * **BPF_F_INGRESS** value in *flags* is used to make the 1595 * distinction (ingress path is selected if the flag is present, 1596 * egress path otherwise). This is the only flag supported for now. 1597 * Return 1598 * **SK_PASS** on success, or **SK_DROP** on error. 1599 * 1600 * int bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags) 1601 * Description 1602 * Add an entry to, or update a *map* referencing sockets. The 1603 * *skops* is used as a new value for the entry associated to 1604 * *key*. *flags* is one of: 1605 * 1606 * **BPF_NOEXIST** 1607 * The entry for *key* must not exist in the map. 1608 * **BPF_EXIST** 1609 * The entry for *key* must already exist in the map. 1610 * **BPF_ANY** 1611 * No condition on the existence of the entry for *key*. 1612 * 1613 * If the *map* has eBPF programs (parser and verdict), those will 1614 * be inherited by the socket being added. If the socket is 1615 * already attached to eBPF programs, this results in an error. 1616 * Return 1617 * 0 on success, or a negative error in case of failure. 1618 * 1619 * int bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta) 1620 * Description 1621 * Adjust the address pointed by *xdp_md*\ **->data_meta** by 1622 * *delta* (which can be positive or negative). Note that this 1623 * operation modifies the address stored in *xdp_md*\ **->data**, 1624 * so the latter must be loaded only after the helper has been 1625 * called. 1626 * 1627 * The use of *xdp_md*\ **->data_meta** is optional and programs 1628 * are not required to use it. The rationale is that when the 1629 * packet is processed with XDP (e.g. as DoS filter), it is 1630 * possible to push further meta data along with it before passing 1631 * to the stack, and to give the guarantee that an ingress eBPF 1632 * program attached as a TC classifier on the same device can pick 1633 * this up for further post-processing. Since TC works with socket 1634 * buffers, it remains possible to set from XDP the **mark** or 1635 * **priority** pointers, or other pointers for the socket buffer. 1636 * Having this scratch space generic and programmable allows for 1637 * more flexibility as the user is free to store whatever meta 1638 * data they need. 1639 * 1640 * A call to this helper is susceptible to change the underlying 1641 * packet buffer. Therefore, at load time, all checks on pointers 1642 * previously done by the verifier are invalidated and must be 1643 * performed again, if the helper is used in combination with 1644 * direct packet access. 1645 * Return 1646 * 0 on success, or a negative error in case of failure. 1647 * 1648 * int bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size) 1649 * Description 1650 * Read the value of a perf event counter, and store it into *buf* 1651 * of size *buf_size*. This helper relies on a *map* of type 1652 * **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event 1653 * counter is selected when *map* is updated with perf event file 1654 * descriptors. The *map* is an array whose size is the number of 1655 * available CPUs, and each cell contains a value relative to one 1656 * CPU. The value to retrieve is indicated by *flags*, that 1657 * contains the index of the CPU to look up, masked with 1658 * **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to 1659 * **BPF_F_CURRENT_CPU** to indicate that the value for the 1660 * current CPU should be retrieved. 1661 * 1662 * This helper behaves in a way close to 1663 * **bpf_perf_event_read**\ () helper, save that instead of 1664 * just returning the value observed, it fills the *buf* 1665 * structure. This allows for additional data to be retrieved: in 1666 * particular, the enabled and running times (in *buf*\ 1667 * **->enabled** and *buf*\ **->running**, respectively) are 1668 * copied. In general, **bpf_perf_event_read_value**\ () is 1669 * recommended over **bpf_perf_event_read**\ (), which has some 1670 * ABI issues and provides fewer functionalities. 1671 * 1672 * These values are interesting, because hardware PMU (Performance 1673 * Monitoring Unit) counters are limited resources. When there are 1674 * more PMU based perf events opened than available counters, 1675 * kernel will multiplex these events so each event gets certain 1676 * percentage (but not all) of the PMU time. In case that 1677 * multiplexing happens, the number of samples or counter value 1678 * will not reflect the case compared to when no multiplexing 1679 * occurs. This makes comparison between different runs difficult. 1680 * Typically, the counter value should be normalized before 1681 * comparing to other experiments. The usual normalization is done 1682 * as follows. 1683 * 1684 * :: 1685 * 1686 * normalized_counter = counter * t_enabled / t_running 1687 * 1688 * Where t_enabled is the time enabled for event and t_running is 1689 * the time running for event since last normalization. The 1690 * enabled and running times are accumulated since the perf event 1691 * open. To achieve scaling factor between two invocations of an 1692 * eBPF program, users can can use CPU id as the key (which is 1693 * typical for perf array usage model) to remember the previous 1694 * value and do the calculation inside the eBPF program. 1695 * Return 1696 * 0 on success, or a negative error in case of failure. 1697 * 1698 * int bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size) 1699 * Description 1700 * For en eBPF program attached to a perf event, retrieve the 1701 * value of the event counter associated to *ctx* and store it in 1702 * the structure pointed by *buf* and of size *buf_size*. Enabled 1703 * and running times are also stored in the structure (see 1704 * description of helper **bpf_perf_event_read_value**\ () for 1705 * more details). 1706 * Return 1707 * 0 on success, or a negative error in case of failure. 1708 * 1709 * int bpf_getsockopt(struct bpf_sock_ops *bpf_socket, int level, int optname, void *optval, int optlen) 1710 * Description 1711 * Emulate a call to **getsockopt()** on the socket associated to 1712 * *bpf_socket*, which must be a full socket. The *level* at 1713 * which the option resides and the name *optname* of the option 1714 * must be specified, see **getsockopt(2)** for more information. 1715 * The retrieved value is stored in the structure pointed by 1716 * *opval* and of length *optlen*. 1717 * 1718 * This helper actually implements a subset of **getsockopt()**. 1719 * It supports the following *level*\ s: 1720 * 1721 * * **IPPROTO_TCP**, which supports *optname* 1722 * **TCP_CONGESTION**. 1723 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**. 1724 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**. 1725 * Return 1726 * 0 on success, or a negative error in case of failure. 1727 * 1728 * int bpf_override_return(struct pt_regs *regs, u64 rc) 1729 * Description 1730 * Used for error injection, this helper uses kprobes to override 1731 * the return value of the probed function, and to set it to *rc*. 1732 * The first argument is the context *regs* on which the kprobe 1733 * works. 1734 * 1735 * This helper works by setting setting the PC (program counter) 1736 * to an override function which is run in place of the original 1737 * probed function. This means the probed function is not run at 1738 * all. The replacement function just returns with the required 1739 * value. 1740 * 1741 * This helper has security implications, and thus is subject to 1742 * restrictions. It is only available if the kernel was compiled 1743 * with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration 1744 * option, and in this case it only works on functions tagged with 1745 * **ALLOW_ERROR_INJECTION** in the kernel code. 1746 * 1747 * Also, the helper is only available for the architectures having 1748 * the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing, 1749 * x86 architecture is the only one to support this feature. 1750 * Return 1751 * 0 1752 * 1753 * int bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval) 1754 * Description 1755 * Attempt to set the value of the **bpf_sock_ops_cb_flags** field 1756 * for the full TCP socket associated to *bpf_sock_ops* to 1757 * *argval*. 1758 * 1759 * The primary use of this field is to determine if there should 1760 * be calls to eBPF programs of type 1761 * **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP 1762 * code. A program of the same type can change its value, per 1763 * connection and as necessary, when the connection is 1764 * established. This field is directly accessible for reading, but 1765 * this helper must be used for updates in order to return an 1766 * error if an eBPF program tries to set a callback that is not 1767 * supported in the current kernel. 1768 * 1769 * *argval* is a flag array which can combine these flags: 1770 * 1771 * * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out) 1772 * * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission) 1773 * * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change) 1774 * * **BPF_SOCK_OPS_RTT_CB_FLAG** (every RTT) 1775 * 1776 * Therefore, this function can be used to clear a callback flag by 1777 * setting the appropriate bit to zero. e.g. to disable the RTO 1778 * callback: 1779 * 1780 * **bpf_sock_ops_cb_flags_set(bpf_sock,** 1781 * **bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)** 1782 * 1783 * Here are some examples of where one could call such eBPF 1784 * program: 1785 * 1786 * * When RTO fires. 1787 * * When a packet is retransmitted. 1788 * * When the connection terminates. 1789 * * When a packet is sent. 1790 * * When a packet is received. 1791 * Return 1792 * Code **-EINVAL** if the socket is not a full TCP socket; 1793 * otherwise, a positive number containing the bits that could not 1794 * be set is returned (which comes down to 0 if all bits were set 1795 * as required). 1796 * 1797 * int bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags) 1798 * Description 1799 * This helper is used in programs implementing policies at the 1800 * socket level. If the message *msg* is allowed to pass (i.e. if 1801 * the verdict eBPF program returns **SK_PASS**), redirect it to 1802 * the socket referenced by *map* (of type 1803 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and 1804 * egress interfaces can be used for redirection. The 1805 * **BPF_F_INGRESS** value in *flags* is used to make the 1806 * distinction (ingress path is selected if the flag is present, 1807 * egress path otherwise). This is the only flag supported for now. 1808 * Return 1809 * **SK_PASS** on success, or **SK_DROP** on error. 1810 * 1811 * int bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes) 1812 * Description 1813 * For socket policies, apply the verdict of the eBPF program to 1814 * the next *bytes* (number of bytes) of message *msg*. 1815 * 1816 * For example, this helper can be used in the following cases: 1817 * 1818 * * A single **sendmsg**\ () or **sendfile**\ () system call 1819 * contains multiple logical messages that the eBPF program is 1820 * supposed to read and for which it should apply a verdict. 1821 * * An eBPF program only cares to read the first *bytes* of a 1822 * *msg*. If the message has a large payload, then setting up 1823 * and calling the eBPF program repeatedly for all bytes, even 1824 * though the verdict is already known, would create unnecessary 1825 * overhead. 1826 * 1827 * When called from within an eBPF program, the helper sets a 1828 * counter internal to the BPF infrastructure, that is used to 1829 * apply the last verdict to the next *bytes*. If *bytes* is 1830 * smaller than the current data being processed from a 1831 * **sendmsg**\ () or **sendfile**\ () system call, the first 1832 * *bytes* will be sent and the eBPF program will be re-run with 1833 * the pointer for start of data pointing to byte number *bytes* 1834 * **+ 1**. If *bytes* is larger than the current data being 1835 * processed, then the eBPF verdict will be applied to multiple 1836 * **sendmsg**\ () or **sendfile**\ () calls until *bytes* are 1837 * consumed. 1838 * 1839 * Note that if a socket closes with the internal counter holding 1840 * a non-zero value, this is not a problem because data is not 1841 * being buffered for *bytes* and is sent as it is received. 1842 * Return 1843 * 0 1844 * 1845 * int bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes) 1846 * Description 1847 * For socket policies, prevent the execution of the verdict eBPF 1848 * program for message *msg* until *bytes* (byte number) have been 1849 * accumulated. 1850 * 1851 * This can be used when one needs a specific number of bytes 1852 * before a verdict can be assigned, even if the data spans 1853 * multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme 1854 * case would be a user calling **sendmsg**\ () repeatedly with 1855 * 1-byte long message segments. Obviously, this is bad for 1856 * performance, but it is still valid. If the eBPF program needs 1857 * *bytes* bytes to validate a header, this helper can be used to 1858 * prevent the eBPF program to be called again until *bytes* have 1859 * been accumulated. 1860 * Return 1861 * 0 1862 * 1863 * int bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags) 1864 * Description 1865 * For socket policies, pull in non-linear data from user space 1866 * for *msg* and set pointers *msg*\ **->data** and *msg*\ 1867 * **->data_end** to *start* and *end* bytes offsets into *msg*, 1868 * respectively. 1869 * 1870 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a 1871 * *msg* it can only parse data that the (**data**, **data_end**) 1872 * pointers have already consumed. For **sendmsg**\ () hooks this 1873 * is likely the first scatterlist element. But for calls relying 1874 * on the **sendpage** handler (e.g. **sendfile**\ ()) this will 1875 * be the range (**0**, **0**) because the data is shared with 1876 * user space and by default the objective is to avoid allowing 1877 * user space to modify data while (or after) eBPF verdict is 1878 * being decided. This helper can be used to pull in data and to 1879 * set the start and end pointer to given values. Data will be 1880 * copied if necessary (i.e. if data was not linear and if start 1881 * and end pointers do not point to the same chunk). 1882 * 1883 * A call to this helper is susceptible to change the underlying 1884 * packet buffer. Therefore, at load time, all checks on pointers 1885 * previously done by the verifier are invalidated and must be 1886 * performed again, if the helper is used in combination with 1887 * direct packet access. 1888 * 1889 * All values for *flags* are reserved for future usage, and must 1890 * be left at zero. 1891 * Return 1892 * 0 on success, or a negative error in case of failure. 1893 * 1894 * int bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len) 1895 * Description 1896 * Bind the socket associated to *ctx* to the address pointed by 1897 * *addr*, of length *addr_len*. This allows for making outgoing 1898 * connection from the desired IP address, which can be useful for 1899 * example when all processes inside a cgroup should use one 1900 * single IP address on a host that has multiple IP configured. 1901 * 1902 * This helper works for IPv4 and IPv6, TCP and UDP sockets. The 1903 * domain (*addr*\ **->sa_family**) must be **AF_INET** (or 1904 * **AF_INET6**). Looking for a free port to bind to can be 1905 * expensive, therefore binding to port is not permitted by the 1906 * helper: *addr*\ **->sin_port** (or **sin6_port**, respectively) 1907 * must be set to zero. 1908 * Return 1909 * 0 on success, or a negative error in case of failure. 1910 * 1911 * int bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta) 1912 * Description 1913 * Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is 1914 * only possible to shrink the packet as of this writing, 1915 * therefore *delta* must be a negative integer. 1916 * 1917 * A call to this helper is susceptible to change the underlying 1918 * packet buffer. Therefore, at load time, all checks on pointers 1919 * previously done by the verifier are invalidated and must be 1920 * performed again, if the helper is used in combination with 1921 * direct packet access. 1922 * Return 1923 * 0 on success, or a negative error in case of failure. 1924 * 1925 * int bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags) 1926 * Description 1927 * Retrieve the XFRM state (IP transform framework, see also 1928 * **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*. 1929 * 1930 * The retrieved value is stored in the **struct bpf_xfrm_state** 1931 * pointed by *xfrm_state* and of length *size*. 1932 * 1933 * All values for *flags* are reserved for future usage, and must 1934 * be left at zero. 1935 * 1936 * This helper is available only if the kernel was compiled with 1937 * **CONFIG_XFRM** configuration option. 1938 * Return 1939 * 0 on success, or a negative error in case of failure. 1940 * 1941 * int bpf_get_stack(void *ctx, void *buf, u32 size, u64 flags) 1942 * Description 1943 * Return a user or a kernel stack in bpf program provided buffer. 1944 * To achieve this, the helper needs *ctx*, which is a pointer 1945 * to the context on which the tracing program is executed. 1946 * To store the stacktrace, the bpf program provides *buf* with 1947 * a nonnegative *size*. 1948 * 1949 * The last argument, *flags*, holds the number of stack frames to 1950 * skip (from 0 to 255), masked with 1951 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set 1952 * the following flags: 1953 * 1954 * **BPF_F_USER_STACK** 1955 * Collect a user space stack instead of a kernel stack. 1956 * **BPF_F_USER_BUILD_ID** 1957 * Collect buildid+offset instead of ips for user stack, 1958 * only valid if **BPF_F_USER_STACK** is also specified. 1959 * 1960 * **bpf_get_stack**\ () can collect up to 1961 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject 1962 * to sufficient large buffer size. Note that 1963 * this limit can be controlled with the **sysctl** program, and 1964 * that it should be manually increased in order to profile long 1965 * user stacks (such as stacks for Java programs). To do so, use: 1966 * 1967 * :: 1968 * 1969 * # sysctl kernel.perf_event_max_stack=<new value> 1970 * Return 1971 * A non-negative value equal to or less than *size* on success, 1972 * or a negative error in case of failure. 1973 * 1974 * int bpf_skb_load_bytes_relative(const void *skb, u32 offset, void *to, u32 len, u32 start_header) 1975 * Description 1976 * This helper is similar to **bpf_skb_load_bytes**\ () in that 1977 * it provides an easy way to load *len* bytes from *offset* 1978 * from the packet associated to *skb*, into the buffer pointed 1979 * by *to*. The difference to **bpf_skb_load_bytes**\ () is that 1980 * a fifth argument *start_header* exists in order to select a 1981 * base offset to start from. *start_header* can be one of: 1982 * 1983 * **BPF_HDR_START_MAC** 1984 * Base offset to load data from is *skb*'s mac header. 1985 * **BPF_HDR_START_NET** 1986 * Base offset to load data from is *skb*'s network header. 1987 * 1988 * In general, "direct packet access" is the preferred method to 1989 * access packet data, however, this helper is in particular useful 1990 * in socket filters where *skb*\ **->data** does not always point 1991 * to the start of the mac header and where "direct packet access" 1992 * is not available. 1993 * Return 1994 * 0 on success, or a negative error in case of failure. 1995 * 1996 * int bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags) 1997 * Description 1998 * Do FIB lookup in kernel tables using parameters in *params*. 1999 * If lookup is successful and result shows packet is to be 2000 * forwarded, the neighbor tables are searched for the nexthop. 2001 * If successful (ie., FIB lookup shows forwarding and nexthop 2002 * is resolved), the nexthop address is returned in ipv4_dst 2003 * or ipv6_dst based on family, smac is set to mac address of 2004 * egress device, dmac is set to nexthop mac address, rt_metric 2005 * is set to metric from route (IPv4/IPv6 only), and ifindex 2006 * is set to the device index of the nexthop from the FIB lookup. 2007 * 2008 * *plen* argument is the size of the passed in struct. 2009 * *flags* argument can be a combination of one or more of the 2010 * following values: 2011 * 2012 * **BPF_FIB_LOOKUP_DIRECT** 2013 * Do a direct table lookup vs full lookup using FIB 2014 * rules. 2015 * **BPF_FIB_LOOKUP_OUTPUT** 2016 * Perform lookup from an egress perspective (default is 2017 * ingress). 2018 * 2019 * *ctx* is either **struct xdp_md** for XDP programs or 2020 * **struct sk_buff** tc cls_act programs. 2021 * Return 2022 * * < 0 if any input argument is invalid 2023 * * 0 on success (packet is forwarded, nexthop neighbor exists) 2024 * * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the 2025 * packet is not forwarded or needs assist from full stack 2026 * 2027 * int bpf_sock_hash_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags) 2028 * Description 2029 * Add an entry to, or update a sockhash *map* referencing sockets. 2030 * The *skops* is used as a new value for the entry associated to 2031 * *key*. *flags* is one of: 2032 * 2033 * **BPF_NOEXIST** 2034 * The entry for *key* must not exist in the map. 2035 * **BPF_EXIST** 2036 * The entry for *key* must already exist in the map. 2037 * **BPF_ANY** 2038 * No condition on the existence of the entry for *key*. 2039 * 2040 * If the *map* has eBPF programs (parser and verdict), those will 2041 * be inherited by the socket being added. If the socket is 2042 * already attached to eBPF programs, this results in an error. 2043 * Return 2044 * 0 on success, or a negative error in case of failure. 2045 * 2046 * int bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags) 2047 * Description 2048 * This helper is used in programs implementing policies at the 2049 * socket level. If the message *msg* is allowed to pass (i.e. if 2050 * the verdict eBPF program returns **SK_PASS**), redirect it to 2051 * the socket referenced by *map* (of type 2052 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and 2053 * egress interfaces can be used for redirection. The 2054 * **BPF_F_INGRESS** value in *flags* is used to make the 2055 * distinction (ingress path is selected if the flag is present, 2056 * egress path otherwise). This is the only flag supported for now. 2057 * Return 2058 * **SK_PASS** on success, or **SK_DROP** on error. 2059 * 2060 * int bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags) 2061 * Description 2062 * This helper is used in programs implementing policies at the 2063 * skb socket level. If the sk_buff *skb* is allowed to pass (i.e. 2064 * if the verdeict eBPF program returns **SK_PASS**), redirect it 2065 * to the socket referenced by *map* (of type 2066 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and 2067 * egress interfaces can be used for redirection. The 2068 * **BPF_F_INGRESS** value in *flags* is used to make the 2069 * distinction (ingress path is selected if the flag is present, 2070 * egress otherwise). This is the only flag supported for now. 2071 * Return 2072 * **SK_PASS** on success, or **SK_DROP** on error. 2073 * 2074 * int bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len) 2075 * Description 2076 * Encapsulate the packet associated to *skb* within a Layer 3 2077 * protocol header. This header is provided in the buffer at 2078 * address *hdr*, with *len* its size in bytes. *type* indicates 2079 * the protocol of the header and can be one of: 2080 * 2081 * **BPF_LWT_ENCAP_SEG6** 2082 * IPv6 encapsulation with Segment Routing Header 2083 * (**struct ipv6_sr_hdr**). *hdr* only contains the SRH, 2084 * the IPv6 header is computed by the kernel. 2085 * **BPF_LWT_ENCAP_SEG6_INLINE** 2086 * Only works if *skb* contains an IPv6 packet. Insert a 2087 * Segment Routing Header (**struct ipv6_sr_hdr**) inside 2088 * the IPv6 header. 2089 * **BPF_LWT_ENCAP_IP** 2090 * IP encapsulation (GRE/GUE/IPIP/etc). The outer header 2091 * must be IPv4 or IPv6, followed by zero or more 2092 * additional headers, up to **LWT_BPF_MAX_HEADROOM** 2093 * total bytes in all prepended headers. Please note that 2094 * if **skb_is_gso**\ (*skb*) is true, no more than two 2095 * headers can be prepended, and the inner header, if 2096 * present, should be either GRE or UDP/GUE. 2097 * 2098 * **BPF_LWT_ENCAP_SEG6**\ \* types can be called by BPF programs 2099 * of type **BPF_PROG_TYPE_LWT_IN**; **BPF_LWT_ENCAP_IP** type can 2100 * be called by bpf programs of types **BPF_PROG_TYPE_LWT_IN** and 2101 * **BPF_PROG_TYPE_LWT_XMIT**. 2102 * 2103 * A call to this helper is susceptible to change the underlying 2104 * packet buffer. Therefore, at load time, all checks on pointers 2105 * previously done by the verifier are invalidated and must be 2106 * performed again, if the helper is used in combination with 2107 * direct packet access. 2108 * Return 2109 * 0 on success, or a negative error in case of failure. 2110 * 2111 * int bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len) 2112 * Description 2113 * Store *len* bytes from address *from* into the packet 2114 * associated to *skb*, at *offset*. Only the flags, tag and TLVs 2115 * inside the outermost IPv6 Segment Routing Header can be 2116 * modified through this helper. 2117 * 2118 * A call to this helper is susceptible to change the underlying 2119 * packet buffer. Therefore, at load time, all checks on pointers 2120 * previously done by the verifier are invalidated and must be 2121 * performed again, if the helper is used in combination with 2122 * direct packet access. 2123 * Return 2124 * 0 on success, or a negative error in case of failure. 2125 * 2126 * int bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta) 2127 * Description 2128 * Adjust the size allocated to TLVs in the outermost IPv6 2129 * Segment Routing Header contained in the packet associated to 2130 * *skb*, at position *offset* by *delta* bytes. Only offsets 2131 * after the segments are accepted. *delta* can be as well 2132 * positive (growing) as negative (shrinking). 2133 * 2134 * A call to this helper is susceptible to change the underlying 2135 * packet buffer. Therefore, at load time, all checks on pointers 2136 * previously done by the verifier are invalidated and must be 2137 * performed again, if the helper is used in combination with 2138 * direct packet access. 2139 * Return 2140 * 0 on success, or a negative error in case of failure. 2141 * 2142 * int bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len) 2143 * Description 2144 * Apply an IPv6 Segment Routing action of type *action* to the 2145 * packet associated to *skb*. Each action takes a parameter 2146 * contained at address *param*, and of length *param_len* bytes. 2147 * *action* can be one of: 2148 * 2149 * **SEG6_LOCAL_ACTION_END_X** 2150 * End.X action: Endpoint with Layer-3 cross-connect. 2151 * Type of *param*: **struct in6_addr**. 2152 * **SEG6_LOCAL_ACTION_END_T** 2153 * End.T action: Endpoint with specific IPv6 table lookup. 2154 * Type of *param*: **int**. 2155 * **SEG6_LOCAL_ACTION_END_B6** 2156 * End.B6 action: Endpoint bound to an SRv6 policy. 2157 * Type of *param*: **struct ipv6_sr_hdr**. 2158 * **SEG6_LOCAL_ACTION_END_B6_ENCAP** 2159 * End.B6.Encap action: Endpoint bound to an SRv6 2160 * encapsulation policy. 2161 * Type of *param*: **struct ipv6_sr_hdr**. 2162 * 2163 * A call to this helper is susceptible to change the underlying 2164 * packet buffer. Therefore, at load time, all checks on pointers 2165 * previously done by the verifier are invalidated and must be 2166 * performed again, if the helper is used in combination with 2167 * direct packet access. 2168 * Return 2169 * 0 on success, or a negative error in case of failure. 2170 * 2171 * int bpf_rc_repeat(void *ctx) 2172 * Description 2173 * This helper is used in programs implementing IR decoding, to 2174 * report a successfully decoded repeat key message. This delays 2175 * the generation of a key up event for previously generated 2176 * key down event. 2177 * 2178 * Some IR protocols like NEC have a special IR message for 2179 * repeating last button, for when a button is held down. 2180 * 2181 * The *ctx* should point to the lirc sample as passed into 2182 * the program. 2183 * 2184 * This helper is only available is the kernel was compiled with 2185 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 2186 * "**y**". 2187 * Return 2188 * 0 2189 * 2190 * int bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle) 2191 * Description 2192 * This helper is used in programs implementing IR decoding, to 2193 * report a successfully decoded key press with *scancode*, 2194 * *toggle* value in the given *protocol*. The scancode will be 2195 * translated to a keycode using the rc keymap, and reported as 2196 * an input key down event. After a period a key up event is 2197 * generated. This period can be extended by calling either 2198 * **bpf_rc_keydown**\ () again with the same values, or calling 2199 * **bpf_rc_repeat**\ (). 2200 * 2201 * Some protocols include a toggle bit, in case the button was 2202 * released and pressed again between consecutive scancodes. 2203 * 2204 * The *ctx* should point to the lirc sample as passed into 2205 * the program. 2206 * 2207 * The *protocol* is the decoded protocol number (see 2208 * **enum rc_proto** for some predefined values). 2209 * 2210 * This helper is only available is the kernel was compiled with 2211 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 2212 * "**y**". 2213 * Return 2214 * 0 2215 * 2216 * u64 bpf_skb_cgroup_id(struct sk_buff *skb) 2217 * Description 2218 * Return the cgroup v2 id of the socket associated with the *skb*. 2219 * This is roughly similar to the **bpf_get_cgroup_classid**\ () 2220 * helper for cgroup v1 by providing a tag resp. identifier that 2221 * can be matched on or used for map lookups e.g. to implement 2222 * policy. The cgroup v2 id of a given path in the hierarchy is 2223 * exposed in user space through the f_handle API in order to get 2224 * to the same 64-bit id. 2225 * 2226 * This helper can be used on TC egress path, but not on ingress, 2227 * and is available only if the kernel was compiled with the 2228 * **CONFIG_SOCK_CGROUP_DATA** configuration option. 2229 * Return 2230 * The id is returned or 0 in case the id could not be retrieved. 2231 * 2232 * u64 bpf_get_current_cgroup_id(void) 2233 * Return 2234 * A 64-bit integer containing the current cgroup id based 2235 * on the cgroup within which the current task is running. 2236 * 2237 * void *bpf_get_local_storage(void *map, u64 flags) 2238 * Description 2239 * Get the pointer to the local storage area. 2240 * The type and the size of the local storage is defined 2241 * by the *map* argument. 2242 * The *flags* meaning is specific for each map type, 2243 * and has to be 0 for cgroup local storage. 2244 * 2245 * Depending on the BPF program type, a local storage area 2246 * can be shared between multiple instances of the BPF program, 2247 * running simultaneously. 2248 * 2249 * A user should care about the synchronization by himself. 2250 * For example, by using the **BPF_STX_XADD** instruction to alter 2251 * the shared data. 2252 * Return 2253 * A pointer to the local storage area. 2254 * 2255 * int bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags) 2256 * Description 2257 * Select a **SO_REUSEPORT** socket from a 2258 * **BPF_MAP_TYPE_REUSEPORT_ARRAY** *map*. 2259 * It checks the selected socket is matching the incoming 2260 * request in the socket buffer. 2261 * Return 2262 * 0 on success, or a negative error in case of failure. 2263 * 2264 * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level) 2265 * Description 2266 * Return id of cgroup v2 that is ancestor of cgroup associated 2267 * with the *skb* at the *ancestor_level*. The root cgroup is at 2268 * *ancestor_level* zero and each step down the hierarchy 2269 * increments the level. If *ancestor_level* == level of cgroup 2270 * associated with *skb*, then return value will be same as that 2271 * of **bpf_skb_cgroup_id**\ (). 2272 * 2273 * The helper is useful to implement policies based on cgroups 2274 * that are upper in hierarchy than immediate cgroup associated 2275 * with *skb*. 2276 * 2277 * The format of returned id and helper limitations are same as in 2278 * **bpf_skb_cgroup_id**\ (). 2279 * Return 2280 * The id is returned or 0 in case the id could not be retrieved. 2281 * 2282 * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 2283 * Description 2284 * Look for TCP socket matching *tuple*, optionally in a child 2285 * network namespace *netns*. The return value must be checked, 2286 * and if non-**NULL**, released via **bpf_sk_release**\ (). 2287 * 2288 * The *ctx* should point to the context of the program, such as 2289 * the skb or socket (depending on the hook in use). This is used 2290 * to determine the base network namespace for the lookup. 2291 * 2292 * *tuple_size* must be one of: 2293 * 2294 * **sizeof**\ (*tuple*\ **->ipv4**) 2295 * Look for an IPv4 socket. 2296 * **sizeof**\ (*tuple*\ **->ipv6**) 2297 * Look for an IPv6 socket. 2298 * 2299 * If the *netns* is a negative signed 32-bit integer, then the 2300 * socket lookup table in the netns associated with the *ctx* will 2301 * will be used. For the TC hooks, this is the netns of the device 2302 * in the skb. For socket hooks, this is the netns of the socket. 2303 * If *netns* is any other signed 32-bit value greater than or 2304 * equal to zero then it specifies the ID of the netns relative to 2305 * the netns associated with the *ctx*. *netns* values beyond the 2306 * range of 32-bit integers are reserved for future use. 2307 * 2308 * All values for *flags* are reserved for future usage, and must 2309 * be left at zero. 2310 * 2311 * This helper is available only if the kernel was compiled with 2312 * **CONFIG_NET** configuration option. 2313 * Return 2314 * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 2315 * For sockets with reuseport option, the **struct bpf_sock** 2316 * result is from *reuse*\ **->socks**\ [] using the hash of the 2317 * tuple. 2318 * 2319 * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 2320 * Description 2321 * Look for UDP socket matching *tuple*, optionally in a child 2322 * network namespace *netns*. The return value must be checked, 2323 * and if non-**NULL**, released via **bpf_sk_release**\ (). 2324 * 2325 * The *ctx* should point to the context of the program, such as 2326 * the skb or socket (depending on the hook in use). This is used 2327 * to determine the base network namespace for the lookup. 2328 * 2329 * *tuple_size* must be one of: 2330 * 2331 * **sizeof**\ (*tuple*\ **->ipv4**) 2332 * Look for an IPv4 socket. 2333 * **sizeof**\ (*tuple*\ **->ipv6**) 2334 * Look for an IPv6 socket. 2335 * 2336 * If the *netns* is a negative signed 32-bit integer, then the 2337 * socket lookup table in the netns associated with the *ctx* will 2338 * will be used. For the TC hooks, this is the netns of the device 2339 * in the skb. For socket hooks, this is the netns of the socket. 2340 * If *netns* is any other signed 32-bit value greater than or 2341 * equal to zero then it specifies the ID of the netns relative to 2342 * the netns associated with the *ctx*. *netns* values beyond the 2343 * range of 32-bit integers are reserved for future use. 2344 * 2345 * All values for *flags* are reserved for future usage, and must 2346 * be left at zero. 2347 * 2348 * This helper is available only if the kernel was compiled with 2349 * **CONFIG_NET** configuration option. 2350 * Return 2351 * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 2352 * For sockets with reuseport option, the **struct bpf_sock** 2353 * result is from *reuse*\ **->socks**\ [] using the hash of the 2354 * tuple. 2355 * 2356 * int bpf_sk_release(struct bpf_sock *sock) 2357 * Description 2358 * Release the reference held by *sock*. *sock* must be a 2359 * non-**NULL** pointer that was returned from 2360 * **bpf_sk_lookup_xxx**\ (). 2361 * Return 2362 * 0 on success, or a negative error in case of failure. 2363 * 2364 * int bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags) 2365 * Description 2366 * Push an element *value* in *map*. *flags* is one of: 2367 * 2368 * **BPF_EXIST** 2369 * If the queue/stack is full, the oldest element is 2370 * removed to make room for this. 2371 * Return 2372 * 0 on success, or a negative error in case of failure. 2373 * 2374 * int bpf_map_pop_elem(struct bpf_map *map, void *value) 2375 * Description 2376 * Pop an element from *map*. 2377 * Return 2378 * 0 on success, or a negative error in case of failure. 2379 * 2380 * int bpf_map_peek_elem(struct bpf_map *map, void *value) 2381 * Description 2382 * Get an element from *map* without removing it. 2383 * Return 2384 * 0 on success, or a negative error in case of failure. 2385 * 2386 * int bpf_msg_push_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags) 2387 * Description 2388 * For socket policies, insert *len* bytes into *msg* at offset 2389 * *start*. 2390 * 2391 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a 2392 * *msg* it may want to insert metadata or options into the *msg*. 2393 * This can later be read and used by any of the lower layer BPF 2394 * hooks. 2395 * 2396 * This helper may fail if under memory pressure (a malloc 2397 * fails) in these cases BPF programs will get an appropriate 2398 * error and BPF programs will need to handle them. 2399 * Return 2400 * 0 on success, or a negative error in case of failure. 2401 * 2402 * int bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags) 2403 * Description 2404 * Will remove *len* bytes from a *msg* starting at byte *start*. 2405 * This may result in **ENOMEM** errors under certain situations if 2406 * an allocation and copy are required due to a full ring buffer. 2407 * However, the helper will try to avoid doing the allocation 2408 * if possible. Other errors can occur if input parameters are 2409 * invalid either due to *start* byte not being valid part of *msg* 2410 * payload and/or *pop* value being to large. 2411 * Return 2412 * 0 on success, or a negative error in case of failure. 2413 * 2414 * int bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y) 2415 * Description 2416 * This helper is used in programs implementing IR decoding, to 2417 * report a successfully decoded pointer movement. 2418 * 2419 * The *ctx* should point to the lirc sample as passed into 2420 * the program. 2421 * 2422 * This helper is only available is the kernel was compiled with 2423 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to 2424 * "**y**". 2425 * Return 2426 * 0 2427 * 2428 * int bpf_spin_lock(struct bpf_spin_lock *lock) 2429 * Description 2430 * Acquire a spinlock represented by the pointer *lock*, which is 2431 * stored as part of a value of a map. Taking the lock allows to 2432 * safely update the rest of the fields in that value. The 2433 * spinlock can (and must) later be released with a call to 2434 * **bpf_spin_unlock**\ (\ *lock*\ ). 2435 * 2436 * Spinlocks in BPF programs come with a number of restrictions 2437 * and constraints: 2438 * 2439 * * **bpf_spin_lock** objects are only allowed inside maps of 2440 * types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this 2441 * list could be extended in the future). 2442 * * BTF description of the map is mandatory. 2443 * * The BPF program can take ONE lock at a time, since taking two 2444 * or more could cause dead locks. 2445 * * Only one **struct bpf_spin_lock** is allowed per map element. 2446 * * When the lock is taken, calls (either BPF to BPF or helpers) 2447 * are not allowed. 2448 * * The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not 2449 * allowed inside a spinlock-ed region. 2450 * * The BPF program MUST call **bpf_spin_unlock**\ () to release 2451 * the lock, on all execution paths, before it returns. 2452 * * The BPF program can access **struct bpf_spin_lock** only via 2453 * the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ () 2454 * helpers. Loading or storing data into the **struct 2455 * bpf_spin_lock** *lock*\ **;** field of a map is not allowed. 2456 * * To use the **bpf_spin_lock**\ () helper, the BTF description 2457 * of the map value must be a struct and have **struct 2458 * bpf_spin_lock** *anyname*\ **;** field at the top level. 2459 * Nested lock inside another struct is not allowed. 2460 * * The **struct bpf_spin_lock** *lock* field in a map value must 2461 * be aligned on a multiple of 4 bytes in that value. 2462 * * Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy 2463 * the **bpf_spin_lock** field to user space. 2464 * * Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from 2465 * a BPF program, do not update the **bpf_spin_lock** field. 2466 * * **bpf_spin_lock** cannot be on the stack or inside a 2467 * networking packet (it can only be inside of a map values). 2468 * * **bpf_spin_lock** is available to root only. 2469 * * Tracing programs and socket filter programs cannot use 2470 * **bpf_spin_lock**\ () due to insufficient preemption checks 2471 * (but this may change in the future). 2472 * * **bpf_spin_lock** is not allowed in inner maps of map-in-map. 2473 * Return 2474 * 0 2475 * 2476 * int bpf_spin_unlock(struct bpf_spin_lock *lock) 2477 * Description 2478 * Release the *lock* previously locked by a call to 2479 * **bpf_spin_lock**\ (\ *lock*\ ). 2480 * Return 2481 * 0 2482 * 2483 * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk) 2484 * Description 2485 * This helper gets a **struct bpf_sock** pointer such 2486 * that all the fields in this **bpf_sock** can be accessed. 2487 * Return 2488 * A **struct bpf_sock** pointer on success, or **NULL** in 2489 * case of failure. 2490 * 2491 * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk) 2492 * Description 2493 * This helper gets a **struct bpf_tcp_sock** pointer from a 2494 * **struct bpf_sock** pointer. 2495 * Return 2496 * A **struct bpf_tcp_sock** pointer on success, or **NULL** in 2497 * case of failure. 2498 * 2499 * int bpf_skb_ecn_set_ce(struct sk_buff *skb) 2500 * Description 2501 * Set ECN (Explicit Congestion Notification) field of IP header 2502 * to **CE** (Congestion Encountered) if current value is **ECT** 2503 * (ECN Capable Transport). Otherwise, do nothing. Works with IPv6 2504 * and IPv4. 2505 * Return 2506 * 1 if the **CE** flag is set (either by the current helper call 2507 * or because it was already present), 0 if it is not set. 2508 * 2509 * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk) 2510 * Description 2511 * Return a **struct bpf_sock** pointer in **TCP_LISTEN** state. 2512 * **bpf_sk_release**\ () is unnecessary and not allowed. 2513 * Return 2514 * A **struct bpf_sock** pointer on success, or **NULL** in 2515 * case of failure. 2516 * 2517 * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags) 2518 * Description 2519 * Look for TCP socket matching *tuple*, optionally in a child 2520 * network namespace *netns*. The return value must be checked, 2521 * and if non-**NULL**, released via **bpf_sk_release**\ (). 2522 * 2523 * This function is identical to **bpf_sk_lookup_tcp**\ (), except 2524 * that it also returns timewait or request sockets. Use 2525 * **bpf_sk_fullsock**\ () or **bpf_tcp_sock**\ () to access the 2526 * full structure. 2527 * 2528 * This helper is available only if the kernel was compiled with 2529 * **CONFIG_NET** configuration option. 2530 * Return 2531 * Pointer to **struct bpf_sock**, or **NULL** in case of failure. 2532 * For sockets with reuseport option, the **struct bpf_sock** 2533 * result is from *reuse*\ **->socks**\ [] using the hash of the 2534 * tuple. 2535 * 2536 * int bpf_tcp_check_syncookie(struct bpf_sock *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len) 2537 * Description 2538 * Check whether *iph* and *th* contain a valid SYN cookie ACK for 2539 * the listening socket in *sk*. 2540 * 2541 * *iph* points to the start of the IPv4 or IPv6 header, while 2542 * *iph_len* contains **sizeof**\ (**struct iphdr**) or 2543 * **sizeof**\ (**struct ip6hdr**). 2544 * 2545 * *th* points to the start of the TCP header, while *th_len* 2546 * contains **sizeof**\ (**struct tcphdr**). 2547 * 2548 * Return 2549 * 0 if *iph* and *th* are a valid SYN cookie ACK, or a negative 2550 * error otherwise. 2551 * 2552 * int bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags) 2553 * Description 2554 * Get name of sysctl in /proc/sys/ and copy it into provided by 2555 * program buffer *buf* of size *buf_len*. 2556 * 2557 * The buffer is always NUL terminated, unless it's zero-sized. 2558 * 2559 * If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is 2560 * copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name 2561 * only (e.g. "tcp_mem"). 2562 * Return 2563 * Number of character copied (not including the trailing NUL). 2564 * 2565 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 2566 * truncated name in this case). 2567 * 2568 * int bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len) 2569 * Description 2570 * Get current value of sysctl as it is presented in /proc/sys 2571 * (incl. newline, etc), and copy it as a string into provided 2572 * by program buffer *buf* of size *buf_len*. 2573 * 2574 * The whole value is copied, no matter what file position user 2575 * space issued e.g. sys_read at. 2576 * 2577 * The buffer is always NUL terminated, unless it's zero-sized. 2578 * Return 2579 * Number of character copied (not including the trailing NUL). 2580 * 2581 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 2582 * truncated name in this case). 2583 * 2584 * **-EINVAL** if current value was unavailable, e.g. because 2585 * sysctl is uninitialized and read returns -EIO for it. 2586 * 2587 * int bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len) 2588 * Description 2589 * Get new value being written by user space to sysctl (before 2590 * the actual write happens) and copy it as a string into 2591 * provided by program buffer *buf* of size *buf_len*. 2592 * 2593 * User space may write new value at file position > 0. 2594 * 2595 * The buffer is always NUL terminated, unless it's zero-sized. 2596 * Return 2597 * Number of character copied (not including the trailing NUL). 2598 * 2599 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain 2600 * truncated name in this case). 2601 * 2602 * **-EINVAL** if sysctl is being read. 2603 * 2604 * int bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len) 2605 * Description 2606 * Override new value being written by user space to sysctl with 2607 * value provided by program in buffer *buf* of size *buf_len*. 2608 * 2609 * *buf* should contain a string in same form as provided by user 2610 * space on sysctl write. 2611 * 2612 * User space may write new value at file position > 0. To override 2613 * the whole sysctl value file position should be set to zero. 2614 * Return 2615 * 0 on success. 2616 * 2617 * **-E2BIG** if the *buf_len* is too big. 2618 * 2619 * **-EINVAL** if sysctl is being read. 2620 * 2621 * int bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res) 2622 * Description 2623 * Convert the initial part of the string from buffer *buf* of 2624 * size *buf_len* to a long integer according to the given base 2625 * and save the result in *res*. 2626 * 2627 * The string may begin with an arbitrary amount of white space 2628 * (as determined by **isspace**\ (3)) followed by a single 2629 * optional '**-**' sign. 2630 * 2631 * Five least significant bits of *flags* encode base, other bits 2632 * are currently unused. 2633 * 2634 * Base must be either 8, 10, 16 or 0 to detect it automatically 2635 * similar to user space **strtol**\ (3). 2636 * Return 2637 * Number of characters consumed on success. Must be positive but 2638 * no more than *buf_len*. 2639 * 2640 * **-EINVAL** if no valid digits were found or unsupported base 2641 * was provided. 2642 * 2643 * **-ERANGE** if resulting value was out of range. 2644 * 2645 * int bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res) 2646 * Description 2647 * Convert the initial part of the string from buffer *buf* of 2648 * size *buf_len* to an unsigned long integer according to the 2649 * given base and save the result in *res*. 2650 * 2651 * The string may begin with an arbitrary amount of white space 2652 * (as determined by **isspace**\ (3)). 2653 * 2654 * Five least significant bits of *flags* encode base, other bits 2655 * are currently unused. 2656 * 2657 * Base must be either 8, 10, 16 or 0 to detect it automatically 2658 * similar to user space **strtoul**\ (3). 2659 * Return 2660 * Number of characters consumed on success. Must be positive but 2661 * no more than *buf_len*. 2662 * 2663 * **-EINVAL** if no valid digits were found or unsupported base 2664 * was provided. 2665 * 2666 * **-ERANGE** if resulting value was out of range. 2667 * 2668 * void *bpf_sk_storage_get(struct bpf_map *map, struct bpf_sock *sk, void *value, u64 flags) 2669 * Description 2670 * Get a bpf-local-storage from a *sk*. 2671 * 2672 * Logically, it could be thought of getting the value from 2673 * a *map* with *sk* as the **key**. From this 2674 * perspective, the usage is not much different from 2675 * **bpf_map_lookup_elem**\ (*map*, **&**\ *sk*) except this 2676 * helper enforces the key must be a full socket and the map must 2677 * be a **BPF_MAP_TYPE_SK_STORAGE** also. 2678 * 2679 * Underneath, the value is stored locally at *sk* instead of 2680 * the *map*. The *map* is used as the bpf-local-storage 2681 * "type". The bpf-local-storage "type" (i.e. the *map*) is 2682 * searched against all bpf-local-storages residing at *sk*. 2683 * 2684 * An optional *flags* (**BPF_SK_STORAGE_GET_F_CREATE**) can be 2685 * used such that a new bpf-local-storage will be 2686 * created if one does not exist. *value* can be used 2687 * together with **BPF_SK_STORAGE_GET_F_CREATE** to specify 2688 * the initial value of a bpf-local-storage. If *value* is 2689 * **NULL**, the new bpf-local-storage will be zero initialized. 2690 * Return 2691 * A bpf-local-storage pointer is returned on success. 2692 * 2693 * **NULL** if not found or there was an error in adding 2694 * a new bpf-local-storage. 2695 * 2696 * int bpf_sk_storage_delete(struct bpf_map *map, struct bpf_sock *sk) 2697 * Description 2698 * Delete a bpf-local-storage from a *sk*. 2699 * Return 2700 * 0 on success. 2701 * 2702 * **-ENOENT** if the bpf-local-storage cannot be found. 2703 * 2704 * int bpf_send_signal(u32 sig) 2705 * Description 2706 * Send signal *sig* to the current task. 2707 * Return 2708 * 0 on success or successfully queued. 2709 * 2710 * **-EBUSY** if work queue under nmi is full. 2711 * 2712 * **-EINVAL** if *sig* is invalid. 2713 * 2714 * **-EPERM** if no permission to send the *sig*. 2715 * 2716 * **-EAGAIN** if bpf program can try again. 2717 * 2718 * s64 bpf_tcp_gen_syncookie(struct bpf_sock *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len) 2719 * Description 2720 * Try to issue a SYN cookie for the packet with corresponding 2721 * IP/TCP headers, *iph* and *th*, on the listening socket in *sk*. 2722 * 2723 * *iph* points to the start of the IPv4 or IPv6 header, while 2724 * *iph_len* contains **sizeof**\ (**struct iphdr**) or 2725 * **sizeof**\ (**struct ip6hdr**). 2726 * 2727 * *th* points to the start of the TCP header, while *th_len* 2728 * contains the length of the TCP header. 2729 * 2730 * Return 2731 * On success, lower 32 bits hold the generated SYN cookie in 2732 * followed by 16 bits which hold the MSS value for that cookie, 2733 * and the top 16 bits are unused. 2734 * 2735 * On failure, the returned value is one of the following: 2736 * 2737 * **-EINVAL** SYN cookie cannot be issued due to error 2738 * 2739 * **-ENOENT** SYN cookie should not be issued (no SYN flood) 2740 * 2741 * **-EOPNOTSUPP** kernel configuration does not enable SYN cookies 2742 * 2743 * **-EPROTONOSUPPORT** IP packet version is not 4 or 6 2744 * 2745 * int bpf_skb_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size) 2746 * Description 2747 * Write raw *data* blob into a special BPF perf event held by 2748 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf 2749 * event must have the following attributes: **PERF_SAMPLE_RAW** 2750 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and 2751 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**. 2752 * 2753 * The *flags* are used to indicate the index in *map* for which 2754 * the value must be put, masked with **BPF_F_INDEX_MASK**. 2755 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU** 2756 * to indicate that the index of the current CPU core should be 2757 * used. 2758 * 2759 * The value to write, of *size*, is passed through eBPF stack and 2760 * pointed by *data*. 2761 * 2762 * *ctx* is a pointer to in-kernel struct sk_buff. 2763 * 2764 * This helper is similar to **bpf_perf_event_output**\ () but 2765 * restricted to raw_tracepoint bpf programs. 2766 * Return 2767 * 0 on success, or a negative error in case of failure. 2768 * 2769 * int bpf_probe_read_user(void *dst, u32 size, const void *unsafe_ptr) 2770 * Description 2771 * Safely attempt to read *size* bytes from user space address 2772 * *unsafe_ptr* and store the data in *dst*. 2773 * Return 2774 * 0 on success, or a negative error in case of failure. 2775 * 2776 * int bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr) 2777 * Description 2778 * Safely attempt to read *size* bytes from kernel space address 2779 * *unsafe_ptr* and store the data in *dst*. 2780 * Return 2781 * 0 on success, or a negative error in case of failure. 2782 * 2783 * int bpf_probe_read_user_str(void *dst, u32 size, const void *unsafe_ptr) 2784 * Description 2785 * Copy a NUL terminated string from an unsafe user address 2786 * *unsafe_ptr* to *dst*. The *size* should include the 2787 * terminating NUL byte. In case the string length is smaller than 2788 * *size*, the target is not padded with further NUL bytes. If the 2789 * string length is larger than *size*, just *size*-1 bytes are 2790 * copied and the last byte is set to NUL. 2791 * 2792 * On success, the length of the copied string is returned. This 2793 * makes this helper useful in tracing programs for reading 2794 * strings, and more importantly to get its length at runtime. See 2795 * the following snippet: 2796 * 2797 * :: 2798 * 2799 * SEC("kprobe/sys_open") 2800 * void bpf_sys_open(struct pt_regs *ctx) 2801 * { 2802 * char buf[PATHLEN]; // PATHLEN is defined to 256 2803 * int res = bpf_probe_read_user_str(buf, sizeof(buf), 2804 * ctx->di); 2805 * 2806 * // Consume buf, for example push it to 2807 * // userspace via bpf_perf_event_output(); we 2808 * // can use res (the string length) as event 2809 * // size, after checking its boundaries. 2810 * } 2811 * 2812 * In comparison, using **bpf_probe_read_user()** helper here 2813 * instead to read the string would require to estimate the length 2814 * at compile time, and would often result in copying more memory 2815 * than necessary. 2816 * 2817 * Another useful use case is when parsing individual process 2818 * arguments or individual environment variables navigating 2819 * *current*\ **->mm->arg_start** and *current*\ 2820 * **->mm->env_start**: using this helper and the return value, 2821 * one can quickly iterate at the right offset of the memory area. 2822 * Return 2823 * On success, the strictly positive length of the string, 2824 * including the trailing NUL character. On error, a negative 2825 * value. 2826 * 2827 * int bpf_probe_read_kernel_str(void *dst, u32 size, const void *unsafe_ptr) 2828 * Description 2829 * Copy a NUL terminated string from an unsafe kernel address *unsafe_ptr* 2830 * to *dst*. Same semantics as with bpf_probe_read_user_str() apply. 2831 * Return 2832 * On success, the strictly positive length of the string, including 2833 * the trailing NUL character. On error, a negative value. 2834 */ 2835 #define __BPF_FUNC_MAPPER(FN) \ 2836 FN(unspec), \ 2837 FN(map_lookup_elem), \ 2838 FN(map_update_elem), \ 2839 FN(map_delete_elem), \ 2840 FN(probe_read), \ 2841 FN(ktime_get_ns), \ 2842 FN(trace_printk), \ 2843 FN(get_prandom_u32), \ 2844 FN(get_smp_processor_id), \ 2845 FN(skb_store_bytes), \ 2846 FN(l3_csum_replace), \ 2847 FN(l4_csum_replace), \ 2848 FN(tail_call), \ 2849 FN(clone_redirect), \ 2850 FN(get_current_pid_tgid), \ 2851 FN(get_current_uid_gid), \ 2852 FN(get_current_comm), \ 2853 FN(get_cgroup_classid), \ 2854 FN(skb_vlan_push), \ 2855 FN(skb_vlan_pop), \ 2856 FN(skb_get_tunnel_key), \ 2857 FN(skb_set_tunnel_key), \ 2858 FN(perf_event_read), \ 2859 FN(redirect), \ 2860 FN(get_route_realm), \ 2861 FN(perf_event_output), \ 2862 FN(skb_load_bytes), \ 2863 FN(get_stackid), \ 2864 FN(csum_diff), \ 2865 FN(skb_get_tunnel_opt), \ 2866 FN(skb_set_tunnel_opt), \ 2867 FN(skb_change_proto), \ 2868 FN(skb_change_type), \ 2869 FN(skb_under_cgroup), \ 2870 FN(get_hash_recalc), \ 2871 FN(get_current_task), \ 2872 FN(probe_write_user), \ 2873 FN(current_task_under_cgroup), \ 2874 FN(skb_change_tail), \ 2875 FN(skb_pull_data), \ 2876 FN(csum_update), \ 2877 FN(set_hash_invalid), \ 2878 FN(get_numa_node_id), \ 2879 FN(skb_change_head), \ 2880 FN(xdp_adjust_head), \ 2881 FN(probe_read_str), \ 2882 FN(get_socket_cookie), \ 2883 FN(get_socket_uid), \ 2884 FN(set_hash), \ 2885 FN(setsockopt), \ 2886 FN(skb_adjust_room), \ 2887 FN(redirect_map), \ 2888 FN(sk_redirect_map), \ 2889 FN(sock_map_update), \ 2890 FN(xdp_adjust_meta), \ 2891 FN(perf_event_read_value), \ 2892 FN(perf_prog_read_value), \ 2893 FN(getsockopt), \ 2894 FN(override_return), \ 2895 FN(sock_ops_cb_flags_set), \ 2896 FN(msg_redirect_map), \ 2897 FN(msg_apply_bytes), \ 2898 FN(msg_cork_bytes), \ 2899 FN(msg_pull_data), \ 2900 FN(bind), \ 2901 FN(xdp_adjust_tail), \ 2902 FN(skb_get_xfrm_state), \ 2903 FN(get_stack), \ 2904 FN(skb_load_bytes_relative), \ 2905 FN(fib_lookup), \ 2906 FN(sock_hash_update), \ 2907 FN(msg_redirect_hash), \ 2908 FN(sk_redirect_hash), \ 2909 FN(lwt_push_encap), \ 2910 FN(lwt_seg6_store_bytes), \ 2911 FN(lwt_seg6_adjust_srh), \ 2912 FN(lwt_seg6_action), \ 2913 FN(rc_repeat), \ 2914 FN(rc_keydown), \ 2915 FN(skb_cgroup_id), \ 2916 FN(get_current_cgroup_id), \ 2917 FN(get_local_storage), \ 2918 FN(sk_select_reuseport), \ 2919 FN(skb_ancestor_cgroup_id), \ 2920 FN(sk_lookup_tcp), \ 2921 FN(sk_lookup_udp), \ 2922 FN(sk_release), \ 2923 FN(map_push_elem), \ 2924 FN(map_pop_elem), \ 2925 FN(map_peek_elem), \ 2926 FN(msg_push_data), \ 2927 FN(msg_pop_data), \ 2928 FN(rc_pointer_rel), \ 2929 FN(spin_lock), \ 2930 FN(spin_unlock), \ 2931 FN(sk_fullsock), \ 2932 FN(tcp_sock), \ 2933 FN(skb_ecn_set_ce), \ 2934 FN(get_listener_sock), \ 2935 FN(skc_lookup_tcp), \ 2936 FN(tcp_check_syncookie), \ 2937 FN(sysctl_get_name), \ 2938 FN(sysctl_get_current_value), \ 2939 FN(sysctl_get_new_value), \ 2940 FN(sysctl_set_new_value), \ 2941 FN(strtol), \ 2942 FN(strtoul), \ 2943 FN(sk_storage_get), \ 2944 FN(sk_storage_delete), \ 2945 FN(send_signal), \ 2946 FN(tcp_gen_syncookie), \ 2947 FN(skb_output), \ 2948 FN(probe_read_user), \ 2949 FN(probe_read_kernel), \ 2950 FN(probe_read_user_str), \ 2951 FN(probe_read_kernel_str), 2952 2953 /* integer value in 'imm' field of BPF_CALL instruction selects which helper 2954 * function eBPF program intends to call 2955 */ 2956 #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x 2957 enum bpf_func_id { 2958 __BPF_FUNC_MAPPER(__BPF_ENUM_FN) 2959 __BPF_FUNC_MAX_ID, 2960 }; 2961 #undef __BPF_ENUM_FN 2962 2963 /* All flags used by eBPF helper functions, placed here. */ 2964 2965 /* BPF_FUNC_skb_store_bytes flags. */ 2966 #define BPF_F_RECOMPUTE_CSUM (1ULL << 0) 2967 #define BPF_F_INVALIDATE_HASH (1ULL << 1) 2968 2969 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags. 2970 * First 4 bits are for passing the header field size. 2971 */ 2972 #define BPF_F_HDR_FIELD_MASK 0xfULL 2973 2974 /* BPF_FUNC_l4_csum_replace flags. */ 2975 #define BPF_F_PSEUDO_HDR (1ULL << 4) 2976 #define BPF_F_MARK_MANGLED_0 (1ULL << 5) 2977 #define BPF_F_MARK_ENFORCE (1ULL << 6) 2978 2979 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */ 2980 #define BPF_F_INGRESS (1ULL << 0) 2981 2982 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */ 2983 #define BPF_F_TUNINFO_IPV6 (1ULL << 0) 2984 2985 /* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */ 2986 #define BPF_F_SKIP_FIELD_MASK 0xffULL 2987 #define BPF_F_USER_STACK (1ULL << 8) 2988 /* flags used by BPF_FUNC_get_stackid only. */ 2989 #define BPF_F_FAST_STACK_CMP (1ULL << 9) 2990 #define BPF_F_REUSE_STACKID (1ULL << 10) 2991 /* flags used by BPF_FUNC_get_stack only. */ 2992 #define BPF_F_USER_BUILD_ID (1ULL << 11) 2993 2994 /* BPF_FUNC_skb_set_tunnel_key flags. */ 2995 #define BPF_F_ZERO_CSUM_TX (1ULL << 1) 2996 #define BPF_F_DONT_FRAGMENT (1ULL << 2) 2997 #define BPF_F_SEQ_NUMBER (1ULL << 3) 2998 2999 /* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and 3000 * BPF_FUNC_perf_event_read_value flags. 3001 */ 3002 #define BPF_F_INDEX_MASK 0xffffffffULL 3003 #define BPF_F_CURRENT_CPU BPF_F_INDEX_MASK 3004 /* BPF_FUNC_perf_event_output for sk_buff input context. */ 3005 #define BPF_F_CTXLEN_MASK (0xfffffULL << 32) 3006 3007 /* Current network namespace */ 3008 #define BPF_F_CURRENT_NETNS (-1L) 3009 3010 /* BPF_FUNC_skb_adjust_room flags. */ 3011 #define BPF_F_ADJ_ROOM_FIXED_GSO (1ULL << 0) 3012 3013 #define BPF_ADJ_ROOM_ENCAP_L2_MASK 0xff 3014 #define BPF_ADJ_ROOM_ENCAP_L2_SHIFT 56 3015 3016 #define BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 (1ULL << 1) 3017 #define BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 (1ULL << 2) 3018 #define BPF_F_ADJ_ROOM_ENCAP_L4_GRE (1ULL << 3) 3019 #define BPF_F_ADJ_ROOM_ENCAP_L4_UDP (1ULL << 4) 3020 #define BPF_F_ADJ_ROOM_ENCAP_L2(len) (((__u64)len & \ 3021 BPF_ADJ_ROOM_ENCAP_L2_MASK) \ 3022 << BPF_ADJ_ROOM_ENCAP_L2_SHIFT) 3023 3024 /* BPF_FUNC_sysctl_get_name flags. */ 3025 #define BPF_F_SYSCTL_BASE_NAME (1ULL << 0) 3026 3027 /* BPF_FUNC_sk_storage_get flags */ 3028 #define BPF_SK_STORAGE_GET_F_CREATE (1ULL << 0) 3029 3030 /* Mode for BPF_FUNC_skb_adjust_room helper. */ 3031 enum bpf_adj_room_mode { 3032 BPF_ADJ_ROOM_NET, 3033 BPF_ADJ_ROOM_MAC, 3034 }; 3035 3036 /* Mode for BPF_FUNC_skb_load_bytes_relative helper. */ 3037 enum bpf_hdr_start_off { 3038 BPF_HDR_START_MAC, 3039 BPF_HDR_START_NET, 3040 }; 3041 3042 /* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */ 3043 enum bpf_lwt_encap_mode { 3044 BPF_LWT_ENCAP_SEG6, 3045 BPF_LWT_ENCAP_SEG6_INLINE, 3046 BPF_LWT_ENCAP_IP, 3047 }; 3048 3049 #define __bpf_md_ptr(type, name) \ 3050 union { \ 3051 type name; \ 3052 __u64 :64; \ 3053 } __attribute__((aligned(8))) 3054 3055 /* user accessible mirror of in-kernel sk_buff. 3056 * new fields can only be added to the end of this structure 3057 */ 3058 struct __sk_buff { 3059 __u32 len; 3060 __u32 pkt_type; 3061 __u32 mark; 3062 __u32 queue_mapping; 3063 __u32 protocol; 3064 __u32 vlan_present; 3065 __u32 vlan_tci; 3066 __u32 vlan_proto; 3067 __u32 priority; 3068 __u32 ingress_ifindex; 3069 __u32 ifindex; 3070 __u32 tc_index; 3071 __u32 cb[5]; 3072 __u32 hash; 3073 __u32 tc_classid; 3074 __u32 data; 3075 __u32 data_end; 3076 __u32 napi_id; 3077 3078 /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */ 3079 __u32 family; 3080 __u32 remote_ip4; /* Stored in network byte order */ 3081 __u32 local_ip4; /* Stored in network byte order */ 3082 __u32 remote_ip6[4]; /* Stored in network byte order */ 3083 __u32 local_ip6[4]; /* Stored in network byte order */ 3084 __u32 remote_port; /* Stored in network byte order */ 3085 __u32 local_port; /* stored in host byte order */ 3086 /* ... here. */ 3087 3088 __u32 data_meta; 3089 __bpf_md_ptr(struct bpf_flow_keys *, flow_keys); 3090 __u64 tstamp; 3091 __u32 wire_len; 3092 __u32 gso_segs; 3093 __bpf_md_ptr(struct bpf_sock *, sk); 3094 }; 3095 3096 struct bpf_tunnel_key { 3097 __u32 tunnel_id; 3098 union { 3099 __u32 remote_ipv4; 3100 __u32 remote_ipv6[4]; 3101 }; 3102 __u8 tunnel_tos; 3103 __u8 tunnel_ttl; 3104 __u16 tunnel_ext; /* Padding, future use. */ 3105 __u32 tunnel_label; 3106 }; 3107 3108 /* user accessible mirror of in-kernel xfrm_state. 3109 * new fields can only be added to the end of this structure 3110 */ 3111 struct bpf_xfrm_state { 3112 __u32 reqid; 3113 __u32 spi; /* Stored in network byte order */ 3114 __u16 family; 3115 __u16 ext; /* Padding, future use. */ 3116 union { 3117 __u32 remote_ipv4; /* Stored in network byte order */ 3118 __u32 remote_ipv6[4]; /* Stored in network byte order */ 3119 }; 3120 }; 3121 3122 /* Generic BPF return codes which all BPF program types may support. 3123 * The values are binary compatible with their TC_ACT_* counter-part to 3124 * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT 3125 * programs. 3126 * 3127 * XDP is handled seprately, see XDP_*. 3128 */ 3129 enum bpf_ret_code { 3130 BPF_OK = 0, 3131 /* 1 reserved */ 3132 BPF_DROP = 2, 3133 /* 3-6 reserved */ 3134 BPF_REDIRECT = 7, 3135 /* >127 are reserved for prog type specific return codes. 3136 * 3137 * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and 3138 * BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been 3139 * changed and should be routed based on its new L3 header. 3140 * (This is an L3 redirect, as opposed to L2 redirect 3141 * represented by BPF_REDIRECT above). 3142 */ 3143 BPF_LWT_REROUTE = 128, 3144 }; 3145 3146 struct bpf_sock { 3147 __u32 bound_dev_if; 3148 __u32 family; 3149 __u32 type; 3150 __u32 protocol; 3151 __u32 mark; 3152 __u32 priority; 3153 /* IP address also allows 1 and 2 bytes access */ 3154 __u32 src_ip4; 3155 __u32 src_ip6[4]; 3156 __u32 src_port; /* host byte order */ 3157 __u32 dst_port; /* network byte order */ 3158 __u32 dst_ip4; 3159 __u32 dst_ip6[4]; 3160 __u32 state; 3161 }; 3162 3163 struct bpf_tcp_sock { 3164 __u32 snd_cwnd; /* Sending congestion window */ 3165 __u32 srtt_us; /* smoothed round trip time << 3 in usecs */ 3166 __u32 rtt_min; 3167 __u32 snd_ssthresh; /* Slow start size threshold */ 3168 __u32 rcv_nxt; /* What we want to receive next */ 3169 __u32 snd_nxt; /* Next sequence we send */ 3170 __u32 snd_una; /* First byte we want an ack for */ 3171 __u32 mss_cache; /* Cached effective mss, not including SACKS */ 3172 __u32 ecn_flags; /* ECN status bits. */ 3173 __u32 rate_delivered; /* saved rate sample: packets delivered */ 3174 __u32 rate_interval_us; /* saved rate sample: time elapsed */ 3175 __u32 packets_out; /* Packets which are "in flight" */ 3176 __u32 retrans_out; /* Retransmitted packets out */ 3177 __u32 total_retrans; /* Total retransmits for entire connection */ 3178 __u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn 3179 * total number of segments in. 3180 */ 3181 __u32 data_segs_in; /* RFC4898 tcpEStatsPerfDataSegsIn 3182 * total number of data segments in. 3183 */ 3184 __u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut 3185 * The total number of segments sent. 3186 */ 3187 __u32 data_segs_out; /* RFC4898 tcpEStatsPerfDataSegsOut 3188 * total number of data segments sent. 3189 */ 3190 __u32 lost_out; /* Lost packets */ 3191 __u32 sacked_out; /* SACK'd packets */ 3192 __u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived 3193 * sum(delta(rcv_nxt)), or how many bytes 3194 * were acked. 3195 */ 3196 __u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked 3197 * sum(delta(snd_una)), or how many bytes 3198 * were acked. 3199 */ 3200 __u32 dsack_dups; /* RFC4898 tcpEStatsStackDSACKDups 3201 * total number of DSACK blocks received 3202 */ 3203 __u32 delivered; /* Total data packets delivered incl. rexmits */ 3204 __u32 delivered_ce; /* Like the above but only ECE marked packets */ 3205 __u32 icsk_retransmits; /* Number of unrecovered [RTO] timeouts */ 3206 }; 3207 3208 struct bpf_sock_tuple { 3209 union { 3210 struct { 3211 __be32 saddr; 3212 __be32 daddr; 3213 __be16 sport; 3214 __be16 dport; 3215 } ipv4; 3216 struct { 3217 __be32 saddr[4]; 3218 __be32 daddr[4]; 3219 __be16 sport; 3220 __be16 dport; 3221 } ipv6; 3222 }; 3223 }; 3224 3225 struct bpf_xdp_sock { 3226 __u32 queue_id; 3227 }; 3228 3229 #define XDP_PACKET_HEADROOM 256 3230 3231 /* User return codes for XDP prog type. 3232 * A valid XDP program must return one of these defined values. All other 3233 * return codes are reserved for future use. Unknown return codes will 3234 * result in packet drops and a warning via bpf_warn_invalid_xdp_action(). 3235 */ 3236 enum xdp_action { 3237 XDP_ABORTED = 0, 3238 XDP_DROP, 3239 XDP_PASS, 3240 XDP_TX, 3241 XDP_REDIRECT, 3242 }; 3243 3244 /* user accessible metadata for XDP packet hook 3245 * new fields must be added to the end of this structure 3246 */ 3247 struct xdp_md { 3248 __u32 data; 3249 __u32 data_end; 3250 __u32 data_meta; 3251 /* Below access go through struct xdp_rxq_info */ 3252 __u32 ingress_ifindex; /* rxq->dev->ifindex */ 3253 __u32 rx_queue_index; /* rxq->queue_index */ 3254 }; 3255 3256 enum sk_action { 3257 SK_DROP = 0, 3258 SK_PASS, 3259 }; 3260 3261 /* user accessible metadata for SK_MSG packet hook, new fields must 3262 * be added to the end of this structure 3263 */ 3264 struct sk_msg_md { 3265 __bpf_md_ptr(void *, data); 3266 __bpf_md_ptr(void *, data_end); 3267 3268 __u32 family; 3269 __u32 remote_ip4; /* Stored in network byte order */ 3270 __u32 local_ip4; /* Stored in network byte order */ 3271 __u32 remote_ip6[4]; /* Stored in network byte order */ 3272 __u32 local_ip6[4]; /* Stored in network byte order */ 3273 __u32 remote_port; /* Stored in network byte order */ 3274 __u32 local_port; /* stored in host byte order */ 3275 __u32 size; /* Total size of sk_msg */ 3276 }; 3277 3278 struct sk_reuseport_md { 3279 /* 3280 * Start of directly accessible data. It begins from 3281 * the tcp/udp header. 3282 */ 3283 __bpf_md_ptr(void *, data); 3284 /* End of directly accessible data */ 3285 __bpf_md_ptr(void *, data_end); 3286 /* 3287 * Total length of packet (starting from the tcp/udp header). 3288 * Note that the directly accessible bytes (data_end - data) 3289 * could be less than this "len". Those bytes could be 3290 * indirectly read by a helper "bpf_skb_load_bytes()". 3291 */ 3292 __u32 len; 3293 /* 3294 * Eth protocol in the mac header (network byte order). e.g. 3295 * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD) 3296 */ 3297 __u32 eth_protocol; 3298 __u32 ip_protocol; /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */ 3299 __u32 bind_inany; /* Is sock bound to an INANY address? */ 3300 __u32 hash; /* A hash of the packet 4 tuples */ 3301 }; 3302 3303 #define BPF_TAG_SIZE 8 3304 3305 struct bpf_prog_info { 3306 __u32 type; 3307 __u32 id; 3308 __u8 tag[BPF_TAG_SIZE]; 3309 __u32 jited_prog_len; 3310 __u32 xlated_prog_len; 3311 __aligned_u64 jited_prog_insns; 3312 __aligned_u64 xlated_prog_insns; 3313 __u64 load_time; /* ns since boottime */ 3314 __u32 created_by_uid; 3315 __u32 nr_map_ids; 3316 __aligned_u64 map_ids; 3317 char name[BPF_OBJ_NAME_LEN]; 3318 __u32 ifindex; 3319 __u32 gpl_compatible:1; 3320 __u32 :31; /* alignment pad */ 3321 __u64 netns_dev; 3322 __u64 netns_ino; 3323 __u32 nr_jited_ksyms; 3324 __u32 nr_jited_func_lens; 3325 __aligned_u64 jited_ksyms; 3326 __aligned_u64 jited_func_lens; 3327 __u32 btf_id; 3328 __u32 func_info_rec_size; 3329 __aligned_u64 func_info; 3330 __u32 nr_func_info; 3331 __u32 nr_line_info; 3332 __aligned_u64 line_info; 3333 __aligned_u64 jited_line_info; 3334 __u32 nr_jited_line_info; 3335 __u32 line_info_rec_size; 3336 __u32 jited_line_info_rec_size; 3337 __u32 nr_prog_tags; 3338 __aligned_u64 prog_tags; 3339 __u64 run_time_ns; 3340 __u64 run_cnt; 3341 } __attribute__((aligned(8))); 3342 3343 struct bpf_map_info { 3344 __u32 type; 3345 __u32 id; 3346 __u32 key_size; 3347 __u32 value_size; 3348 __u32 max_entries; 3349 __u32 map_flags; 3350 char name[BPF_OBJ_NAME_LEN]; 3351 __u32 ifindex; 3352 __u32 :32; 3353 __u64 netns_dev; 3354 __u64 netns_ino; 3355 __u32 btf_id; 3356 __u32 btf_key_type_id; 3357 __u32 btf_value_type_id; 3358 } __attribute__((aligned(8))); 3359 3360 struct bpf_btf_info { 3361 __aligned_u64 btf; 3362 __u32 btf_size; 3363 __u32 id; 3364 } __attribute__((aligned(8))); 3365 3366 /* User bpf_sock_addr struct to access socket fields and sockaddr struct passed 3367 * by user and intended to be used by socket (e.g. to bind to, depends on 3368 * attach attach type). 3369 */ 3370 struct bpf_sock_addr { 3371 __u32 user_family; /* Allows 4-byte read, but no write. */ 3372 __u32 user_ip4; /* Allows 1,2,4-byte read and 4-byte write. 3373 * Stored in network byte order. 3374 */ 3375 __u32 user_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write. 3376 * Stored in network byte order. 3377 */ 3378 __u32 user_port; /* Allows 4-byte read and write. 3379 * Stored in network byte order 3380 */ 3381 __u32 family; /* Allows 4-byte read, but no write */ 3382 __u32 type; /* Allows 4-byte read, but no write */ 3383 __u32 protocol; /* Allows 4-byte read, but no write */ 3384 __u32 msg_src_ip4; /* Allows 1,2,4-byte read and 4-byte write. 3385 * Stored in network byte order. 3386 */ 3387 __u32 msg_src_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write. 3388 * Stored in network byte order. 3389 */ 3390 __bpf_md_ptr(struct bpf_sock *, sk); 3391 }; 3392 3393 /* User bpf_sock_ops struct to access socket values and specify request ops 3394 * and their replies. 3395 * Some of this fields are in network (bigendian) byte order and may need 3396 * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h). 3397 * New fields can only be added at the end of this structure 3398 */ 3399 struct bpf_sock_ops { 3400 __u32 op; 3401 union { 3402 __u32 args[4]; /* Optionally passed to bpf program */ 3403 __u32 reply; /* Returned by bpf program */ 3404 __u32 replylong[4]; /* Optionally returned by bpf prog */ 3405 }; 3406 __u32 family; 3407 __u32 remote_ip4; /* Stored in network byte order */ 3408 __u32 local_ip4; /* Stored in network byte order */ 3409 __u32 remote_ip6[4]; /* Stored in network byte order */ 3410 __u32 local_ip6[4]; /* Stored in network byte order */ 3411 __u32 remote_port; /* Stored in network byte order */ 3412 __u32 local_port; /* stored in host byte order */ 3413 __u32 is_fullsock; /* Some TCP fields are only valid if 3414 * there is a full socket. If not, the 3415 * fields read as zero. 3416 */ 3417 __u32 snd_cwnd; 3418 __u32 srtt_us; /* Averaged RTT << 3 in usecs */ 3419 __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */ 3420 __u32 state; 3421 __u32 rtt_min; 3422 __u32 snd_ssthresh; 3423 __u32 rcv_nxt; 3424 __u32 snd_nxt; 3425 __u32 snd_una; 3426 __u32 mss_cache; 3427 __u32 ecn_flags; 3428 __u32 rate_delivered; 3429 __u32 rate_interval_us; 3430 __u32 packets_out; 3431 __u32 retrans_out; 3432 __u32 total_retrans; 3433 __u32 segs_in; 3434 __u32 data_segs_in; 3435 __u32 segs_out; 3436 __u32 data_segs_out; 3437 __u32 lost_out; 3438 __u32 sacked_out; 3439 __u32 sk_txhash; 3440 __u64 bytes_received; 3441 __u64 bytes_acked; 3442 __bpf_md_ptr(struct bpf_sock *, sk); 3443 }; 3444 3445 /* Definitions for bpf_sock_ops_cb_flags */ 3446 #define BPF_SOCK_OPS_RTO_CB_FLAG (1<<0) 3447 #define BPF_SOCK_OPS_RETRANS_CB_FLAG (1<<1) 3448 #define BPF_SOCK_OPS_STATE_CB_FLAG (1<<2) 3449 #define BPF_SOCK_OPS_RTT_CB_FLAG (1<<3) 3450 #define BPF_SOCK_OPS_ALL_CB_FLAGS 0xF /* Mask of all currently 3451 * supported cb flags 3452 */ 3453 3454 /* List of known BPF sock_ops operators. 3455 * New entries can only be added at the end 3456 */ 3457 enum { 3458 BPF_SOCK_OPS_VOID, 3459 BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or 3460 * -1 if default value should be used 3461 */ 3462 BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized 3463 * window (in packets) or -1 if default 3464 * value should be used 3465 */ 3466 BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an 3467 * active connection is initialized 3468 */ 3469 BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an 3470 * active connection is 3471 * established 3472 */ 3473 BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a 3474 * passive connection is 3475 * established 3476 */ 3477 BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control 3478 * needs ECN 3479 */ 3480 BPF_SOCK_OPS_BASE_RTT, /* Get base RTT. The correct value is 3481 * based on the path and may be 3482 * dependent on the congestion control 3483 * algorithm. In general it indicates 3484 * a congestion threshold. RTTs above 3485 * this indicate congestion 3486 */ 3487 BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered. 3488 * Arg1: value of icsk_retransmits 3489 * Arg2: value of icsk_rto 3490 * Arg3: whether RTO has expired 3491 */ 3492 BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted. 3493 * Arg1: sequence number of 1st byte 3494 * Arg2: # segments 3495 * Arg3: return value of 3496 * tcp_transmit_skb (0 => success) 3497 */ 3498 BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state. 3499 * Arg1: old_state 3500 * Arg2: new_state 3501 */ 3502 BPF_SOCK_OPS_TCP_LISTEN_CB, /* Called on listen(2), right after 3503 * socket transition to LISTEN state. 3504 */ 3505 BPF_SOCK_OPS_RTT_CB, /* Called on every RTT. 3506 */ 3507 }; 3508 3509 /* List of TCP states. There is a build check in net/ipv4/tcp.c to detect 3510 * changes between the TCP and BPF versions. Ideally this should never happen. 3511 * If it does, we need to add code to convert them before calling 3512 * the BPF sock_ops function. 3513 */ 3514 enum { 3515 BPF_TCP_ESTABLISHED = 1, 3516 BPF_TCP_SYN_SENT, 3517 BPF_TCP_SYN_RECV, 3518 BPF_TCP_FIN_WAIT1, 3519 BPF_TCP_FIN_WAIT2, 3520 BPF_TCP_TIME_WAIT, 3521 BPF_TCP_CLOSE, 3522 BPF_TCP_CLOSE_WAIT, 3523 BPF_TCP_LAST_ACK, 3524 BPF_TCP_LISTEN, 3525 BPF_TCP_CLOSING, /* Now a valid state */ 3526 BPF_TCP_NEW_SYN_RECV, 3527 3528 BPF_TCP_MAX_STATES /* Leave at the end! */ 3529 }; 3530 3531 #define TCP_BPF_IW 1001 /* Set TCP initial congestion window */ 3532 #define TCP_BPF_SNDCWND_CLAMP 1002 /* Set sndcwnd_clamp */ 3533 3534 struct bpf_perf_event_value { 3535 __u64 counter; 3536 __u64 enabled; 3537 __u64 running; 3538 }; 3539 3540 #define BPF_DEVCG_ACC_MKNOD (1ULL << 0) 3541 #define BPF_DEVCG_ACC_READ (1ULL << 1) 3542 #define BPF_DEVCG_ACC_WRITE (1ULL << 2) 3543 3544 #define BPF_DEVCG_DEV_BLOCK (1ULL << 0) 3545 #define BPF_DEVCG_DEV_CHAR (1ULL << 1) 3546 3547 struct bpf_cgroup_dev_ctx { 3548 /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */ 3549 __u32 access_type; 3550 __u32 major; 3551 __u32 minor; 3552 }; 3553 3554 struct bpf_raw_tracepoint_args { 3555 __u64 args[0]; 3556 }; 3557 3558 /* DIRECT: Skip the FIB rules and go to FIB table associated with device 3559 * OUTPUT: Do lookup from egress perspective; default is ingress 3560 */ 3561 #define BPF_FIB_LOOKUP_DIRECT (1U << 0) 3562 #define BPF_FIB_LOOKUP_OUTPUT (1U << 1) 3563 3564 enum { 3565 BPF_FIB_LKUP_RET_SUCCESS, /* lookup successful */ 3566 BPF_FIB_LKUP_RET_BLACKHOLE, /* dest is blackholed; can be dropped */ 3567 BPF_FIB_LKUP_RET_UNREACHABLE, /* dest is unreachable; can be dropped */ 3568 BPF_FIB_LKUP_RET_PROHIBIT, /* dest not allowed; can be dropped */ 3569 BPF_FIB_LKUP_RET_NOT_FWDED, /* packet is not forwarded */ 3570 BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */ 3571 BPF_FIB_LKUP_RET_UNSUPP_LWT, /* fwd requires encapsulation */ 3572 BPF_FIB_LKUP_RET_NO_NEIGH, /* no neighbor entry for nh */ 3573 BPF_FIB_LKUP_RET_FRAG_NEEDED, /* fragmentation required to fwd */ 3574 }; 3575 3576 struct bpf_fib_lookup { 3577 /* input: network family for lookup (AF_INET, AF_INET6) 3578 * output: network family of egress nexthop 3579 */ 3580 __u8 family; 3581 3582 /* set if lookup is to consider L4 data - e.g., FIB rules */ 3583 __u8 l4_protocol; 3584 __be16 sport; 3585 __be16 dport; 3586 3587 /* total length of packet from network header - used for MTU check */ 3588 __u16 tot_len; 3589 3590 /* input: L3 device index for lookup 3591 * output: device index from FIB lookup 3592 */ 3593 __u32 ifindex; 3594 3595 union { 3596 /* inputs to lookup */ 3597 __u8 tos; /* AF_INET */ 3598 __be32 flowinfo; /* AF_INET6, flow_label + priority */ 3599 3600 /* output: metric of fib result (IPv4/IPv6 only) */ 3601 __u32 rt_metric; 3602 }; 3603 3604 union { 3605 __be32 ipv4_src; 3606 __u32 ipv6_src[4]; /* in6_addr; network order */ 3607 }; 3608 3609 /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in 3610 * network header. output: bpf_fib_lookup sets to gateway address 3611 * if FIB lookup returns gateway route 3612 */ 3613 union { 3614 __be32 ipv4_dst; 3615 __u32 ipv6_dst[4]; /* in6_addr; network order */ 3616 }; 3617 3618 /* output */ 3619 __be16 h_vlan_proto; 3620 __be16 h_vlan_TCI; 3621 __u8 smac[6]; /* ETH_ALEN */ 3622 __u8 dmac[6]; /* ETH_ALEN */ 3623 }; 3624 3625 enum bpf_task_fd_type { 3626 BPF_FD_TYPE_RAW_TRACEPOINT, /* tp name */ 3627 BPF_FD_TYPE_TRACEPOINT, /* tp name */ 3628 BPF_FD_TYPE_KPROBE, /* (symbol + offset) or addr */ 3629 BPF_FD_TYPE_KRETPROBE, /* (symbol + offset) or addr */ 3630 BPF_FD_TYPE_UPROBE, /* filename + offset */ 3631 BPF_FD_TYPE_URETPROBE, /* filename + offset */ 3632 }; 3633 3634 #define BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG (1U << 0) 3635 #define BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL (1U << 1) 3636 #define BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP (1U << 2) 3637 3638 struct bpf_flow_keys { 3639 __u16 nhoff; 3640 __u16 thoff; 3641 __u16 addr_proto; /* ETH_P_* of valid addrs */ 3642 __u8 is_frag; 3643 __u8 is_first_frag; 3644 __u8 is_encap; 3645 __u8 ip_proto; 3646 __be16 n_proto; 3647 __be16 sport; 3648 __be16 dport; 3649 union { 3650 struct { 3651 __be32 ipv4_src; 3652 __be32 ipv4_dst; 3653 }; 3654 struct { 3655 __u32 ipv6_src[4]; /* in6_addr; network order */ 3656 __u32 ipv6_dst[4]; /* in6_addr; network order */ 3657 }; 3658 }; 3659 __u32 flags; 3660 __be32 flow_label; 3661 }; 3662 3663 struct bpf_func_info { 3664 __u32 insn_off; 3665 __u32 type_id; 3666 }; 3667 3668 #define BPF_LINE_INFO_LINE_NUM(line_col) ((line_col) >> 10) 3669 #define BPF_LINE_INFO_LINE_COL(line_col) ((line_col) & 0x3ff) 3670 3671 struct bpf_line_info { 3672 __u32 insn_off; 3673 __u32 file_name_off; 3674 __u32 line_off; 3675 __u32 line_col; 3676 }; 3677 3678 struct bpf_spin_lock { 3679 __u32 val; 3680 }; 3681 3682 struct bpf_sysctl { 3683 __u32 write; /* Sysctl is being read (= 0) or written (= 1). 3684 * Allows 1,2,4-byte read, but no write. 3685 */ 3686 __u32 file_pos; /* Sysctl file position to read from, write to. 3687 * Allows 1,2,4-byte read an 4-byte write. 3688 */ 3689 }; 3690 3691 struct bpf_sockopt { 3692 __bpf_md_ptr(struct bpf_sock *, sk); 3693 __bpf_md_ptr(void *, optval); 3694 __bpf_md_ptr(void *, optval_end); 3695 3696 __s32 level; 3697 __s32 optname; 3698 __s32 optlen; 3699 __s32 retval; 3700 }; 3701 3702 #endif /* _UAPI__LINUX_BPF_H__ */ 3703