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