Nintendo Switch Brew

Process Manager services: Difference between revisions

← Older edit
 
(29 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= LaunchFlags =
On [[5.0.0]]+, the LaunchFlag enum looks like this:
{| class=wikitable
! Bit || Mask || Name
|-
| 0 || 1 || LaunchFlags_SignalOnExit
|-
| 1 || 2 || LaunchFlags_SignalOnStart
|-
| 2 || 4 || LaunchFlags_SignalOnCrash
|-
| 3 || 8 || LaunchFlags_SignalOnDebug
|-
| 4 || 0x10 || LaunchFlags_StartSuspended
|-
| 5 || 0x20 || LaunchFlags_DisableAslr
|}
Prior to system version [[5.0.0]], the LaunchFlag enum had its entries in a different order:
{| class=wikitable
! Bit || Mask || Name
|-
| 0 || 1 || LaunchFlags_SignalOnExit
|-
| 1 || 2 || LaunchFlags_StartSuspended
|-
| 2 || 4 || LaunchFlags_SignalOnCrash
|-
| 3 || 8 || LaunchFlags_DisableAslr
|-
| 4 || 0x10 || LaunchFlags_SignalOnDebug
|-
| 5 || 0x20 || [2.0.0+] LaunchFlags_SignalOnStart
|}
= ProcessEventInfo =
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ProcessEvent
|-
| 0x4
| 0x4
| Padding/Reserved
|-
| 0x8
| 0x8
| ProcessId
|-
|}
= Process Tracker thread =
= Process Tracker thread =
PM has a separate thread that is waiting for synchronization on process handles.
PM has a separate thread that is waiting for synchronization on process handles.
Line 5: Line 64:
When the kernel signals a process handle, it uses svcResetSignal on the process handle and then it uses svcGetProcessInfo to read out the ProcessEvent.
When the kernel signals a process handle, it uses svcResetSignal on the process handle and then it uses svcGetProcessInfo to read out the ProcessEvent.


If the process moved from non-3 -> 3 it clears 4 in process flags.
If the process moved from non-crashed -> ProcessEvent_Crashed it clears 4 in process flags.


If process flags has mask 8 set:
If process flags has mask 8 set:
* If event is ProcessEvent_Running or ProcessEvent_DebugDetached, it clears 0x20 and sets 0x10 in process flags, and signals the ProcessEventWaiter handle.
* If event is ProcessEvent_Running or ProcessEvent_DebugDetached, it clears 0x20 and sets 0x10 in process flags, and signals the ProcessEventWaiter handle.
* If event is ProcessEvent_DebugSuspended, it sets 0x30 in process flags, and signals the ProcessEventWaiter handle.
* If event is ProcessEvent_DebugSuspended, it sets 0x20 and 0x10 in process flags, and signals the ProcessEventWaiter handle.


[2.0.0+] If new state is ProcessEvent_DebugDetached, and process flags has 0x80 set, it sets mask 0x100 and signals the ProcessEventWaiter handle.
[2.0.0+] If new state is ProcessEvent_DebugDetached, and process flags has 0x80 set, it sets mask 0x100 and signals the ProcessEventWaiter handle.
Line 23: Line 82:
It uses [[Loader_services|ldr:pm]] GetProgramInfo with the supplied title-id.
It uses [[Loader_services|ldr:pm]] GetProgramInfo with the supplied title-id.


If ApplicationType == Application, it goes through the process list and errors if any has bit 0x40 set. Thus you can only run one Application at a time.
If ApplicationType == Application, it goes through the process list and errors if any has mask 0x40 set. Thus you can only run one Application at a time.


Resource limits for the process is selected by ApplicationType.
Resource limits for the process is selected by ApplicationType.
Line 54: Line 113:


= pm:bm =
= pm:bm =
This is "nn::pm::detail::IBootModeInterface".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 61: Line 122:
|-
|-
| 1 || SetMaintenanceBoot
| 1 || SetMaintenanceBoot
|-
| 2 || [19.0.0+]
|-
| 3 || [19.0.0+]
|}
|}


