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