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