ai.rapids.cudf

Class Cuda

java.lang.Object

ai.rapids.cudf.Cuda

public class Cuda
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cuda.Event
static class	Cuda.Stream A class representing a CUDA stream

Field Summary

Fields

Modifier and Type	Field and Description
static Cuda.Stream	DEFAULT_STREAM

Constructor Summary

Constructors

Constructor and Description
Cuda()

Method Summary

Modifier and Type	Method and Description
static void	asyncMemset(long dst, byte value, long count) Sets count bytes starting at the memory area pointed to by dst, with value.
static void	autoSetDevice() Set the device for this thread to the appropriate one.
static void	freeZero() Calls cudaFree(0).
static int	getDevice() Get the id of the current device.
static int	getDeviceCount() Get the device count.
static boolean	isEnvCompatibleForTesting() This should only be used for tests, to enable or disable tests if the current environment is not compatible with this version of the library.
static boolean	isPtdsEnabled() Whether per-thread default stream is enabled.
static CudaMemInfo	memGetInfo() Mapping: cudaMemGetInfo(size_t *free, size_t *total)
static void	memset(long dst, byte value, long count) Sets count bytes starting at the memory area pointed to by dst, with value.
static void	setDevice(int device) Set the id of the current device.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STREAM

public static final Cuda.Stream DEFAULT_STREAM

Constructor Detail

Cuda

public Cuda()

Method Detail

memGetInfo

public static CudaMemInfo memGetInfo()
                              throws CudaException

Mapping: cudaMemGetInfo(size_t *free, size_t *total)

Throws:

CudaException

memset

public static void memset(long dst,
                          byte value,
                          long count)
                   throws CudaException

Sets count bytes starting at the memory area pointed to by dst, with value. The operation has completed when this returns, but it could overlap with operations occurring on other streams.

Parameters:

dst - - Destination memory address

value - - Byte value to set dst with

count - - Size in bytes to set

Throws:

CudaException

asyncMemset

public static void asyncMemset(long dst,
                               byte value,
                               long count)
                        throws CudaException

Sets count bytes starting at the memory area pointed to by dst, with value. The operation has not necessarily completed when this returns, but it could overlap with operations occurring on other streams.

Parameters:

dst - - Destination memory address

value - - Byte value to set dst with

count - - Size in bytes to set

Throws:

CudaException

getDevice

public static int getDevice()
                     throws CudaException

Get the id of the current device.

Returns:

the id of the current device

Throws:

CudaException - on any error

getDeviceCount

public static int getDeviceCount()
                          throws CudaException

Get the device count.

Returns:

returns the number of compute-capable devices

Throws:

CudaException - on any error

setDevice

public static void setDevice(int device)
                      throws CudaException,
                             CudfException

Set the id of the current device.

Note this is relative to CUDA_SET_VISIBLE_DEVICES, e.g. if CUDA_SET_VISIBLE_DEVICES=1,0, and you call setDevice(0), you will get device 1.

Note if RMM has been initialized and the requested device ID does not match the device used to initialize RMM then this will throw an error.

Throws:

CudaException - on any error

CudfException

autoSetDevice

public static void autoSetDevice()
                          throws CudaException

Set the device for this thread to the appropriate one. Java loves threads, but cuda requires each thread to have the device set explicitly or it falls back to CUDA_VISIBLE_DEVICES. Most JNI calls through the cudf API will do this for you, but if you are writing your own JNI calls that extend cudf you might want to call this before calling into your JNI APIs to ensure that the device is set correctly.

Throws:

CudaException - on any error

freeZero

public static void freeZero()
                     throws CudaException

Calls cudaFree(0). This can be used to initialize the GPU after a setDevice()

Throws:

CudaException - on any error

isEnvCompatibleForTesting

public static boolean isEnvCompatibleForTesting()

This should only be used for tests, to enable or disable tests if the current environment is not compatible with this version of the library. Currently it only does some very basic checks, but these may be expanded in the future depending on needs.

Returns:

true if it is compatible else false.

isPtdsEnabled

public static boolean isPtdsEnabled()

Whether per-thread default stream is enabled.