/************************************************************************** * * Copyright 2010 VMware, Inc. * All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sub license, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE * USE OR OTHER DEALINGS IN THE SOFTWARE. * * The above copyright notice and this permission notice (including the * next paragraph) shall be included in all copies or substantial portions * of the Software. * **************************************************************************/ /** * The purpose of this module is to expose LLVM functionality not available * through the C++ bindings. */ // Undef these vars just to silence warnings #undef PACKAGE_BUGREPORT #undef PACKAGE_NAME #undef PACKAGE_STRING #undef PACKAGE_TARNAME #undef PACKAGE_VERSION #include // Workaround http://llvm.org/PR23628 #if HAVE_LLVM >= 0x0307 # pragma push_macro("DEBUG") # undef DEBUG #endif #include #if HAVE_LLVM >= 0x0306 #include #endif #include #include #include #include #if HAVE_LLVM >= 0x0307 #include #else #include #endif #if HAVE_LLVM < 0x0306 #include #else #include #endif #include #include #include #include #if HAVE_LLVM >= 0x0305 #include #endif #include #include #include #include #if LLVM_USE_INTEL_JITEVENTS #include #endif // Workaround http://llvm.org/PR23628 #if HAVE_LLVM >= 0x0307 # pragma pop_macro("DEBUG") #endif #include "c11/threads.h" #include "os/os_thread.h" #include "pipe/p_config.h" #include "util/u_debug.h" #include "util/u_cpu_detect.h" #include "lp_bld_misc.h" #include "lp_bld_debug.h" namespace { class LLVMEnsureMultithreaded { public: LLVMEnsureMultithreaded() { if (!LLVMIsMultithreaded()) { LLVMStartMultithreaded(); } } }; static LLVMEnsureMultithreaded lLVMEnsureMultithreaded; } static once_flag init_native_targets_once_flag = ONCE_FLAG_INIT; static void init_native_targets() { // If we have a native target, initialize it to ensure it is linked in and // usable by the JIT. llvm::InitializeNativeTarget(); llvm::InitializeNativeTargetAsmPrinter(); llvm::InitializeNativeTargetDisassembler(); #if DEBUG && HAVE_LLVM >= 0x0306 { char *env_llc_options = getenv("GALLIVM_LLC_OPTIONS"); if (env_llc_options) { char *option; char *options[64] = {(char *) "llc"}; // Warning without cast int n; for (n = 0, option = strtok(env_llc_options, " "); option; n++, option = strtok(NULL, " ")) { options[n + 1] = option; } if (gallivm_debug & (GALLIVM_DEBUG_IR | GALLIVM_DEBUG_ASM | GALLIVM_DEBUG_DUMP_BC)) { debug_printf("llc additional options (%d):\n", n); for (int i = 1; i <= n; i++) debug_printf("\t%s\n", options[i]); debug_printf("\n"); } LLVMParseCommandLineOptions(n + 1, options, NULL); } } #endif } extern "C" void lp_set_target_options(void) { #if HAVE_LLVM < 0x0304 /* * By default LLVM adds a signal handler to output a pretty stack trace. * This signal handler is never removed, causing problems when unloading the * shared object where the gallium driver resides. */ llvm::DisablePrettyStackTrace = true; #endif /* The llvm target registry is not thread-safe, so drivers and state-trackers * that want to initialize targets should use the lp_set_target_options() * function to safely initialize targets. * * LLVM targets should be initialized before the driver or state-tracker tries * to access the registry. */ call_once(&init_native_targets_once_flag, init_native_targets); } extern "C" LLVMTargetLibraryInfoRef gallivm_create_target_library_info(const char *triple) { return reinterpret_cast( #if HAVE_LLVM < 0x0307 new llvm::TargetLibraryInfo( #else new llvm::TargetLibraryInfoImpl( #endif llvm::Triple(triple))); } extern "C" void gallivm_dispose_target_library_info(LLVMTargetLibraryInfoRef library_info) { delete reinterpret_cast< #if HAVE_LLVM < 0x0307 llvm::TargetLibraryInfo #else llvm::TargetLibraryInfoImpl #endif *>(library_info); } #if HAVE_LLVM < 0x0304 extern "C" void LLVMSetAlignmentBackport(LLVMValueRef V, unsigned Bytes) { switch (LLVMGetInstructionOpcode(V)) { case LLVMLoad: llvm::unwrap(V)->setAlignment(Bytes); break; case LLVMStore: llvm::unwrap(V)->setAlignment(Bytes); break; default: assert(0); break; } } #endif #if HAVE_LLVM < 0x0306 typedef llvm::JITMemoryManager BaseMemoryManager; #else typedef llvm::RTDyldMemoryManager BaseMemoryManager; #endif /* * Delegating is tedious but the default manager class is hidden in an * anonymous namespace in LLVM, so we cannot just derive from it to change * its behavior. */ class DelegatingJITMemoryManager : public BaseMemoryManager { protected: virtual BaseMemoryManager *mgr() const = 0; public: #if HAVE_LLVM < 0x0306 /* * From JITMemoryManager */ virtual void setMemoryWritable() { mgr()->setMemoryWritable(); } virtual void setMemoryExecutable() { mgr()->setMemoryExecutable(); } virtual void setPoisonMemory(bool poison) { mgr()->setPoisonMemory(poison); } virtual void AllocateGOT() { mgr()->AllocateGOT(); /* * isManagingGOT() is not virtual in base class so we can't delegate. * Instead we mirror the value of HasGOT in our instance. */ HasGOT = mgr()->isManagingGOT(); } virtual uint8_t *getGOTBase() const { return mgr()->getGOTBase(); } virtual uint8_t *startFunctionBody(const llvm::Function *F, uintptr_t &ActualSize) { return mgr()->startFunctionBody(F, ActualSize); } virtual uint8_t *allocateStub(const llvm::GlobalValue *F, unsigned StubSize, unsigned Alignment) { return mgr()->allocateStub(F, StubSize, Alignment); } virtual void endFunctionBody(const llvm::Function *F, uint8_t *FunctionStart, uint8_t *FunctionEnd) { mgr()->endFunctionBody(F, FunctionStart, FunctionEnd); } virtual uint8_t *allocateSpace(intptr_t Size, unsigned Alignment) { return mgr()->allocateSpace(Size, Alignment); } virtual uint8_t *allocateGlobal(uintptr_t Size, unsigned Alignment) { return mgr()->allocateGlobal(Size, Alignment); } virtual void deallocateFunctionBody(void *Body) { mgr()->deallocateFunctionBody(Body); } #if HAVE_LLVM < 0x0304 virtual uint8_t *startExceptionTable(const llvm::Function *F, uintptr_t &ActualSize) { return mgr()->startExceptionTable(F, ActualSize); } virtual void endExceptionTable(const llvm::Function *F, uint8_t *TableStart, uint8_t *TableEnd, uint8_t *FrameRegister) { mgr()->endExceptionTable(F, TableStart, TableEnd, FrameRegister); } virtual void deallocateExceptionTable(void *ET) { mgr()->deallocateExceptionTable(ET); } #endif virtual bool CheckInvariants(std::string &s) { return mgr()->CheckInvariants(s); } virtual size_t GetDefaultCodeSlabSize() { return mgr()->GetDefaultCodeSlabSize(); } virtual size_t GetDefaultDataSlabSize() { return mgr()->GetDefaultDataSlabSize(); } virtual size_t GetDefaultStubSlabSize() { return mgr()->GetDefaultStubSlabSize(); } virtual unsigned GetNumCodeSlabs() { return mgr()->GetNumCodeSlabs(); } virtual unsigned GetNumDataSlabs() { return mgr()->GetNumDataSlabs(); } virtual unsigned GetNumStubSlabs() { return mgr()->GetNumStubSlabs(); } #endif /* * From RTDyldMemoryManager */ #if HAVE_LLVM >= 0x0304 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment, unsigned SectionID, llvm::StringRef SectionName) { return mgr()->allocateCodeSection(Size, Alignment, SectionID, SectionName); } #else virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment, unsigned SectionID) { return mgr()->allocateCodeSection(Size, Alignment, SectionID); } #endif virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment, unsigned SectionID, #if HAVE_LLVM >= 0x0304 llvm::StringRef SectionName, #endif bool IsReadOnly) { return mgr()->allocateDataSection(Size, Alignment, SectionID, #if HAVE_LLVM >= 0x0304 SectionName, #endif IsReadOnly); } #if HAVE_LLVM >= 0x0304 virtual void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr, size_t Size) { mgr()->registerEHFrames(Addr, LoadAddr, Size); } #else virtual void registerEHFrames(llvm::StringRef SectionData) { mgr()->registerEHFrames(SectionData); } #endif #if HAVE_LLVM >= 0x0500 virtual void deregisterEHFrames() { mgr()->deregisterEHFrames(); } #elif HAVE_LLVM >= 0x0304 virtual void deregisterEHFrames(uint8_t *Addr, uint64_t LoadAddr, size_t Size) { mgr()->deregisterEHFrames(Addr, LoadAddr, Size); } #endif virtual void *getPointerToNamedFunction(const std::string &Name, bool AbortOnFailure=true) { return mgr()->getPointerToNamedFunction(Name, AbortOnFailure); } #if HAVE_LLVM <= 0x0303 virtual bool applyPermissions(std::string *ErrMsg = 0) { return mgr()->applyPermissions(ErrMsg); } #else virtual bool finalizeMemory(std::string *ErrMsg = 0) { return mgr()->finalizeMemory(ErrMsg); } #endif }; /* * Delegate memory management to one shared manager for more efficient use * of memory than creating a separate pool for each LLVM engine. * Keep generated code until freeGeneratedCode() is called, instead of when * memory manager is destroyed, which happens during engine destruction. * This allows additional memory savings as we don't have to keep the engine * around in order to use the code. * All methods are delegated to the shared manager except destruction and * deallocating code. For the latter we just remember what needs to be * deallocated later. The shared manager is deleted once it is empty. */ class ShaderMemoryManager : public DelegatingJITMemoryManager { BaseMemoryManager *TheMM; struct GeneratedCode { typedef std::vector Vec; Vec FunctionBody, ExceptionTable; BaseMemoryManager *TheMM; GeneratedCode(BaseMemoryManager *MM) { TheMM = MM; } ~GeneratedCode() { /* * Deallocate things as previously requested and * free shared manager when no longer used. */ #if HAVE_LLVM < 0x0306 Vec::iterator i; assert(TheMM); for ( i = FunctionBody.begin(); i != FunctionBody.end(); ++i ) TheMM->deallocateFunctionBody(*i); #if HAVE_LLVM < 0x0304 for ( i = ExceptionTable.begin(); i != ExceptionTable.end(); ++i ) TheMM->deallocateExceptionTable(*i); #endif /* HAVE_LLVM < 0x0304 */ #endif /* HAVE_LLVM < 0x0306 */ } }; GeneratedCode *code; BaseMemoryManager *mgr() const { return TheMM; } public: ShaderMemoryManager(BaseMemoryManager* MM) { TheMM = MM; code = new GeneratedCode(MM); } virtual ~ShaderMemoryManager() { /* * 'code' is purposely not deleted. It is the user's responsibility * to call getGeneratedCode() and freeGeneratedCode(). */ } struct lp_generated_code *getGeneratedCode() { return (struct lp_generated_code *) code; } static void freeGeneratedCode(struct lp_generated_code *code) { delete (GeneratedCode *) code; } #if HAVE_LLVM < 0x0304 virtual void deallocateExceptionTable(void *ET) { // remember for later deallocation code->ExceptionTable.push_back(ET); } #endif virtual void deallocateFunctionBody(void *Body) { // remember for later deallocation code->FunctionBody.push_back(Body); } }; /** * Same as LLVMCreateJITCompilerForModule, but: * - allows using MCJIT and enabling AVX feature where available. * - set target options * * See also: * - llvm/lib/ExecutionEngine/ExecutionEngineBindings.cpp * - llvm/tools/lli/lli.cpp * - http://markmail.org/message/ttkuhvgj4cxxy2on#query:+page:1+mid:aju2dggerju3ivd3+state:results */ extern "C" LLVMBool lp_build_create_jit_compiler_for_module(LLVMExecutionEngineRef *OutJIT, lp_generated_code **OutCode, LLVMModuleRef M, LLVMMCJITMemoryManagerRef CMM, unsigned OptLevel, int useMCJIT, char **OutError) { using namespace llvm; std::string Error; #if HAVE_LLVM >= 0x0306 EngineBuilder builder(std::unique_ptr(unwrap(M))); #else EngineBuilder builder(unwrap(M)); #endif /** * LLVM 3.1+ haven't more "extern unsigned llvm::StackAlignmentOverride" and * friends for configuring code generation options, like stack alignment. */ TargetOptions options; #if defined(PIPE_ARCH_X86) options.StackAlignmentOverride = 4; #if HAVE_LLVM < 0x0304 options.RealignStack = true; #endif #endif #if defined(DEBUG) && HAVE_LLVM < 0x0307 options.JITEmitDebugInfo = true; #endif /* XXX: Workaround http://llvm.org/PR21435 */ #if defined(DEBUG) || defined(PROFILE) || \ (HAVE_LLVM >= 0x0303 && (defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64))) #if HAVE_LLVM < 0x0304 options.NoFramePointerElimNonLeaf = true; #endif #if HAVE_LLVM < 0x0307 options.NoFramePointerElim = true; #endif #endif builder.setEngineKind(EngineKind::JIT) .setErrorStr(&Error) .setTargetOptions(options) .setOptLevel((CodeGenOpt::Level)OptLevel); if (useMCJIT) { #if HAVE_LLVM < 0x0306 builder.setUseMCJIT(true); #endif #ifdef _WIN32 /* * MCJIT works on Windows, but currently only through ELF object format. * * XXX: We could use `LLVM_HOST_TRIPLE "-elf"` but LLVM_HOST_TRIPLE has * different strings for MinGW/MSVC, so better play it safe and be * explicit. */ # ifdef _WIN64 LLVMSetTarget(M, "x86_64-pc-win32-elf"); # else LLVMSetTarget(M, "i686-pc-win32-elf"); # endif #endif } llvm::SmallVector MAttrs; #if defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64) #if HAVE_LLVM >= 0x0400 /* llvm-3.7+ implements sys::getHostCPUFeatures for x86, * which allows us to enable/disable code generation based * on the results of cpuid. */ llvm::StringMap features; llvm::sys::getHostCPUFeatures(features); for (StringMapIterator f = features.begin(); f != features.end(); ++f) { MAttrs.push_back(((*f).second ? "+" : "-") + (*f).first().str()); } #else /* * We need to unset attributes because sometimes LLVM mistakenly assumes * certain features are present given the processor name. * * https://bugs.freedesktop.org/show_bug.cgi?id=92214 * http://llvm.org/PR25021 * http://llvm.org/PR19429 * http://llvm.org/PR16721 */ MAttrs.push_back(util_cpu_caps.has_sse ? "+sse" : "-sse" ); MAttrs.push_back(util_cpu_caps.has_sse2 ? "+sse2" : "-sse2" ); MAttrs.push_back(util_cpu_caps.has_sse3 ? "+sse3" : "-sse3" ); MAttrs.push_back(util_cpu_caps.has_ssse3 ? "+ssse3" : "-ssse3" ); #if HAVE_LLVM >= 0x0304 MAttrs.push_back(util_cpu_caps.has_sse4_1 ? "+sse4.1" : "-sse4.1"); #else MAttrs.push_back(util_cpu_caps.has_sse4_1 ? "+sse41" : "-sse41" ); #endif #if HAVE_LLVM >= 0x0304 MAttrs.push_back(util_cpu_caps.has_sse4_2 ? "+sse4.2" : "-sse4.2"); #else MAttrs.push_back(util_cpu_caps.has_sse4_2 ? "+sse42" : "-sse42" ); #endif /* * AVX feature is not automatically detected from CPUID by the X86 target * yet, because the old (yet default) JIT engine is not capable of * emitting the opcodes. On newer llvm versions it is and at least some * versions (tested with 3.3) will emit avx opcodes without this anyway. */ MAttrs.push_back(util_cpu_caps.has_avx ? "+avx" : "-avx"); MAttrs.push_back(util_cpu_caps.has_f16c ? "+f16c" : "-f16c"); if (HAVE_LLVM >= 0x0304) { MAttrs.push_back(util_cpu_caps.has_fma ? "+fma" : "-fma"); } else { /* * The old JIT in LLVM 3.3 has a bug encoding llvm.fmuladd.f32 and * llvm.fmuladd.v2f32 intrinsics when FMA is available. */ MAttrs.push_back("-fma"); } MAttrs.push_back(util_cpu_caps.has_avx2 ? "+avx2" : "-avx2"); /* disable avx512 and all subvariants */ #if HAVE_LLVM >= 0x0304 MAttrs.push_back("-avx512cd"); MAttrs.push_back("-avx512er"); MAttrs.push_back("-avx512f"); MAttrs.push_back("-avx512pf"); #endif #if HAVE_LLVM >= 0x0305 MAttrs.push_back("-avx512bw"); MAttrs.push_back("-avx512dq"); MAttrs.push_back("-avx512vl"); #endif #endif #endif #if defined(PIPE_ARCH_PPC) MAttrs.push_back(util_cpu_caps.has_altivec ? "+altivec" : "-altivec"); #if (HAVE_LLVM >= 0x0304) #if (HAVE_LLVM < 0x0400) /* * Make sure VSX instructions are disabled * See LLVM bugs: * https://llvm.org/bugs/show_bug.cgi?id=25503#c7 (fixed in 3.8.1) * https://llvm.org/bugs/show_bug.cgi?id=26775 (fixed in 3.8.1) * https://llvm.org/bugs/show_bug.cgi?id=33531 (fixed in 4.0) * https://llvm.org/bugs/show_bug.cgi?id=34647 (llc performance on certain unusual shader IR; intro'd in 4.0, pending as of 5.0) */ if (util_cpu_caps.has_altivec) { MAttrs.push_back("-vsx"); } #else /* * Bug 25503 is fixed, by the same fix that fixed * bug 26775, in versions of LLVM later than 3.8 (starting with 3.8.1). * BZ 33531 actually comprises more than one bug, all of * which are fixed in LLVM 4.0. * * With LLVM 4.0 or higher: * Make sure VSX instructions are ENABLED, unless * a) the entire -mattr option is overridden via GALLIVM_MATTRS, or * b) VSX instructions are explicitly enabled/disabled via GALLIVM_VSX=1 or 0. */ if (util_cpu_caps.has_altivec) { char *env_mattrs = getenv("GALLIVM_MATTRS"); if (env_mattrs) { MAttrs.push_back(env_mattrs); } else { boolean enable_vsx = true; char *env_vsx = getenv("GALLIVM_VSX"); if (env_vsx && env_vsx[0] == '0') { enable_vsx = false; } if (enable_vsx) MAttrs.push_back("+vsx"); else MAttrs.push_back("-vsx"); } } #endif #endif #endif builder.setMAttrs(MAttrs); if (gallivm_debug & (GALLIVM_DEBUG_IR | GALLIVM_DEBUG_ASM | GALLIVM_DEBUG_DUMP_BC)) { int n = MAttrs.size(); if (n > 0) { debug_printf("llc -mattr option(s): "); for (int i = 0; i < n; i++) debug_printf("%s%s", MAttrs[i].c_str(), (i < n - 1) ? "," : ""); debug_printf("\n"); } } #if HAVE_LLVM >= 0x0305 StringRef MCPU = llvm::sys::getHostCPUName(); /* * The cpu bits are no longer set automatically, so need to set mcpu manually. * Note that the MAttrs set above will be sort of ignored (since we should * not set any which would not be set by specifying the cpu anyway). * It ought to be safe though since getHostCPUName() should include bits * not only from the cpu but environment as well (for instance if it's safe * to use avx instructions which need OS support). According to * http://llvm.org/bugs/show_bug.cgi?id=19429 however if I understand this * right it may be necessary to specify older cpu (or disable mattrs) though * when not using MCJIT so no instructions are generated which the old JIT * can't handle. Not entirely sure if we really need to do anything yet. */ #if defined(PIPE_ARCH_LITTLE_ENDIAN) && defined(PIPE_ARCH_PPC_64) /* * Versions of LLVM prior to 4.0 lacked a table entry for "POWER8NVL", * resulting in (big-endian) "generic" being returned on * little-endian Power8NVL systems. The result was that code that * attempted to load the least significant 32 bits of a 64-bit quantity * from memory loaded the wrong half. This resulted in failures in some * Piglit tests, e.g. * .../arb_gpu_shader_fp64/execution/conversion/frag-conversion-explicit-double-uint */ if (MCPU == "generic") MCPU = "pwr8"; #endif builder.setMCPU(MCPU); if (gallivm_debug & (GALLIVM_DEBUG_IR | GALLIVM_DEBUG_ASM | GALLIVM_DEBUG_DUMP_BC)) { debug_printf("llc -mcpu option: %s\n", MCPU.str().c_str()); } #endif ShaderMemoryManager *MM = NULL; if (useMCJIT) { BaseMemoryManager* JMM = reinterpret_cast(CMM); MM = new ShaderMemoryManager(JMM); *OutCode = MM->getGeneratedCode(); #if HAVE_LLVM >= 0x0306 builder.setMCJITMemoryManager(std::unique_ptr(MM)); MM = NULL; // ownership taken by std::unique_ptr #elif HAVE_LLVM > 0x0303 builder.setMCJITMemoryManager(MM); #else builder.setJITMemoryManager(MM); #endif } else { #if HAVE_LLVM < 0x0306 BaseMemoryManager* JMM = reinterpret_cast(CMM); MM = new ShaderMemoryManager(JMM); *OutCode = MM->getGeneratedCode(); builder.setJITMemoryManager(MM); #else assert(0); #endif } ExecutionEngine *JIT; JIT = builder.create(); #if LLVM_USE_INTEL_JITEVENTS JITEventListener *JEL = JITEventListener::createIntelJITEventListener(); JIT->RegisterJITEventListener(JEL); #endif if (JIT) { *OutJIT = wrap(JIT); return 0; } lp_free_generated_code(*OutCode); *OutCode = 0; delete MM; *OutError = strdup(Error.c_str()); return 1; } extern "C" void lp_free_generated_code(struct lp_generated_code *code) { ShaderMemoryManager::freeGeneratedCode(code); } extern "C" LLVMMCJITMemoryManagerRef lp_get_default_memory_manager() { BaseMemoryManager *mm; #if HAVE_LLVM < 0x0306 mm = llvm::JITMemoryManager::CreateDefaultMemManager(); #else mm = new llvm::SectionMemoryManager(); #endif return reinterpret_cast(mm); } extern "C" void lp_free_memory_manager(LLVMMCJITMemoryManagerRef memorymgr) { delete reinterpret_cast(memorymgr); } extern "C" LLVMValueRef lp_get_called_value(LLVMValueRef call) { #if HAVE_LLVM >= 0x0309 return LLVMGetCalledValue(call); #elif HAVE_LLVM >= 0x0305 return llvm::wrap(llvm::CallSite(llvm::unwrap(call)).getCalledValue()); #else return NULL; /* radeonsi doesn't support so old LLVM. */ #endif } extern "C" bool lp_is_function(LLVMValueRef v) { #if HAVE_LLVM >= 0x0309 return LLVMGetValueKind(v) == LLVMFunctionValueKind; #else return llvm::isa(llvm::unwrap(v)); #endif }