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
|
/**
* 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 "mongo/db/query/canonical_query.h"
namespace mongo {
/**
* A runner runs a query.
*/
class Runner {
public:
virtual ~Runner() { }
enum RunnerState {
// We successfully populated the out parameter.
RUNNER_ADVANCED,
// We're EOF. We won't return any more results (edge case exception: capped+tailable).
RUNNER_EOF,
// We were killed or had an error.
RUNNER_DEAD,
// getNext was asked for data it cannot provide. This is an internal error and should
// not occur.
RUNNER_ERROR,
};
/**
* The yielding policy of the runner. By default, a runner does not yield itself
* (YIELD_MANUAL).
*/
enum YieldPolicy {
// Any call to getNext() may yield. In particular, the runner may be killed during any
// call to getNext(). If this occurs, getNext() will return RUNNER_DEAD.
//
// If you are enabling autoyield, you must register the Runner with ClientCursor via
// ClientCursor::registerRunner and deregister via ClientCursor::deregisterRunnerwhen
// done. Registered runners are informed about DiskLoc deletions and Namespace
// invalidations and other important events.
//
// Exception: This is not required if the Runner is cached inside of a ClientCursor.
// This is only done if the Runner is cached and can be referred to by a cursor id.
// This is not a popular thing to do.
YIELD_AUTO,
// Owner must yield manually if yields are requested. How to yield yourself:
//
// 0. Let's say you have Runner* runner.
//
// 1. Register your runner with ClientCursor. Registered runners are informed about
// DiskLoc deletions and Namespace invalidation and other important events. Do this by
// calling ClientCursor::registerRunner(runner). This could be done once when you get
// your runner, or per-yield.
//
// 2. Call runner->saveState() before you yield.
//
// 3. Call RunnerYieldPolicy::staticYield(runner->ns(), NULL) to yield. Any state that
// may change between yields must be checked by you. (For example, DiskLocs may not be
// valid across yielding, indices may be dropped, etc.)
//
// 4. Call runner->restoreState() before using the runner again.
//
// 5. Your runner's next call to getNext may return RUNNER_DEAD.
//
// 6. When you're done with your runner, deregister it from ClientCursor via
// ClientCursor::deregister(runner).
YIELD_MANUAL,
};
/**
* Set the yielding policy of the underlying runner. See the RunnerYieldPolicy enum above.
*/
virtual void setYieldPolicy(YieldPolicy policy) = 0;
/**
* Get the next result from the query.
*
* If objOut is not-NULL, it is filled with the next result, if there is one. If there is
* not, getNext returns RUNNER_ERROR.
*
* If dlOut is not-NULL:
* If objOut is unowned, dlOut is set to its associated DiskLoc.
* If objOut is owned, getNext returns RUNNER_ERROR.
*
* If the caller is running a query, they only care about the object.
* If the caller is an internal client, they may only care about DiskLocs (index scan), or
* about object + DiskLocs (collection scan).
*
* Some notes on objOut and ownership:
*
* objOut may be an owned object in certain cases: invalidation of the underlying DiskLoc,
* object is created from covered index key data, object is projected or otherwise the
* result of a computation.
*
* objOut will be unowned if it's the result of a fetch or a collection scan.
*/
virtual RunnerState getNext(BSONObj* objOut, DiskLoc* dlOut) = 0;
/**
* Will the next call to getNext() return EOF? It's useful to know if the runner is done
* without having to take responsibility for a result.
*/
virtual bool isEOF() = 0;
/**
* Inform the runner that the provided DiskLoc is about to disappear (or change entirely).
* The runner then takes any actions required to continue operating correctly, including
* broadcasting the invalidation request to the PlanStage tree being run.
*
* Called from ClientCursor::aboutToDelete.
*/
virtual void invalidate(const DiskLoc& dl) = 0;
/**
* Mark the Runner as no longer valid. Can happen when a runner yields and the underlying
* database is dropped/indexes removed/etc. All future to calls to getNext return
* RUNNER_DEAD. Every other call is a NOOP.
*/
virtual void kill() = 0;
/**
* Save any state required to yield.
*/
virtual void saveState() = 0;
/**
* Restore saved state, possibly after a yield. Return true if the runner is OK, false if
* it was killed.
*/
virtual bool restoreState() = 0;
/**
* Return the NS that the query is running over.
*/
virtual const string& ns() = 0;
};
} // namespace mongo
|
