Scheduler/ClockService.cci

   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 inline non-template implementation */
  25
  26 // Custom includes
  27 #include <boost/date_time/posix_time/posix_time_types.hpp>
  28
  29 #define prefix_ inline
  30 ///////////////////////////////cci.p///////////////////////////////////////
  31
  32 ///////////////////////////////////////////////////////////////////////////
  33 // senf::ClockService
  34
  35 prefix_ senf::ClockService::clock_type senf::ClockService::now()
  36 {
  37     return instance().now_m();
  38 }
  39
  40 prefix_ senf::ClockService::abstime_type senf::ClockService::abstime(clock_type clock)
  41 {
  42     return instance().abstime_m(clock);
  43 }
  44
  45 prefix_ senf::ClockService::clock_type senf::ClockService::clock(abstime_type time)
  46 {
  47     return instance().clock_m(time);
  48 }
  49
  50 prefix_ senf::ClockService::clock_type senf::ClockService::from_time_t(time_t const & time)
  51 {
  52     return clock( boost::posix_time::from_time_t(time) );
  53 }
  54
  55 prefix_ senf::ClockService::clock_type senf::ClockService::from_timeval(timeval const & time)
  56 {
  57     return from_time_t(time.tv_sec) + ClockService::microseconds(time.tv_usec);
  58 }
  59
  60 prefix_ senf::ClockService::clock_type senf::ClockService::nanoseconds(int64_type v)
  61 {
  62     return v;
  63 }
  64
  65 prefix_ senf::ClockService::clock_type senf::ClockService::microseconds(int64_type v)
  66 {
  67     return v * nanoseconds(1000);
  68 }
  69
  70 prefix_ senf::ClockService::clock_type senf::ClockService::milliseconds(int64_type v)
  71 {
  72     return v * microseconds(1000);
  73 }
  74
  75 prefix_ senf::ClockService::clock_type senf::ClockService::seconds(int64_type v)
  76 {
  77     return v * milliseconds(1000);
  78 }
  79
  80 prefix_ senf::ClockService::clock_type senf::ClockService::minutes(int64_type v)
  81 {
  82     return v * seconds(60);
  83 }
  84
  85 prefix_ senf::ClockService::clock_type senf::ClockService::hours(int64_type v)
  86 {
  87     return v * minutes(60);
  88 }
  89
  90 prefix_ senf::ClockService::clock_type senf::ClockService::days(int64_type v)
  91 {
  92     return v * hours(24);
  93 }
  94
  95 prefix_ senf::ClockService::clock_type senf::ClockService::in_nanoseconds(int64_type v)
  96 {
  97     return v;
  98 }
  99
 100 prefix_ senf::ClockService::clock_type senf::ClockService::in_microseconds(int64_type v)
 101 {
 102     return v / nanoseconds(1000);
 103 }
 104
 105 prefix_ senf::ClockService::clock_type senf::ClockService::in_milliseconds(int64_type v)
 106 {
 107     return v / microseconds(1000);
 108 }
 109
 110 prefix_ senf::ClockService::clock_type senf::ClockService::in_seconds(int64_type v)
 111 {
 112     return v / milliseconds(1000);
 113 }
 114
 115 prefix_ senf::ClockService::clock_type senf::ClockService::in_minutes(int64_type v)
 116 {
 117     return v / seconds(60);
 118 }
 119
 120 prefix_ senf::ClockService::clock_type senf::ClockService::in_hours(int64_type v)
 121 {
 122     return v / minutes(60);
 123 }
 124
 125 prefix_ senf::ClockService::clock_type senf::ClockService::in_days(int64_type v)
 126 {
 127     return v / hours(24);
 128 }
 129
 130 prefix_ void senf::ClockService::restart()
 131 {
 132     instance().restart_m();
 133 }
 134
 135 ////////////////////////////////////////
 136 // private members
 137
 138 prefix_ senf::ClockService::clock_type senf::ClockService::now_m()
 139 {
 140     // We want to make the normal case (no skew) really fast. This first 'checkSkew' *might*
 141     // transiently fail if a SIGALRM is delivered in the midst of the test. updateSkew will
 142     // therefore block signals and do the check again to make sure.
 143     //
 144     // The opposite case (the test returns 'false' even though it should return 'true') is so highly
 145     // improbable that it is treated as academic. (it will be catched by the next SIGALRM)
 146
 147     boost::posix_time::ptime time (boost::posix_time::microsec_clock::universal_time());
 148     if (checkSkew(time))
 149         updateSkew(time);
 150
 151     // 'clock' will pick up the corrected base_ value if needed.
 152     return clock_m(time);
 153 }
 154
 155 prefix_ senf::ClockService::abstime_type senf::ClockService::abstime_m(clock_type clock)
 156 {
 157 #ifdef BOOST_DATE_TIME_POSIX_TIME_STD_CONFIG
 158     return base_ + boost::posix_time::nanoseconds(clock);
 159 #else
 160     return base_ + boost::posix_time::microseconds((clock+500)/1000);
 161 #endif
 162 }
 163
 164 prefix_ senf::ClockService::clock_type senf::ClockService::clock_m(abstime_type time)
 165 {
 166     ///\fixme What happens, if base_ is changed in SIGALRM while reading it here ?
 167
 168     // Idea: Have *two* base values: one is written by the SIGALRM handler, the other is only
 169     // Written by synchronous code. If they differ, we block signals, copy over and continue.  If
 170     // they transiently differ because we are reading the SIGALRM value while it is being changed
 171     // this does not matter: We will then still copy it over.
 172
 173     boost::posix_time::time_duration delta (time - base_);
 174     return clock_type( delta.ticks() )
 175         * clock_type( 1000000000UL / boost::posix_time::time_duration::ticks_per_second() );
 176 }
 177
 178 prefix_ bool senf::ClockService::checkSkew(boost::posix_time::ptime time)
 179 {
 180     boost::posix_time::ptime h (heartbeat_); // reduce chance for race condition
 181     return time < h || (time - h) > boost::posix_time::seconds(2*CheckInterval);
 182 }
 183
 184 prefix_ void senf::ClockService::clockSkew(boost::posix_time::ptime time,
 185                                            boost::posix_time::ptime expected)
 186 {
 187     base_ += (time - expected);
 188 }
 189
 190 ///////////////////////////////cci.e///////////////////////////////////////
 191 #undef prefix_
 192
 193 \f
 194 // Local Variables:
 195 // mode: c++
 196 // fill-column: 100
 197 // comment-column: 40
 198 // c-file-style: "senf"
 199 // indent-tabs-mode: nil
 200 // ispell-local-dictionary: "american"
 201 // compile-command: "scons -u test"
 202 // End: