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