This service gives a graphical representation of algorithms accessing StoreGate. More...

#include <SGAudSvc.h>

Inheritance diagram for SGAudSvc:

Collaboration diagram for SGAudSvc:

Public Member Functions
	SGAudSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters: More...

virtual StatusCode	initialize () override
	Gaudi Service Implementation. More...

virtual StatusCode	finalize () override

virtual void	handle (const Incident &incident) override
	incident service handle for EndEvent. More...

virtual void	SGAudit (const std::string &key, const CLID &id, const int &fnc, const int &store_id) override

bool	SGGetCurrentAlg ()
	Gets name of curently running algorithm from AlgContextSvc. More...

virtual void	setFakeCurrentAlg (const std::string &) override
	For implementing custom increased granularity auditing of for instance tools. More...

virtual void	clearFakeCurrentAlg () override
	For implementing custom increased granularity auditing of for instance tools. More...

Private Types
typedef std::map< std::string, std::set< std::string > >	DataMap

Private Member Functions
	SGAudSvc ()
	Default constructor: More...

void	SGAudRETRIEVE (std::string SGobject)

void	SGAudRECORD (std::string SGobject)

void	getNobj (const std::string &name)

void	addRead ()

void	addWrite ()

void	monitor ()
	just counts events. called at EndEvent incident More...

void	writeJSON ()

Private Attributes
Gaudi::Property< std::string >	m_outFileName

Gaudi::Property< std::string >	m_allFileName

Gaudi::Property< std::string >	m_sumFileName

Gaudi::Property< bool >	m_ignoreFakeAlgs

Gaudi::Property< int >	m_startEvent

Gaudi::Property< bool >	m_useCLID

ServiceHandle< IAlgContextSvc >	p_algCtxSvc
	Pointer to the `AlgContextScv`. More...

ServiceHandle< IClassIDSvc >	m_pCID

std::vector< std::string >	m_vObj
	Vector of accessed SG objects names. More...

std::vector< std::string >	m_vAlg
	Vector of names of algorithms accessing SG. More...

std::map< int, int >	m_timesRead
	map counting Reads of each object by each algorithm. More...

std::map< int, int >	m_timesWritten
	map counting Writes of each object by each algorithm. More...

std::string	m_currAlg

std::string	m_currObj

std::string	m_fakeCurrAlg

int	m_nCurrAlg {0}

int	m_nCurrObj {0}

int	m_nEvents {0}

DataMap	m_read

DataMap	m_write

std::ofstream	m_ofa

std::ofstream	m_ofs

bool	m_inExec {false}

Detailed Description

This service gives a graphical representation of algorithms accessing StoreGate.

SGAudSvc instruments retrieve and record functions of StoreGate and from there gets names of objects accessed. Upon getting an object name it asks AlgContexSvc for the name of the current algorithm. At the end of run, an ASCII file is produced (SGAudSvc.out).

By default data are not collected for the first three events.

Definition at line 42 of file SGAudSvc.h.

Member Typedef Documentation

◆ DataMap

typedef std::map<std::string, std::set<std::string> > SGAudSvc::DataMap

private

Definition at line 138 of file SGAudSvc.h.

Constructor & Destructor Documentation

◆ SGAudSvc() [1/2]

SGAudSvc::SGAudSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor with parameters:

Definition at line 39 of file SGAudSvc.cxx.

                                                                     : 
   base_class  ( name,     pSvcLocator ),
   p_algCtxSvc("AlgContextSvc", name),
   m_pCID("ClassIDSvc", name)
 {
 }

◆ SGAudSvc() [2/2]

SGAudSvc::SGAudSvc ( )

private

Default constructor:

Member Function Documentation

◆ addRead()

void SGAudSvc::addRead ( )

private

Definition at line 356 of file SGAudSvc.cxx.

                  {
   int oaHash=m_nCurrObj*1000 + m_nCurrAlg;
   if (m_timesRead.end()!=m_timesRead.find(oaHash)){
     m_timesRead.find(oaHash)->second++;
   } 
   else{
     std::pair<int,int> p(oaHash,1);
     m_timesRead.insert(p);
   }
   return;
 }

◆ addWrite()

void SGAudSvc::addWrite ( )

private

