Task Queue System - Revision history

LemonHaze: Added task destruction sample code

2021-12-31T21:34:48Z

Added task destruction sample code

@@ Line 91: / Line 91: @@
 A task controls how long it lives in its own callback function.<br>
 When a task wants to be destroyed it calls the subroutine 0x14049D660 (v1.07) during its own callback.<br>
 =Task parameter=

LemonHaze: Added task execution sample code

2021-12-31T21:23:15Z

Added task execution sample code

@@ Line 67: / Line 67: @@
 The main loop iterates through the task queue and calls the callback function with the optional parameter.<br>
 When the callback function returns the next task pointer is read from the current task and moved into the task queue address pointer.
 =Task cleanup (Destruction)=

PhilYeahz: /* Enqueue task */

2019-05-01T12:17:06Z

Enqueue task

← Older revision		Revision as of 13:17, 1 May 2019
Line 56:		Line 56:
	To enqueue an task with TASK data allocation the subroutine 0x14049DA10 (v1.07) needs to be called.<br>		To enqueue an task with TASK data allocation the subroutine 0x14049DA10 (v1.07) needs to be called.<br>
	<sub>		<sub>
	~~EnqueueTaskWithParameter~~(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t ~~parameterSize~~, uint32_t taskToken, char* debugTaskName)		EnqueueTaskWithData(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t dataSize, uint32_t taskToken, char* debugTaskName)
	</sub>		</sub>

PhilYeahz: /* Enqueue task */

2019-05-01T12:16:42Z

Enqueue task

← Older revision		Revision as of 13:16, 1 May 2019
Line 47:		Line 47:
	=Enqueue task=		=Enqueue task=

	==Enqueue task without ~~parameter~~==		==Enqueue task without TASK data allocation==
	To enqueue an task without ~~parameter~~ the subroutine 0x14049D890 (v1.07) needs to be called.		To enqueue an task without TASK data allocation the subroutine 0x14049D890 (v1.07) needs to be called.
	<sub>		<sub>
	EnqueueTask(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t taskToken)		EnqueueTask(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t taskToken)
	</sub>		</sub>

	==Enqueue task with ~~parameter~~==		==Enqueue task with TASK data allocation==
	To enqueue an task with ~~parameter~~ the subroutine 0x14049DA10 (v1.07) needs to be called.<br>		To enqueue an task with TASK data allocation the subroutine 0x14049DA10 (v1.07) needs to be called.<br>
	<sub>		<sub>
	EnqueueTaskWithParameter(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t parameterSize, uint32_t taskToken, char* debugTaskName)		EnqueueTaskWithParameter(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t parameterSize, uint32_t taskToken, char* debugTaskName)

PhilYeahz: /* Task memory structure */

2019-01-10T00:00:14Z

Task memory structure

← Older revision		Revision as of 01:00, 10 January 2019
Line 12:		Line 12:
	\| 0x0D \|\| 0x01 \|\| uint8_t \|\| Unknown value		\| 0x0D \|\| 0x01 \|\| uint8_t \|\| Unknown value
	\|-		\|-
	\| 0x10 \|\| 0x08 \|\| uint64_t* \|\| ~~Some~~ task pointer		\| 0x10 \|\| 0x08 \|\| uint64_t* \|\| Next task pointer
	\|-		\|-
	\| 0x18 \|\| 0x08 \|\| uint64_t* \|\| ~~Next~~ task ~~address~~		\| 0x18 \|\| 0x08 \|\| uint64_t* \|\| Some task pointer
	\|-		\|-
	\| 0x20 \|\| 0x08 \|\| uint64_t* \|\| ~~Task queue address~~ (at the moment of creation)		\| 0x20 \|\| 0x08 \|\| uint64_t* \|\| Current task pointer (at the moment of creation)
	\|-		\|-
	\| 0x28 \|\| 0x08 \|\| uint64_t* \|\| Some task ~~address~~		\| 0x28 \|\| 0x08 \|\| uint64_t* \|\| Some task pointer
	\|-		\|-
	\| 0x30 \|\| 0x08 \|\| uint64_t* \|\| ~~Unknown~~ pointer		\| 0x30 \|\| 0x08 \|\| uint64_t* \|\| Some task pointer
	\|-		\|-
	\| 0x38 \|\| 0x08 \|\| uint64_t* \|\| ~~Unknown~~ pointer		\| 0x38 \|\| 0x08 \|\| uint64_t* \|\| Some task pointer
	\|-		\|-
	\| 0x40 \|\| 0x08 \|\| uint64_t* \|\| ~~Unknown~~ pointer		\| 0x40 \|\| 0x08 \|\| uint64_t* \|\| Some task pointer
	\|-		\|-
	\| 0x48 \|\| 0x08 \|\| uint64_t* \|\| Unknown pointer		\| 0x48 \|\| 0x08 \|\| uint64_t* \|\| Unknown pointer

PhilYeahz: /* Task memory structure */

2019-01-09T21:53:35Z

Task memory structure

← Older revision		Revision as of 22:53, 9 January 2019
Line 18:		Line 18:
	\| 0x20 \|\| 0x08 \|\| uint64_t* \|\| Task queue address (at the moment of creation)		\| 0x20 \|\| 0x08 \|\| uint64_t* \|\| Task queue address (at the moment of creation)
	\|-		\|-
	\| 0x28 \|\| 0x08 \|\| uint64_t* \|\| ~~Unknown pointer~~		\| 0x28 \|\| 0x08 \|\| uint64_t* \|\| Some task address
	\|-		\|-
	\| 0x30 \|\| 0x08 \|\| uint64_t* \|\| Unknown pointer		\| 0x30 \|\| 0x08 \|\| uint64_t* \|\| Unknown pointer

PhilYeahz: /* Task memory structure */

2019-01-09T21:49:53Z

Task memory structure

← Older revision		Revision as of 22:49, 9 January 2019
Line 12:		Line 12:
	\| 0x0D \|\| 0x01 \|\| uint8_t \|\| Unknown value		\| 0x0D \|\| 0x01 \|\| uint8_t \|\| Unknown value
	\|-		\|-
	\| 0x10 \|\| 0x08 \|\| uint64_t* \|\| ~~Unknown~~ pointer		\| 0x10 \|\| 0x08 \|\| uint64_t* \|\| Some task pointer
	\|-		\|-
	\| 0x18 \|\| 0x08 \|\| uint64_t* \|\| Next task address		\| 0x18 \|\| 0x08 \|\| uint64_t* \|\| Next task address

PhilYeahz at 19:58, 9 January 2019

2019-01-09T19:58:42Z

← Older revision		Revision as of 20:58, 9 January 2019
Line 37:		Line 37:
	\|}		\|}

	=Task ~~Queue~~=		=Task queue=
	Task Queue Pointer Offset: 0x1481FFA50 (v1.07)<br>		Task Queue Pointer Offset: 0x1481FFA50 (v1.07)<br>
	At the start an ROOT task is created.<br>		At the start an ROOT task is created.<br>
Line 45:		Line 45:
	The ROOT task points to the first task as it's next task.<br>		The ROOT task points to the first task as it's next task.<br>

	=Enqueue ~~Task~~=		=Enqueue task=

	==Enqueue task without parameter==		==Enqueue task without parameter==
	To enqueue an task without parameter the subroutine 0x14049D890 (v1.07) needs to be called.		To enqueue an task without parameter the subroutine 0x14049D890 (v1.07) needs to be called.
			<sub>
			EnqueueTask(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t taskToken)
			</sub>

	==Enqueue task with parameter==		==Enqueue task with parameter==
	To enqueue an task with parameter the subroutine 0x14049DA10 (v1.07) needs to be called.		To enqueue an task with parameter the subroutine 0x14049DA10 (v1.07) needs to be called.<br>
			<sub>
			EnqueueTaskWithParameter(void* callbackFunction, uint8_t nextFunctionIndex, uint8_t a3, uint32_t parameterSize, uint32_t taskToken, char* debugTaskName)
			</sub>

	==Task creation==		=Task creation=
	During the enqueue process the task will be created with the given callback function.<br>		During the enqueue process the task will be created with the given callback function.<br>
	The callback function parameter, which is optional, is an pointer to an struct than can have any shape or size the callback function needs.		The callback function parameter, which is optional, is an pointer to an struct than can have any shape or size the callback function needs.<br>
			This parameter struct will be allocated inside the USE/fREe storage.

	=Task execution=		=Task execution=
	The main loop iterates through the task queue and calls the callback function with the optional parameter.<br>		The main loop iterates through the task queue and calls the callback function with the optional parameter.<br>
	When the callback function returns the next task pointer is read from the current task and moved into the task queue address pointer.		When the callback function returns the next task pointer is read from the current task and moved into the task queue address pointer.

			=Task cleanup (Destruction)=
			A task controls how long it lives in its own callback function.<br>
			When a task wants to be destroyed it calls the subroutine 0x14049D660 (v1.07) during its own callback.<br>

			=Task parameter=
			When a task gets enqueued with a parameter it will need to find some "fREe" storage in the USE/fREe storage.<br>

			==Storage entry==
			{\| class="wikitable"
			\|-
			! Position !! Length !! Type !! Description
			\|-
			\| 0x00 \|\| 0x04 \|\| string \|\| Task token (TASK)
			\|-
			\| 0x10 \|\| 0x08 \|\| uint64_t* \|\| Unknown pointer
			\|-
			\| 0x18 \|\| 0x08 \|\| uint64_t* \|\| Unknown pointer
			\|-
			\| 0x20 \|\| 0x04 \|\| string \|\| USE/fREe token
			\|-
			\| 0x40 \|\| 0x?? \|\| ? \|\| Storage data
			\|}

PhilYeahz: /* Task Queue */

2018-12-30T20:02:03Z

Task Queue

← Older revision		Revision as of 21:02, 30 December 2018
Line 40:		Line 40:
	Task Queue Pointer Offset: 0x1481FFA50 (v1.07)<br>		Task Queue Pointer Offset: 0x1481FFA50 (v1.07)<br>
	At the start an ROOT task is created.<br>		At the start an ROOT task is created.<br>
	When the ROOT task was created the Queue gets filled with NONE task's which do nothing.		When the ROOT task was created the Queue gets filled with NONE task's which do nothing.<br>
	At initialization each task has the next task in order as their next task specified inside 0x18.		At initialization each task has the next task in order as their next task specified inside 0x18.<br>
	The last task however points to 0x142A88530 (v1.07) as their next task.		The last task however points to 0x142A88530 (v1.07) as their next task.<br>
	The ROOT task points to the first task as it's next task.		The ROOT task points to the first task as it's next task.<br>

	=Enqueue Task=		=Enqueue Task=

PhilYeahz at 20:01, 30 December 2018

2018-12-30T20:01:52Z

← Older revision		Revision as of 21:01, 30 December 2018
Line 41:		Line 41:
	At the start an ROOT task is created.<br>		At the start an ROOT task is created.<br>
	When the ROOT task was created the Queue gets filled with NONE task's which do nothing.		When the ROOT task was created the Queue gets filled with NONE task's which do nothing.
			At initialization each task has the next task in order as their next task specified inside 0x18.
			The last task however points to 0x142A88530 (v1.07) as their next task.
			The ROOT task points to the first task as it's next task.

	=Enqueue Task=		=Enqueue Task=