= pm:dmnt =
= pm:dmnt =
This is "nn::pm::detail::IDebugMonitorInterface".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#IsDebugMode]]
| [1.0.0-4.1.0] 0 || [[#GetModuleIdList]]
|-
|-
| 1 || [[#GetDebugProcesses]]
| 0 ([1.0.0-4.1.0] 1) || [[#GetJitDebugProcessIdList]]
|-
|-
| 2 || [[#StartDebugProcess]]
| 1 ([1.0.0-4.1.0] 2) || [[#StartProcess]]
|-
|-
| 3 || [[#GetDebuggedTitleId]]
| 2 ([1.0.0-4.1.0] 3) || [[#GetProcessId]]
|-
|-
| 4 || [[#EnableDebugForTitleId]]
| 3 ([1.0.0-4.1.0] 4) || [[#HookToCreateProcess]]
|-
|-
| 5 || [[#GetDebuggedPid]]
| 4 ([1.0.0-4.1.0] 5) || [[#GetApplicationProcessId]]
|-
|-
| 6 || [[#EnableDebugForApplication]]
| 5 ([1.0.0-4.1.0] 6) || [[#HookToCreateApplicationProcess]]
|-
| [6.0.0+] 6 || [[#ClearHook]]
|-
| [14.0.0+] 7 || GetProgramId
|}
|}


== IsDebugMode ==
Always returns u32 0 on retail.


[2.0.0+] Additional check on input that can return 0xC0F. The meaning is probably useless because function is somewhat nopped on non-dev builds anyway.
== GetModuleIdList==
Stubbed in all versions of retail firmware (just returns 0).


== GetDebugProcesses ==
[2.0.0+] When output buffer size is > INT_MAX, returns ResultInvalidSize.
 
== GetJitDebugProcessIdList ==
Returns an array of pids of all processes that have mask 4 set in process flags.
Returns an array of pids of all processes that have mask 4 set in process flags.


[2.0.0+] Additional check on input that can return 0xC0F. The meaning is probably useless because function is somewhat nopped on non-dev builds anyway.
[2.0.0+] When output buffer size is > INT_MAX, returns ResultInvalidSize.


== StartDebugProcess ==
== StartProcess ==
Takes a pid. Last process event must be ProcessEvent_Created or ProcessEvent_DebugAttached.
Takes a pid. Last process event must be ProcessEvent_Created or ProcessEvent_DebugAttached.


Line 100: Line 172:
After that, it sets last process state to ProcessEvent_DebugDetached.
After that, it sets last process state to ProcessEvent_DebugDetached.


== GetDebuggedTitleId ==
== GetProcessId ==
Takes a pid and returns the title-id.
Takes a title-id and returns the pid.


== EnableDebugForTitleId ==
== HookToCreateProcess ==
Takes a title-id of the program to debug. Sets this to a global field.
Takes a title-id of the program to debug. Sets this to a global field.


Line 110: Line 182:
Returns an event handle that is signaled when the requested title is about to be launched.
Returns an event handle that is signaled when the requested title is about to be launched.


== GetDebuggedPid ==
== GetApplicationProcessId ==
Returns the pid of the debugged process.
Returns the pid of the application process.


== EnableDebugForApplication ==
== HookToCreateApplicationProcess ==
Does *not* take a specific title-id as input.
Does *not* take a specific title-id as input.


Returns an event handle that is triggered for application titles.
Returns an event handle that is triggered for application titles.
== ClearHook ==
Takes in a u32 of bitflags.
Disables debugging/clears the globally specified tid if bit 0 is set, disables debugging/clears the next application if bit 1 is set.


= pm:info =
= pm:info =
This is "nn::pm::detail::IInformationInterface".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#GetTitleId]]
| 0 || [[#GetProgramId]]
|-
| 1 || [14.0.0+] GetAppletCurrentResourceLimitValues
|-
| 2 || [14.0.0+] GetAppletPeakResourceLimitValues
|}
|}


== GetTitleId ==
== GetProgramId ==
Takes a pid and returns the title-id associated with the process.
Takes a pid and returns the title-id associated with the process.


= pm:shell =
= pm:shell =
This is "nn::pm::detail::IShellInterface".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#LaunchProcess]]
| 0 || [[#LaunchProgram]]
|-
| 1 || TerminateProcess
|-
| 2 || TerminateProgram
|-
| 3 || GetProcessEventHandle
|-
| 4 || [[#GetProcessEventInfo]]
|-
| ([1.0.0-4.1.0] 5) || [[#CleanupProcess]]
|-
|-
| 1 || TerminateProcessByPid
| ([1.0.0-4.1.0] 6) || [[#ClearJitDebugOccured]]
|-
|-
| 2 || TerminateProcessByTitleId
| 5 ([1.0.0-4.1.0] 7) || [[#NotifyBootFinished]]
|-
|-
| 3 || GetProcessEventWaiter
| 6 ([1.0.0-4.1.0] 8) || [[#GetApplicationProcessIdForShell]]
|-
|-
| 4 || [[#GetProcessEventType]]
| 7 ([4.0.0-4.1.0] 9) || [4.0.0+] [[#BoostSystemMemoryResourceLimit]]
|-
|-
| 5 || [[#FinalizeDeadProcess]]
| 8 || [7.0.0+] [[#BoostApplicationThreadResourceLimit]]
|-
|-
| 6 || [[#ClearProcessNotificationFlag]]
| 9 || [8.0.0+] [[#GetBootFinishedEventHandle]]
|-
|-
| 7 || [[#NotifyBootFinished]]
| 10 || [14.0.0+] BoostSystemThreadResourceLimit
|-
|-
| 8 || [[#GetApplicationPid]]
| 12 || [19.0.0+] GetProcessId
|}
|}


== LaunchProcess ==
== LaunchProgram ==
Takes launch_flags, title-id, and storageID. See [[#Process launch]].
Takes an u32 launch_flags and [[NCM_services#ProgramLocation|ProgramLocation]]. Returns the u64 title PID.


Returns the u64 title PID.
See [[#Process launch]].


== GetProcessEventType ==
== GetProcessEventInfo ==
Returns 1 if flags has mask 2 set.
Returns 1 if flags has mask 2 set.


Returns 2 if flags has mask 1 set and state is 6.
Returns 2 if flags has mask 1 set and state is 6.


Returns 3 if flags has mask 0x10 set and not bit5.
Returns 3 if flags has mask 0x10 set and not 0x20.


Returns 4 if flags has mask 0x30 set.
Returns 4 if flags has mask 0x30 set.
Line 171: Line 266:
Returns 0 if process is not found.
Returns 0 if process is not found.


== FinalizeDeadProcess ==
== CleanupProcess ==
Takes a pid as input. If the process with pid has the state "dead", it unregisters the pid in fsp:pr, sm:m, and ldr:pm.
Takes a pid as input. If the process with pid has the state "dead", it unregisters the pid in fsp:pr, sm:m, and ldr:pm.


Then it removes the process from PMs internal linked-list of active processes.
Then it removes the process from PMs internal linked-list of active processes.


== ClearProcessNotificationFlag ==
[5.0.0+] This command was removed.
Takes a pid as input. Clears 0x10 from process flags.  
 
== ClearJitDebugOccured ==
Takes a pid as input. Clears 0x10 from process flags.
 
[5.0.0+] This command was removed.


== NotifyBootFinished ==
== NotifyBootFinished ==
Launches a process with hardcoded [[boot2]] title-id.
This [[#LaunchProgram|launches]] the [[boot2]] title with launch_flags=0.
 
[10.0.0+] The functionality described [[SMC#DisableProgramVerification|here]] was added, prior to title-launching.
 
[4.0.0+] When booting from SafeMode Firmware, instead of [[boot2]], this launches the following titles in order (launch_flags=0):
* 0100000000000009 (settings)
* 0100000000000006 (usb)
* 010000000000001D (pcie)
* 0100000000000007 (tma)
* 0100000000000042 (pgl) [10.0.0+]
* 010000000000001F (ns)
* 0100000000000015 (lm)
* 0100000000000010 (ptm)
* 0100000000000016 (wlan)
* 0100000000000012 (bsdsockets)
* 0100000000000046 (eth) [15.0.0+]
* 010000000000000F (nifm)
* 0100000000000024 (ssl)
* 0100000000000025 (nim)
* 0100000000000031 (glue)
* 010000000000003D (safemode)


== GetApplicationPid ==
== GetApplicationProcessIdForShell ==
Loops through the internal linked-list of processes, looks for mask 0x40 set in process flags. Returns pid of first such entry.
Loops through the internal linked-list of processes, looks for mask 0x40 set in process flags. Returns pid of first such entry.
== BoostSystemMemoryResourceLimit ==
Takes an u64 '''mem_size''' as input. If the desired memory size doesn't exceed an internal limit (imposed by PM by looking at the [[SPL_services#MemoryArrange|MemoryArrange]] ConfigItem), PM calls svcSetResourceLimitLimitValue to set the new [[SVC#LimitableResource|LimitableResource_Memory]] value.
This is used directly by [[NS_Services#IApplicationManagerInterface|ns:am2 BoostSystemMemoryResourceLimit]].
== BoostApplicationThreadResourceLimit ==
Calls svcSetResourceLimitLimitValue to increase the limit on application threads by an amount calculated dynamically during setup.
This function can only increase the limit once, on further calls it will call svcSetResourceLimitLimitValue with the same value it called the first time.
On normal [[7.0.0]] retail firmware, this will double the limit on application threads from 0x60 to 0xC0.
== GetBootFinishedEventHandle ==
This function returns a handle to an event that is signaled when [[#NotifyBootFinished]] is called.
However, this is only used/available in safe mode; in normal, non-safe FIRM, the implementation for this command just does "abort();".


[[Category:Services]]
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/Process_Manager_services"