Fix for concurrent syscall aborters
[akaros.git] / kern / src / kthread.c
1 /* Copyright (c) 2010-13 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Kernel threading.  These are for blocking within the kernel for whatever
6  * reason, usually during blocking IO operations. */
7
8 #include <kthread.h>
9 #include <slab.h>
10 #include <page_alloc.h>
11 #include <pmap.h>
12 #include <smp.h>
13 #include <schedule.h>
14
15 uintptr_t get_kstack(void)
16 {
17         uintptr_t stackbot;
18         if (KSTKSIZE == PGSIZE)
19                 stackbot = (uintptr_t)kpage_alloc_addr();
20         else
21                 stackbot = (uintptr_t)get_cont_pages(KSTKSHIFT - PGSHIFT, 0);
22         assert(stackbot);
23         return stackbot + KSTKSIZE;
24 }
25
26 void put_kstack(uintptr_t stacktop)
27 {
28         uintptr_t stackbot = stacktop - KSTKSIZE;
29         if (KSTKSIZE == PGSIZE)
30                 page_decref(kva2page((void*)stackbot));
31         else
32                 free_cont_pages((void*)stackbot, KSTKSHIFT - PGSHIFT);
33 }
34
35 uintptr_t *kstack_bottom_addr(uintptr_t stacktop)
36 {
37         /* canary at the bottom of the stack */
38         assert(!PGOFF(stacktop));
39         return (uintptr_t*)(stacktop - KSTKSIZE);
40 }
41
42 struct kmem_cache *kthread_kcache;
43
44 void kthread_init(void)
45 {
46         kthread_kcache = kmem_cache_create("kthread", sizeof(struct kthread),
47                                            __alignof__(struct kthread), 0, 0, 0);
48 }
49
50 /* Used by early init routines (smp_boot, etc) */
51 struct kthread *__kthread_zalloc(void)
52 {
53         struct kthread *kthread;
54         kthread = kmem_cache_alloc(kthread_kcache, 0);
55         assert(kthread);
56         memset(kthread, 0, sizeof(struct kthread));
57         return kthread;
58 }
59
60 /* Starts kthread on the calling core.  This does not return, and will handle
61  * the details of cleaning up whatever is currently running (freeing its stack,
62  * etc).  Pairs with sem_down(). */
63 void restart_kthread(struct kthread *kthread)
64 {
65         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
66         uintptr_t current_stacktop;
67         struct kthread *current_kthread;
68         /* Avoid messy complications.  The kthread will enable_irqsave() when it
69          * comes back up. */
70         disable_irq();
71         /* Free any spare, since we need the current to become the spare.  Without
72          * the spare, we can't free our current kthread/stack (we could free the
73          * kthread, but not the stack, since we're still on it).  And we can't free
74          * anything after popping kthread, since we never return. */
75         if (pcpui->spare) {
76                 put_kstack(pcpui->spare->stacktop);
77                 kmem_cache_free(kthread_kcache, pcpui->spare);
78         }
79         current_kthread = pcpui->cur_kthread;
80         current_stacktop = current_kthread->stacktop;
81         assert(!current_kthread->sysc); /* catch bugs, prev user should clear */
82         /* Set the spare stuff (current kthread, which includes its stacktop) */
83         pcpui->spare = current_kthread;
84         /* When a kthread runs, its stack is the default kernel stack */
85         set_stack_top(kthread->stacktop);
86         pcpui->cur_kthread = kthread;
87 #ifdef CONFIG_KTHREAD_POISON
88         /* Assert and switch to cur stack not in use, kthr stack in use */
89         uintptr_t *cur_stack_poison, *kth_stack_poison;
90         cur_stack_poison = kstack_bottom_addr(current_stacktop);
91         assert(*cur_stack_poison == 0xdeadbeef);
92         *cur_stack_poison = 0;
93         kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
94         assert(!*kth_stack_poison);
95         *kth_stack_poison = 0xdeadbeef;
96 #endif /* CONFIG_KTHREAD_POISON */
97         /* Only change current if we need to (the kthread was in process context) */
98         if (kthread->proc) {
99                 /* Load our page tables before potentially decreffing cur_proc */
100                 lcr3(kthread->proc->env_cr3);
101                 /* Might have to clear out an existing current.  If they need to be set
102                  * later (like in restartcore), it'll be done on demand. */
103                 if (pcpui->cur_proc)
104                         proc_decref(pcpui->cur_proc);
105                 /* We also transfer our counted ref from kthread->proc to cur_proc */
106                 pcpui->cur_proc = kthread->proc;
107         }
108         /* Finally, restart our thread */
109         pop_kernel_ctx(&kthread->context);
110 }
111
112 /* Kmsg handler to launch/run a kthread.  This must be a routine message, since
113  * it does not return.  */
114 static void __launch_kthread(uint32_t srcid, long a0, long a1, long a2)
115 {
116         struct kthread *kthread = (struct kthread*)a0;
117         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
118         struct proc *cur_proc = pcpui->cur_proc;
119         
120         /* Make sure we are a routine kmsg */
121         assert(in_early_rkmsg_ctx(pcpui));
122         if (pcpui->owning_proc && pcpui->owning_proc != kthread->proc) {
123                 /* Some process should be running here that is not the same as the
124                  * kthread.  This means the _M is getting interrupted or otherwise
125                  * delayed.  If we want to do something other than run it (like send the
126                  * kmsg to another pcore, or ship the context from here to somewhere
127                  * else/deschedule it (like for an _S)), do it here.
128                  *
129                  * If you want to do something here, call out to the ksched, then
130                  * abandon_core(). */
131                 cmb();  /* do nothing/placeholder */
132         }
133         /* o/w, just run the kthread.  any trapframes that are supposed to run or
134          * were interrupted will run whenever the kthread smp_idles() or otherwise
135          * finishes.  We also need to clear the RKMSG context since we will not
136          * return from restart_kth. */
137         clear_rkmsg(pcpui);
138         restart_kthread(kthread);
139         assert(0);
140 }
141
142 /* Call this when a kthread becomes runnable/unblocked.  We don't do anything
143  * particularly smart yet, but when we do, we can put it here. */
144 void kthread_runnable(struct kthread *kthread)
145 {
146         uint32_t dst = core_id();
147         #if 0
148         /* turn this block on if you want to test migrating non-core0 kthreads */
149         switch (dst) {
150                 case 0:
151                         break;
152                 case 7:
153                         dst = 2;
154                         break;
155                 default:
156                         dst++;
157         }
158         #endif
159         /* For lack of anything better, send it to ourselves. (TODO: KSCHED) */
160         send_kernel_message(dst, __launch_kthread, (long)kthread, 0, 0,
161                             KMSG_ROUTINE);
162 }
163
164 /* Kmsg helper for kthread_yield */
165 static void __wake_me_up(uint32_t srcid, long a0, long a1, long a2)
166 {
167         struct semaphore *sem = (struct semaphore*)a0;
168         assert(sem_up(sem));
169 }
170
171 /* Stop the current kthread.  It'll get woken up next time we run routine kmsgs,
172  * after all existing kmsgs are processed. */
173 void kthread_yield(void)
174 {
175         struct semaphore local_sem, *sem = &local_sem;
176         sem_init(sem, 0);
177         send_kernel_message(core_id(), __wake_me_up, (long)sem, 0, 0,
178                             KMSG_ROUTINE);
179         sem_down(sem);
180 }
181
182 static void __ktask_wrapper(uint32_t srcid, long a0, long a1, long a2)
183 {
184         void (*fn)(void*) = (void (*)(void*))a0;
185         void *arg = (void*)a1;
186         char *name = (char*)a2;
187         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
188         assert(pcpui->cur_kthread->is_ktask);
189         pcpui->cur_kthread->name = name;
190         fn(arg);
191         pcpui->cur_kthread->name = 0;
192         /* if we blocked, when we return, PRKM will smp_idle() */
193 }
194
195 /* Creates a kernel task, running fn(arg), named "name".  This is just a routine
196  * kernel message that happens to have a name, and is allowed to block.  It
197  * won't be associated with any process.  For lack of a better place, we'll just
198  * start it on the calling core.  Caller (and/or fn) need to deal with the
199  * storage for *name. */
200 void ktask(char *name, void (*fn)(void*), void *arg)
201 {
202         send_kernel_message(core_id(), __ktask_wrapper, (long)fn, (long)arg,
203                             (long)name, KMSG_ROUTINE);
204 }
205
206 void check_poison(char *msg)
207 {
208 #ifdef CONFIG_KTHREAD_POISON
209         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
210         assert(pcpui->cur_kthread && pcpui->cur_kthread->stacktop);
211         if (*kstack_bottom_addr(pcpui->cur_kthread->stacktop) != 0xdeadbeef) {
212                 printk("\nBad kthread canary, msg: %s\n", msg);
213                 panic("");
214         }
215 #endif /* CONFIG_KTHREAD_POISON */
216 }
217
218 /* Semaphores, using kthreads directly */
219 static void debug_downed_sem(struct semaphore *sem);
220 static void debug_upped_sem(struct semaphore *sem);
221
222 static void sem_init_common(struct semaphore *sem, int signals)
223 {
224         TAILQ_INIT(&sem->waiters);
225         sem->nr_signals = signals;
226 #ifdef CONFIG_SEMAPHORE_DEBUG
227         sem->is_on_list = FALSE;
228         sem->bt_pc = 0;
229         sem->bt_fp = 0;
230         sem->calling_core = 0;
231 #endif
232 }
233
234 void sem_init(struct semaphore *sem, int signals)
235 {
236         sem_init_common(sem, signals);
237         spinlock_init(&sem->lock);
238         sem->irq_okay = FALSE;
239 }
240
241 void sem_init_irqsave(struct semaphore *sem, int signals)
242 {
243         sem_init_common(sem, signals);
244         spinlock_init_irqsave(&sem->lock);
245         sem->irq_okay = TRUE;
246 }
247
248 bool sem_trydown(struct semaphore *sem)
249 {
250         bool ret = FALSE;
251         spin_lock(&sem->lock);
252         if (sem->nr_signals > 0) {
253                 sem->nr_signals--;
254                 ret = TRUE;
255                 debug_downed_sem(sem);
256         }
257         spin_unlock(&sem->lock);
258         return ret;
259 }
260
261 /* This downs the semaphore and suspends the current kernel context on its
262  * waitqueue if there are no pending signals.  Note that the case where the
263  * signal is already there is not optimized. */
264 void sem_down(struct semaphore *sem)
265 {
266         volatile bool blocking = TRUE;  /* signal to short circuit when restarting*/
267         struct kthread *kthread, *new_kthread;
268         register uintptr_t new_stacktop;
269         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
270
271         assert(can_block(pcpui));
272         /* Make sure we aren't holding any locks (only works if SPINLOCK_DEBUG) */
273         assert(!pcpui->lock_depth);
274         assert(pcpui->cur_kthread);
275         /* Try to down the semaphore.  If there is a signal there, we can skip all
276          * of the sleep prep and just return. */
277         if (sem_trydown(sem))
278                 goto block_return_path;
279         /* We're probably going to sleep, so get ready.  We'll check again later. */
280         kthread = pcpui->cur_kthread;
281         /* We need to have a spare slot for restart, so we also use it when
282          * sleeping.  Right now, we need a new kthread to take over if/when our
283          * current kthread sleeps.  Use the spare, and if not, get a new one.
284          *
285          * Note we do this with interrupts disabled (which protects us from
286          * concurrent modifications). */
287         if (pcpui->spare) {
288                 new_kthread = pcpui->spare;
289                 new_stacktop = new_kthread->stacktop;
290                 pcpui->spare = 0;
291                 /* Based on how we set is_ktask (in PRKM), we'll usually have a spare
292                  * with is_ktask set, even though the default setting is off.  The
293                  * reason is that the launching of blocked kthreads also uses PRKM, and
294                  * that KMSG (__launch_kthread) doesn't return.  Thus the soon-to-be
295                  * spare kthread, that is launching another, has is_ktask set. */
296                 new_kthread->is_ktask = FALSE;
297                 new_kthread->proc = 0;
298                 new_kthread->name = 0;
299         } else {
300                 new_kthread = __kthread_zalloc();
301                 new_stacktop = get_kstack();
302                 new_kthread->stacktop = new_stacktop;
303 #ifdef CONFIG_KTHREAD_POISON
304                 *kstack_bottom_addr(new_stacktop) = 0;
305 #endif /* CONFIG_KTHREAD_POISON */
306         }
307         /* Set the core's new default stack and kthread */
308         set_stack_top(new_stacktop);
309         pcpui->cur_kthread = new_kthread;
310 #ifdef CONFIG_KTHREAD_POISON
311         /* Mark the new stack as in-use, and unmark the current kthread */
312         uintptr_t *new_stack_poison, *kth_stack_poison;
313         new_stack_poison = kstack_bottom_addr(new_stacktop);
314         assert(!*new_stack_poison);
315         *new_stack_poison = 0xdeadbeef;
316         kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
317         assert(*kth_stack_poison == 0xdeadbeef);
318         *kth_stack_poison = 0;
319 #endif /* CONFIG_KTHREAD_POISON */
320         /* Kthreads that are ktasks are not related to any process, and do not need
321          * to work in a process's address space.  They can operate in any address
322          * space that has the kernel mapped (like boot_pgdir, or any pgdir).
323          *
324          * Other kthreads need to stay in the process context (if there is one), but
325          * we want the core (which could be a vcore) to stay in the context too.  In
326          * the future, we could check owning_proc. If it isn't set, we could leave
327          * the process context and transfer the refcnt to kthread->proc. */
328         if (!kthread->is_ktask) {
329                 kthread->proc = current;
330                 proc_incref(kthread->proc, 1);
331         } else {
332                 kthread->proc = 0;
333         } 
334         /* Save the context, toggle blocking for the reactivation */
335         save_kernel_ctx(&kthread->context);
336         if (!blocking)
337                 goto block_return_path;
338         blocking = FALSE;                                       /* for when it starts back up */
339         /* Down the semaphore.  We need this to be inline.  If we're sleeping, once
340          * we unlock the kthread could be started up again and can return and start
341          * trashing this function's stack, hence the weird control flow. */
342         spin_lock(&sem->lock);
343         if (sem->nr_signals-- <= 0) {
344                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
345                 debug_downed_sem(sem);
346                 /* At this point, we know we'll sleep and change stacks later.  Once we
347                  * unlock, we could have the kthread restarted (possibly on another
348                  * core), so we need to disable irqs until we are on our new stack.
349                  * Otherwise, if we take an IRQ, we'll be using our stack while another
350                  * core is using it (restarted kthread).  Basically, disabling irqs
351                  * allows us to atomically unlock and 'yield'. */
352                 disable_irq();
353         } else {                                                        /* we didn't sleep */
354                 debug_downed_sem(sem);
355                 goto unwind_sleep_prep;
356         }
357         spin_unlock(&sem->lock);
358         /* Switch to the core's default stack.  After this, don't use local
359          * variables.  TODO: we shouldn't be using new_stacktop either, can't always
360          * trust the register keyword (AFAIK). */
361         set_stack_pointer(new_stacktop);
362         smp_idle();                                                     /* reenables irqs eventually */
363         /* smp_idle never returns */
364         assert(0);
365 unwind_sleep_prep:
366         /* We get here if we should not sleep on sem (the signal beat the sleep).
367          * Note we are not optimizing for cases where the signal won. */
368         spin_unlock(&sem->lock);
369         printd("[kernel] Didn't sleep, unwinding...\n");
370         /* Restore the core's current and default stacktop */
371         current = kthread->proc;                        /* arguably unnecessary */
372         if (kthread->proc)
373                 proc_decref(kthread->proc);
374         set_stack_top(kthread->stacktop);
375         pcpui->cur_kthread = kthread;
376         /* Save the allocs as the spare */
377         assert(!pcpui->spare);
378         pcpui->spare = new_kthread;
379 #ifdef CONFIG_KTHREAD_POISON
380         /* switch back to old stack in use, new one not */
381         *new_stack_poison = 0;
382         *kth_stack_poison = 0xdeadbeef;
383 #endif /* CONFIG_KTHREAD_POISON */
384 block_return_path:
385         printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
386         return;
387 }
388
389 /* Ups the semaphore.  If it was < 0, we need to wake up someone, which we do.
390  * Returns TRUE if we woke someone, FALSE o/w (used for debugging in some
391  * places).  If we need more control, we can implement a version of the old
392  * __up_sem() again.  */
393 bool sem_up(struct semaphore *sem)
394 {
395         struct kthread *kthread = 0;
396         spin_lock(&sem->lock);
397         if (sem->nr_signals++ < 0) {
398                 assert(!TAILQ_EMPTY(&sem->waiters));
399                 /* could do something with 'priority' here */
400                 kthread = TAILQ_FIRST(&sem->waiters);
401                 TAILQ_REMOVE(&sem->waiters, kthread, link);
402         } else {
403                 assert(TAILQ_EMPTY(&sem->waiters));
404         }
405         debug_upped_sem(sem);
406         spin_unlock(&sem->lock);
407         /* Note that once we call kthread_runnable(), we cannot touch the sem again.
408          * Some sems are on stacks.  The caller can touch sem, if it knows about the
409          * memory/usage of the sem.  Likewise, we can't touch the kthread either. */
410         if (kthread) {
411                 kthread_runnable(kthread);
412                 return TRUE;
413         }
414         return FALSE;
415 }
416
417 bool sem_trydown_irqsave(struct semaphore *sem, int8_t *irq_state)
418 {
419         bool ret;
420         disable_irqsave(irq_state);
421         ret = sem_trydown(sem);
422         enable_irqsave(irq_state);
423         return ret;
424 }
425
426 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
427 {
428         disable_irqsave(irq_state);
429         sem_down(sem);
430         enable_irqsave(irq_state);
431 }
432
433 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state)
434 {
435         bool retval;
436         disable_irqsave(irq_state);
437         retval = sem_up(sem);
438         enable_irqsave(irq_state);
439         return retval;
440 }
441
442 /* Sem debugging */
443
444 #ifdef CONFIG_SEMAPHORE_DEBUG
445 struct semaphore_tailq sems_with_waiters =
446                        TAILQ_HEAD_INITIALIZER(sems_with_waiters);
447 spinlock_t sems_with_waiters_lock = SPINLOCK_INITIALIZER_IRQSAVE;
448
449 /* this gets called any time we downed the sem, regardless of whether or not we
450  * waited */
451 static void debug_downed_sem(struct semaphore *sem)
452 {
453         sem->bt_pc = read_pc();
454         sem->bt_fp = read_bp();
455         sem->calling_core = core_id();
456         if (TAILQ_EMPTY(&sem->waiters) || sem->is_on_list)
457                 return;
458         spin_lock_irqsave(&sems_with_waiters_lock);
459         TAILQ_INSERT_HEAD(&sems_with_waiters, sem, link);
460         spin_unlock_irqsave(&sems_with_waiters_lock);
461         sem->is_on_list = TRUE;
462 }
463
464 /* Called when a sem is upped.  It may or may not have waiters, and it may or
465  * may not be on the list. (we could up several times past 0). */
466 static void debug_upped_sem(struct semaphore *sem)
467 {
468         if (TAILQ_EMPTY(&sem->waiters) && sem->is_on_list) {
469                 spin_lock_irqsave(&sems_with_waiters_lock);
470                 TAILQ_REMOVE(&sems_with_waiters, sem, link);
471                 spin_unlock_irqsave(&sems_with_waiters_lock);
472                 sem->is_on_list = FALSE;
473         }
474 }
475
476 #else
477
478 static void debug_downed_sem(struct semaphore *sem)
479 {
480         /* no debugging */
481 }
482
483 static void debug_upped_sem(struct semaphore *sem)
484 {
485         /* no debugging */
486 }
487
488 #endif /* CONFIG_SEMAPHORE_DEBUG */
489
490 void print_sem_info(struct semaphore *sem)
491 {
492         struct kthread *kth_i;
493         /* Always safe to irqsave */
494         spin_lock_irqsave(&sem->lock);
495         printk("Semaphore %p has %d signals (neg = waiters)", sem, sem->nr_signals);
496 #ifdef CONFIG_SEMAPHORE_DEBUG
497         printk(", recently downed on core %d with pc/frame %p %p\n",
498                sem->calling_core, sem->bt_pc, sem->bt_fp);
499 #else
500         printk("\n");
501 #endif /* CONFIG_SEMAPHORE_DEBUG */
502         TAILQ_FOREACH(kth_i, &sem->waiters, link)
503                 printk("\tKthread %p (%s), proc %d (%p), sysc %p\n", kth_i, kth_i->name,
504                        kth_i->proc ? kth_i->proc->pid : 0, kth_i->proc, kth_i->sysc);
505         spin_unlock_irqsave(&sem->lock);
506 }
507
508 void print_all_sem_info(void)
509 {
510 #ifdef CONFIG_SEMAPHORE_DEBUG
511         struct semaphore *sem_i;
512         printk("All sems with waiters:\n");
513         spin_lock_irqsave(&sems_with_waiters_lock);
514         TAILQ_FOREACH(sem_i, &sems_with_waiters, link)
515                 print_sem_info(sem_i);
516         spin_unlock_irqsave(&sems_with_waiters_lock);
517 #else
518         printk("Failed to print all sems: build with CONFIG_SEMAPHORE_DEBUG\n");
519 #endif
520 }
521
522 /* Condition variables, using semaphores and kthreads */
523 void cv_init(struct cond_var *cv)
524 {
525         sem_init(&cv->sem, 0);
526         cv->lock = &cv->internal_lock;
527         spinlock_init(cv->lock);
528         cv->nr_waiters = 0;
529         cv->irq_okay = FALSE;
530 }
531
532 void cv_init_irqsave(struct cond_var *cv)
533 {
534         sem_init_irqsave(&cv->sem, 0);
535         cv->lock = &cv->internal_lock;
536         spinlock_init_irqsave(cv->lock);
537         cv->nr_waiters = 0;
538         cv->irq_okay = TRUE;
539 }
540
541 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock)
542 {
543         sem_init(&cv->sem, 0);
544         cv->nr_waiters = 0;
545         cv->lock = lock;
546         cv->irq_okay = FALSE;
547 }
548
549 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock)
550 {
551         sem_init_irqsave(&cv->sem, 0);
552         cv->nr_waiters = 0;
553         cv->lock = lock;
554         cv->irq_okay = TRUE;
555 }
556
557 void cv_lock(struct cond_var *cv)
558 {
559         spin_lock(cv->lock);
560 }
561
562 void cv_unlock(struct cond_var *cv)
563 {
564         spin_unlock(cv->lock);
565 }
566
567 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state)
568 {
569         disable_irqsave(irq_state);
570         cv_lock(cv);
571 }
572
573 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state)
574 {
575         cv_unlock(cv);
576         enable_irqsave(irq_state);
577 }
578
579 /* Helper to clarify the wait/signalling code */
580 static int nr_sem_waiters(struct semaphore *sem)
581 {
582         int retval;
583         retval = 0 - sem->nr_signals;
584         assert(retval >= 0);
585         return retval;
586 }
587
588 /* Comes in locked.  Note we don't mess with enabling/disabling irqs.  The
589  * initial cv_lock would have disabled irqs (if applicable), and we don't mess
590  * with that setting at all. */
591 void cv_wait_and_unlock(struct cond_var *cv)
592 {
593         unsigned long nr_prev_waiters;
594         nr_prev_waiters = cv->nr_waiters++;
595         spin_unlock(cv->lock);
596         /* Wait til our turn.  This forces an ordering of all waiters such that the
597          * order in which they wait is the order in which they down the sem. */
598         while (nr_prev_waiters != nr_sem_waiters(&cv->sem))
599                 cpu_relax();
600         printd("core %d, sees nr_sem_waiters: %d, cv_nr_waiters %d\n",
601                core_id(), nr_sem_waiters(&cv->sem), cv->nr_waiters);
602         /* Atomically sleeps and 'unlocks' the next kthread from its busy loop (the
603          * one right above this), when it changes the sems nr_signals/waiters. */
604         sem_down(&cv->sem);
605 }
606
607 /* Comes in locked.  Note cv_lock does not disable irqs.   They should still be
608  * disabled from the initial cv_lock_irqsave(). */
609 void cv_wait(struct cond_var *cv)
610 {
611         cv_wait_and_unlock(cv);
612         if (cv->irq_okay)
613                 assert(!irq_is_enabled());
614         cv_lock(cv);
615 }
616
617 /* Helper, wakes exactly one, and there should have been at least one waiter. */
618 static void sem_wake_one(struct semaphore *sem)
619 {
620         struct kthread *kthread;
621         /* these locks will be irqsaved if the CV is irqsave (only need the one) */
622         spin_lock(&sem->lock);
623         assert(sem->nr_signals < 0);
624         sem->nr_signals++;
625         kthread = TAILQ_FIRST(&sem->waiters);
626         TAILQ_REMOVE(&sem->waiters, kthread, link);
627         debug_upped_sem(sem);
628         spin_unlock(&sem->lock);
629         kthread_runnable(kthread);
630 }
631
632 void __cv_signal(struct cond_var *cv)
633 {
634         /* Can't short circuit this stuff.  We need to make sure any waiters that
635          * made it past upping the cv->nr_waiters has also downed the sem.
636          * Otherwise we muck with nr_waiters, which could break the ordering
637          * required by the waiters.  We also need to lock while making this check,
638          * o/w a new waiter can slip in after our while loop. */
639         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
640                 cpu_relax();
641         if (cv->nr_waiters) {
642                 cv->nr_waiters--;
643                 sem_wake_one(&cv->sem);
644         }
645 }
646
647 void __cv_broadcast(struct cond_var *cv)
648 {
649         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
650                 cpu_relax();
651         while (cv->nr_waiters) {
652                 cv->nr_waiters--;
653                 sem_wake_one(&cv->sem);
654         }
655 }
656
657 void cv_signal(struct cond_var *cv)
658 {
659         spin_lock(cv->lock);
660         __cv_signal(cv);
661         spin_unlock(cv->lock);
662 }
663
664 void cv_broadcast(struct cond_var *cv)
665 {
666         spin_lock(cv->lock);
667         __cv_broadcast(cv);
668         spin_unlock(cv->lock);
669 }
670
671 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state)
672 {
673         disable_irqsave(irq_state);
674         cv_signal(cv);
675         enable_irqsave(irq_state);
676 }
677
678 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state)
679 {
680         disable_irqsave(irq_state);
681         cv_broadcast(cv);
682         enable_irqsave(irq_state);
683 }
684
685 /* Attempts to abort p's sysc.  It will only do so if the sysc lookup succeeds,
686  * so we can handle "guesses" for syscalls that might not be sleeping.  This
687  * style of "do it if you know you can" is the best way here - anything else
688  * runs into situations where you don't know if the memory is safe to touch or
689  * not (we're doing a lookup via pointer address, and only dereferencing if that
690  * succeeds).  Even something simple like letting userspace write SC_ABORT is
691  * very hard for them, since they don't know a sysc's state for sure (under the
692  * current system).
693  *
694  * Here are the rules:
695  * - if you're flagged SC_ABORT, you don't sleep
696  * - if you sleep, you're on the list
697  * - if you are on the list or abort_in_progress is set, CV is signallable, and
698  *   all the memory for CLE is safe */
699 bool abort_sysc(struct proc *p, struct syscall *sysc)
700 {
701         struct cv_lookup_elm *cle;
702         int8_t irq_state = 0;
703         spin_lock_irqsave(&p->abort_list_lock);
704         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
705                 if (cle->sysc == sysc) {
706                         /* Note: we could have multiple aborters, so we need to use a
707                          * numeric refcnt instead of a flag. */
708                         atomic_inc(&cle->abort_in_progress);
709                         break;
710                 }
711         }
712         spin_unlock_irqsave(&p->abort_list_lock);
713         if (!cle)
714                 return FALSE;
715         /* At this point, we have a handle on the syscall that we want to abort (via
716          * the cle), and we know none of the memory will disappear on us (deregers
717          * wait on the flag).  So we'll signal ABORT, which rendez will pick up next
718          * time it is awake.  Then we make sure it is awake with a broadcast. */
719         atomic_or(&cle->sysc->flags, SC_ABORT);
720         cmb();  /* flags write before signal; atomic op provided CPU mb */
721         cv_broadcast_irqsave(cle->cv, &irq_state); 
722         cmb();  /* broadcast writes before abort flag; atomic op provided CPU mb */
723         atomic_dec(&cle->abort_in_progress);
724         return TRUE;
725 }
726
727 /* Being on the abortable list means that the CLE, KTH, SYSC, and CV are valid
728  * memory.  The lock ordering is {CV lock, list_lock}.  Callers to this *will*
729  * have CV held.  This is done to avoid excessive locking in places like
730  * rendez_sleep, which want to check the condition before registering. */
731 void __reg_abortable_cv(struct cv_lookup_elm *cle, struct cond_var *cv)
732 {
733         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
734         cle->cv = cv;
735         cle->kthread = pcpui->cur_kthread;
736         /* Could be a ktask.  Can build in support for aborting these later */
737         if (cle->kthread->is_ktask) {
738                 cle->sysc = 0;
739                 return;
740         }
741         cle->sysc = cle->kthread->sysc;
742         assert(cle->sysc);
743         cle->proc = pcpui->cur_proc;
744         atomic_init(&cle->abort_in_progress, 0);
745         spin_lock_irqsave(&cle->proc->abort_list_lock);
746         TAILQ_INSERT_HEAD(&cle->proc->abortable_sleepers, cle, link);
747         spin_unlock_irqsave(&cle->proc->abort_list_lock);
748 }
749
750 /* We're racing with the aborter too, who will hold the flag in cle to protect
751  * its ref on our cle.  While the lock ordering is CV, list, callers to this
752  * must *not* have the cv lock held.  The reason is this waits on a successful
753  * abort_sysc, which is trying to cv_{signal,broadcast}, which could wait on the
754  * CV lock.  So if we hold the CV lock, we can deadlock (circular dependency).*/
755 void dereg_abortable_cv(struct cv_lookup_elm *cle)
756 {
757         if (cle->kthread->is_ktask)
758                 return;
759         assert(cle->proc);
760         spin_lock_irqsave(&cle->proc->abort_list_lock);
761         TAILQ_REMOVE(&cle->proc->abortable_sleepers, cle, link);
762         spin_unlock_irqsave(&cle->proc->abort_list_lock);
763         /* If we won the race and yanked it out of the list before abort claimed it,
764          * this will already be FALSE. */
765         while (atomic_read(&cle->abort_in_progress))
766                 cpu_relax();
767 }
768
769 /* Helper to sleepers to know if they should abort or not.  I'll probably extend
770  * this with things for ktasks in the future. */
771 bool should_abort(struct cv_lookup_elm *cle)
772 {
773         return (cle->sysc && (atomic_read(&cle->sysc->flags) & SC_ABORT));
774 }