1 /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */ 2 /* Copyright (c) 2018 Facebook */ 3 /*! \file */ 4 5 #ifndef __LIBBPF_BTF_H 6 #define __LIBBPF_BTF_H 7 8 #include <stdarg.h> 9 #include <stdbool.h> 10 #include <linux/btf.h> 11 #include <linux/types.h> 12 13 #include "libbpf_common.h" 14 15 #ifdef __cplusplus 16 extern "C" { 17 #endif 18 19 #define BTF_ELF_SEC ".BTF" 20 #define BTF_EXT_ELF_SEC ".BTF.ext" 21 #define MAPS_ELF_SEC ".maps" 22 23 struct btf; 24 struct btf_ext; 25 struct btf_type; 26 27 struct bpf_object; 28 29 enum btf_endianness { 30 BTF_LITTLE_ENDIAN = 0, 31 BTF_BIG_ENDIAN = 1, 32 }; 33 34 /** 35 * @brief **btf__free()** frees all data of a BTF object 36 * @param btf BTF object to free 37 */ 38 LIBBPF_API void btf__free(struct btf *btf); 39 40 /** 41 * @brief **btf__new()** creates a new instance of a BTF object from the raw 42 * bytes of an ELF's BTF section 43 * @param data raw bytes 44 * @param size number of bytes passed in `data` 45 * @return new BTF object instance which has to be eventually freed with 46 * **btf__free()** 47 * 48 * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract 49 * error code from such a pointer `libbpf_get_error()` should be used. If 50 * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is 51 * returned on error instead. In both cases thread-local `errno` variable is 52 * always set to error code as well. 53 */ 54 LIBBPF_API struct btf *btf__new(const void *data, __u32 size); 55 56 /** 57 * @brief **btf__new_split()** create a new instance of a BTF object from the 58 * provided raw data bytes. It takes another BTF instance, **base_btf**, which 59 * serves as a base BTF, which is extended by types in a newly created BTF 60 * instance 61 * @param data raw bytes 62 * @param size length of raw bytes 63 * @param base_btf the base BTF object 64 * @return new BTF object instance which has to be eventually freed with 65 * **btf__free()** 66 * 67 * If *base_btf* is NULL, `btf__new_split()` is equivalent to `btf__new()` and 68 * creates non-split BTF. 69 * 70 * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract 71 * error code from such a pointer `libbpf_get_error()` should be used. If 72 * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is 73 * returned on error instead. In both cases thread-local `errno` variable is 74 * always set to error code as well. 75 */ 76 LIBBPF_API struct btf *btf__new_split(const void *data, __u32 size, struct btf *base_btf); 77 78 /** 79 * @brief **btf__new_empty()** creates an empty BTF object. Use 80 * `btf__add_*()` to populate such BTF object. 81 * @return new BTF object instance which has to be eventually freed with 82 * **btf__free()** 83 * 84 * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract 85 * error code from such a pointer `libbpf_get_error()` should be used. If 86 * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is 87 * returned on error instead. In both cases thread-local `errno` variable is 88 * always set to error code as well. 89 */ 90 LIBBPF_API struct btf *btf__new_empty(void); 91 92 /** 93 * @brief **btf__new_empty_split()** creates an unpopulated BTF object from an 94 * ELF BTF section except with a base BTF on top of which split BTF should be 95 * based 96 * @return new BTF object instance which has to be eventually freed with 97 * **btf__free()** 98 * 99 * If *base_btf* is NULL, `btf__new_empty_split()` is equivalent to 100 * `btf__new_empty()` and creates non-split BTF. 101 * 102 * On error, error-code-encoded-as-pointer is returned, not a NULL. To extract 103 * error code from such a pointer `libbpf_get_error()` should be used. If 104 * `libbpf_set_strict_mode(LIBBPF_STRICT_CLEAN_PTRS)` is enabled, NULL is 105 * returned on error instead. In both cases thread-local `errno` variable is 106 * always set to error code as well. 107 */ 108 LIBBPF_API struct btf *btf__new_empty_split(struct btf *base_btf); 109 110 LIBBPF_API struct btf *btf__parse(const char *path, struct btf_ext **btf_ext); 111 LIBBPF_API struct btf *btf__parse_split(const char *path, struct btf *base_btf); 112 LIBBPF_API struct btf *btf__parse_elf(const char *path, struct btf_ext **btf_ext); 113 LIBBPF_API struct btf *btf__parse_elf_split(const char *path, struct btf *base_btf); 114 LIBBPF_API struct btf *btf__parse_raw(const char *path); 115 LIBBPF_API struct btf *btf__parse_raw_split(const char *path, struct btf *base_btf); 116 117 LIBBPF_API struct btf *btf__load_vmlinux_btf(void); 118 LIBBPF_API struct btf *btf__load_module_btf(const char *module_name, struct btf *vmlinux_btf); 119 LIBBPF_API struct btf *libbpf_find_kernel_btf(void); 120 121 LIBBPF_API struct btf *btf__load_from_kernel_by_id(__u32 id); 122 LIBBPF_API struct btf *btf__load_from_kernel_by_id_split(__u32 id, struct btf *base_btf); 123 LIBBPF_DEPRECATED_SINCE(0, 6, "use btf__load_from_kernel_by_id instead") 124 LIBBPF_API int btf__get_from_id(__u32 id, struct btf **btf); 125 126 LIBBPF_DEPRECATED_SINCE(0, 6, "intended for internal libbpf use only") 127 LIBBPF_API int btf__finalize_data(struct bpf_object *obj, struct btf *btf); 128 LIBBPF_DEPRECATED_SINCE(0, 6, "use btf__load_into_kernel instead") 129 LIBBPF_API int btf__load(struct btf *btf); 130 LIBBPF_API int btf__load_into_kernel(struct btf *btf); 131 LIBBPF_API __s32 btf__find_by_name(const struct btf *btf, 132 const char *type_name); 133 LIBBPF_API __s32 btf__find_by_name_kind(const struct btf *btf, 134 const char *type_name, __u32 kind); 135 LIBBPF_DEPRECATED_SINCE(0, 7, "use btf__type_cnt() instead; note that btf__get_nr_types() == btf__type_cnt() - 1") 136 LIBBPF_API __u32 btf__get_nr_types(const struct btf *btf); 137 LIBBPF_API __u32 btf__type_cnt(const struct btf *btf); 138 LIBBPF_API const struct btf *btf__base_btf(const struct btf *btf); 139 LIBBPF_API const struct btf_type *btf__type_by_id(const struct btf *btf, 140 __u32 id); 141 LIBBPF_API size_t btf__pointer_size(const struct btf *btf); 142 LIBBPF_API int btf__set_pointer_size(struct btf *btf, size_t ptr_sz); 143 LIBBPF_API enum btf_endianness btf__endianness(const struct btf *btf); 144 LIBBPF_API int btf__set_endianness(struct btf *btf, enum btf_endianness endian); 145 LIBBPF_API __s64 btf__resolve_size(const struct btf *btf, __u32 type_id); 146 LIBBPF_API int btf__resolve_type(const struct btf *btf, __u32 type_id); 147 LIBBPF_API int btf__align_of(const struct btf *btf, __u32 id); 148 LIBBPF_API int btf__fd(const struct btf *btf); 149 LIBBPF_API void btf__set_fd(struct btf *btf, int fd); 150 LIBBPF_API const void *btf__raw_data(const struct btf *btf, __u32 *size); 151 LIBBPF_API const char *btf__name_by_offset(const struct btf *btf, __u32 offset); 152 LIBBPF_API const char *btf__str_by_offset(const struct btf *btf, __u32 offset); 153 LIBBPF_DEPRECATED_SINCE(0, 7, "this API is not necessary when BTF-defined maps are used") 154 LIBBPF_API int btf__get_map_kv_tids(const struct btf *btf, const char *map_name, 155 __u32 expected_key_size, 156 __u32 expected_value_size, 157 __u32 *key_type_id, __u32 *value_type_id); 158 159 LIBBPF_API struct btf_ext *btf_ext__new(const __u8 *data, __u32 size); 160 LIBBPF_API void btf_ext__free(struct btf_ext *btf_ext); 161 LIBBPF_API const void *btf_ext__raw_data(const struct btf_ext *btf_ext, __u32 *size); 162 LIBBPF_API LIBBPF_DEPRECATED("btf_ext__reloc_func_info was never meant as a public API and has wrong assumptions embedded in it; it will be removed in the future libbpf versions") 163 int btf_ext__reloc_func_info(const struct btf *btf, 164 const struct btf_ext *btf_ext, 165 const char *sec_name, __u32 insns_cnt, 166 void **func_info, __u32 *cnt); 167 LIBBPF_API LIBBPF_DEPRECATED("btf_ext__reloc_line_info was never meant as a public API and has wrong assumptions embedded in it; it will be removed in the future libbpf versions") 168 int btf_ext__reloc_line_info(const struct btf *btf, 169 const struct btf_ext *btf_ext, 170 const char *sec_name, __u32 insns_cnt, 171 void **line_info, __u32 *cnt); 172 LIBBPF_API LIBBPF_DEPRECATED("btf_ext__reloc_func_info is deprecated; write custom func_info parsing to fetch rec_size") 173 __u32 btf_ext__func_info_rec_size(const struct btf_ext *btf_ext); 174 LIBBPF_API LIBBPF_DEPRECATED("btf_ext__reloc_line_info is deprecated; write custom line_info parsing to fetch rec_size") 175 __u32 btf_ext__line_info_rec_size(const struct btf_ext *btf_ext); 176 177 LIBBPF_API int btf__find_str(struct btf *btf, const char *s); 178 LIBBPF_API int btf__add_str(struct btf *btf, const char *s); 179 LIBBPF_API int btf__add_type(struct btf *btf, const struct btf *src_btf, 180 const struct btf_type *src_type); 181 /** 182 * @brief **btf__add_btf()** appends all the BTF types from *src_btf* into *btf* 183 * @param btf BTF object which all the BTF types and strings are added to 184 * @param src_btf BTF object which all BTF types and referenced strings are copied from 185 * @return BTF type ID of the first appended BTF type, or negative error code 186 * 187 * **btf__add_btf()** can be used to simply and efficiently append the entire 188 * contents of one BTF object to another one. All the BTF type data is copied 189 * over, all referenced type IDs are adjusted by adding a necessary ID offset. 190 * Only strings referenced from BTF types are copied over and deduplicated, so 191 * if there were some unused strings in *src_btf*, those won't be copied over, 192 * which is consistent with the general string deduplication semantics of BTF 193 * writing APIs. 194 * 195 * If any error is encountered during this process, the contents of *btf* is 196 * left intact, which means that **btf__add_btf()** follows the transactional 197 * semantics and the operation as a whole is all-or-nothing. 198 * 199 * *src_btf* has to be non-split BTF, as of now copying types from split BTF 200 * is not supported and will result in -ENOTSUP error code returned. 201 */ 202 LIBBPF_API int btf__add_btf(struct btf *btf, const struct btf *src_btf); 203 204 LIBBPF_API int btf__add_int(struct btf *btf, const char *name, size_t byte_sz, int encoding); 205 LIBBPF_API int btf__add_float(struct btf *btf, const char *name, size_t byte_sz); 206 LIBBPF_API int btf__add_ptr(struct btf *btf, int ref_type_id); 207 LIBBPF_API int btf__add_array(struct btf *btf, 208 int index_type_id, int elem_type_id, __u32 nr_elems); 209 /* struct/union construction APIs */ 210 LIBBPF_API int btf__add_struct(struct btf *btf, const char *name, __u32 sz); 211 LIBBPF_API int btf__add_union(struct btf *btf, const char *name, __u32 sz); 212 LIBBPF_API int btf__add_field(struct btf *btf, const char *name, int field_type_id, 213 __u32 bit_offset, __u32 bit_size); 214 215 /* enum construction APIs */ 216 LIBBPF_API int btf__add_enum(struct btf *btf, const char *name, __u32 bytes_sz); 217 LIBBPF_API int btf__add_enum_value(struct btf *btf, const char *name, __s64 value); 218 LIBBPF_API int btf__add_enum64(struct btf *btf, const char *name, __u32 bytes_sz, bool is_signed); 219 LIBBPF_API int btf__add_enum64_value(struct btf *btf, const char *name, __u64 value); 220 221 enum btf_fwd_kind { 222 BTF_FWD_STRUCT = 0, 223 BTF_FWD_UNION = 1, 224 BTF_FWD_ENUM = 2, 225 }; 226 227 LIBBPF_API int btf__add_fwd(struct btf *btf, const char *name, enum btf_fwd_kind fwd_kind); 228 LIBBPF_API int btf__add_typedef(struct btf *btf, const char *name, int ref_type_id); 229 LIBBPF_API int btf__add_volatile(struct btf *btf, int ref_type_id); 230 LIBBPF_API int btf__add_const(struct btf *btf, int ref_type_id); 231 LIBBPF_API int btf__add_restrict(struct btf *btf, int ref_type_id); 232 LIBBPF_API int btf__add_type_tag(struct btf *btf, const char *value, int ref_type_id); 233 234 /* func and func_proto construction APIs */ 235 LIBBPF_API int btf__add_func(struct btf *btf, const char *name, 236 enum btf_func_linkage linkage, int proto_type_id); 237 LIBBPF_API int btf__add_func_proto(struct btf *btf, int ret_type_id); 238 LIBBPF_API int btf__add_func_param(struct btf *btf, const char *name, int type_id); 239 240 /* var & datasec construction APIs */ 241 LIBBPF_API int btf__add_var(struct btf *btf, const char *name, int linkage, int type_id); 242 LIBBPF_API int btf__add_datasec(struct btf *btf, const char *name, __u32 byte_sz); 243 LIBBPF_API int btf__add_datasec_var_info(struct btf *btf, int var_type_id, 244 __u32 offset, __u32 byte_sz); 245 246 /* tag construction API */ 247 LIBBPF_API int btf__add_decl_tag(struct btf *btf, const char *value, int ref_type_id, 248 int component_idx); 249 250 struct btf_dedup_opts { 251 size_t sz; 252 /* optional .BTF.ext info to dedup along the main BTF info */ 253 struct btf_ext *btf_ext; 254 /* force hash collisions (used for testing) */ 255 bool force_collisions; 256 size_t :0; 257 }; 258 #define btf_dedup_opts__last_field force_collisions 259 260 LIBBPF_API int btf__dedup(struct btf *btf, const struct btf_dedup_opts *opts); 261 262 LIBBPF_API int btf__dedup_v0_6_0(struct btf *btf, const struct btf_dedup_opts *opts); 263 264 LIBBPF_DEPRECATED_SINCE(0, 7, "use btf__dedup() instead") 265 LIBBPF_API int btf__dedup_deprecated(struct btf *btf, struct btf_ext *btf_ext, const void *opts); 266 #define btf__dedup(...) ___libbpf_overload(___btf_dedup, __VA_ARGS__) 267 #define ___btf_dedup3(btf, btf_ext, opts) btf__dedup_deprecated(btf, btf_ext, opts) 268 #define ___btf_dedup2(btf, opts) btf__dedup(btf, opts) 269 270 struct btf_dump; 271 272 struct btf_dump_opts { 273 union { 274 size_t sz; 275 void *ctx; /* DEPRECATED: will be gone in v1.0 */ 276 }; 277 }; 278 279 typedef void (*btf_dump_printf_fn_t)(void *ctx, const char *fmt, va_list args); 280 281 LIBBPF_API struct btf_dump *btf_dump__new(const struct btf *btf, 282 btf_dump_printf_fn_t printf_fn, 283 void *ctx, 284 const struct btf_dump_opts *opts); 285 286 LIBBPF_API struct btf_dump *btf_dump__new_v0_6_0(const struct btf *btf, 287 btf_dump_printf_fn_t printf_fn, 288 void *ctx, 289 const struct btf_dump_opts *opts); 290 291 LIBBPF_API struct btf_dump *btf_dump__new_deprecated(const struct btf *btf, 292 const struct btf_ext *btf_ext, 293 const struct btf_dump_opts *opts, 294 btf_dump_printf_fn_t printf_fn); 295 296 /* Choose either btf_dump__new() or btf_dump__new_deprecated() based on the 297 * type of 4th argument. If it's btf_dump's print callback, use deprecated 298 * API; otherwise, choose the new btf_dump__new(). ___libbpf_override() 299 * doesn't work here because both variants have 4 input arguments. 300 * 301 * (void *) casts are necessary to avoid compilation warnings about type 302 * mismatches, because even though __builtin_choose_expr() only ever evaluates 303 * one side the other side still has to satisfy type constraints (this is 304 * compiler implementation limitation which might be lifted eventually, 305 * according to the documentation). So passing struct btf_ext in place of 306 * btf_dump_printf_fn_t would be generating compilation warning. Casting to 307 * void * avoids this issue. 308 * 309 * Also, two type compatibility checks for a function and function pointer are 310 * required because passing function reference into btf_dump__new() as 311 * btf_dump__new(..., my_callback, ...) and as btf_dump__new(..., 312 * &my_callback, ...) (not explicit ampersand in the latter case) actually 313 * differs as far as __builtin_types_compatible_p() is concerned. Thus two 314 * checks are combined to detect callback argument. 315 * 316 * The rest works just like in case of ___libbpf_override() usage with symbol 317 * versioning. 318 * 319 * C++ compilers don't support __builtin_types_compatible_p(), so at least 320 * don't screw up compilation for them and let C++ users pick btf_dump__new 321 * vs btf_dump__new_deprecated explicitly. 322 */ 323 #ifndef __cplusplus 324 #define btf_dump__new(a1, a2, a3, a4) __builtin_choose_expr( \ 325 __builtin_types_compatible_p(typeof(a4), btf_dump_printf_fn_t) || \ 326 __builtin_types_compatible_p(typeof(a4), void(void *, const char *, va_list)), \ 327 btf_dump__new_deprecated((void *)a1, (void *)a2, (void *)a3, (void *)a4), \ 328 btf_dump__new((void *)a1, (void *)a2, (void *)a3, (void *)a4)) 329 #endif 330 331 LIBBPF_API void btf_dump__free(struct btf_dump *d); 332 333 LIBBPF_API int btf_dump__dump_type(struct btf_dump *d, __u32 id); 334 335 struct btf_dump_emit_type_decl_opts { 336 /* size of this struct, for forward/backward compatiblity */ 337 size_t sz; 338 /* optional field name for type declaration, e.g.: 339 * - struct my_struct <FNAME> 340 * - void (*<FNAME>)(int) 341 * - char (*<FNAME>)[123] 342 */ 343 const char *field_name; 344 /* extra indentation level (in number of tabs) to emit for multi-line 345 * type declarations (e.g., anonymous struct); applies for lines 346 * starting from the second one (first line is assumed to have 347 * necessary indentation already 348 */ 349 int indent_level; 350 /* strip all the const/volatile/restrict mods */ 351 bool strip_mods; 352 size_t :0; 353 }; 354 #define btf_dump_emit_type_decl_opts__last_field strip_mods 355 356 LIBBPF_API int 357 btf_dump__emit_type_decl(struct btf_dump *d, __u32 id, 358 const struct btf_dump_emit_type_decl_opts *opts); 359 360 361 struct btf_dump_type_data_opts { 362 /* size of this struct, for forward/backward compatibility */ 363 size_t sz; 364 const char *indent_str; 365 int indent_level; 366 /* below match "show" flags for bpf_show_snprintf() */ 367 bool compact; /* no newlines/indentation */ 368 bool skip_names; /* skip member/type names */ 369 bool emit_zeroes; /* show 0-valued fields */ 370 size_t :0; 371 }; 372 #define btf_dump_type_data_opts__last_field emit_zeroes 373 374 LIBBPF_API int 375 btf_dump__dump_type_data(struct btf_dump *d, __u32 id, 376 const void *data, size_t data_sz, 377 const struct btf_dump_type_data_opts *opts); 378 379 /* 380 * A set of helpers for easier BTF types handling. 381 * 382 * The inline functions below rely on constants from the kernel headers which 383 * may not be available for applications including this header file. To avoid 384 * compilation errors, we define all the constants here that were added after 385 * the initial introduction of the BTF_KIND* constants. 386 */ 387 #ifndef BTF_KIND_FUNC 388 #define BTF_KIND_FUNC 12 /* Function */ 389 #define BTF_KIND_FUNC_PROTO 13 /* Function Proto */ 390 #endif 391 #ifndef BTF_KIND_VAR 392 #define BTF_KIND_VAR 14 /* Variable */ 393 #define BTF_KIND_DATASEC 15 /* Section */ 394 #endif 395 #ifndef BTF_KIND_FLOAT 396 #define BTF_KIND_FLOAT 16 /* Floating point */ 397 #endif 398 /* The kernel header switched to enums, so the following were never #defined */ 399 #define BTF_KIND_DECL_TAG 17 /* Decl Tag */ 400 #define BTF_KIND_TYPE_TAG 18 /* Type Tag */ 401 #define BTF_KIND_ENUM64 19 /* Enum for up-to 64bit values */ 402 403 static inline __u16 btf_kind(const struct btf_type *t) 404 { 405 return BTF_INFO_KIND(t->info); 406 } 407 408 static inline __u16 btf_vlen(const struct btf_type *t) 409 { 410 return BTF_INFO_VLEN(t->info); 411 } 412 413 static inline bool btf_kflag(const struct btf_type *t) 414 { 415 return BTF_INFO_KFLAG(t->info); 416 } 417 418 static inline bool btf_is_void(const struct btf_type *t) 419 { 420 return btf_kind(t) == BTF_KIND_UNKN; 421 } 422 423 static inline bool btf_is_int(const struct btf_type *t) 424 { 425 return btf_kind(t) == BTF_KIND_INT; 426 } 427 428 static inline bool btf_is_ptr(const struct btf_type *t) 429 { 430 return btf_kind(t) == BTF_KIND_PTR; 431 } 432 433 static inline bool btf_is_array(const struct btf_type *t) 434 { 435 return btf_kind(t) == BTF_KIND_ARRAY; 436 } 437 438 static inline bool btf_is_struct(const struct btf_type *t) 439 { 440 return btf_kind(t) == BTF_KIND_STRUCT; 441 } 442 443 static inline bool btf_is_union(const struct btf_type *t) 444 { 445 return btf_kind(t) == BTF_KIND_UNION; 446 } 447 448 static inline bool btf_is_composite(const struct btf_type *t) 449 { 450 __u16 kind = btf_kind(t); 451 452 return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION; 453 } 454 455 static inline bool btf_is_enum(const struct btf_type *t) 456 { 457 return btf_kind(t) == BTF_KIND_ENUM; 458 } 459 460 static inline bool btf_is_enum64(const struct btf_type *t) 461 { 462 return btf_kind(t) == BTF_KIND_ENUM64; 463 } 464 465 static inline bool btf_is_fwd(const struct btf_type *t) 466 { 467 return btf_kind(t) == BTF_KIND_FWD; 468 } 469 470 static inline bool btf_is_typedef(const struct btf_type *t) 471 { 472 return btf_kind(t) == BTF_KIND_TYPEDEF; 473 } 474 475 static inline bool btf_is_volatile(const struct btf_type *t) 476 { 477 return btf_kind(t) == BTF_KIND_VOLATILE; 478 } 479 480 static inline bool btf_is_const(const struct btf_type *t) 481 { 482 return btf_kind(t) == BTF_KIND_CONST; 483 } 484 485 static inline bool btf_is_restrict(const struct btf_type *t) 486 { 487 return btf_kind(t) == BTF_KIND_RESTRICT; 488 } 489 490 static inline bool btf_is_mod(const struct btf_type *t) 491 { 492 __u16 kind = btf_kind(t); 493 494 return kind == BTF_KIND_VOLATILE || 495 kind == BTF_KIND_CONST || 496 kind == BTF_KIND_RESTRICT || 497 kind == BTF_KIND_TYPE_TAG; 498 } 499 500 static inline bool btf_is_func(const struct btf_type *t) 501 { 502 return btf_kind(t) == BTF_KIND_FUNC; 503 } 504 505 static inline bool btf_is_func_proto(const struct btf_type *t) 506 { 507 return btf_kind(t) == BTF_KIND_FUNC_PROTO; 508 } 509 510 static inline bool btf_is_var(const struct btf_type *t) 511 { 512 return btf_kind(t) == BTF_KIND_VAR; 513 } 514 515 static inline bool btf_is_datasec(const struct btf_type *t) 516 { 517 return btf_kind(t) == BTF_KIND_DATASEC; 518 } 519 520 static inline bool btf_is_float(const struct btf_type *t) 521 { 522 return btf_kind(t) == BTF_KIND_FLOAT; 523 } 524 525 static inline bool btf_is_decl_tag(const struct btf_type *t) 526 { 527 return btf_kind(t) == BTF_KIND_DECL_TAG; 528 } 529 530 static inline bool btf_is_type_tag(const struct btf_type *t) 531 { 532 return btf_kind(t) == BTF_KIND_TYPE_TAG; 533 } 534 535 static inline bool btf_is_any_enum(const struct btf_type *t) 536 { 537 return btf_is_enum(t) || btf_is_enum64(t); 538 } 539 540 static inline bool btf_kind_core_compat(const struct btf_type *t1, 541 const struct btf_type *t2) 542 { 543 return btf_kind(t1) == btf_kind(t2) || 544 (btf_is_any_enum(t1) && btf_is_any_enum(t2)); 545 } 546 547 static inline __u8 btf_int_encoding(const struct btf_type *t) 548 { 549 return BTF_INT_ENCODING(*(__u32 *)(t + 1)); 550 } 551 552 static inline __u8 btf_int_offset(const struct btf_type *t) 553 { 554 return BTF_INT_OFFSET(*(__u32 *)(t + 1)); 555 } 556 557 static inline __u8 btf_int_bits(const struct btf_type *t) 558 { 559 return BTF_INT_BITS(*(__u32 *)(t + 1)); 560 } 561 562 static inline struct btf_array *btf_array(const struct btf_type *t) 563 { 564 return (struct btf_array *)(t + 1); 565 } 566 567 static inline struct btf_enum *btf_enum(const struct btf_type *t) 568 { 569 return (struct btf_enum *)(t + 1); 570 } 571 572 static inline struct btf_enum64 *btf_enum64(const struct btf_type *t) 573 { 574 return (struct btf_enum64 *)(t + 1); 575 } 576 577 static inline __u64 btf_enum64_value(const struct btf_enum64 *e) 578 { 579 return ((__u64)e->val_hi32 << 32) | e->val_lo32; 580 } 581 582 static inline struct btf_member *btf_members(const struct btf_type *t) 583 { 584 return (struct btf_member *)(t + 1); 585 } 586 587 /* Get bit offset of a member with specified index. */ 588 static inline __u32 btf_member_bit_offset(const struct btf_type *t, 589 __u32 member_idx) 590 { 591 const struct btf_member *m = btf_members(t) + member_idx; 592 bool kflag = btf_kflag(t); 593 594 return kflag ? BTF_MEMBER_BIT_OFFSET(m->offset) : m->offset; 595 } 596 /* 597 * Get bitfield size of a member, assuming t is BTF_KIND_STRUCT or 598 * BTF_KIND_UNION. If member is not a bitfield, zero is returned. 599 */ 600 static inline __u32 btf_member_bitfield_size(const struct btf_type *t, 601 __u32 member_idx) 602 { 603 const struct btf_member *m = btf_members(t) + member_idx; 604 bool kflag = btf_kflag(t); 605 606 return kflag ? BTF_MEMBER_BITFIELD_SIZE(m->offset) : 0; 607 } 608 609 static inline struct btf_param *btf_params(const struct btf_type *t) 610 { 611 return (struct btf_param *)(t + 1); 612 } 613 614 static inline struct btf_var *btf_var(const struct btf_type *t) 615 { 616 return (struct btf_var *)(t + 1); 617 } 618 619 static inline struct btf_var_secinfo * 620 btf_var_secinfos(const struct btf_type *t) 621 { 622 return (struct btf_var_secinfo *)(t + 1); 623 } 624 625 struct btf_decl_tag; 626 static inline struct btf_decl_tag *btf_decl_tag(const struct btf_type *t) 627 { 628 return (struct btf_decl_tag *)(t + 1); 629 } 630 631 #ifdef __cplusplus 632 } /* extern "C" */ 633 #endif 634 635 #endif /* __LIBBPF_BTF_H */ 636