Merge remote-tracking branch 'upstream/main' into compiler-warns-experimental

Author: FirstLemon

.github/workflows/compile.yml

@@ -72,6 +72,7 @@ jobs:
       PTERODACTYL_RESTART_SLEEPTIME: "0"
       PTERODACTYL_RESTART: "true"
       BUILD_CACHE: "true"
+      NO_SAVE_CACHE: "true" # Cache will only be updated by main compiles in build_plugin_linux job
 
   build_testingarea_dev2: # Could make this use the already created artifact but I'm too lazy rn
     name: "Build 32x (Testing Area - Public)"
@@ -95,6 +96,7 @@ jobs:
       PTERODACTYL_RESTART_SLEEPTIME: "0"
       PTERODACTYL_RESTART: "true"
       BUILD_CACHE: "true"
+      NO_SAVE_CACHE: "true" # Cache will only be updated by main compiles in build_plugin_linux job
 
   build_testingarea_64x:
     name: "Build 64x (Testing Area - 64x)"
@@ -119,6 +121,7 @@ jobs:
       PTERODACTYL_RESTART_SLEEPTIME: "0"
       PTERODACTYL_RESTART: "true"
       BUILD_CACHE: "true"
+      NO_SAVE_CACHE: "true" # Cache will only be updated by main compiles in build_plugin_linux job
 
   build_ghostinj:
     name: "Build GhostInj"
@@ -137,6 +140,65 @@ jobs:
       GARRYSMOD_COMMON: "RaphaelIT7/garrysmod_common"
       BUILD_CACHE: "true"
 
+  build_stripped_module:
+    # This saves us useless compiles when it would already fail
+    # + This way we always use the newest cache reducing compile time.
+    # Update: NEVERMIND, this turned out to slow down the entire build process simply because we hit the runner limit
+    #         And less stuff could run in parallel.
+    # Doing this paralle to the main builds gives us at minimim 1min time with ~34 runners available to run parallel
+    # needs: build_plugin_linux
+    name: "Build Stripped modules"
+    uses: RaphaelIT7/gmod-common-module-base/.github/workflows/compile.yml@workflow
+    strategy:
+      fail-fast: false
+      matrix:
+        module:
+          - autorefresh
+          - holylib
+          - gameevent
+          - serverplugin
+          - sourcetv
+          - stringtable
+          - precachefix
+          - pvs
+          - surffix
+          - filesystem
+          - util
+          - concommand
+          - vprof
+          - cvars
+          - bitbuf
+          - networking
+          - steamworks
+          - pas
+          - bass
+          - systimer
+          - voicechat
+          - physenv
+          - net
+          - entitylist
+          - httpserver
+          - gameserver
+          - soundscape
+          - luajit
+          - holylua
+    with:
+      PROJECT_NAME: "holylib"
+      BUILD_64x: "true"
+      REALM: "sv"
+      LINUX_FILEEXTENTION: "so"
+      BUILD_WINDOWS: "false"
+      ARTIFACT_EXPIRE: "7"
+      UPLOAD: "none"
+      BUILD_CACHE: "true"
+      NO_SAVE_CACHE: "true"
+      SOURCESDK_MINIMAL: "RaphaelIT7/sourcesdk-minimal"
+      SOURCESDK_MINIMAL_BRANCH: "patch-7"
+      SOURCESDK_MINIMAL_64XBRANCH: "x86-64-patch-3"
+      GARRYSMOD_COMMON: "RaphaelIT7/garrysmod_common"
+      ADDITIONAL_LINUX_32_SETUP: 'rm -rf source/ivp && cd source/modules/ && ls | grep -xvF ${{ matrix.module }}.cpp | xargs rm -f -- && cd ../../'
+      ADDITIONAL_LINUX_64_SETUP: 'rm -rf source/ivp && cd source/modules/ && ls | grep -xvF ${{ matrix.module }}.cpp | xargs rm -f -- && cd ../../'
+
   setup_artifacts: # Having this as a matrix won't hurt concurrency since both 32x & 64x finish around the same time
     name: "Setup ${{ matrix.arch }} Artifact"
     needs: [build_plugin_linux, build_ghostinj]
@@ -373,7 +435,7 @@ jobs:
         run: |
           cd source/_prebuildtools
           chmod +x luajit_64
-          ./luajit_64 _workflow_summary.lua "${{github.repository}}" "${{env.LOKI_PUBLIC}}" "${{secrets.LOKI_HOST}}" "${{secrets.LOKI_APIKEY}}" "${{github.run_number}}"
+          ./luajit_64 _workflow_summary.lua "${{github.repository}}" "${{env.LOKI_PUBLIC}}" "${{secrets.LOKI_HOST}}" "${{secrets.LOKI_APIKEY}}" "${{github.run_number}}" "0" "${{github.event_name}}"
 
           echo "$(cat generated_summary.md)" > $GITHUB_STEP_SUMMARY
 
