Details | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2928 | svoboda | 1 | /* |
2 | * Copyright (c) 2006 Sergey Bondari |
||
3 | * Copyright (c) 2006 Jakub Jermar |
||
4 | * Copyright (c) 2008 Jiri Svoboda |
||
5 | * All rights reserved. |
||
6 | * |
||
7 | * Redistribution and use in source and binary forms, with or without |
||
8 | * modification, are permitted provided that the following conditions |
||
9 | * are met: |
||
10 | * |
||
11 | * - Redistributions of source code must retain the above copyright |
||
12 | * notice, this list of conditions and the following disclaimer. |
||
13 | * - Redistributions in binary form must reproduce the above copyright |
||
14 | * notice, this list of conditions and the following disclaimer in the |
||
15 | * documentation and/or other materials provided with the distribution. |
||
16 | * - The name of the author may not be used to endorse or promote products |
||
17 | * derived from this software without specific prior written permission. |
||
18 | * |
||
19 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
||
20 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||
21 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
||
22 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
||
23 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||
24 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||
25 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||
26 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||
27 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
||
28 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
29 | */ |
||
30 | |||
31 | /** @addtogroup generic |
||
32 | * @{ |
||
33 | */ |
||
34 | |||
35 | /** |
||
36 | * @file |
||
3101 | svoboda | 37 | * @brief Userspace ELF loader. |
38 | * |
||
39 | * This module allows loading ELF binaries (both executables and |
||
40 | * shared objects) from VFS. The current implementation allocates |
||
41 | * anonymous memory, fills it with segment data and then adjusts |
||
42 | * the memory areas' flags to the final value. In the future, |
||
43 | * the segments will be mapped directly from the file. |
||
2928 | svoboda | 44 | */ |
45 | |||
46 | #include <stdio.h> |
||
47 | #include <sys/types.h> |
||
48 | #include <align.h> |
||
49 | #include <assert.h> |
||
50 | #include <as.h> |
||
2962 | svoboda | 51 | #include <unistd.h> |
52 | #include <fcntl.h> |
||
53 | |||
2928 | svoboda | 54 | #include "elf.h" |
2962 | svoboda | 55 | #include "pcb.h" |
56 | #include "elf_load.h" |
||
3131 | svoboda | 57 | #include "arch.h" |
2928 | svoboda | 58 | |
59 | static char *error_codes[] = { |
||
60 | "no error", |
||
61 | "invalid image", |
||
62 | "address space error", |
||
63 | "incompatible image", |
||
64 | "unsupported image type", |
||
65 | "irrecoverable error" |
||
66 | }; |
||
67 | |||
2972 | svoboda | 68 | static unsigned int elf_load(elf_ld_t *elf, size_t so_bias); |
2964 | svoboda | 69 | static int segment_header(elf_ld_t *elf, elf_segment_header_t *entry); |
70 | static int section_header(elf_ld_t *elf, elf_section_header_t *entry); |
||
71 | static int load_segment(elf_ld_t *elf, elf_segment_header_t *entry); |
||
2928 | svoboda | 72 | |
3101 | svoboda | 73 | /** Load ELF binary from a file. |
74 | * |
||
75 | * Load an ELF binary from the specified file. If the file is |
||
76 | * an executable program, it is loaded unbiased. If it is a shared |
||
77 | * object, it is loaded with the bias @a so_bias. Some information |
||
78 | * extracted from the binary is stored in a elf_info_t structure |
||
79 | * pointed to by @a info. |
||
80 | * |
||
81 | * @param file_name Path to the ELF file. |
||
82 | * @param so_bias Bias to use if the file is a shared object. |
||
83 | * @param info Pointer to a structure for storing information |
||
84 | * extracted from the binary. |
||
85 | * |
||
86 | * @return EOK on success or negative error code. |
||
87 | */ |
||
2972 | svoboda | 88 | int elf_load_file(char *file_name, size_t so_bias, elf_info_t *info) |
2964 | svoboda | 89 | { |
90 | elf_ld_t elf; |
||
2928 | svoboda | 91 | |
2962 | svoboda | 92 | int fd; |
93 | int rc; |
||
94 | |||
95 | printf("open and read '%s'...\n", file_name); |
||
96 | |||
3101 | svoboda | 97 | fd = open(file_name, O_RDONLY); |
2962 | svoboda | 98 | if (fd < 0) { |
99 | printf("failed opening file\n"); |
||
100 | return -1; |
||
101 | } |
||
102 | |||
2964 | svoboda | 103 | elf.fd = fd; |
104 | elf.info = info; |
||
105 | |||
2972 | svoboda | 106 | rc = elf_load(&elf, so_bias); |
2962 | svoboda | 107 | printf("elf_load() -> %d\n", rc); |
108 | |||
109 | close(fd); |
||
110 | |||
111 | return rc; |
||
112 | } |
||
113 | |||
3101 | svoboda | 114 | /** Run an ELF executable. |
115 | * |
||
116 | * Transfers control to the entry point of an ELF executable loaded |
||
117 | * earlier with elf_load_file(). This function does not return. |
||
118 | * |
||
119 | * @param info Info structure filled earlier by elf_load_file() |
||
120 | */ |
||
2964 | svoboda | 121 | void elf_run(elf_info_t *info) |
2962 | svoboda | 122 | { |
3129 | svoboda | 123 | printf("entry point: 0x%llx\n", info->entry); |
3131 | svoboda | 124 | //(*info->entry)(); |
125 | program_run(info->entry); |
||
2962 | svoboda | 126 | |
127 | /* not reached */ |
||
128 | } |
||
129 | |||
3101 | svoboda | 130 | /** Create the program control block (PCB). |
131 | * |
||
132 | * Create and install the program control block, initialising it |
||
133 | * with program information from @a info. |
||
134 | * |
||
135 | * @param info Program info structure |
||
136 | * @return EOK on success or negative error code |
||
137 | */ |
||
2964 | svoboda | 138 | int elf_create_pcb(elf_info_t *info) |
2962 | svoboda | 139 | { |
140 | pcb_t *pcb; |
||
141 | void *a; |
||
142 | |||
2990 | svoboda | 143 | pcb = __pcb_get(); |
2962 | svoboda | 144 | |
145 | a = as_area_create(pcb, sizeof(pcb_t), AS_AREA_READ | AS_AREA_WRITE); |
||
146 | if (a == (void *)(-1)) { |
||
147 | printf("elf_create_pcb: memory mapping failed\n"); |
||
148 | return EE_MEMORY; |
||
149 | } |
||
150 | |||
2964 | svoboda | 151 | pcb->entry = info->entry; |
2965 | svoboda | 152 | pcb->dynamic = info->dynamic; |
2962 | svoboda | 153 | |
154 | return 0; |
||
155 | } |
||
156 | |||
157 | |||
3101 | svoboda | 158 | /** Load an ELF binary. |
2928 | svoboda | 159 | * |
3101 | svoboda | 160 | * The @a elf structure contains the loader state, including |
161 | * an open file, from which the binary will be loaded, |
||
162 | * a pointer to the @c info structure etc. |
||
163 | * |
||
164 | * @param elf Pointer to loader state buffer. |
||
165 | * @param so_bias Bias to use if the file is a shared object. |
||
166 | * @return EE_OK on success or EE_xx error code. |
||
2928 | svoboda | 167 | */ |
2972 | svoboda | 168 | static unsigned int elf_load(elf_ld_t *elf, size_t so_bias) |
2928 | svoboda | 169 | { |
2964 | svoboda | 170 | elf_header_t header_buf; |
171 | elf_header_t *header = &header_buf; |
||
2928 | svoboda | 172 | int i, rc; |
173 | |||
2964 | svoboda | 174 | rc = read(elf->fd, header, sizeof(elf_header_t)); |
2928 | svoboda | 175 | if (rc < 0) { |
176 | printf("read error\n"); |
||
177 | return EE_INVALID; |
||
178 | } |
||
179 | |||
2964 | svoboda | 180 | elf->header = header; |
181 | |||
2928 | svoboda | 182 | printf("ELF-load:"); |
183 | /* Identify ELF */ |
||
184 | if (header->e_ident[EI_MAG0] != ELFMAG0 || |
||
185 | header->e_ident[EI_MAG1] != ELFMAG1 || |
||
186 | header->e_ident[EI_MAG2] != ELFMAG2 || |
||
187 | header->e_ident[EI_MAG3] != ELFMAG3) { |
||
188 | printf("invalid header\n"); |
||
189 | return EE_INVALID; |
||
190 | } |
||
191 | |||
192 | /* Identify ELF compatibility */ |
||
193 | if (header->e_ident[EI_DATA] != ELF_DATA_ENCODING || |
||
194 | header->e_machine != ELF_MACHINE || |
||
195 | header->e_ident[EI_VERSION] != EV_CURRENT || |
||
196 | header->e_version != EV_CURRENT || |
||
197 | header->e_ident[EI_CLASS] != ELF_CLASS) { |
||
198 | printf("incompatible data/version/class\n"); |
||
199 | return EE_INCOMPATIBLE; |
||
200 | } |
||
201 | |||
2992 | svoboda | 202 | if (header->e_phentsize != sizeof(elf_segment_header_t)) { |
203 | printf("e_phentsize:%d != %d\n", header->e_phentsize, |
||
204 | sizeof(elf_segment_header_t)); |
||
2928 | svoboda | 205 | return EE_INCOMPATIBLE; |
2992 | svoboda | 206 | } |
2928 | svoboda | 207 | |
2992 | svoboda | 208 | if (header->e_shentsize != sizeof(elf_section_header_t)) { |
209 | printf("e_shentsize:%d != %d\n", header->e_shentsize, |
||
210 | sizeof(elf_section_header_t)); |
||
2928 | svoboda | 211 | return EE_INCOMPATIBLE; |
2992 | svoboda | 212 | } |
2928 | svoboda | 213 | |
214 | /* Check if the object type is supported. */ |
||
215 | if (header->e_type != ET_EXEC && header->e_type != ET_DYN) { |
||
216 | printf("Object type %d is not supported\n", header->e_type); |
||
217 | return EE_UNSUPPORTED; |
||
218 | } |
||
219 | |||
2972 | svoboda | 220 | /* Shared objects can be loaded with a bias */ |
2971 | svoboda | 221 | printf("Object type: %d\n", header->e_type); |
2964 | svoboda | 222 | if (header->e_type == ET_DYN) |
2972 | svoboda | 223 | elf->bias = so_bias; |
2964 | svoboda | 224 | else |
225 | elf->bias = 0; |
||
226 | |||
2972 | svoboda | 227 | printf("Bias set to 0x%x\n", elf->bias); |
3004 | svoboda | 228 | elf->info->interp = NULL; |
229 | elf->info->dynamic = NULL; |
||
2971 | svoboda | 230 | |
2928 | svoboda | 231 | printf("parse segments\n"); |
232 | |||
233 | /* Walk through all segment headers and process them. */ |
||
234 | for (i = 0; i < header->e_phnum; i++) { |
||
2964 | svoboda | 235 | elf_segment_header_t segment_hdr; |
2928 | svoboda | 236 | |
2961 | svoboda | 237 | /* Seek to start of segment header */ |
2964 | svoboda | 238 | lseek(elf->fd, header->e_phoff |
239 | + i * sizeof(elf_segment_header_t), SEEK_SET); |
||
2928 | svoboda | 240 | |
2964 | svoboda | 241 | rc = read(elf->fd, &segment_hdr, sizeof(elf_segment_header_t)); |
242 | if (rc < 0) { printf("read error\n"); return EE_INVALID; } |
||
243 | |||
244 | rc = segment_header(elf, &segment_hdr); |
||
2928 | svoboda | 245 | if (rc != EE_OK) |
246 | return rc; |
||
247 | } |
||
248 | |||
249 | printf("parse sections\n"); |
||
250 | |||
251 | /* Inspect all section headers and proccess them. */ |
||
252 | for (i = 0; i < header->e_shnum; i++) { |
||
2964 | svoboda | 253 | elf_section_header_t section_hdr; |
2928 | svoboda | 254 | |
2961 | svoboda | 255 | /* Seek to start of section header */ |
2964 | svoboda | 256 | lseek(elf->fd, header->e_shoff |
257 | + i * sizeof(elf_section_header_t), SEEK_SET); |
||
2961 | svoboda | 258 | |
2964 | svoboda | 259 | rc = read(elf->fd, §ion_hdr, sizeof(elf_section_header_t)); |
260 | if (rc < 0) { printf("read error\n"); return EE_INVALID; } |
||
261 | |||
262 | rc = section_header(elf, §ion_hdr); |
||
2928 | svoboda | 263 | if (rc != EE_OK) |
2961 | svoboda | 264 | return rc; |
2928 | svoboda | 265 | } |
266 | |||
2964 | svoboda | 267 | elf->info->entry = |
268 | (entry_point_t)((uint8_t *)header->e_entry + elf->bias); |
||
269 | |||
2928 | svoboda | 270 | printf("done\n"); |
271 | |||
272 | return EE_OK; |
||
273 | } |
||
274 | |||
275 | /** Print error message according to error code. |
||
276 | * |
||
277 | * @param rc Return code returned by elf_load(). |
||
278 | * |
||
279 | * @return NULL terminated description of error. |
||
280 | */ |
||
281 | char *elf_error(unsigned int rc) |
||
282 | { |
||
283 | assert(rc < sizeof(error_codes) / sizeof(char *)); |
||
284 | |||
285 | return error_codes[rc]; |
||
286 | } |
||
287 | |||
288 | /** Process segment header. |
||
289 | * |
||
3101 | svoboda | 290 | * @param entry Segment header. |
2928 | svoboda | 291 | * |
292 | * @return EE_OK on success, error code otherwise. |
||
293 | */ |
||
2964 | svoboda | 294 | static int segment_header(elf_ld_t *elf, elf_segment_header_t *entry) |
2928 | svoboda | 295 | { |
296 | switch (entry->p_type) { |
||
297 | case PT_NULL: |
||
298 | case PT_PHDR: |
||
299 | break; |
||
300 | case PT_LOAD: |
||
2964 | svoboda | 301 | return load_segment(elf, entry); |
2928 | svoboda | 302 | break; |
3004 | svoboda | 303 | case PT_INTERP: |
304 | /* Assume silently interp == "/rtld.so" */ |
||
305 | elf->info->interp = "/rtld.so"; |
||
306 | break; |
||
2928 | svoboda | 307 | case PT_DYNAMIC: |
308 | case PT_SHLIB: |
||
309 | case PT_NOTE: |
||
310 | case PT_LOPROC: |
||
311 | case PT_HIPROC: |
||
312 | default: |
||
313 | printf("segment p_type %d unknown\n", entry->p_type); |
||
314 | return EE_UNSUPPORTED; |
||
315 | break; |
||
316 | } |
||
317 | return EE_OK; |
||
318 | } |
||
319 | |||
320 | /** Load segment described by program header entry. |
||
321 | * |
||
3101 | svoboda | 322 | * @param elf Loader state. |
2928 | svoboda | 323 | * @param entry Program header entry describing segment to be loaded. |
324 | * |
||
325 | * @return EE_OK on success, error code otherwise. |
||
326 | */ |
||
2964 | svoboda | 327 | int load_segment(elf_ld_t *elf, elf_segment_header_t *entry) |
2928 | svoboda | 328 | { |
329 | void *a; |
||
330 | int flags = 0; |
||
2932 | svoboda | 331 | uintptr_t bias; |
3010 | svoboda | 332 | uintptr_t base; |
333 | size_t mem_sz; |
||
2928 | svoboda | 334 | int rc; |
335 | |||
336 | printf("load segment at addr 0x%x, size 0x%x\n", entry->p_vaddr, |
||
337 | entry->p_memsz); |
||
338 | |||
2964 | svoboda | 339 | bias = elf->bias; |
2928 | svoboda | 340 | |
341 | if (entry->p_align > 1) { |
||
342 | if ((entry->p_offset % entry->p_align) != |
||
343 | (entry->p_vaddr % entry->p_align)) { |
||
344 | printf("align check 1 failed offset%%align=%d, vaddr%%align=%d\n", |
||
345 | entry->p_offset % entry->p_align, |
||
346 | entry->p_vaddr % entry->p_align |
||
347 | ); |
||
348 | return EE_INVALID; |
||
349 | } |
||
350 | } |
||
351 | |||
2992 | svoboda | 352 | /* Final flags that will be set for the memory area */ |
353 | |||
2985 | svoboda | 354 | if (entry->p_flags & PF_X) |
2928 | svoboda | 355 | flags |= AS_AREA_EXEC; |
356 | if (entry->p_flags & PF_W) |
||
357 | flags |= AS_AREA_WRITE; |
||
358 | if (entry->p_flags & PF_R) |
||
359 | flags |= AS_AREA_READ; |
||
360 | flags |= AS_AREA_CACHEABLE; |
||
3010 | svoboda | 361 | |
362 | base = ALIGN_DOWN(entry->p_vaddr, PAGE_SIZE); |
||
363 | mem_sz = entry->p_memsz + (entry->p_vaddr - base); |
||
2985 | svoboda | 364 | |
2932 | svoboda | 365 | printf("map to p_vaddr=0x%x-0x%x...\n", entry->p_vaddr + bias, |
366 | entry->p_vaddr + bias + ALIGN_UP(entry->p_memsz, PAGE_SIZE)); |
||
2928 | svoboda | 367 | |
2985 | svoboda | 368 | /* |
369 | * For the course of loading, the area needs to be readable |
||
370 | * and writeable. |
||
371 | */ |
||
3010 | svoboda | 372 | a = as_area_create((uint8_t *)base + bias, |
373 | mem_sz, AS_AREA_READ | AS_AREA_WRITE | AS_AREA_CACHEABLE); |
||
2928 | svoboda | 374 | if (a == (void *)(-1)) { |
375 | printf("memory mapping failed\n"); |
||
376 | return EE_MEMORY; |
||
377 | } |
||
378 | |||
2992 | svoboda | 379 | printf("as_area_create(0x%lx, 0x%x, %d) -> 0x%lx\n", |
380 | entry->p_vaddr+bias, entry->p_memsz, flags, (uintptr_t)a); |
||
2928 | svoboda | 381 | |
382 | /* |
||
383 | * Load segment data |
||
384 | */ |
||
2949 | svoboda | 385 | printf("seek to %d\n", entry->p_offset); |
2964 | svoboda | 386 | rc = lseek(elf->fd, entry->p_offset, SEEK_SET); |
2928 | svoboda | 387 | if (rc < 0) { printf("seek error\n"); return EE_INVALID; } |
388 | |||
2949 | svoboda | 389 | printf("read 0x%x bytes to address 0x%x\n", entry->p_filesz, entry->p_vaddr+bias); |
390 | /* rc = read(fd, (void *)(entry->p_vaddr + bias), entry->p_filesz); |
||
391 | if (rc < 0) { printf("read error\n"); return EE_INVALID; }*/ |
||
3101 | svoboda | 392 | |
393 | /* Long reads are not possible yet. Load segment picewise */ |
||
394 | |||
2949 | svoboda | 395 | unsigned left, now; |
396 | uint8_t *dp; |
||
2928 | svoboda | 397 | |
2949 | svoboda | 398 | left = entry->p_filesz; |
399 | dp = (uint8_t *)(entry->p_vaddr + bias); |
||
400 | |||
401 | while (left > 0) { |
||
2977 | svoboda | 402 | now = 16384; |
3101 | svoboda | 403 | if (now > left) now = left; |
404 | |||
2949 | svoboda | 405 | printf("read %d...", now); |
2964 | svoboda | 406 | rc = read(elf->fd, dp, now); |
3101 | svoboda | 407 | printf("->%d\n", rc); |
408 | |||
2949 | svoboda | 409 | if (rc < 0) { printf("read error\n"); return EE_INVALID; } |
3101 | svoboda | 410 | |
2949 | svoboda | 411 | left -= now; |
412 | dp += now; |
||
413 | } |
||
414 | |||
2985 | svoboda | 415 | printf("set area flags to %d\n", flags); |
416 | rc = as_area_change_flags((uint8_t *)entry->p_vaddr + bias, flags); |
||
417 | if (rc != 0) { |
||
418 | printf("failed to set memory area flags\n"); |
||
419 | return EE_MEMORY; |
||
420 | } |
||
421 | |||
2928 | svoboda | 422 | return EE_OK; |
423 | } |
||
424 | |||
425 | /** Process section header. |
||
426 | * |
||
3101 | svoboda | 427 | * @param elf Loader state. |
2928 | svoboda | 428 | * @param entry Segment header. |
429 | * |
||
430 | * @return EE_OK on success, error code otherwise. |
||
431 | */ |
||
2964 | svoboda | 432 | static int section_header(elf_ld_t *elf, elf_section_header_t *entry) |
2928 | svoboda | 433 | { |
434 | switch (entry->sh_type) { |
||
435 | case SHT_PROGBITS: |
||
436 | if (entry->sh_flags & SHF_TLS) { |
||
437 | /* .tdata */ |
||
438 | } |
||
439 | break; |
||
440 | case SHT_NOBITS: |
||
441 | if (entry->sh_flags & SHF_TLS) { |
||
442 | /* .tbss */ |
||
443 | } |
||
444 | break; |
||
2961 | svoboda | 445 | case SHT_DYNAMIC: |
3101 | svoboda | 446 | /* Record pointer to dynamic section into info structure */ |
2964 | svoboda | 447 | elf->info->dynamic = |
448 | (void *)((uint8_t *)entry->sh_addr + elf->bias); |
||
449 | printf("dynamic section found at 0x%x\n", |
||
450 | (uintptr_t)elf->info->dynamic); |
||
2961 | svoboda | 451 | break; |
2928 | svoboda | 452 | default: |
453 | break; |
||
454 | } |
||
455 | |||
456 | return EE_OK; |
||
457 | } |
||
458 | |||
459 | /** @} |
||
460 | */ |