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