using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; using System.Security.Cryptography; using System.Threading; using System.Threading.Tasks; using MessagePack; namespace GameCult.Caching.MessagePack; /// /// MessagePack backing store that keeps a small schema manifest hot and stores each record as its own cold file. /// public sealed class DirectoryMessagePackBackingStore : CacheBackingStore { private const string IndexedFormatVersion = "cultcache.store.v4.directory-content-addressed-pages"; private readonly FileInfo _manifestFile; private readonly DirectoryInfo _recordDirectory; private readonly object _mutationGate = new(); private readonly ConcurrentDictionary _dirtyKeys = new(StringComparer.Ordinal); private readonly ConcurrentDictionary _deletedKeys = new(StringComparer.Ordinal); private readonly HashSet _hydratedKeys = new(StringComparer.Ordinal); private Dictionary _durableIndex = new(StringComparer.Ordinal); private CultSchemaCatalogEntry[] _durableCatalog = Array.Empty(); /// /// Creates a paged MessagePack backing store. /// public DirectoryMessagePackBackingStore(string manifestPath, string? recordDirectoryPath = null) { if (string.IsNullOrWhiteSpace(manifestPath)) { throw new ArgumentException("Manifest path must be non-empty.", nameof(manifestPath)); } _manifestFile = new FileInfo(manifestPath); _recordDirectory = new DirectoryInfo(recordDirectoryPath ?? DefaultRecordDirectoryPath(manifestPath)); } /// /// Gets the default record directory path for a manifest path. /// public static string DefaultRecordDirectoryPath(string manifestPath) => manifestPath + ".records"; /// public override void PullAll() { lock (_mutationGate) PullAllCore(); } private void PullAllCore() { var traceStartup = string.Equals( Environment.GetEnvironmentVariable("CULTCACHE_TRACE_STARTUP_PHASES"), "1", StringComparison.Ordinal); var startupPhase = Stopwatch.StartNew(); void Trace(string phase) { if (traceStartup) Console.WriteLine($"CultCache directory-pull phase {phase} took {startupPhase.Elapsed.TotalMilliseconds:0.###}ms."); startupPhase.Restart(); } var reports = new List(); var loaded = new Dictionary(StringComparer.Ordinal); using (AcquireCommitLease()) { var manifest = ReadManifest(); Trace($"manifest records={manifest.Records.Length}"); _durableCatalog = manifest.SchemaCatalog; _durableIndex = manifest.Records .Where(record => !string.IsNullOrWhiteSpace(record.Key)) .GroupBy(record => record.Key, StringComparer.Ordinal) .ToDictionary(group => group.Key, group => group.Last(), StringComparer.Ordinal); LoadRecordPages( manifest.Records.OrderBy(record => record.Key, StringComparer.Ordinal).ToArray(), manifest.SchemaCatalog, loaded, reports); Trace($"indexed-pages loaded={loaded.Count}"); } foreach (var pair in loaded) { if (_dirtyKeys.ContainsKey(pair.Key) || _deletedKeys.ContainsKey(pair.Key)) continue; if (Entries.TryGetValue(pair.Key, out var existing) && string.Equals(existing.StoredAt, pair.Value.StoredAt, StringComparison.Ordinal) && string.Equals(existing.Descriptor.SchemaId, pair.Value.Descriptor.SchemaId, StringComparison.Ordinal)) { continue; } Entries[pair.Key] = pair.Value; Loaded?.Invoke(pair.Value); } foreach (var removedKey in _hydratedKeys.Where(key => !loaded.ContainsKey(key)).ToArray()) { if (_dirtyKeys.ContainsKey(removedKey) || _deletedKeys.ContainsKey(removedKey)) continue; if (Entries.TryRemove(removedKey, out var removed)) Unloaded?.Invoke(removed); _hydratedKeys.Remove(removedKey); } foreach (var key in loaded.Keys) _hydratedKeys.Add(key); SetLastSchemaMigrationReports(reports); IsDirty = !_dirtyKeys.IsEmpty || !_deletedKeys.IsEmpty; Trace("publish"); } /// public override bool ContainsDurableRecord(CultRecordKey key) { lock (_mutationGate) return _durableIndex.ContainsKey(key.Value) || base.ContainsDurableRecord(key); } /// public override void Push(CultStoredDocument entry) { lock (_mutationGate) { Entries[entry.Key.Value] = entry; _dirtyKeys[entry.Key.Value] = true; _deletedKeys.TryRemove(entry.Key.Value, out _); IsDirty = true; } } /// public override void Delete(CultStoredDocument entry) { lock (_mutationGate) { Entries.TryRemove(entry.Key.Value, out _); _dirtyKeys.TryRemove(entry.Key.Value, out _); _deletedKeys[entry.Key.Value] = true; IsDirty = true; } } /// public override void CommitBatch( IReadOnlyCollection upserts, IReadOnlyCollection deletes) { lock (_mutationGate) { var previousEntries = Entries.ToDictionary(pair => pair.Key, pair => pair.Value, StringComparer.Ordinal); var previousDirtyKeys = _dirtyKeys.Keys.ToArray(); var previousDeletedKeys = _deletedKeys.Keys.ToArray(); var wasDirty = IsDirty; try { foreach (var entry in deletes) { Entries.TryRemove(entry.Key.Value, out _); _dirtyKeys.TryRemove(entry.Key.Value, out _); _deletedKeys[entry.Key.Value] = true; } foreach (var entry in upserts) { Entries[entry.Key.Value] = entry; _dirtyKeys[entry.Key.Value] = true; _deletedKeys.TryRemove(entry.Key.Value, out _); } IsDirty = true; PushAllCore(); } catch { Entries.Clear(); foreach (var pair in previousEntries) Entries[pair.Key] = pair.Value; _dirtyKeys.Clear(); foreach (var key in previousDirtyKeys) _dirtyKeys[key] = true; _deletedKeys.Clear(); foreach (var key in previousDeletedKeys) _deletedKeys[key] = true; IsDirty = wasDirty; throw; } } } /// public override void PushAll() { lock (_mutationGate) PushAllCore(); } private void PushAllCore() { if (!IsDirty) { return; } Directory.CreateDirectory(_manifestFile.DirectoryName!); Directory.CreateDirectory(_recordDirectory.FullName); using var commitLease = AcquireCommitLease(); var currentManifest = ReadManifest(); var currentIndex = currentManifest.Records.ToDictionary(record => record.Key, record => record, StringComparer.Ordinal); foreach (var key in _deletedKeys.Keys) currentIndex.Remove(key); foreach (var key in _dirtyKeys.Keys) { if (Entries.TryGetValue(key, out var stored)) currentIndex[key] = ToIndexRecord(stored); } var catalogCandidates = currentManifest.SchemaCatalog .Concat(_durableCatalog) .Concat(Entries.Values.Select(entry => entry.Descriptor.ToCatalogEntry())) .GroupBy(entry => entry.SchemaId, StringComparer.Ordinal) .Select(group => group.Last()) .ToArray(); var usedSchemaIds = currentIndex.Values.Select(record => record.SchemaId).ToHashSet(StringComparer.Ordinal); var targetCatalog = catalogCandidates .Where(entry => usedSchemaIds.Contains(entry.SchemaId)) .OrderBy(entry => entry.SchemaName, StringComparer.Ordinal) .ToArray(); var keysToWrite = _dirtyKeys.Keys .OrderBy(value => value, StringComparer.Ordinal) .ToArray(); foreach (var key in keysToWrite) { if (!Entries.TryGetValue(key, out var stored)) { continue; } var record = ToPersistedRecord(stored, document => CultDocumentMessagePackSerialization.SerializeUntyped( document, stored.Descriptor.DocumentType, Registry)); var pagePayload = CultDocumentMessagePackSerialization.SerializePersistedRecord(record); var indexRecord = ToContentAddressedIndexRecord(record, pagePayload); currentIndex[key] = indexRecord; WriteFileAtomically( ContentAddressedRecordPath(indexRecord), pagePayload); } WriteManifest(targetCatalog, currentIndex.Values .OrderBy(record => record.Key, StringComparer.Ordinal) .ToArray()); DeleteUnreferencedRecordPages(currentIndex.Values); _durableCatalog = targetCatalog; _durableIndex = currentIndex; _dirtyKeys.Clear(); _deletedKeys.Clear(); MarkFlushSucceeded(); } private void WriteManifest(CultSchemaCatalogEntry[] catalog, CultPersistedRecord[] index) { var manifest = new CultPersistedStoreSnapshot { FormatVersion = IndexedFormatVersion, SchemaCatalog = catalog, Records = index }; WriteFileAtomically(_manifestFile.FullName, CultDocumentMessagePackSerialization.SerializeSnapshot(manifest)); } private void LoadRecordPages( CultPersistedRecord[] records, IReadOnlyCollection catalogEntries, Dictionary loaded, List reports) { var tracePages = string.Equals( Environment.GetEnvironmentVariable("CULTCACHE_TRACE_STARTUP_PHASES"), "1", StringComparison.Ordinal); var recordReports = new CultSchemaMigrationReport[records.Length]; var storedRecords = new CultStoredDocument?[records.Length]; var pageBytes = tracePages ? new long[records.Length] : Array.Empty(); var pageElapsedTicks = tracePages ? new long[records.Length] : Array.Empty(); Parallel.For( 0, records.Length, new ParallelOptions { MaxDegreeOfParallelism = Math.Min(Environment.ProcessorCount, 8) }, index => { var started = tracePages ? Stopwatch.GetTimestamp() : 0L; var metadata = records[index]; var record = ReadPersistedRecordPage(metadata, out var pagePayload); var catalog = ResolveLegacyUncataloguedRecordCatalog(record, catalogEntries); recordReports[index] = Registry.ResolvePersistedSchemaReport(record.SchemaId, catalog); storedRecords[index] = ToStoredDocument( record, catalog, (type, payload) => CultDocumentMessagePackSerialization.DeserializeUntyped(type, payload, Registry)); if (tracePages) { pageBytes[index] = pagePayload.LongLength; pageElapsedTicks[index] = Stopwatch.GetTimestamp() - started; } }); if (tracePages) { var schemaNames = catalogEntries.ToDictionary(entry => entry.SchemaId, entry => entry.SchemaName, StringComparer.Ordinal); foreach (var group in records .Select((record, index) => new { record.SchemaId, Index = index }) .Where(item => pageElapsedTicks[item.Index] > 0) .GroupBy(item => item.SchemaId, StringComparer.Ordinal) .Select(group => new { SchemaId = group.Key, Count = group.Count(), Bytes = group.Sum(item => pageBytes[item.Index]), TotalMs = group.Sum(item => pageElapsedTicks[item.Index]) * 1000d / Stopwatch.Frequency, MaxMs = group.Max(item => pageElapsedTicks[item.Index]) * 1000d / Stopwatch.Frequency }) .OrderByDescending(group => group.TotalMs) .Take(10)) { var schemaName = schemaNames.TryGetValue(group.SchemaId, out var name) ? name : group.SchemaId; Console.WriteLine( $"CultCache directory-page schema={schemaName} count={group.Count} bytes={group.Bytes} " + $"cumulative={group.TotalMs:0.###}ms max={group.MaxMs:0.###}ms."); } } for (var index = 0; index < storedRecords.Length; index++) { var stored = storedRecords[index]; if (stored == null) continue; reports.Add(recordReports[index]); loaded[stored.Key.Value] = stored; } } private static CultPersistedRecord ToIndexRecord(CultStoredDocument stored) => new() { Key = stored.Key.Value, SchemaId = stored.Descriptor.SchemaId, StoredAt = stored.StoredAt, Payload = Array.Empty() }; private static CultPersistedRecord ToContentAddressedIndexRecord( CultPersistedRecord record, byte[] pagePayload) => new() { Key = record.Key, SchemaId = record.SchemaId, StoredAt = record.StoredAt, Payload = HashPayload(pagePayload) }; // A missing manifest is an empty store. An existing manifest in any other format is refused. private CultPersistedStoreSnapshot ReadManifest() { if (!File.Exists(_manifestFile.FullName)) { return new CultPersistedStoreSnapshot { FormatVersion = IndexedFormatVersion, SchemaCatalog = Array.Empty(), Records = Array.Empty() }; } var snapshot = CultDocumentMessagePackSerialization.DeserializeSnapshot(ReadAllBytesShared(_manifestFile.FullName)); if (!string.Equals(snapshot.FormatVersion, IndexedFormatVersion, StringComparison.Ordinal)) { throw new InvalidOperationException( $"Directory store {_manifestFile.FullName} is {snapshot.FormatVersion}; only {IndexedFormatVersion} is readable."); } return snapshot; } // Explicit compatibility path for records written before catalog precommit existed. private IReadOnlyCollection ResolveLegacyUncataloguedRecordCatalog( CultPersistedRecord record, IReadOnlyCollection manifestCatalog) { if (manifestCatalog.Any(entry => string.Equals(entry.SchemaId, record.SchemaId, StringComparison.Ordinal))) { return manifestCatalog; } var schemaVersion = TryReadPayloadSchemaVersion(record.Payload); if (string.IsNullOrWhiteSpace(schemaVersion)) { return manifestCatalog; } var schemaName = InferSchemaName(schemaVersion); if (string.IsNullOrWhiteSpace(schemaName)) { return manifestCatalog; } return manifestCatalog .Append(new CultSchemaCatalogEntry { SchemaId = record.SchemaId, SchemaName = schemaName, SchemaVersion = schemaVersion, ContentHash = record.SchemaId, CanonicalSchemaJson = "", CompatibleSchemaIds = Array.Empty(), Members = Array.Empty() }) .ToArray(); } private static string TryReadPayloadSchemaVersion(byte[] payload) { if (payload == null || payload.Length == 0) { return ""; } try { var reader = new MessagePackReader(payload); if (reader.NextMessagePackType != MessagePackType.Array) { return ""; } if (reader.ReadArrayHeader() <= 0) { return ""; } return reader.NextMessagePackType == MessagePackType.String ? reader.ReadString() ?? "" : ""; } catch { return ""; } } private static string InferSchemaName(string schemaVersion) { var versionMarker = schemaVersion.LastIndexOf(".v", StringComparison.Ordinal); return versionMarker > 0 && versionMarker + 2 < schemaVersion.Length && char.IsDigit(schemaVersion[versionMarker + 2]) ? schemaVersion.Substring(0, versionMarker) : ""; } private string ContentAddressedRecordPath(CultPersistedRecord metadata) { if (metadata.Payload == null || metadata.Payload.Length != 32) throw new InvalidDataException($"Record '{metadata.Key}' has no committed SHA-256 page identity."); var hash = BitConverter.ToString(metadata.Payload).Replace("-", string.Empty).ToLowerInvariant(); return Path.Combine(_recordDirectory.FullName, $"{hash}.msgpack"); } private static byte[] HashPayload(byte[] payload) { using var sha256 = SHA256.Create(); return sha256.ComputeHash(payload); } private void DeleteUnreferencedRecordPages(IEnumerable durableRecords) { var referenced = durableRecords .Select(ContentAddressedRecordPath) .ToHashSet(StringComparer.OrdinalIgnoreCase); foreach (var file in _recordDirectory.EnumerateFiles("*.msgpack")) { if (referenced.Contains(file.FullName)) continue; try { File.Delete(file.FullName); } catch (IOException) { // An orphan is harmless: no committed manifest references it. } catch (UnauthorizedAccessException) { // Cleanup is best effort and never changes the committed generation. } } } private CultPersistedRecord ReadPersistedRecordPage(CultPersistedRecord metadata, out byte[] pagePayload) { var path = ContentAddressedRecordPath(metadata); if (!File.Exists(path)) throw new InvalidDataException($"Committed record page '{path}' is missing from the selected manifest generation."); pagePayload = ReadAllBytesShared(path); if (!HashPayload(pagePayload).SequenceEqual(metadata.Payload)) throw new InvalidDataException($"Record page '{path}' does not match its committed content hash."); var record = CultDocumentMessagePackSerialization.DeserializePersistedRecord(pagePayload); if (!string.Equals(record.Key, metadata.Key, StringComparison.Ordinal)) throw new InvalidDataException($"Record page '{path}' contains key '{record.Key}', expected '{metadata.Key}'."); return record; } private static void WriteFileAtomically(string path, byte[] payload) { var directory = Path.GetDirectoryName(path)!; Directory.CreateDirectory(directory); var tempPath = Path.Combine(directory, $".{Path.GetFileName(path)}.{Guid.NewGuid():N}.tmp"); try { using (var stream = new FileStream( tempPath, FileMode.CreateNew, FileAccess.Write, FileShare.None, bufferSize: 4096, FileOptions.WriteThrough)) { stream.Write(payload, 0, payload.Length); stream.Flush(true); } if (File.Exists(path)) { ReplaceExistingFile(tempPath, path); } else { File.Move(tempPath, path); } } finally { if (File.Exists(tempPath)) { File.Delete(tempPath); } } } private static byte[] ReadAllBytesShared(string path) { using var stream = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite | FileShare.Delete); using var buffer = new MemoryStream(); stream.CopyTo(buffer); return buffer.ToArray(); } private FileStream AcquireCommitLease() { Directory.CreateDirectory(_recordDirectory.FullName); var lockPath = Path.Combine(_recordDirectory.FullName, ".commit.lock"); var started = Stopwatch.StartNew(); while (true) { try { return new FileStream( lockPath, FileMode.OpenOrCreate, FileAccess.ReadWrite, FileShare.None, bufferSize: 1, FileOptions.WriteThrough); } catch (IOException) when (started.Elapsed < TimeSpan.FromSeconds(30)) { Thread.Sleep(10); } } } private static void ReplaceExistingFile(string sourcePath, string destinationPath) { for (var attempt = 0; attempt < 3; attempt++) { try { File.Replace(sourcePath, destinationPath, null); return; } catch (IOException) when (attempt < 2) { Thread.Sleep(10 * (attempt + 1)); } catch (UnauthorizedAccessException) when (attempt < 2) { Thread.Sleep(10 * (attempt + 1)); } } File.Replace(sourcePath, destinationPath, null); } }