using Ryujinx.Memory.Range;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
namespace Ryujinx.Memory
{
///
/// Represents a address space manager.
/// Supports virtual memory region mapping, address translation and read/write access to mapped regions.
///
public sealed class AddressSpaceManager : IVirtualMemoryManager, IWritableBlock
{
public const int PageBits = PageTable.PageBits;
public const int PageSize = PageTable.PageSize;
public const int PageMask = PageTable.PageMask;
///
/// Address space width in bits.
///
public int AddressSpaceBits { get; }
private readonly ulong _addressSpaceSize;
private readonly PageTable _pageTable;
///
/// Creates a new instance of the memory manager.
///
/// Physical backing memory where virtual memory will be mapped to
/// Size of the address space
public AddressSpaceManager(ulong addressSpaceSize)
{
ulong asSize = PageSize;
int asBits = PageBits;
while (asSize < addressSpaceSize)
{
asSize <<= 1;
asBits++;
}
AddressSpaceBits = asBits;
_addressSpaceSize = asSize;
_pageTable = new PageTable();
}
///
/// Maps a virtual memory range into a physical memory range.
///
///
/// Addresses and size must be page aligned.
///
/// Virtual memory address
/// Physical memory address
/// Size to be mapped
public void Map(ulong va, nuint hostAddress, ulong size)
{
AssertValidAddressAndSize(va, size);
while (size != 0)
{
_pageTable.Map(va, hostAddress);
va += PageSize;
hostAddress += PageSize;
size -= PageSize;
}
}
///
/// Unmaps a previously mapped range of virtual memory.
///
/// Virtual address of the range to be unmapped
/// Size of the range to be unmapped
public void Unmap(ulong va, ulong size)
{
AssertValidAddressAndSize(va, size);
while (size != 0)
{
_pageTable.Unmap(va);
va += PageSize;
size -= PageSize;
}
}
///
/// Reads data from mapped memory.
///
/// Type of the data being read
/// Virtual address of the data in memory
/// The data
/// Throw for unhandled invalid or unmapped memory accesses
public T Read(ulong va) where T : unmanaged
{
return MemoryMarshal.Cast(GetSpan(va, Unsafe.SizeOf()))[0];
}
///
/// Reads data from mapped memory.
///
/// Virtual address of the data in memory
/// Span to store the data being read into
/// Throw for unhandled invalid or unmapped memory accesses
public void Read(ulong va, Span data)
{
ReadImpl(va, data);
}
///
/// Writes data to mapped memory.
///
/// Type of the data being written
/// Virtual address to write the data into
/// Data to be written
/// Throw for unhandled invalid or unmapped memory accesses
public void Write(ulong va, T value) where T : unmanaged
{
Write(va, MemoryMarshal.Cast(MemoryMarshal.CreateSpan(ref value, 1)));
}
///
/// Writes data to mapped memory.
///
/// Virtual address to write the data into
/// Data to be written
/// Throw for unhandled invalid or unmapped memory accesses
public void Write(ulong va, ReadOnlySpan data)
{
if (data.Length == 0)
{
return;
}
AssertValidAddressAndSize(va, (ulong)data.Length);
if (IsContiguousAndMapped(va, data.Length))
{
data.CopyTo(GetHostSpanContiguous(va, data.Length));
}
else
{
int offset = 0, size;
if ((va & PageMask) != 0)
{
size = Math.Min(data.Length, PageSize - (int)(va & PageMask));
data.Slice(0, size).CopyTo(GetHostSpanContiguous(va, size));
offset += size;
}
for (; offset < data.Length; offset += size)
{
size = Math.Min(data.Length - offset, PageSize);
data.Slice(offset, size).CopyTo(GetHostSpanContiguous(va + (ulong)offset, size));
}
}
}
///
/// Gets a read-only span of data from mapped memory.
///
///
/// This may perform a allocation if the data is not contiguous in memory.
/// For this reason, the span is read-only, you can't modify the data.
///
/// Virtual address of the data
/// Size of the data
/// True if read tracking is triggered on the span
/// A read-only span of the data
/// Throw for unhandled invalid or unmapped memory accesses
public ReadOnlySpan GetSpan(ulong va, int size, bool tracked = false)
{
if (size == 0)
{
return ReadOnlySpan.Empty;
}
if (IsContiguousAndMapped(va, size))
{
return GetHostSpanContiguous(va, size);
}
else
{
Span data = new byte[size];
ReadImpl(va, data);
return data;
}
}
///
/// Gets a region of memory that can be written to.
///
///
/// If the requested region is not contiguous in physical memory,
/// this will perform an allocation, and flush the data (writing it
/// back to the backing memory) on disposal.
///
/// Virtual address of the data
/// Size of the data
/// True if write tracking is triggered on the span
/// A writable region of memory containing the data
/// Throw for unhandled invalid or unmapped memory accesses
public unsafe WritableRegion GetWritableRegion(ulong va, int size, bool tracked = false)
{
if (size == 0)
{
return new WritableRegion(null, va, Memory.Empty);
}
if (IsContiguousAndMapped(va, size))
{
return new WritableRegion(null, va, new NativeMemoryManager((byte*)GetHostAddress(va), size).Memory);
}
else
{
Memory memory = new byte[size];
GetSpan(va, size).CopyTo(memory.Span);
return new WritableRegion(this, va, memory);
}
}
///
/// Gets a reference for the given type at the specified virtual memory address.
///
///
/// The data must be located at a contiguous memory region.
///
/// Type of the data to get the reference
/// Virtual address of the data
/// A reference to the data in memory
/// Throw if the specified memory region is not contiguous in physical memory
public unsafe ref T GetRef(ulong va) where T : unmanaged
{
if (!IsContiguous(va, Unsafe.SizeOf()))
{
ThrowMemoryNotContiguous();
}
return ref *(T*)GetHostAddress(va);
}
///
/// Computes the number of pages in a virtual address range.
///
/// Virtual address of the range
/// Size of the range
/// The virtual address of the beginning of the first page
/// This function does not differentiate between allocated and unallocated pages.
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private int GetPagesCount(ulong va, uint size, out ulong startVa)
{
// WARNING: Always check if ulong does not overflow during the operations.
startVa = va & ~(ulong)PageMask;
ulong vaSpan = (va - startVa + size + PageMask) & ~(ulong)PageMask;
return (int)(vaSpan / PageSize);
}
private void ThrowMemoryNotContiguous() => throw new MemoryNotContiguousException();
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private bool IsContiguousAndMapped(ulong va, int size) => IsContiguous(va, size) && IsMapped(va);
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private bool IsContiguous(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 (GetHostAddress(va) + PageSize != GetHostAddress(va + PageSize))
{
return false;
}
va += PageSize;
}
return true;
}
///
/// Gets the physical regions that make up the given virtual address region.
/// If any part of the virtual region is unmapped, null is returned.
///
/// Virtual address of the range
/// Size of the range
/// Array of physical regions
public IEnumerable GetPhysicalRegions(ulong va, ulong size)
{
if (size == 0)
{
return Enumerable.Empty();
}
if (!ValidateAddress(va) || !ValidateAddressAndSize(va, size))
{
return null;
}
int pages = GetPagesCount(va, (uint)size, out va);
var regions = new List();
nuint regionStart = GetHostAddress(va);
ulong regionSize = PageSize;
for (int page = 0; page < pages - 1; page++)
{
if (!ValidateAddress(va + PageSize))
{
return null;
}
nuint newHostAddress = GetHostAddress(va + PageSize);
if (GetHostAddress(va) + PageSize != newHostAddress)
{
regions.Add(new HostMemoryRange(regionStart, regionSize));
regionStart = newHostAddress;
regionSize = 0;
}
va += PageSize;
regionSize += PageSize;
}
regions.Add(new HostMemoryRange(regionStart, regionSize));
return regions;
}
private void ReadImpl(ulong va, Span data)
{
if (data.Length == 0)
{
return;
}
AssertValidAddressAndSize(va, (ulong)data.Length);
int offset = 0, size;
if ((va & PageMask) != 0)
{
size = Math.Min(data.Length, PageSize - (int)(va & PageMask));
GetHostSpanContiguous(va, size).CopyTo(data.Slice(0, size));
offset += size;
}
for (; offset < data.Length; offset += size)
{
size = Math.Min(data.Length - offset, PageSize);
GetHostSpanContiguous(va + (ulong)offset, size).CopyTo(data.Slice(offset, size));
}
}
///
/// Checks if the page at a given virtual address is mapped.
///
/// Virtual address to check
/// True if the address is mapped, false otherwise
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public bool IsMapped(ulong va)
{
if (!ValidateAddress(va))
{
return false;
}
return _pageTable.Read(va) != 0;
}
///
/// Checks if a memory range is mapped.
///
/// Virtual address of the range
/// Size of the range in bytes
/// True if the entire range is mapped, false otherwise
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;
}
private bool ValidateAddress(ulong va)
{
return va < _addressSpaceSize;
}
///
/// Checks if the combination of virtual address and size is part of the addressable space.
///
/// Virtual address of the range
/// Size of the range in bytes
/// True if the combination of virtual address and size is part of the addressable space
private bool ValidateAddressAndSize(ulong va, ulong size)
{
ulong endVa = va + size;
return endVa >= va && endVa >= size && endVa <= _addressSpaceSize;
}
///
/// Ensures the combination of virtual address and size is part of the addressable space.
///
/// Virtual address of the range
/// Size of the range in bytes
/// Throw when the memory region specified outside the addressable space
private void AssertValidAddressAndSize(ulong va, ulong size)
{
if (!ValidateAddressAndSize(va, size))
{
throw new InvalidMemoryRegionException($"va=0x{va:X16}, size=0x{size:X16}");
}
}
private unsafe Span GetHostSpanContiguous(ulong va, int size)
{
return new Span((void*)GetHostAddress(va), size);
}
private nuint GetHostAddress(ulong va)
{
return _pageTable.Read(va) + (nuint)(va & PageMask);
}
///
/// Reprotect a region of virtual memory for tracking. Sets software protection bits.
///
/// Virtual address base
/// Size of the region to protect
/// Memory protection to set
public void TrackingReprotect(ulong va, ulong size, MemoryPermission protection)
{
throw new NotImplementedException();
}
public void SignalMemoryTracking(ulong va, ulong size, bool write, bool precise = false)
{
// Only the ARM Memory Manager has tracking for now.
}
}
}