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