Inventor/threads/SbThreadLocalStorage.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Oct 2008)
**=======================================================================*/


#ifndef _SB_THREAD_LOCAL_STORAGE_H_
#define _SB_THREAD_LOCAL_STORAGE_H_

#include <Inventor/SbBase.h>
#include <Inventor/STL/vector>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/errors/SoDebugError.h>

#if defined(_WIN32)
#pragma warning( push )
#pragma warning(disable:4251)
#endif //_WIN32

typedef void SoInitTLSClassCB();
typedef void SoExitTLSClassCB();

#define SB_THREAD_INIT_CLASS(_className_,_structName_) \
  if  ( _className_::MT_Id == -1 ) \
    _className_::MT_Id = SbThreadLocalStorage::createStorage(sizeof(struct _className_::_structName_), _className_::initTLSClass, _className_::exitTLSClass, __FUNCTION__ ); \
  else \
    SoDebugError::post(__FUNCTION__,"SB_THREAD_INIT_CLASS called multiple time for class " SO__QUOTE(_className_));

#define SB_THREAD_EXIT_CLASS(_className_) \
  SbThreadLocalStorage::deleteStorage( _className_::MT_Id ); \
  _className_::MT_Id = -1;

#define GET_THREAD_LOCAL_VAR(_className_, _structName_, _varName_) \
  \
  ((static_cast<struct _className_::_structName_ *> (SbThreadLocalStorage::getStorage(_className_::MT_Id)))->_varName_)

#define GET_THREAD_LOCAL_STORAGE(_className_) \
  \
  (static_cast<void *> (SbThreadLocalStorage::getStorage(_className_::MT_Id)))

#define SB_THREAD_TLS_HEADER() \
private: \
 \
  static size_t MT_Id; \
 \
  static void initTLSClass(); \
 \
  static void exitTLSClass()


#define SB_THREAD_TLS_SOURCE( _className_ ) \
\
 \
  size_t _className_::MT_Id = -1

#ifndef SoNodeTLS
#define SoNodeTLS SbThreadLocalStorage
#endif

class  SbThreadLocalStorage
{
 public:
  static size_t createStorage(const size_t byteSize, SoInitTLSClassCB* initFunc=NULL, SoExitTLSClassCB* exitFunc=NULL, const char* funcName=NULL);

  static void deleteStorage( size_t id );

  static void *getStorage(const size_t classThreadId);

private:
  static void initThreadLocalStorage();

  static void closeThreadLocalStorage();

  static void exitThreadLocalStorage();

private:
  static void initClass();

  static void exitClass();

  template<typename StructName, typename ClassName>
  static StructName*
  getStruct()
  {
    return static_cast<StructName*>(SbThreadLocalStorage::getStorage(ClassName::MT_Id));
  }

  template<typename StructName, typename ClassName>
  static StructName*
  getStruct(const ClassName*)
  {
    return getStruct<StructName, ClassName>();
  }

  static bool isInitialized()
  { return (getThreadStorage()!=NULL); }

private:
  static void checkInitTLS();

  // Storage info class to handle TLS info for each storage
  class StorageInfo
  {
  public:
    // size of the storage
    size_t size;

    // init storage function callback
    SoInitTLSClassCB* initFunc;

    // exit storage function callback
    SoExitTLSClassCB* exitFunc;

    // default constructor
    StorageInfo() : size(0),initFunc(NULL),exitFunc(NULL) {}
  };

  // global spinlock to protect access to s_storageInfoList
  static SbThreadSpinlock s_storageInfoListLock;

  // global ordered list of StorageInfo
  typedef std::vector<StorageInfo*> SoStorageInfoList;
  static SoStorageInfoList s_storageInfoList;

  // list of thread pointer data
  typedef std::vector<void*> SoStorageList;
  // list used in non-MT mode
  static SoStorageList* s_threadStorageList;
  // return the storageList (from TLS or static vars depending on MT mode)
  static SoStorageList* getThreadStorage();
};


#if defined(_WIN32)
#pragma warning(pop)
#endif //_WIN32


#endif //_SB_THREAD_LOCAL_STORAGE_H_

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/