The Gaudi Framework  master (594c33fa)
StoreSnifferAlg Class Reference
Inheritance diagram for StoreSnifferAlg:
Collaboration diagram for StoreSnifferAlg:

Classes

struct  LeafInfo
 

Public Types

typedef map< string, LeafInfoSniffInfo
 
typedef map< string, map< int, int > > Correlations
 
- Public Types inherited from Gaudi::Algorithm
typedef Gaudi::PluginService::Factory< IAlgorithm *(const std::string &, ISvcLocator *)> Factory
 
- Public Types inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 

Public Member Functions

size_t explore (IRegistry *pObj)
 
StatusCode initialize () override
 Initialize. More...
 
StatusCode finalize () override
 Finalize. More...
 
StatusCode execute () override
 Execute procedure. More...
 
- Public Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
 LegacyAlgorithmAdapter (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
 
const EventContextgetContext () const
 
bool isExecuted () const
 Has this algorithm been executed since the last reset? More...
 
void setExecuted (bool state) const
 Set the executed flag to the specified state. More...
 
bool filterPassed () const
 Did this algorithm pass or fail its filter criterion for the last event? More...
 
void setFilterPassed (bool state) const
 Set the filter passed flag to the specified state. More...
 
- Public Member Functions inherited from Gaudi::Algorithm
 Algorithm (std::string name, ISvcLocator *svcloc, std::string version=PACKAGE_VERSION)
 Constructor. More...
 
StatusCode sysStart () override
 Reinitialization method invoked by the framework. More...
 
StatusCode sysInitialize () override
 Initialization method invoked by the framework. More...
 
StatusCode sysReinitialize () override
 Reinitialization method invoked by the framework. More...
 
StatusCode sysRestart () override
 Restart method invoked by the framework. More...
 
StatusCode sysExecute (const EventContext &ctx) override
 The actions to be performed by the algorithm on an event. More...
 
StatusCode sysStop () override
 System stop. More...
 
StatusCode sysFinalize () override
 System finalization. More...
 
const std::stringname () const override
 The identifying name of the algorithm object. More...
 
const Gaudi::StringKeynameKey () const override
 
const std::stringtype () const override
 The type of the algorithm object. More...
 
void setType (std::string type) override
 
const std::stringversion () const override
 
unsigned int index () const override
 
StatusCode configure () override
 Dummy implementation of IStateful::configure() method. More...
 
StatusCode terminate () override
 Dummy implementation of IStateful::terminate() method. More...
 
StatusCode initialize () override
 the default (empty) implementation of IStateful::initialize() method More...
 
StatusCode start () override
 the default (empty) implementation of IStateful::start() method More...
 
StatusCode stop () override
 the default (empty) implementation of IStateful::stop() method More...
 
StatusCode finalize () override
 the default (empty) implementation of IStateful::finalize() method More...
 
StatusCode reinitialize () override
 the default (empty) implementation of IStateful::reinitialize() method More...
 
StatusCode restart () override
 the default (empty) implementation of IStateful::restart() method More...
 
Gaudi::StateMachine::State FSMState () const override
 returns the current state of the algorithm More...
 
Gaudi::StateMachine::State targetFSMState () const override
 returns the state the algorithm will be in after the ongoing transition More...
 
bool isEnabled () const override
 Is this algorithm enabled or disabled? More...
 
bool isSequence () const override
 Are we a Sequence? More...
 
unsigned int errorCount () const
 Get the number of failures of the algorithm. More...
 
template<class T >
StatusCode service (std::string_view name, T *&psvc, bool createIf=true) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (std::string_view svcType, std::string_view svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
SmartIF< IServiceservice (std::string_view name, const bool createIf=true, const bool quiet=false) const
 Return a pointer to the service identified by name (or "type/name") More...
 
template<class T >
SmartIF< T > service (std::string_view name, bool createIf=true, bool quiet=false) const
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
SmartIF< IChronoStatSvc > & chronoSvc () const
 The standard Chrono & Stat service, Return a pointer to the service if present. More...
 
SmartIF< IDataProviderSvc > & detSvc () const
 The standard detector data service. More...
 
SmartIF< IConversionSvc > & detCnvSvc () const
 The standard detector data persistency conversion service. More...
 
SmartIF< IDataProviderSvc > & eventSvc () const
 The standard event data service. More...
 
SmartIF< IDataProviderSvc > & evtSvc () const
 shortcut for method eventSvc More...
 
SmartIF< IConversionSvc > & eventCnvSvc () const
 The standard event data persistency conversion service. More...
 
SmartIF< IHistogramSvc > & histoSvc () const
 The standard histogram service. More...
 
SmartIF< INTupleSvc > & ntupleSvc () const
 The standard N tuple service. More...
 
SmartIF< IRndmGenSvc > & randSvc () const
 The standard RandomGen service, Return a pointer to the service if present. More...
 
SmartIF< IToolSvc > & toolSvc () const
 The standard ToolSvc service, Return a pointer to the service if present. More...
 
SmartIF< IExceptionSvc > & exceptionSvc () const
 Get the exception Service. More...
 
SmartIF< IAlgContextSvc > & contextSvc () const
 get Algorithm Context Service More...
 
SmartIF< ITimelineSvc > & timelineSvc () const
 
SmartIF< ISvcLocator > & serviceLocator () const override
 The standard service locator. More...
 
SmartIF< ISvcLocator > & svcLoc () const
 shortcut for method serviceLocator More...
 
SmartIF< IHiveWhiteBoard > & whiteboard () const
 
SmartIF< IAlgExecStateSvc > & algExecStateSvc () const
 
bool registerContext () const
 register for Algorithm Context Service? More...
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")
 
template<class T >
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")
 
SmartIF< IMonitorSvc > & monitorSvc () const
 Access the monitor service. More...
 
template<class T >
void declareInfo (const std::string &name, const T &var, const std::string &desc) const
 Declare monitoring information. More...
 
void declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
 Declare monitoring information (special case) More...
 
void acceptDHVisitor (IDataHandleVisitor *) const override
 
void registerTool (IAlgTool *tool) const
 
void deregisterTool (IAlgTool *tool) const
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, bool createIf=true)
 
template<class T >
StatusCode declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
 
template<class T >
void addToolsArray (ToolHandleArray< T > &hndlArr)
 
const std::vector< IAlgTool * > & tools () const
 
bool isBlocking () const
 
void setBlocking (bool value)
 
unsigned int cardinality () const override
 Return the cardinality. More...
 
const std::vector< std::string > & neededResources () const override
 
AlgExecStateexecState (const EventContext &ctx) const override
 reference to AlgExecState of Alg More...
 
std::ostreamtoControlFlowExpression (std::ostream &os) const override
 Produce string represention of the control flow expression. More...
 
- Public Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
std::vector< Gaudi::DataHandle * > inputHandles () const override
 
std::vector< Gaudi::DataHandle * > outputHandles () const override
 
virtual const DataObjIDCollextraInputDeps () const override
 
virtual const DataObjIDCollextraOutputDeps () const override
 
void declare (Gaudi::DataHandle &handle) override
 
void renounce (Gaudi::DataHandle &handle) override
 
bool renounceInput (const DataObjID &id) override
 
const DataObjIDCollinputDataObjs () const override
 
const DataObjIDColloutputDataObjs () const override
 
void addDependency (const DataObjID &id, const Gaudi::DataHandle::Mode &mode) override
 
- Public Member Functions inherited from extends< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >, IDataHandleHolder >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > >
 PropertyHolder ()=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
 Helper to wrap a regular data member and use it as a regular property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
 set the property from another property with a different name More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p)
 Set the property from a property. More...
 
