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