Skip to content

Commit e78d089

Browse files
authored
[Chore](runtime-filter) refactor of try_append_late_arrival_runtime_filter (#59786)
This pull request refactors and simplifies the handling of late-arriving runtime filters and conjunct context cloning in the scan pipeline. The main changes include streamlining the interfaces for applying runtime filters, improving thread safety with new locking mechanisms, and removing redundant or duplicated code. The changes also clarify ownership and lifecycle of conjunct expressions to prevent concurrent access issues. **Runtime filter and conjunct management improvements:** * Refactored `try_append_late_arrival_runtime_filter` in `RuntimeFilterConsumerHelper` to use references instead of pointers for `arrived_rf_num` and conjuncts, and updated all call sites accordingly for clearer and safer usage. [[1]](diffhunk://#diff-ed4cbc22dcb1b5d27652827cea0f12373591a9b06e3c857f0dd0e32f58422026L99-R110) [[2]](diffhunk://#diff-61d96ad649abf519ee21143b6a4d9ed0c1b820ba273281ca8650a1e047d10f15L47-R50) [[3]](diffhunk://#diff-04a5f666c19cc90dfb8f222f1fadc43f08fa2d59f5ae61e2889e615e3cffc35dL101-R101) [[4]](diffhunk://#diff-2c575051a29b06200611882d17cb4c0fea6df46659e8ea953c705aaca2c2b5a4L232-R245) * Removed the redundant `clone_conjunct_ctxs` method from `RuntimeFilterConsumerHelper` and moved conjunct cloning logic into `ScanLocalStateBase`, introducing new methods `update_late_arrival_runtime_filter` and `clone_conjunct_ctxs` for better encapsulation. [[1]](diffhunk://#diff-ac38473f151ccd99db4ed80dfbfa176f4f957ae2f5335ce8fbb4f5dbb0e932e9R76-R91) [[2]](diffhunk://#diff-f5a0db9faf0b649227b0126cca493d8dce22c9d497116fd480d7d018ce1696d2R91-R94) [[3]](diffhunk://#diff-ed4cbc22dcb1b5d27652827cea0f12373591a9b06e3c857f0dd0e32f58422026L123-R128) [[4]](diffhunk://#diff-61d96ad649abf519ee21143b6a4d9ed0c1b820ba273281ca8650a1e047d10f15L47-R50) [[5]](diffhunk://#diff-2c575051a29b06200611882d17cb4c0fea6df46659e8ea953c705aaca2c2b5a4L232-R245) **Thread safety enhancements:** * Added a `std::mutex _conjuncts_lock` to `ScanLocalStateBase` and used it to guard access to `_conjuncts` for thread-safe updates and cloning. [[1]](diffhunk://#diff-f5a0db9faf0b649227b0126cca493d8dce22c9d497116fd480d7d018ce1696d2R21) [[2]](diffhunk://#diff-f5a0db9faf0b649227b0126cca493d8dce22c9d497116fd480d7d018ce1696d2R128) [[3]](diffhunk://#diff-ac38473f151ccd99db4ed80dfbfa176f4f957ae2f5335ce8fbb4f5dbb0e932e9R76-R91) [[4]](diffhunk://#diff-f5a0db9faf0b649227b0126cca493d8dce22c9d497116fd480d7d018ce1696d2R91-R94) **Scanner and file scanner lifecycle fixes:** * Changed handling of conjuncts in `FileScanner` and `Scanner` to avoid destroying conjuncts that may still be in use, by explicitly moving them to a `_stale_expr_ctxs` vector before clearing. Removed the `_discard_conjuncts` method and replaced it with direct management. [[1]](diffhunk://#diff-6afbc092caa913a8775be9772777060161de5608b9aae939202e963e8aaf4e8bL360-L366) [[2]](diffhunk://#diff-2c575051a29b06200611882d17cb4c0fea6df46659e8ea953c705aaca2c2b5a4L232-R245) [[3]](diffhunk://#diff-17432beb88ab0d918d9bbe41b3ba500e3f5102645896e89587a4dc43bcab2125L192-L198) **Minor interface improvements:** * Made `Scanner::is_open()` a `const` method for correctness.
1 parent b80be52 commit e78d089

9 files changed

Lines changed: 47 additions & 54 deletions

File tree

‎be/src/pipeline/exec/multi_cast_data_stream_source.cpp‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,10 @@ Status MultiCastDataStreamerSourceOperatorX::get_block(RuntimeState* state,
9797
}
9898

9999
int arrived_rf_num = 0;
100+
// No lock needed here because this is single-threaded execution without scanners
101+
// and no concurrent access to _conjuncts
100102
RETURN_IF_ERROR(local_state._helper.try_append_late_arrival_runtime_filter(
101-
state, &arrived_rf_num, local_state._conjuncts, _multi_cast_output_row_descriptor));
103+
state, _multi_cast_output_row_descriptor, arrived_rf_num, local_state._conjuncts));
102104

