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