Packages

c

com.nvidia.spark.rapids.RapidsDeviceMemoryStore

RapidsDeviceMemoryBuffer

class RapidsDeviceMemoryBuffer extends RapidsBufferBase

Linear Supertypes
RapidsDeviceMemoryStore.RapidsBufferBase, Arm, RapidsBuffer, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RapidsDeviceMemoryBuffer
  2. RapidsBufferBase
  3. Arm
  4. RapidsBuffer
  5. AutoCloseable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RapidsDeviceMemoryBuffer(id: RapidsBufferId, size: Long, meta: TableMeta, table: Option[Table], contigBuffer: DeviceMemoryBuffer, spillPriority: Long, spillCallback: SpillCallback)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addReference(): Boolean

    Try to add a reference to this buffer to acquire it.

    Try to add a reference to this buffer to acquire it.

    returns

    true if the reference was added or false if this buffer is no longer valid

    Definition Classes
    RapidsBufferBase → RapidsBuffer
    Note

    The close method must be called for every successfully obtained reference.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def close(): Unit
    Definition Classes
    RapidsBufferBase → AutoCloseable
  8. def closeOnExcept[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  9. def closeOnExcept[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  10. def closeOnExcept[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  11. def closeOnExcept[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  12. def closeOnExcept[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, closing the resource only if an exception occurs

    Executes the provided code block, closing the resource only if an exception occurs

    Definition Classes
    Arm
  13. def columnarBatchFromDeviceBuffer(devBuffer: DeviceMemoryBuffer, sparkTypes: Array[DataType]): ColumnarBatch
    Attributes
    protected
    Definition Classes
    RapidsBufferBase
  14. def copyToMemoryBuffer(srcOffset: Long, dst: MemoryBuffer, dstOffset: Long, length: Long, stream: Stream): Unit

    Copy the content of this buffer into the specified memory buffer, starting from the given offset.

    Copy the content of this buffer into the specified memory buffer, starting from the given offset.

    srcOffset

    offset to start copying from.

    dst

    the memory buffer to copy into.

    dstOffset

    offset to copy into.

    length

    number of bytes to copy.

    stream

    CUDA stream to use

    Definition Classes
    RapidsBufferBase → RapidsBuffer
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def free(): Unit

    Mark the buffer as freed and no longer valid.

    Mark the buffer as freed and no longer valid.

    Definition Classes
    RapidsBufferBase → RapidsBuffer
    Note

    The resources may not be immediately released if the buffer has outstanding references. In that case the resources will be released when the reference count reaches zero.

  18. def freeOnExcept[T <: RapidsBuffer, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Definition Classes
    Arm
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def getColumnarBatch(sparkTypes: Array[DataType]): ColumnarBatch

    Get the columnar batch within this buffer.

    Get the columnar batch within this buffer. The caller must have successfully acquired the buffer beforehand.

    sparkTypes

    the spark data types the batch should have

    Definition Classes
    RapidsDeviceMemoryBuffer → RapidsBufferBase → RapidsBuffer
    Note

    It is the responsibility of the caller to close the batch.

    ,

    If the buffer is compressed data then the resulting batch will be built using GpuCompressedColumnVector, and it is the responsibility of the caller to deal with decompressing the data if necessary.

    See also

    addReference

  21. def getDeviceMemoryBuffer: DeviceMemoryBuffer

    Get the device memory buffer from the underlying storage.

    Get the device memory buffer from the underlying storage. If the buffer currently resides outside of device memory, a new DeviceMemoryBuffer is created with the data copied over. The caller must have successfully acquired the buffer beforehand.

    Definition Classes
    RapidsDeviceMemoryBuffer → RapidsBufferBase → RapidsBuffer
    Note

    It is the responsibility of the caller to close the buffer.

    See also

    addReference

  22. def getMemoryBuffer: MemoryBuffer

    Get the underlying memory buffer.

    Get the underlying memory buffer. This may be either a HostMemoryBuffer or a DeviceMemoryBuffer depending on where the buffer currently resides. The caller must have successfully acquired the buffer beforehand.

    Definition Classes
    RapidsDeviceMemoryBuffer → RapidsBuffer
    Note

    It is the responsibility of the caller to close the buffer.

    See also

    addReference

  23. def getSpillPriority: Long

    Get the spill priority value for this buffer.

    Get the spill priority value for this buffer. Lower values are higher priority for spilling, meaning buffers with lower values will be preferred for spilling over buffers with a higher value.

    Definition Classes
    RapidsBufferBase → RapidsBuffer
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val id: RapidsBufferId

    The buffer identifier for this buffer.

    The buffer identifier for this buffer.

    Definition Classes
    RapidsBufferBase → RapidsBuffer
  26. def isAcquired: Boolean

    Determine if a buffer is currently acquired.

    Determine if a buffer is currently acquired.

    Definition Classes
    RapidsBufferBase
    Note

    Unless this is called by the thread that currently "owns" an acquired buffer, the acquisition state could be changing asynchronously, and therefore the result cannot always be used as a proxy for the result obtained from the addReference method.

  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def materializeMemoryBuffer: MemoryBuffer

    Materialize the memory buffer from the underlying storage.

    Materialize the memory buffer from the underlying storage.

    If the buffer resides in device or host memory, only reference count is incremented. If the buffer resides in secondary storage, a new host or device memory buffer is created, with the data copied to the new buffer. The caller must have successfully acquired the buffer beforehand.

    Attributes
    protected
    Definition Classes
    RapidsBufferBase
    Note

    It is the responsibility of the caller to close the buffer.

    ,

    This is an internal API only used by Rapids buffer stores.

    See also

    addReference

  29. val meta: TableMeta

    Descriptor for how the memory buffer is formatted

    Descriptor for how the memory buffer is formatted

    Definition Classes
    RapidsBufferBase → RapidsBuffer
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. var refcount: Int
    Attributes
    protected[this]
    Definition Classes
    RapidsBufferBase
  34. def releaseResources(): Unit

    Release the underlying resources for this buffer.

    Release the underlying resources for this buffer.

    Attributes
    protected
    Definition Classes
    RapidsDeviceMemoryBuffer → RapidsBufferBase
  35. def setSpillPriority(priority: Long): Unit

    Set the spill priority for this buffer.

    Set the spill priority for this buffer. Lower values are higher priority for spilling, meaning buffers with lower values will be preferred for spilling over buffers with a higher value.

    priority

    new priority value for this buffer

    Definition Classes
    RapidsBufferBase → RapidsBuffer
  36. val size: Long

    The size of this buffer in bytes.

    The size of this buffer in bytes.

    Definition Classes
    RapidsBufferBase → RapidsBuffer
  37. val spillCallback: SpillCallback
    Definition Classes
    RapidsDeviceMemoryBuffer → RapidsBufferBase → RapidsBuffer
  38. val storageTier: StorageTier

    The storage tier for this buffer

    The storage tier for this buffer

    Definition Classes
    RapidsDeviceMemoryBuffer → RapidsBuffer
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    RapidsBufferBase → AnyRef → Any
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def withResource[T <: AutoCloseable, V](h: CloseableHolder[T])(block: (CloseableHolder[T]) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  45. def withResource[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block and then closes the array buffer of resources

    Executes the provided code block and then closes the array buffer of resources

    Definition Classes
    Arm
  46. def withResource[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block and then closes the array of resources

    Executes the provided code block and then closes the array of resources

    Definition Classes
    Arm
  47. def withResource[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block and then closes the sequence of resources

    Executes the provided code block and then closes the sequence of resources

    Definition Classes
    Arm
  48. def withResource[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block and then closes the Option[resource]

    Executes the provided code block and then closes the Option[resource]

    Definition Classes
    Arm
  49. def withResource[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  50. def withResourceIfAllowed[T, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the value if it is AutoCloseable

    Executes the provided code block and then closes the value if it is AutoCloseable

    Definition Classes
    Arm

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from RapidsDeviceMemoryStore.RapidsBufferBase

Inherited from Arm

Inherited from RapidsBuffer

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped