Class implementing object persistence. More...

#include <Persistence.h>

Inheritance diagram for lsst::daf::persistence::Persistence:

Public Types
typedef std::shared_ptr< Persistence >	Ptr

enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback) (const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback) (const Citizen *ptr)

Public Member Functions
virtual	~Persistence (void)
	Destructor. More...

virtual FormatterStorage::Ptr	getPersistStorage (std::string const &storageType, LogicalLocation const &location)
	Create a FormatterStorage subclass configured to persist to a location. More...

virtual FormatterStorage::Ptr	getRetrieveStorage (std::string const &storageType, LogicalLocation const &location)
	Create a FormatterStorage subclass configured to retrieve from a location. More...

virtual void	persist (lsst::daf::base::Persistable const &persistable, FormatterStorage::List const &storageList, lsst::daf::base::PropertySet::Ptr additionalData)
	Persist a Persistable instance. More...

virtual lsst::daf::base::Persistable::Ptr	retrieve (std::string const &persistableType, FormatterStorage::List const &storageList, lsst::daf::base::PropertySet::Ptr additionalData)
	Retrieve a Persistable instance. More...

virtual lsst::daf::base::Persistable *	unsafeRetrieve (std::string const &persistableType, FormatterStorage::List const &storageList, lsst::daf::base::PropertySet::Ptr additionalData)
	Retrieve a Persistable instance, returning an unsafe bare pointer. More...

lsst::pex::policy::Policy::Ptr	getPolicy () const
	Return the policy used to configure the Persistence object. More...

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static Ptr	getPersistence (lsst::pex::policy::Policy::Ptr policy)
	Create a Persistence object. More...

static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

Census
Provide a list of current Citizens
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector< const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

callbackIDs
Set callback Ids. The old Id is returned
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

Class implementing object persistence.

This class persists and retrieves objects by calling Formatter subclasses with a sequence of FormatterStorage subclasses that have been configured with LogicalLocations. This class handles all transaction semantics by starting per-FormatterStorage transactions, detecting failures, and causing the FormatterStorage subclasses to roll back if necessary.

Definition at line 68 of file Persistence.h.

Member Typedef Documentation

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ Ptr

typedef std::shared_ptr<Persistence> lsst::daf::persistence::Persistence::Ptr

Definition at line 70 of file Persistence.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

Constructor & Destructor Documentation

◆ ~Persistence()

lsst::daf::persistence::Persistence::~Persistence ( void )

virtual

Destructor.

Definition at line 66 of file Persistence.cc.

66 {

67 }

Member Function Documentation

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ getPersistence()

Persistence::Ptr lsst::daf::persistence::Persistence::getPersistence ( lsst::pex::policy::Policy::Ptr policy )

static

Create a Persistence object.

Parameters

[in] policy Policy to configure the Persistence object

Returns: Pointer to a Persistence instance

Definition at line 196 of file Persistence.cc.

                                    {
     return Persistence::Ptr(new Persistence(policy));
 }

◆ getPersistStorage()

FormatterStorage::Ptr lsst::daf::persistence::Persistence::getPersistStorage	(	std::string const &	storageType,
		LogicalLocation const &	location
	)

virtual

Create a FormatterStorage subclass configured to persist to a location.

Parameters

[in]	storageType	Name of FormatterStorage subclass as registered in StorageRegistry
[in]	location	Location to persist to (subclass-specific)

Definition at line 91 of file Persistence.cc.

                                                                              {
     return _getStorage(storageType, location, true);
 }

◆ getPolicy()

lsst::pex::policy::Policy::Ptr lsst::daf::persistence::Persistence::getPolicy ( ) const

Return the policy used to configure the Persistence object.

Returns: Pointer to Policy

Definition at line 205 of file Persistence.cc.

 {
     return _policy;
 }

◆ getRetrieveStorage()

FormatterStorage::Ptr lsst::daf::persistence::Persistence::getRetrieveStorage	(	std::string const &	storageType,
		LogicalLocation const &	location
	)

virtual

Create a FormatterStorage subclass configured to retrieve from a location.

Parameters

[in]	storageType	Name of FormatterStorage subclass as registered in StorageRegistry
[in]	location	Location to retrieve from (subclass-specific)

Definition at line 101 of file Persistence.cc.

                                                                               {
     return _getStorage(storageType, location, false);
 }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ persist()

