Very simple pass-through implementation of IProxyDict. More...

#include <DebugView.h>

Inheritance diagram for DebugView:

Collaboration diagram for DebugView:

Public Member Functions
	DebugView ()=delete

	DebugView (std::string const &Name, bool AllowFallThrough=true, std::string const &storeName="StoreGateSvc")

virtual	~DebugView ()

virtual void	linkParent (const IProxyDict *parent)

virtual SG::DataProxy *	proxy (const CLID &id, const std::string &key) const

virtual SG::DataProxy *	findProxy (const CLID &id, const std::string &key, const bool allowFallThrough) const

virtual SG::DataProxy *	proxy (const void *const pTransient) const
	Get a proxy referencing a given transient object. More...

virtual SG::DataProxy *	recordObject (SG::DataObjectSharedPtr< DataObject > obj, const std::string &key, bool allowMods, bool returnExisting)

std::string	viewKey (const std::string &key) const
	Construct a key as used in the parent store. More...

virtual const std::set< const SG::View * > &	getParentLinks () const
	returns the links to the previously used views More...

void	setFilter (std::vector< std::string > const &inputFilter)
	Set a filtering rule for anything loaded via fallthrough. More...

virtual SG::DataProxy *	deep_proxy (const void *const pTransient) const
	get proxy for a given data object address in memory, but performs a deep search among all possible 'symlinked' containers TEMPORARY: This method is going away. More...

virtual SG::DataProxy *	proxy_exact (SG::sgkey_t sgkey) const
	Get proxy given a hashed key+clid. More...

virtual std::vector< const SG::DataProxy * >	proxies () const
	Return the list of all current proxies in store. More...

virtual StatusCode	addToStore (CLID id, SG::DataProxy *proxy)
	Add a new proxy to the store. More...

virtual void	boundHandle (IResetable *handle)
	Tell the store that a handle has been bound to a proxy. More...

virtual void	unboundHandle (IResetable *handle)
	Tell the store that a handle has been unbound from a proxy. More...

virtual bool	tryELRemap (sgkey_t sgkey_in, size_t index_in, sgkey_t &sgkey_out, size_t &index_out)
	Test to see if the target of an ElementLink has moved. More...

virtual const std::string &	name () const

virtual IStringPool::sgkey_t	stringToKey (const std::string &str, CLID clid)

virtual const std::string *	keyToString (IStringPool::sgkey_t key) const

virtual const std::string *	keyToString (IStringPool::sgkey_t key, CLID &clid) const

virtual void	registerKey (IStringPool::sgkey_t key, const std::string &str, CLID clid)

std::string	dump (const std::string &indent="") const

void	setROI (const ElementLink< TrigRoiDescriptorCollection > &roi)

const ElementLink< TrigRoiDescriptorCollection > &	getROI () const

Protected Attributes
tbb::concurrent_unordered_set< std::string > m_fallList	ATLAS_THREAD_SAFE

ServiceHandle< StoreGateSvc >	m_store

ElementLink< TrigRoiDescriptorCollection >	m_roi

std::string	m_name

std::set< const SG::View * >	m_parents

std::vector< std::string >	m_fallFilter

bool	m_allowFallThrough

Private Member Functions
bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

Detailed Description

Very simple pass-through implementation of IProxyDict.

Most of the methods are copypasta and don't do anything Adds extra debugging information to SimpleView

Author: Ben Wynne - ATLAS

Definition at line 28 of file DebugView.h.

Constructor & Destructor Documentation

◆ DebugView() [1/2]

DebugView::DebugView ( )

delete

◆ DebugView() [2/2]

DebugView::DebugView	(	std::string const &	Name,
		bool	AllowFallThrough = `true`,
		std::string const &	storeName = `"StoreGateSvc"`
	)

Definition at line 9 of file DebugView.cxx.

                                                                                                :
   SimpleView( Name, AllowFallThrough, storeName ),
   AthMessaging( Name )
 {
 }

◆ ~DebugView()

DebugView::~DebugView ( )

virtual

Definition at line 15 of file DebugView.cxx.

 {
   // Debugging info
   try {
     ATH_MSG_INFO( "Loaded via fallthrough from view " << m_name << ": " );
     for ( auto const& key : m_fallList ) ATH_MSG_INFO( key );
  
     ATH_MSG_INFO( "View " << m_name << " has " << m_parents.size() << " parents" );
   }
   catch (const GaudiException&) {
     // ATH_MSG_* can throw --- don't let the exception escape the destructor.
     std::abort();
   }
 }

