Beginnings of an implementation of channels for ROS
[akaros.git] / kern / src / env.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 //#pragma nodeputy
4 #pragma noasync
5 #endif
6
7 #include <arch/arch.h>
8 #include <arch/mmu.h>
9 #include <elf.h>
10 #include <smp.h>
11
12 #include <atomic.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 #include <manager.h>
20
21 #include <ros/syscall.h>
22 #include <ros/error.h>
23
24 env_t *envs = NULL;             // All environments
25 atomic_t num_envs = atomic_init(0);
26 // TODO: make this a struct of info including the pointer and cacheline-align it
27 // This lets the kernel know what process is running on the core it traps into.
28 // A lot of the Env business, including this and its usage, will change when we
29 // redesign the env as a multi-process.
30 env_t* curenvs[MAX_NUM_CPUS] = {[0 ... (MAX_NUM_CPUS-1)] NULL};
31 static env_list_t env_free_list;        // Free list
32
33 #define ENVGENSHIFT     12              // >= LOGNENV
34
35 //
36 // Converts an envid to an env pointer.
37 //
38 // RETURNS
39 //   0 on success, -EBADENV on error.
40 //   On success, sets *env_store to the environment.
41 //   On error, sets *env_store to NULL.
42 //
43 int
44 envid2env(envid_t envid, env_t **env_store, bool checkperm)
45 {
46         env_t *e;
47         env_t* curenv = curenvs[core_id()];
48
49         // If envid is zero, return the current environment.
50         if (envid == 0) {
51                 *env_store = curenv;
52                 return 0;
53         }
54
55         // Look up the Env structure via the index part of the envid,
56         // then check the env_id field in that env_t
57         // to ensure that the envid is not stale
58         // (i.e., does not refer to a _previous_ environment
59         // that used the same slot in the envs[] array).
60         e = &envs[ENVX(envid)];
61         if (e->env_status == ENV_FREE || e->env_id != envid) {
62                 *env_store = 0;
63                 return -EBADENV;
64         }
65
66         // Check that the calling environment has legitimate permission
67         // to manipulate the specified environment.
68         // If checkperm is set, the specified environment
69         // must be either the current environment
70         // or an immediate child of the current environment.
71         if (checkperm && e != curenv && e->env_parent_id != curenv->env_id) {
72                 *env_store = 0;
73                 return -EBADENV;
74         }
75
76         *env_store = e;
77         return 0;
78 }
79
80 //
81 // Mark all environments in 'envs' as free, set their env_ids to 0,
82 // and insert them into the env_free_list.
83 // Insert in reverse order, so that the first call to env_alloc()
84 // returns envs[0].
85 //
86 void
87 env_init(void)
88 {
89         int i;
90         LIST_INIT(&env_free_list);
91         assert(envs != NULL);
92         for (i = NENV-1; i >= 0; i--) { TRUSTEDBLOCK // asw ivy workaround
93                 // these should already be set from when i memset'd the array to 0
94                 envs[i].env_status = ENV_FREE;
95                 envs[i].env_id = 0;
96                 LIST_INSERT_HEAD(&env_free_list, &envs[i], env_link);
97         }
98 }
99
100 //
101 // Initialize the kernel virtual memory layout for environment e.
102 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
103 // and initialize the kernel portion of the new environment's address space.
104 // Do NOT (yet) map anything into the user portion
105 // of the environment's virtual address space.
106 //
107 // Returns 0 on success, < 0 on error.  Errors include:
108 //      -ENOMEM if page directory or table could not be allocated.
109 //
110 static int
111 env_setup_vm(env_t *e)
112 WRITES(e->env_pgdir, e->env_cr3, e->env_procinfo, e->env_syscallring,
113        e->env_syseventring, e->env_syscallbackring, e->env_syseventfrontring)
114 {
115         int i, r;
116         page_t *pgdir = NULL;
117         page_t *pginfo = NULL; 
118         page_t *pgsyscallring = NULL;
119         page_t *pgsyseventring = NULL;
120
121         /* 
122          * Allocate pages for the page directory, shared info, shared data, 
123          * and kernel message pages
124          */
125         r = page_alloc(&pgdir);
126         if(r < 0) return r;
127         r = page_alloc(&pginfo);
128         if (r < 0) {
129                 page_free(pgdir);
130                 return r;
131         }       
132         r = page_alloc(&pgsyscallring);
133         if (r < 0) {
134                 page_free(pgdir);
135                 page_free(pginfo);
136                 return r;
137         }
138         r = page_alloc(&pgsyseventring);
139         if (r < 0) {
140                 page_free(pgdir);
141                 page_free(pginfo);
142                 page_free(pgsyscallring);
143                 return r;
144         }
145
146         // Now, set e->env_pgdir and e->env_cr3,
147         // and initialize the page directory.
148         //
149         // Hint:
150         //    - The VA space of all envs is identical above UTOP
151         //      (except at VPT and UVPT, which we've set below).
152         //      (and not for UINFO either)
153         //      See inc/memlayout.h for permissions and layout.
154         //      Can you use boot_pgdir as a template?  Hint: Yes.
155         //      (Make sure you got the permissions right in Lab 2.)
156         //    - The initial VA below UTOP is empty.
157         //    - You do not need to make any more calls to page_alloc.
158         //    - Note: pp_ref is not maintained for most physical pages
159         //      mapped above UTOP -- but you do need to increment
160         //      env_pgdir's pp_ref!
161
162         // need to up pgdir's reference, since it will never be done elsewhere
163         pgdir->pp_ref++;
164         e->env_pgdir = page2kva(pgdir);
165         e->env_cr3 = page2pa(pgdir);
166         e->env_procinfo = page2kva(pginfo);
167         e->env_syscallring = page2kva(pgsyscallring);
168         e->env_syseventring = page2kva(pgsyseventring);
169
170         memset(page2kva(pgdir), 0, PGSIZE);
171         memset(e->env_procinfo, 0, PGSIZE);
172         memset((void*COUNT(PGSIZE)) TC(e->env_syscallring), 0, PGSIZE);
173         memset((void*COUNT(PGSIZE)) TC(e->env_syseventring), 0, PGSIZE);
174
175         // Initialize the generic syscall ring buffer
176         SHARED_RING_INIT(e->env_syscallring);
177         // Initialize the backend of the syscall ring buffer
178         BACK_RING_INIT(&e->env_syscallbackring, e->env_syscallring, PGSIZE);
179                        
180         // Initialize the generic sysevent ring buffer
181         SHARED_RING_INIT(e->env_syseventring);
182         // Initialize the frontend of the sysevent ring buffer
183         FRONT_RING_INIT(&e->env_syseventfrontring, e->env_syseventring, PGSIZE);
184
185         // should be able to do this so long as boot_pgdir never has
186         // anything put below UTOP
187         memcpy(e->env_pgdir, boot_pgdir, NPDENTRIES*sizeof(pde_t));
188
189         // something like this.  TODO, if you want
190         //memcpy(&e->env_pgdir[PDX(UTOP)], &boot_pgdir[PDX(UTOP)], PGSIZE - PDX(UTOP));
191         // check with
192         // assert(memcmp(e->env_pgdir, boot_pgdir, PGSIZE) == 0);
193
194         // VPT and UVPT map the env's own page table, with
195         // different permissions.
196         e->env_pgdir[PDX(VPT)]  = PTE(PPN(e->env_cr3), PTE_P | PTE_KERN_RW);
197         e->env_pgdir[PDX(UVPT)] = PTE(PPN(e->env_cr3), PTE_P | PTE_USER_RO);
198
199         // Insert the per-process info and ring buffer pages into this process's 
200         // pgdir.  I don't want to do these two pages later (like with the stack), 
201         // since the kernel wants to keep pointers to it easily.
202         // Could place all of this with a function that maps a shared memory page
203         // that can work between any two address spaces or something.
204         r = page_insert(e->env_pgdir, pginfo, (void*SNT)UINFO, PTE_USER_RO);
205         if (r < 0) {
206                 page_free(pgdir);
207                 page_free(pginfo);
208                 page_free(pgsyscallring);
209                 page_free(pgsyseventring);
210                 return r;
211         }
212         r = page_insert(e->env_pgdir, pgsyscallring, (void*SNT)USYSCALL, PTE_USER_RW);
213         if (r < 0) {
214                 // note that we can't currently deallocate the pages created by
215                 // pgdir_walk (inside insert).  should be able to gather them up when
216                 // we destroy environments and their page tables.
217                 page_free(pgdir);
218                 page_free(pginfo);
219                 page_free(pgsyscallring);
220                 page_free(pgsyseventring);
221                 return r;
222         }
223
224         /* Shared page for all processes.  Can't be trusted, but still very useful
225          * at this stage for us.  Consider removing when we have real processes.
226          * (TODO).  Note the page is alloced only the first time through
227          */
228         static page_t* shared_page = 0;
229         if (!shared_page)
230                 page_alloc(&shared_page);
231         // Up it, so it never goes away.  One per user, plus one from page_alloc
232         // This is necessary, since it's in the per-process range of memory that
233         // gets freed during page_free.
234         shared_page->pp_ref++;
235
236         // Inserted into every process's address space at UGDATA
237         page_insert(e->env_pgdir, shared_page, (void*SNT)UGDATA, PTE_USER_RW);
238
239         return 0;
240 }
241
242 //
243 // Allocates and initializes a new environment.
244 // On success, the new environment is stored in *newenv_store.
245 //
246 // Returns 0 on success, < 0 on failure.  Errors include:
247 //      -ENOFREEENV if all NENVS environments are allocated
248 //      -ENOMEM on memory exhaustion
249 //
250 int
251 env_alloc(env_t **newenv_store, envid_t parent_id)
252 {
253         int32_t generation;
254         int r;
255         env_t *e;
256
257         if (!(e = LIST_FIRST(&env_free_list)))
258                 return -ENOFREEENV;
259         
260         //memset((void*)e + sizeof(e->env_link), 0, sizeof(*e) - sizeof(e->env_link));
261
262     { INITSTRUCT(*e)
263
264         // Allocate and set up the page directory for this environment.
265         if ((r = env_setup_vm(e)) < 0)
266                 return r;
267
268         // Generate an env_id for this environment.
269         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
270         if (generation <= 0)    // Don't create a negative env_id.
271                 generation = 1 << ENVGENSHIFT;
272         e->env_id = generation | (e - envs);
273
274         // Set the basic status variables.
275     e->lock = 0;
276         e->env_parent_id = parent_id;
277         e->env_status = ENV_RUNNABLE;
278         e->env_runs = 0;
279         e->env_refcnt = 1;
280         e->env_flags = 0;
281
282         memset(&e->env_ancillary_state,0,sizeof(e->env_ancillary_state));
283         memset(&e->env_tf,0,sizeof(e->env_tf));
284         env_init_trapframe(e);
285
286         // commit the allocation
287         LIST_REMOVE(e, env_link);
288         *newenv_store = e;
289         atomic_inc(&num_envs);
290
291         e->env_tscfreq = system_timing.tsc_freq;
292         // TODO: for now, the only info at procinfo is this env's struct
293         // note that we need to copy this over every time we make a change to env
294         // that we want userspace to see.  also note that we don't even want to
295         // show them all of env, only specific things like PID, PPID, etc
296         memcpy(e->env_procinfo, e, sizeof(env_t));
297
298         env_t* curenv = curenvs[core_id()];
299
300         printk("[%08x] new env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
301         } // INIT_STRUCT
302         return 0;
303 }
304
305 //
306 // Allocate len bytes of physical memory for environment env,
307 // and map it at virtual address va in the environment's address space.
308 // Does not zero or otherwise initialize the mapped pages in any way.
309 // Pages should be writable by user and kernel.
310 // Panic if any allocation attempt fails.
311 //
312 static void
313 segment_alloc(env_t *e, void *SNT va, size_t len)
314 {
315         void *SNT start, *SNT end;
316         size_t num_pages;
317         int i, r;
318         page_t *page;
319         pte_t *pte;
320
321         start = ROUNDDOWN(va, PGSIZE);
322         end = ROUNDUP(va + len, PGSIZE);
323         if (start >= end)
324                 panic("Wrap-around in memory allocation addresses!");
325         if ((uintptr_t)end > UTOP)
326                 panic("Attempting to map above UTOP!");
327         // page_insert/pgdir_walk alloc a page and read/write to it via its address
328         // starting from pgdir (e's), so we need to be using e's pgdir
329         assert(e->env_cr3 == rcr3());
330         num_pages = PPN(end - start);
331
332         for (i = 0; i < num_pages; i++, start += PGSIZE) {
333                 // skip if a page is already mapped.  yes, page_insert will page_remove
334                 // whatever page was already there, but if we are seg allocing adjacent
335                 // regions, we don't want to destroy that old mapping/page
336                 // though later on we are told we can ignore this...
337                 pte = pgdir_walk(e->env_pgdir, start, 0);
338                 if (pte && *pte & PTE_P)
339                         continue;
340                 if ((r = page_alloc(&page)) < 0)
341                         panic("segment_alloc: %e", r);
342                 page_insert(e->env_pgdir, page, start, PTE_USER_RW);
343         }
344 }
345
346 //
347 // Set up the initial program binary, stack, and processor flags
348 // for a user process.
349 // This function is ONLY called during kernel initialization,
350 // before running the first user-mode environment.
351 //
352 // This function loads all loadable segments from the ELF binary image
353 // into the environment's user memory, starting at the appropriate
354 // virtual addresses indicated in the ELF program header.
355 // At the same time it clears to zero any portions of these segments
356 // that are marked in the program header as being mapped
357 // but not actually present in the ELF file - i.e., the program's bss section.
358 //
359 // All this is very similar to what our boot loader does, except the boot
360 // loader also needs to read the code from disk.  Take a look at
361 // boot/main.c to get ideas.
362 //
363 // Finally, this function maps one page for the program's initial stack.
364 //
365 // load_icode panics if it encounters problems.
366 //  - How might load_icode fail?  What might be wrong with the given input?
367 //
368 static void
369 load_icode(env_t *e, uint8_t *COUNT(size) binary, size_t size)
370 {
371         // Hints:
372         //  Load each program segment into virtual memory
373         //  at the address specified in the ELF section header.
374         //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
375         //  Each segment's virtual address can be found in ph->p_va
376         //  and its size in memory can be found in ph->p_memsz.
377         //  The ph->p_filesz bytes from the ELF binary, starting at
378         //  'binary + ph->p_offset', should be copied to virtual address
379         //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
380         //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
381         //  Use functions from the previous lab to allocate and map pages.
382         //
383         //  All page protection bits should be user read/write for now.
384         //  ELF segments are not necessarily page-aligned, but you can
385         //  assume for this function that no two segments will touch
386         //  the same virtual page.
387         //
388         //  You may find a function like segment_alloc useful.
389         //
390         //  Loading the segments is much simpler if you can move data
391         //  directly into the virtual addresses stored in the ELF binary.
392         //  So which page directory should be in force during
393         //  this function?
394         //
395         // Hint:
396         //  You must also do something with the program's entry point,
397         //  to make sure that the environment starts executing there.
398         //  What?  (See env_run() and env_pop_tf() below.)
399
400         // asw: copy the headers because they might not be aligned.
401         elf_t elfhdr;
402         proghdr_t phdr;
403         memcpy(&elfhdr,binary,sizeof(elfhdr));
404
405         int i, r;
406
407         // is this an elf?
408         assert(elfhdr.e_magic == ELF_MAGIC);
409         // make sure we have proghdrs to load
410         assert(elfhdr.e_phnum);
411
412         // to actually access any pages alloc'd for this environment, we
413         // need to have the hardware use this environment's page tables.
414         // we can use e's tables as long as we want, since it has the same
415         // mappings for the kernel as does boot_pgdir
416         lcr3(e->env_cr3);
417
418         // TODO: how do we do a runtime COUNT?
419         {TRUSTEDBLOCK
420         for (i = 0; i < elfhdr.e_phnum; i++) {
421                 memcpy(&phdr,binary+elfhdr.e_phoff+i*sizeof(phdr),sizeof(phdr));
422         // zra: TRUSTEDBLOCK until validation is done.
423                 if (phdr.p_type != ELF_PROG_LOAD)
424                         continue;
425         // TODO: validate elf header fields!
426                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
427                 // this, there will be issues with overlapping sections
428                 segment_alloc(e, (void*SNT)phdr.p_va, phdr.p_memsz);
429                 memcpy((void*)phdr.p_va, binary + phdr.p_offset, phdr.p_filesz);
430                 memset((void*)phdr.p_va + phdr.p_filesz, 0, phdr.p_memsz - phdr.p_filesz);
431         }}
432
433         env_set_program_counter(e,elfhdr.e_entry);
434
435         // Now map one page for the program's initial stack
436         // at virtual address USTACKTOP - PGSIZE.
437
438         segment_alloc(e, (void*SNT)(USTACKTOP - PGSIZE), PGSIZE);
439 }
440
441 //
442 // Allocates a new env and loads the named elf binary into it.
443 //
444 env_t* env_create(uint8_t *binary, size_t size)
445 {
446         env_t *e;
447         int r;
448
449         if ((r = env_alloc(&e, 0)) < 0)
450                 panic("env_create: %e", r);
451         load_icode(e, binary, size);
452         return e;
453 }
454
455 //
456 // Frees env e and all memory it uses.
457 //
458 void
459 env_free(env_t *e)
460 {
461         physaddr_t pa;
462
463         // Note the environment's demise.
464         env_t* curenv = curenvs[core_id()];
465         cprintf("[%08x] free env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
466
467         // Flush all mapped pages in the user portion of the address space
468         env_user_mem_free(e);
469
470         // Moved to page_decref
471         // need a known good pgdir before releasing the old one
472         //lcr3(PADDR(boot_pgdir));
473
474         // free the page directory
475         pa = e->env_cr3;
476         e->env_pgdir = 0;
477         e->env_cr3 = 0;
478         page_decref(pa2page(pa));
479
480         // return the environment to the free list
481         e->env_status = ENV_FREE;
482         LIST_INSERT_HEAD(&env_free_list, e, env_link);
483 }
484
485 /*
486  * This allows the kernel to keep this process around, in case it is being used
487  * in some asynchronous processing.
488  * The refcnt should always be greater than 0 for processes that aren't dying.
489  * When refcnt is 0, the process is dying and should not allow any more increfs.
490  * TODO: Make sure this is never called from an interrupt handler (irq_save)
491  */
492 error_t env_incref(env_t* e)
493 {
494         error_t retval = 0;
495         spin_lock(&e->lock);
496         if (e->env_refcnt)
497                 e->env_refcnt++;
498         else
499                 retval = -EBADENV;
500         spin_unlock(&e->lock);
501         return retval;
502 }
503
504 /*
505  * When the kernel is done with a process, it decrements its reference count.
506  * When the count hits 0, no one is using it and it should be freed.
507  * env_destroy calls this.
508  * TODO: Make sure this is never called from an interrupt handler (irq_save)
509  */
510 void env_decref(env_t* e)
511 {
512         // need a known good pgdir before releasing the old one
513         // sometimes env_free is called on a different core than decref
514         lcr3(PADDR(boot_pgdir));
515
516         spin_lock(&e->lock);
517         e->env_refcnt--;
518         spin_unlock(&e->lock);
519         // if we hit 0, no one else will increment and we can check outside the lock
520         if (e->env_refcnt == 0)
521                 env_free(e);
522 }
523
524
525 //
526 // Frees environment e.
527 // If e was the current env, then runs a new environment (and does not return
528 // to the caller).
529 //
530 void
531 env_destroy(env_t *e)
532 {
533         // TODO: race condition with env statuses, esp when running / destroying
534         e->env_status = ENV_DYING;
535
536         env_decref(e);
537         atomic_dec(&num_envs);
538
539         // for old envs that die on user cores.  since env run never returns, cores
540         // never get back to their old hlt/relaxed/spin state, so we need to force
541         // them back to an idle function.
542         uint32_t id = core_id();
543         // There is no longer a curenv for this core. (TODO: Think about this.)
544         curenvs[id] = NULL;
545         if (id) {
546                 smp_idle();
547                 panic("should never see me");
548         }
549         // else we're core 0 and can do the usual
550
551         /* Instead of picking a new environment to run, or defaulting to the monitor
552          * like before, for now we'll hop into the manager() function, which
553          * dispatches jobs.  Note that for now we start the manager from the top,
554          * and not from where we left off the last time we called manager.  That
555          * would require us to save some context (and a stack to work on) here.
556          */
557         manager();
558         assert(0); // never get here
559 }
560
561 /* ugly, but for now just linearly search through all possible
562  * environments for a runnable one.
563  * the current *policy* is to round-robin the search
564  */
565 void schedule(void)
566 {
567         env_t *e;
568         static int last_picked = 0;
569         
570         for (int i = 0, j = last_picked + 1; i < NENV; i++, j = (j + 1) % NENV) {
571                 e = &envs[ENVX(j)];
572                 // TODO: race here, if another core is just about to start this env.
573                 // Fix it by setting the status in something like env_dispatch when
574                 // we have multi-contexted processes
575                 if (e && e->env_status == ENV_RUNNABLE) {
576                         last_picked = j;
577                         env_run(e);
578                 }
579         }
580
581         cprintf("Destroyed the only environment - nothing more to do!\n");
582         while (1)
583                 monitor(NULL);
584 }
585
586 //
587 // Context switch from curenv to env e.
588 // Note: if this is the first call to env_run, curenv is NULL.
589 //  (This function does not return.)
590 //
591 void
592 env_run(env_t *e)
593 {
594         // Step 1: If this is a context switch (a new environment is running),
595         //         then set 'curenv' to the new environment,
596         //         update its 'env_runs' counter, and
597         //         and use lcr3() to switch to its address space.
598         // Step 2: Use env_pop_tf() to restore the environment's
599         //         registers and drop into user mode in the
600         //         environment.
601
602         // Hint: This function loads the new environment's state from
603         //      e->env_tf.  Go back through the code you wrote above
604         //      and make sure you have set the relevant parts of
605         //      e->env_tf to sensible values.
606
607         // TODO: race here with env destroy on the status and refcnt
608         // Could up the refcnt and down it when a process is not running
609         e->env_status = ENV_RUNNING;
610         if (e != curenvs[core_id()]) {
611                 curenvs[core_id()] = e;
612                 e->env_runs++;
613                 lcr3(e->env_cr3);
614         }
615
616         env_pop_ancillary_state(e);
617
618         env_pop_tf(&e->env_tf);
619 }
620
621 /* This is the top-half of an interrupt handler, where the bottom half is
622  * env_run (which never returns).  Just add it to the delayed work queue,
623  * which isn't really a queue yet.
624  */
625 void run_env_handler(trapframe_t *tf, void* data)
626 {
627         assert(data);
628         per_cpu_info_t *cpuinfo = &per_cpu_info[core_id()];
629         spin_lock_irqsave(&cpuinfo->lock);
630         { TRUSTEDBLOCK // TODO: how do we make this func_t cast work?
631         cpuinfo->delayed_work.func = (func_t)env_run;
632         cpuinfo->delayed_work.data = data;
633         }
634         spin_unlock_irqsave(&cpuinfo->lock);
635 }