[PATCH] score: Avoid sbintime_t in API headers

Sebastian Huber sebastian.huber at embedded-brains.de
Mon Dec 3 12:20:53 UTC 2018


The sbintime_t is a non-POSIX type and not visible if strict standard
options are selected.

Move implementation details from <rtems/score/timestamp.h> to
<rtems/score/timestampimpl.h>.

Update #3598.
---
 cpukit/headers.am                            |   2 +-
 cpukit/include/rtems/score/threadimpl.h      |   1 +
 cpukit/include/rtems/score/timecounter.h     |   2 +-
 cpukit/include/rtems/score/timestamp.h       | 264 +----------------------
 cpukit/include/rtems/score/timestampimpl.h   | 302 +++++++++++++++++++++++++++
 cpukit/include/rtems/score/watchdogimpl.h    |   4 +-
 cpukit/rtems/src/clockgetuptimenanoseconds.c |   1 +
 cpukit/rtems/src/clockgetuptimetimeval.c     |   1 +
 8 files changed, 309 insertions(+), 268 deletions(-)
 create mode 100644 cpukit/include/rtems/score/timestampimpl.h

diff --git a/cpukit/headers.am b/cpukit/headers.am
index 1dbd154e0e..8172328c68 100644
--- a/cpukit/headers.am
+++ b/cpukit/headers.am
@@ -390,7 +390,7 @@ include_rtems_score_HEADERS += include/rtems/score/threadqimpl.h
 include_rtems_score_HEADERS += include/rtems/score/timecounter.h
 include_rtems_score_HEADERS += include/rtems/score/timecounterimpl.h
 include_rtems_score_HEADERS += include/rtems/score/timespec.h
-include_rtems_score_HEADERS += include/rtems/score/timestamp.h
+include_rtems_score_HEADERS += include/rtems/score/timestampimpl.h
 include_rtems_score_HEADERS += include/rtems/score/tls.h
 include_rtems_score_HEADERS += include/rtems/score/todimpl.h
 include_rtems_score_HEADERS += include/rtems/score/userext.h
diff --git a/cpukit/include/rtems/score/threadimpl.h b/cpukit/include/rtems/score/threadimpl.h
index 39937f9283..0e93cb501d 100644
--- a/cpukit/include/rtems/score/threadimpl.h
+++ b/cpukit/include/rtems/score/threadimpl.h
@@ -31,6 +31,7 @@
 #include <rtems/score/statesimpl.h>
 #include <rtems/score/status.h>
 #include <rtems/score/sysstate.h>
+#include <rtems/score/timestampimpl.h>
 #include <rtems/score/threadqimpl.h>
 #include <rtems/score/todimpl.h>
 #include <rtems/score/freechain.h>
diff --git a/cpukit/include/rtems/score/timecounter.h b/cpukit/include/rtems/score/timecounter.h
index 79444de482..9d688eebe8 100644
--- a/cpukit/include/rtems/score/timecounter.h
+++ b/cpukit/include/rtems/score/timecounter.h
@@ -74,7 +74,7 @@ void _Timecounter_Binuptime( struct bintime *bt );
  *
  * @return Returns the uptime.
  */
-sbintime_t _Timecounter_Sbinuptime( void );
+int64_t _Timecounter_Sbinuptime( void );
 
 /**
  * @brief Returns the uptime in the timespec format.
diff --git a/cpukit/include/rtems/score/timestamp.h b/cpukit/include/rtems/score/timestamp.h
index 6fc17ced9c..1e6a25ef28 100644
--- a/cpukit/include/rtems/score/timestamp.h
+++ b/cpukit/include/rtems/score/timestamp.h
@@ -40,9 +40,6 @@
  */
 /**@{*/
 
-#include <sys/time.h>
-
-#include <rtems/score/basedefs.h>
 #include <rtems/score/timespec.h>
 
 #ifdef __cplusplus
