src/SALOMELocalTrace/LocalTraceCollector.cxx

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  File   : LocalTraceCollector.cxx
  23 //  Author : Paul RASCLE (EDF)
  24 //  Module : KERNEL
  25 //  $Header$
  26 //
  27 #include <iostream>
  28 #include <sstream>
  29 #include <fstream>
  30 #include <cstdlib>
  31
  32 using namespace std;
  33
  34 #include "LocalTraceCollector.hxx"
  35
  36 // ============================================================================
  37 /*!
  38  *  This class is for use without CORBA, inside or outside SALOME.
  39  *  SALOME uses SALOMETraceCollector, to allow trace collection via CORBA.
  40  *  Type of trace (and corresponding class) is choosen in LocalTraceBufferPool.
  41  *
  42  *  Guarantees a unique object instance of the class (singleton thread safe)
  43  *  a separate thread for loop to print traces is launched.
  44  */
  45 // ============================================================================
  46
  47 BaseTraceCollector* LocalTraceCollector::instance()
  48 {
  49   if (_singleton == 0) // no need of lock when singleton already exists
  50     {
  51       int ret;
  52       ret = pthread_mutex_lock(&_singletonMutex); // acquire lock to be alone
  53       if (_singleton == 0)                     // another thread may have got
  54         {                                      // the lock after the first test
  55           BaseTraceCollector* myInstance = new LocalTraceCollector();
  56
  57           sem_init(&_sem,0,0); // to wait until run thread is initialized
  58           pthread_t traceThread;
  59           pthread_create(&traceThread, NULL,
  60                                    LocalTraceCollector::run, NULL);
  61           sem_wait(&_sem);
  62           _singleton = myInstance; // _singleton known only when init done
  63         }
  64       ret = pthread_mutex_unlock(&_singletonMutex); // release lock
  65     }
  66   return _singleton;
  67 }
  68
  69 // ============================================================================
  70 /*!
  71  *  In a separate thread, loop to print traces.
  72  *  Mutex garantees intialisation on instance method is done and only one run
  73  *  allowed (double check ...)
  74  *  Loop until there is no more buffer to print,
  75  *  and no ask for end from destructor.
  76  *  Get a buffer. If type = ABORT then exit application with message.
  77  */
  78 // ============================================================================
  79
  80 void* LocalTraceCollector::run(void *bid)
  81 {
  82   _threadId = new pthread_t;
  83   *_threadId = pthread_self();
  84   sem_post(&_sem); // unlock instance
  85
  86   LocalTraceBufferPool* myTraceBuffer = LocalTraceBufferPool::instance();
  87   LocalTrace_TraceInfo myTrace;
  88
  89   // --- Loop until there is no more buffer to print,
  90   //     and no ask for end from destructor.
  91
  92   while ((!_threadToClose) || myTraceBuffer->toCollect() )
  93     {
  94       if (_threadToClose)
  95         {
  96           DEVTRACE("FileTraceCollector _threadToClose");
  97           //break;
  98         }
  99
 100       myTraceBuffer->retrieve(myTrace);
 101       if (myTrace.traceType == ABORT_MESS)
 102         {
 103           cout << flush ;
 104 #ifndef WIN32
 105           cerr << "INTERRUPTION from thread " << myTrace.threadId
 106                << " : " <<  myTrace.trace;
 107 #else
 108           cerr << "INTERRUPTION from thread " << (void*)(&myTrace.threadId)
 109                << " : " <<  myTrace.trace;
 110 #endif
 111           cerr << flush ;
 112           exit(1);
 113         }
 114       else
 115         {
 116           cout << flush ;
 117 #ifndef WIN32
 118           cerr << "th. " << myTrace.threadId << " " << myTrace.trace;
 119 #else
 120           cerr << "th. " << (void*)(&myTrace.threadId)
 121                << " " << myTrace.trace;
 122 #endif
 123           cerr << flush ;
 124         }
 125     }
 126   pthread_exit(NULL);
 127   return NULL;
 128 }
 129
 130 // ============================================================================
 131 /*!
 132  *  Destructor: wait until printing thread ends (LocalTraceCollector::run)
 133  */
 134 // ============================================================================
 135
 136 LocalTraceCollector:: ~LocalTraceCollector()
 137 {
 138   int ret;
 139   ret = pthread_mutex_lock(&_singletonMutex); // acquire lock to be alone
 140   if (_singleton)
 141     {
 142       DEVTRACE("LocalTraceCollector:: ~LocalTraceCollector()");
 143       LocalTraceBufferPool* myTraceBuffer = LocalTraceBufferPool::instance();
 144       _threadToClose = 1;
 145       myTraceBuffer->insert(NORMAL_MESS,"end of trace\n"); // to wake up thread
 146       if (_threadId)
 147         {
 148           int ret = pthread_join(*_threadId, NULL);
 149           if (ret) cerr << "error close LocalTraceCollector : "<< ret << endl;
 150           else DEVTRACE("LocalTraceCollector destruction OK");
 151           delete _threadId;
 152           _threadId = 0;
 153           _threadToClose = 0;
 154         }
 155       _singleton = 0;
 156     }
 157   ret = pthread_mutex_unlock(&_singletonMutex); // release lock
 158 }
 159
 160 // ============================================================================
 161 /*!
 162  * Constructor: no need of LocalTraceBufferPool object initialization here,
 163  * thread safe singleton used in LocalTraceBufferPool::instance()
 164  */
 165 // ============================================================================
 166
 167 LocalTraceCollector::LocalTraceCollector()
 168 {
 169   _threadId=0;
 170   _threadToClose = 0;
 171 }
 172
 173