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