Salome HOME
Try to kill Salome application when a YACS Launcher job is killed
[modules/kernel.git] / src / SALOMELocalTrace / LocalTraceBufferPool.cxx
index 8a997221a423b19e5e946bf704c8ba89f886fb6c..74c3a2527f57dccf8d961f7ce47e7dac08f16464 100644 (file)
@@ -1,47 +1,78 @@
-//  Copyright (C) 2004  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+// Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
 //
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 //  Author : Paul RASCLE (EDF)
 //  Module : KERNEL
 //  $Header$
-//
 // Cf. C++ Users Journal, June 2004, Tracing Application Execution, Tomer Abramson
 //
-
 #include <iostream>
 #include <limits.h>
+#include <cassert>
+#include <string.h>
+#include <cstdio>
+
+#ifndef WIN32
+#include <dlfcn.h>
+#else
+#include <windows.h>
+#endif
 
+//#define _DEVDEBUG_
 #include "LocalTraceBufferPool.hxx"
+#include "BaseTraceCollector.hxx"
+#include "LocalTraceCollector.hxx"
+#include "FileTraceCollector.hxx"
 #include "utilities.h"
 
-using namespace std;
-
 // In case of truncated message, end of trace contains "...\n\0"
+
 #define TRUNCATED_MESSAGE "...\n"
 #define MAXMESS_LENGTH MAX_TRACE_LENGTH-5
 
+// Class static attributes initialisation
+
 LocalTraceBufferPool* LocalTraceBufferPool::_singleton = 0;
-pthread_mutex_t LocalTraceBufferPool::_singletonMutex;
+//#ifndef WIN32
+//pthread_mutex_t LocalTraceBufferPool::_singletonMutex;
+//#else
+pthread_mutex_t LocalTraceBufferPool::_singletonMutex =
+  PTHREAD_MUTEX_INITIALIZER;
+//#endif
+BaseTraceCollector *LocalTraceBufferPool::_myThreadTrace = 0;
 
 // ============================================================================
 /*!
- *  guarantees a unique object instance of the class (singleton thread safe)
+ *  Guarantees a unique object instance of the class (singleton thread safe).
+ *  When the LocalTraceBufferPool instance is created, the trace collector is
+ *  also created (singleton). Type of trace collector to create depends on 
+ *  environment variable "SALOME_trace":
+ *  - "local" implies standard err trace, LocalTraceCollector is launched.
+ *  - "file" implies trace in /tmp/tracetest.log
+ *  - "file:pathname" implies trace in file pathname
+ *  - anything else like "other" : try to load dynamically a library named
+ *    otherTraceCollector, and invoque C method instance() to start a singleton
+ *    instance of the trace collector. Example: with_loggerTraceCollector, for
+ *    CORBA Log.
  */
 // ============================================================================
 
@@ -52,9 +83,72 @@ LocalTraceBufferPool* LocalTraceBufferPool::instance()
       int ret;
       ret = pthread_mutex_lock(&_singletonMutex); // acquire lock to be alone
       if (_singleton == 0)                     // another thread may have got
-       {                                      // the lock after the first test
-         _singleton = new LocalTraceBufferPool(); 
-       }
+        {                                      // the lock after the first test
+          DEVTRACE("New buffer pool");
+          LocalTraceBufferPool* myInstance = new LocalTraceBufferPool(); 
+
+          new DESTRUCTOR_OF<LocalTraceBufferPool> (*myInstance);
+          _singleton = myInstance;
+
+          // --- start a trace Collector
+
+          char* traceKind = getenv("SALOME_trace");
+
+          if ( !traceKind || strcmp(traceKind,"local")==0 ) // mkr : 27.11.2006 : PAL13967 - Distributed supervision graphs - Problem with "SALOME_trace"
+            {
+              _myThreadTrace = LocalTraceCollector::instance();
+            }
+          else if (strncmp(traceKind,"file",strlen("file"))==0)
+            {
+              const char *fileName;
+              if (strlen(traceKind) > strlen("file"))
+                fileName = &traceKind[strlen("file")+1];
+              else
+                fileName = "/tmp/tracetest.log";
+              
+              _myThreadTrace = FileTraceCollector::instance(fileName);
+            }
+          else // --- try a dynamic library
+            {
+#ifndef WIN32
+              void* handle;
+              std::string impl_name = std::string ("lib") + traceKind 
+                + std::string("TraceCollector.so");
+              handle = dlopen( impl_name.c_str() , RTLD_LAZY ) ;
+#else
+              HINSTANCE handle;
+              std::string impl_name = std::string ("lib") + traceKind + std::string(".dll");
+              handle = LoadLibrary( impl_name.c_str() );
+#endif
+              if ( handle )
+                {
+                  typedef BaseTraceCollector * (*FACTORY_FUNCTION) (void);
+#ifndef WIN32
+                  FACTORY_FUNCTION TraceCollectorFactory =
+                    (FACTORY_FUNCTION) dlsym(handle, "SingletonInstance");
+#else
+                  FACTORY_FUNCTION TraceCollectorFactory =
+                    (FACTORY_FUNCTION)GetProcAddress(handle, "SingletonInstance");
+#endif
+                  if ( !TraceCollectorFactory )
+                  {
+                                         std::cerr << "Can't resolve symbol: SingletonInstance" <<std::endl;
+#ifndef WIN32
+                      std::cerr << "dlerror: " << dlerror() << std::endl;
+#endif
+                      exit( 1 );
+                    }
+                  _myThreadTrace = (TraceCollectorFactory) ();
+                }
+              else
+                {
+                  std::cerr << "library: " << impl_name << " not found !" << std::endl;
+                  assert(handle); // to give file and line
+                  exit(1);        // in case assert is deactivated
+                }             
+            }
+          DEVTRACE("New buffer pool: end");
+        }
       ret = pthread_mutex_unlock(&_singletonMutex); // release lock
     }
   return _singleton;
