d44d4deab87e37b6a977f072e5eaf5edd01801b3
[mesa.git] / src / amd / llvm / ac_llvm_util.h
1 /*
2 * Copyright 2016 Bas Nieuwenhuizen
3 *
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:
11 *
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.
19 *
20 * The above copyright notice and this permission notice (including the
21 * next paragraph) shall be included in all copies or substantial portions
22 * of the Software.
23 *
24 */
25
26 #ifndef AC_LLVM_UTIL_H
27 #define AC_LLVM_UTIL_H
28
29 #include <stdbool.h>
30 #include <llvm-c/TargetMachine.h>
31 #include <llvm/Config/llvm-config.h>
32
33 #include "amd_family.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct ac_compiler_passes;
40 struct ac_llvm_context;
41
42 enum ac_func_attr {
43 AC_FUNC_ATTR_ALWAYSINLINE = (1 << 0),
44 AC_FUNC_ATTR_INREG = (1 << 2),
45 AC_FUNC_ATTR_NOALIAS = (1 << 3),
46 AC_FUNC_ATTR_NOUNWIND = (1 << 4),
47 AC_FUNC_ATTR_READNONE = (1 << 5),
48 AC_FUNC_ATTR_READONLY = (1 << 6),
49 AC_FUNC_ATTR_WRITEONLY = (1 << 7),
50 AC_FUNC_ATTR_INACCESSIBLE_MEM_ONLY = (1 << 8),
51 AC_FUNC_ATTR_CONVERGENT = (1 << 9),
52
53 /* Legacy intrinsic that needs attributes on function declarations
54 * and they must match the internal LLVM definition exactly, otherwise
55 * intrinsic selection fails.
56 */
57 AC_FUNC_ATTR_LEGACY = (1u << 31),
58 };
59
60 enum ac_target_machine_options {
61 AC_TM_SUPPORTS_SPILL = (1 << 0),
62 AC_TM_FORCE_ENABLE_XNACK = (1 << 1),
63 AC_TM_FORCE_DISABLE_XNACK = (1 << 2),
64 AC_TM_PROMOTE_ALLOCA_TO_SCRATCH = (1 << 3),
65 AC_TM_CHECK_IR = (1 << 4),
66 AC_TM_ENABLE_GLOBAL_ISEL = (1 << 5),
67 AC_TM_CREATE_LOW_OPT = (1 << 6),
68 AC_TM_WAVE32 = (1 << 7),
69 };
70
71 enum ac_float_mode {
72 AC_FLOAT_MODE_DEFAULT,
73 AC_FLOAT_MODE_DEFAULT_OPENGL,
74 AC_FLOAT_MODE_DENORM_FLUSH_TO_ZERO,
75 };
76
77 /* Per-thread persistent LLVM objects. */
78 struct ac_llvm_compiler {
79 LLVMTargetLibraryInfoRef target_library_info;
80 LLVMPassManagerRef passmgr;
81
82 /* Default compiler. */
83 LLVMTargetMachineRef tm;
84 struct ac_compiler_passes *passes;
85
86 /* Wave32 compiler for GFX10. */
87 LLVMTargetMachineRef tm_wave32;
88 struct ac_compiler_passes *passes_wave32;
89
90 /* Optional compiler for faster compilation with fewer optimizations.
91 * LLVM modules can be created with "tm" too. There is no difference.
92 */
93 LLVMTargetMachineRef low_opt_tm; /* uses -O1 instead of -O2 */
94 struct ac_compiler_passes *low_opt_passes;
95 };
96
97 const char *ac_get_llvm_processor_name(enum radeon_family family);
98 void ac_add_attr_dereferenceable(LLVMValueRef val, uint64_t bytes);
99 void ac_add_attr_alignment(LLVMValueRef val, uint64_t bytes);
100 bool ac_is_sgpr_param(LLVMValueRef param);
101 void ac_add_function_attr(LLVMContextRef ctx, LLVMValueRef function,
102 int attr_idx, enum ac_func_attr attr);
103 void ac_add_func_attributes(LLVMContextRef ctx, LLVMValueRef function,
104 unsigned attrib_mask);
105 void ac_dump_module(LLVMModuleRef module);
106
107 LLVMValueRef ac_llvm_get_called_value(LLVMValueRef call);
108 bool ac_llvm_is_function(LLVMValueRef v);
109 LLVMModuleRef ac_create_module(LLVMTargetMachineRef tm, LLVMContextRef ctx);
110
111 LLVMBuilderRef ac_create_builder(LLVMContextRef ctx,
112 enum ac_float_mode float_mode);
113 void ac_enable_signed_zeros(struct ac_llvm_context *ctx);
114 void ac_disable_signed_zeros(struct ac_llvm_context *ctx);
115
116 void
117 ac_llvm_add_target_dep_function_attr(LLVMValueRef F,
118 const char *name, unsigned value);
119 void ac_llvm_set_workgroup_size(LLVMValueRef F, unsigned size);
120
121 static inline unsigned
122 ac_get_load_intr_attribs(bool can_speculate)
123 {
124 /* READNONE means writes can't affect it, while READONLY means that
125 * writes can affect it. */
126 return can_speculate ? AC_FUNC_ATTR_READNONE :
127 AC_FUNC_ATTR_READONLY;
128 }
129
130 unsigned
131 ac_count_scratch_private_memory(LLVMValueRef function);
132
133 LLVMTargetLibraryInfoRef ac_create_target_library_info(const char *triple);
134 void ac_dispose_target_library_info(LLVMTargetLibraryInfoRef library_info);
135 void ac_init_shared_llvm_once(void); /* Do not use directly, use ac_init_llvm_once */
136 void ac_init_llvm_once(void);
137
138
139 bool ac_init_llvm_compiler(struct ac_llvm_compiler *compiler,
140 enum radeon_family family,
141 enum ac_target_machine_options tm_options);
142 void ac_destroy_llvm_compiler(struct ac_llvm_compiler *compiler);
143
144 struct ac_compiler_passes *ac_create_llvm_passes(LLVMTargetMachineRef tm);
145 void ac_destroy_llvm_passes(struct ac_compiler_passes *p);
146 bool ac_compile_module_to_elf(struct ac_compiler_passes *p, LLVMModuleRef module,
147 char **pelf_buffer, size_t *pelf_size);
148 void ac_llvm_add_barrier_noop_pass(LLVMPassManagerRef passmgr);
149 void ac_enable_global_isel(LLVMTargetMachineRef tm);
150
151 static inline bool
152 ac_has_vec3_support(enum chip_class chip, bool use_format)
153 {
154 if (chip == GFX6 && !use_format) {
155 /* GFX6 only supports vec3 with load/store format. */
156 return false;
157 }
158
159 return LLVM_VERSION_MAJOR >= 9;
160 }
161
162 #ifdef __cplusplus
163 }
164 #endif
165
166 #endif /* AC_LLVM_UTIL_H */