/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/docs-6.2.2/include/hip/hiprtc.h File Reference#
hiprtc.h File Reference
Include dependency graph for hiprtc.h:
Go to the source code of this file.
Typedefs | |
typedef struct ihiprtcLinkState * | hiprtcLinkState |
typedef struct _hiprtcProgram * | hiprtcProgram |
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] prog runtime compilation program instance. [out] bitcode char 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] prog runtime compilation program instance. [out] logSizeRet size of generated log.
- Returns
- HIPRTC_SUCCESS
- See also
- hiprtcResult