Manage and run threads on each of the system's cores. More...

Collaboration diagram for Thread:

Data Structures
struct	OSThreadGHSExceptionHandling

struct	OSMutexQueue

struct	OSFastMutexQueue

struct	OSTLSSection

struct	OSThread

Macros
#define	OS_THREAD_TAG 0x74487244u

Typedefs
typedef struct OSFastMutex	OSFastMutex

typedef struct OSFastMutexQueue	OSFastMutexQueue

typedef struct OSMutex	OSMutex

typedef struct OSMutexQueue	OSMutexQueue

typedef struct OSThread	OSThread

typedef struct OSTLSSection	OSTLSSection

typedef struct OSThreadGHSExceptionHandling	OSThreadGHSExceptionHandling

typedef uint8_t	OSThreadState
	A value from enum OS_THREAD_STATE. More...

typedef uint32_t	OSThreadRequest
	A value from enum OS_THREAD_REQUEST. More...

typedef uint8_t	OSThreadAttributes
	A bitfield of enum OS_THREAD_ATTRIB. More...

typedef uint32_t	OSThreadType
	A bitfield of enum OS_THREAD_TYPE. More...

typedef int(*	OSThreadEntryPointFn) (int argc, const char **argv)

typedef void(*	OSThreadCleanupCallbackFn) (OSThread thread, void stack)

typedef void(*	OSThreadDeallocatorFn) (OSThread thread, void stack)

typedef enum OSThreadSpecificID	OSThreadSpecificID

Enumerations
enum	OSThreadSpecificID { OS_THREAD_SPECIFIC_0 = 0 , OS_THREAD_SPECIFIC_1 = 1 , OS_THREAD_SPECIFIC_2 = 2 , OS_THREAD_SPECIFIC_3 = 3 , OS_THREAD_SPECIFIC_4 = 4 , OS_THREAD_SPECIFIC_5 = 5 , OS_THREAD_SPECIFIC_6 = 6 , OS_THREAD_SPECIFIC_7 = 7 , OS_THREAD_SPECIFIC_8 = 8 , OS_THREAD_SPECIFIC_9 = 9 , OS_THREAD_SPECIFIC_10 = 10 , OS_THREAD_SPECIFIC_11 = 11 , OS_THREAD_SPECIFIC_12 = 12 , OS_THREAD_SPECIFIC_13 = 13 , OS_THREAD_SPECIFIC_WUT_RESERVED_0 = 14 , OS_THREAD_SPECIFIC_WUT_RESERVED_1 = 15 }

enum	OS_THREAD_STATE { OS_THREAD_STATE_NONE = 0 , OS_THREAD_STATE_READY = 1 << 0 , OS_THREAD_STATE_RUNNING = 1 << 1 , OS_THREAD_STATE_WAITING = 1 << 2 , OS_THREAD_STATE_MORIBUND = 1 << 3 }

enum	OS_THREAD_REQUEST { OS_THREAD_REQUEST_NONE = 0 , OS_THREAD_REQUEST_SUSPEND = 1 , OS_THREAD_REQUEST_CANCEL = 2 }

enum	OS_THREAD_ATTRIB { OS_THREAD_ATTRIB_AFFINITY_CPU0 = 1 << 0 , OS_THREAD_ATTRIB_AFFINITY_CPU1 = 1 << 1 , OS_THREAD_ATTRIB_AFFINITY_CPU2 = 1 << 2 , OS_THREAD_ATTRIB_AFFINITY_ANY = ((1 << 0) \| (1 << 1) \| (1 << 2)) , OS_THREAD_ATTRIB_DETACHED = 1 << 3 , OS_THREAD_ATTRIB_STACK_USAGE = 1 << 5 , OS_THREAD_ATTRIB_UNKNOWN = 1 << 7 }

enum	OS_THREAD_TYPE { OS_THREAD_TYPE_DRIVER = 0 , OS_THREAD_TYPE_IO = 1 , OS_THREAD_TYPE_APP = 2 }

Functions
void	OSCancelThread (OSThread *thread)
	Cancels a thread. More...

int32_t	OSCheckActiveThreads ()
	Returns the count of active threads. More...

int32_t	OSCheckThreadStackUsage (OSThread *thread)
	Get the maximum amount of stack the thread has used. More...

void	OSClearThreadStackUsage (OSThread *thread)
	Disable tracking of thread stack usage. More...

void	OSContinueThread (OSThread *thread)
	Clears a thread's suspend counter and resumes it. More...

