-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
validate.cc
651 lines (548 loc) · 22.4 KB
/
validate.cc
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
// 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.
#include "arrow/array/validate.h"
#include <vector>
#include "arrow/array.h" // IWYU pragma: keep
#include "arrow/extension_type.h"
#include "arrow/type.h"
#include "arrow/type_traits.h"
#include "arrow/util/bit_block_counter.h"
#include "arrow/util/bit_util.h"
#include "arrow/util/checked_cast.h"
#include "arrow/util/int_util_internal.h"
#include "arrow/util/logging.h"
#include "arrow/util/utf8.h"
#include "arrow/visitor_inline.h"
namespace arrow {
namespace internal {
///////////////////////////////////////////////////////////////////////////
// ValidateArray: cheap validation checks
namespace {
struct ValidateArrayImpl {
const ArrayData& data;
Status Validate() { return ValidateWithType(*data.type); }
Status ValidateWithType(const DataType& type) { return VisitTypeInline(type, this); }
Status Visit(const NullType&) {
if (data.null_count != data.length) {
return Status::Invalid("Null array null_count unequal to its length");
}
return Status::OK();
}
Status Visit(const FixedWidthType&) {
if (data.length > 0) {
if (!IsBufferValid(1)) {
return Status::Invalid("Missing values buffer in non-empty array");
}
}
return Status::OK();
}
Status Visit(const StringType& type) { return ValidateBinaryLike(type); }
Status Visit(const BinaryType& type) { return ValidateBinaryLike(type); }
Status Visit(const LargeStringType& type) { return ValidateBinaryLike(type); }
Status Visit(const LargeBinaryType& type) { return ValidateBinaryLike(type); }
Status Visit(const ListType& type) { return ValidateListLike(type); }
Status Visit(const LargeListType& type) { return ValidateListLike(type); }
Status Visit(const MapType& type) { return ValidateListLike(type); }
Status Visit(const FixedSizeListType& type) {
const ArrayData& values = *data.child_data[0];
const int64_t list_size = type.list_size();
if (list_size < 0) {
return Status::Invalid("Fixed size list has negative list size");
}
int64_t expected_values_length = -1;
if (MultiplyWithOverflow(data.length, list_size, &expected_values_length) ||
values.length != expected_values_length) {
return Status::Invalid("Values length (", values.length,
") is not equal to the length (", data.length,
") multiplied by the value size (", list_size, ")");
}
const Status child_valid = ValidateArray(values);
if (!child_valid.ok()) {
return Status::Invalid("Fixed size list child array invalid: ",
child_valid.ToString());
}
return Status::OK();
}
Status Visit(const StructType& type) {
for (int i = 0; i < type.num_fields(); ++i) {
const auto& field_data = *data.child_data[i];
// Validate child first, to catch nonsensical length / offset etc.
const Status field_valid = ValidateArray(field_data);
if (!field_valid.ok()) {
return Status::Invalid("Struct child array #", i,
" invalid: ", field_valid.ToString());
}
if (field_data.length < data.length + data.offset) {
return Status::Invalid("Struct child array #", i,
" has length smaller than expected for struct array (",
field_data.length, " < ", data.length + data.offset, ")");
}
const auto& field_type = type.field(i)->type();
if (!field_data.type->Equals(*field_type)) {
return Status::Invalid("Struct child array #", i, " does not match type field: ",
field_data.type->ToString(), " vs ",
field_type->ToString());
}
}
return Status::OK();
}
Status Visit(const UnionType& type) {
for (int i = 0; i < type.num_fields(); ++i) {
const auto& field_data = *data.child_data[i];
// Validate child first, to catch nonsensical length / offset etc.
const Status field_valid = ValidateArray(field_data);
if (!field_valid.ok()) {
return Status::Invalid("Union child array #", i,
" invalid: ", field_valid.ToString());
}
if (type.mode() == UnionMode::SPARSE &&
field_data.length < data.length + data.offset) {
return Status::Invalid("Sparse union child array #", i,
" has length smaller than expected for union array (",
field_data.length, " < ", data.length + data.offset, ")");
}
const auto& field_type = type.field(i)->type();
if (!field_data.type->Equals(*field_type)) {
return Status::Invalid("Union child array #", i, " does not match type field: ",
field_data.type->ToString(), " vs ",
field_type->ToString());
}
}
return Status::OK();
}
Status Visit(const DictionaryType& type) {
Type::type index_type_id = type.index_type()->id();
if (!is_integer(index_type_id)) {
return Status::Invalid("Dictionary indices must be integer type");
}
if (!data.dictionary) {
return Status::Invalid("Dictionary values must be non-null");
}
const Status dict_valid = ValidateArray(*data.dictionary);
if (!dict_valid.ok()) {
return Status::Invalid("Dictionary array invalid: ", dict_valid.ToString());
}
// Visit indices
return ValidateWithType(*type.index_type());
}
Status Visit(const ExtensionType& type) {
// Visit storage
return ValidateWithType(*type.storage_type());
}
private:
bool IsBufferValid(int index) { return IsBufferValid(data, index); }
static bool IsBufferValid(const ArrayData& data, int index) {
return data.buffers[index] != nullptr && data.buffers[index]->data() != nullptr;
}
template <typename BinaryType>
Status ValidateBinaryLike(const BinaryType& type) {
if (!IsBufferValid(2)) {
return Status::Invalid("Value data buffer is null");
}
// First validate offsets, to make sure the accesses below are valid
RETURN_NOT_OK(ValidateOffsets(type));
if (data.length > 0 && data.buffers[1]->is_cpu()) {
using offset_type = typename BinaryType::offset_type;
const auto offsets = data.GetValues<offset_type>(1);
const Buffer& values = *data.buffers[2];
const auto first_offset = offsets[0];
const auto last_offset = offsets[data.length];
// This early test avoids undefined behaviour when computing `data_extent`
if (first_offset < 0 || last_offset < 0) {
return Status::Invalid("Negative offsets in binary array");
}
const auto data_extent = last_offset - first_offset;
const auto values_length = values.size();
if (values_length < data_extent) {
return Status::Invalid("Length spanned by binary offsets (", data_extent,
") larger than values array (size ", values_length, ")");
}
// These tests ensure that array concatenation is safe if Validate() succeeds
// (for delta dictionaries)
if (first_offset > values_length || last_offset > values_length) {
return Status::Invalid("First or last binary offset out of bounds");
}
if (first_offset > last_offset) {
return Status::Invalid("First offset larger than last offset in binary array");
}
}
return Status::OK();
}
template <typename ListType>
Status ValidateListLike(const ListType& type) {
// First validate offsets, to make sure the accesses below are valid
RETURN_NOT_OK(ValidateOffsets(type));
const ArrayData& values = *data.child_data[0];
// An empty list array can have 0 offsets
if (data.length > 0 && data.buffers[1]->is_cpu()) {
using offset_type = typename ListType::offset_type;
const auto offsets = data.GetValues<offset_type>(1);
const auto first_offset = offsets[0];
const auto last_offset = offsets[data.length];
// This early test avoids undefined behaviour when computing `data_extent`
if (first_offset < 0 || last_offset < 0) {
return Status::Invalid("Negative offsets in list array");
}
const auto data_extent = last_offset - first_offset;
const auto values_length = values.length;
if (values_length < data_extent) {
return Status::Invalid("Length spanned by list offsets (", data_extent,
") larger than values array (length ", values_length, ")");
}
// These tests ensure that array concatenation is safe if Validate() succeeds
// (for delta dictionaries)
if (first_offset > values_length || last_offset > values_length) {
return Status::Invalid("First or last list offset out of bounds");
}
if (first_offset > last_offset) {
return Status::Invalid("First offset larger than last offset in list array");
}
}
const Status child_valid = ValidateArray(values);
if (!child_valid.ok()) {
return Status::Invalid("List child array invalid: ", child_valid.ToString());
}
return Status::OK();
}
template <typename TypeClass>
Status ValidateOffsets(const TypeClass& type) {
using offset_type = typename TypeClass::offset_type;
const Buffer* offsets = data.buffers[1].get();
if (offsets == nullptr) {
// For length 0, an empty offsets buffer seems accepted as a special case
// (ARROW-544)
if (data.length > 0) {
return Status::Invalid("Non-empty array but offsets are null");
}
return Status::OK();
}
// An empty list array can have 0 offsets
auto required_offsets = (data.length > 0) ? data.length + data.offset + 1 : 0;
if (offsets->size() / static_cast<int32_t>(sizeof(offset_type)) < required_offsets) {
return Status::Invalid("Offsets buffer size (bytes): ", offsets->size(),
" isn't large enough for length: ", data.length);
}
return Status::OK();
}
};
} // namespace
ARROW_EXPORT
Status ValidateArray(const ArrayData& data) {
// First check the data layout conforms to the spec
const DataType& type = *data.type;
const auto layout = type.layout();
if (data.length < 0) {
return Status::Invalid("Array length is negative");
}
if (data.buffers.size() != layout.buffers.size()) {
return Status::Invalid("Expected ", layout.buffers.size(),
" buffers in array "
"of type ",
type.ToString(), ", got ", data.buffers.size());
}
// This check is required to avoid addition overflow below
int64_t length_plus_offset = -1;
if (AddWithOverflow(data.length, data.offset, &length_plus_offset)) {
return Status::Invalid("Array of type ", type.ToString(),
" has impossibly large length and offset");
}
for (int i = 0; i < static_cast<int>(data.buffers.size()); ++i) {
const auto& buffer = data.buffers[i];
const auto& spec = layout.buffers[i];
if (buffer == nullptr) {
continue;
}
int64_t min_buffer_size = -1;
switch (spec.kind) {
case DataTypeLayout::BITMAP:
min_buffer_size = BitUtil::BytesForBits(length_plus_offset);
break;
case DataTypeLayout::FIXED_WIDTH:
if (MultiplyWithOverflow(length_plus_offset, spec.byte_width, &min_buffer_size)) {
return Status::Invalid("Array of type ", type.ToString(),
" has impossibly large length and offset");
}
break;
case DataTypeLayout::ALWAYS_NULL:
// XXX Should we raise on non-null buffer?
continue;
default:
continue;
}
if (buffer->size() < min_buffer_size) {
return Status::Invalid("Buffer #", i, " too small in array of type ",
type.ToString(), " and length ", data.length,
": expected at least ", min_buffer_size, " byte(s), got ",
buffer->size());
}
}
if (type.id() != Type::NA && data.null_count > 0 && data.buffers[0] == nullptr) {
return Status::Invalid("Array of type ", type.ToString(), " has ", data.null_count,
" nulls but no null bitmap");
}
// Check null_count() *after* validating the buffer sizes, to avoid
// reading out of bounds.
if (data.null_count > data.length) {
return Status::Invalid("Null count exceeds array length");
}
if (data.null_count < 0 && data.null_count != kUnknownNullCount) {
return Status::Invalid("Negative null count");
}
if (type.id() != Type::EXTENSION) {
if (data.child_data.size() != static_cast<size_t>(type.num_fields())) {
return Status::Invalid("Expected ", type.num_fields(),
" child arrays in array "
"of type ",
type.ToString(), ", got ", data.child_data.size());
}
}
if (layout.has_dictionary && !data.dictionary) {
return Status::Invalid("Array of type ", type.ToString(),
" must have dictionary values");
}
if (!layout.has_dictionary && data.dictionary) {
return Status::Invalid("Unexpected dictionary values in array of type ",
type.ToString());
}
ValidateArrayImpl validator{data};
return validator.Validate();
}
ARROW_EXPORT
Status ValidateArray(const Array& array) { return ValidateArray(*array.data()); }
///////////////////////////////////////////////////////////////////////////
// ValidateArrayFull: expensive validation checks
namespace {
struct UTF8DataValidator {
const ArrayData& data;
Status Visit(const DataType&) {
// Default, should be unreachable
return Status::NotImplemented("");
}
template <typename StringType>
enable_if_string<StringType, Status> Visit(const StringType&) {
util::InitializeUTF8();
int64_t i = 0;
return VisitArrayDataInline<StringType>(
data,
[&](util::string_view v) {
if (ARROW_PREDICT_FALSE(!util::ValidateUTF8(v))) {
return Status::Invalid("Invalid UTF8 sequence at string index ", i);
}
++i;
return Status::OK();
},
[&]() {
++i;
return Status::OK();
});
}
};
struct BoundsChecker {
const ArrayData& data;
int64_t min_value;
int64_t max_value;
Status Visit(const DataType&) {
// Default, should be unreachable
return Status::NotImplemented("");
}
template <typename IntegerType>
enable_if_integer<IntegerType, Status> Visit(const IntegerType&) {
using c_type = typename IntegerType::c_type;
int64_t i = 0;
return VisitArrayDataInline<IntegerType>(
data,
[&](c_type value) {
const auto v = static_cast<int64_t>(value);
if (ARROW_PREDICT_FALSE(v < min_value || v > max_value)) {
return Status::Invalid("Value at position ", i, " out of bounds: ", v,
" (should be in [", min_value, ", ", max_value, "])");
}
++i;
return Status::OK();
},
[&]() {
++i;
return Status::OK();
});
}
};
struct ValidateArrayFullImpl {
const ArrayData& data;
Status Validate() { return ValidateWithType(*data.type); }
Status ValidateWithType(const DataType& type) { return VisitTypeInline(type, this); }
Status Visit(const NullType& type) { return Status::OK(); }
Status Visit(const FixedWidthType& type) { return Status::OK(); }
Status Visit(const StringType& type) {
RETURN_NOT_OK(ValidateBinaryLike(type));
return ValidateUTF8(data);
}
Status Visit(const LargeStringType& type) {
RETURN_NOT_OK(ValidateBinaryLike(type));
return ValidateUTF8(data);
}
Status Visit(const BinaryType& type) { return ValidateBinaryLike(type); }
Status Visit(const LargeBinaryType& type) { return ValidateBinaryLike(type); }
Status Visit(const ListType& type) { return ValidateListLike(type); }
Status Visit(const LargeListType& type) { return ValidateListLike(type); }
Status Visit(const MapType& type) { return ValidateListLike(type); }
Status Visit(const FixedSizeListType& type) {
const ArrayData& child = *data.child_data[0];
const Status child_valid = ValidateArrayFull(child);
if (!child_valid.ok()) {
return Status::Invalid("Fixed size list child array invalid: ",
child_valid.ToString());
}
return Status::OK();
}
Status Visit(const StructType& type) {
// Validate children
for (int64_t i = 0; i < type.num_fields(); ++i) {
const ArrayData& field = *data.child_data[i];
const Status field_valid = ValidateArrayFull(field);
if (!field_valid.ok()) {
return Status::Invalid("Struct child array #", i,
" invalid: ", field_valid.ToString());
}
}
return Status::OK();
}
Status Visit(const UnionType& type) {
const auto& child_ids = type.child_ids();
const auto& type_codes_map = type.type_codes();
const int8_t* type_codes = data.GetValues<int8_t>(1);
for (int64_t i = 0; i < data.length; ++i) {
// Note that union arrays never have top-level nulls
const int32_t code = type_codes[i];
if (code < 0 || child_ids[code] == UnionType::kInvalidChildId) {
return Status::Invalid("Union value at position ", i, " has invalid type id ",
code);
}
}
if (type.mode() == UnionMode::DENSE) {
// Map logical type id to child length
std::vector<int64_t> child_lengths(256);
for (int child_id = 0; child_id < type.num_fields(); ++child_id) {
child_lengths[type_codes_map[child_id]] = data.child_data[child_id]->length;
}
// Check offsets are in bounds
const int32_t* offsets = data.GetValues<int32_t>(2);
for (int64_t i = 0; i < data.length; ++i) {
const int32_t code = type_codes[i];
const int32_t offset = offsets[i];
if (offset < 0) {
return Status::Invalid("Union value at position ", i, " has negative offset ",
offset);
}
if (offset >= child_lengths[code]) {
return Status::Invalid("Union value at position ", i,
" has offset larger "
"than child length (",
offset, " >= ", child_lengths[code], ")");
}
}
}
// Validate children
for (int64_t i = 0; i < type.num_fields(); ++i) {
const ArrayData& field = *data.child_data[i];
const Status field_valid = ValidateArrayFull(field);
if (!field_valid.ok()) {
return Status::Invalid("Struct child array #", i,
" invalid: ", field_valid.ToString());
}
}
return Status::OK();
}
Status Visit(const DictionaryType& type) {
const Status indices_status =
CheckBounds(*type.index_type(), 0, data.dictionary->length - 1);
if (!indices_status.ok()) {
return Status::Invalid("Dictionary indices invalid: ", indices_status.ToString());
}
return ValidateArrayFull(*data.dictionary);
}
Status Visit(const ExtensionType& type) {
return ValidateWithType(*type.storage_type());
}
protected:
template <typename BinaryType>
Status ValidateBinaryLike(const BinaryType& type) {
const auto& data_buffer = data.buffers[2];
if (data_buffer == nullptr) {
return Status::Invalid("Binary data buffer is null");
}
return ValidateOffsets(type, data_buffer->size());
}
template <typename ListType>
Status ValidateListLike(const ListType& type) {
const ArrayData& child = *data.child_data[0];
const Status child_valid = ValidateArrayFull(child);
if (!child_valid.ok()) {
return Status::Invalid("List child array invalid: ", child_valid.ToString());
}
return ValidateOffsets(type, child.offset + child.length);
}
template <typename TypeClass>
Status ValidateOffsets(const TypeClass& type, int64_t offset_limit) {
using offset_type = typename TypeClass::offset_type;
if (data.length == 0) {
return Status::OK();
}
const offset_type* offsets = data.GetValues<offset_type>(1);
if (offsets == nullptr) {
return Status::Invalid("Non-empty array but offsets are null");
}
auto prev_offset = offsets[0];
if (prev_offset < 0) {
return Status::Invalid("Offset invariant failure: array starts at negative offset ",
prev_offset);
}
for (int64_t i = 1; i <= data.length; ++i) {
const auto current_offset = offsets[i];
if (current_offset < prev_offset) {
return Status::Invalid("Offset invariant failure: non-monotonic offset at slot ",
i, ": ", current_offset, " < ", prev_offset);
}
if (current_offset > offset_limit) {
return Status::Invalid("Offset invariant failure: offset for slot ", i,
" out of bounds: ", current_offset, " > ", offset_limit);
}
prev_offset = current_offset;
}
return Status::OK();
}
Status CheckBounds(const DataType& type, int64_t min_value, int64_t max_value) {
BoundsChecker checker{data, min_value, max_value};
return VisitTypeInline(type, &checker);
}
};
} // namespace
ARROW_EXPORT
Status ValidateArrayFull(const ArrayData& data) {
return ValidateArrayFullImpl{data}.Validate();
}
ARROW_EXPORT
Status ValidateArrayFull(const Array& array) { return ValidateArrayFull(*array.data()); }
ARROW_EXPORT
Status ValidateUTF8(const ArrayData& data) {
DCHECK(data.type->id() == Type::STRING || data.type->id() == Type::LARGE_STRING);
UTF8DataValidator validator{data};
return VisitTypeInline(*data.type, &validator);
}
ARROW_EXPORT
Status ValidateUTF8(const Array& array) { return ValidateUTF8(*array.data()); }
} // namespace internal
} // namespace arrow