ChibiOS/os/rt/include/chstats.h

/*
    ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014,
              2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio.

    This file is part of ChibiOS.

    ChibiOS is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation version 3 of the License.

    ChibiOS is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    rt/include/chstats.h
 * @brief   Statistics module macros and structures.
 *
 * @addtogroup statistics
 * @{
 */

#ifndef CHSTATS_H
#define CHSTATS_H

#if (CH_DBG_STATISTICS == TRUE) || defined(__DOXYGEN__)

/*===========================================================================*/
/* Module constants.                                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Module pre-compile time settings.                                         */
/*===========================================================================*/

#if CH_CFG_USE_TM == FALSE
#error "CH_DBG_STATISTICS requires CH_CFG_USE_TM"
#endif

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Module data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   Type of a kernel statistics structure.
 */
typedef struct {
  ucnt_t                n_irq;      /**< @brief Number of IRQs.             */
  ucnt_t                n_ctxswc;   /**< @brief Number of context switches. */
  time_measurement_t    m_crit_thd; /**< @brief Measurement of threads
                                                critical zones duration.    */
  time_measurement_t    m_crit_isr; /**< @brief Measurement of ISRs critical
                                                zones duration.             */
} kernel_stats_t;

/*===========================================================================*/
/* Module macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void __stats_init(void);
  void __stats_increase_irq(void);
  void __stats_ctxswc(thread_t *ntp, thread_t *otp);
  void __stats_start_measure_crit_thd(void);
  void __stats_stop_measure_crit_thd(void);
  void __stats_start_measure_crit_isr(void);
  void __stats_stop_measure_crit_isr(void);
#ifdef __cplusplus
}
#endif

/*===========================================================================*/
/* Module inline functions.                                                  */
/*===========================================================================*/

/**
 * @brief   Statistics initialization.
 * @note    Internal use only.
 *
 * @param[out] ksp      pointer to the @p kernel__stats_t structure
 *
 * @notapi
 */
static inline void __stats_object_init(kernel_stats_t *ksp) {

  ksp->n_irq    = (ucnt_t)0;
  ksp->n_ctxswc = (ucnt_t)0;
  chTMObjectInit(&ksp->m_crit_thd);
  chTMObjectInit(&ksp->m_crit_isr);

  /* The initialization code will stop the measurement on the final call
     to chSysUnlock().*/
  chTMStartMeasurementX(&ksp->m_crit_thd);
}

#else /* CH_DBG_STATISTICS == FALSE */

/* Stub functions for when the statistics module is disabled. */
#define __stats_increase_irq()
#define __stats_ctxswc(old, new)
#define __stats_start_measure_crit_thd()
#define __stats_stop_measure_crit_thd()
#define __stats_start_measure_crit_isr()
#define __stats_stop_measure_crit_isr()

#endif /* CH_DBG_STATISTICS == FALSE */

#endif /* CHSTATS_H */

/** @} */