Package ai.rapids.cudf

Class ColumnVector.OffHeapState

java.lang.Object

ai.rapids.cudf.MemoryCleaner.Cleaner

ai.rapids.cudf.ColumnVector.OffHeapState

Enclosing class:

ColumnVector

protected static final class ColumnVector.OffHeapState
extends MemoryCleaner.Cleaner

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	Description
static final long	UNKNOWN_NULL_COUNT

Fields inherited from class ai.rapids.cudf.MemoryCleaner.Cleaner

id

Constructor Summary

Constructors

Constructor	Description
OffHeapState(long columnHandle)	Make a column form an existing cudf::column *.
OffHeapState(long viewHandle, DeviceMemoryBuffer contiguousBuffer)	Create from existing cudf::column_view and contiguous buffer.
OffHeapState(DeviceMemoryBuffer data, DeviceMemoryBuffer valid, DeviceMemoryBuffer offsets, List<DeviceMemoryBuffer> buffers, long viewHandle)	Create from existing cudf::column_view and buffers.

Method Summary

Modifier and Type	Method	Description
protected boolean	cleanImpl(boolean logErrorIfNotClean)	Clean up any resources not previously released.
BaseDeviceMemoryBuffer	getData()
long	getNativeNullCount()
BaseDeviceMemoryBuffer	getOffsets()
BaseDeviceMemoryBuffer	getValid()
long	getViewHandle()
boolean	isClean()	Check if the underlying memory has been cleaned up or not.
void	noWarnLeakExpected()
String	toString()

Methods inherited from class ai.rapids.cudf.MemoryCleaner.Cleaner

addRef, clean, delRef, isLeakExpected, logRefCountDebug

Methods inherited from class java.lang.Object

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

Field Details

UNKNOWN_NULL_COUNT

public static final long UNKNOWN_NULL_COUNT

See Also:

• Constant Field Values

Constructor Details

OffHeapState

public OffHeapState(long columnHandle)

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

OffHeapState

public OffHeapState(DeviceMemoryBuffer data,
 DeviceMemoryBuffer valid,
 DeviceMemoryBuffer offsets,
 List<DeviceMemoryBuffer> buffers,
 long viewHandle)

Create from existing cudf::column_view and buffers.

OffHeapState

public OffHeapState(long viewHandle,
 DeviceMemoryBuffer contiguousBuffer)

Create from existing cudf::column_view and contiguous buffer.

Method Details

getViewHandle

public long getViewHandle()

getNativeNullCount

public long getNativeNullCount()

getData

public BaseDeviceMemoryBuffer getData()

getValid

public BaseDeviceMemoryBuffer getValid()

getOffsets

public BaseDeviceMemoryBuffer getOffsets()

noWarnLeakExpected

public void noWarnLeakExpected()

Overrides:

noWarnLeakExpected in class MemoryCleaner.Cleaner

toString

public String toString()

Overrides:

toString in class Object

cleanImpl

protected boolean cleanImpl(boolean logErrorIfNotClean)

Description copied from class: MemoryCleaner.Cleaner

Clean up any resources not previously released.

Specified by:

cleanImpl in class MemoryCleaner.Cleaner

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()

Description copied from class: MemoryCleaner.Cleaner

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

Specified by:

isClean in class MemoryCleaner.Cleaner

Returns:

true this is clean else false.