src/amd/common/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
  32 #include "amd_family.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct ac_shader_binary;
  39 struct ac_compiler_passes;
  40
  41 enum ac_func_attr {
  42         AC_FUNC_ATTR_ALWAYSINLINE = (1 << 0),
  43         AC_FUNC_ATTR_INREG        = (1 << 2),
  44         AC_FUNC_ATTR_NOALIAS      = (1 << 3),
  45         AC_FUNC_ATTR_NOUNWIND     = (1 << 4),
  46         AC_FUNC_ATTR_READNONE     = (1 << 5),
  47         AC_FUNC_ATTR_READONLY     = (1 << 6),
  48         AC_FUNC_ATTR_WRITEONLY    = (1 << 7),
  49         AC_FUNC_ATTR_INACCESSIBLE_MEM_ONLY = (1 << 8),
  50         AC_FUNC_ATTR_CONVERGENT = (1 << 9),
  51
  52         /* Legacy intrinsic that needs attributes on function declarations
  53          * and they must match the internal LLVM definition exactly, otherwise
  54          * intrinsic selection fails.
  55          */
  56         AC_FUNC_ATTR_LEGACY       = (1u << 31),
  57 };
  58
  59 enum ac_target_machine_options {
  60         AC_TM_SUPPORTS_SPILL = (1 << 0),
  61         AC_TM_SISCHED = (1 << 1),
  62         AC_TM_FORCE_ENABLE_XNACK = (1 << 2),
  63         AC_TM_FORCE_DISABLE_XNACK = (1 << 3),
  64         AC_TM_PROMOTE_ALLOCA_TO_SCRATCH = (1 << 4),
  65         AC_TM_CHECK_IR = (1 << 5),
  66 };
  67
  68 enum ac_float_mode {
  69         AC_FLOAT_MODE_DEFAULT,
  70         AC_FLOAT_MODE_NO_SIGNED_ZEROS_FP_MATH,
  71         AC_FLOAT_MODE_UNSAFE_FP_MATH,
  72 };
  73
  74 /* Per-thread persistent LLVM objects. */
  75 struct ac_llvm_compiler {
  76         LLVMTargetMachineRef            tm;
  77         LLVMTargetLibraryInfoRef        target_library_info;
  78         LLVMPassManagerRef              passmgr;
  79         struct ac_compiler_passes       *passes;
  80 };
  81
  82 const char *ac_get_llvm_processor_name(enum radeon_family family);
  83 void ac_add_attr_dereferenceable(LLVMValueRef val, uint64_t bytes);
  84 bool ac_is_sgpr_param(LLVMValueRef param);
  85 void ac_add_function_attr(LLVMContextRef ctx, LLVMValueRef function,
  86                           int attr_idx, enum ac_func_attr attr);
  87 void ac_add_func_attributes(LLVMContextRef ctx, LLVMValueRef function,
  88                             unsigned attrib_mask);
  89 void ac_dump_module(LLVMModuleRef module);
  90
  91 LLVMValueRef ac_llvm_get_called_value(LLVMValueRef call);
  92 bool ac_llvm_is_function(LLVMValueRef v);
  93 LLVMModuleRef ac_create_module(LLVMTargetMachineRef tm, LLVMContextRef ctx);
  94
  95 LLVMBuilderRef ac_create_builder(LLVMContextRef ctx,
  96                                  enum ac_float_mode float_mode);
  97
  98 void
  99 ac_llvm_add_target_dep_function_attr(LLVMValueRef F,
 100                                      const char *name, unsigned value);
 101
 102 static inline unsigned
 103 ac_get_load_intr_attribs(bool can_speculate)
 104 {
 105         /* READNONE means writes can't affect it, while READONLY means that
 106          * writes can affect it. */
 107         return can_speculate ? AC_FUNC_ATTR_READNONE :
 108                                AC_FUNC_ATTR_READONLY;
 109 }
 110
 111 static inline unsigned
 112 ac_get_store_intr_attribs(bool writeonly_memory)
 113 {
 114         return writeonly_memory ? AC_FUNC_ATTR_INACCESSIBLE_MEM_ONLY :
 115                                   AC_FUNC_ATTR_WRITEONLY;
 116 }
 117
 118 unsigned
 119 ac_count_scratch_private_memory(LLVMValueRef function);
 120
 121 LLVMTargetLibraryInfoRef ac_create_target_library_info(const char *triple);
 122 void ac_dispose_target_library_info(LLVMTargetLibraryInfoRef library_info);
 123 void ac_init_llvm_once(void);
 124
 125
 126 bool ac_init_llvm_compiler(struct ac_llvm_compiler *compiler,
 127                            bool okay_to_leak_target_library_info,
 128                            enum radeon_family family,
 129                            enum ac_target_machine_options tm_options);
 130 void ac_destroy_llvm_compiler(struct ac_llvm_compiler *compiler);
 131
 132 struct ac_compiler_passes *ac_create_llvm_passes(LLVMTargetMachineRef tm);
 133 void ac_destroy_llvm_passes(struct ac_compiler_passes *p);
 134 bool ac_compile_module_to_binary(struct ac_compiler_passes *p, LLVMModuleRef module,
 135                                  struct ac_shader_binary *binary);
 136
 137 #ifdef __cplusplus
 138 }
 139 #endif
 140
 141 #endif /* AC_LLVM_UTIL_H */