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