feat(crc): Write deep CRC snapshots to disk when game mismatches

Author: Caball009

Core/GameEngine/Include/Common/GameDefines.h

@@ -112,6 +112,10 @@
 #endif
 #endif
 
+#if (!defined(DEEP_CRC_TO_MEMORY) && !defined(DEBUG_CRC))
+#define DEEP_CRC_TO_MEMORY 1
+#endif
+
 #define MIN_DISPLAY_BIT_DEPTH       16
 #define DEFAULT_DISPLAY_BIT_DEPTH   32
 #define DEFAULT_DISPLAY_WIDTH      800 // The standard resolution this game was designed for

Core/GameEngine/Include/Common/RandomValue.h

@@ -35,4 +35,8 @@ extern void InitRandom( UnsignedInt seed );
 extern UnsignedInt GetGameLogicRandomSeed();   ///< Get the seed (used for replays)
 extern UnsignedInt GetGameLogicRandomSeedCRC();///< Get the seed (used for CRCs)
 
+#if DEEP_CRC_TO_MEMORY
+AsciiString GetGameLogicalRandomSeeds();
+#endif
+
 //--------------------------------------------------------------------------------------------------------------

Core/GameEngine/Include/Common/Xfer.h

@@ -178,6 +178,10 @@ class Xfer
 	virtual void xferMatrix3D( Matrix3D* mtx );
 	virtual void xferMapName( AsciiString *mapNameData );
 
+#if DEEP_CRC_TO_MEMORY
+	virtual void xferLogString(const AsciiString& str) {}
+#endif
+
 protected:
 
 	// this is the actual xfer implementation that each derived class should implement

Core/GameEngine/Include/Common/XferDeepCRC.h

@@ -32,6 +32,9 @@
 // USER INCLUDES //////////////////////////////////////////////////////////////////////////////////
 #include "Common/Xfer.h"
 #include "Common/XferCRC.h"
+#if DEEP_CRC_TO_MEMORY
+#include <vector>
+#endif
 
 // FORWARD REFERENCES /////////////////////////////////////////////////////////////////////////////
 class Snapshot;
@@ -55,9 +58,19 @@ class XferDeepCRC : public XferCRC
 	virtual void xferAsciiString( AsciiString *asciiStringData ) override;  ///< xfer ascii string (need our own)
 	virtual void xferUnicodeString( UnicodeString *unicodeStringData ) override;	///< xfer unicode string (need our own);
 
+#if DEEP_CRC_TO_MEMORY
+	virtual void xferLogString(const AsciiString& str) override;
+	void changeXferMode(XferMode xferMode);
+#endif
+
 protected:
 
 	virtual void xferImplementation( void *data, Int dataSize ) override;
 
+#if DEEP_CRC_TO_MEMORY
+	std::vector<UnsignedByte>* m_buffer;									///< pointer to buffer
+	size_t m_bufferIndex;																	///< current index in buffer
+#else
 	FILE * m_fileFP;																			///< pointer to file
+#endif
 };

Core/GameEngine/Source/Common/RandomValue.cpp

@@ -76,6 +76,22 @@ UnsignedInt GetGameLogicRandomSeedCRC()
 	return c.get();
 }
 
