using Ryujinx.Memory.Range; using System; using System.Buffers; using System.Linq; namespace Ryujinx.Graphics.Gpu.Memory { /// /// A range within a buffer that has been modified by the GPU. /// class BufferModifiedRange : INonOverlappingRange { /// /// Start address of the range in guest memory. /// public ulong Address { get; internal set; } /// /// Size of the range in bytes. /// public ulong Size { get; internal set; } /// /// End address of the range in guest memory. /// public ulong EndAddress => Address + Size; public BufferModifiedRange Next { get; set; } public BufferModifiedRange Previous { get; set; } /// /// The GPU sync number at the time of the last modification. /// public ulong SyncNumber { get; internal set; } /// /// The range list that originally owned this range. /// public BufferModifiedRangeList Parent { get; internal set; } /// /// Creates a new instance of a modified range. /// /// Start address of the range /// Size of the range in bytes /// The GPU sync number at the time of creation /// The range list that owns this range public BufferModifiedRange(ulong address, ulong size, ulong syncNumber, BufferModifiedRangeList parent) { Address = address; Size = size; SyncNumber = syncNumber; Parent = parent; } /// /// Checks if a given range overlaps with the modified range. /// /// Start address of the range /// End address of the range /// True if the range overlaps, false otherwise public bool OverlapsWith(ulong address, ulong endAddress) { return Address < endAddress && address < EndAddress; } public INonOverlappingRange Split(ulong splitAddress) { throw new NotImplementedException(); } } /// /// A structure used to track GPU modified ranges within a buffer. /// class BufferModifiedRangeList : NonOverlappingRangeList { private const int BackingInitialSize = 8; private readonly GpuContext _context; private readonly Buffer _parent; private readonly BufferFlushAction _flushAction; private BufferMigration _source; private BufferModifiedRangeList _migrationTarget; /// /// Whether the modified range list has any entries or not. /// public bool HasRanges { get { Lock.EnterReadLock(); bool result = Count > 0; Lock.ExitReadLock(); return result; } } /// /// Creates a new instance of a modified range list. /// /// GPU context that the buffer range list belongs to /// The parent buffer that owns this range list /// The flush action for the parent buffer public BufferModifiedRangeList(GpuContext context, Buffer parent, BufferFlushAction flushAction) : base(BackingInitialSize) { _context = context; _parent = parent; _flushAction = flushAction; } /// /// Given an input range, calls the given action with sub-ranges which exclude any of the modified regions. /// /// Start address of the query range /// Size of the query range in bytes /// Action to perform for each remaining sub-range of the input range public void ExcludeModifiedRegions(ulong address, ulong size, Action action) { // Slices a given region using the modified regions in the list. Calls the action for the new slices. Lock.EnterReadLock(); ReadOnlySpan overlaps = FindOverlapsAsSpan(address, size); for (int i = 0; i < overlaps.Length; i++) { BufferModifiedRange overlap = overlaps[i]; if (overlap.Address > address) { // The start of the remaining region is uncovered by this overlap. Call the action for it. action(address, overlap.Address - address); } // Remaining region is after this overlap. size -= overlap.EndAddress - address; address = overlap.EndAddress; } Lock.ExitReadLock(); if ((long)size > 0) { // If there is any region left after removing the overlaps, signal it. action(address, size); } } /// /// Signal that a region of the buffer has been modified, and add the new region to the range list. /// Any overlapping ranges will be (partially) removed. /// /// Start address of the modified region /// Size of the modified region in bytes public void SignalModified(ulong address, ulong size) { ulong endAddress = address + size; ulong syncNumber = _context.SyncNumber; // We may overlap with some existing modified regions. They must be cut into by the new entry. Lock.EnterWriteLock(); (BufferModifiedRange first, BufferModifiedRange last) = FindOverlapsAsNodes(address, size); if (first is null) { Add(new BufferModifiedRange(address, size, syncNumber, this)); Lock.ExitWriteLock(); return; } if (first == last) { if (first.Address == address && first.EndAddress == endAddress) { first.SyncNumber = syncNumber; first.Parent = this; Lock.ExitWriteLock(); return; } if (first.Address < address) { if (first.EndAddress > endAddress) { Add(new BufferModifiedRange(endAddress, first.EndAddress - endAddress, first.SyncNumber, first.Parent)); } first.Size = address - first.Address; } else { if (first.EndAddress > endAddress) { first.Size = first.EndAddress - endAddress; first.Address = endAddress; } else { first.Address = address; first.Size = size; first.SyncNumber = syncNumber; first.Parent = this; Lock.ExitWriteLock(); return; } } Add(new BufferModifiedRange(address, size, syncNumber, this)); Lock.ExitWriteLock(); return; } if (first.Address < address) { first.Size = address - first.Address; first = first.Next; } if (last.EndAddress > endAddress) { last.Size = last.EndAddress - endAddress; last.Address = endAddress; last = last.Previous; } if (first.Address < last.Address) { RemoveRange(first.Next, last); first.Address = address; first.Size = size; first.SyncNumber = syncNumber; first.Parent = this; } else if (first.Address == last.Address) { first.Address = address; first.Size = size; first.SyncNumber = syncNumber; first.Parent = this; } else { Add(new BufferModifiedRange(address, size, syncNumber, this)); } Lock.ExitWriteLock(); } /// /// Gets modified ranges within the specified region, and then fires the given action for each range individually. /// /// Start address to query /// Size to query /// Sync number required for a range to be signalled /// The action to call for each modified range public void GetRangesAtSync(ulong address, ulong size, ulong syncNumber, Action rangeAction) { Lock.EnterReadLock(); ReadOnlySpan overlaps = FindOverlapsAsSpan(address, size); for (int i = 0; i < overlaps.Length; i++) { BufferModifiedRange overlap = overlaps[i]; if (overlap.SyncNumber == syncNumber) { rangeAction(overlap.Address, overlap.Size); } } Lock.ExitReadLock(); } /// /// Gets modified ranges within the specified region, and then fires the given action for each range individually. /// /// Start address to query /// Size to query /// The action to call for each modified range public void GetRanges(ulong address, ulong size, Action rangeAction) { // We use the non-span method here because keeping the lock will cause a deadlock. Lock.EnterReadLock(); BufferModifiedRange[] overlaps = FindOverlapsAsArray(address, size, out int length); Lock.ExitReadLock(); if (length != 0) { for (int i = 0; i < length; i++) { BufferModifiedRange overlap = overlaps[i]; rangeAction(overlap.Address, overlap.Size); } ArrayPool.Shared.Return(overlaps); } } /// /// Queries if a range exists within the specified region. /// /// Start address to query /// Size to query /// True if a range exists in the specified region, false otherwise public bool HasRange(ulong address, ulong size) { Lock.EnterReadLock(); BufferModifiedRange first = FindOverlapFast(address, size); bool result = first is not null; Lock.ExitReadLock(); return result; } /// /// Performs the given range action, or one from a migration that overlaps and has not synced yet. /// /// The offset to pass to the action /// The size to pass to the action /// The sync number that has been reached /// The action to perform public void RangeActionWithMigration(ulong offset, ulong size, ulong syncNumber, BufferFlushAction rangeAction) { if (_source != null) { _source.RangeActionWithMigration(offset, size, syncNumber, rangeAction); } else { rangeAction(offset, size, syncNumber); } } /// /// Removes modified ranges ready by the sync number from the list, and flushes their buffer data within a given address range. /// /// Overlapping ranges to check /// Number of overlapping ranges /// The highest difference between an overlapping range's sync number and the current one /// The current sync number /// The start address of the flush range /// The end address of the flush range private void RemoveRangesAndFlush( BufferModifiedRange[] overlaps, int rangeCount, long highestDiff, ulong currentSync, ulong address, ulong endAddress) { if (_migrationTarget == null) { ulong waitSync = currentSync + (ulong)highestDiff; for (int i = 0; i < rangeCount; i++) { BufferModifiedRange overlap = overlaps[i]; long diff = (long)(overlap.SyncNumber - currentSync); if (diff <= highestDiff) { ulong clampAddress = Math.Max(address, overlap.Address); ulong clampEnd = Math.Min(endAddress, overlap.EndAddress); if (i == 0 || i == rangeCount - 1) { ClearPart(overlap, clampAddress, clampEnd); } else { Remove(overlap); } RangeActionWithMigration(clampAddress, clampEnd - clampAddress, waitSync, _flushAction); } } return; } // There is a migration target to call instead. This can't be changed after set so accessing it outside the lock is fine. _migrationTarget.RemoveRangesAndFlush(overlaps, rangeCount, highestDiff, currentSync, address, endAddress); } /// /// Gets modified ranges within the specified region, waits on ones from a previous sync number, /// and then fires the flush action for each range individually. /// /// /// This function assumes it is called from the background thread. /// Modifications from the current sync number are ignored because the guest should not expect them to be available yet. /// They will remain reserved, so that any data sync prioritizes the data in the GPU. /// /// Start address to query /// Size to query public void WaitForAndFlushRanges(ulong address, ulong size) { ulong endAddress = address + size; ulong currentSync = _context.SyncNumber; // Range list must be consistent for this operation if (_migrationTarget != null) { _migrationTarget!.WaitForAndFlushRanges(address, size); return; } Lock.EnterWriteLock(); // We use the non-span method here because the array is partially modified by the code, which would invalidate a span. BufferModifiedRange[] overlaps = FindOverlapsAsArray(address, size, out int rangeCount); if (rangeCount == 0) { Lock.ExitWriteLock(); return; } // First, determine which syncpoint to wait on. // This is the latest syncpoint that is not equal to the current sync. long highestDiff = long.MinValue; for (int i = 0; i < rangeCount; i++) { BufferModifiedRange overlap = overlaps![i]; long diff = (long)(overlap.SyncNumber - currentSync); if (diff < 0 && diff > highestDiff) { highestDiff = diff; } } if (highestDiff == long.MinValue) { Lock.ExitWriteLock(); return; } // Wait for the syncpoint. _context.Renderer.WaitSync(currentSync + (ulong)highestDiff); RemoveRangesAndFlush(overlaps, rangeCount, highestDiff, currentSync, address, endAddress); ArrayPool.Shared.Return(overlaps!); Lock.ExitWriteLock(); } /// /// Inherit ranges from another modified range list. /// /// /// Assumes that ranges will be inherited in address ascending order. /// /// The range list to inherit from /// The action to call for each modified range public void InheritRanges(BufferModifiedRangeList ranges, Action registerRangeAction) { ranges.Lock.EnterReadLock(); int rangesCount = ranges.Count; BufferModifiedRange[] inheritRanges = ArrayPool.Shared.Rent(ranges.Count); ranges.Items.AsSpan(0, ranges.Count).CopyTo(inheritRanges); ranges.Lock.ExitReadLock(); // Copy over the migration from the previous range list BufferMigration oldMigration = ranges._source; BufferMigrationSpan span = new(ranges._parent, ranges._flushAction, oldMigration); ranges._parent.IncrementReferenceCount(); if (_source == null) { // Create a new migration. _source = new BufferMigration([span], this, _context.SyncNumber); _context.RegisterBufferMigration(_source); } else { // Extend the migration _source.AddSpanToEnd(span); } ranges._migrationTarget = this; Lock.EnterWriteLock(); for (int i = 0; i < rangesCount; i++) { BufferModifiedRange range = inheritRanges[i]; Add(range); } Lock.ExitWriteLock(); ulong currentSync = _context.SyncNumber; for (int i = 0; i < rangesCount; i++) { BufferModifiedRange range = inheritRanges[i]; if (range.SyncNumber != currentSync) { registerRangeAction(range.Address, range.Size); } } ArrayPool.Shared.Return(inheritRanges); } /// /// Register a migration from previous buffer storage. This migration is from a snapshot of the buffer's /// current handle to its handle in the future, and is assumed to be complete when the sync action completes. /// When the migration completes, the handle is disposed. /// public void SelfMigration() { BufferMigrationSpan span = new(_parent, _parent.GetSnapshotDisposeAction(), _parent.GetSnapshotFlushAction(), _source); BufferMigration migration = new([span], this, _context.SyncNumber); // Migration target is used to redirect flush actions to the latest range list, // so we don't need to set it here. (this range list is still the latest) _context.RegisterBufferMigration(migration); Lock.EnterWriteLock(); _source = migration; Lock.ExitWriteLock(); } /// /// Removes a source buffer migration, indicating its copy has completed. /// /// The migration to remove public void RemoveMigration(BufferMigration migration) { Lock.EnterWriteLock(); if (_source == migration) { _source = null; } Lock.ExitWriteLock(); } private void ClearPart(BufferModifiedRange overlap, ulong address, ulong endAddress) { // If the overlap extends outside of the clear range, make sure those parts still exist. if (overlap.Address < address) { if (overlap.EndAddress > endAddress) { Add(new BufferModifiedRange(endAddress, overlap.EndAddress - endAddress, overlap.SyncNumber, overlap.Parent)); } overlap.Size = address - overlap.Address; } else if (overlap.EndAddress > endAddress) { overlap.Size = overlap.EndAddress - endAddress; overlap.Address = endAddress; } else { Remove(overlap); } } /// /// Clear modified ranges within the specified area. /// /// Start address to clear /// Size to clear public void Clear(ulong address, ulong size) { ulong endAddress = address + size; Lock.EnterWriteLock(); (BufferModifiedRange first, BufferModifiedRange last) = FindOverlapsAsNodes(address, size); if (first is null) { Lock.ExitWriteLock(); return; } if (first == last) { if (first.Address < address) { first.Size = address - first.Address; if (first.EndAddress > endAddress) { Add(new BufferModifiedRange(endAddress, first.EndAddress - endAddress, first.SyncNumber, first.Parent)); } } else { if (first.EndAddress > endAddress) { first.Size = first.EndAddress - endAddress; first.Address = endAddress; } else { Remove(first); } } Lock.ExitWriteLock(); return; } BufferModifiedRange buffPre = null; BufferModifiedRange buffPost = null; bool extendsPost = false; bool extendsPre = false; if (first.Address < address) { buffPre = new BufferModifiedRange(first.Address, address - first.Address, first.SyncNumber, first.Parent); extendsPre = true; } if (last.EndAddress > endAddress) { buffPost = new BufferModifiedRange(endAddress, last.EndAddress - endAddress, last.SyncNumber, last.Parent); extendsPost = true; } RemoveRange(first, last); if (extendsPre) { Add(buffPre); } if (extendsPost) { Add(buffPost); } Lock.ExitWriteLock(); } } }