svc.cpp 55 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498
  1. // Copyright 2018 yuzu emulator team
  2. // Licensed under GPLv2 or any later version
  3. // Refer to the license.txt file included.
  4. #include <algorithm>
  5. #include <cinttypes>
  6. #include <iterator>
  7. #include <mutex>
  8. #include <vector>
  9. #include "common/alignment.h"
  10. #include "common/assert.h"
  11. #include "common/logging/log.h"
  12. #include "common/microprofile.h"
  13. #include "common/string_util.h"
  14. #include "core/arm/exclusive_monitor.h"
  15. #include "core/core.h"
  16. #include "core/core_cpu.h"
  17. #include "core/core_timing.h"
  18. #include "core/hle/kernel/address_arbiter.h"
  19. #include "core/hle/kernel/client_port.h"
  20. #include "core/hle/kernel/client_session.h"
  21. #include "core/hle/kernel/event.h"
  22. #include "core/hle/kernel/handle_table.h"
  23. #include "core/hle/kernel/kernel.h"
  24. #include "core/hle/kernel/mutex.h"
  25. #include "core/hle/kernel/process.h"
  26. #include "core/hle/kernel/resource_limit.h"
  27. #include "core/hle/kernel/scheduler.h"
  28. #include "core/hle/kernel/shared_memory.h"
  29. #include "core/hle/kernel/svc.h"
  30. #include "core/hle/kernel/svc_wrap.h"
  31. #include "core/hle/kernel/thread.h"
  32. #include "core/hle/lock.h"
  33. #include "core/hle/result.h"
  34. #include "core/hle/service/service.h"
  35. #include "core/settings.h"
  36. namespace Kernel {
  37. namespace {
  38. // Checks if address + size is greater than the given address
  39. // This can return false if the size causes an overflow of a 64-bit type
  40. // or if the given size is zero.
  41. constexpr bool IsValidAddressRange(VAddr address, u64 size) {
  42. return address + size > address;
  43. }
  44. // Checks if a given address range lies within a larger address range.
  45. constexpr bool IsInsideAddressRange(VAddr address, u64 size, VAddr address_range_begin,
  46. VAddr address_range_end) {
  47. const VAddr end_address = address + size - 1;
  48. return address_range_begin <= address && end_address <= address_range_end - 1;
  49. }
  50. bool IsInsideAddressSpace(const VMManager& vm, VAddr address, u64 size) {
  51. return IsInsideAddressRange(address, size, vm.GetAddressSpaceBaseAddress(),
  52. vm.GetAddressSpaceEndAddress());
  53. }
  54. bool IsInsideNewMapRegion(const VMManager& vm, VAddr address, u64 size) {
  55. return IsInsideAddressRange(address, size, vm.GetNewMapRegionBaseAddress(),
  56. vm.GetNewMapRegionEndAddress());
  57. }
  58. // Helper function that performs the common sanity checks for svcMapMemory
  59. // and svcUnmapMemory. This is doable, as both functions perform their sanitizing
  60. // in the same order.
  61. ResultCode MapUnmapMemorySanityChecks(const VMManager& vm_manager, VAddr dst_addr, VAddr src_addr,
  62. u64 size) {
  63. if (!Common::Is4KBAligned(dst_addr) || !Common::Is4KBAligned(src_addr)) {
  64. return ERR_INVALID_ADDRESS;
  65. }
  66. if (size == 0 || !Common::Is4KBAligned(size)) {
  67. return ERR_INVALID_SIZE;
  68. }
  69. if (!IsValidAddressRange(dst_addr, size)) {
  70. return ERR_INVALID_ADDRESS_STATE;
  71. }
  72. if (!IsValidAddressRange(src_addr, size)) {
  73. return ERR_INVALID_ADDRESS_STATE;
  74. }
  75. if (!IsInsideAddressSpace(vm_manager, src_addr, size)) {
  76. return ERR_INVALID_ADDRESS_STATE;
  77. }
  78. if (!IsInsideNewMapRegion(vm_manager, dst_addr, size)) {
  79. return ERR_INVALID_MEMORY_RANGE;
  80. }
  81. const VAddr dst_end_address = dst_addr + size;
  82. if (dst_end_address > vm_manager.GetHeapRegionBaseAddress() &&
  83. vm_manager.GetHeapRegionEndAddress() > dst_addr) {
  84. return ERR_INVALID_MEMORY_RANGE;
  85. }
  86. if (dst_end_address > vm_manager.GetMapRegionBaseAddress() &&
  87. vm_manager.GetMapRegionEndAddress() > dst_addr) {
  88. return ERR_INVALID_MEMORY_RANGE;
  89. }
  90. return RESULT_SUCCESS;
  91. }
  92. } // Anonymous namespace
  93. /// Set the process heap to a given Size. It can both extend and shrink the heap.
  94. static ResultCode SetHeapSize(VAddr* heap_addr, u64 heap_size) {
  95. LOG_TRACE(Kernel_SVC, "called, heap_size=0x{:X}", heap_size);
  96. // Size must be a multiple of 0x200000 (2MB) and be equal to or less than 4GB.
  97. if ((heap_size & 0xFFFFFFFE001FFFFF) != 0) {
  98. return ERR_INVALID_SIZE;
  99. }
  100. auto& process = *Core::CurrentProcess();
  101. const VAddr heap_base = process.VMManager().GetHeapRegionBaseAddress();
  102. CASCADE_RESULT(*heap_addr,
  103. process.HeapAllocate(heap_base, heap_size, VMAPermission::ReadWrite));
  104. return RESULT_SUCCESS;
  105. }
  106. static ResultCode SetMemoryPermission(VAddr addr, u64 size, u32 prot) {
  107. LOG_TRACE(Kernel_SVC, "called, addr=0x{:X}, size=0x{:X}, prot=0x{:X}", addr, size, prot);
  108. if (!Common::Is4KBAligned(addr)) {
  109. return ERR_INVALID_ADDRESS;
  110. }
  111. if (size == 0 || !Common::Is4KBAligned(size)) {
  112. return ERR_INVALID_SIZE;
  113. }
  114. if (!IsValidAddressRange(addr, size)) {
  115. return ERR_INVALID_ADDRESS_STATE;
  116. }
  117. const auto permission = static_cast<MemoryPermission>(prot);
  118. if (permission != MemoryPermission::None && permission != MemoryPermission::Read &&
  119. permission != MemoryPermission::ReadWrite) {
  120. return ERR_INVALID_MEMORY_PERMISSIONS;
  121. }
  122. auto* const current_process = Core::CurrentProcess();
  123. auto& vm_manager = current_process->VMManager();
  124. if (!IsInsideAddressSpace(vm_manager, addr, size)) {
  125. return ERR_INVALID_ADDRESS_STATE;
  126. }
  127. const VMManager::VMAHandle iter = vm_manager.FindVMA(addr);
  128. if (iter == vm_manager.vma_map.end()) {
  129. return ERR_INVALID_ADDRESS_STATE;
  130. }
  131. LOG_WARNING(Kernel_SVC, "Uniformity check on protected memory is not implemented.");
  132. // TODO: Performs a uniformity check to make sure only protected memory is changed (it doesn't
  133. // make sense to allow changing permissions on kernel memory itself, etc).
  134. const auto converted_permissions = SharedMemory::ConvertPermissions(permission);
  135. return vm_manager.ReprotectRange(addr, size, converted_permissions);
  136. }
  137. static ResultCode SetMemoryAttribute(VAddr addr, u64 size, u32 state0, u32 state1) {
  138. LOG_WARNING(Kernel_SVC,
  139. "(STUBBED) called, addr=0x{:X}, size=0x{:X}, state0=0x{:X}, state1=0x{:X}", addr,
  140. size, state0, state1);
  141. return RESULT_SUCCESS;
  142. }
  143. /// Maps a memory range into a different range.
  144. static ResultCode MapMemory(VAddr dst_addr, VAddr src_addr, u64 size) {
  145. LOG_TRACE(Kernel_SVC, "called, dst_addr=0x{:X}, src_addr=0x{:X}, size=0x{:X}", dst_addr,
  146. src_addr, size);
  147. auto* const current_process = Core::CurrentProcess();
  148. const auto& vm_manager = current_process->VMManager();
  149. const auto result = MapUnmapMemorySanityChecks(vm_manager, dst_addr, src_addr, size);
  150. if (result != RESULT_SUCCESS) {
  151. return result;
  152. }
  153. return current_process->MirrorMemory(dst_addr, src_addr, size);
  154. }
  155. /// Unmaps a region that was previously mapped with svcMapMemory
  156. static ResultCode UnmapMemory(VAddr dst_addr, VAddr src_addr, u64 size) {
  157. LOG_TRACE(Kernel_SVC, "called, dst_addr=0x{:X}, src_addr=0x{:X}, size=0x{:X}", dst_addr,
  158. src_addr, size);
  159. auto* const current_process = Core::CurrentProcess();
  160. const auto& vm_manager = current_process->VMManager();
  161. const auto result = MapUnmapMemorySanityChecks(vm_manager, dst_addr, src_addr, size);
  162. if (result != RESULT_SUCCESS) {
  163. return result;
  164. }
  165. return current_process->UnmapMemory(dst_addr, src_addr, size);
  166. }
  167. /// Connect to an OS service given the port name, returns the handle to the port to out
  168. static ResultCode ConnectToNamedPort(Handle* out_handle, VAddr port_name_address) {
  169. if (!Memory::IsValidVirtualAddress(port_name_address)) {
  170. return ERR_NOT_FOUND;
  171. }
  172. static constexpr std::size_t PortNameMaxLength = 11;
  173. // Read 1 char beyond the max allowed port name to detect names that are too long.
  174. std::string port_name = Memory::ReadCString(port_name_address, PortNameMaxLength + 1);
  175. if (port_name.size() > PortNameMaxLength) {
  176. return ERR_OUT_OF_RANGE;
  177. }
  178. LOG_TRACE(Kernel_SVC, "called port_name={}", port_name);
  179. auto& kernel = Core::System::GetInstance().Kernel();
  180. auto it = kernel.FindNamedPort(port_name);
  181. if (!kernel.IsValidNamedPort(it)) {
  182. LOG_WARNING(Kernel_SVC, "tried to connect to unknown port: {}", port_name);
  183. return ERR_NOT_FOUND;
  184. }
  185. auto client_port = it->second;
  186. SharedPtr<ClientSession> client_session;
  187. CASCADE_RESULT(client_session, client_port->Connect());
  188. // Return the client session
  189. auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  190. CASCADE_RESULT(*out_handle, handle_table.Create(client_session));
  191. return RESULT_SUCCESS;
  192. }
  193. /// Makes a blocking IPC call to an OS service.
  194. static ResultCode SendSyncRequest(Handle handle) {
  195. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  196. SharedPtr<ClientSession> session = handle_table.Get<ClientSession>(handle);
  197. if (!session) {
  198. LOG_ERROR(Kernel_SVC, "called with invalid handle=0x{:08X}", handle);
  199. return ERR_INVALID_HANDLE;
  200. }
  201. LOG_TRACE(Kernel_SVC, "called handle=0x{:08X}({})", handle, session->GetName());
  202. Core::System::GetInstance().PrepareReschedule();
  203. // TODO(Subv): svcSendSyncRequest should put the caller thread to sleep while the server
  204. // responds and cause a reschedule.
  205. return session->SendSyncRequest(GetCurrentThread());
  206. }
  207. /// Get the ID for the specified thread.
  208. static ResultCode GetThreadId(u32* thread_id, Handle thread_handle) {
  209. LOG_TRACE(Kernel_SVC, "called thread=0x{:08X}", thread_handle);
  210. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  211. const SharedPtr<Thread> thread = handle_table.Get<Thread>(thread_handle);
  212. if (!thread) {
  213. return ERR_INVALID_HANDLE;
  214. }
  215. *thread_id = thread->GetThreadID();
  216. return RESULT_SUCCESS;
  217. }
  218. /// Get the ID of the specified process
  219. static ResultCode GetProcessId(u32* process_id, Handle process_handle) {
  220. LOG_TRACE(Kernel_SVC, "called process=0x{:08X}", process_handle);
  221. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  222. const SharedPtr<Process> process = handle_table.Get<Process>(process_handle);
  223. if (!process) {
  224. return ERR_INVALID_HANDLE;
  225. }
  226. *process_id = process->GetProcessID();
  227. return RESULT_SUCCESS;
  228. }
  229. /// Default thread wakeup callback for WaitSynchronization
  230. static bool DefaultThreadWakeupCallback(ThreadWakeupReason reason, SharedPtr<Thread> thread,
  231. SharedPtr<WaitObject> object, std::size_t index) {
  232. ASSERT(thread->GetStatus() == ThreadStatus::WaitSynchAny);
  233. if (reason == ThreadWakeupReason::Timeout) {
  234. thread->SetWaitSynchronizationResult(RESULT_TIMEOUT);
  235. return true;
  236. }
  237. ASSERT(reason == ThreadWakeupReason::Signal);
  238. thread->SetWaitSynchronizationResult(RESULT_SUCCESS);
  239. thread->SetWaitSynchronizationOutput(static_cast<u32>(index));
  240. return true;
  241. };
  242. /// Wait for the given handles to synchronize, timeout after the specified nanoseconds
  243. static ResultCode WaitSynchronization(Handle* index, VAddr handles_address, u64 handle_count,
  244. s64 nano_seconds) {
  245. LOG_TRACE(Kernel_SVC, "called handles_address=0x{:X}, handle_count={}, nano_seconds={}",
  246. handles_address, handle_count, nano_seconds);
  247. if (!Memory::IsValidVirtualAddress(handles_address))
  248. return ERR_INVALID_POINTER;
  249. static constexpr u64 MaxHandles = 0x40;
  250. if (handle_count > MaxHandles) {
  251. return ERR_OUT_OF_RANGE;
  252. }
  253. auto* const thread = GetCurrentThread();
  254. using ObjectPtr = Thread::ThreadWaitObjects::value_type;
  255. Thread::ThreadWaitObjects objects(handle_count);
  256. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  257. for (u64 i = 0; i < handle_count; ++i) {
  258. const Handle handle = Memory::Read32(handles_address + i * sizeof(Handle));
  259. const auto object = handle_table.Get<WaitObject>(handle);
  260. if (object == nullptr) {
  261. return ERR_INVALID_HANDLE;
  262. }
  263. objects[i] = object;
  264. }
  265. // Find the first object that is acquirable in the provided list of objects
  266. auto itr = std::find_if(objects.begin(), objects.end(), [thread](const ObjectPtr& object) {
  267. return !object->ShouldWait(thread);
  268. });
  269. if (itr != objects.end()) {
  270. // We found a ready object, acquire it and set the result value
  271. WaitObject* object = itr->get();
  272. object->Acquire(thread);
  273. *index = static_cast<s32>(std::distance(objects.begin(), itr));
  274. return RESULT_SUCCESS;
  275. }
  276. // No objects were ready to be acquired, prepare to suspend the thread.
  277. // If a timeout value of 0 was provided, just return the Timeout error code instead of
  278. // suspending the thread.
  279. if (nano_seconds == 0)
  280. return RESULT_TIMEOUT;
  281. for (auto& object : objects)
  282. object->AddWaitingThread(thread);
  283. thread->SetWaitObjects(std::move(objects));
  284. thread->SetStatus(ThreadStatus::WaitSynchAny);
  285. // Create an event to wake the thread up after the specified nanosecond delay has passed
  286. thread->WakeAfterDelay(nano_seconds);
  287. thread->SetWakeupCallback(DefaultThreadWakeupCallback);
  288. Core::System::GetInstance().CpuCore(thread->GetProcessorID()).PrepareReschedule();
  289. return RESULT_TIMEOUT;
  290. }
  291. /// Resumes a thread waiting on WaitSynchronization
  292. static ResultCode CancelSynchronization(Handle thread_handle) {
  293. LOG_TRACE(Kernel_SVC, "called thread=0x{:X}", thread_handle);
  294. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  295. const SharedPtr<Thread> thread = handle_table.Get<Thread>(thread_handle);
  296. if (!thread) {
  297. return ERR_INVALID_HANDLE;
  298. }
  299. ASSERT(thread->GetStatus() == ThreadStatus::WaitSynchAny);
  300. thread->SetWaitSynchronizationResult(ERR_SYNCHRONIZATION_CANCELED);
  301. thread->ResumeFromWait();
  302. return RESULT_SUCCESS;
  303. }
  304. /// Attempts to locks a mutex, creating it if it does not already exist
  305. static ResultCode ArbitrateLock(Handle holding_thread_handle, VAddr mutex_addr,
  306. Handle requesting_thread_handle) {
  307. LOG_TRACE(Kernel_SVC,
  308. "called holding_thread_handle=0x{:08X}, mutex_addr=0x{:X}, "
  309. "requesting_current_thread_handle=0x{:08X}",
  310. holding_thread_handle, mutex_addr, requesting_thread_handle);
  311. if (Memory::IsKernelVirtualAddress(mutex_addr)) {
  312. return ERR_INVALID_ADDRESS_STATE;
  313. }
  314. if (!Common::IsWordAligned(mutex_addr)) {
  315. return ERR_INVALID_ADDRESS;
  316. }
  317. auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  318. return Mutex::TryAcquire(handle_table, mutex_addr, holding_thread_handle,
  319. requesting_thread_handle);
  320. }
  321. /// Unlock a mutex
  322. static ResultCode ArbitrateUnlock(VAddr mutex_addr) {
  323. LOG_TRACE(Kernel_SVC, "called mutex_addr=0x{:X}", mutex_addr);
  324. if (Memory::IsKernelVirtualAddress(mutex_addr)) {
  325. return ERR_INVALID_ADDRESS_STATE;
  326. }
  327. if (!Common::IsWordAligned(mutex_addr)) {
  328. return ERR_INVALID_ADDRESS;
  329. }
  330. return Mutex::Release(mutex_addr);
  331. }
  332. enum class BreakType : u32 {
  333. Panic = 0,
  334. AssertionFailed = 1,
  335. PreNROLoad = 3,
  336. PostNROLoad = 4,
  337. PreNROUnload = 5,
  338. PostNROUnload = 6,
  339. };
  340. struct BreakReason {
  341. union {
  342. u32 raw;
  343. BitField<0, 30, BreakType> break_type;
  344. BitField<31, 1, u32> signal_debugger;
  345. };
  346. };
  347. /// Break program execution
  348. static void Break(u32 reason, u64 info1, u64 info2) {
  349. BreakReason break_reason{reason};
  350. bool has_dumped_buffer{};
  351. const auto handle_debug_buffer = [&](VAddr addr, u64 sz) {
  352. if (sz == 0 || addr == 0 || has_dumped_buffer) {
  353. return;
  354. }
  355. // This typically is an error code so we're going to assume this is the case
  356. if (sz == sizeof(u32)) {
  357. LOG_CRITICAL(Debug_Emulated, "debug_buffer_err_code={:X}", Memory::Read32(addr));
  358. } else {
  359. // We don't know what's in here so we'll hexdump it
  360. std::vector<u8> debug_buffer(sz);
  361. Memory::ReadBlock(addr, debug_buffer.data(), sz);
  362. std::string hexdump;
  363. for (std::size_t i = 0; i < debug_buffer.size(); i++) {
  364. hexdump += fmt::format("{:02X} ", debug_buffer[i]);
  365. if (i != 0 && i % 16 == 0) {
  366. hexdump += '\n';
  367. }
  368. }
  369. LOG_CRITICAL(Debug_Emulated, "debug_buffer=\n{}", hexdump);
  370. }
  371. has_dumped_buffer = true;
  372. };
  373. switch (break_reason.break_type) {
  374. case BreakType::Panic:
  375. LOG_CRITICAL(Debug_Emulated, "Signalling debugger, PANIC! info1=0x{:016X}, info2=0x{:016X}",
  376. info1, info2);
  377. handle_debug_buffer(info1, info2);
  378. break;
  379. case BreakType::AssertionFailed:
  380. LOG_CRITICAL(Debug_Emulated,
  381. "Signalling debugger, Assertion failed! info1=0x{:016X}, info2=0x{:016X}",
  382. info1, info2);
  383. handle_debug_buffer(info1, info2);
  384. break;
  385. case BreakType::PreNROLoad:
  386. LOG_WARNING(
  387. Debug_Emulated,
  388. "Signalling debugger, Attempting to load an NRO at 0x{:016X} with size 0x{:016X}",
  389. info1, info2);
  390. break;
  391. case BreakType::PostNROLoad:
  392. LOG_WARNING(Debug_Emulated,
  393. "Signalling debugger, Loaded an NRO at 0x{:016X} with size 0x{:016X}", info1,
  394. info2);
  395. break;
  396. case BreakType::PreNROUnload:
  397. LOG_WARNING(
  398. Debug_Emulated,
  399. "Signalling debugger, Attempting to unload an NRO at 0x{:016X} with size 0x{:016X}",
  400. info1, info2);
  401. break;
  402. case BreakType::PostNROUnload:
  403. LOG_WARNING(Debug_Emulated,
  404. "Signalling debugger, Unloaded an NRO at 0x{:016X} with size 0x{:016X}", info1,
  405. info2);
  406. break;
  407. default:
  408. LOG_WARNING(
  409. Debug_Emulated,
  410. "Signalling debugger, Unknown break reason {}, info1=0x{:016X}, info2=0x{:016X}",
  411. static_cast<u32>(break_reason.break_type.Value()), info1, info2);
  412. handle_debug_buffer(info1, info2);
  413. break;
  414. }
  415. if (!break_reason.signal_debugger) {
  416. LOG_CRITICAL(
  417. Debug_Emulated,
  418. "Emulated program broke execution! reason=0x{:016X}, info1=0x{:016X}, info2=0x{:016X}",
  419. reason, info1, info2);
  420. handle_debug_buffer(info1, info2);
  421. ASSERT(false);
  422. Core::CurrentProcess()->PrepareForTermination();
  423. // Kill the current thread
  424. GetCurrentThread()->Stop();
  425. Core::System::GetInstance().PrepareReschedule();
  426. }
  427. }
  428. /// Used to output a message on a debug hardware unit - does nothing on a retail unit
  429. static void OutputDebugString(VAddr address, u64 len) {
  430. if (len == 0) {
  431. return;
  432. }
  433. std::string str(len, '\0');
  434. Memory::ReadBlock(address, str.data(), str.size());
  435. LOG_DEBUG(Debug_Emulated, "{}", str);
  436. }
  437. /// Gets system/memory information for the current process
  438. static ResultCode GetInfo(u64* result, u64 info_id, u64 handle, u64 info_sub_id) {
  439. LOG_TRACE(Kernel_SVC, "called info_id=0x{:X}, info_sub_id=0x{:X}, handle=0x{:08X}", info_id,
  440. info_sub_id, handle);
  441. enum class GetInfoType : u64 {
  442. // 1.0.0+
  443. AllowedCpuIdBitmask = 0,
  444. AllowedThreadPrioBitmask = 1,
  445. MapRegionBaseAddr = 2,
  446. MapRegionSize = 3,
  447. HeapRegionBaseAddr = 4,
  448. HeapRegionSize = 5,
  449. TotalMemoryUsage = 6,
  450. TotalHeapUsage = 7,
  451. IsCurrentProcessBeingDebugged = 8,
  452. ResourceHandleLimit = 9,
  453. IdleTickCount = 10,
  454. RandomEntropy = 11,
  455. PerformanceCounter = 0xF0000002,
  456. // 2.0.0+
  457. ASLRRegionBaseAddr = 12,
  458. ASLRRegionSize = 13,
  459. NewMapRegionBaseAddr = 14,
  460. NewMapRegionSize = 15,
  461. // 3.0.0+
  462. IsVirtualAddressMemoryEnabled = 16,
  463. PersonalMmHeapUsage = 17,
  464. TitleId = 18,
  465. // 4.0.0+
  466. PrivilegedProcessId = 19,
  467. // 5.0.0+
  468. UserExceptionContextAddr = 20,
  469. ThreadTickCount = 0xF0000002,
  470. };
  471. const auto* current_process = Core::CurrentProcess();
  472. const auto& vm_manager = current_process->VMManager();
  473. switch (static_cast<GetInfoType>(info_id)) {
  474. case GetInfoType::AllowedCpuIdBitmask:
  475. *result = current_process->GetAllowedProcessorMask();
  476. break;
  477. case GetInfoType::AllowedThreadPrioBitmask:
  478. *result = current_process->GetAllowedThreadPriorityMask();
  479. break;
  480. case GetInfoType::MapRegionBaseAddr:
  481. *result = vm_manager.GetMapRegionBaseAddress();
  482. break;
  483. case GetInfoType::MapRegionSize:
  484. *result = vm_manager.GetMapRegionSize();
  485. break;
  486. case GetInfoType::HeapRegionBaseAddr:
  487. *result = vm_manager.GetHeapRegionBaseAddress();
  488. break;
  489. case GetInfoType::HeapRegionSize:
  490. *result = vm_manager.GetHeapRegionSize();
  491. break;
  492. case GetInfoType::TotalMemoryUsage:
  493. *result = vm_manager.GetTotalMemoryUsage();
  494. break;
  495. case GetInfoType::TotalHeapUsage:
  496. *result = vm_manager.GetTotalHeapUsage();
  497. break;
  498. case GetInfoType::IsCurrentProcessBeingDebugged:
  499. *result = 0;
  500. break;
  501. case GetInfoType::RandomEntropy:
  502. if (handle != 0) {
  503. return ERR_INVALID_HANDLE;
  504. }
  505. if (info_sub_id >= Process::RANDOM_ENTROPY_SIZE) {
  506. return ERR_INVALID_COMBINATION;
  507. }
  508. *result = current_process->GetRandomEntropy(info_sub_id);
  509. return RESULT_SUCCESS;
  510. break;
  511. case GetInfoType::ASLRRegionBaseAddr:
  512. *result = vm_manager.GetASLRRegionBaseAddress();
  513. break;
  514. case GetInfoType::ASLRRegionSize:
  515. *result = vm_manager.GetASLRRegionSize();
  516. break;
  517. case GetInfoType::NewMapRegionBaseAddr:
  518. *result = vm_manager.GetNewMapRegionBaseAddress();
  519. break;
  520. case GetInfoType::NewMapRegionSize:
  521. *result = vm_manager.GetNewMapRegionSize();
  522. break;
  523. case GetInfoType::IsVirtualAddressMemoryEnabled:
  524. *result = current_process->IsVirtualMemoryEnabled();
  525. break;
  526. case GetInfoType::TitleId:
  527. *result = current_process->GetTitleID();
  528. break;
  529. case GetInfoType::PrivilegedProcessId:
  530. LOG_WARNING(Kernel_SVC,
  531. "(STUBBED) Attempted to query privileged process id bounds, returned 0");
  532. *result = 0;
  533. break;
  534. case GetInfoType::UserExceptionContextAddr:
  535. LOG_WARNING(Kernel_SVC,
  536. "(STUBBED) Attempted to query user exception context address, returned 0");
  537. *result = 0;
  538. break;
  539. case GetInfoType::ThreadTickCount: {
  540. constexpr u64 num_cpus = 4;
  541. if (info_sub_id != 0xFFFFFFFFFFFFFFFF && info_sub_id >= num_cpus) {
  542. return ERR_INVALID_COMBINATION;
  543. }
  544. const auto thread =
  545. current_process->GetHandleTable().Get<Thread>(static_cast<Handle>(handle));
  546. if (!thread) {
  547. return ERR_INVALID_HANDLE;
  548. }
  549. const auto& system = Core::System::GetInstance();
  550. const auto& scheduler = system.CurrentScheduler();
  551. const auto* const current_thread = scheduler.GetCurrentThread();
  552. const bool same_thread = current_thread == thread;
  553. const u64 prev_ctx_ticks = scheduler.GetLastContextSwitchTicks();
  554. u64 out_ticks = 0;
  555. if (same_thread && info_sub_id == 0xFFFFFFFFFFFFFFFF) {
  556. const u64 thread_ticks = current_thread->GetTotalCPUTimeTicks();
  557. out_ticks = thread_ticks + (CoreTiming::GetTicks() - prev_ctx_ticks);
  558. } else if (same_thread && info_sub_id == system.CurrentCoreIndex()) {
  559. out_ticks = CoreTiming::GetTicks() - prev_ctx_ticks;
  560. }
  561. *result = out_ticks;
  562. break;
  563. }
  564. default:
  565. UNIMPLEMENTED();
  566. }
  567. return RESULT_SUCCESS;
  568. }
  569. /// Sets the thread activity
  570. static ResultCode SetThreadActivity(Handle handle, u32 unknown) {
  571. LOG_WARNING(Kernel_SVC, "(STUBBED) called, handle=0x{:08X}, unknown=0x{:08X}", handle, unknown);
  572. return RESULT_SUCCESS;
  573. }
  574. /// Gets the thread context
  575. static ResultCode GetThreadContext(VAddr thread_context, Handle handle) {
  576. LOG_DEBUG(Kernel_SVC, "called, context=0x{:08X}, thread=0x{:X}", thread_context, handle);
  577. const auto* current_process = Core::CurrentProcess();
  578. const SharedPtr<Thread> thread = current_process->GetHandleTable().Get<Thread>(handle);
  579. if (!thread) {
  580. return ERR_INVALID_HANDLE;
  581. }
  582. if (thread->GetOwnerProcess() != current_process) {
  583. return ERR_INVALID_HANDLE;
  584. }
  585. if (thread == GetCurrentThread()) {
  586. return ERR_ALREADY_REGISTERED;
  587. }
  588. Core::ARM_Interface::ThreadContext ctx = thread->GetContext();
  589. // Mask away mode bits, interrupt bits, IL bit, and other reserved bits.
  590. ctx.pstate &= 0xFF0FFE20;
  591. // If 64-bit, we can just write the context registers directly and we're good.
  592. // However, if 32-bit, we have to ensure some registers are zeroed out.
  593. if (!current_process->Is64BitProcess()) {
  594. std::fill(ctx.cpu_registers.begin() + 15, ctx.cpu_registers.end(), 0);
  595. std::fill(ctx.vector_registers.begin() + 16, ctx.vector_registers.end(), u128{});
  596. }
  597. Memory::WriteBlock(thread_context, &ctx, sizeof(ctx));
  598. return RESULT_SUCCESS;
  599. }
  600. /// Gets the priority for the specified thread
  601. static ResultCode GetThreadPriority(u32* priority, Handle handle) {
  602. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  603. const SharedPtr<Thread> thread = handle_table.Get<Thread>(handle);
  604. if (!thread) {
  605. return ERR_INVALID_HANDLE;
  606. }
  607. *priority = thread->GetPriority();
  608. return RESULT_SUCCESS;
  609. }
  610. /// Sets the priority for the specified thread
  611. static ResultCode SetThreadPriority(Handle handle, u32 priority) {
  612. if (priority > THREADPRIO_LOWEST) {
  613. return ERR_INVALID_THREAD_PRIORITY;
  614. }
  615. const auto* const current_process = Core::CurrentProcess();
  616. // Note: The kernel uses the current process's resource limit instead of
  617. // the one from the thread owner's resource limit.
  618. const ResourceLimit& resource_limit = current_process->GetResourceLimit();
  619. if (resource_limit.GetMaxResourceValue(ResourceType::Priority) > priority) {
  620. return ERR_INVALID_THREAD_PRIORITY;
  621. }
  622. SharedPtr<Thread> thread = current_process->GetHandleTable().Get<Thread>(handle);
  623. if (!thread) {
  624. return ERR_INVALID_HANDLE;
  625. }
  626. thread->SetPriority(priority);
  627. Core::System::GetInstance().CpuCore(thread->GetProcessorID()).PrepareReschedule();
  628. return RESULT_SUCCESS;
  629. }
  630. /// Get which CPU core is executing the current thread
  631. static u32 GetCurrentProcessorNumber() {
  632. LOG_TRACE(Kernel_SVC, "called");
  633. return GetCurrentThread()->GetProcessorID();
  634. }
  635. static ResultCode MapSharedMemory(Handle shared_memory_handle, VAddr addr, u64 size,
  636. u32 permissions) {
  637. LOG_TRACE(Kernel_SVC,
  638. "called, shared_memory_handle=0x{:X}, addr=0x{:X}, size=0x{:X}, permissions=0x{:08X}",
  639. shared_memory_handle, addr, size, permissions);
  640. if (!Common::Is4KBAligned(addr)) {
  641. return ERR_INVALID_ADDRESS;
  642. }
  643. if (size == 0 || !Common::Is4KBAligned(size)) {
  644. return ERR_INVALID_SIZE;
  645. }
  646. if (!IsValidAddressRange(addr, size)) {
  647. return ERR_INVALID_ADDRESS_STATE;
  648. }
  649. const auto permissions_type = static_cast<MemoryPermission>(permissions);
  650. if (permissions_type != MemoryPermission::Read &&
  651. permissions_type != MemoryPermission::ReadWrite) {
  652. LOG_ERROR(Kernel_SVC, "Invalid permissions=0x{:08X}", permissions);
  653. return ERR_INVALID_MEMORY_PERMISSIONS;
  654. }
  655. auto* const current_process = Core::CurrentProcess();
  656. auto shared_memory = current_process->GetHandleTable().Get<SharedMemory>(shared_memory_handle);
  657. if (!shared_memory) {
  658. return ERR_INVALID_HANDLE;
  659. }
  660. const auto& vm_manager = current_process->VMManager();
  661. if (!vm_manager.IsWithinASLRRegion(addr, size)) {
  662. return ERR_INVALID_MEMORY_RANGE;
  663. }
  664. return shared_memory->Map(current_process, addr, permissions_type, MemoryPermission::DontCare);
  665. }
  666. static ResultCode UnmapSharedMemory(Handle shared_memory_handle, VAddr addr, u64 size) {
  667. LOG_WARNING(Kernel_SVC, "called, shared_memory_handle=0x{:08X}, addr=0x{:X}, size=0x{:X}",
  668. shared_memory_handle, addr, size);
  669. if (!Common::Is4KBAligned(addr)) {
  670. return ERR_INVALID_ADDRESS;
  671. }
  672. if (size == 0 || !Common::Is4KBAligned(size)) {
  673. return ERR_INVALID_SIZE;
  674. }
  675. if (!IsValidAddressRange(addr, size)) {
  676. return ERR_INVALID_ADDRESS_STATE;
  677. }
  678. auto* const current_process = Core::CurrentProcess();
  679. auto shared_memory = current_process->GetHandleTable().Get<SharedMemory>(shared_memory_handle);
  680. if (!shared_memory) {
  681. return ERR_INVALID_HANDLE;
  682. }
  683. const auto& vm_manager = current_process->VMManager();
  684. if (!vm_manager.IsWithinASLRRegion(addr, size)) {
  685. return ERR_INVALID_MEMORY_RANGE;
  686. }
  687. return shared_memory->Unmap(current_process, addr);
  688. }
  689. /// Query process memory
  690. static ResultCode QueryProcessMemory(MemoryInfo* memory_info, PageInfo* /*page_info*/,
  691. Handle process_handle, u64 addr) {
  692. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  693. SharedPtr<Process> process = handle_table.Get<Process>(process_handle);
  694. if (!process) {
  695. return ERR_INVALID_HANDLE;
  696. }
  697. auto vma = process->VMManager().FindVMA(addr);
  698. memory_info->attributes = 0;
  699. if (vma == process->VMManager().vma_map.end()) {
  700. memory_info->base_address = 0;
  701. memory_info->permission = static_cast<u32>(VMAPermission::None);
  702. memory_info->size = 0;
  703. memory_info->type = static_cast<u32>(MemoryState::Unmapped);
  704. } else {
  705. memory_info->base_address = vma->second.base;
  706. memory_info->permission = static_cast<u32>(vma->second.permissions);
  707. memory_info->size = vma->second.size;
  708. memory_info->type = static_cast<u32>(vma->second.meminfo_state);
  709. }
  710. LOG_TRACE(Kernel_SVC, "called process=0x{:08X} addr={:X}", process_handle, addr);
  711. return RESULT_SUCCESS;
  712. }
  713. /// Query memory
  714. static ResultCode QueryMemory(MemoryInfo* memory_info, PageInfo* page_info, VAddr addr) {
  715. LOG_TRACE(Kernel_SVC, "called, addr={:X}", addr);
  716. return QueryProcessMemory(memory_info, page_info, CurrentProcess, addr);
  717. }
  718. /// Exits the current process
  719. static void ExitProcess() {
  720. auto* current_process = Core::CurrentProcess();
  721. LOG_INFO(Kernel_SVC, "Process {} exiting", current_process->GetProcessID());
  722. ASSERT_MSG(current_process->GetStatus() == ProcessStatus::Running,
  723. "Process has already exited");
  724. current_process->PrepareForTermination();
  725. // Kill the current thread
  726. GetCurrentThread()->Stop();
  727. Core::System::GetInstance().PrepareReschedule();
  728. }
  729. /// Creates a new thread
  730. static ResultCode CreateThread(Handle* out_handle, VAddr entry_point, u64 arg, VAddr stack_top,
  731. u32 priority, s32 processor_id) {
  732. if (priority > THREADPRIO_LOWEST) {
  733. return ERR_INVALID_THREAD_PRIORITY;
  734. }
  735. auto* const current_process = Core::CurrentProcess();
  736. const ResourceLimit& resource_limit = current_process->GetResourceLimit();
  737. if (resource_limit.GetMaxResourceValue(ResourceType::Priority) > priority) {
  738. return ERR_INVALID_THREAD_PRIORITY;
  739. }
  740. if (processor_id == THREADPROCESSORID_DEFAULT) {
  741. // Set the target CPU to the one specified in the process' exheader.
  742. processor_id = current_process->GetDefaultProcessorID();
  743. ASSERT(processor_id != THREADPROCESSORID_DEFAULT);
  744. }
  745. switch (processor_id) {
  746. case THREADPROCESSORID_0:
  747. case THREADPROCESSORID_1:
  748. case THREADPROCESSORID_2:
  749. case THREADPROCESSORID_3:
  750. break;
  751. default:
  752. LOG_ERROR(Kernel_SVC, "Invalid thread processor ID: {}", processor_id);
  753. return ERR_INVALID_PROCESSOR_ID;
  754. }
  755. const std::string name = fmt::format("thread-{:X}", entry_point);
  756. auto& kernel = Core::System::GetInstance().Kernel();
  757. CASCADE_RESULT(SharedPtr<Thread> thread,
  758. Thread::Create(kernel, name, entry_point, priority, arg, processor_id, stack_top,
  759. *current_process));
  760. const auto new_guest_handle = current_process->GetHandleTable().Create(thread);
  761. if (new_guest_handle.Failed()) {
  762. return new_guest_handle.Code();
  763. }
  764. thread->SetGuestHandle(*new_guest_handle);
  765. *out_handle = *new_guest_handle;
  766. Core::System::GetInstance().CpuCore(thread->GetProcessorID()).PrepareReschedule();
  767. LOG_TRACE(Kernel_SVC,
  768. "called entrypoint=0x{:08X} ({}), arg=0x{:08X}, stacktop=0x{:08X}, "
  769. "threadpriority=0x{:08X}, processorid=0x{:08X} : created handle=0x{:08X}",
  770. entry_point, name, arg, stack_top, priority, processor_id, *out_handle);
  771. return RESULT_SUCCESS;
  772. }
  773. /// Starts the thread for the provided handle
  774. static ResultCode StartThread(Handle thread_handle) {
  775. LOG_TRACE(Kernel_SVC, "called thread=0x{:08X}", thread_handle);
  776. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  777. const SharedPtr<Thread> thread = handle_table.Get<Thread>(thread_handle);
  778. if (!thread) {
  779. return ERR_INVALID_HANDLE;
  780. }
  781. ASSERT(thread->GetStatus() == ThreadStatus::Dormant);
  782. thread->ResumeFromWait();
  783. Core::System::GetInstance().CpuCore(thread->GetProcessorID()).PrepareReschedule();
  784. return RESULT_SUCCESS;
  785. }
  786. /// Called when a thread exits
  787. static void ExitThread() {
  788. LOG_TRACE(Kernel_SVC, "called, pc=0x{:08X}", Core::CurrentArmInterface().GetPC());
  789. ExitCurrentThread();
  790. Core::System::GetInstance().PrepareReschedule();
  791. }
  792. /// Sleep the current thread
  793. static void SleepThread(s64 nanoseconds) {
  794. LOG_TRACE(Kernel_SVC, "called nanoseconds={}", nanoseconds);
  795. // Don't attempt to yield execution if there are no available threads to run,
  796. // this way we avoid a useless reschedule to the idle thread.
  797. if (nanoseconds == 0 && !Core::System::GetInstance().CurrentScheduler().HaveReadyThreads())
  798. return;
  799. // Sleep current thread and check for next thread to schedule
  800. WaitCurrentThread_Sleep();
  801. // Create an event to wake the thread up after the specified nanosecond delay has passed
  802. GetCurrentThread()->WakeAfterDelay(nanoseconds);
  803. Core::System::GetInstance().PrepareReschedule();
  804. }
  805. /// Wait process wide key atomic
  806. static ResultCode WaitProcessWideKeyAtomic(VAddr mutex_addr, VAddr condition_variable_addr,
  807. Handle thread_handle, s64 nano_seconds) {
  808. LOG_TRACE(
  809. Kernel_SVC,
  810. "called mutex_addr={:X}, condition_variable_addr={:X}, thread_handle=0x{:08X}, timeout={}",
  811. mutex_addr, condition_variable_addr, thread_handle, nano_seconds);
  812. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  813. SharedPtr<Thread> thread = handle_table.Get<Thread>(thread_handle);
  814. ASSERT(thread);
  815. CASCADE_CODE(Mutex::Release(mutex_addr));
  816. SharedPtr<Thread> current_thread = GetCurrentThread();
  817. current_thread->SetCondVarWaitAddress(condition_variable_addr);
  818. current_thread->SetMutexWaitAddress(mutex_addr);
  819. current_thread->SetWaitHandle(thread_handle);
  820. current_thread->SetStatus(ThreadStatus::WaitMutex);
  821. current_thread->InvalidateWakeupCallback();
  822. current_thread->WakeAfterDelay(nano_seconds);
  823. // Note: Deliberately don't attempt to inherit the lock owner's priority.
  824. Core::System::GetInstance().CpuCore(current_thread->GetProcessorID()).PrepareReschedule();
  825. return RESULT_SUCCESS;
  826. }
  827. /// Signal process wide key
  828. static ResultCode SignalProcessWideKey(VAddr condition_variable_addr, s32 target) {
  829. LOG_TRACE(Kernel_SVC, "called, condition_variable_addr=0x{:X}, target=0x{:08X}",
  830. condition_variable_addr, target);
  831. const auto RetrieveWaitingThreads = [](std::size_t core_index,
  832. std::vector<SharedPtr<Thread>>& waiting_threads,
  833. VAddr condvar_addr) {
  834. const auto& scheduler = Core::System::GetInstance().Scheduler(core_index);
  835. const auto& thread_list = scheduler.GetThreadList();
  836. for (const auto& thread : thread_list) {
  837. if (thread->GetCondVarWaitAddress() == condvar_addr)
  838. waiting_threads.push_back(thread);
  839. }
  840. };
  841. // Retrieve a list of all threads that are waiting for this condition variable.
  842. std::vector<SharedPtr<Thread>> waiting_threads;
  843. RetrieveWaitingThreads(0, waiting_threads, condition_variable_addr);
  844. RetrieveWaitingThreads(1, waiting_threads, condition_variable_addr);
  845. RetrieveWaitingThreads(2, waiting_threads, condition_variable_addr);
  846. RetrieveWaitingThreads(3, waiting_threads, condition_variable_addr);
  847. // Sort them by priority, such that the highest priority ones come first.
  848. std::sort(waiting_threads.begin(), waiting_threads.end(),
  849. [](const SharedPtr<Thread>& lhs, const SharedPtr<Thread>& rhs) {
  850. return lhs->GetPriority() < rhs->GetPriority();
  851. });
  852. // Only process up to 'target' threads, unless 'target' is -1, in which case process
  853. // them all.
  854. std::size_t last = waiting_threads.size();
  855. if (target != -1)
  856. last = target;
  857. // If there are no threads waiting on this condition variable, just exit
  858. if (last > waiting_threads.size())
  859. return RESULT_SUCCESS;
  860. for (std::size_t index = 0; index < last; ++index) {
  861. auto& thread = waiting_threads[index];
  862. ASSERT(thread->GetCondVarWaitAddress() == condition_variable_addr);
  863. std::size_t current_core = Core::System::GetInstance().CurrentCoreIndex();
  864. auto& monitor = Core::System::GetInstance().Monitor();
  865. // Atomically read the value of the mutex.
  866. u32 mutex_val = 0;
  867. do {
  868. monitor.SetExclusive(current_core, thread->GetMutexWaitAddress());
  869. // If the mutex is not yet acquired, acquire it.
  870. mutex_val = Memory::Read32(thread->GetMutexWaitAddress());
  871. if (mutex_val != 0) {
  872. monitor.ClearExclusive();
  873. break;
  874. }
  875. } while (!monitor.ExclusiveWrite32(current_core, thread->GetMutexWaitAddress(),
  876. thread->GetWaitHandle()));
  877. if (mutex_val == 0) {
  878. // We were able to acquire the mutex, resume this thread.
  879. ASSERT(thread->GetStatus() == ThreadStatus::WaitMutex);
  880. thread->ResumeFromWait();
  881. auto* const lock_owner = thread->GetLockOwner();
  882. if (lock_owner != nullptr) {
  883. lock_owner->RemoveMutexWaiter(thread);
  884. }
  885. thread->SetLockOwner(nullptr);
  886. thread->SetMutexWaitAddress(0);
  887. thread->SetCondVarWaitAddress(0);
  888. thread->SetWaitHandle(0);
  889. } else {
  890. // Atomically signal that the mutex now has a waiting thread.
  891. do {
  892. monitor.SetExclusive(current_core, thread->GetMutexWaitAddress());
  893. // Ensure that the mutex value is still what we expect.
  894. u32 value = Memory::Read32(thread->GetMutexWaitAddress());
  895. // TODO(Subv): When this happens, the kernel just clears the exclusive state and
  896. // retries the initial read for this thread.
  897. ASSERT_MSG(mutex_val == value, "Unhandled synchronization primitive case");
  898. } while (!monitor.ExclusiveWrite32(current_core, thread->GetMutexWaitAddress(),
  899. mutex_val | Mutex::MutexHasWaitersFlag));
  900. // The mutex is already owned by some other thread, make this thread wait on it.
  901. const Handle owner_handle = static_cast<Handle>(mutex_val & Mutex::MutexOwnerMask);
  902. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  903. auto owner = handle_table.Get<Thread>(owner_handle);
  904. ASSERT(owner);
  905. ASSERT(thread->GetStatus() == ThreadStatus::WaitMutex);
  906. thread->InvalidateWakeupCallback();
  907. owner->AddMutexWaiter(thread);
  908. Core::System::GetInstance().CpuCore(thread->GetProcessorID()).PrepareReschedule();
  909. }
  910. }
  911. return RESULT_SUCCESS;
  912. }
  913. // Wait for an address (via Address Arbiter)
  914. static ResultCode WaitForAddress(VAddr address, u32 type, s32 value, s64 timeout) {
  915. LOG_WARNING(Kernel_SVC, "called, address=0x{:X}, type=0x{:X}, value=0x{:X}, timeout={}",
  916. address, type, value, timeout);
  917. // If the passed address is a kernel virtual address, return invalid memory state.
  918. if (Memory::IsKernelVirtualAddress(address)) {
  919. return ERR_INVALID_ADDRESS_STATE;
  920. }
  921. // If the address is not properly aligned to 4 bytes, return invalid address.
  922. if (address % sizeof(u32) != 0) {
  923. return ERR_INVALID_ADDRESS;
  924. }
  925. switch (static_cast<AddressArbiter::ArbitrationType>(type)) {
  926. case AddressArbiter::ArbitrationType::WaitIfLessThan:
  927. return AddressArbiter::WaitForAddressIfLessThan(address, value, timeout, false);
  928. case AddressArbiter::ArbitrationType::DecrementAndWaitIfLessThan:
  929. return AddressArbiter::WaitForAddressIfLessThan(address, value, timeout, true);
  930. case AddressArbiter::ArbitrationType::WaitIfEqual:
  931. return AddressArbiter::WaitForAddressIfEqual(address, value, timeout);
  932. default:
  933. return ERR_INVALID_ENUM_VALUE;
  934. }
  935. }
  936. // Signals to an address (via Address Arbiter)
  937. static ResultCode SignalToAddress(VAddr address, u32 type, s32 value, s32 num_to_wake) {
  938. LOG_WARNING(Kernel_SVC, "called, address=0x{:X}, type=0x{:X}, value=0x{:X}, num_to_wake=0x{:X}",
  939. address, type, value, num_to_wake);
  940. // If the passed address is a kernel virtual address, return invalid memory state.
  941. if (Memory::IsKernelVirtualAddress(address)) {
  942. return ERR_INVALID_ADDRESS_STATE;
  943. }
  944. // If the address is not properly aligned to 4 bytes, return invalid address.
  945. if (address % sizeof(u32) != 0) {
  946. return ERR_INVALID_ADDRESS;
  947. }
  948. switch (static_cast<AddressArbiter::SignalType>(type)) {
  949. case AddressArbiter::SignalType::Signal:
  950. return AddressArbiter::SignalToAddress(address, num_to_wake);
  951. case AddressArbiter::SignalType::IncrementAndSignalIfEqual:
  952. return AddressArbiter::IncrementAndSignalToAddressIfEqual(address, value, num_to_wake);
  953. case AddressArbiter::SignalType::ModifyByWaitingCountAndSignalIfEqual:
  954. return AddressArbiter::ModifyByWaitingCountAndSignalToAddressIfEqual(address, value,
  955. num_to_wake);
  956. default:
  957. return ERR_INVALID_ENUM_VALUE;
  958. }
  959. }
  960. /// This returns the total CPU ticks elapsed since the CPU was powered-on
  961. static u64 GetSystemTick() {
  962. const u64 result{CoreTiming::GetTicks()};
  963. // Advance time to defeat dumb games that busy-wait for the frame to end.
  964. CoreTiming::AddTicks(400);
  965. return result;
  966. }
  967. /// Close a handle
  968. static ResultCode CloseHandle(Handle handle) {
  969. LOG_TRACE(Kernel_SVC, "Closing handle 0x{:08X}", handle);
  970. auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  971. return handle_table.Close(handle);
  972. }
  973. /// Reset an event
  974. static ResultCode ResetSignal(Handle handle) {
  975. LOG_WARNING(Kernel_SVC, "(STUBBED) called handle 0x{:08X}", handle);
  976. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  977. auto event = handle_table.Get<Event>(handle);
  978. ASSERT(event != nullptr);
  979. event->Clear();
  980. return RESULT_SUCCESS;
  981. }
  982. /// Creates a TransferMemory object
  983. static ResultCode CreateTransferMemory(Handle* handle, VAddr addr, u64 size, u32 permissions) {
  984. LOG_WARNING(Kernel_SVC, "(STUBBED) called addr=0x{:X}, size=0x{:X}, perms=0x{:08X}", addr, size,
  985. permissions);
  986. *handle = 0;
  987. return RESULT_SUCCESS;
  988. }
  989. static ResultCode GetThreadCoreMask(Handle thread_handle, u32* core, u64* mask) {
  990. LOG_TRACE(Kernel_SVC, "called, handle=0x{:08X}", thread_handle);
  991. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  992. const SharedPtr<Thread> thread = handle_table.Get<Thread>(thread_handle);
  993. if (!thread) {
  994. return ERR_INVALID_HANDLE;
  995. }
  996. *core = thread->GetIdealCore();
  997. *mask = thread->GetAffinityMask();
  998. return RESULT_SUCCESS;
  999. }
  1000. static ResultCode SetThreadCoreMask(Handle thread_handle, u32 core, u64 mask) {
  1001. LOG_DEBUG(Kernel_SVC, "called, handle=0x{:08X}, mask=0x{:16X}, core=0x{:X}", thread_handle,
  1002. mask, core);
  1003. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  1004. const SharedPtr<Thread> thread = handle_table.Get<Thread>(thread_handle);
  1005. if (!thread) {
  1006. return ERR_INVALID_HANDLE;
  1007. }
  1008. if (core == static_cast<u32>(THREADPROCESSORID_DEFAULT)) {
  1009. const u8 default_processor_id = thread->GetOwnerProcess()->GetDefaultProcessorID();
  1010. ASSERT(default_processor_id != static_cast<u8>(THREADPROCESSORID_DEFAULT));
  1011. // Set the target CPU to the one specified in the process' exheader.
  1012. core = default_processor_id;
  1013. mask = 1ULL << core;
  1014. }
  1015. if (mask == 0) {
  1016. return ERR_INVALID_COMBINATION;
  1017. }
  1018. /// This value is used to only change the affinity mask without changing the current ideal core.
  1019. static constexpr u32 OnlyChangeMask = static_cast<u32>(-3);
  1020. if (core == OnlyChangeMask) {
  1021. core = thread->GetIdealCore();
  1022. } else if (core >= Core::NUM_CPU_CORES && core != static_cast<u32>(-1)) {
  1023. return ERR_INVALID_PROCESSOR_ID;
  1024. }
  1025. // Error out if the input core isn't enabled in the input mask.
  1026. if (core < Core::NUM_CPU_CORES && (mask & (1ull << core)) == 0) {
  1027. return ERR_INVALID_COMBINATION;
  1028. }
  1029. thread->ChangeCore(core, mask);
  1030. return RESULT_SUCCESS;
  1031. }
  1032. static ResultCode CreateSharedMemory(Handle* handle, u64 size, u32 local_permissions,
  1033. u32 remote_permissions) {
  1034. LOG_TRACE(Kernel_SVC, "called, size=0x{:X}, localPerms=0x{:08X}, remotePerms=0x{:08X}", size,
  1035. local_permissions, remote_permissions);
  1036. // Size must be a multiple of 4KB and be less than or equal to
  1037. // approx. 8 GB (actually (1GB - 512B) * 8)
  1038. if (size == 0 || (size & 0xFFFFFFFE00000FFF) != 0) {
  1039. return ERR_INVALID_SIZE;
  1040. }
  1041. const auto local_perms = static_cast<MemoryPermission>(local_permissions);
  1042. if (local_perms != MemoryPermission::Read && local_perms != MemoryPermission::ReadWrite) {
  1043. return ERR_INVALID_MEMORY_PERMISSIONS;
  1044. }
  1045. const auto remote_perms = static_cast<MemoryPermission>(remote_permissions);
  1046. if (remote_perms != MemoryPermission::Read && remote_perms != MemoryPermission::ReadWrite &&
  1047. remote_perms != MemoryPermission::DontCare) {
  1048. return ERR_INVALID_MEMORY_PERMISSIONS;
  1049. }
  1050. auto& kernel = Core::System::GetInstance().Kernel();
  1051. auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  1052. auto shared_mem_handle =
  1053. SharedMemory::Create(kernel, handle_table.Get<Process>(KernelHandle::CurrentProcess), size,
  1054. local_perms, remote_perms);
  1055. CASCADE_RESULT(*handle, handle_table.Create(shared_mem_handle));
  1056. return RESULT_SUCCESS;
  1057. }
  1058. static ResultCode ClearEvent(Handle handle) {
  1059. LOG_TRACE(Kernel_SVC, "called, event=0x{:08X}", handle);
  1060. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  1061. SharedPtr<Event> evt = handle_table.Get<Event>(handle);
  1062. if (evt == nullptr) {
  1063. return ERR_INVALID_HANDLE;
  1064. }
  1065. evt->Clear();
  1066. return RESULT_SUCCESS;
  1067. }
  1068. static ResultCode GetProcessInfo(u64* out, Handle process_handle, u32 type) {
  1069. LOG_DEBUG(Kernel_SVC, "called, handle=0x{:08X}, type=0x{:X}", process_handle, type);
  1070. // This function currently only allows retrieving a process' status.
  1071. enum class InfoType {
  1072. Status,
  1073. };
  1074. const auto& handle_table = Core::CurrentProcess()->GetHandleTable();
  1075. const auto process = handle_table.Get<Process>(process_handle);
  1076. if (!process) {
  1077. return ERR_INVALID_HANDLE;
  1078. }
  1079. const auto info_type = static_cast<InfoType>(type);
  1080. if (info_type != InfoType::Status) {
  1081. return ERR_INVALID_ENUM_VALUE;
  1082. }
  1083. *out = static_cast<u64>(process->GetStatus());
  1084. return RESULT_SUCCESS;
  1085. }
  1086. namespace {
  1087. struct FunctionDef {
  1088. using Func = void();
  1089. u32 id;
  1090. Func* func;
  1091. const char* name;
  1092. };
  1093. } // namespace
  1094. static const FunctionDef SVC_Table[] = {
  1095. {0x00, nullptr, "Unknown"},
  1096. {0x01, SvcWrap<SetHeapSize>, "SetHeapSize"},
  1097. {0x02, SvcWrap<SetMemoryPermission>, "SetMemoryPermission"},
  1098. {0x03, SvcWrap<SetMemoryAttribute>, "SetMemoryAttribute"},
  1099. {0x04, SvcWrap<MapMemory>, "MapMemory"},
  1100. {0x05, SvcWrap<UnmapMemory>, "UnmapMemory"},
  1101. {0x06, SvcWrap<QueryMemory>, "QueryMemory"},
  1102. {0x07, SvcWrap<ExitProcess>, "ExitProcess"},
  1103. {0x08, SvcWrap<CreateThread>, "CreateThread"},
  1104. {0x09, SvcWrap<StartThread>, "StartThread"},
  1105. {0x0A, SvcWrap<ExitThread>, "ExitThread"},
  1106. {0x0B, SvcWrap<SleepThread>, "SleepThread"},
  1107. {0x0C, SvcWrap<GetThreadPriority>, "GetThreadPriority"},
  1108. {0x0D, SvcWrap<SetThreadPriority>, "SetThreadPriority"},
  1109. {0x0E, SvcWrap<GetThreadCoreMask>, "GetThreadCoreMask"},
  1110. {0x0F, SvcWrap<SetThreadCoreMask>, "SetThreadCoreMask"},
  1111. {0x10, SvcWrap<GetCurrentProcessorNumber>, "GetCurrentProcessorNumber"},
  1112. {0x11, nullptr, "SignalEvent"},
  1113. {0x12, SvcWrap<ClearEvent>, "ClearEvent"},
  1114. {0x13, SvcWrap<MapSharedMemory>, "MapSharedMemory"},
  1115. {0x14, SvcWrap<UnmapSharedMemory>, "UnmapSharedMemory"},
  1116. {0x15, SvcWrap<CreateTransferMemory>, "CreateTransferMemory"},
  1117. {0x16, SvcWrap<CloseHandle>, "CloseHandle"},
  1118. {0x17, SvcWrap<ResetSignal>, "ResetSignal"},
  1119. {0x18, SvcWrap<WaitSynchronization>, "WaitSynchronization"},
  1120. {0x19, SvcWrap<CancelSynchronization>, "CancelSynchronization"},
  1121. {0x1A, SvcWrap<ArbitrateLock>, "ArbitrateLock"},
  1122. {0x1B, SvcWrap<ArbitrateUnlock>, "ArbitrateUnlock"},
  1123. {0x1C, SvcWrap<WaitProcessWideKeyAtomic>, "WaitProcessWideKeyAtomic"},
  1124. {0x1D, SvcWrap<SignalProcessWideKey>, "SignalProcessWideKey"},
  1125. {0x1E, SvcWrap<GetSystemTick>, "GetSystemTick"},
  1126. {0x1F, SvcWrap<ConnectToNamedPort>, "ConnectToNamedPort"},
  1127. {0x20, nullptr, "SendSyncRequestLight"},
  1128. {0x21, SvcWrap<SendSyncRequest>, "SendSyncRequest"},
  1129. {0x22, nullptr, "SendSyncRequestWithUserBuffer"},
  1130. {0x23, nullptr, "SendAsyncRequestWithUserBuffer"},
  1131. {0x24, SvcWrap<GetProcessId>, "GetProcessId"},
  1132. {0x25, SvcWrap<GetThreadId>, "GetThreadId"},
  1133. {0x26, SvcWrap<Break>, "Break"},
  1134. {0x27, SvcWrap<OutputDebugString>, "OutputDebugString"},
  1135. {0x28, nullptr, "ReturnFromException"},
  1136. {0x29, SvcWrap<GetInfo>, "GetInfo"},
  1137. {0x2A, nullptr, "FlushEntireDataCache"},
  1138. {0x2B, nullptr, "FlushDataCache"},
  1139. {0x2C, nullptr, "MapPhysicalMemory"},
  1140. {0x2D, nullptr, "UnmapPhysicalMemory"},
  1141. {0x2E, nullptr, "GetFutureThreadInfo"},
  1142. {0x2F, nullptr, "GetLastThreadInfo"},
  1143. {0x30, nullptr, "GetResourceLimitLimitValue"},
  1144. {0x31, nullptr, "GetResourceLimitCurrentValue"},
  1145. {0x32, SvcWrap<SetThreadActivity>, "SetThreadActivity"},
  1146. {0x33, SvcWrap<GetThreadContext>, "GetThreadContext"},
  1147. {0x34, SvcWrap<WaitForAddress>, "WaitForAddress"},
  1148. {0x35, SvcWrap<SignalToAddress>, "SignalToAddress"},
  1149. {0x36, nullptr, "Unknown"},
  1150. {0x37, nullptr, "Unknown"},
  1151. {0x38, nullptr, "Unknown"},
  1152. {0x39, nullptr, "Unknown"},
  1153. {0x3A, nullptr, "Unknown"},
  1154. {0x3B, nullptr, "Unknown"},
  1155. {0x3C, nullptr, "DumpInfo"},
  1156. {0x3D, nullptr, "DumpInfoNew"},
  1157. {0x3E, nullptr, "Unknown"},
  1158. {0x3F, nullptr, "Unknown"},
  1159. {0x40, nullptr, "CreateSession"},
  1160. {0x41, nullptr, "AcceptSession"},
  1161. {0x42, nullptr, "ReplyAndReceiveLight"},
  1162. {0x43, nullptr, "ReplyAndReceive"},
  1163. {0x44, nullptr, "ReplyAndReceiveWithUserBuffer"},
  1164. {0x45, nullptr, "CreateEvent"},
  1165. {0x46, nullptr, "Unknown"},
  1166. {0x47, nullptr, "Unknown"},
  1167. {0x48, nullptr, "MapPhysicalMemoryUnsafe"},
  1168. {0x49, nullptr, "UnmapPhysicalMemoryUnsafe"},
  1169. {0x4A, nullptr, "SetUnsafeLimit"},
  1170. {0x4B, nullptr, "CreateCodeMemory"},
  1171. {0x4C, nullptr, "ControlCodeMemory"},
  1172. {0x4D, nullptr, "SleepSystem"},
  1173. {0x4E, nullptr, "ReadWriteRegister"},
  1174. {0x4F, nullptr, "SetProcessActivity"},
  1175. {0x50, SvcWrap<CreateSharedMemory>, "CreateSharedMemory"},
  1176. {0x51, nullptr, "MapTransferMemory"},
  1177. {0x52, nullptr, "UnmapTransferMemory"},
  1178. {0x53, nullptr, "CreateInterruptEvent"},
  1179. {0x54, nullptr, "QueryPhysicalAddress"},
  1180. {0x55, nullptr, "QueryIoMapping"},
  1181. {0x56, nullptr, "CreateDeviceAddressSpace"},
  1182. {0x57, nullptr, "AttachDeviceAddressSpace"},
  1183. {0x58, nullptr, "DetachDeviceAddressSpace"},
  1184. {0x59, nullptr, "MapDeviceAddressSpaceByForce"},
  1185. {0x5A, nullptr, "MapDeviceAddressSpaceAligned"},
  1186. {0x5B, nullptr, "MapDeviceAddressSpace"},
  1187. {0x5C, nullptr, "UnmapDeviceAddressSpace"},
  1188. {0x5D, nullptr, "InvalidateProcessDataCache"},
  1189. {0x5E, nullptr, "StoreProcessDataCache"},
  1190. {0x5F, nullptr, "FlushProcessDataCache"},
  1191. {0x60, nullptr, "DebugActiveProcess"},
  1192. {0x61, nullptr, "BreakDebugProcess"},
  1193. {0x62, nullptr, "TerminateDebugProcess"},
  1194. {0x63, nullptr, "GetDebugEvent"},
  1195. {0x64, nullptr, "ContinueDebugEvent"},
  1196. {0x65, nullptr, "GetProcessList"},
  1197. {0x66, nullptr, "GetThreadList"},
  1198. {0x67, nullptr, "GetDebugThreadContext"},
  1199. {0x68, nullptr, "SetDebugThreadContext"},
  1200. {0x69, nullptr, "QueryDebugProcessMemory"},
  1201. {0x6A, nullptr, "ReadDebugProcessMemory"},
  1202. {0x6B, nullptr, "WriteDebugProcessMemory"},
  1203. {0x6C, nullptr, "SetHardwareBreakPoint"},
  1204. {0x6D, nullptr, "GetDebugThreadParam"},
  1205. {0x6E, nullptr, "Unknown"},
  1206. {0x6F, nullptr, "GetSystemInfo"},
  1207. {0x70, nullptr, "CreatePort"},
  1208. {0x71, nullptr, "ManageNamedPort"},
  1209. {0x72, nullptr, "ConnectToPort"},
  1210. {0x73, nullptr, "SetProcessMemoryPermission"},
  1211. {0x74, nullptr, "MapProcessMemory"},
  1212. {0x75, nullptr, "UnmapProcessMemory"},
  1213. {0x76, nullptr, "QueryProcessMemory"},
  1214. {0x77, nullptr, "MapProcessCodeMemory"},
  1215. {0x78, nullptr, "UnmapProcessCodeMemory"},
  1216. {0x79, nullptr, "CreateProcess"},
  1217. {0x7A, nullptr, "StartProcess"},
  1218. {0x7B, nullptr, "TerminateProcess"},
  1219. {0x7C, SvcWrap<GetProcessInfo>, "GetProcessInfo"},
  1220. {0x7D, nullptr, "CreateResourceLimit"},
  1221. {0x7E, nullptr, "SetResourceLimitLimitValue"},
  1222. {0x7F, nullptr, "CallSecureMonitor"},
  1223. };
  1224. static const FunctionDef* GetSVCInfo(u32 func_num) {
  1225. if (func_num >= std::size(SVC_Table)) {
  1226. LOG_ERROR(Kernel_SVC, "Unknown svc=0x{:02X}", func_num);
  1227. return nullptr;
  1228. }
  1229. return &SVC_Table[func_num];
  1230. }
  1231. MICROPROFILE_DEFINE(Kernel_SVC, "Kernel", "SVC", MP_RGB(70, 200, 70));
  1232. void CallSVC(u32 immediate) {
  1233. MICROPROFILE_SCOPE(Kernel_SVC);
  1234. // Lock the global kernel mutex when we enter the kernel HLE.
  1235. std::lock_guard<std::recursive_mutex> lock(HLE::g_hle_lock);
  1236. const FunctionDef* info = GetSVCInfo(immediate);
  1237. if (info) {
  1238. if (info->func) {
  1239. info->func();
  1240. } else {
  1241. LOG_CRITICAL(Kernel_SVC, "Unimplemented SVC function {}(..)", info->name);
  1242. }
  1243. } else {
  1244. LOG_CRITICAL(Kernel_SVC, "Unknown SVC function 0x{:X}", immediate);
  1245. }
  1246. }
  1247. } // namespace Kernel