|
|
|
@ -5,8 +5,18 @@ |
|
|
|
#pragma once |
|
|
|
|
|
|
|
#include <cstddef> |
|
|
|
#include <memory> |
|
|
|
#include <string> |
|
|
|
#include "common/common_types.h" |
|
|
|
#include "common/memory_hook.h" |
|
|
|
|
|
|
|
namespace Common { |
|
|
|
struct PageTable; |
|
|
|
} |
|
|
|
|
|
|
|
namespace Core { |
|
|
|
class System; |
|
|
|
} |
|
|
|
|
|
|
|
namespace Kernel { |
|
|
|
class Process; |
|
|
|
@ -36,41 +46,369 @@ enum : VAddr { |
|
|
|
KERNEL_REGION_END = KERNEL_REGION_VADDR + KERNEL_REGION_SIZE, |
|
|
|
}; |
|
|
|
|
|
|
|
/// Changes the currently active page table to that of |
|
|
|
/// the given process instance. |
|
|
|
void SetCurrentPageTable(Kernel::Process& process); |
|
|
|
/// Central class that handles all memory operations and state. |
|
|
|
class Memory { |
|
|
|
public: |
|
|
|
explicit Memory(Core::System& system); |
|
|
|
~Memory(); |
|
|
|
|
|
|
|
/// Determines if the given VAddr is valid for the specified process. |
|
|
|
bool IsValidVirtualAddress(const Kernel::Process& process, VAddr vaddr); |
|
|
|
bool IsValidVirtualAddress(VAddr vaddr); |
|
|
|
/// Determines if the given VAddr is a kernel address |
|
|
|
bool IsKernelVirtualAddress(VAddr vaddr); |
|
|
|
Memory(const Memory&) = delete; |
|
|
|
Memory& operator=(const Memory&) = delete; |
|
|
|
|
|
|
|
u8 Read8(VAddr addr); |
|
|
|
u16 Read16(VAddr addr); |
|
|
|
u32 Read32(VAddr addr); |
|
|
|
u64 Read64(VAddr addr); |
|
|
|
Memory(Memory&&) = default; |
|
|
|
Memory& operator=(Memory&&) = default; |
|
|
|
|
|
|
|
void Write8(VAddr addr, u8 data); |
|
|
|
void Write16(VAddr addr, u16 data); |
|
|
|
void Write32(VAddr addr, u32 data); |
|
|
|
void Write64(VAddr addr, u64 data); |
|
|
|
/** |
|
|
|
* Changes the currently active page table to that of the given process instance. |
|
|
|
* |
|
|
|
* @param process The process to use the page table of. |
|
|
|
*/ |
|
|
|
void SetCurrentPageTable(Kernel::Process& process); |
|
|
|
|
|
|
|
void ReadBlock(const Kernel::Process& process, VAddr src_addr, void* dest_buffer, std::size_t size); |
|
|
|
void ReadBlock(VAddr src_addr, void* dest_buffer, std::size_t size); |
|
|
|
void WriteBlock(const Kernel::Process& process, VAddr dest_addr, const void* src_buffer, |
|
|
|
std::size_t size); |
|
|
|
void WriteBlock(VAddr dest_addr, const void* src_buffer, std::size_t size); |
|
|
|
void ZeroBlock(const Kernel::Process& process, VAddr dest_addr, std::size_t size); |
|
|
|
void CopyBlock(VAddr dest_addr, VAddr src_addr, std::size_t size); |
|
|
|
/** |
|
|
|
* Maps an allocated buffer onto a region of the emulated process address space. |
|
|
|
* |
|
|
|
* @param page_table The page table of the emulated process. |
|
|
|
* @param base The address to start mapping at. Must be page-aligned. |
|
|
|
* @param size The amount of bytes to map. Must be page-aligned. |
|
|
|
* @param target Buffer with the memory backing the mapping. Must be of length at least |
|
|
|
* `size`. |
|
|
|
*/ |
|
|
|
void MapMemoryRegion(Common::PageTable& page_table, VAddr base, u64 size, u8* target); |
|
|
|
|
|
|
|
u8* GetPointer(VAddr vaddr); |
|
|
|
/** |
|
|
|
* Maps a region of the emulated process address space as a IO region. |
|
|
|
* |
|
|
|
* @param page_table The page table of the emulated process. |
|
|
|
* @param base The address to start mapping at. Must be page-aligned. |
|
|
|
* @param size The amount of bytes to map. Must be page-aligned. |
|
|
|
* @param mmio_handler The handler that backs the mapping. |
|
|
|
*/ |
|
|
|
void MapIoRegion(Common::PageTable& page_table, VAddr base, u64 size, |
|
|
|
Common::MemoryHookPointer mmio_handler); |
|
|
|
|
|
|
|
std::string ReadCString(VAddr vaddr, std::size_t max_length); |
|
|
|
/** |
|
|
|
* Unmaps a region of the emulated process address space. |
|
|
|
* |
|
|
|
* @param page_table The page table of the emulated process. |
|
|
|
* @param base The address to begin unmapping at. |
|
|
|
* @param size The amount of bytes to unmap. |
|
|
|
*/ |
|
|
|
void UnmapRegion(Common::PageTable& page_table, VAddr base, u64 size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Mark each page touching the region as cached. |
|
|
|
*/ |
|
|
|
void RasterizerMarkRegionCached(VAddr vaddr, u64 size, bool cached); |
|
|
|
/** |
|
|
|
* Adds a memory hook to intercept reads and writes to given region of memory. |
|
|
|
* |
|
|
|
* @param page_table The page table of the emulated process |
|
|
|
* @param base The starting address to apply the hook to. |
|
|
|
* @param size The size of the memory region to apply the hook to, in bytes. |
|
|
|
* @param hook The hook to apply to the region of memory. |
|
|
|
*/ |
|
|
|
void AddDebugHook(Common::PageTable& page_table, VAddr base, u64 size, |
|
|
|
Common::MemoryHookPointer hook); |
|
|
|
|
|
|
|
/** |
|
|
|
* Removes a memory hook from a given range of memory. |
|
|
|
* |
|
|
|
* @param page_table The page table of the emulated process. |
|
|
|
* @param base The starting address to remove the hook from. |
|
|
|
* @param size The size of the memory region to remove the hook from, in bytes. |
|
|
|
* @param hook The hook to remove from the specified region of memory. |
|
|
|
*/ |
|
|
|
void RemoveDebugHook(Common::PageTable& page_table, VAddr base, u64 size, |
|
|
|
Common::MemoryHookPointer hook); |
|
|
|
|
|
|
|
/** |
|
|
|
* Checks whether or not the supplied address is a valid virtual |
|
|
|
* address for the given process. |
|
|
|
* |
|
|
|
* @param process The emulated process to check the address against. |
|
|
|
* @param vaddr The virtual address to check the validity of. |
|
|
|
* |
|
|
|
* @returns True if the given virtual address is valid, false otherwise. |
|
|
|
*/ |
|
|
|
bool IsValidVirtualAddress(const Kernel::Process& process, VAddr vaddr) const; |
|
|
|
|
|
|
|
/** |
|
|
|
* Checks whether or not the supplied address is a valid virtual |
|
|
|
* address for the current process. |
|
|
|
* |
|
|
|
* @param vaddr The virtual address to check the validity of. |
|
|
|
* |
|
|
|
* @returns True if the given virtual address is valid, false otherwise. |
|
|
|
*/ |
|
|
|
bool IsValidVirtualAddress(VAddr vaddr) const; |
|
|
|
|
|
|
|
/** |
|
|
|
* Gets a pointer to the given address. |
|
|
|
* |
|
|
|
* @param vaddr Virtual address to retrieve a pointer to. |
|
|
|
* |
|
|
|
* @returns The pointer to the given address, if the address is valid. |
|
|
|
* If the address is not valid, nullptr will be returned. |
|
|
|
*/ |
|
|
|
u8* GetPointer(VAddr vaddr); |
|
|
|
|
|
|
|
/** |
|
|
|
* Gets a pointer to the given address. |
|
|
|
* |
|
|
|
* @param vaddr Virtual address to retrieve a pointer to. |
|
|
|
* |
|
|
|
* @returns The pointer to the given address, if the address is valid. |
|
|
|
* If the address is not valid, nullptr will be returned. |
|
|
|
*/ |
|
|
|
const u8* GetPointer(VAddr vaddr) const; |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads an 8-bit unsigned value from the current process' address space |
|
|
|
* at the given virtual address. |
|
|
|
* |
|
|
|
* @param addr The virtual address to read the 8-bit value from. |
|
|
|
* |
|
|
|
* @returns the read 8-bit unsigned value. |
|
|
|
*/ |
|
|
|
u8 Read8(VAddr addr); |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads a 16-bit unsigned value from the current process' address space |
|
|
|
* at the given virtual address. |
|
|
|
* |
|
|
|
* @param addr The virtual address to read the 16-bit value from. |
|
|
|
* |
|
|
|
* @returns the read 16-bit unsigned value. |
|
|
|
*/ |
|
|
|
u16 Read16(VAddr addr); |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads a 32-bit unsigned value from the current process' address space |
|
|
|
* at the given virtual address. |
|
|
|
* |
|
|
|
* @param addr The virtual address to read the 32-bit value from. |
|
|
|
* |
|
|
|
* @returns the read 32-bit unsigned value. |
|
|
|
*/ |
|
|
|
u32 Read32(VAddr addr); |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads a 64-bit unsigned value from the current process' address space |
|
|
|
* at the given virtual address. |
|
|
|
* |
|
|
|
* @param addr The virtual address to read the 64-bit value from. |
|
|
|
* |
|
|
|
* @returns the read 64-bit value. |
|
|
|
*/ |
|
|
|
u64 Read64(VAddr addr); |
|
|
|
|
|
|
|
/** |
|
|
|
* Writes an 8-bit unsigned integer to the given virtual address in |
|
|
|
* the current process' address space. |
|
|
|
* |
|
|
|
* @param addr The virtual address to write the 8-bit unsigned integer to. |
|
|
|
* @param data The 8-bit unsigned integer to write to the given virtual address. |
|
|
|
* |
|
|
|
* @post The memory at the given virtual address contains the specified data value. |
|
|
|
*/ |
|
|
|
void Write8(VAddr addr, u8 data); |
|
|
|
|
|
|
|
/** |
|
|
|
* Writes a 16-bit unsigned integer to the given virtual address in |
|
|
|
* the current process' address space. |
|
|
|
* |
|
|
|
* @param addr The virtual address to write the 16-bit unsigned integer to. |
|
|
|
* @param data The 16-bit unsigned integer to write to the given virtual address. |
|
|
|
* |
|
|
|
* @post The memory range [addr, sizeof(data)) contains the given data value. |
|
|
|
*/ |
|
|
|
void Write16(VAddr addr, u16 data); |
|
|
|
|
|
|
|
/** |
|
|
|
* Writes a 32-bit unsigned integer to the given virtual address in |
|
|
|
* the current process' address space. |
|
|
|
* |
|
|
|
* @param addr The virtual address to write the 32-bit unsigned integer to. |
|
|
|
* @param data The 32-bit unsigned integer to write to the given virtual address. |
|
|
|
* |
|
|
|
* @post The memory range [addr, sizeof(data)) contains the given data value. |
|
|
|
*/ |
|
|
|
void Write32(VAddr addr, u32 data); |
|
|
|
|
|
|
|
/** |
|
|
|
* Writes a 64-bit unsigned integer to the given virtual address in |
|
|
|
* the current process' address space. |
|
|
|
* |
|
|
|
* @param addr The virtual address to write the 64-bit unsigned integer to. |
|
|
|
* @param data The 64-bit unsigned integer to write to the given virtual address. |
|
|
|
* |
|
|
|
* @post The memory range [addr, sizeof(data)) contains the given data value. |
|
|
|
*/ |
|
|
|
void Write64(VAddr addr, u64 data); |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads a null-terminated string from the given virtual address. |
|
|
|
* This function will continually read characters until either: |
|
|
|
* |
|
|
|
* - A null character ('\0') is reached. |
|
|
|
* - max_length characters have been read. |
|
|
|
* |
|
|
|
* @note The final null-terminating character (if found) is not included |
|
|
|
* in the returned string. |
|
|
|
* |
|
|
|
* @param vaddr The address to begin reading the string from. |
|
|
|
* @param max_length The maximum length of the string to read in characters. |
|
|
|
* |
|
|
|
* @returns The read string. |
|
|
|
*/ |
|
|
|
std::string ReadCString(VAddr vaddr, std::size_t max_length); |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads a contiguous block of bytes from a specified process' address space. |
|
|
|
* |
|
|
|
* @param process The process to read the data from. |
|
|
|
* @param src_addr The virtual address to begin reading from. |
|
|
|
* @param dest_buffer The buffer to place the read bytes into. |
|
|
|
* @param size The amount of data to read, in bytes. |
|
|
|
* |
|
|
|
* @note If a size of 0 is specified, then this function reads nothing and |
|
|
|
* no attempts to access memory are made at all. |
|
|
|
* |
|
|
|
* @pre dest_buffer must be at least size bytes in length, otherwise a |
|
|
|
* buffer overrun will occur. |
|
|
|
* |
|
|
|
* @post The range [dest_buffer, size) contains the read bytes from the |
|
|
|
* process' address space. |
|
|
|
*/ |
|
|
|
void ReadBlock(const Kernel::Process& process, VAddr src_addr, void* dest_buffer, |
|
|
|
std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Reads a contiguous block of bytes from the current process' address space. |
|
|
|
* |
|
|
|
* @param src_addr The virtual address to begin reading from. |
|
|
|
* @param dest_buffer The buffer to place the read bytes into. |
|
|
|
* @param size The amount of data to read, in bytes. |
|
|
|
* |
|
|
|
* @note If a size of 0 is specified, then this function reads nothing and |
|
|
|
* no attempts to access memory are made at all. |
|
|
|
* |
|
|
|
* @pre dest_buffer must be at least size bytes in length, otherwise a |
|
|
|
* buffer overrun will occur. |
|
|
|
* |
|
|
|
* @post The range [dest_buffer, size) contains the read bytes from the |
|
|
|
* current process' address space. |
|
|
|
*/ |
|
|
|
void ReadBlock(VAddr src_addr, void* dest_buffer, std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Writes a range of bytes into a given process' address space at the specified |
|
|
|
* virtual address. |
|
|
|
* |
|
|
|
* @param process The process to write data into the address space of. |
|
|
|
* @param dest_addr The destination virtual address to begin writing the data at. |
|
|
|
* @param src_buffer The data to write into the process' address space. |
|
|
|
* @param size The size of the data to write, in bytes. |
|
|
|
* |
|
|
|
* @post The address range [dest_addr, size) in the process' address space |
|
|
|
* contains the data that was within src_buffer. |
|
|
|
* |
|
|
|
* @post If an attempt is made to write into an unmapped region of memory, the writes |
|
|
|
* will be ignored and an error will be logged. |
|
|
|
* |
|
|
|
* @post If a write is performed into a region of memory that is considered cached |
|
|
|
* rasterizer memory, will cause the currently active rasterizer to be notified |
|
|
|
* and will mark that region as invalidated to caches that the active |
|
|
|
* graphics backend may be maintaining over the course of execution. |
|
|
|
*/ |
|
|
|
void WriteBlock(const Kernel::Process& process, VAddr dest_addr, const void* src_buffer, |
|
|
|
std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Writes a range of bytes into the current process' address space at the specified |
|
|
|
* virtual address. |
|
|
|
* |
|
|
|
* @param dest_addr The destination virtual address to begin writing the data at. |
|
|
|
* @param src_buffer The data to write into the current process' address space. |
|
|
|
* @param size The size of the data to write, in bytes. |
|
|
|
* |
|
|
|
* @post The address range [dest_addr, size) in the current process' address space |
|
|
|
* contains the data that was within src_buffer. |
|
|
|
* |
|
|
|
* @post If an attempt is made to write into an unmapped region of memory, the writes |
|
|
|
* will be ignored and an error will be logged. |
|
|
|
* |
|
|
|
* @post If a write is performed into a region of memory that is considered cached |
|
|
|
* rasterizer memory, will cause the currently active rasterizer to be notified |
|
|
|
* and will mark that region as invalidated to caches that the active |
|
|
|
* graphics backend may be maintaining over the course of execution. |
|
|
|
*/ |
|
|
|
void WriteBlock(VAddr dest_addr, const void* src_buffer, std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Fills the specified address range within a process' address space with zeroes. |
|
|
|
* |
|
|
|
* @param process The process that will have a portion of its memory zeroed out. |
|
|
|
* @param dest_addr The starting virtual address of the range to zero out. |
|
|
|
* @param size The size of the address range to zero out, in bytes. |
|
|
|
* |
|
|
|
* @post The range [dest_addr, size) within the process' address space is |
|
|
|
* filled with zeroes. |
|
|
|
*/ |
|
|
|
void ZeroBlock(const Kernel::Process& process, VAddr dest_addr, std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Fills the specified address range within the current process' address space with zeroes. |
|
|
|
* |
|
|
|
* @param dest_addr The starting virtual address of the range to zero out. |
|
|
|
* @param size The size of the address range to zero out, in bytes. |
|
|
|
* |
|
|
|
* @post The range [dest_addr, size) within the current process' address space is |
|
|
|
* filled with zeroes. |
|
|
|
*/ |
|
|
|
void ZeroBlock(VAddr dest_addr, std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Copies data within a process' address space to another location within the |
|
|
|
* same address space. |
|
|
|
* |
|
|
|
* @param process The process that will have data copied within its address space. |
|
|
|
* @param dest_addr The destination virtual address to begin copying the data into. |
|
|
|
* @param src_addr The source virtual address to begin copying the data from. |
|
|
|
* @param size The size of the data to copy, in bytes. |
|
|
|
* |
|
|
|
* @post The range [dest_addr, size) within the process' address space contains the |
|
|
|
* same data within the range [src_addr, size). |
|
|
|
*/ |
|
|
|
void CopyBlock(const Kernel::Process& process, VAddr dest_addr, VAddr src_addr, |
|
|
|
std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Copies data within the current process' address space to another location within the |
|
|
|
* same address space. |
|
|
|
* |
|
|
|
* @param dest_addr The destination virtual address to begin copying the data into. |
|
|
|
* @param src_addr The source virtual address to begin copying the data from. |
|
|
|
* @param size The size of the data to copy, in bytes. |
|
|
|
* |
|
|
|
* @post The range [dest_addr, size) within the current process' address space |
|
|
|
* contains the same data within the range [src_addr, size). |
|
|
|
*/ |
|
|
|
void CopyBlock(VAddr dest_addr, VAddr src_addr, std::size_t size); |
|
|
|
|
|
|
|
/** |
|
|
|
* Marks each page within the specified address range as cached or uncached. |
|
|
|
* |
|
|
|
* @param vaddr The virtual address indicating the start of the address range. |
|
|
|
* @param size The size of the address range in bytes. |
|
|
|
* @param cached Whether or not any pages within the address range should be |
|
|
|
* marked as cached or uncached. |
|
|
|
*/ |
|
|
|
void RasterizerMarkRegionCached(VAddr vaddr, u64 size, bool cached); |
|
|
|
|
|
|
|
private: |
|
|
|
struct Impl; |
|
|
|
std::unique_ptr<Impl> impl; |
|
|
|
}; |
|
|
|
|
|
|
|
/// Determines if the given VAddr is a kernel address |
|
|
|
bool IsKernelVirtualAddress(VAddr vaddr); |
|
|
|
|
|
|
|
} // namespace Memory |