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

• include
• hip

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 _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 }

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.