Definition at line 371 of file SGAudSvc.cxx.

                   {
   int oaHash=m_nCurrObj*1000 + m_nCurrAlg;
   if (m_timesWritten.end()!=m_timesWritten.find(oaHash)){
     m_timesWritten.find(oaHash)->second++; 
   }
   else{
     std::pair<int,int> p(oaHash,1);
     m_timesWritten.insert(p);
   }
   return;
 }

◆ clearFakeCurrentAlg()

void SGAudSvc::clearFakeCurrentAlg ( )

overridevirtual

For implementing custom increased granularity auditing of for instance tools.

Definition at line 391 of file SGAudSvc.cxx.

391 { m_fakeCurrAlg.clear(); }

◆ finalize()

StatusCode SGAudSvc::finalize ( )

overridevirtual

Definition at line 81 of file SGAudSvc.cxx.

                    {
  
   if (m_vAlg.size()==0) {
     ATH_MSG_WARNING("No data gathered. This might be because you did not run over at least 3 events.");
     return StatusCode::SUCCESS;
   }
   
   ATH_MSG_INFO("Writing output to: "<<m_outFileName);
   std::ofstream f( m_outFileName.value().c_str() );
   
   f << "Algs: " << m_vAlg.size() << std::endl;
   std::vector<std::string>::iterator i;
   for (i=m_vAlg.begin();i<m_vAlg.end();++i) {
           f << (*i) << std::endl;
   }
   
   f << "Obj: "<< m_vObj.size()<<std::endl;
   for (i=m_vObj.begin();i<m_vObj.end();++i) {
           f << (*i) << std::endl; 
   }
  
   
   for (unsigned int w=0;w<m_vAlg.size();w++){
     for(unsigned int q=0;q<m_vObj.size();q++){
       int oaHash=q*1000 + w;
       if (m_timesRead.find(oaHash)==m_timesRead.end())
     f << "0:";
       else
     f << m_timesRead.find(oaHash)->second << ":";
       if (m_timesWritten.find(oaHash)==m_timesWritten.end())
     f << "0\t";
       else
     f << m_timesWritten.find(oaHash)->second << "\t";   
     }
     f << std::endl;
   }
   
   f.close();
  
   if (m_ofa.is_open()) m_ofa.close();
  
   if (m_ofs.is_open()) {
  
     writeJSON();
  
     m_ofs.close();
   }
  
  
   return StatusCode::SUCCESS;
 }

◆ getNobj()

void SGAudSvc::getNobj ( const std::string & name )

private

Definition at line 336 of file SGAudSvc.cxx.

                                       {
   std::vector<std::string>::iterator i;
   int index=0;
   for (i=m_vObj.begin();i<m_vObj.end();++i){
     if (*i==name) {
       m_nCurrObj=index;
       m_currObj=name;
       return;
     }
     index++;
   }  
   m_vObj.push_back(name);
   m_nCurrObj=index;
   m_currObj=name;
 return;
 }

◆ handle()

void SGAudSvc::handle ( const Incident & incident )

overridevirtual

incident service handle for EndEvent.

Calls monitor. There should be more elegant way to get number of events passed.

Definition at line 136 of file SGAudSvc.cxx.

 {
   ATH_MSG_VERBOSE("Entering handle(). Incidence type: " << inc.type() <<
                   " from: " << inc.source());
  
   if (inc.type() == IncidentType::BeginEvent) {
     if (m_ofa.is_open())
       m_ofa << "---- BEGIN EVENT " << m_nEvents << " ----" << std::endl;
     m_inExec = true;
  
   }
  
   // Performing performance-monitoring for EndEvent incident
   if ( inc.type() == IncidentType::EndEvent ) {
     monitor();
  
     if (m_ofa.is_open()) 
       m_ofa << "---- END EVENT " << m_nEvents << " ----" << std::endl;
     m_inExec = false;
  
   }
  
   // Performing performance-monitoring for BeginRun incident
   // at this point everybody has been initialized, we can harvest performance
   // data for the initialize step.
   
   if ( inc.type() == IncidentType::BeginRun ) {
     monitor();
   }
  
   return;
 }

◆ initialize()

StatusCode SGAudSvc::initialize ( )

overridevirtual

Gaudi Service Implementation.

