Skip to content

Commit f96ee7e

Browse files
badrishcCopilot
andcommitted
chore: clean up stale comments across PR
- EvictRecordsInRange: update XML doc and skip-condition comments to reflect that sealed records are now visited (not skipped) and InPlaceDeleter no longer does heap tracking - GarnetRecordTriggers.OnDispose: simplify comment now that tombstone is always set AFTER OnDispose in all paths - Remove legacy SubscribeEvictions reference from EvictRecordsInRange doc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 89cbce5 commit f96ee7e

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

libs/storage/Tsavorite/cs/src/core/Allocator/ObjectAllocatorImpl.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -345,12 +345,12 @@ internal void OnDisposeDiskRecord(ref DiskLogRecord logRecord, DisposeReason dis
345345

346346
/// <summary>
347347
/// Iterate records in the given logical address range and call <see cref="IStoreFunctions.OnEvict"/>
348-
/// on each valid, non-tombstoned record. Used during page eviction to allow cleanup of external resources.
348+
/// on each non-null, non-invalid, non-tombstoned record — including sealed source records that
349+
/// may still own heap. Used during page eviction to allow cleanup of external resources.
349350
/// The caller constrains <paramref name="startAddress"/> / <paramref name="endAddress"/> to lie on a single page
350351
/// (see <see cref="AllocatorBase{TStoreFunctions, TAllocator}.OnPagesClosedWorker"/> and
351352
/// <see cref="AllocatorBase{TStoreFunctions, TAllocator}.EvictPageForRecovery"/>), so this routine walks records
352-
/// within that single page only — matching the <see cref="ObjectScanIterator{TStoreFunctions, TAllocator}"/>
353-
/// semantics with <c>includeClosedRecords: false</c> that the legacy <c>SubscribeEvictions</c> path used.
353+
/// within that single page only.
354354
/// </summary>
355355
internal void EvictRecordsInRange(long startAddress, long endAddress, EvictionSource source)
356356
{
@@ -382,7 +382,7 @@ internal void EvictRecordsInRange(long startAddress, long endAddress, EvictionSo
382382
// - Invalid: record was elided from the hash chain and already disposed
383383
// (OnDispose(Deleted/Elided) or transferred to the revivification freelist).
384384
// - Tombstone: heap was already decremented at the delete site via
385-
// OnDispose(Deleted) or InPlaceDeleter.
385+
// OnDispose(Deleted).
386386
//
387387
// Sealed-but-Valid records are NOT skipped. A Sealed source record from a
388388
// mutable-region CopyUpdate still owns its overflow key/value bytes (and

0 commit comments

Comments
 (0)