summaryrefslogtreecommitdiffstats
path: root/src/core/hle/service/cmif_types.h
blob: b80028c19d358124f5b64fc02dbf827a0bc33c77 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
// SPDX-FileCopyrightText: Copyright 2024 yuzu Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#include <memory>

#include "common/common_funcs.h"
#include "common/common_types.h"
#include "core/hle/service/hle_ipc.h"

namespace Service {

// clang-format off
template <typename T>
class Out {
public:
    /* implicit */ Out(T& t) : raw(&t) {}
    ~Out() = default;

    T* Get() const {
        return raw;
    }

    T& operator*() {
        return *raw;
    }

private:
    T* raw;
};

template <typename T>
using SharedPointer = std::shared_ptr<T>;

struct ClientProcessId {
    explicit operator bool() const {
        return pid != 0;
    }

    const u64& operator*() const {
        return pid;
    }

    u64 pid;
};

using ClientAppletResourceUserId = ClientProcessId;

template <typename T>
class InCopyHandle : public Kernel::KScopedAutoObject<T> {
public:
    using Type = T;

    template <typename... Args>
    /* implicit */ InCopyHandle(Args&&... args) : Kernel::KScopedAutoObject<T>(std::forward<Args...>(args)...) {}
    ~InCopyHandle() = default;

    InCopyHandle& operator=(InCopyHandle&& rhs) {
        Kernel::KScopedAutoObject<T>::operator=(std::move(rhs));
        return *this;
    }
};

template <typename T>
class OutCopyHandle : public Kernel::KScopedAutoObject<T> {
public:
    using Type = T;

    template <typename... Args>
    /* implicit */ OutCopyHandle(Args&&... args) : Kernel::KScopedAutoObject<T>(std::forward<Args...>(args)...) {}
    ~OutCopyHandle() = default;

    OutCopyHandle& operator=(OutCopyHandle&& rhs) {
        Kernel::KScopedAutoObject<T>::operator=(std::move(rhs));
        return *this;
    }
};

template <typename T>
class OutMoveHandle : public Kernel::KScopedAutoObject<T> {
public:
    using Type = T;

    template <typename... Args>
    /* implicit */ OutMoveHandle(Args&&... args) : Kernel::KScopedAutoObject<T>(std::forward<Args...>(args)...) {}
    ~OutMoveHandle() = default;

    OutMoveHandle& operator=(OutMoveHandle&& rhs) {
        Kernel::KScopedAutoObject<T>::operator=(std::move(rhs));
        return *this;
    }
};

enum BufferAttr : int {
    BufferAttr_In = (1U << 0),
    BufferAttr_Out = (1U << 1),
    BufferAttr_HipcMapAlias = (1U << 2),
    BufferAttr_HipcPointer = (1U << 3),
    BufferAttr_FixedSize = (1U << 4),
    BufferAttr_HipcAutoSelect = (1U << 5),
    BufferAttr_HipcMapTransferAllowsNonSecure = (1U << 6),
    BufferAttr_HipcMapTransferAllowsNonDevice = (1U << 7),
};

template <typename T, int A>
struct Buffer : public std::span<T> {
    static_assert(std::is_trivial_v<T>, "Buffer type must be trivial");
    static_assert((A & BufferAttr_FixedSize) == 0, "Buffer attr must not contain FixedSize");
    static_assert(((A & BufferAttr_In) == 0) ^ ((A & BufferAttr_Out) == 0), "Buffer attr must be In or Out");
    static constexpr BufferAttr Attr = static_cast<BufferAttr>(A);
    using Type = T;

    Buffer& operator=(const std::span<T>& rhs) {
        std::span<T>::operator=(rhs);
        return *this;
    }

    T& operator*() const {
        return *this->data();
    }

    explicit operator bool() const {
        return this->size() > 0;
    }
};

template <BufferAttr A>
using InBuffer = Buffer<const u8, BufferAttr_In | A>;

template <typename T, BufferAttr A>
using InArray = Buffer<T, BufferAttr_In | A>;

template <BufferAttr A>
using OutBuffer = Buffer<u8, BufferAttr_Out | A>;

template <typename T, BufferAttr A>
using OutArray = Buffer<T, BufferAttr_Out | A>;

template <typename T, int A>
struct LargeData : public T {
    static_assert(std::is_trivial_v<T>, "LargeData type must be trivial");
    static_assert((A & BufferAttr_FixedSize) != 0, "LargeData attr must contain FixedSize");
    static_assert(((A & BufferAttr_In) == 0) ^ ((A & BufferAttr_Out) == 0), "LargeData attr must be In or Out");
    static constexpr BufferAttr Attr = static_cast<BufferAttr>(A);
    using Type = T;
};

template <typename T, BufferAttr A>
using InLargeData = LargeData<T, BufferAttr_FixedSize | BufferAttr_In | A>;

template <typename T, BufferAttr A>
using OutLargeData = LargeData<T, BufferAttr_FixedSize | BufferAttr_Out | A>;

template <typename T>
struct RemoveOut {
    using Type = std::remove_reference_t<T>;
};

template <typename T>
struct RemoveOut<Out<T>> {
    using Type = T;
};

enum class ArgumentType {
    InProcessId,
    InData,
    InInterface,
    InCopyHandle,
    OutData,
    OutInterface,
    OutCopyHandle,
    OutMoveHandle,
    InBuffer,
    InLargeData,
    OutBuffer,
    OutLargeData,
};

template <typename T>
struct ArgumentTraits;

template <>
struct ArgumentTraits<ClientProcessId> {
    static constexpr ArgumentType Type = ArgumentType::InProcessId;
};

template <typename T>
struct ArgumentTraits<SharedPointer<T>> {
    static constexpr ArgumentType Type = ArgumentType::InInterface;
};

template <typename T>
struct ArgumentTraits<InCopyHandle<T>> {
    static constexpr ArgumentType Type = ArgumentType::InCopyHandle;
};

template <typename T>
struct ArgumentTraits<Out<SharedPointer<T>>> {
    static constexpr ArgumentType Type = ArgumentType::OutInterface;
};

template <typename T>
struct ArgumentTraits<Out<T>> {
    static constexpr ArgumentType Type = ArgumentType::OutData;
};

template <typename T>
struct ArgumentTraits<OutCopyHandle<T>> {
    static constexpr ArgumentType Type = ArgumentType::OutCopyHandle;
};

template <typename T>
struct ArgumentTraits<OutMoveHandle<T>> {
    static constexpr ArgumentType Type = ArgumentType::OutMoveHandle;
};

template <typename T, int A>
struct ArgumentTraits<Buffer<T, A>> {
    static constexpr ArgumentType Type = (A & BufferAttr_In) == 0 ? ArgumentType::OutBuffer : ArgumentType::InBuffer;
};

template <typename T, int A>
struct ArgumentTraits<LargeData<T, A>> {
    static constexpr ArgumentType Type = (A & BufferAttr_In) == 0 ? ArgumentType::OutLargeData : ArgumentType::InLargeData;
};

template <typename T>
struct ArgumentTraits {
    static constexpr ArgumentType Type = ArgumentType::InData;
};
// clang-format on

} // namespace Service