xref: /linux-6.15/tools/objtool/orc_dump.c (revision 3e7be635)
11ccea77eSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2627fce14SJosh Poimboeuf /*
3627fce14SJosh Poimboeuf  * Copyright (C) 2017 Josh Poimboeuf <[email protected]>
4627fce14SJosh Poimboeuf  */
5627fce14SJosh Poimboeuf 
6627fce14SJosh Poimboeuf #include <unistd.h>
70decf1f8SMatt Helsley #include <asm/orc_types.h>
87786032eSVasily Gorbik #include <objtool/objtool.h>
9b8e85e6fSTiezhu Yang #include <objtool/orc.h>
107786032eSVasily Gorbik #include <objtool/warn.h>
117786032eSVasily Gorbik #include <objtool/endianness.h>
12627fce14SJosh Poimboeuf 
orc_dump(const char * filename)135a406031SJosh Poimboeuf int orc_dump(const char *filename)
14627fce14SJosh Poimboeuf {
15627fce14SJosh Poimboeuf 	int fd, nr_entries, i, *orc_ip = NULL, orc_size = 0;
16627fce14SJosh Poimboeuf 	struct orc_entry *orc = NULL;
17627fce14SJosh Poimboeuf 	char *name;
1814c47b54SMikulas Patocka 	size_t nr_sections;
1914c47b54SMikulas Patocka 	Elf64_Addr orc_ip_addr = 0;
208782e7caSJosh Poimboeuf 	size_t shstrtab_idx, strtab_idx = 0;
21627fce14SJosh Poimboeuf 	Elf *elf;
22627fce14SJosh Poimboeuf 	Elf_Scn *scn;
23627fce14SJosh Poimboeuf 	GElf_Shdr sh;
24627fce14SJosh Poimboeuf 	GElf_Rela rela;
25627fce14SJosh Poimboeuf 	GElf_Sym sym;
26627fce14SJosh Poimboeuf 	Elf_Data *data, *symtab = NULL, *rela_orc_ip = NULL;
270646c28bSChristophe Leroy 	struct elf dummy_elf = {};
28627fce14SJosh Poimboeuf 
29627fce14SJosh Poimboeuf 	elf_version(EV_CURRENT);
30627fce14SJosh Poimboeuf 
315a406031SJosh Poimboeuf 	fd = open(filename, O_RDONLY);
32627fce14SJosh Poimboeuf 	if (fd == -1) {
33627fce14SJosh Poimboeuf 		perror("open");
34627fce14SJosh Poimboeuf 		return -1;
35627fce14SJosh Poimboeuf 	}
36627fce14SJosh Poimboeuf 
37627fce14SJosh Poimboeuf 	elf = elf_begin(fd, ELF_C_READ_MMAP, NULL);
38627fce14SJosh Poimboeuf 	if (!elf) {
39*3e7be635SJosh Poimboeuf 		ERROR_ELF("elf_begin");
40627fce14SJosh Poimboeuf 		return -1;
41627fce14SJosh Poimboeuf 	}
42627fce14SJosh Poimboeuf 
430646c28bSChristophe Leroy 	if (!elf64_getehdr(elf)) {
44*3e7be635SJosh Poimboeuf 		ERROR_ELF("elf64_getehdr");
450646c28bSChristophe Leroy 		return -1;
460646c28bSChristophe Leroy 	}
470646c28bSChristophe Leroy 	memcpy(&dummy_elf.ehdr, elf64_getehdr(elf), sizeof(dummy_elf.ehdr));
480646c28bSChristophe Leroy 
49627fce14SJosh Poimboeuf 	if (elf_getshdrnum(elf, &nr_sections)) {
50*3e7be635SJosh Poimboeuf 		ERROR_ELF("elf_getshdrnum");
51627fce14SJosh Poimboeuf 		return -1;
52627fce14SJosh Poimboeuf 	}
53627fce14SJosh Poimboeuf 
54627fce14SJosh Poimboeuf 	if (elf_getshdrstrndx(elf, &shstrtab_idx)) {
55*3e7be635SJosh Poimboeuf 		ERROR_ELF("elf_getshdrstrndx");
56627fce14SJosh Poimboeuf 		return -1;
57627fce14SJosh Poimboeuf 	}
58627fce14SJosh Poimboeuf 
59627fce14SJosh Poimboeuf 	for (i = 0; i < nr_sections; i++) {
60627fce14SJosh Poimboeuf 		scn = elf_getscn(elf, i);
61627fce14SJosh Poimboeuf 		if (!scn) {
62*3e7be635SJosh Poimboeuf 			ERROR_ELF("elf_getscn");
63627fce14SJosh Poimboeuf 			return -1;
64627fce14SJosh Poimboeuf 		}
65627fce14SJosh Poimboeuf 
66627fce14SJosh Poimboeuf 		if (!gelf_getshdr(scn, &sh)) {
67*3e7be635SJosh Poimboeuf 			ERROR_ELF("gelf_getshdr");
68627fce14SJosh Poimboeuf 			return -1;
69627fce14SJosh Poimboeuf 		}
70627fce14SJosh Poimboeuf 
71627fce14SJosh Poimboeuf 		name = elf_strptr(elf, shstrtab_idx, sh.sh_name);
72627fce14SJosh Poimboeuf 		if (!name) {
73*3e7be635SJosh Poimboeuf 			ERROR_ELF("elf_strptr");
74627fce14SJosh Poimboeuf 			return -1;
75627fce14SJosh Poimboeuf 		}
76627fce14SJosh Poimboeuf 
77627fce14SJosh Poimboeuf 		data = elf_getdata(scn, NULL);
78627fce14SJosh Poimboeuf 		if (!data) {
79*3e7be635SJosh Poimboeuf 			ERROR_ELF("elf_getdata");
80627fce14SJosh Poimboeuf 			return -1;
81627fce14SJosh Poimboeuf 		}
82627fce14SJosh Poimboeuf 
83627fce14SJosh Poimboeuf 		if (!strcmp(name, ".symtab")) {
84627fce14SJosh Poimboeuf 			symtab = data;
858782e7caSJosh Poimboeuf 		} else if (!strcmp(name, ".strtab")) {
868782e7caSJosh Poimboeuf 			strtab_idx = i;
87627fce14SJosh Poimboeuf 		} else if (!strcmp(name, ".orc_unwind")) {
88627fce14SJosh Poimboeuf 			orc = data->d_buf;
89627fce14SJosh Poimboeuf 			orc_size = sh.sh_size;
90627fce14SJosh Poimboeuf 		} else if (!strcmp(name, ".orc_unwind_ip")) {
91627fce14SJosh Poimboeuf 			orc_ip = data->d_buf;
92627fce14SJosh Poimboeuf 			orc_ip_addr = sh.sh_addr;
93627fce14SJosh Poimboeuf 		} else if (!strcmp(name, ".rela.orc_unwind_ip")) {
94627fce14SJosh Poimboeuf 			rela_orc_ip = data;
95627fce14SJosh Poimboeuf 		}
96627fce14SJosh Poimboeuf 	}
97627fce14SJosh Poimboeuf 
988782e7caSJosh Poimboeuf 	if (!symtab || !strtab_idx || !orc || !orc_ip)
99627fce14SJosh Poimboeuf 		return 0;
100627fce14SJosh Poimboeuf 
101627fce14SJosh Poimboeuf 	if (orc_size % sizeof(*orc) != 0) {
102*3e7be635SJosh Poimboeuf 		ERROR("bad .orc_unwind section size");
103627fce14SJosh Poimboeuf 		return -1;
104627fce14SJosh Poimboeuf 	}
105627fce14SJosh Poimboeuf 
106627fce14SJosh Poimboeuf 	nr_entries = orc_size / sizeof(*orc);
107627fce14SJosh Poimboeuf 	for (i = 0; i < nr_entries; i++) {
108627fce14SJosh Poimboeuf 		if (rela_orc_ip) {
109627fce14SJosh Poimboeuf 			if (!gelf_getrela(rela_orc_ip, i, &rela)) {
110*3e7be635SJosh Poimboeuf 				ERROR_ELF("gelf_getrela");
111627fce14SJosh Poimboeuf 				return -1;
112627fce14SJosh Poimboeuf 			}
113627fce14SJosh Poimboeuf 
114627fce14SJosh Poimboeuf 			if (!gelf_getsym(symtab, GELF_R_SYM(rela.r_info), &sym)) {
115*3e7be635SJosh Poimboeuf 				ERROR_ELF("gelf_getsym");
116627fce14SJosh Poimboeuf 				return -1;
117627fce14SJosh Poimboeuf 			}
118627fce14SJosh Poimboeuf 
1198782e7caSJosh Poimboeuf 			if (GELF_ST_TYPE(sym.st_info) == STT_SECTION) {
120627fce14SJosh Poimboeuf 				scn = elf_getscn(elf, sym.st_shndx);
121627fce14SJosh Poimboeuf 				if (!scn) {
122*3e7be635SJosh Poimboeuf 					ERROR_ELF("elf_getscn");
123627fce14SJosh Poimboeuf 					return -1;
124627fce14SJosh Poimboeuf 				}
125627fce14SJosh Poimboeuf 
126627fce14SJosh Poimboeuf 				if (!gelf_getshdr(scn, &sh)) {
127*3e7be635SJosh Poimboeuf 					ERROR_ELF("gelf_getshdr");
128627fce14SJosh Poimboeuf 					return -1;
129627fce14SJosh Poimboeuf 				}
130627fce14SJosh Poimboeuf 
131627fce14SJosh Poimboeuf 				name = elf_strptr(elf, shstrtab_idx, sh.sh_name);
1328782e7caSJosh Poimboeuf 				if (!name) {
133*3e7be635SJosh Poimboeuf 					ERROR_ELF("elf_strptr");
134627fce14SJosh Poimboeuf 					return -1;
135627fce14SJosh Poimboeuf 				}
1368782e7caSJosh Poimboeuf 			} else {
1378782e7caSJosh Poimboeuf 				name = elf_strptr(elf, strtab_idx, sym.st_name);
1388782e7caSJosh Poimboeuf 				if (!name) {
139*3e7be635SJosh Poimboeuf 					ERROR_ELF("elf_strptr");
1408782e7caSJosh Poimboeuf 					return -1;
1418782e7caSJosh Poimboeuf 				}
1428782e7caSJosh Poimboeuf 			}
143627fce14SJosh Poimboeuf 
14414c47b54SMikulas Patocka 			printf("%s+%llx:", name, (unsigned long long)rela.r_addend);
145627fce14SJosh Poimboeuf 
146627fce14SJosh Poimboeuf 		} else {
14714c47b54SMikulas Patocka 			printf("%llx:", (unsigned long long)(orc_ip_addr + (i * sizeof(int)) + orc_ip[i]));
148627fce14SJosh Poimboeuf 		}
149627fce14SJosh Poimboeuf 
150b8e85e6fSTiezhu Yang 		orc_print_dump(&dummy_elf, orc, i);
151627fce14SJosh Poimboeuf 	}
152627fce14SJosh Poimboeuf 
153627fce14SJosh Poimboeuf 	elf_end(elf);
154627fce14SJosh Poimboeuf 	close(fd);
155627fce14SJosh Poimboeuf 
156627fce14SJosh Poimboeuf 	return 0;
157627fce14SJosh Poimboeuf }
158