source/timex/internal/TickProducer.cpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #include <unistd.h>
  38 #include <signal.h>
  39
  40 #include <anna/core/functions.hpp>
  41 #include <anna/core/tracing/Logger.hpp>
  42
  43 #include <anna/app/functions.hpp>
  44 #include <anna/app/Application.hpp>
  45
  46 #include <anna/comm/Communicator.hpp>
  47
  48 #include <anna/timex/internal/TickProducer.hpp>
  49 #include <anna/timex/Engine.hpp>
  50
  51 using namespace std;
  52 using namespace anna;
  53
  54 //static
  55 void* timex::TickProducer::exec(void* arg)
  56 throw() {
  57   sigset_t mask;
  58   sigemptyset(&mask);
  59   pthread_sigmask(SIG_SETMASK, &mask, NULL);
  60   timex::TickProducer* _this = reinterpret_cast <timex::TickProducer*>(arg);
  61
  62   try {
  63     comm::Communicator* communicator = app::functions::component <comm::Communicator> (ANNA_FILE_LOCATION);
  64
  65     while(communicator->isServing() == false)
  66       functions::sleep(Millisecond(100));
  67
  68     while(_this->a_requestedStop == false) {
  69       functions::sleep(_this->calculeSlice(functions::millisecond()));
  70       _this->tick();
  71     }
  72   } catch(RuntimeException& ex) {
  73     Logger::write(Logger::Critical, ex.getText(), ANNA_FILE_LOCATION);
  74     exit(-1);
  75   }
  76
  77   return NULL;
  78 }
  79
  80 timex::TickProducer::TickProducer(timex::Engine* timeController, const int fdWrite) :
  81   a_timeController(*timeController),
  82   a_fdWrite(fdWrite),
  83   a_expectedTime(0),
  84   a_isInPause(false),
  85   a_requestedStop(false)
  86 {;}
  87
  88 void timex::TickProducer::tick()
  89 throw() {
  90   static char onebyte = 0xff;
  91   static int errorCount = 0;
  92
  93   if(a_isInPause == true)
  94     return;
  95
  96   if(write(a_fdWrite, &onebyte, sizeof(onebyte)) < 0) {
  97     Logger::write(Logger::Critical, "Cannot generate tick", strerror(errno), ANNA_FILE_LOCATION);
  98
  99     if(++ errorCount == 10) {
 100       Logger::write(Logger::Critical, "Terminating application due to error at tick generation", ANNA_FILE_LOCATION);
 101       app::functions::getApp().eventAbnormalTermination("timex::TickProducer");
 102       _exit(-1);
 103     }
 104   }
 105 }
 106
 107 //--------------------------------------------------------------------------------------------
 108 // Calcula la duracion del proximo tick de reloj. Tiene en cuenta la deriva del anterior
 109 // tick y la corrige en este.
 110 // (2) Si es mayor que cero => El reloj del sistema se adelanta
 111 //     Si es menor que cero => El reloj del sistema se atrasa.
 112 // (3) Si la correcin aplicada es mayor del 5% de la resolucin volvemos a calcularla ya
 113 //     que podemos considerar que normalmente no desviar�tanto tiempo.
 114 //--------------------------------------------------------------------------------------------
 115 Millisecond timex::TickProducer::calculeSlice(const Millisecond & msnow)
 116 throw() {
 117   Millisecond result(a_timeController.getResolution());
 118   int correction = (a_expectedTime == 0) ? 0 : (a_expectedTime - msnow);           // (2)
 119
 120   if(correction != 0) {
 121     if(((abs(correction) * 100) / result) > 5)                                       // (3)
 122       correction = 0;
 123
 124     result += Millisecond(correction);
 125   }
 126
 127   a_expectedTime = msnow + result;
 128   return result;
 129 }
 130
 131