Coverage Report

Created: 2026-06-18 03:34

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/exec/scan/olap_scanner.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 "exec/scan/olap_scanner.h"
19
20
#include <gen_cpp/Descriptors_types.h>
21
#include <gen_cpp/PlanNodes_types.h>
22
#include <gen_cpp/Types_types.h>
23
#include <glog/logging.h>
24
#include <stdlib.h>
25
#include <thrift/protocol/TDebugProtocol.h>
26
27
#include <algorithm>
28
#include <atomic>
29
#include <iterator>
30
#include <ostream>
31
#include <set>
32
33
#include "cloud/cloud_storage_engine.h"
34
#include "cloud/cloud_tablet_hotspot.h"
35
#include "cloud/config.h"
36
#include "common/config.h"
37
#include "common/consts.h"
38
#include "common/logging.h"
39
#include "common/metrics/doris_metrics.h"
40
#include "core/block/block.h"
41
#include "core/data_type/data_type_number.h"
42
#include "exec/common/variant_util.h"
43
#include "exec/operator/olap_scan_operator.h"
44
#include "exec/scan/scan_node.h"
45
#include "exprs/function_filter.h"
46
#include "exprs/vexpr.h"
47
#include "exprs/vexpr_context.h"
48
#include "io/cache/block_file_cache_profile.h"
49
#include "io/io_common.h"
50
#include "runtime/descriptors.h"
51
#include "runtime/exec_env.h"
52
#include "runtime/runtime_profile.h"
53
#include "runtime/runtime_state.h"
54
#include "service/backend_options.h"
55
#include "storage/binlog.h"
56
#include "storage/id_manager.h"
57
#include "storage/index/inverted/inverted_index_profile.h"
58
#include "storage/iterator/block_reader.h"
59
#include "storage/olap_common.h"
60
#include "storage/olap_tuple.h"
61
#include "storage/olap_utils.h"
62
#include "storage/predicate/predicate_creator.h"
63
#include "storage/storage_engine.h"
64
#include "storage/tablet/tablet_schema.h"
65
#ifndef NDEBUG
66
#include "util/debug_points.h"
67
#endif
68
#include "util/json/path_in_data.h"
69
70
namespace doris {
71
#include "common/compile_check_avoid_begin.h"
72
73
using ReadSource = TabletReadSource;
74
75
OlapScanner::OlapScanner(ScanLocalStateBase* parent, OlapScanner::Params&& params)
76
1.20M
        : Scanner(params.state, parent, params.limit, params.profile),
77
1.20M
          _key_ranges(std::move(params.key_ranges)),
78
1.20M
          _tablet_reader_params({.tablet = std::move(params.tablet),
79
1.20M
                                 .tablet_schema {},
80
1.20M
                                 .reader_type = params.read_row_binlog ? ReaderType::READER_BINLOG
81
1.20M
                                                                       : ReaderType::READER_QUERY,
82
1.20M
                                 .aggregation = params.aggregation,
83
1.20M
                                 .version = {0, params.version},
84
1.20M
                                 .start_key {},
85
1.20M
                                 .end_key {},
86
1.20M
                                 .predicates {},
87
1.20M
                                 .function_filters {},
88
1.20M
                                 .delete_predicates {},
89
1.20M
                                 .target_cast_type_for_variants {},
90
1.20M
                                 .all_access_paths {},
91
1.20M
                                 .predicate_access_paths {},
92
1.20M
                                 .rs_splits {},
93
1.20M
                                 .return_columns {},
94
1.20M
                                 .output_columns {},
95
1.20M
                                 .common_expr_ctxs_push_down {},
96
1.20M
                                 .topn_filter_source_node_ids {},
97
1.20M
                                 .key_group_cluster_key_idxes {},
98
1.20M
                                 .virtual_column_exprs {},
99
1.20M
                                 .vir_cid_to_idx_in_block {},
100
1.20M
                                 .vir_col_idx_to_type {},
101
1.20M
                                 .score_runtime {},
102
1.20M
                                 .collection_statistics {},
103
1.20M
                                 .ann_topn_runtime {},
104
1.20M
                                 .condition_cache_digest = parent->get_condition_cache_digest(),
105
1.20M
                                 .binlog_scan_type = params.binlog_scan_type}),
106
1.20M
          _start_tso(params.start_tso),
107
1.20M
          _end_tso(params.end_tso) {
108
1.20M
    _tablet_reader_params.set_read_source(std::move(params.read_source),
109
1.20M
                                          _state->skip_delete_bitmap());
110
1.20M
    _has_prepared = false;
111
1.20M
    _vector_search_params = params.state->get_vector_search_params();
112
1.20M
}
113
114
static std::string read_columns_to_string(TabletSchemaSPtr tablet_schema,
115
2.44k
                                          const std::vector<uint32_t>& read_columns) {
116
    // avoid too long for one line,
117
    // it is hard to display in `show profile` stmt if one line is too long.
118
2.44k
    const int col_per_line = 10;
119
2.44k
    int i = 0;
120
2.44k
    std::string read_columns_string;
121
2.44k
    read_columns_string += "[";
122
12.1k
    for (auto it = read_columns.cbegin(); it != read_columns.cend(); it++) {
123
9.69k
        if (it != read_columns.cbegin()) {
124
7.29k
            read_columns_string += ", ";
125
7.29k
        }
126
9.69k
        read_columns_string += tablet_schema->columns().at(*it)->name();
127
9.69k
        if (i >= col_per_line) {
128
13
            read_columns_string += "\n";
129
13
            i = 0;
130
9.67k
        } else {
131
9.67k
            ++i;
132
9.67k
        }
133
9.69k
    }
134
2.44k
    read_columns_string += "]";
135
2.44k
    return read_columns_string;
136
2.44k
}
137
138
2.44M
static bool has_file_cache_statistics(const io::FileCacheStatistics& stats) {
139
2.44M
    return stats.num_local_io_total != 0 || stats.num_remote_io_total != 0 ||
140
2.44M
           stats.num_peer_io_total != 0 || stats.local_io_timer != 0 ||
141
2.44M
           stats.bytes_read_from_local != 0 || stats.bytes_read_from_remote != 0 ||
142
2.44M
           stats.bytes_read_from_peer != 0 || stats.remote_io_timer != 0 ||
143
2.44M
           stats.peer_io_timer != 0 || stats.remote_wait_timer != 0 ||
144
2.44M
           stats.write_cache_io_timer != 0 || stats.bytes_write_into_cache != 0 ||
145
2.44M
           stats.num_skip_cache_io_total != 0 || stats.read_cache_file_directly_timer != 0 ||
146
2.44M
           stats.cache_get_or_set_timer != 0 || stats.lock_wait_timer != 0 ||
147
2.44M
           stats.get_timer != 0 || stats.set_timer != 0 ||
148
2.44M
           stats.inverted_index_num_local_io_total != 0 ||
149
2.44M
           stats.inverted_index_num_remote_io_total != 0 ||
150
2.44M
           stats.inverted_index_num_peer_io_total != 0 ||
151
2.44M
           stats.inverted_index_bytes_read_from_local != 0 ||
152
2.44M
           stats.inverted_index_bytes_read_from_remote != 0 ||
153
2.44M
           stats.inverted_index_bytes_read_from_peer != 0 ||
154
2.44M
           stats.inverted_index_local_io_timer != 0 || stats.inverted_index_remote_io_timer != 0 ||
155
2.44M
           stats.inverted_index_peer_io_timer != 0 || stats.inverted_index_io_timer != 0;
156
2.44M
}
157
158
1.20M
Status OlapScanner::_prepare_impl() {
159
1.20M
    auto* local_state = static_cast<OlapScanLocalState*>(_local_state);
160
1.20M
    auto& tablet = _tablet_reader_params.tablet;
161
1.20M
    auto& tablet_schema = _tablet_reader_params.tablet_schema;
162
1.20M
    DBUG_EXECUTE_IF("CloudTablet.capture_rs_readers.return.e-230", {
163
1.20M
        LOG_WARNING("CloudTablet.capture_rs_readers.return e-230 init")
164
1.20M
                .tag("tablet_id", tablet->tablet_id());
165
1.20M
        return Status::Error<false>(-230, "injected error");
166
1.20M
    });
167
168
1.20M
    for (auto& ctx : local_state->_common_expr_ctxs_push_down) {
169
22.4k
        VExprContextSPtr context;
170
22.4k
        RETURN_IF_ERROR(ctx->clone(_state, context));
171
22.4k
        _common_expr_ctxs_push_down.emplace_back(context);
172
22.4k
        context->prepare_ann_range_search(_vector_search_params);
173
22.4k
    }
174
175
1.20M
    for (auto pair : local_state->_slot_id_to_virtual_column_expr) {
176
        // Scanner will be executed in a different thread, so we need to clone the context.
177
387
        VExprContextSPtr context;
178
387
        RETURN_IF_ERROR(pair.second->clone(_state, context));
179
387
        _slot_id_to_virtual_column_expr[pair.first] = context;
180
387
    }
181
182
1.20M
    _slot_id_to_index_in_block = local_state->_slot_id_to_index_in_block;
183
1.20M
    _slot_id_to_col_type = local_state->_slot_id_to_col_type;
184
1.20M
    _score_runtime = local_state->_score_runtime;
185
    // All scanners share the same ann_topn_runtime.
186
1.20M
    _ann_topn_runtime = local_state->_ann_topn_runtime;
187
188
    // set limit to reduce end of rowset and segment mem use
189
1.20M
    _tablet_reader = std::make_unique<BlockReader>();
190
    // batch size is passed down to segment iterator, use _state->batch_size()
191
    // instead of _parent->limit(), because if _parent->limit() is a very small
192
    // value (e.g. select a from t where a .. and b ... limit 1),
193
    // it will be very slow when reading data in segment iterator
194
1.20M
    _tablet_reader->set_batch_size(_state->batch_size());
195
    // Adaptive batch size: pass byte-budget settings to the storage reader.
196
    // The reader still uses batch_size() as the row ceiling.
197
1.20M
    _tablet_reader->set_preferred_block_size_bytes(_state->preferred_block_size_bytes());
198
1.20M
    {
199
1.20M
        TOlapScanNode& olap_scan_node = local_state->olap_scan_node();
200
1.20M
        TabletSchemaSPtr source_tablet_schema =
201
1.20M
                _tablet_reader_params.reader_type == ReaderType::READER_BINLOG
202
1.20M
                        ? tablet->row_binlog_tablet_schema()
203
1.20M
                        : tablet->tablet_schema();
204
205
1.20M
        tablet_schema = std::make_shared<TabletSchema>();
206
1.20M
        tablet_schema->copy_from(*source_tablet_schema);
207
1.20M
        if (olap_scan_node.__isset.columns_desc && !olap_scan_node.columns_desc.empty() &&
208
1.20M
            olap_scan_node.columns_desc[0].col_unique_id >= 0) {
209
1.20M
            tablet_schema->clear_columns();
210
18.9M
            for (const auto& column_desc : olap_scan_node.columns_desc) {
211
18.9M
                tablet_schema->append_column(TabletColumn(column_desc));
212
18.9M
            }
213
1.20M
            if (olap_scan_node.__isset.schema_version) {
214
1.20M
                tablet_schema->set_schema_version(olap_scan_node.schema_version);
215
1.20M
            }
216
1.20M
        }
217
1.20M
        if (olap_scan_node.__isset.indexes_desc) {
218
1.20M
            tablet_schema->update_indexes_from_thrift(olap_scan_node.indexes_desc);
219
1.20M
        }
220
221
1.20M
        if (_tablet_reader_params.rs_splits.empty()) {
222
            // Non-pipeline mode, Tablet : Scanner = 1 : 1
223
            // acquire tablet rowset readers at the beginning of the scan node
224
            // to prevent this case: when there are lots of olap scanners to run for example 10000
225
            // the rowsets maybe compacted when the last olap scanner starts
226
0
            ReadSource read_source;
227
228
0
            if (config::is_cloud_mode()) {
229
                // FIXME(plat1ko): Avoid pointer cast
230
0
                ExecEnv::GetInstance()->storage_engine().to_cloud().tablet_hotspot().count(*tablet);
231
0
            }
232
233
0
            auto maybe_read_source = tablet->capture_read_source(
234
0
                    _tablet_reader_params.version,
235
0
                    {
236
0
                            .skip_missing_versions = _state->skip_missing_version(),
237
0
                            .enable_fetch_rowsets_from_peers =
238
0
                                    config::enable_fetch_rowsets_from_peer_replicas,
239
0
                            .capture_row_binlog =
240
0
                                    _tablet_reader_params.reader_type == ReaderType::READER_BINLOG,
241
0
                            .enable_prefer_cached_rowset =
242
0
                                    config::is_cloud_mode() ? _state->enable_prefer_cached_rowset()
243
0
                                                            : false,
244
0
                            .query_freshness_tolerance_ms =
245
0
                                    config::is_cloud_mode() ? _state->query_freshness_tolerance_ms()
246
0
                                                            : -1,
247
0
                    });
248
0
            if (!maybe_read_source) {
249
0
                LOG(WARNING) << "fail to init reader. res=" << maybe_read_source.error();
250
0
                return maybe_read_source.error();
251
0
            }
252
0
            read_source = std::move(maybe_read_source.value());
253
254
0
            if (config::enable_mow_verbose_log && tablet->enable_unique_key_merge_on_write()) {
255
0
                LOG_INFO("finish capture_rs_readers for tablet={}, query_id={}",
256
0
                         tablet->tablet_id(), print_id(_state->query_id()));
257
0
            }
258
259
0
            if (!_state->skip_delete_predicate()) {
260
0
                read_source.fill_delete_predicates();
261
0
            }
262
0
            _tablet_reader_params.set_read_source(std::move(read_source));
263
0
        }
264
265
        // Initialize tablet_reader_params
266
1.20M
        RETURN_IF_ERROR(_init_tablet_reader_params(
267
1.20M
                local_state->_parent->cast<OlapScanOperatorX>()._slot_id_to_slot_desc, _key_ranges,
268
1.20M
                local_state->_slot_id_to_predicates, local_state->_push_down_functions));
269
1.20M
    }
270
271
    // add read columns in profile
272
1.20M
    if (_state->enable_profile()) {
273
2.42k
        _profile->add_info_string("ReadColumns",
274
2.42k
                                  read_columns_to_string(tablet_schema, _return_columns));
275
2.42k
    }
276
277
1.20M
    if (_tablet_reader_params.score_runtime) {
278
14
        SCOPED_TIMER(local_state->_statistics_collect_timer);
279
14
        _tablet_reader_params.collection_statistics = std::make_shared<CollectionStatistics>();
280
281
14
        io::IOContext io_ctx {
282
14
                .reader_type = _tablet_reader_params.reader_type,
283
14
                .expiration_time = tablet->ttl_seconds(),
284
14
                .query_id = &_state->query_id(),
285
14
                .file_cache_stats = &_tablet_reader->mutable_stats()->file_cache_stats,
286
14
                .is_inverted_index = true,
287
14
        };
288
289
14
        RETURN_IF_ERROR(_tablet_reader_params.collection_statistics->collect(
290
14
                _state, _tablet_reader_params.rs_splits, _tablet_reader_params.tablet_schema,
291
14
                _tablet_reader_params.common_expr_ctxs_push_down, &io_ctx));
292
14
    }
293
294
1.20M
    _has_prepared = true;
295
1.20M
    return Status::OK();
296
1.20M
}
297
298
1.19M
Status OlapScanner::_open_impl(RuntimeState* state) {
299
1.19M
    RETURN_IF_ERROR(Scanner::_open_impl(state));
300
1.19M
    SCOPED_TIMER(_local_state->cast<OlapScanLocalState>()._reader_init_timer);
301
302
1.19M
    auto res = _tablet_reader->init(_tablet_reader_params);
303
1.19M
    if (!res.ok()) {
304
55
        res.append("failed to initialize storage reader. tablet=" +
305
55
                   std::to_string(_tablet_reader_params.tablet->tablet_id()) +
306
55
                   ", backend=" + BackendOptions::get_localhost());
307
55
        return res;
308
55
    }
309
310
    // Do not hold rs_splits any more to release memory.
311
1.19M
    _tablet_reader_params.rs_splits.clear();
312
313
1.19M
    return Status::OK();
314
1.19M
}
315
316
// For binlog partition-based incremental read. Pushes down [start_tso, end_tso] range
317
// predicates onto the binlog timestamp column for row-binlog scans. Also ensures the
318
// timestamp column is part of return_columns so the predicates can be evaluated by the
319
// storage layer.
320
1.19M
Status OlapScanner::_init_row_binlog_tso_predicates() {
321
1.19M
    if (_tablet_reader_params.reader_type != ReaderType::READER_BINLOG) {
322
1.19M
        return Status::OK();
323
1.19M
    }
324
325
18.4E
    if (!_start_tso.has_value() && !_end_tso.has_value()) {
326
0
        return Status::OK();
327
0
    }
328
329
18.4E
    auto& tablet_schema = _tablet_reader_params.tablet_schema;
330
18.4E
    int32_t tso_index = tablet_schema->binlog_timestamp_col_idx();
331
18.4E
    if (tso_index < 0) {
332
0
        return Status::InternalError("Column {} not found in tablet schema after append",
333
0
                                     BINLOG_TIMESTAMP_COL);
334
0
    }
335
336
18.4E
    auto data_type = std::make_shared<DataTypeInt64>();
337
18.4E
    if (_start_tso.has_value()) {
338
0
        Field start_value = Field::create_field<TYPE_BIGINT>(*_start_tso);
339
0
        _tablet_reader_params.predicates.push_back(create_comparison_predicate<PredicateType::GT>(
340
0
                tso_index, std::string(kRowBinlogTimestampColName), data_type, start_value, false));
341
0
    }
342
18.4E
    if (_end_tso.has_value()) {
343
0
        Field end_value = Field::create_field<TYPE_BIGINT>(*_end_tso);
344
0
        _tablet_reader_params.predicates.push_back(create_comparison_predicate<PredicateType::LE>(
345
0
                tso_index, std::string(kRowBinlogTimestampColName), data_type, end_value, false));
346
0
    }
347
348
18.4E
    if (std::find(_tablet_reader_params.return_columns.begin(),
349
18.4E
                  _tablet_reader_params.return_columns.end(),
350
18.4E
                  tso_index) == _tablet_reader_params.return_columns.end()) {
351
0
        _tablet_reader_params.return_columns.push_back(tso_index);
352
0
    }
353
354
18.4E
    return Status::OK();
355
18.4E
}
356
357
// it will be called under tablet read lock because capture rs readers need
358
Status OlapScanner::_init_tablet_reader_params(
359
        const phmap::flat_hash_map<int, SlotDescriptor*>& slot_id_to_slot_desc,
360
        const std::vector<OlapScanRange*>& key_ranges,
361
        const phmap::flat_hash_map<int, std::vector<std::shared_ptr<ColumnPredicate>>>&
362
                slot_to_predicates,
363
1.20M
        const std::vector<FunctionFilter>& function_filters) {
364
    // if the table with rowset [0-x] or [0-1] [2-y], and [0-1] is empty
365
1.20M
    const bool single_version = _tablet_reader_params.has_single_version();
366
367
1.20M
    auto* olap_local_state = static_cast<OlapScanLocalState*>(_local_state);
368
1.20M
    bool read_mor_as_dup = olap_local_state->olap_scan_node().__isset.read_mor_as_dup &&
369
1.20M
                           olap_local_state->olap_scan_node().read_mor_as_dup;
370
1.20M
    if (_state->skip_storage_engine_merge() || read_mor_as_dup) {
371
43
        _tablet_reader_params.direct_mode = true;
372
43
        _tablet_reader_params.aggregation = true;
373
1.20M
    } else {
374
1.20M
        auto push_down_agg_type = _local_state->get_push_down_agg_type();
375
1.20M
        _tablet_reader_params.direct_mode = _tablet_reader_params.aggregation || single_version ||
376
1.20M
                                            (push_down_agg_type != TPushAggOp::NONE &&
377
11.0k
                                             push_down_agg_type != TPushAggOp::COUNT_ON_INDEX);
378
1.20M
    }
379
380
1.20M
    RETURN_IF_ERROR(_init_variant_columns());
381
1.20M
    RETURN_IF_ERROR(_init_return_columns());
382
383
1.20M
    _tablet_reader_params.push_down_agg_type_opt = _local_state->get_push_down_agg_type();
384
385
    // Binlog DETAIL/MIN_DELTA scans widen `return_columns` with key/op/lsn/before
386
    // columns to drive the row-level merge in BlockReader. The storage-layer
387
    // statistics fast path (VStatisticsIterator, picked when push_down_agg_type
388
    // is COUNT/MINMAX) bypasses SegmentIterator entirely, returning raw segment
389
    // row counts without binlog op filtering and with a schema that does not
390
    // match the widened read schema. The result is both wrong (raw segment
391
    // count != binlog row count) and unsafe (column-count DCHECK fires inside
392
    // VStatisticsIterator::next_batch). Disable the fast path for these scans.
393
1.20M
    if (_tablet_reader_params.binlog_scan_type == TBinlogScanType::DETAIL ||
394
1.20M
        _tablet_reader_params.binlog_scan_type == TBinlogScanType::MIN_DELTA) {
395
0
        _tablet_reader_params.push_down_agg_type_opt = TPushAggOp::NONE;
396
0
    }
397
398
1.20M
    _tablet_reader_params.common_expr_ctxs_push_down = _common_expr_ctxs_push_down;
399
1.20M
    _tablet_reader_params.virtual_column_exprs = _virtual_column_exprs;
400
1.20M
    _tablet_reader_params.vir_cid_to_idx_in_block = _vir_cid_to_idx_in_block;
401
1.20M
    _tablet_reader_params.vir_col_idx_to_type = _vir_col_idx_to_type;
402
1.20M
    _tablet_reader_params.score_runtime = _score_runtime;
403
1.20M
    _tablet_reader_params.output_columns = ((OlapScanLocalState*)_local_state)->_output_column_ids;
404
1.20M
    _tablet_reader_params.ann_topn_runtime = _ann_topn_runtime;
405
1.20M
    for (const auto& ele : ((OlapScanLocalState*)_local_state)->_cast_types_for_variants) {
406
1.49k
        _tablet_reader_params.target_cast_type_for_variants[ele.first] = ele.second;
407
1.49k
    };
408
1.20M
    auto& tablet_schema = _tablet_reader_params.tablet_schema;
409
9.70M
    for (auto& predicates : slot_to_predicates) {
410
9.70M
        const int sid = predicates.first;
411
9.70M
        DCHECK(slot_id_to_slot_desc.contains(sid));
412
9.70M
        int32_t index =
413
9.70M
                tablet_schema->field_index(slot_id_to_slot_desc.find(sid)->second->col_name());
414
9.70M
        if (index < 0) {
415
0
            throw Exception(
416
0
                    Status::InternalError("Column {} not found in tablet schema",
417
0
                                          slot_id_to_slot_desc.find(sid)->second->col_name()));
418
0
        }
419
9.70M
        for (auto& predicate : predicates.second) {
420
976k
            _tablet_reader_params.predicates.push_back(predicate->clone(index));
421
976k
        }
422
9.70M
    }
423
424
1.20M
    std::copy(function_filters.cbegin(), function_filters.cend(),
425
1.20M
              std::inserter(_tablet_reader_params.function_filters,
426
1.20M
                            _tablet_reader_params.function_filters.begin()));
427
428
    // Merge the columns in delete predicate that not in latest schema in to current tablet schema
429
1.20M
    for (auto& del_pred : _tablet_reader_params.delete_predicates) {
430
6.67k
        tablet_schema->merge_dropped_columns(*del_pred->tablet_schema());
431
6.67k
    }
432
433
    // Push key ranges to the tablet reader.
434
    // Skip the "full scan" placeholder (has_lower_bound == false) — when no key
435
    // predicates exist, start_key/end_key remain empty and the reader does a full scan.
436
1.72M
    for (auto* key_range : key_ranges) {
437
1.72M
        if (!key_range->has_lower_bound) {
438
153k
            continue;
439
153k
        }
440
441
1.57M
        _tablet_reader_params.start_key_include = key_range->begin_include;
442
1.57M
        _tablet_reader_params.end_key_include = key_range->end_include;
443
444
1.57M
        _tablet_reader_params.start_key.push_back(key_range->begin_scan_range);
445
1.57M
        _tablet_reader_params.end_key.push_back(key_range->end_scan_range);
446
1.57M
    }
447
448
1.20M
    _tablet_reader_params.profile = _local_state->custom_profile();
449
1.20M
    _tablet_reader_params.runtime_state = _state;
450
451
1.20M
    _tablet_reader_params.origin_return_columns = &_return_columns;
452
1.20M
    _tablet_reader_params.tablet_columns_convert_to_null_set = &_tablet_columns_convert_to_null_set;
453
454
1.20M
    auto add_return_column_if_absent = [&](uint32_t cid) {
455
0
        if (std::find(_tablet_reader_params.return_columns.begin(),
456
0
                      _tablet_reader_params.return_columns.end(),
457
0
                      cid) == _tablet_reader_params.return_columns.end()) {
458
0
            _tablet_reader_params.return_columns.push_back(cid);
459
0
        }
460
0
    };
461
462
    // For row-binlog scans that emit BEFORE/AFTER pairs (MIN_DELTA / DETAIL), we must read
463
    // every key column, every requested value column, the binlog meta columns (op / lsn /
464
    // tso) and their __BEFORE__ mirrors, so the BlockReader can reconstruct change rows.
465
1.20M
    const bool need_before_columns =
466
1.20M
            _tablet_reader_params.binlog_scan_type == TBinlogScanType::MIN_DELTA ||
467
1.20M
            _tablet_reader_params.binlog_scan_type == TBinlogScanType::DETAIL;
468
1.20M
    if (need_before_columns) {
469
0
        for (size_t i = 0; i < tablet_schema->num_key_columns(); ++i) {
470
0
            add_return_column_if_absent(static_cast<uint32_t>(i));
471
0
        }
472
0
        for (auto cid : _return_columns) {
473
0
            add_return_column_if_absent(cid);
474
0
        }
475
476
0
        if (int32_t op_idx = tablet_schema->field_index(std::string(kRowBinlogOpColName));
477
0
            op_idx >= 0) {
478
0
            add_return_column_if_absent(static_cast<uint32_t>(op_idx));
479
0
        }
480
0
        if (int32_t lsn_idx = tablet_schema->binlog_lsn_col_idx(); lsn_idx >= 0) {
481
0
            add_return_column_if_absent(static_cast<uint32_t>(lsn_idx));
482
0
        }
483
484
0
        for (auto cid : _return_columns) {
485
0
            if (cid >= tablet_schema->num_key_columns()) {
486
0
                const auto& col_name = tablet_schema->column(cid).name();
487
0
                std::string before_col_name;
488
0
                before_col_name.append("__BEFORE__");
489
0
                before_col_name.append(col_name);
490
0
                before_col_name.append("__");
491
0
                if (int32_t before_idx = tablet_schema->field_index(before_col_name);
492
0
                    before_idx >= 0) {
493
0
                    add_return_column_if_absent(static_cast<uint32_t>(before_idx));
494
0
                }
495
0
            }
496
0
        }
497
1.20M
    } else if (_tablet_reader_params.direct_mode) {
498
1.18M
        _tablet_reader_params.return_columns = _return_columns;
499
1.18M
    } else {
500
        // we need to fetch all key columns to do the right aggregation on storage engine side.
501
41.8k
        for (size_t i = 0; i < tablet_schema->num_key_columns(); ++i) {
502
29.6k
            _tablet_reader_params.return_columns.push_back(i);
503
29.6k
        }
504
52.9k
        for (auto index : _return_columns) {
505
52.9k
            if (tablet_schema->column(index).is_key()) {
506
20.5k
                continue;
507
20.5k
            }
508
32.3k
            _tablet_reader_params.return_columns.push_back(index);
509
32.3k
        }
510
        // expand the sequence column
511
12.1k
        if (tablet_schema->has_sequence_col() || tablet_schema->has_seq_map()) {
512
40
            bool has_replace_col = false;
513
91
            for (auto col : _return_columns) {
514
91
                if (tablet_schema->column(col).aggregation() ==
515
91
                    FieldAggregationMethod::OLAP_FIELD_AGGREGATION_REPLACE) {
516
40
                    has_replace_col = true;
517
40
                    break;
518
40
                }
519
91
            }
520
40
            if (auto sequence_col_idx = tablet_schema->sequence_col_idx();
521
40
                has_replace_col && tablet_schema->has_sequence_col() &&
522
40
                std::find(_return_columns.begin(), _return_columns.end(), sequence_col_idx) ==
523
28
                        _return_columns.end()) {
524
16
                _tablet_reader_params.return_columns.push_back(sequence_col_idx);
525
16
            }
526
40
            if (has_replace_col) {
527
40
                const auto& val_to_seq = tablet_schema->value_col_idx_to_seq_col_idx();
528
40
                std::set<uint32_t> return_seq_columns;
529
530
245
                for (auto col : _tablet_reader_params.return_columns) {
531
                    // we need to add the necessary sequence column in _return_columns, and
532
                    // Avoid adding the same seq column twice
533
245
                    const auto val_iter = val_to_seq.find(col);
534
245
                    if (val_iter != val_to_seq.end()) {
535
42
                        auto seq = val_iter->second;
536
42
                        if (std::find(_tablet_reader_params.return_columns.begin(),
537
42
                                      _tablet_reader_params.return_columns.end(),
538
42
                                      seq) == _tablet_reader_params.return_columns.end()) {
539
4
                            return_seq_columns.insert(seq);
540
4
                        }
541
42
                    }
542
245
                }
543
40
                _tablet_reader_params.return_columns.insert(
544
40
                        std::end(_tablet_reader_params.return_columns),
545
40
                        std::begin(return_seq_columns), std::end(return_seq_columns));
546
40
            }
547
40
        }
548
12.1k
    }
549
550
1.20M
    RETURN_IF_ERROR(_init_row_binlog_tso_predicates());
551
552
    // For any row-binlog scan, force the storage layer to deliver rows strictly in primary-key
553
    // order so the BlockReader can group consecutive same-key changes (MIN_DELTA) or emit
554
    // BEFORE/AFTER pairs in deterministic order (DETAIL). Disable ORDER BY / TopN pushdowns
555
    // and reset their related params, since they would otherwise re-order the stream.
556
1.20M
    if (_tablet_reader_params.binlog_scan_type != TBinlogScanType::NONE) {
557
0
        _tablet_reader_params.read_orderby_key = true;
558
0
        _tablet_reader_params.read_orderby_key_reverse = false;
559
0
        _tablet_reader_params.read_orderby_key_num_prefix_columns = 0;
560
0
        _tablet_reader_params.read_orderby_key_limit = 0;
561
0
        _tablet_reader_params.force_key_ordered_read = true;
562
0
        _tablet_reader_params.topn_filter_source_node_ids.clear();
563
0
    }
564
565
1.20M
    _tablet_reader_params.use_page_cache = _state->enable_page_cache();
566
567
1.20M
    DBUG_EXECUTE_IF("NewOlapScanner::_init_tablet_reader_params.block", DBUG_BLOCK);
568
569
1.20M
    if (!_state->skip_storage_engine_merge()) {
570
1.19M
        auto* olap_scan_local_state = (OlapScanLocalState*)_local_state;
571
1.19M
        TOlapScanNode& olap_scan_node = olap_scan_local_state->olap_scan_node();
572
573
        // Set MOR value predicate pushdown flag
574
1.19M
        if (olap_scan_node.__isset.enable_mor_value_predicate_pushdown &&
575
1.19M
            olap_scan_node.enable_mor_value_predicate_pushdown) {
576
25
            _tablet_reader_params.enable_mor_value_predicate_pushdown = true;
577
25
        }
578
579
1.19M
        const bool has_key_topn =
580
1.19M
                olap_scan_node.__isset.sort_info && !olap_scan_node.sort_info.is_asc_order.empty();
581
1.19M
        if (has_key_topn) {
582
2.50k
            _limit = _local_state->limit_per_scanner();
583
2.50k
        }
584
585
1.19M
        const bool no_runtime_filters = _total_rf_num == 0;
586
1.19M
        const bool segment_limit_enabled = _state->enable_segment_limit_pushdown();
587
1.19M
        const bool storage_no_merge = olap_scan_local_state->_storage_no_merge();
588
589
1.19M
        if (_limit > 0 && no_runtime_filters && segment_limit_enabled && storage_no_merge) {
590
1.72k
            for (const auto& conjunct : _conjuncts) {
591
0
                DORIS_CHECK(!olap_scan_local_state->_check_expr_storage_filter(
592
0
                        conjunct->root(), OlapScanLocalState::ExprStorageFilterCheckMode::
593
0
                                                  HAS_SEGMENT_EVALUABLE_EXPR));
594
0
            }
595
1.72k
        }
596
597
        // Segment LIMIT has only two legal states: completely disabled, or enabled after every
598
        // row-filtering conjunct has become a storage predicate or SegmentIterator common expr.
599
1.19M
        const bool can_push_down_segment_limit = _limit > 0 && no_runtime_filters &&
600
1.19M
                                                 _conjuncts.empty() && segment_limit_enabled &&
601
1.19M
                                                 storage_no_merge;
602
1.19M
        if (can_push_down_segment_limit) {
603
1.73k
            if (has_key_topn) {
604
1.39k
                _tablet_reader_params.read_orderby_key = true;
605
1.39k
                if (!olap_scan_node.sort_info.is_asc_order[0]) {
606
369
                    _tablet_reader_params.read_orderby_key_reverse = true;
607
369
                }
608
1.39k
                _tablet_reader_params.read_orderby_key_num_prefix_columns =
609
1.39k
                        olap_scan_node.sort_info.is_asc_order.size();
610
1.39k
                _tablet_reader_params.read_orderby_key_limit = _limit;
611
1.39k
            } else {
612
335
                _tablet_reader_params.general_read_limit = _limit;
613
335
            }
614
1.73k
        }
615
616
1.19M
        if (_tablet_reader_params.read_orderby_key_limit > 0 ||
617
1.19M
            _tablet_reader_params.general_read_limit > 0) {
618
1.72k
            DORIS_CHECK(can_push_down_segment_limit);
619
1.72k
            DORIS_CHECK(_conjuncts.empty());
620
1.72k
        }
621
622
        // A key TopN scan cannot share the plain LIMIT early-stop counter. If
623
        // storage TopN is pushed down, each scanner must produce its full local
624
        // candidates. If it is not pushed down for any reason, the upper TopN
625
        // still needs all rows from the scan.
626
1.19M
        if (has_key_topn) {
627
2.50k
            _shared_scan_limit = nullptr;
628
2.50k
            if (_tablet_reader_params.read_orderby_key_limit == 0) {
629
1.11k
                _limit = -1;
630
1.11k
            }
631
2.50k
        }
632
        // Note: _shared_scan_limit is intentionally not pushed into the
633
        // storage layer. SegmentIterator's _process_eof() is irreversible,
634
        // so a concurrently-decremented atomic could reach 0 while a segment
635
        // still has data needed by other scanners.
636
637
        // set push down topn filter
638
1.19M
        _tablet_reader_params.topn_filter_source_node_ids =
639
1.19M
                olap_scan_local_state->get_topn_filter_source_node_ids(_state, true);
640
1.19M
        if (!_tablet_reader_params.topn_filter_source_node_ids.empty()) {
641
5.10k
            _tablet_reader_params.topn_filter_target_node_id =
642
5.10k
                    olap_scan_local_state->parent()->node_id();
643
5.10k
        }
644
1.19M
    }
645
646
    // If this is a Two-Phase read query, and we need to delay the release of Rowset
647
    // by rowset->update_delayed_expired_timestamp().This could expand the lifespan of Rowset
648
1.20M
    if (tablet_schema->field_index(BeConsts::ROWID_COL) >= 0) {
649
0
        constexpr static int delayed_s = 60;
650
0
        for (auto rs_reader : _tablet_reader_params.rs_splits) {
651
0
            uint64_t delayed_expired_timestamp =
652
0
                    UnixSeconds() + _tablet_reader_params.runtime_state->execution_timeout() +
653
0
                    delayed_s;
654
0
            rs_reader.rs_reader->rowset()->update_delayed_expired_timestamp(
655
0
                    delayed_expired_timestamp);
656
0
            ExecEnv::GetInstance()->storage_engine().add_quering_rowset(
657
0
                    rs_reader.rs_reader->rowset());
658
0
        }
659
0
    }
660
661
1.20M
    if (tablet_schema->has_global_row_id()) {
662
7.14k
        auto& id_file_map = _state->get_id_file_map();
663
12.6k
        for (auto rs_reader : _tablet_reader_params.rs_splits) {
664
12.6k
            id_file_map->add_temp_rowset(rs_reader.rs_reader->rowset());
665
12.6k
        }
666
7.14k
    }
667
668
1.20M
    return Status::OK();
669
1.20M
}
670
671
1.19M
Status OlapScanner::_init_variant_columns() {
672
1.19M
    auto& tablet_schema = _tablet_reader_params.tablet_schema;
673
1.19M
    if (tablet_schema->num_variant_columns() == 0) {
674
1.19M
        return Status::OK();
675
1.19M
    }
676
    // Parent column has path info to distinction from each other
677
14.6k
    for (auto* slot : _output_tuple_desc->slots()) {
678
14.6k
        if (slot->type()->get_primitive_type() == PrimitiveType::TYPE_VARIANT) {
679
            // Such columns are not exist in frontend schema info, so we need to
680
            // add them into tablet_schema for later column indexing.
681
6.86k
            const auto& dt_variant =
682
6.86k
                    assert_cast<const DataTypeVariant&>(*remove_nullable(slot->type()));
683
6.86k
            TabletColumn subcol = TabletColumn::create_materialized_variant_column(
684
6.86k
                    tablet_schema->column_by_uid(slot->col_unique_id()).name_lower_case(),
685
6.86k
                    slot->column_paths(), slot->col_unique_id(),
686
6.86k
                    dt_variant.variant_max_subcolumns_count(), dt_variant.enable_doc_mode());
687
6.86k
            if (tablet_schema->field_index(*subcol.path_info_ptr()) < 0) {
688
5.14k
                tablet_schema->append_column(subcol, TabletSchema::ColumnType::VARIANT);
689
5.14k
            }
690
6.86k
        }
691
14.6k
    }
692
5.44k
    variant_util::inherit_column_attributes(tablet_schema);
693
5.44k
    return Status::OK();
694
1.19M
}
695
696
1.19M
Status OlapScanner::_init_return_columns() {
697
12.7M
    for (auto* slot : _output_tuple_desc->slots()) {
698
        // variant column using path to index a column
699
12.7M
        int32_t index = 0;
700
12.7M
        auto& tablet_schema = _tablet_reader_params.tablet_schema;
701
12.7M
        if (slot->type()->get_primitive_type() == PrimitiveType::TYPE_VARIANT) {
702
6.87k
            index = tablet_schema->field_index(PathInData(
703
6.87k
                    tablet_schema->column_by_uid(slot->col_unique_id()).name_lower_case(),
704
6.87k
                    slot->column_paths()));
705
12.7M
        } else {
706
12.7M
            index = slot->col_unique_id() >= 0 ? tablet_schema->field_index(slot->col_unique_id())
707
18.4E
                                               : tablet_schema->field_index(slot->col_name());
708
12.7M
        }
709
710
12.7M
        if (index < 0) {
711
0
            return Status::InternalError(
712
0
                    "field name is invalid. field={}, field_name_to_index={}, col_unique_id={}",
713
0
                    slot->col_name(), tablet_schema->get_all_field_names(), slot->col_unique_id());
714
0
        }
715
716
12.7M
        if (slot->get_virtual_column_expr()) {
717
385
            ColumnId virtual_column_cid = index;
718
385
            _virtual_column_exprs[virtual_column_cid] = _slot_id_to_virtual_column_expr[slot->id()];
719
385
            size_t idx_in_block = _slot_id_to_index_in_block[slot->id()];
720
385
            _vir_cid_to_idx_in_block[virtual_column_cid] = idx_in_block;
721
385
            _vir_col_idx_to_type[idx_in_block] = _slot_id_to_col_type[slot->id()];
722
723
385
            VLOG_DEBUG << fmt::format(
724
2
                    "Virtual column, slot id: {}, cid {}, column index: {}, type: {}", slot->id(),
725
2
                    virtual_column_cid, _vir_cid_to_idx_in_block[virtual_column_cid],
726
2
                    _vir_col_idx_to_type[idx_in_block]->get_name());
727
385
        }
728
729
12.7M
        const auto& column = tablet_schema->column(index);
730
12.7M
        int32_t unique_id =
731
18.4E
                column.unique_id() >= 0 ? column.unique_id() : column.parent_unique_id();
732
12.7M
        if (!slot->all_access_paths().empty()) {
733
73.6k
            _tablet_reader_params.all_access_paths.insert({unique_id, slot->all_access_paths()});
734
73.6k
        }
735
736
12.7M
        if (!slot->predicate_access_paths().empty()) {
737
8.27k
            _tablet_reader_params.predicate_access_paths.insert(
738
8.27k
                    {unique_id, slot->predicate_access_paths()});
739
8.27k
        }
740
741
12.7M
        if ((slot->type()->get_primitive_type() == PrimitiveType::TYPE_STRUCT ||
742
12.8M
             slot->type()->get_primitive_type() == PrimitiveType::TYPE_MAP ||
743
12.7M
             slot->type()->get_primitive_type() == PrimitiveType::TYPE_ARRAY) &&
744
12.7M
            !slot->all_access_paths().empty()) {
745
59.1k
            tablet_schema->add_pruned_columns_data_type(column.unique_id(), slot->type());
746
59.1k
        }
747
748
12.7M
        _return_columns.push_back(index);
749
12.7M
        if (slot->is_nullable() && !tablet_schema->column(index).is_nullable()) {
750
0
            _tablet_columns_convert_to_null_set.emplace(index);
751
12.7M
        } else if (!slot->is_nullable() && tablet_schema->column(index).is_nullable()) {
752
0
            return Status::Error<ErrorCode::INVALID_SCHEMA>(
753
0
                    "slot(id: {}, name: {})'s nullable does not match "
754
0
                    "column(tablet id: {}, index: {}, name: {}) ",
755
0
                    slot->id(), slot->col_name(), tablet_schema->table_id(), index,
756
0
                    tablet_schema->column(index).name());
757
0
        }
758
12.7M
    }
759
760
1.19M
    if (_return_columns.empty()) {
761
0
        return Status::InternalError("failed to build storage scanner, no materialized slot!");
762
0
    }
763
764
1.19M
    return Status::OK();
765
1.19M
}
766
767
2.49M
bool OlapScanner::check_partition_pruned() const {
768
2.49M
    if (!_local_state) {
769
0
        return false;
770
0
    }
771
2.49M
    return _local_state->is_partition_pruned(_tablet_reader_params.tablet->partition_id());
772
2.49M
}
773
774
1.24M
doris::TabletStorageType OlapScanner::get_storage_type() {
775
1.24M
    if (config::is_cloud_mode()) {
776
        // we don't have cold storage in cloud mode, all storage is treated as local
777
878k
        return doris::TabletStorageType::STORAGE_TYPE_LOCAL;
778
878k
    }
779
371k
    int local_reader = 0;
780
703k
    for (const auto& reader : _tablet_reader_params.rs_splits) {
781
703k
        local_reader += reader.rs_reader->rowset()->is_local();
782
703k
    }
783
371k
    int total_reader = _tablet_reader_params.rs_splits.size();
784
785
371k
    if (local_reader == total_reader) {
786
371k
        return doris::TabletStorageType::STORAGE_TYPE_LOCAL;
787
371k
    } else if (local_reader == 0) {
788
0
        return doris::TabletStorageType::STORAGE_TYPE_REMOTE;
789
0
    }
790
0
    return doris::TabletStorageType::STORAGE_TYPE_REMOTE_AND_LOCAL;
791
371k
}
792
793
1.53M
Status OlapScanner::_get_block_impl(RuntimeState* state, Block* block, bool* eof) {
794
    // Read one block from block reader
795
    // ATTN: Here we need to let the _get_block_impl method guarantee the semantics of the interface,
796
    // that is, eof can be set to true only when the returned block is empty.
797
1.53M
    RETURN_IF_ERROR(_tablet_reader->next_block_with_aggregation(block, eof));
798
1.53M
    if (block->rows() > 0) {
799
335k
        _tablet_reader_params.tablet->read_block_count.fetch_add(1, std::memory_order_relaxed);
800
335k
        *eof = false;
801
335k
    }
802
1.53M
#ifndef NDEBUG
803
1.53M
    RETURN_IF_ERROR(_check_ann_cache_hit_debug_points(_tablet_reader->stats()));
804
1.53M
#endif
805
1.53M
    return Status::OK();
806
1.53M
}
807
808
1.20M
Status OlapScanner::close(RuntimeState* state) {
809
1.20M
    if (!_try_close()) {
810
150
        return Status::OK();
811
150
    }
812
1.20M
    RETURN_IF_ERROR(Scanner::close(state));
813
1.20M
    return Status::OK();
814
1.20M
}
815
816
1.24M
void OlapScanner::update_realtime_counters() {
817
1.24M
    if (!_has_prepared) {
818
        // Counter update need prepare successfully, or it maybe core. For example, olap scanner
819
        // will open tablet reader during prepare, if not prepare successfully, tablet reader == nullptr.
820
0
        return;
821
0
    }
822
1.24M
    OlapScanLocalState* local_state = static_cast<OlapScanLocalState*>(_local_state);
823
1.24M
    const OlapReaderStatistics& stats = _tablet_reader->stats();
824
1.24M
    COUNTER_UPDATE(local_state->_read_compressed_counter, stats.compressed_bytes_read);
825
1.24M
    COUNTER_UPDATE(local_state->_read_uncompressed_counter, stats.uncompressed_bytes_read);
826
1.24M
    COUNTER_UPDATE(local_state->_scan_bytes, stats.uncompressed_bytes_read);
827
1.24M
    COUNTER_UPDATE(local_state->_scan_rows, stats.raw_rows_read);
828
829
    // Make sure the scan bytes and scan rows counter in audit log is the same as the counter in
830
    // doris metrics.
831
    // ScanBytes is the uncompressed bytes read from local + remote
832
    // bytes_read_from_local is the compressed bytes read from local
833
    // bytes_read_from_remote is the compressed bytes read from remote
834
    // scan bytes > bytes_read_from_local + bytes_read_from_remote
835
1.24M
    _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_rows(stats.raw_rows_read);
836
1.24M
    _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_bytes(
837
1.24M
            stats.uncompressed_bytes_read);
838
839
    // In case of no cache, we still need to update the IO stats. uncompressed bytes read == local + remote
840
1.24M
    if (stats.file_cache_stats.bytes_read_from_local == 0 &&
841
1.24M
        stats.file_cache_stats.bytes_read_from_remote == 0) {
842
1.02M
        _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_bytes_from_local_storage(
843
1.02M
                stats.compressed_bytes_read);
844
1.02M
        DorisMetrics::instance()->query_scan_bytes_from_local->increment(
845
1.02M
                stats.compressed_bytes_read);
846
1.02M
    } else {
847
223k
        _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_bytes_from_local_storage(
848
223k
                stats.file_cache_stats.bytes_read_from_local);
849
223k
        _state->get_query_ctx()
850
223k
                ->resource_ctx()
851
223k
                ->io_context()
852
223k
                ->update_scan_bytes_from_remote_storage(
853
223k
                        stats.file_cache_stats.bytes_read_from_remote);
854
855
223k
        DorisMetrics::instance()->query_scan_bytes_from_local->increment(
856
223k
                stats.file_cache_stats.bytes_read_from_local);
857
223k
        DorisMetrics::instance()->query_scan_bytes_from_remote->increment(
858
223k
                stats.file_cache_stats.bytes_read_from_remote);
859
223k
    }
860
861
1.24M
    if (has_file_cache_statistics(stats.file_cache_stats)) {
862
225k
        io::FileCacheProfileReporter cache_profile(local_state->_segment_profile.get());
863
225k
        cache_profile.update(&stats.file_cache_stats);
864
225k
        _state->get_query_ctx()->resource_ctx()->io_context()->update_bytes_write_into_cache(
865
225k
                stats.file_cache_stats.bytes_write_into_cache);
866
225k
    }
867
868
1.24M
    _tablet_reader->mutable_stats()->compressed_bytes_read = 0;
869
1.24M
    _tablet_reader->mutable_stats()->uncompressed_bytes_read = 0;
870
1.24M
    _tablet_reader->mutable_stats()->raw_rows_read = 0;
871
1.24M
    _tablet_reader->mutable_stats()->file_cache_stats = {};
872
1.24M
}
873
874
1.19M
void OlapScanner::_collect_profile_before_close() {
875
    //  Please don't directly enable the profile here, we need to set QueryStatistics using the counter inside.
876
1.19M
    if (_has_updated_counter) {
877
0
        return;
878
0
    }
879
1.19M
    _has_updated_counter = true;
880
1.19M
    _tablet_reader->update_profile(_profile);
881
882
1.19M
    Scanner::_collect_profile_before_close();
883
884
    // Update counters for OlapScanner
885
    // Update counters from tablet reader's stats
886
1.19M
    auto& stats = _tablet_reader->stats();
887
1.19M
    auto* local_state = (OlapScanLocalState*)_local_state;
888
1.19M
    COUNTER_UPDATE(local_state->_io_timer, stats.io_ns);
889
1.19M
    COUNTER_UPDATE(local_state->_read_compressed_counter, stats.compressed_bytes_read);
890
1.19M
    COUNTER_UPDATE(local_state->_scan_bytes, stats.uncompressed_bytes_read);
891
1.19M
    COUNTER_UPDATE(local_state->_decompressor_timer, stats.decompress_ns);
892
1.19M
    COUNTER_UPDATE(local_state->_read_uncompressed_counter, stats.uncompressed_bytes_read);
893
1.19M
    COUNTER_UPDATE(local_state->_block_load_timer, stats.block_load_ns);
894
1.19M
    COUNTER_UPDATE(local_state->_block_load_counter, stats.blocks_load);
895
1.19M
    COUNTER_UPDATE(local_state->_block_fetch_timer, stats.block_fetch_ns);
896
1.19M
    COUNTER_UPDATE(local_state->_delete_bitmap_get_agg_timer, stats.delete_bitmap_get_agg_ns);
897
1.19M
    COUNTER_UPDATE(local_state->_scan_rows, stats.raw_rows_read);
898
1.19M
    COUNTER_UPDATE(local_state->_vec_cond_timer, stats.vec_cond_ns);
899
1.19M
    COUNTER_UPDATE(local_state->_short_cond_timer, stats.short_cond_ns);
900
1.19M
    COUNTER_UPDATE(local_state->_expr_filter_timer, stats.expr_filter_ns);
901
1.19M
    COUNTER_UPDATE(local_state->_block_init_timer, stats.block_init_ns);
902
1.19M
    COUNTER_UPDATE(local_state->_block_init_seek_timer, stats.block_init_seek_ns);
903
1.19M
    COUNTER_UPDATE(local_state->_block_init_seek_counter, stats.block_init_seek_num);
904
1.19M
    COUNTER_UPDATE(local_state->_segment_generate_row_range_by_keys_timer,
905
1.19M
                   stats.generate_row_ranges_by_keys_ns);
906
1.19M
    COUNTER_UPDATE(local_state->_segment_generate_row_range_by_column_conditions_timer,
907
1.19M
                   stats.generate_row_ranges_by_column_conditions_ns);
908
1.19M
    COUNTER_UPDATE(local_state->_segment_generate_row_range_by_bf_timer,
909
1.19M
                   stats.generate_row_ranges_by_bf_ns);
910
1.19M
    COUNTER_UPDATE(local_state->_collect_iterator_merge_next_timer,
911
1.19M
                   stats.collect_iterator_merge_next_timer);
912
1.19M
    COUNTER_UPDATE(local_state->_segment_generate_row_range_by_zonemap_timer,
913
1.19M
                   stats.generate_row_ranges_by_zonemap_ns);
914
1.19M
    COUNTER_UPDATE(local_state->_segment_generate_row_range_by_dict_timer,
915
1.19M
                   stats.generate_row_ranges_by_dict_ns);
916
1.19M
    COUNTER_UPDATE(local_state->_predicate_column_read_timer, stats.predicate_column_read_ns);
917
1.19M
    COUNTER_UPDATE(local_state->_non_predicate_column_read_timer, stats.non_predicate_read_ns);
918
1.19M
    COUNTER_UPDATE(local_state->_predicate_column_read_seek_timer,
919
1.19M
                   stats.predicate_column_read_seek_ns);
920
1.19M
    COUNTER_UPDATE(local_state->_predicate_column_read_seek_counter,
921
1.19M
                   stats.predicate_column_read_seek_num);
922
1.19M
    COUNTER_UPDATE(local_state->_lazy_read_timer, stats.lazy_read_ns);
923
1.19M
    COUNTER_UPDATE(local_state->_lazy_read_seek_timer, stats.block_lazy_read_seek_ns);
924
1.19M
    COUNTER_UPDATE(local_state->_lazy_read_seek_counter, stats.block_lazy_read_seek_num);
925
1.19M
    COUNTER_UPDATE(local_state->_output_col_timer, stats.output_col_ns);
926
1.19M
    COUNTER_UPDATE(local_state->_rows_vec_cond_filtered_counter, stats.rows_vec_cond_filtered);
927
1.19M
    COUNTER_UPDATE(local_state->_rows_short_circuit_cond_filtered_counter,
928
1.19M
                   stats.rows_short_circuit_cond_filtered);
929
1.19M
    COUNTER_UPDATE(local_state->_rows_expr_cond_filtered_counter, stats.rows_expr_cond_filtered);
930
1.19M
    COUNTER_UPDATE(local_state->_rows_vec_cond_input_counter, stats.vec_cond_input_rows);
931
1.19M
    COUNTER_UPDATE(local_state->_rows_short_circuit_cond_input_counter,
932
1.19M
                   stats.short_circuit_cond_input_rows);
933
1.19M
    COUNTER_UPDATE(local_state->_rows_expr_cond_input_counter, stats.expr_cond_input_rows);
934
1.19M
    COUNTER_UPDATE(local_state->_stats_filtered_counter, stats.rows_stats_filtered);
935
1.19M
    COUNTER_UPDATE(local_state->_stats_rp_filtered_counter, stats.rows_stats_rp_filtered);
936
1.19M
    COUNTER_UPDATE(local_state->_dict_filtered_counter, stats.segment_dict_filtered);
937
1.19M
    COUNTER_UPDATE(local_state->_bf_filtered_counter, stats.rows_bf_filtered);
938
1.19M
    COUNTER_UPDATE(local_state->_del_filtered_counter, stats.rows_del_filtered);
939
1.19M
    COUNTER_UPDATE(local_state->_del_filtered_counter, stats.rows_del_by_bitmap);
940
1.19M
    COUNTER_UPDATE(local_state->_del_filtered_counter, stats.rows_vec_del_cond_filtered);
941
1.19M
    COUNTER_UPDATE(local_state->_conditions_filtered_counter, stats.rows_conditions_filtered);
942
1.19M
    COUNTER_UPDATE(local_state->_key_range_filtered_counter, stats.rows_key_range_filtered);
943
1.19M
    COUNTER_UPDATE(local_state->_total_pages_num_counter, stats.total_pages_num);
944
1.19M
    COUNTER_UPDATE(local_state->_cached_pages_num_counter, stats.cached_pages_num);
945
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_filter_counter, stats.rows_inverted_index_filtered);
946
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_filter_timer, stats.inverted_index_filter_timer);
947
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_query_cache_hit_counter,
948
1.19M
                   stats.inverted_index_query_cache_hit);
