|
|
@@ -4,26 +4,16 @@
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
-#include <algorithm>
|
|
|
-#include <array>
|
|
|
#include <cstddef>
|
|
|
#include <string>
|
|
|
-#include <vector>
|
|
|
+#include <utility>
|
|
|
#include <boost/smart_ptr/intrusive_ptr.hpp>
|
|
|
#include "common/common_types.h"
|
|
|
-#include "core/hle/result.h"
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
|
|
using Handle = u32;
|
|
|
|
|
|
-class Thread;
|
|
|
-
|
|
|
-enum KernelHandle : Handle {
|
|
|
- CurrentThread = 0xFFFF8000,
|
|
|
- CurrentProcess = 0xFFFF8001,
|
|
|
-};
|
|
|
-
|
|
|
enum class HandleType : u32 {
|
|
|
Unknown,
|
|
|
Event,
|
|
|
@@ -121,170 +111,17 @@ inline void intrusive_ptr_release(Object* object) {
|
|
|
template <typename T>
|
|
|
using SharedPtr = boost::intrusive_ptr<T>;
|
|
|
|
|
|
-/// Class that represents a Kernel object that a thread can be waiting on
|
|
|
-class WaitObject : public Object {
|
|
|
-public:
|
|
|
- /**
|
|
|
- * Check if the specified thread should wait until the object is available
|
|
|
- * @param thread The thread about which we're deciding.
|
|
|
- * @return True if the current thread should wait due to this object being unavailable
|
|
|
- */
|
|
|
- virtual bool ShouldWait(Thread* thread) const = 0;
|
|
|
-
|
|
|
- /// Acquire/lock the object for the specified thread if it is available
|
|
|
- virtual void Acquire(Thread* thread) = 0;
|
|
|
-
|
|
|
- /**
|
|
|
- * Add a thread to wait on this object
|
|
|
- * @param thread Pointer to thread to add
|
|
|
- */
|
|
|
- virtual void AddWaitingThread(SharedPtr<Thread> thread);
|
|
|
-
|
|
|
- /**
|
|
|
- * Removes a thread from waiting on this object (e.g. if it was resumed already)
|
|
|
- * @param thread Pointer to thread to remove
|
|
|
- */
|
|
|
- virtual void RemoveWaitingThread(Thread* thread);
|
|
|
-
|
|
|
- /**
|
|
|
- * Wake up all threads waiting on this object that can be awoken, in priority order,
|
|
|
- * and set the synchronization result and output of the thread.
|
|
|
- */
|
|
|
- virtual void WakeupAllWaitingThreads();
|
|
|
-
|
|
|
- /// Obtains the highest priority thread that is ready to run from this object's waiting list.
|
|
|
- SharedPtr<Thread> GetHighestPriorityReadyThread();
|
|
|
-
|
|
|
- /// Get a const reference to the waiting threads list for debug use
|
|
|
- const std::vector<SharedPtr<Thread>>& GetWaitingThreads() const;
|
|
|
-
|
|
|
-private:
|
|
|
- /// Threads waiting for this object to become available
|
|
|
- std::vector<SharedPtr<Thread>> waiting_threads;
|
|
|
-};
|
|
|
-
|
|
|
/**
|
|
|
- * This class allows the creation of Handles, which are references to objects that can be tested
|
|
|
- * for validity and looked up. Here they are used to pass references to kernel objects to/from the
|
|
|
- * emulated process. it has been designed so that it follows the same handle format and has
|
|
|
- * approximately the same restrictions as the handle manager in the CTR-OS.
|
|
|
- *
|
|
|
- * Handles contain two sub-fields: a slot index (bits 31:15) and a generation value (bits 14:0).
|
|
|
- * The slot index is used to index into the arrays in this class to access the data corresponding
|
|
|
- * to the Handle.
|
|
|
- *
|
|
|
- * To prevent accidental use of a freed Handle whose slot has already been reused, a global counter
|
|
|
- * is kept and incremented every time a Handle is created. This is the Handle's "generation". The
|
|
|
- * value of the counter is stored into the Handle as well as in the handle table (in the
|
|
|
- * "generations" array). When looking up a handle, the Handle's generation must match with the
|
|
|
- * value stored on the class, otherwise the Handle is considered invalid.
|
|
|
- *
|
|
|
- * To find free slots when allocating a Handle without needing to scan the entire object array, the
|
|
|
- * generations field of unallocated slots is re-purposed as a linked list of indices to free slots.
|
|
|
- * When a Handle is created, an index is popped off the list and used for the new Handle. When it
|
|
|
- * is destroyed, it is again pushed onto the list to be re-used by the next allocation. It is
|
|
|
- * likely that this allocation strategy differs from the one used in CTR-OS, but this hasn't been
|
|
|
- * verified and isn't likely to cause any problems.
|
|
|
+ * Attempts to downcast the given Object pointer to a pointer to T.
|
|
|
+ * @return Derived pointer to the object, or `nullptr` if `object` isn't of type T.
|
|
|
*/
|
|
|
-class HandleTable final : NonCopyable {
|
|
|
-public:
|
|
|
- HandleTable();
|
|
|
-
|
|
|
- /**
|
|
|
- * Allocates a handle for the given object.
|
|
|
- * @return The created Handle or one of the following errors:
|
|
|
- * - `ERR_OUT_OF_HANDLES`: the maximum number of handles has been exceeded.
|
|
|
- */
|
|
|
- ResultVal<Handle> Create(SharedPtr<Object> obj);
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a new handle that points to the same object as the passed in handle.
|
|
|
- * @return The duplicated Handle or one of the following errors:
|
|
|
- * - `ERR_INVALID_HANDLE`: an invalid handle was passed in.
|
|
|
- * - Any errors returned by `Create()`.
|
|
|
- */
|
|
|
- ResultVal<Handle> Duplicate(Handle handle);
|
|
|
-
|
|
|
- /**
|
|
|
- * Closes a handle, removing it from the table and decreasing the object's ref-count.
|
|
|
- * @return `RESULT_SUCCESS` or one of the following errors:
|
|
|
- * - `ERR_INVALID_HANDLE`: an invalid handle was passed in.
|
|
|
- */
|
|
|
- ResultCode Close(Handle handle);
|
|
|
-
|
|
|
- /// Checks if a handle is valid and points to an existing object.
|
|
|
- bool IsValid(Handle handle) const;
|
|
|
-
|
|
|
- /**
|
|
|
- * Looks up a handle.
|
|
|
- * @return Pointer to the looked-up object, or `nullptr` if the handle is not valid.
|
|
|
- */
|
|
|
- SharedPtr<Object> GetGeneric(Handle handle) const;
|
|
|
-
|
|
|
- /**
|
|
|
- * Looks up a handle while verifying its type.
|
|
|
- * @return Pointer to the looked-up object, or `nullptr` if the handle is not valid or its
|
|
|
- * type differs from the handle type `T::HANDLE_TYPE`.
|
|
|
- */
|
|
|
- template <class T>
|
|
|
- SharedPtr<T> Get(Handle handle) const {
|
|
|
- SharedPtr<Object> object = GetGeneric(handle);
|
|
|
- if (object != nullptr && object->GetHandleType() == T::HANDLE_TYPE) {
|
|
|
- return boost::static_pointer_cast<T>(std::move(object));
|
|
|
- }
|
|
|
- return nullptr;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Looks up a handle while verifying that it is an object that a thread can wait on
|
|
|
- * @return Pointer to the looked-up object, or `nullptr` if the handle is not valid or it is
|
|
|
- * not a waitable object.
|
|
|
- */
|
|
|
- SharedPtr<WaitObject> GetWaitObject(Handle handle) const {
|
|
|
- SharedPtr<Object> object = GetGeneric(handle);
|
|
|
- if (object != nullptr && object->IsWaitable()) {
|
|
|
- return boost::static_pointer_cast<WaitObject>(std::move(object));
|
|
|
- }
|
|
|
- return nullptr;
|
|
|
- }
|
|
|
-
|
|
|
- /// Closes all handles held in this table.
|
|
|
- void Clear();
|
|
|
-
|
|
|
-private:
|
|
|
- /**
|
|
|
- * This is the maximum limit of handles allowed per process in CTR-OS. It can be further
|
|
|
- * reduced by ExHeader values, but this is not emulated here.
|
|
|
- */
|
|
|
- static const size_t MAX_COUNT = 4096;
|
|
|
-
|
|
|
- static u16 GetSlot(Handle handle) {
|
|
|
- return handle >> 15;
|
|
|
- }
|
|
|
- static u16 GetGeneration(Handle handle) {
|
|
|
- return handle & 0x7FFF;
|
|
|
+template <typename T>
|
|
|
+inline SharedPtr<T> DynamicObjectCast(SharedPtr<Object> object) {
|
|
|
+ if (object != nullptr && object->GetHandleType() == T::HANDLE_TYPE) {
|
|
|
+ return boost::static_pointer_cast<T>(std::move(object));
|
|
|
}
|
|
|
-
|
|
|
- /// Stores the Object referenced by the handle or null if the slot is empty.
|
|
|
- std::array<SharedPtr<Object>, MAX_COUNT> objects;
|
|
|
-
|
|
|
- /**
|
|
|
- * The value of `next_generation` when the handle was created, used to check for validity. For
|
|
|
- * empty slots, contains the index of the next free slot in the list.
|
|
|
- */
|
|
|
- std::array<u16, MAX_COUNT> generations;
|
|
|
-
|
|
|
- /**
|
|
|
- * Global counter of the number of created handles. Stored in `generations` when a handle is
|
|
|
- * created, and wraps around to 1 when it hits 0x8000.
|
|
|
- */
|
|
|
- u16 next_generation;
|
|
|
-
|
|
|
- /// Head of the free slots linked list.
|
|
|
- u16 next_free_slot;
|
|
|
-};
|
|
|
-
|
|
|
-extern HandleTable g_handle_table;
|
|
|
+ return nullptr;
|
|
|
+}
|
|
|
|
|
|
/// Initialize the kernel with the specified system mode.
|
|
|
void Init(u32 system_mode);
|