Coverage Report

Created: 2026-03-17 18:28

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/storage/segment/column_reader.cpp
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
18
#include "storage/segment/column_reader.h"
19
20
#include <assert.h>
21
#include <gen_cpp/Descriptors_types.h>
22
#include <gen_cpp/segment_v2.pb.h>
23
#include <glog/logging.h>
24
25
#include <algorithm>
26
#include <memory>
27
#include <ostream>
28
#include <set>
29
#include <utility>
30
31
#include "common/compiler_util.h" // IWYU pragma: keep
32
#include "common/status.h"
33
#include "core/assert_cast.h"
34
#include "core/binary_cast.hpp"
35
#include "core/column/column.h"
36
#include "core/column/column_array.h"
37
#include "core/column/column_map.h"
38
#include "core/column/column_nullable.h"
39
#include "core/column/column_struct.h"
40
#include "core/column/column_vector.h"
41
#include "core/data_type/data_type_agg_state.h"
42
#include "core/data_type/data_type_factory.hpp"
43
#include "core/data_type/data_type_nullable.h"
44
#include "core/data_type/define_primitive_type.h"
45
#include "core/decimal12.h"
46
#include "core/string_ref.h"
47
#include "core/types.h"
48
#include "core/value/decimalv2_value.h"
49
#include "core/value/vdatetime_value.h" //for VecDateTime
50
#include "io/fs/file_reader.h"
51
#include "storage/index/ann/ann_index_reader.h"
52
#include "storage/index/bloom_filter/bloom_filter.h"
53
#include "storage/index/bloom_filter/bloom_filter_index_reader.h"
54
#include "storage/index/index_file_reader.h"
55
#include "storage/index/index_reader.h"
56
#include "storage/index/inverted/analyzer/analyzer.h"
57
#include "storage/index/inverted/inverted_index_reader.h"
58
#include "storage/index/zone_map/zone_map_index.h"
59
#include "storage/iterators.h"
60
#include "storage/olap_common.h"
61
#include "storage/predicate/block_column_predicate.h"
62
#include "storage/predicate/column_predicate.h"
63
#include "storage/segment/binary_dict_page.h" // for BinaryDictPageDecoder
64
#include "storage/segment/binary_plain_page.h"
65
#include "storage/segment/column_meta_accessor.h"
66
#include "storage/segment/encoding_info.h" // for EncodingInfo
67
#include "storage/segment/page_decoder.h"
68
#include "storage/segment/page_handle.h" // for PageHandle
69
#include "storage/segment/page_io.h"
70
#include "storage/segment/page_pointer.h" // for PagePointer
71
#include "storage/segment/row_ranges.h"
72
#include "storage/segment/segment.h"
73
#include "storage/segment/segment_prefetcher.h"
74
#include "storage/segment/variant/variant_column_reader.h"
75
#include "storage/tablet/tablet_schema.h"
76
#include "storage/types.h" // for TypeInfo
77
#include "util/bitmap.h"
78
#include "util/block_compression.h"
79
#include "util/concurrency_stats.h"
80
#include "util/rle_encoding.h" // for RleDecoder
81
#include "util/slice.h"
82
83
namespace doris::segment_v2 {
84
#include "common/compile_check_begin.h"
85
#include "storage/segment/column_reader.h"
86
87
0
inline bool read_as_string(PrimitiveType type) {
88
0
    return type == PrimitiveType::TYPE_STRING || type == PrimitiveType::INVALID_TYPE ||
89
0
           type == PrimitiveType::TYPE_BITMAP || type == PrimitiveType::TYPE_FIXED_LENGTH_OBJECT;
90
0
}
91
92
Status ColumnReader::create_array(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
93
                                  const io::FileReaderSPtr& file_reader,
94
10
                                  std::shared_ptr<ColumnReader>* reader) {
95
10
    DCHECK(meta.children_columns_size() == 2 || meta.children_columns_size() == 3);
96
97
10
    std::shared_ptr<ColumnReader> item_reader;
98
10
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(0),
99
10
                                         meta.children_columns(0).num_rows(), file_reader,
100
10
                                         &item_reader));
101
102
10
    std::shared_ptr<ColumnReader> offset_reader;
103
10
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(1),
104
10
                                         meta.children_columns(1).num_rows(), file_reader,
105
10
                                         &offset_reader));
106
107
10
    std::shared_ptr<ColumnReader> null_reader;
108
10
    if (meta.is_nullable()) {
109
8
        RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(2),
110
8
                                             meta.children_columns(2).num_rows(), file_reader,
111
8
                                             &null_reader));
112
8
    }
113
114
    // The num rows of the array reader equals to the num rows of the length reader.
115
10
    uint64_t array_num_rows = meta.children_columns(1).num_rows();
116
10
    std::shared_ptr<ColumnReader> array_reader(
117
10
            new ColumnReader(opts, meta, array_num_rows, file_reader));
118
    //  array reader do not need to init
119
10
    array_reader->_sub_readers.resize(meta.children_columns_size());
120
10
    array_reader->_sub_readers[0] = std::move(item_reader);
121
10
    array_reader->_sub_readers[1] = std::move(offset_reader);
122
10
    if (meta.is_nullable()) {
123
8
        array_reader->_sub_readers[2] = std::move(null_reader);
124
8
    }
125
10
    array_reader->_meta_type = FieldType::OLAP_FIELD_TYPE_ARRAY;
126
10
    *reader = std::move(array_reader);
127
10
    return Status::OK();
128
10
}
129
130
Status ColumnReader::create_map(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
131
                                const io::FileReaderSPtr& file_reader,
132
386
                                std::shared_ptr<ColumnReader>* reader) {
133
    // map reader now has 3 sub readers for key, value, offsets(scalar), null(scala)
134
386
    DCHECK(meta.children_columns_size() == 3 || meta.children_columns_size() == 4);
135
386
    std::shared_ptr<ColumnReader> key_reader;
136
386
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(0),
137
386
                                         meta.children_columns(0).num_rows(), file_reader,
138
386
                                         &key_reader));
139
386
    std::shared_ptr<ColumnReader> val_reader;
140
386
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(1),
141
386
                                         meta.children_columns(1).num_rows(), file_reader,
142
386
                                         &val_reader));
143
386
    std::shared_ptr<ColumnReader> offset_reader;
144
386
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(2),
145
386
                                         meta.children_columns(2).num_rows(), file_reader,
146
386
                                         &offset_reader));
147
386
    std::shared_ptr<ColumnReader> null_reader;
148
386
    if (meta.is_nullable()) {
149
0
        RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(3),
150
0
                                             meta.children_columns(3).num_rows(), file_reader,
151
0
                                             &null_reader));
152
0
    }
153
154
    // The num rows of the map reader equals to the num rows of the length reader.
155
386
    uint64_t map_num_rows = meta.children_columns(2).num_rows();
156
386
    std::shared_ptr<ColumnReader> map_reader(
157
386
            new ColumnReader(opts, meta, map_num_rows, file_reader));
158
386
    map_reader->_sub_readers.resize(meta.children_columns_size());
159
160
386
    map_reader->_sub_readers[0] = std::move(key_reader);
161
386
    map_reader->_sub_readers[1] = std::move(val_reader);
162
386
    map_reader->_sub_readers[2] = std::move(offset_reader);
163
386
    if (meta.is_nullable()) {
164
0
        map_reader->_sub_readers[3] = std::move(null_reader);
165
0
    }
166
386
    map_reader->_meta_type = FieldType::OLAP_FIELD_TYPE_MAP;
167
386
    *reader = std::move(map_reader);
168
386
    return Status::OK();
169
386
}
170
171
Status ColumnReader::create_struct(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
172
                                   uint64_t num_rows, const io::FileReaderSPtr& file_reader,
173
0
                                   std::shared_ptr<ColumnReader>* reader) {
174
    // not support empty struct
175
0
    DCHECK(meta.children_columns_size() >= 1);
176
    // create struct column reader
177
0
    std::shared_ptr<ColumnReader> struct_reader(
178
0
            new ColumnReader(opts, meta, num_rows, file_reader));
179
0
    struct_reader->_sub_readers.reserve(meta.children_columns_size());
180
    // now we support struct column can add the children columns according to the schema-change behavior
181
0
    for (int i = 0; i < meta.children_columns_size(); i++) {
182
0
        std::shared_ptr<ColumnReader> sub_reader;
183
0
        RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(i),
184
0
                                             meta.children_columns(i).num_rows(), file_reader,
185
0
                                             &sub_reader));
186
0
        struct_reader->_sub_readers.push_back(std::move(sub_reader));
187
0
    }
188
0
    struct_reader->_meta_type = FieldType::OLAP_FIELD_TYPE_STRUCT;
189
0
    *reader = std::move(struct_reader);
190
0
    return Status::OK();
191
0
}
192
193
Status ColumnReader::create_agg_state(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
194
                                      uint64_t num_rows, const io::FileReaderSPtr& file_reader,
195
0
                                      std::shared_ptr<ColumnReader>* reader) {
196
0
    if (!meta.has_function_name()) { // meet old version ColumnMetaPB
197
0
        std::shared_ptr<ColumnReader> reader_local(
198
0
                new ColumnReader(opts, meta, num_rows, file_reader));
199
0
        RETURN_IF_ERROR(reader_local->init(&meta));
200
0
        *reader = std::move(reader_local);
201
0
        return Status::OK();
202
0
    }
203
204
0
    auto data_type = DataTypeFactory::instance().create_data_type(meta);
205
0
    const auto* agg_state_type = assert_cast<const DataTypeAggState*>(data_type.get());
206
0
    agg_state_type->check_function_compatibility(opts.be_exec_version);
207
0
    auto type = agg_state_type->get_serialized_type()->get_primitive_type();
208
209
0
    if (read_as_string(type)) {
210
0
        std::shared_ptr<ColumnReader> reader_local(
211
0
                new ColumnReader(opts, meta, num_rows, file_reader));
212
0
        RETURN_IF_ERROR(reader_local->init(&meta));
213
0
        *reader = std::move(reader_local);
214
0
        return Status::OK();
215
0
    } else if (type == PrimitiveType::TYPE_MAP) {
216
0
        return create_map(opts, meta, file_reader, reader);
217
0
    } else if (type == PrimitiveType::TYPE_ARRAY) {
218
0
        return create_array(opts, meta, file_reader, reader);
219
0
    } else if (type == PrimitiveType::TYPE_STRUCT) {
220
0
        return create_struct(opts, meta, num_rows, file_reader, reader);
221
0
    }
222
223
0
    return Status::InternalError("Not supported type: {}, serialized type: {}",
224
0
                                 agg_state_type->get_name(), int(type));
225
0
}
226
227
488
bool ColumnReader::is_compaction_reader_type(ReaderType type) {
228
488
    return type == ReaderType::READER_BASE_COMPACTION ||
229
488
           type == ReaderType::READER_CUMULATIVE_COMPACTION ||
230
488
           type == ReaderType::READER_COLD_DATA_COMPACTION ||
231
488
           type == ReaderType::READER_SEGMENT_COMPACTION ||
232
488
           type == ReaderType::READER_FULL_COMPACTION;
233
488
}
234
235
Status ColumnReader::create(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
236
                            uint64_t num_rows, const io::FileReaderSPtr& file_reader,
237
15.1k
                            std::shared_ptr<ColumnReader>* reader) {
238
15.1k
    if (is_scalar_type((FieldType)meta.type())) {
239
14.3k
        std::shared_ptr<ColumnReader> reader_local(
240
14.3k
                new ColumnReader(opts, meta, num_rows, file_reader));
241
14.3k
        RETURN_IF_ERROR(reader_local->init(&meta));
242
14.3k
        *reader = std::move(reader_local);
243
14.3k
        return Status::OK();
244
14.3k
    } else {
245
771
        auto type = (FieldType)meta.type();
246
771
        switch (type) {
247
0
        case FieldType::OLAP_FIELD_TYPE_AGG_STATE: {
248
0
            return create_agg_state(opts, meta, num_rows, file_reader, reader);
249
0
        }
250
0
        case FieldType::OLAP_FIELD_TYPE_STRUCT: {
251
0
            return create_struct(opts, meta, num_rows, file_reader, reader);
252
0
        }
253
10
        case FieldType::OLAP_FIELD_TYPE_ARRAY: {
254
10
            return create_array(opts, meta, file_reader, reader);
255
0
        }
256
386
        case FieldType::OLAP_FIELD_TYPE_MAP: {
257
386
            return create_map(opts, meta, file_reader, reader);
258
0
        }
259
375
        case FieldType::OLAP_FIELD_TYPE_VARIANT: {
260
            // Read variant only root data using a single ColumnReader
261
375
            std::shared_ptr<ColumnReader> reader_local(
262
375
                    new ColumnReader(opts, meta, num_rows, file_reader));
263
375
            RETURN_IF_ERROR(reader_local->init(&meta));
264
375
            *reader = std::move(reader_local);
265
375
            return Status::OK();
266
375
        }
267
0
        default:
268
0
            return Status::NotSupported("unsupported type for ColumnReader: {}",
269
0
                                        std::to_string(int(type)));
270
771
        }
271
771
    }
272
15.1k
}
273
274
404
ColumnReader::ColumnReader() = default;
275
276
ColumnReader::ColumnReader(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
277
                           uint64_t num_rows, io::FileReaderSPtr file_reader)
278
15.1k
        : _use_index_page_cache(!config::disable_storage_page_cache),
279
15.1k
          _opts(opts),
280
15.1k
          _num_rows(num_rows),
281
15.1k
          _file_reader(std::move(file_reader)),
