Define a set of default flags for kthreads
[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
24 struct all_cpu_work {
25         struct completion comp;
26         void (*func)(void *);
27         void *opaque;
28 };
29
30 struct per_cpu_info per_cpu_info[MAX_NUM_CORES];
31
32 // tracks number of global waits on smp_calls, must be <= NUM_HANDLER_WRAPPERS
33 atomic_t outstanding_calls = 0;
34
35 /* Helper for running a proc (if we should).  Lots of repetition with
36  * proc_restartcore */
37 static void try_run_proc(void)
38 {
39         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
40         /* There was a process running here, and we should return to it. */
41         if (pcpui->owning_proc) {
42                 assert(!pcpui->cur_kthread->sysc);
43                 assert(pcpui->cur_ctx);
44                 __proc_startcore(pcpui->owning_proc, pcpui->cur_ctx);
45                 assert(0);
46         } else {
47                 /* Make sure we have abandoned core.  It's possible to have an owner
48                  * without a current (smp_idle, __startcore, __death). */
49                 abandon_core();
50         }
51 }
52
53 /* All cores end up calling this whenever there is nothing left to do or they
54  * don't know explicitly what to do.  Non-zero cores call it when they are done
55  * booting.  Other cases include after getting a DEATH IPI.
56  *
57  * All cores attempt to run the context of any owning proc.  Barring that, they
58  * halt and wake up when interrupted, do any work on their work queue, then halt
59  * again.  In between, the ksched gets a chance to tell it to do something else,
60  * or perhaps to halt in another manner. */
61 static void __attribute__((noinline, noreturn)) __smp_idle(void)
62 {
63         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
64
65         clear_rkmsg(pcpui);
66         pcpui->cur_kthread->flags = KTH_DEFAULT_FLAGS;
67         enable_irq();   /* one-shot change to get any IRQs before we halt later */
68         while (1) {
69                 disable_irq();
70                 process_routine_kmsg();
71                 try_run_proc();
72                 cpu_bored();            /* call out to the ksched */
73                 /* cpu_halt() atomically turns on interrupts and halts the core.
74                  * Important to do this, since we could have a RKM come in via an
75                  * interrupt right while PRKM is returning, and we wouldn't catch
76                  * it. */
77                 __set_cpu_state(pcpui, CPU_STATE_IDLE);
78                 cpu_halt();
79                 /* interrupts are back on now (given our current semantics) */
80         }
81         assert(0);
82 }
83
84 void smp_idle(void)
85 {
86         #ifdef CONFIG_RESET_STACKS
87         set_stack_pointer(get_stack_top());
88         set_frame_pointer(0);
89         #endif /* CONFIG_RESET_STACKS */
90         __smp_idle();
91         assert(0);
92 }
93
94 /* Arch-independent per-cpu initialization.  This will call the arch dependent
95  * init first. */
96 void smp_percpu_init(void)
97 {
98         uint32_t coreid = core_id();
99         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
100         void *trace_buf;
101         struct kthread *kthread;
102         /* Don't initialize __ctx_depth here, since it is already 1 (at least on
103          * x86), since this runs in irq context. */
104         /* Do this first */
105         __arch_pcpu_init(coreid);
106         /* init our kthread (tracks our currently running context) */
107         kthread = __kthread_zalloc();
108         kthread->stacktop = get_stack_top();    /* assumes we're on the 1st page */
109         pcpui->cur_kthread = kthread;
110         /* Treat the startup threads as ktasks.  This will last until smp_idle when
111          * they clear it, either in anticipation of being a user-backing kthread or
112          * to handle an RKM. */
113         kthread->flags = KTH_KTASK_FLAGS;
114         per_cpu_info[coreid].spare = 0;
115         /* Init relevant lists */
116         spinlock_init_irqsave(&per_cpu_info[coreid].immed_amsg_lock);
117         STAILQ_INIT(&per_cpu_info[coreid].immed_amsgs);
118         spinlock_init_irqsave(&per_cpu_info[coreid].routine_amsg_lock);
119         STAILQ_INIT(&per_cpu_info[coreid].routine_amsgs);
120         /* Initialize the per-core timer chain */
121         init_timer_chain(&per_cpu_info[coreid].tchain, set_pcpu_alarm_interrupt);
122 #ifdef CONFIG_KTHREAD_POISON
123         *kstack_bottom_addr(kthread->stacktop) = 0xdeadbeef;
124 #endif /* CONFIG_KTHREAD_POISON */
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         char *func_name;
181         uintptr_t addr;
182         addr = te->arg1;
183         func_name = get_fn_name(addr);
184         printk("\tKMSG %p: %s\n", addr, func_name);
185         kfree(func_name);
186 }
187
188 static void pcpui_trace_locks_handler(void *event, void *data)
189 {
190         struct pcpu_trace_event *te = (struct pcpu_trace_event*)event;
191         char *func_name;
192         uintptr_t lock_addr = te->arg1;
193         if (lock_addr > KERN_LOAD_ADDR)
194                 func_name = get_fn_name(lock_addr);
195         else
196                 func_name = "Dynamic 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         if (lock_addr > KERN_LOAD_ADDR)
201                 kfree(func_name);
202 }
203
204 /* Add specific trace handlers here: */
205 trace_handler_t pcpui_tr_handlers[PCPUI_NR_TYPES] = {
206                                   0,
207                                   pcpui_trace_kmsg_handler,
208                                   pcpui_trace_locks_handler,
209                                   };
210
211 /* Generic handler for the pcpui ring.  Will switch out to the appropriate
212  * type's handler */
213 static void pcpui_trace_fn(void *event, void *data)
214 {
215         struct pcpu_trace_event *te = (struct pcpu_trace_event*)event;
216         int desired_type = (int)(long)data;
217         if (te->type >= PCPUI_NR_TYPES)
218                 printk("Bad trace type %d\n", te->type);
219         /* desired_type == 0 means all types */
220         if (desired_type && desired_type != te->type)
221                 return;
222         if (pcpui_tr_handlers[te->type])
223                 pcpui_tr_handlers[te->type](event, data);
224 }
225
226 void pcpui_tr_foreach(int coreid, int type)
227 {
228         struct trace_ring *tr = &per_cpu_info[coreid].traces;
229         assert(tr);
230         printk("\n\nTrace Ring on Core %d\n--------------\n", coreid);
231         trace_ring_foreach(tr, pcpui_trace_fn, (void*)(long)type);
232 }
233
234 void pcpui_tr_foreach_all(int type)
235 {
236         for (int i = 0; i < num_cores; i++)
237                 pcpui_tr_foreach(i, type);
238 }
239
240 void pcpui_tr_reset_all(void)
241 {
242         for (int i = 0; i < num_cores; i++)
243                 trace_ring_reset(&per_cpu_info[i].traces);
244 }
245
246 void pcpui_tr_reset_and_clear_all(void)
247 {
248         for (int i = 0; i < num_cores; i++)
249                 trace_ring_reset_and_clear(&per_cpu_info[i].traces);
250 }
251
252 static void smp_do_core_work(uint32_t srcid, long a0, long a1, long a2)
253 {
254         struct all_cpu_work *acw = (struct all_cpu_work *) a0;
255
256         acw->func(acw->opaque);
257         completion_complete(&acw->comp, 1);
258 }
259
260 void smp_do_in_cores(const struct core_set *cset, void (*func)(void *),
261                                          void *opaque)
262 {
263         int cpu = core_id();
264         struct all_cpu_work acw;
265
266         memset(&acw, 0, sizeof(acw));
267         completion_init(&acw.comp, core_set_remote_count(cset));
268         acw.func = func;
269         acw.opaque = opaque;
270
271         for (int i = 0; i < num_cores; i++) {
272                 if (core_set_getcpu(cset, i)) {
273                         if (i == cpu)
274                                 func(opaque);
275                         else
276                                 send_kernel_message(i, smp_do_core_work, (long) &acw, 0, 0,
277                                                                         KMSG_ROUTINE);
278                 }
279         }
280         completion_wait(&acw.comp);
281 }