OCEOS Operation - Revision history

Dtimofejevs: /* The System Log */

2022-02-25T12:10:16Z

The System Log

← Older revision		Revision as of 12:10, 25 February 2022
Line 612:		Line 612:
	<p>The log is structured as a circular buffer, with its read and write indices also stored in the log area. It is set up initially by oceos_init(). This does not overwrite the data currently in the log but resets the read and write indices to be equal and as far as can be determined after the most recent log entry. As the log indices are equal the log now appears empty when an attempt to read it in the usual way is made, but a special directive allows the application program read the data at any position in the log. Another directive allows the application reset all log entries.</p>		<p>The log is structured as a circular buffer, with its read and write indices also stored in the log area. It is set up initially by oceos_init(). This does not overwrite the data currently in the log but resets the read and write indices to be equal and as far as can be determined after the most recent log entry. As the log indices are equal the log now appears empty when an attempt to read it in the usual way is made, but a special directive allows the application program read the data at any position in the log. Another directive allows the application reset all log entries.</p>
	<p>Any system that uses OCEOS must have a system log. The number of entries in the log is specified in the system configuration structure, and must be within the specified range or 0, in which case a default value is used.</p>		<p>Any system that uses OCEOS must have a system log. The number of entries in the log is specified in the system configuration structure, and must be within the specified range or 0, in which case a default value is used.</p>
	<p>The header file ~~oceos~~.h gives the structure of the log area and the values of the associated constants.</p>		<p>The header file system_log.h gives the structure of the log area and the values of the associated constants.</p>

	<syntaxhighlight lang="C" line>		<syntaxhighlight lang="C" line>

Dtimofejevs: /* oceos_sem_wait_restart (..) */

2022-02-22T19:16:07Z

oceos_sem_wait_restart (..)

← Older revision		Revision as of 19:16, 22 February 2022
Line 451:		Line 451:
	<p>If the semaphore is equal to zero then the job is put on a queue until the semaphore is incremented (signalled), at which time the job is restarted. </p> <p> Note that the job is restarted from scratch and not just continued from the directive call.</p>		<p>If the semaphore is equal to zero then the job is put on a queue until the semaphore is incremented (signalled), at which time the job is restarted. </p> <p> Note that the job is restarted from scratch and not just continued from the directive call.</p>

	~~[[File:Oceos_sem_wait_restart2.jpg]]~~		<syntaxhighlight lang="C" line>
			status = oceos_sem_wait_restart(s_0);
			</syntaxhighlight>

	The parameter is:		The parameter is:

Dtimofejevs: /* oceos_sem_wait_restart_timeout (..) */

2022-02-22T19:14:44Z

oceos_sem_wait_restart_timeout (..)

← Older revision		Revision as of 19:14, 22 February 2022
Line 463:		Line 463:

	<syntaxhighlight lang="C" line>		<syntaxhighlight lang="C" line>
	status = ~~oceos_sem_wait_restart~~(s_0, time_out);		status = oceos_sem_wait_restart_timeout(s_0, time_out);
	</syntaxhighlight>		</syntaxhighlight>

Dtimofejevs: /* Directive return codes */

2022-02-22T19:11:27Z

Directive return codes

← Older revision		Revision as of 19:11, 22 February 2022
Line 570:		Line 570:
	OCEOS is driven by directives described in the Reference section below. All directives return a status to be checked by the application. The directive return status is either success or a code indicating why it failed. The table below is taken from oceos.h. It is the responsibility of the application to take appropriate action if a directive call fails.		OCEOS is driven by directives described in the Reference section below. All directives return a status to be checked by the application. The directive return status is either success or a code indicating why it failed. The table below is taken from oceos.h. It is the responsibility of the application to take appropriate action if a directive call fails.

	~~[[File:Enum_directive_status2.jpg]]~~		<syntaxhighlight lang="C" line>
			enum DIRECTIVE_STATUS {
			SUCCESSFUL,
			INVALID_NAME,
			INVALID_ID,
			TOO_MANY,
			TIMEOUT,
			OBJECT_WAS_DELETED,
			INVALID_SIZE,
			INVALID_ADDRESS,
			INVALID_NUMBER,
			NOT_DEFINED,
			FAILED_TO_PUT_JOB_ON_REDYQ,
			UNSATISFIED,
			INCORRECT_STATE,
			ALREADY_SUSPENDED,
			INVALID_PRIORITY,
			INVALID_NODE,
			NOT_CONFIGURED,
			INTERNAL_ERROR,
			FAILED_TO_SET_REGISTER
			};
			</syntaxhighlight>

	=== The System Log ===		=== The System Log ===

Dtimofejevs: /* oceos_dataq_write(..) */

2022-02-22T19:09:43Z

oceos_dataq_write(..)

