Difference between revisions of "IPC Marshalling"

From Nintendo Switch Brew
Jump to navigation Jump to search
(Fix a few things)
Line 15: Line 15:
 
| 0 || 31-28 || Number of buf W desciptors (each: 3 words), never observed.
 
| 0 || 31-28 || Number of buf W desciptors (each: 3 words), never observed.
 
|-
 
|-
| 1 || 9-0 || Total word count (in u32's).
+
| 1 || 9-0 || Raw data size (in u32's).
 
|-
 
|-
 
| 1 || 13-10 || Flags for buf C descriptor.
 
| 1 || 13-10 || Flags for buf C descriptor.
Line 31: Line 31:
 
| ... || || Type W descriptors, each one 3 words.
 
| ... || || Type W descriptors, each one 3 words.
 
|-
 
|-
| ... || || Padding
+
| ... || || Raw data (including any padding).
|-
 
| ... || || Raw data
 
 
|-
 
|-
 
| ... || || Buf C descriptors, each one 2 words.
 
| ... || || Buf C descriptors, each one 2 words.
Line 49: Line 47:
 
|-
 
|-
 
| 0 || 8-5 || Number of handles to move
 
| 0 || 8-5 || Number of handles to move
 +
|-
 +
| ... || || 8-byte PID if enabled
 
|-
 
|-
 
| ... || || Handles to copy
 
| ... || || Handles to copy
Line 113: Line 113:
  
 
== Raw data portion ==
 
== Raw data portion ==
This is an array of u64's. It's always aligned to 16 so sometimes there is padding words before it.
+
This is an array of u32's, but individual parameters are generally stored as u64's.
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
! Word || Description
 
! Word || Description
 
|-
 
|-
| ... || Pid is written here if enabled.
+
| ... || Padding to align to 16
 +
|-
 +
| ... || Domain header padded to 16 if required
 +
|-
 +
| +0 || Magic ("SFCI" for requests, "SFCO" for responses) as u64
 
|-
 
|-
| +0 || Magic ("SFCI" for requests, "SFCO" for responses)
+
| +2 || Cmd id as u64
 
|-
 
|-
| +1 || Cmd id
+
| ... || Input parameters
 
|-
 
|-
| ... || Rest of raw data.
+
| ... || Any u16 buffer sizes packed and aligned to 2 bytes
 
|}
 
|}
  
Line 186: Line 190:
  
 
== Control ==
 
== Control ==
When type == 5 you are talking to kernel.
+
When type == 5 you are talking to the IPC manager.
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"

Revision as of 10:31, 6 July 2017

IPC Command Structure

This is an array of u32's.

Word Bits Description
0 15-0 Type. 4=Request, 5=Control
0 19-16 Number of buf X descriptors (each: 2 words).
0 23-20 Number of buf A descriptors (each: 3 words).
0 27-24 Number of buf B descriptors (each: 3 words).
0 31-28 Number of buf W desciptors (each: 3 words), never observed.
1 9-0 Raw data size (in u32's).
1 13-10 Flags for buf C descriptor.
1 31 Enable handle descriptor.
... Handle descriptor, if enabled.
... Buf X descriptors, each one 2 words.
... Buf A descriptors, each one 3 words.
... Buf B descriptors, each one 3 words.
... Type W descriptors, each one 3 words.
... Raw data (including any padding).
... Buf C descriptors, each one 2 words.

Handle descriptor

There can only be one of this descriptor type. It is enabled by bit31 of the second word.

Word Bits Description
0 0 Send current PID.
0 4-1 Number of handles to copy
0 8-5 Number of handles to move
... 8-byte PID if enabled
... Handles to copy
... Handles to move

Buffer descriptor X "Pointer"

This one is packed even worse than A, they inserted the bit38-36 of the address on top of the counter field.

Officially, the counter is known as "receive index". This one writes to the buffer described in the ReceiveList.

Word Bits Description
0 5-0 Bits 5-0 of counter.
0 8-6 Bit 38-36 of address.
0 11-9 Bits 11-9 of counter.
0 15-12 Bit 35-32 of address.
0 31-16 Size
1 Lower 32-bits of address.

Buffer descriptor A/B/W "Send"/"Receive"/"Exchange"

This packing is so unnecessarily complex.

Word Bits Description
0 Lower 32-bits of size.
1 Lower 32-bits of address.
2 1-0 Flags. Always set to 1 or 3.
2 4-2 Bit 38-36 of address.
2 27-24 Bit 35-32 of size.
2 31-28 Bit 35-32 of address.

Buffer descriptor C "ReceiveList"

There's a 4-bit flag in the main header controlling the behavior of C descriptors.

If it has value 0, the C descriptor functionality is disabled. If it has value 1, there is no C descriptor. If it has value 2, there is a single C descriptor.

Otherwise it has (flag-2) C descriptors.

Word Bits Description
0 Lower 32-bits of address.
1 15-0 Rest of address.
1 31-16 Size

Raw data portion

This is an array of u32's, but individual parameters are generally stored as u64's.

Word Description
... Padding to align to 16
... Domain header padded to 16 if required
+0 Magic ("SFCI" for requests, "SFCO" for responses) as u64
+2 Cmd id as u64
... Input parameters
... Any u16 buffer sizes packed and aligned to 2 bytes

Official marshalling code

The official marshalling function takes an array of (buf_ptr, size) pairs and a type-field for each such pair.

Bitmask 0x10 seems to indicate null-terminated strings, but that flag is ignored by the marshalling code.

Type Mask Description Direction
4 + 1 Creates a A descriptor with flags=0. In
0x40 + 4 + 1 Creates a A descriptor with flags=1. In
0x80 + 4 + 1 Creates a A descriptor with flags=3. In
4 + 2 Creates a B descriptor with flags=0. Out
0x40 + 4 + 2 Creates a B descriptor with flags=1. Out
0x80 + 4 + 2 Creates a B descriptor with flags=3. Out
8 + 1 Creates an X descriptor In
8 + 2 Creates a C descriptor, and writes the u16 size to an offset into raw data. Out
0x10 + 8 + 2 Creates a C descriptor Out
0x20 + 1 Creates both an A and X descriptor In
0x20 + 2 Creates both an B and C descriptor Out

For types 0x21, 0x22 if size doesn't fit in u16, it's added to a list. Some magic shit happens to that list.

Official IPC Cmd Structure

Official struct that is stored for each IPC command. It contains precalculated offsets for different portions of the command structure.

All offsets are given is in number of u32 words.

struct IpcCmdStruct {
  u8  unk0;
  u8  has_handle_descriptor;
  u8  pad0[2];
  u32 cmd0;
  u32 cmd1;
  u32 offset_handle_descriptor;
  u32 pad1;
  u32 offset_handles;          
  u32 pad2;
  u32 offset_x_descriptors;
  u32 offset_a_descriptors;
  u32 offset_b_descriptors;
  u32 offset_w_descriptors; /* this is a guess */
  u32 offset_raw_data;
  u32 offset_c_descriptors;
  u32 unk2;
  u32 unk3;
}

Control

When type == 5 you are talking to the IPC manager.

Cmd Name
0 ConvertSessionToDomain
2 DuplicateSession
3 QueryPointerBufferSize
4 DuplicateSessionEx