Merge pull request #24 from Pika-Software/dev

Update `HandleFileChange` signatures

Author: dankmolot

.gitignore

@@ -1,3 +1,4 @@
 .vscode
 /build*
-.DS_Store
+.DS_Store
+CMakeUserPresets.json

CMakeLists.txt

@@ -1,12 +1,4 @@
 cmake_minimum_required(VERSION 3.22)
-enable_language(CXX C)
-
-# Require C++ 17
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-
-# Enable -fPIC flag
-set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 # Enable IDE folders
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
@@ -21,34 +13,8 @@ if(APPLE)
     )
 endif()
 
-# Debug build is unsupported on MSVC
-if(MSVC)
-    list(REMOVE_ITEM CMAKE_CONFIGURATION_TYPES "Debug")
-endif()
-
-# Force old ABI for Linux, since Garry's Mod ABI is used
-if(UNIX AND NOT APPLE)
-    add_compile_definitions(_GLIBCXX_USE_CXX11_ABI=0)
-endif()
-
-# Include extensions
-add_subdirectory(cmake)
-
-# Entropia File System Watcher
-add_subdirectory(third-party/efsw)
-
-# Include embedded lua
-# add_subdirectory(third-party/lua)
-add_subdirectory(third-party/lpeg)
-
-# Add moonengine library
-add_subdirectory(moonengine)
-
-# Include garrysmod_common
-find_garrysmod_common()
-if(NOT GARRYSMOD_COMMON_FOUND) # Check if garrysmod_common has been found
-    message(FATAL_ERROR "garrysmod_common not found")
-endif()
+# Allow CMake find custom package finders
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
 # Get the latest abbreviated commit hash of the working branch
 execute_process(
@@ -71,8 +37,41 @@ endif()
 file(STRINGS "VERSION" GM_MOONLOADER_VERSION)
 project(gm_moonloader 
     VERSION ${GM_MOONLOADER_VERSION}
-    LANGUAGES CXX 
+    LANGUAGES CXX C
     HOMEPAGE_URL "https://github.com/Pika-Software/gm_moonloader"
 )
 
+# Require C++ 17
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Enable -fPIC flag
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+# Debug build is unsupported on MSVC
+if(MSVC)
+    list(REMOVE_ITEM CMAKE_CONFIGURATION_TYPES "Debug")
+endif()
+
+# Force old ABI for Linux, since Garry's Mod ABI is used
+if(UNIX AND NOT APPLE)
+    add_compile_definitions(_GLIBCXX_USE_CXX11_ABI=0)
+endif()
+
+# Include extensions
+add_subdirectory(cmake)
+
+# Entropia File System Watcher
+add_subdirectory(third-party/efsw)
+
+# Include embedded lua
+# add_subdirectory(third-party/lua)
+add_subdirectory(third-party/lpeg)
+
+# Add moonengine library
+add_subdirectory(moonengine)
+
+# Include garrysmod_common
+find_package(GarrysmodCommon REQUIRED)
+
 add_subdirectory(source)

VERSION

@@ -1 +1 @@
-2.1.7
+2.1.8

cmake/CMakeLists.txt

@@ -1,4 +1,3 @@
-include(find_garrysmod_common.cmake)
 include(CMakeRC.cmake)
 include(find_Yuescript.cmake)
 include(find_lua52.cmake)

cmake/FindGarrysmodCommon.cmake

@@ -0,0 +1,10 @@
+message(STATUS "Looking for garrysmod_common...")
+set(GARRYSMOD_COMMON_PATH "GARRYSMOD_COMMON_NOT_FOUND" CACHE PATH "Path to garrysmod_common (https://github.com/dankmolot/garrysmod_common/tree/master-cmake)")
+cmake_path(ABSOLUTE_PATH GARRYSMOD_COMMON_PATH NORMALIZE)
+
+if(NOT IS_DIRECTORY ${GARRYSMOD_COMMON_PATH} OR NOT EXISTS ${GARRYSMOD_COMMON_PATH}/CMakeLists.txt OR ${GARRYSMOD_COMMON_PATH} STREQUAL ${CMAKE_CURRENT_LIST_DIR})
+    message(FATAL_ERROR "Invalid path to garrysmod_common. Please set valid GARRYSMOD_COMMON_PATH")
+endif()
+
+add_subdirectory(${GARRYSMOD_COMMON_PATH} ${CMAKE_BINARY_DIR}/garrysmod_common)
+set(GarrysmodCommon_FOUND TRUE)

cmake/find_garrysmod_common.cmake

@@ -7,12 +7,7 @@
 #include <Platform.hpp>
 
 #if IS_SERVERSIDE
-#if ARCHITECTURE_IS_X86
-#include <Color.h>
-#else
 #include <color.h>
-#endif
-
 #include <unordered_set>
 #else
 struct Color {

source/global.hpp

@@ -20,7 +20,7 @@ GMOD_MODULE_OPEN() {
         core->Deinitialize();
         core.reset();
 
-        ILUA->ThrowError(Utils::Format("error during moonloader core initialization: %s", e.what()).c_str());
+        ILUA->ThrowError(Utils::Format("[Moonloader] Fatal error: %s", e.what()).c_str());
     }
 
     return 0;
@@ -39,4 +39,4 @@ GMOD_MODULE_CLOSE() {
     }
 
     return 0;
-}
+}

