2014-12-13 21:30:11 -08:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-16 21:38:14 -08:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-12-13 21:30:11 -08:00
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2017-02-19 18:37:14 -08:00
|
|
|
#include <memory>
|
2015-06-21 05:40:28 -07:00
|
|
|
#include <string>
|
|
|
|
#include "common/assert.h"
|
|
|
|
#include "common/common_types.h"
|
2014-12-13 21:30:11 -08:00
|
|
|
#include "core/hle/kernel/kernel.h"
|
2017-05-29 15:45:30 -07:00
|
|
|
#include "core/hle/kernel/wait_object.h"
|
2015-06-21 05:40:28 -07:00
|
|
|
#include "core/hle/result.h"
|
2015-05-12 18:38:29 -07:00
|
|
|
#include "core/memory.h"
|
2014-12-13 21:30:11 -08:00
|
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
|
2016-06-14 16:03:30 -07:00
|
|
|
class ClientSession;
|
2017-01-04 20:23:17 -08:00
|
|
|
class ClientPort;
|
|
|
|
class ServerSession;
|
2017-06-08 00:33:57 -07:00
|
|
|
class Session;
|
2017-06-04 21:52:19 -07:00
|
|
|
class SessionRequestHandler;
|
2017-05-29 16:45:42 -07:00
|
|
|
class Thread;
|
2018-02-18 10:22:19 -08:00
|
|
|
class HLERequestContext;
|
2016-06-14 16:03:30 -07:00
|
|
|
|
2014-12-13 21:30:11 -08:00
|
|
|
/**
|
2016-06-14 16:03:30 -07:00
|
|
|
* Kernel object representing the server endpoint of an IPC session. Sessions are the basic CTR-OS
|
2014-12-13 21:30:11 -08:00
|
|
|
* primitive for communication between different processes, and are used to implement service calls
|
|
|
|
* to the various system services.
|
|
|
|
*
|
|
|
|
* To make a service call, the client must write the command header and parameters to the buffer
|
|
|
|
* located at offset 0x80 of the TLS (Thread-Local Storage) area, then execute a SendSyncRequest
|
2016-12-14 09:33:49 -08:00
|
|
|
* SVC call with its ClientSession handle. The kernel will read the command header, using it to
|
|
|
|
* marshall the parameters to the process at the server endpoint of the session.
|
|
|
|
* After the server replies to the request, the response is marshalled back to the caller's
|
|
|
|
* TLS buffer and control is transferred back to it.
|
2014-12-13 21:30:11 -08:00
|
|
|
*/
|
2016-12-05 08:02:08 -08:00
|
|
|
class ServerSession final : public WaitObject {
|
2014-12-13 21:30:11 -08:00
|
|
|
public:
|
2016-11-30 20:28:31 -08:00
|
|
|
std::string GetTypeName() const override {
|
|
|
|
return "ServerSession";
|
|
|
|
}
|
2014-12-13 21:30:11 -08:00
|
|
|
|
2016-06-14 16:03:30 -07:00
|
|
|
static const HandleType HANDLE_TYPE = HandleType::ServerSession;
|
2016-11-30 20:28:31 -08:00
|
|
|
HandleType GetHandleType() const override {
|
|
|
|
return HANDLE_TYPE;
|
|
|
|
}
|
2016-06-14 16:03:30 -07:00
|
|
|
|
2016-12-08 08:06:19 -08:00
|
|
|
using SessionPair = std::tuple<SharedPtr<ServerSession>, SharedPtr<ClientSession>>;
|
|
|
|
|
2016-06-14 16:03:30 -07:00
|
|
|
/**
|
|
|
|
* Creates a pair of ServerSession and an associated ClientSession.
|
2017-02-26 17:58:51 -08:00
|
|
|
* @param name Optional name of the ports.
|
2017-01-04 20:23:17 -08:00
|
|
|
* @param client_port Optional The ClientPort that spawned this session.
|
2016-06-14 16:03:30 -07:00
|
|
|
* @return The created session tuple
|
|
|
|
*/
|
2017-06-05 22:39:26 -07:00
|
|
|
static SessionPair CreateSessionPair(const std::string& name = "Unknown",
|
|
|
|
SharedPtr<ClientPort> client_port = nullptr);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the HLE handler for the session. This handler will be called to service IPC requests
|
|
|
|
* instead of the regular IPC machinery. (The regular IPC machinery is currently not
|
|
|
|
* implemented.)
|
|
|
|
*/
|
|
|
|
void SetHleHandler(std::shared_ptr<SessionRequestHandler> hle_handler_) {
|
|
|
|
hle_handler = std::move(hle_handler_);
|
|
|
|
}
|
2014-12-13 21:30:11 -08:00
|
|
|
|
|
|
|
/**
|
2016-06-14 16:03:30 -07:00
|
|
|
* Handle a sync request from the emulated application.
|
2017-06-20 15:33:28 -07:00
|
|
|
* @param thread Thread that initiated the request.
|
2016-06-14 16:03:30 -07:00
|
|
|
* @returns ResultCode from the operation.
|
2014-12-13 21:30:11 -08:00
|
|
|
*/
|
2017-06-20 15:33:28 -07:00
|
|
|
ResultCode HandleSyncRequest(SharedPtr<Thread> thread);
|
2015-01-18 17:40:53 -08:00
|
|
|
|
2017-01-01 13:53:22 -08:00
|
|
|
bool ShouldWait(Thread* thread) const override;
|
2015-01-20 14:41:12 -08:00
|
|
|
|
2017-01-01 13:53:22 -08:00
|
|
|
void Acquire(Thread* thread) override;
|
2015-01-20 14:41:12 -08:00
|
|
|
|
2017-01-04 20:23:17 -08:00
|
|
|
std::string name; ///< The name of this session (optional)
|
|
|
|
std::shared_ptr<Session> parent; ///< The parent session, which links to the client endpoint.
|
2017-06-04 21:52:19 -07:00
|
|
|
std::shared_ptr<SessionRequestHandler>
|
2018-01-23 15:03:09 -08:00
|
|
|
hle_handler; ///< This session's HLE request handler (applicable when not a domain)
|
|
|
|
|
|
|
|
/// This is the list of domain request handlers (after conversion to a domain)
|
|
|
|
std::vector<std::shared_ptr<SessionRequestHandler>> domain_request_handlers;
|
2016-12-05 08:02:08 -08:00
|
|
|
|
2017-06-20 15:33:28 -07:00
|
|
|
/// List of threads that are pending a response after a sync request. This list is processed in
|
|
|
|
/// a LIFO manner, thus, the last request will be dispatched first.
|
|
|
|
/// TODO(Subv): Verify if this is indeed processed in LIFO using a hardware test.
|
|
|
|
std::vector<SharedPtr<Thread>> pending_requesting_threads;
|
|
|
|
|
|
|
|
/// Thread whose request is currently being handled. A request is considered "handled" when a
|
|
|
|
/// response is sent via svcReplyAndReceive.
|
|
|
|
/// TODO(Subv): Find a better name for this.
|
|
|
|
SharedPtr<Thread> currently_handling;
|
|
|
|
|
2018-01-23 15:03:09 -08:00
|
|
|
/// Returns true if the session has been converted to a domain, otherwise False
|
|
|
|
bool IsDomain() const {
|
|
|
|
return !domain_request_handlers.empty();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Converts the session to a domain at the end of the current command
|
|
|
|
void ConvertToDomain() {
|
|
|
|
convert_to_domain = true;
|
|
|
|
}
|
|
|
|
|
2016-12-05 08:02:08 -08:00
|
|
|
private:
|
|
|
|
ServerSession();
|
|
|
|
~ServerSession() override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
* @return The created server session
|
|
|
|
*/
|
2017-06-05 22:39:26 -07:00
|
|
|
static ResultVal<SharedPtr<ServerSession>> Create(std::string name = "Unknown");
|
2018-01-23 15:03:09 -08:00
|
|
|
|
2018-02-18 10:22:19 -08:00
|
|
|
/// Handles a SyncRequest to a domain, forwarding the request to the proper object or closing an
|
|
|
|
/// object handle.
|
|
|
|
ResultCode HandleDomainSyncRequest(Kernel::HLERequestContext& context);
|
|
|
|
|
2018-01-23 15:03:09 -08:00
|
|
|
/// When set to True, converts the session to a domain at the end of the command
|
|
|
|
bool convert_to_domain{};
|
2014-12-13 21:30:11 -08:00
|
|
|
};
|
2016-12-09 09:52:12 -08:00
|
|
|
|
2018-01-19 23:48:02 -08:00
|
|
|
} // namespace Kernel
|