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