Split pcpui->syscalls into a current and next
[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;
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;                            /* catch bugs */
75         if (kthread->proc)
76                 kref_get(&kthread->proc->kref, 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("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                 kref_put(&kthread->proc->kref);
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("Returning from being 'blocked'!\n");
115         enable_irqsave(&irq_state);
116         return;
117 }
118
119 /* Starts kthread on the calling core.  This does not return, and will handle
120  * the details of cleaning up whatever is currently running (freeing its stack,
121  * etc). */
122 void restart_kthread(struct kthread *kthread)
123 {
124         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
125         uintptr_t current_stacktop;
126         /* Avoid messy complications.  The kthread will enable_irqsave() when it
127          * comes back up. */
128         disable_irq();
129         /* Free any spare, since we need ours to become the spare (since we can't
130          * free our current kthread *before* popping it, nor can we free the current
131          * stack until we pop to the kthread's stack). */
132         if (pcpui->spare) {
133                 page_decref(kva2page((void*)kthread->stacktop - PGSIZE));
134                 kmem_cache_free(kthread_kcache, pcpui->spare);
135         }
136         current_stacktop = get_stack_top();
137         /* When a kthread runs, its stack is the default kernel stack */
138         set_stack_top(kthread->stacktop);
139         /* Set the spare stuff (current kthread, current (not kthread) stacktop) */
140         pcpui->spare = kthread;
141         kthread->stacktop = current_stacktop;
142         if (current) {
143                 /* __launch_kthread() should have abandoned if it was diff */
144                 assert(current == kthread->proc);
145                 /* no longer need this ref, current holds it */
146                 kref_put(&kthread->proc->kref);
147         } else {
148                 /* ref gets transfered (or it was 0 (no ref held)) */
149                 current = kthread->proc;
150                 if (kthread->proc)
151                         lcr3(kthread->proc->env_cr3);
152         }
153         /* Tell the core which syscall we are running (if any) */
154         pcpui->cur_sysc = kthread->sysc;
155         /* Finally, restart our thread */
156         pop_kernel_tf(&kthread->context);
157 }
158
159 /* Call this when a kthread becomes runnable/unblocked.  We don't do anything
160  * particularly smart yet, but when we do, we can put it here. */
161 void kthread_runnable(struct kthread *kthread)
162 {
163         /* For lack of anything better, send it to ourselves. (TODO: KSCHED) */
164         send_kernel_message(core_id(), __launch_kthread, (void*)kthread, 0, 0,
165                             KMSG_ROUTINE);
166 }
167
168 /* Kmsg handler to launch/run a kthread.  This must be a routine message, since
169  * it does not return.  Furthermore, like all routine kmsgs that don't return,
170  * this needs to handle the fact that it won't return to the given TF (which is
171  * a proc's TF, since this was routine). */
172 void __launch_kthread(struct trapframe *tf, uint32_t srcid, void *a0, void *a1,
173                           void *a2)
174 {
175         struct kthread *kthread = (struct kthread*)a0;
176         struct proc *cur_proc = current;
177         /* If there is no proc running, don't worry about not returning. */
178         if (cur_proc) {
179                 /* If we're dying, we have a message incoming that we need to deal with,
180                  * so we send this message to ourselves (at the end of the queue).  This
181                  * is a bit ghetto, and a lot of this will need work. */
182                 if (cur_proc->state == PROC_DYING) {
183                         /* We could fake it and send it manually, but this is fine */
184                         send_kernel_message(core_id(), __launch_kthread, (void*)kthread,
185                                             0, 0, KMSG_ROUTINE);
186                         return;
187                 }
188                 if (cur_proc != kthread->proc) {
189                         /* we're running the kthread from a different proc.  For now, we
190                          * can't be _M, since that would be taking away someone's vcore to
191                          * process another process's work. */
192                         assert(cur_proc->state == PROC_RUNNING_S);
193                         spin_lock(&cur_proc->proc_lock);
194                         /* Wrap up / yield the current _S proc, which calls schedule_proc */
195                         __proc_yield_s(cur_proc, tf);
196                         spin_unlock(&cur_proc->proc_lock);
197                         abandon_core();
198                 } else {
199                         /* possible to get here if there is only one _S proc that blocked */
200                         //assert(cur_proc->state == PROC_RUNNING_M);
201                         /* TODO: might need to do something here, though it will depend on
202                          * how we handle async local calls. */
203                 }
204
205         }
206         restart_kthread(kthread);
207         assert(0);
208 }