1 // Copyright (c) 2017-2024, Lawrence Livermore National Security, LLC and other CEED contributors. 2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 // 4 // SPDX-License-Identifier: BSD-2-Clause 5 // 6 // This file is part of CEED: http://github.com/ceed 7 8 #include "ceed-hip-compile.h" 9 10 #include <ceed.h> 11 #include <ceed/backend.h> 12 #include <ceed/jit-tools.h> 13 #include <stdarg.h> 14 #include <string.h> 15 #include <hip/hiprtc.h> 16 17 #include <sstream> 18 19 #include "ceed-hip-common.h" 20 21 #define CeedChk_hiprtc(ceed, x) \ 22 do { \ 23 hiprtcResult result = static_cast<hiprtcResult>(x); \ 24 if (result != HIPRTC_SUCCESS) return CeedError((ceed), CEED_ERROR_BACKEND, hiprtcGetErrorString(result)); \ 25 } while (0) 26 27 #define CeedCallHiprtc(ceed, ...) \ 28 do { \ 29 int ierr_q_ = __VA_ARGS__; \ 30 CeedChk_hiprtc(ceed, ierr_q_); \ 31 } while (0) 32 33 //------------------------------------------------------------------------------ 34 // Compile HIP kernel 35 //------------------------------------------------------------------------------ 36 int CeedCompile_Hip(Ceed ceed, const char *source, hipModule_t *module, const CeedInt num_defines, ...) { 37 size_t ptx_size; 38 char *jit_defs_source, *ptx; 39 const char *jit_defs_path; 40 const int num_opts = 4; 41 CeedInt num_jit_source_dirs = 0; 42 const char **opts; 43 int runtime_version; 44 hiprtcProgram prog; 45 struct hipDeviceProp_t prop; 46 Ceed_Hip *ceed_data; 47 48 hipFree(0); // Make sure a Context exists for hiprtc 49 50 std::ostringstream code; 51 52 // Add hip runtime include statement for generation if runtime < 40400000 (implies ROCm < 4.5) 53 CeedCallHip(ceed, hipRuntimeGetVersion(&runtime_version)); 54 if (runtime_version < 40400000) { 55 code << "\n#include <hip/hip_runtime.h>\n"; 56 } 57 // With ROCm 4.5, need to include these definitions specifically for hiprtc (but cannot include the runtime header) 58 else { 59 code << "#include <stddef.h>\n"; 60 code << "#define __forceinline__ inline __attribute__((always_inline))\n"; 61 code << "#define HIP_DYNAMIC_SHARED(type, var) extern __shared__ type var[];\n"; 62 } 63 64 // Kernel specific options, such as kernel constants 65 if (num_defines > 0) { 66 va_list args; 67 va_start(args, num_defines); 68 char *name; 69 int val; 70 71 for (int i = 0; i < num_defines; i++) { 72 name = va_arg(args, char *); 73 val = va_arg(args, int); 74 code << "#define " << name << " " << val << "\n"; 75 } 76 va_end(args); 77 } 78 79 // Standard libCEED definitions for HIP backends 80 CeedCallBackend(CeedGetJitAbsolutePath(ceed, "ceed/jit-source/hip/hip-jit.h", &jit_defs_path)); 81 CeedCallBackend(CeedLoadSourceToBuffer(ceed, jit_defs_path, &jit_defs_source)); 82 code << jit_defs_source; 83 code << "\n\n"; 84 CeedCallBackend(CeedFree(&jit_defs_path)); 85 CeedCallBackend(CeedFree(&jit_defs_source)); 86 87 // Non-macro options 88 CeedCallBackend(CeedCalloc(num_opts, &opts)); 89 opts[0] = "-default-device"; 90 CeedCallBackend(CeedGetData(ceed, (void **)&ceed_data)); 91 CeedCallHip(ceed, hipGetDeviceProperties(&prop, ceed_data->device_id)); 92 std::string arch_arg = "--gpu-architecture=" + std::string(prop.gcnArchName); 93 opts[1] = arch_arg.c_str(); 94 opts[2] = "-munsafe-fp-atomics"; 95 opts[3] = "-DCEED_RUNNING_JIT_PASS=1"; 96 { 97 const char **jit_source_dirs; 98 99 CeedCallBackend(CeedGetJitSourceRoots(ceed, &num_jit_source_dirs, &jit_source_dirs)); 100 CeedCallBackend(CeedRealloc(num_opts + num_jit_source_dirs, &opts)); 101 for (CeedInt i = 0; i < num_jit_source_dirs; i++) { 102 std::ostringstream include_dirs_arg; 103 104 include_dirs_arg << "-I" << jit_source_dirs[i]; 105 CeedCallBackend(CeedStringAllocCopy(include_dirs_arg.str().c_str(), (char **)&opts[num_opts + i])); 106 } 107 CeedCallBackend(CeedRestoreJitSourceRoots(ceed, &jit_source_dirs)); 108 } 109 110 // Add string source argument provided in call 111 code << source; 112 113 // Create Program 114 CeedCallHiprtc(ceed, hiprtcCreateProgram(&prog, code.str().c_str(), NULL, 0, NULL, NULL)); 115 116 // Compile kernel 117 hiprtcResult result = hiprtcCompileProgram(prog, num_opts + num_jit_source_dirs, opts); 118 119 for (CeedInt i = 0; i < num_jit_source_dirs; i++) { 120 CeedCallBackend(CeedFree(&opts[num_opts + i])); 121 } 122 CeedCallBackend(CeedFree(&opts)); 123 if (result != HIPRTC_SUCCESS) { 124 size_t log_size; 125 char *log; 126 127 CeedDebug256(ceed, CEED_DEBUG_COLOR_ERROR, "---------- CEED JIT SOURCE FAILED TO COMPILE ----------\n"); 128 CeedDebug(ceed, "Source:\n%s\n", code.str().c_str()); 129 CeedDebug256(ceed, CEED_DEBUG_COLOR_ERROR, "---------- CEED JIT SOURCE FAILED TO COMPILE ----------\n"); 130 CeedChk_hiprtc(ceed, hiprtcGetProgramLogSize(prog, &log_size)); 131 CeedCallBackend(CeedMalloc(log_size, &log)); 132 CeedCallHiprtc(ceed, hiprtcGetProgramLog(prog, log)); 133 return CeedError(ceed, CEED_ERROR_BACKEND, "%s\n%s", hiprtcGetErrorString(result), log); 134 } 135 136 CeedCallHiprtc(ceed, hiprtcGetCodeSize(prog, &ptx_size)); 137 CeedCallBackend(CeedMalloc(ptx_size, &ptx)); 138 CeedCallHiprtc(ceed, hiprtcGetCode(prog, ptx)); 139 CeedCallHiprtc(ceed, hiprtcDestroyProgram(&prog)); 140 141 CeedCallHip(ceed, hipModuleLoadData(module, ptx)); 142 CeedCallBackend(CeedFree(&ptx)); 143 return CEED_ERROR_SUCCESS; 144 } 145 146 //------------------------------------------------------------------------------ 147 // Get HIP kernel 148 //------------------------------------------------------------------------------ 149 int CeedGetKernel_Hip(Ceed ceed, hipModule_t module, const char *name, hipFunction_t *kernel) { 150 CeedCallHip(ceed, hipModuleGetFunction(kernel, module, name)); 151 return CEED_ERROR_SUCCESS; 152 } 153 154 //------------------------------------------------------------------------------ 155 // Run HIP kernel 156 //------------------------------------------------------------------------------ 157 int CeedRunKernel_Hip(Ceed ceed, hipFunction_t kernel, const int grid_size, const int block_size, void **args) { 158 CeedCallHip(ceed, hipModuleLaunchKernel(kernel, grid_size, 1, 1, block_size, 1, 1, 0, NULL, args, NULL)); 159 return CEED_ERROR_SUCCESS; 160 } 161 162 //------------------------------------------------------------------------------ 163 // Run HIP kernel for spatial dimension 164 //------------------------------------------------------------------------------ 165 int CeedRunKernelDim_Hip(Ceed ceed, hipFunction_t kernel, const int grid_size, const int block_size_x, const int block_size_y, const int block_size_z, 166 void **args) { 167 CeedCallHip(ceed, hipModuleLaunchKernel(kernel, grid_size, 1, 1, block_size_x, block_size_y, block_size_z, 0, NULL, args, NULL)); 168 return CEED_ERROR_SUCCESS; 169 } 170 171 //------------------------------------------------------------------------------ 172 // Run HIP kernel for spatial dimension with shared memory 173 //------------------------------------------------------------------------------ 174 int CeedRunKernelDimShared_Hip(Ceed ceed, hipFunction_t kernel, const int grid_size, const int block_size_x, const int block_size_y, 175 const int block_size_z, const int shared_mem_size, void **args) { 176 CeedCallHip(ceed, hipModuleLaunchKernel(kernel, grid_size, 1, 1, block_size_x, block_size_y, block_size_z, shared_mem_size, NULL, args, NULL)); 177 return CEED_ERROR_SUCCESS; 178 } 179 180 //------------------------------------------------------------------------------ 181