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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
|
/**
* Copyright (C) 2018-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.
*/
#include "mongo/platform/basic.h"
#include "mongo/client/dbclient_cursor.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/client.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/dbdirectclient.h"
#include "mongo/db/exec/collection_scan.h"
#include "mongo/db/exec/count_scan.h"
#include "mongo/db/exec/working_set.h"
#include "mongo/db/json.h"
#include "mongo/db/matcher/expression_parser.h"
#include "mongo/dbtests/dbtests.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/fail_point_registry.h"
#include "mongo/util/fail_point_service.h"
namespace QueryStageCountScan {
using std::shared_ptr;
class CountBase {
public:
CountBase() : _client(&_opCtx) {}
virtual ~CountBase() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
_client.dropCollection(ns());
}
void addIndex(const BSONObj& obj) {
ASSERT_OK(dbtests::createIndex(&_opCtx, ns(), obj));
}
void insert(const BSONObj& obj) {
_client.insert(ns(), obj);
}
void remove(const BSONObj& obj) {
_client.remove(ns(), obj);
}
/*
* Given a CountScan PlanStage object count, call work() on
* count until we reach IS_EOF. Tally up how many objects
* we've counted and return the count.
*/
int runCount(CountScan* count) {
int countWorks = 0;
WorkingSetID wsid;
PlanStage::StageState countState = count->work(&wsid);
while (PlanStage::IS_EOF != countState) {
if (PlanStage::ADVANCED == countState)
countWorks++;
countState = count->work(&wsid);
}
return countWorks;
}
const IndexDescriptor* getIndex(Database* db, const BSONObj& obj) {
Collection* collection =
CollectionCatalog::get(&_opCtx).lookupCollectionByNamespace(NamespaceString(ns()));
std::vector<const IndexDescriptor*> indexes;
collection->getIndexCatalog()->findIndexesByKeyPattern(&_opCtx, obj, false, &indexes);
return indexes.empty() ? nullptr : indexes[0];
}
CountScanParams makeCountScanParams(OperationContext* opCtx,
const IndexDescriptor* descriptor) {
return {opCtx, descriptor};
}
static const char* ns() {
return "unittests.QueryStageCountScanScan";
}
protected:
const ServiceContext::UniqueOperationContext _txnPtr = cc().makeOperationContext();
OperationContext& _opCtx = *_txnPtr;
private:
DBDirectClient _client;
};
//
// Check that dups are properly identified
//
class QueryStageCountScanDups : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert some docs
insert(BSON("a" << BSON_ARRAY(5 << 7)));
insert(BSON("a" << BSON_ARRAY(6 << 8)));
// Add an index on a:1
addIndex(BSON("a" << 1));
// Set up the count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("a" << 1);
params.startKeyInclusive = true;
params.endKey = BSON("a" << 10);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(2, numCounted);
}
};
//
// Check that expected results are returned with inclusive bounds
//
class QueryStageCountScanInclusiveBounds : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert some docs
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << i));
}
// Add an index
addIndex(BSON("a" << 1));
// Set up the count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 3);
params.startKeyInclusive = true;
params.endKey = BSON("" << 7);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(5, numCounted);
}
};
//
// Check that expected results are returned with exclusive bounds
//
class QueryStageCountScanExclusiveBounds : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert some docs
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << i));
}
// Add an index
addIndex(BSON("a" << 1));
// Set up the count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 3);
params.startKeyInclusive = false;
params.endKey = BSON("" << 7);
params.endKeyInclusive = false;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(3, numCounted);
}
};
//
// Check that cursor returns no results if all docs are below lower bound
//
class QueryStageCountScanLowerBound : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert doc, add index
insert(BSON("a" << 2));
addIndex(BSON("a" << 1));
// Set up count, and run
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 2);
params.startKeyInclusive = false;
params.endKey = BSON("" << 3);
params.endKeyInclusive = false;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(0, numCounted);
}
};
//
// Check that cursor returns no results if there are no docs within interval
//
class QueryStageCountScanNothingInInterval : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert documents, add index
insert(BSON("a" << 2));
insert(BSON("a" << 3));
addIndex(BSON("a" << 1));
// Set up count, and run
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 2);
params.startKeyInclusive = false;
params.endKey = BSON("" << 3);
params.endKeyInclusive = false;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(0, numCounted);
}
};
//
// Check that cursor returns no results if there are no docs within interval
// and the first key located during initialization is above upper bound
//
class QueryStageCountScanNothingInIntervalFirstMatchTooHigh : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert some documents, add index
insert(BSON("a" << 2));
insert(BSON("a" << 4));
addIndex(BSON("a" << 1));
// Set up count, and run
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 2);
params.startKeyInclusive = false;
params.endKey = BSON("" << 3);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(0, numCounted);
}
};
//
// Check that cursor recovers its position properly if there is no change
// during a yield
//
class QueryStageCountScanNoChangeDuringYield : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert documents, add index
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << i));
}
addIndex(BSON("a" << 1));
// Set up count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 2);
params.startKeyInclusive = false;
params.endKey = BSON("" << 6);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
WorkingSetID wsid;
int numCounted = 0;
PlanStage::StageState countState;
// Begin running the count
while (numCounted < 2) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
// Prepare the cursor to yield
static_cast<PlanStage*>(&count)->saveState();
// Recover from yield
static_cast<PlanStage*>(&count)->restoreState();
// finish counting
while (PlanStage::IS_EOF != countState) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
ASSERT_EQUALS(4, numCounted);
}
};
//
// Check that cursor recovers its position properly if its current location
// is deleted during a yield
//
class QueryStageCountScanDeleteDuringYield : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert documents, add index
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << i));
}
addIndex(BSON("a" << 1));
// Set up count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 2);
params.startKeyInclusive = false;
params.endKey = BSON("" << 6);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
WorkingSetID wsid;
int numCounted = 0;
PlanStage::StageState countState;
// Begin running the count
while (numCounted < 2) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
// Prepare the cursor to yield
static_cast<PlanStage*>(&count)->saveState();
// Remove remaining objects
remove(BSON("a" << GTE << 5));
// Recover from yield
static_cast<PlanStage*>(&count)->restoreState();
// finish counting
while (PlanStage::IS_EOF != countState) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
ASSERT_EQUALS(2, numCounted);
}
};
//
// Check that cursor relocates its end location properly if end location
// changes during a yield
//
class QueryStageCountScanInsertNewDocsDuringYield : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert documents, add index
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << i));
}
addIndex(BSON("a" << 1));
// Set up count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 2);
params.startKeyInclusive = false;
params.endKey = BSON("" << 6);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
WorkingSetID wsid;
int numCounted = 0;
PlanStage::StageState countState;
// Begin running the count
while (numCounted < 2) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
// Prepare the cursor to yield
static_cast<PlanStage*>(&count)->saveState();
// Insert one document before the end
insert(BSON("a" << 5.5));
// Insert one document after the end
insert(BSON("a" << 6.5));
// Recover from yield
static_cast<PlanStage*>(&count)->restoreState();
// finish counting
while (PlanStage::IS_EOF != countState) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
ASSERT_EQUALS(5, numCounted);
}
};
//
// Unused keys are not returned during iteration
//
class QueryStageCountScanUnusedKeys : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert docs, add index
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << 1 << "b" << i));
}
addIndex(BSON("a" << 1));
// Mark several keys as 'unused'
remove(BSON("a" << 1 << "b" << 0));
remove(BSON("a" << 1 << "b" << 3));
remove(BSON("a" << 1 << "b" << 4));
// Ensure that count does not include unused keys
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 1);
params.startKeyInclusive = true;
params.endKey = BSON("" << 1);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(7, numCounted);
}
};
//
// Iteration is properly terminated when the end location is an unused key
//
class QueryStageCountScanUnusedEndKey : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert docs, add index
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << 1 << "b" << i));
}
addIndex(BSON("a" << 1));
// Mark key at end position as 'unused' by deleting
remove(BSON("a" << 1 << "b" << 9));
// Run count and check
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 0);
params.startKeyInclusive = true;
params.endKey = BSON("" << 2);
params.endKeyInclusive = true; // yes?
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
int numCounted = runCount(&count);
ASSERT_EQUALS(9, numCounted);
}
};
//
// Advances past a key that becomes unused during a yield
//
class QueryStageCountScanKeyBecomesUnusedDuringYield : public CountBase {
public:
void run() {
dbtests::WriteContextForTests ctx(&_opCtx, ns());
// Insert documents, add index
for (int i = 0; i < 10; ++i) {
insert(BSON("a" << 1 << "b" << i));
}
addIndex(BSON("a" << 1));
// Set up count stage
auto params = makeCountScanParams(&_opCtx, getIndex(ctx.db(), BSON("a" << 1)));
params.startKey = BSON("" << 1);
params.startKeyInclusive = true;
params.endKey = BSON("" << 1);
params.endKeyInclusive = true;
WorkingSet ws;
CountScan count(&_opCtx, params, &ws);
WorkingSetID wsid;
int numCounted = 0;
PlanStage::StageState countState;
// Begin running the count
while (numCounted < 2) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
// Prepare the cursor to yield
static_cast<PlanStage*>(&count)->saveState();
// Mark the key at position 5 as 'unused'
remove(BSON("a" << 1 << "b" << 5));
// Recover from yield
static_cast<PlanStage*>(&count)->restoreState();
// finish counting
while (PlanStage::IS_EOF != countState) {
countState = count.work(&wsid);
if (PlanStage::ADVANCED == countState)
numCounted++;
}
ASSERT_EQUALS(8, numCounted);
}
};
class All : public OldStyleSuiteSpecification {
public:
All() : OldStyleSuiteSpecification("query_stage_count_scan") {}
void setupTests() {
add<QueryStageCountScanDups>();
add<QueryStageCountScanInclusiveBounds>();
add<QueryStageCountScanExclusiveBounds>();
add<QueryStageCountScanLowerBound>();
add<QueryStageCountScanNothingInInterval>();
add<QueryStageCountScanNothingInIntervalFirstMatchTooHigh>();
add<QueryStageCountScanNoChangeDuringYield>();
add<QueryStageCountScanDeleteDuringYield>();
add<QueryStageCountScanInsertNewDocsDuringYield>();
add<QueryStageCountScanUnusedKeys>();
}
};
OldStyleSuiteInitializer<All> queryStageCountScanAll;
} // namespace QueryStageCountScan
|