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