2f93693f76
This PR introduces a mechanism to defer JIT engine initialization, enabling registration of required symbols before global constructor execution. ## Problem Modules containing `gpu.module` generate global constructors (e.g., kernel load/unload) that execute *during* engine creation. This can force premature symbol resolution, causing failures when: - Symbols are registered via `mlirExecutionEngineRegisterSymbol` *after* creation - Global constructors exist (even if not directly using unresolved symbols, e.g., an external function declaration) - GPU modules introduce mandatory binary loading logic ## Usage ```c // Create engine without initialization MlirExecutionEngine jit = mlirExecutionEngineCreate(...); // Register required symbols mlirExecutionEngineRegisterSymbol(jit, ...); // Explicitly initialize (runs global constructors) mlirExecutionEngineInitialize(jit); ``` --------- Co-authored-by: Mehdi Amini <joker.eph@gmail.com>
123 lines
4.6 KiB
C++
123 lines
4.6 KiB
C++
//===- ExecutionEngine.cpp - C API for MLIR JIT ---------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "mlir-c/ExecutionEngine.h"
|
|
#include "mlir/CAPI/ExecutionEngine.h"
|
|
#include "mlir/CAPI/IR.h"
|
|
#include "mlir/CAPI/Support.h"
|
|
#include "mlir/ExecutionEngine/OptUtils.h"
|
|
#include "mlir/Target/LLVMIR/Dialect/Builtin/BuiltinToLLVMIRTranslation.h"
|
|
#include "mlir/Target/LLVMIR/Dialect/LLVMIR/LLVMToLLVMIRTranslation.h"
|
|
#include "mlir/Target/LLVMIR/Dialect/OpenMP/OpenMPToLLVMIRTranslation.h"
|
|
#include "llvm/ExecutionEngine/Orc/Mangling.h"
|
|
#include "llvm/Support/TargetSelect.h"
|
|
|
|
using namespace mlir;
|
|
|
|
extern "C" MlirExecutionEngine
|
|
mlirExecutionEngineCreate(MlirModule op, int optLevel, int numPaths,
|
|
const MlirStringRef *sharedLibPaths,
|
|
bool enableObjectDump) {
|
|
static bool initOnce = [] {
|
|
llvm::InitializeNativeTarget();
|
|
llvm::InitializeNativeTargetAsmParser(); // needed for inline_asm
|
|
llvm::InitializeNativeTargetAsmPrinter();
|
|
return true;
|
|
}();
|
|
(void)initOnce;
|
|
|
|
auto &ctx = *unwrap(op)->getContext();
|
|
mlir::registerBuiltinDialectTranslation(ctx);
|
|
mlir::registerLLVMDialectTranslation(ctx);
|
|
mlir::registerOpenMPDialectTranslation(ctx);
|
|
|
|
auto tmBuilderOrError = llvm::orc::JITTargetMachineBuilder::detectHost();
|
|
if (!tmBuilderOrError) {
|
|
llvm::errs() << "Failed to create a JITTargetMachineBuilder for the host\n";
|
|
return MlirExecutionEngine{nullptr};
|
|
}
|
|
auto tmOrError = tmBuilderOrError->createTargetMachine();
|
|
if (!tmOrError) {
|
|
llvm::errs() << "Failed to create a TargetMachine for the host\n";
|
|
return MlirExecutionEngine{nullptr};
|
|
}
|
|
|
|
SmallVector<StringRef> libPaths;
|
|
for (unsigned i = 0; i < static_cast<unsigned>(numPaths); ++i)
|
|
libPaths.push_back(sharedLibPaths[i].data);
|
|
|
|
// Create a transformer to run all LLVM optimization passes at the
|
|
// specified optimization level.
|
|
auto transformer = mlir::makeOptimizingTransformer(
|
|
optLevel, /*sizeLevel=*/0, /*targetMachine=*/tmOrError->get());
|
|
ExecutionEngineOptions jitOptions;
|
|
jitOptions.transformer = transformer;
|
|
jitOptions.jitCodeGenOptLevel = static_cast<llvm::CodeGenOptLevel>(optLevel);
|
|
jitOptions.sharedLibPaths = libPaths;
|
|
jitOptions.enableObjectDump = enableObjectDump;
|
|
auto jitOrError = ExecutionEngine::create(unwrap(op), jitOptions);
|
|
if (!jitOrError) {
|
|
consumeError(jitOrError.takeError());
|
|
return MlirExecutionEngine{nullptr};
|
|
}
|
|
return wrap(jitOrError->release());
|
|
}
|
|
|
|
extern "C" void mlirExecutionEngineInitialize(MlirExecutionEngine jit) {
|
|
unwrap(jit)->initialize();
|
|
}
|
|
|
|
extern "C" void mlirExecutionEngineDestroy(MlirExecutionEngine jit) {
|
|
delete (unwrap(jit));
|
|
}
|
|
|
|
extern "C" MlirLogicalResult
|
|
mlirExecutionEngineInvokePacked(MlirExecutionEngine jit, MlirStringRef name,
|
|
void **arguments) {
|
|
const std::string ifaceName = ("_mlir_ciface_" + unwrap(name)).str();
|
|
llvm::Error error = unwrap(jit)->invokePacked(
|
|
ifaceName, MutableArrayRef<void *>{arguments, (size_t)0});
|
|
if (error)
|
|
return wrap(failure());
|
|
return wrap(success());
|
|
}
|
|
|
|
extern "C" void *mlirExecutionEngineLookupPacked(MlirExecutionEngine jit,
|
|
MlirStringRef name) {
|
|
auto optionalFPtr =
|
|
llvm::expectedToOptional(unwrap(jit)->lookupPacked(unwrap(name)));
|
|
if (!optionalFPtr)
|
|
return nullptr;
|
|
return reinterpret_cast<void *>(*optionalFPtr);
|
|
}
|
|
|
|
extern "C" void *mlirExecutionEngineLookup(MlirExecutionEngine jit,
|
|
MlirStringRef name) {
|
|
auto optionalFPtr =
|
|
llvm::expectedToOptional(unwrap(jit)->lookup(unwrap(name)));
|
|
if (!optionalFPtr)
|
|
return nullptr;
|
|
return *optionalFPtr;
|
|
}
|
|
|
|
extern "C" void mlirExecutionEngineRegisterSymbol(MlirExecutionEngine jit,
|
|
MlirStringRef name,
|
|
void *sym) {
|
|
unwrap(jit)->registerSymbols([&](llvm::orc::MangleAndInterner interner) {
|
|
llvm::orc::SymbolMap symbolMap;
|
|
symbolMap[interner(unwrap(name))] = {llvm::orc::ExecutorAddr::fromPtr(sym),
|
|
llvm::JITSymbolFlags::Exported};
|
|
return symbolMap;
|
|
});
|
|
}
|
|
|
|
extern "C" void mlirExecutionEngineDumpToObjectFile(MlirExecutionEngine jit,
|
|
MlirStringRef name) {
|
|
unwrap(jit)->dumpToObjectFile(unwrap(name));
|
|
}
|