memory.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797
  1. // SPDX-FileCopyrightText: 2015 Citra Emulator Project
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  3. #include <algorithm>
  4. #include <cstring>
  5. #include "common/assert.h"
  6. #include "common/atomic_ops.h"
  7. #include "common/common_types.h"
  8. #include "common/logging/log.h"
  9. #include "common/page_table.h"
  10. #include "common/settings.h"
  11. #include "common/swap.h"
  12. #include "core/core.h"
  13. #include "core/device_memory.h"
  14. #include "core/hle/kernel/k_page_table.h"
  15. #include "core/hle/kernel/k_process.h"
  16. #include "core/memory.h"
  17. #include "video_core/gpu.h"
  18. namespace Core::Memory {
  19. // Implementation class used to keep the specifics of the memory subsystem hidden
  20. // from outside classes. This also allows modification to the internals of the memory
  21. // subsystem without needing to rebuild all files that make use of the memory interface.
  22. struct Memory::Impl {
  23. explicit Impl(Core::System& system_) : system{system_} {}
  24. void SetCurrentPageTable(Kernel::KProcess& process, u32 core_id) {
  25. current_page_table = &process.PageTable().PageTableImpl();
  26. current_page_table->fastmem_arena = system.DeviceMemory().buffer.VirtualBasePointer();
  27. const std::size_t address_space_width = process.PageTable().GetAddressSpaceWidth();
  28. system.ArmInterface(core_id).PageTableChanged(*current_page_table, address_space_width);
  29. }
  30. void MapMemoryRegion(Common::PageTable& page_table, VAddr base, u64 size, PAddr target) {
  31. ASSERT_MSG((size & YUZU_PAGEMASK) == 0, "non-page aligned size: {:016X}", size);
  32. ASSERT_MSG((base & YUZU_PAGEMASK) == 0, "non-page aligned base: {:016X}", base);
  33. ASSERT_MSG(target >= DramMemoryMap::Base, "Out of bounds target: {:016X}", target);
  34. MapPages(page_table, base / YUZU_PAGESIZE, size / YUZU_PAGESIZE, target,
  35. Common::PageType::Memory);
  36. if (Settings::IsFastmemEnabled()) {
  37. system.DeviceMemory().buffer.Map(base, target - DramMemoryMap::Base, size);
  38. }
  39. }
  40. void UnmapRegion(Common::PageTable& page_table, VAddr base, u64 size) {
  41. ASSERT_MSG((size & YUZU_PAGEMASK) == 0, "non-page aligned size: {:016X}", size);
  42. ASSERT_MSG((base & YUZU_PAGEMASK) == 0, "non-page aligned base: {:016X}", base);
  43. MapPages(page_table, base / YUZU_PAGESIZE, size / YUZU_PAGESIZE, 0,
  44. Common::PageType::Unmapped);
  45. if (Settings::IsFastmemEnabled()) {
  46. system.DeviceMemory().buffer.Unmap(base, size);
  47. }
  48. }
  49. [[nodiscard]] u8* GetPointerFromRasterizerCachedMemory(VAddr vaddr) const {
  50. const PAddr paddr{current_page_table->backing_addr[vaddr >> YUZU_PAGEBITS]};
  51. if (!paddr) {
  52. return {};
  53. }
  54. return system.DeviceMemory().GetPointer<u8>(paddr) + vaddr;
  55. }
  56. [[nodiscard]] u8* GetPointerFromDebugMemory(VAddr vaddr) const {
  57. const PAddr paddr{current_page_table->backing_addr[vaddr >> YUZU_PAGEBITS]};
  58. if (paddr == 0) {
  59. return {};
  60. }
  61. return system.DeviceMemory().GetPointer<u8>(paddr) + vaddr;
  62. }
  63. u8 Read8(const VAddr addr) {
  64. return Read<u8>(addr);
  65. }
  66. u16 Read16(const VAddr addr) {
  67. if ((addr & 1) == 0) {
  68. return Read<u16_le>(addr);
  69. } else {
  70. const u32 a{Read<u8>(addr)};
  71. const u32 b{Read<u8>(addr + sizeof(u8))};
  72. return static_cast<u16>((b << 8) | a);
  73. }
  74. }
  75. u32 Read32(const VAddr addr) {
  76. if ((addr & 3) == 0) {
  77. return Read<u32_le>(addr);
  78. } else {
  79. const u32 a{Read16(addr)};
  80. const u32 b{Read16(addr + sizeof(u16))};
  81. return (b << 16) | a;
  82. }
  83. }
  84. u64 Read64(const VAddr addr) {
  85. if ((addr & 7) == 0) {
  86. return Read<u64_le>(addr);
  87. } else {
  88. const u32 a{Read32(addr)};
  89. const u32 b{Read32(addr + sizeof(u32))};
  90. return (static_cast<u64>(b) << 32) | a;
  91. }
  92. }
  93. void Write8(const VAddr addr, const u8 data) {
  94. Write<u8>(addr, data);
  95. }
  96. void Write16(const VAddr addr, const u16 data) {
  97. if ((addr & 1) == 0) {
  98. Write<u16_le>(addr, data);
  99. } else {
  100. Write<u8>(addr, static_cast<u8>(data));
  101. Write<u8>(addr + sizeof(u8), static_cast<u8>(data >> 8));
  102. }
  103. }
  104. void Write32(const VAddr addr, const u32 data) {
  105. if ((addr & 3) == 0) {
  106. Write<u32_le>(addr, data);
  107. } else {
  108. Write16(addr, static_cast<u16>(data));
  109. Write16(addr + sizeof(u16), static_cast<u16>(data >> 16));
  110. }
  111. }
  112. void Write64(const VAddr addr, const u64 data) {
  113. if ((addr & 7) == 0) {
  114. Write<u64_le>(addr, data);
  115. } else {
  116. Write32(addr, static_cast<u32>(data));
  117. Write32(addr + sizeof(u32), static_cast<u32>(data >> 32));
  118. }
  119. }
  120. bool WriteExclusive8(const VAddr addr, const u8 data, const u8 expected) {
  121. return WriteExclusive<u8>(addr, data, expected);
  122. }
  123. bool WriteExclusive16(const VAddr addr, const u16 data, const u16 expected) {
  124. return WriteExclusive<u16_le>(addr, data, expected);
  125. }
  126. bool WriteExclusive32(const VAddr addr, const u32 data, const u32 expected) {
  127. return WriteExclusive<u32_le>(addr, data, expected);
  128. }
  129. bool WriteExclusive64(const VAddr addr, const u64 data, const u64 expected) {
  130. return WriteExclusive<u64_le>(addr, data, expected);
  131. }
  132. std::string ReadCString(VAddr vaddr, std::size_t max_length) {
  133. std::string string;
  134. string.reserve(max_length);
  135. for (std::size_t i = 0; i < max_length; ++i) {
  136. const char c = Read<s8>(vaddr);
  137. if (c == '\0') {
  138. break;
  139. }
  140. string.push_back(c);
  141. ++vaddr;
  142. }
  143. string.shrink_to_fit();
  144. return string;
  145. }
  146. void WalkBlock(const Kernel::KProcess& process, const VAddr addr, const std::size_t size,
  147. auto on_unmapped, auto on_memory, auto on_rasterizer, auto increment) {
  148. const auto& page_table = process.PageTable().PageTableImpl();
  149. std::size_t remaining_size = size;
  150. std::size_t page_index = addr >> YUZU_PAGEBITS;
  151. std::size_t page_offset = addr & YUZU_PAGEMASK;
  152. while (remaining_size) {
  153. const std::size_t copy_amount =
  154. std::min(static_cast<std::size_t>(YUZU_PAGESIZE) - page_offset, remaining_size);
  155. const auto current_vaddr =
  156. static_cast<VAddr>((page_index << YUZU_PAGEBITS) + page_offset);
  157. const auto [pointer, type] = page_table.pointers[page_index].PointerType();
  158. switch (type) {
  159. case Common::PageType::Unmapped: {
  160. on_unmapped(copy_amount, current_vaddr);
  161. break;
  162. }
  163. case Common::PageType::Memory: {
  164. DEBUG_ASSERT(pointer);
  165. u8* mem_ptr = pointer + page_offset + (page_index << YUZU_PAGEBITS);
  166. on_memory(copy_amount, mem_ptr);
  167. break;
  168. }
  169. case Common::PageType::DebugMemory: {
  170. DEBUG_ASSERT(pointer);
  171. u8* const mem_ptr{GetPointerFromDebugMemory(current_vaddr)};
  172. on_memory(copy_amount, mem_ptr);
  173. break;
  174. }
  175. case Common::PageType::RasterizerCachedMemory: {
  176. u8* const host_ptr{GetPointerFromRasterizerCachedMemory(current_vaddr)};
  177. on_rasterizer(current_vaddr, copy_amount, host_ptr);
  178. break;
  179. }
  180. default:
  181. UNREACHABLE();
  182. }
  183. page_index++;
  184. page_offset = 0;
  185. increment(copy_amount);
  186. remaining_size -= copy_amount;
  187. }
  188. }
  189. template <bool UNSAFE>
  190. void ReadBlockImpl(const Kernel::KProcess& process, const VAddr src_addr, void* dest_buffer,
  191. const std::size_t size) {
  192. WalkBlock(
  193. process, src_addr, size,
  194. [src_addr, size, &dest_buffer](const std::size_t copy_amount,
  195. const VAddr current_vaddr) {
  196. LOG_ERROR(HW_Memory,
  197. "Unmapped ReadBlock @ 0x{:016X} (start address = 0x{:016X}, size = {})",
  198. current_vaddr, src_addr, size);
  199. std::memset(dest_buffer, 0, copy_amount);
  200. },
  201. [&](const std::size_t copy_amount, const u8* const src_ptr) {
  202. std::memcpy(dest_buffer, src_ptr, copy_amount);
  203. },
  204. [&](const VAddr current_vaddr, const std::size_t copy_amount,
  205. const u8* const host_ptr) {
  206. if constexpr (!UNSAFE) {
  207. system.GPU().FlushRegion(current_vaddr, copy_amount);
  208. }
  209. std::memcpy(dest_buffer, host_ptr, copy_amount);
  210. },
  211. [&](const std::size_t copy_amount) {
  212. dest_buffer = static_cast<u8*>(dest_buffer) + copy_amount;
  213. });
  214. }
  215. void ReadBlock(const VAddr src_addr, void* dest_buffer, const std::size_t size) {
  216. ReadBlockImpl<false>(*system.CurrentProcess(), src_addr, dest_buffer, size);
  217. }
  218. void ReadBlockUnsafe(const VAddr src_addr, void* dest_buffer, const std::size_t size) {
  219. ReadBlockImpl<true>(*system.CurrentProcess(), src_addr, dest_buffer, size);
  220. }
  221. template <bool UNSAFE>
  222. void WriteBlockImpl(const Kernel::KProcess& process, const VAddr dest_addr,
  223. const void* src_buffer, const std::size_t size) {
  224. WalkBlock(
  225. process, dest_addr, size,
  226. [dest_addr, size](const std::size_t copy_amount, const VAddr current_vaddr) {
  227. LOG_ERROR(HW_Memory,
  228. "Unmapped WriteBlock @ 0x{:016X} (start address = 0x{:016X}, size = {})",
  229. current_vaddr, dest_addr, size);
  230. },
  231. [&](const std::size_t copy_amount, u8* const dest_ptr) {
  232. std::memcpy(dest_ptr, src_buffer, copy_amount);
  233. },
  234. [&](const VAddr current_vaddr, const std::size_t copy_amount, u8* const host_ptr) {
  235. if constexpr (!UNSAFE) {
  236. system.GPU().InvalidateRegion(current_vaddr, copy_amount);
  237. }
  238. std::memcpy(host_ptr, src_buffer, copy_amount);
  239. },
  240. [&](const std::size_t copy_amount) {
  241. src_buffer = static_cast<const u8*>(src_buffer) + copy_amount;
  242. });
  243. }
  244. void WriteBlock(const VAddr dest_addr, const void* src_buffer, const std::size_t size) {
  245. WriteBlockImpl<false>(*system.CurrentProcess(), dest_addr, src_buffer, size);
  246. }
  247. void WriteBlockUnsafe(const VAddr dest_addr, const void* src_buffer, const std::size_t size) {
  248. WriteBlockImpl<true>(*system.CurrentProcess(), dest_addr, src_buffer, size);
  249. }
  250. void ZeroBlock(const Kernel::KProcess& process, const VAddr dest_addr, const std::size_t size) {
  251. WalkBlock(
  252. process, dest_addr, size,
  253. [dest_addr, size](const std::size_t copy_amount, const VAddr current_vaddr) {
  254. LOG_ERROR(HW_Memory,
  255. "Unmapped ZeroBlock @ 0x{:016X} (start address = 0x{:016X}, size = {})",
  256. current_vaddr, dest_addr, size);
  257. },
  258. [](const std::size_t copy_amount, u8* const dest_ptr) {
  259. std::memset(dest_ptr, 0, copy_amount);
  260. },
  261. [&](const VAddr current_vaddr, const std::size_t copy_amount, u8* const host_ptr) {
  262. system.GPU().InvalidateRegion(current_vaddr, copy_amount);
  263. std::memset(host_ptr, 0, copy_amount);
  264. },
  265. [](const std::size_t copy_amount) {});
  266. }
  267. void CopyBlock(const Kernel::KProcess& process, VAddr dest_addr, VAddr src_addr,
  268. const std::size_t size) {
  269. WalkBlock(
  270. process, dest_addr, size,
  271. [&](const std::size_t copy_amount, const VAddr current_vaddr) {
  272. LOG_ERROR(HW_Memory,
  273. "Unmapped CopyBlock @ 0x{:016X} (start address = 0x{:016X}, size = {})",
  274. current_vaddr, src_addr, size);
  275. ZeroBlock(process, dest_addr, copy_amount);
  276. },
  277. [&](const std::size_t copy_amount, const u8* const src_ptr) {
  278. WriteBlockImpl<false>(process, dest_addr, src_ptr, copy_amount);
  279. },
  280. [&](const VAddr current_vaddr, const std::size_t copy_amount, u8* const host_ptr) {
  281. system.GPU().FlushRegion(current_vaddr, copy_amount);
  282. WriteBlockImpl<false>(process, dest_addr, host_ptr, copy_amount);
  283. },
  284. [&](const std::size_t copy_amount) {
  285. dest_addr += static_cast<VAddr>(copy_amount);
  286. src_addr += static_cast<VAddr>(copy_amount);
  287. });
  288. }
  289. void MarkRegionDebug(VAddr vaddr, u64 size, bool debug) {
  290. if (vaddr == 0) {
  291. return;
  292. }
  293. // Iterate over a contiguous CPU address space, marking/unmarking the region.
  294. // The region is at a granularity of CPU pages.
  295. const u64 num_pages = ((vaddr + size - 1) >> YUZU_PAGEBITS) - (vaddr >> YUZU_PAGEBITS) + 1;
  296. for (u64 i = 0; i < num_pages; ++i, vaddr += YUZU_PAGESIZE) {
  297. const Common::PageType page_type{
  298. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Type()};
  299. if (debug) {
  300. // Switch page type to debug if now debug
  301. switch (page_type) {
  302. case Common::PageType::Unmapped:
  303. ASSERT_MSG(false, "Attempted to mark unmapped pages as debug");
  304. break;
  305. case Common::PageType::RasterizerCachedMemory:
  306. case Common::PageType::DebugMemory:
  307. // Page is already marked.
  308. break;
  309. case Common::PageType::Memory:
  310. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Store(
  311. nullptr, Common::PageType::DebugMemory);
  312. break;
  313. default:
  314. UNREACHABLE();
  315. }
  316. } else {
  317. // Switch page type to non-debug if now non-debug
  318. switch (page_type) {
  319. case Common::PageType::Unmapped:
  320. ASSERT_MSG(false, "Attempted to mark unmapped pages as non-debug");
  321. break;
  322. case Common::PageType::RasterizerCachedMemory:
  323. case Common::PageType::Memory:
  324. // Don't mess with already non-debug or rasterizer memory.
  325. break;
  326. case Common::PageType::DebugMemory: {
  327. u8* const pointer{GetPointerFromDebugMemory(vaddr & ~YUZU_PAGEMASK)};
  328. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Store(
  329. pointer - (vaddr & ~YUZU_PAGEMASK), Common::PageType::Memory);
  330. break;
  331. }
  332. default:
  333. UNREACHABLE();
  334. }
  335. }
  336. }
  337. }
  338. void RasterizerMarkRegionCached(VAddr vaddr, u64 size, bool cached) {
  339. if (vaddr == 0) {
  340. return;
  341. }
  342. if (Settings::IsFastmemEnabled()) {
  343. const bool is_read_enable = Settings::IsGPULevelHigh() || !cached;
  344. system.DeviceMemory().buffer.Protect(vaddr, size, is_read_enable, !cached);
  345. }
  346. // Iterate over a contiguous CPU address space, which corresponds to the specified GPU
  347. // address space, marking the region as un/cached. The region is marked un/cached at a
  348. // granularity of CPU pages, hence why we iterate on a CPU page basis (note: GPU page size
  349. // is different). This assumes the specified GPU address region is contiguous as well.
  350. const u64 num_pages = ((vaddr + size - 1) >> YUZU_PAGEBITS) - (vaddr >> YUZU_PAGEBITS) + 1;
  351. for (u64 i = 0; i < num_pages; ++i, vaddr += YUZU_PAGESIZE) {
  352. const Common::PageType page_type{
  353. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Type()};
  354. if (cached) {
  355. // Switch page type to cached if now cached
  356. switch (page_type) {
  357. case Common::PageType::Unmapped:
  358. // It is not necessary for a process to have this region mapped into its address
  359. // space, for example, a system module need not have a VRAM mapping.
  360. break;
  361. case Common::PageType::DebugMemory:
  362. case Common::PageType::Memory:
  363. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Store(
  364. nullptr, Common::PageType::RasterizerCachedMemory);
  365. break;
  366. case Common::PageType::RasterizerCachedMemory:
  367. // There can be more than one GPU region mapped per CPU region, so it's common
  368. // that this area is already marked as cached.
  369. break;
  370. default:
  371. UNREACHABLE();
  372. }
  373. } else {
  374. // Switch page type to uncached if now uncached
  375. switch (page_type) {
  376. case Common::PageType::Unmapped: // NOLINT(bugprone-branch-clone)
  377. // It is not necessary for a process to have this region mapped into its address
  378. // space, for example, a system module need not have a VRAM mapping.
  379. break;
  380. case Common::PageType::DebugMemory:
  381. case Common::PageType::Memory:
  382. // There can be more than one GPU region mapped per CPU region, so it's common
  383. // that this area is already unmarked as cached.
  384. break;
  385. case Common::PageType::RasterizerCachedMemory: {
  386. u8* const pointer{GetPointerFromRasterizerCachedMemory(vaddr & ~YUZU_PAGEMASK)};
  387. if (pointer == nullptr) {
  388. // It's possible that this function has been called while updating the
  389. // pagetable after unmapping a VMA. In that case the underlying VMA will no
  390. // longer exist, and we should just leave the pagetable entry blank.
  391. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Store(
  392. nullptr, Common::PageType::Unmapped);
  393. } else {
  394. current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Store(
  395. pointer - (vaddr & ~YUZU_PAGEMASK), Common::PageType::Memory);
  396. }
  397. break;
  398. }
  399. default:
  400. UNREACHABLE();
  401. }
  402. }
  403. }
  404. }
  405. /**
  406. * Maps a region of pages as a specific type.
  407. *
  408. * @param page_table The page table to use to perform the mapping.
  409. * @param base The base address to begin mapping at.
  410. * @param size The total size of the range in bytes.
  411. * @param target The target address to begin mapping from.
  412. * @param type The page type to map the memory as.
  413. */
  414. void MapPages(Common::PageTable& page_table, VAddr base, u64 size, PAddr target,
  415. Common::PageType type) {
  416. LOG_DEBUG(HW_Memory, "Mapping {:016X} onto {:016X}-{:016X}", target, base * YUZU_PAGESIZE,
  417. (base + size) * YUZU_PAGESIZE);
  418. // During boot, current_page_table might not be set yet, in which case we need not flush
  419. if (system.IsPoweredOn()) {
  420. auto& gpu = system.GPU();
  421. for (u64 i = 0; i < size; i++) {
  422. const auto page = base + i;
  423. if (page_table.pointers[page].Type() == Common::PageType::RasterizerCachedMemory) {
  424. gpu.FlushAndInvalidateRegion(page << YUZU_PAGEBITS, YUZU_PAGESIZE);
  425. }
  426. }
  427. }
  428. const VAddr end = base + size;
  429. ASSERT_MSG(end <= page_table.pointers.size(), "out of range mapping at {:016X}",
  430. base + page_table.pointers.size());
  431. if (!target) {
  432. ASSERT_MSG(type != Common::PageType::Memory,
  433. "Mapping memory page without a pointer @ {:016x}", base * YUZU_PAGESIZE);
  434. while (base != end) {
  435. page_table.pointers[base].Store(nullptr, type);
  436. page_table.backing_addr[base] = 0;
  437. base += 1;
  438. }
  439. } else {
  440. while (base != end) {
  441. page_table.pointers[base].Store(
  442. system.DeviceMemory().GetPointer<u8>(target) - (base << YUZU_PAGEBITS), type);
  443. page_table.backing_addr[base] = target - (base << YUZU_PAGEBITS);
  444. ASSERT_MSG(page_table.pointers[base].Pointer(),
  445. "memory mapping base yield a nullptr within the table");
  446. base += 1;
  447. target += YUZU_PAGESIZE;
  448. }
  449. }
  450. }
  451. [[nodiscard]] u8* GetPointerImpl(VAddr vaddr, auto on_unmapped, auto on_rasterizer) const {
  452. // AARCH64 masks the upper 16 bit of all memory accesses
  453. vaddr &= 0xffffffffffffULL;
  454. if (vaddr >= 1uLL << current_page_table->GetAddressSpaceBits()) {
  455. on_unmapped();
  456. return nullptr;
  457. }
  458. // Avoid adding any extra logic to this fast-path block
  459. const uintptr_t raw_pointer = current_page_table->pointers[vaddr >> YUZU_PAGEBITS].Raw();
  460. if (u8* const pointer = Common::PageTable::PageInfo::ExtractPointer(raw_pointer)) {
  461. return &pointer[vaddr];
  462. }
  463. switch (Common::PageTable::PageInfo::ExtractType(raw_pointer)) {
  464. case Common::PageType::Unmapped:
  465. on_unmapped();
  466. return nullptr;
  467. case Common::PageType::Memory:
  468. ASSERT_MSG(false, "Mapped memory page without a pointer @ 0x{:016X}", vaddr);
  469. return nullptr;
  470. case Common::PageType::DebugMemory:
  471. return GetPointerFromDebugMemory(vaddr);
  472. case Common::PageType::RasterizerCachedMemory: {
  473. u8* const host_ptr{GetPointerFromRasterizerCachedMemory(vaddr)};
  474. on_rasterizer();
  475. return host_ptr;
  476. }
  477. default:
  478. UNREACHABLE();
  479. }
  480. return nullptr;
  481. }
  482. [[nodiscard]] u8* GetPointer(const VAddr vaddr) const {
  483. return GetPointerImpl(
  484. vaddr, [vaddr]() { LOG_ERROR(HW_Memory, "Unmapped GetPointer @ 0x{:016X}", vaddr); },
  485. []() {});
  486. }
  487. [[nodiscard]] u8* GetPointerSilent(const VAddr vaddr) const {
  488. return GetPointerImpl(
  489. vaddr, []() {}, []() {});
  490. }
  491. /**
  492. * Reads a particular data type out of memory at the given virtual address.
  493. *
  494. * @param vaddr The virtual address to read the data type from.
  495. *
  496. * @tparam T The data type to read out of memory. This type *must* be
  497. * trivially copyable, otherwise the behavior of this function
  498. * is undefined.
  499. *
  500. * @returns The instance of T read from the specified virtual address.
  501. */
  502. template <typename T>
  503. T Read(VAddr vaddr) {
  504. T result = 0;
  505. const u8* const ptr = GetPointerImpl(
  506. vaddr,
  507. [vaddr]() {
  508. LOG_ERROR(HW_Memory, "Unmapped Read{} @ 0x{:016X}", sizeof(T) * 8, vaddr);
  509. },
  510. [&]() { system.GPU().FlushRegion(vaddr, sizeof(T)); });
  511. if (ptr) {
  512. std::memcpy(&result, ptr, sizeof(T));
  513. }
  514. return result;
  515. }
  516. /**
  517. * Writes a particular data type to memory at the given virtual address.
  518. *
  519. * @param vaddr The virtual address to write the data type to.
  520. *
  521. * @tparam T The data type to write to memory. This type *must* be
  522. * trivially copyable, otherwise the behavior of this function
  523. * is undefined.
  524. */
  525. template <typename T>
  526. void Write(VAddr vaddr, const T data) {
  527. u8* const ptr = GetPointerImpl(
  528. vaddr,
  529. [vaddr, data]() {
  530. LOG_ERROR(HW_Memory, "Unmapped Write{} @ 0x{:016X} = 0x{:016X}", sizeof(T) * 8,
  531. vaddr, static_cast<u64>(data));
  532. },
  533. [&]() { system.GPU().InvalidateRegion(vaddr, sizeof(T)); });
  534. if (ptr) {
  535. std::memcpy(ptr, &data, sizeof(T));
  536. }
  537. }
  538. template <typename T>
  539. bool WriteExclusive(VAddr vaddr, const T data, const T expected) {
  540. u8* const ptr = GetPointerImpl(
  541. vaddr,
  542. [vaddr, data]() {
  543. LOG_ERROR(HW_Memory, "Unmapped WriteExclusive{} @ 0x{:016X} = 0x{:016X}",
  544. sizeof(T) * 8, vaddr, static_cast<u64>(data));
  545. },
  546. [&]() { system.GPU().InvalidateRegion(vaddr, sizeof(T)); });
  547. if (ptr) {
  548. const auto volatile_pointer = reinterpret_cast<volatile T*>(ptr);
  549. return Common::AtomicCompareAndSwap(volatile_pointer, data, expected);
  550. }
  551. return true;
  552. }
  553. bool WriteExclusive128(VAddr vaddr, const u128 data, const u128 expected) {
  554. u8* const ptr = GetPointerImpl(
  555. vaddr,
  556. [vaddr, data]() {
  557. LOG_ERROR(HW_Memory, "Unmapped WriteExclusive128 @ 0x{:016X} = 0x{:016X}{:016X}",
  558. vaddr, static_cast<u64>(data[1]), static_cast<u64>(data[0]));
  559. },
  560. [&]() { system.GPU().InvalidateRegion(vaddr, sizeof(u128)); });
  561. if (ptr) {
  562. const auto volatile_pointer = reinterpret_cast<volatile u64*>(ptr);
  563. return Common::AtomicCompareAndSwap(volatile_pointer, data, expected);
  564. }
  565. return true;
  566. }
  567. Common::PageTable* current_page_table = nullptr;
  568. Core::System& system;
  569. };
  570. Memory::Memory(Core::System& system_) : system{system_} {
  571. Reset();
  572. }
  573. Memory::~Memory() = default;
  574. void Memory::Reset() {
  575. impl = std::make_unique<Impl>(system);
  576. }
  577. void Memory::SetCurrentPageTable(Kernel::KProcess& process, u32 core_id) {
  578. impl->SetCurrentPageTable(process, core_id);
  579. }
  580. void Memory::MapMemoryRegion(Common::PageTable& page_table, VAddr base, u64 size, PAddr target) {
  581. impl->MapMemoryRegion(page_table, base, size, target);
  582. }
  583. void Memory::UnmapRegion(Common::PageTable& page_table, VAddr base, u64 size) {
  584. impl->UnmapRegion(page_table, base, size);
  585. }
  586. bool Memory::IsValidVirtualAddress(const VAddr vaddr) const {
  587. const Kernel::KProcess& process = *system.CurrentProcess();
  588. const auto& page_table = process.PageTable().PageTableImpl();
  589. const size_t page = vaddr >> YUZU_PAGEBITS;
  590. if (page >= page_table.pointers.size()) {
  591. return false;
  592. }
  593. const auto [pointer, type] = page_table.pointers[page].PointerType();
  594. return pointer != nullptr || type == Common::PageType::RasterizerCachedMemory ||
  595. type == Common::PageType::DebugMemory;
  596. }
  597. bool Memory::IsValidVirtualAddressRange(VAddr base, u64 size) const {
  598. VAddr end = base + size;
  599. VAddr page = Common::AlignDown(base, YUZU_PAGESIZE);
  600. for (; page < end; page += YUZU_PAGESIZE) {
  601. if (!IsValidVirtualAddress(page)) {
  602. return false;
  603. }
  604. }
  605. return true;
  606. }
  607. u8* Memory::GetPointer(VAddr vaddr) {
  608. return impl->GetPointer(vaddr);
  609. }
  610. u8* Memory::GetPointerSilent(VAddr vaddr) {
  611. return impl->GetPointerSilent(vaddr);
  612. }
  613. const u8* Memory::GetPointer(VAddr vaddr) const {
  614. return impl->GetPointer(vaddr);
  615. }
  616. u8 Memory::Read8(const VAddr addr) {
  617. return impl->Read8(addr);
  618. }
  619. u16 Memory::Read16(const VAddr addr) {
  620. return impl->Read16(addr);
  621. }
  622. u32 Memory::Read32(const VAddr addr) {
  623. return impl->Read32(addr);
  624. }
  625. u64 Memory::Read64(const VAddr addr) {
  626. return impl->Read64(addr);
  627. }
  628. void Memory::Write8(VAddr addr, u8 data) {
  629. impl->Write8(addr, data);
  630. }
  631. void Memory::Write16(VAddr addr, u16 data) {
  632. impl->Write16(addr, data);
  633. }
  634. void Memory::Write32(VAddr addr, u32 data) {
  635. impl->Write32(addr, data);
  636. }
  637. void Memory::Write64(VAddr addr, u64 data) {
  638. impl->Write64(addr, data);
  639. }
  640. bool Memory::WriteExclusive8(VAddr addr, u8 data, u8 expected) {
  641. return impl->WriteExclusive8(addr, data, expected);
  642. }
  643. bool Memory::WriteExclusive16(VAddr addr, u16 data, u16 expected) {
  644. return impl->WriteExclusive16(addr, data, expected);
  645. }
  646. bool Memory::WriteExclusive32(VAddr addr, u32 data, u32 expected) {
  647. return impl->WriteExclusive32(addr, data, expected);
  648. }
  649. bool Memory::WriteExclusive64(VAddr addr, u64 data, u64 expected) {
  650. return impl->WriteExclusive64(addr, data, expected);
  651. }
  652. bool Memory::WriteExclusive128(VAddr addr, u128 data, u128 expected) {
  653. return impl->WriteExclusive128(addr, data, expected);
  654. }
  655. std::string Memory::ReadCString(VAddr vaddr, std::size_t max_length) {
  656. return impl->ReadCString(vaddr, max_length);
  657. }
  658. void Memory::ReadBlock(const Kernel::KProcess& process, const VAddr src_addr, void* dest_buffer,
  659. const std::size_t size) {
  660. impl->ReadBlockImpl<false>(process, src_addr, dest_buffer, size);
  661. }
  662. void Memory::ReadBlock(const VAddr src_addr, void* dest_buffer, const std::size_t size) {
  663. impl->ReadBlock(src_addr, dest_buffer, size);
  664. }
  665. void Memory::ReadBlockUnsafe(const VAddr src_addr, void* dest_buffer, const std::size_t size) {
  666. impl->ReadBlockUnsafe(src_addr, dest_buffer, size);
  667. }
  668. void Memory::WriteBlock(const Kernel::KProcess& process, VAddr dest_addr, const void* src_buffer,
  669. std::size_t size) {
  670. impl->WriteBlockImpl<false>(process, dest_addr, src_buffer, size);
  671. }
  672. void Memory::WriteBlock(const VAddr dest_addr, const void* src_buffer, const std::size_t size) {
  673. impl->WriteBlock(dest_addr, src_buffer, size);
  674. }
  675. void Memory::WriteBlockUnsafe(const VAddr dest_addr, const void* src_buffer,
  676. const std::size_t size) {
  677. impl->WriteBlockUnsafe(dest_addr, src_buffer, size);
  678. }
  679. void Memory::CopyBlock(const Kernel::KProcess& process, VAddr dest_addr, VAddr src_addr,
  680. const std::size_t size) {
  681. impl->CopyBlock(process, dest_addr, src_addr, size);
  682. }
  683. void Memory::ZeroBlock(const Kernel::KProcess& process, VAddr dest_addr, const std::size_t size) {
  684. impl->ZeroBlock(process, dest_addr, size);
  685. }
  686. void Memory::RasterizerMarkRegionCached(VAddr vaddr, u64 size, bool cached) {
  687. impl->RasterizerMarkRegionCached(vaddr, size, cached);
  688. }
  689. void Memory::MarkRegionDebug(VAddr vaddr, u64 size, bool debug) {
  690. impl->MarkRegionDebug(vaddr, size, debug);
  691. }
  692. } // namespace Core::Memory