@@ -559,12 +621,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        module: 
+        module:
+          - autorefresh
           - holylib
           - gameevent
           - serverplugin
           - sourcetv
-          - threadpoolfix
           - stringtable
           - precachefix
           - pvs
@@ -599,7 +661,7 @@ jobs:
   # -------
 
   build_exampledll_linux:
-    name: "Build Plugin"
+    name: "Build ExampleDLL"
     uses: RaphaelIT7/gmod-common-module-base/.github/workflows/compile.yml@workflow
     with:
       PROJECT_PATH: "example-module-dll/"

.github/workflows/compile_custom.yml

@@ -0,0 +1,76 @@
+name: Build Custom Version
+
+on: 
+  workflow_dispatch:
+    inputs:
+      modules:
+        description: 'Space-separated list of modules to keep (e.g., holylib gameevent)'
+        required: true
+        type: string
+      custom_vphysics:
+        description: 'Include custom vphysics build'
+        required: false
+        default: false
+        type: boolean
+
+env:
+  MODULES_LIST: "autorefresh holylib gameevent serverplugin sourcetv stringtable precachefix pvs surffix filesystem util concommand vprof cvars bitbuf networking steamworks pas bass systimer voicechat physenv net entitylist httpserver gameserver soundscape luajit holylua"
+
+jobs:
+  build_custom_version:
+    runs-on: ubuntu-latest
+    outputs:
+      COMMAND: ${{ steps.construct_command.outputs.COMMAND }}
+
+    steps:
+      - name: Construct the removal command and output it
+        id: construct_command
+        run: |
+          MODULES_SELECTED=(${{ inputs.modules }})
+
+          COMMAND="${{ inputs.custom_vphysics == false && 'rm -rf source/ivp &&' || '' }} cd source/modules && ls | grep -vF -e 'none'"
+
+          for MODULE in "${MODULES_SELECTED[@]}"; do
+            if [[ " $MODULES_LIST " =~ " $MODULE " ]]; then
+              COMMAND="$COMMAND -e $MODULE.cpp"
+            fi
+          done
+
+          COMMAND="$COMMAND | xargs rm -f -- && cd ../../"
+
+          echo "Generated Command: $COMMAND"
+          echo "::set-output name=COMMAND::$COMMAND"
+
+  build_holylib:
+    needs: build_custom_version
+    uses: RaphaelIT7/gmod-common-module-base/.github/workflows/compile.yml@workflow
+    with:
+      PROJECT_NAME: "holylib"
+      BUILD_64x: "true"
+      REALM: "sv"
+      LINUX_FILEEXTENTION: "so"
+      BUILD_WINDOWS: "false"
+      ARTIFACT_EXPIRE: "7"
+      SOURCESDK_MINIMAL: "RaphaelIT7/sourcesdk-minimal"
+      SOURCESDK_MINIMAL_BRANCH: "patch-7"
+      SOURCESDK_MINIMAL_64XBRANCH: "x86-64-patch-3"
+      GARRYSMOD_COMMON: "RaphaelIT7/garrysmod_common"
+      ADDITIONAL_DATA: "1"
+      ADDITIONAL_LINUX_32_SETUP: ${{ needs.build_custom_version.outputs.COMMAND }}
+      ADDITIONAL_LINUX_64_SETUP: ${{ needs.build_custom_version.outputs.COMMAND }}
+
+  build_ghostinj:
+    uses: RaphaelIT7/gmod-common-module-base/.github/workflows/compile.yml@workflow
+    with:
+      PROJECT_PATH: "ghostinj-dll/"
+      PROJECT_NAME: "ghostinj"
+      BUILD_64x: "true"
+      LINUX_FILEEXTENTION: "dll"
+      BUILD_WINDOWS: "false"
+      USE_PREFIX: "false"
+      ARTIFACT_EXPIRE: "7"
+      ADDITIONAL_DATA: "1"
+      SOURCESDK_MINIMAL: "RaphaelIT7/sourcesdk-minimal"
+      SOURCESDK_MINIMAL_BRANCH: "patch-7"
+      SOURCESDK_MINIMAL_64XBRANCH: "x86-64-patch-3"
+      GARRYSMOD_COMMON: "RaphaelIT7/garrysmod_common"

README.md

@@ -27,6 +27,11 @@ If you already had a `ghostinj.dll`, you can rename it to `ghostinj2.dll` and it
 2. Put the `holylib.vdf` into the `garrysmod/addons/` directory.<br>
 3. Put the `gmsv_holylib_linux.so` into the `garrysmod/lua/bin/` directory.<br>
 
