diff --git a/alarm_8h_source.html b/alarm_8h_source.html index 94f2a82..3eae6cf 100644 --- a/alarm_8h_source.html +++ b/alarm_8h_source.html @@ -257,7 +257,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Cache synchronisation functions.
Equivalent to dcbf, sync, eieio.
Equivalent to dcbf.
+Does not perform sync, eieio like DCFlushRange.
Equivalent to dcbi instruction.
Equivalent to dcbst, sync, eieio.
Equivalent to dcbst.
+Does not perform sync, eieio like DCStoreRange.
Equivalent to dcbt instruction.
Equivalent to dcbz instruction.
Standard condition variable implementation.
+Similar to std::condition_variable.
Definition at line 18 of file condition.h.
+Definition at line 22 of file condition.h.
Definition at line 15 of file condition.h.
+Definition at line 19 of file condition.h.
Definition at line 16 of file condition.h.
+Definition at line 20 of file condition.h.
Initialise a condition variable structure.
Initialise a condition variable structure with a name.
Will wake up any threads waiting on the condition with OSWaitCond.
+Similar to std::condition_variable::notify_all.
Sleep the current thread until the condition variable has been signalled.
+The mutex must be locked when entering this function. Will unlock the mutex and then sleep, reacquiring the mutex when woken.
+Similar to std::condition_variable::wait.
Standard event object implementation. There are two supported event object modes, check OSEventMode.
+Similar to Windows Event Objects.
Enumerator | |
---|---|
OS_EVENT_MODE_MANUAL |
+ A manual event will only reset when OSResetEvent is called. |
OS_EVENT_MODE_AUTO |
+ An auto event will reset everytime a thread is woken. |
Initialise an event object with value and mode.
Initialise an event object with value, mode and name.
Resets the event object.
+Similar to ResetEvent.
Signals the event.
+If no threads are waiting the event value is set.
+If the event mode is OS_EVENT_MODE_MANUAL this will wake all waiting threads and the event will remain set until OSResetEvent is called.
+If the event mode is OS_EVENT_MODE_AUTO this will wake only one thread and the event will be reset immediately.
+Similar to SetEvent.
Signals all threads waiting on an event.
+If no threads are waiting the event value is set.
+If the event mode is OS_EVENT_MODE_MANUAL this will wake all waiting threads and the event will remain set until OSResetEvent is called.
+If the event mode is OS_EVENT_MODE_AUTO this will wake all waiting threads and the event will be reset.
Wait until an event is signalled.
+If the event is already set, this returns immediately.
+If the event mode is OS_EVENT_MODE_AUTO the event will be reset before returning from this method.
+Similar to WaitForSingleObject.
Wait until an event is signalled or a timeout has occurred.
+Similar to WaitForSingleObject.
Similar to OSMutex but tries to acquire the mutex without using the global scheduler lock, and does not test for thread cancel.
Definition at line 28 of file fastmutex.h.
+Definition at line 31 of file fastmutex.h.
Definition at line 17 of file fastmutex.h.
+Definition at line 20 of file fastmutex.h.
Definition at line 15 of file fastmutex.h.
+Definition at line 18 of file fastmutex.h.
Definition at line 16 of file fastmutex.h.
+Definition at line 19 of file fastmutex.h.
Standard mutex object, supports recursive locking.
+Similar to std::recursive_mutex.
Initialise a mutex structure.
Initialise a mutex structure with a name.
Lock the mutex.
+If no one owns the mutex, set current thread as owner.
+If the lock is owned by the current thread, increase the recursion count.
+If the lock is owned by another thread, the current thread will sleep until the owner has unlocked this mutex.
+Similar to std::recursive_mutex::lock.
Try to lock a mutex.
+If no one owns the mutex, set current thread as owner.
+If the lock is owned by the current thread, increase the recursion count.
+If the lock is owned by another thread, do not block, return FALSE.
+Similar to std::recursive_mutex::try_lock.
Unlocks the mutex.
+Will decrease the recursion count, will only unlock the mutex when the recursion count reaches 0.
+If any other threads are waiting to lock the mutex they will be woken.
+Similar to std::recursive_mutex::unlock.
Similar to Windows Semaphore Objects.
Definition at line 17 of file semaphore.h.
+Definition at line 19 of file semaphore.h.
Definition at line 15 of file semaphore.h.
+Definition at line 17 of file semaphore.h.
Get the current semaphore count.
Initialise semaphore object with count.
Initialise semaphore object with count and name.
Increase the semaphore value.
+If any threads are waiting for semaphore, they are woken.
Try to decrease the semaphore value.
+If the value is greater than zero then it will be decremented, else the function will return immediately with a value <= 0 indicating a failure.
+Decrease the semaphore value.
+If the value is less than or equal to zero the current thread will be put to sleep until the count is above zero and it can decrement it safely.
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.
Definition at line 40 of file thread.h.
+Definition at line 62 of file thread.h.
@@ -499,16 +508,20 @@ FunctionsThread is ready to run.
Thread is running.
Thread is waiting, i.e. on a mutex.
Thread is about to terminate.
Definition at line 31 of file thread.h.
+Definition at line 45 of file thread.h.
@@ -526,6 +539,8 @@ FunctionsCancels a thread.
+This sets the threads requestFlag to OS_THREAD_REQUEST_CANCEL, the thread will be terminated next time OSTestThreadCancel is called.
Returns the count of active threads.
Get the maximum amount of stack the thread has used.
Disable tracking of thread stack usage
Clears a thread's suspend counter and resumes it.
Create a new thread.
+thread | Thread to initialise. |
entry | Thread entry point. |
argc | argc argument passed to entry point. |
argv | argv argument passed to entry point. |
stack | Top of stack (highest address). |
stackSize | Size of stack. |
priority | Thread priority, 0 is highest priorty, 31 is lowest. |
attributes | Thread attributes, see OSThreadAttributes. |
Detach thread.
Exit the current thread with a exit code.
+This function is implicitly called when the thread entry point returns.
Get the next and previous thread in the thread's active queue.
Return pointer to OSThread object for the current thread.
Returns the default thread for a specific core.
+Each core has 1 default thread created before the game boots. The default thread for core 1 calls the RPX entry point, the default threads for core 0 and 2 are suspended and can be used with OSRunThread.
Return current stack pointer, value of r1 register.
Get a thread's affinity.
Get a thread's name.
Get a thread's base priority.
Get a thread's specific value set by OSSetThreadSpecific.
Returns TRUE if a thread is suspended.
Returns TRUE if a thread is terminated.
void OSPrintCurrentThreadState | -( | -) | -- |
Wait until thread is terminated.
+If the target thread is detached, returns FALSE.
+thread | Thread to wait for |
threadResult | Pointer to store thread exit value in. |
Resumes a thread.
+Decrements the thread's suspend counter, if the counter reaches 0 the thread is resumed.
+Run a function on an already created thread.
+Can only be used on idle threads.
Set a thread's affinity.
Set a thread's cancellation state.
+If the state is TRUE then the thread can be suspended or cancelled when OSTestThreadCancel is called.
Set the callback to be called just before a thread is terminated.
Set the callback to be called just after a thread is terminated.
Set a thread's name.
Set a thread's priority.
Set a thread's run quantum.
+This is the maximum amount of time the thread can run for before being forced to yield.
Set a thread specific value.
+Can be read with OSGetThreadSpecific.
Set thread stack usage tracking.
Sleep the current thread and add it to a thread queue.
+Will sleep until the thread queue is woken with OSWakeupThread.
Sleep the current thread for a period of time.
Suspend a thread.
+Increases a thread's suspend counter, if the counter is >0 then the thread is suspended.
+Check to see if the current thread should be cancelled or suspended.
+This is implicitly called in:
Wake up all threads in queue.
+Clears the thread queue.
Yield execution to waiting threads with same priority.
+This will never switch to a thread with a lower priority than the current thread.
Definition at line 20 of file condition.h.
+Definition at line 24 of file condition.h.
Name set by OSInitCondEx.
-Definition at line 26 of file condition.h.
+Definition at line 30 of file condition.h.
Queue of threads currently waiting on condition with OSWaitCond.
-Definition at line 31 of file condition.h.
+Definition at line 35 of file condition.h.
@@ -153,7 +153,7 @@ Data FieldsShould always be set to the value OS_CONDITION_TAG.
-Definition at line 23 of file condition.h.
+Definition at line 27 of file condition.h.
diff --git a/struct_o_s_context.html b/struct_o_s_context.html index 59f55c0..a9f2636 100644 --- a/struct_o_s_context.html +++ b/struct_o_s_context.html @@ -96,6 +96,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');Definition at line 33 of file event.h.
+The threads currently waiting on this event object with OSWaitEvent.
+ +Definition at line 30 of file fastmutex.h.
+Definition at line 33 of file fastmutex.h.
Definition at line 36 of file fastmutex.h.
+Definition at line 39 of file fastmutex.h.
Definition at line 33 of file fastmutex.h.
+Definition at line 36 of file fastmutex.h.
Definition at line 35 of file fastmutex.h.
+Definition at line 38 of file fastmutex.h.
Definition at line 32 of file fastmutex.h.
+Definition at line 35 of file fastmutex.h.
Definition at line 19 of file fastmutex.h.
+Definition at line 22 of file fastmutex.h.
Definition at line 21 of file fastmutex.h.
+Definition at line 24 of file fastmutex.h.
Definition at line 22 of file fastmutex.h.
+Definition at line 25 of file fastmutex.h.
Definition at line 19 of file semaphore.h.
+Definition at line 21 of file semaphore.h.
Definition at line 24 of file semaphore.h.
+Current count of semaphore.
+ +Definition at line 32 of file semaphore.h.
Definition at line 22 of file semaphore.h.
+Name set by OSInitMutexEx.
+ +Definition at line 27 of file semaphore.h.
Definition at line 25 of file semaphore.h.
+Queue of threads waiting on semaphore object with OSWaitSemaphore.
+ +Definition at line 35 of file semaphore.h.
Definition at line 21 of file semaphore.h.
+Should always be set to the value OS_SEMAPHORE_TAG.
+ +Definition at line 24 of file semaphore.h.
Definition at line 145 of file thread.h.
+Base priority of thread, 0 is highest priority, 31 is lowest priority.
+ +uint32_t cancelState | +BOOL cancelState |
Definition at line 163 of file thread.h.
+Called just before thread is terminated, set with OSSetThreadCleanupCallback.
+ +Definition at line 164 of file thread.h.
+Called just after a thread is terminated, set with OSSetThreadDeallocator.
+ +Definition at line 160 of file thread.h.
+Thread name, accessed with OSSetThreadName and OSGetThreadName.
+ +Definition at line 166 of file thread.h.
+Current thread request, used for cancelleing and suspending the thread.
+ +Definition at line 158 of file thread.h.
+Thread specific values, accessed with OSSetThreadSpecific and OSGetThreadSpecific.
+ +Definition at line 169 of file thread.h.
+Queue of threads waiting for a thread to be suspended.
+ +