Rename RCU CB context to 'cannot block' context
[akaros.git] / kern / src / kthread.c
index 76febba..ea56d27 100644 (file)
 #include <smp.h>
 #include <schedule.h>
 #include <kstack.h>
+#include <kmalloc.h>
 #include <arch/uaccess.h>
 
+#define KSTACK_NR_GUARD_PGS            1
+#define KSTACK_GUARD_SZ                        (KSTACK_NR_GUARD_PGS * PGSIZE)
+static struct kmem_cache *kstack_cache;
+
+/* We allocate KSTKSIZE + PGSIZE vaddrs.  So for one-page stacks, we get two
+ * pages.  blob points to the bottom of this space.  Our job is to allocate the
+ * physical pages for the stack and set up the virtual-to-physical mappings. */
+int kstack_ctor(void *blob, void *priv, int flags)
+{
+       void *stackbot;
+
+       stackbot = kpages_alloc(KSTKSIZE, flags);
+       if (!stackbot)
+               return -1;
+       if (map_vmap_segment((uintptr_t)blob, 0x123456000, KSTACK_NR_GUARD_PGS,
+                                PTE_NONE))
+               goto error;
+       if (map_vmap_segment((uintptr_t)blob + KSTACK_GUARD_SZ, PADDR(stackbot),
+                                KSTKSIZE / PGSIZE, PTE_KERN_RW))
+               goto error;
+       return 0;
+error:
+       /* On failure, we only need to undo what our dtor would do.  The unmaps
+        * happen in the vmap_arena ffunc. */
+       kpages_free(stackbot, KSTKSIZE);
+       return -1;
+}
+
+/* The vmap_arena free will unmap the vaddrs on its own.  We just need to free
+ * the physical memory we allocated in ctor.  Although we still have mappings
+ * and TLB entries pointing to the memory after we free it (and thus it can be
+ * reused), this is no more dangerous than just freeing the stack.  Errant
+ * pointers into an old kstack are still dangerous. */
+void kstack_dtor(void *blob, void *priv)
+{
+       void *stackbot;
+       pte_t pte;
+
+       pte = pgdir_walk(boot_pgdir, blob + KSTACK_GUARD_SZ, 0);
+       assert(pte_walk_okay(pte));
+       stackbot = KADDR(pte_get_paddr(pte));
+       kpages_free(stackbot, KSTKSIZE);
+}
+
 uintptr_t get_kstack(void)
 {
-       uintptr_t stackbot;
-       if (KSTKSIZE == PGSIZE)
-               stackbot = (uintptr_t)kpage_alloc_addr();
-       else
-               stackbot = (uintptr_t)get_cont_pages(KSTKSHIFT - PGSHIFT, 0);
-       assert(stackbot);
-       return stackbot + KSTKSIZE;
+       void *blob;
+
+       blob = kmem_cache_alloc(kstack_cache, MEM_ATOMIC);
+       /* TODO: think about MEM_WAIT within kthread/blocking code. */
+       assert(blob);
+       return (uintptr_t)blob + KSTKSIZE + KSTACK_GUARD_SZ;
 }
 
 void put_kstack(uintptr_t stacktop)
 {
-       uintptr_t stackbot = stacktop - KSTKSIZE;
-       if (KSTKSIZE == PGSIZE)
-               page_decref(kva2page((void*)stackbot));
-       else
-               free_cont_pages((void*)stackbot, KSTKSHIFT - PGSHIFT);
+       kmem_cache_free(kstack_cache, (void*)(stacktop - KSTKSIZE
+                                             - KSTACK_GUARD_SZ));
 }
 
 uintptr_t *kstack_bottom_addr(uintptr_t stacktop)