virtual StatusCode setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
 Set the property from a property with a different name. More...
 
virtual StatusCode setProperty (const std::string &s)=0
 Set the property by string. More...
 
StatusCode setProperty (const std::string &name, const char *v)
 Special case for string literals. More...
 
StatusCode setProperty (const std::string &name, const std::string &v)
 Special case for std::string. More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode setPropertyRepr (const std::string &n, const std::string &r) override
 set the property from name and value string representation More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (std::string_view name) const override
 get the property by name More...
 
StatusCode getProperty (std::string_view n, std::string &v) const override
 convert the property to the string More...
 
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties More...
 
bool hasProperty (std::string_view name) const override
 Return true if we have a property with the given name. More...
 
Gaudi::Details::PropertyBaseproperty (std::string_view name) const
 \fixme property and bindPropertiesTo should be protected More...
 
void bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
- Public Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level msgLevel () const
 get the cached level (originally extracted from the embedded MsgStream) More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 

Public Attributes

SmartIF< IDataManagerSvcm_mgr
 
SniffInfo m_info
 
SniffInfo m_curr
 
Correlations m_corr
 
Correlations m_links
 
- Public Attributes inherited from Gaudi::Algorithm
friend AlgorithmManager
 

Additional Inherited Members

- Protected Member Functions inherited from Gaudi::details::LegacyAlgorithmAdapter
bool isReEntrant () const override
 
