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