proc_change_to_m() is now a scheduler function
[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 KERN64
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         off_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 *cur_proc = current;
34         current = 0;
35
36         /* Read in ELF header. */
37         elf64_t elfhdr_storage;
38         elf32_t* elfhdr32 = (elf32_t*)&elfhdr_storage;
39         elf64_t* elfhdr64 = &elfhdr_storage;
40         if (f->f_op->read(f, (char*)elfhdr64, sizeof(elf64_t), &f_off) == -1)
41                 goto fail;
42
43         bool elf32 = elfhdr32->e_ident[ELF_IDENT_CLASS] == ELFCLASS32;
44         bool elf64 = elfhdr64->e_ident[ELF_IDENT_CLASS] == ELFCLASS64;
45         if (elf64 == elf32)
46                 goto fail;
47         #ifndef KERN64
48         if(elf64)
49                 goto fail;
50         #endif
51
52         size_t phsz = elf64 ? sizeof(proghdr64_t) : sizeof(proghdr32_t);
53         uint16_t e_phnum = elf_field(elfhdr, e_phnum);
54         uint16_t e_phoff = elf_field(elfhdr, e_phoff);
55
56         /* Read in program headers. */
57         if (e_phnum > 10000 || e_phoff % (elf32 ? 4 : 8) != 0)
58           goto fail;
59         phdrs = kmalloc(e_phnum * phsz, 0);
60         f_off = e_phoff;
61         if (!phdrs || f->f_op->read(f, phdrs, e_phnum * phsz, &f_off) == -1)
62                 goto fail;
63         for (int i = 0; i < e_phnum; i++) {
64                 proghdr32_t* ph32 = (proghdr32_t*)phdrs + i;
65                 proghdr64_t* ph64 = (proghdr64_t*)phdrs + i;
66                 uint16_t p_type = elf_field(ph, p_type);
67                 uintptr_t p_va = elf_field(ph, p_va);
68                 uintptr_t p_offset = elf_field(ph, p_offset);
69                 uintptr_t p_align = elf_field(ph, p_align);
70                 uintptr_t p_memsz = elf_field(ph, p_memsz);
71                 uintptr_t p_filesz = elf_field(ph, p_filesz);
72                 uintptr_t p_flags = elf_field(ph, p_flags);
73
74                 /* Here's the ld hack, mentioned above */
75                 p_flags |= (writable ? ELF_PROT_WRITE : 0);
76                 /* All mmaps need to be fixed to their VAs.  If the program wants it to
77                  * be a writable region, we also need the region to be private. */
78                 mm_flags = MAP_FIXED | (p_flags & ELF_PROT_WRITE ? MAP_PRIVATE : 0);
79
80                 if (p_type == ELF_PROG_PHDR)
81                         ei->phdr = p_va;
82                 else if (p_type == ELF_PROG_INTERP) {
83                         f_off = p_offset;
84                         ssize_t maxlen = sizeof(ei->interp);
85                         ssize_t bytes = f->f_op->read(f, ei->interp, maxlen, &f_off);
86                         if (bytes == -1)
87                           goto fail;
88
89                         maxlen = MIN(maxlen, bytes);
90                         if (strnlen(ei->interp, maxlen) == maxlen)
91                           goto fail;
92
93                         ei->dynamic = 1;
94                 }
95                 else if (p_type == ELF_PROG_LOAD && p_memsz) {
96                         if (p_align % PGSIZE)
97                                 goto fail;
98                         if (p_offset % PGSIZE != p_va % PGSIZE)
99                                 goto fail;
100
101                         uintptr_t filestart = ROUNDDOWN(p_offset, PGSIZE);
102                         uintptr_t filesz = p_offset + p_filesz - filestart;
103
104                         uintptr_t memstart = ROUNDDOWN(p_va, PGSIZE);
105                         uintptr_t memsz = ROUNDUP(p_va + p_memsz, PGSIZE) - memstart;
106                         memstart += pgoffset * PGSIZE;
107
108                         if (memstart + memsz > ei->highest_addr)
109                                 ei->highest_addr = memstart + memsz;
110
111                         mm_perms = 0;
112                         mm_perms |= (p_flags & ELF_PROT_READ  ? PROT_READ : 0);
113                         mm_perms |= (p_flags & ELF_PROT_WRITE ? PROT_WRITE : 0);
114                         mm_perms |= (p_flags & ELF_PROT_EXEC  ? PROT_EXEC : 0);
115
116                         if (filesz) {
117                                 /* Due to elf-ghetto-ness, we need to zero the first part of
118                                  * the BSS from the last page of the data segment.  If we end
119                                  * on a partial page, we map it in separately with
120                                  * MAP_POPULATE so that we can zero the rest of it now. We
121                                  * translate to the KVA so we don't need to worry about using
122                                  * the proc's mapping */
123                                 uintptr_t partial = PGOFF(filesz);
124
125                                 if (filesz - partial) {
126                                         /* Map the complete pages. */
127                                         if (do_mmap(p, memstart, filesz - partial, mm_perms,
128                                                     mm_flags, f, filestart) == MAP_FAILED)
129                                                 goto fail;
130                                 }
131                                 /* Note that we (probably) only need to do this zeroing the end
132                                  * of a partial file page when we are dealing with
133                                  * ELF_PROT_WRITE-able PHs, and not for all cases.  */
134                                 if (partial) {
135                                         /* Need our own populated, private copy of the page so that
136                                          * we can zero the remainder - and not zero chunks of the
137                                          * real file in the page cache. */
138                                         mm_flags |= MAP_PRIVATE | MAP_POPULATE;
139
140                                         /* Map the final partial page. */
141                                         uintptr_t last_page = memstart + filesz - partial;
142                                         if (do_mmap(p, last_page, PGSIZE, mm_perms, mm_flags,
143                                                     f, filestart + filesz - partial) == MAP_FAILED)
144                                                 goto fail;
145
146                                         /* Zero the end of it. */
147                                         pte_t *pte = pgdir_walk(p->env_pgdir, (void*)last_page, 0);
148                                         assert(pte);
149                                         void* last_page_kva = ppn2kva(PTE2PPN(*pte));
150                                         memset(last_page_kva + partial, 0, PGSIZE - partial);
151
152                                         filesz = ROUNDUP(filesz, PGSIZE);
153                                 }
154                         }
155                         /* Any extra pages are mapped anonymously... (a bit weird) */
156                         if (filesz < memsz)
157                                 if (do_mmap(p, memstart + filesz, memsz-filesz,
158                                             PROT_READ | PROT_WRITE, MAP_PRIVATE,
159                                                 NULL, 0) == MAP_FAILED)
160                                         goto fail;
161                 }
162         }
163         /* map in program headers anyway if not present in binary.
164          * useful for TLS in static programs. */
165         if (ei->phdr == -1) {
166                 uintptr_t filestart = ROUNDDOWN(e_phoff, PGSIZE);
167                 uintptr_t filesz = e_phoff + (e_phnum * phsz) - filestart;
168                 void *phdr_addr = do_mmap(p, 0, filesz, PROT_READ | PROT_WRITE,
169                                           MAP_PRIVATE, f, filestart);
170                 if (phdr_addr == MAP_FAILED)
171                         goto fail;
172                 ei->phdr = (long)phdr_addr + e_phoff;
173         }
174         ei->entry = elf_field(elfhdr, e_entry) + pgoffset*PGSIZE;
175         ei->phnum = e_phnum;
176         ei->elf64 = elf64;
177         ret = 0;
178         goto out;
179 fail:
180         printk("[kernel] Load failed during loadelf of file %s!\n", file_name(f));
181 out:
182         if (phdrs)
183                 kfree(phdrs);
184         current = cur_proc;
185         return ret;
186 }
187
188 int load_elf(struct proc* p, struct file* f)
189 {
190         elf_info_t ei, interp_ei;
191         if (load_one_elf(p, f, 0, &ei, FALSE))
192                 return -1;
193
194         if (ei.dynamic) {
195                 struct file *interp = do_file_open(ei.interp, 0, 0);
196                 if (!interp)
197                         return -1;
198                 /* Load dynamic linker one page into the address space */
199                 int error = load_one_elf(p, interp, 1, &interp_ei, TRUE);
200                 kref_put(&interp->f_kref);
201                 if (error)
202                         return -1;
203         }
204
205         // fill in auxiliary info for dynamic linker/runtime
206         elf_aux_t auxp[] = {{ELF_AUX_PHDR, ei.phdr},
207                             {ELF_AUX_PHENT, sizeof(proghdr32_t)},
208                             {ELF_AUX_PHNUM, ei.phnum},
209                             {ELF_AUX_ENTRY, ei.entry},
210                             #ifdef __sparc_v8__
211                             {ELF_AUX_HWCAP, ELF_HWCAP_SPARC_FLUSH},
212                             #endif
213                             {0, 0}};
214
215         // put auxp after argv, envp in procinfo
216         int auxp_pos = -1;
217         for (int i = 0, zeros = 0; i < PROCINFO_MAX_ARGP; i++)
218                 if (p->procinfo->argp[i] == NULL)
219                         if (++zeros == 2)
220                                 auxp_pos = i + 1;
221         if (auxp_pos == -1 ||
222             auxp_pos + sizeof(auxp) / sizeof(char*) >= PROCINFO_MAX_ARGP)
223                 return -1;
224         memcpy(p->procinfo->argp+auxp_pos,auxp,sizeof(auxp));
225
226         uintptr_t core0_entry = ei.dynamic ? interp_ei.entry : ei.entry;
227         proc_init_trapframe(&p->env_tf,0,core0_entry,USTACKTOP);
228         p->env_entry = ei.entry;
229
230         int flags = MAP_FIXED | MAP_ANONYMOUS;
231         #ifdef __sparc_v8__
232         flags |= MAP_POPULATE; // SPARC stacks must be mapped in
233         #endif
234         uintptr_t stacksz = USTACK_NUM_PAGES*PGSIZE;
235         if (do_mmap(p, USTACKTOP-stacksz, stacksz, PROT_READ | PROT_WRITE,
236                     flags, NULL, 0) == MAP_FAILED)
237                 return -1;
238
239         // Set the heap bottom and top to just past where the text 
240         // region has been loaded
241         p->heap_top = (void*)ei.highest_addr;
242         p->procinfo->heap_bottom = p->heap_top;
243
244         return 0;
245 }
246