1283625Sdim//===---- ExecutionUtils.cpp - Utilities for executing functions in Orc ---===// 2283625Sdim// 3353358Sdim// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4353358Sdim// See https://llvm.org/LICENSE.txt for license information. 5353358Sdim// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6283625Sdim// 7283625Sdim//===----------------------------------------------------------------------===// 8283625Sdim 9283625Sdim#include "llvm/ExecutionEngine/Orc/ExecutionUtils.h" 10283625Sdim 11360784Sdim#include "llvm/ExecutionEngine/Orc/Layer.h" 12283625Sdim#include "llvm/IR/Constants.h" 13283625Sdim#include "llvm/IR/Function.h" 14283625Sdim#include "llvm/IR/GlobalVariable.h" 15283625Sdim#include "llvm/IR/Module.h" 16341825Sdim#include "llvm/Support/TargetRegistry.h" 17341825Sdim#include "llvm/Target/TargetMachine.h" 18283625Sdim 19283625Sdimnamespace llvm { 20283625Sdimnamespace orc { 21283625Sdim 22360784Sdimint runAsMain(int (*Main)(int, char *[]), ArrayRef<std::string> Args, 23360784Sdim Optional<StringRef> ProgramName) { 24360784Sdim std::vector<std::unique_ptr<char[]>> ArgVStorage; 25360784Sdim std::vector<char *> ArgV; 26360784Sdim 27360784Sdim ArgVStorage.reserve(Args.size() + (ProgramName ? 1 : 0)); 28360784Sdim ArgV.reserve(Args.size() + 1 + (ProgramName ? 1 : 0)); 29360784Sdim 30360784Sdim if (ProgramName) { 31360784Sdim ArgVStorage.push_back(std::make_unique<char[]>(ProgramName->size() + 1)); 32360784Sdim llvm::copy(*ProgramName, &ArgVStorage.back()[0]); 33360784Sdim ArgVStorage.back()[ProgramName->size()] = '\0'; 34360784Sdim ArgV.push_back(ArgVStorage.back().get()); 35360784Sdim } 36360784Sdim 37360784Sdim for (auto &Arg : Args) { 38360784Sdim ArgVStorage.push_back(std::make_unique<char[]>(Arg.size() + 1)); 39360784Sdim llvm::copy(Arg, &ArgVStorage.back()[0]); 40360784Sdim ArgVStorage.back()[Arg.size()] = '\0'; 41360784Sdim ArgV.push_back(ArgVStorage.back().get()); 42360784Sdim } 43360784Sdim ArgV.push_back(nullptr); 44360784Sdim 45360784Sdim return Main(Args.size() + !!ProgramName, ArgV.data()); 46360784Sdim} 47360784Sdim 48283625SdimCtorDtorIterator::CtorDtorIterator(const GlobalVariable *GV, bool End) 49283625Sdim : InitList( 50283625Sdim GV ? dyn_cast_or_null<ConstantArray>(GV->getInitializer()) : nullptr), 51283625Sdim I((InitList && End) ? InitList->getNumOperands() : 0) { 52283625Sdim} 53283625Sdim 54283625Sdimbool CtorDtorIterator::operator==(const CtorDtorIterator &Other) const { 55283625Sdim assert(InitList == Other.InitList && "Incomparable iterators."); 56283625Sdim return I == Other.I; 57283625Sdim} 58283625Sdim 59283625Sdimbool CtorDtorIterator::operator!=(const CtorDtorIterator &Other) const { 60283625Sdim return !(*this == Other); 61283625Sdim} 62283625Sdim 63283625SdimCtorDtorIterator& CtorDtorIterator::operator++() { 64283625Sdim ++I; 65283625Sdim return *this; 66283625Sdim} 67283625Sdim 68283625SdimCtorDtorIterator CtorDtorIterator::operator++(int) { 69283625Sdim CtorDtorIterator Temp = *this; 70283625Sdim ++I; 71283625Sdim return Temp; 72283625Sdim} 73283625Sdim 74283625SdimCtorDtorIterator::Element CtorDtorIterator::operator*() const { 75283625Sdim ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(I)); 76283625Sdim assert(CS && "Unrecognized type in llvm.global_ctors/llvm.global_dtors"); 77283625Sdim 78283625Sdim Constant *FuncC = CS->getOperand(1); 79283625Sdim Function *Func = nullptr; 80283625Sdim 81283625Sdim // Extract function pointer, pulling off any casts. 82283625Sdim while (FuncC) { 83283625Sdim if (Function *F = dyn_cast_or_null<Function>(FuncC)) { 84283625Sdim Func = F; 85283625Sdim break; 86283625Sdim } else if (ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(FuncC)) { 87283625Sdim if (CE->isCast()) 88283625Sdim FuncC = dyn_cast_or_null<ConstantExpr>(CE->getOperand(0)); 89283625Sdim else 90283625Sdim break; 91283625Sdim } else { 92283625Sdim // This isn't anything we recognize. Bail out with Func left set to null. 93283625Sdim break; 94283625Sdim } 95283625Sdim } 96283625Sdim 97360784Sdim auto *Priority = cast<ConstantInt>(CS->getOperand(0)); 98341825Sdim Value *Data = CS->getNumOperands() == 3 ? CS->getOperand(2) : nullptr; 99341825Sdim if (Data && !isa<GlobalValue>(Data)) 100341825Sdim Data = nullptr; 101283625Sdim return Element(Priority->getZExtValue(), Func, Data); 102283625Sdim} 103283625Sdim 104283625Sdimiterator_range<CtorDtorIterator> getConstructors(const Module &M) { 105283625Sdim const GlobalVariable *CtorsList = M.getNamedGlobal("llvm.global_ctors"); 106283625Sdim return make_range(CtorDtorIterator(CtorsList, false), 107283625Sdim CtorDtorIterator(CtorsList, true)); 108283625Sdim} 109283625Sdim 110283625Sdimiterator_range<CtorDtorIterator> getDestructors(const Module &M) { 111283625Sdim const GlobalVariable *DtorsList = M.getNamedGlobal("llvm.global_dtors"); 112283625Sdim return make_range(CtorDtorIterator(DtorsList, false), 113283625Sdim CtorDtorIterator(DtorsList, true)); 114283625Sdim} 115283625Sdim 116344779Sdimvoid CtorDtorRunner::add(iterator_range<CtorDtorIterator> CtorDtors) { 117360784Sdim if (CtorDtors.empty()) 118341825Sdim return; 119341825Sdim 120341825Sdim MangleAndInterner Mangle( 121344779Sdim JD.getExecutionSession(), 122341825Sdim (*CtorDtors.begin()).Func->getParent()->getDataLayout()); 123341825Sdim 124360784Sdim for (auto CtorDtor : CtorDtors) { 125341825Sdim assert(CtorDtor.Func && CtorDtor.Func->hasName() && 126341825Sdim "Ctor/Dtor function must be named to be runnable under the JIT"); 127341825Sdim 128344779Sdim // FIXME: Maybe use a symbol promoter here instead. 129344779Sdim if (CtorDtor.Func->hasLocalLinkage()) { 130344779Sdim CtorDtor.Func->setLinkage(GlobalValue::ExternalLinkage); 131344779Sdim CtorDtor.Func->setVisibility(GlobalValue::HiddenVisibility); 132344779Sdim } 133344779Sdim 134341825Sdim if (CtorDtor.Data && cast<GlobalValue>(CtorDtor.Data)->isDeclaration()) { 135341825Sdim dbgs() << " Skipping because why now?\n"; 136341825Sdim continue; 137341825Sdim } 138341825Sdim 139341825Sdim CtorDtorsByPriority[CtorDtor.Priority].push_back( 140341825Sdim Mangle(CtorDtor.Func->getName())); 141341825Sdim } 142341825Sdim} 143341825Sdim 144344779SdimError CtorDtorRunner::run() { 145341825Sdim using CtorDtorTy = void (*)(); 146341825Sdim 147360784Sdim SymbolLookupSet LookupSet; 148360784Sdim for (auto &KV : CtorDtorsByPriority) 149360784Sdim for (auto &Name : KV.second) 150360784Sdim LookupSet.add(Name); 151360784Sdim assert(!LookupSet.containsDuplicates() && 152360784Sdim "Ctor/Dtor list contains duplicates"); 153341825Sdim 154344779Sdim auto &ES = JD.getExecutionSession(); 155360784Sdim if (auto CtorDtorMap = ES.lookup( 156360784Sdim makeJITDylibSearchOrder(&JD, JITDylibLookupFlags::MatchAllSymbols), 157360784Sdim std::move(LookupSet))) { 158341825Sdim for (auto &KV : CtorDtorsByPriority) { 159341825Sdim for (auto &Name : KV.second) { 160341825Sdim assert(CtorDtorMap->count(Name) && "No entry for Name"); 161341825Sdim auto CtorDtor = reinterpret_cast<CtorDtorTy>( 162341825Sdim static_cast<uintptr_t>((*CtorDtorMap)[Name].getAddress())); 163341825Sdim CtorDtor(); 164341825Sdim } 165341825Sdim } 166353358Sdim CtorDtorsByPriority.clear(); 167341825Sdim return Error::success(); 168341825Sdim } else 169341825Sdim return CtorDtorMap.takeError(); 170341825Sdim} 171341825Sdim 172341825Sdimvoid LocalCXXRuntimeOverridesBase::runDestructors() { 173283625Sdim auto& CXXDestructorDataPairs = DSOHandleOverride; 174283625Sdim for (auto &P : CXXDestructorDataPairs) 175283625Sdim P.first(P.second); 176283625Sdim CXXDestructorDataPairs.clear(); 177283625Sdim} 178283625Sdim 179341825Sdimint LocalCXXRuntimeOverridesBase::CXAAtExitOverride(DestructorPtr Destructor, 180341825Sdim void *Arg, 181341825Sdim void *DSOHandle) { 182283625Sdim auto& CXXDestructorDataPairs = 183283625Sdim *reinterpret_cast<CXXDestructorDataPairList*>(DSOHandle); 184283625Sdim CXXDestructorDataPairs.push_back(std::make_pair(Destructor, Arg)); 185283625Sdim return 0; 186283625Sdim} 187283625Sdim 188344779SdimError LocalCXXRuntimeOverrides::enable(JITDylib &JD, 189344779Sdim MangleAndInterner &Mangle) { 190344779Sdim SymbolMap RuntimeInterposes; 191344779Sdim RuntimeInterposes[Mangle("__dso_handle")] = 192344779Sdim JITEvaluatedSymbol(toTargetAddress(&DSOHandleOverride), 193344779Sdim JITSymbolFlags::Exported); 194344779Sdim RuntimeInterposes[Mangle("__cxa_atexit")] = 195344779Sdim JITEvaluatedSymbol(toTargetAddress(&CXAAtExitOverride), 196344779Sdim JITSymbolFlags::Exported); 197341825Sdim 198344779Sdim return JD.define(absoluteSymbols(std::move(RuntimeInterposes))); 199341825Sdim} 200341825Sdim 201344779SdimDynamicLibrarySearchGenerator::DynamicLibrarySearchGenerator( 202353358Sdim sys::DynamicLibrary Dylib, char GlobalPrefix, SymbolPredicate Allow) 203341825Sdim : Dylib(std::move(Dylib)), Allow(std::move(Allow)), 204353358Sdim GlobalPrefix(GlobalPrefix) {} 205341825Sdim 206360784SdimExpected<std::unique_ptr<DynamicLibrarySearchGenerator>> 207353358SdimDynamicLibrarySearchGenerator::Load(const char *FileName, char GlobalPrefix, 208344779Sdim SymbolPredicate Allow) { 209344779Sdim std::string ErrMsg; 210344779Sdim auto Lib = sys::DynamicLibrary::getPermanentLibrary(FileName, &ErrMsg); 211344779Sdim if (!Lib.isValid()) 212344779Sdim return make_error<StringError>(std::move(ErrMsg), inconvertibleErrorCode()); 213360784Sdim return std::make_unique<DynamicLibrarySearchGenerator>( 214360784Sdim std::move(Lib), GlobalPrefix, std::move(Allow)); 215344779Sdim} 216344779Sdim 217360784SdimError DynamicLibrarySearchGenerator::tryToGenerate( 218360784Sdim LookupKind K, JITDylib &JD, JITDylibLookupFlags JDLookupFlags, 219360784Sdim const SymbolLookupSet &Symbols) { 220341825Sdim orc::SymbolMap NewSymbols; 221341825Sdim 222341825Sdim bool HasGlobalPrefix = (GlobalPrefix != '\0'); 223341825Sdim 224360784Sdim for (auto &KV : Symbols) { 225360784Sdim auto &Name = KV.first; 226360784Sdim 227344779Sdim if ((*Name).empty()) 228341825Sdim continue; 229341825Sdim 230344779Sdim if (Allow && !Allow(Name)) 231344779Sdim continue; 232344779Sdim 233341825Sdim if (HasGlobalPrefix && (*Name).front() != GlobalPrefix) 234341825Sdim continue; 235341825Sdim 236353358Sdim std::string Tmp((*Name).data() + HasGlobalPrefix, 237353358Sdim (*Name).size() - HasGlobalPrefix); 238341825Sdim if (void *Addr = Dylib.getAddressOfSymbol(Tmp.c_str())) { 239341825Sdim NewSymbols[Name] = JITEvaluatedSymbol( 240341825Sdim static_cast<JITTargetAddress>(reinterpret_cast<uintptr_t>(Addr)), 241341825Sdim JITSymbolFlags::Exported); 242341825Sdim } 243341825Sdim } 244341825Sdim 245360784Sdim if (NewSymbols.empty()) 246360784Sdim return Error::success(); 247341825Sdim 248360784Sdim return JD.define(absoluteSymbols(std::move(NewSymbols))); 249341825Sdim} 250341825Sdim 251360784SdimExpected<std::unique_ptr<StaticLibraryDefinitionGenerator>> 252360784SdimStaticLibraryDefinitionGenerator::Load(ObjectLayer &L, const char *FileName) { 253360784Sdim auto ArchiveBuffer = errorOrToExpected(MemoryBuffer::getFile(FileName)); 254360784Sdim 255360784Sdim if (!ArchiveBuffer) 256360784Sdim return ArchiveBuffer.takeError(); 257360784Sdim 258360784Sdim return Create(L, std::move(*ArchiveBuffer)); 259360784Sdim} 260360784Sdim 261360784SdimExpected<std::unique_ptr<StaticLibraryDefinitionGenerator>> 262360784SdimStaticLibraryDefinitionGenerator::Create( 263360784Sdim ObjectLayer &L, std::unique_ptr<MemoryBuffer> ArchiveBuffer) { 264360784Sdim Error Err = Error::success(); 265360784Sdim 266360784Sdim std::unique_ptr<StaticLibraryDefinitionGenerator> ADG( 267360784Sdim new StaticLibraryDefinitionGenerator(L, std::move(ArchiveBuffer), Err)); 268360784Sdim 269360784Sdim if (Err) 270360784Sdim return std::move(Err); 271360784Sdim 272360784Sdim return std::move(ADG); 273360784Sdim} 274360784Sdim 275360784SdimError StaticLibraryDefinitionGenerator::tryToGenerate( 276360784Sdim LookupKind K, JITDylib &JD, JITDylibLookupFlags JDLookupFlags, 277360784Sdim const SymbolLookupSet &Symbols) { 278360784Sdim 279360784Sdim // Don't materialize symbols from static archives unless this is a static 280360784Sdim // lookup. 281360784Sdim if (K != LookupKind::Static) 282360784Sdim return Error::success(); 283360784Sdim 284360784Sdim // Bail out early if we've already freed the archive. 285360784Sdim if (!Archive) 286360784Sdim return Error::success(); 287360784Sdim 288360784Sdim DenseSet<std::pair<StringRef, StringRef>> ChildBufferInfos; 289360784Sdim 290360784Sdim for (const auto &KV : Symbols) { 291360784Sdim const auto &Name = KV.first; 292360784Sdim auto Child = Archive->findSym(*Name); 293360784Sdim if (!Child) 294360784Sdim return Child.takeError(); 295360784Sdim if (*Child == None) 296360784Sdim continue; 297360784Sdim auto ChildBuffer = (*Child)->getMemoryBufferRef(); 298360784Sdim if (!ChildBuffer) 299360784Sdim return ChildBuffer.takeError(); 300360784Sdim ChildBufferInfos.insert( 301360784Sdim {ChildBuffer->getBuffer(), ChildBuffer->getBufferIdentifier()}); 302360784Sdim } 303360784Sdim 304360784Sdim for (auto ChildBufferInfo : ChildBufferInfos) { 305360784Sdim MemoryBufferRef ChildBufferRef(ChildBufferInfo.first, 306360784Sdim ChildBufferInfo.second); 307360784Sdim 308360784Sdim if (auto Err = 309360784Sdim L.add(JD, MemoryBuffer::getMemBuffer(ChildBufferRef), VModuleKey())) 310360784Sdim return Err; 311360784Sdim } 312360784Sdim 313360784Sdim return Error::success(); 314360784Sdim} 315360784Sdim 316360784SdimStaticLibraryDefinitionGenerator::StaticLibraryDefinitionGenerator( 317360784Sdim ObjectLayer &L, std::unique_ptr<MemoryBuffer> ArchiveBuffer, Error &Err) 318360784Sdim : L(L), ArchiveBuffer(std::move(ArchiveBuffer)), 319360784Sdim Archive(std::make_unique<object::Archive>(*this->ArchiveBuffer, Err)) {} 320360784Sdim 321283625Sdim} // End namespace orc. 322283625Sdim} // End namespace llvm. 323