Reorganized the directory structure, placing newlib under user/parlib.
[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         return 0;
186 }
187
188 //
189 // Allocates and initializes a new environment.
190 // On success, the new environment is stored in *newenv_store.
191 //
192 // Returns 0 on success, < 0 on failure.  Errors include:
193 //      -E_NO_FREE_ENV if all NENVS environments are allocated
194 //      -E_NO_MEM on memory exhaustion
195 //
196 int
197 env_alloc(env_t **newenv_store, envid_t parent_id)
198 {
199         int32_t generation;
200         int r;
201         env_t *e;
202
203         if (!(e = LIST_FIRST(&env_free_list)))
204                 return -E_NO_FREE_ENV;
205         
206         memset((void*)e + sizeof(e->env_link), 0, sizeof(*e) - sizeof(e->env_link));
207
208         // Allocate and set up the page directory for this environment.
209         if ((r = env_setup_vm(e)) < 0)
210                 return r;
211
212         // Generate an env_id for this environment.
213         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
214         if (generation <= 0)    // Don't create a negative env_id.
215                 generation = 1 << ENVGENSHIFT;
216         e->env_id = generation | (e - envs);
217
218         // Set the basic status variables.
219         e->env_parent_id = parent_id;
220         e->env_status = ENV_RUNNABLE;
221         e->env_runs = 0;
222         e->env_refcnt = 1;
223
224         // Clear out all the saved register state,
225         // to prevent the register values
226         // of a prior environment inhabiting this Env structure
227         // from "leaking" into our new environment.
228         memset(&e->env_tf, 0, sizeof(e->env_tf));
229
230         // Set up appropriate initial values for the segment registers.
231         // GD_UD is the user data segment selector in the GDT, and
232         // GD_UT is the user text segment selector (see inc/memlayout.h).
233         // The low 2 bits of each segment register contains the
234         // Requestor Privilege Level (RPL); 3 means user mode.
235         e->env_tf.tf_ds = GD_UD | 3;
236         e->env_tf.tf_es = GD_UD | 3;
237         e->env_tf.tf_ss = GD_UD | 3;
238         e->env_tf.tf_esp = USTACKTOP;
239         e->env_tf.tf_cs = GD_UT | 3;
240         // You will set e->env_tf.tf_eip later.
241         // set the env's EFLAGSs to have interrupts enabled
242         e->env_tf.tf_eflags |= 0x00000200; // bit 9 is the interrupts-enabled
243
244         // commit the allocation
245         LIST_REMOVE(e, env_link);
246         *newenv_store = e;
247
248         e->env_tscfreq = system_timing.tsc_freq;
249         // TODO: for now, the only info at procinfo is this env's struct
250         // note that we need to copy this over every time we make a change to env
251         // that we want userspace to see.  also note that we don't even want to
252         // show them all of env, only specific things like PID, PPID, etc
253         memcpy(e->env_procinfo, e, sizeof(env_t));
254
255         env_t* curenv = curenvs[lapic_get_id()];
256
257         cprintf("[%08x] new env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
258         return 0;
259 }
260
261 //
262 // Allocate len bytes of physical memory for environment env,
263 // and map it at virtual address va in the environment's address space.
264 // Does not zero or otherwise initialize the mapped pages in any way.
265 // Pages should be writable by user and kernel.
266 // Panic if any allocation attempt fails.
267 //
268 static void
269 segment_alloc(env_t *e, void *va, size_t len)
270 {
271         void *start, *end;
272         size_t num_pages;
273         int i, r;
274         page_t *page;
275         pte_t *pte;
276
277         start = ROUNDDOWN(va, PGSIZE);
278         end = ROUNDUP(va + len, PGSIZE);
279         if (start >= end)
280                 panic("Wrap-around in memory allocation addresses!");
281         if ((uintptr_t)end > UTOP)
282                 panic("Attempting to map above UTOP!");
283         // page_insert/pgdir_walk alloc a page and read/write to it via its address
284         // starting from pgdir (e's), so we need to be using e's pgdir
285         assert(e->env_cr3 == rcr3());
286         num_pages = PPN(end - start);
287         for (i = 0; i < num_pages; i++, start += PGSIZE) {
288                 // skip if a page is already mapped.  yes, page_insert will page_remove
289                 // whatever page was already there, but if we are seg allocing adjacent
290                 // regions, we don't want to destroy that old mapping/page
291                 // though later on we are told we can ignore this...
292                 pte = pgdir_walk(e->env_pgdir, start, 0);
293                 if (pte && *pte & PTE_P)
294                         continue;
295                 if ((r = page_alloc(&page)) < 0)
296                         panic("segment_alloc: %e", r);
297                 page_insert(e->env_pgdir, page, start, PTE_U | PTE_W);
298         }
299 }
300
301 //
302 // Set up the initial program binary, stack, and processor flags
303 // for a user process.
304 // This function is ONLY called during kernel initialization,
305 // before running the first user-mode environment.
306 //
307 // This function loads all loadable segments from the ELF binary image
308 // into the environment's user memory, starting at the appropriate
309 // virtual addresses indicated in the ELF program header.
310 // At the same time it clears to zero any portions of these segments
311 // that are marked in the program header as being mapped
312 // but not actually present in the ELF file - i.e., the program's bss section.
313 //
314 // All this is very similar to what our boot loader does, except the boot
315 // loader also needs to read the code from disk.  Take a look at
316 // boot/main.c to get ideas.
317 //
318 // Finally, this function maps one page for the program's initial stack.
319 //
320 // load_icode panics if it encounters problems.
321 //  - How might load_icode fail?  What might be wrong with the given input?
322 //
323 static void
324 load_icode(env_t *e, uint8_t *binary, size_t size)
325 {
326         // Hints:
327         //  Load each program segment into virtual memory
328         //  at the address specified in the ELF section header.
329         //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
330         //  Each segment's virtual address can be found in ph->p_va
331         //  and its size in memory can be found in ph->p_memsz.
332         //  The ph->p_filesz bytes from the ELF binary, starting at
333         //  'binary + ph->p_offset', should be copied to virtual address
334         //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
335         //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
336         //  Use functions from the previous lab to allocate and map pages.
337         //
338         //  All page protection bits should be user read/write for now.
339         //  ELF segments are not necessarily page-aligned, but you can
340         //  assume for this function that no two segments will touch
341         //  the same virtual page.
342         //
343         //  You may find a function like segment_alloc useful.
344         //
345         //  Loading the segments is much simpler if you can move data
346         //  directly into the virtual addresses stored in the ELF binary.
347         //  So which page directory should be in force during
348         //  this function?
349         //
350         // Hint:
351         //  You must also do something with the program's entry point,
352         //  to make sure that the environment starts executing there.
353         //  What?  (See env_run() and env_pop_tf() below.)
354
355         elf_t *elfhdr = (elf_t *)binary;
356         int i, r;
357
358         // is this an elf?
359         assert(elfhdr->e_magic == ELF_MAGIC);
360         // make sure we have proghdrs to load
361         assert(elfhdr->e_phnum);
362
363         // to actually access any pages alloc'd for this environment, we
364         // need to have the hardware use this environment's page tables.
365         // we can use e's tables as long as we want, since it has the same
366         // mappings for the kernel as does boot_pgdir
367         lcr3(e->env_cr3);
368
369         proghdr_t *phdr = (proghdr_t *)(binary + elfhdr->e_phoff);
370         for (i = 0; i < elfhdr->e_phnum; i++, phdr++) {
371                 if (phdr->p_type != ELF_PROG_LOAD)
372                         continue;
373                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
374                 // this, there will be issues with overlapping sections
375                 segment_alloc(e, (void*)phdr->p_va, phdr->p_memsz);
376                 memcpy((void*)phdr->p_va, binary + phdr->p_offset, phdr->p_filesz);
377                 memset((void*)phdr->p_va + phdr->p_filesz, 0, phdr->p_memsz - phdr->p_filesz);
378         }
379
380         e->env_tf.tf_eip = elfhdr->e_entry;
381
382         // Now map one page for the program's initial stack
383         // at virtual address USTACKTOP - PGSIZE.
384
385         segment_alloc(e, (void*)(USTACKTOP - PGSIZE), PGSIZE);
386 }
387
388 //
389 // Allocates a new env and loads the named elf binary into it.
390 //
391 env_t* env_create(uint8_t *binary, size_t size)
392 {
393         env_t *e;
394         int r;
395
396         if ((r = env_alloc(&e, 0)) < 0)
397                 panic("env_create: %e", r);
398         load_icode(e, binary, size);
399         return e;
400 }
401
402 //
403 // Frees env e and all memory it uses.
404 //
405 void
406 env_free(env_t *e)
407 {
408         pte_t *pt;
409         uint32_t pdeno, pteno;
410         physaddr_t pa;
411
412         // Note the environment's demise.
413         env_t* curenv = curenvs[lapic_get_id()];
414         cprintf("[%08x] free env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
415
416         // Flush all mapped pages in the user portion of the address space
417         static_assert(UTOP % PTSIZE == 0);
418         for (pdeno = 0; pdeno < PDX(UTOP); pdeno++) {
419
420                 // only look at mapped page tables
421                 if (!(e->env_pgdir[pdeno] & PTE_P))
422                         continue;
423
424                 // find the pa and va of the page table
425                 pa = PTE_ADDR(e->env_pgdir[pdeno]);
426                 pt = (pte_t*) KADDR(pa);
427
428                 // unmap all PTEs in this page table
429                 for (pteno = 0; pteno <= PTX(~0); pteno++) {
430                         if (pt[pteno] & PTE_P)
431                                 page_remove(e->env_pgdir, PGADDR(pdeno, pteno, 0));
432                 }
433
434                 // free the page table itself
435                 e->env_pgdir[pdeno] = 0;
436                 page_decref(pa2page(pa));
437         }
438
439         // need a known good pgdir before releasing the old one
440         lcr3(boot_cr3);
441
442         // free the page directory
443         pa = e->env_cr3;
444         e->env_pgdir = 0;
445         e->env_cr3 = 0;
446         page_decref(pa2page(pa));
447
448         // return the environment to the free list
449         e->env_status = ENV_FREE;
450         LIST_INSERT_HEAD(&env_free_list, e, env_link);
451 }
452
453 /*
454  * This allows the kernel to keep this process around, in case it is being used
455  * in some asynchronous processing.
456  * The refcnt should always be greater than 0 for processes that aren't dying.
457  * When refcnt is 0, the process is dying and should not allow any more increfs.
458  * TODO: Make sure this is never called from an interrupt handler (irq_save)
459  */
460 error_t env_incref(env_t* e)
461 {
462         error_t retval = 0;
463         spin_lock(&e->lock);
464         if (e->env_refcnt)
465                 e->env_refcnt++;
466         else
467                 retval = E_BAD_ENV;
468         spin_unlock(&e->lock);
469         return retval;
470 }
471
472 /*
473  * When the kernel is done with a process, it decrements its reference count.
474  * When the count hits 0, no one is using it and it should be freed.
475  * env_destroy calls this.
476  * TODO: Make sure this is never called from an interrupt handler (irq_save)
477  */
478 void env_decref(env_t* e)
479 {
480         spin_lock(&e->lock);
481         e->env_refcnt--;
482         spin_unlock(&e->lock);
483         // if we hit 0, no one else will increment and we can check outside the lock
484         if (e->env_refcnt == 0)
485                 env_free(e);
486 }
487
488
489 //
490 // Frees environment e.
491 // If e was the current env, then runs a new environment (and does not return
492 // to the caller).
493 //
494 void
495 env_destroy(env_t *e)
496 {
497         // TODO: race condition with env statuses, esp when running / destroying
498         e->env_status = ENV_DYING;
499         env_decref(e);
500
501         // for old envs that die on user cores.  since env run never returns, cores
502         // never get back to their old hlt/relaxed/spin state, so we need to force
503         // them back to an idle function.
504         uint32_t id = lapic_get_id();
505         // There is no longer a curenv for this core. (TODO: Think about this.)
506         curenvs[id] = NULL;
507         if (id) {
508                 smp_idle();
509                 panic("should never see me");
510         }
511         // else we're core 0 and can do the usual
512
513         /* Instead of picking a new environment to run, or defaulting to the monitor
514          * like before, for now we'll hop into the manager() function, which
515          * dispatches jobs.  Note that for now we start the manager from the top,
516          * and not from where we left off the last time we called manager.  That
517          * would require us to save some context (and a stack to work on) here.
518          */
519         manager();
520         assert(0); // never get here
521
522         // ugly, but for now just linearly search through all possible
523         // environments for a runnable one.
524         for (int i = 0; i < NENV; i++) {
525                 e = &envs[ENVX(i)];
526                 // TODO: race here, if another core is just about to start this env.
527                 // Fix it by setting the status in something like env_dispatch when
528                 // we have multi-contexted processes
529                 if (e && e->env_status == ENV_RUNNABLE)
530                         env_run(e);
531         }
532         cprintf("Destroyed the only environment - nothing more to do!\n");
533         while (1)
534                 monitor(NULL);
535 }
536
537
538 //
539 // Restores the register values in the Trapframe with the 'iret' instruction.
540 // This exits the kernel and starts executing some environment's code.
541 // This function does not return.
542 //
543 void
544 env_pop_tf(trapframe_t *tf)
545 {
546         __asm __volatile("movl %0,%%esp\n"
547                 "\tpopal\n"
548                 "\tpopl %%es\n"
549                 "\tpopl %%ds\n"
550                 "\taddl $0x8,%%esp\n" /* skip tf_trapno and tf_errcode */
551                 "\tiret"
552                 : : "g" (tf) : "memory");
553         panic("iret failed");  /* mostly to placate the compiler */
554 }
555
556 //
557 // Context switch from curenv to env e.
558 // Note: if this is the first call to env_run, curenv is NULL.
559 //  (This function does not return.)
560 //
561 void
562 env_run(env_t *e)
563 {
564         // Step 1: If this is a context switch (a new environment is running),
565         //         then set 'curenv' to the new environment,
566         //         update its 'env_runs' counter, and
567         //         and use lcr3() to switch to its address space.
568         // Step 2: Use env_pop_tf() to restore the environment's
569         //         registers and drop into user mode in the
570         //         environment.
571
572         // Hint: This function loads the new environment's state from
573         //      e->env_tf.  Go back through the code you wrote above
574         //      and make sure you have set the relevant parts of
575         //      e->env_tf to sensible values.
576
577         // TODO: race here with env destroy on the status and refcnt
578         // Could up the refcnt and down it when a process is not running
579         e->env_status = ENV_RUNNING;
580         if (e != curenvs[lapic_get_id()]) {
581                 curenvs[lapic_get_id()] = e;
582                 e->env_runs++;
583                 lcr3(e->env_cr3);
584         }
585     env_pop_tf(&e->env_tf);
586 }
587