diff options
Diffstat (limited to 'cpukit/score/include/rtems/score/smplockstats.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/smplockstats.h | 277 |
1 files changed, 0 insertions, 277 deletions
diff --git a/cpukit/score/include/rtems/score/smplockstats.h b/cpukit/score/include/rtems/score/smplockstats.h deleted file mode 100644 index dd8e06c81d..0000000000 --- a/cpukit/score/include/rtems/score/smplockstats.h +++ /dev/null @@ -1,277 +0,0 @@ -/** - * @file - * - * @ingroup ScoreSMPLock - * - * @brief SMP Lock API - */ - -/* - * Copyright (c) 2013, 2016 embedded brains GmbH - * - * 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_SCORE_SMPLOCKSTATS_H -#define _RTEMS_SCORE_SMPLOCKSTATS_H - -#include <rtems/score/cpuopts.h> - -#if defined(RTEMS_SMP) - -#include <rtems/score/chainimpl.h> - -#include <stdint.h> - -#ifdef __cplusplus -extern "C" { -#endif /* __cplusplus */ - -/** - * @addtogroup ScoreSMPLock - * - * @{ - */ - -#if defined(RTEMS_PROFILING) - -/** - * @brief Count of lock contention counters for lock statistics. - */ -#define SMP_LOCK_STATS_CONTENTION_COUNTS 4 - -/** - * @brief SMP lock statistics. - * - * The lock acquire attempt instant is the point in time right after the - * interrupt disable action in the lock acquire sequence. - * - * The lock acquire instant is the point in time right after the lock - * acquisition. This is the begin of the critical section code execution. - * - * The lock release instant is the point in time right before the interrupt - * enable action in the lock release sequence. - * - * The lock section time is the time elapsed between the lock acquire instant - * and the lock release instant. - * - * The lock acquire time is the time elapsed between the lock acquire attempt - * instant and the lock acquire instant. - */ -typedef struct { - /** - * @brief Node for SMP lock statistics chain. - */ - Chain_Node Node; - - /** - * @brief The maximum lock acquire time in CPU counter ticks. - */ - CPU_Counter_ticks max_acquire_time; - - /** - * @brief The maximum lock section time in CPU counter ticks. - */ - CPU_Counter_ticks max_section_time; - - /** - * @brief The count of lock uses. - * - * This value may overflow. - */ - uint64_t usage_count; - - /** - * @brief Total lock acquire time in nanoseconds. - * - * The average lock acquire time is the total acquire time divided by the - * lock usage count. The ration of the total section and total acquire times - * gives a measure for the lock contention. - * - * This value may overflow. - */ - uint64_t total_acquire_time; - - /** - * @brief The counts of lock acquire operations by contention. - * - * The contention count for index N corresponds to a lock acquire attempt - * with an initial queue length of N. The last index corresponds to all - * lock acquire attempts with an initial queue length greater than or equal - * to SMP_LOCK_STATS_CONTENTION_COUNTS minus one. - * - * The values may overflow. - */ - uint64_t contention_counts[SMP_LOCK_STATS_CONTENTION_COUNTS]; - - /** - * @brief Total lock section time in CPU counter ticks. - * - * The average lock section time is the total section time divided by the - * lock usage count. - * - * This value may overflow. - */ - uint64_t total_section_time; - - /** - * @brief The lock name. - */ - const char *name; -} SMP_lock_Stats; - -/** - * @brief Local context for SMP lock statistics. - */ -typedef struct { - /** - * @brief The last lock acquire instant in CPU counter ticks. - * - * This value is used to measure the lock section time. - */ - CPU_Counter_ticks acquire_instant; - - /** - * @brief The lock stats used for the last lock acquire. - */ - SMP_lock_Stats *stats; -} SMP_lock_Stats_context; - -/** - * @brief SMP lock statistics initializer for static initialization. - */ -#define SMP_LOCK_STATS_INITIALIZER( name ) \ - { { NULL, NULL }, 0, 0, 0, 0, { 0, 0, 0, 0 }, 0, name } - -/** - * @brief Initializes an SMP lock statistics block. - * - * @param[in, out] stats The SMP lock statistics block. - * @param[in] name The name for the SMP lock statistics. This name must be - * persistent throughout the life time of this statistics block. - */ -static inline void _SMP_lock_Stats_initialize( - SMP_lock_Stats *stats, - const char *name -) -{ - SMP_lock_Stats init = SMP_LOCK_STATS_INITIALIZER( name ); - - *stats = init; -} - -/** - * @brief Destroys an SMP lock statistics block. - * - * @param[in] stats The SMP lock statistics block. - */ -void _SMP_lock_Stats_destroy( SMP_lock_Stats *stats ); - -void _SMP_lock_Stats_register( SMP_lock_Stats *stats ); - -typedef struct { - CPU_Counter_ticks first; -} SMP_lock_Stats_acquire_context; - -static inline void _SMP_lock_Stats_acquire_begin( - SMP_lock_Stats_acquire_context *acquire_context -) -{ - acquire_context->first = _CPU_Counter_read(); -} - -static inline void _SMP_lock_Stats_acquire_end( - const SMP_lock_Stats_acquire_context *acquire_context, - SMP_lock_Stats *stats, - SMP_lock_Stats_context *stats_context, - unsigned int queue_length -) -{ - CPU_Counter_ticks second; - CPU_Counter_ticks delta; - - second = _CPU_Counter_read(); - stats_context->acquire_instant = second; - delta = _CPU_Counter_difference( second, acquire_context->first ); - - ++stats->usage_count; - - stats->total_acquire_time += delta; - - if ( stats->max_acquire_time < delta ) { - stats->max_acquire_time = delta; - } - - if ( queue_length >= SMP_LOCK_STATS_CONTENTION_COUNTS ) { - queue_length = SMP_LOCK_STATS_CONTENTION_COUNTS - 1; - } - ++stats->contention_counts[ queue_length ]; - - stats_context->stats = stats; -} - -/** - * @brief Updates an SMP lock statistics block during a lock release. - * - * @param[in] stats_context The SMP lock statistics context. - */ -static inline void _SMP_lock_Stats_release_update( - const SMP_lock_Stats_context *stats_context -) -{ - SMP_lock_Stats *stats = stats_context->stats; - CPU_Counter_ticks first = stats_context->acquire_instant; - CPU_Counter_ticks second = _CPU_Counter_read(); - CPU_Counter_ticks delta = _CPU_Counter_difference( second, first ); - - stats->total_section_time += delta; - - if ( stats->max_section_time < delta ) { - stats->max_section_time = delta; - - if ( _Chain_Is_node_off_chain( &stats->Node ) ) { - _SMP_lock_Stats_register( stats ); - } - } -} - -typedef struct { - Chain_Node Node; - SMP_lock_Stats *current; -} SMP_lock_Stats_iteration_context; - -void _SMP_lock_Stats_iteration_start( - SMP_lock_Stats_iteration_context *iteration_context -); - - -bool _SMP_lock_Stats_iteration_next( - SMP_lock_Stats_iteration_context *iteration_context, - SMP_lock_Stats *snapshot, - char *name, - size_t name_size -); - -void _SMP_lock_Stats_iteration_stop( - SMP_lock_Stats_iteration_context *iteration_context -); - -#else /* RTEMS_PROFILING */ - -#define _SMP_lock_Stats_initialize( stats, name ) do { } while ( 0 ) - -#define _SMP_lock_Stats_destroy( stats ) do { } while ( 0 ) - -#endif /* !RTEMS_PROFILING */ - -/**@}*/ - -#ifdef __cplusplus -} -#endif /* __cplusplus */ - -#endif /* RTEMS_SMP */ - -#endif /* _RTEMS_SCORE_SMPLOCKSTATS_H */ |