282
15.1k
          _dict_encoding_type(UNKNOWN_DICT_ENCODING) {
283
15.1k
    _meta_length = meta.length();
284
15.1k
    _meta_type = (FieldType)meta.type();
285
15.1k
    if (_meta_type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
286
10
        _meta_children_column_type = (FieldType)meta.children_columns(0).type();
287
10
    }
288
15.1k
    _data_type = DataTypeFactory::instance().create_data_type(meta);
289
15.1k
    _meta_is_nullable = meta.is_nullable();
290
15.1k
    _meta_dict_page = meta.dict_page();
291
15.1k
    _meta_compression = meta.compression();
292
15.1k
}
293
294
15.5k
ColumnReader::~ColumnReader() = default;
295
296
14.9k
int64_t ColumnReader::get_metadata_size() const {
297
14.9k
    return sizeof(ColumnReader) + (_segment_zone_map ? _segment_zone_map->ByteSizeLong() : 0);
298
14.9k
}
299
300
#ifdef BE_TEST
301
/// This function is only used in UT to verify the correctness of data read from zone map
302
/// See UT case 'SegCompactionMoWTest.SegCompactionInterleaveWithBig_ooooOOoOooooooooO'
303
/// be/test/olap/segcompaction_mow_test.cpp
304
28.8k
void ColumnReader::check_data_by_zone_map_for_test(const MutableColumnPtr& dst) const {
305
28.8k
    if (!_segment_zone_map) {
306
2.33k
        return;
307
2.33k
    }
308
309
26.4k
    const auto rows = dst->size();
310
26.4k
    if (rows == 0) {
311
0
        return;
312
0
    }
313
314
26.4k
    FieldType type = _type_info->type();
315
316
26.4k
    if (type != FieldType::OLAP_FIELD_TYPE_INT) {
317
3.66k
        return;
318
3.66k
    }
319
320
22.8k
    auto* non_nullable_column =
321
22.8k
            dst->is_nullable()
322
22.8k
                    ? assert_cast<ColumnNullable*>(dst.get())->get_nested_column_ptr().get()
323
22.8k
                    : dst.get();
324
325
    /// `PredicateColumnType<TYPE_INT>` does not support `void get(size_t n, Field& res)`,
326
    /// So here only check `CoumnVector<TYPE_INT>`
327
22.8k
    if (check_and_get_column<ColumnVector<TYPE_INT>>(non_nullable_column) == nullptr) {
328
4.05k
        return;
329
4.05k
    }
330
331
18.7k
    ZoneMap zone_map;
332
18.7k
    THROW_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
333
334
18.7k
    if (zone_map.has_null) {
335
2
        return;
336
2
    }
337
338
18.2M
    for (size_t i = 0; i != rows; ++i) {
339
18.2M
        Field field;
340
18.2M
        dst->get(i, field);
341
18.2M
        DCHECK(!field.is_null());
342
18.2M
        const auto v = field.get<TYPE_INT>();
343
18.2M
        DCHECK_GE(v, zone_map.min_value.get<TYPE_INT>());
344
18.2M
        DCHECK_LE(v, zone_map.max_value.get<TYPE_INT>());
345
18.2M
    }
346
18.7k
}
347
#endif
348
349
14.7k
Status ColumnReader::init(const ColumnMetaPB* meta) {
350
14.7k
    _type_info = get_type_info(meta);
351
352
14.7k
    if (meta->has_be_exec_version()) {
353
12.9k
        _be_exec_version = meta->be_exec_version();
354
12.9k
    }
355
356
14.7k
    if (_type_info == nullptr) {
357
0
        return Status::NotSupported("unsupported typeinfo, type={}", meta->type());
358
0
    }
359
14.7k
    RETURN_IF_ERROR(EncodingInfo::get(_type_info->type(), meta->encoding(), {}, &_encoding_info));
360
361
41.9k
    for (int i = 0; i < meta->indexes_size(); i++) {
362
27.1k
        const auto& index_meta = meta->indexes(i);
363
27.1k
        switch (index_meta.type()) {
364
0
        case BITMAP_INDEX:
365
0
            break;
366
14.6k
        case ORDINAL_INDEX:
367
14.6k
            _ordinal_index.reset(
368
14.6k
                    new OrdinalIndexReader(_file_reader, _num_rows, index_meta.ordinal_index()));
369
14.6k
            break;
370
12.5k
        case ZONE_MAP_INDEX:
371
12.5k
            _segment_zone_map =
372
12.5k
                    std::make_unique<ZoneMapPB>(index_meta.zone_map_index().segment_zone_map());
373
12.5k
            _zone_map_index.reset(new ZoneMapIndexReader(
374
12.5k
                    _file_reader, index_meta.zone_map_index().page_zone_maps()));
375
12.5k
            break;
376
4
        case BLOOM_FILTER_INDEX:
377
4
            _bloom_filter_index.reset(
378
4
                    new BloomFilterIndexReader(_file_reader, index_meta.bloom_filter_index()));
379
4
            break;
380
0
        case NESTED_OFFSETS_INDEX:
381
0
            break;
382
0
        default:
383
0
            return Status::Corruption("Bad file {}: invalid column index type {}",
384
0
                                      _file_reader->path().native(), index_meta.type());
385
27.1k
        }
386
27.1k
    }
387
14.7k
    update_metadata_size();
388
389
    // ArrayColumnWriter writes a single empty array and flushes. In this scenario,
390
    // the item writer doesn't write any data and the corresponding ordinal index is empty.
391
14.7k
    if (_ordinal_index == nullptr && !is_empty()) {
392
0
        return Status::Corruption("Bad file {}: missing ordinal index for column {}",
393
0
                                  _file_reader->path().native(), meta->column_id());
394
0
    }
395
396
14.7k
    return Status::OK();
397
14.7k
}
398
399
Status ColumnReader::new_index_iterator(const std::shared_ptr<IndexFileReader>& index_file_reader,
400
                                        const TabletIndex* index_meta,
401
2.56k
                                        std::unique_ptr<IndexIterator>* iterator) {
402
2.56k
    RETURN_IF_ERROR(_load_index(index_file_reader, index_meta));
403
2.56k
    {
404
2.56k
        std::shared_lock<std::shared_mutex> rlock(_load_index_lock);
405
2.56k
        auto iter = _index_readers.find(index_meta->index_id());
406
2.56k
        if (iter != _index_readers.end()) {
407
2.56k
            if (iter->second != nullptr) {
408
2.56k
                RETURN_IF_ERROR(iter->second->new_iterator(iterator));
409
2.56k
            }
410
2.56k
        }
411
2.56k
    }
412
2.56k
    return Status::OK();
413
2.56k
}
414
415
Status ColumnReader::read_page(const ColumnIteratorOptions& iter_opts, const PagePointer& pp,
416
                               PageHandle* handle, Slice* page_body, PageFooterPB* footer,
417
18.5k
                               BlockCompressionCodec* codec, bool is_dict_page) const {
418
18.5k
    SCOPED_CONCURRENCY_COUNT(ConcurrencyStatsManager::instance().column_reader_read_page);
419
18.5k
    iter_opts.sanity_check();
420
18.5k
    PageReadOptions opts(iter_opts.io_ctx);
421
18.5k
    opts.verify_checksum = _opts.verify_checksum;
422
18.5k
    opts.use_page_cache = iter_opts.use_page_cache;
423
18.5k
    opts.kept_in_memory = _opts.kept_in_memory;
424
18.5k
    opts.type = iter_opts.type;
425
18.5k
    opts.file_reader = iter_opts.file_reader;
426
18.5k
    opts.page_pointer = pp;
427
18.5k
    opts.codec = codec;
428
18.5k
    opts.stats = iter_opts.stats;
429
18.5k
    opts.encoding_info = _encoding_info;
430
18.5k
    opts.is_dict_page = is_dict_page;
431
432
18.5k
    return PageIO::read_and_decompress_page(opts, handle, page_body, footer);
433
18.5k
}
434
435
Status ColumnReader::get_row_ranges_by_zone_map(
436
        const AndBlockColumnPredicate* col_predicates,
437
        const std::vector<std::shared_ptr<const ColumnPredicate>>* delete_predicates,
438
0
        RowRanges* row_ranges, const ColumnIteratorOptions& iter_opts) {
439
0
    std::vector<uint32_t> page_indexes;
440
0
    RETURN_IF_ERROR(
441
0
            _get_filtered_pages(col_predicates, delete_predicates, &page_indexes, iter_opts));
442
0
    RETURN_IF_ERROR(_calculate_row_ranges(page_indexes, row_ranges, iter_opts));
443
0
    return Status::OK();
444
0
}
445
446
0
Status ColumnReader::next_batch_of_zone_map(size_t* n, MutableColumnPtr& dst) const {
447
0
    if (_segment_zone_map == nullptr) {
448
0
        return Status::InternalError("segment zonemap not exist");
449
0
    }
450
    // TODO: this work to get min/max value seems should only do once
451
0
    ZoneMap zone_map;
452
0
    RETURN_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
453
454
0
    dst->reserve(*n);
455
0
    if (!zone_map.has_not_null) {
456
0
        assert_cast<ColumnNullable&>(*dst).insert_many_defaults(*n);
457
0
        return Status::OK();
458
0
    }
459
0
    dst->insert(zone_map.max_value);
460
0
    for (int i = 1; i < *n; ++i) {
461
0
        dst->insert(zone_map.min_value);
462
0
    }
463
0
    return Status::OK();
464
0
}
465
466
Status ColumnReader::match_condition(const AndBlockColumnPredicate* col_predicates,
467
0
                                     bool* matched) const {
468
0
    *matched = true;
469
0
    if (_zone_map_index == nullptr) {
470
0
        return Status::OK();
471
0
    }
472
0
    ZoneMap zone_map;
473
0
    RETURN_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
474
475
0
    *matched = _zone_map_match_condition(zone_map, col_predicates);
476
0
    return Status::OK();
477
0
}
478
479
Status ColumnReader::prune_predicates_by_zone_map(
480
        std::vector<std::shared_ptr<ColumnPredicate>>& predicates, const int column_id,
481
0
        bool* pruned) const {
482
0
    *pruned = false;
483
0
    if (_zone_map_index == nullptr) {
484
0
        return Status::OK();
485
0
    }
486
487
0
    ZoneMap zone_map;
488
0
    RETURN_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
489
0
    if (zone_map.pass_all) {
490
0
        return Status::OK();
491
0
    }
492
493
0
    for (auto it = predicates.begin(); it != predicates.end();) {
494
0
        auto predicate = *it;
495
0
        if (predicate->column_id() == column_id && predicate->is_always_true(zone_map)) {
496
0
            *pruned = true;
497
0
            it = predicates.erase(it);
498
0
        } else {
499
0
            ++it;
500
0
        }
501
0
    }
502
0
    return Status::OK();
503
0
}
504
505
bool ColumnReader::_zone_map_match_condition(const ZoneMap& zone_map,
506
0
                                             const AndBlockColumnPredicate* col_predicates) const {
507
0
    if (zone_map.pass_all) {
508
0
        return true;
509
0
    }
510
511
0
    return col_predicates->evaluate_and(zone_map);
512
0
}
513
514
Status ColumnReader::_get_filtered_pages(
515
        const AndBlockColumnPredicate* col_predicates,
516
        const std::vector<std::shared_ptr<const ColumnPredicate>>* delete_predicates,
517
0
        std::vector<uint32_t>* page_indexes, const ColumnIteratorOptions& iter_opts) {
518
0
    RETURN_IF_ERROR(_load_zone_map_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
519
520
0
    const std::vector<ZoneMapPB>& zone_maps = _zone_map_index->page_zone_maps();
521
0
    size_t page_size = _zone_map_index->num_pages();
522
0
    for (size_t i = 0; i < page_size; ++i) {
523
0
        if (zone_maps[i].pass_all()) {
524
0
            page_indexes->push_back(cast_set<uint32_t>(i));
525
0
        } else {
526
0
            segment_v2::ZoneMap zone_map;
527
0
            RETURN_IF_ERROR(ZoneMap::from_proto(zone_maps[i], _data_type, zone_map));
528
0
            if (_zone_map_match_condition(zone_map, col_predicates)) {
529
0
                bool should_read = true;
530
0
                if (delete_predicates != nullptr) {
531
0
                    for (auto del_pred : *delete_predicates) {
532
                        // TODO: Both `min_value` and `max_value` should be 0 or neither should be 0.
533
                        //  So nullable only need to judge once.
534
0
                        if (del_pred->evaluate_del(zone_map)) {
535
0
                            should_read = false;
536
0
                            break;
537
0
                        }
538
0
                    }
539
0
                }
540
0
                if (should_read) {
541
0
                    page_indexes->push_back(cast_set<uint32_t>(i));
542
0
                }
543
0
            }
544
0
        }
545
0
    }
546
0
    VLOG(1) << "total-pages: " << page_size << " not-filtered-pages: " << page_indexes->size()
547
0
            << " filtered-percent:"
548
0
            << 1.0 - (static_cast<double>(page_indexes->size()) /
549
0
                      (static_cast<double>(page_size) * 1.0));
550
0
    return Status::OK();
551
0
}
552
553
Status ColumnReader::_calculate_row_ranges(const std::vector<uint32_t>& page_indexes,
554
                                           RowRanges* row_ranges,
555
0
                                           const ColumnIteratorOptions& iter_opts) {
556
0
    row_ranges->clear();
557
0
    RETURN_IF_ERROR(_load_ordinal_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
558
0
    for (auto i : page_indexes) {
559
0
        ordinal_t page_first_id = _ordinal_index->get_first_ordinal(i);
560
0
        ordinal_t page_last_id = _ordinal_index->get_last_ordinal(i);
561
0
        RowRanges page_row_ranges(RowRanges::create_single(page_first_id, page_last_id + 1));
562
0
        RowRanges::ranges_union(*row_ranges, page_row_ranges, row_ranges);
563
0
    }
564
0
    return Status::OK();
565
0
}
566
567
Status ColumnReader::get_row_ranges_by_bloom_filter(const AndBlockColumnPredicate* col_predicates,
568
                                                    RowRanges* row_ranges,
569
0
                                                    const ColumnIteratorOptions& iter_opts) {
570
0
    RETURN_IF_ERROR(_load_ordinal_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
571
0
    RETURN_IF_ERROR(
572
0
            _load_bloom_filter_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
573
0
    RowRanges bf_row_ranges;
574
0
    std::unique_ptr<BloomFilterIndexIterator> bf_iter;
575
0
    RETURN_IF_ERROR(_bloom_filter_index->new_iterator(&bf_iter, iter_opts.stats));
576
0
    size_t range_size = row_ranges->range_size();
577
    // get covered page ids
578
0
    std::set<uint32_t> page_ids;
579
0
    for (int i = 0; i < range_size; ++i) {
580
0
        int64_t from = row_ranges->get_range_from(i);
581
0
        int64_t idx = from;
582
0
        int64_t to = row_ranges->get_range_to(i);
583
0
        auto iter = _ordinal_index->seek_at_or_before(from);
584
0
        while (idx < to && iter.valid()) {
585
0
            page_ids.insert(iter.page_index());
586
0
            idx = iter.last_ordinal() + 1;
587
0
            iter.next();
588
0
        }
589
0
    }
590
0
    for (auto& pid : page_ids) {
591
0
        std::unique_ptr<BloomFilter> bf;
592
0
        RETURN_IF_ERROR(bf_iter->read_bloom_filter(pid, &bf));
593
0
        if (col_predicates->evaluate_and(bf.get())) {
594
0
            bf_row_ranges.add(RowRange(_ordinal_index->get_first_ordinal(pid),
595
0
                                       _ordinal_index->get_last_ordinal(pid) + 1));
596
0
        }
597
0
    }
598
0
    RowRanges::ranges_intersection(*row_ranges, bf_row_ranges, row_ranges);
599
0
    return Status::OK();
600
0
}
601
602
Status ColumnReader::_load_ordinal_index(bool use_page_cache, bool kept_in_memory,
603
13.9k
                                         const ColumnIteratorOptions& iter_opts) {
604
13.9k
    if (!_ordinal_index) {
605
0
        return Status::InternalError("ordinal_index not inited");
606
0
    }
607
13.9k
    return _ordinal_index->load(use_page_cache, kept_in_memory, iter_opts.stats);
608
13.9k
}
609
610
Status ColumnReader::_load_zone_map_index(bool use_page_cache, bool kept_in_memory,
611
0
                                          const ColumnIteratorOptions& iter_opts) {
612
0
    if (_zone_map_index != nullptr) {
613
0
        return _zone_map_index->load(use_page_cache, kept_in_memory, iter_opts.stats);
614
0
    }
615
0
    return Status::OK();
616
0
}
617
618
Status ColumnReader::_load_index(const std::shared_ptr<IndexFileReader>& index_file_reader,
619
2.56k
                                 const TabletIndex* index_meta) {
620
2.56k
    std::unique_lock<std::shared_mutex> wlock(_load_index_lock);
621
622
2.56k
    if (index_meta == nullptr) {
623
0
        return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
624
0
                "Failed to load inverted index: index metadata is null");
625
0
    }
626
627
2.56k
    auto it = _index_readers.find(index_meta->index_id());
628
2.56k
    if (it != _index_readers.end()) {
629
0
        return Status::OK();
630
0
    }
631
632
2.56k
    bool should_analyzer =
633
2.56k
            inverted_index::InvertedIndexAnalyzer::should_analyzer(index_meta->properties());
634
635
2.56k
    FieldType type;
636
2.56k
    if (_meta_type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
637
2
        type = _meta_children_column_type;
638
2.56k
    } else {
639
2.56k
        type = _type_info->type();
640
2.56k
    }
641
642
2.56k
    if (index_meta->index_type() == IndexType::ANN) {
643
1
        _index_readers[index_meta->index_id()] =
644
1
                std::make_shared<AnnIndexReader>(index_meta, index_file_reader);
645
1
        return Status::OK();
646
1
    }
647
648
2.56k
    IndexReaderPtr index_reader;
649
650
2.56k
    if (is_string_type(type)) {
651
2.16k
        if (should_analyzer) {
652
1.68k
            try {
653
1.68k
                index_reader = FullTextIndexReader::create_shared(index_meta, index_file_reader);
654
1.68k
            } catch (const CLuceneError& e) {
655
0
                return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
656
0
                        "create FullTextIndexReader error: {}", e.what());
657
0
            }
658
1.68k
        } else {
659
476
            try {
660
476
                index_reader =
661
476
                        StringTypeInvertedIndexReader::create_shared(index_meta, index_file_reader);
662
476
            } catch (const CLuceneError& e) {
663
0
                return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
664
0
                        "create StringTypeInvertedIndexReader error: {}", e.what());
665
0
            }
666
476
        }
667
2.16k
    } else if (is_numeric_type(type)) {
668
402
        try {
669
402
            index_reader = BkdIndexReader::create_shared(index_meta, index_file_reader);
670
402
        } catch (const CLuceneError& e) {
671
0
            return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
672
0
                    "create BkdIndexReader error: {}", e.what());
673
0
        }
674
402
    } else {
675
0
        return Status::Error<ErrorCode::INVERTED_INDEX_NOT_SUPPORTED>(
676
0
                "Field type {} is not supported for inverted index", type);
677
0
    }
678
2.56k
    _index_readers[index_meta->index_id()] = index_reader;
679
2.56k
    return Status::OK();
680
2.56k
}
681
682
0
bool ColumnReader::has_bloom_filter_index(bool ngram) const {
683
0
    if (_bloom_filter_index == nullptr) return false;
684
685
0
    if (ngram) {
686
0
        return _bloom_filter_index->algorithm() == BloomFilterAlgorithmPB::NGRAM_BLOOM_FILTER;
687
0
    } else {
688
0
        return _bloom_filter_index->algorithm() != BloomFilterAlgorithmPB::NGRAM_BLOOM_FILTER;
689
0
    }
690
0
}
691
692
Status ColumnReader::_load_bloom_filter_index(bool use_page_cache, bool kept_in_memory,
693
0
                                              const ColumnIteratorOptions& iter_opts) {
694
0
    if (_bloom_filter_index != nullptr) {
695
0
        return _bloom_filter_index->load(use_page_cache, kept_in_memory, iter_opts.stats);
696
0
    }
697
0
    return Status::OK();
698
0
}
699
700
Status ColumnReader::seek_at_or_before(ordinal_t ordinal, OrdinalPageIndexIterator* iter,
701
13.9k
                                       const ColumnIteratorOptions& iter_opts) {
702
13.9k
    RETURN_IF_ERROR(_load_ordinal_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
703
13.9k
    *iter = _ordinal_index->seek_at_or_before(ordinal);
704
13.9k
    if (!iter->valid()) {
705
0
        return Status::NotFound("Failed to seek to ordinal {}, ", ordinal);
706
0
    }
707
13.9k
    return Status::OK();
708
13.9k
}
709
710
Status ColumnReader::get_ordinal_index_reader(OrdinalIndexReader*& reader,
711
0
                                              OlapReaderStatistics* index_load_stats) {
712
0
    CHECK(_ordinal_index) << fmt::format("ordinal index is null for column reader of type {}",
713
0
                                         std::to_string(int(_meta_type)));
714
0
    RETURN_IF_ERROR(
715
0
            _ordinal_index->load(_use_index_page_cache, _opts.kept_in_memory, index_load_stats));
716
0
    reader = _ordinal_index.get();
717
0
    return Status::OK();
718
0
}
719
720
1.07k
Status ColumnReader::new_iterator(ColumnIteratorUPtr* iterator, const TabletColumn* tablet_column) {
721
1.07k
    return new_iterator(iterator, tablet_column, nullptr);
722
1.07k
}
723
724
Status ColumnReader::new_iterator(ColumnIteratorUPtr* iterator, const TabletColumn* tablet_column,
725
13.6k
                                  const StorageReadOptions* opt) {
726
13.6k
    if (is_empty()) {
727
46
        *iterator = std::make_unique<EmptyFileColumnIterator>();
728
46
        return Status::OK();
729
46
    }
730
13.6k
    if (is_scalar_type(_meta_type)) {
731
13.4k
        *iterator = std::make_unique<FileColumnIterator>(shared_from_this());
732
13.4k
        (*iterator)->set_column_name(tablet_column ? tablet_column->name() : "");
733
13.4k
        return Status::OK();
734
13.4k
    } else {
735
183
        auto type = _meta_type;
736
183
        switch (type) {
737
0
        case FieldType::OLAP_FIELD_TYPE_AGG_STATE: {
738
0
            return new_agg_state_iterator(iterator);
739
0
        }
740
0
        case FieldType::OLAP_FIELD_TYPE_STRUCT: {
741
0
            return new_struct_iterator(iterator, tablet_column);
742
0
        }
743
10
        case FieldType::OLAP_FIELD_TYPE_ARRAY: {
744
10
            return new_array_iterator(iterator, tablet_column);
745
0
        }
746
173
        case FieldType::OLAP_FIELD_TYPE_MAP: {
747
173
            return new_map_iterator(iterator, tablet_column);
748
0
        }
749
0
        default:
750
0
            return Status::NotSupported("unsupported type to create iterator: {}",
751
0
                                        std::to_string(int(type)));
752
183
        }
753
183
    }
754
13.6k
}
755
756
0
Status ColumnReader::new_agg_state_iterator(ColumnIteratorUPtr* iterator) {
757
0
    *iterator = std::make_unique<FileColumnIterator>(shared_from_this());
758
0
    return Status::OK();
759
0
}
760
761
Status ColumnReader::new_array_iterator(ColumnIteratorUPtr* iterator,
762
10
                                        const TabletColumn* tablet_column) {
763
10
    ColumnIteratorUPtr item_iterator;
764
10
    RETURN_IF_ERROR(_sub_readers[0]->new_iterator(
765
10
            &item_iterator, tablet_column && tablet_column->get_subtype_count() > 0
766
10
                                    ? &tablet_column->get_sub_column(0)
767
10
                                    : nullptr));
768
769
10
    item_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(0).name() : "");
770
771
10
    ColumnIteratorUPtr offset_iterator;
772
10
    RETURN_IF_ERROR(_sub_readers[1]->new_iterator(&offset_iterator, nullptr));
773
10
    auto* file_iter = static_cast<FileColumnIterator*>(offset_iterator.release());
774
10
    OffsetFileColumnIteratorUPtr ofcIter = std::make_unique<OffsetFileColumnIterator>(
775
10
            std::unique_ptr<FileColumnIterator>(file_iter));
776
777
10
    ColumnIteratorUPtr null_iterator;
778
10
    if (is_nullable()) {
779
8
        RETURN_IF_ERROR(_sub_readers[2]->new_iterator(&null_iterator, nullptr));
780
8
    }
781
10
    *iterator = std::make_unique<ArrayFileColumnIterator>(shared_from_this(), std::move(ofcIter),
782
10
                                                          std::move(item_iterator),
783
10
                                                          std::move(null_iterator));
784
10
    return Status::OK();
785
10
}
786
787
Status ColumnReader::new_map_iterator(ColumnIteratorUPtr* iterator,
788
173
                                      const TabletColumn* tablet_column) {
789
173
    ColumnIteratorUPtr key_iterator;
790
173
    RETURN_IF_ERROR(_sub_readers[0]->new_iterator(
791
173
            &key_iterator, tablet_column && tablet_column->get_subtype_count() > 1
792
173
                                   ? &tablet_column->get_sub_column(0)
793
173
                                   : nullptr));
794
173
    key_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(0).name() : "");
795
173
    ColumnIteratorUPtr val_iterator;
796
173
    RETURN_IF_ERROR(_sub_readers[1]->new_iterator(
797
173
            &val_iterator, tablet_column && tablet_column->get_subtype_count() > 1
798
173
                                   ? &tablet_column->get_sub_column(1)
799
173
                                   : nullptr));
800
173
    val_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(1).name() : "");
801
173
    ColumnIteratorUPtr offsets_iterator;
802
173
    RETURN_IF_ERROR(_sub_readers[2]->new_iterator(&offsets_iterator, nullptr));
803
173
    auto* file_iter = static_cast<FileColumnIterator*>(offsets_iterator.release());
804
173
    OffsetFileColumnIteratorUPtr ofcIter = std::make_unique<OffsetFileColumnIterator>(
805
173
            std::unique_ptr<FileColumnIterator>(file_iter));
806
807
173
    ColumnIteratorUPtr null_iterator;
808
173
    if (is_nullable()) {
809
0
        RETURN_IF_ERROR(_sub_readers[3]->new_iterator(&null_iterator, nullptr));
810
0
    }
811
173
    *iterator = std::make_unique<MapFileColumnIterator>(
812
173
            shared_from_this(), std::move(null_iterator), std::move(ofcIter),
813
173
            std::move(key_iterator), std::move(val_iterator));
814
173
    return Status::OK();
815
173
}
816
817
Status ColumnReader::new_struct_iterator(ColumnIteratorUPtr* iterator,
818
0
                                         const TabletColumn* tablet_column) {
819
0
    std::vector<ColumnIteratorUPtr> sub_column_iterators;
820
0
    size_t child_size = is_nullable() ? _sub_readers.size() - 1 : _sub_readers.size();
821
0
    size_t tablet_column_size = tablet_column ? tablet_column->get_sub_columns().size() : 0;
822
0
    sub_column_iterators.reserve(child_size);
823
824
0
    for (uint64_t i = 0; i < child_size; i++) {
825
0
        ColumnIteratorUPtr sub_column_iterator;
826
0
        RETURN_IF_ERROR(_sub_readers[i]->new_iterator(
827
0
                &sub_column_iterator, tablet_column ? &tablet_column->get_sub_column(i) : nullptr));
828
0
        sub_column_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(i).name()
829
0
                                                           : "");
830
0
        sub_column_iterators.emplace_back(std::move(sub_column_iterator));
831
0
    }
832
833
    // create default_iterator for schema-change behavior which increase column
834
0
    for (size_t i = child_size; i < tablet_column_size; i++) {
835
0
        TabletColumn column = tablet_column->get_sub_column(i);
836
0
        ColumnIteratorUPtr it;
837
0
        RETURN_IF_ERROR(Segment::new_default_iterator(column, &it));
838
0
        it->set_column_name(column.name());
839
0
        sub_column_iterators.emplace_back(std::move(it));
840
0
    }
841
842
0
    ColumnIteratorUPtr null_iterator;
843
0
    if (is_nullable()) {
844
0
        RETURN_IF_ERROR(_sub_readers[child_size]->new_iterator(&null_iterator, nullptr));
845
0
    }
846
0
    *iterator = std::make_unique<StructFileColumnIterator>(
847
0
            shared_from_this(), std::move(null_iterator), std::move(sub_column_iterators));
848
0
    return Status::OK();
849
0
}
850
851
Result<TColumnAccessPaths> ColumnIterator::_get_sub_access_paths(
852
12
        const TColumnAccessPaths& access_paths) {
853
12
    TColumnAccessPaths sub_access_paths = access_paths;
854
19
    for (auto it = sub_access_paths.begin(); it != sub_access_paths.end();) {
855
9
        TColumnAccessPath& name_path = *it;
856
9
        if (name_path.data_access_path.path.empty()) {
857
1
            return ResultError(
858
1
                    Status::InternalError("Invalid access path for struct column: path is empty"));
859
1
        }
860
861
8
        if (!StringCaseEqual()(name_path.data_access_path.path[0], _column_name)) {
862
1
            return ResultError(Status::InternalError(
863
1
                    R"(Invalid access path for column: expected name "{}", got "{}")", _column_name,
864
1
                    name_path.data_access_path.path[0]));
865
1
        }
866
867
7
        name_path.data_access_path.path.erase(name_path.data_access_path.path.begin());
868
7
        if (!name_path.data_access_path.path.empty()) {
869
6
            ++it;
870
6
        } else {
871
1
            set_need_to_read();
872
1
            it = sub_access_paths.erase(it);
873
1
        }
874
7
    }
875
10
    return sub_access_paths;
876
12
}
877
878
///====================== MapFileColumnIterator ============================////
879
MapFileColumnIterator::MapFileColumnIterator(std::shared_ptr<ColumnReader> reader,
880
                                             ColumnIteratorUPtr null_iterator,
881
                                             OffsetFileColumnIteratorUPtr offsets_iterator,
882
                                             ColumnIteratorUPtr key_iterator,
883
                                             ColumnIteratorUPtr val_iterator)
