Difference between revisions of "Loader services"

From Nintendo Switch Brew
Jump to navigation Jump to search
(ro:1)
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
= ldr:shel =
 +
This is "nn::ldr::detail::IShellInterface".
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#SetProgramArgument]]
 +
|-
 +
| 1 || [[#FlushArguments]]
 +
|}
 +
 +
== SetProgramArgument ==
 +
Takes a type-0x9 input buffer with launch arguments (as string), an u32 (size of arguments string), and an input title-id.
 +
 +
Loads a process for the specified title-id and passes along the supplied arguments.
 +
Loaded processes are kept in a queue waiting for PM to launch them. The maximum number of waiting processes in this list is 10.
 +
 +
== FlushArguments ==
 +
Clears the loaded processes waiting queue.
 +
 +
 
= ldr:dmnt =
 
= ldr:dmnt =
 
This is "nn::ldr::detail::IDebugMonitorInterface".
 
This is "nn::ldr::detail::IDebugMonitorInterface".
Line 6: Line 28:
 
! Cmd || Name
 
! Cmd || Name
 
|-
 
|-
| 0 || [[Loader_services#AddProcessToDebugLaunchQueue|AddProcessToDebugLaunchQueue]]
+
| 0 || [[#SetProgramArgument]]
 
|-
 
|-
| 1 || [[Loader_services#ClearDebugLaunchQueue|ClearDebugLaunchQueue]]
+
| 1 || [[#FlushArguments]]
 
|-
 
|-
| 2 || [[Loader_services#GetNsoInfos|GetNsoInfos]]
+
| 2 || [[#GetProcessModuleInfo]]
 
|}
 
|}
  
== AddProcessToDebugLaunchQueue ==
+
== GetProcessModuleInfo ==
Same as [[Loader_services#AddProcessToLaunchQueue|AddProcessToLaunchQueue]] but for processes marked as debug.
+
Takes in a u64 Process ID, and a C descriptor out array of [[#ModuleInfos]]. Returns the number of ModuleInfos copied to output.
  
== ClearDebugLaunchQueue ==
+
ModuleInfo is the same here as for ro:dmnt.
Same as [[Loader_services#ClearLaunchQueue|ClearLaunchQueue]].
 
  
== GetNsoInfos ==
+
ModuleInfo has the following layout:
Takes in a u64 ProcessID, and a C descriptor. Returns the number of NsoInfos copied to output.
 
 
 
NsoInfo has the following layout:
 
  
 +
=== ModuleInfo ===
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
Line 32: Line 51:
 
| 0x0
 
| 0x0
 
| 0x20
 
| 0x20
| "Build ID", from NSO header+0x40.
+
| Build ID
 
|-
 
|-
 
| 0x20
 
| 0x20
 
| 0x8
 
| 0x8
| Mapped address for this NSO
+
| Mapped Address
 
|-
 
|-
 
| 0x28
 
| 0x28
 
| 0x8
 
| 0x8
| Mapped size for this NSO
+
| Mapped Size
 
|-
 
|-
 
|}
 
|}
Line 56: Line 75:
 
| 1 || [[#GetProgramInfo]]
 
| 1 || [[#GetProgramInfo]]
 
|-
 
|-
| 2 || [[#RegisterTitle]]
+
| 2 || [[#PinProgram]]
 
|-
 
|-
| 3 || [[#UnregisterTitle]]
+
| 3 || [[#UnpinProgram]]
 
|}
 
|}
  
 
== GetProgramInfo ==
 
== GetProgramInfo ==
Takes a TitleId + StorageId, parses the NPDM, and writes output to a C descriptor buffer as follows:
+
Takes an ncm::ProgramLocation, parses the NPDM, and writes a [[#ProgramInfo]] to a C descriptor buffer as follows:
  
 +
=== ProgramInfo ===
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
Line 127: Line 147:
 
|}
 
|}
  
== RegisterTitle ==
+
== PinProgram ==
Takes a TitleId + StorageId, returns an index.
+
Takes an ncm::ProgramLocation, returns a u64 "PinId".
 
 
== UnregisterTitle ==
 
Takes the index from [[#RegisterTitle]].
 
 
 
= ldr:shel =
 
This is "nn::ldr::detail::IShellInterface".
 
 
 
{| class="wikitable" border="1"
 
|-
 
! Cmd || Name
 
|-
 
| 0 || [[#AddProcessToLaunchQueue]]
 
|-
 
| 1 || [[#ClearLaunchQueue]]
 
|}
 
 
 
== AddProcessToLaunchQueue ==
 
Takes a type-0x19 input buffer with launch arguments (as string), an u32 (size of arguments string), and an input title-id.
 
 
 
Loads a process for the specified title-id and passes along the supplied arguments.
 
Loaded processes are kept in a queue waiting for PM to launch them. The maximum number of waiting processes in this list is 10.
 
 
 
== ClearLaunchQueue ==
 
Clears the loaded processes waiting queue.
 
 
 
= ldr:ro =
 
= ro:1 =
 
[1.0.0-2.3.0] This is "nn::ldr::detail::IRoInterface"
 
 
 
[3.0.0+] This is "nn::ro::detail::IRoInterface".
 
 
 
[7.0.0+] ro:1 was added, and also creates nn::ro::detail::IRoInterface objects.
 
 
 
{| class="wikitable" border="1"
 
|-
 
! Cmd || Name
 
|-
 
| 0 || [[#LoadNro]]
 
|-
 
| 1 || UnloadNro
 
|-
 
| 2 || [[#LoadNrr]]
 
|-
 
| 3 || UnloadNrr
 
|-
 
| 4 || [[#Initialize]]
 
|-
 
| 10 || [7.0.0+] [[#LoadNrrEx]]
 
|}
 
 
 
== LoadNro ==
 
{| class="wikitable" border="1"
 
|-
 
! Word || Value
 
|-
 
| 0 || 0x00000004
 
|-
 
| 1 || 0x80000012
 
|-
 
| 2 || 0x00000001
 
|- style="border-top: double"
 
| 0-1 || Pid
 
|- style="border-top: double"
 
| 0 || "SCFI"
 
|-
 
| 1 || 0x00000000
 
|-
 
| 2 || Always 0.
 
|-
 
| 3 || Nro heap address
 
|-
 
| 4 || Nro size
 
|-
 
| 5 || Bss backing heap address
 
|-
 
| 6 || Bss size
 
|}
 
 
 
== LoadNrr ==
 
[7.0.0+] A new 8-bit field at NRR + 0x33C (previously padding) must be 0 for this function to succeed.
 
 
 
{| class="wikitable" border="1"
 
|-
 
! Word || Value
 
|-
 
| 0 || 0x00000004
 
|-
 
| 1 || 0x8000000E
 
|-
 
| 2 || 0x00000001
 
|-
 
|- style="border-top: double"
 
| 0-1 || Pid
 
|- style="border-top: double"
 
| 0 || "SFCI"
 
|-
 
| 1 || 0x00000002
 
|-
 
| 2 || Always 0.
 
|-
 
| 3 || Nrr address
 
|-
 
| 4 || Nrr size
 
|}
 
 
 
== Initialize ==
 
{| class="wikitable" border="1"
 
|-
 
! Word || Value
 
|-
 
| 0 || 0x00000004
 
|-
 
| 1 || 0x8000000A
 
|-
 
| 2 || 0x00000003
 
|- style="border-top: double"
 
| 0-1 || Pid
 
|-
 
| 2 || Process handle (0xFFFF8001)
 
|- style="border-top: double"
 
| 0 || "SFCI"
 
|-
 
| 1 || 0x00000004
 
|-
 
| 2 || Always 0.
 
|}
 
 
 
== LoadNrrEx ==
 
Takes in a u64 nrr_address, a u64 nrr_size, a pid descriptor, and a process handle.
 
 
 
First, this validates that the pid descriptor matches the pid for the process handle sent to this->Initialize() earlier.
 
 
 
Then, this calls the same function as LoadNrr, except using the passed process handle instead of the one sent to Initialize.  
 
  
When called from an ro:1 session, the field at NRR header + 0x33C must be 0x1. When called from ldr:ro session, the field at NRR header + 0x33C must be 0x0.
+
== UnpinProgram ==
 +
Takes a PinId from [[#PinProgram]].
  
 
[[Category:Services]]
 
[[Category:Services]]

Revision as of 06:23, 28 October 2019

ldr:shel

This is "nn::ldr::detail::IShellInterface".

Cmd Name
0 #SetProgramArgument
1 #FlushArguments

SetProgramArgument

Takes a type-0x9 input buffer with launch arguments (as string), an u32 (size of arguments string), and an input title-id.

Loads a process for the specified title-id and passes along the supplied arguments. Loaded processes are kept in a queue waiting for PM to launch them. The maximum number of waiting processes in this list is 10.

FlushArguments

Clears the loaded processes waiting queue.


ldr:dmnt

This is "nn::ldr::detail::IDebugMonitorInterface".

Cmd Name
0 #SetProgramArgument
1 #FlushArguments
2 #GetProcessModuleInfo

GetProcessModuleInfo

Takes in a u64 Process ID, and a C descriptor out array of #ModuleInfos. Returns the number of ModuleInfos copied to output.

ModuleInfo is the same here as for ro:dmnt.

ModuleInfo has the following layout:

ModuleInfo

Offset Size Description
0x0 0x20 Build ID
0x20 0x8 Mapped Address
0x28 0x8 Mapped Size


ldr:pm

This is "nn::ldr::detail::IProcessManagerInterface".

Cmd Name
0 CreateProcess
1 #GetProgramInfo
2 #PinProgram
3 #UnpinProgram

GetProgramInfo

Takes an ncm::ProgramLocation, parses the NPDM, and writes a #ProgramInfo to a C descriptor buffer as follows:

ProgramInfo

Offset Size Description
0x0 0x1 MainThreadPrio. Arg1 to svcStartProcess
0x1 0x1 DefaultCpuId. Arg2 to svcStartProcess
0x2 0x1 ApplicationType, see here.
0x3 0x1 Padding
0x4 0x4 MainThreadStackSize. Arg3 to svcStartProcess
0x8 0x8 TitleIdRange_Min
0x10 0x4 ACID Service Access Control list size
0x14 0x4 ACI0 Service Access Control list size
0x18 0x4 ACID FS Access Control buffer size
0x1C 0x4 ACI0 FS Access Control buffer size
0x20 <Varies> ACID Service Access Control list
<Varies> <Varies> ACI0 Service Access Control list
<Varies> <Varies> ACID FS Access Control buffer
<Varies> <Varies> ACI0 FS Access Control

PinProgram

Takes an ncm::ProgramLocation, returns a u64 "PinId".

UnpinProgram

Takes a PinId from #PinProgram.