413 lines
13 KiB
C++
413 lines
13 KiB
C++
// Copyright 2016 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include <array>
|
|
#include <tuple>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
#include "core/hle/ipc.h"
|
|
#include "core/hle/kernel/client_port.h"
|
|
#include "core/hle/kernel/client_session.h"
|
|
#include "core/hle/kernel/handle_table.h"
|
|
#include "core/hle/kernel/hle_ipc.h"
|
|
#include "core/hle/kernel/kernel.h"
|
|
#include "core/hle/kernel/server_port.h"
|
|
|
|
namespace IPC {
|
|
|
|
class RequestHelperBase {
|
|
protected:
|
|
Kernel::HLERequestContext* context = nullptr;
|
|
u32* cmdbuf;
|
|
ptrdiff_t index = 0;
|
|
|
|
public:
|
|
explicit RequestHelperBase(u32* command_buffer) : cmdbuf(command_buffer) {}
|
|
|
|
explicit RequestHelperBase(Kernel::HLERequestContext& context)
|
|
: context(&context), cmdbuf(context.CommandBuffer()) {}
|
|
|
|
void Skip(unsigned size_in_words, bool set_to_null) {
|
|
if (set_to_null)
|
|
memset(cmdbuf + index, 0, size_in_words * sizeof(u32));
|
|
index += size_in_words;
|
|
}
|
|
|
|
/**
|
|
* Aligns the current position forward to a 16-byte boundary, padding with zeros.
|
|
*/
|
|
void AlignWithPadding() {
|
|
if (index & 3) {
|
|
Skip(4 - (index & 3), true);
|
|
}
|
|
}
|
|
|
|
unsigned GetCurrentOffset() const {
|
|
return static_cast<unsigned>(index);
|
|
}
|
|
|
|
void SetCurrentOffset(unsigned offset) {
|
|
index = static_cast<ptrdiff_t>(offset);
|
|
}
|
|
};
|
|
|
|
class ResponseBuilder : public RequestHelperBase {
|
|
public:
|
|
/// Flags used for customizing the behavior of ResponseBuilder
|
|
enum class Flags : u32 {
|
|
None = 0,
|
|
/// Uses move handles to move objects in the response, even when in a domain. This is
|
|
/// required when PushMoveObjects is used.
|
|
AlwaysMoveHandles = 1,
|
|
};
|
|
|
|
explicit ResponseBuilder(u32* command_buffer) : RequestHelperBase(command_buffer) {}
|
|
|
|
explicit ResponseBuilder(Kernel::HLERequestContext& context, u32 normal_params_size,
|
|
u32 num_handles_to_copy = 0, u32 num_objects_to_move = 0,
|
|
Flags flags = Flags::None)
|
|
|
|
: RequestHelperBase(context), normal_params_size(normal_params_size),
|
|
num_handles_to_copy(num_handles_to_copy), num_objects_to_move(num_objects_to_move) {
|
|
|
|
memset(cmdbuf, 0, sizeof(u32) * IPC::COMMAND_BUFFER_LENGTH);
|
|
|
|
context.ClearIncomingObjects();
|
|
|
|
IPC::CommandHeader header{};
|
|
|
|
// The entire size of the raw data section in u32 units, including the 16 bytes of mandatory
|
|
// padding.
|
|
u32 raw_data_size = sizeof(IPC::DataPayloadHeader) / 4 + 4 + normal_params_size;
|
|
|
|
u32 num_handles_to_move{};
|
|
u32 num_domain_objects{};
|
|
const bool always_move_handles{
|
|
(static_cast<u32>(flags) & static_cast<u32>(Flags::AlwaysMoveHandles)) != 0};
|
|
if (!context.Session()->IsDomain() || always_move_handles) {
|
|
num_handles_to_move = num_objects_to_move;
|
|
} else {
|
|
num_domain_objects = num_objects_to_move;
|
|
}
|
|
|
|
if (context.Session()->IsDomain()) {
|
|
raw_data_size += sizeof(DomainMessageHeader) / 4 + num_domain_objects;
|
|
}
|
|
|
|
header.data_size.Assign(raw_data_size);
|
|
if (num_handles_to_copy || num_handles_to_move) {
|
|
header.enable_handle_descriptor.Assign(1);
|
|
}
|
|
PushRaw(header);
|
|
|
|
if (header.enable_handle_descriptor) {
|
|
IPC::HandleDescriptorHeader handle_descriptor_header{};
|
|
handle_descriptor_header.num_handles_to_copy.Assign(num_handles_to_copy);
|
|
handle_descriptor_header.num_handles_to_move.Assign(num_handles_to_move);
|
|
PushRaw(handle_descriptor_header);
|
|
Skip(num_handles_to_copy + num_handles_to_move, true);
|
|
}
|
|
|
|
AlignWithPadding();
|
|
|
|
const bool request_has_domain_header{context.GetDomainMessageHeader() != nullptr};
|
|
if (context.Session()->IsDomain() && request_has_domain_header) {
|
|
IPC::DomainMessageHeader domain_header{};
|
|
domain_header.num_objects = num_domain_objects;
|
|
PushRaw(domain_header);
|
|
}
|
|
|
|
IPC::DataPayloadHeader data_payload_header{};
|
|
data_payload_header.magic = Common::MakeMagic('S', 'F', 'C', 'O');
|
|
PushRaw(data_payload_header);
|
|
|
|
datapayload_index = index;
|
|
}
|
|
|
|
template <class T>
|
|
void PushIpcInterface(std::shared_ptr<T> iface) {
|
|
if (context->Session()->IsDomain()) {
|
|
context->AddDomainObject(std::move(iface));
|
|
} else {
|
|
auto sessions = Kernel::ServerSession::CreateSessionPair(iface->GetServiceName());
|
|
auto server = std::get<Kernel::SharedPtr<Kernel::ServerSession>>(sessions);
|
|
auto client = std::get<Kernel::SharedPtr<Kernel::ClientSession>>(sessions);
|
|
iface->ClientConnected(server);
|
|
context->AddMoveObject(std::move(client));
|
|
}
|
|
}
|
|
|
|
template <class T, class... Args>
|
|
void PushIpcInterface(Args&&... args) {
|
|
PushIpcInterface<T>(std::make_shared<T>(std::forward<Args>(args)...));
|
|
}
|
|
|
|
void ValidateHeader() {
|
|
const size_t num_domain_objects = context->NumDomainObjects();
|
|
const size_t num_move_objects = context->NumMoveObjects();
|
|
ASSERT_MSG(!num_domain_objects || !num_move_objects,
|
|
"cannot move normal handles and domain objects");
|
|
ASSERT_MSG((index - datapayload_index) == normal_params_size,
|
|
"normal_params_size value is incorrect");
|
|
ASSERT_MSG((num_domain_objects + num_move_objects) == num_objects_to_move,
|
|
"num_objects_to_move value is incorrect");
|
|
ASSERT_MSG(context->NumCopyObjects() == num_handles_to_copy,
|
|
"num_handles_to_copy value is incorrect");
|
|
}
|
|
|
|
// Validate on destruction, as there shouldn't be any case where we don't want it
|
|
~ResponseBuilder() {
|
|
ValidateHeader();
|
|
}
|
|
|
|
template <typename T>
|
|
void Push(T value);
|
|
|
|
template <typename First, typename... Other>
|
|
void Push(const First& first_value, const Other&... other_values);
|
|
|
|
/**
|
|
* Helper function for pushing strongly-typed enumeration values.
|
|
*
|
|
* @tparam Enum The enumeration type to be pushed
|
|
*
|
|
* @param value The value to push.
|
|
*
|
|
* @note The underlying size of the enumeration type is the size of the
|
|
* data that gets pushed. e.g. "enum class SomeEnum : u16" will
|
|
* push a u16-sized amount of data.
|
|
*/
|
|
template <typename Enum>
|
|
void PushEnum(Enum value) {
|
|
static_assert(std::is_enum_v<Enum>, "T must be an enum type within a PushEnum call.");
|
|
static_assert(!std::is_convertible_v<Enum, int>,
|
|
"enum type in PushEnum must be a strongly typed enum.");
|
|
Push(static_cast<std::underlying_type_t<Enum>>(value));
|
|
}
|
|
|
|
/**
|
|
* @brief Copies the content of the given trivially copyable class to the buffer as a normal
|
|
* param
|
|
* @note: The input class must be correctly packed/padded to fit hardware layout.
|
|
*/
|
|
template <typename T>
|
|
void PushRaw(const T& value);
|
|
|
|
template <typename... O>
|
|
void PushMoveObjects(Kernel::SharedPtr<O>... pointers);
|
|
|
|
template <typename... O>
|
|
void PushCopyObjects(Kernel::SharedPtr<O>... pointers);
|
|
|
|
private:
|
|
u32 normal_params_size{};
|
|
u32 num_handles_to_copy{};
|
|
u32 num_objects_to_move{}; ///< Domain objects or move handles, context dependent
|
|
std::ptrdiff_t datapayload_index{};
|
|
};
|
|
|
|
/// Push ///
|
|
|
|
template <>
|
|
inline void ResponseBuilder::Push(u32 value) {
|
|
cmdbuf[index++] = value;
|
|
}
|
|
|
|
template <typename T>
|
|
void ResponseBuilder::PushRaw(const T& value) {
|
|
std::memcpy(cmdbuf + index, &value, sizeof(T));
|
|
index += (sizeof(T) + 3) / 4; // round up to word length
|
|
}
|
|
|
|
template <>
|
|
inline void ResponseBuilder::Push(ResultCode value) {
|
|
// Result codes are actually 64-bit in the IPC buffer, but only the high part is discarded.
|
|
Push(value.raw);
|
|
Push<u32>(0);
|
|
}
|
|
|
|
template <>
|
|
inline void ResponseBuilder::Push(u8 value) {
|
|
PushRaw(value);
|
|
}
|
|
|
|
template <>
|
|
inline void ResponseBuilder::Push(u16 value) {
|
|
PushRaw(value);
|
|
}
|
|
|
|
template <>
|
|
inline void ResponseBuilder::Push(u64 value) {
|
|
Push(static_cast<u32>(value));
|
|
Push(static_cast<u32>(value >> 32));
|
|
}
|
|
|
|
template <>
|
|
inline void ResponseBuilder::Push(bool value) {
|
|
Push(static_cast<u8>(value));
|
|
}
|
|
|
|
template <typename First, typename... Other>
|
|
void ResponseBuilder::Push(const First& first_value, const Other&... other_values) {
|
|
Push(first_value);
|
|
Push(other_values...);
|
|
}
|
|
|
|
template <typename... O>
|
|
inline void ResponseBuilder::PushCopyObjects(Kernel::SharedPtr<O>... pointers) {
|
|
auto objects = {pointers...};
|
|
for (auto& object : objects) {
|
|
context->AddCopyObject(std::move(object));
|
|
}
|
|
}
|
|
|
|
template <typename... O>
|
|
inline void ResponseBuilder::PushMoveObjects(Kernel::SharedPtr<O>... pointers) {
|
|
auto objects = {pointers...};
|
|
for (auto& object : objects) {
|
|
context->AddMoveObject(std::move(object));
|
|
}
|
|
}
|
|
|
|
class RequestParser : public RequestHelperBase {
|
|
public:
|
|
explicit RequestParser(u32* command_buffer) : RequestHelperBase(command_buffer) {}
|
|
|
|
explicit RequestParser(Kernel::HLERequestContext& context) : RequestHelperBase(context) {
|
|
ASSERT_MSG(context.GetDataPayloadOffset(), "context is incomplete");
|
|
Skip(context.GetDataPayloadOffset(), false);
|
|
// Skip the u64 command id, it's already stored in the context
|
|
static constexpr u32 CommandIdSize = 2;
|
|
Skip(CommandIdSize, false);
|
|
}
|
|
|
|
ResponseBuilder MakeBuilder(u32 normal_params_size, u32 num_handles_to_copy,
|
|
u32 num_handles_to_move,
|
|
ResponseBuilder::Flags flags = ResponseBuilder::Flags::None) const {
|
|
return ResponseBuilder{*context, normal_params_size, num_handles_to_copy,
|
|
num_handles_to_move, flags};
|
|
}
|
|
|
|
template <typename T>
|
|
T Pop();
|
|
|
|
template <typename T>
|
|
void Pop(T& value);
|
|
|
|
template <typename First, typename... Other>
|
|
void Pop(First& first_value, Other&... other_values);
|
|
|
|
template <typename T>
|
|
T PopEnum() {
|
|
static_assert(std::is_enum_v<T>, "T must be an enum type within a PopEnum call.");
|
|
static_assert(!std::is_convertible_v<T, int>,
|
|
"enum type in PopEnum must be a strongly typed enum.");
|
|
return static_cast<T>(Pop<std::underlying_type_t<T>>());
|
|
}
|
|
|
|
/**
|
|
* @brief Reads the next normal parameters as a struct, by copying it
|
|
* @note: The output class must be correctly packed/padded to fit hardware layout.
|
|
*/
|
|
template <typename T>
|
|
void PopRaw(T& value);
|
|
|
|
/**
|
|
* @brief Reads the next normal parameters as a struct, by copying it into a new value
|
|
* @note: The output class must be correctly packed/padded to fit hardware layout.
|
|
*/
|
|
template <typename T>
|
|
T PopRaw();
|
|
|
|
template <typename T>
|
|
Kernel::SharedPtr<T> GetMoveObject(size_t index);
|
|
|
|
template <typename T>
|
|
Kernel::SharedPtr<T> GetCopyObject(size_t index);
|
|
|
|
template <class T>
|
|
std::shared_ptr<T> PopIpcInterface() {
|
|
ASSERT(context->Session()->IsDomain());
|
|
ASSERT(context->GetDomainMessageHeader()->input_object_count > 0);
|
|
return context->GetDomainRequestHandler<T>(Pop<u32>() - 1);
|
|
}
|
|
};
|
|
|
|
/// Pop ///
|
|
|
|
template <>
|
|
inline u32 RequestParser::Pop() {
|
|
return cmdbuf[index++];
|
|
}
|
|
|
|
template <typename T>
|
|
void RequestParser::PopRaw(T& value) {
|
|
std::memcpy(&value, cmdbuf + index, sizeof(T));
|
|
index += (sizeof(T) + 3) / 4; // round up to word length
|
|
}
|
|
|
|
template <typename T>
|
|
T RequestParser::PopRaw() {
|
|
T value;
|
|
PopRaw(value);
|
|
return value;
|
|
}
|
|
|
|
template <>
|
|
inline u8 RequestParser::Pop() {
|
|
return PopRaw<u8>();
|
|
}
|
|
|
|
template <>
|
|
inline u16 RequestParser::Pop() {
|
|
return PopRaw<u16>();
|
|
}
|
|
|
|
template <>
|
|
inline u64 RequestParser::Pop() {
|
|
const u64 lsw = Pop<u32>();
|
|
const u64 msw = Pop<u32>();
|
|
return msw << 32 | lsw;
|
|
}
|
|
|
|
template <>
|
|
inline s64 RequestParser::Pop() {
|
|
return static_cast<s64>(Pop<u64>());
|
|
}
|
|
|
|
template <>
|
|
inline bool RequestParser::Pop() {
|
|
return Pop<u8>() != 0;
|
|
}
|
|
|
|
template <>
|
|
inline ResultCode RequestParser::Pop() {
|
|
return ResultCode{Pop<u32>()};
|
|
}
|
|
|
|
template <typename T>
|
|
void RequestParser::Pop(T& value) {
|
|
value = Pop<T>();
|
|
}
|
|
|
|
template <typename First, typename... Other>
|
|
void RequestParser::Pop(First& first_value, Other&... other_values) {
|
|
first_value = Pop<First>();
|
|
Pop(other_values...);
|
|
}
|
|
|
|
template <typename T>
|
|
Kernel::SharedPtr<T> RequestParser::GetMoveObject(size_t index) {
|
|
return context->GetMoveObject<T>(index);
|
|
}
|
|
|
|
template <typename T>
|
|
Kernel::SharedPtr<T> RequestParser::GetCopyObject(size_t index) {
|
|
return context->GetCopyObject<T>(index);
|
|
}
|
|
|
|
} // namespace IPC
|