949
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_query_cache_miss_counter,
950
1.19M
                   stats.inverted_index_query_cache_miss);
951
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_query_timer, stats.inverted_index_query_timer);
952
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_query_null_bitmap_timer,
953
1.19M
                   stats.inverted_index_query_null_bitmap_timer);
954
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_query_bitmap_copy_timer,
955
1.19M
                   stats.inverted_index_query_bitmap_copy_timer);
956
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_searcher_open_timer,
957
1.19M
                   stats.inverted_index_searcher_open_timer);
958
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_searcher_search_timer,
959
1.19M
                   stats.inverted_index_searcher_search_timer);
960
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_searcher_search_init_timer,
961
1.19M
                   stats.inverted_index_searcher_search_init_timer);
962
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_searcher_search_exec_timer,
963
1.19M
                   stats.inverted_index_searcher_search_exec_timer);
964
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_searcher_cache_hit_counter,
965
1.19M
                   stats.inverted_index_searcher_cache_hit);
966
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_searcher_cache_miss_counter,
967
1.19M
                   stats.inverted_index_searcher_cache_miss);
968
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_downgrade_count_counter,
969
1.19M
                   stats.inverted_index_downgrade_count);
970
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_analyzer_timer,
971
1.19M
                   stats.inverted_index_analyzer_timer);
