OCEOS/oceos kernel/task - Revision history

Okhoruzhyy: /* oceos_task_kill() */

2022-03-24T09:53:56Z

oceos_task_kill()

← Older revision		Revision as of 09:53, 24 March 2022
Line 597:		Line 597:
	Current task is terminated and back to scheduler. This task can be restarted later.<br>		Current task is terminated and back to scheduler. This task can be restarted later.<br>
	If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>		If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>
	The user provided ~~END function~~ for this task when created with [[OCEOS/oceos kernel/task#oceos_task_create()\|oceos_task_create()]] is called from the scheduler.<br>		The user provided '''end_function''' for this task when created with [[OCEOS/oceos kernel/task#oceos_task_create()\|oceos_task_create()]] is called from the scheduler.<br>
	OCEOS can only kill the current job due to its single stack design. Application scenarios where this directive could be used include:<br>		OCEOS can only kill the current job due to its single stack design. Application scenarios where this directive could be used include:<br>
	* Application regular interrupt checking job status<br>		* Application regular interrupt checking job status<br>

Okhoruzhyy: /* oceos_task_kill() */

2022-03-24T09:53:23Z

oceos_task_kill()

← Older revision		Revision as of 09:53, 24 March 2022
Line 597:		Line 597:
	Current task is terminated and back to scheduler. This task can be restarted later.<br>		Current task is terminated and back to scheduler. This task can be restarted later.<br>
	If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>		If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>
	The user provided END function for this task is called from the scheduler.<br>		The user provided END function for this task when created with [[OCEOS/oceos kernel/task#oceos_task_create()\|oceos_task_create()]] is called from the scheduler.<br>
	OCEOS can only kill the current job due to its single stack design. Application scenarios where this directive could be used include:<br>		OCEOS can only kill the current job due to its single stack design. Application scenarios where this directive could be used include:<br>
	* Application regular interrupt checking job status<br>		* Application regular interrupt checking job status<br>

Okhoruzhyy: /* OCEOS Task */

2022-03-22T15:44:56Z

OCEOS Task

← Older revision		Revision as of 15:44, 22 March 2022
Line 1:		Line 1:
	=<span style="color:#0000ff">'''OCEOS Task'''</span>=		=<span style="color:#0000ff">'''OCEOS Task'''</span>=
	==<span style="color:#0000ff">Introduction</span>==		==<span style="color:#0000ff">Task Introduction</span>==

	In OCEOS all tasks are defined before scheduling begins and each task assigned a fixed priority, a pre-emption threshold, a current jobs limit, a maximum start to completion time, and an expected minimum inter start request time.		In OCEOS all tasks are defined before scheduling begins and each task assigned a fixed priority, a pre-emption threshold, a current jobs limit, a maximum start to completion time, and an expected minimum inter start request time.
Line 16:		Line 16:
	<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>		<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>
	All Tasks must be created before [[OCEOS/oceos kernel/initialisation#oceos_init_finish()\|oceos_init_finish()]] is called.		All Tasks must be created before [[OCEOS/oceos kernel/initialisation#oceos_init_finish()\|oceos_init_finish()]] is called.
			</blockquote>

			==<span style="color:#0000ff">Task Configuration</span>==

			<blockquote>
			User must define NUMBER_OF_TASKS. The example can be found in OCEOS demo projects.<br>
			User must create defined number of tasks before calling [[OCEOS/oceos kernel/initialisation#oceos_init_finish()\|oceos_init_finish()]]
			<syntaxhighlight lang="C">
			#define NUMBER_OF_TASKS 2
			/*
			* Create the application configuration structure
			*/
			struct application_configuration app_config = {0};
			app_config.number_of_tasks = NUMBER_OF_TASKS; // >= 1
			</syntaxhighlight>
			</blockquote>
			<blockquote>
			User must define NUMBER_OF_READYQ_ENTRIES. The example can be found in OCEOS demo projects.<br>
			Number of ready queue entries, 0 to 254. Defaults to number of tasks, as each task should have at least one job.
			If Number of ready queue entries is larger that number of total jobs it defaults to number of total jobs
			<syntaxhighlight lang="C">
			#define NUMBER_OF_READYQ_ENTRIES 5
			/*
			* Create the application configuration structure
			*/
			struct application_configuration app_config = {0};
			app_config.number_of_readyQ_entries = NUMBER_OF_READYQ_ENTRIES; // 0 => calculate size
			</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* Introduction */

2022-03-15T10:32:16Z

Introduction

← Older revision		Revision as of 10:32, 15 March 2022
Line 12:		Line 12:
	For each task a record is kept of the shortest time between attempts to create a new job, and a record of the maximum time between these attempts.		For each task a record is kept of the shortest time between attempts to create a new job, and a record of the maximum time between these attempts.
	For each task a record is kept also of the maximum time a job was waiting before starting, the minimum execution time, the maximum execution time, the maximum time from job creation to completion, and the maximum number of job pre-emptions. The system state variable is updated if necessary.<br>		For each task a record is kept also of the maximum time a job was waiting before starting, the minimum execution time, the maximum execution time, the maximum time from job creation to completion, and the maximum number of job pre-emptions. The system state variable is updated if necessary.<br>
	Task chaining is supported. A job can create a new job and pass this to the scheduler or place it on the timed actions queue.<br>		Task chaining is supported. A job can create a new job and pass this to the scheduler or place it on the [[OCEOS/oceos introduction#Timed_Actions_Queue\|timed actions queue]] .<br>
	Tasks provide a start address for a termination routine for use if task execution must be abandoned.		Tasks provide a start address for a termination routine for use if task execution must be abandoned.
	<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>		<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>

Okhoruzhyy: /* oceos_task_kill() */

2022-03-14T17:40:01Z

oceos_task_kill()

← Older revision		Revision as of 17:40, 14 March 2022
Line 576:		Line 576:
	OCEOS calls oceos_on_error(<span style="color:red">TODO ADD THE LINK TO DESCRIPTION OF THIS FUNCTION</span>) in the case of a system error. This is user implemented function where application recovery code is located.<br>		OCEOS calls oceos_on_error(<span style="color:red">TODO ADD THE LINK TO DESCRIPTION OF THIS FUNCTION</span>) in the case of a system error. This is user implemented function where application recovery code is located.<br>
	oceos_task_kill() is a possible directive to be used as part of error recovery.		oceos_task_kill() is a possible directive to be used as part of error recovery.
	~~<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>~~
	~~'''FOR SPARC ONLY : Tasks can be started in IRQ routines but CANNOT be started in TRAP handlers'''.~~
	~~</blockquote>~~
	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">

Okhoruzhyy: /* oceos_task_get_info() */

2022-03-14T17:32:13Z

oceos_task_get_info()

← Older revision		Revision as of 17:32, 14 March 2022
Line 677:		Line 677:
	U32_t time_min_gap_starts; // minimum time between job creations, can be reset		U32_t time_min_gap_starts; // minimum time between job creations, can be reset
	U32_t time_min_gap_finish_start; // minimum time between job ending and new job creation, can be reset		U32_t time_min_gap_finish_start; // minimum time between job ending and new job creation, can be reset

	U32_t time_last_start; // time of most recent job creation		U32_t time_last_start; // time of most recent job creation
	U32_t time_last_finish; // time of most recent job finish		U32_t time_last_finish; // time of most recent job finish

	U32_t preempt_max; // maximum times any job was pre-empted, no roll-over, can be reset		U32_t preempt_max; // maximum times any job was pre-empted, no roll-over, can be reset
	};		};

Okhoruzhyy: /* oceos_task_get_info() */

2022-03-14T17:31:35Z

oceos_task_get_info()

← Older revision		Revision as of 17:31, 14 March 2022
Line 622:		Line 622:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Get task information for task with ID.<br>
			User must pass pointer to struct task_info in order to retrieve data.

	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_task_get_info (
			const unsigned int Task, // Task ID
			struct task_info *info // Pointer to struct task_info
			);
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 632:		Line 637:
	! Parameter !! Description		! Parameter !! Description
	\|-		\|-
	\| \|\|		\| task_id \|\| Task ID
			\|-
			\| info \|\| Pointer to struct task_info
	\|}		\|}
	<span style="color:#1b7ac2">'''Returns'''</span><br>		<span style="color:#1b7ac2">'''Returns'''</span><br>
Line 640:		Line 647:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system~~ Meta pointer is NULL or		\|NOT_CONFIGURED \|\| System Meta pointer is NULL or
	~~Init pointer~~ is ~~NULL or~~		Fixed data start sentinel is corrupt
	~~Start up phase check fail or~~		\|-
	~~Fixed data checksum failed (check log)~~		\|INCORRECT_STATE \|\| Called while initialisation is ongoing
	\|-		\|-
	\| ~~INVALID_NAME~~ \|\| ~~If Start Sentinel for fixed area~~ is ~~corrupt or~~		\|INTERNAL_ERROR \|\| Dynamic Meta pointer is NULL
	~~Start Sentinel for dynamic area is corrupt~~
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\|INVALID_ID \|\| Failed on task ID check
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-		\|-
	\| SUCCESSFUL \|\| If All OK		\|NOT_DEFINED \|\| Pointer to task_info is NULL
			\|-
			\|SUCCESSFUL \|\| All is OK and data is valid
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			/**
			* task info to be used with oceos_task_get_info
			*/
			struct task_info {

			unsigned int jobs_current_max :16; // maximum number of current jobs for this task, no roll over, can be reset
			unsigned int jobs_total :16; // number of times this task was started, no roll-over, can be reset
			unsigned int jobs_current; // Number of task instances currently in use by oceos
			U32_t time_max_delay; // maximum time job is waiting on ready queue before becoming active
			U32_t time_max_finish; // maximum time to finish job execution after starting
			U32_t time_max_exec; // maximum time spent executing
			U32_t time_total_exec_low; // total CPU time used by this task low bits
			U32_t time_total_exec_high; // total CPU time used by this task high bits
			U32_t time_min_gap_starts; // minimum time between job creations, can be reset
			U32_t time_min_gap_finish_start; // minimum time between job ending and new job creation, can be reset

			U32_t time_last_start; // time of most recent job creation
			U32_t time_last_finish; // time of most recent job finish

			U32_t preempt_max; // maximum times any job was pre-empted, no roll-over, can be reset
			};
			enum TASK_NAME{
			t_tom, // will have task ID 0
			t_dick, // will have task ID 1
			};
			...
			struct task_info info;
			enum DIRECTIVE_STATUS status;
			status = oceos_task_get_info(t_tom, &info);
			if (SUCCESS != status) {
			// Deal with the problem
			return status;
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

Okhoruzhyy: /* oceos_task_kill() */

2022-03-14T17:25:21Z

oceos_task_kill()

← Older revision		Revision as of 17:25, 14 March 2022
Line 574:		Line 574:
	If such an application interrupt detected an error in the current job it can call oceos_task_kill() as part of its recovery actions.		If such an application interrupt detected an error in the current job it can call oceos_task_kill() as part of its recovery actions.
	* oceos_on_error()<br>		* oceos_on_error()<br>
	OCEOS calls oceos_on_error(TODO ADD THE LINK TO DESCRIPTION OF THIS FUNCTION) in the case of a system error. This is user implemented function where application recovery code is located.<br>		OCEOS calls oceos_on_error(<span style="color:red">TODO ADD THE LINK TO DESCRIPTION OF THIS FUNCTION</span>) in the case of a system error. This is user implemented function where application recovery code is located.<br>
	oceos_task_kill() is a possible directive to be used as part of error recovery.		oceos_task_kill() is a possible directive to be used as part of error recovery.
	<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>		<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>

Okhoruzhyy: /* oceos_task_kill() */

2022-03-14T17:24:08Z

oceos_task_kill()

← Older revision		Revision as of 17:24, 14 March 2022
Line 569:		Line 569:
	Current task is terminated and back to scheduler. This task can be restarted later.<br>		Current task is terminated and back to scheduler. This task can be restarted later.<br>
	If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>		If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>
	The user provided END function for this task is called from the scheduler.		The user provided END function for this task is called from the scheduler.<br>
			OCEOS can only kill the current job due to its single stack design. Application scenarios where this directive could be used include:<br>
			* Application regular interrupt checking job status<br>
			If such an application interrupt detected an error in the current job it can call oceos_task_kill() as part of its recovery actions.
			* oceos_on_error()<br>
			OCEOS calls oceos_on_error(TODO ADD THE LINK TO DESCRIPTION OF THIS FUNCTION) in the case of a system error. This is user implemented function where application recovery code is located.<br>
			oceos_task_kill() is a possible directive to be used as part of error recovery.
	<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>		<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>
	'''FOR SPARC ONLY : Tasks can be started in IRQ routines but CANNOT be started in TRAP handlers'''.		'''FOR SPARC ONLY : Tasks can be started in IRQ routines but CANNOT be started in TRAP handlers'''.

Okhoruzhyy: /* oceos_task_kill() */

2022-03-14T17:15:21Z

oceos_task_kill()

← Older revision		Revision as of 17:15, 14 March 2022
Line 566:		Line 566:

	<span style="color:#1b7ac2">'''Description'''</span><br>		<span style="color:#1b7ac2">'''Description'''</span><br>
			Directive to terminate current task when undesired behavior was detected.<br>
			Current task is terminated and back to scheduler. This task can be restarted later.<br>
			If oceos_task_kill() is called from IRQ handler, the task is terminated when IRQ nesting is unraveled.<br>
			The user provided END function for this task is called from the scheduler.
			<blockquote style="background-color: #c6e2f7; border-left-style: solid; border-left-width: 3px; border-left-color: blue; "> '''Note'''<br>
			'''FOR SPARC ONLY : Tasks can be started in IRQ routines but CANNOT be started in TRAP handlers'''.
			</blockquote>
	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS oceos_task_kill();
	</syntaxhighlight>		</syntaxhighlight>
	<span style="color:#1b7ac2">'''Parameters'''</span><br>		<span style="color:#1b7ac2">'''Parameters'''</span><br>
Line 584:		Line 590:
	! enum DIRECTIVE_STATUS !! Description		! enum DIRECTIVE_STATUS !! Description
	\|-		\|-
	\| ~~INCORRECT_STATE~~ \|\| ~~If system~~ Meta pointer is NULL or		\|NOT_CONFIGURED \|\| System Meta pointer is NULL or
	~~Init pointer is NULL or~~		Fixed data start sentinel is corrupt
	~~Start up phase check fail or~~
	Fixed data ~~checksum failed (check log)~~
	\|-		\|-
	\| ~~INVALID_NAME~~ \|\| ~~If Start Sentinel for fixed area~~ is ~~corrupt~~ or		\|INCORRECT_STATE \|\| Called while initialisation is ongoing or
	~~Start Sentinel for dynamic area~~ is ~~corrupt~~		Scheduling is not started
	\|-		\|-
	\| ~~INVALID_NUMBER~~ \|\| ~~If Configuration and actual parameters do not match~~		\|INTERNAL_ERROR \|\| Dynamic Meta pointer is NULL
	~~(In configuration file was defined 5 tasks, but created less)~~
	\|-		\|-
	\| SUCCESSFUL \|\| If All OK		\|SUCCESSFUL \|\| All is OK (only return this if was called from IRQ handler)
	\|}		\|}
	<span style="color:#1b7ac2">'''Example Usage'''</span><br>		<span style="color:#1b7ac2">'''Example Usage'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
			enum DIRECTIVE_STATUS status;
			status = oceos_task_kill();
			if (SUCCESSFUL != status ) {
			// Handle ERROR
			}
	</syntaxhighlight>		</syntaxhighlight>
	</blockquote>		</blockquote>

	===<span style="color:#0000ff">oceos_task_get_info()</span>===		===<span style="color:#0000ff">oceos_task_get_info()</span>===
	<blockquote style="border-left-style: none;">		<blockquote style="border-left-style: none;">