Fixes x86 LAPIC_ISR/IRR reading
[akaros.git] / kern / arch / i686 / trap.c
1 #ifdef __SHARC__
2 #pragma nosharc
3 #define SINIT(x) x
4 #endif
5
6 #include <arch/mmu.h>
7 #include <arch/x86.h>
8 #include <arch/arch.h>
9 #include <arch/console.h>
10 #include <arch/apic.h>
11 #include <ros/common.h>
12 #include <smp.h>
13 #include <assert.h>
14 #include <pmap.h>
15 #include <trap.h>
16 #include <monitor.h>
17 #include <process.h>
18 #include <mm.h>
19 #include <stdio.h>
20 #include <slab.h>
21 #include <syscall.h>
22 #include <kdebug.h>
23 #include <kmalloc.h>
24
25 taskstate_t RO ts;
26
27 /* Interrupt descriptor table.  (Must be built at run time because
28  * shifted function addresses can't be represented in relocation records.)
29  */
30 // Aligned on an 8 byte boundary (SDM V3A 5-13)
31 gatedesc_t __attribute__ ((aligned (8))) (RO idt)[256] = { { 0 } };
32 pseudodesc_t RO idt_pd = {
33         sizeof(idt) - 1, (uint32_t) idt
34 };
35
36 /* global handler table, used by core0 (for now).  allows the registration
37  * of functions to be called when servicing an interrupt.  other cores
38  * can set up their own later.
39  */
40 #ifdef __IVY__
41 #pragma cilnoremove("iht_lock")
42 #endif
43 spinlock_t iht_lock;
44 handler_t TP(TV(t)) LCKD(&iht_lock) (RO interrupt_handlers)[NUM_INTERRUPT_HANDLERS];
45
46 /* x86-specific interrupt handlers */
47 void __kernel_message(struct trapframe *tf, void *data);
48
49 static const char *NTS trapname(int trapno)
50 {
51     // zra: excnames is SREADONLY because Ivy doesn't trust const
52         static const char *NT const (RO excnames)[] = {
53                 "Divide error",
54                 "Debug",
55                 "Non-Maskable Interrupt",
56                 "Breakpoint",
57                 "Overflow",
58                 "BOUND Range Exceeded",
59                 "Invalid Opcode",
60                 "Device Not Available",
61                 "Double Fault",
62                 "Coprocessor Segment Overrun",
63                 "Invalid TSS",
64                 "Segment Not Present",
65                 "Stack Fault",
66                 "General Protection",
67                 "Page Fault",
68                 "(unknown trap)",
69                 "x87 FPU Floating-Point Error",
70                 "Alignment Check",
71                 "Machine-Check",
72                 "SIMD Floating-Point Exception"
73         };
74
75         if (trapno < sizeof(excnames)/sizeof(excnames[0]))
76                 return excnames[trapno];
77         if (trapno == T_SYSCALL)
78                 return "System call";
79         return "(unknown trap)";
80 }
81
82 /* Set stacktop for the current core to be the stack the kernel will start on
83  * when trapping/interrupting from userspace.  Don't use this til after
84  * smp_percpu_init().  We can probably get the TSS by reading the task register
85  * and then the GDT.  Still, it's a pain. */
86 void set_stack_top(uintptr_t stacktop)
87 {
88         struct per_cpu_info *pcpu = &per_cpu_info[core_id()];
89         /* No need to reload the task register, this takes effect immediately */
90         pcpu->tss->ts_esp0 = stacktop;
91         /* Also need to make sure sysenters come in correctly */
92         write_msr(MSR_IA32_SYSENTER_ESP, stacktop);
93 }
94
95 /* Note the check implies we only are on a one page stack (or the first page) */
96 uintptr_t get_stack_top(void)
97 {
98         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
99         uintptr_t stacktop;
100         /* so we can check this in interrupt handlers (before smp_boot()) */
101         if (!pcpui->tss)
102                 return ROUNDUP(read_esp(), PGSIZE);
103         stacktop = pcpui->tss->ts_esp0;
104         if (stacktop != ROUNDUP(read_esp(), PGSIZE))
105                 panic("Bad stacktop: %08p esp one is %08p\n", stacktop,
106                       ROUNDUP(read_esp(), PGSIZE));
107         return stacktop;
108 }
109
110 /* Starts running the current TF, just using ret. */
111 void pop_kernel_tf(struct trapframe *tf)
112 {
113         asm volatile ("movl %1,%%esp;           " /* move to future stack */
114                       "pushl %2;                " /* push cs */
115                       "movl %0,%%esp;           " /* move to TF */
116                       "addl $0x20,%%esp;        " /* move to tf_gs slot */
117                       "movl %1,(%%esp);         " /* write future esp */
118                       "subl $0x20,%%esp;        " /* move back to tf start */
119                       "popal;                   " /* restore regs */
120                       "popl %%esp;              " /* set stack ptr */
121                       "subl $0x4,%%esp;         " /* jump down past CS */
122                       "ret                      " /* return to the EIP */
123                       :
124                       : "g"(tf), "r"(tf->tf_esp), "r"(tf->tf_eip) : "memory");
125         panic("ret failed");                            /* mostly to placate your mom */
126 }
127
128 /* Sends a non-maskable interrupt; the handler will print a trapframe. */
129 void send_nmi(uint32_t os_coreid)
130 {
131         /* NMI / IPI for x86 are limited to 8 bits */
132         uint8_t hw_core = (uint8_t)get_hw_coreid(os_coreid);
133         __send_nmi(hw_core);
134 }
135
136 void idt_init(void)
137 {
138         extern segdesc_t (RO gdt)[];
139
140         // This table is made in trapentry.S by each macro in that file.
141         // It is layed out such that the ith entry is the ith's traphandler's
142         // (uint32_t) trap addr, then (uint32_t) trap number
143         struct trapinfo { uint32_t trapaddr; uint32_t trapnumber; };
144         extern struct trapinfo (BND(__this,trap_tbl_end) RO trap_tbl)[];
145         extern struct trapinfo (SNT RO trap_tbl_end)[];
146         int i, trap_tbl_size = trap_tbl_end - trap_tbl;
147         extern void ISR_default(void);
148
149         // set all to default, to catch everything
150         for(i = 0; i < 256; i++)
151                 ROSETGATE(idt[i], 0, GD_KT, &ISR_default, 0);
152
153         // set all entries that have real trap handlers
154         // we need to stop short of the last one, since the last is the default
155         // handler with a fake interrupt number (500) that is out of bounds of
156         // the idt[]
157         // if we set these to trap gates, be sure to handle the IRQs separately
158         // and we might need to break our pretty tables
159         for(i = 0; i < trap_tbl_size - 1; i++)
160                 ROSETGATE(idt[trap_tbl[i].trapnumber], 0, GD_KT, trap_tbl[i].trapaddr, 0);
161
162         // turn on syscall handling and other user-accessible ints
163         // DPL 3 means this can be triggered by the int instruction
164         // STS_TG32 sets the IDT type to a Interrupt Gate (interrupts disabled)
165         idt[T_SYSCALL].gd_dpl = SINIT(3);
166         idt[T_SYSCALL].gd_type = SINIT(STS_IG32);
167         idt[T_BRKPT].gd_dpl = SINIT(3);
168
169         /* Setup a TSS so that we get the right stack when we trap to the kernel. */
170         ts.ts_esp0 = (uintptr_t)bootstacktop;
171         ts.ts_ss0 = SINIT(GD_KD);
172 #ifdef __CONFIG_KTHREAD_POISON__
173         /* TODO: KTHR-STACK */
174         uintptr_t *poison = (uintptr_t*)ROUNDDOWN(bootstacktop - 1, PGSIZE);
175         *poison = 0xdeadbeef;
176 #endif /* __CONFIG_KTHREAD_POISON__ */
177
178         // Initialize the TSS field of the gdt.
179         SEG16ROINIT(gdt[GD_TSS >> 3],STS_T32A, (uint32_t)(&ts),sizeof(taskstate_t),0);
180         //gdt[GD_TSS >> 3] = (segdesc_t)SEG16(STS_T32A, (uint32_t) (&ts),
181         //                                 sizeof(taskstate_t), 0);
182         gdt[GD_TSS >> 3].sd_s = SINIT(0);
183
184         // Load the TSS
185         ltr(GD_TSS);
186
187         // Load the IDT
188         asm volatile("lidt idt_pd");
189
190         // This will go away when we start using the IOAPIC properly
191         pic_remap();
192         // set LINT0 to receive ExtINTs (KVM's default).  At reset they are 0x1000.
193         write_mmreg32(LAPIC_LVT_LINT0, 0x700);
194         // mask it to shut it up for now
195         mask_lapic_lvt(LAPIC_LVT_LINT0);
196         // and turn it on
197         lapic_enable();
198         /* register the generic timer_interrupt() handler for the per-core timers */
199         register_interrupt_handler(interrupt_handlers, LAPIC_TIMER_DEFAULT_VECTOR,
200                                    timer_interrupt, NULL);
201         /* register the kernel message handler */
202         register_interrupt_handler(interrupt_handlers, I_KERNEL_MSG,
203                                    __kernel_message, NULL);
204 }
205
206 void
207 print_regs(push_regs_t *regs)
208 {
209         cprintf("  edi  0x%08x\n", regs->reg_edi);
210         cprintf("  esi  0x%08x\n", regs->reg_esi);
211         cprintf("  ebp  0x%08x\n", regs->reg_ebp);
212         cprintf("  oesp 0x%08x\n", regs->reg_oesp);
213         cprintf("  ebx  0x%08x\n", regs->reg_ebx);
214         cprintf("  edx  0x%08x\n", regs->reg_edx);
215         cprintf("  ecx  0x%08x\n", regs->reg_ecx);
216         cprintf("  eax  0x%08x\n", regs->reg_eax);
217 }
218
219 void
220 print_trapframe(trapframe_t *tf)
221 {
222         static spinlock_t ptf_lock;
223
224         spin_lock_irqsave(&ptf_lock);
225         printk("TRAP frame at %p on core %d\n", tf, core_id());
226         print_regs(&tf->tf_regs);
227         printk("  gs   0x----%04x\n", tf->tf_gs);
228         printk("  fs   0x----%04x\n", tf->tf_fs);
229         printk("  es   0x----%04x\n", tf->tf_es);
230         printk("  ds   0x----%04x\n", tf->tf_ds);
231         printk("  trap 0x%08x %s\n", tf->tf_trapno, trapname(tf->tf_trapno));
232         printk("  err  0x%08x\n", tf->tf_err);
233         printk("  eip  0x%08x\n", tf->tf_eip);
234         printk("  cs   0x----%04x\n", tf->tf_cs);
235         printk("  flag 0x%08x\n", tf->tf_eflags);
236         /* Prevents us from thinking these mean something for nested interrupts. */
237         if (tf->tf_cs != GD_KT) {
238                 printk("  esp  0x%08x\n", tf->tf_esp);
239                 printk("  ss   0x----%04x\n", tf->tf_ss);
240         }
241         spin_unlock_irqsave(&ptf_lock);
242 }
243
244 /* Certain traps want IRQs enabled, such as the syscall.  Others can't handle
245  * it, like the page fault handler.  Turn them on on a case-by-case basis. */
246 static void trap_dispatch(struct trapframe *tf)
247 {
248         // Handle processor exceptions.
249         switch(tf->tf_trapno) {
250                 case T_NMI:
251                         print_trapframe(tf);
252                         char *fn_name = get_fn_name(tf->tf_eip);
253                         printk("Core %d is at %08p (%s)\n", core_id(), tf->tf_eip, fn_name);
254                         kfree(fn_name);
255                         break;
256                 case T_BRKPT:
257                         enable_irq();
258                         monitor(tf);
259                         break;
260                 case T_PGFLT:
261                         page_fault_handler(tf);
262                         break;
263                 case T_SYSCALL:
264                         enable_irq();
265                         // check for userspace, for now
266                         assert(tf->tf_cs != GD_KT);
267                         /* Set up and run the async calls */
268                         prep_syscalls(current, (struct syscall*)tf->tf_regs.reg_eax,
269                                       tf->tf_regs.reg_edx);
270                         break;
271                 default:
272                         // Unexpected trap: The user process or the kernel has a bug.
273                         print_trapframe(tf);
274                         if (tf->tf_cs == GD_KT)
275                                 panic("Damn Damn!  Unhandled trap in the kernel!");
276                         else {
277                                 warn("Unexpected trap from userspace");
278                                 proc_destroy(current);
279                         }
280         }
281         return;
282 }
283
284 void
285 env_push_ancillary_state(env_t* e)
286 {
287         // TODO: (HSS) handle silly state (don't really want this per-process)
288         // Here's where you'll save FP/MMX/XMM regs
289 }
290
291 void
292 env_pop_ancillary_state(env_t* e)
293 {
294         // Here's where you'll restore FP/MMX/XMM regs
295 }
296
297 /* Helper.  For now, this copies out the TF to pcpui.  Eventually, we should
298  * consider doing this in trapentry.S */
299 static void set_current_tf(struct per_cpu_info *pcpui, struct trapframe *tf)
300 {
301         assert(!irq_is_enabled());
302         assert(!pcpui->cur_tf);
303         pcpui->actual_tf = *tf;
304         pcpui->cur_tf = &pcpui->actual_tf;
305 }
306
307 /* If the interrupt interrupted a halt, we advance past it.  Made to work with
308  * x86's custom cpu_halt() in arch/arch.h.  Note this nearly never gets called.
309  * I needed to insert exactly one 'nop' in cpu_halt() (that isn't there now) to
310  * get the interrupt to trip on the hlt, o/w the hlt will execute before the
311  * interrupt arrives (even with a pending interrupt that should hit right after
312  * an interrupt_enable (sti)).  This was on the i7. */
313 static void abort_halt(struct trapframe *tf)
314 {
315         /* Don't care about user TFs.  Incidentally, dereferencing user EIPs is
316          * reading userspace memory, which can be dangerous.  It can page fault,
317          * like immediately after a fork (which doesn't populate the pages). */
318         if (!in_kernel(tf))
319                 return;
320         /* the halt instruction in 32 bit is 0xf4, and it's size is 1 byte */
321         if (*(uint8_t*)tf->tf_eip == 0xf4)
322                 tf->tf_eip += 1;
323 }
324
325 void trap(struct trapframe *tf)
326 {
327         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
328         /* Copy out the TF for now, set tf to point to it.  */
329         if (!in_kernel(tf))
330                 set_current_tf(pcpui, tf);
331
332         printd("Incoming TRAP %d on core %d, TF at %p\n", tf->tf_trapno, core_id(),
333                tf);
334         if ((tf->tf_cs & ~3) != GD_UT && (tf->tf_cs & ~3) != GD_KT) {
335                 print_trapframe(tf);
336                 panic("Trapframe with invalid CS!");
337         }
338         trap_dispatch(tf);
339         /* Return to the current process, which should be runnable.  If we're the
340          * kernel, we should just return naturally.  Note that current and tf need
341          * to still be okay (might not be after blocking) */
342         if (in_kernel(tf))
343                 return; /* TODO: think about this, might want a helper instead. */
344         proc_restartcore();
345         assert(0);
346 }
347
348 /* Tells us if an interrupt (trap_nr) came from the PIC or not */
349 static bool irq_from_pic(uint32_t trap_nr)
350 {
351         /* The 16 IRQs within the range [PIC1_OFFSET, PIC1_OFFSET + 15] came from
352          * the PIC.  [32-47] */
353         if (trap_nr < PIC1_OFFSET)
354                 return FALSE;
355         if (trap_nr > PIC1_OFFSET + 15)
356                 return FALSE;
357         return TRUE;
358 }
359
360 /* Helper: returns TRUE if the irq is spurious.  Pass in the trap_nr, not the
361  * IRQ number (trap_nr = PIC_OFFSET + irq) */
362 static bool check_spurious_irq(uint32_t trap_nr)
363 {
364 #ifndef __CONFIG_ENABLE_MPTABLES__              /* TODO: our proxy for using the PIC */
365         /* the PIC may send spurious irqs via one of the chips irq 7.  if the isr
366          * doesn't show that irq, then it was spurious, and we don't send an eoi.
367          * Check out http://wiki.osdev.org/8259_PIC#Spurious_IRQs */
368         if ((trap_nr == PIC1_SPURIOUS) && !(pic_get_isr() & PIC1_SPURIOUS)) {
369                 printk("Spurious PIC1 irq!\n"); /* want to know if this happens */
370                 return TRUE;
371         }
372         if ((trap_nr == PIC2_SPURIOUS) && !(pic_get_isr() & PIC2_SPURIOUS)) {
373                 printk("Spurious PIC2 irq!\n"); /* want to know if this happens */
374                 /* for the cascaded PIC, we *do* need to send an EOI to the master's
375                  * cascade irq (2). */
376                 pic_send_eoi(2);
377                 return TRUE;
378         }
379         /* At this point, we know the PIC didn't send a spurious IRQ */
380         if (irq_from_pic(trap_nr))
381                 return FALSE;
382 #endif
383         /* Either way (with or without a PIC), we need to check the LAPIC.
384          * FYI: lapic_spurious is 255 on qemu and 15 on the nehalem..  We actually
385          * can set bits 4-7, and P6s have 0-3 hardwired to 0.  YMMV.
386          *
387          * The SDM recommends not using the spurious vector for any other IRQs (LVT
388          * or IOAPIC RTE), since the handlers don't send an EOI.  However, our check
389          * here allows us to use the vector since we can tell the diff btw a
390          * spurious and a real IRQ. */
391         uint8_t lapic_spurious = read_mmreg32(LAPIC_SPURIOUS) & 0xff;
392         /* Note the lapic's vectors are not shifted by an offset. */
393         if ((trap_nr == lapic_spurious) && !lapic_get_isr_bit(lapic_spurious)) {
394                 printk("Spurious LAPIC irq %d, core %d!\n", lapic_spurious, core_id());
395                 lapic_print_isr();
396                 return TRUE;
397         }
398         return FALSE;
399 }
400
401 /* Helper, sends an end-of-interrupt for the trap_nr (not HW IRQ number). */
402 static void send_eoi(uint32_t trap_nr)
403 {
404 #ifndef __CONFIG_ENABLE_MPTABLES__              /* TODO: our proxy for using the PIC */
405         /* WARNING: this will break if the LAPIC requests vectors that overlap with
406          * the PIC's range. */
407         if (irq_from_pic(trap_nr))
408                 pic_send_eoi(trap_nr - PIC1_OFFSET);
409         else
410                 lapic_send_eoi();
411 #else
412         lapic_send_eoi();
413 #endif
414 }
415
416 /* Note IRQs are disabled unless explicitly turned on.
417  *
418  * In general, we should only get trapno's >= PIC1_OFFSET (32).  Anything else
419  * should be a trap.  Even if we don't use the PIC, that should be the standard.
420  * It is possible to get a spurious LAPIC IRQ with vector 15 (or similar), but
421  * the spurious check should catch that.
422  *
423  * Note that from hardware's perspective (PIC, etc), IRQs start from 0, but they
424  * are all mapped up at PIC1_OFFSET for the cpu / irq_handler. */
425 void irq_handler(struct trapframe *tf)
426 {
427         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
428         /* Copy out the TF for now, set tf to point to it. */
429         if (!in_kernel(tf))
430                 set_current_tf(pcpui, tf);
431         /* Coupled with cpu_halt() and smp_idle() */
432         abort_halt(tf);
433         //if (core_id())
434                 printd("Incoming IRQ, ISR: %d on core %d\n", tf->tf_trapno, core_id());
435         if (check_spurious_irq(tf->tf_trapno))
436                 goto out_no_eoi;
437         extern handler_wrapper_t (RO handler_wrappers)[NUM_HANDLER_WRAPPERS];
438
439         // determine the interrupt handler table to use.  for now, pick the global
440         handler_t TP(TV(t)) LCKD(&iht_lock) * handler_tbl = interrupt_handlers;
441
442         if (handler_tbl[tf->tf_trapno].isr != 0)
443                 handler_tbl[tf->tf_trapno].isr(tf, handler_tbl[tf->tf_trapno].data);
444         // if we're a general purpose IPI function call, down the cpu_list
445         if ((I_SMP_CALL0 <= tf->tf_trapno) && (tf->tf_trapno <= I_SMP_CALL_LAST))
446                 down_checklist(handler_wrappers[tf->tf_trapno & 0x0f].cpu_list);
447
448         // Send EOI.  might want to do this in assembly, and possibly earlier
449         // This is set up to work with an old PIC for now
450         // Convention is that all IRQs between 32 and 47 are for the PIC.
451         // All others are LAPIC (timer, IPIs, perf, non-ExtINT LINTS, etc)
452         // For now, only 235-255 are available
453         assert(tf->tf_trapno >= 32); // slows us down, but we should never have this
454         send_eoi(tf->tf_trapno);
455 out_no_eoi:
456         /* Return to the current process, which should be runnable.  If we're the
457          * kernel, we should just return naturally.  Note that current and tf need
458          * to still be okay (might not be after blocking) */
459         if (in_kernel(tf))
460                 return; /* TODO: think about this, might want a helper instead. */
461         proc_restartcore();
462         assert(0);
463 }
464
465 void
466 register_interrupt_handler(handler_t TP(TV(t)) table[],
467                            uint8_t int_num, poly_isr_t handler, TV(t) data)
468 {
469         table[int_num].isr = handler;
470         table[int_num].data = data;
471 }
472
473 void page_fault_handler(struct trapframe *tf)
474 {
475         uint32_t fault_va = rcr2();
476         int prot = tf->tf_err & PF_ERROR_WRITE ? PROT_WRITE : PROT_READ;
477         int err;
478
479         /* TODO - handle kernel page faults */
480         if ((tf->tf_cs & 3) == 0) {
481                 print_trapframe(tf);
482                 panic("Page Fault in the Kernel at 0x%08x!", fault_va);
483         }
484         if ((err = handle_page_fault(current, fault_va, prot))) {
485                 /* Destroy the faulting process */
486                 printk("[%08x] user %s fault va %08x ip %08x on core %d with err %d\n",
487                        current->pid, prot & PROT_READ ? "READ" : "WRITE", fault_va,
488                        tf->tf_eip, core_id(), err);
489                 print_trapframe(tf);
490                 proc_destroy(current);
491         }
492 }
493
494 void sysenter_init(void)
495 {
496         write_msr(MSR_IA32_SYSENTER_CS, GD_KT);
497         write_msr(MSR_IA32_SYSENTER_ESP, ts.ts_esp0);
498         write_msr(MSR_IA32_SYSENTER_EIP, (uint32_t) &sysenter_handler);
499 }
500
501 /* This is called from sysenter's asm, with the tf on the kernel stack. */
502 void sysenter_callwrapper(struct trapframe *tf)
503 {
504         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
505         /* Copy out the TF for now, set tf to point to it. */
506         if (!in_kernel(tf))
507                 set_current_tf(pcpui, tf);
508         /* Once we've set_current_tf, we can enable interrupts */
509         enable_irq();
510
511         if (in_kernel(tf))
512                 panic("sysenter from a kernel TF!!");
513         /* Set up and run the async calls */
514         prep_syscalls(current, (struct syscall*)tf->tf_regs.reg_eax,
515                       tf->tf_regs.reg_esi);
516         /* If you use pcpui again, reread it, since you might have migrated */
517         proc_restartcore();
518 }
519
520 struct kmem_cache *kernel_msg_cache;
521 void kernel_msg_init(void)
522 {
523         kernel_msg_cache = kmem_cache_create("kernel_msgs",
524                            sizeof(struct kernel_message), HW_CACHE_ALIGN, 0, 0, 0);
525 }
526
527 void kmsg_queue_stat(void)
528 {
529         struct kernel_message *kmsg;
530         bool immed_emp, routine_emp;
531         for (int i = 0; i < num_cpus; i++) {
532                 spin_lock_irqsave(&per_cpu_info[i].immed_amsg_lock);
533                 immed_emp = STAILQ_EMPTY(&per_cpu_info[i].immed_amsgs);
534                 spin_unlock_irqsave(&per_cpu_info[i].immed_amsg_lock);
535                 spin_lock_irqsave(&per_cpu_info[i].routine_amsg_lock);
536                 routine_emp = STAILQ_EMPTY(&per_cpu_info[i].routine_amsgs);
537                 spin_unlock_irqsave(&per_cpu_info[i].routine_amsg_lock);
538                 printk("Core %d's immed_emp: %d, routine_emp %d\n", i, immed_emp, routine_emp);
539                 if (!immed_emp) {
540                         kmsg = STAILQ_FIRST(&per_cpu_info[i].immed_amsgs);
541                         printk("Immed msg on core %d:\n", i);
542                         printk("\tsrc:  %d\n", kmsg->srcid);
543                         printk("\tdst:  %d\n", kmsg->dstid);
544                         printk("\tpc:   %08p\n", kmsg->pc);
545                         printk("\targ0: %08p\n", kmsg->arg0);
546                         printk("\targ1: %08p\n", kmsg->arg1);
547                         printk("\targ2: %08p\n", kmsg->arg2);
548                 }
549                 if (!routine_emp) {
550                         kmsg = STAILQ_FIRST(&per_cpu_info[i].routine_amsgs);
551                         printk("Routine msg on core %d:\n", i);
552                         printk("\tsrc:  %d\n", kmsg->srcid);
553                         printk("\tdst:  %d\n", kmsg->dstid);
554                         printk("\tpc:   %08p\n", kmsg->pc);
555                         printk("\targ0: %08p\n", kmsg->arg0);
556                         printk("\targ1: %08p\n", kmsg->arg1);
557                         printk("\targ2: %08p\n", kmsg->arg2);
558                 }
559                         
560         }
561 }
562
563 uint32_t send_kernel_message(uint32_t dst, amr_t pc, long arg0, long arg1,
564                              long arg2, int type)
565 {
566         kernel_message_t *k_msg;
567         assert(pc);
568         // note this will be freed on the destination core
569         k_msg = (kernel_message_t *CT(1))TC(kmem_cache_alloc(kernel_msg_cache, 0));
570         k_msg->srcid = core_id();
571         k_msg->dstid = dst;
572         k_msg->pc = pc;
573         k_msg->arg0 = arg0;
574         k_msg->arg1 = arg1;
575         k_msg->arg2 = arg2;
576         switch (type) {
577                 case KMSG_IMMEDIATE:
578                         spin_lock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
579                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].immed_amsgs, k_msg, link);
580                         spin_unlock_irqsave(&per_cpu_info[dst].immed_amsg_lock);
581                         break;
582                 case KMSG_ROUTINE:
583                         spin_lock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
584                         STAILQ_INSERT_TAIL(&per_cpu_info[dst].routine_amsgs, k_msg, link);
585                         spin_unlock_irqsave(&per_cpu_info[dst].routine_amsg_lock);
586                         break;
587                 default:
588                         panic("Unknown type of kernel message!");
589         }
590         /* since we touched memory the other core will touch (the lock), we don't
591          * need an wmb_f() */
592         /* if we're sending a routine message locally, we don't want/need an IPI */
593         if ((dst != k_msg->srcid) || (type == KMSG_IMMEDIATE))
594                 send_ipi(get_hw_coreid(dst), I_KERNEL_MSG);
595         return 0;
596 }
597
598 /* Helper function.  Returns 0 if the list was empty. */
599 static kernel_message_t *get_next_amsg(struct kernel_msg_list *list_head,
600                                        spinlock_t *list_lock)
601 {
602         kernel_message_t *k_msg;
603         spin_lock_irqsave(list_lock);
604         k_msg = STAILQ_FIRST(list_head);
605         if (k_msg)
606                 STAILQ_REMOVE_HEAD(list_head, link);
607         spin_unlock_irqsave(list_lock);
608         return k_msg;
609 }
610
611 /* Kernel message handler.  Extensive documentation is in
612  * Documentation/kernel_messages.txt.
613  *
614  * In general: this processes immediate messages, then routine messages.
615  * Routine messages might not return (__startcore, etc), so we need to be
616  * careful about a few things.
617  *
618  * Note that all of this happens from interrupt context, and interrupts are
619  * currently disabled for this gate.  Interrupts need to be disabled so that the
620  * self-ipi doesn't preempt the execution of this kernel message. */
621 void __kernel_message(struct trapframe *tf, void *data)
622 {
623         per_cpu_info_t *myinfo = &per_cpu_info[core_id()];
624         kernel_message_t msg_cp, *k_msg;
625
626         /* Important that we send the EOI first, so that the ipi_is_pending check
627          * doesn't see the irq we're servicing (which it would see if it was still
628          * 'inside' the IRQ handler (which to the APIC ends upon EOI)). */
629         lapic_send_eoi();
630         while (1) { // will break out when there are no more messages
631                 /* Try to get an immediate message.  Exec and free it. */
632                 k_msg = get_next_amsg(&myinfo->immed_amsgs, &myinfo->immed_amsg_lock);
633                 if (k_msg) {
634                         assert(k_msg->pc);
635                         k_msg->pc(tf, k_msg->srcid, k_msg->arg0, k_msg->arg1, k_msg->arg2);
636                         kmem_cache_free(kernel_msg_cache, (void*)k_msg);
637                 } else { // no immediate, might be a routine
638                         if (in_kernel(tf))
639                                 return; // don't execute routine msgs if we were in the kernel
640                         k_msg = get_next_amsg(&myinfo->routine_amsgs,
641                                               &myinfo->routine_amsg_lock);
642                         if (!k_msg) // no routines either
643                                 return;
644                         /* copy in, and then free, in case we don't return */
645                         msg_cp = *k_msg;
646                         kmem_cache_free(kernel_msg_cache, (void*)k_msg);
647                         /* make sure an IPI is pending if we have more work */
648                         /* technically, we don't need to lock when checking */
649                         if (!STAILQ_EMPTY(&myinfo->routine_amsgs) &&
650                                !ipi_is_pending(I_KERNEL_MSG))
651                                 send_self_ipi(I_KERNEL_MSG);
652                         /* Execute the kernel message */
653                         assert(msg_cp.pc);
654                         assert(msg_cp.dstid == core_id());
655                         /* TODO: when batching syscalls, this should be reread from cur_tf*/
656                         msg_cp.pc(tf, msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
657                 }
658         }
659 }
660
661 /* Runs any outstanding routine kernel messages from within the kernel.  Will
662  * make sure immediates still run first (or when they arrive, if processing a
663  * bunch of these messages).  This will disable interrupts, and restore them to
664  * whatever state you left them. */
665 void process_routine_kmsg(struct trapframe *tf)
666 {
667         per_cpu_info_t *myinfo = &per_cpu_info[core_id()];
668         kernel_message_t msg_cp, *k_msg;
669         int8_t irq_state = 0;
670
671         disable_irqsave(&irq_state);
672         /* If we were told what our TF was, use that.  o/w, go with current_tf. */
673         tf = tf ? tf : current_tf;
674         while (1) {
675                 /* normally, we want ints disabled, so we don't have an empty self-ipi
676                  * for every routine message. (imagine a long list of routines).  But we
677                  * do want immediates to run ahead of routines.  This enabling should
678                  * work (might not in some shitty VMs).  Also note we can receive an
679                  * extra self-ipi for routine messages before we turn off irqs again.
680                  * Not a big deal, since we will process it right away. 
681                  * TODO: consider calling __kernel_message() here. */
682                 if (!STAILQ_EMPTY(&myinfo->immed_amsgs)) {
683                         enable_irq();
684                         cpu_relax();
685                         disable_irq();
686                 }
687                 k_msg = get_next_amsg(&myinfo->routine_amsgs,
688                                       &myinfo->routine_amsg_lock);
689                 if (!k_msg) {
690                         enable_irqsave(&irq_state);
691                         return;
692                 }
693                 /* copy in, and then free, in case we don't return */
694                 msg_cp = *k_msg;
695                 kmem_cache_free(kernel_msg_cache, (void*)k_msg);
696                 /* make sure an IPI is pending if we have more work */
697                 if (!STAILQ_EMPTY(&myinfo->routine_amsgs) &&
698                        !ipi_is_pending(I_KERNEL_MSG))
699                         send_self_ipi(I_KERNEL_MSG);
700                 /* Execute the kernel message */
701                 assert(msg_cp.pc);
702                 assert(msg_cp.dstid == core_id());
703                 msg_cp.pc(tf, msg_cp.srcid, msg_cp.arg0, msg_cp.arg1, msg_cp.arg2);
704         }
705 }