Kthreads launched from KMSGs are tracked as ktasks
[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 void check_poison(char *msg)
183 {
184 #ifdef CONFIG_KTHREAD_POISON
185         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
186         assert(pcpui->cur_kthread && pcpui->cur_kthread->stacktop);
187         if (*kstack_bottom_addr(pcpui->cur_kthread->stacktop) != 0xdeadbeef) {
188                 printk("\nBad kthread canary, msg: %s\n", msg);
189                 panic("");
190         }
191 #endif /* CONFIG_KTHREAD_POISON */
192 }
193
194 /* Semaphores, using kthreads directly */
195 void sem_init(struct semaphore *sem, int signals)
196 {
197         TAILQ_INIT(&sem->waiters);
198         sem->nr_signals = signals;
199         spinlock_init(&sem->lock);
200         sem->irq_okay = FALSE;
201 }
202
203 void sem_init_irqsave(struct semaphore *sem, int signals)
204 {
205         TAILQ_INIT(&sem->waiters);
206         sem->nr_signals = signals;
207         spinlock_init_irqsave(&sem->lock);
208         sem->irq_okay = TRUE;
209 }
210
211 /* This downs the semaphore and suspends the current kernel context on its
212  * waitqueue if there are no pending signals.  Note that the case where the
213  * signal is already there is not optimized. */
214 void sem_down(struct semaphore *sem)
215 {
216         volatile bool blocking = TRUE;  /* signal to short circuit when restarting*/
217         struct kthread *kthread, *new_kthread;
218         register uintptr_t new_stacktop;
219         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
220
221         assert(can_block(pcpui));
222         /* Make sure we aren't holding any locks (only works if SPINLOCK_DEBUG) */
223         assert(!pcpui->lock_depth);
224         assert(pcpui->cur_kthread);
225         /* Try to down the semaphore.  If there is a signal there, we can skip all
226          * of the sleep prep and just return. */
227         spin_lock(&sem->lock);  /* no need for irqsave, since we disabled ints */
228         if (sem->nr_signals > 0) {
229                 sem->nr_signals--;
230                 spin_unlock(&sem->lock);
231                 goto block_return_path;
232         }
233         spin_unlock(&sem->lock);
234         /* We're probably going to sleep, so get ready.  We'll check again later. */
235         kthread = pcpui->cur_kthread;
236         /* We need to have a spare slot for restart, so we also use it when
237          * sleeping.  Right now, we need a new kthread to take over if/when our
238          * current kthread sleeps.  Use the spare, and if not, get a new one.
239          *
240          * Note we do this with interrupts disabled (which protects us from
241          * concurrent modifications). */
242         if (pcpui->spare) {
243                 new_kthread = pcpui->spare;
244                 new_stacktop = new_kthread->stacktop;
245                 pcpui->spare = 0;
246                 /* Based on how we set is_ktask (in PRKM), we'll usually have a spare
247                  * with is_ktask set, even though the default setting is off.  The
248                  * reason is that the launching of blocked kthreads also uses PRKM, and
249                  * that KMSG (__launch_kthread) doesn't return.  Thus the soon-to-be
250                  * spare kthread, that is launching another, has is_ktask set. */
251                 new_kthread->is_ktask = FALSE;
252                 new_kthread->proc = 0;
253         } else {
254                 new_kthread = __kthread_zalloc();
255                 new_stacktop = get_kstack();
256                 new_kthread->stacktop = new_stacktop;
257 #ifdef CONFIG_KTHREAD_POISON
258                 *kstack_bottom_addr(new_stacktop) = 0;
259 #endif /* CONFIG_KTHREAD_POISON */
260         }
261         /* Set the core's new default stack and kthread */
262         set_stack_top(new_stacktop);
263         pcpui->cur_kthread = new_kthread;
264 #ifdef CONFIG_KTHREAD_POISON
265         /* Mark the new stack as in-use, and unmark the current kthread */
266         uintptr_t *new_stack_poison, *kth_stack_poison;
267         new_stack_poison = kstack_bottom_addr(new_stacktop);
268         assert(!*new_stack_poison);
269         *new_stack_poison = 0xdeadbeef;
270         kth_stack_poison = kstack_bottom_addr(kthread->stacktop);
271         assert(*kth_stack_poison == 0xdeadbeef);
272         *kth_stack_poison = 0;
273 #endif /* CONFIG_KTHREAD_POISON */
274         /* Kthreads that are ktasks are not related to any process, and do not need
275          * to work in a process's address space.  They can operate in any address
276          * space that has the kernel mapped (like boot_pgdir, or any pgdir).
277          *
278          * Other kthreads need to stay in the process context (if there is one), but
279          * we want the core (which could be a vcore) to stay in the context too.  In
280          * the future, we could check owning_proc. If it isn't set, we could leave
281          * the process context and transfer the refcnt to kthread->proc. */
282         if (!kthread->is_ktask) {
283                 kthread->proc = current;
284                 proc_incref(kthread->proc, 1);
285         } else {
286                 kthread->proc = 0;
287         } 
288         /* Save the context, toggle blocking for the reactivation */
289         save_kernel_ctx(&kthread->context);
290         if (!blocking)
291                 goto block_return_path;
292         blocking = FALSE;                                       /* for when it starts back up */
293         /* Down the semaphore.  We need this to be inline.  If we're sleeping, once
294          * we unlock the kthread could be started up again and can return and start
295          * trashing this function's stack, hence the weird control flow. */
296         spin_lock(&sem->lock);
297         if (sem->nr_signals-- <= 0) {
298                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
299                 /* At this point, we know we'll sleep and change stacks later.  Once we
300                  * unlock, we could have the kthread restarted (possibly on another
301                  * core), so we need to disable irqs until we are on our new stack.
302                  * Otherwise, if we take an IRQ, we'll be using our stack while another
303                  * core is using it (restarted kthread).  Basically, disabling irqs
304                  * allows us to atomically unlock and 'yield'. */
305                 disable_irq();
306         } else {                                                        /* we didn't sleep */
307                 goto unwind_sleep_prep;
308         }
309         spin_unlock(&sem->lock);
310         /* Switch to the core's default stack.  After this, don't use local
311          * variables.  TODO: we shouldn't be using new_stacktop either, can't always
312          * trust the register keyword (AFAIK). */
313         set_stack_pointer(new_stacktop);
314         smp_idle();                                                     /* reenables irqs eventually */
315         /* smp_idle never returns */
316         assert(0);
317 unwind_sleep_prep:
318         /* We get here if we should not sleep on sem (the signal beat the sleep).
319          * Note we are not optimizing for cases where the signal won. */
320         spin_unlock(&sem->lock);
321         printd("[kernel] Didn't sleep, unwinding...\n");
322         /* Restore the core's current and default stacktop */
323         current = kthread->proc;                        /* arguably unnecessary */
324         if (kthread->proc)
325                 proc_decref(kthread->proc);
326         set_stack_top(kthread->stacktop);
327         pcpui->cur_kthread = kthread;
328         /* Save the allocs as the spare */
329         assert(!pcpui->spare);
330         pcpui->spare = new_kthread;
331 #ifdef CONFIG_KTHREAD_POISON
332         /* switch back to old stack in use, new one not */
333         *new_stack_poison = 0;
334         *kth_stack_poison = 0xdeadbeef;
335 #endif /* CONFIG_KTHREAD_POISON */
336 block_return_path:
337         printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
338         return;
339 }
340
341 /* Ups the semaphore.  If it was < 0, we need to wake up someone, which we do.
342  * Returns TRUE if we woke someone, FALSE o/w (used for debugging in some
343  * places).  If we need more control, we can implement a version of the old
344  * __up_sem() again.  */
345 bool sem_up(struct semaphore *sem)
346 {
347         struct kthread *kthread = 0;
348         spin_lock(&sem->lock);
349         if (sem->nr_signals++ < 0) {
350                 assert(!TAILQ_EMPTY(&sem->waiters));
351                 /* could do something with 'priority' here */
352                 kthread = TAILQ_FIRST(&sem->waiters);
353                 TAILQ_REMOVE(&sem->waiters, kthread, link);
354         } else {
355                 assert(TAILQ_EMPTY(&sem->waiters));
356         }
357         spin_unlock(&sem->lock);
358         /* Note that once we call kthread_runnable(), we cannot touch the sem again.
359          * Some sems are on stacks.  The caller can touch sem, if it knows about the
360          * memory/usage of the sem.  Likewise, we can't touch the kthread either. */
361         if (kthread) {
362                 kthread_runnable(kthread);
363                 return TRUE;
364         }
365         return FALSE;
366 }
367
368 void sem_down_irqsave(struct semaphore *sem, int8_t *irq_state)
369 {
370         disable_irqsave(irq_state);
371         sem_down(sem);
372         enable_irqsave(irq_state);
373 }
374
375 bool sem_up_irqsave(struct semaphore *sem, int8_t *irq_state)
376 {
377         bool retval;
378         disable_irqsave(irq_state);
379         retval = sem_up(sem);
380         enable_irqsave(irq_state);
381         return retval;
382 }
383
384 /* Condition variables, using semaphores and kthreads */
385 void cv_init(struct cond_var *cv)
386 {
387         sem_init(&cv->sem, 0);
388         cv->lock = &cv->internal_lock;
389         spinlock_init(cv->lock);
390         cv->nr_waiters = 0;
391         cv->irq_okay = FALSE;
392 }
393
394 void cv_init_irqsave(struct cond_var *cv)
395 {
396         sem_init_irqsave(&cv->sem, 0);
397         cv->lock = &cv->internal_lock;
398         spinlock_init_irqsave(cv->lock);
399         cv->nr_waiters = 0;
400         cv->irq_okay = TRUE;
401 }
402
403 void cv_init_with_lock(struct cond_var *cv, spinlock_t *lock)
404 {
405         sem_init(&cv->sem, 0);
406         cv->nr_waiters = 0;
407         cv->lock = lock;
408         cv->irq_okay = FALSE;
409 }
410
411 void cv_init_irqsave_with_lock(struct cond_var *cv, spinlock_t *lock)
412 {
413         sem_init_irqsave(&cv->sem, 0);
414         cv->nr_waiters = 0;
415         cv->lock = lock;
416         cv->irq_okay = TRUE;
417 }
418
419 void cv_lock(struct cond_var *cv)
420 {
421         spin_lock(cv->lock);
422 }
423
424 void cv_unlock(struct cond_var *cv)
425 {
426         spin_unlock(cv->lock);
427 }
428
429 void cv_lock_irqsave(struct cond_var *cv, int8_t *irq_state)
430 {
431         disable_irqsave(irq_state);
432         cv_lock(cv);
433 }
434
435 void cv_unlock_irqsave(struct cond_var *cv, int8_t *irq_state)
436 {
437         cv_unlock(cv);
438         enable_irqsave(irq_state);
439 }
440
441 /* Helper to clarify the wait/signalling code */
442 static int nr_sem_waiters(struct semaphore *sem)
443 {
444         int retval;
445         retval = 0 - sem->nr_signals;
446         assert(retval >= 0);
447         return retval;
448 }
449
450 /* Comes in locked.  Note we don't mess with enabling/disabling irqs.  The
451  * initial cv_lock would have disabled irqs (if applicable), and we don't mess
452  * with that setting at all. */
453 void cv_wait_and_unlock(struct cond_var *cv)
454 {
455         unsigned long nr_prev_waiters;
456         nr_prev_waiters = cv->nr_waiters++;
457         spin_unlock(cv->lock);
458         /* Wait til our turn.  This forces an ordering of all waiters such that the
459          * order in which they wait is the order in which they down the sem. */
460         while (nr_prev_waiters != nr_sem_waiters(&cv->sem))
461                 cpu_relax();
462         printd("core %d, sees nr_sem_waiters: %d, cv_nr_waiters %d\n",
463                core_id(), nr_sem_waiters(&cv->sem), cv->nr_waiters);
464         /* Atomically sleeps and 'unlocks' the next kthread from its busy loop (the
465          * one right above this), when it changes the sems nr_signals/waiters. */
466         sem_down(&cv->sem);
467 }
468
469 /* Comes in locked.  Note cv_lock does not disable irqs.   They should still be
470  * disabled from the initial cv_lock_irqsave(). */
471 void cv_wait(struct cond_var *cv)
472 {
473         cv_wait_and_unlock(cv);
474         if (cv->irq_okay)
475                 assert(!irq_is_enabled());
476         cv_lock(cv);
477 }
478
479 /* Helper, wakes exactly one, and there should have been at least one waiter. */
480 static void sem_wake_one(struct semaphore *sem)
481 {
482         struct kthread *kthread;
483         /* these locks will be irqsaved if the CV is irqsave (only need the one) */
484         spin_lock(&sem->lock);
485         assert(sem->nr_signals < 0);
486         sem->nr_signals++;
487         kthread = TAILQ_FIRST(&sem->waiters);
488         TAILQ_REMOVE(&sem->waiters, kthread, link);
489         spin_unlock(&sem->lock);
490         kthread_runnable(kthread);
491 }
492
493 void __cv_signal(struct cond_var *cv)
494 {
495         /* Can't short circuit this stuff.  We need to make sure any waiters that
496          * made it past upping the cv->nr_waiters has also downed the sem.
497          * Otherwise we muck with nr_waiters, which could break the ordering
498          * required by the waiters.  We also need to lock while making this check,
499          * o/w a new waiter can slip in after our while loop. */
500         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
501                 cpu_relax();
502         if (cv->nr_waiters) {
503                 cv->nr_waiters--;
504                 sem_wake_one(&cv->sem);
505         }
506 }
507
508 void __cv_broadcast(struct cond_var *cv)
509 {
510         while (cv->nr_waiters != nr_sem_waiters(&cv->sem))
511                 cpu_relax();
512         while (cv->nr_waiters) {
513                 cv->nr_waiters--;
514                 sem_wake_one(&cv->sem);
515         }
516 }
517
518 void cv_signal(struct cond_var *cv)
519 {
520         spin_lock(cv->lock);
521         __cv_signal(cv);
522         spin_unlock(cv->lock);
523 }
524
525 void cv_broadcast(struct cond_var *cv)
526 {
527         spin_lock(cv->lock);
528         __cv_broadcast(cv);
529         spin_unlock(cv->lock);
530 }
531
532 void cv_signal_irqsave(struct cond_var *cv, int8_t *irq_state)
533 {
534         disable_irqsave(irq_state);
535         cv_signal(cv);
536         enable_irqsave(irq_state);
537 }
538
539 void cv_broadcast_irqsave(struct cond_var *cv, int8_t *irq_state)
540 {
541         disable_irqsave(irq_state);
542         cv_broadcast(cv);
543         enable_irqsave(irq_state);
544 }