Packages

c

org.apache.spark.sql.rapids

GpuMultiFileAvroPartitionReader

class GpuMultiFileAvroPartitionReader extends MultiFileCoalescingPartitionReaderBase with GpuAvroReaderBase

A PartitionReader that can read multiple AVRO files up to the certain size. It will coalesce small files together and copy the block data in a separate thread pool to speed up processing the small files before sending down to the GPU.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuMultiFileAvroPartitionReader
  2. GpuAvroReaderBase
  3. MultiFileCoalescingPartitionReaderBase
  4. MultiFileReaderFunctions
  5. FilePartitionReaderBase
  6. ScanWithMetrics
  7. Logging
  8. PartitionReader
  9. Closeable
  10. AutoCloseable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuMultiFileAvroPartitionReader(conf: Configuration, splits: Array[PartitionedFile], clippedBlocks: Seq[AvroSingleDataBlockInfo], readDataSchema: StructType, partitionSchema: StructType, maxReadBatchSizeRows: Integer, maxReadBatchSizeBytes: Long, maxGpuColumnSizeBytes: Long, numThreads: Int, debugDumpPrefix: Option[String], debugDumpAlways: Boolean, execMetrics: Map[String, GpuMetric], mapPathHeader: Map[Path, Header])

Type Members

  1. class AvroCopyBlocksRunner extends Callable[(Seq[DataBlockBase], Long)]

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. var batchIter: Iterator[ColumnarBatch]
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  6. val cacheBufferSize: Int
    Definition Classes
    GpuAvroReaderBase
  7. def calculateEstimatedBlocksOutputSize(batchContext: BatchContext): Long

    Calculate the output size according to the block chunks and the schema, and the estimated output size will be used as the initialized size of allocating HostMemoryBuffer

    Calculate the output size according to the block chunks and the schema, and the estimated output size will be used as the initialized size of allocating HostMemoryBuffer

    Please be note, the estimated size should be at least equal to size of HEAD + Blocks + FOOTER

    batchContext

    the batch building context

    returns

    Long, the estimated output size

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  8. def calculateFinalBlocksOutputSize(footerOffset: Long, blocks: Seq[DataBlockBase], batchContext: BatchContext): Long

    Calculate the final block output size which will be used to decide if re-allocate HostMemoryBuffer

    Calculate the final block output size which will be used to decide if re-allocate HostMemoryBuffer

    There is no need to re-calculate the block size, just calculate the footer size and plus footerOffset.

    If the size calculated by this function is bigger than the one calculated by calculateEstimatedBlocksOutputSize, then it will cause HostMemoryBuffer re-allocating, and cause the performance issue.

    footerOffset

    footer offset

    blocks

    blocks to be evaluated

    batchContext

    the batch building context

    returns

    the output size

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  9. def checkIfNeedToSplitDataBlock(currentBlockInfo: SingleDataBlockInfo, nextBlockInfo: SingleDataBlockInfo): Boolean

    To check if the next block will be split into another ColumnarBatch

    To check if the next block will be split into another ColumnarBatch

    currentBlockInfo

    current SingleDataBlockInfo

    nextBlockInfo

    next SingleDataBlockInfo

    returns

    true: split the next block into another ColumnarBatch and vice versa

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def close(): Unit
    Definition Classes
    FilePartitionReaderBase → Closeable → AutoCloseable
  12. val conf: Configuration
  13. final def copyBlocksData(blocks: Seq[BlockInfo], in: FSDataInputStream, out: OutputStream, sync: Option[Array[Byte]] = None): Seq[BlockInfo]

    Copy the data specified by the blocks from in to out

    Copy the data specified by the blocks from in to out

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  14. def createBatchContext(chunkedBlocks: LinkedHashMap[Path, ArrayBuffer[DataBlockBase]], clippedSchema: SchemaBase): BatchContext

    Return a batch context which will be shared during the process of building a memory file, aka with the following APIs.

    Return a batch context which will be shared during the process of building a memory file, aka with the following APIs.

    • calculateEstimatedBlocksOutputSize
    • writeFileHeader
    • getBatchRunner
    • calculateFinalBlocksOutputSize
    • writeFileFooter It is useful when something is needed by some or all of the above APIs. Children can override this to return a customized batch context.
    chunkedBlocks

    mapping of file path to data blocks

    clippedSchema

    schema info

    Attributes
    protected
    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  15. def currentMetricsValues(): Array[CustomTaskMetric]
    Definition Classes
    PartitionReader
  16. val debugDumpAlways: Boolean
  17. val debugDumpPrefix: Option[String]
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. final def estimateOutputSize(blocks: Seq[BlockInfo], headerSize: Long): Long

    Estimate the total size from the given blocks and header

    Estimate the total size from the given blocks and header

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  21. def fileSystemBytesRead(): Long
    Attributes
    protected
    Definition Classes
    MultiFileReaderFunctions
    Annotations
    @nowarn()
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def finalizeOutputBatch(batch: ColumnarBatch, extraInfo: ExtraInfo): ColumnarBatch

    A callback to finalize the output batch.

    A callback to finalize the output batch. The batch returned will be the final output batch of the reader's "get" method.

    batch

    the batch after decoding, adding partitioned columns.

    extraInfo

    the corresponding extra information of the input batch.

    returns

    the finalized columnar batch.

    Attributes
    protected
    Definition Classes
    MultiFileCoalescingPartitionReaderBase
  24. def get(): ColumnarBatch
    Definition Classes
    FilePartitionReaderBase → PartitionReader
  25. def getBatchRunner(tc: TaskContext, file: Path, outhmb: HostMemoryBuffer, blocks: ArrayBuffer[DataBlockBase], offset: Long, batchContext: BatchContext): Callable[(Seq[DataBlockBase], Long)]

    The sub-class must implement the real file reading logic in a Callable which will be running in a thread pool

    The sub-class must implement the real file reading logic in a Callable which will be running in a thread pool

    tc

    task context to use

    file

    file to be read

    outhmb

    the sliced HostMemoryBuffer to hold the blocks, and the implementation is in charge of closing it in sub-class

    blocks

    blocks meta info to specify which blocks to be read

    offset

    used as the offset adjustment

    batchContext

    the batch building context

    returns

    Callable[(Seq[DataBlockBase], Long)], which will be submitted to a ThreadPoolExecutor, and the Callable will return a tuple result and result._1 is block meta info with the offset adjusted result._2 is the bytes read

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. final def getFileFormatShortName: String

    File format short name used for logging and other things to uniquely identity which file format is being used.

    File format short name used for logging and other things to uniquely identity which file format is being used.

    returns

    the file format short name

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  30. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. var isDone: Boolean
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  34. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  42. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. val metrics: Map[String, GpuMetric]
    Definition Classes
    ScanWithMetrics
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def next(): Boolean
    Definition Classes
    MultiFileCoalescingPartitionReaderBase → PartitionReader
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. final def populateCurrentBlockChunk(blockIter: BufferedIterator[BlockInfo], maxReadBatchSizeRows: Int, maxReadBatchSizeBytes: Long): Seq[BlockInfo]

    Get the block chunk according to the max batch size and max rows.

    Get the block chunk according to the max batch size and max rows.

    blockIter

    blocks to be evaluated

    maxReadBatchSizeRows

    soft limit on the maximum number of rows the reader reads per batch

    maxReadBatchSizeBytes

    soft limit on the maximum number of bytes the reader reads per batch

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  52. def readBufferToTablesAndClose(dataBuffer: HostMemoryBuffer, dataSize: Long, clippedSchema: SchemaBase, readSchema: StructType, extraInfo: ExtraInfo): GpuDataProducer[Table]

    Sent host memory to GPU to decode

    Sent host memory to GPU to decode

    dataBuffer

    the data which can be decoded in GPU

    dataSize

    data size

    clippedSchema

    the clipped schema

    readSchema

    the expected schema

    extraInfo

    the extra information for specific file format

    returns

    Table

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  53. val readDataSchema: StructType
  54. final def readPartFile(partFilePath: Path, blocks: Seq[BlockInfo], headerSize: Long, conf: Configuration): (HostMemoryBuffer, Long)

    Read a split into a host buffer, preparing for sending to GPU

    Read a split into a host buffer, preparing for sending to GPU

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  55. final def sendToGpu(hostBuf: HostMemoryBuffer, bufSize: Long, splits: Array[PartitionedFile]): Option[ColumnarBatch]

    Send a host buffer to GPU for decoding, and return it as a ColumnarBatch.

    Send a host buffer to GPU for decoding, and return it as a ColumnarBatch. The input hostBuf will be closed after returning, please do not use it anymore. 'splits' is used only for debugging.

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  56. final def sendToGpuUnchecked(hostBuf: HostMemoryBuffer, bufSize: Long, splits: Array[PartitionedFile]): Table

    Read the host data to GPU for decoding, and return it as a cuDF Table.

    Read the host data to GPU for decoding, and return it as a cuDF Table. The input host buffer should contain valid data, otherwise the behavior is undefined. 'splits' is used only for debugging.

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  57. def startNewBufferRetry: Unit

    You can reset the target batch size if needed for splits...

    You can reset the target batch size if needed for splits...

    Definition Classes
    MultiFileCoalescingPartitionReaderBase
  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. implicit def toAvroBatchContext(in: BatchContext): AvroBatchContext
  60. implicit def toAvroExtraInfo(in: ExtraInfo): AvroExtraInfo
  61. implicit def toAvroSchema(schema: SchemaBase): Schema
  62. implicit def toBlockBases(blocks: Seq[BlockInfo]): Seq[DataBlockBase]
  63. implicit def toBlockInfo(block: DataBlockBase): BlockInfo
  64. implicit def toBlockInfos(blocks: Seq[DataBlockBase]): Seq[BlockInfo]
  65. def toString(): String
    Definition Classes
    AnyRef → Any
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  69. def writeFileFooter(buffer: HostMemoryBuffer, bufferSize: Long, footerOffset: Long, blocks: Seq[DataBlockBase], bContext: BatchContext): (HostMemoryBuffer, Long)

    Writer a footer for a specific file format.

    Writer a footer for a specific file format. If there is no footer for the file format, just return (hmb, offset)

    Please be note, some file formats may re-allocate the HostMemoryBuffer because of the estimated initialized buffer size may be a little smaller than the actual size. So in this case, the hmb should be closed in the implementation.

    buffer

    The buffer holding (header + data blocks)

    bufferSize

    The total buffer size which equals to size of (header + blocks + footer)

    footerOffset

    Where begin to write the footer

    blocks

    The data block meta info

    returns

    the buffer and the buffer size

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase
  70. def writeFileHeader(buffer: HostMemoryBuffer, bContext: BatchContext): Long

    Write a header for a specific file format.

    Write a header for a specific file format. If there is no header for the file format, just ignore it and return 0

    buffer

    where the header will be written

    returns

    how many bytes written

    Definition Classes
    GpuMultiFileAvroPartitionReaderMultiFileCoalescingPartitionReaderBase

Inherited from GpuAvroReaderBase

Inherited from MultiFileReaderFunctions

Inherited from FilePartitionReaderBase

Inherited from ScanWithMetrics

Inherited from Logging

Inherited from PartitionReader[ColumnarBatch]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped