Skip to content

perf: project cached batches by buffer selection, prune on collated strings - #5543

Open
andygrove wants to merge 4 commits into
apache:mainfrom
andygrove:feat/cache-buffer-selection-projection
Open

perf: project cached batches by buffer selection, prune on collated strings#5543
andygrove wants to merge 4 commits into
apache:mainfrom
andygrove:feat/cache-buffer-selection-projection

Conversation

@andygrove

@andygrove andygrove commented Aug 29, 2026

Copy link
Copy Markdown
Member

Which issue does this PR close?

Part of #5487. Ticks these boxes:

  • Drop the schema message from each cached stream — subsumed by the buffer-selection change below, which removes per-column framing entirely.
  • Evaluate projection by buffer selection instead of per-column streams
  • Prune on collated string columns
  • Documentation — the committed-benchmark-results half is not done; see the note at the end.

Not addressed here: typed readers for the row path (#5485 has no established cause yet, so this would be optimising ahead of a diagnosis) and background prefetch.

Rationale for this change

#5051 stores each cached column as its own compressed Arrow IPC stream, so a scan decodes only the columns it projects. That works, but it pays an Arrow schema block and compression framing per column per batch, and gives up cross-column compression: footprint grows 2.5% at 6 columns and 32% at 60.

Spark's ArrowCachedBatchSerializer (SPARK-57268) reaches the same projection-proportional decode with no per-column framing at all. It keeps one RecordBatch per cached batch and parses the IPC message flatbuffer, which lists every buffer's offset and length within the body, to copy out only the byte ranges belonging to the selected columns. It depends on Arrow's native per-buffer compression rather than wrapping the whole payload in a Spark CompressionCodec.

That approach dominates the current design on footprint while keeping the projection win, so this PR adopts it.

Separately, tracksBounds matches case StringType, which a collated StringType does not equal. Collated columns therefore get null bounds and buildFilter declines to push predicates on them. That is correct but loses pruning that Spark manages.

What changes are included in this PR?

Cached batch format. CometCachedBatch.columns: Array[ChunkedByteBuffer] becomes bytes: Array[Byte]: one encapsulated Arrow IPC record batch message and its body, with no Schema message and no end-of-stream marker. The reader rebuilds the schema from the cached relation's attributes via Utils.toArrowSchema, so a wide relation no longer repeats the same schema bytes once per cached batch. New CachedBatchIpc owns the format — the field-node, buffer-span and variadic-count arithmetic, and the projected read that copies only the selected columns' buffers into a single off-heap allocation.

Compression moves from a whole-payload Spark codec to Arrow's per-buffer IPC compression, which is what lets a projected read decompress only what it selected. New spark.comet.exec.inMemoryCache.compression.codec (zstd default, none available) and ...compression.zstd.level.

Arrow's lz4 is deliberately not offered. It is commons-compress's pure-Java implementation, unrelated to the JNI-accelerated lz4-java behind spark.io.compression.codec. Over a 200k-row six-column relation:

Codec Materialize Footprint Read 1 of 6 Read 6 of 6
zstd 363 ms 2 MiB 56 ms 62 ms
none 1776 ms 13 MiB 78 ms 81 ms
lz4 205373 ms 6 MiB 51 ms 107 ms

lz4 is dominated on both speed and size, so nothing prefers it. zstd also beats storing batches uncompressed on both axes, because the bytes it saves cost more to copy and store than compressing them costs. Reads still accept any codec a batch records.

Dictionary-encoded columns are decoded before being stored. A payload with no schema message has nowhere to record either the index type or the dictionary. Comet's native scans do produce such columns, so this is a real path rather than a defensive one.

Decompression is done in CachedBatchIpc rather than left to VectorLoader. arrow-java 18.3.0 leaks on the failure path: VectorLoader.loadBuffers collects a field's decompressed buffers into a local list and releases them only after the whole field has loaded, so a buffer that fails to decompress strands every buffer of that field decompressed before it. A string column reaches this — its offsets buffer decompresses, then its data buffer throws — so a single corrupt cached batch leaks off-heap for the life of the executor.

Collated string pruning. tracksBounds widens to any StringType, and bounds are compared with TypeUtils.getInterpretedOrdering(dataType) — Spark's own interpreted ordering for the type, which on Spark 4 resolves a StringType through CollationFactory.fetchCollation(collationId).comparator. So bounds are recorded with the same ordering the partition filter Spark generates over that column uses, the collation awareness comes from Spark at every supported version with no shim, and the ordering is resolved once per column instead of re-dispatching on the DataType per row. This also replaces the hand-rolled per-type compare.

Reading builds one CachedBatchIpc.Projection per partition, holding the projected schema and the node/buffer/variadic index layout. That arithmetic walks every field of the cached relation, so computing it per batch would make the bookkeeping O(total columns) against O(selected columns) of useful work — worst in exactly the wide-relation, narrow-projection case this format exists for.

Dependency. Adds org.apache.arrow:arrow-compression. Already covered by the existing org.apache.arrow:* shade include, so it relocates with the rest of Arrow; its commons-compress and zstd-jni are excluded and come from Spark, which ships both on every supported version.

How are these changes tested?

CometInMemoryCacheSuite keeps its existing coverage, with the format-dependent tests rewritten against the new layout:

  • The projection tests no longer corrupt per-column streams. They scramble the compressed bytes of the columns a read must not touch, leaving every other byte of the payload identical, and assert the read still succeeds — which it only can if those buffers were never copied out of the payload. Each asserts as a precondition that the column it corrupts is genuinely stored compressed, since Arrow stores a buffer verbatim when compressing would not shrink it.
  • A new test asserts the payload begins with its record batch rather than a schema message, so a regression to a self-describing stream shows up directly rather than only as a footprint number.
  • Per-column sizes in the statistics row are checked against the message's own buffer layout.
  • A new test round-trips every codec the config accepts through a full read, a projected read, a row-count-only read and stats pruning. none takes a different path on read and was broken until this test was written.
  • The collation test is inverted: it now asserts pruning happens, and adds a UTF8_LCASE case that returns no rows if bounds are recorded with byte-order comparison. The no-bounds case moves to BinaryType.
  • Two leak tests cover a failure at a column's first buffer and a failure part way through a column, the latter reaching the VectorLoader behaviour above. Both assert the decode error surfaces as itself rather than as an Arrow reference-count error, which is what catches a cleanup path releasing the shared body twice.
  • The dictionary tests assert values read back correctly, which is what proves the writer decoded them — a row count would not.

CometCachedBatchHelper re-derives the IPC buffer arithmetic independently rather than calling into CachedBatchIpc, so the assertions built on it cannot pass by inheriting a bug from the code under test.

Also run: CometInMemoryCacheKryoSuite, CometExecSuite, UtilsSuite. Compiles clean against Spark 3.5, 4.0 and 4.1. The shaded jar was checked to confirm arrow-compression relocates and that commons-compress and zstd-jni are not bundled.

CometInMemoryCacheBenchmark over a 5M-row six-column relation (Apple M3 Ultra, JDK 17, Spark 4.1, release build):

Query shape Spark cache scan + convert CometInMemoryTableScan Relative
Repeated scan (3 of 6 columns) 157 ms 116 ms 1.4x
Selective filter 44 ms 38 ms 1.1x
Row count only (0 of 6) 30 ms 28 ms 1.1x
Narrow projection (1 of 6) 49 ms 39 ms 1.3x
Full projection (6 of 6) 299 ms 135 ms 2.2x

As with #5051, both columns read the same Comet-written CometCachedBatch and Comet execution is on in both, so this measures keeping the cached scan native against falling back to a Spark cache scan and converting — not Comet against Spark execution, and not a comparison with Spark's own cache format.

Notes for reviewers

  • The feature is still disabled by default. spark.comet.exec.inMemoryCache.enabled stays false, as it has been since feat: add experimental native support for in-memory cache, disabled by default #5051, so none of this reaches a default configuration. Everything below the config, including the change of cached format, only affects users who have opted in to the experimental native cache. The config is static: its value at startup is what decides whether Comet's cache serializer is installed at all.
  • The committed benchmark results half of the documentation item is not done. spark/benchmarks is in .gitignore, so Comet does not currently commit results files the way Spark does. Doing it properly needs that directory un-ignored plus a workflow to regenerate them, or the numbers rot — worth its own decision rather than being slipped in here. The measured tables live in the new docs page instead.
  • Cache materialization retains about 800 bytes per partition, independent of row count. This reproduces identically on 492dd6f, so it predates this PR and is untouched here; happy to file it separately.

…trings

Follow-up to apache#5051, applying items from apache#5487.

Replace the per-column Arrow IPC stream layout of `CometCachedBatch` with a
single encapsulated IPC record batch message per cached batch, carrying no
Schema message and no end-of-stream marker. The reader rebuilds the schema
from the cached relation's attributes, so a wide relation no longer repeats
the same schema bytes once per cached batch.

Compression moves from a whole-payload Spark codec to Arrow's per-buffer IPC
compression. That is what makes projection cheap: the message metadata records
every buffer's offset and length in the body, so `CachedBatchIpc.readProjected`
copies out only the byte ranges of the columns a scan selected and decompresses
just those. This subsumes the separate "drop the schema message" item, since
there is no longer a per-column stream to frame.

Dictionary-encoded columns are decoded before being stored: a payload with no
schema message cannot describe a dictionary encoding.

The codec defaults to zstd, and lz4 is deliberately not offered. Arrow's lz4 is
commons-compress's pure-Java implementation, unrelated to the JNI-accelerated
lz4-java behind `spark.io.compression.codec`. Over a 200k-row six-column
relation it measured 205s to write against 347ms for zstd, while also producing
larger output, so no workload prefers it. zstd also beats storing batches
uncompressed on both axes (347ms and 2 MiB against 1743ms and 13 MiB), because
the bytes it saves cost more to copy and store than compressing them costs.

Decompression is done here rather than left to `VectorLoader`, which leaks:
`VectorLoader.loadBuffers` collects a field's decompressed buffers into a local
list and releases them only after the whole field loads, so a buffer that fails
to decompress strands every buffer of that field decompressed before it. A
string column reaches this, its offsets buffer decompressing before its data
buffer throws.

Also track statistics bounds for collated string columns, comparing with the
collation's own ordering through a new `CometTypeShim.compareStrings`. Matching
the bare `StringType` object excluded collated columns, which then got null
bounds and no pruning.

Benchmark over a 5M-row six-column relation, keeping the cached scan native
against falling back to a Spark cache scan and converting: 1.3x on a repeated
scan, 1.3x on a narrow projection and 2.3x on a full projection.
…on layout

Cleanup pass over the cache format change. No behaviour change.

Drop the `compareStrings` shim in favour of `TypeUtils.getInterpretedOrdering`.
That method is public with the same signature on every supported Spark version,
and on Spark 4 it resolves a `StringType` through
`CollationFactory.fetchCollation(collationId).comparator` -- the comparison the
shim was reaching for. So the collation awareness comes from Spark itself and
the shim, its Spark 3.x stub and the hand-rolled per-type `compare` all go.
The ordering is now resolved once per column per partition rather than being
re-dispatched on the `DataType` twice per row.

Build the projection's index layout once per partition instead of per batch.
The node, buffer and variadic index arithmetic is a pure function of the cached
schema and the selected columns, but it walks every field of the relation, so
recomputing it per batch made the bookkeeping O(total columns) against O(selected
columns) of useful work -- worst in the wide-relation, narrow-projection case the
format exists for. `CachedBatchIpc.Projection` now holds that layout and the
projected schema, and owns the whole decode; `ProjectedBatch` is left with
ownership only. This also puts the projected schema next to the code that packs
buffers in the same order, an invariant that previously spanned two files
unstated.

Smaller cleanups: use Arrow's `DataSizeRoundingUtil.roundUpTo8Multiple` rather
than open-coding IPC body alignment; size the serialization buffer from the
record batch's known body length instead of growing from 32 bytes; resolve
decompressors once instead of per batch; share the dictionary lookup guard
between `Utils.combineDictionaryProviders` and the cache writer; read the codec
config through one helper carrying the driver-vs-executor rationale; and collapse
the duplicated compressed-buffer predicate and scramble loop in the test helper.

Corrects two `Utils` scaladocs that still described the per-column stream format
this change replaced. Benchmark and codec figures in the docs re-measured against
the current code.
arrow-compression ships
META-INF/services/org.apache.arrow.vector.compression.CompressionCodec$Factory.
The shade plugin copies it verbatim without a ServicesResourceTransformer, so
the jar declared a provider for Spark's own unshaded Arrow interface while
naming a class that exists here only under the relocated package. Every
ServiceLoader lookup Spark's Arrow made then failed with a
ServiceConfigurationError, which took CompressionCodec.Factory's static
initializer down with it and broke unrelated Arrow IPC reads, including
mapInArrow.

Add ServicesResourceTransformer so the service file name and its contents are
both relocated. arrow-compression is the only bundled artifact that ships one.

Also drop an unused NonFatal import that scalafix flagged.
"releases its vectors when a column fails part way through" zeroed the last
16 bytes of a compressed buffer and required the read to fail. Whether that
fails is a property of the zstd runtime, not of Comet: the cached payload is
byte-identical across Spark versions, but Comet takes zstd-jni from Spark
rather than from arrow-compression, and 1.5.5 (Spark 3.4, 3.5) decodes that
frame while 1.5.7 (Spark 4.x) reports it corrupt. So the test passed on 4.x
and failed on 3.4 and 3.5.

The scenario it claimed to cover is also unreachable: CachedBatchIpc
decompresses every selected buffer before VectorLoader runs, so no content
corruption can fail part way through the load. The two remaining leak tests
corrupt a frame from its header onwards, which every zstd release rejects,
and already cover a failure at a column's first buffer and a failure after an
earlier buffer of the same column decoded.

Records the constraint on scramble so a future test does not reach for a
tail-only corruption again, and drops the now unused truncateColumn helper
and the dictionary fixture's payload argument.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant