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