+## Custom Builds (Linux Only)
+You can fork this repository and use the `Build Custom Version` to create a custom HolyLib version which only contains specific functions.<br>
+I heard from some that they don't want a huge DLL of which they only use a few functions of,<br>
+so by making a custom build anyone can include just the stuff they actually want and need, nothing else.<br>
+
 ## How to update (Newer GhostInj)
 
 > [!NOTE]
@@ -88,6 +93,7 @@ This is done by first deleting the current `gmsv_holylib_linux[64].so` and then
 \- [+] Added `bitbuf.CreateStackReadBuffer` & `bitbuf.CreateStackWriteBuffer` to `bitbuf` module.<br>
 \- [+] Added a fallback method for HolyLib's internal `Util::PushEntity` function in case a Gmod update breaks our offsets which previously lead to undefined behavior<br>
 \- [+] Added a `ILuaThreadedCall` to call all modules Think function when HolyLib is loaded as a binary module/loaded using `require("holylib")`<br>
+\- [+] Added a new DLL system if anything wants to be loaded with HolyLib. (See: [example-module-dll](https://github.com/RaphaelIT7/gmod-holylib/tree/f937ba454b4d86edfc72df9cb3f8a689d7de2571/example-module-dll))<br>
 \- [#] Added some more safeguards to `IPhysicsEnvironment:Simulate` to prevent one from simulating a environment that is already being simulated.<br>
 \- [#] Highly optimized `util` module's json code to be noticably faster and use noticably less memory.<br>
 \- [#] Better support for multiple Lua states<br>
@@ -127,6 +133,16 @@ This is done by first deleting the current `gmsv_holylib_linux[64].so` and then
 \- [#] Tried to improve out of memory handling of `bitbuf.Create[Read/Write]Buffer` and `bf_read:ReadString()` functions<br>
 \- [#] Fixed a regression with `util.FancyTableToJSON` crashing with the `0.8-pre` build when it falsely tried to become sequential while being already non-sequential. (Reported by @Noahbg)<br>
 \- [#] Fixed absolute search cache causing files from any search path to be returned / destroying seperation between search paths (See https://github.com/RaphaelIT7/gmod-holylib/issues/83)<br>
+\- [#] Fixed HolyLua being unable to register any metatable causing crashes when trying to use them.<br>
+\- [#] Fixed some small memory leaks in HolyLibs CLuaInterface class<br>
+\- [#] Fixed `steamworks.ForceAuthenticate` being silently broken<br>
+\- [#] Fully seperated HolyLib's core from all modules allowing anyone to remove modules they don't want.<br>
+\- [#] Removed all dependencies modules had on each other allowing each module to compile without requiring another one.<br>
+\- [#] Fixed some issues in `luathreads` module that caused either crashes or simply were bugs<br>
+\- [#] Fixed lua error handler used by any `CLuaInterface` created by HolyLib failing (`error in error handler`)<br>
+\- [#] Moved `HolyLua` from HolyLib's core into a module to seperate it and allow anyone to remove it<br>
+\- [#] Fixed some memory leaks from our own `CLuaInterface` since on shutdown they never cleared up on removal/shutdown<br>
+\- [#] Added a speedup for pushing networked entities to Lua (On 64x pushing entities became 2.6x faster)<br>
 \- [-] Removed some unused code of former fixes that were implemented into Gmod<br>
 
 You can see all changes/commits here:<br>

example-module-dll/README.md

@@ -32,4 +32,4 @@ This is an interface provided by HolyLib, which you can find here: https://githu
 Using this interface, you can for example, register your own module to HolyLib.
 
 > [!WARNING]
-> If you use dev builds of HolyLib, interfaces will most likely change, ensure that your DLLs either use the newest interface of HolyLib, or 
+> If you use dev builds of HolyLib, interfaces will most likely change, ensure that your DLLs either use the newest interface of HolyLib, or properly use the config

gluatests/lua/autorun/gmod_tests_init.lua

@@ -16,3 +16,11 @@ hook.Add("GLuaTest_Finished", "ChangeLevel", function()
 		RunConsoleCommand("changelevel", game.GetMap())
 	end
 end)
+
+hook.Add("Initialize", "SetupBots", function()
+	RunConsoleCommand("bot_zombie", "1")
+	RunConsoleCommand("sv_stressbots", "1")
+	for k=1, math.Clamp(math.ceil(game.MaxPlayers() / 4), 1, 4) do
+		RunConsoleCommand("bot")
+	end
+end)

gluatests/lua/tests/core/ClearLuaTable.lua

@@ -0,0 +1,29 @@
+return {
+    groupName = "HolyLib manages to properly clear the Lua table of HolyLib UserData",
+    cases = {
+        {
+            name = "Is _HOLYLIB_CORE.ClearLuaTable function existent",
+            func = function()
+                expect( _HOLYLIB_CORE.ClearLuaTable ).to.beA( "function" )
+            end
+        },
+        {
+            name = "Clears Lua Table correctly",
+            func = function()
+                local userdata = _HOLYLIB_CORE.PushTestUserData()
+                userdata.example = "Test"
+                expect( userdata.example ).to.equal( "Test" )
+
+                _HOLYLIB_CORE.ClearLuaTable(userdata)
+                expect( userdata.example ).to.beNil()
+            end
+        },
+        {
+            name = "Performance",
+            func = function()
+                local userdata = _HOLYLIB_CORE.PushTestUserData()
+                HolyLib_RunPerformanceTest("_HOLYLIB_CORE.ClearLuaTable", _HOLYLIB_CORE.ClearLuaTable, userdata)
+            end
+        },
+    }
+}

gluatests/lua/tests/core/GetEntity.lua

@@ -2,18 +2,24 @@ return {
     groupName = "HolyLib manages to properly Get Entities from Lua",
     cases = {
         {
-            name = "Is HolyLib.__GetEntity function existent",
+            name = "Is _HOLYLIB_CORE.GetEntity function existent",
             func = function()
-                expect( HolyLib.__GetEntity ).to.beA( "function" )
+                expect( _HOLYLIB_CORE.GetEntity ).to.beA( "function" )
             end
         },
         {
             name = "Pushes an Entity to Lua correctly",
             func = function()
-                local success = HolyLib.__GetEntity(game.GetWorld()) -- Returns false or crashes if anything was wrong
+                local success = _HOLYLIB_CORE.GetEntity(game.GetWorld()) -- Returns false or crashes if anything was wrong
 
                 expect( success ).to.beTrue()
             end
         },
+        {
+            name = "Performance",
+            func = function()
+                HolyLib_RunPerformanceTest("_HOLYLIB_CORE.RawGetEntity", _HOLYLIB_CORE.RawGetEntity, game.GetWorld())
+            end
+        },
     }
 }

gluatests/lua/tests/core/GetGModUserData.lua

@@ -0,0 +1,25 @@
+return {
+    groupName = "HolyLib manages to properly Get GMod UserData from Lua",
+    cases = {
+        {
+            name = "Is _HOLYLIB_CORE.GetGModVector function existent",
+            func = function()
+                expect( _HOLYLIB_CORE.GetGModVector ).to.beA( "function" )
+            end
+        },
+        {
+            name = "Pushes an Entity to Lua correctly",
+            func = function()
+                local success = _HOLYLIB_CORE.GetGModVector(Vector(1, 2, 3)) -- Returns false or crashes if anything was wrong. We check for x = 1, y = 2, z = 3
+
+                expect( success ).to.beTrue()
+            end
+        },
+        {
+            name = "Performance",
+            func = function()
+                HolyLib_RunPerformanceTest("_HOLYLIB_CORE.RawGetGModVector", _HOLYLIB_CORE.RawGetGModVector, Vector(1, 2, 3))
+            end
+        },
+    }
+}

gluatests/lua/tests/core/GetModuleData.lua

@@ -0,0 +1,24 @@
+return {
+    groupName = "HolyLib manages to properly Push Entities to Lua",
+    cases = {
+        {
+            name = "Is _HOLYLIB_CORE.GetModuleData function existent",
+            func = function()
+                expect( _HOLYLIB_CORE.GetModuleData ).to.beA( "function" )
+            end
+        },
+        {
+            name = "Internally verifies the pointer it got",
+            func = function()
+                -- If we got a garbage pointer, this will return false or crash.
+                expect( _HOLYLIB_CORE.GetModuleData() ).to.beTrue()
+            end
+        },
+        {
+            name = "Performance",
+            func = function()
+                HolyLib_RunPerformanceTest("_HOLYLIB_CORE.GetModuleData", _HOLYLIB_CORE.RawGetModuleData)
+            end
+        },
+    }
+}

gluatests/lua/tests/core/GetPlayer.lua

@@ -1,18 +1,10 @@
 return {
-    groupName = "HolyLib manages to properly Get Entities from Lua",
+    groupName = "HolyLib manages to properly Get Players from Lua",
     cases = {
         {
-            name = "Is HolyLib.__GetEntity function existent",
+            name = "Is _HOLYLIB_CORE.GetPlayer function existent",
             func = function()
-                expect( HolyLib.__GetEntity ).to.beA( "function" )
-            end
-        },
-        {
-            name = "Pushes an Entity to Lua correctly",
-            func = function()
-                local success = HolyLib.__GetEntity(game.GetWorld()) -- Returns false or crashes if anything was wrong
-
-                expect( success ).to.beTrue()
+                expect( _HOLYLIB_CORE.GetPlayer ).to.beA( "function" )
             end
         },
     }