Cuda (cudfjni 24.12.0 API)

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

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

Fields
Modifier and Type	Field and Description
`static Cuda.Stream`	`DEFAULT_STREAM`

Constructor Summary

Constructors
Constructor and Description

Cuda()

Constructors
Constructor and Description
`Cuda()`

Method Summary

All Methods Static Methods Concrete Methods
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`	`deviceSynchronize()` Synchronizes the whole device using cudaDeviceSynchronize.
`static void`	`freeZero()` Calls cudaFree(0).
`static int`	`getComputeCapabilityMajor()` Gets the major CUDA compute capability of the current device.
`static int`	`getComputeCapabilityMinor()` Gets the minor CUDA compute capability of the current device.
`static CudaComputeMode`	`getComputeMode()` Gets the CUDA compute mode of the current device.
`static int`	`getDevice()` Get the id of the current device.
`static int`	`getDeviceCount()` Get the device count.
`static int`	`getDriverVersion()` Get the CUDA Driver version, which is the latest version of CUDA supported by the driver.
`static int`	`getRuntimeVersion()` Get the CUDA Runtime version of the current CUDA Runtime instance.
`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`	`multiBufferCopyAsync(long[] destAddrs, long[] srcAddrs, long[] copySizes, Cuda.Stream stream)` Copy data from multiple device buffer sources to multiple device buffer destinations.
`static void`	`profilerStart()` Begins an Nsight profiling session, if a profiler is currently attached.
`static void`	`profilerStop()` Stops an active Nsight profiling session.
`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
  - getComputeMode
```
public static CudaComputeMode getComputeMode()
```
    Gets the CUDA compute mode of the current device.
    
    Returns:
    
    the enum value of CudaComputeMode
  - 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
  - getDriverVersion
```
public static int getDriverVersion()
                            throws CudaException
```
    Get the CUDA Driver version, which is the latest version of CUDA supported by the driver. The version is returned as (1000 major + 10 minor). For example, CUDA 9.2 would be represented by 9020. If no driver is installed,then 0 is returned as the driver version.
    
    Returns:
    
    the CUDA driver version
    
    Throws:
    
    CudaException - on any error
  - getRuntimeVersion
```
public static int getRuntimeVersion()
                             throws CudaException
```
    Get the CUDA Runtime version of the current CUDA Runtime instance. The version is returned as (1000 major + 10 minor). For example, CUDA 9.2 would be represented by 9020.
    
    Returns:
    
    the CUDA Runtime version
    
    Throws:
    
    CudaException - on any error
  - getComputeCapabilityMajor
```
public static int getComputeCapabilityMajor()
                                     throws CudaException
```
    Gets the major CUDA compute capability of the current device. For reference: https://developer.nvidia.com/cuda-gpus Hardware Generation Compute Capability Ampere 8.x Turing 7.5 Volta 7.0, 7.2 Pascal 6.x Maxwell 5.x Kepler 3.x Fermi 2.x
    
    Returns:
    
    The Major compute capability version number of the current CUDA device
    
    Throws:
    
    CudaException - on any error
  - getComputeCapabilityMinor
```
public static int getComputeCapabilityMinor()
                                     throws CudaException
```
    Gets the minor CUDA compute capability of the current device. For reference: https://developer.nvidia.com/cuda-gpus Hardware Generation Compute Capability Ampere 8.x Turing 7.5 Volta 7.0, 7.2 Pascal 6.x Maxwell 5.x Kepler 3.x Fermi 2.x
    
    Returns:
    
    The Minor compute capability version number of the current CUDA device
    
    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.
  - multiBufferCopyAsync
```
public static void multiBufferCopyAsync(long[] destAddrs,
                                        long[] srcAddrs,
                                        long[] copySizes,
                                        Cuda.Stream stream)
```
    Copy data from multiple device buffer sources to multiple device buffer destinations. For each buffer to copy there is a corresponding entry in the destination address, source address, and copy size vectors.
    
    Parameters:
    
    destAddrs - vector of device destination addresses
    
    srcAddrs - vector of device source addresses
    
    copySizes - vector of copy sizes
    
    stream - CUDA stream to use for the copy
  - profilerStart
```
public static void profilerStart()
```
    Begins an Nsight profiling session, if a profiler is currently attached.
  - profilerStop
```
public static void profilerStop()
```
    Stops an active Nsight profiling session.
  - deviceSynchronize
```
public static void deviceSynchronize()
```
    Synchronizes the whole device using cudaDeviceSynchronize.

Class Cuda

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_STREAM

Constructor Detail

Cuda

Method Detail

getComputeMode

memGetInfo

memset

asyncMemset

getDevice

getDeviceCount

setDevice

autoSetDevice

getDriverVersion

getRuntimeVersion

getComputeCapabilityMajor

getComputeCapabilityMinor

freeZero

isEnvCompatibleForTesting

isPtdsEnabled

multiBufferCopyAsync

profilerStart

profilerStop

deviceSynchronize