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