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