Salome HOME
[EDF30062] : Forward of current directory mecanism
[modules/kernel.git] / src / SALOMELocalTrace / LocalTraceBufferPool.cxx
index f41e57593b0c60599283b6b11c3468b1f44a820e..afba1c4b9c80621404c99af7cedc3ad9b8c70de4 100644 (file)
@@ -1,34 +1,37 @@
-//  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 
-// 
+// Copyright (C) 2007-2024  CEA, EDF, 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, or (at your option) any later version.
+//
+// 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 WNT
+#ifndef WIN32
 #include <dlfcn.h>
 #else
 #include <windows.h>
 #include "BaseTraceCollector.hxx"
 #include "LocalTraceCollector.hxx"
 #include "FileTraceCollector.hxx"
-#include "BasicsGenericDestructor.hxx"
 #include "utilities.h"
 
-using namespace std;
-
 // In case of truncated message, end of trace contains "...\n\0"
 
 #define TRUNCATED_MESSAGE "...\n"
@@ -52,7 +52,7 @@ using namespace std;
 // Class static attributes initialisation
 
 LocalTraceBufferPool* LocalTraceBufferPool::_singleton = 0;
-//#ifndef WNT
+//#ifndef WIN32
 //pthread_mutex_t LocalTraceBufferPool::_singletonMutex;
 //#else
 pthread_mutex_t LocalTraceBufferPool::_singletonMutex =