BOOL	OSCreateThread (OSThread thread, OSThreadEntryPointFn entry, int32_t argc, char argv, void *stack, uint32_t stackSize, int32_t priority, OSThreadAttributes attributes)
	Create a new thread. More...

void	OSDetachThread (OSThread *thread)
	Detach thread. More...

void	OSExitThread (int32_t result)
	Exit the current thread with a exit code. More...

void	OSGetActiveThreadLink (OSThread thread, OSThreadLink link)
	Get the next and previous thread in the thread's active queue. More...

OSThread *	OSGetCurrentThread ()
	Return pointer to OSThread object for the current thread. More...

OSThread *	OSGetDefaultThread (uint32_t coreID)
	Returns the default thread for a specific core. More...

uint32_t	OSGetStackPointer ()
	Return current stack pointer, value of r1 register. More...

uint32_t	OSGetThreadAffinity (OSThread *thread)
	Get a thread's affinity. More...

const char *	OSGetThreadName (OSThread *thread)
	Get a thread's name. More...

int32_t	OSGetThreadPriority (OSThread *thread)
	Get a thread's base priority. More...

void *	OSGetThreadSpecific (OSThreadSpecificID id)
	Get a thread's specific value set by OSSetThreadSpecific. More...

BOOL	OSIsThreadSuspended (OSThread *thread)
	Returns TRUE if a thread is suspended. More...

BOOL	OSIsThreadTerminated (OSThread *thread)
	Returns TRUE if a thread is terminated. More...

BOOL	OSJoinThread (OSThread thread, int threadResult)
	Wait until thread is terminated. More...

int32_t	OSResumeThread (OSThread *thread)
	Resumes a thread. More...

BOOL	OSRunThread (OSThread thread, OSThreadEntryPointFn entry, int argc, const char *argv)
	Run a function on an already created thread. More...

BOOL	OSSetThreadAffinity (OSThread *thread, uint32_t affinity)
	Set a thread's affinity. More...

BOOL	OSSetThreadCancelState (BOOL state)
	Set a thread's cancellation state. More...

OSThreadCleanupCallbackFn	OSSetThreadCleanupCallback (OSThread *thread, OSThreadCleanupCallbackFn callback)
	Set the callback to be called just before a thread is terminated. More...

OSThreadDeallocatorFn	OSSetThreadDeallocator (OSThread *thread, OSThreadDeallocatorFn deallocator)
	Set the callback to be called just after a thread is terminated. More...

void	OSSetThreadName (OSThread thread, const char name)
	Set a thread's name. More...

BOOL	OSSetThreadPriority (OSThread *thread, int32_t priority)
	Set a thread's priority. More...

BOOL	OSSetThreadRunQuantum (OSThread *thread, uint32_t quantum)
	Set a thread's run quantum. More...

void	OSSetThreadSpecific (OSThreadSpecificID id, void *value)
	Set a thread specific value. More...

BOOL	OSSetThreadStackUsage (OSThread *thread)
	Set thread stack usage tracking. More...

void	OSSleepThread (OSThreadQueue *queue)
	Sleep the current thread and add it to a thread queue. More...

void	OSSleepTicks (OSTime ticks)
	Sleep the current thread for a period of time. More...

uint32_t	OSSuspendThread (OSThread *thread)
	Suspend a thread. More...

void	__OSSuspendThreadNolock (OSThread *thread)

void	OSTestThreadCancel ()
	Check to see if the current thread should be cancelled or suspended. More...

void	OSWakeupThread (OSThreadQueue *queue)
	Wake up all threads in queue. More...

void	OSYieldThread ()
	Yield execution to waiting threads with same priority. More...

Detailed Description

Manage and run threads on each of the system's cores.

The thread scheduler in the Wii U uses co-operative scheduling, this is different to the usual pre-emptive scheduling that most operating systems use (such as Windows, Linux, etc). In co-operative scheduling threads must voluntarily yield execution to other threads. In pre-emptive threads are switched by the operating system after an amount of time.

With the Wii U's scheduling model the thread with the highest priority which is in a non-waiting state will always be running (where 0 is the highest priority and 31 is the lowest). Execution will only switch to other threads once this thread has been forced to wait, such as when waiting to acquire a mutex, or when the thread voluntarily yields execution to other threads which have the same priority using OSYieldThread. OSYieldThread will never yield to a thread with lower priority than the current thread.

Data Structure Documentation

◆ OSThreadGHSExceptionHandling

struct OSThreadGHSExceptionHandling

Definition at line 135 of file thread.h.

Data Fields
void *	eh_globals
void *	eh_mem_manage[9]
void *	eh_store_globals[6]
void *	eh_store_globals_tdeh[76]

