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