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