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