xref: /linux/scripts/elf-parse.c (revision 36492b7141b9abc967e92c991af32c670351dc16)
1*b055f4c4SSteven Rostedt #include <sys/types.h>
2*b055f4c4SSteven Rostedt #include <sys/mman.h>
3*b055f4c4SSteven Rostedt #include <sys/stat.h>
4*b055f4c4SSteven Rostedt #include <fcntl.h>
5*b055f4c4SSteven Rostedt #include <stdio.h>
6*b055f4c4SSteven Rostedt #include <stdlib.h>
7*b055f4c4SSteven Rostedt #include <stdbool.h>
8*b055f4c4SSteven Rostedt #include <string.h>
9*b055f4c4SSteven Rostedt #include <unistd.h>
10*b055f4c4SSteven Rostedt #include <errno.h>
11*b055f4c4SSteven Rostedt 
12*b055f4c4SSteven Rostedt #include "elf-parse.h"
13*b055f4c4SSteven Rostedt 
14*b055f4c4SSteven Rostedt struct elf_funcs elf_parser;
15*b055f4c4SSteven Rostedt 
16*b055f4c4SSteven Rostedt /*
17*b055f4c4SSteven Rostedt  * Get the whole file as a programming convenience in order to avoid
18*b055f4c4SSteven Rostedt  * malloc+lseek+read+free of many pieces.  If successful, then mmap
19*b055f4c4SSteven Rostedt  * avoids copying unused pieces; else just read the whole file.
20*b055f4c4SSteven Rostedt  * Open for both read and write.
21*b055f4c4SSteven Rostedt  */
map_file(char const * fname,size_t * size)22*b055f4c4SSteven Rostedt static void *map_file(char const *fname, size_t *size)
23*b055f4c4SSteven Rostedt {
24*b055f4c4SSteven Rostedt 	int fd;
25*b055f4c4SSteven Rostedt 	struct stat sb;
26*b055f4c4SSteven Rostedt 	void *addr = NULL;
27*b055f4c4SSteven Rostedt 
28*b055f4c4SSteven Rostedt 	fd = open(fname, O_RDWR);
29*b055f4c4SSteven Rostedt 	if (fd < 0) {
30*b055f4c4SSteven Rostedt 		perror(fname);
31*b055f4c4SSteven Rostedt 		return NULL;
32*b055f4c4SSteven Rostedt 	}
33*b055f4c4SSteven Rostedt 	if (fstat(fd, &sb) < 0) {
34*b055f4c4SSteven Rostedt 		perror(fname);
35*b055f4c4SSteven Rostedt 		goto out;
36*b055f4c4SSteven Rostedt 	}
37*b055f4c4SSteven Rostedt 	if (!S_ISREG(sb.st_mode)) {
38*b055f4c4SSteven Rostedt 		fprintf(stderr, "not a regular file: %s\n", fname);
39*b055f4c4SSteven Rostedt 		goto out;
40*b055f4c4SSteven Rostedt 	}
41*b055f4c4SSteven Rostedt 
42*b055f4c4SSteven Rostedt 	addr = mmap(0, sb.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
43*b055f4c4SSteven Rostedt 	if (addr == MAP_FAILED) {
44*b055f4c4SSteven Rostedt 		fprintf(stderr, "Could not mmap file: %s\n", fname);
45*b055f4c4SSteven Rostedt 		goto out;
46*b055f4c4SSteven Rostedt 	}
47*b055f4c4SSteven Rostedt 
48*b055f4c4SSteven Rostedt 	*size = sb.st_size;
49*b055f4c4SSteven Rostedt 
50*b055f4c4SSteven Rostedt out:
51*b055f4c4SSteven Rostedt 	close(fd);
52*b055f4c4SSteven Rostedt 	return addr;
53*b055f4c4SSteven Rostedt }
54*b055f4c4SSteven Rostedt 
elf_parse(const char * fname,void * addr,uint32_t types)55*b055f4c4SSteven Rostedt static int elf_parse(const char *fname, void *addr, uint32_t types)
56*b055f4c4SSteven Rostedt {
57*b055f4c4SSteven Rostedt 	Elf_Ehdr *ehdr = addr;
58*b055f4c4SSteven Rostedt 	uint16_t type;
59*b055f4c4SSteven Rostedt 
60*b055f4c4SSteven Rostedt 	switch (ehdr->e32.e_ident[EI_DATA]) {
61*b055f4c4SSteven Rostedt 	case ELFDATA2LSB:
62*b055f4c4SSteven Rostedt 		elf_parser.r	= rle;
63*b055f4c4SSteven Rostedt 		elf_parser.r2	= r2le;
64*b055f4c4SSteven Rostedt 		elf_parser.r8	= r8le;
65*b055f4c4SSteven Rostedt 		elf_parser.w	= wle;
66*b055f4c4SSteven Rostedt 		elf_parser.w8	= w8le;
67*b055f4c4SSteven Rostedt 		break;
68*b055f4c4SSteven Rostedt 	case ELFDATA2MSB:
69*b055f4c4SSteven Rostedt 		elf_parser.r	= rbe;
70*b055f4c4SSteven Rostedt 		elf_parser.r2	= r2be;
71*b055f4c4SSteven Rostedt 		elf_parser.r8	= r8be;
72*b055f4c4SSteven Rostedt 		elf_parser.w	= wbe;
73*b055f4c4SSteven Rostedt 		elf_parser.w8	= w8be;
74*b055f4c4SSteven Rostedt 		break;
75*b055f4c4SSteven Rostedt 	default:
76*b055f4c4SSteven Rostedt 		fprintf(stderr, "unrecognized ELF data encoding %d: %s\n",
77*b055f4c4SSteven Rostedt 			ehdr->e32.e_ident[EI_DATA], fname);
78*b055f4c4SSteven Rostedt 		return -1;
79*b055f4c4SSteven Rostedt 	}
80*b055f4c4SSteven Rostedt 
81*b055f4c4SSteven Rostedt 	if (memcmp(ELFMAG, ehdr->e32.e_ident, SELFMAG) != 0 ||
82*b055f4c4SSteven Rostedt 	    ehdr->e32.e_ident[EI_VERSION] != EV_CURRENT) {
83*b055f4c4SSteven Rostedt 		fprintf(stderr, "unrecognized ELF file %s\n", fname);
84*b055f4c4SSteven Rostedt 		return -1;
85*b055f4c4SSteven Rostedt 	}
86*b055f4c4SSteven Rostedt 
87*b055f4c4SSteven Rostedt 	type = elf_parser.r2(&ehdr->e32.e_type);
88*b055f4c4SSteven Rostedt 	if (!((1 << type) & types)) {
89*b055f4c4SSteven Rostedt 		fprintf(stderr, "Invalid ELF type file %s\n", fname);
90*b055f4c4SSteven Rostedt 		return -1;
91*b055f4c4SSteven Rostedt 	}
92*b055f4c4SSteven Rostedt 
93*b055f4c4SSteven Rostedt 	switch (ehdr->e32.e_ident[EI_CLASS]) {
94*b055f4c4SSteven Rostedt 	case ELFCLASS32: {
95*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shoff		= ehdr32_shoff;
96*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shentsize	= ehdr32_shentsize;
97*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shstrndx	= ehdr32_shstrndx;
98*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shnum		= ehdr32_shnum;
99*b055f4c4SSteven Rostedt 		elf_parser.shdr_addr		= shdr32_addr;
100*b055f4c4SSteven Rostedt 		elf_parser.shdr_offset		= shdr32_offset;
101*b055f4c4SSteven Rostedt 		elf_parser.shdr_link		= shdr32_link;
102*b055f4c4SSteven Rostedt 		elf_parser.shdr_size		= shdr32_size;
103*b055f4c4SSteven Rostedt 		elf_parser.shdr_name		= shdr32_name;
104*b055f4c4SSteven Rostedt 		elf_parser.shdr_type		= shdr32_type;
105*b055f4c4SSteven Rostedt 		elf_parser.shdr_entsize		= shdr32_entsize;
106*b055f4c4SSteven Rostedt 		elf_parser.sym_type		= sym32_type;
107*b055f4c4SSteven Rostedt 		elf_parser.sym_name		= sym32_name;
108*b055f4c4SSteven Rostedt 		elf_parser.sym_value		= sym32_value;
109*b055f4c4SSteven Rostedt 		elf_parser.sym_shndx		= sym32_shndx;
110*b055f4c4SSteven Rostedt 		elf_parser.rela_offset		= rela32_offset;
111*b055f4c4SSteven Rostedt 		elf_parser.rela_info		= rela32_info;
112*b055f4c4SSteven Rostedt 		elf_parser.rela_addend		= rela32_addend;
113*b055f4c4SSteven Rostedt 		elf_parser.rela_write_addend	= rela32_write_addend;
114*b055f4c4SSteven Rostedt 
115*b055f4c4SSteven Rostedt 		if (elf_parser.r2(&ehdr->e32.e_ehsize) != sizeof(Elf32_Ehdr) ||
116*b055f4c4SSteven Rostedt 		    elf_parser.r2(&ehdr->e32.e_shentsize) != sizeof(Elf32_Shdr)) {
117*b055f4c4SSteven Rostedt 			fprintf(stderr,
118*b055f4c4SSteven Rostedt 				"unrecognized ET_EXEC/ET_DYN file: %s\n", fname);
119*b055f4c4SSteven Rostedt 			return -1;
120*b055f4c4SSteven Rostedt 		}
121*b055f4c4SSteven Rostedt 
122*b055f4c4SSteven Rostedt 		}
123*b055f4c4SSteven Rostedt 		break;
124*b055f4c4SSteven Rostedt 	case ELFCLASS64: {
125*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shoff		= ehdr64_shoff;
126*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shentsize		= ehdr64_shentsize;
127*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shstrndx		= ehdr64_shstrndx;
128*b055f4c4SSteven Rostedt 		elf_parser.ehdr_shnum		= ehdr64_shnum;
129*b055f4c4SSteven Rostedt 		elf_parser.shdr_addr		= shdr64_addr;
130*b055f4c4SSteven Rostedt 		elf_parser.shdr_offset		= shdr64_offset;
131*b055f4c4SSteven Rostedt 		elf_parser.shdr_link		= shdr64_link;
132*b055f4c4SSteven Rostedt 		elf_parser.shdr_size		= shdr64_size;
133*b055f4c4SSteven Rostedt 		elf_parser.shdr_name		= shdr64_name;
134*b055f4c4SSteven Rostedt 		elf_parser.shdr_type		= shdr64_type;
135*b055f4c4SSteven Rostedt 		elf_parser.shdr_entsize		= shdr64_entsize;
136*b055f4c4SSteven Rostedt 		elf_parser.sym_type		= sym64_type;
137*b055f4c4SSteven Rostedt 		elf_parser.sym_name		= sym64_name;
138*b055f4c4SSteven Rostedt 		elf_parser.sym_value		= sym64_value;
139*b055f4c4SSteven Rostedt 		elf_parser.sym_shndx		= sym64_shndx;
140*b055f4c4SSteven Rostedt 		elf_parser.rela_offset		= rela64_offset;
141*b055f4c4SSteven Rostedt 		elf_parser.rela_info		= rela64_info;
142*b055f4c4SSteven Rostedt 		elf_parser.rela_addend		= rela64_addend;
143*b055f4c4SSteven Rostedt 		elf_parser.rela_write_addend	= rela64_write_addend;
144*b055f4c4SSteven Rostedt 
145*b055f4c4SSteven Rostedt 		if (elf_parser.r2(&ehdr->e64.e_ehsize) != sizeof(Elf64_Ehdr) ||
146*b055f4c4SSteven Rostedt 		    elf_parser.r2(&ehdr->e64.e_shentsize) != sizeof(Elf64_Shdr)) {
147*b055f4c4SSteven Rostedt 			fprintf(stderr,
148*b055f4c4SSteven Rostedt 				"unrecognized ET_EXEC/ET_DYN file: %s\n",
149*b055f4c4SSteven Rostedt 				fname);
150*b055f4c4SSteven Rostedt 			return -1;
151*b055f4c4SSteven Rostedt 		}
152*b055f4c4SSteven Rostedt 
153*b055f4c4SSteven Rostedt 		}
154*b055f4c4SSteven Rostedt 		break;
155*b055f4c4SSteven Rostedt 	default:
156*b055f4c4SSteven Rostedt 		fprintf(stderr, "unrecognized ELF class %d %s\n",
157*b055f4c4SSteven Rostedt 			ehdr->e32.e_ident[EI_CLASS], fname);
158*b055f4c4SSteven Rostedt 		return -1;
159*b055f4c4SSteven Rostedt 	}
160*b055f4c4SSteven Rostedt 	return 0;
161*b055f4c4SSteven Rostedt }
162*b055f4c4SSteven Rostedt 
elf_map_machine(void * addr)163*b055f4c4SSteven Rostedt int elf_map_machine(void *addr)
164*b055f4c4SSteven Rostedt {
165*b055f4c4SSteven Rostedt 	Elf_Ehdr *ehdr = addr;
166*b055f4c4SSteven Rostedt 
167*b055f4c4SSteven Rostedt 	return elf_parser.r2(&ehdr->e32.e_machine);
168*b055f4c4SSteven Rostedt }
169*b055f4c4SSteven Rostedt 
elf_map_long_size(void * addr)170*b055f4c4SSteven Rostedt int elf_map_long_size(void *addr)
171*b055f4c4SSteven Rostedt {
172*b055f4c4SSteven Rostedt 	Elf_Ehdr *ehdr = addr;
173*b055f4c4SSteven Rostedt 
174*b055f4c4SSteven Rostedt 	return ehdr->e32.e_ident[EI_CLASS] == ELFCLASS32 ? 4 : 8;
175*b055f4c4SSteven Rostedt }
176*b055f4c4SSteven Rostedt 
elf_map(char const * fname,size_t * size,uint32_t types)177*b055f4c4SSteven Rostedt void *elf_map(char const *fname, size_t *size, uint32_t types)
178*b055f4c4SSteven Rostedt {
179*b055f4c4SSteven Rostedt 	void *addr;
180*b055f4c4SSteven Rostedt 	int ret;
181*b055f4c4SSteven Rostedt 
182*b055f4c4SSteven Rostedt 	addr = map_file(fname, size);
183*b055f4c4SSteven Rostedt 	if (!addr)
184*b055f4c4SSteven Rostedt 		return NULL;
185*b055f4c4SSteven Rostedt 
186*b055f4c4SSteven Rostedt 	ret = elf_parse(fname, addr, types);
187*b055f4c4SSteven Rostedt 	if (ret < 0) {
188*b055f4c4SSteven Rostedt 		elf_unmap(addr, *size);
189*b055f4c4SSteven Rostedt 		return NULL;
190*b055f4c4SSteven Rostedt 	}
191*b055f4c4SSteven Rostedt 
192*b055f4c4SSteven Rostedt 	return addr;
193*b055f4c4SSteven Rostedt }
194*b055f4c4SSteven Rostedt 
elf_unmap(void * addr,size_t size)195*b055f4c4SSteven Rostedt void elf_unmap(void *addr, size_t size)
196*b055f4c4SSteven Rostedt {
197*b055f4c4SSteven Rostedt 	munmap(addr, size);
198*b055f4c4SSteven Rostedt }
199