1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * elf.c - ELF access library
5 * Adapted from kpatch (https://github.com/dynup/kpatch):
6 * Copyright (C) 2013-2015 Josh Poimboeuf <jpoimboe@redhat.com>
7 * Copyright (C) 2014 Seth Jennings <sjenning@redhat.com>
10 #include <sys/types.h>
23 #define MAX_NAME_LEN 128
25 static inline u32 str_hash(const char *str)
27 return jhash(str, strlen(str), 0);
30 static inline int elf_hash_bits(void)
32 return vmlinux ? ELF_HASH_BITS : 16;
35 #define elf_hash_add(hashtable, node, key) \
36 hlist_add_head(node, &hashtable[hash_min(key, elf_hash_bits())])
38 static void elf_hash_init(struct hlist_head *table)
40 __hash_init(table, 1U << elf_hash_bits());
43 #define elf_hash_for_each_possible(name, obj, member, key) \
44 hlist_for_each_entry(obj, &name[hash_min(key, elf_hash_bits())], member)
46 static void rb_add(struct rb_root *tree, struct rb_node *node,
47 int (*cmp)(struct rb_node *, const struct rb_node *))
49 struct rb_node **link = &tree->rb_node;
50 struct rb_node *parent = NULL;
54 if (cmp(node, parent) < 0)
55 link = &parent->rb_left;
57 link = &parent->rb_right;
60 rb_link_node(node, parent, link);
61 rb_insert_color(node, tree);
64 static struct rb_node *rb_find_first(const struct rb_root *tree, const void *key,
65 int (*cmp)(const void *key, const struct rb_node *))
67 struct rb_node *node = tree->rb_node;
68 struct rb_node *match = NULL;
71 int c = cmp(key, node);
77 node = node->rb_right;
84 static struct rb_node *rb_next_match(struct rb_node *node, const void *key,
85 int (*cmp)(const void *key, const struct rb_node *))
88 if (node && cmp(key, node))
93 #define rb_for_each(tree, node, key, cmp) \
94 for ((node) = rb_find_first((tree), (key), (cmp)); \
95 (node); (node) = rb_next_match((node), (key), (cmp)))
97 static int symbol_to_offset(struct rb_node *a, const struct rb_node *b)
99 struct symbol *sa = rb_entry(a, struct symbol, node);
100 struct symbol *sb = rb_entry(b, struct symbol, node);
102 if (sa->offset < sb->offset)
104 if (sa->offset > sb->offset)
107 if (sa->len < sb->len)
109 if (sa->len > sb->len)
117 static int symbol_by_offset(const void *key, const struct rb_node *node)
119 const struct symbol *s = rb_entry(node, struct symbol, node);
120 const unsigned long *o = key;
124 if (*o >= s->offset + s->len)
130 struct section *find_section_by_name(const struct elf *elf, const char *name)
134 elf_hash_for_each_possible(elf->section_name_hash, sec, name_hash, str_hash(name))
135 if (!strcmp(sec->name, name))
141 static struct section *find_section_by_index(struct elf *elf,
146 elf_hash_for_each_possible(elf->section_hash, sec, hash, idx)
153 static struct symbol *find_symbol_by_index(struct elf *elf, unsigned int idx)
157 elf_hash_for_each_possible(elf->symbol_hash, sym, hash, idx)
164 struct symbol *find_symbol_by_offset(struct section *sec, unsigned long offset)
166 struct rb_node *node;
168 rb_for_each(&sec->symbol_tree, node, &offset, symbol_by_offset) {
169 struct symbol *s = rb_entry(node, struct symbol, node);
171 if (s->offset == offset && s->type != STT_SECTION)
178 struct symbol *find_func_by_offset(struct section *sec, unsigned long offset)
180 struct rb_node *node;
182 rb_for_each(&sec->symbol_tree, node, &offset, symbol_by_offset) {
183 struct symbol *s = rb_entry(node, struct symbol, node);
185 if (s->offset == offset && s->type == STT_FUNC)
192 struct symbol *find_symbol_containing(const struct section *sec, unsigned long offset)
194 struct rb_node *node;
196 rb_for_each(&sec->symbol_tree, node, &offset, symbol_by_offset) {
197 struct symbol *s = rb_entry(node, struct symbol, node);
199 if (s->type != STT_SECTION)
206 struct symbol *find_func_containing(struct section *sec, unsigned long offset)
208 struct rb_node *node;
210 rb_for_each(&sec->symbol_tree, node, &offset, symbol_by_offset) {
211 struct symbol *s = rb_entry(node, struct symbol, node);
213 if (s->type == STT_FUNC)
220 struct symbol *find_symbol_by_name(const struct elf *elf, const char *name)
224 elf_hash_for_each_possible(elf->symbol_name_hash, sym, name_hash, str_hash(name))
225 if (!strcmp(sym->name, name))
231 struct rela *find_rela_by_dest_range(const struct elf *elf, struct section *sec,
232 unsigned long offset, unsigned int len)
234 struct rela *rela, *r = NULL;
242 for_offset_range(o, offset, offset + len) {
243 elf_hash_for_each_possible(elf->rela_hash, rela, hash,
244 sec_offset_hash(sec, o)) {
245 if (rela->sec != sec)
248 if (rela->offset >= offset && rela->offset < offset + len) {
249 if (!r || rela->offset < r->offset)
260 struct rela *find_rela_by_dest(const struct elf *elf, struct section *sec, unsigned long offset)
262 return find_rela_by_dest_range(elf, sec, offset, 1);
265 static int read_sections(struct elf *elf)
269 size_t shstrndx, sections_nr;
272 if (elf_getshdrnum(elf->elf, §ions_nr)) {
273 WARN_ELF("elf_getshdrnum");
277 if (elf_getshdrstrndx(elf->elf, &shstrndx)) {
278 WARN_ELF("elf_getshdrstrndx");
282 for (i = 0; i < sections_nr; i++) {
283 sec = malloc(sizeof(*sec));
288 memset(sec, 0, sizeof(*sec));
290 INIT_LIST_HEAD(&sec->symbol_list);
291 INIT_LIST_HEAD(&sec->rela_list);
293 s = elf_getscn(elf->elf, i);
295 WARN_ELF("elf_getscn");
299 sec->idx = elf_ndxscn(s);
301 if (!gelf_getshdr(s, &sec->sh)) {
302 WARN_ELF("gelf_getshdr");
306 sec->name = elf_strptr(elf->elf, shstrndx, sec->sh.sh_name);
308 WARN_ELF("elf_strptr");
312 if (sec->sh.sh_size != 0) {
313 sec->data = elf_getdata(s, NULL);
315 WARN_ELF("elf_getdata");
318 if (sec->data->d_off != 0 ||
319 sec->data->d_size != sec->sh.sh_size) {
320 WARN("unexpected data attributes for %s",
325 sec->len = sec->sh.sh_size;
327 list_add_tail(&sec->list, &elf->sections);
328 elf_hash_add(elf->section_hash, &sec->hash, sec->idx);
329 elf_hash_add(elf->section_name_hash, &sec->name_hash, str_hash(sec->name));
333 printf("nr_sections: %lu\n", (unsigned long)sections_nr);
335 /* sanity check, one more call to elf_nextscn() should return NULL */
336 if (elf_nextscn(elf->elf, s)) {
337 WARN("section entry mismatch");
344 static int read_symbols(struct elf *elf)
346 struct section *symtab, *symtab_shndx, *sec;
347 struct symbol *sym, *pfunc;
348 struct list_head *entry;
349 struct rb_node *pnode;
352 Elf_Data *shndx_data = NULL;
355 symtab = find_section_by_name(elf, ".symtab");
357 WARN("missing symbol table");
361 symtab_shndx = find_section_by_name(elf, ".symtab_shndx");
363 shndx_data = symtab_shndx->data;
365 symbols_nr = symtab->sh.sh_size / symtab->sh.sh_entsize;
367 for (i = 0; i < symbols_nr; i++) {
368 sym = malloc(sizeof(*sym));
373 memset(sym, 0, sizeof(*sym));
378 if (!gelf_getsymshndx(symtab->data, shndx_data, i, &sym->sym,
380 WARN_ELF("gelf_getsymshndx");
384 sym->name = elf_strptr(elf->elf, symtab->sh.sh_link,
387 WARN_ELF("elf_strptr");
391 sym->type = GELF_ST_TYPE(sym->sym.st_info);
392 sym->bind = GELF_ST_BIND(sym->sym.st_info);
394 if ((sym->sym.st_shndx > SHN_UNDEF &&
395 sym->sym.st_shndx < SHN_LORESERVE) ||
396 (shndx_data && sym->sym.st_shndx == SHN_XINDEX)) {
397 if (sym->sym.st_shndx != SHN_XINDEX)
398 shndx = sym->sym.st_shndx;
400 sym->sec = find_section_by_index(elf, shndx);
402 WARN("couldn't find section for symbol %s",
406 if (sym->type == STT_SECTION) {
407 sym->name = sym->sec->name;
411 sym->sec = find_section_by_index(elf, 0);
413 sym->offset = sym->sym.st_value;
414 sym->len = sym->sym.st_size;
416 rb_add(&sym->sec->symbol_tree, &sym->node, symbol_to_offset);
417 pnode = rb_prev(&sym->node);
419 entry = &rb_entry(pnode, struct symbol, node)->list;
421 entry = &sym->sec->symbol_list;
422 list_add(&sym->list, entry);
423 elf_hash_add(elf->symbol_hash, &sym->hash, sym->idx);
424 elf_hash_add(elf->symbol_name_hash, &sym->name_hash, str_hash(sym->name));
428 printf("nr_symbols: %lu\n", (unsigned long)symbols_nr);
430 /* Create parent/child links for any cold subfunctions */
431 list_for_each_entry(sec, &elf->sections, list) {
432 list_for_each_entry(sym, &sec->symbol_list, list) {
433 char pname[MAX_NAME_LEN + 1];
435 if (sym->type != STT_FUNC)
437 sym->pfunc = sym->cfunc = sym;
438 coldstr = strstr(sym->name, ".cold");
442 pnamelen = coldstr - sym->name;
443 if (pnamelen > MAX_NAME_LEN) {
444 WARN("%s(): parent function name exceeds maximum length of %d characters",
445 sym->name, MAX_NAME_LEN);
449 strncpy(pname, sym->name, pnamelen);
450 pname[pnamelen] = '\0';
451 pfunc = find_symbol_by_name(elf, pname);
454 WARN("%s(): can't find parent function",
463 * Unfortunately, -fnoreorder-functions puts the child
464 * inside the parent. Remove the overlap so we can
465 * have sane assumptions.
467 * Note that pfunc->len now no longer matches
468 * pfunc->sym.st_size.
470 if (sym->sec == pfunc->sec &&
471 sym->offset >= pfunc->offset &&
472 sym->offset + sym->len == pfunc->offset + pfunc->len) {
473 pfunc->len -= sym->len;
485 void elf_add_rela(struct elf *elf, struct rela *rela)
487 struct section *sec = rela->sec;
489 list_add_tail(&rela->list, &sec->rela_list);
490 elf_hash_add(elf->rela_hash, &rela->hash, rela_hash(rela));
493 static int read_relas(struct elf *elf)
499 unsigned long nr_rela, max_rela = 0, tot_rela = 0;
501 list_for_each_entry(sec, &elf->sections, list) {
502 if (sec->sh.sh_type != SHT_RELA)
505 sec->base = find_section_by_name(elf, sec->name + 5);
507 WARN("can't find base section for rela section %s",
512 sec->base->rela = sec;
515 for (i = 0; i < sec->sh.sh_size / sec->sh.sh_entsize; i++) {
516 rela = malloc(sizeof(*rela));
521 memset(rela, 0, sizeof(*rela));
523 if (!gelf_getrela(sec->data, i, &rela->rela)) {
524 WARN_ELF("gelf_getrela");
528 rela->type = GELF_R_TYPE(rela->rela.r_info);
529 rela->addend = rela->rela.r_addend;
530 rela->offset = rela->rela.r_offset;
531 symndx = GELF_R_SYM(rela->rela.r_info);
534 rela->sym = find_symbol_by_index(elf, symndx);
536 WARN("can't find rela entry symbol %d for %s",
541 elf_add_rela(elf, rela);
544 max_rela = max(max_rela, nr_rela);
549 printf("max_rela: %lu\n", max_rela);
550 printf("tot_rela: %lu\n", tot_rela);
556 struct elf *elf_open_read(const char *name, int flags)
561 elf_version(EV_CURRENT);
563 elf = malloc(sizeof(*elf));
568 memset(elf, 0, offsetof(struct elf, sections));
570 INIT_LIST_HEAD(&elf->sections);
572 elf_hash_init(elf->symbol_hash);
573 elf_hash_init(elf->symbol_name_hash);
574 elf_hash_init(elf->section_hash);
575 elf_hash_init(elf->section_name_hash);
576 elf_hash_init(elf->rela_hash);
578 elf->fd = open(name, flags);
580 fprintf(stderr, "objtool: Can't open '%s': %s\n",
581 name, strerror(errno));
585 if ((flags & O_ACCMODE) == O_RDONLY)
586 cmd = ELF_C_READ_MMAP;
587 else if ((flags & O_ACCMODE) == O_RDWR)
592 elf->elf = elf_begin(elf->fd, cmd, NULL);
594 WARN_ELF("elf_begin");
598 if (!gelf_getehdr(elf->elf, &elf->ehdr)) {
599 WARN_ELF("gelf_getehdr");
603 if (read_sections(elf))
606 if (read_symbols(elf))
619 struct section *elf_create_section(struct elf *elf, const char *name,
620 size_t entsize, int nr)
622 struct section *sec, *shstrtab;
623 size_t size = entsize * nr;
627 sec = malloc(sizeof(*sec));
632 memset(sec, 0, sizeof(*sec));
634 INIT_LIST_HEAD(&sec->symbol_list);
635 INIT_LIST_HEAD(&sec->rela_list);
637 s = elf_newscn(elf->elf);
639 WARN_ELF("elf_newscn");
643 sec->name = strdup(name);
649 sec->idx = elf_ndxscn(s);
653 sec->data = elf_newdata(s);
655 WARN_ELF("elf_newdata");
659 sec->data->d_size = size;
660 sec->data->d_align = 1;
663 sec->data->d_buf = malloc(size);
664 if (!sec->data->d_buf) {
668 memset(sec->data->d_buf, 0, size);
671 if (!gelf_getshdr(s, &sec->sh)) {
672 WARN_ELF("gelf_getshdr");
676 sec->sh.sh_size = size;
677 sec->sh.sh_entsize = entsize;
678 sec->sh.sh_type = SHT_PROGBITS;
679 sec->sh.sh_addralign = 1;
680 sec->sh.sh_flags = SHF_ALLOC;
683 /* Add section name to .shstrtab (or .strtab for Clang) */
684 shstrtab = find_section_by_name(elf, ".shstrtab");
686 shstrtab = find_section_by_name(elf, ".strtab");
688 WARN("can't find .shstrtab or .strtab section");
692 s = elf_getscn(elf->elf, shstrtab->idx);
694 WARN_ELF("elf_getscn");
698 data = elf_newdata(s);
700 WARN_ELF("elf_newdata");
704 data->d_buf = sec->name;
705 data->d_size = strlen(name) + 1;
708 sec->sh.sh_name = shstrtab->len;
710 shstrtab->len += strlen(name) + 1;
711 shstrtab->changed = true;
713 list_add_tail(&sec->list, &elf->sections);
714 elf_hash_add(elf->section_hash, &sec->hash, sec->idx);
715 elf_hash_add(elf->section_name_hash, &sec->name_hash, str_hash(sec->name));
722 struct section *elf_create_rela_section(struct elf *elf, struct section *base)
727 relaname = malloc(strlen(base->name) + strlen(".rela") + 1);
732 strcpy(relaname, ".rela");
733 strcat(relaname, base->name);
735 sec = elf_create_section(elf, relaname, sizeof(GElf_Rela), 0);
743 sec->sh.sh_type = SHT_RELA;
744 sec->sh.sh_addralign = 8;
745 sec->sh.sh_link = find_section_by_name(elf, ".symtab")->idx;
746 sec->sh.sh_info = base->idx;
747 sec->sh.sh_flags = SHF_INFO_LINK;
752 int elf_rebuild_rela_section(struct elf *elf, struct section *sec)
755 int nr, idx = 0, size;
759 list_for_each_entry(rela, &sec->rela_list, list)
762 size = nr * sizeof(*relas);
763 relas = malloc(size);
772 sec->data->d_buf = relas;
773 sec->data->d_size = size;
775 sec->sh.sh_size = size;
778 list_for_each_entry(rela, &sec->rela_list, list) {
779 relas[idx].r_offset = rela->offset;
780 relas[idx].r_addend = rela->addend;
781 relas[idx].r_info = GELF_R_INFO(rela->sym->idx, rela->type);
788 int elf_write_insn(struct elf *elf, struct section *sec,
789 unsigned long offset, unsigned int len,
792 Elf_Data *data = sec->data;
794 if (data->d_type != ELF_T_BYTE || data->d_off) {
795 WARN("write to unexpected data for section: %s", sec->name);
799 memcpy(data->d_buf + offset, insn, len);
800 elf_flagdata(data, ELF_C_SET, ELF_F_DIRTY);
807 int elf_write_rela(struct elf *elf, struct rela *rela)
809 struct section *sec = rela->sec;
811 rela->rela.r_info = GELF_R_INFO(rela->sym->idx, rela->type);
812 rela->rela.r_addend = rela->addend;
813 rela->rela.r_offset = rela->offset;
815 if (!gelf_update_rela(sec->data, rela->idx, &rela->rela)) {
816 WARN_ELF("gelf_update_rela");
825 int elf_write(struct elf *elf)
830 /* Update section headers for changed sections: */
831 list_for_each_entry(sec, &elf->sections, list) {
833 s = elf_getscn(elf->elf, sec->idx);
835 WARN_ELF("elf_getscn");
838 if (!gelf_update_shdr(s, &sec->sh)) {
839 WARN_ELF("gelf_update_shdr");
843 sec->changed = false;
847 /* Make sure the new section header entries get updated properly. */
848 elf_flagelf(elf->elf, ELF_C_SET, ELF_F_DIRTY);
850 /* Write all changes to the file. */
851 if (elf_update(elf->elf, ELF_C_WRITE) < 0) {
852 WARN_ELF("elf_update");
856 elf->changed = false;
861 void elf_close(struct elf *elf)
863 struct section *sec, *tmpsec;
864 struct symbol *sym, *tmpsym;
865 struct rela *rela, *tmprela;
873 list_for_each_entry_safe(sec, tmpsec, &elf->sections, list) {
874 list_for_each_entry_safe(sym, tmpsym, &sec->symbol_list, list) {
875 list_del(&sym->list);
876 hash_del(&sym->hash);
879 list_for_each_entry_safe(rela, tmprela, &sec->rela_list, list) {
880 list_del(&rela->list);
881 hash_del(&rela->hash);
884 list_del(&sec->list);