From 92b821f2dcddbfa934689e10d8f11df150ab1043 Mon Sep 17 00:00:00 2001 From: Aiden Grossman Date: Sat, 25 Nov 2023 12:38:22 -0800 Subject: [PATCH] Reland "[llvm-exegesis] Switch from MCJIT to LLJIT (#72838)" This reverts commit ddc6ef46418cc419041d0bd85de40d0eb9396848. This relands commit 12b0ab2c9ce8ef813d9eb888860f20daac3336bd. There was an issue with certain configurations failing to build due to a deleted Error constructor that should be fixed with this relanding. --- llvm/tools/llvm-exegesis/lib/Assembler.cpp | 81 ++++++++------------- llvm/tools/llvm-exegesis/lib/Assembler.h | 7 +- llvm/tools/llvm-exegesis/lib/CMakeLists.txt | 2 +- 3 files changed, 36 insertions(+), 54 deletions(-) diff --git a/llvm/tools/llvm-exegesis/lib/Assembler.cpp b/llvm/tools/llvm-exegesis/lib/Assembler.cpp index 9ff33258e965f7..e64f4e64ebb451 100644 --- a/llvm/tools/llvm-exegesis/lib/Assembler.cpp +++ b/llvm/tools/llvm-exegesis/lib/Assembler.cpp @@ -21,11 +21,12 @@ #include "llvm/CodeGen/TargetInstrInfo.h" #include "llvm/CodeGen/TargetPassConfig.h" #include "llvm/CodeGen/TargetSubtargetInfo.h" -#include "llvm/ExecutionEngine/SectionMemoryManager.h" +#include "llvm/ExecutionEngine/Orc/LLJIT.h" #include "llvm/IR/BasicBlock.h" #include "llvm/IR/Instructions.h" #include "llvm/IR/LegacyPassManager.h" #include "llvm/MC/MCInstrInfo.h" +#include "llvm/Object/SymbolSize.h" #include "llvm/Support/Alignment.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/Support/raw_ostream.h" @@ -105,7 +106,7 @@ MachineFunction &createVoidVoidPtrMachineFunction(StringRef FunctionName, FunctionType *FunctionType = FunctionType::get(ReturnType, {MemParamType}, false); Function *const F = Function::Create( - FunctionType, GlobalValue::InternalLinkage, FunctionName, Module); + FunctionType, GlobalValue::ExternalLinkage, FunctionName, Module); BasicBlock *BB = BasicBlock::Create(Module->getContext(), "", F); new UnreachableInst(Module->getContext(), BB); return MMI->getOrCreateMachineFunction(*F); @@ -324,66 +325,48 @@ object::OwningBinary getObjectFromFile(StringRef Filename) { return cantFail(object::ObjectFile::createObjectFile(Filename)); } -namespace { - -// Implementation of this class relies on the fact that a single object with a -// single function will be loaded into memory. -class TrackingSectionMemoryManager : public SectionMemoryManager { -public: - explicit TrackingSectionMemoryManager(uintptr_t *CodeSize) - : CodeSize(CodeSize) {} - - uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment, - unsigned SectionID, - StringRef SectionName) override { - *CodeSize = Size; - return SectionMemoryManager::allocateCodeSection(Size, Alignment, SectionID, - SectionName); - } - -private: - uintptr_t *const CodeSize = nullptr; -}; - -} // namespace - Expected ExecutableFunction::create( std::unique_ptr TM, object::OwningBinary &&ObjectFileHolder) { assert(ObjectFileHolder.getBinary() && "cannot create object file"); std::unique_ptr Ctx = std::make_unique(); - // Initializing the execution engine. - // We need to use the JIT EngineKind to be able to add an object file. - LLVMLinkInMCJIT(); - uintptr_t CodeSize = 0; - std::string Error; - std::unique_ptr EE( - EngineBuilder(createModule(Ctx, TM->createDataLayout())) - .setErrorStr(&Error) - .setMCPU(TM->getTargetCPU()) - .setEngineKind(EngineKind::JIT) - .setMCJITMemoryManager( - std::make_unique(&CodeSize)) - .create(TM.release())); - if (!EE) - return make_error(Twine(Error), inconvertibleErrorCode()); - // Adding the generated object file containing the assembled function. - // The ExecutionEngine makes sure the object file is copied into an - // executable page. - EE->addObjectFile(std::move(ObjectFileHolder)); - // Fetching function bytes. - const uint64_t FunctionAddress = EE->getFunctionAddress(FunctionID); + + auto SymbolSizes = object::computeSymbolSizes(*ObjectFileHolder.getBinary()); + // Get the size of the function that we want to call into (with the name of + // FunctionID). This should always be the third symbol returned by + // calculateSymbolSizes. + assert(SymbolSizes.size() == 3); + assert(cantFail(std::get<0>(SymbolSizes[2]).getName()) == FunctionID); + uintptr_t CodeSize = std::get<1>(SymbolSizes[2]); + + auto EJITOrErr = orc::LLJITBuilder().create(); + if (!EJITOrErr) + return EJITOrErr.takeError(); + + auto EJIT = std::move(*EJITOrErr); + + if (auto ObjErr = + EJIT->addObjectFile(std::get<1>(ObjectFileHolder.takeBinary()))) + return std::move(ObjErr); + + auto FunctionAddressOrErr = EJIT->lookup(FunctionID); + if (!FunctionAddressOrErr) + return FunctionAddressOrErr.takeError(); + + const uint64_t FunctionAddress = FunctionAddressOrErr->getValue(); + assert(isAligned(kFunctionAlignment, FunctionAddress) && "function is not properly aligned"); + StringRef FBytes = StringRef(reinterpret_cast(FunctionAddress), CodeSize); - return ExecutableFunction(std::move(Ctx), std::move(EE), FBytes); + return ExecutableFunction(std::move(Ctx), std::move(EJIT), FBytes); } ExecutableFunction::ExecutableFunction(std::unique_ptr Ctx, - std::unique_ptr EE, + std::unique_ptr EJIT, StringRef FB) - : FunctionBytes(FB), Context(std::move(Ctx)), ExecEngine(std::move(EE)) {} + : FunctionBytes(FB), Context(std::move(Ctx)), ExecJIT(std::move(EJIT)) {} Error getBenchmarkFunctionBytes(const StringRef InputData, std::vector &Bytes) { diff --git a/llvm/tools/llvm-exegesis/lib/Assembler.h b/llvm/tools/llvm-exegesis/lib/Assembler.h index 5f1bf8cdfb7ad6..abc5aa7be8cfee 100644 --- a/llvm/tools/llvm-exegesis/lib/Assembler.h +++ b/llvm/tools/llvm-exegesis/lib/Assembler.h @@ -23,7 +23,7 @@ #include "llvm/ADT/BitVector.h" #include "llvm/CodeGen/MachineFunction.h" #include "llvm/CodeGen/MachineModuleInfo.h" -#include "llvm/ExecutionEngine/ExecutionEngine.h" +#include "llvm/ExecutionEngine/Orc/LLJIT.h" #include "llvm/IR/LLVMContext.h" #include "llvm/IR/Module.h" #include "llvm/MC/MCInst.h" @@ -124,11 +124,10 @@ class ExecutableFunction { private: ExecutableFunction(std::unique_ptr Ctx, - std::unique_ptr EE, - StringRef FunctionBytes); + std::unique_ptr EJIT, StringRef FunctionBytes); std::unique_ptr Context; - std::unique_ptr ExecEngine; + std::unique_ptr ExecJIT; }; // Copies benchmark function's bytes from benchmark object. diff --git a/llvm/tools/llvm-exegesis/lib/CMakeLists.txt b/llvm/tools/llvm-exegesis/lib/CMakeLists.txt index 92135e6aaf673b..7312811989dd80 100644 --- a/llvm/tools/llvm-exegesis/lib/CMakeLists.txt +++ b/llvm/tools/llvm-exegesis/lib/CMakeLists.txt @@ -29,10 +29,10 @@ set(LLVM_LINK_COMPONENTS MC MCA MCDisassembler - MCJIT MCParser Object ObjectYAML + OrcJIT RuntimeDyld Support TargetParser