+#if DEEP_CRC_TO_MEMORY
+AsciiString GetGameLogicalRandomSeeds()
+{
+	AsciiString str;
+	str.format("%8.8X, %8.8X, %8.8X, %8.8X, %8.8X, %8.8X",
+		theGameLogicSeed[0],
+		theGameLogicSeed[1],
+		theGameLogicSeed[2],
+		theGameLogicSeed[3],
+		theGameLogicSeed[4],
+		theGameLogicSeed[5]);
+
+	return str;
+}
+#endif
+
 static void seedRandom(UnsignedInt SEED, UnsignedInt (&seed)[6])
 {
 	UnsignedInt ax;

Core/GameEngine/Source/Common/System/XferCRC.cpp

@@ -36,6 +36,10 @@
 #include "Common/Snapshot.h"
 #include "Utility/endian_compat.h"
 
+#if DEEP_CRC_TO_MEMORY
+#include "GameLogic/GameLogic.h"
+#endif
+
 //-------------------------------------------------------------------------------------------------
 //-------------------------------------------------------------------------------------------------
 XferCRC::XferCRC()
@@ -175,8 +179,14 @@ UnsignedInt XferCRC::getCRC()
 XferDeepCRC::XferDeepCRC()
 {
 
+#if DEEP_CRC_TO_MEMORY
+	m_xferMode = XFER_CRC;
+	m_buffer = nullptr;
+	m_bufferIndex = 0;
+#else
 	m_xferMode = XFER_SAVE;
 	m_fileFP = nullptr;
+#endif
 
 }
 
@@ -185,6 +195,7 @@ XferDeepCRC::XferDeepCRC()
 XferDeepCRC::~XferDeepCRC()
 {
 
+#if !DEEP_CRC_TO_MEMORY
 	// warn the user if a file was left open
 	if( m_fileFP != nullptr )
 	{
@@ -193,6 +204,7 @@ XferDeepCRC::~XferDeepCRC()
 		close();
 
 	}
+#endif
 
 }
 
@@ -202,8 +214,13 @@ XferDeepCRC::~XferDeepCRC()
 void XferDeepCRC::open( AsciiString identifier )
 {
 
+#if DEEP_CRC_TO_MEMORY
+	m_xferMode = XFER_CRC;
+#else
 	m_xferMode = XFER_SAVE;
+#endif
 
+#if !DEEP_CRC_TO_MEMORY
 	// sanity, check to see if we're already open
 	if( m_fileFP != nullptr )
 	{
@@ -213,10 +230,26 @@ void XferDeepCRC::open( AsciiString identifier )
 		throw XFER_FILE_ALREADY_OPEN;
 
 	}
+#endif
 
 	// call base class
 	Xfer::open( identifier );
 
+#if DEEP_CRC_TO_MEMORY
+	m_buffer = &TheGameLogic->getCRCBuffer();
+
+	AsciiString str;
+	str.format("[ START OF DEEP CRC FRAME %d ]", TheGameLogic->getFrame());
+	const UnsignedInt length = str.getLength();
+
+	while (m_bufferIndex + length >= m_buffer->size())
+	{
+		m_buffer->resize(m_buffer->size() * 2);
+	}
+
+	memcpy(&(*m_buffer)[m_bufferIndex], str.str(), length);
+	m_bufferIndex += length;
+#else
 	// open the file
 	m_fileFP = fopen( identifier.str(), "w+b" );
 	if( m_fileFP == nullptr )
@@ -226,6 +259,7 @@ void XferDeepCRC::open( AsciiString identifier )
 		throw XFER_FILE_NOT_FOUND;
 
 	}
+#endif
 
 	// initialize CRC to brand new one at zero
 	m_crc = 0;
@@ -238,6 +272,21 @@ void XferDeepCRC::open( AsciiString identifier )
 void XferDeepCRC::close()
 {
 
+#if DEEP_CRC_TO_MEMORY
+	AsciiString str;
+	str.format("[ END OF DEEP CRC FRAME %d ]", TheGameLogic->getFrame());
+	const UnsignedInt length = str.getLength();
+
+	while (m_bufferIndex + length >= m_buffer->size())
+	{
+		m_buffer->resize(m_buffer->size() * 2);
+	}
+
+	memcpy(&(*m_buffer)[m_bufferIndex], str.str(), length);
+	m_bufferIndex += length;
+
+	TheGameLogic->storeCRCBuffer(m_bufferIndex);
+#else
 	// sanity, if we don't have an open file we can do nothing
 	if( m_fileFP == nullptr )
 	{
@@ -246,10 +295,15 @@ void XferDeepCRC::close()
 		throw XFER_FILE_NOT_OPEN;
 
 	}
+#endif
 
+#if DEEP_CRC_TO_MEMORY
+	m_buffer = nullptr;
+#else
 	// close the file
 	fclose( m_fileFP );
 	m_fileFP = nullptr;
+#endif
 
 	// erase the filename
 	m_identifier.clear();
@@ -267,6 +321,15 @@ void XferDeepCRC::xferImplementation( void *data, Int dataSize )
 		return;
 	}
 
+#if DEEP_CRC_TO_MEMORY
+	while (m_bufferIndex + dataSize >= m_buffer->size())
+	{
+		m_buffer->resize(m_buffer->size() * 2);
+	}
+
+	memcpy(&(*m_buffer)[m_bufferIndex], data, dataSize);
+	m_bufferIndex += dataSize;
+#else
 	// sanity
 	DEBUG_ASSERTCRASH( m_fileFP != nullptr, ("XferSave - file pointer for '%s' is null",
 										 m_identifier.str()) );
@@ -279,6 +342,7 @@ void XferDeepCRC::xferImplementation( void *data, Int dataSize )
 		throw XFER_WRITE_ERROR;
 
 	}