103105
if (!local_state._conjuncts.empty() && !output_block->empty()) {
104106
SCOPED_TIMER(local_state._filter_timer);

‎be/src/pipeline/exec/scan_operator.cpp‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,24 @@ bool ScanLocalState<Derived>::should_run_serial() const {
7373
return _parent->cast<typename Derived::Parent>()._should_run_serial;
7474
}
7575

76+
Status ScanLocalStateBase::update_late_arrival_runtime_filter(RuntimeState* state,
77+
int& arrived_rf_num) {
78+
// Lock needed because _conjuncts can be accessed concurrently by multiple scanner threads
79+
std::unique_lock lock(_conjuncts_lock);
80+
return _helper.try_append_late_arrival_runtime_filter(state, _parent->row_descriptor(),
81+
arrived_rf_num, _conjuncts);
82+
}
83+
84+
Status ScanLocalStateBase::clone_conjunct_ctxs(vectorized::VExprContextSPtrs& scanner_conjuncts) {
85+
// Lock needed because _conjuncts can be accessed concurrently by multiple scanner threads
86+
std::unique_lock lock(_conjuncts_lock);
87+
scanner_conjuncts.resize(_conjuncts.size());
88+
for (size_t i = 0; i != _conjuncts.size(); ++i) {
89+
RETURN_IF_ERROR(_conjuncts[i]->clone(_state, scanner_conjuncts[i]));
90+
}
91+
return Status::OK();
92+
}
93+
7694
int ScanLocalStateBase::max_scanners_concurrency(RuntimeState* state) const {
7795
// For select * from table limit 10; should just use one thread.
7896
if (should_run_serial()) {

‎be/src/pipeline/exec/scan_operator.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
#pragma once
1919

2020
#include <cstdint>
21+
#include <mutex>
2122
#include <string>
2223

2324
#include "common/status.h"
@@ -87,6 +88,10 @@ class ScanLocalStateBase : public PipelineXLocalState<> {
8788

8889
uint64_t get_condition_cache_digest() const { return _condition_cache_digest; }
8990

91+
Status update_late_arrival_runtime_filter(RuntimeState* state, int& arrived_rf_num);
92+
93+
Status clone_conjunct_ctxs(vectorized::VExprContextSPtrs& scanner_conjuncts);
94+
9095
protected:
9196
friend class vectorized::ScannerContext;
9297
friend class vectorized::Scanner;
@@ -120,6 +125,7 @@ class ScanLocalStateBase : public PipelineXLocalState<> {
120125
RuntimeProfile::Counter* _scan_rows = nullptr;
121126
RuntimeProfile::Counter* _scan_bytes = nullptr;
122127

128+
std::mutex _conjuncts_lock;
123129
RuntimeFilterConsumerHelper _helper;
124130
// magic number as seed to generate hash value for condition cache
125131
uint64_t _condition_cache_digest = 0;

‎be/src/runtime_filter/runtime_filter_consumer_helper.cpp‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -96,18 +96,18 @@ Status RuntimeFilterConsumerHelper::_append_rf_into_conjuncts(
9696
}
9797

9898
Status RuntimeFilterConsumerHelper::try_append_late_arrival_runtime_filter(
99-
RuntimeState* state, int* arrived_rf_num, vectorized::VExprContextSPtrs& conjuncts,
100-
const RowDescriptor& row_descriptor) {
99+
RuntimeState* state, const RowDescriptor& row_descriptor, int& arrived_rf_num,
100+
vectorized::VExprContextSPtrs& arrived_conjuncts) {
101101
if (_is_all_rf_applied) {
102-
*arrived_rf_num = cast_set<int>(_runtime_filter_descs.size());
102+
arrived_rf_num = cast_set<int>(_runtime_filter_descs.size());
103103
return Status::OK();
104104
}
105105

106106
// This method will be called in scanner thread.
107107
// So need to add lock
108108
std::unique_lock l(_rf_locks);
109109
if (_is_all_rf_applied) {
110-
*arrived_rf_num = cast_set<int>(_runtime_filter_descs.size());
110+
arrived_rf_num = cast_set<int>(_runtime_filter_descs.size());
111111
return Status::OK();
112112
}
113113

@@ -120,24 +120,12 @@ Status RuntimeFilterConsumerHelper::try_append_late_arrival_runtime_filter(
120120
}
121121
// 2. Append unapplied runtime filters to _conjuncts
122122
if (!exprs.empty()) {
123-
RETURN_IF_ERROR(_append_rf_into_conjuncts(state, exprs, conjuncts, row_descriptor));
123+
RETURN_IF_ERROR(_append_rf_into_conjuncts(state, exprs, arrived_conjuncts, row_descriptor));
124124
}
125125
if (current_arrived_rf_num == _runtime_filter_descs.size()) {
126126
_is_all_rf_applied = true;
127127
}
128-
129-
*arrived_rf_num = current_arrived_rf_num;
130-
return Status::OK();
131-
}
132-
133-
Status RuntimeFilterConsumerHelper::clone_conjunct_ctxs(
134-
RuntimeState* state, vectorized::VExprContextSPtrs& scanner_conjuncts,
135-
vectorized::VExprContextSPtrs& local_state_conjuncts) {
136-
std::unique_lock l(_rf_locks);
137-
scanner_conjuncts.resize(local_state_conjuncts.size());
138-
for (size_t i = 0; i != local_state_conjuncts.size(); ++i) {
139-
RETURN_IF_ERROR(local_state_conjuncts[i]->clone(state, scanner_conjuncts[i]));
140-
}
128+
arrived_rf_num = current_arrived_rf_num;
141129
return Status::OK();
142130
}
143131

‎be/src/runtime_filter/runtime_filter_consumer_helper.h‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,10 @@ class RuntimeFilterConsumerHelper {
4444
// The un-arrival filters will be checked every time the scanner is scheduled.
4545
// And once new runtime filters arrived, we will use it to do operator's filtering.
4646
// Called by Scanner.
47-
Status try_append_late_arrival_runtime_filter(RuntimeState* state, int* arrived_rf_num,
48-
vectorized::VExprContextSPtrs& conjuncts,
49-
const RowDescriptor& row_descriptor);
50-
51-
Status clone_conjunct_ctxs(RuntimeState* state,
52-
vectorized::VExprContextSPtrs& scanner_conjuncts,
53-
vectorized::VExprContextSPtrs& local_state_conjuncts);
47+
Status try_append_late_arrival_runtime_filter(RuntimeState* state,
48+
const RowDescriptor& row_descriptor,
49+
int& arrived_rf_num,
50+
vectorized::VExprContextSPtrs& arrived_conjuncts);
5451

5552
// Called by XXXLocalState::close()
5653
// parent_operator_profile is owned by LocalState so update it is safe at here.

‎be/src/vec/exec/scan/file_scanner.cpp‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -357,13 +357,9 @@ Status FileScanner::_process_late_arrival_conjuncts(bool* changed,
357357
*changed = false;
358358
if (_push_down_conjuncts.size() < _conjuncts.size()) {
359359
*changed = true;
360-
_push_down_conjuncts.clear();
361-
_push_down_conjuncts.resize(_conjuncts.size());
362-
for (size_t i = 0; i != _conjuncts.size(); ++i) {
363-
RETURN_IF_ERROR(_conjuncts[i]->clone(_state, _push_down_conjuncts[i]));
364-
}
360+
_push_down_conjuncts = _conjuncts;
361+
_conjuncts.clear();
365362
RETURN_IF_ERROR(_process_conjuncts());
366-
_discard_conjuncts();
367363
new_push_down_conjuncts = _push_down_conjuncts;
368364
}
369365
if (_applied_rf_num == _total_rf_num) {

‎be/src/vec/exec/scan/scanner.cpp‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -229,27 +229,20 @@ Status Scanner::try_append_late_arrival_runtime_filter() {
229229
return Status::OK();
230230
}
231231
DCHECK(_applied_rf_num < _total_rf_num);
232-
233232
int arrived_rf_num = 0;
234-
RETURN_IF_ERROR(_local_state->_helper.try_append_late_arrival_runtime_filter(
235-
_state, &arrived_rf_num, _local_state->_conjuncts,
236-
_local_state->_parent->row_descriptor()));
233+
RETURN_IF_ERROR(_local_state->update_late_arrival_runtime_filter(_state, arrived_rf_num));
237234

238235
if (arrived_rf_num == _applied_rf_num) {
239236
// No newly arrived runtime filters, just return;
240237
return Status::OK();
241238
}
242239

243-
// There are newly arrived runtime filters,
244-
// renew the _conjuncts
245-
if (!_conjuncts.empty()) {
246-
_discard_conjuncts();
240+
// avoid conjunct destroy in used by storage layer
241+
for (auto& conjunct : _conjuncts) {
242+
_stale_expr_ctxs.emplace_back(conjunct);
247243
}
248-
// Notice that the number of runtime filters may be larger than _applied_rf_num.
249-
// But it is ok because it will be updated at next time.
250-
RETURN_IF_ERROR(_local_state->_helper.clone_conjunct_ctxs(_state, _conjuncts,
251-
_local_state->_conjuncts));
252-
_applied_rf_num = arrived_rf_num;
244+
_conjuncts.clear();
245+
RETURN_IF_ERROR(_local_state->clone_conjunct_ctxs(_conjuncts));
253246
return Status::OK();
254247
}
255248

‎be/src/vec/exec/scan/scanner.h‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ class Scanner {
160160

161161
RuntimeState* runtime_state() { return _state; }
162162

163-
bool is_open() { return _is_open; }
163+
bool is_open() const { return _is_open; }
164164
void set_opened() { _is_open = true; }
165165

166166
virtual doris::TabletStorageType get_storage_type() {
@@ -189,13 +189,6 @@ class Scanner {
189189
void update_block_avg_bytes(size_t block_avg_bytes) { _block_avg_bytes = block_avg_bytes; }
190190

191191
protected:
192-
void _discard_conjuncts() {
193-
for (auto& conjunct : _conjuncts) {
194-
_stale_expr_ctxs.emplace_back(conjunct);
195-
}
196-
_conjuncts.clear();
197-
}
198-
199192
RuntimeState* _state = nullptr;
200193
pipeline::ScanLocalStateBase* _local_state = nullptr;
201194

‎be/test/runtime_filter/runtime_filter_consumer_helper_test.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ TEST_F(RuntimeFilterConsumerHelperTest, basic) {
102102
int arrived_rf_num = -1;
103103
helper._consumers[1]->signal(producer.get());
104104
FAIL_IF_ERROR_OR_CATCH_EXCEPTION(helper.try_append_late_arrival_runtime_filter(
105-
_runtime_states[0].get(), &arrived_rf_num, conjuncts, row_desc));
105+
_runtime_states[0].get(), row_desc, arrived_rf_num, conjuncts));
106106
ASSERT_EQ(conjuncts.size(), 1);
107107
ASSERT_EQ(arrived_rf_num, 2);
108108
}

0 commit comments

Comments
 (0)