tools/lib/bpf/btf.h

   1 /* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
   2 /* Copyright (c) 2018 Facebook */
   3
   4 #ifndef __LIBBPF_BTF_H
   5 #define __LIBBPF_BTF_H
   6
   7 #include <stdarg.h>
   8 #include <stdbool.h>
   9 #include <linux/btf.h>
  10 #include <linux/types.h>
  11
  12 #include "libbpf_common.h"
  13
  14 #ifdef __cplusplus
  15 extern "C" {
  16 #endif
  17
  18 #define BTF_ELF_SEC ".BTF"
  19 #define BTF_EXT_ELF_SEC ".BTF.ext"
  20 #define MAPS_ELF_SEC ".maps"
  21
  22 struct btf;
  23 struct btf_ext;
  24 struct btf_type;
  25
  26 struct bpf_object;
  27
  28 enum btf_endianness {
  29         BTF_LITTLE_ENDIAN = 0,
  30         BTF_BIG_ENDIAN = 1,
  31 };
  32
  33 LIBBPF_API void btf__free(struct btf *btf);
  34
  35 LIBBPF_API struct btf *btf__new(const void *data, __u32 size);
  36 LIBBPF_API struct btf *btf__new_split(const void *data, __u32 size, struct btf *base_btf);
  37 LIBBPF_API struct btf *btf__new_empty(void);
  38 LIBBPF_API struct btf *btf__new_empty_split(struct btf *base_btf);
  39
  40 LIBBPF_API struct btf *btf__parse(const char *path, struct btf_ext **btf_ext);
  41 LIBBPF_API struct btf *btf__parse_split(const char *path, struct btf *base_btf);
  42 LIBBPF_API struct btf *btf__parse_elf(const char *path, struct btf_ext **btf_ext);
  43 LIBBPF_API struct btf *btf__parse_elf_split(const char *path, struct btf *base_btf);
  44 LIBBPF_API struct btf *btf__parse_raw(const char *path);
  45 LIBBPF_API struct btf *btf__parse_raw_split(const char *path, struct btf *base_btf);
  46
  47 LIBBPF_API int btf__finalize_data(struct bpf_object *obj, struct btf *btf);
  48 LIBBPF_API int btf__load(struct btf *btf);
  49 LIBBPF_API int btf__load_into_kernel(struct btf *btf);
  50 LIBBPF_API __s32 btf__find_by_name(const struct btf *btf,
  51                                    const char *type_name);
  52 LIBBPF_API __s32 btf__find_by_name_kind(const struct btf *btf,
  53                                         const char *type_name, __u32 kind);
  54 LIBBPF_API __u32 btf__get_nr_types(const struct btf *btf);
  55 LIBBPF_API const struct btf *btf__base_btf(const struct btf *btf);
  56 LIBBPF_API const struct btf_type *btf__type_by_id(const struct btf *btf,
  57                                                   __u32 id);
  58 LIBBPF_API size_t btf__pointer_size(const struct btf *btf);
  59 LIBBPF_API int btf__set_pointer_size(struct btf *btf, size_t ptr_sz);
  60 LIBBPF_API enum btf_endianness btf__endianness(const struct btf *btf);
  61 LIBBPF_API int btf__set_endianness(struct btf *btf, enum btf_endianness endian);
  62 LIBBPF_API __s64 btf__resolve_size(const struct btf *btf, __u32 type_id);
  63 LIBBPF_API int btf__resolve_type(const struct btf *btf, __u32 type_id);
  64 LIBBPF_API int btf__align_of(const struct btf *btf, __u32 id);
  65 LIBBPF_API int btf__fd(const struct btf *btf);
  66 LIBBPF_API void btf__set_fd(struct btf *btf, int fd);
  67 LIBBPF_API const void *btf__get_raw_data(const struct btf *btf, __u32 *size);
  68 LIBBPF_API const char *btf__name_by_offset(const struct btf *btf, __u32 offset);
  69 LIBBPF_API const char *btf__str_by_offset(const struct btf *btf, __u32 offset);
  70 LIBBPF_API int btf__get_from_id(__u32 id, struct btf **btf);
  71 LIBBPF_API int btf__get_map_kv_tids(const struct btf *btf, const char *map_name,
  72                                     __u32 expected_key_size,
  73                                     __u32 expected_value_size,
  74                                     __u32 *key_type_id, __u32 *value_type_id);
  75
  76 LIBBPF_API struct btf_ext *btf_ext__new(__u8 *data, __u32 size);
  77 LIBBPF_API void btf_ext__free(struct btf_ext *btf_ext);
  78 LIBBPF_API const void *btf_ext__get_raw_data(const struct btf_ext *btf_ext,
  79                                              __u32 *size);
  80 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")
  81 int btf_ext__reloc_func_info(const struct btf *btf,
  82                              const struct btf_ext *btf_ext,
  83                              const char *sec_name, __u32 insns_cnt,
  84                              void **func_info, __u32 *cnt);
  85 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")
  86 int btf_ext__reloc_line_info(const struct btf *btf,
  87                              const struct btf_ext *btf_ext,
  88                              const char *sec_name, __u32 insns_cnt,
  89                              void **line_info, __u32 *cnt);
  90 LIBBPF_API __u32 btf_ext__func_info_rec_size(const struct btf_ext *btf_ext);
  91 LIBBPF_API __u32 btf_ext__line_info_rec_size(const struct btf_ext *btf_ext);
  92
  93 LIBBPF_API struct btf *libbpf_find_kernel_btf(void);
  94
  95 LIBBPF_API int btf__find_str(struct btf *btf, const char *s);
  96 LIBBPF_API int btf__add_str(struct btf *btf, const char *s);
  97 LIBBPF_API int btf__add_type(struct btf *btf, const struct btf *src_btf,
  98                              const struct btf_type *src_type);
  99
 100 LIBBPF_API int btf__add_int(struct btf *btf, const char *name, size_t byte_sz, int encoding);
 101 LIBBPF_API int btf__add_float(struct btf *btf, const char *name, size_t byte_sz);
 102 LIBBPF_API int btf__add_ptr(struct btf *btf, int ref_type_id);
 103 LIBBPF_API int btf__add_array(struct btf *btf,
 104                               int index_type_id, int elem_type_id, __u32 nr_elems);
 105 /* struct/union construction APIs */
 106 LIBBPF_API int btf__add_struct(struct btf *btf, const char *name, __u32 sz);
 107 LIBBPF_API int btf__add_union(struct btf *btf, const char *name, __u32 sz);
 108 LIBBPF_API int btf__add_field(struct btf *btf, const char *name, int field_type_id,
 109                               __u32 bit_offset, __u32 bit_size);
 110
 111 /* enum construction APIs */
 112 LIBBPF_API int btf__add_enum(struct btf *btf, const char *name, __u32 bytes_sz);
 113 LIBBPF_API int btf__add_enum_value(struct btf *btf, const char *name, __s64 value);
 114
 115 enum btf_fwd_kind {
 116         BTF_FWD_STRUCT = 0,
 117         BTF_FWD_UNION = 1,
 118         BTF_FWD_ENUM = 2,
 119 };
 120
 121 LIBBPF_API int btf__add_fwd(struct btf *btf, const char *name, enum btf_fwd_kind fwd_kind);
 122 LIBBPF_API int btf__add_typedef(struct btf *btf, const char *name, int ref_type_id);
 123 LIBBPF_API int btf__add_volatile(struct btf *btf, int ref_type_id);
 124 LIBBPF_API int btf__add_const(struct btf *btf, int ref_type_id);
 125 LIBBPF_API int btf__add_restrict(struct btf *btf, int ref_type_id);
 126
 127 /* func and func_proto construction APIs */
 128 LIBBPF_API int btf__add_func(struct btf *btf, const char *name,
 129                              enum btf_func_linkage linkage, int proto_type_id);
 130 LIBBPF_API int btf__add_func_proto(struct btf *btf, int ret_type_id);
 131 LIBBPF_API int btf__add_func_param(struct btf *btf, const char *name, int type_id);
 132
 133 /* var & datasec construction APIs */
 134 LIBBPF_API int btf__add_var(struct btf *btf, const char *name, int linkage, int type_id);
 135 LIBBPF_API int btf__add_datasec(struct btf *btf, const char *name, __u32 byte_sz);
 136 LIBBPF_API int btf__add_datasec_var_info(struct btf *btf, int var_type_id,
 137                                          __u32 offset, __u32 byte_sz);
 138
 139 struct btf_dedup_opts {
 140         unsigned int dedup_table_size;
 141         bool dont_resolve_fwds;
 142 };
 143
 144 LIBBPF_API int btf__dedup(struct btf *btf, struct btf_ext *btf_ext,
 145                           const struct btf_dedup_opts *opts);
 146
 147 struct btf_dump;
 148
 149 struct btf_dump_opts {
 150         void *ctx;
 151 };
 152
 153 typedef void (*btf_dump_printf_fn_t)(void *ctx, const char *fmt, va_list args);
 154
 155 LIBBPF_API struct btf_dump *btf_dump__new(const struct btf *btf,
 156                                           const struct btf_ext *btf_ext,
 157                                           const struct btf_dump_opts *opts,
 158                                           btf_dump_printf_fn_t printf_fn);
 159 LIBBPF_API void btf_dump__free(struct btf_dump *d);
 160
 161 LIBBPF_API int btf_dump__dump_type(struct btf_dump *d, __u32 id);
 162
 163 struct btf_dump_emit_type_decl_opts {
 164         /* size of this struct, for forward/backward compatiblity */
 165         size_t sz;
 166         /* optional field name for type declaration, e.g.:
 167          * - struct my_struct <FNAME>
 168          * - void (*<FNAME>)(int)
 169          * - char (*<FNAME>)[123]
 170          */
 171         const char *field_name;
 172         /* extra indentation level (in number of tabs) to emit for multi-line
 173          * type declarations (e.g., anonymous struct); applies for lines
 174          * starting from the second one (first line is assumed to have
 175          * necessary indentation already
 176          */
 177         int indent_level;
 178         /* strip all the const/volatile/restrict mods */
 179         bool strip_mods;
 180         size_t :0;
 181 };
 182 #define btf_dump_emit_type_decl_opts__last_field strip_mods
 183
 184 LIBBPF_API int
 185 btf_dump__emit_type_decl(struct btf_dump *d, __u32 id,
 186                          const struct btf_dump_emit_type_decl_opts *opts);
 187
 188
 189 struct btf_dump_type_data_opts {
 190         /* size of this struct, for forward/backward compatibility */
 191         size_t sz;
 192         const char *indent_str;
 193         int indent_level;
 194         /* below match "show" flags for bpf_show_snprintf() */
 195         bool compact;           /* no newlines/indentation */
 196         bool skip_names;        /* skip member/type names */
 197         bool emit_zeroes;       /* show 0-valued fields */
 198         size_t :0;
 199 };
 200 #define btf_dump_type_data_opts__last_field emit_zeroes
 201
 202 LIBBPF_API int
 203 btf_dump__dump_type_data(struct btf_dump *d, __u32 id,
 204                          const void *data, size_t data_sz,
 205                          const struct btf_dump_type_data_opts *opts);
 206
 207 /*
 208  * A set of helpers for easier BTF types handling
 209  */
 210 static inline __u16 btf_kind(const struct btf_type *t)
 211 {
 212         return BTF_INFO_KIND(t->info);
 213 }
 214
 215 static inline __u16 btf_vlen(const struct btf_type *t)
 216 {
 217         return BTF_INFO_VLEN(t->info);
 218 }
 219
 220 static inline bool btf_kflag(const struct btf_type *t)
 221 {
 222         return BTF_INFO_KFLAG(t->info);
 223 }
 224
 225 static inline bool btf_is_void(const struct btf_type *t)
 226 {
 227         return btf_kind(t) == BTF_KIND_UNKN;
 228 }
 229
 230 static inline bool btf_is_int(const struct btf_type *t)
 231 {
 232         return btf_kind(t) == BTF_KIND_INT;
 233 }
 234
 235 static inline bool btf_is_ptr(const struct btf_type *t)
 236 {
 237         return btf_kind(t) == BTF_KIND_PTR;
 238 }
 239
 240 static inline bool btf_is_array(const struct btf_type *t)
 241 {
 242         return btf_kind(t) == BTF_KIND_ARRAY;
 243 }
 244
 245 static inline bool btf_is_struct(const struct btf_type *t)
 246 {
 247         return btf_kind(t) == BTF_KIND_STRUCT;
 248 }
 249
 250 static inline bool btf_is_union(const struct btf_type *t)
 251 {
 252         return btf_kind(t) == BTF_KIND_UNION;
 253 }
 254
 255 static inline bool btf_is_composite(const struct btf_type *t)
 256 {
 257         __u16 kind = btf_kind(t);
 258
 259         return kind == BTF_KIND_STRUCT || kind == BTF_KIND_UNION;
 260 }
 261
 262 static inline bool btf_is_enum(const struct btf_type *t)
 263 {
 264         return btf_kind(t) == BTF_KIND_ENUM;
 265 }
 266
 267 static inline bool btf_is_fwd(const struct btf_type *t)
 268 {
 269         return btf_kind(t) == BTF_KIND_FWD;
 270 }
 271
 272 static inline bool btf_is_typedef(const struct btf_type *t)
 273 {
 274         return btf_kind(t) == BTF_KIND_TYPEDEF;
 275 }
 276
 277 static inline bool btf_is_volatile(const struct btf_type *t)
 278 {
 279         return btf_kind(t) == BTF_KIND_VOLATILE;
 280 }
 281
 282 static inline bool btf_is_const(const struct btf_type *t)
 283 {
 284         return btf_kind(t) == BTF_KIND_CONST;
 285 }
 286
 287 static inline bool btf_is_restrict(const struct btf_type *t)
 288 {
 289         return btf_kind(t) == BTF_KIND_RESTRICT;
 290 }
 291
 292 static inline bool btf_is_mod(const struct btf_type *t)
 293 {
 294         __u16 kind = btf_kind(t);
 295
 296         return kind == BTF_KIND_VOLATILE ||
 297                kind == BTF_KIND_CONST ||
 298                kind == BTF_KIND_RESTRICT;
 299 }
 300
 301 static inline bool btf_is_func(const struct btf_type *t)
 302 {
 303         return btf_kind(t) == BTF_KIND_FUNC;
 304 }
 305
 306 static inline bool btf_is_func_proto(const struct btf_type *t)
 307 {
 308         return btf_kind(t) == BTF_KIND_FUNC_PROTO;
 309 }
 310
 311 static inline bool btf_is_var(const struct btf_type *t)
 312 {
 313         return btf_kind(t) == BTF_KIND_VAR;
 314 }
 315
 316 static inline bool btf_is_datasec(const struct btf_type *t)
 317 {
 318         return btf_kind(t) == BTF_KIND_DATASEC;
 319 }
 320
 321 static inline bool btf_is_float(const struct btf_type *t)
 322 {
 323         return btf_kind(t) == BTF_KIND_FLOAT;
 324 }
 325
 326 static inline __u8 btf_int_encoding(const struct btf_type *t)
 327 {
 328         return BTF_INT_ENCODING(*(__u32 *)(t + 1));
 329 }
 330
 331 static inline __u8 btf_int_offset(const struct btf_type *t)
 332 {
 333         return BTF_INT_OFFSET(*(__u32 *)(t + 1));
 334 }
 335
 336 static inline __u8 btf_int_bits(const struct btf_type *t)
 337 {
 338         return BTF_INT_BITS(*(__u32 *)(t + 1));
 339 }
 340
 341 static inline struct btf_array *btf_array(const struct btf_type *t)
 342 {
 343         return (struct btf_array *)(t + 1);
 344 }
 345
 346 static inline struct btf_enum *btf_enum(const struct btf_type *t)
 347 {
 348         return (struct btf_enum *)(t + 1);
 349 }
 350
 351 static inline struct btf_member *btf_members(const struct btf_type *t)
 352 {
 353         return (struct btf_member *)(t + 1);
 354 }
 355
 356 /* Get bit offset of a member with specified index. */
 357 static inline __u32 btf_member_bit_offset(const struct btf_type *t,
 358                                           __u32 member_idx)
 359 {
 360         const struct btf_member *m = btf_members(t) + member_idx;
 361         bool kflag = btf_kflag(t);
 362
 363         return kflag ? BTF_MEMBER_BIT_OFFSET(m->offset) : m->offset;
 364 }
 365 /*
 366  * Get bitfield size of a member, assuming t is BTF_KIND_STRUCT or
 367  * BTF_KIND_UNION. If member is not a bitfield, zero is returned.
 368  */
 369 static inline __u32 btf_member_bitfield_size(const struct btf_type *t,
 370                                              __u32 member_idx)
 371 {
 372         const struct btf_member *m = btf_members(t) + member_idx;
 373         bool kflag = btf_kflag(t);
 374
 375         return kflag ? BTF_MEMBER_BITFIELD_SIZE(m->offset) : 0;
 376 }
 377
 378 static inline struct btf_param *btf_params(const struct btf_type *t)
 379 {
 380         return (struct btf_param *)(t + 1);
 381 }
 382
 383 static inline struct btf_var *btf_var(const struct btf_type *t)
 384 {
 385         return (struct btf_var *)(t + 1);
 386 }
 387
 388 static inline struct btf_var_secinfo *
 389 btf_var_secinfos(const struct btf_type *t)
 390 {
 391         return (struct btf_var_secinfo *)(t + 1);
 392 }
 393
 394 #ifdef __cplusplus
 395 } /* extern "C" */
 396 #endif
 397
 398 #endif /* __LIBBPF_BTF_H */