Workqueue interface and coreid()
[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/x86.h>
8 #include <arch/mmu.h>
9 #include <arch/elf.h>
10 #include <arch/apic.h>
11 #include <arch/smp.h>
12
13 #include <atomic.h>
14 #include <string.h>
15 #include <assert.h>
16 #include <process.h>
17 #include <pmap.h>
18 #include <trap.h>
19 #include <monitor.h>
20 #include <manager.h>
21
22 #include <ros/syscall.h>
23 #include <ros/error.h>
24
25 env_t *envs = NULL;             // All environments
26 uint32_t num_envs = 0;          // Number of envs
27 // TODO: make this a struct of info including the pointer and cacheline-align it
28 // This lets the kernel know what process is running on the core it traps into.
29 // A lot of the Env business, including this and its usage, will change when we
30 // redesign the env as a multi-process.
31 env_t* curenvs[MAX_NUM_CPUS] = {[0 ... (MAX_NUM_CPUS-1)] NULL};
32 static env_list_t env_free_list;        // Free list
33
34 #define ENVGENSHIFT     12              // >= LOGNENV
35
36 //
37 // Converts an envid to an env pointer.
38 //
39 // RETURNS
40 //   0 on success, -EBADENV on error.
41 //   On success, sets *env_store to the environment.
42 //   On error, sets *env_store to NULL.
43 //
44 int
45 envid2env(envid_t envid, env_t **env_store, bool checkperm)
46 {
47         env_t *e;
48
49         // If envid is zero, return the current environment.
50         if (envid == 0) {
51                 *env_store = current;
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->state == 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         // TODO: should check for current being null
72         if (checkperm && e != current && e->env_parent_id != current->env_id) {
73                 *env_store = 0;
74                 return -EBADENV;
75         }
76
77         *env_store = e;
78         return 0;
79 }
80
81 //
82 // Mark all environments in 'envs' as free, set their env_ids to 0,
83 // and insert them into the env_free_list.
84 // Insert in reverse order, so that the first call to env_alloc()
85 // returns envs[0].
86 // TODO: get rid of this whole array bullshit
87 //
88 void
89 env_init(void)
90 {
91         int i;
92         LIST_INIT(&env_free_list);
93         for (i = NENV-1; i >= 0; i--) {
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_procdata,
114        e->env_sysbackring)
115 {
116         int i, r;
117         page_t *pgdir = NULL, *pginfo = NULL, *pgdata = NULL;
118
119         // Allocate pages for the page directory, shared info, and shared data pages
120         r = page_alloc(&pgdir);
121         r = page_alloc(&pginfo);
122         r = page_alloc(&pgdata);
123         if (r < 0) {
124                 page_free(pgdir);
125                 page_free(pginfo);
126                 return r;
127         }
128
129         // Now, set e->env_pgdir and e->env_cr3,
130         // and initialize the page directory.
131         //
132         // Hint:
133         //    - The VA space of all envs is identical above UTOP
134         //      (except at VPT and UVPT, which we've set below).
135         //      (and not for UINFO either)
136         //      See inc/memlayout.h for permissions and layout.
137         //      Can you use boot_pgdir as a template?  Hint: Yes.
138         //      (Make sure you got the permissions right in Lab 2.)
139         //    - The initial VA below UTOP is empty.
140         //    - You do not need to make any more calls to page_alloc.
141         //    - Note: pp_ref is not maintained for most physical pages
142         //      mapped above UTOP -- but you do need to increment
143         //      env_pgdir's pp_ref!
144
145         // need to up pgdir's reference, since it will never be done elsewhere
146         pgdir->pp_ref++;
147         e->env_pgdir = page2kva(pgdir);
148         e->env_cr3 = page2pa(pgdir);
149         e->env_procinfo = page2kva(pginfo);
150         e->env_procdata = page2kva(pgdata);
151
152         memset(e->env_pgdir, 0, PGSIZE);
153         memset(e->env_procinfo, 0, PGSIZE);
154         memset(e->env_procdata, 0, PGSIZE);
155
156         // Initialize the generic syscall ring buffer
157         SHARED_RING_INIT((syscall_sring_t *SAFE)e->env_procdata);
158         // Initialize the backend of the ring buffer
159         BACK_RING_INIT(&e->env_sysbackring, (syscall_sring_t *SAFE)e->env_procdata,
160                        PGSIZE);
161
162         // should be able to do this so long as boot_pgdir never has
163         // anything put below UTOP
164         // TODO check on this!  had a nasty bug because of it
165         memcpy(e->env_pgdir, boot_pgdir, PGSIZE);
166
167         // something like this.  TODO, if you want
168         //memcpy(&e->env_pgdir[PDX(UTOP)], &boot_pgdir[PDX(UTOP)], PGSIZE - PDX(UTOP));
169         // check with
170         // assert(memcmp(e->env_pgdir, boot_pgdir, PGSIZE) == 0);
171
172         // VPT and UVPT map the env's own page table, with
173         // different permissions.
174         e->env_pgdir[PDX(VPT)]  = e->env_cr3 | PTE_P | PTE_W;
175         e->env_pgdir[PDX(UVPT)] = e->env_cr3 | PTE_P | PTE_U;
176
177         // Insert the per-process info and data pages into this process's pgdir
178         // I don't want to do these two pages later (like with the stack), since
179         // the kernel wants to keep pointers to it easily.
180         // Could place all of this with a function that maps a shared memory page
181         // that can work between any two address spaces or something.
182         r = page_insert(e->env_pgdir, pginfo, (void*SNT)UINFO, PTE_U);
183         r = page_insert(e->env_pgdir, pgdata, (void*SNT)UDATA, PTE_U | PTE_W);
184         if (r < 0) {
185                 // note that we can't currently deallocate the pages created by
186                 // pgdir_walk (inside insert).  should be able to gather them up when
187                 // we destroy environments and their page tables.
188                 page_free(pgdir);
189                 page_free(pginfo);
190                 page_free(pgdata);
191                 return r;
192         }
193
194         /* Shared page for all processes.  Can't be trusted, but still very useful
195          * at this stage for us.  Consider removing when we have real processes.
196          * (TODO).  Note the page is alloced only the first time through
197          */
198         static page_t* shared_page = 0;
199         if (!shared_page)
200                 page_alloc(&shared_page);
201         // Up it, so it never goes away.  One per user, plus one from page_alloc
202         // This is necessary, since it's in the per-process range of memory that
203         // gets freed during page_free.
204         shared_page->pp_ref++;
205
206         // Inserted into every process's address space at UGDATA
207         page_insert(e->env_pgdir, shared_page, (void*SNT)UGDATA, PTE_U | PTE_W);
208
209         return 0;
210 }
211
212 //
213 // Allocates and initializes a new environment.
214 // On success, the new environment is stored in *newenv_store.
215 //
216 // Returns 0 on success, < 0 on failure.  Errors include:
217 //      -ENOFREEENV if all NENVS environments are allocated
218 //      -ENOMEM on memory exhaustion
219 //
220 int
221 env_alloc(env_t **newenv_store, envid_t parent_id)
222 {
223         int32_t generation;
224         int r;
225         env_t *e;
226
227         if (!(e = LIST_FIRST(&env_free_list)))
228                 return -ENOFREEENV;
229         
230     { INITSTRUCT(*e)
231
232         // Allocate and set up the page directory for this environment.
233         if ((r = env_setup_vm(e)) < 0)
234                 return r;
235
236         // Generate an env_id for this environment.
237         generation = (e->env_id + (1 << ENVGENSHIFT)) & ~(NENV - 1);
238         if (generation <= 0)    // Don't create a negative env_id.
239                 generation = 1 << ENVGENSHIFT;
240         e->env_id = generation | (e - envs);
241
242         // Set the basic status variables.
243     e->lock = 0;
244         e->env_parent_id = parent_id;
245         proc_set_state(e, PROC_CREATED);
246         e->env_runs = 0;
247         e->env_refcnt = 1;
248         e->env_flags = 0;
249
250         // Clear out all the saved register state,
251         // to prevent the register values
252         // of a prior environment inhabiting this Env structure
253         // from "leaking" into our new environment.
254         memset(&e->env_tf, 0, sizeof(e->env_tf));
255
256         // Set up appropriate initial values for the segment registers.
257         // GD_UD is the user data segment selector in the GDT, and
258         // GD_UT is the user text segment selector (see inc/memlayout.h).
259         // The low 2 bits of each segment register contains the
260         // Requestor Privilege Level (RPL); 3 means user mode.
261         e->env_tf.tf_ds = GD_UD | 3;
262         e->env_tf.tf_es = GD_UD | 3;
263         e->env_tf.tf_ss = GD_UD | 3;
264         e->env_tf.tf_esp = USTACKTOP;
265         e->env_tf.tf_cs = GD_UT | 3;
266         // You will set e->env_tf.tf_eip later.
267         // set the env's EFLAGSs to have interrupts enabled
268         e->env_tf.tf_eflags |= 0x00000200; // bit 9 is the interrupts-enabled
269
270         // commit the allocation
271         LIST_REMOVE(e, env_link);
272         *newenv_store = e;
273         atomic_inc(&num_envs);
274
275         e->env_tscfreq = system_timing.tsc_freq;
276         // TODO: for now, the only info at procinfo is this env's struct
277         // note that we need to copy this over every time we make a change to env
278         // that we want userspace to see.  also note that we don't even want to
279         // show them all of env, only specific things like PID, PPID, etc
280         memcpy(e->env_procinfo, e, sizeof(env_t));
281
282         printk("[%08x] new env %08x\n", current ? current->env_id : 0, e->env_id);
283         } // INIT_STRUCT
284         return 0;
285 }
286
287 //
288 // Allocate len bytes of physical memory for environment env,
289 // and map it at virtual address va in the environment's address space.
290 // Does not zero or otherwise initialize the mapped pages in any way.
291 // Pages should be writable by user and kernel.
292 // Panic if any allocation attempt fails.
293 //
294 static void
295 segment_alloc(env_t *e, void *SNT va, size_t len)
296 {
297         void *SNT start, *SNT end;
298         size_t num_pages;
299         int i, r;
300         page_t *page;
301         pte_t *pte;
302
303         start = ROUNDDOWN(va, PGSIZE);
304         end = ROUNDUP(va + len, PGSIZE);
305         if (start >= end)
306                 panic("Wrap-around in memory allocation addresses!");
307         if ((uintptr_t)end > UTOP)
308                 panic("Attempting to map above UTOP!");
309         // page_insert/pgdir_walk alloc a page and read/write to it via its address
310         // starting from pgdir (e's), so we need to be using e's pgdir
311         assert(e->env_cr3 == rcr3());
312         num_pages = PPN(end - start);
313         for (i = 0; i < num_pages; i++, start += PGSIZE) {
314                 // skip if a page is already mapped.  yes, page_insert will page_remove
315                 // whatever page was already there, but if we are seg allocing adjacent
316                 // regions, we don't want to destroy that old mapping/page
317                 // though later on we are told we can ignore this...
318                 pte = pgdir_walk(e->env_pgdir, start, 0);
319                 if (pte && *pte & PTE_P)
320                         continue;
321                 if ((r = page_alloc(&page)) < 0)
322                         panic("segment_alloc: %e", r);
323                 page_insert(e->env_pgdir, page, start, PTE_U | PTE_W);
324         }
325 }
326
327 //
328 // Set up the initial program binary, stack, and processor flags
329 // for a user process.
330 // This function is ONLY called during kernel initialization,
331 // before running the first user-mode environment.
332 //
333 // This function loads all loadable segments from the ELF binary image
334 // into the environment's user memory, starting at the appropriate
335 // virtual addresses indicated in the ELF program header.
336 // At the same time it clears to zero any portions of these segments
337 // that are marked in the program header as being mapped
338 // but not actually present in the ELF file - i.e., the program's bss section.
339 //
340 // All this is very similar to what our boot loader does, except the boot
341 // loader also needs to read the code from disk.  Take a look at
342 // boot/main.c to get ideas.
343 //
344 // Finally, this function maps one page for the program's initial stack.
345 //
346 // load_icode panics if it encounters problems.
347 //  - How might load_icode fail?  What might be wrong with the given input?
348 //
349 static void
350 load_icode(env_t *e, uint8_t *COUNT(size) binary, size_t size)
351 {
352         // Hints:
353         //  Load each program segment into virtual memory
354         //  at the address specified in the ELF section header.
355         //  You should only load segments with ph->p_type == ELF_PROG_LOAD.
356         //  Each segment's virtual address can be found in ph->p_va
357         //  and its size in memory can be found in ph->p_memsz.
358         //  The ph->p_filesz bytes from the ELF binary, starting at
359         //  'binary + ph->p_offset', should be copied to virtual address
360         //  ph->p_va.  Any remaining memory bytes should be cleared to zero.
361         //  (The ELF header should have ph->p_filesz <= ph->p_memsz.)
362         //  Use functions from the previous lab to allocate and map pages.
363         //
364         //  All page protection bits should be user read/write for now.
365         //  ELF segments are not necessarily page-aligned, but you can
366         //  assume for this function that no two segments will touch
367         //  the same virtual page.
368         //
369         //  You may find a function like segment_alloc useful.
370         //
371         //  Loading the segments is much simpler if you can move data
372         //  directly into the virtual addresses stored in the ELF binary.
373         //  So which page directory should be in force during
374         //  this function?
375         //
376         // Hint:
377         //  You must also do something with the program's entry point,
378         //  to make sure that the environment starts executing there.
379         //  What?  (See env_run() and env_pop_tf() below.)
380
381         elf_t *elfhdr = (elf_t *)binary;
382         int i, r;
383
384         // is this an elf?
385         assert(elfhdr->e_magic == ELF_MAGIC);
386         // make sure we have proghdrs to load
387         assert(elfhdr->e_phnum);
388
389         // to actually access any pages alloc'd for this environment, we
390         // need to have the hardware use this environment's page tables.
391         uintreg_t old_cr3 = rcr3();
392         lcr3(e->env_cr3);
393
394         // TODO: how do we do a runtime COUNT?
395         {TRUSTEDBLOCK
396         proghdr_t* phdr = (proghdr_t*)(binary + elfhdr->e_phoff);
397         for (i = 0; i < elfhdr->e_phnum; i++, phdr++) {
398         // zra: TRUSTEDBLOCK until validation is done.
399                 if (phdr->p_type != ELF_PROG_LOAD)
400                         continue;
401         // TODO: validate elf header fields!
402                 // seg alloc creates PTE_U|PTE_W pages.  if you ever want to change
403                 // this, there will be issues with overlapping sections
404                 segment_alloc(e, (void*SNT)phdr->p_va, phdr->p_memsz);
405                 memcpy((void*)phdr->p_va, binary + phdr->p_offset, phdr->p_filesz);
406                 memset((void*)phdr->p_va + phdr->p_filesz, 0, phdr->p_memsz - phdr->p_filesz);
407         }}
408
409         e->env_tf.tf_eip = elfhdr->e_entry;
410
411         // Now map one page for the program's initial stack
412         // at virtual address USTACKTOP - PGSIZE.
413         segment_alloc(e, (void*SNT)(USTACKTOP - PGSIZE), PGSIZE);
414
415         // reload the original address space
416         lcr3(old_cr3);
417 }
418
419 //
420 // Allocates a new env and loads the named elf binary into it.
421 //
422 env_t* env_create(uint8_t *binary, size_t size)
423 {
424         env_t *e;
425         int r;
426         envid_t curid;
427         
428         curid = (current ? current->env_id : 0);        
429         if ((r = env_alloc(&e, curid)) < 0)
430                 panic("env_create: %e", r);
431         load_icode(e, binary, size);
432         return e;
433 }
434
435 //
436 // Frees env e and all memory it uses.
437 //
438 void
439 env_free(env_t *e)
440 {
441         pte_t *pt;
442         uint32_t pdeno, pteno;
443         physaddr_t pa;
444
445         // Note the environment's demise.
446         cprintf("[%08x] free env %08x\n", current ? current->env_id : 0, e->env_id);
447
448         // Flush all mapped pages in the user portion of the address space
449         static_assert(UTOP % PTSIZE == 0);
450         for (pdeno = 0; pdeno < PDX(UTOP); pdeno++) {
451
452                 // only look at mapped page tables
453                 if (!(e->env_pgdir[pdeno] & PTE_P))
454                         continue;
455
456                 // find the pa and va of the page table
457                 pa = PTE_ADDR(e->env_pgdir[pdeno]);
458                 pt = (pte_t*COUNT(NPTENTRIES)) KADDR(pa);
459
460                 // unmap all PTEs in this page table
461                 for (pteno = 0; pteno <= PTX(~0); pteno++) {
462                         if (pt[pteno] & PTE_P)
463                                 page_remove(e->env_pgdir, PGADDR(pdeno, pteno, 0));
464                 }
465
466                 // free the page table itself
467                 e->env_pgdir[pdeno] = 0;
468                 page_decref(pa2page(pa));
469         }
470
471         // Moved to page_decref
472         // need a known good pgdir before releasing the old one
473         //lcr3(boot_cr3);
474
475         // free the page directory
476         pa = e->env_cr3;
477         e->env_pgdir = 0;
478         e->env_cr3 = 0;
479         page_decref(pa2page(pa));
480
481         // return the environment to the free list
482         e->state = ENV_FREE;
483         LIST_INSERT_HEAD(&env_free_list, e, env_link);
484 }
485
486 /*
487  * This allows the kernel to keep this process around, in case it is being used
488  * in some asynchronous processing.
489  * The refcnt should always be greater than 0 for processes that aren't dying.
490  * When refcnt is 0, the process is dying and should not allow any more increfs.
491  * TODO: Make sure this is never called from an interrupt handler (irq_save)
492  */
493 error_t env_incref(env_t* e)
494 {
495         error_t retval = 0;
496         spin_lock(&e->lock);
497         if (e->env_refcnt)
498                 e->env_refcnt++;
499         else
500                 retval = -EBADENV;
501         spin_unlock(&e->lock);
502         return retval;
503 }
504
505 /*
506  * When the kernel is done with a process, it decrements its reference count.
507  * When the count hits 0, no one is using it and it should be freed.
508  * env_destroy calls this.
509  * TODO: Make sure this is never called from an interrupt handler (irq_save)
510  */
511 void env_decref(env_t* e)
512 {
513         // need a known good pgdir before releasing the old one
514         // sometimes env_free is called on a different core than decref
515         lcr3(boot_cr3);
516
517         spin_lock(&e->lock);
518         e->env_refcnt--;
519         spin_unlock(&e->lock);
520         // if we hit 0, no one else will increment and we can check outside the lock
521         if (e->env_refcnt == 0)
522                 env_free(e);
523 }
524
525
526 //
527 // Frees environment e.
528 // If e was the current env, then runs a new environment (and does not return
529 // to the caller).
530 //
531 void
532 env_destroy(env_t *e)
533 {
534         // TODO: XME race condition with env statuses, esp when running / destroying
535         proc_set_state(e, PROC_DYING);
536
537         env_decref(e);
538         atomic_dec(&num_envs);
539
540         // for old envs that die on user cores.  since env run never returns, cores
541         // never get back to their old hlt/relaxed/spin state, so we need to force
542         // them back to an idle function.
543         uint32_t id = coreid();
544         // There is no longer a current process for this core. (TODO: Think about this.)
545         current = NULL;
546         if (id) {
547                 smp_idle();
548                 panic("should never see me");
549         }
550         // else we're core 0 and can do the usual
551
552         /* Instead of picking a new environment to run, or defaulting to the monitor
553          * like before, for now we'll hop into the manager() function, which
554          * dispatches jobs.  Note that for now we start the manager from the top,
555          * and not from where we left off the last time we called manager.  That
556          * would require us to save some context (and a stack to work on) here.
557          */
558         manager();
559         assert(0); // never get here
560 }
561
562 /* ugly, but for now just linearly search through all possible
563  * environments for a runnable one.
564  * the current *policy* is to round-robin the search
565  */
566 void schedule(void)
567 {
568         env_t *e;
569         static int last_picked = 0;
570         
571         for (int i = 0, j = last_picked + 1; i < NENV; i++, j = (j + 1) % NENV) {
572                 e = &envs[ENVX(j)];
573                 // TODO: XME race here, if another core is just about to start this env.
574                 // Fix it by setting the status in something like env_dispatch when
575                 // we have multi-contexted processes
576                 if (e && e->state == PROC_RUNNABLE_S) {
577                         last_picked = j;
578                         env_run(e);
579                 }
580         }
581
582         cprintf("Destroyed the only environment - nothing more to do!\n");
583         while (1)
584                 monitor(NULL);
585 }
586
587 //
588 // Restores the register values in the Trapframe with the 'iret' instruction.
589 // This exits the kernel and starts executing some environment's code.
590 // This function does not return.
591 //
592 void env_pop_tf(trapframe_t *tf)
593 {
594         asm volatile ("movl %0,%%esp;           "
595                       "popal;                   "
596                       "popl %%es;               "
597                       "popl %%ds;               "
598                       "addl $0x8,%%esp;         "
599                       "iret                     "
600                       : : "g" (tf) : "memory");
601         panic("iret failed");  /* mostly to placate the compiler */
602 }
603
604 /* Return path of sysexit.  See sysenter_handler's asm for details. */
605 void env_pop_tf_sysexit(trapframe_t *tf)
606 {
607         asm volatile ("movl %0,%%esp;           "
608                       "popal;                   "
609                       "popl %%es;               "
610                       "popl %%ds;               "
611                       "addl $0x10, %%esp;       "
612                       "popfl;                   "
613                       "movl %%ebp, %%ecx;       "
614                       "movl %%esi, %%edx;       "
615                       "sysexit                  "
616                       : : "g" (tf) : "memory");
617         panic("sysexit failed");  /* mostly to placate the compiler */
618 }
619
620 //
621 // Context switch from current process to env e.
622 // Note: if this is the first call to env_run, current is NULL.
623 //  (This function does not return.)
624 //
625 void
626 env_run(env_t *e)
627 {
628         // Step 1: If this is a context switch (a new environment is running),
629         //         then set 'current' to the new environment,
630         //         update its 'env_runs' counter, and
631         //         and use lcr3() to switch to its address space.
632         // Step 2: Use env_pop_tf() to restore the environment's
633         //         registers and drop into user mode in the
634         //         environment.
635
636         // Hint: This function loads the new environment's state from
637         //      e->env_tf.  Go back through the code you wrote above
638         //      and make sure you have set the relevant parts of
639         //      e->env_tf to sensible values.
640
641         // TODO: XME race here with env destroy on the status and refcnt
642         // Could up the refcnt and down it when a process is not running
643         
644         // TODO XME need different code paths for retarting a core (pop) and
645         // running for the first time
646         if (e->state == PROC_RUNNABLE_S)
647                 proc_set_state(e, PROC_RUNNING_S);
648
649         if (e != current) {
650                 current = e;
651                 e->env_runs++;
652                 lcr3(e->env_cr3); // think about the refcnt here
653         }
654         /* If the process entered the kernel via sysenter, we need to leave via
655          * sysexit.  sysenter trapframes have 0 for a CS, which is pushed in
656          * sysenter_handler.
657          *
658          *           FFFFFFFFF UU     UU    CCCCCC  KK     KK  #
659          *           FF        UU     UU  CCC       KK    KK   #
660          *           FF        UU     UU CC         KK  KK     #
661          *           FFFFFF    UU     UU CC         KKKKK      #
662          *           FF        UU     UU CC         KK  KK     #
663          *           FF         UU   UU   CCC       KK    KK    
664          *           FF          UUUUU      CCCCCC  KK     KK  #
665          *
666          * TODO think about when we no longer need the stack, in case we are
667          * preempted and expected to run again from somewhere else.  we can't
668          * expect to have the kernel stack around anymore.
669          * I think we need to make it such that the kernel in "process context"
670          * never gets removed from the core (displaced from its stack)
671          * would like to leave interrupts on too, so long as we come back.
672          * Consider a moveable flag or something
673          */
674         /* workqueue with the todo item put there by the interrupt handler when
675          * it realizes we were in the kernel in the first place.  disable ints
676          * before checking the queue and deciding to pop out or whatever.
677          */
678         if (e->env_tf.tf_cs)
679                 env_pop_tf(&e->env_tf);
680         else
681                 env_pop_tf_sysexit(&e->env_tf);
682 }
683
684 /* This is the top-half of an interrupt handler, where the bottom half is
685  * env_run (which never returns).  Just add it to the delayed work queue,
686  * which (incidentally) can only hold one item at this point.
687  */
688 void run_env_handler(trapframe_t *tf, void *data)
689 {
690         assert(data);
691         struct work job;
692         struct workqueue *workqueue = &per_cpu_info[coreid()].workqueue;
693         { TRUSTEDBLOCK // TODO: how do we make this func_t cast work?
694         job.func = (func_t)env_run;
695         job.data = data;
696         }
697         if (enqueue_work(workqueue, &job))
698                 panic("Failed to enqueue work!");
699 }