Service that enables the Jemalloc profiler on demand. More...

#include <jemalloc/JemallocProfileSvc.h>

Inheritance diagram for JemallocProfileSvc:

Collaboration diagram for JemallocProfileSvc:

Public Member Functions
	JemallocProfileSvc (const std::string &name, ISvcLocator *svcLoc)
	Standard constructor. More...

StatusCode	initialize ()
	Initializer. More...

StatusCode	finalize ()
	Finalizer. More...

void	handle (const Incident &incident)
	Destructor. More...

virtual	~JemallocProfileSvc ()

Public Member Functions inherited from extends< Service, IIncidentListener >
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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	~extends () override=default
	Virtual destructor. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const 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 (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...

template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Member Functions
void	handleBegin ()

void	handleEnd ()

void	startProfiling ()
	Utility method to start profiling with jemalloc. More...

void	stopProfiling ()
	Utility method to stop profiling with jemalloc. More...

void	dumpProfile ()
	Utility method to dump profile with jemalloc. More...

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Private Attributes
int	m_nStartFromEvent
	Start, End event and counter. More...

int	m_nStopAtEvent

int	m_dumpPeriod

int	m_eventNumber

std::vector< std::string >	m_startFromIncidents

std::vector< std::string >	m_stopAtIncidents

bool	m_hasStartIncident

bool	m_hasStopIncident

bool	m_profiling
	Status of the profiling. More...

SmartIF< IIncidentSvc >	m_incidentSvc
	Pointer to the incident service. More...

Additional Inherited Members
Public Types inherited from extends< Service, IIncidentListener >
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 Service
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, 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...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Detailed Description

Service that enables the Jemalloc profiler on demand.

By default, the profiling is diabled, the user needs to set incidents at which to start/stop the profiling, or specify incidents for that purpose.

Author: Ben Couturier

Date: 2016-01-12

Definition at line 18 of file JemallocProfileSvc.h.

Constructor & Destructor Documentation

JemallocProfileSvc::JemallocProfileSvc	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

Standard constructor.

Definition at line 28 of file JemallocProfileSvc.cpp.

                                                                                 :
   base_class(name, svcLoc), m_eventNumber(0),  m_startFromIncidents({}),
   m_stopAtIncidents({}), m_hasStartIncident(false), m_hasStopIncident(false),
   m_profiling(false) {
   
   declareProperty("StartFromEventN", m_nStartFromEvent = 0,
                   "After what event we start profiling. "
                   );
 
   declareProperty("StartFromIncidents", m_startFromIncidents = {},
                   "Incidents that trigger profiling start"
                   );
 
   declareProperty("StopAtEventN", m_nStopAtEvent = 0,
                   "After what event we stop profiling. "
                   "If 0 than we also profile finalization stage. Default = 0."
                   );
 
   declareProperty("StopAtIncidents", m_stopAtIncidents = {},
                   "Incidents that trigger profiling start"
                   );
 
   declareProperty("DumpPeriod", m_dumpPeriod = 100,
                   "Period for dumping head to a file. Default=100"
                   );
 
 }

JemallocProfileSvc::~JemallocProfileSvc ( )

virtual

Definition at line 233 of file JemallocProfileSvc.cpp.

233 {}

Member Function Documentation

void JemallocProfileSvc::dumpProfile ( )

inlineprotected

Utility method to dump profile with jemalloc.

Definition at line 220 of file JemallocProfileSvc.cpp.

 {
     info() << "Dumping Jemalloc profile at event " 
            <<  m_eventNumber << endmsg;
     mallctl("prof.dump", NULL, NULL, NULL, 0);
 
 }

StatusCode JemallocProfileSvc::finalize ( )

Finalizer.

Definition at line 105 of file JemallocProfileSvc.cpp.

                                         {
 
   // unregistering from the IncidentSvc
   m_incidentSvc->removeListener(this, IncidentType::BeginEvent);
   m_incidentSvc->removeListener(this, IncidentType::EndEvent);
   m_incidentSvc.reset();
   return base_class::finalize();
 }

void JemallocProfileSvc::handle ( const Incident & incident )

Destructor.

Definition at line 120 of file JemallocProfileSvc.cpp.

 {
   if (IncidentType::BeginEvent == incident.type())
   {
     handleBegin();
   } else if (IncidentType::EndEvent == incident.type()) 
   {
     handleEnd();
   }
   
   // If already processing we can ignore the incidents for start
   if (!m_profiling && m_hasStartIncident) 
   {
     for(std::string startincident: m_startFromIncidents) 
     {
       if (startincident == incident.type()) 
       {
         info() << "Starting Jemalloc profile at incident "
                <<  incident.type() << endmsg;
         startProfiling();
         break;
       }
     } // Loop on incidents 
   } // If checking incidents to start
 
   // If already processing we can ignore the incidents for start
   if (m_profiling && m_hasStopIncident) 
   {
     for(std::string stopincident: m_stopAtIncidents) 
     {
       if (stopincident == incident.type()) 
       {
         info() << "Stopping Jemalloc profile at incident "
                <<  incident.type() << endmsg;
         stopProfiling();
         break;
       }
     } // Loop on incidents 
   } // If checking incidents to stop
 
   
 }

void JemallocProfileSvc::handleBegin ( )

inlineprotected

Definition at line 165 of file JemallocProfileSvc.cpp.

 { 
   m_eventNumber += 1;
   
   if (m_eventNumber == m_nStartFromEvent)
   {
     startProfiling();
   }
 }

void JemallocProfileSvc::handleEnd ( )

inlineprotected

Definition at line 177 of file JemallocProfileSvc.cpp.

 {
   if (m_profiling
       && m_eventNumber != m_nStartFromEvent
       && ((m_eventNumber - m_nStartFromEvent) % m_dumpPeriod == 0)) 
   {
     dumpProfile();
   }
 
   if (m_eventNumber ==  m_nStopAtEvent) 
   {
     stopProfiling();
   } 
 }

StatusCode JemallocProfileSvc::initialize ( )

Initializer.

Definition at line 59 of file JemallocProfileSvc.cpp.

                                           {
   StatusCode sc = base_class::initialize();
   if (sc.isFailure()) return sc;
 
   // register to the incident service
   static const std::string serviceName = "IncidentSvc";
   m_incidentSvc = serviceLocator()->service(serviceName);
   if ( ! m_incidentSvc ) {
     error() << "Cannot retrieve " << serviceName << endmsg;
     return StatusCode::FAILURE;
   }
   
   debug() << "Register to the IncidentSvc" << endmsg;
   m_incidentSvc->addListener(this, IncidentType::BeginEvent);
   m_incidentSvc->addListener(this, IncidentType::EndEvent);
   for (std::string incident: m_startFromIncidents) 
   {
     m_incidentSvc->addListener(this, incident);
   }  
   for (std::string incident: m_stopAtIncidents) 
   {
     m_incidentSvc->addListener(this, incident);
   }
 
   // Resetting the event counter
   m_eventNumber = 0;
   m_profiling = false;
 
   // Cache whether we have start/stop incidents
   m_hasStartIncident = (m_startFromIncidents.size() > 0);
   m_hasStopIncident = (m_stopAtIncidents.size() > 0);
 
   // Checking the consistency of the start/stop events
   if (m_nStartFromEvent == 0 && !m_hasStartIncident
       && (m_hasStopIncident || m_nStopAtEvent > 0))
     {
       info() << "Stop profiling trigger was specified but no start. Defaulting to first events" << endmsg;
       m_nStartFromEvent = 1;
     }
       
 
 
   return StatusCode::SUCCESS;
 }

void JemallocProfileSvc::startProfiling ( )

inlineprotected

Utility method to start profiling with jemalloc.

Definition at line 200 of file JemallocProfileSvc.cpp.

 {
   m_profiling = true;
   info() << "Starting Jemalloc profile at event "
          <<  m_eventNumber << endmsg;
   mallctl("prof.dump", NULL, NULL, NULL, 0);
 }

void JemallocProfileSvc::stopProfiling ( )

inlineprotected

Utility method to stop profiling with jemalloc.

Definition at line 211 of file JemallocProfileSvc.cpp.

 {
     m_profiling = false;
     dumpProfile();
 }

Member Data Documentation

int JemallocProfileSvc::m_dumpPeriod

private

Definition at line 49 of file JemallocProfileSvc.h.

int JemallocProfileSvc::m_eventNumber

private

Definition at line 50 of file JemallocProfileSvc.h.

bool JemallocProfileSvc::m_hasStartIncident

private

Definition at line 53 of file JemallocProfileSvc.h.

bool JemallocProfileSvc::m_hasStopIncident

private

Definition at line 54 of file JemallocProfileSvc.h.

SmartIF<IIncidentSvc> JemallocProfileSvc::m_incidentSvc

private

Pointer to the incident service.

Definition at line 61 of file JemallocProfileSvc.h.

int JemallocProfileSvc::m_nStartFromEvent

private

Start, End event and counter.

Definition at line 47 of file JemallocProfileSvc.h.

int JemallocProfileSvc::m_nStopAtEvent

private

Definition at line 48 of file JemallocProfileSvc.h.

bool JemallocProfileSvc::m_profiling

private

Status of the profiling.

Definition at line 58 of file JemallocProfileSvc.h.

std::vector<std::string> JemallocProfileSvc::m_startFromIncidents

private

Definition at line 51 of file JemallocProfileSvc.h.

std::vector<std::string> JemallocProfileSvc::m_stopAtIncidents

private

Definition at line 52 of file JemallocProfileSvc.h.

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

GaudiProfiling/src/component/jemalloc/JemallocProfileSvc.h
GaudiProfiling/src/component/jemalloc/JemallocProfileSvc.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation