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