ai.rapids.cudf

Class ColumnVector.OffHeapState

java.lang.Object

ai.rapids.cudf.ColumnVector.OffHeapState

Enclosing class:

ColumnVector

protected static final class ColumnVector.OffHeapState
extends Object

Holds the off heap state of the column vector so we can clean it up, even if it is leaked.

Field Summary

Fields

Modifier and Type	Field and Description
long	id
static long	UNKNOWN_NULL_COUNT

Constructor Summary

Constructors

Constructor and Description
OffHeapState(DType type, int rows, Optional<Long> nullCount, DeviceMemoryBuffer data, DeviceMemoryBuffer valid, DeviceMemoryBuffer offsets) Create a cudf::column_view from device side data.
OffHeapState(long columnHandle) Make a column form an existing cudf::column *.
OffHeapState(long viewHandle, DeviceMemoryBuffer contiguousBuffer) Create a cudf::column_view from contiguous device side data.

Method Summary

Modifier and Type	Method and Description
void	addRef()
boolean	clean(boolean logErrorIfNotClean) Clean up any resources not previously released.
protected boolean	cleanImpl(boolean logErrorIfNotClean) Clean up any resources not previously released.
void	delRef()
BaseDeviceMemoryBuffer	getData()
long	getDeviceMemorySize() This returns total memory allocated in device for the ColumnVector.
long	getNativeNullCount()
long	getNativeRowCount()
DType	getNativeType()
BaseDeviceMemoryBuffer	getOffsets()
BaseDeviceMemoryBuffer	getValid()
long	getViewHandle()
boolean	isClean() Check if the underlying memory has been cleaned up or not.
boolean	isLeakExpected() Return true if a leak is expected for this object else false.
void	logRefCountDebug(String message)
void	noWarnLeakExpected()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_NULL_COUNT

public static final long UNKNOWN_NULL_COUNT

See Also:

Constant Field Values

id

public final long id

Constructor Detail

OffHeapState

public OffHeapState(long columnHandle)

Make a column form an existing cudf::column *.

OffHeapState

public OffHeapState(DType type,
                    int rows,
                    Optional<Long> nullCount,
                    DeviceMemoryBuffer data,
                    DeviceMemoryBuffer valid,
                    DeviceMemoryBuffer offsets)

Create a cudf::column_view from device side data.

OffHeapState

public OffHeapState(long viewHandle,
                    DeviceMemoryBuffer contiguousBuffer)

Create a cudf::column_view from contiguous device side data.

Method Detail

getViewHandle

public long getViewHandle()

getNativeRowCount

public long getNativeRowCount()

getNativeNullCount

public long getNativeNullCount()

getNativeType

public DType getNativeType()

getData

public BaseDeviceMemoryBuffer getData()

getValid

public BaseDeviceMemoryBuffer getValid()

getOffsets

public BaseDeviceMemoryBuffer getOffsets()

noWarnLeakExpected

public void noWarnLeakExpected()

toString

public String toString()

Overrides:

toString in class Object

cleanImpl

protected boolean cleanImpl(boolean logErrorIfNotClean)

Clean up any resources not previously released.

Parameters:

logErrorIfNotClean - if true and there are resources to clean up a leak has happened so log it.

Returns:

true if resources were cleaned up else false.

isClean

public boolean isClean()

Check if the underlying memory has been cleaned up or not.

Returns:

true this is clean else false.

getDeviceMemorySize

public long getDeviceMemorySize()

This returns total memory allocated in device for the ColumnVector.

Returns:

number of device bytes allocated for this column

addRef

public final void addRef()

delRef

public final void delRef()

logRefCountDebug

public final void logRefCountDebug(String message)

clean

public final boolean clean(boolean logErrorIfNotClean)

Clean up any resources not previously released.

Parameters:

logErrorIfNotClean - if true we should log a leak unless it is expected.

Returns:

true if resources were cleaned up else false.

isLeakExpected

public final boolean isLeakExpected()

Return true if a leak is expected for this object else false.