Rate-Monotonic Manager

The Rate-Monotonic Manager provides facilities to implement tasks which execute in a periodic fashion. Critically, it also gathers information about the execution of those periods and can provide important statistics to the user which can be used to analyze and tune the application. More...

Files
file	ratemon.h
	This header file defines the Rate-Monotonic Manager API.

Classes
struct	rtems_rate_monotonic_period_statistics
	% More...
struct	rtems_rate_monotonic_period_status
	% More...

Macros
#define	RTEMS_PERIOD_STATUS   WATCHDOG_NO_TIMEOUT
	This constant is the interval passed to the rtems_rate_monotonic_period() directive to obtain status information.

Enumerations
enum	rtems_rate_monotonic_period_states { RATE_MONOTONIC_INACTIVE, RATE_MONOTONIC_ACTIVE, RATE_MONOTONIC_EXPIRED }
	% More...

Functions
rtems_status_code	rtems_rate_monotonic_cancel (rtems_id id)
	% More...
rtems_status_code	rtems_rate_monotonic_create (rtems_name name, rtems_id *id)
	% More...
rtems_status_code	rtems_rate_monotonic_delete (rtems_id id)
	% More...
rtems_status_code	rtems_rate_monotonic_get_statistics (rtems_id id, rtems_rate_monotonic_period_statistics *statistics)
	% More...
rtems_status_code	rtems_rate_monotonic_get_status (rtems_id id, rtems_rate_monotonic_period_status *status)
	% More...
rtems_status_code	rtems_rate_monotonic_ident (rtems_name name, rtems_id *id)
	Identifies a period object by the specified object name. More...
rtems_status_code	rtems_rate_monotonic_period (rtems_id id, rtems_interval length)
	% More...
void	rtems_rate_monotonic_report_statistics (void)
	%
void	rtems_rate_monotonic_report_statistics_with_plugin (const struct rtems_printer *printer)
	% More...
void	rtems_rate_monotonic_reset_all_statistics (void)
	%
rtems_status_code	rtems_rate_monotonic_reset_statistics (rtems_id id)
	% More...

Detailed Description

The Rate-Monotonic Manager provides facilities to implement tasks which execute in a periodic fashion. Critically, it also gathers information about the execution of those periods and can provide important statistics to the user which can be used to analyze and tune the application.

Enumeration Type Documentation

rtems_rate_monotonic_period_states

enum rtems_rate_monotonic_period_states

%

Enumerator
RATE_MONOTONIC_INACTIVE	%
RATE_MONOTONIC_ACTIVE	%
RATE_MONOTONIC_EXPIRED	%

Definition at line 87 of file ratemon.h.

Function Documentation

rtems_rate_monotonic_cancel()

rtems_status_code rtems_rate_monotonic_cancel

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 49 of file ratemoncancel.c.

rtems_rate_monotonic_create()

rtems_status_code rtems_rate_monotonic_create	(	rtems_name	name,
		rtems_id *	id
	)

%

Parameters

name	%
id	%

Definition at line 30 of file ratemoncreate.c.

rtems_rate_monotonic_delete()

rtems_status_code rtems_rate_monotonic_delete

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 24 of file ratemondelete.c.

rtems_rate_monotonic_get_statistics()

rtems_status_code rtems_rate_monotonic_get_statistics	(	rtems_id	id,
		rtems_rate_monotonic_period_statistics *	statistics
	)

%

Parameters

id	%
statistics	%

Definition at line 24 of file ratemongetstatistics.c.

rtems_rate_monotonic_get_status()

rtems_status_code rtems_rate_monotonic_get_status	(	rtems_id	id,
		rtems_rate_monotonic_period_status *	status
	)

%

Parameters

id	%
status	%

Definition at line 25 of file ratemongetstatus.c.

rtems_rate_monotonic_ident()

rtems_status_code rtems_rate_monotonic_ident	(	rtems_name	name,
		rtems_id *	id
	)

Identifies a period object by the specified object name.

This directive obtains the period identifier associated with the period name specified in name.

If the period name is not unique, then the period identifier will match the first period with that name in the search order. However, this period identifier is not guaranteed to correspond to the desired period. The period identifier is used with other rate monotonic related directives to access the period.

The objects are searched from lowest to the highest index. Only the local node is searched.

Parameters

	name	is the object name to look up.
[out]	id	is the pointer to an object identifier variable. The object identifier of an object with the specified name will be stored in this variable, in case of a successful operation.

Return values

RTEMS_SUCCESSFUL	The requested operation was successful.
RTEMS_INVALID_ADDRESS	The id parameter was NULL.
RTEMS_INVALID_NAME	The name parameter was 0.
RTEMS_INVALID_NAME	There was no object with the specified name on the local node.

Definition at line 44 of file ratemonident.c.

rtems_rate_monotonic_period()

rtems_status_code rtems_rate_monotonic_period	(	rtems_id	id,
		rtems_interval	length
	)

%

Parameters

id	%
length	%

Definition at line 305 of file ratemonperiod.c.

rtems_rate_monotonic_report_statistics_with_plugin()

void rtems_rate_monotonic_report_statistics_with_plugin

(

const struct rtems_printer *

printer

)

%

Parameters

printer

%

rtems_rate_monotonic_reset_statistics()

rtems_status_code rtems_rate_monotonic_reset_statistics

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 24 of file ratemonresetstatistics.c.