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