Remove historical file.
[akaros.git] / kern / src / elf.c
1 #include <mm.h>
2 #include <frontend.h>
3 #include <string.h>
4 #include <kmalloc.h>
5 #include <syscall.h>
6 #include <elf.h>
7 #include <pmap.h>
8 #include <smp.h>
9 #include <arch/arch.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 *f)
20 {
21         elf64_t h;
22         off64_t o = 0;
23         struct proc *c = switch_to(0);
24
25         if (f->f_op->read(f, (char*)&h, sizeof(elf64_t), &o) != sizeof(elf64_t)) {
26                 goto fail;
27         }
28         if (h.e_magic != ELF_MAGIC) {
29                 goto fail;
30         }
31 success:
32         switch_back(0, c);
33         return TRUE;
34 fail:
35         switch_back(0, c);
36         return FALSE;
37 }
38
39 /* We need the writable flag for ld.  Even though the elf header says it wants
40  * RX (and not W) for its main program header, it will page fault (eip 56f0,
41  * 46f0 after being relocated to 0x1000, va 0x20f4). */
42 static int load_one_elf(struct proc *p, struct file *f, uintptr_t pgoffset,
43                         elf_info_t *ei, bool writable)
44 {
45         int ret = -1;
46         ei->phdr = -1;
47         ei->dynamic = 0;
48         ei->highest_addr = 0;
49         off64_t f_off = 0;
50         void* phdrs = 0;
51         int mm_perms, mm_flags = MAP_FIXED;
52         
53         /* When reading on behalf of the kernel, we need to make sure no proc is
54          * "current".  This is a bit ghetto (TODO: KFOP) */
55         struct proc *old_proc = switch_to(0);
56
57         /* Read in ELF header. */
58         elf64_t elfhdr_storage;
59         elf32_t* elfhdr32 = (elf32_t*)&elfhdr_storage;
60         elf64_t* elfhdr64 = &elfhdr_storage;
61         if (f->f_op->read(f, (char*)elfhdr64, sizeof(elf64_t), &f_off)
62                 != sizeof(elf64_t)) {
63                 /* if you ever debug this, be sure to 0 out elfhrd_storage in advance */
64                 printk("[kernel] load_one_elf: failed to read file\n");
65                 goto fail;
66         }
67         if (elfhdr64->e_magic != ELF_MAGIC) {
68                 printk("[kernel] load_one_elf: file is not an elf!\n");
69                 goto fail;
70         }
71         bool elf32 = elfhdr32->e_ident[ELF_IDENT_CLASS] == ELFCLASS32;
72         bool elf64 = elfhdr64->e_ident[ELF_IDENT_CLASS] == ELFCLASS64;
73         if (elf64 == elf32) {
74                 printk("[kernel] load_one_elf: ID as both 32 and 64 bit\n");
75                 goto fail;
76         }
77         #ifndef CONFIG_64BIT
78         if (elf64) {
79                 printk("[kernel] load_one_elf: 64 bit elf on 32 bit kernel\n");
80                 goto fail;
81         }
82         #endif
83         #ifdef CONFIG_X86_64
84         if (elf32) {
85                 printk("[kernel] load_one_elf: 32 bit elf on 64 bit kernel\n");
86                 goto fail;
87         }
88         #endif
89
90         size_t phsz = elf64 ? sizeof(proghdr64_t) : sizeof(proghdr32_t);
91         uint16_t e_phnum = elf_field(elfhdr, e_phnum);
92         uint16_t e_phoff = elf_field(elfhdr, e_phoff);
93
94         /* Read in program headers. */
95         if (e_phnum > 10000 || e_phoff % (elf32 ? 4 : 8) != 0) {
96                 printk("[kernel] load_one_elf: Bad program headers\n");
97                 goto fail;
98         }
99         phdrs = kmalloc(e_phnum * phsz, 0);
100         f_off = e_phoff;
101         if (!phdrs || f->f_op->read(f, phdrs, e_phnum * phsz, &f_off) !=
102                       e_phnum * phsz) {
103                 printk("[kernel] load_one_elf: could not get program headers\n");
104                 goto fail;
105         }
106         for (int i = 0; i < e_phnum; i++) {
107                 proghdr32_t* ph32 = (proghdr32_t*)phdrs + i;
108                 proghdr64_t* ph64 = (proghdr64_t*)phdrs + i;
109                 uint16_t p_type = elf_field(ph, p_type);
110                 uintptr_t p_va = elf_field(ph, p_va);
111                 uintptr_t p_offset = elf_field(ph, p_offset);
112                 uintptr_t p_align = elf_field(ph, p_align);
113                 uintptr_t p_memsz = elf_field(ph, p_memsz);
114                 uintptr_t p_filesz = elf_field(ph, p_filesz);
115                 uintptr_t p_flags = elf_field(ph, p_flags);
116
117                 /* Here's the ld hack, mentioned above */
118                 p_flags |= (writable ? ELF_PROT_WRITE : 0);
119                 /* All mmaps need to be fixed to their VAs.  If the program wants it to
120                  * be a writable region, we also need the region to be private. */
121                 mm_flags = MAP_FIXED | (p_flags & ELF_PROT_WRITE ? MAP_PRIVATE : 0);
122
123                 if (p_type == ELF_PROG_PHDR)
124                         ei->phdr = p_va;
125                 else if (p_type == ELF_PROG_INTERP) {
126                         f_off = p_offset;
127                         ssize_t maxlen = sizeof(ei->interp);
128                         ssize_t bytes = f->f_op->read(f, ei->interp, maxlen, &f_off);
129                         /* trying to catch errors.  don't know how big it could be, but it
130                          * should be at least 0. */
131                         if (bytes <= 0) {
132                                 printk("[kernel] load_one_elf: could not read ei->interp\n");
133                                 goto fail;
134                         }
135
136                         maxlen = MIN(maxlen, bytes);
137                         if (strnlen(ei->interp, maxlen) == maxlen) {
138                                 printk("[kernel] load_one_elf: interpreter name too long\n");
139                                 goto fail;
140                         }
141
142                         ei->dynamic = 1;
143                 }
144                 else if (p_type == ELF_PROG_LOAD && p_memsz) {
145                         if (p_align % PGSIZE) {
146                                 printk("[kernel] load_one_elf: not page aligned\n");
147                                 goto fail;
148                         }
149                         if (p_offset % PGSIZE != p_va % PGSIZE) {
150                                 printk("[kernel] load_one_elf: offset difference \n");
151                                 goto fail;
152                         }
153
154                         uintptr_t filestart = ROUNDDOWN(p_offset, PGSIZE);
155                         uintptr_t filesz = p_offset + p_filesz - filestart;
156
157                         uintptr_t memstart = ROUNDDOWN(p_va, PGSIZE);
158                         uintptr_t memsz = ROUNDUP(p_va + p_memsz, PGSIZE) - memstart;
159                         memstart += pgoffset * PGSIZE;
160
161                         if (memstart + memsz > ei->highest_addr)
162                                 ei->highest_addr = memstart + memsz;
163
164                         mm_perms = 0;
165                         mm_perms |= (p_flags & ELF_PROT_READ  ? PROT_READ : 0);
166                         mm_perms |= (p_flags & ELF_PROT_WRITE ? PROT_WRITE : 0);
167                         mm_perms |= (p_flags & ELF_PROT_EXEC  ? PROT_EXEC : 0);
168
169                         if (filesz) {
170                                 /* Due to elf-ghetto-ness, we need to zero the first part of
171                                  * the BSS from the last page of the data segment.  If we end
172                                  * on a partial page, we map it in separately with
173                                  * MAP_POPULATE so that we can zero the rest of it now. We
174                                  * translate to the KVA so we don't need to worry about using
175                                  * the proc's mapping */
176                                 uintptr_t partial = PGOFF(filesz);
177
178                                 if (filesz - partial) {
179                                         /* Map the complete pages. */
180                                         if (do_mmap(p, memstart, filesz - partial, mm_perms,
181                                                     mm_flags, f, filestart) == MAP_FAILED) {
182                                                 printk("[kernel] load_one_elf: complete mmap failed\n");
183                                                 goto fail;
184                                         }
185                                 }
186                                 /* Note that we (probably) only need to do this zeroing the end
187                                  * of a partial file page when we are dealing with
188                                  * ELF_PROT_WRITE-able PHs, and not for all cases.  */
189                                 if (partial) {
190                                         /* Need our own populated, private copy of the page so that
191                                          * we can zero the remainder - and not zero chunks of the
192                                          * real file in the page cache. */
193                                         mm_flags |= MAP_PRIVATE | MAP_POPULATE;
194
195                                         /* Map the final partial page. */
196                                         uintptr_t last_page = memstart + filesz - partial;
197                                         if (do_mmap(p, last_page, PGSIZE, mm_perms, mm_flags,
198                                                     f, filestart + filesz - partial) == MAP_FAILED) {
199                                                 printk("[kernel] load_one_elf: partial mmap failed\n");
200                                                 goto fail;
201                                         }
202
203                                         /* Zero the end of it.  This is a huge pain in the ass.  The
204                                          * filesystems should zero out the last bits of a page if
205                                          * the file doesn't fill the last page.  But we're dealing
206                                          * with windows into otherwise complete files. */
207                                         pte_t *pte = pgdir_walk(p->env_pgdir, (void*)last_page, 0);
208                                         /* if we were able to get a PTE, then there is a real page
209                                          * backing the VMR, and we need to zero the excess.  if
210                                          * there isn't, then the page fault code should handle it.
211                                          * since we set populate above, we should have a PTE, except
212                                          * in cases where the offset + len window exceeded the file
213                                          * size.  in this case, we let them mmap it, but didn't
214                                          * populate it.  there will be a PF right away if someone
215                                          * tries to use this.  check out do_mmap for more info. */
216                                         if (pte) {
217                                                 void* last_page_kva = ppn2kva(PTE2PPN(*pte));
218                                                 memset(last_page_kva + partial, 0, PGSIZE - partial);
219                                         }
220
221                                         filesz = ROUNDUP(filesz, PGSIZE);
222                                 }
223                         }
224                         /* Any extra pages are mapped anonymously... (a bit weird) */
225                         if (filesz < memsz)
226                                 if (do_mmap(p, memstart + filesz, memsz-filesz,
227                                             PROT_READ | PROT_WRITE, MAP_PRIVATE,
228                                                 NULL, 0) == MAP_FAILED) {
229                                         printk("[kernel] load_one_elf: anon mmap failed\n");
230                                         goto fail;
231                                 }
232                 }
233         }
234         /* map in program headers anyway if not present in binary.
235          * useful for TLS in static programs. */
236         if (ei->phdr == -1) {
237                 uintptr_t filestart = ROUNDDOWN(e_phoff, PGSIZE);
238                 uintptr_t filesz = e_phoff + (e_phnum * phsz) - filestart;
239                 void *phdr_addr = do_mmap(p, 0, filesz, PROT_READ | PROT_WRITE,
240                                           MAP_PRIVATE, f, filestart);
241                 if (phdr_addr == MAP_FAILED) {
242                         printk("[kernel] load_one_elf: prog header mmap failed\n");
243                         goto fail;
244                 }
245                 ei->phdr = (long)phdr_addr + e_phoff;
246         }
247         ei->entry = elf_field(elfhdr, e_entry) + pgoffset*PGSIZE;
248         ei->phnum = e_phnum;
249         ei->elf64 = elf64;
250         ret = 0;
251         /* Fall-through */
252 fail:
253         if (phdrs)
254                 kfree(phdrs);
255         switch_back(0, old_proc);
256         return ret;
257 }
258
259 int load_elf(struct proc* p, struct file* f)
260 {
261         elf_info_t ei, interp_ei;
262         if (load_one_elf(p, f, 0, &ei, FALSE))
263                 return -1;
264
265         if (ei.dynamic) {
266                 struct file *interp = do_file_open(ei.interp, 0, 0);
267                 if (!interp)
268                         return -1;
269                 /* Load dynamic linker at 1M. Obvious MIB joke avoided.
270                  * It used to be loaded at page 1, but the existence of valid addresses
271                  * that low masked bad derefs through NULL pointer structs. This in turn
272                  * helped us waste a full day debugging a bug in the Go runtime. True!
273                  * Note that MMAP_LOWEST_VA also has this value but we want to make this
274                  * explicit. */
275                 int error = load_one_elf(p, interp, MiB>>12, &interp_ei, TRUE);
276                 kref_put(&interp->f_kref);
277                 if (error)
278                         return -1;
279         }
280
281         // fill in auxiliary info for dynamic linker/runtime
282         elf_aux_t auxp[] = {{ELF_AUX_PHDR, ei.phdr},
283                             {ELF_AUX_PHENT, sizeof(proghdr32_t)},
284                             {ELF_AUX_PHNUM, ei.phnum},
285                             {ELF_AUX_ENTRY, ei.entry},
286                             {0, 0}};
287
288         // put auxp after argv, envp in procinfo
289         int auxp_pos = -1;
290         for (int i = 0, zeros = 0; i < PROCINFO_MAX_ARGP; i++)
291                 if (p->procinfo->argp[i] == NULL)
292                         if (++zeros == 2)
293                                 auxp_pos = i + 1;
294         if (auxp_pos == -1 ||
295             auxp_pos + sizeof(auxp) / sizeof(char*) >= PROCINFO_MAX_ARGP)
296                 return -1;
297         memcpy(p->procinfo->argp+auxp_pos,auxp,sizeof(auxp));
298
299         uintptr_t core0_entry = ei.dynamic ? interp_ei.entry : ei.entry;
300         proc_init_ctx(&p->scp_ctx, 0, core0_entry, USTACKTOP, 0);
301         p->env_entry = ei.entry;
302
303         int flags = MAP_FIXED | MAP_ANONYMOUS;
304         uintptr_t stacksz = USTACK_NUM_PAGES*PGSIZE;
305         if (do_mmap(p, USTACKTOP-stacksz, stacksz, PROT_READ | PROT_WRITE,
306                     flags, NULL, 0) == MAP_FAILED)
307                 return -1;
308
309         // Set the heap bottom and top to just past where the text 
310         // region has been loaded
311         p->heap_top = (void*)ei.highest_addr;
312         p->procinfo->heap_bottom = p->heap_top;
313
314         return 0;
315 }
316