kernel.cpp 39 KB

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