AthDevice::MonitoredMemoryResourceTool Class Reference

Tool providing monitoring functionality for memory resources. More...

#include <MonitoredMemoryResourceTool.h>

Inheritance diagram for AthDevice::MonitoredMemoryResourceTool:

Collaboration diagram for AthDevice::MonitoredMemoryResourceTool:

Public Member Functions
Function(s) inherited from @c AthAlgTool
virtual StatusCode	initialize () override
	Initialize the tool.
Function(s) inherited from @c AthDevice::IMemoryResourceTool
virtual std::pmr::memory_resource &	mr () const override
	Get the provided std::pmr::memory_resource object.
virtual std::string_view	deviceName () const override
	The name of the device for which the memory resource is provided.

Private Attributes
std::unique_ptr< std::pmr::memory_resource >	m_mr
	The memory resource that this tool uses.
Tool properties
ToolHandle< IMemoryResourceTool >	m_mrTool
	Underlying memory resource to use for allocations.
ServiceHandle< IMemoryMonitorSvc >	m_monitorSvc
	Service collecting the memory monitoring information.

Detailed Description

Tool providing monitoring functionality for memory resources.

Making use of AthDevice::MonitoredMemoryResource, which would in turn provide monitoring information to AthDevice::IMemoryMonitorSvc.

Definition at line 22 of file MonitoredMemoryResourceTool.h.

Member Function Documentation

deviceName()

std::string_view AthDevice::MonitoredMemoryResourceTool::deviceName ( ) const

overridevirtual

The name of the device for which the memory resource is provided.

Definition at line 45 of file MonitoredMemoryResourceTool.cxx.

                                                             {
 
  assert(m_mrTool.isValid());
  return m_mrTool->deviceName();
}

initialize()

StatusCode AthDevice::MonitoredMemoryResourceTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 12 of file MonitoredMemoryResourceTool.cxx.

                                                   {
 
  // Retrieve the upstream tool.
  ATH_CHECK(m_mrTool.retrieve());
 
  // Retrieve the monitoring service.
  ATH_CHECK(m_monitorSvc.retrieve());
 
  // Get the name of the tool's parent.
  std::string component;
  const INamedInterface* parent =
      dynamic_cast<const INamedInterface*>(this->parent());
  if (parent) {
    component = parent->name();
  } else {
    ATH_MSG_WARNING("Could not retrieve the name of the parent component");
    component = "Unknown";
  }
 
  // Construct the monitored resource.
  m_mr = std::make_unique<MonitoredMemoryResource>(
      m_mrTool->mr(), *m_monitorSvc, component, std::string{deviceName()});
 
  // Return gracefully.
  return StatusCode::SUCCESS;
}

mr()

std::pmr::memory_resource & AthDevice::MonitoredMemoryResourceTool::mr ( ) const

overridevirtual

Get the provided std::pmr::memory_resource object.

Definition at line 39 of file MonitoredMemoryResourceTool.cxx.

                                                             {
 
  assert(m_mr);
  return *m_mr;
}

Member Data Documentation

m_monitorSvc

ServiceHandle<IMemoryMonitorSvc> AthDevice::MonitoredMemoryResourceTool::m_monitorSvc

private

Initial value:

{
      this, "MonitorSvc", "AthDevice::MemoryMonitorSvc",
      "Memory monitor service to collect the monitoring information"}

Service collecting the memory monitoring information.

Definition at line 60 of file MonitoredMemoryResourceTool.h.

                                               {
      this, "MonitorSvc", "AthDevice::MemoryMonitorSvc",
      "Memory monitor service to collect the monitoring information"};

m_mr

std::unique_ptr<std::pmr::memory_resource> AthDevice::MonitoredMemoryResourceTool::m_mr

private

The memory resource that this tool uses.

Definition at line 50 of file MonitoredMemoryResourceTool.h.

m_mrTool

ToolHandle<IMemoryResourceTool> AthDevice::MonitoredMemoryResourceTool::m_mrTool

private

Initial value:

{
      this, "MRTool", "", "Memory resource tool to use for allocations"}

Underlying memory resource to use for allocations.

Definition at line 56 of file MonitoredMemoryResourceTool.h.

                                          {
      this, "MRTool", "", "Memory resource tool to use for allocations"};

---

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

• MonitoredMemoryResourceTool.h
• MonitoredMemoryResourceTool.cxx