Coverage Report

Created: 2026-08-13 12:41

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/storage/segment/segment.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/segment.h"
19
20
#include <crc32c/crc32c.h>
21
#include <gen_cpp/Descriptors_types.h>
22
#include <gen_cpp/PlanNodes_types.h>
23
#include <gen_cpp/olap_file.pb.h>
24
#include <gen_cpp/segment_v2.pb.h>
25
26
#include <algorithm>
27
#include <cstring>
28
#include <memory>
29
#include <set>
30
#include <sstream>
31
#include <utility>
32
33
#include "cloud/config.h"
34
#include "common/config.h"
35
#include "common/exception.h"
36
#include "common/logging.h"
37
#include "common/status.h"
38
#include "core/column/column.h"
39
#include "core/data_type/data_type.h"
40
#include "core/data_type/data_type_factory.hpp"
41
#include "core/data_type/data_type_nullable.h"
42
#include "core/data_type/data_type_variant.h"
43
#include "core/data_type/data_type_variant_v2.h"
44
#include "core/field.h"
45
#include "core/string_ref.h"
46
#include "cpp/sync_point.h"
47
#include "exec/common/variant_util.h"
48
#include "exprs/expr_zonemap_filter.h"
49
#include "exprs/vexpr_context.h"
50
#include "io/cache/block_file_cache.h"
51
#include "io/cache/block_file_cache_factory.h"
52
#include "io/cache/cached_remote_file_reader.h"
53
#include "io/fs/file_reader.h"
54
#include "io/fs/file_system.h"
55
#include "io/io_common.h"
56
#include "runtime/exec_env.h"
57
#include "runtime/query_context.h"
58
#include "runtime/runtime_predicate.h"
59
#include "runtime/runtime_state.h"
60
#include "storage/index/index_file_reader.h"
61
#include "storage/index/indexed_column_reader.h"
62
#include "storage/index/primary_key_index.h"
63
#include "storage/index/short_key_index.h"
64
#include "storage/index/zone_map/zonemap_eval_context.h"
65
#include "storage/iterator/vgeneric_iterators.h"
66
#include "storage/iterators.h"
67
#include "storage/key_coder.h"
68
#include "storage/olap_common.h"
69
#include "storage/predicate/block_column_predicate.h"
70
#include "storage/predicate/column_predicate.h"
71
#include "storage/rowset/rowset_reader_context.h"
72
#include "storage/schema.h"
73
#include "storage/segment/column_meta_accessor.h"
74
#include "storage/segment/column_reader.h"
75
#include "storage/segment/column_reader_cache.h"
76
#include "storage/segment/empty_segment_iterator.h"
77
#include "storage/segment/page_io.h"
78
#include "storage/segment/page_pointer.h"
79
#include "storage/segment/segment_iterator.h"
80
#include "storage/segment/segment_writer.h" // k_segment_magic_length
81
#include "storage/segment/stream_reader.h"
82
#include "storage/segment/variant/variant_column_reader.h"
83
#include "storage/tablet/tablet_schema.h"
84
#include "storage/types.h"
85
#include "storage/utils.h"
86
#include "util/coding.h"
87
#include "util/json/path_in_data.h"
88
#include "util/slice.h" // Slice
89
90
namespace doris::segment_v2 {
91
92
class InvertedIndexIterator;
93
94
namespace {
95
96
Status build_segment_zonemap_context(Segment* segment, const Schema& schema,
97
                                     const StorageReadOptions& read_options,
98
17.5k
                                     const VExprContextSPtrs& conjuncts, ZoneMapEvalContext* ctx) {
99
17.5k
    DORIS_CHECK(segment != nullptr);
100
17.5k
    DORIS_CHECK(ctx != nullptr);
101
17.5k
    std::set<int> slot_indexes;
102
19.9k
    for (const auto& conjunct : conjuncts) {
103
19.9k
        DORIS_CHECK(conjunct != nullptr);
104
19.9k
        const auto& root = conjunct->root();
105
19.9k
        DORIS_CHECK(root != nullptr);
106
19.9k
        if (!root->can_evaluate_zonemap_filter()) {
107
18.1k
            continue;
108
18.1k
        }
109
        // Segment zone maps have one min/max/null summary per column for the whole segment, so a
110
        // segment-level context can safely hold every slot referenced by a compound expression.
111
        // Page zone maps are page-aligned per column and still use single-slot filtering in
112
        // SegmentIterator.
113
1.79k
        root->collect_slot_column_ids(slot_indexes);
114
1.79k
    }
115
17.5k
    for (const int slot_index : slot_indexes) {
116
3.04k
        if (slot_index < 0 || cast_set<size_t>(slot_index) >= schema.num_column_ids()) {
117
0
            continue;
118
0
        }
119
3.04k
        const auto column_id = schema.column_id(cast_set<size_t>(slot_index));
120
3.04k
        const auto* tablet_column = schema.column(column_id);
121
3.04k
        DORIS_CHECK(tablet_column != nullptr);
122
3.04k
        if (!segment->can_apply_predicate_safely(
123
3.04k
                    column_id, schema, read_options.target_cast_type_for_variants, read_options)) {
124
8
            continue;
125
8
        }
126
3.03k
        auto data_type = segment->get_data_type_of(*tablet_column, read_options);
127
3.03k
        if (data_type == nullptr) {
128
0
            continue;
129
0
        }
130
3.03k
        ZoneMapEvalContext::SlotZoneMap slot_zone_map;
131
3.03k
        slot_zone_map.data_type = data_type;
132
3.03k
        std::shared_ptr<ColumnReader> reader;
133
3.03k
        Status st = segment->get_column_reader(*tablet_column, &reader, read_options.stats,
134
3.03k
                                               &read_options.io_ctx);
135
3.03k
        if (st.is<ErrorCode::NOT_FOUND>()) {
136
18
            ctx->slots.emplace(slot_index, std::move(slot_zone_map));
137
18
            continue;
138
18
        }
139
3.01k
        RETURN_IF_ERROR(st);
140
3.01k
        if (reader != nullptr && reader->has_zone_map()) {
141
2.79k
            ZoneMap zone_map;
142
2.79k
            RETURN_IF_ERROR(reader->get_segment_zone_map(&zone_map));
143
2.79k
            slot_zone_map.zone_map = std::make_shared<ZoneMap>(std::move(zone_map));
144
2.79k
        }
145
3.01k
        ctx->slots.emplace(slot_index, std::move(slot_zone_map));
146
3.01k
    }
147
17.5k
    return Status::OK();
148
17.5k
}
149
150
535k
void fill_missing_decimal_precision(const TabletColumn& column, ColumnMetaPB* meta) {
151
535k
    auto meta_type = static_cast<FieldType>(meta->type());
152
535k
    if (meta_type != column.type()) {
153
0
        return;
154
0
    }
155
156
535k
    if (field_is_decimal_type(meta_type)) {
157
26.9k
        if ((!meta->has_precision() || meta->precision() <= 0) && column.precision() > 0) {
158
4
            meta->set_precision(column.precision());
159
4
        }
160
26.9k
        if ((!meta->has_frac() || meta->frac() < 0) && column.frac() >= 0) {
161
4
            meta->set_frac(column.frac());
162
4
        }
163
26.9k
    }
164
165
    // Complex column meta may also include storage helper children, such as
166
    // array offsets. Only schema children have matching TabletColumn subtypes.
167
535k
    int child_count =
168
535k
            std::min(meta->children_columns_size(), static_cast<int>(column.get_subtype_count()));
169
590k
    for (int i = 0; i < child_count; ++i) {
170
55.4k
        fill_missing_decimal_precision(column.get_sub_column(i), meta->mutable_children_columns(i));
171
55.4k
    }
172
535k
}
173
174
void fill_missing_decimal_precision_from_schema(const TabletSchemaSPtr& tablet_schema,
175
572k
                                                ColumnMetaPB* meta) {
176
572k
    if (!meta->has_unique_id()) {
177
0
        return;
178
0
    }
179
572k
    int32_t col_idx = tablet_schema->field_index(static_cast<int32_t>(meta->unique_id()));
180
572k
    if (col_idx < 0) {
181
92.3k
        return;
182
92.3k
    }
183
480k
    fill_missing_decimal_precision(tablet_schema->column(col_idx), meta);
184
480k
}
185
186
void fill_footer_missing_decimal_precision(const TabletSchemaSPtr& tablet_schema,
187
77.6k
                                           SegmentFooterPB* footer) {
188
650k
    for (int i = 0; i < footer->columns_size(); ++i) {
189
572k
        fill_missing_decimal_precision_from_schema(tablet_schema, footer->mutable_columns(i));
190
572k
    }
191
77.6k
}
192
193
335k
io::IOContext create_index_io_context(const io::IOContext* source, OlapReaderStatistics* stats) {
194
335k
    io::IOContext io_ctx;
195
335k
    if (source != nullptr) {
196
300k
        io_ctx = *source;
197
300k
    }
198
335k
    io_ctx.is_index_data = true;
199
335k
    io_ctx.is_inverted_index = false;
200
335k
    io_ctx.file_cache_stats = stats ? &stats->file_cache_stats : nullptr;
201
335k
    return io_ctx;
202
335k
}
203
} // namespace
204
205
Status Segment::open(io::FileSystemSPtr fs, const std::string& path, int64_t tablet_id,
206
                     uint32_t segment_id, RowsetId rowset_id, TabletSchemaSPtr tablet_schema,
207
                     const io::FileReaderOptions& reader_options, std::shared_ptr<Segment>* output,
208
                     InvertedIndexFileInfo idx_file_info, OlapReaderStatistics* stats,
209
1.73M
                     const io::IOContext* source_io_ctx) {
210
    // Ensure tablet_id is available in reader_options for CachedRemoteFileReader peer read.
211
1.73M
    io::FileReaderOptions opts_with_tablet = reader_options;
212
1.73M
    opts_with_tablet.tablet_id = tablet_id;
213
214
1.73M
    auto s = _open(fs, path, segment_id, rowset_id, tablet_schema, opts_with_tablet, output,
215
1.73M
                   idx_file_info, stats, source_io_ctx);
216
1.73M
    if (s.ok() && output && *output) {
217
1.73M
        (*output)->_tablet_id = tablet_id;
218
1.73M
    }
219
1.73M
    if (!s.ok()) {
220
5
        if (!config::is_cloud_mode()) {
221
5
            auto res = ExecEnv::get_tablet(tablet_id);
222
5
            TabletSharedPtr tablet =
223
5
                    res.has_value() ? std::dynamic_pointer_cast<Tablet>(res.value()) : nullptr;
224
5
            if (tablet) {
225
0
                tablet->report_error(s);
226
0
            }
227
5
        }
228
5
    }
229
230
1.73M
    return s;
231
1.73M
}
232
233
Status Segment::_open(io::FileSystemSPtr fs, const std::string& path, uint32_t segment_id,
234
                      RowsetId rowset_id, TabletSchemaSPtr tablet_schema,
235
                      const io::FileReaderOptions& reader_options, std::shared_ptr<Segment>* output,
236
                      InvertedIndexFileInfo idx_file_info, OlapReaderStatistics* stats,
237
1.73M
                      const io::IOContext* source_io_ctx) {
238
1.73M
    io::FileReaderSPtr file_reader;
239
1.73M
    auto st = fs->open_file(path, &file_reader, &reader_options);
240
1.73M
    TEST_INJECTION_POINT_CALLBACK("Segment::open:corruption", &st);
241
1.73M
    std::shared_ptr<Segment> segment(
242
1.73M
            new Segment(segment_id, rowset_id, std::move(tablet_schema), idx_file_info));
243
1.73M
    segment->_seg_path = path;
244
1.73M
    if (st) {
245
1.73M
        segment->_fs = fs;
246
1.73M
        segment->_file_reader = std::move(file_reader);
247
1.73M
        st = segment->_open(stats, source_io_ctx);
248
1.73M
    }
249
250
    // Three-tier retry for CORRUPTION errors when file cache is enabled.
251
    // This handles CORRUPTION from both open_file() and _parse_footer() (via _open()).
252
1.73M
    if (st.is<ErrorCode::CORRUPTION>() &&
253
1.73M
        reader_options.cache_type == io::FileCachePolicy::FILE_BLOCK_CACHE) {
254
        // Tier 1: Clear file cache and retry with cache support (re-downloads from remote).
255
2
        LOG(WARNING) << "bad segment file may be read from file cache, try to read remote source "
256
2
                        "file directly, file path: "
257
2
                     << path << " cache_key: " << file_cache_key_str(path);
258
2
        auto file_key = file_cache_key_from_path(path);
259
2
        auto* file_cache = io::FileCacheFactory::instance()->get_by_path(file_key);
260
2
        file_cache->remove_if_cached(file_key);
261
262
2
        st = fs->open_file(path, &file_reader, &reader_options);
263
2
        if (st) {
264
2
            segment->_fs = fs;
265
2
            segment->_file_reader = std::move(file_reader);
266
2
            st = segment->_open(stats, source_io_ctx);
267
2
        }
268
2
        TEST_INJECTION_POINT_CALLBACK("Segment::open:corruption1", &st);
269
2
        if (st.is<ErrorCode::CORRUPTION>()) { // corrupt again
270
            // Tier 2: Bypass cache entirely and read directly from remote storage.
271
0
            LOG(WARNING) << "failed to try to read remote source file again with cache support,"
272
0
                         << " try to read from remote directly, "
273
0
                         << " file path: " << path << " cache_key: " << file_cache_key_str(path);
274
0
            file_cache = io::FileCacheFactory::instance()->get_by_path(file_key);
275
0
            file_cache->remove_if_cached(file_key);
276
277
0
            io::FileReaderOptions opt = reader_options;
278
0
            opt.cache_type = io::FileCachePolicy::NO_CACHE; // skip cache
279
0
            RETURN_IF_ERROR(fs->open_file(path, &file_reader, &opt));
280
0
            segment->_fs = fs;
281
0
            segment->_file_reader = std::move(file_reader);
282
0
            st = segment->_open(stats, source_io_ctx);
283
0
            if (!st.ok()) {
284
                // Tier 3: Remote source itself is corrupt.
285
0
                LOG(WARNING) << "failed to try to read remote source file directly,"
286
0
                             << " file path: " << path
287
0
                             << " cache_key: " << file_cache_key_str(path);
288
0
            }
289
0
        }
290
2
    }
291
1.73M
    RETURN_IF_ERROR(st);
292
18.4E
    DCHECK(segment->_fs != nullptr) << "file system is nullptr after segment open";
293
1.73M
    *output = std::move(segment);
294
1.73M
    return Status::OK();
295
1.73M
}
296
297
Segment::Segment(uint32_t segment_id, RowsetId rowset_id, TabletSchemaSPtr tablet_schema,
298
                 InvertedIndexFileInfo idx_file_info)
299
1.73M
        : _segment_id(segment_id),
300
1.73M
          _meta_mem_usage(0),
301
1.73M
          _rowset_id(rowset_id),
302
1.73M
          _tablet_schema(std::move(tablet_schema)),
303
1.73M
          _idx_file_info(std::move(idx_file_info)) {}
304
305
1.73M
Segment::~Segment() {
306
1.73M
    g_segment_estimate_mem_bytes << -_tracked_meta_mem_usage;
307
    // if failed, fix `_tracked_meta_mem_usage` accuracy
308
1.73M
    DCHECK(_tracked_meta_mem_usage == meta_mem_usage());
309
1.73M
}
310
311
51.0k
io::UInt128Wrapper Segment::file_cache_key(std::string_view rowset_id, uint32_t seg_id) {
312
51.0k
    return io::BlockFileCache::hash(fmt::format("{}_{}.dat", rowset_id, seg_id));
313
51.0k
}
314
315
1.72M
int64_t Segment::get_metadata_size() const {
316
1.72M
    std::shared_ptr<SegmentFooterPB> footer_pb_shared = _footer_pb.lock();
317
1.72M
    return sizeof(Segment) + (_pk_index_meta ? _pk_index_meta->ByteSizeLong() : 0) +
318
18.4E
           (footer_pb_shared ? footer_pb_shared->ByteSizeLong() : 0);
319
1.72M
}
320
321
1.72M
void Segment::update_metadata_size() {
322
1.72M
    MetadataAdder::update_metadata_size();
323
1.72M
    g_segment_estimate_mem_bytes << _meta_mem_usage - _tracked_meta_mem_usage;
324
1.72M
    _tracked_meta_mem_usage = _meta_mem_usage;
325
1.72M
}
326
327
1.73M
Status Segment::_open(OlapReaderStatistics* stats, const io::IOContext* source_io_ctx) {
328
1.73M
    std::shared_ptr<SegmentFooterPB> footer_pb_shared;
329
1.73M
    RETURN_IF_ERROR(_get_segment_footer(footer_pb_shared, stats, source_io_ctx));
330
331
1.73M
    _pk_index_meta.reset(
332
1.73M
            footer_pb_shared->has_primary_key_index_meta()
333
1.73M
                    ? new PrimaryKeyIndexMetaPB(footer_pb_shared->primary_key_index_meta())
334
1.73M
                    : nullptr);
335
    // delete_bitmap_calculator_test.cpp
336
    // DCHECK(footer.has_short_key_index_page());
337
1.73M
    _sk_index_page = footer_pb_shared->short_key_index_page();
338
1.73M
    _num_rows = footer_pb_shared->num_rows();
339
340
    // An estimated memory usage of a segment
341
    // Footer is seperated to StoragePageCache so we don't need to add it to _meta_mem_usage
342
    // _meta_mem_usage += footer_pb_shared->ByteSizeLong();
343
1.73M
    if (_pk_index_meta != nullptr) {
344
1.41M
        _meta_mem_usage += _pk_index_meta->ByteSizeLong();
345
1.41M
    }
346
347
1.73M
    _meta_mem_usage += sizeof(*this);
348
1.73M
    _meta_mem_usage += std::min(static_cast<int>(_tablet_schema->num_columns()),
349
1.73M
                                config::max_segment_partial_column_cache_size) *
350
1.73M
                       config::estimated_mem_per_column_reader;
351
352
    // 1024 comes from SegmentWriterOptions
353
1.73M
    _meta_mem_usage += (_num_rows + 1023) / 1024 * (36 + 4);
354
    // 0.01 comes from PrimaryKeyIndexBuilder::init
355
1.73M
    _meta_mem_usage += BloomFilter::optimal_bit_num(_num_rows, 0.01) / 8;
356
357
1.73M
    update_metadata_size();
358
359
1.73M
    return Status::OK();
360
1.73M
}
361
362
21.6k
Status Segment::_open_index_file_reader() {
363
    // Derive the index path from `_seg_path`, not `_file_reader->path()`: remote FS normalizes the
364
    // latter to an absolute path that won't match the relative keys in PackedFileSystem's index map.
365
21.6k
    _index_file_reader = std::make_shared<IndexFileReader>(
366
21.6k
            _fs, std::string {InvertedIndexDescriptor::get_index_file_path_prefix(_seg_path)},
367
21.6k
            _tablet_schema->get_inverted_index_storage_format(), _idx_file_info, _tablet_id);
368
21.6k
    return Status::OK();
369
21.6k
}
370
371
bool Segment::is_tso_placeholder_col(int cid, const Schema& schema,
372
1.34M
                                     const StorageReadOptions& read_options) const {
373
1.34M
    if (read_options.version.first != read_options.version.second) {
374
746k
        return false;
375
746k
    }
376
595k
    if (!read_options.read_row_binlog) {
377
595k
        return false;
378
595k
    }
379
    // tso_col_idx() is -1 for non-binlog schemas, so this returns false there.
380
18.4E
    return cid == schema.tso_col_idx();
381
594k
}
382
383
Status Segment::new_iterator(SchemaSPtr schema, const StorageReadOptions& read_options,
384
1.50M
                             std::unique_ptr<RowwiseIterator>* iter) {
385
1.50M
    if (read_options.runtime_state != nullptr) {
386
1.42M
        _be_exec_version = read_options.runtime_state->be_exec_version();
387
1.42M
    }
388
1.50M
    RETURN_IF_ERROR(_create_column_meta_once(read_options.stats, &read_options.io_ctx));
389
390
1.50M
    read_options.stats->total_segment_number++;
391
    // trying to prune the current segment by segment-level zone map
392
1.50M
    for (const auto& entry : read_options.col_id_to_predicates) {
393
1.26M
        int32_t column_id = entry.first;
394
        // schema change
395
1.26M
        if (_tablet_schema->num_columns() <= column_id) {
396
1.17k
            continue;
397
1.17k
        }
398
1.26M
        const TabletColumn& col = read_options.tablet_schema->column(column_id);
399
1.26M
        std::shared_ptr<ColumnReader> reader;
400
        // __DORIS_COMMIT_TSO_COL__ on a single-version segment stores a 0 placeholder on disk
401
        // (replaced with the rowset's real commit_tso at read time). Its on-disk zonemap [0,0]
402
        // must not drive segment-level pruning, so build a ConstantColumnReader carrying the real
403
        // commit_tso to prune against the real value instead.
404
1.26M
        std::optional<Field> const_value;
405
1.26M
        if (read_options.version.first == read_options.version.second &&
406
1.26M
            column_id == schema->commit_tso_col_idx() && read_options.commit_tso.end_tso() != -1) {
407
1
            const_value = Field::create_field<TYPE_BIGINT>(read_options.commit_tso.end_tso());
408
1
        }
409
1.26M
        Status st = get_column_reader(col, &reader, read_options.stats, &read_options.io_ctx,
410
1.26M
                                      std::move(const_value));
411
        // not found in this segment, skip
412
1.26M
        if (st.is<ErrorCode::NOT_FOUND>()) {
413
19
            continue;
414
19
        }
415
1.26M
        RETURN_IF_ERROR(st);
416
        // should be OK
417
1.26M
        DCHECK(reader != nullptr);
418
1.26M
        if (!reader->has_zone_map()) {
419
22
            continue;
420
22
        }
421
        // Placeholder tso column on a single-version binlog segment: its zonemap reflects the
422
        // NULL placeholder (replaced with commit_tso at read time), so skip pruning by
423
        // zonemap (min == max == commit_tso) and reuse the predicate's own zonemap matching:
424
        // evaluate_and() returns false iff no value in [min, max] can satisfy the predicates,
425
        // i.e. commit_tso fails them and the whole segment can be pruned. Predicates that don't
426
        // support zonemap return true (conservative: not pruned, row-level eval handles them).
427
1.26M
        if (read_options.col_id_to_predicates.contains(column_id) &&
428
1.26M
            is_tso_placeholder_col(column_id, *schema, read_options)) {
429
0
            const Int64 commit_tso =
430
0
                    read_options.commit_tso.end_tso() == -1 ? 0 : read_options.commit_tso.end_tso();
431
0
            ZoneMap zone_map;
432
0
            zone_map.min_value = Field::create_field<TYPE_BIGINT>(commit_tso);
433
0
            zone_map.max_value = Field::create_field<TYPE_BIGINT>(commit_tso);
434
0
            zone_map.has_not_null = true;
435
0
            if (!entry.second->evaluate_and(zone_map)) {
436
                // any condition not satisfied, return.
437
0
                *iter = std::make_unique<EmptySegmentIterator>(*schema);
438
0
                read_options.stats->filtered_segment_number++;
439
0
                return Status::OK();
440
0
            }
441
0
            continue;
442
0
        }
443
1.26M
        if (read_options.col_id_to_predicates.contains(column_id) &&
444
1.26M
            can_apply_predicate_safely(column_id, *schema,
445
1.25M
                                       read_options.target_cast_type_for_variants, read_options)) {
446
1.25M
            bool matched = true;
447
1.25M
            RETURN_IF_ERROR(reader->match_condition(entry.second.get(), &matched));
448
1.25M
            if (!matched) {
449
                // any condition not satisfied, return.
450
94.1k
                *iter = std::make_unique<EmptySegmentIterator>(*schema);
451
94.1k
                read_options.stats->filtered_segment_number++;
452
94.1k
                read_options.stats->rows_stats_filtered += num_rows();
453
94.1k
                return Status::OK();
454
94.1k
            }
455
1.25M
        }
456
1.26M
    }
457
458
    // Segment-level expr-zonemap runs before SegmentIterator can rebind storage expressions to
459
    // the reader schema. Only apply it when scan tuple slot ordinals already match this schema.
460
1.41M
    if (expr_zonemap::is_expr_zonemap_filter_enabled(read_options.runtime_state) &&
461
1.41M
        !read_options.common_expr_ctxs_push_down.empty()) {
462
17.6k
        ZoneMapEvalContext ctx;
463
17.6k
        RETURN_IF_ERROR(build_segment_zonemap_context(
464
17.6k
                this, *schema, read_options, read_options.common_expr_ctxs_push_down, &ctx));
465
17.6k
        const auto result =
466
17.6k
                VExprContext::evaluate_zonemap_filter(read_options.common_expr_ctxs_push_down, ctx);
467
17.6k
        ctx.stats.accumulate_to(read_options.stats);
468
17.6k
        if (result == ZoneMapFilterResult::kNoMatch) {
469
359
            *iter = std::make_unique<EmptySegmentIterator>(*schema);
470
359
            read_options.stats->filtered_segment_number++;
471
359
            read_options.stats->expr_zonemap_filtered_segments++;
472
359
            return Status::OK();
473
359
        }
474
17.6k
    }
475
476
1.41M
    {
477
1.41M
        SCOPED_RAW_TIMER(&read_options.stats->segment_load_index_timer_ns);
478
1.41M
        RETURN_IF_ERROR(load_index(read_options.stats, &read_options.io_ctx));
479
1.41M
    }
480
481
1.41M
    if (read_options.delete_condition_predicates->num_of_column_predicate() == 0 &&
482
1.41M
        read_options.push_down_agg_type_opt != TPushAggOp::NONE &&
483
1.41M
        read_options.push_down_agg_type_opt != TPushAggOp::COUNT_ON_INDEX) {
484
10.6k
        iter->reset(new_vstatistics_iterator(this->shared_from_this(), *schema));
485
1.40M
    } else {
486
1.40M
        *iter = std::make_unique<SegmentIterator>(this->shared_from_this(), schema);
487
1.40M
    }
488
489
    // TODO: Valid the opt not only in ReaderType::READER_QUERY
490
1.41M
    if (read_options.io_ctx.reader_type == ReaderType::READER_QUERY &&
491
1.41M
        !read_options.column_predicates.empty()) {
492
1.12M
        auto pruned_predicates = read_options.column_predicates;
493
1.12M
        auto pruned = false;
494
1.21M
        for (auto& it : _column_reader_cache->get_available_readers(false)) {
495
1.21M
            const auto uid = it.first;
496
1.21M
            const auto column_id = read_options.tablet_schema->field_index(uid);
497
1.21M
            bool tmp_pruned = false;
498
1.21M
            RETURN_IF_ERROR(it.second->prune_predicates_by_zone_map(pruned_predicates, column_id,
499
1.21M
                                                                    &tmp_pruned));
500
1.21M
            pruned |= tmp_pruned;
501
1.21M
        }
502
503
1.12M
        if (pruned) {
504
7.80k
            auto options_with_pruned_predicates = read_options;
505
7.80k
            options_with_pruned_predicates.column_predicates = pruned_predicates;
506
            //because column_predicates is changed, we need to rebuild col_id_to_predicates so that inverted index will not go through it.
507
7.80k
            options_with_pruned_predicates.col_id_to_predicates.clear();
508
12.1k
            for (auto pred : options_with_pruned_predicates.column_predicates) {
509
12.1k
                if (!options_with_pruned_predicates.col_id_to_predicates.contains(
510
12.1k
                            pred->column_id())) {
511
8.76k
                    options_with_pruned_predicates.col_id_to_predicates.insert(
512
8.76k
                            {pred->column_id(), AndBlockColumnPredicate::create_shared()});
513
8.76k
                }
514
12.1k
                options_with_pruned_predicates.col_id_to_predicates[pred->column_id()]
515
12.1k
                        ->add_column_predicate(SingleColumnBlockPredicate::create_unique(pred));
516
12.1k
            }
517
26.1k
            for (const auto& pred : read_options.column_predicates) {
518
26.1k
                const auto pred_cid = pred->column_id();
519
                // Key columns may still be required by key range seeks even if the segment zone
520
                // map proves their predicates always true. Only mark non-key columns as safe for
521
                // the no-need-read path.
522
26.1k
                if (!read_options.tablet_schema->column(pred_cid).is_key() &&
523
26.1k
                    !options_with_pruned_predicates.col_id_to_predicates.contains(pred_cid)) {
524
5.91k
                    options_with_pruned_predicates.zonemap_always_true_pred_cols.insert(pred_cid);
525
5.91k
                }
526
26.1k
            }
527
7.80k
            return iter->get()->init(options_with_pruned_predicates);
528
7.80k
        }
529
1.12M
    }
530
1.40M
    return iter->get()->init(read_options);
531
1.41M
}
532
533
Status Segment::_write_error_file(size_t file_size, size_t offset, size_t bytes_read, char* data,
534
1
                                  io::IOContext& io_ctx) {
535
1
    if (!config::enbale_dump_error_file || !doris::config::is_cloud_mode()) {
536
1
        return Status::OK();
537
1
    }
538
539
0
    std::string file_name = _rowset_id.to_string() + "_" + std::to_string(_segment_id) + ".dat";
540
0
    std::string dir_path = io::FileCacheFactory::instance()->get_base_paths()[0] + "/error_file/";
541
0
    Status create_st = io::global_local_filesystem()->create_directory(dir_path, true);
542
0
    if (!create_st.ok() && !create_st.is<ErrorCode::ALREADY_EXIST>()) {
543
0
        LOG(WARNING) << "failed to create error file dir: " << create_st.to_string();
544
0
        return create_st;
545
0
    }
546
0
    size_t dir_size = 0;
547
0
    RETURN_IF_ERROR(io::global_local_filesystem()->directory_size(dir_path, &dir_size));
548
0
    if (dir_size > config::file_cache_error_log_limit_bytes) {
549
0
        LOG(WARNING) << "error file dir size is too large: " << dir_size;
550
0
        return Status::OK();
551
0
    }
552
553
0
    std::string error_part;
554
0
    error_part.resize(bytes_read);
555
0
    std::string part_path = dir_path + file_name + ".part_offset_" + std::to_string(offset);
556
0
    LOG(WARNING) << "writer error part to " << part_path;
557
0
    bool is_part_exist = false;
558
0
    RETURN_IF_ERROR(io::global_local_filesystem()->exists(part_path, &is_part_exist));
559
0
    if (is_part_exist) {
560
0
        LOG(WARNING) << "error part already exists: " << part_path;
561
0
    } else {
562
0
        std::unique_ptr<io::FileWriter> part_writer;
563
0
        RETURN_IF_ERROR(io::global_local_filesystem()->create_file(part_path, &part_writer));
564
0
        RETURN_IF_ERROR(part_writer->append(Slice(data, bytes_read)));
565
0
        RETURN_IF_ERROR(part_writer->close());
566
0
    }
567
568
0
    std::string error_file;
569
0
    error_file.resize(file_size);
570
0
    auto* cached_reader = dynamic_cast<io::CachedRemoteFileReader*>(_file_reader.get());
571
0
    if (cached_reader == nullptr) {
572
0
        return Status::InternalError("file reader is not CachedRemoteFileReader");
573
0
    }
574
0
    size_t error_file_bytes_read = 0;
575
0
    RETURN_IF_ERROR(cached_reader->get_remote_reader()->read_at(
576
0
            0, Slice(error_file.data(), file_size), &error_file_bytes_read, &io_ctx));
577
0
    DCHECK(error_file_bytes_read == file_size);
578
    //std::string file_path = dir_path + std::to_string(cur_time) + "_" + ss.str();
579
0
    std::string file_path = dir_path + file_name;
580
0
    LOG(WARNING) << "writer error file to " << file_path;
581
0
    bool is_file_exist = false;
582
0
    RETURN_IF_ERROR(io::global_local_filesystem()->exists(file_path, &is_file_exist));
583
0
    if (is_file_exist) {
584
0
        LOG(WARNING) << "error file already exists: " << part_path;
585
0
    } else {
586
0
        std::unique_ptr<io::FileWriter> writer;
587
0
        RETURN_IF_ERROR(io::global_local_filesystem()->create_file(file_path, &writer));
588
0
        RETURN_IF_ERROR(writer->append(Slice(error_file.data(), file_size)));
589
0
        RETURN_IF_ERROR(writer->close());
590
0
    }
591
0
    return Status::OK(); // already exists
592
0
};
593
594
Status Segment::_parse_footer(std::shared_ptr<SegmentFooterPB>& footer, OlapReaderStatistics* stats,
595
77.5k
                              const io::IOContext* source_io_ctx) {
596
    // Footer := SegmentFooterPB, FooterPBSize(4), FooterPBChecksum(4), MagicNumber(4)
597
77.5k
    auto file_size = _file_reader->size();
598
77.5k
    if (file_size < 12) {
599
0
        return Status::Corruption("Bad segment file {}: file size {} < 12, cache_key: {}",
600
0
                                  _file_reader->path().native(), file_size,
601
0
                                  file_cache_key_str(_file_reader->path().native()));
602
0
    }
603
604
77.5k
    uint8_t fixed_buf[12];
605
77.5k
    size_t bytes_read = 0;
606
77.5k
    auto io_ctx = create_index_io_context(source_io_ctx, stats);
607
77.5k
    TEST_SYNC_POINT_CALLBACK("Segment::_parse_footer::io_ctx", &io_ctx);
608
77.5k
    RETURN_IF_ERROR(
609
77.5k
            _file_reader->read_at(file_size - 12, Slice(fixed_buf, 12), &bytes_read, &io_ctx));
610
77.5k
    DCHECK_EQ(bytes_read, 12);
611
77.5k
    TEST_SYNC_POINT_CALLBACK("Segment::parse_footer:magic_number_corruption", fixed_buf);
612
77.5k
    TEST_INJECTION_POINT_CALLBACK("Segment::parse_footer:magic_number_corruption_inj", fixed_buf);
613
77.5k
    if (memcmp(fixed_buf + 8, k_segment_magic, k_segment_magic_length) != 0) {
614
1
        Status st =
615
1
                _write_error_file(file_size, file_size - 12, bytes_read, (char*)fixed_buf, io_ctx);
616
1
        if (!st.ok()) {
617
0
            LOG(WARNING) << "failed to write error file: " << st.to_string();
618
0
        }
619
1
        return Status::Corruption(
620
1
                "Bad segment file {}: file_size: {}, magic number not match, cache_key: {}",
621
1
                _file_reader->path().native(), file_size,
622
1
                file_cache_key_str(_file_reader->path().native()));
623
1
    }
624
625
    // read footer PB
626
77.5k
    uint32_t footer_length = decode_fixed32_le(fixed_buf);
627
77.5k
    if (file_size < 12 + footer_length) {
628
0
        Status st =
629
0
                _write_error_file(file_size, file_size - 12, bytes_read, (char*)fixed_buf, io_ctx);
630
0
        if (!st.ok()) {
631
0
            LOG(WARNING) << "failed to write error file: " << st.to_string();
632
0
        }
633
0
        return Status::Corruption("Bad segment file {}: file size {} < {}, cache_key: {}",
634
0
                                  _file_reader->path().native(), file_size, 12 + footer_length,
635
0
                                  file_cache_key_str(_file_reader->path().native()));
636
0
    }
637
638
77.5k
    std::string footer_buf;
639
77.5k
    footer_buf.resize(footer_length);
640
77.5k
    RETURN_IF_ERROR(_file_reader->read_at(file_size - 12 - footer_length, footer_buf, &bytes_read,
641
77.5k
                                          &io_ctx));
642
77.5k
    DCHECK_EQ(bytes_read, footer_length);
643
644
    // validate footer PB's checksum
645
77.5k
    uint32_t expect_checksum = decode_fixed32_le(fixed_buf + 4);
646
77.5k
    uint32_t actual_checksum = crc32c::Crc32c(footer_buf.data(), footer_buf.size());
647
77.5k
    if (actual_checksum != expect_checksum) {
648
0
        Status st = _write_error_file(file_size, file_size - 12 - footer_length, bytes_read,
649
0
                                      footer_buf.data(), io_ctx);
650
0
        if (!st.ok()) {
651
0
            LOG(WARNING) << "failed to write error file: " << st.to_string();
652
0
        }
653
0
        return Status::Corruption(
654
0
                "Bad segment file {}: file_size = {}, footer checksum not match, actual={} "
655
0
                "vs expect={}, cache_key: {}",
656
0
                _file_reader->path().native(), file_size, actual_checksum, expect_checksum,
657
0
                file_cache_key_str(_file_reader->path().native()));
658
0
    }
659
660
    // deserialize footer PB
661
77.5k
    footer = std::make_shared<SegmentFooterPB>();
662
77.5k
    if (!footer->ParseFromString(footer_buf)) {
663
0
        Status st = _write_error_file(file_size, file_size - 12 - footer_length, bytes_read,
664
0
                                      footer_buf.data(), io_ctx);
665
0
        if (!st.ok()) {
666
0
            LOG(WARNING) << "failed to write error file: " << st.to_string();
667
0
        }
668
0
        return Status::Corruption(
669
0
                "Bad segment file {}: file_size = {}, failed to parse SegmentFooterPB, "
670
0
                "cache_key: ",
671
0
                _file_reader->path().native(), file_size,
672
0
                file_cache_key_str(_file_reader->path().native()));
673
0
    }
674
    // Segments written before #26572 do not persist decimal precision/frac in
675
    // ColumnMetaPB, so recover the logical p/s from TabletSchema before
676
    // ColumnReader builds DataTypeDecimal.
677
77.5k
    fill_footer_missing_decimal_precision(_tablet_schema, footer.get());
678
679
18.4E
    VLOG_DEBUG << fmt::format("Loading segment footer from {} finished",
680
18.4E
                              _file_reader->path().native());
681
77.5k
    return Status::OK();
682
77.5k
}
683
684
Status Segment::_load_pk_bloom_filter(OlapReaderStatistics* stats,
685
4.17M
                                      const io::IOContext* source_io_ctx) {
686
#ifdef BE_TEST
687
    if (_pk_index_meta == nullptr) {
688
        // for BE UT "segment_cache_test"
689
        return _load_pk_bf_once.call([this] {
690
            _meta_mem_usage += 100;
691
            update_metadata_size();
692
            return Status::OK();
693
        });
694
    }
695
#endif
696
4.17M
    DCHECK(_tablet_schema->keys_type() == UNIQUE_KEYS);
697
4.17M
    DCHECK(_pk_index_meta != nullptr);
698
4.17M
    DCHECK(_pk_index_reader != nullptr);
699
700
4.17M
    return _load_pk_bf_once.call([this, stats, source_io_ctx] {
701
106k
        RETURN_IF_ERROR(
702
106k
                _pk_index_reader->parse_bf(_file_reader, *_pk_index_meta, stats, source_io_ctx));
703
        // _meta_mem_usage += _pk_index_reader->get_bf_memory_size();
704
106k
        return Status::OK();
705
106k
    });
706
4.17M
}
707
708
Status Segment::load_pk_index_and_bf(OlapReaderStatistics* index_load_stats,
709
4.18M
                                     const io::IOContext* source_io_ctx) {
710
    // `DorisCallOnce` may catch exception in calling stack A and re-throw it in
711
    // a different calling stack B which doesn't have catch block. So we add catch block here
712
    // to prevent coreudmp
713
4.18M
    RETURN_IF_CATCH_EXCEPTION({
714
4.18M
        RETURN_IF_ERROR(load_index(index_load_stats, source_io_ctx));
715
4.18M
        RETURN_IF_ERROR(_load_pk_bloom_filter(index_load_stats, source_io_ctx));
716
4.18M
    });
717
4.18M
    return Status::OK();
718
4.18M
}
719
720
5.58M
Status Segment::load_index(OlapReaderStatistics* stats, const io::IOContext* source_io_ctx) {
721
5.58M
    return _load_index_once.call([this, stats, source_io_ctx] {
722
1.50M
        if (_tablet_schema->keys_type() == UNIQUE_KEYS && _pk_index_meta != nullptr) {
723
1.24M
            _pk_index_reader = std::make_unique<PrimaryKeyIndexReader>();
724
1.24M
            RETURN_IF_ERROR(_pk_index_reader->parse_index(_file_reader, *_pk_index_meta, stats,
725
1.24M
                                                          source_io_ctx));
726
            // _meta_mem_usage += _pk_index_reader->get_memory_size();
727
1.24M
            return Status::OK();
728
1.24M
        } else {
729
            // read and parse short key index page
730
260k
            OlapReaderStatistics tmp_stats;
731
260k
            OlapReaderStatistics* stats_ptr = stats != nullptr ? stats : &tmp_stats;
732
260k
            auto page_io_ctx = create_index_io_context(source_io_ctx, stats_ptr);
733
260k
            PageReadOptions opts(page_io_ctx);
734
260k
            opts.use_page_cache = true;
735
260k
            opts.type = INDEX_PAGE;
736
260k
            opts.file_reader = _file_reader.get();
737
260k
            opts.page_pointer = PagePointer(_sk_index_page);
738
            // short key index page uses NO_COMPRESSION for now
739
260k
            opts.codec = nullptr;
740
260k
            opts.stats = &tmp_stats;
741
742
260k
            Slice body;
743
260k
            PageFooterPB footer;
744
260k
            RETURN_IF_ERROR(
745
260k
                    PageIO::read_and_decompress_page(opts, &_sk_index_handle, &body, &footer));
746
260k
            DCHECK_EQ(footer.type(), SHORT_KEY_PAGE);
747
260k
            DCHECK(footer.has_short_key_page_footer());
748
749
            // _meta_mem_usage += body.get_size();
750
260k
            _sk_index_decoder = std::make_unique<ShortKeyIndexDecoder>();
751
260k
            return _sk_index_decoder->parse(body, footer.short_key_page_footer());
752
260k
        }
753
1.50M
    });
754
5.58M
}
755
756
11.5k
Status Segment::healthy_status() {
757
11.5k
    try {
758
11.5k
        if (_load_index_once.has_called()) {
759
10.8k
            RETURN_IF_ERROR(_load_index_once.stored_result());
760
10.8k
        }
761
11.5k
        if (_load_pk_bf_once.has_called()) {
762
3.00k
            RETURN_IF_ERROR(_load_pk_bf_once.stored_result());
763
3.00k
        }
764
11.5k
        if (_create_column_meta_once_call.has_called()) {
765
11.2k
            RETURN_IF_ERROR(_create_column_meta_once_call.stored_result());
766
11.2k
        }
767
11.5k
        if (_index_file_reader_open.has_called()) {
768
3.38k
            RETURN_IF_ERROR(_index_file_reader_open.stored_result());
769
3.38k
        }
770
        // This status is set by running time, for example, if there is something wrong during read segment iterator.
771
11.5k
        return _healthy_status.status();
772
11.5k
    } catch (const doris::Exception& e) {
773
        // If there is an exception during load_xxx, should not throw exception directly because
774
        // the caller may not exception safe.
775
0
        return e.to_status();
776
0
    } catch (const std::exception& e) {
777
        // The exception is not thrown by doris code.
778
0
        return Status::InternalError("Unexcepted error during load segment: {}", e.what());
779
0
    }
780
11.5k
}
781
782
// Return the storage datatype of related column to field.
783
DataTypePtr Segment::get_data_type_of(const TabletColumn& column,
784
20.8M
                                      const StorageReadOptions& read_options) {
785
20.8M
    const PathInDataPtr path = column.path_info_ptr();
786
787
    // none variant column
788
20.9M
    if (path == nullptr || path->empty()) {
789
20.9M
        return DataTypeFactory::instance().create_data_type(column);
790
20.9M
    }
791
792
    // Path exists, proceed with variant logic.
793
18.4E
    PathInData relative_path = path->copy_pop_front();
794
18.4E
    int32_t unique_id = column.unique_id() >= 0 ? column.unique_id() : column.parent_unique_id();
795
796
    // If this uid does not exist in segment meta, fallback to schema type.
797
18.4E
    if (!_column_meta_accessor->has_column_uid(unique_id)) {
798
319
        return DataTypeFactory::instance().create_data_type(column);
799
319
    }
800
801
18.4E
    std::shared_ptr<ColumnReader> v_reader;
802
18.4E
    OlapReaderStatistics tmp_stats;
803
18.4E
    auto* stats = read_options.stats == nullptr ? &tmp_stats : read_options.stats;
804
805
    // Get the parent variant column reader
806
    // If status is not ok, it will throw exception(data corruption)
807
18.4E
    THROW_IF_ERROR(get_column_reader(unique_id, &v_reader, stats, &read_options.io_ctx));
808
18.4E
    DCHECK(v_reader != nullptr);
809
18.4E
    auto* variant_reader = static_cast<VariantColumnReader*>(v_reader.get());
810
    // Delegate type inference for variant paths to VariantColumnReader.
811
18.4E
    DataTypePtr type;
812
18.4E
    THROW_IF_ERROR(variant_reader->infer_data_type_for_path(&type, column, read_options,
813
18.4E
                                                            _column_reader_cache.get()));
814
18.4E
    return type;
815
18.4E
}
816
817
Status Segment::_create_column_meta_once(OlapReaderStatistics* stats,
818
39.2M
                                         const io::IOContext* source_io_ctx) {
819
39.2M
    SCOPED_RAW_TIMER(&stats->segment_create_column_readers_timer_ns);
820
39.2M
    return _create_column_meta_once_call.call([this, stats, source_io_ctx] {
821
1.55M
        std::shared_ptr<SegmentFooterPB> footer_pb_shared;
822
1.55M
        RETURN_IF_ERROR(_get_segment_footer(footer_pb_shared, stats, source_io_ctx));
823
1.55M
        return _create_column_meta(*footer_pb_shared, stats, source_io_ctx);
824
1.55M
    });
825
39.2M
}
826
827
Status Segment::_create_column_meta(const SegmentFooterPB& footer, OlapReaderStatistics* stats,
828
1.54M
                                    const io::IOContext* source_io_ctx) {
829
    // Initialize column meta accessor which internally maintains uid -> column_ordinal mapping.
830
1.54M
    _column_meta_accessor = std::make_unique<ColumnMetaAccessor>();
831
1.54M
    RETURN_IF_ERROR(_column_meta_accessor->init(footer, _file_reader));
832
833
1.54M
    if (config::enable_adaptive_batch_size) {
834
        // Cache raw_data_bytes per column uid for adaptive batch size prediction.
835
        // This runs under call_once, so no thread-safety concerns.
836
1.54M
        auto st = _column_meta_accessor->traverse_metas(
837
1.54M
                footer,
838
25.7M
                [this](const ColumnMetaPB& meta) {
839
25.7M
                    if (meta.has_unique_id() && meta.unique_id() != -1 &&
840
25.7M
                        meta.has_raw_data_bytes()) {
841
25.0M
                        _column_uid_to_raw_bytes[meta.unique_id()] = meta.raw_data_bytes();
842
25.0M
                    }
843
25.7M
                },
844
1.54M
                stats, source_io_ctx);
845
846
1.54M
        if (!st.ok()) {
847
0
            LOG(WARNING) << "Failed to traverse column metas to cache raw_data_bytes, error: "
848
0
                         << st.to_string();
849
0
        }
850
1.54M
    }
851
852
1.54M
    _column_reader_cache = std::make_unique<ColumnReaderCache>(
853
1.54M
            _column_meta_accessor.get(), _tablet_schema, _file_reader, _num_rows,
854
1.54M
            [this](std::shared_ptr<SegmentFooterPB>& footer_pb, OlapReaderStatistics* stats,
855
19.4M
                   const io::IOContext* io_ctx) {
856
19.4M
                return _get_segment_footer(footer_pb, stats, io_ctx);
857
19.4M
            });
858
1.54M
    return Status::OK();
859
1.54M
}
860
861
Status Segment::new_default_iterator(const TabletColumn& tablet_column,
862
9.21k
                                     std::unique_ptr<ColumnIterator>* iter) {
863
9.21k
    if (!tablet_column.has_default_value() && !tablet_column.is_nullable()) {
864
0
        return Status::InternalError(
865
0
                "invalid nonexistent column without default value. column_uid={}, "
866
0
                "column_name={}, "
867
0
                "column_type={}",
868
0
                tablet_column.unique_id(), tablet_column.name(), tablet_column.type());
869
0
    }
870
9.21k
    std::unique_ptr<DefaultValueColumnIterator> default_value_iter(new DefaultValueColumnIterator(
871
9.21k
            tablet_column.has_default_value(), tablet_column.default_value(),
872
9.21k
            tablet_column.is_nullable(), tablet_column.type(), tablet_column.precision(),
873
9.21k
            tablet_column.frac(), tablet_column.length()));
874
9.21k
    ColumnIteratorOptions iter_opts;
875
876
9.21k
    RETURN_IF_ERROR(default_value_iter->init(iter_opts));
877
9.21k
    *iter = std::move(default_value_iter);
878
9.21k
    return Status::OK();
879
9.21k
}
880
881
// Not use cid anymore, for example original table schema is colA int, then user do following actions
882
// 1.add column b
883
// 2. drop column b
884
// 3. add column c
885
// in the new schema column c's cid == 2
886
// but in the old schema column b's cid == 2
887
// but they are not the same column
888
Status Segment::new_column_iterator(const TabletColumn& tablet_column,
889
                                    std::unique_ptr<ColumnIterator>* iter,
890
                                    const StorageReadOptions* opt,
891
                                    const std::unordered_map<int32_t, PathToBinaryColumnCacheUPtr>*
892
18.2M
                                            variant_sparse_column_cache) {
893
18.2M
    if (opt->runtime_state != nullptr) {
894
17.8M
        _be_exec_version = opt->runtime_state->be_exec_version();
895
17.8M
    }
896
18.2M
    RETURN_IF_ERROR(_create_column_meta_once(opt->stats, &opt->io_ctx));
897
898
    // For compability reason unique_id may less than 0 for variant extracted column
899
18.2M
    int32_t unique_id = tablet_column.unique_id() >= 0 ? tablet_column.unique_id()
900
18.4E
                                                       : tablet_column.parent_unique_id();
901
902
    // If column meta for this uid is not found in this segment, use default iterator.
903
18.2M
    if (!_column_meta_accessor->has_column_uid(unique_id)) {
904
3.10k
        RETURN_IF_ERROR(new_default_iterator(tablet_column, iter));
905
3.10k
        return Status::OK();
906
3.10k
    }
907
908
    // __DORIS_COMMIT_TSO_COL__ on a single-version segment stores a 0 placeholder on disk (its
909
    // real value is the rowset's commit_tso, filled at read time). Pass the real commit_tso as a
910
    // const value so the cache returns a ConstantColumnReader, whose iterator yields the real value
911
    // on every read path (projection / predicate / MIN-MAX zone-map) instead of the placeholder 0.
912
    // commit_tso == -1 means it is not assigned yet (before publish); keep the on-disk value then.
913
    // The value is constant per segment (a segment belongs to a single rowset), so caching the
914
    // ConstantColumnReader does not cross-pollute other queries. Some internal read paths (e.g. MOW
915
    // partial-update row fetch) build a bare StorageReadOptions without tablet_schema, so guard it.
916
18.2M
    std::optional<Field> const_value;
917
18.2M
    if (opt->tablet_schema != nullptr && opt->version.first == opt->version.second &&
918
18.2M
        opt->commit_tso.end_tso() != -1) {
919
1
        int32_t tso_idx = opt->tablet_schema->commit_tso_col_idx();
920
1
        if (tso_idx != -1 && opt->tablet_schema->column(tso_idx).unique_id() == unique_id) {
921
1
            const_value = Field::create_field<TYPE_BIGINT>(opt->commit_tso.end_tso());
922
1
        }
923
1
    }
924
925
    // init iterator by unique id
926
18.2M
    std::shared_ptr<ColumnReader> reader;
927
18.2M
    RETURN_IF_ERROR(get_column_reader(unique_id, &reader, opt->stats, &opt->io_ctx,
928
18.2M
                                      std::move(const_value)));
929
18.2M
    if (reader == nullptr) {
930
0
        return Status::InternalError("column reader is nullptr, unique_id={}", unique_id);
931
0
    }
932
18.2M
    if (reader->get_meta_type() == FieldType::OLAP_FIELD_TYPE_VARIANT) {
933
        // if sparse_column_cache_ptr is nullptr, means the sparse column cache is not used
934
26.6k
        PathToBinaryColumnCache* sparse_column_cache_ptr = nullptr;
935
26.6k
        if (variant_sparse_column_cache) {
936
26.1k
            auto it = variant_sparse_column_cache->find(unique_id);
937
26.1k
            if (it != variant_sparse_column_cache->end()) {
938
26.1k
                sparse_column_cache_ptr = it->second.get();
939
18.4E
            } else {
940
18.4E
                DCHECK(false) << "sparse column cache is not found, unique_id=" << unique_id;
941
18.4E
            }
942
26.1k
        }
943
        // use _column_reader_cache to get variant subcolumn(path column) reader
944
26.6k
        RETURN_IF_ERROR(assert_cast<VariantColumnReader*>(reader.get())
945
26.6k
                                ->new_iterator(iter, &tablet_column, opt,
946
26.6k
                                               _column_reader_cache.get(),
947
26.6k
                                               sparse_column_cache_ptr));
948
18.1M
    } else {
949
18.1M
        RETURN_IF_ERROR(reader->new_iterator(iter, &tablet_column, opt));
950
18.1M
        if (opt->all_access_paths.contains(unique_id) ||
951
18.1M
            opt->predicate_access_paths.contains(unique_id)) {
952
64.7k
            const auto& all_access_paths = opt->all_access_paths.contains(unique_id)
953
64.7k
                                                   ? opt->all_access_paths.at(unique_id)
954
64.7k
                                                   : TColumnAccessPaths {};
955
64.7k
            const auto& predicate_access_paths = opt->predicate_access_paths.contains(unique_id)
956
64.7k
                                                         ? opt->predicate_access_paths.at(unique_id)
957
64.7k
                                                         : TColumnAccessPaths {};
958
959
            // set column name to apply access paths.
960
64.7k
            (*iter)->set_column_name(tablet_column.name());
961
64.7k
            RETURN_IF_ERROR((*iter)->set_access_paths(all_access_paths, predicate_access_paths));
962
64.7k
            (*iter)->remove_pruned_sub_iterators();
963
64.7k
        }
964
18.1M
    }
965
966
18.2M
    if (config::enable_column_type_check && !tablet_column.has_path_info() &&
967
18.2M
        !tablet_column.is_agg_state_type() && tablet_column.type() != reader->get_meta_type()) {
968
0
        LOG(WARNING) << "different type between schema and column reader,"
969
0
                     << " column schema name: " << tablet_column.name()
970
0
                     << " column schema type: " << int(tablet_column.type())
971
0
                     << " column reader meta type: " << int(reader->get_meta_type());
972
0
        return Status::InternalError("different type between schema and column reader");
973
0
    }
974
18.2M
    return Status::OK();
975
18.2M
}
976
977
Status Segment::get_column_reader(int32_t col_uid, std::shared_ptr<ColumnReader>* column_reader,
978
                                  OlapReaderStatistics* stats, const io::IOContext* source_io_ctx,
979
18.2M
                                  std::optional<Field> const_value) {
980
18.2M
    RETURN_IF_ERROR(_create_column_meta_once(stats, source_io_ctx));
981
18.2M
    SCOPED_RAW_TIMER(&stats->segment_create_column_readers_timer_ns);
982
    // The column is not in this segment, return nullptr
983
18.2M
    if (!_tablet_schema->has_column_unique_id(col_uid)) {
984
0
        *column_reader = nullptr;
985
0
        return Status::Error<ErrorCode::NOT_FOUND, false>("column not found in segment, col_uid={}",
986
0
                                                          col_uid);
987
0
    }
988
18.2M
    return _column_reader_cache->get_column_reader(col_uid, column_reader, stats, source_io_ctx,
989
18.2M
                                                   std::move(const_value));
990
18.2M
}
991
992
43.2k
Status Segment::traverse_column_meta_pbs(const std::function<void(const ColumnMetaPB&)>& visitor) {
993
    // Ensure column meta accessor and reader cache are initialized once.
994
43.2k
    OlapReaderStatistics dummy_stats;
995
43.2k
    RETURN_IF_ERROR(_create_column_meta_once(&dummy_stats));
996
43.2k
    std::shared_ptr<SegmentFooterPB> footer_pb_shared;
997
43.2k
    RETURN_IF_ERROR(_get_segment_footer(footer_pb_shared, &dummy_stats));
998
43.2k
    return _column_meta_accessor->traverse_metas(*footer_pb_shared, visitor, &dummy_stats);
999
43.2k
}
1000
1001
Status Segment::get_column_reader(const TabletColumn& col,
1002
                                  std::shared_ptr<ColumnReader>* column_reader,
1003
                                  OlapReaderStatistics* stats, const io::IOContext* source_io_ctx,
1004
1.33M
                                  std::optional<Field> const_value) {
1005
1.33M
    RETURN_IF_ERROR(_create_column_meta_once(stats, source_io_ctx));
1006
1.33M
    SCOPED_RAW_TIMER(&stats->segment_create_column_readers_timer_ns);
1007
18.4E
    int col_uid = col.unique_id() >= 0 ? col.unique_id() : col.parent_unique_id();
1008
    // The column is not in this segment, return nullptr
1009
1.33M
    if (!_tablet_schema->has_column_unique_id(col_uid)) {
1010
16
        *column_reader = nullptr;
1011
16
        return Status::Error<ErrorCode::NOT_FOUND, false>("column not found in segment, col_uid={}",
1012
16
                                                          col_uid);
1013
16
    }
1014
1.33M
    if (col.has_path_info()) {
1015
1.02k
        PathInData relative_path = col.path_info_ptr()->copy_pop_front();
1016
1.02k
        return _column_reader_cache->get_path_column_reader(col_uid, relative_path, column_reader,
1017
1.02k
                                                            stats, nullptr, source_io_ctx);
1018
1.02k
    }
1019
1.33M
    return _column_reader_cache->get_column_reader(col_uid, column_reader, stats, source_io_ctx,
1020
1.33M
                                                   std::move(const_value));
1021
1.33M
}
1022
1023
Status Segment::new_index_iterator(const TabletColumn& tablet_column, const TabletIndex* index_meta,
1024
                                   const StorageReadOptions& read_options,
1025
75.5k
                                   std::unique_ptr<IndexIterator>* iter) {
1026
75.5k
    if (read_options.runtime_state != nullptr) {
1027
66.1k
        _be_exec_version = read_options.runtime_state->be_exec_version();
1028
66.1k
    }
1029
75.5k
    RETURN_IF_ERROR(_create_column_meta_once(read_options.stats, &read_options.io_ctx));
1030
75.5k
    std::shared_ptr<ColumnReader> reader;
1031
75.5k
    auto st = get_column_reader(tablet_column, &reader, read_options.stats, &read_options.io_ctx);
1032
75.5k
    if (st.is<ErrorCode::NOT_FOUND>()) {
1033
28
        return Status::OK();
1034
28
    }
1035
75.5k
    RETURN_IF_ERROR(st);
1036
75.5k
    DCHECK(reader != nullptr);
1037
75.7k
    if (index_meta) {
1038
        // call DorisCallOnce.call without check if _index_file_reader is nullptr
1039
        // to avoid data race during parallel method calls
1040
75.7k
        RETURN_IF_ERROR(_index_file_reader_open.call([&] { return _open_index_file_reader(); }));
1041
        // after DorisCallOnce.call, _index_file_reader is guaranteed to be not nullptr
1042
75.7k
        const std::string rowset_id =
1043
75.7k
                index_meta->index_type() == IndexType::ANN ? _rowset_id.to_string() : "";
1044
75.7k
        const bool need_binding_diagnostic = tablet_column.is_variant_type() ||
1045
75.7k
                                             tablet_column.is_extracted_column() ||
1046
75.7k
                                             !index_meta->get_index_suffix().empty();
1047
75.7k
        bool index_file_exists = false;
1048
75.7k
        Status probe_status;
1049
75.7k
        if (need_binding_diagnostic) {
1050
777
            probe_status = _index_file_reader->init(config::inverted_index_read_buffer_size,
1051
777
                                                    &read_options.io_ctx);
1052
777
            if (probe_status.ok()) {
1053
777
                probe_status = _index_file_reader->index_file_exist(index_meta, &index_file_exists);
1054
777
            }
1055
777
            const auto diagnostic = fmt::format(
1056
777
                    "[VariantSearchBinding] phase=index_file_probe tablet_id={} rowset_id={} "
1057
777
                    "segment_id={} column={} logical_path={} index_id={} suffix={} exists={} "
1058
777
                    "status={}",
1059
777
                    read_options.tablet_id, _rowset_id.to_string(), _segment_id,
1060
777
                    tablet_column.name(),
1061
777
                    tablet_column.has_path_info() ? tablet_column.path_info_ptr()->get_path()
1062
777
                                                  : tablet_column.name(),
1063
777
                    index_meta->index_id(), index_meta->get_index_suffix(), index_file_exists,
1064
777
                    probe_status.ok() ? "OK" : probe_status.to_string());
1065
777
            VLOG_DEBUG << diagnostic;
1066
777
            if (read_options.stats != nullptr) {
1067
777
                read_options.stats->inverted_index_stats.add_binding_diagnostic(diagnostic);
1068
777
            }
1069
777
        }
1070
75.7k
        Status iter_status = reader->new_index_iterator(_index_file_reader, index_meta, rowset_id,
1071
75.7k
                                                        _segment_id, _num_rows, iter);
1072
75.7k
        if (!iter_status.ok()) {
1073
0
            if (need_binding_diagnostic) {
1074
0
                const auto diagnostic = fmt::format(
1075
0
                        "[VariantSearchBinding] phase=index_iterator_create result=reject "
1076
0
                        "tablet_id={} rowset_id={} segment_id={} column={} logical_path={} "
1077
0
                        "index_id={} suffix={} reason={}",
1078
0
                        read_options.tablet_id, _rowset_id.to_string(), _segment_id,
1079
0
                        tablet_column.name(),
1080
0
                        tablet_column.has_path_info() ? tablet_column.path_info_ptr()->get_path()
1081
0
                                                      : tablet_column.name(),
1082
0
                        index_meta->index_id(), index_meta->get_index_suffix(),
1083
0
                        iter_status.to_string());
1084
0
                VLOG_DEBUG << diagnostic;
1085
0
                if (read_options.stats != nullptr) {
1086
0
                    read_options.stats->inverted_index_stats.add_binding_diagnostic(diagnostic);
1087
0
                }
1088
0
            }
1089
0
            return iter_status;
1090
0
        }
1091
75.7k
        return Status::OK();
1092
75.7k
    }
1093
18.4E
    return Status::OK();
1094
75.5k
}
1095
1096
Status Segment::lookup_row_key(const Slice& key, const TabletSchema* latest_schema,
1097
                               bool with_seq_col, bool with_rowid, RowLocation* row_location,
1098
                               OlapReaderStatistics* stats, std::string* encoded_seq_value,
1099
4.08M
                               const io::IOContext* io_ctx) {
1100
4.08M
    RETURN_IF_ERROR(load_pk_index_and_bf(stats, io_ctx));
1101
4.08M
    bool has_seq_col = latest_schema->has_sequence_col();
1102
4.08M
    bool has_rowid = !latest_schema->cluster_key_uids().empty();
1103
4.08M
    size_t seq_col_length = 0;
1104
4.08M
    if (has_seq_col) {
1105
26.9k
        seq_col_length = latest_schema->column(latest_schema->sequence_col_idx()).length() + 1;
1106
26.9k
    }
1107
4.08M
    size_t rowid_length = has_rowid ? PrimaryKeyIndexReader::ROW_ID_LENGTH : 0;
1108
1109
4.08M
    Slice key_without_seq =
1110
4.08M
            Slice(key.get_data(), key.get_size() - (with_seq_col ? seq_col_length : 0) -
1111
4.08M
                                          (with_rowid ? rowid_length : 0));
1112
1113
4.08M
    DCHECK(_pk_index_reader != nullptr);
1114
4.08M
    if (!_pk_index_reader->check_present(key_without_seq)) {
1115
188k
        return Status::Error<ErrorCode::KEY_NOT_FOUND, false>("");
1116
188k
    }
1117
3.89M
    bool exact_match = false;
1118
3.89M
    std::unique_ptr<segment_v2::IndexedColumnIterator> index_iterator;
1119
3.89M
    RETURN_IF_ERROR(_pk_index_reader->new_iterator(&index_iterator, stats, io_ctx));
1120
3.89M
    auto st = index_iterator->seek_at_or_after(&key_without_seq, &exact_match);
1121
3.89M
    if (!st.ok() && !st.is<ErrorCode::ENTRY_NOT_FOUND>()) {
1122
0
        return st;
1123
0
    }
1124
3.90M
    if (st.is<ErrorCode::ENTRY_NOT_FOUND>() || (!has_seq_col && !has_rowid && !exact_match)) {
1125
83
        return Status::Error<ErrorCode::KEY_NOT_FOUND, false>("");
1126
83
    }
1127
3.89M
    row_location->row_id = cast_set<uint32_t>(index_iterator->get_current_ordinal());
1128
3.89M
    row_location->segment_id = _segment_id;
1129
3.89M
    row_location->rowset_id = _rowset_id;
1130
1131
3.89M
    size_t num_to_read = 1;
1132
3.89M
    auto index_type = DataTypeFactory::instance().create_data_type(_pk_index_reader->type(), 1, 0);
1133
3.89M
    auto index_column = index_type->create_column();
1134
3.89M
    size_t num_read = num_to_read;
1135
3.89M
    RETURN_IF_ERROR(index_iterator->next_batch(&num_read, index_column));
1136
3.89M
    DCHECK(num_to_read == num_read);
1137
1138
3.89M
    Slice sought_key = Slice(index_column->get_data_at(0).data, index_column->get_data_at(0).size);
1139
1140
    // user may use "ALTER TABLE tbl ENABLE FEATURE "SEQUENCE_LOAD" WITH ..." to add a hidden sequence column
1141
    // for a merge-on-write table which doesn't have sequence column, so `has_seq_col ==  true` doesn't mean
1142
    // data in segment has sequence column value
1143
3.89M
    bool segment_has_seq_col = _tablet_schema->has_sequence_col();
1144
3.89M
    Slice sought_key_without_seq = Slice(
1145
3.89M
            sought_key.get_data(),
1146
3.89M
            sought_key.get_size() - (segment_has_seq_col ? seq_col_length : 0) - rowid_length);
1147
1148
3.89M
    if (has_seq_col) {
1149
        // compare key
1150
25.3k
        if (key_without_seq.compare(sought_key_without_seq) != 0) {
1151
2
            return Status::Error<ErrorCode::KEY_NOT_FOUND, false>("");
1152
2
        }
1153
1154
25.3k
        if (with_seq_col && segment_has_seq_col) {
1155
            // compare sequence id
1156
23.3k
            Slice sequence_id =
1157
23.3k
                    Slice(key.get_data() + key_without_seq.get_size() + 1, seq_col_length - 1);
1158
23.3k
            Slice previous_sequence_id =
1159
23.3k
                    Slice(sought_key.get_data() + sought_key_without_seq.get_size() + 1,
1160
23.3k
                          seq_col_length - 1);
1161
23.3k
            if (sequence_id.compare(previous_sequence_id) < 0) {
1162
347
                return Status::Error<ErrorCode::KEY_ALREADY_EXISTS>(
1163
347
                        "key with higher sequence id exists");
1164
347
            }
1165
23.3k
        }
1166
3.86M
    } else if (has_rowid) {
1167
59.0k
        Slice sought_key_without_rowid =
1168
59.0k
                Slice(sought_key.get_data(), sought_key.get_size() - rowid_length);
1169
        // compare key
1170
59.0k
        if (key_without_seq.compare(sought_key_without_rowid) != 0) {
1171
0
            return Status::Error<ErrorCode::KEY_NOT_FOUND, false>("");
1172
0
        }
1173
59.0k
    }
1174
    // found the key, use rowid in pk index if necessary.
1175
3.89M
    if (has_rowid) {
1176
71.0k
        Slice rowid_slice = Slice(sought_key.get_data() + sought_key_without_seq.get_size() +
1177
71.0k
                                          (segment_has_seq_col ? seq_col_length : 0) + 1,
1178
71.0k
                                  rowid_length - 1);
1179
71.0k
        const auto* rowid_coder = get_key_coder(FieldType::OLAP_FIELD_TYPE_UNSIGNED_INT);
1180
71.0k
        RETURN_IF_ERROR(rowid_coder->decode_ascending(&rowid_slice, rowid_length,
1181
71.0k
                                                      (uint8_t*)&row_location->row_id));
1182
71.0k
    }
1183
1184
3.89M
    if (encoded_seq_value) {
1185
83
        if (!segment_has_seq_col) {
1186
0
            *encoded_seq_value = std::string {};
1187
83
        } else {
1188
            // include marker
1189
83
            *encoded_seq_value =
1190
83
                    Slice(sought_key.get_data() + sought_key_without_seq.get_size(), seq_col_length)
1191
83
                            .to_string();
1192
83
        }
1193
83
    }
1194
3.89M
    return Status::OK();
1195
3.89M
}
1196
1197
96
Status Segment::read_key_by_rowid(uint32_t row_id, std::string* key) {
1198
96
    OlapReaderStatistics* null_stat = nullptr;
1199
96
    RETURN_IF_ERROR(load_pk_index_and_bf(null_stat));
1200
96
    std::unique_ptr<segment_v2::IndexedColumnIterator> iter;
1201
96
    RETURN_IF_ERROR(_pk_index_reader->new_iterator(&iter, null_stat));
1202
1203
96
    auto index_type = DataTypeFactory::instance().create_data_type(_pk_index_reader->type(), 1, 0);
1204
96
    auto index_column = index_type->create_column();
1205
96
    RETURN_IF_ERROR(iter->seek_to_ordinal(row_id));
1206
96
    size_t num_read = 1;
1207
96
    RETURN_IF_ERROR(iter->next_batch(&num_read, index_column));
1208
96
    CHECK(num_read == 1);
1209
    // trim row id
1210
96
    if (_tablet_schema->cluster_key_uids().empty()) {
1211
96
        *key = index_column->get_data_at(0).to_string();
1212
96
    } else {
1213
0
        Slice sought_key =
1214
0
                Slice(index_column->get_data_at(0).data, index_column->get_data_at(0).size);
1215
0
        Slice sought_key_without_rowid =
1216
0
                Slice(sought_key.get_data(),
1217
0
                      sought_key.get_size() - PrimaryKeyIndexReader::ROW_ID_LENGTH);
1218
0
        *key = sought_key_without_rowid.to_string();
1219
0
    }
1220
96
    return Status::OK();
1221
96
}
1222
1223
Status Segment::seek_and_read_by_rowid(const TabletSchema& schema, SlotDescriptor* slot,
1224
                                       const std::vector<uint32_t>& row_ids,
1225
                                       MutableColumnPtr& result,
1226
                                       StorageReadOptions& storage_read_options,
1227
12.9k
                                       std::unique_ptr<ColumnIterator>& iterator_hint) {
1228
12.9k
    if (row_ids.empty()) {
1229
0
        return Status::OK();
1230
0
    }
1231
12.9k
    DORIS_CHECK(std::is_sorted(row_ids.begin(), row_ids.end()));
1232
12.9k
    DORIS_CHECK(std::adjacent_find(row_ids.begin(), row_ids.end()) == row_ids.end());
1233
    // ColumnIterator::seek_and_read expects monotonically increasing row_ids without
1234
    // duplicates for correct ordinal scanning. Enforce this contract at the entry point.
1235
12.9k
    auto io_ctx = storage_read_options.io_ctx;
1236
12.9k
    io_ctx.reader_type = ReaderType::READER_QUERY;
1237
12.9k
    io_ctx.file_cache_stats = &storage_read_options.stats->file_cache_stats;
1238
12.9k
    segment_v2::ColumnIteratorOptions opt {
1239
12.9k
            .use_page_cache = !config::disable_storage_page_cache,
1240
12.9k
            .file_reader = file_reader().get(),
1241
12.9k
            .stats = storage_read_options.stats,
1242
12.9k
            .io_ctx = io_ctx,
1243
12.9k
    };
1244
1245
12.9k
    const auto runtime_type = remove_nullable(slot->type());
1246
12.9k
    const auto* variant_type = typeid_cast<const DataTypeVariant*>(runtime_type.get());
1247
12.9k
    const auto* variant_v2_type = typeid_cast<const DataTypeVariantV2*>(runtime_type.get());
1248
1249
12.9k
    if (!slot->column_paths().empty()) {
1250
345
        DORIS_CHECK(variant_type != nullptr || variant_v2_type != nullptr);
1251
        // here need create column readers to make sure column reader is created before seek_and_read_by_rowid
1252
        // if segment cache miss, column reader will be created to make sure the variant column result not coredump
1253
345
        RETURN_IF_ERROR(
1254
345
                _create_column_meta_once(storage_read_options.stats, &storage_read_options.io_ctx));
1255
1256
345
        const PathInData path(schema.column_by_uid(slot->col_unique_id()).name_lower_case(),
1257
345
                              slot->column_paths());
1258
345
        TabletColumn column = variant_util::get_column_by_type(
1259
345
                make_nullable(slot->type()), path.get_path(),
1260
345
                variant_util::ExtraInfo {.parent_unique_id = slot->col_unique_id(),
1261
345
                                         .path_info = path});
1262
345
        auto storage_type = get_data_type_of(column, storage_read_options);
1263
345
        DCHECK(storage_type != nullptr);
1264
345
        MutableColumnPtr file_storage_column = storage_type->create_column();
1265
1266
345
        if (iterator_hint == nullptr) {
1267
333
            RETURN_IF_ERROR(new_column_iterator(column, &iterator_hint, &storage_read_options));
1268
333
            RETURN_IF_ERROR(iterator_hint->init(opt));
1269
333
        }
1270
345
        RETURN_IF_ERROR(
1271
345
                iterator_hint->read_by_rowids(row_ids.data(), row_ids.size(), file_storage_column));
1272
345
        ColumnPtr source_ptr;
1273
        // storage may have different type with schema, so we need to cast the column
1274
345
        RETURN_IF_ERROR(variant_util::cast_column(
1275
345
                ColumnWithTypeAndName(file_storage_column->get_ptr(), storage_type, column.name()),
1276
345
                slot->type(), &source_ptr));
1277
        // An empty Variant V2 destination has no representation to preserve. Adopt the cast
1278
        // result so a homogeneous scalar leaf stays in typed state; subsequent batches with the
1279
        // same typed identity can append without converting every value to encoded Variant bytes.
1280
345
        if (variant_v2_type != nullptr && result->empty()) {
1281
5
            result = IColumn::mutate(std::move(source_ptr));
1282
5
            return Status::OK();
1283
5
        }
1284
340
        RETURN_IF_CATCH_EXCEPTION(result->insert_range_from(*source_ptr, 0, row_ids.size()));
1285
12.6k
    } else {
1286
12.6k
        int index = (slot->col_unique_id() >= 0) ? schema.field_index(slot->col_unique_id())
1287
18.4E
                                                 : schema.field_index(slot->col_name());
1288
12.6k
        if (index < 0) {
1289
0
            std::stringstream ss;
1290
0
            ss << "field name is invalid. field=" << slot->col_name()
1291
0
               << ", field_name_to_index=" << schema.get_all_field_names();
1292
0
            return Status::InternalError(ss.str());
1293
0
        }
1294
12.6k
        TabletColumn column = schema.column(index);
1295
12.6k
        if (column.type() == FieldType::OLAP_FIELD_TYPE_VARIANT) {
1296
102
            DORIS_CHECK(variant_type != nullptr || variant_v2_type != nullptr);
1297
102
            column.set_variant_is_v2(variant_v2_type != nullptr);
1298
102
        }
1299
12.6k
        if (iterator_hint == nullptr) {
1300
12.5k
            RETURN_IF_ERROR(new_column_iterator(column, &iterator_hint, &storage_read_options));
1301
12.5k
            RETURN_IF_ERROR(iterator_hint->init(opt));
1302
12.5k
        }
1303
12.6k
        RETURN_IF_ERROR(iterator_hint->read_by_rowids(row_ids.data(), row_ids.size(), result));
1304
12.6k
    }
1305
12.9k
    return Status::OK();
1306
12.9k
}
1307
1308
Status Segment::_get_segment_footer(std::shared_ptr<SegmentFooterPB>& footer_pb,
1309
                                    OlapReaderStatistics* stats,
1310
22.6M
                                    const io::IOContext* source_io_ctx) {
1311
22.6M
    std::shared_ptr<SegmentFooterPB> footer_pb_shared = _footer_pb.lock();
1312
22.6M
    if (footer_pb_shared != nullptr) {
1313
21.0M
        footer_pb = footer_pb_shared;
1314
21.0M
        return Status::OK();
1315
21.0M
    }
1316
1317
18.4E
    VLOG_DEBUG << fmt::format("Segment footer of {}:{}:{} is missing, try to load it",
1318
18.4E
                              _file_reader->path().native(), _file_reader->size(),
1319
18.4E
                              _file_reader->size() - 12);
1320
1321
1.62M
    StoragePageCache* segment_footer_cache = ExecEnv::GetInstance()->get_storage_page_cache();
1322
1.62M
    DCHECK(segment_footer_cache != nullptr);
1323
1324
1.62M
    auto cache_key = get_segment_footer_cache_key();
1325
1326
1.62M
    PageCacheHandle cache_handle;
1327
1328
    // Put segment footer into index page cache.
1329
    // Rationale:
1330
    // - Footer is metadata (small, parsed with indexes), not data page payload.
1331
    // - Using PageTypePB::INDEX_PAGE keeps it under the same eviction policy/shards
1332
    //   as other index/metadata pages and avoids competing with DATA_PAGE budget.
1333
1.62M
    if (!segment_footer_cache->lookup(cache_key, &cache_handle,
1334
1.62M
                                      segment_v2::PageTypePB::INDEX_PAGE)) {
1335
77.5k
        RETURN_IF_ERROR(_parse_footer(footer_pb_shared, stats, source_io_ctx));
1336
77.5k
        segment_footer_cache->insert(cache_key, footer_pb_shared, footer_pb_shared->ByteSizeLong(),
1337
77.5k
                                     &cache_handle, segment_v2::PageTypePB::INDEX_PAGE);
1338
1.54M
    } else {
1339
18.4E
        VLOG_DEBUG << fmt::format("Segment footer of {}:{}:{} is found in cache",
1340
18.4E
                                  _file_reader->path().native(), _file_reader->size(),
1341
18.4E
                                  _file_reader->size() - 12);
1342
1.54M
    }
1343
1.62M
    footer_pb_shared = cache_handle.get<std::shared_ptr<SegmentFooterPB>>();
1344
1.62M
    _footer_pb = footer_pb_shared;
1345
1.62M
    footer_pb = footer_pb_shared;
1346
1.62M
    return Status::OK();
1347
1.62M
}
1348
1349
1.73M
StoragePageCache::CacheKey Segment::get_segment_footer_cache_key() const {
1350
1.73M
    DCHECK(_file_reader != nullptr);
1351
    // The footer is always at the end of the segment file.
1352
    // The size of footer is 12.
1353
    // So we use the size of file minus 12 as the cache key, which is unique for each segment file.
1354
1.73M
    return get_segment_footer_cache_key(_file_reader);
1355
1.73M
}
1356
1357
StoragePageCache::CacheKey Segment::get_segment_footer_cache_key(
1358
1.73M
        const io::FileReaderSPtr& file_reader) {
1359
1.73M
    return {file_reader->path().native(), file_reader->size(),
1360
1.73M
            static_cast<int64_t>(file_reader->size() - 12)};
1361
1.73M
}
1362
1363
} // namespace doris::segment_v2