@@ -80,77 +80,79 @@ LocalTraceBufferPool* LocalTraceBufferPool::instance()
 {
   if (_singleton == 0) // no need of lock when singleton already exists
     {
-      int ret;
-      ret = pthread_mutex_lock(&_singletonMutex); // acquire lock to be alone
+      pthread_mutex_lock(&_singletonMutex);    // acquire lock to be alone
       if (_singleton == 0)                     // another thread may have got
-       {                                      // the lock after the first test
-         DEVTRACE("New buffer pool");
-         LocalTraceBufferPool* myInstance = new LocalTraceBufferPool(); 
-
-         DESTRUCTOR_OF<LocalTraceBufferPool> *ptrDestroy =
-           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)
-           {
-             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 WNT
-             void* handle;
-             string impl_name = string ("lib") + traceKind 
-               + string("TraceCollector.so");
-             handle = dlopen( impl_name.c_str() , RTLD_LAZY ) ;
+        {                                      // 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 
+#ifdef __APPLE__
+                + std::string("TraceCollector.dylib");
 #else
-             HINSTANCE handle;
-             string impl_name = string ("lib") + traceKind + string(".dll");
-             handle = LoadLibrary( impl_name.c_str() );
+                + std::string("TraceCollector.so");
 #endif
-             if ( handle )
-               {
-                 typedef BaseTraceCollector * (*FACTORY_FUNCTION) (void);
-#ifndef WNT
-                 FACTORY_FUNCTION TraceCollectorFactory =
-                   (FACTORY_FUNCTION) dlsym(handle, "SingletonInstance");
+              handle = dlopen( impl_name.c_str() , RTLD_LAZY | RTLD_GLOBAL ) ;
 #else
-                 FACTORY_FUNCTION TraceCollectorFactory =
-                   (FACTORY_FUNCTION)GetProcAddress(handle, "SingletonInstance");
+              HINSTANCE handle;
+              std::string impl_name = std::string ("lib") + traceKind + std::string(".dll");                                
+              handle = LoadLibraryA( impl_name.c_str() );
 #endif
-                 if ( !TraceCollectorFactory )
-                 {
-                     cerr << "Can't resolve symbol: SingletonInstance" <<endl;
-#ifndef WNT
-                     cerr << "dlerror: " << dlerror() << endl;
+              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
-               {
-                 cerr << "library: " << impl_name << " not found !" << 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
+                      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");
+        }
+      pthread_mutex_unlock(&_singletonMutex); // release lock
     }
   return _singleton;
 }
@@ -174,13 +176,16 @@ int LocalTraceBufferPool::insert(int traceType, const char* msg)
 
   // wait until there is a free buffer in the pool
 
+#ifdef __APPLE__
+  dispatch_semaphore_wait(_freeBufferSemaphore, DISPATCH_TIME_FOREVER);
+#else
   int ret = -1;
   while (ret)
     {
       ret = sem_wait(&_freeBufferSemaphore);
       if (ret) perror(" LocalTraceBufferPool::insert, sem_wait");
     }
-
+#endif
   // get the next free buffer available (mutex protected) 
 
   unsigned long myInsertPos = lockedIncrement(_insertPos);
@@ -188,8 +193,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;
@@ -198,12 +203,20 @@ int LocalTraceBufferPool::insert(int traceType, const char* msg)
   // increment the full buffer semaphore
   // (if previously 0, awake thread in charge of trace)
 
+#ifdef __APPLE__
+  dispatch_semaphore_signal(_fullBufferSemaphore);
+#else
   ret = sem_post(&_fullBufferSemaphore);
+#endif
 
-  // returns the number of free buffers
 
+  // returns the number of free buffers
+#ifdef __APPLE__
+  return 0;
+#else
   sem_getvalue(&_freeBufferSemaphore, &ret);
   return ret;  
+#endif
 }
 
 // ============================================================================
@@ -219,13 +232,16 @@ int LocalTraceBufferPool::retrieve(LocalTrace_TraceInfo& aTrace)
 
   // wait until there is a buffer in the pool, with a message to print
 
+#ifdef __APPLE__
+    dispatch_semaphore_wait(_fullBufferSemaphore, DISPATCH_TIME_FOREVER);
+#else
   int ret = -1;
   while (ret)
     {
       ret = sem_wait(&_fullBufferSemaphore);
-      if (ret) perror(" LocalTraceBufferPool::retrieve, sem_wait");
+      if (ret) MESSAGE (" LocalTraceBufferPool::retrieve, sem_wait");
     }
-
+#endif
   // get the next buffer to print
 
   unsigned long myRetrievePos = lockedIncrement(_retrievePos);
@@ -233,8 +249,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)
@@ -242,12 +258,20 @@ int LocalTraceBufferPool::retrieve(LocalTrace_TraceInfo& aTrace)
   // threads are waiting to put a trace: the waken up thread is not
   // necessarily the first thread to wait.
 
+#ifdef __APPLE__
+  dispatch_semaphore_signal(_freeBufferSemaphore);
+#else
   ret = sem_post(&_freeBufferSemaphore);
+#endif
 
   // returns the number of full buffers
 
+#ifdef __APPLE__
+  return 0;
+#else
   sem_getvalue(&_fullBufferSemaphore, &ret);
   return ret;
+#endif
 }
 
 // ============================================================================
@@ -283,10 +307,16 @@ LocalTraceBufferPool::LocalTraceBufferPool()
   for (int i=0; i<TRACE_BUFFER_SIZE; i++)
     strcpy(&(_myBuffer[i].trace[MAXMESS_LENGTH]),TRUNCATED_MESSAGE);
   int ret;
+#ifdef __APPLE__
+  dispatch_semaphore_t* sem1 = &_freeBufferSemaphore, *sem2 = &_fullBufferSemaphore;
+  *sem1 = dispatch_semaphore_create(TRACE_BUFFER_SIZE);
+  *sem2 = dispatch_semaphore_create(0);
+#else
   ret=sem_init(&_freeBufferSemaphore, 0, TRACE_BUFFER_SIZE); // all buffer free
   if (ret!=0) IMMEDIATE_ABORT(ret);
   ret=sem_init(&_fullBufferSemaphore, 0, 0);                 // 0 buffer full
   if (ret!=0) IMMEDIATE_ABORT(ret);
+#endif
   ret=pthread_mutex_init(&_incrementMutex,NULL); // default = fast mutex
   if (ret!=0) IMMEDIATE_ABORT(ret);
 
@@ -301,20 +331,24 @@ LocalTraceBufferPool::LocalTraceBufferPool()
 
 LocalTraceBufferPool::~LocalTraceBufferPool()
 {
-  int ret = pthread_mutex_lock(&_singletonMutex); // acquire lock to be alone
+  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);
+#ifdef __APPLE__
+      dispatch_release(_freeBufferSemaphore);
+      dispatch_release(_fullBufferSemaphore);
+#else
+      sem_destroy(&_freeBufferSemaphore);
+      sem_destroy(&_fullBufferSemaphore);
+#endif
+      pthread_mutex_destroy(&_incrementMutex);
       DEVTRACE("LocalTraceBufferPool::~LocalTraceBufferPool()-end");
       _singleton = 0;
     }
-  ret = pthread_mutex_unlock(&_singletonMutex); // release lock
+  pthread_mutex_unlock(&_singletonMutex); // release lock
 }
 
 // ============================================================================
@@ -325,10 +359,8 @@ LocalTraceBufferPool::~LocalTraceBufferPool()
 
 unsigned long LocalTraceBufferPool::lockedIncrement(unsigned long& pos)
 {
-  int ret;
-  ret = pthread_mutex_lock(&_incrementMutex);   // lock access to counters
+  pthread_mutex_lock(&_incrementMutex);   // lock access to counters
   unsigned long mypos = ++pos;
-  ret = pthread_mutex_unlock(&_incrementMutex); // release lock
+  pthread_mutex_unlock(&_incrementMutex); // release lock
   return mypos;
 }
-