summaryrefslogtreecommitdiffstats
path: root/src/core/hle/kernel/k_slab_heap.h
blob: 05c0bec9cb80e7c43b9d0a1bc34c610f1cca1576 (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
// Copyright 2020 yuzu Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.

#pragma once

#include <atomic>

#include "common/assert.h"
#include "common/common_funcs.h"
#include "common/common_types.h"

namespace Kernel {

class KernelCore;

namespace impl {

class KSlabHeapImpl final {
public:
    YUZU_NON_COPYABLE(KSlabHeapImpl);
    YUZU_NON_MOVEABLE(KSlabHeapImpl);

    struct Node {
        Node* next{};
    };

    constexpr KSlabHeapImpl() = default;
    constexpr ~KSlabHeapImpl() = default;

    void Initialize(std::size_t size) {
        ASSERT(head == nullptr);
        obj_size = size;
    }

    constexpr std::size_t GetObjectSize() const {
        return obj_size;
    }

    Node* GetHead() const {
        return head;
    }

    void* Allocate() {
        Node* ret = head.load();

        do {
            if (ret == nullptr) {
                break;
            }
        } while (!head.compare_exchange_weak(ret, ret->next));

        return ret;
    }

    void Free(void* obj) {
        Node* node = static_cast<Node*>(obj);

        Node* cur_head = head.load();
        do {
            node->next = cur_head;
        } while (!head.compare_exchange_weak(cur_head, node));
    }

private:
    std::atomic<Node*> head{};
    std::size_t obj_size{};
};

} // namespace impl

class KSlabHeapBase {
public:
    YUZU_NON_COPYABLE(KSlabHeapBase);
    YUZU_NON_MOVEABLE(KSlabHeapBase);

    constexpr KSlabHeapBase() = default;
    constexpr ~KSlabHeapBase() = default;

    constexpr bool Contains(uintptr_t addr) const {
        return start <= addr && addr < end;
    }

    constexpr std::size_t GetSlabHeapSize() const {
        return (end - start) / GetObjectSize();
    }

    constexpr std::size_t GetObjectSize() const {
        return impl.GetObjectSize();
    }

    constexpr uintptr_t GetSlabHeapAddress() const {
        return start;
    }

    std::size_t GetObjectIndexImpl(const void* obj) const {
        return (reinterpret_cast<uintptr_t>(obj) - start) / GetObjectSize();
    }

    std::size_t GetPeakIndex() const {
        return GetObjectIndexImpl(reinterpret_cast<const void*>(peak));
    }

    void* AllocateImpl() {
        return impl.Allocate();
    }

    void FreeImpl(void* obj) {
        // Don't allow freeing an object that wasn't allocated from this heap
        ASSERT(Contains(reinterpret_cast<uintptr_t>(obj)));

        impl.Free(obj);
    }

    void InitializeImpl(std::size_t obj_size, void* memory, std::size_t memory_size) {
        // Ensure we don't initialize a slab using null memory
        ASSERT(memory != nullptr);

        // Initialize the base allocator
        impl.Initialize(obj_size);

        // Set our tracking variables
        const std::size_t num_obj = (memory_size / obj_size);
        start = reinterpret_cast<uintptr_t>(memory);
        end = start + num_obj * obj_size;
        peak = start;

        // Free the objects
        u8* cur = reinterpret_cast<u8*>(end);

        for (std::size_t i{}; i < num_obj; i++) {
            cur -= obj_size;
            impl.Free(cur);
        }
    }

private:
    using Impl = impl::KSlabHeapImpl;

    Impl impl;
    uintptr_t peak{};
    uintptr_t start{};
    uintptr_t end{};
};

template <typename T>
class KSlabHeap final : public KSlabHeapBase {
public:
    enum class AllocationType {
        Host,
        Guest,
    };

    explicit constexpr KSlabHeap(AllocationType allocation_type_ = AllocationType::Host)
        : KSlabHeapBase(), allocation_type{allocation_type_} {}

    void Initialize(void* memory, std::size_t memory_size) {
        if (allocation_type == AllocationType::Guest) {
            InitializeImpl(sizeof(T), memory, memory_size);
        }
    }

    T* Allocate() {
        switch (allocation_type) {
        case AllocationType::Host:
            // Fallback for cases where we do not yet support allocating guest memory from the slab
            // heap, such as for kernel memory regions.
            return new T;

        case AllocationType::Guest:
            T* obj = static_cast<T*>(AllocateImpl());
            if (obj != nullptr) {
                new (obj) T();
            }
            return obj;
        }

        UNREACHABLE_MSG("Invalid AllocationType {}", allocation_type);
        return nullptr;
    }

    T* AllocateWithKernel(KernelCore& kernel) {
        switch (allocation_type) {
        case AllocationType::Host:
            // Fallback for cases where we do not yet support allocating guest memory from the slab
            // heap, such as for kernel memory regions.
            return new T(kernel);

        case AllocationType::Guest:
            T* obj = static_cast<T*>(AllocateImpl());
            if (obj != nullptr) {
                new (obj) T(kernel);
            }
            return obj;
        }

        UNREACHABLE_MSG("Invalid AllocationType {}", allocation_type);
        return nullptr;
    }

    void Free(T* obj) {
        switch (allocation_type) {
        case AllocationType::Host:
            // Fallback for cases where we do not yet support allocating guest memory from the slab
            // heap, such as for kernel memory regions.
            delete obj;
            return;

        case AllocationType::Guest:
            FreeImpl(obj);
            return;
        }

        UNREACHABLE_MSG("Invalid AllocationType {}", allocation_type);
    }

    constexpr std::size_t GetObjectIndex(const T* obj) const {
        return GetObjectIndexImpl(obj);
    }

private:
    const AllocationType allocation_type;
};

} // namespace Kernel