HIP: Heterogenous-computing Interface for Portability
hiprtc.h
1 /*
2 Copyright (c) 2015 - 2021 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__)) && (defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
27  #include <hip/nvidia_detail/nvidia_hiprtc.h>
28 #elif (defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__)) && !(defined(__HIP_PLATFORM_NVCC__) || defined(__HIP_PLATFORM_NVIDIA__))
29 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif /* __cplusplus */
39 
40 #include <stdlib.h>
41 
42 #if !defined(_WIN32)
43 #pragma GCC visibility push (default)
44 #endif
45 
52 typedef enum hiprtcResult {
53  HIPRTC_SUCCESS = 0,
54  HIPRTC_ERROR_OUT_OF_MEMORY = 1,
55  HIPRTC_ERROR_PROGRAM_CREATION_FAILURE = 2,
56  HIPRTC_ERROR_INVALID_INPUT = 3,
57  HIPRTC_ERROR_INVALID_PROGRAM = 4,
58  HIPRTC_ERROR_INVALID_OPTION = 5,
59  HIPRTC_ERROR_COMPILATION = 6,
60  HIPRTC_ERROR_BUILTIN_OPERATION_FAILURE = 7,
61  HIPRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION = 8,
62  HIPRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION = 9,
63  HIPRTC_ERROR_NAME_EXPRESSION_NOT_VALID = 10,
64  HIPRTC_ERROR_INTERNAL_ERROR = 11
65 } hiprtcResult;
66 
78 const char* hiprtcGetErrorString(hiprtcResult result);
79 
87 hiprtcResult hiprtcVersion(int* major, int* minor);
88 
89 typedef struct _hiprtcProgram* hiprtcProgram;
90 
102 hiprtcResult hiprtcAddNameExpression(hiprtcProgram prog,
103  const char* name_expression);
104 
118 hiprtcResult hiprtcCompileProgram(hiprtcProgram prog,
119  int numOptions,
120  const char** options);
121 
141 hiprtcResult hiprtcCreateProgram(hiprtcProgram* prog,
142  const char* src,
143  const char* name,
144  int numHeaders,
145  const char** headers,
146  const char** includeNames);
147 
158 hiprtcResult hiprtcDestroyProgram(hiprtcProgram* prog);
159 
177 hiprtcResult hiprtcGetLoweredName(hiprtcProgram prog,
178  const char* name_expression,
179  const char** lowered_name);
180 
190 hiprtcResult hiprtcGetProgramLog(hiprtcProgram prog, char* log);
191 
201 hiprtcResult hiprtcGetProgramLogSize(hiprtcProgram prog,
202  size_t* logSizeRet);
203 
213 hiprtcResult hiprtcGetCode(hiprtcProgram prog, char* code);
214 
224 hiprtcResult hiprtcGetCodeSize(hiprtcProgram prog, size_t* codeSizeRet);
225 
226 #if !defined(_WIN32)
227 #pragma GCC visibility pop
228 #endif
229 
230 #ifdef __cplusplus
231 }
232 #endif /* __cplusplus */
233 // doxygen end HIPrtc feature
237 #else
238 #error("Must define exactly one of __HIP_PLATFORM_AMD__ or __HIP_PLATFORM_NVIDIA__");
239 #endif
hiprtcGetProgramLog
hiprtcResult hiprtcGetProgramLog(hiprtcProgram prog, char *log)
Gets the log generated by the runtime compilation program instance.
hiprtcVersion
hiprtcResult hiprtcVersion(int *major, int *minor)
Sets the parameters as major and minor version.
hiprtcAddNameExpression
hiprtcResult hiprtcAddNameExpression(hiprtcProgram prog, const char *name_expression)
Adds the given name exprssion to the runtime compilation program.
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...
hiprtcCompileProgram
hiprtcResult hiprtcCompileProgram(hiprtcProgram prog, int numOptions, const char **options)
Compiles the given runtime compilation program.
hiprtcGetCode
hiprtcResult hiprtcGetCode(hiprtcProgram prog, char *code)
Gets the pointer of compilation binary by the runtime compilation program instance.
hiprtcGetErrorString
const char * hiprtcGetErrorString(hiprtcResult result)
Returns text string message to explain the error which occurred.
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,...
hiprtcDestroyProgram
hiprtcResult hiprtcDestroyProgram(hiprtcProgram *prog)
Destroys an instance of given hiprtcProgram.
hiprtcGetCodeSize
hiprtcResult hiprtcGetCodeSize(hiprtcProgram prog, size_t *codeSizeRet)
Gets the size of compilation binary by the runtime compilation program instance.
hiprtcGetProgramLogSize
hiprtcResult hiprtcGetProgramLogSize(hiprtcProgram prog, size_t *logSizeRet)
Gets the size of log generated by the runtime compilation program instance.