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