@@ -46,7 +87,11 @@ struct kmem_cache *kthread_kcache;
 void kthread_init(void)
 {
        kthread_kcache = kmem_cache_create("kthread", sizeof(struct kthread),
-                                          __alignof__(struct kthread), 0, 0, 0);
+                                          __alignof__(struct kthread), 0,
+                                          NULL, 0, 0, NULL);
+       kstack_cache = kmem_cache_create("kstack", KSTKSIZE + KSTACK_GUARD_SZ,
+                                        PGSIZE, 0, vmap_arena, kstack_ctor,
+                                                                        kstack_dtor, NULL);
 }
 
 /* Used by early init routines (smp_boot, etc) */
@@ -59,6 +104,21 @@ struct kthread *__kthread_zalloc(void)
        return kthread;
 }
 
+/* Helper during early boot, where we jump from the bootstack to a real kthread
+ * stack, then run f().  Note that we don't have a kthread yet (done in smp.c).
+ *
+ * After this, our callee (f) can free the bootstack, if we care, by adding it
+ * to the base arena (use the KERNBASE addr, not the KERN_LOAD_ADDR). */
+void __use_real_kstack(void (*f)(void *arg))
+{
+       struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
+       uintptr_t new_stacktop;
+
+       new_stacktop = get_kstack();
+       set_stack_top(new_stacktop);
+       __reset_stack_pointer(0, new_stacktop, f);
+}
+
 /* Starts kthread on the calling core.  This does not return, and will handle
  * the details of cleaning up whatever is currently running (freeing its stack,
  * etc).  Pairs with sem_down(). */
@@ -66,7 +126,9 @@ void restart_kthread(struct kthread *kthread)
 {
        struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
        uintptr_t current_stacktop;
-       struct kthread *current_kthread;
+       struct kthread *cur_kth;
+       struct proc *old_proc;
+
        /* Avoid messy complications.  The kthread will enable_irqsave() when it
         * comes back up. */
        disable_irq();
@@ -78,34 +140,39 @@ void restart_kthread(struct kthread *kthread)
                put_kstack(pcpui->spare->stacktop);
                kmem_cache_free(kthread_kcache, pcpui->spare);
        }
-       current_kthread = pcpui->cur_kthread;
-       current_stacktop = current_kthread->stacktop;
-       assert(!current_kthread->sysc); /* catch bugs, prev user should clear */
+       cur_kth = pcpui->cur_kthread;
+       current_stacktop = cur_kth->stacktop;
+       assert(!cur_kth->sysc); /* catch bugs, prev user should clear */
        /* Set the spare stuff (current kthread, which includes its stacktop) */
-       pcpui->spare = current_kthread;
+       pcpui->spare = cur_kth;
        /* When a kthread runs, its stack is the default kernel stack */
        set_stack_top(kthread->stacktop);
        pcpui->cur_kthread = kthread;
-#ifdef CONFIG_KTHREAD_POISON
-       /* Assert and switch to cur stack not in use, kthr stack in use */
-       uintptr_t *cur_stack_poison, *kth_stack_poison;
-       cur_stack_poison = kstack_bottom_addr(current_stacktop);
-       assert(*cur_stack_poison == 0xdeadbeef);
-       *cur_stack_poison = 0;
-       kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
-       assert(!*kth_stack_poison);
-       *kth_stack_poison = 0xdeadbeef;
-#endif /* CONFIG_KTHREAD_POISON */
        /* Only change current if we need to (the kthread was in process context) */
        if (kthread->proc) {
-               /* Load our page tables before potentially decreffing cur_proc */
-               lcr3(kthread->proc->env_cr3);
-               /* Might have to clear out an existing current.  If they need to be set
-                * later (like in restartcore), it'll be done on demand. */
-               if (pcpui->cur_proc)
-                       proc_decref(pcpui->cur_proc);
-               /* We also transfer our counted ref from kthread->proc to cur_proc */
-               pcpui->cur_proc = kthread->proc;
+               if (kthread->proc == pcpui->cur_proc) {
+                       /* We're already loaded, but we do need to drop the extra ref stored
+                        * in kthread->proc. */
+                       proc_decref(kthread->proc);
+                       kthread->proc = 0;
+               } else {
+                       /* Load our page tables before potentially decreffing cur_proc.
+                        *
+                        * We don't need to do an EPT flush here.  The EPT is flushed and
+                        * managed in sync with the VMCS.  We won't run a different VM (and
+                        * thus *need* a different EPT) without first removing the old GPC,
+                        * which ultimately will result in a flushed EPT (on x86, this
+                        * actually happens when we clear_owning_proc()). */
+                       lcr3(kthread->proc->env_cr3);
+                       /* Might have to clear out an existing current.  If they need to be
+                        * set later (like in restartcore), it'll be done on demand. */
+                       old_proc = pcpui->cur_proc;
+                       /* Transfer our counted ref from kthread->proc to cur_proc. */
+                       pcpui->cur_proc = kthread->proc;
+                       kthread->proc = 0;
+                       if (old_proc)
+                               proc_decref(old_proc);
+               }
        }
        /* Finally, restart our thread */
        longjmp(&kthread->context, 1);
