| 1 |
|
| 2 |
|
| 3 | |
| 4 | * Common eBPF ELF object loading operations.
|
| 5 | *
|
| 6 | * Copyright (C) 2013-2015 Alexei Starovoitov <[email protected]>
|
| 7 | * Copyright (C) 2015 Wang Nan <[email protected]>
|
| 8 | * Copyright (C) 2015 Huawei Inc.
|
| 9 |
|
| 10 | #ifndef __LIBBPF_LIBBPF_H
|
| 11 | #define __LIBBPF_LIBBPF_H
|
| 12 |
|
| 13 | #include <stdarg.h>
|
| 14 | #include <stdio.h>
|
| 15 | #include <stdint.h>
|
| 16 | #include <stdbool.h>
|
| 17 | #include <sys/types.h>
|
| 18 | #include <linux/bpf.h>
|
| 19 |
|
| 20 | #include "libbpf_common.h"
|
| 21 | #include "libbpf_legacy.h"
|
| 22 |
|
| 23 | #ifdef __cplusplus
|
| 24 | extern "C" {
|
| 25 | #endif
|
| 26 |
|
| 27 | |
| 28 | * @brief **libbpf_major_version()** provides the major version of libbpf.
|
| 29 | * @return An integer, the major version number
|
| 30 |
|
| 31 | LIBBPF_API __u32 libbpf_major_version(void);
|
| 32 |
|
| 33 | |
| 34 | * @brief **libbpf_minor_version()** provides the minor version of libbpf.
|
| 35 | * @return An integer, the minor version number
|
| 36 |
|
| 37 | LIBBPF_API __u32 libbpf_minor_version(void);
|
| 38 |
|
| 39 | |
| 40 | * @brief **libbpf_version_string()** provides the version of libbpf in a
|
| 41 | * human-readable form, e.g., "v1.7".
|
| 42 | * @return Pointer to a static string containing the version
|
| 43 | *
|
| 44 | * The format is *not* a part of a stable API and may change in the future.
|
| 45 |
|
| 46 | LIBBPF_API const char *libbpf_version_string(void);
|
| 47 |
|
| 48 | enum libbpf_errno {
|
| 49 | __LIBBPF_ERRNO__START = 4000,
|
| 50 |
|
| 51 |
|
| 52 | LIBBPF_ERRNO__LIBELF = __LIBBPF_ERRNO__START,
|
| 53 | LIBBPF_ERRNO__FORMAT,
|
| 54 | LIBBPF_ERRNO__KVERSION,
|
| 55 | LIBBPF_ERRNO__ENDIAN,
|
| 56 | LIBBPF_ERRNO__INTERNAL,
|
| 57 | LIBBPF_ERRNO__RELOC,
|
| 58 | LIBBPF_ERRNO__LOAD,
|
| 59 | LIBBPF_ERRNO__VERIFY,
|
| 60 | LIBBPF_ERRNO__PROG2BIG,
|
| 61 | LIBBPF_ERRNO__KVER,
|
| 62 | LIBBPF_ERRNO__PROGTYPE,
|
| 63 | LIBBPF_ERRNO__WRNGPID,
|
| 64 | LIBBPF_ERRNO__INVSEQ,
|
| 65 | LIBBPF_ERRNO__NLPARSE,
|
| 66 | __LIBBPF_ERRNO__END,
|
| 67 | };
|
| 68 |
|
| 69 | |
| 70 | * @brief **libbpf_strerror()** converts the provided error code into a
|
| 71 | * human-readable string.
|
| 72 | * @param err The error code to convert
|
| 73 | * @param buf Pointer to a buffer where the error message will be stored
|
| 74 | * @param size The number of bytes in the buffer
|
| 75 | * @return 0, on success; negative error code, otherwise
|
| 76 |
|
| 77 | LIBBPF_API int libbpf_strerror(int err, char *buf, size_t size);
|
| 78 |
|
| 79 | |
| 80 | * @brief **libbpf_bpf_attach_type_str()** converts the provided attach type
|
| 81 | * value into a textual representation.
|
| 82 | * @param t The attach type.
|
| 83 | * @return Pointer to a static string identifying the attach type. NULL is
|
| 84 | * returned for unknown **bpf_attach_type** values.
|
| 85 |
|
| 86 | LIBBPF_API const char *libbpf_bpf_attach_type_str(enum bpf_attach_type t);
|
| 87 |
|
| 88 | |
| 89 | * @brief **libbpf_bpf_link_type_str()** converts the provided link type value
|
| 90 | * into a textual representation.
|
| 91 | * @param t The link type.
|
| 92 | * @return Pointer to a static string identifying the link type. NULL is
|
| 93 | * returned for unknown **bpf_link_type** values.
|
| 94 |
|
| 95 | LIBBPF_API const char *libbpf_bpf_link_type_str(enum bpf_link_type t);
|
| 96 |
|
| 97 | |
| 98 | * @brief **libbpf_bpf_map_type_str()** converts the provided map type value
|
| 99 | * into a textual representation.
|
| 100 | * @param t The map type.
|
| 101 | * @return Pointer to a static string identifying the map type. NULL is
|
| 102 | * returned for unknown **bpf_map_type** values.
|
| 103 |
|
| 104 | LIBBPF_API const char *libbpf_bpf_map_type_str(enum bpf_map_type t);
|
| 105 |
|
| 106 | |
| 107 | * @brief **libbpf_bpf_prog_type_str()** converts the provided program type
|
| 108 | * value into a textual representation.
|
| 109 | * @param t The program type.
|
| 110 | * @return Pointer to a static string identifying the program type. NULL is
|
| 111 | * returned for unknown **bpf_prog_type** values.
|
| 112 |
|
| 113 | LIBBPF_API const char *libbpf_bpf_prog_type_str(enum bpf_prog_type t);
|
| 114 |
|
| 115 | enum libbpf_print_level {
|
| 116 | LIBBPF_WARN,
|
| 117 | LIBBPF_INFO,
|
| 118 | LIBBPF_DEBUG,
|
| 119 | };
|
| 120 |
|
| 121 | typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,
|
| 122 | const char *, va_list ap);
|
| 123 |
|
| 124 | |
| 125 | * @brief **libbpf_set_print()** sets user-provided log callback function to
|
| 126 | * be used for libbpf warnings and informational messages. If the user callback
|
| 127 | * is not set, messages are logged to stderr by default. The verbosity of these
|
| 128 | * messages can be controlled by setting the environment variable
|
| 129 | * LIBBPF_LOG_LEVEL to either warn, info, or debug.
|
| 130 | * @param fn The log print function. If NULL, libbpf won't print anything.
|
| 131 | * @return Pointer to old print function.
|
| 132 | *
|
| 133 | * This function is thread-safe.
|
| 134 |
|
| 135 | LIBBPF_API libbpf_print_fn_t libbpf_set_print(libbpf_print_fn_t fn);
|
| 136 |
|
| 137 |
|
| 138 | struct bpf_object;
|
| 139 |
|
| 140 | struct bpf_object_open_opts {
|
| 141 |
|
| 142 | size_t sz;
|
| 143 | |
| 144 | * - for object open from file, this will override setting object
|
| 145 | * name from file path's base name;
|
| 146 | * - for object open from memory buffer, this will specify an object
|
| 147 | * name and will override default "<addr>-<buf-size>" name;
|
| 148 |
|
| 149 | const char *object_name;
|
| 150 |
|
| 151 | bool relaxed_maps;
|
| 152 | |
| 153 | * their pin_path attribute set to a file in this directory, and be
|
| 154 | * auto-pinned to that path on load; defaults to "/sys/fs/bpf".
|
| 155 |
|
| 156 | const char *pin_root_path;
|
| 157 |
|
| 158 | __u32 :32;
|
| 159 |
|
| 160 | |
| 161 | * system Kconfig for CONFIG_xxx externs.
|
| 162 |
|
| 163 | const char *kconfig;
|
| 164 | |
| 165 | * This custom BTF completely replaces the use of vmlinux BTF
|
| 166 | * for the purpose of CO-RE relocations.
|
| 167 | * NOTE: any other BPF feature (e.g., fentry/fexit programs,
|
| 168 | * struct_ops, etc) will need actual kernel BTF at /sys/kernel/btf/vmlinux.
|
| 169 |
|
| 170 | const char *btf_custom_path;
|
| 171 | |
| 172 | * commands. Valid kernel_log_size has to be specified as well and are
|
| 173 | * passed-through to bpf() syscall. Keep in mind that kernel might
|
| 174 | * fail operation with -ENOSPC error if provided buffer is too small
|
| 175 | * to contain entire log output.
|
| 176 | * See the comment below for kernel_log_level for interaction between
|
| 177 | * log_buf and log_level settings.
|
| 178 | *
|
| 179 | * If specified, this log buffer will be passed for:
|
| 180 | * - each BPF progral load (BPF_PROG_LOAD) attempt, unless overridden
|
| 181 | * with bpf_program__set_log() on per-program level, to get
|
| 182 | * BPF verifier log output.
|
| 183 | * - during BPF object's BTF load into kernel (BPF_BTF_LOAD) to get
|
| 184 | * BTF sanity checking log.
|
| 185 | *
|
| 186 | * Each BPF command (BPF_BTF_LOAD or BPF_PROG_LOAD) will overwrite
|
| 187 | * previous contents, so if you need more fine-grained control, set
|
| 188 | * per-program buffer with bpf_program__set_log_buf() to preserve each
|
| 189 | * individual program's verification log. Keep using kernel_log_buf
|
| 190 | * for BTF verification log, if necessary.
|
| 191 |
|
| 192 | char *kernel_log_buf;
|
| 193 | size_t kernel_log_size;
|
| 194 | |
| 195 | * Log level can be set independently from log buffer. Log_level=0
|
| 196 | * means that libbpf will attempt loading BTF or program without any
|
| 197 | * logging requested, but will retry with either its own or custom log
|
| 198 | * buffer, if provided, and log_level=1 on any error.
|
| 199 | * And vice versa, setting log_level>0 will request BTF or prog
|
| 200 | * loading with verbose log from the first attempt (and as such also
|
| 201 | * for successfully loaded BTF or program), and the actual log buffer
|
| 202 | * could be either libbpf's own auto-allocated log buffer, if
|
| 203 | * kernel_log_buffer is NULL, or user-provided custom kernel_log_buf.
|
| 204 | * If user didn't provide custom log buffer, libbpf will emit captured
|
| 205 | * logs through its print callback.
|
| 206 |
|
| 207 | __u32 kernel_log_level;
|
| 208 | |
| 209 | *
|
| 210 | * Created BPF token will be used for all bpf() syscall operations
|
| 211 | * that accept BPF token (e.g., map creation, BTF and program loads,
|
| 212 | * etc) automatically within instantiated BPF object.
|
| 213 | *
|
| 214 | * If bpf_token_path is not specified, libbpf will consult
|
| 215 | * LIBBPF_BPF_TOKEN_PATH environment variable. If set, it will be
|
| 216 | * taken as a value of bpf_token_path option and will force libbpf to
|
| 217 | * either create BPF token from provided custom BPF FS path, or will
|
| 218 | * disable implicit BPF token creation, if envvar value is an empty
|
| 219 | * string. bpf_token_path overrides LIBBPF_BPF_TOKEN_PATH, if both are
|
| 220 | * set at the same time.
|
| 221 | *
|
| 222 | * Setting bpf_token_path option to empty string disables libbpf's
|
| 223 | * automatic attempt to create BPF token from default BPF FS mount
|
| 224 | * point (/sys/fs/bpf), in case this default behavior is undesirable.
|
| 225 |
|
| 226 | const char *bpf_token_path;
|
| 227 |
|
| 228 | size_t :0;
|
| 229 | };
|
| 230 | #define bpf_object_open_opts__last_field bpf_token_path
|
| 231 |
|
| 232 | |
| 233 | * @brief **bpf_object__open()** creates a bpf_object by opening
|
| 234 | * the BPF ELF object file pointed to by the passed path and loading it
|
| 235 | * into memory.
|
| 236 | * @param path BPF object file path.
|
| 237 | * @return pointer to the new bpf_object; or NULL is returned on error,
|
| 238 | * error code is stored in errno
|
| 239 |
|
| 240 | LIBBPF_API struct bpf_object *bpf_object__open(const char *path);
|
| 241 |
|
| 242 | |
| 243 | * @brief **bpf_object__open_file()** creates a bpf_object by opening
|
| 244 | * the BPF ELF object file pointed to by the passed path and loading it
|
| 245 | * into memory.
|
| 246 | * @param path BPF object file path
|
| 247 | * @param opts options for how to load the bpf object, this parameter is
|
| 248 | * optional and can be set to NULL
|
| 249 | * @return pointer to the new bpf_object; or NULL is returned on error,
|
| 250 | * error code is stored in errno
|
| 251 |
|
| 252 | LIBBPF_API struct bpf_object *
|
| 253 | bpf_object__open_file(const char *path, const struct bpf_object_open_opts *opts);
|
| 254 |
|
| 255 | |
| 256 | * @brief **bpf_object__open_mem()** creates a bpf_object by reading
|
| 257 | * the BPF objects raw bytes from a memory buffer containing a valid
|
| 258 | * BPF ELF object file.
|
| 259 | * @param obj_buf pointer to the buffer containing ELF file bytes
|
| 260 | * @param obj_buf_sz number of bytes in the buffer
|
| 261 | * @param opts options for how to load the bpf object
|
| 262 | * @return pointer to the new bpf_object; or NULL is returned on error,
|
| 263 | * error code is stored in errno
|
| 264 |
|
| 265 | LIBBPF_API struct bpf_object *
|
| 266 | bpf_object__open_mem(const void *obj_buf, size_t obj_buf_sz,
|
| 267 | const struct bpf_object_open_opts *opts);
|
| 268 |
|
| 269 | |
| 270 | * @brief **bpf_object__prepare()** prepares BPF object for loading:
|
| 271 | * performs ELF processing, relocations, prepares final state of BPF program
|
| 272 | * instructions (accessible with bpf_program__insns()), creates and
|
| 273 | * (potentially) pins maps. Leaves BPF object in the state ready for program
|
| 274 | * loading.
|
| 275 | * @param obj Pointer to a valid BPF object instance returned by
|
| 276 | * **bpf_object__open*()** API
|
| 277 | * @return 0, on success; negative error code, otherwise, error code is
|
| 278 | * stored in errno
|
| 279 |
|
| 280 | LIBBPF_API int bpf_object__prepare(struct bpf_object *obj);
|
| 281 |
|
| 282 | |
| 283 | * @brief **bpf_object__load()** loads BPF object into kernel.
|
| 284 | * @param obj Pointer to a valid BPF object instance returned by
|
| 285 | * **bpf_object__open*()** APIs
|
| 286 | * @return 0, on success; negative error code, otherwise, error code is
|
| 287 | * stored in errno
|
| 288 |
|
| 289 | LIBBPF_API int bpf_object__load(struct bpf_object *obj);
|
| 290 |
|
| 291 | |
| 292 | * @brief **bpf_object__close()** closes a BPF object and releases all
|
| 293 | * resources.
|
| 294 | * @param obj Pointer to a valid BPF object
|
| 295 |
|
| 296 | LIBBPF_API void bpf_object__close(struct bpf_object *obj);
|
| 297 |
|
| 298 | |
| 299 | * @brief **bpf_object__pin_maps()** pins each map contained within
|
| 300 | * the BPF object at the passed directory.
|
| 301 | * @param obj Pointer to a valid BPF object
|
| 302 | * @param path A directory where maps should be pinned.
|
| 303 | * @return 0, on success; negative error code, otherwise
|
| 304 | *
|
| 305 | * If `path` is NULL `bpf_map__pin` (which is being used on each map)
|
| 306 | * will use the pin_path attribute of each map. In this case, maps that
|
| 307 | * don't have a pin_path set will be ignored.
|
| 308 |
|
| 309 | LIBBPF_API int bpf_object__pin_maps(struct bpf_object *obj, const char *path);
|
| 310 |
|
| 311 | |
| 312 | * @brief **bpf_object__unpin_maps()** unpins each map contained within
|
| 313 | * the BPF object found in the passed directory.
|
| 314 | * @param obj Pointer to a valid BPF object
|
| 315 | * @param path A directory where pinned maps should be searched for.
|
| 316 | * @return 0, on success; negative error code, otherwise
|
| 317 | *
|
| 318 | * If `path` is NULL `bpf_map__unpin` (which is being used on each map)
|
| 319 | * will use the pin_path attribute of each map. In this case, maps that
|
| 320 | * don't have a pin_path set will be ignored.
|
| 321 |
|
| 322 | LIBBPF_API int bpf_object__unpin_maps(struct bpf_object *obj,
|
| 323 | const char *path);
|
| 324 | LIBBPF_API int bpf_object__pin_programs(struct bpf_object *obj,
|
| 325 | const char *path);
|
| 326 | LIBBPF_API int bpf_object__unpin_programs(struct bpf_object *obj,
|
| 327 | const char *path);
|
| 328 | LIBBPF_API int bpf_object__pin(struct bpf_object *object, const char *path);
|
| 329 | LIBBPF_API int bpf_object__unpin(struct bpf_object *object, const char *path);
|
| 330 |
|
| 331 | LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj);
|
| 332 | LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj);
|
| 333 | LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);
|
| 334 |
|
| 335 | |
| 336 | * @brief **bpf_object__token_fd** is an accessor for BPF token FD associated
|
| 337 | * with BPF object.
|
| 338 | * @param obj Pointer to a valid BPF object
|
| 339 | * @return BPF token FD or -1, if it wasn't set
|
| 340 |
|
| 341 | LIBBPF_API int bpf_object__token_fd(const struct bpf_object *obj);
|
| 342 |
|
| 343 | struct btf;
|
| 344 | LIBBPF_API struct btf *bpf_object__btf(const struct bpf_object *obj);
|
| 345 | LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj);
|
| 346 |
|
| 347 | LIBBPF_API struct bpf_program *
|
| 348 | bpf_object__find_program_by_name(const struct bpf_object *obj,
|
| 349 | const char *name);
|
| 350 |
|
| 351 | LIBBPF_API int
|
| 352 | libbpf_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type,
|
| 353 | enum bpf_attach_type *expected_attach_type);
|
| 354 | LIBBPF_API int libbpf_attach_type_by_name(const char *name,
|
| 355 | enum bpf_attach_type *attach_type);
|
| 356 | LIBBPF_API int libbpf_find_vmlinux_btf_id(const char *name,
|
| 357 | enum bpf_attach_type attach_type);
|
| 358 |
|
| 359 |
|
| 360 | struct bpf_program;
|
| 361 |
|
| 362 | LIBBPF_API struct bpf_program *
|
| 363 | bpf_object__next_program(const struct bpf_object *obj, struct bpf_program *prog);
|
| 364 |
|
| 365 | #define bpf_object__for_each_program(pos, obj) \
|
| 366 | for ((pos) = bpf_object__next_program((obj), NULL); \
|
| 367 | (pos) != NULL; \
|
| 368 | (pos) = bpf_object__next_program((obj), (pos)))
|
| 369 |
|
| 370 | LIBBPF_API struct bpf_program *
|
| 371 | bpf_object__prev_program(const struct bpf_object *obj, struct bpf_program *prog);
|
| 372 |
|
| 373 | LIBBPF_API void bpf_program__set_ifindex(struct bpf_program *prog,
|
| 374 | __u32 ifindex);
|
| 375 |
|
| 376 | LIBBPF_API const char *bpf_program__name(const struct bpf_program *prog);
|
| 377 | LIBBPF_API const char *bpf_program__section_name(const struct bpf_program *prog);
|
| 378 | LIBBPF_API bool bpf_program__autoload(const struct bpf_program *prog);
|
| 379 | LIBBPF_API int bpf_program__set_autoload(struct bpf_program *prog, bool autoload);
|
| 380 | LIBBPF_API bool bpf_program__autoattach(const struct bpf_program *prog);
|
| 381 | LIBBPF_API void bpf_program__set_autoattach(struct bpf_program *prog, bool autoattach);
|
| 382 |
|
| 383 | struct bpf_insn;
|
| 384 |
|
| 385 | |
| 386 | * @brief **bpf_program__insns()** gives read-only access to BPF program's
|
| 387 | * underlying BPF instructions.
|
| 388 | * @param prog BPF program for which to return instructions
|
| 389 | * @return a pointer to an array of BPF instructions that belong to the
|
| 390 | * specified BPF program
|
| 391 | *
|
| 392 | * Returned pointer is always valid and not NULL. Number of `struct bpf_insn`
|
| 393 | * pointed to can be fetched using **bpf_program__insn_cnt()** API.
|
| 394 | *
|
| 395 | * Keep in mind, libbpf can modify and append/delete BPF program's
|
| 396 | * instructions as it processes BPF object file and prepares everything for
|
| 397 | * uploading into the kernel. So depending on the point in BPF object
|
| 398 | * lifetime, **bpf_program__insns()** can return different sets of
|
| 399 | * instructions. As an example, during BPF object load phase BPF program
|
| 400 | * instructions will be CO-RE-relocated, BPF subprograms instructions will be
|
| 401 | * appended, ldimm64 instructions will have FDs embedded, etc. So instructions
|
| 402 | * returned before **bpf_object__load()** and after it might be quite
|
| 403 | * different.
|
| 404 |
|
| 405 | LIBBPF_API const struct bpf_insn *bpf_program__insns(const struct bpf_program *prog);
|
| 406 |
|
| 407 | |
| 408 | * @brief **bpf_program__set_insns()** can set BPF program's underlying
|
| 409 | * BPF instructions.
|
| 410 | *
|
| 411 | * WARNING: This is a very advanced libbpf API and users need to know
|
| 412 | * what they are doing. This should be used from prog_prepare_load_fn
|
| 413 | * callback only.
|
| 414 | *
|
| 415 | * @param prog BPF program for which to return instructions
|
| 416 | * @param new_insns a pointer to an array of BPF instructions
|
| 417 | * @param new_insn_cnt number of `struct bpf_insn`'s that form
|
| 418 | * specified BPF program
|
| 419 | * @return 0, on success; negative error code, otherwise
|
| 420 |
|
| 421 | LIBBPF_API int bpf_program__set_insns(struct bpf_program *prog,
|
| 422 | struct bpf_insn *new_insns, size_t new_insn_cnt);
|
| 423 |
|
| 424 | |
| 425 | * @brief **bpf_program__insn_cnt()** returns number of `struct bpf_insn`'s
|
| 426 | * that form specified BPF program.
|
| 427 | * @param prog BPF program for which to return number of BPF instructions
|
| 428 | *
|
| 429 | * See **bpf_program__insns()** documentation for notes on how libbpf can
|
| 430 | * change instructions and their count during different phases of
|
| 431 | * **bpf_object** lifetime.
|
| 432 |
|
| 433 | LIBBPF_API size_t bpf_program__insn_cnt(const struct bpf_program *prog);
|
| 434 |
|
| 435 | LIBBPF_API int bpf_program__fd(const struct bpf_program *prog);
|
| 436 |
|
| 437 | |
| 438 | * @brief **bpf_program__pin()** pins the BPF program to a file
|
| 439 | * in the BPF FS specified by a path. This increments the programs
|
| 440 | * reference count, allowing it to stay loaded after the process
|
| 441 | * which loaded it has exited.
|
| 442 | *
|
| 443 | * @param prog BPF program to pin, must already be loaded
|
| 444 | * @param path file path in a BPF file system
|
| 445 | * @return 0, on success; negative error code, otherwise
|
| 446 |
|
| 447 | LIBBPF_API int bpf_program__pin(struct bpf_program *prog, const char *path);
|
| 448 |
|
| 449 | |
| 450 | * @brief **bpf_program__unpin()** unpins the BPF program from a file
|
| 451 | * in the BPFFS specified by a path. This decrements program's in-kernel
|
| 452 | * reference count.
|
| 453 | *
|
| 454 | * The file pinning the BPF program can also be unlinked by a different
|
| 455 | * process in which case this function will return an error.
|
| 456 | *
|
| 457 | * @param prog BPF program to unpin
|
| 458 | * @param path file path to the pin in a BPF file system
|
| 459 | * @return 0, on success; negative error code, otherwise
|
| 460 |
|
| 461 | LIBBPF_API int bpf_program__unpin(struct bpf_program *prog, const char *path);
|
| 462 | LIBBPF_API void bpf_program__unload(struct bpf_program *prog);
|
| 463 |
|
| 464 | struct bpf_link;
|
| 465 |
|
| 466 | LIBBPF_API struct bpf_link *bpf_link__open(const char *path);
|
| 467 | LIBBPF_API int bpf_link__fd(const struct bpf_link *link);
|
| 468 | LIBBPF_API const char *bpf_link__pin_path(const struct bpf_link *link);
|
| 469 | |
| 470 | * @brief **bpf_link__pin()** pins the BPF link to a file
|
| 471 | * in the BPF FS specified by a path. This increments the links
|
| 472 | * reference count, allowing it to stay loaded after the process
|
| 473 | * which loaded it has exited.
|
| 474 | *
|
| 475 | * @param link BPF link to pin, must already be loaded
|
| 476 | * @param path file path in a BPF file system
|
| 477 | * @return 0, on success; negative error code, otherwise
|
| 478 |
|
| 479 |
|
| 480 | LIBBPF_API int bpf_link__pin(struct bpf_link *link, const char *path);
|
| 481 |
|
| 482 | |
| 483 | * @brief **bpf_link__unpin()** unpins the BPF link from a file
|
| 484 | * in the BPFFS. This decrements link's in-kernel reference count.
|
| 485 | *
|
| 486 | * The file pinning the BPF link can also be unlinked by a different
|
| 487 | * process in which case this function will return an error.
|
| 488 | *
|
| 489 | * @param link BPF link to unpin
|
| 490 | * @return 0, on success; negative error code, otherwise
|
| 491 |
|
| 492 | LIBBPF_API int bpf_link__unpin(struct bpf_link *link);
|
| 493 | LIBBPF_API int bpf_link__update_program(struct bpf_link *link,
|
| 494 | struct bpf_program *prog);
|
| 495 | LIBBPF_API void bpf_link__disconnect(struct bpf_link *link);
|
| 496 | LIBBPF_API int bpf_link__detach(struct bpf_link *link);
|
| 497 | LIBBPF_API int bpf_link__destroy(struct bpf_link *link);
|
| 498 |
|
| 499 | |
| 500 | * @brief **bpf_program__attach()** is a generic function for attaching
|
| 501 | * a BPF program based on auto-detection of program type, attach type,
|
| 502 | * and extra parameters, where applicable.
|
| 503 | *
|
| 504 | * @param prog BPF program to attach
|
| 505 | * @return Reference to the newly created BPF link; or NULL is returned on error,
|
| 506 | * error code is stored in errno
|
| 507 | *
|
| 508 | * This is supported for:
|
| 509 | * - kprobe/kretprobe (depends on SEC() definition)
|
| 510 | * - uprobe/uretprobe (depends on SEC() definition)
|
| 511 | * - tracepoint
|
| 512 | * - raw tracepoint
|
| 513 | * - tracing programs (typed raw TP/fentry/fexit/fmod_ret)
|
| 514 |
|
| 515 | LIBBPF_API struct bpf_link *
|
| 516 | bpf_program__attach(const struct bpf_program *prog);
|
| 517 |
|
| 518 | struct bpf_perf_event_opts {
|
| 519 |
|
| 520 | size_t sz;
|
| 521 |
|
| 522 | __u64 bpf_cookie;
|
| 523 |
|
| 524 | bool force_ioctl_attach;
|
| 525 |
|
| 526 | bool dont_enable;
|
| 527 | size_t :0;
|
| 528 | };
|
| 529 | #define bpf_perf_event_opts__last_field dont_enable
|
| 530 |
|
| 531 | LIBBPF_API struct bpf_link *
|
| 532 | bpf_program__attach_perf_event(const struct bpf_program *prog, int pfd);
|
| 533 |
|
| 534 | LIBBPF_API struct bpf_link *
|
| 535 | bpf_program__attach_perf_event_opts(const struct bpf_program *prog, int pfd,
|
| 536 | const struct bpf_perf_event_opts *opts);
|
| 537 |
|
| 538 | |
| 539 | * enum probe_attach_mode - the mode to attach kprobe/uprobe
|
| 540 | *
|
| 541 | * force libbpf to attach kprobe/uprobe in specific mode, -ENOTSUP will
|
| 542 | * be returned if it is not supported by the kernel.
|
| 543 |
|
| 544 | enum probe_attach_mode {
|
| 545 |
|
| 546 | PROBE_ATTACH_MODE_DEFAULT = 0,
|
| 547 |
|
| 548 | PROBE_ATTACH_MODE_LEGACY,
|
| 549 |
|
| 550 | PROBE_ATTACH_MODE_PERF,
|
| 551 |
|
| 552 | PROBE_ATTACH_MODE_LINK,
|
| 553 | };
|
| 554 |
|
| 555 | struct bpf_kprobe_opts {
|
| 556 |
|
| 557 | size_t sz;
|
| 558 |
|
| 559 | __u64 bpf_cookie;
|
| 560 |
|
| 561 | size_t offset;
|
| 562 |
|
| 563 | bool retprobe;
|
| 564 |
|
| 565 | enum probe_attach_mode attach_mode;
|
| 566 | size_t :0;
|
| 567 | };
|
| 568 |
|
| 569 | #define bpf_kprobe_opts__last_field attach_mode
|
| 570 |
|
| 571 | |
| 572 | * @brief **bpf_program__attach_kprobe()** attaches a BPF program to a
|
| 573 | * kernel function entry or return.
|
| 574 | *
|
| 575 | * @param prog BPF program to attach
|
| 576 | * @param retprobe Attach to function return
|
| 577 | * @param func_name Name of the kernel function to attach to
|
| 578 | * @return Reference to the newly created BPF link; or NULL is returned on
|
| 579 | * error, error code is stored in errno
|
| 580 |
|
| 581 | LIBBPF_API struct bpf_link *
|
| 582 | bpf_program__attach_kprobe(const struct bpf_program *prog, bool retprobe,
|
| 583 | const char *func_name);
|
| 584 |
|
| 585 | |
| 586 | * @brief **bpf_program__attach_kprobe_opts()** is just like
|
| 587 | * bpf_program__attach_kprobe() except with an options struct
|
| 588 | * for various configurations.
|
| 589 | *
|
| 590 | * @param prog BPF program to attach
|
| 591 | * @param func_name Name of the kernel function to attach to. If NULL,
|
| 592 | * opts->offset is treated as a raw kernel address. Raw-address attach
|
| 593 | * is supported with PROBE_ATTACH_MODE_PERF and PROBE_ATTACH_MODE_LINK.
|
| 594 | * @param opts Options for altering program attachment
|
| 595 | * @return Reference to the newly created BPF link; or NULL is returned on
|
| 596 | * error, error code is stored in errno
|
| 597 |
|
| 598 | LIBBPF_API struct bpf_link *
|
| 599 | bpf_program__attach_kprobe_opts(const struct bpf_program *prog,
|
| 600 | const char *func_name,
|
| 601 | const struct bpf_kprobe_opts *opts);
|
| 602 |
|
| 603 | struct bpf_kprobe_multi_opts {
|
| 604 |
|
| 605 | size_t sz;
|
| 606 |
|
| 607 | const char **syms;
|
| 608 |
|
| 609 | const unsigned long *addrs;
|
| 610 |
|
| 611 | const __u64 *cookies;
|
| 612 |
|
| 613 | size_t cnt;
|
| 614 |
|
| 615 | bool retprobe;
|
| 616 |
|
| 617 | bool session;
|
| 618 |
|
| 619 | bool unique_match;
|
| 620 | size_t :0;
|
| 621 | };
|
| 622 |
|
| 623 | #define bpf_kprobe_multi_opts__last_field unique_match
|
| 624 |
|
| 625 | LIBBPF_API struct bpf_link *
|
| 626 | bpf_program__attach_kprobe_multi_opts(const struct bpf_program *prog,
|
| 627 | const char *pattern,
|
| 628 | const struct bpf_kprobe_multi_opts *opts);
|
| 629 |
|
| 630 | struct bpf_uprobe_multi_opts {
|
| 631 |
|
| 632 | size_t sz;
|
| 633 |
|
| 634 | const char **syms;
|
| 635 |
|
| 636 | const unsigned long *offsets;
|
| 637 |
|
| 638 | const unsigned long *ref_ctr_offsets;
|
| 639 |
|
| 640 | const __u64 *cookies;
|
| 641 |
|
| 642 | size_t cnt;
|
| 643 |
|
| 644 | bool retprobe;
|
| 645 |
|
| 646 | bool session;
|
| 647 | size_t :0;
|
| 648 | };
|
| 649 |
|
| 650 | #define bpf_uprobe_multi_opts__last_field session
|
| 651 |
|
| 652 | |
| 653 | * @brief **bpf_program__attach_uprobe_multi()** attaches a BPF program
|
| 654 | * to multiple uprobes with uprobe_multi link.
|
| 655 | *
|
| 656 | * User can specify 2 mutually exclusive set of inputs:
|
| 657 | *
|
| 658 | * 1) use only path/func_pattern/pid arguments
|
| 659 | *
|
| 660 | * 2) use path/pid with allowed combinations of
|
| 661 | * syms/offsets/ref_ctr_offsets/cookies/cnt
|
| 662 | *
|
| 663 | * - syms and offsets are mutually exclusive
|
| 664 | * - ref_ctr_offsets and cookies are optional
|
| 665 | *
|
| 666 | *
|
| 667 | * @param prog BPF program to attach
|
| 668 | * @param pid Process ID to attach the uprobe to, 0 for self (own process),
|
| 669 | * -1 for all processes
|
| 670 | * @param binary_path Path to binary
|
| 671 | * @param func_pattern Regular expression to specify functions to attach
|
| 672 | * BPF program to
|
| 673 | * @param opts Additional options (see **struct bpf_uprobe_multi_opts**)
|
| 674 | * @return 0, on success; negative error code, otherwise
|
| 675 |
|
| 676 | LIBBPF_API struct bpf_link *
|
| 677 | bpf_program__attach_uprobe_multi(const struct bpf_program *prog,
|
| 678 | pid_t pid,
|
| 679 | const char *binary_path,
|
| 680 | const char *func_pattern,
|
| 681 | const struct bpf_uprobe_multi_opts *opts);
|
| 682 |
|
| 683 | struct bpf_ksyscall_opts {
|
| 684 |
|
| 685 | size_t sz;
|
| 686 |
|
| 687 | __u64 bpf_cookie;
|
| 688 |
|
| 689 | bool retprobe;
|
| 690 | size_t :0;
|
| 691 | };
|
| 692 | #define bpf_ksyscall_opts__last_field retprobe
|
| 693 |
|
| 694 | |
| 695 | * @brief **bpf_program__attach_ksyscall()** attaches a BPF program
|
| 696 | * to kernel syscall handler of a specified syscall. Optionally it's possible
|
| 697 | * to request to install retprobe that will be triggered at syscall exit. It's
|
| 698 | * also possible to associate BPF cookie (though options).
|
| 699 | *
|
| 700 | * Libbpf automatically will determine correct full kernel function name,
|
| 701 | * which depending on system architecture and kernel version/configuration
|
| 702 | * could be of the form __<arch>_sys_<syscall> or __se_sys_<syscall>, and will
|
| 703 | * attach specified program using kprobe/kretprobe mechanism.
|
| 704 | *
|
| 705 | * **bpf_program__attach_ksyscall()** is an API counterpart of declarative
|
| 706 | * **SEC("ksyscall/<syscall>")** annotation of BPF programs.
|
| 707 | *
|
| 708 | * At the moment **SEC("ksyscall")** and **bpf_program__attach_ksyscall()** do
|
| 709 | * not handle all the calling convention quirks for mmap(), clone() and compat
|
| 710 | * syscalls. It also only attaches to "native" syscall interfaces. If host
|
| 711 | * system supports compat syscalls or defines 32-bit syscalls in 64-bit
|
| 712 | * kernel, such syscall interfaces won't be attached to by libbpf.
|
| 713 | *
|
| 714 | * These limitations may or may not change in the future. Therefore it is
|
| 715 | * recommended to use SEC("kprobe") for these syscalls or if working with
|
| 716 | * compat and 32-bit interfaces is required.
|
| 717 | *
|
| 718 | * @param prog BPF program to attach
|
| 719 | * @param syscall_name Symbolic name of the syscall (e.g., "bpf")
|
| 720 | * @param opts Additional options (see **struct bpf_ksyscall_opts**)
|
| 721 | * @return Reference to the newly created BPF link; or NULL is returned on
|
| 722 | * error, error code is stored in errno
|
| 723 |
|
| 724 | LIBBPF_API struct bpf_link *
|
| 725 | bpf_program__attach_ksyscall(const struct bpf_program *prog,
|
| 726 | const char *syscall_name,
|
| 727 | const struct bpf_ksyscall_opts *opts);
|
| 728 |
|
| 729 | struct bpf_tracing_multi_opts {
|
| 730 |
|
| 731 | size_t sz;
|
| 732 | const __u32 *ids;
|
| 733 | const __u64 *cookies;
|
| 734 | size_t cnt;
|
| 735 | size_t :0;
|
| 736 | };
|
| 737 |
|
| 738 | #define bpf_tracing_multi_opts__last_field cnt
|
| 739 |
|
| 740 | LIBBPF_API struct bpf_link *
|
| 741 | bpf_program__attach_tracing_multi(const struct bpf_program *prog, const char *pattern,
|
| 742 | const struct bpf_tracing_multi_opts *opts);
|
| 743 |
|
| 744 | struct bpf_uprobe_opts {
|
| 745 |
|
| 746 | size_t sz;
|
| 747 | |
| 748 | * a6ca88b241d5 ("trace_uprobe: support reference counter in fd-based uprobe")
|
| 749 |
|
| 750 | size_t ref_ctr_offset;
|
| 751 |
|
| 752 | __u64 bpf_cookie;
|
| 753 |
|
| 754 | bool retprobe;
|
| 755 | |
| 756 | * "abc@LIBXYZ" name. To specify function entry, func_name should be set while
|
| 757 | * func_offset argument to bpf_prog__attach_uprobe_opts() should be 0. To trace an
|
| 758 | * offset within a function, specify func_name and use func_offset argument to specify
|
| 759 | * offset within the function. Shared library functions must specify the shared library
|
| 760 | * binary_path.
|
| 761 |
|
| 762 | const char *func_name;
|
| 763 |
|
| 764 | enum probe_attach_mode attach_mode;
|
| 765 | size_t :0;
|
| 766 | };
|
| 767 | #define bpf_uprobe_opts__last_field attach_mode
|
| 768 |
|
| 769 | |
| 770 | * @brief **bpf_program__attach_uprobe()** attaches a BPF program
|
| 771 | * to the userspace function which is found by binary path and
|
| 772 | * offset. You can optionally specify a particular process to attach
|
| 773 | * to. You can also optionally attach the program to the function
|
| 774 | * exit instead of entry.
|
| 775 | *
|
| 776 | * @param prog BPF program to attach
|
| 777 | * @param retprobe Attach to function exit
|
| 778 | * @param pid Process ID to attach the uprobe to, 0 for self (own process),
|
| 779 | * -1 for all processes
|
| 780 | * @param binary_path Path to binary that contains the function symbol
|
| 781 | * @param func_offset Offset within the binary of the function symbol
|
| 782 | * @return Reference to the newly created BPF link; or NULL is returned on error,
|
| 783 | * error code is stored in errno
|
| 784 |
|
| 785 | LIBBPF_API struct bpf_link *
|
| 786 | bpf_program__attach_uprobe(const struct bpf_program *prog, bool retprobe,
|
| 787 | pid_t pid, const char *binary_path,
|
| 788 | size_t func_offset);
|
| 789 |
|
| 790 | |
| 791 | * @brief **bpf_program__attach_uprobe_opts()** is just like
|
| 792 | * bpf_program__attach_uprobe() except with a options struct
|
| 793 | * for various configurations.
|
| 794 | *
|
| 795 | * @param prog BPF program to attach
|
| 796 | * @param pid Process ID to attach the uprobe to, 0 for self (own process),
|
| 797 | * -1 for all processes
|
| 798 | * @param binary_path Path to binary that contains the function symbol
|
| 799 | * @param func_offset Offset within the binary of the function symbol
|
| 800 | * @param opts Options for altering program attachment
|
| 801 | * @return Reference to the newly created BPF link; or NULL is returned on error,
|
| 802 | * error code is stored in errno
|
| 803 |
|
| 804 | LIBBPF_API struct bpf_link *
|
| 805 | bpf_program__attach_uprobe_opts(const struct bpf_program *prog, pid_t pid,
|
| 806 | const char *binary_path, size_t func_offset,
|
| 807 | const struct bpf_uprobe_opts *opts);
|
| 808 |
|
| 809 | struct bpf_usdt_opts {
|
| 810 |
|
| 811 | size_t sz;
|
| 812 |
|
| 813 | __u64 usdt_cookie;
|
| 814 | size_t :0;
|
| 815 | };
|
| 816 | #define bpf_usdt_opts__last_field usdt_cookie
|
| 817 |
|
| 818 | |
| 819 | * @brief **bpf_program__attach_usdt()** is just like
|
| 820 | * bpf_program__attach_uprobe_opts() except it covers USDT (User-space
|
| 821 | * Statically Defined Tracepoint) attachment, instead of attaching to
|
| 822 | * user-space function entry or exit.
|
| 823 | *
|
| 824 | * @param prog BPF program to attach
|
| 825 | * @param pid Process ID to attach the uprobe to, 0 for self (own process),
|
| 826 | * -1 for all processes
|
| 827 | * @param binary_path Path to binary that contains provided USDT probe
|
| 828 | * @param usdt_provider USDT provider name
|
| 829 | * @param usdt_name USDT probe name
|
| 830 | * @param opts Options for altering program attachment
|
| 831 | * @return Reference to the newly created BPF link; or NULL is returned on error,
|
| 832 | * error code is stored in errno
|
| 833 |
|
| 834 | LIBBPF_API struct bpf_link *
|
| 835 | bpf_program__attach_usdt(const struct bpf_program *prog,
|
| 836 | pid_t pid, const char *binary_path,
|
| 837 | const char *usdt_provider, const char *usdt_name,
|
| 838 | const struct bpf_usdt_opts *opts);
|
| 839 |
|
| 840 | struct bpf_tracepoint_opts {
|
| 841 |
|
| 842 | size_t sz;
|
| 843 |
|
| 844 | __u64 bpf_cookie;
|
| 845 | };
|
| 846 | #define bpf_tracepoint_opts__last_field bpf_cookie
|
| 847 |
|
| 848 | LIBBPF_API struct bpf_link *
|
| 849 | bpf_program__attach_tracepoint(const struct bpf_program *prog,
|
| 850 | const char *tp_category,
|
| 851 | const char *tp_name);
|
| 852 | LIBBPF_API struct bpf_link *
|
| 853 | bpf_program__attach_tracepoint_opts(const struct bpf_program *prog,
|
| 854 | const char *tp_category,
|
| 855 | const char *tp_name,
|
| 856 | const struct bpf_tracepoint_opts *opts);
|
| 857 |
|
| 858 | struct bpf_raw_tracepoint_opts {
|
| 859 | size_t sz;
|
| 860 | __u64 cookie;
|
| 861 | size_t :0;
|
| 862 | };
|
| 863 | #define bpf_raw_tracepoint_opts__last_field cookie
|
| 864 |
|
| 865 | LIBBPF_API struct bpf_link *
|
| 866 | bpf_program__attach_raw_tracepoint(const struct bpf_program *prog,
|
| 867 | const char *tp_name);
|
| 868 | LIBBPF_API struct bpf_link *
|
| 869 | bpf_program__attach_raw_tracepoint_opts(const struct bpf_program *prog,
|
| 870 | const char *tp_name,
|
| 871 | struct bpf_raw_tracepoint_opts *opts);
|
| 872 |
|
| 873 | struct bpf_trace_opts {
|
| 874 |
|
| 875 | size_t sz;
|
| 876 |
|
| 877 | __u64 cookie;
|
| 878 | };
|
| 879 | #define bpf_trace_opts__last_field cookie
|
| 880 |
|
| 881 | LIBBPF_API struct bpf_link *
|
| 882 | bpf_program__attach_trace(const struct bpf_program *prog);
|
| 883 | LIBBPF_API struct bpf_link *
|
| 884 | bpf_program__attach_trace_opts(const struct bpf_program *prog, const struct bpf_trace_opts *opts);
|
| 885 |
|
| 886 | LIBBPF_API struct bpf_link *
|
| 887 | bpf_program__attach_lsm(const struct bpf_program *prog);
|
| 888 | LIBBPF_API struct bpf_link *
|
| 889 | bpf_program__attach_cgroup(const struct bpf_program *prog, int cgroup_fd);
|
| 890 | LIBBPF_API struct bpf_link *
|
| 891 | bpf_program__attach_netns(const struct bpf_program *prog, int netns_fd);
|
| 892 | LIBBPF_API struct bpf_link *
|
| 893 | bpf_program__attach_sockmap(const struct bpf_program *prog, int map_fd);
|
| 894 | LIBBPF_API struct bpf_link *
|
| 895 | bpf_program__attach_xdp(const struct bpf_program *prog, int ifindex);
|
| 896 | LIBBPF_API struct bpf_link *
|
| 897 | bpf_program__attach_freplace(const struct bpf_program *prog,
|
| 898 | int target_fd, const char *attach_func_name);
|
| 899 |
|
| 900 | struct bpf_netfilter_opts {
|
| 901 |
|
| 902 | size_t sz;
|
| 903 |
|
| 904 | __u32 pf;
|
| 905 | __u32 hooknum;
|
| 906 | __s32 priority;
|
| 907 | __u32 flags;
|
| 908 | };
|
| 909 | #define bpf_netfilter_opts__last_field flags
|
| 910 |
|
| 911 | LIBBPF_API struct bpf_link *
|
| 912 | bpf_program__attach_netfilter(const struct bpf_program *prog,
|
| 913 | const struct bpf_netfilter_opts *opts);
|
| 914 |
|
| 915 | struct bpf_tcx_opts {
|
| 916 |
|
| 917 | size_t sz;
|
| 918 | __u32 flags;
|
| 919 | __u32 relative_fd;
|
| 920 | __u32 relative_id;
|
| 921 | __u64 expected_revision;
|
| 922 | size_t :0;
|
| 923 | };
|
| 924 | #define bpf_tcx_opts__last_field expected_revision
|
| 925 |
|
| 926 | LIBBPF_API struct bpf_link *
|
| 927 | bpf_program__attach_tcx(const struct bpf_program *prog, int ifindex,
|
| 928 | const struct bpf_tcx_opts *opts);
|
| 929 |
|
| 930 | struct bpf_netkit_opts {
|
| 931 |
|
| 932 | size_t sz;
|
| 933 | __u32 flags;
|
| 934 | __u32 relative_fd;
|
| 935 | __u32 relative_id;
|
| 936 | __u64 expected_revision;
|
| 937 | size_t :0;
|
| 938 | };
|
| 939 | #define bpf_netkit_opts__last_field expected_revision
|
| 940 |
|
| 941 | LIBBPF_API struct bpf_link *
|
| 942 | bpf_program__attach_netkit(const struct bpf_program *prog, int ifindex,
|
| 943 | const struct bpf_netkit_opts *opts);
|
| 944 |
|
| 945 | struct bpf_cgroup_opts {
|
| 946 |
|
| 947 | size_t sz;
|
| 948 | __u32 flags;
|
| 949 | __u32 relative_fd;
|
| 950 | __u32 relative_id;
|
| 951 | __u64 expected_revision;
|
| 952 | size_t :0;
|
| 953 | };
|
| 954 | #define bpf_cgroup_opts__last_field expected_revision
|
| 955 |
|
| 956 | LIBBPF_API struct bpf_link *
|
| 957 | bpf_program__attach_cgroup_opts(const struct bpf_program *prog, int cgroup_fd,
|
| 958 | const struct bpf_cgroup_opts *opts);
|
| 959 |
|
| 960 | struct bpf_map;
|
| 961 |
|
| 962 | LIBBPF_API struct bpf_link *bpf_map__attach_struct_ops(const struct bpf_map *map);
|
| 963 | LIBBPF_API int bpf_link__update_map(struct bpf_link *link, const struct bpf_map *map);
|
| 964 |
|
| 965 | struct bpf_iter_attach_opts {
|
| 966 | size_t sz;
|
| 967 | union bpf_iter_link_info *link_info;
|
| 968 | __u32 link_info_len;
|
| 969 | };
|
| 970 | #define bpf_iter_attach_opts__last_field link_info_len
|
| 971 |
|
| 972 | LIBBPF_API struct bpf_link *
|
| 973 | bpf_program__attach_iter(const struct bpf_program *prog,
|
| 974 | const struct bpf_iter_attach_opts *opts);
|
| 975 |
|
| 976 | LIBBPF_API enum bpf_prog_type bpf_program__type(const struct bpf_program *prog);
|
| 977 |
|
| 978 | |
| 979 | * @brief **bpf_program__set_type()** sets the program
|
| 980 | * type of the passed BPF program.
|
| 981 | * @param prog BPF program to set the program type for
|
| 982 | * @param type program type to set the BPF map to have
|
| 983 | * @return error code; or 0 if no error. An error occurs
|
| 984 | * if the object is already loaded.
|
| 985 | *
|
| 986 | * This must be called before the BPF object is loaded,
|
| 987 | * otherwise it has no effect and an error is returned.
|
| 988 |
|
| 989 | LIBBPF_API int bpf_program__set_type(struct bpf_program *prog,
|
| 990 | enum bpf_prog_type type);
|
| 991 |
|
| 992 | LIBBPF_API enum bpf_attach_type
|
| 993 | bpf_program__expected_attach_type(const struct bpf_program *prog);
|
| 994 |
|
| 995 | |
| 996 | * @brief **bpf_program__set_expected_attach_type()** sets the
|
| 997 | * attach type of the passed BPF program. This is used for
|
| 998 | * auto-detection of attachment when programs are loaded.
|
| 999 | * @param prog BPF program to set the attach type for
|
| 1000 | * @param type attach type to set the BPF map to have
|
| 1001 | * @return error code; or 0 if no error. An error occurs
|
| 1002 | * if the object is already loaded.
|
| 1003 | *
|
| 1004 | * This must be called before the BPF object is loaded,
|
| 1005 | * otherwise it has no effect and an error is returned.
|
| 1006 |
|
| 1007 | LIBBPF_API int
|
| 1008 | bpf_program__set_expected_attach_type(struct bpf_program *prog,
|
| 1009 | enum bpf_attach_type type);
|
| 1010 |
|
| 1011 | LIBBPF_API __u32 bpf_program__flags(const struct bpf_program *prog);
|
| 1012 | LIBBPF_API int bpf_program__set_flags(struct bpf_program *prog, __u32 flags);
|
| 1013 |
|
| 1014 | |
| 1015 | * See bpf_object_open_opts comments regarding log_level and log_buf
|
| 1016 | * interactions.
|
| 1017 |
|
| 1018 | LIBBPF_API __u32 bpf_program__log_level(const struct bpf_program *prog);
|
| 1019 | LIBBPF_API int bpf_program__set_log_level(struct bpf_program *prog, __u32 log_level);
|
| 1020 | LIBBPF_API const char *bpf_program__log_buf(const struct bpf_program *prog, size_t *log_size);
|
| 1021 | LIBBPF_API int bpf_program__set_log_buf(struct bpf_program *prog, char *log_buf, size_t log_size);
|
| 1022 |
|
| 1023 | LIBBPF_API struct bpf_func_info *bpf_program__func_info(const struct bpf_program *prog);
|
| 1024 | LIBBPF_API __u32 bpf_program__func_info_cnt(const struct bpf_program *prog);
|
| 1025 |
|
| 1026 | LIBBPF_API struct bpf_line_info *bpf_program__line_info(const struct bpf_program *prog);
|
| 1027 | LIBBPF_API __u32 bpf_program__line_info_cnt(const struct bpf_program *prog);
|
| 1028 |
|
| 1029 | |
| 1030 | * @brief **bpf_program__set_attach_target()** sets BTF-based attach target
|
| 1031 | * for supported BPF program types:
|
| 1032 | * - BTF-aware raw tracepoints (tp_btf);
|
| 1033 | * - fentry/fexit/fmod_ret;
|
| 1034 | * - lsm;
|
| 1035 | * - freplace.
|
| 1036 | * @param prog BPF program to configure; must be not yet loaded.
|
| 1037 | * @param attach_prog_fd FD of target BPF program (for freplace/extension).
|
| 1038 | * If >0 and func name omitted, defers BTF ID resolution.
|
| 1039 | * @param attach_func_name Target function name. Used either with
|
| 1040 | * attach_prog_fd to find destination BTF type ID in that BPF program, or
|
| 1041 | * alone (no attach_prog_fd) to resolve kernel (vmlinux/module) BTF ID.
|
| 1042 | * Must be provided if attach_prog_fd is 0.
|
| 1043 | * @return error code; or 0 if no error occurred.
|
| 1044 |
|
| 1045 | LIBBPF_API int
|
| 1046 | bpf_program__set_attach_target(struct bpf_program *prog, int attach_prog_fd,
|
| 1047 | const char *attach_func_name);
|
| 1048 |
|
| 1049 | struct bpf_prog_assoc_struct_ops_opts;
|
| 1050 |
|
| 1051 | |
| 1052 | * @brief **bpf_program__assoc_struct_ops()** associates a BPF program with a
|
| 1053 | * struct_ops map.
|
| 1054 | *
|
| 1055 | * @param prog BPF program
|
| 1056 | * @param map struct_ops map to be associated with the BPF program
|
| 1057 | * @param opts optional options, can be NULL
|
| 1058 | *
|
| 1059 | * @return 0, on success; negative error code, otherwise
|
| 1060 |
|
| 1061 | LIBBPF_API int
|
| 1062 | bpf_program__assoc_struct_ops(struct bpf_program *prog, struct bpf_map *map,
|
| 1063 | struct bpf_prog_assoc_struct_ops_opts *opts);
|
| 1064 |
|
| 1065 | |
| 1066 | * @brief **bpf_object__find_map_by_name()** returns BPF map of
|
| 1067 | * the given name, if it exists within the passed BPF object
|
| 1068 | * @param obj BPF object
|
| 1069 | * @param name name of the BPF map
|
| 1070 | * @return BPF map instance, if such map exists within the BPF object;
|
| 1071 | * or NULL otherwise.
|
| 1072 |
|
| 1073 | LIBBPF_API struct bpf_map *
|
| 1074 | bpf_object__find_map_by_name(const struct bpf_object *obj, const char *name);
|
| 1075 |
|
| 1076 | LIBBPF_API int
|
| 1077 | bpf_object__find_map_fd_by_name(const struct bpf_object *obj, const char *name);
|
| 1078 |
|
| 1079 | LIBBPF_API struct bpf_map *
|
| 1080 | bpf_object__next_map(const struct bpf_object *obj, const struct bpf_map *map);
|
| 1081 |
|
| 1082 | #define bpf_object__for_each_map(pos, obj) \
|
| 1083 | for ((pos) = bpf_object__next_map((obj), NULL); \
|
| 1084 | (pos) != NULL; \
|
| 1085 | (pos) = bpf_object__next_map((obj), (pos)))
|
| 1086 | #define bpf_map__for_each bpf_object__for_each_map
|
| 1087 |
|
| 1088 | LIBBPF_API struct bpf_map *
|
| 1089 | bpf_object__prev_map(const struct bpf_object *obj, const struct bpf_map *map);
|
| 1090 |
|
| 1091 | |
| 1092 | * @brief **bpf_map__set_autocreate()** sets whether libbpf has to auto-create
|
| 1093 | * BPF map during BPF object load phase.
|
| 1094 | * @param map the BPF map instance
|
| 1095 | * @param autocreate whether to create BPF map during BPF object load
|
| 1096 | * @return 0 on success; -EBUSY if BPF object was already loaded
|
| 1097 | *
|
| 1098 | * **bpf_map__set_autocreate()** allows to opt-out from libbpf auto-creating
|
| 1099 | * BPF map. By default, libbpf will attempt to create every single BPF map
|
| 1100 | * defined in BPF object file using BPF_MAP_CREATE command of bpf() syscall
|
| 1101 | * and fill in map FD in BPF instructions.
|
| 1102 | *
|
| 1103 | * This API allows to opt-out of this process for specific map instance. This
|
| 1104 | * can be useful if host kernel doesn't support such BPF map type or used
|
| 1105 | * combination of flags and user application wants to avoid creating such
|
| 1106 | * a map in the first place. User is still responsible to make sure that their
|
| 1107 | * BPF-side code that expects to use such missing BPF map is recognized by BPF
|
| 1108 | * verifier as dead code, otherwise BPF verifier will reject such BPF program.
|
| 1109 |
|
| 1110 | LIBBPF_API int bpf_map__set_autocreate(struct bpf_map *map, bool autocreate);
|
| 1111 | LIBBPF_API bool bpf_map__autocreate(const struct bpf_map *map);
|
| 1112 |
|
| 1113 | |
| 1114 | * @brief **bpf_map__set_autoattach()** sets whether libbpf has to auto-attach
|
| 1115 | * map during BPF skeleton attach phase.
|
| 1116 | * @param map the BPF map instance
|
| 1117 | * @param autoattach whether to attach map during BPF skeleton attach phase
|
| 1118 | * @return 0 on success; negative error code, otherwise
|
| 1119 |
|
| 1120 | LIBBPF_API int bpf_map__set_autoattach(struct bpf_map *map, bool autoattach);
|
| 1121 |
|
| 1122 | |
| 1123 | * @brief **bpf_map__autoattach()** returns whether BPF map is configured to
|
| 1124 | * auto-attach during BPF skeleton attach phase.
|
| 1125 | * @param map the BPF map instance
|
| 1126 | * @return true if map is set to auto-attach during skeleton attach phase; false, otherwise
|
| 1127 |
|
| 1128 | LIBBPF_API bool bpf_map__autoattach(const struct bpf_map *map);
|
| 1129 |
|
| 1130 | |
| 1131 | * @brief **bpf_map__fd()** gets the file descriptor of the passed
|
| 1132 | * BPF map
|
| 1133 | * @param map the BPF map instance
|
| 1134 | * @return the file descriptor; or -EINVAL in case of an error
|
| 1135 |
|
| 1136 | LIBBPF_API int bpf_map__fd(const struct bpf_map *map);
|
| 1137 | LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd);
|
| 1138 |
|
| 1139 | LIBBPF_API const char *bpf_map__name(const struct bpf_map *map);
|
| 1140 |
|
| 1141 | LIBBPF_API enum bpf_map_type bpf_map__type(const struct bpf_map *map);
|
| 1142 | LIBBPF_API int bpf_map__set_type(struct bpf_map *map, enum bpf_map_type type);
|
| 1143 |
|
| 1144 | LIBBPF_API __u32 bpf_map__max_entries(const struct bpf_map *map);
|
| 1145 | LIBBPF_API int bpf_map__set_max_entries(struct bpf_map *map, __u32 max_entries);
|
| 1146 |
|
| 1147 | LIBBPF_API __u32 bpf_map__map_flags(const struct bpf_map *map);
|
| 1148 | LIBBPF_API int bpf_map__set_map_flags(struct bpf_map *map, __u32 flags);
|
| 1149 |
|
| 1150 | LIBBPF_API __u32 bpf_map__numa_node(const struct bpf_map *map);
|
| 1151 | LIBBPF_API int bpf_map__set_numa_node(struct bpf_map *map, __u32 numa_node);
|
| 1152 |
|
| 1153 | LIBBPF_API __u32 bpf_map__key_size(const struct bpf_map *map);
|
| 1154 | LIBBPF_API int bpf_map__set_key_size(struct bpf_map *map, __u32 size);
|
| 1155 |
|
| 1156 | LIBBPF_API __u32 bpf_map__value_size(const struct bpf_map *map);
|
| 1157 | |
| 1158 | * @brief **bpf_map__set_value_size()** sets map value size.
|
| 1159 | * @param map the BPF map instance
|
| 1160 | * @param size the new value size
|
| 1161 | * @return 0, on success; negative error, otherwise
|
| 1162 | *
|
| 1163 | * There is a special case for maps with associated memory-mapped regions, like
|
| 1164 | * the global data section maps (bss, data, rodata). When this function is used
|
| 1165 | * on such a map, the mapped region is resized. Afterward, an attempt is made to
|
| 1166 | * adjust the corresponding BTF info. This attempt is best-effort and can only
|
| 1167 | * succeed if the last variable of the data section map is an array. The array
|
| 1168 | * BTF type is replaced by a new BTF array type with a different length.
|
| 1169 | * Any previously existing pointers returned from bpf_map__initial_value() or
|
| 1170 | * corresponding data section skeleton pointer must be reinitialized.
|
| 1171 |
|
| 1172 | LIBBPF_API int bpf_map__set_value_size(struct bpf_map *map, __u32 size);
|
| 1173 |
|
| 1174 | LIBBPF_API __u32 bpf_map__btf_key_type_id(const struct bpf_map *map);
|
| 1175 | LIBBPF_API __u32 bpf_map__btf_value_type_id(const struct bpf_map *map);
|
| 1176 |
|
| 1177 | LIBBPF_API __u32 bpf_map__ifindex(const struct bpf_map *map);
|
| 1178 | LIBBPF_API int bpf_map__set_ifindex(struct bpf_map *map, __u32 ifindex);
|
| 1179 |
|
| 1180 | LIBBPF_API __u64 bpf_map__map_extra(const struct bpf_map *map);
|
| 1181 | LIBBPF_API int bpf_map__set_map_extra(struct bpf_map *map, __u64 map_extra);
|
| 1182 |
|
| 1183 | LIBBPF_API int bpf_map__set_initial_value(struct bpf_map *map,
|
| 1184 | const void *data, size_t size);
|
| 1185 | LIBBPF_API void *bpf_map__initial_value(const struct bpf_map *map, size_t *psize);
|
| 1186 |
|
| 1187 | |
| 1188 | * @brief **bpf_map__is_internal()** tells the caller whether or not the
|
| 1189 | * passed map is a special map created by libbpf automatically for things like
|
| 1190 | * global variables, __ksym externs, Kconfig values, etc
|
| 1191 | * @param map the bpf_map
|
| 1192 | * @return true, if the map is an internal map; false, otherwise
|
| 1193 |
|
| 1194 | LIBBPF_API bool bpf_map__is_internal(const struct bpf_map *map);
|
| 1195 |
|
| 1196 | |
| 1197 | * @brief **bpf_map__set_pin_path()** sets the path attribute that tells where the
|
| 1198 | * BPF map should be pinned. This does not actually create the 'pin'.
|
| 1199 | * @param map The bpf_map
|
| 1200 | * @param path The path
|
| 1201 | * @return 0, on success; negative error, otherwise
|
| 1202 |
|
| 1203 | LIBBPF_API int bpf_map__set_pin_path(struct bpf_map *map, const char *path);
|
| 1204 |
|
| 1205 | |
| 1206 | * @brief **bpf_map__pin_path()** gets the path attribute that tells where the
|
| 1207 | * BPF map should be pinned.
|
| 1208 | * @param map The bpf_map
|
| 1209 | * @return The path string; which can be NULL
|
| 1210 |
|
| 1211 | LIBBPF_API const char *bpf_map__pin_path(const struct bpf_map *map);
|
| 1212 |
|
| 1213 | |
| 1214 | * @brief **bpf_map__is_pinned()** tells the caller whether or not the
|
| 1215 | * passed map has been pinned via a 'pin' file.
|
| 1216 | * @param map The bpf_map
|
| 1217 | * @return true, if the map is pinned; false, otherwise
|
| 1218 |
|
| 1219 | LIBBPF_API bool bpf_map__is_pinned(const struct bpf_map *map);
|
| 1220 |
|
| 1221 | |
| 1222 | * @brief **bpf_map__pin()** creates a file that serves as a 'pin'
|
| 1223 | * for the BPF map. This increments the reference count on the
|
| 1224 | * BPF map which will keep the BPF map loaded even after the
|
| 1225 | * userspace process which loaded it has exited.
|
| 1226 | * @param map The bpf_map to pin
|
| 1227 | * @param path A file path for the 'pin'
|
| 1228 | * @return 0, on success; negative error, otherwise
|
| 1229 | *
|
| 1230 | * If `path` is NULL the maps `pin_path` attribute will be used. If this is
|
| 1231 | * also NULL, an error will be returned and the map will not be pinned.
|
| 1232 |
|
| 1233 | LIBBPF_API int bpf_map__pin(struct bpf_map *map, const char *path);
|
| 1234 |
|
| 1235 | |
| 1236 | * @brief **bpf_map__unpin()** removes the file that serves as a
|
| 1237 | * 'pin' for the BPF map.
|
| 1238 | * @param map The bpf_map to unpin
|
| 1239 | * @param path A file path for the 'pin'
|
| 1240 | * @return 0, on success; negative error, otherwise
|
| 1241 | *
|
| 1242 | * The `path` parameter can be NULL, in which case the `pin_path`
|
| 1243 | * map attribute is unpinned. If both the `path` parameter and
|
| 1244 | * `pin_path` map attribute are set, they must be equal.
|
| 1245 |
|
| 1246 | LIBBPF_API int bpf_map__unpin(struct bpf_map *map, const char *path);
|
| 1247 |
|
| 1248 | LIBBPF_API int bpf_map__set_inner_map_fd(struct bpf_map *map, int fd);
|
| 1249 | LIBBPF_API struct bpf_map *bpf_map__inner_map(struct bpf_map *map);
|
| 1250 |
|
| 1251 | |
| 1252 | * @brief **bpf_map__lookup_elem()** allows to lookup BPF map value
|
| 1253 | * corresponding to provided key.
|
| 1254 | * @param map BPF map to lookup element in
|
| 1255 | * @param key pointer to memory containing bytes of the key used for lookup
|
| 1256 | * @param key_sz size in bytes of key data, needs to match BPF map definition's **key_size**
|
| 1257 | * @param value pointer to memory in which looked up value will be stored
|
| 1258 | * @param value_sz size in byte of value data memory; it has to match BPF map
|
| 1259 | * definition's **value_size**. For per-CPU BPF maps, value size can be
|
| 1260 | * `value_size` if either **BPF_F_CPU** or **BPF_F_ALL_CPUS** is specified
|
| 1261 | * in **flags**, otherwise a product of BPF map value size and number of
|
| 1262 | * possible CPUs in the system (could be fetched with
|
| 1263 | * **libbpf_num_possible_cpus()**). Note also that for per-CPU values value
|
| 1264 | * size has to be aligned up to closest 8 bytes, so expected size is:
|
| 1265 | * `round_up(value_size, 8) * libbpf_num_possible_cpus()`.
|
| 1266 | * @param flags extra flags passed to kernel for this operation
|
| 1267 | * @return 0, on success; negative error, otherwise
|
| 1268 | *
|
| 1269 | * **bpf_map__lookup_elem()** is high-level equivalent of
|
| 1270 | * **bpf_map_lookup_elem()** API with added check for key and value size.
|
| 1271 |
|
| 1272 | LIBBPF_API int bpf_map__lookup_elem(const struct bpf_map *map,
|
| 1273 | const void *key, size_t key_sz,
|
| 1274 | void *value, size_t value_sz, __u64 flags);
|
| 1275 |
|
| 1276 | |
| 1277 | * @brief **bpf_map__update_elem()** allows to insert or update value in BPF
|
| 1278 | * map that corresponds to provided key.
|
| 1279 | * @param map BPF map to insert to or update element in
|
| 1280 | * @param key pointer to memory containing bytes of the key
|
| 1281 | * @param key_sz size in bytes of key data, needs to match BPF map definition's **key_size**
|
| 1282 | * @param value pointer to memory containing bytes of the value
|
| 1283 | * @param value_sz refer to **bpf_map__lookup_elem**'s description.'
|
| 1284 | * @param flags extra flags passed to kernel for this operation
|
| 1285 | * @return 0, on success; negative error, otherwise
|
| 1286 | *
|
| 1287 | * **bpf_map__update_elem()** is high-level equivalent of
|
| 1288 | * **bpf_map_update_elem()** API with added check for key and value size.
|
| 1289 |
|
| 1290 | LIBBPF_API int bpf_map__update_elem(const struct bpf_map *map,
|
| 1291 | const void *key, size_t key_sz,
|
| 1292 | const void *value, size_t value_sz, __u64 flags);
|
| 1293 |
|
| 1294 | |
| 1295 | * @brief **bpf_map__delete_elem()** allows to delete element in BPF map that
|
| 1296 | * corresponds to provided key.
|
| 1297 | * @param map BPF map to delete element from
|
| 1298 | * @param key pointer to memory containing bytes of the key
|
| 1299 | * @param key_sz size in bytes of key data, needs to match BPF map definition's **key_size**
|
| 1300 | * @param flags extra flags passed to kernel for this operation
|
| 1301 | * @return 0, on success; negative error, otherwise
|
| 1302 | *
|
| 1303 | * **bpf_map__delete_elem()** is high-level equivalent of
|
| 1304 | * **bpf_map_delete_elem()** API with added check for key size.
|
| 1305 |
|
| 1306 | LIBBPF_API int bpf_map__delete_elem(const struct bpf_map *map,
|
| 1307 | const void *key, size_t key_sz, __u64 flags);
|
| 1308 |
|
| 1309 | |
| 1310 | * @brief **bpf_map__lookup_and_delete_elem()** allows to lookup BPF map value
|
| 1311 | * corresponding to provided key and atomically delete it afterwards.
|
| 1312 | * @param map BPF map to lookup element in
|
| 1313 | * @param key pointer to memory containing bytes of the key used for lookup
|
| 1314 | * @param key_sz size in bytes of key data, needs to match BPF map definition's **key_size**
|
| 1315 | * @param value pointer to memory in which looked up value will be stored
|
| 1316 | * @param value_sz size in byte of value data memory; it has to match BPF map
|
| 1317 | * definition's **value_size**. For per-CPU BPF maps value size has to be
|
| 1318 | * a product of BPF map value size and number of possible CPUs in the system
|
| 1319 | * (could be fetched with **libbpf_num_possible_cpus()**). Note also that for
|
| 1320 | * per-CPU values value size has to be aligned up to closest 8 bytes for
|
| 1321 | * alignment reasons, so expected size is: `round_up(value_size, 8)
|
| 1322 | * * libbpf_num_possible_cpus()`.
|
| 1323 | * @param flags extra flags passed to kernel for this operation
|
| 1324 | * @return 0, on success; negative error, otherwise
|
| 1325 | *
|
| 1326 | * **bpf_map__lookup_and_delete_elem()** is high-level equivalent of
|
| 1327 | * **bpf_map_lookup_and_delete_elem()** API with added check for key and value size.
|
| 1328 |
|
| 1329 | LIBBPF_API int bpf_map__lookup_and_delete_elem(const struct bpf_map *map,
|
| 1330 | const void *key, size_t key_sz,
|
| 1331 | void *value, size_t value_sz, __u64 flags);
|
| 1332 |
|
| 1333 | |
| 1334 | * @brief **bpf_map__get_next_key()** allows to iterate BPF map keys by
|
| 1335 | * fetching next key that follows current key.
|
| 1336 | * @param map BPF map to fetch next key from
|
| 1337 | * @param cur_key pointer to memory containing bytes of current key or NULL to
|
| 1338 | * fetch the first key
|
| 1339 | * @param next_key pointer to memory to write next key into
|
| 1340 | * @param key_sz size in bytes of key data, needs to match BPF map definition's **key_size**
|
| 1341 | * @return 0, on success; -ENOENT if **cur_key** is the last key in BPF map;
|
| 1342 | * negative error, otherwise
|
| 1343 | *
|
| 1344 | * **bpf_map__get_next_key()** is high-level equivalent of
|
| 1345 | * **bpf_map_get_next_key()** API with added check for key size.
|
| 1346 |
|
| 1347 | LIBBPF_API int bpf_map__get_next_key(const struct bpf_map *map,
|
| 1348 | const void *cur_key, void *next_key, size_t key_sz);
|
| 1349 | |
| 1350 | * @brief **bpf_map__set_exclusive_program()** sets a map to be exclusive to the
|
| 1351 | * specified program. This must be called *before* the map is created.
|
| 1352 | *
|
| 1353 | * @param map BPF map to make exclusive.
|
| 1354 | * @param prog BPF program to be the exclusive user of the map. Must belong
|
| 1355 | * to the same bpf_object as the map.
|
| 1356 | * @return 0 on success; a negative error code otherwise.
|
| 1357 | *
|
| 1358 | * This function must be called after the BPF object is opened but before
|
| 1359 | * it is loaded. Once the object is loaded, only the specified program
|
| 1360 | * will be able to access the map's contents.
|
| 1361 |
|
| 1362 | LIBBPF_API int bpf_map__set_exclusive_program(struct bpf_map *map, struct bpf_program *prog);
|
| 1363 |
|
| 1364 | |
| 1365 | * @brief **bpf_map__exclusive_program()** returns the exclusive program
|
| 1366 | * that is registered with the map (if any).
|
| 1367 | * @param map BPF map to which the exclusive program is registered.
|
| 1368 | * @return the registered exclusive program.
|
| 1369 |
|
| 1370 | LIBBPF_API struct bpf_program *bpf_map__exclusive_program(struct bpf_map *map);
|
| 1371 |
|
| 1372 | struct bpf_xdp_set_link_opts {
|
| 1373 | size_t sz;
|
| 1374 | int old_fd;
|
| 1375 | size_t :0;
|
| 1376 | };
|
| 1377 | #define bpf_xdp_set_link_opts__last_field old_fd
|
| 1378 |
|
| 1379 | struct bpf_xdp_attach_opts {
|
| 1380 | size_t sz;
|
| 1381 | int old_prog_fd;
|
| 1382 | size_t :0;
|
| 1383 | };
|
| 1384 | #define bpf_xdp_attach_opts__last_field old_prog_fd
|
| 1385 |
|
| 1386 | struct bpf_xdp_query_opts {
|
| 1387 | size_t sz;
|
| 1388 | __u32 prog_id;
|
| 1389 | __u32 drv_prog_id;
|
| 1390 | __u32 hw_prog_id;
|
| 1391 | __u32 skb_prog_id;
|
| 1392 | __u8 attach_mode;
|
| 1393 | __u64 feature_flags;
|
| 1394 | __u32 xdp_zc_max_segs;
|
| 1395 | size_t :0;
|
| 1396 | };
|
| 1397 | #define bpf_xdp_query_opts__last_field xdp_zc_max_segs
|
| 1398 |
|
| 1399 | LIBBPF_API int bpf_xdp_attach(int ifindex, int prog_fd, __u32 flags,
|
| 1400 | const struct bpf_xdp_attach_opts *opts);
|
| 1401 | LIBBPF_API int bpf_xdp_detach(int ifindex, __u32 flags,
|
| 1402 | const struct bpf_xdp_attach_opts *opts);
|
| 1403 | LIBBPF_API int bpf_xdp_query(int ifindex, int flags, struct bpf_xdp_query_opts *opts);
|
| 1404 | LIBBPF_API int bpf_xdp_query_id(int ifindex, int flags, __u32 *prog_id);
|
| 1405 |
|
| 1406 |
|
| 1407 | enum bpf_tc_attach_point {
|
| 1408 | BPF_TC_INGRESS = 1 << 0,
|
| 1409 | BPF_TC_EGRESS = 1 << 1,
|
| 1410 | BPF_TC_CUSTOM = 1 << 2,
|
| 1411 | BPF_TC_QDISC = 1 << 3,
|
| 1412 | };
|
| 1413 |
|
| 1414 | #define BPF_TC_PARENT(a, b) \
|
| 1415 | ((((a) << 16) & 0xFFFF0000U) | ((b) & 0x0000FFFFU))
|
| 1416 |
|
| 1417 | enum bpf_tc_flags {
|
| 1418 | BPF_TC_F_REPLACE = 1 << 0,
|
| 1419 | };
|
| 1420 |
|
| 1421 | struct bpf_tc_hook {
|
| 1422 | size_t sz;
|
| 1423 | int ifindex;
|
| 1424 | enum bpf_tc_attach_point attach_point;
|
| 1425 | __u32 parent;
|
| 1426 | __u32 handle;
|
| 1427 | const char *qdisc;
|
| 1428 | size_t :0;
|
| 1429 | };
|
| 1430 | #define bpf_tc_hook__last_field qdisc
|
| 1431 |
|
| 1432 | struct bpf_tc_opts {
|
| 1433 | size_t sz;
|
| 1434 | int prog_fd;
|
| 1435 | __u32 flags;
|
| 1436 | __u32 prog_id;
|
| 1437 | __u32 handle;
|
| 1438 | __u32 priority;
|
| 1439 | size_t :0;
|
| 1440 | };
|
| 1441 | #define bpf_tc_opts__last_field priority
|
| 1442 |
|
| 1443 | LIBBPF_API int bpf_tc_hook_create(struct bpf_tc_hook *hook);
|
| 1444 | LIBBPF_API int bpf_tc_hook_destroy(struct bpf_tc_hook *hook);
|
| 1445 | LIBBPF_API int bpf_tc_attach(const struct bpf_tc_hook *hook,
|
| 1446 | struct bpf_tc_opts *opts);
|
| 1447 | LIBBPF_API int bpf_tc_detach(const struct bpf_tc_hook *hook,
|
| 1448 | const struct bpf_tc_opts *opts);
|
| 1449 | LIBBPF_API int bpf_tc_query(const struct bpf_tc_hook *hook,
|
| 1450 | struct bpf_tc_opts *opts);
|
| 1451 |
|
| 1452 |
|
| 1453 | struct ring_buffer;
|
| 1454 | struct ring;
|
| 1455 | struct user_ring_buffer;
|
| 1456 |
|
| 1457 | typedef int (*ring_buffer_sample_fn)(void *ctx, void *data, size_t size);
|
| 1458 |
|
| 1459 | struct ring_buffer_opts {
|
| 1460 | size_t sz;
|
| 1461 | };
|
| 1462 |
|
| 1463 | #define ring_buffer_opts__last_field sz
|
| 1464 |
|
| 1465 | LIBBPF_API struct ring_buffer *
|
| 1466 | ring_buffer__new(int map_fd, ring_buffer_sample_fn sample_cb, void *ctx,
|
| 1467 | const struct ring_buffer_opts *opts);
|
| 1468 | LIBBPF_API void ring_buffer__free(struct ring_buffer *rb);
|
| 1469 | LIBBPF_API int ring_buffer__add(struct ring_buffer *rb, int map_fd,
|
| 1470 | ring_buffer_sample_fn sample_cb, void *ctx);
|
| 1471 | LIBBPF_API int ring_buffer__poll(struct ring_buffer *rb, int timeout_ms);
|
| 1472 | LIBBPF_API int ring_buffer__consume(struct ring_buffer *rb);
|
| 1473 | LIBBPF_API int ring_buffer__consume_n(struct ring_buffer *rb, size_t n);
|
| 1474 | LIBBPF_API int ring_buffer__epoll_fd(const struct ring_buffer *rb);
|
| 1475 |
|
| 1476 | |
| 1477 | * @brief **ring_buffer__ring()** returns the ringbuffer object inside a given
|
| 1478 | * ringbuffer manager representing a single BPF_MAP_TYPE_RINGBUF map instance.
|
| 1479 | *
|
| 1480 | * @param rb A ringbuffer manager object.
|
| 1481 | * @param idx An index into the ringbuffers contained within the ringbuffer
|
| 1482 | * manager object. The index is 0-based and corresponds to the order in which
|
| 1483 | * ring_buffer__add was called.
|
| 1484 | * @return A ringbuffer object on success; NULL and errno set if the index is
|
| 1485 | * invalid.
|
| 1486 |
|
| 1487 | LIBBPF_API struct ring *ring_buffer__ring(struct ring_buffer *rb,
|
| 1488 | unsigned int idx);
|
| 1489 |
|
| 1490 | |
| 1491 | * @brief **ring__consumer_pos()** returns the current consumer position in the
|
| 1492 | * given ringbuffer.
|
| 1493 | *
|
| 1494 | * @param r A ringbuffer object.
|
| 1495 | * @return The current consumer position.
|
| 1496 |
|
| 1497 | LIBBPF_API unsigned long ring__consumer_pos(const struct ring *r);
|
| 1498 |
|
| 1499 | |
| 1500 | * @brief **ring__producer_pos()** returns the current producer position in the
|
| 1501 | * given ringbuffer.
|
| 1502 | *
|
| 1503 | * @param r A ringbuffer object.
|
| 1504 | * @return The current producer position.
|
| 1505 |
|
| 1506 | LIBBPF_API unsigned long ring__producer_pos(const struct ring *r);
|
| 1507 |
|
| 1508 | |
| 1509 | * @brief **ring__avail_data_size()** returns the number of bytes in the
|
| 1510 | * ringbuffer not yet consumed. This has no locking associated with it, so it
|
| 1511 | * can be inaccurate if operations are ongoing while this is called. However, it
|
| 1512 | * should still show the correct trend over the long-term.
|
| 1513 | *
|
| 1514 | * @param r A ringbuffer object.
|
| 1515 | * @return The number of bytes not yet consumed.
|
| 1516 |
|
| 1517 | LIBBPF_API size_t ring__avail_data_size(const struct ring *r);
|
| 1518 |
|
| 1519 | |
| 1520 | * @brief **ring__size()** returns the total size of the ringbuffer's map data
|
| 1521 | * area (excluding special producer/consumer pages). Effectively this gives the
|
| 1522 | * amount of usable bytes of data inside the ringbuffer.
|
| 1523 | *
|
| 1524 | * @param r A ringbuffer object.
|
| 1525 | * @return The total size of the ringbuffer map data area.
|
| 1526 |
|
| 1527 | LIBBPF_API size_t ring__size(const struct ring *r);
|
| 1528 |
|
| 1529 | |
| 1530 | * @brief **ring__map_fd()** returns the file descriptor underlying the given
|
| 1531 | * ringbuffer.
|
| 1532 | *
|
| 1533 | * @param r A ringbuffer object.
|
| 1534 | * @return The underlying ringbuffer file descriptor
|
| 1535 |
|
| 1536 | LIBBPF_API int ring__map_fd(const struct ring *r);
|
| 1537 |
|
| 1538 | |
| 1539 | * @brief **ring__consume()** consumes available ringbuffer data without event
|
| 1540 | * polling.
|
| 1541 | *
|
| 1542 | * @param r A ringbuffer object.
|
| 1543 | * @return The number of records consumed (or INT_MAX, whichever is less), or
|
| 1544 | * a negative number if any of the callbacks return an error.
|
| 1545 |
|
| 1546 | LIBBPF_API int ring__consume(struct ring *r);
|
| 1547 |
|
| 1548 | |
| 1549 | * @brief **ring__consume_n()** consumes up to a requested amount of items from
|
| 1550 | * a ringbuffer without event polling.
|
| 1551 | *
|
| 1552 | * @param r A ringbuffer object.
|
| 1553 | * @param n Maximum amount of items to consume.
|
| 1554 | * @return The number of items consumed, or a negative number if any of the
|
| 1555 | * callbacks return an error.
|
| 1556 |
|
| 1557 | LIBBPF_API int ring__consume_n(struct ring *r, size_t n);
|
| 1558 |
|
| 1559 | struct user_ring_buffer_opts {
|
| 1560 | size_t sz;
|
| 1561 | };
|
| 1562 |
|
| 1563 | #define user_ring_buffer_opts__last_field sz
|
| 1564 |
|
| 1565 | |
| 1566 | * @brief **user_ring_buffer__new()** creates a new instance of a user ring
|
| 1567 | * buffer.
|
| 1568 | *
|
| 1569 | * @param map_fd A file descriptor to a BPF_MAP_TYPE_USER_RINGBUF map.
|
| 1570 | * @param opts Options for how the ring buffer should be created.
|
| 1571 | * @return A user ring buffer on success; NULL and errno being set on a
|
| 1572 | * failure.
|
| 1573 |
|
| 1574 | LIBBPF_API struct user_ring_buffer *
|
| 1575 | user_ring_buffer__new(int map_fd, const struct user_ring_buffer_opts *opts);
|
| 1576 |
|
| 1577 | |
| 1578 | * @brief **user_ring_buffer__reserve()** reserves a pointer to a sample in the
|
| 1579 | * user ring buffer.
|
| 1580 | * @param rb A pointer to a user ring buffer.
|
| 1581 | * @param size The size of the sample, in bytes.
|
| 1582 | * @return A pointer to an 8-byte aligned reserved region of the user ring
|
| 1583 | * buffer; NULL, and errno being set if a sample could not be reserved.
|
| 1584 | *
|
| 1585 | * This function is *not* thread safe, and callers must synchronize accessing
|
| 1586 | * this function if there are multiple producers. If a size is requested that
|
| 1587 | * is larger than the size of the entire ring buffer, errno will be set to
|
| 1588 | * E2BIG and NULL is returned. If the ring buffer could accommodate the size,
|
| 1589 | * but currently does not have enough space, errno is set to ENOSPC and NULL is
|
| 1590 | * returned.
|
| 1591 | *
|
| 1592 | * After initializing the sample, callers must invoke
|
| 1593 | * **user_ring_buffer__submit()** to post the sample to the kernel. Otherwise,
|
| 1594 | * the sample must be freed with **user_ring_buffer__discard()**.
|
| 1595 |
|
| 1596 | LIBBPF_API void *user_ring_buffer__reserve(struct user_ring_buffer *rb, __u32 size);
|
| 1597 |
|
| 1598 | |
| 1599 | * @brief **user_ring_buffer__reserve_blocking()** reserves a record in the
|
| 1600 | * ring buffer, possibly blocking for up to @timeout_ms until a sample becomes
|
| 1601 | * available.
|
| 1602 | * @param rb The user ring buffer.
|
| 1603 | * @param size The size of the sample, in bytes.
|
| 1604 | * @param timeout_ms The amount of time, in milliseconds, for which the caller
|
| 1605 | * should block when waiting for a sample. -1 causes the caller to block
|
| 1606 | * indefinitely.
|
| 1607 | * @return A pointer to an 8-byte aligned reserved region of the user ring
|
| 1608 | * buffer; NULL, and errno being set if a sample could not be reserved.
|
| 1609 | *
|
| 1610 | * This function is *not* thread safe, and callers must synchronize
|
| 1611 | * accessing this function if there are multiple producers
|
| 1612 | *
|
| 1613 | * If **timeout_ms** is -1, the function will block indefinitely until a sample
|
| 1614 | * becomes available. Otherwise, **timeout_ms** must be non-negative, or errno
|
| 1615 | * is set to EINVAL, and NULL is returned. If **timeout_ms** is 0, no blocking
|
| 1616 | * will occur and the function will return immediately after attempting to
|
| 1617 | * reserve a sample.
|
| 1618 | *
|
| 1619 | * If **size** is larger than the size of the entire ring buffer, errno is set
|
| 1620 | * to E2BIG and NULL is returned. If the ring buffer could accommodate
|
| 1621 | * **size**, but currently does not have enough space, the caller will block
|
| 1622 | * until at most **timeout_ms** has elapsed. If insufficient space is available
|
| 1623 | * at that time, errno is set to ENOSPC, and NULL is returned.
|
| 1624 | *
|
| 1625 | * The kernel guarantees that it will wake up this thread to check if
|
| 1626 | * sufficient space is available in the ring buffer at least once per
|
| 1627 | * invocation of the **bpf_ringbuf_drain()** helper function, provided that at
|
| 1628 | * least one sample is consumed, and the BPF program did not invoke the
|
| 1629 | * function with BPF_RB_NO_WAKEUP. A wakeup may occur sooner than that, but the
|
| 1630 | * kernel does not guarantee this. If the helper function is invoked with
|
| 1631 | * BPF_RB_FORCE_WAKEUP, a wakeup event will be sent even if no sample is
|
| 1632 | * consumed.
|
| 1633 | *
|
| 1634 | * When a sample of size **size** is found within **timeout_ms**, a pointer to
|
| 1635 | * the sample is returned. After initializing the sample, callers must invoke
|
| 1636 | * **user_ring_buffer__submit()** to post the sample to the ring buffer.
|
| 1637 | * Otherwise, the sample must be freed with **user_ring_buffer__discard()**.
|
| 1638 |
|
| 1639 | LIBBPF_API void *user_ring_buffer__reserve_blocking(struct user_ring_buffer *rb,
|
| 1640 | __u32 size,
|
| 1641 | int timeout_ms);
|
| 1642 |
|
| 1643 | |
| 1644 | * @brief **user_ring_buffer__submit()** submits a previously reserved sample
|
| 1645 | * into the ring buffer.
|
| 1646 | * @param rb The user ring buffer.
|
| 1647 | * @param sample A reserved sample.
|
| 1648 | *
|
| 1649 | * It is not necessary to synchronize amongst multiple producers when invoking
|
| 1650 | * this function.
|
| 1651 |
|
| 1652 | LIBBPF_API void user_ring_buffer__submit(struct user_ring_buffer *rb, void *sample);
|
| 1653 |
|
| 1654 | |
| 1655 | * @brief **user_ring_buffer__discard()** discards a previously reserved sample.
|
| 1656 | * @param rb The user ring buffer.
|
| 1657 | * @param sample A reserved sample.
|
| 1658 | *
|
| 1659 | * It is not necessary to synchronize amongst multiple producers when invoking
|
| 1660 | * this function.
|
| 1661 |
|
| 1662 | LIBBPF_API void user_ring_buffer__discard(struct user_ring_buffer *rb, void *sample);
|
| 1663 |
|
| 1664 | |
| 1665 | * @brief **user_ring_buffer__free()** frees a ring buffer that was previously
|
| 1666 | * created with **user_ring_buffer__new()**.
|
| 1667 | * @param rb The user ring buffer being freed.
|
| 1668 |
|
| 1669 | LIBBPF_API void user_ring_buffer__free(struct user_ring_buffer *rb);
|
| 1670 |
|
| 1671 |
|
| 1672 | struct perf_buffer;
|
| 1673 |
|
| 1674 | typedef void (*perf_buffer_sample_fn)(void *ctx, int cpu,
|
| 1675 | void *data, __u32 size);
|
| 1676 | typedef void (*perf_buffer_lost_fn)(void *ctx, int cpu, __u64 cnt);
|
| 1677 |
|
| 1678 |
|
| 1679 | struct perf_buffer_opts {
|
| 1680 | size_t sz;
|
| 1681 | __u32 sample_period;
|
| 1682 | size_t :0;
|
| 1683 | };
|
| 1684 | #define perf_buffer_opts__last_field sample_period
|
| 1685 |
|
| 1686 | |
| 1687 | * @brief **perf_buffer__new()** creates BPF perfbuf manager for a specified
|
| 1688 | * BPF_PERF_EVENT_ARRAY map
|
| 1689 | * @param map_fd FD of BPF_PERF_EVENT_ARRAY BPF map that will be used by BPF
|
| 1690 | * code to send data over to user-space
|
| 1691 | * @param page_cnt number of memory pages allocated for each per-CPU buffer
|
| 1692 | * @param sample_cb function called on each received data record
|
| 1693 | * @param lost_cb function called when record loss has occurred
|
| 1694 | * @param ctx user-provided extra context passed into *sample_cb* and *lost_cb*
|
| 1695 | * @param opts optional parameters for the perf buffer, can be null
|
| 1696 | * @return a new instance of struct perf_buffer on success, NULL on error with
|
| 1697 | * *errno* containing an error code
|
| 1698 |
|
| 1699 | LIBBPF_API struct perf_buffer *
|
| 1700 | perf_buffer__new(int map_fd, size_t page_cnt,
|
| 1701 | perf_buffer_sample_fn sample_cb, perf_buffer_lost_fn lost_cb, void *ctx,
|
| 1702 | const struct perf_buffer_opts *opts);
|
| 1703 |
|
| 1704 | enum bpf_perf_event_ret {
|
| 1705 | LIBBPF_PERF_EVENT_DONE = 0,
|
| 1706 | LIBBPF_PERF_EVENT_ERROR = -1,
|
| 1707 | LIBBPF_PERF_EVENT_CONT = -2,
|
| 1708 | };
|
| 1709 |
|
| 1710 | struct perf_event_header;
|
| 1711 |
|
| 1712 | typedef enum bpf_perf_event_ret
|
| 1713 | (*perf_buffer_event_fn)(void *ctx, int cpu, struct perf_event_header *event);
|
| 1714 |
|
| 1715 |
|
| 1716 | struct perf_buffer_raw_opts {
|
| 1717 | size_t sz;
|
| 1718 | long :0;
|
| 1719 | long :0;
|
| 1720 | |
| 1721 | * max_entries of given PERF_EVENT_ARRAY map)
|
| 1722 |
|
| 1723 | int cpu_cnt;
|
| 1724 |
|
| 1725 | int *cpus;
|
| 1726 |
|
| 1727 | int *map_keys;
|
| 1728 | };
|
| 1729 | #define perf_buffer_raw_opts__last_field map_keys
|
| 1730 |
|
| 1731 | struct perf_event_attr;
|
| 1732 |
|
| 1733 | LIBBPF_API struct perf_buffer *
|
| 1734 | perf_buffer__new_raw(int map_fd, size_t page_cnt, struct perf_event_attr *attr,
|
| 1735 | perf_buffer_event_fn event_cb, void *ctx,
|
| 1736 | const struct perf_buffer_raw_opts *opts);
|
| 1737 |
|
| 1738 | LIBBPF_API void perf_buffer__free(struct perf_buffer *pb);
|
| 1739 | LIBBPF_API int perf_buffer__epoll_fd(const struct perf_buffer *pb);
|
| 1740 | LIBBPF_API int perf_buffer__poll(struct perf_buffer *pb, int timeout_ms);
|
| 1741 | LIBBPF_API int perf_buffer__consume(struct perf_buffer *pb);
|
| 1742 | LIBBPF_API int perf_buffer__consume_buffer(struct perf_buffer *pb, size_t buf_idx);
|
| 1743 | LIBBPF_API size_t perf_buffer__buffer_cnt(const struct perf_buffer *pb);
|
| 1744 | LIBBPF_API int perf_buffer__buffer_fd(const struct perf_buffer *pb, size_t buf_idx);
|
| 1745 | |
| 1746 | * @brief **perf_buffer__buffer()** returns the per-cpu raw mmap()'ed underlying
|
| 1747 | * memory region of the ring buffer.
|
| 1748 | * This ring buffer can be used to implement a custom events consumer.
|
| 1749 | * The ring buffer starts with the *struct perf_event_mmap_page*, which
|
| 1750 | * holds the ring buffer management fields, when accessing the header
|
| 1751 | * structure it's important to be SMP aware.
|
| 1752 | * You can refer to *perf_event_read_simple* for a simple example.
|
| 1753 | * @param pb the perf buffer structure
|
| 1754 | * @param buf_idx the buffer index to retrieve
|
| 1755 | * @param buf (out) gets the base pointer of the mmap()'ed memory
|
| 1756 | * @param buf_size (out) gets the size of the mmap()'ed region
|
| 1757 | * @return 0 on success, negative error code for failure
|
| 1758 |
|
| 1759 | LIBBPF_API int perf_buffer__buffer(struct perf_buffer *pb, int buf_idx, void **buf,
|
| 1760 | size_t *buf_size);
|
| 1761 |
|
| 1762 | struct bpf_prog_linfo;
|
| 1763 | struct bpf_prog_info;
|
| 1764 |
|
| 1765 | LIBBPF_API void bpf_prog_linfo__free(struct bpf_prog_linfo *prog_linfo);
|
| 1766 | LIBBPF_API struct bpf_prog_linfo *
|
| 1767 | bpf_prog_linfo__new(const struct bpf_prog_info *info);
|
| 1768 | LIBBPF_API const struct bpf_line_info *
|
| 1769 | bpf_prog_linfo__lfind_addr_func(const struct bpf_prog_linfo *prog_linfo,
|
| 1770 | __u64 addr, __u32 func_idx, __u32 nr_skip);
|
| 1771 | LIBBPF_API const struct bpf_line_info *
|
| 1772 | bpf_prog_linfo__lfind(const struct bpf_prog_linfo *prog_linfo,
|
| 1773 | __u32 insn_off, __u32 nr_skip);
|
| 1774 |
|
| 1775 | |
| 1776 | * Probe for supported system features
|
| 1777 | *
|
| 1778 | * Note that running many of these probes in a short amount of time can cause
|
| 1779 | * the kernel to reach the maximal size of lockable memory allowed for the
|
| 1780 | * user, causing subsequent probes to fail. In this case, the caller may want
|
| 1781 | * to adjust that limit with setrlimit().
|
| 1782 |
|
| 1783 |
|
| 1784 | |
| 1785 | * @brief **libbpf_probe_bpf_prog_type()** detects if host kernel supports
|
| 1786 | * BPF programs of a given type.
|
| 1787 | * @param prog_type BPF program type to detect kernel support for
|
| 1788 | * @param opts reserved for future extensibility, should be NULL
|
| 1789 | * @return 1, if given program type is supported; 0, if given program type is
|
| 1790 | * not supported; negative error code if feature detection failed or can't be
|
| 1791 | * performed
|
| 1792 | *
|
| 1793 | * Make sure the process has required set of CAP_* permissions (or runs as
|
| 1794 | * root) when performing feature checking.
|
| 1795 |
|
| 1796 | LIBBPF_API int libbpf_probe_bpf_prog_type(enum bpf_prog_type prog_type, const void *opts);
|
| 1797 | |
| 1798 | * @brief **libbpf_probe_bpf_map_type()** detects if host kernel supports
|
| 1799 | * BPF maps of a given type.
|
| 1800 | * @param map_type BPF map type to detect kernel support for
|
| 1801 | * @param opts reserved for future extensibility, should be NULL
|
| 1802 | * @return 1, if given map type is supported; 0, if given map type is
|
| 1803 | * not supported; negative error code if feature detection failed or can't be
|
| 1804 | * performed
|
| 1805 | *
|
| 1806 | * Make sure the process has required set of CAP_* permissions (or runs as
|
| 1807 | * root) when performing feature checking.
|
| 1808 |
|
| 1809 | LIBBPF_API int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts);
|
| 1810 | |
| 1811 | * @brief **libbpf_probe_bpf_helper()** detects if host kernel supports the
|
| 1812 | * use of a given BPF helper from specified BPF program type.
|
| 1813 | * @param prog_type BPF program type used to check the support of BPF helper
|
| 1814 | * @param helper_id BPF helper ID (enum bpf_func_id) to check support for
|
| 1815 | * @param opts reserved for future extensibility, should be NULL
|
| 1816 | * @return 1, if given combination of program type and helper is supported; 0,
|
| 1817 | * if the combination is not supported; negative error code if feature
|
| 1818 | * detection for provided input arguments failed or can't be performed
|
| 1819 | *
|
| 1820 | * Make sure the process has required set of CAP_* permissions (or runs as
|
| 1821 | * root) when performing feature checking.
|
| 1822 |
|
| 1823 | LIBBPF_API int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type,
|
| 1824 | enum bpf_func_id helper_id, const void *opts);
|
| 1825 |
|
| 1826 | |
| 1827 | * @brief **libbpf_num_possible_cpus()** is a helper function to get the
|
| 1828 | * number of possible CPUs that the host kernel supports and expects.
|
| 1829 | * @return number of possible CPUs; or error code on failure
|
| 1830 | *
|
| 1831 | * Example usage:
|
| 1832 | *
|
| 1833 | * int ncpus = libbpf_num_possible_cpus();
|
| 1834 | * if (ncpus < 0) {
|
| 1835 | * // error handling
|
| 1836 | * }
|
| 1837 | * long values[ncpus];
|
| 1838 | * bpf_map_lookup_elem(per_cpu_map_fd, key, values);
|
| 1839 |
|
| 1840 | LIBBPF_API int libbpf_num_possible_cpus(void);
|
| 1841 |
|
| 1842 | struct bpf_map_skeleton {
|
| 1843 | const char *name;
|
| 1844 | struct bpf_map **map;
|
| 1845 | void **mmaped;
|
| 1846 | struct bpf_link **link;
|
| 1847 | };
|
| 1848 |
|
| 1849 | struct bpf_prog_skeleton {
|
| 1850 | const char *name;
|
| 1851 | struct bpf_program **prog;
|
| 1852 | struct bpf_link **link;
|
| 1853 | };
|
| 1854 |
|
| 1855 | struct bpf_object_skeleton {
|
| 1856 | size_t sz;
|
| 1857 |
|
| 1858 | const char *name;
|
| 1859 | const void *data;
|
| 1860 | size_t data_sz;
|
| 1861 |
|
| 1862 | struct bpf_object **obj;
|
| 1863 |
|
| 1864 | int map_cnt;
|
| 1865 | int map_skel_sz;
|
| 1866 | struct bpf_map_skeleton *maps;
|
| 1867 |
|
| 1868 | int prog_cnt;
|
| 1869 | int prog_skel_sz;
|
| 1870 | struct bpf_prog_skeleton *progs;
|
| 1871 | };
|
| 1872 |
|
| 1873 | LIBBPF_API int
|
| 1874 | bpf_object__open_skeleton(struct bpf_object_skeleton *s,
|
| 1875 | const struct bpf_object_open_opts *opts);
|
| 1876 | LIBBPF_API int bpf_object__load_skeleton(struct bpf_object_skeleton *s);
|
| 1877 | LIBBPF_API int bpf_object__attach_skeleton(struct bpf_object_skeleton *s);
|
| 1878 | LIBBPF_API void bpf_object__detach_skeleton(struct bpf_object_skeleton *s);
|
| 1879 | LIBBPF_API void bpf_object__destroy_skeleton(struct bpf_object_skeleton *s);
|
| 1880 |
|
| 1881 | struct bpf_var_skeleton {
|
| 1882 | const char *name;
|
| 1883 | struct bpf_map **map;
|
| 1884 | void **addr;
|
| 1885 | };
|
| 1886 |
|
| 1887 | struct bpf_object_subskeleton {
|
| 1888 | size_t sz;
|
| 1889 |
|
| 1890 | const struct bpf_object *obj;
|
| 1891 |
|
| 1892 | int map_cnt;
|
| 1893 | int map_skel_sz;
|
| 1894 | struct bpf_map_skeleton *maps;
|
| 1895 |
|
| 1896 | int prog_cnt;
|
| 1897 | int prog_skel_sz;
|
| 1898 | struct bpf_prog_skeleton *progs;
|
| 1899 |
|
| 1900 | int var_cnt;
|
| 1901 | int var_skel_sz;
|
| 1902 | struct bpf_var_skeleton *vars;
|
| 1903 | };
|
| 1904 |
|
| 1905 | LIBBPF_API int
|
| 1906 | bpf_object__open_subskeleton(struct bpf_object_subskeleton *s);
|
| 1907 | LIBBPF_API void
|
| 1908 | bpf_object__destroy_subskeleton(struct bpf_object_subskeleton *s);
|
| 1909 |
|
| 1910 | struct gen_loader_opts {
|
| 1911 | size_t sz;
|
| 1912 | const char *data;
|
| 1913 | const char *insns;
|
| 1914 | __u32 data_sz;
|
| 1915 | __u32 insns_sz;
|
| 1916 | bool gen_hash;
|
| 1917 | };
|
| 1918 |
|
| 1919 | #define gen_loader_opts__last_field gen_hash
|
| 1920 | LIBBPF_API int bpf_object__gen_loader(struct bpf_object *obj,
|
| 1921 | struct gen_loader_opts *opts);
|
| 1922 |
|
| 1923 | enum libbpf_tristate {
|
| 1924 | TRI_NO = 0,
|
| 1925 | TRI_YES = 1,
|
| 1926 | TRI_MODULE = 2,
|
| 1927 | };
|
| 1928 |
|
| 1929 | struct bpf_linker_opts {
|
| 1930 |
|
| 1931 | size_t sz;
|
| 1932 | };
|
| 1933 | #define bpf_linker_opts__last_field sz
|
| 1934 |
|
| 1935 | struct bpf_linker_file_opts {
|
| 1936 |
|
| 1937 | size_t sz;
|
| 1938 | };
|
| 1939 | #define bpf_linker_file_opts__last_field sz
|
| 1940 |
|
| 1941 | struct bpf_linker;
|
| 1942 |
|
| 1943 | LIBBPF_API struct bpf_linker *bpf_linker__new(const char *filename, struct bpf_linker_opts *opts);
|
| 1944 | LIBBPF_API struct bpf_linker *bpf_linker__new_fd(int fd, struct bpf_linker_opts *opts);
|
| 1945 | LIBBPF_API int bpf_linker__add_file(struct bpf_linker *linker,
|
| 1946 | const char *filename,
|
| 1947 | const struct bpf_linker_file_opts *opts);
|
| 1948 | LIBBPF_API int bpf_linker__add_fd(struct bpf_linker *linker, int fd,
|
| 1949 | const struct bpf_linker_file_opts *opts);
|
| 1950 | LIBBPF_API int bpf_linker__add_buf(struct bpf_linker *linker, void *buf, size_t buf_sz,
|
| 1951 | const struct bpf_linker_file_opts *opts);
|
| 1952 | LIBBPF_API int bpf_linker__finalize(struct bpf_linker *linker);
|
| 1953 | LIBBPF_API void bpf_linker__free(struct bpf_linker *linker);
|
| 1954 |
|
| 1955 | |
| 1956 | * Custom handling of BPF program's SEC() definitions
|
| 1957 |
|
| 1958 |
|
| 1959 | struct bpf_prog_load_opts;
|
| 1960 |
|
| 1961 | |
| 1962 | * can use various bpf_program__set_*() setters to adjust whatever properties
|
| 1963 | * are necessary.
|
| 1964 |
|
| 1965 | typedef int (*libbpf_prog_setup_fn_t)(struct bpf_program *prog, long cookie);
|
| 1966 |
|
| 1967 | |
| 1968 | * into the kernel. Callback can adjust opts as necessary.
|
| 1969 |
|
| 1970 | typedef int (*libbpf_prog_prepare_load_fn_t)(struct bpf_program *prog,
|
| 1971 | struct bpf_prog_load_opts *opts, long cookie);
|
| 1972 |
|
| 1973 | |
| 1974 | * auto-attach is not supported, callback should return 0 and set link to
|
| 1975 | * NULL (it's not considered an error during skeleton attach, but it will be
|
| 1976 | * an error for bpf_program__attach() calls). On error, error should be
|
| 1977 | * returned directly and link set to NULL. On success, return 0 and set link
|
| 1978 | * to a valid struct bpf_link.
|
| 1979 |
|
| 1980 | typedef int (*libbpf_prog_attach_fn_t)(const struct bpf_program *prog, long cookie,
|
| 1981 | struct bpf_link **link);
|
| 1982 |
|
| 1983 | struct libbpf_prog_handler_opts {
|
| 1984 |
|
| 1985 | size_t sz;
|
| 1986 | |
| 1987 | * prog_prepare_load_fn, and prog_attach_fn callbacks. Allows user to
|
| 1988 | * register one set of callbacks for multiple SEC() definitions and
|
| 1989 | * still be able to distinguish them, if necessary. For example,
|
| 1990 | * libbpf itself is using this to pass necessary flags (e.g.,
|
| 1991 | * sleepable flag) to a common internal SEC() handler.
|
| 1992 |
|
| 1993 | long cookie;
|
| 1994 | |
| 1995 | * Callback is optional, pass NULL if it's not necessary.
|
| 1996 |
|
| 1997 | libbpf_prog_setup_fn_t prog_setup_fn;
|
| 1998 | |
| 1999 | * Callback is optional, pass NULL if it's not necessary.
|
| 2000 |
|
| 2001 | libbpf_prog_prepare_load_fn_t prog_prepare_load_fn;
|
| 2002 | |
| 2003 | * Callback is optional, pass NULL if it's not necessary.
|
| 2004 |
|
| 2005 | libbpf_prog_attach_fn_t prog_attach_fn;
|
| 2006 | };
|
| 2007 | #define libbpf_prog_handler_opts__last_field prog_attach_fn
|
| 2008 |
|
| 2009 | |
| 2010 | * @brief **libbpf_register_prog_handler()** registers a custom BPF program
|
| 2011 | * SEC() handler.
|
| 2012 | * @param sec section prefix for which custom handler is registered
|
| 2013 | * @param prog_type BPF program type associated with specified section
|
| 2014 | * @param exp_attach_type Expected BPF attach type associated with specified section
|
| 2015 | * @param opts optional cookie, callbacks, and other extra options
|
| 2016 | * @return Non-negative handler ID is returned on success. This handler ID has
|
| 2017 | * to be passed to *libbpf_unregister_prog_handler()* to unregister such
|
| 2018 | * custom handler. Negative error code is returned on error.
|
| 2019 | *
|
| 2020 | * *sec* defines which SEC() definitions are handled by this custom handler
|
| 2021 | * registration. *sec* can have few different forms:
|
| 2022 | * - if *sec* is just a plain string (e.g., "abc"), it will match only
|
| 2023 | * SEC("abc"). If BPF program specifies SEC("abc/whatever") it will result
|
| 2024 | * in an error;
|
| 2025 | * - if *sec* is of the form "abc/", proper SEC() form is
|
| 2026 | * SEC("abc/something"), where acceptable "something" should be checked by
|
| 2027 | * *prog_init_fn* callback, if there are additional restrictions;
|
| 2028 | * - if *sec* is of the form "abc+", it will successfully match both
|
| 2029 | * SEC("abc") and SEC("abc/whatever") forms;
|
| 2030 | * - if *sec* is NULL, custom handler is registered for any BPF program that
|
| 2031 | * doesn't match any of the registered (custom or libbpf's own) SEC()
|
| 2032 | * handlers. There could be only one such generic custom handler registered
|
| 2033 | * at any given time.
|
| 2034 | *
|
| 2035 | * All custom handlers (except the one with *sec* == NULL) are processed
|
| 2036 | * before libbpf's own SEC() handlers. It is allowed to "override" libbpf's
|
| 2037 | * SEC() handlers by registering custom ones for the same section prefix
|
| 2038 | * (i.e., it's possible to have custom SEC("perf_event/LLC-load-misses")
|
| 2039 | * handler).
|
| 2040 | *
|
| 2041 | * Note, like much of global libbpf APIs (e.g., libbpf_set_print(),
|
| 2042 | * libbpf_set_strict_mode(), etc)) these APIs are not thread-safe. User needs
|
| 2043 | * to ensure synchronization if there is a risk of running this API from
|
| 2044 | * multiple threads simultaneously.
|
| 2045 |
|
| 2046 | LIBBPF_API int libbpf_register_prog_handler(const char *sec,
|
| 2047 | enum bpf_prog_type prog_type,
|
| 2048 | enum bpf_attach_type exp_attach_type,
|
| 2049 | const struct libbpf_prog_handler_opts *opts);
|
| 2050 | |
| 2051 | * @brief *libbpf_unregister_prog_handler()* unregisters previously registered
|
| 2052 | * custom BPF program SEC() handler.
|
| 2053 | * @param handler_id handler ID returned by *libbpf_register_prog_handler()*
|
| 2054 | * after successful registration
|
| 2055 | * @return 0 on success, negative error code if handler isn't found
|
| 2056 | *
|
| 2057 | * Note, like much of global libbpf APIs (e.g., libbpf_set_print(),
|
| 2058 | * libbpf_set_strict_mode(), etc)) these APIs are not thread-safe. User needs
|
| 2059 | * to ensure synchronization if there is a risk of running this API from
|
| 2060 | * multiple threads simultaneously.
|
| 2061 |
|
| 2062 | LIBBPF_API int libbpf_unregister_prog_handler(int handler_id);
|
| 2063 |
|
| 2064 | |
| 2065 | * @brief **bpf_program__clone()** loads a single BPF program from a prepared
|
| 2066 | * BPF object into the kernel, returning its file descriptor.
|
| 2067 | *
|
| 2068 | * The BPF object must have been previously prepared with
|
| 2069 | * **bpf_object__prepare()**. If @opts is provided, any non-zero field
|
| 2070 | * overrides the defaults derived from the program/object internals.
|
| 2071 | * If @opts is NULL, all fields are populated automatically.
|
| 2072 | *
|
| 2073 | * The returned FD is owned by the caller and must be closed with close().
|
| 2074 | *
|
| 2075 | * @param prog BPF program from a prepared object
|
| 2076 | * @param opts Optional load options; non-zero fields override defaults
|
| 2077 | * @return program FD (>= 0) on success; negative error code on failure
|
| 2078 |
|
| 2079 | LIBBPF_API int bpf_program__clone(struct bpf_program *prog, const struct bpf_prog_load_opts *opts);
|
| 2080 |
|
| 2081 | #ifdef __cplusplus
|
| 2082 | }
|
| 2083 | #endif
|
| 2084 |
|
| 2085 | #endif
|