[llvm] [offload] Add the ability to record and replay IR bitcode modules (PR #207278)

Giorgi Gvalia via llvm-commits llvm-commits at lists.llvm.org
Thu Jul 2 16:50:53 PDT 2026


https://github.com/gvalson updated https://github.com/llvm/llvm-project/pull/207278

>From 76ae0f438a9c63a9c06a41b4fa79b81ab9f724d6 Mon Sep 17 00:00:00 2001
From: Giorgi Gvalia <>
Date: Thu, 2 Jul 2026 13:35:30 -0700
Subject: [PATCH 1/2] Add the ability to record and replay IR bitcode modules,
 allowing use of JIT

---
 .../common/include/PluginInterface.h          | 23 +++++++++++++++++++
 .../common/include/RecordReplay.h             |  6 +++--
 .../common/src/PluginInterface.cpp            |  4 ++++
 .../common/src/RecordReplay.cpp               | 20 +++++++++++++---
 .../kernelreplay/llvm-omp-kernel-replay.cpp   | 11 ++++++++-
 5 files changed, 58 insertions(+), 6 deletions(-)

diff --git a/offload/plugins-nextgen/common/include/PluginInterface.h b/offload/plugins-nextgen/common/include/PluginInterface.h
index dc21abf1a334a..9919f6cf2a3c0 100644
--- a/offload/plugins-nextgen/common/include/PluginInterface.h
+++ b/offload/plugins-nextgen/common/include/PluginInterface.h
@@ -375,6 +375,9 @@ class DeviceImageTy {
   /// The managed image data.
   std::unique_ptr<MemoryBuffer> Image;
 
+  /// An optional buffer for an IR image.
+  std::unique_ptr<MemoryBuffer> DeviceIRImage;
+
   /// Reference to the device this image is loaded on.
   GenericDeviceTy &Device;
 
@@ -402,6 +405,26 @@ class DeviceImageTy {
     return MemoryBufferRef(StringRef((const char *)getStart(), getSize()),
                            "Image");
   }
+
+  /// Get the IR image starting address.
+  const void *getIRStart() const {
+    // if (!DeviceIRImage) return nullptr;
+    return DeviceIRImage->getBufferStart();
+  }
+
+  /// Get the IR image size.
+  size_t getIRSize() const { return DeviceIRImage->getBufferSize(); }
+
+  /// Get a memory buffer reference to the whole IR image.
+  MemoryBufferRef getIRMemoryBuffer() const {
+    return MemoryBufferRef(StringRef((const char *)getIRStart(), getIRSize()),
+                           "IRImage");
+  }
+
+  /// Set the IR image
+  void setIRImage(std::unique_ptr<MemoryBuffer> m) {
+    DeviceIRImage = std::move(m);
+  }
 };
 
 /// Class implementing common functionalities of offload kernels. Each plugin
diff --git a/offload/plugins-nextgen/common/include/RecordReplay.h b/offload/plugins-nextgen/common/include/RecordReplay.h
index ef48b55ff998d..bb015d3ad30b7 100644
--- a/offload/plugins-nextgen/common/include/RecordReplay.h
+++ b/offload/plugins-nextgen/common/include/RecordReplay.h
@@ -57,7 +57,8 @@ struct RecordReplayTy {
     EpilogueSnapshot,
     Descriptor,
     Globals,
-    Program
+    Program,
+    IRModule
   };
 
   struct HandleTy {
@@ -296,7 +297,8 @@ struct NativeRecordReplayTy : public RecordReplayTy {
   Error recordGlobals(StringRef Filename);
 
   /// Record the device image to a file.
-  Error recordImage(const GenericKernelTy &Kernel, StringRef Filename);
+  Error recordImage(const GenericKernelTy &Kernel, StringRef Filename,
+                    std::optional<StringRef> IRImageFilename);
 };
 
 } // namespace plugin
diff --git a/offload/plugins-nextgen/common/src/PluginInterface.cpp b/offload/plugins-nextgen/common/src/PluginInterface.cpp
index 70e10ca6be24a..cd62b376dd625 100644
--- a/offload/plugins-nextgen/common/src/PluginInterface.cpp
+++ b/offload/plugins-nextgen/common/src/PluginInterface.cpp
@@ -695,6 +695,10 @@ Expected<DeviceImageTy *> GenericDeviceTy::loadBinary(GenericPluginTy &Plugin,
     return ImageOrErr.takeError();
   DeviceImageTy *Image = *ImageOrErr;
 
+  if (identify_magic(InputTgtImage) == file_magic::bitcode) {
+    Image->setIRImage(MemoryBuffer::getMemBufferCopy(InputTgtImage));
+  }
+
   // Add the image to list.
   LoadedImages.push_back(Image);
 
diff --git a/offload/plugins-nextgen/common/src/RecordReplay.cpp b/offload/plugins-nextgen/common/src/RecordReplay.cpp
index 436ee6308c0db..aa79be6999d51 100644
--- a/offload/plugins-nextgen/common/src/RecordReplay.cpp
+++ b/offload/plugins-nextgen/common/src/RecordReplay.cpp
@@ -246,7 +246,9 @@ Error NativeRecordReplayTy::recordPrologueImpl(
     return Err;
 
   SmallString<128> ImageFilename = getFilename(Instance, FileTy::Program);
-  return recordImage(Kernel, ImageFilename.c_str());
+
+  SmallString<128> IRImageFilename = getFilename(Instance, FileTy::IRModule);
+  return recordImage(Kernel, ImageFilename.c_str(), IRImageFilename.c_str());
 }
 
 Error NativeRecordReplayTy::recordEpilogueImpl(const GenericKernelTy &Kernel,
@@ -323,6 +325,8 @@ StringRef NativeRecordReplayTy::getExtension(FileTy FileType) {
     return "globals";
   case FileTy::Program:
     return "image";
+  case FileTy::IRModule:
+    return "bc";
   }
   return "";
 }
@@ -366,14 +370,24 @@ Error NativeRecordReplayTy::recordSnapshot(StringRef Filename) {
   return Plugin::success();
 }
 
-Error NativeRecordReplayTy::recordImage(const GenericKernelTy &Kernel,
-                                        StringRef Filename) {
+Error NativeRecordReplayTy::recordImage(
+    const GenericKernelTy &Kernel, StringRef Filename,
+    std::optional<StringRef> IRImageFilename) {
   std::error_code EC;
   raw_fd_ostream OS(Filename, EC);
   if (EC)
     return Plugin::error(ErrorCode::HOST_IO, "saving image file");
   OS << Kernel.getImage().getMemoryBuffer().getBuffer();
   OS.close();
+
+  if (IRImageFilename.has_value()) {
+    raw_fd_ostream IROS(IRImageFilename.value(), EC);
+    if (EC)
+      return Plugin::error(ErrorCode::HOST_IO, "saving image file");
+    IROS << Kernel.getImage().getIRMemoryBuffer().getBuffer();
+    IROS.close();
+  }
+
   return Plugin::success();
 }
 
diff --git a/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp b/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp
index 353bd9d07696d..0018be4db275f 100644
--- a/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp
+++ b/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp
@@ -68,6 +68,11 @@ static cl::opt<bool>
                     cl::desc("Ignore thread and team limits (unrecommended)."),
                     cl::init(false), cl::cat(ReplayOptions));
 
+static cl::opt<bool>
+    LoadBitcodeOpt("load-bitcode",
+                   cl::desc("Load the recorded IR bitcode image file."),
+                   cl::init(false), cl::cat(ReplayOptions));
+
 template <typename... ArgsTy>
 Error createErr(const char *ErrFmt, ArgsTy &&...Args) {
   return llvm::createStringError(llvm::inconvertibleErrorCode(), ErrFmt,
@@ -300,7 +305,11 @@ Error replayKernel() {
   }
 
   // Load the device image file.
-  Filepath.replace_extension("image");
+  if (LoadBitcodeOpt) {
+    Filepath.replace_extension("bc");
+  } else {
+    Filepath.replace_extension("image");
+  }
   auto ImageBufferOrErr =
       MemoryBuffer::getFile(Filepath.c_str(), /*isText=*/false,
                             /*RequiresNullTerminator=*/false);

>From b04ddb5a22f2d1e70b374ff9ea0e884c77c4e156 Mon Sep 17 00:00:00 2001
From: Giorgi Gvalia <>
Date: Thu, 2 Jul 2026 16:50:04 -0700
Subject: [PATCH 2/2] Remove getIRStart and getIRSize, rename IRModule to
 IRImage, add hasIRImage minor stylistic tweaks

---
 .../common/include/PluginInterface.h          | 25 ++++++++-----------
 .../common/include/RecordReplay.h             |  4 +--
 .../common/src/PluginInterface.cpp            |  3 +--
 .../common/src/RecordReplay.cpp               | 18 ++++++-------
 .../kernelreplay/llvm-omp-kernel-replay.cpp   |  6 +----
 5 files changed, 23 insertions(+), 33 deletions(-)

diff --git a/offload/plugins-nextgen/common/include/PluginInterface.h b/offload/plugins-nextgen/common/include/PluginInterface.h
index 9919f6cf2a3c0..e805eeeae8435 100644
--- a/offload/plugins-nextgen/common/include/PluginInterface.h
+++ b/offload/plugins-nextgen/common/include/PluginInterface.h
@@ -406,24 +406,19 @@ class DeviceImageTy {
                            "Image");
   }
 
-  /// Get the IR image starting address.
-  const void *getIRStart() const {
-    // if (!DeviceIRImage) return nullptr;
-    return DeviceIRImage->getBufferStart();
-  }
-
-  /// Get the IR image size.
-  size_t getIRSize() const { return DeviceIRImage->getBufferSize(); }
-
   /// Get a memory buffer reference to the whole IR image.
-  MemoryBufferRef getIRMemoryBuffer() const {
-    return MemoryBufferRef(StringRef((const char *)getIRStart(), getIRSize()),
-                           "IRImage");
+  MemoryBufferRef getIRImageMemoryBuffer() const {
+    if (DeviceIRImage)
+      return MemoryBufferRef(*DeviceIRImage);
+
+    return MemoryBufferRef();
   }
 
-  /// Set the IR image
-  void setIRImage(std::unique_ptr<MemoryBuffer> m) {
-    DeviceIRImage = std::move(m);
+  bool hasIRImage() const { return DeviceIRImage != nullptr; }
+
+  /// Set the IR image.
+  void setIRImage(std::unique_ptr<MemoryBuffer> ImageBuffer) {
+    DeviceIRImage = std::move(ImageBuffer);
   }
 };
 
diff --git a/offload/plugins-nextgen/common/include/RecordReplay.h b/offload/plugins-nextgen/common/include/RecordReplay.h
index bb015d3ad30b7..4c81f64620f32 100644
--- a/offload/plugins-nextgen/common/include/RecordReplay.h
+++ b/offload/plugins-nextgen/common/include/RecordReplay.h
@@ -58,7 +58,7 @@ struct RecordReplayTy {
     Descriptor,
     Globals,
     Program,
-    IRModule
+    IRImage
   };
 
   struct HandleTy {
@@ -298,7 +298,7 @@ struct NativeRecordReplayTy : public RecordReplayTy {
 
   /// Record the device image to a file.
   Error recordImage(const GenericKernelTy &Kernel, StringRef Filename,
-                    std::optional<StringRef> IRImageFilename);
+                    StringRef IRImageFilename);
 };
 
 } // namespace plugin
diff --git a/offload/plugins-nextgen/common/src/PluginInterface.cpp b/offload/plugins-nextgen/common/src/PluginInterface.cpp
index cd62b376dd625..fb84c8c5db2b9 100644
--- a/offload/plugins-nextgen/common/src/PluginInterface.cpp
+++ b/offload/plugins-nextgen/common/src/PluginInterface.cpp
@@ -695,9 +695,8 @@ Expected<DeviceImageTy *> GenericDeviceTy::loadBinary(GenericPluginTy &Plugin,
     return ImageOrErr.takeError();
   DeviceImageTy *Image = *ImageOrErr;
 
-  if (identify_magic(InputTgtImage) == file_magic::bitcode) {
+  if (identify_magic(InputTgtImage) == file_magic::bitcode)
     Image->setIRImage(MemoryBuffer::getMemBufferCopy(InputTgtImage));
-  }
 
   // Add the image to list.
   LoadedImages.push_back(Image);
diff --git a/offload/plugins-nextgen/common/src/RecordReplay.cpp b/offload/plugins-nextgen/common/src/RecordReplay.cpp
index aa79be6999d51..faa0aef2b0add 100644
--- a/offload/plugins-nextgen/common/src/RecordReplay.cpp
+++ b/offload/plugins-nextgen/common/src/RecordReplay.cpp
@@ -247,7 +247,7 @@ Error NativeRecordReplayTy::recordPrologueImpl(
 
   SmallString<128> ImageFilename = getFilename(Instance, FileTy::Program);
 
-  SmallString<128> IRImageFilename = getFilename(Instance, FileTy::IRModule);
+  SmallString<128> IRImageFilename = getFilename(Instance, FileTy::IRImage);
   return recordImage(Kernel, ImageFilename.c_str(), IRImageFilename.c_str());
 }
 
@@ -325,7 +325,7 @@ StringRef NativeRecordReplayTy::getExtension(FileTy FileType) {
     return "globals";
   case FileTy::Program:
     return "image";
-  case FileTy::IRModule:
+  case FileTy::IRImage:
     return "bc";
   }
   return "";
@@ -370,9 +370,9 @@ Error NativeRecordReplayTy::recordSnapshot(StringRef Filename) {
   return Plugin::success();
 }
 
-Error NativeRecordReplayTy::recordImage(
-    const GenericKernelTy &Kernel, StringRef Filename,
-    std::optional<StringRef> IRImageFilename) {
+Error NativeRecordReplayTy::recordImage(const GenericKernelTy &Kernel,
+                                        StringRef Filename,
+                                        StringRef IRImageFilename) {
   std::error_code EC;
   raw_fd_ostream OS(Filename, EC);
   if (EC)
@@ -380,11 +380,11 @@ Error NativeRecordReplayTy::recordImage(
   OS << Kernel.getImage().getMemoryBuffer().getBuffer();
   OS.close();
 
-  if (IRImageFilename.has_value()) {
-    raw_fd_ostream IROS(IRImageFilename.value(), EC);
+  if (!IRImageFilename.empty() && Kernel.getImage().hasIRImage()) {
+    raw_fd_ostream IROS(IRImageFilename, EC);
     if (EC)
-      return Plugin::error(ErrorCode::HOST_IO, "saving image file");
-    IROS << Kernel.getImage().getIRMemoryBuffer().getBuffer();
+      return Plugin::error(ErrorCode::HOST_IO, "saving IR image file");
+    IROS << Kernel.getImage().getIRImageMemoryBuffer().getBuffer();
     IROS.close();
   }
 
diff --git a/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp b/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp
index 0018be4db275f..3f821a33a1d9b 100644
--- a/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp
+++ b/offload/tools/kernelreplay/llvm-omp-kernel-replay.cpp
@@ -305,11 +305,7 @@ Error replayKernel() {
   }
 
   // Load the device image file.
-  if (LoadBitcodeOpt) {
-    Filepath.replace_extension("bc");
-  } else {
-    Filepath.replace_extension("image");
-  }
+  Filepath.replace_extension(LoadBitcodeOpt ? "bc" : "image");
   auto ImageBufferOrErr =
       MemoryBuffer::getFile(Filepath.c_str(), /*isText=*/false,
                             /*RequiresNullTerminator=*/false);



More information about the llvm-commits mailing list