AthHIP::DeviceMemoryResourceTool Class Reference

Tool providing memory resource for device memory. More...

#include <DeviceMemoryResourceTool.h>

Inheritance diagram for AthHIP::DeviceMemoryResourceTool:

Collaboration diagram for AthHIP::DeviceMemoryResourceTool:

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.
std::string	m_deviceName
	Name of the device for which the memory resource is provided.
Tool properties
Gaudi::Property< int >	m_deviceID
	Device to allocate memory on.

Detailed Description

Tool providing memory resource for device memory.

Making use of vecmem::hip::device_memory_resource.

Definition at line 22 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.h.

Member Function Documentation

deviceName()

std::string_view AthHIP::DeviceMemoryResourceTool::deviceName ( ) const

overridevirtual

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

Definition at line 62 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.cxx.

                                                          {
 
  return m_deviceName;
}

initialize()

StatusCode AthHIP::DeviceMemoryResourceTool::initialize ( )

overridevirtual

Initialize the tool.

Definition at line 16 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.cxx.

                                                {
 
  // Construct the appropriate memory resource.
  m_mr = std::make_unique<vecmem::hip::device_memory_resource>(m_deviceID);
 
  // Figure out which device the memory resource was created for. Unfortunately
  // vecmem doesn't advertise this in a convenient way at the moment. :( So we
  // have to re-create its logic here.
  int deviceID = m_deviceID;
  if (deviceID == vecmem::hip::device_memory_resource::INVALID_DEVICE) {
    // The default device was requested. We have to query for the current
    // device.
    hipError_t err = hipGetDevice(&deviceID);
    if (err != hipSuccess) {
      ATH_MSG_ERROR(
          "Failed to query the current HIP device: " << hipGetErrorString(err));
      return StatusCode::FAILURE;
    }
  }
 
  // Get the device's properties.
  hipDeviceProp_t props;
  hipError_t err = hipGetDeviceProperties(&props, deviceID);
  if (err != hipSuccess) {
    ATH_MSG_ERROR(
        "Failed to get the HIP device properties: " << hipGetErrorString(err));
    return StatusCode::FAILURE;
  }
 
  // Construct a unique name out of those properties.
  std::ostringstream deviceName;
  deviceName << props.name << " [id: " << deviceID
             << ", bus: " << props.pciBusID << ", device: " << props.pciDeviceID
             << "]";
  m_deviceName = deviceName.str();
 
  // Return gracefully.
  return StatusCode::SUCCESS;
}

mr()

std::pmr::memory_resource & AthHIP::DeviceMemoryResourceTool::mr ( ) const

overridevirtual

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

Definition at line 56 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.cxx.

                                                          {
 
  assert(m_mr);
  return *m_mr;
}

Member Data Documentation

m_deviceID

Gaudi::Property<int> AthHIP::DeviceMemoryResourceTool::m_deviceID

private

Initial value:

{
      this, "DeviceID", vecmem::hip::device_memory_resource::INVALID_DEVICE,
      "ID of the device to allocate memory on (-1 to use the default device)"}

Device to allocate memory on.

Definition at line 58 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.h.

                               {
      this, "DeviceID", vecmem::hip::device_memory_resource::INVALID_DEVICE,
      "ID of the device to allocate memory on (-1 to use the default device)"};

m_deviceName

std::string AthHIP::DeviceMemoryResourceTool::m_deviceName

private

Name of the device for which the memory resource is provided.

Definition at line 52 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.h.

m_mr

std::unique_ptr<std::pmr::memory_resource> AthHIP::DeviceMemoryResourceTool::m_mr

private

The memory resource that this tool uses.

Definition at line 50 of file AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.h.

---

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

• AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.h
• AthHIP/AthHIPComps/src/DeviceMemoryResourceTool.cxx