ratemon.h

Go to the documentation of this file.

/* COPYRIGHT (c) 1989-2009, 2016.
 * On-Line Applications Research Corporation (OAR).
 * COPYRIGHT (c) 2016-2017 Kuan-Hsun Chen.
 *
 * 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>

struct rtems_printer;

#ifdef __cplusplus
extern "C" {
#endif

typedef struct timespec rtems_rate_monotonic_period_time_t RTEMS_DEPRECATED;

typedef enum {
  RATE_MONOTONIC_INACTIVE,

  RATE_MONOTONIC_ACTIVE,

  RATE_MONOTONIC_EXPIRED
}   rtems_rate_monotonic_period_states;

#define RTEMS_PERIOD_STATUS       WATCHDOG_NO_TIMEOUT

typedef struct {
  uint32_t     count;
  uint32_t     missed_count;

  struct timespec min_cpu_time;
  struct timespec max_cpu_time;
  struct timespec total_cpu_time;

  struct timespec min_wall_time;
  struct timespec max_wall_time;
  struct timespec total_wall_time;
}  rtems_rate_monotonic_period_statistics;

typedef struct {
  rtems_id                             owner;

  rtems_rate_monotonic_period_states   state;

  struct timespec                      since_last_period;

  struct timespec                      executed_since_last_period;

  uint32_t                             postponed_jobs_count;
}  rtems_rate_monotonic_period_status;

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(
  const struct rtems_printer *printer
);

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 */