[Openmp-commits] [openmp] [OpenMP][OMPT] Fix device identifier collision during callbacks (PR #65595)
Michael Halkenhäuser via Openmp-commits
openmp-commits at lists.llvm.org
Thu Sep 7 04:07:01 PDT 2023
https://github.com/mhalk created https://github.com/llvm/llvm-project/pull/65595:
Fixes: https://github.com/llvm/llvm-project/issues/65104
When a user assigns devices to target regions it may happen that different identifiers will map onto the same id within different plugins. This will lead to situations where callbacks will become much harder to read, as ambiguous identifiers are reported.
We fix this by collecting the index-offset upon general RTL initialization. Which in turn, allows to calculate the unique, user-observable device id.
>From 6f6ddbae90646d9b90276ba003bf47eedab62af6 Mon Sep 17 00:00:00 2001
From: Michael Halkenhaeuser <MichaelGerald.Halkenhauser at amd.com>
Date: Wed, 6 Sep 2023 15:10:38 -0400
Subject: [PATCH] [OpenMP][OMPT] Fix device identifier collision during
callbacks
Fixes: https://github.com/llvm/llvm-project/issues/65104
When a user assigns devices to target regions it may happen that different
identifiers will map onto the same id within different plugins.
This will lead to situations where callbacks will become much harder to read,
as ambiguous identifiers are reported.
We fix this by collecting the index-offset upon general RTL initialization.
Which in turn, allows to calculate the unique, user-observable device id.
---
openmp/libomptarget/include/omptargetplugin.h | 4 ++++
openmp/libomptarget/include/rtl.h | 2 ++
.../PluginInterface/PluginInterface.cpp | 20 ++++++++++++++-----
.../common/PluginInterface/PluginInterface.h | 14 ++++++++++++-
openmp/libomptarget/src/device.cpp | 8 ++++----
openmp/libomptarget/src/rtl.cpp | 6 ++++++
6 files changed, 44 insertions(+), 10 deletions(-)
diff --git a/openmp/libomptarget/include/omptargetplugin.h b/openmp/libomptarget/include/omptargetplugin.h
index 3aa33528f9a85ef..2580731112da2ca 100644
--- a/openmp/libomptarget/include/omptargetplugin.h
+++ b/openmp/libomptarget/include/omptargetplugin.h
@@ -218,6 +218,10 @@ int32_t __tgt_rtl_data_notify_mapped(int32_t ID, void *HstPtr, int64_t Size);
// host address \p HstPtr and \p Size bytes.
int32_t __tgt_rtl_data_notify_unmapped(int32_t ID, void *HstPtr);
+// Set the global device identifier offset, such that the plugin may determine a
+// unique device number.
+int32_t __tgt_rtl_set_device_offset(int32_t DeviceIdOffset);
+
#ifdef __cplusplus
}
#endif
diff --git a/openmp/libomptarget/include/rtl.h b/openmp/libomptarget/include/rtl.h
index 29746b6a47ea75f..782a46e27bf47e6 100644
--- a/openmp/libomptarget/include/rtl.h
+++ b/openmp/libomptarget/include/rtl.h
@@ -72,6 +72,7 @@ struct RTLInfoTy {
typedef int32_t(data_unlock_ty)(int32_t, void *);
typedef int32_t(data_notify_mapped_ty)(int32_t, void *, int64_t);
typedef int32_t(data_notify_unmapped_ty)(int32_t, void *);
+ typedef int32_t(set_device_offset_ty)(int32_t);
typedef int32_t(activate_record_replay_ty)(int32_t, uint64_t, bool, bool);
int32_t Idx = -1; // RTL index, index is the number of devices
@@ -125,6 +126,7 @@ struct RTLInfoTy {
data_unlock_ty *data_unlock = nullptr;
data_notify_mapped_ty *data_notify_mapped = nullptr;
data_notify_unmapped_ty *data_notify_unmapped = nullptr;
+ set_device_offset_ty *set_device_offset = nullptr;
activate_record_replay_ty *activate_record_replay = nullptr;
// Are there images associated with this RTL.
diff --git a/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.cpp b/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.cpp
index c976c0bc59ed9b0..2a52ec2aa6b272e 100644
--- a/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.cpp
+++ b/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.cpp
@@ -542,7 +542,8 @@ Error GenericDeviceTy::init(GenericPluginTy &Plugin) {
bool ExpectedStatus = false;
if (OmptInitialized.compare_exchange_strong(ExpectedStatus, true))
performOmptCallback(device_initialize,
- /* device_num */ DeviceId,
+ /* device_num */ DeviceId +
+ Plugin.getGlobalDeviceIdOffset(),
/* type */ getComputeUnitKind().c_str(),
/* device */ reinterpret_cast<ompt_device_t *>(this),
/* lookup */ ompt::lookupCallbackByName,
@@ -587,7 +588,7 @@ Error GenericDeviceTy::init(GenericPluginTy &Plugin) {
return Plugin::success();
}
-Error GenericDeviceTy::deinit() {
+Error GenericDeviceTy::deinit(GenericPluginTy &Plugin) {
// Delete the memory manager before deinitializing the device. Otherwise,
// we may delete device allocations after the device is deinitialized.
if (MemoryManager)
@@ -605,7 +606,9 @@ Error GenericDeviceTy::deinit() {
if (ompt::Initialized) {
bool ExpectedStatus = true;
if (OmptInitialized.compare_exchange_strong(ExpectedStatus, false))
- performOmptCallback(device_finalize, /* device_num */ DeviceId);
+ performOmptCallback(device_finalize,
+ /* device_num */ DeviceId +
+ Plugin.getGlobalDeviceIdOffset());
}
#endif
@@ -656,7 +659,8 @@ GenericDeviceTy::loadBinary(GenericPluginTy &Plugin,
size_t Bytes =
getPtrDiff(InputTgtImage->ImageEnd, InputTgtImage->ImageStart);
performOmptCallback(device_load,
- /* device_num */ DeviceId,
+ /* device_num */ DeviceId +
+ Plugin.getGlobalDeviceIdOffset(),
/* FileName */ nullptr,
/* File Offset */ 0,
/* VmaInFile */ nullptr,
@@ -1362,7 +1366,7 @@ Error GenericPluginTy::deinitDevice(int32_t DeviceId) {
return Plugin::success();
// Deinitialize the device and release its resources.
- if (auto Err = Devices[DeviceId]->deinit())
+ if (auto Err = Devices[DeviceId]->deinit(*this))
return Err;
// Delete the device and invalidate its reference.
@@ -1815,6 +1819,12 @@ int32_t __tgt_rtl_init_device_info(int32_t DeviceId,
return OFFLOAD_SUCCESS;
}
+int32_t __tgt_rtl_set_device_offset(int32_t DeviceIdOffset) {
+ Plugin::get().setGlobalDeviceIdOffset(DeviceIdOffset);
+
+ return OFFLOAD_SUCCESS;
+}
+
#ifdef __cplusplus
}
#endif
diff --git a/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.h b/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.h
index 57bf3575ca45c11..63dfadb74c7aab0 100644
--- a/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.h
+++ b/openmp/libomptarget/plugins-nextgen/common/PluginInterface/PluginInterface.h
@@ -611,7 +611,7 @@ struct GenericDeviceTy : public DeviceAllocatorTy {
/// Deinitialize the device and free all its resources. After this call, the
/// device is no longer considered ready, so no queries or modifications are
/// allowed.
- Error deinit();
+ Error deinit(GenericPluginTy &Plugin);
virtual Error deinitImpl() = 0;
/// Load the binary image into the device and return the target table.
@@ -946,6 +946,14 @@ struct GenericPluginTy {
/// Get the number of active devices.
int32_t getNumDevices() const { return NumDevices; }
+ /// Get the plugin-specific device identifier offset.
+ int32_t getGlobalDeviceIdOffset() const { return GlobalDeviceIdOffset; }
+
+ /// Set the plugin-specific device identifier offset.
+ void setGlobalDeviceIdOffset(int32_t Offset) {
+ GlobalDeviceIdOffset = Offset;
+ }
+
/// Get the ELF code to recognize the binary image of this plugin.
virtual uint16_t getMagicElfBits() const = 0;
@@ -1010,6 +1018,10 @@ struct GenericPluginTy {
/// Number of devices available for the plugin.
int32_t NumDevices = 0;
+ /// Offset which when added to a DeviceId will yield a unique, user-observable
+ /// device identifier.
+ int32_t GlobalDeviceIdOffset = 0;
+
/// Array of pointers to the devices. Initially, they are all set to nullptr.
/// Once a device is initialized, the pointer is stored in the position given
/// by its device id. A position with nullptr means that the corresponding
diff --git a/openmp/libomptarget/src/device.cpp b/openmp/libomptarget/src/device.cpp
index ca5f48a4e49d129..93d2157dbd4ee15 100644
--- a/openmp/libomptarget/src/device.cpp
+++ b/openmp/libomptarget/src/device.cpp
@@ -583,7 +583,7 @@ void *DeviceTy::allocData(int64_t Size, void *HstPtr, int32_t Kind) {
void *TargetPtr = nullptr;
OMPT_IF_BUILT(InterfaceRAII TargetDataAllocRAII(
RegionInterface.getCallbacks<ompt_target_data_alloc>(),
- RTLDeviceID, HstPtr, &TargetPtr, Size,
+ DeviceID, HstPtr, &TargetPtr, Size,
/* CodePtr */ OMPT_GET_RETURN_ADDRESS(0));)
TargetPtr = RTL->data_alloc(RTLDeviceID, Size, HstPtr, Kind);
@@ -594,7 +594,7 @@ int32_t DeviceTy::deleteData(void *TgtAllocBegin, int32_t Kind) {
/// RAII to establish tool anchors before and after data deletion
OMPT_IF_BUILT(InterfaceRAII TargetDataDeleteRAII(
RegionInterface.getCallbacks<ompt_target_data_delete>(),
- RTLDeviceID, TgtAllocBegin,
+ DeviceID, TgtAllocBegin,
/* CodePtr */ OMPT_GET_RETURN_ADDRESS(0));)
return RTL->data_delete(RTLDeviceID, TgtAllocBegin, Kind);
@@ -632,7 +632,7 @@ int32_t DeviceTy::submitData(void *TgtPtrBegin, void *HstPtrBegin, int64_t Size,
OMPT_IF_BUILT(
InterfaceRAII TargetDataSubmitRAII(
RegionInterface.getCallbacks<ompt_target_data_transfer_to_device>(),
- RTLDeviceID, TgtPtrBegin, HstPtrBegin, Size,
+ DeviceID, TgtPtrBegin, HstPtrBegin, Size,
/* CodePtr */ OMPT_GET_RETURN_ADDRESS(0));)
if (!AsyncInfo || !RTL->data_submit_async || !RTL->synchronize)
@@ -660,7 +660,7 @@ int32_t DeviceTy::retrieveData(void *HstPtrBegin, void *TgtPtrBegin,
OMPT_IF_BUILT(
InterfaceRAII TargetDataRetrieveRAII(
RegionInterface.getCallbacks<ompt_target_data_transfer_from_device>(),
- RTLDeviceID, HstPtrBegin, TgtPtrBegin, Size,
+ DeviceID, HstPtrBegin, TgtPtrBegin, Size,
/* CodePtr */ OMPT_GET_RETURN_ADDRESS(0));)
if (!RTL->data_retrieve_async || !RTL->synchronize)
diff --git a/openmp/libomptarget/src/rtl.cpp b/openmp/libomptarget/src/rtl.cpp
index 6623057f394b08d..fdedf2ee456acb4 100644
--- a/openmp/libomptarget/src/rtl.cpp
+++ b/openmp/libomptarget/src/rtl.cpp
@@ -249,6 +249,8 @@ bool RTLsTy::attemptLoadRTL(const std::string &RTLName, RTLInfoTy &RTL) {
DynLibrary->getAddressOfSymbol("__tgt_rtl_data_notify_mapped");
*((void **)&RTL.data_notify_unmapped) =
DynLibrary->getAddressOfSymbol("__tgt_rtl_data_notify_unmapped");
+ *((void **)&RTL.set_device_offset) =
+ DynLibrary->getAddressOfSymbol("__tgt_rtl_set_device_offset");
// Record Replay RTL
*((void **)&RTL.activate_record_replay) =
@@ -424,6 +426,10 @@ void RTLsTy::initRTLonce(RTLInfoTy &R) {
R.IsUsed = true;
UsedRTLs.push_back(&R);
+ // If possible, set the device identifier offset
+ if (R.set_device_offset)
+ R.set_device_offset(Start);
+
DP("RTL " DPxMOD " has index %d!\n", DPxPTR(R.LibraryHandler.get()), R.Idx);
}
}
More information about the Openmp-commits
mailing list