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