Class for XML file storage. More...

#include <XmlStorage.h>

Inheritance diagram for lsst::daf::persistence::XmlStorage:

Public Types
typedef std::shared_ptr< XmlStorage >	Ptr

typedef std::vector< Ptr >	List

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
	XmlStorage (void)
	Constructor. More...

virtual	~XmlStorage (void)
	Destructor. More...

virtual void	setPolicy (lsst::pex::policy::Policy::Ptr policy)
	Allow a Policy to be used to configure the FormatterStorage. More...

virtual void	setPersistLocation (LogicalLocation const &location)
	Set the destination to persist to. More...

virtual void	setRetrieveLocation (LogicalLocation const &location)
	Set the source to retrieve from. More...

virtual void	startTransaction (void)
	Start a transaction. More...

virtual void	endTransaction (void)
	End a transaction. More...

virtual boost::archive::xml_oarchive &	getOArchive (void)
	Get a `boost::serialization` XML archive suitable for output. More...

virtual boost::archive::xml_iarchive &	getIArchive (void)
	Get a `boost::serialization` XML archive suitable for input. 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	createInstance (std::string const &name, LogicalLocation const &location, bool persist, lsst::pex::policy::Policy::Ptr policy)
	Create and configure a FormatterStorage subclass instance. 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...

Protected Member Functions
void	verifyPathName (std::string const &pathName)
	Ensure that all directories along a path exist, creating them if necessary. More...

Detailed Description

Class for XML file storage.

Provides Boost XML archives for Formatter subclasses to use.

Definition at line 58 of file XmlStorage.h.

Member Typedef Documentation

◆ List

typedef std::vector<Ptr> lsst::daf::persistence::FormatterStorage::List

inherited

Definition at line 63 of file FormatterStorage.h.

◆ 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<XmlStorage> lsst::daf::persistence::XmlStorage::Ptr

Definition at line 60 of file XmlStorage.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

◆ XmlStorage()

lsst::daf::persistence::XmlStorage::XmlStorage ( void )

Constructor.

Definition at line 54 of file XmlStorage.cc.

                            : FormatterStorage(typeid(*this)),
     _ostream{}, _istream{}, _oarchive{}, _iarchive{} {
 }

◆ ~XmlStorage()

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

virtual

Destructor.

Clean up streams.

Definition at line 62 of file XmlStorage.cc.

62 {

63 }

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;
 }

◆ createInstance()

FormatterStorage::Ptr lsst::daf::persistence::FormatterStorage::createInstance	(	std::string const &	name,
		LogicalLocation const &	location,
		bool	persist,
		lsst::pex::policy::Policy::Ptr	policy
	)

staticinherited

Create and configure a FormatterStorage subclass instance.

Parameters

[in]	name	Name of subclass
[in]	location	Location to persist to or retrieve from
[in]	persist	True if persisting, false if retrieving
[in]	policy	Policy used to configure the FormatterStorage

Returns: Shared pointer to FormatterStorage subclass instance

Definition at line 75 of file FormatterStorage.cc.

                                    {
     FormatterStorage::Ptr storage = StorageRegistry::getRegistry().createInstance(name);
     storage->setPolicy(policy);
     if (persist) {
         storage->setPersistLocation(location);
     }
     else {
         storage->setRetrieveLocation(location);
     }
     return storage;
 }

◆ endTransaction()

void lsst::daf::persistence::XmlStorage::endTransaction ( void )

virtual

End a transaction.

No transaction support for now, but close streams.

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 97 of file XmlStorage.cc.

                                     {
     _oarchive.reset();
     _ostream.reset();
     _iarchive.reset();
     _istream.reset();
 }

◆ getIArchive()

boost::archive::xml_iarchive & lsst::daf::persistence::XmlStorage::getIArchive ( void )

virtual

Get a boost::serialization XML archive suitable for input.

Returns: Reference to an XML input archive

