1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
#pragma clang system_header
// 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.
// Internal metadata serialization matters
#pragma once
#include <cstdint>
#include <cstring>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include <flatbuffers/flatbuffers.h>
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/buffer.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/io/type_fwd.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/ipc/message.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/result.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/sparse_tensor.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/status.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/type_fwd.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/util/macros.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/util/visibility.h"
#include "contrib/libs/apache/arrow_next/cpp/src/generated/Message.fbs.h"
#include "contrib/libs/apache/arrow_next/cpp/src/generated/Schema.fbs.h"
#include "contrib/libs/apache/arrow_next/cpp/src/generated/SparseTensor.fbs.h" // IWYU pragma: keep
namespace arrow20 {
namespace flatbuf = org::apache::arrow20::flatbuf;
namespace ipc {
class DictionaryFieldMapper;
class DictionaryMemo;
namespace internal {
using KeyValueOffset = flatbuffers::Offset<flatbuf::KeyValue>;
using KVVector = flatbuffers::Vector<KeyValueOffset>;
// This 0xFFFFFFFF value is the first 4 bytes of a valid IPC message
constexpr int32_t kIpcContinuationToken = -1;
static constexpr flatbuf::MetadataVersion kCurrentMetadataVersion =
flatbuf::MetadataVersion::MetadataVersion_V5;
static constexpr flatbuf::MetadataVersion kLatestMetadataVersion =
flatbuf::MetadataVersion::MetadataVersion_V5;
static constexpr flatbuf::MetadataVersion kMinMetadataVersion =
flatbuf::MetadataVersion::MetadataVersion_V4;
// These functions are used in unit tests
ARROW_EXPORT
MetadataVersion GetMetadataVersion(flatbuf::MetadataVersion version);
ARROW_EXPORT
flatbuf::MetadataVersion MetadataVersionToFlatbuffer(MetadataVersion version);
// Whether the type has a validity bitmap in the given IPC version
bool HasValidityBitmap(Type::type type_id, MetadataVersion version);
static constexpr const char* kArrowMagicBytes = "ARROW1";
struct FieldMetadata {
int64_t length;
int64_t null_count;
int64_t offset;
};
struct BufferMetadata {
/// The relative offset into the memory page to the starting byte of the buffer
int64_t offset;
/// Absolute length in bytes of the buffer
int64_t length;
};
struct FileBlock {
int64_t offset;
int32_t metadata_length;
int64_t body_length;
};
// Low-level utilities to help with reading Flatbuffers data.
#define CHECK_FLATBUFFERS_NOT_NULL(fb_value, name) \
if ((fb_value) == NULLPTR) { \
return Status::IOError("Unexpected null field ", name, \
" in flatbuffer-encoded metadata"); \
}
template <typename T>
inline uint32_t FlatBuffersVectorSize(const flatbuffers::Vector<T>* vec) {
return (vec == NULLPTR) ? 0 : vec->size();
}
inline std::string StringFromFlatbuffers(const flatbuffers::String* s) {
return (s == NULLPTR) ? "" : s->str();
}
// Read interface classes. We do not fully deserialize the flatbuffers so that
// individual fields metadata can be retrieved from very large schema without
//
// Construct a complete Schema from the message and add
// dictionary-encoded fields to a DictionaryMemo instance. May be
// expensive for very large schemas if you are only interested in a
// few fields
ARROW_EXPORT
Status GetSchema(const void* opaque_schema, DictionaryMemo* dictionary_memo,
std::shared_ptr<Schema>* out);
ARROW_EXPORT
Status GetTensorMetadata(const Buffer& metadata, std::shared_ptr<DataType>* type,
std::vector<int64_t>* shape, std::vector<int64_t>* strides,
std::vector<std::string>* dim_names);
// EXPERIMENTAL: Extracting metadata of a SparseCOOIndex from the message
ARROW_EXPORT
Status GetSparseCOOIndexMetadata(const flatbuf::SparseTensorIndexCOO* sparse_index,
std::shared_ptr<DataType>* indices_type);
// EXPERIMENTAL: Extracting metadata of a SparseCSXIndex from the message
ARROW_EXPORT
Status GetSparseCSXIndexMetadata(const flatbuf::SparseMatrixIndexCSX* sparse_index,
std::shared_ptr<DataType>* indptr_type,
std::shared_ptr<DataType>* indices_type);
// EXPERIMENTAL: Extracting metadata of a SparseCSFIndex from the message
ARROW_EXPORT
Status GetSparseCSFIndexMetadata(const flatbuf::SparseTensorIndexCSF* sparse_index,
std::vector<int64_t>* axis_order,
std::vector<int64_t>* indices_size,
std::shared_ptr<DataType>* indptr_type,
std::shared_ptr<DataType>* indices_type);
// EXPERIMENTAL: Extracting metadata of a sparse tensor from the message
ARROW_EXPORT
Status GetSparseTensorMetadata(const Buffer& metadata, std::shared_ptr<DataType>* type,
std::vector<int64_t>* shape,
std::vector<std::string>* dim_names, int64_t* length,
SparseTensorFormat::type* sparse_tensor_format_id);
ARROW_EXPORT
Status GetKeyValueMetadata(const KVVector* fb_metadata,
std::shared_ptr<KeyValueMetadata>* out);
ARROW_EXPORT
Status ConcreteTypeFromFlatbuffer(flatbuf::Type type, const void* type_data,
FieldVector children, std::shared_ptr<DataType>* out);
template <typename RootType>
bool VerifyFlatbuffers(const uint8_t* data, int64_t size) {
// Heuristic: tables in a Arrow flatbuffers buffer must take at least 1 bit
// each in average (ARROW-11559).
// Especially, the only recursive table (the `Field` table in Schema.fbs)
// must have a non-empty `type` member.
flatbuffers::Verifier verifier(
data, static_cast<size_t>(size),
/*max_depth=*/128,
/*max_tables=*/static_cast<flatbuffers::uoffset_t>(8 * size));
return verifier.VerifyBuffer<RootType>(nullptr);
}
static inline Status VerifyMessage(const uint8_t* data, int64_t size,
const flatbuf::Message** out) {
if (!VerifyFlatbuffers<flatbuf::Message>(data, size)) {
return Status::IOError("Invalid flatbuffers message.");
}
*out = flatbuf::GetMessage(data);
return Status::OK();
}
// Serialize arrow20::Schema as a Flatbuffer
ARROW_EXPORT
Status WriteSchemaMessage(const Schema& schema, const DictionaryFieldMapper& mapper,
const IpcWriteOptions& options, std::shared_ptr<Buffer>* out);
// This function is used in a unit test
ARROW_EXPORT
Status WriteRecordBatchMessage(
const int64_t length, const int64_t body_length,
const std::shared_ptr<const KeyValueMetadata>& custom_metadata,
const std::vector<FieldMetadata>& nodes, const std::vector<BufferMetadata>& buffers,
const std::vector<int64_t>& variadic_counts, const IpcWriteOptions& options,
std::shared_ptr<Buffer>* out);
ARROW_EXPORT
Result<std::shared_ptr<Buffer>> WriteTensorMessage(const Tensor& tensor,
const int64_t buffer_start_offset,
const IpcWriteOptions& options);
ARROW_EXPORT
Result<std::shared_ptr<Buffer>> WriteSparseTensorMessage(
const SparseTensor& sparse_tensor, int64_t body_length,
const std::vector<BufferMetadata>& buffers, const IpcWriteOptions& options);
ARROW_EXPORT
Status WriteFileFooter(const Schema& schema, const std::vector<FileBlock>& dictionaries,
const std::vector<FileBlock>& record_batches,
const std::shared_ptr<const KeyValueMetadata>& metadata,
io::OutputStream* out);
ARROW_EXPORT
Status WriteDictionaryMessage(
const int64_t id, const bool is_delta, const int64_t length,
const int64_t body_length,
const std::shared_ptr<const KeyValueMetadata>& custom_metadata,
const std::vector<FieldMetadata>& nodes, const std::vector<BufferMetadata>& buffers,
const std::vector<int64_t>& variadic_counts, const IpcWriteOptions& options,
std::shared_ptr<Buffer>* out);
static inline Result<std::shared_ptr<Buffer>> WriteFlatbufferBuilder(
flatbuffers::FlatBufferBuilder& fbb, // NOLINT non-const reference
MemoryPool* pool = default_memory_pool()) {
int32_t size = fbb.GetSize();
ARROW_ASSIGN_OR_RAISE(auto result, AllocateBuffer(size, pool));
uint8_t* dst = result->mutable_data();
memcpy(dst, fbb.GetBufferPointer(), size);
// R build with openSUSE155 requires an explicit shared_ptr construction
return std::shared_ptr<Buffer>(std::move(result));
}
ARROW_EXPORT
flatbuf::TimeUnit ToFlatbufferUnit(TimeUnit::type unit);
ARROW_EXPORT
TimeUnit::type FromFlatbufferUnit(flatbuf::TimeUnit unit);
} // namespace internal
} // namespace ipc
} // namespace arrow20
|