- Protected Member Functions inherited from Gaudi::Algorithm
std::vector< IAlgTool * > & tools ()
 
bool isInitialized () const override
 Has the Algorithm already been initialized? More...
 
bool isFinalized () const override
 Has the Algorithm already been finalized? More...
 
void setIndex (const unsigned int &idx) override
 set instantiation index of Alg More...
 
bool isReEntrant () const override
 
- Protected Member Functions inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
void initDataHandleHolder ()
 initializes all handles - called by the sysInitialize method of any descendant of this More...
 
- Protected Member Functions inherited from CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >
MSG::Level setUpMessaging () const
 Set up local caches. More...
 
MSG::Level resetMessaging ()
 Reinitialize internal states. More...
 
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Attributes inherited from Gaudi::Algorithm
std::unique_ptr< IDataHandleVisitorm_updateDataHandles
 Hook for for derived classes to provide a custom visitor for data handles. More...
 
- Protected Attributes inherited from DataHandleHolderBase< PropertyHolder< CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > > > >
DataObjIDColl m_inputDataObjs
 
DataObjIDColl m_outputDataObjs
 

Detailed Description

Small algorithm, which traverses the data store and prints a summary of the leafs accessed during the run.

Author
: M.Frank
Version
: 1.0

Definition at line 37 of file StoreSnifferAlg.cpp.

Member Typedef Documentation

◆ Correlations

Definition at line 50 of file StoreSnifferAlg.cpp.

◆ SniffInfo

Definition at line 49 of file StoreSnifferAlg.cpp.

Member Function Documentation

◆ execute()

StatusCode StoreSnifferAlg::execute ( )
inlineoverridevirtual

Execute procedure.

Implements Algorithm.

Definition at line 137 of file StoreSnifferAlg.cpp.