← Older revision		Revision as of 19:09, 22 February 2022
Line 537:		Line 537:
	This directive puts a pointer on the specified data queue.		This directive puts a pointer on the specified data queue.

	[[~~File:oceos_dataq_write.jpg]~~]		<syntaxhighlight lang="C" line>
			status = oceos_dataq_write(d_0, message_text[mess_no % NUMBER_OF_MESSAGES]);
			if (status != SUCCESSFUL) {
			printf(
			"Task ID: %x writing to dataq %d Error: %s\n",
			oceos_task_self(),
			d_0,
			status_text[status]);
			} else {
			++mess_no;
			}
			</syntaxhighlight>

	Parameters are :		Parameters are :

Dtimofejevs: /* oceos_dataq_read_restart_timeout(..) */

2022-02-22T19:07:24Z

oceos_dataq_read_restart_timeout(..)

← Older revision		Revision as of 19:07, 22 February 2022
Line 526:		Line 526:
	<p>A timeout in microseconds can be set, after which the task will not be restarted.</p>		<p>A timeout in microseconds can be set, after which the task will not be restarted.</p>

	~~[[File:Oceos_dataq_read_restart_timeout2.jpg]]~~		<syntaxhighlight lang="C" line>
			assert(NULL == oceos_dataq_read_restart_timeout(d_0, TIME_OUT));
			</syntaxhighlight>

	* Data Queue ID (0 to 62)		* Data Queue ID (0 to 62)

Dtimofejevs: /* oceos_dataq_read_restart(..) */

2022-02-22T19:04:25Z

oceos_dataq_read_restart(..)

← Older revision		Revision as of 19:04, 22 February 2022
Line 515:		Line 515:
	<p>This directive reads a pointer from the specified data queue. If the data queue is empty the task is put on a queue to be restarted when a new pointer has been added to the queue. </p>		<p>This directive reads a pointer from the specified data queue. If the data queue is empty the task is put on a queue to be restarted when a new pointer has been added to the queue. </p>

	~~[[File:Oceos_dataq_read_restart2.jpg]]~~		<syntaxhighlight lang="C" line>
			s = (char*) oceos_dataq_read_restart(d_0); // Indefinite wait for message
			</syntaxhighlight>

	* Data Queue ID (0 to 62)		* Data Queue ID (0 to 62)

Dtimofejevs: /* oceos_dataq_create (..) */

2022-02-22T19:02:14Z

oceos_dataq_create (..)

← Older revision		Revision as of 19:02, 22 February 2022
Line 492:		Line 492:
	This directive creates a data queue with specified ID		This directive creates a data queue with specified ID

	~~[[File~~:~~Oceos_dataq_create2.jpg]]~~		<syntaxhighlight lang="C" line>
			// Create data queue
			if (oceos_dataq_create(d_0, // Dataq ID: 0 to 63
			NUMBER_OF_MESSAGES, // Dataq size: 1 to 254
			6, // Dataq max number of pending jobs: 1 to 254
			0, // Boolean : 0 is roll-overs disabled, 1 is roll-overs enabled
			FALSE // whether timeout is used oceos_dataq_read_restart_timeout
			) != SUCCESSFUL) {
			printf("\nFailed to create data queue");
			return 11;
			}
			</syntaxhighlight>

	* Data Queue ID (0 to 62)		* Data Queue ID (0 to 62)

Dtimofejevs: /* oceos_sem_signal (..) */

2022-02-22T19:00:29Z

oceos_sem_signal (..)

← Older revision		Revision as of 19:00, 22 February 2022
Line 474:		Line 474:
	This directive increments (signals) the specified semaphore.		This directive increments (signals) the specified semaphore.

	[~~[File:oceos_sem_signal.jpg]~~]		<syntaxhighlight lang="C" line>
			status = oceos_sem_signal(s_0);
			if (status != SUCCESSFUL) {
			printf(
			"Task ID: %x, inc semaphore %d, value %d, %s\n",
			oceos_task_self(),
			s_0,
			oceos_sem_get_value(s_0),
			status_text[status]);
			}
			</syntaxhighlight>

	The semaphore ID is the sole parameter.		The semaphore ID is the sole parameter.

Dtimofejevs: /* oceos_sem_wait_restart_timeout (..) */

2022-02-22T18:57:47Z

oceos_sem_wait_restart_timeout (..)

← Older revision		Revision as of 18:57, 22 February 2022
Line 462:		Line 462:
	If a timeout is specified and subsequently expires, the job is restarted and status UNSATISFIED is returned. </p> <p> Note that the job is restarted from scratch and not just continued from the directive call.</p>		If a timeout is specified and subsequently expires, the job is restarted and status UNSATISFIED is returned. </p> <p> Note that the job is restarted from scratch and not just continued from the directive call.</p>

	~~[[File:Oceos_sem_wait_restart_timeout.jpg]]~~		<syntaxhighlight lang="C" line>
			status = oceos_sem_wait_restart(s_0, time_out);
			</syntaxhighlight>

	The parameters are:		The parameters are: