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