137  {
138  SmartDataPtr<DataObject> root( eventSvc(), "/Event" );
139  if ( root ) {
140  m_curr.clear();
141  auto& evnt = m_curr["/Event"];
142  evnt.count = explore( root->registry() );
143  evnt.clid = root->clID();
144  evnt.id = m_curr.size();
145  for ( const auto& i : m_curr ) m_info[i.first].count++;
146  for ( const auto& i : m_info ) {
147  const string& nam = i.first;
148  // const LeafInfo& leaf = (*i).second;
149  auto c = m_corr.find( nam );
150  if ( c == m_corr.end() ) {
151  m_corr[nam] = {};
152  c = m_corr.find( nam );
153  }
154  for ( const auto& l : m_curr ) {
155  const auto& id = l.second.id;
156  auto k = c->second.find( id );
157  if ( k == c->second.end() ) k = c->second.emplace( id, 0 ).first;
158  ++( k->second );
159  }
160 
161  c = m_links.find( nam );
162  if ( c == m_links.end() ) c = m_links.emplace( nam, std::map<int, int>{} ).first;
163  if ( m_curr.find( nam ) == m_curr.end() ) continue;
164 
165  SmartDataPtr<DataObject> obj( eventSvc(), nam );
166  if ( !obj ) continue;
167 
168  LinkManager* m = obj->linkMgr();
169  for ( long l = 0; l < m->size(); ++l ) {
170  auto* lnk = m->link( l );
171  auto il = m_curr.find( lnk->path() );
172  // cout << "Link:" << lnk->path() << " " << (char*)(il != m_curr.end() ? "Found" : "Not there") << endl;
173  if ( il == m_curr.end() ) continue;
174  if ( !lnk->object() ) continue;
175  const auto& id = il->second.id;
176  auto k = c->second.find( id );
177  if ( k == c->second.end() ) k = c->second.emplace( id, 0 ).first;
178  ++( k->second );
179  }
180  }
181  }
182  return StatusCode::SUCCESS;
183  }

◆ explore()

size_t StoreSnifferAlg::explore ( IRegistry pObj)
inline

We are only interested in leaves with an object

Definition at line 55 of file StoreSnifferAlg.cpp.

55  {
56  if ( pObj ) {
57  auto mgr = eventSvc().as<IDataManagerSvc>();
58  if ( mgr ) {
59  vector<IRegistry*> leaves;
60  StatusCode sc = m_mgr->objectLeaves( pObj, leaves );
61  if ( sc.isSuccess() ) {
62  for ( auto& pReg : leaves ) {
64  if ( !pReg->address() || !pReg->object() ) continue;
65  const string& id = pReg->identifier();
66  auto j = m_info.find( id );
67  if ( j == m_info.end() ) {
68  m_info[id] = LeafInfo();
69  j = m_info.find( id );
70  j->second.count = 0;
71  j->second.id = m_info.size();
72  j->second.clid = pReg->object()->clID();
73  }
74  m_curr[id].id = m_info[id].id;
75  m_curr[id].count = explore( pReg );
76  }
77  return leaves.size();
78  }
79  }
80  }
81  return 0;
82  }

◆ finalize()

StatusCode StoreSnifferAlg::finalize ( )
inlineoverride

Finalize.

Definition at line 92 of file StoreSnifferAlg.cpp.

92  {
93  auto& log = always();
94  log << "== BEGIN ============= Access list content:" << m_info.size() << endmsg;
95  for ( const auto& i : m_info ) {
96  const LeafInfo& info = i.second;
97  log << "== ITEM == " << right << setw( 4 ) << dec << info.id << " clid:" << right << setw( 8 ) << hex << info.clid
98  << " Count:" << right << setw( 6 ) << dec << info.count << " " << i.first + ":" << endmsg;
99  auto c = m_corr.find( i.first );
100  if ( c != m_corr.end() ) {
101  int cnt = 0;
102  log << "== CORRELATIONS:" << ( *c ).second.size() << endmsg;
103  for ( const auto& k : c->second ) {
104  if ( k.second > 0 ) {
105  log << dec << k.first << ":" << k.second << " ";
106  if ( ++cnt == 10 ) {
107  cnt = 0;
108  log << endmsg;
109  }
110  }
111  }
112  if ( cnt > 0 ) log << endmsg;
113  }
114  auto l = m_links.find( i.first );
115  if ( l != m_links.end() ) {
116  int cnt = 0;
117  log << "== LINKS:" << l->second.size() << endmsg;
118  for ( const auto& k : l->second ) {
119  if ( k.second > 0 ) {
120  log << dec << k.first << ":" << k.second << " ";
121  if ( ++cnt == 10 ) {
122  cnt = 0;
123  log << endmsg;
124  }
125  }
126  }
127  if ( cnt > 0 ) log << endmsg;
128  }
129  }
130  always() << "== END =============== Access list content:" << m_info.size() << endmsg;
131  m_info.clear();
132  m_mgr = nullptr;
133  return StatusCode::SUCCESS;
134  }

