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