c

com.nvidia.spark.rapids.shuffle

BounceBufferManager

class BounceBufferManager[T <: MemoryBuffer] extends AutoCloseable with Logging

This classes manages a set of bounce buffers, that are instances of MemoryBuffer. The size/quantity of buffers is configurable, and so is the allocator.

T

the specific type of MemoryBuffer i.e. DeviceMemoryBuffer, HostMemoryBuffer, etc.

Linear Supertypes
Logging, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BounceBufferManager
  2. Logging
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BounceBufferManager(poolName: String, bufferSize: Long, numBuffers: Int, allocator: (Long) ⇒ T)

    poolName

    a human-friendly name to use for debug logs

    bufferSize

    the size of buffer to use

    numBuffers

    the number of buffers to allocate on instantiation

    allocator

    function that takes a size, and returns a MemoryBuffer instance.

Type Members

  1. class BounceBufferImpl extends BounceBuffer

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 acquireBuffersNonBlocking(possibleNumBuffers: Int): Seq[BounceBuffer]

    Acquire possibleNumBuffers buffers from the pool.

    Acquire possibleNumBuffers buffers from the pool. This method will not block.

    possibleNumBuffers

    number of buffers to acquire

    returns

    a sequence of BounceBuffers, or empty if the request can't be satisfied

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val bufferSize: Long
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def close(): Unit
    Definition Classes
    BounceBufferManager → AutoCloseable
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def freeBuffer(bounceBuffer: BounceBuffer): Unit

    Free a BounceBuffer, putting it back into the pool.

    Free a BounceBuffer, putting it back into the pool.

    bounceBuffer

    the memory buffer to free

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getRootBuffer(): MemoryBuffer

    Returns the root (backing) MemoryBuffer.

    Returns the root (backing) MemoryBuffer. This is used for a transport that wants to register the bounce buffers against hardware, for pinning purposes.

    returns

    the root (backing) memory buffer

  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  17. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  20. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  21. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. val numBuffers: Int
  36. def numFree(): Int
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. 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