Definition at line 52 of file SGAudSvc.cxx.

                      {
   
   ATH_MSG_INFO("Initializing " << name() << "..." );
  
   ATH_CHECK( p_algCtxSvc.retrieve() );
   ATH_CHECK( m_pCID.retrieve() );
  
   if (m_allFileName != "") {
     m_ofa.open(m_allFileName.value().c_str());
   }
  
   if (m_sumFileName != "") {
     m_ofs.open(m_sumFileName.value().c_str());
   }
   
   // Set to be listener for end-of-event
   ServiceHandle<IIncidentSvc> incSvc( "IncidentSvc", this->name() );
   ATH_CHECK( incSvc.retrieve() );
  
   incSvc->addListener( this, IncidentType::BeginRun );
   incSvc->addListener( this, IncidentType::BeginEvent );
   incSvc->addListener( this, IncidentType::EndEvent );
  
   return StatusCode::SUCCESS;
 }

◆ monitor()

void SGAudSvc::monitor ( )

private

just counts events. called at EndEvent incident

Definition at line 173 of file SGAudSvc.cxx.

                  {
   m_nEvents++;
   return;
 }

◆ setFakeCurrentAlg()

void SGAudSvc::setFakeCurrentAlg ( const std::string & s )

overridevirtual

For implementing custom increased granularity auditing of for instance tools.

Definition at line 386 of file SGAudSvc.cxx.

386 { m_fakeCurrAlg=s; }

◆ SGAudit()

void SGAudSvc::SGAudit	(	const std::string &	key,
		const CLID &	id,
		const int &	fnc,
		const int &	store_id
	)

overridevirtual

Definition at line 226 of file SGAudSvc.cxx.

                                                {
  
   // we can sometimes get here really early, before initialization.
   if (m_pCID == 0) { return; }
  
   bool a = SGGetCurrentAlg();  
  
   if (m_nEvents >= m_startEvent && store_id == 0 && a) {
     if (typ == 0) {
       SGAudRETRIEVE(key);
     } else {
       SGAudRECORD(key);
     }
   }
  
   std::string idname;
  
   if (m_ofa.is_open() || ( m_ofs.is_open() && ! m_useCLID ) ) {
       if( ! m_pCID->getTypeNameOfID(id,idname).isSuccess()) {
     std::ostringstream ost;
     ost << id;
     idname = ost.str();
       }
   }
  
   if (m_ofa.is_open()) {
     m_ofa << ( (typ == 1) ? "RECORD" : "RETRIEVE" ) << " clid: " << id 
       << " | ";
     
     m_ofa << idname;
  
     m_ofa << "  key: " << key << "  alg: " << m_currAlg 
       << "  store: " << store_id
       << std:: endl;
   }    
  
   // store stuff for the summary
  
   if (!m_ofs.is_open()) return;
   
   if (m_nEvents < m_startEvent || !m_inExec) return;
   
   if (m_currAlg == "----") return;
     
   std::string kk;
   if (m_useCLID) {
     std::ostringstream ost;
     ost << id << "/" << key;
     kk = ost.str();
   } else {
     kk = idname + "/" + key;
   }
  
   DataMap::iterator itr;
   if (typ == 0) {
     itr = m_read.find(m_currAlg);
     if (itr != m_read.end()) {
       itr->second.insert(kk);
     } else {
       m_read[m_currAlg] = std::set<std::string> ( {kk} );
     }
   } else {
     itr = m_write.find(m_currAlg);
     if (itr != m_write.end()) {
       itr->second.insert(kk);
     } else {
       m_write[m_currAlg] = std::set<std::string> ( {kk} );
     }
   }
 }

◆ SGAudRECORD()

void SGAudSvc::SGAudRECORD ( std::string SGobject )

private

Definition at line 205 of file SGAudSvc.cxx.

                                        {
   // if (m_nEvents<3) return;
   if (SGobject=="") SGobject="noKey";  
   for (unsigned int i = 0; i < SGobject.length(); i++)        
     if (!std::isdigit(SGobject[i])){
       //isAnumb=false; 
       break;   
     }
   
   if (m_currObj==SGobject) 
     addWrite();
   else {
     getNobj(SGobject);
     addWrite();
   }
  
   return;   
 }

◆ SGAudRETRIEVE()

void SGAudSvc::SGAudRETRIEVE ( std::string SGobject )

private

Definition at line 181 of file SGAudSvc.cxx.

                                          {
   // if (m_nEvents<3) return;
   if (SGobject=="") SGobject="noKey";
   bool isAnumb=true;
   for (unsigned int i = 0; i < SGobject.length(); i++)        
     if (!std::isdigit(SGobject[i])){
       isAnumb=false; 
       break;   
     }
  
   if (!isAnumb){
     if (m_currObj==SGobject) 
       addRead();
     else {
       getNobj(SGobject);
       addRead();
     }
   }
   return;   
 }

◆ SGGetCurrentAlg()

bool SGAudSvc::SGGetCurrentAlg ( )

Gets name of curently running algorithm from AlgContextSvc.

Definition at line 301 of file SGAudSvc.cxx.

                          {
  
   IAlgorithm *asdf = p_algCtxSvc->currentAlg();
   if (!asdf || m_nEvents==0) { // to skip before first event 
     m_currAlg="----";
     m_nCurrAlg=-1;
     return false;
   }
   std::string name = asdf->name();
   
   if ( !m_ignoreFakeAlgs && !m_fakeCurrAlg.empty() )
     name=m_fakeCurrAlg;
   
   if (name!=m_currAlg){
     std::vector<std::string>::iterator i;
     int index=0;
     for (i=m_vAlg.begin();i<m_vAlg.end();++i){
       if (*i==name) {
     m_nCurrAlg=index;
     m_currAlg=name;
     return true;
       }
       index++;
     }
     m_vAlg.push_back(name);
     m_nCurrAlg=index;
     m_currAlg=name;
     return true;
   }
   return true;
 }

◆ writeJSON()

void SGAudSvc::writeJSON ( )

private

Definition at line 396 of file SGAudSvc.cxx.

                     {
  
   DataMap::const_iterator itr;
   std::set<std::string>::const_iterator it2;
   std::vector<std::string>::const_iterator ia;
   
   m_ofs << "{ \"algorithms\" : [" << std::endl;
   for (ia = m_vAlg.begin(); ia != m_vAlg.end(); ++ia) {
     m_ofs << " {" << std::endl;
     m_ofs << "  \"name\" : \"" << *ia << "\"," << std::endl;
     m_ofs << "  \"inputs\" : [";
     
     itr = m_read.find(*ia);
     if (itr != m_read.end()) {
       for (it2 = itr->second.begin(); it2 != itr->second.end(); ++it2) {
     if (it2 != itr->second.begin()) m_ofs << ",";
     m_ofs << "\"" << *it2 << "\"";
       }
     }
     m_ofs << "]," << std::endl;
     
     m_ofs << "  \"outputs\" : [";
     
     itr = m_write.find(*ia);
     if (itr != m_write.end()) {
       for (it2 = itr->second.begin(); it2 != itr->second.end(); ++it2) {
     if (it2 != itr->second.begin()) m_ofs << ",";
     m_ofs << "\"" << *it2 << "\"";
       }
     }
     m_ofs << "]," << std::endl;    
     m_ofs << " }," << std::endl;
   }
   m_ofs << " ]" << std::endl << "}" << std::endl;
  
 }

Member Data Documentation

◆ m_allFileName

Gaudi::Property<std::string> SGAudSvc::m_allFileName

private

Initial value:

{ "FullFileName", "",

"Name of the output file to hold the full SG aud data"}

Definition at line 103 of file SGAudSvc.h.

◆ m_currAlg

std::string SGAudSvc::m_currAlg

private

Definition at line 130 of file SGAudSvc.h.

◆ m_currObj

std::string SGAudSvc::m_currObj

private

Definition at line 131 of file SGAudSvc.h.

◆ m_fakeCurrAlg

std::string SGAudSvc::m_fakeCurrAlg

private

Definition at line 132 of file SGAudSvc.h.

◆ m_ignoreFakeAlgs

Gaudi::Property<bool> SGAudSvc::m_ignoreFakeAlgs

private

Initial value:

{this, "IgnoreFakeAlgs", false,

"Set to ignore any attempts to override current-alg"}

Definition at line 109 of file SGAudSvc.h.

◆ m_inExec

bool SGAudSvc::m_inExec {false}

private

