jcuda.nvrtc

Class JNvrtc

java.lang.Object

jcuda.nvrtc.JNvrtc

public class JNvrtc
extends Object

Java bindings for NVRTC, the NVIDIA CUDA RunTime Compiler

Method Summary

Modifier and Type	Method and Description
static int	nvrtcAddNameExpression(nvrtcProgram prog, String name_expression) Notes the given name expression denoting a __global__ function or function template instantiation.
static int	nvrtcCompileProgram(nvrtcProgram prog, int numOptions, String[] options) Compiles the given program.
static int	nvrtcCreateProgram(nvrtcProgram prog, String src, String name, int numHeaders, String[] headers, String[] includeNames) Creates an instance of nvrtcProgram with the given input parameters, and sets the output parameter prog with it.
static int	nvrtcDestroyProgram(nvrtcProgram prog) Destroys the given program.
static String	nvrtcGetErrorString(int result) A helper function that returns a string describing the given nvrtcResult code, e.g., NVRTC_SUCCESS to "NVRTC_SUCCESS".
static int	nvrtcGetLoweredName(nvrtcProgram prog, String name_expression, String[] lowered_name) Extracts the lowered (mangled) name for a __global__ function or function template instantiation, and updates *lowered_name to point to it.
static int	nvrtcGetProgramLog(nvrtcProgram prog, String[] log) Stores the log generated by the previous compilation of prog in the memory pointed by log.
static int	nvrtcGetProgramLogSize(nvrtcProgram prog, long[] logSizeRet) Sets logSizeRet with the size of the log generated by the previous compilation of prog (including the trailing NULL)
static int	nvrtcGetPTX(nvrtcProgram prog, String[] ptx) Stores the PTX generated by the previous compilation of prog in the memory pointed by ptx.
static int	nvrtcGetPTXSize(nvrtcProgram prog, long[] ptxSizeRet) Sets ptxSizeRet with the size of the PTX generated by the previous compilation of prog (including the trailing NULL).
static int	nvrtcVersion(int[] major, int[] minor) Sets the output parameters major and minor with the CUDA Runtime Compilation version number.
static void	setExceptionsEnabled(boolean enabled) Enables or disables exceptions.
static void	setLogLevel(LogLevel logLevel) Set the specified log level for the JNvrtc library.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setLogLevel

public static void setLogLevel(LogLevel logLevel)

Set the specified log level for the JNvrtc library.

Currently supported log levels:
LOG_QUIET: Never print anything
LOG_ERROR: Print error messages
LOG_TRACE: Print a trace of all native function calls

Parameters:

logLevel - The log level to use.

setExceptionsEnabled

public static void setExceptionsEnabled(boolean enabled)

Enables or disables exceptions. By default, the methods of this class only return the nvrtcResult error code from the underlying CUDA function. If exceptions are enabled, a CudaException with a detailed error message will be thrown if a method is about to return a result code that is not nvrtcResult.NVRTC_SUCCESS

Parameters:

enabled - Whether exceptions are enabled

nvrtcGetErrorString

public static String nvrtcGetErrorString(int result)

A helper function that returns a string describing the given nvrtcResult code, e.g., NVRTC_SUCCESS to "NVRTC_SUCCESS". For unrecognized enumeration values, it returns "NVRTC_ERROR unknown".

Parameters:

result - CUDA Runtime Compilation API result code.

Returns:

Message string for the given nvrtcResult code.

nvrtcVersion

public static int nvrtcVersion(int[] major,
                               int[] minor)

Sets the output parameters major and minor with the CUDA Runtime Compilation version number.

Parameters:

major - CUDA Runtime Compilation major version number.

minor - CUDA Runtime Compilation minor version number.

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_INVALID_INPUT

nvrtcCreateProgram

public static int nvrtcCreateProgram(nvrtcProgram prog,
                                     String src,
                                     String name,
                                     int numHeaders,
                                     String[] headers,
                                     String[] includeNames)

Creates an instance of nvrtcProgram with the given input parameters, and sets the output parameter prog with it.

Parameters:

prog - CUDA Runtime Compilation program.

src - CUDA program source.

name - CUDA program name. name can be NULL; "default_program" is used when name is NULL.

numHeaders - Number of headers used. numHeaders must be greater than or equal to 0.

headers - Sources of the headers. headers can be NULL when numHeaders is 0.

