Provide an alternative to SourceHook

.github/workflows/ci.yml

@@ -1,5 +1,6 @@
 name: Continuous Integration
 on: 
+  workflow_dispatch:
   push:
     branches:
       - master
@@ -98,36 +99,36 @@ jobs:
           python ../configure.py --enable-optimize --sdks=${{ join(fromJSON(env.SDKS)) }} --hl2sdk-root=${{ env.DEPENDENCIES_ROOT }}
           ambuild
 
-      - name: Test SourceHook (Optimized)
-        working-directory: metamod-source
-        shell: bash
-        # SourceHook tests are busted on Windows
-        continue-on-error: ${{ startsWith(runner.os, 'Windows') }}
-        run: |
-          mkdir build-sh-opt && cd build-sh-opt
-          python ../configure.py --enable-optimize --enable-tests --sdks=
-          ambuild
-          cd ./core/sourcehook/test/test_sourcehook
-          if [ -d "${{ matrix.os_short }}-x86" ]; then
-            ./${{ matrix.os_short }}-x86/test_sourcehook -v
-          fi
-          if [ -d "${{ matrix.os_short }}-x86_64" ]; then
-            ./${{ matrix.os_short }}-x86_64/test_sourcehook -v
-          fi
+      #- name: Test SourceHook (Optimized)
+      #  working-directory: metamod-source
+      #  shell: bash
+      #  # SourceHook tests are busted on Windows
+      #  continue-on-error: ${{ startsWith(runner.os, 'Windows') }}
+      #  run: |
+      #    mkdir build-sh-opt && cd build-sh-opt
+      #    python ../configure.py --enable-optimize --enable-tests --sdks=
+      #    ambuild
+      #    cd ./core/sourcehook/test/test_sourcehook
+      #    if [ -d "${{ matrix.os_short }}-x86" ]; then
+      #      ./${{ matrix.os_short }}-x86/test_sourcehook -v
+      #    fi
+      #    if [ -d "${{ matrix.os_short }}-x86_64" ]; then
+      #      ./${{ matrix.os_short }}-x86_64/test_sourcehook -v
+      #    fi
 
-      - name: Test SourceHook (Debug)
-        working-directory: metamod-source
-        shell: bash
+      #- name: Test SourceHook (Debug)
+      #  working-directory: metamod-source
+      #  shell: bash
         # SourceHook tests are busted on Windows
-        continue-on-error: ${{ startsWith(runner.os, 'Windows') }}
-        run: |
-          mkdir build-sh-debug && cd build-sh-debug
-          python ../configure.py --enable-debug --enable-tests --sdks=
-          ambuild
-          cd ./core/sourcehook/test/test_sourcehook
-          if [ -d "${{ matrix.os_short }}-x86" ]; then
-            ./${{ matrix.os_short }}-x86/test_sourcehook -v
-          fi
-          if [ -d "${{ matrix.os_short }}-x86_64" ]; then
-            ./${{ matrix.os_short }}-x86_64/test_sourcehook -v
-          fi
+      #  continue-on-error: ${{ startsWith(runner.os, 'Windows') }}
+      #  run: |
+      #    mkdir build-sh-debug && cd build-sh-debug
+      #    python ../configure.py --enable-debug --enable-tests --sdks=
+      #    ambuild
+      #    cd ./core/sourcehook/test/test_sourcehook
+      #    if [ -d "${{ matrix.os_short }}-x86" ]; then
+      #      ./${{ matrix.os_short }}-x86/test_sourcehook -v
+      #    fi
+      #    if [ -d "${{ matrix.os_short }}-x86_64" ]; then
+      #      ./${{ matrix.os_short }}-x86_64/test_sourcehook -v
+      #    fi

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "hl2sdk-manifests"]
 	path = hl2sdk-manifests
 	url = https://github.com/alliedmodders/hl2sdk-manifests
+[submodule "third_party/khook"]
+	path = third_party/khook
+	url = https://github.com/Kenzzer/KHook

AMBuildScript

@@ -31,6 +31,8 @@ class MMSConfig(object):
     self.versionlib = None
     self.all_targets = []
     self.target_archs = set()
+    self.libsafetyhook = {}
+    self.libkhook = {}
 
     if builder.options.targets:
       target_archs = builder.options.targets.split(',')
