Coverage Report

Created: 2026-07-14 19:01

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