installer: Improve user interaction

Improve the processing flow according to the return value of check
tool: prohibits user to install HAXM only when the system hardware or
OS does not support; allows user to retry when VMs are occupying HAXM;
and if the system needs to be configured, prompts a warning but proceed
installation. When uninstalling, only the occupancy of VMs is checked.

* Add status and flags according to the error code of check tool
* Update the function of checking environment to comply with check tool
  upgrade
* Add message boxes to show and handle the check result for both
  installation and uninstallation process

Signed-off-by: Wenchao Wang <[email protected]>

Author: wcwang

Installer/HaxmSetup.nsi

@@ -58,17 +58,39 @@ Section Main
   File "assets\checktool.exe"
   ${Log} "Extract: checktool.exe... 100%"
 
+Check:
   Call CheckEnv
+  Pop $0
+
+  ${Switch} $0
+    ${Case} ${ENV_STATUS_UNREADY}
+      MessageBox MB_OK|MB_ICONEXCLAMATION "${DLG_WARNING}" /SD IDOK
+      ${Log} "${DLG_WARNING}"
+      ${Break}
+    ${Case} ${ENV_STATUS_INUSE}
+      MessageBox MB_RETRYCANCEL|MB_ICONSTOP "${DLG_GUEST_ERROR}" /SD IDCANCEL \
+          IDRETRY Check
+      ${Log} "${DLG_GUEST_ERROR}"
+      ${Exit} 0 3
+      ${Break}
+    ${Case} ${ENV_STATUS_UNSUPPORTED}
+      MessageBox MB_OK|MB_ICONSTOP "${DLG_SYS_ERROR}" /SD IDOK
+      ${Log} "${DLG_SYS_ERROR}"
+      Call Restore
+      ${Exit} 0 3
+      ${Break}
+    ${Default}
+      ${Break}
+  ${EndSwitch}
+
   Call UninstallMsiVersion
   Call InstallDriver
 
   ; WriteUninstaller is not used directly because a signed binary is needed
   File "assets\uninstall.exe"
   ${Log} "Create uninstaller: $INSTDIR\uninstall.exe"
-SectionEnd
 
-Section -Post
-  Call onInstalled
+  Call LoadDriver
 SectionEnd
 
 Function .onInit
@@ -93,33 +115,42 @@ Function CheckVersion
 
   ClearErrors
   EnumRegKey $0 ${REG_ROOT_KEY} ${REG_KEY_PRODUCT} 0
-  IfErrors not_installed installed
-  not_installed:
-    StrCpy $code 0
-    ${Log} "Version: ${PRODUCT_VERSION}"
+  IfErrors NotInstalled Installed
+NotInstalled:
+  StrCpy $code 0
+  ${Log} "Version: ${PRODUCT_VERSION}"
+  Return
+Installed:
+  ReadRegStr $0 ${REG_ROOT_KEY} ${REG_KEY_PRODUCT} "DisplayVersion"
+  ${VersionCompare} $0 ${PRODUCT_VERSION} $R0
+  ${Switch} $R0
+    ${Case} 0
+      MessageBox MB_YESNO|MB_ICONQUESTION "${DLG_REINSTALL}" /SD IDYES IDYES \
+          Reinstall
+      ${Exit} 1 0
+Reinstall:
+      StrCpy $code 1
+      ${Log} "${LOG_REINSTALL}: $0"
+      ${Break}
+    ${Case} 1
+      MessageBox MB_OK|MB_ICONEXCLAMATION "${DLG_DOWNGRADE}" /SD IDOK
+      ${Log} "${LOG_UNINSTALL}: $0"
+      ${Exit} 1 3
+      ${Break}
+    ${Default}
+      StrCpy $code 2
+      ${Log} "${LOG_UPGRADE}: $0 => ${PRODUCT_VERSION}"
+      ${Break}
+  ${EndSwitch}
+FunctionEnd
+
+Function Restore
+  ${If} $code != 0
     Return
-  installed:
-    ReadRegStr $0 ${REG_ROOT_KEY} ${REG_KEY_PRODUCT} "DisplayVersion"
-    ${VersionCompare} $0 ${PRODUCT_VERSION} $R0
-    ${Switch} $R0
-      ${Case} 0
-        MessageBox MB_YESNO|MB_ICONQUESTION "${DLG_REINSTALL}" /SD IDYES IDYES \
-            reinstall
-        ${Exit} 1 0
-  reinstall:
-        StrCpy $code 1
-        ${Log} "${LOG_REINSTALL}: $0"
-        ${Break}
-      ${Case} 1
-        MessageBox MB_OK|MB_ICONEXCLAMATION "${DLG_DOWNGRADE}" /SD IDOK
-        ${Log} "${LOG_UNINSTALL}: $0"
-        ${Exit} 1 3
-        ${Break}
-      ${Default}
-        StrCpy $code 2
-        ${Log} "${LOG_UPGRADE}: $0 => ${PRODUCT_VERSION}"
-        ${Break}
-    ${EndSwitch}
+  ${EndIf}
+
+  RMDir /r "$INSTDIR"
+  ${Log} "Delete folder: $INSTDIR"
 FunctionEnd
 
 Function UninstallMsiVersion
