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 <stdio.h> 14 #include <stdint.h> 15 #include <stdbool.h> 16 #include <sys/types.h> // for size_t 17 #include <linux/bpf.h> 18 19 #ifndef LIBBPF_API 20 #define LIBBPF_API __attribute__((visibility("default"))) 21 #endif 22 23 enum libbpf_errno { 24 __LIBBPF_ERRNO__START = 4000, 25 26 /* Something wrong in libelf */ 27 LIBBPF_ERRNO__LIBELF = __LIBBPF_ERRNO__START, 28 LIBBPF_ERRNO__FORMAT, /* BPF object format invalid */ 29 LIBBPF_ERRNO__KVERSION, /* Incorrect or no 'version' section */ 30 LIBBPF_ERRNO__ENDIAN, /* Endian mismatch */ 31 LIBBPF_ERRNO__INTERNAL, /* Internal error in libbpf */ 32 LIBBPF_ERRNO__RELOC, /* Relocation failed */ 33 LIBBPF_ERRNO__LOAD, /* Load program failure for unknown reason */ 34 LIBBPF_ERRNO__VERIFY, /* Kernel verifier blocks program loading */ 35 LIBBPF_ERRNO__PROG2BIG, /* Program too big */ 36 LIBBPF_ERRNO__KVER, /* Incorrect kernel version */ 37 LIBBPF_ERRNO__PROGTYPE, /* Kernel doesn't support this program type */ 38 LIBBPF_ERRNO__WRNGPID, /* Wrong pid in netlink message */ 39 LIBBPF_ERRNO__INVSEQ, /* Invalid netlink sequence */ 40 LIBBPF_ERRNO__NLPARSE, /* netlink parsing error */ 41 __LIBBPF_ERRNO__END, 42 }; 43 44 LIBBPF_API int libbpf_strerror(int err, char *buf, size_t size); 45 46 /* 47 * __printf is defined in include/linux/compiler-gcc.h. However, 48 * it would be better if libbpf.h didn't depend on Linux header files. 49 * So instead of __printf, here we use gcc attribute directly. 50 */ 51 typedef int (*libbpf_print_fn_t)(const char *, ...) 52 __attribute__((format(printf, 1, 2))); 53 54 LIBBPF_API void libbpf_set_print(libbpf_print_fn_t warn, 55 libbpf_print_fn_t info, 56 libbpf_print_fn_t debug); 57 58 /* Hide internal to user */ 59 struct bpf_object; 60 61 struct bpf_object_open_attr { 62 const char *file; 63 enum bpf_prog_type prog_type; 64 }; 65 66 LIBBPF_API struct bpf_object *bpf_object__open(const char *path); 67 LIBBPF_API struct bpf_object * 68 bpf_object__open_xattr(struct bpf_object_open_attr *attr); 69 struct bpf_object *__bpf_object__open_xattr(struct bpf_object_open_attr *attr, 70 int flags); 71 LIBBPF_API struct bpf_object *bpf_object__open_buffer(void *obj_buf, 72 size_t obj_buf_sz, 73 const char *name); 74 LIBBPF_API int bpf_object__pin_maps(struct bpf_object *obj, const char *path); 75 LIBBPF_API int bpf_object__unpin_maps(struct bpf_object *obj, 76 const char *path); 77 LIBBPF_API int bpf_object__pin_programs(struct bpf_object *obj, 78 const char *path); 79 LIBBPF_API int bpf_object__unpin_programs(struct bpf_object *obj, 80 const char *path); 81 LIBBPF_API int bpf_object__pin(struct bpf_object *object, const char *path); 82 LIBBPF_API void bpf_object__close(struct bpf_object *object); 83 84 /* Load/unload object into/from kernel */ 85 LIBBPF_API int bpf_object__load(struct bpf_object *obj); 86 LIBBPF_API int bpf_object__unload(struct bpf_object *obj); 87 LIBBPF_API const char *bpf_object__name(struct bpf_object *obj); 88 LIBBPF_API unsigned int bpf_object__kversion(struct bpf_object *obj); 89 LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj); 90 91 LIBBPF_API struct bpf_program * 92 bpf_object__find_program_by_title(struct bpf_object *obj, const char *title); 93 94 LIBBPF_API struct bpf_object *bpf_object__next(struct bpf_object *prev); 95 #define bpf_object__for_each_safe(pos, tmp) \ 96 for ((pos) = bpf_object__next(NULL), \ 97 (tmp) = bpf_object__next(pos); \ 98 (pos) != NULL; \ 99 (pos) = (tmp), (tmp) = bpf_object__next(tmp)) 100 101 typedef void (*bpf_object_clear_priv_t)(struct bpf_object *, void *); 102 LIBBPF_API int bpf_object__set_priv(struct bpf_object *obj, void *priv, 103 bpf_object_clear_priv_t clear_priv); 104 LIBBPF_API void *bpf_object__priv(struct bpf_object *prog); 105 106 LIBBPF_API int 107 libbpf_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type, 108 enum bpf_attach_type *expected_attach_type); 109 LIBBPF_API int libbpf_attach_type_by_name(const char *name, 110 enum bpf_attach_type *attach_type); 111 112 /* Accessors of bpf_program */ 113 struct bpf_program; 114 LIBBPF_API struct bpf_program *bpf_program__next(struct bpf_program *prog, 115 struct bpf_object *obj); 116 117 #define bpf_object__for_each_program(pos, obj) \ 118 for ((pos) = bpf_program__next(NULL, (obj)); \ 119 (pos) != NULL; \ 120 (pos) = bpf_program__next((pos), (obj))) 121 122 LIBBPF_API struct bpf_program *bpf_program__prev(struct bpf_program *prog, 123 struct bpf_object *obj); 124 125 typedef void (*bpf_program_clear_priv_t)(struct bpf_program *, 126 void *); 127 128 LIBBPF_API int bpf_program__set_priv(struct bpf_program *prog, void *priv, 129 bpf_program_clear_priv_t clear_priv); 130 131 LIBBPF_API void *bpf_program__priv(struct bpf_program *prog); 132 LIBBPF_API void bpf_program__set_ifindex(struct bpf_program *prog, 133 __u32 ifindex); 134 135 LIBBPF_API const char *bpf_program__title(struct bpf_program *prog, 136 bool needs_copy); 137 138 LIBBPF_API int bpf_program__load(struct bpf_program *prog, char *license, 139 __u32 kern_version); 140 LIBBPF_API int bpf_program__fd(struct bpf_program *prog); 141 LIBBPF_API int bpf_program__pin_instance(struct bpf_program *prog, 142 const char *path, 143 int instance); 144 LIBBPF_API int bpf_program__unpin_instance(struct bpf_program *prog, 145 const char *path, 146 int instance); 147 LIBBPF_API int bpf_program__pin(struct bpf_program *prog, const char *path); 148 LIBBPF_API int bpf_program__unpin(struct bpf_program *prog, const char *path); 149 LIBBPF_API void bpf_program__unload(struct bpf_program *prog); 150 151 struct bpf_insn; 152 153 /* 154 * Libbpf allows callers to adjust BPF programs before being loaded 155 * into kernel. One program in an object file can be transformed into 156 * multiple variants to be attached to different hooks. 157 * 158 * bpf_program_prep_t, bpf_program__set_prep and bpf_program__nth_fd 159 * form an API for this purpose. 160 * 161 * - bpf_program_prep_t: 162 * Defines a 'preprocessor', which is a caller defined function 163 * passed to libbpf through bpf_program__set_prep(), and will be 164 * called before program is loaded. The processor should adjust 165 * the program one time for each instance according to the instance id 166 * passed to it. 167 * 168 * - bpf_program__set_prep: 169 * Attaches a preprocessor to a BPF program. The number of instances 170 * that should be created is also passed through this function. 171 * 172 * - bpf_program__nth_fd: 173 * After the program is loaded, get resulting FD of a given instance 174 * of the BPF program. 175 * 176 * If bpf_program__set_prep() is not used, the program would be loaded 177 * without adjustment during bpf_object__load(). The program has only 178 * one instance. In this case bpf_program__fd(prog) is equal to 179 * bpf_program__nth_fd(prog, 0). 180 */ 181 182 struct bpf_prog_prep_result { 183 /* 184 * If not NULL, load new instruction array. 185 * If set to NULL, don't load this instance. 186 */ 187 struct bpf_insn *new_insn_ptr; 188 int new_insn_cnt; 189 190 /* If not NULL, result FD is written to it. */ 191 int *pfd; 192 }; 193 194 /* 195 * Parameters of bpf_program_prep_t: 196 * - prog: The bpf_program being loaded. 197 * - n: Index of instance being generated. 198 * - insns: BPF instructions array. 199 * - insns_cnt:Number of instructions in insns. 200 * - res: Output parameter, result of transformation. 201 * 202 * Return value: 203 * - Zero: pre-processing success. 204 * - Non-zero: pre-processing error, stop loading. 205 */ 206 typedef int (*bpf_program_prep_t)(struct bpf_program *prog, int n, 207 struct bpf_insn *insns, int insns_cnt, 208 struct bpf_prog_prep_result *res); 209 210 LIBBPF_API int bpf_program__set_prep(struct bpf_program *prog, int nr_instance, 211 bpf_program_prep_t prep); 212 213 LIBBPF_API int bpf_program__nth_fd(struct bpf_program *prog, int n); 214 215 /* 216 * Adjust type of BPF program. Default is kprobe. 217 */ 218 LIBBPF_API int bpf_program__set_socket_filter(struct bpf_program *prog); 219 LIBBPF_API int bpf_program__set_tracepoint(struct bpf_program *prog); 220 LIBBPF_API int bpf_program__set_raw_tracepoint(struct bpf_program *prog); 221 LIBBPF_API int bpf_program__set_kprobe(struct bpf_program *prog); 222 LIBBPF_API int bpf_program__set_sched_cls(struct bpf_program *prog); 223 LIBBPF_API int bpf_program__set_sched_act(struct bpf_program *prog); 224 LIBBPF_API int bpf_program__set_xdp(struct bpf_program *prog); 225 LIBBPF_API int bpf_program__set_perf_event(struct bpf_program *prog); 226 LIBBPF_API void bpf_program__set_type(struct bpf_program *prog, 227 enum bpf_prog_type type); 228 LIBBPF_API void 229 bpf_program__set_expected_attach_type(struct bpf_program *prog, 230 enum bpf_attach_type type); 231 232 LIBBPF_API bool bpf_program__is_socket_filter(struct bpf_program *prog); 233 LIBBPF_API bool bpf_program__is_tracepoint(struct bpf_program *prog); 234 LIBBPF_API bool bpf_program__is_raw_tracepoint(struct bpf_program *prog); 235 LIBBPF_API bool bpf_program__is_kprobe(struct bpf_program *prog); 236 LIBBPF_API bool bpf_program__is_sched_cls(struct bpf_program *prog); 237 LIBBPF_API bool bpf_program__is_sched_act(struct bpf_program *prog); 238 LIBBPF_API bool bpf_program__is_xdp(struct bpf_program *prog); 239 LIBBPF_API bool bpf_program__is_perf_event(struct bpf_program *prog); 240 241 /* 242 * No need for __attribute__((packed)), all members of 'bpf_map_def' 243 * are all aligned. In addition, using __attribute__((packed)) 244 * would trigger a -Wpacked warning message, and lead to an error 245 * if -Werror is set. 246 */ 247 struct bpf_map_def { 248 unsigned int type; 249 unsigned int key_size; 250 unsigned int value_size; 251 unsigned int max_entries; 252 unsigned int map_flags; 253 }; 254 255 /* 256 * The 'struct bpf_map' in include/linux/bpf.h is internal to the kernel, 257 * so no need to worry about a name clash. 258 */ 259 struct bpf_map; 260 LIBBPF_API struct bpf_map * 261 bpf_object__find_map_by_name(struct bpf_object *obj, const char *name); 262 263 /* 264 * Get bpf_map through the offset of corresponding struct bpf_map_def 265 * in the BPF object file. 266 */ 267 LIBBPF_API struct bpf_map * 268 bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset); 269 270 LIBBPF_API struct bpf_map * 271 bpf_map__next(struct bpf_map *map, struct bpf_object *obj); 272 #define bpf_map__for_each(pos, obj) \ 273 for ((pos) = bpf_map__next(NULL, (obj)); \ 274 (pos) != NULL; \ 275 (pos) = bpf_map__next((pos), (obj))) 276 277 LIBBPF_API struct bpf_map * 278 bpf_map__prev(struct bpf_map *map, struct bpf_object *obj); 279 280 LIBBPF_API int bpf_map__fd(struct bpf_map *map); 281 LIBBPF_API const struct bpf_map_def *bpf_map__def(struct bpf_map *map); 282 LIBBPF_API const char *bpf_map__name(struct bpf_map *map); 283 LIBBPF_API __u32 bpf_map__btf_key_type_id(const struct bpf_map *map); 284 LIBBPF_API __u32 bpf_map__btf_value_type_id(const struct bpf_map *map); 285 286 typedef void (*bpf_map_clear_priv_t)(struct bpf_map *, void *); 287 LIBBPF_API int bpf_map__set_priv(struct bpf_map *map, void *priv, 288 bpf_map_clear_priv_t clear_priv); 289 LIBBPF_API void *bpf_map__priv(struct bpf_map *map); 290 LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd); 291 LIBBPF_API bool bpf_map__is_offload_neutral(struct bpf_map *map); 292 LIBBPF_API void bpf_map__set_ifindex(struct bpf_map *map, __u32 ifindex); 293 LIBBPF_API int bpf_map__pin(struct bpf_map *map, const char *path); 294 LIBBPF_API int bpf_map__unpin(struct bpf_map *map, const char *path); 295 296 LIBBPF_API long libbpf_get_error(const void *ptr); 297 298 struct bpf_prog_load_attr { 299 const char *file; 300 enum bpf_prog_type prog_type; 301 enum bpf_attach_type expected_attach_type; 302 int ifindex; 303 }; 304 305 LIBBPF_API int bpf_prog_load_xattr(const struct bpf_prog_load_attr *attr, 306 struct bpf_object **pobj, int *prog_fd); 307 LIBBPF_API int bpf_prog_load(const char *file, enum bpf_prog_type type, 308 struct bpf_object **pobj, int *prog_fd); 309 310 LIBBPF_API int bpf_set_link_xdp_fd(int ifindex, int fd, __u32 flags); 311 312 enum bpf_perf_event_ret { 313 LIBBPF_PERF_EVENT_DONE = 0, 314 LIBBPF_PERF_EVENT_ERROR = -1, 315 LIBBPF_PERF_EVENT_CONT = -2, 316 }; 317 318 struct perf_event_header; 319 typedef enum bpf_perf_event_ret 320 (*bpf_perf_event_print_t)(struct perf_event_header *hdr, 321 void *private_data); 322 LIBBPF_API enum bpf_perf_event_ret 323 bpf_perf_event_read_simple(void *mmap_mem, size_t mmap_size, size_t page_size, 324 void **copy_mem, size_t *copy_size, 325 bpf_perf_event_print_t fn, void *private_data); 326 327 struct nlattr; 328 typedef int (*libbpf_dump_nlmsg_t)(void *cookie, void *msg, struct nlattr **tb); 329 int libbpf_netlink_open(unsigned int *nl_pid); 330 int libbpf_nl_get_link(int sock, unsigned int nl_pid, 331 libbpf_dump_nlmsg_t dump_link_nlmsg, void *cookie); 332 int libbpf_nl_get_class(int sock, unsigned int nl_pid, int ifindex, 333 libbpf_dump_nlmsg_t dump_class_nlmsg, void *cookie); 334 int libbpf_nl_get_qdisc(int sock, unsigned int nl_pid, int ifindex, 335 libbpf_dump_nlmsg_t dump_qdisc_nlmsg, void *cookie); 336 int libbpf_nl_get_filter(int sock, unsigned int nl_pid, int ifindex, int handle, 337 libbpf_dump_nlmsg_t dump_filter_nlmsg, void *cookie); 338 #endif /* __LIBBPF_LIBBPF_H */ 339