include/anna/core/tracing/TraceWriter.hpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 #ifndef anna_core_tracing_TraceWriter_hpp
  10 #define anna_core_tracing_TraceWriter_hpp
  11
  12 #include <vector>
  13
  14 #include <anna/core/mt/NRMutex.hpp>
  15 #include <anna/core/tracing/Logger.hpp>
  16 #include <anna/config/defines.hpp>
  17 #include <anna/core/util/Microsecond.hpp>
  18
  19 namespace anna {
  20
  21 class Configuration;
  22 class TraceWriterObserver;
  23
  24 /**
  25    Grabador de trazas
  26    @see Logger
  27 */
  28 class TraceWriter : public Logger::Writer {
  29 public:
  30   static const int DefaultMaxKBSize = 4192 * 1024;
  31
  32   /**
  33      Constructor.
  34      \warning Si se usa este constructor las trazas se escribiran en un fichero del directorio temporal
  35      con el mismo nombre que el pid del proceso.
  36   */
  37   TraceWriter();
  38
  39   /**
  40      Constructor.
  41      \param fileName Nombre del fichero de trazas.
  42      \param maxSize Tama�o maximo del fichero de trazas expresando en bytes.
  43   */
  44   TraceWriter(const char* fileName, const int maxSize);
  45
  46   /**
  47      Devuelve el tama�o maximo del fichero de trazas.
  48      \return El tama�o maximo del fichero de trazas.
  49   */
  50   int getMaxSize() const { return a_maxSize; }
  51
  52   /**
  53      Metodo para cambiar dinamicamente la configuracion del grabador de trazas. Las seccciones
  54      requeridas para el archivo de configuracion seran:
  55
  56      \code
  57      [Trace]
  58      MaxFileSize = Kbytes maximo de los ficheros de trazas. Por defecto sera 4096 Kbytes
  59      Level = Nivel de trazas con el que comenzar la configuracion. Por defecto sera Debug para las
  60      versiones con depuracion y Error para las versiones definitivas.
  61      Clean = Un 1 indica que los ficheros de trazas usados hasta el momento deben borrarse y un 0
  62      indica que deben mantenerse. Por defecto sera 1.
  63      \endcode
  64
  65      Todos los parametros de la seccion \em Trace son opcionales.
  66
  67      \param fileName Nombre del fichero de trazas.
  68      \param configuration Configuracion que contiene las variables y secciones necesarias
  69      para establecer la configuracion desea del grabador de trazas.
  70
  71      \warning La configuracion debera estar correctamente cargada. Ver Configuration::load.
  72   */
  73   void setup(const char* fileName, const Configuration& configuration) ;
  74
  75   /**
  76      Metodo para cambiar dinamicamente la configuracion del grabador de trazas.
  77
  78      \param fileName Nombre del fichero de trazas.
  79      \param maxSize Tama�o maximo del fichero de trazas expresando en bytes. Un valor 0 mantiene
  80      el valor del tama�o estahlecido hasta el momento.
  81      \param clean \em true Indica que los ficheros de trazas usados hasta el momento deben
  82      borrase, \em false indica que los ficheros de trazas deben mantenerse.
  83
  84      \warning Solo deberia llamarse una vez para cambiar de la configuracion por defecto a la
  85      configuracion particular de cada proceso.
  86   */
  87   void setup(const char* fileName, const int maxSize = 0, const bool clean = true) ;
  88
  89   /**
  90      Saca por pantalla la informacion relevente de este grabador de trazas.
  91   */
  92   void printResume() ;
  93
  94   /**
  95      Conecta esta instancia con un TraceWriterObserver, lo que permitira que esta instancia
  96      conozca cuando se abre o cierra el fichero asociado a la escritura de trazas.
  97
  98      Este metodo puede invocarse tantas veces como sea necesario con distintas instancias de observador.
  99
 100      \param observer Instancia del observador que recibira las notificaciones de apertura y
 101      cierre del fichero usado para sacar las trazas.
 102
 103      \warning La instancia del TraceWriterObserver debera estar disponible durante toda
 104      la ejecucion.
 105   */
 106   void attach(TraceWriterObserver* observer) ;
 107
 108 private:
 109   typedef std::vector <TraceWriterObserver*>::iterator observer_iterator;
 110
 111   static const int ErrorStream = 2;
 112
 113   class GuardNoLog {
 114   public:
 115     GuardNoLog(NRMutex& mutex) : a_mutex(mutex) { mutex.lock(); }
 116     ~GuardNoLog() { a_mutex.unlock(); }
 117   private:
 118     NRMutex& a_mutex;
 119   };
 120
 121   std::string a_outputFile;
 122   std::string a_outputOldFile;
 123   int a_maxSize;
 124   int a_stream;
 125   Microsecond a_lastTime;
 126   std::string a_date;
 127   NRMutex a_mutex;
 128   std::vector <TraceWriterObserver*> a_observers;
 129   bool a_observed;
 130
 131   observer_iterator observer_begin() { return a_observers.begin(); }
 132   observer_iterator observer_end() { return a_observers.end(); }
 133
 134   static TraceWriterObserver* observer(observer_iterator& ii) { return *ii; }
 135
 136   void initialize(const char*) { printResume(); }
 137   void do_write(int level, const char* text, ...) ;
 138   const char* getDate() ;
 139   int prepareOutput(const char* date) ;
 140 };
 141
 142 }
 143
 144 #endif