@@ -325,7 +327,6 @@ class MMSConfig(object):
 
     cxx.cxxincludes += [
       os.path.join(context.currentSourcePath),
-      os.path.join(context.currentSourcePath, 'sourcehook'),
       os.path.join(context.sourcePath, 'loader'),
     ]
 
@@ -370,7 +371,6 @@ BuildScripts = [
 ]
 if getattr(builder.options, 'enable_tests', False):
     BuildScripts += [
-        'core/sourcehook/test/AMBuilder',
         'loader/test/AMBuilder',
     ]
 
@@ -379,6 +379,7 @@ if builder.backend == 'amb2':
     'support/buildbot/PackageScript',
   ]
 
+builder.Build(['third_party/khook/AMBuilder', 'third_party/khook/third_party/safetyhook/AMBuilder'], { 'KHook': MMS, 'SafetyHook': MMS })
 builder.Build(BuildScripts, { 'MMS': MMS })
 
 if builder.options.breakpad_dump:

core/AMBuilder

@@ -7,6 +7,15 @@ for sdk_target in MMS.sdk_targets:
 
   name = 'metamod.' + sdk['extension']
   binary = MMS.HL2Library(builder, cxx, name, sdk)
+  binary.compiler.cxxincludes += [os.path.join(builder.sourcePath, 'third_party', 'khook', 'include')]
+
+  binary.compiler.defines += ['KHOOK_STANDALONE', 'KHOOK_EXPORT']
+  for task in MMS.libkhook:
+    if task.target.arch == binary.compiler.target.arch:
+      binary.compiler.linkflags += [task.binary]
+  for task in MMS.libsafetyhook:
+    if task.target.arch == binary.compiler.target.arch:
+      binary.compiler.linkflags += [task.binary]
 
   binary.sources += [
     'metamod.cpp',
@@ -15,12 +24,6 @@ for sdk_target in MMS.sdk_targets:
     'metamod_plugins.cpp',
     'metamod_util.cpp',
     'provider/provider_base.cpp',
-    'sourcehook/sourcehook.cpp',
-    'sourcehook/sourcehook_impl_chookidman.cpp',
-    'sourcehook/sourcehook_impl_chookmaninfo.cpp',
-    'sourcehook/sourcehook_impl_cproto.cpp',
-    'sourcehook/sourcehook_impl_cvfnptr.cpp',
-    'sourcehook/sourcehook_hookmangen.cpp',
     'gamedll_bridge.cpp'
   ]
 
@@ -38,10 +41,5 @@ for sdk_target in MMS.sdk_targets:
       'vsp_bridge.cpp'
       ]
     binary.compiler.defines += ['_ALLOW_KEYWORD_MACROS']
-
-  if cxx.target.arch == 'x86':
-    binary.sources += ['sourcehook/sourcehook_hookmangen_x86.cpp']
-  elif binary.compiler.target.arch == 'x86_64' and binary.compiler.target.platform != 'linux':
-    binary.sources += ['sourcehook/sourcehook_hookmangen_x86_64.cpp']
   nodes = builder.Add(binary)
   MMS.binaries += [nodes]

core/ISmmAPI.h

@@ -35,7 +35,6 @@
 
 #include <cstdarg>
 
-#include "sourcehook.h"
 #include "IPluginManager.h"
 
 #if defined META_NO_HL2SDK
@@ -57,6 +56,7 @@ typedef ConCommandBase ProviderConCommand;
 #endif
 #endif
 
+#define MMIFACE_KHOOK			"IKHook"				/**< IKHook Pointer */
 #define	MMIFACE_SOURCEHOOK		"ISourceHook"			/**< ISourceHook Pointer */
 #define	MMIFACE_PLMANAGER		"IPluginManager"		/**< SourceMM Plugin Functions */
 #define MMIFACE_SH_HOOKMANAUTOGEN	"IHookManagerAutoGen"		/**< SourceHook::IHookManagerAutoGen Pointer */
@@ -189,14 +189,6 @@ namespace SourceMM
 		 */
 		virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
 
-		/** 
-		 * @brief Returns sourcehook API version and implementation version.
-		 *
-		 * @param shvers		Filled with the SourceHook API version number.
-		 * @param shimpl		Filled with the SourceHook implementation number.
-		 */
-		virtual void GetShVersions(int &shvers, int &shimpl) =0;
-
 		/**
 		 * @brief Adds a Metamod listener.
 		 *
@@ -467,5 +459,4 @@ using namespace SourceMM;
  * 1.6.0 Added API for Orange Box.  Broke backwards compatibility.
  */
 