Definition at line 143 of file SGAudSvc.h.

◆ m_nCurrAlg

int SGAudSvc::m_nCurrAlg {0}

private

Definition at line 133 of file SGAudSvc.h.

◆ m_nCurrObj

int SGAudSvc::m_nCurrObj {0}

private

Definition at line 134 of file SGAudSvc.h.

◆ m_nEvents

int SGAudSvc::m_nEvents {0}

private

Definition at line 135 of file SGAudSvc.h.

◆ m_ofa

std::ofstream SGAudSvc::m_ofa

private

Definition at line 142 of file SGAudSvc.h.

◆ m_ofs

std::ofstream SGAudSvc::m_ofs

private

Definition at line 142 of file SGAudSvc.h.

◆ m_outFileName

Gaudi::Property<std::string> SGAudSvc::m_outFileName

private

Initial value:

{this, "OutFileName", "SGAudSvc.out",

"Name of the output file to hold SGAudSvc data"}

Definition at line 100 of file SGAudSvc.h.

◆ m_pCID

ServiceHandle<IClassIDSvc> SGAudSvc::m_pCID

private

Definition at line 120 of file SGAudSvc.h.

◆ m_read

DataMap SGAudSvc::m_read

private

Definition at line 139 of file SGAudSvc.h.

◆ m_startEvent

Gaudi::Property<int> SGAudSvc::m_startEvent

private

Initial value:

{this, "StartEvent", 3,

"Event number to start recording data"}

Definition at line 112 of file SGAudSvc.h.

◆ m_sumFileName

Gaudi::Property<std::string> SGAudSvc::m_sumFileName

private

Initial value:

{this, "SummaryFileName", "",

"Name of the output file to hold the summary output in json format"}

Definition at line 106 of file SGAudSvc.h.

◆ m_timesRead

std::map<int,int> SGAudSvc::m_timesRead

private

map counting Reads of each object by each algorithm.

Definition at line 127 of file SGAudSvc.h.

◆ m_timesWritten

std::map<int,int> SGAudSvc::m_timesWritten

private

map counting Writes of each object by each algorithm.

Definition at line 129 of file SGAudSvc.h.

◆ m_useCLID

Gaudi::Property<bool> SGAudSvc::m_useCLID

private

Initial value:

{this, "UseCLID", true,

"Use CLID or DataObj name in Summary File"}

Definition at line 115 of file SGAudSvc.h.

◆ m_vAlg

std::vector<std::string> SGAudSvc::m_vAlg

private

Vector of names of algorithms accessing SG.

Definition at line 125 of file SGAudSvc.h.

◆ m_vObj

std::vector<std::string> SGAudSvc::m_vObj

private

Vector of accessed SG objects names.

Definition at line 123 of file SGAudSvc.h.

◆ m_write

DataMap SGAudSvc::m_write

private

Definition at line 140 of file SGAudSvc.h.

◆ p_algCtxSvc

ServiceHandle<IAlgContextSvc> SGAudSvc::p_algCtxSvc

private

Pointer to the AlgContextScv.

Definition at line 119 of file SGAudSvc.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataMap

Constructor & Destructor Documentation

◆ SGAudSvc() [1/2]

◆ SGAudSvc() [2/2]

Member Function Documentation

◆ addRead()

◆ addWrite()

◆ clearFakeCurrentAlg()

◆ finalize()

◆ getNobj()

◆ handle()

◆ initialize()

◆ monitor()

◆ setFakeCurrentAlg()

◆ SGAudit()

◆ SGAudRECORD()

◆ SGAudRETRIEVE()

◆ SGGetCurrentAlg()

◆ writeJSON()

Member Data Documentation

◆ m_allFileName

◆ m_currAlg

◆ m_currObj

◆ m_fakeCurrAlg

◆ m_ignoreFakeAlgs

◆ m_inExec

◆ m_nCurrAlg

◆ m_nCurrObj

◆ m_nEvents

◆ m_ofa

◆ m_ofs

◆ m_outFileName

◆ m_pCID

◆ m_read

◆ m_startEvent

◆ m_sumFileName

◆ m_timesRead

◆ m_timesWritten

◆ m_useCLID

◆ m_vAlg

◆ m_vObj

◆ m_write

◆ p_algCtxSvc