Skip to content

GH-55487: [C++][Parquet] Fix DeltaLengthByteArrayEncoder memory pool tracking and Arrow string batching #55488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryanvickr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH-55487: [C++][Parquet] Fix DeltaLengthByteArrayEncoder memory pool tracking and Arrow string batching #55488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 85 additions & 10 deletions cpp/src/parquet/encoder.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#include "parquet/encoding.h"

#include <algorithm>
#include <array>
#include <bit>
#include <cstdint>
#include <cstdlib>
Expand Down Expand Up @@ -1384,9 +1385,9 @@ void DeltaBitPackEncoder<DType>::PutSpaced(const T* src, int num_values,
class DeltaLengthByteArrayEncoder : public EncoderImpl,
virtual public TypedEncoder<ByteArrayType> {
public:
explicit DeltaLengthByteArrayEncoder(const ColumnDescriptor* descr, MemoryPool* pool)
: EncoderImpl(descr, Encoding::DELTA_LENGTH_BYTE_ARRAY,
pool = ::arrow::default_memory_pool()),
explicit DeltaLengthByteArrayEncoder(const ColumnDescriptor* descr,
MemoryPool* pool = ::arrow::default_memory_pool())
: EncoderImpl(descr, Encoding::DELTA_LENGTH_BYTE_ARRAY, pool),
sink_(pool),
length_encoder_(nullptr, pool) {}

Expand All @@ -1408,6 +1409,67 @@ class DeltaLengthByteArrayEncoder : public EncoderImpl,
protected:
template <typename ArrayType>
void PutBinaryArray(const ArrayType& array) {
if (array.length() == 0 || array.null_count() == array.length()) {
return;
}

constexpr int kBatchSize = 256;
std::array<int32_t, kBatchSize> lengths;

if constexpr (!std::is_same_v<ArrayType, ::arrow::BinaryViewArray>) {
if (array.null_count() == 0) {
const int64_t num_values = array.length();
const auto* offsets = array.raw_value_offsets();
const int64_t start_offset = offsets[0];
const int64_t total_bytes =
static_cast<int64_t>(offsets[num_values]) - start_offset;
if constexpr (sizeof(typename ArrayType::offset_type) > sizeof(int32_t)) {
for (int64_t i = 0; i < num_values; ++i) {
const int64_t len = offsets[i + 1] - offsets[i];
if (ARROW_PREDICT_FALSE(len < 0 ||
static_cast<size_t>(len) > kMaxByteArraySize)) {
PARQUET_THROW_NOT_OK(Status::Invalid(
"Parquet cannot store strings with size 2GB or more, got: ", len));
}
}
}
if (ARROW_PREDICT_FALSE(total_bytes < 0 ||
total_bytes > std::numeric_limits<int32_t>::max() -
sink_.length())) {
PARQUET_THROW_NOT_OK(
Status::Invalid("excess expansion in DELTA_LENGTH_BYTE_ARRAY"));
}
if (total_bytes > 0) {
PARQUET_THROW_NOT_OK(sink_.Reserve(total_bytes));
}
for (int64_t idx = 0; idx < num_values; idx += kBatchSize) {
const int batch_size =
static_cast<int>(std::min<int64_t>(kBatchSize, num_values - idx));
for (int j = 0; j < batch_size; ++j) {
const int64_t len =
static_cast<int64_t>(offsets[idx + j + 1]) - offsets[idx + j];
if (ARROW_PREDICT_FALSE(len < 0)) {
PARQUET_THROW_NOT_OK(
Status::Invalid("Negative string length in BinaryArray: ", len));
}
lengths[j] = static_cast<int32_t>(len);
}
length_encoder_.Put(lengths.data(), batch_size);
}
if (total_bytes > 0) {
sink_.UnsafeAppend(array.raw_data() + start_offset, total_bytes);
unencoded_byte_array_data_bytes_ += total_bytes;
}
return;
}
}

const int64_t estimated_bytes = GetBinaryDataSize(array);
if (estimated_bytes > 0 &&
estimated_bytes <= std::numeric_limits<int32_t>::max() - sink_.length()) {
PARQUET_THROW_NOT_OK(sink_.Reserve(estimated_bytes));
}
int batch_len = 0;
PARQUET_THROW_NOT_OK(::arrow::VisitArraySpanInline<typename ArrayType::TypeClass>(
*array.data(),
[&](::std::string_view view) {
Expand All @@ -1420,12 +1482,21 @@ class DeltaLengthByteArrayEncoder : public EncoderImpl,
static_cast<size_t>(std::numeric_limits<int32_t>::max()))) {
return Status::Invalid("excess expansion in DELTA_LENGTH_BYTE_ARRAY");
}
length_encoder_.Put({static_cast<int32_t>(view.length())}, 1);
PARQUET_THROW_NOT_OK(sink_.Append(view.data(), view.length()));
unencoded_byte_array_data_bytes_ += view.size();
lengths[batch_len++] = static_cast<int32_t>(view.length());
if (batch_len == kBatchSize) {
length_encoder_.Put(lengths.data(), kBatchSize);
batch_len = 0;
}
if (!view.empty()) {
RETURN_NOT_OK(sink_.Append(view.data(), static_cast<int64_t>(view.length())));
unencoded_byte_array_data_bytes_ += view.size();
}
return Status::OK();
},
[]() { return Status::OK(); }));
if (batch_len > 0) {
length_encoder_.Put(lengths.data(), batch_len);
}
}

