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

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

HIP Runtime API Reference: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-5.7.0/include/hip/hiprtc.h File Reference
Typedefs | Enumerations | Functions
hiprtc.h File Reference
#include <hip/hip_common.h>
#include <stdlib.h>
Include dependency graph for hiprtc.h:

Go to the source code of this file.

Typedefs

typedef struct ihiprtcLinkState * hiprtcLinkState
 
typedef struct _hiprtcProgram * hiprtcProgram
 

Enumerations

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
}
 
enum  hiprtcJIT_option {
  HIPRTC_JIT_MAX_REGISTERS = 0 ,
  HIPRTC_JIT_THREADS_PER_BLOCK ,
  HIPRTC_JIT_WALL_TIME ,
  HIPRTC_JIT_INFO_LOG_BUFFER ,
  HIPRTC_JIT_INFO_LOG_BUFFER_SIZE_BYTES ,
  HIPRTC_JIT_ERROR_LOG_BUFFER ,
  HIPRTC_JIT_ERROR_LOG_BUFFER_SIZE_BYTES ,
  HIPRTC_JIT_OPTIMIZATION_LEVEL ,
  HIPRTC_JIT_TARGET_FROM_HIPCONTEXT ,
  HIPRTC_JIT_TARGET ,
  HIPRTC_JIT_FALLBACK_STRATEGY ,
  HIPRTC_JIT_GENERATE_DEBUG_INFO ,
  HIPRTC_JIT_LOG_VERBOSE ,
  HIPRTC_JIT_GENERATE_LINE_INFO ,
  HIPRTC_JIT_CACHE_MODE ,
  HIPRTC_JIT_NEW_SM3X_OPT ,
  HIPRTC_JIT_FAST_COMPILE ,
  HIPRTC_JIT_GLOBAL_SYMBOL_NAMES ,
  HIPRTC_JIT_GLOBAL_SYMBOL_ADDRESS ,
  HIPRTC_JIT_GLOBAL_SYMBOL_COUNT ,
  HIPRTC_JIT_LTO ,
  HIPRTC_JIT_FTZ ,
  HIPRTC_JIT_PREC_DIV ,
  HIPRTC_JIT_PREC_SQRT ,
  HIPRTC_JIT_FMA ,
  HIPRTC_JIT_NUM_OPTIONS ,
  HIPRTC_JIT_IR_TO_ISA_OPT_EXT = 10000 ,
  HIPRTC_JIT_IR_TO_ISA_OPT_COUNT_EXT
}
 
enum  hiprtcJITInputType {
  HIPRTC_JIT_INPUT_CUBIN = 0 ,
  HIPRTC_JIT_INPUT_PTX ,
  HIPRTC_JIT_INPUT_FATBINARY ,
  HIPRTC_JIT_INPUT_OBJECT ,
  HIPRTC_JIT_INPUT_LIBRARY ,
  HIPRTC_JIT_INPUT_NVVM ,
  HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES ,
  HIPRTC_JIT_INPUT_LLVM_BITCODE = 100 ,
  HIPRTC_JIT_INPUT_LLVM_BUNDLED_BITCODE = 101 ,
  HIPRTC_JIT_INPUT_LLVM_ARCHIVES_OF_BUNDLED_BITCODE = 102 ,
  HIPRTC_JIT_NUM_INPUT_TYPES = (HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES + 3)
}
 

Functions

const char * hiprtcGetErrorString (hiprtcResult result)
 Returns text string message to explain the error which occurred.
 
hiprtcResult hiprtcVersion (int *major, int *minor)
 Sets the parameters as major and minor version.
 
hiprtcResult hiprtcAddNameExpression (hiprtcProgram prog, const char *name_expression)
 Adds the given name exprssion to the runtime compilation program.
 
hiprtcResult hiprtcCompileProgram (hiprtcProgram prog, int numOptions, const char **options)
 Compiles the given runtime compilation program.
 
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 hiprtcProgram prog with it.
 
hiprtcResult hiprtcDestroyProgram (hiprtcProgram *prog)
 Destroys an instance of given hiprtcProgram.
 
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, and sets the output lowered_name with it.
 
hiprtcResult hiprtcGetProgramLog (hiprtcProgram prog, char *log)
 Gets the log generated by the runtime compilation program instance.
 
hiprtcResult hiprtcGetProgramLogSize (hiprtcProgram prog, size_t *logSizeRet)
 Gets the size of log generated by the runtime compilation program instance.
 
hiprtcResult hiprtcGetCode (hiprtcProgram prog, char *code)
 Gets the pointer of compilation binary by the runtime compilation program instance.
 
hiprtcResult hiprtcGetCodeSize (hiprtcProgram prog, size_t *codeSizeRet)
 Gets the size of compilation binary by the runtime compilation program instance.
 
hiprtcResult hiprtcGetBitcode (hiprtcProgram prog, char *bitcode)
 Gets the pointer of compiled bitcode by the runtime compilation program instance.
 
hiprtcResult hiprtcGetBitcodeSize (hiprtcProgram prog, size_t *bitcode_size)
 Gets the size of compiled bitcode by the runtime compilation program instance.
 
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.
 
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.
 
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.
 
hiprtcResult hiprtcLinkComplete (hiprtcLinkState hip_link_state, void **bin_out, size_t *size_out)
 Completes the linking of the given program.
 
hiprtcResult hiprtcLinkDestroy (hiprtcLinkState hip_link_state)
 Deletes the link instance via hiprtc APIs.
 

Typedef Documentation

◆ hiprtcLinkState

typedef struct ihiprtcLinkState* hiprtcLinkState

hiprtc link state

◆ hiprtcProgram

typedef struct _hiprtcProgram* hiprtcProgram

hiprtc program

Function Documentation

◆ hiprtcGetBitcode()

hiprtcResult hiprtcGetBitcode ( hiprtcProgram  prog,
char *  bitcode 
)

Gets the pointer of compiled bitcode by the runtime compilation program instance.

Parameters
[in]progruntime compilation program instance.
[out]bitcodechar pointer to bitcode.
Returns
HIPRTC_SUCCESS
See also
hiprtcResult

◆ hiprtcGetProgramLogSize()

hiprtcResult hiprtcGetProgramLogSize ( hiprtcProgram  prog,
size_t *  logSizeRet 
)

Gets the size of log generated by the runtime compilation program instance.

Parameters
[in]progruntime compilation program instance.
[out]logSizeRetsize of generated log.
Returns
HIPRTC_SUCCESS
See also
hiprtcResult