Jump to a real kstack ASAP during boot
[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 /* Helper during early boot, where we jump from the bootstack to a real kthread
63  * stack, then run f().  Note that we don't have a kthread yet (done in smp.c).
64  *
65  * After this, our callee (f) can free the bootstack, if we care, by adding it
66  * to the base arena (use the KERNBASE addr, not the KERN_LOAD_ADDR). */
67 void __use_real_kstack(void (*f)(void *arg))
68 {
69         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
70         uintptr_t new_stacktop;
71
72         new_stacktop = get_kstack();
73 #ifdef CONFIG_KTHREAD_POISON
74         *kstack_bottom_addr(new_stacktop) = 0xdeadbeef;
75 #endif /* CONFIG_KTHREAD_POISON */
76         set_stack_top(new_stacktop);
77         __reset_stack_pointer(0, new_stacktop, f);
78 }
79
80 /* Starts kthread on the calling core.  This does not return, and will handle
81  * the details of cleaning up whatever is currently running (freeing its stack,
82  * etc).  Pairs with sem_down(). */
83 void restart_kthread(struct kthread *kthread)
84 {
85         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
86         uintptr_t current_stacktop;
87         struct kthread *current_kthread;
88         /* Avoid messy complications.  The kthread will enable_irqsave() when it
89          * comes back up. */
90         disable_irq();
91         /* Free any spare, since we need the current to become the spare.  Without
92          * the spare, we can't free our current kthread/stack (we could free the
93          * kthread, but not the stack, since we're still on it).  And we can't free
94          * anything after popping kthread, since we never return. */
95         if (pcpui->spare) {
96                 put_kstack(pcpui->spare->stacktop);
97                 kmem_cache_free(kthread_kcache, pcpui->spare);
98         }
99         current_kthread = pcpui->cur_kthread;
100         current_stacktop = current_kthread->stacktop;
101         assert(!current_kthread->sysc); /* catch bugs, prev user should clear */
102         /* Set the spare stuff (current kthread, which includes its stacktop) */
103         pcpui->spare = current_kthread;
104         /* When a kthread runs, its stack is the default kernel stack */
105         set_stack_top(kthread->stacktop);
106         pcpui->cur_kthread = kthread;
107 #ifdef CONFIG_KTHREAD_POISON
108         /* Assert and switch to cur stack not in use, kthr stack in use */
109         uintptr_t *cur_stack_poison, *kth_stack_poison;
110         cur_stack_poison = kstack_bottom_addr(current_stacktop);
111         assert(*cur_stack_poison == 0xdeadbeef);
112         *cur_stack_poison = 0;
113         kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
114         assert(!*kth_stack_poison);
115         *kth_stack_poison = 0xdeadbeef;
116 #endif /* CONFIG_KTHREAD_POISON */
117         /* Only change current if we need to (the kthread was in process context) */
118         if (kthread->proc) {
119                 if (kthread->proc == pcpui->cur_proc) {
120                         /* We're already loaded, but we do need to drop the extra ref stored
121                          * in kthread->proc. */
122                         proc_decref(kthread->proc);
123                         kthread->proc = 0;
124                 } else {
125                         /* Load our page tables before potentially decreffing cur_proc */
126                         lcr3(kthread->proc->env_cr3);
127                         /* Might have to clear out an existing current.  If they need to be
128                          * set later (like in restartcore), it'll be done on demand. */
129                         if (pcpui->cur_proc)
130                                 proc_decref(pcpui->cur_proc);
131                         /* Transfer our counted ref from kthread->proc to cur_proc. */
132                         pcpui->cur_proc = kthread->proc;
133                         kthread->proc = 0;
134                 }
135         }
136         /* Finally, restart our thread */
137         longjmp(&kthread->context, 1);
138 }
139
140 /* Kmsg handler to launch/run a kthread.  This must be a routine message, since
141  * it does not return.  */
142 static void __launch_kthread(uint32_t srcid, long a0, long a1, long a2)
143 {
144         struct kthread *kthread = (struct kthread*)a0;
145         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
146         struct proc *cur_proc = pcpui->cur_proc;
147
148         /* Make sure we are a routine kmsg */
149         assert(in_early_rkmsg_ctx(pcpui));
150         if (pcpui->owning_proc && pcpui->owning_proc != kthread->proc) {
151                 /* Some process should be running here that is not the same as the
152                  * kthread.  This means the _M is getting interrupted or otherwise
153                  * delayed.  If we want to do something other than run it (like send the
154                  * kmsg to another pcore, or ship the context from here to somewhere
155                  * else/deschedule it (like for an _S)), do it here.
156                  *
157                  * If you want to do something here, call out to the ksched, then
158                  * abandon_core(). */
159                 cmb();  /* do nothing/placeholder */
160         }
161         /* o/w, just run the kthread.  any trapframes that are supposed to run or
162          * were interrupted will run whenever the kthread smp_idles() or otherwise
163          * finishes.  We also need to clear the RKMSG context since we will not
164          * return from restart_kth. */
165         clear_rkmsg(pcpui);
166         restart_kthread(kthread);
167         assert(0);
168 }
169
170 /* Call this when a kthread becomes runnable/unblocked.  We don't do anything
171  * particularly smart yet, but when we do, we can put it here. */
172 void kthread_runnable(struct kthread *kthread)
173 {
174         uint32_t dst = core_id();
175         #if 0
176         /* turn this block on if you want to test migrating non-core0 kthreads */
177         switch (dst) {
178                 case 0:
179                         break;
180                 case 7:
181                         dst = 2;
182                         break;
183                 default:
184                         dst++;
185         }
186         #endif
187         /* For lack of anything better, send it to ourselves. (TODO: KSCHED) */
188         send_kernel_message(dst, __launch_kthread, (long)kthread, 0, 0,
189                             KMSG_ROUTINE);
190 }
191
192 /* Kmsg helper for kthread_yield */
193 static void __wake_me_up(uint32_t srcid, long a0, long a1, long a2)
194 {
195         struct semaphore *sem = (struct semaphore*)a0;
196         assert(sem_up(sem));
197 }
198
199 /* Stop the current kthread.  It'll get woken up next time we run routine kmsgs,
200  * after all existing kmsgs are processed. */
201 void kthread_yield(void)
202 {
203         struct semaphore local_sem, *sem = &local_sem;
204         sem_init(sem, 0);
205         send_kernel_message(core_id(), __wake_me_up, (long)sem, 0, 0,
206                             KMSG_ROUTINE);
207         sem_down(sem);
208 }
209
210 void kthread_usleep(uint64_t usec)
211 {
212         ERRSTACK(1);
213         /* TODO: classic ksched issue: where do we want the wake up to happen? */
214         struct timer_chain *tchain = &per_cpu_info[core_id()].tchain;
215         struct rendez rv;
216
217         int ret_zero(void *ignored)
218         {
219                 return 0;
220         }
221
222         /* "discard the error" style (we run the conditional code) */
223         if (!waserror()) {
224                 rendez_init(&rv);
225                 rendez_sleep_timeout(&rv, ret_zero, 0, usec);
226         }
227         poperror();
228 }
229
230 static void __ktask_wrapper(uint32_t srcid, long a0, long a1, long a2)
231 {
232         ERRSTACK(1);
233         void (*fn)(void*) = (void (*)(void*))a0;
234         void *arg = (void*)a1;
235         char *name = (char*)a2;
236         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
237         assert(is_ktask(pcpui->cur_kthread));
238         pcpui->cur_kthread->name = name;
239         /* There are some rendezs out there that aren't wrapped.  Though no one can
240          * abort them.  Yet. */
241         if (waserror()) {
242                 printk("Ktask %s threw error %s\n", name, current_errstr());
243                 goto out;
244         }
245         enable_irq();
246         fn(arg);
247 out:
248         disable_irq();
249         pcpui->cur_kthread->name = 0;
250         poperror();
251         /* if we blocked, when we return, PRKM will smp_idle() */
252 }
253
254 /* Creates a kernel task, running fn(arg), named "name".  This is just a routine
255  * kernel message that happens to have a name, and is allowed to block.  It
256  * won't be associated with any process.  For lack of a better place, we'll just
257  * start it on the calling core.  Caller (and/or fn) need to deal with the
258  * storage for *name. */
259 void ktask(char *name, void (*fn)(void*), void *arg)
260 {
261         send_kernel_message(core_id(), __ktask_wrapper, (long)fn, (long)arg,
262                             (long)name, KMSG_ROUTINE);
263 }
264
265 void check_poison(char *msg)
266 {
267 #ifdef CONFIG_KTHREAD_POISON
268         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
269         if (pcpui->cur_kthread && pcpui->cur_kthread->stacktop &&
270             (*kstack_bottom_addr(pcpui->cur_kthread->stacktop) != 0xdeadbeef)) {
271                 printk("\nBad kthread canary, msg: %s\n", msg);
272                 panic("");
273         }
274 #endif /* CONFIG_KTHREAD_POISON */
275 }
276
277 /* Semaphores, using kthreads directly */
278 static void debug_downed_sem(struct semaphore *sem);
279 static void debug_upped_sem(struct semaphore *sem);
280 static void debug_lock_semlist(void);
281 static void debug_unlock_semlist(void);
282
283 static void sem_init_common(struct semaphore *sem, int signals)
284 {
285         TAILQ_INIT(&sem->waiters);
286         sem->nr_signals = signals;
287 #ifdef CONFIG_SEMAPHORE_DEBUG
288         sem->is_on_list = FALSE;
289 #endif
290 }
291
292 void sem_init(struct semaphore *sem, int signals)
293 {
294         sem_init_common(sem, signals);
295         spinlock_init(&sem->lock);
296         sem->irq_okay = FALSE;
297 }
298
299 void sem_init_irqsave(struct semaphore *sem, int signals)
300 {
301         sem_init_common(sem, signals);
302         spinlock_init_irqsave(&sem->lock);
303         sem->irq_okay = TRUE;
304 }
305
306 bool sem_trydown(struct semaphore *sem)
307 {
308         bool ret = FALSE;
309         /* lockless peek */
310         if (sem->nr_signals <= 0)
311                 return ret;
312         debug_lock_semlist();
313         spin_lock(&sem->lock);
314         if (sem->nr_signals > 0) {
315                 sem->nr_signals--;
316                 ret = TRUE;
317                 debug_downed_sem(sem);
318         }
319         spin_unlock(&sem->lock);
320         debug_unlock_semlist();
321         return ret;
322 }
323
324 /* Bottom-half of sem_down.  This is called after we jumped to the new stack. */
325 static void __attribute__((noreturn)) __unlock_and_idle(void *arg)
326 {
327         struct semaphore *sem = (struct semaphore*)arg;
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.  If so, we'll
415                  * need to reset the cr3 to something (boot_cr3 or owning_proc's cr3),
416                  * which might not be worth the potentially excessive TLB flush. */
417                 proc_incref(kthread->proc, 1);
418         } else {
419                 assert(kthread->proc == 0);
420         }
421         if (setjmp(&kthread->context))
422                 goto block_return_path;
423         debug_lock_semlist();
424         spin_lock(&sem->lock);
425         if (sem->nr_signals-- <= 0) {
426                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
427                 debug_downed_sem(sem);  /* need to debug after inserting */
428                 /* At this point, we know we'll sleep and change stacks.  Once we unlock
429                  * the sem, we could have the kthread restarted (possibly on another
430                  * core), so we need to leave the old stack before unlocking.  If we
431                  * don't and we stay on the stack, then if we take an IRQ or NMI (NMI
432                  * that doesn't change stacks, unlike x86_64), we'll be using the stack
433                  * at the same time as the kthread.  We could just disable IRQs, but
434                  * that wouldn't protect us from NMIs that don't change stacks. */
435                 __reset_stack_pointer(sem, new_stacktop, __unlock_and_idle);
436                 assert(0);
437         }
438         /* We get here if we should not sleep on sem (the signal beat the sleep).
439          * We debug_downed_sem since we actually downed it - just didn't sleep. */
440         debug_downed_sem(sem);
441         spin_unlock(&sem->lock);
442         debug_unlock_semlist();
443         printd("[kernel] Didn't sleep, unwinding...\n");
444         /* Restore the core's current and default stacktop */
445         if (kthread->flags & KTH_SAVE_ADDR_SPACE) {
446                 proc_decref(kthread->proc);
447                 kthread->proc = 0;
448         }
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         if (TAILQ_EMPTY(&sem->waiters) || sem->is_on_list)
549                 return;
550         TAILQ_INSERT_HEAD(&sems_with_waiters, sem, link);
551         sem->is_on_list = TRUE;
552 }
553
554 /* Called when a sem is upped.  It may or may not have waiters, and it may or
555  * may not be on the list. (we could up several times past 0). */
556 static void debug_upped_sem(struct semaphore *sem)
557 {
558         if (TAILQ_EMPTY(&sem->waiters) && sem->is_on_list) {
559                 TAILQ_REMOVE(&sems_with_waiters, sem, link);
560                 sem->is_on_list = FALSE;
561         }
562 }
563
564 #else
565
566 static void debug_lock_semlist(void)
567 {
568         /* no debugging */
569 }
570
571 static void debug_unlock_semlist(void)
572 {
573         /* no debugging */
574 }
575
576 static void debug_downed_sem(struct semaphore *sem)
577 {
578         /* no debugging */
579 }
580
581 static void debug_upped_sem(struct semaphore *sem)
582 {
583         /* no debugging */
584 }
585
586 #endif /* CONFIG_SEMAPHORE_DEBUG */
587
588 void print_sem_info(struct semaphore *sem)
589 {
590         struct kthread *kth_i;
591         /* Always safe to irqsave */
592         spin_lock_irqsave(&sem->lock);
593         printk("Semaphore %p has %d signals (neg = waiters)\n", sem,
594                sem->nr_signals);
595         TAILQ_FOREACH(kth_i, &sem->waiters, link)
596                 printk("\tKthread %p (%s), proc %d, sysc %p, pc/frame %p %p\n",
597                        kth_i, kth_i->name, kth_i->proc ? kth_i->proc->pid : 0,
598                        kth_i->sysc, jmpbuf_get_pc(&kth_i->context),
599                        jmpbuf_get_fp(&kth_i->context));
600         printk("\n");
601         spin_unlock_irqsave(&sem->lock);
602 }
603
604 void print_all_sem_info(void)
605 {
606 #ifdef CONFIG_SEMAPHORE_DEBUG
607         struct semaphore *sem_i;
608         printk("All sems with waiters:\n");
609         spin_lock_irqsave(&sems_with_waiters_lock);
610         TAILQ_FOREACH(sem_i, &sems_with_waiters, link)
611                 print_sem_info(sem_i);
612         spin_unlock_irqsave(&sems_with_waiters_lock);
613 #else
614         printk("Failed to print all sems: build with CONFIG_SEMAPHORE_DEBUG\n");
615 #endif
616 }
617
618 /* Condition variables, using semaphores and kthreads */
619 void cv_init(struct cond_var *cv)
620 {
621         sem_init(&cv->sem, 0);
622         cv->lock = &cv->internal_lock;
623         spinlock_init(cv->lock);
624         cv->nr_waiters = 0;
625         cv->irq_okay = FALSE;
626 }
627
628 void cv_init_irqsave(struct cond_var *cv)
629 {
630         sem_init_irqsave(&cv->sem, 0);
631         cv->lock = &cv->internal_lock;
632         spinlock_init_irqsave(cv->lock);
633         cv->nr_waiters = 0;
634         cv->irq_okay = TRUE;
635 }
636
637 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock)
638 {
639         sem_init(&cv->sem, 0);
640         cv->nr_waiters = 0;
641         cv->lock = lock;
642         cv->irq_okay = FALSE;
643 }
644
645 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock)
646 {
647         sem_init_irqsave(&cv->sem, 0);
648         cv->nr_waiters = 0;
649         cv->lock = lock;
650         cv->irq_okay = TRUE;
651 }
652
653 void cv_lock(struct cond_var *cv)
654 {
655         spin_lock(cv->lock);
656 }
657
658 void cv_unlock(struct cond_var *cv)
659 {
660         spin_unlock(cv->lock);
661 }
662
663 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state)
664 {
665         disable_irqsave(irq_state);
666         cv_lock(cv);
667 }
668
669 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state)
670 {
671         cv_unlock(cv);
672         enable_irqsave(irq_state);
673 }
674
675 /* Helper to clarify the wait/signalling code */
676 static int nr_sem_waiters(struct semaphore *sem)
677 {
678         int retval;
679         retval = 0 - sem->nr_signals;
680         assert(retval >= 0);
681         return retval;
682 }
683
684 /* Comes in locked.  Note we don't mess with enabling/disabling irqs.  The
685  * initial cv_lock would have disabled irqs (if applicable), and we don't mess
686  * with that setting at all. */
687 void cv_wait_and_unlock(struct cond_var *cv)
688 {
689         unsigned long nr_prev_waiters;
690         nr_prev_waiters = cv->nr_waiters++;
691         spin_unlock(cv->lock);
692         /* Wait til our turn.  This forces an ordering of all waiters such that the
693          * order in which they wait is the order in which they down the sem. */
694         while (nr_prev_waiters != nr_sem_waiters(&cv->sem))
695                 cpu_relax();
696         printd("core %d, sees nr_sem_waiters: %d, cv_nr_waiters %d\n",
697                core_id(), nr_sem_waiters(&cv->sem), cv->nr_waiters);
698         /* Atomically sleeps and 'unlocks' the next kthread from its busy loop (the
699          * one right above this), when it changes the sems nr_signals/waiters. */
700         sem_down(&cv->sem);
701 }
702
703 /* Comes in locked.  Note cv_lock does not disable irqs.   They should still be
704  * disabled from the initial cv_lock_irqsave(). */
705 void cv_wait(struct cond_var *cv)
706 {
707         cv_wait_and_unlock(cv);
708         if (cv->irq_okay)
709                 assert(!irq_is_enabled());
710         cv_lock(cv);
711 }
712
713 /* Helper, wakes exactly one, and there should have been at least one waiter. */
714 static void sem_wake_one(struct semaphore *sem)
715 {
716         struct kthread *kthread;
717
718         /* these locks will be irqsaved if the CV is irqsave (only need the one) */
719         debug_lock_semlist();
720         spin_lock(&sem->lock);
721         assert(sem->nr_signals < 0);
722         sem->nr_signals++;
723         kthread = TAILQ_FIRST(&sem->waiters);
724         TAILQ_REMOVE(&sem->waiters, kthread, link);
725         debug_upped_sem(sem);
726         spin_unlock(&sem->lock);
727         debug_unlock_semlist();
728         kthread_runnable(kthread);
729 }
730
731 void __cv_signal(struct cond_var *cv)
732 {
733         /* Can't short circuit this stuff.  We need to make sure any waiters that
734          * made it past upping the cv->nr_waiters has also downed the sem.
735          * Otherwise we muck with nr_waiters, which could break the ordering
736          * required by the waiters.  We also need to lock while making this check,
737          * o/w a new waiter can slip in after our while loop. */
738         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
739                 cpu_relax();
740         if (cv->nr_waiters) {
741                 cv->nr_waiters--;
742                 sem_wake_one(&cv->sem);
743         }
744 }
745
746 void __cv_broadcast(struct cond_var *cv)
747 {
748         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
749                 cpu_relax();
750         while (cv->nr_waiters) {
751                 cv->nr_waiters--;
752                 sem_wake_one(&cv->sem);
753         }
754 }
755
756 void cv_signal(struct cond_var *cv)
757 {
758         spin_lock(cv->lock);
759         __cv_signal(cv);
760         spin_unlock(cv->lock);
761 }
762
763 void cv_broadcast(struct cond_var *cv)
764 {
765         spin_lock(cv->lock);
766         __cv_broadcast(cv);
767         spin_unlock(cv->lock);
768 }
769
770 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state)
771 {
772         disable_irqsave(irq_state);
773         cv_signal(cv);
774         enable_irqsave(irq_state);
775 }
776
777 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state)
778 {
779         disable_irqsave(irq_state);
780         cv_broadcast(cv);
781         enable_irqsave(irq_state);
782 }
783
784 /* Helper, aborts and releases a CLE.  dereg_ spinwaits on abort_in_progress.
785  * This can throw a PF */
786 static void __abort_and_release_cle(struct cv_lookup_elm *cle)
787 {
788         int8_t irq_state = 0;
789         /* At this point, we have a handle on the syscall that we want to abort (via
790          * the cle), and we know none of the memory will disappear on us (deregers
791          * wait on the flag).  So we'll signal ABORT, which rendez will pick up next
792          * time it is awake.  Then we make sure it is awake with a broadcast. */
793         atomic_or(&cle->sysc->flags, SC_ABORT);
794         cmb();  /* flags write before signal; atomic op provided CPU mb */
795         cv_broadcast_irqsave(cle->cv, &irq_state);
796         cmb();  /* broadcast writes before abort flag; atomic op provided CPU mb */
797         atomic_dec(&cle->abort_in_progress);
798 }
799
800 /* Attempts to abort p's sysc.  It will only do so if the sysc lookup succeeds,
801  * so we can handle "guesses" for syscalls that might not be sleeping.  This
802  * style of "do it if you know you can" is the best way here - anything else
803  * runs into situations where you don't know if the memory is safe to touch or
804  * not (we're doing a lookup via pointer address, and only dereferencing if that
805  * succeeds).  Even something simple like letting userspace write SC_ABORT is
806  * very hard for them, since they don't know a sysc's state for sure (under the
807  * current system).
808  *
809  * Here are the rules:
810  * - if you're flagged SC_ABORT, you don't sleep
811  * - if you sleep, you're on the list
812  * - if you are on the list or abort_in_progress is set, CV is signallable, and
813  *   all the memory for CLE is safe */
814 bool abort_sysc(struct proc *p, struct syscall *sysc)
815 {
816         ERRSTACK(1);
817         struct cv_lookup_elm *cle;
818         int8_t irq_state = 0;
819
820         spin_lock_irqsave(&p->abort_list_lock);
821         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
822                 if (cle->sysc == sysc) {
823                         /* Note: we could have multiple aborters, so we need to use a
824                          * numeric refcnt instead of a flag. */
825                         atomic_inc(&cle->abort_in_progress);
826                         break;
827                 }
828         }
829         spin_unlock_irqsave(&p->abort_list_lock);
830         if (!cle)
831                 return FALSE;
832         if (!waserror())        /* discard error */
833                 __abort_and_release_cle(cle);
834         poperror();
835         return TRUE;
836 }
837
838 /* This will abort any abortables at the time the call was started for which
839  * should_abort(cle, arg) returns true.  New abortables could be registered
840  * concurrently.
841  *
842  * One caller for this is proc_destroy(), in which case DYING_ABORT will be set,
843  * and new abortables will quickly abort and dereg when they see their proc is
844  * DYING_ABORT. */
845 static int __abort_all_sysc(struct proc *p,
846                             bool (*should_abort)(struct cv_lookup_elm*, void*),
847                             void *arg)
848 {
849         ERRSTACK(1);
850         struct cv_lookup_elm *cle;
851         int8_t irq_state = 0;
852         struct cv_lookup_tailq abortall_list;
853         uintptr_t old_proc = switch_to(p);
854         int ret = 0;
855
856         /* Concerns: we need to not remove them from their original list, since
857          * concurrent wake ups will cause a dereg, which will remove from the list.
858          * We also can't touch freed memory, so we need a refcnt to keep cles
859          * around. */
860         TAILQ_INIT(&abortall_list);
861         spin_lock_irqsave(&p->abort_list_lock);
862         TAILQ_FOREACH(cle, &p->abortable_sleepers, link) {
863                 if (!should_abort(cle, arg))
864                         continue;
865                 atomic_inc(&cle->abort_in_progress);
866                 TAILQ_INSERT_HEAD(&abortall_list, cle, abortall_link);
867                 ret++;
868         }
869         spin_unlock_irqsave(&p->abort_list_lock);
870         if (!waserror()) { /* discard error */
871                 TAILQ_FOREACH(cle, &abortall_list, abortall_link)
872                         __abort_and_release_cle(cle);
873         }
874         poperror();
875         switch_back(p, old_proc);
876         return ret;
877 }
878
879 static bool always_abort(struct cv_lookup_elm *cle, void *arg)
880 {
881         return TRUE;
882 }
883
884 void abort_all_sysc(struct proc *p)
885 {
886         __abort_all_sysc(p, always_abort, 0);
887 }
888
889 /* cle->sysc could be a bad pointer.  we can either use copy_from_user (btw,
890  * we're already in their addr space) or we can use a waserror in
891  * __abort_all_sysc().  Both options are fine.  I went with it here for a couple
892  * reasons.  It is only this abort function pointer that accesses sysc, though
893  * that could change.  Our syscall aborting isn't plugged into a broader error()
894  * handler yet, which means we'd want to poperror instead of nexterror in
895  * __abort_all_sysc, and that would required int ret getting a volatile flag. */
896 static bool sysc_uses_fd(struct cv_lookup_elm *cle, void *fd)
897 {
898         struct syscall local_sysc;
899         int err;
900
901         err = copy_from_user(&local_sysc, cle->sysc, sizeof(struct syscall));
902         /* Trigger an abort on error */
903         if (err)
904                 return TRUE;
905         return syscall_uses_fd(&local_sysc, (int)(long)fd);
906 }
907
908 int abort_all_sysc_fd(struct proc *p, int fd)
909 {
910         return __abort_all_sysc(p, sysc_uses_fd, (void*)(long)fd);
911 }
912
913 /* Being on the abortable list means that the CLE, KTH, SYSC, and CV are valid
914  * memory.  The lock ordering is {CV lock, list_lock}.  Callers to this *will*
915  * have CV held.  This is done to avoid excessive locking in places like
916  * rendez_sleep, which want to check the condition before registering. */
917 void __reg_abortable_cv(struct cv_lookup_elm *cle, struct cond_var *cv)
918 {
919         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
920         cle->cv = cv;
921         cle->kthread = pcpui->cur_kthread;
922         /* Could be a ktask.  Can build in support for aborting these later */
923         if (is_ktask(cle->kthread)) {
924                 cle->sysc = 0;
925                 return;
926         }
927         cle->sysc = cle->kthread->sysc;
928         cle->proc = pcpui->cur_proc;
929         atomic_init(&cle->abort_in_progress, 0);
930         spin_lock_irqsave(&cle->proc->abort_list_lock);
931         TAILQ_INSERT_HEAD(&cle->proc->abortable_sleepers, cle, link);
932         spin_unlock_irqsave(&cle->proc->abort_list_lock);
933 }
934
935 /* We're racing with the aborter too, who will hold the flag in cle to protect
936  * its ref on our cle.  While the lock ordering is CV, list, callers to this
937  * must *not* have the cv lock held.  The reason is this waits on a successful
938  * abort_sysc, which is trying to cv_{signal,broadcast}, which could wait on the
939  * CV lock.  So if we hold the CV lock, we can deadlock (circular dependency).*/
940 void dereg_abortable_cv(struct cv_lookup_elm *cle)
941 {
942         if (is_ktask(cle->kthread))
943                 return;
944         assert(cle->proc);
945         spin_lock_irqsave(&cle->proc->abort_list_lock);
946         TAILQ_REMOVE(&cle->proc->abortable_sleepers, cle, link);
947         spin_unlock_irqsave(&cle->proc->abort_list_lock);
948         /* If we won the race and yanked it out of the list before abort claimed it,
949          * this will already be FALSE. */
950         while (atomic_read(&cle->abort_in_progress))
951                 cpu_relax();
952 }
953
954 /* Helper to sleepers to know if they should abort or not.  I'll probably extend
955  * this with things for ktasks in the future. */
956 bool should_abort(struct cv_lookup_elm *cle)
957 {
958         struct syscall local_sysc;
959         int err;
960
961         if (is_ktask(cle->kthread))
962                 return FALSE;
963         if (cle->proc && (cle->proc->state == PROC_DYING_ABORT))
964                 return TRUE;
965         if (cle->sysc) {
966                 assert(cle->proc && (cle->proc == current));
967                 err = copy_from_user(&local_sysc, cle->sysc,
968                                      offsetof(struct syscall, flags) +
969                                      sizeof(cle->sysc->flags));
970                 /* just go ahead and abort if there was an error */
971                 if (err || (atomic_read(&local_sysc.flags) & SC_ABORT))
972                         return TRUE;
973         }
974         return FALSE;
975 }
976
977 /* Sometimes the kernel needs to switch out of process context and into a
978  * 'process-less' kernel thread.  This is basically a ktask.  We use this mostly
979  * when performing file ops as the kernel.  It's nasty, and all uses of this
980  * probably should be removed.  (TODO: KFOP). */
981 uintptr_t switch_to_ktask(void)
982 {
983         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
984         struct kthread *kth = pcpui->cur_kthread;
985
986         if (is_ktask(kth))
987                 return 0;
988         /* We leave the SAVE_ADDR_SPACE flag on.  Now we're basically a ktask that
989          * cares about its addr space, since we need to return to it (not that we're
990          * leaving). */
991         kth->flags |= KTH_IS_KTASK;
992         return 1;
993 }
994
995 void switch_back_from_ktask(uintptr_t old_ret)
996 {
997         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
998         struct kthread *kth = pcpui->cur_kthread;
999
1000         if (old_ret)
1001                 kth->flags &= ~KTH_IS_KTASK;
1002 }