/************************************************************************** * * Copyright 2009 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 above copyright notice and this permission notice (including the * next paragraph) shall be included in all copies or substantial portions * of the Software. * * 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 VMWARE 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. * **************************************************************************/ #include "pipe/p_config.h" #include "pipe/p_compiler.h" #include "util/u_cpu_detect.h" #include "util/u_debug.h" #include "util/u_memory.h" #include "util/simple_list.h" #include "util/os_time.h" #include "lp_bld.h" #include "lp_bld_debug.h" #include "lp_bld_misc.h" #include "lp_bld_init.h" #include #include #include #if LLVM_VERSION_MAJOR >= 7 #include #endif #include #if GALLIVM_HAVE_CORO #if LLVM_VERSION_MAJOR <= 8 && (defined(PIPE_ARCH_AARCH64) || defined (PIPE_ARCH_ARM) || defined(PIPE_ARCH_S390) || defined(PIPE_ARCH_MIPS64)) #include #endif #include #endif unsigned gallivm_perf = 0; static const struct debug_named_value lp_bld_perf_flags[] = { { "brilinear", GALLIVM_PERF_BRILINEAR, "enable brilinear optimization" }, { "rho_approx", GALLIVM_PERF_RHO_APPROX, "enable rho_approx optimization" }, { "no_quad_lod", GALLIVM_PERF_NO_QUAD_LOD, "disable quad_lod optimization" }, { "no_aos_sampling", GALLIVM_PERF_NO_AOS_SAMPLING, "disable aos sampling optimization" }, { "nopt", GALLIVM_PERF_NO_OPT, "disable optimization passes to speed up shader compilation" }, DEBUG_NAMED_VALUE_END }; #ifdef DEBUG unsigned gallivm_debug = 0; static const struct debug_named_value lp_bld_debug_flags[] = { { "tgsi", GALLIVM_DEBUG_TGSI, NULL }, { "ir", GALLIVM_DEBUG_IR, NULL }, { "asm", GALLIVM_DEBUG_ASM, NULL }, { "perf", GALLIVM_DEBUG_PERF, NULL }, { "gc", GALLIVM_DEBUG_GC, NULL }, { "dumpbc", GALLIVM_DEBUG_DUMP_BC, NULL }, DEBUG_NAMED_VALUE_END }; DEBUG_GET_ONCE_FLAGS_OPTION(gallivm_debug, "GALLIVM_DEBUG", lp_bld_debug_flags, 0) #endif static boolean gallivm_initialized = FALSE; unsigned lp_native_vector_width; /* * Optimization values are: * - 0: None (-O0) * - 1: Less (-O1) * - 2: Default (-O2, -Os) * - 3: Aggressive (-O3) * * See also CodeGenOpt::Level in llvm/Target/TargetMachine.h */ enum LLVM_CodeGenOpt_Level { None, // -O0 Less, // -O1 Default, // -O2, -Os Aggressive // -O3 }; /** * Create the LLVM (optimization) pass manager and install * relevant optimization passes. * \return TRUE for success, FALSE for failure */ static boolean create_pass_manager(struct gallivm_state *gallivm) { assert(!gallivm->passmgr); assert(gallivm->target); gallivm->passmgr = LLVMCreateFunctionPassManagerForModule(gallivm->module); if (!gallivm->passmgr) return FALSE; #if GALLIVM_HAVE_CORO gallivm->cgpassmgr = LLVMCreatePassManager(); #endif /* * TODO: some per module pass manager with IPO passes might be helpful - * the generated texture functions may benefit from inlining if they are * simple, or constant propagation into them, etc. */ { char *td_str; // New ones from the Module. td_str = LLVMCopyStringRepOfTargetData(gallivm->target); LLVMSetDataLayout(gallivm->module, td_str); free(td_str); } #if GALLIVM_HAVE_CORO #if LLVM_VERSION_MAJOR <= 8 && (defined(PIPE_ARCH_AARCH64) || defined (PIPE_ARCH_ARM) || defined(PIPE_ARCH_S390) || defined(PIPE_ARCH_MIPS64)) LLVMAddArgumentPromotionPass(gallivm->cgpassmgr); LLVMAddFunctionAttrsPass(gallivm->cgpassmgr); #endif LLVMAddCoroEarlyPass(gallivm->cgpassmgr); LLVMAddCoroSplitPass(gallivm->cgpassmgr); LLVMAddCoroElidePass(gallivm->cgpassmgr); #endif if ((gallivm_perf & GALLIVM_PERF_NO_OPT) == 0) { /* * TODO: Evaluate passes some more - keeping in mind * both quality of generated code and compile times. */ /* * NOTE: if you change this, don't forget to change the output * with GALLIVM_DEBUG_DUMP_BC in gallivm_compile_module. */ LLVMAddScalarReplAggregatesPass(gallivm->passmgr); LLVMAddEarlyCSEPass(gallivm->passmgr); LLVMAddCFGSimplificationPass(gallivm->passmgr); /* * FIXME: LICM is potentially quite useful. However, for some * rather crazy shaders the compile time can reach _hours_ per shader, * due to licm implying lcssa (since llvm 3.5), which can take forever. * Even for sane shaders, the cost of licm is rather high (and not just * due to lcssa, licm itself too), though mostly only in cases when it * can actually move things, so having to disable it is a pity. * LLVMAddLICMPass(gallivm->passmgr); */ LLVMAddReassociatePass(gallivm->passmgr); LLVMAddPromoteMemoryToRegisterPass(gallivm->passmgr); #if LLVM_VERSION_MAJOR <= 11 LLVMAddConstantPropagationPass(gallivm->passmgr); #else LLVMAddInstructionSimplifyPass(gallivm->passmgr); #endif LLVMAddInstructionCombiningPass(gallivm->passmgr); LLVMAddGVNPass(gallivm->passmgr); } else { /* We need at least this pass to prevent the backends to fail in * unexpected ways. */ LLVMAddPromoteMemoryToRegisterPass(gallivm->passmgr); } #if GALLIVM_HAVE_CORO LLVMAddCoroCleanupPass(gallivm->passmgr); #endif return TRUE; } /** * Free gallivm object's LLVM allocations, but not any generated code * nor the gallivm object itself. */ void gallivm_free_ir(struct gallivm_state *gallivm) { if (gallivm->passmgr) { LLVMDisposePassManager(gallivm->passmgr); } #if GALLIVM_HAVE_CORO if (gallivm->cgpassmgr) { LLVMDisposePassManager(gallivm->cgpassmgr); } #endif if (gallivm->engine) { /* This will already destroy any associated module */ LLVMDisposeExecutionEngine(gallivm->engine); } else if (gallivm->module) { LLVMDisposeModule(gallivm->module); } if (gallivm->cache) { lp_free_objcache(gallivm->cache->jit_obj_cache); free(gallivm->cache->data); } FREE(gallivm->module_name); if (gallivm->target) { LLVMDisposeTargetData(gallivm->target); } if (gallivm->builder) LLVMDisposeBuilder(gallivm->builder); /* The LLVMContext should be owned by the parent of gallivm. */ gallivm->engine = NULL; gallivm->target = NULL; gallivm->module = NULL; gallivm->module_name = NULL; gallivm->cgpassmgr = NULL; gallivm->passmgr = NULL; gallivm->context = NULL; gallivm->builder = NULL; gallivm->cache = NULL; } /** * Free LLVM-generated code. Should be done AFTER gallivm_free_ir(). */ static void gallivm_free_code(struct gallivm_state *gallivm) { assert(!gallivm->module); assert(!gallivm->engine); lp_free_generated_code(gallivm->code); gallivm->code = NULL; lp_free_memory_manager(gallivm->memorymgr); gallivm->memorymgr = NULL; } static boolean init_gallivm_engine(struct gallivm_state *gallivm) { if (1) { enum LLVM_CodeGenOpt_Level optlevel; char *error = NULL; int ret; if (gallivm_perf & GALLIVM_PERF_NO_OPT) { optlevel = None; } else { optlevel = Default; } ret = lp_build_create_jit_compiler_for_module(&gallivm->engine, &gallivm->code, gallivm->cache, gallivm->module, gallivm->memorymgr, (unsigned) optlevel, &error); if (ret) { _debug_printf("%s\n", error); LLVMDisposeMessage(error); goto fail; } } if (0) { /* * Dump the data layout strings. */ LLVMTargetDataRef target = LLVMGetExecutionEngineTargetData(gallivm->engine); char *data_layout; char *engine_data_layout; data_layout = LLVMCopyStringRepOfTargetData(gallivm->target); engine_data_layout = LLVMCopyStringRepOfTargetData(target); if (1) { debug_printf("module target data = %s\n", data_layout); debug_printf("engine target data = %s\n", engine_data_layout); } free(data_layout); free(engine_data_layout); } return TRUE; fail: return FALSE; } /** * Allocate gallivm LLVM objects. * \return TRUE for success, FALSE for failure */ static boolean init_gallivm_state(struct gallivm_state *gallivm, const char *name, LLVMContextRef context, struct lp_cached_code *cache) { assert(!gallivm->context); assert(!gallivm->module); if (!lp_build_init()) return FALSE; gallivm->context = context; gallivm->cache = cache; if (!gallivm->context) goto fail; gallivm->module_name = NULL; if (name) { size_t size = strlen(name) + 1; gallivm->module_name = MALLOC(size); if (gallivm->module_name) { memcpy(gallivm->module_name, name, size); } } gallivm->module = LLVMModuleCreateWithNameInContext(name, gallivm->context); if (!gallivm->module) goto fail; #if defined(PIPE_ARCH_X86) lp_set_module_stack_alignment_override(gallivm->module, 4); #endif gallivm->builder = LLVMCreateBuilderInContext(gallivm->context); if (!gallivm->builder) goto fail; gallivm->memorymgr = lp_get_default_memory_manager(); if (!gallivm->memorymgr) goto fail; /* FIXME: MC-JIT only allows compiling one module at a time, and it must be * complete when MC-JIT is created. So defer the MC-JIT engine creation for * now. */ /* * MC-JIT engine compiles the module immediately on creation, so we can't * obtain the target data from it. Instead we create a target data layout * from a string. * * The produced layout strings are not precisely the same, but should make * no difference for the kind of optimization passes we run. * * For reference this is the layout string on x64: * * e-p:64:64:64-S128-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:64-f16:16:16-f32:32:32-f64:64:64-v64:64:64-v128:128:128-a0:0:64-s0:64:64-f80:128:128-f128:128:128-n8:16:32:64 * * See also: * - http://llvm.org/docs/LangRef.html#datalayout */ { const unsigned pointer_size = 8 * sizeof(void *); char layout[512]; snprintf(layout, sizeof layout, "%c-p:%u:%u:%u-i64:64:64-a0:0:%u-s0:%u:%u", #if UTIL_ARCH_LITTLE_ENDIAN 'e', // little endian #else 'E', // big endian #endif pointer_size, pointer_size, pointer_size, // pointer size, abi alignment, preferred alignment pointer_size, // aggregate preferred alignment pointer_size, pointer_size); // stack objects abi alignment, preferred alignment gallivm->target = LLVMCreateTargetData(layout); if (!gallivm->target) { return FALSE; } } if (!create_pass_manager(gallivm)) goto fail; return TRUE; fail: gallivm_free_ir(gallivm); gallivm_free_code(gallivm); return FALSE; } boolean lp_build_init(void) { if (gallivm_initialized) return TRUE; /* LLVMLinkIn* are no-ops at runtime. They just ensure the respective * component is linked at buildtime, which is sufficient for its static * constructors to be called at load time. */ LLVMLinkInMCJIT(); #ifdef DEBUG gallivm_debug = debug_get_option_gallivm_debug(); #endif gallivm_perf = debug_get_flags_option("GALLIVM_PERF", lp_bld_perf_flags, 0 ); lp_set_target_options(); util_cpu_detect(); /* For simulating less capable machines */ #ifdef DEBUG if (debug_get_bool_option("LP_FORCE_SSE2", FALSE)) { extern struct util_cpu_caps_t util_cpu_caps; assert(util_cpu_caps.has_sse2); util_cpu_caps.has_sse3 = 0; util_cpu_caps.has_ssse3 = 0; util_cpu_caps.has_sse4_1 = 0; util_cpu_caps.has_sse4_2 = 0; util_cpu_caps.has_avx = 0; util_cpu_caps.has_avx2 = 0; util_cpu_caps.has_f16c = 0; util_cpu_caps.has_fma = 0; } #endif if (util_get_cpu_caps()->has_avx2 || util_get_cpu_caps()->has_avx) { lp_native_vector_width = 256; } else { /* Leave it at 128, even when no SIMD extensions are available. * Really needs to be a multiple of 128 so can fit 4 floats. */ lp_native_vector_width = 128; } lp_native_vector_width = debug_get_num_option("LP_NATIVE_VECTOR_WIDTH", lp_native_vector_width); #if LLVM_VERSION_MAJOR < 4 if (lp_native_vector_width <= 128) { /* Hide AVX support, as often LLVM AVX intrinsics are only guarded by * "util_get_cpu_caps()->has_avx" predicate, and lack the * "lp_native_vector_width > 128" predicate. And also to ensure a more * consistent behavior, allowing one to test SSE2 on AVX machines. * XXX: should not play games with util_cpu_caps directly as it might * get used for other things outside llvm too. */ util_get_cpu_caps()->has_avx = 0; util_get_cpu_caps()->has_avx2 = 0; util_get_cpu_caps()->has_f16c = 0; util_get_cpu_caps()->has_fma = 0; } #endif #ifdef PIPE_ARCH_PPC_64 /* Set the NJ bit in VSCR to 0 so denormalized values are handled as * specified by IEEE standard (PowerISA 2.06 - Section 6.3). This guarantees * that some rounding and half-float to float handling does not round * incorrectly to 0. * XXX: should eventually follow same logic on all platforms. * Right now denorms get explicitly disabled (but elsewhere) for x86, * whereas ppc64 explicitly enables them... */ if (util_get_cpu_caps()->has_altivec) { unsigned short mask[] = { 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFE, 0xFFFF }; __asm ( "mfvscr %%v1\n" "vand %0,%%v1,%0\n" "mtvscr %0" : : "r" (*mask) ); } #endif gallivm_initialized = TRUE; return TRUE; } /** * Create a new gallivm_state object. */ struct gallivm_state * gallivm_create(const char *name, LLVMContextRef context, struct lp_cached_code *cache) { struct gallivm_state *gallivm; gallivm = CALLOC_STRUCT(gallivm_state); if (gallivm) { if (!init_gallivm_state(gallivm, name, context, cache)) { FREE(gallivm); gallivm = NULL; } } assert(gallivm != NULL); return gallivm; } /** * Destroy a gallivm_state object. */ void gallivm_destroy(struct gallivm_state *gallivm) { gallivm_free_ir(gallivm); gallivm_free_code(gallivm); FREE(gallivm); } /** * Validate a function. * Verification is only done with debug builds. */ void gallivm_verify_function(struct gallivm_state *gallivm, LLVMValueRef func) { /* Verify the LLVM IR. If invalid, dump and abort */ #ifdef DEBUG if (LLVMVerifyFunction(func, LLVMPrintMessageAction)) { lp_debug_dump_value(func); assert(0); return; } #endif if (gallivm_debug & GALLIVM_DEBUG_IR) { /* Print the LLVM IR to stderr */ lp_debug_dump_value(func); debug_printf("\n"); } } /** * Compile a module. * This does IR optimization on all functions in the module. */ void gallivm_compile_module(struct gallivm_state *gallivm) { LLVMValueRef func; int64_t time_begin = 0; assert(!gallivm->compiled); if (gallivm->builder) { LLVMDisposeBuilder(gallivm->builder); gallivm->builder = NULL; } if (gallivm->cache && gallivm->cache->data_size) { goto skip_cached; } /* Dump bitcode to a file */ if (gallivm_debug & GALLIVM_DEBUG_DUMP_BC) { char filename[256]; assert(gallivm->module_name); snprintf(filename, sizeof(filename), "ir_%s.bc", gallivm->module_name); LLVMWriteBitcodeToFile(gallivm->module, filename); debug_printf("%s written\n", filename); debug_printf("Invoke as \"opt %s %s | llc -O%d %s%s\"\n", gallivm_perf & GALLIVM_PERF_NO_OPT ? "-mem2reg" : "-sroa -early-cse -simplifycfg -reassociate " "-mem2reg -constprop -instcombine -gvn", filename, gallivm_perf & GALLIVM_PERF_NO_OPT ? 0 : 2, "[-mcpu=<-mcpu option>] ", "[-mattr=<-mattr option(s)>]"); } if (gallivm_debug & GALLIVM_DEBUG_PERF) time_begin = os_time_get(); #if GALLIVM_HAVE_CORO LLVMRunPassManager(gallivm->cgpassmgr, gallivm->module); #endif /* Run optimization passes */ LLVMInitializeFunctionPassManager(gallivm->passmgr); func = LLVMGetFirstFunction(gallivm->module); while (func) { if (0) { debug_printf("optimizing func %s...\n", LLVMGetValueName(func)); } /* Disable frame pointer omission on debug/profile builds */ /* XXX: And workaround http://llvm.org/PR21435 */ #if defined(DEBUG) || defined(PROFILE) || defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64) LLVMAddTargetDependentFunctionAttr(func, "no-frame-pointer-elim", "true"); LLVMAddTargetDependentFunctionAttr(func, "no-frame-pointer-elim-non-leaf", "true"); #endif LLVMRunFunctionPassManager(gallivm->passmgr, func); func = LLVMGetNextFunction(func); } LLVMFinalizeFunctionPassManager(gallivm->passmgr); if (gallivm_debug & GALLIVM_DEBUG_PERF) { int64_t time_end = os_time_get(); int time_msec = (int)((time_end - time_begin) / 1000); assert(gallivm->module_name); debug_printf("optimizing module %s took %d msec\n", gallivm->module_name, time_msec); } /* Setting the module's DataLayout to an empty string will cause the * ExecutionEngine to copy to the DataLayout string from its target machine * to the module. As of LLVM 3.8 the module and the execution engine are * required to have the same DataLayout. * * We must make sure we do this after running the optimization passes, * because those passes need a correct datalayout string. For example, if * those optimization passes see an empty datalayout, they will assume this * is a little endian target and will do optimizations that break big endian * machines. * * TODO: This is just a temporary work-around. The correct solution is for * gallivm_init_state() to create a TargetMachine and pull the DataLayout * from there. Currently, the TargetMachine used by llvmpipe is being * implicitly created by the EngineBuilder in * lp_build_create_jit_compiler_for_module() */ skip_cached: LLVMSetDataLayout(gallivm->module, ""); assert(!gallivm->engine); if (!init_gallivm_engine(gallivm)) { assert(0); } assert(gallivm->engine); ++gallivm->compiled; if (gallivm->debug_printf_hook) LLVMAddGlobalMapping(gallivm->engine, gallivm->debug_printf_hook, debug_printf); if (gallivm_debug & GALLIVM_DEBUG_ASM) { LLVMValueRef llvm_func = LLVMGetFirstFunction(gallivm->module); while (llvm_func) { /* * Need to filter out functions which don't have an implementation, * such as the intrinsics. May not be sufficient in case of IPO? * LLVMGetPointerToGlobal() will abort otherwise. */ if (!LLVMIsDeclaration(llvm_func)) { void *func_code = LLVMGetPointerToGlobal(gallivm->engine, llvm_func); lp_disassemble(llvm_func, func_code); } llvm_func = LLVMGetNextFunction(llvm_func); } } #if defined(PROFILE) { LLVMValueRef llvm_func = LLVMGetFirstFunction(gallivm->module); while (llvm_func) { if (!LLVMIsDeclaration(llvm_func)) { void *func_code = LLVMGetPointerToGlobal(gallivm->engine, llvm_func); lp_profile(llvm_func, func_code); } llvm_func = LLVMGetNextFunction(llvm_func); } } #endif } func_pointer gallivm_jit_function(struct gallivm_state *gallivm, LLVMValueRef func) { void *code; func_pointer jit_func; int64_t time_begin = 0; assert(gallivm->compiled); assert(gallivm->engine); if (gallivm_debug & GALLIVM_DEBUG_PERF) time_begin = os_time_get(); code = LLVMGetPointerToGlobal(gallivm->engine, func); assert(code); jit_func = pointer_to_func(code); if (gallivm_debug & GALLIVM_DEBUG_PERF) { int64_t time_end = os_time_get(); int time_msec = (int)(time_end - time_begin) / 1000; debug_printf(" jitting func %s took %d msec\n", LLVMGetValueName(func), time_msec); } return jit_func; } unsigned gallivm_get_perf_flags(void) { return gallivm_perf; }