Merge branch 'master' of ssh://waterman@scm.millennium.berkeley.edu/project/cs/radlab...
[akaros.git] / kern / src / env.c
1 /* See COPYRIGHT for copyright information. */
2
3 #ifdef __SHARC__
4 #pragma nosharc
5 #endif
6
7 #include <arch/arch.h>
8 #include <arch/mmu.h>
9 #include <arch/bitmask.h>
10 #include <elf.h>
11 #include <smp.h>
12
13 #include <atomic.h>
14 #include <string.h>
15 #include <assert.h>
16 #include <process.h>
17 #include <pmap.h>
18 #include <trap.h>
19 #include <monitor.h>
20 #include <manager.h>
21 #include <stdio.h>
22 #include <schedule.h>
23 #include <kmalloc.h>
24
25 #include <ros/syscall.h>
26 #include <ros/error.h>
27
28 atomic_t num_envs;
29
30 // Initialize the kernel virtual memory layout for environment e.
31 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
32 // and initialize the kernel portion of the new environment's address space.
33 // Do NOT (yet) map anything into the user portion
34 // of the environment's virtual address space.
35 //
36 // Returns 0 on success, < 0 on error.  Errors include:
37 //      -ENOMEM if page directory or table could not be allocated.
38 //
39 int env_setup_vm(env_t *e)
40 WRITES(e->env_pgdir, e->env_cr3, e->env_procinfo, e->env_procdata)
41 {
42         int i, r;
43         page_t *pgdir = NULL;
44         page_t *pginfo[PROCINFO_NUM_PAGES] = {NULL};
45         page_t *pgdata[PROCDATA_NUM_PAGES] = {NULL};
46         static page_t * RO shared_page = 0;
47
48         /*
49          * First, allocate a page for the pgdir of this process and up
50          * its reference count since this will never be done elsewhere
51          */
52         r = kpage_alloc(&pgdir);
53         if(r < 0) return r;
54
55         /*
56          * Next, set up the e->env_pgdir and e->env_cr3 pointers to point
57          * to this newly allocated page and clear its contents
58          */
59         memset(page2kva(pgdir), 0, PGSIZE);
60         e->env_pgdir = (pde_t *COUNT(NPDENTRIES)) TC(page2kva(pgdir));
61         e->env_cr3 =   (physaddr_t) TC(page2pa(pgdir));
62
63         /*
64          * Now start filling in the pgdir with mappings required by all newly
65          * created address spaces
66          */
67
68         // Map in the kernel to the top of every address space
69         // should be able to do this so long as boot_pgdir never has
70         // anything put below UTOP
71         // TODO check on this!  had a nasty bug because of it
72         // this is a bit wonky, since if it's not PGSIZE, lots of other things are
73         // screwed up...
74         memcpy(e->env_pgdir, boot_pgdir, NPDENTRIES*sizeof(pde_t));
75
76         // VPT and UVPT map the env's own page table, with
77         // different permissions.
78         e->env_pgdir[PDX(VPT)]  = PTE(LA2PPN(e->env_cr3), PTE_P | PTE_KERN_RW);
79         e->env_pgdir[PDX(UVPT)] = PTE(LA2PPN(e->env_cr3), PTE_P | PTE_USER_RO);
80
81         /*
82          * Now allocate and insert all pages required for the shared
83          * procinfo structure into the page table
84          */
85         for(int i=0; i<PROCINFO_NUM_PAGES; i++) {
86                 if(upage_alloc(e, &pginfo[i],1) < 0)
87                         goto env_setup_vm_error;
88                 if(page_insert(e->env_pgdir, pginfo[i], (void*SNT)(UINFO + i*PGSIZE),
89                                PTE_USER_RO) < 0)
90                         goto env_setup_vm_error;
91         }
92
93         /*
94          * Now allocate and insert all pages required for the shared
95          * procdata structure into the page table
96          */
97         for(int i=0; i<PROCDATA_NUM_PAGES; i++) {
98                 if(upage_alloc(e, &pgdata[i],1) < 0)
99                         goto env_setup_vm_error;
100                 if(page_insert(e->env_pgdir, pgdata[i], (void*SNT)(UDATA + i*PGSIZE),
101                                PTE_USER_RW) < 0)
102                         goto env_setup_vm_error;
103         }
104
105         /*
106          * Now, set e->env_procinfo, and e->env_procdata to point to
107          * the proper pages just allocated and clear them out.
108          */
109         e->env_procinfo = (procinfo_t *SAFE) TC(page2kva(pginfo[0]));
110         e->env_procdata = (procdata_t *SAFE) TC(page2kva(pgdata[0]));
111
112         /* Finally, set up the Global Shared Data page for all processes.
113          * Can't be trusted, but still very useful at this stage for us.
114          * Consider removing when we have real processes.
115          * (TODO).  Note the page is alloced only the first time through
116          */
117         if (!shared_page) {
118                 if(upage_alloc(e, &shared_page,1) < 0)
119                         goto env_setup_vm_error;
120                 // Up it, so it never goes away.  One per user, plus one from page_alloc
121                 // This is necessary, since it's in the per-process range of memory that
122                 // gets freed during page_free.
123                 page_incref(shared_page);
124         }
125
126         // Inserted into every process's address space at UGDATA
127         if(page_insert(e->env_pgdir, shared_page, (void*SNT)UGDATA, PTE_USER_RW) < 0)
128                 goto env_setup_vm_error;
129
130         return 0;
131
132 env_setup_vm_error:
133         page_free(shared_page);
134         for(int i=0; i< PROCDATA_NUM_PAGES; i++) {
135                 page_free(pgdata[i]);
136         }
137         for(int i=0; i< PROCINFO_NUM_PAGES; i++) {
138                 page_free(pginfo[i]);
139         }
140         env_user_mem_free(e);
141         page_free(pgdir);
142         return -ENOMEM;
143 }
144
145 // Allocate len bytes of physical memory for environment env,
146 // and map it at virtual address va in the environment's address space.
147 // Pages are zeroed by upage_alloc.
148 // Pages should be writable by user and kernel.
149 // Panic if any allocation attempt fails.
150 //
151 void
152 env_segment_alloc(env_t *e, void *SNT va, size_t len)
153 {
154         void *SNT start, *SNT end;
155         size_t num_pages;
156         int i, r;
157         page_t *page;
158         pte_t *pte;
159
160         start = ROUNDDOWN(va, PGSIZE);
161         end = ROUNDUP(va + len, PGSIZE);
162         if (start >= end)
163                 panic("Wrap-around in memory allocation addresses!");
164         if ((uintptr_t)end > UTOP)
165                 panic("Attempting to map above UTOP!");
166         num_pages = LA2PPN(end - start);
167
168         for (i = 0; i < num_pages; i++, start += PGSIZE) {
169                 // skip if a page is already mapped.  yes, page_insert will page_remove
170                 // whatever page was already there, but if we are seg allocing adjacent
171                 // regions, we don't want to destroy that old mapping/page
172                 // though later on we are told we can ignore this...
173                 pte = pgdir_walk(e->env_pgdir, start, 0);
174                 if (pte && *pte & PTE_P)
175                         continue;
176                 if ((r = upage_alloc(e, &page, 1)) < 0)
177                         panic("env_segment_alloc: %e", r);
178                 page_insert(e->env_pgdir, page, start, PTE_USER_RW);
179         }
180 }
181
182 void
183 env_segment_free(env_t *e, void *SNT va, size_t len)
184 {
185         void *SNT start, *SNT end;
186         size_t num_pages;
187         page_t *page;
188         pte_t *pte;
189
190         // Round this up this time so we don't free the page that va is actually on
191         start = ROUNDUP(va, PGSIZE);
192         end = ROUNDUP(va + len, PGSIZE);
193         if (start >= end)
194                 panic("Wrap-around in memory free addresses!");
195         if ((uintptr_t)end > UTOP)
196                 panic("Attempting to unmap above UTOP!");
197         // page_insert/pgdir_walk alloc a page and read/write to it via its address
198         // starting from pgdir (e's), so we need to be using e's pgdir
199         assert(e->env_cr3 == rcr3());
200         num_pages = LA2PPN(end - start);
201
202         for (int i = 0; i < num_pages; i++, start += PGSIZE) {
203                 // skip if a page is already unmapped. 
204                 pte = pgdir_walk(e->env_pgdir, start, 0);
205                 if (pte && *pte & PTE_P)
206                         page_remove(e->env_pgdir,start);
207         }
208 }
209
210 // this helper function handles all cases of copying to/from user/kernel
211 // or between two users.
212 static error_t load_icode_memcpy(struct proc *dest_p, struct proc *src_p,
213                                  void* dest, const void* src, size_t len)
214 {
215         if(src < (void*)UTOP)
216         {
217                 if(src_p == NULL)
218                         return -EFAULT;
219
220                 if(dest_p == NULL)
221                         return memcpy_from_user(src_p, dest, src, len);
222                 else
223                 {
224                         // TODO: do something more elegant & faster here.
225                         // e.g. a memcpy_from_user_to_user
226                         uint8_t kbuf[1024];
227                         while(len > 0)
228                         {
229                                 size_t thislen = MIN(len,sizeof(kbuf));
230                                 if (memcpy_from_user(src_p, kbuf, src, thislen))
231                                         return -EFAULT;
232                                 if (memcpy_to_user(dest_p, dest, kbuf, thislen))
233                                         panic("destination env isn't mapped!");
234                                 len -= thislen;
235                                 src += thislen;
236                                 dest += thislen;
237                         }
238                         return ESUCCESS;
239                 }
240
241         }
242         else
243         {
244                 if(src_p != NULL)
245                         return -EFAULT;
246
247                 if(dest_p == NULL)
248                         memcpy(dest, src, len);
249                 else if(memcpy_to_user(dest_p, dest, src, len))
250                         panic("destination env isn't mapped!");
251
252                 return ESUCCESS;
253         }
254 }
255
256 //
257 // Set up the initial program binary, stack, and processor flags
258 // for a user process.
259 //
260 // This function loads all loadable segments from the ELF binary image
261 // into the environment's user memory, starting at the appropriate
262 // virtual addresses indicated in the ELF program header.
263 // At the same time it clears to zero any portions of these segments
264 // that are marked in the program header as being mapped
265 // but not actually present in the ELF file - i.e., the program's bss section.
266 //
267 // Finally, this function maps one page for the program's initial stack.
268 static void* load_icode(env_t *SAFE e, env_t* binary_env,
269                         uint8_t *COUNT(size) binary, size_t size)
270 {
271         // asw: copy the headers because they might not be aligned.
272         elf_t elfhdr;
273         proghdr_t phdr;
274         void* _end = 0;
275
276         assert(load_icode_memcpy(NULL,binary_env,&elfhdr, binary,
277                                  sizeof(elfhdr)) == ESUCCESS);
278
279         int i, r;
280
281         // is this an elf?
282         assert(elfhdr.e_magic == ELF_MAGIC);
283         // make sure we have proghdrs to load
284         assert(elfhdr.e_phnum);
285
286         // TODO: how do we do a runtime COUNT?
287         {TRUSTEDBLOCK // zra: TRUSTEDBLOCK until validation is done.
288         for (i = 0; i < elfhdr.e_phnum; i++) {
289                 // copy phdr to kernel mem
290                 assert(load_icode_memcpy(NULL,binary_env,&phdr, binary + elfhdr.e_phoff + i*sizeof(phdr), sizeof(phdr)) == ESUCCESS);
291
292                 if (phdr.p_type != ELF_PROG_LOAD)
293                         continue;
294                 // TODO: validate elf header fields!
295                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
296                 // this, there will be issues with overlapping sections
297                 _end = MAX(_end, (void*)(phdr.p_va + phdr.p_memsz));
298                 env_segment_alloc(e, (void*SNT)phdr.p_va, phdr.p_memsz);
299
300                 // copy section to user mem
301                 assert(load_icode_memcpy(e,binary_env,(void*)phdr.p_va, binary + phdr.p_offset, phdr.p_filesz) == ESUCCESS);
302
303                 //no need to memclr the remaining p_memsz-p_filesz bytes
304                 //because upage_alloc'd pages are zeroed
305         }}
306
307         proc_set_program_counter(&e->env_tf, elfhdr.e_entry);
308         e->env_entry = elfhdr.e_entry;
309
310         // Now map USTACK_NUM_PAGES pages for the program's initial stack
311         // starting at virtual address USTACKTOP - USTACK_NUM_PAGES*PGSIZE.
312         env_segment_alloc(e, (void*SNT)(USTACKTOP - USTACK_NUM_PAGES*PGSIZE), 
313                           USTACK_NUM_PAGES*PGSIZE);
314         
315         return _end;
316 }
317
318 void env_load_icode(env_t* e, env_t* binary_env, uint8_t* binary, size_t size)
319 {
320         /* Load the binary and set the current locations of the elf segments.
321          * All end-of-segment pointers are page aligned (invariant) */
322         e->heap_bottom = load_icode(e, binary_env, binary, size);
323         e->heap_top = e->heap_bottom;
324 }
325
326 #define PER_CPU_THING(type,name)\
327 type SLOCKED(name##_lock) * RWPROTECT name;\
328 type SLOCKED(name##_lock) *\
329 (get_per_cpu_##name)()\
330 {\
331         { R_PERMITTED(global(name))\
332                 return &name[core_id()];\
333         }\
334 }
335
336 /* This is the top-half of an interrupt handler, where the bottom half is
337  * proc_run (which never returns).  Just add it to the delayed work queue,
338  * which (incidentally) can only hold one item at this point.
339  *
340  * Note this is rather old, and meant to run a RUNNABLE_S on a worker core.
341  */
342 #ifdef __IVY__
343 void run_env_handler(trapframe_t *tf, env_t * data)
344 #else
345 void run_env_handler(trapframe_t *tf, void * data)
346 #endif
347 {
348         assert(data);
349         struct work TP(env_t *) job;
350         struct workqueue TP(env_t *) *CT(1) workqueue =
351             TC(&per_cpu_info[core_id()].workqueue);
352         // this doesn't work, and making it a TP(env_t) is wrong
353         // zra: When you want to use other types, let me know, and I can help
354     // make something that Ivy is happy with. 
355 #ifdef __IVY__
356         job.func = proc_run;
357 #else
358         job.func = (func_t)proc_run;
359 #endif
360         job.data = data;
361         if (enqueue_work(workqueue, &job))
362                 panic("Failed to enqueue work!");
363 }