disas/ppc: Fix indefinite articles in comments
[qemu/ar7.git] / include / hw / elf_ops.h
blob25659b93beccb4e38734ce330581de307af7c058
1 static void glue(bswap_ehdr, SZ)(struct elfhdr *ehdr)
3 bswap16s(&ehdr->e_type); /* Object file type */
4 bswap16s(&ehdr->e_machine); /* Architecture */
5 bswap32s(&ehdr->e_version); /* Object file version */
6 bswapSZs(&ehdr->e_entry); /* Entry point virtual address */
7 bswapSZs(&ehdr->e_phoff); /* Program header table file offset */
8 bswapSZs(&ehdr->e_shoff); /* Section header table file offset */
9 bswap32s(&ehdr->e_flags); /* Processor-specific flags */
10 bswap16s(&ehdr->e_ehsize); /* ELF header size in bytes */
11 bswap16s(&ehdr->e_phentsize); /* Program header table entry size */
12 bswap16s(&ehdr->e_phnum); /* Program header table entry count */
13 bswap16s(&ehdr->e_shentsize); /* Section header table entry size */
14 bswap16s(&ehdr->e_shnum); /* Section header table entry count */
15 bswap16s(&ehdr->e_shstrndx); /* Section header string table index */
18 static void glue(bswap_phdr, SZ)(struct elf_phdr *phdr)
20 bswap32s(&phdr->p_type); /* Segment type */
21 bswapSZs(&phdr->p_offset); /* Segment file offset */
22 bswapSZs(&phdr->p_vaddr); /* Segment virtual address */
23 bswapSZs(&phdr->p_paddr); /* Segment physical address */
24 bswapSZs(&phdr->p_filesz); /* Segment size in file */
25 bswapSZs(&phdr->p_memsz); /* Segment size in memory */
26 bswap32s(&phdr->p_flags); /* Segment flags */
27 bswapSZs(&phdr->p_align); /* Segment alignment */
30 static void glue(bswap_shdr, SZ)(struct elf_shdr *shdr)
32 bswap32s(&shdr->sh_name);
33 bswap32s(&shdr->sh_type);
34 bswapSZs(&shdr->sh_flags);
35 bswapSZs(&shdr->sh_addr);
36 bswapSZs(&shdr->sh_offset);
37 bswapSZs(&shdr->sh_size);
38 bswap32s(&shdr->sh_link);
39 bswap32s(&shdr->sh_info);
40 bswapSZs(&shdr->sh_addralign);
41 bswapSZs(&shdr->sh_entsize);
44 static void glue(bswap_sym, SZ)(struct elf_sym *sym)
46 bswap32s(&sym->st_name);
47 bswapSZs(&sym->st_value);
48 bswapSZs(&sym->st_size);
49 bswap16s(&sym->st_shndx);
52 static void glue(bswap_rela, SZ)(struct elf_rela *rela)
54 bswapSZs(&rela->r_offset);
55 bswapSZs(&rela->r_info);
56 bswapSZs((elf_word *)&rela->r_addend);
59 static struct elf_shdr *glue(find_section, SZ)(struct elf_shdr *shdr_table,
60 int n, int type)
62 int i;
63 for(i=0;i<n;i++) {
64 if (shdr_table[i].sh_type == type)
65 return shdr_table + i;
67 return NULL;
70 static int glue(symfind, SZ)(const void *s0, const void *s1)
72 hwaddr addr = *(hwaddr *)s0;
73 struct elf_sym *sym = (struct elf_sym *)s1;
74 int result = 0;
75 if (addr < sym->st_value) {
76 result = -1;
77 } else if (addr >= sym->st_value + sym->st_size) {
78 result = 1;
80 return result;
83 static const char *glue(lookup_symbol, SZ)(struct syminfo *s,
84 hwaddr orig_addr)
86 struct elf_sym *syms = glue(s->disas_symtab.elf, SZ);
87 struct elf_sym *sym;
89 sym = bsearch(&orig_addr, syms, s->disas_num_syms, sizeof(*syms),
90 glue(symfind, SZ));
91 if (sym != NULL) {
92 return s->disas_strtab + sym->st_name;
95 return "";
98 static int glue(symcmp, SZ)(const void *s0, const void *s1)
100 struct elf_sym *sym0 = (struct elf_sym *)s0;
101 struct elf_sym *sym1 = (struct elf_sym *)s1;
102 return (sym0->st_value < sym1->st_value)
103 ? -1
104 : ((sym0->st_value > sym1->st_value) ? 1 : 0);
107 static int glue(load_symbols, SZ)(struct elfhdr *ehdr, int fd, int must_swab,
108 int clear_lsb)
110 struct elf_shdr *symtab, *strtab, *shdr_table = NULL;
111 struct elf_sym *syms = NULL;
112 struct syminfo *s;
113 int nsyms, i;
114 char *str = NULL;
116 shdr_table = load_at(fd, ehdr->e_shoff,
117 sizeof(struct elf_shdr) * ehdr->e_shnum);
118 if (!shdr_table)
119 return -1;
121 if (must_swab) {
122 for (i = 0; i < ehdr->e_shnum; i++) {
123 glue(bswap_shdr, SZ)(shdr_table + i);
127 symtab = glue(find_section, SZ)(shdr_table, ehdr->e_shnum, SHT_SYMTAB);
128 if (!symtab)
129 goto fail;
130 syms = load_at(fd, symtab->sh_offset, symtab->sh_size);
131 if (!syms)
132 goto fail;
134 nsyms = symtab->sh_size / sizeof(struct elf_sym);
136 i = 0;
137 while (i < nsyms) {
138 if (must_swab)
139 glue(bswap_sym, SZ)(&syms[i]);
140 /* We are only interested in function symbols.
141 Throw everything else away. */
142 if (syms[i].st_shndx == SHN_UNDEF ||
143 syms[i].st_shndx >= SHN_LORESERVE ||
144 ELF_ST_TYPE(syms[i].st_info) != STT_FUNC) {
145 nsyms--;
146 if (i < nsyms) {
147 syms[i] = syms[nsyms];
149 continue;
151 if (clear_lsb) {
152 /* The bottom address bit marks a Thumb or MIPS16 symbol. */
153 syms[i].st_value &= ~(glue(glue(Elf, SZ), _Addr))1;
155 i++;
157 syms = g_realloc(syms, nsyms * sizeof(*syms));
159 qsort(syms, nsyms, sizeof(*syms), glue(symcmp, SZ));
160 for (i = 0; i < nsyms - 1; i++) {
161 if (syms[i].st_size == 0) {
162 syms[i].st_size = syms[i + 1].st_value - syms[i].st_value;
166 /* String table */
167 if (symtab->sh_link >= ehdr->e_shnum)
168 goto fail;
169 strtab = &shdr_table[symtab->sh_link];
171 str = load_at(fd, strtab->sh_offset, strtab->sh_size);
172 if (!str)
173 goto fail;
175 /* Commit */
176 s = g_malloc0(sizeof(*s));
177 s->lookup_symbol = glue(lookup_symbol, SZ);
178 glue(s->disas_symtab.elf, SZ) = syms;
179 s->disas_num_syms = nsyms;
180 s->disas_strtab = str;
181 s->next = syminfos;
182 syminfos = s;
183 g_free(shdr_table);
184 return 0;
185 fail:
186 g_free(syms);
187 g_free(str);
188 g_free(shdr_table);
189 return -1;
192 static int glue(elf_reloc, SZ)(struct elfhdr *ehdr, int fd, int must_swab,
193 uint64_t (*translate_fn)(void *, uint64_t),
194 void *translate_opaque, uint8_t *data,
195 struct elf_phdr *ph, int elf_machine)
197 struct elf_shdr *reltab, *shdr_table = NULL;
198 struct elf_rela *rels = NULL;
199 int nrels, i, ret = -1;
200 elf_word wordval;
201 void *addr;
203 shdr_table = load_at(fd, ehdr->e_shoff,
204 sizeof(struct elf_shdr) * ehdr->e_shnum);
205 if (!shdr_table) {
206 return -1;
208 if (must_swab) {
209 for (i = 0; i < ehdr->e_shnum; i++) {
210 glue(bswap_shdr, SZ)(&shdr_table[i]);
214 reltab = glue(find_section, SZ)(shdr_table, ehdr->e_shnum, SHT_RELA);
215 if (!reltab) {
216 goto fail;
218 rels = load_at(fd, reltab->sh_offset, reltab->sh_size);
219 if (!rels) {
220 goto fail;
222 nrels = reltab->sh_size / sizeof(struct elf_rela);
224 for (i = 0; i < nrels; i++) {
225 if (must_swab) {
226 glue(bswap_rela, SZ)(&rels[i]);
228 if (rels[i].r_offset < ph->p_vaddr ||
229 rels[i].r_offset >= ph->p_vaddr + ph->p_filesz) {
230 continue;
232 addr = &data[rels[i].r_offset - ph->p_vaddr];
233 switch (elf_machine) {
234 case EM_S390:
235 switch (rels[i].r_info) {
236 case R_390_RELATIVE:
237 wordval = *(elf_word *)addr;
238 if (must_swab) {
239 bswapSZs(&wordval);
241 wordval = translate_fn(translate_opaque, wordval);
242 if (must_swab) {
243 bswapSZs(&wordval);
245 *(elf_word *)addr = wordval;
246 break;
247 default:
248 fprintf(stderr, "Unsupported relocation type %i!\n",
249 (int)rels[i].r_info);
254 ret = 0;
255 fail:
256 g_free(rels);
257 g_free(shdr_table);
258 return ret;
261 static int glue(load_elf, SZ)(const char *name, int fd,
262 uint64_t (*translate_fn)(void *, uint64_t),
263 void *translate_opaque,
264 int must_swab, uint64_t *pentry,
265 uint64_t *lowaddr, uint64_t *highaddr,
266 int elf_machine, int clear_lsb, int data_swab,
267 AddressSpace *as)
269 struct elfhdr ehdr;
270 struct elf_phdr *phdr = NULL, *ph;
271 int size, i, total_size;
272 elf_word mem_size, file_size;
273 uint64_t addr, low = (uint64_t)-1, high = 0;
274 uint8_t *data = NULL;
275 char label[128];
276 int ret = ELF_LOAD_FAILED;
278 if (read(fd, &ehdr, sizeof(ehdr)) != sizeof(ehdr))
279 goto fail;
280 if (must_swab) {
281 glue(bswap_ehdr, SZ)(&ehdr);
284 if (elf_machine <= EM_NONE) {
285 /* The caller didn't specify an ARCH, we can figure it out */
286 elf_machine = ehdr.e_machine;
289 switch (elf_machine) {
290 case EM_PPC64:
291 if (ehdr.e_machine != EM_PPC64) {
292 if (ehdr.e_machine != EM_PPC) {
293 ret = ELF_LOAD_WRONG_ARCH;
294 goto fail;
297 break;
298 case EM_X86_64:
299 if (ehdr.e_machine != EM_X86_64) {
300 if (ehdr.e_machine != EM_386) {
301 ret = ELF_LOAD_WRONG_ARCH;
302 goto fail;
305 break;
306 case EM_MICROBLAZE:
307 if (ehdr.e_machine != EM_MICROBLAZE) {
308 if (ehdr.e_machine != EM_MICROBLAZE_OLD) {
309 ret = ELF_LOAD_WRONG_ARCH;
310 goto fail;
313 break;
314 case EM_MOXIE:
315 if (ehdr.e_machine != EM_MOXIE) {
316 if (ehdr.e_machine != EM_MOXIE_OLD) {
317 ret = ELF_LOAD_WRONG_ARCH;
318 goto fail;
321 break;
322 default:
323 if (elf_machine != ehdr.e_machine) {
324 ret = ELF_LOAD_WRONG_ARCH;
325 goto fail;
329 if (pentry)
330 *pentry = (uint64_t)(elf_sword)ehdr.e_entry;
332 glue(load_symbols, SZ)(&ehdr, fd, must_swab, clear_lsb);
334 size = ehdr.e_phnum * sizeof(phdr[0]);
335 if (lseek(fd, ehdr.e_phoff, SEEK_SET) != ehdr.e_phoff) {
336 goto fail;
338 phdr = g_malloc0(size);
339 if (!phdr)
340 goto fail;
341 if (read(fd, phdr, size) != size)
342 goto fail;
343 if (must_swab) {
344 for(i = 0; i < ehdr.e_phnum; i++) {
345 ph = &phdr[i];
346 glue(bswap_phdr, SZ)(ph);
350 total_size = 0;
351 for(i = 0; i < ehdr.e_phnum; i++) {
352 ph = &phdr[i];
353 if (ph->p_type == PT_LOAD) {
354 mem_size = ph->p_memsz; /* Size of the ROM */
355 file_size = ph->p_filesz; /* Size of the allocated data */
356 data = g_malloc0(file_size);
357 if (ph->p_filesz > 0) {
358 if (lseek(fd, ph->p_offset, SEEK_SET) < 0) {
359 goto fail;
361 if (read(fd, data, file_size) != file_size) {
362 goto fail;
365 /* address_offset is hack for kernel images that are
366 linked at the wrong physical address. */
367 if (translate_fn) {
368 addr = translate_fn(translate_opaque, ph->p_paddr);
369 glue(elf_reloc, SZ)(&ehdr, fd, must_swab, translate_fn,
370 translate_opaque, data, ph, elf_machine);
371 } else {
372 addr = ph->p_paddr;
375 if (data_swab) {
376 int j;
377 for (j = 0; j < file_size; j += (1 << data_swab)) {
378 uint8_t *dp = data + j;
379 switch (data_swab) {
380 case (1):
381 *(uint16_t *)dp = bswap16(*(uint16_t *)dp);
382 break;
383 case (2):
384 *(uint32_t *)dp = bswap32(*(uint32_t *)dp);
385 break;
386 case (3):
387 *(uint64_t *)dp = bswap64(*(uint64_t *)dp);
388 break;
389 default:
390 g_assert_not_reached();
395 /* the entry pointer in the ELF header is a virtual
396 * address, if the text segments paddr and vaddr differ
397 * we need to adjust the entry */
398 if (pentry && !translate_fn &&
399 ph->p_vaddr != ph->p_paddr &&
400 ehdr.e_entry >= ph->p_vaddr &&
401 ehdr.e_entry < ph->p_vaddr + ph->p_filesz &&
402 ph->p_flags & PF_X) {
403 *pentry = ehdr.e_entry - ph->p_vaddr + ph->p_paddr;
406 snprintf(label, sizeof(label), "phdr #%d: %s", i, name);
408 /* rom_add_elf_program() seize the ownership of 'data' */
409 rom_add_elf_program(label, data, file_size, mem_size, addr, as);
411 total_size += mem_size;
412 if (addr < low)
413 low = addr;
414 if ((addr + mem_size) > high)
415 high = addr + mem_size;
417 data = NULL;
420 g_free(phdr);
421 if (lowaddr)
422 *lowaddr = (uint64_t)(elf_sword)low;
423 if (highaddr)
424 *highaddr = (uint64_t)(elf_sword)high;
425 return total_size;
426 fail:
427 g_free(data);
428 g_free(phdr);
429 return ret;