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