884
175
        : _map_reader(reader),
885
175
          _offsets_iterator(std::move(offsets_iterator)),
886
175
          _key_iterator(std::move(key_iterator)),
887
175
          _val_iterator(std::move(val_iterator)) {
888
175
    if (_map_reader->is_nullable()) {
889
0
        _null_iterator = std::move(null_iterator);
890
0
    }
891
175
}
892
893
169
Status MapFileColumnIterator::init(const ColumnIteratorOptions& opts) {
894
169
    if (_reading_flag == ReadingFlag::SKIP_READING) {
895
0
        DLOG(INFO) << "Map column iterator column " << _column_name << " skip reading.";
896
0
        return Status::OK();
897
0
    }
898
169
    RETURN_IF_ERROR(_key_iterator->init(opts));
899
169
    RETURN_IF_ERROR(_val_iterator->init(opts));
900
169
    RETURN_IF_ERROR(_offsets_iterator->init(opts));
901
169
    if (_map_reader->is_nullable()) {
902
0
        RETURN_IF_ERROR(_null_iterator->init(opts));
903
0
    }
904
169
    return Status::OK();
905
169
}
906
907
169
Status MapFileColumnIterator::seek_to_ordinal(ordinal_t ord) {
908
169
    if (_reading_flag == ReadingFlag::SKIP_READING) {
909
0
        DLOG(INFO) << "Map column iterator column " << _column_name << " skip reading.";
910
0
        return Status::OK();
911
0
    }
912
913
169
    if (_map_reader->is_nullable()) {
914
0
        RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
915
0
    }
916
169
    RETURN_IF_ERROR(_offsets_iterator->seek_to_ordinal(ord));
917
    // here to use offset info
918
169
    ordinal_t offset = 0;
919
169
    RETURN_IF_ERROR(_offsets_iterator->_peek_one_offset(&offset));
920
169
    RETURN_IF_ERROR(_key_iterator->seek_to_ordinal(offset));
921
169
    RETURN_IF_ERROR(_val_iterator->seek_to_ordinal(offset));
922
169
    return Status::OK();
923
169
}
924
925
0
Status MapFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
926
0
    RETURN_IF_ERROR(_offsets_iterator->init_prefetcher(params));
927
0
    if (_map_reader->is_nullable()) {
928
0
        RETURN_IF_ERROR(_null_iterator->init_prefetcher(params));
929
0
    }
930
0
    RETURN_IF_ERROR(_key_iterator->init_prefetcher(params));
931
0
    RETURN_IF_ERROR(_val_iterator->init_prefetcher(params));
932
0
    return Status::OK();
933
0
}
934
935
void MapFileColumnIterator::collect_prefetchers(
936
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
937
0
        PrefetcherInitMethod init_method) {
938
0
    _offsets_iterator->collect_prefetchers(prefetchers, init_method);
939
0
    if (_map_reader->is_nullable()) {
940
0
        _null_iterator->collect_prefetchers(prefetchers, init_method);
941
0
    }
942
    // the actual data pages to read of key/value column depends on the read result of offset column,
943
    // so we can't init prefetch blocks according to rowids, just prefetch all data blocks here.
944
0
    _key_iterator->collect_prefetchers(prefetchers, PrefetcherInitMethod::ALL_DATA_BLOCKS);
945
0
    _val_iterator->collect_prefetchers(prefetchers, PrefetcherInitMethod::ALL_DATA_BLOCKS);
946
0
}
947
948
168
Status MapFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
949
168
    if (_reading_flag == ReadingFlag::SKIP_READING) {
950
0
        DLOG(INFO) << "Map column iterator column " << _column_name << " skip reading.";
951
0
        dst->insert_many_defaults(*n);
952
0
        return Status::OK();
953
0
    }
954
955
168
    auto& column_map = assert_cast<ColumnMap&, TypeCheckOnRelease::DISABLE>(
956
168
            dst->is_nullable() ? static_cast<ColumnNullable&>(*dst).get_nested_column() : *dst);
957
168
    auto column_offsets_ptr = column_map.get_offsets_column().assume_mutable();
958
168
    bool offsets_has_null = false;
959
168
    ssize_t start = column_offsets_ptr->size();
960
168
    RETURN_IF_ERROR(_offsets_iterator->next_batch(n, column_offsets_ptr, &offsets_has_null));
961
168
    if (*n == 0) {
962
0
        return Status::OK();
963
0
    }
964
168
    auto& column_offsets = static_cast<ColumnArray::ColumnOffsets&>(*column_offsets_ptr);
965
168
    RETURN_IF_ERROR(_offsets_iterator->_calculate_offsets(start, column_offsets));
966
168
    DCHECK(column_offsets.get_data().back() >= column_offsets.get_data()[start - 1]);
967
168
    size_t num_items =
968
168
            column_offsets.get_data().back() - column_offsets.get_data()[start - 1]; // -1 is valid
969
168
    auto key_ptr = column_map.get_keys().assume_mutable();
970
168
    auto val_ptr = column_map.get_values().assume_mutable();
971
972
168
    if (num_items > 0) {
973
148
        size_t num_read = num_items;
974
148
        bool key_has_null = false;
975
148
        bool val_has_null = false;
976
148
        RETURN_IF_ERROR(_key_iterator->next_batch(&num_read, key_ptr, &key_has_null));
977
148
        RETURN_IF_ERROR(_val_iterator->next_batch(&num_read, val_ptr, &val_has_null));
978
148
        DCHECK(num_read == num_items);
979
980
148
        column_map.get_keys_ptr() = std::move(key_ptr);
981
148
        column_map.get_values_ptr() = std::move(val_ptr);
982
148
    }
983
984
168
    if (dst->is_nullable()) {
985
0
        size_t num_read = *n;
986
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
987
        // in not-null to null linked-schemachange mode,
988
        // actually we do not change dat data include meta in footer,
989
        // so may dst from changed meta which is nullable but old data is not nullable,
990
        // if so, we should set null_map to all null by default
991
0
        if (_null_iterator) {
992
0
            bool null_signs_has_null = false;
993
0
            RETURN_IF_ERROR(
994
0
                    _null_iterator->next_batch(&num_read, null_map_ptr, &null_signs_has_null));
995
0
        } else {
996
0
            auto& null_map = assert_cast<ColumnUInt8&, TypeCheckOnRelease::DISABLE>(*null_map_ptr);
997
0
            null_map.insert_many_vals(0, num_read);
998
0
        }
999
0
        DCHECK(num_read == *n);
1000
0
    }
1001
168
    return Status::OK();
1002
168
}
1003
1004
Status MapFileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
1005
7
                                             MutableColumnPtr& dst) {
1006
7
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1007
1
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
1008
1
        dst->insert_many_defaults(count);
1009
1
        return Status::OK();
1010
1
    }
1011
6
    if (count == 0) {
1012
0
        return Status::OK();
1013
0
    }
1014
    // resolve ColumnMap and nullable wrapper
1015
6
    const auto* column_map = check_and_get_column<ColumnMap>(
1016
6
            dst->is_nullable() ? static_cast<ColumnNullable&>(*dst).get_nested_column() : *dst);
1017
6
    auto offsets_ptr = column_map->get_offsets_column().assume_mutable();
1018
6
    auto& offsets = static_cast<ColumnArray::ColumnOffsets&>(*offsets_ptr);
1019
6
    size_t base = offsets.get_data().empty() ? 0 : offsets.get_data().back();
1020
1021
    // 1. bulk read null-map if nullable
1022
6
    std::vector<uint8_t> null_mask; // 0: not null, 1: null
1023
6
    if (_map_reader->is_nullable()) {
1024
        // For nullable map columns, the destination column must also be nullable.
1025
0
        if (UNLIKELY(!dst->is_nullable())) {
1026
0
            return Status::InternalError(
1027
0
                    "unexpected non-nullable destination column for nullable map reader");
1028
0
        }
1029
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1030
0
        size_t null_before = null_map_ptr->size();
1031
0
        RETURN_IF_ERROR(_null_iterator->read_by_rowids(rowids, count, null_map_ptr));
1032
        // extract a light-weight view to decide element reads
1033
0
        auto& null_map_col = assert_cast<ColumnUInt8&>(*null_map_ptr);
1034
0
        null_mask.reserve(count);
1035
0
        for (size_t i = 0; i < count; ++i) {
1036
0
            null_mask.push_back(null_map_col.get_element(null_before + i));
1037
0
        }
1038
6
    } else if (dst->is_nullable()) {
1039
        // in not-null to null linked-schemachange mode,
1040
        // actually we do not change dat data include meta in footer,
1041
        // so may dst from changed meta which is nullable but old data is not nullable,
1042
        // if so, we should set null_map to all null by default
1043
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1044
0
        auto& null_map = assert_cast<ColumnUInt8&>(*null_map_ptr);
1045
0
        null_map.insert_many_vals(0, count);
1046
0
    }
1047
1048
    // 2. bulk read start ordinals for requested rows
1049
6
    MutableColumnPtr starts_col = ColumnOffset64::create();
1050
6
    starts_col->reserve(count);
1051
6
    RETURN_IF_ERROR(_offsets_iterator->read_by_rowids(rowids, count, starts_col));
1052
1053
    // 3. bulk read next-start ordinals for rowid+1 (within bounds)
1054
6
    std::vector<rowid_t> next_rowids(count);
1055
2.57k
    for (size_t i = 0; i < count; ++i) {
1056
2.57k
        uint64_t nr = rowids[i] + 1;
1057
2.57k
        next_rowids[i] = nr < _map_reader->num_rows() ? static_cast<rowid_t>(nr)
1058
2.57k
                                                      : static_cast<rowid_t>(0); // placeholder
1059
2.57k
    }
1060
6
    MutableColumnPtr next_starts_col = ColumnOffset64::create();
1061
6
    next_starts_col->reserve(count);
1062
    // read for all; we'll fix out-of-bound cases below
1063
6
    RETURN_IF_ERROR(_offsets_iterator->read_by_rowids(next_rowids.data(), count, next_starts_col));
1064
1065
    // 4. fix next_start for rows whose next_rowid is out-of-bound (rowid == num_rows-1)
1066
2.57k
    for (size_t i = 0; i < count; ++i) {
1067
2.57k
        if (rowids[i] + 1 >= _map_reader->num_rows()) {
1068
            // seek to the last row and consume one to move decoder to end-of-page,
1069
            // then peek page-tail sentinel next_array_item_ordinal as next_start
1070
2
            RETURN_IF_ERROR(_offsets_iterator->seek_to_ordinal(rowids[i]));
1071
2
            size_t one = 1;
1072
2
            bool has_null_unused = false;
1073
2
            MutableColumnPtr tmp = ColumnOffset64::create();
1074
2
            RETURN_IF_ERROR(_offsets_iterator->next_batch(&one, tmp, &has_null_unused));
1075
2
            ordinal_t ns = 0;
1076
2
            RETURN_IF_ERROR(_offsets_iterator->_peek_one_offset(&ns));
1077
            // overwrite with sentinel
1078
2
            assert_cast<ColumnOffset64&, TypeCheckOnRelease::DISABLE>(*next_starts_col)
1079
2
                    .get_data()[i] = ns;
1080
2
        }
1081
2.57k
    }
1082
1083
    // 5. compute sizes and append offsets prefix-sum
1084
6
    auto& starts_data = assert_cast<ColumnOffset64&>(*starts_col).get_data();
1085
6
    auto& next_starts_data = assert_cast<ColumnOffset64&>(*next_starts_col).get_data();
1086
6
    std::vector<size_t> sizes(count, 0);
1087
6
    size_t acc = base;
1088
6
    const auto original_size = offsets.get_data().back();
1089
6
    offsets.get_data().reserve(offsets.get_data().size() + count);
1090
2.57k
    for (size_t i = 0; i < count; ++i) {
1091
2.57k
        size_t sz = static_cast<size_t>(next_starts_data[i] - starts_data[i]);
1092
2.57k
        if (_map_reader->is_nullable() && !null_mask.empty() && null_mask[i]) {
1093
0
            sz = 0; // null rows do not consume elements
1094
0
        }
1095
2.57k
        sizes[i] = sz;
1096
2.57k
        acc += sz;
1097
2.57k
        offsets.get_data().push_back(acc);
1098
2.57k
    }
1099
1100
    // 6. read key/value elements for non-empty sizes
1101
6
    auto keys_ptr = column_map->get_keys().assume_mutable();
1102
6
    auto vals_ptr = column_map->get_values().assume_mutable();
1103
1104
6
    size_t this_run = sizes[0];
1105
6
    auto start_idx = starts_data[0];
1106
6
    auto last_idx = starts_data[0] + this_run;
1107
2.57k
    for (size_t i = 1; i < count; ++i) {
1108
2.56k
        size_t sz = sizes[i];
1109
2.56k
        if (sz == 0) {
1110
1.15k
            continue;
1111
1.15k
        }
1112
1.40k
        auto start = static_cast<ordinal_t>(starts_data[i]);
1113
1.40k
        if (start != last_idx) {
1114
238
            size_t n = this_run;
1115
238
            bool dummy_has_null = false;
1116
1117
238
            if (this_run != 0) {
1118
236
                if (_key_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1119
236
                    RETURN_IF_ERROR(_key_iterator->seek_to_ordinal(start_idx));
1120
236
                    RETURN_IF_ERROR(_key_iterator->next_batch(&n, keys_ptr, &dummy_has_null));
1121
236
                    DCHECK(n == this_run);
1122
236
                }
1123
1124
236
                if (_val_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1125
236
                    n = this_run;
1126
236
                    RETURN_IF_ERROR(_val_iterator->seek_to_ordinal(start_idx));
1127
236
                    RETURN_IF_ERROR(_val_iterator->next_batch(&n, vals_ptr, &dummy_has_null));
1128
236
                    DCHECK(n == this_run);
1129
236
                }
1130
236
            }
1131
238
            start_idx = start;
1132
238
            this_run = sz;
1133
238
            last_idx = start + sz;
1134
238
            continue;
1135
238
        }
1136
1137
1.16k
        this_run += sz;
1138
1.16k
        last_idx += sz;
1139
1.16k
    }
