Async syscall handling
[akaros.git] / kern / env.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 #pragma nodeputy
4 #endif
5
6 #include <inc/x86.h>
7 #include <inc/mmu.h>
8 #include <inc/error.h>
9 #include <inc/string.h>
10 #include <inc/assert.h>
11 #include <inc/elf.h>
12 #include <inc/syscall.h>
13
14 #include <kern/env.h>
15 #include <kern/pmap.h>
16 #include <kern/trap.h>
17 #include <kern/monitor.h>
18 #include <kern/apic.h>
19 #include <kern/smp.h>
20
21 env_t *envs = NULL;             // All environments
22 env_t *curenv = NULL;           // The current env
23 static env_list_t env_free_list;        // Free list
24
25 #define ENVGENSHIFT     12              // >= LOGNENV
26
27 //
28 // Converts an envid to an env pointer.
29 //
30 // RETURNS
31 //   0 on success, -E_BAD_ENV on error.
32 //   On success, sets *env_store to the environment.
33 //   On error, sets *env_store to NULL.
34 //
35 int
36 envid2env(envid_t envid, env_t **env_store, bool checkperm)
37 {
38         env_t *e;
39
40         // If envid is zero, return the current environment.
41         if (envid == 0) {
42                 *env_store = curenv;
43                 return 0;
44         }
45
46         // Look up the Env structure via the index part of the envid,
47         // then check the env_id field in that env_t
48         // to ensure that the envid is not stale
49         // (i.e., does not refer to a _previous_ environment
50         // that used the same slot in the envs[] array).
51         e = &envs[ENVX(envid)];
52         if (e->env_status == ENV_FREE || e->env_id != envid) {
53                 *env_store = 0;
54                 return -E_BAD_ENV;
55         }
56
57         // Check that the calling environment has legitimate permission
58         // to manipulate the specified environment.
59         // If checkperm is set, the specified environment
60         // must be either the current environment
61         // or an immediate child of the current environment.
62         if (checkperm && e != curenv && e->env_parent_id != curenv->env_id) {
63                 *env_store = 0;
64                 return -E_BAD_ENV;
65         }
66
67         *env_store = e;
68         return 0;
69 }
70
71 //
72 // Mark all environments in 'envs' as free, set their env_ids to 0,
73 // and insert them into the env_free_list.
74 // Insert in reverse order, so that the first call to env_alloc()
75 // returns envs[0].
76 //
77 void
78 env_init(void)
79 {
80         int i;
81         LIST_INIT(&env_free_list);
82         for (i = NENV-1; i >= 0; i--) {
83                 // these should already be set from when i memset'd the array to 0
84                 envs[i].env_status = ENV_FREE;
85                 envs[i].env_id = 0;
86                 LIST_INSERT_HEAD(&env_free_list, &envs[i], env_link);
87         }
88 }
89
90 //
91 // Initialize the kernel virtual memory layout for environment e.
92 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
93 // and initialize the kernel portion of the new environment's address space.
94 // Do NOT (yet) map anything into the user portion
95 // of the environment's virtual address space.
96 //
97 // Returns 0 on success, < 0 on error.  Errors include:
98 //      -E_NO_MEM if page directory or table could not be allocated.
99 //
100 static int
101 env_setup_vm(env_t *e)
102 {
103         int i, r;
104         page_t *pgdir = NULL, *pginfo = NULL, *pgdata = NULL;
105
106         // Allocate pages for the page directory, shared info, and shared data pages
107         r = page_alloc(&pgdir);
108         r = page_alloc(&pginfo);
109         r = page_alloc(&pgdata);
110         if (r < 0) {
111                 page_free(pgdir);
112                 page_free(pginfo);
113                 return r;
114         }
115
116         // Now, set e->env_pgdir and e->env_cr3,
117         // and initialize the page directory.
118         //
119         // Hint:
120         //    - The VA space of all envs is identical above UTOP
121         //      (except at VPT and UVPT, which we've set below).
122         //      (and not for UINFO either)
123         //      See inc/memlayout.h for permissions and layout.
124         //      Can you use boot_pgdir as a template?  Hint: Yes.
125         //      (Make sure you got the permissions right in Lab 2.)
126         //    - The initial VA below UTOP is empty.
127         //    - You do not need to make any more calls to page_alloc.
128         //    - Note: pp_ref is not maintained for most physical pages
129         //      mapped above UTOP -- but you do need to increment
130         //      env_pgdir's pp_ref!
131
132         // need to up pgdir's reference, since it will never be done elsewhere
133         pgdir->pp_ref++;
134         e->env_pgdir = page2kva(pgdir);
135         e->env_cr3 = page2pa(pgdir);
136         e->env_procinfo = page2kva(pginfo);
137         e->env_procdata = page2kva(pgdata);
138
139         memset(e->env_pgdir, 0, PGSIZE);
140         memset(e->env_procinfo, 0, PGSIZE);
141         memset(e->env_procdata, 0, PGSIZE);
142
143         // Initialize the generic syscall ring buffer
144         SHARED_RING_INIT((syscall_sring_t*)e->env_procdata);
145         // Initialize the backend of the ring buffer
146         BACK_RING_INIT(&e->env_sysbackring, (syscall_sring_t*)e->env_procdata, PGSIZE);
147
148         // should be able to do this so long as boot_pgdir never has
149         // anything put below UTOP
150         memcpy(e->env_pgdir, boot_pgdir, PGSIZE);
151
152         // something like this.  TODO, if you want
153         //memcpy(&e->env_pgdir[PDX(UTOP)], &boot_pgdir[PDX(UTOP)], PGSIZE - PDX(UTOP));
154         // check with
155         // assert(memcmp(e->env_pgdir, boot_pgdir, PGSIZE) == 0);
156
157         // VPT and UVPT map the env's own page table, with
158         // different permissions.
159         e->env_pgdir[PDX(VPT)]  = e->env_cr3 | PTE_P | PTE_W;
160         e->env_pgdir[PDX(UVPT)] = e->env_cr3 | PTE_P | PTE_U;
161
162         // Insert the per-process info and data pages into this process's pgdir
163         // I don't want to do these two pages later (like with the stack), since
164         // the kernel wants to keep pointers to it easily.
165         // Could place all of this with a function that maps a shared memory page
166         // that can work between any two address spaces or something.
167         r = page_insert(e->env_pgdir, pginfo, (void*)UINFO, PTE_U);
168         r = page_insert(e->env_pgdir, pgdata, (void*)UDATA, PTE_U | PTE_W);
169         if (r < 0) {
170                 // note that we can't currently deallocate the pages created by
171                 // pgdir_walk (inside insert).  should be able to gather them up when
172                 // we destroy environments and their page tables.
173                 page_free(pgdir);
174                 page_free(pginfo);
175                 page_free(pgdata);
176                 return r;
177         }
178         return 0;
179 }
180
181 //
182 // Allocates and initializes a new environment.
183 // On success, the new environment is stored in *newenv_store.
184 //
185 // Returns 0 on success, < 0 on failure.  Errors include:
186 //      -E_NO_FREE_ENV if all NENVS environments are allocated
187 //      -E_NO_MEM on memory exhaustion
188 //
189 int
190 env_alloc(env_t **newenv_store, envid_t parent_id)
191 {
192         int32_t generation;
193         int r;
194         env_t *e;
195
196         if (!(e = LIST_FIRST(&env_free_list)))
197                 return -E_NO_FREE_ENV;
198
199         // Allocate and set up the page directory for this environment.
200         if ((r = env_setup_vm(e)) < 0)
201                 return r;
202
203         // Generate an env_id for this environment.
204         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
205         if (generation <= 0)    // Don't create a negative env_id.
206                 generation = 1 << ENVGENSHIFT;
207         e->env_id = generation | (e - envs);
208
209         // Set the basic status variables.
210         e->env_parent_id = parent_id;
211         e->env_status = ENV_RUNNABLE;
212         e->env_runs = 0;
213
214         // Clear out all the saved register state,
215         // to prevent the register values
216         // of a prior environment inhabiting this Env structure
217         // from "leaking" into our new environment.
218         memset(&e->env_tf, 0, sizeof(e->env_tf));
219
220         // Set up appropriate initial values for the segment registers.
221         // GD_UD is the user data segment selector in the GDT, and
222         // GD_UT is the user text segment selector (see inc/memlayout.h).
223         // The low 2 bits of each segment register contains the
224         // Requestor Privilege Level (RPL); 3 means user mode.
225         e->env_tf.tf_ds = GD_UD | 3;
226         e->env_tf.tf_es = GD_UD | 3;
227         e->env_tf.tf_ss = GD_UD | 3;
228         e->env_tf.tf_esp = USTACKTOP;
229         e->env_tf.tf_cs = GD_UT | 3;
230         // You will set e->env_tf.tf_eip later.
231         // set the env's EFLAGSs to have interrupts enabled
232         e->env_tf.tf_eflags |= 0x00000200; // bit 9 is the interrupts-enabled
233
234         // commit the allocation
235         LIST_REMOVE(e, env_link);
236         *newenv_store = e;
237
238         // TODO: for now, the only info at procinfo is this env's struct
239         // note that we need to copy this over every time we make a change to env
240         // that we want userspace to see.  also note that we don't even want to
241         // show them all of env, only specific things like PID, PPID, etc
242         memcpy(e->env_procinfo, e, sizeof(env_t));
243
244         cprintf("[%08x] new env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
245         return 0;
246 }
247
248 //
249 // Allocate len bytes of physical memory for environment env,
250 // and map it at virtual address va in the environment's address space.
251 // Does not zero or otherwise initialize the mapped pages in any way.
252 // Pages should be writable by user and kernel.
253 // Panic if any allocation attempt fails.
254 //
255 static void
256 segment_alloc(env_t *e, void *va, size_t len)
257 {
258         void *start, *end;
259         size_t num_pages;
260         int i, r;
261         page_t *page;
262         pte_t *pte;
263
264         start = ROUNDDOWN(va, PGSIZE);
265         end = ROUNDUP(va + len, PGSIZE);
266         if (start >= end)
267                 panic("Wrap-around in memory allocation addresses!");
268         if ((uintptr_t)end > UTOP)
269                 panic("Attempting to map above UTOP!");
270         // page_insert/pgdir_walk alloc a page and read/write to it via its address
271         // starting from pgdir (e's), so we need to be using e's pgdir
272         assert(e->env_cr3 == rcr3());
273         num_pages = PPN(end - start);
274         for (i = 0; i < num_pages; i++, start += PGSIZE) {
275                 // skip if a page is already mapped.  yes, page_insert will page_remove
276                 // whatever page was already there, but if we are seg allocing adjacent
277                 // regions, we don't want to destroy that old mapping/page
278                 // though later on we are told we can ignore this...
279                 pte = pgdir_walk(e->env_pgdir, start, 0);
280                 if (pte && *pte & PTE_P)
281                         continue;
282                 if ((r = page_alloc(&page)) < 0)
283                         panic("segment_alloc: %e", r);
284                 page_insert(e->env_pgdir, page, start, PTE_U | PTE_W);
285         }
286 }
287
288 //
289 // Set up the initial program binary, stack, and processor flags
290 // for a user process.
291 // This function is ONLY called during kernel initialization,
292 // before running the first user-mode environment.
293 //
294 // This function loads all loadable segments from the ELF binary image
295 // into the environment's user memory, starting at the appropriate
296 // virtual addresses indicated in the ELF program header.
297 // At the same time it clears to zero any portions of these segments
298 // that are marked in the program header as being mapped
299 // but not actually present in the ELF file - i.e., the program's bss section.
300 //
301 // All this is very similar to what our boot loader does, except the boot
302 // loader also needs to read the code from disk.  Take a look at
303 // boot/main.c to get ideas.
304 //
305 // Finally, this function maps one page for the program's initial stack.
306 //
307 // load_icode panics if it encounters problems.
308 //  - How might load_icode fail?  What might be wrong with the given input?
309 //
310 static void
311 load_icode(env_t *e, uint8_t *binary, size_t size)
312 {
313         // Hints:
314         //  Load each program segment into virtual memory
315         //  at the address specified in the ELF section header.
316         //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
317         //  Each segment's virtual address can be found in ph->p_va
318         //  and its size in memory can be found in ph->p_memsz.
319         //  The ph->p_filesz bytes from the ELF binary, starting at
320         //  'binary + ph->p_offset', should be copied to virtual address
321         //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
322         //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
323         //  Use functions from the previous lab to allocate and map pages.
324         //
325         //  All page protection bits should be user read/write for now.
326         //  ELF segments are not necessarily page-aligned, but you can
327         //  assume for this function that no two segments will touch
328         //  the same virtual page.
329         //
330         //  You may find a function like segment_alloc useful.
331         //
332         //  Loading the segments is much simpler if you can move data
333         //  directly into the virtual addresses stored in the ELF binary.
334         //  So which page directory should be in force during
335         //  this function?
336         //
337         // Hint:
338         //  You must also do something with the program's entry point,
339         //  to make sure that the environment starts executing there.
340         //  What?  (See env_run() and env_pop_tf() below.)
341
342         elf_t *elfhdr = (elf_t *)binary;
343         int i, r;
344
345         // is this an elf?
346         assert(elfhdr->e_magic == ELF_MAGIC);
347         // make sure we have proghdrs to load
348         assert(elfhdr->e_phnum);
349
350         // to actually access any pages alloc'd for this environment, we
351         // need to have the hardware use this environment's page tables.
352         // we can use e's tables as long as we want, since it has the same
353         // mappings for the kernel as does boot_pgdir
354         lcr3(e->env_cr3);
355
356         proghdr_t *phdr = (proghdr_t *)(binary + elfhdr->e_phoff);
357         for (i = 0; i < elfhdr->e_phnum; i++, phdr++) {
358                 if (phdr->p_type != ELF_PROG_LOAD)
359                         continue;
360                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
361                 // this, there will be issues with overlapping sections
362                 segment_alloc(e, (void*)phdr->p_va, phdr->p_memsz);
363                 memcpy((void*)phdr->p_va, binary + phdr->p_offset, phdr->p_filesz);
364                 memset((void*)phdr->p_va + phdr->p_filesz, 0, phdr->p_memsz - phdr->p_filesz);
365         }
366
367         e->env_tf.tf_eip = elfhdr->e_entry;
368
369         // Now map one page for the program's initial stack
370         // at virtual address USTACKTOP - PGSIZE.
371
372         segment_alloc(e, (void*)(USTACKTOP - PGSIZE), PGSIZE);
373 }
374
375 //
376 // Allocates a new env and loads the named elf binary into it.
377 // This function is ONLY called during kernel initialization,
378 // before running the first user-mode environment.
379 // The new env's parent ID is set to 0.
380 //
381 // Where does the result go?
382 // By convention, envs[0] is the first environment allocated, so
383 // whoever calls env_create simply looks for the newly created
384 // environment there.
385 void
386 env_create(uint8_t *binary, size_t size)
387 {
388         env_t *e;
389         int r;
390
391         if ((r = env_alloc(&e, 0)) < 0)
392                 panic("env_create: %e", r);
393         load_icode(e, binary, size);
394 }
395
396 //
397 // Frees env e and all memory it uses.
398 //
399 void
400 env_free(env_t *e)
401 {
402         pte_t *pt;
403         uint32_t pdeno, pteno;
404         physaddr_t pa;
405
406         // Note the environment's demise.
407         cprintf("[%08x] free env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
408
409         // Flush all mapped pages in the user portion of the address space
410         static_assert(UTOP % PTSIZE == 0);
411         for (pdeno = 0; pdeno < PDX(UTOP); pdeno++) {
412
413                 // only look at mapped page tables
414                 if (!(e->env_pgdir[pdeno] & PTE_P))
415                         continue;
416
417                 // find the pa and va of the page table
418                 pa = PTE_ADDR(e->env_pgdir[pdeno]);
419                 pt = (pte_t*) KADDR(pa);
420
421                 // unmap all PTEs in this page table
422                 for (pteno = 0; pteno <= PTX(~0); pteno++) {
423                         if (pt[pteno] & PTE_P)
424                                 page_remove(e->env_pgdir, PGADDR(pdeno, pteno, 0));
425                 }
426
427                 // free the page table itself
428                 e->env_pgdir[pdeno] = 0;
429                 page_decref(pa2page(pa));
430         }
431
432         // need a known good pgdir before releasing the old one
433         lcr3(boot_cr3);
434
435         // free the page directory
436         pa = e->env_cr3;
437         e->env_pgdir = 0;
438         e->env_cr3 = 0;
439         page_decref(pa2page(pa));
440
441         // return the environment to the free list
442         e->env_status = ENV_FREE;
443         LIST_INSERT_HEAD(&env_free_list, e, env_link);
444 }
445
446 //
447 // Frees environment e.
448 // If e was the current env, then runs a new environment (and does not return
449 // to the caller).
450 //
451 void
452 env_destroy(env_t *e)
453 {
454         env_free(e);
455
456         // for old envs that die on user cores.  since env run never returns, cores
457         // never get back to their old hlt/relaxed/spin state, so we need to force
458         // them back to an idle function.
459         uint32_t id = lapic_get_id();
460         if (id) {
461                 smp_idle();
462                 panic("should never see me");
463         }
464         // else we're core 0 and can do the usual
465
466         // ugly, but for now just linearly search through all possible
467         // environments for a runnable one.
468         for (int i = 0; i < NENV; i++) {
469                 e = &envs[ENVX(i)];
470                 if (e && e->env_status == ENV_RUNNABLE)
471                         env_run(e);
472         }
473         cprintf("Destroyed the only environment - nothing more to do!\n");
474         while (1)
475                 monitor(NULL);
476 }
477
478
479 //
480 // Restores the register values in the Trapframe with the 'iret' instruction.
481 // This exits the kernel and starts executing some environment's code.
482 // This function does not return.
483 //
484 void
485 env_pop_tf(trapframe_t *tf)
486 {
487         __asm __volatile("movl %0,%%esp\n"
488                 "\tpopal\n"
489                 "\tpopl %%es\n"
490                 "\tpopl %%ds\n"
491                 "\taddl $0x8,%%esp\n" /* skip tf_trapno and tf_errcode */
492                 "\tiret"
493                 : : "g" (tf) : "memory");
494         panic("iret failed");  /* mostly to placate the compiler */
495 }
496
497 //
498 // Context switch from curenv to env e.
499 // Note: if this is the first call to env_run, curenv is NULL.
500 //  (This function does not return.)
501 //
502 void
503 env_run(env_t *e)
504 {
505         // Step 1: If this is a context switch (a new environment is running),
506         //         then set 'curenv' to the new environment,
507         //         update its 'env_runs' counter, and
508         //         and use lcr3() to switch to its address space.
509         // Step 2: Use env_pop_tf() to restore the environment's
510         //         registers and drop into user mode in the
511         //         environment.
512
513         // Hint: This function loads the new environment's state from
514         //      e->env_tf.  Go back through the code you wrote above
515         //      and make sure you have set the relevant parts of
516         //      e->env_tf to sensible values.
517
518                 // would set the curenv->env_status if we had more states
519         if (e != curenv) {
520                 curenv = e;
521                 e->env_runs++;
522                 lcr3(e->env_cr3);
523         }
524     env_pop_tf(&e->env_tf);
525 }
526