diff --git a/llvm/include/llvm-c/Error.h b/llvm/include/llvm-c/Error.h index 00714ec950ea..6a5ba877eb74 100644 --- a/llvm/include/llvm-c/Error.h +++ b/llvm/include/llvm-c/Error.h @@ -18,6 +18,8 @@ extern "C" { #endif +#define LLVMErrorSuccess 0 + /** * Opaque reference to an error instance. Null serves as the 'success' value. */ diff --git a/llvm/include/llvm-c/OrcBindings.h b/llvm/include/llvm-c/OrcBindings.h index 9497f0d40776..570db87fee94 100644 --- a/llvm/include/llvm-c/OrcBindings.h +++ b/llvm/include/llvm-c/OrcBindings.h @@ -22,6 +22,7 @@ #ifndef LLVM_C_ORCBINDINGS_H #define LLVM_C_ORCBINDINGS_H +#include "llvm-c/Error.h" #include "llvm-c/Object.h" #include "llvm-c/TargetMachine.h" @@ -36,8 +37,6 @@ typedef uint64_t (*LLVMOrcSymbolResolverFn)(const char *Name, void *LookupCtx); typedef uint64_t (*LLVMOrcLazyCompileCallbackFn)(LLVMOrcJITStackRef JITStack, void *CallbackCtx); -typedef enum { LLVMOrcErrSuccess = 0, LLVMOrcErrGeneric } LLVMOrcErrorCode; - /** * Create an ORC JIT stack. * @@ -72,43 +71,41 @@ void LLVMOrcDisposeMangledSymbol(char *MangledSymbol); /** * Create a lazy compile callback. */ -LLVMOrcErrorCode -LLVMOrcCreateLazyCompileCallback(LLVMOrcJITStackRef JITStack, - LLVMOrcTargetAddress *RetAddr, - LLVMOrcLazyCompileCallbackFn Callback, - void *CallbackCtx); +LLVMErrorRef LLVMOrcCreateLazyCompileCallback( + LLVMOrcJITStackRef JITStack, LLVMOrcTargetAddress *RetAddr, + LLVMOrcLazyCompileCallbackFn Callback, void *CallbackCtx); /** * Create a named indirect call stub. */ -LLVMOrcErrorCode LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack, - const char *StubName, - LLVMOrcTargetAddress InitAddr); +LLVMErrorRef LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack, + const char *StubName, + LLVMOrcTargetAddress InitAddr); /** * Set the pointer for the given indirect stub. */ -LLVMOrcErrorCode LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack, - const char *StubName, - LLVMOrcTargetAddress NewAddr); +LLVMErrorRef LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack, + const char *StubName, + LLVMOrcTargetAddress NewAddr); /** * Add module to be eagerly compiled. */ -LLVMOrcErrorCode -LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle *RetHandle, LLVMModuleRef Mod, - LLVMOrcSymbolResolverFn SymbolResolver, - void *SymbolResolverCtx); +LLVMErrorRef LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle *RetHandle, + LLVMModuleRef Mod, + LLVMOrcSymbolResolverFn SymbolResolver, + void *SymbolResolverCtx); /** * Add module to be lazily compiled one function at a time. */ -LLVMOrcErrorCode -LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle *RetHandle, LLVMModuleRef Mod, - LLVMOrcSymbolResolverFn SymbolResolver, - void *SymbolResolverCtx); +LLVMErrorRef LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle *RetHandle, + LLVMModuleRef Mod, + LLVMOrcSymbolResolverFn SymbolResolver, + void *SymbolResolverCtx); /** * Add an object file. @@ -118,11 +115,11 @@ LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, * Clients should *not* dispose of the 'Obj' argument: the JIT will manage it * from this call onwards. */ -LLVMOrcErrorCode LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle *RetHandle, - LLVMMemoryBufferRef Obj, - LLVMOrcSymbolResolverFn SymbolResolver, - void *SymbolResolverCtx); +LLVMErrorRef LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle *RetHandle, + LLVMMemoryBufferRef Obj, + LLVMOrcSymbolResolverFn SymbolResolver, + void *SymbolResolverCtx); /** * Remove a module set from the JIT. @@ -130,29 +127,29 @@ LLVMOrcErrorCode LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, * This works for all modules that can be added via OrcAdd*, including object * files. */ -LLVMOrcErrorCode LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle H); +LLVMErrorRef LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle H); /** * Get symbol address from JIT instance. */ -LLVMOrcErrorCode LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack, - LLVMOrcTargetAddress *RetAddr, - const char *SymbolName); +LLVMErrorRef LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack, + LLVMOrcTargetAddress *RetAddr, + const char *SymbolName); /** * Get symbol address from JIT instance, searching only the specified * handle. */ -LLVMOrcErrorCode LLVMOrcGetSymbolAddressIn(LLVMOrcJITStackRef JITStack, - LLVMOrcTargetAddress *RetAddr, - LLVMOrcModuleHandle H, - const char *SymbolName); +LLVMErrorRef LLVMOrcGetSymbolAddressIn(LLVMOrcJITStackRef JITStack, + LLVMOrcTargetAddress *RetAddr, + LLVMOrcModuleHandle H, + const char *SymbolName); /** * Dispose of an ORC JIT stack. */ -LLVMOrcErrorCode LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack); +LLVMErrorRef LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack); /** * Register a JIT Event Listener. diff --git a/llvm/lib/ExecutionEngine/Orc/OrcCBindings.cpp b/llvm/lib/ExecutionEngine/Orc/OrcCBindings.cpp index d6005d24a648..6dea64a6e78f 100644 --- a/llvm/lib/ExecutionEngine/Orc/OrcCBindings.cpp +++ b/llvm/lib/ExecutionEngine/Orc/OrcCBindings.cpp @@ -42,89 +42,110 @@ void LLVMOrcGetMangledSymbol(LLVMOrcJITStackRef JITStack, char **MangledName, void LLVMOrcDisposeMangledSymbol(char *MangledName) { delete[] MangledName; } -LLVMOrcErrorCode -LLVMOrcCreateLazyCompileCallback(LLVMOrcJITStackRef JITStack, - LLVMOrcTargetAddress *RetAddr, - LLVMOrcLazyCompileCallbackFn Callback, - void *CallbackCtx) { +LLVMErrorRef LLVMOrcCreateLazyCompileCallback( + LLVMOrcJITStackRef JITStack, LLVMOrcTargetAddress *RetAddr, + LLVMOrcLazyCompileCallbackFn Callback, void *CallbackCtx) { OrcCBindingsStack &J = *unwrap(JITStack); - return J.createLazyCompileCallback(*RetAddr, Callback, CallbackCtx); + if (auto Addr = J.createLazyCompileCallback(Callback, CallbackCtx)) { + *RetAddr = *Addr; + return LLVMErrorSuccess; + } else + return wrap(Addr.takeError()); } -LLVMOrcErrorCode LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack, +LLVMErrorRef LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack, + const char *StubName, + LLVMOrcTargetAddress InitAddr) { + OrcCBindingsStack &J = *unwrap(JITStack); + return wrap(J.createIndirectStub(StubName, InitAddr)); +} + +LLVMErrorRef LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack, const char *StubName, - LLVMOrcTargetAddress InitAddr) { + LLVMOrcTargetAddress NewAddr) { OrcCBindingsStack &J = *unwrap(JITStack); - return J.createIndirectStub(StubName, InitAddr); + return wrap(J.setIndirectStubPointer(StubName, NewAddr)); } -LLVMOrcErrorCode LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack, - const char *StubName, - LLVMOrcTargetAddress NewAddr) { - OrcCBindingsStack &J = *unwrap(JITStack); - return J.setIndirectStubPointer(StubName, NewAddr); -} - -LLVMOrcErrorCode -LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle *RetHandle, LLVMModuleRef Mod, - LLVMOrcSymbolResolverFn SymbolResolver, - void *SymbolResolverCtx) { +LLVMErrorRef LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle *RetHandle, + LLVMModuleRef Mod, + LLVMOrcSymbolResolverFn SymbolResolver, + void *SymbolResolverCtx) { OrcCBindingsStack &J = *unwrap(JITStack); std::unique_ptr M(unwrap(Mod)); - return J.addIRModuleEager(*RetHandle, std::move(M), SymbolResolver, - SymbolResolverCtx); + if (auto Handle = + J.addIRModuleEager(std::move(M), SymbolResolver, SymbolResolverCtx)) { + *RetHandle = *Handle; + return LLVMErrorSuccess; + } else + return wrap(Handle.takeError()); } -LLVMOrcErrorCode -LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle *RetHandle, LLVMModuleRef Mod, - LLVMOrcSymbolResolverFn SymbolResolver, - void *SymbolResolverCtx) { +LLVMErrorRef LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle *RetHandle, + LLVMModuleRef Mod, + LLVMOrcSymbolResolverFn SymbolResolver, + void *SymbolResolverCtx) { OrcCBindingsStack &J = *unwrap(JITStack); std::unique_ptr M(unwrap(Mod)); - return J.addIRModuleLazy(*RetHandle, std::move(M), SymbolResolver, - SymbolResolverCtx); + if (auto Handle = + J.addIRModuleLazy(std::move(M), SymbolResolver, SymbolResolverCtx)) { + *RetHandle = *Handle; + return LLVMErrorSuccess; + } else + return wrap(Handle.takeError()); } -LLVMOrcErrorCode -LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle *RetHandle, - LLVMMemoryBufferRef Obj, - LLVMOrcSymbolResolverFn SymbolResolver, - void *SymbolResolverCtx) { +LLVMErrorRef LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle *RetHandle, + LLVMMemoryBufferRef Obj, + LLVMOrcSymbolResolverFn SymbolResolver, + void *SymbolResolverCtx) { OrcCBindingsStack &J = *unwrap(JITStack); std::unique_ptr O(unwrap(Obj)); - return J.addObject(*RetHandle, std::move(O), SymbolResolver, - SymbolResolverCtx); + if (auto Handle = + J.addObject(std::move(O), SymbolResolver, SymbolResolverCtx)) { + *RetHandle = *Handle; + return LLVMErrorSuccess; + } else + return wrap(Handle.takeError()); } -LLVMOrcErrorCode LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack, - LLVMOrcModuleHandle H) { +LLVMErrorRef LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack, + LLVMOrcModuleHandle H) { OrcCBindingsStack &J = *unwrap(JITStack); - return J.removeModule(H); + return wrap(J.removeModule(H)); } -LLVMOrcErrorCode LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack, - LLVMOrcTargetAddress *RetAddr, - const char *SymbolName) { +LLVMErrorRef LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack, + LLVMOrcTargetAddress *RetAddr, + const char *SymbolName) { OrcCBindingsStack &J = *unwrap(JITStack); - return J.findSymbolAddress(*RetAddr, SymbolName, true); + if (auto Addr = J.findSymbolAddress(SymbolName, true)) { + *RetAddr = *Addr; + return LLVMErrorSuccess; + } else + return wrap(Addr.takeError()); } -LLVMOrcErrorCode LLVMOrcGetSymbolAddressIn(LLVMOrcJITStackRef JITStack, - LLVMOrcTargetAddress *RetAddr, - LLVMOrcModuleHandle H, - const char *SymbolName) { +LLVMErrorRef LLVMOrcGetSymbolAddressIn(LLVMOrcJITStackRef JITStack, + LLVMOrcTargetAddress *RetAddr, + LLVMOrcModuleHandle H, + const char *SymbolName) { OrcCBindingsStack &J = *unwrap(JITStack); - return J.findSymbolAddressIn(*RetAddr, H, SymbolName, true); + if (auto Addr = J.findSymbolAddressIn(H, SymbolName, true)) { + *RetAddr = *Addr; + return LLVMErrorSuccess; + } else + return wrap(Addr.takeError()); } -LLVMOrcErrorCode LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack) { +LLVMErrorRef LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack) { auto *J = unwrap(JITStack); auto Err = J->shutdown(); delete J; - return Err; + return wrap(std::move(Err)); } void LLVMOrcRegisterJITEventListener(LLVMOrcJITStackRef JITStack, LLVMJITEventListenerRef L) diff --git a/llvm/lib/ExecutionEngine/Orc/OrcCBindingsStack.h b/llvm/lib/ExecutionEngine/Orc/OrcCBindingsStack.h index a67215f659ae..d59030abab30 100644 --- a/llvm/lib/ExecutionEngine/Orc/OrcCBindingsStack.h +++ b/llvm/lib/ExecutionEngine/Orc/OrcCBindingsStack.h @@ -244,14 +244,14 @@ public: CXXRuntimeOverrides( [this](const std::string &S) { return mangle(S); }) {} - LLVMOrcErrorCode shutdown() { + Error shutdown() { // Run any destructors registered with __cxa_atexit. CXXRuntimeOverrides.runDestructors(); // Run any IR destructors. for (auto &DtorRunner : IRStaticDestructorRunners) if (auto Err = DtorRunner.runViaLayer(*this)) - return mapError(std::move(Err)); - return LLVMOrcErrSuccess; + return Err; + return Error::success(); } std::string mangle(StringRef Name) { @@ -268,35 +268,27 @@ public: return reinterpret_cast(static_cast(Addr)); } - - LLVMOrcErrorCode - createLazyCompileCallback(JITTargetAddress &RetAddr, - LLVMOrcLazyCompileCallbackFn Callback, + Expected + createLazyCompileCallback(LLVMOrcLazyCompileCallbackFn Callback, void *CallbackCtx) { auto WrappedCallback = [=]() -> JITTargetAddress { return Callback(wrap(this), CallbackCtx); }; - if (auto CCAddr = CCMgr->getCompileCallback(std::move(WrappedCallback))) { - RetAddr = *CCAddr; - return LLVMOrcErrSuccess; - } else - return mapError(CCAddr.takeError()); + return CCMgr->getCompileCallback(std::move(WrappedCallback)); } - LLVMOrcErrorCode createIndirectStub(StringRef StubName, - JITTargetAddress Addr) { - return mapError( - IndirectStubsMgr->createStub(StubName, Addr, JITSymbolFlags::Exported)); + Error createIndirectStub(StringRef StubName, JITTargetAddress Addr) { + return IndirectStubsMgr->createStub(StubName, Addr, + JITSymbolFlags::Exported); } - LLVMOrcErrorCode setIndirectStubPointer(StringRef Name, - JITTargetAddress Addr) { - return mapError(IndirectStubsMgr->updatePointer(Name, Addr)); + Error setIndirectStubPointer(StringRef Name, JITTargetAddress Addr) { + return IndirectStubsMgr->updatePointer(Name, Addr); } template - LLVMOrcErrorCode - addIRModule(orc::VModuleKey &RetKey, LayerT &Layer, std::unique_ptr M, + Expected + addIRModule(LayerT &Layer, std::unique_ptr M, std::unique_ptr MemMgr, LLVMOrcSymbolResolverFn ExternalResolver, void *ExternalResolverCtx) { @@ -314,72 +306,70 @@ public: DtorNames.push_back(mangle(Dtor.Func->getName())); // Add the module to the JIT. - RetKey = ES.allocateVModule(); - Resolvers[RetKey] = std::make_shared( - *this, ExternalResolver, ExternalResolverCtx); - if (auto Err = Layer.addModule(RetKey, std::move(M))) - return mapError(std::move(Err)); + auto K = ES.allocateVModule(); + Resolvers[K] = std::make_shared(*this, ExternalResolver, + ExternalResolverCtx); + if (auto Err = Layer.addModule(K, std::move(M))) + return std::move(Err); - KeyLayers[RetKey] = detail::createGenericLayer(Layer); + KeyLayers[K] = detail::createGenericLayer(Layer); // Run the static constructors, and save the static destructor runner for // execution when the JIT is torn down. - orc::CtorDtorRunner CtorRunner(std::move(CtorNames), - RetKey); + orc::CtorDtorRunner CtorRunner(std::move(CtorNames), K); if (auto Err = CtorRunner.runViaLayer(*this)) - return mapError(std::move(Err)); + return std::move(Err); - IRStaticDestructorRunners.emplace_back(std::move(DtorNames), RetKey); + IRStaticDestructorRunners.emplace_back(std::move(DtorNames), K); - return LLVMOrcErrSuccess; + return K; } - LLVMOrcErrorCode addIRModuleEager(orc::VModuleKey &RetKey, - std::unique_ptr M, - LLVMOrcSymbolResolverFn ExternalResolver, - void *ExternalResolverCtx) { - return addIRModule(RetKey, CompileLayer, std::move(M), + Expected + addIRModuleEager(std::unique_ptr M, + LLVMOrcSymbolResolverFn ExternalResolver, + void *ExternalResolverCtx) { + return addIRModule(CompileLayer, std::move(M), llvm::make_unique(), std::move(ExternalResolver), ExternalResolverCtx); } - LLVMOrcErrorCode addIRModuleLazy(orc::VModuleKey &RetKey, - std::unique_ptr M, - LLVMOrcSymbolResolverFn ExternalResolver, - void *ExternalResolverCtx) { - return addIRModule(RetKey, CODLayer, std::move(M), + Expected + addIRModuleLazy(std::unique_ptr M, + LLVMOrcSymbolResolverFn ExternalResolver, + void *ExternalResolverCtx) { + return addIRModule(CODLayer, std::move(M), llvm::make_unique(), std::move(ExternalResolver), ExternalResolverCtx); } - LLVMOrcErrorCode removeModule(orc::VModuleKey K) { + Error removeModule(orc::VModuleKey K) { // FIXME: Should error release the module key? if (auto Err = KeyLayers[K]->removeModule(K)) - return mapError(std::move(Err)); + return Err; ES.releaseVModule(K); KeyLayers.erase(K); - return LLVMOrcErrSuccess; + return Error::success(); } - LLVMOrcErrorCode addObject(orc::VModuleKey &RetKey, - std::unique_ptr ObjBuffer, - LLVMOrcSymbolResolverFn ExternalResolver, - void *ExternalResolverCtx) { + Expected addObject(std::unique_ptr ObjBuffer, + LLVMOrcSymbolResolverFn ExternalResolver, + void *ExternalResolverCtx) { if (auto Obj = object::ObjectFile::createObjectFile( ObjBuffer->getMemBufferRef())) { - RetKey = ES.allocateVModule(); - Resolvers[RetKey] = std::make_shared( + auto K = ES.allocateVModule(); + Resolvers[K] = std::make_shared( *this, ExternalResolver, ExternalResolverCtx); - if (auto Err = ObjectLayer.addObject(RetKey, std::move(ObjBuffer))) - return mapError(std::move(Err)); + if (auto Err = ObjectLayer.addObject(K, std::move(ObjBuffer))) + return std::move(Err); - KeyLayers[RetKey] = detail::createGenericLayer(ObjectLayer); + KeyLayers[K] = detail::createGenericLayer(ObjectLayer); - return LLVMOrcErrSuccess; + return K; } else - return mapError(Obj.takeError()); + return Obj.takeError(); } JITSymbol findSymbol(const std::string &Name, @@ -395,45 +385,39 @@ public: return KeyLayers[K]->findSymbolIn(K, mangle(Name), ExportedSymbolsOnly); } - LLVMOrcErrorCode findSymbolAddress(JITTargetAddress &RetAddr, - const std::string &Name, - bool ExportedSymbolsOnly) { - RetAddr = 0; + Expected findSymbolAddress(const std::string &Name, + bool ExportedSymbolsOnly) { if (auto Sym = findSymbol(Name, ExportedSymbolsOnly)) { // Successful lookup, non-null symbol: - if (auto AddrOrErr = Sym.getAddress()) { - RetAddr = *AddrOrErr; - return LLVMOrcErrSuccess; - } else - return mapError(AddrOrErr.takeError()); + if (auto AddrOrErr = Sym.getAddress()) + return *AddrOrErr; + else + return AddrOrErr.takeError(); } else if (auto Err = Sym.takeError()) { // Lookup failure - report error. - return mapError(std::move(Err)); + return std::move(Err); } - // Otherwise we had a successful lookup but got a null result. We already - // set RetAddr to '0' above, so just return success. - return LLVMOrcErrSuccess; + + // No symbol not found. Return 0. + return 0; } - LLVMOrcErrorCode findSymbolAddressIn(JITTargetAddress &RetAddr, - orc::VModuleKey K, - const std::string &Name, - bool ExportedSymbolsOnly) { - RetAddr = 0; + Expected findSymbolAddressIn(orc::VModuleKey K, + const std::string &Name, + bool ExportedSymbolsOnly) { if (auto Sym = findSymbolIn(K, Name, ExportedSymbolsOnly)) { // Successful lookup, non-null symbol: - if (auto AddrOrErr = Sym.getAddress()) { - RetAddr = *AddrOrErr; - return LLVMOrcErrSuccess; - } else - return mapError(AddrOrErr.takeError()); + if (auto AddrOrErr = Sym.getAddress()) + return *AddrOrErr; + else + return AddrOrErr.takeError(); } else if (auto Err = Sym.takeError()) { // Lookup failure - report error. - return mapError(std::move(Err)); + return std::move(Err); } - // Otherwise we had a successful lookup but got a null result. We already - // set RetAddr to '0' above, so just return success. - return LLVMOrcErrSuccess; + + // Symbol not found. Return 0. + return 0; } const std::string &getErrorMessage() const { return ErrMsg; } @@ -457,18 +441,6 @@ public: private: - LLVMOrcErrorCode mapError(Error Err) { - LLVMOrcErrorCode Result = LLVMOrcErrSuccess; - handleAllErrors(std::move(Err), [&](ErrorInfoBase &EIB) { - // Handler of last resort. - Result = LLVMOrcErrGeneric; - ErrMsg = ""; - raw_string_ostream ErrStream(ErrMsg); - EIB.log(ErrStream); - }); - return Result; - } - void reportError(Error Err) { // FIXME: Report errors on the execution session. logAllUnhandledErrors(std::move(Err), errs(), "ORC error: ");