1140
1141
6
    size_t n = this_run;
1142
6
    const size_t total_count = offsets.get_data().back() - original_size;
1143
6
    bool dummy_has_null = false;
1144
6
    if (_key_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1145
6
        if (this_run != 0) {
1146
6
            RETURN_IF_ERROR(_key_iterator->seek_to_ordinal(start_idx));
1147
6
            RETURN_IF_ERROR(_key_iterator->next_batch(&n, keys_ptr, &dummy_has_null));
1148
6
            DCHECK(n == this_run);
1149
6
        }
1150
6
    } else {
1151
0
        keys_ptr->insert_many_defaults(total_count);
1152
0
    }
1153
1154
6
    if (_val_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1155
6
        if (this_run != 0) {
1156
6
            n = this_run;
1157
6
            RETURN_IF_ERROR(_val_iterator->seek_to_ordinal(start_idx));
1158
6
            RETURN_IF_ERROR(_val_iterator->next_batch(&n, vals_ptr, &dummy_has_null));
1159
6
            DCHECK(n == this_run);
1160
6
        }
1161
6
    } else {
1162
0
        vals_ptr->insert_many_defaults(total_count);
1163
0
    }
1164
1165
6
    return Status::OK();
1166
6
}
1167
1168
0
void MapFileColumnIterator::set_need_to_read() {
1169
0
    set_reading_flag(ReadingFlag::NEED_TO_READ);
1170
0
    _key_iterator->set_need_to_read();
1171
0
    _val_iterator->set_need_to_read();
1172
0
}
1173
1174
0
void MapFileColumnIterator::remove_pruned_sub_iterators() {
1175
0
    _key_iterator->remove_pruned_sub_iterators();
1176
0
    _val_iterator->remove_pruned_sub_iterators();
1177
0
}
1178
1179
Status MapFileColumnIterator::set_access_paths(const TColumnAccessPaths& all_access_paths,
1180
1
                                               const TColumnAccessPaths& predicate_access_paths) {
1181
1
    if (all_access_paths.empty()) {
1182
0
        return Status::OK();
1183
0
    }
1184
1185
1
    if (!predicate_access_paths.empty()) {
1186
0
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1187
0
        DLOG(INFO) << "Map column iterator set sub-column " << _column_name
1188
0
                   << " to READING_FOR_PREDICATE";
1189
0
    }
1190
1191
1
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
1192
1
    auto sub_predicate_access_paths = DORIS_TRY(_get_sub_access_paths(predicate_access_paths));
1193
1194
1
    if (sub_all_access_paths.empty()) {
1195
0
        return Status::OK();
1196
0
    }
1197
1198
1
    TColumnAccessPaths key_all_access_paths;
1199
1
    TColumnAccessPaths val_all_access_paths;
1200
1
    TColumnAccessPaths key_predicate_access_paths;
1201
1
    TColumnAccessPaths val_predicate_access_paths;
1202
1203
1
    for (auto paths : sub_all_access_paths) {
1204
1
        if (paths.data_access_path.path[0] == "*") {
1205
0
            paths.data_access_path.path[0] = _key_iterator->column_name();
1206
0
            key_all_access_paths.emplace_back(paths);
1207
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1208
0
            val_all_access_paths.emplace_back(paths);
1209
1
        } else if (paths.data_access_path.path[0] == "KEYS") {
1210
1
            paths.data_access_path.path[0] = _key_iterator->column_name();
1211
1
            key_all_access_paths.emplace_back(paths);
1212
1
        } else if (paths.data_access_path.path[0] == "VALUES") {
1213
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1214
0
            val_all_access_paths.emplace_back(paths);
1215
0
        }
1216
1
    }
1217
1
    const auto need_read_keys = !key_all_access_paths.empty();
1218
1
    const auto need_read_values = !val_all_access_paths.empty();
1219
1220
1
    for (auto paths : sub_predicate_access_paths) {
1221
0
        if (paths.data_access_path.path[0] == "*") {
1222
0
            paths.data_access_path.path[0] = _key_iterator->column_name();
1223
0
            key_predicate_access_paths.emplace_back(paths);
1224
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1225
0
            val_predicate_access_paths.emplace_back(paths);
1226
0
        } else if (paths.data_access_path.path[0] == "KEYS") {
1227
0
            paths.data_access_path.path[0] = _key_iterator->column_name();
1228
0
            key_predicate_access_paths.emplace_back(paths);
1229
0
        } else if (paths.data_access_path.path[0] == "VALUES") {
1230
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1231
0
            val_predicate_access_paths.emplace_back(paths);
1232
0
        }
1233
0
    }
1234
1235
1
    if (need_read_keys) {
1236
1
        _key_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1237
1
        RETURN_IF_ERROR(
1238
1
                _key_iterator->set_access_paths(key_all_access_paths, key_predicate_access_paths));
1239
1
    } else {
1240
0
        _key_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1241
0
        DLOG(INFO) << "Map column iterator set key column to SKIP_READING";
1242
0
    }
1243
1244
1
    if (need_read_values) {
1245
0
        _val_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1246
0
        RETURN_IF_ERROR(
1247
0
                _val_iterator->set_access_paths(val_all_access_paths, val_predicate_access_paths));
1248
1
    } else {
1249
1
        _val_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1250
1
        DLOG(INFO) << "Map column iterator set value column to SKIP_READING";
1251
1
    }
1252
1
    return Status::OK();
1253
1
}
1254
1255
0
Status MapFileColumnIterator::read_null_map(size_t* n, NullMap& null_map) {
1256
0
    if (!_map_reader->is_nullable()) {
1257
0
        return Status::InternalError("read_null_map is not supported for non-nullable column");
1258
0
    }
1259
0
    if (!_null_iterator) {
1260
        // Schema-change scenario: column became nullable but old segment has no null data.
1261
0
        null_map.resize(*n);
1262
0
        memset(null_map.data(), 0, *n);
1263
0
        return Status::OK();
1264
0
    }
1265
0
    auto null_col = ColumnUInt8::create();
1266
0
    auto null_col_ptr = null_col->get_ptr();
1267
0
    size_t read_rows = *n;
1268
0
    bool has_null = false;
1269
0
    RETURN_IF_ERROR(_null_iterator->next_batch(&read_rows, null_col_ptr, &has_null));
1270
0
    *n = read_rows;
1271
0
    null_map.resize(read_rows);
1272
0
    memcpy(null_map.data(), null_col->get_data().data(), read_rows);
1273
0
    return Status::OK();
1274
0
}
1275
1276
////////////////////////////////////////////////////////////////////////////////
1277
1278
StructFileColumnIterator::StructFileColumnIterator(
1279
        std::shared_ptr<ColumnReader> reader, ColumnIteratorUPtr null_iterator,
1280
        std::vector<ColumnIteratorUPtr>&& sub_column_iterators)
1281
4
        : _struct_reader(reader), _sub_column_iterators(std::move(sub_column_iterators)) {
1282
4
    if (_struct_reader->is_nullable()) {
1283
0
        _null_iterator = std::move(null_iterator);
1284
0
    }
1285
4
}
1286
1287
0
Status StructFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1288
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1289
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1290
0
        return Status::OK();
1291
0
    }
1292
1293
0
    for (auto& column_iterator : _sub_column_iterators) {
1294
0
        RETURN_IF_ERROR(column_iterator->init(opts));
1295
0
    }
1296
0
    if (_struct_reader->is_nullable()) {
1297
0
        RETURN_IF_ERROR(_null_iterator->init(opts));
1298
0
    }
1299
0
    return Status::OK();
1300
0
}
1301
1302
0
Status StructFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1303
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1304
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1305
0
        dst->insert_many_defaults(*n);
1306
0
        return Status::OK();
1307
0
    }
1308
1309
0
    auto& column_struct = assert_cast<ColumnStruct&, TypeCheckOnRelease::DISABLE>(
1310
0
            dst->is_nullable() ? static_cast<ColumnNullable&>(*dst).get_nested_column() : *dst);
1311
0
    for (size_t i = 0; i < column_struct.tuple_size(); i++) {
1312
0
        size_t num_read = *n;
1313
0
        auto sub_column_ptr = column_struct.get_column(i).assume_mutable();
1314
0
        bool column_has_null = false;
1315
0
        RETURN_IF_ERROR(
1316
0
                _sub_column_iterators[i]->next_batch(&num_read, sub_column_ptr, &column_has_null));
1317
0
        DCHECK(num_read == *n);
1318
0
        column_struct.get_column_ptr(i) = std::move(sub_column_ptr);
1319
0
    }
1320
1321
0
    if (dst->is_nullable()) {
1322
0
        size_t num_read = *n;
1323
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1324
        // in not-null to null linked-schemachange mode,
1325
        // actually we do not change dat data include meta in footer,
1326
        // so may dst from changed meta which is nullable but old data is not nullable,
1327
        // if so, we should set null_map to all null by default
1328
0
        if (_null_iterator) {
1329
0
            bool null_signs_has_null = false;
1330
0
            RETURN_IF_ERROR(
1331
0
                    _null_iterator->next_batch(&num_read, null_map_ptr, &null_signs_has_null));
1332
0
        } else {
1333
0
            auto& null_map = assert_cast<ColumnUInt8&, TypeCheckOnRelease::DISABLE>(*null_map_ptr);
1334
0
            null_map.insert_many_vals(0, num_read);
1335
0
        }
1336
0
        DCHECK(num_read == *n);
1337
0
    }
1338
1339
0
    return Status::OK();
1340
0
}
1341
1342
0
Status StructFileColumnIterator::seek_to_ordinal(ordinal_t ord) {
1343
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1344
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1345
0
        return Status::OK();
1346
0
    }
1347
1348
0
    for (auto& column_iterator : _sub_column_iterators) {
1349
0
        RETURN_IF_ERROR(column_iterator->seek_to_ordinal(ord));
1350
0
    }
1351
0
    if (_struct_reader->is_nullable()) {
1352
0
        RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
1353
0
    }
1354
0
    return Status::OK();
1355
0
}
1356
1357
0
Status StructFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
1358
0
    for (auto& column_iterator : _sub_column_iterators) {
1359
0
        RETURN_IF_ERROR(column_iterator->init_prefetcher(params));
1360
0
    }
1361
0
    if (_struct_reader->is_nullable()) {
1362
0
        RETURN_IF_ERROR(_null_iterator->init_prefetcher(params));
1363
0
    }
1364
0
    return Status::OK();
1365
0
}
1366
1367
void StructFileColumnIterator::collect_prefetchers(
1368
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
1369
0
        PrefetcherInitMethod init_method) {
1370
0
    for (auto& column_iterator : _sub_column_iterators) {
1371
0
        column_iterator->collect_prefetchers(prefetchers, init_method);
1372
0
    }
1373
0
    if (_struct_reader->is_nullable()) {
1374
0
        _null_iterator->collect_prefetchers(prefetchers, init_method);
1375
0
    }
1376
0
}
1377
1378
Status StructFileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
1379
0
                                                MutableColumnPtr& dst) {
1380
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1381
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1382
0
        dst->insert_many_defaults(count);
1383
0
        return Status::OK();
1384
0
    }
1385
1386
0
    if (count == 0) {
1387
0
        return Status::OK();
1388
0
    }
1389
1390
0
    size_t this_run = 1;
1391
0
    auto start_idx = rowids[0];
1392
0
    auto last_idx = rowids[0];
1393
0
    for (size_t i = 1; i < count; ++i) {
1394
0
        if (last_idx == rowids[i] - 1) {
1395
0
            last_idx = rowids[i];
1396
0
            this_run++;
1397
0
            continue;
1398
0
        }
1399
0
        RETURN_IF_ERROR(seek_to_ordinal(start_idx));
1400
0
        size_t num_read = this_run;
1401
0
        RETURN_IF_ERROR(next_batch(&num_read, dst, nullptr));
1402
0
        DCHECK_EQ(num_read, this_run);
1403
1404
0
        start_idx = rowids[i];
1405
0
        last_idx = rowids[i];
1406
0
        this_run = 1;
1407
0
    }
1408
1409
0
    RETURN_IF_ERROR(seek_to_ordinal(start_idx));
1410
0
    size_t num_read = this_run;
1411
0
    RETURN_IF_ERROR(next_batch(&num_read, dst, nullptr));
1412
0
    DCHECK_EQ(num_read, this_run);
1413
0
    return Status::OK();
