Skip to content

🧹 [Refactor TryLoadSaveDataIndexedV8 method to improve code health] #1421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
marko1olo wants to merge 1 commit into from
Closed

🧹 [Refactor TryLoadSaveDataIndexedV8 method to improve code health] #1421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 102 additions & 41 deletions Assets/_Project/Scripts/SaveBinaryStorage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5699,19 +5699,90 @@ private static bool TryLoadSaveDataIndexedV8(
}

int payloadCursor = cursor + saveDataLength;
if (!TryReadIndexedPackedQuestSectionV8(rawPtr, metadataRawLength, in header, ref payloadCursor, out packedQuestHeader, out packedQuestStateWords, out error))
return false;
playerDialogueChoiceFlags = ResolveLoadedPlayerDialogueChoiceFlags(
header.Version,
playerDialogueChoiceFlags,
packedQuestStateWords);

if (!TryReadIndexedEcosystemSectionV8(rawPtr, metadataRawLength, header.Version, ref payloadCursor, out ecosystemSectorStates, out error))
return false;
int voxelByteLength = math.max(0, metadataRawLength - payloadCursor);
if (voxelByteLength > 0)
{
if (!voxelDeltaSnapshotDestination.IsCreated || voxelDeltaSnapshotDestination.Length < voxelByteLength)
{
error = "Indexed voxel delta snapshot destination is too small.";
return false;
}

void* voxelDestinationPtr = NativeArrayUnsafeUtility.GetUnsafeBufferPointerWithoutChecks(voxelDeltaSnapshotDestination);
if (!UnsafeMemoryCopyGuard.SafeCopy(voxelDestinationPtr, voxelDeltaSnapshotDestination.Length, AddByteOffset(rawPtr, payloadCursor), voxelByteLength))
{
error = "Indexed voxel delta snapshot copy exceeded destination bounds.";
return false;
}

voxelDeltaSnapshotBytes = voxelByteLength;
}

if (!TryReadIndexedPersistentWorldDeltasV8(absolutePath, in prefix, sectorEntries, ref mapping, out persistentWorldDeltas, out indexedBackupRecoveryUsed, out error))
return false;

rawPayloadLength = metadataRawLength;
if (!TryToRuntimePosition(prefix.PlayerPosition, out Vector3 playerPosition))
{
error = "Indexed save payload contains an invalid player AUP position.";
return false;
}

metadata = new SaveMetadata
{
SlotName = slotName,
GameVersion = gameVersion,
Timestamp = ToUtcTicks(header.TimestampUnixMs),
PlayTimeSeconds = prefix.PlayTimeSeconds,
SceneName = SaveMetadata.NormalizeSceneName(sceneName),
PlayerPosition = playerPosition,
Checksum = FormatPayloadChecksum(in header)
};
return true;
}

private static unsafe bool TryReadIndexedPackedQuestSectionV8(
byte* rawPtr,
int metadataRawLength,
in SaveFileHeader header,
ref int payloadCursor,
out QuestSaveHeader packedQuestHeader,
out uint[] packedQuestStateWords,
out string error)
{
error = string.Empty;
if (!TryDecodePackedQuestWordCount(in header, out int packedQuestWordCount, out error))
{
packedQuestHeader = default;
packedQuestStateWords = null;
return false;
}

if (packedQuestWordCount > 0)
{
if (!IsByteRangeWithin(payloadCursor, PackedQuestStateSectionHeaderSize, metadataRawLength))
{
packedQuestHeader = default;
packedQuestStateWords = null;
error = "Indexed packed quest section header is truncated.";
return false;
}

packedQuestHeader = UnsafeUtility.ReadArrayElement<QuestSaveHeader>(AddByteOffset(rawPtr, payloadCursor), 0);
if (!TryValidatePackedQuestSectionHeader(in packedQuestHeader, packedQuestWordCount, out error))
{
packedQuestStateWords = null;
return false;
}

packedQuestStateWords = new uint[packedQuestWordCount];
payloadCursor += PackedQuestStateSectionHeaderSize;
Expand Down Expand Up @@ -5747,28 +5818,39 @@ private static bool TryLoadSaveDataIndexedV8(
packedQuestHeader = default;
packedQuestStateWords = Array.Empty<uint>();
}
playerDialogueChoiceFlags = ResolveLoadedPlayerDialogueChoiceFlags(
header.Version,
playerDialogueChoiceFlags,
packedQuestStateWords);

int ecosystemHeaderSize = ResolveEcosystemSectionHeaderSize(header.Version);
return true;
}

private static unsafe bool TryReadIndexedEcosystemSectionV8(
byte* rawPtr,
int metadataRawLength,
int headerVersion,
ref int payloadCursor,
out EcosystemSectorSaveRecord[] ecosystemSectorStates,
out string error)
{
error = string.Empty;
int ecosystemHeaderSize = ResolveEcosystemSectionHeaderSize(headerVersion);
if (!IsByteRangeWithin(payloadCursor, ecosystemHeaderSize, metadataRawLength))
{
ecosystemSectorStates = null;
error = "Indexed ecosystem section header is truncated.";
return false;
}

EcosystemSectionHeader ecosystemHeader = ReadEcosystemSectionHeader(AddByteOffset(rawPtr, payloadCursor), ecosystemHeaderSize);
if (!TryConvertSectionCount(ecosystemHeader.RecordCount, out int ecosystemRecordCount) ||
!TryComputeEcosystemSectionLength(ecosystemRecordCount, header.Version, out int ecosystemSectionLength))
!TryComputeEcosystemSectionLength(ecosystemRecordCount, headerVersion, out int ecosystemSectionLength))
{
ecosystemSectorStates = null;
error = "Indexed ecosystem section header exceeds supported bounds.";
return false;
}

if (!IsByteRangeWithin(payloadCursor, ecosystemSectionLength, metadataRawLength))
{
ecosystemSectorStates = null;
error = "Indexed ecosystem section exceeds the metadata payload bounds.";
return false;
}
Expand All @@ -5788,24 +5870,21 @@ private static bool TryLoadSaveDataIndexedV8(
}

payloadCursor += ecosystemSectionLength;
int voxelByteLength = math.max(0, metadataRawLength - payloadCursor);
if (voxelByteLength > 0)
{
if (!voxelDeltaSnapshotDestination.IsCreated || voxelDeltaSnapshotDestination.Length < voxelByteLength)
{
error = "Indexed voxel delta snapshot destination is too small.";
return false;
}

void* voxelDestinationPtr = NativeArrayUnsafeUtility.GetUnsafeBufferPointerWithoutChecks(voxelDeltaSnapshotDestination);
if (!UnsafeMemoryCopyGuard.SafeCopy(voxelDestinationPtr, voxelDeltaSnapshotDestination.Length, AddByteOffset(rawPtr, payloadCursor), voxelByteLength))
{
error = "Indexed voxel delta snapshot copy exceeded destination bounds.";
return false;
}
return true;
}

voxelDeltaSnapshotBytes = voxelByteLength;
}
private static unsafe bool TryReadIndexedPersistentWorldDeltasV8(
string absolutePath,
in PayloadPrefixInfo prefix,
SectorEntry[] sectorEntries,
ref AsyncWriteManager.ReadOnlyMapping mapping,
out PersistentWorldDeltaRecord[] persistentWorldDeltas,
out bool indexedBackupRecoveryUsed,
out string error)
{
persistentWorldDeltas = null;
indexedBackupRecoveryUsed = false;
error = string.Empty;

NativeList<PersistentWorldDeltaRecord> aggregatedWorldDeltas = CreateRegisteredTransientNativeList<PersistentWorldDeltaRecord>(
256,
Expand Down Expand Up @@ -5901,24 +5980,6 @@ private static bool TryLoadSaveDataIndexedV8(
ref aggregatedWorldDeltasSentinelId,
IndexedSectorAggregatedWorldDeltasScratchLabel);
}

rawPayloadLength = metadataRawLength;
if (!TryToRuntimePosition(prefix.PlayerPosition, out Vector3 playerPosition))
{
error = "Indexed save payload contains an invalid player AUP position.";
return false;
}

metadata = new SaveMetadata
{
SlotName = slotName,
GameVersion = gameVersion,
Timestamp = ToUtcTicks(header.TimestampUnixMs),
PlayTimeSeconds = prefix.PlayTimeSeconds,
SceneName = SaveMetadata.NormalizeSceneName(sceneName),
PlayerPosition = playerPosition,
Checksum = FormatPayloadChecksum(in header)
};
return true;
}

Expand Down