[llvm] 7b73cd6 - [ORC] Introduce C API for adding object buffers directly to an object layer.
Lang Hames via llvm-commits
llvm-commits at lists.llvm.org
Wed May 5 19:12:30 PDT 2021
Author: Lang Hames
Date: 2021-05-05T19:02:13-07:00
New Revision: 7b73cd684a8d5fb44d34064200f10e2723085c33
URL: https://github.com/llvm/llvm-project/commit/7b73cd684a8d5fb44d34064200f10e2723085c33
DIFF: https://github.com/llvm/llvm-project/commit/7b73cd684a8d5fb44d34064200f10e2723085c33.diff
LOG: [ORC] Introduce C API for adding object buffers directly to an object layer.
This can be useful for clients constructing custom JIT stacks: If the C API
for your custom stack exposes API to obtain a reference to an object layer
(e.g. LLVMOrcLLJITGetObjLinkingLayer) then the newly added
LLVMOrcObjectLayerAddObjectFile and LLVMOrcObjectLayerAddObjectFileWithRT
functions can be used to add objects directly to that layer.
Added:
Modified:
llvm/include/llvm-c/Orc.h
llvm/lib/ExecutionEngine/Orc/OrcV2CBindings.cpp
llvm/unittests/ExecutionEngine/Orc/OrcCAPITest.cpp
Removed:
################################################################################
diff --git a/llvm/include/llvm-c/Orc.h b/llvm/include/llvm-c/Orc.h
index 76692ba89def6..17e9dab6ea9e5 100644
--- a/llvm/include/llvm-c/Orc.h
+++ b/llvm/include/llvm-c/Orc.h
@@ -671,6 +671,37 @@ void LLVMOrcJITTargetMachineBuilderSetTargetTriple(
void LLVMOrcJITTargetMachineBuilderDisposeTargetTriple(
LLVMOrcJITTargetMachineBuilderRef JTMB, char *TargetTriple);
+/**
+ * Add an object to an ObjectLayer to the given JITDylib.
+ *
+ * Adds a buffer representing an object file to the given JITDylib using the
+ * given ObjectLayer instance. This operation transfers ownership of the buffer
+ * to the ObjectLayer instance. The buffer should not be disposed of or
+ * referenced once this function returns.
+ *
+ * Resources associated with the given object will be tracked by the given
+ * JITDylib's default ResourceTracker.
+ */
+LLVMErrorRef LLVMOrcObjectLayerAddObjectFile(LLVMOrcObjectLayerRef ObjLayer,
+ LLVMOrcJITDylibRef JD,
+ LLVMMemoryBufferRef ObjBuffer);
+
+/**
+ * Add an object to an ObjectLayer using the given ResourceTracker.
+ *
+ * Adds a buffer representing an object file to the given ResourceTracker's
+ * JITDylib using the given ObjectLayer instance. This operation transfers
+ * ownership of the buffer to the ObjectLayer instance. The buffer should not
+ * be disposed of or referenced once this function returns.
+ *
+ * Resources associated with the given object will be tracked by
+ * ResourceTracker RT.
+ */
+LLVMErrorRef
+LLVMOrcObjectLayerAddObjectFileWithRT(LLVMOrcObjectLayerRef ObjLayer,
+ LLVMOrcResourceTrackerRef RT,
+ LLVMMemoryBufferRef ObjBuffer);
+
/**
* Emit an object buffer to an ObjectLayer.
*
diff --git a/llvm/lib/ExecutionEngine/Orc/OrcV2CBindings.cpp b/llvm/lib/ExecutionEngine/Orc/OrcV2CBindings.cpp
index 5f9cb10be5888..dd81ba14e2957 100644
--- a/llvm/lib/ExecutionEngine/Orc/OrcV2CBindings.cpp
+++ b/llvm/lib/ExecutionEngine/Orc/OrcV2CBindings.cpp
@@ -491,6 +491,21 @@ void LLVMOrcJITTargetMachineBuilderDisposeTargetTriple(
free(TargetTriple);
}
+LLVMErrorRef LLVMOrcObjectLayerAddObjectFile(LLVMOrcObjectLayerRef ObjLayer,
+ LLVMOrcJITDylibRef JD,
+ LLVMMemoryBufferRef ObjBuffer) {
+ return wrap(unwrap(ObjLayer)->add(
+ *unwrap(JD), std::unique_ptr<MemoryBuffer>(unwrap(ObjBuffer))));
+}
+
+LLVMErrorRef LLVMOrcLLJITAddObjectFileWithRT(LLVMOrcObjectLayerRef ObjLayer,
+ LLVMOrcResourceTrackerRef RT,
+ LLVMMemoryBufferRef ObjBuffer) {
+ return wrap(
+ unwrap(ObjLayer)->add(ResourceTrackerSP(unwrap(RT)),
+ std::unique_ptr<MemoryBuffer>(unwrap(ObjBuffer))));
+}
+
void LLVMOrcObjectLayerEmit(LLVMOrcObjectLayerRef ObjLayer,
LLVMOrcMaterializationResponsibilityRef R,
LLVMMemoryBufferRef ObjBuffer) {
diff --git a/llvm/unittests/ExecutionEngine/Orc/OrcCAPITest.cpp b/llvm/unittests/ExecutionEngine/Orc/OrcCAPITest.cpp
index 50a2ee459ac2e..efafb685c46a5 100644
--- a/llvm/unittests/ExecutionEngine/Orc/OrcCAPITest.cpp
+++ b/llvm/unittests/ExecutionEngine/Orc/OrcCAPITest.cpp
@@ -13,9 +13,18 @@
#include "gtest/gtest.h"
#include "llvm/ADT/Triple.h"
+#include "llvm/ExecutionEngine/Orc/CompileUtils.h"
+#include "llvm/IR/LLVMContext.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IRReader/IRReader.h"
+#include "llvm/Support/Error.h"
+#include "llvm/Support/SourceMgr.h"
#include <string>
using namespace llvm;
+using namespace llvm::orc;
+
+DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ThreadSafeModule, LLVMOrcThreadSafeModuleRef)
// OrcCAPITestBase contains several helper methods and pointers for unit tests
// written for the LLVM-C API. It provides the following helpers:
@@ -109,6 +118,7 @@ class OrcCAPITestBase : public testing::Test {
}
static void materializationUnitFn() {}
+
// Stub definition generator, where all Names are materialized from the
// materializationUnitFn() test function and defined into the JIT Dylib
static LLVMErrorRef
@@ -132,29 +142,47 @@ class OrcCAPITestBase : public testing::Test {
}
return LLVMErrorSuccess;
}
- // create a test LLVM IR module containing a function named "sum" which has
- // returns the sum of its two parameters
- static LLVMOrcThreadSafeModuleRef createTestModule() {
- LLVMOrcThreadSafeContextRef TSC = LLVMOrcCreateNewThreadSafeContext();
- LLVMContextRef Ctx = LLVMOrcThreadSafeContextGetContext(TSC);
- LLVMModuleRef Mod = LLVMModuleCreateWithNameInContext("test", Ctx);
+
+ static Error createSMDiagnosticError(llvm::SMDiagnostic &Diag) {
+ std::string Msg;
{
- LLVMTypeRef Int32Ty = LLVMInt32TypeInContext(Ctx);
- LLVMTypeRef ParamTys[] = {Int32Ty, Int32Ty};
- LLVMTypeRef TestFnTy = LLVMFunctionType(Int32Ty, ParamTys, 2, 0);
- LLVMValueRef TestFn = LLVMAddFunction(Mod, "sum", TestFnTy);
- LLVMBuilderRef IRBuilder = LLVMCreateBuilderInContext(Ctx);
- LLVMBasicBlockRef EntryBB = LLVMAppendBasicBlock(TestFn, "entry");
- LLVMPositionBuilderAtEnd(IRBuilder, EntryBB);
- LLVMValueRef Arg1 = LLVMGetParam(TestFn, 0);
- LLVMValueRef Arg2 = LLVMGetParam(TestFn, 1);
- LLVMValueRef Sum = LLVMBuildAdd(IRBuilder, Arg1, Arg2, "");
- LLVMBuildRet(IRBuilder, Sum);
- LLVMDisposeBuilder(IRBuilder);
+ raw_string_ostream OS(Msg);
+ Diag.print("", OS);
}
- LLVMOrcThreadSafeModuleRef TSM = LLVMOrcCreateNewThreadSafeModule(Mod, TSC);
- LLVMOrcDisposeThreadSafeContext(TSC);
- return TSM;
+ return make_error<StringError>(std::move(Msg), inconvertibleErrorCode());
+ }
+
+ // Create an LLVM IR module from the given StringRef.
+ static Expected<std::unique_ptr<Module>>
+ parseTestModule(LLVMContext &Ctx, StringRef Source, StringRef Name) {
+ assert(TargetSupported &&
+ "Attempted to create module for unsupported target");
+ SMDiagnostic Err;
+ if (auto M = parseIR(MemoryBufferRef(Source, Name), Err, Ctx))
+ return std::move(M);
+ return createSMDiagnosticError(Err);
+ }
+
+ // returns the sum of its two parameters
+ static LLVMOrcThreadSafeModuleRef createTestModule(StringRef Source,
+ StringRef Name) {
+ auto Ctx = std::make_unique<LLVMContext>();
+ auto M = cantFail(parseTestModule(*Ctx, Source, Name));
+ return wrap(new ThreadSafeModule(std::move(M), std::move(Ctx)));
+ }
+
+ static LLVMMemoryBufferRef createTestObject(StringRef Source,
+ StringRef Name) {
+ auto Ctx = std::make_unique<LLVMContext>();
+ auto M = cantFail(parseTestModule(*Ctx, Source, Name));
+
+ auto JTMB = cantFail(JITTargetMachineBuilder::detectHost());
+ M->setDataLayout(cantFail(JTMB.getDefaultDataLayoutForTarget()));
+ auto TM = cantFail(JTMB.createTargetMachine());
+
+ SimpleCompiler SC(*TM);
+ auto ObjBuffer = cantFail(SC(*M));
+ return wrap(ObjBuffer.release());
}
static std::string TargetTriple;
@@ -164,6 +192,19 @@ class OrcCAPITestBase : public testing::Test {
std::string OrcCAPITestBase::TargetTriple;
bool OrcCAPITestBase::TargetSupported = false;
+namespace {
+
+constexpr StringRef SumExample =
+ R"(
+ define i32 @sum(i32 %x, i32 %y) {
+ entry:
+ %r = add nsw i32 %x, %y
+ ret i32 %r
+ }
+ )";
+
+} // end anonymous namespace.
+
// Consumes the given error ref and returns the string error message.
static std::string toString(LLVMErrorRef E) {
char *ErrMsg = LLVMGetErrorMessage(E);
@@ -261,7 +302,7 @@ TEST_F(OrcCAPITestBase, ResourceTrackerDefinitionLifetime) {
// removed.
LLVMOrcResourceTrackerRef RT =
LLVMOrcJITDylibCreateResourceTracker(MainDylib);
- LLVMOrcThreadSafeModuleRef TSM = createTestModule();
+ LLVMOrcThreadSafeModuleRef TSM = createTestModule(SumExample, "sum.ll");
if (LLVMErrorRef E = LLVMOrcLLJITAddLLVMIRModuleWithRT(Jit, RT, TSM))
FAIL() << "Failed to add LLVM IR module to LLJIT (triple = " << TargetTriple
<< "): " << toString(E);
@@ -290,7 +331,7 @@ TEST_F(OrcCAPITestBase, ResourceTrackerTransfer) {
LLVMOrcJITDylibGetDefaultResourceTracker(MainDylib);
LLVMOrcResourceTrackerRef RT2 =
LLVMOrcJITDylibCreateResourceTracker(MainDylib);
- LLVMOrcThreadSafeModuleRef TSM = createTestModule();
+ LLVMOrcThreadSafeModuleRef TSM = createTestModule(SumExample, "sum.ll");
if (LLVMErrorRef E = LLVMOrcLLJITAddLLVMIRModuleWithRT(Jit, DefaultRT, TSM))
FAIL() << "Failed to add LLVM IR module to LLJIT (triple = " << TargetTriple
<< "): " << toString(E);
@@ -304,6 +345,27 @@ TEST_F(OrcCAPITestBase, ResourceTrackerTransfer) {
LLVMOrcReleaseResourceTracker(RT2);
}
+TEST_F(OrcCAPITestBase, AddObjectBuffer) {
+ if (!Jit) {
+ // TODO: Use GTEST_SKIP() when GTest is updated to version 1.10.0
+ return;
+ }
+
+ LLVMOrcObjectLayerRef ObjLinkingLayer = LLVMOrcLLJITGetObjLinkingLayer(Jit);
+ LLVMMemoryBufferRef ObjBuffer = createTestObject(SumExample, "sum.ll");
+
+ if (LLVMErrorRef E = LLVMOrcObjectLayerAddObjectFile(ObjLinkingLayer,
+ MainDylib, ObjBuffer))
+ FAIL() << "Failed to add object file to ObjLinkingLayer (triple = "
+ << TargetTriple << "): " << toString(E);
+
+ LLVMOrcJITTargetAddress SumAddr;
+ if (LLVMErrorRef E = LLVMOrcLLJITLookup(Jit, &SumAddr, "sum"))
+ FAIL() << "Symbol \"sum\" was not added into JIT (triple = " << TargetTriple
+ << "): " << toString(E);
+ ASSERT_TRUE(!!SumAddr);
+}
+
TEST_F(OrcCAPITestBase, ExecutionTest) {
if (!Jit) {
// TODO: Use GTEST_SKIP() when GTest is updated to version 1.10.0
@@ -314,7 +376,7 @@ TEST_F(OrcCAPITestBase, ExecutionTest) {
// This test performs OrcJIT compilation of a simple sum module
LLVMInitializeNativeAsmPrinter();
- LLVMOrcThreadSafeModuleRef TSM = createTestModule();
+ LLVMOrcThreadSafeModuleRef TSM = createTestModule(SumExample, "sum.ll");
if (LLVMErrorRef E = LLVMOrcLLJITAddLLVMIRModule(Jit, MainDylib, TSM))
FAIL() << "Failed to add LLVM IR module to LLJIT (triple = " << TargetTriple
<< ")" << toString(E);
More information about the llvm-commits
mailing list