1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/**
* Copyright (C) 2019-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <queue>
#include "mongo/db/exec/sbe/stages/stages.h"
#include "mongo/db/query/optimizer/explain_interface.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/query/plan_explainer_sbe.h"
#include "mongo/db/query/plan_yield_policy_sbe.h"
#include "mongo/db/query/sbe_plan_ranker.h"
#include "mongo/db/query/sbe_runtime_planner.h"
#include "mongo/db/query/sbe_stage_builder.h"
namespace mongo {
class PlanExecutorSBE final : public PlanExecutor {
public:
PlanExecutorSBE(OperationContext* opCtx,
std::unique_ptr<CanonicalQuery> cq,
std::unique_ptr<optimizer::AbstractABTPrinter> optimizerData,
sbe::CandidatePlans candidates,
const CollectionPtr& collection,
bool returnOwnedBson,
NamespaceString nss,
bool isOpen,
std::unique_ptr<PlanYieldPolicySBE> yieldPolicy);
CanonicalQuery* getCanonicalQuery() const override {
return _cq.get();
}
const NamespaceString& nss() const override {
return _nss;
}
OperationContext* getOpCtx() const override {
return _opCtx;
}
void saveState();
void restoreState(const RestoreContext& context);
void detachFromOperationContext();
void reattachToOperationContext(OperationContext* opCtx);
ExecState getNext(BSONObj* out, RecordId* dlOut) override;
ExecState getNextDocument(Document* objOut, RecordId* dlOut) override;
bool isEOF() override {
return isMarkedAsKilled() || (_stash.empty() && _root->getCommonStats()->isEOF);
}
long long executeCount() override {
// Using SBE to execute a count command is not yet supported.
MONGO_UNREACHABLE;
}
UpdateResult executeUpdate() override {
// Using SBE to execute an update command is not yet supported.
MONGO_UNREACHABLE;
}
UpdateResult getUpdateResult() const override {
// Using SBE to execute an update command is not yet supported.
MONGO_UNREACHABLE;
}
long long executeDelete() override {
// Using SBE to execute a delete command is not yet supported.
MONGO_UNREACHABLE;
}
void markAsKilled(Status killStatus);
void dispose(OperationContext* opCtx);
void stashResult(const BSONObj& obj);
bool isMarkedAsKilled() const override {
return !_killStatus.isOK();
}
Status getKillStatus() override {
invariant(isMarkedAsKilled());
return _killStatus;
}
bool isDisposed() const override {
return _isDisposed;
}
Timestamp getLatestOplogTimestamp() const override;
BSONObj getPostBatchResumeToken() const override;
/**
* Even though the leaves of '_root' will acquire AutoGet objects, the caller must acquire a top
* level AutoGet object outside of this PlanExecutor in order to open a storage transaction and
* establish a consistent view of the catalog.
*/
LockPolicy lockPolicy() const override {
return LockPolicy::kLockExternally;
}
const PlanExplainer& getPlanExplainer() const final {
invariant(_planExplainer);
return *_planExplainer;
}
void enableSaveRecoveryUnitAcrossCommandsIfSupported() override {
_isSaveRecoveryUnitAcrossCommandsEnabled = true;
}
bool isSaveRecoveryUnitAcrossCommandsEnabled() const override {
return _isSaveRecoveryUnitAcrossCommandsEnabled;
}
private:
enum class State { kClosed, kOpened };
State _state{State::kClosed};
OperationContext* _opCtx;
NamespaceString _nss;
const bool _mustReturnOwnedBson;
// CompileCtx owns the instance pointed by _env, so we must keep it around.
const std::unique_ptr<sbe::PlanStage> _root;
stage_builder::PlanStageData _rootData;
std::unique_ptr<QuerySolution> _solution;
sbe::value::SlotAccessor* _result{nullptr};
sbe::value::SlotAccessor* _resultRecordId{nullptr};
sbe::value::TypeTags _tagLastRecordId{sbe::value::TypeTags::Nothing};
sbe::value::Value _valLastRecordId{0};
sbe::RuntimeEnvironment::Accessor* _oplogTs{nullptr};
boost::optional<sbe::value::SlotId> _resumeRecordIdSlot;
std::deque<std::pair<BSONObj, boost::optional<RecordId>>> _stash;
// If we are returning owned result (i.e. value is moved out of the result accessor) then its
// lifetime must extend up to the next getNext (or saveState).
BSONObj _lastGetNext;
// If _killStatus has a non-OK value, then we have been killed and the value represents the
// reason for the kill.
Status _killStatus = Status::OK();
std::unique_ptr<CanonicalQuery> _cq;
std::unique_ptr<PlanYieldPolicySBE> _yieldPolicy;
std::unique_ptr<PlanExplainer> _planExplainer;
bool _isDisposed{false};
bool _isSaveRecoveryUnitAcrossCommandsEnabled = false;
};
/**
* Executes getNext() on the 'root' PlanStage and used 'resultSlot' and 'recordIdSlot' to access the
* fetched document and it's record id, which are stored in 'out' and 'dlOut' parameters
* respectively, if they not null pointers.
*
* This common logic can be used by various consumers which need to fetch data using an SBE
* PlanStage tree, such as PlanExecutor or RuntimePlanner.
*/
sbe::PlanState fetchNext(sbe::PlanStage* root,
sbe::value::SlotAccessor* resultSlot,
sbe::value::SlotAccessor* recordIdSlot,
BSONObj* out,
RecordId* dlOut,
bool returnOwnedBson);
} // namespace mongo
|
