SMP boot cleanup
[akaros.git] / kern / src / smp.c
1 #ifdef __DEPUTY__
2 #pragma nodeputy
3 #endif
4
5 #include <arch/x86.h>
6 #include <arch/smp.h>
7 #include <arch/console.h>
8 #include <arch/apic.h>
9 #include <stdio.h>
10 #include <string.h>
11 #include <assert.h>
12 #include <error.h>
13 #include <pmap.h>
14 #include <env.h>
15 #include <atomic.h>
16 #include <trap.h>
17
18 volatile uint8_t num_cpus = 0xee;
19 uintptr_t smp_stack_top;
20 per_cpu_info_t per_cpu_info[MAX_NUM_CPUS];
21
22 /*************************** IPI Wrapper Stuff ********************************/
23 // checklists to protect the global interrupt_handlers for 0xf0, f1, f2, f3, f4
24 // need to be global, since there is no function that will always exist for them
25 handler_wrapper_t             handler_wrappers[NUM_HANDLER_WRAPPERS];
26 // tracks number of global waits on smp_calls, must be <= NUM_HANDLER_WRAPPERS
27 uint32_t outstanding_calls = 0; 
28
29 #define DECLARE_HANDLER_CHECKLISTS(vector)                          \
30         INIT_CHECKLIST(f##vector##_cpu_list, MAX_NUM_CPUS);
31
32 #define INIT_HANDLER_WRAPPER(v)                                     \
33 {                                                                   \
34         handler_wrappers[(v)].vector = 0xf##v;                          \
35         handler_wrappers[(v)].cpu_list = &f##v##_cpu_list;              \
36         handler_wrappers[(v)].cpu_list->mask.size = num_cpus;           \
37 }
38
39 DECLARE_HANDLER_CHECKLISTS(0);
40 DECLARE_HANDLER_CHECKLISTS(1);
41 DECLARE_HANDLER_CHECKLISTS(2);
42 DECLARE_HANDLER_CHECKLISTS(3);
43 DECLARE_HANDLER_CHECKLISTS(4);
44
45 static void init_smp_call_function(void)
46 {
47         INIT_HANDLER_WRAPPER(0);
48         INIT_HANDLER_WRAPPER(1);
49         INIT_HANDLER_WRAPPER(2);
50         INIT_HANDLER_WRAPPER(3);
51         INIT_HANDLER_WRAPPER(4);
52 }
53
54 /******************************************************************************/
55
56 static void smp_mtrr_handler(trapframe_t *tf, void* data)
57 {
58         setup_default_mtrrs((barrier_t*)data);
59 }
60
61 void smp_boot(void)
62 {
63         // this needs to be set in smp_entry too...
64         #define trampoline_pg 0x00001000
65         page_t *smp_stack;
66         // NEED TO GRAB A LOWMEM FREE PAGE FOR AP BOOTUP CODE
67         // page1 (2nd page) is reserved, hardcoded in pmap.c
68         extern smp_entry(), smp_entry_end(), smp_boot_lock(), smp_semaphore();
69         memset(KADDR(trampoline_pg), 0, PGSIZE);
70         memcpy(KADDR(trampoline_pg), &smp_entry, &smp_entry_end - &smp_entry);
71
72         // This mapping allows access to the trampoline with paging on and off
73         // via trampoline_pg
74         page_insert(boot_pgdir, pa2page(trampoline_pg), (void*)trampoline_pg, PTE_W);
75
76         // Allocate a stack for the cores starting up.  One for all, must share
77         if (page_alloc(&smp_stack))
78                 panic("No memory for SMP boot stack!");
79         smp_stack_top = (uintptr_t)(page2kva(smp_stack) + PGSIZE);
80
81         // Start the IPI process (INIT, wait, SIPI, wait, SIPI, wait)
82         send_init_ipi();
83         // SDM 3A is a little wonky wrt the proper delays.  These are my best guess.
84         udelay(10000);
85         // first SIPI
86         send_startup_ipi(0x01);
87         /* BOCHS does not like this second SIPI.
88         // second SIPI
89         udelay(200);
90         send_startup_ipi(0x01);
91         */
92         udelay(100000);
93
94         // Each core will also increment smp_semaphore, and decrement when it is done,
95         // all in smp_entry.  It's purpose is to keep Core0 from competing for the
96         // smp_boot_lock.  So long as one AP increments the sem before the final
97         // LAPIC timer goes off, all available cores will be initialized.
98         while(*(volatile uint32_t*)(&smp_semaphore - &smp_entry + trampoline_pg));
99
100         // From here on, no other cores are coming up.  Grab the lock to ensure it.
101         // Another core could be in it's prelock phase and be trying to grab the lock
102         // forever....
103         // The lock exists on the trampoline, so it can be grabbed right away in
104         // real mode.  If core0 wins the race and blocks other CPUs from coming up
105         // it can crash the machine if the other cores are allowed to proceed with
106         // booting.  Specifically, it's when they turn on paging and have that temp
107         // mapping pulled out from under them.  Now, if a core loses, it will spin
108         // on the trampoline (which we must be careful to not deallocate)
109         spin_lock((uint32_t*)(&smp_boot_lock - &smp_entry + trampoline_pg));
110         cprintf("Num_Cpus Detected: %d\n", num_cpus);
111
112         // Remove the mapping of the page used by the trampoline
113         page_remove(boot_pgdir, (void*)trampoline_pg);
114         // It had a refcount of 2 earlier, so we need to dec once more to free it
115         // but only if all cores are in (or we reset / reinit those that failed)
116         // TODO after we parse ACPI tables
117         if (num_cpus == 8) // TODO - ghetto coded for our 8 way SMPs
118                 page_decref(pa2page(trampoline_pg));
119         // Remove the page table used for that mapping
120         pagetable_remove(boot_pgdir, (void*)trampoline_pg);
121         // Dealloc the temp shared stack
122         page_decref(smp_stack);
123
124         // Set up the generic remote function call facility
125         init_smp_call_function();
126
127         // Set up all cores to use the proper MTRRs
128         barrier_t generic_barrier;
129         init_barrier(&generic_barrier, num_cpus); // barrier used by smp_mtrr_handler
130         smp_call_function_all(smp_mtrr_handler, &generic_barrier, 0);
131
132         // Should probably flush everyone's TLB at this point, to get rid of
133         // temp mappings that were removed.  TODO
134 }
135
136 /*
137  * This is called from smp_entry by each core to finish the core bootstrapping.
138  * There is a spinlock around this entire function in smp_entry, for a few reasons,
139  * the most important being that all cores use the same stack when entering here.
140  */
141 uint32_t smp_main(void)
142 {
143         /*
144         // Print some diagnostics.  Uncomment if there're issues.
145         cprintf("Good morning Vietnam!\n");
146         cprintf("This core's Default APIC ID: 0x%08x\n", lapic_get_default_id());
147         cprintf("This core's Current APIC ID: 0x%08x\n", lapic_get_id());
148         if (read_msr(IA32_APIC_BASE) & 0x00000100)
149                 cprintf("I am the Boot Strap Processor\n");
150         else
151                 cprintf("I am an Application Processor\n");
152         cprintf("Num_Cpus: %d\n\n", num_cpus);
153         */
154
155         // Get a per-core kernel stack
156         page_t *my_stack;
157         if (page_alloc(&my_stack))
158                 panic("Unable to alloc a per-core stack!");
159         memset(page2kva(my_stack), 0, PGSIZE);
160
161         // Set up a gdt / gdt_pd for this core, stored at the top of the stack
162         // This is necessary, eagle-eyed readers know why
163         // GDT should be 4-byte aligned.  TS isn't aligned.  Not sure if it matters.
164         pseudodesc_t *my_gdt_pd = page2kva(my_stack) + PGSIZE -
165                 sizeof(pseudodesc_t) - sizeof(segdesc_t)*SEG_COUNT;
166         segdesc_t *my_gdt = page2kva(my_stack) + PGSIZE -
167                 sizeof(segdesc_t)*SEG_COUNT;
168         // TS also needs to be permanent
169         taskstate_t *my_ts = page2kva(my_stack) + PGSIZE -
170                 sizeof(pseudodesc_t) - sizeof(segdesc_t)*SEG_COUNT -
171                 sizeof(taskstate_t);
172         // Usable portion of the KSTACK grows down from here
173         // Won't actually start using this stack til our first interrupt
174         // (issues with changing the stack pointer and then trying to "return")
175         uintptr_t my_stack_top = (uintptr_t)my_ts;
176         
177         // Set up MSR for SYSENTER 
178         write_msr(MSR_IA32_SYSENTER_CS, GD_KT);
179         write_msr(MSR_IA32_SYSENTER_ESP, my_stack_top);
180         write_msr(MSR_IA32_SYSENTER_EIP, (uint32_t) &sysenter_handler);
181
182         // Build and load the gdt / gdt_pd
183         memcpy(my_gdt, gdt, sizeof(segdesc_t)*SEG_COUNT);
184         *my_gdt_pd = (pseudodesc_t) {
185                 sizeof(segdesc_t)*SEG_COUNT - 1, (uintptr_t) my_gdt };
186         asm volatile("lgdt %0" : : "m"(*my_gdt_pd));
187
188         // Need to set the TSS so we know where to trap on this core
189         my_ts->ts_esp0 = my_stack_top;
190         my_ts->ts_ss0 = GD_KD;
191         // Initialize the TSS field of my_gdt.
192         my_gdt[GD_TSS >> 3] = SEG16(STS_T32A, (uint32_t) (my_ts), sizeof(taskstate_t), 0);
193         my_gdt[GD_TSS >> 3].sd_s = 0;
194         // Load the TSS
195         ltr(GD_TSS);
196
197         // Loads the same IDT used by the other cores
198         asm volatile("lidt idt_pd");
199
200         // APIC setup
201         // set LINT0 to receive ExtINTs (KVM's default).  At reset they are 0x1000.
202         write_mmreg32(LAPIC_LVT_LINT0, 0x700);
203         // mask it to shut it up for now.  Doesn't seem to matter yet, since both
204         // KVM and Bochs seem to only route the PIC to core0.
205         mask_lapic_lvt(LAPIC_LVT_LINT0);
206         // and then turn it on
207         lapic_enable();
208
209         // set a default logical id for now
210         lapic_set_logid(lapic_get_id());
211
212         return my_stack_top; // will be loaded in smp_entry.S
213 }
214
215 /* All non-zero cores call this at the end of their boot process.  They halt,
216  * and wake up when interrupted, do any work on their work queue, then halt
217  * when there is nothing to do.  
218  */
219 void smp_idle(void)
220 {
221         enable_irq();
222         while (1) {
223                 process_workqueue();
224                 // consider races with work added after we started leaving the last func
225                 cpu_halt();
226         }
227 }
228
229 static int smp_call_function(uint8_t type, uint8_t dest, isr_t handler, void* data,
230                               handler_wrapper_t** wait_wrapper)
231 {
232         extern handler_t interrupt_handlers[];
233         int8_t state = 0;
234         uint32_t wrapper_num;
235         handler_wrapper_t* wrapper;
236
237         // prevents us from ever having more than NUM_HANDLER_WRAPPERS callers in
238         // the process of competing for vectors.  not decremented until both after
239         // the while(1) loop and after it's been waited on.
240         atomic_inc(&outstanding_calls);
241         if (outstanding_calls > NUM_HANDLER_WRAPPERS) {
242                 atomic_dec(&outstanding_calls);
243                 return E_BUSY;
244         }
245         
246         // assumes our cores are numbered in order
247         if ((type == 4) && (dest >= num_cpus))
248                 panic("Destination CPU does not exist!");
249
250         // build the mask based on the type and destination
251         INIT_CHECKLIST_MASK(cpu_mask, MAX_NUM_CPUS);
252         // set checklist mask's size dynamically to the num cpus actually present
253         cpu_mask.size = num_cpus;
254         switch (type) {
255                 case 1: // self
256                         SET_BITMASK_BIT(cpu_mask.bits, lapic_get_id());
257                         break;
258                 case 2: // all
259                         FILL_BITMASK(cpu_mask.bits, num_cpus);
260                         break;
261                 case 3: // all but self
262                         FILL_BITMASK(cpu_mask.bits, num_cpus);
263                         CLR_BITMASK_BIT(cpu_mask.bits, lapic_get_id());
264                         break;
265                 case 4: // physical mode
266                         // note this only supports sending to one specific physical id
267                         // (only sets one bit, so if multiple cores have the same phys id
268                         // the first one through will set this).
269                         SET_BITMASK_BIT(cpu_mask.bits, dest);
270                         break;
271                 case 5: // logical mode
272                         // TODO
273                         warn("Logical mode bitmask handler protection not implemented!");
274                         break;
275                 default:
276                         panic("Invalid type for cross-core function call!");
277         }
278
279         // Find an available vector/wrapper.  Starts with this core's id (mod the
280         // number of wrappers).  Walk through on conflict.
281         // Commit returns an error if it wanted to give up for some reason,
282         // like taking too long to acquire the lock or clear the mask, at which
283         // point, we try the next one.
284         // When we are done, wrapper points to the one we finally got.
285         // this wrapper_num trick doesn't work as well if you send a bunch in a row
286         // and wait, since you always check your main one (which is currently busy).
287         wrapper_num = lapic_get_id() % NUM_HANDLER_WRAPPERS;
288         while(1) {
289                 wrapper = &handler_wrappers[wrapper_num];
290                 if (!commit_checklist_wait(wrapper->cpu_list, &cpu_mask))
291                         break;
292                 wrapper_num = (wrapper_num + 1) % NUM_HANDLER_WRAPPERS;
293                 /*
294                 uint32_t count = 0;
295                 // instead of deadlock, smp_call can fail with this.  makes it harder
296                 // to use (have to check your return value).  consider putting a delay
297                 // here too (like if wrapper_num == initial_wrapper_num)
298                 if (count++ > NUM_HANDLER_WRAPPERS * 1000) // note 1000 isn't enough...
299                         return E_BUSY;
300                 */
301         }
302
303         // Wanting to wait is expressed by having a non-NULL handler_wrapper_t**
304         // passed in.  Pass out our reference to wrapper, to wait later.
305         // If we don't want to wait, release the checklist (though it is still not
306         // clear, so it can't be used til everyone checks in).
307         if (wait_wrapper)
308                 *wait_wrapper = wrapper;
309         else {
310                 release_checklist(wrapper->cpu_list);
311                 atomic_dec(&outstanding_calls);
312         }
313
314         // now register our handler to run
315         register_interrupt_handler(interrupt_handlers, wrapper->vector, handler, data);
316         // WRITE MEMORY BARRIER HERE
317         enable_irqsave(&state);
318         // Send the proper type of IPI.  I made up these numbers.
319         switch (type) {
320                 case 1:
321                         send_self_ipi(wrapper->vector);
322                         break;
323                 case 2:
324                         send_broadcast_ipi(wrapper->vector);
325                         break;
326                 case 3:
327                         send_all_others_ipi(wrapper->vector);
328                         break;
329                 case 4: // physical mode
330                         send_ipi(dest, 0, wrapper->vector);
331                         break;
332                 case 5: // logical mode
333                         send_ipi(dest, 1, wrapper->vector);
334                         break;
335                 default:
336                         panic("Invalid type for cross-core function call!");
337         }
338         // wait long enough to receive our own broadcast (PROBABLY WORKS) TODO
339         lapic_wait_to_send();
340         disable_irqsave(&state);
341         return 0;
342 }
343
344 // Wrapper functions.  Add more as they are needed.
345 int smp_call_function_self(isr_t handler, void* data,
346                            handler_wrapper_t** wait_wrapper)
347 {
348         return smp_call_function(1, 0, handler, data, wait_wrapper);
349 }
350
351 int smp_call_function_all(isr_t handler, void* data,
352                           handler_wrapper_t** wait_wrapper)
353 {
354         return smp_call_function(2, 0, handler, data, wait_wrapper);
355 }
356
357 int smp_call_function_single(uint8_t dest, isr_t handler, void* data,
358                              handler_wrapper_t** wait_wrapper)
359 {
360         return smp_call_function(4, dest, handler, data, wait_wrapper);
361 }
362
363 // If you want to wait, pass the address of a pointer up above, then call
364 // this to do the actual waiting.  Be somewhat careful about uninitialized 
365 // or old wrapper pointers.
366 int smp_call_wait(handler_wrapper_t* wrapper)
367 {
368         if (wrapper) {
369                 waiton_checklist(wrapper->cpu_list);
370                 return 0;
371         } else {
372                 warn("Attempting to wait on null wrapper!  Check your return values!");
373                 return E_FAIL;
374         }
375 }
376