972
1.19M
    COUNTER_UPDATE(local_state->_inverted_index_lookup_timer, stats.inverted_index_lookup_timer);
973
1.19M
    COUNTER_UPDATE(local_state->_variant_scan_sparse_column_timer,
974
1.19M
                   stats.variant_scan_sparse_column_timer_ns);
975
1.19M
    COUNTER_UPDATE(local_state->_variant_scan_sparse_column_bytes,
976
1.19M
                   stats.variant_scan_sparse_column_bytes);
977
1.19M
    COUNTER_UPDATE(local_state->_variant_fill_path_from_sparse_column_timer,
978
1.19M
                   stats.variant_fill_path_from_sparse_column_timer_ns);
979
1.19M
    COUNTER_UPDATE(local_state->_variant_subtree_default_iter_count,
980
1.19M
                   stats.variant_subtree_default_iter_count);
981
1.19M
    COUNTER_UPDATE(local_state->_variant_subtree_leaf_iter_count,
982
1.19M
                   stats.variant_subtree_leaf_iter_count);
983
1.19M
    COUNTER_UPDATE(local_state->_variant_subtree_hierarchical_iter_count,
984
1.19M
                   stats.variant_subtree_hierarchical_iter_count);
985
1.19M
    COUNTER_UPDATE(local_state->_variant_subtree_sparse_iter_count,
986
1.19M
                   stats.variant_subtree_sparse_iter_count);
987
1.19M
    COUNTER_UPDATE(local_state->_variant_doc_value_column_iter_count,
988
1.19M
                   stats.variant_doc_value_column_iter_count);
989
990
1.19M
    if (stats.adaptive_batch_size_predict_max_rows > 0) {
991
947k
        local_state->_adaptive_batch_predict_min_rows_counter->set(
992
947k
                stats.adaptive_batch_size_predict_min_rows);
993
947k
        local_state->_adaptive_batch_predict_max_rows_counter->set(
994
947k
                stats.adaptive_batch_size_predict_max_rows);
995
947k
    }
996
997
1.19M
    InvertedIndexProfileReporter inverted_index_profile;
998
1.19M
    inverted_index_profile.update(local_state->_index_filter_profile.get(),
999
1.19M
                                  &stats.inverted_index_stats);
1000
1001
1.19M
    if (has_file_cache_statistics(stats.file_cache_stats)) {
1002
0
        io::FileCacheProfileReporter cache_profile(local_state->_segment_profile.get());
1003
0
        cache_profile.update(&stats.file_cache_stats);
1004
0
        _state->get_query_ctx()->resource_ctx()->io_context()->update_bytes_write_into_cache(
1005
0
                stats.file_cache_stats.bytes_write_into_cache);
1006
0
    }
1007
1.19M
    COUNTER_UPDATE(local_state->_output_index_result_column_timer,
1008
1.19M
                   stats.output_index_result_column_timer);
1009
1.19M
    COUNTER_UPDATE(local_state->_filtered_segment_counter, stats.filtered_segment_number);
1010
1.19M
    COUNTER_UPDATE(local_state->_total_segment_counter, stats.total_segment_number);
1011
1.19M
    COUNTER_UPDATE(local_state->_condition_cache_hit_counter, stats.condition_cache_hit_seg_nums);
1012
1.19M
    COUNTER_UPDATE(local_state->_condition_cache_filtered_rows_counter,
1013
1.19M
                   stats.condition_cache_filtered_rows);
1014
1015
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_init_timer, stats.tablet_reader_init_timer_ns);
1016
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_capture_rs_readers_timer,
1017
1.19M
                   stats.tablet_reader_capture_rs_readers_timer_ns);
1018
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_init_return_columns_timer,
1019
1.19M
                   stats.tablet_reader_init_return_columns_timer_ns);
1020
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_init_keys_param_timer,
1021
1.19M
                   stats.tablet_reader_init_keys_param_timer_ns);
1022
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_init_orderby_keys_param_timer,
1023
1.19M
                   stats.tablet_reader_init_orderby_keys_param_timer_ns);
1024
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_init_conditions_param_timer,
1025
1.19M
                   stats.tablet_reader_init_conditions_param_timer_ns);
1026
1.19M
    COUNTER_UPDATE(local_state->_tablet_reader_init_delete_condition_param_timer,
1027
1.19M
                   stats.tablet_reader_init_delete_condition_param_timer_ns);
1028
1.19M
    COUNTER_UPDATE(local_state->_block_reader_vcollect_iter_init_timer,
1029
1.19M
                   stats.block_reader_vcollect_iter_init_timer_ns);
1030
1.19M
    COUNTER_UPDATE(local_state->_block_reader_rs_readers_init_timer,
1031
1.19M
                   stats.block_reader_rs_readers_init_timer_ns);
1032
1.19M
    COUNTER_UPDATE(local_state->_block_reader_build_heap_init_timer,
1033
1.19M
                   stats.block_reader_build_heap_init_timer_ns);
1034
1035
1.19M
    COUNTER_UPDATE(local_state->_rowset_reader_get_segment_iterators_timer,
1036
1.19M
                   stats.rowset_reader_get_segment_iterators_timer_ns);
1037
1.19M
    COUNTER_UPDATE(local_state->_rowset_reader_create_iterators_timer,
1038
1.19M
                   stats.rowset_reader_create_iterators_timer_ns);
1039
1.19M
    COUNTER_UPDATE(local_state->_rowset_reader_init_iterators_timer,
1040
1.19M
                   stats.rowset_reader_init_iterators_timer_ns);
1041
1.19M
    COUNTER_UPDATE(local_state->_rowset_reader_load_segments_timer,
1042
1.19M
                   stats.rowset_reader_load_segments_timer_ns);
1043
1044
1.19M
    COUNTER_UPDATE(local_state->_segment_iterator_init_timer, stats.segment_iterator_init_timer_ns);
1045
1.19M
    COUNTER_UPDATE(local_state->_segment_iterator_init_return_column_iterators_timer,
1046
1.19M
                   stats.segment_iterator_init_return_column_iterators_timer_ns);
1047
1.19M
    COUNTER_UPDATE(local_state->_segment_iterator_init_index_iterators_timer,
1048
1.19M
                   stats.segment_iterator_init_index_iterators_timer_ns);
1049
1.19M
    COUNTER_UPDATE(local_state->_segment_iterator_init_segment_prefetchers_timer,
1050
1.19M
                   stats.segment_iterator_init_segment_prefetchers_timer_ns);
1051
1052
1.19M
    COUNTER_UPDATE(local_state->_segment_create_column_readers_timer,
1053
1.19M
                   stats.segment_create_column_readers_timer_ns);