void lsst::daf::persistence::Persistence::persist	(	lsst::daf::base::Persistable const &	persistable,
		FormatterStorage::List const &	storageList,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

virtual

Persist a Persistable instance.

Parameters

[in]	persistable	The Persistable instance
[in]	storageList	List of storages to persist to (in order)
[in]	additionalData	Additional information needed to determine the correct place to put data in any of the Storages

Definition at line 112 of file Persistence.cc.

                                               {
     // Get the policies for all Formatters, if present
     std::string policyName = "Formatter";
     lsst::pex::policy::Policy::Ptr policyPtr;
     if (_policy && _policy->exists(policyName)) {
         policyPtr = _policy->getPolicy(policyName);
     }
     // Find the appropriate Formatter.
     Formatter::Ptr f =
         Formatter::lookupFormatter(typeid(persistable), policyPtr);
     // Use the Formatter instance to write the Persistable to each FormatterStorage
     // in turn.  Commit the transactions (in order) when all writing is
     // complete.
     for (FormatterStorage::List::const_iterator it = storageList.begin();
          it != storageList.end(); ++it) {
         (*it)->startTransaction();
         f->write(&persistable, *it, additionalData);
     }
     for (FormatterStorage::List::const_iterator it = storageList.begin();
          it != storageList.end(); ++it) {
         (*it)->endTransaction();
     }
 }

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ retrieve()

lsst::daf::base::Persistable::Ptr lsst::daf::persistence::Persistence::retrieve	(	std::string const &	persistableType,
		FormatterStorage::List const &	storageList,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

virtual

Retrieve a Persistable instance.

Parameters

[in]	persistableType	Name of Persistable type to be retrieved as registered by its Formatter
[in]	storageList	List of storages to retrieve from (in order)
[in]	additionalData	Additional information needed to select the correct data from any of the FormatterStorages

Returns: Shared pointer to new Persistable instance

Definition at line 185 of file Persistence.cc.

                                               {
     return lsst::daf::base::Persistable::Ptr(
         unsafeRetrieve(persistableType, storageList, additionalData));
 }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ unsafeRetrieve()

lsst::daf::base::Persistable * lsst::daf::persistence::Persistence::unsafeRetrieve	(	std::string const &	persistableType,
		FormatterStorage::List const &	storageList,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

virtual

Retrieve a Persistable instance, returning an unsafe bare pointer.

Intended for use by SWIG/Python only.

Parameters

[in]	persistableType	Name of Persistable type to be retrieved as registered by its Formatter
[in]	storageList	List of storages to retrieve from (in order)
[in]	additionalData	Additional information needed to select the correct data from any of the Storages

Returns: Bare pointer to new Persistable instance

Definition at line 147 of file Persistence.cc.

                                               {
     // Get the policies for all Formatters, if present
     std::string policyName = "Formatter";
     lsst::pex::policy::Policy::Ptr policyPtr;
     if (_policy && _policy->exists(policyName)) {
         policyPtr = _policy->getPolicy(policyName);
     }
     // Find the appropriate Formatter.
     Formatter::Ptr f = Formatter::lookupFormatter(persistableType, policyPtr);
     // Use the Formatter instance to read from the first FormatterStorage; then update
     // from each additional FormatterStorage in turn.
     lsst::daf::base::Persistable* persistable = 0;
     for (FormatterStorage::List::const_iterator it = storageList.begin();
          it != storageList.end(); ++it) {
         (*it)->startTransaction();
         if (!persistable) {
             persistable = f->read(*it, additionalData);
         } else {
             f->update(persistable, *it, additionalData);
         }
     }
     for (FormatterStorage::List::const_iterator it = storageList.begin();
          it != storageList.end(); ++it) {
         (*it)->endTransaction();
     }
     return persistable;
 }

The documentation for this class was generated from the following files:

/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/include/lsst/daf/persistence/Persistence.h
/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/src/Persistence.cc

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ memCallback

◆ memId

◆ memNewCallback

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ~Persistence()

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ getId()

◆ getNextMemId()

◆ getPersistence()

◆ getPersistStorage()

◆ getPolicy()

◆ getRetrieveStorage()

◆ hasBeenCorrupted()

◆ init()

◆ markPersistent()

◆ persist()

◆ repr()

◆ retrieve()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ unsafeRetrieve()