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