@@ -52,266 +49,7 @@ extern "C" {
 /**
  *   Define the Timestamp control type.
  */
-typedef sbintime_t Timestamp_Control;
-
-/**
- *  @brief Set timestamp to specified seconds and nanoseconds.
- *
- *  This method sets the timestamp to the specified @a _seconds and @a _nanoseconds
- *  value.
- *
- *  @param[in] _time points to the timestamp instance to validate.
- *  @param[in] _seconds is the seconds portion of the timestamp
- *  @param[in] _nanoseconds is the nanoseconds portion of the timestamp
- */
-RTEMS_INLINE_ROUTINE void _Timestamp_Set(
-  Timestamp_Control *_time,
-  time_t             _seconds,
-  long               _nanoseconds
-)
-{
-  struct timespec _ts;
-
-  _ts.tv_sec = _seconds;
-  _ts.tv_nsec = _nanoseconds;
-
-  *_time = tstosbt(_ts);
-}
-
-/**
- *  @brief Sets the timestamp to zero.
- *
- *  This method sets the timestamp to zero.
- *  value.
- *
- *  @param[in] _time points to the timestamp instance to zero.
- */
-
-RTEMS_INLINE_ROUTINE void _Timestamp_Set_to_zero(
-  Timestamp_Control *_time
-)
-{
-  *_time = 0;
-}
-
-/**
- *  @brief Less than operator for timestamps.
- *
- *  This method is the less than operator for timestamps.
- *
- *  @param[in] _lhs points to the left hand side timestamp
- *  @param[in] _rhs points to the right hand side timestamp
- *
- *  @retval This method returns true if @a _lhs is less than the @a _rhs and
- *          false otherwise.
- */
-
-RTEMS_INLINE_ROUTINE bool _Timestamp_Less_than(
-  const Timestamp_Control *_lhs,
-  const Timestamp_Control *_rhs
-)
-{
-  return *_lhs < *_rhs;
-}
-
-/**
- *  @brief Greater than operator for timestamps.
- *
- *  This method is the greater than operator for timestamps.
- *
- *  @param[in] _lhs points to the left hand side timestamp
- *  @param[in] _rhs points to the right hand side timestamp
- *
- *  @retval This method returns true if @a _lhs is greater than the @a _rhs and
- *          false otherwise.
- */
-
-RTEMS_INLINE_ROUTINE bool _Timestamp_Greater_than(
-  const Timestamp_Control *_lhs,
-  const Timestamp_Control *_rhs
-)
-{
-  return *_lhs > *_rhs;
-}
-
-/**
- *  @brief Equal to than operator for timestamps.
- *
- *  This method is the is equal to than operator for timestamps.
- *
- *  @param[in] _lhs points to the left hand side timestamp
- *  @param[in] _rhs points to the right hand side timestamp
- *
- *  @retval This method returns true if @a _lhs is equal to  @a _rhs and
- *          false otherwise.
- */
-
-RTEMS_INLINE_ROUTINE bool _Timestamp_Equal_to(
-  const Timestamp_Control *_lhs,
-  const Timestamp_Control *_rhs
-)
-{
-  return *_lhs == *_rhs;
-}
-
-/**
- *  @brief Adds two timestamps.
- *
- *  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
- */
-RTEMS_INLINE_ROUTINE void _Timestamp_Add_to(
-  Timestamp_Control *_time,
-  const Timestamp_Control *_add
-)
-{
-  *_time += *_add;
-}
-
-/**
- *  @brief Subtracts two timestamps.
- *
- *  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.
- *
- *  @retval This method fills in @a _result.
- */
-RTEMS_INLINE_ROUTINE void _Timestamp_Subtract(
-  const Timestamp_Control *_start,
-  const Timestamp_Control *_end,
-  Timestamp_Control       *_result
-)
-{
-  *_result = *_end - *_start;
-}
-
-/**
- *  @brief Divides a timestamp by another timestamp.
- *
- *  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 points to the integer portion of the average
- *  @param[in] _fval_percentage points to the thousandths of percentage
- *
- *  @retval This method fills in @a result.
- */
-RTEMS_INLINE_ROUTINE void _Timestamp_Divide(
-  const Timestamp_Control *_lhs,
-  const Timestamp_Control *_rhs,
-  uint32_t                *_ival_percentage,
-  uint32_t                *_fval_percentage
-)
-{
-  struct timespec _ts_left;
-  struct timespec _ts_right;
-
-  _ts_left = sbttots( *_lhs );
-  _ts_right = sbttots( *_rhs );
-
-  _Timespec_Divide(
-    &_ts_left,
-    &_ts_right,
-    _ival_percentage,
-    _fval_percentage
-  );
-}
-
-/**
- *  @brief Get seconds portion of timestamp.
- *
- *  This method returns the seconds portion of the specified timestamp
- *
- *  @param[in] _time points to the timestamp
- *
- *  @retval The seconds portion of @a _time.
- */
-RTEMS_INLINE_ROUTINE time_t _Timestamp_Get_seconds(
-  const Timestamp_Control *_time
-)
-{
-  return (*_time >> 32);
-}
-
-/**
- *  @brief Get nanoseconds portion of timestamp.
- *
- *  This method returns the nanoseconds portion of the specified timestamp
- *
- *  @param[in] _time points to the timestamp
- *
- *  @retval The nanoseconds portion of @a _time.
- */
-RTEMS_INLINE_ROUTINE uint32_t _Timestamp_Get_nanoseconds(
-  const Timestamp_Control *_time
-)
-{
-  struct timespec _ts;
-
-  _ts = sbttots( *_time );
-
-  return (uint32_t) _ts.tv_nsec;
-}
-
-/**
- *  @brief Get the timestamp as nanoseconds.
- *
- *  This method returns the timestamp as nanoseconds.
- *
- *  @param[in] _time points to the timestamp
- *
- *  @retval The time in nanoseconds.
- */
-RTEMS_INLINE_ROUTINE uint64_t _Timestamp_Get_as_nanoseconds(
-  const Timestamp_Control *_time
-)
-{
-  struct timespec _ts;
-
-  _ts = sbttots( *_time );
-
-  return _Timespec_Get_as_nanoseconds( &_ts );
-}
-
-/**
- *  @brief Convert timestamp to struct timespec.
- *
- *  This method returns the seconds portion of the specified @a _timestamp.
- *
- *  @param[in] _timestamp points to the timestamp
- *  @param[in] _timespec points to the timespec
- */
-RTEMS_INLINE_ROUTINE void _Timestamp_To_timespec(
-  const Timestamp_Control *_timestamp,
-  struct timespec         *_timespec
-)
-{
-  *_timespec = sbttots( *_timestamp );
-}
-
-/**
- *  @brief Convert timestamp to struct timeval.
- *
- *  @param[in] _timestamp points to the timestamp
- *  @param[in] _timeval points to the timeval
- */
-RTEMS_INLINE_ROUTINE void _Timestamp_To_timeval(
-  const Timestamp_Control *_timestamp,
-  struct timeval          *_timeval
-)
-{
-  *_timeval = sbttotv( *_timestamp );
-}
+typedef int64_t Timestamp_Control;
 
 #ifdef __cplusplus
 }
