2 * Copyright 2014 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sub license, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
15 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
17 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
18 * USE OR OTHER DEALINGS IN THE SOFTWARE.
20 * The above copyright notice and this permission notice (including the
21 * next paragraph) shall be included in all copies or substantial portions
25 /* based on pieces from si_pipe.c and radeon_llvm_emit.c */
26 #include "ac_llvm_util.h"
27 #include "ac_llvm_build.h"
28 #include "util/bitscan.h"
29 #include <llvm-c/Core.h>
30 #include <llvm-c/Support.h>
31 #include <llvm-c/Transforms/IPO.h>
32 #include <llvm-c/Transforms/Scalar.h>
33 #include <llvm-c/Transforms/Utils.h>
34 #include "c11/threads.h"
35 #include "gallivm/lp_bld_misc.h"
36 #include "util/u_math.h"
42 static void ac_init_llvm_target()
44 LLVMInitializeAMDGPUTargetInfo();
45 LLVMInitializeAMDGPUTarget();
46 LLVMInitializeAMDGPUTargetMC();
47 LLVMInitializeAMDGPUAsmPrinter();
49 /* For inline assembly. */
50 LLVMInitializeAMDGPUAsmParser();
52 /* For ACO disassembly. */
53 LLVMInitializeAMDGPUDisassembler();
55 /* Workaround for bug in llvm 4.0 that causes image intrinsics
57 * https://reviews.llvm.org/D26348
59 * "mesa" is the prefix for error messages.
61 * -global-isel-abort=2 is a no-op unless global isel has been enabled.
62 * This option tells the backend to fall-back to SelectionDAG and print
63 * a diagnostic message if global isel fails.
65 const char *argv
[] = {
67 "-simplifycfg-sink-common=false",
68 "-global-isel-abort=2",
69 #if LLVM_VERSION_MAJOR >= 10
70 /* Atomic optimizations require LLVM 10.0 for gfx10 support. */
71 "-amdgpu-atomic-optimizations=true",
73 #if LLVM_VERSION_MAJOR >= 11
74 /* This was disabled by default in: https://reviews.llvm.org/D77228 */
75 "-structurizecfg-skip-uniform-regions",
78 LLVMParseCommandLineOptions(ARRAY_SIZE(argv
), argv
, NULL
);
81 PUBLIC
void ac_init_shared_llvm_once(void)
83 static once_flag ac_init_llvm_target_once_flag
= ONCE_FLAG_INIT
;
84 call_once(&ac_init_llvm_target_once_flag
, ac_init_llvm_target
);
88 static once_flag ac_init_static_llvm_target_once_flag
= ONCE_FLAG_INIT
;
89 static void ac_init_static_llvm_once(void)
91 call_once(&ac_init_static_llvm_target_once_flag
, ac_init_llvm_target
);
95 void ac_init_llvm_once(void)
98 ac_init_shared_llvm_once();
100 ac_init_static_llvm_once();
104 static LLVMTargetRef
ac_get_llvm_target(const char *triple
)
106 LLVMTargetRef target
= NULL
;
107 char *err_message
= NULL
;
109 if (LLVMGetTargetFromTriple(triple
, &target
, &err_message
)) {
110 fprintf(stderr
, "Cannot find target for triple %s ", triple
);
112 fprintf(stderr
, "%s\n", err_message
);
114 LLVMDisposeMessage(err_message
);
120 const char *ac_get_llvm_processor_name(enum radeon_family family
)
176 case CHIP_SIENNA_CICHLID
:
177 case CHIP_NAVY_FLOUNDER
:
184 static LLVMTargetMachineRef
ac_create_target_machine(enum radeon_family family
,
185 enum ac_target_machine_options tm_options
,
186 LLVMCodeGenOptLevel level
,
187 const char **out_triple
)
189 assert(family
>= CHIP_TAHITI
);
191 const char *triple
= (tm_options
& AC_TM_SUPPORTS_SPILL
) ? "amdgcn-mesa-mesa3d" : "amdgcn--";
192 LLVMTargetRef target
= ac_get_llvm_target(triple
);
194 snprintf(features
, sizeof(features
),
195 "+DumpCode%s%s%s%s%s",
196 LLVM_VERSION_MAJOR
>= 11 ? "" : ",-fp32-denormals,+fp64-denormals",
197 family
>= CHIP_NAVI10
&& !(tm_options
& AC_TM_WAVE32
) ?
198 ",+wavefrontsize64,-wavefrontsize32" : "",
199 family
<= CHIP_NAVI14
&& tm_options
& AC_TM_FORCE_ENABLE_XNACK
? ",+xnack" : "",
200 family
<= CHIP_NAVI14
&& tm_options
& AC_TM_FORCE_DISABLE_XNACK
? ",-xnack" : "",
201 tm_options
& AC_TM_PROMOTE_ALLOCA_TO_SCRATCH
? ",-promote-alloca" : "");
203 LLVMTargetMachineRef tm
= LLVMCreateTargetMachine(
206 ac_get_llvm_processor_name(family
),
210 LLVMCodeModelDefault
);
213 *out_triple
= triple
;
214 if (tm_options
& AC_TM_ENABLE_GLOBAL_ISEL
)
215 ac_enable_global_isel(tm
);
219 static LLVMPassManagerRef
ac_create_passmgr(LLVMTargetLibraryInfoRef target_library_info
,
222 LLVMPassManagerRef passmgr
= LLVMCreatePassManager();
226 if (target_library_info
)
227 LLVMAddTargetLibraryInfo(target_library_info
,
231 LLVMAddVerifierPass(passmgr
);
232 LLVMAddAlwaysInlinerPass(passmgr
);
233 /* Normally, the pass manager runs all passes on one function before
234 * moving onto another. Adding a barrier no-op pass forces the pass
235 * manager to run the inliner on all functions first, which makes sure
236 * that the following passes are only run on the remaining non-inline
237 * function, so it removes useless work done on dead inline functions.
239 ac_llvm_add_barrier_noop_pass(passmgr
);
240 /* This pass should eliminate all the load and store instructions. */
241 LLVMAddPromoteMemoryToRegisterPass(passmgr
);
242 LLVMAddScalarReplAggregatesPass(passmgr
);
243 LLVMAddLICMPass(passmgr
);
244 LLVMAddAggressiveDCEPass(passmgr
);
245 LLVMAddCFGSimplificationPass(passmgr
);
246 /* This is recommended by the instruction combining pass. */
247 LLVMAddEarlyCSEMemSSAPass(passmgr
);
248 LLVMAddInstructionCombiningPass(passmgr
);
252 static const char *attr_to_str(enum ac_func_attr attr
)
255 case AC_FUNC_ATTR_ALWAYSINLINE
: return "alwaysinline";
256 case AC_FUNC_ATTR_INREG
: return "inreg";
257 case AC_FUNC_ATTR_NOALIAS
: return "noalias";
258 case AC_FUNC_ATTR_NOUNWIND
: return "nounwind";
259 case AC_FUNC_ATTR_READNONE
: return "readnone";
260 case AC_FUNC_ATTR_READONLY
: return "readonly";
261 case AC_FUNC_ATTR_WRITEONLY
: return "writeonly";
262 case AC_FUNC_ATTR_INACCESSIBLE_MEM_ONLY
: return "inaccessiblememonly";
263 case AC_FUNC_ATTR_CONVERGENT
: return "convergent";
265 fprintf(stderr
, "Unhandled function attribute: %x\n", attr
);
271 ac_add_function_attr(LLVMContextRef ctx
, LLVMValueRef function
,
272 int attr_idx
, enum ac_func_attr attr
)
274 const char *attr_name
= attr_to_str(attr
);
275 unsigned kind_id
= LLVMGetEnumAttributeKindForName(attr_name
,
277 LLVMAttributeRef llvm_attr
= LLVMCreateEnumAttribute(ctx
, kind_id
, 0);
279 if (LLVMIsAFunction(function
))
280 LLVMAddAttributeAtIndex(function
, attr_idx
, llvm_attr
);
282 LLVMAddCallSiteAttribute(function
, attr_idx
, llvm_attr
);
285 void ac_add_func_attributes(LLVMContextRef ctx
, LLVMValueRef function
,
286 unsigned attrib_mask
)
288 attrib_mask
|= AC_FUNC_ATTR_NOUNWIND
;
289 attrib_mask
&= ~AC_FUNC_ATTR_LEGACY
;
291 while (attrib_mask
) {
292 enum ac_func_attr attr
= 1u << u_bit_scan(&attrib_mask
);
293 ac_add_function_attr(ctx
, function
, -1, attr
);
298 ac_dump_module(LLVMModuleRef module
)
300 char *str
= LLVMPrintModuleToString(module
);
301 fprintf(stderr
, "%s", str
);
302 LLVMDisposeMessage(str
);
306 ac_llvm_add_target_dep_function_attr(LLVMValueRef F
,
307 const char *name
, unsigned value
)
311 snprintf(str
, sizeof(str
), "0x%x", value
);
312 LLVMAddTargetDependentFunctionAttr(F
, name
, str
);
315 void ac_llvm_set_workgroup_size(LLVMValueRef F
, unsigned size
)
321 snprintf(str
, sizeof(str
), "%u,%u", size
, size
);
322 LLVMAddTargetDependentFunctionAttr(F
, "amdgpu-flat-work-group-size", str
);
326 ac_count_scratch_private_memory(LLVMValueRef function
)
328 unsigned private_mem_vgprs
= 0;
330 /* Process all LLVM instructions. */
331 LLVMBasicBlockRef bb
= LLVMGetFirstBasicBlock(function
);
333 LLVMValueRef next
= LLVMGetFirstInstruction(bb
);
336 LLVMValueRef inst
= next
;
337 next
= LLVMGetNextInstruction(next
);
339 if (LLVMGetInstructionOpcode(inst
) != LLVMAlloca
)
342 LLVMTypeRef type
= LLVMGetElementType(LLVMTypeOf(inst
));
343 /* No idea why LLVM aligns allocas to 4 elements. */
344 unsigned alignment
= LLVMGetAlignment(inst
);
345 unsigned dw_size
= align(ac_get_type_size(type
) / 4, alignment
);
346 private_mem_vgprs
+= dw_size
;
348 bb
= LLVMGetNextBasicBlock(bb
);
351 return private_mem_vgprs
;
355 ac_init_llvm_compiler(struct ac_llvm_compiler
*compiler
,
356 enum radeon_family family
,
357 enum ac_target_machine_options tm_options
)
360 memset(compiler
, 0, sizeof(*compiler
));
362 compiler
->tm
= ac_create_target_machine(family
, tm_options
,
363 LLVMCodeGenLevelDefault
,
368 if (tm_options
& AC_TM_CREATE_LOW_OPT
) {
369 compiler
->low_opt_tm
=
370 ac_create_target_machine(family
, tm_options
,
371 LLVMCodeGenLevelLess
, NULL
);
372 if (!compiler
->low_opt_tm
)
376 if (family
>= CHIP_NAVI10
) {
377 assert(!(tm_options
& AC_TM_CREATE_LOW_OPT
));
378 compiler
->tm_wave32
= ac_create_target_machine(family
,
379 tm_options
| AC_TM_WAVE32
,
380 LLVMCodeGenLevelDefault
,
382 if (!compiler
->tm_wave32
)
386 compiler
->target_library_info
=
387 ac_create_target_library_info(triple
);
388 if (!compiler
->target_library_info
)
391 compiler
->passmgr
= ac_create_passmgr(compiler
->target_library_info
,
392 tm_options
& AC_TM_CHECK_IR
);
393 if (!compiler
->passmgr
)
398 ac_destroy_llvm_compiler(compiler
);
403 ac_destroy_llvm_compiler(struct ac_llvm_compiler
*compiler
)
405 ac_destroy_llvm_passes(compiler
->passes
);
406 ac_destroy_llvm_passes(compiler
->passes_wave32
);
407 ac_destroy_llvm_passes(compiler
->low_opt_passes
);
409 if (compiler
->passmgr
)
410 LLVMDisposePassManager(compiler
->passmgr
);
411 if (compiler
->target_library_info
)
412 ac_dispose_target_library_info(compiler
->target_library_info
);
413 if (compiler
->low_opt_tm
)
414 LLVMDisposeTargetMachine(compiler
->low_opt_tm
);
416 LLVMDisposeTargetMachine(compiler
->tm
);
417 if (compiler
->tm_wave32
)
418 LLVMDisposeTargetMachine(compiler
->tm_wave32
);