src/gallium/drivers/radeon/radeon_llvm_emit.c

   1 /*
   2  * Copyright 2011 Advanced Micro Devices, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  *
  23  * Authors: Tom Stellard <thomas.stellard@amd.com>
  24  *
  25  */
  26
  27 #include "radeon_llvm_emit.h"
  28 #include "radeon_elf_util.h"
  29 #include "c11/threads.h"
  30 #include "gallivm/lp_bld_misc.h"
  31 #include "util/u_debug.h"
  32 #include "util/u_memory.h"
  33 #include "pipe/p_shader_tokens.h"
  34 #include "pipe/p_state.h"
  35
  36 #include <llvm-c/Target.h>
  37 #include <llvm-c/TargetMachine.h>
  38 #include <llvm-c/Core.h>
  39
  40 #include <stdlib.h>
  41 #include <stdio.h>
  42 #include <string.h>
  43
  44 #define CPU_STRING_LEN 30
  45 #define FS_STRING_LEN 30
  46 #define TRIPLE_STRING_LEN 7
  47
  48 /**
  49  * Shader types for the LLVM backend.
  50  */
  51 enum radeon_llvm_shader_type {
  52         RADEON_LLVM_SHADER_PS = 0,
  53         RADEON_LLVM_SHADER_VS = 1,
  54         RADEON_LLVM_SHADER_GS = 2,
  55         RADEON_LLVM_SHADER_CS = 3,
  56 };
  57
  58 /**
  59  * Set the shader type we want to compile
  60  *
  61  * @param type shader type to set
  62  */
  63 void radeon_llvm_shader_type(LLVMValueRef F, unsigned type)
  64 {
  65         char Str[2];
  66         enum radeon_llvm_shader_type llvm_type;
  67
  68         switch (type) {
  69         case TGSI_PROCESSOR_VERTEX:
  70         case TGSI_PROCESSOR_TESS_CTRL:
  71         case TGSI_PROCESSOR_TESS_EVAL:
  72                 llvm_type = RADEON_LLVM_SHADER_VS;
  73                 break;
  74         case TGSI_PROCESSOR_GEOMETRY:
  75                 llvm_type = RADEON_LLVM_SHADER_GS;
  76                 break;
  77         case TGSI_PROCESSOR_FRAGMENT:
  78                 llvm_type = RADEON_LLVM_SHADER_PS;
  79                 break;
  80         case TGSI_PROCESSOR_COMPUTE:
  81                 llvm_type = RADEON_LLVM_SHADER_CS;
  82                 break;
  83         default:
  84                 assert(0);
  85         }
  86
  87         sprintf(Str, "%1d", llvm_type);
  88
  89         LLVMAddTargetDependentFunctionAttr(F, "ShaderType", Str);
  90 }
  91
  92 static void init_r600_target()
  93 {
  94         gallivm_init_llvm_targets();
  95 #if HAVE_LLVM < 0x0307
  96         LLVMInitializeR600TargetInfo();
  97         LLVMInitializeR600Target();
  98         LLVMInitializeR600TargetMC();
  99         LLVMInitializeR600AsmPrinter();
 100 #else
 101         LLVMInitializeAMDGPUTargetInfo();
 102         LLVMInitializeAMDGPUTarget();
 103         LLVMInitializeAMDGPUTargetMC();
 104         LLVMInitializeAMDGPUAsmPrinter();
 105
 106 #endif
 107 }
 108
 109 static once_flag init_r600_target_once_flag = ONCE_FLAG_INIT;
 110
 111 LLVMTargetRef radeon_llvm_get_r600_target(const char *triple)
 112 {
 113         LLVMTargetRef target = NULL;
 114         char *err_message = NULL;
 115
 116         call_once(&init_r600_target_once_flag, init_r600_target);
 117
 118         if (LLVMGetTargetFromTriple(triple, &target, &err_message)) {
 119                 fprintf(stderr, "Cannot find target for triple %s ", triple);
 120                 if (err_message) {
 121                         fprintf(stderr, "%s\n", err_message);
 122                 }
 123                 LLVMDisposeMessage(err_message);
 124                 return NULL;
 125         }
 126         return target;
 127 }
 128
 129 struct radeon_llvm_diagnostics {
 130         struct pipe_debug_callback *debug;
 131         unsigned retval;
 132 };
 133
 134 static void radeonDiagnosticHandler(LLVMDiagnosticInfoRef di, void *context)
 135 {
 136         struct radeon_llvm_diagnostics *diag = (struct radeon_llvm_diagnostics *)context;
 137         LLVMDiagnosticSeverity severity = LLVMGetDiagInfoSeverity(di);
 138         char *description = LLVMGetDiagInfoDescription(di);
 139         const char *severity_str = NULL;
 140
 141         switch (severity) {
 142         case LLVMDSError:
 143                 severity_str = "error";
 144                 break;
 145         case LLVMDSWarning:
 146                 severity_str = "warning";
 147                 break;
 148         case LLVMDSRemark:
 149                 severity_str = "remark";
 150                 break;
 151         case LLVMDSNote:
 152                 severity_str = "note";
 153                 break;
 154         default:
 155                 severity_str = "unknown";
 156         }
 157
 158         pipe_debug_message(diag->debug, SHADER_INFO,
 159                            "LLVM diagnostic (%s): %s", severity_str, description);
 160
 161         if (severity == LLVMDSError) {
 162                 diag->retval = 1;
 163                 fprintf(stderr,"LLVM triggered Diagnostic Handler: %s\n", description);
 164         }
 165
 166         LLVMDisposeMessage(description);
 167 }
 168
 169 /**
 170  * Compile an LLVM module to machine code.
 171  *
 172  * @returns 0 for success, 1 for failure
 173  */
 174 unsigned radeon_llvm_compile(LLVMModuleRef M, struct radeon_shader_binary *binary,
 175                              const char *gpu_family, bool dump_ir, bool dump_asm,
 176                              LLVMTargetMachineRef tm,
 177                              struct pipe_debug_callback *debug)
 178 {
 179         struct radeon_llvm_diagnostics diag;
 180         char cpu[CPU_STRING_LEN];
 181         char fs[FS_STRING_LEN];
 182         char *err;
 183         bool dispose_tm = false;
 184         LLVMContextRef llvm_ctx;
 185         LLVMMemoryBufferRef out_buffer;
 186         unsigned buffer_size;
 187         const char *buffer_data;
 188         char triple[TRIPLE_STRING_LEN];
 189         LLVMBool mem_err;
 190
 191         diag.debug = debug;
 192         diag.retval = 0;
 193
 194         if (!tm) {
 195                 strncpy(triple, "r600--", TRIPLE_STRING_LEN);
 196                 LLVMTargetRef target = radeon_llvm_get_r600_target(triple);
 197                 if (!target) {
 198                         return 1;
 199                 }
 200                 strncpy(cpu, gpu_family, CPU_STRING_LEN);
 201                 memset(fs, 0, sizeof(fs));
 202                 if (dump_asm)
 203                         strncpy(fs, "+DumpCode", FS_STRING_LEN);
 204                 tm = LLVMCreateTargetMachine(target, triple, cpu, fs,
 205                                   LLVMCodeGenLevelDefault, LLVMRelocDefault,
 206                                                   LLVMCodeModelDefault);
 207                 dispose_tm = true;
 208         }
 209         if (dump_ir)
 210                 LLVMDumpModule(M);
 211         /* Setup Diagnostic Handler*/
 212         llvm_ctx = LLVMGetModuleContext(M);
 213
 214         LLVMContextSetDiagnosticHandler(llvm_ctx, radeonDiagnosticHandler, &diag);
 215
 216         /* Compile IR*/
 217         mem_err = LLVMTargetMachineEmitToMemoryBuffer(tm, M, LLVMObjectFile, &err,
 218                                                                  &out_buffer);
 219
 220         /* Process Errors/Warnings */
 221         if (mem_err) {
 222                 fprintf(stderr, "%s: %s", __FUNCTION__, err);
 223                 pipe_debug_message(debug, SHADER_INFO,
 224                                    "LLVM emit error: %s", err);
 225                 FREE(err);
 226                 diag.retval = 1;
 227                 goto out;
 228         }
 229
 230         /* Extract Shader Code*/
 231         buffer_size = LLVMGetBufferSize(out_buffer);
 232         buffer_data = LLVMGetBufferStart(out_buffer);
 233
 234         radeon_elf_read(buffer_data, buffer_size, binary);
 235
 236         /* Clean up */
 237         LLVMDisposeMemoryBuffer(out_buffer);
 238
 239 out:
 240         if (dispose_tm) {
 241                 LLVMDisposeTargetMachine(tm);
 242         }
 243         if (diag.retval != 0)
 244                 pipe_debug_message(debug, SHADER_INFO, "LLVM compile failed");
 245         return diag.retval;
 246 }