HIP: Heterogenous-computing Interface for Portability
hiprtc.h
1 /*
2 Copyright (c) 2015 - 2023 Advanced Micro Devices, Inc. All rights reserved.
3 
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10 
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13 
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 THE SOFTWARE.
21 */
22 #pragma once
23 
24 #include <hip/hip_common.h>
25 
26 #if !(defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && \
27  (defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
28 #include <hip/nvidia_detail/nvidia_hiprtc.h>
29 #elif (defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && \
30  !(defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
31 
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif /* __cplusplus */
36 
37 #include <stdlib.h>
38 
39 #if !defined(_WIN32)
40 #pragma GCC visibility push(default)
41 #endif
42 
52 typedef enum hiprtcResult {
67 
72 typedef enum hiprtcJIT_option {
81  HIPRTC_JIT_TARGET_FROM_HIPCONTEXT,
99  HIPRTC_JIT_IR_TO_ISA_OPT_EXT = 10000, //< AMD only. Linker options to be passed on to
100  HIPRTC_JIT_IR_TO_ISA_OPT_COUNT_EXT, //< AMD only. Count of linker options
102 
106 typedef enum hiprtcJITInputType {
117  HIPRTC_JIT_NUM_INPUT_TYPES = (HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES + 3)
127 typedef struct ihiprtcLinkState* hiprtcLinkState;
141 const char* hiprtcGetErrorString(hiprtcResult result);
142 
151 hiprtcResult hiprtcVersion(int* major, int* minor);
156 typedef struct _hiprtcProgram* hiprtcProgram;
157 
171  const char* name_expression);
172 
188  int numOptions,
189  const char** options);
190 
211 hiprtcResult hiprtcCreateProgram(hiprtcProgram* prog,
212  const char* src,
213  const char* name,
214  int numHeaders,
215  const char** headers,
216  const char** includeNames);
217 
228 hiprtcResult hiprtcDestroyProgram(hiprtcProgram* prog);
229 
248  const char* name_expression,
249  const char** lowered_name);
250 
260 hiprtcResult hiprtcGetProgramLog(hiprtcProgram prog, char* log);
261 
271 hiprtcResult hiprtcGetProgramLogSize(hiprtcProgram prog,
272  size_t* logSizeRet);
273 
283 hiprtcResult hiprtcGetCode(hiprtcProgram prog, char* code);
284 
294 hiprtcResult hiprtcGetCodeSize(hiprtcProgram prog, size_t* codeSizeRet);
295 
305 hiprtcResult hiprtcGetBitcode(hiprtcProgram prog, char* bitcode);
306 
317 hiprtcResult hiprtcGetBitcodeSize(hiprtcProgram prog, size_t* bitcode_size);
318 
331 hiprtcResult hiprtcLinkCreate(unsigned int num_options, hiprtcJIT_option* option_ptr,
332  void** option_vals_pptr, hiprtcLinkState* hip_link_state_ptr);
333 
352 hiprtcResult hiprtcLinkAddFile(hiprtcLinkState hip_link_state, hiprtcJITInputType input_type,
353  const char* file_path, unsigned int num_options,
354  hiprtcJIT_option* options_ptr, void** option_values);
355 
376 hiprtcResult hiprtcLinkAddData(hiprtcLinkState hip_link_state, hiprtcJITInputType input_type,
377  void* image, size_t image_size, const char* name,
378  unsigned int num_options, hiprtcJIT_option* options_ptr,
379  void** option_values);
380 
395 hiprtcResult hiprtcLinkComplete(hiprtcLinkState hip_link_state, void** bin_out, size_t* size_out);
396 
406 hiprtcResult hiprtcLinkDestroy(hiprtcLinkState hip_link_state);
407 
408 #if !defined(_WIN32)
409 #pragma GCC visibility pop
410 #endif
411 
412 #ifdef __cplusplus
413 }
414 #endif /* __cplusplus */
415 
416 #else
417 #error("Must define exactly one of __HIP_PLATFORM_AMD__ or __HIP_PLATFORM_NVIDIA__");
418 #endif
hiprtcGetProgramLog
hiprtcResult hiprtcGetProgramLog(hiprtcProgram prog, char *log)
Gets the log generated by the runtime compilation program instance.
HIPRTC_JIT_INPUT_CUBIN
@ HIPRTC_JIT_INPUT_CUBIN
Input cubin.
Definition: hiprtc.h:107
HIPRTC_JIT_GENERATE_LINE_INFO
@ HIPRTC_JIT_GENERATE_LINE_INFO
Generate line information.
Definition: hiprtc.h:86
hiprtcLinkDestroy
hiprtcResult hiprtcLinkDestroy(hiprtcLinkState hip_link_state)
Deletes the link instance via hiprtc APIs.
HIPRTC_ERROR_LINKING
@ HIPRTC_ERROR_LINKING
Error in linking.
Definition: hiprtc.h:65
HIPRTC_JIT_MAX_REGISTERS
@ HIPRTC_JIT_MAX_REGISTERS
Maximum registers.
Definition: hiprtc.h:73
hiprtcResult
hiprtcResult
Definition: hiprtc.h:52
HIPRTC_JIT_LOG_VERBOSE
@ HIPRTC_JIT_LOG_VERBOSE
Log verbose.
Definition: hiprtc.h:85
HIPRTC_ERROR_NAME_EXPRESSION_NOT_VALID
@ HIPRTC_ERROR_NAME_EXPRESSION_NOT_VALID
Invalid name expression.
Definition: hiprtc.h:63
HIPRTC_JIT_LTO
@ HIPRTC_JIT_LTO
LTO.
Definition: hiprtc.h:93
hiprtcVersion
hiprtcResult hiprtcVersion(int *major, int *minor)
Sets the parameters as major and minor version.
HIPRTC_JIT_FMA
@ HIPRTC_JIT_FMA
FMA.
Definition: hiprtc.h:97
HIPRTC_JIT_INPUT_FATBINARY
@ HIPRTC_JIT_INPUT_FATBINARY
Input fat binary.
Definition: hiprtc.h:109
HIPRTC_JIT_INPUT_NVVM
@ HIPRTC_JIT_INPUT_NVVM
Input NVVM.
Definition: hiprtc.h:112
hiprtcAddNameExpression
hiprtcResult hiprtcAddNameExpression(hiprtcProgram prog, const char *name_expression)
Adds the given name exprssion to the runtime compilation program.
HIPRTC_JIT_GLOBAL_SYMBOL_NAMES
@ HIPRTC_JIT_GLOBAL_SYMBOL_NAMES
Global symbol names.
Definition: hiprtc.h:90
HIPRTC_JIT_FTZ
@ HIPRTC_JIT_FTZ
FTZ.
Definition: hiprtc.h:94
hiprtcCreateProgram
hiprtcResult hiprtcCreateProgram(hiprtcProgram *prog, const char *src, const char *name, int numHeaders, const char **headers, const char **includeNames)
Creates an instance of hiprtcProgram with the given input parameters, and sets the output hiprtcProgr...
HIPRTC_ERROR_INVALID_INPUT
@ HIPRTC_ERROR_INVALID_INPUT
Invalid input.
Definition: hiprtc.h:56
HIPRTC_JIT_INPUT_LLVM_ARCHIVES_OF_BUNDLED_BITCODE
@ HIPRTC_JIT_INPUT_LLVM_ARCHIVES_OF_BUNDLED_BITCODE
LLVM archives of boundled bitcode.
Definition: hiprtc.h:116
HIPRTC_JIT_INPUT_OBJECT
@ HIPRTC_JIT_INPUT_OBJECT
Input object.
Definition: hiprtc.h:110
hiprtcGetBitcodeSize
hiprtcResult hiprtcGetBitcodeSize(hiprtcProgram prog, size_t *bitcode_size)
Gets the size of compiled bitcode by the runtime compilation program instance.
HIPRTC_JIT_GENERATE_DEBUG_INFO
@ HIPRTC_JIT_GENERATE_DEBUG_INFO
Generate debug information.
Definition: hiprtc.h:84
HIPRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION
@ HIPRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION
No lowered names before compilation.
Definition: hiprtc.h:62
HIPRTC_JIT_CACHE_MODE
@ HIPRTC_JIT_CACHE_MODE
Cache mode.
Definition: hiprtc.h:87
HIPRTC_ERROR_INVALID_PROGRAM
@ HIPRTC_ERROR_INVALID_PROGRAM
Invalid program.
Definition: hiprtc.h:57
hiprtcLinkCreate
hiprtcResult hiprtcLinkCreate(unsigned int num_options, hiprtcJIT_option *option_ptr, void **option_vals_pptr, hiprtcLinkState *hip_link_state_ptr)
Creates the link instance via hiprtc APIs.
HIPRTC_JIT_GLOBAL_SYMBOL_ADDRESS
@ HIPRTC_JIT_GLOBAL_SYMBOL_ADDRESS
Global symbol address.
Definition: hiprtc.h:91
hiprtcLinkAddFile
hiprtcResult hiprtcLinkAddFile(hiprtcLinkState hip_link_state, hiprtcJITInputType input_type, const char *file_path, unsigned int num_options, hiprtcJIT_option *options_ptr, void **option_values)
Adds a file with bit code to be linked with options.
HIPRTC_ERROR_BUILTIN_OPERATION_FAILURE
@ HIPRTC_ERROR_BUILTIN_OPERATION_FAILURE
Failed in builtin operation.
Definition: hiprtc.h:60
hiprtcJIT_option
hiprtcJIT_option
Definition: hiprtc.h:72
HIPRTC_JIT_INPUT_PTX
@ HIPRTC_JIT_INPUT_PTX
Input PTX.
Definition: hiprtc.h:108
hiprtcJITInputType
hiprtcJITInputType
Definition: hiprtc.h:106
HIPRTC_JIT_INPUT_LIBRARY
@ HIPRTC_JIT_INPUT_LIBRARY
Input library.
Definition: hiprtc.h:111
hiprtcCompileProgram
hiprtcResult hiprtcCompileProgram(hiprtcProgram prog, int numOptions, const char **options)
Compiles the given runtime compilation program.
HIPRTC_JIT_WALL_TIME
@ HIPRTC_JIT_WALL_TIME
Time from aall clock.
Definition: hiprtc.h:75
HIPRTC_JIT_ERROR_LOG_BUFFER_SIZE_BYTES
@ HIPRTC_JIT_ERROR_LOG_BUFFER_SIZE_BYTES
Log buffer size in bytes.
Definition: hiprtc.h:79
hiprtcGetCode
hiprtcResult hiprtcGetCode(hiprtcProgram prog, char *code)
Gets the pointer of compilation binary by the runtime compilation program instance.
HIPRTC_JIT_INPUT_LLVM_BUNDLED_BITCODE
@ HIPRTC_JIT_INPUT_LLVM_BUNDLED_BITCODE
LLVM bundled bitcode.
Definition: hiprtc.h:115
HIPRTC_JIT_PREC_SQRT
@ HIPRTC_JIT_PREC_SQRT
PREC_SQRT.
Definition: hiprtc.h:96
HIPRTC_JIT_GLOBAL_SYMBOL_COUNT
@ HIPRTC_JIT_GLOBAL_SYMBOL_COUNT
Global symbol count.
Definition: hiprtc.h:92
HIPRTC_JIT_INFO_LOG_BUFFER
@ HIPRTC_JIT_INFO_LOG_BUFFER
Log buffer info.
Definition: hiprtc.h:76
HIPRTC_JIT_PREC_DIV
@ HIPRTC_JIT_PREC_DIV
Prec_VIV.
Definition: hiprtc.h:95
HIPRTC_ERROR_COMPILATION
@ HIPRTC_ERROR_COMPILATION
Compilation error.
Definition: hiprtc.h:59
HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES
@ HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES
Number of legacy input type.
Definition: hiprtc.h:113
HIPRTC_JIT_INFO_LOG_BUFFER_SIZE_BYTES
@ HIPRTC_JIT_INFO_LOG_BUFFER_SIZE_BYTES
Log buffer size in bytes.
Definition: hiprtc.h:77
HIPRTC_JIT_TARGET
@ HIPRTC_JIT_TARGET
JIT target.
Definition: hiprtc.h:82
HIPRTC_JIT_THREADS_PER_BLOCK
@ HIPRTC_JIT_THREADS_PER_BLOCK
Thread per block.
Definition: hiprtc.h:74
hiprtcGetErrorString
const char * hiprtcGetErrorString(hiprtcResult result)
Returns text string message to explain the error which occurred.
HIPRTC_ERROR_INVALID_OPTION
@ HIPRTC_ERROR_INVALID_OPTION
Invalid option.
Definition: hiprtc.h:58
hiprtcLinkAddData
hiprtcResult hiprtcLinkAddData(hiprtcLinkState hip_link_state, hiprtcJITInputType input_type, void *image, size_t image_size, const char *name, unsigned int num_options, hiprtcJIT_option *options_ptr, void **option_values)
Completes the linking of the given program.
HIPRTC_JIT_NUM_OPTIONS
@ HIPRTC_JIT_NUM_OPTIONS
Number of options.
Definition: hiprtc.h:98
hiprtcGetLoweredName
hiprtcResult hiprtcGetLoweredName(hiprtcProgram prog, const char *name_expression, const char **lowered_name)
Gets the lowered (mangled) name from an instance of hiprtcProgram with the given input parameters,...
HIPRTC_JIT_FAST_COMPILE
@ HIPRTC_JIT_FAST_COMPILE
Fast compile.
Definition: hiprtc.h:89
HIPRTC_ERROR_PROGRAM_CREATION_FAILURE
@ HIPRTC_ERROR_PROGRAM_CREATION_FAILURE
Failed to create program.
Definition: hiprtc.h:55
hiprtcLinkComplete
hiprtcResult hiprtcLinkComplete(hiprtcLinkState hip_link_state, void **bin_out, size_t *size_out)
Completes the linking of the given program.
HIPRTC_JIT_INPUT_LLVM_BITCODE
@ HIPRTC_JIT_INPUT_LLVM_BITCODE
LLVM bitcode.
Definition: hiprtc.h:114
HIPRTC_JIT_NEW_SM3X_OPT
@ HIPRTC_JIT_NEW_SM3X_OPT
New SM3X option.
Definition: hiprtc.h:88
HIPRTC_ERROR_INTERNAL_ERROR
@ HIPRTC_ERROR_INTERNAL_ERROR
Internal error.
Definition: hiprtc.h:64
HIPRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION
@ HIPRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION
No name expression after compilation.
Definition: hiprtc.h:61
HIPRTC_JIT_ERROR_LOG_BUFFER
@ HIPRTC_JIT_ERROR_LOG_BUFFER
Log buffer error.
Definition: hiprtc.h:78
hiprtcDestroyProgram
hiprtcResult hiprtcDestroyProgram(hiprtcProgram *prog)
Destroys an instance of given hiprtcProgram.
HIPRTC_JIT_OPTIMIZATION_LEVEL
@ HIPRTC_JIT_OPTIMIZATION_LEVEL
Optimization level.
Definition: hiprtc.h:80
HIPRTC_ERROR_OUT_OF_MEMORY
@ HIPRTC_ERROR_OUT_OF_MEMORY
Out of memory.
Definition: hiprtc.h:54
hiprtcGetCodeSize
hiprtcResult hiprtcGetCodeSize(hiprtcProgram prog, size_t *codeSizeRet)
Gets the size of compilation binary by the runtime compilation program instance.
HIPRTC_SUCCESS
@ HIPRTC_SUCCESS
Success.
Definition: hiprtc.h:53
HIPRTC_JIT_FALLBACK_STRATEGY
@ HIPRTC_JIT_FALLBACK_STRATEGY
Fallback strategy.
Definition: hiprtc.h:83