rpcs3/rpcs3/Emu/CPU/CPUThread.h

#pragma once

#include "../Utilities/Thread.h"
#include "../Utilities/bit_set.h"

// CPU Thread Type (TODO: probably remove, use id and idm to classify threads)
enum class cpu_type : u8
{
	ppu, // PPU Thread
	spu, // SPU Thread
	arm, // ARMv7 Thread
};

// CPU Thread State flags (TODO: use u32 once cpu_type is removed)
enum class cpu_state : u16
{
	stop, // Thread not running (HLE, initial state)
	exit, // Irreversible exit
	suspend, // Thread paused
	ret, // Callback return requested
	signal, // Thread received a signal (HLE)

	dbg_global_pause, // Emulation paused
	dbg_global_stop, // Emulation stopped
	dbg_pause, // Thread paused
	dbg_step, // Thread forced to pause after one step (one instruction, etc)

	__bitset_enum_max
};

// CPU Thread State flags: pause state union
constexpr bs_t<cpu_state> cpu_state_pause = cpu_state::suspend + cpu_state::dbg_global_pause + cpu_state::dbg_pause;

class cpu_thread : public named_thread
{
	void on_task() override;

public:
	virtual void on_stop() override;
	virtual ~cpu_thread() override;

	const id_value<> id{};
	const cpu_type type;

	cpu_thread(cpu_type type);

	// Public thread state
	atomic_t<bs_t<cpu_state>> state{+cpu_state::stop};

	// Object associated with sleep state, possibly synchronization primitive (mutex, semaphore, etc.)
	atomic_t<void*> owner{};

	// Process thread state, return true if the checker must return
	bool check_state();

	// Run thread
	void run();

	virtual std::string dump() const = 0; // Print CPU state
	virtual void cpu_init() {} // Obsolete, must be removed
	virtual void cpu_task() = 0;
};

inline cpu_thread* get_current_cpu_thread() noexcept
{
	extern thread_local cpu_thread* g_tls_current_cpu_thread;

	return g_tls_current_cpu_thread;
}