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