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 enum libbpf_errno { 28 __LIBBPF_ERRNO__START = 4000, 29 30 /* Something wrong in libelf */ 31 LIBBPF_ERRNO__LIBELF = __LIBBPF_ERRNO__START, 32 LIBBPF_ERRNO__FORMAT, /* BPF object format invalid */ 33 LIBBPF_ERRNO__KVERSION, /* Incorrect or no 'version' section */ 34 LIBBPF_ERRNO__ENDIAN, /* Endian mismatch */ 35 LIBBPF_ERRNO__INTERNAL, /* Internal error in libbpf */ 36 LIBBPF_ERRNO__RELOC, /* Relocation failed */ 37 LIBBPF_ERRNO__LOAD, /* Load program failure for unknown reason */ 38 LIBBPF_ERRNO__VERIFY, /* Kernel verifier blocks program loading */ 39 LIBBPF_ERRNO__PROG2BIG, /* Program too big */ 40 LIBBPF_ERRNO__KVER, /* Incorrect kernel version */ 41 LIBBPF_ERRNO__PROGTYPE, /* Kernel doesn't support this program type */ 42 LIBBPF_ERRNO__WRNGPID, /* Wrong pid in netlink message */ 43 LIBBPF_ERRNO__INVSEQ, /* Invalid netlink sequence */ 44 LIBBPF_ERRNO__NLPARSE, /* netlink parsing error */ 45 __LIBBPF_ERRNO__END, 46 }; 47 48 LIBBPF_API int libbpf_strerror(int err, char *buf, size_t size); 49 50 enum libbpf_print_level { 51 LIBBPF_WARN, 52 LIBBPF_INFO, 53 LIBBPF_DEBUG, 54 }; 55 56 typedef int (*libbpf_print_fn_t)(enum libbpf_print_level level, 57 const char *, va_list ap); 58 59 LIBBPF_API libbpf_print_fn_t libbpf_set_print(libbpf_print_fn_t fn); 60 61 /* Hide internal to user */ 62 struct bpf_object; 63 64 struct bpf_object_open_attr { 65 const char *file; 66 enum bpf_prog_type prog_type; 67 }; 68 69 struct bpf_object_open_opts { 70 /* size of this struct, for forward/backward compatiblity */ 71 size_t sz; 72 /* object name override, if provided: 73 * - for object open from file, this will override setting object 74 * name from file path's base name; 75 * - for object open from memory buffer, this will specify an object 76 * name and will override default "<addr>-<buf-size>" name; 77 */ 78 const char *object_name; 79 /* parse map definitions non-strictly, allowing extra attributes/data */ 80 bool relaxed_maps; 81 /* DEPRECATED: handle CO-RE relocations non-strictly, allowing failures. 82 * Value is ignored. Relocations always are processed non-strictly. 83 * Non-relocatable instructions are replaced with invalid ones to 84 * prevent accidental errors. 85 * */ 86 LIBBPF_DEPRECATED_SINCE(0, 6, "field has no effect") 87 bool relaxed_core_relocs; 88 /* maps that set the 'pinning' attribute in their definition will have 89 * their pin_path attribute set to a file in this directory, and be 90 * auto-pinned to that path on load; defaults to "/sys/fs/bpf". 91 */ 92 const char *pin_root_path; 93 94 LIBBPF_DEPRECATED_SINCE(0, 7, "use bpf_program__set_attach_target() on each individual bpf_program") 95 __u32 attach_prog_fd; 96 /* Additional kernel config content that augments and overrides 97 * system Kconfig for CONFIG_xxx externs. 98 */ 99 const char *kconfig; 100 /* Path to the custom BTF to be used for BPF CO-RE relocations. 101 * This custom BTF completely replaces the use of vmlinux BTF 102 * for the purpose of CO-RE relocations. 103 * NOTE: any other BPF feature (e.g., fentry/fexit programs, 104 * struct_ops, etc) will need actual kernel BTF at /sys/kernel/btf/vmlinux. 105 */ 106 const char *btf_custom_path; 107 }; 108 #define bpf_object_open_opts__last_field btf_custom_path 109 110 LIBBPF_API struct bpf_object *bpf_object__open(const char *path); 111 LIBBPF_API struct bpf_object * 112 bpf_object__open_file(const char *path, const struct bpf_object_open_opts *opts); 113 LIBBPF_API struct bpf_object * 114 bpf_object__open_mem(const void *obj_buf, size_t obj_buf_sz, 115 const struct bpf_object_open_opts *opts); 116 117 /* deprecated bpf_object__open variants */ 118 LIBBPF_API struct bpf_object * 119 bpf_object__open_buffer(const void *obj_buf, size_t obj_buf_sz, 120 const char *name); 121 LIBBPF_API struct bpf_object * 122 bpf_object__open_xattr(struct bpf_object_open_attr *attr); 123 124 enum libbpf_pin_type { 125 LIBBPF_PIN_NONE, 126 /* PIN_BY_NAME: pin maps by name (in /sys/fs/bpf by default) */ 127 LIBBPF_PIN_BY_NAME, 128 }; 129 130 /* pin_maps and unpin_maps can both be called with a NULL path, in which case 131 * they will use the pin_path attribute of each map (and ignore all maps that 132 * don't have a pin_path set). 133 */ 134 LIBBPF_API int bpf_object__pin_maps(struct bpf_object *obj, const char *path); 135 LIBBPF_API int bpf_object__unpin_maps(struct bpf_object *obj, 136 const char *path); 137 LIBBPF_API int bpf_object__pin_programs(struct bpf_object *obj, 138 const char *path); 139 LIBBPF_API int bpf_object__unpin_programs(struct bpf_object *obj, 140 const char *path); 141 LIBBPF_API int bpf_object__pin(struct bpf_object *object, const char *path); 142 LIBBPF_API void bpf_object__close(struct bpf_object *object); 143 144 struct bpf_object_load_attr { 145 struct bpf_object *obj; 146 int log_level; 147 const char *target_btf_path; 148 }; 149 150 /* Load/unload object into/from kernel */ 151 LIBBPF_API int bpf_object__load(struct bpf_object *obj); 152 LIBBPF_API int bpf_object__load_xattr(struct bpf_object_load_attr *attr); 153 LIBBPF_API int bpf_object__unload(struct bpf_object *obj); 154 155 LIBBPF_API const char *bpf_object__name(const struct bpf_object *obj); 156 LIBBPF_API unsigned int bpf_object__kversion(const struct bpf_object *obj); 157 LIBBPF_API int bpf_object__set_kversion(struct bpf_object *obj, __u32 kern_version); 158 159 struct btf; 160 LIBBPF_API struct btf *bpf_object__btf(const struct bpf_object *obj); 161 LIBBPF_API int bpf_object__btf_fd(const struct bpf_object *obj); 162 163 LIBBPF_API struct bpf_program * 164 bpf_object__find_program_by_title(const struct bpf_object *obj, 165 const char *title); 166 LIBBPF_API struct bpf_program * 167 bpf_object__find_program_by_name(const struct bpf_object *obj, 168 const char *name); 169 170 LIBBPF_API struct bpf_object *bpf_object__next(struct bpf_object *prev); 171 #define bpf_object__for_each_safe(pos, tmp) \ 172 for ((pos) = bpf_object__next(NULL), \ 173 (tmp) = bpf_object__next(pos); \ 174 (pos) != NULL; \ 175 (pos) = (tmp), (tmp) = bpf_object__next(tmp)) 176 177 typedef void (*bpf_object_clear_priv_t)(struct bpf_object *, void *); 178 LIBBPF_API int bpf_object__set_priv(struct bpf_object *obj, void *priv, 179 bpf_object_clear_priv_t clear_priv); 180 LIBBPF_API void *bpf_object__priv(const struct bpf_object *prog); 181 182 LIBBPF_API int 183 libbpf_prog_type_by_name(const char *name, enum bpf_prog_type *prog_type, 184 enum bpf_attach_type *expected_attach_type); 185 LIBBPF_API int libbpf_attach_type_by_name(const char *name, 186 enum bpf_attach_type *attach_type); 187 LIBBPF_API int libbpf_find_vmlinux_btf_id(const char *name, 188 enum bpf_attach_type attach_type); 189 190 /* Accessors of bpf_program */ 191 struct bpf_program; 192 LIBBPF_API struct bpf_program *bpf_program__next(struct bpf_program *prog, 193 const struct bpf_object *obj); 194 195 #define bpf_object__for_each_program(pos, obj) \ 196 for ((pos) = bpf_program__next(NULL, (obj)); \ 197 (pos) != NULL; \ 198 (pos) = bpf_program__next((pos), (obj))) 199 200 LIBBPF_API struct bpf_program *bpf_program__prev(struct bpf_program *prog, 201 const struct bpf_object *obj); 202 203 typedef void (*bpf_program_clear_priv_t)(struct bpf_program *, void *); 204 205 LIBBPF_API int bpf_program__set_priv(struct bpf_program *prog, void *priv, 206 bpf_program_clear_priv_t clear_priv); 207 208 LIBBPF_API void *bpf_program__priv(const struct bpf_program *prog); 209 LIBBPF_API void bpf_program__set_ifindex(struct bpf_program *prog, 210 __u32 ifindex); 211 212 LIBBPF_API const char *bpf_program__name(const struct bpf_program *prog); 213 LIBBPF_API const char *bpf_program__section_name(const struct bpf_program *prog); 214 LIBBPF_API LIBBPF_DEPRECATED("BPF program title is confusing term; please use bpf_program__section_name() instead") 215 const char *bpf_program__title(const struct bpf_program *prog, bool needs_copy); 216 LIBBPF_API bool bpf_program__autoload(const struct bpf_program *prog); 217 LIBBPF_API int bpf_program__set_autoload(struct bpf_program *prog, bool autoload); 218 219 /* returns program size in bytes */ 220 LIBBPF_API size_t bpf_program__size(const struct bpf_program *prog); 221 222 LIBBPF_API int bpf_program__load(struct bpf_program *prog, char *license, 223 __u32 kern_version); 224 LIBBPF_API int bpf_program__fd(const struct bpf_program *prog); 225 LIBBPF_API int bpf_program__pin_instance(struct bpf_program *prog, 226 const char *path, 227 int instance); 228 LIBBPF_API int bpf_program__unpin_instance(struct bpf_program *prog, 229 const char *path, 230 int instance); 231 LIBBPF_API int bpf_program__pin(struct bpf_program *prog, const char *path); 232 LIBBPF_API int bpf_program__unpin(struct bpf_program *prog, const char *path); 233 LIBBPF_API void bpf_program__unload(struct bpf_program *prog); 234 235 struct bpf_link; 236 237 LIBBPF_API struct bpf_link *bpf_link__open(const char *path); 238 LIBBPF_API int bpf_link__fd(const struct bpf_link *link); 239 LIBBPF_API const char *bpf_link__pin_path(const struct bpf_link *link); 240 LIBBPF_API int bpf_link__pin(struct bpf_link *link, const char *path); 241 LIBBPF_API int bpf_link__unpin(struct bpf_link *link); 242 LIBBPF_API int bpf_link__update_program(struct bpf_link *link, 243 struct bpf_program *prog); 244 LIBBPF_API void bpf_link__disconnect(struct bpf_link *link); 245 LIBBPF_API int bpf_link__detach(struct bpf_link *link); 246 LIBBPF_API int bpf_link__destroy(struct bpf_link *link); 247 248 LIBBPF_API struct bpf_link * 249 bpf_program__attach(const struct bpf_program *prog); 250 251 struct bpf_perf_event_opts { 252 /* size of this struct, for forward/backward compatiblity */ 253 size_t sz; 254 /* custom user-provided value fetchable through bpf_get_attach_cookie() */ 255 __u64 bpf_cookie; 256 }; 257 #define bpf_perf_event_opts__last_field bpf_cookie 258 259 LIBBPF_API struct bpf_link * 260 bpf_program__attach_perf_event(const struct bpf_program *prog, int pfd); 261 262 LIBBPF_API struct bpf_link * 263 bpf_program__attach_perf_event_opts(const struct bpf_program *prog, int pfd, 264 const struct bpf_perf_event_opts *opts); 265 266 struct bpf_kprobe_opts { 267 /* size of this struct, for forward/backward compatiblity */ 268 size_t sz; 269 /* custom user-provided value fetchable through bpf_get_attach_cookie() */ 270 __u64 bpf_cookie; 271 /* function's offset to install kprobe to */ 272 unsigned long offset; 273 /* kprobe is return probe */ 274 bool retprobe; 275 size_t :0; 276 }; 277 #define bpf_kprobe_opts__last_field retprobe 278 279 LIBBPF_API struct bpf_link * 280 bpf_program__attach_kprobe(const struct bpf_program *prog, bool retprobe, 281 const char *func_name); 282 LIBBPF_API struct bpf_link * 283 bpf_program__attach_kprobe_opts(const struct bpf_program *prog, 284 const char *func_name, 285 const struct bpf_kprobe_opts *opts); 286 287 struct bpf_uprobe_opts { 288 /* size of this struct, for forward/backward compatiblity */ 289 size_t sz; 290 /* offset of kernel reference counted USDT semaphore, added in 291 * a6ca88b241d5 ("trace_uprobe: support reference counter in fd-based uprobe") 292 */ 293 size_t ref_ctr_offset; 294 /* custom user-provided value fetchable through bpf_get_attach_cookie() */ 295 __u64 bpf_cookie; 296 /* uprobe is return probe, invoked at function return time */ 297 bool retprobe; 298 size_t :0; 299 }; 300 #define bpf_uprobe_opts__last_field retprobe 301 302 LIBBPF_API struct bpf_link * 303 bpf_program__attach_uprobe(const struct bpf_program *prog, bool retprobe, 304 pid_t pid, const char *binary_path, 305 size_t func_offset); 306 LIBBPF_API struct bpf_link * 307 bpf_program__attach_uprobe_opts(const struct bpf_program *prog, pid_t pid, 308 const char *binary_path, size_t func_offset, 309 const struct bpf_uprobe_opts *opts); 310 311 struct bpf_tracepoint_opts { 312 /* size of this struct, for forward/backward compatiblity */ 313 size_t sz; 314 /* custom user-provided value fetchable through bpf_get_attach_cookie() */ 315 __u64 bpf_cookie; 316 }; 317 #define bpf_tracepoint_opts__last_field bpf_cookie 318 319 LIBBPF_API struct bpf_link * 320 bpf_program__attach_tracepoint(const struct bpf_program *prog, 321 const char *tp_category, 322 const char *tp_name); 323 LIBBPF_API struct bpf_link * 324 bpf_program__attach_tracepoint_opts(const struct bpf_program *prog, 325 const char *tp_category, 326 const char *tp_name, 327 const struct bpf_tracepoint_opts *opts); 328 329 LIBBPF_API struct bpf_link * 330 bpf_program__attach_raw_tracepoint(const struct bpf_program *prog, 331 const char *tp_name); 332 LIBBPF_API struct bpf_link * 333 bpf_program__attach_trace(const struct bpf_program *prog); 334 LIBBPF_API struct bpf_link * 335 bpf_program__attach_lsm(const struct bpf_program *prog); 336 LIBBPF_API struct bpf_link * 337 bpf_program__attach_cgroup(const struct bpf_program *prog, int cgroup_fd); 338 LIBBPF_API struct bpf_link * 339 bpf_program__attach_netns(const struct bpf_program *prog, int netns_fd); 340 LIBBPF_API struct bpf_link * 341 bpf_program__attach_xdp(const struct bpf_program *prog, int ifindex); 342 LIBBPF_API struct bpf_link * 343 bpf_program__attach_freplace(const struct bpf_program *prog, 344 int target_fd, const char *attach_func_name); 345 346 struct bpf_map; 347 348 LIBBPF_API struct bpf_link *bpf_map__attach_struct_ops(const struct bpf_map *map); 349 350 struct bpf_iter_attach_opts { 351 size_t sz; /* size of this struct for forward/backward compatibility */ 352 union bpf_iter_link_info *link_info; 353 __u32 link_info_len; 354 }; 355 #define bpf_iter_attach_opts__last_field link_info_len 356 357 LIBBPF_API struct bpf_link * 358 bpf_program__attach_iter(const struct bpf_program *prog, 359 const struct bpf_iter_attach_opts *opts); 360 361 struct bpf_insn; 362 363 /* 364 * Libbpf allows callers to adjust BPF programs before being loaded 365 * into kernel. One program in an object file can be transformed into 366 * multiple variants to be attached to different hooks. 367 * 368 * bpf_program_prep_t, bpf_program__set_prep and bpf_program__nth_fd 369 * form an API for this purpose. 370 * 371 * - bpf_program_prep_t: 372 * Defines a 'preprocessor', which is a caller defined function 373 * passed to libbpf through bpf_program__set_prep(), and will be 374 * called before program is loaded. The processor should adjust 375 * the program one time for each instance according to the instance id 376 * passed to it. 377 * 378 * - bpf_program__set_prep: 379 * Attaches a preprocessor to a BPF program. The number of instances 380 * that should be created is also passed through this function. 381 * 382 * - bpf_program__nth_fd: 383 * After the program is loaded, get resulting FD of a given instance 384 * of the BPF program. 385 * 386 * If bpf_program__set_prep() is not used, the program would be loaded 387 * without adjustment during bpf_object__load(). The program has only 388 * one instance. In this case bpf_program__fd(prog) is equal to 389 * bpf_program__nth_fd(prog, 0). 390 */ 391 392 struct bpf_prog_prep_result { 393 /* 394 * If not NULL, load new instruction array. 395 * If set to NULL, don't load this instance. 396 */ 397 struct bpf_insn *new_insn_ptr; 398 int new_insn_cnt; 399 400 /* If not NULL, result FD is written to it. */ 401 int *pfd; 402 }; 403 404 /* 405 * Parameters of bpf_program_prep_t: 406 * - prog: The bpf_program being loaded. 407 * - n: Index of instance being generated. 408 * - insns: BPF instructions array. 409 * - insns_cnt:Number of instructions in insns. 410 * - res: Output parameter, result of transformation. 411 * 412 * Return value: 413 * - Zero: pre-processing success. 414 * - Non-zero: pre-processing error, stop loading. 415 */ 416 typedef int (*bpf_program_prep_t)(struct bpf_program *prog, int n, 417 struct bpf_insn *insns, int insns_cnt, 418 struct bpf_prog_prep_result *res); 419 420 LIBBPF_API int bpf_program__set_prep(struct bpf_program *prog, int nr_instance, 421 bpf_program_prep_t prep); 422 423 LIBBPF_API int bpf_program__nth_fd(const struct bpf_program *prog, int n); 424 425 /* 426 * Adjust type of BPF program. Default is kprobe. 427 */ 428 LIBBPF_API int bpf_program__set_socket_filter(struct bpf_program *prog); 429 LIBBPF_API int bpf_program__set_tracepoint(struct bpf_program *prog); 430 LIBBPF_API int bpf_program__set_raw_tracepoint(struct bpf_program *prog); 431 LIBBPF_API int bpf_program__set_kprobe(struct bpf_program *prog); 432 LIBBPF_API int bpf_program__set_lsm(struct bpf_program *prog); 433 LIBBPF_API int bpf_program__set_sched_cls(struct bpf_program *prog); 434 LIBBPF_API int bpf_program__set_sched_act(struct bpf_program *prog); 435 LIBBPF_API int bpf_program__set_xdp(struct bpf_program *prog); 436 LIBBPF_API int bpf_program__set_perf_event(struct bpf_program *prog); 437 LIBBPF_API int bpf_program__set_tracing(struct bpf_program *prog); 438 LIBBPF_API int bpf_program__set_struct_ops(struct bpf_program *prog); 439 LIBBPF_API int bpf_program__set_extension(struct bpf_program *prog); 440 LIBBPF_API int bpf_program__set_sk_lookup(struct bpf_program *prog); 441 442 LIBBPF_API enum bpf_prog_type bpf_program__get_type(const struct bpf_program *prog); 443 LIBBPF_API void bpf_program__set_type(struct bpf_program *prog, 444 enum bpf_prog_type type); 445 446 LIBBPF_API enum bpf_attach_type 447 bpf_program__get_expected_attach_type(const struct bpf_program *prog); 448 LIBBPF_API void 449 bpf_program__set_expected_attach_type(struct bpf_program *prog, 450 enum bpf_attach_type type); 451 452 LIBBPF_API int 453 bpf_program__set_attach_target(struct bpf_program *prog, int attach_prog_fd, 454 const char *attach_func_name); 455 456 LIBBPF_API bool bpf_program__is_socket_filter(const struct bpf_program *prog); 457 LIBBPF_API bool bpf_program__is_tracepoint(const struct bpf_program *prog); 458 LIBBPF_API bool bpf_program__is_raw_tracepoint(const struct bpf_program *prog); 459 LIBBPF_API bool bpf_program__is_kprobe(const struct bpf_program *prog); 460 LIBBPF_API bool bpf_program__is_lsm(const struct bpf_program *prog); 461 LIBBPF_API bool bpf_program__is_sched_cls(const struct bpf_program *prog); 462 LIBBPF_API bool bpf_program__is_sched_act(const struct bpf_program *prog); 463 LIBBPF_API bool bpf_program__is_xdp(const struct bpf_program *prog); 464 LIBBPF_API bool bpf_program__is_perf_event(const struct bpf_program *prog); 465 LIBBPF_API bool bpf_program__is_tracing(const struct bpf_program *prog); 466 LIBBPF_API bool bpf_program__is_struct_ops(const struct bpf_program *prog); 467 LIBBPF_API bool bpf_program__is_extension(const struct bpf_program *prog); 468 LIBBPF_API bool bpf_program__is_sk_lookup(const struct bpf_program *prog); 469 470 /* 471 * No need for __attribute__((packed)), all members of 'bpf_map_def' 472 * are all aligned. In addition, using __attribute__((packed)) 473 * would trigger a -Wpacked warning message, and lead to an error 474 * if -Werror is set. 475 */ 476 struct bpf_map_def { 477 unsigned int type; 478 unsigned int key_size; 479 unsigned int value_size; 480 unsigned int max_entries; 481 unsigned int map_flags; 482 }; 483 484 /* 485 * The 'struct bpf_map' in include/linux/bpf.h is internal to the kernel, 486 * so no need to worry about a name clash. 487 */ 488 LIBBPF_API struct bpf_map * 489 bpf_object__find_map_by_name(const struct bpf_object *obj, const char *name); 490 491 LIBBPF_API int 492 bpf_object__find_map_fd_by_name(const struct bpf_object *obj, const char *name); 493 494 /* 495 * Get bpf_map through the offset of corresponding struct bpf_map_def 496 * in the BPF object file. 497 */ 498 LIBBPF_API struct bpf_map * 499 bpf_object__find_map_by_offset(struct bpf_object *obj, size_t offset); 500 501 LIBBPF_API struct bpf_map * 502 bpf_map__next(const struct bpf_map *map, const struct bpf_object *obj); 503 #define bpf_object__for_each_map(pos, obj) \ 504 for ((pos) = bpf_map__next(NULL, (obj)); \ 505 (pos) != NULL; \ 506 (pos) = bpf_map__next((pos), (obj))) 507 #define bpf_map__for_each bpf_object__for_each_map 508 509 LIBBPF_API struct bpf_map * 510 bpf_map__prev(const struct bpf_map *map, const struct bpf_object *obj); 511 512 /* get/set map FD */ 513 LIBBPF_API int bpf_map__fd(const struct bpf_map *map); 514 LIBBPF_API int bpf_map__reuse_fd(struct bpf_map *map, int fd); 515 /* get map definition */ 516 LIBBPF_API const struct bpf_map_def *bpf_map__def(const struct bpf_map *map); 517 /* get map name */ 518 LIBBPF_API const char *bpf_map__name(const struct bpf_map *map); 519 /* get/set map type */ 520 LIBBPF_API enum bpf_map_type bpf_map__type(const struct bpf_map *map); 521 LIBBPF_API int bpf_map__set_type(struct bpf_map *map, enum bpf_map_type type); 522 /* get/set map size (max_entries) */ 523 LIBBPF_API __u32 bpf_map__max_entries(const struct bpf_map *map); 524 LIBBPF_API int bpf_map__set_max_entries(struct bpf_map *map, __u32 max_entries); 525 LIBBPF_API int bpf_map__resize(struct bpf_map *map, __u32 max_entries); 526 /* get/set map flags */ 527 LIBBPF_API __u32 bpf_map__map_flags(const struct bpf_map *map); 528 LIBBPF_API int bpf_map__set_map_flags(struct bpf_map *map, __u32 flags); 529 /* get/set map NUMA node */ 530 LIBBPF_API __u32 bpf_map__numa_node(const struct bpf_map *map); 531 LIBBPF_API int bpf_map__set_numa_node(struct bpf_map *map, __u32 numa_node); 532 /* get/set map key size */ 533 LIBBPF_API __u32 bpf_map__key_size(const struct bpf_map *map); 534 LIBBPF_API int bpf_map__set_key_size(struct bpf_map *map, __u32 size); 535 /* get/set map value size */ 536 LIBBPF_API __u32 bpf_map__value_size(const struct bpf_map *map); 537 LIBBPF_API int bpf_map__set_value_size(struct bpf_map *map, __u32 size); 538 /* get map key/value BTF type IDs */ 539 LIBBPF_API __u32 bpf_map__btf_key_type_id(const struct bpf_map *map); 540 LIBBPF_API __u32 bpf_map__btf_value_type_id(const struct bpf_map *map); 541 /* get/set map if_index */ 542 LIBBPF_API __u32 bpf_map__ifindex(const struct bpf_map *map); 543 LIBBPF_API int bpf_map__set_ifindex(struct bpf_map *map, __u32 ifindex); 544 545 typedef void (*bpf_map_clear_priv_t)(struct bpf_map *, void *); 546 LIBBPF_API int bpf_map__set_priv(struct bpf_map *map, void *priv, 547 bpf_map_clear_priv_t clear_priv); 548 LIBBPF_API void *bpf_map__priv(const struct bpf_map *map); 549 LIBBPF_API int bpf_map__set_initial_value(struct bpf_map *map, 550 const void *data, size_t size); 551 LIBBPF_API const void *bpf_map__initial_value(struct bpf_map *map, size_t *psize); 552 LIBBPF_API bool bpf_map__is_offload_neutral(const struct bpf_map *map); 553 LIBBPF_API bool bpf_map__is_internal(const struct bpf_map *map); 554 LIBBPF_API int bpf_map__set_pin_path(struct bpf_map *map, const char *path); 555 LIBBPF_API const char *bpf_map__get_pin_path(const struct bpf_map *map); 556 LIBBPF_API const char *bpf_map__pin_path(const struct bpf_map *map); 557 LIBBPF_API bool bpf_map__is_pinned(const struct bpf_map *map); 558 LIBBPF_API int bpf_map__pin(struct bpf_map *map, const char *path); 559 LIBBPF_API int bpf_map__unpin(struct bpf_map *map, const char *path); 560 561 LIBBPF_API int bpf_map__set_inner_map_fd(struct bpf_map *map, int fd); 562 LIBBPF_API struct bpf_map *bpf_map__inner_map(struct bpf_map *map); 563 564 LIBBPF_API long libbpf_get_error(const void *ptr); 565 566 struct bpf_prog_load_attr { 567 const char *file; 568 enum bpf_prog_type prog_type; 569 enum bpf_attach_type expected_attach_type; 570 int ifindex; 571 int log_level; 572 int prog_flags; 573 }; 574 575 LIBBPF_API int bpf_prog_load_xattr(const struct bpf_prog_load_attr *attr, 576 struct bpf_object **pobj, int *prog_fd); 577 LIBBPF_API int bpf_prog_load(const char *file, enum bpf_prog_type type, 578 struct bpf_object **pobj, int *prog_fd); 579 580 /* XDP related API */ 581 struct xdp_link_info { 582 __u32 prog_id; 583 __u32 drv_prog_id; 584 __u32 hw_prog_id; 585 __u32 skb_prog_id; 586 __u8 attach_mode; 587 }; 588 589 struct bpf_xdp_set_link_opts { 590 size_t sz; 591 int old_fd; 592 size_t :0; 593 }; 594 #define bpf_xdp_set_link_opts__last_field old_fd 595 596 LIBBPF_API int bpf_set_link_xdp_fd(int ifindex, int fd, __u32 flags); 597 LIBBPF_API int bpf_set_link_xdp_fd_opts(int ifindex, int fd, __u32 flags, 598 const struct bpf_xdp_set_link_opts *opts); 599 LIBBPF_API int bpf_get_link_xdp_id(int ifindex, __u32 *prog_id, __u32 flags); 600 LIBBPF_API int bpf_get_link_xdp_info(int ifindex, struct xdp_link_info *info, 601 size_t info_size, __u32 flags); 602 603 /* TC related API */ 604 enum bpf_tc_attach_point { 605 BPF_TC_INGRESS = 1 << 0, 606 BPF_TC_EGRESS = 1 << 1, 607 BPF_TC_CUSTOM = 1 << 2, 608 }; 609 610 #define BPF_TC_PARENT(a, b) \ 611 ((((a) << 16) & 0xFFFF0000U) | ((b) & 0x0000FFFFU)) 612 613 enum bpf_tc_flags { 614 BPF_TC_F_REPLACE = 1 << 0, 615 }; 616 617 struct bpf_tc_hook { 618 size_t sz; 619 int ifindex; 620 enum bpf_tc_attach_point attach_point; 621 __u32 parent; 622 size_t :0; 623 }; 624 #define bpf_tc_hook__last_field parent 625 626 struct bpf_tc_opts { 627 size_t sz; 628 int prog_fd; 629 __u32 flags; 630 __u32 prog_id; 631 __u32 handle; 632 __u32 priority; 633 size_t :0; 634 }; 635 #define bpf_tc_opts__last_field priority 636 637 LIBBPF_API int bpf_tc_hook_create(struct bpf_tc_hook *hook); 638 LIBBPF_API int bpf_tc_hook_destroy(struct bpf_tc_hook *hook); 639 LIBBPF_API int bpf_tc_attach(const struct bpf_tc_hook *hook, 640 struct bpf_tc_opts *opts); 641 LIBBPF_API int bpf_tc_detach(const struct bpf_tc_hook *hook, 642 const struct bpf_tc_opts *opts); 643 LIBBPF_API int bpf_tc_query(const struct bpf_tc_hook *hook, 644 struct bpf_tc_opts *opts); 645 646 /* Ring buffer APIs */ 647 struct ring_buffer; 648 649 typedef int (*ring_buffer_sample_fn)(void *ctx, void *data, size_t size); 650 651 struct ring_buffer_opts { 652 size_t sz; /* size of this struct, for forward/backward compatiblity */ 653 }; 654 655 #define ring_buffer_opts__last_field sz 656 657 LIBBPF_API struct ring_buffer * 658 ring_buffer__new(int map_fd, ring_buffer_sample_fn sample_cb, void *ctx, 659 const struct ring_buffer_opts *opts); 660 LIBBPF_API void ring_buffer__free(struct ring_buffer *rb); 661 LIBBPF_API int ring_buffer__add(struct ring_buffer *rb, int map_fd, 662 ring_buffer_sample_fn sample_cb, void *ctx); 663 LIBBPF_API int ring_buffer__poll(struct ring_buffer *rb, int timeout_ms); 664 LIBBPF_API int ring_buffer__consume(struct ring_buffer *rb); 665 LIBBPF_API int ring_buffer__epoll_fd(const struct ring_buffer *rb); 666 667 /* Perf buffer APIs */ 668 struct perf_buffer; 669 670 typedef void (*perf_buffer_sample_fn)(void *ctx, int cpu, 671 void *data, __u32 size); 672 typedef void (*perf_buffer_lost_fn)(void *ctx, int cpu, __u64 cnt); 673 674 /* common use perf buffer options */ 675 struct perf_buffer_opts { 676 /* if specified, sample_cb is called for each sample */ 677 perf_buffer_sample_fn sample_cb; 678 /* if specified, lost_cb is called for each batch of lost samples */ 679 perf_buffer_lost_fn lost_cb; 680 /* ctx is provided to sample_cb and lost_cb */ 681 void *ctx; 682 }; 683 684 LIBBPF_API struct perf_buffer * 685 perf_buffer__new(int map_fd, size_t page_cnt, 686 const struct perf_buffer_opts *opts); 687 688 enum bpf_perf_event_ret { 689 LIBBPF_PERF_EVENT_DONE = 0, 690 LIBBPF_PERF_EVENT_ERROR = -1, 691 LIBBPF_PERF_EVENT_CONT = -2, 692 }; 693 694 struct perf_event_header; 695 696 typedef enum bpf_perf_event_ret 697 (*perf_buffer_event_fn)(void *ctx, int cpu, struct perf_event_header *event); 698 699 /* raw perf buffer options, giving most power and control */ 700 struct perf_buffer_raw_opts { 701 /* perf event attrs passed directly into perf_event_open() */ 702 struct perf_event_attr *attr; 703 /* raw event callback */ 704 perf_buffer_event_fn event_cb; 705 /* ctx is provided to event_cb */ 706 void *ctx; 707 /* if cpu_cnt == 0, open all on all possible CPUs (up to the number of 708 * max_entries of given PERF_EVENT_ARRAY map) 709 */ 710 int cpu_cnt; 711 /* if cpu_cnt > 0, cpus is an array of CPUs to open ring buffers on */ 712 int *cpus; 713 /* if cpu_cnt > 0, map_keys specify map keys to set per-CPU FDs for */ 714 int *map_keys; 715 }; 716 717 LIBBPF_API struct perf_buffer * 718 perf_buffer__new_raw(int map_fd, size_t page_cnt, 719 const struct perf_buffer_raw_opts *opts); 720 721 LIBBPF_API void perf_buffer__free(struct perf_buffer *pb); 722 LIBBPF_API int perf_buffer__epoll_fd(const struct perf_buffer *pb); 723 LIBBPF_API int perf_buffer__poll(struct perf_buffer *pb, int timeout_ms); 724 LIBBPF_API int perf_buffer__consume(struct perf_buffer *pb); 725 LIBBPF_API int perf_buffer__consume_buffer(struct perf_buffer *pb, size_t buf_idx); 726 LIBBPF_API size_t perf_buffer__buffer_cnt(const struct perf_buffer *pb); 727 LIBBPF_API int perf_buffer__buffer_fd(const struct perf_buffer *pb, size_t buf_idx); 728 729 typedef enum bpf_perf_event_ret 730 (*bpf_perf_event_print_t)(struct perf_event_header *hdr, 731 void *private_data); 732 LIBBPF_API enum bpf_perf_event_ret 733 bpf_perf_event_read_simple(void *mmap_mem, size_t mmap_size, size_t page_size, 734 void **copy_mem, size_t *copy_size, 735 bpf_perf_event_print_t fn, void *private_data); 736 737 struct bpf_prog_linfo; 738 struct bpf_prog_info; 739 740 LIBBPF_API void bpf_prog_linfo__free(struct bpf_prog_linfo *prog_linfo); 741 LIBBPF_API struct bpf_prog_linfo * 742 bpf_prog_linfo__new(const struct bpf_prog_info *info); 743 LIBBPF_API const struct bpf_line_info * 744 bpf_prog_linfo__lfind_addr_func(const struct bpf_prog_linfo *prog_linfo, 745 __u64 addr, __u32 func_idx, __u32 nr_skip); 746 LIBBPF_API const struct bpf_line_info * 747 bpf_prog_linfo__lfind(const struct bpf_prog_linfo *prog_linfo, 748 __u32 insn_off, __u32 nr_skip); 749 750 /* 751 * Probe for supported system features 752 * 753 * Note that running many of these probes in a short amount of time can cause 754 * the kernel to reach the maximal size of lockable memory allowed for the 755 * user, causing subsequent probes to fail. In this case, the caller may want 756 * to adjust that limit with setrlimit(). 757 */ 758 LIBBPF_API bool bpf_probe_prog_type(enum bpf_prog_type prog_type, 759 __u32 ifindex); 760 LIBBPF_API bool bpf_probe_map_type(enum bpf_map_type map_type, __u32 ifindex); 761 LIBBPF_API bool bpf_probe_helper(enum bpf_func_id id, 762 enum bpf_prog_type prog_type, __u32 ifindex); 763 LIBBPF_API bool bpf_probe_large_insn_limit(__u32 ifindex); 764 765 /* 766 * Get bpf_prog_info in continuous memory 767 * 768 * struct bpf_prog_info has multiple arrays. The user has option to choose 769 * arrays to fetch from kernel. The following APIs provide an uniform way to 770 * fetch these data. All arrays in bpf_prog_info are stored in a single 771 * continuous memory region. This makes it easy to store the info in a 772 * file. 773 * 774 * Before writing bpf_prog_info_linear to files, it is necessary to 775 * translate pointers in bpf_prog_info to offsets. Helper functions 776 * bpf_program__bpil_addr_to_offs() and bpf_program__bpil_offs_to_addr() 777 * are introduced to switch between pointers and offsets. 778 * 779 * Examples: 780 * # To fetch map_ids and prog_tags: 781 * __u64 arrays = (1UL << BPF_PROG_INFO_MAP_IDS) | 782 * (1UL << BPF_PROG_INFO_PROG_TAGS); 783 * struct bpf_prog_info_linear *info_linear = 784 * bpf_program__get_prog_info_linear(fd, arrays); 785 * 786 * # To save data in file 787 * bpf_program__bpil_addr_to_offs(info_linear); 788 * write(f, info_linear, sizeof(*info_linear) + info_linear->data_len); 789 * 790 * # To read data from file 791 * read(f, info_linear, <proper_size>); 792 * bpf_program__bpil_offs_to_addr(info_linear); 793 */ 794 enum bpf_prog_info_array { 795 BPF_PROG_INFO_FIRST_ARRAY = 0, 796 BPF_PROG_INFO_JITED_INSNS = 0, 797 BPF_PROG_INFO_XLATED_INSNS, 798 BPF_PROG_INFO_MAP_IDS, 799 BPF_PROG_INFO_JITED_KSYMS, 800 BPF_PROG_INFO_JITED_FUNC_LENS, 801 BPF_PROG_INFO_FUNC_INFO, 802 BPF_PROG_INFO_LINE_INFO, 803 BPF_PROG_INFO_JITED_LINE_INFO, 804 BPF_PROG_INFO_PROG_TAGS, 805 BPF_PROG_INFO_LAST_ARRAY, 806 }; 807 808 struct bpf_prog_info_linear { 809 /* size of struct bpf_prog_info, when the tool is compiled */ 810 __u32 info_len; 811 /* total bytes allocated for data, round up to 8 bytes */ 812 __u32 data_len; 813 /* which arrays are included in data */ 814 __u64 arrays; 815 struct bpf_prog_info info; 816 __u8 data[]; 817 }; 818 819 LIBBPF_API struct bpf_prog_info_linear * 820 bpf_program__get_prog_info_linear(int fd, __u64 arrays); 821 822 LIBBPF_API void 823 bpf_program__bpil_addr_to_offs(struct bpf_prog_info_linear *info_linear); 824 825 LIBBPF_API void 826 bpf_program__bpil_offs_to_addr(struct bpf_prog_info_linear *info_linear); 827 828 /* 829 * A helper function to get the number of possible CPUs before looking up 830 * per-CPU maps. Negative errno is returned on failure. 831 * 832 * Example usage: 833 * 834 * int ncpus = libbpf_num_possible_cpus(); 835 * if (ncpus < 0) { 836 * // error handling 837 * } 838 * long values[ncpus]; 839 * bpf_map_lookup_elem(per_cpu_map_fd, key, values); 840 * 841 */ 842 LIBBPF_API int libbpf_num_possible_cpus(void); 843 844 struct bpf_map_skeleton { 845 const char *name; 846 struct bpf_map **map; 847 void **mmaped; 848 }; 849 850 struct bpf_prog_skeleton { 851 const char *name; 852 struct bpf_program **prog; 853 struct bpf_link **link; 854 }; 855 856 struct bpf_object_skeleton { 857 size_t sz; /* size of this struct, for forward/backward compatibility */ 858 859 const char *name; 860 const void *data; 861 size_t data_sz; 862 863 struct bpf_object **obj; 864 865 int map_cnt; 866 int map_skel_sz; /* sizeof(struct bpf_skeleton_map) */ 867 struct bpf_map_skeleton *maps; 868 869 int prog_cnt; 870 int prog_skel_sz; /* sizeof(struct bpf_skeleton_prog) */ 871 struct bpf_prog_skeleton *progs; 872 }; 873 874 LIBBPF_API int 875 bpf_object__open_skeleton(struct bpf_object_skeleton *s, 876 const struct bpf_object_open_opts *opts); 877 LIBBPF_API int bpf_object__load_skeleton(struct bpf_object_skeleton *s); 878 LIBBPF_API int bpf_object__attach_skeleton(struct bpf_object_skeleton *s); 879 LIBBPF_API void bpf_object__detach_skeleton(struct bpf_object_skeleton *s); 880 LIBBPF_API void bpf_object__destroy_skeleton(struct bpf_object_skeleton *s); 881 882 struct gen_loader_opts { 883 size_t sz; /* size of this struct, for forward/backward compatiblity */ 884 const char *data; 885 const char *insns; 886 __u32 data_sz; 887 __u32 insns_sz; 888 }; 889 890 #define gen_loader_opts__last_field insns_sz 891 LIBBPF_API int bpf_object__gen_loader(struct bpf_object *obj, 892 struct gen_loader_opts *opts); 893 894 enum libbpf_tristate { 895 TRI_NO = 0, 896 TRI_YES = 1, 897 TRI_MODULE = 2, 898 }; 899 900 struct bpf_linker_opts { 901 /* size of this struct, for forward/backward compatiblity */ 902 size_t sz; 903 }; 904 #define bpf_linker_opts__last_field sz 905 906 struct bpf_linker_file_opts { 907 /* size of this struct, for forward/backward compatiblity */ 908 size_t sz; 909 }; 910 #define bpf_linker_file_opts__last_field sz 911 912 struct bpf_linker; 913 914 LIBBPF_API struct bpf_linker *bpf_linker__new(const char *filename, struct bpf_linker_opts *opts); 915 LIBBPF_API int bpf_linker__add_file(struct bpf_linker *linker, 916 const char *filename, 917 const struct bpf_linker_file_opts *opts); 918 LIBBPF_API int bpf_linker__finalize(struct bpf_linker *linker); 919 LIBBPF_API void bpf_linker__free(struct bpf_linker *linker); 920 921 #ifdef __cplusplus 922 } /* extern "C" */ 923 #endif 924 925 #endif /* __LIBBPF_LIBBPF_H */ 926