diff --git a/arrow-ipc/Cargo.toml b/arrow-ipc/Cargo.toml index 4988eed4a5e..735f7a14a2f 100644 --- a/arrow-ipc/Cargo.toml +++ b/arrow-ipc/Cargo.toml @@ -47,4 +47,17 @@ default = [] lz4 = ["lz4_flex"] [dev-dependencies] +criterion = "0.5.1" tempfile = "3.3" +tokio = "1.43.0" +# used in benches +memmap2 = "0.9.3" +bytes = "1.9" + +[[bench]] +name = "ipc_writer" +harness = false + +[[bench]] +name = "ipc_reader" +harness = false diff --git a/arrow-ipc/benches/ipc_reader.rs b/arrow-ipc/benches/ipc_reader.rs new file mode 100644 index 00000000000..7fc14664b4a --- /dev/null +++ b/arrow-ipc/benches/ipc_reader.rs @@ -0,0 +1,229 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use arrow_array::builder::{Date32Builder, Decimal128Builder, Int32Builder}; +use arrow_array::{builder::StringBuilder, RecordBatch}; +use arrow_buffer::Buffer; +use arrow_ipc::convert::fb_to_schema; +use arrow_ipc::reader::{read_footer_length, FileDecoder, FileReader, StreamReader}; +use arrow_ipc::writer::{FileWriter, IpcWriteOptions, StreamWriter}; +use arrow_ipc::{root_as_footer, Block, CompressionType}; +use arrow_schema::{DataType, Field, Schema}; +use criterion::{criterion_group, criterion_main, Criterion}; +use std::io::Cursor; +use std::sync::Arc; +use tempfile::tempdir; + +fn criterion_benchmark(c: &mut Criterion) { + let mut group = c.benchmark_group("arrow_ipc_reader"); + + group.bench_function("StreamReader/read_10", |b| { + let batch = create_batch(8192, true); + let mut buffer = Vec::with_capacity(2 * 1024 * 1024); + let mut writer = StreamWriter::try_new(&mut buffer, batch.schema().as_ref()).unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + + b.iter(move || { + let projection = None; + let mut reader = StreamReader::try_new(buffer.as_slice(), projection).unwrap(); + for _ in 0..10 { + reader.next().unwrap().unwrap(); + } + assert!(reader.next().is_none()); + }) + }); + + group.bench_function("StreamReader/read_10/zstd", |b| { + let batch = create_batch(8192, true); + let mut buffer = Vec::with_capacity(2 * 1024 * 1024); + let options = IpcWriteOptions::default() + .try_with_compression(Some(CompressionType::ZSTD)) + .unwrap(); + let mut writer = + StreamWriter::try_new_with_options(&mut buffer, batch.schema().as_ref(), options) + .unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + + b.iter(move || { + let projection = None; + let mut reader = StreamReader::try_new(buffer.as_slice(), projection).unwrap(); + for _ in 0..10 { + reader.next().unwrap().unwrap(); + } + assert!(reader.next().is_none()); + }) + }); + + group.bench_function("FileReader/read_10", |b| { + let batch = create_batch(8192, true); + let mut buffer = Vec::with_capacity(2 * 1024 * 1024); + let mut writer = FileWriter::try_new(&mut buffer, batch.schema().as_ref()).unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + + b.iter(move || { + let projection = None; + let cursor = Cursor::new(buffer.as_slice()); + let mut reader = FileReader::try_new(cursor, projection).unwrap(); + for _ in 0..10 { + reader.next().unwrap().unwrap(); + } + assert!(reader.next().is_none()); + }) + }); + + group.bench_function("FileReader/read_10/mmap", |b| { + let batch = create_batch(8192, true); + // write to an actual file + let dir = tempdir().unwrap(); + let path = dir.path().join("test.arrow"); + let file = std::fs::File::create(&path).unwrap(); + let mut writer = FileWriter::try_new(file, batch.schema().as_ref()).unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + + b.iter(move || { + let ipc_file = std::fs::File::open(&path).expect("failed to open file"); + let mmap = unsafe { memmap2::Mmap::map(&ipc_file).expect("failed to mmap file") }; + + // Convert the mmap region to an Arrow `Buffer` to back the arrow arrays. + let bytes = bytes::Bytes::from_owner(mmap); + let buffer = Buffer::from(bytes); + let decoder = IPCBufferDecoder::new(buffer); + assert_eq!(decoder.num_batches(), 10); + + for i in 0..decoder.num_batches() { + decoder.get_batch(i); + } + }) + }); +} + +// copied from the zero_copy_ipc example. +// should we move this to an actual API? +/// Wrapper around the example in the `FileDecoder` which handles the +/// low level interaction with the Arrow IPC format. +struct IPCBufferDecoder { + /// Memory (or memory mapped) Buffer with the data + buffer: Buffer, + /// Decoder that reads Arrays that refers to the underlying buffers + decoder: FileDecoder, + /// Location of the batches within the buffer + batches: Vec, +} + +impl IPCBufferDecoder { + fn new(buffer: Buffer) -> Self { + let trailer_start = buffer.len() - 10; + let footer_len = read_footer_length(buffer[trailer_start..].try_into().unwrap()).unwrap(); + let footer = root_as_footer(&buffer[trailer_start - footer_len..trailer_start]).unwrap(); + + let schema = fb_to_schema(footer.schema().unwrap()); + + let mut decoder = FileDecoder::new(Arc::new(schema), footer.version()); + + // Read dictionaries + for block in footer.dictionaries().iter().flatten() { + let block_len = block.bodyLength() as usize + block.metaDataLength() as usize; + let data = buffer.slice_with_length(block.offset() as _, block_len); + decoder.read_dictionary(block, &data).unwrap(); + } + + // convert to Vec from the flatbuffers Vector to avoid having a direct dependency on flatbuffers + let batches = footer + .recordBatches() + .map(|b| b.iter().copied().collect()) + .unwrap_or_default(); + + Self { + buffer, + decoder, + batches, + } + } + + fn num_batches(&self) -> usize { + self.batches.len() + } + + fn get_batch(&self, i: usize) -> RecordBatch { + let block = &self.batches[i]; + let block_len = block.bodyLength() as usize + block.metaDataLength() as usize; + let data = self + .buffer + .slice_with_length(block.offset() as _, block_len); + self.decoder + .read_record_batch(block, &data) + .unwrap() + .unwrap() + } +} + +fn create_batch(num_rows: usize, allow_nulls: bool) -> RecordBatch { + let schema = Arc::new(Schema::new(vec![ + Field::new("c0", DataType::Int32, true), + Field::new("c1", DataType::Utf8, true), + Field::new("c2", DataType::Date32, true), + Field::new("c3", DataType::Decimal128(11, 2), true), + ])); + let mut a = Int32Builder::new(); + let mut b = StringBuilder::new(); + let mut c = Date32Builder::new(); + let mut d = Decimal128Builder::new() + .with_precision_and_scale(11, 2) + .unwrap(); + for i in 0..num_rows { + a.append_value(i as i32); + c.append_value(i as i32); + d.append_value((i * 1000000) as i128); + if allow_nulls && i % 10 == 0 { + b.append_null(); + } else { + b.append_value(format!("this is string number {i}")); + } + } + let a = a.finish(); + let b = b.finish(); + let c = c.finish(); + let d = d.finish(); + RecordBatch::try_new( + schema.clone(), + vec![Arc::new(a), Arc::new(b), Arc::new(c), Arc::new(d)], + ) + .unwrap() +} + +fn config() -> Criterion { + Criterion::default() +} + +criterion_group! { + name = benches; + config = config(); + targets = criterion_benchmark +} +criterion_main!(benches); diff --git a/arrow-ipc/benches/ipc_writer.rs b/arrow-ipc/benches/ipc_writer.rs new file mode 100644 index 00000000000..6b4d184b455 --- /dev/null +++ b/arrow-ipc/benches/ipc_writer.rs @@ -0,0 +1,117 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use arrow_array::builder::{Date32Builder, Decimal128Builder, Int32Builder}; +use arrow_array::{builder::StringBuilder, RecordBatch}; +use arrow_ipc::writer::{FileWriter, IpcWriteOptions, StreamWriter}; +use arrow_ipc::CompressionType; +use arrow_schema::{DataType, Field, Schema}; +use criterion::{criterion_group, criterion_main, Criterion}; +use std::sync::Arc; + +fn criterion_benchmark(c: &mut Criterion) { + let mut group = c.benchmark_group("arrow_ipc_stream_writer"); + + group.bench_function("StreamWriter/write_10", |b| { + let batch = create_batch(8192, true); + let mut buffer = Vec::with_capacity(2 * 1024 * 1024); + b.iter(move || { + buffer.clear(); + let mut writer = StreamWriter::try_new(&mut buffer, batch.schema().as_ref()).unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + }) + }); + + group.bench_function("StreamWriter/write_10/zstd", |b| { + let batch = create_batch(8192, true); + let mut buffer = Vec::with_capacity(2 * 1024 * 1024); + b.iter(move || { + buffer.clear(); + let options = IpcWriteOptions::default() + .try_with_compression(Some(CompressionType::ZSTD)) + .unwrap(); + let mut writer = + StreamWriter::try_new_with_options(&mut buffer, batch.schema().as_ref(), options) + .unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + }) + }); + + group.bench_function("FileWriter/write_10", |b| { + let batch = create_batch(8192, true); + let mut buffer = Vec::with_capacity(2 * 1024 * 1024); + b.iter(move || { + buffer.clear(); + let mut writer = FileWriter::try_new(&mut buffer, batch.schema().as_ref()).unwrap(); + for _ in 0..10 { + writer.write(&batch).unwrap(); + } + writer.finish().unwrap(); + }) + }); +} + +fn create_batch(num_rows: usize, allow_nulls: bool) -> RecordBatch { + let schema = Arc::new(Schema::new(vec![ + Field::new("c0", DataType::Int32, true), + Field::new("c1", DataType::Utf8, true), + Field::new("c2", DataType::Date32, true), + Field::new("c3", DataType::Decimal128(11, 2), true), + ])); + let mut a = Int32Builder::new(); + let mut b = StringBuilder::new(); + let mut c = Date32Builder::new(); + let mut d = Decimal128Builder::new() + .with_precision_and_scale(11, 2) + .unwrap(); + for i in 0..num_rows { + a.append_value(i as i32); + c.append_value(i as i32); + d.append_value((i * 1000000) as i128); + if allow_nulls && i % 10 == 0 { + b.append_null(); + } else { + b.append_value(format!("this is string number {i}")); + } + } + let a = a.finish(); + let b = b.finish(); + let c = c.finish(); + let d = d.finish(); + RecordBatch::try_new( + schema.clone(), + vec![Arc::new(a), Arc::new(b), Arc::new(c), Arc::new(d)], + ) + .unwrap() +} + +fn config() -> Criterion { + Criterion::default() +} + +criterion_group! { + name = benches; + config = config(); + targets = criterion_benchmark +} +criterion_main!(benches);