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