KProcess.cs 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077
  1. using ARMeilleure.State;
  2. using Ryujinx.Common;
  3. using Ryujinx.Common.Logging;
  4. using Ryujinx.Cpu;
  5. using Ryujinx.HLE.Exceptions;
  6. using Ryujinx.HLE.HOS.Kernel.Common;
  7. using Ryujinx.HLE.HOS.Kernel.Memory;
  8. using Ryujinx.HLE.HOS.Kernel.Threading;
  9. using Ryujinx.Memory;
  10. using System;
  11. using System.Collections.Generic;
  12. using System.Linq;
  13. using System.Threading;
  14. namespace Ryujinx.HLE.HOS.Kernel.Process
  15. {
  16. class KProcess : KSynchronizationObject
  17. {
  18. public const int KernelVersionMajor = 10;
  19. public const int KernelVersionMinor = 4;
  20. public const int KernelVersionRevision = 0;
  21. public const int KernelVersionPacked =
  22. (KernelVersionMajor << 19) |
  23. (KernelVersionMinor << 15) |
  24. (KernelVersionRevision << 0);
  25. public KMemoryManager MemoryManager { get; private set; }
  26. private SortedDictionary<ulong, KTlsPageInfo> _fullTlsPages;
  27. private SortedDictionary<ulong, KTlsPageInfo> _freeTlsPages;
  28. public int DefaultCpuCore { get; set; }
  29. public bool Debug { get; private set; }
  30. public KResourceLimit ResourceLimit { get; private set; }
  31. public ulong PersonalMmHeapPagesCount { get; private set; }
  32. public ProcessState State { get; private set; }
  33. private object _processLock;
  34. private object _threadingLock;
  35. public KAddressArbiter AddressArbiter { get; private set; }
  36. public long[] RandomEntropy { get; private set; }
  37. private bool _signaled;
  38. public string Name { get; private set; }
  39. private int _threadCount;
  40. public ProcessCreationFlags Flags { get; private set; }
  41. private MemoryRegion _memRegion;
  42. public KProcessCapabilities Capabilities { get; private set; }
  43. public ulong TitleId { get; private set; }
  44. public long Pid { get; private set; }
  45. private long _creationTimestamp;
  46. private ulong _entrypoint;
  47. private ThreadStart _customThreadStart;
  48. private ulong _imageSize;
  49. private ulong _mainThreadStackSize;
  50. private ulong _memoryUsageCapacity;
  51. private int _version;
  52. public KHandleTable HandleTable { get; private set; }
  53. public ulong UserExceptionContextAddress { get; private set; }
  54. private LinkedList<KThread> _threads;
  55. public bool IsPaused { get; private set; }
  56. private IProcessContextFactory _contextFactory;
  57. public IProcessContext Context { get; private set; }
  58. public IVirtualMemoryManager CpuMemory => Context.AddressSpace;
  59. public HleProcessDebugger Debugger { get; private set; }
  60. public KProcess(KernelContext context) : base(context)
  61. {
  62. _processLock = new object();
  63. _threadingLock = new object();
  64. AddressArbiter = new KAddressArbiter(context);
  65. _fullTlsPages = new SortedDictionary<ulong, KTlsPageInfo>();
  66. _freeTlsPages = new SortedDictionary<ulong, KTlsPageInfo>();
  67. Capabilities = new KProcessCapabilities();
  68. RandomEntropy = new long[KScheduler.CpuCoresCount];
  69. // TODO: Remove once we no longer need to initialize it externally.
  70. HandleTable = new KHandleTable(context);
  71. _threads = new LinkedList<KThread>();
  72. Debugger = new HleProcessDebugger(this);
  73. }
  74. public KernelResult InitializeKip(
  75. ProcessCreationInfo creationInfo,
  76. ReadOnlySpan<int> capabilities,
  77. KPageList pageList,
  78. KResourceLimit resourceLimit,
  79. MemoryRegion memRegion,
  80. IProcessContextFactory contextFactory)
  81. {
  82. ResourceLimit = resourceLimit;
  83. _memRegion = memRegion;
  84. _contextFactory = contextFactory ?? new ProcessContextFactory();
  85. AddressSpaceType addrSpaceType = (AddressSpaceType)((int)(creationInfo.Flags & ProcessCreationFlags.AddressSpaceMask) >> (int)ProcessCreationFlags.AddressSpaceShift);
  86. InitializeMemoryManager(creationInfo.Flags);
  87. bool aslrEnabled = creationInfo.Flags.HasFlag(ProcessCreationFlags.EnableAslr);
  88. ulong codeAddress = creationInfo.CodeAddress;
  89. ulong codeSize = (ulong)creationInfo.CodePagesCount * KMemoryManager.PageSize;
  90. KMemoryBlockAllocator memoryBlockAllocator = creationInfo.Flags.HasFlag(ProcessCreationFlags.IsApplication)
  91. ? KernelContext.LargeMemoryBlockAllocator
  92. : KernelContext.SmallMemoryBlockAllocator;
  93. KernelResult result = MemoryManager.InitializeForProcess(
  94. addrSpaceType,
  95. aslrEnabled,
  96. !aslrEnabled,
  97. memRegion,
  98. codeAddress,
  99. codeSize,
  100. memoryBlockAllocator);
  101. if (result != KernelResult.Success)
  102. {
  103. return result;
  104. }
  105. if (!MemoryManager.CanContain(codeAddress, codeSize, MemoryState.CodeStatic))
  106. {
  107. return KernelResult.InvalidMemRange;
  108. }
  109. result = MemoryManager.MapPages(
  110. codeAddress,
  111. pageList,
  112. MemoryState.CodeStatic,
  113. KMemoryPermission.None);
  114. if (result != KernelResult.Success)
  115. {
  116. return result;
  117. }
  118. result = Capabilities.InitializeForKernel(capabilities, MemoryManager);
  119. if (result != KernelResult.Success)
  120. {
  121. return result;
  122. }
  123. Pid = KernelContext.NewKipId();
  124. if (Pid == 0 || (ulong)Pid >= KernelConstants.InitialProcessId)
  125. {
  126. throw new InvalidOperationException($"Invalid KIP Id {Pid}.");
  127. }
  128. result = ParseProcessInfo(creationInfo);
  129. return result;
  130. }
  131. public KernelResult Initialize(
  132. ProcessCreationInfo creationInfo,
  133. ReadOnlySpan<int> capabilities,
  134. KResourceLimit resourceLimit,
  135. MemoryRegion memRegion,
  136. IProcessContextFactory contextFactory,
  137. ThreadStart customThreadStart = null)
  138. {
  139. ResourceLimit = resourceLimit;
  140. _memRegion = memRegion;
  141. _contextFactory = contextFactory ?? new ProcessContextFactory();
  142. ulong personalMmHeapSize = GetPersonalMmHeapSize((ulong)creationInfo.SystemResourcePagesCount, memRegion);
  143. ulong codePagesCount = (ulong)creationInfo.CodePagesCount;
  144. ulong neededSizeForProcess = personalMmHeapSize + codePagesCount * KMemoryManager.PageSize;
  145. if (neededSizeForProcess != 0 && resourceLimit != null)
  146. {
  147. if (!resourceLimit.Reserve(LimitableResource.Memory, neededSizeForProcess))
  148. {
  149. return KernelResult.ResLimitExceeded;
  150. }
  151. }
  152. void CleanUpForError()
  153. {
  154. if (neededSizeForProcess != 0 && resourceLimit != null)
  155. {
  156. resourceLimit.Release(LimitableResource.Memory, neededSizeForProcess);
  157. }
  158. }
  159. PersonalMmHeapPagesCount = (ulong)creationInfo.SystemResourcePagesCount;
  160. KMemoryBlockAllocator memoryBlockAllocator;
  161. if (PersonalMmHeapPagesCount != 0)
  162. {
  163. memoryBlockAllocator = new KMemoryBlockAllocator(PersonalMmHeapPagesCount * KMemoryManager.PageSize);
  164. }
  165. else
  166. {
  167. memoryBlockAllocator = creationInfo.Flags.HasFlag(ProcessCreationFlags.IsApplication)
  168. ? KernelContext.LargeMemoryBlockAllocator
  169. : KernelContext.SmallMemoryBlockAllocator;
  170. }
  171. AddressSpaceType addrSpaceType = (AddressSpaceType)((int)(creationInfo.Flags & ProcessCreationFlags.AddressSpaceMask) >> (int)ProcessCreationFlags.AddressSpaceShift);
  172. InitializeMemoryManager(creationInfo.Flags);
  173. bool aslrEnabled = creationInfo.Flags.HasFlag(ProcessCreationFlags.EnableAslr);
  174. ulong codeAddress = creationInfo.CodeAddress;
  175. ulong codeSize = codePagesCount * KMemoryManager.PageSize;
  176. KernelResult result = MemoryManager.InitializeForProcess(
  177. addrSpaceType,
  178. aslrEnabled,
  179. !aslrEnabled,
  180. memRegion,
  181. codeAddress,
  182. codeSize,
  183. memoryBlockAllocator);
  184. if (result != KernelResult.Success)
  185. {
  186. CleanUpForError();
  187. return result;
  188. }
  189. if (!MemoryManager.CanContain(codeAddress, codeSize, MemoryState.CodeStatic))
  190. {
  191. CleanUpForError();
  192. return KernelResult.InvalidMemRange;
  193. }
  194. result = MemoryManager.MapNewProcessCode(
  195. codeAddress,
  196. codePagesCount,
  197. MemoryState.CodeStatic,
  198. KMemoryPermission.None);
  199. if (result != KernelResult.Success)
  200. {
  201. CleanUpForError();
  202. return result;
  203. }
  204. result = Capabilities.InitializeForUser(capabilities, MemoryManager);
  205. if (result != KernelResult.Success)
  206. {
  207. CleanUpForError();
  208. return result;
  209. }
  210. Pid = KernelContext.NewProcessId();
  211. if (Pid == -1 || (ulong)Pid < KernelConstants.InitialProcessId)
  212. {
  213. throw new InvalidOperationException($"Invalid Process Id {Pid}.");
  214. }
  215. result = ParseProcessInfo(creationInfo);
  216. if (result != KernelResult.Success)
  217. {
  218. CleanUpForError();
  219. }
  220. _customThreadStart = customThreadStart;
  221. return result;
  222. }
  223. private KernelResult ParseProcessInfo(ProcessCreationInfo creationInfo)
  224. {
  225. // Ensure that the current kernel version is equal or above to the minimum required.
  226. uint requiredKernelVersionMajor = (uint)Capabilities.KernelReleaseVersion >> 19;
  227. uint requiredKernelVersionMinor = ((uint)Capabilities.KernelReleaseVersion >> 15) & 0xf;
  228. if (KernelContext.EnableVersionChecks)
  229. {
  230. if (requiredKernelVersionMajor > KernelVersionMajor)
  231. {
  232. return KernelResult.InvalidCombination;
  233. }
  234. if (requiredKernelVersionMajor != KernelVersionMajor && requiredKernelVersionMajor < 3)
  235. {
  236. return KernelResult.InvalidCombination;
  237. }
  238. if (requiredKernelVersionMinor > KernelVersionMinor)
  239. {
  240. return KernelResult.InvalidCombination;
  241. }
  242. }
  243. KernelResult result = AllocateThreadLocalStorage(out ulong userExceptionContextAddress);
  244. if (result != KernelResult.Success)
  245. {
  246. return result;
  247. }
  248. UserExceptionContextAddress = userExceptionContextAddress;
  249. MemoryHelper.FillWithZeros(CpuMemory, (long)userExceptionContextAddress, KTlsPageInfo.TlsEntrySize);
  250. Name = creationInfo.Name;
  251. State = ProcessState.Created;
  252. _creationTimestamp = PerformanceCounter.ElapsedMilliseconds;
  253. Flags = creationInfo.Flags;
  254. _version = creationInfo.Version;
  255. TitleId = creationInfo.TitleId;
  256. _entrypoint = creationInfo.CodeAddress;
  257. _imageSize = (ulong)creationInfo.CodePagesCount * KMemoryManager.PageSize;
  258. switch (Flags & ProcessCreationFlags.AddressSpaceMask)
  259. {
  260. case ProcessCreationFlags.AddressSpace32Bit:
  261. case ProcessCreationFlags.AddressSpace64BitDeprecated:
  262. case ProcessCreationFlags.AddressSpace64Bit:
  263. _memoryUsageCapacity = MemoryManager.HeapRegionEnd -
  264. MemoryManager.HeapRegionStart;
  265. break;
  266. case ProcessCreationFlags.AddressSpace32BitWithoutAlias:
  267. _memoryUsageCapacity = MemoryManager.HeapRegionEnd -
  268. MemoryManager.HeapRegionStart +
  269. MemoryManager.AliasRegionEnd -
  270. MemoryManager.AliasRegionStart;
  271. break;
  272. default: throw new InvalidOperationException($"Invalid MMU flags value 0x{Flags:x2}.");
  273. }
  274. GenerateRandomEntropy();
  275. return KernelResult.Success;
  276. }
  277. public KernelResult AllocateThreadLocalStorage(out ulong address)
  278. {
  279. KernelContext.CriticalSection.Enter();
  280. KernelResult result;
  281. if (_freeTlsPages.Count > 0)
  282. {
  283. // If we have free TLS pages available, just use the first one.
  284. KTlsPageInfo pageInfo = _freeTlsPages.Values.First();
  285. if (!pageInfo.TryGetFreePage(out address))
  286. {
  287. throw new InvalidOperationException("Unexpected failure getting free TLS page!");
  288. }
  289. if (pageInfo.IsFull())
  290. {
  291. _freeTlsPages.Remove(pageInfo.PageAddr);
  292. _fullTlsPages.Add(pageInfo.PageAddr, pageInfo);
  293. }
  294. result = KernelResult.Success;
  295. }
  296. else
  297. {
  298. // Otherwise, we need to create a new one.
  299. result = AllocateTlsPage(out KTlsPageInfo pageInfo);
  300. if (result == KernelResult.Success)
  301. {
  302. if (!pageInfo.TryGetFreePage(out address))
  303. {
  304. throw new InvalidOperationException("Unexpected failure getting free TLS page!");
  305. }
  306. _freeTlsPages.Add(pageInfo.PageAddr, pageInfo);
  307. }
  308. else
  309. {
  310. address = 0;
  311. }
  312. }
  313. KernelContext.CriticalSection.Leave();
  314. return result;
  315. }
  316. private KernelResult AllocateTlsPage(out KTlsPageInfo pageInfo)
  317. {
  318. pageInfo = default;
  319. if (!KernelContext.UserSlabHeapPages.TryGetItem(out ulong tlsPagePa))
  320. {
  321. return KernelResult.OutOfMemory;
  322. }
  323. ulong regionStart = MemoryManager.TlsIoRegionStart;
  324. ulong regionSize = MemoryManager.TlsIoRegionEnd - regionStart;
  325. ulong regionPagesCount = regionSize / KMemoryManager.PageSize;
  326. KernelResult result = MemoryManager.AllocateOrMapPa(
  327. 1,
  328. KMemoryManager.PageSize,
  329. tlsPagePa,
  330. true,
  331. regionStart,
  332. regionPagesCount,
  333. MemoryState.ThreadLocal,
  334. KMemoryPermission.ReadAndWrite,
  335. out ulong tlsPageVa);
  336. if (result != KernelResult.Success)
  337. {
  338. KernelContext.UserSlabHeapPages.Free(tlsPagePa);
  339. }
  340. else
  341. {
  342. pageInfo = new KTlsPageInfo(tlsPageVa);
  343. MemoryHelper.FillWithZeros(CpuMemory, (long)tlsPageVa, KMemoryManager.PageSize);
  344. }
  345. return result;
  346. }
  347. public KernelResult FreeThreadLocalStorage(ulong tlsSlotAddr)
  348. {
  349. ulong tlsPageAddr = BitUtils.AlignDown(tlsSlotAddr, KMemoryManager.PageSize);
  350. KernelContext.CriticalSection.Enter();
  351. KernelResult result = KernelResult.Success;
  352. KTlsPageInfo pageInfo;
  353. if (_fullTlsPages.TryGetValue(tlsPageAddr, out pageInfo))
  354. {
  355. // TLS page was full, free slot and move to free pages tree.
  356. _fullTlsPages.Remove(tlsPageAddr);
  357. _freeTlsPages.Add(tlsPageAddr, pageInfo);
  358. }
  359. else if (!_freeTlsPages.TryGetValue(tlsPageAddr, out pageInfo))
  360. {
  361. result = KernelResult.InvalidAddress;
  362. }
  363. if (pageInfo != null)
  364. {
  365. pageInfo.FreeTlsSlot(tlsSlotAddr);
  366. if (pageInfo.IsEmpty())
  367. {
  368. // TLS page is now empty, we should ensure it is removed
  369. // from all trees, and free the memory it was using.
  370. _freeTlsPages.Remove(tlsPageAddr);
  371. KernelContext.CriticalSection.Leave();
  372. FreeTlsPage(pageInfo);
  373. return KernelResult.Success;
  374. }
  375. }
  376. KernelContext.CriticalSection.Leave();
  377. return result;
  378. }
  379. private KernelResult FreeTlsPage(KTlsPageInfo pageInfo)
  380. {
  381. if (!MemoryManager.TryConvertVaToPa(pageInfo.PageAddr, out ulong tlsPagePa))
  382. {
  383. throw new InvalidOperationException("Unexpected failure translating virtual address to physical.");
  384. }
  385. KernelResult result = MemoryManager.UnmapForKernel(pageInfo.PageAddr, 1, MemoryState.ThreadLocal);
  386. if (result == KernelResult.Success)
  387. {
  388. KernelContext.UserSlabHeapPages.Free(tlsPagePa);
  389. }
  390. return result;
  391. }
  392. private void GenerateRandomEntropy()
  393. {
  394. // TODO.
  395. }
  396. public KernelResult Start(int mainThreadPriority, ulong stackSize)
  397. {
  398. lock (_processLock)
  399. {
  400. if (State > ProcessState.CreatedAttached)
  401. {
  402. return KernelResult.InvalidState;
  403. }
  404. if (ResourceLimit != null && !ResourceLimit.Reserve(LimitableResource.Thread, 1))
  405. {
  406. return KernelResult.ResLimitExceeded;
  407. }
  408. KResourceLimit threadResourceLimit = ResourceLimit;
  409. KResourceLimit memoryResourceLimit = null;
  410. if (_mainThreadStackSize != 0)
  411. {
  412. throw new InvalidOperationException("Trying to start a process with a invalid state!");
  413. }
  414. ulong stackSizeRounded = BitUtils.AlignUp(stackSize, KMemoryManager.PageSize);
  415. ulong neededSize = stackSizeRounded + _imageSize;
  416. // Check if the needed size for the code and the stack will fit on the
  417. // memory usage capacity of this Process. Also check for possible overflow
  418. // on the above addition.
  419. if (neededSize > _memoryUsageCapacity || neededSize < stackSizeRounded)
  420. {
  421. threadResourceLimit?.Release(LimitableResource.Thread, 1);
  422. return KernelResult.OutOfMemory;
  423. }
  424. if (stackSizeRounded != 0 && ResourceLimit != null)
  425. {
  426. memoryResourceLimit = ResourceLimit;
  427. if (!memoryResourceLimit.Reserve(LimitableResource.Memory, stackSizeRounded))
  428. {
  429. threadResourceLimit?.Release(LimitableResource.Thread, 1);
  430. return KernelResult.ResLimitExceeded;
  431. }
  432. }
  433. KernelResult result;
  434. KThread mainThread = null;
  435. ulong stackTop = 0;
  436. void CleanUpForError()
  437. {
  438. HandleTable.Destroy();
  439. mainThread?.DecrementReferenceCount();
  440. if (_mainThreadStackSize != 0)
  441. {
  442. ulong stackBottom = stackTop - _mainThreadStackSize;
  443. ulong stackPagesCount = _mainThreadStackSize / KMemoryManager.PageSize;
  444. MemoryManager.UnmapForKernel(stackBottom, stackPagesCount, MemoryState.Stack);
  445. _mainThreadStackSize = 0;
  446. }
  447. memoryResourceLimit?.Release(LimitableResource.Memory, stackSizeRounded);
  448. threadResourceLimit?.Release(LimitableResource.Thread, 1);
  449. }
  450. if (stackSizeRounded != 0)
  451. {
  452. ulong stackPagesCount = stackSizeRounded / KMemoryManager.PageSize;
  453. ulong regionStart = MemoryManager.StackRegionStart;
  454. ulong regionSize = MemoryManager.StackRegionEnd - regionStart;
  455. ulong regionPagesCount = regionSize / KMemoryManager.PageSize;
  456. result = MemoryManager.AllocateOrMapPa(
  457. stackPagesCount,
  458. KMemoryManager.PageSize,
  459. 0,
  460. false,
  461. regionStart,
  462. regionPagesCount,
  463. MemoryState.Stack,
  464. KMemoryPermission.ReadAndWrite,
  465. out ulong stackBottom);
  466. if (result != KernelResult.Success)
  467. {
  468. CleanUpForError();
  469. return result;
  470. }
  471. _mainThreadStackSize += stackSizeRounded;
  472. stackTop = stackBottom + stackSizeRounded;
  473. }
  474. ulong heapCapacity = _memoryUsageCapacity - _mainThreadStackSize - _imageSize;
  475. result = MemoryManager.SetHeapCapacity(heapCapacity);
  476. if (result != KernelResult.Success)
  477. {
  478. CleanUpForError();
  479. return result;
  480. }
  481. HandleTable = new KHandleTable(KernelContext);
  482. result = HandleTable.Initialize(Capabilities.HandleTableSize);
  483. if (result != KernelResult.Success)
  484. {
  485. CleanUpForError();
  486. return result;
  487. }
  488. mainThread = new KThread(KernelContext);
  489. result = mainThread.Initialize(
  490. _entrypoint,
  491. 0,
  492. stackTop,
  493. mainThreadPriority,
  494. DefaultCpuCore,
  495. this,
  496. ThreadType.User,
  497. _customThreadStart);
  498. if (result != KernelResult.Success)
  499. {
  500. CleanUpForError();
  501. return result;
  502. }
  503. result = HandleTable.GenerateHandle(mainThread, out int mainThreadHandle);
  504. if (result != KernelResult.Success)
  505. {
  506. CleanUpForError();
  507. return result;
  508. }
  509. mainThread.SetEntryArguments(0, mainThreadHandle);
  510. ProcessState oldState = State;
  511. ProcessState newState = State != ProcessState.Created
  512. ? ProcessState.Attached
  513. : ProcessState.Started;
  514. SetState(newState);
  515. result = mainThread.Start();
  516. if (result != KernelResult.Success)
  517. {
  518. SetState(oldState);
  519. CleanUpForError();
  520. }
  521. if (result == KernelResult.Success)
  522. {
  523. mainThread.IncrementReferenceCount();
  524. }
  525. mainThread.DecrementReferenceCount();
  526. return result;
  527. }
  528. }
  529. private void SetState(ProcessState newState)
  530. {
  531. if (State != newState)
  532. {
  533. State = newState;
  534. _signaled = true;
  535. Signal();
  536. }
  537. }
  538. public KernelResult InitializeThread(
  539. KThread thread,
  540. ulong entrypoint,
  541. ulong argsPtr,
  542. ulong stackTop,
  543. int priority,
  544. int cpuCore)
  545. {
  546. lock (_processLock)
  547. {
  548. return thread.Initialize(entrypoint, argsPtr, stackTop, priority, cpuCore, this, ThreadType.User, null);
  549. }
  550. }
  551. public void SubscribeThreadEventHandlers(ARMeilleure.State.ExecutionContext context)
  552. {
  553. context.Interrupt += InterruptHandler;
  554. context.SupervisorCall += KernelContext.SyscallHandler.SvcCall;
  555. context.Undefined += UndefinedInstructionHandler;
  556. }
  557. private void InterruptHandler(object sender, EventArgs e)
  558. {
  559. KernelContext.Scheduler.ContextSwitch();
  560. KernelContext.Scheduler.GetCurrentThread().HandlePostSyscall();
  561. }
  562. public void IncrementThreadCount()
  563. {
  564. Interlocked.Increment(ref _threadCount);
  565. }
  566. public void DecrementThreadCountAndTerminateIfZero()
  567. {
  568. if (Interlocked.Decrement(ref _threadCount) == 0)
  569. {
  570. Terminate();
  571. }
  572. }
  573. public void DecrementToZeroWhileTerminatingCurrent()
  574. {
  575. while (Interlocked.Decrement(ref _threadCount) != 0)
  576. {
  577. Destroy();
  578. TerminateCurrentProcess();
  579. }
  580. // Nintendo panic here because if it reaches this point, the current thread should be already dead.
  581. // As we handle the death of the thread in the post SVC handler and inside the CPU emulator, we don't panic here.
  582. }
  583. public ulong GetMemoryCapacity()
  584. {
  585. ulong totalCapacity = (ulong)ResourceLimit.GetRemainingValue(LimitableResource.Memory);
  586. totalCapacity += MemoryManager.GetTotalHeapSize();
  587. totalCapacity += GetPersonalMmHeapSize();
  588. totalCapacity += _imageSize + _mainThreadStackSize;
  589. if (totalCapacity <= _memoryUsageCapacity)
  590. {
  591. return totalCapacity;
  592. }
  593. return _memoryUsageCapacity;
  594. }
  595. public ulong GetMemoryUsage()
  596. {
  597. return _imageSize + _mainThreadStackSize + MemoryManager.GetTotalHeapSize() + GetPersonalMmHeapSize();
  598. }
  599. public ulong GetMemoryCapacityWithoutPersonalMmHeap()
  600. {
  601. return GetMemoryCapacity() - GetPersonalMmHeapSize();
  602. }
  603. public ulong GetMemoryUsageWithoutPersonalMmHeap()
  604. {
  605. return GetMemoryUsage() - GetPersonalMmHeapSize();
  606. }
  607. private ulong GetPersonalMmHeapSize()
  608. {
  609. return GetPersonalMmHeapSize(PersonalMmHeapPagesCount, _memRegion);
  610. }
  611. private static ulong GetPersonalMmHeapSize(ulong personalMmHeapPagesCount, MemoryRegion memRegion)
  612. {
  613. if (memRegion == MemoryRegion.Applet)
  614. {
  615. return 0;
  616. }
  617. return personalMmHeapPagesCount * KMemoryManager.PageSize;
  618. }
  619. public void AddThread(KThread thread)
  620. {
  621. lock (_threadingLock)
  622. {
  623. thread.ProcessListNode = _threads.AddLast(thread);
  624. }
  625. }
  626. public void RemoveThread(KThread thread)
  627. {
  628. lock (_threadingLock)
  629. {
  630. _threads.Remove(thread.ProcessListNode);
  631. }
  632. }
  633. public bool IsCpuCoreAllowed(int core)
  634. {
  635. return (Capabilities.AllowedCpuCoresMask & (1L << core)) != 0;
  636. }
  637. public bool IsPriorityAllowed(int priority)
  638. {
  639. return (Capabilities.AllowedThreadPriosMask & (1L << priority)) != 0;
  640. }
  641. public override bool IsSignaled()
  642. {
  643. return _signaled;
  644. }
  645. public KernelResult Terminate()
  646. {
  647. KernelResult result;
  648. bool shallTerminate = false;
  649. KernelContext.CriticalSection.Enter();
  650. lock (_processLock)
  651. {
  652. if (State >= ProcessState.Started)
  653. {
  654. if (State == ProcessState.Started ||
  655. State == ProcessState.Crashed ||
  656. State == ProcessState.Attached ||
  657. State == ProcessState.DebugSuspended)
  658. {
  659. SetState(ProcessState.Exiting);
  660. shallTerminate = true;
  661. }
  662. result = KernelResult.Success;
  663. }
  664. else
  665. {
  666. result = KernelResult.InvalidState;
  667. }
  668. }
  669. KernelContext.CriticalSection.Leave();
  670. if (shallTerminate)
  671. {
  672. UnpauseAndTerminateAllThreadsExcept(KernelContext.Scheduler.GetCurrentThread());
  673. HandleTable.Destroy();
  674. SignalExitToDebugTerminated();
  675. SignalExit();
  676. }
  677. return result;
  678. }
  679. public void TerminateCurrentProcess()
  680. {
  681. bool shallTerminate = false;
  682. KernelContext.CriticalSection.Enter();
  683. lock (_processLock)
  684. {
  685. if (State >= ProcessState.Started)
  686. {
  687. if (State == ProcessState.Started ||
  688. State == ProcessState.Attached ||
  689. State == ProcessState.DebugSuspended)
  690. {
  691. SetState(ProcessState.Exiting);
  692. shallTerminate = true;
  693. }
  694. }
  695. }
  696. KernelContext.CriticalSection.Leave();
  697. if (shallTerminate)
  698. {
  699. UnpauseAndTerminateAllThreadsExcept(KernelContext.Scheduler.GetCurrentThread());
  700. HandleTable.Destroy();
  701. // NOTE: this is supposed to be called in receiving of the mailbox.
  702. SignalExitToDebugExited();
  703. SignalExit();
  704. }
  705. }
  706. private void UnpauseAndTerminateAllThreadsExcept(KThread currentThread)
  707. {
  708. lock (_threadingLock)
  709. {
  710. KernelContext.CriticalSection.Enter();
  711. foreach (KThread thread in _threads)
  712. {
  713. if ((thread.SchedFlags & ThreadSchedState.LowMask) != ThreadSchedState.TerminationPending)
  714. {
  715. thread.PrepareForTermination();
  716. }
  717. }
  718. KernelContext.CriticalSection.Leave();
  719. }
  720. while (true)
  721. {
  722. KThread blockedThread = null;
  723. lock (_threadingLock)
  724. {
  725. foreach (KThread thread in _threads)
  726. {
  727. if (thread != currentThread && (thread.SchedFlags & ThreadSchedState.LowMask) != ThreadSchedState.TerminationPending)
  728. {
  729. thread.IncrementReferenceCount();
  730. blockedThread = thread;
  731. break;
  732. }
  733. }
  734. }
  735. if (blockedThread == null)
  736. {
  737. break;
  738. }
  739. blockedThread.Terminate();
  740. blockedThread.DecrementReferenceCount();
  741. }
  742. }
  743. private void SignalExitToDebugTerminated()
  744. {
  745. // TODO: Debug events.
  746. }
  747. private void SignalExitToDebugExited()
  748. {
  749. // TODO: Debug events.
  750. }
  751. private void SignalExit()
  752. {
  753. if (ResourceLimit != null)
  754. {
  755. ResourceLimit.Release(LimitableResource.Memory, GetMemoryUsage());
  756. }
  757. KernelContext.CriticalSection.Enter();
  758. SetState(ProcessState.Exited);
  759. KernelContext.CriticalSection.Leave();
  760. }
  761. public KernelResult ClearIfNotExited()
  762. {
  763. KernelResult result;
  764. KernelContext.CriticalSection.Enter();
  765. lock (_processLock)
  766. {
  767. if (State != ProcessState.Exited && _signaled)
  768. {
  769. _signaled = false;
  770. result = KernelResult.Success;
  771. }
  772. else
  773. {
  774. result = KernelResult.InvalidState;
  775. }
  776. }
  777. KernelContext.CriticalSection.Leave();
  778. return result;
  779. }
  780. private void InitializeMemoryManager(ProcessCreationFlags flags)
  781. {
  782. int addrSpaceBits = (flags & ProcessCreationFlags.AddressSpaceMask) switch
  783. {
  784. ProcessCreationFlags.AddressSpace32Bit => 32,
  785. ProcessCreationFlags.AddressSpace64BitDeprecated => 36,
  786. ProcessCreationFlags.AddressSpace32BitWithoutAlias => 32,
  787. ProcessCreationFlags.AddressSpace64Bit => 39,
  788. _ => 39
  789. };
  790. Context = _contextFactory.Create(KernelContext.Memory, 1UL << addrSpaceBits, InvalidAccessHandler);
  791. // TODO: This should eventually be removed.
  792. // The GPU shouldn't depend on the CPU memory manager at all.
  793. if (flags.HasFlag(ProcessCreationFlags.IsApplication))
  794. {
  795. KernelContext.Device.Gpu.SetVmm((MemoryManager)CpuMemory);
  796. }
  797. MemoryManager = new KMemoryManager(KernelContext, CpuMemory);
  798. }
  799. private bool InvalidAccessHandler(ulong va)
  800. {
  801. KernelContext.Scheduler.GetCurrentThreadOrNull()?.PrintGuestStackTrace();
  802. Logger.Error?.Print(LogClass.Cpu, $"Invalid memory access at virtual address 0x{va:X16}.");
  803. return false;
  804. }
  805. private void UndefinedInstructionHandler(object sender, InstUndefinedEventArgs e)
  806. {
  807. KernelContext.Scheduler.GetCurrentThreadOrNull()?.PrintGuestStackTrace();
  808. throw new UndefinedInstructionException(e.Address, e.OpCode);
  809. }
  810. protected override void Destroy() => Context.Dispose();
  811. }
  812. }