feat: runtime vscript checksums (#361)

Author: betsruner

Makefile

@@ -15,7 +15,7 @@ DEPS=$(OBJS:%.o=%.d)
 
 WARNINGS=-Wall -Wno-parentheses -Wno-unknown-pragmas -Wno-delete-non-virtual-dtor -Wno-overloaded-virtual
 CXXFLAGS=-std=c++17 -m32 $(WARNINGS) -I$(SDIR) -fPIC -D_GNU_SOURCE -Ilib/ffmpeg/include -Ilib/SFML/include -Ilib/curl/include -Ilib/discord-rpc/include -DSFML_STATIC -DCURL_STATICLIB
-LDFLAGS=-m32 -shared -lstdc++fs -Llib/ffmpeg/lib/linux -lavformat -lavcodec -lavutil -lswscale -lswresample -lx264 -lx265 -lvorbis -lvorbisenc -lvorbisfile -logg -lopus -lvpx -Llib/SFML/lib/linux -lsfml -Llib/curl/lib/linux -lcurl -lssl -lcrypto -lnghttp2 -Llib/discord-rpc/lib/linux -ldiscord-rpc
+LDFLAGS=-m32 -shared -lstdc++fs -Llib/ffmpeg/lib/linux -lavformat -lavcodec -lavutil -lswscale -lswresample -lx264 -lx265 -lvorbis -lvorbisenc -lvorbisfile -logg -lopus -lvpx -Llib/SFML/lib/linux -lsfml -Llib/curl/lib/linux -lcurl -lssl -lcrypto -lnghttp2 -Llib/discord-rpc/lib/linux -ldiscord-rpc -static-libstdc++ -static-libgcc
 
 # Import config.mk, which can be used for optional config
 -include config.mk

src/Checksum.cpp

@@ -27,6 +27,8 @@
 #define READ_LE32(arr, i) \
 	(((uint32_t)arr[i + 0] << 0) | ((uint32_t)arr[i + 1] << 8) | ((uint32_t)arr[i + 2] << 16) | ((uint32_t)arr[i + 3] << 24))
 
+static constexpr uint8_t SAR_MSG_VSCRIPT_RUNTIME_CHECKSUM = 0x14;
+
 // clang-format off
 static const uint32_t crcTable[256] = {
 	0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA,
@@ -560,6 +562,40 @@ static void addVpkInternalChecksum(const VpkInternalData &vpk) {
 	engine->demorecorder->RecordData(data.data(), data.size());
 }
 
+static size_t BoundedCStringLen(const char *str, size_t maxLen) {
+	if (!str) return 0;
+	size_t len = 0;
+	while (len < maxLen && str[len]) ++len;
+	return len;
+}
+
+void RecordRuntimeVscriptChecksum(const char *scriptName, const char *scriptData) {
+	if (!scriptName || !*scriptName || !scriptData || !*scriptData) return;
+
+	// Avoid an unbounded C-string search in case file data is not null-terminated.
+	constexpr size_t MAX_SCRIPT_SIZE = 8 * 1024 * 1024;
+	size_t scriptLen = BoundedCStringLen(scriptData, MAX_SCRIPT_SIZE);
+	if (scriptLen == 0) return;
+
+	uint32_t sum = 0;
+	if (scriptLen < MAX_SCRIPT_SIZE) {
+		sum = crc32(scriptData, scriptLen);
+	}
+
+	if (engine->demorecorder->isRecordingDemo && engine->demorecorder->GetTick() >= 0) {
+		size_t nameLen = strlen(scriptName);
+		size_t bufLen = nameLen + 6;
+		auto *buf = new uint8_t[bufLen];
+		buf[0] = SAR_MSG_VSCRIPT_RUNTIME_CHECKSUM;
+		*reinterpret_cast<uint32_t *>(buf + 1) = sum;
+		strcpy(reinterpret_cast<char *>(buf + 5), scriptName);
+		engine->demorecorder->RecordData(buf, bufLen);
+		delete[] buf;
+	} else {
+		engine->demorecorder->queuedVScriptChecksums.emplace_back(scriptName, sum);
+	}
+}
+
 void AddDemoVpkChecksums() {
 	if (g_vpkThread.joinable()) g_vpkThread.join();
 

src/Checksum.hpp

@@ -6,3 +6,4 @@
 bool AddDemoChecksum(const char *filename);
 void AddDemoFileChecksums();
 void AddDemoVpkChecksums();
+void RecordRuntimeVscriptChecksum(const char *scriptName, const char *scriptData);

src/Modules.hpp

@@ -12,3 +12,4 @@
 #include "Modules/Tier1.hpp"
 #include "Modules/VGui.hpp"
 #include "Modules/VPhysics.hpp"
+#include "Modules/VScript.hpp"

src/Modules/Client.cpp

@@ -204,6 +204,7 @@ void Client::MultiColorChat(const std::vector<std::pair<Color, std::string>> &co
 }
 
 void Client::ShowLocator(Vector position, Vector normal, Color color) {
+	if (!PrecacheParticleSystem || !DispatchParticleEffect) return;
 	Vector colorAsVector = {(float)color.r, (float)color.g, (float)color.b};
 	QAngle angles;
 

src/Modules/EngineDemoPlayer.cpp

@@ -174,6 +174,7 @@ std::string EngineDemoPlayer::GetLevelName() {
 // 0x11: VPK internal checksums
 // 0x12: incomplete speedrun summary
 // 0x13: speedrun identifier
+// 0x14: runtime vscript checksum
 void EngineDemoPlayer::CustomDemoData(char *data, size_t length) {
 	if (data[0] == 0x03 || data[0] == 0x04) {  // Entity input data
 		std::optional<int> slot;

src/Modules/EngineDemoRecorder.cpp

@@ -103,7 +103,33 @@ static void RecordQueuedCommands() {
 	engine->demorecorder->queuedCommands.clear();
 }
 
+static void RecordQueuedVScriptChecksums() {
+	if (!engine->demorecorder->isRecordingDemo) return;
+	if (!engine->demorecorder->customDataReady) return;
+	if (engine->demorecorder->GetTick() < 0) return;
+
+	for (auto &queuedChecksum : engine->demorecorder->queuedVScriptChecksums) {
+		size_t nameLen = queuedChecksum.first.size();
+		size_t bufLen = nameLen + 6;
+		auto *buf = new uint8_t[bufLen];
+		buf[0] = 0x14;
+		*reinterpret_cast<uint32_t *>(buf + 1) = queuedChecksum.second;
+		strcpy(reinterpret_cast<char *>(buf + 5), queuedChecksum.first.c_str());
+		engine->demorecorder->RecordData(buf, bufLen);
+		delete[] buf;
+	}
+	engine->demorecorder->queuedVScriptChecksums.clear();
+}
+
+ON_EVENT(PRE_TICK) {
+	if (!engine->demorecorder->queuedVScriptChecksums.empty()) {
+		RecordQueuedVScriptChecksums();
+	}
+}
+
 ON_EVENT(SESSION_END) {
+	engine->demorecorder->queuedVScriptChecksums.clear();
+
 	if (*engine->demorecorder->m_bRecording && sar_autorecord.GetInt() == -1) {
 		engine->demorecorder->Stop();
 	}
@@ -172,6 +198,7 @@ DETOUR(EngineDemoRecorder::SetSignonState, int state) {
 		RecordTimestamp();
 		SpeedrunTimer::WriteIdToDemo();  // Write speedrun ID to every demo segment
 		RecordQueuedCommands();
+		RecordQueuedVScriptChecksums();
 		SpeedrunTimer::RecordIncompleteSummary();
 		engine->ExecuteCommand("echo \"SAR " SAR_VERSION " (Built " SAR_BUILT ")\"", true);
 		AddDemoFileChecksums();

src/Modules/EngineDemoRecorder.hpp

@@ -5,6 +5,8 @@
 #include "Utils.hpp"
 
 #include <string>
+#include <utility>
+#include <vector>
 
 // Ticks before demo autostop
 #define DEMO_AUTOSTOP_DELAY 15
@@ -28,6 +30,7 @@ class EngineDemoRecorder : public Module {
 	int autorecordStartNum = 1;
 
 	std::vector<std::string> queuedCommands = {};
+	std::vector<std::pair<std::string, uint32_t>> queuedVScriptChecksums = {};
 
 	char coopRadialMenuLastPos[8];
 

src/Modules/VScript.cpp

@@ -0,0 +1,37 @@
+#include "VScript.hpp"
+
+#include "Checksum.hpp"
+#include "Game.hpp"
+#include "Hook.hpp"
+#include "Offsets.hpp"
+#include "SAR.hpp"
+
+REDECL(VScript::CompileScript);
+
+extern Hook g_VScriptCompileScriptHook;
+DETOUR_T(int, VScript::CompileScript, const char *scriptData, const char *scriptName) {
+	if (scriptName && *scriptName) {
+		RecordRuntimeVscriptChecksum(scriptName, scriptData);
+	}
+
+	g_VScriptCompileScriptHook.Disable();
+	auto ret = VScript::CompileScript(thisptr, scriptData, scriptName);
+	g_VScriptCompileScriptHook.Enable();
+	return ret;
+}
+Hook g_VScriptCompileScriptHook(&VScript::CompileScript_Hook);
+
+bool VScript::Init() {
+	VScript::CompileScript = (VScript::_CompileScript)Memory::Scan(this->Name(), Offsets::VScript_CompileScript);
+	if (!VScript::CompileScript) {
+		return false;
+	}
+
+	g_VScriptCompileScriptHook.SetFunc(VScript::CompileScript);
+	return this->hasLoaded = true;
+}
+
+void VScript::Shutdown() {
+}
+
+VScript *vscript;

src/Modules/VScript.hpp

@@ -0,0 +1,16 @@
+#pragma once
+
+#include "Module.hpp"
+#include "Utils.hpp"
+
+class VScript : public Module {
+public:
+	// CVScriptGameSystem::CompileScript
+	DECL_DETOUR_T(int, CompileScript, const char *scriptData, const char *scriptName);
+
+	bool Init() override;
+	void Shutdown() override;
+	const char *Name() override { return MODULE("vscript"); }
+};
+
+extern VScript *vscript;