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