+#endif
 
 	XferCRC::xferImplementation( data, dataSize );
 
@@ -290,6 +354,11 @@ void XferDeepCRC::xferImplementation( void *data, Int dataSize )
 void XferDeepCRC::xferMarkerLabel( AsciiString asciiStringData )
 {
 
+#if DEEP_CRC_TO_MEMORY
+	XferCRC::xferMarkerLabel(asciiStringData);
+	return;
+#endif
+
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -298,6 +367,11 @@ void XferDeepCRC::xferMarkerLabel( AsciiString asciiStringData )
 void XferDeepCRC::xferAsciiString( AsciiString *asciiStringData )
 {
 
+#if DEEP_CRC_TO_MEMORY
+	XferCRC::xferAsciiString(asciiStringData);
+	return;
+#endif
+
 	// sanity
 	if( asciiStringData->getLength() > 16385 )
 	{
@@ -323,6 +397,11 @@ void XferDeepCRC::xferAsciiString( AsciiString *asciiStringData )
 void XferDeepCRC::xferUnicodeString( UnicodeString *unicodeStringData )
 {
 
+#if DEEP_CRC_TO_MEMORY
+	XferCRC::xferUnicodeString(unicodeStringData);
+	return;
+#endif
+
 	// sanity
 	if( unicodeStringData->getLength() > 255 )
 	{
@@ -341,3 +420,23 @@ void XferDeepCRC::xferUnicodeString( UnicodeString *unicodeStringData )
 		xferUser( (void *)unicodeStringData->str(), sizeof( WideChar ) * len );
 
 }
+
+#if DEEP_CRC_TO_MEMORY
+void XferDeepCRC::xferLogString(const AsciiString& str)
+{
+	const UnsignedInt length = str.getLength();
+
+	while (m_bufferIndex + length >= m_buffer->size())
+	{
+		m_buffer->resize(m_buffer->size() * 2);
+	}
+
+	memcpy(&(*m_buffer)[m_bufferIndex], str.str(), length);
+	m_bufferIndex += length;
+}
+
+void XferDeepCRC::changeXferMode(XferMode xferMode)
+{
+	m_xferMode = xferMode;
+}
+#endif

Core/GameEngine/Source/GameClient/ClientInstance.cpp

@@ -27,6 +27,8 @@ UnsignedInt ClientInstance::s_instanceIndex = 0;
 
 #if defined(RTS_MULTI_INSTANCE)
 Bool ClientInstance::s_isMultiInstance = true;
+#elif DEEP_CRC_TO_MEMORY
+Bool ClientInstance::s_isMultiInstance = true;
 #else
 Bool ClientInstance::s_isMultiInstance = false;
 #endif

Core/GameEngine/Source/GameNetwork/Network.cpp

@@ -55,6 +55,8 @@
 
 #if defined(DEBUG_CRC)
 Int NET_CRC_INTERVAL = 1;
+#elif DEEP_CRC_TO_MEMORY
+Int NET_CRC_INTERVAL = 1;
 #else
 Int NET_CRC_INTERVAL = 100;
 #endif

GeneralsMD/Code/GameEngine/Include/GameLogic/GameLogic.h

@@ -405,6 +405,16 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	void xferObjectTOC( Xfer *xfer );												///< save/load object TOC for current state of map
 	void prepareLogicForObjectLoad();									///< prepare engine for object data from game file
 
+#if DEEP_CRC_TO_MEMORY
+	UnsignedInt m_crcBufferIndex;
+	std::vector<UnsignedByte> m_crcWriteBuffer;
+	std::vector<UnsignedByte> m_crcBuffers[64];
+
+public:
+	std::vector<UnsignedByte>& getCRCBuffer();
+	void storeCRCBuffer(size_t size);
+	void writeCRCBuffersToDisk(UnsignedInt frame) const;
+#endif
 };
 
 // INLINE /////////////////////////////////////////////////////////////////////////////////////////

GeneralsMD/Code/GameEngine/Include/GameLogic/Object.h

@@ -818,6 +818,10 @@ class Object : public Thing, public Snapshot
 	Bool													m_singleUseCommandUsed;
 	Bool													m_isReceivingDifficultyBonus;
 
+#if DEEP_CRC_TO_MEMORY
+public:
+	const UpgradeMaskType& getUpgrades() const { return m_objectUpgradesCompleted; }
+#endif
 };
 
 // deleteInstance is not meant to be used with Object in order to require the use of TheGameLogic->destroyObject()