ratemon.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

/*
 * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Do not manually edit this file.  It is part of the RTEMS quality process
 * and was automatically generated.
 *
 * If you find something that needs to be fixed or worded better please
 * post a report to an RTEMS mailing list or raise a bug report:
 *
 * https://docs.rtems.org/branches/master/user/support/bugs.html
 *
 * For information on updating and regenerating please refer to:
 *
 * https://docs.rtems.org/branches/master/eng/req/howto.html
 */

/* Generated from spec:/rtems/ratemon/if/header */

#ifndef _RTEMS_RTEMS_RATEMON_H
#define _RTEMS_RTEMS_RATEMON_H

#include <stdint.h>
#include <sys/_timespec.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/watchdogticks.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/rtems/ratemon/if/group */

/* Generated from spec:/rtems/ratemon/if/period-states */

typedef enum {
  RATE_MONOTONIC_INACTIVE,

  RATE_MONOTONIC_ACTIVE,

  RATE_MONOTONIC_EXPIRED
} rtems_rate_monotonic_period_states;

/* Generated from spec:/rtems/ratemon/if/period-statistics */

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;

/* Generated from spec:/rtems/ratemon/if/period-status */

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;

/* Generated from spec:/rtems/ratemon/if/printer */

/* Forward declaration */
struct rtems_printer;

/* Generated from spec:/rtems/ratemon/if/cancel */

rtems_status_code rtems_rate_monotonic_cancel( rtems_id id );

/* Generated from spec:/rtems/ratemon/if/create */

rtems_status_code rtems_rate_monotonic_create( rtems_name name, rtems_id *id );

/* Generated from spec:/rtems/ratemon/if/delete */

rtems_status_code rtems_rate_monotonic_delete( rtems_id id );

/* Generated from spec:/rtems/ratemon/if/get-statistics */

rtems_status_code rtems_rate_monotonic_get_statistics(
  rtems_id                                id,
  rtems_rate_monotonic_period_statistics *statistics
);

/* Generated from spec:/rtems/ratemon/if/get-status */

rtems_status_code rtems_rate_monotonic_get_status(
  rtems_id                            id,
  rtems_rate_monotonic_period_status *status
);

/* Generated from spec:/rtems/ratemon/if/ident */

rtems_status_code rtems_rate_monotonic_ident( rtems_name name, rtems_id *id );

/* Generated from spec:/rtems/ratemon/if/period */

rtems_status_code rtems_rate_monotonic_period(
  rtems_id       id,
  rtems_interval length
);

/* Generated from spec:/rtems/ratemon/if/period-status-define */

#define RTEMS_PERIOD_STATUS WATCHDOG_NO_TIMEOUT

/* Generated from spec:/rtems/ratemon/if/report-statistics */

void rtems_rate_monotonic_report_statistics( void );

/* Generated from spec:/rtems/ratemon/if/report-statistics-with-plugin */

void rtems_rate_monotonic_report_statistics_with_plugin(
  const struct rtems_printer *printer
);

/* Generated from spec:/rtems/ratemon/if/reset-all-statistics */

void rtems_rate_monotonic_reset_all_statistics( void );

/* Generated from spec:/rtems/ratemon/if/reset-statistics */

rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_id id );

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_RTEMS_RATEMON_H */