Helpful debugging additions
[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 /* This downs the semaphore and suspends the current kernel context on its
24  * waitqueue if there are no pending signals.  Note that the case where the
25  * signal is already there is not optimized. */
26 void sleep_on(struct semaphore *sem)
27 {
28         volatile bool blocking = TRUE;  /* signal to short circuit when restarting*/
29         struct kthread *kthread;
30         struct page *page;                              /* assumption here that stacks are PGSIZE */
31         register uintptr_t new_stacktop;
32         int8_t irq_state = 0;
33         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
34
35         /* interrups would be messy here */
36         disable_irqsave(&irq_state);
37         /* Try to down the semaphore.  If there is a signal there, we can skip all
38          * of the sleep prep and just return. */
39         spin_lock(&sem->lock);  /* no need for irqsave, since we disabled ints */
40         if (sem->nr_signals > 0) {
41                 sem->nr_signals--;
42                 spin_unlock(&sem->lock);
43                 goto block_return_path_np;
44         }
45         /* we're probably going to sleep, so get ready.  We'll check again later. */
46         spin_unlock(&sem->lock);
47         /* Try to get the spare first.  If there is one, we'll use it (o/w, we'll
48          * get a fresh kthread.  Why we need this is more clear when we try to
49          * restart kthreads.  Having them also ought to cut down on contention.
50          * Note we do this with interrupts disabled (which protects us from
51          * concurrent modifications). */
52         if (pcpui->spare) {
53                 kthread = pcpui->spare;
54                 /* we're using the spare, so we use the page the spare held */
55                 new_stacktop = kthread->stacktop;
56                 pcpui->spare = 0;
57         } else {
58                 kthread = kmem_cache_alloc(kthread_kcache, 0);
59                 assert(kthread);
60                 assert(!kpage_alloc(&page));    /* decref'd when the kthread is freed */
61                 new_stacktop = (uintptr_t)page2kva(page) + PGSIZE;
62         }
63         /* This is the stacktop we are currently on and wish to save */
64         kthread->stacktop = get_stack_top();
65         /* Set the core's new default stack */
66         set_stack_top(new_stacktop);
67         /* The kthread needs to stay in the process context (if there is one), but
68          * we want the core (which could be a vcore) to stay in the context too.  If
69          * we want to leave, we'll need to do that in smp_idle() or elsewhere in the
70          * code. */
71         kthread->proc = current;
72         /* kthread tracks the syscall it is working on, which implies errno */
73         kthread->sysc = pcpui->cur_sysc;
74         pcpui->cur_sysc = 0;                            /* this core no longer works on sysc */
75         if (kthread->proc)
76                 proc_incref(kthread->proc, 1);
77         /* Save the context, toggle blocking for the reactivation */
78         save_kernel_tf(&kthread->context);
79         if (!blocking)
80                 goto block_return_path;
81         blocking = FALSE;                                       /* for when it starts back up */
82         /* Down the semaphore.  We need this to be inline.  If we're sleeping, once
83          * we unlock the kthread could be started up again and can return and start
84          * trashing this function's stack, hence the weird control flow. */
85         spin_lock(&sem->lock);  /* no need for irqsave, since we disabled ints */
86         if (sem->nr_signals-- <= 0)
87                 TAILQ_INSERT_TAIL(&sem->waiters, kthread, link);
88         else                                                            /* we didn't sleep */
89                 goto unwind_sleep_prep;
90         spin_unlock(&sem->lock);
91         /* Switch to the core's default stack.  After this, don't use local
92          * variables.  TODO: we shouldn't be using new_stacktop either, can't always
93          * trust the register keyword (AFAIK). */
94         set_stack_pointer(new_stacktop);
95         smp_idle();
96         /* smp_idle never returns */
97         assert(0);
98 unwind_sleep_prep:
99         /* We get here if we should not sleep on sem (the signal beat the sleep).
100          * Note we are not optimizing for cases where the signal won. */
101         spin_unlock(&sem->lock);
102         printd("[kernel] Didn't sleep, unwinding...\n");
103         /* Restore the core's current and default stacktop */
104         current = kthread->proc;                        /* arguably unnecessary */
105         if (kthread->proc)
106                 proc_decref(kthread->proc);
107         set_stack_top(kthread->stacktop);
108         /* Save the allocs as the spare */
109         assert(!pcpui->spare);
110         pcpui->spare = kthread;
111         /* save the "freshly alloc'd" stack/page, not the one we came in on */
112         kthread->stacktop = new_stacktop;
113 block_return_path:
114         printd("[kernel] Returning from being 'blocked'! at %llu\n", read_tsc());
115 block_return_path_np:
116         enable_irqsave(&irq_state);
117         return;
118 }
119
120 /* Starts kthread on the calling core.  This does not return, and will handle
121  * the details of cleaning up whatever is currently running (freeing its stack,
122  * etc). */
123 void restart_kthread(struct kthread *kthread)
124 {
125         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
126         uintptr_t current_stacktop;
127         /* Avoid messy complications.  The kthread will enable_irqsave() when it
128          * comes back up. */
129         disable_irq();
130         /* Free any spare, since we need ours to become the spare (since we can't
131          * free our current kthread *before* popping it, nor can we free the current
132          * stack until we pop to the kthread's stack). */
133         if (pcpui->spare) {
134                 /* this should probably have a rounddown, since it's not always the top,
135                  * or even always PGSIZE... */
136                 page_decref(kva2page((void*)pcpui->spare->stacktop - PGSIZE));
137                 kmem_cache_free(kthread_kcache, pcpui->spare);
138         }
139         current_stacktop = get_stack_top();
140         /* When a kthread runs, its stack is the default kernel stack */
141         set_stack_top(kthread->stacktop);
142         /* Set the spare stuff (current kthread, current (not kthread) stacktop) */
143         pcpui->spare = kthread;
144         kthread->stacktop = current_stacktop;
145         if (current) {
146                 /* __launch_kthread() should have abandoned if it was diff */
147                 assert(current == kthread->proc);
148                 /* no longer need this ref, current holds it */
149                 proc_decref(kthread->proc);
150         } else {
151                 /* ref gets transfered (or it was 0 (no ref held)) */
152                 current = kthread->proc;
153                 if (kthread->proc)
154                         lcr3(kthread->proc->env_cr3);
155         }
156         /* Tell the core which syscall we are running (if any) */
157         assert(!pcpui->cur_sysc);       /* catch bugs, prev user should clear */
158         pcpui->cur_sysc = kthread->sysc;
159         /* Finally, restart our thread */
160         pop_kernel_tf(&kthread->context);
161 }
162
163 /* Call this when a kthread becomes runnable/unblocked.  We don't do anything
164  * particularly smart yet, but when we do, we can put it here. */
165 void kthread_runnable(struct kthread *kthread)
166 {
167         /* For lack of anything better, send it to ourselves. (TODO: KSCHED) */
168         send_kernel_message(core_id(), __launch_kthread, (void*)kthread, 0, 0,
169                             KMSG_ROUTINE);
170 }
171
172 /* Kmsg handler to launch/run a kthread.  This must be a routine message, since
173  * it does not return.  Furthermore, like all routine kmsgs that don't return,
174  * this needs to handle the fact that it won't return to the given TF (which is
175  * a proc's TF, since this was routine). */
176 void __launch_kthread(struct trapframe *tf, uint32_t srcid, void *a0, void *a1,
177                           void *a2)
178 {
179         struct kthread *kthread = (struct kthread*)a0;
180         struct proc *cur_proc = current;
181         /* If there is no proc running, don't worry about not returning. */
182         if (cur_proc) {
183                 /* If we're dying, we have a message incoming that we need to deal with,
184                  * so we send this message to ourselves (at the end of the queue).  This
185                  * is a bit ghetto, and a lot of this will need work. */
186                 if (cur_proc->state == PROC_DYING) {
187                         /* We could fake it and send it manually, but this is fine */
188                         send_kernel_message(core_id(), __launch_kthread, (void*)kthread,
189                                             0, 0, KMSG_ROUTINE);
190                         return;
191                 }
192                 /* TODO: this whole area needs serious work */
193                 if (cur_proc != kthread->proc) {
194                         /* we're running the kthread from a different proc.  For now, we
195                          * can't be _M, since that would be taking away someone's vcore to
196                          * process another process's work. */
197                         /* Keep in mind this can happen if you yield your core after
198                          * submitting work (like sys_block()) that will complete on the
199                          * current core, and then someone else gets it.
200                          * TODO: This can also happen if we started running another _M
201                          * here... */
202                         if (cur_proc->state != PROC_RUNNING_S) {
203                                 printk("cur_proc: %08p, kthread->proc: %08p\n", cur_proc,
204                                        kthread->proc);
205                         }
206                         assert(cur_proc->state == PROC_RUNNING_S);
207                         spin_lock(&cur_proc->proc_lock);
208                         /* Wrap up / yield the current _S proc, which calls schedule_proc */
209                         __proc_yield_s(cur_proc, tf);
210                         spin_unlock(&cur_proc->proc_lock);
211                         abandon_core();
212                 } else {
213                         /* possible to get here if there is only one _S proc that blocked */
214                         //assert(cur_proc->state == PROC_RUNNING_M);
215                         /* Our proc was current, but also wants an old kthread restarted.
216                          * This could happen if we are in the kernel servicing a call, and a
217                          * kthread tries to get restarted here on the way out.  cur_tf ought
218                          * to be the TF that needs to be restarted when the kernel is done
219                          * (regardless of whether or not we rerun kthreads). */
220                         assert(tf == current_tf);
221                         /* And just let the kthread restart, abandoning the call path via
222                          * proc_restartcore (or however we got here). */
223                 }
224         }
225         restart_kthread(kthread);
226         assert(0);
227 }