Merge branch 'master' into proc-work
[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 <process.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
48         // If envid is zero, return the current environment.
49         if (envid == 0) {
50                 *env_store = current;
51                 return 0;
52         }
53
54         // Look up the Env structure via the index part of the envid,
55         // then check the env_id field in that env_t
56         // to ensure that the envid is not stale
57         // (i.e., does not refer to a _previous_ environment
58         // that used the same slot in the envs[] array).
59         e = &envs[ENVX(envid)];
60         if (e->state == ENV_FREE || e->env_id != envid) {
61                 *env_store = 0;
62                 return -EBADENV;
63         }
64
65         // Check that the calling environment has legitimate permission
66         // to manipulate the specified environment.
67         // If checkperm is set, the specified environment
68         // must be either the current environment
69         // or an immediate child of the current environment.
70         // TODO: should check for current being null
71         if (checkperm && e != current && e->env_parent_id != current->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 // TODO: get rid of this whole array bullshit
86 //
87 void
88 env_init(void)
89 {
90         int i;
91         LIST_INIT(&env_free_list);
92         assert(envs != NULL);
93         for (i = NENV-1; i >= 0; i--) { TRUSTEDBLOCK // asw ivy workaround
94                 // these should already be set from when i memset'd the array to 0
95                 envs[i].state = ENV_FREE;
96                 envs[i].env_id = 0;
97                 LIST_INSERT_HEAD(&env_free_list, &envs[i], env_link);
98         }
99 }
100
101 //
102 // Initialize the kernel virtual memory layout for environment e.
103 // Allocate a page directory, set e->env_pgdir and e->env_cr3 accordingly,
104 // and initialize the kernel portion of the new environment's address space.
105 // Do NOT (yet) map anything into the user portion
106 // of the environment's virtual address space.
107 //
108 // Returns 0 on success, < 0 on error.  Errors include:
109 //      -ENOMEM if page directory or table could not be allocated.
110 //
111 static int
112 env_setup_vm(env_t *e)
113 WRITES(e->env_pgdir, e->env_cr3, e->env_procinfo, e->env_syscallring,
114        e->env_syseventring, e->env_syscallbackring, e->env_syseventfrontring)
115 {
116         int i, r;
117         page_t *pgdir = NULL;
118         page_t *pginfo = NULL; 
119         page_t *pgsyscallring = NULL;
120         page_t *pgsyseventring = NULL;
121
122         /* 
123          * Allocate pages for the page directory, shared info, shared data, 
124          * and kernel message pages
125          */
126         r = page_alloc(&pgdir);
127         if(r < 0) return r;
128         r = page_alloc(&pginfo);
129         if (r < 0) {
130                 page_free(pgdir);
131                 return r;
132         }       
133         r = page_alloc(&pgsyscallring);
134         if (r < 0) {
135                 page_free(pgdir);
136                 page_free(pginfo);
137                 return r;
138         }
139         r = page_alloc(&pgsyseventring);
140         if (r < 0) {
141                 page_free(pgdir);
142                 page_free(pginfo);
143                 page_free(pgsyscallring);
144                 return r;
145         }
146
147         // Now, set e->env_pgdir and e->env_cr3,
148         // and initialize the page directory.
149         //
150         // Hint:
151         //    - The VA space of all envs is identical above UTOP
152         //      (except at VPT and UVPT, which we've set below).
153         //      (and not for UINFO either)
154         //      See inc/memlayout.h for permissions and layout.
155         //      Can you use boot_pgdir as a template?  Hint: Yes.
156         //      (Make sure you got the permissions right in Lab 2.)
157         //    - The initial VA below UTOP is empty.
158         //    - You do not need to make any more calls to page_alloc.
159         //    - Note: pp_ref is not maintained for most physical pages
160         //      mapped above UTOP -- but you do need to increment
161         //      env_pgdir's pp_ref!
162
163         // need to up pgdir's reference, since it will never be done elsewhere
164         pgdir->pp_ref++;
165         e->env_pgdir = page2kva(pgdir);
166         e->env_cr3 = page2pa(pgdir);
167         e->env_procinfo = page2kva(pginfo);
168         e->env_syscallring = page2kva(pgsyscallring);
169         e->env_syseventring = page2kva(pgsyseventring);
170
171         memset(page2kva(pgdir), 0, PGSIZE);
172         memset(e->env_procinfo, 0, PGSIZE);
173         memset((void*COUNT(PGSIZE)) TC(e->env_syscallring), 0, PGSIZE);
174         memset((void*COUNT(PGSIZE)) TC(e->env_syseventring), 0, PGSIZE);
175
176         // Initialize the generic syscall ring buffer
177         SHARED_RING_INIT(e->env_syscallring);
178         // Initialize the backend of the syscall ring buffer
179         BACK_RING_INIT(&e->env_syscallbackring, e->env_syscallring, PGSIZE);
180                        
181         // Initialize the generic sysevent ring buffer
182         SHARED_RING_INIT(e->env_syseventring);
183         // Initialize the frontend of the sysevent ring buffer
184         FRONT_RING_INIT(&e->env_syseventfrontring, e->env_syseventring, PGSIZE);
185
186         // should be able to do this so long as boot_pgdir never has
187         // anything put below UTOP
188         // TODO check on this!  had a nasty bug because of it
189         // this is a bit wonky, since if it's not PGSIZE, lots of other things are
190         // screwed up...
191         memcpy(e->env_pgdir, boot_pgdir, NPDENTRIES*sizeof(pde_t));
192
193         // something like this.  TODO, if you want
194         //memcpy(&e->env_pgdir[PDX(UTOP)], &boot_pgdir[PDX(UTOP)], PGSIZE - PDX(UTOP));
195         // check with
196         // assert(memcmp(e->env_pgdir, boot_pgdir, PGSIZE) == 0);
197
198         // VPT and UVPT map the env's own page table, with
199         // different permissions.
200         e->env_pgdir[PDX(VPT)]  = PTE(PPN(e->env_cr3), PTE_P | PTE_KERN_RW);
201         e->env_pgdir[PDX(UVPT)] = PTE(PPN(e->env_cr3), PTE_P | PTE_USER_RO);
202
203         // Insert the per-process info and ring buffer pages into this process's 
204         // pgdir.  I don't want to do these two pages later (like with the stack), 
205         // since the kernel wants to keep pointers to it easily.
206         // Could place all of this with a function that maps a shared memory page
207         // that can work between any two address spaces or something.
208         r = page_insert(e->env_pgdir, pginfo, (void*SNT)UINFO, PTE_USER_RO);
209         if (r < 0) {
210                 page_free(pgdir);
211                 page_free(pginfo);
212                 page_free(pgsyscallring);
213                 page_free(pgsyseventring);
214                 return r;
215         }
216         r = page_insert(e->env_pgdir, pgsyscallring, (void*SNT)USYSCALL, PTE_USER_RW);
217         if (r < 0) {
218                 // note that we can't currently deallocate the pages created by
219                 // pgdir_walk (inside insert).  should be able to gather them up when
220                 // we destroy environments and their page tables.
221                 page_free(pgdir);
222                 page_free(pginfo);
223                 page_free(pgsyscallring);
224                 page_free(pgsyseventring);
225                 return r;
226         }
227
228         /* Shared page for all processes.  Can't be trusted, but still very useful
229          * at this stage for us.  Consider removing when we have real processes.
230          * (TODO).  Note the page is alloced only the first time through
231          */
232         static page_t* shared_page = 0;
233         if (!shared_page)
234                 page_alloc(&shared_page);
235         // Up it, so it never goes away.  One per user, plus one from page_alloc
236         // This is necessary, since it's in the per-process range of memory that
237         // gets freed during page_free.
238         shared_page->pp_ref++;
239
240         // Inserted into every process's address space at UGDATA
241         page_insert(e->env_pgdir, shared_page, (void*SNT)UGDATA, PTE_USER_RW);
242
243         return 0;
244 }
245
246 //
247 // Allocates and initializes a new environment.
248 // On success, the new environment is stored in *newenv_store.
249 //
250 // Returns 0 on success, < 0 on failure.  Errors include:
251 //      -ENOFREEENV if all NENVS environments are allocated
252 //      -ENOMEM on memory exhaustion
253 //
254 int
255 env_alloc(env_t **newenv_store, envid_t parent_id)
256 {
257         int32_t generation;
258         int r;
259         env_t *e;
260
261         if (!(e = LIST_FIRST(&env_free_list)))
262                 return -ENOFREEENV;
263         
264     { INITSTRUCT(*e)
265
266         // Allocate and set up the page directory for this environment.
267         if ((r = env_setup_vm(e)) < 0)
268                 return r;
269
270         // Generate an env_id for this environment.
271         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
272         if (generation <= 0)    // Don't create a negative env_id.
273                 generation = 1 << ENVGENSHIFT;
274         e->env_id = generation | (e - envs);
275
276         // Set the basic status variables.
277     e->lock = 0;
278         e->env_parent_id = parent_id;
279         proc_set_state(e, PROC_CREATED);
280         e->env_runs = 0;
281         e->env_refcnt = 1;
282         e->env_flags = 0;
283
284         memset(&e->env_ancillary_state, 0, sizeof(e->env_ancillary_state));
285         memset(&e->env_tf, 0, sizeof(e->env_tf));
286         env_init_trapframe(e);
287
288         // commit the allocation
289         LIST_REMOVE(e, env_link);
290         *newenv_store = e;
291         atomic_inc(&num_envs);
292
293         printk("[%08x] new env %08x\n", current ? current->env_id : 0, e->env_id);
294         } // INIT_STRUCT
295         return 0;
296 }
297
298 //
299 // Allocate len bytes of physical memory for environment env,
300 // and map it at virtual address va in the environment's address space.
301 // Does not zero or otherwise initialize the mapped pages in any way.
302 // Pages should be writable by user and kernel.
303 // Panic if any allocation attempt fails.
304 //
305 static void
306 segment_alloc(env_t *e, void *SNT va, size_t len)
307 {
308         void *SNT start, *SNT end;
309         size_t num_pages;
310         int i, r;
311         page_t *page;
312         pte_t *pte;
313
314         start = ROUNDDOWN(va, PGSIZE);
315         end = ROUNDUP(va + len, PGSIZE);
316         if (start >= end)
317                 panic("Wrap-around in memory allocation addresses!");
318         if ((uintptr_t)end > UTOP)
319                 panic("Attempting to map above UTOP!");
320         // page_insert/pgdir_walk alloc a page and read/write to it via its address
321         // starting from pgdir (e's), so we need to be using e's pgdir
322         assert(e->env_cr3 == rcr3());
323         num_pages = PPN(end - start);
324
325         for (i = 0; i < num_pages; i++, start += PGSIZE) {
326                 // skip if a page is already mapped.  yes, page_insert will page_remove
327                 // whatever page was already there, but if we are seg allocing adjacent
328                 // regions, we don't want to destroy that old mapping/page
329                 // though later on we are told we can ignore this...
330                 pte = pgdir_walk(e->env_pgdir, start, 0);
331                 if (pte && *pte & PTE_P)
332                         continue;
333                 if ((r = page_alloc(&page)) < 0)
334                         panic("segment_alloc: %e", r);
335                 page_insert(e->env_pgdir, page, start, PTE_USER_RW);
336         }
337 }
338
339 //
340 // Set up the initial program binary, stack, and processor flags
341 // for a user process.
342 //
343 // This function loads all loadable segments from the ELF binary image
344 // into the environment's user memory, starting at the appropriate
345 // virtual addresses indicated in the ELF program header.
346 // At the same time it clears to zero any portions of these segments
347 // that are marked in the program header as being mapped
348 // but not actually present in the ELF file - i.e., the program's bss section.
349 //
350 // Finally, this function maps one page for the program's initial stack.
351 static void
352 load_icode(env_t *SAFE e, uint8_t *COUNT(size) binary, size_t size)
353 {
354         // asw: copy the headers because they might not be aligned.
355         elf_t elfhdr;
356         proghdr_t phdr;
357         memcpy(&elfhdr, binary, sizeof(elfhdr));
358
359         int i, r;
360
361         // is this an elf?
362         assert(elfhdr.e_magic == ELF_MAGIC);
363         // make sure we have proghdrs to load
364         assert(elfhdr.e_phnum);
365
366         // to actually access any pages alloc'd for this environment, we
367         // need to have the hardware use this environment's page tables.
368         uintreg_t old_cr3 = rcr3();
369         /*
370          * Even though we'll decref later and no one should be killing us at this
371          * stage, we're still going to wrap the lcr3s with incref/decref.
372          *
373          * Note we never decref on the old_cr3, since we aren't willing to let it
374          * die.  It's also not clear who the previous process is - sometimes it
375          * isn't even a process (when the kernel loads on its own, and not in
376          * response to a syscall).  Probably need to think more about this (TODO)
377          *
378          * This can get a bit tricky if this code blocks (will need to think about a
379          * decref then), if we try to change states, etc.
380          */
381         env_incref(e);
382         lcr3(e->env_cr3);
383
384         // TODO: how do we do a runtime COUNT?
385         {TRUSTEDBLOCK // zra: TRUSTEDBLOCK until validation is done.
386         for (i = 0; i < elfhdr.e_phnum; i++) {
387                 memcpy(&phdr, binary + elfhdr.e_phoff + i*sizeof(phdr), sizeof(phdr));
388                 if (phdr.p_type != ELF_PROG_LOAD)
389                         continue;
390         // TODO: validate elf header fields!
391                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
392                 // this, there will be issues with overlapping sections
393                 segment_alloc(e, (void*SNT)phdr.p_va, phdr.p_memsz);
394                 memcpy((void*)phdr.p_va, binary + phdr.p_offset, phdr.p_filesz);
395                 memset((void*)phdr.p_va + phdr.p_filesz, 0, phdr.p_memsz - phdr.p_filesz);
396         }}
397
398         env_set_program_counter(e, elfhdr.e_entry);
399
400         // Now map one page for the program's initial stack
401         // at virtual address USTACKTOP - PGSIZE.
402         segment_alloc(e, (void*SNT)(USTACKTOP - PGSIZE), PGSIZE);
403
404         // reload the original address space
405         lcr3(old_cr3);
406         env_decref(e);
407 }
408
409 //
410 // Allocates a new env and loads the named elf binary into it.
411 //
412 env_t* env_create(uint8_t *binary, size_t size)
413 {
414         env_t *e;
415         int r;
416         envid_t curid;
417         
418         curid = (current ? current->env_id : 0);        
419         if ((r = env_alloc(&e, curid)) < 0)
420                 panic("env_create: %e", r);
421         load_icode(e, binary, size);
422         return e;
423 }
424
425 //
426 // Frees env e and all memory it uses.
427 //
428 void
429 env_free(env_t *e)
430 {
431         physaddr_t pa;
432
433         // Note the environment's demise.
434         printk("[%08x] free env %08x\n", current ? current->env_id : 0, e->env_id);
435         // All parts of the kernel should have decref'd before env_free was called. 
436         assert(e->env_refcnt == 0);
437
438         // Flush all mapped pages in the user portion of the address space
439         env_user_mem_free(e);
440
441         // free the page directory
442         pa = e->env_cr3;
443         e->env_pgdir = 0;
444         e->env_cr3 = 0;
445         page_decref(pa2page(pa));
446
447         // return the environment to the free list
448         e->state = ENV_FREE;
449         LIST_INSERT_HEAD(&env_free_list, e, env_link);
450 }
451
452 /*
453  * The process refcnt is the number of places the process 'exists' in the
454  * system.  Creation counts as 1.  Having your page tables loaded somewhere
455  * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
456  * least 1.  If the kernel is on another core and in a processes address space
457  * (like processing its backring), that counts as another 1.
458  *
459  * Note that the actual loading and unloading of cr3 is up to the caller, since
460  * that's not the only use for this (and decoupling is more flexible).
461  *
462  * The refcnt should always be greater than 0 for processes that aren't dying.
463  * When refcnt is 0, the process is dying and should not allow any more increfs.
464  * A process can be dying with a refcnt greater than 0, since it could be
465  * waiting for other cores to "get the message" to die, or a kernel core can be
466  * finishing work in the processes's address space.
467  *
468  * Implementation aside, the important thing is that we atomically increment
469  * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
470  * the process, so we return an error, which should be handled however is
471  * appropriate.  We currently use spinlocks, but some sort of clever atomics
472  * would work too.
473  *
474  * Also, no one should ever update the refcnt outside of these functions.
475  * Eventually, we'll have Ivy support for this. (TODO)
476  */
477 error_t env_incref(env_t* e)
478 {
479         error_t retval = 0;
480         spin_lock_irqsave(&e->lock);
481         if (e->env_refcnt)
482                 e->env_refcnt++;
483         else
484                 retval = -EBADENV;
485         spin_unlock_irqsave(&e->lock);
486         return retval;
487 }
488
489 /*
490  * When the kernel is done with a process, it decrements its reference count.
491  * When the count hits 0, no one is using it and it should be freed.
492  * "Last one out" actually finalizes the death of the process.  This is tightly
493  * coupled with the previous function (incref)
494  * Be sure to load a different cr3 before calling this!
495  */
496 void env_decref(env_t* e)
497 {
498         spin_lock_irqsave(&e->lock);
499         e->env_refcnt--;
500         spin_unlock_irqsave(&e->lock);
501         // if we hit 0, no one else will increment and we can check outside the lock
502         if (e->env_refcnt == 0)
503                 env_free(e);
504 }
505
506
507 /*
508  * Destroys the given process.  Can be called by a different process (checked
509  * via current), though that's unable to handle an async call (TODO current does
510  * not work asyncly, though it could be made to in the async processing
511  * function. 
512  */
513 void
514 env_destroy(env_t *e)
515 {
516         // TODO: XME race condition with env statuses, esp when running / destroying
517         proc_set_state(e, PROC_DYING);
518
519         /*
520          * If we are currently running this address space on our core, we need a
521          * known good pgdir before releasing the old one.  This is currently the
522          * major practical implication of the kernel caring about a processes
523          * existence (the inc and decref).  This decref corresponds to the incref in
524          * proc_startcore (though it's not the only one).
525          */
526         if (current == e) {
527                 lcr3(boot_cr3);
528                 env_decref(e); // this decref is for the cr3
529         }
530         env_decref(e); // this decref is for the process in general
531         atomic_dec(&num_envs);
532
533         /*
534          * Could consider removing this from destroy and having the caller specify
535          * these actions
536          */
537         // for old envs that die on user cores.  since env run never returns, cores
538         // never get back to their old hlt/relaxed/spin state, so we need to force
539         // them back to an idle function.
540         uint32_t id = core_id();
541         // There is no longer a current process for this core. (TODO: Think about this.)
542         current = NULL;
543         if (id) {
544                 smp_idle();
545                 panic("should never see me");
546         }
547         // else we're core 0 and can do the usual
548
549         /* Instead of picking a new environment to run, or defaulting to the monitor
550          * like before, for now we'll hop into the manager() function, which
551          * dispatches jobs.  Note that for now we start the manager from the top,
552          * and not from where we left off the last time we called manager.  That
553          * would require us to save some context (and a stack to work on) here.
554          */
555         manager();
556         assert(0); // never get here
557 }
558
559 /* ugly, but for now just linearly search through all possible
560  * environments for a runnable one.
561  * the current *policy* is to round-robin the search
562  */
563 void schedule(void)
564 {
565         env_t *e;
566         static int last_picked = 0;
567         
568         for (int i = 0, j = last_picked + 1; i < NENV; i++, j = (j + 1) % NENV) {
569                 e = &envs[ENVX(j)];
570                 // TODO: XME race here, if another core is just about to start this env.
571                 // Fix it by setting the status in something like env_dispatch when
572                 // we have multi-contexted processes
573                 if (e && e->state == PROC_RUNNABLE_S) {
574                         last_picked = j;
575                         env_run(e);
576                 }
577         }
578
579         cprintf("Destroyed the only environment - nothing more to do!\n");
580         while (1)
581                 monitor(NULL);
582 }
583
584 //
585 // Context switch from curenv to env e.
586 // Note: if this is the first call to env_run, curenv is NULL.
587 //  (This function does not return.)
588 //
589 void
590 env_run(env_t *e)
591 {
592         // TODO: XME race here with env destroy on the status and refcnt
593         // Could up the refcnt and down it when a process is not running
594         
595         proc_set_state(e, PROC_RUNNING_S);
596         proc_startcore(e, &e->env_tf);
597 }
598
599 /* This is the top-half of an interrupt handler, where the bottom half is
600  * env_run (which never returns).  Just add it to the delayed work queue,
601  * which (incidentally) can only hold one item at this point.
602  */
603 void run_env_handler(trapframe_t *tf, void *data)
604 {
605         assert(data);
606         struct work job;
607         struct workqueue *workqueue = &per_cpu_info[core_id()].workqueue;
608         { TRUSTEDBLOCK // TODO: how do we make this func_t cast work?
609         job.func = (func_t)env_run;
610         job.data = data;
611         }
612         if (enqueue_work(workqueue, &job))
613                 panic("Failed to enqueue work!");
614 }