using ARMeilleure.Memory; 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 MemoryManagerHostMapped : VirtualMemoryManagerRefCountedBase, IMemoryManager, IVirtualMemoryManagerTracked { private readonly InvalidAccessHandler _invalidAccessHandler; private readonly bool _unsafeMode; private readonly AddressSpace _addressSpace; private readonly PageTable _pageTable; private readonly MemoryEhMeilleure _memoryEh; private readonly ManagedPageFlags _pages; /// public bool UsesPrivateAllocations => false; public int AddressSpaceBits { get; } public IntPtr PageTablePointer => _addressSpace.Base.Pointer; public MemoryManagerType Type => _unsafeMode ? MemoryManagerType.HostMappedUnsafe : MemoryManagerType.HostMapped; public MemoryTracking Tracking { get; } public event Action UnmapEvent; protected override ulong AddressSpaceSize { get; } /// /// Creates a new instance of the host mapped memory manager. /// /// Address space instance to use /// True if unmanaged access should not be masked (unsafe), false otherwise. /// Optional function to handle invalid memory accesses public MemoryManagerHostMapped(AddressSpace addressSpace, bool unsafeMode, InvalidAccessHandler invalidAccessHandler) { _addressSpace = addressSpace; _pageTable = new PageTable(); _invalidAccessHandler = invalidAccessHandler; _unsafeMode = unsafeMode; AddressSpaceSize = addressSpace.AddressSpaceSize; ulong asSize = PageSize; int asBits = PageBits; while (asSize < AddressSpaceSize) { asSize <<= 1; asBits++; } AddressSpaceBits = asBits; _pages = new ManagedPageFlags(AddressSpaceBits); Tracking = new MemoryTracking(this, (int)MemoryBlock.GetPageSize(), invalidAccessHandler); _memoryEh = new MemoryEhMeilleure(_addressSpace.Base, _addressSpace.Mirror, Tracking); } /// /// Ensures the combination of virtual address and size is part of the addressable space and fully mapped. /// /// Virtual address of the range /// Size of the range in bytes private void AssertMapped(ulong va, ulong size) { if (!ValidateAddressAndSize(va, size) || !_pages.IsRangeMapped(va, size)) { throw new InvalidMemoryRegionException($"Not mapped: va=0x{va:X16}, size=0x{size:X16}"); } } /// public void Map(ulong va, ulong pa, ulong size, MemoryMapFlags flags) { AssertValidAddressAndSize(va, size); _addressSpace.Map(va, pa, size, flags); _pages.AddMapping(va, size); PtMap(va, pa, size); Tracking.Map(va, size); } /// public void Unmap(ulong va, ulong size) { AssertValidAddressAndSize(va, size); UnmapEvent?.Invoke(va, size); Tracking.Unmap(va, size); _pages.RemoveMapping(va, size); PtUnmap(va, size); _addressSpace.Unmap(va, size); } private void PtMap(ulong va, ulong pa, ulong size) { while (size != 0) { _pageTable.Map(va, pa); va += PageSize; pa += PageSize; size -= PageSize; } } private void PtUnmap(ulong va, ulong size) { while (size != 0) { _pageTable.Unmap(va); va += PageSize; size -= PageSize; } } public override T Read(ulong va) { try { AssertMapped(va, (ulong)Unsafe.SizeOf()); return _addressSpace.Mirror.Read(va); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return default; } } 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) { try { AssertMapped(va, (ulong)data.Length); _addressSpace.Mirror.Read(va, data); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override void Write(ulong va, T value) { try { SignalMemoryTracking(va, (ulong)Unsafe.SizeOf(), write: true); _addressSpace.Mirror.Write(va, value); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override void Write(ulong va, ReadOnlySpan data) { try { SignalMemoryTracking(va, (ulong)data.Length, write: true); _addressSpace.Mirror.Write(va, data); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override void WriteUntracked(ulong va, ReadOnlySpan data) { try { AssertMapped(va, (ulong)data.Length); _addressSpace.Mirror.Write(va, data); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override bool WriteWithRedundancyCheck(ulong va, ReadOnlySpan data) { try { SignalMemoryTracking(va, (ulong)data.Length, false); Span target = _addressSpace.Mirror.GetSpan(va, data.Length); bool changed = !data.SequenceEqual(target); if (changed) { data.CopyTo(target); } return changed; } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return true; } } public override ReadOnlySequence GetReadOnlySequence(ulong va, int size, bool tracked = false) { if (tracked) { SignalMemoryTracking(va, (ulong)size, write: false); } else { AssertMapped(va, (ulong)size); } return new ReadOnlySequence(_addressSpace.Mirror.GetMemory(va, size)); } public override ReadOnlySpan GetSpan(ulong va, int size, bool tracked = false) { if (tracked) { SignalMemoryTracking(va, (ulong)size, write: false); } else { AssertMapped(va, (ulong)size); } return _addressSpace.Mirror.GetSpan(va, size); } public override WritableRegion GetWritableRegion(ulong va, int size, bool tracked = false) { if (tracked) { SignalMemoryTracking(va, (ulong)size, true); } else { AssertMapped(va, (ulong)size); } return _addressSpace.Mirror.GetWritableRegion(va, size); } public ref T GetRef(ulong va) where T : unmanaged { SignalMemoryTracking(va, (ulong)Unsafe.SizeOf(), true); return ref _addressSpace.Mirror.GetRef(va); } [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); } /// public IEnumerable GetHostRegions(ulong va, ulong size) { AssertValidAddressAndSize(va, size); return Enumerable.Repeat(new HostMemoryRange((nuint)(ulong)_addressSpace.Mirror.GetPointer(va, size), size), 1); } /// public IEnumerable GetPhysicalRegions(ulong va, ulong size) { int pages = GetPagesCount(va, (uint)size, out va); var regions = new List(); ulong regionStart = GetPhysicalAddressChecked(va); ulong regionSize = PageSize; for (int page = 0; page < pages - 1; page++) { if (!ValidateAddress(va + PageSize)) { return null; } ulong newPa = GetPhysicalAddressChecked(va + PageSize); if (GetPhysicalAddressChecked(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; } private ulong GetPhysicalAddressChecked(ulong va) { if (!IsMapped(va)) { ThrowInvalidMemoryRegionException($"Not mapped: va=0x{va:X16}"); } return GetPhysicalAddressInternal(va); } private ulong GetPhysicalAddressInternal(ulong va) { return _pageTable.Read(va) + (va & PageMask); } /// /// 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; } _pages.SignalMemoryTracking(Tracking, va, size, write, exemptId); } /// public void Reprotect(ulong va, ulong size, MemoryPermission protection) { // TODO } /// public void TrackingReprotect(ulong va, ulong size, MemoryPermission protection, bool guest) { if (guest) { _addressSpace.Base.Reprotect(va, size, protection, false); } else { _pages.TrackingReprotect(va, size, protection); } } /// 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); } /// /// Disposes of resources used by the memory manager. /// protected override void Destroy() { _addressSpace.Dispose(); _memoryEh.Dispose(); } protected override Memory GetPhysicalAddressMemory(nuint pa, int size) => _addressSpace.Mirror.GetMemory(pa, size); protected override Span GetPhysicalAddressSpan(nuint pa, int size) => _addressSpace.Mirror.GetSpan(pa, size); protected override nuint TranslateVirtualAddressChecked(ulong va) => (nuint)GetPhysicalAddressChecked(va); protected override nuint TranslateVirtualAddressUnchecked(ulong va) => (nuint)GetPhysicalAddressInternal(va); } }