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