using ARMeilleure.Memory; using Ryujinx.Common.Memory; using Ryujinx.Cpu.Jit.HostTracked; using Ryujinx.Cpu.Signal; using Ryujinx.Memory; using Ryujinx.Memory.Range; using Ryujinx.Memory.Tracking; using System; using System.Buffers; using System.Collections.Generic; using System.Linq; using System.Runtime.CompilerServices; namespace Ryujinx.Cpu.Jit { /// /// Represents a CPU memory manager which maps guest virtual memory directly onto a host virtual region. /// public sealed class MemoryManagerHostTracked : VirtualMemoryManagerRefCountedBase, IMemoryManager, IVirtualMemoryManagerTracked { private readonly InvalidAccessHandler _invalidAccessHandler; private readonly bool _unsafeMode; private readonly MemoryBlock _backingMemory; public int AddressSpaceBits { get; } public MemoryTracking Tracking { get; } private readonly NativePageTable _nativePageTable; private readonly AddressSpacePartitioned _addressSpace; private readonly ManagedPageFlags _pages; protected override ulong AddressSpaceSize { get; } /// public bool UsesPrivateAllocations => true; public IntPtr PageTablePointer => _nativePageTable.PageTablePointer; public MemoryManagerType Type => _unsafeMode ? MemoryManagerType.HostTrackedUnsafe : MemoryManagerType.HostTracked; public event Action UnmapEvent; /// /// Creates a new instance of the host tracked memory manager. /// /// Physical backing memory where virtual memory will be mapped to /// Size of the address space /// True if unmanaged access should not be masked (unsafe), false otherwise. /// Optional function to handle invalid memory accesses public MemoryManagerHostTracked(MemoryBlock backingMemory, ulong addressSpaceSize, bool unsafeMode, InvalidAccessHandler invalidAccessHandler) { bool useProtectionMirrors = MemoryBlock.GetPageSize() > PageSize; Tracking = new MemoryTracking(this, PageSize, invalidAccessHandler, useProtectionMirrors); _backingMemory = backingMemory; _invalidAccessHandler = invalidAccessHandler; _unsafeMode = unsafeMode; AddressSpaceSize = addressSpaceSize; ulong asSize = PageSize; int asBits = PageBits; while (asSize < AddressSpaceSize) { asSize <<= 1; asBits++; } AddressSpaceBits = asBits; if (useProtectionMirrors && !NativeSignalHandler.SupportsFaultAddressPatching()) { // Currently we require being able to change the fault address to something else // in order to "emulate" 4KB granularity protection on systems with larger page size. throw new PlatformNotSupportedException(); } _pages = new ManagedPageFlags(asBits); _nativePageTable = new(asSize); _addressSpace = new(Tracking, backingMemory, _nativePageTable, useProtectionMirrors); } public override ReadOnlySequence GetReadOnlySequence(ulong va, int size, bool tracked = false) { if (size == 0) { return ReadOnlySequence.Empty; } try { if (tracked) { SignalMemoryTracking(va, (ulong)size, false); } else { AssertValidAddressAndSize(va, (ulong)size); } ulong endVa = va + (ulong)size; int offset = 0; BytesReadOnlySequenceSegment first = null, last = null; while (va < endVa) { (MemoryBlock memory, ulong rangeOffset, ulong copySize) = GetMemoryOffsetAndSize(va, (ulong)(size - offset)); Memory physicalMemory = memory.GetMemory(rangeOffset, (int)copySize); if (first is null) { first = last = new BytesReadOnlySequenceSegment(physicalMemory); } else { if (last.IsContiguousWith(physicalMemory, out nuint contiguousStart, out int contiguousSize)) { Memory contiguousPhysicalMemory = new NativeMemoryManager(contiguousStart, contiguousSize).Memory; last.Replace(contiguousPhysicalMemory); } else { last = last.Append(physicalMemory); } } va += copySize; offset += (int)copySize; } return new ReadOnlySequence(first, 0, last, (int)(size - last.RunningIndex)); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return ReadOnlySequence.Empty; } } /// public void Map(ulong va, ulong pa, ulong size, MemoryMapFlags flags) { AssertValidAddressAndSize(va, size); if (flags.HasFlag(MemoryMapFlags.Private)) { _addressSpace.Map(va, pa, size); } _pages.AddMapping(va, size); _nativePageTable.Map(va, pa, size, _addressSpace, _backingMemory, flags.HasFlag(MemoryMapFlags.Private)); Tracking.Map(va, size); } /// public void Unmap(ulong va, ulong size) { AssertValidAddressAndSize(va, size); _addressSpace.Unmap(va, size); UnmapEvent?.Invoke(va, size); Tracking.Unmap(va, size); _pages.RemoveMapping(va, size); _nativePageTable.Unmap(va, size); } public override T ReadTracked(ulong va) { try { return base.ReadTracked(va); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return default; } } public override void Read(ulong va, Span data) { if (data.Length == 0) { return; } try { AssertValidAddressAndSize(va, (ulong)data.Length); ulong endVa = va + (ulong)data.Length; int offset = 0; while (va < endVa) { (MemoryBlock memory, ulong rangeOffset, ulong copySize) = GetMemoryOffsetAndSize(va, (ulong)(data.Length - offset)); memory.GetSpan(rangeOffset, (int)copySize).CopyTo(data.Slice(offset, (int)copySize)); va += copySize; offset += (int)copySize; } } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override bool WriteWithRedundancyCheck(ulong va, ReadOnlySpan data) { if (data.Length == 0) { return false; } SignalMemoryTracking(va, (ulong)data.Length, false); if (TryGetVirtualContiguous(va, data.Length, out MemoryBlock memoryBlock, out ulong offset)) { var target = memoryBlock.GetSpan(offset, data.Length); bool changed = !data.SequenceEqual(target); if (changed) { data.CopyTo(target); } return changed; } else { WriteImpl(va, data); return true; } } public override ReadOnlySpan GetSpan(ulong va, int size, bool tracked = false) { if (size == 0) { return ReadOnlySpan.Empty; } if (tracked) { SignalMemoryTracking(va, (ulong)size, false); } if (TryGetVirtualContiguous(va, size, out MemoryBlock memoryBlock, out ulong offset)) { return memoryBlock.GetSpan(offset, size); } else { Span data = new byte[size]; Read(va, data); return data; } } public override WritableRegion GetWritableRegion(ulong va, int size, bool tracked = false) { if (size == 0) { return new WritableRegion(null, va, Memory.Empty); } if (tracked) { SignalMemoryTracking(va, (ulong)size, true); } if (TryGetVirtualContiguous(va, size, out MemoryBlock memoryBlock, out ulong offset)) { return new WritableRegion(null, va, memoryBlock.GetMemory(offset, size)); } else { MemoryOwner memoryOwner = MemoryOwner.Rent(size); Read(va, memoryOwner.Span); return new WritableRegion(this, va, memoryOwner); } } public ref T GetRef(ulong va) where T : unmanaged { if (!TryGetVirtualContiguous(va, Unsafe.SizeOf(), out MemoryBlock memory, out ulong offset)) { ThrowMemoryNotContiguous(); } SignalMemoryTracking(va, (ulong)Unsafe.SizeOf(), true); return ref memory.GetRef(offset); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public override bool IsMapped(ulong va) { return ValidateAddress(va) && _pages.IsMapped(va); } public bool IsRangeMapped(ulong va, ulong size) { AssertValidAddressAndSize(va, size); return _pages.IsRangeMapped(va, size); } private bool TryGetVirtualContiguous(ulong va, int size, out MemoryBlock memory, out ulong offset) { if (_addressSpace.HasAnyPrivateAllocation(va, (ulong)size, out PrivateRange range)) { // If we have a private allocation overlapping the range, // then the access is only considered contiguous if it covers the entire range. if (range.Memory != null) { memory = range.Memory; offset = range.Offset; return true; } memory = null; offset = 0; return false; } memory = _backingMemory; offset = GetPhysicalAddressInternal(va); return IsPhysicalContiguous(va, size); } [MethodImpl(MethodImplOptions.AggressiveInlining)] private bool IsPhysicalContiguous(ulong va, int size) { if (!ValidateAddress(va) || !ValidateAddressAndSize(va, (ulong)size)) { return false; } int pages = GetPagesCount(va, (uint)size, out va); for (int page = 0; page < pages - 1; page++) { if (!ValidateAddress(va + PageSize)) { return false; } if (GetPhysicalAddressInternal(va) + PageSize != GetPhysicalAddressInternal(va + PageSize)) { return false; } va += PageSize; } return true; } [MethodImpl(MethodImplOptions.AggressiveInlining)] private ulong GetContiguousSize(ulong va, ulong size) { ulong contiguousSize = PageSize - (va & PageMask); if (!ValidateAddress(va) || !ValidateAddressAndSize(va, size)) { return contiguousSize; } int pages = GetPagesCount(va, size, out va); for (int page = 0; page < pages - 1; page++) { if (!ValidateAddress(va + PageSize)) { return contiguousSize; } if (GetPhysicalAddressInternal(va) + PageSize != GetPhysicalAddressInternal(va + PageSize)) { return contiguousSize; } va += PageSize; contiguousSize += PageSize; } return Math.Min(contiguousSize, size); } private (MemoryBlock, ulong, ulong) GetMemoryOffsetAndSize(ulong va, ulong size) { PrivateRange privateRange = _addressSpace.GetFirstPrivateAllocation(va, size, out ulong nextVa); if (privateRange.Memory != null) { return (privateRange.Memory, privateRange.Offset, privateRange.Size); } ulong physSize = GetContiguousSize(va, Math.Min(size, nextVa - va)); return (_backingMemory, GetPhysicalAddressChecked(va), physSize); } public IEnumerable GetHostRegions(ulong va, ulong size) { if (!ValidateAddressAndSize(va, size)) { return null; } var regions = new List(); ulong endVa = va + size; try { while (va < endVa) { (MemoryBlock memory, ulong rangeOffset, ulong rangeSize) = GetMemoryOffsetAndSize(va, endVa - va); regions.Add(new((UIntPtr)memory.GetPointer(rangeOffset, rangeSize), rangeSize)); va += rangeSize; } } catch (InvalidMemoryRegionException) { return null; } return regions; } public IEnumerable GetPhysicalRegions(ulong va, ulong size) { if (size == 0) { return Enumerable.Empty(); } return GetPhysicalRegionsImpl(va, size); } private List GetPhysicalRegionsImpl(ulong va, ulong size) { if (!ValidateAddress(va) || !ValidateAddressAndSize(va, size)) { return null; } int pages = GetPagesCount(va, (uint)size, out va); var regions = new List(); ulong regionStart = GetPhysicalAddressInternal(va); ulong regionSize = PageSize; for (int page = 0; page < pages - 1; page++) { if (!ValidateAddress(va + PageSize)) { return null; } ulong newPa = GetPhysicalAddressInternal(va + PageSize); if (GetPhysicalAddressInternal(va) + PageSize != newPa) { regions.Add(new MemoryRange(regionStart, regionSize)); regionStart = newPa; regionSize = 0; } va += PageSize; regionSize += PageSize; } regions.Add(new MemoryRange(regionStart, regionSize)); return regions; } /// /// /// This function also validates that the given range is both valid and mapped, and will throw if it is not. /// public override void SignalMemoryTracking(ulong va, ulong size, bool write, bool precise = false, int? exemptId = null) { AssertValidAddressAndSize(va, size); if (precise) { Tracking.VirtualMemoryEvent(va, size, write, precise: true, exemptId); return; } // Software table, used for managed memory tracking. _pages.SignalMemoryTracking(Tracking, va, size, write, exemptId); } public RegionHandle BeginTracking(ulong address, ulong size, int id, RegionFlags flags = RegionFlags.None) { return Tracking.BeginTracking(address, size, id, flags); } public MultiRegionHandle BeginGranularTracking(ulong address, ulong size, IEnumerable handles, ulong granularity, int id, RegionFlags flags = RegionFlags.None) { return Tracking.BeginGranularTracking(address, size, handles, granularity, id, flags); } public SmartMultiRegionHandle BeginSmartGranularTracking(ulong address, ulong size, ulong granularity, int id) { return Tracking.BeginSmartGranularTracking(address, size, granularity, id); } private ulong GetPhysicalAddressChecked(ulong va) { if (!IsMapped(va)) { ThrowInvalidMemoryRegionException($"Not mapped: va=0x{va:X16}"); } return GetPhysicalAddressInternal(va); } private ulong GetPhysicalAddressInternal(ulong va) { return _nativePageTable.GetPhysicalAddress(va); } /// public void Reprotect(ulong va, ulong size, MemoryPermission protection) { // TODO } /// public void TrackingReprotect(ulong va, ulong size, MemoryPermission protection, bool guest) { if (guest) { _addressSpace.Reprotect(va, size, protection); } else { _pages.TrackingReprotect(va, size, protection); } } /// /// Disposes of resources used by the memory manager. /// protected override void Destroy() { _addressSpace.Dispose(); _nativePageTable.Dispose(); } protected override Memory GetPhysicalAddressMemory(nuint pa, int size) => _backingMemory.GetMemory(pa, size); protected override Span GetPhysicalAddressSpan(nuint pa, int size) => _backingMemory.GetSpan(pa, size); protected override void WriteImpl(ulong va, ReadOnlySpan data) { try { AssertValidAddressAndSize(va, (ulong)data.Length); ulong endVa = va + (ulong)data.Length; int offset = 0; while (va < endVa) { (MemoryBlock memory, ulong rangeOffset, ulong copySize) = GetMemoryOffsetAndSize(va, (ulong)(data.Length - offset)); data.Slice(offset, (int)copySize).CopyTo(memory.GetSpan(rangeOffset, (int)copySize)); va += copySize; offset += (int)copySize; } } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } protected override nuint TranslateVirtualAddressChecked(ulong va) => (nuint)GetPhysicalAddressChecked(va); protected override nuint TranslateVirtualAddressUnchecked(ulong va) => (nuint)GetPhysicalAddressInternal(va); } }