src/SALOMELocalTrace/LocalTraceBufferPool.hxx

   1 //  Copyright (C) 2004  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  19 //
  20 //  Author : Paul RASCLE (EDF)
  21 //  Module : KERNEL
  22 //  $Header$
  23
  24 #ifndef _LOCALTRACEBUFFERPOOL_HXX_
  25 #define _LOCALTRACEBUFFERPOOL_HXX_
  26
  27 #define TRACE_BUFFER_SIZE 256  // number of entries in circular buffer
  28                                // must be power of 2
  29 #define MAX_TRACE_LENGTH 256   // messages are truncated at this size
  30
  31 #include <pthread.h>
  32 #include <semaphore.h>
  33 #include "BaseTraceCollector.hxx"
  34 #include "BasicsGenericDestructor.hxx"
  35
  36 #define ABORT_MESS  1   // for traceType field in struct LocalTrace_TraceInfo
  37 #define NORMAL_MESS 0
  38
  39 struct SALOMELOCALTRACE_EXPORT LocalTrace_TraceInfo
  40 {
  41   char trace[MAX_TRACE_LENGTH];
  42   pthread_t threadId;
  43   int traceType;                 // normal or abort
  44   int position;                  // to check sequence
  45 };
  46
  47 class SALOMELOCALTRACE_EXPORT LocalTraceBufferPool : public PROTECTED_DELETE
  48 {
  49  public:
  50   static LocalTraceBufferPool* instance();
  51   int insert(int traceType, const char* msg);
  52   int retrieve(LocalTrace_TraceInfo& aTrace);
  53   unsigned long toCollect();
  54
  55  protected:
  56   LocalTraceBufferPool();
  57   virtual ~LocalTraceBufferPool();
  58   unsigned long lockedIncrement(unsigned long& pos);
  59
  60  private:
  61   static LocalTraceBufferPool* _singleton;
  62   static pthread_mutex_t _singletonMutex;
  63   static BaseTraceCollector *_myThreadTrace;
  64
  65   LocalTrace_TraceInfo _myBuffer[TRACE_BUFFER_SIZE];
  66   sem_t _freeBufferSemaphore;       // to wait until there is a free buffer
  67   sem_t _fullBufferSemaphore;       // to wait until there is a buffer to print
  68   pthread_mutex_t _incrementMutex;  // to lock position variables for increment
  69   unsigned long _position;
  70   unsigned long _insertPos;
  71   unsigned long _retrievePos;
  72 };
  73
  74 #endif