5eb057f422
Two kernel object should absolutely never have the same handle ID type. This can cause incorrect behavior when it comes to retrieving object types from the handle table. In this case it allows converting a WritableEvent into a ReadableEvent and vice-versa, which is undefined behavior, since the object types are not the same. This also corrects ClearEvent() to check both kernel types like the kernel itself does.
104 lines
2.5 KiB
C++
104 lines
2.5 KiB
C++
// Copyright 2018 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include <atomic>
|
|
#include <string>
|
|
|
|
#include <boost/smart_ptr/intrusive_ptr.hpp>
|
|
|
|
#include "common/common_types.h"
|
|
|
|
namespace Kernel {
|
|
|
|
class KernelCore;
|
|
|
|
using Handle = u32;
|
|
|
|
enum class HandleType : u32 {
|
|
Unknown,
|
|
WritableEvent,
|
|
ReadableEvent,
|
|
SharedMemory,
|
|
Thread,
|
|
Process,
|
|
AddressArbiter,
|
|
Timer,
|
|
ResourceLimit,
|
|
ClientPort,
|
|
ServerPort,
|
|
ClientSession,
|
|
ServerSession,
|
|
};
|
|
|
|
enum class ResetType {
|
|
OneShot, ///< Reset automatically on object acquisition
|
|
Sticky, ///< Never reset automatically
|
|
Pulse, ///< Reset automatically on wakeup
|
|
};
|
|
|
|
class Object : NonCopyable {
|
|
public:
|
|
explicit Object(KernelCore& kernel);
|
|
virtual ~Object();
|
|
|
|
/// Returns a unique identifier for the object. For debugging purposes only.
|
|
u32 GetObjectId() const {
|
|
return object_id.load(std::memory_order_relaxed);
|
|
}
|
|
|
|
virtual std::string GetTypeName() const {
|
|
return "[BAD KERNEL OBJECT TYPE]";
|
|
}
|
|
virtual std::string GetName() const {
|
|
return "[UNKNOWN KERNEL OBJECT]";
|
|
}
|
|
virtual HandleType GetHandleType() const = 0;
|
|
|
|
/**
|
|
* Check if a thread can wait on the object
|
|
* @return True if a thread can wait on the object, otherwise false
|
|
*/
|
|
bool IsWaitable() const;
|
|
|
|
protected:
|
|
/// The kernel instance this object was created under.
|
|
KernelCore& kernel;
|
|
|
|
private:
|
|
friend void intrusive_ptr_add_ref(Object*);
|
|
friend void intrusive_ptr_release(Object*);
|
|
|
|
std::atomic<u32> ref_count{0};
|
|
std::atomic<u32> object_id{0};
|
|
};
|
|
|
|
// Special functions used by boost::instrusive_ptr to do automatic ref-counting
|
|
inline void intrusive_ptr_add_ref(Object* object) {
|
|
object->ref_count.fetch_add(1, std::memory_order_relaxed);
|
|
}
|
|
|
|
inline void intrusive_ptr_release(Object* object) {
|
|
if (object->ref_count.fetch_sub(1, std::memory_order_acq_rel) == 1) {
|
|
delete object;
|
|
}
|
|
}
|
|
|
|
template <typename T>
|
|
using SharedPtr = boost::intrusive_ptr<T>;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
template <typename T>
|
|
inline SharedPtr<T> DynamicObjectCast(SharedPtr<Object> object) {
|
|
if (object != nullptr && object->GetHandleType() == T::HANDLE_TYPE) {
|
|
return boost::static_pointer_cast<T>(object);
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
} // namespace Kernel
|