2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #include <palacios/vmx_handler.h>
21 #include <palacios/vmm_types.h>
22 #include <palacios/vmm.h>
23 #include <palacios/vmcs.h>
24 #include <palacios/vmx_lowlevel.h>
25 #include <palacios/vmx_io.h>
26 #include <palacios/vmm_cpuid.h>
27 #include <palacios/vmm_debug.h>
29 #include <palacios/vmx.h>
30 #include <palacios/vmm_ctrl_regs.h>
31 #include <palacios/vmm_lowlevel.h>
32 #include <palacios/vmx_ctrl_regs.h>
33 #include <palacios/vmx_assist.h>
34 #include <palacios/vmm_halt.h>
35 #include <palacios/vmm_mwait.h>
36 #include <palacios/vmx_ept.h>
39 #ifndef V3_CONFIG_DEBUG_VMX
41 #define PrintDebug(fmt, args...)
44 #ifdef V3_CONFIG_TELEMETRY
45 #include <palacios/vmm_telemetry.h>
48 /* At this point the GPRs are already copied into the guest_info state */
49 int v3_handle_vmx_exit(struct guest_info * info, struct vmx_exit_info * exit_info) {
50 struct vmx_basic_exit_info * basic_info = (struct vmx_basic_exit_info *)&(exit_info->exit_reason);
53 PrintError("Handling VMX_EXIT: %s (%u), %lu (0x%lx)\n",
54 v3_vmx_exit_code_to_str(exit_info->exit_reason),
55 exit_info->exit_reason,
56 exit_info->exit_qual, exit_info->exit_qual);
62 if (basic_info->entry_error == 1) {
63 switch (basic_info->reason) {
64 case VMX_EXIT_INVALID_GUEST_STATE:
65 PrintError("VM Entry failed due to invalid guest state\n");
66 PrintError("Printing VMCS: (NOTE: This VMCS may not belong to the correct guest)\n");
69 case VMX_EXIT_INVALID_MSR_LOAD:
70 PrintError("VM Entry failed due to error loading MSRs\n");
73 PrintError("Entry failed for unknown reason (%d)\n", basic_info->reason);
82 #ifdef V3_CONFIG_TELEMETRY
83 if (info->vm_info->enable_telemetry) {
84 v3_telemetry_start_exit(info);
88 switch (basic_info->reason) {
89 case VMX_EXIT_INFO_EXCEPTION_OR_NMI: {
90 pf_error_t error_code = *(pf_error_t *)&(exit_info->int_err);
93 // JRL: Change "0x0e" to a macro value
94 if ((uint8_t)exit_info->int_info == 14) {
95 #ifdef V3_CONFIG_DEBUG_SHADOW_PAGING
96 PrintDebug("Page Fault at %p error_code=%x\n", (void *)exit_info->exit_qual, *(uint32_t *)&error_code);
99 if (info->shdw_pg_mode == SHADOW_PAGING) {
100 if (v3_handle_shadow_pagefault(info, (addr_t)exit_info->exit_qual, error_code) == -1) {
101 PrintError("Error handling shadow page fault\n");
106 PrintError("Page fault in unimplemented paging mode\n");
109 } else if ((uint8_t)exit_info->int_info == 2) {
110 // NMI. Don't do anything
111 V3_Print("NMI Exception Received\n");
113 PrintError("Unknown exception: 0x%x\n", (uint8_t)exit_info->int_info);
120 case VMX_EXIT_EPT_VIOLATION: {
121 struct ept_exit_qual * ept_qual = (struct ept_exit_qual *)&(exit_info->exit_qual);
123 if (v3_handle_ept_fault(info, exit_info->ept_fault_addr, ept_qual) == -1) {
124 PrintError("Error handling EPT fault\n");
130 case VMX_EXIT_INVLPG:
131 if (info->shdw_pg_mode == SHADOW_PAGING) {
132 if (v3_handle_shadow_invlpg(info) == -1) {
133 PrintError("Error handling INVLPG\n");
141 #ifdef V3_CONFIG_DEBUG_TIME
142 PrintDebug("RDTSC\n");
144 if (v3_handle_rdtsc(info) == -1) {
145 PrintError("Error Handling RDTSC instruction\n");
152 if (v3_handle_cpuid(info) == -1) {
153 PrintError("Error Handling CPUID instruction\n");
159 if (v3_handle_msr_read(info) == -1) {
160 PrintError("Error handling MSR Read\n");
166 if (v3_handle_msr_write(info) == -1) {
167 PrintError("Error handling MSR Write\n");
172 case VMX_EXIT_VMCALL:
177 // VMCALL is a 3 byte op
178 // We do this early because some hypercalls can change the rip...
181 if (v3_handle_hypercall(info) == -1) {
185 case VMX_EXIT_IO_INSTR: {
186 struct vmx_exit_io_qual * io_qual = (struct vmx_exit_io_qual *)&(exit_info->exit_qual);
188 if (io_qual->dir == 0) {
189 if (io_qual->string) {
190 if (v3_handle_vmx_io_outs(info, exit_info) == -1) {
191 PrintError("Error in outs IO handler\n");
195 if (v3_handle_vmx_io_out(info, exit_info) == -1) {
196 PrintError("Error in out IO handler\n");
201 if (io_qual->string) {
202 if(v3_handle_vmx_io_ins(info, exit_info) == -1) {
203 PrintError("Error in ins IO handler\n");
207 if (v3_handle_vmx_io_in(info, exit_info) == -1) {
208 PrintError("Error in in IO handler\n");
215 case VMX_EXIT_CR_REG_ACCESSES: {
216 struct vmx_exit_cr_qual * cr_qual = (struct vmx_exit_cr_qual *)&(exit_info->exit_qual);
218 // PrintDebug("Control register: %d\n", cr_qual->access_type);
219 switch(cr_qual->cr_id) {
221 //PrintDebug("Handling CR0 Access\n");
222 if (v3_vmx_handle_cr0_access(info, cr_qual, exit_info) == -1) {
223 PrintError("Error in CR0 access handler\n");
228 //PrintDebug("Handling CR3 Access\n");
229 if (v3_vmx_handle_cr3_access(info, cr_qual) == -1) {
230 PrintError("Error in CR3 access handler\n");
235 //PrintDebug("Handling CR4 Access\n");
236 if (v3_vmx_handle_cr4_access(info, cr_qual) == -1) {
237 PrintError("Error in CR4 access handler\n");
242 if (v3_vmx_handle_cr8_access(info, cr_qual) == -1) {
243 PrintError("Error in CR8 access handler\n");
248 PrintError("Unhandled CR access: %d\n", cr_qual->cr_id);
252 // TODO: move RIP increment into all of the above individual CR
253 // handlers, not just v3_vmx_handle_cr4_access()
254 if (cr_qual->cr_id != 4)
255 info->rip += exit_info->instr_len;
260 PrintDebug("Guest halted\n");
262 if (v3_handle_halt(info) == -1) {
263 PrintError("Error handling halt instruction\n");
269 case VMX_EXIT_MONITOR:
270 PrintDebug("Guest Executing monitor\n");
272 if (v3_handle_monitor(info) == -1) {
273 PrintError("Error handling monitor instruction\n");
280 PrintDebug("Guest Executing mwait\n");
282 if (v3_handle_mwait(info) == -1) {
283 PrintError("Error handling mwait instruction\n");
295 case VMX_EXIT_EXTERNAL_INTR:
296 // Interrupts are handled outside switch
298 case VMX_EXIT_INTR_WINDOW:
299 // This is handled in the atomic part of the vmx code,
300 // not in the generic (interruptable) vmx handler
302 case VMX_EXIT_EXPIRED_PREEMPT_TIMER:
303 V3_Print("VMX Preempt Timer Expired.\n");
304 // This just forces an exit and is handled outside the switch
308 PrintError("Unhandled VMX_EXIT: %s (%u), %lu (0x%lx)\n",
309 v3_vmx_exit_code_to_str(basic_info->reason),
311 exit_info->exit_qual, exit_info->exit_qual);
316 #ifdef V3_CONFIG_TELEMETRY
317 if (info->vm_info->enable_telemetry) {
318 v3_telemetry_end_exit(info, exit_info->exit_reason);
326 static const char VMX_EXIT_INFO_EXCEPTION_OR_NMI_STR[] = "VMX_EXIT_INFO_EXCEPTION_OR_NMI";
327 static const char VMX_EXIT_EXTERNAL_INTR_STR[] = "VMX_EXIT_EXTERNAL_INTR";
328 static const char VMX_EXIT_TRIPLE_FAULT_STR[] = "VMX_EXIT_TRIPLE_FAULT";
329 static const char VMX_EXIT_INIT_SIGNAL_STR[] = "VMX_EXIT_INIT_SIGNAL";
330 static const char VMX_EXIT_STARTUP_IPI_STR[] = "VMX_EXIT_STARTUP_IPI";
331 static const char VMX_EXIT_IO_SMI_STR[] = "VMX_EXIT_IO_SMI";
332 static const char VMX_EXIT_OTHER_SMI_STR[] = "VMX_EXIT_OTHER_SMI";
333 static const char VMX_EXIT_INTR_WINDOW_STR[] = "VMX_EXIT_INTR_WINDOW";
334 static const char VMX_EXIT_NMI_WINDOW_STR[] = "VMX_EXIT_NMI_WINDOW";
335 static const char VMX_EXIT_TASK_SWITCH_STR[] = "VMX_EXIT_TASK_SWITCH";
336 static const char VMX_EXIT_CPUID_STR[] = "VMX_EXIT_CPUID";
337 static const char VMX_EXIT_HLT_STR[] = "VMX_EXIT_HLT";
338 static const char VMX_EXIT_INVD_STR[] = "VMX_EXIT_INVD";
339 static const char VMX_EXIT_INVLPG_STR[] = "VMX_EXIT_INVLPG";
340 static const char VMX_EXIT_RDPMC_STR[] = "VMX_EXIT_RDPMC";
341 static const char VMX_EXIT_RDTSC_STR[] = "VMX_EXIT_RDTSC";
342 static const char VMX_EXIT_RSM_STR[] = "VMX_EXIT_RSM";
343 static const char VMX_EXIT_VMCALL_STR[] = "VMX_EXIT_VMCALL";
344 static const char VMX_EXIT_VMCLEAR_STR[] = "VMX_EXIT_VMCLEAR";
345 static const char VMX_EXIT_VMLAUNCH_STR[] = "VMX_EXIT_VMLAUNCH";
346 static const char VMX_EXIT_VMPTRLD_STR[] = "VMX_EXIT_VMPTRLD";
347 static const char VMX_EXIT_VMPTRST_STR[] = "VMX_EXIT_VMPTRST";
348 static const char VMX_EXIT_VMREAD_STR[] = "VMX_EXIT_VMREAD";
349 static const char VMX_EXIT_VMRESUME_STR[] = "VMX_EXIT_VMRESUME";
350 static const char VMX_EXIT_VMWRITE_STR[] = "VMX_EXIT_VMWRITE";
351 static const char VMX_EXIT_VMXOFF_STR[] = "VMX_EXIT_VMXOFF";
352 static const char VMX_EXIT_VMXON_STR[] = "VMX_EXIT_VMXON";
353 static const char VMX_EXIT_CR_REG_ACCESSES_STR[] = "VMX_EXIT_CR_REG_ACCESSES";
354 static const char VMX_EXIT_MOV_DR_STR[] = "VMX_EXIT_MOV_DR";
355 static const char VMX_EXIT_IO_INSTR_STR[] = "VMX_EXIT_IO_INSTR";
356 static const char VMX_EXIT_RDMSR_STR[] = "VMX_EXIT_RDMSR";
357 static const char VMX_EXIT_WRMSR_STR[] = "VMX_EXIT_WRMSR";
358 static const char VMX_EXIT_INVALID_GUEST_STATE_STR[] = "VMX_EXIT_INVALID_GUEST_STATE";
359 static const char VMX_EXIT_INVALID_MSR_LOAD_STR[] = "VMX_EXIT_INVALID_MSR_LOAD";
360 static const char VMX_EXIT_MWAIT_STR[] = "VMX_EXIT_MWAIT";
361 static const char VMX_EXIT_MONITOR_STR[] = "VMX_EXIT_MONITOR";
362 static const char VMX_EXIT_PAUSE_STR[] = "VMX_EXIT_PAUSE";
363 static const char VMX_EXIT_INVALID_MACHINE_CHECK_STR[] = "VMX_EXIT_INVALIDE_MACHINE_CHECK";
364 static const char VMX_EXIT_TPR_BELOW_THRESHOLD_STR[] = "VMX_EXIT_TPR_BELOW_THRESHOLD";
365 static const char VMX_EXIT_APIC_STR[] = "VMX_EXIT_APIC";
366 static const char VMX_EXIT_GDTR_IDTR_STR[] = "VMX_EXIT_GDTR_IDTR";
367 static const char VMX_EXIT_LDTR_TR_STR[] = "VMX_EXIT_LDTR_TR";
368 static const char VMX_EXIT_EPT_VIOLATION_STR[] = "VMX_EXIT_EPT_VIOLATION";
369 static const char VMX_EXIT_EPT_CONFIG_STR[] = "VMX_EXIT_EPT_CONFIG";
370 static const char VMX_EXIT_INVEPT_STR[] = "VMX_EXIT_INVEPT";
371 static const char VMX_EXIT_RDTSCP_STR[] = "VMX_EXIT_RDTSCP";
372 static const char VMX_EXIT_EXPIRED_PREEMPT_TIMER_STR[] = "VMX_EXIT_EXPIRED_PREEMPT_TIMER";
373 static const char VMX_EXIT_INVVPID_STR[] = "VMX_EXIT_INVVPID";
374 static const char VMX_EXIT_WBINVD_STR[] = "VMX_EXIT_WBINVD";
375 static const char VMX_EXIT_XSETBV_STR[] = "VMX_EXIT_XSETBV";
377 const char * v3_vmx_exit_code_to_str(vmx_exit_t exit)
380 case VMX_EXIT_INFO_EXCEPTION_OR_NMI:
381 return VMX_EXIT_INFO_EXCEPTION_OR_NMI_STR;
382 case VMX_EXIT_EXTERNAL_INTR:
383 return VMX_EXIT_EXTERNAL_INTR_STR;
384 case VMX_EXIT_TRIPLE_FAULT:
385 return VMX_EXIT_TRIPLE_FAULT_STR;
386 case VMX_EXIT_INIT_SIGNAL:
387 return VMX_EXIT_INIT_SIGNAL_STR;
388 case VMX_EXIT_STARTUP_IPI:
389 return VMX_EXIT_STARTUP_IPI_STR;
390 case VMX_EXIT_IO_SMI:
391 return VMX_EXIT_IO_SMI_STR;
392 case VMX_EXIT_OTHER_SMI:
393 return VMX_EXIT_OTHER_SMI_STR;
394 case VMX_EXIT_INTR_WINDOW:
395 return VMX_EXIT_INTR_WINDOW_STR;
396 case VMX_EXIT_NMI_WINDOW:
397 return VMX_EXIT_NMI_WINDOW_STR;
398 case VMX_EXIT_TASK_SWITCH:
399 return VMX_EXIT_TASK_SWITCH_STR;
401 return VMX_EXIT_CPUID_STR;
403 return VMX_EXIT_HLT_STR;
405 return VMX_EXIT_INVD_STR;
406 case VMX_EXIT_INVLPG:
407 return VMX_EXIT_INVLPG_STR;
409 return VMX_EXIT_RDPMC_STR;
411 return VMX_EXIT_RDTSC_STR;
413 return VMX_EXIT_RSM_STR;
414 case VMX_EXIT_VMCALL:
415 return VMX_EXIT_VMCALL_STR;
416 case VMX_EXIT_VMCLEAR:
417 return VMX_EXIT_VMCLEAR_STR;
418 case VMX_EXIT_VMLAUNCH:
419 return VMX_EXIT_VMLAUNCH_STR;
420 case VMX_EXIT_VMPTRLD:
421 return VMX_EXIT_VMPTRLD_STR;
422 case VMX_EXIT_VMPTRST:
423 return VMX_EXIT_VMPTRST_STR;
424 case VMX_EXIT_VMREAD:
425 return VMX_EXIT_VMREAD_STR;
426 case VMX_EXIT_VMRESUME:
427 return VMX_EXIT_VMRESUME_STR;
428 case VMX_EXIT_VMWRITE:
429 return VMX_EXIT_VMWRITE_STR;
430 case VMX_EXIT_VMXOFF:
431 return VMX_EXIT_VMXOFF_STR;
433 return VMX_EXIT_VMXON_STR;
434 case VMX_EXIT_CR_REG_ACCESSES:
435 return VMX_EXIT_CR_REG_ACCESSES_STR;
436 case VMX_EXIT_MOV_DR:
437 return VMX_EXIT_MOV_DR_STR;
438 case VMX_EXIT_IO_INSTR:
439 return VMX_EXIT_IO_INSTR_STR;
441 return VMX_EXIT_RDMSR_STR;
443 return VMX_EXIT_WRMSR_STR;
444 case VMX_EXIT_INVALID_GUEST_STATE:
445 return VMX_EXIT_INVALID_GUEST_STATE_STR;
446 case VMX_EXIT_INVALID_MSR_LOAD:
447 return VMX_EXIT_INVALID_MSR_LOAD_STR;
449 return VMX_EXIT_MWAIT_STR;
450 case VMX_EXIT_MONITOR:
451 return VMX_EXIT_MONITOR_STR;
453 return VMX_EXIT_PAUSE_STR;
454 case VMX_EXIT_INVALID_MACHINE_CHECK:
455 return VMX_EXIT_INVALID_MACHINE_CHECK_STR;
456 case VMX_EXIT_TPR_BELOW_THRESHOLD:
457 return VMX_EXIT_TPR_BELOW_THRESHOLD_STR;
459 return VMX_EXIT_APIC_STR;
460 case VMX_EXIT_GDTR_IDTR:
461 return VMX_EXIT_GDTR_IDTR_STR;
462 case VMX_EXIT_LDTR_TR:
463 return VMX_EXIT_LDTR_TR_STR;
464 case VMX_EXIT_EPT_VIOLATION:
465 return VMX_EXIT_EPT_VIOLATION_STR;
466 case VMX_EXIT_EPT_CONFIG:
467 return VMX_EXIT_EPT_CONFIG_STR;
468 case VMX_EXIT_INVEPT:
469 return VMX_EXIT_INVEPT_STR;
470 case VMX_EXIT_RDTSCP:
471 return VMX_EXIT_RDTSCP_STR;
472 case VMX_EXIT_EXPIRED_PREEMPT_TIMER:
473 return VMX_EXIT_EXPIRED_PREEMPT_TIMER_STR;
474 case VMX_EXIT_INVVPID:
475 return VMX_EXIT_INVVPID_STR;
476 case VMX_EXIT_WBINVD:
477 return VMX_EXIT_WBINVD_STR;
478 case VMX_EXIT_XSETBV:
479 return VMX_EXIT_XSETBV_STR;