[NFC][OMPT] Make data type non-OMPT specific (llvm#3768)

Author: ronlieb

offload/libomptarget/interface.cpp

@@ -201,8 +201,11 @@ targetData(ident_t *Loc, int64_t DeviceId, int32_t ArgNum, void **ArgsBase,
   }
 
 #ifdef OMPT_SUPPORT
-  if (__tgt_async_info *AI = AsyncInfo; AI->ProfilerData)
-    delete AI->ProfilerData;
+  if (__tgt_async_info *AI = AsyncInfo; AI->ProfilerData) {
+    auto OmptData = reinterpret_cast<OmptEventInfoTy*>(AI->ProfilerData);
+    // These deletes are going to go into the OmptProfiler
+    delete OmptData;
+  }
 #endif
 
   handleTargetOutcome(Rc == OFFLOAD_SUCCESS, Loc);
@@ -491,13 +494,18 @@ static inline int targetKernel(ident_t *Loc, int64_t DeviceId, int32_t NumTeams,
   }
 
 #ifdef OMPT_SUPPORT
-  if (__tgt_async_info *AI = AsyncInfo; AI->ProfilerData)
-    delete AI->ProfilerData;
+  if (__tgt_async_info *AI = AsyncInfo; AI->ProfilerData) {
+    auto OmptData = reinterpret_cast<OmptEventInfoTy*>(AI->ProfilerData);
+    // These deletes are going to go into the OmptProfiler
+    delete OmptData;
+  }
 
   for (TargetAsyncInfoTy *LocalTAI : TargetAsyncInfos) {
     AsyncInfoTy &AsyncInfo = *LocalTAI;
     if (__tgt_async_info *AI = AsyncInfo; AI->ProfilerData) {
-      delete AI->ProfilerData;
+      auto OmptData = reinterpret_cast<OmptEventInfoTy*>(AI->ProfilerData);
+      // These deletes are going to go into the OmptProfiler
+      delete OmptData;
     }
   }
 #endif

offload/plugins-nextgen/amdgpu/src/rtl.cpp

@@ -142,35 +142,41 @@ namespace plugin {
 
 struct AMDGPUSignalTy;
 /// Use to transport information to OMPT timing functions.
-struct OmptKernelTimingArgsAsyncTy {
+struct ProfilingInfoTy {
   GenericDeviceTy *Device;
   AMDGPUSignalTy *Signal;
   double TicksToTime;
-  std::unique_ptr<ompt::OmptEventInfoTy> OmptEventInfo;
+  // FIXME: OMPT specific.
+  std::unique_ptr<ompt::OmptEventInfoTy> ProfilerSpecificData;
 };
 
-/// Get OmptKernelTimingArgsAsyncTy from the void * used in the action
+/// Get ProfilingInfoTy from the void * used in the action
 /// functions.
-static OmptKernelTimingArgsAsyncTy *getOmptTimingsArgs(void *Data);
+static ProfilingInfoTy *getProfilingInfo(void *Data);
 
 /// Returns the pair of <start, end> time for a kernel
 static std::pair<uint64_t, uint64_t>
-getKernelStartAndEndTime(const OmptKernelTimingArgsAsyncTy *Args);
+getKernelStartAndEndTime(const ProfilingInfoTy *Args);
 
 /// Returns the pair of <start, end> time for a data transfer
 static std::pair<uint64_t, uint64_t>
-getCopyStartAndEndTime(const OmptKernelTimingArgsAsyncTy *Args);
+getCopyStartAndEndTime(const ProfilingInfoTy *Args);
 
 /// Obtain the timing info and call the RegionInterface callback for the
 /// asynchronous trace records.
 static Error timeDataTransferInNsAsync(void *Data) {
-  auto Args = getOmptTimingsArgs(Data);
+  auto Args = getProfilingInfo(Data);
 
   auto [Start, End] = getCopyStartAndEndTime(Args);
 
-  auto OmptEventInfo = *Args->OmptEventInfo.get();
+  /// XXX For now this must not happen as this is only called in OMPT code path.
+  assert(Args->ProfilerSpecificData &&
+         "ProfilerSpecificData was null when profiler enabled");
+
+  // XXX: Is unique_ptr memory freed after leaving this scope?
+  auto OmptEventInfo = Args->ProfilerSpecificData.get();
   llvm::omp::target::ompt::RegionInterface.stopTargetDataMovementTraceAsync(
-      OmptEventInfo.TraceRecord, Start, End);
+      OmptEventInfo->TraceRecord, Start, End);
 
   return Plugin::success();
 }
@@ -192,11 +198,12 @@ getOrNullOmptEventInfo(AsyncInfoWrapperTy &AsyncInfoWrapper) {
 
   // We need to copy the content of the ProfilerData object to persist it
   // between multiple async operations.
-  auto LocalOmptEventInfo = std::make_unique<ompt::OmptEventInfoTy>(
-      *reinterpret_cast<ompt::OmptEventInfoTy *>(AI->ProfilerData));
-  // printOmptEventInfoTy(*AI->ProfilerData);
+  // TODO: This is OMPT specific right now
+  auto LocalOmptEventInfo =
+      reinterpret_cast<ompt::OmptEventInfoTy *>(AI->ProfilerData);
   printOmptEventInfoTy(*LocalOmptEventInfo);
-  return LocalOmptEventInfo;
+
+  return std::make_unique<ompt::OmptEventInfoTy>(*LocalOmptEventInfo);
 }
 
 } // namespace plugin
@@ -263,6 +270,8 @@ namespace llvm::omp::target::ompt {
 struct OmptEventInfoTy {};
 } // namespace llvm::omp::target::ompt
 namespace llvm::omp::target::plugin {
+
+/// When no OMPT is enabled, return nullptr to de-facto disable the profiling
 static std::unique_ptr<ompt::OmptEventInfoTy>
 getOrNullOmptEventInfo(AsyncInfoWrapperTy &AsyncInfoWrapper) {
   return nullptr;
@@ -1762,7 +1771,7 @@ struct AMDGPUStreamTy {
 #ifdef OMPT_SUPPORT
     /// Space for the OMPT action's arguments. A pointer to these arguments is
     /// passed to the action function.
-    OmptKernelTimingArgsAsyncTy OmptKernelTimingArgsAsync;
+    ProfilingInfoTy OmptKernelTimingArgsAsync;
 #endif
 
     /// Create an empty slot.
@@ -1813,19 +1822,18 @@ struct AMDGPUStreamTy {
         GenericDeviceTy *Device, AMDGPUSignalTy *OutputSignal,
         double TicksToTime, std::unique_ptr<ompt::OmptEventInfoTy> OMPTData) {
       OmptActionFunction = timeKernelInNsAsync;
-      OmptKernelTimingArgsAsync = OmptKernelTimingArgsAsyncTy{
+      OmptKernelTimingArgsAsync = ProfilingInfoTy{
           Device, OutputSignal, TicksToTime, std::move(OMPTData)};
       return Plugin::success();
     }
 
     /// Schedule OMPT data transfer timing on the slot
     Error schedOmptAsyncD2HTransferTiming(
         GenericDeviceTy *Device, AMDGPUSignalTy *OutputSignal,
-        double TicksToTime,
-        std::unique_ptr<ompt::OmptEventInfoTy> OmptInfoData) {
+        double TicksToTime, std::unique_ptr<ompt::OmptEventInfoTy> OMPTData) {
       OmptActionFunction = timeDataTransferInNsAsync;
-      OmptKernelTimingArgsAsync = OmptKernelTimingArgsAsyncTy{
-          Device, OutputSignal, TicksToTime, std::move(OmptInfoData)};
+      OmptKernelTimingArgsAsync = ProfilingInfoTy{
+          Device, OutputSignal, TicksToTime, std::move(OMPTData)};
       return Plugin::success();
     }
 #endif
@@ -2180,7 +2188,7 @@ struct AMDGPUStreamTy {
 #ifdef OMPT_SUPPORT
   static Error timeKernelInNsAsync(void *Data) {
     assert(Data && "Invalid data pointer in OMPT profiling");
-    auto Args = getOmptTimingsArgs(Data);
+    auto Args = getProfilingInfo(Data);
 
     assert(Args && "Invalid args pointer in OMPT profiling");
     auto [StartTime, EndTime] = getKernelStartAndEndTime(Args);
@@ -2189,12 +2197,11 @@ struct AMDGPUStreamTy {
        "End %lu\n",
        StartTime, EndTime);
 
-    assert(Args->OmptEventInfo && "Invalid OEI pointer in OMPT profiling");
-    auto OmptEventInfo = *Args->OmptEventInfo;
+    auto OmptEventInfo = Args->ProfilerSpecificData.get();
 
-    assert(OmptEventInfo.TraceRecord && "Invalid TraceRecord");
+    assert(OmptEventInfo->TraceRecord && "Invalid TraceRecord");
     llvm::omp::target::ompt::RegionInterface.stopTargetSubmitTraceAsync(
-        OmptEventInfo.TraceRecord, OmptEventInfo.NumTeams, StartTime, EndTime);
+        OmptEventInfo->TraceRecord, OmptEventInfo->NumTeams, StartTime, EndTime);
 
     return Plugin::success();
   }
@@ -2451,11 +2458,11 @@ struct AMDGPUStreamTy {
   /// the pinned host buffer. Both operations are asynchronous and dependent.
   /// The intermediate pinned buffer will be released to the specified memory
   /// manager once the operation completes.
-  Error pushMemoryCopyH2DAsync(void *Dst, const void *Src, void *Inter,
-                               uint64_t CopySize,
-                               AMDGPUMemoryManagerTy &MemoryManager,
-                               std::unique_ptr<ompt::OmptEventInfoTy> OmptInfo = nullptr,
-                               size_t NumTimes = 1) {
+  Error pushMemoryCopyH2DAsync(
+      void *Dst, const void *Src, void *Inter, uint64_t CopySize,
+      AMDGPUMemoryManagerTy &MemoryManager,
+      std::unique_ptr<ompt::OmptEventInfoTy> OmptInfo = nullptr,
+      size_t NumTimes = 1) {
     // Retrieve available signals for the operation's outputs.
     AMDGPUSignalTy *OutputSignals[2] = {};
     if (auto Err = SignalManager.getResources(/*Num=*/2, OutputSignals))
@@ -3815,7 +3822,7 @@ struct AMDGPUDeviceTy : public GenericDeviceTy, AMDGenericDeviceTy {
 
 #ifdef OMPT_SUPPORT
       if (LocalOmptEventInfo) {
-        OmptKernelTimingArgsAsyncTy OmptKernelTimingArgsAsync{
+        ProfilingInfoTy OmptKernelTimingArgsAsync{
             this, &Signal, TicksToTime, std::move(LocalOmptEventInfo)};
         if (auto Err = timeDataTransferInNsAsync(&OmptKernelTimingArgsAsync))
           return Err;
@@ -3909,7 +3916,7 @@ struct AMDGPUDeviceTy : public GenericDeviceTy, AMDGenericDeviceTy {
 
 #ifdef OMPT_SUPPORT
       if (LocalOmptEventInfo) {
-        OmptKernelTimingArgsAsyncTy OmptKernelTimingArgsAsync{
+        ProfilingInfoTy OmptKernelTimingArgsAsync{
             this, &Signal, TicksToTime, std::move(LocalOmptEventInfo)};
         if (auto Err = timeDataTransferInNsAsync(&OmptKernelTimingArgsAsync))
           return Err;
@@ -3967,7 +3974,7 @@ struct AMDGPUDeviceTy : public GenericDeviceTy, AMDGenericDeviceTy {
 
 #ifdef OMPT_SUPPORT
       if (LocalOmptEventInfo) {
-        OmptKernelTimingArgsAsyncTy OmptKernelTimingArgsAsync{
+        ProfilingInfoTy OmptKernelTimingArgsAsync{
             this, &Signal, TicksToTime, std::move(LocalOmptEventInfo)};
         if (auto Err = timeDataTransferInNsAsync(&OmptKernelTimingArgsAsync))
           return Err;
@@ -5807,19 +5814,16 @@ void *AMDGPUDeviceTy::allocate(size_t Size, void *, TargetAllocTy Kind) {
 
 #ifdef OMPT_SUPPORT
 /// Casts and validated the OMPT-related info passed to the action function.
-static OmptKernelTimingArgsAsyncTy *getOmptTimingsArgs(void *Data) {
-  OmptKernelTimingArgsAsyncTy *Args =
-      reinterpret_cast<OmptKernelTimingArgsAsyncTy *>(Data);
+static ProfilingInfoTy *getProfilingInfo(void *Data) {
+  ProfilingInfoTy *Args = reinterpret_cast<ProfilingInfoTy *>(Data);
   assert(Args && "Invalid argument pointer");
   assert(Args->Device && "Invalid device");
   assert(Args->Signal && "Invalid signal");
-  assert(Args->OmptEventInfo && "Invalid OMPT Async data (nullptr)");
-  assert(Args->OmptEventInfo->TraceRecord && "Invalid Trace Record Pointer");
   return Args;
 }
 
 static std::pair<uint64_t, uint64_t>
-getKernelStartAndEndTime(const OmptKernelTimingArgsAsyncTy *Args) {
+getKernelStartAndEndTime(const ProfilingInfoTy *Args) {
   assert(Args->Device && "Invalid GenericDevice Pointer in OMPT profiling");
   assert(Args->Signal && "Invalid AMDGPUSignal Pointer in OMPT profiling");
   auto *AMDGPUDevice = reinterpret_cast<AMDGPUDeviceTy *>(Args->Device);
@@ -5841,7 +5845,7 @@ getKernelStartAndEndTime(const OmptKernelTimingArgsAsyncTy *Args) {
 }
 
 static std::pair<uint64_t, uint64_t>
-getCopyStartAndEndTime(const OmptKernelTimingArgsAsyncTy *Args) {
+getCopyStartAndEndTime(const ProfilingInfoTy *Args) {
   assert(Args->Device && "Invalid GenericDevice Pointer in OMPT profiling");
   assert(Args->Signal && "Invalid AMDGPUSignal Pointer in OMPT profiling");
   hsa_amd_profiling_async_copy_time_t TimeRec{0, 0};