1414
0
}
1415
1416
1
void StructFileColumnIterator::set_need_to_read() {
1417
1
    set_reading_flag(ReadingFlag::NEED_TO_READ);
1418
2
    for (auto& sub_iterator : _sub_column_iterators) {
1419
2
        sub_iterator->set_need_to_read();
1420
2
    }
1421
1
}
1422
1423
0
void StructFileColumnIterator::remove_pruned_sub_iterators() {
1424
0
    for (auto it = _sub_column_iterators.begin(); it != _sub_column_iterators.end();) {
1425
0
        auto& sub_iterator = *it;
1426
0
        if (sub_iterator->reading_flag() == ReadingFlag::SKIP_READING) {
1427
0
            DLOG(INFO) << "Struct column iterator remove pruned sub-column "
1428
0
                       << sub_iterator->column_name();
1429
0
            it = _sub_column_iterators.erase(it);
1430
0
        } else {
1431
0
            sub_iterator->remove_pruned_sub_iterators();
1432
0
            ++it;
1433
0
        }
1434
0
    }
1435
0
}
1436
1437
Status StructFileColumnIterator::set_access_paths(
1438
        const TColumnAccessPaths& all_access_paths,
1439
6
        const TColumnAccessPaths& predicate_access_paths) {
1440
6
    if (all_access_paths.empty()) {
1441
1
        return Status::OK();
1442
1
    }
1443
1444
5
    if (!predicate_access_paths.empty()) {
1445
4
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1446
4
        DLOG(INFO) << "Struct column iterator set sub-column " << _column_name
1447
4
                   << " to READING_FOR_PREDICATE";
1448
4
    }
1449
5
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
1450
3
    auto sub_predicate_access_paths = DORIS_TRY(_get_sub_access_paths(predicate_access_paths));
1451
1452
3
    const auto no_sub_column_to_skip = sub_all_access_paths.empty();
1453
3
    const auto no_predicate_sub_column = sub_predicate_access_paths.empty();
1454
1455
6
    for (auto& sub_iterator : _sub_column_iterators) {
1456
6
        const auto name = sub_iterator->column_name();
1457
6
        bool need_to_read = no_sub_column_to_skip;
1458
6
        TColumnAccessPaths sub_all_access_paths_of_this;
1459
6
        if (!need_to_read) {
1460
4
            for (const auto& paths : sub_all_access_paths) {
1461
4
                if (paths.data_access_path.path[0] == name) {
1462
2
                    sub_all_access_paths_of_this.emplace_back(paths);
1463
2
                }
1464
4
            }
1465
4
            need_to_read = !sub_all_access_paths_of_this.empty();
1466
4
        }
1467
1468
6
        if (!need_to_read) {
1469
2
            set_reading_flag(ReadingFlag::SKIP_READING);
1470
2
            sub_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1471
2
            DLOG(INFO) << "Struct column iterator set sub-column " << name << " to SKIP_READING";
1472
2
            continue;
1473
2
        }
1474
4
        set_reading_flag(ReadingFlag::NEED_TO_READ);
1475
4
        sub_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1476
1477
4
        TColumnAccessPaths sub_predicate_access_paths_of_this;
1478
1479
4
        if (!no_predicate_sub_column) {
1480
3
            for (const auto& paths : sub_predicate_access_paths) {
1481
3
                if (StringCaseEqual()(paths.data_access_path.path[0], name)) {
1482
2
                    sub_predicate_access_paths_of_this.emplace_back(paths);
1483
2
                }
1484
3
            }
1485
3
        }
1486
1487
4
        RETURN_IF_ERROR(sub_iterator->set_access_paths(sub_all_access_paths_of_this,
1488
4
                                                       sub_predicate_access_paths_of_this));
1489
4
    }
1490
3
    return Status::OK();
1491
3
}
1492
1493
0
Status StructFileColumnIterator::read_null_map(size_t* n, NullMap& null_map) {
1494
0
    if (!_struct_reader->is_nullable()) {
1495
0
        return Status::InternalError("read_null_map is not supported for non-nullable column");
1496
0
    }
1497
0
    if (!_null_iterator) {
1498
        // Schema-change scenario: column became nullable but old segment has no null data.
1499
0
        null_map.resize(*n);
1500
0
        memset(null_map.data(), 0, *n);
1501
0
        return Status::OK();
1502
0
    }
1503
0
    auto null_col = ColumnUInt8::create();
1504
0
    auto null_col_ptr = null_col->get_ptr();
1505
0
    size_t read_rows = *n;
1506
0
    bool has_null = false;
1507
0
    RETURN_IF_ERROR(_null_iterator->next_batch(&read_rows, null_col_ptr, &has_null));
1508
0
    *n = read_rows;
1509
0
    null_map.resize(read_rows);
1510
0
    memcpy(null_map.data(), null_col->get_data().data(), read_rows);
1511
0
    return Status::OK();
1512
0
}
1513
1514
////////////////////////////////////////////////////////////////////////////////
1515
179
Status OffsetFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1516
179
    RETURN_IF_ERROR(_offset_iterator->init(opts));
1517
    // allocate peek tmp column once
1518
179
    _peek_tmp_col = ColumnOffset64::create();
1519
179
    return Status::OK();
1520
179
}
1521
1522
180
Status OffsetFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1523
180
    RETURN_IF_ERROR(_offset_iterator->next_batch(n, dst, has_null));
1524
180
    return Status::OK();
1525
180
}
1526
1527
363
Status OffsetFileColumnIterator::_peek_one_offset(ordinal_t* offset) {
1528
363
    if (_offset_iterator->get_current_page()->has_remaining()) {
1529
181
        PageDecoder* offset_page_decoder = _offset_iterator->get_current_page()->data_decoder.get();
1530
181
        size_t n = 1;
1531
181
        _peek_tmp_col->clear();
1532
181
        RETURN_IF_ERROR(offset_page_decoder->peek_next_batch(&n, _peek_tmp_col)); // not null
1533
181
        DCHECK(_peek_tmp_col->size() == 1);
1534
181
        *offset =
1535
181
                assert_cast<const ColumnOffset64*, TypeCheckOnRelease::DISABLE>(_peek_tmp_col.get())
1536
181
                        ->get_element(0);
1537
182
    } else {
1538
182
        *offset = _offset_iterator->get_current_page()->next_array_item_ordinal;
1539
182
    }
1540
363
    return Status::OK();
1541
363
}
1542
1543
0
Status OffsetFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
1544
0
    return _offset_iterator->init_prefetcher(params);
1545
0
}
1546
1547
void OffsetFileColumnIterator::collect_prefetchers(
1548
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
1549
0
        PrefetcherInitMethod init_method) {
1550
0
    _offset_iterator->collect_prefetchers(prefetchers, init_method);
1551
0
}
1552
1553
/**
1554
 *  first_storage_offset read from page should smaller than next_storage_offset which here call _peek_one_offset from page,
1555
    and first_column_offset is keep in memory data which is different dimension with (first_storage_offset and next_storage_offset)
1556
     eg. step1. read page: first_storage_offset = 16382
1557
         step2. read page below with _peek_one_offset(&last_offset): last_offset = 16387
1558
         step3. first_offset = 126 which is calculate in column offsets
1559
         for loop column offsets element in size
1560
            we can calculate from first_storage_offset to next_storage_offset one by one to fill with offsets_data in memory column offsets
1561
 * @param start
1562
 * @param column_offsets
1563
 * @return
1564
 */
1565
Status OffsetFileColumnIterator::_calculate_offsets(ssize_t start,
1566
179
                                                    ColumnArray::ColumnOffsets& column_offsets) {
1567
179
    ordinal_t next_storage_offset = 0;
1568
179
    RETURN_IF_ERROR(_peek_one_offset(&next_storage_offset));
1569
1570
    // calculate real offsets
1571
179
    auto& offsets_data = column_offsets.get_data();
1572
179
    ordinal_t first_column_offset = offsets_data[start - 1]; // -1 is valid
1573
179
    ordinal_t first_storage_offset = offsets_data[start];
1574
179
    DCHECK(next_storage_offset >= first_storage_offset);
1575
88.9k
    for (ssize_t i = start; i < offsets_data.size() - 1; ++i) {
1576
88.7k
        offsets_data[i] = first_column_offset + (offsets_data[i + 1] - first_storage_offset);
1577
88.7k
    }
1578
    // last offset
1579
179
    offsets_data[offsets_data.size() - 1] =
1580
179
            first_column_offset + (next_storage_offset - first_storage_offset);
1581
179
    return Status::OK();
1582
179
}
1583
1584
////////////////////////////////////////////////////////////////////////////////
1585
ArrayFileColumnIterator::ArrayFileColumnIterator(std::shared_ptr<ColumnReader> reader,
1586
                                                 OffsetFileColumnIteratorUPtr offset_reader,
1587
                                                 ColumnIteratorUPtr item_iterator,
1588
                                                 ColumnIteratorUPtr null_iterator)
1589
11
        : _array_reader(reader),
1590
11
          _offset_iterator(std::move(offset_reader)),
1591
11
          _item_iterator(std::move(item_iterator)) {
1592
11
    if (_array_reader->is_nullable()) {
1593
8
        _null_iterator = std::move(null_iterator);
1594
8
    }
1595
11
}
1596
1597
10
Status ArrayFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1598
10
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1599
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip readking.";
1600
0
        return Status::OK();
1601
0
    }
1602
1603
10
    RETURN_IF_ERROR(_offset_iterator->init(opts));
1604
10
    RETURN_IF_ERROR(_item_iterator->init(opts));
1605
10
    if (_array_reader->is_nullable()) {
1606
8
        RETURN_IF_ERROR(_null_iterator->init(opts));
1607
8
    }
1608
10
    return Status::OK();
1609
10
}
1610
1611
12
Status ArrayFileColumnIterator::_seek_by_offsets(ordinal_t ord) {
1612
    // using offsets info
1613
12
    ordinal_t offset = 0;
1614
12
    RETURN_IF_ERROR(_offset_iterator->_peek_one_offset(&offset));
1615
12
    RETURN_IF_ERROR(_item_iterator->seek_to_ordinal(offset));
1616
12
    return Status::OK();
1617
12
}
1618
1619
12
Status ArrayFileColumnIterator::seek_to_ordinal(ordinal_t ord) {
1620
12
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1621
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip reading.";
1622
0
        return Status::OK();
1623
0
    }
1624
1625
12
    RETURN_IF_ERROR(_offset_iterator->seek_to_ordinal(ord));
1626
12
    if (_array_reader->is_nullable()) {
1627
10
        RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
1628
10
    }
1629
12
    return _seek_by_offsets(ord);
1630
12
}
1631
1632
10
Status ArrayFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1633
10
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1634
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip reading.";
1635
0
        dst->insert_many_defaults(*n);
1636
0
        return Status::OK();
1637
0
    }
1638
1639
10
    const auto* column_array = check_and_get_column<ColumnArray>(
1640
10
            dst->is_nullable() ? static_cast<ColumnNullable&>(*dst).get_nested_column() : *dst);
1641
1642
10
    bool offsets_has_null = false;
1643
10
    auto column_offsets_ptr = column_array->get_offsets_column().assume_mutable();
1644
10
    ssize_t start = column_offsets_ptr->size();
1645
10
    RETURN_IF_ERROR(_offset_iterator->next_batch(n, column_offsets_ptr, &offsets_has_null));
1646
10
    if (*n == 0) {
1647
0
        return Status::OK();
1648
0
    }
1649
10
    auto& column_offsets = static_cast<ColumnArray::ColumnOffsets&>(*column_offsets_ptr);
1650
10
    RETURN_IF_ERROR(_offset_iterator->_calculate_offsets(start, column_offsets));
1651
10
    size_t num_items =
1652
10
            column_offsets.get_data().back() - column_offsets.get_data()[start - 1]; // -1 is valid
1653
10
    auto column_items_ptr = column_array->get_data().assume_mutable();
1654
10
    if (num_items > 0) {
1655
10
        size_t num_read = num_items;
1656
10
        bool items_has_null = false;
1657
10
        RETURN_IF_ERROR(_item_iterator->next_batch(&num_read, column_items_ptr, &items_has_null));
1658
10
        DCHECK(num_read == num_items);
1659
10
    }
1660
1661
10
    if (dst->is_nullable()) {
1662
8
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1663
8
        size_t num_read = *n;
1664
        // in not-null to null linked-schemachange mode,
1665
        // actually we do not change dat data include meta in footer,
1666
        // so may dst from changed meta which is nullable but old data is not nullable,
1667
        // if so, we should set null_map to all null by default
1668
8
        if (_null_iterator) {
1669
8
            bool null_signs_has_null = false;
1670
8
            RETURN_IF_ERROR(
1671
8
                    _null_iterator->next_batch(&num_read, null_map_ptr, &null_signs_has_null));
1672
8
        } else {
1673
0
            auto& null_map = assert_cast<ColumnUInt8&, TypeCheckOnRelease::DISABLE>(*null_map_ptr);
1674
0
            null_map.insert_many_vals(0, num_read);
1675
0
        }
1676
8
        DCHECK(num_read == *n);
1677
8
    }
1678
1679
10
    return Status::OK();
1680
10
}
1681
1682
0
Status ArrayFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
1683
0
    RETURN_IF_ERROR(_offset_iterator->init_prefetcher(params));
1684
0
    RETURN_IF_ERROR(_item_iterator->init_prefetcher(params));
1685
0
    if (_array_reader->is_nullable()) {
1686
0
        RETURN_IF_ERROR(_null_iterator->init_prefetcher(params));
1687
0
    }
1688
0
    return Status::OK();
1689
0
}
1690
1691
void ArrayFileColumnIterator::collect_prefetchers(
1692
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
1693
0
        PrefetcherInitMethod init_method) {
1694
0
    _offset_iterator->collect_prefetchers(prefetchers, init_method);
1695
    // the actual data pages to read of item column depends on the read result of offset column,
1696
    // so we can't init prefetch blocks according to rowids, just prefetch all data blocks here.
1697
0
    _item_iterator->collect_prefetchers(prefetchers, PrefetcherInitMethod::ALL_DATA_BLOCKS);
1698
0
    if (_array_reader->is_nullable()) {
1699
0
        _null_iterator->collect_prefetchers(prefetchers, init_method);
1700
0
    }
1701
0
}
1702
1703
Status ArrayFileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
1704
0
                                               MutableColumnPtr& dst) {
1705
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1706
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip reading.";
1707
0
        dst->insert_many_defaults(count);
1708
0
        return Status::OK();
1709
0
    }
1710
1711
0
    for (size_t i = 0; i < count; ++i) {
1712
        // TODO(cambyzju): now read array one by one, need optimize later
1713
0
        RETURN_IF_ERROR(seek_to_ordinal(rowids[i]));
1714
0
        size_t num_read = 1;
1715
0
        RETURN_IF_ERROR(next_batch(&num_read, dst, nullptr));
1716
0
        DCHECK(num_read == 1);
1717
0
    }
1718
0
    return Status::OK();