-#endif //_INCLUDE_ISMM_API_H
-
+#endif //_INCLUDE_ISMM_API_H

core/ISmmPlugin.h

@@ -34,7 +34,6 @@
  * The pure-virtual ISmmPlugin callbacks must be implemented for the load to load.
  */
 
-#include "sourcehook.h"
 #include "IPluginManager.h"
 #include "ISmmAPI.h"
 #include "ISmmPluginExt.h"
@@ -487,11 +486,12 @@ using namespace SourceMM;
 #define PL_EXPOSURE_FUNC(name, var)	EXPOSE_SINGLE_INTERFACE_GLOBALVAR(ISmmPlugin, ISmmPlugin, METAMOD_PLAPI_NAME, var);
 #endif
 
+#include "khook.hpp"
 #define PLUGIN_EXPOSE(name, var) \
 	ISmmAPI *g_SMAPI = NULL; \
 	ISmmPlugin *g_PLAPI = NULL; \
 	PluginId g_PLID = (PluginId)0; \
-	SourceHook::ISourceHook *g_SHPtr = NULL; \
+	namespace KHook { KHook::IKHook* __exported__khook = nullptr; } \
 	PL_EXPOSURE_FUNC(name, var)
 
 
@@ -503,7 +503,7 @@ using namespace SourceMM;
  * to use values like g_SHPtr in other files.
  */
 #define PLUGIN_GLOBALVARS()	\
-	extern SourceHook::ISourceHook *g_SHPtr; \
+	namespace KHooK { extern KHook::IKHook* __exported__khook; } \
 	extern ISmmAPI *g_SMAPI; \
 	extern ISmmPlugin *g_PLAPI; \
 	extern PluginId g_PLID; 
@@ -513,7 +513,7 @@ using namespace SourceMM;
  */
 #define PLUGIN_SAVEVARS() \
 	g_SMAPI = ismm; \
-	g_SHPtr = static_cast<SourceHook::ISourceHook *>(ismm->MetaFactory(MMIFACE_SOURCEHOOK, NULL, NULL)); \
+	KHook::__exported__khook = static_cast<KHook::IKHook*>(ismm->MetaFactory(MMIFACE_KHOOK, nullptr, nullptr)); \
 	g_PLAPI = static_cast<ISmmPlugin *>(this); \
 	g_PLID = id;
 

core/ISmmPluginExt.h

@@ -128,8 +128,6 @@ struct MetamodVersionInfo
 {
 	int api_major;			/**< ISmmAPI major version */
 	int api_minor;			/**< ISmmAPI minor version */
-	int sh_iface;			/**< SourceHook interface version */
-	int sh_impl;			/**< SourceHook implementation version */
 	int pl_min;				/**< Plugin API minimum version */
 	int pl_max;				/**< Plugin API maximum version */
 	int source_engine;		/**< Source Engine version (SOURCE_* constants) */

core/gamedll_bridge.cpp

@@ -30,6 +30,7 @@
 #include "metamod_util.h"
 #include "loader_bridge.h"
 #include "provider/provider_base.h"
+#include "khook.hpp"
 
 using namespace SourceMM;
 
@@ -62,18 +63,13 @@ class GameDllBridge : public IGameDllBridge
 	}
 	virtual void DLLInit_Post(int *isgdUnload)
 	{
-		SourceHook::MemFuncInfo mfi;
-
-		mfi.isVirtual = false;
 #ifdef META_IS_SOURCE2
-		SourceHook::GetFuncInfo(&ISource2ServerConfig::Disconnect, mfi);
+		auto mfi = KHook::GetVtableIndex(&ISource2ServerConfig::Disconnect);
 #else
-		SourceHook::GetFuncInfo(&IServerGameDLL::DLLShutdown, mfi);
+		auto mfi = KHook::GetVtableIndex(&IServerGameDLL::DLLShutdown);
 #endif
-		assert(mfi.isVirtual);
-		assert(mfi.vtbloffs == 0);
-		assert(mfi.thisptroffs == 0);
-		*isgdUnload = mfi.vtblindex;
+		assert(mfi != -1);
+		*isgdUnload = mfi;
 
 		g_PluginMngr.SetAllLoaded();
 	}