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