1719
0
}
1720
1721
0
void ArrayFileColumnIterator::set_need_to_read() {
1722
0
    set_reading_flag(ReadingFlag::NEED_TO_READ);
1723
0
    _item_iterator->set_need_to_read();
1724
0
}
1725
1726
0
void ArrayFileColumnIterator::remove_pruned_sub_iterators() {
1727
0
    _item_iterator->remove_pruned_sub_iterators();
1728
0
}
1729
1730
Status ArrayFileColumnIterator::set_access_paths(const TColumnAccessPaths& all_access_paths,
1731
1
                                                 const TColumnAccessPaths& predicate_access_paths) {
1732
1
    if (all_access_paths.empty()) {
1733
0
        return Status::OK();
1734
0
    }
1735
1736
1
    if (!predicate_access_paths.empty()) {
1737
0
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1738
0
        DLOG(INFO) << "Array column iterator set sub-column " << _column_name
1739
0
                   << " to READING_FOR_PREDICATE";
1740
0
    }
1741
1742
1
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
1743
1
    auto sub_predicate_access_paths = DORIS_TRY(_get_sub_access_paths(predicate_access_paths));
1744
1745
1
    const auto no_sub_column_to_skip = sub_all_access_paths.empty();
1746
1
    const auto no_predicate_sub_column = sub_predicate_access_paths.empty();
1747
1748
1
    if (!no_sub_column_to_skip) {
1749
1
        for (auto& path : sub_all_access_paths) {
1750
1
            if (path.data_access_path.path[0] == "*") {
1751
1
                path.data_access_path.path[0] = _item_iterator->column_name();
1752
1
            }
1753
1
        }
1754
1
    }
1755
1756
1
    if (!no_predicate_sub_column) {
1757
0
        for (auto& path : sub_predicate_access_paths) {
1758
0
            if (path.data_access_path.path[0] == "*") {
1759
0
                path.data_access_path.path[0] = _item_iterator->column_name();
1760
0
            }
1761
0
        }
1762
0
    }
1763
1764
1
    if (!no_sub_column_to_skip || !no_predicate_sub_column) {
1765
1
        _item_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1766
1
        RETURN_IF_ERROR(
1767
1
                _item_iterator->set_access_paths(sub_all_access_paths, sub_predicate_access_paths));
1768
1
    }
1769
1
    return Status::OK();
1770
1
}
1771
1772
0
Status ArrayFileColumnIterator::read_null_map(size_t* n, NullMap& null_map) {
1773
0
    if (!_array_reader->is_nullable()) {
1774
0
        return Status::InternalError("read_null_map is not supported for non-nullable column");
1775
0
    }
1776
0
    if (!_null_iterator) {
1777
        // Schema-change scenario: column became nullable but old segment has no null data.
1778
0
        null_map.resize(*n);
1779
0
        memset(null_map.data(), 0, *n);
1780
0
        return Status::OK();
1781
0
    }
1782
0
    auto null_col = ColumnUInt8::create();
1783
0
    auto null_col_ptr = null_col->get_ptr();
1784
0
    size_t read_rows = *n;
1785
0
    bool has_null = false;
1786
0
    RETURN_IF_ERROR(_null_iterator->next_batch(&read_rows, null_col_ptr, &has_null));
1787
0
    *n = read_rows;
1788
0
    null_map.resize(read_rows);
1789
0
    memcpy(null_map.data(), null_col->get_data().data(), read_rows);
1790
0
    return Status::OK();
1791
0
}
1792
1793
////////////////////////////////////////////////////////////////////////////////
1794
1795
13.5k
FileColumnIterator::FileColumnIterator(std::shared_ptr<ColumnReader> reader) : _reader(reader) {}
1796
1797
13.5k
Status FileColumnIterator::init(const ColumnIteratorOptions& opts) {
1798
13.5k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1799
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
1800
0
        return Status::OK();
1801
0
    }
1802
1803
13.5k
    _opts = opts;
1804
13.5k
    if (!_opts.use_page_cache) {
1805
13.5k
        _reader->disable_index_meta_cache();
1806
13.5k
    }
1807
13.5k
    RETURN_IF_ERROR(get_block_compression_codec(_reader->get_compression(), &_compress_codec));
1808
13.5k
    if (config::enable_low_cardinality_optimize &&
1809
13.5k
        opts.io_ctx.reader_type == ReaderType::READER_QUERY &&
1810
13.5k
        _reader->encoding_info()->encoding() == DICT_ENCODING) {
1811
0
        auto dict_encoding_type = _reader->get_dict_encoding_type();
1812
        // Only if the column is a predicate column, then we need check the all dict encoding flag
1813
        // because we could rewrite the predciate to accelarate query speed. But if it is not a
1814
        // predicate column, then it is useless. And it has a bad impact on cold read(first time read)
1815
        // because it will load the column's ordinal index and zonemap index and maybe other indices.
1816
        // it has bad impact on primary key query. For example, select * from table where pk = 1, and
1817
        // the table has 2000 columns.
1818
0
        if (dict_encoding_type == ColumnReader::UNKNOWN_DICT_ENCODING && opts.is_predicate_column) {
1819
0
            RETURN_IF_ERROR(seek_to_ordinal(_reader->num_rows() - 1));
1820
0
            _is_all_dict_encoding = _page.is_dict_encoding;
1821
0
            _reader->set_dict_encoding_type(_is_all_dict_encoding
1822
0
                                                    ? ColumnReader::ALL_DICT_ENCODING
1823
0
                                                    : ColumnReader::PARTIAL_DICT_ENCODING);
1824
0
        } else {
1825
0
            _is_all_dict_encoding = dict_encoding_type == ColumnReader::ALL_DICT_ENCODING;
1826
0
        }
1827
0
    }
1828
13.5k
    return Status::OK();
1829
13.5k
}
1830
1831
13.5k
FileColumnIterator::~FileColumnIterator() = default;
1832
1833
0
void FileColumnIterator::_trigger_prefetch_if_eligible(ordinal_t ord) {
1834
0
    std::vector<BlockRange> ranges;
1835
0
    if (_prefetcher->need_prefetch(cast_set<uint32_t>(ord), &ranges)) {
1836
0
        for (const auto& range : ranges) {
1837
0
            _cached_remote_file_reader->prefetch_range(range.offset, range.size, &_opts.io_ctx);
1838
0
        }
1839
0
    }
1840
0
}
1841
1842
34.3k
Status FileColumnIterator::seek_to_ordinal(ordinal_t ord) {
1843
34.3k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1844
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
1845
0
        return Status::OK();
1846
0
    }
1847
1848
34.3k
    LOG_IF(INFO, config::enable_segment_prefetch_verbose_log) << fmt::format(
1849
0
            "[verbose] FileColumnIterator::seek_to_ordinal seek to ordinal {}, enable_prefetch={}",
1850
0
            ord, _enable_prefetch);
1851
34.3k
    if (_enable_prefetch) {
1852
0
        _trigger_prefetch_if_eligible(ord);
1853
0
    }
1854
1855
    // if current page contains this row, we don't need to seek
1856
34.3k
    if (!_page || !_page.contains(ord) || !_page_iter.valid()) {
1857
13.9k
        RETURN_IF_ERROR(_reader->seek_at_or_before(ord, &_page_iter, _opts));
1858
13.9k
        RETURN_IF_ERROR(_read_data_page(_page_iter));
1859
13.9k
    }
1860
34.3k
    RETURN_IF_ERROR(_seek_to_pos_in_page(&_page, ord - _page.first_ordinal));
1861
34.3k
    _current_ordinal = ord;
1862
34.3k
    return Status::OK();
1863
34.3k
}
1864
1865
0
Status FileColumnIterator::seek_to_page_start() {
1866
0
    return seek_to_ordinal(_page.first_ordinal);
1867
0
}
1868
1869
36.1k
Status FileColumnIterator::_seek_to_pos_in_page(ParsedPage* page, ordinal_t offset_in_page) const {
1870
36.1k
    if (page->offset_in_page == offset_in_page) {
1871
        // fast path, do nothing
1872
31.2k
        return Status::OK();
1873
31.2k
    }
1874
1875
4.82k
    ordinal_t pos_in_data = offset_in_page;
1876
4.82k
    if (_page.has_null) {
1877
4
        ordinal_t offset_in_data = 0;
1878
4
        ordinal_t skips = offset_in_page;
1879
1880
4
        if (offset_in_page > page->offset_in_page) {
1881
            // forward, reuse null bitmap
1882
0
            skips = offset_in_page - page->offset_in_page;
1883
0
            offset_in_data = page->data_decoder->current_index();
1884
4
        } else {
1885
            // rewind null bitmap, and
1886
4
            page->null_decoder = RleDecoder<bool>((const uint8_t*)page->null_bitmap.data,
1887
4
                                                  cast_set<int>(page->null_bitmap.size), 1);
1888
4
        }
1889
1890
4
        auto skip_nulls = page->null_decoder.Skip(skips);
1891
4
        pos_in_data = offset_in_data + skips - skip_nulls;
1892
4
    }
1893
1894
4.82k
    RETURN_IF_ERROR(page->data_decoder->seek_to_position_in_page(pos_in_data));
1895
4.82k
    page->offset_in_page = offset_in_page;
1896
4.82k
    return Status::OK();
1897
4.82k
}
1898
1899
0
Status FileColumnIterator::next_batch_of_zone_map(size_t* n, MutableColumnPtr& dst) {
1900
0
    return _reader->next_batch_of_zone_map(n, dst);
1901
0
}
1902
1903
28.8k
Status FileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1904
28.8k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1905
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
1906
0
        dst->insert_many_defaults(*n);
1907
0
        return Status::OK();
1908
0
    }
1909
1910
28.8k
    size_t curr_size = dst->byte_size();
1911
28.8k
    dst->reserve(*n);
1912
28.8k
    size_t remaining = *n;
1913
28.8k
    *has_null = false;
1914
59.4k
    while (remaining > 0) {
1915
30.5k
        if (!_page.has_remaining()) {
1916
1.76k
            bool eos = false;
1917
1.76k
            RETURN_IF_ERROR(_load_next_page(&eos));
1918
1.76k
            if (eos) {
1919
0
                break;
1920
0
            }
1921
1.76k
        }
1922
1923
        // number of rows to be read from this page
1924
30.5k
        size_t nrows_in_page = std::min(remaining, _page.remaining());
1925
30.5k
        size_t nrows_to_read = nrows_in_page;
1926
30.5k
        if (_page.has_null) {
1927
21.0k
            while (nrows_to_read > 0) {
1928
20.7k
                bool is_null = false;
1929
20.7k
                size_t this_run = _page.null_decoder.GetNextRun(&is_null, nrows_to_read);
1930
                // we use num_rows only for CHECK
1931
20.7k
                size_t num_rows = this_run;
1932
20.7k
                if (!is_null) {
1933
10.4k
                    RETURN_IF_ERROR(_page.data_decoder->next_batch(&num_rows, dst));
1934
10.4k
                    DCHECK_EQ(this_run, num_rows);
1935
10.4k
                } else {
1936
10.3k
                    *has_null = true;
1937
10.3k
                    auto* null_col = check_and_get_column<ColumnNullable>(dst.get());
1938
10.3k
                    if (null_col != nullptr) {
1939
10.3k
                        null_col->insert_many_defaults(this_run);
1940
10.3k
                    } else {
1941
0
                        return Status::InternalError("unexpected column type in column reader");
1942
0
                    }
1943
10.3k
                }
1944
1945
20.7k
                nrows_to_read -= this_run;
1946
20.7k
                _page.offset_in_page += this_run;
1947
20.7k
                _current_ordinal += this_run;
1948
20.7k
            }
1949
30.3k
        } else {
1950
30.3k
            RETURN_IF_ERROR(_page.data_decoder->next_batch(&nrows_to_read, dst));
1951
30.3k
            DCHECK_EQ(nrows_to_read, nrows_in_page);
1952
1953
30.3k
            _page.offset_in_page += nrows_to_read;
1954
30.3k
            _current_ordinal += nrows_to_read;
1955
30.3k
        }
1956
30.5k
        remaining -= nrows_in_page;
1957
30.5k
    }
1958
28.8k
    *n -= remaining;
1959
28.8k
    _opts.stats->bytes_read += (dst->byte_size() - curr_size) + BitmapSize(*n);
1960
1961
28.8k
#ifdef BE_TEST
1962
28.8k
    _reader->check_data_by_zone_map_for_test(dst);
1963
28.8k
#endif
1964
28.8k
    return Status::OK();
1965
28.8k
}
1966
1967
0
Status FileColumnIterator::read_null_map(size_t* n, NullMap& null_map) {
1968
0
    if (!_reader->is_nullable()) {
1969
0
        return Status::InternalError("read_null_map is not supported for non-nullable column");
1970
0
    }
1971
1972
0
    null_map.resize(*n);
1973
0
    size_t remaining = *n;
1974
0
    size_t offset = 0;
1975
1976
0
    while (remaining > 0) {
1977
0
        if (!_page.has_remaining()) {
1978
0
            bool eos = false;
1979
0
            RETURN_IF_ERROR(_load_next_page(&eos));
1980
0
            if (eos) {
1981
0
                break;
1982
0
            }
1983
0
        }
1984
1985
0
        if (!_page.has_null) {
1986
0
            size_t nrows_in_page = std::min(remaining, _page.remaining());
1987
0
            memset(null_map.data() + offset, 0, nrows_in_page);
1988
0
            offset += nrows_in_page;
1989
0
            _current_ordinal += nrows_in_page;
1990
0
            _page.offset_in_page += nrows_in_page;
1991
0
            remaining -= nrows_in_page;
1992
0
            continue;
1993
0
        }
1994
1995
0
        size_t nrows_in_page = std::min(remaining, _page.remaining());
1996
0
        size_t this_run = 0;
1997
0
        while (this_run < nrows_in_page) {
1998
0
            bool is_null = false;
1999
0
            size_t run_len = _page.null_decoder.GetNextRun(&is_null, nrows_in_page - this_run);
2000
0
            memset(null_map.data() + offset + this_run, is_null ? 1 : 0, run_len);
2001
0
            this_run += run_len;
2002
0
        }
2003
2004
0
        offset += nrows_in_page;
2005
0
        _page.offset_in_page += nrows_in_page;
2006
0
        _current_ordinal += nrows_in_page;
2007
0
        remaining -= nrows_in_page;
2008
0
    }
2009
2010
0
    *n = offset;
2011
0
    return Status::OK();
2012
0
}
2013
2014
Status FileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
2015
4.98k
                                          MutableColumnPtr& dst) {
2016
4.98k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
2017
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
2018
0
        dst->insert_many_defaults(count);
2019
0
        return Status::OK();
2020
0
    }
2021
2022
4.98k
    size_t remaining = count;
2023
4.98k
    size_t total_read_count = 0;
2024
4.98k
    size_t nrows_to_read = 0;
