Bdb packages | Design docs | Source docs | Guidelines | Recent releases
	Search | Site Map .

                 

---

/BdbObjyMgmt/BdbObjyMgr.hh

Go to the documentation of this file.

#if !defined(BDBOBJYMGR_HH)
#define BDBOBJYMGR_HH
//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: BdbObjyMgr.hh,v 1.5 2002/03/15 22:37:55 patton Exp $
//
// Description:
//      Class BdbObjyMgr:
//
// Environment:
//      Software developed for the BaBar Detector at the SLAC B-Factory.
//
// Author List:
//      Simon Patton
//
// Copyright Information:
//      Copyright (C) 1999      LBNL
//
//------------------------------------------------------------------------

//-------------
// C Headers --
//-------------
extern "C" {
#include <pthread.h>
}

//---------------
// C++ Headers --
//---------------

//-----------------
// BaBar Headers --
//-----------------
#include "BaBar/BaBar.hh"

#include "BdbUtil/Bdb.hh"

//-------------------------------
// Collaborating Class Headers --
//-------------------------------
#include "BdbObjyMgmt/BdbObjyDomainStack.hh"

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------
class BdbObjyTrans ;
class BdbObjyDomain ;
class BdbOptInhibitSystem ;
class BdbInhibitSystem ;
class BdbInhibitPolicy ;
class BdbFederationPrimer ;

extern "C"{
   void destroyBdbObjyMgrThreadData( void* aInstance );
}

//----------------------
// Base Class Headers --
//----------------------

//              ---------------------
//              -- Class Interface --
//              ---------------------

/**
  * The BdbObjyMgr class is ...
  */
class BdbObjyMgr
{
      // friend classes and functions
      friend class BdbSetDefaultBootName ;
      friend void destroyBdbObjyMgrThreadData( void* aInstance );

   public:

      // Typedefs, consts, and enums

      // Constructors and destructor

      /**
        * Constructs an instanace of this class.
        * Note: the instance takes over ownership of the BdbInhibitSystem
        */
      BdbObjyMgr( BdbInhibitSystem* inhibitSystem ) ;

      /**
        * Constructs an instanace of this class.
        * Note: the instance takes over ownership of the BdbInhibitSystem
        */
      BdbObjyMgr( BdbOptInhibitSystem* inhibitSystem ) ;

      /**
        * Destroys this instance.
        */
      virtual ~BdbObjyMgr() ;

      // Selectors (const)

      //
      // PThreads management
      //

      /**
       * @return true if the pthreads is being used for multithreading
       */
      d_Boolean isUsingPthreads() const ;

      //
      // Objectivity initialization
      //

      /**
       * @return the value to be used when initializing Objy
       */
      d_ULong fileDescriptors() const ;

      /**
       * @return the number of cache pages for main ooContext to
       *   initially use
       */
      d_ULong cacheInitPages() const ;

      /**
       * @return the maximum number of cache pages for main ooContext
       *  to use
       */
      d_ULong cacheMaxPages() const ;

      /**
       * @return the AMS usage for the job
       */
      BdbAMSUsage amsUsage() const ;

      /**
       * @return true if jobs is standalone
       */
      d_Boolean isStandalone() const ;

      /**
       *  @return true if single federation is going to be used
       */
      d_Boolean isSingleFed() const ;

      /**
       * @return true if Objectivity has been initialized
       */
      d_Boolean isInitialized() const ;

      /**
       * @return true if this thread has been initialized for Objectivity
       */
      d_Boolean threadIsInitialized() const ;

      /**
       * Cleanup objectivity for this thread before it is terminated
       */
      void finalizeThread() const ;

      //
      // Objectivity management
      //

      /**
       * @return the default boot file name. If none has been set the
       *   the value of OO_FD_BOOT is returned.
       */
      const char* defaultBootName() const ;

      /**
       * @return the default transaction for the default federation
       */
      BdbObjyTrans* defaultTransaction( const BdbObjyDomain* domain = 0 ) const ;

      /**
       * @returns the activationStack for the current thread
       */
      const BdbObjyDomainStack& activationStack() const ;

      /**
       * creates and returns and new BdbObjyTrans object
       */
      BdbObjyTrans* createTrans() const ;

      /**
       * creates and returns and new BdbObjyTrans object whose setting
       *   are based on those of the specified BdbObjyTrans
       */
      BdbObjyTrans* createTrans( const BdbObjyTrans& trans ) const ;

      /**
       * @return true if the vtable pointers are being checked
       */
      d_Boolean checkVTablePointer() const ;

      /**
       * @return true if a policy has been set for the inhibit system
       */
      d_Boolean hasInhibitPolicy() const ;

      // Modifiers

      //
      // Objectivity initialization
      //

      /**
       * Set up the number of file descriptors to be used by each
       *   ooContext instance
       */
      void setFileDescriptors( d_ULong nFiles ) ;

