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