◆ initialize()

StatusCode StoreSnifferAlg::initialize ( )
inlineoverride

Initialize.

Definition at line 85 of file StoreSnifferAlg.cpp.

85  {
86  m_info.clear();
87  m_mgr = eventSvc();
88  return StatusCode::SUCCESS;
89  }

Member Data Documentation

◆ m_corr

Correlations StoreSnifferAlg::m_corr

Definition at line 53 of file StoreSnifferAlg.cpp.

◆ m_curr

SniffInfo StoreSnifferAlg::m_curr

Definition at line 52 of file StoreSnifferAlg.cpp.

◆ m_info

SniffInfo StoreSnifferAlg::m_info

Definition at line 52 of file StoreSnifferAlg.cpp.

◆ m_links

Correlations StoreSnifferAlg::m_links

Definition at line 53 of file StoreSnifferAlg.cpp.

◆ m_mgr

SmartIF<IDataManagerSvc> StoreSnifferAlg::m_mgr

Definition at line 42 of file StoreSnifferAlg.cpp.


The documentation for this class was generated from the following file:
MSG::hex
MsgStream & hex(MsgStream &log)
Definition: MsgStream.h:282
StoreSnifferAlg::m_info
SniffInfo m_info
Definition: StoreSnifferAlg.cpp:52
Gaudi.Configuration.log
log
Definition: Configuration.py:28
IDataManagerSvc
Definition: IDataManagerSvc.h:55
Gaudi::Algorithm::eventSvc
SmartIF< IDataProviderSvc > & eventSvc() const
The standard event data service.
Definition: Algorithm.cpp:561
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:314
std::vector< IRegistry * >
std::map::find
T find(T... args)
std::map::size
T size(T... args)
StoreSnifferAlg::m_mgr
SmartIF< IDataManagerSvc > m_mgr
Definition: StoreSnifferAlg.cpp:42
std::map::emplace
T emplace(T... args)
gaudiComponentHelp.root
root
Definition: gaudiComponentHelp.py:42
gaudirun.c
c
Definition: gaudirun.py:525
StoreSnifferAlg::m_curr
SniffInfo m_curr
Definition: StoreSnifferAlg.cpp:52
GaudiPartProp.tests.id
id
Definition: tests.py:111
std::map::clear
T clear(T... args)
StoreSnifferAlg::m_corr
Correlations m_corr
Definition: StoreSnifferAlg.cpp:53
StatusCode
Definition: StatusCode.h:65
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:108
ProduceConsume.j
j
Definition: ProduceConsume.py:101
MSG::dec
MsgStream & dec(MsgStream &log)
Definition: MsgStream.h:278
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:203
std::map< int, int >
StoreSnifferAlg::LeafInfo::id
int id
Definition: StoreSnifferAlg.cpp:46
StoreSnifferAlg::m_links
Correlations m_links
Definition: StoreSnifferAlg.cpp:53
SmartIF::as
SmartIF< IFace > as() const
return a new SmartIF instance to another interface
Definition: SmartIF.h:117
StoreSnifferAlg::explore
size_t explore(IRegistry *pObj)
Definition: StoreSnifferAlg.cpp:55
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:100
std::right
T right(T... args)
gaudirun.l
dictionary l
Definition: gaudirun.py:581
SmartDataPtr
A small class used to access easily (and efficiently) data items residing in data stores.
Definition: SmartDataPtr.h:57
std::map::count
T count(T... args)
std::map::end
T end(T... args)
std::setw
T setw(T... args)