Lab2, exercise 4 - basic VM init, paging
[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 *penv to the environment.
27 //   On error, sets *penv 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         // LAB 3: Your code here.
75 }
76
77 //
78 // Initialize the kernel virtual memory layout for environment e.
79 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
80 // and initialize the kernel portion of the new environment's address space.
81 // Do NOT (yet) map anything into the user portion
82 // of the environment's virtual address space.
83 //
84 // Returns 0 on success, < 0 on error.  Errors include:
85 //      -E_NO_MEM if page directory or table could not be allocated.
86 //
87 static int
88 env_setup_vm(struct Env *e)
89 {
90         int i, r;
91         struct Page *p = NULL;
92
93         // Allocate a page for the page directory
94         if ((r = page_alloc(&p)) < 0)
95                 return r;
96
97         // Now, set e->env_pgdir and e->env_cr3,
98         // and initialize the page directory.
99         //
100         // Hint:
101         //    - The VA space of all envs is identical above UTOP
102         //      (except at VPT and UVPT, which we've set below).
103         //      See inc/memlayout.h for permissions and layout.
104         //      Can you use boot_pgdir as a template?  Hint: Yes.
105         //      (Make sure you got the permissions right in Lab 2.)
106         //    - The initial VA below UTOP is empty.
107         //    - You do not need to make any more calls to page_alloc.
108         //    - Note: pp_ref is not maintained for most physical pages
109         //      mapped above UTOP -- but you do need to increment
110         //      env_pgdir's pp_ref!
111
112         // LAB 3: Your code here.
113
114         // VPT and UVPT map the env's own page table, with
115         // different permissions.
116         e->env_pgdir[PDX(VPT)]  = e->env_cr3 | PTE_P | PTE_W;
117         e->env_pgdir[PDX(UVPT)] = e->env_cr3 | PTE_P | PTE_U;
118
119         return 0;
120 }
121
122 //
123 // Allocates and initializes a new environment.
124 // On success, the new environment is stored in *newenv_store.
125 //
126 // Returns 0 on success, < 0 on failure.  Errors include:
127 //      -E_NO_FREE_ENV if all NENVS environments are allocated
128 //      -E_NO_MEM on memory exhaustion
129 //
130 int
131 env_alloc(struct Env **newenv_store, envid_t parent_id)
132 {
133         int32_t generation;
134         int r;
135         struct Env *e;
136
137         if (!(e = LIST_FIRST(&env_free_list)))
138                 return -E_NO_FREE_ENV;
139
140         // Allocate and set up the page directory for this environment.
141         if ((r = env_setup_vm(e)) < 0)
142                 return r;
143
144         // Generate an env_id for this environment.
145         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
146         if (generation <= 0)    // Don't create a negative env_id.
147                 generation = 1 << ENVGENSHIFT;
148         e->env_id = generation | (e - envs);
149         
150         // Set the basic status variables.
151         e->env_parent_id = parent_id;
152         e->env_status = ENV_RUNNABLE;
153         e->env_runs = 0;
154
155         // Clear out all the saved register state,
156         // to prevent the register values
157         // of a prior environment inhabiting this Env structure
158         // from "leaking" into our new environment.
159         memset(&e->env_tf, 0, sizeof(e->env_tf));
160
161         // Set up appropriate initial values for the segment registers.
162         // GD_UD is the user data segment selector in the GDT, and 
163         // GD_UT is the user text segment selector (see inc/memlayout.h).
164         // The low 2 bits of each segment register contains the
165         // Requestor Privilege Level (RPL); 3 means user mode.
166         e->env_tf.tf_ds = GD_UD | 3;
167         e->env_tf.tf_es = GD_UD | 3;
168         e->env_tf.tf_ss = GD_UD | 3;
169         e->env_tf.tf_esp = USTACKTOP;
170         e->env_tf.tf_cs = GD_UT | 3;
171         // You will set e->env_tf.tf_eip later.
172
173         // commit the allocation
174         LIST_REMOVE(e, env_link);
175         *newenv_store = e;
176
177         cprintf("[%08x] new env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
178         return 0;
179 }
180
181 //
182 // Allocate len bytes of physical memory for environment env,
183 // and map it at virtual address va in the environment's address space.
184 // Does not zero or otherwise initialize the mapped pages in any way.
185 // Pages should be writable by user and kernel.
186 // Panic if any allocation attempt fails.
187 //
188 static void
189 segment_alloc(struct Env *e, void *va, size_t len)
190 {
191         // LAB 3: Your code here.
192         // (But only if you need it for load_icode.)
193         //
194         // Hint: It is easier to use segment_alloc if the caller can pass
195         //   'va' and 'len' values that are not page-aligned.
196         //   You should round va down, and round len up.
197 }
198
199 //
200 // Set up the initial program binary, stack, and processor flags
201 // for a user process.
202 // This function is ONLY called during kernel initialization,
203 // before running the first user-mode environment.
204 //
205 // This function loads all loadable segments from the ELF binary image
206 // into the environment's user memory, starting at the appropriate
207 // virtual addresses indicated in the ELF program header.
208 // At the same time it clears to zero any portions of these segments
209 // that are marked in the program header as being mapped
210 // but not actually present in the ELF file - i.e., the program's bss section.
211 //
212 // All this is very similar to what our boot loader does, except the boot
213 // loader also needs to read the code from disk.  Take a look at
214 // boot/main.c to get ideas.
215 //
216 // Finally, this function maps one page for the program's initial stack.
217 //
218 // load_icode panics if it encounters problems.
219 //  - How might load_icode fail?  What might be wrong with the given input?
220 //
221 static void
222 load_icode(struct Env *e, uint8_t *binary, size_t size)
223 {
224         // Hints: 
225         //  Load each program segment into virtual memory
226         //  at the address specified in the ELF section header.
227         //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
228         //  Each segment's virtual address can be found in ph->p_va
229         //  and its size in memory can be found in ph->p_memsz.
230         //  The ph->p_filesz bytes from the ELF binary, starting at
231         //  'binary + ph->p_offset', should be copied to virtual address
232         //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
233         //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
234         //  Use functions from the previous lab to allocate and map pages.
235         //
236         //  All page protection bits should be user read/write for now.
237         //  ELF segments are not necessarily page-aligned, but you can
238         //  assume for this function that no two segments will touch
239         //  the same virtual page.
240         //
241         //  You may find a function like segment_alloc useful.
242         //
243         //  Loading the segments is much simpler if you can move data
244         //  directly into the virtual addresses stored in the ELF binary.
245         //  So which page directory should be in force during
246         //  this function?
247         //
248         // Hint:
249         //  You must also do something with the program's entry point,
250         //  to make sure that the environment starts executing there.
251         //  What?  (See env_run() and env_pop_tf() below.)
252
253         // LAB 3: Your code here.
254
255         // Now map one page for the program's initial stack
256         // at virtual address USTACKTOP - PGSIZE.
257
258         // LAB 3: Your code here.
259 }
260
261 //
262 // Allocates a new env and loads the named elf binary into it.
263 // This function is ONLY called during kernel initialization,
264 // before running the first user-mode environment.
265 // The new env's parent ID is set to 0.
266 //
267 // Where does the result go? 
268 // By convention, envs[0] is the first environment allocated, so
269 // whoever calls env_create simply looks for the newly created
270 // environment there. 
271 void
272 env_create(uint8_t *binary, size_t size)
273 {
274         // LAB 3: Your code here.
275 }
276
277 //
278 // Frees env e and all memory it uses.
279 // 
280 void
281 env_free(struct Env *e)
282 {
283         pte_t *pt;
284         uint32_t pdeno, pteno;
285         physaddr_t pa;
286
287         // Note the environment's demise.
288         cprintf("[%08x] free env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
289
290         // Flush all mapped pages in the user portion of the address space
291         static_assert(UTOP % PTSIZE == 0);
292         for (pdeno = 0; pdeno < PDX(UTOP); pdeno++) {
293
294                 // only look at mapped page tables
295                 if (!(e->env_pgdir[pdeno] & PTE_P))
296                         continue;
297
298                 // find the pa and va of the page table
299                 pa = PTE_ADDR(e->env_pgdir[pdeno]);
300                 pt = (pte_t*) KADDR(pa);
301
302                 // unmap all PTEs in this page table
303                 for (pteno = 0; pteno <= PTX(~0); pteno++) {
304                         if (pt[pteno] & PTE_P)
305                                 page_remove(e->env_pgdir, PGADDR(pdeno, pteno, 0));
306                 }
307
308                 // free the page table itself
309                 e->env_pgdir[pdeno] = 0;
310                 page_decref(pa2page(pa));
311         }
312
313         // free the page directory
314         pa = e->env_cr3;
315         e->env_pgdir = 0;
316         e->env_cr3 = 0;
317         page_decref(pa2page(pa));
318
319         // return the environment to the free list
320         e->env_status = ENV_FREE;
321         LIST_INSERT_HEAD(&env_free_list, e, env_link);
322 }
323
324 //
325 // Frees environment e.
326 // If e was the current env, then runs a new environment (and does not return
327 // to the caller).
328 //
329 void
330 env_destroy(struct Env *e) 
331 {
332         env_free(e);
333
334         cprintf("Destroyed the only environment - nothing more to do!\n");
335         while (1)
336                 monitor(NULL);
337 }
338
339
340 //
341 // Restores the register values in the Trapframe with the 'iret' instruction.
342 // This exits the kernel and starts executing some environment's code.
343 // This function does not return.
344 //
345 void
346 env_pop_tf(struct Trapframe *tf)
347 {
348         __asm __volatile("movl %0,%%esp\n"
349                 "\tpopal\n"
350                 "\tpopl %%es\n"
351                 "\tpopl %%ds\n"
352                 "\taddl $0x8,%%esp\n" /* skip tf_trapno and tf_errcode */
353                 "\tiret"
354                 : : "g" (tf) : "memory");
355         panic("iret failed");  /* mostly to placate the compiler */
356 }
357
358 //
359 // Context switch from curenv to env e.
360 // Note: if this is the first call to env_run, curenv is NULL.
361 //  (This function does not return.)
362 //
363 void
364 env_run(struct Env *e)
365 {
366         // Step 1: If this is a context switch (a new environment is running),
367         //         then set 'curenv' to the new environment,
368         //         update its 'env_runs' counter, and
369         //         and use lcr3() to switch to its address space.
370         // Step 2: Use env_pop_tf() to restore the environment's
371         //         registers and drop into user mode in the
372         //         environment.
373
374         // Hint: This function loads the new environment's state from
375         //      e->env_tf.  Go back through the code you wrote above
376         //      and make sure you have set the relevant parts of
377         //      e->env_tf to sensible values.
378         
379         // LAB 3: Your code here.
380
381         panic("env_run not yet implemented");
382 }
383