/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-develop/include/hip/hiprtc.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-develop/include/hip/hiprtc.h Source File#

HIP Runtime API Reference: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-develop/include/hip/hiprtc.h Source File
Go to the documentation of this file.
/*
Copyright (c) 2015 - 2023 Advanced Micro Devices, Inc. All rights reserved.
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#pragma once
 
#include <hip/hip_common.h>
#include <hip/linker_types.h>
 
#if !defined(__HIP_PLATFORM_AMD__) && defined(__HIP_PLATFORM_NVIDIA__)
#include <hip/nvidia_detail/nvidia_hiprtc.h>
#elif defined(__HIP_PLATFORM_AMD__) && !defined(__HIP_PLATFORM_NVIDIA__)
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include <stdlib.h>
 
#if !defined(_WIN32)
#pragma GCC visibility push(default)
#endif
 
typedef enum hiprtcResult {
    HIPRTC_SUCCESS = 0,   
    HIPRTC_ERROR_OUT_OF_MEMORY = 1,  
    HIPRTC_ERROR_PROGRAM_CREATION_FAILURE = 2,   
    HIPRTC_ERROR_INVALID_INPUT = 3,   
    HIPRTC_ERROR_INVALID_PROGRAM = 4,   
    HIPRTC_ERROR_INVALID_OPTION = 5,   
    HIPRTC_ERROR_COMPILATION = 6,   
    HIPRTC_ERROR_BUILTIN_OPERATION_FAILURE = 7,   
    HIPRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION = 8,   
    HIPRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION = 9,   
    HIPRTC_ERROR_NAME_EXPRESSION_NOT_VALID = 10,   
    HIPRTC_ERROR_INTERNAL_ERROR = 11,   
    HIPRTC_ERROR_LINKING = 100   
} hiprtcResult;
typedef enum hiprtcResult {…};
#define hiprtcJIT_option hipJitOption
#define HIPRTC_JIT_MAX_REGISTERS hipJitOptionMaxRegisters        
#define HIPRTC_JIT_THREADS_PER_BLOCK hipJitOptionThreadsPerBlock 
#define HIPRTC_JIT_WALL_TIME hipJitOptionWallTime                
#define HIPRTC_JIT_INFO_LOG_BUFFER hipJitOptionInfoLogBuffer     
#define HIPRTC_JIT_INFO_LOG_BUFFER_SIZE_BYTES hipJitOptionInfoLogBufferSizeBytes    
#define HIPRTC_JIT_ERROR_LOG_BUFFER hipJitOptionErrorLogBuffer                      
#define HIPRTC_JIT_ERROR_LOG_BUFFER_SIZE_BYTES hipJitOptionErrorLogBufferSizeBytes  
#define HIPRTC_JIT_OPTIMIZATION_LEVEL hipJitOptionOptimizationLevel                 
#define HIPRTC_JIT_TARGET_FROM_HIPCONTEXT hipJitOptionTargetFromContext             
#define HIPRTC_JIT_TARGET hipJitOptionTarget                          
#define HIPRTC_JIT_FALLBACK_STRATEGY hipJitOptionFallbackStrategy     
#define HIPRTC_JIT_GENERATE_DEBUG_INFO hipJitOptionGenerateDebugInfo  
#define HIPRTC_JIT_LOG_VERBOSE hipJitOptionLogVerbose                 
#define HIPRTC_JIT_GENERATE_LINE_INFO hipJitOptionGenerateLineInfo    
#define HIPRTC_JIT_CACHE_MODE hipJitOptionCacheMode                   
#define HIPRTC_JIT_NEW_SM3X_OPT hipJitOptionSm3xOpt                   
#define HIPRTC_JIT_FAST_COMPILE hipJitOptionFastCompile               
#define HIPRTC_JIT_GLOBAL_SYMBOL_NAMES hipJitOptionGlobalSymbolNames  
#define HIPRTC_JIT_GLOBAL_SYMBOL_ADDRESS hipJitOptionGlobalSymbolAddresses 
#define HIPRTC_JIT_GLOBAL_SYMBOL_COUNT hipJitOptionGlobalSymbolCount       
#define HIPRTC_JIT_LTO hipJitOptionLto                                     
#define HIPRTC_JIT_FTZ hipJitOptionFtz                                     
#define HIPRTC_JIT_PREC_DIV hipJitOptionPrecDiv                            
#define HIPRTC_JIT_PREC_SQRT hipJitOptionPrecSqrt                          
#define HIPRTC_JIT_FMA hipJitOptionFma                                     
#define HIPRTC_JIT_POSITION_INDEPENDENT_CODE hipJitOptionPositionIndependentCode 
#define HIPRTC_JIT_MIN_CTA_PER_SM hipJitOptionMinCTAPerSM                        
#define HIPRTC_JIT_MAX_THREADS_PER_BLOCK hipJitOptionMaxThreadsPerBlock          
#define HIPRTC_JIT_OVERRIDE_DIRECT_VALUES hipJitOptionOverrideDirectiveValues    
#define HIPRTC_JIT_NUM_OPTIONS hipJitOptionNumOptions                            
#define HIPRTC_JIT_IR_TO_ISA_OPT_EXT hipJitOptionIRtoISAOptExt                   
#define HIPRTC_JIT_IR_TO_ISA_OPT_COUNT_EXT hipJitOptionIRtoISAOptCountExt        
 
#define hiprtcJITInputType hipJitInputType
#define HIPRTC_JIT_INPUT_CUBIN hipJitInputCubin         
#define HIPRTC_JIT_INPUT_PTX hipJitInputPtx             
#define HIPRTC_JIT_INPUT_FATBINARY hipJitInputFatBinary 
#define HIPRTC_JIT_INPUT_OBJECT hipJitInputObject       
#define HIPRTC_JIT_INPUT_LIBRARY hipJitInputLibrary     
#define HIPRTC_JIT_INPUT_NVVM hipJitInputNvvm           
#define HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES hipJitNumLegacyInputTypes         
#define HIPRTC_JIT_INPUT_LLVM_BITCODE hipJitInputLLVMBitcode                
#define HIPRTC_JIT_INPUT_LLVM_BUNDLED_BITCODE hipJitInputLLVMBundledBitcode 
#define HIPRTC_JIT_INPUT_LLVM_ARCHIVES_OF_BUNDLED_BITCODE hipJitInputLLVMArchivesOfBundledBitcode  
#define HIPRTC_JIT_INPUT_SPIRV hipJitInputSpirv         
#define HIPRTC_JIT_NUM_INPUT_TYPES hipJitNumInputTypes  
typedef struct ihiprtcLinkState* hiprtcLinkState;
const char* hiprtcGetErrorString(hiprtcResult result);
 
hiprtcResult hiprtcVersion(int* major, int* minor);
 
typedef struct _hiprtcProgram* hiprtcProgram;
 
hiprtcResult hiprtcAddNameExpression(hiprtcProgram prog,
                                     const char* name_expression);
 
hiprtcResult hiprtcCompileProgram(hiprtcProgram prog,
                                  int numOptions,
                                  const char** options);
 
hiprtcResult hiprtcCreateProgram(hiprtcProgram* prog,
                                 const char* src,
                                 const char* name,
                                 int numHeaders,
                                 const char** headers,
                                 const char** includeNames);
 
hiprtcResult hiprtcDestroyProgram(hiprtcProgram* prog);
 
hiprtcResult hiprtcGetLoweredName(hiprtcProgram prog,
                                  const char* name_expression,
                                  const char** lowered_name);
 
hiprtcResult hiprtcGetProgramLog(hiprtcProgram prog, char* log);
 
hiprtcResult hiprtcGetProgramLogSize(hiprtcProgram prog,
                                     size_t* logSizeRet);
 
hiprtcResult hiprtcGetCode(hiprtcProgram prog, char* code);
 
hiprtcResult hiprtcGetCodeSize(hiprtcProgram prog, size_t* codeSizeRet);
 
hiprtcResult hiprtcGetBitcode(hiprtcProgram prog, char* bitcode);
 
hiprtcResult hiprtcGetBitcodeSize(hiprtcProgram prog, size_t* bitcode_size);
 
hiprtcResult hiprtcLinkCreate(unsigned int num_options, hiprtcJIT_option* option_ptr,
                              void** option_vals_pptr, hiprtcLinkState* hip_link_state_ptr);
 
hiprtcResult hiprtcLinkAddFile(hiprtcLinkState hip_link_state, hiprtcJITInputType input_type,
                               const char* file_path, unsigned int num_options,
                               hiprtcJIT_option* options_ptr, void** option_values);
 
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);
 
hiprtcResult hiprtcLinkComplete(hiprtcLinkState hip_link_state, void** bin_out, size_t* size_out);
 
hiprtcResult hiprtcLinkDestroy(hiprtcLinkState hip_link_state);
 
#if !defined(_WIN32)
#pragma GCC visibility pop
#endif
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#else
#error("Must define exactly one of __HIP_PLATFORM_AMD__ or __HIP_PLATFORM_NVIDIA__");
#endif