Scheduler/ClockService.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief ClockService public header */
  25
  26 #ifndef HH_ClockService_
  27 #define HH_ClockService_ 1
  28
  29 // Custom includes
  30 #include <sys/time.h>
  31 #include <boost/utility.hpp>
  32 #include <boost/date_time/posix_time/posix_time.hpp>
  33 #include <boost/scoped_ptr.hpp>
  34 #include "../Utils/singleton.hh"
  35
  36 //#include "ClockService.mpp"
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38
  39 namespace senf {
  40
  41 #ifndef DOXYGEN
  42     namespace detail { class ClockServiceTest; }
  43 #endif
  44
  45     // Implementation note:
  46     //
  47     // The clock value is represented as a 64bit unsigned integer number of nanosecods elapsed since
  48     // the construction of the ClockService object.
  49     //
  50     // The implementation must provide two features:
  51     // a) It must reliably detect clock changes
  52     // b) In case of a clock change a reasonably accurate fallback clock value must be provided
  53     //
  54     // We do this using setitimer/getitimer. We setup an interval timer sending SIGALRM whenever
  55     // CheckInverval seconds have elapsed.
  56     //
  57     // On every SIGALRM signal we save the current value of gettimeofday(). If this new value is
  58     // substantially different from the currently saved value + CheckInterval, the clock has been
  59     // changed.
  60     //
  61     // Whenever the current clock value is requested using now(), the current gettimeofday() value
  62     // is compared with the saved value. If the difference is substantially more than CheckInterval,
  63     // the clock has been changed.
  64     //
  65     // This provides clock skew detection. If clock skew is detected, we need to move base_ by the
  66     // amount the time has been changed. To do this we need an as accurate as possible approximation
  67     // of the expected current time value. We need to differentiate two cases:
  68     //
  69     // a) Clock skew detected within now()
  70     //
  71     // In this case, we use getitimer() to find the time remaining in the timer. Using this value
  72     // and the saved gettimeofday() value we can adjust base_ accordingly.
  73     //
  74     // b) Clock skew detected in the signal handler
  75     //
  76     // In this case we use the saved gettimeofday() value + CheckInterval to adjust base_.
  77
  78     /** \brief Reliable high precision monotonous clock source
  79
  80         The ClockService provides a highly accurate monotonous clock source based on
  81         gettimeofday(). However, it takes additional precautions to detect clock skew.
  82
  83         \implementation We use a mix of static and non-static members to achieve high performance
  84             in the normal case (no clock skew) and still encapsulate the dependency on legacy C
  85             headers. Using the senf::singleton mixin ensures, that the instance is constructed
  86             before main even when instance() is not called.
  87
  88         \bug There is a deadlock condition between ClockService and the streaming of Boost.DateTime
  89             values: Boost.DateTime seems to call tzset() whenever writing a date/time value (ugh)
  90             and since tzset changes basic date/time values, it seems to block gettimeofday() which
  91             leads to the SIGLARM handler blocking indefinitely. Resolution either a) find out, why
  92             tzset() of all functions is called or b) move the ClockService heartbeat functionality
  93             into the Scheduler.
  94       */
  95     class ClockService
  96         : singleton<ClockService>
  97     {
  98     public:
  99         ///////////////////////////////////////////////////////////////////////////
 100         // Types
 101
 102         /** \brief ClockService timer data type
 103
 104             Unsigned integer type representing scheduler time. Scheduler time is measured in
 105             nanoseconds relative to some implementation defined reference time.
 106          */
 107         typedef boost::int_fast64_t clock_type;
 108         typedef boost::int_fast64_t int64_type;
 109
 110         /** \brief Absolute time data type
 111
 112             Boost.DateTime datatype used to represent absolute date/time values.
 113          */
 114         typedef boost::posix_time::ptime abstime_type;
 115
 116         static unsigned const CheckInterval = 10;
 117
 118         ///////////////////////////////////////////////////////////////////////////
 119         ///\name Structors and default members
 120         ///@{
 121
 122         ~ClockService();
 123
 124         ///@}
 125         ///////////////////////////////////////////////////////////////////////////
 126
 127         static clock_type now();  ///< Return current clock value
 128
 129         static abstime_type abstime(clock_type clock); ///< Convert clock to absolute time
 130                                         /**< This member converts a clock value into an absolute
 131                                              Boost.DateTime value.
 132                                              \note You should not base timeout calculations on this
 133                                                  absolute time value. Clock time is guaranteed to be
 134                                                  monotonous, absolute time may be non-monotonous if
 135                                                  the system date/time is changed. */
 136
 137         static clock_type clock(abstime_type time); ///< Convert absolute time to clock value
 138                                         /**< This member converst an absolute time value into the
 139                                              corresponding clock value.
 140                                              \see abstime */
 141
 142         static clock_type from_time_t(time_t const & time);
 143                                         ///< Convert legacy time_t to clock value
 144                                         /**< This member converts an absolute time value
 145                                              represented as a time_t value into a clock value */
 146
 147         static clock_type from_timeval(timeval const & time);
 148                                         ///< Convert legacy timeval to clock value
 149                                         /**< This member converts an absolute time value
 150                                              represented as a timeval value into a clock value */
 151
 152         static clock_type nanoseconds(int64_type v); ///< Convert \a v nanoseconds to clock_type
 153         static clock_type microseconds(int64_type v); ///< Convert \a v microseconds to clock_type
 154         static clock_type milliseconds(int64_type v); ///< Convert \a v milliseconds to clock_type
 155         static clock_type seconds(int64_type v); ///< Convert \a v seconds to clock_type
 156         static clock_type minutes(int64_type v); ///< Convert \a v minutes to clock_type
 157         static clock_type hours(int64_type v); ///< Convert \a v hours to clock_type
 158         static clock_type days(int64_type v); ///< Convert \a v days to clock_type
 159
 160         static int64_type in_nanoseconds(clock_type v); ///< Convert \a v to nanoseconds
 161         static int64_type in_microseconds(clock_type v); ///< Convert \a v to microseconds
 162         static int64_type in_milliseconds(clock_type v); ///< Convert \a v to milliseconds
 163         static int64_type in_seconds(clock_type v); ///< Convert \a v to seconds
 164         static int64_type in_minutes(clock_type v); ///< Convert \a v to minutes
 165         static int64_type in_hours(clock_type v); ///< Convert \a v to hours
 166         static int64_type in_days(clock_type v); ///< Convert \a v to days
 167
 168         static void restart();
 169
 170     private:
 171         ClockService();
 172
 173         void timer();
 174
 175         clock_type now_m();
 176         abstime_type abstime_m(clock_type clock);
 177         clock_type clock_m(abstime_type time);
 178         void restart_m(bool restart = true);
 179
 180         bool checkSkew(boost::posix_time::ptime time);
 181         void updateSkew(boost::posix_time::ptime time);
 182         void clockSkew(boost::posix_time::ptime time, boost::posix_time::ptime expected);
 183
 184         void restartTimer(bool restart = true);
 185
 186         boost::posix_time::ptime base_;
 187         boost::posix_time::ptime heartbeat_;
 188
 189         // I don't want this header to depend on the legacy C headers.
 190         /// Internal: ClockService private data (PIMPL idiom)
 191         struct Impl;
 192         boost::scoped_ptr<Impl> impl_;
 193
 194         friend class Impl;
 195 #ifndef DOXYGEN
 196         friend class senf::detail::ClockServiceTest;
 197         friend class singleton<ClockService>;
 198 #endif
 199     };
 200
 201 }
 202
 203 ///////////////////////////////hh.e////////////////////////////////////////
 204 #include "ClockService.cci"
 205 //#include "ClockService.ct"
 206 //#include "ClockService.cti"
 207 #endif
 208
 209 \f
 210 // Local Variables:
 211 // mode: c++
 212 // fill-column: 100
 213 // comment-column: 40
 214 // c-file-style: "senf"
 215 // indent-tabs-mode: nil
 216 // ispell-local-dictionary: "american"
 217 // compile-command: "scons -u test"
 218 // End: