Massive reorganizing and making all the makefiles consistent.
[akaros.git] / kern / src / smp.c
1 #ifdef __DEPUTY__
2 #pragma nodeputy
3 #endif
4
5 #include <inc/stdio.h>
6 #include <inc/string.h>
7 #include <inc/assert.h>
8 #include <inc/error.h>
9 #include <inc/x86.h>
10
11 #include <kern/smp.h>
12 #include <kern/console.h>
13 #include <kern/pmap.h>
14 #include <kern/env.h>
15 #include <kern/apic.h>
16 #include <kern/atomic.h>
17 #include <kern/trap.h>
18
19 volatile uint8_t num_cpus = 0xee;
20 uintptr_t smp_stack_top;
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         // Dealloc the temp shared stack
120         page_decref(smp_stack);
121
122         // Set up the generic remote function call facility
123         init_smp_call_function();
124
125         // Set up all cores to use the proper MTRRs
126         barrier_t generic_barrier;
127         init_barrier(&generic_barrier, num_cpus); // barrier used by smp_mtrr_handler
128         smp_call_function_all(smp_mtrr_handler, &generic_barrier, 0);
129
130         // Should probably flush everyone's TLB at this point, to get rid of
131         // temp mappings that were removed.  TODO
132 }
133
134 /*
135  * This is called from smp_entry by each core to finish the core bootstrapping.
136  * There is a spinlock around this entire function in smp_entry, for a few reasons,
137  * the most important being that all cores use the same stack when entering here.
138  */
139 uint32_t smp_main(void)
140 {
141         /*
142         // Print some diagnostics.  Uncomment if there're issues.
143         cprintf("Good morning Vietnam!\n");
144         cprintf("This core's Default APIC ID: 0x%08x\n", lapic_get_default_id());
145         cprintf("This core's Current APIC ID: 0x%08x\n", lapic_get_id());
146         if (read_msr(IA32_APIC_BASE) & 0x00000100)
147                 cprintf("I am the Boot Strap Processor\n");
148         else
149                 cprintf("I am an Application Processor\n");
150         cprintf("Num_Cpus: %d\n\n", num_cpus);
151         */
152
153         // Get a per-core kernel stack
154         page_t *my_stack;
155         if (page_alloc(&my_stack))
156                 panic("Unable to alloc a per-core stack!");
157         memset(page2kva(my_stack), 0, PGSIZE);
158
159         // Set up a gdt / gdt_pd for this core, stored at the top of the stack
160         // This is necessary, eagle-eyed readers know why
161         // GDT should be 4-byte aligned.  TS isn't aligned.  Not sure if it matters.
162         pseudodesc_t *my_gdt_pd = page2kva(my_stack) + PGSIZE -
163                 sizeof(pseudodesc_t) - sizeof(segdesc_t)*SEG_COUNT;
164         segdesc_t *my_gdt = page2kva(my_stack) + PGSIZE -
165                 sizeof(segdesc_t)*SEG_COUNT;
166         // TS also needs to be permanent
167         taskstate_t *my_ts = page2kva(my_stack) + PGSIZE -
168                 sizeof(pseudodesc_t) - sizeof(segdesc_t)*SEG_COUNT -
169                 sizeof(taskstate_t);
170         // Usable portion of the KSTACK grows down from here
171         // Won't actually start using this stack til our first interrupt
172         // (issues with changing the stack pointer and then trying to "return")
173         uintptr_t my_stack_top = (uintptr_t)my_ts;
174         
175         // Set up MSR for SYSENTER 
176         write_msr(MSR_IA32_SYSENTER_CS, GD_KT);
177         write_msr(MSR_IA32_SYSENTER_ESP, my_stack_top);
178         write_msr(MSR_IA32_SYSENTER_EIP, (uint32_t) &sysenter_handler);
179
180         // Build and load the gdt / gdt_pd
181         memcpy(my_gdt, gdt, sizeof(segdesc_t)*SEG_COUNT);
182         *my_gdt_pd = (pseudodesc_t) {
183                 sizeof(segdesc_t)*SEG_COUNT - 1, (uintptr_t) my_gdt };
184         asm volatile("lgdt %0" : : "m"(*my_gdt_pd));
185
186         // Need to set the TSS so we know where to trap on this core
187         my_ts->ts_esp0 = my_stack_top;
188         my_ts->ts_ss0 = GD_KD;
189         // Initialize the TSS field of my_gdt.
190         my_gdt[GD_TSS >> 3] = SEG16(STS_T32A, (uint32_t) (my_ts), sizeof(taskstate_t), 0);
191         my_gdt[GD_TSS >> 3].sd_s = 0;
192         // Load the TSS
193         ltr(GD_TSS);
194
195         // Loads the same IDT used by the other cores
196         asm volatile("lidt idt_pd");
197
198         // APIC setup
199         // set LINT0 to receive ExtINTs (KVM's default).  At reset they are 0x1000.
200         write_mmreg32(LAPIC_LVT_LINT0, 0x700);
201         // mask it to shut it up for now.  Doesn't seem to matter yet, since both
202         // KVM and Bochs seem to only route the PIC to core0.
203         mask_lapic_lvt(LAPIC_LVT_LINT0);
204         // and then turn it on
205         lapic_enable();
206
207         // set a default logical id for now
208         lapic_set_logid(lapic_get_id());
209
210         return my_stack_top; // will be loaded in smp_entry.S
211 }
212
213 // this idles a core, sometimes we need to call it directly.  never returns.
214 // the pause is somewhat of a hack, since kvm isn't halting.  not sure what the
215 // deal is with that.
216 void smp_idle(void)
217 {
218         asm volatile("1: hlt; pause; jmp 1b;");
219 }
220
221 static int smp_call_function(uint8_t type, uint8_t dest, isr_t handler, void* data,
222                               handler_wrapper_t** wait_wrapper)
223 {
224         extern handler_t interrupt_handlers[];
225         int8_t state = 0;
226         uint32_t wrapper_num;
227         handler_wrapper_t* wrapper;
228
229         // prevents us from ever having more than NUM_HANDLER_WRAPPERS callers in
230         // the process of competing for vectors.  not decremented until both after
231         // the while(1) loop and after it's been waited on.
232         atomic_inc(&outstanding_calls);
233         if (outstanding_calls > NUM_HANDLER_WRAPPERS) {
234                 atomic_dec(&outstanding_calls);
235                 return E_BUSY;
236         }
237         
238         // assumes our cores are numbered in order
239         if ((type == 4) && (dest >= num_cpus))
240                 panic("Destination CPU does not exist!");
241
242         // build the mask based on the type and destination
243         INIT_CHECKLIST_MASK(cpu_mask, MAX_NUM_CPUS);
244         // set checklist mask's size dynamically to the num cpus actually present
245         cpu_mask.size = num_cpus;
246         switch (type) {
247                 case 1: // self
248                         SET_BITMASK_BIT(cpu_mask.bits, lapic_get_id());
249                         break;
250                 case 2: // all
251                         FILL_BITMASK(cpu_mask.bits, num_cpus);
252                         break;
253                 case 3: // all but self
254                         FILL_BITMASK(cpu_mask.bits, num_cpus);
255                         CLR_BITMASK_BIT(cpu_mask.bits, lapic_get_id());
256                         break;
257                 case 4: // physical mode
258                         // note this only supports sending to one specific physical id
259                         // (only sets one bit, so if multiple cores have the same phys id
260                         // the first one through will set this).
261                         SET_BITMASK_BIT(cpu_mask.bits, dest);
262                         break;
263                 case 5: // logical mode
264                         // TODO
265                         warn("Logical mode bitmask handler protection not implemented!");
266                         break;
267                 default:
268                         panic("Invalid type for cross-core function call!");
269         }
270
271         // Find an available vector/wrapper.  Starts with this core's id (mod the
272         // number of wrappers).  Walk through on conflict.
273         // Commit returns an error if it wanted to give up for some reason,
274         // like taking too long to acquire the lock or clear the mask, at which
275         // point, we try the next one.
276         // When we are done, wrapper points to the one we finally got.
277         // this wrapper_num trick doesn't work as well if you send a bunch in a row
278         // and wait, since you always check your main one (which is currently busy).
279         wrapper_num = lapic_get_id() % NUM_HANDLER_WRAPPERS;
280         while(1) {
281                 wrapper = &handler_wrappers[wrapper_num];
282                 if (!commit_checklist_wait(wrapper->cpu_list, &cpu_mask))
283                         break;
284                 wrapper_num = (wrapper_num + 1) % NUM_HANDLER_WRAPPERS;
285                 /*
286                 uint32_t count = 0;
287                 // instead of deadlock, smp_call can fail with this.  makes it harder
288                 // to use (have to check your return value).  consider putting a delay
289                 // here too (like if wrapper_num == initial_wrapper_num)
290                 if (count++ > NUM_HANDLER_WRAPPERS * 1000) // note 1000 isn't enough...
291                         return E_BUSY;
292                 */
293         }
294
295         // Wanting to wait is expressed by having a non-NULL handler_wrapper_t**
296         // passed in.  Pass out our reference to wrapper, to wait later.
297         // If we don't want to wait, release the checklist (though it is still not
298         // clear, so it can't be used til everyone checks in).
299         if (wait_wrapper)
300                 *wait_wrapper = wrapper;
301         else {
302                 release_checklist(wrapper->cpu_list);
303                 atomic_dec(&outstanding_calls);
304         }
305
306         // now register our handler to run
307         register_interrupt_handler(interrupt_handlers, wrapper->vector, handler, data);
308         // WRITE MEMORY BARRIER HERE
309         enable_irqsave(&state);
310         // Send the proper type of IPI.  I made up these numbers.
311         switch (type) {
312                 case 1:
313                         send_self_ipi(wrapper->vector);
314                         break;
315                 case 2:
316                         send_broadcast_ipi(wrapper->vector);
317                         break;
318                 case 3:
319                         send_all_others_ipi(wrapper->vector);
320                         break;
321                 case 4: // physical mode
322                         send_ipi(dest, 0, wrapper->vector);
323                         break;
324                 case 5: // logical mode
325                         send_ipi(dest, 1, wrapper->vector);
326                         break;
327                 default:
328                         panic("Invalid type for cross-core function call!");
329         }
330         // wait long enough to receive our own broadcast (PROBABLY WORKS) TODO
331         lapic_wait_to_send();
332         disable_irqsave(&state);
333         return 0;
334 }
335
336 // Wrapper functions.  Add more as they are needed.
337 int smp_call_function_self(isr_t handler, void* data,
338                            handler_wrapper_t** wait_wrapper)
339 {
340         return smp_call_function(1, 0, handler, data, wait_wrapper);
341 }
342
343 int smp_call_function_all(isr_t handler, void* data,
344                           handler_wrapper_t** wait_wrapper)
345 {
346         return smp_call_function(2, 0, handler, data, wait_wrapper);
347 }
348
349 int smp_call_function_single(uint8_t dest, isr_t handler, void* data,
350                              handler_wrapper_t** wait_wrapper)
351 {
352         return smp_call_function(4, dest, handler, data, wait_wrapper);
353 }
354
355 // If you want to wait, pass the address of a pointer up above, then call
356 // this to do the actual waiting.  Be somewhat careful about uninitialized 
357 // or old wrapper pointers.
358 int smp_call_wait(handler_wrapper_t* wrapper)
359 {
360         if (wrapper) {
361                 waiton_checklist(wrapper->cpu_list);
362                 return 0;
363         } else {
364                 warn("Attempting to wait on null wrapper!  Check your return values!");
365                 return E_FAIL;
366         }
367 }
368