Packages

c

com.nvidia.spark.rapids

RapidsBufferStore

abstract class RapidsBufferStore extends AutoCloseable with Logging

Base class for all buffer store types.

Linear Supertypes
Logging, AutoCloseable, AnyRef, Any
Known Subclasses
RapidsBufferStoreWithoutSpill, RapidsDeviceMemoryStore, RapidsDiskStore, RapidsHostMemoryStore
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RapidsBufferStore
  2. Logging
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RapidsBufferStore(tier: StorageTier)

    tier

    storage tier of this store

Type Members

  1. abstract class RapidsBufferBase extends RapidsBuffer

    Base class for all buffers in this store.

Abstract Value Members

  1. abstract def createBuffer(buffer: RapidsBuffer, catalog: RapidsBufferCatalog, stream: Stream): Option[RapidsBufferBase]

    Create a new buffer from an existing buffer in another store.

    Create a new buffer from an existing buffer in another store. If the data transfer will be performed asynchronously, this method is responsible for adding a reference to the existing buffer and later closing it when the transfer completes.

    buffer

    data from another store

    catalog

    RapidsBufferCatalog we may need to modify during this create

    stream

    CUDA stream to use or null

    returns

    the new buffer that was created.

    Attributes
    protected
    Note

    DO NOT close the buffer unless adding a reference!

    ,

    createBuffer impls should synchronize against stream before returning, if needed.

Concrete 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 addBuffer(buffer: RapidsBufferBase, needsSync: Boolean): Unit

    Adds a buffer to the spill framework, stream synchronizing with the producer stream to ensure that the buffer is fully materialized, and can be safely copied as part of the spill.

    Adds a buffer to the spill framework, stream synchronizing with the producer stream to ensure that the buffer is fully materialized, and can be safely copied as part of the spill.

    needsSync

    true if we should stream synchronize before adding the buffer

    Attributes
    protected
  5. def addBuffer(buffer: RapidsBufferBase): Unit

    Update bookkeeping for a new buffer

    Update bookkeeping for a new buffer

    Attributes
    protected
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def close(): Unit
    Definition Classes
    RapidsBufferStore → AutoCloseable
  9. def copyBuffer(buffer: RapidsBuffer, catalog: RapidsBufferCatalog, stream: Stream): Option[RapidsBufferBase]

    Adds an existing buffer from another store to this store.

    Adds an existing buffer from another store to this store. The buffer must already have an active reference by the caller and needs to be eventually closed by the caller (i.e.: this method will not take ownership of the incoming buffer object). This does not need to update the catalog, the caller is responsible for that.

    buffer

    data from another store

    catalog

    RapidsBufferCatalog we may need to modify during this copy

    stream

    CUDA stream to use for copy or null

    returns

    the new buffer that was created

  10. def currentSize: Long

    Return the current byte total of buffers in this store.

  11. def currentSpillableSize: Long
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getMaxSize: Option[Long]

    Stores that need to stay within a specific byte limit of buffers stored override this function.

    Stores that need to stay within a specific byte limit of buffers stored override this function. Only the HostMemoryBufferStore requires such a limit.

    returns

    maximum amount of bytes that can be stored in the store, None for no limit

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  19. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  22. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  23. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  30. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. val name: String
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def nextSpillable(): RapidsBuffer
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def setSpillStore(store: RapidsBufferStore): Unit

    Specify another store that can be used when this store needs to spill.

    Specify another store that can be used when this store needs to spill.

    Note

    Only one spill store can be registered. This will throw if a spill store has already been registered.

  40. def setSpillable(buffer: RapidsBufferBase, isSpillable: Boolean): Unit
    Attributes
    protected
  41. var spillStore: RapidsBufferStore

    A store that can be used for spilling.

  42. def spillableOnAdd: Boolean

    A store that manages spillability of buffers should override this method to false, otherwise BufferTracker treats buffers as always spillable.

    A store that manages spillability of buffers should override this method to false, otherwise BufferTracker treats buffers as always spillable.

    Attributes
    protected
  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. def synchronousSpill(targetTotalSize: Long, catalog: RapidsBufferCatalog, stream: Stream = Cuda.DEFAULT_STREAM): Long
  45. val tier: StorageTier
  46. def toString(): String
    Definition Classes
    AnyRef → Any
  47. def trySpillToMaximumSize(buffer: RapidsBuffer, catalog: RapidsBufferCatalog, stream: Stream): Boolean

    Tries to make room for buffer in the host store by spilling.

    Tries to make room for buffer in the host store by spilling.

    buffer

    buffer that will be copied to the host store if it fits

    stream

    CUDA stream to synchronize for memory operations

    returns

    true if the buffer fits after a potential spill

    Attributes
    protected
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Logging

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped