|
| 1 | +// <copyright file="RecoveryManager.cs" company="MPCoreDeveloper"> |
| 2 | +// Copyright (c) 2025-2026 MPCoreDeveloper and GitHub Copilot. All rights reserved. |
| 3 | +// Licensed under the MIT License. See LICENSE file in the project root for full license information. |
| 4 | +// </copyright> |
| 5 | + |
| 6 | +namespace SharpCoreDB.Storage.Scdb; |
| 7 | + |
| 8 | +using System; |
| 9 | +using System.Collections.Generic; |
| 10 | +using System.Linq; |
| 11 | +using System.Threading; |
| 12 | +using System.Threading.Tasks; |
| 13 | +using SharpCoreDB.Storage; |
| 14 | + |
| 15 | +/// <summary> |
| 16 | +/// Recovery manager for crash recovery using WAL replay. |
| 17 | +/// Implements REDO-only recovery (no UNDO needed with write-ahead guarantee). |
| 18 | +/// C# 14: Modern async patterns with Lock type. |
| 19 | +/// </summary> |
| 20 | +internal sealed class RecoveryManager : IDisposable |
| 21 | +{ |
| 22 | + private readonly SingleFileStorageProvider _provider; |
| 23 | + private readonly WalManager _walManager; |
| 24 | + private readonly Lock _recoveryLock = new(); // ✅ C# 14: Lock type |
| 25 | + private bool _disposed; |
| 26 | + |
| 27 | + public RecoveryManager(SingleFileStorageProvider provider, WalManager walManager) |
| 28 | + { |
| 29 | + ArgumentNullException.ThrowIfNull(provider); |
| 30 | + ArgumentNullException.ThrowIfNull(walManager); |
| 31 | + |
| 32 | + _provider = provider; |
| 33 | + _walManager = walManager; |
| 34 | + } |
| 35 | + |
| 36 | + /// <summary> |
| 37 | + /// Performs crash recovery by replaying WAL entries. |
| 38 | + /// REDO-only: Replays committed transactions, ignores uncommitted. |
| 39 | + /// </summary> |
| 40 | + /// <returns>Recovery information with statistics.</returns> |
| 41 | + public async Task<RecoveryInfo> RecoverAsync(CancellationToken cancellationToken = default) |
| 42 | + { |
| 43 | + lock (_recoveryLock) |
| 44 | + { |
| 45 | + if (_disposed) |
| 46 | + { |
| 47 | + throw new ObjectDisposedException(nameof(RecoveryManager)); |
| 48 | + } |
| 49 | + } |
| 50 | + |
| 51 | + var startTime = DateTime.UtcNow; |
| 52 | + |
| 53 | + // Step 1: Analyze WAL to identify committed transactions |
| 54 | + var analysis = await AnalyzeWalAsync(cancellationToken); |
| 55 | + |
| 56 | + if (analysis.TotalEntries == 0) |
| 57 | + { |
| 58 | + // No recovery needed |
| 59 | + return new RecoveryInfo |
| 60 | + { |
| 61 | + RecoveryNeeded = false, |
| 62 | + TotalEntries = 0, |
| 63 | + CommittedTransactions = 0, |
| 64 | + UncommittedTransactions = 0, |
| 65 | + OperationsReplayed = 0, |
| 66 | + RecoveryTime = TimeSpan.Zero |
| 67 | + }; |
| 68 | + } |
| 69 | + |
| 70 | + // Step 2: Replay committed transactions in LSN order |
| 71 | + var replayed = await ReplayCommittedTransactionsAsync(analysis, cancellationToken); |
| 72 | + |
| 73 | + var duration = DateTime.UtcNow - startTime; |
| 74 | + |
| 75 | + return new RecoveryInfo |
| 76 | + { |
| 77 | + RecoveryNeeded = true, |
| 78 | + TotalEntries = analysis.TotalEntries, |
| 79 | + CommittedTransactions = analysis.CommittedTransactions.Count, |
| 80 | + UncommittedTransactions = analysis.UncommittedTransactions.Count, |
| 81 | + OperationsReplayed = replayed, |
| 82 | + RecoveryTime = duration |
| 83 | + }; |
| 84 | + } |
| 85 | + |
| 86 | + /// <summary> |
| 87 | + /// Analyzes WAL to build transaction map. |
| 88 | + /// Identifies committed vs uncommitted transactions. |
| 89 | + /// </summary> |
| 90 | + private async Task<WalAnalysisResult> AnalyzeWalAsync(CancellationToken cancellationToken) |
| 91 | + { |
| 92 | + var entries = await _walManager.ReadEntriesSinceCheckpointAsync(cancellationToken); |
| 93 | + |
| 94 | + var activeTransactions = new HashSet<ulong>(); |
| 95 | + var committedTransactions = new HashSet<ulong>(); |
| 96 | + var operations = new Dictionary<ulong, List<WalEntry>>(); // txId → operations |
| 97 | + |
| 98 | + foreach (var entry in entries) |
| 99 | + { |
| 100 | + var txId = entry.TransactionId; |
| 101 | + |
| 102 | + switch ((WalOperation)entry.Operation) |
| 103 | + { |
| 104 | + case WalOperation.TransactionBegin: |
| 105 | + activeTransactions.Add(txId); |
| 106 | + operations[txId] = new List<WalEntry>(); |
| 107 | + break; |
| 108 | + |
| 109 | + case WalOperation.TransactionCommit: |
| 110 | + if (activeTransactions.Contains(txId)) |
| 111 | + { |
| 112 | + committedTransactions.Add(txId); |
| 113 | + activeTransactions.Remove(txId); |
| 114 | + } |
| 115 | + break; |
| 116 | + |
| 117 | + case WalOperation.TransactionAbort: |
| 118 | + // Transaction aborted, remove from active |
| 119 | + activeTransactions.Remove(txId); |
| 120 | + operations.Remove(txId); |
| 121 | + break; |
| 122 | + |
| 123 | + case WalOperation.Insert: |
| 124 | + case WalOperation.Update: |
| 125 | + case WalOperation.Delete: |
| 126 | + // Add operation to transaction |
| 127 | + if (operations.ContainsKey(txId)) |
| 128 | + { |
| 129 | + operations[txId].Add(entry); |
| 130 | + } |
| 131 | + break; |
| 132 | + } |
| 133 | + } |
| 134 | + |
| 135 | + // Uncommitted = still active |
| 136 | + var uncommittedTransactions = new HashSet<ulong>(activeTransactions); |
| 137 | + |
| 138 | + return new WalAnalysisResult |
| 139 | + { |
| 140 | + TotalEntries = entries.Count, |
| 141 | + CommittedTransactions = committedTransactions, |
| 142 | + UncommittedTransactions = uncommittedTransactions, |
| 143 | + Operations = operations |
| 144 | + }; |
| 145 | + } |
| 146 | + |
| 147 | + /// <summary> |
| 148 | + /// Replays committed transactions in LSN order. |
| 149 | + /// Applies operations to block registry and data files. |
| 150 | + /// </summary> |
| 151 | + private async Task<int> ReplayCommittedTransactionsAsync( |
| 152 | + WalAnalysisResult analysis, |
| 153 | + CancellationToken cancellationToken) |
| 154 | + { |
| 155 | + var replayedCount = 0; |
| 156 | + |
| 157 | + // Get all operations from committed transactions, sorted by LSN |
| 158 | + var operationsToReplay = analysis.Operations |
| 159 | + .Where(kvp => analysis.CommittedTransactions.Contains(kvp.Key)) |
| 160 | + .SelectMany(kvp => kvp.Value) |
| 161 | + .OrderBy(entry => entry.Lsn) |
| 162 | + .ToList(); |
| 163 | + |
| 164 | + foreach (var entry in operationsToReplay) |
| 165 | + { |
| 166 | + await ReplayOperationAsync(entry, cancellationToken); |
| 167 | + replayedCount++; |
| 168 | + } |
| 169 | + |
| 170 | + // Flush after all replays |
| 171 | + await _provider.FlushAsync(cancellationToken); |
| 172 | + |
| 173 | + return replayedCount; |
| 174 | + } |
| 175 | + |
| 176 | + /// <summary> |
| 177 | + /// Replays a single WAL operation. |
| 178 | + /// </summary> |
| 179 | + private async Task ReplayOperationAsync(WalEntry entry, CancellationToken cancellationToken) |
| 180 | + { |
| 181 | + switch ((WalOperation)entry.Operation) |
| 182 | + { |
| 183 | + case WalOperation.Insert: |
| 184 | + await ReplayInsertAsync(entry, cancellationToken); |
| 185 | + break; |
| 186 | + |
| 187 | + case WalOperation.Update: |
| 188 | + await ReplayUpdateAsync(entry, cancellationToken); |
| 189 | + break; |
| 190 | + |
| 191 | + case WalOperation.Delete: |
| 192 | + await ReplayDeleteAsync(entry, cancellationToken); |
| 193 | + break; |
| 194 | + |
| 195 | + default: |
| 196 | + // Skip unknown operations |
| 197 | + break; |
| 198 | + } |
| 199 | + } |
| 200 | + |
| 201 | + /// <summary> |
| 202 | + /// Replays an INSERT operation. |
| 203 | + /// </summary> |
| 204 | + private async Task ReplayInsertAsync(WalEntry entry, CancellationToken cancellationToken) |
| 205 | + { |
| 206 | + // In a real implementation: |
| 207 | + // 1. Read data from WAL entry |
| 208 | + // 2. Write to block at specified offset |
| 209 | + // 3. Update block registry |
| 210 | + |
| 211 | + // For now, stub implementation |
| 212 | + await Task.CompletedTask; |
| 213 | + } |
| 214 | + |
| 215 | + /// <summary> |
| 216 | + /// Replays an UPDATE operation. |
| 217 | + /// </summary> |
| 218 | + private async Task ReplayUpdateAsync(WalEntry entry, CancellationToken cancellationToken) |
| 219 | + { |
| 220 | + // In a real implementation: |
| 221 | + // 1. Read new data from WAL entry |
| 222 | + // 2. Overwrite block at specified offset |
| 223 | + // 3. Update metadata |
| 224 | + |
| 225 | + await Task.CompletedTask; |
| 226 | + } |
| 227 | + |
| 228 | + /// <summary> |
| 229 | + /// Replays a DELETE operation. |
| 230 | + /// </summary> |
| 231 | + private async Task ReplayDeleteAsync(WalEntry entry, CancellationToken cancellationToken) |
| 232 | + { |
| 233 | + // In a real implementation: |
| 234 | + // 1. Mark block as deleted in registry |
| 235 | + // 2. Free pages in FSM |
| 236 | + // 3. Update metadata |
| 237 | + |
| 238 | + await Task.CompletedTask; |
| 239 | + } |
| 240 | + |
| 241 | + /// <inheritdoc/> |
| 242 | + public void Dispose() |
| 243 | + { |
| 244 | + if (_disposed) return; |
| 245 | + |
| 246 | + lock (_recoveryLock) |
| 247 | + { |
| 248 | + _disposed = true; |
| 249 | + } |
| 250 | + } |
| 251 | +} |
| 252 | + |
| 253 | +/// <summary> |
| 254 | +/// Result of WAL analysis for recovery. |
| 255 | +/// </summary> |
| 256 | +internal sealed class WalAnalysisResult |
| 257 | +{ |
| 258 | + public required int TotalEntries { get; init; } |
| 259 | + public required HashSet<ulong> CommittedTransactions { get; init; } |
| 260 | + public required HashSet<ulong> UncommittedTransactions { get; init; } |
| 261 | + public required Dictionary<ulong, List<WalEntry>> Operations { get; init; } |
| 262 | +} |
| 263 | + |
| 264 | +/// <summary> |
| 265 | +/// Information about recovery process. |
| 266 | +/// C# 14: Record struct with required properties. |
| 267 | +/// </summary> |
| 268 | +public readonly record struct RecoveryInfo |
| 269 | +{ |
| 270 | + /// <summary>Was recovery needed?</summary> |
| 271 | + public required bool RecoveryNeeded { get; init; } |
| 272 | + |
| 273 | + /// <summary>Total WAL entries scanned.</summary> |
| 274 | + public required int TotalEntries { get; init; } |
| 275 | + |
| 276 | + /// <summary>Number of committed transactions replayed.</summary> |
| 277 | + public required int CommittedTransactions { get; init; } |
| 278 | + |
| 279 | + /// <summary>Number of uncommitted transactions discarded.</summary> |
| 280 | + public required int UncommittedTransactions { get; init; } |
| 281 | + |
| 282 | + /// <summary>Number of operations replayed.</summary> |
| 283 | + public required int OperationsReplayed { get; init; } |
| 284 | + |
| 285 | + /// <summary>Total recovery time.</summary> |
| 286 | + public required TimeSpan RecoveryTime { get; init; } |
| 287 | + |
| 288 | + /// <summary> |
| 289 | + /// Returns human-readable summary. |
| 290 | + /// </summary> |
| 291 | + public override string ToString() |
| 292 | + { |
| 293 | + if (!RecoveryNeeded) |
| 294 | + { |
| 295 | + return "No recovery needed"; |
| 296 | + } |
| 297 | + |
| 298 | + return $"Recovery: {OperationsReplayed} operations from {CommittedTransactions} transactions " + |
| 299 | + $"in {RecoveryTime.TotalMilliseconds:F0}ms"; |
| 300 | + } |
| 301 | +} |
0 commit comments