Member Function Documentation

◆ addToStore()

StatusCode SimpleView::addToStore	(	CLID	id,
		SG::DataProxy *	proxy
	)

virtualinherited

Add a new proxy to the store.

Parameters

id	CLID as which the proxy should be added.
proxy	The proxy to add.

Simple addition of a proxy to the store. The key is taken as the primary key of the proxy. Does not handle things like overwrite, history, symlinks, etc. Should return failure if there is already an entry for this clid/key.

Definition at line 146 of file SimpleView.cxx.

 {
   return m_store->addToStore( id, proxy );
 }

◆ boundHandle()

void SimpleView::boundHandle ( IResetable * handle )

virtualinherited

Tell the store that a handle has been bound to a proxy.

Parameters

handle The handle that was bound. The default implementation does nothing.

Definition at line 188 of file SimpleView.cxx.

 {
   return m_store->boundHandle( handle );
 }

◆ deep_proxy()

virtual SG::DataProxy* SimpleView::deep_proxy ( const void *const pTransient ) const

inlinevirtualinherited

get proxy for a given data object address in memory, but performs a deep search among all possible 'symlinked' containers TEMPORARY: This method is going away.

Definition at line 71 of file SimpleView.h.

72 { return proxy (pTransient); }

◆ dump()

std::string SimpleView::dump ( const std::string & indent = "" ) const

inherited

Definition at line 234 of file SimpleView.cxx.

                                                           {
  
   // Dump view contents
   std::string ret = indent + "Dump " + name() + "\n";
   ret += indent + "[";
   for ( const SG::DataProxy* dp: proxies() ) {
     if ( dp->name().find( name() ) == 0 ) 
       ret += " " + dp->name();
   }
   ret += " ]\n";
  
   // Dump parent views
   if ( m_parents.size() ) ret += indent + "Parents:\n";
   for ( auto p : m_parents ) {
     ret += p->dump( indent + "  " );
   }
  
   // Fallthrough
   if ( indent == "" ) {
     if ( m_allowFallThrough ) {
       ret += indent + "May access main store: " + m_store->name();
     } else {
       ret += indent + "May not access main store";
     }
   }
   return ret;
 }

◆ findProxy()

SG::DataProxy * DebugView::findProxy	(	const CLID &	id,
		const std::string &	key,
		const bool	allowFallThrough
	)		const

virtual

Reimplemented from SimpleView.

Definition at line 56 of file DebugView.cxx.

 {
   auto isValid = [](const SG::DataProxy* p) { return p != nullptr and p->isValid(); };
   auto localProxy = m_store->proxy( id, viewKey(key) );
   if ( isValid( localProxy ) ) {
     return localProxy;
   }
  
   // Locate any parent views containing the data
   SG::DataProxy* parentProxy = nullptr;
   std::vector< const SG::View* > validParents;
   for ( auto& parent: m_parents ) {
  
     // Don't allow parents to access whole-event store independently of this view
     auto inParentProxy = parent->impl()->findProxy( id, key, false );
  
     // Record parents that contain the data
     if ( isValid( inParentProxy ) ) {
  
       // Warn if two different data objects conflict
       if ( parentProxy && ( parentProxy->object() != inParentProxy->object() ) ) {
         ATH_MSG_WARNING( "Parent view " << parent->name() << " contains conflicting data (" << inParentProxy->object() << ") vs " << parentProxy->object() << " found first" );
       }
  
       // Retrive the first data found
       if ( !parentProxy ) parentProxy = inParentProxy;
  
       // Make list of all parents returning data
       validParents.push_back( parent );
     }
   }
  
   // Return results from parent view search
   if ( parentProxy ) {
  
     // Warn if multiple parents returned result
     if ( validParents.size() > 1 ) {
  
       std::string validNames = "";
       for ( auto& parent : validParents ) validNames += parent->name() + " ";
  
       ATH_MSG_WARNING( "Key " << key << " in multiple parents (" << validParents.size() << "): " << validNames );
     }
     return parentProxy;
   }
   
   // Look in the default store if cound not find in any view - for instance for event-wise IDCs
   if ( (not isValid( localProxy )) and allowFallThrough ) {
  
     // Apply filtering
     if ( m_fallFilter.size() ) {
       bool filterPass = false;
  
       // Filter passes if the key contains one of the possible values
       for ( auto& entry : m_fallFilter ) {
         if ( key.find( entry ) != std::string::npos ) {
           filterPass = true;
           break;
         }
       }
  
       if ( !filterPass ) {
         ATH_MSG_INFO( "Key " << key << " not found in filter for view " << m_name << ":  returning 0" );
         return nullptr;
       }
     }
  
     auto mainStoreProxy = m_store->proxy( id, key );
     if ( mainStoreProxy ) {
       ATH_MSG_INFO( "Key " << key << " fell through to main store from view " << m_name << ":  returning " << mainStoreProxy );
       m_fallList.insert( key );
     }
     return mainStoreProxy;
   }
   return nullptr;
 }