@@ -119,8 +186,6 @@ static void __launch_kthread(uint32_t srcid, long a0, long a1, long a2)
        struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
        struct proc *cur_proc = pcpui->cur_proc;
 
-       /* Make sure we are a routine kmsg */
-       assert(in_early_rkmsg_ctx(pcpui));
        if (pcpui->owning_proc && pcpui->owning_proc != kthread->proc) {
                /* Some process should be running here that is not the same as the
                 * kthread.  This means the _M is getting interrupted or otherwise
@@ -134,9 +199,7 @@ static void __launch_kthread(uint32_t srcid, long a0, long a1, long a2)
        }
        /* o/w, just run the kthread.  any trapframes that are supposed to run or
         * were interrupted will run whenever the kthread smp_idles() or otherwise
-        * finishes.  We also need to clear the RKMSG context since we will not
-        * return from restart_kth. */
-       clear_rkmsg(pcpui);
+        * finishes. */
        restart_kthread(kthread);
        assert(0);
 }
@@ -163,21 +226,13 @@ void kthread_runnable(struct kthread *kthread)
                            KMSG_ROUTINE);
 }
 
-/* Kmsg helper for kthread_yield */
-static void __wake_me_up(uint32_t srcid, long a0, long a1, long a2)
-{
-       struct semaphore *sem = (struct semaphore*)a0;
-       assert(sem_up(sem));
-}
-
 /* Stop the current kthread.  It'll get woken up next time we run routine kmsgs,
  * after all existing kmsgs are processed. */
 void kthread_yield(void)
 {
        struct semaphore local_sem, *sem = &local_sem;
        sem_init(sem, 0);
-       send_kernel_message(core_id(), __wake_me_up, (long)sem, 0, 0,
-                           KMSG_ROUTINE);
+       run_as_rkm(sem_up, sem);
        sem_down(sem);
 }
 
@@ -236,18 +291,6 @@ void ktask(char *name, void (*fn)(void*), void *arg)
                            (long)name, KMSG_ROUTINE);
 }
 
-void check_poison(char *msg)
-{
-#ifdef CONFIG_KTHREAD_POISON
-       struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
-       if (pcpui->cur_kthread && pcpui->cur_kthread->stacktop &&
-           (*kstack_bottom_addr(pcpui->cur_kthread->stacktop) != 0xdeadbeef)) {
-               printk("\nBad kthread canary, msg: %s\n", msg);
-               panic("");
-       }
-#endif /* CONFIG_KTHREAD_POISON */
-}
-
 /* Semaphores, using kthreads directly */
 static void debug_downed_sem(struct semaphore *sem);
 static void debug_upped_sem(struct semaphore *sem);
@@ -277,15 +320,16 @@ void sem_init_irqsave(struct semaphore *sem, int signals)
        sem->irq_okay = TRUE;
 }
 