includeNames - Name of each header by which they can be included in the CUDA program source. includeNames can be NULL when numHeaders is 0.

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_OUT_OF_MEMORY, NVRTC_ERROR_PROGRAM_CREATION_FAILURE, NVRTC_ERROR_INVALID_INPUT, NVRTC_ERROR_INVALID_PROGRAM

nvrtcDestroyProgram

public static int nvrtcDestroyProgram(nvrtcProgram prog)

Destroys the given program.

Parameters:

prog - CUDA Runtime Compilation program.

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_INVALID_PROGRAM

nvrtcCompileProgram

public static int nvrtcCompileProgram(nvrtcProgram prog,
                                      int numOptions,
                                      String[] options)

Compiles the given program. See the Supported Compile Options (external site)

Parameters:

prog - CUDA Runtime Compilation program.

numOptions - The number of options

options - The options

Returns:

An error code

nvrtcGetPTXSize

public static int nvrtcGetPTXSize(nvrtcProgram prog,
                                  long[] ptxSizeRet)

Sets ptxSizeRet with the size of the PTX generated by the previous compilation of prog (including the trailing NULL).

Parameters:

prog - CUDA Runtime Compilation program.

ptxSizeRetSize - of the generated PTX (including the trailing NULL).

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_INVALID_INPUT, NVRTC_ERROR_INVALID_PROGRAM

See Also:

nvrtcGetPTX(nvrtcProgram, String[])

nvrtcGetPTX

public static int nvrtcGetPTX(nvrtcProgram prog,
                              String[] ptx)

Stores the PTX generated by the previous compilation of prog in the memory pointed by ptx.

Parameters:

prog - CUDA Runtime Compilation program.

ptx - Compiled result

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_INVALID_INPUT, NVRTC_ERROR_INVALID_PROGRAM

See Also:

nvrtcGetPTXSize(nvrtcProgram, long[])

nvrtcGetProgramLogSize

public static int nvrtcGetProgramLogSize(nvrtcProgram prog,
                                         long[] logSizeRet)

Sets logSizeRet with the size of the log generated by the previous compilation of prog (including the trailing NULL)

Parameters:

prog - CUDA Runtime Compilation program.

logSizeRet - Size of the compilation log (including the trailing NULL).

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_INVALID_INPUT NVRTC_ERROR_INVALID_PROGRAM

See Also:

nvrtcGetProgramLog(nvrtcProgram, String[])

nvrtcGetProgramLog

public static int nvrtcGetProgramLog(nvrtcProgram prog,
                                     String[] log)

Stores the log generated by the previous compilation of prog in the memory pointed by log.

Parameters:

prog - CUDA Runtime Compilation program.

log - Compilation log

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_INVALID_INPUT, NVRTC_ERROR_INVALID_PROGRAM

See Also:

nvrtcGetProgramLogSize(nvrtcProgram, long[])

nvrtcAddNameExpression

public static int nvrtcAddNameExpression(nvrtcProgram prog,
                                         String name_expression)

Notes the given name expression denoting a __global__ function or function template instantiation.

The identical name expression string must be provided on a subsequent call to nvrtcGetLoweredName to extract the lowered name.

Parameters:

prog - CUDA Runtime Compilation program.

name_expression - constant expression denoting a __global__ function or function template instantiation.

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION

See Also:

nvrtcGetLoweredName(jcuda.nvrtc.nvrtcProgram, java.lang.String, java.lang.String[])

nvrtcGetLoweredName

public static int nvrtcGetLoweredName(nvrtcProgram prog,
                                      String name_expression,
                                      String[] lowered_name)

Extracts the lowered (mangled) name for a __global__ function or function template instantiation, and updates *lowered_name to point to it. The memory containing the name is released when the NVRTC program is destroyed by nvrtcDestroyProgram.

The identical name expression must have been previously provided to nvrtcAddNameExpression.

Parameters:

prog - CUDA Runtime Compilation program.

name_expression - constant expression denoting a __global__ function or function template instantiation.

lowered_name - initialized by the function to point to a C string containing the lowered (mangled) name corresponding to the provided name expression.

Returns:

NVRTC_SUCCESS, NVRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION, NVRTC_ERROR_NAME_EXPRESSION_NOT_VALID

See Also:

nvrtcAddNameExpression(jcuda.nvrtc.nvrtcProgram, java.lang.String)