RTEMS 4.8.0 On-Line Library

Rate Monotonic Manager RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period

RTEMS C User's Guide

19.4.7: RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period

CALLING SEQUENCE:

rtems_status_code rtems_rate_monotonic_get_statistics(
  rtems_id                                id,
  rtems_rate_monotonic_period_statistics *statistics
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - period initiated successfully
RTEMS_INVALID_ID - invalid rate monotonic period id
RTEMS_INVALID_ADDRESS - invalid address of statistics

DESCRIPTION:

This directive returns statistics information associated with the rate monotonic period id in the following data structure:

typedef struct {
  uint32_t     count;
  uint32_t     missed_count;
  #ifdef RTEMS_ENABLE_NANOSECOND_CPU_USAGE_STATISTICS
    struct timespec min_cpu_time;
    struct timespec max_cpu_time;
    struct timespec total_cpu_time;
  #else
    uint32_t  min_cpu_time;
    uint32_t  max_cpu_time;
    uint32_t  total_cpu_time;
  #endif
  #ifdef RTEMS_ENABLE_NANOSECOND_RATE_MONOTONIC_STATISTICS
    struct timespec min_wall_time;
    struct timespec max_wall_time;
    struct timespec total_wall_time;
  #else
    uint32_t  min_wall_time;
    uint32_t  max_wall_time;
    uint32_t  total_wall_time;
  #endif
}  rtems_rate_monotonic_period_statistics;

This directive returns the current statistics information for the period instance assocaited with id. The information returned is indicated by the structure above.

NOTES:

This directive will not cause the running task to be preempted.

RTEMS C User's Guide