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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
// dbclient.cpp - connect to a Mongo database as a database, from C++
/* Copyright 2009 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kNetwork
#include "mongo/platform/basic.h"
#include "mongo/client/dbclientcursor.h"
#include "mongo/client/connpool.h"
#include "mongo/db/dbmessage.h"
#include "mongo/db/namespace_string.h"
#include "mongo/rpc/factory.h"
#include "mongo/rpc/get_status_from_command_result.h"
#include "mongo/rpc/metadata.h"
#include "mongo/rpc/request_builder_interface.h"
#include "mongo/s/stale_exception.h"
#include "mongo/stdx/memory.h"
#include "mongo/util/debug_util.h"
#include "mongo/util/exit.h"
#include "mongo/util/log.h"
#include "mongo/util/scopeguard.h"
namespace mongo {
using std::unique_ptr;
using std::endl;
using std::string;
using std::vector;
namespace {
/**
* This code is mostly duplicated from DBClientWithCommands::runCommand. It may not
* be worth de-duplicating as this codepath will eventually be removed anyway.
*/
std::unique_ptr<Message> assembleCommandRequest(DBClientWithCommands* cli,
StringData database,
int legacyQueryOptions,
BSONObj legacyQuery) {
// TODO: Rewrite this to a common utility shared between this and DBClientMultiCommand.
// Can be an OP_COMMAND or OP_QUERY message.
auto requestBuilder =
rpc::makeRequestBuilder(cli->getClientRPCProtocols(), cli->getServerRPCProtocols());
BSONObj upconvertedCommand;
BSONObj upconvertedMetadata;
std::tie(upconvertedCommand, upconvertedMetadata) =
uassertStatusOK(rpc::upconvertRequestMetadata(std::move(legacyQuery), legacyQueryOptions));
BSONObjBuilder metadataBob;
metadataBob.appendElements(upconvertedMetadata);
if (cli->getRequestMetadataWriter()) {
uassertStatusOK(cli->getRequestMetadataWriter()(&metadataBob, cli->getServerAddress()));
}
requestBuilder->setDatabase(database);
// We need to get the command name from the upconverted command as it may have originally
// been wrapped.
requestBuilder->setCommandName(upconvertedCommand.firstElementFieldName());
requestBuilder->setMetadata(metadataBob.done());
requestBuilder->setCommandArgs(std::move(upconvertedCommand));
return requestBuilder->done();
}
} // namespace
int DBClientCursor::nextBatchSize() {
if (nToReturn == 0)
return batchSize;
if (batchSize == 0)
return nToReturn;
return batchSize < nToReturn ? batchSize : nToReturn;
}
void DBClientCursor::_assembleInit(Message& toSend) {
// If we haven't gotten a cursorId yet, we need to issue a new query or command.
if (!cursorId) {
// HACK:
// Unfortunately, this code is used by the shell to run commands,
// so we need to allow the shell to send invalid options so that we can
// test that the server rejects them. Thus, to allow generating commands with
// invalid options, we validate them here, and fall back to generating an OP_QUERY
// through assembleQueryRequest if the options are invalid.
bool hasValidNToReturnForCommand = (nToReturn == 1 || nToReturn == -1);
bool hasValidFlagsForCommand = !(opts & mongo::QueryOption_Exhaust);
if (_isCommand && hasValidNToReturnForCommand && hasValidFlagsForCommand) {
toSend =
std::move(*assembleCommandRequest(_client, nsToDatabaseSubstring(ns), opts, query));
return;
}
assembleQueryRequest(ns, query, nextBatchSize(), nToSkip, fieldsToReturn, opts, toSend);
return;
}
// Assemble a legacy getMore request.
BufBuilder b;
b.appendNum(opts);
b.appendStr(ns);
b.appendNum(nToReturn);
b.appendNum(cursorId);
toSend.setData(dbGetMore, b.buf(), b.len());
}
bool DBClientCursor::init() {
Message toSend;
_assembleInit(toSend);
verify(_client);
if (!_client->call(toSend, *batch.m, false, &_originalHost)) {
// log msg temp?
log() << "DBClientCursor::init call() failed" << endl;
return false;
}
if (batch.m->empty()) {
// log msg temp?
log() << "DBClientCursor::init message from call() was empty" << endl;
return false;
}
dataReceived();
return true;
}
void DBClientCursor::initLazy(bool isRetry) {
massert(15875,
"DBClientCursor::initLazy called on a client that doesn't support lazy",
_client->lazySupported());
Message toSend;
_assembleInit(toSend);
_client->say(toSend, isRetry, &_originalHost);
}
bool DBClientCursor::initLazyFinish(bool& retry) {
bool recvd = _client->recv(*batch.m);
// If we get a bad response, return false
if (!recvd || batch.m->empty()) {
if (!recvd)
log() << "DBClientCursor::init lazy say() failed" << endl;
if (batch.m->empty())
log() << "DBClientCursor::init message from say() was empty" << endl;
_client->checkResponse(NULL, -1, &retry, &_lazyHost);
return false;
}
dataReceived(retry, _lazyHost);
return !retry;
}
bool DBClientCursor::initCommand() {
BSONObj res;
bool ok = _client->runCommand(nsGetDB(ns), query, res, opts);
replyToQuery(0, *batch.m, res);
dataReceived();
return ok;
}
void DBClientCursor::requestMore() {
verify(cursorId && batch.pos == batch.nReturned);
if (haveLimit) {
nToReturn -= batch.nReturned;
verify(nToReturn > 0);
}
BufBuilder b;
b.appendNum(opts);
b.appendStr(ns);
b.appendNum(nextBatchSize());
b.appendNum(cursorId);
Message toSend;
toSend.setData(dbGetMore, b.buf(), b.len());
unique_ptr<Message> response(new Message());
if (_client) {
_client->call(toSend, *response);
this->batch.m = std::move(response);
dataReceived();
} else {
verify(_scopedHost.size());
ScopedDbConnection conn(_scopedHost);
conn->call(toSend, *response);
_client = conn.get();
ON_BLOCK_EXIT([this] { _client = nullptr; });
this->batch.m = std::move(response);
dataReceived();
conn.done();
}
}
/** with QueryOption_Exhaust, the server just blasts data at us (marked at end with cursorid==0). */
void DBClientCursor::exhaustReceiveMore() {
verify(cursorId && batch.pos == batch.nReturned);
verify(!haveLimit);
unique_ptr<Message> response(new Message());
verify(_client);
if (!_client->recv(*response)) {
uasserted(16465, "recv failed while exhausting cursor");
}
batch.m = std::move(response);
dataReceived();
}
void DBClientCursor::commandDataReceived() {
int op = batch.m->operation();
invariant(op == opReply || op == dbCommandReply);
batch.nReturned = 1;
batch.pos = 0;
auto commandReply = rpc::makeReply(batch.m.get());
auto commandStatus = getStatusFromCommandResult(commandReply->getCommandReply());
if (ErrorCodes::SendStaleConfig == commandStatus) {
throw RecvStaleConfigException("stale config in DBClientCursor::dataReceived()",
commandReply->getCommandReply());
} else if (!commandStatus.isOK()) {
wasError = true;
}
if (_client->getReplyMetadataReader()) {
uassertStatusOK(_client->getReplyMetadataReader()(commandReply->getMetadata(),
_client->getServerAddress()));
}
// HACK: If we got an OP_COMMANDREPLY, take the reply object
// and shove it in to an OP_REPLY message.
if (op == dbCommandReply) {
// Need to take ownership here as we destroy the underlying message.
BSONObj reply = commandReply->getCommandReply().getOwned();
batch.m = stdx::make_unique<Message>();
replyToQuery(0, *batch.m, reply);
}
QueryResult::View qr = batch.m->singleData().view2ptr();
batch.data = qr.data();
}
void DBClientCursor::dataReceived(bool& retry, string& host) {
// If this is a reply to our initial command request.
if (_isCommand && cursorId == 0) {
commandDataReceived();
return;
}
QueryResult::View qr = batch.m->singleData().view2ptr();
resultFlags = qr.getResultFlags();
if (qr.getResultFlags() & ResultFlag_ErrSet) {
wasError = true;
}
if (qr.getResultFlags() & ResultFlag_CursorNotFound) {
// cursor id no longer valid at the server.
invariant(qr.getCursorId() == 0);
if (!(opts & QueryOption_CursorTailable)) {
uasserted(13127,
str::stream() << "cursor id " << cursorId << " didn't exist on server.");
}
// 0 indicates no longer valid (dead)
cursorId = 0;
}
if (cursorId == 0 || !(opts & QueryOption_CursorTailable)) {
// only set initially: we don't want to kill it on end of data
// if it's a tailable cursor
cursorId = qr.getCursorId();
}
batch.nReturned = qr.getNReturned();
batch.pos = 0;
batch.data = qr.data();
_client->checkResponse(batch.data, batch.nReturned, &retry, &host); // watches for "not master"
if (qr.getResultFlags() & ResultFlag_ShardConfigStale) {
BSONObj error;
verify(peekError(&error));
throw RecvStaleConfigException(
(string) "stale config on lazy receive" + causedBy(getErrField(error)), error);
}
/* this assert would fire the way we currently work:
verify( nReturned || cursorId == 0 );
*/
}
/** If true, safe to call next(). Requests more from server if necessary. */
bool DBClientCursor::more() {
_assertIfNull();
if (!_putBack.empty())
return true;
if (haveLimit && batch.pos >= nToReturn)
return false;
if (batch.pos < batch.nReturned)
return true;
if (cursorId == 0)
return false;
requestMore();
return batch.pos < batch.nReturned;
}
BSONObj DBClientCursor::next() {
DEV _assertIfNull();
if (!_putBack.empty()) {
BSONObj ret = _putBack.top();
_putBack.pop();
return ret;
}
uassert(13422, "DBClientCursor next() called but more() is false", batch.pos < batch.nReturned);
batch.pos++;
BSONObj o(batch.data);
batch.data += o.objsize();
/* todo would be good to make data null at end of batch for safety */
return o;
}
BSONObj DBClientCursor::nextSafe() {
BSONObj o = next();
if (this->wasError && strcmp(o.firstElementFieldName(), "$err") == 0) {
std::string s = "nextSafe(): " + o.toString();
LOG(5) << s;
uasserted(13106, s);
}
return o;
}
void DBClientCursor::peek(vector<BSONObj>& v, int atMost) {
int m = atMost;
/*
for( stack<BSONObj>::iterator i = _putBack.begin(); i != _putBack.end(); i++ ) {
if( m == 0 )
return;
v.push_back(*i);
m--;
n++;
}
*/
int p = batch.pos;
const char* d = batch.data;
while (m && p < batch.nReturned) {
BSONObj o(d);
d += o.objsize();
p++;
m--;
v.push_back(o);
}
}
BSONObj DBClientCursor::peekFirst() {
vector<BSONObj> v;
peek(v, 1);
if (v.size() > 0)
return v[0];
else
return BSONObj();
}
bool DBClientCursor::peekError(BSONObj* error) {
if (!wasError)
return false;
vector<BSONObj> v;
peek(v, 1);
verify(v.size() == 1);
verify(hasErrField(v[0]));
if (error)
*error = v[0].getOwned();
return true;
}
void DBClientCursor::attach(AScopedConnection* conn) {
verify(_scopedHost.size() == 0);
verify(conn);
verify(conn->get());
if (conn->get()->type() == ConnectionString::SET ||
conn->get()->type() == ConnectionString::SYNC) {
if (_lazyHost.size() > 0)
_scopedHost = _lazyHost;
else if (_client)
_scopedHost = _client->getServerAddress();
else
massert(14821,
"No client or lazy client specified, cannot store multi-host connection.",
false);
} else {
_scopedHost = conn->getHost();
}
conn->done();
_client = 0;
_lazyHost = "";
}
DBClientCursor::DBClientCursor(DBClientBase* client,
const std::string& ns,
const BSONObj& query,
int nToReturn,
int nToSkip,
const BSONObj* fieldsToReturn,
int queryOptions,
int batchSize)
: DBClientCursor(client,
ns,
query,
0, // cursorId
nToReturn,
nToSkip,
fieldsToReturn,
queryOptions,
batchSize) {}
DBClientCursor::DBClientCursor(DBClientBase* client,
const std::string& ns,
long long cursorId,
int nToReturn,
int queryOptions)
: DBClientCursor(client,
ns,
BSONObj(), // query
cursorId,
nToReturn,
0, // nToSkip
nullptr, // fieldsToReturn
queryOptions,
0) {} // batchSize
DBClientCursor::DBClientCursor(DBClientBase* client,
const std::string& ns,
const BSONObj& query,
long long cursorId,
int nToReturn,
int nToSkip,
const BSONObj* fieldsToReturn,
int queryOptions,
int batchSize)
: _client(client),
_originalHost(_client->getServerAddress()),
ns(ns),
_isCommand(nsIsFull(ns) ? nsToCollectionSubstring(ns) == "$cmd" : false),
query(query),
nToReturn(nToReturn),
haveLimit(nToReturn > 0 && !(queryOptions & QueryOption_CursorTailable)),
nToSkip(nToSkip),
fieldsToReturn(fieldsToReturn),
opts(queryOptions),
batchSize(batchSize == 1 ? 2 : batchSize),
resultFlags(0),
cursorId(cursorId),
_ownCursor(true),
wasError(false) {}
DBClientCursor::~DBClientCursor() {
kill();
}
void DBClientCursor::kill() {
DESTRUCTOR_GUARD(
if (cursorId && _ownCursor && !inShutdown()) {
if (_client) {
_client->killCursor(cursorId);
} else {
verify(_scopedHost.size());
ScopedDbConnection conn(_scopedHost);
conn->killCursor(cursorId);
conn.done();
}
}
);
// Mark this cursor as dead since we can't do any getMores.
cursorId = 0;
}
} // namespace mongo
|