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