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