::arrow::BufferBuilder sink_;
Expand Down Expand Up @@ -1469,11 +1540,15 @@ void DeltaLengthByteArrayEncoder::Put(const T* src, int num_values) {
if (sink_.length() + total_increment_size > std::numeric_limits<int32_t>::max()) {
throw ParquetException("excess expansion in DELTA_LENGTH_BYTE_ARRAY");
}
PARQUET_THROW_NOT_OK(sink_.Reserve(total_increment_size));
for (int idx = 0; idx < num_values; idx++) {
sink_.UnsafeAppend(src[idx].ptr, src[idx].len);
if (total_increment_size > 0) {
PARQUET_THROW_NOT_OK(sink_.Reserve(total_increment_size));
for (int idx = 0; idx < num_values; idx++) {
if (src[idx].len > 0) {
sink_.UnsafeAppend(src[idx].ptr, src[idx].len);
}
}
unencoded_byte_array_data_bytes_ += total_increment_size;
}
unencoded_byte_array_data_bytes_ += total_increment_size;
}

void DeltaLengthByteArrayEncoder::PutSpaced(const T* src, int num_values,
Expand Down
210 changes: 210 additions & 0 deletions cpp/src/parquet/encoding_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
#include <functional>
#include <limits>
#include <span>
#include <string>
#include <utility>
#include <vector>

Expand All @@ -32,6 +33,7 @@
#include "arrow/array/builder_dict.h"
#include "arrow/array/concatenate.h"
#include "arrow/compute/cast.h"
#include "arrow/memory_pool.h"
#include "arrow/testing/gtest_util.h"
#include "arrow/testing/random.h"
#include "arrow/testing/util.h"
Expand Down Expand Up @@ -2391,6 +2393,214 @@ TEST(DeltaLengthByteArrayEncodingAdHoc, ArrowDirectPut) {
}
}

TEST(DeltaLengthByteArrayEncodingAdHoc, UsesProvidedMemoryPool) {
constexpr int kCount = 320;
::arrow::StringBuilder dense_builder;
::arrow::StringBuilder nullable_builder;
::arrow::LargeStringBuilder large_builder;
::arrow::StringViewBuilder view_builder;

int64_t expected_payload_bytes = 0;
std::vector<std::string> raw_strings;
raw_strings.reserve(kCount);
for (int i = 0; i < kCount; ++i) {
std::string val = (i % 2 == 0) ? ("short_" + std::to_string(i))
: ("long_out_of_line_payload_" + std::to_string(i));
raw_strings.push_back(val);
ASSERT_OK(dense_builder.Append(val));
expected_payload_bytes += static_cast<int64_t>(val.size());

if (i % 7 == 0) {
ASSERT_OK(nullable_builder.AppendNull());
} else {
ASSERT_OK(nullable_builder.Append(val));
expected_payload_bytes += static_cast<int64_t>(val.size());
}
ASSERT_OK(large_builder.Append(val));
ASSERT_OK(view_builder.Append(val));
expected_payload_bytes += static_cast<int64_t>(val.size());
}
ASSERT_OK_AND_ASSIGN(auto dense_arr, dense_builder.Finish());
ASSERT_OK_AND_ASSIGN(auto nullable_arr, nullable_builder.Finish());
ASSERT_OK_AND_ASSIGN(auto large_arr, large_builder.Finish());
auto sliced_large = large_arr->Slice(5, kCount - 10);
for (int i = 5; i < kCount - 5; ++i) {
expected_payload_bytes += static_cast<int64_t>(raw_strings[i].size());
}
ASSERT_OK_AND_ASSIGN(auto view_arr, view_builder.Finish());

std::vector<ByteArray> raw_ba;
raw_ba.reserve(raw_strings.size());
for (const auto& s : raw_strings) {
raw_ba.emplace_back(static_cast<uint32_t>(s.size()),
reinterpret_cast<const uint8_t*>(s.data()));
expected_payload_bytes += static_cast<int64_t>(s.size());
}

::arrow::ProxyMemoryPool tracking_pool(default_memory_pool());
{
auto encoder = MakeTypedEncoder<ByteArrayType>(Encoding::DELTA_LENGTH_BYTE_ARRAY,
/*use_dictionary=*/false,
/*descr=*/nullptr, &tracking_pool);
EXPECT_EQ(&tracking_pool, encoder->memory_pool());

for (const auto& arr : {dense_arr, nullable_arr, sliced_large, view_arr}) {
encoder->Put(*arr);
auto flushed = encoder->FlushValues();
ASSERT_GT(flushed->size(), 0);
}
encoder->Put(raw_ba.data(), static_cast<int>(raw_ba.size()));
auto flushed = encoder->FlushValues();
ASSERT_GT(flushed->size(), 0);

auto dba_encoder = MakeTypedEncoder<ByteArrayType>(Encoding::DELTA_BYTE_ARRAY,
/*use_dictionary=*/false,
/*descr=*/nullptr, &tracking_pool);
dba_encoder->Put(*dense_arr);
ASSERT_GT(dba_encoder->FlushValues()->size(), 0);
}

EXPECT_GT(tracking_pool.num_allocations(), 0);
EXPECT_GE(tracking_pool.total_bytes_allocated(), expected_payload_bytes);
EXPECT_EQ(0, tracking_pool.bytes_allocated());
}

TEST(DeltaLengthByteArrayEncodingAdHoc, BatchedLengthsSlicesAndZeroLengthSafety) {
auto descr = ExampleDescr<ByteArrayType>();
auto encoder = MakeTypedEncoder<ByteArrayType>(Encoding::DELTA_LENGTH_BYTE_ARRAY,
/*use_dictionary=*/false, descr.get());
auto decoder =
MakeTypedDecoder<ByteArrayType>(Encoding::DELTA_LENGTH_BYTE_ARRAY, descr.get());

auto VerifyArrayRoundTrip = [&](const std::shared_ptr<::arrow::Array>& arr,
const std::vector<int32_t>& expected_valid_lengths,
const std::string& expected_payload) {
encoder->Put(*arr);
EXPECT_EQ(static_cast<int64_t>(expected_payload.size()),
encoder->ReportUnencodedDataBytes());
auto buf = encoder->FlushValues();

auto expected_len_buf = DeltaEncode(expected_valid_lengths);
ASSERT_EQ(expected_len_buf->size() + static_cast<int64_t>(expected_payload.size()),
buf->size());
EXPECT_TRUE(SliceBuffer(buf, 0, expected_len_buf->size())->Equals(*expected_len_buf));
EXPECT_TRUE(
SliceBuffer(buf, expected_len_buf->size())->Equals(Buffer(expected_payload)));

const int num_valid = static_cast<int>(expected_valid_lengths.size());
decoder->SetData(num_valid, buf->data(), static_cast<int>(buf->size()));
typename EncodingTraits<ByteArrayType>::Accumulator acc;
ASSERT_OK_AND_ASSIGN(acc.builder, ::arrow::MakeBuilder(arr->type()));
ASSERT_EQ(num_valid,
decoder->DecodeArrow(static_cast<int>(arr->length()),
static_cast<int>(arr->null_count()),
arr->null_bitmap_data(), arr->offset(), &acc));
std::shared_ptr<::arrow::Array> decoded;
ASSERT_OK(acc.builder->Finish(&decoded));
::arrow::AssertArraysEqual(*arr, *decoded, /*verbose=*/true);
};

for (int count : {0, 1, 255, 256, 257, 512, 600}) {
ARROW_SCOPED_TRACE("count = ", count);
::arrow::StringBuilder dense_b;
::arrow::StringBuilder nullable_b;
::arrow::StringBuilder empty_b;
::arrow::StringBuilder nulls_b;
std::vector<int32_t> dense_lens, nullable_lens, empty_lens(count, 0);
std::string dense_payload, nullable_payload;

for (int i = 0; i < count; ++i) {
std::string s = (i % 11 == 0) ? "" : ("v_" + std::to_string(i));
ASSERT_OK(dense_b.Append(s));
dense_lens.push_back(static_cast<int32_t>(s.size()));
dense_payload.append(s);

if (i % 5 == 0) {
ASSERT_OK(nullable_b.AppendNull());
} else {
ASSERT_OK(nullable_b.Append(s));
nullable_lens.push_back(static_cast<int32_t>(s.size()));
nullable_payload.append(s);
}
ASSERT_OK(empty_b.Append(""));
ASSERT_OK(nulls_b.AppendNull());
}
ASSERT_OK_AND_ASSIGN(auto dense_arr, dense_b.Finish());
ASSERT_OK_AND_ASSIGN(auto nullable_arr, nullable_b.Finish());
ASSERT_OK_AND_ASSIGN(auto empty_arr, empty_b.Finish());
ASSERT_OK_AND_ASSIGN(auto nulls_arr, nulls_b.Finish());

VerifyArrayRoundTrip(dense_arr, dense_lens, dense_payload);
VerifyArrayRoundTrip(nullable_arr, nullable_lens, nullable_payload);
VerifyArrayRoundTrip(empty_arr, empty_lens, "");
VerifyArrayRoundTrip(nulls_arr, {}, "");
}

{
::arrow::LargeStringBuilder large_b;
std::vector<std::string> vals;
for (int i = 0; i < 300; ++i) {
vals.push_back((i % 13 == 0) ? "" : ("slice_item_" + std::to_string(i)));
ASSERT_OK(large_b.Append(vals.back()));
}
ASSERT_OK_AND_ASSIGN(auto large_arr, large_b.Finish());
auto sliced = large_arr->Slice(17, 260);
std::vector<int32_t> lens;
std::string payload;
for (int i = 17; i < 17 + 260; ++i) {
lens.push_back(static_cast<int32_t>(vals[i].size()));
payload.append(vals[i]);
}
VerifyArrayRoundTrip(sliced, lens, payload);
}

{
::arrow::StringViewBuilder view_b;
std::vector<int32_t> lens;
std::string payload;
for (int i = 0; i < 270; ++i) {
if (i % 9 == 0) {
ASSERT_OK(view_b.AppendNull());
continue;
}
std::string s = (i % 3 == 0) ? ""
: (i % 3 == 1) ? ("in_" + std::to_string(i))
: ("out_of_line_string_view_" + std::to_string(i));
ASSERT_OK(view_b.Append(s));
lens.push_back(static_cast<int32_t>(s.size()));
payload.append(s);
}
ASSERT_OK_AND_ASSIGN(auto view_arr, view_b.Finish());
VerifyArrayRoundTrip(view_arr, lens, payload);
}

{
const std::string abc = "abc";
std::vector<ByteArray> mixed = {
ByteArray(0, nullptr),
ByteArray(3, reinterpret_cast<const uint8_t*>(abc.data())),
ByteArray(0, nullptr),
};
encoder->Put(mixed.data(), static_cast<int>(mixed.size()));
EXPECT_EQ(3, encoder->ReportUnencodedDataBytes());
auto buf = encoder->FlushValues();
EXPECT_EQ(DeltaEncode({0, 3, 0})->ToString() + "abc", buf->ToString());

std::vector<ByteArray> all_zero_null(4, ByteArray(0, nullptr));
encoder->Put(all_zero_null.data(), static_cast<int>(all_zero_null.size()));
EXPECT_EQ(0, encoder->ReportUnencodedDataBytes());
auto zero_buf = encoder->FlushValues();
EXPECT_EQ(DeltaEncode({0, 0, 0, 0})->ToString(), zero_buf->ToString());

const uint8_t valid_bits = 0b00001010;
encoder->PutSpaced(all_zero_null.data(), 4, &valid_bits, /*valid_bits_offset=*/0);
EXPECT_EQ(0, encoder->ReportUnencodedDataBytes());
auto spaced_buf = encoder->FlushValues();
EXPECT_EQ(DeltaEncode(std::vector<int32_t>{0, 0})->ToString(),
spaced_buf->ToString());
}
}

// ----------------------------------------------------------------------
// DELTA_BYTE_ARRAY encode/decode tests.

Expand Down
Loading