A bit of a redesign.

Sessions and Ports are now detached from each other.
HLE services are handled by means of a SessionRequestHandler class, Interface now inherits from this class.
The File and Directory classes are no longer kernel objects, but SessionRequestHandlers instead, bound to a ServerSession when requested.
File::OpenLinkFile now creates a new session pair and binds the File instance to it.
This commit is contained in:
Subv 2016-11-30 22:50:13 -05:00
parent c5e7e0fa26
commit 009b15b3aa
13 changed files with 266 additions and 263 deletions

View file

@ -14,21 +14,7 @@ namespace Kernel {
ClientPort::ClientPort() {}
ClientPort::~ClientPort() {}
Kernel::SharedPtr<ClientPort> ClientPort::CreateForHLE(u32 max_sessions, std::shared_ptr<Service::Interface> hle_interface) {
SharedPtr<ClientPort> client_port(new ClientPort);
client_port->max_sessions = max_sessions;
client_port->active_sessions = 0;
client_port->name = hle_interface->GetPortName();
client_port->hle_interface = std::move(hle_interface);
return client_port;
}
void ClientPort::AddWaitingSession(SharedPtr<ServerSession> server_session) {
// A port that has an associated HLE interface doesn't have a server port.
if (hle_interface != nullptr)
return;
server_port->pending_sessions.push_back(server_session);
// Wake the threads waiting on the ServerPort
server_port->WakeupAllWaitingThreads();

View file

@ -22,14 +22,6 @@ class ClientPort final : public Object {
public:
friend class ServerPort;
/**
* Creates a serverless ClientPort that represents a bridge between the HLE implementation of a service/port and the emulated application.
* @param max_sessions Maximum number of sessions that this port is able to handle concurrently.
* @param hle_interface Interface object that implements the commands of the service.
* @returns ClientPort for the given HLE interface.
*/
static Kernel::SharedPtr<ClientPort> CreateForHLE(u32 max_sessions, std::shared_ptr<Service::Interface> hle_interface);
/**
* Adds the specified server session to the queue of pending sessions of the associated ServerPort
* @param server_session Server session to add to the queue
@ -44,12 +36,10 @@ public:
return HANDLE_TYPE;
}
SharedPtr<ServerPort> server_port = nullptr; ///< ServerPort associated with this client port.
SharedPtr<ServerPort> server_port; ///< ServerPort associated with this client port.
u32 max_sessions; ///< Maximum number of simultaneous sessions the port can have
u32 active_sessions; ///< Number of currently open sessions to this port
std::string name; ///< Name of client port (optional)
std::shared_ptr<Service::Interface> hle_interface = nullptr; ///< HLE implementation of this port's request handler
private:
ClientPort();
~ClientPort() override;

View file

@ -15,29 +15,17 @@ namespace Kernel {
ClientSession::ClientSession() {}
ClientSession::~ClientSession() {}
ResultVal<SharedPtr<ClientSession>> ClientSession::Create(SharedPtr<ServerSession> server_session, SharedPtr<ClientPort> client_port, std::string name) {
ResultVal<SharedPtr<ClientSession>> ClientSession::Create(SharedPtr<ServerSession> server_session, std::string name) {
SharedPtr<ClientSession> client_session(new ClientSession);
client_session->name = std::move(name);
client_session->server_session = server_session;
client_session->client_port = client_port;
client_session->hle_helper = client_port->hle_interface;
return MakeResult<SharedPtr<ClientSession>>(std::move(client_session));
}
ResultCode ClientSession::HandleSyncRequest() {
// Signal the server session that new data is available
ResultCode result = server_session->HandleSyncRequest();
if (result.IsError())
return result;
// If this ClientSession has an associated HLE helper, forward the request to it.
if (hle_helper != nullptr)
result = hle_helper->HandleSyncRequest(server_session);
return result;
return server_session->HandleSyncRequest();
}
} // namespace

View file

@ -25,11 +25,10 @@ public:
/**
* Creates a client session.
* @param server_session The server session associated with this client session
* @param client_port The client port which this session is connected to
* @param name Optional name of client session
* @return The created client session
*/
static ResultVal<SharedPtr<ClientSession>> Create(SharedPtr<ServerSession> server_session, SharedPtr<ClientPort> client_port, std::string name = "Unknown");
static ResultVal<SharedPtr<ClientSession>> Create(SharedPtr<ServerSession> server_session, std::string name = "Unknown");
std::string GetTypeName() const override { return "ClientSession"; }
std::string GetName() const override { return name; }
@ -45,8 +44,6 @@ public:
std::string name; ///< Name of client port (optional)
SharedPtr<ServerSession> server_session; ///< The server session associated with this client session.
SharedPtr<ClientPort> client_port; ///< The client port which this session is connected to.
std::shared_ptr<Service::Interface> hle_helper = nullptr; ///< HLE implementation of this port's request handler
private:
ClientSession();

View file

@ -14,11 +14,12 @@ namespace Kernel {
ServerSession::ServerSession() {}
ServerSession::~ServerSession() {}
ResultVal<SharedPtr<ServerSession>> ServerSession::Create(std::string name) {
ResultVal<SharedPtr<ServerSession>> ServerSession::Create(std::string name, std::shared_ptr<Service::SessionRequestHandler> hle_handler) {
SharedPtr<ServerSession> server_session(new ServerSession);
server_session->name = std::move(name);
server_session->signaled = false;
server_session->hle_handler = hle_handler;
return MakeResult<SharedPtr<ServerSession>>(std::move(server_session));
}
@ -34,23 +35,21 @@ void ServerSession::Acquire() {
ResultCode ServerSession::HandleSyncRequest() {
// The ServerSession received a sync request, this means that there's new data available
// from one of its ClientSessions, so wake up any threads that may be waiting on a svcReplyAndReceive or similar.
// from its ClientSession, so wake up any threads that may be waiting on a svcReplyAndReceive or similar.
// If this ServerSession has an associated HLE handler, forward the request to it.
if (hle_handler != nullptr)
return hle_handler->HandleSyncRequest(SharedPtr<ServerSession>(this));
// If this ServerSession does not have an HLE implementation, just wake up the threads waiting on it.
signaled = true;
WakeupAllWaitingThreads();
return RESULT_SUCCESS;
}
SharedPtr<ClientSession> ServerSession::CreateClientSession() {
// In Citra, some types of ServerSessions (File and Directory sessions) are not created as a pair of Server-Client sessions,
// but are instead created as a single ServerSession, which then hands over a ClientSession on demand (When opening the File or Directory).
// The real kernel (Or more specifically, the real FS service) does create the pair of Sessions at the same time (via svcCreateSession), and simply
// stores the ClientSession until it is needed.
return ClientSession::Create(SharedPtr<ServerSession>(this), nullptr, name + "Client").MoveFrom();
}
std::tuple<SharedPtr<ServerSession>, SharedPtr<ClientSession>> ServerSession::CreateSessionPair(SharedPtr<ClientPort> client_port, const std::string& name) {
auto server_session = ServerSession::Create(name + "Server").MoveFrom();
auto client_session = ClientSession::Create(server_session, client_port, name + "Client").MoveFrom();
std::tuple<SharedPtr<ServerSession>, SharedPtr<ClientSession>> ServerSession::CreateSessionPair(const std::string& name, std::shared_ptr<Service::SessionRequestHandler> hle_handler) {
auto server_session = ServerSession::Create(name + "Server", hle_handler).MoveFrom();
auto client_session = ClientSession::Create(server_session, name + "Client").MoveFrom();
return std::make_tuple(server_session, client_session);
}

View file

@ -10,158 +10,11 @@
#include "core/hle/kernel/kernel.h"
#include "core/hle/kernel/thread.h"
#include "core/hle/result.h"
#include "core/hle/service/service.h"
#include "core/memory.h"
namespace IPC {
enum DescriptorType : u32 {
// Buffer related desciptors types (mask : 0x0F)
StaticBuffer = 0x02,
PXIBuffer = 0x04,
MappedBuffer = 0x08,
// Handle related descriptors types (mask : 0x30, but need to check for buffer related
// descriptors first )
CopyHandle = 0x00,
MoveHandle = 0x10,
CallingPid = 0x20,
};
/**
* @brief Creates a command header to be used for IPC
* @param command_id ID of the command to create a header for.
* @param normal_params Size of the normal parameters in words. Up to 63.
* @param translate_params_size Size of the translate parameters in words. Up to 63.
* @return The created IPC header.
*
* Normal parameters are sent directly to the process while the translate parameters might go
* through modifications and checks by the kernel.
* The translate parameters are described by headers generated with the IPC::*Desc functions.
*
* @note While #normal_params is equivalent to the number of normal parameters,
* #translate_params_size includes the size occupied by the translate parameters headers.
*/
constexpr u32 MakeHeader(u16 command_id, unsigned int normal_params,
unsigned int translate_params_size) {
return (u32(command_id) << 16) | ((u32(normal_params) & 0x3F) << 6) |
(u32(translate_params_size) & 0x3F);
}
union Header {
u32 raw;
BitField<0, 6, u32> translate_params_size;
BitField<6, 6, u32> normal_params;
BitField<16, 16, u32> command_id;
};
inline Header ParseHeader(u32 header) {
return {header};
}
constexpr u32 MoveHandleDesc(u32 num_handles = 1) {
return MoveHandle | ((num_handles - 1) << 26);
}
constexpr u32 CopyHandleDesc(u32 num_handles = 1) {
return CopyHandle | ((num_handles - 1) << 26);
}
constexpr u32 CallingPidDesc() {
return CallingPid;
}
constexpr bool isHandleDescriptor(u32 descriptor) {
return (descriptor & 0xF) == 0x0;
}
constexpr u32 HandleNumberFromDesc(u32 handle_descriptor) {
return (handle_descriptor >> 26) + 1;
}
constexpr u32 StaticBufferDesc(u32 size, u8 buffer_id) {
return StaticBuffer | (size << 14) | ((buffer_id & 0xF) << 10);
}
union StaticBufferDescInfo {
u32 raw;
BitField<10, 4, u32> buffer_id;
BitField<14, 18, u32> size;
};
inline StaticBufferDescInfo ParseStaticBufferDesc(const u32 desc) {
return {desc};
}
/**
* @brief Creates a header describing a buffer to be sent over PXI.
* @param size Size of the buffer. Max 0x00FFFFFF.
* @param buffer_id The Id of the buffer. Max 0xF.
* @param is_read_only true if the buffer is read-only. If false, the buffer is considered to have
* read-write access.
* @return The created PXI buffer header.
*
* The next value is a phys-address of a table located in the BASE memregion.
*/
inline u32 PXIBufferDesc(u32 size, unsigned buffer_id, bool is_read_only) {
u32 type = PXIBuffer;
if (is_read_only)
type |= 0x2;
return type | (size << 8) | ((buffer_id & 0xF) << 4);
}
enum MappedBufferPermissions {
R = 1,
W = 2,
RW = R | W,
};
constexpr u32 MappedBufferDesc(u32 size, MappedBufferPermissions perms) {
return MappedBuffer | (size << 4) | (u32(perms) << 1);
}
union MappedBufferDescInfo {
u32 raw;
BitField<4, 28, u32> size;
BitField<1, 2, MappedBufferPermissions> perms;
};
inline MappedBufferDescInfo ParseMappedBufferDesc(const u32 desc) {
return {desc};
}
inline DescriptorType GetDescriptorType(u32 descriptor) {
// Note: Those checks must be done in this order
if (isHandleDescriptor(descriptor))
return (DescriptorType)(descriptor & 0x30);
// handle the fact that the following descriptors can have rights
if (descriptor & MappedBuffer)
return MappedBuffer;
if (descriptor & PXIBuffer)
return PXIBuffer;
return StaticBuffer;
}
} // namespace IPC
namespace Kernel {
static const int kCommandHeaderOffset = 0x80; ///< Offset into command buffer of header
/**
* Returns a pointer to the command buffer in the current thread's TLS
* TODO(Subv): This is not entirely correct, the command buffer should be copied from
* the thread's TLS to an intermediate buffer in kernel memory, and then copied again to
* the service handler process' memory.
* @param offset Optional offset into command buffer
* @return Pointer to command buffer
*/
inline u32* GetCommandBuffer(const int offset = 0) {
return (u32*)Memory::GetPointer(GetCurrentThread()->GetTLSAddress() + kCommandHeaderOffset +
offset);
}
class ClientSession;
class ClientPort;
@ -183,11 +36,13 @@ public:
~ServerSession() override;
/**
* Creates a server session.
* @param name Optional name of the server session
* Creates a server session. The server session can have an optional HLE handler,
* which will be invoked to handle the IPC requests that this session receives.
* @param name Optional name of the server session.
* @param hle_handler Optional HLE handler for this server session.
* @return The created server session
*/
static ResultVal<SharedPtr<ServerSession>> Create(std::string name = "Unknown");
static ResultVal<SharedPtr<ServerSession>> Create(std::string name = "Unknown", std::shared_ptr<Service::SessionRequestHandler> hle_handler = nullptr);
std::string GetTypeName() const override { return "ServerSession"; }
@ -196,17 +51,10 @@ public:
/**
* Creates a pair of ServerSession and an associated ClientSession.
* @param client_port ClientPort to which the sessions are connected
* @param name Optional name of the ports
* @return The created session tuple
*/
static std::tuple<SharedPtr<ServerSession>, SharedPtr<ClientSession>> CreateSessionPair(SharedPtr<ClientPort> client_port, const std::string& name = "Unknown");
/**
* Creates a portless ClientSession and associates it with this ServerSession.
* @returns ClientSession The newly created ClientSession.
*/
SharedPtr<ClientSession> CreateClientSession();
static std::tuple<SharedPtr<ServerSession>, SharedPtr<ClientSession>> CreateSessionPair(const std::string& name = "Unknown", std::shared_ptr<Service::SessionRequestHandler> hle_handler = nullptr);
/**
* Handle a sync request from the emulated application.
@ -221,5 +69,6 @@ public:
std::string name; ///< The name of this session (optional)
bool signaled; ///< Whether there's new data available to this ServerSession
std::shared_ptr<Service::SessionRequestHandler> hle_handler; ///< This session's HLE request handler (optional)
};
}