1 // SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
4 * resolve_btfids scans Elf object for .BTF_ids section and resolves
5 * its symbols with BTF ID values.
7 * Each symbol points to 4 bytes data and is expected to have
8 * following name syntax:
10 * __BTF_ID__<type>__<symbol>[__<id>]
14 * func - lookup BTF_KIND_FUNC symbol with <symbol> name
15 * and store its ID into the data:
17 * __BTF_ID__func__vfs_close__1:
20 * struct - lookup BTF_KIND_STRUCT symbol with <symbol> name
21 * and store its ID into the data:
23 * __BTF_ID__struct__sk_buff__1:
26 * union - lookup BTF_KIND_UNION symbol with <symbol> name
27 * and store its ID into the data:
29 * __BTF_ID__union__thread_union__1:
32 * typedef - lookup BTF_KIND_TYPEDEF symbol with <symbol> name
33 * and store its ID into the data:
35 * __BTF_ID__typedef__pid_t__1:
38 * set - store symbol size into first 4 bytes and sort following
41 * __BTF_ID__set__list:
44 * __BTF_ID__func__vfs_getattr__3:
46 * __BTF_ID__func__vfs_fallocate__4:
60 #include <linux/rbtree.h>
61 #include <linux/zalloc.h>
62 #include <linux/err.h>
65 #include <parse-options.h>
67 #define BTF_IDS_SECTION ".BTF_ids"
68 #define BTF_ID "__BTF_ID__"
70 #define BTF_STRUCT "struct"
71 #define BTF_UNION "union"
72 #define BTF_TYPEDEF "typedef"
73 #define BTF_FUNC "func"
79 struct rb_node rb_node;
86 Elf64_Addr addr[ADDR_CNT];
101 unsigned long idlist_addr;
105 struct rb_root structs;
106 struct rb_root unions;
107 struct rb_root typedefs;
108 struct rb_root funcs;
118 int eprintf(int level, int var, const char *fmt, ...)
125 ret = vfprintf(stderr, fmt, args);
132 #define pr_fmt(fmt) fmt
135 #define pr_debug(fmt, ...) \
136 eprintf(1, verbose, pr_fmt(fmt), ##__VA_ARGS__)
137 #define pr_debugN(n, fmt, ...) \
138 eprintf(n, verbose, pr_fmt(fmt), ##__VA_ARGS__)
139 #define pr_debug2(fmt, ...) pr_debugN(2, pr_fmt(fmt), ##__VA_ARGS__)
140 #define pr_err(fmt, ...) \
141 eprintf(0, verbose, pr_fmt(fmt), ##__VA_ARGS__)
143 static bool is_btf_id(const char *name)
145 return name && !strncmp(name, BTF_ID, sizeof(BTF_ID) - 1);
148 static struct btf_id *btf_id__find(struct rb_root *root, const char *name)
150 struct rb_node *p = root->rb_node;
155 id = rb_entry(p, struct btf_id, rb_node);
156 cmp = strcmp(id->name, name);
167 static struct btf_id*
168 btf_id__add(struct rb_root *root, char *name, bool unique)
170 struct rb_node **p = &root->rb_node;
171 struct rb_node *parent = NULL;
177 id = rb_entry(parent, struct btf_id, rb_node);
178 cmp = strcmp(id->name, name);
184 return unique ? NULL : id;
187 id = zalloc(sizeof(*id));
189 pr_debug("adding symbol %s\n", name);
191 rb_link_node(&id->rb_node, parent, p);
192 rb_insert_color(&id->rb_node, root);
197 static char *get_id(const char *prefix_end)
200 * __BTF_ID__func__vfs_truncate__0
204 int len = strlen(prefix_end);
205 int pos = sizeof("__") - 1;
211 id = strdup(prefix_end + pos);
214 * __BTF_ID__func__vfs_truncate__0
217 * cut the unique id part
219 p = strrchr(id, '_');
230 static struct btf_id *add_set(struct object *obj, char *name)
233 * __BTF_ID__set__name
237 char *id = name + sizeof(BTF_SET "__") - 1;
238 int len = strlen(name);
240 if (id >= name + len) {
241 pr_err("FAILED to parse set name: %s\n", name);
245 return btf_id__add(&obj->sets, id, true);
248 static struct btf_id *add_symbol(struct rb_root *root, char *name, size_t size)
252 id = get_id(name + size);
254 pr_err("FAILED to parse symbol name: %s\n", name);
258 return btf_id__add(root, id, false);
261 /* Older libelf.h and glibc elf.h might not yet define the ELF compression types. */
262 #ifndef SHF_COMPRESSED
263 #define SHF_COMPRESSED (1 << 11) /* Section with compressed data. */
267 * The data of compressed section should be aligned to 4
268 * (for 32bit) or 8 (for 64 bit) bytes. The binutils ld
269 * sets sh_addralign to 1, which makes libelf fail with
270 * misaligned section error during the update:
271 * FAILED elf_update(WRITE): invalid section alignment
273 * While waiting for ld fix, we fix the compressed sections
274 * sh_addralign value manualy.
276 static int compressed_section_fix(Elf *elf, Elf_Scn *scn, GElf_Shdr *sh)
278 int expected = gelf_getclass(elf) == ELFCLASS32 ? 4 : 8;
280 if (!(sh->sh_flags & SHF_COMPRESSED))
283 if (sh->sh_addralign == expected)
286 pr_debug2(" - fixing wrong alignment sh_addralign %u, expected %u\n",
287 sh->sh_addralign, expected);
289 sh->sh_addralign = expected;
291 if (gelf_update_shdr(scn, sh) == 0) {
292 printf("FAILED cannot update section header: %s\n",
299 static int elf_collect(struct object *obj)
307 fd = open(obj->path, O_RDWR, 0666);
309 pr_err("FAILED cannot open %s: %s\n",
310 obj->path, strerror(errno));
314 elf_version(EV_CURRENT);
316 elf = elf_begin(fd, ELF_C_RDWR_MMAP, NULL);
318 pr_err("FAILED cannot create ELF descriptor: %s\n",
324 obj->efile.elf = elf;
326 elf_flagelf(elf, ELF_C_SET, ELF_F_LAYOUT);
328 if (elf_getshdrstrndx(elf, &shdrstrndx) != 0) {
329 pr_err("FAILED cannot get shdr str ndx\n");
334 * Scan all the elf sections and look for save data
335 * from .BTF_ids section and symbols.
337 while ((scn = elf_nextscn(elf, scn)) != NULL) {
343 if (gelf_getshdr(scn, &sh) != &sh) {
344 pr_err("FAILED get section(%d) header\n", idx);
348 name = elf_strptr(elf, shdrstrndx, sh.sh_name);
350 pr_err("FAILED get section(%d) name\n", idx);
354 data = elf_getdata(scn, 0);
356 pr_err("FAILED to get section(%d) data from %s\n",
361 pr_debug2("section(%d) %s, size %ld, link %d, flags %lx, type=%d\n",
362 idx, name, (unsigned long) data->d_size,
363 (int) sh.sh_link, (unsigned long) sh.sh_flags,
366 if (sh.sh_type == SHT_SYMTAB) {
367 obj->efile.symbols = data;
368 obj->efile.symbols_shndx = idx;
369 obj->efile.strtabidx = sh.sh_link;
370 } else if (!strcmp(name, BTF_IDS_SECTION)) {
371 obj->efile.idlist = data;
372 obj->efile.idlist_shndx = idx;
373 obj->efile.idlist_addr = sh.sh_addr;
376 if (compressed_section_fix(elf, scn, &sh))
383 static int symbols_collect(struct object *obj)
390 scn = elf_getscn(obj->efile.elf, obj->efile.symbols_shndx);
394 if (gelf_getshdr(scn, &sh) != &sh)
397 n = sh.sh_size / sh.sh_entsize;
400 * Scan symbols and look for the ones starting with
401 * __BTF_ID__* over .BTF_ids section.
403 for (i = 0; !err && i < n; i++) {
409 if (!gelf_getsym(obj->efile.symbols, i, &sym))
412 if (sym.st_shndx != obj->efile.idlist_shndx)
415 name = elf_strptr(obj->efile.elf, obj->efile.strtabidx,
418 if (!is_btf_id(name))
422 * __BTF_ID__TYPE__vfs_truncate__0
425 prefix = name + sizeof(BTF_ID) - 1;
428 if (!strncmp(prefix, BTF_STRUCT, sizeof(BTF_STRUCT) - 1)) {
430 id = add_symbol(&obj->structs, prefix, sizeof(BTF_STRUCT) - 1);
432 } else if (!strncmp(prefix, BTF_UNION, sizeof(BTF_UNION) - 1)) {
434 id = add_symbol(&obj->unions, prefix, sizeof(BTF_UNION) - 1);
436 } else if (!strncmp(prefix, BTF_TYPEDEF, sizeof(BTF_TYPEDEF) - 1)) {
438 id = add_symbol(&obj->typedefs, prefix, sizeof(BTF_TYPEDEF) - 1);
440 } else if (!strncmp(prefix, BTF_FUNC, sizeof(BTF_FUNC) - 1)) {
442 id = add_symbol(&obj->funcs, prefix, sizeof(BTF_FUNC) - 1);
444 } else if (!strncmp(prefix, BTF_SET, sizeof(BTF_SET) - 1)) {
445 id = add_set(obj, prefix);
447 * SET objects store list's count, which is encoded
448 * in symbol's size, together with 'cnt' field hence
452 id->cnt = sym.st_size / sizeof(int) - 1;
454 pr_err("FAILED unsupported prefix %s\n", prefix);
461 if (id->addr_cnt >= ADDR_CNT) {
462 pr_err("FAILED symbol %s crossed the number of allowed lists",
466 id->addr[id->addr_cnt++] = sym.st_value;
472 static int symbols_resolve(struct object *obj)
474 int nr_typedefs = obj->nr_typedefs;
475 int nr_structs = obj->nr_structs;
476 int nr_unions = obj->nr_unions;
477 int nr_funcs = obj->nr_funcs;
482 btf = btf__parse(obj->btf ?: obj->path, NULL);
483 err = libbpf_get_error(btf);
485 pr_err("FAILED: load BTF from %s: %s",
486 obj->path, strerror(err));
491 nr = btf__get_nr_types(btf);
494 * Iterate all the BTF types and search for collected symbol IDs.
496 for (type_id = 1; type_id <= nr; type_id++) {
497 const struct btf_type *type;
498 struct rb_root *root;
503 type = btf__type_by_id(btf, type_id);
505 pr_err("FAILED: malformed BTF, can't resolve type for ID %d\n",
510 if (btf_is_func(type) && nr_funcs) {
513 } else if (btf_is_struct(type) && nr_structs) {
515 root = &obj->structs;
516 } else if (btf_is_union(type) && nr_unions) {
519 } else if (btf_is_typedef(type) && nr_typedefs) {
521 root = &obj->typedefs;
525 str = btf__name_by_offset(btf, type->name_off);
527 pr_err("FAILED: malformed BTF, can't resolve name for ID %d\n",
532 id = btf_id__find(root, str);
545 static int id_patch(struct object *obj, struct btf_id *id)
547 Elf_Data *data = obj->efile.idlist;
548 int *ptr = data->d_buf;
552 pr_err("FAILED unresolved symbol %s\n", id->name);
556 for (i = 0; i < id->addr_cnt; i++) {
557 unsigned long addr = id->addr[i];
558 unsigned long idx = addr - obj->efile.idlist_addr;
560 pr_debug("patching addr %5lu: ID %7d [%s]\n",
561 idx, id->id, id->name);
563 if (idx >= data->d_size) {
564 pr_err("FAILED patching index %lu out of bounds %lu\n",
569 idx = idx / sizeof(int);
576 static int __symbols_patch(struct object *obj, struct rb_root *root)
578 struct rb_node *next;
581 next = rb_first(root);
583 id = rb_entry(next, struct btf_id, rb_node);
585 if (id_patch(obj, id))
588 next = rb_next(next);
593 static int cmp_id(const void *pa, const void *pb)
595 const int *a = pa, *b = pb;
600 static int sets_patch(struct object *obj)
602 Elf_Data *data = obj->efile.idlist;
603 int *ptr = data->d_buf;
604 struct rb_node *next;
606 next = rb_first(&obj->sets);
608 unsigned long addr, idx;
613 id = rb_entry(next, struct btf_id, rb_node);
615 idx = addr - obj->efile.idlist_addr;
617 /* sets are unique */
618 if (id->addr_cnt != 1) {
619 pr_err("FAILED malformed data for set '%s'\n",
624 idx = idx / sizeof(int);
625 base = &ptr[idx] + 1;
628 pr_debug("sorting addr %5lu: cnt %6d [%s]\n",
629 (idx + 1) * sizeof(int), cnt, id->name);
631 qsort(base, cnt, sizeof(int), cmp_id);
633 next = rb_next(next);
638 static int symbols_patch(struct object *obj)
642 if (__symbols_patch(obj, &obj->structs) ||
643 __symbols_patch(obj, &obj->unions) ||
644 __symbols_patch(obj, &obj->typedefs) ||
645 __symbols_patch(obj, &obj->funcs) ||
646 __symbols_patch(obj, &obj->sets))
652 /* Set type to ensure endian translation occurs. */
653 obj->efile.idlist->d_type = ELF_T_WORD;
655 elf_flagdata(obj->efile.idlist, ELF_C_SET, ELF_F_DIRTY);
657 err = elf_update(obj->efile.elf, ELF_C_WRITE);
659 pr_err("FAILED elf_update(WRITE): %s\n",
663 pr_debug("update %s for %s\n",
664 err >= 0 ? "ok" : "failed", obj->path);
665 return err < 0 ? -1 : 0;
668 static const char * const resolve_btfids_usage[] = {
669 "resolve_btfids [<options>] <ELF object>",
673 int main(int argc, const char **argv)
675 bool no_fail = false;
676 struct object obj = {
687 struct option btfid_options[] = {
688 OPT_INCR('v', "verbose", &verbose,
689 "be more verbose (show errors, etc)"),
690 OPT_STRING(0, "btf", &obj.btf, "BTF data",
692 OPT_BOOLEAN(0, "no-fail", &no_fail,
693 "do not fail if " BTF_IDS_SECTION " section is not found"),
698 argc = parse_options(argc, argv, btfid_options, resolve_btfids_usage,
699 PARSE_OPT_STOP_AT_NON_OPTION);
701 usage_with_options(resolve_btfids_usage, btfid_options);
705 if (elf_collect(&obj))
709 * We did not find .BTF_ids section or symbols section,
712 if (obj.efile.idlist_shndx == -1 ||
713 obj.efile.symbols_shndx == -1) {
716 pr_err("FAILED to find needed sections\n");
720 if (symbols_collect(&obj))
723 if (symbols_resolve(&obj))
726 if (symbols_patch(&obj))
732 elf_end(obj.efile.elf);