Can associate multiple CVs with spinlocks
[akaros.git] / kern / src / kthread.c
1 /* Copyright (c) 2010 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
15 struct kmem_cache *kthread_kcache;
16
17 void kthread_init(void)
18 {
19         kthread_kcache = kmem_cache_create("kthread", sizeof(struct kthread),
20                                            __alignof__(struct kthread), 0, 0, 0);
21 }
22
23 /* Starts kthread on the calling core.  This does not return, and will handle
24  * the details of cleaning up whatever is currently running (freeing its stack,
25  * etc).  Pairs with sem_down(). */
26 void restart_kthread(struct kthread *kthread)
27 {
28         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
29         uintptr_t current_stacktop;
30         /* Avoid messy complications.  The kthread will enable_irqsave() when it
31          * comes back up. */
32         disable_irq();
33         /* Free any spare, since we need ours to become the spare (since we can't
34          * free our current kthread *before* popping it, nor can we free the current
35          * stack until we pop to the kthread's stack). */
36         if (pcpui->spare) {
37                 /* assumes the stack is a page, and that stacktop is somewhere in
38                  * (pg_bottom, pg_bottom + PGSIZE].  Normally, it ought to be pg_bottom
39                  * + PGSIZE (on x86).  kva2page can take any kva, not just a page
40                  * aligned addr. */
41                 page_decref(kva2page((void*)pcpui->spare->stacktop - 1));
42                 kmem_cache_free(kthread_kcache, pcpui->spare);
43         }
44         current_stacktop = get_stack_top();
45         /* When a kthread runs, its stack is the default kernel stack */
46         set_stack_top(kthread->stacktop);
47 #ifdef CONFIG_KTHREAD_POISON
48         /* TODO: KTHR-STACK */
49         /* Assert and switch to cur stack not in use, kthr stack in use */
50         uintptr_t *cur_stack_poison, *kth_stack_poison;
51         cur_stack_poison = (uintptr_t*)ROUNDDOWN(current_stacktop - 1, PGSIZE);
52         assert(*cur_stack_poison == 0xdeadbeef);
53         *cur_stack_poison = 0;
54         kth_stack_poison = (uintptr_t*)ROUNDDOWN(kthread->stacktop - 1, PGSIZE);
55         assert(!*kth_stack_poison);
56         *kth_stack_poison = 0xdeadbeef;
57 #endif /* CONFIG_KTHREAD_POISON */
58         /* Set the spare stuff (current kthread, current (not kthread) stacktop) */
59         pcpui->spare = kthread;
60         kthread->stacktop = current_stacktop;
61         /* Only change current if we need to (the kthread was in process context) */
62         if (kthread->proc) {
63                 /* Load our page tables before potentially decreffing cur_proc */
64                 lcr3(kthread->proc->env_cr3);
65                 /* Might have to clear out an existing current.  If they need to be set
66                  * later (like in restartcore), it'll be done on demand. */
67                 if (pcpui->cur_proc)
68                         proc_decref(pcpui->cur_proc);
69                 /* We also transfer our counted ref from kthread->proc to cur_proc */
70                 pcpui->cur_proc = kthread->proc;
71         }
72         /* Tell the core which syscall we are running (if any) */
73         assert(!pcpui->cur_sysc);       /* catch bugs, prev user should clear */
74         pcpui->cur_sysc = kthread->sysc;
75         pcpui->cur_errbuf = kthread->errbuf;
76         /* Finally, restart our thread */
77         pop_kernel_ctx(&kthread->context);
78 }
79
80 /* Kmsg handler to launch/run a kthread.  This must be a routine message, since
81  * it does not return.  */
82 static void __launch_kthread(uint32_t srcid, long a0, long a1, long a2)
83 {
84         struct kthread *kthread = (struct kthread*)a0;
85         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
86         struct proc *cur_proc = pcpui->cur_proc;
87         
88         /* Make sure we are a routine kmsg */
89         assert(in_early_rkmsg_ctx(pcpui));
90         if (pcpui->owning_proc && pcpui->owning_proc != kthread->proc) {
91                 /* Some process should be running here that is not the same as the
92                  * kthread.  This means the _M is getting interrupted or otherwise
93                  * delayed.  If we want to do something other than run it (like send the
94                  * kmsg to another pcore, or ship the context from here to somewhere
95                  * else/deschedule it (like for an _S)), do it here.
96                  *
97                  * If you want to do something here, call out to the ksched, then
98                  * abandon_core(). */
99                 cmb();  /* do nothing/placeholder */
100         }
101         /* o/w, just run the kthread.  any trapframes that are supposed to run or
102          * were interrupted will run whenever the kthread smp_idles() or otherwise
103          * finishes.  We also need to clear the RKMSG context since we will not
104          * return from restart_kth. */
105         clear_rkmsg(pcpui);
106         restart_kthread(kthread);
107         assert(0);
108 }
109
110 /* Call this when a kthread becomes runnable/unblocked.  We don't do anything
111  * particularly smart yet, but when we do, we can put it here. */
112 void kthread_runnable(struct kthread *kthread)
113 {
114         uint32_t dst = core_id();
115         #if 0
116         /* turn this block on if you want to test migrating non-core0 kthreads */
117         switch (dst) {
118                 case 0:
119                         break;
120                 case 7:
121                         dst = 2;
122                         break;
123                 default:
124                         dst++;
125         }
126         #endif
127         /* For lack of anything better, send it to ourselves. (TODO: KSCHED) */
128         send_kernel_message(dst, __launch_kthread, (long)kthread, 0, 0,
129                             KMSG_ROUTINE);
130 }
131
132 /* Kmsg helper for kthread_yield */
133 static void __wake_me_up(uint32_t srcid, long a0, long a1, long a2)
134 {
135         struct semaphore *sem = (struct semaphore*)a0;
136         assert(sem_up(sem));
137 }
138
139 /* Stop the current kthread.  It'll get woken up next time we run routine kmsgs,
140  * after all existing kmsgs are processed. */
141 void kthread_yield(void)
142 {
143         struct semaphore local_sem, *sem = &local_sem;
144         sem_init(sem, 0);
145         send_kernel_message(core_id(), __wake_me_up, (long)sem, 0, 0,
146                             KMSG_ROUTINE);
147         sem_down(sem);
148 }
149
150 void check_poison(char *msg)
151 {
152 #ifdef CONFIG_KTHREAD_POISON
153         if (*(uintptr_t*)ROUNDDOWN(get_stack_top() - 1, PGSIZE) != 0xdeadbeef) {
154                 printk("\nBad kthread canary, msg: %s\n", msg);
155                 panic("");
156         }
157 #endif /* CONFIG_KTHREAD_POISON */
158 }
159
160 /* Semaphores, using kthreads directly */
161 void sem_init(struct semaphore *sem, int signals)
162 {
163         TAILQ_INIT(&sem->waiters);
164         sem->nr_signals = signals;
165         spinlock_init(&sem->lock);
166         sem->irq_okay = FALSE;
167 }
168
169 void sem_init_irqsave(struct semaphore *sem, int signals)
170 {
171         TAILQ_INIT(&sem->waiters);
172         sem->nr_signals = signals;
173         spinlock_init_irqsave(&sem->lock);
174         sem->irq_okay = TRUE;
175 }
176
177 /* This downs the semaphore and suspends the current kernel context on its
178  * waitqueue if there are no pending signals.  Note that the case where the
179  * signal is already there is not optimized. */
180 void sem_down(struct semaphore *sem)
181 {
182         volatile bool blocking = TRUE;  /* signal to short circuit when restarting*/
183         struct kthread *kthread;
184         struct page *page;                              /* assumption here that stacks are PGSIZE */
185         register uintptr_t new_stacktop;
186         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
187
188         assert(can_block(pcpui));
189         /* Make sure we aren't holding any locks (only works if SPINLOCK_DEBUG) */
190         assert(!pcpui->lock_depth);
191         /* Try to down the semaphore.  If there is a signal there, we can skip all
192          * of the sleep prep and just return. */
193         spin_lock(&sem->lock);  /* no need for irqsave, since we disabled ints */
194         if (sem->nr_signals > 0) {
195                 sem->nr_signals--;
196                 spin_unlock(&sem->lock);
197                 goto block_return_path;
198         }
199         spin_unlock(&sem->lock);
200         /* We're probably going to sleep, so get ready.  We'll check again later. */
201         /* Try to get the spare first.  If there is one, we'll use it (o/w, we'll
202          * get a fresh kthread.  Why we need this is more clear when we try to
203          * restart kthreads.  Having them also ought to cut down on contention.
204          * Note we do this with interrupts disabled (which protects us from
205          * concurrent modifications). */
206         if (pcpui->spare) {
207                 kthread = pcpui->spare;
208                 /* we're using the spare, so we use the page the spare held */
209                 new_stacktop = kthread->stacktop;
210                 pcpui->spare = 0;
211         } else {
212                 kthread = kmem_cache_alloc(kthread_kcache, 0);
213                 assert(kthread);
214                 assert(!kpage_alloc(&page));    /* decref'd when the kthread is freed */
215 #ifdef CONFIG_KTHREAD_POISON
216                 /* TODO: KTHR-STACK don't poison like this */
217                 *(uintptr_t*)page2kva(page) = 0;
218 #endif /* CONFIG_KTHREAD_POISON */
219                 new_stacktop = (uintptr_t)page2kva(page) + PGSIZE;
220         }
221         /* This is the stacktop we are currently on and wish to save */
222         kthread->stacktop = get_stack_top();
223         /* Set the core's new default stack */
224         set_stack_top(new_stacktop);
225 #ifdef CONFIG_KTHREAD_POISON
226         /* Mark the new stack as in-use, and unmark the current kthread */
227         /* TODO: KTHR-STACK don't poison like this */
228         uintptr_t *new_stack_poison, *kth_stack_poison;
229         new_stack_poison = (uintptr_t*)ROUNDDOWN(new_stacktop - 1, PGSIZE);
230         assert(!*new_stack_poison);
231         *new_stack_poison = 0xdeadbeef;
232         kth_stack_poison = (uintptr_t*)ROUNDDOWN(kthread->stacktop - 1, PGSIZE);
233         assert(*kth_stack_poison == 0xdeadbeef);
234         *kth_stack_poison = 0;
235 #endif /* CONFIG_KTHREAD_POISON */
236         /* The kthread needs to stay in the process context (if there is one), but
237          * we want the core (which could be a vcore) to stay in the context too.  In
238          * the future, we could check owning_proc. If it isn't set, we could leave
239          * the process context and transfer the refcnt to kthread->proc. */
240         kthread->proc = current;
241         /* kthread tracks the syscall it is working on, which implies errno */
242         kthread->sysc = pcpui->cur_sysc;
243         kthread->errbuf = pcpui->cur_errbuf;
244         pcpui->cur_sysc = 0;                            /* this core no longer works on sysc */
245         pcpui->cur_errbuf = 0;                          /* this core no longer has an errbuf */
246         if (kthread->proc)
247                 proc_incref(kthread->proc, 1);
248         /* Save the context, toggle blocking for the reactivation */
249         save_kernel_ctx(&kthread->context);
250         if (!blocking)
251                 goto block_return_path;
252         blocking = FALSE;                                       /* for when it starts back up */
253         /* Down the semaphore.  We need this to be inline.  If we're sleeping, once
254          * we unlock the kthread could be started up again and can return and start
255          * trashing this function's stack, hence the weird control flow. */
256         spin_lock(&sem->lock);
257         if (sem->nr_signals-- <= 0) {
258                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
259                 /* At this point, we know we'll sleep and change stacks later.  Once we
260                  * unlock, we could have the kthread restarted (possibly on another
261                  * core), so we need to disable irqs until we are on our new stack.
262                  * Otherwise, if we take an IRQ, we'll be using our stack while another
263                  * core is using it (restarted kthread).  Basically, disabling irqs
264                  * allows us to atomically unlock and 'yield'. */
265                 disable_irq();
266         } else {                                                        /* we didn't sleep */
267                 goto unwind_sleep_prep;
268         }
269         spin_unlock(&sem->lock);
270         /* Switch to the core's default stack.  After this, don't use local
271          * variables.  TODO: we shouldn't be using new_stacktop either, can't always
272          * trust the register keyword (AFAIK). */
273         set_stack_pointer(new_stacktop);
274         smp_idle();                                                     /* reenables irqs eventually */
275         /* smp_idle never returns */
276         assert(0);
277 unwind_sleep_prep:
278         /* We get here if we should not sleep on sem (the signal beat the sleep).
279          * Note we are not optimizing for cases where the signal won. */
280         spin_unlock(&sem->lock);
281         printd("[kernel] Didn't sleep, unwinding...\n");
282         /* Restore the core's current and default stacktop */
283         current = kthread->proc;                        /* arguably unnecessary */
284         if (kthread->proc)
285                 proc_decref(kthread->proc);
286         set_stack_top(kthread->stacktop);
287         /* Save the allocs as the spare */
288         assert(!pcpui->spare);
289         pcpui->spare = kthread;
290         /* save the "freshly alloc'd" stack/page, not the one we came in on */
291         kthread->stacktop = new_stacktop;
292 #ifdef CONFIG_KTHREAD_POISON
293         /* TODO: KTHR-STACK don't unpoison like this */
294         /* switch back to old stack in use, new one not */
295         *new_stack_poison = 0;
296         *kth_stack_poison = 0xdeadbeef;
297 #endif /* CONFIG_KTHREAD_POISON */
298 block_return_path:
299         printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
300         return;
301 }
302
303 /* Ups the semaphore.  If it was < 0, we need to wake up someone, which we do.
304  * Returns TRUE if we woke someone, FALSE o/w (used for debugging in some
305  * places).  If we need more control, we can implement a version of the old
306  * __up_sem() again.  */
307 bool sem_up(struct semaphore *sem)
308 {
309         struct kthread *kthread = 0;
310         spin_lock(&sem->lock);
311         if (sem->nr_signals++ < 0) {
312                 assert(!TAILQ_EMPTY(&sem->waiters));
313                 /* could do something with 'priority' here */
314                 kthread = TAILQ_FIRST(&sem->waiters);
315                 TAILQ_REMOVE(&sem->waiters, kthread, link);
316         } else {
317                 assert(TAILQ_EMPTY(&sem->waiters));
318         }
319         spin_unlock(&sem->lock);
320         /* Note that once we call kthread_runnable(), we cannot touch the sem again.
321          * Some sems are on stacks.  The caller can touch sem, if it knows about the
322          * memory/usage of the sem.  Likewise, we can't touch the kthread either. */
323         if (kthread) {
324                 kthread_runnable(kthread);
325                 return TRUE;
326         }
327         return FALSE;
328 }
329
330 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
331 {
332         disable_irqsave(irq_state);
333         sem_down(sem);
334         enable_irqsave(irq_state);
335 }
336
337 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state)
338 {
339         bool retval;
340         disable_irqsave(irq_state);
341         retval = sem_up(sem);
342         enable_irqsave(irq_state);
343         return retval;
344 }
345
346 /* Condition variables, using semaphores and kthreads */
347 void cv_init(struct cond_var *cv)
348 {
349         sem_init(&cv->sem, 0);
350         cv->lock = &cv->internal_lock;
351         spinlock_init(cv->lock);
352         cv->nr_waiters = 0;
353         cv->irq_okay = FALSE;
354 }
355
356 void cv_init_irqsave(struct cond_var *cv)
357 {
358         sem_init_irqsave(&cv->sem, 0);
359         cv->lock = &cv->internal_lock;
360         spinlock_init_irqsave(cv->lock);
361         cv->nr_waiters = 0;
362         cv->irq_okay = TRUE;
363 }
364
365 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock)
366 {
367         sem_init(&cv->sem, 0);
368         cv->nr_waiters = 0;
369         cv->lock = lock;
370         cv->irq_okay = FALSE;
371 }
372
373 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock)
374 {
375         sem_init_irqsave(&cv->sem, 0);
376         cv->nr_waiters = 0;
377         cv->lock = lock;
378         cv->irq_okay = TRUE;
379 }
380
381 void cv_lock(struct cond_var *cv)
382 {
383         spin_lock(cv->lock);
384 }
385
386 void cv_unlock(struct cond_var *cv)
387 {
388         spin_unlock(cv->lock);
389 }
390
391 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state)
392 {
393         disable_irqsave(irq_state);
394         cv_lock(cv);
395 }
396
397 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state)
398 {
399         cv_unlock(cv);
400         enable_irqsave(irq_state);
401 }
402
403 /* Helper to clarify the wait/signalling code */
404 static int nr_sem_waiters(struct semaphore *sem)
405 {
406         int retval;
407         retval = 0 - sem->nr_signals;
408         assert(retval >= 0);
409         return retval;
410 }
411
412 /* Comes in locked.  Note we don't mess with enabling/disabling irqs.  The
413  * initial cv_lock would have disabled irqs (if applicable), and we don't mess
414  * with that setting at all. */
415 void cv_wait_and_unlock(struct cond_var *cv)
416 {
417         unsigned long nr_prev_waiters;
418         nr_prev_waiters = cv->nr_waiters++;
419         spin_unlock(cv->lock);
420         /* Wait til our turn.  This forces an ordering of all waiters such that the
421          * order in which they wait is the order in which they down the sem. */
422         while (nr_prev_waiters != nr_sem_waiters(&cv->sem))
423                 cpu_relax();
424         printd("core %d, sees nr_sem_waiters: %d, cv_nr_waiters %d\n",
425                core_id(), nr_sem_waiters(&cv->sem), cv->nr_waiters);
426         /* Atomically sleeps and 'unlocks' the next kthread from its busy loop (the
427          * one right above this), when it changes the sems nr_signals/waiters. */
428         sem_down(&cv->sem);
429 }
430
431 /* Comes in locked.  Note cv_lock does not disable irqs.   They should still be
432  * disabled from the initial cv_lock_irqsave(). */
433 void cv_wait(struct cond_var *cv)
434 {
435         cv_wait_and_unlock(cv);
436         if (cv->irq_okay)
437                 assert(!irq_is_enabled());
438         cv_lock(cv);
439 }
440
441 /* Helper, wakes exactly one, and there should have been at least one waiter. */
442 static void sem_wake_one(struct semaphore *sem)
443 {
444         struct kthread *kthread;
445         /* these locks will be irqsaved if the CV is irqsave (only need the one) */
446         spin_lock(&sem->lock);
447         assert(sem->nr_signals < 0);
448         sem->nr_signals++;
449         kthread = TAILQ_FIRST(&sem->waiters);
450         TAILQ_REMOVE(&sem->waiters, kthread, link);
451         spin_unlock(&sem->lock);
452         kthread_runnable(kthread);
453 }
454
455 void __cv_signal(struct cond_var *cv)
456 {
457         /* Can't short circuit this stuff.  We need to make sure any waiters that
458          * made it past upping the cv->nr_waiters has also downed the sem.
459          * Otherwise we muck with nr_waiters, which could break the ordering
460          * required by the waiters.  We also need to lock while making this check,
461          * o/w a new waiter can slip in after our while loop. */
462         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
463                 cpu_relax();
464         if (cv->nr_waiters) {
465                 cv->nr_waiters--;
466                 sem_wake_one(&cv->sem);
467         }
468 }
469
470 void __cv_broadcast(struct cond_var *cv)
471 {
472         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
473                 cpu_relax();
474         while (cv->nr_waiters) {
475                 cv->nr_waiters--;
476                 sem_wake_one(&cv->sem);
477         }
478 }
479
480 void cv_signal(struct cond_var *cv)
481 {
482         spin_lock(cv->lock);
483         __cv_signal(cv);
484         spin_unlock(cv->lock);
485 }
486
487 void cv_broadcast(struct cond_var *cv)
488 {
489         spin_lock(cv->lock);
490         __cv_broadcast(cv);
491         spin_unlock(cv->lock);
492 }
493
494 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state)
495 {
496         disable_irqsave(irq_state);
497         cv_signal(cv);
498         enable_irqsave(irq_state);
499 }
500
501 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state)
502 {
503         disable_irqsave(irq_state);
504         cv_broadcast(cv);
505         enable_irqsave(irq_state);
506 }