Merge branch 'master' into proc-work
[akaros.git] / kern / src / env.c
index 1705425..fa5fd05 100644 (file)
@@ -12,7 +12,7 @@
 #include <atomic.h>
 #include <string.h>
 #include <assert.h>
-#include <env.h>
+#include <process.h>
 #include <pmap.h>
 #include <trap.h>
 #include <monitor.h>
@@ -22,7 +22,7 @@
 #include <ros/error.h>
 
 env_t *envs = NULL;            // All environments
-atomic_t num_envs = atomic_init(0);
+atomic_t num_envs;
 // TODO: make this a struct of info including the pointer and cacheline-align it
 // This lets the kernel know what process is running on the core it traps into.
 // A lot of the Env business, including this and its usage, will change when we
@@ -44,11 +44,10 @@ int
 envid2env(envid_t envid, env_t **env_store, bool checkperm)
 {
        env_t *e;
-       env_t* curenv = curenvs[core_id()];
 
        // If envid is zero, return the current environment.
        if (envid == 0) {
-               *env_store = curenv;
+               *env_store = current;
                return 0;
        }
 
@@ -58,7 +57,7 @@ envid2env(envid_t envid, env_t **env_store, bool checkperm)
        // (i.e., does not refer to a _previous_ environment
        // that used the same slot in the envs[] array).
        e = &envs[ENVX(envid)];
-       if (e->env_status == ENV_FREE || e->env_id != envid) {
+       if (e->state == ENV_FREE || e->env_id != envid) {
                *env_store = 0;
                return -EBADENV;
        }
@@ -68,7 +67,8 @@ envid2env(envid_t envid, env_t **env_store, bool checkperm)
        // If checkperm is set, the specified environment
        // must be either the current environment
        // or an immediate child of the current environment.
-       if (checkperm && e != curenv && e->env_parent_id != curenv->env_id) {
+       // TODO: should check for current being null
+       if (checkperm && e != current && e->env_parent_id != current->env_id) {
                *env_store = 0;
                return -EBADENV;
        }
@@ -82,16 +82,19 @@ envid2env(envid_t envid, env_t **env_store, bool checkperm)
 // and insert them into the env_free_list.
 // Insert in reverse order, so that the first call to env_alloc()
 // returns envs[0].
+// TODO: get rid of this whole array bullshit
 //
 void
 env_init(void)
 {
        int i;
+
+       atomic_init(&num_envs, 0);
        LIST_INIT(&env_free_list);
        assert(envs != NULL);
        for (i = NENV-1; i >= 0; i--) { TRUSTEDBLOCK // asw ivy workaround
                // these should already be set from when i memset'd the array to 0
-               envs[i].env_status = ENV_FREE;
+               envs[i].state = ENV_FREE;
                envs[i].env_id = 0;
                LIST_INSERT_HEAD(&env_free_list, &envs[i], env_link);
        }
@@ -184,6 +187,9 @@ WRITES(e->env_pgdir, e->env_cr3, e->env_procinfo, e->env_syscallring,
 
        // should be able to do this so long as boot_pgdir never has
        // anything put below UTOP
+       // TODO check on this!  had a nasty bug because of it
+       // this is a bit wonky, since if it's not PGSIZE, lots of other things are
+       // screwed up...
        memcpy(e->env_pgdir, boot_pgdir, NPDENTRIES*sizeof(pde_t));
 
        // something like this.  TODO, if you want
@@ -257,8 +263,6 @@ env_alloc(env_t **newenv_store, envid_t parent_id)
        if (!(e = LIST_FIRST(&env_free_list)))
                return -ENOFREEENV;
        
-       //memset((void*)e + sizeof(e->env_link), 0, sizeof(*e) - sizeof(e->env_link));
-
     { INITSTRUCT(*e)
 
        // Allocate and set up the page directory for this environment.
@@ -274,13 +278,13 @@ env_alloc(env_t **newenv_store, envid_t parent_id)
        // Set the basic status variables.
     e->lock = 0;
        e->env_parent_id = parent_id;
-       e->env_status = ENV_RUNNABLE;
+       proc_set_state(e, PROC_CREATED);
        e->env_runs = 0;
        e->env_refcnt = 1;
        e->env_flags = 0;
 
-       memset(&e->env_ancillary_state,0,sizeof(e->env_ancillary_state));
-       memset(&e->env_tf,0,sizeof(e->env_tf));
+       memset(&e->env_ancillary_state, 0, sizeof(e->env_ancillary_state));
+       memset(&e->env_tf, 0, sizeof(e->env_tf));
        env_init_trapframe(e);
 
        // commit the allocation
@@ -288,16 +292,7 @@ env_alloc(env_t **newenv_store, envid_t parent_id)
        *newenv_store = e;
        atomic_inc(&num_envs);
 
-       e->env_tscfreq = system_timing.tsc_freq;
-       // TODO: for now, the only info at procinfo is this env's struct
-       // note that we need to copy this over every time we make a change to env
-       // that we want userspace to see.  also note that we don't even want to
-       // show them all of env, only specific things like PID, PPID, etc
-       memcpy(e->env_procinfo, e, sizeof(env_t));
-
-       env_t* curenv = curenvs[core_id()];
-
-       printk("[%08x] new env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
+       printk("[%08x] new env %08x\n", current ? current->env_id : 0, e->env_id);
        } // INIT_STRUCT
        return 0;
 }
@@ -346,8 +341,6 @@ segment_alloc(env_t *e, void *SNT va, size_t len)
 //
 // Set up the initial program binary, stack, and processor flags
 // for a user process.
-// This function is ONLY called during kernel initialization,
-// before running the first user-mode environment.
 //
 // This function loads all loadable segments from the ELF binary image
 // into the environment's user memory, starting at the appropriate
@@ -356,51 +349,14 @@ segment_alloc(env_t *e, void *SNT va, size_t len)
 // that are marked in the program header as being mapped
 // but not actually present in the ELF file - i.e., the program's bss section.
 //
-// All this is very similar to what our boot loader does, except the boot
-// loader also needs to read the code from disk.  Take a look at
-// boot/main.c to get ideas.
-//
 // Finally, this function maps one page for the program's initial stack.
-//
-// load_icode panics if it encounters problems.
-//  - How might load_icode fail?  What might be wrong with the given input?
-//
 static void
-load_icode(env_t *e, uint8_t *COUNT(size) binary, size_t size)
+load_icode(env_t *SAFE e, uint8_t *COUNT(size) binary, size_t size)
 {
-       // Hints:
-       //  Load each program segment into virtual memory
-       //  at the address specified in the ELF section header.
-       //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
-       //  Each segment's virtual address can be found in ph->p_va
-       //  and its size in memory can be found in ph->p_memsz.
-       //  The ph->p_filesz bytes from the ELF binary, starting at
-       //  'binary + ph->p_offset', should be copied to virtual address
-       //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
-       //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
-       //  Use functions from the previous lab to allocate and map pages.
-       //
-       //  All page protection bits should be user read/write for now.
-       //  ELF segments are not necessarily page-aligned, but you can
-       //  assume for this function that no two segments will touch
-       //  the same virtual page.
-       //
-       //  You may find a function like segment_alloc useful.
-       //
-       //  Loading the segments is much simpler if you can move data
-       //  directly into the virtual addresses stored in the ELF binary.
-       //  So which page directory should be in force during
-       //  this function?
-       //
-       // Hint:
-       //  You must also do something with the program's entry point,
-       //  to make sure that the environment starts executing there.
-       //  What?  (See env_run() and env_pop_tf() below.)
-
        // asw: copy the headers because they might not be aligned.
        elf_t elfhdr;
        proghdr_t phdr;
-       memcpy(&elfhdr,binary,sizeof(elfhdr));
+       memcpy(&elfhdr, binary, sizeof(elfhdr));
 
        int i, r;
 
@@ -411,15 +367,26 @@ load_icode(env_t *e, uint8_t *COUNT(size) binary, size_t size)
 
        // to actually access any pages alloc'd for this environment, we
        // need to have the hardware use this environment's page tables.
-       // we can use e's tables as long as we want, since it has the same
-       // mappings for the kernel as does boot_pgdir
+       uintreg_t old_cr3 = rcr3();
+       /*
+        * Even though we'll decref later and no one should be killing us at this
+        * stage, we're still going to wrap the lcr3s with incref/decref.
+        *
+        * Note we never decref on the old_cr3, since we aren't willing to let it
+        * die.  It's also not clear who the previous process is - sometimes it
+        * isn't even a process (when the kernel loads on its own, and not in
+        * response to a syscall).  Probably need to think more about this (TODO)
+        *
+        * This can get a bit tricky if this code blocks (will need to think about a
+        * decref then), if we try to change states, etc.
+        */
+       env_incref(e);
        lcr3(e->env_cr3);
 
        // TODO: how do we do a runtime COUNT?
-       {TRUSTEDBLOCK
+       {TRUSTEDBLOCK // zra: TRUSTEDBLOCK until validation is done.
        for (i = 0; i < elfhdr.e_phnum; i++) {
-               memcpy(&phdr,binary+elfhdr.e_phoff+i*sizeof(phdr),sizeof(phdr));
-        // zra: TRUSTEDBLOCK until validation is done.
+               memcpy(&phdr, binary + elfhdr.e_phoff + i*sizeof(phdr), sizeof(phdr));
                if (phdr.p_type != ELF_PROG_LOAD)
                        continue;
         // TODO: validate elf header fields!
@@ -430,12 +397,15 @@ load_icode(env_t *e, uint8_t *COUNT(size) binary, size_t size)
                memset((void*)phdr.p_va + phdr.p_filesz, 0, phdr.p_memsz - phdr.p_filesz);
        }}
 
-       env_set_program_counter(e,elfhdr.e_entry);
+       env_set_program_counter(e, elfhdr.e_entry);
 
        // Now map one page for the program's initial stack
        // at virtual address USTACKTOP - PGSIZE.
-
        segment_alloc(e, (void*SNT)(USTACKTOP - PGSIZE), PGSIZE);
+
+       // reload the original address space
+       lcr3(old_cr3);
+       env_decref(e);
 }
 
 //
@@ -445,8 +415,10 @@ env_t* env_create(uint8_t *binary, size_t size)
 {
        env_t *e;
        int r;
-
-       if ((r = env_alloc(&e, 0)) < 0)
+       envid_t curid;
+       
+       curid = (current ? current->env_id : 0);        
+       if ((r = env_alloc(&e, curid)) < 0)
                panic("env_create: %e", r);
        load_icode(e, binary, size);
        return e;
@@ -461,16 +433,13 @@ env_free(env_t *e)
        physaddr_t pa;
 
        // Note the environment's demise.
-       env_t* curenv = curenvs[core_id()];
-       cprintf("[%08x] free env %08x\n", curenv ? curenv->env_id : 0, e->env_id);
+       printk("[%08x] free env %08x\n", current ? current->env_id : 0, e->env_id);
+       // All parts of the kernel should have decref'd before env_free was called. 
+       assert(e->env_refcnt == 0);
 
        // Flush all mapped pages in the user portion of the address space
        env_user_mem_free(e);
 
-       // Moved to page_decref
-       // need a known good pgdir before releasing the old one
-       //lcr3(PADDR(boot_pgdir));
-
        // free the page directory
        pa = e->env_cr3;
        e->env_pgdir = 0;
@@ -478,70 +447,101 @@ env_free(env_t *e)
        page_decref(pa2page(pa));
 
        // return the environment to the free list
-       e->env_status = ENV_FREE;
+       e->state = ENV_FREE;
        LIST_INSERT_HEAD(&env_free_list, e, env_link);
 }
 
 /*
- * This allows the kernel to keep this process around, in case it is being used
- * in some asynchronous processing.
+ * The process refcnt is the number of places the process 'exists' in the
+ * system.  Creation counts as 1.  Having your page tables loaded somewhere
+ * (lcr3) counts as another 1.  A non-RUNNING_* process should have refcnt at
+ * least 1.  If the kernel is on another core and in a processes address space
+ * (like processing its backring), that counts as another 1.
+ *
+ * Note that the actual loading and unloading of cr3 is up to the caller, since
+ * that's not the only use for this (and decoupling is more flexible).
+ *
  * The refcnt should always be greater than 0 for processes that aren't dying.
  * When refcnt is 0, the process is dying and should not allow any more increfs.
- * TODO: Make sure this is never called from an interrupt handler (irq_save)
+ * A process can be dying with a refcnt greater than 0, since it could be
+ * waiting for other cores to "get the message" to die, or a kernel core can be
+ * finishing work in the processes's address space.
+ *
+ * Implementation aside, the important thing is that we atomically increment
+ * only if it wasn't already 0.  If it was 0, then we shouldn't be attaching to
+ * the process, so we return an error, which should be handled however is
+ * appropriate.  We currently use spinlocks, but some sort of clever atomics
+ * would work too.
+ *
+ * Also, no one should ever update the refcnt outside of these functions.
+ * Eventually, we'll have Ivy support for this. (TODO)
  */
 error_t env_incref(env_t* e)
 {
        error_t retval = 0;
-       spin_lock(&e->lock);
+       spin_lock_irqsave(&e->lock);
        if (e->env_refcnt)
                e->env_refcnt++;
        else
                retval = -EBADENV;
-       spin_unlock(&e->lock);
+       spin_unlock_irqsave(&e->lock);
        return retval;
 }
 
 /*
  * When the kernel is done with a process, it decrements its reference count.
  * When the count hits 0, no one is using it and it should be freed.
- * env_destroy calls this.
- * TODO: Make sure this is never called from an interrupt handler (irq_save)
+ * "Last one out" actually finalizes the death of the process.  This is tightly
+ * coupled with the previous function (incref)
+ * Be sure to load a different cr3 before calling this!
  */
 void env_decref(env_t* e)
 {
-       // need a known good pgdir before releasing the old one
-       // sometimes env_free is called on a different core than decref
-       lcr3(PADDR(boot_pgdir));
-
-       spin_lock(&e->lock);
+       spin_lock_irqsave(&e->lock);
        e->env_refcnt--;
-       spin_unlock(&e->lock);
+       spin_unlock_irqsave(&e->lock);
        // if we hit 0, no one else will increment and we can check outside the lock
        if (e->env_refcnt == 0)
                env_free(e);
 }
 
 
-//
-// Frees environment e.
-// If e was the current env, then runs a new environment (and does not return
-// to the caller).
-//
+/*
+ * Destroys the given process.  Can be called by a different process (checked
+ * via current), though that's unable to handle an async call (TODO current does
+ * not work asyncly, though it could be made to in the async processing
+ * function. 
+ */
 void
 env_destroy(env_t *e)
 {
-       // TODO: race condition with env statuses, esp when running / destroying
-       e->env_status = ENV_DYING;
-
-       env_decref(e);
+       // TODO: XME race condition with env statuses, esp when running / destroying
+       proc_set_state(e, PROC_DYING);
+
+       /*
+        * If we are currently running this address space on our core, we need a
+        * known good pgdir before releasing the old one.  This is currently the
+        * major practical implication of the kernel caring about a processes
+        * existence (the inc and decref).  This decref corresponds to the incref in
+        * proc_startcore (though it's not the only one).
+        */
+       if (current == e) {
+               lcr3(boot_cr3);
+               env_decref(e); // this decref is for the cr3
+       }
+       env_decref(e); // this decref is for the process in general
        atomic_dec(&num_envs);
 
+       /*
+        * Could consider removing this from destroy and having the caller specify
+        * these actions
+        */
        // for old envs that die on user cores.  since env run never returns, cores
        // never get back to their old hlt/relaxed/spin state, so we need to force
        // them back to an idle function.
        uint32_t id = core_id();
-       // There is no longer a curenv for this core. (TODO: Think about this.)
-       curenvs[id] = NULL;
+       // There is no longer a current process for this core. (TODO: Think about this.)
+       current = NULL;
        if (id) {
                smp_idle();
                panic("should never see me");
@@ -569,10 +569,10 @@ void schedule(void)
        
        for (int i = 0, j = last_picked + 1; i < NENV; i++, j = (j + 1) % NENV) {
                e = &envs[ENVX(j)];
-               // TODO: race here, if another core is just about to start this env.
+               // TODO: XME race here, if another core is just about to start this env.
                // Fix it by setting the status in something like env_dispatch when
                // we have multi-contexted processes
-               if (e && e->env_status == ENV_RUNNABLE) {
+               if (e && e->state == PROC_RUNNABLE_S) {
                        last_picked = j;
                        env_run(e);
                }
@@ -591,45 +591,26 @@ void schedule(void)
 void
 env_run(env_t *e)
 {
-       // Step 1: If this is a context switch (a new environment is running),
-       //         then set 'curenv' to the new environment,
-       //         update its 'env_runs' counter, and
-       //         and use lcr3() to switch to its address space.
-       // Step 2: Use env_pop_tf() to restore the environment's
-       //         registers and drop into user mode in the
-       //         environment.
-
-       // Hint: This function loads the new environment's state from
-       //      e->env_tf.  Go back through the code you wrote above
-       //      and make sure you have set the relevant parts of
-       //      e->env_tf to sensible values.
-
-       // TODO: race here with env destroy on the status and refcnt
+       // TODO: XME race here with env destroy on the status and refcnt
        // Could up the refcnt and down it when a process is not running
-       e->env_status = ENV_RUNNING;
-       if (e != curenvs[core_id()]) {
-               curenvs[core_id()] = e;
-               e->env_runs++;
-               lcr3(e->env_cr3);
-       }
-
-       env_pop_ancillary_state(e);
-
-       env_pop_tf(&e->env_tf);
+       
+       proc_set_state(e, PROC_RUNNING_S);
+       proc_startcore(e, &e->env_tf);
 }
 
 /* This is the top-half of an interrupt handler, where the bottom half is
  * env_run (which never returns).  Just add it to the delayed work queue,
- * which isn't really a queue yet.
+ * which (incidentally) can only hold one item at this point.
  */
-void run_env_handler(trapframe_t *tf, voiddata)
+void run_env_handler(trapframe_t *tf, void *data)
 {
        assert(data);
-       per_cpu_info_t *cpuinfo = &per_cpu_info[core_id()];
-       spin_lock_irqsave(&cpuinfo->lock);
+       struct work job;
+       struct workqueue *workqueue = &per_cpu_info[core_id()].workqueue;
        { TRUSTEDBLOCK // TODO: how do we make this func_t cast work?
-       cpuinfo->delayed_work.func = (func_t)env_run;
-       cpuinfo->delayed_work.data = data;
+       job.func = (func_t)env_run;
+       job.data = data;
        }
-       spin_unlock_irqsave(&cpuinfo->lock);
+       if (enqueue_work(workqueue, &job))
+               panic("Failed to enqueue work!");
 }