summaryrefslogtreecommitdiff
path: root/src/mongo/db/clientcursor.h
blob: a145802e985bfd29175a77a104d7822d1a36922f (plain)
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
/**
 *    Copyright (C) 2008 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/jsobj.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/record_id.h"
#include "mongo/s/collection_metadata.h"
#include "mongo/util/net/message.h"

namespace mongo {

class ClientCursor;
class Collection;
class CursorManager;
class RecoveryUnit;

typedef long long CursorId; /* passed to the client so it can send back on getMore */
static const CursorId INVALID_CURSOR_ID = -1;  // But see SERVER-5726.

/**
 * ClientCursor is a wrapper that represents a cursorid from our database application's
 * perspective.
 */
class ClientCursor {
    MONGO_DISALLOW_COPYING(ClientCursor);

public:
    /**
     * This ClientCursor constructor creates a cursorid that can be used with getMore and
     * killCursors.  "cursorManager" is the object that will manage the lifetime of this
     * cursor, and "ns" is the namespace string that should be associated with this cursor (e.g.
     * "test.foo", "test.$cmd.listCollections", etc).
     */
    ClientCursor(CursorManager* cursorManager,
                 PlanExecutor* exec,
                 const std::string& ns,
                 int qopts = 0,
                 const BSONObj query = BSONObj(),
                 bool isAggCursor = false);

    /**
     * This ClientCursor is used to track sharding state for the given collection.
     */
    explicit ClientCursor(const Collection* collection);

    //
    // Basic accessors
    //

    CursorId cursorid() const {
        return _cursorid;
    }
    std::string ns() const {
        return _ns;
    }
    CursorManager* cursorManager() const {
        return _cursorManager;
    }
    bool isAggCursor() const {
        return _isAggCursor;
    }

    //
    // Pinning functionality.
    //

    /**
     * Marks this ClientCursor as in use.  unsetPinned() must be called before the destructor of
     * this ClientCursor is invoked.
     */
    void setPinned() {
        _isPinned = true;
    }

    /**
     * Marks this ClientCursor as no longer in use.
     */
    void unsetPinned() {
        _isPinned = false;
    }

    bool isPinned() const {
        return _isPinned;
    }

    /**
     * This is called when someone is dropping a collection or something else that
     * goes through killing cursors.
     * It removes the responsiilibty of de-registering from ClientCursor.
     * Responsibility for deleting the ClientCursor doesn't change from this call
     * see PlanExecutor::kill.
     */
    void kill();

    //
    // Timing and timeouts
    //

    /**
     * @param millis amount of idle passed time since last call
     * note called outside of locks (other than ccmutex) so care must be exercised
     */
    bool shouldTimeout(int millis);
    void setIdleTime(int millis);
    int idleTime() const {
        return _idleAgeMillis;
    }

    uint64_t getLeftoverMaxTimeMicros() const {
        return _leftoverMaxTimeMicros;
    }
    void setLeftoverMaxTimeMicros(uint64_t leftoverMaxTimeMicros) {
        _leftoverMaxTimeMicros = leftoverMaxTimeMicros;
    }

    //
    // Replication-related stuff.  TODO: Document and clean.
    //

    // Used to report replication position only in master-slave,
    // so we keep them as TimeStamp rather than OpTime.
    void updateSlaveLocation(OperationContext* txn);
    void slaveReadTill(const Timestamp& t) {
        _slaveReadTill = t;
    }
    /** Just for testing. */
    Timestamp getSlaveReadTill() const {
        return _slaveReadTill;
    }

    //
    // Query-specific functionality that may be adapted for the PlanExecutor.
    //

    PlanExecutor* getExecutor() const {
        return _exec.get();
    }
    int queryOptions() const {
        return _queryOptions;
    }
    const BSONObj& getQuery() const {
        return _query;
    }

    // Used by ops/query.cpp to stash how many results have been returned by a query.
    int pos() const {
        return _pos;
    }
    void incPos(int n) {
        _pos += n;
    }
    void setPos(int n) {
        _pos = n;
    }

    static long long totalOpen();

    //
    // Storage engine state for getMore.
    //

    bool hasRecoveryUnit() const {
        return _ownedRU.get() || _unownedRU;
    }

    /**
     *
     * If a ClientCursor is created via DBDirectClient, it uses the same storage engine
     * context as the DBDirectClient caller.  We store this context in _unownedRU.  We use
     * this to verify that all further callers use the same RecoveryUnit.
     *
     * Once a ClientCursor has an unowned RecoveryUnit, it will always have one.
     *
     * Sets the unowned RecoveryUnit to 'ru'.  Does NOT take ownership of the pointer.
     */
    void setUnownedRecoveryUnit(RecoveryUnit* ru);

    /**
     * Return the unowned RecoveryUnit.  'this' does not own pointer and therefore cannot
     * transfer ownership.
     */
    RecoveryUnit* getUnownedRecoveryUnit() const;

    /**
     * If a ClientCursor is created via a client request, we bind its lifetime to the
     * ClientCursor's by storing it un _ownedRU.  In order to execute the query over repeated
     * network requests, we have to keep the execution state around.
     */