Definition at line 114 of file XmlStorage.cc.

                                                       {
     return *_iarchive;
 }

◆ 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(); }

◆ getOArchive()

boost::archive::xml_oarchive & lsst::daf::persistence::XmlStorage::getOArchive ( void )

virtual

Get a boost::serialization XML archive suitable for output.

Returns: Reference to an XML output archive

Definition at line 107 of file XmlStorage.cc.

                                                       {
     return *_oarchive;
 }

◆ 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);
 }

◆ 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));
 }

◆ 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;
 }

◆ setPersistLocation()

void lsst::daf::persistence::XmlStorage::setPersistLocation ( LogicalLocation const & location )

virtual

Set the destination to persist to.

Parameters

[in] location Pathname to Boost XML file

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 74 of file XmlStorage.cc.

                                                                    {
     verifyPathName(location.locString());
     _ostream.reset(new std::ofstream(location.locString().c_str()));
     _oarchive.reset(new boost::archive::xml_oarchive(*_ostream));
 }

◆ setPolicy()

void lsst::daf::persistence::XmlStorage::setPolicy ( lsst::pex::policy::Policy::Ptr policy )

virtual

Allow a Policy to be used to configure the FormatterStorage.

Parameters

[in] policy

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 68 of file XmlStorage.cc.

68 {

69 }

◆ setRetrieveLocation()

void lsst::daf::persistence::XmlStorage::setRetrieveLocation ( LogicalLocation const & location )

virtual

Set the source to retrieve from.

Parameters

[in] location Pathname to Boost XML file

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 83 of file XmlStorage.cc.

                                                                     {
     _istream.reset(new std::ifstream(location.locString().c_str()));
     _iarchive.reset(new boost::archive::xml_iarchive(*_istream));
 }

◆ startTransaction()

void lsst::daf::persistence::XmlStorage::startTransaction ( void )

virtual

Start a transaction.

No transaction support for now.

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 91 of file XmlStorage.cc.

91 {

92 }

◆ verifyPathName()

void lsst::daf::persistence::FormatterStorage::verifyPathName ( std::string const & name )

protectedinherited

Ensure that all directories along a path exist, creating them if necessary.

Parameters

[in] name Pathname to file to be created

Definition at line 93 of file FormatterStorage.cc.

                                                            {
     // Get the directory by stripping off anything after the last slash.
     std::string::size_type pos = name.find_last_of('/');
     if (pos == std::string::npos) return;
     std::string dirName = name.substr(0, pos);
 
     // Check to see if the directory exists.
     struct stat buf;
     int ret = ::stat(dirName.c_str(), &buf);
 
     if (ret == -1 && errno == ENOENT) {
         // It doesn't; check its parent and then create it.
         verifyPathName(dirName);
 
         ret = ::mkdir(dirName.c_str(), 0777);
 
         // If it already exists, we're OK; otherwise, throw an exception.
         if (ret == -1 && errno != EEXIST) {
             throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                 dirName + ": Error creating directory = " + std::strerror(errno));
         }
     }
     else if (ret == -1) {
         // We couldn't read the (existing) directory for some reason.
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
             dirName + ": Error searching for directory = " + std::strerror(errno));
     }
     else if (!S_ISDIR(buf.st_mode)) {
         // It's not a directory.
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
             dirName + ": Non-directory in path");
     }
 }

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/XmlStorage.h
/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/src/XmlStorage.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ List

◆ memCallback

◆ memId

◆ memNewCallback

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ XmlStorage()

◆ ~XmlStorage()

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ createInstance()

◆ endTransaction()

◆ getIArchive()

◆ getId()

◆ getNextMemId()

◆ getOArchive()

◆ hasBeenCorrupted()

◆ init()

◆ markPersistent()

◆ repr()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ setPersistLocation()

◆ setPolicy()

◆ setRetrieveLocation()

◆ startTransaction()

◆ verifyPathName()