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