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