Rename RCU CB context to 'cannot block' context
[akaros.git] / kern / src / smp.c
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  */
6
7 #include <arch/arch.h>
8 #include <atomic.h>
9 #include <smp.h>
10 #include <error.h>
11 #include <stdio.h>
12 #include <string.h>
13 #include <assert.h>
14 #include <pmap.h>
15 #include <process.h>
16 #include <schedule.h>
17 #include <trap.h>
18 #include <trace.h>
19 #include <kdebug.h>
20 #include <kmalloc.h>
21 #include <core_set.h>
22 #include <completion.h>
23 #include <rcu.h>
24
25 struct all_cpu_work {
26         struct completion comp;
27         void (*func)(void *);
28         void *opaque;
29 };
30
31 struct per_cpu_info per_cpu_info[MAX_NUM_CORES];
32
33 // tracks number of global waits on smp_calls, must be <= NUM_HANDLER_WRAPPERS
34 atomic_t outstanding_calls = 0;
35
36 /* Helper for running a proc (if we should).  Lots of repetition with
37  * proc_restartcore */
38 static void try_run_proc(void)
39 {
40         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
41         /* There was a process running here, and we should return to it. */
42         if (pcpui->owning_proc) {
43                 assert(!pcpui->cur_kthread->sysc);
44                 assert(pcpui->cur_ctx);
45                 __proc_startcore(pcpui->owning_proc, pcpui->cur_ctx);
46                 assert(0);
47         } else {
48                 /* Make sure we have abandoned core.  It's possible to have an owner
49                  * without a current (smp_idle, __startcore, __death).
50                  *
51                  * If we had a current process, we might trigger __proc_free, which
52                  * could send us a KMSG.  Since we're called after PRKM, let's just
53                  * restart the idle loop. */
54                 if (abandon_core())
55                         smp_idle();
56         }
57 }
58
59 /* All cores end up calling this whenever there is nothing left to do or they
60  * don't know explicitly what to do.  Non-zero cores call it when they are done
61  * booting.  Other cases include after getting a DEATH IPI.
62  *
63  * All cores attempt to run the context of any owning proc.  Barring that, they
64  * halt and wake up when interrupted, do any work on their work queue, then halt
65  * again.  In between, the ksched gets a chance to tell it to do something else,
66  * or perhaps to halt in another manner. */
67 static void __attribute__((noreturn)) __smp_idle(void *arg)
68 {
69         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
70
71         pcpui->cur_kthread->flags = KTH_DEFAULT_FLAGS;
72         while (1) {
73                 /* This might wake a kthread (the gp ktask), so be sure to run PRKM
74                  * after reporting the quiescent state. */
75                 rcu_report_qs();
76                 /* If this runs an RKM, we'll call smp_idle from the top. */
77                 process_routine_kmsg();
78                 try_run_proc();
79                 cpu_bored();            /* call out to the ksched */
80                 /* cpu_halt() atomically turns on interrupts and halts the core.
81                  * Important to do this, since we could have a RKM come in via an
82                  * interrupt right while PRKM is returning, and we wouldn't catch
83                  * it.  When it returns, IRQs are back off. */
84                 __set_cpu_state(pcpui, CPU_STATE_IDLE);
85                 cpu_halt();
86                 __set_cpu_state(pcpui, CPU_STATE_KERNEL);
87         }
88         assert(0);
89 }
90
91 void smp_idle(void)
92 {
93         disable_irq();
94         __reset_stack_pointer(0, get_stack_top(), __smp_idle);
95 }
96
97 /* Arch-independent per-cpu initialization.  This will call the arch dependent
98  * init first. */
99 void smp_percpu_init(void)
100 {
101         uint32_t coreid = core_id();
102         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
103         void *trace_buf;
104         struct kthread *kthread;
105         /* Don't initialize __ctx_depth here, since it is already 1 (at least on
106          * x86), since this runs in irq context. */
107         /* Do this first */
108         __arch_pcpu_init(coreid);
109         /* init our kthread (tracks our currently running context) */
110         kthread = __kthread_zalloc();
111         kthread->stacktop = get_stack_top();    /* assumes we're on the 1st page */
112         pcpui->cur_kthread = kthread;
113         /* Treat the startup threads as ktasks.  This will last until smp_idle when
114          * they clear it, either in anticipation of being a user-backing kthread or
115          * to handle an RKM. */
116         kthread->flags = KTH_KTASK_FLAGS;
117         per_cpu_info[coreid].spare = 0;
118         /* Init relevant lists */
119         spinlock_init_irqsave(&per_cpu_info[coreid].immed_amsg_lock);
120         STAILQ_INIT(&per_cpu_info[coreid].immed_amsgs);
121         spinlock_init_irqsave(&per_cpu_info[coreid].routine_amsg_lock);
122         STAILQ_INIT(&per_cpu_info[coreid].routine_amsgs);
123         /* Initialize the per-core timer chain */
124         init_timer_chain(&per_cpu_info[coreid].tchain, set_pcpu_alarm_interrupt);
125         /* Init generic tracing ring */
126         trace_buf = kpage_alloc_addr();
127         assert(trace_buf);
128         trace_ring_init(&pcpui->traces, trace_buf, PGSIZE,
129                         sizeof(struct pcpu_trace_event));
130         for (int i = 0; i < NR_CPU_STATES; i++)
131                 pcpui->state_ticks[i] = 0;
132         pcpui->last_tick_cnt = read_tsc();
133         /* Core 0 is in the KERNEL state, called from smp_boot.  The other cores are
134          * too, at least on x86, where we were called from asm (woken by POKE). */
135         pcpui->cpu_state = CPU_STATE_KERNEL;
136         /* Enable full lock debugging, after all pcpui work is done */
137         pcpui->__lock_checking_enabled = 1;
138 }
139
140 /* it's actually okay to set the state to the existing state.  originally, it
141  * was a bug in the state tracking, but it is possible, at least on x86, to have
142  * a halted core (state IDLE) get woken up by an IRQ that does not trigger the
143  * IRQ handling state.  for example, there is the I_POKE_CORE ipi.  smp_idle
144  * will just sleep again, and reset the state from IDLE to IDLE. */
145 void __set_cpu_state(struct per_cpu_info *pcpui, int state)
146 {
147         uint64_t now_ticks;
148         assert(!irq_is_enabled());
149         /* TODO: could put in an option to enable/disable state tracking. */
150         now_ticks = read_tsc();
151         pcpui->state_ticks[pcpui->cpu_state] += now_ticks - pcpui->last_tick_cnt;
152         /* TODO: if the state was user, we could account for the vcore's time,
153          * similar to the total_ticks in struct vcore.  the difference is that the
154          * total_ticks tracks the vcore's virtual time, while this tracks user time.
155          * something like vcore->user_ticks. */
156         pcpui->cpu_state = state;
157         pcpui->last_tick_cnt = now_ticks;
158 }
159
160 void reset_cpu_state_ticks(int coreid)
161 {
162         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
163         uint64_t now_ticks;
164         if (coreid >= num_cores)
165                 return;
166         /* need to update last_tick_cnt, so the current value doesn't get added in
167          * next time we update */
168         now_ticks = read_tsc();
169         for (int i = 0; i < NR_CPU_STATES; i++) {
170                 pcpui->state_ticks[i] = 0;
171                 pcpui->last_tick_cnt = now_ticks;
172         }
173 }
174
175 /* PCPUI Trace Rings: */
176
177 static void pcpui_trace_kmsg_handler(void *event, void *data)
178 {
179         struct pcpu_trace_event *te = (struct pcpu_trace_event*)event;
180         uintptr_t addr;
181
182         addr = te->arg1;
183         printk("\tKMSG %p: %s\n", addr, get_fn_name(addr));
184 }
185
186 static void pcpui_trace_locks_handler(void *event, void *data)
187 {
188         struct pcpu_trace_event *te = (struct pcpu_trace_event*)event;
189         const char *func_name;
190         uintptr_t lock_addr = te->arg1;
191
192         if (lock_addr > KERN_LOAD_ADDR)
193                 func_name = get_fn_name(lock_addr);
194         else
195                 func_name = "Dynamic lock";
196         print_lock();
197         printk("Time %uus, lock %p (%s)\n", te->arg0, lock_addr, func_name);
198         printk("\t");
199         spinlock_debug((spinlock_t*)lock_addr);
200         print_unlock();
201 }
202
203 /* Add specific trace handlers here: */
204 trace_handler_t pcpui_tr_handlers[PCPUI_NR_TYPES] = {
205                                   0,
206                                   pcpui_trace_kmsg_handler,
207                                   pcpui_trace_locks_handler,
208                                   };
209
210 /* Generic handler for the pcpui ring.  Will switch out to the appropriate
211  * type's handler */
212 static void pcpui_trace_fn(void *event, void *data)
213 {
214         struct pcpu_trace_event *te = (struct pcpu_trace_event*)event;
215         int desired_type = (int)(long)data;
216         if (te->type >= PCPUI_NR_TYPES)
217                 printk("Bad trace type %d\n", te->type);
218         /* desired_type == 0 means all types */
219         if (desired_type && desired_type != te->type)
220                 return;
221         if (pcpui_tr_handlers[te->type])
222                 pcpui_tr_handlers[te->type](event, data);
223 }
224
225 void pcpui_tr_foreach(int coreid, int type)
226 {
227         struct trace_ring *tr = &per_cpu_info[coreid].traces;
228         assert(tr);
229         printk("\n\nTrace Ring on Core %d\n--------------\n", coreid);
230         trace_ring_foreach(tr, pcpui_trace_fn, (void*)(long)type);
231 }
232
233 void pcpui_tr_foreach_all(int type)
234 {
235         for (int i = 0; i < num_cores; i++)
236                 pcpui_tr_foreach(i, type);
237 }
238
239 void pcpui_tr_reset_all(void)
240 {
241         for (int i = 0; i < num_cores; i++)
242                 trace_ring_reset(&per_cpu_info[i].traces);
243 }
244
245 void pcpui_tr_reset_and_clear_all(void)
246 {
247         for (int i = 0; i < num_cores; i++)
248                 trace_ring_reset_and_clear(&per_cpu_info[i].traces);
249 }
250
251 static void smp_do_core_work(uint32_t srcid, long a0, long a1, long a2)
252 {
253         struct all_cpu_work *acw = (struct all_cpu_work *) a0;
254
255         acw->func(acw->opaque);
256         completion_complete(&acw->comp, 1);
257 }
258
259 void smp_do_in_cores(const struct core_set *cset, void (*func)(void *),
260                                          void *opaque)
261 {
262         int cpu = core_id();
263         struct all_cpu_work acw;
264
265         memset(&acw, 0, sizeof(acw));
266         completion_init(&acw.comp, core_set_remote_count(cset));
267         acw.func = func;
268         acw.opaque = opaque;
269
270         for (int i = 0; i < num_cores; i++) {
271                 if (core_set_getcpu(cset, i)) {
272                         if (i == cpu)
273                                 func(opaque);
274                         else
275                                 send_kernel_message(i, smp_do_core_work, (long) &acw, 0, 0,
276                                                                         KMSG_ROUTINE);
277                 }
278         }
279         completion_wait(&acw.comp);
280 }