c

com.nvidia.spark.rapids.shuffle

BufferSendState

class BufferSendState extends AutoCloseable with Logging

A helper case class to maintain the server side state in response to a transfer request initiated by a peer.

The class implements the Iterator interface.

On next(), a set of RapidsBuffer are copied onto a bounce buffer, and a MemoryBuffer slice of the bounce buffer is returned. Buffers are copied to the bounce buffer in TransferRequest order. The receiver has the same conventions.

Synchronization with serverStream is outside of this class. It is assumed that the caller has several BufferSendState iterators and on calling next on this collection, it will perform a sync on serverStream before handing it off to the transport.

It also is AutoCloseable. close() should be called to free bounce buffers.

In terms of the lifecycle of this object, it begins with the client asking for transfers to start, it lasts through all buffers being transmitted, and ultimately finishes when a TransferResponse is sent back to the client.

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

Instance Constructors

  1. new BufferSendState(transaction: Transaction, sendBounceBuffers: SendBounceBuffers, requestHandler: RapidsShuffleRequestHandler, serverStream: Stream = Cuda.DEFAULT_STREAM)

    transaction

    a request transaction

    sendBounceBuffers

    - an object that contains a device and potentially a host buffer also

    requestHandler

    - impl of trait that interfaces to the catalog

    serverStream

    - CUDA stream to use for copies.

Type Members

  1. case class RangeBuffer(range: BlockRange[SendBlock], rapidsBuffer: RapidsBuffer) extends AutoCloseable with Product with Serializable
  2. class SendBlock extends BlockWithSize

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def close(): Unit
    Definition Classes
    BufferSendState → AutoCloseable
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def getBufferToSend(): MemoryBuffer

    Prepares and returns a MemoryBuffer that can be used in a send.

    Prepares and returns a MemoryBuffer that can be used in a send.

    returns

    - a memory buffer slice backed by either a host or device bounce buffer, depending on the tier location for buffers we are sending.

    Exceptions thrown

    org.apache.spark.shuffle.rapids.RapidsShuffleSendPrepareException when copies to the bounce buffer fail.

  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getPeerBufferReceiveHeader: Long
  13. def getRequestTransaction: Transaction
  14. def getTransferResponse(): RefCountedDirectByteBuffer
  15. def hasMoreSends: Boolean
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  18. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  21. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  22. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. val peerExecutorId: Long
  37. def releaseAcquiredToCatalog(): Unit

    Called by the RapidsShuffleServer when it has synchronized with its stream, allowing us to safely return buffers to the catalog to be potentially freed if spilling.

  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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()

Inherited from Logging

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped