Difference between revisions of "Unit Threads"

Revision as of 06:50, 24 November 2016

Description: Check if the sleep queue is empty, if not then decrement the first key. Note: Then check if the timeout queue is empty, if not then decrement the first key. If either key reaches zero, return success to indicate there are threads to be woken or threads whose timeout has expired. Finally check if the termination queue is empty, if not then decrement the first key. Items will be removed ?rom the termination queue by SchedulerReschedule.

@@ Line 381: / Line 381: @@
 | <code>THREAD_STATE_TERMINATED = 10;</code>
 | Thread has been terminated
+|-
+|}
+</div></div>
+<br />
+<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
+<div style="font-size: 14px; padding-left: 12px;">'''Thread name constants''' <code> THREAD_NAME_* </code></div>
+<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+{| class="wikitable" style="font-size: 14px; background: white;"
+|-
+| <code>THREAD_NAME_LENGTH = 256;</code>
+| Length of thread name
+|-
+|colspan="2"|&nbsp;
+|-
+| <code>IRQ_THREAD_NAME = 'IRQ';</code>
+| &nbsp;
+|-
+| <code>FIQ_THREAD_NAME = 'FIQ';</code>
+| &nbsp;
+|-
+| <code>SWI_THREAD_NAME = 'SWI';</code>
+| &nbsp;
+|-
+| <code>IDLE_THREAD_NAME = 'Idle';</code>
+| &nbsp;
+|-
+| <code>MAIN_THREAD_NAME = 'Main';</code>
+| &nbsp;
+|-
+| <code>TIMER_THREAD_NAME = 'Timer';</code>
+| &nbsp;
+|-
+| <code>WORKER_THREAD_NAME = 'Worker';</code>
+| &nbsp;
+|-
+| <code>RTL_THREAD_NAME = 'RTL Thread';</code>
+| &nbsp;
 |-
 |}

`LOCK_FLAG_NONE = $00000000;`
`LOCK_FLAG_IRQ = $00000001;`
`LOCK_FLAG_FIQ = $00000002;`
`LOCK_FLAG_IRQFIQ = $00000004;`

`MUTEX_FLAG_NONE = $00000000;`
`MUTEX_FLAG_RECURSIVE = $00000001;`

`CRITICAL_SECTION_STATE_UNLOCKED = 0;`
`CRITICAL_SECTION_STATE_LOCKED = 1;`

`SEMAPHORE_FLAG_NONE = LOCK_FLAG_NONE;`
`SEMAPHORE_FLAG_IRQ = LOCK_FLAG_IRQ;`
`SEMAPHORE_FLAG_FIQ = LOCK_FLAG_FIQ;`
`SEMAPHORE_FLAG_IRQFIQ = LOCK_FLAG_IRQFIQ;`

`SYNCHRONIZER_STATE_UNLOCKED = 0;`
`SYNCHRONIZER_STATE_READER_LOCKED = 1;`
`SYNCHRONIZER_STATE_WRITER_LOCKED = 2;`

`SYNCHRONIZER_FLAG_NONE = $00000000;`
`SYNCHRONIZER_FLAG_READ_PRIORITY = $00000001;`	Synchronizer prioritises readers over writers
`SYNCHRONIZER_FLAG_WRITE_PRIORITY = $00000002;`	Synchronizer prioritises writers over readers

`LIST_TYPE_NOT_SPECIFIED = 0;`	A generic thread list without a specific purpose
`LIST_TYPE_WAIT_SECTION = 1;`	A Critical Section Wait List
`LIST_TYPE_WAIT_SEMAPHORE = 2;`	A Semaphore Wait List
`LIST_TYPE_WAIT_SYNCHRONIZER = 3;`	A Synchronizer Wait List
`LIST_TYPE_WAIT_EVENT = 4;`	An Event Wait List
`LIST_TYPE_WAIT_THREAD = 5;`	A Thread Wait List
`LIST_TYPE_WAIT_MESSAGESLOT = 6;`	A Messageslot Wait List
`LIST_TYPE_WAIT_OTHER = 7;`	Another type of Wait List (Suitable for passing to ThreadWait/ThreadWaitEx/ThreadWaitMultiple/ThreadRelease)

`LIST_FLAG_NONE = LOCK_FLAG_NONE;`
`LIST_FLAG_IRQ = LOCK_FLAG_IRQ;`
`LIST_FLAG_FIQ = LOCK_FLAG_FIQ;`
`LIST_FLAG_IRQFIQ = LOCK_FLAG_IRQFIQ;`

`NONE = LOCK_FLAG_NONE;`
`QUEUE_FLAG_IRQ = LOCK_FLAG_IRQ;`
`QUEUE_FLAG_FIQ = LOCK_FLAG_FIQ;`
`QUEUE_FLAG_IRQFIQ = LOCK_FLAG_IRQFIQ;`
`QUEUE_FLAG_DESCENDING = $00000008;`
`QUEUE_FLAG_DELTA = $00000010;`

`SPIN_STATE_UNLOCKED = 0;`
`SPIN_STATE_LOCKED = 1;`

`MUTEX_STATE_UNLOCKED = 0;`
`MUTEX_STATE_LOCKED = 1;`

`QUEUE_KEY_NONE = Integer($7FFFFFFF);`	Null key value returned ?rom an empty Queue
`QUEUE_KEY_MAX = Integer($7FFFFFFE);`	Max key that can be ordered in a Queue
`QUEUE_KEY_MIN = Integer($80000000);`	Min key that can be ordered in a Queue

`THREAD_TYPE_NORMAL = 0;`	A Normal thread (No special case handling)
`THREAD_TYPE_IDLE = 1;`	An Idle thread (Used to calculate ultilization and provide an always ready thread)
`THREAD_TYPE_IRQ = 2;`	An IRQ thread (Used by the IRQ handler during interrupt time)
`THREAD_TYPE_FIQ = 3;`	An FIQ thread (Used by the FIQ handler during interrupt time)
`THREAD_TYPE_SWI = 4;`	A Software Interrupt (SWI) thread (Used by the SWI handler during a system call)

`THREAD_STATE_RUNNING = 1;`	Thread is currently running
`THREAD_STATE_READY = 2;`	Thread is on ready queue
`THREAD_STATE_SLEEP = 3;`	Thread is sleeping
`THREAD_STATE_SUSPENDED = 4;`	Thread is suspended
`THREAD_STATE_WAIT = 5;`	Thread is on a wait list
`THREAD_STATE_WAIT_TIMEOUT = 6;`	Thread is on a wait list with timeout
`THREAD_STATE_RECEIVE = 7;`	Thread is waiting to receive a message
`THREAD_STATE_RECEIVE_TIMEOUT = 8;`	Thread is waiting to receive a message with timeout
`THREAD_STATE_HALTED = 9;`	Thread has been halted (Due to an unhandled exception etc)
`THREAD_STATE_TERMINATED = 10;`	Thread has been terminated

`THREAD_NAME_LENGTH = 256;`	Length of thread name

`IRQ_THREAD_NAME = 'IRQ';`
`FIQ_THREAD_NAME = 'FIQ';`
`SWI_THREAD_NAME = 'SWI';`
`IDLE_THREAD_NAME = 'Idle';`
`MAIN_THREAD_NAME = 'Main';`
`TIMER_THREAD_NAME = 'Timer';`
`WORKER_THREAD_NAME = 'Worker';`
`RTL_THREAD_NAME = 'RTL Thread';`

InitialOwner	If true set the state of the spin to locked and the owner to the current thread
Return	Handle of new Spin entry or INVALID_HANDLE_VALUE if entry could not be created

Spin	Handle of Spin entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Spin	Handle of Spin entry to get owner for
Return	Handle of owning thread or INVALID_HANDLE_VALUE if not currently owned

Spin	Handle of Spin entry to lock
Return	ERROR_SUCCESS if completed or another error code on failure

Spin	Handle of Spin entry to unlock
Return	ERROR_SUCCESS if completed or another error code on failure

Spin	Handle of Spin entry to check
Return	True if the mask would enable IRQ on restore, False if it would not
Note	The Spin entry must be locked by the current thread

Spin1	Handle of first Spin entry
Spin2	Handle of second Spin entry
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Both Spin entries must be locked by the current thread

InitialOwner	If true set the state of the mutex to locked and the owner to the current thread
SpinCount	The number of times the mutex will spin before yielding (Always 0 if CPU count equals 1)
Flags	The flags for the Mutex entry (eg MUTEX_FLAG_RECURSIVE)
Return	Handle of new Mutex entry or INVALID_HANDLE_VALUE if entry could not be created

Difference between revisions of "Unit Threads"

Revision as of 06:50, 24 November 2016

Contents

Description

Constants

Type definitions

Public variables

Function declarations

Navigation menu

Search

Mutex	Handle of Mutex entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Mutex	Handle of Mutex entry to get flags for
Return	Current flags or INVALID_HANDLE_VALUE on error

Mutex	Handle of Mutex entry to lock
Return	ERROR_SUCCESS if completed or another error code on failure

Mutex	Handle of Mutex entry to unlock
Return	ERROR_SUCCESS if completed or another error code on failure

Mutex	Mutex to try to lock
Return	ERROR_SUCCESS if completed, ERROR_LOCKED if already locked or another error code on failure

Mutex	Mutex to get count for
Return	Current lock count or INVALID_HANDLE_VALUE on error
Note	Count is only valid if Flags includes MUTEX_FLAG_RECURSIVE

Mutex	Handle of Mutex entry to get owner for
Return	Handle of owning thread or INVALID_HANDLE_VALUE if not currently owned

CriticalSection	If true set the state of the criticalsection to locked and the owner to the current thread
SpinCount	The number of times the criticalsection will spin before waiting (Always 0 if CPU count equals 1)
Return	Handle of new CriticalSection entry or INVALID_HANDLE_VALUE if entry could not be created

CriticalSection	Handle of CriticalSection entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

CriticalSection	CriticalSection to get count for
Return	Current lock count or INVALID_HANDLE_VALUE on error