1054
1.19M
    COUNTER_UPDATE(local_state->_segment_load_index_timer, stats.segment_load_index_timer_ns);
1055
1056
    // Update metrics
1057
1.19M
    DorisMetrics::instance()->query_scan_bytes->increment(
1058
1.19M
            local_state->_read_uncompressed_counter->value());
1059
1.19M
    DorisMetrics::instance()->query_scan_rows->increment(local_state->_scan_rows->value());
1060
1.19M
    auto& tablet = _tablet_reader_params.tablet;
1061
1.19M
    tablet->query_scan_bytes->increment(local_state->_read_uncompressed_counter->value());
1062
1.19M
    tablet->query_scan_rows->increment(local_state->_scan_rows->value());
1063
1.19M
    tablet->query_scan_count->increment(1);
1064
1065
1.19M
    COUNTER_UPDATE(local_state->_ann_range_search_filter_counter,
1066
1.19M
                   stats.rows_ann_index_range_filtered);
1067
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_filter_counter, stats.rows_ann_index_topn_filtered);
1068
1.19M
    COUNTER_UPDATE(local_state->_ann_index_load_costs, stats.ann_index_load_ns);
1069
1.19M
    COUNTER_UPDATE(local_state->_ann_ivf_on_disk_load_costs, stats.ann_ivf_on_disk_load_ns);
1070
1.19M
    COUNTER_UPDATE(local_state->_ann_ivf_on_disk_cache_hit_cnt,
1071
1.19M
                   stats.ann_ivf_on_disk_cache_hit_cnt);
1072
1.19M
    COUNTER_UPDATE(local_state->_ann_ivf_on_disk_cache_miss_cnt,
1073
1.19M
                   stats.ann_ivf_on_disk_cache_miss_cnt);
1074
1.19M
    COUNTER_UPDATE(local_state->_ann_range_search_costs, stats.ann_index_range_search_ns);
1075
1.19M
    COUNTER_UPDATE(local_state->_ann_range_search_cnt, stats.ann_index_range_search_cnt);
1076
1.19M
    COUNTER_UPDATE(local_state->_ann_range_engine_search_costs, stats.ann_range_engine_search_ns);
1077
    // Engine prepare before search
1078
1.19M
    COUNTER_UPDATE(local_state->_ann_range_pre_process_costs, stats.ann_range_pre_process_ns);
1079
    // Post process parent: Doris result process + engine convert
1080
1.19M
    COUNTER_UPDATE(local_state->_ann_range_post_process_costs,
1081
1.19M
                   stats.ann_range_result_convert_ns + stats.ann_range_engine_convert_ns);
1082
    // Engine convert (child under post-process)
1083
1.19M
    COUNTER_UPDATE(local_state->_ann_range_engine_convert_costs, stats.ann_range_engine_convert_ns);
1084
    // Doris-side result convert (child under post-process)
1085
1.19M
    COUNTER_UPDATE(local_state->_ann_range_result_convert_costs, stats.ann_range_result_convert_ns);
1086
1087
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_search_costs, stats.ann_topn_search_ns);
1088
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_search_cnt, stats.ann_index_topn_search_cnt);
1089
1.19M
    COUNTER_UPDATE(local_state->_ann_cache_hit_cnt, stats.ann_index_cache_hits);
1090
1.19M
    COUNTER_UPDATE(local_state->_ann_range_cache_hit_cnt, stats.ann_index_range_cache_hits);
1091
1092
    // Detailed ANN timers
1093
    // ANN TopN timers with hierarchy
1094
    // Engine search time (FAISS)
1095
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_engine_search_costs,
1096
1.19M
                   stats.ann_index_topn_engine_search_ns);
1097
    // Engine prepare time (allocations/buffer setup before search)
1098
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_pre_process_costs,
1099
1.19M
                   stats.ann_index_topn_engine_prepare_ns);
1100
    // Post process parent includes Doris result processing + engine convert
1101
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_post_process_costs,
1102
1.19M
                   stats.ann_index_topn_result_process_ns + stats.ann_index_topn_engine_convert_ns);
1103
    // Engine-side conversion time inside FAISS wrappers (child under post-process)
1104
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_engine_convert_costs,
1105
1.19M
                   stats.ann_index_topn_engine_convert_ns);
1106
1107
    // Doris-side result convert costs (show separately as another child counter); use pure process time
1108
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_result_convert_costs,
1109
1.19M
                   stats.ann_index_topn_result_process_ns);
1110
1111
1.19M
    COUNTER_UPDATE(local_state->_ann_fallback_brute_force_cnt, stats.ann_fall_back_brute_force_cnt);
1112
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_fallback_by_small_candidate_cnt,
1113
1.19M
                   stats.ann_topn_fallback_by_small_candidate_cnt);
1114
1.19M
    COUNTER_UPDATE(local_state->_ann_topn_fallback_small_candidate_rows,
1115
1.19M
                   stats.ann_topn_fallback_small_candidate_rows);
1116
1.19M
    COUNTER_UPDATE(local_state->_ann_range_fallback_by_small_candidate_cnt,
1117
1.19M
                   stats.ann_range_fallback_by_small_candidate_cnt);
1118
1.19M
    COUNTER_UPDATE(local_state->_ann_range_fallback_small_candidate_rows,
1119
1.19M
                   stats.ann_range_fallback_small_candidate_rows);
1120
1121
    // Overhead counter removed; precise instrumentation is reported via engine_prepare above.
1122
1.19M
}
1123
1124
#ifndef NDEBUG
1125
1.53M
Status OlapScanner::_check_ann_cache_hit_debug_points(const OlapReaderStatistics& stats) {
1126
1.53M
    DBUG_EXECUTE_IF("olap_scanner.ann_topn_cache_hits", {
1127
1.53M
        auto expected_hits = dp->param<int32_t>("expected_hits", -1);
1128
1.53M
        auto min_hits = dp->param<int32_t>("min_hits", -1);
1129
1.53M
        if (expected_hits >= 0 && stats.ann_index_cache_hits != expected_hits) {
1130
1.53M
            return Status::Error<ErrorCode::INTERNAL_ERROR>(
1131
1.53M
                    "ann_index_cache_hits: {} not equal to expected: {}",
1132
1.53M
                    stats.ann_index_cache_hits, expected_hits);
1133
1.53M
        }
1134
1.53M
        if (min_hits >= 0 && stats.ann_index_cache_hits < min_hits) {
1135
1.53M
            return Status::Error<ErrorCode::INTERNAL_ERROR>(
1136
1.53M
                    "ann_index_cache_hits: {} less than expected min: {}",
1137
1.53M
                    stats.ann_index_cache_hits, min_hits);
1138
1.53M
        }
1139
1.53M
    })
1140
1.53M
    DBUG_EXECUTE_IF("olap_scanner.ann_range_cache_hits", {
1141
1.53M
        auto expected_hits = dp->param<int32_t>("expected_hits", -1);
1142
1.53M
        auto min_hits = dp->param<int32_t>("min_hits", -1);
1143
1.53M
        if (expected_hits >= 0 && stats.ann_index_range_cache_hits != expected_hits) {
1144
1.53M
            return Status::Error<ErrorCode::INTERNAL_ERROR>(
1145
1.53M
                    "ann_index_range_cache_hits: {} not equal to expected: {}",
1146
1.53M
                    stats.ann_index_range_cache_hits, expected_hits);
1147
1.53M
        }
1148
1.53M
        if (min_hits >= 0 && stats.ann_index_range_cache_hits < min_hits) {
1149
1.53M
            return Status::Error<ErrorCode::INTERNAL_ERROR>(
1150
1.53M
                    "ann_index_range_cache_hits: {} less than expected min: {}",
1151
1.53M
                    stats.ann_index_range_cache_hits, min_hits);
1152
1.53M
        }
1153
1.53M
    })
1154
1.53M
    return Status::OK();
1155
1.53M
}
1156
#endif
1157
1158
#include "common/compile_check_avoid_end.h"
1159
} // namespace doris