/
batch_executor.cpp
1476 lines (1228 loc) · 57.5 KB
/
batch_executor.cpp
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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kWrite
#include "mongo/platform/basic.h"
#include "mongo/db/commands/write_commands/batch_executor.h"
#include <boost/scoped_ptr.hpp>
#include <memory>
#include "mongo/base/error_codes.h"
#include "mongo/db/catalog/database.h"
#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/catalog/index_create.h"
#include "mongo/db/clientcursor.h"
#include "mongo/db/commands.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/exec/delete.h"
#include "mongo/db/exec/update.h"
#include "mongo/db/service_context.h"
#include "mongo/db/instance.h"
#include "mongo/db/introspect.h"
#include "mongo/db/lasterror.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/op_observer.h"
#include "mongo/db/operation_context_impl.h"
#include "mongo/db/ops/delete_request.h"
#include "mongo/db/ops/insert.h"
#include "mongo/db/ops/parsed_delete.h"
#include "mongo/db/ops/parsed_update.h"
#include "mongo/db/ops/update_lifecycle_impl.h"
#include "mongo/db/query/get_executor.h"
#include "mongo/db/query/plan_executor.h"
#include "mongo/db/query/query_knobs.h"
#include "mongo/db/repl/oplog.h"
#include "mongo/db/repl/repl_client_info.h"
#include "mongo/db/repl/repl_settings.h"
#include "mongo/db/repl/replication_coordinator_global.h"
#include "mongo/db/server_parameters.h"
#include "mongo/db/stats/counters.h"
#include "mongo/db/write_concern.h"
#include "mongo/s/collection_metadata.h"
#include "mongo/s/d_state.h"
#include "mongo/s/shard_key_pattern.h"
#include "mongo/s/stale_exception.h"
#include "mongo/s/write_ops/batched_upsert_detail.h"
#include "mongo/s/write_ops/write_error_detail.h"
#include "mongo/util/elapsed_tracker.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"
namespace mongo {
using boost::scoped_ptr;
using std::auto_ptr;
using std::endl;
using std::string;
using std::vector;
namespace {
/**
* Data structure to safely hold and clean up results of single write operations.
*/
class WriteOpResult {
MONGO_DISALLOW_COPYING(WriteOpResult);
public:
WriteOpResult() {}
WriteOpStats& getStats() { return _stats; }
WriteErrorDetail* getError() { return _error.get(); }
WriteErrorDetail* releaseError() { return _error.release(); }
void setError(WriteErrorDetail* error) { _error.reset(error); }
private:
WriteOpStats _stats;
std::auto_ptr<WriteErrorDetail> _error;
};
} // namespace
// TODO: Determine queueing behavior we want here
MONGO_EXPORT_SERVER_PARAMETER( queueForMigrationCommit, bool, true );
using mongoutils::str::stream;
WriteBatchExecutor::WriteBatchExecutor( OperationContext* txn,
OpCounters* opCounters,
LastError* le ) :
_txn(txn),
_opCounters( opCounters ),
_le( le ),
_stats( new WriteBatchStats ) {
}
static WCErrorDetail* toWriteConcernError( const Status& wcStatus,
const WriteConcernResult& wcResult ) {
WCErrorDetail* wcError = new WCErrorDetail;
wcError->setErrCode( wcStatus.code() );
wcError->setErrMessage( wcStatus.reason() );
if ( wcResult.wTimedOut )
wcError->setErrInfo( BSON( "wtimeout" << true ) );
return wcError;
}
static WriteErrorDetail* toWriteError( const Status& status ) {
WriteErrorDetail* error = new WriteErrorDetail;
// TODO: Complex transform here?
error->setErrCode( status.code() );
error->setErrMessage( status.reason() );
return error;
}
static void toBatchError( const Status& status, BatchedCommandResponse* response ) {
response->clear();
response->setErrCode( status.code() );
response->setErrMessage( status.reason() );
response->setOk( false );
dassert( response->isValid(NULL) );
}
static void noteInCriticalSection( WriteErrorDetail* staleError ) {
BSONObjBuilder builder;
if ( staleError->isErrInfoSet() )
builder.appendElements( staleError->getErrInfo() );
builder.append( "inCriticalSection", true );
staleError->setErrInfo( builder.obj() );
}
// static
Status WriteBatchExecutor::validateBatch( const BatchedCommandRequest& request ) {
// Validate namespace
const NamespaceString& nss = request.getNSS();
if ( !nss.isValid() ) {
return Status( ErrorCodes::InvalidNamespace,
nss.ns() + " is not a valid namespace" );
}
// Make sure we can write to the namespace
Status allowedStatus = userAllowedWriteNS( nss );
if ( !allowedStatus.isOK() ) {
return allowedStatus;
}
// Validate insert index requests
// TODO: Push insert index requests through createIndex once all upgrade paths support it
string errMsg;
if ( request.isInsertIndexRequest() && !request.isValidIndexRequest( &errMsg ) ) {
return Status( ErrorCodes::InvalidOptions, errMsg );
}
return Status::OK();
}
void WriteBatchExecutor::executeBatch( const BatchedCommandRequest& request,
BatchedCommandResponse* response ) {
// Validate namespace
Status isValid = validateBatch(request);
if (!isValid.isOK()) {
toBatchError( isValid, response );
return;
}
if ( request.sizeWriteOps() == 0u ) {
toBatchError( Status( ErrorCodes::InvalidLength,
"no write ops were included in the batch" ),
response );
return;
}
// Validate batch size
if ( request.sizeWriteOps() > BatchedCommandRequest::kMaxWriteBatchSize ) {
toBatchError( Status( ErrorCodes::InvalidLength,
stream() << "exceeded maximum write batch size of "
<< BatchedCommandRequest::kMaxWriteBatchSize ),
response );
return;
}
//
// End validation
//
const WriteConcernOptions& writeConcern = _txn->getWriteConcern();
bool silentWC = writeConcern.wMode.empty() && writeConcern.wNumNodes == 0
&& writeConcern.syncMode == WriteConcernOptions::NONE;
Timer commandTimer;
OwnedPointerVector<WriteErrorDetail> writeErrorsOwned;
vector<WriteErrorDetail*>& writeErrors = writeErrorsOwned.mutableVector();
OwnedPointerVector<BatchedUpsertDetail> upsertedOwned;
vector<BatchedUpsertDetail*>& upserted = upsertedOwned.mutableVector();
//
// Apply each batch item, possibly bulking some items together in the write lock.
// Stops on error if batch is ordered.
//
bulkExecute( request, &upserted, &writeErrors );
//
// Try to enforce the write concern if everything succeeded (unordered or ordered)
// OR if something succeeded and we're unordered.
//
auto_ptr<WCErrorDetail> wcError;
bool needToEnforceWC = writeErrors.empty()
|| ( !request.getOrdered()
&& writeErrors.size() < request.sizeWriteOps() );
if ( needToEnforceWC ) {
_txn->getCurOp()->setMessage( "waiting for write concern" );
WriteConcernResult res;
Status status = waitForWriteConcern(
_txn,
repl::ReplClientInfo::forClient(_txn->getClient()).getLastOp(),
&res);
if ( !status.isOK() ) {
wcError.reset( toWriteConcernError( status, res ) );
}
}
//
// Refresh metadata if needed
//
bool staleBatch = !writeErrors.empty()
&& writeErrors.back()->getErrCode() == ErrorCodes::StaleShardVersion;
if ( staleBatch ) {
const BatchedRequestMetadata* requestMetadata = request.getMetadata();
dassert( requestMetadata );
// Make sure our shard name is set or is the same as what was set previously
if ( shardingState.setShardName( requestMetadata->getShardName() ) ) {
//
// First, we refresh metadata if we need to based on the requested version.
//
ChunkVersion latestShardVersion;
shardingState.refreshMetadataIfNeeded( _txn,
request.getTargetingNS(),
requestMetadata->getShardVersion(),
&latestShardVersion );
// Report if we're still changing our metadata
// TODO: Better reporting per-collection
if ( shardingState.inCriticalMigrateSection() ) {
noteInCriticalSection( writeErrors.back() );
}
if ( queueForMigrationCommit ) {
//
// Queue up for migration to end - this allows us to be sure that clients will
// not repeatedly try to refresh metadata that is not yet written to the config
// server. Not necessary for correctness.
// Exposed as optional parameter to allow testing of queuing behavior with
// different network timings.
//
const ChunkVersion& requestShardVersion = requestMetadata->getShardVersion();
//
// Only wait if we're an older version (in the current collection epoch) and
// we're not write compatible, implying that the current migration is affecting
// writes.
//
if ( requestShardVersion.isOlderThan( latestShardVersion ) &&
!requestShardVersion.isWriteCompatibleWith( latestShardVersion ) ) {
while ( shardingState.inCriticalMigrateSection() ) {
log() << "write request to old shard version "
<< requestMetadata->getShardVersion().toString()
<< " waiting for migration commit" << endl;
shardingState.waitTillNotInCriticalSection( 10 /* secs */);
}
}
}
}
else {
// If our shard name is stale, our version must have been stale as well
dassert( writeErrors.size() == request.sizeWriteOps() );
}
}
//
// Construct response
//
response->setOk( true );
if ( !silentWC ) {
if ( upserted.size() ) {
response->setUpsertDetails( upserted );
}
if ( writeErrors.size() ) {
response->setErrDetails( writeErrors );
}
if ( wcError.get() ) {
response->setWriteConcernError( wcError.release() );
}
repl::ReplicationCoordinator* replCoord = repl::getGlobalReplicationCoordinator();
const repl::ReplicationCoordinator::Mode replMode = replCoord->getReplicationMode();
if (replMode != repl::ReplicationCoordinator::modeNone) {
response->setLastOp(
repl::ReplClientInfo::forClient(_txn->getClient()).getLastOp());
if (replMode == repl::ReplicationCoordinator::modeReplSet) {
response->setElectionId(replCoord->getElectionId());
}
}
// Set the stats for the response
response->setN( _stats->numInserted + _stats->numUpserted + _stats->numMatched
+ _stats->numDeleted );
if ( request.getBatchType() == BatchedCommandRequest::BatchType_Update )
response->setNModified( _stats->numModified );
}
dassert( response->isValid( NULL ) );
}
// Translates write item type to wire protocol op code.
// Helper for WriteBatchExecutor::applyWriteItem().
static int getOpCode( BatchedCommandRequest::BatchType writeType ) {
switch ( writeType ) {
case BatchedCommandRequest::BatchType_Insert:
return dbInsert;
case BatchedCommandRequest::BatchType_Update:
return dbUpdate;
default:
dassert( writeType == BatchedCommandRequest::BatchType_Delete );
return dbDelete;
}
return 0;
}
static void buildStaleError( const ChunkVersion& shardVersionRecvd,
const ChunkVersion& shardVersionWanted,
WriteErrorDetail* error ) {
// Write stale error to results
error->setErrCode( ErrorCodes::StaleShardVersion );
BSONObjBuilder infoB;
shardVersionWanted.addToBSON( infoB, "vWanted" );
error->setErrInfo( infoB.obj() );
string errMsg = stream() << "stale shard version detected before write, received "
<< shardVersionRecvd.toString() << " but local version is "
<< shardVersionWanted.toString();
error->setErrMessage( errMsg );
}
static bool checkShardVersion(OperationContext* txn,
ShardingState* shardingState,
const BatchedCommandRequest& request,
WriteOpResult* result) {
const NamespaceString& nss = request.getTargetingNSS();
dassert(txn->lockState()->isCollectionLockedForMode(nss.ns(), MODE_IX));
ChunkVersion requestShardVersion =
request.isMetadataSet() && request.getMetadata()->isShardVersionSet() ?
request.getMetadata()->getShardVersion() : ChunkVersion::IGNORED();
if ( shardingState->enabled() ) {
CollectionMetadataPtr metadata = shardingState->getCollectionMetadata( nss.ns() );
if ( !ChunkVersion::isIgnoredVersion( requestShardVersion ) ) {
ChunkVersion shardVersion =
metadata ? metadata->getShardVersion() : ChunkVersion::UNSHARDED();
if ( !requestShardVersion.isWriteCompatibleWith( shardVersion ) ) {
result->setError(new WriteErrorDetail);
buildStaleError(requestShardVersion, shardVersion, result->getError());
return false;
}
}
}
return true;
}
static bool checkIsMasterForDatabase(const NamespaceString& ns, WriteOpResult* result) {
if (!repl::getGlobalReplicationCoordinator()->canAcceptWritesForDatabase(
ns.db())) {
WriteErrorDetail* errorDetail = new WriteErrorDetail;
result->setError(errorDetail);
errorDetail->setErrCode(ErrorCodes::NotMaster);
errorDetail->setErrMessage("Not primary while writing to " + ns.toString());
return false;
}
return true;
}
static void buildUniqueIndexError( const BSONObj& keyPattern,
const BSONObj& indexPattern,
WriteErrorDetail* error ) {
error->setErrCode( ErrorCodes::CannotCreateIndex );
string errMsg = stream() << "cannot create unique index over " << indexPattern
<< " with shard key pattern " << keyPattern;
error->setErrMessage( errMsg );
}
static bool checkIndexConstraints(OperationContext* txn,
ShardingState* shardingState,
const BatchedCommandRequest& request,
WriteOpResult* result) {
const NamespaceString& nss = request.getTargetingNSS();
dassert(txn->lockState()->isCollectionLockedForMode(nss.ns(), MODE_IX));
if ( !request.isUniqueIndexRequest() )
return true;
if ( shardingState->enabled() ) {
CollectionMetadataPtr metadata = shardingState->getCollectionMetadata( nss.ns() );
if ( metadata ) {
ShardKeyPattern shardKeyPattern(metadata->getKeyPattern());
if (!shardKeyPattern.isUniqueIndexCompatible(request.getIndexKeyPattern())) {
result->setError(new WriteErrorDetail);
buildUniqueIndexError(metadata->getKeyPattern(),
request.getIndexKeyPattern(),
result->getError());
return false;
}
}
}
return true;
}
//
// HELPERS FOR CUROP MANAGEMENT AND GLOBAL STATS
//
static void beginCurrentOp( CurOp* currentOp, Client* client, const BatchItemRef& currWrite ) {
// Execute the write item as a child operation of the current operation.
// This is not done by out callers
// Set up the child op with more info
HostAndPort remote =
client->hasRemote() ? client->getRemote() : HostAndPort( "0.0.0.0", 0 );
// TODO Modify CurOp "wrapped" constructor to take an opcode, so calling .reset()
// is unneeded
currentOp->reset( remote, getOpCode( currWrite.getRequest()->getBatchType() ) );
currentOp->ensureStarted();
currentOp->setNS( currWrite.getRequest()->getNS() );
currentOp->debug().ns = currentOp->getNS();
currentOp->debug().op = currentOp->getOp();
if ( currWrite.getOpType() == BatchedCommandRequest::BatchType_Insert ) {
currentOp->setQuery( currWrite.getDocument() );
currentOp->debug().query = currWrite.getDocument();
currentOp->debug().ninserted = 0;
}
else if ( currWrite.getOpType() == BatchedCommandRequest::BatchType_Update ) {
currentOp->setQuery( currWrite.getUpdate()->getQuery() );
currentOp->debug().query = currWrite.getUpdate()->getQuery();
currentOp->debug().updateobj = currWrite.getUpdate()->getUpdateExpr();
// Note: debug().nMatched, nModified and nmoved are set internally in update
}
else {
dassert( currWrite.getOpType() == BatchedCommandRequest::BatchType_Delete );
currentOp->setQuery( currWrite.getDelete()->getQuery() );
currentOp->debug().query = currWrite.getDelete()->getQuery();
currentOp->debug().ndeleted = 0;
}
}
void WriteBatchExecutor::incOpStats( const BatchItemRef& currWrite ) {
if ( currWrite.getOpType() == BatchedCommandRequest::BatchType_Insert ) {
_opCounters->gotInsert();
}
else if ( currWrite.getOpType() == BatchedCommandRequest::BatchType_Update ) {
_opCounters->gotUpdate();
}
else {
dassert( currWrite.getOpType() == BatchedCommandRequest::BatchType_Delete );
_opCounters->gotDelete();
}
}
void WriteBatchExecutor::incWriteStats( const BatchItemRef& currWrite,
const WriteOpStats& stats,
const WriteErrorDetail* error,
CurOp* currentOp ) {
if ( currWrite.getOpType() == BatchedCommandRequest::BatchType_Insert ) {
_stats->numInserted += stats.n;
currentOp->debug().ninserted += stats.n;
if (!error) {
_le->recordInsert(stats.n);
}
}
else if ( currWrite.getOpType() == BatchedCommandRequest::BatchType_Update ) {
if ( stats.upsertedID.isEmpty() ) {
_stats->numMatched += stats.n;
_stats->numModified += stats.nModified;
}
else {
++_stats->numUpserted;
}
if (!error) {
_le->recordUpdate( stats.upsertedID.isEmpty() && stats.n > 0,
stats.n,
stats.upsertedID );
}
}
else {
dassert( currWrite.getOpType() == BatchedCommandRequest::BatchType_Delete );
_stats->numDeleted += stats.n;
if ( !error ) {
_le->recordDelete( stats.n );
}
currentOp->debug().ndeleted += stats.n;
}
if (error) {
_le->setLastError(error->getErrCode(), error->getErrMessage().c_str());
}
}
static void finishCurrentOp( OperationContext* txn,
CurOp* currentOp,
WriteErrorDetail* opError ) {
currentOp->done();
int executionTime = currentOp->debug().executionTime = currentOp->totalTimeMillis();
currentOp->debug().recordStats();
if (currentOp->getOp() == dbInsert) {
// This is a wrapped operation, so make sure to count this part of the op
// SERVER-13339: Properly fix the handling of context in the insert path.
// Right now it caches client contexts in ExecInsertsState, unlike the
// update and remove operations.
currentOp->recordGlobalTime(txn->lockState()->isWriteLocked(),
currentOp->totalTimeMicros());
}
if ( opError ) {
currentOp->debug().exceptionInfo = ExceptionInfo( opError->getErrMessage(),
opError->getErrCode() );
LOG(3) << " Caught Assertion in " << opToString( currentOp->getOp() )
<< ", continuing " << causedBy( opError->getErrMessage() ) << endl;
}
bool logAll = logger::globalLogDomain()->shouldLog(logger::LogComponent::kWrite,
logger::LogSeverity::Debug(1));
bool logSlow = executionTime
> ( serverGlobalParams.slowMS + currentOp->getExpectedLatencyMs() );
if ( logAll || logSlow ) {
Locker::LockerInfo lockerInfo;
txn->lockState()->getLockerInfo(&lockerInfo);
LOG(0) << currentOp->debug().report(*currentOp, lockerInfo.stats);
}
if (currentOp->shouldDBProfile(executionTime)) {
profile(txn, txn->getCurOp()->getOp());
}
}
// END HELPERS
//
// CORE WRITE OPERATIONS (declaration)
// These functions write to the database and return stats and zero or one of:
// - page fault
// - error
//
static void singleInsert( OperationContext* txn,
const BSONObj& docToInsert,
Collection* collection,
WriteOpResult* result );
static void singleCreateIndex( OperationContext* txn,
const BSONObj& indexDesc,
WriteOpResult* result );
static void multiUpdate( OperationContext* txn,
const BatchItemRef& updateItem,
WriteOpResult* result );
static void multiRemove( OperationContext* txn,
const BatchItemRef& removeItem,
WriteOpResult* result );
//
// WRITE EXECUTION
// In general, the exec* operations manage db lock state and stats before dispatching to the
// core write operations, which are *only* responsible for performing a write and reporting
// success or failure.
//
/**
* Representation of the execution state of execInserts. Used by a single
* execution of execInserts in a single thread.
*/
class WriteBatchExecutor::ExecInsertsState {
MONGO_DISALLOW_COPYING(ExecInsertsState);
public:
/**
* Constructs a new instance, for performing inserts described in "aRequest".
*/
explicit ExecInsertsState(OperationContext* txn,
const BatchedCommandRequest* aRequest);
/**
* Acquires the write lock and client context needed to perform the current write operation.
* Returns true on success, after which it is safe to use the "context" and "collection"
* members. It is safe to call this function if this instance already holds the write lock.
*
* On failure, writeLock, context and collection will be NULL/clear.
*/
bool lockAndCheck(WriteOpResult* result);
/**
* Releases the client context and write lock acquired by lockAndCheck. Safe to call
* regardless of whether or not this state object currently owns the lock.
*/
void unlock();
/**
* Returns true if this executor has the lock on the target database.
*/
bool hasLock() { return _writeLock.get(); }
/**
* Gets the lock-holding object. Only valid if hasLock().
*/
Lock::DBLock& getLock() { return *_writeLock; }
/**
* Gets the target collection for the batch operation. Value is undefined
* unless hasLock() is true.
*/
Collection* getCollection() { return _collection; }
OperationContext* txn;
// Request object describing the inserts.
const BatchedCommandRequest* request;
// Index of the current insert operation to perform.
size_t currIndex;
// Translation of insert documents in "request" into insert-ready forms. This vector has a
// correspondence with elements of the "request", and "currIndex" is used to
// index both.
std::vector<StatusWith<BSONObj> > normalizedInserts;
private:
bool _lockAndCheckImpl(WriteOpResult* result, bool intentLock);
ScopedTransaction _transaction;
// Guard object for the write lock on the target database.
scoped_ptr<Lock::DBLock> _writeLock;
scoped_ptr<Lock::CollectionLock> _collLock;
// Context object on the target database. Must appear after writeLock, so that it is
// destroyed in proper order.
scoped_ptr<OldClientContext> _context;
// Target collection.
Collection* _collection;
};
void WriteBatchExecutor::bulkExecute( const BatchedCommandRequest& request,
std::vector<BatchedUpsertDetail*>* upsertedIds,
std::vector<WriteErrorDetail*>* errors ) {
if ( request.getBatchType() == BatchedCommandRequest::BatchType_Insert ) {
execInserts( request, errors );
}
else if ( request.getBatchType() == BatchedCommandRequest::BatchType_Update ) {
for ( size_t i = 0; i < request.sizeWriteOps(); i++ ) {
if ( i + 1 == request.sizeWriteOps() ) {
setupSynchronousCommit( _txn );
}
WriteErrorDetail* error = NULL;
BSONObj upsertedId;
execUpdate( BatchItemRef( &request, i ), &upsertedId, &error );
if ( !upsertedId.isEmpty() ) {
BatchedUpsertDetail* batchUpsertedId = new BatchedUpsertDetail;
batchUpsertedId->setIndex( i );
batchUpsertedId->setUpsertedID( upsertedId );
upsertedIds->push_back( batchUpsertedId );
}
if ( error ) {
errors->push_back( error );
if ( request.getOrdered() )
break;
}
}
}
else {
dassert( request.getBatchType() == BatchedCommandRequest::BatchType_Delete );
for ( size_t i = 0; i < request.sizeWriteOps(); i++ ) {
if ( i + 1 == request.sizeWriteOps() ) {
setupSynchronousCommit( _txn );
}
WriteErrorDetail* error = NULL;
execRemove( BatchItemRef( &request, i ), &error );
if ( error ) {
errors->push_back( error );
if ( request.getOrdered() )
break;
}
}
}
// Fill in stale version errors for unordered batches (update/delete can't do this on own)
if ( !errors->empty() && !request.getOrdered() ) {
const WriteErrorDetail* finalError = errors->back();
if ( finalError->getErrCode() == ErrorCodes::StaleShardVersion ) {
for ( size_t i = finalError->getIndex() + 1; i < request.sizeWriteOps(); i++ ) {
WriteErrorDetail* dupStaleError = new WriteErrorDetail;
finalError->cloneTo( dupStaleError );
errors->push_back( dupStaleError );
}
}
}
}
// Goes over the request and preprocesses normalized versions of all the inserts in the request
static void normalizeInserts( const BatchedCommandRequest& request,
vector<StatusWith<BSONObj> >* normalizedInserts ) {
normalizedInserts->reserve(request.sizeWriteOps());
for ( size_t i = 0; i < request.sizeWriteOps(); ++i ) {
BSONObj insertDoc = request.getInsertRequest()->getDocumentsAt( i );
StatusWith<BSONObj> normalInsert = fixDocumentForInsert( insertDoc );
normalizedInserts->push_back( normalInsert );
if ( request.getOrdered() && !normalInsert.isOK() )
break;
}
}
void WriteBatchExecutor::execInserts( const BatchedCommandRequest& request,
std::vector<WriteErrorDetail*>* errors ) {
// Theory of operation:
//
// Instantiates an ExecInsertsState, which represents all of the state involved in the batch
// insert execution algorithm. Most importantly, encapsulates the lock state.
//
// Every iteration of the loop in execInserts() processes one document insertion, by calling
// insertOne() exactly once for a given value of state.currIndex.
//
// If the ExecInsertsState indicates that the requisite write locks are not held, insertOne
// acquires them and performs lock-acquisition-time checks. However, on non-error
// execution, it does not release the locks. Therefore, the yielding logic in the while
// loop in execInserts() is solely responsible for lock release in the non-error case.
//
// Internally, insertOne loops performing the single insert until it completes without a
// PageFaultException, or until it fails with some kind of error. Errors are mostly
// propagated via the request->error field, but DBExceptions or std::exceptions may escape,
// particularly on operation interruption. These kinds of errors necessarily prevent
// further insertOne calls, and stop the batch. As a result, the only expected source of
// such exceptions are interruptions.
ExecInsertsState state(_txn, &request);
normalizeInserts(request, &state.normalizedInserts);
ShardedConnectionInfo* info = ShardedConnectionInfo::get(false);
if (info) {
if (request.isMetadataSet() && request.getMetadata()->isShardVersionSet()) {
info->setVersion(request.getTargetingNS(),
request.getMetadata()->getShardVersion());
}
else {
info->setVersion(request.getTargetingNS(), ChunkVersion::IGNORED());
}
}
// Yield frequency is based on the same constants used by PlanYieldPolicy.
ElapsedTracker elapsedTracker(internalQueryExecYieldIterations,
internalQueryExecYieldPeriodMS);
for (state.currIndex = 0;
state.currIndex < state.request->sizeWriteOps();
++state.currIndex) {
if (state.currIndex + 1 == state.request->sizeWriteOps()) {
setupSynchronousCommit(_txn);
}
if (elapsedTracker.intervalHasElapsed()) {
// Yield between inserts.
if (state.hasLock()) {
// Release our locks. They get reacquired when insertOne() calls
// ExecInsertsState::lockAndCheck(). Since the lock manager guarantees FIFO
// queues waiting on locks, there is no need to explicitly sleep or give up
// control of the processor here.
state.unlock();
// This releases any storage engine held locks/snapshots.
_txn->recoveryUnit()->commitAndRestart();
}
_txn->checkForInterrupt();
elapsedTracker.resetLastTime();
}
WriteErrorDetail* error = NULL;
execOneInsert(&state, &error);
if (error) {
errors->push_back(error);
error->setIndex(state.currIndex);
if (request.getOrdered())
return;
}
}
}
void WriteBatchExecutor::execUpdate( const BatchItemRef& updateItem,
BSONObj* upsertedId,
WriteErrorDetail** error ) {
// BEGIN CURRENT OP
CurOp currentOp(_txn->getClient());
beginCurrentOp( ¤tOp, _txn->getClient(), updateItem );
incOpStats( updateItem );
ShardedConnectionInfo* info = ShardedConnectionInfo::get(false);
if (info) {
auto rootRequest = updateItem.getRequest();
if (!updateItem.getUpdate()->getMulti() &&
rootRequest->isMetadataSet() &&
rootRequest->getMetadata()->isShardVersionSet()) {
info->setVersion(rootRequest->getTargetingNS(),
rootRequest->getMetadata()->getShardVersion());
}
else {
info->setVersion(rootRequest->getTargetingNS(), ChunkVersion::IGNORED());
}
}
WriteOpResult result;
multiUpdate( _txn, updateItem, &result );
if ( !result.getStats().upsertedID.isEmpty() ) {
*upsertedId = result.getStats().upsertedID;
}
// END CURRENT OP
incWriteStats( updateItem, result.getStats(), result.getError(), ¤tOp );
finishCurrentOp( _txn, ¤tOp, result.getError() );
// End current transaction and release snapshot.
_txn->recoveryUnit()->commitAndRestart();
if ( result.getError() ) {
result.getError()->setIndex( updateItem.getItemIndex() );
*error = result.releaseError();
}
}
void WriteBatchExecutor::execRemove( const BatchItemRef& removeItem,
WriteErrorDetail** error ) {
// Removes are similar to updates, but page faults are handled externally
// BEGIN CURRENT OP
CurOp currentOp(_txn->getClient());
beginCurrentOp( ¤tOp, _txn->getClient(), removeItem );
incOpStats( removeItem );
ShardedConnectionInfo* info = ShardedConnectionInfo::get(false);
if (info) {
auto rootRequest = removeItem.getRequest();
if (removeItem.getDelete()->getLimit() == 1 &&
rootRequest->isMetadataSet() &&
rootRequest->getMetadata()->isShardVersionSet()) {
info->setVersion(rootRequest->getTargetingNS(),
rootRequest->getMetadata()->getShardVersion());
}
else {
info->setVersion(rootRequest->getTargetingNS(), ChunkVersion::IGNORED());
}
}
WriteOpResult result;
multiRemove( _txn, removeItem, &result );
// END CURRENT OP
incWriteStats( removeItem, result.getStats(), result.getError(), ¤tOp );
finishCurrentOp( _txn, ¤tOp, result.getError() );
// End current transaction and release snapshot.
_txn->recoveryUnit()->commitAndRestart();
if ( result.getError() ) {
result.getError()->setIndex( removeItem.getItemIndex() );
*error = result.releaseError();
}
}
//
// IN-DB-LOCK CORE OPERATIONS
//
WriteBatchExecutor::ExecInsertsState::ExecInsertsState(OperationContext* txn,
const BatchedCommandRequest* aRequest) :
txn(txn),
request(aRequest),
currIndex(0),
_transaction(txn, MODE_IX),
_collection(NULL) {
}
bool WriteBatchExecutor::ExecInsertsState::_lockAndCheckImpl(WriteOpResult* result,
bool intentLock) {
if (hasLock()) {
// TODO: OldClientContext legacy, needs to be removed
txn->getCurOp()->enter(_context->ns(),
_context->db() ? _context->db()->getProfilingLevel() : 0);
return true;
}
if (request->isInsertIndexRequest())
intentLock = false; // can't build indexes in intent mode
invariant(!_context.get());
const NamespaceString& nss = request->getNSS();