◆ getParentLinks()

virtual const std::set< const SG::View* >& SimpleView::getParentLinks ( ) const

inlinevirtualinherited

returns the links to the previously used views

Definition at line 57 of file SimpleView.h.

58 { return m_parents; }

◆ getROI()

const ElementLink< TrigRoiDescriptorCollection > & SimpleView::getROI ( ) const

inherited

Definition at line 230 of file SimpleView.cxx.

                                                                          {
   return m_roi;
 }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ keyToString() [1/2]

const std::string * SimpleView::keyToString ( IStringPool::sgkey_t key ) const

virtualinherited

Definition at line 213 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::keyToString" );
 }

◆ keyToString() [2/2]

const std::string * SimpleView::keyToString	(	IStringPool::sgkey_t	key,
		CLID &	clid
	)		const

virtualinherited

Definition at line 217 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::keyToString" );
 }

◆ linkParent()

void DebugView::linkParent ( const IProxyDict * parent )

virtual

See also: SimpleView::linkParent

Reimplemented from SimpleView.

Definition at line 30 of file DebugView.cxx.

                                                      {
  
   // Check the parent is a view
   auto castParent = dynamic_cast< const SG::View* >( parent );
   if ( castParent ) {
  
     // Check for uniqueness
     auto result = m_parents.insert( castParent );
     if ( std::get<1>( result ) ) {
       ATH_MSG_INFO( "Adding parent view " << parent->name() << " to view " << name() << " with " << m_parents.size() - 1 << " existing parents" );
     }
     else {
       ATH_MSG_WARNING( "Attempted to add duplicate parent " << parent->name() << " to view " << name() );
     }
   }
   else {
     ATH_MSG_ERROR( "Unable to link parent view that cannot be cast to SG::View" );
   }
 }

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

 {
   if (!m_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ name()

const std::string & SimpleView::name ( ) const

virtualinherited

Definition at line 203 of file SimpleView.cxx.

 {
   return m_name;
 }

◆ proxies()

std::vector< const SG::DataProxy * > SimpleView::proxies ( ) const

virtualinherited

Return the list of all current proxies in store.

Definition at line 130 of file SimpleView.cxx.

 {
   return m_store->proxies();
 }

◆ proxy() [1/2]

SG::DataProxy * DebugView::proxy	(	const CLID &	id,
		const std::string &	key
	)		const

virtual

See also: SimpleView::proxy

Reimplemented from SimpleView.

Definition at line 51 of file DebugView.cxx.

 {
   return findProxy( id, key, m_allowFallThrough );
 }

◆ proxy() [2/2]

SG::DataProxy * DebugView::proxy ( const void *const pTransient ) const

virtual

Get a proxy referencing a given transient object.

Parameters

pTransient The object to find.

Returns 0 to flag failure

Reimplemented from SimpleView.

Definition at line 133 of file DebugView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::proxy" );
 }

◆ proxy_exact()

SG::DataProxy * SimpleView::proxy_exact ( SG::sgkey_t sgkey ) const

virtualinherited

Get proxy given a hashed key+clid.

Parameters

sgkey Hashed key to look up.

Find an exact match; no handling of aliases, etc. Returns 0 to flag failure.

Definition at line 51 of file SimpleView.cxx.

 {
   return nullptr;
 }

◆ recordObject()

SG::DataProxy * DebugView::recordObject	(	SG::DataObjectSharedPtr< DataObject >	obj,
		const std::string &	key,
		bool	allowMods,
		bool	returnExisting
	)

virtual

See also: SimpleView::recordObject

Reimplemented from SimpleView.

Definition at line 138 of file DebugView.cxx.

 {
   // Warn if fallthrough already happened for the object
   if ( m_fallList.find( key ) != m_fallList.end() ) {
     ATH_MSG_WARNING( "Key " << key << " was recorded to view " << m_name << " but was previously retrieved via fallthrough" );
   }
  
   return m_store->recordObject( obj, viewKey(key), allowMods, returnExisting );
 }

◆ registerKey()

void SimpleView::registerKey	(	IStringPool::sgkey_t	key,
		const std::string &	str,
		CLID	clid
	)

virtualinherited

Definition at line 221 of file SimpleView.cxx.

 {
     m_store->registerKey( key, viewKey(str), clid );
 }

◆ setFilter()

void SimpleView::setFilter ( std::vector< std::string > const & inputFilter )

inlineinherited

Set a filtering rule for anything loaded via fallthrough.

Definition at line 63 of file SimpleView.h.

64 { m_fallFilter = inputFilter; }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

◆ setROI()

void SimpleView::setROI ( const ElementLink< TrigRoiDescriptorCollection > & roi )

inherited

Definition at line 226 of file SimpleView.cxx.

                                                                            {
   m_roi = roi;
 }

◆ stringToKey()

IStringPool::sgkey_t SimpleView::stringToKey	(	const std::string &	str,
		CLID	clid
	)

virtualinherited

Definition at line 209 of file SimpleView.cxx.

 {
   return m_store->stringToKey( viewKey(str), clid );
 }

◆ tryELRemap()

bool SimpleView::tryELRemap	(	sgkey_t	sgkey_in,
		size_t	index_in,
		sgkey_t &	sgkey_out,
		size_t &	index_out
	)

virtualinherited

Test to see if the target of an ElementLink has moved.

Parameters

sgkey_in	Original hashed key of the EL.
index_in	Original index of the EL.
sgkey_out[out]	New hashed key for the EL.
index_out[out]	New index for the EL.

Returns: True if there is a remapping; false otherwise.

The default implementation here always returns false.

Definition at line 162 of file SimpleView.cxx.

 {
   throw std::runtime_error( "Not implemented: SimpleView::tryELRemap" );
 }

◆ unboundHandle()

void SimpleView::unboundHandle ( IResetable * handle )

virtualinherited

Tell the store that a handle has been unbound from a proxy.

Parameters

handle The handle that was unbound. The default implementation does nothing.

Definition at line 198 of file SimpleView.cxx.

 {
   return m_store->unboundHandle( handle );
 }

◆ viewKey()

std::string SimpleView::viewKey ( const std::string & key ) const

inherited

Construct a key as used in the parent store.

key The key as used in the view.

Definition at line 27 of file SimpleView.cxx.

 {
   return SG::transientKey (m_name + "_" + key);
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

tbb::concurrent_unordered_set< std::string > m_fallList DebugView::ATLAS_THREAD_SAFE

mutableprotected

Definition at line 65 of file DebugView.h.

◆ m_allowFallThrough

bool SimpleView::m_allowFallThrough

protectedinherited

Definition at line 197 of file SimpleView.h.

◆ m_fallFilter

std::vector< std::string > SimpleView::m_fallFilter

protectedinherited

Definition at line 196 of file SimpleView.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_name

std::string SimpleView::m_name

protectedinherited

Definition at line 194 of file SimpleView.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_parents

std::set< const SG::View* > SimpleView::m_parents

protectedinherited

Definition at line 195 of file SimpleView.h.

◆ m_roi

ElementLink<TrigRoiDescriptorCollection> SimpleView::m_roi

protectedinherited

Definition at line 193 of file SimpleView.h.

◆ m_store

ServiceHandle< StoreGateSvc > SimpleView::m_store

protectedinherited

Definition at line 190 of file SimpleView.h.

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DebugView() [1/2]

◆ DebugView() [2/2]

◆ ~DebugView()

Member Function Documentation

◆ addToStore()

◆ boundHandle()

◆ deep_proxy()

◆ dump()

◆ findProxy()

◆ getParentLinks()

◆ getROI()

◆ initMessaging()

◆ keyToString() [1/2]

◆ keyToString() [2/2]

◆ linkParent()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ proxies()

◆ proxy() [1/2]

◆ proxy() [2/2]

◆ proxy_exact()

◆ recordObject()

◆ registerKey()

◆ setFilter()

◆ setLevel()

◆ setROI()

◆ stringToKey()

◆ tryELRemap()

◆ unboundHandle()

◆ viewKey()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_allowFallThrough

◆ m_fallFilter

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_parents

◆ m_roi

◆ m_store