@@ -79,7 +173,12 @@ int LocalTraceBufferPool::insert(int traceType, const char* msg)
 
   // wait until there is a free buffer in the pool
 
-  int ret = sem_wait(&_freeBufferSemaphore);
+  int ret = -1;
+  while (ret)
+    {
+      ret = sem_wait(&_freeBufferSemaphore);
+      if (ret) perror(" LocalTraceBufferPool::insert, sem_wait");
+    }
 
   // get the next free buffer available (mutex protected) 
 
@@ -88,8 +187,8 @@ int LocalTraceBufferPool::insert(int traceType, const char* msg)
   // fill the buffer with message, thread id and type (normal or abort)
 
   strncpy(_myBuffer[myInsertPos%TRACE_BUFFER_SIZE].trace,
-         msg,
-         MAXMESS_LENGTH); // last chars always "...\n\0" if msg too long
+          msg,
+          MAXMESS_LENGTH); // last chars always "...\n\0" if msg too long
   _myBuffer[myInsertPos%TRACE_BUFFER_SIZE].threadId =pthread_self();//thread id
   _myBuffer[myInsertPos%TRACE_BUFFER_SIZE].traceType = traceType;
   _myBuffer[myInsertPos%TRACE_BUFFER_SIZE].position = myMessageNumber;
@@ -119,7 +218,12 @@ int LocalTraceBufferPool::retrieve(LocalTrace_TraceInfo& aTrace)
 
   // wait until there is a buffer in the pool, with a message to print
 
-  int ret = sem_wait(&_fullBufferSemaphore);
+  int ret = -1;
+  while (ret)
+    {
+      ret = sem_wait(&_fullBufferSemaphore);
+      if (ret) MESSAGE (" LocalTraceBufferPool::retrieve, sem_wait");
+    }
 
   // get the next buffer to print
 
@@ -128,8 +232,8 @@ int LocalTraceBufferPool::retrieve(LocalTrace_TraceInfo& aTrace)
   // copy the buffer from the pool to the provided buffer
 
   memcpy((void*)&aTrace,
-        (void*)&_myBuffer[myRetrievePos%TRACE_BUFFER_SIZE],
-        sizeof(aTrace));
+         (void*)&_myBuffer[myRetrievePos%TRACE_BUFFER_SIZE],
+         sizeof(aTrace));
 
   // increment the free buffer semaphore
   // (if previously 0, awake one of the threads waiting to put a trace, if any)
@@ -168,7 +272,7 @@ unsigned long LocalTraceBufferPool::toCollect()
 
 LocalTraceBufferPool::LocalTraceBufferPool()
 {
-  //cout << "LocalTraceBufferPool::LocalTraceBufferPool()" << endl;
+  //cerr << "LocalTraceBufferPool::LocalTraceBufferPool()" << endl;
 
   _insertPos   = ULONG_MAX;  // first increment will give 0
   _retrievePos = ULONG_MAX;
@@ -184,6 +288,8 @@ LocalTraceBufferPool::LocalTraceBufferPool()
   if (ret!=0) IMMEDIATE_ABORT(ret);
   ret=pthread_mutex_init(&_incrementMutex,NULL); // default = fast mutex
   if (ret!=0) IMMEDIATE_ABORT(ret);
+
+  //cerr << "LocalTraceBufferPool::LocalTraceBufferPool()-end" << endl;
 }
 
 // ============================================================================
@@ -194,10 +300,20 @@ LocalTraceBufferPool::LocalTraceBufferPool()
 
 LocalTraceBufferPool::~LocalTraceBufferPool()
 {
-  int ret;
-  ret=sem_destroy(&_freeBufferSemaphore);
-  ret=sem_destroy(&_fullBufferSemaphore);
-  ret=pthread_mutex_destroy(&_incrementMutex);
+  int ret = pthread_mutex_lock(&_singletonMutex); // acquire lock to be alone
+  if (_singleton)
+    {
+      DEVTRACE("LocalTraceBufferPool::~LocalTraceBufferPool()");
+      delete (_myThreadTrace);
+      _myThreadTrace = 0;
+      int ret;
+      ret=sem_destroy(&_freeBufferSemaphore);
+      ret=sem_destroy(&_fullBufferSemaphore);
+      ret=pthread_mutex_destroy(&_incrementMutex);
+      DEVTRACE("LocalTraceBufferPool::~LocalTraceBufferPool()-end");
+      _singleton = 0;
+    }
+  ret = pthread_mutex_unlock(&_singletonMutex); // release lock
 }
 
 // ============================================================================
@@ -210,8 +326,8 @@ unsigned long LocalTraceBufferPool::lockedIncrement(unsigned long& pos)
 {
   int ret;
   ret = pthread_mutex_lock(&_incrementMutex);   // lock access to counters
-  pos++;
+  unsigned long mypos = ++pos;
   ret = pthread_mutex_unlock(&_incrementMutex); // release lock
-  return pos;
+  return mypos;
 }