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
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 enum libbpf_errno {
  27         __LIBBPF_ERRNO__START = 4000,
  28
  29         /* Something wrong in libelf */
  30         LIBBPF_ERRNO__LIBELF = __LIBBPF_ERRNO__START,
  31         LIBBPF_ERRNO__FORMAT,   /* BPF object format invalid */
  32         LIBBPF_ERRNO__KVERSION, /* Incorrect or no 'version' section */
  33         LIBBPF_ERRNO__ENDIAN,   /* Endian mismatch */
  34         LIBBPF_ERRNO__INTERNAL, /* Internal error in libbpf */
  35         LIBBPF_ERRNO__RELOC,    /* Relocation failed */
  36         LIBBPF_ERRNO__LOAD,     /* Load program failure for unknown reason */
  37         LIBBPF_ERRNO__VERIFY,   /* Kernel verifier blocks program loading */
  38         LIBBPF_ERRNO__PROG2BIG, /* Program too big */
  39         LIBBPF_ERRNO__KVER,     /* Incorrect kernel version */
  40         LIBBPF_ERRNO__PROGTYPE, /* Kernel doesn't support this program type */
  41         LIBBPF_ERRNO__WRNGPID,  /* Wrong pid in netlink message */
  42         LIBBPF_ERRNO__INVSEQ,   /* Invalid netlink sequence */
  43         LIBBPF_ERRNO__NLPARSE,  /* netlink parsing error */
  44         __LIBBPF_ERRNO__END,
  45 };
  46
  47 LIBBPF_API int libbpf_strerror(int err, char *buf, size_t size);
  48
  49 enum libbpf_print_level {
  50         LIBBPF_WARN,
  51         LIBBPF_INFO,
  52         LIBBPF_DEBUG,
  53 };
  54
  55 typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,
  56                                  const char *, va_list ap);
  57
  58 LIBBPF_API libbpf_print_fn_t libbpf_set_print(libbpf_print_fn_t fn);
  59
  60 /* Hide internal to user */
  61 struct bpf_object;
  62
  63 struct bpf_object_open_attr {
  64         const char *file;
  65         enum bpf_prog_type prog_type;
  66 };
  67
  68 struct bpf_object_open_opts {
  69         /* size of this struct, for forward/backward compatiblity */
  70         size_t sz;
  71         /* object name override, if provided:
  72          * - for object open from file, this will override setting object
  73          *   name from file path's base name;
  74          * - for object open from memory buffer, this will specify an object
  75          *   name and will override default "<addr>-<buf-size>" name;
  76          */
  77         const char *object_name;
  78         /* parse map definitions non-strictly, allowing extra attributes/data */
  79         bool relaxed_maps;
  80         /* process CO-RE relocations non-strictly, allowing them to fail */
  81         bool relaxed_core_relocs;
  82         /* maps that set the 'pinning' attribute in their definition will have
  83          * their pin_path attribute set to a file in this directory, and be
  84          * auto-pinned to that path on load; defaults to "/sys/fs/bpf".
  85          */
  86         const char *pin_root_path;
  87         __u32 attach_prog_fd;
  88         /* kernel config file path override (for CONFIG_ externs); can point
  89          * to either uncompressed text file or .gz file
  90          */
  91         const char *kconfig_path;
  92 };
  93 #define bpf_object_open_opts__last_field kconfig_path
  94
  95 LIBBPF_API struct bpf_object *bpf_object__open(const char *path);
  96 LIBBPF_API struct bpf_object *
  97 bpf_object__open_file(const char *path, const struct bpf_object_open_opts *opts);
  98 LIBBPF_API struct bpf_object *
  99 bpf_object__open_mem(const void *obj_buf, size_t obj_buf_sz,
 100                      const struct bpf_object_open_opts *opts);
 101
 102 /* deprecated bpf_object__open variants */
 103 LIBBPF_API struct bpf_object *
 104 bpf_object__open_buffer(const void *obj_buf, size_t obj_buf_sz,
 105                         const char *name);
 106 LIBBPF_API struct bpf_object *
 107 bpf_object__open_xattr(struct bpf_object_open_attr *attr);
 108
 109 enum libbpf_pin_type {
 110         LIBBPF_PIN_NONE,
 111         /* PIN_BY_NAME: pin maps by name (in /sys/fs/bpf by default) */
 112         LIBBPF_PIN_BY_NAME,
 113 };
 114
 115 /* pin_maps and unpin_maps can both be called with a NULL path, in which case
 116  * they will use the pin_path attribute of each map (and ignore all maps that
 117  * don't have a pin_path set).
 118  */
 119 LIBBPF_API int bpf_object__pin_maps(struct bpf_object *obj, const char *path);
 120 LIBBPF_API int bpf_object__unpin_maps(struct bpf_object *obj,
 121                                       const char *path);
 122 LIBBPF_API int bpf_object__pin_programs(struct bpf_object *obj,
 123                                         const char *path);
 124 LIBBPF_API int bpf_object__unpin_programs(struct bpf_object *obj,
 125                                           const char *path);
 126 LIBBPF_API int bpf_object__pin(struct bpf_object *object, const char *path);
 127 LIBBPF_API void bpf_object__close(struct bpf_object *object);
 128
 129 struct bpf_object_load_attr {
 130         struct bpf_object *obj;
 131         int log_level;
 132         const char *target_btf_path;
 133 };
 134
 135 /* Load/unload object into/from kernel */
 136 LIBBPF_API int bpf_object__load(struct bpf_object *obj);
 137 LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr);
 138 LIBBPF_API int bpf_object__unload(struct bpf_object *obj);
 139
 140 LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj);
 141 LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj);
 142
 143 struct btf;
 144 LIBBPF_API struct btf *bpf_object__btf(const struct bpf_object *obj);
 145 LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj);
 146
 147 LIBBPF_API struct bpf_program *
 148 bpf_object__find_program_by_title(const struct bpf_object *obj,
 149                                   const char *title);
 150 LIBBPF_API struct bpf_program *
 151 bpf_object__find_program_by_name(const struct bpf_object *obj,
 152                                  const char *name);
 153
 154 LIBBPF_API struct bpf_object *bpf_object__next(struct bpf_object *prev);
 155 #define bpf_object__for_each_safe(pos, tmp)                     \
 156         for ((pos) = bpf_object__next(NULL),            \
 157                 (tmp) = bpf_object__next(pos);          \
 158              (pos) != NULL;                             \
 159              (pos) = (tmp), (tmp) = bpf_object__next(tmp))
 160
 161 typedef void (*bpf_object_clear_priv_t)(struct bpf_object *, void *);
 162 LIBBPF_API int bpf_object__set_priv(struct bpf_object *obj, void *priv,
 163                                     bpf_object_clear_priv_t clear_priv);
 164 LIBBPF_API void *bpf_object__priv(const struct bpf_object *prog);
 165
 166 LIBBPF_API int
 167 libbpf_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type,
 168                          enum bpf_attach_type *expected_attach_type);
 169 LIBBPF_API int libbpf_attach_type_by_name(const char *name,
 170                                           enum bpf_attach_type *attach_type);
 171 LIBBPF_API int libbpf_find_vmlinux_btf_id(const char *name,
 172                                           enum bpf_attach_type attach_type);
 173
 174 /* Accessors of bpf_program */
 175 struct bpf_program;
 176 LIBBPF_API struct bpf_program *bpf_program__next(struct bpf_program *prog,
 177                                                  const struct bpf_object *obj);
 178
 179 #define bpf_object__for_each_program(pos, obj)          \
 180         for ((pos) = bpf_program__next(NULL, (obj));    \
 181              (pos) != NULL;                             \
 182              (pos) = bpf_program__next((pos), (obj)))
 183
 184 LIBBPF_API struct bpf_program *bpf_program__prev(struct bpf_program *prog,
 185                                                  const struct bpf_object *obj);
 186
 187 typedef void (*bpf_program_clear_priv_t)(struct bpf_program *, void *);
 188
 189 LIBBPF_API int bpf_program__set_priv(struct bpf_program *prog, void *priv,
 190                                      bpf_program_clear_priv_t clear_priv);
 191
 192 LIBBPF_API void *bpf_program__priv(const struct bpf_program *prog);
 193 LIBBPF_API void bpf_program__set_ifindex(struct bpf_program *prog,
 194                                          __u32 ifindex);
 195
 196 LIBBPF_API const char *bpf_program__name(const struct bpf_program *prog);
 197 LIBBPF_API const char *bpf_program__title(const struct bpf_program *prog,
 198                                           bool needs_copy);
 199
 200 /* returns program size in bytes */
 201 LIBBPF_API size_t bpf_program__size(const struct bpf_program *prog);
 202
 203 LIBBPF_API int bpf_program__load(struct bpf_program *prog, char *license,
 204                                  __u32 kern_version);
 205 LIBBPF_API int bpf_program__fd(const struct bpf_program *prog);
 206 LIBBPF_API int bpf_program__pin_instance(struct bpf_program *prog,
 207                                          const char *path,
 208                                          int instance);
 209 LIBBPF_API int bpf_program__unpin_instance(struct bpf_program *prog,
 210                                            const char *path,
 211                                            int instance);
 212 LIBBPF_API int bpf_program__pin(struct bpf_program *prog, const char *path);
 213 LIBBPF_API int bpf_program__unpin(struct bpf_program *prog, const char *path);
 214 LIBBPF_API void bpf_program__unload(struct bpf_program *prog);
 215
 216 struct bpf_link;
 217
 218 LIBBPF_API int bpf_link__destroy(struct bpf_link *link);
 219
 220 LIBBPF_API struct bpf_link *
 221 bpf_program__attach(struct bpf_program *prog);
 222 LIBBPF_API struct bpf_link *
 223 bpf_program__attach_perf_event(struct bpf_program *prog, int pfd);
 224 LIBBPF_API struct bpf_link *
 225 bpf_program__attach_kprobe(struct bpf_program *prog, bool retprobe,
 226                            const char *func_name);
 227 LIBBPF_API struct bpf_link *
 228 bpf_program__attach_uprobe(struct bpf_program *prog, bool retprobe,
 229                            pid_t pid, const char *binary_path,
 230                            size_t func_offset);
 231 LIBBPF_API struct bpf_link *
 232 bpf_program__attach_tracepoint(struct bpf_program *prog,
 233                                const char *tp_category,
 234                                const char *tp_name);
 235 LIBBPF_API struct bpf_link *
 236 bpf_program__attach_raw_tracepoint(struct bpf_program *prog,
 237                                    const char *tp_name);
 238
 239 LIBBPF_API struct bpf_link *
 240 bpf_program__attach_trace(struct bpf_program *prog);
 241 struct bpf_insn;
 242
 243 /*
 244  * Libbpf allows callers to adjust BPF programs before being loaded
 245  * into kernel. One program in an object file can be transformed into
 246  * multiple variants to be attached to different hooks.
 247  *
 248  * bpf_program_prep_t, bpf_program__set_prep and bpf_program__nth_fd
 249  * form an API for this purpose.
 250  *
 251  * - bpf_program_prep_t:
 252  *   Defines a 'preprocessor', which is a caller defined function
 253  *   passed to libbpf through bpf_program__set_prep(), and will be
 254  *   called before program is loaded. The processor should adjust
 255  *   the program one time for each instance according to the instance id
 256  *   passed to it.
 257  *
 258  * - bpf_program__set_prep:
 259  *   Attaches a preprocessor to a BPF program. The number of instances
 260  *   that should be created is also passed through this function.
 261  *
 262  * - bpf_program__nth_fd:
 263  *   After the program is loaded, get resulting FD of a given instance
 264  *   of the BPF program.
 265  *
 266  * If bpf_program__set_prep() is not used, the program would be loaded
 267  * without adjustment during bpf_object__load(). The program has only
 268  * one instance. In this case bpf_program__fd(prog) is equal to
 269  * bpf_program__nth_fd(prog, 0).
 270  */
 271
 272 struct bpf_prog_prep_result {
 273         /*
 274          * If not NULL, load new instruction array.
 275          * If set to NULL, don't load this instance.
 276          */
 277         struct bpf_insn *new_insn_ptr;
 278         int new_insn_cnt;
 279
 280         /* If not NULL, result FD is written to it. */
 281         int *pfd;
 282 };
 283
 284 /*
 285  * Parameters of bpf_program_prep_t:
 286  *  - prog:     The bpf_program being loaded.
 287  *  - n:        Index of instance being generated.
 288  *  - insns:    BPF instructions array.
 289  *  - insns_cnt:Number of instructions in insns.
 290  *  - res:      Output parameter, result of transformation.
 291  *
 292  * Return value:
 293  *  - Zero:     pre-processing success.
 294  *  - Non-zero: pre-processing error, stop loading.
 295  */
 296 typedef int (*bpf_program_prep_t)(struct bpf_program *prog, int n,
 297                                   struct bpf_insn *insns, int insns_cnt,
 298                                   struct bpf_prog_prep_result *res);
 299
 300 LIBBPF_API int bpf_program__set_prep(struct bpf_program *prog, int nr_instance,
 301                                      bpf_program_prep_t prep);
 302
 303 LIBBPF_API int bpf_program__nth_fd(const struct bpf_program *prog, int n);
 304
 305 /*
 306  * Adjust type of BPF program. Default is kprobe.
 307  */
 308 LIBBPF_API int bpf_program__set_socket_filter(struct bpf_program *prog);
 309 LIBBPF_API int bpf_program__set_tracepoint(struct bpf_program *prog);
 310 LIBBPF_API int bpf_program__set_raw_tracepoint(struct bpf_program *prog);
 311 LIBBPF_API int bpf_program__set_kprobe(struct bpf_program *prog);
 312 LIBBPF_API int bpf_program__set_sched_cls(struct bpf_program *prog);
 313 LIBBPF_API int bpf_program__set_sched_act(struct bpf_program *prog);
 314 LIBBPF_API int bpf_program__set_xdp(struct bpf_program *prog);
 315 LIBBPF_API int bpf_program__set_perf_event(struct bpf_program *prog);
 316 LIBBPF_API int bpf_program__set_tracing(struct bpf_program *prog);
 317
 318 LIBBPF_API enum bpf_prog_type bpf_program__get_type(struct bpf_program *prog);
 319 LIBBPF_API void bpf_program__set_type(struct bpf_program *prog,
 320                                       enum bpf_prog_type type);
 321
 322 LIBBPF_API enum bpf_attach_type
 323 bpf_program__get_expected_attach_type(struct bpf_program *prog);
 324 LIBBPF_API void
 325 bpf_program__set_expected_attach_type(struct bpf_program *prog,
 326                                       enum bpf_attach_type type);
 327
 328 LIBBPF_API bool bpf_program__is_socket_filter(const struct bpf_program *prog);
 329 LIBBPF_API bool bpf_program__is_tracepoint(const struct bpf_program *prog);
 330 LIBBPF_API bool bpf_program__is_raw_tracepoint(const struct bpf_program *prog);
 331 LIBBPF_API bool bpf_program__is_kprobe(const struct bpf_program *prog);
 332 LIBBPF_API bool bpf_program__is_sched_cls(const struct bpf_program *prog);
 333 LIBBPF_API bool bpf_program__is_sched_act(const struct bpf_program *prog);
 334 LIBBPF_API bool bpf_program__is_xdp(const struct bpf_program *prog);
 335 LIBBPF_API bool bpf_program__is_perf_event(const struct bpf_program *prog);
 336 LIBBPF_API bool bpf_program__is_tracing(const struct bpf_program *prog);
 337
 338 /*
 339  * No need for __attribute__((packed)), all members of 'bpf_map_def'
 340  * are all aligned.  In addition, using __attribute__((packed))
 341  * would trigger a -Wpacked warning message, and lead to an error
 342  * if -Werror is set.
 343  */
 344 struct bpf_map_def {
 345         unsigned int type;
 346         unsigned int key_size;
 347         unsigned int value_size;
 348         unsigned int max_entries;
 349         unsigned int map_flags;
 350 };
 351
 352 /*
 353  * The 'struct bpf_map' in include/linux/bpf.h is internal to the kernel,
 354  * so no need to worry about a name clash.
 355  */
 356 struct bpf_map;
 357 LIBBPF_API struct bpf_map *
 358 bpf_object__find_map_by_name(const struct bpf_object *obj, const char *name);
 359
 360 LIBBPF_API int
 361 bpf_object__find_map_fd_by_name(const struct bpf_object *obj, const char *name);
 362
 363 /*
 364  * Get bpf_map through the offset of corresponding struct bpf_map_def
 365  * in the BPF object file.
 366  */
 367 LIBBPF_API struct bpf_map *
 368 bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset);
 369
 370 LIBBPF_API struct bpf_map *
 371 bpf_map__next(const struct bpf_map *map, const struct bpf_object *obj);
 372 #define bpf_object__for_each_map(pos, obj)              \
 373         for ((pos) = bpf_map__next(NULL, (obj));        \
 374              (pos) != NULL;                             \
 375              (pos) = bpf_map__next((pos), (obj)))
 376 #define bpf_map__for_each bpf_object__for_each_map
 377
 378 LIBBPF_API struct bpf_map *
 379 bpf_map__prev(const struct bpf_map *map, const struct bpf_object *obj);
 380
 381 LIBBPF_API int bpf_map__fd(const struct bpf_map *map);
 382 LIBBPF_API const struct bpf_map_def *bpf_map__def(const struct bpf_map *map);
 383 LIBBPF_API const char *bpf_map__name(const struct bpf_map *map);
 384 LIBBPF_API __u32 bpf_map__btf_key_type_id(const struct bpf_map *map);
 385 LIBBPF_API __u32 bpf_map__btf_value_type_id(const struct bpf_map *map);
 386
 387 typedef void (*bpf_map_clear_priv_t)(struct bpf_map *, void *);
 388 LIBBPF_API int bpf_map__set_priv(struct bpf_map *map, void *priv,
 389                                  bpf_map_clear_priv_t clear_priv);
 390 LIBBPF_API void *bpf_map__priv(const struct bpf_map *map);
 391 LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd);
 392 LIBBPF_API int bpf_map__resize(struct bpf_map *map, __u32 max_entries);
 393 LIBBPF_API bool bpf_map__is_offload_neutral(const struct bpf_map *map);
 394 LIBBPF_API bool bpf_map__is_internal(const struct bpf_map *map);
 395 LIBBPF_API void bpf_map__set_ifindex(struct bpf_map *map, __u32 ifindex);
 396 LIBBPF_API int bpf_map__set_pin_path(struct bpf_map *map, const char *path);
 397 LIBBPF_API const char *bpf_map__get_pin_path(const struct bpf_map *map);
 398 LIBBPF_API bool bpf_map__is_pinned(const struct bpf_map *map);
 399 LIBBPF_API int bpf_map__pin(struct bpf_map *map, const char *path);
 400 LIBBPF_API int bpf_map__unpin(struct bpf_map *map, const char *path);
 401
 402 LIBBPF_API int bpf_map__set_inner_map_fd(struct bpf_map *map, int fd);
 403
 404 LIBBPF_API long libbpf_get_error(const void *ptr);
 405
 406 struct bpf_prog_load_attr {
 407         const char *file;
 408         enum bpf_prog_type prog_type;
 409         enum bpf_attach_type expected_attach_type;
 410         int ifindex;
 411         int log_level;
 412         int prog_flags;
 413 };
 414
 415 LIBBPF_API int bpf_prog_load_xattr(const struct bpf_prog_load_attr *attr,
 416                                    struct bpf_object **pobj, int *prog_fd);
 417 LIBBPF_API int bpf_prog_load(const char *file, enum bpf_prog_type type,
 418                              struct bpf_object **pobj, int *prog_fd);
 419
 420 struct xdp_link_info {
 421         __u32 prog_id;
 422         __u32 drv_prog_id;
 423         __u32 hw_prog_id;
 424         __u32 skb_prog_id;
 425         __u8 attach_mode;
 426 };
 427
 428 LIBBPF_API int bpf_set_link_xdp_fd(int ifindex, int fd, __u32 flags);
 429 LIBBPF_API int bpf_get_link_xdp_id(int ifindex, __u32 *prog_id, __u32 flags);
 430 LIBBPF_API int bpf_get_link_xdp_info(int ifindex, struct xdp_link_info *info,
 431                                      size_t info_size, __u32 flags);
 432
 433 struct perf_buffer;
 434
 435 typedef void (*perf_buffer_sample_fn)(void *ctx, int cpu,
 436                                       void *data, __u32 size);
 437 typedef void (*perf_buffer_lost_fn)(void *ctx, int cpu, __u64 cnt);
 438
 439 /* common use perf buffer options */
 440 struct perf_buffer_opts {
 441         /* if specified, sample_cb is called for each sample */
 442         perf_buffer_sample_fn sample_cb;
 443         /* if specified, lost_cb is called for each batch of lost samples */
 444         perf_buffer_lost_fn lost_cb;
 445         /* ctx is provided to sample_cb and lost_cb */
 446         void *ctx;
 447 };
 448
 449 LIBBPF_API struct perf_buffer *
 450 perf_buffer__new(int map_fd, size_t page_cnt,
 451                  const struct perf_buffer_opts *opts);
 452
 453 enum bpf_perf_event_ret {
 454         LIBBPF_PERF_EVENT_DONE  = 0,
 455         LIBBPF_PERF_EVENT_ERROR = -1,
 456         LIBBPF_PERF_EVENT_CONT  = -2,
 457 };
 458
 459 struct perf_event_header;
 460
 461 typedef enum bpf_perf_event_ret
 462 (*perf_buffer_event_fn)(void *ctx, int cpu, struct perf_event_header *event);
 463
 464 /* raw perf buffer options, giving most power and control */
 465 struct perf_buffer_raw_opts {
 466         /* perf event attrs passed directly into perf_event_open() */
 467         struct perf_event_attr *attr;
 468         /* raw event callback */
 469         perf_buffer_event_fn event_cb;
 470         /* ctx is provided to event_cb */
 471         void *ctx;
 472         /* if cpu_cnt == 0, open all on all possible CPUs (up to the number of
 473          * max_entries of given PERF_EVENT_ARRAY map)
 474          */
 475         int cpu_cnt;
 476         /* if cpu_cnt > 0, cpus is an array of CPUs to open ring buffers on */
 477         int *cpus;
 478         /* if cpu_cnt > 0, map_keys specify map keys to set per-CPU FDs for */
 479         int *map_keys;
 480 };
 481
 482 LIBBPF_API struct perf_buffer *
 483 perf_buffer__new_raw(int map_fd, size_t page_cnt,
 484                      const struct perf_buffer_raw_opts *opts);
 485
 486 LIBBPF_API void perf_buffer__free(struct perf_buffer *pb);
 487 LIBBPF_API int perf_buffer__poll(struct perf_buffer *pb, int timeout_ms);
 488
 489 typedef enum bpf_perf_event_ret
 490         (*bpf_perf_event_print_t)(struct perf_event_header *hdr,
 491                                   void *private_data);
 492 LIBBPF_API enum bpf_perf_event_ret
 493 bpf_perf_event_read_simple(void *mmap_mem, size_t mmap_size, size_t page_size,
 494                            void **copy_mem, size_t *copy_size,
 495                            bpf_perf_event_print_t fn, void *private_data);
 496
 497 struct bpf_prog_linfo;
 498 struct bpf_prog_info;
 499
 500 LIBBPF_API void bpf_prog_linfo__free(struct bpf_prog_linfo *prog_linfo);
 501 LIBBPF_API struct bpf_prog_linfo *
 502 bpf_prog_linfo__new(const struct bpf_prog_info *info);
 503 LIBBPF_API const struct bpf_line_info *
 504 bpf_prog_linfo__lfind_addr_func(const struct bpf_prog_linfo *prog_linfo,
 505                                 __u64 addr, __u32 func_idx, __u32 nr_skip);
 506 LIBBPF_API const struct bpf_line_info *
 507 bpf_prog_linfo__lfind(const struct bpf_prog_linfo *prog_linfo,
 508                       __u32 insn_off, __u32 nr_skip);
 509
 510 /*
 511  * Probe for supported system features
 512  *
 513  * Note that running many of these probes in a short amount of time can cause
 514  * the kernel to reach the maximal size of lockable memory allowed for the
 515  * user, causing subsequent probes to fail. In this case, the caller may want
 516  * to adjust that limit with setrlimit().
 517  */
 518 LIBBPF_API bool bpf_probe_prog_type(enum bpf_prog_type prog_type,
 519                                     __u32 ifindex);
 520 LIBBPF_API bool bpf_probe_map_type(enum bpf_map_type map_type, __u32 ifindex);
 521 LIBBPF_API bool bpf_probe_helper(enum bpf_func_id id,
 522                                  enum bpf_prog_type prog_type, __u32 ifindex);
 523
 524 /*
 525  * Get bpf_prog_info in continuous memory
 526  *
 527  * struct bpf_prog_info has multiple arrays. The user has option to choose
 528  * arrays to fetch from kernel. The following APIs provide an uniform way to
 529  * fetch these data. All arrays in bpf_prog_info are stored in a single
 530  * continuous memory region. This makes it easy to store the info in a
 531  * file.
 532  *
 533  * Before writing bpf_prog_info_linear to files, it is necessary to
 534  * translate pointers in bpf_prog_info to offsets. Helper functions
 535  * bpf_program__bpil_addr_to_offs() and bpf_program__bpil_offs_to_addr()
 536  * are introduced to switch between pointers and offsets.
 537  *
 538  * Examples:
 539  *   # To fetch map_ids and prog_tags:
 540  *   __u64 arrays = (1UL << BPF_PROG_INFO_MAP_IDS) |
 541  *           (1UL << BPF_PROG_INFO_PROG_TAGS);
 542  *   struct bpf_prog_info_linear *info_linear =
 543  *           bpf_program__get_prog_info_linear(fd, arrays);
 544  *
 545  *   # To save data in file
 546  *   bpf_program__bpil_addr_to_offs(info_linear);
 547  *   write(f, info_linear, sizeof(*info_linear) + info_linear->data_len);
 548  *
 549  *   # To read data from file
 550  *   read(f, info_linear, <proper_size>);
 551  *   bpf_program__bpil_offs_to_addr(info_linear);
 552  */
 553 enum bpf_prog_info_array {
 554         BPF_PROG_INFO_FIRST_ARRAY = 0,
 555         BPF_PROG_INFO_JITED_INSNS = 0,
 556         BPF_PROG_INFO_XLATED_INSNS,
 557         BPF_PROG_INFO_MAP_IDS,
 558         BPF_PROG_INFO_JITED_KSYMS,
 559         BPF_PROG_INFO_JITED_FUNC_LENS,
 560         BPF_PROG_INFO_FUNC_INFO,
 561         BPF_PROG_INFO_LINE_INFO,
 562         BPF_PROG_INFO_JITED_LINE_INFO,
 563         BPF_PROG_INFO_PROG_TAGS,
 564         BPF_PROG_INFO_LAST_ARRAY,
 565 };
 566
 567 struct bpf_prog_info_linear {
 568         /* size of struct bpf_prog_info, when the tool is compiled */
 569         __u32                   info_len;
 570         /* total bytes allocated for data, round up to 8 bytes */
 571         __u32                   data_len;
 572         /* which arrays are included in data */
 573         __u64                   arrays;
 574         struct bpf_prog_info    info;
 575         __u8                    data[];
 576 };
 577
 578 LIBBPF_API struct bpf_prog_info_linear *
 579 bpf_program__get_prog_info_linear(int fd, __u64 arrays);
 580
 581 LIBBPF_API void
 582 bpf_program__bpil_addr_to_offs(struct bpf_prog_info_linear *info_linear);
 583
 584 LIBBPF_API void
 585 bpf_program__bpil_offs_to_addr(struct bpf_prog_info_linear *info_linear);
 586
 587 /*
 588  * A helper function to get the number of possible CPUs before looking up
 589  * per-CPU maps. Negative errno is returned on failure.
 590  *
 591  * Example usage:
 592  *
 593  *     int ncpus = libbpf_num_possible_cpus();
 594  *     if (ncpus < 0) {
 595  *          // error handling
 596  *     }
 597  *     long values[ncpus];
 598  *     bpf_map_lookup_elem(per_cpu_map_fd, key, values);
 599  *
 600  */
 601 LIBBPF_API int libbpf_num_possible_cpus(void);
 602
 603 struct bpf_embed_data {
 604         void *data;
 605         size_t size;
 606 };
 607
 608 #define BPF_EMBED_OBJ_DECLARE(NAME)                                     \
 609 extern struct bpf_embed_data NAME##_embed;                              \
 610 extern char NAME##_data[];                                              \
 611 extern char NAME##_data_end[];
 612
 613 #define __BPF_EMBED_OBJ(NAME, PATH, SZ, ASM_TYPE)                       \
 614 asm (                                                                   \
 615 "       .pushsection \".rodata\", \"a\", @progbits              \n"     \
 616 "       .global "#NAME"_data                                    \n"     \
 617 #NAME"_data:                                                    \n"     \
 618 "       .incbin \"" PATH "\"                                    \n"     \
 619 "       .global "#NAME"_data_end                                \n"     \
 620 #NAME"_data_end:                                                \n"     \
 621 "       .global "#NAME"_embed                                   \n"     \
 622 "       .type "#NAME"_embed, @object                            \n"     \
 623 "       .size "#NAME"_size, "#SZ"                               \n"     \
 624 "       .align 8,                                               \n"     \
 625 #NAME"_embed:                                                   \n"     \
 626 "       "ASM_TYPE" "#NAME"_data                                 \n"     \
 627 "       "ASM_TYPE" "#NAME"_data_end - "#NAME"_data              \n"     \
 628 "       .popsection                                             \n"     \
 629 );                                                                      \
 630 BPF_EMBED_OBJ_DECLARE(NAME)
 631
 632 #if __SIZEOF_POINTER__ == 4
 633 #define BPF_EMBED_OBJ(NAME, PATH) __BPF_EMBED_OBJ(NAME, PATH, 8, ".long")
 634 #else
 635 #define BPF_EMBED_OBJ(NAME, PATH) __BPF_EMBED_OBJ(NAME, PATH, 16, ".quad")
 636 #endif
 637
 638 struct bpf_map_skeleton {
 639         const char *name;
 640         struct bpf_map **map;
 641         void **mmaped;
 642 };
 643
 644 struct bpf_prog_skeleton {
 645         const char *name;
 646         struct bpf_program **prog;
 647         struct bpf_link **link;
 648 };
 649
 650 struct bpf_object_skeleton {
 651         size_t sz; /* size of this struct, for forward/backward compatibility */
 652
 653         const char *name;
 654         void *data;
 655         size_t data_sz;
 656
 657         struct bpf_object **obj;
 658
 659         int map_cnt;
 660         int map_skel_sz; /* sizeof(struct bpf_skeleton_map) */
 661         struct bpf_map_skeleton *maps;
 662
 663         int prog_cnt;
 664         int prog_skel_sz; /* sizeof(struct bpf_skeleton_prog) */
 665         struct bpf_prog_skeleton *progs;
 666 };
 667
 668 LIBBPF_API int
 669 bpf_object__open_skeleton(struct bpf_object_skeleton *s,
 670                           const struct bpf_object_open_opts *opts);
 671 LIBBPF_API int bpf_object__load_skeleton(struct bpf_object_skeleton *s);
 672 LIBBPF_API int bpf_object__attach_skeleton(struct bpf_object_skeleton *s);
 673 LIBBPF_API void bpf_object__detach_skeleton(struct bpf_object_skeleton *s);
 674 LIBBPF_API void bpf_object__destroy_skeleton(struct bpf_object_skeleton *s);
 675
 676 enum libbpf_tristate {
 677         TRI_NO = 0,
 678         TRI_YES = 1,
 679         TRI_MODULE = 2,
 680 };
 681
 682 #ifdef __cplusplus
 683 } /* extern "C" */
 684 #endif
 685
 686 #endif /* __LIBBPF_LIBBPF_H */