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
|
/**
* Copyright (C) 2020-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 "mongo/db/exec/sbe/stages/stages.h"
#include "mongo/db/query/optimizer/explain_interface.h"
#include "mongo/db/query/plan_cache_debug_info.h"
#include "mongo/db/query/plan_explainer.h"
#include "mongo/db/query/query_solution.h"
#include "mongo/db/query/sbe_plan_ranker.h"
namespace mongo {
/**
* A PlanExplainer implementation for SBE execution plans.
*/
class PlanExplainerSBE final : public PlanExplainer {
public:
PlanExplainerSBE(const sbe::PlanStage* root,
const stage_builder::PlanStageData* data,
const QuerySolution* solution,
std::unique_ptr<optimizer::AbstractABTPrinter> optimizerData,
std::vector<sbe::plan_ranker::CandidatePlan> rejectedCandidates,
bool isMultiPlan,
bool isCachedPlan,
std::shared_ptr<const plan_cache_debug_info::DebugInfoSBE> debugInfo)
: PlanExplainer{solution},
_root{root},
_rootData{data},
_solution{solution},
_optimizerData(std::move(optimizerData)),
_rejectedCandidates{std::move(rejectedCandidates)},
_isMultiPlan{isMultiPlan},
_isFromPlanCache{isCachedPlan},
_debugInfo{debugInfo} {
tassert(5968203, "_debugInfo should not be null", _debugInfo);
}
bool isMultiPlan() const final {
return _isMultiPlan;
}
bool isFromCache() const {
return _isFromPlanCache;
}
const ExplainVersion& getVersion() const final;
std::string getPlanSummary() const final;
void getSummaryStats(PlanSummaryStats* statsOut) const final;
void getSecondarySummaryStats(std::string secondaryColl,
PlanSummaryStats* statsOut) const override;
PlanStatsDetails getWinningPlanStats(ExplainOptions::Verbosity verbosity) const final;
PlanStatsDetails getWinningPlanTrialStats() const final;
std::vector<PlanStatsDetails> getRejectedPlansStats(
ExplainOptions::Verbosity verbosity) const final;
std::vector<PlanStatsDetails> getCachedPlanStats(const plan_cache_debug_info::DebugInfo&,
ExplainOptions::Verbosity) const final;
private:
static boost::optional<BSONObj> buildExecPlanDebugInfo(
const sbe::PlanStage* root, const stage_builder::PlanStageData* data) {
if (root && data) {
return BSON("slots" << data->debugString() << "stages"
<< sbe::DebugPrinter().print(*root));
}
return boost::none;
}
boost::optional<BSONObj> buildCascadesPlan() const;
// These fields are are owned elsewhere (e.g. the PlanExecutor or CandidatePlan).
const sbe::PlanStage* _root{nullptr};
const stage_builder::PlanStageData* _rootData{nullptr};
const QuerySolution* _solution{nullptr};
const std::unique_ptr<optimizer::AbstractABTPrinter> _optimizerData;
const std::vector<sbe::plan_ranker::CandidatePlan> _rejectedCandidates;
const bool _isMultiPlan{false};
const bool _isFromPlanCache{false};
// Pre-computed debugging info so we don't necessarily have to collect them from QuerySolution.
// All plans recovered from the same cached entry share the same debug info.
const std::shared_ptr<const plan_cache_debug_info::DebugInfoSBE> _debugInfo;
};
} // namespace mongo
|
