org.apache.sysml.runtime.instructions.gpu.context

Class GPUContext

java.lang.Object

org.apache.sysml.runtime.instructions.gpu.context.GPUContext

public class GPUContext
extends Object

Represents a context per GPU accessible through the same JVM. Each context holds cublas, cusparse, cudnn... handles which are separate for each GPU.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GPUContext(int deviceNum)

Method Summary

Modifier and Type	Method and Description
jcuda.Pointer	allocate(long size) Convenience method for allocate(String, long).
jcuda.Pointer	allocate(String instructionName, long size) Invokes memory manager's malloc method
void	clearMemory() Clears all memory used by this GPUContext.
void	clearTemporaryMemory()
GPUObject	createGPUObject(org.apache.sysml.runtime.controlprogram.caching.MatrixObject mo) Instantiates a new GPUObject initialized with the given MatrixObject.
void	cudaFreeHelper(jcuda.Pointer toFree) Does lazy cudaFree calls.
void	cudaFreeHelper(jcuda.Pointer toFree, boolean eager) Does lazy/eager cudaFree calls.
void	cudaFreeHelper(String instructionName, jcuda.Pointer toFree) Does lazy cudaFree calls.
void	cudaFreeHelper(String instructionName, jcuda.Pointer toFree, boolean eager) Does cudaFree calls, lazily.
static int	cudaGetDevice() Returns which device is currently being used.
void	destroy() Destroys this GPUContext object.
void	ensureComputeCapability() Makes sure that GPU that SystemML is trying to use has the minimum compute capability needed.
long	getAvailableMemory() Gets the available memory on GPU that SystemML can use.
jcuda.jcublas.cublasHandle	getCublasHandle() Returns cublasHandle for BLAS operations on the GPU.
jcuda.jcudnn.cudnnHandle	getCudnnHandle() Returns the cudnnHandle for Deep Neural Network operations on the GPU.
jcuda.jcusolver.cusolverDnHandle	getCusolverDnHandle() Returns cusolverDnHandle for invoking solve() function on dense matrices on the GPU.
jcuda.jcusparse.cusparseHandle	getCusparseHandle() Returns cusparseHandle for certain sparse BLAS operations on the GPU.
int	getDeviceNum() Returns which device is assigned to this GPUContext instance.
jcuda.runtime.cudaDeviceProp	getGPUProperties() Gets the device properties for the active GPU (set with cudaSetDevice()).
JCudaKernels	getKernels() Returns utility class used to launch custom CUDA kernel, specific to the active GPU for this GPUContext.
int	getMaxBlocks() Gets the maximum number of blocks supported by the active cuda device.
long	getMaxSharedMemory() Gets the shared memory per block supported by the active cuda device.
int	getMaxThreadsPerBlock() Gets the maximum number of threads per block for "active" GPU.
GPUMemoryManager	getMemoryManager()
int	getWarpSize() Gets the warp size supported by the active cuda device.
void	initializeThread() Sets the device for the calling thread.
void	printMemoryInfo(String opcode) Print information of memory usage.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

Constructor Detail

GPUContext

protected GPUContext(int deviceNum)
              throws DMLRuntimeException

Throws:

DMLRuntimeException

Method Detail

getMemoryManager

public GPUMemoryManager getMemoryManager()

cudaGetDevice

public static int cudaGetDevice()

Returns which device is currently being used.

Returns:

the current device for the calling host thread

printMemoryInfo

public void printMemoryInfo(String opcode)
                     throws DMLRuntimeException

Print information of memory usage.

Parameters:

opcode - opcode of caller

Throws:

DMLRuntimeException - if error

getDeviceNum

public int getDeviceNum()

Returns which device is assigned to this GPUContext instance.

Returns:

active device assigned to this GPUContext instance

initializeThread

public void initializeThread()
                      throws DMLRuntimeException

Sets the device for the calling thread. This method must be called after ExecutionContext.getGPUContext(int) If in a multi-threaded environment like parfor, this method must be called when in the appropriate thread.

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

allocate

public jcuda.Pointer allocate(long size)
                       throws DMLRuntimeException

Convenience method for allocate(String, long).

Parameters:

size - size of data (in bytes) to allocate

Returns:

jcuda pointer

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

allocate

public jcuda.Pointer allocate(String instructionName,
                              long size)
                       throws DMLRuntimeException

Invokes memory manager's malloc method

Parameters:

instructionName - name of instruction for which to record per instruction performance statistics, null if don't want to record

size - size of data (in bytes) to allocate

Returns:

jcuda pointer

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

cudaFreeHelper

public void cudaFreeHelper(jcuda.Pointer toFree)
                    throws DMLRuntimeException

Does lazy cudaFree calls.

Parameters:

toFree - Pointer instance to be freed

Throws:

