Add hookcheck utility program

Author: botder

utils/hookcheck.exe

@@ -0,0 +1,45 @@
+@echo off
+set "VSWHERE=%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe"
+if exist "%VSWHERE%" goto :FindVisualStudio
+
+echo Unable to locate Visual Studio: vswhere not found
+echo ^>^> %VSWHERE%
+pause
+exit /b 1
+
+:FindVisualStudio
+for /f "usebackq tokens=*" %%i in (`call "%VSWHERE%" -latest -requires Microsoft.Component.MSBuild -find "**\VsDevCmd.bat"`) do (
+    set VSDEVCMD=%%i
+)
+
+if defined VSDEVCMD goto :SetupEnv
+echo Visual Studio not found
+echo Make sure you've installed the 'Desktop development with C++' workload
+pause
+exit /b 1
+
+:SetupEnv
+echo Found Visual Studio environment setup batch file:
+echo ^>^> %VSDEVCMD%
+call "%VSDEVCMD%" -arch=amd64 -host_arch=amd64 >NUL
+
+where MSBuild.exe >NUL 2>&1
+if %ERRORLEVEL% == 0 goto :Build
+echo MSBuild not found
+echo Make sure you've installed the 'Desktop development with C++' workload
+pause
+exit /b 1
+
+:Build
+call create-solution.bat < NUL
+
+MSBuild.exe build\utility.sln ^
+    -target:hookcheck ^
+    -property:Configuration=Release ^
+    -property:Platform=x64 ^
+    -maxCpuCount
+
+copy build\bin\Release\*.dll ..\..\ >NUL
+copy build\bin\Release\hookcheck.exe ..\..\ >NUL
+
+if %0 == "%~0" pause

utils/msdia140.dll

@@ -0,0 +1,3 @@
+@echo off
+..\..\premake5.exe vs2022
+if %0 == "%~0" pause

utils/src/hookcheck/build-solution.bat

@@ -0,0 +1,200 @@
+/*****************************************************************************
+ *
+ *  PROJECT:     Multi Theft Auto
+ *  LICENSE:     See LICENSE in the top level directory
+ *  FILE:        utils/src/hookcheck/dll-analyzer.cpp
+ *  PURPOSE:     Implementation for a class that can extract both the PDB file
+ *               path and the value of the __LOCAL_SIZE assignment from our
+ *               special macro.
+ *
+ *  Multi Theft Auto is available from https://multitheftauto.com/
+ *
+ *****************************************************************************/
+
+#include "dll-analyzer.h"
+
+#include <string>
+#include <cstddef>
+#include <filesystem>
+
+#define NOMINMAX
+#define WIN32_LEAN_AND_MEAN
+#include <Windows.h>
+
+namespace fs = std::filesystem;
+
+static const std::string EmptyString;
+
+struct CV_INFO_PDB70
+{
+    DWORD CvSignature;
+    GUID  Guid;
+    DWORD Age;
+    char  PdbFileName[1];
+};
+
+DllAnalyzer::DllAnalyzer() = default;
+
+DllAnalyzer::~DllAnalyzer()
+{
+    Unload();
+}
+
+auto DllAnalyzer::LoadDll(const std::wstring& dll) -> std::pair<LoadError, HRESULT>
+{
+    using enum LoadError;
+
+    HANDLE fileHandle = CreateFileW(dll.c_str(), GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, 0, nullptr);
+
+    if (fileHandle == INVALID_HANDLE_VALUE)
+    {
+        const auto hr = HRESULT_FROM_WIN32(GetLastError());
+        return std::make_pair(OpenDll, hr);
+    }
+
+    HANDLE mapping = CreateFileMappingW(fileHandle, nullptr, PAGE_READONLY, 0, 0, nullptr);
+    if (!mapping)
+    {
+        const auto hr = HRESULT_FROM_WIN32(GetLastError());
+        CloseHandle(fileHandle);
+        return std::make_pair(CreateMapping, hr);
+    }
+
+    LPVOID fileView = MapViewOfFile(mapping, FILE_MAP_READ, 0, 0, 0);
+    if (!fileView)
+    {
+        const auto hr = HRESULT_FROM_WIN32(GetLastError());
+        CloseHandle(mapping);
+        CloseHandle(fileHandle);
+        return std::make_pair(CreateView, hr);
+    }
+
+    const auto base = reinterpret_cast<const std::byte*>(fileView);
+    const auto dos = reinterpret_cast<const IMAGE_DOS_HEADER*>(fileView);
+
+    if (dos->e_magic != IMAGE_DOS_SIGNATURE)
+    {
+        UnmapViewOfFile(fileView);
+        CloseHandle(mapping);
+        CloseHandle(fileHandle);
+        return std::make_pair(DosSignature, E_UNEXPECTED);
+    }
+
+    const auto nt = reinterpret_cast<const _IMAGE_NT_HEADERS*>(base + dos->e_lfanew);
+
+    if (nt->Signature != IMAGE_NT_SIGNATURE)
+    {
+        UnmapViewOfFile(fileView);
+        CloseHandle(mapping);
+        CloseHandle(fileHandle);
+        return std::make_pair(NtSignature, E_UNEXPECTED);
+    }
+
+    if (nt->FileHeader.Machine != IMAGE_FILE_MACHINE_I386 || nt->OptionalHeader.Magic != IMAGE_NT_OPTIONAL_HDR32_MAGIC)
+    {
+        UnmapViewOfFile(fileView);
+        CloseHandle(mapping);
+        CloseHandle(fileHandle);
+        return std::make_pair(ImageArch, E_UNEXPECTED);
+    }
+
+    m_file = fileHandle;
+    m_mapping = mapping;
+    m_view = fileView;
+    m_nt = nt;
+    return std::make_pair(None, S_OK);
+}
+
+void DllAnalyzer::Unload()
+{
+    if (m_view)
+    {
+        UnmapViewOfFile(m_view);
+        m_view = {};
+        m_nt = {};
+    }
+
+    if (m_mapping)
+    {
+        CloseHandle(m_mapping);
+        m_mapping = {};
+    }
+
+    if (m_file)
+    {
+        CloseHandle(m_file);
+        m_file = {};
+    }
+}
+
+auto DllAnalyzer::ExtractPdbPath() const -> std::pair<ExtractError, std::string>
+{
+    using enum ExtractError;
+
+    if (!m_nt)
+        return std::make_pair(NotLoaded, EmptyString);
+
+    const auto base = reinterpret_cast<const std::byte*>(m_view);
+    const auto opt32 = reinterpret_cast<const IMAGE_OPTIONAL_HEADER32*>(&m_nt->OptionalHeader);
+    const auto ddir = &opt32->DataDirectory[IMAGE_DIRECTORY_ENTRY_DEBUG];
+
+    if (!ddir->Size)
+        return std::make_pair(NoDebugDirectory, EmptyString);
+
+    const auto rva = ddir->VirtualAddress;
+    auto       section = IMAGE_FIRST_SECTION(m_nt);
+
+    for (WORD i = 0; i < m_nt->FileHeader.NumberOfSections; ++i, ++section)
+    {
+        const auto rvaBegin = section->VirtualAddress;
+        const auto rvaEnd = rvaBegin + section->SizeOfRawData;
+
+        if (rva < rvaBegin || rva >= rvaEnd)
+            continue;
+
+        auto        entry = reinterpret_cast<const IMAGE_DEBUG_DIRECTORY*>(base + section->PointerToRawData + (rva - rvaBegin));
+        const DWORD numEntries = ddir->Size / sizeof(IMAGE_DEBUG_DIRECTORY);
+
+        for (DWORD j = 0; j < numEntries; ++j, ++entry)
+        {
+            if (entry->Type == IMAGE_DEBUG_TYPE_CODEVIEW)
+            {
+                const auto info = reinterpret_cast<const CV_INFO_PDB70*>(base + entry->PointerToRawData);
+
+                if (info->CvSignature == 'SDSR')
+                {
+                    return std::make_pair(None, std::string{ info->PdbFileName });
+                }
+            }
+        }
+
+        break;
+    }
+
+    return std::make_pair(NotFound, EmptyString);
+}
+
+auto DllAnalyzer::GetLocalSize(DWORD virtualAddress) -> std::optional<DWORD>
+{
+    if (!m_nt)
+        return std::nullopt;
+
+    const auto base = reinterpret_cast<const std::byte*>(m_view);
+    auto       section = IMAGE_FIRST_SECTION(m_nt);
+
+    for (WORD i = 0; i < m_nt->FileHeader.NumberOfSections; ++i, ++section)
+    {
+        const auto rvaBegin = section->VirtualAddress;
+        const auto rvaEnd = rvaBegin + section->SizeOfRawData;
+
+        if (virtualAddress < rvaBegin || virtualAddress >= rvaEnd)
+            continue;
+
+        // B8 00 00 00 00 | mov eax, __LOCAL_SIZE
+        // We must skip a singular byte (0xB8 for mov) to retrieve the value of __LOCAL_SIZE.
+        auto value = reinterpret_cast<const DWORD*>(base + section->PointerToRawData + (virtualAddress - rvaBegin) + 1);
+        return *value;
+    }
+
+    return std::nullopt;
+}

utils/src/hookcheck/create-solution.bat

@@ -0,0 +1,97 @@
+/*****************************************************************************
+ *
+ *  PROJECT:     Multi Theft Auto
+ *  LICENSE:     See LICENSE in the top level directory
+ *  FILE:        utils/src/hookcheck/dll-analyzer.h
+ *  PURPOSE:     Header for a class that can extract both the PDB file path
+ *               and the value of the __LOCAL_SIZE assignment from our special
+ *               macro.
+ *
+ *  Multi Theft Auto is available from https://multitheftauto.com/
+ *
+ *****************************************************************************/
+
+#pragma once
+
+#include <utility>
+#include <string>
+#include <optional>
+
+using HRESULT = long;
+using HANDLE = void*;
+using LPVOID = void*;
+using DWORD = unsigned long;
+using ULONGLONG = unsigned long long;
+
+struct _IMAGE_NT_HEADERS;
+
+class DllAnalyzer final
+{
+public:
+    enum class LoadError
+    {
+        None,
+        OpenDll,
+        CreateMapping,
+        CreateView,
+        DosSignature,
+        NtSignature,
+        ImageArch,
+    };
+
+    enum class ExtractError
+    {
+        None,
+        NotLoaded,
+        NoDebugDirectory,
+        NotFound,
+    };
+
+public:
+    DllAnalyzer();
+    ~DllAnalyzer();
+
+    DllAnalyzer(const DllAnalyzer&) = delete;
+    DllAnalyzer& operator=(const DllAnalyzer&) = delete;
+
+    DllAnalyzer(DllAnalyzer&&) noexcept = default;
+    DllAnalyzer& operator=(DllAnalyzer&&) noexcept = default;
+
+public:
+    /**
+     * @brief Loads a DLL (Dynamic-Link Library) file.
+     * @param dll The path to the DLL file to load.
+     * @return A pair consisting of a LoadError value indicating the generic error of the load operation,
+     *         and an HRESULT code providing additional status information.
+     */
+    [[nodiscard]]
+    auto LoadDll(const std::wstring& dll) -> std::pair<LoadError, HRESULT>;
+
+    /**
+     * @brief Releases or unloads resources.
+     */
+    void Unload();
+
+    /**
+     * @brief Extracts the path to the PDB (Program Database) file.
+     * @return A pair consisting of a ExtractError value indicating an error and an empty string on failure,
+     *         or a pair consisting of ExtractError::None and the path to the PDB file on success.
+     */
+    [[nodiscard]]
+    auto ExtractPdbPath() const -> std::pair<ExtractError, std::string>;
+
+    /**
+     * @brief Retrieves the value of __LOCAL_SIZE using the virtual address of the label before it.
+     * @param virtualAddress The virtual address of the label before the assignment.
+     * @return The value of __LOCAL_SIZE on success, otherwise an empty value on failure.
+     */
+    [[nodiscard]]
+    auto GetLocalSize(DWORD virtualAddress) -> std::optional<DWORD>;
+
+private:
+    HANDLE m_file{};
+    HANDLE m_mapping{};
+    LPVOID m_view{};
+
+    const _IMAGE_NT_HEADERS* m_nt{};
+};