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; using System.Runtime.InteropServices; using System.Threading; namespace Ryujinx.Cpu.Jit { /// /// Represents a CPU memory manager. /// public sealed class MemoryManager : VirtualMemoryManagerRefCountedBase, IMemoryManager, IVirtualMemoryManagerTracked { private const int PteSize = 8; private const int PointerTagBit = 62; private readonly MemoryBlock _backingMemory; private readonly InvalidAccessHandler _invalidAccessHandler; /// public bool UsesPrivateAllocations => false; /// /// Address space width in bits. /// public int AddressSpaceBits { get; } private readonly MemoryBlock _pageTable; private readonly ManagedPageFlags _pages; /// /// Page table base pointer. /// public IntPtr PageTablePointer => _pageTable.Pointer; public MemoryManagerType Type => MemoryManagerType.SoftwarePageTable; public MemoryTracking Tracking { get; } public event Action UnmapEvent; protected override ulong AddressSpaceSize { get; } /// /// Creates a new instance of the memory manager. /// /// Physical backing memory where virtual memory will be mapped to /// Size of the address space /// Optional function to handle invalid memory accesses public MemoryManager(MemoryBlock backingMemory, ulong addressSpaceSize, InvalidAccessHandler invalidAccessHandler = null) { _backingMemory = backingMemory; _invalidAccessHandler = invalidAccessHandler; ulong asSize = PageSize; int asBits = PageBits; while (asSize < addressSpaceSize) { asSize <<= 1; asBits++; } AddressSpaceBits = asBits; AddressSpaceSize = asSize; _pageTable = new MemoryBlock((asSize / PageSize) * PteSize); _pages = new ManagedPageFlags(AddressSpaceBits); Tracking = new MemoryTracking(this, PageSize); } /// public void Map(ulong va, ulong pa, ulong size, MemoryMapFlags flags) { AssertValidAddressAndSize(va, size); ulong remainingSize = size; ulong oVa = va; while (remainingSize != 0) { _pageTable.Write((va / PageSize) * PteSize, PaToPte(pa)); va += PageSize; pa += PageSize; remainingSize -= PageSize; } _pages.AddMapping(oVa, size); Tracking.Map(oVa, size); } /// public void Unmap(ulong va, ulong size) { // If size is 0, there's nothing to unmap, just exit early. if (size == 0) { return; } AssertValidAddressAndSize(va, size); UnmapEvent?.Invoke(va, size); Tracking.Unmap(va, size); _pages.RemoveMapping(va, size); ulong remainingSize = size; while (remainingSize != 0) { _pageTable.Write((va / PageSize) * PteSize, 0UL); va += PageSize; remainingSize -= PageSize; } } public override T ReadTracked(ulong va) { try { return base.ReadTracked(va); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return default; } } /// public T ReadGuest(ulong va) where T : unmanaged { try { SignalMemoryTrackingImpl(va, (ulong)Unsafe.SizeOf(), false, true); return Read(va); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return default; } } /// public override void Read(ulong va, Span data) { try { base.Read(va, data); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override void Write(ulong va, ReadOnlySpan data) { try { base.Write(va, data); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } /// public void WriteGuest(ulong va, T value) where T : unmanaged { Span data = MemoryMarshal.Cast(MemoryMarshal.CreateSpan(ref value, 1)); SignalMemoryTrackingImpl(va, (ulong)data.Length, true, true); Write(va, data); } public override void WriteUntracked(ulong va, ReadOnlySpan data) { try { base.WriteUntracked(va, data); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } } } public override ReadOnlySequence GetReadOnlySequence(ulong va, int size, bool tracked = false) { try { return base.GetReadOnlySequence(va, size, tracked); } catch (InvalidMemoryRegionException) { if (_invalidAccessHandler == null || !_invalidAccessHandler(va)) { throw; } return ReadOnlySequence.Empty; } } public ref T GetRef(ulong va) where T : unmanaged { if (!IsContiguous(va, Unsafe.SizeOf())) { ThrowMemoryNotContiguous(); } SignalMemoryTracking(va, (ulong)Unsafe.SizeOf(), true); return ref _backingMemory.GetRef(GetPhysicalAddressInternal(va)); } /// public IEnumerable GetHostRegions(ulong va, ulong size) { if (size == 0) { return Enumerable.Empty(); } var guestRegions = GetPhysicalRegionsImpl(va, size); if (guestRegions == null) { return null; } var regions = new HostMemoryRange[guestRegions.Count]; for (int i = 0; i < regions.Length; i++) { var guestRegion = guestRegions[i]; IntPtr pointer = _backingMemory.GetPointer(guestRegion.Address, guestRegion.Size); regions[i] = new HostMemoryRange((nuint)(ulong)pointer, guestRegion.Size); } 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; } /// public bool IsRangeMapped(ulong va, ulong size) { if (size == 0UL) { return true; } if (!ValidateAddressAndSize(va, size)) { return false; } int pages = GetPagesCount(va, (uint)size, out va); for (int page = 0; page < pages; page++) { if (!IsMapped(va)) { return false; } va += PageSize; } return true; } [MethodImpl(MethodImplOptions.AggressiveInlining)] public override bool IsMapped(ulong va) { if (!ValidateAddress(va)) { return false; } return _pageTable.Read((va / PageSize) * PteSize) != 0; } private nuint GetPhysicalAddressInternal(ulong va) { return (nuint)(PteToPa(_pageTable.Read((va / PageSize) * PteSize) & ~(0xffffUL << 48)) + (va & PageMask)); } /// public void Reprotect(ulong va, ulong size, MemoryPermission protection) { // TODO } /// public void TrackingReprotect(ulong va, ulong size, MemoryPermission protection, bool guest) { AssertValidAddressAndSize(va, size); if (guest) { // Protection is inverted on software pages, since the default value is 0. protection = (~protection) & MemoryPermission.ReadAndWrite; long tag = protection switch { MemoryPermission.None => 0L, MemoryPermission.Write => 2L << PointerTagBit, _ => 3L << PointerTagBit, }; int pages = GetPagesCount(va, (uint)size, out va); ulong pageStart = va >> PageBits; long invTagMask = ~(0xffffL << 48); for (int page = 0; page < pages; page++) { ref long pageRef = ref _pageTable.GetRef(pageStart * PteSize); long pte; do { pte = Volatile.Read(ref pageRef); } while (pte != 0 && Interlocked.CompareExchange(ref pageRef, (pte & invTagMask) | tag, pte) != pte); pageStart++; } } 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); } private void SignalMemoryTrackingImpl(ulong va, ulong size, bool write, bool guest, bool precise = false, int? exemptId = null) { AssertValidAddressAndSize(va, size); if (precise) { Tracking.VirtualMemoryEvent(va, size, write, precise: true, exemptId); return; } // If the memory tracking is coming from the guest, use the tag bits in the page table entry. // Otherwise, use the managed page flags. if (guest) { // We emulate guard pages for software memory access. This makes for an easy transition to // tracking using host guard pages in future, but also supporting platforms where this is not possible. // Write tag includes read protection, since we don't have any read actions that aren't performed before write too. long tag = (write ? 3L : 1L) << PointerTagBit; int pages = GetPagesCount(va, (uint)size, out _); ulong pageStart = va >> PageBits; for (int page = 0; page < pages; page++) { ref long pageRef = ref _pageTable.GetRef(pageStart * PteSize); long pte = Volatile.Read(ref pageRef); if ((pte & tag) != 0) { Tracking.VirtualMemoryEvent(va, size, write, precise: false, exemptId, true); break; } pageStart++; } } else { _pages.SignalMemoryTracking(Tracking, va, size, write, exemptId); } } /// public override void SignalMemoryTracking(ulong va, ulong size, bool write, bool precise = false, int? exemptId = null) { SignalMemoryTrackingImpl(va, size, write, false, precise, exemptId); } private ulong PaToPte(ulong pa) { return (ulong)_backingMemory.GetPointer(pa, PageSize); } private ulong PteToPa(ulong pte) { return (ulong)((long)pte - _backingMemory.Pointer.ToInt64()); } /// /// Disposes of resources used by the memory manager. /// protected override void Destroy() => _pageTable.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 nuint TranslateVirtualAddressChecked(ulong va) => GetPhysicalAddressInternal(va); protected override nuint TranslateVirtualAddressUnchecked(ulong va) => GetPhysicalAddressInternal(va); } }