@@ -174,7 +205,7 @@ Function InstallDriver
   ${Log} "Copy to ${DRIVER_DIR}\${DRIVER_FILE}"
 FunctionEnd
 
-Function onInstalled
+Function LoadDriver
   ${If} $code == 0
     Call CreateService
   ${EndIf}

Installer/RegOps.nsh

@@ -36,7 +36,7 @@
 !endif
 
 !include 'Log.nsh'
-!include 'Strings.nsh'
+!include 'Resources.nsh'
 
 !ifdef INSTALL
 

Installer/Strings.nsh renamed to Installer/Resources.nsh

@@ -28,16 +28,18 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-!ifndef STRINGS_NSH_
-!define STRINGS_NSH_
+!ifndef RESOURCES_NSH_
+!define RESOURCES_NSH_
 
+# Strings
 !define PRODUCT_NAME          "HAXM"
 !define PRODUCT_FULL_NAME     "Hardware Accelerated Execution Manager"
 !define PRODUCT_VERSION       "7.6.5"
 !define PRODUCT_YEAR          "2020"
 !define PRODUCT_PUBLISHER     "Intel Corporation"
 !define PRODUCT_BRAND         "Intel${U+00AE}"
 !define PRODUCT_WEBSITE       "https://github.com/intel/haxm"
+!define PRODUCT_WIKIPAGE      "/wiki/Windows-System-Configurations"
 !define PRODUCT_GUID          "AAA802A8DF574F4CA0489512D2D91818"
 
 !define PROGRAM_DIR           "\Intel\${PRODUCT_NAME}"
@@ -60,15 +62,59 @@
 !define DRIVER_WIN7_64   "assets\win7\x64\${DRIVER_FILE}"
 !define DRIVER_WIN7_32   "assets\win7\x86\${DRIVER_FILE}"
 
-!define DLG_CHECK_ENV  "The system requirements are not satisfied."
-!define DLG_DOWNGRADE  "The existing version is greater than the version to \
+!define DLG_SYS_ERROR    "The system environment does not meet the \
+        installation requirements."
+!define DLG_GUEST_ERROR  "${PRODUCT_NAME} is being used by running virtual \
+        machines now. Please terminate these virtual machine processes first."
+!define DLG_WARNING      "The ${PRODUCT_NAME} driver can be installed on this \
+        computer. However, it is required to further configure the system to \
+        make it usable. Then ${PRODUCT_NAME} will be automatically loaded for \
+        use."
+!define DLG_DOWNGRADE    "The existing version is greater than the version to \
         be installed. Please uninstall the existing version manually before \
         proceeding."
-!define DLG_REINSTALL  "${PRODUCT_NAME} v${PRODUCT_VERSION} has already been \
+!define DLG_REINSTALL    "${PRODUCT_NAME} v${PRODUCT_VERSION} has already been \
         installed. Are you sure to continue?"
-!define DLG_UNINSTALL  "Are you sure you want to remove $(^Name)?"
-!define LOG_REINSTALL  "To reinstall the current version"
-!define LOG_UNINSTALL  "To uninstall the current version"
-!define LOG_UPGRADE    "To upgrade version"
+!define DLG_UNINSTALL    "Are you sure you want to remove $(^Name)?"
+!define LOG_REINSTALL    "To reinstall the current version"
+!define LOG_UNINSTALL    "To uninstall the current version"
+!define LOG_UPGRADE      "To upgrade version"
 
-!endif  # STRINGS_NSH_
+# Constants
+# Environment flags
+!define ENV_FLAG_CPU_SUPPORTED     0x00000001
+!define ENV_FLAG_VMX_SUPPORTED     0x00000002
+!define ENV_FLAG_NX_SUPPORTED      0x00000004
+!define ENV_FLAG_EM64T_SUPPORTED   0x00000008
+!define ENV_FLAG_EPT_SUPPORTED     0x00000010
+!define ENV_FLAG_VMX_ENABLED       0x00000100
+!define ENV_FLAG_NX_ENABLED        0x00000200
+!define ENV_FLAG_EM64T_ENABLED     0x00000400
+!define ENV_FLAG_OSVER_SUPPORTED   0x00010000
+!define ENV_FLAG_OSARCH_SUPPORTED  0x00020000
+!define ENV_FLAG_HYPERV_DISABLED   0x00040000
+!define ENV_FLAG_SANDBOX_DISABLED  0x00080000
+!define ENV_FLAG_GUEST_UNOCCUPIED  0x01000000
+
+# Hardware supports:
+#   ENV_FLAG_CPU_SUPPORTED, ENV_FLAG_VMX_SUPPORTED, ENV_FLAG_NX_SUPPORTED,
+#   ENV_FLAG_EM64T_SUPPORTED, ENV_FLAG_EPT_SUPPORTED
+# OS supports:
+#   ENV_FLAG_OSVER_SUPPORTED, ENV_FLAG_OSARCH_SUPPORTED
+!define ENV_FLAGS_SYS_SUPPORTED    0x000300ff
+# BIOS settings:
+#   ENV_FLAG_VMX_ENABLED, ENV_FLAG_NX_ENABLED, ENV_FLAG_EM64T_ENABLED
+# OS settings:
+#   ENV_FLAG_HYPERV_DISABLED, ENV_FLAG_SANDBOX_DISABLED
+!define ENV_FLAGS_HOST_READY       0x00fcff00
+# Guest status:
+#   ENV_FLAG_GUEST_UNOCCUPIED
+!define ENV_FLAGS_GUEST_READY      0xff000000
+
+# Environment status
+!define ENV_STATUS_READY                    0
+!define ENV_STATUS_UNREADY                  1
+!define ENV_STATUS_INUSE                    2
+!define ENV_STATUS_UNSUPPORTED              3
+
+!endif  # RESOURCES_NSH_

Installer/UI.nsh

@@ -33,7 +33,7 @@
 
 !include "MUI.nsh"
 
-!include 'Strings.nsh'
+!include 'Resources.nsh'
 
 RequestExecutionLevel  admin
 ShowInstDetails        show

Installer/Uninstall.nsi

@@ -57,7 +57,16 @@ Section Uninstall
 
   ${OpenLog}
   ${Log} "Version: ${PRODUCT_VERSION}"
+Check:
   Call un.CheckEnv
+  Pop $0
+
+  ${If} $0 == ${ENV_STATUS_INUSE}
+    MessageBox MB_RETRYCANCEL|MB_ICONSTOP "${DLG_GUEST_ERROR}" /SD IDCANCEL \
+        IDRETRY Check
+    ${Log} "${DLG_GUEST_ERROR}"
+    ${Exit} 1 3
+  ${EndIf}
 
   ; Sometimes checktool.exe is still locked when removing $INSTDIR. Below two
   ; parts ensure that checktool.exe is completely unlocked for removal.

Installer/Utils.nsh

@@ -34,7 +34,7 @@
 !include "LogicLib.nsh"
 
 !include 'Log.nsh'
-!include 'Strings.nsh'
+!include 'Resources.nsh'
 
 # ExecCommand --------------------------
 
@@ -91,6 +91,7 @@
       Abort
       ${Break}
     ${Default}
+      Return
       ${Break}
   ${EndSwitch}
 !macroend
@@ -99,16 +100,29 @@
 
 # CheckEnv -----------------------------
 
+Var status
+
+!macro CheckReturn Ret Flags
+  IntOp $0 $status & ${Flags}
+
+  ${If} $0 != 0
+    Push ${Ret}
+    Return
+  ${EndIf}
+!macroend
+
+!define CheckReturn `!insertmacro CheckReturn`
+
 !macro CheckEnv un
   Function ${un}CheckEnv
-    ${${un}ExecCommand} '$INSTDIR\checktool.exe --verbose' true
-    Pop $0
+    ${${un}ExecCommand} '$INSTDIR\checktool.exe' true
+    Pop $status
 
-    ${If} $0 != "0"
-      MessageBox MB_OK|MB_ICONSTOP "${DLG_CHECK_ENV}" /SD IDOK
-      ${Log} "${DLG_CHECK_ENV}"
-      ${Exit} 2 3
-    ${EndIf}
+    ${CheckReturn} ${ENV_STATUS_UNSUPPORTED} ${ENV_FLAGS_SYS_SUPPORTED}
+    ${CheckReturn} ${ENV_STATUS_INUSE}       ${ENV_FLAGS_GUEST_READY}
+    ${CheckReturn} ${ENV_STATUS_UNREADY}     ${ENV_FLAGS_HOST_READY}
+
+    Push ${ENV_STATUS_READY}
   FunctionEnd
 !macroend