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