1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
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.
8 #ifndef _UAPI__LINUX_BPF_H__
9 #define _UAPI__LINUX_BPF_H__
11 #include <linux/types.h>
12 #include <linux/bpf_common.h>
14 /* Extended instruction set based on top of classic BPF */
16 /* instruction classes */
17 #define BPF_JMP32 0x06 /* jmp mode in word width */
18 #define BPF_ALU64 0x07 /* alu mode in double word width */
21 #define BPF_DW 0x18 /* double word (64-bit) */
22 #define BPF_ATOMIC 0xc0 /* atomic memory ops - op type in immediate */
23 #define BPF_XADD 0xc0 /* exclusive add - legacy name */
26 #define BPF_MOV 0xb0 /* mov reg to reg */
27 #define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */
29 /* change endianness of a register */
30 #define BPF_END 0xd0 /* flags for endianness conversion: */
31 #define BPF_TO_LE 0x00 /* convert to little-endian */
32 #define BPF_TO_BE 0x08 /* convert to big-endian */
33 #define BPF_FROM_LE BPF_TO_LE
34 #define BPF_FROM_BE BPF_TO_BE
37 #define BPF_JNE 0x50 /* jump != */
38 #define BPF_JLT 0xa0 /* LT is unsigned, '<' */
39 #define BPF_JLE 0xb0 /* LE is unsigned, '<=' */
40 #define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
41 #define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
42 #define BPF_JSLT 0xc0 /* SLT is signed, '<' */
43 #define BPF_JSLE 0xd0 /* SLE is signed, '<=' */
44 #define BPF_CALL 0x80 /* function call */
45 #define BPF_EXIT 0x90 /* function return */
47 /* atomic op type fields (stored in immediate) */
48 #define BPF_FETCH 0x01 /* not an opcode on its own, used to build others */
49 #define BPF_XCHG (0xe0 | BPF_FETCH) /* atomic exchange */
50 #define BPF_CMPXCHG (0xf0 | BPF_FETCH) /* atomic compare-and-write */
52 /* Register numbers */
68 /* BPF has 10 general purpose 64-bit registers and stack frame. */
69 #define MAX_BPF_REG __MAX_BPF_REG
72 __u8 code; /* opcode */
73 __u8 dst_reg:4; /* dest register */
74 __u8 src_reg:4; /* source register */
75 __s16 off; /* signed offset */
76 __s32 imm; /* signed immediate constant */
79 /* Key of an a BPF_MAP_TYPE_LPM_TRIE entry */
80 struct bpf_lpm_trie_key {
81 __u32 prefixlen; /* up to 32 for AF_INET, 128 for AF_INET6 */
82 __u8 data[0]; /* Arbitrary size */
85 struct bpf_cgroup_storage_key {
86 __u64 cgroup_inode_id; /* cgroup inode id */
87 __u32 attach_type; /* program attach type (enum bpf_attach_type) */
90 union bpf_iter_link_info {
96 /* BPF syscall commands, see bpf(2) man-page for more details. */
98 * DOC: eBPF Syscall Preamble
100 * The operation to be performed by the **bpf**\ () system call is determined
101 * by the *cmd* argument. Each operation takes an accompanying argument,
102 * provided via *attr*, which is a pointer to a union of type *bpf_attr* (see
103 * below). The size argument is the size of the union pointed to by *attr*.
106 * DOC: eBPF Syscall Commands
110 * Create a map and return a file descriptor that refers to the
111 * map. The close-on-exec file descriptor flag (see **fcntl**\ (2))
112 * is automatically enabled for the new file descriptor.
114 * Applying **close**\ (2) to the file descriptor returned by
115 * **BPF_MAP_CREATE** will delete the map (but see NOTES).
118 * A new file descriptor (a nonnegative integer), or -1 if an
119 * error occurred (in which case, *errno* is set appropriately).
121 * BPF_MAP_LOOKUP_ELEM
123 * Look up an element with a given *key* in the map referred to
124 * by the file descriptor *map_fd*.
126 * The *flags* argument may be specified as one of the
130 * Look up the value of a spin-locked map without
131 * returning the lock. This must be specified if the
132 * elements contain a spinlock.
135 * Returns zero on success. On error, -1 is returned and *errno*
136 * is set appropriately.
138 * BPF_MAP_UPDATE_ELEM
140 * Create or update an element (key/value pair) in a specified map.
142 * The *flags* argument should be specified as one of the
146 * Create a new element or update an existing element.
148 * Create a new element only if it did not exist.
150 * Update an existing element.
152 * Update a spin_lock-ed map element.
155 * Returns zero on success. On error, -1 is returned and *errno*
156 * is set appropriately.
158 * May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**,
159 * **E2BIG**, **EEXIST**, or **ENOENT**.
162 * The number of elements in the map reached the
163 * *max_entries* limit specified at map creation time.
165 * If *flags* specifies **BPF_NOEXIST** and the element
166 * with *key* already exists in the map.
168 * If *flags* specifies **BPF_EXIST** and the element with
169 * *key* does not exist in the map.
171 * BPF_MAP_DELETE_ELEM
173 * Look up and delete an element by key in a specified map.
176 * Returns zero on success. On error, -1 is returned and *errno*
177 * is set appropriately.
179 * BPF_MAP_GET_NEXT_KEY
181 * Look up an element by key in a specified map and return the key
182 * of the next element. Can be used to iterate over all elements
186 * Returns zero on success. On error, -1 is returned and *errno*
187 * is set appropriately.
189 * The following cases can be used to iterate over all elements of
192 * * If *key* is not found, the operation returns zero and sets
193 * the *next_key* pointer to the key of the first element.
194 * * If *key* is found, the operation returns zero and sets the
195 * *next_key* pointer to the key of the next element.
196 * * If *key* is the last element, returns -1 and *errno* is set
199 * May set *errno* to **ENOMEM**, **EFAULT**, **EPERM**, or
200 * **EINVAL** on error.
204 * Verify and load an eBPF program, returning a new file
205 * descriptor associated with the program.
207 * Applying **close**\ (2) to the file descriptor returned by
208 * **BPF_PROG_LOAD** will unload the eBPF program (but see NOTES).
210 * The close-on-exec file descriptor flag (see **fcntl**\ (2)) is
211 * automatically enabled for the new file descriptor.
214 * A new file descriptor (a nonnegative integer), or -1 if an
215 * error occurred (in which case, *errno* is set appropriately).
219 * Pin an eBPF program or map referred by the specified *bpf_fd*
220 * to the provided *pathname* on the filesystem.
222 * The *pathname* argument must not contain a dot (".").
224 * On success, *pathname* retains a reference to the eBPF object,
225 * preventing deallocation of the object when the original
226 * *bpf_fd* is closed. This allow the eBPF object to live beyond
227 * **close**\ (\ *bpf_fd*\ ), and hence the lifetime of the parent
230 * Applying **unlink**\ (2) or similar calls to the *pathname*
231 * unpins the object from the filesystem, removing the reference.
232 * If no other file descriptors or filesystem nodes refer to the
233 * same object, it will be deallocated (see NOTES).
235 * The filesystem type for the parent directory of *pathname* must
236 * be **BPF_FS_MAGIC**.
239 * Returns zero on success. On error, -1 is returned and *errno*
240 * is set appropriately.
244 * Open a file descriptor for the eBPF object pinned to the
245 * specified *pathname*.
248 * A new file descriptor (a nonnegative integer), or -1 if an
249 * error occurred (in which case, *errno* is set appropriately).
253 * Attach an eBPF program to a *target_fd* at the specified
254 * *attach_type* hook.
256 * The *attach_type* specifies the eBPF attachment point to
257 * attach the program to, and must be one of *bpf_attach_type*
260 * The *attach_bpf_fd* must be a valid file descriptor for a
261 * loaded eBPF program of a cgroup, flow dissector, LIRC, sockmap
262 * or sock_ops type corresponding to the specified *attach_type*.
264 * The *target_fd* must be a valid file descriptor for a kernel
265 * object which depends on the attach type of *attach_bpf_fd*:
267 * **BPF_PROG_TYPE_CGROUP_DEVICE**,
268 * **BPF_PROG_TYPE_CGROUP_SKB**,
269 * **BPF_PROG_TYPE_CGROUP_SOCK**,
270 * **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**,
271 * **BPF_PROG_TYPE_CGROUP_SOCKOPT**,
272 * **BPF_PROG_TYPE_CGROUP_SYSCTL**,
273 * **BPF_PROG_TYPE_SOCK_OPS**
275 * Control Group v2 hierarchy with the eBPF controller
276 * enabled. Requires the kernel to be compiled with
277 * **CONFIG_CGROUP_BPF**.
279 * **BPF_PROG_TYPE_FLOW_DISSECTOR**
281 * Network namespace (eg /proc/self/ns/net).
283 * **BPF_PROG_TYPE_LIRC_MODE2**
285 * LIRC device path (eg /dev/lircN). Requires the kernel
286 * to be compiled with **CONFIG_BPF_LIRC_MODE2**.
288 * **BPF_PROG_TYPE_SK_SKB**,
289 * **BPF_PROG_TYPE_SK_MSG**
291 * eBPF map of socket type (eg **BPF_MAP_TYPE_SOCKHASH**).
294 * Returns zero on success. On error, -1 is returned and *errno*
295 * is set appropriately.
299 * Detach the eBPF program associated with the *target_fd* at the
300 * hook specified by *attach_type*. The program must have been
301 * previously attached using **BPF_PROG_ATTACH**.
304 * Returns zero on success. On error, -1 is returned and *errno*
305 * is set appropriately.
309 * Run the eBPF program associated with the *prog_fd* a *repeat*
310 * number of times against a provided program context *ctx_in* and
311 * data *data_in*, and return the modified program context
312 * *ctx_out*, *data_out* (for example, packet data), result of the
313 * execution *retval*, and *duration* of the test run.
315 * The sizes of the buffers provided as input and output
316 * parameters *ctx_in*, *ctx_out*, *data_in*, and *data_out* must
317 * be provided in the corresponding variables *ctx_size_in*,
318 * *ctx_size_out*, *data_size_in*, and/or *data_size_out*. If any
319 * of these parameters are not provided (ie set to NULL), the
320 * corresponding size field must be zero.
322 * Some program types have particular requirements:
324 * **BPF_PROG_TYPE_SK_LOOKUP**
325 * *data_in* and *data_out* must be NULL.
327 * **BPF_PROG_TYPE_RAW_TRACEPOINT**,
328 * **BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE**
330 * *ctx_out*, *data_in* and *data_out* must be NULL.
331 * *repeat* must be zero.
333 * BPF_PROG_RUN is an alias for BPF_PROG_TEST_RUN.
336 * Returns zero on success. On error, -1 is returned and *errno*
337 * is set appropriately.
340 * Either *data_size_out* or *ctx_size_out* is too small.
342 * This command is not supported by the program type of
343 * the program referred to by *prog_fd*.
345 * BPF_PROG_GET_NEXT_ID
347 * Fetch the next eBPF program currently loaded into the kernel.
349 * Looks for the eBPF program with an id greater than *start_id*
350 * and updates *next_id* on success. If no other eBPF programs
351 * remain with ids higher than *start_id*, returns -1 and sets
352 * *errno* to **ENOENT**.
355 * Returns zero on success. On error, or when no id remains, -1
356 * is returned and *errno* is set appropriately.
358 * BPF_MAP_GET_NEXT_ID
360 * Fetch the next eBPF map currently loaded into the kernel.
362 * Looks for the eBPF map with an id greater than *start_id*
363 * and updates *next_id* on success. If no other eBPF maps
364 * remain with ids higher than *start_id*, returns -1 and sets
365 * *errno* to **ENOENT**.
368 * Returns zero on success. On error, or when no id remains, -1
369 * is returned and *errno* is set appropriately.
371 * BPF_PROG_GET_FD_BY_ID
373 * Open a file descriptor for the eBPF program corresponding to
377 * A new file descriptor (a nonnegative integer), or -1 if an
378 * error occurred (in which case, *errno* is set appropriately).
380 * BPF_MAP_GET_FD_BY_ID
382 * Open a file descriptor for the eBPF map corresponding to
386 * A new file descriptor (a nonnegative integer), or -1 if an
387 * error occurred (in which case, *errno* is set appropriately).
389 * BPF_OBJ_GET_INFO_BY_FD
391 * Obtain information about the eBPF object corresponding to
394 * Populates up to *info_len* bytes of *info*, which will be in
395 * one of the following formats depending on the eBPF object type
398 * * **struct bpf_prog_info**
399 * * **struct bpf_map_info**
400 * * **struct bpf_btf_info**
401 * * **struct bpf_link_info**
404 * Returns zero on success. On error, -1 is returned and *errno*
405 * is set appropriately.
409 * Obtain information about eBPF programs associated with the
410 * specified *attach_type* hook.
412 * The *target_fd* must be a valid file descriptor for a kernel
413 * object which depends on the attach type of *attach_bpf_fd*:
415 * **BPF_PROG_TYPE_CGROUP_DEVICE**,
416 * **BPF_PROG_TYPE_CGROUP_SKB**,
417 * **BPF_PROG_TYPE_CGROUP_SOCK**,
418 * **BPF_PROG_TYPE_CGROUP_SOCK_ADDR**,
419 * **BPF_PROG_TYPE_CGROUP_SOCKOPT**,
420 * **BPF_PROG_TYPE_CGROUP_SYSCTL**,
421 * **BPF_PROG_TYPE_SOCK_OPS**
423 * Control Group v2 hierarchy with the eBPF controller
424 * enabled. Requires the kernel to be compiled with
425 * **CONFIG_CGROUP_BPF**.
427 * **BPF_PROG_TYPE_FLOW_DISSECTOR**
429 * Network namespace (eg /proc/self/ns/net).
431 * **BPF_PROG_TYPE_LIRC_MODE2**
433 * LIRC device path (eg /dev/lircN). Requires the kernel
434 * to be compiled with **CONFIG_BPF_LIRC_MODE2**.
436 * **BPF_PROG_QUERY** always fetches the number of programs
437 * attached and the *attach_flags* which were used to attach those
438 * programs. Additionally, if *prog_ids* is nonzero and the number
439 * of attached programs is less than *prog_cnt*, populates
440 * *prog_ids* with the eBPF program ids of the programs attached
443 * The following flags may alter the result:
445 * **BPF_F_QUERY_EFFECTIVE**
446 * Only return information regarding programs which are
447 * currently effective at the specified *target_fd*.
450 * Returns zero on success. On error, -1 is returned and *errno*
451 * is set appropriately.
453 * BPF_RAW_TRACEPOINT_OPEN
455 * Attach an eBPF program to a tracepoint *name* to access kernel
456 * internal arguments of the tracepoint in their raw form.
458 * The *prog_fd* must be a valid file descriptor associated with
459 * a loaded eBPF program of type **BPF_PROG_TYPE_RAW_TRACEPOINT**.
461 * No ABI guarantees are made about the content of tracepoint
462 * arguments exposed to the corresponding eBPF program.
464 * Applying **close**\ (2) to the file descriptor returned by
465 * **BPF_RAW_TRACEPOINT_OPEN** will delete the map (but see NOTES).
468 * A new file descriptor (a nonnegative integer), or -1 if an
469 * error occurred (in which case, *errno* is set appropriately).
473 * Verify and load BPF Type Format (BTF) metadata into the kernel,
474 * returning a new file descriptor associated with the metadata.
475 * BTF is described in more detail at
476 * https://www.kernel.org/doc/html/latest/bpf/btf.html.
478 * The *btf* parameter must point to valid memory providing
479 * *btf_size* bytes of BTF binary metadata.
481 * The returned file descriptor can be passed to other **bpf**\ ()
482 * subcommands such as **BPF_PROG_LOAD** or **BPF_MAP_CREATE** to
483 * associate the BTF with those objects.
485 * Similar to **BPF_PROG_LOAD**, **BPF_BTF_LOAD** has optional
486 * parameters to specify a *btf_log_buf*, *btf_log_size* and
487 * *btf_log_level* which allow the kernel to return freeform log
488 * output regarding the BTF verification process.
491 * A new file descriptor (a nonnegative integer), or -1 if an
492 * error occurred (in which case, *errno* is set appropriately).
494 * BPF_BTF_GET_FD_BY_ID
496 * Open a file descriptor for the BPF Type Format (BTF)
497 * corresponding to *btf_id*.
500 * A new file descriptor (a nonnegative integer), or -1 if an
501 * error occurred (in which case, *errno* is set appropriately).
505 * Obtain information about eBPF programs associated with the
506 * target process identified by *pid* and *fd*.
508 * If the *pid* and *fd* are associated with a tracepoint, kprobe
509 * or uprobe perf event, then the *prog_id* and *fd_type* will
510 * be populated with the eBPF program id and file descriptor type
511 * of type **bpf_task_fd_type**. If associated with a kprobe or
512 * uprobe, the *probe_offset* and *probe_addr* will also be
513 * populated. Optionally, if *buf* is provided, then up to
514 * *buf_len* bytes of *buf* will be populated with the name of
515 * the tracepoint, kprobe or uprobe.
517 * The resulting *prog_id* may be introspected in deeper detail
518 * using **BPF_PROG_GET_FD_BY_ID** and **BPF_OBJ_GET_INFO_BY_FD**.
521 * Returns zero on success. On error, -1 is returned and *errno*
522 * is set appropriately.
524 * BPF_MAP_LOOKUP_AND_DELETE_ELEM
526 * Look up an element with the given *key* in the map referred to
527 * by the file descriptor *fd*, and if found, delete the element.
529 * For **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map
530 * types, the *flags* argument needs to be set to 0, but for other
531 * map types, it may be specified as:
534 * Look up and delete the value of a spin-locked map
535 * without returning the lock. This must be specified if
536 * the elements contain a spinlock.
538 * The **BPF_MAP_TYPE_QUEUE** and **BPF_MAP_TYPE_STACK** map types
539 * implement this command as a "pop" operation, deleting the top
540 * element rather than one corresponding to *key*.
541 * The *key* and *key_len* parameters should be zeroed when
542 * issuing this operation for these map types.
544 * This command is only valid for the following map types:
545 * * **BPF_MAP_TYPE_QUEUE**
546 * * **BPF_MAP_TYPE_STACK**
547 * * **BPF_MAP_TYPE_HASH**
548 * * **BPF_MAP_TYPE_PERCPU_HASH**
549 * * **BPF_MAP_TYPE_LRU_HASH**
550 * * **BPF_MAP_TYPE_LRU_PERCPU_HASH**
553 * Returns zero on success. On error, -1 is returned and *errno*
554 * is set appropriately.
558 * Freeze the permissions of the specified map.
560 * Write permissions may be frozen by passing zero *flags*.
561 * Upon success, no future syscall invocations may alter the
562 * map state of *map_fd*. Write operations from eBPF programs
563 * are still possible for a frozen map.
565 * Not supported for maps of type **BPF_MAP_TYPE_STRUCT_OPS**.
568 * Returns zero on success. On error, -1 is returned and *errno*
569 * is set appropriately.
571 * BPF_BTF_GET_NEXT_ID
573 * Fetch the next BPF Type Format (BTF) object currently loaded
576 * Looks for the BTF object with an id greater than *start_id*
577 * and updates *next_id* on success. If no other BTF objects
578 * remain with ids higher than *start_id*, returns -1 and sets
579 * *errno* to **ENOENT**.
582 * Returns zero on success. On error, or when no id remains, -1
583 * is returned and *errno* is set appropriately.
585 * BPF_MAP_LOOKUP_BATCH
587 * Iterate and fetch multiple elements in a map.
589 * Two opaque values are used to manage batch operations,
590 * *in_batch* and *out_batch*. Initially, *in_batch* must be set
591 * to NULL to begin the batched operation. After each subsequent
592 * **BPF_MAP_LOOKUP_BATCH**, the caller should pass the resultant
593 * *out_batch* as the *in_batch* for the next operation to
594 * continue iteration from the current point.
596 * The *keys* and *values* are output parameters which must point
597 * to memory large enough to hold *count* items based on the key
598 * and value size of the map *map_fd*. The *keys* buffer must be
599 * of *key_size* * *count*. The *values* buffer must be of
600 * *value_size* * *count*.
602 * The *elem_flags* argument may be specified as one of the
606 * Look up the value of a spin-locked map without
607 * returning the lock. This must be specified if the
608 * elements contain a spinlock.
610 * On success, *count* elements from the map are copied into the
611 * user buffer, with the keys copied into *keys* and the values
612 * copied into the corresponding indices in *values*.
614 * If an error is returned and *errno* is not **EFAULT**, *count*
615 * is set to the number of successfully processed elements.
618 * Returns zero on success. On error, -1 is returned and *errno*
619 * is set appropriately.
621 * May set *errno* to **ENOSPC** to indicate that *keys* or
622 * *values* is too small to dump an entire bucket during
623 * iteration of a hash-based map type.
625 * BPF_MAP_LOOKUP_AND_DELETE_BATCH
627 * Iterate and delete all elements in a map.
629 * This operation has the same behavior as
630 * **BPF_MAP_LOOKUP_BATCH** with two exceptions:
632 * * Every element that is successfully returned is also deleted
633 * from the map. This is at least *count* elements. Note that
634 * *count* is both an input and an output parameter.
635 * * Upon returning with *errno* set to **EFAULT**, up to
636 * *count* elements may be deleted without returning the keys
637 * and values of the deleted elements.
640 * Returns zero on success. On error, -1 is returned and *errno*
641 * is set appropriately.
643 * BPF_MAP_UPDATE_BATCH
645 * Update multiple elements in a map by *key*.
647 * The *keys* and *values* are input parameters which must point
648 * to memory large enough to hold *count* items based on the key
649 * and value size of the map *map_fd*. The *keys* buffer must be
650 * of *key_size* * *count*. The *values* buffer must be of
651 * *value_size* * *count*.
653 * Each element specified in *keys* is sequentially updated to the
654 * value in the corresponding index in *values*. The *in_batch*
655 * and *out_batch* parameters are ignored and should be zeroed.
657 * The *elem_flags* argument should be specified as one of the
661 * Create new elements or update a existing elements.
663 * Create new elements only if they do not exist.
665 * Update existing elements.
667 * Update spin_lock-ed map elements. This must be
668 * specified if the map value contains a spinlock.
670 * On success, *count* elements from the map are updated.
672 * If an error is returned and *errno* is not **EFAULT**, *count*
673 * is set to the number of successfully processed elements.
676 * Returns zero on success. On error, -1 is returned and *errno*
677 * is set appropriately.
679 * May set *errno* to **EINVAL**, **EPERM**, **ENOMEM**, or
680 * **E2BIG**. **E2BIG** indicates that the number of elements in
681 * the map reached the *max_entries* limit specified at map
684 * May set *errno* to one of the following error codes under
685 * specific circumstances:
688 * If *flags* specifies **BPF_NOEXIST** and the element
689 * with *key* already exists in the map.
691 * If *flags* specifies **BPF_EXIST** and the element with
692 * *key* does not exist in the map.
694 * BPF_MAP_DELETE_BATCH
696 * Delete multiple elements in a map by *key*.
698 * The *keys* parameter is an input parameter which must point
699 * to memory large enough to hold *count* items based on the key
700 * size of the map *map_fd*, that is, *key_size* * *count*.
702 * Each element specified in *keys* is sequentially deleted. The
703 * *in_batch*, *out_batch*, and *values* parameters are ignored
704 * and should be zeroed.
706 * The *elem_flags* argument may be specified as one of the
710 * Look up the value of a spin-locked map without
711 * returning the lock. This must be specified if the
712 * elements contain a spinlock.
714 * On success, *count* elements from the map are updated.
716 * If an error is returned and *errno* is not **EFAULT**, *count*
717 * is set to the number of successfully processed elements. If
718 * *errno* is **EFAULT**, up to *count* elements may be been
722 * Returns zero on success. On error, -1 is returned and *errno*
723 * is set appropriately.
727 * Attach an eBPF program to a *target_fd* at the specified
728 * *attach_type* hook and return a file descriptor handle for
732 * A new file descriptor (a nonnegative integer), or -1 if an
733 * error occurred (in which case, *errno* is set appropriately).
737 * Update the eBPF program in the specified *link_fd* to
741 * Returns zero on success. On error, -1 is returned and *errno*
742 * is set appropriately.
744 * BPF_LINK_GET_FD_BY_ID
746 * Open a file descriptor for the eBPF Link corresponding to
750 * A new file descriptor (a nonnegative integer), or -1 if an
751 * error occurred (in which case, *errno* is set appropriately).
753 * BPF_LINK_GET_NEXT_ID
755 * Fetch the next eBPF link currently loaded into the kernel.
757 * Looks for the eBPF link with an id greater than *start_id*
758 * and updates *next_id* on success. If no other eBPF links
759 * remain with ids higher than *start_id*, returns -1 and sets
760 * *errno* to **ENOENT**.
763 * Returns zero on success. On error, or when no id remains, -1
764 * is returned and *errno* is set appropriately.
768 * Enable eBPF runtime statistics gathering.
770 * Runtime statistics gathering for the eBPF runtime is disabled
771 * by default to minimize the corresponding performance overhead.
772 * This command enables statistics globally.
774 * Multiple programs may independently enable statistics.
775 * After gathering the desired statistics, eBPF runtime statistics
776 * may be disabled again by calling **close**\ (2) for the file
777 * descriptor returned by this function. Statistics will only be
778 * disabled system-wide when all outstanding file descriptors
779 * returned by prior calls for this subcommand are closed.
782 * A new file descriptor (a nonnegative integer), or -1 if an
783 * error occurred (in which case, *errno* is set appropriately).
787 * Create an iterator on top of the specified *link_fd* (as
788 * previously created using **BPF_LINK_CREATE**) and return a
789 * file descriptor that can be used to trigger the iteration.
791 * If the resulting file descriptor is pinned to the filesystem
792 * using **BPF_OBJ_PIN**, then subsequent **read**\ (2) syscalls
793 * for that path will trigger the iterator to read kernel state
794 * using the eBPF program attached to *link_fd*.
797 * A new file descriptor (a nonnegative integer), or -1 if an
798 * error occurred (in which case, *errno* is set appropriately).
802 * Forcefully detach the specified *link_fd* from its
803 * corresponding attachment point.
806 * Returns zero on success. On error, -1 is returned and *errno*
807 * is set appropriately.
811 * Bind a map to the lifetime of an eBPF program.
813 * The map identified by *map_fd* is bound to the program
814 * identified by *prog_fd* and only released when *prog_fd* is
815 * released. This may be used in cases where metadata should be
816 * associated with a program which otherwise does not contain any
817 * references to the map (for example, embedded in the eBPF
818 * program instructions).
821 * Returns zero on success. On error, -1 is returned and *errno*
822 * is set appropriately.
825 * eBPF objects (maps and programs) can be shared between processes.
827 * * After **fork**\ (2), the child inherits file descriptors
828 * referring to the same eBPF objects.
829 * * File descriptors referring to eBPF objects can be transferred over
830 * **unix**\ (7) domain sockets.
831 * * File descriptors referring to eBPF objects can be duplicated in the
832 * usual way, using **dup**\ (2) and similar calls.
833 * * File descriptors referring to eBPF objects can be pinned to the
834 * filesystem using the **BPF_OBJ_PIN** command of **bpf**\ (2).
836 * An eBPF object is deallocated only after all file descriptors referring
837 * to the object have been closed and no references remain pinned to the
838 * filesystem or attached (for example, bound to a program or device).
845 BPF_MAP_GET_NEXT_KEY,
852 BPF_PROG_RUN = BPF_PROG_TEST_RUN,
853 BPF_PROG_GET_NEXT_ID,
855 BPF_PROG_GET_FD_BY_ID,
856 BPF_MAP_GET_FD_BY_ID,
857 BPF_OBJ_GET_INFO_BY_FD,
859 BPF_RAW_TRACEPOINT_OPEN,
861 BPF_BTF_GET_FD_BY_ID,
863 BPF_MAP_LOOKUP_AND_DELETE_ELEM,
866 BPF_MAP_LOOKUP_BATCH,
867 BPF_MAP_LOOKUP_AND_DELETE_BATCH,
868 BPF_MAP_UPDATE_BATCH,
869 BPF_MAP_DELETE_BATCH,
872 BPF_LINK_GET_FD_BY_ID,
873 BPF_LINK_GET_NEXT_ID,
884 BPF_MAP_TYPE_PROG_ARRAY,
885 BPF_MAP_TYPE_PERF_EVENT_ARRAY,
886 BPF_MAP_TYPE_PERCPU_HASH,
887 BPF_MAP_TYPE_PERCPU_ARRAY,
888 BPF_MAP_TYPE_STACK_TRACE,
889 BPF_MAP_TYPE_CGROUP_ARRAY,
890 BPF_MAP_TYPE_LRU_HASH,
891 BPF_MAP_TYPE_LRU_PERCPU_HASH,
892 BPF_MAP_TYPE_LPM_TRIE,
893 BPF_MAP_TYPE_ARRAY_OF_MAPS,
894 BPF_MAP_TYPE_HASH_OF_MAPS,
896 BPF_MAP_TYPE_SOCKMAP,
899 BPF_MAP_TYPE_SOCKHASH,
900 BPF_MAP_TYPE_CGROUP_STORAGE,
901 BPF_MAP_TYPE_REUSEPORT_SOCKARRAY,
902 BPF_MAP_TYPE_PERCPU_CGROUP_STORAGE,
905 BPF_MAP_TYPE_SK_STORAGE,
906 BPF_MAP_TYPE_DEVMAP_HASH,
907 BPF_MAP_TYPE_STRUCT_OPS,
908 BPF_MAP_TYPE_RINGBUF,
909 BPF_MAP_TYPE_INODE_STORAGE,
910 BPF_MAP_TYPE_TASK_STORAGE,
911 BPF_MAP_TYPE_BLOOM_FILTER,
914 /* Note that tracing related programs such as
915 * BPF_PROG_TYPE_{KPROBE,TRACEPOINT,PERF_EVENT,RAW_TRACEPOINT}
916 * are not subject to a stable API since kernel internal data
917 * structures can change from release to release and may
918 * therefore break existing tracing BPF programs. Tracing BPF
919 * programs correspond to /a/ specific kernel which is to be
920 * analyzed, and not /a/ specific kernel /and/ all future ones.
923 BPF_PROG_TYPE_UNSPEC,
924 BPF_PROG_TYPE_SOCKET_FILTER,
925 BPF_PROG_TYPE_KPROBE,
926 BPF_PROG_TYPE_SCHED_CLS,
927 BPF_PROG_TYPE_SCHED_ACT,
928 BPF_PROG_TYPE_TRACEPOINT,
930 BPF_PROG_TYPE_PERF_EVENT,
931 BPF_PROG_TYPE_CGROUP_SKB,
932 BPF_PROG_TYPE_CGROUP_SOCK,
933 BPF_PROG_TYPE_LWT_IN,
934 BPF_PROG_TYPE_LWT_OUT,
935 BPF_PROG_TYPE_LWT_XMIT,
936 BPF_PROG_TYPE_SOCK_OPS,
937 BPF_PROG_TYPE_SK_SKB,
938 BPF_PROG_TYPE_CGROUP_DEVICE,
939 BPF_PROG_TYPE_SK_MSG,
940 BPF_PROG_TYPE_RAW_TRACEPOINT,
941 BPF_PROG_TYPE_CGROUP_SOCK_ADDR,
942 BPF_PROG_TYPE_LWT_SEG6LOCAL,
943 BPF_PROG_TYPE_LIRC_MODE2,
944 BPF_PROG_TYPE_SK_REUSEPORT,
945 BPF_PROG_TYPE_FLOW_DISSECTOR,
946 BPF_PROG_TYPE_CGROUP_SYSCTL,
947 BPF_PROG_TYPE_RAW_TRACEPOINT_WRITABLE,
948 BPF_PROG_TYPE_CGROUP_SOCKOPT,
949 BPF_PROG_TYPE_TRACING,
950 BPF_PROG_TYPE_STRUCT_OPS,
953 BPF_PROG_TYPE_SK_LOOKUP,
954 BPF_PROG_TYPE_SYSCALL, /* a program that can execute syscalls */
957 enum bpf_attach_type {
958 BPF_CGROUP_INET_INGRESS,
959 BPF_CGROUP_INET_EGRESS,
960 BPF_CGROUP_INET_SOCK_CREATE,
962 BPF_SK_SKB_STREAM_PARSER,
963 BPF_SK_SKB_STREAM_VERDICT,
966 BPF_CGROUP_INET4_BIND,
967 BPF_CGROUP_INET6_BIND,
968 BPF_CGROUP_INET4_CONNECT,
969 BPF_CGROUP_INET6_CONNECT,
970 BPF_CGROUP_INET4_POST_BIND,
971 BPF_CGROUP_INET6_POST_BIND,
972 BPF_CGROUP_UDP4_SENDMSG,
973 BPF_CGROUP_UDP6_SENDMSG,
977 BPF_CGROUP_UDP4_RECVMSG,
978 BPF_CGROUP_UDP6_RECVMSG,
979 BPF_CGROUP_GETSOCKOPT,
980 BPF_CGROUP_SETSOCKOPT,
987 BPF_CGROUP_INET4_GETPEERNAME,
988 BPF_CGROUP_INET6_GETPEERNAME,
989 BPF_CGROUP_INET4_GETSOCKNAME,
990 BPF_CGROUP_INET6_GETSOCKNAME,
992 BPF_CGROUP_INET_SOCK_RELEASE,
997 BPF_SK_REUSEPORT_SELECT,
998 BPF_SK_REUSEPORT_SELECT_OR_MIGRATE,
1000 BPF_TRACE_KPROBE_MULTI,
1001 __MAX_BPF_ATTACH_TYPE
1004 #define MAX_BPF_ATTACH_TYPE __MAX_BPF_ATTACH_TYPE
1006 enum bpf_link_type {
1007 BPF_LINK_TYPE_UNSPEC = 0,
1008 BPF_LINK_TYPE_RAW_TRACEPOINT = 1,
1009 BPF_LINK_TYPE_TRACING = 2,
1010 BPF_LINK_TYPE_CGROUP = 3,
1011 BPF_LINK_TYPE_ITER = 4,
1012 BPF_LINK_TYPE_NETNS = 5,
1013 BPF_LINK_TYPE_XDP = 6,
1014 BPF_LINK_TYPE_PERF_EVENT = 7,
1015 BPF_LINK_TYPE_KPROBE_MULTI = 8,
1020 /* cgroup-bpf attach flags used in BPF_PROG_ATTACH command
1022 * NONE(default): No further bpf programs allowed in the subtree.
1024 * BPF_F_ALLOW_OVERRIDE: If a sub-cgroup installs some bpf program,
1025 * the program in this cgroup yields to sub-cgroup program.
1027 * BPF_F_ALLOW_MULTI: If a sub-cgroup installs some bpf program,
1028 * that cgroup program gets run in addition to the program in this cgroup.
1030 * Only one program is allowed to be attached to a cgroup with
1031 * NONE or BPF_F_ALLOW_OVERRIDE flag.
1032 * Attaching another program on top of NONE or BPF_F_ALLOW_OVERRIDE will
1033 * release old program and attach the new one. Attach flags has to match.
1035 * Multiple programs are allowed to be attached to a cgroup with
1036 * BPF_F_ALLOW_MULTI flag. They are executed in FIFO order
1037 * (those that were attached first, run first)
1038 * The programs of sub-cgroup are executed first, then programs of
1039 * this cgroup and then programs of parent cgroup.
1040 * When children program makes decision (like picking TCP CA or sock bind)
1041 * parent program has a chance to override it.
1043 * With BPF_F_ALLOW_MULTI a new program is added to the end of the list of
1044 * programs for a cgroup. Though it's possible to replace an old program at
1045 * any position by also specifying BPF_F_REPLACE flag and position itself in
1046 * replace_bpf_fd attribute. Old program at this position will be released.
1048 * A cgroup with MULTI or OVERRIDE flag allows any attach flags in sub-cgroups.
1049 * A cgroup with NONE doesn't allow any programs in sub-cgroups.
1051 * cgrp1 (MULTI progs A, B) ->
1052 * cgrp2 (OVERRIDE prog C) ->
1053 * cgrp3 (MULTI prog D) ->
1054 * cgrp4 (OVERRIDE prog E) ->
1055 * cgrp5 (NONE prog F)
1056 * the event in cgrp5 triggers execution of F,D,A,B in that order.
1057 * if prog F is detached, the execution is E,D,A,B
1058 * if prog F and D are detached, the execution is E,A,B
1059 * if prog F, E and D are detached, the execution is C,A,B
1061 * All eligible programs are executed regardless of return code from
1064 #define BPF_F_ALLOW_OVERRIDE (1U << 0)
1065 #define BPF_F_ALLOW_MULTI (1U << 1)
1066 #define BPF_F_REPLACE (1U << 2)
1068 /* If BPF_F_STRICT_ALIGNMENT is used in BPF_PROG_LOAD command, the
1069 * verifier will perform strict alignment checking as if the kernel
1070 * has been built with CONFIG_EFFICIENT_UNALIGNED_ACCESS not set,
1071 * and NET_IP_ALIGN defined to 2.
1073 #define BPF_F_STRICT_ALIGNMENT (1U << 0)
1075 /* If BPF_F_ANY_ALIGNMENT is used in BPF_PROF_LOAD command, the
1076 * verifier will allow any alignment whatsoever. On platforms
1077 * with strict alignment requirements for loads ands stores (such
1078 * as sparc and mips) the verifier validates that all loads and
1079 * stores provably follow this requirement. This flag turns that
1080 * checking and enforcement off.
1082 * It is mostly used for testing when we want to validate the
1083 * context and memory access aspects of the verifier, but because
1084 * of an unaligned access the alignment check would trigger before
1085 * the one we are interested in.
1087 #define BPF_F_ANY_ALIGNMENT (1U << 1)
1089 /* BPF_F_TEST_RND_HI32 is used in BPF_PROG_LOAD command for testing purpose.
1090 * Verifier does sub-register def/use analysis and identifies instructions whose
1091 * def only matters for low 32-bit, high 32-bit is never referenced later
1092 * through implicit zero extension. Therefore verifier notifies JIT back-ends
1093 * that it is safe to ignore clearing high 32-bit for these instructions. This
1094 * saves some back-ends a lot of code-gen. However such optimization is not
1095 * necessary on some arches, for example x86_64, arm64 etc, whose JIT back-ends
1096 * hence hasn't used verifier's analysis result. But, we really want to have a
1097 * way to be able to verify the correctness of the described optimization on
1098 * x86_64 on which testsuites are frequently exercised.
1100 * So, this flag is introduced. Once it is set, verifier will randomize high
1101 * 32-bit for those instructions who has been identified as safe to ignore them.
1102 * Then, if verifier is not doing correct analysis, such randomization will
1103 * regress tests to expose bugs.
1105 #define BPF_F_TEST_RND_HI32 (1U << 2)
1107 /* The verifier internal test flag. Behavior is undefined */
1108 #define BPF_F_TEST_STATE_FREQ (1U << 3)
1110 /* If BPF_F_SLEEPABLE is used in BPF_PROG_LOAD command, the verifier will
1111 * restrict map and helper usage for such programs. Sleepable BPF programs can
1112 * only be attached to hooks where kernel execution context allows sleeping.
1113 * Such programs are allowed to use helpers that may sleep like
1114 * bpf_copy_from_user().
1116 #define BPF_F_SLEEPABLE (1U << 4)
1118 /* If BPF_F_XDP_HAS_FRAGS is used in BPF_PROG_LOAD command, the loaded program
1119 * fully support xdp frags.
1121 #define BPF_F_XDP_HAS_FRAGS (1U << 5)
1123 /* link_create.kprobe_multi.flags used in LINK_CREATE command for
1124 * BPF_TRACE_KPROBE_MULTI attach type to create return probe.
1126 #define BPF_F_KPROBE_MULTI_RETURN (1U << 0)
1128 /* When BPF ldimm64's insn[0].src_reg != 0 then this can have
1129 * the following extensions:
1131 * insn[0].src_reg: BPF_PSEUDO_MAP_[FD|IDX]
1132 * insn[0].imm: map fd or fd_idx
1136 * ldimm64 rewrite: address of map
1137 * verifier type: CONST_PTR_TO_MAP
1139 #define BPF_PSEUDO_MAP_FD 1
1140 #define BPF_PSEUDO_MAP_IDX 5
1142 /* insn[0].src_reg: BPF_PSEUDO_MAP_[IDX_]VALUE
1143 * insn[0].imm: map fd or fd_idx
1144 * insn[1].imm: offset into value
1147 * ldimm64 rewrite: address of map[0]+offset
1148 * verifier type: PTR_TO_MAP_VALUE
1150 #define BPF_PSEUDO_MAP_VALUE 2
1151 #define BPF_PSEUDO_MAP_IDX_VALUE 6
1153 /* insn[0].src_reg: BPF_PSEUDO_BTF_ID
1154 * insn[0].imm: kernel btd id of VAR
1158 * ldimm64 rewrite: address of the kernel variable
1159 * verifier type: PTR_TO_BTF_ID or PTR_TO_MEM, depending on whether the var
1162 #define BPF_PSEUDO_BTF_ID 3
1163 /* insn[0].src_reg: BPF_PSEUDO_FUNC
1164 * insn[0].imm: insn offset to the func
1168 * ldimm64 rewrite: address of the function
1169 * verifier type: PTR_TO_FUNC.
1171 #define BPF_PSEUDO_FUNC 4
1173 /* when bpf_call->src_reg == BPF_PSEUDO_CALL, bpf_call->imm == pc-relative
1174 * offset to another bpf function
1176 #define BPF_PSEUDO_CALL 1
1177 /* when bpf_call->src_reg == BPF_PSEUDO_KFUNC_CALL,
1178 * bpf_call->imm == btf_id of a BTF_KIND_FUNC in the running kernel
1180 #define BPF_PSEUDO_KFUNC_CALL 2
1182 /* flags for BPF_MAP_UPDATE_ELEM command */
1184 BPF_ANY = 0, /* create new element or update existing */
1185 BPF_NOEXIST = 1, /* create new element if it didn't exist */
1186 BPF_EXIST = 2, /* update existing element */
1187 BPF_F_LOCK = 4, /* spin_lock-ed map_lookup/map_update */
1190 /* flags for BPF_MAP_CREATE command */
1192 BPF_F_NO_PREALLOC = (1U << 0),
1193 /* Instead of having one common LRU list in the
1194 * BPF_MAP_TYPE_LRU_[PERCPU_]HASH map, use a percpu LRU list
1195 * which can scale and perform better.
1196 * Note, the LRU nodes (including free nodes) cannot be moved
1197 * across different LRU lists.
1199 BPF_F_NO_COMMON_LRU = (1U << 1),
1200 /* Specify numa node during map creation */
1201 BPF_F_NUMA_NODE = (1U << 2),
1203 /* Flags for accessing BPF object from syscall side. */
1204 BPF_F_RDONLY = (1U << 3),
1205 BPF_F_WRONLY = (1U << 4),
1207 /* Flag for stack_map, store build_id+offset instead of pointer */
1208 BPF_F_STACK_BUILD_ID = (1U << 5),
1210 /* Zero-initialize hash function seed. This should only be used for testing. */
1211 BPF_F_ZERO_SEED = (1U << 6),
1213 /* Flags for accessing BPF object from program side. */
1214 BPF_F_RDONLY_PROG = (1U << 7),
1215 BPF_F_WRONLY_PROG = (1U << 8),
1217 /* Clone map from listener for newly accepted socket */
1218 BPF_F_CLONE = (1U << 9),
1220 /* Enable memory-mapping BPF map */
1221 BPF_F_MMAPABLE = (1U << 10),
1223 /* Share perf_event among processes */
1224 BPF_F_PRESERVE_ELEMS = (1U << 11),
1226 /* Create a map that is suitable to be an inner map with dynamic max entries */
1227 BPF_F_INNER_MAP = (1U << 12),
1230 /* Flags for BPF_PROG_QUERY. */
1232 /* Query effective (directly attached + inherited from ancestor cgroups)
1233 * programs that will be executed for events within a cgroup.
1234 * attach_flags with this flag are returned only for directly attached programs.
1236 #define BPF_F_QUERY_EFFECTIVE (1U << 0)
1238 /* Flags for BPF_PROG_TEST_RUN */
1240 /* If set, run the test on the cpu specified by bpf_attr.test.cpu */
1241 #define BPF_F_TEST_RUN_ON_CPU (1U << 0)
1242 /* If set, XDP frames will be transmitted after processing */
1243 #define BPF_F_TEST_XDP_LIVE_FRAMES (1U << 1)
1245 /* type for BPF_ENABLE_STATS */
1246 enum bpf_stats_type {
1247 /* enabled run_time_ns and run_cnt */
1248 BPF_STATS_RUN_TIME = 0,
1251 enum bpf_stack_build_id_status {
1252 /* user space need an empty entry to identify end of a trace */
1253 BPF_STACK_BUILD_ID_EMPTY = 0,
1254 /* with valid build_id and offset */
1255 BPF_STACK_BUILD_ID_VALID = 1,
1256 /* couldn't get build_id, fallback to ip */
1257 BPF_STACK_BUILD_ID_IP = 2,
1260 #define BPF_BUILD_ID_SIZE 20
1261 struct bpf_stack_build_id {
1263 unsigned char build_id[BPF_BUILD_ID_SIZE];
1270 #define BPF_OBJ_NAME_LEN 16U
1273 struct { /* anonymous struct used by BPF_MAP_CREATE command */
1274 __u32 map_type; /* one of enum bpf_map_type */
1275 __u32 key_size; /* size of key in bytes */
1276 __u32 value_size; /* size of value in bytes */
1277 __u32 max_entries; /* max number of entries in a map */
1278 __u32 map_flags; /* BPF_MAP_CREATE related
1279 * flags defined above.
1281 __u32 inner_map_fd; /* fd pointing to the inner map */
1282 __u32 numa_node; /* numa node (effective only if
1283 * BPF_F_NUMA_NODE is set).
1285 char map_name[BPF_OBJ_NAME_LEN];
1286 __u32 map_ifindex; /* ifindex of netdev to create on */
1287 __u32 btf_fd; /* fd pointing to a BTF type data */
1288 __u32 btf_key_type_id; /* BTF type_id of the key */
1289 __u32 btf_value_type_id; /* BTF type_id of the value */
1290 __u32 btf_vmlinux_value_type_id;/* BTF type_id of a kernel-
1291 * struct stored as the
1294 /* Any per-map-type extra fields
1296 * BPF_MAP_TYPE_BLOOM_FILTER - the lowest 4 bits indicate the
1297 * number of hash functions (if 0, the bloom filter will default
1298 * to using 5 hash functions).
1303 struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
1307 __aligned_u64 value;
1308 __aligned_u64 next_key;
1313 struct { /* struct used by BPF_MAP_*_BATCH commands */
1314 __aligned_u64 in_batch; /* start batch,
1315 * NULL to start from beginning
1317 __aligned_u64 out_batch; /* output: next start batch */
1319 __aligned_u64 values;
1320 __u32 count; /* input/output:
1321 * input: # of key/value
1323 * output: # of filled elements
1330 struct { /* anonymous struct used by BPF_PROG_LOAD command */
1331 __u32 prog_type; /* one of enum bpf_prog_type */
1333 __aligned_u64 insns;
1334 __aligned_u64 license;
1335 __u32 log_level; /* verbosity level of verifier */
1336 __u32 log_size; /* size of user buffer */
1337 __aligned_u64 log_buf; /* user supplied buffer */
1338 __u32 kern_version; /* not used */
1340 char prog_name[BPF_OBJ_NAME_LEN];
1341 __u32 prog_ifindex; /* ifindex of netdev to prep for */
1342 /* For some prog types expected attach type must be known at
1343 * load time to verify attach type specific parts of prog
1344 * (context accesses, allowed helpers, etc).
1346 __u32 expected_attach_type;
1347 __u32 prog_btf_fd; /* fd pointing to BTF type data */
1348 __u32 func_info_rec_size; /* userspace bpf_func_info size */
1349 __aligned_u64 func_info; /* func info */
1350 __u32 func_info_cnt; /* number of bpf_func_info records */
1351 __u32 line_info_rec_size; /* userspace bpf_line_info size */
1352 __aligned_u64 line_info; /* line info */
1353 __u32 line_info_cnt; /* number of bpf_line_info records */
1354 __u32 attach_btf_id; /* in-kernel BTF type id to attach to */
1356 /* valid prog_fd to attach to bpf prog */
1357 __u32 attach_prog_fd;
1358 /* or valid module BTF object fd or 0 to attach to vmlinux */
1359 __u32 attach_btf_obj_fd;
1361 __u32 core_relo_cnt; /* number of bpf_core_relo */
1362 __aligned_u64 fd_array; /* array of FDs */
1363 __aligned_u64 core_relos;
1364 __u32 core_relo_rec_size; /* sizeof(struct bpf_core_relo) */
1367 struct { /* anonymous struct used by BPF_OBJ_* commands */
1368 __aligned_u64 pathname;
1373 struct { /* anonymous struct used by BPF_PROG_ATTACH/DETACH commands */
1374 __u32 target_fd; /* container object to attach to */
1375 __u32 attach_bpf_fd; /* eBPF program to attach */
1378 __u32 replace_bpf_fd; /* previously attached eBPF
1379 * program to replace if
1380 * BPF_F_REPLACE is used
1384 struct { /* anonymous struct used by BPF_PROG_TEST_RUN command */
1387 __u32 data_size_in; /* input: len of data_in */
1388 __u32 data_size_out; /* input/output: len of data_out
1389 * returns ENOSPC if data_out
1392 __aligned_u64 data_in;
1393 __aligned_u64 data_out;
1396 __u32 ctx_size_in; /* input: len of ctx_in */
1397 __u32 ctx_size_out; /* input/output: len of ctx_out
1398 * returns ENOSPC if ctx_out
1401 __aligned_u64 ctx_in;
1402 __aligned_u64 ctx_out;
1408 struct { /* anonymous struct used by BPF_*_GET_*_ID */
1420 struct { /* anonymous struct used by BPF_OBJ_GET_INFO_BY_FD */
1426 struct { /* anonymous struct used by BPF_PROG_QUERY command */
1427 __u32 target_fd; /* container object to query */
1431 __aligned_u64 prog_ids;
1435 struct { /* anonymous struct used by BPF_RAW_TRACEPOINT_OPEN command */
1440 struct { /* anonymous struct for BPF_BTF_LOAD */
1442 __aligned_u64 btf_log_buf;
1445 __u32 btf_log_level;
1449 __u32 pid; /* input: pid */
1450 __u32 fd; /* input: fd */
1451 __u32 flags; /* input: flags */
1452 __u32 buf_len; /* input/output: buf len */
1453 __aligned_u64 buf; /* input/output:
1454 * tp_name for tracepoint
1456 * filename for uprobe
1458 __u32 prog_id; /* output: prod_id */
1459 __u32 fd_type; /* output: BPF_FD_TYPE_* */
1460 __u64 probe_offset; /* output: probe_offset */
1461 __u64 probe_addr; /* output: probe_addr */
1464 struct { /* struct used by BPF_LINK_CREATE command */
1465 __u32 prog_fd; /* eBPF program to attach */
1467 __u32 target_fd; /* object to attach to */
1468 __u32 target_ifindex; /* target ifindex */
1470 __u32 attach_type; /* attach type */
1471 __u32 flags; /* extra flags */
1473 __u32 target_btf_id; /* btf_id of target to attach to */
1475 __aligned_u64 iter_info; /* extra bpf_iter_link_info */
1476 __u32 iter_info_len; /* iter_info length */
1479 /* black box user-provided value passed through
1480 * to BPF program at the execution time and
1481 * accessible through bpf_get_attach_cookie() BPF helper
1489 __aligned_u64 addrs;
1490 __aligned_u64 cookies;
1495 struct { /* struct used by BPF_LINK_UPDATE command */
1496 __u32 link_fd; /* link fd */
1497 /* new program fd to update link with */
1499 __u32 flags; /* extra flags */
1500 /* expected link's program fd; is specified only if
1501 * BPF_F_REPLACE flag is set in flags */
1509 struct { /* struct used by BPF_ENABLE_STATS command */
1513 struct { /* struct used by BPF_ITER_CREATE command */
1518 struct { /* struct used by BPF_PROG_BIND_MAP command */
1521 __u32 flags; /* extra flags */
1524 } __attribute__((aligned(8)));
1526 /* The description below is an attempt at providing documentation to eBPF
1527 * developers about the multiple available eBPF helper functions. It can be
1528 * parsed and used to produce a manual page. The workflow is the following,
1529 * and requires the rst2man utility:
1531 * $ ./scripts/bpf_doc.py \
1532 * --filename include/uapi/linux/bpf.h > /tmp/bpf-helpers.rst
1533 * $ rst2man /tmp/bpf-helpers.rst > /tmp/bpf-helpers.7
1534 * $ man /tmp/bpf-helpers.7
1536 * Note that in order to produce this external documentation, some RST
1537 * formatting is used in the descriptions to get "bold" and "italics" in
1538 * manual pages. Also note that the few trailing white spaces are
1539 * intentional, removing them would break paragraphs for rst2man.
1541 * Start of BPF helper function descriptions:
1543 * void *bpf_map_lookup_elem(struct bpf_map *map, const void *key)
1545 * Perform a lookup in *map* for an entry associated to *key*.
1547 * Map value associated to *key*, or **NULL** if no entry was
1550 * long bpf_map_update_elem(struct bpf_map *map, const void *key, const void *value, u64 flags)
1552 * Add or update the value of the entry associated to *key* in
1553 * *map* with *value*. *flags* is one of:
1556 * The entry for *key* must not exist in the map.
1558 * The entry for *key* must already exist in the map.
1560 * No condition on the existence of the entry for *key*.
1562 * Flag value **BPF_NOEXIST** cannot be used for maps of types
1563 * **BPF_MAP_TYPE_ARRAY** or **BPF_MAP_TYPE_PERCPU_ARRAY** (all
1564 * elements always exist), the helper would return an error.
1566 * 0 on success, or a negative error in case of failure.
1568 * long bpf_map_delete_elem(struct bpf_map *map, const void *key)
1570 * Delete entry with *key* from *map*.
1572 * 0 on success, or a negative error in case of failure.
1574 * long bpf_probe_read(void *dst, u32 size, const void *unsafe_ptr)
1576 * For tracing programs, safely attempt to read *size* bytes from
1577 * kernel space address *unsafe_ptr* and store the data in *dst*.
1579 * Generally, use **bpf_probe_read_user**\ () or
1580 * **bpf_probe_read_kernel**\ () instead.
1582 * 0 on success, or a negative error in case of failure.
1584 * u64 bpf_ktime_get_ns(void)
1586 * Return the time elapsed since system boot, in nanoseconds.
1587 * Does not include time the system was suspended.
1588 * See: **clock_gettime**\ (**CLOCK_MONOTONIC**)
1592 * long bpf_trace_printk(const char *fmt, u32 fmt_size, ...)
1594 * This helper is a "printk()-like" facility for debugging. It
1595 * prints a message defined by format *fmt* (of size *fmt_size*)
1596 * to file *\/sys/kernel/debug/tracing/trace* from DebugFS, if
1597 * available. It can take up to three additional **u64**
1598 * arguments (as an eBPF helpers, the total number of arguments is
1601 * Each time the helper is called, it appends a line to the trace.
1602 * Lines are discarded while *\/sys/kernel/debug/tracing/trace* is
1603 * open, use *\/sys/kernel/debug/tracing/trace_pipe* to avoid this.
1604 * The format of the trace is customizable, and the exact output
1605 * one will get depends on the options set in
1606 * *\/sys/kernel/debug/tracing/trace_options* (see also the
1607 * *README* file under the same directory). However, it usually
1608 * defaults to something like:
1612 * telnet-470 [001] .N.. 419421.045894: 0x00000001: <formatted msg>
1616 * * ``telnet`` is the name of the current task.
1617 * * ``470`` is the PID of the current task.
1618 * * ``001`` is the CPU number on which the task is
1620 * * In ``.N..``, each character refers to a set of
1621 * options (whether irqs are enabled, scheduling
1622 * options, whether hard/softirqs are running, level of
1623 * preempt_disabled respectively). **N** means that
1624 * **TIF_NEED_RESCHED** and **PREEMPT_NEED_RESCHED**
1626 * * ``419421.045894`` is a timestamp.
1627 * * ``0x00000001`` is a fake value used by BPF for the
1628 * instruction pointer register.
1629 * * ``<formatted msg>`` is the message formatted with
1632 * The conversion specifiers supported by *fmt* are similar, but
1633 * more limited than for printk(). They are **%d**, **%i**,
1634 * **%u**, **%x**, **%ld**, **%li**, **%lu**, **%lx**, **%lld**,
1635 * **%lli**, **%llu**, **%llx**, **%p**, **%s**. No modifier (size
1636 * of field, padding with zeroes, etc.) is available, and the
1637 * helper will return **-EINVAL** (but print nothing) if it
1638 * encounters an unknown specifier.
1640 * Also, note that **bpf_trace_printk**\ () is slow, and should
1641 * only be used for debugging purposes. For this reason, a notice
1642 * block (spanning several lines) is printed to kernel logs and
1643 * states that the helper should not be used "for production use"
1644 * the first time this helper is used (or more precisely, when
1645 * **trace_printk**\ () buffers are allocated). For passing values
1646 * to user space, perf events should be preferred.
1648 * The number of bytes written to the buffer, or a negative error
1649 * in case of failure.
1651 * u32 bpf_get_prandom_u32(void)
1653 * Get a pseudo-random number.
1655 * From a security point of view, this helper uses its own
1656 * pseudo-random internal state, and cannot be used to infer the
1657 * seed of other random functions in the kernel. However, it is
1658 * essential to note that the generator used by the helper is not
1659 * cryptographically secure.
1661 * A random 32-bit unsigned value.
1663 * u32 bpf_get_smp_processor_id(void)
1665 * Get the SMP (symmetric multiprocessing) processor id. Note that
1666 * all programs run with migration disabled, which means that the
1667 * SMP processor id is stable during all the execution of the
1670 * The SMP id of the processor running the program.
1672 * long bpf_skb_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len, u64 flags)
1674 * Store *len* bytes from address *from* into the packet
1675 * associated to *skb*, at *offset*. *flags* are a combination of
1676 * **BPF_F_RECOMPUTE_CSUM** (automatically recompute the
1677 * checksum for the packet after storing the bytes) and
1678 * **BPF_F_INVALIDATE_HASH** (set *skb*\ **->hash**, *skb*\
1679 * **->swhash** and *skb*\ **->l4hash** to 0).
1681 * A call to this helper is susceptible to change the underlying
1682 * packet buffer. Therefore, at load time, all checks on pointers
1683 * previously done by the verifier are invalidated and must be
1684 * performed again, if the helper is used in combination with
1685 * direct packet access.
1687 * 0 on success, or a negative error in case of failure.
1689 * long bpf_l3_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 size)
1691 * Recompute the layer 3 (e.g. IP) checksum for the packet
1692 * associated to *skb*. Computation is incremental, so the helper
1693 * must know the former value of the header field that was
1694 * modified (*from*), the new value of this field (*to*), and the
1695 * number of bytes (2 or 4) for this field, stored in *size*.
1696 * Alternatively, it is possible to store the difference between
1697 * the previous and the new values of the header field in *to*, by
1698 * setting *from* and *size* to 0. For both methods, *offset*
1699 * indicates the location of the IP checksum within the packet.
1701 * This helper works in combination with **bpf_csum_diff**\ (),
1702 * which does not update the checksum in-place, but offers more
1703 * flexibility and can handle sizes larger than 2 or 4 for the
1704 * checksum to update.
1706 * A call to this helper is susceptible to change the underlying
1707 * packet buffer. Therefore, at load time, all checks on pointers
1708 * previously done by the verifier are invalidated and must be
1709 * performed again, if the helper is used in combination with
1710 * direct packet access.
1712 * 0 on success, or a negative error in case of failure.
1714 * long bpf_l4_csum_replace(struct sk_buff *skb, u32 offset, u64 from, u64 to, u64 flags)
1716 * Recompute the layer 4 (e.g. TCP, UDP or ICMP) checksum for the
1717 * packet associated to *skb*. Computation is incremental, so the
1718 * helper must know the former value of the header field that was
1719 * modified (*from*), the new value of this field (*to*), and the
1720 * number of bytes (2 or 4) for this field, stored on the lowest
1721 * four bits of *flags*. Alternatively, it is possible to store
1722 * the difference between the previous and the new values of the
1723 * header field in *to*, by setting *from* and the four lowest
1724 * bits of *flags* to 0. For both methods, *offset* indicates the
1725 * location of the IP checksum within the packet. In addition to
1726 * the size of the field, *flags* can be added (bitwise OR) actual
1727 * flags. With **BPF_F_MARK_MANGLED_0**, a null checksum is left
1728 * untouched (unless **BPF_F_MARK_ENFORCE** is added as well), and
1729 * for updates resulting in a null checksum the value is set to
1730 * **CSUM_MANGLED_0** instead. Flag **BPF_F_PSEUDO_HDR** indicates
1731 * the checksum is to be computed against a pseudo-header.
1733 * This helper works in combination with **bpf_csum_diff**\ (),
1734 * which does not update the checksum in-place, but offers more
1735 * flexibility and can handle sizes larger than 2 or 4 for the
1736 * checksum to update.
1738 * A call to this helper is susceptible to change the underlying
1739 * packet buffer. Therefore, at load time, all checks on pointers
1740 * previously done by the verifier are invalidated and must be
1741 * performed again, if the helper is used in combination with
1742 * direct packet access.
1744 * 0 on success, or a negative error in case of failure.
1746 * long bpf_tail_call(void *ctx, struct bpf_map *prog_array_map, u32 index)
1748 * This special helper is used to trigger a "tail call", or in
1749 * other words, to jump into another eBPF program. The same stack
1750 * frame is used (but values on stack and in registers for the
1751 * caller are not accessible to the callee). This mechanism allows
1752 * for program chaining, either for raising the maximum number of
1753 * available eBPF instructions, or to execute given programs in
1754 * conditional blocks. For security reasons, there is an upper
1755 * limit to the number of successive tail calls that can be
1758 * Upon call of this helper, the program attempts to jump into a
1759 * program referenced at index *index* in *prog_array_map*, a
1760 * special map of type **BPF_MAP_TYPE_PROG_ARRAY**, and passes
1761 * *ctx*, a pointer to the context.
1763 * If the call succeeds, the kernel immediately runs the first
1764 * instruction of the new program. This is not a function call,
1765 * and it never returns to the previous program. If the call
1766 * fails, then the helper has no effect, and the caller continues
1767 * to run its subsequent instructions. A call can fail if the
1768 * destination program for the jump does not exist (i.e. *index*
1769 * is superior to the number of entries in *prog_array_map*), or
1770 * if the maximum number of tail calls has been reached for this
1771 * chain of programs. This limit is defined in the kernel by the
1772 * macro **MAX_TAIL_CALL_CNT** (not accessible to user space),
1773 * which is currently set to 33.
1775 * 0 on success, or a negative error in case of failure.
1777 * long bpf_clone_redirect(struct sk_buff *skb, u32 ifindex, u64 flags)
1779 * Clone and redirect the packet associated to *skb* to another
1780 * net device of index *ifindex*. Both ingress and egress
1781 * interfaces can be used for redirection. The **BPF_F_INGRESS**
1782 * value in *flags* is used to make the distinction (ingress path
1783 * is selected if the flag is present, egress path otherwise).
1784 * This is the only flag supported for now.
1786 * In comparison with **bpf_redirect**\ () helper,
1787 * **bpf_clone_redirect**\ () has the associated cost of
1788 * duplicating the packet buffer, but this can be executed out of
1789 * the eBPF program. Conversely, **bpf_redirect**\ () is more
1790 * efficient, but it is handled through an action code where the
1791 * redirection happens only after the eBPF program has returned.
1793 * A call to this helper is susceptible to change the underlying
1794 * packet buffer. Therefore, at load time, all checks on pointers
1795 * previously done by the verifier are invalidated and must be
1796 * performed again, if the helper is used in combination with
1797 * direct packet access.
1799 * 0 on success, or a negative error in case of failure.
1801 * u64 bpf_get_current_pid_tgid(void)
1803 * Get the current pid and tgid.
1805 * A 64-bit integer containing the current tgid and pid, and
1807 * *current_task*\ **->tgid << 32 \|**
1808 * *current_task*\ **->pid**.
1810 * u64 bpf_get_current_uid_gid(void)
1812 * Get the current uid and gid.
1814 * A 64-bit integer containing the current GID and UID, and
1815 * created as such: *current_gid* **<< 32 \|** *current_uid*.
1817 * long bpf_get_current_comm(void *buf, u32 size_of_buf)
1819 * Copy the **comm** attribute of the current task into *buf* of
1820 * *size_of_buf*. The **comm** attribute contains the name of
1821 * the executable (excluding the path) for the current task. The
1822 * *size_of_buf* must be strictly positive. On success, the
1823 * helper makes sure that the *buf* is NUL-terminated. On failure,
1824 * it is filled with zeroes.
1826 * 0 on success, or a negative error in case of failure.
1828 * u32 bpf_get_cgroup_classid(struct sk_buff *skb)
1830 * Retrieve the classid for the current task, i.e. for the net_cls
1831 * cgroup to which *skb* belongs.
1833 * This helper can be used on TC egress path, but not on ingress.
1835 * The net_cls cgroup provides an interface to tag network packets
1836 * based on a user-provided identifier for all traffic coming from
1837 * the tasks belonging to the related cgroup. See also the related
1838 * kernel documentation, available from the Linux sources in file
1839 * *Documentation/admin-guide/cgroup-v1/net_cls.rst*.
1841 * The Linux kernel has two versions for cgroups: there are
1842 * cgroups v1 and cgroups v2. Both are available to users, who can
1843 * use a mixture of them, but note that the net_cls cgroup is for
1844 * cgroup v1 only. This makes it incompatible with BPF programs
1845 * run on cgroups, which is a cgroup-v2-only feature (a socket can
1846 * only hold data for one version of cgroups at a time).
1848 * This helper is only available is the kernel was compiled with
1849 * the **CONFIG_CGROUP_NET_CLASSID** configuration option set to
1850 * "**y**" or to "**m**".
1852 * The classid, or 0 for the default unconfigured classid.
1854 * long bpf_skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci)
1856 * Push a *vlan_tci* (VLAN tag control information) of protocol
1857 * *vlan_proto* to the packet associated to *skb*, then update
1858 * the checksum. Note that if *vlan_proto* is different from
1859 * **ETH_P_8021Q** and **ETH_P_8021AD**, it is considered to
1860 * be **ETH_P_8021Q**.
1862 * A call to this helper is susceptible to change the underlying
1863 * packet buffer. Therefore, at load time, all checks on pointers
1864 * previously done by the verifier are invalidated and must be
1865 * performed again, if the helper is used in combination with
1866 * direct packet access.
1868 * 0 on success, or a negative error in case of failure.
1870 * long bpf_skb_vlan_pop(struct sk_buff *skb)
1872 * Pop a VLAN header from the packet associated to *skb*.
1874 * A call to this helper is susceptible to change the underlying
1875 * packet buffer. Therefore, at load time, all checks on pointers
1876 * previously done by the verifier are invalidated and must be
1877 * performed again, if the helper is used in combination with
1878 * direct packet access.
1880 * 0 on success, or a negative error in case of failure.
1882 * long bpf_skb_get_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
1884 * Get tunnel metadata. This helper takes a pointer *key* to an
1885 * empty **struct bpf_tunnel_key** of **size**, that will be
1886 * filled with tunnel metadata for the packet associated to *skb*.
1887 * The *flags* can be set to **BPF_F_TUNINFO_IPV6**, which
1888 * indicates that the tunnel is based on IPv6 protocol instead of
1891 * The **struct bpf_tunnel_key** is an object that generalizes the
1892 * principal parameters used by various tunneling protocols into a
1893 * single struct. This way, it can be used to easily make a
1894 * decision based on the contents of the encapsulation header,
1895 * "summarized" in this struct. In particular, it holds the IP
1896 * address of the remote end (IPv4 or IPv6, depending on the case)
1897 * in *key*\ **->remote_ipv4** or *key*\ **->remote_ipv6**. Also,
1898 * this struct exposes the *key*\ **->tunnel_id**, which is
1899 * generally mapped to a VNI (Virtual Network Identifier), making
1900 * it programmable together with the **bpf_skb_set_tunnel_key**\
1903 * Let's imagine that the following code is part of a program
1904 * attached to the TC ingress interface, on one end of a GRE
1905 * tunnel, and is supposed to filter out all messages coming from
1906 * remote ends with IPv4 address other than 10.0.0.1:
1911 * struct bpf_tunnel_key key = {};
1913 * ret = bpf_skb_get_tunnel_key(skb, &key, sizeof(key), 0);
1915 * return TC_ACT_SHOT; // drop packet
1917 * if (key.remote_ipv4 != 0x0a000001)
1918 * return TC_ACT_SHOT; // drop packet
1920 * return TC_ACT_OK; // accept packet
1922 * This interface can also be used with all encapsulation devices
1923 * that can operate in "collect metadata" mode: instead of having
1924 * one network device per specific configuration, the "collect
1925 * metadata" mode only requires a single device where the
1926 * configuration can be extracted from this helper.
1928 * This can be used together with various tunnels such as VXLan,
1929 * Geneve, GRE or IP in IP (IPIP).
1931 * 0 on success, or a negative error in case of failure.
1933 * long bpf_skb_set_tunnel_key(struct sk_buff *skb, struct bpf_tunnel_key *key, u32 size, u64 flags)
1935 * Populate tunnel metadata for packet associated to *skb.* The
1936 * tunnel metadata is set to the contents of *key*, of *size*. The
1937 * *flags* can be set to a combination of the following values:
1939 * **BPF_F_TUNINFO_IPV6**
1940 * Indicate that the tunnel is based on IPv6 protocol
1942 * **BPF_F_ZERO_CSUM_TX**
1943 * For IPv4 packets, add a flag to tunnel metadata
1944 * indicating that checksum computation should be skipped
1945 * and checksum set to zeroes.
1946 * **BPF_F_DONT_FRAGMENT**
1947 * Add a flag to tunnel metadata indicating that the
1948 * packet should not be fragmented.
1949 * **BPF_F_SEQ_NUMBER**
1950 * Add a flag to tunnel metadata indicating that a
1951 * sequence number should be added to tunnel header before
1952 * sending the packet. This flag was added for GRE
1953 * encapsulation, but might be used with other protocols
1954 * as well in the future.
1956 * Here is a typical usage on the transmit path:
1960 * struct bpf_tunnel_key key;
1962 * bpf_skb_set_tunnel_key(skb, &key, sizeof(key), 0);
1963 * bpf_clone_redirect(skb, vxlan_dev_ifindex, 0);
1965 * See also the description of the **bpf_skb_get_tunnel_key**\ ()
1966 * helper for additional information.
1968 * 0 on success, or a negative error in case of failure.
1970 * u64 bpf_perf_event_read(struct bpf_map *map, u64 flags)
1972 * Read the value of a perf event counter. This helper relies on a
1973 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of
1974 * the perf event counter is selected when *map* is updated with
1975 * perf event file descriptors. The *map* is an array whose size
1976 * is the number of available CPUs, and each cell contains a value
1977 * relative to one CPU. The value to retrieve is indicated by
1978 * *flags*, that contains the index of the CPU to look up, masked
1979 * with **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
1980 * **BPF_F_CURRENT_CPU** to indicate that the value for the
1981 * current CPU should be retrieved.
1983 * Note that before Linux 4.13, only hardware perf event can be
1986 * Also, be aware that the newer helper
1987 * **bpf_perf_event_read_value**\ () is recommended over
1988 * **bpf_perf_event_read**\ () in general. The latter has some ABI
1989 * quirks where error and counter value are used as a return code
1990 * (which is wrong to do since ranges may overlap). This issue is
1991 * fixed with **bpf_perf_event_read_value**\ (), which at the same
1992 * time provides more features over the **bpf_perf_event_read**\
1993 * () interface. Please refer to the description of
1994 * **bpf_perf_event_read_value**\ () for details.
1996 * The value of the perf event counter read from the map, or a
1997 * negative error code in case of failure.
1999 * long bpf_redirect(u32 ifindex, u64 flags)
2001 * Redirect the packet to another net device of index *ifindex*.
2002 * This helper is somewhat similar to **bpf_clone_redirect**\
2003 * (), except that the packet is not cloned, which provides
2004 * increased performance.
2006 * Except for XDP, both ingress and egress interfaces can be used
2007 * for redirection. The **BPF_F_INGRESS** value in *flags* is used
2008 * to make the distinction (ingress path is selected if the flag
2009 * is present, egress path otherwise). Currently, XDP only
2010 * supports redirection to the egress interface, and accepts no
2013 * The same effect can also be attained with the more generic
2014 * **bpf_redirect_map**\ (), which uses a BPF map to store the
2015 * redirect target instead of providing it directly to the helper.
2017 * For XDP, the helper returns **XDP_REDIRECT** on success or
2018 * **XDP_ABORTED** on error. For other program types, the values
2019 * are **TC_ACT_REDIRECT** on success or **TC_ACT_SHOT** on
2022 * u32 bpf_get_route_realm(struct sk_buff *skb)
2024 * Retrieve the realm or the route, that is to say the
2025 * **tclassid** field of the destination for the *skb*. The
2026 * identifier retrieved is a user-provided tag, similar to the
2027 * one used with the net_cls cgroup (see description for
2028 * **bpf_get_cgroup_classid**\ () helper), but here this tag is
2029 * held by a route (a destination entry), not by a task.
2031 * Retrieving this identifier works with the clsact TC egress hook
2032 * (see also **tc-bpf(8)**), or alternatively on conventional
2033 * classful egress qdiscs, but not on TC ingress path. In case of
2034 * clsact TC egress hook, this has the advantage that, internally,
2035 * the destination entry has not been dropped yet in the transmit
2036 * path. Therefore, the destination entry does not need to be
2037 * artificially held via **netif_keep_dst**\ () for a classful
2038 * qdisc until the *skb* is freed.
2040 * This helper is available only if the kernel was compiled with
2041 * **CONFIG_IP_ROUTE_CLASSID** configuration option.
2043 * The realm of the route for the packet associated to *skb*, or 0
2044 * if none was found.
2046 * long bpf_perf_event_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
2048 * Write raw *data* blob into a special BPF perf event held by
2049 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
2050 * event must have the following attributes: **PERF_SAMPLE_RAW**
2051 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
2052 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
2054 * The *flags* are used to indicate the index in *map* for which
2055 * the value must be put, masked with **BPF_F_INDEX_MASK**.
2056 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
2057 * to indicate that the index of the current CPU core should be
2060 * The value to write, of *size*, is passed through eBPF stack and
2061 * pointed by *data*.
2063 * The context of the program *ctx* needs also be passed to the
2066 * On user space, a program willing to read the values needs to
2067 * call **perf_event_open**\ () on the perf event (either for
2068 * one or for all CPUs) and to store the file descriptor into the
2069 * *map*. This must be done before the eBPF program can send data
2070 * into it. An example is available in file
2071 * *samples/bpf/trace_output_user.c* in the Linux kernel source
2072 * tree (the eBPF program counterpart is in
2073 * *samples/bpf/trace_output_kern.c*).
2075 * **bpf_perf_event_output**\ () achieves better performance
2076 * than **bpf_trace_printk**\ () for sharing data with user
2077 * space, and is much better suitable for streaming data from eBPF
2080 * Note that this helper is not restricted to tracing use cases
2081 * and can be used with programs attached to TC or XDP as well,
2082 * where it allows for passing data to user space listeners. Data
2085 * * Only custom structs,
2086 * * Only the packet payload, or
2087 * * A combination of both.
2089 * 0 on success, or a negative error in case of failure.
2091 * long bpf_skb_load_bytes(const void *skb, u32 offset, void *to, u32 len)
2093 * This helper was provided as an easy way to load data from a
2094 * packet. It can be used to load *len* bytes from *offset* from
2095 * the packet associated to *skb*, into the buffer pointed by
2098 * Since Linux 4.7, usage of this helper has mostly been replaced
2099 * by "direct packet access", enabling packet data to be
2100 * manipulated with *skb*\ **->data** and *skb*\ **->data_end**
2101 * pointing respectively to the first byte of packet data and to
2102 * the byte after the last byte of packet data. However, it
2103 * remains useful if one wishes to read large quantities of data
2104 * at once from a packet into the eBPF stack.
2106 * 0 on success, or a negative error in case of failure.
2108 * long bpf_get_stackid(void *ctx, struct bpf_map *map, u64 flags)
2110 * Walk a user or a kernel stack and return its id. To achieve
2111 * this, the helper needs *ctx*, which is a pointer to the context
2112 * on which the tracing program is executed, and a pointer to a
2113 * *map* of type **BPF_MAP_TYPE_STACK_TRACE**.
2115 * The last argument, *flags*, holds the number of stack frames to
2116 * skip (from 0 to 255), masked with
2117 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
2118 * a combination of the following flags:
2120 * **BPF_F_USER_STACK**
2121 * Collect a user space stack instead of a kernel stack.
2122 * **BPF_F_FAST_STACK_CMP**
2123 * Compare stacks by hash only.
2124 * **BPF_F_REUSE_STACKID**
2125 * If two different stacks hash into the same *stackid*,
2126 * discard the old one.
2128 * The stack id retrieved is a 32 bit long integer handle which
2129 * can be further combined with other data (including other stack
2130 * ids) and used as a key into maps. This can be useful for
2131 * generating a variety of graphs (such as flame graphs or off-cpu
2134 * For walking a stack, this helper is an improvement over
2135 * **bpf_probe_read**\ (), which can be used with unrolled loops
2136 * but is not efficient and consumes a lot of eBPF instructions.
2137 * Instead, **bpf_get_stackid**\ () can collect up to
2138 * **PERF_MAX_STACK_DEPTH** both kernel and user frames. Note that
2139 * this limit can be controlled with the **sysctl** program, and
2140 * that it should be manually increased in order to profile long
2141 * user stacks (such as stacks for Java programs). To do so, use:
2145 * # sysctl kernel.perf_event_max_stack=<new value>
2147 * The positive or null stack id on success, or a negative error
2148 * in case of failure.
2150 * s64 bpf_csum_diff(__be32 *from, u32 from_size, __be32 *to, u32 to_size, __wsum seed)
2152 * Compute a checksum difference, from the raw buffer pointed by
2153 * *from*, of length *from_size* (that must be a multiple of 4),
2154 * towards the raw buffer pointed by *to*, of size *to_size*
2155 * (same remark). An optional *seed* can be added to the value
2156 * (this can be cascaded, the seed may come from a previous call
2159 * This is flexible enough to be used in several ways:
2161 * * With *from_size* == 0, *to_size* > 0 and *seed* set to
2162 * checksum, it can be used when pushing new data.
2163 * * With *from_size* > 0, *to_size* == 0 and *seed* set to
2164 * checksum, it can be used when removing data from a packet.
2165 * * With *from_size* > 0, *to_size* > 0 and *seed* set to 0, it
2166 * can be used to compute a diff. Note that *from_size* and
2167 * *to_size* do not need to be equal.
2169 * This helper can be used in combination with
2170 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\ (), to
2171 * which one can feed in the difference computed with
2172 * **bpf_csum_diff**\ ().
2174 * The checksum result, or a negative error code in case of
2177 * long bpf_skb_get_tunnel_opt(struct sk_buff *skb, void *opt, u32 size)
2179 * Retrieve tunnel options metadata for the packet associated to
2180 * *skb*, and store the raw tunnel option data to the buffer *opt*
2183 * This helper can be used with encapsulation devices that can
2184 * operate in "collect metadata" mode (please refer to the related
2185 * note in the description of **bpf_skb_get_tunnel_key**\ () for
2186 * more details). A particular example where this can be used is
2187 * in combination with the Geneve encapsulation protocol, where it
2188 * allows for pushing (with **bpf_skb_get_tunnel_opt**\ () helper)
2189 * and retrieving arbitrary TLVs (Type-Length-Value headers) from
2190 * the eBPF program. This allows for full customization of these
2193 * The size of the option data retrieved.
2195 * long bpf_skb_set_tunnel_opt(struct sk_buff *skb, void *opt, u32 size)
2197 * Set tunnel options metadata for the packet associated to *skb*
2198 * to the option data contained in the raw buffer *opt* of *size*.
2200 * See also the description of the **bpf_skb_get_tunnel_opt**\ ()
2201 * helper for additional information.
2203 * 0 on success, or a negative error in case of failure.
2205 * long bpf_skb_change_proto(struct sk_buff *skb, __be16 proto, u64 flags)
2207 * Change the protocol of the *skb* to *proto*. Currently
2208 * supported are transition from IPv4 to IPv6, and from IPv6 to
2209 * IPv4. The helper takes care of the groundwork for the
2210 * transition, including resizing the socket buffer. The eBPF
2211 * program is expected to fill the new headers, if any, via
2212 * **skb_store_bytes**\ () and to recompute the checksums with
2213 * **bpf_l3_csum_replace**\ () and **bpf_l4_csum_replace**\
2214 * (). The main case for this helper is to perform NAT64
2215 * operations out of an eBPF program.
2217 * Internally, the GSO type is marked as dodgy so that headers are
2218 * checked and segments are recalculated by the GSO/GRO engine.
2219 * The size for GSO target is adapted as well.
2221 * All values for *flags* are reserved for future usage, and must
2224 * A call to this helper is susceptible to change the underlying
2225 * packet buffer. Therefore, at load time, all checks on pointers
2226 * previously done by the verifier are invalidated and must be
2227 * performed again, if the helper is used in combination with
2228 * direct packet access.
2230 * 0 on success, or a negative error in case of failure.
2232 * long bpf_skb_change_type(struct sk_buff *skb, u32 type)
2234 * Change the packet type for the packet associated to *skb*. This
2235 * comes down to setting *skb*\ **->pkt_type** to *type*, except
2236 * the eBPF program does not have a write access to *skb*\
2237 * **->pkt_type** beside this helper. Using a helper here allows
2238 * for graceful handling of errors.
2240 * The major use case is to change incoming *skb*s to
2241 * **PACKET_HOST** in a programmatic way instead of having to
2242 * recirculate via **redirect**\ (..., **BPF_F_INGRESS**), for
2245 * Note that *type* only allows certain values. At this time, they
2250 * **PACKET_BROADCAST**
2251 * Send packet to all.
2252 * **PACKET_MULTICAST**
2253 * Send packet to group.
2254 * **PACKET_OTHERHOST**
2255 * Send packet to someone else.
2257 * 0 on success, or a negative error in case of failure.
2259 * long bpf_skb_under_cgroup(struct sk_buff *skb, struct bpf_map *map, u32 index)
2261 * Check whether *skb* is a descendant of the cgroup2 held by
2262 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
2264 * The return value depends on the result of the test, and can be:
2266 * * 0, if the *skb* failed the cgroup2 descendant test.
2267 * * 1, if the *skb* succeeded the cgroup2 descendant test.
2268 * * A negative error code, if an error occurred.
2270 * u32 bpf_get_hash_recalc(struct sk_buff *skb)
2272 * Retrieve the hash of the packet, *skb*\ **->hash**. If it is
2273 * not set, in particular if the hash was cleared due to mangling,
2274 * recompute this hash. Later accesses to the hash can be done
2275 * directly with *skb*\ **->hash**.
2277 * Calling **bpf_set_hash_invalid**\ (), changing a packet
2278 * prototype with **bpf_skb_change_proto**\ (), or calling
2279 * **bpf_skb_store_bytes**\ () with the
2280 * **BPF_F_INVALIDATE_HASH** are actions susceptible to clear
2281 * the hash and to trigger a new computation for the next call to
2282 * **bpf_get_hash_recalc**\ ().
2286 * u64 bpf_get_current_task(void)
2288 * Get the current task.
2290 * A pointer to the current task struct.
2292 * long bpf_probe_write_user(void *dst, const void *src, u32 len)
2294 * Attempt in a safe way to write *len* bytes from the buffer
2295 * *src* to *dst* in memory. It only works for threads that are in
2296 * user context, and *dst* must be a valid user space address.
2298 * This helper should not be used to implement any kind of
2299 * security mechanism because of TOC-TOU attacks, but rather to
2300 * debug, divert, and manipulate execution of semi-cooperative
2303 * Keep in mind that this feature is meant for experiments, and it
2304 * has a risk of crashing the system and running programs.
2305 * Therefore, when an eBPF program using this helper is attached,
2306 * a warning including PID and process name is printed to kernel
2309 * 0 on success, or a negative error in case of failure.
2311 * long bpf_current_task_under_cgroup(struct bpf_map *map, u32 index)
2313 * Check whether the probe is being run is the context of a given
2314 * subset of the cgroup2 hierarchy. The cgroup2 to test is held by
2315 * *map* of type **BPF_MAP_TYPE_CGROUP_ARRAY**, at *index*.
2317 * The return value depends on the result of the test, and can be:
2319 * * 1, if current task belongs to the cgroup2.
2320 * * 0, if current task does not belong to the cgroup2.
2321 * * A negative error code, if an error occurred.
2323 * long bpf_skb_change_tail(struct sk_buff *skb, u32 len, u64 flags)
2325 * Resize (trim or grow) the packet associated to *skb* to the
2326 * new *len*. The *flags* are reserved for future usage, and must
2329 * The basic idea is that the helper performs the needed work to
2330 * change the size of the packet, then the eBPF program rewrites
2331 * the rest via helpers like **bpf_skb_store_bytes**\ (),
2332 * **bpf_l3_csum_replace**\ (), **bpf_l3_csum_replace**\ ()
2333 * and others. This helper is a slow path utility intended for
2334 * replies with control messages. And because it is targeted for
2335 * slow path, the helper itself can afford to be slow: it
2336 * implicitly linearizes, unclones and drops offloads from the
2339 * A call to this helper is susceptible to change the underlying
2340 * packet buffer. Therefore, at load time, all checks on pointers
2341 * previously done by the verifier are invalidated and must be
2342 * performed again, if the helper is used in combination with
2343 * direct packet access.
2345 * 0 on success, or a negative error in case of failure.
2347 * long bpf_skb_pull_data(struct sk_buff *skb, u32 len)
2349 * Pull in non-linear data in case the *skb* is non-linear and not
2350 * all of *len* are part of the linear section. Make *len* bytes
2351 * from *skb* readable and writable. If a zero value is passed for
2352 * *len*, then the whole length of the *skb* is pulled.
2354 * This helper is only needed for reading and writing with direct
2357 * For direct packet access, testing that offsets to access
2358 * are within packet boundaries (test on *skb*\ **->data_end**) is
2359 * susceptible to fail if offsets are invalid, or if the requested
2360 * data is in non-linear parts of the *skb*. On failure the
2361 * program can just bail out, or in the case of a non-linear
2362 * buffer, use a helper to make the data available. The
2363 * **bpf_skb_load_bytes**\ () helper is a first solution to access
2364 * the data. Another one consists in using **bpf_skb_pull_data**
2365 * to pull in once the non-linear parts, then retesting and
2366 * eventually access the data.
2368 * At the same time, this also makes sure the *skb* is uncloned,
2369 * which is a necessary condition for direct write. As this needs
2370 * to be an invariant for the write part only, the verifier
2371 * detects writes and adds a prologue that is calling
2372 * **bpf_skb_pull_data()** to effectively unclone the *skb* from
2373 * the very beginning in case it is indeed cloned.
2375 * A call to this helper is susceptible to change the underlying
2376 * packet buffer. Therefore, at load time, all checks on pointers
2377 * previously done by the verifier are invalidated and must be
2378 * performed again, if the helper is used in combination with
2379 * direct packet access.
2381 * 0 on success, or a negative error in case of failure.
2383 * s64 bpf_csum_update(struct sk_buff *skb, __wsum csum)
2385 * Add the checksum *csum* into *skb*\ **->csum** in case the
2386 * driver has supplied a checksum for the entire packet into that
2387 * field. Return an error otherwise. This helper is intended to be
2388 * used in combination with **bpf_csum_diff**\ (), in particular
2389 * when the checksum needs to be updated after data has been
2390 * written into the packet through direct packet access.
2392 * The checksum on success, or a negative error code in case of
2395 * void bpf_set_hash_invalid(struct sk_buff *skb)
2397 * Invalidate the current *skb*\ **->hash**. It can be used after
2398 * mangling on headers through direct packet access, in order to
2399 * indicate that the hash is outdated and to trigger a
2400 * recalculation the next time the kernel tries to access this
2401 * hash or when the **bpf_get_hash_recalc**\ () helper is called.
2405 * long bpf_get_numa_node_id(void)
2407 * Return the id of the current NUMA node. The primary use case
2408 * for this helper is the selection of sockets for the local NUMA
2409 * node, when the program is attached to sockets using the
2410 * **SO_ATTACH_REUSEPORT_EBPF** option (see also **socket(7)**),
2411 * but the helper is also available to other eBPF program types,
2412 * similarly to **bpf_get_smp_processor_id**\ ().
2414 * The id of current NUMA node.
2416 * long bpf_skb_change_head(struct sk_buff *skb, u32 len, u64 flags)
2418 * Grows headroom of packet associated to *skb* and adjusts the
2419 * offset of the MAC header accordingly, adding *len* bytes of
2420 * space. It automatically extends and reallocates memory as
2423 * This helper can be used on a layer 3 *skb* to push a MAC header
2424 * for redirection into a layer 2 device.
2426 * All values for *flags* are reserved for future usage, and must
2429 * A call to this helper is susceptible to change the underlying
2430 * packet buffer. Therefore, at load time, all checks on pointers
2431 * previously done by the verifier are invalidated and must be
2432 * performed again, if the helper is used in combination with
2433 * direct packet access.
2435 * 0 on success, or a negative error in case of failure.
2437 * long bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta)
2439 * Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that
2440 * it is possible to use a negative value for *delta*. This helper
2441 * can be used to prepare the packet for pushing or popping
2444 * A call to this helper is susceptible to change the underlying
2445 * packet buffer. Therefore, at load time, all checks on pointers
2446 * previously done by the verifier are invalidated and must be
2447 * performed again, if the helper is used in combination with
2448 * direct packet access.
2450 * 0 on success, or a negative error in case of failure.
2452 * long bpf_probe_read_str(void *dst, u32 size, const void *unsafe_ptr)
2454 * Copy a NUL terminated string from an unsafe kernel address
2455 * *unsafe_ptr* to *dst*. See **bpf_probe_read_kernel_str**\ () for
2458 * Generally, use **bpf_probe_read_user_str**\ () or
2459 * **bpf_probe_read_kernel_str**\ () instead.
2461 * On success, the strictly positive length of the string,
2462 * including the trailing NUL character. On error, a negative
2465 * u64 bpf_get_socket_cookie(struct sk_buff *skb)
2467 * If the **struct sk_buff** pointed by *skb* has a known socket,
2468 * retrieve the cookie (generated by the kernel) of this socket.
2469 * If no cookie has been set yet, generate a new cookie. Once
2470 * generated, the socket cookie remains stable for the life of the
2471 * socket. This helper can be useful for monitoring per socket
2472 * networking traffic statistics as it provides a global socket
2473 * identifier that can be assumed unique.
2475 * A 8-byte long unique number on success, or 0 if the socket
2476 * field is missing inside *skb*.
2478 * u64 bpf_get_socket_cookie(struct bpf_sock_addr *ctx)
2480 * Equivalent to bpf_get_socket_cookie() helper that accepts
2481 * *skb*, but gets socket from **struct bpf_sock_addr** context.
2483 * A 8-byte long unique number.
2485 * u64 bpf_get_socket_cookie(struct bpf_sock_ops *ctx)
2487 * Equivalent to **bpf_get_socket_cookie**\ () helper that accepts
2488 * *skb*, but gets socket from **struct bpf_sock_ops** context.
2490 * A 8-byte long unique number.
2492 * u64 bpf_get_socket_cookie(struct sock *sk)
2494 * Equivalent to **bpf_get_socket_cookie**\ () helper that accepts
2495 * *sk*, but gets socket from a BTF **struct sock**. This helper
2496 * also works for sleepable programs.
2498 * A 8-byte long unique number or 0 if *sk* is NULL.
2500 * u32 bpf_get_socket_uid(struct sk_buff *skb)
2502 * Get the owner UID of the socked associated to *skb*.
2504 * The owner UID of the socket associated to *skb*. If the socket
2505 * is **NULL**, or if it is not a full socket (i.e. if it is a
2506 * time-wait or a request socket instead), **overflowuid** value
2507 * is returned (note that **overflowuid** might also be the actual
2508 * UID value for the socket).
2510 * long bpf_set_hash(struct sk_buff *skb, u32 hash)
2512 * Set the full hash for *skb* (set the field *skb*\ **->hash**)
2517 * long bpf_setsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen)
2519 * Emulate a call to **setsockopt()** on the socket associated to
2520 * *bpf_socket*, which must be a full socket. The *level* at
2521 * which the option resides and the name *optname* of the option
2522 * must be specified, see **setsockopt(2)** for more information.
2523 * The option value of length *optlen* is pointed by *optval*.
2525 * *bpf_socket* should be one of the following:
2527 * * **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**.
2528 * * **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT**
2529 * and **BPF_CGROUP_INET6_CONNECT**.
2531 * This helper actually implements a subset of **setsockopt()**.
2532 * It supports the following *level*\ s:
2534 * * **SOL_SOCKET**, which supports the following *optname*\ s:
2535 * **SO_RCVBUF**, **SO_SNDBUF**, **SO_MAX_PACING_RATE**,
2536 * **SO_PRIORITY**, **SO_RCVLOWAT**, **SO_MARK**,
2537 * **SO_BINDTODEVICE**, **SO_KEEPALIVE**.
2538 * * **IPPROTO_TCP**, which supports the following *optname*\ s:
2539 * **TCP_CONGESTION**, **TCP_BPF_IW**,
2540 * **TCP_BPF_SNDCWND_CLAMP**, **TCP_SAVE_SYN**,
2541 * **TCP_KEEPIDLE**, **TCP_KEEPINTVL**, **TCP_KEEPCNT**,
2542 * **TCP_SYNCNT**, **TCP_USER_TIMEOUT**, **TCP_NOTSENT_LOWAT**.
2543 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
2544 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
2546 * 0 on success, or a negative error in case of failure.
2548 * long bpf_skb_adjust_room(struct sk_buff *skb, s32 len_diff, u32 mode, u64 flags)
2550 * Grow or shrink the room for data in the packet associated to
2551 * *skb* by *len_diff*, and according to the selected *mode*.
2553 * By default, the helper will reset any offloaded checksum
2554 * indicator of the skb to CHECKSUM_NONE. This can be avoided
2555 * by the following flag:
2557 * * **BPF_F_ADJ_ROOM_NO_CSUM_RESET**: Do not reset offloaded
2558 * checksum data of the skb to CHECKSUM_NONE.
2560 * There are two supported modes at this time:
2562 * * **BPF_ADJ_ROOM_MAC**: Adjust room at the mac layer
2563 * (room space is added or removed below the layer 2 header).
2565 * * **BPF_ADJ_ROOM_NET**: Adjust room at the network layer
2566 * (room space is added or removed below the layer 3 header).
2568 * The following flags are supported at this time:
2570 * * **BPF_F_ADJ_ROOM_FIXED_GSO**: Do not adjust gso_size.
2571 * Adjusting mss in this way is not allowed for datagrams.
2573 * * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV4**,
2574 * **BPF_F_ADJ_ROOM_ENCAP_L3_IPV6**:
2575 * Any new space is reserved to hold a tunnel header.
2576 * Configure skb offsets and other fields accordingly.
2578 * * **BPF_F_ADJ_ROOM_ENCAP_L4_GRE**,
2579 * **BPF_F_ADJ_ROOM_ENCAP_L4_UDP**:
2580 * Use with ENCAP_L3 flags to further specify the tunnel type.
2582 * * **BPF_F_ADJ_ROOM_ENCAP_L2**\ (*len*):
2583 * Use with ENCAP_L3/L4 flags to further specify the tunnel
2584 * type; *len* is the length of the inner MAC header.
2586 * * **BPF_F_ADJ_ROOM_ENCAP_L2_ETH**:
2587 * Use with BPF_F_ADJ_ROOM_ENCAP_L2 flag to further specify the
2588 * L2 type as Ethernet.
2590 * A call to this helper is susceptible to change the underlying
2591 * packet buffer. Therefore, at load time, all checks on pointers
2592 * previously done by the verifier are invalidated and must be
2593 * performed again, if the helper is used in combination with
2594 * direct packet access.
2596 * 0 on success, or a negative error in case of failure.
2598 * long bpf_redirect_map(struct bpf_map *map, u32 key, u64 flags)
2600 * Redirect the packet to the endpoint referenced by *map* at
2601 * index *key*. Depending on its type, this *map* can contain
2602 * references to net devices (for forwarding packets through other
2603 * ports), or to CPUs (for redirecting XDP frames to another CPU;
2604 * but this is only implemented for native XDP (with driver
2605 * support) as of this writing).
2607 * The lower two bits of *flags* are used as the return code if
2608 * the map lookup fails. This is so that the return value can be
2609 * one of the XDP program return codes up to **XDP_TX**, as chosen
2610 * by the caller. The higher bits of *flags* can be set to
2611 * BPF_F_BROADCAST or BPF_F_EXCLUDE_INGRESS as defined below.
2613 * With BPF_F_BROADCAST the packet will be broadcasted to all the
2614 * interfaces in the map, with BPF_F_EXCLUDE_INGRESS the ingress
2615 * interface will be excluded when do broadcasting.
2617 * See also **bpf_redirect**\ (), which only supports redirecting
2618 * to an ifindex, but doesn't require a map to do so.
2620 * **XDP_REDIRECT** on success, or the value of the two lower bits
2621 * of the *flags* argument on error.
2623 * long bpf_sk_redirect_map(struct sk_buff *skb, struct bpf_map *map, u32 key, u64 flags)
2625 * Redirect the packet to the socket referenced by *map* (of type
2626 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
2627 * egress interfaces can be used for redirection. The
2628 * **BPF_F_INGRESS** value in *flags* is used to make the
2629 * distinction (ingress path is selected if the flag is present,
2630 * egress path otherwise). This is the only flag supported for now.
2632 * **SK_PASS** on success, or **SK_DROP** on error.
2634 * long bpf_sock_map_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
2636 * Add an entry to, or update a *map* referencing sockets. The
2637 * *skops* is used as a new value for the entry associated to
2638 * *key*. *flags* is one of:
2641 * The entry for *key* must not exist in the map.
2643 * The entry for *key* must already exist in the map.
2645 * No condition on the existence of the entry for *key*.
2647 * If the *map* has eBPF programs (parser and verdict), those will
2648 * be inherited by the socket being added. If the socket is
2649 * already attached to eBPF programs, this results in an error.
2651 * 0 on success, or a negative error in case of failure.
2653 * long bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta)
2655 * Adjust the address pointed by *xdp_md*\ **->data_meta** by
2656 * *delta* (which can be positive or negative). Note that this
2657 * operation modifies the address stored in *xdp_md*\ **->data**,
2658 * so the latter must be loaded only after the helper has been
2661 * The use of *xdp_md*\ **->data_meta** is optional and programs
2662 * are not required to use it. The rationale is that when the
2663 * packet is processed with XDP (e.g. as DoS filter), it is
2664 * possible to push further meta data along with it before passing
2665 * to the stack, and to give the guarantee that an ingress eBPF
2666 * program attached as a TC classifier on the same device can pick
2667 * this up for further post-processing. Since TC works with socket
2668 * buffers, it remains possible to set from XDP the **mark** or
2669 * **priority** pointers, or other pointers for the socket buffer.
2670 * Having this scratch space generic and programmable allows for
2671 * more flexibility as the user is free to store whatever meta
2674 * A call to this helper is susceptible to change the underlying
2675 * packet buffer. Therefore, at load time, all checks on pointers
2676 * previously done by the verifier are invalidated and must be
2677 * performed again, if the helper is used in combination with
2678 * direct packet access.
2680 * 0 on success, or a negative error in case of failure.
2682 * long bpf_perf_event_read_value(struct bpf_map *map, u64 flags, struct bpf_perf_event_value *buf, u32 buf_size)
2684 * Read the value of a perf event counter, and store it into *buf*
2685 * of size *buf_size*. This helper relies on a *map* of type
2686 * **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. The nature of the perf event
2687 * counter is selected when *map* is updated with perf event file
2688 * descriptors. The *map* is an array whose size is the number of
2689 * available CPUs, and each cell contains a value relative to one
2690 * CPU. The value to retrieve is indicated by *flags*, that
2691 * contains the index of the CPU to look up, masked with
2692 * **BPF_F_INDEX_MASK**. Alternatively, *flags* can be set to
2693 * **BPF_F_CURRENT_CPU** to indicate that the value for the
2694 * current CPU should be retrieved.
2696 * This helper behaves in a way close to
2697 * **bpf_perf_event_read**\ () helper, save that instead of
2698 * just returning the value observed, it fills the *buf*
2699 * structure. This allows for additional data to be retrieved: in
2700 * particular, the enabled and running times (in *buf*\
2701 * **->enabled** and *buf*\ **->running**, respectively) are
2702 * copied. In general, **bpf_perf_event_read_value**\ () is
2703 * recommended over **bpf_perf_event_read**\ (), which has some
2704 * ABI issues and provides fewer functionalities.
2706 * These values are interesting, because hardware PMU (Performance
2707 * Monitoring Unit) counters are limited resources. When there are
2708 * more PMU based perf events opened than available counters,
2709 * kernel will multiplex these events so each event gets certain
2710 * percentage (but not all) of the PMU time. In case that
2711 * multiplexing happens, the number of samples or counter value
2712 * will not reflect the case compared to when no multiplexing
2713 * occurs. This makes comparison between different runs difficult.
2714 * Typically, the counter value should be normalized before
2715 * comparing to other experiments. The usual normalization is done
2720 * normalized_counter = counter * t_enabled / t_running
2722 * Where t_enabled is the time enabled for event and t_running is
2723 * the time running for event since last normalization. The
2724 * enabled and running times are accumulated since the perf event
2725 * open. To achieve scaling factor between two invocations of an
2726 * eBPF program, users can use CPU id as the key (which is
2727 * typical for perf array usage model) to remember the previous
2728 * value and do the calculation inside the eBPF program.
2730 * 0 on success, or a negative error in case of failure.
2732 * long bpf_perf_prog_read_value(struct bpf_perf_event_data *ctx, struct bpf_perf_event_value *buf, u32 buf_size)
2734 * For en eBPF program attached to a perf event, retrieve the
2735 * value of the event counter associated to *ctx* and store it in
2736 * the structure pointed by *buf* and of size *buf_size*. Enabled
2737 * and running times are also stored in the structure (see
2738 * description of helper **bpf_perf_event_read_value**\ () for
2741 * 0 on success, or a negative error in case of failure.
2743 * long bpf_getsockopt(void *bpf_socket, int level, int optname, void *optval, int optlen)
2745 * Emulate a call to **getsockopt()** on the socket associated to
2746 * *bpf_socket*, which must be a full socket. The *level* at
2747 * which the option resides and the name *optname* of the option
2748 * must be specified, see **getsockopt(2)** for more information.
2749 * The retrieved value is stored in the structure pointed by
2750 * *opval* and of length *optlen*.
2752 * *bpf_socket* should be one of the following:
2754 * * **struct bpf_sock_ops** for **BPF_PROG_TYPE_SOCK_OPS**.
2755 * * **struct bpf_sock_addr** for **BPF_CGROUP_INET4_CONNECT**
2756 * and **BPF_CGROUP_INET6_CONNECT**.
2758 * This helper actually implements a subset of **getsockopt()**.
2759 * It supports the following *level*\ s:
2761 * * **IPPROTO_TCP**, which supports *optname*
2762 * **TCP_CONGESTION**.
2763 * * **IPPROTO_IP**, which supports *optname* **IP_TOS**.
2764 * * **IPPROTO_IPV6**, which supports *optname* **IPV6_TCLASS**.
2766 * 0 on success, or a negative error in case of failure.
2768 * long bpf_override_return(struct pt_regs *regs, u64 rc)
2770 * Used for error injection, this helper uses kprobes to override
2771 * the return value of the probed function, and to set it to *rc*.
2772 * The first argument is the context *regs* on which the kprobe
2775 * This helper works by setting the PC (program counter)
2776 * to an override function which is run in place of the original
2777 * probed function. This means the probed function is not run at
2778 * all. The replacement function just returns with the required
2781 * This helper has security implications, and thus is subject to
2782 * restrictions. It is only available if the kernel was compiled
2783 * with the **CONFIG_BPF_KPROBE_OVERRIDE** configuration
2784 * option, and in this case it only works on functions tagged with
2785 * **ALLOW_ERROR_INJECTION** in the kernel code.
2787 * Also, the helper is only available for the architectures having
2788 * the CONFIG_FUNCTION_ERROR_INJECTION option. As of this writing,
2789 * x86 architecture is the only one to support this feature.
2793 * long bpf_sock_ops_cb_flags_set(struct bpf_sock_ops *bpf_sock, int argval)
2795 * Attempt to set the value of the **bpf_sock_ops_cb_flags** field
2796 * for the full TCP socket associated to *bpf_sock_ops* to
2799 * The primary use of this field is to determine if there should
2800 * be calls to eBPF programs of type
2801 * **BPF_PROG_TYPE_SOCK_OPS** at various points in the TCP
2802 * code. A program of the same type can change its value, per
2803 * connection and as necessary, when the connection is
2804 * established. This field is directly accessible for reading, but
2805 * this helper must be used for updates in order to return an
2806 * error if an eBPF program tries to set a callback that is not
2807 * supported in the current kernel.
2809 * *argval* is a flag array which can combine these flags:
2811 * * **BPF_SOCK_OPS_RTO_CB_FLAG** (retransmission time out)
2812 * * **BPF_SOCK_OPS_RETRANS_CB_FLAG** (retransmission)
2813 * * **BPF_SOCK_OPS_STATE_CB_FLAG** (TCP state change)
2814 * * **BPF_SOCK_OPS_RTT_CB_FLAG** (every RTT)
2816 * Therefore, this function can be used to clear a callback flag by
2817 * setting the appropriate bit to zero. e.g. to disable the RTO
2820 * **bpf_sock_ops_cb_flags_set(bpf_sock,**
2821 * **bpf_sock->bpf_sock_ops_cb_flags & ~BPF_SOCK_OPS_RTO_CB_FLAG)**
2823 * Here are some examples of where one could call such eBPF
2827 * * When a packet is retransmitted.
2828 * * When the connection terminates.
2829 * * When a packet is sent.
2830 * * When a packet is received.
2832 * Code **-EINVAL** if the socket is not a full TCP socket;
2833 * otherwise, a positive number containing the bits that could not
2834 * be set is returned (which comes down to 0 if all bits were set
2837 * long bpf_msg_redirect_map(struct sk_msg_buff *msg, struct bpf_map *map, u32 key, u64 flags)
2839 * This helper is used in programs implementing policies at the
2840 * socket level. If the message *msg* is allowed to pass (i.e. if
2841 * the verdict eBPF program returns **SK_PASS**), redirect it to
2842 * the socket referenced by *map* (of type
2843 * **BPF_MAP_TYPE_SOCKMAP**) at index *key*. Both ingress and
2844 * egress interfaces can be used for redirection. The
2845 * **BPF_F_INGRESS** value in *flags* is used to make the
2846 * distinction (ingress path is selected if the flag is present,
2847 * egress path otherwise). This is the only flag supported for now.
2849 * **SK_PASS** on success, or **SK_DROP** on error.
2851 * long bpf_msg_apply_bytes(struct sk_msg_buff *msg, u32 bytes)
2853 * For socket policies, apply the verdict of the eBPF program to
2854 * the next *bytes* (number of bytes) of message *msg*.
2856 * For example, this helper can be used in the following cases:
2858 * * A single **sendmsg**\ () or **sendfile**\ () system call
2859 * contains multiple logical messages that the eBPF program is
2860 * supposed to read and for which it should apply a verdict.
2861 * * An eBPF program only cares to read the first *bytes* of a
2862 * *msg*. If the message has a large payload, then setting up
2863 * and calling the eBPF program repeatedly for all bytes, even
2864 * though the verdict is already known, would create unnecessary
2867 * When called from within an eBPF program, the helper sets a
2868 * counter internal to the BPF infrastructure, that is used to
2869 * apply the last verdict to the next *bytes*. If *bytes* is
2870 * smaller than the current data being processed from a
2871 * **sendmsg**\ () or **sendfile**\ () system call, the first
2872 * *bytes* will be sent and the eBPF program will be re-run with
2873 * the pointer for start of data pointing to byte number *bytes*
2874 * **+ 1**. If *bytes* is larger than the current data being
2875 * processed, then the eBPF verdict will be applied to multiple
2876 * **sendmsg**\ () or **sendfile**\ () calls until *bytes* are
2879 * Note that if a socket closes with the internal counter holding
2880 * a non-zero value, this is not a problem because data is not
2881 * being buffered for *bytes* and is sent as it is received.
2885 * long bpf_msg_cork_bytes(struct sk_msg_buff *msg, u32 bytes)
2887 * For socket policies, prevent the execution of the verdict eBPF
2888 * program for message *msg* until *bytes* (byte number) have been
2891 * This can be used when one needs a specific number of bytes
2892 * before a verdict can be assigned, even if the data spans
2893 * multiple **sendmsg**\ () or **sendfile**\ () calls. The extreme
2894 * case would be a user calling **sendmsg**\ () repeatedly with
2895 * 1-byte long message segments. Obviously, this is bad for
2896 * performance, but it is still valid. If the eBPF program needs
2897 * *bytes* bytes to validate a header, this helper can be used to
2898 * prevent the eBPF program to be called again until *bytes* have
2903 * long bpf_msg_pull_data(struct sk_msg_buff *msg, u32 start, u32 end, u64 flags)
2905 * For socket policies, pull in non-linear data from user space
2906 * for *msg* and set pointers *msg*\ **->data** and *msg*\
2907 * **->data_end** to *start* and *end* bytes offsets into *msg*,
2910 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
2911 * *msg* it can only parse data that the (**data**, **data_end**)
2912 * pointers have already consumed. For **sendmsg**\ () hooks this
2913 * is likely the first scatterlist element. But for calls relying
2914 * on the **sendpage** handler (e.g. **sendfile**\ ()) this will
2915 * be the range (**0**, **0**) because the data is shared with
2916 * user space and by default the objective is to avoid allowing
2917 * user space to modify data while (or after) eBPF verdict is
2918 * being decided. This helper can be used to pull in data and to
2919 * set the start and end pointer to given values. Data will be
2920 * copied if necessary (i.e. if data was not linear and if start
2921 * and end pointers do not point to the same chunk).
2923 * A call to this helper is susceptible to change the underlying
2924 * packet buffer. Therefore, at load time, all checks on pointers
2925 * previously done by the verifier are invalidated and must be
2926 * performed again, if the helper is used in combination with
2927 * direct packet access.
2929 * All values for *flags* are reserved for future usage, and must
2932 * 0 on success, or a negative error in case of failure.
2934 * long bpf_bind(struct bpf_sock_addr *ctx, struct sockaddr *addr, int addr_len)
2936 * Bind the socket associated to *ctx* to the address pointed by
2937 * *addr*, of length *addr_len*. This allows for making outgoing
2938 * connection from the desired IP address, which can be useful for
2939 * example when all processes inside a cgroup should use one
2940 * single IP address on a host that has multiple IP configured.
2942 * This helper works for IPv4 and IPv6, TCP and UDP sockets. The
2943 * domain (*addr*\ **->sa_family**) must be **AF_INET** (or
2944 * **AF_INET6**). It's advised to pass zero port (**sin_port**
2945 * or **sin6_port**) which triggers IP_BIND_ADDRESS_NO_PORT-like
2946 * behavior and lets the kernel efficiently pick up an unused
2947 * port as long as 4-tuple is unique. Passing non-zero port might
2948 * lead to degraded performance.
2950 * 0 on success, or a negative error in case of failure.
2952 * long bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta)
2954 * Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is
2955 * possible to both shrink and grow the packet tail.
2956 * Shrink done via *delta* being a negative integer.
2958 * A call to this helper is susceptible to change the underlying
2959 * packet buffer. Therefore, at load time, all checks on pointers
2960 * previously done by the verifier are invalidated and must be
2961 * performed again, if the helper is used in combination with
2962 * direct packet access.
2964 * 0 on success, or a negative error in case of failure.
2966 * long bpf_skb_get_xfrm_state(struct sk_buff *skb, u32 index, struct bpf_xfrm_state *xfrm_state, u32 size, u64 flags)
2968 * Retrieve the XFRM state (IP transform framework, see also
2969 * **ip-xfrm(8)**) at *index* in XFRM "security path" for *skb*.
2971 * The retrieved value is stored in the **struct bpf_xfrm_state**
2972 * pointed by *xfrm_state* and of length *size*.
2974 * All values for *flags* are reserved for future usage, and must
2977 * This helper is available only if the kernel was compiled with
2978 * **CONFIG_XFRM** configuration option.
2980 * 0 on success, or a negative error in case of failure.
2982 * long bpf_get_stack(void *ctx, void *buf, u32 size, u64 flags)
2984 * Return a user or a kernel stack in bpf program provided buffer.
2985 * To achieve this, the helper needs *ctx*, which is a pointer
2986 * to the context on which the tracing program is executed.
2987 * To store the stacktrace, the bpf program provides *buf* with
2988 * a nonnegative *size*.
2990 * The last argument, *flags*, holds the number of stack frames to
2991 * skip (from 0 to 255), masked with
2992 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
2993 * the following flags:
2995 * **BPF_F_USER_STACK**
2996 * Collect a user space stack instead of a kernel stack.
2997 * **BPF_F_USER_BUILD_ID**
2998 * Collect buildid+offset instead of ips for user stack,
2999 * only valid if **BPF_F_USER_STACK** is also specified.
3001 * **bpf_get_stack**\ () can collect up to
3002 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
3003 * to sufficient large buffer size. Note that
3004 * this limit can be controlled with the **sysctl** program, and
3005 * that it should be manually increased in order to profile long
3006 * user stacks (such as stacks for Java programs). To do so, use:
3010 * # sysctl kernel.perf_event_max_stack=<new value>
3012 * The non-negative copied *buf* length equal to or less than
3013 * *size* on success, or a negative error in case of failure.
3015 * long bpf_skb_load_bytes_relative(const void *skb, u32 offset, void *to, u32 len, u32 start_header)
3017 * This helper is similar to **bpf_skb_load_bytes**\ () in that
3018 * it provides an easy way to load *len* bytes from *offset*
3019 * from the packet associated to *skb*, into the buffer pointed
3020 * by *to*. The difference to **bpf_skb_load_bytes**\ () is that
3021 * a fifth argument *start_header* exists in order to select a
3022 * base offset to start from. *start_header* can be one of:
3024 * **BPF_HDR_START_MAC**
3025 * Base offset to load data from is *skb*'s mac header.
3026 * **BPF_HDR_START_NET**
3027 * Base offset to load data from is *skb*'s network header.
3029 * In general, "direct packet access" is the preferred method to
3030 * access packet data, however, this helper is in particular useful
3031 * in socket filters where *skb*\ **->data** does not always point
3032 * to the start of the mac header and where "direct packet access"
3035 * 0 on success, or a negative error in case of failure.
3037 * long bpf_fib_lookup(void *ctx, struct bpf_fib_lookup *params, int plen, u32 flags)
3039 * Do FIB lookup in kernel tables using parameters in *params*.
3040 * If lookup is successful and result shows packet is to be
3041 * forwarded, the neighbor tables are searched for the nexthop.
3042 * If successful (ie., FIB lookup shows forwarding and nexthop
3043 * is resolved), the nexthop address is returned in ipv4_dst
3044 * or ipv6_dst based on family, smac is set to mac address of
3045 * egress device, dmac is set to nexthop mac address, rt_metric
3046 * is set to metric from route (IPv4/IPv6 only), and ifindex
3047 * is set to the device index of the nexthop from the FIB lookup.
3049 * *plen* argument is the size of the passed in struct.
3050 * *flags* argument can be a combination of one or more of the
3053 * **BPF_FIB_LOOKUP_DIRECT**
3054 * Do a direct table lookup vs full lookup using FIB
3056 * **BPF_FIB_LOOKUP_OUTPUT**
3057 * Perform lookup from an egress perspective (default is
3060 * *ctx* is either **struct xdp_md** for XDP programs or
3061 * **struct sk_buff** tc cls_act programs.
3063 * * < 0 if any input argument is invalid
3064 * * 0 on success (packet is forwarded, nexthop neighbor exists)
3065 * * > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the
3066 * packet is not forwarded or needs assist from full stack
3068 * If lookup fails with BPF_FIB_LKUP_RET_FRAG_NEEDED, then the MTU
3069 * was exceeded and output params->mtu_result contains the MTU.
3071 * long bpf_sock_hash_update(struct bpf_sock_ops *skops, struct bpf_map *map, void *key, u64 flags)
3073 * Add an entry to, or update a sockhash *map* referencing sockets.
3074 * The *skops* is used as a new value for the entry associated to
3075 * *key*. *flags* is one of:
3078 * The entry for *key* must not exist in the map.
3080 * The entry for *key* must already exist in the map.
3082 * No condition on the existence of the entry for *key*.
3084 * If the *map* has eBPF programs (parser and verdict), those will
3085 * be inherited by the socket being added. If the socket is
3086 * already attached to eBPF programs, this results in an error.
3088 * 0 on success, or a negative error in case of failure.
3090 * long bpf_msg_redirect_hash(struct sk_msg_buff *msg, struct bpf_map *map, void *key, u64 flags)
3092 * This helper is used in programs implementing policies at the
3093 * socket level. If the message *msg* is allowed to pass (i.e. if
3094 * the verdict eBPF program returns **SK_PASS**), redirect it to
3095 * the socket referenced by *map* (of type
3096 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
3097 * egress interfaces can be used for redirection. The
3098 * **BPF_F_INGRESS** value in *flags* is used to make the
3099 * distinction (ingress path is selected if the flag is present,
3100 * egress path otherwise). This is the only flag supported for now.
3102 * **SK_PASS** on success, or **SK_DROP** on error.
3104 * long bpf_sk_redirect_hash(struct sk_buff *skb, struct bpf_map *map, void *key, u64 flags)
3106 * This helper is used in programs implementing policies at the
3107 * skb socket level. If the sk_buff *skb* is allowed to pass (i.e.
3108 * if the verdict eBPF program returns **SK_PASS**), redirect it
3109 * to the socket referenced by *map* (of type
3110 * **BPF_MAP_TYPE_SOCKHASH**) using hash *key*. Both ingress and
3111 * egress interfaces can be used for redirection. The
3112 * **BPF_F_INGRESS** value in *flags* is used to make the
3113 * distinction (ingress path is selected if the flag is present,
3114 * egress otherwise). This is the only flag supported for now.
3116 * **SK_PASS** on success, or **SK_DROP** on error.
3118 * long bpf_lwt_push_encap(struct sk_buff *skb, u32 type, void *hdr, u32 len)
3120 * Encapsulate the packet associated to *skb* within a Layer 3
3121 * protocol header. This header is provided in the buffer at
3122 * address *hdr*, with *len* its size in bytes. *type* indicates
3123 * the protocol of the header and can be one of:
3125 * **BPF_LWT_ENCAP_SEG6**
3126 * IPv6 encapsulation with Segment Routing Header
3127 * (**struct ipv6_sr_hdr**). *hdr* only contains the SRH,
3128 * the IPv6 header is computed by the kernel.
3129 * **BPF_LWT_ENCAP_SEG6_INLINE**
3130 * Only works if *skb* contains an IPv6 packet. Insert a
3131 * Segment Routing Header (**struct ipv6_sr_hdr**) inside
3133 * **BPF_LWT_ENCAP_IP**
3134 * IP encapsulation (GRE/GUE/IPIP/etc). The outer header
3135 * must be IPv4 or IPv6, followed by zero or more
3136 * additional headers, up to **LWT_BPF_MAX_HEADROOM**
3137 * total bytes in all prepended headers. Please note that
3138 * if **skb_is_gso**\ (*skb*) is true, no more than two
3139 * headers can be prepended, and the inner header, if
3140 * present, should be either GRE or UDP/GUE.
3142 * **BPF_LWT_ENCAP_SEG6**\ \* types can be called by BPF programs
3143 * of type **BPF_PROG_TYPE_LWT_IN**; **BPF_LWT_ENCAP_IP** type can
3144 * be called by bpf programs of types **BPF_PROG_TYPE_LWT_IN** and
3145 * **BPF_PROG_TYPE_LWT_XMIT**.
3147 * A call to this helper is susceptible to change the underlying
3148 * packet buffer. Therefore, at load time, all checks on pointers
3149 * previously done by the verifier are invalidated and must be
3150 * performed again, if the helper is used in combination with
3151 * direct packet access.
3153 * 0 on success, or a negative error in case of failure.
3155 * long bpf_lwt_seg6_store_bytes(struct sk_buff *skb, u32 offset, const void *from, u32 len)
3157 * Store *len* bytes from address *from* into the packet
3158 * associated to *skb*, at *offset*. Only the flags, tag and TLVs
3159 * inside the outermost IPv6 Segment Routing Header can be
3160 * modified through this helper.
3162 * A call to this helper is susceptible to change the underlying
3163 * packet buffer. Therefore, at load time, all checks on pointers
3164 * previously done by the verifier are invalidated and must be
3165 * performed again, if the helper is used in combination with
3166 * direct packet access.
3168 * 0 on success, or a negative error in case of failure.
3170 * long bpf_lwt_seg6_adjust_srh(struct sk_buff *skb, u32 offset, s32 delta)
3172 * Adjust the size allocated to TLVs in the outermost IPv6
3173 * Segment Routing Header contained in the packet associated to
3174 * *skb*, at position *offset* by *delta* bytes. Only offsets
3175 * after the segments are accepted. *delta* can be as well
3176 * positive (growing) as negative (shrinking).
3178 * A call to this helper is susceptible to change the underlying
3179 * packet buffer. Therefore, at load time, all checks on pointers
3180 * previously done by the verifier are invalidated and must be
3181 * performed again, if the helper is used in combination with
3182 * direct packet access.
3184 * 0 on success, or a negative error in case of failure.
3186 * long bpf_lwt_seg6_action(struct sk_buff *skb, u32 action, void *param, u32 param_len)
3188 * Apply an IPv6 Segment Routing action of type *action* to the
3189 * packet associated to *skb*. Each action takes a parameter
3190 * contained at address *param*, and of length *param_len* bytes.
3191 * *action* can be one of:
3193 * **SEG6_LOCAL_ACTION_END_X**
3194 * End.X action: Endpoint with Layer-3 cross-connect.
3195 * Type of *param*: **struct in6_addr**.
3196 * **SEG6_LOCAL_ACTION_END_T**
3197 * End.T action: Endpoint with specific IPv6 table lookup.
3198 * Type of *param*: **int**.
3199 * **SEG6_LOCAL_ACTION_END_B6**
3200 * End.B6 action: Endpoint bound to an SRv6 policy.
3201 * Type of *param*: **struct ipv6_sr_hdr**.
3202 * **SEG6_LOCAL_ACTION_END_B6_ENCAP**
3203 * End.B6.Encap action: Endpoint bound to an SRv6
3204 * encapsulation policy.
3205 * Type of *param*: **struct ipv6_sr_hdr**.
3207 * A call to this helper is susceptible to change the underlying
3208 * packet buffer. Therefore, at load time, all checks on pointers
3209 * previously done by the verifier are invalidated and must be
3210 * performed again, if the helper is used in combination with
3211 * direct packet access.
3213 * 0 on success, or a negative error in case of failure.
3215 * long bpf_rc_repeat(void *ctx)
3217 * This helper is used in programs implementing IR decoding, to
3218 * report a successfully decoded repeat key message. This delays
3219 * the generation of a key up event for previously generated
3222 * Some IR protocols like NEC have a special IR message for
3223 * repeating last button, for when a button is held down.
3225 * The *ctx* should point to the lirc sample as passed into
3228 * This helper is only available is the kernel was compiled with
3229 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
3234 * long bpf_rc_keydown(void *ctx, u32 protocol, u64 scancode, u32 toggle)
3236 * This helper is used in programs implementing IR decoding, to
3237 * report a successfully decoded key press with *scancode*,
3238 * *toggle* value in the given *protocol*. The scancode will be
3239 * translated to a keycode using the rc keymap, and reported as
3240 * an input key down event. After a period a key up event is
3241 * generated. This period can be extended by calling either
3242 * **bpf_rc_keydown**\ () again with the same values, or calling
3243 * **bpf_rc_repeat**\ ().
3245 * Some protocols include a toggle bit, in case the button was
3246 * released and pressed again between consecutive scancodes.
3248 * The *ctx* should point to the lirc sample as passed into
3251 * The *protocol* is the decoded protocol number (see
3252 * **enum rc_proto** for some predefined values).
3254 * This helper is only available is the kernel was compiled with
3255 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
3260 * u64 bpf_skb_cgroup_id(struct sk_buff *skb)
3262 * Return the cgroup v2 id of the socket associated with the *skb*.
3263 * This is roughly similar to the **bpf_get_cgroup_classid**\ ()
3264 * helper for cgroup v1 by providing a tag resp. identifier that
3265 * can be matched on or used for map lookups e.g. to implement
3266 * policy. The cgroup v2 id of a given path in the hierarchy is
3267 * exposed in user space through the f_handle API in order to get
3268 * to the same 64-bit id.
3270 * This helper can be used on TC egress path, but not on ingress,
3271 * and is available only if the kernel was compiled with the
3272 * **CONFIG_SOCK_CGROUP_DATA** configuration option.
3274 * The id is returned or 0 in case the id could not be retrieved.
3276 * u64 bpf_get_current_cgroup_id(void)
3278 * Get the current cgroup id based on the cgroup within which
3279 * the current task is running.
3281 * A 64-bit integer containing the current cgroup id based
3282 * on the cgroup within which the current task is running.
3284 * void *bpf_get_local_storage(void *map, u64 flags)
3286 * Get the pointer to the local storage area.
3287 * The type and the size of the local storage is defined
3288 * by the *map* argument.
3289 * The *flags* meaning is specific for each map type,
3290 * and has to be 0 for cgroup local storage.
3292 * Depending on the BPF program type, a local storage area
3293 * can be shared between multiple instances of the BPF program,
3294 * running simultaneously.
3296 * A user should care about the synchronization by himself.
3297 * For example, by using the **BPF_ATOMIC** instructions to alter
3300 * A pointer to the local storage area.
3302 * long bpf_sk_select_reuseport(struct sk_reuseport_md *reuse, struct bpf_map *map, void *key, u64 flags)
3304 * Select a **SO_REUSEPORT** socket from a
3305 * **BPF_MAP_TYPE_REUSEPORT_SOCKARRAY** *map*.
3306 * It checks the selected socket is matching the incoming
3307 * request in the socket buffer.
3309 * 0 on success, or a negative error in case of failure.
3311 * u64 bpf_skb_ancestor_cgroup_id(struct sk_buff *skb, int ancestor_level)
3313 * Return id of cgroup v2 that is ancestor of cgroup associated
3314 * with the *skb* at the *ancestor_level*. The root cgroup is at
3315 * *ancestor_level* zero and each step down the hierarchy
3316 * increments the level. If *ancestor_level* == level of cgroup
3317 * associated with *skb*, then return value will be same as that
3318 * of **bpf_skb_cgroup_id**\ ().
3320 * The helper is useful to implement policies based on cgroups
3321 * that are upper in hierarchy than immediate cgroup associated
3324 * The format of returned id and helper limitations are same as in
3325 * **bpf_skb_cgroup_id**\ ().
3327 * The id is returned or 0 in case the id could not be retrieved.
3329 * struct bpf_sock *bpf_sk_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
3331 * Look for TCP socket matching *tuple*, optionally in a child
3332 * network namespace *netns*. The return value must be checked,
3333 * and if non-**NULL**, released via **bpf_sk_release**\ ().
3335 * The *ctx* should point to the context of the program, such as
3336 * the skb or socket (depending on the hook in use). This is used
3337 * to determine the base network namespace for the lookup.
3339 * *tuple_size* must be one of:
3341 * **sizeof**\ (*tuple*\ **->ipv4**)
3342 * Look for an IPv4 socket.
3343 * **sizeof**\ (*tuple*\ **->ipv6**)
3344 * Look for an IPv6 socket.
3346 * If the *netns* is a negative signed 32-bit integer, then the
3347 * socket lookup table in the netns associated with the *ctx*
3348 * will be used. For the TC hooks, this is the netns of the device
3349 * in the skb. For socket hooks, this is the netns of the socket.
3350 * If *netns* is any other signed 32-bit value greater than or
3351 * equal to zero then it specifies the ID of the netns relative to
3352 * the netns associated with the *ctx*. *netns* values beyond the
3353 * range of 32-bit integers are reserved for future use.
3355 * All values for *flags* are reserved for future usage, and must
3358 * This helper is available only if the kernel was compiled with
3359 * **CONFIG_NET** configuration option.
3361 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
3362 * For sockets with reuseport option, the **struct bpf_sock**
3363 * result is from *reuse*\ **->socks**\ [] using the hash of the
3366 * struct bpf_sock *bpf_sk_lookup_udp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
3368 * Look for UDP socket matching *tuple*, optionally in a child
3369 * network namespace *netns*. The return value must be checked,
3370 * and if non-**NULL**, released via **bpf_sk_release**\ ().
3372 * The *ctx* should point to the context of the program, such as
3373 * the skb or socket (depending on the hook in use). This is used
3374 * to determine the base network namespace for the lookup.
3376 * *tuple_size* must be one of:
3378 * **sizeof**\ (*tuple*\ **->ipv4**)
3379 * Look for an IPv4 socket.
3380 * **sizeof**\ (*tuple*\ **->ipv6**)
3381 * Look for an IPv6 socket.
3383 * If the *netns* is a negative signed 32-bit integer, then the
3384 * socket lookup table in the netns associated with the *ctx*
3385 * will be used. For the TC hooks, this is the netns of the device
3386 * in the skb. For socket hooks, this is the netns of the socket.
3387 * If *netns* is any other signed 32-bit value greater than or
3388 * equal to zero then it specifies the ID of the netns relative to
3389 * the netns associated with the *ctx*. *netns* values beyond the
3390 * range of 32-bit integers are reserved for future use.
3392 * All values for *flags* are reserved for future usage, and must
3395 * This helper is available only if the kernel was compiled with
3396 * **CONFIG_NET** configuration option.
3398 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
3399 * For sockets with reuseport option, the **struct bpf_sock**
3400 * result is from *reuse*\ **->socks**\ [] using the hash of the
3403 * long bpf_sk_release(void *sock)
3405 * Release the reference held by *sock*. *sock* must be a
3406 * non-**NULL** pointer that was returned from
3407 * **bpf_sk_lookup_xxx**\ ().
3409 * 0 on success, or a negative error in case of failure.
3411 * long bpf_map_push_elem(struct bpf_map *map, const void *value, u64 flags)
3413 * Push an element *value* in *map*. *flags* is one of:
3416 * If the queue/stack is full, the oldest element is
3417 * removed to make room for this.
3419 * 0 on success, or a negative error in case of failure.
3421 * long bpf_map_pop_elem(struct bpf_map *map, void *value)
3423 * Pop an element from *map*.
3425 * 0 on success, or a negative error in case of failure.
3427 * long bpf_map_peek_elem(struct bpf_map *map, void *value)
3429 * Get an element from *map* without removing it.
3431 * 0 on success, or a negative error in case of failure.
3433 * long bpf_msg_push_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags)
3435 * For socket policies, insert *len* bytes into *msg* at offset
3438 * If a program of type **BPF_PROG_TYPE_SK_MSG** is run on a
3439 * *msg* it may want to insert metadata or options into the *msg*.
3440 * This can later be read and used by any of the lower layer BPF
3443 * This helper may fail if under memory pressure (a malloc
3444 * fails) in these cases BPF programs will get an appropriate
3445 * error and BPF programs will need to handle them.
3447 * 0 on success, or a negative error in case of failure.
3449 * long bpf_msg_pop_data(struct sk_msg_buff *msg, u32 start, u32 len, u64 flags)
3451 * Will remove *len* bytes from a *msg* starting at byte *start*.
3452 * This may result in **ENOMEM** errors under certain situations if
3453 * an allocation and copy are required due to a full ring buffer.
3454 * However, the helper will try to avoid doing the allocation
3455 * if possible. Other errors can occur if input parameters are
3456 * invalid either due to *start* byte not being valid part of *msg*
3457 * payload and/or *pop* value being to large.
3459 * 0 on success, or a negative error in case of failure.
3461 * long bpf_rc_pointer_rel(void *ctx, s32 rel_x, s32 rel_y)
3463 * This helper is used in programs implementing IR decoding, to
3464 * report a successfully decoded pointer movement.
3466 * The *ctx* should point to the lirc sample as passed into
3469 * This helper is only available is the kernel was compiled with
3470 * the **CONFIG_BPF_LIRC_MODE2** configuration option set to
3475 * long bpf_spin_lock(struct bpf_spin_lock *lock)
3477 * Acquire a spinlock represented by the pointer *lock*, which is
3478 * stored as part of a value of a map. Taking the lock allows to
3479 * safely update the rest of the fields in that value. The
3480 * spinlock can (and must) later be released with a call to
3481 * **bpf_spin_unlock**\ (\ *lock*\ ).
3483 * Spinlocks in BPF programs come with a number of restrictions
3486 * * **bpf_spin_lock** objects are only allowed inside maps of
3487 * types **BPF_MAP_TYPE_HASH** and **BPF_MAP_TYPE_ARRAY** (this
3488 * list could be extended in the future).
3489 * * BTF description of the map is mandatory.
3490 * * The BPF program can take ONE lock at a time, since taking two
3491 * or more could cause dead locks.
3492 * * Only one **struct bpf_spin_lock** is allowed per map element.
3493 * * When the lock is taken, calls (either BPF to BPF or helpers)
3495 * * The **BPF_LD_ABS** and **BPF_LD_IND** instructions are not
3496 * allowed inside a spinlock-ed region.
3497 * * The BPF program MUST call **bpf_spin_unlock**\ () to release
3498 * the lock, on all execution paths, before it returns.
3499 * * The BPF program can access **struct bpf_spin_lock** only via
3500 * the **bpf_spin_lock**\ () and **bpf_spin_unlock**\ ()
3501 * helpers. Loading or storing data into the **struct
3502 * bpf_spin_lock** *lock*\ **;** field of a map is not allowed.
3503 * * To use the **bpf_spin_lock**\ () helper, the BTF description
3504 * of the map value must be a struct and have **struct
3505 * bpf_spin_lock** *anyname*\ **;** field at the top level.
3506 * Nested lock inside another struct is not allowed.
3507 * * The **struct bpf_spin_lock** *lock* field in a map value must
3508 * be aligned on a multiple of 4 bytes in that value.
3509 * * Syscall with command **BPF_MAP_LOOKUP_ELEM** does not copy
3510 * the **bpf_spin_lock** field to user space.
3511 * * Syscall with command **BPF_MAP_UPDATE_ELEM**, or update from
3512 * a BPF program, do not update the **bpf_spin_lock** field.
3513 * * **bpf_spin_lock** cannot be on the stack or inside a
3514 * networking packet (it can only be inside of a map values).
3515 * * **bpf_spin_lock** is available to root only.
3516 * * Tracing programs and socket filter programs cannot use
3517 * **bpf_spin_lock**\ () due to insufficient preemption checks
3518 * (but this may change in the future).
3519 * * **bpf_spin_lock** is not allowed in inner maps of map-in-map.
3523 * long bpf_spin_unlock(struct bpf_spin_lock *lock)
3525 * Release the *lock* previously locked by a call to
3526 * **bpf_spin_lock**\ (\ *lock*\ ).
3530 * struct bpf_sock *bpf_sk_fullsock(struct bpf_sock *sk)
3532 * This helper gets a **struct bpf_sock** pointer such
3533 * that all the fields in this **bpf_sock** can be accessed.
3535 * A **struct bpf_sock** pointer on success, or **NULL** in
3538 * struct bpf_tcp_sock *bpf_tcp_sock(struct bpf_sock *sk)
3540 * This helper gets a **struct bpf_tcp_sock** pointer from a
3541 * **struct bpf_sock** pointer.
3543 * A **struct bpf_tcp_sock** pointer on success, or **NULL** in
3546 * long bpf_skb_ecn_set_ce(struct sk_buff *skb)
3548 * Set ECN (Explicit Congestion Notification) field of IP header
3549 * to **CE** (Congestion Encountered) if current value is **ECT**
3550 * (ECN Capable Transport). Otherwise, do nothing. Works with IPv6
3553 * 1 if the **CE** flag is set (either by the current helper call
3554 * or because it was already present), 0 if it is not set.
3556 * struct bpf_sock *bpf_get_listener_sock(struct bpf_sock *sk)
3558 * Return a **struct bpf_sock** pointer in **TCP_LISTEN** state.
3559 * **bpf_sk_release**\ () is unnecessary and not allowed.
3561 * A **struct bpf_sock** pointer on success, or **NULL** in
3564 * struct bpf_sock *bpf_skc_lookup_tcp(void *ctx, struct bpf_sock_tuple *tuple, u32 tuple_size, u64 netns, u64 flags)
3566 * Look for TCP socket matching *tuple*, optionally in a child
3567 * network namespace *netns*. The return value must be checked,
3568 * and if non-**NULL**, released via **bpf_sk_release**\ ().
3570 * This function is identical to **bpf_sk_lookup_tcp**\ (), except
3571 * that it also returns timewait or request sockets. Use
3572 * **bpf_sk_fullsock**\ () or **bpf_tcp_sock**\ () to access the
3575 * This helper is available only if the kernel was compiled with
3576 * **CONFIG_NET** configuration option.
3578 * Pointer to **struct bpf_sock**, or **NULL** in case of failure.
3579 * For sockets with reuseport option, the **struct bpf_sock**
3580 * result is from *reuse*\ **->socks**\ [] using the hash of the
3583 * long bpf_tcp_check_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
3585 * Check whether *iph* and *th* contain a valid SYN cookie ACK for
3586 * the listening socket in *sk*.
3588 * *iph* points to the start of the IPv4 or IPv6 header, while
3589 * *iph_len* contains **sizeof**\ (**struct iphdr**) or
3590 * **sizeof**\ (**struct ip6hdr**).
3592 * *th* points to the start of the TCP header, while *th_len*
3593 * contains **sizeof**\ (**struct tcphdr**).
3595 * 0 if *iph* and *th* are a valid SYN cookie ACK, or a negative
3598 * long bpf_sysctl_get_name(struct bpf_sysctl *ctx, char *buf, size_t buf_len, u64 flags)
3600 * Get name of sysctl in /proc/sys/ and copy it into provided by
3601 * program buffer *buf* of size *buf_len*.
3603 * The buffer is always NUL terminated, unless it's zero-sized.
3605 * If *flags* is zero, full name (e.g. "net/ipv4/tcp_mem") is
3606 * copied. Use **BPF_F_SYSCTL_BASE_NAME** flag to copy base name
3607 * only (e.g. "tcp_mem").
3609 * Number of character copied (not including the trailing NUL).
3611 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
3612 * truncated name in this case).
3614 * long bpf_sysctl_get_current_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
3616 * Get current value of sysctl as it is presented in /proc/sys
3617 * (incl. newline, etc), and copy it as a string into provided
3618 * by program buffer *buf* of size *buf_len*.
3620 * The whole value is copied, no matter what file position user
3621 * space issued e.g. sys_read at.
3623 * The buffer is always NUL terminated, unless it's zero-sized.
3625 * Number of character copied (not including the trailing NUL).
3627 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
3628 * truncated name in this case).
3630 * **-EINVAL** if current value was unavailable, e.g. because
3631 * sysctl is uninitialized and read returns -EIO for it.
3633 * long bpf_sysctl_get_new_value(struct bpf_sysctl *ctx, char *buf, size_t buf_len)
3635 * Get new value being written by user space to sysctl (before
3636 * the actual write happens) and copy it as a string into
3637 * provided by program buffer *buf* of size *buf_len*.
3639 * User space may write new value at file position > 0.
3641 * The buffer is always NUL terminated, unless it's zero-sized.
3643 * Number of character copied (not including the trailing NUL).
3645 * **-E2BIG** if the buffer wasn't big enough (*buf* will contain
3646 * truncated name in this case).
3648 * **-EINVAL** if sysctl is being read.
3650 * long bpf_sysctl_set_new_value(struct bpf_sysctl *ctx, const char *buf, size_t buf_len)
3652 * Override new value being written by user space to sysctl with
3653 * value provided by program in buffer *buf* of size *buf_len*.
3655 * *buf* should contain a string in same form as provided by user
3656 * space on sysctl write.
3658 * User space may write new value at file position > 0. To override
3659 * the whole sysctl value file position should be set to zero.
3663 * **-E2BIG** if the *buf_len* is too big.
3665 * **-EINVAL** if sysctl is being read.
3667 * long bpf_strtol(const char *buf, size_t buf_len, u64 flags, long *res)
3669 * Convert the initial part of the string from buffer *buf* of
3670 * size *buf_len* to a long integer according to the given base
3671 * and save the result in *res*.
3673 * The string may begin with an arbitrary amount of white space
3674 * (as determined by **isspace**\ (3)) followed by a single
3675 * optional '**-**' sign.
3677 * Five least significant bits of *flags* encode base, other bits
3678 * are currently unused.
3680 * Base must be either 8, 10, 16 or 0 to detect it automatically
3681 * similar to user space **strtol**\ (3).
3683 * Number of characters consumed on success. Must be positive but
3684 * no more than *buf_len*.
3686 * **-EINVAL** if no valid digits were found or unsupported base
3689 * **-ERANGE** if resulting value was out of range.
3691 * long bpf_strtoul(const char *buf, size_t buf_len, u64 flags, unsigned long *res)
3693 * Convert the initial part of the string from buffer *buf* of
3694 * size *buf_len* to an unsigned long integer according to the
3695 * given base and save the result in *res*.
3697 * The string may begin with an arbitrary amount of white space
3698 * (as determined by **isspace**\ (3)).
3700 * Five least significant bits of *flags* encode base, other bits
3701 * are currently unused.
3703 * Base must be either 8, 10, 16 or 0 to detect it automatically
3704 * similar to user space **strtoul**\ (3).
3706 * Number of characters consumed on success. Must be positive but
3707 * no more than *buf_len*.
3709 * **-EINVAL** if no valid digits were found or unsupported base
3712 * **-ERANGE** if resulting value was out of range.
3714 * void *bpf_sk_storage_get(struct bpf_map *map, void *sk, void *value, u64 flags)
3716 * Get a bpf-local-storage from a *sk*.
3718 * Logically, it could be thought of getting the value from
3719 * a *map* with *sk* as the **key**. From this
3720 * perspective, the usage is not much different from
3721 * **bpf_map_lookup_elem**\ (*map*, **&**\ *sk*) except this
3722 * helper enforces the key must be a full socket and the map must
3723 * be a **BPF_MAP_TYPE_SK_STORAGE** also.
3725 * Underneath, the value is stored locally at *sk* instead of
3726 * the *map*. The *map* is used as the bpf-local-storage
3727 * "type". The bpf-local-storage "type" (i.e. the *map*) is
3728 * searched against all bpf-local-storages residing at *sk*.
3730 * *sk* is a kernel **struct sock** pointer for LSM program.
3731 * *sk* is a **struct bpf_sock** pointer for other program types.
3733 * An optional *flags* (**BPF_SK_STORAGE_GET_F_CREATE**) can be
3734 * used such that a new bpf-local-storage will be
3735 * created if one does not exist. *value* can be used
3736 * together with **BPF_SK_STORAGE_GET_F_CREATE** to specify
3737 * the initial value of a bpf-local-storage. If *value* is
3738 * **NULL**, the new bpf-local-storage will be zero initialized.
3740 * A bpf-local-storage pointer is returned on success.
3742 * **NULL** if not found or there was an error in adding
3743 * a new bpf-local-storage.
3745 * long bpf_sk_storage_delete(struct bpf_map *map, void *sk)
3747 * Delete a bpf-local-storage from a *sk*.
3751 * **-ENOENT** if the bpf-local-storage cannot be found.
3752 * **-EINVAL** if sk is not a fullsock (e.g. a request_sock).
3754 * long bpf_send_signal(u32 sig)
3756 * Send signal *sig* to the process of the current task.
3757 * The signal may be delivered to any of this process's threads.
3759 * 0 on success or successfully queued.
3761 * **-EBUSY** if work queue under nmi is full.
3763 * **-EINVAL** if *sig* is invalid.
3765 * **-EPERM** if no permission to send the *sig*.
3767 * **-EAGAIN** if bpf program can try again.
3769 * s64 bpf_tcp_gen_syncookie(void *sk, void *iph, u32 iph_len, struct tcphdr *th, u32 th_len)
3771 * Try to issue a SYN cookie for the packet with corresponding
3772 * IP/TCP headers, *iph* and *th*, on the listening socket in *sk*.
3774 * *iph* points to the start of the IPv4 or IPv6 header, while
3775 * *iph_len* contains **sizeof**\ (**struct iphdr**) or
3776 * **sizeof**\ (**struct ip6hdr**).
3778 * *th* points to the start of the TCP header, while *th_len*
3779 * contains the length of the TCP header.
3781 * On success, lower 32 bits hold the generated SYN cookie in
3782 * followed by 16 bits which hold the MSS value for that cookie,
3783 * and the top 16 bits are unused.
3785 * On failure, the returned value is one of the following:
3787 * **-EINVAL** SYN cookie cannot be issued due to error
3789 * **-ENOENT** SYN cookie should not be issued (no SYN flood)
3791 * **-EOPNOTSUPP** kernel configuration does not enable SYN cookies
3793 * **-EPROTONOSUPPORT** IP packet version is not 4 or 6
3795 * long bpf_skb_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
3797 * Write raw *data* blob into a special BPF perf event held by
3798 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
3799 * event must have the following attributes: **PERF_SAMPLE_RAW**
3800 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
3801 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
3803 * The *flags* are used to indicate the index in *map* for which
3804 * the value must be put, masked with **BPF_F_INDEX_MASK**.
3805 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
3806 * to indicate that the index of the current CPU core should be
3809 * The value to write, of *size*, is passed through eBPF stack and
3810 * pointed by *data*.
3812 * *ctx* is a pointer to in-kernel struct sk_buff.
3814 * This helper is similar to **bpf_perf_event_output**\ () but
3815 * restricted to raw_tracepoint bpf programs.
3817 * 0 on success, or a negative error in case of failure.
3819 * long bpf_probe_read_user(void *dst, u32 size, const void *unsafe_ptr)
3821 * Safely attempt to read *size* bytes from user space address
3822 * *unsafe_ptr* and store the data in *dst*.
3824 * 0 on success, or a negative error in case of failure.
3826 * long bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr)
3828 * Safely attempt to read *size* bytes from kernel space address
3829 * *unsafe_ptr* and store the data in *dst*.
3831 * 0 on success, or a negative error in case of failure.
3833 * long bpf_probe_read_user_str(void *dst, u32 size, const void *unsafe_ptr)
3835 * Copy a NUL terminated string from an unsafe user address
3836 * *unsafe_ptr* to *dst*. The *size* should include the
3837 * terminating NUL byte. In case the string length is smaller than
3838 * *size*, the target is not padded with further NUL bytes. If the
3839 * string length is larger than *size*, just *size*-1 bytes are
3840 * copied and the last byte is set to NUL.
3842 * On success, returns the number of bytes that were written,
3843 * including the terminal NUL. This makes this helper useful in
3844 * tracing programs for reading strings, and more importantly to
3845 * get its length at runtime. See the following snippet:
3849 * SEC("kprobe/sys_open")
3850 * void bpf_sys_open(struct pt_regs *ctx)
3852 * char buf[PATHLEN]; // PATHLEN is defined to 256
3853 * int res = bpf_probe_read_user_str(buf, sizeof(buf),
3856 * // Consume buf, for example push it to
3857 * // userspace via bpf_perf_event_output(); we
3858 * // can use res (the string length) as event
3859 * // size, after checking its boundaries.
3862 * In comparison, using **bpf_probe_read_user**\ () helper here
3863 * instead to read the string would require to estimate the length
3864 * at compile time, and would often result in copying more memory
3867 * Another useful use case is when parsing individual process
3868 * arguments or individual environment variables navigating
3869 * *current*\ **->mm->arg_start** and *current*\
3870 * **->mm->env_start**: using this helper and the return value,
3871 * one can quickly iterate at the right offset of the memory area.
3873 * On success, the strictly positive length of the output string,
3874 * including the trailing NUL character. On error, a negative
3877 * long bpf_probe_read_kernel_str(void *dst, u32 size, const void *unsafe_ptr)
3879 * Copy a NUL terminated string from an unsafe kernel address *unsafe_ptr*
3880 * to *dst*. Same semantics as with **bpf_probe_read_user_str**\ () apply.
3882 * On success, the strictly positive length of the string, including
3883 * the trailing NUL character. On error, a negative value.
3885 * long bpf_tcp_send_ack(void *tp, u32 rcv_nxt)
3887 * Send out a tcp-ack. *tp* is the in-kernel struct **tcp_sock**.
3888 * *rcv_nxt* is the ack_seq to be sent out.
3890 * 0 on success, or a negative error in case of failure.
3892 * long bpf_send_signal_thread(u32 sig)
3894 * Send signal *sig* to the thread corresponding to the current task.
3896 * 0 on success or successfully queued.
3898 * **-EBUSY** if work queue under nmi is full.
3900 * **-EINVAL** if *sig* is invalid.
3902 * **-EPERM** if no permission to send the *sig*.
3904 * **-EAGAIN** if bpf program can try again.
3906 * u64 bpf_jiffies64(void)
3908 * Obtain the 64bit jiffies
3910 * The 64 bit jiffies
3912 * long bpf_read_branch_records(struct bpf_perf_event_data *ctx, void *buf, u32 size, u64 flags)
3914 * For an eBPF program attached to a perf event, retrieve the
3915 * branch records (**struct perf_branch_entry**) associated to *ctx*
3916 * and store it in the buffer pointed by *buf* up to size
3919 * On success, number of bytes written to *buf*. On error, a
3922 * The *flags* can be set to **BPF_F_GET_BRANCH_RECORDS_SIZE** to
3923 * instead return the number of bytes required to store all the
3924 * branch entries. If this flag is set, *buf* may be NULL.
3926 * **-EINVAL** if arguments invalid or **size** not a multiple
3927 * of **sizeof**\ (**struct perf_branch_entry**\ ).
3929 * **-ENOENT** if architecture does not support branch records.
3931 * long bpf_get_ns_current_pid_tgid(u64 dev, u64 ino, struct bpf_pidns_info *nsdata, u32 size)
3933 * Returns 0 on success, values for *pid* and *tgid* as seen from the current
3934 * *namespace* will be returned in *nsdata*.
3936 * 0 on success, or one of the following in case of failure:
3938 * **-EINVAL** if dev and inum supplied don't match dev_t and inode number
3939 * with nsfs of current task, or if dev conversion to dev_t lost high bits.
3941 * **-ENOENT** if pidns does not exists for the current task.
3943 * long bpf_xdp_output(void *ctx, struct bpf_map *map, u64 flags, void *data, u64 size)
3945 * Write raw *data* blob into a special BPF perf event held by
3946 * *map* of type **BPF_MAP_TYPE_PERF_EVENT_ARRAY**. This perf
3947 * event must have the following attributes: **PERF_SAMPLE_RAW**
3948 * as **sample_type**, **PERF_TYPE_SOFTWARE** as **type**, and
3949 * **PERF_COUNT_SW_BPF_OUTPUT** as **config**.
3951 * The *flags* are used to indicate the index in *map* for which
3952 * the value must be put, masked with **BPF_F_INDEX_MASK**.
3953 * Alternatively, *flags* can be set to **BPF_F_CURRENT_CPU**
3954 * to indicate that the index of the current CPU core should be
3957 * The value to write, of *size*, is passed through eBPF stack and
3958 * pointed by *data*.
3960 * *ctx* is a pointer to in-kernel struct xdp_buff.
3962 * This helper is similar to **bpf_perf_eventoutput**\ () but
3963 * restricted to raw_tracepoint bpf programs.
3965 * 0 on success, or a negative error in case of failure.
3967 * u64 bpf_get_netns_cookie(void *ctx)
3969 * Retrieve the cookie (generated by the kernel) of the network
3970 * namespace the input *ctx* is associated with. The network
3971 * namespace cookie remains stable for its lifetime and provides
3972 * a global identifier that can be assumed unique. If *ctx* is
3973 * NULL, then the helper returns the cookie for the initial
3974 * network namespace. The cookie itself is very similar to that
3975 * of **bpf_get_socket_cookie**\ () helper, but for network
3976 * namespaces instead of sockets.
3978 * A 8-byte long opaque number.
3980 * u64 bpf_get_current_ancestor_cgroup_id(int ancestor_level)
3982 * Return id of cgroup v2 that is ancestor of the cgroup associated
3983 * with the current task at the *ancestor_level*. The root cgroup
3984 * is at *ancestor_level* zero and each step down the hierarchy
3985 * increments the level. If *ancestor_level* == level of cgroup
3986 * associated with the current task, then return value will be the
3987 * same as that of **bpf_get_current_cgroup_id**\ ().
3989 * The helper is useful to implement policies based on cgroups
3990 * that are upper in hierarchy than immediate cgroup associated
3991 * with the current task.
3993 * The format of returned id and helper limitations are same as in
3994 * **bpf_get_current_cgroup_id**\ ().
3996 * The id is returned or 0 in case the id could not be retrieved.
3998 * long bpf_sk_assign(struct sk_buff *skb, void *sk, u64 flags)
4000 * Helper is overloaded depending on BPF program type. This
4001 * description applies to **BPF_PROG_TYPE_SCHED_CLS** and
4002 * **BPF_PROG_TYPE_SCHED_ACT** programs.
4004 * Assign the *sk* to the *skb*. When combined with appropriate
4005 * routing configuration to receive the packet towards the socket,
4006 * will cause *skb* to be delivered to the specified socket.
4007 * Subsequent redirection of *skb* via **bpf_redirect**\ (),
4008 * **bpf_clone_redirect**\ () or other methods outside of BPF may
4009 * interfere with successful delivery to the socket.
4011 * This operation is only valid from TC ingress path.
4013 * The *flags* argument must be zero.
4015 * 0 on success, or a negative error in case of failure:
4017 * **-EINVAL** if specified *flags* are not supported.
4019 * **-ENOENT** if the socket is unavailable for assignment.
4021 * **-ENETUNREACH** if the socket is unreachable (wrong netns).
4023 * **-EOPNOTSUPP** if the operation is not supported, for example
4024 * a call from outside of TC ingress.
4026 * **-ESOCKTNOSUPPORT** if the socket type is not supported
4029 * long bpf_sk_assign(struct bpf_sk_lookup *ctx, struct bpf_sock *sk, u64 flags)
4031 * Helper is overloaded depending on BPF program type. This
4032 * description applies to **BPF_PROG_TYPE_SK_LOOKUP** programs.
4034 * Select the *sk* as a result of a socket lookup.
4036 * For the operation to succeed passed socket must be compatible
4037 * with the packet description provided by the *ctx* object.
4039 * L4 protocol (**IPPROTO_TCP** or **IPPROTO_UDP**) must
4040 * be an exact match. While IP family (**AF_INET** or
4041 * **AF_INET6**) must be compatible, that is IPv6 sockets
4042 * that are not v6-only can be selected for IPv4 packets.
4044 * Only TCP listeners and UDP unconnected sockets can be
4045 * selected. *sk* can also be NULL to reset any previous
4048 * *flags* argument can combination of following values:
4050 * * **BPF_SK_LOOKUP_F_REPLACE** to override the previous
4051 * socket selection, potentially done by a BPF program
4052 * that ran before us.
4054 * * **BPF_SK_LOOKUP_F_NO_REUSEPORT** to skip
4055 * load-balancing within reuseport group for the socket
4058 * On success *ctx->sk* will point to the selected socket.
4061 * 0 on success, or a negative errno in case of failure.
4063 * * **-EAFNOSUPPORT** if socket family (*sk->family*) is
4064 * not compatible with packet family (*ctx->family*).
4066 * * **-EEXIST** if socket has been already selected,
4067 * potentially by another program, and
4068 * **BPF_SK_LOOKUP_F_REPLACE** flag was not specified.
4070 * * **-EINVAL** if unsupported flags were specified.
4072 * * **-EPROTOTYPE** if socket L4 protocol
4073 * (*sk->protocol*) doesn't match packet protocol
4074 * (*ctx->protocol*).
4076 * * **-ESOCKTNOSUPPORT** if socket is not in allowed
4077 * state (TCP listening or UDP unconnected).
4079 * u64 bpf_ktime_get_boot_ns(void)
4081 * Return the time elapsed since system boot, in nanoseconds.
4082 * Does include the time the system was suspended.
4083 * See: **clock_gettime**\ (**CLOCK_BOOTTIME**)
4087 * long bpf_seq_printf(struct seq_file *m, const char *fmt, u32 fmt_size, const void *data, u32 data_len)
4089 * **bpf_seq_printf**\ () uses seq_file **seq_printf**\ () to print
4090 * out the format string.
4091 * The *m* represents the seq_file. The *fmt* and *fmt_size* are for
4092 * the format string itself. The *data* and *data_len* are format string
4093 * arguments. The *data* are a **u64** array and corresponding format string
4094 * values are stored in the array. For strings and pointers where pointees
4095 * are accessed, only the pointer values are stored in the *data* array.
4096 * The *data_len* is the size of *data* in bytes - must be a multiple of 8.
4098 * Formats **%s**, **%p{i,I}{4,6}** requires to read kernel memory.
4099 * Reading kernel memory may fail due to either invalid address or
4100 * valid address but requiring a major memory fault. If reading kernel memory
4101 * fails, the string for **%s** will be an empty string, and the ip
4102 * address for **%p{i,I}{4,6}** will be 0. Not returning error to
4103 * bpf program is consistent with what **bpf_trace_printk**\ () does for now.
4105 * 0 on success, or a negative error in case of failure:
4107 * **-EBUSY** if per-CPU memory copy buffer is busy, can try again
4108 * by returning 1 from bpf program.
4110 * **-EINVAL** if arguments are invalid, or if *fmt* is invalid/unsupported.
4112 * **-E2BIG** if *fmt* contains too many format specifiers.
4114 * **-EOVERFLOW** if an overflow happened: The same object will be tried again.
4116 * long bpf_seq_write(struct seq_file *m, const void *data, u32 len)
4118 * **bpf_seq_write**\ () uses seq_file **seq_write**\ () to write the data.
4119 * The *m* represents the seq_file. The *data* and *len* represent the
4120 * data to write in bytes.
4122 * 0 on success, or a negative error in case of failure:
4124 * **-EOVERFLOW** if an overflow happened: The same object will be tried again.
4126 * u64 bpf_sk_cgroup_id(void *sk)
4128 * Return the cgroup v2 id of the socket *sk*.
4130 * *sk* must be a non-**NULL** pointer to a socket, e.g. one
4131 * returned from **bpf_sk_lookup_xxx**\ (),
4132 * **bpf_sk_fullsock**\ (), etc. The format of returned id is
4133 * same as in **bpf_skb_cgroup_id**\ ().
4135 * This helper is available only if the kernel was compiled with
4136 * the **CONFIG_SOCK_CGROUP_DATA** configuration option.
4138 * The id is returned or 0 in case the id could not be retrieved.
4140 * u64 bpf_sk_ancestor_cgroup_id(void *sk, int ancestor_level)
4142 * Return id of cgroup v2 that is ancestor of cgroup associated
4143 * with the *sk* at the *ancestor_level*. The root cgroup is at
4144 * *ancestor_level* zero and each step down the hierarchy
4145 * increments the level. If *ancestor_level* == level of cgroup
4146 * associated with *sk*, then return value will be same as that
4147 * of **bpf_sk_cgroup_id**\ ().
4149 * The helper is useful to implement policies based on cgroups
4150 * that are upper in hierarchy than immediate cgroup associated
4153 * The format of returned id and helper limitations are same as in
4154 * **bpf_sk_cgroup_id**\ ().
4156 * The id is returned or 0 in case the id could not be retrieved.
4158 * long bpf_ringbuf_output(void *ringbuf, void *data, u64 size, u64 flags)
4160 * Copy *size* bytes from *data* into a ring buffer *ringbuf*.
4161 * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification
4162 * of new data availability is sent.
4163 * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification
4164 * of new data availability is sent unconditionally.
4165 * If **0** is specified in *flags*, an adaptive notification
4166 * of new data availability is sent.
4168 * An adaptive notification is a notification sent whenever the user-space
4169 * process has caught up and consumed all available payloads. In case the user-space
4170 * process is still processing a previous payload, then no notification is needed
4171 * as it will process the newly added payload automatically.
4173 * 0 on success, or a negative error in case of failure.
4175 * void *bpf_ringbuf_reserve(void *ringbuf, u64 size, u64 flags)
4177 * Reserve *size* bytes of payload in a ring buffer *ringbuf*.
4178 * *flags* must be 0.
4180 * Valid pointer with *size* bytes of memory available; NULL,
4183 * void bpf_ringbuf_submit(void *data, u64 flags)
4185 * Submit reserved ring buffer sample, pointed to by *data*.
4186 * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification
4187 * of new data availability is sent.
4188 * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification
4189 * of new data availability is sent unconditionally.
4190 * If **0** is specified in *flags*, an adaptive notification
4191 * of new data availability is sent.
4193 * See 'bpf_ringbuf_output()' for the definition of adaptive notification.
4195 * Nothing. Always succeeds.
4197 * void bpf_ringbuf_discard(void *data, u64 flags)
4199 * Discard reserved ring buffer sample, pointed to by *data*.
4200 * If **BPF_RB_NO_WAKEUP** is specified in *flags*, no notification
4201 * of new data availability is sent.
4202 * If **BPF_RB_FORCE_WAKEUP** is specified in *flags*, notification
4203 * of new data availability is sent unconditionally.
4204 * If **0** is specified in *flags*, an adaptive notification
4205 * of new data availability is sent.
4207 * See 'bpf_ringbuf_output()' for the definition of adaptive notification.
4209 * Nothing. Always succeeds.
4211 * u64 bpf_ringbuf_query(void *ringbuf, u64 flags)
4213 * Query various characteristics of provided ring buffer. What
4214 * exactly is queries is determined by *flags*:
4216 * * **BPF_RB_AVAIL_DATA**: Amount of data not yet consumed.
4217 * * **BPF_RB_RING_SIZE**: The size of ring buffer.
4218 * * **BPF_RB_CONS_POS**: Consumer position (can wrap around).
4219 * * **BPF_RB_PROD_POS**: Producer(s) position (can wrap around).
4221 * Data returned is just a momentary snapshot of actual values
4222 * and could be inaccurate, so this facility should be used to
4223 * power heuristics and for reporting, not to make 100% correct
4226 * Requested value, or 0, if *flags* are not recognized.
4228 * long bpf_csum_level(struct sk_buff *skb, u64 level)
4230 * Change the skbs checksum level by one layer up or down, or
4231 * reset it entirely to none in order to have the stack perform
4232 * checksum validation. The level is applicable to the following
4233 * protocols: TCP, UDP, GRE, SCTP, FCOE. For example, a decap of
4234 * | ETH | IP | UDP | GUE | IP | TCP | into | ETH | IP | TCP |
4235 * through **bpf_skb_adjust_room**\ () helper with passing in
4236 * **BPF_F_ADJ_ROOM_NO_CSUM_RESET** flag would require one call
4237 * to **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_DEC** since
4238 * the UDP header is removed. Similarly, an encap of the latter
4239 * into the former could be accompanied by a helper call to
4240 * **bpf_csum_level**\ () with **BPF_CSUM_LEVEL_INC** if the
4241 * skb is still intended to be processed in higher layers of the
4242 * stack instead of just egressing at tc.
4244 * There are three supported level settings at this time:
4246 * * **BPF_CSUM_LEVEL_INC**: Increases skb->csum_level for skbs
4247 * with CHECKSUM_UNNECESSARY.
4248 * * **BPF_CSUM_LEVEL_DEC**: Decreases skb->csum_level for skbs
4249 * with CHECKSUM_UNNECESSARY.
4250 * * **BPF_CSUM_LEVEL_RESET**: Resets skb->csum_level to 0 and
4251 * sets CHECKSUM_NONE to force checksum validation by the stack.
4252 * * **BPF_CSUM_LEVEL_QUERY**: No-op, returns the current
4255 * 0 on success, or a negative error in case of failure. In the
4256 * case of **BPF_CSUM_LEVEL_QUERY**, the current skb->csum_level
4257 * is returned or the error code -EACCES in case the skb is not
4258 * subject to CHECKSUM_UNNECESSARY.
4260 * struct tcp6_sock *bpf_skc_to_tcp6_sock(void *sk)
4262 * Dynamically cast a *sk* pointer to a *tcp6_sock* pointer.
4264 * *sk* if casting is valid, or **NULL** otherwise.
4266 * struct tcp_sock *bpf_skc_to_tcp_sock(void *sk)
4268 * Dynamically cast a *sk* pointer to a *tcp_sock* pointer.
4270 * *sk* if casting is valid, or **NULL** otherwise.
4272 * struct tcp_timewait_sock *bpf_skc_to_tcp_timewait_sock(void *sk)
4274 * Dynamically cast a *sk* pointer to a *tcp_timewait_sock* pointer.
4276 * *sk* if casting is valid, or **NULL** otherwise.
4278 * struct tcp_request_sock *bpf_skc_to_tcp_request_sock(void *sk)
4280 * Dynamically cast a *sk* pointer to a *tcp_request_sock* pointer.
4282 * *sk* if casting is valid, or **NULL** otherwise.
4284 * struct udp6_sock *bpf_skc_to_udp6_sock(void *sk)
4286 * Dynamically cast a *sk* pointer to a *udp6_sock* pointer.
4288 * *sk* if casting is valid, or **NULL** otherwise.
4290 * long bpf_get_task_stack(struct task_struct *task, void *buf, u32 size, u64 flags)
4292 * Return a user or a kernel stack in bpf program provided buffer.
4293 * To achieve this, the helper needs *task*, which is a valid
4294 * pointer to **struct task_struct**. To store the stacktrace, the
4295 * bpf program provides *buf* with a nonnegative *size*.
4297 * The last argument, *flags*, holds the number of stack frames to
4298 * skip (from 0 to 255), masked with
4299 * **BPF_F_SKIP_FIELD_MASK**. The next bits can be used to set
4300 * the following flags:
4302 * **BPF_F_USER_STACK**
4303 * Collect a user space stack instead of a kernel stack.
4304 * **BPF_F_USER_BUILD_ID**
4305 * Collect buildid+offset instead of ips for user stack,
4306 * only valid if **BPF_F_USER_STACK** is also specified.
4308 * **bpf_get_task_stack**\ () can collect up to
4309 * **PERF_MAX_STACK_DEPTH** both kernel and user frames, subject
4310 * to sufficient large buffer size. Note that
4311 * this limit can be controlled with the **sysctl** program, and
4312 * that it should be manually increased in order to profile long
4313 * user stacks (such as stacks for Java programs). To do so, use:
4317 * # sysctl kernel.perf_event_max_stack=<new value>
4319 * The non-negative copied *buf* length equal to or less than
4320 * *size* on success, or a negative error in case of failure.
4322 * long bpf_load_hdr_opt(struct bpf_sock_ops *skops, void *searchby_res, u32 len, u64 flags)
4324 * Load header option. Support reading a particular TCP header
4325 * option for bpf program (**BPF_PROG_TYPE_SOCK_OPS**).
4327 * If *flags* is 0, it will search the option from the
4328 * *skops*\ **->skb_data**. The comment in **struct bpf_sock_ops**
4329 * has details on what skb_data contains under different
4330 * *skops*\ **->op**.
4332 * The first byte of the *searchby_res* specifies the
4333 * kind that it wants to search.
4335 * If the searching kind is an experimental kind
4336 * (i.e. 253 or 254 according to RFC6994). It also
4337 * needs to specify the "magic" which is either
4338 * 2 bytes or 4 bytes. It then also needs to
4339 * specify the size of the magic by using
4340 * the 2nd byte which is "kind-length" of a TCP
4341 * header option and the "kind-length" also
4342 * includes the first 2 bytes "kind" and "kind-length"
4343 * itself as a normal TCP header option also does.
4345 * For example, to search experimental kind 254 with
4346 * 2 byte magic 0xeB9F, the searchby_res should be
4347 * [ 254, 4, 0xeB, 0x9F, 0, 0, .... 0 ].
4349 * To search for the standard window scale option (3),
4350 * the *searchby_res* should be [ 3, 0, 0, .... 0 ].
4351 * Note, kind-length must be 0 for regular option.
4353 * Searching for No-Op (0) and End-of-Option-List (1) are
4356 * *len* must be at least 2 bytes which is the minimal size
4357 * of a header option.
4361 * * **BPF_LOAD_HDR_OPT_TCP_SYN** to search from the
4362 * saved_syn packet or the just-received syn packet.
4365 * > 0 when found, the header option is copied to *searchby_res*.
4366 * The return value is the total length copied. On failure, a
4367 * negative error code is returned:
4369 * **-EINVAL** if a parameter is invalid.
4371 * **-ENOMSG** if the option is not found.
4373 * **-ENOENT** if no syn packet is available when
4374 * **BPF_LOAD_HDR_OPT_TCP_SYN** is used.
4376 * **-ENOSPC** if there is not enough space. Only *len* number of
4379 * **-EFAULT** on failure to parse the header options in the
4382 * **-EPERM** if the helper cannot be used under the current
4383 * *skops*\ **->op**.
4385 * long bpf_store_hdr_opt(struct bpf_sock_ops *skops, const void *from, u32 len, u64 flags)
4387 * Store header option. The data will be copied
4388 * from buffer *from* with length *len* to the TCP header.
4390 * The buffer *from* should have the whole option that
4391 * includes the kind, kind-length, and the actual
4392 * option data. The *len* must be at least kind-length
4393 * long. The kind-length does not have to be 4 byte
4394 * aligned. The kernel will take care of the padding
4395 * and setting the 4 bytes aligned value to th->doff.
4397 * This helper will check for duplicated option
4398 * by searching the same option in the outgoing skb.
4400 * This helper can only be called during
4401 * **BPF_SOCK_OPS_WRITE_HDR_OPT_CB**.
4404 * 0 on success, or negative error in case of failure:
4406 * **-EINVAL** If param is invalid.
4408 * **-ENOSPC** if there is not enough space in the header.
4409 * Nothing has been written
4411 * **-EEXIST** if the option already exists.
4413 * **-EFAULT** on failrue to parse the existing header options.
4415 * **-EPERM** if the helper cannot be used under the current
4416 * *skops*\ **->op**.
4418 * long bpf_reserve_hdr_opt(struct bpf_sock_ops *skops, u32 len, u64 flags)
4420 * Reserve *len* bytes for the bpf header option. The
4421 * space will be used by **bpf_store_hdr_opt**\ () later in
4422 * **BPF_SOCK_OPS_WRITE_HDR_OPT_CB**.
4424 * If **bpf_reserve_hdr_opt**\ () is called multiple times,
4425 * the total number of bytes will be reserved.
4427 * This helper can only be called during
4428 * **BPF_SOCK_OPS_HDR_OPT_LEN_CB**.
4431 * 0 on success, or negative error in case of failure:
4433 * **-EINVAL** if a parameter is invalid.
4435 * **-ENOSPC** if there is not enough space in the header.
4437 * **-EPERM** if the helper cannot be used under the current
4438 * *skops*\ **->op**.
4440 * void *bpf_inode_storage_get(struct bpf_map *map, void *inode, void *value, u64 flags)
4442 * Get a bpf_local_storage from an *inode*.
4444 * Logically, it could be thought of as getting the value from
4445 * a *map* with *inode* as the **key**. From this
4446 * perspective, the usage is not much different from
4447 * **bpf_map_lookup_elem**\ (*map*, **&**\ *inode*) except this
4448 * helper enforces the key must be an inode and the map must also
4449 * be a **BPF_MAP_TYPE_INODE_STORAGE**.
4451 * Underneath, the value is stored locally at *inode* instead of
4452 * the *map*. The *map* is used as the bpf-local-storage
4453 * "type". The bpf-local-storage "type" (i.e. the *map*) is
4454 * searched against all bpf_local_storage residing at *inode*.
4456 * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be
4457 * used such that a new bpf_local_storage will be
4458 * created if one does not exist. *value* can be used
4459 * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify
4460 * the initial value of a bpf_local_storage. If *value* is
4461 * **NULL**, the new bpf_local_storage will be zero initialized.
4463 * A bpf_local_storage pointer is returned on success.
4465 * **NULL** if not found or there was an error in adding
4466 * a new bpf_local_storage.
4468 * int bpf_inode_storage_delete(struct bpf_map *map, void *inode)
4470 * Delete a bpf_local_storage from an *inode*.
4474 * **-ENOENT** if the bpf_local_storage cannot be found.
4476 * long bpf_d_path(struct path *path, char *buf, u32 sz)
4478 * Return full path for given **struct path** object, which
4479 * needs to be the kernel BTF *path* object. The path is
4480 * returned in the provided buffer *buf* of size *sz* and
4481 * is zero terminated.
4484 * On success, the strictly positive length of the string,
4485 * including the trailing NUL character. On error, a negative
4488 * long bpf_copy_from_user(void *dst, u32 size, const void *user_ptr)
4490 * Read *size* bytes from user space address *user_ptr* and store
4491 * the data in *dst*. This is a wrapper of **copy_from_user**\ ().
4493 * 0 on success, or a negative error in case of failure.
4495 * long bpf_snprintf_btf(char *str, u32 str_size, struct btf_ptr *ptr, u32 btf_ptr_size, u64 flags)
4497 * Use BTF to store a string representation of *ptr*->ptr in *str*,
4498 * using *ptr*->type_id. This value should specify the type
4499 * that *ptr*->ptr points to. LLVM __builtin_btf_type_id(type, 1)
4500 * can be used to look up vmlinux BTF type ids. Traversing the
4501 * data structure using BTF, the type information and values are
4502 * stored in the first *str_size* - 1 bytes of *str*. Safe copy of
4503 * the pointer data is carried out to avoid kernel crashes during
4504 * operation. Smaller types can use string space on the stack;
4505 * larger programs can use map data to store the string
4508 * The string can be subsequently shared with userspace via
4509 * bpf_perf_event_output() or ring buffer interfaces.
4510 * bpf_trace_printk() is to be avoided as it places too small
4511 * a limit on string size to be useful.
4513 * *flags* is a combination of
4516 * no formatting around type information
4518 * no struct/union member names/types
4520 * show raw (unobfuscated) pointer values;
4521 * equivalent to printk specifier %px.
4523 * show zero-valued struct/union members; they
4524 * are not displayed by default
4527 * The number of bytes that were written (or would have been
4528 * written if output had to be truncated due to string size),
4529 * or a negative error in cases of failure.
4531 * long bpf_seq_printf_btf(struct seq_file *m, struct btf_ptr *ptr, u32 ptr_size, u64 flags)
4533 * Use BTF to write to seq_write a string representation of
4534 * *ptr*->ptr, using *ptr*->type_id as per bpf_snprintf_btf().
4535 * *flags* are identical to those used for bpf_snprintf_btf.
4537 * 0 on success or a negative error in case of failure.
4539 * u64 bpf_skb_cgroup_classid(struct sk_buff *skb)
4541 * See **bpf_get_cgroup_classid**\ () for the main description.
4542 * This helper differs from **bpf_get_cgroup_classid**\ () in that
4543 * the cgroup v1 net_cls class is retrieved only from the *skb*'s
4544 * associated socket instead of the current process.
4546 * The id is returned or 0 in case the id could not be retrieved.
4548 * long bpf_redirect_neigh(u32 ifindex, struct bpf_redir_neigh *params, int plen, u64 flags)
4550 * Redirect the packet to another net device of index *ifindex*
4551 * and fill in L2 addresses from neighboring subsystem. This helper
4552 * is somewhat similar to **bpf_redirect**\ (), except that it
4553 * populates L2 addresses as well, meaning, internally, the helper
4554 * relies on the neighbor lookup for the L2 address of the nexthop.
4556 * The helper will perform a FIB lookup based on the skb's
4557 * networking header to get the address of the next hop, unless
4558 * this is supplied by the caller in the *params* argument. The
4559 * *plen* argument indicates the len of *params* and should be set
4560 * to 0 if *params* is NULL.
4562 * The *flags* argument is reserved and must be 0. The helper is
4563 * currently only supported for tc BPF program types, and enabled
4564 * for IPv4 and IPv6 protocols.
4566 * The helper returns **TC_ACT_REDIRECT** on success or
4567 * **TC_ACT_SHOT** on error.
4569 * void *bpf_per_cpu_ptr(const void *percpu_ptr, u32 cpu)
4571 * Take a pointer to a percpu ksym, *percpu_ptr*, and return a
4572 * pointer to the percpu kernel variable on *cpu*. A ksym is an
4573 * extern variable decorated with '__ksym'. For ksym, there is a
4574 * global var (either static or global) defined of the same name
4575 * in the kernel. The ksym is percpu if the global var is percpu.
4576 * The returned pointer points to the global percpu var on *cpu*.
4578 * bpf_per_cpu_ptr() has the same semantic as per_cpu_ptr() in the
4579 * kernel, except that bpf_per_cpu_ptr() may return NULL. This
4580 * happens if *cpu* is larger than nr_cpu_ids. The caller of
4581 * bpf_per_cpu_ptr() must check the returned value.
4583 * A pointer pointing to the kernel percpu variable on *cpu*, or
4584 * NULL, if *cpu* is invalid.
4586 * void *bpf_this_cpu_ptr(const void *percpu_ptr)
4588 * Take a pointer to a percpu ksym, *percpu_ptr*, and return a
4589 * pointer to the percpu kernel variable on this cpu. See the
4590 * description of 'ksym' in **bpf_per_cpu_ptr**\ ().
4592 * bpf_this_cpu_ptr() has the same semantic as this_cpu_ptr() in
4593 * the kernel. Different from **bpf_per_cpu_ptr**\ (), it would
4594 * never return NULL.
4596 * A pointer pointing to the kernel percpu variable on this cpu.
4598 * long bpf_redirect_peer(u32 ifindex, u64 flags)
4600 * Redirect the packet to another net device of index *ifindex*.
4601 * This helper is somewhat similar to **bpf_redirect**\ (), except
4602 * that the redirection happens to the *ifindex*' peer device and
4603 * the netns switch takes place from ingress to ingress without
4604 * going through the CPU's backlog queue.
4606 * The *flags* argument is reserved and must be 0. The helper is
4607 * currently only supported for tc BPF program types at the ingress
4608 * hook and for veth device types. The peer device must reside in a
4609 * different network namespace.
4611 * The helper returns **TC_ACT_REDIRECT** on success or
4612 * **TC_ACT_SHOT** on error.
4614 * void *bpf_task_storage_get(struct bpf_map *map, struct task_struct *task, void *value, u64 flags)
4616 * Get a bpf_local_storage from the *task*.
4618 * Logically, it could be thought of as getting the value from
4619 * a *map* with *task* as the **key**. From this
4620 * perspective, the usage is not much different from
4621 * **bpf_map_lookup_elem**\ (*map*, **&**\ *task*) except this
4622 * helper enforces the key must be an task_struct and the map must also
4623 * be a **BPF_MAP_TYPE_TASK_STORAGE**.
4625 * Underneath, the value is stored locally at *task* instead of
4626 * the *map*. The *map* is used as the bpf-local-storage
4627 * "type". The bpf-local-storage "type" (i.e. the *map*) is
4628 * searched against all bpf_local_storage residing at *task*.
4630 * An optional *flags* (**BPF_LOCAL_STORAGE_GET_F_CREATE**) can be
4631 * used such that a new bpf_local_storage will be
4632 * created if one does not exist. *value* can be used
4633 * together with **BPF_LOCAL_STORAGE_GET_F_CREATE** to specify
4634 * the initial value of a bpf_local_storage. If *value* is
4635 * **NULL**, the new bpf_local_storage will be zero initialized.
4637 * A bpf_local_storage pointer is returned on success.
4639 * **NULL** if not found or there was an error in adding
4640 * a new bpf_local_storage.
4642 * long bpf_task_storage_delete(struct bpf_map *map, struct task_struct *task)
4644 * Delete a bpf_local_storage from a *task*.
4648 * **-ENOENT** if the bpf_local_storage cannot be found.
4650 * struct task_struct *bpf_get_current_task_btf(void)
4652 * Return a BTF pointer to the "current" task.
4653 * This pointer can also be used in helpers that accept an
4654 * *ARG_PTR_TO_BTF_ID* of type *task_struct*.
4656 * Pointer to the current task.
4658 * long bpf_bprm_opts_set(struct linux_binprm *bprm, u64 flags)
4660 * Set or clear certain options on *bprm*:
4662 * **BPF_F_BPRM_SECUREEXEC** Set the secureexec bit
4663 * which sets the **AT_SECURE** auxv for glibc. The bit
4664 * is cleared if the flag is not specified.
4666 * **-EINVAL** if invalid *flags* are passed, zero otherwise.
4668 * u64 bpf_ktime_get_coarse_ns(void)
4670 * Return a coarse-grained version of the time elapsed since
4671 * system boot, in nanoseconds. Does not include time the system
4674 * See: **clock_gettime**\ (**CLOCK_MONOTONIC_COARSE**)
4678 * long bpf_ima_inode_hash(struct inode *inode, void *dst, u32 size)
4680 * Returns the stored IMA hash of the *inode* (if it's avaialable).
4681 * If the hash is larger than *size*, then only *size*
4682 * bytes will be copied to *dst*
4684 * The **hash_algo** is returned on success,
4685 * **-EOPNOTSUP** if IMA is disabled or **-EINVAL** if
4686 * invalid arguments are passed.
4688 * struct socket *bpf_sock_from_file(struct file *file)
4690 * If the given file represents a socket, returns the associated
4693 * A pointer to a struct socket on success or NULL if the file is
4696 * long bpf_check_mtu(void *ctx, u32 ifindex, u32 *mtu_len, s32 len_diff, u64 flags)
4698 * Check packet size against exceeding MTU of net device (based
4699 * on *ifindex*). This helper will likely be used in combination
4700 * with helpers that adjust/change the packet size.
4702 * The argument *len_diff* can be used for querying with a planned
4703 * size change. This allows to check MTU prior to changing packet
4704 * ctx. Providing an *len_diff* adjustment that is larger than the
4705 * actual packet size (resulting in negative packet size) will in
4706 * principle not exceed the MTU, why it is not considered a
4707 * failure. Other BPF-helpers are needed for performing the
4708 * planned size change, why the responsability for catch a negative
4709 * packet size belong in those helpers.
4711 * Specifying *ifindex* zero means the MTU check is performed
4712 * against the current net device. This is practical if this isn't
4713 * used prior to redirect.
4715 * On input *mtu_len* must be a valid pointer, else verifier will
4716 * reject BPF program. If the value *mtu_len* is initialized to
4717 * zero then the ctx packet size is use. When value *mtu_len* is
4718 * provided as input this specify the L3 length that the MTU check
4719 * is done against. Remember XDP and TC length operate at L2, but
4720 * this value is L3 as this correlate to MTU and IP-header tot_len
4721 * values which are L3 (similar behavior as bpf_fib_lookup).
4723 * The Linux kernel route table can configure MTUs on a more
4724 * specific per route level, which is not provided by this helper.
4725 * For route level MTU checks use the **bpf_fib_lookup**\ ()
4728 * *ctx* is either **struct xdp_md** for XDP programs or
4729 * **struct sk_buff** for tc cls_act programs.
4731 * The *flags* argument can be a combination of one or more of the
4734 * **BPF_MTU_CHK_SEGS**
4735 * This flag will only works for *ctx* **struct sk_buff**.
4736 * If packet context contains extra packet segment buffers
4737 * (often knows as GSO skb), then MTU check is harder to
4738 * check at this point, because in transmit path it is
4739 * possible for the skb packet to get re-segmented
4740 * (depending on net device features). This could still be
4741 * a MTU violation, so this flag enables performing MTU
4742 * check against segments, with a different violation
4743 * return code to tell it apart. Check cannot use len_diff.
4745 * On return *mtu_len* pointer contains the MTU value of the net
4746 * device. Remember the net device configured MTU is the L3 size,
4747 * which is returned here and XDP and TC length operate at L2.
4748 * Helper take this into account for you, but remember when using
4749 * MTU value in your BPF-code.
4752 * * 0 on success, and populate MTU value in *mtu_len* pointer.
4754 * * < 0 if any input argument is invalid (*mtu_len* not updated)
4756 * MTU violations return positive values, but also populate MTU
4757 * value in *mtu_len* pointer, as this can be needed for
4758 * implementing PMTU handing:
4760 * * **BPF_MTU_CHK_RET_FRAG_NEEDED**
4761 * * **BPF_MTU_CHK_RET_SEGS_TOOBIG**
4763 * long bpf_for_each_map_elem(struct bpf_map *map, void *callback_fn, void *callback_ctx, u64 flags)
4765 * For each element in **map**, call **callback_fn** function with
4766 * **map**, **callback_ctx** and other map-specific parameters.
4767 * The **callback_fn** should be a static function and
4768 * the **callback_ctx** should be a pointer to the stack.
4769 * The **flags** is used to control certain aspects of the helper.
4770 * Currently, the **flags** must be 0.
4772 * The following are a list of supported map types and their
4773 * respective expected callback signatures:
4775 * BPF_MAP_TYPE_HASH, BPF_MAP_TYPE_PERCPU_HASH,
4776 * BPF_MAP_TYPE_LRU_HASH, BPF_MAP_TYPE_LRU_PERCPU_HASH,
4777 * BPF_MAP_TYPE_ARRAY, BPF_MAP_TYPE_PERCPU_ARRAY
4779 * long (\*callback_fn)(struct bpf_map \*map, const void \*key, void \*value, void \*ctx);
4781 * For per_cpu maps, the map_value is the value on the cpu where the
4782 * bpf_prog is running.
4784 * If **callback_fn** return 0, the helper will continue to the next
4785 * element. If return value is 1, the helper will skip the rest of
4786 * elements and return. Other return values are not used now.
4789 * The number of traversed map elements for success, **-EINVAL** for
4790 * invalid **flags**.
4792 * long bpf_snprintf(char *str, u32 str_size, const char *fmt, u64 *data, u32 data_len)
4794 * Outputs a string into the **str** buffer of size **str_size**
4795 * based on a format string stored in a read-only map pointed by
4798 * Each format specifier in **fmt** corresponds to one u64 element
4799 * in the **data** array. For strings and pointers where pointees
4800 * are accessed, only the pointer values are stored in the *data*
4801 * array. The *data_len* is the size of *data* in bytes - must be
4804 * Formats **%s** and **%p{i,I}{4,6}** require to read kernel
4805 * memory. Reading kernel memory may fail due to either invalid
4806 * address or valid address but requiring a major memory fault. If
4807 * reading kernel memory fails, the string for **%s** will be an
4808 * empty string, and the ip address for **%p{i,I}{4,6}** will be 0.
4809 * Not returning error to bpf program is consistent with what
4810 * **bpf_trace_printk**\ () does for now.
4813 * The strictly positive length of the formatted string, including
4814 * the trailing zero character. If the return value is greater than
4815 * **str_size**, **str** contains a truncated string, guaranteed to
4816 * be zero-terminated except when **str_size** is 0.
4818 * Or **-EBUSY** if the per-CPU memory copy buffer is busy.
4820 * long bpf_sys_bpf(u32 cmd, void *attr, u32 attr_size)
4822 * Execute bpf syscall with given arguments.
4826 * long bpf_btf_find_by_name_kind(char *name, int name_sz, u32 kind, int flags)
4828 * Find BTF type with given name and kind in vmlinux BTF or in module's BTFs.
4830 * Returns btf_id and btf_obj_fd in lower and upper 32 bits.
4832 * long bpf_sys_close(u32 fd)
4834 * Execute close syscall for given FD.
4838 * long bpf_timer_init(struct bpf_timer *timer, struct bpf_map *map, u64 flags)
4840 * Initialize the timer.
4841 * First 4 bits of *flags* specify clockid.
4842 * Only CLOCK_MONOTONIC, CLOCK_REALTIME, CLOCK_BOOTTIME are allowed.
4843 * All other bits of *flags* are reserved.
4844 * The verifier will reject the program if *timer* is not from
4848 * **-EBUSY** if *timer* is already initialized.
4849 * **-EINVAL** if invalid *flags* are passed.
4850 * **-EPERM** if *timer* is in a map that doesn't have any user references.
4851 * The user space should either hold a file descriptor to a map with timers
4852 * or pin such map in bpffs. When map is unpinned or file descriptor is
4853 * closed all timers in the map will be cancelled and freed.
4855 * long bpf_timer_set_callback(struct bpf_timer *timer, void *callback_fn)
4857 * Configure the timer to call *callback_fn* static function.
4860 * **-EINVAL** if *timer* was not initialized with bpf_timer_init() earlier.
4861 * **-EPERM** if *timer* is in a map that doesn't have any user references.
4862 * The user space should either hold a file descriptor to a map with timers
4863 * or pin such map in bpffs. When map is unpinned or file descriptor is
4864 * closed all timers in the map will be cancelled and freed.
4866 * long bpf_timer_start(struct bpf_timer *timer, u64 nsecs, u64 flags)
4868 * Set timer expiration N nanoseconds from the current time. The
4869 * configured callback will be invoked in soft irq context on some cpu
4870 * and will not repeat unless another bpf_timer_start() is made.
4871 * In such case the next invocation can migrate to a different cpu.
4872 * Since struct bpf_timer is a field inside map element the map
4873 * owns the timer. The bpf_timer_set_callback() will increment refcnt
4874 * of BPF program to make sure that callback_fn code stays valid.
4875 * When user space reference to a map reaches zero all timers
4876 * in a map are cancelled and corresponding program's refcnts are
4877 * decremented. This is done to make sure that Ctrl-C of a user
4878 * process doesn't leave any timers running. If map is pinned in
4879 * bpffs the callback_fn can re-arm itself indefinitely.
4880 * bpf_map_update/delete_elem() helpers and user space sys_bpf commands
4881 * cancel and free the timer in the given map element.
4882 * The map can contain timers that invoke callback_fn-s from different
4883 * programs. The same callback_fn can serve different timers from
4884 * different maps if key/value layout matches across maps.
4885 * Every bpf_timer_set_callback() can have different callback_fn.
4889 * **-EINVAL** if *timer* was not initialized with bpf_timer_init() earlier
4890 * or invalid *flags* are passed.
4892 * long bpf_timer_cancel(struct bpf_timer *timer)
4894 * Cancel the timer and wait for callback_fn to finish if it was running.
4896 * 0 if the timer was not active.
4897 * 1 if the timer was active.
4898 * **-EINVAL** if *timer* was not initialized with bpf_timer_init() earlier.
4899 * **-EDEADLK** if callback_fn tried to call bpf_timer_cancel() on its
4900 * own timer which would have led to a deadlock otherwise.
4902 * u64 bpf_get_func_ip(void *ctx)
4904 * Get address of the traced function (for tracing and kprobe programs).
4906 * Address of the traced function.
4908 * u64 bpf_get_attach_cookie(void *ctx)
4910 * Get bpf_cookie value provided (optionally) during the program
4911 * attachment. It might be different for each individual
4912 * attachment, even if BPF program itself is the same.
4913 * Expects BPF program context *ctx* as a first argument.
4915 * Supported for the following program types:
4920 * Value specified by user at BPF link creation/attachment time
4921 * or 0, if it was not specified.
4923 * long bpf_task_pt_regs(struct task_struct *task)
4925 * Get the struct pt_regs associated with **task**.
4927 * A pointer to struct pt_regs.
4929 * long bpf_get_branch_snapshot(void *entries, u32 size, u64 flags)
4931 * Get branch trace from hardware engines like Intel LBR. The
4932 * hardware engine is stopped shortly after the helper is
4933 * called. Therefore, the user need to filter branch entries
4934 * based on the actual use case. To capture branch trace
4935 * before the trigger point of the BPF program, the helper
4936 * should be called at the beginning of the BPF program.
4938 * The data is stored as struct perf_branch_entry into output
4939 * buffer *entries*. *size* is the size of *entries* in bytes.
4940 * *flags* is reserved for now and must be zero.
4943 * On success, number of bytes written to *buf*. On error, a
4946 * **-EINVAL** if *flags* is not zero.
4948 * **-ENOENT** if architecture does not support branch records.
4950 * long bpf_trace_vprintk(const char *fmt, u32 fmt_size, const void *data, u32 data_len)
4952 * Behaves like **bpf_trace_printk**\ () helper, but takes an array of u64
4953 * to format and can handle more format args as a result.
4955 * Arguments are to be used as in **bpf_seq_printf**\ () helper.
4957 * The number of bytes written to the buffer, or a negative error
4958 * in case of failure.
4960 * struct unix_sock *bpf_skc_to_unix_sock(void *sk)
4962 * Dynamically cast a *sk* pointer to a *unix_sock* pointer.
4964 * *sk* if casting is valid, or **NULL** otherwise.
4966 * long bpf_kallsyms_lookup_name(const char *name, int name_sz, int flags, u64 *res)
4968 * Get the address of a kernel symbol, returned in *res*. *res* is
4969 * set to 0 if the symbol is not found.
4971 * On success, zero. On error, a negative value.
4973 * **-EINVAL** if *flags* is not zero.
4975 * **-EINVAL** if string *name* is not the same size as *name_sz*.
4977 * **-ENOENT** if symbol is not found.
4979 * **-EPERM** if caller does not have permission to obtain kernel address.
4981 * long bpf_find_vma(struct task_struct *task, u64 addr, void *callback_fn, void *callback_ctx, u64 flags)
4983 * Find vma of *task* that contains *addr*, call *callback_fn*
4984 * function with *task*, *vma*, and *callback_ctx*.
4985 * The *callback_fn* should be a static function and
4986 * the *callback_ctx* should be a pointer to the stack.
4987 * The *flags* is used to control certain aspects of the helper.
4988 * Currently, the *flags* must be 0.
4990 * The expected callback signature is
4992 * long (\*callback_fn)(struct task_struct \*task, struct vm_area_struct \*vma, void \*callback_ctx);
4996 * **-ENOENT** if *task->mm* is NULL, or no vma contains *addr*.
4997 * **-EBUSY** if failed to try lock mmap_lock.
4998 * **-EINVAL** for invalid **flags**.
5000 * long bpf_loop(u32 nr_loops, void *callback_fn, void *callback_ctx, u64 flags)
5002 * For **nr_loops**, call **callback_fn** function
5003 * with **callback_ctx** as the context parameter.
5004 * The **callback_fn** should be a static function and
5005 * the **callback_ctx** should be a pointer to the stack.
5006 * The **flags** is used to control certain aspects of the helper.
5007 * Currently, the **flags** must be 0. Currently, nr_loops is
5008 * limited to 1 << 23 (~8 million) loops.
5010 * long (\*callback_fn)(u32 index, void \*ctx);
5012 * where **index** is the current index in the loop. The index
5015 * If **callback_fn** returns 0, the helper will continue to the next
5016 * loop. If return value is 1, the helper will skip the rest of
5017 * the loops and return. Other return values are not used now,
5018 * and will be rejected by the verifier.
5021 * The number of loops performed, **-EINVAL** for invalid **flags**,
5022 * **-E2BIG** if **nr_loops** exceeds the maximum number of loops.
5024 * long bpf_strncmp(const char *s1, u32 s1_sz, const char *s2)
5026 * Do strncmp() between **s1** and **s2**. **s1** doesn't need
5027 * to be null-terminated and **s1_sz** is the maximum storage
5028 * size of **s1**. **s2** must be a read-only string.
5030 * An integer less than, equal to, or greater than zero
5031 * if the first **s1_sz** bytes of **s1** is found to be
5032 * less than, to match, or be greater than **s2**.
5034 * long bpf_get_func_arg(void *ctx, u32 n, u64 *value)
5036 * Get **n**-th argument (zero based) of the traced function (for tracing programs)
5037 * returned in **value**.
5041 * **-EINVAL** if n >= arguments count of traced function.
5043 * long bpf_get_func_ret(void *ctx, u64 *value)
5045 * Get return value of the traced function (for tracing programs)
5050 * **-EOPNOTSUPP** for tracing programs other than BPF_TRACE_FEXIT or BPF_MODIFY_RETURN.
5052 * long bpf_get_func_arg_cnt(void *ctx)
5054 * Get number of arguments of the traced function (for tracing programs).
5057 * The number of arguments of the traced function.
5059 * int bpf_get_retval(void)
5061 * Get the syscall's return value that will be returned to userspace.
5063 * This helper is currently supported by cgroup programs only.
5065 * The syscall's return value.
5067 * int bpf_set_retval(int retval)
5069 * Set the syscall's return value that will be returned to userspace.
5071 * This helper is currently supported by cgroup programs only.
5073 * 0 on success, or a negative error in case of failure.
5075 * u64 bpf_xdp_get_buff_len(struct xdp_buff *xdp_md)
5077 * Get the total size of a given xdp buff (linear and paged area)
5079 * The total size of a given xdp buffer.
5081 * long bpf_xdp_load_bytes(struct xdp_buff *xdp_md, u32 offset, void *buf, u32 len)
5083 * This helper is provided as an easy way to load data from a
5084 * xdp buffer. It can be used to load *len* bytes from *offset* from
5085 * the frame associated to *xdp_md*, into the buffer pointed by
5088 * 0 on success, or a negative error in case of failure.
5090 * long bpf_xdp_store_bytes(struct xdp_buff *xdp_md, u32 offset, void *buf, u32 len)
5092 * Store *len* bytes from buffer *buf* into the frame
5093 * associated to *xdp_md*, at *offset*.
5095 * 0 on success, or a negative error in case of failure.
5097 * long bpf_copy_from_user_task(void *dst, u32 size, const void *user_ptr, struct task_struct *tsk, u64 flags)
5099 * Read *size* bytes from user space address *user_ptr* in *tsk*'s
5100 * address space, and stores the data in *dst*. *flags* is not
5101 * used yet and is provided for future extensibility. This helper
5102 * can only be used by sleepable programs.
5104 * 0 on success, or a negative error in case of failure. On error
5105 * *dst* buffer is zeroed out.
5107 * long bpf_skb_set_tstamp(struct sk_buff *skb, u64 tstamp, u32 tstamp_type)
5109 * Change the __sk_buff->tstamp_type to *tstamp_type*
5110 * and set *tstamp* to the __sk_buff->tstamp together.
5112 * If there is no need to change the __sk_buff->tstamp_type,
5113 * the tstamp value can be directly written to __sk_buff->tstamp
5116 * BPF_SKB_TSTAMP_DELIVERY_MONO is the only tstamp that
5117 * will be kept during bpf_redirect_*(). A non zero
5118 * *tstamp* must be used with the BPF_SKB_TSTAMP_DELIVERY_MONO
5121 * A BPF_SKB_TSTAMP_UNSPEC *tstamp_type* can only be used
5122 * with a zero *tstamp*.
5124 * Only IPv4 and IPv6 skb->protocol are supported.
5126 * This function is most useful when it needs to set a
5127 * mono delivery time to __sk_buff->tstamp and then
5128 * bpf_redirect_*() to the egress of an iface. For example,
5129 * changing the (rcv) timestamp in __sk_buff->tstamp at
5130 * ingress to a mono delivery time and then bpf_redirect_*()
5131 * to sch_fq@phy-dev.
5134 * **-EINVAL** for invalid input
5135 * **-EOPNOTSUPP** for unsupported protocol
5137 * long bpf_ima_file_hash(struct file *file, void *dst, u32 size)
5139 * Returns a calculated IMA hash of the *file*.
5140 * If the hash is larger than *size*, then only *size*
5141 * bytes will be copied to *dst*
5143 * The **hash_algo** is returned on success,
5144 * **-EOPNOTSUP** if the hash calculation failed or **-EINVAL** if
5145 * invalid arguments are passed.
5147 * void *bpf_kptr_xchg(void *map_value, void *ptr)
5149 * Exchange kptr at pointer *map_value* with *ptr*, and return the
5150 * old value. *ptr* can be NULL, otherwise it must be a referenced
5151 * pointer which will be released when this helper is called.
5153 * The old value of kptr (which can be NULL). The returned pointer
5154 * if not NULL, is a reference which must be released using its
5155 * corresponding release function, or moved into a BPF map before
5158 #define __BPF_FUNC_MAPPER(FN) \
5160 FN(map_lookup_elem), \
5161 FN(map_update_elem), \
5162 FN(map_delete_elem), \
5166 FN(get_prandom_u32), \
5167 FN(get_smp_processor_id), \
5168 FN(skb_store_bytes), \
5169 FN(l3_csum_replace), \
5170 FN(l4_csum_replace), \
5172 FN(clone_redirect), \
5173 FN(get_current_pid_tgid), \
5174 FN(get_current_uid_gid), \
5175 FN(get_current_comm), \
5176 FN(get_cgroup_classid), \
5177 FN(skb_vlan_push), \
5179 FN(skb_get_tunnel_key), \
5180 FN(skb_set_tunnel_key), \
5181 FN(perf_event_read), \
5183 FN(get_route_realm), \
5184 FN(perf_event_output), \
5185 FN(skb_load_bytes), \
5188 FN(skb_get_tunnel_opt), \
5189 FN(skb_set_tunnel_opt), \
5190 FN(skb_change_proto), \
5191 FN(skb_change_type), \
5192 FN(skb_under_cgroup), \
5193 FN(get_hash_recalc), \
5194 FN(get_current_task), \
5195 FN(probe_write_user), \
5196 FN(current_task_under_cgroup), \
5197 FN(skb_change_tail), \
5198 FN(skb_pull_data), \
5200 FN(set_hash_invalid), \
5201 FN(get_numa_node_id), \
5202 FN(skb_change_head), \
5203 FN(xdp_adjust_head), \
5204 FN(probe_read_str), \
5205 FN(get_socket_cookie), \
5206 FN(get_socket_uid), \
5209 FN(skb_adjust_room), \
5211 FN(sk_redirect_map), \
5212 FN(sock_map_update), \
5213 FN(xdp_adjust_meta), \
5214 FN(perf_event_read_value), \
5215 FN(perf_prog_read_value), \
5217 FN(override_return), \
5218 FN(sock_ops_cb_flags_set), \
5219 FN(msg_redirect_map), \
5220 FN(msg_apply_bytes), \
5221 FN(msg_cork_bytes), \
5222 FN(msg_pull_data), \
5224 FN(xdp_adjust_tail), \
5225 FN(skb_get_xfrm_state), \
5227 FN(skb_load_bytes_relative), \
5229 FN(sock_hash_update), \
5230 FN(msg_redirect_hash), \
5231 FN(sk_redirect_hash), \
5232 FN(lwt_push_encap), \
5233 FN(lwt_seg6_store_bytes), \
5234 FN(lwt_seg6_adjust_srh), \
5235 FN(lwt_seg6_action), \
5238 FN(skb_cgroup_id), \
5239 FN(get_current_cgroup_id), \
5240 FN(get_local_storage), \
5241 FN(sk_select_reuseport), \
5242 FN(skb_ancestor_cgroup_id), \
5243 FN(sk_lookup_tcp), \
5244 FN(sk_lookup_udp), \
5246 FN(map_push_elem), \
5248 FN(map_peek_elem), \
5249 FN(msg_push_data), \
5251 FN(rc_pointer_rel), \
5256 FN(skb_ecn_set_ce), \
5257 FN(get_listener_sock), \
5258 FN(skc_lookup_tcp), \
5259 FN(tcp_check_syncookie), \
5260 FN(sysctl_get_name), \
5261 FN(sysctl_get_current_value), \
5262 FN(sysctl_get_new_value), \
5263 FN(sysctl_set_new_value), \
5266 FN(sk_storage_get), \
5267 FN(sk_storage_delete), \
5269 FN(tcp_gen_syncookie), \
5271 FN(probe_read_user), \
5272 FN(probe_read_kernel), \
5273 FN(probe_read_user_str), \
5274 FN(probe_read_kernel_str), \
5276 FN(send_signal_thread), \
5278 FN(read_branch_records), \
5279 FN(get_ns_current_pid_tgid), \
5281 FN(get_netns_cookie), \
5282 FN(get_current_ancestor_cgroup_id), \
5284 FN(ktime_get_boot_ns), \
5288 FN(sk_ancestor_cgroup_id), \
5289 FN(ringbuf_output), \
5290 FN(ringbuf_reserve), \
5291 FN(ringbuf_submit), \
5292 FN(ringbuf_discard), \
5293 FN(ringbuf_query), \
5295 FN(skc_to_tcp6_sock), \
5296 FN(skc_to_tcp_sock), \
5297 FN(skc_to_tcp_timewait_sock), \
5298 FN(skc_to_tcp_request_sock), \
5299 FN(skc_to_udp6_sock), \
5300 FN(get_task_stack), \
5302 FN(store_hdr_opt), \
5303 FN(reserve_hdr_opt), \
5304 FN(inode_storage_get), \
5305 FN(inode_storage_delete), \
5307 FN(copy_from_user), \
5309 FN(seq_printf_btf), \
5310 FN(skb_cgroup_classid), \
5311 FN(redirect_neigh), \
5314 FN(redirect_peer), \
5315 FN(task_storage_get), \
5316 FN(task_storage_delete), \
5317 FN(get_current_task_btf), \
5318 FN(bprm_opts_set), \
5319 FN(ktime_get_coarse_ns), \
5320 FN(ima_inode_hash), \
5321 FN(sock_from_file), \
5323 FN(for_each_map_elem), \
5326 FN(btf_find_by_name_kind), \
5329 FN(timer_set_callback), \
5333 FN(get_attach_cookie), \
5335 FN(get_branch_snapshot), \
5336 FN(trace_vprintk), \
5337 FN(skc_to_unix_sock), \
5338 FN(kallsyms_lookup_name), \
5344 FN(get_func_arg_cnt), \
5347 FN(xdp_get_buff_len), \
5348 FN(xdp_load_bytes), \
5349 FN(xdp_store_bytes), \
5350 FN(copy_from_user_task), \
5351 FN(skb_set_tstamp), \
5352 FN(ima_file_hash), \
5356 /* integer value in 'imm' field of BPF_CALL instruction selects which helper
5357 * function eBPF program intends to call
5359 #define __BPF_ENUM_FN(x) BPF_FUNC_ ## x
5361 __BPF_FUNC_MAPPER(__BPF_ENUM_FN)
5364 #undef __BPF_ENUM_FN
5366 /* All flags used by eBPF helper functions, placed here. */
5368 /* BPF_FUNC_skb_store_bytes flags. */
5370 BPF_F_RECOMPUTE_CSUM = (1ULL << 0),
5371 BPF_F_INVALIDATE_HASH = (1ULL << 1),
5374 /* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
5375 * First 4 bits are for passing the header field size.
5378 BPF_F_HDR_FIELD_MASK = 0xfULL,
5381 /* BPF_FUNC_l4_csum_replace flags. */
5383 BPF_F_PSEUDO_HDR = (1ULL << 4),
5384 BPF_F_MARK_MANGLED_0 = (1ULL << 5),
5385 BPF_F_MARK_ENFORCE = (1ULL << 6),
5388 /* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
5390 BPF_F_INGRESS = (1ULL << 0),
5393 /* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
5395 BPF_F_TUNINFO_IPV6 = (1ULL << 0),
5398 /* flags for both BPF_FUNC_get_stackid and BPF_FUNC_get_stack. */
5400 BPF_F_SKIP_FIELD_MASK = 0xffULL,
5401 BPF_F_USER_STACK = (1ULL << 8),
5402 /* flags used by BPF_FUNC_get_stackid only. */
5403 BPF_F_FAST_STACK_CMP = (1ULL << 9),
5404 BPF_F_REUSE_STACKID = (1ULL << 10),
5405 /* flags used by BPF_FUNC_get_stack only. */
5406 BPF_F_USER_BUILD_ID = (1ULL << 11),
5409 /* BPF_FUNC_skb_set_tunnel_key flags. */
5411 BPF_F_ZERO_CSUM_TX = (1ULL << 1),
5412 BPF_F_DONT_FRAGMENT = (1ULL << 2),
5413 BPF_F_SEQ_NUMBER = (1ULL << 3),
5416 /* BPF_FUNC_perf_event_output, BPF_FUNC_perf_event_read and
5417 * BPF_FUNC_perf_event_read_value flags.
5420 BPF_F_INDEX_MASK = 0xffffffffULL,
5421 BPF_F_CURRENT_CPU = BPF_F_INDEX_MASK,
5422 /* BPF_FUNC_perf_event_output for sk_buff input context. */
5423 BPF_F_CTXLEN_MASK = (0xfffffULL << 32),
5426 /* Current network namespace */
5428 BPF_F_CURRENT_NETNS = (-1L),
5431 /* BPF_FUNC_csum_level level values. */
5433 BPF_CSUM_LEVEL_QUERY,
5436 BPF_CSUM_LEVEL_RESET,
5439 /* BPF_FUNC_skb_adjust_room flags. */
5441 BPF_F_ADJ_ROOM_FIXED_GSO = (1ULL << 0),
5442 BPF_F_ADJ_ROOM_ENCAP_L3_IPV4 = (1ULL << 1),
5443 BPF_F_ADJ_ROOM_ENCAP_L3_IPV6 = (1ULL << 2),
5444 BPF_F_ADJ_ROOM_ENCAP_L4_GRE = (1ULL << 3),
5445 BPF_F_ADJ_ROOM_ENCAP_L4_UDP = (1ULL << 4),
5446 BPF_F_ADJ_ROOM_NO_CSUM_RESET = (1ULL << 5),
5447 BPF_F_ADJ_ROOM_ENCAP_L2_ETH = (1ULL << 6),
5451 BPF_ADJ_ROOM_ENCAP_L2_MASK = 0xff,
5452 BPF_ADJ_ROOM_ENCAP_L2_SHIFT = 56,
5455 #define BPF_F_ADJ_ROOM_ENCAP_L2(len) (((__u64)len & \
5456 BPF_ADJ_ROOM_ENCAP_L2_MASK) \
5457 << BPF_ADJ_ROOM_ENCAP_L2_SHIFT)
5459 /* BPF_FUNC_sysctl_get_name flags. */
5461 BPF_F_SYSCTL_BASE_NAME = (1ULL << 0),
5464 /* BPF_FUNC_<kernel_obj>_storage_get flags */
5466 BPF_LOCAL_STORAGE_GET_F_CREATE = (1ULL << 0),
5467 /* BPF_SK_STORAGE_GET_F_CREATE is only kept for backward compatibility
5468 * and BPF_LOCAL_STORAGE_GET_F_CREATE must be used instead.
5470 BPF_SK_STORAGE_GET_F_CREATE = BPF_LOCAL_STORAGE_GET_F_CREATE,
5473 /* BPF_FUNC_read_branch_records flags. */
5475 BPF_F_GET_BRANCH_RECORDS_SIZE = (1ULL << 0),
5478 /* BPF_FUNC_bpf_ringbuf_commit, BPF_FUNC_bpf_ringbuf_discard, and
5479 * BPF_FUNC_bpf_ringbuf_output flags.
5482 BPF_RB_NO_WAKEUP = (1ULL << 0),
5483 BPF_RB_FORCE_WAKEUP = (1ULL << 1),
5486 /* BPF_FUNC_bpf_ringbuf_query flags */
5488 BPF_RB_AVAIL_DATA = 0,
5489 BPF_RB_RING_SIZE = 1,
5490 BPF_RB_CONS_POS = 2,
5491 BPF_RB_PROD_POS = 3,
5494 /* BPF ring buffer constants */
5496 BPF_RINGBUF_BUSY_BIT = (1U << 31),
5497 BPF_RINGBUF_DISCARD_BIT = (1U << 30),
5498 BPF_RINGBUF_HDR_SZ = 8,
5501 /* BPF_FUNC_sk_assign flags in bpf_sk_lookup context. */
5503 BPF_SK_LOOKUP_F_REPLACE = (1ULL << 0),
5504 BPF_SK_LOOKUP_F_NO_REUSEPORT = (1ULL << 1),
5507 /* Mode for BPF_FUNC_skb_adjust_room helper. */
5508 enum bpf_adj_room_mode {
5513 /* Mode for BPF_FUNC_skb_load_bytes_relative helper. */
5514 enum bpf_hdr_start_off {
5519 /* Encapsulation type for BPF_FUNC_lwt_push_encap helper. */
5520 enum bpf_lwt_encap_mode {
5522 BPF_LWT_ENCAP_SEG6_INLINE,
5526 /* Flags for bpf_bprm_opts_set helper */
5528 BPF_F_BPRM_SECUREEXEC = (1ULL << 0),
5531 /* Flags for bpf_redirect_map helper */
5533 BPF_F_BROADCAST = (1ULL << 3),
5534 BPF_F_EXCLUDE_INGRESS = (1ULL << 4),
5537 #define __bpf_md_ptr(type, name) \
5541 } __attribute__((aligned(8)))
5544 BPF_SKB_TSTAMP_UNSPEC,
5545 BPF_SKB_TSTAMP_DELIVERY_MONO, /* tstamp has mono delivery time */
5546 /* For any BPF_SKB_TSTAMP_* that the bpf prog cannot handle,
5547 * the bpf prog should handle it like BPF_SKB_TSTAMP_UNSPEC
5548 * and try to deduce it by ingress, egress or skb->sk->sk_clockid.
5552 /* user accessible mirror of in-kernel sk_buff.
5553 * new fields can only be added to the end of this structure
5559 __u32 queue_mapping;
5565 __u32 ingress_ifindex;
5575 /* Accessed by BPF_PROG_TYPE_sk_skb types from here to ... */
5577 __u32 remote_ip4; /* Stored in network byte order */
5578 __u32 local_ip4; /* Stored in network byte order */
5579 __u32 remote_ip6[4]; /* Stored in network byte order */
5580 __u32 local_ip6[4]; /* Stored in network byte order */
5581 __u32 remote_port; /* Stored in network byte order */
5582 __u32 local_port; /* stored in host byte order */
5586 __bpf_md_ptr(struct bpf_flow_keys *, flow_keys);
5590 __bpf_md_ptr(struct bpf_sock *, sk);
5593 __u32 :24; /* Padding, future use. */
5597 struct bpf_tunnel_key {
5601 __u32 remote_ipv6[4];
5605 __u16 tunnel_ext; /* Padding, future use. */
5609 /* user accessible mirror of in-kernel xfrm_state.
5610 * new fields can only be added to the end of this structure
5612 struct bpf_xfrm_state {
5614 __u32 spi; /* Stored in network byte order */
5616 __u16 ext; /* Padding, future use. */
5618 __u32 remote_ipv4; /* Stored in network byte order */
5619 __u32 remote_ipv6[4]; /* Stored in network byte order */
5623 /* Generic BPF return codes which all BPF program types may support.
5624 * The values are binary compatible with their TC_ACT_* counter-part to
5625 * provide backwards compatibility with existing SCHED_CLS and SCHED_ACT
5628 * XDP is handled seprately, see XDP_*.
5636 /* >127 are reserved for prog type specific return codes.
5638 * BPF_LWT_REROUTE: used by BPF_PROG_TYPE_LWT_IN and
5639 * BPF_PROG_TYPE_LWT_XMIT to indicate that skb had been
5640 * changed and should be routed based on its new L3 header.
5641 * (This is an L3 redirect, as opposed to L2 redirect
5642 * represented by BPF_REDIRECT above).
5644 BPF_LWT_REROUTE = 128,
5654 /* IP address also allows 1 and 2 bytes access */
5657 __u32 src_port; /* host byte order */
5658 __be16 dst_port; /* network byte order */
5659 __u16 :16; /* zero padding */
5663 __s32 rx_queue_mapping;
5666 struct bpf_tcp_sock {
5667 __u32 snd_cwnd; /* Sending congestion window */
5668 __u32 srtt_us; /* smoothed round trip time << 3 in usecs */
5670 __u32 snd_ssthresh; /* Slow start size threshold */
5671 __u32 rcv_nxt; /* What we want to receive next */
5672 __u32 snd_nxt; /* Next sequence we send */
5673 __u32 snd_una; /* First byte we want an ack for */
5674 __u32 mss_cache; /* Cached effective mss, not including SACKS */
5675 __u32 ecn_flags; /* ECN status bits. */
5676 __u32 rate_delivered; /* saved rate sample: packets delivered */
5677 __u32 rate_interval_us; /* saved rate sample: time elapsed */
5678 __u32 packets_out; /* Packets which are "in flight" */
5679 __u32 retrans_out; /* Retransmitted packets out */
5680 __u32 total_retrans; /* Total retransmits for entire connection */
5681 __u32 segs_in; /* RFC4898 tcpEStatsPerfSegsIn
5682 * total number of segments in.
5684 __u32 data_segs_in; /* RFC4898 tcpEStatsPerfDataSegsIn
5685 * total number of data segments in.
5687 __u32 segs_out; /* RFC4898 tcpEStatsPerfSegsOut
5688 * The total number of segments sent.
5690 __u32 data_segs_out; /* RFC4898 tcpEStatsPerfDataSegsOut
5691 * total number of data segments sent.
5693 __u32 lost_out; /* Lost packets */
5694 __u32 sacked_out; /* SACK'd packets */
5695 __u64 bytes_received; /* RFC4898 tcpEStatsAppHCThruOctetsReceived
5696 * sum(delta(rcv_nxt)), or how many bytes
5699 __u64 bytes_acked; /* RFC4898 tcpEStatsAppHCThruOctetsAcked
5700 * sum(delta(snd_una)), or how many bytes
5703 __u32 dsack_dups; /* RFC4898 tcpEStatsStackDSACKDups
5704 * total number of DSACK blocks received
5706 __u32 delivered; /* Total data packets delivered incl. rexmits */
5707 __u32 delivered_ce; /* Like the above but only ECE marked packets */
5708 __u32 icsk_retransmits; /* Number of unrecovered [RTO] timeouts */
5711 struct bpf_sock_tuple {
5728 struct bpf_xdp_sock {
5732 #define XDP_PACKET_HEADROOM 256
5734 /* User return codes for XDP prog type.
5735 * A valid XDP program must return one of these defined values. All other
5736 * return codes are reserved for future use. Unknown return codes will
5737 * result in packet drops and a warning via bpf_warn_invalid_xdp_action().
5747 /* user accessible metadata for XDP packet hook
5748 * new fields must be added to the end of this structure
5754 /* Below access go through struct xdp_rxq_info */
5755 __u32 ingress_ifindex; /* rxq->dev->ifindex */
5756 __u32 rx_queue_index; /* rxq->queue_index */
5758 __u32 egress_ifindex; /* txq->dev->ifindex */
5761 /* DEVMAP map-value layout
5763 * The struct data-layout of map-value is a configuration interface.
5764 * New members can only be added to the end of this structure.
5766 struct bpf_devmap_val {
5767 __u32 ifindex; /* device index */
5769 int fd; /* prog fd on map write */
5770 __u32 id; /* prog id on map read */
5774 /* CPUMAP map-value layout
5776 * The struct data-layout of map-value is a configuration interface.
5777 * New members can only be added to the end of this structure.
5779 struct bpf_cpumap_val {
5780 __u32 qsize; /* queue size to remote target CPU */
5782 int fd; /* prog fd on map write */
5783 __u32 id; /* prog id on map read */
5792 /* user accessible metadata for SK_MSG packet hook, new fields must
5793 * be added to the end of this structure
5796 __bpf_md_ptr(void *, data);
5797 __bpf_md_ptr(void *, data_end);
5800 __u32 remote_ip4; /* Stored in network byte order */
5801 __u32 local_ip4; /* Stored in network byte order */
5802 __u32 remote_ip6[4]; /* Stored in network byte order */
5803 __u32 local_ip6[4]; /* Stored in network byte order */
5804 __u32 remote_port; /* Stored in network byte order */
5805 __u32 local_port; /* stored in host byte order */
5806 __u32 size; /* Total size of sk_msg */
5808 __bpf_md_ptr(struct bpf_sock *, sk); /* current socket */
5811 struct sk_reuseport_md {
5813 * Start of directly accessible data. It begins from
5814 * the tcp/udp header.
5816 __bpf_md_ptr(void *, data);
5817 /* End of directly accessible data */
5818 __bpf_md_ptr(void *, data_end);
5820 * Total length of packet (starting from the tcp/udp header).
5821 * Note that the directly accessible bytes (data_end - data)
5822 * could be less than this "len". Those bytes could be
5823 * indirectly read by a helper "bpf_skb_load_bytes()".
5827 * Eth protocol in the mac header (network byte order). e.g.
5828 * ETH_P_IP(0x0800) and ETH_P_IPV6(0x86DD)
5831 __u32 ip_protocol; /* IP protocol. e.g. IPPROTO_TCP, IPPROTO_UDP */
5832 __u32 bind_inany; /* Is sock bound to an INANY address? */
5833 __u32 hash; /* A hash of the packet 4 tuples */
5834 /* When reuse->migrating_sk is NULL, it is selecting a sk for the
5835 * new incoming connection request (e.g. selecting a listen sk for
5836 * the received SYN in the TCP case). reuse->sk is one of the sk
5837 * in the reuseport group. The bpf prog can use reuse->sk to learn
5838 * the local listening ip/port without looking into the skb.
5840 * When reuse->migrating_sk is not NULL, reuse->sk is closed and
5841 * reuse->migrating_sk is the socket that needs to be migrated
5842 * to another listening socket. migrating_sk could be a fullsock
5843 * sk that is fully established or a reqsk that is in-the-middle
5844 * of 3-way handshake.
5846 __bpf_md_ptr(struct bpf_sock *, sk);
5847 __bpf_md_ptr(struct bpf_sock *, migrating_sk);
5850 #define BPF_TAG_SIZE 8
5852 struct bpf_prog_info {
5855 __u8 tag[BPF_TAG_SIZE];
5856 __u32 jited_prog_len;
5857 __u32 xlated_prog_len;
5858 __aligned_u64 jited_prog_insns;
5859 __aligned_u64 xlated_prog_insns;
5860 __u64 load_time; /* ns since boottime */
5861 __u32 created_by_uid;
5863 __aligned_u64 map_ids;
5864 char name[BPF_OBJ_NAME_LEN];
5866 __u32 gpl_compatible:1;
5867 __u32 :31; /* alignment pad */
5870 __u32 nr_jited_ksyms;
5871 __u32 nr_jited_func_lens;
5872 __aligned_u64 jited_ksyms;
5873 __aligned_u64 jited_func_lens;
5875 __u32 func_info_rec_size;
5876 __aligned_u64 func_info;
5879 __aligned_u64 line_info;
5880 __aligned_u64 jited_line_info;
5881 __u32 nr_jited_line_info;
5882 __u32 line_info_rec_size;
5883 __u32 jited_line_info_rec_size;
5885 __aligned_u64 prog_tags;
5888 __u64 recursion_misses;
5889 __u32 verified_insns;
5890 } __attribute__((aligned(8)));
5892 struct bpf_map_info {
5899 char name[BPF_OBJ_NAME_LEN];
5901 __u32 btf_vmlinux_value_type_id;
5905 __u32 btf_key_type_id;
5906 __u32 btf_value_type_id;
5907 __u32 :32; /* alignment pad */
5909 } __attribute__((aligned(8)));
5911 struct bpf_btf_info {
5918 } __attribute__((aligned(8)));
5920 struct bpf_link_info {
5926 __aligned_u64 tp_name; /* in/out: tp_name buffer ptr */
5927 __u32 tp_name_len; /* in/out: tp_name buffer len */
5931 __u32 target_obj_id; /* prog_id for PROG_EXT, otherwise btf object id */
5932 __u32 target_btf_id; /* BTF type id inside the object */
5939 __aligned_u64 target_name; /* in/out: target_name buffer ptr */
5940 __u32 target_name_len; /* in/out: target_name buffer len */
5955 } __attribute__((aligned(8)));
5957 /* User bpf_sock_addr struct to access socket fields and sockaddr struct passed
5958 * by user and intended to be used by socket (e.g. to bind to, depends on
5961 struct bpf_sock_addr {
5962 __u32 user_family; /* Allows 4-byte read, but no write. */
5963 __u32 user_ip4; /* Allows 1,2,4-byte read and 4-byte write.
5964 * Stored in network byte order.
5966 __u32 user_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write.
5967 * Stored in network byte order.
5969 __u32 user_port; /* Allows 1,2,4-byte read and 4-byte write.
5970 * Stored in network byte order
5972 __u32 family; /* Allows 4-byte read, but no write */
5973 __u32 type; /* Allows 4-byte read, but no write */
5974 __u32 protocol; /* Allows 4-byte read, but no write */
5975 __u32 msg_src_ip4; /* Allows 1,2,4-byte read and 4-byte write.
5976 * Stored in network byte order.
5978 __u32 msg_src_ip6[4]; /* Allows 1,2,4,8-byte read and 4,8-byte write.
5979 * Stored in network byte order.
5981 __bpf_md_ptr(struct bpf_sock *, sk);
5984 /* User bpf_sock_ops struct to access socket values and specify request ops
5985 * and their replies.
5986 * Some of this fields are in network (bigendian) byte order and may need
5987 * to be converted before use (bpf_ntohl() defined in samples/bpf/bpf_endian.h).
5988 * New fields can only be added at the end of this structure
5990 struct bpf_sock_ops {
5993 __u32 args[4]; /* Optionally passed to bpf program */
5994 __u32 reply; /* Returned by bpf program */
5995 __u32 replylong[4]; /* Optionally returned by bpf prog */
5998 __u32 remote_ip4; /* Stored in network byte order */
5999 __u32 local_ip4; /* Stored in network byte order */
6000 __u32 remote_ip6[4]; /* Stored in network byte order */
6001 __u32 local_ip6[4]; /* Stored in network byte order */
6002 __u32 remote_port; /* Stored in network byte order */
6003 __u32 local_port; /* stored in host byte order */
6004 __u32 is_fullsock; /* Some TCP fields are only valid if
6005 * there is a full socket. If not, the
6006 * fields read as zero.
6009 __u32 srtt_us; /* Averaged RTT << 3 in usecs */
6010 __u32 bpf_sock_ops_cb_flags; /* flags defined in uapi/linux/tcp.h */
6019 __u32 rate_delivered;
6020 __u32 rate_interval_us;
6023 __u32 total_retrans;
6027 __u32 data_segs_out;
6031 __u64 bytes_received;
6033 __bpf_md_ptr(struct bpf_sock *, sk);
6034 /* [skb_data, skb_data_end) covers the whole TCP header.
6036 * BPF_SOCK_OPS_PARSE_HDR_OPT_CB: The packet received
6037 * BPF_SOCK_OPS_HDR_OPT_LEN_CB: Not useful because the
6038 * header has not been written.
6039 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB: The header and options have
6040 * been written so far.
6041 * BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB: The SYNACK that concludes
6043 * BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB: The ACK that concludes
6046 * bpf_load_hdr_opt() can also be used to read a particular option.
6048 __bpf_md_ptr(void *, skb_data);
6049 __bpf_md_ptr(void *, skb_data_end);
6050 __u32 skb_len; /* The total length of a packet.
6051 * It includes the header, options,
6054 __u32 skb_tcp_flags; /* tcp_flags of the header. It provides
6055 * an easy way to check for tcp_flags
6056 * without parsing skb_data.
6058 * In particular, the skb_tcp_flags
6059 * will still be available in
6060 * BPF_SOCK_OPS_HDR_OPT_LEN even though
6061 * the outgoing header has not
6066 /* Definitions for bpf_sock_ops_cb_flags */
6068 BPF_SOCK_OPS_RTO_CB_FLAG = (1<<0),
6069 BPF_SOCK_OPS_RETRANS_CB_FLAG = (1<<1),
6070 BPF_SOCK_OPS_STATE_CB_FLAG = (1<<2),
6071 BPF_SOCK_OPS_RTT_CB_FLAG = (1<<3),
6072 /* Call bpf for all received TCP headers. The bpf prog will be
6073 * called under sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB
6075 * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB
6076 * for the header option related helpers that will be useful
6077 * to the bpf programs.
6079 * It could be used at the client/active side (i.e. connect() side)
6080 * when the server told it that the server was in syncookie
6081 * mode and required the active side to resend the bpf-written
6082 * options. The active side can keep writing the bpf-options until
6083 * it received a valid packet from the server side to confirm
6084 * the earlier packet (and options) has been received. The later
6085 * example patch is using it like this at the active side when the
6086 * server is in syncookie mode.
6088 * The bpf prog will usually turn this off in the common cases.
6090 BPF_SOCK_OPS_PARSE_ALL_HDR_OPT_CB_FLAG = (1<<4),
6091 /* Call bpf when kernel has received a header option that
6092 * the kernel cannot handle. The bpf prog will be called under
6093 * sock_ops->op == BPF_SOCK_OPS_PARSE_HDR_OPT_CB.
6095 * Please refer to the comment in BPF_SOCK_OPS_PARSE_HDR_OPT_CB
6096 * for the header option related helpers that will be useful
6097 * to the bpf programs.
6099 BPF_SOCK_OPS_PARSE_UNKNOWN_HDR_OPT_CB_FLAG = (1<<5),
6100 /* Call bpf when the kernel is writing header options for the
6101 * outgoing packet. The bpf prog will first be called
6102 * to reserve space in a skb under
6103 * sock_ops->op == BPF_SOCK_OPS_HDR_OPT_LEN_CB. Then
6104 * the bpf prog will be called to write the header option(s)
6105 * under sock_ops->op == BPF_SOCK_OPS_WRITE_HDR_OPT_CB.
6107 * Please refer to the comment in BPF_SOCK_OPS_HDR_OPT_LEN_CB
6108 * and BPF_SOCK_OPS_WRITE_HDR_OPT_CB for the header option
6109 * related helpers that will be useful to the bpf programs.
6111 * The kernel gets its chance to reserve space and write
6112 * options first before the BPF program does.
6114 BPF_SOCK_OPS_WRITE_HDR_OPT_CB_FLAG = (1<<6),
6115 /* Mask of all currently supported cb flags */
6116 BPF_SOCK_OPS_ALL_CB_FLAGS = 0x7F,
6119 /* List of known BPF sock_ops operators.
6120 * New entries can only be added at the end
6124 BPF_SOCK_OPS_TIMEOUT_INIT, /* Should return SYN-RTO value to use or
6125 * -1 if default value should be used
6127 BPF_SOCK_OPS_RWND_INIT, /* Should return initial advertized
6128 * window (in packets) or -1 if default
6129 * value should be used
6131 BPF_SOCK_OPS_TCP_CONNECT_CB, /* Calls BPF program right before an
6132 * active connection is initialized
6134 BPF_SOCK_OPS_ACTIVE_ESTABLISHED_CB, /* Calls BPF program when an
6135 * active connection is
6138 BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB, /* Calls BPF program when a
6139 * passive connection is
6142 BPF_SOCK_OPS_NEEDS_ECN, /* If connection's congestion control
6145 BPF_SOCK_OPS_BASE_RTT, /* Get base RTT. The correct value is
6146 * based on the path and may be
6147 * dependent on the congestion control
6148 * algorithm. In general it indicates
6149 * a congestion threshold. RTTs above
6150 * this indicate congestion
6152 BPF_SOCK_OPS_RTO_CB, /* Called when an RTO has triggered.
6153 * Arg1: value of icsk_retransmits
6154 * Arg2: value of icsk_rto
6155 * Arg3: whether RTO has expired
6157 BPF_SOCK_OPS_RETRANS_CB, /* Called when skb is retransmitted.
6158 * Arg1: sequence number of 1st byte
6160 * Arg3: return value of
6161 * tcp_transmit_skb (0 => success)
6163 BPF_SOCK_OPS_STATE_CB, /* Called when TCP changes state.
6167 BPF_SOCK_OPS_TCP_LISTEN_CB, /* Called on listen(2), right after
6168 * socket transition to LISTEN state.
6170 BPF_SOCK_OPS_RTT_CB, /* Called on every RTT.
6172 BPF_SOCK_OPS_PARSE_HDR_OPT_CB, /* Parse the header option.
6173 * It will be called to handle
6174 * the packets received at
6175 * an already established
6178 * sock_ops->skb_data:
6179 * Referring to the received skb.
6180 * It covers the TCP header only.
6182 * bpf_load_hdr_opt() can also
6183 * be used to search for a
6184 * particular option.
6186 BPF_SOCK_OPS_HDR_OPT_LEN_CB, /* Reserve space for writing the
6187 * header option later in
6188 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB.
6189 * Arg1: bool want_cookie. (in
6190 * writing SYNACK only)
6192 * sock_ops->skb_data:
6193 * Not available because no header has
6196 * sock_ops->skb_tcp_flags:
6197 * The tcp_flags of the
6198 * outgoing skb. (e.g. SYN, ACK, FIN).
6200 * bpf_reserve_hdr_opt() should
6201 * be used to reserve space.
6203 BPF_SOCK_OPS_WRITE_HDR_OPT_CB, /* Write the header options
6204 * Arg1: bool want_cookie. (in
6205 * writing SYNACK only)
6207 * sock_ops->skb_data:
6208 * Referring to the outgoing skb.
6209 * It covers the TCP header
6210 * that has already been written
6211 * by the kernel and the
6212 * earlier bpf-progs.
6214 * sock_ops->skb_tcp_flags:
6215 * The tcp_flags of the outgoing
6216 * skb. (e.g. SYN, ACK, FIN).
6218 * bpf_store_hdr_opt() should
6219 * be used to write the
6222 * bpf_load_hdr_opt() can also
6223 * be used to search for a
6224 * particular option that
6225 * has already been written
6226 * by the kernel or the
6227 * earlier bpf-progs.
6231 /* List of TCP states. There is a build check in net/ipv4/tcp.c to detect
6232 * changes between the TCP and BPF versions. Ideally this should never happen.
6233 * If it does, we need to add code to convert them before calling
6234 * the BPF sock_ops function.
6237 BPF_TCP_ESTABLISHED = 1,
6247 BPF_TCP_CLOSING, /* Now a valid state */
6248 BPF_TCP_NEW_SYN_RECV,
6250 BPF_TCP_MAX_STATES /* Leave at the end! */
6254 TCP_BPF_IW = 1001, /* Set TCP initial congestion window */
6255 TCP_BPF_SNDCWND_CLAMP = 1002, /* Set sndcwnd_clamp */
6256 TCP_BPF_DELACK_MAX = 1003, /* Max delay ack in usecs */
6257 TCP_BPF_RTO_MIN = 1004, /* Min delay ack in usecs */
6258 /* Copy the SYN pkt to optval
6260 * BPF_PROG_TYPE_SOCK_OPS only. It is similar to the
6261 * bpf_getsockopt(TCP_SAVED_SYN) but it does not limit
6262 * to only getting from the saved_syn. It can either get the
6265 * 1. the just-received SYN packet (only available when writing the
6266 * SYNACK). It will be useful when it is not necessary to
6267 * save the SYN packet for latter use. It is also the only way
6268 * to get the SYN during syncookie mode because the syn
6269 * packet cannot be saved during syncookie.
6273 * 2. the earlier saved syn which was done by
6274 * bpf_setsockopt(TCP_SAVE_SYN).
6276 * The bpf_getsockopt(TCP_BPF_SYN*) option will hide where the
6277 * SYN packet is obtained.
6279 * If the bpf-prog does not need the IP[46] header, the
6280 * bpf-prog can avoid parsing the IP header by using
6281 * TCP_BPF_SYN. Otherwise, the bpf-prog can get both
6282 * IP[46] and TCP header by using TCP_BPF_SYN_IP.
6284 * >0: Total number of bytes copied
6285 * -ENOSPC: Not enough space in optval. Only optlen number of
6287 * -ENOENT: The SYN skb is not available now and the earlier SYN pkt
6288 * is not saved by setsockopt(TCP_SAVE_SYN).
6290 TCP_BPF_SYN = 1005, /* Copy the TCP header */
6291 TCP_BPF_SYN_IP = 1006, /* Copy the IP[46] and TCP header */
6292 TCP_BPF_SYN_MAC = 1007, /* Copy the MAC, IP[46], and TCP header */
6296 BPF_LOAD_HDR_OPT_TCP_SYN = (1ULL << 0),
6299 /* args[0] value during BPF_SOCK_OPS_HDR_OPT_LEN_CB and
6300 * BPF_SOCK_OPS_WRITE_HDR_OPT_CB.
6303 BPF_WRITE_HDR_TCP_CURRENT_MSS = 1, /* Kernel is finding the
6304 * total option spaces
6305 * required for an established
6306 * sk in order to calculate the
6307 * MSS. No skb is actually
6310 BPF_WRITE_HDR_TCP_SYNACK_COOKIE = 2, /* Kernel is in syncookie mode
6311 * when sending a SYN.
6315 struct bpf_perf_event_value {
6322 BPF_DEVCG_ACC_MKNOD = (1ULL << 0),
6323 BPF_DEVCG_ACC_READ = (1ULL << 1),
6324 BPF_DEVCG_ACC_WRITE = (1ULL << 2),
6328 BPF_DEVCG_DEV_BLOCK = (1ULL << 0),
6329 BPF_DEVCG_DEV_CHAR = (1ULL << 1),
6332 struct bpf_cgroup_dev_ctx {
6333 /* access_type encoded as (BPF_DEVCG_ACC_* << 16) | BPF_DEVCG_DEV_* */
6339 struct bpf_raw_tracepoint_args {
6343 /* DIRECT: Skip the FIB rules and go to FIB table associated with device
6344 * OUTPUT: Do lookup from egress perspective; default is ingress
6347 BPF_FIB_LOOKUP_DIRECT = (1U << 0),
6348 BPF_FIB_LOOKUP_OUTPUT = (1U << 1),
6352 BPF_FIB_LKUP_RET_SUCCESS, /* lookup successful */
6353 BPF_FIB_LKUP_RET_BLACKHOLE, /* dest is blackholed; can be dropped */
6354 BPF_FIB_LKUP_RET_UNREACHABLE, /* dest is unreachable; can be dropped */
6355 BPF_FIB_LKUP_RET_PROHIBIT, /* dest not allowed; can be dropped */
6356 BPF_FIB_LKUP_RET_NOT_FWDED, /* packet is not forwarded */
6357 BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */
6358 BPF_FIB_LKUP_RET_UNSUPP_LWT, /* fwd requires encapsulation */
6359 BPF_FIB_LKUP_RET_NO_NEIGH, /* no neighbor entry for nh */
6360 BPF_FIB_LKUP_RET_FRAG_NEEDED, /* fragmentation required to fwd */
6363 struct bpf_fib_lookup {
6364 /* input: network family for lookup (AF_INET, AF_INET6)
6365 * output: network family of egress nexthop
6369 /* set if lookup is to consider L4 data - e.g., FIB rules */
6374 union { /* used for MTU check */
6375 /* input to lookup */
6376 __u16 tot_len; /* L3 length from network hdr (iph->tot_len) */
6378 /* output: MTU value */
6381 /* input: L3 device index for lookup
6382 * output: device index from FIB lookup
6387 /* inputs to lookup */
6388 __u8 tos; /* AF_INET */
6389 __be32 flowinfo; /* AF_INET6, flow_label + priority */
6391 /* output: metric of fib result (IPv4/IPv6 only) */
6397 __u32 ipv6_src[4]; /* in6_addr; network order */
6400 /* input to bpf_fib_lookup, ipv{4,6}_dst is destination address in
6401 * network header. output: bpf_fib_lookup sets to gateway address
6402 * if FIB lookup returns gateway route
6406 __u32 ipv6_dst[4]; /* in6_addr; network order */
6410 __be16 h_vlan_proto;
6412 __u8 smac[6]; /* ETH_ALEN */
6413 __u8 dmac[6]; /* ETH_ALEN */
6416 struct bpf_redir_neigh {
6417 /* network family for lookup (AF_INET, AF_INET6) */
6419 /* network address of nexthop; skips fib lookup to find gateway */
6422 __u32 ipv6_nh[4]; /* in6_addr; network order */
6426 /* bpf_check_mtu flags*/
6427 enum bpf_check_mtu_flags {
6428 BPF_MTU_CHK_SEGS = (1U << 0),
6431 enum bpf_check_mtu_ret {
6432 BPF_MTU_CHK_RET_SUCCESS, /* check and lookup successful */
6433 BPF_MTU_CHK_RET_FRAG_NEEDED, /* fragmentation required to fwd */
6434 BPF_MTU_CHK_RET_SEGS_TOOBIG, /* GSO re-segmentation needed to fwd */
6437 enum bpf_task_fd_type {
6438 BPF_FD_TYPE_RAW_TRACEPOINT, /* tp name */
6439 BPF_FD_TYPE_TRACEPOINT, /* tp name */
6440 BPF_FD_TYPE_KPROBE, /* (symbol + offset) or addr */
6441 BPF_FD_TYPE_KRETPROBE, /* (symbol + offset) or addr */
6442 BPF_FD_TYPE_UPROBE, /* filename + offset */
6443 BPF_FD_TYPE_URETPROBE, /* filename + offset */
6447 BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG = (1U << 0),
6448 BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL = (1U << 1),
6449 BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP = (1U << 2),
6452 struct bpf_flow_keys {
6455 __u16 addr_proto; /* ETH_P_* of valid addrs */
6469 __u32 ipv6_src[4]; /* in6_addr; network order */
6470 __u32 ipv6_dst[4]; /* in6_addr; network order */
6477 struct bpf_func_info {
6482 #define BPF_LINE_INFO_LINE_NUM(line_col) ((line_col) >> 10)
6483 #define BPF_LINE_INFO_LINE_COL(line_col) ((line_col) & 0x3ff)
6485 struct bpf_line_info {
6487 __u32 file_name_off;
6492 struct bpf_spin_lock {
6499 } __attribute__((aligned(8)));
6502 __u32 write; /* Sysctl is being read (= 0) or written (= 1).
6503 * Allows 1,2,4-byte read, but no write.
6505 __u32 file_pos; /* Sysctl file position to read from, write to.
6506 * Allows 1,2,4-byte read an 4-byte write.
6510 struct bpf_sockopt {
6511 __bpf_md_ptr(struct bpf_sock *, sk);
6512 __bpf_md_ptr(void *, optval);
6513 __bpf_md_ptr(void *, optval_end);
6521 struct bpf_pidns_info {
6526 /* User accessible data for SK_LOOKUP programs. Add new fields at the end. */
6527 struct bpf_sk_lookup {
6529 __bpf_md_ptr(struct bpf_sock *, sk); /* Selected socket */
6530 __u64 cookie; /* Non-zero if socket was selected in PROG_TEST_RUN */
6533 __u32 family; /* Protocol family (AF_INET, AF_INET6) */
6534 __u32 protocol; /* IP protocol (IPPROTO_TCP, IPPROTO_UDP) */
6535 __u32 remote_ip4; /* Network byte order */
6536 __u32 remote_ip6[4]; /* Network byte order */
6537 __be16 remote_port; /* Network byte order */
6538 __u16 :16; /* Zero padding */
6539 __u32 local_ip4; /* Network byte order */
6540 __u32 local_ip6[4]; /* Network byte order */
6541 __u32 local_port; /* Host byte order */
6542 __u32 ingress_ifindex; /* The arriving interface. Determined by inet_iif. */
6546 * struct btf_ptr is used for typed pointer representation; the
6547 * type id is used to render the pointer data as the appropriate type
6548 * via the bpf_snprintf_btf() helper described above. A flags field -
6549 * potentially to specify additional details about the BTF pointer
6550 * (rather than its mode of display) - is included for future use.
6551 * Display flags - BTF_F_* - are passed to bpf_snprintf_btf separately.
6556 __u32 flags; /* BTF ptr flags; unused at present. */
6560 * Flags to control bpf_snprintf_btf() behaviour.
6561 * - BTF_F_COMPACT: no formatting around type information
6562 * - BTF_F_NONAME: no struct/union member names/types
6563 * - BTF_F_PTR_RAW: show raw (unobfuscated) pointer values;
6564 * equivalent to %px.
6565 * - BTF_F_ZERO: show zero-valued struct/union members; they
6566 * are not displayed by default
6569 BTF_F_COMPACT = (1ULL << 0),
6570 BTF_F_NONAME = (1ULL << 1),
6571 BTF_F_PTR_RAW = (1ULL << 2),
6572 BTF_F_ZERO = (1ULL << 3),
6575 /* bpf_core_relo_kind encodes which aspect of captured field/type/enum value
6576 * has to be adjusted by relocations. It is emitted by llvm and passed to
6577 * libbpf and later to the kernel.
6579 enum bpf_core_relo_kind {
6580 BPF_CORE_FIELD_BYTE_OFFSET = 0, /* field byte offset */
6581 BPF_CORE_FIELD_BYTE_SIZE = 1, /* field size in bytes */
6582 BPF_CORE_FIELD_EXISTS = 2, /* field existence in target kernel */
6583 BPF_CORE_FIELD_SIGNED = 3, /* field signedness (0 - unsigned, 1 - signed) */
6584 BPF_CORE_FIELD_LSHIFT_U64 = 4, /* bitfield-specific left bitshift */
6585 BPF_CORE_FIELD_RSHIFT_U64 = 5, /* bitfield-specific right bitshift */
6586 BPF_CORE_TYPE_ID_LOCAL = 6, /* type ID in local BPF object */
6587 BPF_CORE_TYPE_ID_TARGET = 7, /* type ID in target kernel */
6588 BPF_CORE_TYPE_EXISTS = 8, /* type existence in target kernel */
6589 BPF_CORE_TYPE_SIZE = 9, /* type size in bytes */
6590 BPF_CORE_ENUMVAL_EXISTS = 10, /* enum value existence in target kernel */
6591 BPF_CORE_ENUMVAL_VALUE = 11, /* enum value integer value */
6595 * "struct bpf_core_relo" is used to pass relocation data form LLVM to libbpf
6596 * and from libbpf to the kernel.
6598 * CO-RE relocation captures the following data:
6599 * - insn_off - instruction offset (in bytes) within a BPF program that needs
6600 * its insn->imm field to be relocated with actual field info;
6601 * - type_id - BTF type ID of the "root" (containing) entity of a relocatable
6603 * - access_str_off - offset into corresponding .BTF string section. String
6604 * interpretation depends on specific relocation kind:
6605 * - for field-based relocations, string encodes an accessed field using
6606 * a sequence of field and array indices, separated by colon (:). It's
6607 * conceptually very close to LLVM's getelementptr ([0]) instruction's
6608 * arguments for identifying offset to a field.
6609 * - for type-based relocations, strings is expected to be just "0";
6610 * - for enum value-based relocations, string contains an index of enum
6611 * value within its enum type;
6612 * - kind - one of enum bpf_core_relo_kind;
6622 * struct sample *s = ...;
6623 * int *x = &s->a; // encoded as "0:0" (a is field #0)
6624 * int *y = &s->b[5]; // encoded as "0:1:0:5" (anon struct is field #1,
6625 * // b is field #0 inside anon struct, accessing elem #5)
6626 * int *z = &s[10]->b; // encoded as "10:1" (ptr is used as an array)
6628 * type_id for all relocs in this example will capture BTF type id of
6631 * Such relocation is emitted when using __builtin_preserve_access_index()
6632 * Clang built-in, passing expression that captures field address, e.g.:
6634 * bpf_probe_read(&dst, sizeof(dst),
6635 * __builtin_preserve_access_index(&src->a.b.c));
6637 * In this case Clang will emit field relocation recording necessary data to
6638 * be able to find offset of embedded `a.b.c` field within `src` struct.
6640 * [0] https://llvm.org/docs/LangRef.html#getelementptr-instruction
6642 struct bpf_core_relo {
6645 __u32 access_str_off;
6646 enum bpf_core_relo_kind kind;
6649 #endif /* _UAPI__LINUX_BPF_H__ */
projects / linux-block.git / blob