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