OCEOSmp/notes - Revision history

Bkavanagh: /* Associated directives */

2024-05-03T15:28:36Z

Associated directives

← Older revision		Revision as of 15:28, 3 May 2024
Line 563:		Line 563:
	This returns the oldest unread entry to outputPtr and updates the buffer indices		This returns the oldest unread entry to outputPtr and updates the buffer indices

	#Other directives are detailed in system_log.h		# <li value="3">Other directives are detailed in system_log.h</li>

Bkavanagh: /* Associated directives */

2024-05-03T15:27:59Z

Associated directives

← Older revision		Revision as of 15:27, 3 May 2024
Line 546:		Line 546:
	== Associated directives ==		== Associated directives ==
	#Add Log Entry		#Add Log Entry
	~~<span style="color:#1b7ac2">'''Prototype'''</span><br>~~
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	S32_t oceos_log_add_entry(		S32_t oceos_log_add_entry(
Line 556:		Line 555:

	# <li value="2">Remove Log Entry</li>		# <li value="2">Remove Log Entry</li>
	~~<span style="color:#1b7ac2">'''Prototype'''</span><br>~~
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	S32_t oceos_log_remove_entry(		S32_t oceos_log_remove_entry(

Bkavanagh: /* Associated directives */

2024-05-03T15:27:12Z

Associated directives

← Older revision		Revision as of 15:27, 3 May 2024
Line 555:		Line 555:
	This adds an entry, overwriting the currently oldest entry.		This adds an entry, overwriting the currently oldest entry.

	#Remove Log Entry		# <li value="2">Remove Log Entry</li>
	<span style="color:#1b7ac2">'''Prototype'''</span><br>		<span style="color:#1b7ac2">'''Prototype'''</span><br>
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
Line 567:		Line 567:
	#Other directives are detailed in system_log.h		#Other directives are detailed in system_log.h


	== Usage by OCEOSmp itself ==		== Usage by OCEOSmp itself ==
	#OCEOSmp only uses the system log for problems that do not arise directly when a directive is used (problems that arise directly are described in the returned directive status code).		#OCEOSmp only uses the system log for problems that do not arise directly when a directive is used (problems that arise directly are described in the returned directive status code).

Bkavanagh: /* Storage */

2024-05-03T15:26:09Z

Storage

← Older revision		Revision as of 15:26, 3 May 2024
Line 540:		Line 540:
	} __attribute__ ((aligned (8));		} __attribute__ ((aligned (8));
	</syntaxhighlight>		</syntaxhighlight>
	#When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.		# <li value="4">When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.</li>
	#The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.		#The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.
	#The entry_comment allows noting further information on the current situation		#The entry_comment allows noting further information on the current situation

Bkavanagh: /* Usage by OCEOSmp itself */

2024-05-03T15:23:36Z

Usage by OCEOSmp itself

← Older revision		Revision as of 15:23, 3 May 2024
Line 570:		Line 570:
	#OCEOSmp only uses the system log for problems that do not arise directly when a directive is used (problems that arise directly are described in the returned directive status code).		#OCEOSmp only uses the system log for problems that do not arise directly when a directive is used (problems that arise directly are described in the returned directive status code).
	#Such problems fall into a number of categories		#Such problems fall into a number of categories
	a. System corruption is detected and/or oceos_exit is called		## System corruption is detected and/or oceos_exit is called a
	b. Excessive delays in obtaining system spin locks perhaps due to system overloading		## Excessive delays in obtaining system spin locks perhaps due to system overloading
	c. A timed action misses its specified time		## A timed action misses its specified time
	d. A task misses its deadlines		## A task misses its deadlines
	e. Task start requests occur more frequently than expected		## Task start requests occur more frequently than expected
	f. A task exits without returning a mutex or read-write mutex that it holds		## A task exits without returning a mutex or read-write mutex that it holds
	g. Counts already at max or min		## Nested mutexes or read-write mutexes not returned in correct order
	h.		## Counts already at max or min
	~~18.~~ In many cases when OCEOSmp makes a system log entry it also updates the system state variable. This is updated using ‘OR’ and so provides a long term record that a problem has occurred even if a log entry is overwritten. In addition, if the update corresponds to an application defined action mask an application defined problem handling function may be called which can if desired read the system log.		#In many cases when OCEOSmp makes a system log entry it also updates the system state variable. This is updated using ‘OR’ and so provides a long term record that a problem has occurred even if a log entry is overwritten. In addition, if the update corresponds to an application defined action mask an application defined problem handling function may be called which can if desired read the system log.


	[[Category:backup]]		[[Category:backup]]

Bkavanagh: /* Associated directives (from system_log.h) */

2024-05-03T15:22:40Z

Associated directives (from system_log.h)

← Older revision		Revision as of 15:22, 3 May 2024
Line 189:		Line 189:

	==== Associated directives (from system_log.h) ====		==== Associated directives (from system_log.h) ====
	#Add log entry		# <li value="13">Add log entry</li>
	S32_t oceos_log_add_entry(		S32_t oceos_log_add_entry(
	enum LOG_ENTRY_TYPE type, // 8 bit enum LOG_ENTRY_TYPE		enum LOG_ENTRY_TYPE type, // 8 bit enum LOG_ENTRY_TYPE
Line 197:		Line 197:
	This adds an entry, overwriting the currently oldest entry.		This adds an entry, overwriting the currently oldest entry.

	#Remove log entry		# <li value="14">Remove log entry</li>
	S32_t oceos_log_remove_entry(		S32_t oceos_log_remove_entry(
	struct log_entry * const outputPtr		struct log_entry * const outputPtr
Line 204:		Line 204:
	This returns the oldest unread entry to outputPtr and updates the buffer indices		This returns the oldest unread entry to outputPtr and updates the buffer indices

	# <li value="13">Other log directives are detailed in system_log.h</li>		# <li value="15">Other log directives are detailed in system_log.h</li>

	Usage by OCEOSmp itself		Usage by OCEOSmp itself

Bkavanagh: /* Associated directives (from system_log.h) */

2024-05-03T15:18:41Z

Associated directives (from system_log.h)

← Older revision		Revision as of 15:18, 3 May 2024
Line 189:		Line 189:

	==== Associated directives (from system_log.h) ====		==== Associated directives (from system_log.h) ====
			#Add log entry
	S32_t oceos_log_add_entry(		S32_t oceos_log_add_entry(
	enum LOG_ENTRY_TYPE type, // 8 bit enum LOG_ENTRY_TYPE		enum LOG_ENTRY_TYPE type, // 8 bit enum LOG_ENTRY_TYPE
Line 197:		Line 197:
	This adds an entry, overwriting the currently oldest entry.		This adds an entry, overwriting the currently oldest entry.

			#Remove log entry
	S32_t oceos_log_remove_entry(		S32_t oceos_log_remove_entry(
	struct log_entry * const outputPtr		struct log_entry * const outputPtr

Bkavanagh: /* Storage */

2024-05-03T15:16:48Z

Storage

← Older revision		Revision as of 15:16, 3 May 2024
Line 186:		Line 186:
	# <li value="10">When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.</li>		# <li value="10">When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.</li>
	# The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.		# The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.
	# The entry_comment allows noting further information on the current situation		# The ''entry_comment'' allows noting further information on the current situation

	==== Associated directives (from system_log.h) ====		==== Associated directives (from system_log.h) ====

Bkavanagh: /* Storage */

2024-05-03T15:13:57Z

Storage

← Older revision		Revision as of 15:13, 3 May 2024
Line 531:		Line 531:
	#The log size and the oceosmp_on_full() function declaration are stored in the oceosmp_fixed_area, as also are the log area addresses.		#The log size and the oceosmp_on_full() function declaration are stored in the oceosmp_fixed_area, as also are the log area addresses.
	#Log entry format (from system_log.h):		#Log entry format (from system_log.h):
	~~<span style="color:#1b7ac2">'''Prototype'''</span><br>~~
	<syntaxhighlight lang="C">		<syntaxhighlight lang="C">
	Struct log_entry{		Struct log_entry{
Line 542:		Line 541:
	#When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.		#When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.
	#The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.		#The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.
	#The entry_comment allows noting further information on the current situation		#The entry_comment allows noting further information on the current situation

	== Associated directives ==		== Associated directives ==

Bkavanagh at 14:59, 3 May 2024

2024-05-03T14:59:32Z

← Older revision		Revision as of 14:59, 3 May 2024
Line 514:		Line 514:

	Even where it is hoped that nothing can possibly go wrong….		Even where it is hoped that nothing can possibly go wrong….

			= <span style="color:#0000ff">'''System Log'''</span> =

			== Purpose ==
			#Provide application software with the ability to make time stamped records of events for use in application performance monitoring and in application debugging
			#Provide OCEOSmp with the ability to record internal anomalies should these be detected.

			== Structure ==
			#A circular buffer with a fixed size that is set in the application configuration
			#Size from 16 to 1024 entries, default 64 if not specified
			#If the application defines oceosmp_on_full_log(void *) this is called automatically when the buffer becomes ¾ full, allowing log entries that might otherwise be overwritten be stored. The automatic call will reoccur only after the buffer becomes ¾ empty.
			#On system reset log entries are not overwritten and buffer indices are reset so as to postpone recent entries being overwritten and allow review of events prior to the reset.

			== Storage ==
			#Stored statically in the oceosmp_log_area, which also contains the next-read and next-write buffer indices and the system state related variables.
			#The log size and the oceosmp_on_full() function declaration are stored in the oceosmp_fixed_area, as also are the log area addresses.
			#Log entry format (from system_log.h):
			<span style="color:#1b7ac2">'''Prototype'''</span><br>
			<syntaxhighlight lang="C">
			Struct log_entry{
			U64_t time64;
			unsigned int current_cpu_id :8;
			unsigned int entry_type :8;
			U32_t entry_comment;
			} __attribute__ ((aligned (8));
			</syntaxhighlight>
			#When a log entry is made, time64 and current_cpu_id are set automatically by OCEOSmp.
			#The entry type is an enum defined by the application, with a subset of enum values reserved for use by OCEOSmp. The reserved enum values are specified in system_log.h.
			#The entry_comment allows noting further information on the current situation

			== Associated directives ==
			#Add Log Entry
			<span style="color:#1b7ac2">'''Prototype'''</span><br>
			<syntaxhighlight lang="C">
			S32_t oceos_log_add_entry(
			enum LOG_ENTRY_TYPE type, // 8 bit enum LOG_ENTRY_TYPE
			const U32_t info // further information
			);
			</syntaxhighlight>
			This adds an entry, overwriting the currently oldest entry.

			#Remove Log Entry
			<span style="color:#1b7ac2">'''Prototype'''</span><br>
			<syntaxhighlight lang="C">
			S32_t oceos_log_remove_entry(
			struct log_entry * const outputPtr
			);
			</syntaxhighlight>

			This returns the oldest unread entry to outputPtr and updates the buffer indices

			#Other directives are detailed in system_log.h

			== Usage by OCEOSmp itself ==
			#OCEOSmp only uses the system log for problems that do not arise directly when a directive is used (problems that arise directly are described in the returned directive status code).
			#Such problems fall into a number of categories
			a. System corruption is detected and/or oceos_exit is called
			b. Excessive delays in obtaining system spin locks perhaps due to system overloading
			c. A timed action misses its specified time
			d. A task misses its deadlines
			e. Task start requests occur more frequently than expected
			f. A task exits without returning a mutex or read-write mutex that it holds
			g. Counts already at max or min
			h.
			18. In many cases when OCEOSmp makes a system log entry it also updates the system state variable. This is updated using ‘OR’ and so provides a long term record that a problem has occurred even if a log entry is overwritten. In addition, if the update corresponds to an application defined action mask an application defined problem handling function may be called which can if desired read the system log.


	[[Category:backup]]		[[Category:backup]]