Changeset 96571 in vbox for trunk/src/VBox/Installer/win/StubBld

Timestamp:

Sep 1, 2022 8:34:00 PM (2 years ago)

Author:

vboxsync

Message:

Installer/win/Stub*: Built in no-CRT mode. Documented and reworked the resource structures a bit. bugref:10261

Location:

trunk/src/VBox/Installer/win/StubBld

Files:

• VBoxStubBld.cpp (modified) (3 diffs)
• VBoxStubBld.h (modified) (1 diff)

trunk/src/VBox/Installer/win/StubBld/VBoxStubBld.cpp

@@ -39 +39 @@
 #include "VBoxStubBld.h"
 
-HRESULT GetFile (const char* pszFilePath,
-                 HANDLE* phFile,
-                 DWORD* pdwFileSize)
-{
-    HRESULT hr = S_OK;
-    *phFile = CreateFile(pszFilePath, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
-    if (INVALID_HANDLE_VALUE == *phFile)
-        hr = HRESULT_FROM_WIN32(GetLastError());
+
+static HRESULT GetFile(const char *pszFilePath, HANDLE *phFile, DWORD *pcbFile)
+{
+    HANDLE hFile = CreateFileA(pszFilePath, GENERIC_READ, FILE_SHARE_READ, NULL,
+                               OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
+    if (hFile != INVALID_HANDLE_VALUE)
+    {
+        SetLastError(NO_ERROR);
+        LARGE_INTEGER cbFile;
+        if (GetFileSizeEx(hFile, &cbFile))
+        {
+            if (cbFile.HighPart == 0)
+            {
+                *pcbFile = cbFile.LowPart;
+                *phFile  = hFile;
+                return S_OK;
+            }
+            fprintf(stderr, "error: File '%s' is too large: %llu bytes\n", pszFilePath, cbFile.QuadPart);
+        }
+        else
+            fprintf(stderr, "error: GetFileSizeEx failed on '%s': %lu\n", pszFilePath, GetLastError());
+        CloseHandle(hFile);
+    }
     else
-    {
-        *pdwFileSize = ::GetFileSize(*phFile, NULL);
-        if (!*pdwFileSize)
-            hr = HRESULT_FROM_WIN32(GetLastError());
-    }
-    return hr;
-}
-
-HRESULT UpdateResource(HANDLE hFile,
-                       DWORD dwFileSize,
-                       HANDLE hResourceUpdate,
-                       const char *pszResourceType,
-                       const char *pszResourceId)
-{
-    HRESULT hr = S_OK;
-
-    HANDLE hMap = CreateFileMapping(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
-    PVOID pvFile = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, dwFileSize);
-    if (!UpdateResourceA(hResourceUpdate, pszResourceType, pszResourceId,
-                         MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US), pvFile, dwFileSize))
-        hr = HRESULT_FROM_WIN32(GetLastError());
-
-    if (pvFile)
-        UnmapViewOfFile(pvFile);
-
-    if (hMap)
+        fprintf(stderr, "error: CreateFileA failed on '%s': %lu\n", pszFilePath, GetLastError());
+    *phFile = INVALID_HANDLE_VALUE;
+    return E_FAIL;
+}
+
+static HRESULT MyUpdateResource(HANDLE hFile, DWORD cbFile, HANDLE hResourceUpdate,
+                                const char *pszResourceType, const char *pszResourceId)
+{
+    HRESULT hr   = E_FAIL;
+    HANDLE  hMap = CreateFileMappingW(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
+    if (hMap != NULL)
+    {
+        PVOID pvFile = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, cbFile);
+        if (pvFile)
+        {
+            if (UpdateResourceA(hResourceUpdate, pszResourceType, pszResourceId,
+                                MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US), pvFile, cbFile))
+                hr = S_OK;
+            else
+                fprintf(stderr, "error: UpdateResourceA failed: %lu\n", GetLastError());
+
+            UnmapViewOfFile(pvFile);
+        }
+        else
+            fprintf(stderr, "error: MapViewOfFile failed: %lu\n", GetLastError());
         CloseHandle(hMap);
-
+    }
+    else
+        fprintf(stderr, "error: CreateFileMappingW failed: %lu\n", GetLastError());
     return hr;
 }
@@ -83 +99 @@
 {
     HANDLE hFile = INVALID_HANDLE_VALUE;
-    DWORD dwFileSize = 0;
-    HRESULT hr = GetFile(pszFilePath, &hFile, &dwFileSize);
+    DWORD cbFile = 0;
+    HRESULT hr = GetFile(pszFilePath, &hFile, &cbFile);
     if (SUCCEEDED(hr))
     {
-        hr = UpdateResource(hFile, dwFileSize, hResourceUpdate, pszResourceType, pszResourceId);
+        hr = MyUpdateResource(hFile, cbFile, hResourceUpdate, pszResourceType, pszResourceId);
         if (FAILED(hr))
             printf("ERROR: Error updating resource for file %s!", pszFilePath);
+        CloseHandle(hFile);
     }
     else
         hr = HRESULT_FROM_WIN32(GetLastError());
-
-    if (hFile != INVALID_HANDLE_VALUE)
-        CloseHandle(hFile);
     return hr;
 }
@@ -130 +144 @@
 int main(int argc, char* argv[])
 {
-    HRESULT hr = S_OK;
-    int rcExit = RTEXITCODE_SUCCESS;
-
-    char szSetupStub[_MAX_PATH] = {"VBoxStub.exe"};
-    char szOutput[_MAX_PATH] = {"VirtualBox-MultiArch.exe"};
-    HANDLE hUpdate = NULL;
-
-    do /* goto avoidance "loop" */
-    {
-        printf(VBOX_PRODUCT " Stub Builder v%d.%d.%d.%d\n",
-               VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD, VBOX_SVN_REV);
-
-        if (argc < 2)
-            printf("WARNING: No parameters given! Using default values!\n");
-
-        VBOXSTUBBUILDPKG stbBuildPkg[VBOXSTUB_MAX_PACKAGES] = {{{0}}};
-        VBOXSTUBPKG stbPkg[VBOXSTUB_MAX_PACKAGES] = {{0}};
-        VBOXSTUBPKGHEADER stbHeader =
-        {
-            "vbox$tub",    /* File magic. */
-            1,             /* Version. */
-            0              /* No files yet. */
-        };
-
-        for (int i=1; i<argc; i++)
-        {
-            if (!stricmp(argv[i], "-out") && argc > i+1)
-            {
-                hr = StringCchCopy(szOutput, _MAX_PATH, argv[i+1]);
-                i++;
-            }
-
-            else if (!stricmp(argv[i], "-stub") && argc > i+1)
-            {
-                hr = StringCchCopy(szSetupStub, _MAX_PATH, argv[i+1]);
-                i++;
-            }
-
-            else if (!stricmp(argv[i], "-target-all") && argc > i+1)
-            {
-                hr = StringCchCopy(stbBuildPkg[stbHeader.byCntPkgs].szSourcePath, _MAX_PATH, argv[i+1]);
-                stbBuildPkg[stbHeader.byCntPkgs].byArch = VBOXSTUBPKGARCH_ALL;
-                stbHeader.byCntPkgs++;
-                i++;
-            }
-
-            else if (!stricmp(argv[i], "-target-x86") && argc > i+1)
-            {
-                hr = StringCchCopy(stbBuildPkg[stbHeader.byCntPkgs].szSourcePath, _MAX_PATH, argv[i+1]);
-                stbBuildPkg[stbHeader.byCntPkgs].byArch = VBOXSTUBPKGARCH_X86;
-                stbHeader.byCntPkgs++;
-                i++;
-            }
-
-            else if (!stricmp(argv[i], "-target-amd64") && argc > i+1)
-            {
-                hr = StringCchCopy(stbBuildPkg[stbHeader.byCntPkgs].szSourcePath, _MAX_PATH, argv[i+1]);
-                stbBuildPkg[stbHeader.byCntPkgs].byArch = VBOXSTUBPKGARCH_AMD64;
-                stbHeader.byCntPkgs++;
-                i++;
-            }
+    /*
+     * Parse arguments.
+     */
+    const char *pszSetupStub = "VBoxStub.exe";
+    const char *pszOutput    = "VirtualBox-MultiArch.exe";
+
+    printf(VBOX_PRODUCT " Stub Builder v%d.%d.%d.%d\n",
+           VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD, VBOX_SVN_REV);
+
+    struct VBOXSTUBBUILDPKG
+    {
+        const char     *pszSrcPath;
+        VBOXSTUBPKGARCH enmArch;
+    }                   aBuildPkgs[VBOXSTUB_MAX_PACKAGES] = { { NULL } };
+    VBOXSTUBPKGHEADER   StubHdr =
+    {
+        /*.szMagic = */   VBOXSTUBPKGHEADER_MAGIC_SZ,
+        /*.cPackages = */ 0
+    };
+
+    for (int i = 1; i < argc; i++)
+    {
+        const char *pszArg = argv[i];
+        if (   strcmp(pszArg, "--help") == 0
+            || strcmp(pszArg, "-help") == 0
+            || strcmp(pszArg, "-h") == 0
+            || strcmp(pszArg, "-?") == 0)
+        {
+            printf("usage: %s -out <installer.exe> -stub <stub.exe> [-target-all <file>] [-target-<arch> <file>]\n", argv[0]);
+            return RTEXITCODE_SUCCESS;
+        }
+
+        /* The remaining options all take a while. */
+        if (   strcmp(pszArg, "-out")
+            && strcmp(pszArg, "-stub")
+            && strcmp(pszArg, "-target-all")
+            && strcmp(pszArg, "-target-x86")
+            && strcmp(pszArg, "-target-amd64"))
+        {
+            fprintf(stderr, "syntax error: Invalid parameter: %s\n", argv[i]);
+            return RTEXITCODE_SYNTAX;
+        }
+
+        i++;
+        if (i >= argc)
+        {
+            fprintf(stderr, "syntax error: Option '%s' takes a value argument!\n", pszArg);
+            return RTEXITCODE_SYNTAX;
+        }
+        const char *pszValue = argv[i];
+
+        /* Process the individual options. */
+        if (strcmp(pszArg, "-out") == 0)
+            pszOutput = pszValue;
+        else if (strcmp(pszArg, "-stub") == 0)
+            pszSetupStub = pszValue;
+        else
+        {
+            if (StubHdr.cPackages >= RT_ELEMENTS(aBuildPkgs))
+            {
+                fprintf(stderr, "error: Too many packages specified!\n");
+                return RTEXITCODE_FAILURE;
+            }
+            aBuildPkgs[StubHdr.cPackages].pszSrcPath = pszValue;
+            if (strcmp(pszArg, "-target-all") == 0)
+                aBuildPkgs[StubHdr.cPackages].enmArch = VBOXSTUBPKGARCH_ALL;
+            else if (strcmp(pszArg, "-target-amd64") == 0)
+                aBuildPkgs[StubHdr.cPackages].enmArch = VBOXSTUBPKGARCH_AMD64;
+            else if (strcmp(pszArg, "-target-x86") == 0)
+                aBuildPkgs[StubHdr.cPackages].enmArch = VBOXSTUBPKGARCH_X86;
             else
             {
-                printf("ERROR: Invalid parameter: %s\n", argv[i]);
-                hr = E_INVALIDARG;
-                break;
-            }
-            if (FAILED(hr))
-            {
-                printf("ERROR: StringCchCopy failed: %#lx\n", hr);
-                break;
-            }
-        }
-        if (FAILED(hr))
-            break;
-
-        if (stbHeader.byCntPkgs <= 0)
-        {
-            printf("ERROR: No packages defined! Exiting.\n");
-            break;
-        }
-
-        printf("Stub: %s\n", szSetupStub);
-        printf("Output: %s\n", szOutput);
-        printf("# Packages: %u\n", stbHeader.byCntPkgs);
-
-        if (!CopyFile(szSetupStub, szOutput, FALSE))
-        {
-            hr = HRESULT_FROM_WIN32(GetLastError());
-            printf("ERROR: Could not create stub loader: %#lx\n", hr);
-            break;
-        }
-
-        hUpdate = BeginUpdateResource(szOutput, FALSE);
-
-        PVBOXSTUBPKG pPackage = stbPkg;
-        char szHeaderName[_MAX_PATH] = {0};
-
-        for (BYTE i = 0; i < stbHeader.byCntPkgs; i++)
-        {
-            printf("Integrating (Platform %d): %s\n", stbBuildPkg[i].byArch, stbBuildPkg[i].szSourcePath);
-
-            /* Construct resource name. */
-            hr = StringCchPrintf(pPackage->szResourceName, _MAX_PATH, "BIN_%02d", i);
-            pPackage->byArch = stbBuildPkg[i].byArch;
+                fprintf(stderr, "internal error: %u\n", __LINE__);
+                return RTEXITCODE_FAILURE;
+            }
+            StubHdr.cPackages++;
+        }
+    }
+
+    if (StubHdr.cPackages == 0)
+    {
+        fprintf(stderr, "syntax error: No packages specified! Exiting.\n");
+        return RTEXITCODE_SYNTAX;
+    }
+
+    printf("Stub:       %s\n", pszSetupStub);
+    printf("Output:     %s\n", pszOutput);
+    printf("# Packages: %u\n", StubHdr.cPackages);
+
+    /*
+     * Copy the stub over the output file.
+     */
+    if (!CopyFile(pszSetupStub, pszOutput, FALSE))
+    {
+        fprintf(stderr, "ERROR: Could not copy the stub loader: %lu\n", GetLastError());
+        return RTEXITCODE_SYNTAX;
+    }
+
+    /*
+     * Start updating the resources of the output file.
+     */
+    HANDLE hUpdate = BeginUpdateResourceA(pszOutput, FALSE);
+    if (hUpdate)
+    {
+        /*
+         * Add the file one by one to the output file.
+         */
+        HRESULT hrc = S_OK;
+        for (BYTE i = 0; i < StubHdr.cPackages; i++)
+        {
+            printf("Integrating (Platform %d): %s\n", aBuildPkgs[i].enmArch, aBuildPkgs[i].pszSrcPath);
+
+            /*
+             * Create the package header.
+             */
+            VBOXSTUBPKG Package = {0};
+            Package.enmArch = aBuildPkgs[i].enmArch;
+
+            /* The resource name */
+            hrc = StringCchPrintf(Package.szResourceName, sizeof(Package.szResourceName), "BIN_%02d", i);
+            if (FAILED(hrc))
+            {
+                fprintf(stderr, "Internal error: %u\n", __LINE__);
+                break;
+            }
 
             /* Construct final name used when extracting. */
-            hr = StringCchCopy(pPackage->szFileName, _MAX_PATH, MyPathFilename(stbBuildPkg[i].szSourcePath));
-
-            /* Integrate header into binary. */
-            hr = StringCchPrintf(szHeaderName, _MAX_PATH, "HDR_%02d", i);
-            hr = UpdateResource(hUpdate, RT_RCDATA, szHeaderName, MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US), pPackage, sizeof(VBOXSTUBPKG));
-
-            /* Integrate file into binary. */
-            hr = IntegrateFile(hUpdate, RT_RCDATA, pPackage->szResourceName, stbBuildPkg[i].szSourcePath);
-            if (FAILED(hr))
-            {
-                printf("ERROR: Could not integrate binary %s (%s): %#lx\n",
-                         pPackage->szResourceName, pPackage->szFileName, hr);
-                rcExit = RTEXITCODE_FAILURE;
-            }
-
-            pPackage++;
-        }
-
-        if (FAILED(hr))
-            break;
-
-        if (!UpdateResource(hUpdate, RT_RCDATA, "MANIFEST", MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US), &stbHeader, sizeof(VBOXSTUBPKGHEADER)))
-        {
-            hr = HRESULT_FROM_WIN32(GetLastError());
-            break;
-        }
-
-        if (!EndUpdateResource(hUpdate, FALSE))
-        {
-            hr = HRESULT_FROM_WIN32(GetLastError());
-            break;
-        }
-
-        printf("Integration done!\n");
-
-    } while (0);
-
-    hUpdate = NULL;
-
-    if (FAILED(hr))
-    {
-        printf("ERROR: Building failed! Last error: %lu\n", GetLastError());
-        rcExit = RTEXITCODE_FAILURE;
-    }
-    return rcExit;
-}
+            hrc = StringCchCopy(Package.szFilename, sizeof(Package.szFilename), MyPathFilename(aBuildPkgs[i].pszSrcPath));
+            if (FAILED(hrc))
+            {
+                fprintf(stderr, "ERROR: Filename is too long: %s\n", aBuildPkgs[i].pszSrcPath);
+                break;
+            }
+
+            /*
+             * Add the package header to the binary.
+             */
+            char szHeaderName[32];
+            hrc = StringCchPrintf(szHeaderName, sizeof(szHeaderName), "HDR_%02d", i);
+            if (FAILED(hrc))
+            {
+                fprintf(stderr, "Internal error: %u\n", __LINE__);
+                break;
+            }
+
+            if (!UpdateResourceA(hUpdate, RT_RCDATA, szHeaderName, MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
+                                 &Package, sizeof(Package)))
+            {
+                fprintf(stderr, "ERROR: UpdateResourceA failed for the package header: %lu\n", GetLastError());
+                hrc = E_FAIL;
+                break;
+            }
+
+            /*
+             * Add the file content under the BIN_xx resource name.
+             */
+            hrc = IntegrateFile(hUpdate, RT_RCDATA, Package.szResourceName, aBuildPkgs[i].pszSrcPath);
+            if (FAILED(hrc))
+                break;
+        }
+        if (SUCCEEDED(hrc))
+        {
+            /*
+             * Now add the header/manifest and complete the operation.
+             */
+            if (UpdateResourceA(hUpdate, RT_RCDATA, "MANIFEST", MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
+                                &StubHdr, sizeof(StubHdr)))
+            {
+                if (EndUpdateResourceA(hUpdate, FALSE /*fDiscard*/))
+                {
+                    printf("Successfully created the installer\n");
+                    return RTEXITCODE_SUCCESS;
+                }
+                fprintf(stderr, "ERROR: EndUpdateResourceA failed: %lu\n", GetLastError());
+            }
+            else
+                fprintf(stderr, "ERROR: UpdateResourceA failed for the installer header/manifest: %lu\n", GetLastError());
+        }
+
+        EndUpdateResourceA(hUpdate, TRUE /*fDiscard*/);
+        hUpdate = NULL;
+    }
+    else
+        fprintf(stderr, "error: BeginUpdateResource failed: %lu\n", GetLastError());
+    return RTEXITCODE_FAILURE;
+}

trunk/src/VBox/Installer/win/StubBld/VBoxStubBld.h

@@ -32 +32 @@
 #endif
 
+#include <iprt/types.h>
+#include <iprt/assertcompile.h>
+
+/**/
 #define VBOXSTUB_MAX_PACKAGES 128
 
+/** */
+#define VBOXSTUBPKGHEADER_MAGIC_SZ  "VBoxInstV1\0\0\0\0"
+
+/**
+ * VBox installer stub header, aka "MANIFEST".
+ *
+ * This just holds the number of packages present in the image.
+ */
 typedef struct VBOXSTUBPKGHEADER
 {
-    /** Some magic string not defined by this header? Turns out it's a write only
-     *  field... */
-    char    szMagic[9];
-    /* Inbetween szMagic and dwVersion there are 3 bytes of implicit padding. */
-    /** Some version number not defined by this header? Also write only field.
-     *  Should be a uint32_t, not DWORD. */
-    DWORD   dwVersion;
-    /** Number of packages following the header. byte is prefixed 'b', not 'by'!
-     *  Use uint8_t instead of BYTE. */
-    BYTE    byCntPkgs;
-    /* There are 3 bytes of implicit padding here. */
+    /** Magic value/string (VBOXSTUBPKGHEADER_MAGIC_SZ) */
+    char    szMagic[11 + 4];
+    /** Number of packages following the header. */
+    uint8_t cPackages;
 } VBOXSTUBPKGHEADER;
+AssertCompileSize(VBOXSTUBPKGHEADER, 16);
 typedef VBOXSTUBPKGHEADER *PVBOXSTUBPKGHEADER;
 
 typedef enum VBOXSTUBPKGARCH
 {
-    VBOXSTUBPKGARCH_ALL = 0,
+    /** Always extract.   */
+    VBOXSTUBPKGARCH_ALL = 1,
+    /** Extract on x86 hosts. */
     VBOXSTUBPKGARCH_X86,
+    /** Extract on AMD64 hosts. */
     VBOXSTUBPKGARCH_AMD64
 } VBOXSTUBPKGARCH;
 
+/**
+ * Package header/descriptor.
+ *
+ * This is found as "HDR_xx" where xx is replaced by the decimal package number,
+ * zero padded to two digits.
+ */
 typedef struct VBOXSTUBPKG
 {
-    BYTE byArch;
-    /** Probably the name of the PE resource or something, read the source to
-     *  find out for sure.  Don't use _MAX_PATH, define your own max lengths! */
-    char szResourceName[_MAX_PATH];
-    char szFileName[_MAX_PATH];
+    /** The architecture for the file. */
+    VBOXSTUBPKGARCH enmArch;
+    /** The name of the resource holding the file bytes.
+     * This is a pointless field, because the resource name is "BIN_xx"
+     * corresponding to the name of the resource containing this struct. */
+    char szResourceName[28];
+    /** The filename.   */
+    char szFilename[224];
 } VBOXSTUBPKG;
+AssertCompileSize(VBOXSTUBPKG, 256);
 typedef VBOXSTUBPKG *PVBOXSTUBPKG;
 
-/* Only for construction. */
-/* Since it's only used by VBoxStubBld.cpp, why not just keep it there? */
-
-typedef struct VBOXSTUBBUILDPKG
-{
-    char szSourcePath[_MAX_PATH];
-    BYTE byArch;
-} VBOXSTUBBUILDPKG;
-typedef VBOXSTUBBUILDPKG *PVBOXSTUBBUILDPKG;
-
 #endif /* !VBOX_INCLUDED_SRC_StubBld_VBoxStubBld_h */