Server: Reimplement chunk cache

Author: SirLynix

database/server/202608011713_chunk_cache_rework.sql

@@ -0,0 +1,2 @@
+DROP TABLE "planet_generator_cache";
+ALTER TABLE "planet_chunks" ADD COLUMN "cache_state" INTEGER NOT NULL DEFAULT 0;

include/CommonLib/Chunk.hpp

@@ -41,8 +41,8 @@ namespace tsom
 
 	enum class ChunkFlag
 	{
-		PlayerModified,
-		SaveToDatabase,
+		PlayerModified, //< Chunk modified by a player
+		SaveToDatabase, //< Chunk pending a save to the database
 
 		Max = SaveToDatabase
 	};

include/ServerLib/Database/Schema.hpp

@@ -37,6 +37,7 @@ namespace tsom::Database
 		Nz::Vector3i32 position;
 		Nz::UInt32 version;
 		std::span<const Nz::UInt8> chunkData;
+		bool cacheState;
 	};
 
 	struct PlanetEntityPartial
@@ -59,6 +60,7 @@ namespace tsom::Database
 	{
 		std::string generatorName;
 		std::string generatorHash;
+		Nz::UInt32 seed;
 		Nz::Vector3i32 chunkIndices;
 		Nz::UInt32 chunkDataVersion;
 		std::span<const Nz::UInt8> chunkData;

include/ServerLib/Database/ServerDatabase.hpp

@@ -41,12 +41,10 @@ namespace tsom
 			void GetAllPlanetLinks(Nz::FunctionRef<bool(Database::PlanetLink&& /*planetLink*/)> callback) const;
 			void GetAllPlanetChunks(Nz::UInt32 planetId, Nz::FunctionRef<bool(Database::PlanetChunk&& /*planetChunk*/)> callback) const;
 			bool GetPlanetChunk(Nz::UInt32 planetId, const Nz::Vector3i32& chunkIndices, Nz::FunctionRef<void(Database::PlanetChunk&& /*planetChunk*/)> callback) const;
-			bool GetPlanetGeneratorCache(const std::string& generatorName, const Nz::Vector3i32& chunkIndices, Nz::FunctionRef<void(Database::PlanetGeneratorCache&& /*planetGeneratorCache*/)> callback) const;
 
 			void StorePlanet(const Database::Planet& planetChunk);
 			void StorePlanetChunk(const Database::PlanetChunk& planetChunk);
 			void StorePlanetLink(const Database::PlanetLink& planetChunk);
-			void StorePlanetGeneratorCache(const Database::PlanetGeneratorCache& planetGeneratorCache);
 
 			void Transaction(Nz::FunctionRef<bool(ServerDatabase& database)> callback);
 
@@ -83,10 +81,6 @@ namespace tsom
 				SQLite::Statement getAllPlanetEntitiesQuery;
 				SQLite::Statement partialUpdatePlanetEntityQuery;
 
-				// planet generator cache
-				SQLite::Statement getPlanetGeneratorCacheChunk;
-				SQLite::Statement storePlanetGeneratorCacheChunk;
-
 				// planet links
 				SQLite::Statement getAllPlanetLinkQuery;
 				SQLite::Statement storePlanetLinkQuery;

include/ServerLib/ServerInstance.hpp

@@ -101,6 +101,7 @@ namespace tsom
 				std::string databaseFile;
 				Nz::Time saveInterval = Nz::Time::Seconds(30);
 				bool enableDebugDrawer = false;
+				bool enableChunkCache = false;
 				bool pauseWhenEmpty = true;
 			};
 

include/ServerLib/ServerPlanetEnvironment.hpp

@@ -58,7 +58,6 @@ namespace tsom
 			ServerAtmosphere* GetFallbackAtmosphereAtPosition(const Nz::Vector3f& position) override;
 			void LoadChunksFromDatabase();
 			void LoadEntitiesFromDatabase();
-			void SavePlanetGeneratorCache();
 
 			struct ChunkLoadingData
 			{

serverconfig.lua.default

@@ -1,6 +1,9 @@
 Api = {
 	Url = "https://tsom-api.digitalpulse.software"
 }
+Chunk = {
+	EnableCache = false
+}
 ConnectionToken = {
 	EncryptionKey = ""
 }

src/Server/ServerConfigAppComponent.cpp

@@ -15,6 +15,7 @@ namespace tsom
 	ServerConfigFile::ServerConfigFile()
 	{
 		RegisterStringOption(Config::Api_Url);
+		RegisterBoolOption(Config::Chunk_EnableCache, false);
 		RegisterStringOption(Config::ConnectionToken_EncryptionKey, "");
 		RegisterIntegerOption(Config::Server_Port, 1, 0xFFFF, 29536);
 		RegisterIntegerOption(Config::Server_MaxStuckSeconds, 0, 60, 10);

src/Server/ServerConfigs.hpp

@@ -11,6 +11,7 @@
 
 namespace tsom::Config
 {
+	static constexpr auto Chunk_EnableCache = ConfigFile::BoolOptionName{ "Chunk.EnableCache" };
 	static constexpr auto ConnectionToken_EncryptionKey = ConfigFile::StringOptionName{ "ConnectionToken.EncryptionKey" };
 	static constexpr auto Database_Filename = ConfigFile::StringOptionName{ "Database.Filename" };
 	static constexpr auto Debug_EnableDrawer = ConfigFile::BoolOptionName{ "Debug.EnableDrawer" };

src/Server/main.cpp

@@ -77,6 +77,7 @@ int ServerMain(int argc, char* argv[])
 	instanceConfig.pauseWhenEmpty = config.GetBoolValue(tsom::Config::Server_SleepWhenEmpty);
 	instanceConfig.saveInterval = Nz::Time::Seconds(config.GetIntegerValue<long long>(tsom::Config::Save_Interval));
 	instanceConfig.connectionTokenEncryptionKey = config.GetConnectionTokenEncryptionKey();
+	instanceConfig.enableChunkCache = config.GetBoolValue(tsom::Config::Chunk_EnableCache);
 	instanceConfig.enableDebugDrawer = config.GetBoolValue(tsom::Config::Debug_EnableDrawer);
 	instanceConfig.databaseFile = config.GetStringValue(tsom::Config::Database_Filename);