kernel.cpp 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016
  1. // Copyright 2021 yuzu Emulator Project
  2. // Licensed under GPLv2 or any later version
  3. // Refer to the license.txt file included.
  4. #include <array>
  5. #include <atomic>
  6. #include <bitset>
  7. #include <functional>
  8. #include <memory>
  9. #include <thread>
  10. #include <unordered_set>
  11. #include <utility>
  12. #include "common/assert.h"
  13. #include "common/common_sizes.h"
  14. #include "common/logging/log.h"
  15. #include "common/microprofile.h"
  16. #include "common/thread.h"
  17. #include "common/thread_worker.h"
  18. #include "core/arm/arm_interface.h"
  19. #include "core/arm/cpu_interrupt_handler.h"
  20. #include "core/arm/exclusive_monitor.h"
  21. #include "core/core.h"
  22. #include "core/core_timing.h"
  23. #include "core/core_timing_util.h"
  24. #include "core/cpu_manager.h"
  25. #include "core/device_memory.h"
  26. #include "core/hardware_properties.h"
  27. #include "core/hle/kernel/init/init_slab_setup.h"
  28. #include "core/hle/kernel/k_client_port.h"
  29. #include "core/hle/kernel/k_handle_table.h"
  30. #include "core/hle/kernel/k_memory_layout.h"
  31. #include "core/hle/kernel/k_memory_manager.h"
  32. #include "core/hle/kernel/k_process.h"
  33. #include "core/hle/kernel/k_resource_limit.h"
  34. #include "core/hle/kernel/k_scheduler.h"
  35. #include "core/hle/kernel/k_shared_memory.h"
  36. #include "core/hle/kernel/k_slab_heap.h"
  37. #include "core/hle/kernel/k_thread.h"
  38. #include "core/hle/kernel/kernel.h"
  39. #include "core/hle/kernel/physical_core.h"
  40. #include "core/hle/kernel/service_thread.h"
  41. #include "core/hle/kernel/svc_results.h"
  42. #include "core/hle/kernel/time_manager.h"
  43. #include "core/hle/lock.h"
  44. #include "core/hle/result.h"
  45. #include "core/hle/service/sm/sm.h"
  46. #include "core/memory.h"
  47. MICROPROFILE_DEFINE(Kernel_SVC, "Kernel", "SVC", MP_RGB(70, 200, 70));
  48. namespace Kernel {
  49. struct KernelCore::Impl {
  50. explicit Impl(Core::System& system_, KernelCore& kernel_)
  51. : time_manager{system_}, object_list_container{kernel_}, system{system_} {}
  52. void SetMulticore(bool is_multi) {
  53. is_multicore = is_multi;
  54. }
  55. void Initialize(KernelCore& kernel) {
  56. global_scheduler_context = std::make_unique<Kernel::GlobalSchedulerContext>(kernel);
  57. global_handle_table = std::make_unique<Kernel::KHandleTable>(kernel);
  58. is_phantom_mode_for_singlecore = false;
  59. InitializePhysicalCores();
  60. // Derive the initial memory layout from the emulated board
  61. Init::InitializeSlabResourceCounts(kernel);
  62. KMemoryLayout memory_layout;
  63. DeriveInitialMemoryLayout(memory_layout);
  64. Init::InitializeSlabHeaps(system, memory_layout);
  65. // Initialize kernel memory and resources.
  66. InitializeSystemResourceLimit(kernel, system.CoreTiming(), memory_layout);
  67. InitializeMemoryLayout(memory_layout);
  68. InitializePageSlab();
  69. InitializeSchedulers();
  70. InitializeSuspendThreads();
  71. InitializePreemption(kernel);
  72. RegisterHostThread();
  73. }
  74. void InitializeCores() {
  75. for (auto& core : cores) {
  76. core.Initialize(current_process->Is64BitProcess());
  77. }
  78. }
  79. void Shutdown() {
  80. process_list.clear();
  81. // Ensures all service threads gracefully shutdown
  82. service_threads.clear();
  83. next_object_id = 0;
  84. next_kernel_process_id = KProcess::InitialKIPIDMin;
  85. next_user_process_id = KProcess::ProcessIDMin;
  86. next_thread_id = 1;
  87. for (u32 core_id = 0; core_id < Core::Hardware::NUM_CPU_CORES; core_id++) {
  88. if (suspend_threads[core_id]) {
  89. suspend_threads[core_id]->Close();
  90. suspend_threads[core_id] = nullptr;
  91. }
  92. schedulers[core_id].reset();
  93. }
  94. cores.clear();
  95. if (current_process) {
  96. current_process->Close();
  97. current_process = nullptr;
  98. }
  99. global_handle_table.reset();
  100. preemption_event = nullptr;
  101. for (auto& iter : named_ports) {
  102. iter.second->Close();
  103. }
  104. named_ports.clear();
  105. exclusive_monitor.reset();
  106. // Cleanup persistent kernel objects
  107. auto CleanupObject = [](KAutoObject* obj) {
  108. if (obj) {
  109. obj->Close();
  110. obj = nullptr;
  111. }
  112. };
  113. CleanupObject(hid_shared_mem);
  114. CleanupObject(font_shared_mem);
  115. CleanupObject(irs_shared_mem);
  116. CleanupObject(time_shared_mem);
  117. CleanupObject(system_resource_limit);
  118. // Next host thead ID to use, 0-3 IDs represent core threads, >3 represent others
  119. next_host_thread_id = Core::Hardware::NUM_CPU_CORES;
  120. }
  121. void InitializePhysicalCores() {
  122. exclusive_monitor =
  123. Core::MakeExclusiveMonitor(system.Memory(), Core::Hardware::NUM_CPU_CORES);
  124. for (u32 i = 0; i < Core::Hardware::NUM_CPU_CORES; i++) {
  125. schedulers[i] = std::make_unique<Kernel::KScheduler>(system, i);
  126. cores.emplace_back(i, system, *schedulers[i], interrupts);
  127. }
  128. }
  129. void InitializeSchedulers() {
  130. for (u32 i = 0; i < Core::Hardware::NUM_CPU_CORES; i++) {
  131. cores[i].Scheduler().Initialize();
  132. }
  133. }
  134. // Creates the default system resource limit
  135. void InitializeSystemResourceLimit(KernelCore& kernel,
  136. const Core::Timing::CoreTiming& core_timing,
  137. const KMemoryLayout& memory_layout) {
  138. system_resource_limit = KResourceLimit::Create(system.Kernel());
  139. system_resource_limit->Initialize(&core_timing);
  140. const auto [total_size, kernel_size] = memory_layout.GetTotalAndKernelMemorySizes();
  141. // If setting the default system values fails, then something seriously wrong has occurred.
  142. ASSERT(system_resource_limit->SetLimitValue(LimitableResource::PhysicalMemory, total_size)
  143. .IsSuccess());
  144. ASSERT(system_resource_limit->SetLimitValue(LimitableResource::Threads, 800).IsSuccess());
  145. ASSERT(system_resource_limit->SetLimitValue(LimitableResource::Events, 900).IsSuccess());
  146. ASSERT(system_resource_limit->SetLimitValue(LimitableResource::TransferMemory, 200)
  147. .IsSuccess());
  148. ASSERT(system_resource_limit->SetLimitValue(LimitableResource::Sessions, 1133).IsSuccess());
  149. system_resource_limit->Reserve(LimitableResource::PhysicalMemory, kernel_size);
  150. // Reserve secure applet memory, introduced in firmware 5.0.0
  151. constexpr u64 secure_applet_memory_size{Common::Size_4_MB};
  152. ASSERT(system_resource_limit->Reserve(LimitableResource::PhysicalMemory,
  153. secure_applet_memory_size));
  154. // This memory seems to be reserved on hardware, but is not reserved/used by yuzu.
  155. // Likely Horizon OS reserved memory
  156. // TODO(ameerj): Derive the memory rather than hardcode it.
  157. constexpr u64 unknown_reserved_memory{0x2f896000};
  158. ASSERT(system_resource_limit->Reserve(LimitableResource::PhysicalMemory,
  159. unknown_reserved_memory));
  160. }
  161. void InitializePreemption(KernelCore& kernel) {
  162. preemption_event = Core::Timing::CreateEvent(
  163. "PreemptionCallback", [this, &kernel](std::uintptr_t, std::chrono::nanoseconds) {
  164. {
  165. KScopedSchedulerLock lock(kernel);
  166. global_scheduler_context->PreemptThreads();
  167. }
  168. const auto time_interval = std::chrono::nanoseconds{
  169. Core::Timing::msToCycles(std::chrono::milliseconds(10))};
  170. system.CoreTiming().ScheduleEvent(time_interval, preemption_event);
  171. });
  172. const auto time_interval =
  173. std::chrono::nanoseconds{Core::Timing::msToCycles(std::chrono::milliseconds(10))};
  174. system.CoreTiming().ScheduleEvent(time_interval, preemption_event);
  175. }
  176. void InitializeSuspendThreads() {
  177. for (u32 core_id = 0; core_id < Core::Hardware::NUM_CPU_CORES; core_id++) {
  178. suspend_threads[core_id] = KThread::Create(system.Kernel());
  179. ASSERT(KThread::InitializeHighPriorityThread(system, suspend_threads[core_id], {}, {},
  180. core_id)
  181. .IsSuccess());
  182. suspend_threads[core_id]->SetName(fmt::format("SuspendThread:{}", core_id));
  183. }
  184. }
  185. void MakeCurrentProcess(KProcess* process) {
  186. current_process = process;
  187. if (process == nullptr) {
  188. return;
  189. }
  190. const u32 core_id = GetCurrentHostThreadID();
  191. if (core_id < Core::Hardware::NUM_CPU_CORES) {
  192. system.Memory().SetCurrentPageTable(*process, core_id);
  193. }
  194. }
  195. /// Creates a new host thread ID, should only be called by GetHostThreadId
  196. u32 AllocateHostThreadId(std::optional<std::size_t> core_id) {
  197. if (core_id) {
  198. // The first for slots are reserved for CPU core threads
  199. ASSERT(*core_id < Core::Hardware::NUM_CPU_CORES);
  200. return static_cast<u32>(*core_id);
  201. } else {
  202. return next_host_thread_id++;
  203. }
  204. }
  205. /// Gets the host thread ID for the caller, allocating a new one if this is the first time
  206. u32 GetHostThreadId(std::optional<std::size_t> core_id = std::nullopt) {
  207. const thread_local auto host_thread_id{AllocateHostThreadId(core_id)};
  208. return host_thread_id;
  209. }
  210. // Gets the dummy KThread for the caller, allocating a new one if this is the first time
  211. KThread* GetHostDummyThread() {
  212. auto make_thread = [this]() {
  213. std::unique_ptr<KThread> thread = std::make_unique<KThread>(system.Kernel());
  214. KAutoObject::Create(thread.get());
  215. ASSERT(KThread::InitializeDummyThread(thread.get()).IsSuccess());
  216. thread->SetName(fmt::format("DummyThread:{}", GetHostThreadId()));
  217. return thread;
  218. };
  219. thread_local auto thread = make_thread();
  220. return thread.get();
  221. }
  222. /// Registers a CPU core thread by allocating a host thread ID for it
  223. void RegisterCoreThread(std::size_t core_id) {
  224. ASSERT(core_id < Core::Hardware::NUM_CPU_CORES);
  225. const auto this_id = GetHostThreadId(core_id);
  226. if (!is_multicore) {
  227. single_core_thread_id = this_id;
  228. }
  229. }
  230. /// Registers a new host thread by allocating a host thread ID for it
  231. void RegisterHostThread() {
  232. [[maybe_unused]] const auto this_id = GetHostThreadId();
  233. [[maybe_unused]] const auto dummy_thread = GetHostDummyThread();
  234. }
  235. [[nodiscard]] u32 GetCurrentHostThreadID() {
  236. const auto this_id = GetHostThreadId();
  237. if (!is_multicore && single_core_thread_id == this_id) {
  238. return static_cast<u32>(system.GetCpuManager().CurrentCore());
  239. }
  240. return this_id;
  241. }
  242. bool IsPhantomModeForSingleCore() const {
  243. return is_phantom_mode_for_singlecore;
  244. }
  245. void SetIsPhantomModeForSingleCore(bool value) {
  246. ASSERT(!is_multicore);
  247. is_phantom_mode_for_singlecore = value;
  248. }
  249. KThread* GetCurrentEmuThread() {
  250. const auto thread_id = GetCurrentHostThreadID();
  251. if (thread_id >= Core::Hardware::NUM_CPU_CORES) {
  252. return GetHostDummyThread();
  253. }
  254. return schedulers[thread_id]->GetCurrentThread();
  255. }
  256. void DeriveInitialMemoryLayout(KMemoryLayout& memory_layout) {
  257. // Insert the root region for the virtual memory tree, from which all other regions will
  258. // derive.
  259. memory_layout.GetVirtualMemoryRegionTree().InsertDirectly(
  260. KernelVirtualAddressSpaceBase,
  261. KernelVirtualAddressSpaceBase + KernelVirtualAddressSpaceSize - 1);
  262. // Insert the root region for the physical memory tree, from which all other regions will
  263. // derive.
  264. memory_layout.GetPhysicalMemoryRegionTree().InsertDirectly(
  265. KernelPhysicalAddressSpaceBase,
  266. KernelPhysicalAddressSpaceBase + KernelPhysicalAddressSpaceSize - 1);
  267. // Save start and end for ease of use.
  268. const VAddr code_start_virt_addr = KernelVirtualAddressCodeBase;
  269. const VAddr code_end_virt_addr = KernelVirtualAddressCodeEnd;
  270. // Setup the containing kernel region.
  271. constexpr size_t KernelRegionSize = Common::Size_1_GB;
  272. constexpr size_t KernelRegionAlign = Common::Size_1_GB;
  273. constexpr VAddr kernel_region_start =
  274. Common::AlignDown(code_start_virt_addr, KernelRegionAlign);
  275. size_t kernel_region_size = KernelRegionSize;
  276. if (!(kernel_region_start + KernelRegionSize - 1 <= KernelVirtualAddressSpaceLast)) {
  277. kernel_region_size = KernelVirtualAddressSpaceEnd - kernel_region_start;
  278. }
  279. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  280. kernel_region_start, kernel_region_size, KMemoryRegionType_Kernel));
  281. // Setup the code region.
  282. constexpr size_t CodeRegionAlign = PageSize;
  283. constexpr VAddr code_region_start =
  284. Common::AlignDown(code_start_virt_addr, CodeRegionAlign);
  285. constexpr VAddr code_region_end = Common::AlignUp(code_end_virt_addr, CodeRegionAlign);
  286. constexpr size_t code_region_size = code_region_end - code_region_start;
  287. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  288. code_region_start, code_region_size, KMemoryRegionType_KernelCode));
  289. // Setup board-specific device physical regions.
  290. Init::SetupDevicePhysicalMemoryRegions(memory_layout);
  291. // Determine the amount of space needed for the misc region.
  292. size_t misc_region_needed_size;
  293. {
  294. // Each core has a one page stack for all three stack types (Main, Idle, Exception).
  295. misc_region_needed_size = Core::Hardware::NUM_CPU_CORES * (3 * (PageSize + PageSize));
  296. // Account for each auto-map device.
  297. for (const auto& region : memory_layout.GetPhysicalMemoryRegionTree()) {
  298. if (region.HasTypeAttribute(KMemoryRegionAttr_ShouldKernelMap)) {
  299. // Check that the region is valid.
  300. ASSERT(region.GetEndAddress() != 0);
  301. // Account for the region.
  302. misc_region_needed_size +=
  303. PageSize + (Common::AlignUp(region.GetLastAddress(), PageSize) -
  304. Common::AlignDown(region.GetAddress(), PageSize));
  305. }
  306. }
  307. // Multiply the needed size by three, to account for the need for guard space.
  308. misc_region_needed_size *= 3;
  309. }
  310. // Decide on the actual size for the misc region.
  311. constexpr size_t MiscRegionAlign = KernelAslrAlignment;
  312. constexpr size_t MiscRegionMinimumSize = Common::Size_32_MB;
  313. const size_t misc_region_size = Common::AlignUp(
  314. std::max(misc_region_needed_size, MiscRegionMinimumSize), MiscRegionAlign);
  315. ASSERT(misc_region_size > 0);
  316. // Setup the misc region.
  317. const VAddr misc_region_start =
  318. memory_layout.GetVirtualMemoryRegionTree().GetRandomAlignedRegion(
  319. misc_region_size, MiscRegionAlign, KMemoryRegionType_Kernel);
  320. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  321. misc_region_start, misc_region_size, KMemoryRegionType_KernelMisc));
  322. // Setup the stack region.
  323. constexpr size_t StackRegionSize = Common::Size_14_MB;
  324. constexpr size_t StackRegionAlign = KernelAslrAlignment;
  325. const VAddr stack_region_start =
  326. memory_layout.GetVirtualMemoryRegionTree().GetRandomAlignedRegion(
  327. StackRegionSize, StackRegionAlign, KMemoryRegionType_Kernel);
  328. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  329. stack_region_start, StackRegionSize, KMemoryRegionType_KernelStack));
  330. // Determine the size of the resource region.
  331. const size_t resource_region_size = memory_layout.GetResourceRegionSizeForInit();
  332. // Determine the size of the slab region.
  333. const size_t slab_region_size =
  334. Common::AlignUp(Init::CalculateTotalSlabHeapSize(system.Kernel()), PageSize);
  335. ASSERT(slab_region_size <= resource_region_size);
  336. // Setup the slab region.
  337. const PAddr code_start_phys_addr = KernelPhysicalAddressCodeBase;
  338. const PAddr code_end_phys_addr = code_start_phys_addr + code_region_size;
  339. const PAddr slab_start_phys_addr = code_end_phys_addr;
  340. const PAddr slab_end_phys_addr = slab_start_phys_addr + slab_region_size;
  341. constexpr size_t SlabRegionAlign = KernelAslrAlignment;
  342. const size_t slab_region_needed_size =
  343. Common::AlignUp(code_end_phys_addr + slab_region_size, SlabRegionAlign) -
  344. Common::AlignDown(code_end_phys_addr, SlabRegionAlign);
  345. const VAddr slab_region_start =
  346. memory_layout.GetVirtualMemoryRegionTree().GetRandomAlignedRegion(
  347. slab_region_needed_size, SlabRegionAlign, KMemoryRegionType_Kernel) +
  348. (code_end_phys_addr % SlabRegionAlign);
  349. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  350. slab_region_start, slab_region_size, KMemoryRegionType_KernelSlab));
  351. // Setup the temp region.
  352. constexpr size_t TempRegionSize = Common::Size_128_MB;
  353. constexpr size_t TempRegionAlign = KernelAslrAlignment;
  354. const VAddr temp_region_start =
  355. memory_layout.GetVirtualMemoryRegionTree().GetRandomAlignedRegion(
  356. TempRegionSize, TempRegionAlign, KMemoryRegionType_Kernel);
  357. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(temp_region_start, TempRegionSize,
  358. KMemoryRegionType_KernelTemp));
  359. // Automatically map in devices that have auto-map attributes.
  360. for (auto& region : memory_layout.GetPhysicalMemoryRegionTree()) {
  361. // We only care about kernel regions.
  362. if (!region.IsDerivedFrom(KMemoryRegionType_Kernel)) {
  363. continue;
  364. }
  365. // Check whether we should map the region.
  366. if (!region.HasTypeAttribute(KMemoryRegionAttr_ShouldKernelMap)) {
  367. continue;
  368. }
  369. // If this region has already been mapped, no need to consider it.
  370. if (region.HasTypeAttribute(KMemoryRegionAttr_DidKernelMap)) {
  371. continue;
  372. }
  373. // Check that the region is valid.
  374. ASSERT(region.GetEndAddress() != 0);
  375. // Set the attribute to note we've mapped this region.
  376. region.SetTypeAttribute(KMemoryRegionAttr_DidKernelMap);
  377. // Create a virtual pair region and insert it into the tree.
  378. const PAddr map_phys_addr = Common::AlignDown(region.GetAddress(), PageSize);
  379. const size_t map_size =
  380. Common::AlignUp(region.GetEndAddress(), PageSize) - map_phys_addr;
  381. const VAddr map_virt_addr =
  382. memory_layout.GetVirtualMemoryRegionTree().GetRandomAlignedRegionWithGuard(
  383. map_size, PageSize, KMemoryRegionType_KernelMisc, PageSize);
  384. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  385. map_virt_addr, map_size, KMemoryRegionType_KernelMiscMappedDevice));
  386. region.SetPairAddress(map_virt_addr + region.GetAddress() - map_phys_addr);
  387. }
  388. Init::SetupDramPhysicalMemoryRegions(memory_layout);
  389. // Insert a physical region for the kernel code region.
  390. ASSERT(memory_layout.GetPhysicalMemoryRegionTree().Insert(
  391. code_start_phys_addr, code_region_size, KMemoryRegionType_DramKernelCode));
  392. // Insert a physical region for the kernel slab region.
  393. ASSERT(memory_layout.GetPhysicalMemoryRegionTree().Insert(
  394. slab_start_phys_addr, slab_region_size, KMemoryRegionType_DramKernelSlab));
  395. // Determine size available for kernel page table heaps, requiring > 8 MB.
  396. const PAddr resource_end_phys_addr = slab_start_phys_addr + resource_region_size;
  397. const size_t page_table_heap_size = resource_end_phys_addr - slab_end_phys_addr;
  398. ASSERT(page_table_heap_size / Common::Size_4_MB > 2);
  399. // Insert a physical region for the kernel page table heap region
  400. ASSERT(memory_layout.GetPhysicalMemoryRegionTree().Insert(
  401. slab_end_phys_addr, page_table_heap_size, KMemoryRegionType_DramKernelPtHeap));
  402. // All DRAM regions that we haven't tagged by this point will be mapped under the linear
  403. // mapping. Tag them.
  404. for (auto& region : memory_layout.GetPhysicalMemoryRegionTree()) {
  405. if (region.GetType() == KMemoryRegionType_Dram) {
  406. // Check that the region is valid.
  407. ASSERT(region.GetEndAddress() != 0);
  408. // Set the linear map attribute.
  409. region.SetTypeAttribute(KMemoryRegionAttr_LinearMapped);
  410. }
  411. }
  412. // Get the linear region extents.
  413. const auto linear_extents =
  414. memory_layout.GetPhysicalMemoryRegionTree().GetDerivedRegionExtents(
  415. KMemoryRegionAttr_LinearMapped);
  416. ASSERT(linear_extents.GetEndAddress() != 0);
  417. // Setup the linear mapping region.
  418. constexpr size_t LinearRegionAlign = Common::Size_1_GB;
  419. const PAddr aligned_linear_phys_start =
  420. Common::AlignDown(linear_extents.GetAddress(), LinearRegionAlign);
  421. const size_t linear_region_size =
  422. Common::AlignUp(linear_extents.GetEndAddress(), LinearRegionAlign) -
  423. aligned_linear_phys_start;
  424. const VAddr linear_region_start =
  425. memory_layout.GetVirtualMemoryRegionTree().GetRandomAlignedRegionWithGuard(
  426. linear_region_size, LinearRegionAlign, KMemoryRegionType_None, LinearRegionAlign);
  427. const u64 linear_region_phys_to_virt_diff = linear_region_start - aligned_linear_phys_start;
  428. // Map and create regions for all the linearly-mapped data.
  429. {
  430. PAddr cur_phys_addr = 0;
  431. u64 cur_size = 0;
  432. for (auto& region : memory_layout.GetPhysicalMemoryRegionTree()) {
  433. if (!region.HasTypeAttribute(KMemoryRegionAttr_LinearMapped)) {
  434. continue;
  435. }
  436. ASSERT(region.GetEndAddress() != 0);
  437. if (cur_size == 0) {
  438. cur_phys_addr = region.GetAddress();
  439. cur_size = region.GetSize();
  440. } else if (cur_phys_addr + cur_size == region.GetAddress()) {
  441. cur_size += region.GetSize();
  442. } else {
  443. cur_phys_addr = region.GetAddress();
  444. cur_size = region.GetSize();
  445. }
  446. const VAddr region_virt_addr =
  447. region.GetAddress() + linear_region_phys_to_virt_diff;
  448. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  449. region_virt_addr, region.GetSize(),
  450. GetTypeForVirtualLinearMapping(region.GetType())));
  451. region.SetPairAddress(region_virt_addr);
  452. KMemoryRegion* virt_region =
  453. memory_layout.GetVirtualMemoryRegionTree().FindModifiable(region_virt_addr);
  454. ASSERT(virt_region != nullptr);
  455. virt_region->SetPairAddress(region.GetAddress());
  456. }
  457. }
  458. // Insert regions for the initial page table region.
  459. ASSERT(memory_layout.GetPhysicalMemoryRegionTree().Insert(
  460. resource_end_phys_addr, KernelPageTableHeapSize, KMemoryRegionType_DramKernelInitPt));
  461. ASSERT(memory_layout.GetVirtualMemoryRegionTree().Insert(
  462. resource_end_phys_addr + linear_region_phys_to_virt_diff, KernelPageTableHeapSize,
  463. KMemoryRegionType_VirtualDramKernelInitPt));
  464. // All linear-mapped DRAM regions that we haven't tagged by this point will be allocated to
  465. // some pool partition. Tag them.
  466. for (auto& region : memory_layout.GetPhysicalMemoryRegionTree()) {
  467. if (region.GetType() == (KMemoryRegionType_Dram | KMemoryRegionAttr_LinearMapped)) {
  468. region.SetType(KMemoryRegionType_DramPoolPartition);
  469. }
  470. }
  471. // Setup all other memory regions needed to arrange the pool partitions.
  472. Init::SetupPoolPartitionMemoryRegions(memory_layout);
  473. // Cache all linear regions in their own trees for faster access, later.
  474. memory_layout.InitializeLinearMemoryRegionTrees(aligned_linear_phys_start,
  475. linear_region_start);
  476. }
  477. void InitializeMemoryLayout(const KMemoryLayout& memory_layout) {
  478. const auto system_pool = memory_layout.GetKernelSystemPoolRegionPhysicalExtents();
  479. const auto applet_pool = memory_layout.GetKernelAppletPoolRegionPhysicalExtents();
  480. const auto application_pool = memory_layout.GetKernelApplicationPoolRegionPhysicalExtents();
  481. // Initialize memory managers
  482. memory_manager = std::make_unique<KMemoryManager>();
  483. memory_manager->InitializeManager(KMemoryManager::Pool::Application,
  484. application_pool.GetAddress(),
  485. application_pool.GetEndAddress());
  486. memory_manager->InitializeManager(KMemoryManager::Pool::Applet, applet_pool.GetAddress(),
  487. applet_pool.GetEndAddress());
  488. memory_manager->InitializeManager(KMemoryManager::Pool::System, system_pool.GetAddress(),
  489. system_pool.GetEndAddress());
  490. // Setup memory regions for emulated processes
  491. // TODO(bunnei): These should not be hardcoded regions initialized within the kernel
  492. constexpr std::size_t hid_size{0x40000};
  493. constexpr std::size_t font_size{0x1100000};
  494. constexpr std::size_t irs_size{0x8000};
  495. constexpr std::size_t time_size{0x1000};
  496. const PAddr hid_phys_addr{system_pool.GetAddress()};
  497. const PAddr font_phys_addr{system_pool.GetAddress() + hid_size};
  498. const PAddr irs_phys_addr{system_pool.GetAddress() + hid_size + font_size};
  499. const PAddr time_phys_addr{system_pool.GetAddress() + hid_size + font_size + irs_size};
  500. hid_shared_mem = KSharedMemory::Create(system.Kernel());
  501. font_shared_mem = KSharedMemory::Create(system.Kernel());
  502. irs_shared_mem = KSharedMemory::Create(system.Kernel());
  503. time_shared_mem = KSharedMemory::Create(system.Kernel());
  504. hid_shared_mem->Initialize(system.DeviceMemory(), nullptr,
  505. {hid_phys_addr, hid_size / PageSize},
  506. Svc::MemoryPermission::None, Svc::MemoryPermission::Read,
  507. hid_phys_addr, hid_size, "HID:SharedMemory");
  508. font_shared_mem->Initialize(system.DeviceMemory(), nullptr,
  509. {font_phys_addr, font_size / PageSize},
  510. Svc::MemoryPermission::None, Svc::MemoryPermission::Read,
  511. font_phys_addr, font_size, "Font:SharedMemory");
  512. irs_shared_mem->Initialize(system.DeviceMemory(), nullptr,
  513. {irs_phys_addr, irs_size / PageSize},
  514. Svc::MemoryPermission::None, Svc::MemoryPermission::Read,
  515. irs_phys_addr, irs_size, "IRS:SharedMemory");
  516. time_shared_mem->Initialize(system.DeviceMemory(), nullptr,
  517. {time_phys_addr, time_size / PageSize},
  518. Svc::MemoryPermission::None, Svc::MemoryPermission::Read,
  519. time_phys_addr, time_size, "Time:SharedMemory");
  520. }
  521. void InitializePageSlab() {
  522. // Allocate slab heaps
  523. user_slab_heap_pages =
  524. std::make_unique<KSlabHeap<Page>>(KSlabHeap<Page>::AllocationType::Guest);
  525. // TODO(ameerj): This should be derived, not hardcoded within the kernel
  526. constexpr u64 user_slab_heap_size{0x3de000};
  527. // Reserve slab heaps
  528. ASSERT(
  529. system_resource_limit->Reserve(LimitableResource::PhysicalMemory, user_slab_heap_size));
  530. // Initialize slab heap
  531. user_slab_heap_pages->Initialize(
  532. system.DeviceMemory().GetPointer(Core::DramMemoryMap::SlabHeapBase),
  533. user_slab_heap_size);
  534. }
  535. std::atomic<u32> next_object_id{0};
  536. std::atomic<u64> next_kernel_process_id{KProcess::InitialKIPIDMin};
  537. std::atomic<u64> next_user_process_id{KProcess::ProcessIDMin};
  538. std::atomic<u64> next_thread_id{1};
  539. // Lists all processes that exist in the current session.
  540. std::vector<KProcess*> process_list;
  541. KProcess* current_process{};
  542. std::unique_ptr<Kernel::GlobalSchedulerContext> global_scheduler_context;
  543. Kernel::TimeManager time_manager;
  544. Init::KSlabResourceCounts slab_resource_counts{};
  545. KResourceLimit* system_resource_limit{};
  546. std::shared_ptr<Core::Timing::EventType> preemption_event;
  547. // This is the kernel's handle table or supervisor handle table which
  548. // stores all the objects in place.
  549. std::unique_ptr<KHandleTable> global_handle_table;
  550. KAutoObjectWithListContainer object_list_container;
  551. /// Map of named ports managed by the kernel, which can be retrieved using
  552. /// the ConnectToPort SVC.
  553. std::unordered_map<std::string, ServiceInterfaceFactory> service_interface_factory;
  554. NamedPortTable named_ports;
  555. std::unique_ptr<Core::ExclusiveMonitor> exclusive_monitor;
  556. std::vector<Kernel::PhysicalCore> cores;
  557. // Next host thead ID to use, 0-3 IDs represent core threads, >3 represent others
  558. std::atomic<u32> next_host_thread_id{Core::Hardware::NUM_CPU_CORES};
  559. // Kernel memory management
  560. std::unique_ptr<KMemoryManager> memory_manager;
  561. std::unique_ptr<KSlabHeap<Page>> user_slab_heap_pages;
  562. // Shared memory for services
  563. Kernel::KSharedMemory* hid_shared_mem{};
  564. Kernel::KSharedMemory* font_shared_mem{};
  565. Kernel::KSharedMemory* irs_shared_mem{};
  566. Kernel::KSharedMemory* time_shared_mem{};
  567. // Threads used for services
  568. std::unordered_set<std::shared_ptr<Kernel::ServiceThread>> service_threads;
  569. std::array<KThread*, Core::Hardware::NUM_CPU_CORES> suspend_threads;
  570. std::array<Core::CPUInterruptHandler, Core::Hardware::NUM_CPU_CORES> interrupts{};
  571. std::array<std::unique_ptr<Kernel::KScheduler>, Core::Hardware::NUM_CPU_CORES> schedulers{};
  572. bool is_multicore{};
  573. bool is_phantom_mode_for_singlecore{};
  574. u32 single_core_thread_id{};
  575. std::array<u64, Core::Hardware::NUM_CPU_CORES> svc_ticks{};
  576. // System context
  577. Core::System& system;
  578. };
  579. KernelCore::KernelCore(Core::System& system) : impl{std::make_unique<Impl>(system, *this)} {}
  580. KernelCore::~KernelCore() = default;
  581. void KernelCore::SetMulticore(bool is_multicore) {
  582. impl->SetMulticore(is_multicore);
  583. }
  584. void KernelCore::Initialize() {
  585. slab_heap_container = std::make_unique<SlabHeapContainer>();
  586. impl->Initialize(*this);
  587. }
  588. void KernelCore::InitializeCores() {
  589. impl->InitializeCores();
  590. }
  591. void KernelCore::Shutdown() {
  592. impl->Shutdown();
  593. }
  594. const KResourceLimit* KernelCore::GetSystemResourceLimit() const {
  595. return impl->system_resource_limit;
  596. }
  597. KResourceLimit* KernelCore::GetSystemResourceLimit() {
  598. return impl->system_resource_limit;
  599. }
  600. KScopedAutoObject<KThread> KernelCore::RetrieveThreadFromGlobalHandleTable(Handle handle) const {
  601. return impl->global_handle_table->GetObject<KThread>(handle);
  602. }
  603. void KernelCore::AppendNewProcess(KProcess* process) {
  604. impl->process_list.push_back(process);
  605. }
  606. void KernelCore::MakeCurrentProcess(KProcess* process) {
  607. impl->MakeCurrentProcess(process);
  608. }
  609. KProcess* KernelCore::CurrentProcess() {
  610. return impl->current_process;
  611. }
  612. const KProcess* KernelCore::CurrentProcess() const {
  613. return impl->current_process;
  614. }
  615. const std::vector<KProcess*>& KernelCore::GetProcessList() const {
  616. return impl->process_list;
  617. }
  618. Kernel::GlobalSchedulerContext& KernelCore::GlobalSchedulerContext() {
  619. return *impl->global_scheduler_context;
  620. }
  621. const Kernel::GlobalSchedulerContext& KernelCore::GlobalSchedulerContext() const {
  622. return *impl->global_scheduler_context;
  623. }
  624. Kernel::KScheduler& KernelCore::Scheduler(std::size_t id) {
  625. return *impl->schedulers[id];
  626. }
  627. const Kernel::KScheduler& KernelCore::Scheduler(std::size_t id) const {
  628. return *impl->schedulers[id];
  629. }
  630. Kernel::PhysicalCore& KernelCore::PhysicalCore(std::size_t id) {
  631. return impl->cores[id];
  632. }
  633. const Kernel::PhysicalCore& KernelCore::PhysicalCore(std::size_t id) const {
  634. return impl->cores[id];
  635. }
  636. Kernel::PhysicalCore& KernelCore::CurrentPhysicalCore() {
  637. u32 core_id = impl->GetCurrentHostThreadID();
  638. ASSERT(core_id < Core::Hardware::NUM_CPU_CORES);
  639. return impl->cores[core_id];
  640. }
  641. const Kernel::PhysicalCore& KernelCore::CurrentPhysicalCore() const {
  642. u32 core_id = impl->GetCurrentHostThreadID();
  643. ASSERT(core_id < Core::Hardware::NUM_CPU_CORES);
  644. return impl->cores[core_id];
  645. }
  646. Kernel::KScheduler* KernelCore::CurrentScheduler() {
  647. u32 core_id = impl->GetCurrentHostThreadID();
  648. if (core_id >= Core::Hardware::NUM_CPU_CORES) {
  649. // This is expected when called from not a guest thread
  650. return {};
  651. }
  652. return impl->schedulers[core_id].get();
  653. }
  654. std::array<Core::CPUInterruptHandler, Core::Hardware::NUM_CPU_CORES>& KernelCore::Interrupts() {
  655. return impl->interrupts;
  656. }
  657. const std::array<Core::CPUInterruptHandler, Core::Hardware::NUM_CPU_CORES>& KernelCore::Interrupts()
  658. const {
  659. return impl->interrupts;
  660. }
  661. Kernel::TimeManager& KernelCore::TimeManager() {
  662. return impl->time_manager;
  663. }
  664. const Kernel::TimeManager& KernelCore::TimeManager() const {
  665. return impl->time_manager;
  666. }
  667. Core::ExclusiveMonitor& KernelCore::GetExclusiveMonitor() {
  668. return *impl->exclusive_monitor;
  669. }
  670. const Core::ExclusiveMonitor& KernelCore::GetExclusiveMonitor() const {
  671. return *impl->exclusive_monitor;
  672. }
  673. KAutoObjectWithListContainer& KernelCore::ObjectListContainer() {
  674. return impl->object_list_container;
  675. }
  676. const KAutoObjectWithListContainer& KernelCore::ObjectListContainer() const {
  677. return impl->object_list_container;
  678. }
  679. void KernelCore::InvalidateAllInstructionCaches() {
  680. for (auto& physical_core : impl->cores) {
  681. physical_core.ArmInterface().ClearInstructionCache();
  682. }
  683. }
  684. void KernelCore::InvalidateCpuInstructionCacheRange(VAddr addr, std::size_t size) {
  685. for (auto& physical_core : impl->cores) {
  686. if (!physical_core.IsInitialized()) {
  687. continue;
  688. }
  689. physical_core.ArmInterface().InvalidateCacheRange(addr, size);
  690. }
  691. }
  692. void KernelCore::PrepareReschedule(std::size_t id) {
  693. // TODO: Reimplement, this
  694. }
  695. void KernelCore::RegisterNamedService(std::string name, ServiceInterfaceFactory&& factory) {
  696. impl->service_interface_factory.emplace(std::move(name), factory);
  697. }
  698. KClientPort* KernelCore::CreateNamedServicePort(std::string name) {
  699. auto search = impl->service_interface_factory.find(name);
  700. if (search == impl->service_interface_factory.end()) {
  701. UNIMPLEMENTED();
  702. return {};
  703. }
  704. return &search->second(impl->system.ServiceManager(), impl->system);
  705. }
  706. bool KernelCore::IsValidNamedPort(NamedPortTable::const_iterator port) const {
  707. return port != impl->named_ports.cend();
  708. }
  709. u32 KernelCore::CreateNewObjectID() {
  710. return impl->next_object_id++;
  711. }
  712. u64 KernelCore::CreateNewThreadID() {
  713. return impl->next_thread_id++;
  714. }
  715. u64 KernelCore::CreateNewKernelProcessID() {
  716. return impl->next_kernel_process_id++;
  717. }
  718. u64 KernelCore::CreateNewUserProcessID() {
  719. return impl->next_user_process_id++;
  720. }
  721. KHandleTable& KernelCore::GlobalHandleTable() {
  722. return *impl->global_handle_table;
  723. }
  724. const KHandleTable& KernelCore::GlobalHandleTable() const {
  725. return *impl->global_handle_table;
  726. }
  727. void KernelCore::RegisterCoreThread(std::size_t core_id) {
  728. impl->RegisterCoreThread(core_id);
  729. }
  730. void KernelCore::RegisterHostThread() {
  731. impl->RegisterHostThread();
  732. }
  733. u32 KernelCore::GetCurrentHostThreadID() const {
  734. return impl->GetCurrentHostThreadID();
  735. }
  736. KThread* KernelCore::GetCurrentEmuThread() const {
  737. return impl->GetCurrentEmuThread();
  738. }
  739. KMemoryManager& KernelCore::MemoryManager() {
  740. return *impl->memory_manager;
  741. }
  742. const KMemoryManager& KernelCore::MemoryManager() const {
  743. return *impl->memory_manager;
  744. }
  745. KSlabHeap<Page>& KernelCore::GetUserSlabHeapPages() {
  746. return *impl->user_slab_heap_pages;
  747. }
  748. const KSlabHeap<Page>& KernelCore::GetUserSlabHeapPages() const {
  749. return *impl->user_slab_heap_pages;
  750. }
  751. Kernel::KSharedMemory& KernelCore::GetHidSharedMem() {
  752. return *impl->hid_shared_mem;
  753. }
  754. const Kernel::KSharedMemory& KernelCore::GetHidSharedMem() const {
  755. return *impl->hid_shared_mem;
  756. }
  757. Kernel::KSharedMemory& KernelCore::GetFontSharedMem() {
  758. return *impl->font_shared_mem;
  759. }
  760. const Kernel::KSharedMemory& KernelCore::GetFontSharedMem() const {
  761. return *impl->font_shared_mem;
  762. }
  763. Kernel::KSharedMemory& KernelCore::GetIrsSharedMem() {
  764. return *impl->irs_shared_mem;
  765. }
  766. const Kernel::KSharedMemory& KernelCore::GetIrsSharedMem() const {
  767. return *impl->irs_shared_mem;
  768. }
  769. Kernel::KSharedMemory& KernelCore::GetTimeSharedMem() {
  770. return *impl->time_shared_mem;
  771. }
  772. const Kernel::KSharedMemory& KernelCore::GetTimeSharedMem() const {
  773. return *impl->time_shared_mem;
  774. }
  775. void KernelCore::Suspend(bool in_suspention) {
  776. const bool should_suspend = exception_exited || in_suspention;
  777. {
  778. KScopedSchedulerLock lock(*this);
  779. const auto state = should_suspend ? ThreadState::Runnable : ThreadState::Waiting;
  780. for (u32 core_id = 0; core_id < Core::Hardware::NUM_CPU_CORES; core_id++) {
  781. impl->suspend_threads[core_id]->SetState(state);
  782. impl->suspend_threads[core_id]->SetWaitReasonForDebugging(
  783. ThreadWaitReasonForDebugging::Suspended);
  784. }
  785. }
  786. }
  787. bool KernelCore::IsMulticore() const {
  788. return impl->is_multicore;
  789. }
  790. void KernelCore::ExceptionalExit() {
  791. exception_exited = true;
  792. Suspend(true);
  793. }
  794. void KernelCore::EnterSVCProfile() {
  795. std::size_t core = impl->GetCurrentHostThreadID();
  796. impl->svc_ticks[core] = MicroProfileEnter(MICROPROFILE_TOKEN(Kernel_SVC));
  797. }
  798. void KernelCore::ExitSVCProfile() {
  799. std::size_t core = impl->GetCurrentHostThreadID();
  800. MicroProfileLeave(MICROPROFILE_TOKEN(Kernel_SVC), impl->svc_ticks[core]);
  801. }
  802. std::weak_ptr<Kernel::ServiceThread> KernelCore::CreateServiceThread(const std::string& name) {
  803. auto service_thread = std::make_shared<Kernel::ServiceThread>(*this, 1, name);
  804. impl->service_threads.emplace(service_thread);
  805. return service_thread;
  806. }
  807. void KernelCore::ReleaseServiceThread(std::weak_ptr<Kernel::ServiceThread> service_thread) {
  808. if (auto strong_ptr = service_thread.lock()) {
  809. impl->service_threads.erase(strong_ptr);
  810. }
  811. }
  812. Init::KSlabResourceCounts& KernelCore::SlabResourceCounts() {
  813. return impl->slab_resource_counts;
  814. }
  815. const Init::KSlabResourceCounts& KernelCore::SlabResourceCounts() const {
  816. return impl->slab_resource_counts;
  817. }
  818. bool KernelCore::IsPhantomModeForSingleCore() const {
  819. return impl->IsPhantomModeForSingleCore();
  820. }
  821. void KernelCore::SetIsPhantomModeForSingleCore(bool value) {
  822. impl->SetIsPhantomModeForSingleCore(value);
  823. }
  824. Core::System& KernelCore::System() {
  825. return impl->system;
  826. }
  827. const Core::System& KernelCore::System() const {
  828. return impl->system;
  829. }
  830. } // namespace Kernel