DMLRuntimeException - if error

cudaFreeHelper

public void cudaFreeHelper(jcuda.Pointer toFree,
                           boolean eager)
                    throws DMLRuntimeException

Does lazy/eager cudaFree calls.

Parameters:

toFree - Pointer instance to be freed

eager - true if to be done eagerly

Throws:

DMLRuntimeException - if error

cudaFreeHelper

public void cudaFreeHelper(String instructionName,
                           jcuda.Pointer toFree)
                    throws DMLRuntimeException

Does lazy cudaFree calls.

Parameters:

instructionName - name of the instruction for which to record per instruction free time, null if do not want to record

toFree - Pointer instance to be freed

Throws:

DMLRuntimeException - if error

cudaFreeHelper

public void cudaFreeHelper(String instructionName,
                           jcuda.Pointer toFree,
                           boolean eager)
                    throws DMLRuntimeException

Does cudaFree calls, lazily.

Parameters:

instructionName - name of the instruction for which to record per instruction free time, null if do not want to record

toFree - Pointer instance to be freed

eager - true if to be done eagerly

Throws:

DMLRuntimeException - if error

getAvailableMemory

public long getAvailableMemory()

Gets the available memory on GPU that SystemML can use.

Returns:

the available memory in bytes

ensureComputeCapability

public void ensureComputeCapability()
                             throws DMLRuntimeException

Makes sure that GPU that SystemML is trying to use has the minimum compute capability needed.

Throws:

DMLRuntimeException - if the compute capability is less than what is required

createGPUObject

public GPUObject createGPUObject(org.apache.sysml.runtime.controlprogram.caching.MatrixObject mo)

Instantiates a new GPUObject initialized with the given MatrixObject.

Parameters:

mo - a MatrixObject that represents a matrix

Returns:

a new GPUObject instance

getGPUProperties

public jcuda.runtime.cudaDeviceProp getGPUProperties()
                                              throws DMLRuntimeException

Gets the device properties for the active GPU (set with cudaSetDevice()).

Returns:

the device properties

Throws:

DMLRuntimeException - ?

getMaxThreadsPerBlock

public int getMaxThreadsPerBlock()
                          throws DMLRuntimeException

Gets the maximum number of threads per block for "active" GPU.

Returns:

the maximum number of threads per block

Throws:

DMLRuntimeException - ?

getMaxBlocks

public int getMaxBlocks()
                 throws DMLRuntimeException

Gets the maximum number of blocks supported by the active cuda device.

Returns:

the maximum number of blocks supported

Throws:

DMLRuntimeException - ?

getMaxSharedMemory

public long getMaxSharedMemory()
                        throws DMLRuntimeException

Gets the shared memory per block supported by the active cuda device.

Returns:

the shared memory per block

Throws:

DMLRuntimeException - ?

getWarpSize

public int getWarpSize()
                throws DMLRuntimeException

Gets the warp size supported by the active cuda device.

Returns:

the warp size

Throws:

DMLRuntimeException - ?

getCudnnHandle

public jcuda.jcudnn.cudnnHandle getCudnnHandle()

Returns the cudnnHandle for Deep Neural Network operations on the GPU.

Returns:

cudnnHandle for current thread

getCublasHandle

public jcuda.jcublas.cublasHandle getCublasHandle()

Returns cublasHandle for BLAS operations on the GPU.

Returns:

cublasHandle for current thread

getCusparseHandle

public jcuda.jcusparse.cusparseHandle getCusparseHandle()

Returns cusparseHandle for certain sparse BLAS operations on the GPU.

Returns:

cusparseHandle for current thread

getCusolverDnHandle

public jcuda.jcusolver.cusolverDnHandle getCusolverDnHandle()

Returns cusolverDnHandle for invoking solve() function on dense matrices on the GPU.

Returns:

cusolverDnHandle for current thread

getKernels

public JCudaKernels getKernels()

Returns utility class used to launch custom CUDA kernel, specific to the active GPU for this GPUContext.

Returns:

JCudaKernels for current thread

destroy

public void destroy()
             throws DMLRuntimeException

Destroys this GPUContext object.

Throws:

DMLRuntimeException - if error

clearMemory

public void clearMemory()
                 throws DMLRuntimeException

Clears all memory used by this GPUContext. Be careful to ensure that no memory is currently being used in the temporary memory before invoking this. If memory is being used between MLContext invocations, they are pointed to by a GPUObject instance which would be part of the MatrixObject. The cleanup of that MatrixObject instance will cause the memory associated with that block on the GPU to be freed up.

Throws:

DMLRuntimeException - ?

clearTemporaryMemory

public void clearTemporaryMemory()
                          throws DMLRuntimeException

Throws:

DMLRuntimeException

toString

public String toString()

Overrides:

toString in class Object