-bool sem_trydown(struct semaphore *sem)
+bool sem_trydown_bulk(struct semaphore *sem, int nr_signals)
 {
        bool ret = FALSE;
+
        /* lockless peek */
-       if (sem->nr_signals <= 0)
+       if (sem->nr_signals - nr_signals < 0)
                return ret;
        debug_lock_semlist();
        spin_lock(&sem->lock);
-       if (sem->nr_signals > 0) {
+       if (sem->nr_signals - nr_signals >= 0) {
                sem->nr_signals--;
                ret = TRUE;
                debug_downed_sem(sem);
@@ -295,33 +339,15 @@ bool sem_trydown(struct semaphore *sem)
        return ret;
 }
 
-/* Helper, pushes the sem pointer on the top of the stack, returning the stack
- * pointer to use. */
-static uintptr_t push_sem_ptr(uintptr_t stack_top, struct semaphore *sem)
-{
-       struct semaphore **sp_ptr;
-
-       sp_ptr = (struct semaphore**)(stack_top - sizeof(struct semaphore*));
-       *sp_ptr = sem;
-       return (uintptr_t)sp_ptr;
-}
-
-/* Helper: gets the sem pointer from the top of the stack.  Note we don't pop
- * from the stack.  We're just using the topmost part of the stack for free
- * storage. */
-static struct semaphore *get_sem_ptr(void)
+bool sem_trydown(struct semaphore *sem)
 {
-       struct semaphore **sp_ptr;
-
-       sp_ptr = (struct semaphore**)(get_stack_top() - sizeof(struct semaphore*));
-       return *sp_ptr;
+       return sem_trydown_bulk(sem, 1);
 }
 
-
 /* Bottom-half of sem_down.  This is called after we jumped to the new stack. */
-static void __attribute__((noinline, noreturn)) __unlock_and_idle(void)
+static void __attribute__((noreturn)) __unlock_and_idle(void *arg)
 {
-       struct semaphore *sem = get_sem_ptr();
+       struct semaphore *sem = (struct semaphore*)arg;
 
        spin_unlock(&sem->lock);
        debug_unlock_semlist();
@@ -342,7 +368,6 @@ void sem_down(struct semaphore *sem)
        /* Make sure we aren't holding any locks (only works if SPINLOCK_DEBUG) */
        if (pcpui->lock_depth)
                panic("Kthread tried to sleep, with lockdepth %d\n", pcpui->lock_depth);
-       assert(pcpui->cur_kthread);
        /* Try to down the semaphore.  If there is a signal there, we can skip all
         * of the sleep prep and just return. */
 #ifdef CONFIG_SEM_SPINWAIT
@@ -355,6 +380,7 @@ void sem_down(struct semaphore *sem)
        if (sem_trydown(sem))
                goto block_return_path;
 #endif
+       assert(pcpui->cur_kthread);
        /* We're probably going to sleep, so get ready.  We'll check again later. */
        kthread = pcpui->cur_kthread;
        /* We need to have a spare slot for restart, so we also use it when
@@ -379,23 +405,10 @@ void sem_down(struct semaphore *sem)
                new_kthread->flags = KTH_DEFAULT_FLAGS;
                new_stacktop = get_kstack();
                new_kthread->stacktop = new_stacktop;
-#ifdef CONFIG_KTHREAD_POISON
-               *kstack_bottom_addr(new_stacktop) = 0;
-#endif /* CONFIG_KTHREAD_POISON */
        }
        /* Set the core's new default stack and kthread */
        set_stack_top(new_stacktop);
        pcpui->cur_kthread = new_kthread;
-#ifdef CONFIG_KTHREAD_POISON
-       /* Mark the new stack as in-use, and unmark the current kthread */
-       uintptr_t *new_stack_poison, *kth_stack_poison;
-       new_stack_poison = kstack_bottom_addr(new_stacktop);
-       assert(!*new_stack_poison);
-       *new_stack_poison = 0xdeadbeef;
-       kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
-       assert(*kth_stack_poison == 0xdeadbeef);
-       *kth_stack_poison = 0;
-#endif /* CONFIG_KTHREAD_POISON */
        /* Kthreads that are ktasks are not related to any process, and do not need
         * to work in a process's address space.  They can operate in any address
         * space that has the kernel mapped (like boot_pgdir, or any pgdir).  Some
@@ -404,20 +417,22 @@ void sem_down(struct semaphore *sem)
         *
         * Normal kthreads need to stay in the process context, but we want the core
         * (which could be a vcore) to stay in the context too. */
-       if (kthread->flags & KTH_SAVE_ADDR_SPACE) {
+       if ((kthread->flags & KTH_SAVE_ADDR_SPACE) && current) {
                kthread->proc = current;
-               assert(kthread->proc);
                /* In the future, we could check owning_proc. If it isn't set, we could
-                * clear current and transfer the refcnt to kthread->proc. */
+                * clear current and transfer the refcnt to kthread->proc.  If so, we'll
+                * need to reset the cr3 to something (boot_cr3 or owning_proc's cr3),
+                * which might not be worth the potentially excessive TLB flush. */
                proc_incref(kthread->proc, 1);
        } else {
-               kthread->proc = 0;
+               assert(kthread->proc == 0);
        }
        if (setjmp(&kthread->context))
                goto block_return_path;
        debug_lock_semlist();
        spin_lock(&sem->lock);
-       if (sem->nr_signals-- <= 0) {
+       sem->nr_signals -= 1;
+       if (sem->nr_signals < 0) {
                TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
                debug_downed_sem(sem);  /* need to debug after inserting */
                /* At this point, we know we'll sleep and change stacks.  Once we unlock
@@ -427,10 +442,7 @@ void sem_down(struct semaphore *sem)
                 * that doesn't change stacks, unlike x86_64), we'll be using the stack
                 * at the same time as the kthread.  We could just disable IRQs, but
                 * that wouldn't protect us from NMIs that don't change stacks. */
-               new_stacktop = push_sem_ptr(new_stacktop, sem);
-               set_frame_pointer(0);
-               set_stack_pointer(new_stacktop);
-               __unlock_and_idle();
+               __reset_stack_pointer(sem, new_stacktop, __unlock_and_idle);
                assert(0);
        }
        /* We get here if we should not sleep on sem (the signal beat the sleep).
@@ -440,19 +452,15 @@ void sem_down(struct semaphore *sem)
        debug_unlock_semlist();
        printd("[kernel] Didn't sleep, unwinding...\n");
        /* Restore the core's current and default stacktop */
-       current = kthread->proc;                        /* arguably unnecessary */
-       if (kthread->proc)
+       if (kthread->flags & KTH_SAVE_ADDR_SPACE) {
                proc_decref(kthread->proc);
+               kthread->proc = 0;
+       }
        set_stack_top(kthread->stacktop);
        pcpui->cur_kthread = kthread;
        /* Save the allocs as the spare */
        assert(!pcpui->spare);
        pcpui->spare = new_kthread;
-#ifdef CONFIG_KTHREAD_POISON
-       /* switch back to old stack in use, new one not */
-       *new_stack_poison = 0;
-       *kth_stack_poison = 0xdeadbeef;
-#endif /* CONFIG_KTHREAD_POISON */
 block_return_path:
        printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
        /* restart_kthread and longjmp did not reenable IRQs.  We need to make sure
@@ -464,6 +472,20 @@ block_return_path:
        return;
 }
 
+void sem_down_bulk(struct semaphore *sem, int nr_signals)
+{
+       /* This is far from ideal.  Our current sem code expects a 1:1 pairing of
+        * signals to waiters.  For instance, if we have 10 waiters of -1 each or 1
+        * waiter of -10, we can't tell from looking at the overall structure.  We'd
+        * need to track the desired number of signals per waiter.
+        *
+        * Note that if there are a bunch of signals available, sem_down will
+        * quickly do a try_down and return, so we won't block repeatedly.  But if
+        * we do block, we could wake up N times. */
+       for (int i = 0; i < nr_signals; i++)
+               sem_down(sem);
+}
+
 /* Ups the semaphore.  If it was < 0, we need to wake up someone, which we do.
  * Returns TRUE if we woke someone, FALSE o/w (used for debugging in some
  * places).  If we need more control, we can implement a version of the old
@@ -495,22 +517,35 @@ bool sem_up(struct semaphore *sem)
        return FALSE;
 }
 
-bool sem_trydown_irqsave(struct semaphore *sem, int8_t *irq_state)
+bool sem_trydown_bulk_irqsave(struct semaphore *sem, int nr_signals,
+                              int8_t *irq_state)
 {
        bool ret;
+
        disable_irqsave(irq_state);
-       ret = sem_trydown(sem);
+       ret = sem_trydown_bulk(sem, nr_signals);
        enable_irqsave(irq_state);
        return ret;
 }
 
-void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
+bool sem_trydown_irqsave(struct semaphore *sem, int8_t *irq_state)
+{
+       return sem_trydown_bulk_irqsave(sem, 1, irq_state);
+}
+
+void sem_down_bulk_irqsave(struct semaphore *sem, int nr_signals,
+                           int8_t *irq_state)
 {
        disable_irqsave(irq_state);
-       sem_down(sem);
+       sem_down_bulk(sem, nr_signals);
        enable_irqsave(irq_state);
 }
 
+void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
+{
+       sem_down_bulk_irqsave(sem, 1, irq_state);
+}
+
 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state)
 {
        bool retval;
@@ -582,11 +617,34 @@ static void debug_upped_sem(struct semaphore *sem)
 
 #endif /* CONFIG_SEMAPHORE_DEBUG */
 
-void print_sem_info(struct semaphore *sem)
+static bool __sem_has_pid(struct semaphore *sem, pid_t pid)
+{
+       struct kthread *kth_i;
+
+       if (pid == -1)
+               return TRUE;
+       TAILQ_FOREACH(kth_i, &sem->waiters, link) {
+               if (kth_i->proc) {
+                       if (kth_i->proc->pid == pid)
+                               return TRUE;
+               } else {
+                       if (pid == 0)
+                               return TRUE;
+               }
+       }
+       return FALSE;
+}
+
+static void print_sem_info(struct semaphore *sem, pid_t pid)
 {
        struct kthread *kth_i;
+
        /* Always safe to irqsave */
        spin_lock_irqsave(&sem->lock);
+       if (!__sem_has_pid(sem, pid)) {
+               spin_unlock_irqsave(&sem->lock);
+               return;
+       }
        printk("Semaphore %p has %d signals (neg = waiters)\n", sem,
               sem->nr_signals);
        TAILQ_FOREACH(kth_i, &sem->waiters, link)
@@ -598,14 +656,14 @@ void print_sem_info(struct semaphore *sem)
        spin_unlock_irqsave(&sem->lock);
 }
 
-void print_all_sem_info(void)
+void print_all_sem_info(pid_t pid)
 {
 #ifdef CONFIG_SEMAPHORE_DEBUG
        struct semaphore *sem_i;
        printk("All sems with waiters:\n");
        spin_lock_irqsave(&sems_with_waiters_lock);
        TAILQ_FOREACH(sem_i, &sems_with_waiters, link)
-               print_sem_info(sem_i);
+               print_sem_info(sem_i, pid);
        spin_unlock_irqsave(&sems_with_waiters_lock);
 #else
        printk("Failed to print all sems: build with CONFIG_SEMAPHORE_DEBUG\n");