Removed hax_log macro and using hax_info instead

- Some functions used hax_log, which was macro'ed to hax_info. Most likely a leftover from older HAXM revisions. This has been removed and replaced with hax_info directly.

- Fixed some incorrect format specifiers and improved documentation of `name_vmcs_component`.

Signed-off-by: Alexandro Sanchez Bach <[email protected]>

Author: AlexAltea

core/cpu.c

@@ -132,7 +132,7 @@ void cpu_init_vmx(void *arg)
     /* get VMX capabilities */
     vmx_read_info(&vmx_info);
 #if 0
-    //hax_log("-----------cpu %d---------------\n", cpu_data->cpu_id);
+    //hax_info("-----------cpu %d---------------\n", cpu_data->cpu_id);
 
     if ((cpu_data->cpu_id == 0 ||
          memcmp(&vmx_info, &hax_cpu_data[0]->vmx_info,
@@ -142,13 +142,13 @@ void cpu_init_vmx(void *arg)
 #endif
 
     if (vmx_info._vmcs_region_length > HAX_PAGE_SIZE)
-        hax_log("VMCS of %d bytes not supported by this Hypervisor. "
+        hax_info("VMCS of %d bytes not supported by this Hypervisor. "
                 "Max supported %u bytes\n",
                 vmx_info._vmcs_region_length, (uint32_t)HAX_PAGE_SIZE);
     vmxon = (vmcs_t *)hax_page_va(cpu_data->vmxon_page);
     vmxon->_revision_id = vmx_info._vmcs_revision_id;
 
-    //hax_log("enabled VMX mode (vmxon = %p)\n",
+    //hax_info("enabled VMX mode (vmxon = %p)\n",
     //        hax_page_va(cpu_data->vmxon_page));
 
     vmx_read_info(&cpu_data->vmx_info);
@@ -654,7 +654,7 @@ static void cpu_vmentry_failed(struct vcpu_t *vcpu, vmx_result_t result)
     reason = vmread(vcpu, VM_EXIT_INFO_REASON);
     if (result == VMX_FAIL_VALID) {
         error = vmread(vcpu, VMX_INSTRUCTION_ERROR_CODE);
-        hax_error("VMfailValid. Prev exit: %llx. Error code: %lld (%s)\n",
+        hax_error("VMfailValid. Prev exit: %llx. Error code: %llu (%s)\n",
                   reason, error, name_vmx_error(error));
     } else {
         hax_error("VMfailInvalid. Prev exit: %llx no error code\n",

core/dump.c

@@ -195,30 +195,30 @@ void dump_vmcs(struct vcpu_t *vcpu)
 
 void dump_vmx_info(struct info_t *info)
 {
-    hax_log("VMCS Rev %d\n", info->_vmcs_revision_id);
+    hax_info("VMCS Rev %d\n", info->_vmcs_revision_id);
 
-    hax_log("VMX basic info       : 0x%016llX\n",
-            info->_basic_info);
-    hax_log("VMX misc info        : 0x%08llX\n",
-            info->_miscellaneous);
-    hax_log("VMX revision control : %d\n",
-            info->_vmcs_revision_id);
-    hax_log("VMX exit ctls        : 0x%X, 0x%X\n",
-            info->exit_ctls_0, info->exit_ctls_1);
-    hax_log("VMX entry ctls       : 0x%X, 0x%X\n",
-            info->entry_ctls_0, info->entry_ctls_1);
-    hax_log("VMX pin ctls         : 0x%X, 0x%X\n",
-            info->pin_ctls_0, info->pin_ctls_1);
-    hax_log("VMX cpu prim ctrls   : 0x%X, 0x%X\n",
-            info->pcpu_ctls_0, info->pcpu_ctls_1);
-    hax_log("VMX cpu sec ctrl     : 0x%X, 0x%X\n",
-            info->scpu_ctls_0, info->scpu_ctls_1);
-    hax_log("VMX fixed CR0 bits   : 0x%llX, %llX\n",
-            info->_cr0_fixed_0, info->_cr0_fixed_1);
-    hax_log("VMX fixed CR4 bits   : 0x%llX, %llX\n",
-            info->_cr4_fixed_0, info->_cr4_fixed_1);
-    hax_log("VMX EPT/VPID caps    : 0x%016llX\n",
-            info->_ept_cap);
+    hax_info("VMX basic info       : 0x%016llX\n",
+             info->_basic_info);
+    hax_info("VMX misc info        : 0x%016llX\n",
+             info->_miscellaneous);
+    hax_info("VMX revision control : %u\n",
+             info->_vmcs_revision_id);
+    hax_info("VMX exit ctls        : 0x%X, 0x%X\n",
+             info->exit_ctls_0, info->exit_ctls_1);
+    hax_info("VMX entry ctls       : 0x%X, 0x%X\n",
+             info->entry_ctls_0, info->entry_ctls_1);
+    hax_info("VMX pin ctls         : 0x%X, 0x%X\n",
+             info->pin_ctls_0, info->pin_ctls_1);
+    hax_info("VMX cpu prim ctrls   : 0x%X, 0x%X\n",
+             info->pcpu_ctls_0, info->pcpu_ctls_1);
+    hax_info("VMX cpu sec ctrl     : 0x%X, 0x%X\n",
+             info->scpu_ctls_0, info->scpu_ctls_1);
+    hax_info("VMX fixed CR0 bits   : 0x%llX, %llX\n",
+             info->_cr0_fixed_0, info->_cr0_fixed_1);
+    hax_info("VMX fixed CR4 bits   : 0x%llX, %llX\n",
+             info->_cr4_fixed_0, info->_cr4_fixed_1);
+    hax_info("VMX EPT/VPID caps    : 0x%016llX\n",
+             info->_ept_cap);
 }
 
 /*Remove this function. It only for debug*/

core/name.c

@@ -33,11 +33,22 @@
 
 const char *name_vmcs_component(int value)
 {
+    // The following macro compactifies the VMCS component encoding to 9 bits,
+    // thus all major compilers will optimize the switch-case via jump tables.
+    // Compilers will ensure this is a perfect hash function, by preventing
+    // the two identical cases to exist.
+    // The original encoding is described by:
     // Intel SDM Vol. 3C: Table 24-17. Structure of VMCS Component Encoding
+    // Our compact encoding is described by:
+    // [W WTTI IIII]  W=Width, T=Type, I=Index
+
+    // As of this writing, no VMCS component is encoded with an Index of more
+    // than 5 bits (Intel SDM Vol. 3D, Appendix B: Field Encoding in VMCS),
+    // even though 9 bits are allocated to Index.
 #define HASH(x) \
     (((x) & 0x003E) >> 1) /* Index */ | \
-    (((x) & 0x0C00) >> 4) /* Type  */ | \
-    (((x) & 0x6000) >> 5) /* Width */
+    (((x) & 0x0C00) >> 5) /* Type  */ | \
+    (((x) & 0x6000) >> 6) /* Width */
 #define CASE(x) \
     case HASH(x): \
         return #x

core/vm.c

@@ -226,7 +226,7 @@ int hax_vm_core_open(struct vm_t *vm)
 int hax_teardown_vm(struct vm_t *vm)
 {
     if (!hax_list_empty(&(vm->vcpu_list))) {
-        hax_log("Try to teardown non-empty vm\n");
+        hax_info("Try to teardown non-empty vm\n");
         return -1;
     }
 #ifdef HAX_ARCH_X86_32

include/darwin/hax_mac.h

@@ -191,8 +191,6 @@ extern int default_hax_log_level;
                 printf("haxm_debug: " x);          \
         }
 
-#define hax_log hax_info
-
 #define hax_panic panic
 
 #define hax_panic_vcpu(v, x...) {     \

include/windows/hax_windows.h

@@ -200,9 +200,6 @@ void hax_error(char *fmt, ...);
 void hax_warning(char *fmt, ...);
 void hax_info(char *fmt, ...);
 void hax_debug(char *fmt, ...);
-void hax_log(char *fmt, ...);
-
-#define hax_log hax_info
 
 #define hax_panic DbgPrint
 

platforms/windows/hax_entry.c

@@ -191,7 +191,7 @@ NTSTATUS HaxClose(PDEVICE_OBJECT DeviceObject, PIRP Irp)
     NTSTATUS ret = STATUS_SUCCESS;
     devext = (struct hax_dev_ext *)DeviceObject->DeviceExtension;
 
-    hax_log("HaxClose device %x at process %p\n", devext->type,
+    hax_info("HaxClose device %x at process %p\n", devext->type,
             (ULONG_PTR)PsGetCurrentThread());
     switch (devext->type) {
         case HAX_DEVEXT_TYPE_UP:
@@ -201,7 +201,7 @@ NTSTATUS HaxClose(PDEVICE_OBJECT DeviceObject, PIRP Irp)
         case HAX_DEVEXT_TYPE_VM:
             vm = &devext->vmdev_ext;
             cvm = vm->cvm;
-            hax_log("Close VM %x\n", vm->vm_id);
+            hax_info("Close VM %x\n", vm->vm_id);
             if (cvm)
                 hax_put_vm(cvm);
             break;
@@ -433,7 +433,7 @@ NTSTATUS HaxVcpuControl(PDEVICE_OBJECT DeviceObject,
         default:
             hax_error("Unknow vcpu ioctl %lx\n",
                       irpSp->Parameters.DeviceIoControl.IoControlCode);
-            hax_log("set regs ioctl %lx get regs %lx", HAX_VCPU_SET_REGS,
+            hax_info("set regs ioctl %lx get regs %lx", HAX_VCPU_SET_REGS,
                     HAX_VCPU_GET_REGS );
             ret = STATUS_INVALID_PARAMETER;
             break;
@@ -487,7 +487,7 @@ NTSTATUS HaxVmControl(PDEVICE_OBJECT DeviceObject, struct hax_vm_windows *ext,
             vm_id = vm->vm_id;
             cvcpu = vcpu_create(cvm, vm, vcpu_id);
             if (!cvcpu) {
-                hax_log("Failed to create vcpu %x on vm %x\n", vcpu_id, vm_id);
+                hax_info("Failed to create vcpu %x on vm %x\n", vcpu_id, vm_id);
                 ret = STATUS_UNSUCCESSFUL;
                 goto done;
             }
@@ -744,7 +744,7 @@ VOID HaxUnloadDriver(__in PDRIVER_OBJECT DriverObject)
     RtlInitUnicodeString(&ntWin32NameString, DOS_DEVICE_NAME);
     IoDeleteSymbolicLink(&ntWin32NameString);
     IoDeleteDevice(HaxDeviceObject);
-    hax_log("Unload the driver\n");
+    hax_info("Unload the driver\n");
     hax_host_exit();
     write_event(HaxDriverUnloaded, DriverObject, NULL, 0);
     HaxDeviceObject = NULL;

platforms/windows/haxm-core.vcxproj

@@ -113,7 +113,6 @@
     </ClCompile>
   </ItemDefinitionGroup>
   <ItemGroup>
-    <!-- We only add items (e.g. form ClSourceFiles) that do not already exist (e.g in the ClCompile list), this avoids duplication -->
     <ClCompile Include="..\..\core\name.c" />
     <ClCompile Include="..\..\core\chunk.c" />
     <ClCompile Include="..\..\core\cpu.c" />
@@ -135,6 +134,7 @@
     <ClCompile Include="..\..\core\vm.c" />
     <ClCompile Include="..\..\core\vmx.c" />
     <ClCompile Include="..\..\core\vtlb.c" />
+    <!-- We only add items (e.g. form ClSourceFiles) that do not already exist (e.g in the ClCompile list), this avoids duplication -->
     <ClCompile Include="@(ClSourceFiles)" Exclude="@(ClCompile)" />
     <ResourceCompile Include="@(RcSourceFiles)" Exclude="@(ResourceCompile)" />
     <Midl Include="@(IdlSourceFiles)" Exclude="@(Midl)" />