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
|
/**
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <boost/scoped_ptr.hpp>
#include <queue>
#include <vector>
#include "mongo/db/exec/working_set.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/query/canonical_query.h"
#include "mongo/db/query/lite_parsed_query.h"
#include "mongo/db/query/plan_ranker.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/query/runner.h"
#include "mongo/platform/cstdint.h"
namespace mongo {
using std::queue;
using std::size_t;
using std::vector;
/**
* Runs several plans in parallel and picks the best one. Caches the selection for future use.
*/
class MultiPlanRunner : public Runner {
public:
/**
* Takes ownership of query.
*/
MultiPlanRunner(CanonicalQuery* query);
virtual ~MultiPlanRunner();
/**
* Takes ownership of all arguments
*/
void addPlan(QuerySolution* solution, PlanStage* root, WorkingSet* ws);
/**
* Get the next result. Yielding is handled internally. If a best plan is not picked when
* this is called, we call pickBestPlan() internally.
*/
Runner::RunnerState getNext(BSONObj* objOut, DiskLoc* dlOut);
virtual bool isEOF();
/**
* Runs all plans added by addPlan, ranks them, and picks a best. Deletes all loser plans.
* All further calls to getNext(...) will return results from the best plan.
*
* Returns true if a best plan was picked, false if there was an error.
*
* If out is not-NULL, set *out to the index of the picked plan.
*/
bool pickBestPlan(size_t* out);
virtual void saveState();
virtual bool restoreState();
virtual void invalidate(const DiskLoc& dl);
virtual void setYieldPolicy(Runner::YieldPolicy policy);
virtual const string& ns() { return _query->getParsed().ns(); }
virtual void kill();
private:
/**
* Have all our candidate plans do something.
*/
bool workAllPlans();
void allPlansSaveState();
void allPlansRestoreState();
// Did some plan fail while we were running it to compare against other plans? Just give up
// if so. Also set if we were killed during a yield.
bool _failure;
// We need to cache this so that when we switch from running our candidates to using a
// PlanExecutor, we can set the right yielding policy on it.
Runner::YieldPolicy _policy;
// The winner of the plan competition...
scoped_ptr<PlanExecutor> _bestPlan;
// ...and any results it produced while working toward winning.
std::queue<WorkingSetID> _alreadyProduced;
// Candidate plans.
vector<CandidatePlan> _candidates;
// Yielding policy we use when we're running candidates.
scoped_ptr<RunnerYieldPolicy> _yieldPolicy;
// The query that we're trying to figure out the best solution to.
scoped_ptr<CanonicalQuery> _query;
};
} // namespace mongo
|