ratemon.h

Go to the documentation of this file.

/* COPYRIGHT (c) 1989-2009.
 * On-Line Applications Research Corporation (OAR).
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_RATEMON_H
#define _RTEMS_RTEMS_RATEMON_H

#include <rtems/rtems/types.h>
#include <rtems/rtems/status.h>
#include <rtems/score/thread.h>
#include <rtems/score/watchdog.h>
#include <rtems/bspIo.h>

#ifdef __cplusplus
extern "C" {
#endif

#include <rtems/score/timespec.h>

typedef struct timespec rtems_rate_monotonic_period_time_t;

#include <rtems/score/timestamp.h>

typedef Timestamp_Control Rate_monotonic_Period_time_t;

typedef enum {
  RATE_MONOTONIC_INACTIVE,

  RATE_MONOTONIC_OWNER_IS_BLOCKING,

  RATE_MONOTONIC_ACTIVE,

  RATE_MONOTONIC_EXPIRED_WHILE_BLOCKING,

  RATE_MONOTONIC_EXPIRED
}   rtems_rate_monotonic_period_states;

#define RTEMS_PERIOD_STATUS       WATCHDOG_NO_TIMEOUT

typedef struct {
  uint32_t     count;
  uint32_t     missed_count;

  rtems_thread_cpu_usage_t             min_cpu_time;
  rtems_thread_cpu_usage_t             max_cpu_time;
  rtems_thread_cpu_usage_t             total_cpu_time;

  rtems_rate_monotonic_period_time_t   min_wall_time;
  rtems_rate_monotonic_period_time_t   max_wall_time;
  rtems_rate_monotonic_period_time_t   total_wall_time;
}  rtems_rate_monotonic_period_statistics;

typedef struct {
  uint32_t     count;
  uint32_t     missed_count;

  Thread_CPU_usage_t                   min_cpu_time;
  Thread_CPU_usage_t                   max_cpu_time;
  Thread_CPU_usage_t                   total_cpu_time;

  Rate_monotonic_Period_time_t         min_wall_time;
  Rate_monotonic_Period_time_t         max_wall_time;
  Rate_monotonic_Period_time_t         total_wall_time;
}  Rate_monotonic_Statistics;

typedef struct {
  rtems_id                             owner;

  rtems_rate_monotonic_period_states   state;

  rtems_rate_monotonic_period_time_t   since_last_period;

  rtems_thread_cpu_usage_t             executed_since_last_period;
}  rtems_rate_monotonic_period_status;

typedef struct {
  Objects_Control                         Object;

  Watchdog_Control                        Timer;

  rtems_rate_monotonic_period_states      state;

  uint32_t                                next_length;

  Thread_Control                         *owner;

  Thread_CPU_usage_t                      cpu_usage_period_initiated;

  Rate_monotonic_Period_time_t            time_period_initiated;

  Rate_monotonic_Statistics               Statistics;
}   Rate_monotonic_Control;

rtems_status_code rtems_rate_monotonic_create(
  rtems_name    name,
  rtems_id     *id
);

rtems_status_code rtems_rate_monotonic_ident(
  rtems_name    name,
  rtems_id     *id
);

rtems_status_code rtems_rate_monotonic_cancel(
  rtems_id   id
);

rtems_status_code rtems_rate_monotonic_delete(
  rtems_id   id
);

rtems_status_code rtems_rate_monotonic_get_status(
  rtems_id                             id,
  rtems_rate_monotonic_period_status  *status
);

rtems_status_code rtems_rate_monotonic_get_statistics(
  rtems_id                                id,
  rtems_rate_monotonic_period_statistics *statistics
);

rtems_status_code rtems_rate_monotonic_reset_statistics(
  rtems_id                                 id
);

void rtems_rate_monotonic_reset_all_statistics( void );

void rtems_rate_monotonic_report_statistics_with_plugin(
  void                  *context,
  rtems_printk_plugin_t  print
);

void rtems_rate_monotonic_report_statistics( void );

rtems_status_code rtems_rate_monotonic_period(
  rtems_id        id,
  rtems_interval  length
);

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */