handle CreateInstance mount failure error

It is hard to distinguish between a corrupted disk and bad fsType/fsMountOptions for failures of mounting the rootfs. This change renamed the WSL_E_DISK_CORRUPTED into WSL_E_MOUNT_FAILED, and changed the error message to inform the user the possible causes of the failure.

Author: artiga033

localization/strings/en-US/Resources.resw

@@ -1056,8 +1056,8 @@ Falling back to NAT networking.</value>
     <value>The distribution failed to start. Error code: {}, failure step: {}</value>
     <comment>{FixedPlaceholder="{}"}Command line arguments, file names and string inserts should not be translated</comment>
   </data>
-  <data name="MessageDiskCorrupted" xml:space="preserve">
-    <value>The distribution failed to start because its virtual disk is corrupted.</value>
+  <data name="MessageMountFailed" xml:space="preserve">
+    <value>The distribution failed to start because its virtual disk is corrupted, of non-expected filesystem, or invalid mount options.</value>
   </data>
   <data name="MessageConfigKeyDuplicated" xml:space="preserve">
     <value>Duplicated config key '{}' in {}:{} (Conflicting key: '{}' in {}:{})</value>

src/windows/common/wslutil.cpp

@@ -81,7 +81,7 @@ static const std::map<HRESULT, LPCWSTR> g_commonErrors{
     X(WSL_E_WSL1_DISABLED),
     X(WSL_E_VIRTUAL_MACHINE_PLATFORM_REQUIRED),
     X(WSL_E_LOCAL_SYSTEM_NOT_SUPPORTED),
-    X(WSL_E_DISK_CORRUPTED),
+    X(WSL_E_MOUNT_FAILED),
     X(WSL_E_DISTRIBUTION_NAME_NEEDED),
     X(WSL_E_INVALID_JSON),
     X(WSL_E_VM_CRASHED),
@@ -887,8 +887,8 @@ std::wstring wsl::windows::common::wslutil::GetErrorString(HRESULT result)
     case WSL_E_LOCAL_SYSTEM_NOT_SUPPORTED:
         return Localization::MessageLocalSystemNotSupported();
 
-    case WSL_E_DISK_CORRUPTED:
-        return Localization::MessageDiskCorrupted();
+    case WSL_E_MOUNT_FAILED:
+        return Localization::MessageMountFailed();
 
     case WSL_E_NOT_A_LINUX_DISTRO:
         return Localization::MessageInvalidDistributionTar();

src/windows/service/exe/WslCoreInstance.cpp

@@ -60,9 +60,9 @@ WslCoreInstance::WslCoreInstance(
     if (result.Result != 0)
     {
         // N.B. EUCLEAN (117) can be returned if the disk's journal is corrupted.
-        if ((result.Result == 117) && result.FailureStep == LxInitCreateInstanceStepMountDisk)
+        if ((result.Result == EINVAL || result.Result == 117) && result.FailureStep == LxInitCreateInstanceStepMountDisk)
         {
-            THROW_HR(WSL_E_DISK_CORRUPTED);
+            THROW_HR(WSL_E_MOUNT_FAILED);
         }
         else
         {

src/windows/service/inc/wslservice.idl

@@ -405,7 +405,7 @@ cpp_quote("#define WSL_E_DISK_MOUNT_DISABLED MAKE_HRESULT(SEVERITY_ERROR, FACILI
 cpp_quote("#define WSL_E_WSL1_DISABLED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x2C) /* 0x8004032C */")
 cpp_quote("#define WSL_E_VIRTUAL_MACHINE_PLATFORM_REQUIRED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x2D) /* 0x8004032D */")
 cpp_quote("#define WSL_E_LOCAL_SYSTEM_NOT_SUPPORTED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x2E) /* 0x8004032E */")
-cpp_quote("#define WSL_E_DISK_CORRUPTED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x2F) /* 0x8004032F */")
+cpp_quote("#define WSL_E_MOUNT_FAILED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x2F) /* 0x8004032F */")
 cpp_quote("#define WSL_E_DISTRIBUTION_NAME_NEEDED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x30) /* 0x80040330 */")
 cpp_quote("#define WSL_E_INVALID_JSON MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x31) /* 0x80040331 */")
 cpp_quote("#define WSL_E_VM_CRASHED MAKE_HRESULT(SEVERITY_ERROR, FACILITY_ITF, WSL_E_BASE + 0x32) /* 0x80040332 */")

test/windows/UnitTests.cpp

@@ -2586,14 +2586,14 @@ Error code: Wsl/InstallDistro/WSL_E_DISTRO_NOT_FOUND
             // Validate that starting the distribution fails with the correct error code.
             validateOutput(
                 L"-d BrokenDistro echo ok",
-                L"The distribution failed to start because its virtual disk is corrupted.\r\n"
-                L"Error code: Wsl/Service/CreateInstance/WSL_E_DISK_CORRUPTED\r\n");
+                L"The distribution failed to start because its virtual disk is corrupted, of non-expected filesystem, or invalid mount options.\r\n"
+                L"Error code: Wsl/Service/CreateInstance/WSL_E_MOUNT_FAILED\r\n");
 
             // Validate that trying to export the distribution fails with the correct error code.
             validateOutput(
                 L"--export BrokenDistro dummy.tar",
-                L"The distribution failed to start because its virtual disk is corrupted.\r\n"
-                L"Error code: Wsl/Service/WSL_E_DISK_CORRUPTED\r\n");
+                L"The distribution failed to start because its virtual disk is corrupted, of non-expected filesystem, or invalid mount options.\r\n"
+                L"Error code: Wsl/Service/WSL_E_MOUNT_FAILED\r\n");
 
             // Shutdown WSL to force the disk to detach.
             VERIFY_ARE_EQUAL(LxsstuLaunchWsl(L"--shutdown"), 0L);
@@ -2602,8 +2602,8 @@ Error code: Wsl/InstallDistro/WSL_E_DISTRO_NOT_FOUND
         // Import a corrupted vhd.
         validateOutput(
             std::format(L"--import-in-place test-distro-corrupted \"{}\"", vhdPath.wstring()),
-            L"The distribution failed to start because its virtual disk is corrupted.\r\n"
-            L"Error code: Wsl/Service/RegisterDistro/WSL_E_DISK_CORRUPTED\r\n");
+            L"The distribution failed to start because its virtual disk is corrupted, of non-expected filesystem, or invalid mount options.\r\n"
+            L"Error code: Wsl/Service/RegisterDistro/WSL_E_MOUNT_FAILED\r\n");
 
         // Ensure the VHD can be deleted to make sure it was properly ejected from the VM.
         VERIFY_ARE_EQUAL(DeleteFileW(vhdPath.c_str()), TRUE);