AthDevice::MemoryMonitorSvc Class Reference

Service providing "device memory monitoring". More...

#include <MemoryMonitorSvc.h>

Inheritance diagram for AthDevice::MemoryMonitorSvc:

Collaboration diagram for AthDevice::MemoryMonitorSvc:

Classes
struct	MemoryAllocKey
	Key used in the memory allocation/deallocation monitoring maps. More...
struct	MemoryCopyKey
	Key used in the memory copy monitoring map. More...

Public Member Functions
Function(s) inherited from @c AthService
virtual StatusCode	finalize () override
	Finalize the service.
Function(s) inherited from @c IMemoryMonitorSvc
virtual void	memoryAllocated (const std::string &component, const std::string &device, std::size_t bytes) override
	Notify the service that a memory allocation has been made.
virtual void	memoryDeallocated (const std::string &component, const std::string &device, std::size_t bytes) override
	Notify the service that a memory deallocation has been made.
virtual void	memoryCopied (const std::string &component, vecmem::copy::type::copy_type type, std::size_t bytes) override
	Notify the service that a memory copy has been made.

Private Attributes
Objects collecting the monitoring data
std::map< MemoryAllocKey, std::size_t >	m_allocations
	All the memory allocations.
std::mutex	m_allocationsMutex
	Mutex for m_allocations.
std::map< MemoryAllocKey, std::size_t >	m_deallocations
	All the memory deallocations.
std::mutex	m_deallocationsMutex
	Mutex for m_deallocations.
std::map< MemoryCopyKey, std::size_t >	m_copies
	All the memory copies.
std::mutex	m_copiesMutex
	Mutex for m_copies.

Detailed Description

Service providing "device memory monitoring".

Definition at line 20 of file MemoryMonitorSvc.h.

Member Function Documentation

finalize()

StatusCode AthDevice::MemoryMonitorSvc::finalize ( )

overridevirtual

Finalize the service.

Definition at line 35 of file MemoryMonitorSvc.cxx.

                                      {
 
  // Find the longest component name, to make the output more readable.
  std::size_t longestComponentName = 0u;
  auto helper = [&longestComponentName](const auto& map) {
    for (const auto& [key, bytes] : map) {
      longestComponentName =
          std::max(longestComponentName, key.component.size());
    }
  };
  helper(m_allocations);
  helper(m_deallocations);
 
  // Print the memory allocation monitoring data.
  ATH_MSG_INFO("Memory allocations:");
  std::string currentDevice = "";
  for (const auto& [key, bytes] : m_allocations) {
    if (key.device != currentDevice) {
      ATH_MSG_INFO("  - " << key.device);
      currentDevice = key.device;
    }
    ATH_MSG_INFO("    * " << std::setw(longestComponentName) << std::left
                          << key.component << " : " << std::setw(15)
                          << std::right << formatBytes(bytes));
  }
 
  // Print the memory deallocation monitoring data.
  ATH_MSG_INFO("Memory deallocations:");
  currentDevice = "";
  for (const auto& [key, bytes] : m_deallocations) {
    if (key.device != currentDevice) {
      ATH_MSG_INFO("  - " << key.device);
      currentDevice = key.device;
    }
    ATH_MSG_INFO("    * " << std::setw(longestComponentName) << std::left
                          << key.component << " : " << std::setw(15)
                          << std::right << formatBytes(bytes));
  }
 
  // TODO: Print the memory copy monitoring data.
 
  // Return gracefully.
  return StatusCode::SUCCESS;
}

memoryAllocated()

void AthDevice::MemoryMonitorSvc::memoryAllocated ( const std::string & component, const std::string & device, std::size_t bytes )

overridevirtual

Notify the service that a memory allocation has been made.

Definition at line 80 of file MemoryMonitorSvc.cxx.

                                                        {
 
  std::lock_guard lock(m_allocationsMutex);
  m_allocations[{component, device}] += bytes;
}

memoryCopied()

void AthDevice::MemoryMonitorSvc::memoryCopied ( const std::string & component, vecmem::copy::type::copy_type type, std::size_t bytes )

overridevirtual

Notify the service that a memory copy has been made.

Definition at line 96 of file MemoryMonitorSvc.cxx.

                                                     {
 
  std::lock_guard lock(m_copiesMutex);
  m_copies[{component, type}] += bytes;
}

memoryDeallocated()

void AthDevice::MemoryMonitorSvc::memoryDeallocated ( const std::string & component, const std::string & device, std::size_t bytes )

overridevirtual

Notify the service that a memory deallocation has been made.

Definition at line 88 of file MemoryMonitorSvc.cxx.

                                                          {
 
  std::lock_guard lock(m_deallocationsMutex);
  m_deallocations[{component, device}] += bytes;
}

Member Data Documentation

m_allocations

std::map<MemoryAllocKey, std::size_t> AthDevice::MemoryMonitorSvc::m_allocations

private

All the memory allocations.

Definition at line 78 of file MemoryMonitorSvc.h.

m_allocationsMutex

std::mutex AthDevice::MemoryMonitorSvc::m_allocationsMutex

private

Mutex for m_allocations.

Definition at line 80 of file MemoryMonitorSvc.h.

m_copies

std::map<MemoryCopyKey, std::size_t> AthDevice::MemoryMonitorSvc::m_copies

private

All the memory copies.

Definition at line 104 of file MemoryMonitorSvc.h.

m_copiesMutex

std::mutex AthDevice::MemoryMonitorSvc::m_copiesMutex

private

Mutex for m_copies.

Definition at line 106 of file MemoryMonitorSvc.h.

m_deallocations

std::map<MemoryAllocKey, std::size_t> AthDevice::MemoryMonitorSvc::m_deallocations

private

All the memory deallocations.

Definition at line 82 of file MemoryMonitorSvc.h.

m_deallocationsMutex

std::mutex AthDevice::MemoryMonitorSvc::m_deallocationsMutex

private

Mutex for m_deallocations.

Definition at line 84 of file MemoryMonitorSvc.h.

---

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

• MemoryMonitorSvc.h
• MemoryMonitorSvc.cxx