source/main.cpp

@@ -4,6 +4,7 @@
 #include "filesystem.hpp"
 #include "utils.hpp"
 #include "core.hpp"
+#include "config.hpp"
 
 #include <tier0/dbg.h>
 #include <chrono>
@@ -14,52 +15,51 @@
 #include <scanning/symbolfinder.hpp>
 #include <detouring/hook.hpp>
 
-#if SYSTEM_IS_WINDOWS
-    #if ARCHITECTURE_IS_X86
-        #define GMCOMMON_CALLING_CONVENTION __stdcall
-    #else
-        #define GMCOMMON_CALLING_CONVENTION __fastcall
-    #endif
-#else
-    #define GMCOMMON_CALLING_CONVENTION
-#endif
-
 namespace Symbols {
-    typedef void (GMCOMMON_CALLING_CONVENTION *HandleFileChange_t)(const std::string& path);
+    typedef void (GMCOMMON_CALLING_CONVENTION_STD *HandleFileChange_t)(const std::string& path);
 
     std::vector<Symbol> HandleFileChange = {
 #if ARCHITECTURE_IS_X86
     #if SYSTEM_IS_WINDOWS
-        Symbol::FromSignature("\x55\x8b\xec\x83\xec\x60\x56\x8b\x75\x08\x8d\x45\xd0\x57\x56\x50\xe8\x2A\x2A\x2A\x00\x83\xc4\x08\x83\x7d\xe0\x00\x0f\x84\x60\x02"),
+        Symbol::FromSignature("\x55\x8b\xec\x83\xec\x60\x56\x8b\x75\x08\x8d\x45\xd0\x56\x50\xe8\x2A\x2A\x2A\x2A\x83\xc4\x08\x83\x7d\xe0\x00\x0f\x84"),
     #elif SYSTEM_IS_LINUX
-        Symbol::FromSignature("\x55\x89\xe5\x57\x56\x53\x8d\x5d\x98\x83\xec\x7c\x8b\x75\x08\x89\x1c\x24\x89\x74\x24\x04\xe8\x2A\x2A\x2A\x00\x8b\x45\x98\x83\xec"),
+        Symbol::FromSignature("\x55\x89\xe5\x57\x56\x53\x8d\x5d\x98\x83\xec\x7c\x8b\x75\x08\x89\x1c\x24\x89\x74\x24\x04\xe8\x2A\x2A\x2A\x2A\x8b\x45\x98\x83\xec\x04\x8b\x50\xf4\x85\xd2\x0f\x84"),
     #endif
 #elif ARCHITECTURE_IS_X86_64
     #if SYSTEM_IS_WINDOWS
-        Symbol::FromSignature("\x48\x89\x5c\x24\x10\x48\x89\x74\x24\x18\x48\x89\x7c\x24\x20\x55\x48\x8d\x6c\x24\xa9\x48\x81\xec\xb0\x00\x00\x00\x48\x8b\x05\x2A"),
+        Symbol::FromSignature("\x48\x89\x5c\x24\x10\x48\x89\x74\x24\x18\x48\x89\x7c\x24\x20\x55\x48\x8d\x6c\x24\xa9\x48\x81\xec\xb0\x00\x00\x00\x48\x8b\x05\x2A\x2A\x2A\x2A\x48\x33\xc4\x48\x89\x45\x47\x48\x8b\xf9\x48\x8b\xd1\x48\x8d\x4d\xc7\xe8\x2A\x2A\x2A\x2A\x48\x83\x7d\xd7\x00\x0f\x84"),
     #elif SYSTEM_IS_LINUX
-        Symbol::FromSignature("\x55\x48\x89\xfe\x48\x89\xe5\x41\x57\x41\x56\x41\x55\x41\x54\x4c\x8d\x65\x80\x53\x48\x89\xfb\x4c\x89\xe7\x48\x83\xec\x68\xe8\x2A")
+        Symbol::FromSignature("\x55\x48\x89\xfe\x48\x89\xe5\x41\x57\x41\x56\x41\x55\x41\x54\x4c\x8d\x65\x80\x53\x48\x89\xfb\x4c\x89\xe7\x48\x83\xec\x68\xe8\x2A\x2A\x2A\x2A\x48\x8b\x45\x80\x48\x83\x78\xe8\x00\x75")
     #elif SYSTEM_IS_MACOSX
-        Symbol::FromSignature("\x55\x48\x89\xe5\x53\x48\x81\xec\x88\x00\x00\x00\x48\x89\xfb\x48\x8d\x7d\xc8\x48\x89\xde\xe8\x2A\x2A\x2A\x00\x8a\x4d\xc8\x89\xc8"),
+        Symbol::FromSignature("\x55\x48\x89\xe5\x53\x48\x81\xec\x88\x00\x00\x00\x48\x89\xfb\x48\x8d\x7d\xc8\x48\x89\xde\xe8\x2A\x2A\x2A\x2A\x8a\x4d\xc8\x89\xc8\x24\x01\x74"),
     #endif
 #endif
     };
 
     static SymbolFinder finder;
     template<typename T>
-    static inline T ResolveSymbol(SourceSDK::FactoryLoader& loader, const Symbol& symbol) {
-        return reinterpret_cast<T>( finder.Resolve(loader.GetModule(), symbol.name.c_str(), symbol.length) );
+    static inline std::vector<T> ResolveSymbol(SourceSDK::FactoryLoader& loader, const Symbol& symbol) {
+        static_assert(std::is_pointer<T>::value, "T must be a pointer");
+
+        // vector used to catch if signature eventually find more than one function
+        // I'm still new into signatures, so they may be wrong
+        std::vector<T> pointers;
+        void* ptr = nullptr;
+        while (ptr = finder.Resolve(loader.GetModule(), symbol.name.c_str(), symbol.length, ptr)) {
+            pointers.push_back( reinterpret_cast<T>(ptr) );
+            ptr = reinterpret_cast<void*>(reinterpret_cast<char*>(ptr) + 1);
+        }
+        return pointers;
     }
 
     template<typename T>
-    static inline T ResolveSymbols(SourceSDK::FactoryLoader& loader, const std::vector<Symbol>& symbols) {
-        T ptr = nullptr;
+    static inline std::vector<T> ResolveSymbols(SourceSDK::FactoryLoader& loader, const std::vector<Symbol>& symbols) {
         for (const auto& symbol : symbols) {
-            ptr = ResolveSymbol<T>(loader, symbol);
-            if (ptr != nullptr)
-                break;
+            auto pointers = ResolveSymbol<T>(loader, symbol);
+            if (!pointers.empty())
+                return pointers;
         }
-        return ptr;
+        return {};
     }
 }
 
@@ -86,14 +86,22 @@ void WatchdogListener::handleFileAction(efsw::WatchID watchid, const std::string
 Watchdog::Watchdog(std::shared_ptr<Core> core, std::shared_ptr<Filesystem> fs) 
     : core(core), fs(fs) 
 {
+    m_HandleFileChangeHook = std::make_unique<Detouring::Hook>();
     SourceSDK::FactoryLoader server_loader("server");
-    auto HandleFileChange_original = Symbols::ResolveSymbols<Symbols::HandleFileChange_t>(server_loader, Symbols::HandleFileChange);
-    if (HandleFileChange_original == nullptr)
-        throw std::runtime_error("Failed to resolve HandleFileChange");
 
-    m_HandleFileChangeHook = std::make_unique<Detouring::Hook>((void*)HandleFileChange_original, (void*)HandleFileChange_detour);
-    if (!m_HandleFileChangeHook->Enable())
-        throw std::runtime_error("Failed to hook HandleFileChange");
+    auto HandleFileChange_pointers = Symbols::ResolveSymbols<Symbols::HandleFileChange_t>(server_loader, Symbols::HandleFileChange);
+    if (HandleFileChange_pointers.size() == 1) {
+        auto HandleFileChange_original = HandleFileChange_pointers[0];
+        if (m_HandleFileChangeHook->Create((void*)HandleFileChange_original, (void*)HandleFileChange_detour) && m_HandleFileChangeHook->Enable()) {
+            DevMsg("[Moonloader] HandleFileChange: %p\n", HandleFileChange_original);
+        } else {
+            core->LUA->ErrorNoHalt("[Moonloader] Failed to hook HandleFileChange function! Autorefresh won't work properly.\n\tPlease, report to " MOONLOADER_URL "/issues\n");
+        }
+    } else if (HandleFileChange_pointers.empty()) {
+        core->LUA->ErrorNoHalt("[Moonloader] HandleFileChange not found! Autorefresh won't work properly.\n\tPlease, report to " MOONLOADER_URL "/issues\n" );
+    } else {
+        core->LUA->ErrorNoHalt("[Moonloader] Too many functions were found for HandleFileChange signature! Autorefresh won't work properly.\n\tPlease, report to " MOONLOADER_URL "/issues\n");
+    }
 }
 
 void Watchdog::Start() {
@@ -103,7 +111,6 @@ void Watchdog::Start() {
 
 Watchdog::~Watchdog() {
     m_HandleFileChangeHook->Disable();
-    m_HandleFileChangeHook->Destroy();
 }
 
 void Watchdog::OnFileModified(const std::string& path) {
@@ -189,5 +196,9 @@ void Watchdog::HandleFileChange(const std::string& path) {
 }
 
 void Watchdog::RefreshFile(const std::string& path) {
-    m_HandleFileChangeHook->GetTrampoline<Symbols::HandleFileChange_t>()(path);
+    if (m_HandleFileChangeHook->IsValid()) {
+        m_HandleFileChangeHook->GetTrampoline<Symbols::HandleFileChange_t>()(path);
+    } else {
+        // TODO: use lua_refresh_file?
+    }
 }

source/watchdog.cpp

@@ -8,18 +8,18 @@
 #include <unordered_set>
 #include <queue>
 #include <mutex>
-#include <tier0/platform.h>
 #include <efsw/efsw.hpp>
 #include <GarrysMod/Lua/LuaInterface.h>
-
-namespace Detouring {
-    class Hook;
-}
+#include <detouring/hook.hpp>
 
 namespace GarrysMod::Lua {
     class File;
 }
 
+namespace Detouring {
+    class Hook;
+}
+
 namespace MoonLoader {
     class Watchdog;
     class Filesystem;