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