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