449 lines
16 KiB
C
449 lines
16 KiB
C
/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
|
|
|
|
/*
|
|
* Common eBPF ELF object loading operations.
|
|
*
|
|
* Copyright (C) 2013-2015 Alexei Starovoitov <ast@kernel.org>
|
|
* Copyright (C) 2015 Wang Nan <wangnan0@huawei.com>
|
|
* Copyright (C) 2015 Huawei Inc.
|
|
*/
|
|
#ifndef __LIBBPF_LIBBPF_H
|
|
#define __LIBBPF_LIBBPF_H
|
|
|
|
#include <stdarg.h>
|
|
#include <stdio.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <sys/types.h> // for size_t
|
|
#include <linux/bpf.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef LIBBPF_API
|
|
#define LIBBPF_API __attribute__((visibility("default")))
|
|
#endif
|
|
|
|
enum libbpf_errno {
|
|
__LIBBPF_ERRNO__START = 4000,
|
|
|
|
/* Something wrong in libelf */
|
|
LIBBPF_ERRNO__LIBELF = __LIBBPF_ERRNO__START,
|
|
LIBBPF_ERRNO__FORMAT, /* BPF object format invalid */
|
|
LIBBPF_ERRNO__KVERSION, /* Incorrect or no 'version' section */
|
|
LIBBPF_ERRNO__ENDIAN, /* Endian mismatch */
|
|
LIBBPF_ERRNO__INTERNAL, /* Internal error in libbpf */
|
|
LIBBPF_ERRNO__RELOC, /* Relocation failed */
|
|
LIBBPF_ERRNO__LOAD, /* Load program failure for unknown reason */
|
|
LIBBPF_ERRNO__VERIFY, /* Kernel verifier blocks program loading */
|
|
LIBBPF_ERRNO__PROG2BIG, /* Program too big */
|
|
LIBBPF_ERRNO__KVER, /* Incorrect kernel version */
|
|
LIBBPF_ERRNO__PROGTYPE, /* Kernel doesn't support this program type */
|
|
LIBBPF_ERRNO__WRNGPID, /* Wrong pid in netlink message */
|
|
LIBBPF_ERRNO__INVSEQ, /* Invalid netlink sequence */
|
|
LIBBPF_ERRNO__NLPARSE, /* netlink parsing error */
|
|
__LIBBPF_ERRNO__END,
|
|
};
|
|
|
|
LIBBPF_API int libbpf_strerror(int err, char *buf, size_t size);
|
|
|
|
enum libbpf_print_level {
|
|
LIBBPF_WARN,
|
|
LIBBPF_INFO,
|
|
LIBBPF_DEBUG,
|
|
};
|
|
|
|
typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level,
|
|
const char *, va_list ap);
|
|
|
|
LIBBPF_API void libbpf_set_print(libbpf_print_fn_t fn);
|
|
|
|
/* Hide internal to user */
|
|
struct bpf_object;
|
|
|
|
struct bpf_object_open_attr {
|
|
const char *file;
|
|
enum bpf_prog_type prog_type;
|
|
};
|
|
|
|
LIBBPF_API struct bpf_object *bpf_object__open(const char *path);
|
|
LIBBPF_API struct bpf_object *
|
|
bpf_object__open_xattr(struct bpf_object_open_attr *attr);
|
|
struct bpf_object *__bpf_object__open_xattr(struct bpf_object_open_attr *attr,
|
|
int flags);
|
|
LIBBPF_API struct bpf_object *bpf_object__open_buffer(void *obj_buf,
|
|
size_t obj_buf_sz,
|
|
const char *name);
|
|
LIBBPF_API int bpf_object__pin_maps(struct bpf_object *obj, const char *path);
|
|
LIBBPF_API int bpf_object__unpin_maps(struct bpf_object *obj,
|
|
const char *path);
|
|
LIBBPF_API int bpf_object__pin_programs(struct bpf_object *obj,
|
|
const char *path);
|
|
LIBBPF_API int bpf_object__unpin_programs(struct bpf_object *obj,
|
|
const char *path);
|
|
LIBBPF_API int bpf_object__pin(struct bpf_object *object, const char *path);
|
|
LIBBPF_API void bpf_object__close(struct bpf_object *object);
|
|
|
|
/* Load/unload object into/from kernel */
|
|
LIBBPF_API int bpf_object__load(struct bpf_object *obj);
|
|
LIBBPF_API int bpf_object__unload(struct bpf_object *obj);
|
|
LIBBPF_API const char *bpf_object__name(struct bpf_object *obj);
|
|
LIBBPF_API unsigned int bpf_object__kversion(struct bpf_object *obj);
|
|
|
|
struct btf;
|
|
LIBBPF_API struct btf *bpf_object__btf(struct bpf_object *obj);
|
|
LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj);
|
|
|
|
LIBBPF_API struct bpf_program *
|
|
bpf_object__find_program_by_title(struct bpf_object *obj, const char *title);
|
|
|
|
LIBBPF_API struct bpf_object *bpf_object__next(struct bpf_object *prev);
|
|
#define bpf_object__for_each_safe(pos, tmp) \
|
|
for ((pos) = bpf_object__next(NULL), \
|
|
(tmp) = bpf_object__next(pos); \
|
|
(pos) != NULL; \
|
|
(pos) = (tmp), (tmp) = bpf_object__next(tmp))
|
|
|
|
typedef void (*bpf_object_clear_priv_t)(struct bpf_object *, void *);
|
|
LIBBPF_API int bpf_object__set_priv(struct bpf_object *obj, void *priv,
|
|
bpf_object_clear_priv_t clear_priv);
|
|
LIBBPF_API void *bpf_object__priv(struct bpf_object *prog);
|
|
|
|
LIBBPF_API int
|
|
libbpf_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type,
|
|
enum bpf_attach_type *expected_attach_type);
|
|
LIBBPF_API int libbpf_attach_type_by_name(const char *name,
|
|
enum bpf_attach_type *attach_type);
|
|
|
|
/* Accessors of bpf_program */
|
|
struct bpf_program;
|
|
LIBBPF_API struct bpf_program *bpf_program__next(struct bpf_program *prog,
|
|
struct bpf_object *obj);
|
|
|
|
#define bpf_object__for_each_program(pos, obj) \
|
|
for ((pos) = bpf_program__next(NULL, (obj)); \
|
|
(pos) != NULL; \
|
|
(pos) = bpf_program__next((pos), (obj)))
|
|
|
|
LIBBPF_API struct bpf_program *bpf_program__prev(struct bpf_program *prog,
|
|
struct bpf_object *obj);
|
|
|
|
typedef void (*bpf_program_clear_priv_t)(struct bpf_program *,
|
|
void *);
|
|
|
|
LIBBPF_API int bpf_program__set_priv(struct bpf_program *prog, void *priv,
|
|
bpf_program_clear_priv_t clear_priv);
|
|
|
|
LIBBPF_API void *bpf_program__priv(struct bpf_program *prog);
|
|
LIBBPF_API void bpf_program__set_ifindex(struct bpf_program *prog,
|
|
__u32 ifindex);
|
|
|
|
LIBBPF_API const char *bpf_program__title(struct bpf_program *prog,
|
|
bool needs_copy);
|
|
|
|
LIBBPF_API int bpf_program__load(struct bpf_program *prog, char *license,
|
|
__u32 kern_version);
|
|
LIBBPF_API int bpf_program__fd(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__pin_instance(struct bpf_program *prog,
|
|
const char *path,
|
|
int instance);
|
|
LIBBPF_API int bpf_program__unpin_instance(struct bpf_program *prog,
|
|
const char *path,
|
|
int instance);
|
|
LIBBPF_API int bpf_program__pin(struct bpf_program *prog, const char *path);
|
|
LIBBPF_API int bpf_program__unpin(struct bpf_program *prog, const char *path);
|
|
LIBBPF_API void bpf_program__unload(struct bpf_program *prog);
|
|
|
|
struct bpf_insn;
|
|
|
|
/*
|
|
* Libbpf allows callers to adjust BPF programs before being loaded
|
|
* into kernel. One program in an object file can be transformed into
|
|
* multiple variants to be attached to different hooks.
|
|
*
|
|
* bpf_program_prep_t, bpf_program__set_prep and bpf_program__nth_fd
|
|
* form an API for this purpose.
|
|
*
|
|
* - bpf_program_prep_t:
|
|
* Defines a 'preprocessor', which is a caller defined function
|
|
* passed to libbpf through bpf_program__set_prep(), and will be
|
|
* called before program is loaded. The processor should adjust
|
|
* the program one time for each instance according to the instance id
|
|
* passed to it.
|
|
*
|
|
* - bpf_program__set_prep:
|
|
* Attaches a preprocessor to a BPF program. The number of instances
|
|
* that should be created is also passed through this function.
|
|
*
|
|
* - bpf_program__nth_fd:
|
|
* After the program is loaded, get resulting FD of a given instance
|
|
* of the BPF program.
|
|
*
|
|
* If bpf_program__set_prep() is not used, the program would be loaded
|
|
* without adjustment during bpf_object__load(). The program has only
|
|
* one instance. In this case bpf_program__fd(prog) is equal to
|
|
* bpf_program__nth_fd(prog, 0).
|
|
*/
|
|
|
|
struct bpf_prog_prep_result {
|
|
/*
|
|
* If not NULL, load new instruction array.
|
|
* If set to NULL, don't load this instance.
|
|
*/
|
|
struct bpf_insn *new_insn_ptr;
|
|
int new_insn_cnt;
|
|
|
|
/* If not NULL, result FD is written to it. */
|
|
int *pfd;
|
|
};
|
|
|
|
/*
|
|
* Parameters of bpf_program_prep_t:
|
|
* - prog: The bpf_program being loaded.
|
|
* - n: Index of instance being generated.
|
|
* - insns: BPF instructions array.
|
|
* - insns_cnt:Number of instructions in insns.
|
|
* - res: Output parameter, result of transformation.
|
|
*
|
|
* Return value:
|
|
* - Zero: pre-processing success.
|
|
* - Non-zero: pre-processing error, stop loading.
|
|
*/
|
|
typedef int (*bpf_program_prep_t)(struct bpf_program *prog, int n,
|
|
struct bpf_insn *insns, int insns_cnt,
|
|
struct bpf_prog_prep_result *res);
|
|
|
|
LIBBPF_API int bpf_program__set_prep(struct bpf_program *prog, int nr_instance,
|
|
bpf_program_prep_t prep);
|
|
|
|
LIBBPF_API int bpf_program__nth_fd(struct bpf_program *prog, int n);
|
|
|
|
/*
|
|
* Adjust type of BPF program. Default is kprobe.
|
|
*/
|
|
LIBBPF_API int bpf_program__set_socket_filter(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_tracepoint(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_raw_tracepoint(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_kprobe(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_sched_cls(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_sched_act(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_xdp(struct bpf_program *prog);
|
|
LIBBPF_API int bpf_program__set_perf_event(struct bpf_program *prog);
|
|
LIBBPF_API void bpf_program__set_type(struct bpf_program *prog,
|
|
enum bpf_prog_type type);
|
|
LIBBPF_API void
|
|
bpf_program__set_expected_attach_type(struct bpf_program *prog,
|
|
enum bpf_attach_type type);
|
|
|
|
LIBBPF_API bool bpf_program__is_socket_filter(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_tracepoint(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_raw_tracepoint(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_kprobe(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_sched_cls(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_sched_act(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_xdp(struct bpf_program *prog);
|
|
LIBBPF_API bool bpf_program__is_perf_event(struct bpf_program *prog);
|
|
|
|
/*
|
|
* No need for __attribute__((packed)), all members of 'bpf_map_def'
|
|
* are all aligned. In addition, using __attribute__((packed))
|
|
* would trigger a -Wpacked warning message, and lead to an error
|
|
* if -Werror is set.
|
|
*/
|
|
struct bpf_map_def {
|
|
unsigned int type;
|
|
unsigned int key_size;
|
|
unsigned int value_size;
|
|
unsigned int max_entries;
|
|
unsigned int map_flags;
|
|
};
|
|
|
|
/*
|
|
* The 'struct bpf_map' in include/linux/bpf.h is internal to the kernel,
|
|
* so no need to worry about a name clash.
|
|
*/
|
|
struct bpf_map;
|
|
LIBBPF_API struct bpf_map *
|
|
bpf_object__find_map_by_name(struct bpf_object *obj, const char *name);
|
|
|
|
LIBBPF_API int
|
|
bpf_object__find_map_fd_by_name(struct bpf_object *obj, const char *name);
|
|
|
|
/*
|
|
* Get bpf_map through the offset of corresponding struct bpf_map_def
|
|
* in the BPF object file.
|
|
*/
|
|
LIBBPF_API struct bpf_map *
|
|
bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset);
|
|
|
|
LIBBPF_API struct bpf_map *
|
|
bpf_map__next(struct bpf_map *map, struct bpf_object *obj);
|
|
#define bpf_object__for_each_map(pos, obj) \
|
|
for ((pos) = bpf_map__next(NULL, (obj)); \
|
|
(pos) != NULL; \
|
|
(pos) = bpf_map__next((pos), (obj)))
|
|
#define bpf_map__for_each bpf_object__for_each_map
|
|
|
|
LIBBPF_API struct bpf_map *
|
|
bpf_map__prev(struct bpf_map *map, struct bpf_object *obj);
|
|
|
|
LIBBPF_API int bpf_map__fd(struct bpf_map *map);
|
|
LIBBPF_API const struct bpf_map_def *bpf_map__def(struct bpf_map *map);
|
|
LIBBPF_API const char *bpf_map__name(struct bpf_map *map);
|
|
LIBBPF_API __u32 bpf_map__btf_key_type_id(const struct bpf_map *map);
|
|
LIBBPF_API __u32 bpf_map__btf_value_type_id(const struct bpf_map *map);
|
|
|
|
typedef void (*bpf_map_clear_priv_t)(struct bpf_map *, void *);
|
|
LIBBPF_API int bpf_map__set_priv(struct bpf_map *map, void *priv,
|
|
bpf_map_clear_priv_t clear_priv);
|
|
LIBBPF_API void *bpf_map__priv(struct bpf_map *map);
|
|
LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd);
|
|
LIBBPF_API int bpf_map__resize(struct bpf_map *map, __u32 max_entries);
|
|
LIBBPF_API bool bpf_map__is_offload_neutral(struct bpf_map *map);
|
|
LIBBPF_API void bpf_map__set_ifindex(struct bpf_map *map, __u32 ifindex);
|
|
LIBBPF_API int bpf_map__pin(struct bpf_map *map, const char *path);
|
|
LIBBPF_API int bpf_map__unpin(struct bpf_map *map, const char *path);
|
|
|
|
LIBBPF_API int bpf_map__set_inner_map_fd(struct bpf_map *map, int fd);
|
|
|
|
LIBBPF_API long libbpf_get_error(const void *ptr);
|
|
|
|
struct bpf_prog_load_attr {
|
|
const char *file;
|
|
enum bpf_prog_type prog_type;
|
|
enum bpf_attach_type expected_attach_type;
|
|
int ifindex;
|
|
};
|
|
|
|
LIBBPF_API int bpf_prog_load_xattr(const struct bpf_prog_load_attr *attr,
|
|
struct bpf_object **pobj, int *prog_fd);
|
|
LIBBPF_API int bpf_prog_load(const char *file, enum bpf_prog_type type,
|
|
struct bpf_object **pobj, int *prog_fd);
|
|
|
|
LIBBPF_API int bpf_set_link_xdp_fd(int ifindex, int fd, __u32 flags);
|
|
LIBBPF_API int bpf_get_link_xdp_id(int ifindex, __u32 *prog_id, __u32 flags);
|
|
|
|
enum bpf_perf_event_ret {
|
|
LIBBPF_PERF_EVENT_DONE = 0,
|
|
LIBBPF_PERF_EVENT_ERROR = -1,
|
|
LIBBPF_PERF_EVENT_CONT = -2,
|
|
};
|
|
|
|
struct perf_event_header;
|
|
typedef enum bpf_perf_event_ret
|
|
(*bpf_perf_event_print_t)(struct perf_event_header *hdr,
|
|
void *private_data);
|
|
LIBBPF_API enum bpf_perf_event_ret
|
|
bpf_perf_event_read_simple(void *mmap_mem, size_t mmap_size, size_t page_size,
|
|
void **copy_mem, size_t *copy_size,
|
|
bpf_perf_event_print_t fn, void *private_data);
|
|
|
|
struct nlattr;
|
|
typedef int (*libbpf_dump_nlmsg_t)(void *cookie, void *msg, struct nlattr **tb);
|
|
int libbpf_netlink_open(unsigned int *nl_pid);
|
|
int libbpf_nl_get_link(int sock, unsigned int nl_pid,
|
|
libbpf_dump_nlmsg_t dump_link_nlmsg, void *cookie);
|
|
int libbpf_nl_get_class(int sock, unsigned int nl_pid, int ifindex,
|
|
libbpf_dump_nlmsg_t dump_class_nlmsg, void *cookie);
|
|
int libbpf_nl_get_qdisc(int sock, unsigned int nl_pid, int ifindex,
|
|
libbpf_dump_nlmsg_t dump_qdisc_nlmsg, void *cookie);
|
|
int libbpf_nl_get_filter(int sock, unsigned int nl_pid, int ifindex, int handle,
|
|
libbpf_dump_nlmsg_t dump_filter_nlmsg, void *cookie);
|
|
|
|
struct bpf_prog_linfo;
|
|
struct bpf_prog_info;
|
|
|
|
LIBBPF_API void bpf_prog_linfo__free(struct bpf_prog_linfo *prog_linfo);
|
|
LIBBPF_API struct bpf_prog_linfo *
|
|
bpf_prog_linfo__new(const struct bpf_prog_info *info);
|
|
LIBBPF_API const struct bpf_line_info *
|
|
bpf_prog_linfo__lfind_addr_func(const struct bpf_prog_linfo *prog_linfo,
|
|
__u64 addr, __u32 func_idx, __u32 nr_skip);
|
|
LIBBPF_API const struct bpf_line_info *
|
|
bpf_prog_linfo__lfind(const struct bpf_prog_linfo *prog_linfo,
|
|
__u32 insn_off, __u32 nr_skip);
|
|
|
|
/*
|
|
* Probe for supported system features
|
|
*
|
|
* Note that running many of these probes in a short amount of time can cause
|
|
* the kernel to reach the maximal size of lockable memory allowed for the
|
|
* user, causing subsequent probes to fail. In this case, the caller may want
|
|
* to adjust that limit with setrlimit().
|
|
*/
|
|
LIBBPF_API bool bpf_probe_prog_type(enum bpf_prog_type prog_type,
|
|
__u32 ifindex);
|
|
LIBBPF_API bool bpf_probe_map_type(enum bpf_map_type map_type, __u32 ifindex);
|
|
LIBBPF_API bool bpf_probe_helper(enum bpf_func_id id,
|
|
enum bpf_prog_type prog_type, __u32 ifindex);
|
|
|
|
/*
|
|
* Get bpf_prog_info in continuous memory
|
|
*
|
|
* struct bpf_prog_info has multiple arrays. The user has option to choose
|
|
* arrays to fetch from kernel. The following APIs provide an uniform way to
|
|
* fetch these data. All arrays in bpf_prog_info are stored in a single
|
|
* continuous memory region. This makes it easy to store the info in a
|
|
* file.
|
|
*
|
|
* Before writing bpf_prog_info_linear to files, it is necessary to
|
|
* translate pointers in bpf_prog_info to offsets. Helper functions
|
|
* bpf_program__bpil_addr_to_offs() and bpf_program__bpil_offs_to_addr()
|
|
* are introduced to switch between pointers and offsets.
|
|
*
|
|
* Examples:
|
|
* # To fetch map_ids and prog_tags:
|
|
* __u64 arrays = (1UL << BPF_PROG_INFO_MAP_IDS) |
|
|
* (1UL << BPF_PROG_INFO_PROG_TAGS);
|
|
* struct bpf_prog_info_linear *info_linear =
|
|
* bpf_program__get_prog_info_linear(fd, arrays);
|
|
*
|
|
* # To save data in file
|
|
* bpf_program__bpil_addr_to_offs(info_linear);
|
|
* write(f, info_linear, sizeof(*info_linear) + info_linear->data_len);
|
|
*
|
|
* # To read data from file
|
|
* read(f, info_linear, <proper_size>);
|
|
* bpf_program__bpil_offs_to_addr(info_linear);
|
|
*/
|
|
enum bpf_prog_info_array {
|
|
BPF_PROG_INFO_FIRST_ARRAY = 0,
|
|
BPF_PROG_INFO_JITED_INSNS = 0,
|
|
BPF_PROG_INFO_XLATED_INSNS,
|
|
BPF_PROG_INFO_MAP_IDS,
|
|
BPF_PROG_INFO_JITED_KSYMS,
|
|
BPF_PROG_INFO_JITED_FUNC_LENS,
|
|
BPF_PROG_INFO_FUNC_INFO,
|
|
BPF_PROG_INFO_LINE_INFO,
|
|
BPF_PROG_INFO_JITED_LINE_INFO,
|
|
BPF_PROG_INFO_PROG_TAGS,
|
|
BPF_PROG_INFO_LAST_ARRAY,
|
|
};
|
|
|
|
struct bpf_prog_info_linear {
|
|
/* size of struct bpf_prog_info, when the tool is compiled */
|
|
__u32 info_len;
|
|
/* total bytes allocated for data, round up to 8 bytes */
|
|
__u32 data_len;
|
|
/* which arrays are included in data */
|
|
__u64 arrays;
|
|
struct bpf_prog_info info;
|
|
__u8 data[];
|
|
};
|
|
|
|
LIBBPF_API struct bpf_prog_info_linear *
|
|
bpf_program__get_prog_info_linear(int fd, __u64 arrays);
|
|
|
|
LIBBPF_API void
|
|
bpf_program__bpil_addr_to_offs(struct bpf_prog_info_linear *info_linear);
|
|
|
|
LIBBPF_API void
|
|
bpf_program__bpil_offs_to_addr(struct bpf_prog_info_linear *info_linear);
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* __LIBBPF_LIBBPF_H */
|