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.Versioning; namespace Ryujinx.Cpu.AppleHv { /// /// Represents a CPU memory manager which maps guest virtual memory directly onto the Hypervisor page table. /// [SupportedOSPlatform("macos")] public sealed class HvMemoryManager : VirtualMemoryManagerRefCountedBase, IMemoryManager, IVirtualMemoryManagerTracked { private readonly InvalidAccessHandler _invalidAccessHandler; private readonly HvAddressSpace _addressSpace; internal HvAddressSpace AddressSpace => _addressSpace; private readonly MemoryBlock _backingMemory; private readonly PageTable _pageTable; private readonly ManagedPageFlags _pages; public bool UsesPrivateAllocations => false; public int AddressSpaceBits { get; } public IntPtr PageTablePointer => IntPtr.Zero; public MemoryManagerType Type => MemoryManagerType.SoftwarePageTable; public MemoryTracking Tracking { get; } public event Action UnmapEvent; protected override ulong AddressSpaceSize { get; } /// /// Creates a new instance of the Hypervisor 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 HvMemoryManager(MemoryBlock backingMemory, ulong addressSpaceSize, InvalidAccessHandler invalidAccessHandler = null) { _backingMemory = backingMemory; _pageTable = new PageTable(); _invalidAccessHandler = invalidAccessHandler; AddressSpaceSize = addressSpaceSize; ulong asSize = PageSize; int asBits = PageBits; while (asSize < addressSpaceSize) { asSize <<= 1; asBits++; } _addressSpace = new HvAddressSpace(backingMemory, asSize); AddressSpaceBits = asBits; _pages = new ManagedPageFlags(AddressSpaceBits); Tracking = new MemoryTracking(this, PageSize, invalidAccessHandler); } /// public void Map(ulong va, ulong pa, ulong size, MemoryMapFlags flags) { AssertValidAddressAndSize(va, size); PtMap(va, pa, size); _addressSpace.MapUser(va, pa, size, MemoryPermission.ReadWriteExecute); _pages.AddMapping(va, size); Tracking.Map(va, size); } private void PtMap(ulong va, ulong pa, ulong size) { while (size != 0) { _pageTable.Map(va, pa); va += PageSize; pa += PageSize; size -= PageSize; } } /// public void Unmap(ulong va, ulong size) { AssertValidAddressAndSize(va, size); UnmapEvent?.Invoke(va, size); Tracking.Unmap(va, size); _pages.RemoveMapping(va, size); _addressSpace.UnmapUser(va, size); PtUnmap(va, size); } private void PtUnmap(ulong va, ulong size) { while (size != 0) { _pageTable.Unmap(va); va += PageSize; size -= PageSize; } } 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 { 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 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(GetPhysicalAddressChecked(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) { 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; } /// /// 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.ReprotectUser(va, size, protection); } 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 nuint GetPhysicalAddressChecked(ulong va) { if (!IsMapped(va)) { ThrowInvalidMemoryRegionException($"Not mapped: va=0x{va:X16}"); } return GetPhysicalAddressInternal(va); } private nuint GetPhysicalAddressInternal(ulong va) { return (nuint)(_pageTable.Read(va) + (va & PageMask)); } /// /// Disposes of resources used by the memory manager. /// protected override void Destroy() { _addressSpace.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) => GetPhysicalAddressChecked(va); protected override nuint TranslateVirtualAddressUnchecked(ulong va) => GetPhysicalAddressInternal(va); } }