CLEANUP: Remove trailing whitespace throughout the kernel.
[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
255 static void sem_init_common(struct semaphore *sem, int signals)
256 {
257         TAILQ_INIT(&sem->waiters);
258         sem->nr_signals = signals;
259 #ifdef CONFIG_SEMAPHORE_DEBUG
260         sem->is_on_list = FALSE;
261         sem->bt_pc = 0;
262         sem->bt_fp = 0;
263         sem->calling_core = 0;
264 #endif
265 }
266
267 void sem_init(struct semaphore *sem, int signals)
268 {
269         sem_init_common(sem, signals);
270         spinlock_init(&sem->lock);
271         sem->irq_okay = FALSE;
272 }
273
274 void sem_init_irqsave(struct semaphore *sem, int signals)
275 {
276         sem_init_common(sem, signals);
277         spinlock_init_irqsave(&sem->lock);
278         sem->irq_okay = TRUE;
279 }
280
281 bool sem_trydown(struct semaphore *sem)
282 {
283         bool ret = FALSE;
284         /* lockless peek */
285         if (sem->nr_signals <= 0)
286                 return ret;
287         spin_lock(&sem->lock);
288         if (sem->nr_signals > 0) {
289                 sem->nr_signals--;
290                 ret = TRUE;
291                 debug_downed_sem(sem);
292         }
293         spin_unlock(&sem->lock);
294         return ret;
295 }
296
297 /* This downs the semaphore and suspends the current kernel context on its
298  * waitqueue if there are no pending signals.  Note that the case where the
299  * signal is already there is not optimized. */
300 void sem_down(struct semaphore *sem)
301 {
302         struct kthread *kthread, *new_kthread;
303         register uintptr_t new_stacktop;
304         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
305         bool irqs_were_on = irq_is_enabled();
306
307         assert(can_block(pcpui));
308         /* Make sure we aren't holding any locks (only works if SPINLOCK_DEBUG) */
309         if (pcpui->lock_depth)
310                 panic("Kthread tried to sleep, with lockdepth %d\n", pcpui->lock_depth);
311         assert(pcpui->cur_kthread);
312         /* Try to down the semaphore.  If there is a signal there, we can skip all
313          * of the sleep prep and just return. */
314 #ifdef CONFIG_SEM_SPINWAIT
315         for (int i = 0; i < CONFIG_SEM_SPINWAIT_NR_LOOPS; i++) {
316                 if (sem_trydown(sem))
317                         goto block_return_path;
318                 cpu_relax();
319         }
320 #else
321         if (sem_trydown(sem))
322                 goto block_return_path;
323 #endif
324 #ifdef CONFIG_SEM_TRACE_BLOCKERS
325         TRACEME();
326 #endif
327         /* We're probably going to sleep, so get ready.  We'll check again later. */
328         kthread = pcpui->cur_kthread;
329         /* We need to have a spare slot for restart, so we also use it when
330          * sleeping.  Right now, we need a new kthread to take over if/when our
331          * current kthread sleeps.  Use the spare, and if not, get a new one.
332          *
333          * Note we do this with interrupts disabled (which protects us from
334          * concurrent modifications). */
335         if (pcpui->spare) {
336                 new_kthread = pcpui->spare;
337                 new_stacktop = new_kthread->stacktop;
338                 pcpui->spare = 0;
339                 /* The old flags could have KTH_IS_KTASK set.  The reason is that the
340                  * launching of blocked kthreads also uses PRKM, and that KMSG
341                  * (__launch_kthread) doesn't return.  Thus the soon-to-be spare
342                  * kthread, that is launching another, has flags & KTH_IS_KTASK set. */
343                 new_kthread->flags = KTH_DEFAULT_FLAGS;
344                 new_kthread->proc = 0;
345                 new_kthread->name = 0;
346         } else {
347                 new_kthread = __kthread_zalloc();
348                 new_kthread->flags = KTH_DEFAULT_FLAGS;
349                 new_stacktop = get_kstack();
350                 new_kthread->stacktop = new_stacktop;
351 #ifdef CONFIG_KTHREAD_POISON
352                 *kstack_bottom_addr(new_stacktop) = 0;
353 #endif /* CONFIG_KTHREAD_POISON */
354         }
355         /* Set the core's new default stack and kthread */
356         set_stack_top(new_stacktop);
357         pcpui->cur_kthread = new_kthread;
358 #ifdef CONFIG_KTHREAD_POISON
359         /* Mark the new stack as in-use, and unmark the current kthread */
360         uintptr_t *new_stack_poison, *kth_stack_poison;
361         new_stack_poison = kstack_bottom_addr(new_stacktop);
362         assert(!*new_stack_poison);
363         *new_stack_poison = 0xdeadbeef;
364         kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
365         assert(*kth_stack_poison == 0xdeadbeef);
366         *kth_stack_poison = 0;
367 #endif /* CONFIG_KTHREAD_POISON */
368         /* Kthreads that are ktasks are not related to any process, and do not need
369          * to work in a process's address space.  They can operate in any address
370          * space that has the kernel mapped (like boot_pgdir, or any pgdir).  Some
371          * ktasks may switch_to, at which point they do care about the address
372          * space and must maintain a reference.
373          *
374          * Normal kthreads need to stay in the process context, but we want the core
375          * (which could be a vcore) to stay in the context too. */
376         if (kthread->flags & KTH_SAVE_ADDR_SPACE) {
377                 kthread->proc = current;
378                 assert(kthread->proc);
379                 /* In the future, we could check owning_proc. If it isn't set, we could
380                  * clear current and transfer the refcnt to kthread->proc. */
381                 proc_incref(kthread->proc, 1);
382         } else {
383                 kthread->proc = 0;
384         }
385         if (setjmp(&kthread->context))
386                 goto block_return_path;
387         spin_lock(&sem->lock);
388         if (sem->nr_signals-- <= 0) {
389                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
390                 debug_downed_sem(sem);  /* need to debug after inserting */
391                 /* At this point, we know we'll sleep and change stacks later.  Once we
392                  * unlock, we could have the kthread restarted (possibly on another
393                  * core), so we need to disable irqs until we are on our new stack.
394                  * Otherwise, if we take an IRQ, we'll be using our stack while another
395                  * core is using it (restarted kthread).  Basically, disabling irqs
396                  * allows us to atomically unlock and 'yield'.  Also, IRQs might have
397                  * already been disabled if this was an irqsave sem. */
398                 disable_irq();
399                 spin_unlock(&sem->lock);
400                 /* Switch to the core's default stack.  After this, don't use local
401                  * variables. */
402                 set_stack_pointer(new_stacktop);
403                 smp_idle();                                                     /* reenables irqs eventually */
404                 assert(0);
405         }
406         /* We get here if we should not sleep on sem (the signal beat the sleep).
407          * We debug_downed_sem since we actually downed it - just didn't sleep. */
408         debug_downed_sem(sem);
409         spin_unlock(&sem->lock);
410         printd("[kernel] Didn't sleep, unwinding...\n");
411         /* Restore the core's current and default stacktop */
412         current = kthread->proc;                        /* arguably unnecessary */
413         if (kthread->proc)
414                 proc_decref(kthread->proc);
415         set_stack_top(kthread->stacktop);
416         pcpui->cur_kthread = kthread;
417         /* Save the allocs as the spare */
418         assert(!pcpui->spare);
419         pcpui->spare = new_kthread;
420 #ifdef CONFIG_KTHREAD_POISON
421         /* switch back to old stack in use, new one not */
422         *new_stack_poison = 0;
423         *kth_stack_poison = 0xdeadbeef;
424 #endif /* CONFIG_KTHREAD_POISON */
425 block_return_path:
426         printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
427         /* restart_kthread and longjmp did not reenable IRQs.  We need to make sure
428          * irqs are on if they were on when we started to block.  If they were
429          * already on and we short-circuited the block, it's harmless to reenable
430          * them. */
431         if (irqs_were_on)
432                 enable_irq();
433         return;
434 }
435
436 /* Ups the semaphore.  If it was < 0, we need to wake up someone, which we do.
437  * Returns TRUE if we woke someone, FALSE o/w (used for debugging in some
438  * places).  If we need more control, we can implement a version of the old
439  * __up_sem() again.  */
440 bool sem_up(struct semaphore *sem)
441 {
442         struct kthread *kthread = 0;
443         spin_lock(&sem->lock);
444         if (sem->nr_signals++ < 0) {
445                 assert(!TAILQ_EMPTY(&sem->waiters));
446                 /* could do something with 'priority' here */
447                 kthread = TAILQ_FIRST(&sem->waiters);
448                 TAILQ_REMOVE(&sem->waiters, kthread, link);
449         } else {
450                 assert(TAILQ_EMPTY(&sem->waiters));
451         }
452         debug_upped_sem(sem);
453         spin_unlock(&sem->lock);
454         /* Note that once we call kthread_runnable(), we cannot touch the sem again.
455          * Some sems are on stacks.  The caller can touch sem, if it knows about the
456          * memory/usage of the sem.  Likewise, we can't touch the kthread either. */
457         if (kthread) {
458                 kthread_runnable(kthread);
459                 return TRUE;
460         }
461         return FALSE;
462 }
463
464 bool sem_trydown_irqsave(struct semaphore *sem, int8_t *irq_state)
465 {
466         bool ret;
467         disable_irqsave(irq_state);
468         ret = sem_trydown(sem);
469         enable_irqsave(irq_state);
470         return ret;
471 }
472
473 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
474 {
475         disable_irqsave(irq_state);
476         sem_down(sem);
477         enable_irqsave(irq_state);
478 }
479
480 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state)
481 {
482         bool retval;
483         disable_irqsave(irq_state);
484         retval = sem_up(sem);
485         enable_irqsave(irq_state);
486         return retval;
487 }
488
489 /* Sem debugging */
490
491 #ifdef CONFIG_SEMAPHORE_DEBUG
492 struct semaphore_tailq sems_with_waiters =
493                        TAILQ_HEAD_INITIALIZER(sems_with_waiters);
494 spinlock_t sems_with_waiters_lock = SPINLOCK_INITIALIZER_IRQSAVE;
495
496 /* this gets called any time we downed the sem, regardless of whether or not we
497  * waited */
498 static void debug_downed_sem(struct semaphore *sem)
499 {
500         sem->bt_pc = read_pc();
501         sem->bt_fp = read_bp();
502         sem->calling_core = core_id();
503         if (TAILQ_EMPTY(&sem->waiters) || sem->is_on_list)
504                 return;
505         spin_lock_irqsave(&sems_with_waiters_lock);
506         TAILQ_INSERT_HEAD(&sems_with_waiters, sem, link);
507         spin_unlock_irqsave(&sems_with_waiters_lock);
508         sem->is_on_list = TRUE;
509 }
510
511 /* Called when a sem is upped.  It may or may not have waiters, and it may or
512  * may not be on the list. (we could up several times past 0). */
513 static void debug_upped_sem(struct semaphore *sem)
514 {
515         if (TAILQ_EMPTY(&sem->waiters) && sem->is_on_list) {
516                 spin_lock_irqsave(&sems_with_waiters_lock);
517                 TAILQ_REMOVE(&sems_with_waiters, sem, link);
518                 spin_unlock_irqsave(&sems_with_waiters_lock);
519                 sem->is_on_list = FALSE;
520         }
521 }
522
523 #else
524
525 static void debug_downed_sem(struct semaphore *sem)
526 {
527         /* no debugging */
528 }
529
530 static void debug_upped_sem(struct semaphore *sem)
531 {
532         /* no debugging */
533 }
534
535 #endif /* CONFIG_SEMAPHORE_DEBUG */
536
537 void print_sem_info(struct semaphore *sem)
538 {
539         struct kthread *kth_i;
540         /* Always safe to irqsave */
541         spin_lock_irqsave(&sem->lock);
542         printk("Semaphore %p has %d signals (neg = waiters)", sem, sem->nr_signals);
543 #ifdef CONFIG_SEMAPHORE_DEBUG
544         printk(", recently downed on core %d with pc/frame %p %p\n",
545                sem->calling_core, sem->bt_pc, sem->bt_fp);
546 #else
547         printk("\n");
548 #endif /* CONFIG_SEMAPHORE_DEBUG */
549         TAILQ_FOREACH(kth_i, &sem->waiters, link)
550                 printk("\tKthread %p (%s), proc %d (%p), sysc %p\n", kth_i, kth_i->name,
551                        kth_i->proc ? kth_i->proc->pid : 0, kth_i->proc, kth_i->sysc);
552         printk("\n");
553         spin_unlock_irqsave(&sem->lock);
554 }
555
556 void print_all_sem_info(void)
557 {
558 #ifdef CONFIG_SEMAPHORE_DEBUG
559         struct semaphore *sem_i;
560         printk("All sems with waiters:\n");
561         spin_lock_irqsave(&sems_with_waiters_lock);
562         TAILQ_FOREACH(sem_i, &sems_with_waiters, link)
563                 print_sem_info(sem_i);
564         spin_unlock_irqsave(&sems_with_waiters_lock);
565 #else
566         printk("Failed to print all sems: build with CONFIG_SEMAPHORE_DEBUG\n");
567 #endif
568 }
569
570 /* Condition variables, using semaphores and kthreads */
571 void cv_init(struct cond_var *cv)
572 {
573         sem_init(&cv->sem, 0);
574         cv->lock = &cv->internal_lock;
575         spinlock_init(cv->lock);
576         cv->nr_waiters = 0;
577         cv->irq_okay = FALSE;
578 }
579
580 void cv_init_irqsave(struct cond_var *cv)
581 {
582         sem_init_irqsave(&cv->sem, 0);
583         cv->lock = &cv->internal_lock;
584         spinlock_init_irqsave(cv->lock);
585         cv->nr_waiters = 0;
586         cv->irq_okay = TRUE;
587 }
588
589 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock)
590 {
591         sem_init(&cv->sem, 0);
592         cv->nr_waiters = 0;
593         cv->lock = lock;
594         cv->irq_okay = FALSE;
595 }
596
597 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock)
598 {
599         sem_init_irqsave(&cv->sem, 0);
600         cv->nr_waiters = 0;
601         cv->lock = lock;
602         cv->irq_okay = TRUE;
603 }
604
605 void cv_lock(struct cond_var *cv)
606 {
607         spin_lock(cv->lock);
608 }
609
610 void cv_unlock(struct cond_var *cv)
611 {
612         spin_unlock(cv->lock);
613 }
614
615 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state)
616 {
617         disable_irqsave(irq_state);
618         cv_lock(cv);
619 }
620
621 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state)
622 {
623         cv_unlock(cv);
624         enable_irqsave(irq_state);
625 }
626
627 /* Helper to clarify the wait/signalling code */
628 static int nr_sem_waiters(struct semaphore *sem)
629 {
630         int retval;
631         retval = 0 - sem->nr_signals;
632         assert(retval >= 0);
633         return retval;
634 }
635
636 /* Comes in locked.  Note we don't mess with enabling/disabling irqs.  The
637  * initial cv_lock would have disabled irqs (if applicable), and we don't mess
638  * with that setting at all. */
639 void cv_wait_and_unlock(struct cond_var *cv)
640 {
641         unsigned long nr_prev_waiters;
642         nr_prev_waiters = cv->nr_waiters++;
643         spin_unlock(cv->lock);
644         /* Wait til our turn.  This forces an ordering of all waiters such that the
645          * order in which they wait is the order in which they down the sem. */
646         while (nr_prev_waiters != nr_sem_waiters(&cv->sem))
647                 cpu_relax();
648         printd("core %d, sees nr_sem_waiters: %d, cv_nr_waiters %d\n",
649                core_id(), nr_sem_waiters(&cv->sem), cv->nr_waiters);
650         /* Atomically sleeps and 'unlocks' the next kthread from its busy loop (the
651          * one right above this), when it changes the sems nr_signals/waiters. */
652         sem_down(&cv->sem);
653 }
654
655 /* Comes in locked.  Note cv_lock does not disable irqs.   They should still be
656  * disabled from the initial cv_lock_irqsave(). */
657 void cv_wait(struct cond_var *cv)
658 {
659         cv_wait_and_unlock(cv);
660         if (cv->irq_okay)
661                 assert(!irq_is_enabled());
662         cv_lock(cv);
663 }
664
665 /* Helper, wakes exactly one, and there should have been at least one waiter. */
666 static void sem_wake_one(struct semaphore *sem)
667 {
668         struct kthread *kthread;
669         /* these locks will be irqsaved if the CV is irqsave (only need the one) */
670         spin_lock(&sem->lock);
671         assert(sem->nr_signals < 0);
672         sem->nr_signals++;
673         kthread = TAILQ_FIRST(&sem->waiters);
674         TAILQ_REMOVE(&sem->waiters, kthread, link);
675         debug_upped_sem(sem);
676         spin_unlock(&sem->lock);
677         kthread_runnable(kthread);
678 }
679
680 void __cv_signal(struct cond_var *cv)
681 {
682         /* Can't short circuit this stuff.  We need to make sure any waiters that
683          * made it past upping the cv->nr_waiters has also downed the sem.
684          * Otherwise we muck with nr_waiters, which could break the ordering
685          * required by the waiters.  We also need to lock while making this check,
686          * o/w a new waiter can slip in after our while loop. */
687         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
688                 cpu_relax();
689         if (cv->nr_waiters) {
690                 cv->nr_waiters--;
691                 sem_wake_one(&cv->sem);
692         }
693 }
694
695 void __cv_broadcast(struct cond_var *cv)
696 {
697         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
698                 cpu_relax();
699         while (cv->nr_waiters) {
700                 cv->nr_waiters--;
701                 sem_wake_one(&cv->sem);
702         }
703 }
704
705 void cv_signal(struct cond_var *cv)
706 {
707         spin_lock(cv->lock);
708         __cv_signal(cv);
709         spin_unlock(cv->lock);
710 }
711
712 void cv_broadcast(struct cond_var *cv)
713 {
714         spin_lock(cv->lock);
715         __cv_broadcast(cv);
716         spin_unlock(cv->lock);
717 }
718
719 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state)
720 {
721         disable_irqsave(irq_state);
722         cv_signal(cv);
723         enable_irqsave(irq_state);
724 }
725
726 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state)
727 {
728         disable_irqsave(irq_state);
729         cv_broadcast(cv);
730         enable_irqsave(irq_state);
731 }
732
733 /* Helper, aborts and releases a CLE.  dereg_ spinwaits on abort_in_progress.
734  * This can throw a PF */
735 static void __abort_and_release_cle(struct cv_lookup_elm *cle)
736 {
737         int8_t irq_state = 0;
738         /* At this point, we have a handle on the syscall that we want to abort (via
739          * the cle), and we know none of the memory will disappear on us (deregers
740          * wait on the flag).  So we'll signal ABORT, which rendez will pick up next
741          * time it is awake.  Then we make sure it is awake with a broadcast. */
742         atomic_or(&cle->sysc->flags, SC_ABORT);
743         cmb();  /* flags write before signal; atomic op provided CPU mb */
744         cv_broadcast_irqsave(cle->cv, &irq_state);
745         cmb();  /* broadcast writes before abort flag; atomic op provided CPU mb */
746         atomic_dec(&cle->abort_in_progress);
747 }
748
749 /* Attempts to abort p's sysc.  It will only do so if the sysc lookup succeeds,
750  * so we can handle "guesses" for syscalls that might not be sleeping.  This
751  * style of "do it if you know you can" is the best way here - anything else
752  * runs into situations where you don't know if the memory is safe to touch or
753  * not (we're doing a lookup via pointer address, and only dereferencing if that
754  * succeeds).  Even something simple like letting userspace write SC_ABORT is
755  * very hard for them, since they don't know a sysc's state for sure (under the
756  * current system).
757  *
758  * Here are the rules:
759  * - if you're flagged SC_ABORT, you don't sleep
760  * - if you sleep, you're on the list
761  * - if you are on the list or abort_in_progress is set, CV is signallable, and
762  *   all the memory for CLE is safe */
763 bool abort_sysc(struct proc *p, struct syscall *sysc)
764 {
765         ERRSTACK(1);
766         struct cv_lookup_elm *cle;
767         int8_t irq_state = 0;
768
769         spin_lock_irqsave(&p->abort_list_lock);
770         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
771                 if (cle->sysc == sysc) {
772                         /* Note: we could have multiple aborters, so we need to use a
773                          * numeric refcnt instead of a flag. */
774                         atomic_inc(&cle->abort_in_progress);
775                         break;
776                 }
777         }
778         spin_unlock_irqsave(&p->abort_list_lock);
779         if (!cle)
780                 return FALSE;
781         if (!waserror())        /* discard error */
782                 __abort_and_release_cle(cle);
783         poperror();
784         return TRUE;
785 }
786
787 /* This will abort any abortables at the time the call was started for which
788  * should_abort(cle, arg) returns true.  New abortables could be registered
789  * concurrently.  The original for this is proc_destroy(), so DYING will be set,
790  * and new abortables will quickly abort and dereg when they see their proc is
791  * DYING. */
792 static int __abort_all_sysc(struct proc *p,
793                             bool (*should_abort)(struct cv_lookup_elm*, void*),
794                             void *arg)
795 {
796         ERRSTACK(1);
797         struct cv_lookup_elm *cle;
798         int8_t irq_state = 0;
799         struct cv_lookup_tailq abortall_list;
800         uintptr_t old_proc = switch_to(p);
801         int ret = 0;
802
803         /* Concerns: we need to not remove them from their original list, since
804          * concurrent wake ups will cause a dereg, which will remove from the list.
805          * We also can't touch freed memory, so we need a refcnt to keep cles
806          * around. */
807         TAILQ_INIT(&abortall_list);
808         spin_lock_irqsave(&p->abort_list_lock);
809         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
810                 if (!should_abort(cle, arg))
811                         continue;
812                 atomic_inc(&cle->abort_in_progress);
813                 TAILQ_INSERT_HEAD(&abortall_list, cle, abortall_link);
814                 ret++;
815         }
816         spin_unlock_irqsave(&p->abort_list_lock);
817         if (!waserror()) { /* discard error */
818                 TAILQ_FOREACH(cle, &abortall_list, abortall_link)
819                         __abort_and_release_cle(cle);
820         }
821         poperror();
822         switch_back(p, old_proc);
823         return ret;
824 }
825
826 static bool always_abort(struct cv_lookup_elm *cle, void *arg)
827 {
828         return TRUE;
829 }
830
831 void abort_all_sysc(struct proc *p)
832 {
833         __abort_all_sysc(p, always_abort, 0);
834 }
835
836 /* cle->sysc could be a bad pointer.  we can either use copy_from_user (btw,
837  * we're already in their addr space) or we can use a waserror in
838  * __abort_all_sysc().  Both options are fine.  I went with it here for a couple
839  * reasons.  It is only this abort function pointer that accesses sysc, though
840  * that could change.  Our syscall aborting isn't plugged into a broader error()
841  * handler yet, which means we'd want to poperror instead of nexterror in
842  * __abort_all_sysc, and that would required int ret getting a volatile flag. */
843 static bool sysc_uses_fd(struct cv_lookup_elm *cle, void *fd)
844 {
845         struct syscall local_sysc;
846         int err;
847
848         err = copy_from_user(&local_sysc, cle->sysc, sizeof(struct syscall));
849         /* Trigger an abort on error */
850         if (err)
851                 return TRUE;
852         return syscall_uses_fd(&local_sysc, (int)(long)fd);
853 }
854
855 int abort_all_sysc_fd(struct proc *p, int fd)
856 {
857         return __abort_all_sysc(p, sysc_uses_fd, (void*)(long)fd);
858 }
859
860 /* Being on the abortable list means that the CLE, KTH, SYSC, and CV are valid
861  * memory.  The lock ordering is {CV lock, list_lock}.  Callers to this *will*
862  * have CV held.  This is done to avoid excessive locking in places like
863  * rendez_sleep, which want to check the condition before registering. */
864 void __reg_abortable_cv(struct cv_lookup_elm *cle, struct cond_var *cv)
865 {
866         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
867         cle->cv = cv;
868         cle->kthread = pcpui->cur_kthread;
869         /* Could be a ktask.  Can build in support for aborting these later */
870         if (is_ktask(cle->kthread)) {
871                 cle->sysc = 0;
872                 return;
873         }
874         cle->sysc = cle->kthread->sysc;
875         cle->proc = pcpui->cur_proc;
876         atomic_init(&cle->abort_in_progress, 0);
877         spin_lock_irqsave(&cle->proc->abort_list_lock);
878         TAILQ_INSERT_HEAD(&cle->proc->abortable_sleepers, cle, link);
879         spin_unlock_irqsave(&cle->proc->abort_list_lock);
880 }
881
882 /* We're racing with the aborter too, who will hold the flag in cle to protect
883  * its ref on our cle.  While the lock ordering is CV, list, callers to this
884  * must *not* have the cv lock held.  The reason is this waits on a successful
885  * abort_sysc, which is trying to cv_{signal,broadcast}, which could wait on the
886  * CV lock.  So if we hold the CV lock, we can deadlock (circular dependency).*/
887 void dereg_abortable_cv(struct cv_lookup_elm *cle)
888 {
889         if (is_ktask(cle->kthread))
890                 return;
891         assert(cle->proc);
892         spin_lock_irqsave(&cle->proc->abort_list_lock);
893         TAILQ_REMOVE(&cle->proc->abortable_sleepers, cle, link);
894         spin_unlock_irqsave(&cle->proc->abort_list_lock);
895         /* If we won the race and yanked it out of the list before abort claimed it,
896          * this will already be FALSE. */
897         while (atomic_read(&cle->abort_in_progress))
898                 cpu_relax();
899 }
900
901 /* Helper to sleepers to know if they should abort or not.  I'll probably extend
902  * this with things for ktasks in the future. */
903 bool should_abort(struct cv_lookup_elm *cle)
904 {
905         struct syscall local_sysc;
906         int err;
907
908         if (is_ktask(cle->kthread))
909                 return FALSE;
910         if (cle->proc && (cle->proc->state == PROC_DYING))
911                 return TRUE;
912         if (cle->sysc) {
913                 assert(cle->proc && (cle->proc == current));
914                 err = copy_from_user(&local_sysc, cle->sysc,
915                                      offsetof(struct syscall, flags) +
916                                      sizeof(cle->sysc->flags));
917                 /* just go ahead and abort if there was an error */
918                 if (err || (atomic_read(&local_sysc.flags) & SC_ABORT))
919                         return TRUE;
920         }
921         return FALSE;
922 }
923
924 /* Sometimes the kernel needs to switch out of process context and into a
925  * 'process-less' kernel thread.  This is basically a ktask.  We use this mostly
926  * when performing file ops as the kernel.  It's nasty, and all uses of this
927  * probably should be removed.  (TODO: KFOP). */
928 uintptr_t switch_to_ktask(void)
929 {
930         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
931         struct kthread *kth = pcpui->cur_kthread;
932
933         if (is_ktask(kth))
934                 return 0;
935         /* We leave the SAVE_ADDR_SPACE flag on.  Now we're basically a ktask that
936          * cares about its addr space, since we need to return to it (not that we're
937          * leaving). */
938         kth->flags |= KTH_IS_KTASK;
939         return 1;
940 }
941
942 void switch_back_from_ktask(uintptr_t old_ret)
943 {
944         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
945         struct kthread *kth = pcpui->cur_kthread;
946
947         if (old_ret)
948                 kth->flags &= ~KTH_IS_KTASK;
949 }