◆ OSMutexQueue

struct OSMutexQueue

Definition at line 149 of file thread.h.

Data Fields
OSMutex *	head
OSMutex *	tail
void *	parent

◆ OSFastMutexQueue

struct OSFastMutexQueue

Definition at line 161 of file thread.h.

Data Fields
OSFastMutex *	head
OSFastMutex *	tail

◆ OSTLSSection

struct OSTLSSection

Definition at line 170 of file thread.h.

Data Fields
void *	data

◆ OSThread

struct OSThread

Definition at line 180 of file thread.h.

Data Fields
OSContext	context
uint32_t	tag	Should always be set to the value OS_THREAD_TAG.
OSThreadState	state	Bitfield of OS_THREAD_STATE.
OSThreadAttributes	attr	Bitfield of OS_THREAD_ATTRIB.
uint16_t	id	Unique thread ID.
int32_t	suspendCounter	Suspend count (increased by OSSuspendThread).
int32_t	priority	Actual priority of thread.
int32_t	basePriority	Base priority of thread, 0 is highest priority, 31 is lowest priority.
int32_t	exitValue	Exit value.
OSThreadQueue *	coreRunQueue[3]	Core run queue stuff.
OSThreadLink	coreRunQueueLink[3]
OSThreadQueue *	queue	Queue the thread is currently waiting on.
OSThreadLink	link	Link used for thread queue.
OSThreadQueue	joinQueue	Queue of threads waiting to join this thread.
OSMutex *	mutex	Mutex this thread is waiting to lock.
OSMutexQueue	mutexQueue	Queue of mutexes this thread owns.
OSThreadLink	activeLink	Link for global active thread queue.
void *	stackStart	Stack start (top, highest address)
void *	stackEnd	Stack end (bottom, lowest address)
OSThreadEntryPointFn	entryPoint	Thread entry point.
OSThreadGHSExceptionHandling	ghsExceptionHandling	GHS Exception handling thread-specifics.
BOOL	alarmCancelled
void *	specific[0x10]	Thread specific values, accessed with OSSetThreadSpecific and OSGetThreadSpecific.
OSThreadType	type
const char *	name	Thread name, accessed with OSSetThreadName and OSGetThreadName.
OSAlarm *	waitEventTimeoutAlarm
void *	userStackPointer	The stack pointer passed in OSCreateThread.
OSThreadCleanupCallbackFn	cleanupCallback	Called just before thread is terminated, set with OSSetThreadCleanupCallback.
OSThreadDeallocatorFn	deallocator	Called just after a thread is terminated, set with OSSetThreadDeallocator.
BOOL	cancelState	If TRUE then a thread can be cancelled or suspended, set with OSSetThreadCancelState.
OSThreadRequest	requestFlag	Current thread request, used for cancelleing and suspending the thread.
int32_t	needSuspend	Pending suspend request count.
int32_t	suspendResult	Result of thread suspend.
OSThreadQueue	suspendQueue	Queue of threads waiting for a thread to be suspended.
int64_t	runQuantumTicks	How many ticks the thread should run for before suspension.
uint64_t	coreTimeConsumedNs	The total amount of core time consumed by this thread (Does not include time while Running)
uint64_t	wakeCount	The number of times this thread has been awoken.
OSTime	unk0x610
OSTime	unk0x618
OSTime	unk0x620
OSTime	unk0x628
OSExceptionCallbackFn	dsiCallback[3]	Callback for DSI exception.
OSExceptionCallbackFn	isiCallback[3]	Callback for ISI exception.
OSExceptionCallbackFn	programCallback[3]	Callback for Program exception.
OSExceptionCallbackFn	perfMonCallback[3]	Callback for PerfMon exception.
BOOL	stackSyncObjAllowed	Checks for synchronization objects placed on stack in debug mode when set to true.
uint16_t	tlsSectionCount	Number of TLS sections.
OSTLSSection *	tlsSections	TLS Sections.
OSFastMutex *	fastMutex	The fast mutex we are currently waiting for.
OSFastMutexQueue	contendedFastMutexes	The fast mutexes we are currently contended on.
OSFastMutexQueue	fastMutexQueue	The fast mutexes we currently own locks on.
OSExceptionCallbackFn	alignCallback[3]	Callback for Alignment exception.
uint32_t	reserved[5]	Cleared on thread creation but never used.

Macro Definition Documentation

◆ OS_THREAD_TAG

#define OS_THREAD_TAG 0x74487244u

Definition at line 178 of file thread.h.