summaryrefslogtreecommitdiffstats
path: root/src/core/hle/kernel/kernel.cpp
blob: 615d7901a883fe35d8e151586baccedefed1781e (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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
// Copyright 2014 Citra Emulator Project
// Licensed under GPLv2 or any later version
// Refer to the license.txt file included.

#include <array>
#include <atomic>
#include <memory>
#include <mutex>
#include <utility>

#include "common/assert.h"
#include "common/logging/log.h"

#include "core/core.h"
#include "core/core_timing.h"
#include "core/hle/kernel/handle_table.h"
#include "core/hle/kernel/kernel.h"
#include "core/hle/kernel/process.h"
#include "core/hle/kernel/resource_limit.h"
#include "core/hle/kernel/thread.h"
#include "core/hle/kernel/timer.h"
#include "core/hle/lock.h"
#include "core/hle/result.h"

namespace Kernel {

/**
 * Callback that will wake up the thread it was scheduled for
 * @param thread_handle The handle of the thread that's been awoken
 * @param cycles_late The number of CPU cycles that have passed since the desired wakeup time
 */
static void ThreadWakeupCallback(u64 thread_handle, [[maybe_unused]] int cycles_late) {
    const auto proper_handle = static_cast<Handle>(thread_handle);
    auto& system = Core::System::GetInstance();

    // Lock the global kernel mutex when we enter the kernel HLE.
    std::lock_guard<std::recursive_mutex> lock(HLE::g_hle_lock);

    SharedPtr<Thread> thread =
        system.Kernel().RetrieveThreadFromWakeupCallbackHandleTable(proper_handle);
    if (thread == nullptr) {
        LOG_CRITICAL(Kernel, "Callback fired for invalid thread {:08X}", proper_handle);
        return;
    }

    bool resume = true;

    if (thread->status == ThreadStatus::WaitSynchAny ||
        thread->status == ThreadStatus::WaitSynchAll ||
        thread->status == ThreadStatus::WaitHLEEvent) {
        // Remove the thread from each of its waiting objects' waitlists
        for (auto& object : thread->wait_objects) {
            object->RemoveWaitingThread(thread.get());
        }
        thread->wait_objects.clear();

        // Invoke the wakeup callback before clearing the wait objects
        if (thread->wakeup_callback) {
            resume = thread->wakeup_callback(ThreadWakeupReason::Timeout, thread, nullptr, 0);
        }
    }

    if (thread->mutex_wait_address != 0 || thread->condvar_wait_address != 0 ||
        thread->wait_handle) {
        ASSERT(thread->status == ThreadStatus::WaitMutex);
        thread->mutex_wait_address = 0;
        thread->condvar_wait_address = 0;
        thread->wait_handle = 0;

        auto lock_owner = thread->lock_owner;
        // Threads waking up by timeout from WaitProcessWideKey do not perform priority inheritance
        // and don't have a lock owner unless SignalProcessWideKey was called first and the thread
        // wasn't awakened due to the mutex already being acquired.
        if (lock_owner) {
            lock_owner->RemoveMutexWaiter(thread);
        }
    }

    if (thread->arb_wait_address != 0) {
        ASSERT(thread->status == ThreadStatus::WaitArb);
        thread->arb_wait_address = 0;
    }

    if (resume) {
        thread->ResumeFromWait();
    }
}

/// The timer callback event, called when a timer is fired
static void TimerCallback(u64 timer_handle, int cycles_late) {
    const auto proper_handle = static_cast<Handle>(timer_handle);
    auto& system = Core::System::GetInstance();
    SharedPtr<Timer> timer = system.Kernel().RetrieveTimerFromCallbackHandleTable(proper_handle);

    if (timer == nullptr) {
        LOG_CRITICAL(Kernel, "Callback fired for invalid timer {:016X}", timer_handle);
        return;
    }

    timer->Signal(cycles_late);
}

struct KernelCore::Impl {
    void Initialize(KernelCore& kernel) {
        Shutdown();

        InitializeResourceLimits(kernel);
        InitializeThreads();
        InitializeTimers();
    }

    void Shutdown() {
        next_object_id = 0;
        next_process_id = 10;
        next_thread_id = 1;

        process_list.clear();

        handle_table.Clear();
        resource_limits.fill(nullptr);

        thread_wakeup_callback_handle_table.Clear();
        thread_wakeup_event_type = nullptr;

        timer_callback_handle_table.Clear();
        timer_callback_event_type = nullptr;
    }

    void InitializeResourceLimits(KernelCore& kernel) {
        // Create the four resource limits that the system uses
        // Create the APPLICATION resource limit
        SharedPtr<ResourceLimit> resource_limit = ResourceLimit::Create(kernel, "Applications");
        resource_limit->max_priority = 0x18;
        resource_limit->max_commit = 0x4000000;
        resource_limit->max_threads = 0x20;
        resource_limit->max_events = 0x20;
        resource_limit->max_mutexes = 0x20;
        resource_limit->max_semaphores = 0x8;
        resource_limit->max_timers = 0x8;
        resource_limit->max_shared_mems = 0x10;
        resource_limit->max_address_arbiters = 0x2;
        resource_limit->max_cpu_time = 0x1E;
        resource_limits[static_cast<u8>(ResourceLimitCategory::APPLICATION)] = resource_limit;

        // Create the SYS_APPLET resource limit
        resource_limit = ResourceLimit::Create(kernel, "System Applets");
        resource_limit->max_priority = 0x4;
        resource_limit->max_commit = 0x5E00000;
        resource_limit->max_threads = 0x1D;
        resource_limit->max_events = 0xB;
        resource_limit->max_mutexes = 0x8;
        resource_limit->max_semaphores = 0x4;
        resource_limit->max_timers = 0x4;
        resource_limit->max_shared_mems = 0x8;
        resource_limit->max_address_arbiters = 0x3;
        resource_limit->max_cpu_time = 0x2710;
        resource_limits[static_cast<u8>(ResourceLimitCategory::SYS_APPLET)] = resource_limit;

        // Create the LIB_APPLET resource limit
        resource_limit = ResourceLimit::Create(kernel, "Library Applets");
        resource_limit->max_priority = 0x4;
        resource_limit->max_commit = 0x600000;
        resource_limit->max_threads = 0xE;
        resource_limit->max_events = 0x8;
        resource_limit->max_mutexes = 0x8;
        resource_limit->max_semaphores = 0x4;
        resource_limit->max_timers = 0x4;
        resource_limit->max_shared_mems = 0x8;
        resource_limit->max_address_arbiters = 0x1;
        resource_limit->max_cpu_time = 0x2710;
        resource_limits[static_cast<u8>(ResourceLimitCategory::LIB_APPLET)] = resource_limit;

        // Create the OTHER resource limit
        resource_limit = ResourceLimit::Create(kernel, "Others");
        resource_limit->max_priority = 0x4;
        resource_limit->max_commit = 0x2180000;
        resource_limit->max_threads = 0xE1;
        resource_limit->max_events = 0x108;
        resource_limit->max_mutexes = 0x25;
        resource_limit->max_semaphores = 0x43;
        resource_limit->max_timers = 0x2C;
        resource_limit->max_shared_mems = 0x1F;
        resource_limit->max_address_arbiters = 0x2D;
        resource_limit->max_cpu_time = 0x3E8;
        resource_limits[static_cast<u8>(ResourceLimitCategory::OTHER)] = resource_limit;
    }

    void InitializeThreads() {
        thread_wakeup_event_type =
            CoreTiming::RegisterEvent("ThreadWakeupCallback", ThreadWakeupCallback);
    }

    void InitializeTimers() {
        timer_callback_handle_table.Clear();
        timer_callback_event_type = CoreTiming::RegisterEvent("TimerCallback", TimerCallback);
    }

    std::atomic<u32> next_object_id{0};
    // TODO(Subv): Start the process ids from 10 for now, as lower PIDs are
    // reserved for low-level services
    std::atomic<u32> next_process_id{10};
    std::atomic<u32> next_thread_id{1};

    // Lists all processes that exist in the current session.
    std::vector<SharedPtr<Process>> process_list;

    Kernel::HandleTable handle_table;
    std::array<SharedPtr<ResourceLimit>, 4> resource_limits;

    /// The event type of the generic timer callback event
    CoreTiming::EventType* timer_callback_event_type = nullptr;
    // TODO(yuriks): This can be removed if Timer objects are explicitly pooled in the future,
    // allowing us to simply use a pool index or similar.
    Kernel::HandleTable timer_callback_handle_table;

    CoreTiming::EventType* thread_wakeup_event_type = nullptr;
    // TODO(yuriks): This can be removed if Thread objects are explicitly pooled in the future,
    // allowing us to simply use a pool index or similar.
    Kernel::HandleTable thread_wakeup_callback_handle_table;
};

KernelCore::KernelCore() : impl{std::make_unique<Impl>()} {}
KernelCore::~KernelCore() {
    Shutdown();
}

void KernelCore::Initialize() {
    impl->Initialize(*this);
}

void KernelCore::Shutdown() {
    impl->Shutdown();
}

Kernel::HandleTable& KernelCore::HandleTable() {
    return impl->handle_table;
}

const Kernel::HandleTable& KernelCore::HandleTable() const {
    return impl->handle_table;
}

SharedPtr<ResourceLimit> KernelCore::ResourceLimitForCategory(
    ResourceLimitCategory category) const {
    return impl->resource_limits.at(static_cast<std::size_t>(category));
}

SharedPtr<Thread> KernelCore::RetrieveThreadFromWakeupCallbackHandleTable(Handle handle) const {
    return impl->thread_wakeup_callback_handle_table.Get<Thread>(handle);
}

SharedPtr<Timer> KernelCore::RetrieveTimerFromCallbackHandleTable(Handle handle) const {
    return impl->timer_callback_handle_table.Get<Timer>(handle);
}

void KernelCore::AppendNewProcess(SharedPtr<Process> process) {
    impl->process_list.push_back(std::move(process));
}

u32 KernelCore::CreateNewObjectID() {
    return impl->next_object_id++;
}

u32 KernelCore::CreateNewThreadID() {
    return impl->next_thread_id++;
}

u32 KernelCore::CreateNewProcessID() {
    return impl->next_process_id++;
}

ResultVal<Handle> KernelCore::CreateTimerCallbackHandle(const SharedPtr<Timer>& timer) {
    return impl->timer_callback_handle_table.Create(timer);
}

CoreTiming::EventType* KernelCore::ThreadWakeupCallbackEventType() const {
    return impl->thread_wakeup_event_type;
}

CoreTiming::EventType* KernelCore::TimerCallbackEventType() const {
    return impl->timer_callback_event_type;
}

Kernel::HandleTable& KernelCore::ThreadWakeupCallbackHandleTable() {
    return impl->thread_wakeup_callback_handle_table;
}

const Kernel::HandleTable& KernelCore::ThreadWakeupCallbackHandleTable() const {
    return impl->thread_wakeup_callback_handle_table;
}

} // namespace Kernel