tools/lib/bpf/libbpf.h

   1 /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
   2
   3 /*
   4  * Common eBPF ELF object loading operations.
   5  *
   6  * Copyright (C) 2013-2015 Alexei Starovoitov <ast@kernel.org>
   7  * Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
   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>  // for size_t
  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 LIBBPF_API __u32 libbpf_major_version(void);
  28 LIBBPF_API __u32 libbpf_minor_version(void);
  29 LIBBPF_API const char *libbpf_version_string(void);
  30
  31 enum libbpf_errno {
  32         __LIBBPF_ERRNO__START = 4000,
  33
  34         /* Something wrong in libelf */
  35         LIBBPF_ERRNO__LIBELF = __LIBBPF_ERRNO__START,
  36         LIBBPF_ERRNO__FORMAT,   /* BPF object format invalid */
  37         LIBBPF_ERRNO__KVERSION, /* Incorrect or no 'version' section */
  38         LIBBPF_ERRNO__ENDIAN,   /* Endian mismatch */
  39         LIBBPF_ERRNO__INTERNAL, /* Internal error in libbpf */
  40         LIBBPF_ERRNO__RELOC,    /* Relocation failed */
  41         LIBBPF_ERRNO__LOAD,     /* Load program failure for unknown reason */
  42         LIBBPF_ERRNO__VERIFY,   /* Kernel verifier blocks program loading */
  43         LIBBPF_ERRNO__PROG2BIG, /* Program too big */
  44         LIBBPF_ERRNO__KVER,     /* Incorrect kernel version */
  45         LIBBPF_ERRNO__PROGTYPE, /* Kernel doesn't support this program type */
  46         LIBBPF_ERRNO__WRNGPID,  /* Wrong pid in netlink message */
  47         LIBBPF_ERRNO__INVSEQ,   /* Invalid netlink sequence */
  48         LIBBPF_ERRNO__NLPARSE,  /* netlink parsing error */
  49         __LIBBPF_ERRNO__END,
  50 };
  51
  52 LIBBPF_API int libbpf_strerror(int err, char *buf, size_t size);
  53
  54 enum libbpf_print_level {
  55         LIBBPF_WARN,
  56         LIBBPF_INFO,
  57         LIBBPF_DEBUG,
  58 };
  59
  60 typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,
  61                                  const char *, va_list ap);
  62
  63 LIBBPF_API libbpf_print_fn_t libbpf_set_print(libbpf_print_fn_t fn);
  64
  65 /* Hide internal to user */
  66 struct bpf_object;
  67
  68 struct bpf_object_open_attr {
  69         const char *file;
  70         enum bpf_prog_type prog_type;
  71 };
  72
  73 struct bpf_object_open_opts {
  74         /* size of this struct, for forward/backward compatiblity */
  75         size_t sz;
  76         /* object name override, if provided:
  77          * - for object open from file, this will override setting object
  78          *   name from file path's base name;
  79          * - for object open from memory buffer, this will specify an object
  80          *   name and will override default "<addr>-<buf-size>" name;
  81          */
  82         const char *object_name;
  83         /* parse map definitions non-strictly, allowing extra attributes/data */
  84         bool relaxed_maps;
  85         /* DEPRECATED: handle CO-RE relocations non-strictly, allowing failures.
  86          * Value is ignored. Relocations always are processed non-strictly.
  87          * Non-relocatable instructions are replaced with invalid ones to
  88          * prevent accidental errors.
  89          * */
  90         LIBBPF_DEPRECATED_SINCE(0, 6, "field has no effect")
  91         bool relaxed_core_relocs;
  92         /* maps that set the 'pinning' attribute in their definition will have
  93          * their pin_path attribute set to a file in this directory, and be
  94          * auto-pinned to that path on load; defaults to "/sys/fs/bpf".
  95          */
  96         const char *pin_root_path;
  97
  98         LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_program__set_attach_target() on each individual bpf_program")
  99         __u32 attach_prog_fd;
 100         /* Additional kernel config content that augments and overrides
 101          * system Kconfig for CONFIG_xxx externs.
 102          */
 103         const char *kconfig;
 104         /* Path to the custom BTF to be used for BPF CO-RE relocations.
 105          * This custom BTF completely replaces the use of vmlinux BTF
 106          * for the purpose of CO-RE relocations.
 107          * NOTE: any other BPF feature (e.g., fentry/fexit programs,
 108          * struct_ops, etc) will need actual kernel BTF at /sys/kernel/btf/vmlinux.
 109          */
 110         const char *btf_custom_path;
 111         /* Pointer to a buffer for storing kernel logs for applicable BPF
 112          * commands. Valid kernel_log_size has to be specified as well and are
 113          * passed-through to bpf() syscall. Keep in mind that kernel might
 114          * fail operation with -ENOSPC error if provided buffer is too small
 115          * to contain entire log output.
 116          * See the comment below for kernel_log_level for interaction between
 117          * log_buf and log_level settings.
 118          *
 119          * If specified, this log buffer will be passed for:
 120          *   - each BPF progral load (BPF_PROG_LOAD) attempt, unless overriden
 121          *     with bpf_program__set_log() on per-program level, to get
 122          *     BPF verifier log output.
 123          *   - during BPF object's BTF load into kernel (BPF_BTF_LOAD) to get
 124          *     BTF sanity checking log.
 125          *
 126          * Each BPF command (BPF_BTF_LOAD or BPF_PROG_LOAD) will overwrite
 127          * previous contents, so if you need more fine-grained control, set
 128          * per-program buffer with bpf_program__set_log_buf() to preserve each
 129          * individual program's verification log. Keep using kernel_log_buf
 130          * for BTF verification log, if necessary.
 131          */
 132         char *kernel_log_buf;
 133         size_t kernel_log_size;
 134         /*
 135          * Log level can be set independently from log buffer. Log_level=0
 136          * means that libbpf will attempt loading BTF or program without any
 137          * logging requested, but will retry with either its own or custom log
 138          * buffer, if provided, and log_level=1 on any error.
 139          * And vice versa, setting log_level>0 will request BTF or prog
 140          * loading with verbose log from the first attempt (and as such also
 141          * for successfully loaded BTF or program), and the actual log buffer
 142          * could be either libbpf's own auto-allocated log buffer, if
 143          * kernel_log_buffer is NULL, or user-provided custom kernel_log_buf.
 144          * If user didn't provide custom log buffer, libbpf will emit captured
 145          * logs through its print callback.
 146          */
 147         __u32 kernel_log_level;
 148
 149         size_t :0;
 150 };
 151 #define bpf_object_open_opts__last_field kernel_log_level
 152
 153 LIBBPF_API struct bpf_object *bpf_object__open(const char *path);
 154
 155 /**
 156  * @brief **bpf_object__open_file()** creates a bpf_object by opening
 157  * the BPF ELF object file pointed to by the passed path and loading it
 158  * into memory.
 159  * @param path BPF object file path
 160  * @param opts options for how to load the bpf object, this parameter is
 161  * optional and can be set to NULL
 162  * @return pointer to the new bpf_object; or NULL is returned on error,
 163  * error code is stored in errno
 164  */
 165 LIBBPF_API struct bpf_object *
 166 bpf_object__open_file(const char *path, const struct bpf_object_open_opts *opts);
 167
 168 /**
 169  * @brief **bpf_object__open_mem()** creates a bpf_object by reading
 170  * the BPF objects raw bytes from a memory buffer containing a valid
 171  * BPF ELF object file.
 172  * @param obj_buf pointer to the buffer containing ELF file bytes
 173  * @param obj_buf_sz number of bytes in the buffer
 174  * @param opts options for how to load the bpf object
 175  * @return pointer to the new bpf_object; or NULL is returned on error,
 176  * error code is stored in errno
 177  */
 178 LIBBPF_API struct bpf_object *
 179 bpf_object__open_mem(const void *obj_buf, size_t obj_buf_sz,
 180                      const struct bpf_object_open_opts *opts);
 181
 182 /* deprecated bpf_object__open variants */
 183 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_object__open_mem() instead")
 184 LIBBPF_API struct bpf_object *
 185 bpf_object__open_buffer(const void *obj_buf, size_t obj_buf_sz,
 186                         const char *name);
 187 LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__open_file() instead")
 188 LIBBPF_API struct bpf_object *
 189 bpf_object__open_xattr(struct bpf_object_open_attr *attr);
 190
 191 enum libbpf_pin_type {
 192         LIBBPF_PIN_NONE,
 193         /* PIN_BY_NAME: pin maps by name (in /sys/fs/bpf by default) */
 194         LIBBPF_PIN_BY_NAME,
 195 };
 196
 197 /* pin_maps and unpin_maps can both be called with a NULL path, in which case
 198  * they will use the pin_path attribute of each map (and ignore all maps that
 199  * don't have a pin_path set).
 200  */
 201 LIBBPF_API int bpf_object__pin_maps(struct bpf_object *obj, const char *path);
 202 LIBBPF_API int bpf_object__unpin_maps(struct bpf_object *obj,
 203                                       const char *path);
 204 LIBBPF_API int bpf_object__pin_programs(struct bpf_object *obj,
 205                                         const char *path);
 206 LIBBPF_API int bpf_object__unpin_programs(struct bpf_object *obj,
 207                                           const char *path);
 208 LIBBPF_API int bpf_object__pin(struct bpf_object *object, const char *path);
 209 LIBBPF_API void bpf_object__close(struct bpf_object *object);
 210
 211 struct bpf_object_load_attr {
 212         struct bpf_object *obj;
 213         int log_level;
 214         const char *target_btf_path;
 215 };
 216
 217 /* Load/unload object into/from kernel */
 218 LIBBPF_API int bpf_object__load(struct bpf_object *obj);
 219 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_object__load() instead")
 220 LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr);
 221 LIBBPF_DEPRECATED_SINCE(0, 6, "bpf_object__unload() is deprecated, use bpf_object__close() instead")
 222 LIBBPF_API int bpf_object__unload(struct bpf_object *obj);
 223
 224 LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj);
 225 LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj);
 226 LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version);
 227
 228 struct btf;
 229 LIBBPF_API struct btf *bpf_object__btf(const struct bpf_object *obj);
 230 LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj);
 231
 232 LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__find_program_by_name() instead")
 233 LIBBPF_API struct bpf_program *
 234 bpf_object__find_program_by_title(const struct bpf_object *obj,
 235                                   const char *title);
 236 LIBBPF_API struct bpf_program *
 237 bpf_object__find_program_by_name(const struct bpf_object *obj,
 238                                  const char *name);
 239
 240 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "track bpf_objects in application code instead")
 241 struct bpf_object *bpf_object__next(struct bpf_object *prev);
 242 #define bpf_object__for_each_safe(pos, tmp)                     \
 243         for ((pos) = bpf_object__next(NULL),            \
 244                 (tmp) = bpf_object__next(pos);          \
 245              (pos) != NULL;                             \
 246              (pos) = (tmp), (tmp) = bpf_object__next(tmp))
 247
 248 typedef void (*bpf_object_clear_priv_t)(struct bpf_object *, void *);
 249 LIBBPF_DEPRECATED_SINCE(0, 7, "storage via set_priv/priv is deprecated")
 250 LIBBPF_API int bpf_object__set_priv(struct bpf_object *obj, void *priv,
 251                                     bpf_object_clear_priv_t clear_priv);
 252 LIBBPF_DEPRECATED_SINCE(0, 7, "storage via set_priv/priv is deprecated")
 253 LIBBPF_API void *bpf_object__priv(const struct bpf_object *prog);
 254
 255 LIBBPF_API int
 256 libbpf_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type,
 257                          enum bpf_attach_type *expected_attach_type);
 258 LIBBPF_API int libbpf_attach_type_by_name(const char *name,
 259                                           enum bpf_attach_type *attach_type);
 260 LIBBPF_API int libbpf_find_vmlinux_btf_id(const char *name,
 261                                           enum bpf_attach_type attach_type);
 262
 263 /* Accessors of bpf_program */
 264 struct bpf_program;
 265 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__next_program() instead")
 266 struct bpf_program *bpf_program__next(struct bpf_program *prog,
 267                                       const struct bpf_object *obj);
 268 LIBBPF_API struct bpf_program *
 269 bpf_object__next_program(const struct bpf_object *obj, struct bpf_program *prog);
 270
 271 #define bpf_object__for_each_program(pos, obj)                  \
 272         for ((pos) = bpf_object__next_program((obj), NULL);     \
 273              (pos) != NULL;                                     \
 274              (pos) = bpf_object__next_program((obj), (pos)))
 275
 276 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__prev_program() instead")
 277 struct bpf_program *bpf_program__prev(struct bpf_program *prog,
 278                                       const struct bpf_object *obj);
 279 LIBBPF_API struct bpf_program *
 280 bpf_object__prev_program(const struct bpf_object *obj, struct bpf_program *prog);
 281
 282 typedef void (*bpf_program_clear_priv_t)(struct bpf_program *, void *);
 283
 284 LIBBPF_DEPRECATED_SINCE(0, 7, "storage via set_priv/priv is deprecated")
 285 LIBBPF_API int bpf_program__set_priv(struct bpf_program *prog, void *priv,
 286                                      bpf_program_clear_priv_t clear_priv);
 287 LIBBPF_DEPRECATED_SINCE(0, 7, "storage via set_priv/priv is deprecated")
 288 LIBBPF_API void *bpf_program__priv(const struct bpf_program *prog);
 289 LIBBPF_API void bpf_program__set_ifindex(struct bpf_program *prog,
 290                                          __u32 ifindex);
 291
 292 LIBBPF_API const char *bpf_program__name(const struct bpf_program *prog);
 293 LIBBPF_API const char *bpf_program__section_name(const struct bpf_program *prog);
 294 LIBBPF_API LIBBPF_DEPRECATED("BPF program title is confusing term; please use bpf_program__section_name() instead")
 295 const char *bpf_program__title(const struct bpf_program *prog, bool needs_copy);
 296 LIBBPF_API bool bpf_program__autoload(const struct bpf_program *prog);
 297 LIBBPF_API int bpf_program__set_autoload(struct bpf_program *prog, bool autoload);
 298
 299 /* returns program size in bytes */
 300 LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_program__insn_cnt() instead")
 301 LIBBPF_API size_t bpf_program__size(const struct bpf_program *prog);
 302
 303 struct bpf_insn;
 304
 305 /**
 306  * @brief **bpf_program__insns()** gives read-only access to BPF program's
 307  * underlying BPF instructions.
 308  * @param prog BPF program for which to return instructions
 309  * @return a pointer to an array of BPF instructions that belong to the
 310  * specified BPF program
 311  *
 312  * Returned pointer is always valid and not NULL. Number of `struct bpf_insn`
 313  * pointed to can be fetched using **bpf_program__insn_cnt()** API.
 314  *
 315  * Keep in mind, libbpf can modify and append/delete BPF program's
 316  * instructions as it processes BPF object file and prepares everything for
 317  * uploading into the kernel. So depending on the point in BPF object
 318  * lifetime, **bpf_program__insns()** can return different sets of
 319  * instructions. As an example, during BPF object load phase BPF program
 320  * instructions will be CO-RE-relocated, BPF subprograms instructions will be
 321  * appended, ldimm64 instructions will have FDs embedded, etc. So instructions
 322  * returned before **bpf_object__load()** and after it might be quite
 323  * different.
 324  */
 325 LIBBPF_API const struct bpf_insn *bpf_program__insns(const struct bpf_program *prog);
 326 /**
 327  * @brief **bpf_program__insn_cnt()** returns number of `struct bpf_insn`'s
 328  * that form specified BPF program.
 329  * @param prog BPF program for which to return number of BPF instructions
 330  *
 331  * See **bpf_program__insns()** documentation for notes on how libbpf can
 332  * change instructions and their count during different phases of
 333  * **bpf_object** lifetime.
 334  */
 335 LIBBPF_API size_t bpf_program__insn_cnt(const struct bpf_program *prog);
 336
 337 LIBBPF_DEPRECATED_SINCE(0, 6, "use bpf_object__load() instead")
 338 LIBBPF_API int bpf_program__load(struct bpf_program *prog, const char *license, __u32 kern_version);
 339 LIBBPF_API int bpf_program__fd(const struct bpf_program *prog);
 340 LIBBPF_DEPRECATED_SINCE(0, 7, "multi-instance bpf_program support is deprecated")
 341 LIBBPF_API int bpf_program__pin_instance(struct bpf_program *prog,
 342                                          const char *path,
 343                                          int instance);
 344 LIBBPF_DEPRECATED_SINCE(0, 7, "multi-instance bpf_program support is deprecated")
 345 LIBBPF_API int bpf_program__unpin_instance(struct bpf_program *prog,
 346                                            const char *path,
 347                                            int instance);
 348
 349 /**
 350  * @brief **bpf_program__pin()** pins the BPF program to a file
 351  * in the BPF FS specified by a path. This increments the programs
 352  * reference count, allowing it to stay loaded after the process
 353  * which loaded it has exited.
 354  *
 355  * @param prog BPF program to pin, must already be loaded
 356  * @param path file path in a BPF file system
 357  * @return 0, on success; negative error code, otherwise
 358  */
 359 LIBBPF_API int bpf_program__pin(struct bpf_program *prog, const char *path);
 360
 361 /**
 362  * @brief **bpf_program__unpin()** unpins the BPF program from a file
 363  * in the BPFFS specified by a path. This decrements the programs
 364  * reference count.
 365  *
 366  * The file pinning the BPF program can also be unlinked by a different
 367  * process in which case this function will return an error.
 368  *
 369  * @param prog BPF program to unpin
 370  * @param path file path to the pin in a BPF file system
 371  * @return 0, on success; negative error code, otherwise
 372  */
 373 LIBBPF_API int bpf_program__unpin(struct bpf_program *prog, const char *path);
 374 LIBBPF_API void bpf_program__unload(struct bpf_program *prog);
 375
 376 struct bpf_link;
 377
 378 LIBBPF_API struct bpf_link *bpf_link__open(const char *path);
 379 LIBBPF_API int bpf_link__fd(const struct bpf_link *link);
 380 LIBBPF_API const char *bpf_link__pin_path(const struct bpf_link *link);
 381 LIBBPF_API int bpf_link__pin(struct bpf_link *link, const char *path);
 382 LIBBPF_API int bpf_link__unpin(struct bpf_link *link);
 383 LIBBPF_API int bpf_link__update_program(struct bpf_link *link,
 384                                         struct bpf_program *prog);
 385 LIBBPF_API void bpf_link__disconnect(struct bpf_link *link);
 386 LIBBPF_API int bpf_link__detach(struct bpf_link *link);
 387 LIBBPF_API int bpf_link__destroy(struct bpf_link *link);
 388
 389 LIBBPF_API struct bpf_link *
 390 bpf_program__attach(const struct bpf_program *prog);
 391
 392 struct bpf_perf_event_opts {
 393         /* size of this struct, for forward/backward compatiblity */
 394         size_t sz;
 395         /* custom user-provided value fetchable through bpf_get_attach_cookie() */
 396         __u64 bpf_cookie;
 397 };
 398 #define bpf_perf_event_opts__last_field bpf_cookie
 399
 400 LIBBPF_API struct bpf_link *
 401 bpf_program__attach_perf_event(const struct bpf_program *prog, int pfd);
 402
 403 LIBBPF_API struct bpf_link *
 404 bpf_program__attach_perf_event_opts(const struct bpf_program *prog, int pfd,
 405                                     const struct bpf_perf_event_opts *opts);
 406
 407 struct bpf_kprobe_opts {
 408         /* size of this struct, for forward/backward compatiblity */
 409         size_t sz;
 410         /* custom user-provided value fetchable through bpf_get_attach_cookie() */
 411         __u64 bpf_cookie;
 412         /* function's offset to install kprobe to */
 413         size_t offset;
 414         /* kprobe is return probe */
 415         bool retprobe;
 416         size_t :0;
 417 };
 418 #define bpf_kprobe_opts__last_field retprobe
 419
 420 LIBBPF_API struct bpf_link *
 421 bpf_program__attach_kprobe(const struct bpf_program *prog, bool retprobe,
 422                            const char *func_name);
 423 LIBBPF_API struct bpf_link *
 424 bpf_program__attach_kprobe_opts(const struct bpf_program *prog,
 425                                 const char *func_name,
 426                                 const struct bpf_kprobe_opts *opts);
 427
 428 struct bpf_uprobe_opts {
 429         /* size of this struct, for forward/backward compatiblity */
 430         size_t sz;
 431         /* offset of kernel reference counted USDT semaphore, added in
 432          * a6ca88b241d5 ("trace_uprobe: support reference counter in fd-based uprobe")
 433          */
 434         size_t ref_ctr_offset;
 435         /* custom user-provided value fetchable through bpf_get_attach_cookie() */
 436         __u64 bpf_cookie;
 437         /* uprobe is return probe, invoked at function return time */
 438         bool retprobe;
 439         size_t :0;
 440 };
 441 #define bpf_uprobe_opts__last_field retprobe
 442
 443 /**
 444  * @brief **bpf_program__attach_uprobe()** attaches a BPF program
 445  * to the userspace function which is found by binary path and
 446  * offset. You can optionally specify a particular proccess to attach
 447  * to. You can also optionally attach the program to the function
 448  * exit instead of entry.
 449  *
 450  * @param prog BPF program to attach
 451  * @param retprobe Attach to function exit
 452  * @param pid Process ID to attach the uprobe to, 0 for self (own process),
 453  * -1 for all processes
 454  * @param binary_path Path to binary that contains the function symbol
 455  * @param func_offset Offset within the binary of the function symbol
 456  * @return Reference to the newly created BPF link; or NULL is returned on error,
 457  * error code is stored in errno
 458  */
 459 LIBBPF_API struct bpf_link *
 460 bpf_program__attach_uprobe(const struct bpf_program *prog, bool retprobe,
 461                            pid_t pid, const char *binary_path,
 462                            size_t func_offset);
 463
 464 /**
 465  * @brief **bpf_program__attach_uprobe_opts()** is just like
 466  * bpf_program__attach_uprobe() except with a options struct
 467  * for various configurations.
 468  *
 469  * @param prog BPF program to attach
 470  * @param pid Process ID to attach the uprobe to, 0 for self (own process),
 471  * -1 for all processes
 472  * @param binary_path Path to binary that contains the function symbol
 473  * @param func_offset Offset within the binary of the function symbol
 474  * @param opts Options for altering program attachment
 475  * @return Reference to the newly created BPF link; or NULL is returned on error,
 476  * error code is stored in errno
 477  */
 478 LIBBPF_API struct bpf_link *
 479 bpf_program__attach_uprobe_opts(const struct bpf_program *prog, pid_t pid,
 480                                 const char *binary_path, size_t func_offset,
 481                                 const struct bpf_uprobe_opts *opts);
 482
 483 struct bpf_tracepoint_opts {
 484         /* size of this struct, for forward/backward compatiblity */
 485         size_t sz;
 486         /* custom user-provided value fetchable through bpf_get_attach_cookie() */
 487         __u64 bpf_cookie;
 488 };
 489 #define bpf_tracepoint_opts__last_field bpf_cookie
 490
 491 LIBBPF_API struct bpf_link *
 492 bpf_program__attach_tracepoint(const struct bpf_program *prog,
 493                                const char *tp_category,
 494                                const char *tp_name);
 495 LIBBPF_API struct bpf_link *
 496 bpf_program__attach_tracepoint_opts(const struct bpf_program *prog,
 497                                     const char *tp_category,
 498                                     const char *tp_name,
 499                                     const struct bpf_tracepoint_opts *opts);
 500
 501 LIBBPF_API struct bpf_link *
 502 bpf_program__attach_raw_tracepoint(const struct bpf_program *prog,
 503                                    const char *tp_name);
 504 LIBBPF_API struct bpf_link *
 505 bpf_program__attach_trace(const struct bpf_program *prog);
 506 LIBBPF_API struct bpf_link *
 507 bpf_program__attach_lsm(const struct bpf_program *prog);
 508 LIBBPF_API struct bpf_link *
 509 bpf_program__attach_cgroup(const struct bpf_program *prog, int cgroup_fd);
 510 LIBBPF_API struct bpf_link *
 511 bpf_program__attach_netns(const struct bpf_program *prog, int netns_fd);
 512 LIBBPF_API struct bpf_link *
 513 bpf_program__attach_xdp(const struct bpf_program *prog, int ifindex);
 514 LIBBPF_API struct bpf_link *
 515 bpf_program__attach_freplace(const struct bpf_program *prog,
 516                              int target_fd, const char *attach_func_name);
 517
 518 struct bpf_map;
 519
 520 LIBBPF_API struct bpf_link *bpf_map__attach_struct_ops(const struct bpf_map *map);
 521
 522 struct bpf_iter_attach_opts {
 523         size_t sz; /* size of this struct for forward/backward compatibility */
 524         union bpf_iter_link_info *link_info;
 525         __u32 link_info_len;
 526 };
 527 #define bpf_iter_attach_opts__last_field link_info_len
 528
 529 LIBBPF_API struct bpf_link *
 530 bpf_program__attach_iter(const struct bpf_program *prog,
 531                          const struct bpf_iter_attach_opts *opts);
 532
 533 /*
 534  * Libbpf allows callers to adjust BPF programs before being loaded
 535  * into kernel. One program in an object file can be transformed into
 536  * multiple variants to be attached to different hooks.
 537  *
 538  * bpf_program_prep_t, bpf_program__set_prep and bpf_program__nth_fd
 539  * form an API for this purpose.
 540  *
 541  * - bpf_program_prep_t:
 542  *   Defines a 'preprocessor', which is a caller defined function
 543  *   passed to libbpf through bpf_program__set_prep(), and will be
 544  *   called before program is loaded. The processor should adjust
 545  *   the program one time for each instance according to the instance id
 546  *   passed to it.
 547  *
 548  * - bpf_program__set_prep:
 549  *   Attaches a preprocessor to a BPF program. The number of instances
 550  *   that should be created is also passed through this function.
 551  *
 552  * - bpf_program__nth_fd:
 553  *   After the program is loaded, get resulting FD of a given instance
 554  *   of the BPF program.
 555  *
 556  * If bpf_program__set_prep() is not used, the program would be loaded
 557  * without adjustment during bpf_object__load(). The program has only
 558  * one instance. In this case bpf_program__fd(prog) is equal to
 559  * bpf_program__nth_fd(prog, 0).
 560  */
 561 struct bpf_prog_prep_result {
 562         /*
 563          * If not NULL, load new instruction array.
 564          * If set to NULL, don't load this instance.
 565          */
 566         struct bpf_insn *new_insn_ptr;
 567         int new_insn_cnt;
 568
 569         /* If not NULL, result FD is written to it. */
 570         int *pfd;
 571 };
 572
 573 /*
 574  * Parameters of bpf_program_prep_t:
 575  *  - prog:     The bpf_program being loaded.
 576  *  - n:        Index of instance being generated.
 577  *  - insns:    BPF instructions array.
 578  *  - insns_cnt:Number of instructions in insns.
 579  *  - res:      Output parameter, result of transformation.
 580  *
 581  * Return value:
 582  *  - Zero:     pre-processing success.
 583  *  - Non-zero: pre-processing error, stop loading.
 584  */
 585 typedef int (*bpf_program_prep_t)(struct bpf_program *prog, int n,
 586                                   struct bpf_insn *insns, int insns_cnt,
 587                                   struct bpf_prog_prep_result *res);
 588
 589 LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_program__insns() for getting bpf_program instructions")
 590 LIBBPF_API int bpf_program__set_prep(struct bpf_program *prog, int nr_instance,
 591                                      bpf_program_prep_t prep);
 592
 593 LIBBPF_DEPRECATED_SINCE(0, 7, "multi-instance bpf_program support is deprecated")
 594 LIBBPF_API int bpf_program__nth_fd(const struct bpf_program *prog, int n);
 595
 596 /*
 597  * Adjust type of BPF program. Default is kprobe.
 598  */
 599 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 600 LIBBPF_API int bpf_program__set_socket_filter(struct bpf_program *prog);
 601 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 602 LIBBPF_API int bpf_program__set_tracepoint(struct bpf_program *prog);
 603 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 604 LIBBPF_API int bpf_program__set_raw_tracepoint(struct bpf_program *prog);
 605 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 606 LIBBPF_API int bpf_program__set_kprobe(struct bpf_program *prog);
 607 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 608 LIBBPF_API int bpf_program__set_lsm(struct bpf_program *prog);
 609 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 610 LIBBPF_API int bpf_program__set_sched_cls(struct bpf_program *prog);
 611 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 612 LIBBPF_API int bpf_program__set_sched_act(struct bpf_program *prog);
 613 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 614 LIBBPF_API int bpf_program__set_xdp(struct bpf_program *prog);
 615 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 616 LIBBPF_API int bpf_program__set_perf_event(struct bpf_program *prog);
 617 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 618 LIBBPF_API int bpf_program__set_tracing(struct bpf_program *prog);
 619 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 620 LIBBPF_API int bpf_program__set_struct_ops(struct bpf_program *prog);
 621 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 622 LIBBPF_API int bpf_program__set_extension(struct bpf_program *prog);
 623 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__set_type() instead")
 624 LIBBPF_API int bpf_program__set_sk_lookup(struct bpf_program *prog);
 625
 626 LIBBPF_API enum bpf_prog_type bpf_program__type(const struct bpf_program *prog);
 627 LIBBPF_API void bpf_program__set_type(struct bpf_program *prog,
 628                                       enum bpf_prog_type type);
 629
 630 LIBBPF_API enum bpf_attach_type
 631 bpf_program__expected_attach_type(const struct bpf_program *prog);
 632 LIBBPF_API void
 633 bpf_program__set_expected_attach_type(struct bpf_program *prog,
 634                                       enum bpf_attach_type type);
 635
 636 LIBBPF_API __u32 bpf_program__flags(const struct bpf_program *prog);
 637 LIBBPF_API int bpf_program__set_flags(struct bpf_program *prog, __u32 flags);
 638
 639 /* Per-program log level and log buffer getters/setters.
 640  * See bpf_object_open_opts comments regarding log_level and log_buf
 641  * interactions.
 642  */
 643 LIBBPF_API __u32 bpf_program__log_level(const struct bpf_program *prog);
 644 LIBBPF_API int bpf_program__set_log_level(struct bpf_program *prog, __u32 log_level);
 645 LIBBPF_API const char *bpf_program__log_buf(const struct bpf_program *prog, size_t *log_size);
 646 LIBBPF_API int bpf_program__set_log_buf(struct bpf_program *prog, char *log_buf, size_t log_size);
 647
 648 LIBBPF_API int
 649 bpf_program__set_attach_target(struct bpf_program *prog, int attach_prog_fd,
 650                                const char *attach_func_name);
 651
 652 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 653 LIBBPF_API bool bpf_program__is_socket_filter(const struct bpf_program *prog);
 654 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 655 LIBBPF_API bool bpf_program__is_tracepoint(const struct bpf_program *prog);
 656 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 657 LIBBPF_API bool bpf_program__is_raw_tracepoint(const struct bpf_program *prog);
 658 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 659 LIBBPF_API bool bpf_program__is_kprobe(const struct bpf_program *prog);
 660 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 661 LIBBPF_API bool bpf_program__is_lsm(const struct bpf_program *prog);
 662 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 663 LIBBPF_API bool bpf_program__is_sched_cls(const struct bpf_program *prog);
 664 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 665 LIBBPF_API bool bpf_program__is_sched_act(const struct bpf_program *prog);
 666 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 667 LIBBPF_API bool bpf_program__is_xdp(const struct bpf_program *prog);
 668 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 669 LIBBPF_API bool bpf_program__is_perf_event(const struct bpf_program *prog);
 670 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 671 LIBBPF_API bool bpf_program__is_tracing(const struct bpf_program *prog);
 672 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 673 LIBBPF_API bool bpf_program__is_struct_ops(const struct bpf_program *prog);
 674 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 675 LIBBPF_API bool bpf_program__is_extension(const struct bpf_program *prog);
 676 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_program__type() instead")
 677 LIBBPF_API bool bpf_program__is_sk_lookup(const struct bpf_program *prog);
 678
 679 /*
 680  * No need for __attribute__((packed)), all members of 'bpf_map_def'
 681  * are all aligned.  In addition, using __attribute__((packed))
 682  * would trigger a -Wpacked warning message, and lead to an error
 683  * if -Werror is set.
 684  */
 685 struct bpf_map_def {
 686         unsigned int type;
 687         unsigned int key_size;
 688         unsigned int value_size;
 689         unsigned int max_entries;
 690         unsigned int map_flags;
 691 };
 692
 693 /**
 694  * @brief **bpf_object__find_map_by_name()** returns BPF map of
 695  * the given name, if it exists within the passed BPF object
 696  * @param obj BPF object
 697  * @param name name of the BPF map
 698  * @return BPF map instance, if such map exists within the BPF object;
 699  * or NULL otherwise.
 700  */
 701 LIBBPF_API struct bpf_map *
 702 bpf_object__find_map_by_name(const struct bpf_object *obj, const char *name);
 703
 704 LIBBPF_API int
 705 bpf_object__find_map_fd_by_name(const struct bpf_object *obj, const char *name);
 706
 707 /*
 708  * Get bpf_map through the offset of corresponding struct bpf_map_def
 709  * in the BPF object file.
 710  */
 711 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_object__find_map_by_name() instead")
 712 struct bpf_map *
 713 bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset);
 714
 715 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__next_map() instead")
 716 struct bpf_map *bpf_map__next(const struct bpf_map *map, const struct bpf_object *obj);
 717 LIBBPF_API struct bpf_map *
 718 bpf_object__next_map(const struct bpf_object *obj, const struct bpf_map *map);
 719
 720 #define bpf_object__for_each_map(pos, obj)              \
 721         for ((pos) = bpf_object__next_map((obj), NULL); \
 722              (pos) != NULL;                             \
 723              (pos) = bpf_object__next_map((obj), (pos)))
 724 #define bpf_map__for_each bpf_object__for_each_map
 725
 726 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__prev_map() instead")
 727 struct bpf_map *bpf_map__prev(const struct bpf_map *map, const struct bpf_object *obj);
 728 LIBBPF_API struct bpf_map *
 729 bpf_object__prev_map(const struct bpf_object *obj, const struct bpf_map *map);
 730
 731 /**
 732  * @brief **bpf_map__fd()** gets the file descriptor of the passed
 733  * BPF map
 734  * @param map the BPF map instance
 735  * @return the file descriptor; or -EINVAL in case of an error
 736  */
 737 LIBBPF_API int bpf_map__fd(const struct bpf_map *map);
 738 LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd);
 739 /* get map definition */
 740 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 8, "use appropriate getters or setters instead")
 741 const struct bpf_map_def *bpf_map__def(const struct bpf_map *map);
 742 /* get map name */
 743 LIBBPF_API const char *bpf_map__name(const struct bpf_map *map);
 744 /* get/set map type */
 745 LIBBPF_API enum bpf_map_type bpf_map__type(const struct bpf_map *map);
 746 LIBBPF_API int bpf_map__set_type(struct bpf_map *map, enum bpf_map_type type);
 747 /* get/set map size (max_entries) */
 748 LIBBPF_API __u32 bpf_map__max_entries(const struct bpf_map *map);
 749 LIBBPF_API int bpf_map__set_max_entries(struct bpf_map *map, __u32 max_entries);
 750 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_map__set_max_entries() instead")
 751 LIBBPF_API int bpf_map__resize(struct bpf_map *map, __u32 max_entries);
 752 /* get/set map flags */
 753 LIBBPF_API __u32 bpf_map__map_flags(const struct bpf_map *map);
 754 LIBBPF_API int bpf_map__set_map_flags(struct bpf_map *map, __u32 flags);
 755 /* get/set map NUMA node */
 756 LIBBPF_API __u32 bpf_map__numa_node(const struct bpf_map *map);
 757 LIBBPF_API int bpf_map__set_numa_node(struct bpf_map *map, __u32 numa_node);
 758 /* get/set map key size */
 759 LIBBPF_API __u32 bpf_map__key_size(const struct bpf_map *map);
 760 LIBBPF_API int bpf_map__set_key_size(struct bpf_map *map, __u32 size);
 761 /* get/set map value size */
 762 LIBBPF_API __u32 bpf_map__value_size(const struct bpf_map *map);
 763 LIBBPF_API int bpf_map__set_value_size(struct bpf_map *map, __u32 size);
 764 /* get map key/value BTF type IDs */
 765 LIBBPF_API __u32 bpf_map__btf_key_type_id(const struct bpf_map *map);
 766 LIBBPF_API __u32 bpf_map__btf_value_type_id(const struct bpf_map *map);
 767 /* get/set map if_index */
 768 LIBBPF_API __u32 bpf_map__ifindex(const struct bpf_map *map);
 769 LIBBPF_API int bpf_map__set_ifindex(struct bpf_map *map, __u32 ifindex);
 770 /* get/set map map_extra flags */
 771 LIBBPF_API __u64 bpf_map__map_extra(const struct bpf_map *map);
 772 LIBBPF_API int bpf_map__set_map_extra(struct bpf_map *map, __u64 map_extra);
 773
 774 typedef void (*bpf_map_clear_priv_t)(struct bpf_map *, void *);
 775 LIBBPF_DEPRECATED_SINCE(0, 7, "storage via set_priv/priv is deprecated")
 776 LIBBPF_API int bpf_map__set_priv(struct bpf_map *map, void *priv,
 777                                  bpf_map_clear_priv_t clear_priv);
 778 LIBBPF_DEPRECATED_SINCE(0, 7, "storage via set_priv/priv is deprecated")
 779 LIBBPF_API void *bpf_map__priv(const struct bpf_map *map);
 780 LIBBPF_API int bpf_map__set_initial_value(struct bpf_map *map,
 781                                           const void *data, size_t size);
 782 LIBBPF_API const void *bpf_map__initial_value(struct bpf_map *map, size_t *psize);
 783 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_map__type() instead")
 784 LIBBPF_API bool bpf_map__is_offload_neutral(const struct bpf_map *map);
 785
 786 /**
 787  * @brief **bpf_map__is_internal()** tells the caller whether or not the
 788  * passed map is a special map created by libbpf automatically for things like
 789  * global variables, __ksym externs, Kconfig values, etc
 790  * @param map the bpf_map
 791  * @return true, if the map is an internal map; false, otherwise
 792  */
 793 LIBBPF_API bool bpf_map__is_internal(const struct bpf_map *map);
 794 LIBBPF_API int bpf_map__set_pin_path(struct bpf_map *map, const char *path);
 795 LIBBPF_API const char *bpf_map__pin_path(const struct bpf_map *map);
 796 LIBBPF_API bool bpf_map__is_pinned(const struct bpf_map *map);
 797 LIBBPF_API int bpf_map__pin(struct bpf_map *map, const char *path);
 798 LIBBPF_API int bpf_map__unpin(struct bpf_map *map, const char *path);
 799
 800 LIBBPF_API int bpf_map__set_inner_map_fd(struct bpf_map *map, int fd);
 801 LIBBPF_API struct bpf_map *bpf_map__inner_map(struct bpf_map *map);
 802
 803 /**
 804  * @brief **libbpf_get_error()** extracts the error code from the passed
 805  * pointer
 806  * @param ptr pointer returned from libbpf API function
 807  * @return error code; or 0 if no error occured
 808  *
 809  * Many libbpf API functions which return pointers have logic to encode error
 810  * codes as pointers, and do not return NULL. Meaning **libbpf_get_error()**
 811  * should be used on the return value from these functions immediately after
 812  * calling the API function, with no intervening calls that could clobber the
 813  * `errno` variable. Consult the individual functions documentation to verify
 814  * if this logic applies should be used.
 815  *
 816  * For these API functions, if `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)`
 817  * is enabled, NULL is returned on error instead.
 818  *
 819  * If ptr is NULL, then errno should be already set by the failing
 820  * API, because libbpf never returns NULL on success and it now always
 821  * sets errno on error.
 822  *
 823  * Example usage:
 824  *
 825  *   struct perf_buffer *pb;
 826  *
 827  *   pb = perf_buffer__new(bpf_map__fd(obj->maps.events), PERF_BUFFER_PAGES, &opts);
 828  *   err = libbpf_get_error(pb);
 829  *   if (err) {
 830  *        pb = NULL;
 831  *        fprintf(stderr, "failed to open perf buffer: %d\n", err);
 832  *        goto cleanup;
 833  *   }
 834  */
 835 LIBBPF_API long libbpf_get_error(const void *ptr);
 836
 837 struct bpf_prog_load_attr {
 838         const char *file;
 839         enum bpf_prog_type prog_type;
 840         enum bpf_attach_type expected_attach_type;
 841         int ifindex;
 842         int log_level;
 843         int prog_flags;
 844 };
 845
 846 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_object__open() and bpf_object__load() instead")
 847 LIBBPF_API int bpf_prog_load_xattr(const struct bpf_prog_load_attr *attr,
 848                                    struct bpf_object **pobj, int *prog_fd);
 849 LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_object__open() and bpf_object__load() instead")
 850 LIBBPF_API int bpf_prog_load_deprecated(const char *file, enum bpf_prog_type type,
 851                                         struct bpf_object **pobj, int *prog_fd);
 852
 853 /* XDP related API */
 854 struct xdp_link_info {
 855         __u32 prog_id;
 856         __u32 drv_prog_id;
 857         __u32 hw_prog_id;
 858         __u32 skb_prog_id;
 859         __u8 attach_mode;
 860 };
 861
 862 struct bpf_xdp_set_link_opts {
 863         size_t sz;
 864         int old_fd;
 865         size_t :0;
 866 };
 867 #define bpf_xdp_set_link_opts__last_field old_fd
 868
 869 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_xdp_attach() instead")
 870 LIBBPF_API int bpf_set_link_xdp_fd(int ifindex, int fd, __u32 flags);
 871 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_xdp_attach() instead")
 872 LIBBPF_API int bpf_set_link_xdp_fd_opts(int ifindex, int fd, __u32 flags,
 873                                         const struct bpf_xdp_set_link_opts *opts);
 874 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_xdp_query_id() instead")
 875 LIBBPF_API int bpf_get_link_xdp_id(int ifindex, __u32 *prog_id, __u32 flags);
 876 LIBBPF_DEPRECATED_SINCE(0, 8, "use bpf_xdp_query() instead")
 877 LIBBPF_API int bpf_get_link_xdp_info(int ifindex, struct xdp_link_info *info,
 878                                      size_t info_size, __u32 flags);
 879
 880 struct bpf_xdp_attach_opts {
 881         size_t sz;
 882         int old_prog_fd;
 883         size_t :0;
 884 };
 885 #define bpf_xdp_attach_opts__last_field old_prog_fd
 886
 887 struct bpf_xdp_query_opts {
 888         size_t sz;
 889         __u32 prog_id;          /* output */
 890         __u32 drv_prog_id;      /* output */
 891         __u32 hw_prog_id;       /* output */
 892         __u32 skb_prog_id;      /* output */
 893         __u8 attach_mode;       /* output */
 894         size_t :0;
 895 };
 896 #define bpf_xdp_query_opts__last_field attach_mode
 897
 898 LIBBPF_API int bpf_xdp_attach(int ifindex, int prog_fd, __u32 flags,
 899                               const struct bpf_xdp_attach_opts *opts);
 900 LIBBPF_API int bpf_xdp_detach(int ifindex, __u32 flags,
 901                               const struct bpf_xdp_attach_opts *opts);
 902 LIBBPF_API int bpf_xdp_query(int ifindex, int flags, struct bpf_xdp_query_opts *opts);
 903 LIBBPF_API int bpf_xdp_query_id(int ifindex, int flags, __u32 *prog_id);
 904
 905 /* TC related API */
 906 enum bpf_tc_attach_point {
 907         BPF_TC_INGRESS = 1 << 0,
 908         BPF_TC_EGRESS  = 1 << 1,
 909         BPF_TC_CUSTOM  = 1 << 2,
 910 };
 911
 912 #define BPF_TC_PARENT(a, b)     \
 913         ((((a) << 16) & 0xFFFF0000U) | ((b) & 0x0000FFFFU))
 914
 915 enum bpf_tc_flags {
 916         BPF_TC_F_REPLACE = 1 << 0,
 917 };
 918
 919 struct bpf_tc_hook {
 920         size_t sz;
 921         int ifindex;
 922         enum bpf_tc_attach_point attach_point;
 923         __u32 parent;
 924         size_t :0;
 925 };
 926 #define bpf_tc_hook__last_field parent
 927
 928 struct bpf_tc_opts {
 929         size_t sz;
 930         int prog_fd;
 931         __u32 flags;
 932         __u32 prog_id;
 933         __u32 handle;
 934         __u32 priority;
 935         size_t :0;
 936 };
 937 #define bpf_tc_opts__last_field priority
 938
 939 LIBBPF_API int bpf_tc_hook_create(struct bpf_tc_hook *hook);
 940 LIBBPF_API int bpf_tc_hook_destroy(struct bpf_tc_hook *hook);
 941 LIBBPF_API int bpf_tc_attach(const struct bpf_tc_hook *hook,
 942                              struct bpf_tc_opts *opts);
 943 LIBBPF_API int bpf_tc_detach(const struct bpf_tc_hook *hook,
 944                              const struct bpf_tc_opts *opts);
 945 LIBBPF_API int bpf_tc_query(const struct bpf_tc_hook *hook,
 946                             struct bpf_tc_opts *opts);
 947
 948 /* Ring buffer APIs */
 949 struct ring_buffer;
 950
 951 typedef int (*ring_buffer_sample_fn)(void *ctx, void *data, size_t size);
 952
 953 struct ring_buffer_opts {
 954         size_t sz; /* size of this struct, for forward/backward compatiblity */
 955 };
 956
 957 #define ring_buffer_opts__last_field sz
 958
 959 LIBBPF_API struct ring_buffer *
 960 ring_buffer__new(int map_fd, ring_buffer_sample_fn sample_cb, void *ctx,
 961                  const struct ring_buffer_opts *opts);
 962 LIBBPF_API void ring_buffer__free(struct ring_buffer *rb);
 963 LIBBPF_API int ring_buffer__add(struct ring_buffer *rb, int map_fd,
 964                                 ring_buffer_sample_fn sample_cb, void *ctx);
 965 LIBBPF_API int ring_buffer__poll(struct ring_buffer *rb, int timeout_ms);
 966 LIBBPF_API int ring_buffer__consume(struct ring_buffer *rb);
 967 LIBBPF_API int ring_buffer__epoll_fd(const struct ring_buffer *rb);
 968
 969 /* Perf buffer APIs */
 970 struct perf_buffer;
 971
 972 typedef void (*perf_buffer_sample_fn)(void *ctx, int cpu,
 973                                       void *data, __u32 size);
 974 typedef void (*perf_buffer_lost_fn)(void *ctx, int cpu, __u64 cnt);
 975
 976 /* common use perf buffer options */
 977 struct perf_buffer_opts {
 978         union {
 979                 size_t sz;
 980                 struct { /* DEPRECATED: will be removed in v1.0 */
 981                         /* if specified, sample_cb is called for each sample */
 982                         perf_buffer_sample_fn sample_cb;
 983                         /* if specified, lost_cb is called for each batch of lost samples */
 984                         perf_buffer_lost_fn lost_cb;
 985                         /* ctx is provided to sample_cb and lost_cb */
 986                         void *ctx;
 987                 };
 988         };
 989 };
 990 #define perf_buffer_opts__last_field sz
 991
 992 /**
 993  * @brief **perf_buffer__new()** creates BPF perfbuf manager for a specified
 994  * BPF_PERF_EVENT_ARRAY map
 995  * @param map_fd FD of BPF_PERF_EVENT_ARRAY BPF map that will be used by BPF
 996  * code to send data over to user-space
 997  * @param page_cnt number of memory pages allocated for each per-CPU buffer
 998  * @param sample_cb function called on each received data record
 999  * @param lost_cb function called when record loss has occurred
1000  * @param ctx user-provided extra context passed into *sample_cb* and *lost_cb*
1001  * @return a new instance of struct perf_buffer on success, NULL on error with
1002  * *errno* containing an error code
1003  */
1004 LIBBPF_API struct perf_buffer *
1005 perf_buffer__new(int map_fd, size_t page_cnt,
1006                  perf_buffer_sample_fn sample_cb, perf_buffer_lost_fn lost_cb, void *ctx,
1007                  const struct perf_buffer_opts *opts);
1008
1009 LIBBPF_API struct perf_buffer *
1010 perf_buffer__new_v0_6_0(int map_fd, size_t page_cnt,
1011                         perf_buffer_sample_fn sample_cb, perf_buffer_lost_fn lost_cb, void *ctx,
1012                         const struct perf_buffer_opts *opts);
1013
1014 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "use new variant of perf_buffer__new() instead")
1015 struct perf_buffer *perf_buffer__new_deprecated(int map_fd, size_t page_cnt,
1016                                                 const struct perf_buffer_opts *opts);
1017
1018 #define perf_buffer__new(...) ___libbpf_overload(___perf_buffer_new, __VA_ARGS__)
1019 #define ___perf_buffer_new6(map_fd, page_cnt, sample_cb, lost_cb, ctx, opts) \
1020         perf_buffer__new(map_fd, page_cnt, sample_cb, lost_cb, ctx, opts)
1021 #define ___perf_buffer_new3(map_fd, page_cnt, opts) \
1022         perf_buffer__new_deprecated(map_fd, page_cnt, opts)
1023
1024 enum bpf_perf_event_ret {
1025         LIBBPF_PERF_EVENT_DONE  = 0,
1026         LIBBPF_PERF_EVENT_ERROR = -1,
1027         LIBBPF_PERF_EVENT_CONT  = -2,
1028 };
1029
1030 struct perf_event_header;
1031
1032 typedef enum bpf_perf_event_ret
1033 (*perf_buffer_event_fn)(void *ctx, int cpu, struct perf_event_header *event);
1034
1035 /* raw perf buffer options, giving most power and control */
1036 struct perf_buffer_raw_opts {
1037         union {
1038                 struct {
1039                         size_t sz;
1040                         long :0;
1041                         long :0;
1042                 };
1043                 struct { /* DEPRECATED: will be removed in v1.0 */
1044                         /* perf event attrs passed directly into perf_event_open() */
1045                         struct perf_event_attr *attr;
1046                         /* raw event callback */
1047                         perf_buffer_event_fn event_cb;
1048                         /* ctx is provided to event_cb */
1049                         void *ctx;
1050                 };
1051         };
1052         /* if cpu_cnt == 0, open all on all possible CPUs (up to the number of
1053          * max_entries of given PERF_EVENT_ARRAY map)
1054          */
1055         int cpu_cnt;
1056         /* if cpu_cnt > 0, cpus is an array of CPUs to open ring buffers on */
1057         int *cpus;
1058         /* if cpu_cnt > 0, map_keys specify map keys to set per-CPU FDs for */
1059         int *map_keys;
1060 };
1061 #define perf_buffer_raw_opts__last_field map_keys
1062
1063 LIBBPF_API struct perf_buffer *
1064 perf_buffer__new_raw(int map_fd, size_t page_cnt, struct perf_event_attr *attr,
1065                      perf_buffer_event_fn event_cb, void *ctx,
1066                      const struct perf_buffer_raw_opts *opts);
1067
1068 LIBBPF_API struct perf_buffer *
1069 perf_buffer__new_raw_v0_6_0(int map_fd, size_t page_cnt, struct perf_event_attr *attr,
1070                             perf_buffer_event_fn event_cb, void *ctx,
1071                             const struct perf_buffer_raw_opts *opts);
1072
1073 LIBBPF_API LIBBPF_DEPRECATED_SINCE(0, 7, "use new variant of perf_buffer__new_raw() instead")
1074 struct perf_buffer *perf_buffer__new_raw_deprecated(int map_fd, size_t page_cnt,
1075                                                     const struct perf_buffer_raw_opts *opts);
1076
1077 #define perf_buffer__new_raw(...) ___libbpf_overload(___perf_buffer_new_raw, __VA_ARGS__)
1078 #define ___perf_buffer_new_raw6(map_fd, page_cnt, attr, event_cb, ctx, opts) \
1079         perf_buffer__new_raw(map_fd, page_cnt, attr, event_cb, ctx, opts)
1080 #define ___perf_buffer_new_raw3(map_fd, page_cnt, opts) \
1081         perf_buffer__new_raw_deprecated(map_fd, page_cnt, opts)
1082
1083 LIBBPF_API void perf_buffer__free(struct perf_buffer *pb);
1084 LIBBPF_API int perf_buffer__epoll_fd(const struct perf_buffer *pb);
1085 LIBBPF_API int perf_buffer__poll(struct perf_buffer *pb, int timeout_ms);
1086 LIBBPF_API int perf_buffer__consume(struct perf_buffer *pb);
1087 LIBBPF_API int perf_buffer__consume_buffer(struct perf_buffer *pb, size_t buf_idx);
1088 LIBBPF_API size_t perf_buffer__buffer_cnt(const struct perf_buffer *pb);
1089 LIBBPF_API int perf_buffer__buffer_fd(const struct perf_buffer *pb, size_t buf_idx);
1090
1091 typedef enum bpf_perf_event_ret
1092         (*bpf_perf_event_print_t)(struct perf_event_header *hdr,
1093                                   void *private_data);
1094 LIBBPF_DEPRECATED_SINCE(0, 8, "use perf_buffer__poll() or  perf_buffer__consume() instead")
1095 LIBBPF_API enum bpf_perf_event_ret
1096 bpf_perf_event_read_simple(void *mmap_mem, size_t mmap_size, size_t page_size,
1097                            void **copy_mem, size_t *copy_size,
1098                            bpf_perf_event_print_t fn, void *private_data);
1099
1100 struct bpf_prog_linfo;
1101 struct bpf_prog_info;
1102
1103 LIBBPF_API void bpf_prog_linfo__free(struct bpf_prog_linfo *prog_linfo);
1104 LIBBPF_API struct bpf_prog_linfo *
1105 bpf_prog_linfo__new(const struct bpf_prog_info *info);
1106 LIBBPF_API const struct bpf_line_info *
1107 bpf_prog_linfo__lfind_addr_func(const struct bpf_prog_linfo *prog_linfo,
1108                                 __u64 addr, __u32 func_idx, __u32 nr_skip);
1109 LIBBPF_API const struct bpf_line_info *
1110 bpf_prog_linfo__lfind(const struct bpf_prog_linfo *prog_linfo,
1111                       __u32 insn_off, __u32 nr_skip);
1112
1113 /*
1114  * Probe for supported system features
1115  *
1116  * Note that running many of these probes in a short amount of time can cause
1117  * the kernel to reach the maximal size of lockable memory allowed for the
1118  * user, causing subsequent probes to fail. In this case, the caller may want
1119  * to adjust that limit with setrlimit().
1120  */
1121 LIBBPF_DEPRECATED_SINCE(0, 8, "use libbpf_probe_bpf_prog_type() instead")
1122 LIBBPF_API bool bpf_probe_prog_type(enum bpf_prog_type prog_type, __u32 ifindex);
1123 LIBBPF_DEPRECATED_SINCE(0, 8, "use libbpf_probe_bpf_map_type() instead")
1124 LIBBPF_API bool bpf_probe_map_type(enum bpf_map_type map_type, __u32 ifindex);
1125 LIBBPF_DEPRECATED_SINCE(0, 8, "use libbpf_probe_bpf_helper() instead")
1126 LIBBPF_API bool bpf_probe_helper(enum bpf_func_id id, enum bpf_prog_type prog_type, __u32 ifindex);
1127 LIBBPF_DEPRECATED_SINCE(0, 8, "implement your own or use bpftool for feature detection")
1128 LIBBPF_API bool bpf_probe_large_insn_limit(__u32 ifindex);
1129
1130 /**
1131  * @brief **libbpf_probe_bpf_prog_type()** detects if host kernel supports
1132  * BPF programs of a given type.
1133  * @param prog_type BPF program type to detect kernel support for
1134  * @param opts reserved for future extensibility, should be NULL
1135  * @return 1, if given program type is supported; 0, if given program type is
1136  * not supported; negative error code if feature detection failed or can't be
1137  * performed
1138  *
1139  * Make sure the process has required set of CAP_* permissions (or runs as
1140  * root) when performing feature checking.
1141  */
1142 LIBBPF_API int libbpf_probe_bpf_prog_type(enum bpf_prog_type prog_type, const void *opts);
1143 /**
1144  * @brief **libbpf_probe_bpf_map_type()** detects if host kernel supports
1145  * BPF maps of a given type.
1146  * @param map_type BPF map type to detect kernel support for
1147  * @param opts reserved for future extensibility, should be NULL
1148  * @return 1, if given map type is supported; 0, if given map type is
1149  * not supported; negative error code if feature detection failed or can't be
1150  * performed
1151  *
1152  * Make sure the process has required set of CAP_* permissions (or runs as
1153  * root) when performing feature checking.
1154  */
1155 LIBBPF_API int libbpf_probe_bpf_map_type(enum bpf_map_type map_type, const void *opts);
1156 /**
1157  * @brief **libbpf_probe_bpf_helper()** detects if host kernel supports the
1158  * use of a given BPF helper from specified BPF program type.
1159  * @param prog_type BPF program type used to check the support of BPF helper
1160  * @param helper_id BPF helper ID (enum bpf_func_id) to check support for
1161  * @param opts reserved for future extensibility, should be NULL
1162  * @return 1, if given combination of program type and helper is supported; 0,
1163  * if the combination is not supported; negative error code if feature
1164  * detection for provided input arguments failed or can't be performed
1165  *
1166  * Make sure the process has required set of CAP_* permissions (or runs as
1167  * root) when performing feature checking.
1168  */
1169 LIBBPF_API int libbpf_probe_bpf_helper(enum bpf_prog_type prog_type,
1170                                        enum bpf_func_id helper_id, const void *opts);
1171
1172 /*
1173  * Get bpf_prog_info in continuous memory
1174  *
1175  * struct bpf_prog_info has multiple arrays. The user has option to choose
1176  * arrays to fetch from kernel. The following APIs provide an uniform way to
1177  * fetch these data. All arrays in bpf_prog_info are stored in a single
1178  * continuous memory region. This makes it easy to store the info in a
1179  * file.
1180  *
1181  * Before writing bpf_prog_info_linear to files, it is necessary to
1182  * translate pointers in bpf_prog_info to offsets. Helper functions
1183  * bpf_program__bpil_addr_to_offs() and bpf_program__bpil_offs_to_addr()
1184  * are introduced to switch between pointers and offsets.
1185  *
1186  * Examples:
1187  *   # To fetch map_ids and prog_tags:
1188  *   __u64 arrays = (1UL << BPF_PROG_INFO_MAP_IDS) |
1189  *           (1UL << BPF_PROG_INFO_PROG_TAGS);
1190  *   struct bpf_prog_info_linear *info_linear =
1191  *           bpf_program__get_prog_info_linear(fd, arrays);
1192  *
1193  *   # To save data in file
1194  *   bpf_program__bpil_addr_to_offs(info_linear);
1195  *   write(f, info_linear, sizeof(*info_linear) + info_linear->data_len);
1196  *
1197  *   # To read data from file
1198  *   read(f, info_linear, <proper_size>);
1199  *   bpf_program__bpil_offs_to_addr(info_linear);
1200  */
1201 enum bpf_prog_info_array {
1202         BPF_PROG_INFO_FIRST_ARRAY = 0,
1203         BPF_PROG_INFO_JITED_INSNS = 0,
1204         BPF_PROG_INFO_XLATED_INSNS,
1205         BPF_PROG_INFO_MAP_IDS,
1206         BPF_PROG_INFO_JITED_KSYMS,
1207         BPF_PROG_INFO_JITED_FUNC_LENS,
1208         BPF_PROG_INFO_FUNC_INFO,
1209         BPF_PROG_INFO_LINE_INFO,
1210         BPF_PROG_INFO_JITED_LINE_INFO,
1211         BPF_PROG_INFO_PROG_TAGS,
1212         BPF_PROG_INFO_LAST_ARRAY,
1213 };
1214
1215 struct bpf_prog_info_linear {
1216         /* size of struct bpf_prog_info, when the tool is compiled */
1217         __u32                   info_len;
1218         /* total bytes allocated for data, round up to 8 bytes */
1219         __u32                   data_len;
1220         /* which arrays are included in data */
1221         __u64                   arrays;
1222         struct bpf_prog_info    info;
1223         __u8                    data[];
1224 };
1225
1226 LIBBPF_DEPRECATED_SINCE(0, 6, "use a custom linear prog_info wrapper")
1227 LIBBPF_API struct bpf_prog_info_linear *
1228 bpf_program__get_prog_info_linear(int fd, __u64 arrays);
1229
1230 LIBBPF_DEPRECATED_SINCE(0, 6, "use a custom linear prog_info wrapper")
1231 LIBBPF_API void
1232 bpf_program__bpil_addr_to_offs(struct bpf_prog_info_linear *info_linear);
1233
1234 LIBBPF_DEPRECATED_SINCE(0, 6, "use a custom linear prog_info wrapper")
1235 LIBBPF_API void
1236 bpf_program__bpil_offs_to_addr(struct bpf_prog_info_linear *info_linear);
1237
1238 /**
1239  * @brief **libbpf_num_possible_cpus()** is a helper function to get the
1240  * number of possible CPUs that the host kernel supports and expects.
1241  * @return number of possible CPUs; or error code on failure
1242  *
1243  * Example usage:
1244  *
1245  *     int ncpus = libbpf_num_possible_cpus();
1246  *     if (ncpus < 0) {
1247  *          // error handling
1248  *     }
1249  *     long values[ncpus];
1250  *     bpf_map_lookup_elem(per_cpu_map_fd, key, values);
1251  */
1252 LIBBPF_API int libbpf_num_possible_cpus(void);
1253
1254 struct bpf_map_skeleton {
1255         const char *name;
1256         struct bpf_map **map;
1257         void **mmaped;
1258 };
1259
1260 struct bpf_prog_skeleton {
1261         const char *name;
1262         struct bpf_program **prog;
1263         struct bpf_link **link;
1264 };
1265
1266 struct bpf_object_skeleton {
1267         size_t sz; /* size of this struct, for forward/backward compatibility */
1268
1269         const char *name;
1270         const void *data;
1271         size_t data_sz;
1272
1273         struct bpf_object **obj;
1274
1275         int map_cnt;
1276         int map_skel_sz; /* sizeof(struct bpf_map_skeleton) */
1277         struct bpf_map_skeleton *maps;
1278
1279         int prog_cnt;
1280         int prog_skel_sz; /* sizeof(struct bpf_prog_skeleton) */
1281         struct bpf_prog_skeleton *progs;
1282 };
1283
1284 LIBBPF_API int
1285 bpf_object__open_skeleton(struct bpf_object_skeleton *s,
1286                           const struct bpf_object_open_opts *opts);
1287 LIBBPF_API int bpf_object__load_skeleton(struct bpf_object_skeleton *s);
1288 LIBBPF_API int bpf_object__attach_skeleton(struct bpf_object_skeleton *s);
1289 LIBBPF_API void bpf_object__detach_skeleton(struct bpf_object_skeleton *s);
1290 LIBBPF_API void bpf_object__destroy_skeleton(struct bpf_object_skeleton *s);
1291
1292 struct gen_loader_opts {
1293         size_t sz; /* size of this struct, for forward/backward compatiblity */
1294         const char *data;
1295         const char *insns;
1296         __u32 data_sz;
1297         __u32 insns_sz;
1298 };
1299
1300 #define gen_loader_opts__last_field insns_sz
1301 LIBBPF_API int bpf_object__gen_loader(struct bpf_object *obj,
1302                                       struct gen_loader_opts *opts);
1303
1304 enum libbpf_tristate {
1305         TRI_NO = 0,
1306         TRI_YES = 1,
1307         TRI_MODULE = 2,
1308 };
1309
1310 struct bpf_linker_opts {
1311         /* size of this struct, for forward/backward compatiblity */
1312         size_t sz;
1313 };
1314 #define bpf_linker_opts__last_field sz
1315
1316 struct bpf_linker_file_opts {
1317         /* size of this struct, for forward/backward compatiblity */
1318         size_t sz;
1319 };
1320 #define bpf_linker_file_opts__last_field sz
1321
1322 struct bpf_linker;
1323
1324 LIBBPF_API struct bpf_linker *bpf_linker__new(const char *filename, struct bpf_linker_opts *opts);
1325 LIBBPF_API int bpf_linker__add_file(struct bpf_linker *linker,
1326                                     const char *filename,
1327                                     const struct bpf_linker_file_opts *opts);
1328 LIBBPF_API int bpf_linker__finalize(struct bpf_linker *linker);
1329 LIBBPF_API void bpf_linker__free(struct bpf_linker *linker);
1330
1331 #ifdef __cplusplus
1332 } /* extern "C" */
1333 #endif
1334
1335 #endif /* __LIBBPF_LIBBPF_H */