summaryrefslogtreecommitdiffstats
path: root/src/core/hle/service/cmif_serialization.h
diff options
context:
space:
mode:
authorLiam <byteslice@airmail.cc>2024-01-25 06:50:03 +0100
committerLiam <byteslice@airmail.cc>2024-01-25 20:35:51 +0100
commit01a2d978ebc24aa517048f941f53213db9de722e (patch)
tree989cb25197de378ae71c639e7dcd564d29630438 /src/core/hle/service/cmif_serialization.h
parentMerge pull request #12763 from liamwhite/fix-hbl-again (diff)
downloadyuzu-01a2d978ebc24aa517048f941f53213db9de722e.tar
yuzu-01a2d978ebc24aa517048f941f53213db9de722e.tar.gz
yuzu-01a2d978ebc24aa517048f941f53213db9de722e.tar.bz2
yuzu-01a2d978ebc24aa517048f941f53213db9de722e.tar.lz
yuzu-01a2d978ebc24aa517048f941f53213db9de722e.tar.xz
yuzu-01a2d978ebc24aa517048f941f53213db9de722e.tar.zst
yuzu-01a2d978ebc24aa517048f941f53213db9de722e.zip
Diffstat (limited to 'src/core/hle/service/cmif_serialization.h')
-rw-r--r--src/core/hle/service/cmif_serialization.h337
1 files changed, 337 insertions, 0 deletions
diff --git a/src/core/hle/service/cmif_serialization.h b/src/core/hle/service/cmif_serialization.h
new file mode 100644
index 000000000..8e8cf2507
--- /dev/null
+++ b/src/core/hle/service/cmif_serialization.h
@@ -0,0 +1,337 @@
+// SPDX-FileCopyrightText: Copyright 2024 yuzu Emulator Project
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "common/div_ceil.h"
+
+#include "core/hle/service/cmif_types.h"
+#include "core/hle/service/ipc_helpers.h"
+#include "core/hle/service/service.h"
+
+namespace Service {
+
+// clang-format off
+struct RequestLayout {
+ u32 copy_handle_count;
+ u32 move_handle_count;
+ u32 cmif_raw_data_size;
+ u32 domain_interface_count;
+};
+
+template <ArgumentType Type1, ArgumentType Type2, typename MethodArguments, size_t PrevAlign = 1, size_t DataOffset = 0, size_t ArgIndex = 0>
+constexpr u32 GetArgumentRawDataSize() {
+ if constexpr (ArgIndex >= std::tuple_size_v<MethodArguments>) {
+ return static_cast<u32>(DataOffset);
+ } else {
+ using ArgType = std::tuple_element_t<ArgIndex, MethodArguments>;
+
+ if constexpr (ArgumentTraits<ArgType>::Type == Type1 || ArgumentTraits<ArgType>::Type == Type2) {
+ constexpr size_t ArgAlign = alignof(ArgType);
+ constexpr size_t ArgSize = sizeof(ArgType);
+
+ static_assert(PrevAlign <= ArgAlign, "Input argument is not ordered by alignment");
+
+ constexpr size_t ArgOffset = Common::AlignUp(DataOffset, ArgAlign);
+ constexpr size_t ArgEnd = ArgOffset + ArgSize;
+
+ return GetArgumentRawDataSize<Type1, Type2, MethodArguments, ArgAlign, ArgEnd, ArgIndex + 1>();
+ } else {
+ return GetArgumentRawDataSize<Type1, Type2, MethodArguments, PrevAlign, DataOffset, ArgIndex + 1>();
+ }
+ }
+}
+
+template <ArgumentType DataType, typename MethodArguments, size_t ArgCount = 0, size_t ArgIndex = 0>
+constexpr u32 GetArgumentTypeCount() {
+ if constexpr (ArgIndex >= std::tuple_size_v<MethodArguments>) {
+ return static_cast<u32>(ArgCount);
+ } else {
+ using ArgType = std::tuple_element_t<ArgIndex, MethodArguments>;
+
+ if constexpr (ArgumentTraits<ArgType>::Type == DataType) {
+ return GetArgumentTypeCount<DataType, MethodArguments, ArgCount + 1, ArgIndex + 1>();
+ } else {
+ return GetArgumentTypeCount<DataType, MethodArguments, ArgCount, ArgIndex + 1>();
+ }
+ }
+}
+
+template <typename MethodArguments>
+constexpr RequestLayout GetNonDomainReplyInLayout() {
+ return RequestLayout{
+ .copy_handle_count = GetArgumentTypeCount<ArgumentType::InCopyHandle, MethodArguments>(),
+ .move_handle_count = 0,
+ .cmif_raw_data_size = GetArgumentRawDataSize<ArgumentType::InData, ArgumentType::InProcessId, MethodArguments>(),
+ .domain_interface_count = 0,
+ };
+}
+
+template <typename MethodArguments>
+constexpr RequestLayout GetDomainReplyInLayout() {
+ return RequestLayout{
+ .copy_handle_count = GetArgumentTypeCount<ArgumentType::InCopyHandle, MethodArguments>(),
+ .move_handle_count = 0,
+ .cmif_raw_data_size = GetArgumentRawDataSize<ArgumentType::InData, ArgumentType::InProcessId, MethodArguments>(),
+ .domain_interface_count = GetArgumentTypeCount<ArgumentType::InInterface, MethodArguments>(),
+ };
+}
+
+template <typename MethodArguments>
+constexpr RequestLayout GetNonDomainReplyOutLayout() {
+ return RequestLayout{
+ .copy_handle_count = GetArgumentTypeCount<ArgumentType::OutCopyHandle, MethodArguments>(),
+ .move_handle_count = GetArgumentTypeCount<ArgumentType::OutMoveHandle, MethodArguments>() + GetArgumentTypeCount<ArgumentType::OutInterface, MethodArguments>(),
+ .cmif_raw_data_size = GetArgumentRawDataSize<ArgumentType::OutData, ArgumentType::OutData, MethodArguments>(),
+ .domain_interface_count = 0,
+ };
+}
+
+template <typename MethodArguments>
+constexpr RequestLayout GetDomainReplyOutLayout() {
+ return RequestLayout{
+ .copy_handle_count = GetArgumentTypeCount<ArgumentType::OutCopyHandle, MethodArguments>(),
+ .move_handle_count = GetArgumentTypeCount<ArgumentType::OutMoveHandle, MethodArguments>(),
+ .cmif_raw_data_size = GetArgumentRawDataSize<ArgumentType::OutData, ArgumentType::OutData, MethodArguments>(),
+ .domain_interface_count = GetArgumentTypeCount<ArgumentType::OutInterface, MethodArguments>(),
+ };
+}
+
+template <bool Domain, typename MethodArguments>
+constexpr RequestLayout GetReplyInLayout() {
+ return Domain ? GetDomainReplyInLayout<MethodArguments>() : GetNonDomainReplyInLayout<MethodArguments>();
+}
+
+template <bool Domain, typename MethodArguments>
+constexpr RequestLayout GetReplyOutLayout() {
+ return Domain ? GetDomainReplyOutLayout<MethodArguments>() : GetNonDomainReplyOutLayout<MethodArguments>();
+}
+
+using OutTemporaryBuffers = std::array<Common::ScratchBuffer<u8>, 3>;
+
+template <bool Domain, typename MethodArguments, typename CallArguments, size_t PrevAlign = 1, size_t DataOffset = 0, size_t HandleIndex = 0, size_t InBufferIndex = 0, size_t OutBufferIndex = 0, bool RawDataFinished = false, size_t ArgIndex = 0>
+void ReadInArgument(CallArguments& args, const u8* raw_data, HLERequestContext& ctx, OutTemporaryBuffers& temp) {
+ if constexpr (ArgIndex >= std::tuple_size_v<CallArguments>) {
+ return;
+ } else {
+ using ArgType = std::tuple_element_t<ArgIndex, MethodArguments>;
+
+ if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::InData || ArgumentTraits<ArgType>::Type == ArgumentType::InProcessId) {
+ constexpr size_t ArgAlign = alignof(ArgType);
+ constexpr size_t ArgSize = sizeof(ArgType);
+
+ static_assert(PrevAlign <= ArgAlign, "Input argument is not ordered by alignment");
+ static_assert(!RawDataFinished, "All input interface arguments must appear after raw data");
+
+ constexpr size_t ArgOffset = Common::AlignUp(DataOffset, ArgAlign);
+ constexpr size_t ArgEnd = ArgOffset + ArgSize;
+
+ if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::InProcessId) {
+ // TODO: abort parsing if PID is not provided?
+ // TODO: validate against raw data value?
+ std::get<ArgIndex>(args).pid = ctx.GetPID();
+ } else {
+ std::memcpy(&std::get<ArgIndex>(args), raw_data + ArgOffset, ArgSize);
+ }
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, ArgAlign, ArgEnd, HandleIndex, InBufferIndex, OutBufferIndex, false, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::InInterface) {
+ constexpr size_t ArgAlign = alignof(u32);
+ constexpr size_t ArgSize = sizeof(u32);
+ constexpr size_t ArgOffset = Common::AlignUp(DataOffset, ArgAlign);
+ constexpr size_t ArgEnd = ArgOffset + ArgSize;
+
+ static_assert(Domain);
+ ASSERT(ctx.GetDomainMessageHeader().input_object_count > 0);
+
+ u32 value{};
+ std::memcpy(&value, raw_data + ArgOffset, ArgSize);
+ std::get<ArgIndex>(args) = ctx.GetDomainHandler<ArgType::Type>(value - 1);
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, ArgAlign, ArgEnd, HandleIndex, InBufferIndex, OutBufferIndex, true, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::InCopyHandle) {
+ std::get<ArgIndex>(args) = std::move(ctx.GetObjectFromHandle<typename ArgType::Type>(ctx.GetCopyHandle(HandleIndex)));
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, HandleIndex + 1, InBufferIndex, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::InLargeData) {
+ constexpr size_t BufferSize = sizeof(ArgType);
+
+ // Clear the existing data.
+ std::memset(&std::get<ArgIndex>(args), 0, BufferSize);
+
+ std::span<const u8> buffer{};
+
+ ASSERT(ctx.CanReadBuffer(InBufferIndex));
+ if constexpr (ArgType::Attr & BufferAttr_HipcAutoSelect) {
+ buffer = ctx.ReadBuffer(InBufferIndex);
+ } else if constexpr (ArgType::Attr & BufferAttr_HipcMapAlias) {
+ buffer = ctx.ReadBufferA(InBufferIndex);
+ } else /* if (ArgType::Attr & BufferAttr_HipcPointer) */ {
+ buffer = ctx.ReadBufferX(InBufferIndex);
+ }
+
+ std::memcpy(&std::get<ArgIndex>(args), buffer.data(), std::min(BufferSize, buffer.size()));
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, HandleIndex, InBufferIndex + 1, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::InBuffer) {
+ using ElementType = typename ArgType::Type;
+
+ std::span<const u8> buffer{};
+
+ if (ctx.CanReadBuffer(InBufferIndex)) {
+ if constexpr (ArgType::Attr & BufferAttr_HipcAutoSelect) {
+ buffer = ctx.ReadBuffer(InBufferIndex);
+ } else if constexpr (ArgType::Attr & BufferAttr_HipcMapAlias) {
+ buffer = ctx.ReadBufferA(InBufferIndex);
+ } else /* if (ArgType::Attr & BufferAttr_HipcPointer) */ {
+ buffer = ctx.ReadBufferX(InBufferIndex);
+ }
+ }
+
+ ElementType* ptr = (ElementType*) buffer.data();
+ size_t size = buffer.size() / sizeof(ElementType);
+
+ std::get<ArgIndex>(args) = std::span(ptr, size);
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, HandleIndex, InBufferIndex + 1, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutLargeData) {
+ constexpr size_t BufferSize = sizeof(ArgType);
+
+ // Clear the existing data.
+ std::memset(&std::get<ArgIndex>(args), 0, BufferSize);
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, HandleIndex, InBufferIndex, OutBufferIndex + 1, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutBuffer) {
+ using ElementType = typename ArgType::Type;
+
+ // Set up scratch buffer.
+ auto& buffer = temp[OutBufferIndex];
+ if (ctx.CanWriteBuffer(OutBufferIndex)) {
+ buffer.resize_destructive(ctx.GetWriteBufferSize(OutBufferIndex));
+ } else {
+ buffer.resize_destructive(0);
+ }
+
+ ElementType* ptr = (ElementType*) buffer.data();
+ size_t size = buffer.size() / sizeof(ElementType);
+
+ std::get<ArgIndex>(args) = std::span(ptr, size);
+
+ return ReadInArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, HandleIndex, InBufferIndex, OutBufferIndex + 1, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else {
+ return ReadInArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, HandleIndex, InBufferIndex, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ }
+ }
+}
+
+template <bool Domain, typename MethodArguments, typename CallArguments, size_t PrevAlign = 1, size_t DataOffset = 0, size_t OutBufferIndex = 0, bool RawDataFinished = false, size_t ArgIndex = 0>
+void WriteOutArgument(CallArguments& args, u8* raw_data, HLERequestContext& ctx, OutTemporaryBuffers& temp) {
+ if constexpr (ArgIndex >= std::tuple_size_v<CallArguments>) {
+ return;
+ } else {
+ using ArgType = std::tuple_element_t<ArgIndex, MethodArguments>;
+
+ if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutData) {
+ constexpr size_t ArgAlign = alignof(ArgType);
+ constexpr size_t ArgSize = sizeof(ArgType);
+
+ static_assert(PrevAlign <= ArgAlign, "Output argument is not ordered by alignment");
+ static_assert(!RawDataFinished, "All output interface arguments must appear after raw data");
+
+ constexpr size_t ArgOffset = Common::AlignUp(DataOffset, ArgAlign);
+ constexpr size_t ArgEnd = ArgOffset + ArgSize;
+
+ std::memcpy(raw_data + ArgOffset, &std::get<ArgIndex>(args), ArgSize);
+
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, ArgAlign, ArgEnd, OutBufferIndex, false, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutInterface) {
+ if constexpr (Domain) {
+ ctx.AddDomainObject(std::get<ArgIndex>(args));
+ } else {
+ ctx.AddMoveInterface(std::get<ArgIndex>(args));
+ }
+
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, OutBufferIndex, true, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutCopyHandle) {
+ ctx.AddCopyObject(std::get<ArgIndex>(args).GetPointerUnsafe());
+
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutMoveHandle) {
+ ctx.AddMoveObject(std::get<ArgIndex>(args).GetPointerUnsafe());
+
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutLargeData) {
+ constexpr size_t BufferSize = sizeof(ArgType);
+
+ ASSERT(ctx.CanWriteBuffer(OutBufferIndex));
+ if constexpr (ArgType::Attr & BufferAttr_HipcAutoSelect) {
+ ctx.WriteBuffer(std::get<ArgIndex>(args), OutBufferIndex);
+ } else if constexpr (ArgType::Attr & BufferAttr_HipcMapAlias) {
+ ctx.WriteBufferB(&std::get<ArgIndex>(args), BufferSize, OutBufferIndex);
+ } else /* if (ArgType::Attr & BufferAttr_HipcPointer) */ {
+ ctx.WriteBufferC(&std::get<ArgIndex>(args), BufferSize, OutBufferIndex);
+ }
+
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, OutBufferIndex + 1, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ } else if constexpr (ArgumentTraits<ArgType>::Type == ArgumentType::OutBuffer) {
+ auto& buffer = temp[OutBufferIndex];
+ const size_t size = buffer.size();
+
+ if (ctx.CanWriteBuffer(OutBufferIndex)) {
+ if constexpr (ArgType::Attr & BufferAttr_HipcAutoSelect) {
+ ctx.WriteBuffer(buffer.data(), size, OutBufferIndex);
+ } else if constexpr (ArgType::Attr & BufferAttr_HipcMapAlias) {
+ ctx.WriteBufferB(buffer.data(), size, OutBufferIndex);
+ } else /* if (ArgType::Attr & BufferAttr_HipcPointer) */ {
+ ctx.WriteBufferC(buffer.data(), size, OutBufferIndex);
+ }
+ }
+
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, OutBufferIndex + 1, RawDataFinished, ArgIndex + 1>( args, raw_data, ctx, temp);
+ } else {
+ return WriteOutArgument<Domain, MethodArguments, CallArguments, PrevAlign, DataOffset, OutBufferIndex, RawDataFinished, ArgIndex + 1>(args, raw_data, ctx, temp);
+ }
+ }
+}
+
+template <bool Domain, typename T, typename... A>
+void CmifReplyWrapImpl(HLERequestContext& ctx, T& t, Result (T::*f)(A...)) {
+ // Verify domain state.
+ if constexpr (Domain) {
+ ASSERT_MSG(ctx.GetManager()->IsDomain(), "Domain reply used on non-domain session");
+ } else {
+ ASSERT_MSG(!ctx.GetManager()->IsDomain(), "Non-domain reply used on domain session");
+ }
+
+ using MethodArguments = std::tuple<std::remove_reference_t<A>...>;
+
+ OutTemporaryBuffers buffers{};
+ auto call_arguments = std::tuple<typename RemoveOut<A>::Type...>();
+
+ // Read inputs.
+ const size_t offset_plus_command_id = ctx.GetDataPayloadOffset() + 2;
+ ReadInArgument<Domain, MethodArguments>(call_arguments, reinterpret_cast<u8*>(ctx.CommandBuffer() + offset_plus_command_id), ctx, buffers);
+
+ // Call.
+ const auto Callable = [&]<typename... CallArgs>(CallArgs&... args) {
+ return (t.*f)(args...);
+ };
+ const Result res = std::apply(Callable, call_arguments);
+
+ // Write result.
+ constexpr RequestLayout layout = GetReplyOutLayout<Domain, MethodArguments>();
+ IPC::ResponseBuilder rb{ctx, 2 + Common::DivCeil(layout.cmif_raw_data_size, sizeof(u32)), layout.copy_handle_count, layout.move_handle_count + layout.domain_interface_count};
+ rb.Push(res);
+
+ // Write out arguments.
+ WriteOutArgument<Domain, MethodArguments>(call_arguments, reinterpret_cast<u8*>(ctx.CommandBuffer() + rb.GetCurrentOffset()), ctx, buffers);
+}
+// clang-format on
+
+template <typename Self>
+template <bool Domain, auto F>
+inline void ServiceFramework<Self>::CmifReplyWrap(HLERequestContext& ctx) {
+ return CmifReplyWrapImpl<Domain>(ctx, *static_cast<Self*>(this), F);
+}
+
+} // namespace Service