Ktasks are run with interrupts enabled
[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         enable_irq();
191         fn(arg);
192         disable_irq();
193         pcpui->cur_kthread->name = 0;
194         /* if we blocked, when we return, PRKM will smp_idle() */
195 }
196
197 /* Creates a kernel task, running fn(arg), named "name".  This is just a routine
198  * kernel message that happens to have a name, and is allowed to block.  It
199  * won't be associated with any process.  For lack of a better place, we'll just
200  * start it on the calling core.  Caller (and/or fn) need to deal with the
201  * storage for *name. */
202 void ktask(char *name, void (*fn)(void*), void *arg)
203 {
204         send_kernel_message(core_id(), __ktask_wrapper, (long)fn, (long)arg,
205                             (long)name, KMSG_ROUTINE);
206 }
207
208 void check_poison(char *msg)
209 {
210 #ifdef CONFIG_KTHREAD_POISON
211         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
212         assert(pcpui->cur_kthread && pcpui->cur_kthread->stacktop);
213         if (*kstack_bottom_addr(pcpui->cur_kthread->stacktop) != 0xdeadbeef) {
214                 printk("\nBad kthread canary, msg: %s\n", msg);
215                 panic("");
216         }
217 #endif /* CONFIG_KTHREAD_POISON */
218 }
219
220 /* Semaphores, using kthreads directly */
221 static void debug_downed_sem(struct semaphore *sem);
222 static void debug_upped_sem(struct semaphore *sem);
223
224 static void sem_init_common(struct semaphore *sem, int signals)
225 {
226         TAILQ_INIT(&sem->waiters);
227         sem->nr_signals = signals;
228 #ifdef CONFIG_SEMAPHORE_DEBUG
229         sem->is_on_list = FALSE;
230         sem->bt_pc = 0;
231         sem->bt_fp = 0;
232         sem->calling_core = 0;
233 #endif
234 }
235
236 void sem_init(struct semaphore *sem, int signals)
237 {
238         sem_init_common(sem, signals);
239         spinlock_init(&sem->lock);
240         sem->irq_okay = FALSE;
241 }
242
243 void sem_init_irqsave(struct semaphore *sem, int signals)
244 {
245         sem_init_common(sem, signals);
246         spinlock_init_irqsave(&sem->lock);
247         sem->irq_okay = TRUE;
248 }
249
250 bool sem_trydown(struct semaphore *sem)
251 {
252         bool ret = FALSE;
253         spin_lock(&sem->lock);
254         if (sem->nr_signals > 0) {
255                 sem->nr_signals--;
256                 ret = TRUE;
257                 debug_downed_sem(sem);
258         }
259         spin_unlock(&sem->lock);
260         return ret;
261 }
262
263 /* This downs the semaphore and suspends the current kernel context on its
264  * waitqueue if there are no pending signals.  Note that the case where the
265  * signal is already there is not optimized. */
266 void sem_down(struct semaphore *sem)
267 {
268         volatile bool blocking = TRUE;  /* signal to short circuit when restarting*/
269         struct kthread *kthread, *new_kthread;
270         register uintptr_t new_stacktop;
271         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
272
273         assert(can_block(pcpui));
274         /* Make sure we aren't holding any locks (only works if SPINLOCK_DEBUG) */
275         assert(!pcpui->lock_depth);
276         assert(pcpui->cur_kthread);
277         /* Try to down the semaphore.  If there is a signal there, we can skip all
278          * of the sleep prep and just return. */
279         if (sem_trydown(sem))
280                 goto block_return_path;
281         /* We're probably going to sleep, so get ready.  We'll check again later. */
282         kthread = pcpui->cur_kthread;
283         /* We need to have a spare slot for restart, so we also use it when
284          * sleeping.  Right now, we need a new kthread to take over if/when our
285          * current kthread sleeps.  Use the spare, and if not, get a new one.
286          *
287          * Note we do this with interrupts disabled (which protects us from
288          * concurrent modifications). */
289         if (pcpui->spare) {
290                 new_kthread = pcpui->spare;
291                 new_stacktop = new_kthread->stacktop;
292                 pcpui->spare = 0;
293                 /* Based on how we set is_ktask (in PRKM), we'll usually have a spare
294                  * with is_ktask set, even though the default setting is off.  The
295                  * reason is that the launching of blocked kthreads also uses PRKM, and
296                  * that KMSG (__launch_kthread) doesn't return.  Thus the soon-to-be
297                  * spare kthread, that is launching another, has is_ktask set. */
298                 new_kthread->is_ktask = FALSE;
299                 new_kthread->proc = 0;
300                 new_kthread->name = 0;
301         } else {
302                 new_kthread = __kthread_zalloc();
303                 new_stacktop = get_kstack();
304                 new_kthread->stacktop = new_stacktop;
305 #ifdef CONFIG_KTHREAD_POISON
306                 *kstack_bottom_addr(new_stacktop) = 0;
307 #endif /* CONFIG_KTHREAD_POISON */
308         }
309         /* Set the core's new default stack and kthread */
310         set_stack_top(new_stacktop);
311         pcpui->cur_kthread = new_kthread;
312 #ifdef CONFIG_KTHREAD_POISON
313         /* Mark the new stack as in-use, and unmark the current kthread */
314         uintptr_t *new_stack_poison, *kth_stack_poison;
315         new_stack_poison = kstack_bottom_addr(new_stacktop);
316         assert(!*new_stack_poison);
317         *new_stack_poison = 0xdeadbeef;
318         kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
319         assert(*kth_stack_poison == 0xdeadbeef);
320         *kth_stack_poison = 0;
321 #endif /* CONFIG_KTHREAD_POISON */
322         /* Kthreads that are ktasks are not related to any process, and do not need
323          * to work in a process's address space.  They can operate in any address
324          * space that has the kernel mapped (like boot_pgdir, or any pgdir).
325          *
326          * Other kthreads need to stay in the process context (if there is one), but
327          * we want the core (which could be a vcore) to stay in the context too.  In
328          * the future, we could check owning_proc. If it isn't set, we could leave
329          * the process context and transfer the refcnt to kthread->proc. */
330         if (!kthread->is_ktask) {
331                 kthread->proc = current;
332                 proc_incref(kthread->proc, 1);
333         } else {
334                 kthread->proc = 0;
335         } 
336         /* Save the context, toggle blocking for the reactivation */
337         save_kernel_ctx(&kthread->context);
338         if (!blocking)
339                 goto block_return_path;
340         blocking = FALSE;                                       /* for when it starts back up */
341         /* Down the semaphore.  We need this to be inline.  If we're sleeping, once
342          * we unlock the kthread could be started up again and can return and start
343          * trashing this function's stack, hence the weird control flow. */
344         spin_lock(&sem->lock);
345         if (sem->nr_signals-- <= 0) {
346                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
347                 debug_downed_sem(sem);
348                 /* At this point, we know we'll sleep and change stacks later.  Once we
349                  * unlock, we could have the kthread restarted (possibly on another
350                  * core), so we need to disable irqs until we are on our new stack.
351                  * Otherwise, if we take an IRQ, we'll be using our stack while another
352                  * core is using it (restarted kthread).  Basically, disabling irqs
353                  * allows us to atomically unlock and 'yield'. */
354                 disable_irq();
355         } else {                                                        /* we didn't sleep */
356                 debug_downed_sem(sem);
357                 goto unwind_sleep_prep;
358         }
359         spin_unlock(&sem->lock);
360         /* Switch to the core's default stack.  After this, don't use local
361          * variables.  TODO: we shouldn't be using new_stacktop either, can't always
362          * trust the register keyword (AFAIK). */
363         set_stack_pointer(new_stacktop);
364         smp_idle();                                                     /* reenables irqs eventually */
365         /* smp_idle never returns */
366         assert(0);
367 unwind_sleep_prep:
368         /* We get here if we should not sleep on sem (the signal beat the sleep).
369          * Note we are not optimizing for cases where the signal won. */
370         spin_unlock(&sem->lock);
371         printd("[kernel] Didn't sleep, unwinding...\n");
372         /* Restore the core's current and default stacktop */
373         current = kthread->proc;                        /* arguably unnecessary */
374         if (kthread->proc)
375                 proc_decref(kthread->proc);
376         set_stack_top(kthread->stacktop);
377         pcpui->cur_kthread = kthread;
378         /* Save the allocs as the spare */
379         assert(!pcpui->spare);
380         pcpui->spare = new_kthread;
381 #ifdef CONFIG_KTHREAD_POISON
382         /* switch back to old stack in use, new one not */
383         *new_stack_poison = 0;
384         *kth_stack_poison = 0xdeadbeef;
385 #endif /* CONFIG_KTHREAD_POISON */
386 block_return_path:
387         printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
388         return;
389 }
390
391 /* Ups the semaphore.  If it was < 0, we need to wake up someone, which we do.
392  * Returns TRUE if we woke someone, FALSE o/w (used for debugging in some
393  * places).  If we need more control, we can implement a version of the old
394  * __up_sem() again.  */
395 bool sem_up(struct semaphore *sem)
396 {
397         struct kthread *kthread = 0;
398         spin_lock(&sem->lock);
399         if (sem->nr_signals++ < 0) {
400                 assert(!TAILQ_EMPTY(&sem->waiters));
401                 /* could do something with 'priority' here */
402                 kthread = TAILQ_FIRST(&sem->waiters);
403                 TAILQ_REMOVE(&sem->waiters, kthread, link);
404         } else {
405                 assert(TAILQ_EMPTY(&sem->waiters));
406         }
407         debug_upped_sem(sem);
408         spin_unlock(&sem->lock);
409         /* Note that once we call kthread_runnable(), we cannot touch the sem again.
410          * Some sems are on stacks.  The caller can touch sem, if it knows about the
411          * memory/usage of the sem.  Likewise, we can't touch the kthread either. */
412         if (kthread) {
413                 kthread_runnable(kthread);
414                 return TRUE;
415         }
416         return FALSE;
417 }
418
419 bool sem_trydown_irqsave(struct semaphore *sem, int8_t *irq_state)
420 {
421         bool ret;
422         disable_irqsave(irq_state);
423         ret = sem_trydown(sem);
424         enable_irqsave(irq_state);
425         return ret;
426 }
427
428 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
429 {
430         disable_irqsave(irq_state);
431         sem_down(sem);
432         enable_irqsave(irq_state);
433 }
434
435 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state)
436 {
437         bool retval;
438         disable_irqsave(irq_state);
439         retval = sem_up(sem);
440         enable_irqsave(irq_state);
441         return retval;
442 }
443
444 /* Sem debugging */
445
446 #ifdef CONFIG_SEMAPHORE_DEBUG
447 struct semaphore_tailq sems_with_waiters =
448                        TAILQ_HEAD_INITIALIZER(sems_with_waiters);
449 spinlock_t sems_with_waiters_lock = SPINLOCK_INITIALIZER_IRQSAVE;
450
451 /* this gets called any time we downed the sem, regardless of whether or not we
452  * waited */
453 static void debug_downed_sem(struct semaphore *sem)
454 {
455         sem->bt_pc = read_pc();
456         sem->bt_fp = read_bp();
457         sem->calling_core = core_id();
458         if (TAILQ_EMPTY(&sem->waiters) || sem->is_on_list)
459                 return;
460         spin_lock_irqsave(&sems_with_waiters_lock);
461         TAILQ_INSERT_HEAD(&sems_with_waiters, sem, link);
462         spin_unlock_irqsave(&sems_with_waiters_lock);
463         sem->is_on_list = TRUE;
464 }
465
466 /* Called when a sem is upped.  It may or may not have waiters, and it may or
467  * may not be on the list. (we could up several times past 0). */
468 static void debug_upped_sem(struct semaphore *sem)
469 {
470         if (TAILQ_EMPTY(&sem->waiters) && sem->is_on_list) {
471                 spin_lock_irqsave(&sems_with_waiters_lock);
472                 TAILQ_REMOVE(&sems_with_waiters, sem, link);
473                 spin_unlock_irqsave(&sems_with_waiters_lock);
474                 sem->is_on_list = FALSE;
475         }
476 }
477
478 #else
479
480 static void debug_downed_sem(struct semaphore *sem)
481 {
482         /* no debugging */
483 }
484
485 static void debug_upped_sem(struct semaphore *sem)
486 {
487         /* no debugging */
488 }
489
490 #endif /* CONFIG_SEMAPHORE_DEBUG */
491
492 void print_sem_info(struct semaphore *sem)
493 {
494         struct kthread *kth_i;
495         /* Always safe to irqsave */
496         spin_lock_irqsave(&sem->lock);
497         printk("Semaphore %p has %d signals (neg = waiters)", sem, sem->nr_signals);
498 #ifdef CONFIG_SEMAPHORE_DEBUG
499         printk(", recently downed on core %d with pc/frame %p %p\n",
500                sem->calling_core, sem->bt_pc, sem->bt_fp);
501 #else
502         printk("\n");
503 #endif /* CONFIG_SEMAPHORE_DEBUG */
504         TAILQ_FOREACH(kth_i, &sem->waiters, link)
505                 printk("\tKthread %p (%s), proc %d (%p), sysc %p\n", kth_i, kth_i->name,
506                        kth_i->proc ? kth_i->proc->pid : 0, kth_i->proc, kth_i->sysc);
507         spin_unlock_irqsave(&sem->lock);
508 }
509
510 void print_all_sem_info(void)
511 {
512 #ifdef CONFIG_SEMAPHORE_DEBUG
513         struct semaphore *sem_i;
514         printk("All sems with waiters:\n");
515         spin_lock_irqsave(&sems_with_waiters_lock);
516         TAILQ_FOREACH(sem_i, &sems_with_waiters, link)
517                 print_sem_info(sem_i);
518         spin_unlock_irqsave(&sems_with_waiters_lock);
519 #else
520         printk("Failed to print all sems: build with CONFIG_SEMAPHORE_DEBUG\n");
521 #endif
522 }
523
524 /* Condition variables, using semaphores and kthreads */
525 void cv_init(struct cond_var *cv)
526 {
527         sem_init(&cv->sem, 0);
528         cv->lock = &cv->internal_lock;
529         spinlock_init(cv->lock);
530         cv->nr_waiters = 0;
531         cv->irq_okay = FALSE;
532 }
533
534 void cv_init_irqsave(struct cond_var *cv)
535 {
536         sem_init_irqsave(&cv->sem, 0);
537         cv->lock = &cv->internal_lock;
538         spinlock_init_irqsave(cv->lock);
539         cv->nr_waiters = 0;
540         cv->irq_okay = TRUE;
541 }
542
543 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock)
544 {
545         sem_init(&cv->sem, 0);
546         cv->nr_waiters = 0;
547         cv->lock = lock;
548         cv->irq_okay = FALSE;
549 }
550
551 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock)
552 {
553         sem_init_irqsave(&cv->sem, 0);
554         cv->nr_waiters = 0;
555         cv->lock = lock;
556         cv->irq_okay = TRUE;
557 }
558
559 void cv_lock(struct cond_var *cv)
560 {
561         spin_lock(cv->lock);
562 }
563
564 void cv_unlock(struct cond_var *cv)
565 {
566         spin_unlock(cv->lock);
567 }
568
569 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state)
570 {
571         disable_irqsave(irq_state);
572         cv_lock(cv);
573 }
574
575 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state)
576 {
577         cv_unlock(cv);
578         enable_irqsave(irq_state);
579 }
580
581 /* Helper to clarify the wait/signalling code */
582 static int nr_sem_waiters(struct semaphore *sem)
583 {
584         int retval;
585         retval = 0 - sem->nr_signals;
586         assert(retval >= 0);
587         return retval;
588 }
589
590 /* Comes in locked.  Note we don't mess with enabling/disabling irqs.  The
591  * initial cv_lock would have disabled irqs (if applicable), and we don't mess
592  * with that setting at all. */
593 void cv_wait_and_unlock(struct cond_var *cv)
594 {
595         unsigned long nr_prev_waiters;
596         nr_prev_waiters = cv->nr_waiters++;
597         spin_unlock(cv->lock);
598         /* Wait til our turn.  This forces an ordering of all waiters such that the
599          * order in which they wait is the order in which they down the sem. */
600         while (nr_prev_waiters != nr_sem_waiters(&cv->sem))
601                 cpu_relax();
602         printd("core %d, sees nr_sem_waiters: %d, cv_nr_waiters %d\n",
603                core_id(), nr_sem_waiters(&cv->sem), cv->nr_waiters);
604         /* Atomically sleeps and 'unlocks' the next kthread from its busy loop (the
605          * one right above this), when it changes the sems nr_signals/waiters. */
606         sem_down(&cv->sem);
607 }
608
609 /* Comes in locked.  Note cv_lock does not disable irqs.   They should still be
610  * disabled from the initial cv_lock_irqsave(). */
611 void cv_wait(struct cond_var *cv)
612 {
613         cv_wait_and_unlock(cv);
614         if (cv->irq_okay)
615                 assert(!irq_is_enabled());
616         cv_lock(cv);
617 }
618
619 /* Helper, wakes exactly one, and there should have been at least one waiter. */
620 static void sem_wake_one(struct semaphore *sem)
621 {
622         struct kthread *kthread;
623         /* these locks will be irqsaved if the CV is irqsave (only need the one) */
624         spin_lock(&sem->lock);
625         assert(sem->nr_signals < 0);
626         sem->nr_signals++;
627         kthread = TAILQ_FIRST(&sem->waiters);
628         TAILQ_REMOVE(&sem->waiters, kthread, link);
629         debug_upped_sem(sem);
630         spin_unlock(&sem->lock);
631         kthread_runnable(kthread);
632 }
633
634 void __cv_signal(struct cond_var *cv)
635 {
636         /* Can't short circuit this stuff.  We need to make sure any waiters that
637          * made it past upping the cv->nr_waiters has also downed the sem.
638          * Otherwise we muck with nr_waiters, which could break the ordering
639          * required by the waiters.  We also need to lock while making this check,
640          * o/w a new waiter can slip in after our while loop. */
641         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
642                 cpu_relax();
643         if (cv->nr_waiters) {
644                 cv->nr_waiters--;
645                 sem_wake_one(&cv->sem);
646         }
647 }
648
649 void __cv_broadcast(struct cond_var *cv)
650 {
651         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
652                 cpu_relax();
653         while (cv->nr_waiters) {
654                 cv->nr_waiters--;
655                 sem_wake_one(&cv->sem);
656         }
657 }
658
659 void cv_signal(struct cond_var *cv)
660 {
661         spin_lock(cv->lock);
662         __cv_signal(cv);
663         spin_unlock(cv->lock);
664 }
665
666 void cv_broadcast(struct cond_var *cv)
667 {
668         spin_lock(cv->lock);
669         __cv_broadcast(cv);
670         spin_unlock(cv->lock);
671 }
672
673 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state)
674 {
675         disable_irqsave(irq_state);
676         cv_signal(cv);
677         enable_irqsave(irq_state);
678 }
679
680 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state)
681 {
682         disable_irqsave(irq_state);
683         cv_broadcast(cv);
684         enable_irqsave(irq_state);
685 }
686
687 /* Helper, aborts and releases a CLE.  dereg_ spinwaits on abort_in_progress. */
688 static void __abort_and_release_cle(struct cv_lookup_elm *cle)
689 {
690         int8_t irq_state = 0;
691         /* At this point, we have a handle on the syscall that we want to abort (via
692          * the cle), and we know none of the memory will disappear on us (deregers
693          * wait on the flag).  So we'll signal ABORT, which rendez will pick up next
694          * time it is awake.  Then we make sure it is awake with a broadcast. */
695         atomic_or(&cle->sysc->flags, SC_ABORT);
696         cmb();  /* flags write before signal; atomic op provided CPU mb */
697         cv_broadcast_irqsave(cle->cv, &irq_state);
698         cmb();  /* broadcast writes before abort flag; atomic op provided CPU mb */
699         atomic_dec(&cle->abort_in_progress);
700 }
701
702 /* Attempts to abort p's sysc.  It will only do so if the sysc lookup succeeds,
703  * so we can handle "guesses" for syscalls that might not be sleeping.  This
704  * style of "do it if you know you can" is the best way here - anything else
705  * runs into situations where you don't know if the memory is safe to touch or
706  * not (we're doing a lookup via pointer address, and only dereferencing if that
707  * succeeds).  Even something simple like letting userspace write SC_ABORT is
708  * very hard for them, since they don't know a sysc's state for sure (under the
709  * current system).
710  *
711  * Here are the rules:
712  * - if you're flagged SC_ABORT, you don't sleep
713  * - if you sleep, you're on the list
714  * - if you are on the list or abort_in_progress is set, CV is signallable, and
715  *   all the memory for CLE is safe */
716 bool abort_sysc(struct proc *p, struct syscall *sysc)
717 {
718         struct cv_lookup_elm *cle;
719         int8_t irq_state = 0;
720         spin_lock_irqsave(&p->abort_list_lock);
721         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
722                 if (cle->sysc == sysc) {
723                         /* Note: we could have multiple aborters, so we need to use a
724                          * numeric refcnt instead of a flag. */
725                         atomic_inc(&cle->abort_in_progress);
726                         break;
727                 }
728         }
729         spin_unlock_irqsave(&p->abort_list_lock);
730         if (!cle)
731                 return FALSE;
732         __abort_and_release_cle(cle);
733         return TRUE;
734 }
735
736 /* This will abort any abortabls at the time the call was started.  New
737  * abortables could be registered concurrently.  The main caller I see for this
738  * is proc_destroy(), so DYING will be set, and new abortables will quickly
739  * abort and dereg when they see their proc is DYING. */
740 void abort_all_sysc(struct proc *p)
741 {
742         struct cv_lookup_elm *cle;
743         int8_t irq_state = 0;
744         struct cv_lookup_tailq abortall_list;
745         struct proc *old_proc = switch_to(p);
746         /* Concerns: we need to not remove them from their original list, since
747          * concurrent wake ups will cause a dereg, which will remove from the list.
748          * We also can't touch freed memory, so we need a refcnt to keep cles
749          * around. */
750         TAILQ_INIT(&abortall_list);
751         spin_lock_irqsave(&p->abort_list_lock);
752         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
753                 atomic_inc(&cle->abort_in_progress);
754                 TAILQ_INSERT_HEAD(&abortall_list, cle, abortall_link);
755         }
756         spin_unlock_irqsave(&p->abort_list_lock);
757         TAILQ_FOREACH(cle, &abortall_list, abortall_link)
758                 __abort_and_release_cle(cle);
759         switch_back(p, old_proc);
760 }
761
762 /* Being on the abortable list means that the CLE, KTH, SYSC, and CV are valid
763  * memory.  The lock ordering is {CV lock, list_lock}.  Callers to this *will*
764  * have CV held.  This is done to avoid excessive locking in places like
765  * rendez_sleep, which want to check the condition before registering. */
766 void __reg_abortable_cv(struct cv_lookup_elm *cle, struct cond_var *cv)
767 {
768         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
769         cle->cv = cv;
770         cle->kthread = pcpui->cur_kthread;
771         /* Could be a ktask.  Can build in support for aborting these later */
772         if (cle->kthread->is_ktask) {
773                 cle->sysc = 0;
774                 return;
775         }
776         cle->sysc = cle->kthread->sysc;
777         assert(cle->sysc);
778         cle->proc = pcpui->cur_proc;
779         atomic_init(&cle->abort_in_progress, 0);
780         spin_lock_irqsave(&cle->proc->abort_list_lock);
781         TAILQ_INSERT_HEAD(&cle->proc->abortable_sleepers, cle, link);
782         spin_unlock_irqsave(&cle->proc->abort_list_lock);
783 }
784
785 /* We're racing with the aborter too, who will hold the flag in cle to protect
786  * its ref on our cle.  While the lock ordering is CV, list, callers to this
787  * must *not* have the cv lock held.  The reason is this waits on a successful
788  * abort_sysc, which is trying to cv_{signal,broadcast}, which could wait on the
789  * CV lock.  So if we hold the CV lock, we can deadlock (circular dependency).*/
790 void dereg_abortable_cv(struct cv_lookup_elm *cle)
791 {
792         if (cle->kthread->is_ktask)
793                 return;
794         assert(cle->proc);
795         spin_lock_irqsave(&cle->proc->abort_list_lock);
796         TAILQ_REMOVE(&cle->proc->abortable_sleepers, cle, link);
797         spin_unlock_irqsave(&cle->proc->abort_list_lock);
798         /* If we won the race and yanked it out of the list before abort claimed it,
799          * this will already be FALSE. */
800         while (atomic_read(&cle->abort_in_progress))
801                 cpu_relax();
802 }
803
804 /* Helper to sleepers to know if they should abort or not.  I'll probably extend
805  * this with things for ktasks in the future. */
806 bool should_abort(struct cv_lookup_elm *cle)
807 {
808         if (cle->kthread->is_ktask)
809                 return FALSE;
810         if (cle->proc && (cle->proc->state == PROC_DYING))
811                 return TRUE;
812         if (cle->sysc && (atomic_read(&cle->sysc->flags) & SC_ABORT))
813                 return TRUE;
814         return FALSE;
815 }