1dee3c065ed25e4f43eac9ab5a22312aa50b6727
[akaros.git] / kern / src / elf.c
1 #include <mm.h>
2 #include <string.h>
3 #include <kmalloc.h>
4 #include <syscall.h>
5 #include <elf.h>
6 #include <pmap.h>
7 #include <smp.h>
8 #include <arch/arch.h>
9 #include <umem.h>
10
11 #ifdef CONFIG_64BIT
12 # define elf_field(obj, field) (elf64 ? (obj##64)->field : (obj##32)->field)
13 #else
14 # define elf_field(obj, field) ((obj##32)->field)
15 #endif
16
17 /* Check if the file is valid elf file (i.e. by checking for ELF_MAGIC in the
18  * header) */
19 bool is_valid_elf(struct file_or_chan *foc)
20 {
21         elf64_t h;
22         uintptr_t c = switch_to_ktask();
23
24         if (foc_read(foc, (char*)&h, sizeof(elf64_t), 0) != sizeof(elf64_t))
25                 goto fail;
26         if (h.e_magic != ELF_MAGIC) {
27                 goto fail;
28         }
29 success:
30         switch_back_from_ktask(c);
31         return TRUE;
32 fail:
33         switch_back_from_ktask(c);
34         return FALSE;
35 }
36
37 /* Function to get the lengths of the argument and environment strings. */
38 static int get_lens(int argc, char *argv[], int arg_lens[])
39 {
40         int total = 0;
41
42         for (int i = 0; i < argc; i++) {
43                 arg_lens[i] = strlen(argv[i]) + 1;
44                 total += arg_lens[i];
45         }
46         return total;
47 }
48
49 /* Function to help map the argument and environment strings, to their
50  * final location. */
51 static int remap(struct proc *p, int argc, char *argv[], char *new_argv[],
52                  char new_argbuf[], int arg_lens[])
53 {
54         int offset = 0;
55         char *temp_argv[argc + 1];
56
57         for (int i = 0; i < argc; i++) {
58                 if (memcpy_to_user(p, new_argbuf + offset, argv[i],
59                                    arg_lens[i]))
60                         return -1;
61                 temp_argv[i] = new_argbuf + offset;
62                 offset += arg_lens[i];
63         }
64         temp_argv[argc] = NULL;
65         if (memcpy_to_user(p, new_argv, temp_argv, sizeof(temp_argv)))
66                 return -1;
67         return offset;
68 }
69
70 static uintptr_t populate_stack(struct proc *p, int argc, char *argv[],
71                                                 int envc, char *envp[],
72                                                 int auxc, elf_aux_t auxv[])
73 {
74         /* Map in pages for p's stack. */
75         int flags = MAP_FIXED | MAP_ANONYMOUS | MAP_PRIVATE;
76         uintptr_t stacksz = USTACK_NUM_PAGES*PGSIZE;
77
78         if (do_mmap(p, USTACKTOP-stacksz, stacksz, PROT_READ | PROT_WRITE,
79                     flags, NULL, 0) == MAP_FAILED)
80                 return 0;
81
82         /* Start tracking the size of the buffer necessary to hold all of our
83          * data on the stack. Preallocate space for argc, argv, envp, and auxv
84          * in this buffer. */
85         int bufsize = 0;
86
87         bufsize += 1 * sizeof(size_t);
88         bufsize += (auxc + 1) * sizeof(elf_aux_t);
89         bufsize += (envc + 1) * sizeof(char**);
90         bufsize += (argc + 1) * sizeof(char**);
91
92         /* Add in the size of the env and arg strings. */
93         int arg_lens[argc];
94         int env_lens[envc];
95
96         bufsize += get_lens(argc, argv, arg_lens);
97         bufsize += get_lens(envc, envp, env_lens);
98
99         /* Adjust bufsize so that our buffer will ultimately be 16 byte aligned.
100          */
101         bufsize = ROUNDUP(bufsize, 16);
102
103         /* Set up pointers to all of the appropriate data regions we map to. */
104         size_t *new_argc = (size_t*)(USTACKTOP - bufsize);
105         char **new_argv = (char**)(new_argc + 1);
106         char **new_envp = new_argv + argc + 1;
107         elf_aux_t *new_auxv = (elf_aux_t*)(new_envp + envc + 1);
108         char *new_argbuf = (char*)(new_auxv + auxc + 1);
109
110         /* Verify that all data associated with our argv, envp, and auxv arrays
111          * (and any corresponding strings they point to) will fit in the space
112          * alloted. */
113         if (bufsize > ARG_MAX)
114                 return 0;
115
116         /* Map argc into its final location. */
117         if (memcpy_to_user(p, new_argc, &argc, sizeof(size_t)))
118                 return 0;
119
120         /* Map all data for argv and envp into its final location. */
121         int offset = 0;
122
123         offset = remap(p, argc, argv, new_argv, new_argbuf, arg_lens);
124         if (offset == -1)
125                 return 0;
126         offset = remap(p, envc, envp, new_envp, new_argbuf + offset, env_lens);
127         if (offset == -1)
128                 return 0;
129
130         /* Map auxv into its final location. */
131         elf_aux_t null_aux = {0, 0};
132         if (memcpy_to_user(p, new_auxv, auxv, auxc * sizeof(elf_aux_t)))
133                 return 0;
134         if (memcpy_to_user(p, new_auxv + auxc, &null_aux, sizeof(elf_aux_t)))
135                 return 0;
136
137         return USTACKTOP - bufsize;
138 }
139
140 /* We need the writable flag for ld.  Even though the elf header says it wants
141  * RX (and not W) for its main program header, it will page fault (eip 56f0,
142  * 46f0 after being relocated to 0x1000, va 0x20f4). */
143 static int load_one_elf(struct proc *p, struct file_or_chan *foc,
144                         uintptr_t pg_num, elf_info_t *ei, bool writable)
145 {
146         int ret = -1;
147         ei->phdr = -1;
148         ei->dynamic = 0;
149         ei->highest_addr = 0;
150         off64_t f_off = 0;
151         void* phdrs = 0;
152         int mm_perms, mm_flags;
153
154         /* When reading on behalf of the kernel, we need to switch to a ktask so
155          * the VFS (and maybe other places) know. (TODO: KFOP) */
156         uintptr_t old_ret = switch_to_ktask();
157
158         /* Read in ELF header. */
159         elf64_t elfhdr_storage;
160         elf32_t* elfhdr32 = (elf32_t*)&elfhdr_storage;
161         elf64_t* elfhdr64 = &elfhdr_storage;
162         if (foc_read(foc, (char*)elfhdr64, sizeof(elf64_t), f_off)
163                 != sizeof(elf64_t)) {
164                 /* if you ever debug this, be sure to 0 out elfhrd_storage in
165                  * advance */
166                 printk("[kernel] load_one_elf: failed to read file\n");
167                 goto fail;
168         }
169         if (elfhdr64->e_magic != ELF_MAGIC) {
170                 printk("[kernel] load_one_elf: file is not an elf!\n");
171                 goto fail;
172         }
173         bool elf32 = elfhdr32->e_ident[ELF_IDENT_CLASS] == ELFCLASS32;
174         bool elf64 = elfhdr64->e_ident[ELF_IDENT_CLASS] == ELFCLASS64;
175         if (elf64 == elf32) {
176                 printk("[kernel] load_one_elf: ID as both 32 and 64 bit\n");
177                 goto fail;
178         }
179         #ifndef CONFIG_64BIT
180         if (elf64) {
181                 printk("[kernel] load_one_elf: 64 bit elf on 32 bit kernel\n");
182                 goto fail;
183         }
184         #endif
185         /* Not sure what RISCV's 64 bit kernel can do here, so this check is x86
186          * only */
187         #ifdef CONFIG_X86
188         if (elf32) {
189                 printk("[kernel] load_one_elf: 32 bit elf on 64 bit kernel\n");
190                 goto fail;
191         }
192         #endif
193
194         size_t phsz = elf64 ? sizeof(proghdr64_t) : sizeof(proghdr32_t);
195         uint16_t e_phnum = elf_field(elfhdr, e_phnum);
196         uint16_t e_phoff = elf_field(elfhdr, e_phoff);
197
198         /* Read in program headers. */
199         if (e_phnum > 10000 || e_phoff % (elf32 ? 4 : 8) != 0) {
200                 printk("[kernel] load_one_elf: Bad program headers\n");
201                 goto fail;
202         }
203         phdrs = kmalloc(e_phnum * phsz, 0);
204         f_off = e_phoff;
205         if (!phdrs || foc_read(foc, phdrs, e_phnum * phsz, f_off) !=
206                       e_phnum * phsz) {
207                 printk("[kernel] load_one_elf: couldn't get program headers\n");
208                 goto fail;
209         }
210         for (int i = 0; i < e_phnum; i++) {
211                 proghdr32_t* ph32 = (proghdr32_t*)phdrs + i;
212                 proghdr64_t* ph64 = (proghdr64_t*)phdrs + i;
213                 uint16_t p_type = elf_field(ph, p_type);
214                 uintptr_t p_va = elf_field(ph, p_va);
215                 uintptr_t p_offset = elf_field(ph, p_offset);
216                 uintptr_t p_align = elf_field(ph, p_align);
217                 uintptr_t p_memsz = elf_field(ph, p_memsz);
218                 uintptr_t p_filesz = elf_field(ph, p_filesz);
219                 uintptr_t p_flags = elf_field(ph, p_flags);
220
221                 /* Here's the ld hack, mentioned above */
222                 p_flags |= (writable ? ELF_PROT_WRITE : 0);
223                 /* All mmaps need to be fixed to their VAs.  If the program
224                  * wants it to be a writable region, we also need the region to
225                  * be private. */
226                 mm_flags = MAP_FIXED | (p_flags & ELF_PROT_WRITE ? MAP_PRIVATE :
227                                         MAP_SHARED);
228
229                 if (p_type == ELF_PROG_PHDR)
230                         ei->phdr = p_va;
231                 else if (p_type == ELF_PROG_INTERP) {
232                         f_off = p_offset;
233                         ssize_t maxlen = sizeof(ei->interp);
234                         ssize_t bytes = foc_read(foc, ei->interp, maxlen,
235                                                  f_off);
236                         /* trying to catch errors.  don't know how big it could
237                          * be, but it should be at least 0. */
238                         if (bytes <= 0) {
239                                 printk("[kernel] load_one_elf: could not read ei->interp\n");
240                                 goto fail;
241                         }
242
243                         maxlen = MIN(maxlen, bytes);
244                         if (strnlen(ei->interp, maxlen) == maxlen) {
245                                 printk("[kernel] load_one_elf: interpreter name too long\n");
246                                 goto fail;
247                         }
248
249                         ei->dynamic = 1;
250                 }
251                 else if (p_type == ELF_PROG_LOAD && p_memsz) {
252                         if (p_align % PGSIZE) {
253                                 printk("[kernel] load_one_elf: not page aligned\n");
254                                 goto fail;
255                         }
256                         if (p_offset % PGSIZE != p_va % PGSIZE) {
257                                 printk("[kernel] load_one_elf: offset difference \n");
258                                 goto fail;
259                         }
260
261                         uintptr_t filestart = ROUNDDOWN(p_offset, PGSIZE);
262                         uintptr_t filesz = p_offset + p_filesz - filestart;
263
264                         uintptr_t memstart = ROUNDDOWN(p_va, PGSIZE);
265                         uintptr_t memsz = ROUNDUP(p_va + p_memsz, PGSIZE) -
266                                 memstart;
267                         memstart += pg_num * PGSIZE;
268
269                         if (memstart + memsz > ei->highest_addr)
270                                 ei->highest_addr = memstart + memsz;
271
272                         mm_perms = 0;
273                         mm_perms |= (p_flags & ELF_PROT_READ  ? PROT_READ : 0);
274                         mm_perms |= (p_flags & ELF_PROT_WRITE ? PROT_WRITE : 0);
275                         mm_perms |= (p_flags & ELF_PROT_EXEC  ? PROT_EXEC : 0);
276
277                         if (filesz) {
278                                 /* Due to elf-ghetto-ness, we need to zero the
279                                  * first part of the BSS from the last page of
280                                  * the data segment.  If we end on a partial
281                                  * page, we map it in separately with
282                                  * MAP_POPULATE so that we can zero the rest of
283                                  * it now. We translate to the KVA so we don't
284                                  * need to worry about using the proc's mapping
285                                  * */
286                                 uintptr_t partial = PGOFF(filesz);
287
288                                 if (filesz - partial) {
289                                         /* Map the complete pages. */
290                                         if (do_mmap(p, memstart, filesz -
291                                                     partial, mm_perms, mm_flags,
292                                                     foc, filestart) ==
293                                             MAP_FAILED) {
294                                                 printk("[kernel] load_one_elf: complete mmap failed\n");
295                                                 goto fail;
296                                         }
297                                 }
298                                 /* Note that we (probably) only need to do this
299                                  * zeroing the end of a partial file page when
300                                  * we are dealing with ELF_PROT_WRITE-able PHs,
301                                  * and not for all cases.  */
302                                 if (partial) {
303                                         /* Need our own populated, private copy
304                                          * of the page so that we can zero the
305                                          * remainder - and not zero chunks of
306                                          * the real file in the page cache. */
307                                         mm_flags &= ~MAP_SHARED;
308                                         mm_flags |= MAP_PRIVATE | MAP_POPULATE;
309
310                                         /* Map the final partial page. */
311                                         uintptr_t last_page = memstart + filesz
312                                                 - partial;
313                                         if (do_mmap(p, last_page, PGSIZE,
314                                                     mm_perms, mm_flags, foc,
315                                                     filestart + filesz -
316                                                     partial) == MAP_FAILED) {
317                                                 printk("[kernel] load_one_elf: partial mmap failed\n");
318                                                 goto fail;
319                                         }
320
321                                         pte_t pte = pgdir_walk(p->env_pgdir,
322                                                                (void*)last_page,
323                                                                0);
324                                         /* if we were able to get a PTE, then
325                                          * there is a real page backing the VMR,
326                                          * and we need to zero the excess.  if
327                                          * there isn't, then the page fault code
328                                          * should handle it.  since we set
329                                          * populate above, we should have a PTE,
330                                          * except in cases where the offset +
331                                          * len window exceeded the file size.
332                                          * in this case, we let them mmap it,
333                                          * but didn't populate it.  there will
334                                          * be a PF right away if someone tries
335                                          * to use this.  check out do_mmap for
336                                          * more info. */
337                                         if (pte_walk_okay(pte)) {
338                                                 void *last_page_kva =
339                                                     KADDR(pte_get_paddr(pte));
340                                                 memset(last_page_kva + partial,
341                                                        0, PGSIZE - partial);
342                                         }
343
344                                         filesz = ROUNDUP(filesz, PGSIZE);
345                                 }
346                         }
347                         /* Any extra pages are mapped anonymously... (a bit
348                          * weird) */
349                         if (filesz < memsz)
350                                 if (do_mmap(p, memstart + filesz, memsz-filesz,
351                                             PROT_READ | PROT_WRITE, MAP_PRIVATE,
352                                                 NULL, 0) == MAP_FAILED) {
353                                         printk("[kernel] load_one_elf: anon mmap failed\n");
354                                         goto fail;
355                                 }
356                 }
357         }
358         /* map in program headers anyway if not present in binary.
359          * useful for TLS in static programs. */
360         if (ei->phdr == -1) {
361                 uintptr_t filestart = ROUNDDOWN(e_phoff, PGSIZE);
362                 uintptr_t filesz = e_phoff + (e_phnum * phsz) - filestart;
363                 void *phdr_addr = do_mmap(p, 0, filesz, PROT_READ | PROT_WRITE,
364                                           MAP_PRIVATE, foc, filestart);
365                 if (phdr_addr == MAP_FAILED) {
366                         printk("[kernel] load_one_elf: prog header mmap failed\n");
367                         goto fail;
368                 }
369                 ei->phdr = (long)phdr_addr + e_phoff;
370         }
371         ei->entry = elf_field(elfhdr, e_entry) + pg_num * PGSIZE;
372         ei->phnum = e_phnum;
373         ei->elf64 = elf64;
374         ret = 0;
375         /* Fall-through */
376 fail:
377         if (phdrs)
378                 kfree(phdrs);
379         switch_back_from_ktask(old_ret);
380         return ret;
381 }
382
383 int load_elf(struct proc *p, struct file_or_chan *foc,
384              int argc, char *argv[], int envc, char *envp[])
385 {
386         elf_info_t ei, interp_ei;
387         if (load_one_elf(p, foc, 0, &ei, FALSE))
388                 return -1;
389
390         if (ei.dynamic) {
391                 struct file_or_chan *interp = foc_open(ei.interp, O_EXEC |
392                                                        O_READ, 0);
393
394                 if (!interp)
395                         return -1;
396                 /* Load dynamic linker at 1M. Obvious MIB joke avoided.
397                  * It used to be loaded at page 1, but the existence of valid
398                  * addresses that low masked bad derefs through NULL pointer
399                  * structs. This in turn helped us waste a full day debugging a
400                  * bug in the Go runtime. True!  Note that MMAP_LOWEST_VA also
401                  * has this value but we want to make this explicit. */
402                 int error = load_one_elf(p, interp, MMAP_LD_FIXED_VA >> PGSHIFT,
403                                          &interp_ei, TRUE);
404                 foc_decref(interp);
405                 if (error)
406                         return -1;
407         }
408
409         /* Set up the auxiliary info for dynamic linker/runtime */
410         elf_aux_t auxv[] = {{ELF_AUX_PHDR, ei.phdr},
411                             {ELF_AUX_PHENT, sizeof(proghdr32_t)},
412                             {ELF_AUX_PHNUM, ei.phnum},
413                             {ELF_AUX_ENTRY, ei.entry}};
414         int auxc = sizeof(auxv)/sizeof(auxv[0]);
415
416         /* Populate the stack with the required info. */
417         uintptr_t stack_top = populate_stack(p, argc, argv, envc, envp, auxc,
418                                              auxv);
419         if (!stack_top)
420                 return -1;
421
422         /* Initialize the process as an SCP. */
423         uintptr_t core0_entry = ei.dynamic ? interp_ei.entry : ei.entry;
424         proc_init_ctx(&p->scp_ctx, 0, core0_entry, stack_top, 0);
425
426         p->procinfo->program_end = ei.highest_addr;
427         p->args_base = (void *) stack_top;
428
429         return 0;
430 }
431
432 ssize_t get_startup_argc(struct proc *p)
433 {
434         const char *sptr = (const char *) p->args_base;
435         ssize_t argc = 0;
436
437         /* TODO,DL: Use copy_from_user() when available.
438          */
439         if (memcpy_from_user(p, &argc, sptr, sizeof(size_t)))
440                 return -1;
441
442         return argc;
443 }
444
445 char *get_startup_argv(struct proc *p, size_t idx, char *argp,
446                                            size_t max_size)
447 {
448         size_t stack_space = (const char *) USTACKTOP - (const char *)
449                 p->args_base;
450         const char *sptr = (const char *) p->args_base + sizeof(size_t) +
451                 idx * sizeof(char *);
452         const char *argv = NULL;
453
454         /* TODO,DL: Use copy_from_user() when available.
455          */
456         if (memcpy_from_user(p, &argv, sptr, sizeof(char *)))
457                 return NULL;
458
459         /* TODO,DL: Use strncpy_from_user() when available.
460          */
461         max_size = MIN(max_size, stack_space);
462         if (memcpy_from_user(p, argp, argv, max_size))
463                 return NULL;
464         argp[max_size - 1] = 0;
465
466         return argp;
467 }