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