x86: Use a separate stack and handler for NMIs
[akaros.git] / kern / arch / x86 / trap.c
1 #include <arch/mmu.h>
2 #include <arch/x86.h>
3 #include <arch/arch.h>
4 #include <arch/console.h>
5 #include <arch/apic.h>
6 #include <arch/perfmon.h>
7 #include <ros/common.h>
8 #include <smp.h>
9 #include <assert.h>
10 #include <pmap.h>
11 #include <trap.h>
12 #include <monitor.h>
13 #include <process.h>
14 #include <mm.h>
15 #include <stdio.h>
16 #include <slab.h>
17 #include <syscall.h>
18 #include <kdebug.h>
19 #include <kmalloc.h>
20 #include <ex_table.h>
21 #include <arch/mptables.h>
22 #include <ros/procinfo.h>
23
24 taskstate_t ts;
25
26 /* Interrupt descriptor table.  64 bit needs 16 byte alignment (i think). */
27 gatedesc_t __attribute__((aligned (16))) idt[256] = { { 0 } };
28 pseudodesc_t idt_pd;
29
30 /* interrupt handler table, each element is a linked list of handlers for a
31  * given IRQ.  Modification requires holding the lock (TODO: RCU) */
32 struct irq_handler *irq_handlers[NUM_IRQS];
33 spinlock_t irq_handler_wlock = SPINLOCK_INITIALIZER_IRQSAVE;
34
35 static bool try_handle_exception_fixup(struct hw_trapframe *hw_tf)
36 {
37         if (in_kernel(hw_tf)) {
38                 uintptr_t fixup_ip = get_fixup_ip(hw_tf->tf_rip);
39
40                 if (fixup_ip != 0) {
41                         hw_tf->tf_rip = fixup_ip;
42                         return true;
43                 }
44         }
45
46         return false;
47 }
48
49 const char *x86_trapname(int trapno)
50 {
51         static const char *const excnames[] = {
52                 "Divide error",
53                 "Debug",
54                 "Non-Maskable Interrupt",
55                 "Breakpoint",
56                 "Overflow",
57                 "BOUND Range Exceeded",
58                 "Invalid Opcode",
59                 "Device Not Available",
60                 "Double Fault",
61                 "Coprocessor Segment Overrun",
62                 "Invalid TSS",
63                 "Segment Not Present",
64                 "Stack Fault",
65                 "General Protection",
66                 "Page Fault",
67                 "(unknown trap)",
68                 "x87 FPU Floating-Point Error",
69                 "Alignment Check",
70                 "Machine-Check",
71                 "SIMD Floating-Point Exception"
72         };
73
74         if (trapno < sizeof(excnames)/sizeof(excnames[0]))
75                 return excnames[trapno];
76         if (trapno == T_SYSCALL)
77                 return "System call";
78         return "(unknown trap)";
79 }
80
81 /* Set stacktop for the current core to be the stack the kernel will start on
82  * when trapping/interrupting from userspace.  Don't use this til after
83  * smp_percpu_init().  We can probably get the TSS by reading the task register
84  * and then the GDT.  Still, it's a pain. */
85 void set_stack_top(uintptr_t stacktop)
86 {
87         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
88         /* No need to reload the task register, this takes effect immediately */
89         x86_set_stacktop_tss(pcpui->tss, stacktop);
90         /* Also need to make sure sysenters come in correctly */
91         x86_set_sysenter_stacktop(stacktop);
92 }
93
94 /* Note the check implies we only are on a one page stack (or the first page) */
95 uintptr_t get_stack_top(void)
96 {
97         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
98         uintptr_t stacktop;
99         /* so we can check this in interrupt handlers (before smp_boot()) */
100         /* TODO: These are dangerous - it assumes we're on a one-page stack.  If we
101          * change it to KSTKSIZE, then we assume stacks are KSTKSIZE-aligned */
102         if (!pcpui->tss)
103                 return ROUNDUP(read_sp(), PGSIZE);
104         stacktop = x86_get_stacktop_tss(pcpui->tss);
105         if (stacktop != ROUNDUP(read_sp(), PGSIZE))
106                 panic("Bad stacktop: %p esp one is %p\n", stacktop,
107                       ROUNDUP(read_sp(), PGSIZE));
108         return stacktop;
109 }
110
111 /* Sends a non-maskable interrupt; the handler will print a trapframe. */
112 void send_nmi(uint32_t os_coreid)
113 {
114         /* NMI / IPI for x86 are limited to 8 bits */
115         uint8_t hw_core = (uint8_t)get_hw_coreid(os_coreid);
116         __send_nmi(hw_core);
117 }
118
119 void idt_init(void)
120 {
121         /* This table is made in trapentry$BITS.S by each macro in that file.
122          * It is layed out such that the ith entry is the ith's traphandler's
123          * (uintptr_t) trap addr, then (uint32_t) trap number. */
124         struct trapinfo { uintptr_t trapaddr; uint32_t trapnumber; }
125                __attribute__((packed));
126         extern struct trapinfo trap_tbl[];
127         extern struct trapinfo trap_tbl_end[];
128         int i, trap_tbl_size = trap_tbl_end - trap_tbl;
129         extern void ISR_default(void);
130         extern void ISR_syscall(void);
131
132         /* set all to default, to catch everything */
133         for (i = 0; i < 256; i++)
134                 SETGATE(idt[i], 0, GD_KT, &ISR_default, 0);
135
136         /* set all entries that have real trap handlers
137          * we need to stop short of the last one, since the last is the default
138          * handler with a fake interrupt number (500) that is out of bounds of
139          * the idt[] */
140         for (i = 0; i < trap_tbl_size - 1; i++)
141                 SETGATE(idt[trap_tbl[i].trapnumber], 0, GD_KT, trap_tbl[i].trapaddr, 0);
142         /* Sanity check */
143         assert((uintptr_t)ISR_syscall ==
144                ((uintptr_t)idt[T_SYSCALL].gd_off_63_32 << 32 |
145                 (uintptr_t)idt[T_SYSCALL].gd_off_31_16 << 16 |
146                 (uintptr_t)idt[T_SYSCALL].gd_off_15_0));
147         /* turn on trap-based syscall handling and other user-accessible ints
148          * DPL 3 means this can be triggered by the int instruction */
149         idt[T_SYSCALL].gd_dpl = 3;
150         idt[T_BRKPT].gd_dpl = 3;
151         /* Send NMIs to their own stack (IST1 in every core's TSS) */
152         idt[T_NMI].gd_ist = 1;
153
154         /* Set up our kernel stack when changing rings */
155         /* Note: we want 16 byte aligned kernel stack frames (AMD 2:8.9.3) */
156         x86_set_stacktop_tss(&ts, (uintptr_t)bootstacktop);
157         x86_sysenter_init((uintptr_t)bootstacktop);
158
159 #ifdef CONFIG_KTHREAD_POISON
160         *kstack_bottom_addr((uintptr_t)bootstacktop) = 0xdeadbeef;
161 #endif /* CONFIG_KTHREAD_POISON */
162
163         /* Initialize the TSS field of the gdt.  The size of the TSS desc differs
164          * between 64 and 32 bit, hence the pointer acrobatics */
165         syssegdesc_t *ts_slot = (syssegdesc_t*)&gdt[GD_TSS >> 3];
166         *ts_slot = (syssegdesc_t)SEG_SYS_SMALL(STS_T32A, (uintptr_t)&ts,
167                                                sizeof(taskstate_t), 0);
168
169         /* Init the IDT PD.  Need to do this before ltr for some reason.  (Doing
170          * this between ltr and lidt causes the machine to reboot... */
171         idt_pd.pd_lim = sizeof(idt) - 1;
172         idt_pd.pd_base = (uintptr_t)idt;
173
174         ltr(GD_TSS);
175
176         asm volatile("lidt %0" : : "m"(idt_pd));
177
178         pic_remap();
179         pic_mask_all();
180
181         int ncleft = MAX_NUM_CORES;
182         int num_cores_mpacpi;
183
184         ncleft = mpsinit(ncleft);
185         ncleft = mpacpi(ncleft);
186         num_cores_mpacpi = MAX_NUM_CORES - ncleft;
187         printk("MP and ACPI found %d cores\n", num_cores_mpacpi);
188         if (num_cores != num_cores_mpacpi)
189                 warn("Topology (%d) and MP/ACPI (%d) differ on num_cores!", num_cores,
190                      num_cores_mpacpi);
191
192         apiconline();
193         ioapiconline();
194
195         /* the lapic IRQs need to be unmasked on a per-core basis */
196         register_irq(IdtLAPIC_TIMER, timer_interrupt, NULL,
197                      MKBUS(BusLAPIC, 0, 0, 0));
198         register_irq(IdtLAPIC_ERROR, handle_lapic_error, NULL,
199                      MKBUS(BusLAPIC, 0, 0, 0));
200         register_irq(IdtLAPIC_PCINT, perfmon_interrupt, NULL,
201                      MKBUS(BusLAPIC, 0, 0, 0));
202         register_irq(I_KERNEL_MSG, handle_kmsg_ipi, NULL, MKBUS(BusIPI, 0, 0, 0));
203 }
204
205 static void handle_fperr(struct hw_trapframe *hw_tf)
206 {
207         uint16_t fpcw, fpsw;
208         uint32_t mxcsr;
209         asm volatile ("fnstcw %0" : "=m"(fpcw));
210         asm volatile ("fnstsw %0" : "=m"(fpsw));
211         asm volatile ("stmxcsr %0" : "=m"(mxcsr));
212         print_trapframe(hw_tf);
213         printk("Core %d: FP ERR, CW: 0x%04x, SW: 0x%04x, MXCSR 0x%08x\n", core_id(),
214                fpcw, fpsw, mxcsr);
215         printk("Core %d: The following faults are unmasked:\n", core_id());
216         if (fpsw & ~fpcw & FP_EXCP_IE) {
217                 printk("\tInvalid Operation: ");
218                 if (fpsw & FP_SW_SF) {
219                         if (fpsw & FP_SW_C1)
220                                 printk("Stack overflow\n");
221                         else
222                                 printk("Stack underflow\n");
223                 } else {
224                         printk("invalid arithmetic operand\n");
225                 }
226         }
227         if (fpsw & ~fpcw & FP_EXCP_DE)
228                 printk("\tDenormalized operand\n");
229         if (fpsw & ~fpcw & FP_EXCP_ZE)
230                 printk("\tDivide by zero\n");
231         if (fpsw & ~fpcw & FP_EXCP_OE)
232                 printk("\tNumeric Overflow\n");
233         if (fpsw & ~fpcw & FP_EXCP_UE)
234                 printk("\tNumeric Underflow\n");
235         if (fpsw & ~fpcw & FP_EXCP_PE)
236                 printk("\tInexact result (precision)\n");
237         printk("Killing the process.\n");
238         proc_destroy(current);
239 }
240
241 static bool __handler_user_page_fault(struct hw_trapframe *hw_tf,
242                                       uintptr_t fault_va, int prot)
243 {
244         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
245         int err;
246
247         assert(pcpui->owning_proc == pcpui->cur_proc);
248         enable_irq();
249         err = handle_page_fault(pcpui->owning_proc, fault_va, prot);
250         disable_irq();
251         if (err) {
252                 if (err == -EAGAIN)
253                         hw_tf->tf_err |= PF_VMR_BACKED;
254                 return FALSE;
255         }
256         return TRUE;
257 }
258
259 static bool __handler_kernel_page_fault(struct hw_trapframe *hw_tf,
260                                         uintptr_t fault_va, int prot)
261 {
262         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
263         int err;
264
265         /* In general, if there's no cur_proc, a KPF is a bug. */
266         if (!pcpui->cur_proc) {
267                 /* This only runs from test_uaccess(), where it is expected to fail. */
268                 if (try_handle_exception_fixup(hw_tf))
269                         return TRUE;
270                 print_trapframe(hw_tf);
271                 backtrace_hwtf(hw_tf);
272                 panic("Proc-less Page Fault in the Kernel at %p!", fault_va);
273         }
274         /* TODO - handle kernel page faults.  This is dangerous, since we might be
275          * holding locks in the kernel and could deadlock when we HPF.  For now, I'm
276          * just disabling the lock checker, since it'll flip out when it sees there
277          * is a kernel trap.  Will need to think about this a bit, esp when we
278          * properly handle bad addrs and whatnot. */
279         pcpui->__lock_checking_enabled--;
280         /* It is a bug for the kernel to access user memory while holding locks that
281          * are used by handle_page_fault.  At a minimum, this includes p->vmr_lock
282          * and memory allocation locks.
283          *
284          * In an effort to reduce the number of locks (both now and in the future),
285          * the kernel will not attempt to handle faults on file-back VMRs.  We
286          * probably can turn that on in the future, but I'd rather keep things safe
287          * for now.  (We'll probably need to change this when we stop
288          * MAP_POPULATE | MAP_LOCKED entire binaries).
289          *
290          * Note that we do not enable IRQs here, unlike in the user case.  Again,
291          * this is to limit the locks we could be grabbing. */
292         err = handle_page_fault_nofile(pcpui->cur_proc, fault_va, prot);
293         pcpui->__lock_checking_enabled++;
294         if (err) {
295                 if (try_handle_exception_fixup(hw_tf))
296                         return TRUE;
297                 print_trapframe(hw_tf);
298                 backtrace_hwtf(hw_tf);
299                 /* Turn this on to help debug bad function pointers */
300                 printd("rsp %p\n\t 0(rsp): %p\n\t 8(rsp): %p\n\t 16(rsp): %p\n"
301                        "\t24(rsp): %p\n", hw_tf->tf_rsp,
302                        *(uintptr_t*)(hw_tf->tf_rsp +  0),
303                        *(uintptr_t*)(hw_tf->tf_rsp +  8),
304                        *(uintptr_t*)(hw_tf->tf_rsp + 16),
305                        *(uintptr_t*)(hw_tf->tf_rsp + 24));
306                 panic("Proc-ful Page Fault in the Kernel at %p!", fault_va);
307                 /* if we want to do something like kill a process or other code, be
308                  * aware we are in a sort of irq-like context, meaning the main
309                  * kernel code we 'interrupted' could be holding locks - even
310                  * irqsave locks. */
311         }
312         return TRUE;
313 }
314
315 static bool __handle_page_fault(struct hw_trapframe *hw_tf, unsigned long *aux)
316 {
317         uintptr_t fault_va = rcr2();
318         int prot = hw_tf->tf_err & PF_ERROR_WRITE ? PROT_WRITE : PROT_READ;
319
320         *aux = fault_va;
321         if (in_kernel(hw_tf))
322                 return __handler_kernel_page_fault(hw_tf, fault_va, prot);
323         else
324                 return __handler_user_page_fault(hw_tf, fault_va, prot);
325 }
326
327 /* Separate handler from traps, since there's too many rules for NMI ctx.
328  *
329  * The general rule is that any writes from NMI context must be very careful.
330  * When talking about reads and writes to per-core data:
331  * - If NMIs write things written by normal kernel contexts, including IRQs and
332  *   traps with IRQs disabled, then you must use atomics on both sides.
333  * - If NMIs write things read by normal contexts, then readers must be careful,
334  *   since the data can change at will.
335  * - If NMIs read things written by normal contexts, don't worry: you're running
336  *   uninterrupted (given x86 NMI caveats).
337  * - We cannot block.  The current kthread thinks its stacktop is different than
338  *   the one we're on.  Just get in and get out.
339  * - If we interrupted a user TF, then we don't need to worry any more than for
340  *   normal traps/IRQs.
341  * - However, we cannot call proc_restartcore.  That could trigger all sorts of
342  *   things, like kthreads blocking.
343  * - Parallel accesses (from other cores) are the same as always.  You just
344  *   can't lock easily. */
345 void handle_nmi(struct hw_trapframe *hw_tf)
346 {
347         struct per_cpu_info *pcpui;
348
349         /* TODO: this is all racy and needs to go */
350
351         /* Temporarily disable deadlock detection when we print.  We could
352          * deadlock if we were printing when we NMIed. */
353         pcpui = &per_cpu_info[core_id()];
354         pcpui->__lock_checking_enabled--;
355         /* This is a bit hacky, but we don't have a decent API yet */
356         extern bool mon_verbose_trace;
357         if (mon_verbose_trace) {
358                 print_trapframe(hw_tf);
359                 backtrace_hwtf(hw_tf);
360         }
361         char *fn_name = get_fn_name(get_hwtf_pc(hw_tf));
362
363         printk("Core %d is at %p (%s)\n", core_id(), get_hwtf_pc(hw_tf),
364                    fn_name);
365         kfree(fn_name);
366         print_kmsgs(core_id());
367         pcpui->__lock_checking_enabled++;
368 }
369
370 /* Certain traps want IRQs enabled, such as the syscall.  Others can't handle
371  * it, like the page fault handler.  Turn them on on a case-by-case basis. */
372 static void trap_dispatch(struct hw_trapframe *hw_tf)
373 {
374         struct per_cpu_info *pcpui;
375         bool handled = TRUE;
376         unsigned long aux = 0;
377         uintptr_t fixup_ip;
378
379         // Handle processor exceptions.
380         switch(hw_tf->tf_trapno) {
381                 case T_BRKPT:
382                         enable_irq();
383                         monitor(hw_tf);
384                         disable_irq();
385                         break;
386                 case T_ILLOP:
387                 {
388                         /* TODO: this can PF if there is a concurrent unmap/PM removal. */
389                         uintptr_t ip = get_hwtf_pc(hw_tf);
390                         pcpui = &per_cpu_info[core_id()];
391                         pcpui->__lock_checking_enabled--;               /* for print debugging */
392                         /* We will muck with the actual TF.  If we're dealing with
393                          * userspace, we need to make sure we edit the actual TF that will
394                          * get restarted (pcpui), and not the TF on the kstack (which aren't
395                          * the same).  See set_current_ctx() for more info. */
396                         if (!in_kernel(hw_tf))
397                                 hw_tf = &pcpui->cur_ctx->tf.hw_tf;
398                         printd("bad opcode, eip: %p, next 3 bytes: %x %x %x\n", ip,
399                                *(uint8_t*)(ip + 0),
400                                *(uint8_t*)(ip + 1),
401                                *(uint8_t*)(ip + 2));
402                         /* rdtscp: 0f 01 f9 */
403                         if (*(uint8_t*)(ip + 0) == 0x0f,
404                             *(uint8_t*)(ip + 1) == 0x01,
405                             *(uint8_t*)(ip + 2) == 0xf9) {
406                                 x86_fake_rdtscp(hw_tf);
407                                 pcpui->__lock_checking_enabled++;       /* for print debugging */
408                                 return;
409                         }
410                         enable_irq();
411                         monitor(hw_tf);
412                         disable_irq();
413                         pcpui->__lock_checking_enabled++;               /* for print debugging */
414                         break;
415                 }
416                 case T_PGFLT:
417                         handled = __handle_page_fault(hw_tf, &aux);
418                         break;
419                 case T_FPERR:
420                         handled = try_handle_exception_fixup(hw_tf);
421                         if (!handled)
422                                 handle_fperr(hw_tf);
423                         break;
424                 case T_SYSCALL:
425                         enable_irq();
426                         // check for userspace, for now
427                         assert(hw_tf->tf_cs != GD_KT);
428                         /* Set up and run the async calls */
429                         /* TODO: this is using the wrong reg1 for traps for 32 bit */
430                         prep_syscalls(current,
431                                       (struct syscall*)x86_get_systrap_arg0(hw_tf),
432                                                   (unsigned int)x86_get_systrap_arg1(hw_tf));
433                         disable_irq();
434                         break;
435                 default:
436                         if (hw_tf->tf_cs == GD_KT) {
437                                 handled = try_handle_exception_fixup(hw_tf);
438                                 if (!handled) {
439                                         print_trapframe(hw_tf);
440                                         panic("Damn Damn!  Unhandled trap in the kernel!");
441                                 }
442                         } else {
443                                 handled = FALSE;
444                         }
445         }
446
447         if (!handled)
448                 reflect_unhandled_trap(hw_tf->tf_trapno, hw_tf->tf_err, aux);
449 }
450
451 /* Helper.  For now, this copies out the TF to pcpui.  Eventually, we should
452  * consider doing this in trapentry.S
453  *
454  * TODO: consider having this return the tf used, so we can set tf in trap and
455  * irq handlers to edit the TF that will get restarted.  Right now, the kernel
456  * uses and restarts tf, but userspace restarts the old pcpui tf.  It is
457  * tempting to do this, but note that tf stays on the stack of the kthread,
458  * while pcpui->cur_ctx is for the core we trapped in on.  Meaning if we ever
459  * block, suddenly cur_ctx is pointing to some old clobbered state that was
460  * already returned to and can't be trusted.  Meanwhile tf can always be trusted
461  * (like with an in_kernel() check).  The only types of traps from the user that
462  * can be expected to have editable trapframes are ones that don't block. */
463 static void set_current_ctx_hw(struct per_cpu_info *pcpui,
464                                struct hw_trapframe *hw_tf)
465 {
466         assert(!irq_is_enabled());
467         pcpui->actual_ctx.type = ROS_HW_CTX;
468         pcpui->actual_ctx.tf.hw_tf = *hw_tf;
469         pcpui->cur_ctx = &pcpui->actual_ctx;
470 }
471
472 static void set_current_ctx_sw(struct per_cpu_info *pcpui,
473                                struct sw_trapframe *sw_tf)
474 {
475         assert(!irq_is_enabled());
476         pcpui->actual_ctx.type = ROS_SW_CTX;
477         pcpui->actual_ctx.tf.sw_tf = *sw_tf;
478         pcpui->cur_ctx = &pcpui->actual_ctx;
479 }
480
481 static void set_current_ctx_vm(struct per_cpu_info *pcpui,
482                                struct vm_trapframe *vm_tf)
483 {
484         assert(!irq_is_enabled());
485         pcpui->actual_ctx.type = ROS_VM_CTX;
486         pcpui->actual_ctx.tf.vm_tf = *vm_tf;
487         pcpui->cur_ctx = &pcpui->actual_ctx;
488 }
489
490 void trap(struct hw_trapframe *hw_tf)
491 {
492         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
493         /* Copy out the TF for now */
494         if (!in_kernel(hw_tf)) {
495                 set_current_ctx_hw(pcpui, hw_tf);
496                 /* ignoring state for nested kernel traps.  should be rare. */
497                 __set_cpu_state(pcpui, CPU_STATE_KERNEL);
498         } else {
499                 inc_ktrap_depth(pcpui);
500         }
501         printd("Incoming TRAP %d on core %d, TF at %p\n", hw_tf->tf_trapno,
502                core_id(), hw_tf);
503         if ((hw_tf->tf_cs & ~3) != GD_UT && (hw_tf->tf_cs & ~3) != GD_KT) {
504                 print_trapframe(hw_tf);
505                 panic("Trapframe with invalid CS!");
506         }
507         trap_dispatch(hw_tf);
508         /* Return to the current process, which should be runnable.  If we're the
509          * kernel, we should just return naturally.  Note that current and tf need
510          * to still be okay (might not be after blocking) */
511         if (in_kernel(hw_tf)) {
512                 dec_ktrap_depth(pcpui);
513                 return;
514         }
515         proc_restartcore();
516         assert(0);
517 }
518
519 static bool vector_is_irq(int apic_vec)
520 {
521         /* arguably, we could limit them to MaxIdtIOAPIC */
522         return (IdtPIC <= apic_vec) && (apic_vec <= IdtMAX);
523 }
524
525 static void irq_dispatch(struct hw_trapframe *hw_tf)
526 {
527         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
528         struct irq_handler *irq_h;
529
530         if (!in_irq_ctx(pcpui))
531                 __set_cpu_state(pcpui, CPU_STATE_IRQ);
532         inc_irq_depth(pcpui);
533         //if (core_id())
534         if (hw_tf->tf_trapno != IdtLAPIC_TIMER) /* timer irq */
535         if (hw_tf->tf_trapno != I_KERNEL_MSG)
536         if (hw_tf->tf_trapno != 65)     /* qemu serial tends to get this one */
537                 printd("Incoming IRQ, ISR: %d on core %d\n", hw_tf->tf_trapno,
538                        core_id());
539         /* TODO: RCU read lock */
540         irq_h = irq_handlers[hw_tf->tf_trapno];
541         if (!irq_h) {
542                 warn_once("Received IRQ %d, had no handler registered!",
543                           hw_tf->tf_trapno);
544                 /* If we don't have an IRQ handler, we don't know how to EOI.  Odds are,
545                  * it's a LAPIC IRQ, such as I_TESTING */
546                 if (!lapic_check_spurious(hw_tf->tf_trapno))
547                         lapic_send_eoi(hw_tf->tf_trapno);
548                 goto out_no_eoi;
549         }
550         if (irq_h->check_spurious(hw_tf->tf_trapno))
551                 goto out_no_eoi;
552         /* Can now be interrupted/nested by higher priority IRQs, but not by our
553          * current IRQ vector, til we EOI. */
554         enable_irq();
555         while (irq_h) {
556                 irq_h->isr(hw_tf, irq_h->data);
557                 irq_h = irq_h->next;
558         }
559         // if we're a general purpose IPI function call, down the cpu_list
560         extern handler_wrapper_t handler_wrappers[NUM_HANDLER_WRAPPERS];
561         if ((I_SMP_CALL0 <= hw_tf->tf_trapno) &&
562             (hw_tf->tf_trapno <= I_SMP_CALL_LAST))
563                 down_checklist(handler_wrappers[hw_tf->tf_trapno & 0x0f].cpu_list);
564         disable_irq();
565         /* Keep in sync with ipi_is_pending */
566         irq_handlers[hw_tf->tf_trapno]->eoi(hw_tf->tf_trapno);
567         /* Fall-through */
568 out_no_eoi:
569         dec_irq_depth(pcpui);
570         if (!in_irq_ctx(pcpui))
571                 __set_cpu_state(pcpui, CPU_STATE_KERNEL);
572 }
573
574 /* Note IRQs are disabled unless explicitly turned on.
575  *
576  * In general, we should only get trapno's >= PIC1_OFFSET (32).  Anything else
577  * should be a trap.  Even if we don't use the PIC, that should be the standard.
578  * It is possible to get a spurious LAPIC IRQ with vector 15 (or similar), but
579  * the spurious check should catch that.
580  *
581  * Note that from hardware's perspective (PIC, etc), IRQs start from 0, but they
582  * are all mapped up at PIC1_OFFSET for the cpu / irq_handler. */
583 void handle_irq(struct hw_trapframe *hw_tf)
584 {
585         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
586
587         /* Copy out the TF for now */
588         if (!in_kernel(hw_tf))
589                 set_current_ctx_hw(pcpui, hw_tf);
590         irq_dispatch(hw_tf);
591         /* Return to the current process, which should be runnable.  If we're the
592          * kernel, we should just return naturally.  Note that current and tf need
593          * to still be okay (might not be after blocking) */
594         if (in_kernel(hw_tf))
595                 return;
596         proc_restartcore();
597         assert(0);
598 }
599
600 /* The irq field may be ignored based on the type of Bus. */
601 int register_irq(int irq, isr_t handler, void *irq_arg, uint32_t tbdf)
602 {
603         struct irq_handler *irq_h;
604         int vector;
605         irq_h = kzmalloc(sizeof(struct irq_handler), 0);
606         assert(irq_h);
607         irq_h->dev_irq = irq;
608         irq_h->tbdf = tbdf;
609         vector = bus_irq_setup(irq_h);
610         if (vector == -1) {
611                 kfree(irq_h);
612                 return -1;
613         }
614         printk("IRQ %d, vector %d (0x%x), type %s\n", irq, vector, vector,
615                irq_h->type);
616         assert(irq_h->check_spurious && irq_h->eoi);
617         irq_h->isr = handler;
618         irq_h->data = irq_arg;
619         irq_h->apic_vector = vector;
620         /* RCU write lock */
621         spin_lock_irqsave(&irq_handler_wlock);
622         irq_h->next = irq_handlers[vector];
623         wmb();  /* make sure irq_h is done before publishing to readers */
624         irq_handlers[vector] = irq_h;
625         spin_unlock_irqsave(&irq_handler_wlock);
626         /* Most IRQs other than the BusIPI should need their irq unmasked.
627          * Might need to pass the irq_h, in case unmask needs more info.
628          * The lapic IRQs need to be unmasked on a per-core basis */
629         if (irq_h->unmask && strcmp(irq_h->type, "lapic"))
630                 irq_h->unmask(irq_h, vector);
631         return 0;
632 }
633
634 /* These routing functions only allow the routing of an irq to a single core.
635  * If we want to route to multiple cores, we'll probably need to set up logical
636  * groups or something and take some additional parameters. */
637 static int route_irq_h(struct irq_handler *irq_h, int os_coreid)
638 {
639         int hw_coreid;
640         if (!irq_h->route_irq) {
641                 printk("[kernel] apic_vec %d, type %s cannot be routed\n",
642                        irq_h->apic_vector, irq_h->type);
643                 return -1;
644         }
645         if (os_coreid >= MAX_NUM_CORES) {
646                 printk("[kernel] os_coreid %d out of range!\n", os_coreid);
647                 return -1;
648         }
649         hw_coreid = get_hw_coreid(os_coreid);
650         if (hw_coreid == -1) {
651                 printk("[kernel] os_coreid %d not a valid hw core!\n", os_coreid);
652                 return -1;
653         }
654         irq_h->route_irq(irq_h, irq_h->apic_vector, hw_coreid);
655         return 0;
656 }
657
658 /* Routes all irqs for a given apic_vector to os_coreid.  Returns 0 if all of
659  * them succeeded.  -1 if there were none or if any of them failed.  We don't
660  * share IRQs often (if ever anymore), so this shouldn't be an issue. */
661 int route_irqs(int apic_vec, int os_coreid)
662 {
663         struct irq_handler *irq_h;
664         int ret = -1;
665         if (!vector_is_irq(apic_vec)) {
666                 printk("[kernel] vector %d is not an IRQ vector!\n", apic_vec);
667                 return -1;
668         }
669         irq_h = irq_handlers[apic_vec];
670         while (irq_h) {
671                 assert(irq_h->apic_vector == apic_vec);
672                 ret = route_irq_h(irq_h, os_coreid);
673                 irq_h = irq_h->next;
674         }
675         return ret;
676 }
677
678 /* It's a moderate pain in the ass to put these in bit-specific files (header
679  * hell with the set_current_ helpers) */
680 void sysenter_callwrapper(struct syscall *sysc, unsigned long count,
681                           struct sw_trapframe *sw_tf)
682 {
683         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
684         set_current_ctx_sw(pcpui, sw_tf);
685         __set_cpu_state(pcpui, CPU_STATE_KERNEL);
686         /* Once we've set_current_ctx, we can enable interrupts.  This used to be
687          * mandatory (we had immediate KMSGs that would muck with cur_ctx).  Now it
688          * should only help for sanity/debugging. */
689         enable_irq();
690         /* Set up and run the async calls.  This may block, and we could migrate to
691          * another core.  If you use pcpui again, you need to reread it. */
692         prep_syscalls(current, sysc, count);
693         disable_irq();
694         proc_restartcore();
695 }
696
697 /* Declared in x86/arch.h */
698 void send_ipi(uint32_t os_coreid, uint8_t vector)
699 {
700         int hw_coreid = get_hw_coreid(os_coreid);
701         if (hw_coreid == -1) {
702                 panic("Unmapped OS coreid (OS %d)!\n", os_coreid);
703                 return;
704         }
705         __send_ipi(hw_coreid, vector);
706 }
707
708 /****************** VM exit handling ******************/
709
710 static bool handle_vmexit_cpuid(struct vm_trapframe *tf)
711 {
712         uint32_t eax, ebx, ecx, edx;
713
714         /* 0x4000000 is taken from Linux; it is not documented but it signals the
715          * use of KVM. */
716         if (tf->tf_rax == 0x40000000) {
717                 /* Pretend to be KVM: Return the KVM signature by placing the following
718                  * constants in RAX, RBX, RCX and RDX. RAX is set to 0, while RBX to
719                  * RDX forms the string "KVMKVMKVMKVM\0\0\0". This can be placed in
720                  * 0x100 offsets from 0x40000000 to 0x40010000. */
721                 eax = 0;
722                 ebx = 0x4b4d564b;
723                 ecx = 0x564b4d56;
724                 edx = 0x0000004d;
725         } else {
726                 cpuid(tf->tf_rax, tf->tf_rcx, &eax, &ebx, &ecx, &edx);
727                 if (tf->tf_rax == 1) {
728                         /* Set the hypervisor bit to let the guest know it is virtualized */
729                         ecx |= 1 << 31;
730                 }
731         }
732         tf->tf_rax = eax;
733         tf->tf_rbx = ebx;
734         tf->tf_rcx = ecx;
735         tf->tf_rdx = edx;
736         tf->tf_rip += 2;
737         return TRUE;
738 }
739
740 static bool handle_vmexit_ept_fault(struct vm_trapframe *tf)
741 {
742         int prot = 0;
743         int ret;
744
745         prot |= tf->tf_exit_qual & VMX_EPT_FAULT_READ ? PROT_READ : 0;
746         prot |= tf->tf_exit_qual & VMX_EPT_FAULT_WRITE ? PROT_WRITE : 0;
747         prot |= tf->tf_exit_qual & VMX_EPT_FAULT_INS ? PROT_EXEC : 0;
748         ret = handle_page_fault(current, tf->tf_guest_pa, prot);
749         if (ret) {
750                 /* TODO: maybe put ret in the TF somewhere */
751                 return FALSE;
752         }
753         return TRUE;
754 }
755
756 static bool handle_vmexit_nmi(struct vm_trapframe *tf)
757 {
758         /* Sanity checks, make sure we really got an NMI.  Feel free to remove. */
759         assert((tf->tf_intrinfo2 & INTR_INFO_INTR_TYPE_MASK) == INTR_TYPE_NMI_INTR);
760         assert((tf->tf_intrinfo2 & INTR_INFO_VECTOR_MASK) == T_NMI);
761         /* our NMI handler from trap.c won't run.  but we don't need the lock
762          * disabling stuff. */
763         extern bool mon_verbose_trace;
764
765         if (mon_verbose_trace) {
766                 print_vmtrapframe(tf);
767                 /* TODO: a backtrace of the guest would be nice here. */
768         }
769         printk("Core %d is at %p\n", core_id(), get_vmtf_pc(tf));
770         return TRUE;
771 }
772
773 bool handle_vmexit_msr(struct vm_trapframe *tf)
774 {
775         bool ret;
776
777         ret = vmm_emulate_msr(&tf->tf_rcx, &tf->tf_rdx, &tf->tf_rax,
778                               (tf->tf_exit_reason == EXIT_REASON_MSR_READ
779                                                    ? VMM_MSR_EMU_READ : VMM_MSR_EMU_WRITE));
780         if (ret)
781                 tf->tf_rip += 2;
782         return ret;
783 }
784
785 bool handle_vmexit_extirq(struct vm_trapframe *tf)
786 {
787         struct hw_trapframe hw_tf;
788
789         /* For now, we just handle external IRQs.  I think guest traps should go to
790          * the guest, based on our vmctls */
791         assert((tf->tf_intrinfo2 & INTR_INFO_INTR_TYPE_MASK) == INTR_TYPE_EXT_INTR);
792         /* TODO: Our IRQ handlers all expect TFs.  Let's fake one.  A bunch of
793          * handlers (e.g. backtrace/perf) will probably be unhappy about a user TF
794          * that is really a VM, so this all needs work. */
795         hw_tf.tf_gsbase = 0;
796         hw_tf.tf_fsbase = 0;
797         hw_tf.tf_rax = tf->tf_rax;
798         hw_tf.tf_rbx = tf->tf_rbx;
799         hw_tf.tf_rcx = tf->tf_rcx;
800         hw_tf.tf_rdx = tf->tf_rdx;
801         hw_tf.tf_rbp = tf->tf_rbp;
802         hw_tf.tf_rsi = tf->tf_rsi;
803         hw_tf.tf_rdi = tf->tf_rdi;
804         hw_tf.tf_r8 = tf->tf_r8;
805         hw_tf.tf_r9 = tf->tf_r9;
806         hw_tf.tf_r10 = tf->tf_r10;
807         hw_tf.tf_r11 = tf->tf_r11;
808         hw_tf.tf_r12 = tf->tf_r12;
809         hw_tf.tf_r13 = tf->tf_r13;
810         hw_tf.tf_r14 = tf->tf_r14;
811         hw_tf.tf_r15 = tf->tf_r15;
812         hw_tf.tf_trapno = tf->tf_intrinfo2 & INTR_INFO_VECTOR_MASK;
813         hw_tf.tf_err = 0;
814         hw_tf.tf_rip = tf->tf_rip;
815         hw_tf.tf_cs = GD_UT;    /* faking a user TF, even though it's a VM */
816         hw_tf.tf_rflags = tf->tf_rflags;
817         hw_tf.tf_rsp = tf->tf_rsp;
818         hw_tf.tf_ss = GD_UD;
819
820         irq_dispatch(&hw_tf);
821         /* Consider returning whether or not there was a handler registered */
822         return TRUE;
823 }
824
825 static bool handle_vmexit_xsetbv(struct vm_trapframe *tf)
826 {
827         // The VM's requested-feature bitmap is represented by edx:eax
828         uint64_t vm_rfbm = (tf->tf_rdx << 32) | tf->tf_rax;
829
830         // If the VM tries to set xcr0 to a superset
831         // of Akaros's default value, kill the VM.
832
833         // Bit in vm_rfbm and x86_default_xcr0:        Ok. Requested and allowed.
834         // Bit in vm_rfbm but not x86_default_xcr0:    Bad! Requested, not allowed.
835         // Bit not in vm_rfbm but in x86_default_xcr0: Ok. Not requested.
836
837         // vm_rfbm & (~x86_default_xcr0) is nonzero if any bits
838         // are set in vm_rfbm but not x86_default_xcr0
839
840         if (vm_rfbm & (~__proc_global_info.x86_default_xcr0))
841                 return FALSE;
842
843
844         // If attempting to use vm_rfbm for xsetbv
845         // causes a fault, we reflect to the VMM.
846         if (safe_lxcr0(vm_rfbm))
847                 return FALSE;
848
849
850         // If no fault, advance the instruction pointer
851         // and return TRUE to make the VM resume.
852         tf->tf_rip += 3; // XSETBV is a 3-byte instruction
853         return TRUE;
854 }
855
856 static void vmexit_dispatch(struct vm_trapframe *tf)
857 {
858         bool handled = FALSE;
859
860         /* Do not block in any of these functions.
861          *
862          * If we block, we'll probably need to finalize the context.  If we do, then
863          * there's a chance the guest pcore can start somewhere else, and then we
864          * can't get the GPC loaded again.  Plus, they could be running a GPC with
865          * an unresolved vmexit.  It's just mess.
866          *
867          * If we want to enable IRQs, we can do so on a case-by-case basis.  Don't
868          * do it for external IRQs - the irq_dispatch code will handle it. */
869         switch (tf->tf_exit_reason) {
870         case EXIT_REASON_VMCALL:
871                 if (current->vmm.flags & VMM_VMCALL_PRINTF) {
872                         printk("%c", tf->tf_rdi);
873                         tf->tf_rip += 3;
874                         handled = TRUE;
875                 }
876                 break;
877         case EXIT_REASON_CPUID:
878                 handled = handle_vmexit_cpuid(tf);
879                 break;
880         case EXIT_REASON_EPT_VIOLATION:
881                 handled = handle_vmexit_ept_fault(tf);
882                 break;
883         case EXIT_REASON_EXCEPTION_NMI:
884                 handled = handle_vmexit_nmi(tf);
885                 break;
886         case EXIT_REASON_MSR_READ:
887         case EXIT_REASON_MSR_WRITE:
888                 handled = handle_vmexit_msr(tf);
889                 break;
890         case EXIT_REASON_EXTERNAL_INTERRUPT:
891                 handled = handle_vmexit_extirq(tf);
892                 break;
893         case EXIT_REASON_XSETBV:
894                 handled = handle_vmexit_xsetbv(tf);
895                 break;
896         default:
897                 printd("Unhandled vmexit: reason 0x%x, exit qualification 0x%x\n",
898                        tf->tf_exit_reason, tf->tf_exit_qual);
899         }
900         if (!handled) {
901                 tf->tf_flags |= VMCTX_FL_HAS_FAULT;
902                 if (reflect_current_context()) {
903                         /* VM contexts shouldn't be in vcore context, so this should be
904                          * pretty rare (unlike SCPs or VC ctx page faults). */
905                         printk("[kernel] Unable to reflect VM Exit\n");
906                         print_vmtrapframe(tf);
907                         proc_destroy(current);
908                 }
909         }
910 }
911
912 void handle_vmexit(struct vm_trapframe *tf)
913 {
914         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
915
916         tf->tf_rip = vmcs_read(GUEST_RIP);
917         tf->tf_rflags = vmcs_read(GUEST_RFLAGS);
918         tf->tf_rsp = vmcs_read(GUEST_RSP);
919         tf->tf_cr2 = rcr2();
920         tf->tf_cr3 = vmcs_read(GUEST_CR3);
921         tf->tf_guest_pcoreid = pcpui->guest_pcoreid;
922         tf->tf_flags |= VMCTX_FL_PARTIAL;
923         tf->tf_guest_intr_status = vmcs_read(GUEST_INTR_STATUS);
924         tf->tf_exit_reason = vmcs_read(VM_EXIT_REASON);
925         tf->tf_exit_qual = vmcs_read(EXIT_QUALIFICATION);
926         tf->tf_intrinfo1 = vmcs_read(GUEST_INTERRUPTIBILITY_INFO);
927         tf->tf_intrinfo2 = vmcs_read(VM_EXIT_INTR_INFO);
928         tf->tf_guest_va = vmcs_read(GUEST_LINEAR_ADDRESS);
929         tf->tf_guest_pa = vmcs_read(GUEST_PHYSICAL_ADDRESS);
930
931         set_current_ctx_vm(pcpui, tf);
932         tf = &pcpui->cur_ctx->tf.vm_tf;
933         vmexit_dispatch(tf);
934         /* We're either restarting a partial VM ctx (vmcs was launched, loaded on
935          * the core, etc) or a SW vc ctx for the reflected trap.  Or the proc is
936          * dying and we'll handle a __death KMSG shortly. */
937         proc_restartcore();
938 }
939
940 void x86_finalize_vmtf(struct vm_trapframe *tf)
941 {
942         struct per_cpu_info *pcpui = &per_cpu_info[core_id()];
943
944         x86_vmtf_clear_partial(tf);
945         unload_guest_pcore(pcpui->cur_proc, pcpui->guest_pcoreid);
946 }