summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/timestamp.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2008-12-09 21:27:35 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2008-12-09 21:27:35 +0000
commite57cb3c9df68ebe3616f8276be8d6fe7e926b4f2 (patch)
tree42483f3fce61b821e9d617a8c633e7fdd53a0d19 /cpukit/score/include/rtems/score/timestamp.h
parent2008-12-09 Joel Sherrill <joel.sherrill@oarcorp.com> (diff)
downloadrtems-e57cb3c9df68ebe3616f8276be8d6fe7e926b4f2.tar.bz2
2008-12-09 Joel Sherrill <joel.sherrill@oarcorp.com>
* score/Makefile.am, score/preinstall.am, score/include/rtems/score/timespec.h, score/include/rtems/score/timestamp.h: Add 64-bit implementation of SuperCore Timestamps. Tested on PowerPC/psim and SPARC/sis. * score/include/rtems/score/timestamp64.h, score/src/ts64addto.c, score/src/ts64divide.c, score/src/ts64dividebyinteger.c, score/src/ts64equalto.c, score/src/ts64getnanoseconds.c, score/src/ts64getseconds.c, score/src/ts64greaterthan.c, score/src/ts64lessthan.c, score/src/ts64set.c, score/src/ts64settozero.c, score/src/ts64subtract.c, score/src/ts64toticks.c, score/src/ts64totimespec.c: New files.
Diffstat (limited to 'cpukit/score/include/rtems/score/timestamp.h')
-rw-r--r--cpukit/score/include/rtems/score/timestamp.h237
1 files changed, 179 insertions, 58 deletions
diff --git a/cpukit/score/include/rtems/score/timestamp.h b/cpukit/score/include/rtems/score/timestamp.h
index 0602c8d916..d039a195fb 100644
--- a/cpukit/score/include/rtems/score/timestamp.h
+++ b/cpukit/score/include/rtems/score/timestamp.h
@@ -44,15 +44,90 @@ extern "C" {
#include <rtems/score/timespec.h>
-#define RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC
+/*
+ * NOTE: Eventually each port should select what it should use!!!
+ *
+ * These control which implementation of SuperCore Timestamp is used.
+ *
+ * if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+ * struct timespec is used
+ * else if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_INT64)
+ * int64_t is used
+ *
+ * When int64_t is used, then
+ * if defined(CPU_RTEMS_SCORE_TIMESTAMP_INT64_INLINE)
+ * the methods are inlined
+ * else
+ * the methods are NOT inlined
+ *
+ * Performance of int64_t versus struct timespec
+ * =============================================
+ *
+ * On PowerPC/psim, inlined int64_t saves ~50 instructions on each
+ * _Thread_Dispatch operation which results in a context switch.
+ * This works out to be about 10% faster dispatches and 7.5% faster
+ * blocking semaphore obtains. The following numbers are in instructions
+ * and from tm02 and tm26.
+ *
+ * timespec int64 inlined int64
+ * dispatch: 446 446 400
+ * blocking sem obtain: 627 626 581
+ *
+ * On SPARC/sis, inlined int64_t shows the same percentage gains.
+ * The following numbers are in microseconds and from tm02 and tm26.
+ *
+ * timespec int64 inlined int64
+ * dispatch: 59 61 53
+ * blocking sem obtain: 98 100 92
+ *
+ * Inlining appears to have a tendency to increase the size of
+ * some executables.
+ * Not inlining reduces the execution improvement but does not seem to
+ * be an improvement on the PowerPC and SPARC. The struct timespec
+ * and the executables with int64 not inlined are about the same size.
+ *
+ * Once there has some analysis of which algorithm and configuration
+ * is best suited to each target, these defines should be moved to
+ * the appropriate score/cpu cpu.h file. In the meantime, it is
+ * appropriate to select an implementation here using CPU macros.
+ */
+
+#define CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC
+/*
+#define CPU_RTEMS_SCORE_TIMESTAMP_IS_INT64
+#define CPU_RTEMS_SCORE_TIMESTAMP_INT64_INLINE
+*/
+
+/*
+ * Verify something is defined.
+ */
+#if !defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC) && \
+ !defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_INT64)
+ #error "No SuperCore Timestamp implementation selected."
+#endif
+
+/*
+ * Verify that more than one is not defined.
+ */
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC) && \
+ defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_INT64)
+ #error "Too many SuperCore Timestamp implementations selected."
+#endif
+
+/**
+ * Include any implementation specific header files
+ */
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_INT64)
+ #include <rtems/score/timestamp64.h>
+#endif
/**
* Define the Timestamp control type.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
typedef struct timespec Timestamp_Control;
#else
- #error "No Alternative implementations for SuperCore Timestamp."
+ typedef Timestamp64_Control Timestamp_Control;
#endif
/** @brief Set Timestamp to Seconds Nanosecond
@@ -64,12 +139,12 @@ extern "C" {
* @param[in] _seconds is the seconds portion of the timestamp
* @param[in] _nanoseconds is the nanoseconds portion of the timestamp
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Set( _time, _seconds, _nanoseconds ) \
- do { \
- (_time)->tv_sec = (_seconds); \
- (_time)->tv_nsec = (_nanoseconds); \
- } while (0)
+ _Timespec_Set( _time, _seconds, _nanoseconds )
+#else
+ #define _Timestamp_Set( _time, _seconds, _nanoseconds ) \
+ _Timestamp64_Set( _time, _seconds, _nanoseconds )
#endif
/** @brief Zero Timestamp
@@ -79,71 +154,83 @@ extern "C" {
*
* @param[in] _time points to the timestamp instance to zero.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Set_to_zero( _time ) \
- do { \
- (_time)->tv_sec = 0; \
- (_time)->tv_nsec = 0; \
- } while (0)
+ _Timespec_Set_to_zero( _time )
+#else
+ #define _Timestamp_Set_to_zero( _time ) \
+ _Timestamp64_Set_to_zero( _time )
#endif
/** @brief Is Timestamp Valid
*
* This method determines the validity of a timestamp.
*
- * @param[in] time is the timestamp instance to validate.
+ * @param[in] _time points to the timestamp instance to validate.
*
* @return This method returns true if @a time is valid and
* false otherwise.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Is_valid( _time ) \
_Timespec_Is_valid( _time )
+#else
+ #define _Timestamp_Is_valid( _time ) \
+ _Timestamp64_Is_valid( _time )
#endif
/** @brief Timestamp Less Than Operator
*
* This method is the less than operator for timestamps.
*
- * @param[in] lhs is the left hand side timestamp
- * @param[in] rhs is the right hand side timestamp
+ * @param[in] _lhs points to the left hand side timestamp
+ * @param[in] _rhs points to the right hand side timestamp
*
- * @return This method returns true if @a lhs is less than the @a rhs and
+ * @return This method returns true if @a _lhs is less than the @a _rhs and
* false otherwise.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Less_than( _lhs, _rhs ) \
_Timespec_Less_than( _lhs, _rhs )
+#else
+ #define _Timestamp_Less_than( _lhs, _rhs ) \
+ _Timestamp64_Less_than( _lhs, _rhs )
#endif
/** @brief Timestamp Greater Than Operator
*
* This method is the greater than operator for timestamps.
*
- * @param[in] lhs is the left hand side timestamp
- * @param[in] rhs is the right hand side timestamp
+ * @param[in] _lhs points to the left hand side timestamp
+ * @param[in] _rhs points to the right hand side timestamp
*
- * @return This method returns true if @a lhs is greater than the @a rhs and
+ * @return This method returns true if @a _lhs is greater than the @a _rhs and
* false otherwise.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Greater_than( _lhs, _rhs ) \
_Timespec_Greater_than( _lhs, _rhs )
+#else
+ #define _Timestamp_Greater_than( _lhs, _rhs ) \
+ _Timestamp64_Greater_than( _lhs, _rhs )
#endif
/** @brief Timestamp equal to Operator
*
* This method is the is equal to than operator for timestamps.
*
- * @param[in] lhs is the left hand side timestamp
- * @param[in] rhs is the right hand side timestamp
+ * @param[in] _lhs points to the left hand side timestamp
+ * @param[in] _rhs points to the right hand side timestamp
*
- * @return This method returns true if @a lhs is equal to @a rhs and
+ * @return This method returns true if @a _lhs is equal to @a _rhs and
* false otherwise.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Equal_to( _lhs, _rhs ) \
_Timespec_Equal_to( _lhs, _rhs )
+#else
+ #define _Timestamp_Equal_to( _lhs, _rhs ) \
+ _Timestamp64_Equal_to( _lhs, _rhs )
#endif
/** @brief Add to a Timestamp
@@ -151,12 +238,17 @@ extern "C" {
* This routine adds two timestamps. The second argument is added
* to the first.
*
- * @param[in] time points to the base time to be added to
- * @param[in] add points to the timestamp to add to the first argument
+ * @param[in] _time points to the base time to be added to
+ * @param[in] _add points to the timestamp to add to the first argument
+ *
+ * @return This method returns the number of seconds @a time increased by.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Add_to( _time, _add ) \
_Timespec_Add_to( _time, _add )
+#else
+ #define _Timestamp_Add_to( _time, _add ) \
+ _Timestamp64_Add_to( _time, _add )
#endif
/** @brief Add to a Timestamp (At Clock Tick)
@@ -170,14 +262,17 @@ extern "C" {
* operation is ONLY used as part of processing a clock tick,
* it is generally safe to assume that only one second changed.
*
- * @param[in] time points to the base time to be added to
- * @param[in] add points to the timestamp to add to the first argument
+ * @param[in] _time points to the base time to be added to
+ * @param[in] _add points to the timestamp to add to the first argument
*
* @return This method returns the number of seconds @a time increased by.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Add_to_at_tick( _time, _add ) \
_Timespec_Add_to( _time, _add )
+#else
+ #define _Timestamp_Add_to_at_tick( _time, _add ) \
+ _Timestamp64_Add_to_at_tick( _time, _add )
#endif
/** @brief Convert Timestamp to Number of Ticks
@@ -185,26 +280,32 @@ extern "C" {
* This routine convert the @a time timestamp to the corresponding number
* of clock ticks.
*
- * @param[in] time points to the time to be converted
+ * @param[in] _time points to the time to be converted
*
* @return This method returns the number of ticks computed.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_To_ticks( _time ) \
_Timespec_To_ticks( _time )
+#else
+ #define _Timestamp_To_ticks( _time ) \
+ _Timestamp64_To_ticks( _time )
#endif
/** @brief Convert Ticks to Timestamp
*
- * This routine converts the @a ticks value to the corresponding
- * timestamp format @a time.
+ * This routine converts the @a _ticks value to the corresponding
+ * timestamp format @a _time.
*
* @param[in] time points to the timestamp format time result
- * @param[in] ticks points to the the number of ticks to be filled in
+ * @param[in] ticks points to the number of ticks to be filled in
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_From_ticks( _ticks, _time ) \
_Timespec_From_ticks( _ticks, _time )
+#else
+ #define _Timestamp_From_ticks( _ticks, _time ) \
+ _Timestamp64_From_ticks( _ticks, _time )
#endif
/** @brief Subtract Two Timestamp
@@ -212,15 +313,19 @@ extern "C" {
* This routine subtracts two timestamps. @a result is set to
* @a end - @a start.
*
- * @param[in] start points to the starting time
- * @param[in] end points to the ending time
- * @param[in] result points to the difference between starting and ending time.
+ * @param[in] _start points to the starting time
+ * @param[in] _end points to the ending time
+ * @param[in] _result points to the difference between
+ * starting and ending time.
*
- * @return This method fills in @a result.
+ * @return This method fills in @a _result.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Subtract( _start, _end, _result ) \
_Timespec_Subtract( _start, _end, _result )
+#else
+ #define _Timestamp_Subtract( _start, _end, _result ) \
+ _Timestamp64_Subtract( _start, _end, _result )
#endif
/** @brief Divide Timestamp By Integer
@@ -229,15 +334,18 @@ extern "C" {
* use is to assist in benchmark calculations where you typically
* divide a duration by a number of iterations.
*
- * @param[in] time points to the total
- * @param[in] iterations is the number of iterations
- * @param[in] result points to the average time.
+ * @param[in] _time points to the total
+ * @param[in] _iterations is the number of iterations
+ * @param[in] _result points to the average time.
*
* @return This method fills in @a result.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Divide_by_integer( _time, _iterations, _result ) \
_Timespec_Divide_by_integer(_time, _iterations, _result )
+#else
+ #define _Timestamp_Divide_by_integer( _time, _iterations, _result ) \
+ _Timestamp64_Divide_by_integer( _time, _iterations, _result )
#endif
/** @brief Divide Timestamp
@@ -245,16 +353,19 @@ extern "C" {
* This routine divides a timestamp by another timestamp. The
* intended use is for calculating percentages to three decimal points.
*
- * @param[in] lhs points to the left hand number
- * @param[in] rhs points to the right hand number
- * @param[in] ival_percentage is the integer portion of the average
- * @param[in] fval_percentage is the thousandths of percentage
+ * @param[in] _lhs points to the left hand number
+ * @param[in] _rhs points to the right hand number
+ * @param[in] _ival_percentage points to the integer portion of the average
+ * @param[in] _fval_percentage points to the thousandths of percentage
*
* @return This method fills in @a result.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Divide( _lhs, _rhs, _ival_percentage, _fval_percentage ) \
_Timespec_Divide( _lhs, _rhs, _ival_percentage, _fval_percentage )
+#else
+ #define _Timestamp_Divide( _lhs, _rhs, _ival_percentage, _fval_percentage ) \
+ _Timestamp64_Divide( _lhs, _rhs, _ival_percentage, _fval_percentage )
#endif
/** @brief Get Seconds Portion of Timestamp
@@ -265,9 +376,12 @@ extern "C" {
*
* @return The seconds portion of @a _time.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
#define _Timestamp_Get_seconds( _time ) \
- ((_time)->tv_sec)
+ _Timespec_Get_seconds( _time )
+#else
+ #define _Timestamp_Get_seconds( _time ) \
+ _Timestamp64_Get_seconds( _time )
#endif
/** @brief Get Nanoseconds Portion of Timestamp
@@ -278,9 +392,12 @@ extern "C" {
*
* @return The nanoseconds portion of @a _time.
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+ #define _Timestamp_Get_nanoseconds( _time ) \
+ _Timespec_Get_nanoseconds( _time )
+#else
#define _Timestamp_Get_nanoseconds( _time ) \
- ((_time)->tv_nsec)
+ _Timestamp64_Get_nanoseconds( _time )
#endif
/** @brief Convert Timestamp to struct timespec
@@ -290,9 +407,13 @@ extern "C" {
* @param[in] _timestamp points to the timestamp
* @param[in] _timespec points to the timespec
*/
-#if defined(RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+#if defined(CPU_RTEMS_SCORE_TIMESTAMP_IS_STRUCT_SPEC)
+ /* in this case we know they are the same type so use simple assignment */
#define _Timestamp_To_timespec( _timestamp, _timespec ) \
*(_timespec) = *(_timestamp)
+#else
+ #define _Timestamp_To_timespec( _timestamp, _timespec ) \
+ _Timestamp64_To_timespec( _timestamp, _timespec )
#endif
#ifdef __cplusplus