    /**
     * Set the owned recovery unit to 'ru'.  Takes ownership of it.  If there is a previous
     * owned recovery unit, it is deleted.
     */
    void setOwnedRecoveryUnit(RecoveryUnit* ru);

    /**
     * Returns the owned recovery unit.  Ownership is transferred to the caller.
     */
    RecoveryUnit* releaseOwnedRecoveryUnit();

private:
    friend class CursorManager;
    friend class ClientCursorPin;

    /**
     * Only friends are allowed to destroy ClientCursor objects.
     */
    ~ClientCursor();

    /**
     * Initialization common between both constructors for the ClientCursor. The database must
     * be stable when this is called, because cursors hang off the collection.
     */
    void init();

    //
    // ClientCursor-specific data, independent of the underlying execution type.
    //

    // The ID of the ClientCursor.
    CursorId _cursorid;

    // The namespace we're operating on.
    std::string _ns;

    CursorManager* _cursorManager;

    // if we've added it to the total open counter yet
    bool _countedYet;

    // How many objects have been returned by the find() so far?
    int _pos;

    // If this cursor was created by a find operation, '_query' holds the query predicate for
    // the find. If this cursor was created by a command (e.g. the aggregate command), then
    // '_query' holds the command specification received from the client.
    BSONObj _query;

    // See the QueryOptions enum in dbclient.h
    int _queryOptions;

    // Is this ClientCursor backed by an aggregation pipeline?  Defaults to false.
    //
    // Agg executors differ from others in that they manage their own locking internally and
    // should not be killed or destroyed when the underlying collection is deleted.
    //
    // Note: This should *not* be set for the internal cursor used as input to an aggregation.
    bool _isAggCursor;

    // Is this cursor in use?  Defaults to false.
    bool _isPinned;

    // Is the "no timeout" flag set on this cursor?  If false, this cursor may be targeted for
    // deletion after an interval of inactivity.  Defaults to false.
    bool _isNoTimeout;

    // The replication position only used in master-slave.
    Timestamp _slaveReadTill;

    // How long has the cursor been idle?
    int _idleAgeMillis;

    // TODO: Document.
    uint64_t _leftoverMaxTimeMicros;

    // For chunks that are being migrated, there is a period of time when that chunks data is in
    // two shards, the donor and the receiver one. That data is picked up by a cursor on the
    // receiver side, even before the migration was decided.  The CollectionMetadata allow one
    // to inquiry if any given document of the collection belongs indeed to this shard or if it
    // is coming from (or a vestige of) an ongoing migration.
    CollectionMetadataPtr _collMetadata;

    // Only one of these is not-NULL.
    RecoveryUnit* _unownedRU;
    std::unique_ptr<RecoveryUnit> _ownedRU;
    // NOTE: _ownedRU must come before _exec, because _ownedRU must outlive _exec.
    // The storage engine can have resources in the PlanExecutor that rely on
    // the RecoveryUnit being alive.

    //
    // The underlying execution machinery.
    //
    std::unique_ptr<PlanExecutor> _exec;
};

/**
 * ClientCursorPin is an RAII class that manages the pinned state of a ClientCursor.
 * ClientCursorPin objects pin the given cursor upon construction, and release the pin upon
 * destruction.
 *
 * A pin extends the lifetime of a ClientCursor object until the pin's release.  Pinned
 * ClientCursor objects cannot not be killed due to inactivity, and cannot be killed by user
 * kill requests.  When a CursorManager is destroyed (e.g. by a collection drop), ownership of
 * any still-pinned ClientCursor objects is transferred to their managing ClientCursorPin
 * objects.
 *
 * Example usage:
 * {
 *     ClientCursorPin pin(cursorManager, cursorid);
 *     ClientCursor* cursor = pin.c();
 *     if (cursor) {
 *         // Use cursor.
 *     }
 *     // Pin automatically released on block exit.
 * }
 *
 * Clients that wish to access ClientCursor objects owned by collection cursor managers must
 * hold the collection lock during pin acquisition and pin release.  This guards from a
 * collection drop (which requires an exclusive lock on the collection) occurring concurrently
 * with the pin request or unpin request.
 *
 * Clients that wish to access ClientCursor objects owned by the global cursor manager need not
 * hold any locks; the global cursor manager can only be destroyed by a process exit.
 */
class ClientCursorPin {
    MONGO_DISALLOW_COPYING(ClientCursorPin);

public:
    /**
     * Asks "cursorManager" to set a pin on the ClientCursor associated with "cursorid".  If no
     * such cursor exists, does nothing.  If the cursor is already pinned, throws a
     * UserException.
     */
    ClientCursorPin(CursorManager* cursorManager, long long cursorid);

    /**
     * Calls release().
     */
    ~ClientCursorPin();

    /**
     * Releases the pin.  It does not delete the underlying cursor unless ownership has passed
     * to us after kill.  Turns into a no-op if release() or deleteUnderlying() have already
     * been called on this pin.
     */
    void release();

    /**
     * Deletes the underlying cursor.  Cannot be called if release() or deleteUnderlying() have
     * already been called on this pin.
     */
    void deleteUnderlying();

    ClientCursor* c() const;

private:
    ClientCursor* _cursor;
};

void startClientCursorMonitor();

}  // namespace mongo