2025
10.4k
    while (remaining > 0) {
2026
5.49k
        RETURN_IF_ERROR(seek_to_ordinal(rowids[total_read_count]));
2027
2028
        // number of rows to be read from this page
2029
5.49k
        nrows_to_read = std::min(remaining, _page.remaining());
2030
2031
5.49k
        if (_page.has_null) {
2032
4
            size_t already_read = 0;
2033
1.08k
            while ((nrows_to_read - already_read) > 0) {
2034
1.08k
                bool is_null = false;
2035
1.08k
                size_t this_run = std::min(nrows_to_read - already_read, _page.remaining());
2036
1.08k
                if (UNLIKELY(this_run == 0)) {
2037
0
                    break;
2038
0
                }
2039
1.08k
                this_run = _page.null_decoder.GetNextRun(&is_null, this_run);
2040
1.08k
                size_t offset = total_read_count + already_read;
2041
1.08k
                size_t this_read_count = 0;
2042
1.08k
                rowid_t current_ordinal_in_page =
2043
1.08k
                        cast_set<uint32_t>(_page.offset_in_page + _page.first_ordinal);
2044
3.36k
                for (size_t i = 0; i < this_run; ++i) {
2045
2.79k
                    if (rowids[offset + i] - current_ordinal_in_page >= this_run) {
2046
508
                        break;
2047
508
                    }
2048
2.28k
                    this_read_count++;
2049
2.28k
                }
2050
2051
1.08k
                auto origin_index = _page.data_decoder->current_index();
2052
1.08k
                if (this_read_count > 0) {
2053
744
                    if (is_null) {
2054
310
                        auto* null_col = check_and_get_column<ColumnNullable>(dst.get());
2055
310
                        if (UNLIKELY(null_col == nullptr)) {
2056
0
                            return Status::InternalError("unexpected column type in column reader");
2057
0
                        }
2058
2059
310
                        null_col->insert_many_defaults(this_read_count);
2060
434
                    } else {
2061
434
                        size_t read_count = this_read_count;
2062
2063
                        // ordinal in nullable columns' data buffer maybe be not continuously(the data doesn't contain null value),
2064
                        // so we need use `page_start_off_in_decoder` to calculate the actual offset in `data_decoder`
2065
434
                        size_t page_start_off_in_decoder =
2066
434
                                _page.first_ordinal + _page.offset_in_page - origin_index;
2067
434
                        RETURN_IF_ERROR(_page.data_decoder->read_by_rowids(
2068
434
                                &rowids[offset], page_start_off_in_decoder, &read_count, dst));
2069
434
                        DCHECK_EQ(read_count, this_read_count);
2070
434
                    }
2071
744
                }
2072
2073
1.08k
                if (!is_null) {
2074
553
                    RETURN_IF_ERROR(
2075
553
                            _page.data_decoder->seek_to_position_in_page(origin_index + this_run));
2076
553
                }
2077
2078
1.08k
                already_read += this_read_count;
2079
1.08k
                _page.offset_in_page += this_run;
2080
1.08k
                DCHECK(_page.offset_in_page <= _page.num_rows);
2081
1.08k
            }
2082
2083
4
            nrows_to_read = already_read;
2084
4
            total_read_count += nrows_to_read;
2085
4
            remaining -= nrows_to_read;
2086
5.49k
        } else {
2087
5.49k
            RETURN_IF_ERROR(_page.data_decoder->read_by_rowids(
2088
5.49k
                    &rowids[total_read_count], _page.first_ordinal, &nrows_to_read, dst));
2089
5.49k
            total_read_count += nrows_to_read;
2090
5.49k
            remaining -= nrows_to_read;
2091
5.49k
        }
2092
5.49k
    }
2093
4.98k
    return Status::OK();
2094
4.98k
}
2095
2096
1.76k
Status FileColumnIterator::_load_next_page(bool* eos) {
2097
1.76k
    _page_iter.next();
2098
1.76k
    if (!_page_iter.valid()) {
2099
0
        *eos = true;
2100
0
        return Status::OK();
2101
0
    }
2102
2103
1.76k
    RETURN_IF_ERROR(_read_data_page(_page_iter));
2104
1.76k
    RETURN_IF_ERROR(_seek_to_pos_in_page(&_page, 0));
2105
1.76k
    *eos = false;
2106
1.76k
    return Status::OK();
2107
1.76k
}
2108
2109
15.7k
Status FileColumnIterator::_read_data_page(const OrdinalPageIndexIterator& iter) {
2110
15.7k
    PageHandle handle;
2111
15.7k
    Slice page_body;
2112
15.7k
    PageFooterPB footer;
2113
15.7k
    _opts.type = DATA_PAGE;
2114
15.7k
    RETURN_IF_ERROR(
2115
15.7k
            _reader->read_page(_opts, iter.page(), &handle, &page_body, &footer, _compress_codec));
2116
    // parse data page
2117
15.7k
    auto st = ParsedPage::create(std::move(handle), page_body, footer.data_page_footer(),
2118
15.7k
                                 _reader->encoding_info(), iter.page(), iter.page_index(), &_page);
2119
15.7k
    if (!st.ok()) {
2120
0
        LOG(WARNING) << "failed to create ParsedPage, file=" << _opts.file_reader->path().native()
2121
0
                     << ", page_offset=" << iter.page().offset << ", page_size=" << iter.page().size
2122
0
                     << ", page_index=" << iter.page_index() << ", error=" << st;
2123
0
        return st;
2124
0
    }
2125
2126
    // dictionary page is read when the first data page that uses it is read,
2127
    // this is to optimize the memory usage: when there is no query on one column, we could
2128
    // release the memory of dictionary page.
2129
    // note that concurrent iterators for the same column won't repeatedly read dictionary page
2130
    // because of page cache.
2131
15.7k
    if (_reader->encoding_info()->encoding() == DICT_ENCODING) {
2132
4.39k
        auto dict_page_decoder = reinterpret_cast<BinaryDictPageDecoder*>(_page.data_decoder.get());
2133
4.39k
        if (dict_page_decoder->is_dict_encoding()) {
2134
2.75k
            if (_dict_decoder == nullptr) {
2135
2.75k
                RETURN_IF_ERROR(_read_dict_data());
2136
2.75k
                CHECK_NOTNULL(_dict_decoder);
2137
2.75k
            }
2138
2139
2.75k
            dict_page_decoder->set_dict_decoder(cast_set<uint32_t>(_dict_decoder->count()),
2140
2.75k
                                                _dict_word_info.get());
2141
2.75k
        }
2142
4.39k
    }
2143
15.7k
    return Status::OK();
2144
15.7k
}
2145
2146
2.75k
Status FileColumnIterator::_read_dict_data() {
2147
2.75k
    CHECK_EQ(_reader->encoding_info()->encoding(), DICT_ENCODING);
2148
    // read dictionary page
2149
2.75k
    Slice dict_data;
2150
2.75k
    PageFooterPB dict_footer;
2151
2.75k
    _opts.type = INDEX_PAGE;
2152
2153
2.75k
    RETURN_IF_ERROR(_reader->read_page(_opts, _reader->get_dict_page_pointer(), &_dict_page_handle,
2154
2.75k
                                       &dict_data, &dict_footer, _compress_codec, true));
2155
2.75k
    const EncodingInfo* encoding_info;
2156
2.75k
    RETURN_IF_ERROR(EncodingInfo::get(FieldType::OLAP_FIELD_TYPE_VARCHAR,
2157
2.75k
                                      dict_footer.dict_page_footer().encoding(), {},
2158
2.75k
                                      &encoding_info));
2159
2.75k
    RETURN_IF_ERROR(encoding_info->create_page_decoder(dict_data, {}, _dict_decoder));
2160
2.75k
    RETURN_IF_ERROR(_dict_decoder->init());
2161
2162
2.75k
    _dict_word_info.reset(new StringRef[_dict_decoder->count()]);
2163
2.75k
    RETURN_IF_ERROR(_dict_decoder->get_dict_word_info(_dict_word_info.get()));
2164
2.75k
    return Status::OK();
2165
2.75k
}
2166
2167
Status FileColumnIterator::get_row_ranges_by_zone_map(
2168
        const AndBlockColumnPredicate* col_predicates,
2169
        const std::vector<std::shared_ptr<const ColumnPredicate>>* delete_predicates,
2170
0
        RowRanges* row_ranges) {
2171
0
    if (_reader->has_zone_map()) {
2172
0
        RETURN_IF_ERROR(_reader->get_row_ranges_by_zone_map(col_predicates, delete_predicates,
2173
0
                                                            row_ranges, _opts));
2174
0
    }
2175
0
    return Status::OK();
2176
0
}
2177
2178
Status FileColumnIterator::get_row_ranges_by_bloom_filter(
2179
0
        const AndBlockColumnPredicate* col_predicates, RowRanges* row_ranges) {
2180
0
    if ((col_predicates->can_do_bloom_filter(false) && _reader->has_bloom_filter_index(false)) ||
2181
0
        (col_predicates->can_do_bloom_filter(true) && _reader->has_bloom_filter_index(true))) {
2182
0
        RETURN_IF_ERROR(_reader->get_row_ranges_by_bloom_filter(col_predicates, row_ranges, _opts));
2183
0
    }
2184
0
    return Status::OK();
2185
0
}
2186
2187
Status FileColumnIterator::get_row_ranges_by_dict(const AndBlockColumnPredicate* col_predicates,
2188
0
                                                  RowRanges* row_ranges) {
2189
0
    if (!_is_all_dict_encoding) {
2190
0
        return Status::OK();
2191
0
    }
2192
2193
0
    if (!_dict_decoder) {
2194
0
        RETURN_IF_ERROR(_read_dict_data());
2195
0
        CHECK_NOTNULL(_dict_decoder);
2196
0
    }
2197
2198
0
    if (!col_predicates->evaluate_and(_dict_word_info.get(), _dict_decoder->count())) {
2199
0
        row_ranges->clear();
2200
0
    }
2201
0
    return Status::OK();
2202
0
}
2203
2204
0
Status FileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
2205
0
    if (_cached_remote_file_reader =
2206
0
                std::dynamic_pointer_cast<io::CachedRemoteFileReader>(_reader->_file_reader);
2207
0
        !_cached_remote_file_reader) {
2208
0
        return Status::OK();
2209
0
    }
2210
0
    _enable_prefetch = true;
2211
0
    _prefetcher = std::make_unique<SegmentPrefetcher>(params.config);
2212
0
    RETURN_IF_ERROR(_prefetcher->init(_reader, params.read_options));
2213
0
    return Status::OK();
2214
0
}
2215
2216
void FileColumnIterator::collect_prefetchers(
2217
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
2218
0
        PrefetcherInitMethod init_method) {
2219
0
    if (_prefetcher) {
2220
0
        prefetchers[init_method].emplace_back(_prefetcher.get());
2221
0
    }
2222
0
}
2223
2224
3
Status DefaultValueColumnIterator::init(const ColumnIteratorOptions& opts) {
2225
3
    _opts = opts;
2226
    // be consistent with segment v1
2227
    // if _has_default_value, we should create default column iterator for this column, and
2228
    // "NULL" is a special default value which means the default value is null.
2229
3
    if (_has_default_value) {
2230
1
        if (_default_value == "NULL") {
2231
1
            _default_value_field = Field::create_field<TYPE_NULL>(Null {});
2232
1
        } else {
2233
0
            if (_type_info->type() == FieldType::OLAP_FIELD_TYPE_ARRAY) {
2234
0
                if (_default_value != "[]") {
2235
0
                    return Status::NotSupported("Array default {} is unsupported", _default_value);
2236
0
                } else {
2237
0
                    _default_value_field = Field::create_field<TYPE_ARRAY>(Array {});
2238
0
                    return Status::OK();
2239
0
                }
2240
0
            } else if (_type_info->type() == FieldType::OLAP_FIELD_TYPE_STRUCT) {
2241
0
                return Status::NotSupported("STRUCT default type is unsupported");
2242
0
            } else if (_type_info->type() == FieldType::OLAP_FIELD_TYPE_MAP) {
2243
0
                return Status::NotSupported("MAP default type is unsupported");
2244
0
            }
2245
0
            const auto t = _type_info->type();
2246
0
            const auto serde = DataTypeFactory::instance()
2247
0
                                       .create_data_type(t, _precision, _scale, _len)
2248
0
                                       ->get_serde();
2249
0
            DataTypeSerDe::FormatOptions opt;
2250
0
            RETURN_IF_ERROR(serde->from_olap_string(_default_value, _default_value_field, opt));
2251
0
        }
2252
2
    } else if (_is_nullable) {
2253
2
        _default_value_field = Field::create_field<TYPE_NULL>(Null {});
2254
2
    } else {
2255
0
        return Status::InternalError(
2256
0
                "invalid default value column for no default value and not nullable");
2257
0
    }
2258
3
    return Status::OK();
2259
3
}
2260
2261
0
Status DefaultValueColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
2262
0
    *has_null = _default_value_field.is_null();
2263
0
    _insert_many_default(dst, *n);
2264
0
    return Status::OK();
2265
0
}
2266
2267
Status DefaultValueColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
2268
0
                                                  MutableColumnPtr& dst) {
2269
0
    _insert_many_default(dst, count);
2270
0
    return Status::OK();
2271
0
}
2272
2273
0
void DefaultValueColumnIterator::_insert_many_default(MutableColumnPtr& dst, size_t n) {
2274
0
    if (_default_value_field.is_null()) {
2275
0
        dst->insert_many_defaults(n);
2276
0
    } else {
2277
0
        dst = dst->convert_to_predicate_column_if_dictionary();
2278
0
        dst->insert_duplicate_fields(_default_value_field, n);
2279
0
    }
2280
0
}
2281
2282
10
Status RowIdColumnIteratorV2::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
2283
10
    auto* string_column = assert_cast<ColumnString*, TypeCheckOnRelease::DISABLE>(dst.get());
2284
2285
20
    for (uint32_t i = 0; i < *n; ++i) {
2286
10
        uint32_t row_id = _current_rowid + i;
2287
10
        GlobalRowLoacationV2 location(_version, _backend_id, _file_id, row_id);
2288
10
        string_column->insert_data(reinterpret_cast<const char*>(&location),
2289
10
                                   sizeof(GlobalRowLoacationV2));
2290
10
    }
2291
10
    _current_rowid += *n;
2292
10
    return Status::OK();
2293
10
}
2294
2295
Status RowIdColumnIteratorV2::read_by_rowids(const rowid_t* rowids, const size_t count,
2296
5
                                             MutableColumnPtr& dst) {
2297
5
    auto* string_column = assert_cast<ColumnString*>(dst.get());
2298
2299
19
    for (size_t i = 0; i < count; ++i) {
2300
14
        uint32_t row_id = rowids[i];
2301
14
        GlobalRowLoacationV2 location(_version, _backend_id, _file_id, row_id);
2302
14
        string_column->insert_data(reinterpret_cast<const char*>(&location),
2303
14
                                   sizeof(GlobalRowLoacationV2));
2304
14
    }
2305
5
    return Status::OK();
2306
5
}
2307
#include "common/compile_check_end.h"
2308
2309
} // namespace doris::segment_v2