diff --git a/cpukit/include/rtems/score/timestampimpl.h b/cpukit/include/rtems/score/timestampimpl.h
new file mode 100644
index 0000000000..555d9354f2
--- /dev/null
+++ b/cpukit/include/rtems/score/timestampimpl.h
@@ -0,0 +1,302 @@
+/**
+ *  @file  rtems/score/timestamp.h
+ *
+ *  @brief Helpers for Manipulating Timestamps
+ *
+ *  This include file contains helpers for manipulating timestamps.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2009.
+ *  On-Line Applications Research Corporation (OAR).
+ *
+ *  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_TIMESTAMPIMPL_H
+#define _RTEMS_SCORE_TIMESTAMPIMPL_H
+
+/**
+ * @addtogroup SuperCoreTimeStamp
+ *
+ * @{
+ */
+
+#include <rtems/score/timestamp.h>
+#include <rtems/score/basedefs.h>
+
+#include <sys/time.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ *  @brief Set timestamp to specified seconds and nanoseconds.
+ *
+ *  This method sets the timestamp to the specified @a _seconds and @a _nanoseconds
+ *  value.
+ *
+ *  @param[in] _time points to the timestamp instance to validate.
+ *  @param[in] _seconds is the seconds portion of the timestamp
+ *  @param[in] _nanoseconds is the nanoseconds portion of the timestamp
+ */
+RTEMS_INLINE_ROUTINE void _Timestamp_Set(
+  Timestamp_Control *_time,
+  time_t             _seconds,
+  long               _nanoseconds
+)
+{
+  struct timespec _ts;
+
+  _ts.tv_sec = _seconds;
+  _ts.tv_nsec = _nanoseconds;
+
+  *_time = tstosbt(_ts);
+}
+
+/**
+ *  @brief Sets the timestamp to zero.
+ *
+ *  This method sets the timestamp to zero.
+ *  value.
+ *
+ *  @param[in] _time points to the timestamp instance to zero.
+ */
+
+RTEMS_INLINE_ROUTINE void _Timestamp_Set_to_zero(
+  Timestamp_Control *_time
+)
+{
+  *_time = 0;
+}
+
+/**
+ *  @brief Less than operator for timestamps.
+ *
+ *  This method is the less than operator for timestamps.
+ *
+ *  @param[in] _lhs points to the left hand side timestamp
+ *  @param[in] _rhs points to the right hand side timestamp
+ *
+ *  @retval This method returns true if @a _lhs is less than the @a _rhs and
+ *          false otherwise.
+ */
+
+RTEMS_INLINE_ROUTINE bool _Timestamp_Less_than(
+  const Timestamp_Control *_lhs,
+  const Timestamp_Control *_rhs
+)
+{
+  return *_lhs < *_rhs;
+}
+
+/**
+ *  @brief Greater than operator for timestamps.
+ *
+ *  This method is the greater than operator for timestamps.
+ *
+ *  @param[in] _lhs points to the left hand side timestamp
+ *  @param[in] _rhs points to the right hand side timestamp
+ *
+ *  @retval This method returns true if @a _lhs is greater than the @a _rhs and
+ *          false otherwise.
+ */
+
+RTEMS_INLINE_ROUTINE bool _Timestamp_Greater_than(
+  const Timestamp_Control *_lhs,
+  const Timestamp_Control *_rhs
+)
+{
+  return *_lhs > *_rhs;
+}
+
+/**
+ *  @brief Equal to than operator for timestamps.
+ *
+ *  This method is the is equal to than operator for timestamps.
+ *
+ *  @param[in] _lhs points to the left hand side timestamp
+ *  @param[in] _rhs points to the right hand side timestamp
+ *
+ *  @retval This method returns true if @a _lhs is equal to  @a _rhs and
+ *          false otherwise.
+ */
+
+RTEMS_INLINE_ROUTINE bool _Timestamp_Equal_to(
+  const Timestamp_Control *_lhs,
+  const Timestamp_Control *_rhs
+)
+{
+  return *_lhs == *_rhs;
+}
+
+/**
+ *  @brief Adds two timestamps.
+ *
+ *  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
+ */
+RTEMS_INLINE_ROUTINE void _Timestamp_Add_to(
+  Timestamp_Control *_time,
+  const Timestamp_Control *_add
+)
+{
+  *_time += *_add;
+}
+
+/**
+ *  @brief Subtracts two timestamps.
+ *
+ *  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.
+ *
+ *  @retval This method fills in @a _result.
+ */
+RTEMS_INLINE_ROUTINE void _Timestamp_Subtract(
+  const Timestamp_Control *_start,
+  const Timestamp_Control *_end,
+  Timestamp_Control       *_result
+)
+{
+  *_result = *_end - *_start;
+}
+
+/**
+ *  @brief Divides a timestamp by another timestamp.
+ *
+ *  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 points to the integer portion of the average
+ *  @param[in] _fval_percentage points to the thousandths of percentage
+ *
+ *  @retval This method fills in @a result.
+ */
+RTEMS_INLINE_ROUTINE void _Timestamp_Divide(
+  const Timestamp_Control *_lhs,
+  const Timestamp_Control *_rhs,
+  uint32_t                *_ival_percentage,
+  uint32_t                *_fval_percentage
+)
+{
+  struct timespec _ts_left;
+  struct timespec _ts_right;
+
+  _ts_left = sbttots( *_lhs );
+  _ts_right = sbttots( *_rhs );
+
+  _Timespec_Divide(
+    &_ts_left,
+    &_ts_right,
+    _ival_percentage,
+    _fval_percentage
+  );
+}
+
+/**
+ *  @brief Get seconds portion of timestamp.
+ *
+ *  This method returns the seconds portion of the specified timestamp
+ *
+ *  @param[in] _time points to the timestamp
+ *
+ *  @retval The seconds portion of @a _time.
+ */
+RTEMS_INLINE_ROUTINE time_t _Timestamp_Get_seconds(
+  const Timestamp_Control *_time
+)
+{
+  return (*_time >> 32);
+}
+
+/**
+ *  @brief Get nanoseconds portion of timestamp.
+ *
+ *  This method returns the nanoseconds portion of the specified timestamp
+ *
+ *  @param[in] _time points to the timestamp
+ *
+ *  @retval The nanoseconds portion of @a _time.
+ */
+RTEMS_INLINE_ROUTINE uint32_t _Timestamp_Get_nanoseconds(
+  const Timestamp_Control *_time
+)
+{
+  struct timespec _ts;
+
+  _ts = sbttots( *_time );
+
+  return (uint32_t) _ts.tv_nsec;
+}
+
+/**
+ *  @brief Get the timestamp as nanoseconds.
+ *
+ *  This method returns the timestamp as nanoseconds.
+ *
+ *  @param[in] _time points to the timestamp
+ *
+ *  @retval The time in nanoseconds.
+ */
+RTEMS_INLINE_ROUTINE uint64_t _Timestamp_Get_as_nanoseconds(
+  const Timestamp_Control *_time
+)
+{
+  struct timespec _ts;
+
+  _ts = sbttots( *_time );
+
+  return _Timespec_Get_as_nanoseconds( &_ts );
+}
+
+/**
+ *  @brief Convert timestamp to struct timespec.
+ *
+ *  This method returns the seconds portion of the specified @a _timestamp.
+ *
+ *  @param[in] _timestamp points to the timestamp
+ *  @param[in] _timespec points to the timespec
+ */
+RTEMS_INLINE_ROUTINE void _Timestamp_To_timespec(
+  const Timestamp_Control *_timestamp,
+  struct timespec         *_timespec
+)
+{
+  *_timespec = sbttots( *_timestamp );
+}
+
+/**
+ *  @brief Convert timestamp to struct timeval.
+ *
+ *  @param[in] _timestamp points to the timestamp
+ *  @param[in] _timeval points to the timeval
+ */
+RTEMS_INLINE_ROUTINE void _Timestamp_To_timeval(
+  const Timestamp_Control *_timestamp,
+  struct timeval          *_timeval
+)
+{
+  *_timeval = sbttotv( *_timestamp );
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+/**@}*/
+
+#endif
+/* end of include file */
diff --git a/cpukit/include/rtems/score/watchdogimpl.h b/cpukit/include/rtems/score/watchdogimpl.h
index 17ef130d3a..5a024069ca 100644
--- a/cpukit/include/rtems/score/watchdogimpl.h
+++ b/cpukit/include/rtems/score/watchdogimpl.h
@@ -398,9 +398,7 @@ RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Ticks_from_timespec(
   return ticks;
 }
 
-RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Ticks_from_sbintime(
-  sbintime_t sbt
-)
+RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Ticks_from_sbintime( int64_t sbt )
 {
   uint64_t ticks = ( sbt >> 32 ) << WATCHDOG_BITS_FOR_1E9_NANOSECONDS;
 
diff --git a/cpukit/rtems/src/clockgetuptimenanoseconds.c b/cpukit/rtems/src/clockgetuptimenanoseconds.c
index 03ff73bba3..71f5588db2 100644
--- a/cpukit/rtems/src/clockgetuptimenanoseconds.c
+++ b/cpukit/rtems/src/clockgetuptimenanoseconds.c
@@ -18,6 +18,7 @@
 #endif
 
 #include <rtems/rtems/clock.h>
+#include <rtems/score/timestampimpl.h>
 #include <rtems/score/todimpl.h>
 
 uint64_t rtems_clock_get_uptime_nanoseconds( void )
diff --git a/cpukit/rtems/src/clockgetuptimetimeval.c b/cpukit/rtems/src/clockgetuptimetimeval.c
index 2e09ae2cd2..0e095e6cb5 100644
--- a/cpukit/rtems/src/clockgetuptimetimeval.c
+++ b/cpukit/rtems/src/clockgetuptimetimeval.c
@@ -24,6 +24,7 @@
 #endif
 
 #include <rtems/rtems/clock.h>
+#include <rtems/score/timestampimpl.h>
 #include <rtems/score/todimpl.h>
 
 void rtems_clock_get_uptime_timeval( struct timeval *uptime )
-- 
2.16.4



More information about the devel mailing list