      /**
       * Set up the  number of cache pages for main ooContext to
       *   initially use
       */
      void setCacheInitPages( d_ULong nPages ) ;

      /**
       * Set up the maximum number of cache pages for main ooContext
       *   to use
       */
      void setCacheMaxPages( d_ULong nPages ) ;

      /**
       * Set the AMS usage for the job
       */
      void setAMSUsage( BdbAMSUsage amsUsage ) ;

      /**
       * Set the flag indicating whether the jobs is standalone
       */
      void setStandalone() ;

      /**
       * Set the flag indication when the job is running in single or
       *   multiple federation mode.
       */
      void setSingleFed() ;

      /**
       * Set the instance of BdbNoOpenTrans which will be used just
       *   when the default federation is accessed for the first time.
       * @return the old primer
       */
      BdbFederationPrimer* setDefaultPrimer( BdbFederationPrimer* primer ) ;

      //
      // Objectivity management
      //

      /**
       * Set the default boot file name. If set to '0' the the
       *   value of OO_FD_BOOT will be used.
       */
      void setDefaultBootName( const char* bootname ) ;

      /**
       * @returns the activationStack for the current thread
       */
      BdbObjyDomainStack& activationStack() ;

      /**
       * Set the flag indication whether to check the VTable pointer
       */
      void setCheckVTablePointer( d_Boolean checkVptr ) ;

      /**
       * Set the inhibit systems policy.
       */
      void setInhibitPolicy( const BdbInhibitPolicy* policy ) ;

      // Static Member Functions

   protected:

      // Selectors (const)

      // Modifiers

   private:

      // Constructors
      /** stops default */
      BdbObjyMgr() ;

      /** stops default */
      BdbObjyMgr( const BdbObjyMgr& aRhs ) ;

      // Operators
      /** stops default */
      const BdbObjyMgr& operator=( const BdbObjyMgr& aRhs ) ;

      // Selectors (const)

      /**
       * Initialize Objectivity if not already initialized
       */
      void initialize() const ;

      /**
       * Initialize this thread for Objectivity if not already initialized
       */
      void initializeThread() const ;

      /**
       * Lock mutex associated with this instance, exits if fails
       */
      void mutex_lock() const;

      /**
       * Unlock mutex associated with this instance, exits if fails
       */
      void mutex_unlock() const;

      // Modifiers

      /**
       * initialize the class
       */
      void initClass() ;

      /**
       * sets the default transaction and executes the federation primer
       */
      void setDefaultTransaction( BdbObjyTrans* aTrans ) ;

      /**
       * Set parameters to values detect in environment variables
       */
      void setParametersFromEnv() ;

      // Static Member Functions

      // Data Members

      struct ThreadData {
            /** LIFO stack of domain activations */
            BdbObjyDomainStack _activationStack ;
            /** pointer to transaction to access default federation instance */
            BdbObjyTrans* _defaultTransaction ;
            /** the default bootfile name to use if none is specified */
            char* _defaultBootName ;
            /** number of file descriptors used to initialize Objy */
            d_ULong _fileDescriptors ;
            /** number of cache pages for main ooContext to initially use */
            d_ULong _cacheInitPages ;
            /** maximum number of cache pages for main ooContext to use */
            d_ULong _cacheMaxPages ;
            /** true if this thread has been initialized */
            d_Boolean _isInitialized ;

            /** ctor */
            ThreadData();
            /** dtor */
            ~ThreadData();
      };

      /** AMS usage for the job */
      BdbAMSUsage _amsUsage ;
      /** @return true if jobs is standalone */
      d_Boolean _isStandalone ;
      /** true if single federation is going to be used */
      d_Boolean _isSingleFed ;
      /** true of ooInit has been called */
      d_Boolean _isInitialized ;
      /** true if the vtable pointers are being checked */
      d_Boolean _checkVTablePointer ;

      /** pointer to the function used to prime a default federation */
      BdbFederationPrimer* _defaultPrimer ;
      /** Inhibit System implementation to use of all transactions */
      BdbInhibitSystem* _inhibitSystem ;
      /** Inhibit System implementation to use of all transactions */
      BdbOptInhibitSystem* _optInhibitSystem ;

      /** mutex to be used for this class */
      pthread_mutex_t _mutex;
      /** the key to be used to access data when threads are in use */
      pthread_key_t _threadDataKey;

      /** data for this instance when threads are not in use */
      ThreadData* _threadData;

      /**
       * @return the data for this instance in the current thread
       */
      const ThreadData& threadData() const;

      /**
       * @return the data for this instance in the current thread
       */
      ThreadData& threadData();

      // Static Data Members

      /** true if the previous main transaction should be reused if possible */
      static bool _usingPthreads;
} ;

// inline function definitions

#endif // BDBOBJYMGR_HH

 

---

BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us

Page Owner: Jacek Becla
Last Update: October 04, 2002