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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
|
/**
* 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.
*/
#define MONGO_LOGV2_DEFAULT_COMPONENT ::mongo::logv2::LogComponent::kWrite
#include "mongo/platform/basic.h"
#include <memory>
#include "mongo/base/checked_cast.h"
#include "mongo/db/audit.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/catalog/document_validation.h"
#include "mongo/db/catalog_raii.h"
#include "mongo/db/commands.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/curop_failpoint_helpers.h"
#include "mongo/db/curop_metrics.h"
#include "mongo/db/error_labels.h"
#include "mongo/db/exec/delete.h"
#include "mongo/db/exec/update_stage.h"
#include "mongo/db/introspect.h"
#include "mongo/db/lasterror.h"
#include "mongo/db/matcher/extensions_callback_real.h"
#include "mongo/db/ops/delete_request_gen.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_request.h"
#include "mongo/db/ops/write_ops_exec.h"
#include "mongo/db/ops/write_ops_gen.h"
#include "mongo/db/ops/write_ops_retryability.h"
#include "mongo/db/query/collection_query_info.h"
#include "mongo/db/query/get_executor.h"
#include "mongo/db/query/plan_summary_stats.h"
#include "mongo/db/repl/repl_client_info.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/retryable_writes_stats.h"
#include "mongo/db/s/collection_sharding_state.h"
#include "mongo/db/s/operation_sharding_state.h"
#include "mongo/db/s/sharding_state.h"
#include "mongo/db/stats/counters.h"
#include "mongo/db/stats/server_write_concern_metrics.h"
#include "mongo/db/stats/top.h"
#include "mongo/db/storage/duplicate_key_error_info.h"
#include "mongo/db/transaction_participant.h"
#include "mongo/db/write_concern.h"
#include "mongo/logv2/log.h"
#include "mongo/rpc/get_status_from_command_result.h"
#include "mongo/s/would_change_owning_shard_exception.h"
#include "mongo/util/fail_point.h"
#include "mongo/util/log_and_backoff.h"
#include "mongo/util/scopeguard.h"
namespace mongo {
// Convention in this file: generic helpers go in the anonymous namespace. Helpers that are for a
// single type of operation are static functions defined above their caller.
namespace {
MONGO_FAIL_POINT_DEFINE(failAllInserts);
MONGO_FAIL_POINT_DEFINE(failAllUpdates);
MONGO_FAIL_POINT_DEFINE(failAllRemoves);
MONGO_FAIL_POINT_DEFINE(hangBeforeChildRemoveOpFinishes);
MONGO_FAIL_POINT_DEFINE(hangBeforeChildRemoveOpIsPopped);
MONGO_FAIL_POINT_DEFINE(hangAfterAllChildRemoveOpsArePopped);
MONGO_FAIL_POINT_DEFINE(hangDuringBatchInsert);
MONGO_FAIL_POINT_DEFINE(hangDuringBatchUpdate);
MONGO_FAIL_POINT_DEFINE(hangDuringBatchRemove);
MONGO_FAIL_POINT_DEFINE(hangAndFailAfterDocumentInsertsReserveOpTimes);
// The withLock fail points are for testing interruptability of these operations, so they will not
// themselves check for interrupt.
MONGO_FAIL_POINT_DEFINE(hangWithLockDuringBatchInsert);
MONGO_FAIL_POINT_DEFINE(hangWithLockDuringBatchUpdate);
MONGO_FAIL_POINT_DEFINE(hangWithLockDuringBatchRemove);
void updateRetryStats(OperationContext* opCtx, bool containsRetry) {
if (containsRetry) {
RetryableWritesStats::get(opCtx)->incrementRetriedCommandsCount();
}
}
void finishCurOp(OperationContext* opCtx, CurOp* curOp) {
try {
curOp->done();
auto executionTimeMicros = duration_cast<Microseconds>(curOp->elapsedTimeExcludingPauses());
curOp->debug().executionTime = executionTimeMicros;
recordCurOpMetrics(opCtx);
Top::get(opCtx->getServiceContext())
.record(opCtx,
curOp->getNS(),
curOp->getLogicalOp(),
Top::LockType::WriteLocked,
durationCount<Microseconds>(curOp->elapsedTimeExcludingPauses()),
curOp->isCommand(),
curOp->getReadWriteType());
if (!curOp->debug().errInfo.isOK()) {
LOGV2_DEBUG(20886,
3,
"Caught Assertion in finishCurOp. Op: {operation}, error: {error}",
"Caught Assertion in finishCurOp",
"operation"_attr = redact(logicalOpToString(curOp->getLogicalOp())),
"error"_attr = curOp->debug().errInfo.toString());
}
// Mark the op as complete, and log it if appropriate. Returns a boolean indicating whether
// this op should be sampled for profiling.
const bool shouldSample =
curOp->completeAndLogOperation(opCtx, MONGO_LOGV2_DEFAULT_COMPONENT);
if (curOp->shouldDBProfile(shouldSample)) {
// Stash the current transaction so that writes to the profile collection are not
// done as part of the transaction.
TransactionParticipant::SideTransactionBlock sideTxn(opCtx);
profile(opCtx, CurOp::get(opCtx)->getNetworkOp());
}
} catch (const DBException& ex) {
// We need to ignore all errors here. We don't want a successful op to fail because of a
// failure to record stats. We also don't want to replace the error reported for an op that
// is failing.
LOGV2(20887,
"Ignoring error from finishCurOp: {error}",
"Ignoring error from finishCurOp",
"error"_attr = redact(ex));
}
}
/**
* Sets the Client's LastOp to the system OpTime if needed. This is especially helpful for
* adjusting the client opTime for cases when batched write performed multiple writes, but
* when the last write was a no-op (which will not advance the client opTime).
*/
class LastOpFixer {
public:
LastOpFixer(OperationContext* opCtx, const NamespaceString& ns)
: _opCtx(opCtx), _isOnLocalDb(ns.isLocal()) {}
~LastOpFixer() {
if (_needToFixLastOp && !_isOnLocalDb) {
// If this operation has already generated a new lastOp, don't bother setting it
// here. No-op updates will not generate a new lastOp, so we still need the
// guard to fire in that case. Operations on the local DB aren't replicated, so they
// don't need to bump the lastOp.
replClientInfo().setLastOpToSystemLastOpTimeIgnoringInterrupt(_opCtx);
LOGV2_DEBUG(20888,
5,
"Set last op to system time: {timestamp}",
"Set last op to system time",
"timestamp"_attr = replClientInfo().getLastOp().getTimestamp());
}
}
void startingOp() {
_needToFixLastOp = true;
_opTimeAtLastOpStart = replClientInfo().getLastOp();
}
void finishedOpSuccessfully() {
// If the op was succesful and bumped LastOp, we don't need to do it again. However, we
// still need to for no-ops and all failing ops.
_needToFixLastOp = (replClientInfo().getLastOp() == _opTimeAtLastOpStart);
}
private:
repl::ReplClientInfo& replClientInfo() {
return repl::ReplClientInfo::forClient(_opCtx->getClient());
}
OperationContext* const _opCtx;
bool _needToFixLastOp = true;
const bool _isOnLocalDb;
repl::OpTime _opTimeAtLastOpStart;
};
void assertCanWrite_inlock(OperationContext* opCtx, const NamespaceString& ns) {
uassert(ErrorCodes::PrimarySteppedDown,
str::stream() << "Not primary while writing to " << ns.ns(),
repl::ReplicationCoordinator::get(opCtx->getServiceContext())
->canAcceptWritesFor(opCtx, ns));
CollectionShardingState::get(opCtx, ns)->checkShardVersionOrThrow(opCtx);
}
void makeCollection(OperationContext* opCtx, const NamespaceString& ns) {
writeConflictRetry(opCtx, "implicit collection creation", ns.ns(), [&opCtx, &ns] {
AutoGetOrCreateDb db(opCtx, ns.db(), MODE_IX);
Lock::CollectionLock collLock(opCtx, ns, MODE_IX);
assertCanWrite_inlock(opCtx, ns);
if (!CollectionCatalog::get(opCtx).lookupCollectionByNamespace(
opCtx,
ns)) { // someone else may have beat us to it.
uassertStatusOK(userAllowedCreateNS(ns));
WriteUnitOfWork wuow(opCtx);
CollectionOptions defaultCollectionOptions;
uassertStatusOK(db.getDb()->userCreateNS(opCtx, ns, defaultCollectionOptions));
wuow.commit();
}
});
}
/**
* Returns true if the batch can continue, false to stop the batch, or throws to fail the command.
*/
bool handleError(OperationContext* opCtx,
const DBException& ex,
const NamespaceString& nss,
const write_ops::WriteCommandBase& wholeOp,
WriteResult* out) {
LastError::get(opCtx->getClient()).setLastError(ex.code(), ex.reason());
auto& curOp = *CurOp::get(opCtx);
curOp.debug().errInfo = ex.toStatus();
if (ErrorCodes::isInterruption(ex.code())) {
throw; // These have always failed the whole batch.
}
if (ErrorCodes::WouldChangeOwningShard == ex.code()) {
throw; // Fail this write so mongos can retry
}
auto txnParticipant = TransactionParticipant::get(opCtx);
if (txnParticipant && opCtx->inMultiDocumentTransaction()) {
if (isTransientTransactionError(
ex.code(), false /* hasWriteConcernError */, false /* isCommitOrAbort */)) {
// Tell the client to try the whole txn again, by returning ok: 0 with errorLabels.
throw;
}
// If we are in a transaction, we must fail the whole batch.
out->results.emplace_back(ex.toStatus());
txnParticipant.abortTransaction(opCtx);
return false;
}
if (ex.code() == ErrorCodes::StaleDbVersion || ErrorCodes::isStaleShardVersionError(ex)) {
if (!opCtx->getClient()->isInDirectClient()) {
auto& oss = OperationShardingState::get(opCtx);
oss.setShardingOperationFailedStatus(ex.toStatus());
}
// Since this is a routing error, it is guaranteed that all subsequent operations will fail
// with the same cause, so don't try doing any more operations. The command reply serializer
// will handle repeating this error for unordered writes.
out->results.emplace_back(ex.toStatus());
return false;
}
out->results.emplace_back(ex.toStatus());
return !wholeOp.getOrdered();
}
void insertDocuments(OperationContext* opCtx,
Collection* collection,
std::vector<InsertStatement>::iterator begin,
std::vector<InsertStatement>::iterator end,
bool fromMigrate) {
// Intentionally not using writeConflictRetry. That is handled by the caller so it can react to
// oversized batches.
WriteUnitOfWork wuow(opCtx);
// Acquire optimes and fill them in for each item in the batch.
// This must only be done for doc-locking storage engines, which are allowed to insert oplog
// documents out-of-timestamp-order. For other storage engines, the oplog entries must be
// physically written in timestamp order, so we defer optime assignment until the oplog is about
// to be written. Multidocument transactions should not generate opTimes because they are
// generated at the time of commit.
auto batchSize = std::distance(begin, end);
if (supportsDocLocking()) {
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
auto inTransaction = opCtx->inMultiDocumentTransaction();
if (!inTransaction && !replCoord->isOplogDisabledFor(opCtx, collection->ns())) {
// Populate 'slots' with new optimes for each insert.
// This also notifies the storage engine of each new timestamp.
auto oplogSlots = repl::getNextOpTimes(opCtx, batchSize);
auto slot = oplogSlots.begin();
for (auto it = begin; it != end; it++) {
it->oplogSlot = *slot++;
}
}
}
hangAndFailAfterDocumentInsertsReserveOpTimes.executeIf(
[&](const BSONObj& data) {
hangAndFailAfterDocumentInsertsReserveOpTimes.pauseWhileSet(opCtx);
uasserted(51269, "hangAndFailAfterDocumentInsertsReserveOpTimes fail point enabled");
},
[&](const BSONObj& data) {
// Check if the failpoint specifies no collection or matches the existing one.
const auto collElem = data["collectionNS"];
return !collElem || collection->ns().ns() == collElem.str();
});
uassertStatusOK(
collection->insertDocuments(opCtx, begin, end, &CurOp::get(opCtx)->debug(), fromMigrate));
wuow.commit();
}
/**
* Returns a OperationNotSupportedInTransaction error Status if we are in a transaction and
* operating on a capped collection.
*
* The behavior of an operation against a capped collection may differ across replica set members,
* where it can succeed on one member and fail on another, crashing the failing member. Prepared
* transactions are not allowed to fail, so capped collections will not be allowed on shards.
* Even in the unsharded case, capped collections are still problematic with transactions because
* they only allow one operation at a time because they enforce insertion order with a MODE_X
* collection lock, which we cannot hold in transactions.
*/
Status checkIfTransactionOnCappedColl(OperationContext* opCtx, Collection* collection) {
if (opCtx->inMultiDocumentTransaction() && collection->isCapped()) {
return {ErrorCodes::OperationNotSupportedInTransaction,
str::stream() << "Collection '" << collection->ns()
<< "' is a capped collection. Writes in transactions are not allowed "
"on capped collections."};
}
return Status::OK();
}
/**
* Returns true if caller should try to insert more documents. Does nothing else if batch is empty.
*/
bool insertBatchAndHandleErrors(OperationContext* opCtx,
const write_ops::Insert& wholeOp,
std::vector<InsertStatement>& batch,
LastOpFixer* lastOpFixer,
WriteResult* out,
bool fromMigrate) {
if (batch.empty())
return true;
auto& curOp = *CurOp::get(opCtx);
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangDuringBatchInsert,
opCtx,
"hangDuringBatchInsert",
[&wholeOp]() {
LOGV2(20889,
"Batch insert - hangDuringBatchInsert fail point enabled for namespace "
"{namespace}. Blocking until fail point is disabled",
"Batch insert - hangDuringBatchInsert fail point enabled for a namespace. "
"Blocking until fail point is disabled",
"namespace"_attr = wholeOp.getNamespace());
},
true, // Check for interrupt periodically.
wholeOp.getNamespace());
if (MONGO_unlikely(failAllInserts.shouldFail())) {
uasserted(ErrorCodes::InternalError, "failAllInserts failpoint active!");
}
boost::optional<AutoGetCollection> collection;
auto acquireCollection = [&] {
while (true) {
collection.emplace(
opCtx,
wholeOp.getNamespace(),
fixLockModeForSystemDotViewsChanges(wholeOp.getNamespace(), MODE_IX));
if (collection->getCollection())
break;
collection.reset(); // unlock.
makeCollection(opCtx, wholeOp.getNamespace());
}
curOp.raiseDbProfileLevel(
CollectionCatalog::get(opCtx).getDatabaseProfileLevel(wholeOp.getNamespace().db()));
assertCanWrite_inlock(opCtx, wholeOp.getNamespace());
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangWithLockDuringBatchInsert, opCtx, "hangWithLockDuringBatchInsert");
};
auto txnParticipant = TransactionParticipant::get(opCtx);
auto inTxn = txnParticipant && opCtx->inMultiDocumentTransaction();
bool shouldProceedWithBatchInsert = true;
try {
acquireCollection();
} catch (const DBException& ex) {
collection.reset();
if (inTxn) {
// It is not safe to ignore errors from collection creation while inside a
// multi-document transaction.
auto canContinue =
handleError(opCtx, ex, wholeOp.getNamespace(), wholeOp.getWriteCommandBase(), out);
invariant(!canContinue);
return false;
}
// Otherwise, proceed as though the batch insert block failed, since the batch insert block
// assumes `acquireCollection` is successful.
shouldProceedWithBatchInsert = false;
}
if (shouldProceedWithBatchInsert) {
try {
if (!collection->getCollection()->isCapped() && !inTxn && batch.size() > 1) {
// First try doing it all together. If all goes well, this is all we need to do.
// See Collection::_insertDocuments for why we do all capped inserts one-at-a-time.
lastOpFixer->startingOp();
insertDocuments(
opCtx, collection->getCollection(), batch.begin(), batch.end(), fromMigrate);
lastOpFixer->finishedOpSuccessfully();
globalOpCounters.gotInserts(batch.size());
ServerWriteConcernMetrics::get(opCtx)->recordWriteConcernForInserts(
opCtx->getWriteConcern(), batch.size());
SingleWriteResult result;
result.setN(1);
std::fill_n(std::back_inserter(out->results), batch.size(), std::move(result));
curOp.debug().additiveMetrics.incrementNinserted(batch.size());
return true;
}
} catch (const DBException&) {
// Ignore this failure and behave as if we never tried to do the combined batch
// insert. The loop below will handle reporting any non-transient errors.
collection.reset();
}
}
// Try to insert the batch one-at-a-time. This path is executed for singular batches,
// multi-statement transactions, capped collections, and if we failed all-at-once inserting.
for (auto it = batch.begin(); it != batch.end(); ++it) {
globalOpCounters.gotInsert();
ServerWriteConcernMetrics::get(opCtx)->recordWriteConcernForInsert(
opCtx->getWriteConcern());
try {
writeConflictRetry(opCtx, "insert", wholeOp.getNamespace().ns(), [&] {
try {
if (!collection)
acquireCollection();
// Transactions are not allowed to operate on capped collections.
uassertStatusOK(
checkIfTransactionOnCappedColl(opCtx, collection->getCollection()));
lastOpFixer->startingOp();
insertDocuments(opCtx, collection->getCollection(), it, it + 1, fromMigrate);
lastOpFixer->finishedOpSuccessfully();
SingleWriteResult result;
result.setN(1);
out->results.emplace_back(std::move(result));
curOp.debug().additiveMetrics.incrementNinserted(1);
} catch (...) {
// Release the lock following any error if we are not in multi-statement
// transaction. Among other things, this ensures that we don't sleep in the WCE
// retry loop with the lock held.
// If we are in multi-statement transaction and under a WUOW, we will
// not actually release the lock.
collection.reset();
throw;
}
});
} catch (const DBException& ex) {
bool canContinue =
handleError(opCtx, ex, wholeOp.getNamespace(), wholeOp.getWriteCommandBase(), out);
if (!canContinue) {
// Failed in ordered batch, or in a transaction, or from some unrecoverable error.
return false;
}
}
}
return true;
}
template <typename T>
StmtId getStmtIdForWriteOp(OperationContext* opCtx, const T& wholeOp, size_t opIndex) {
return opCtx->getTxnNumber() ? write_ops::getStmtIdForWriteAt(wholeOp, opIndex)
: kUninitializedStmtId;
}
SingleWriteResult makeWriteResultForInsertOrDeleteRetry() {
SingleWriteResult res;
res.setN(1);
res.setNModified(0);
return res;
}
} // namespace
WriteResult performInserts(OperationContext* opCtx,
const write_ops::Insert& wholeOp,
bool fromMigrate) {
// Insert performs its own retries, so we should only be within a WriteUnitOfWork when run in a
// transaction.
auto txnParticipant = TransactionParticipant::get(opCtx);
invariant(!opCtx->lockState()->inAWriteUnitOfWork() ||
(txnParticipant && opCtx->inMultiDocumentTransaction()));
auto& curOp = *CurOp::get(opCtx);
ON_BLOCK_EXIT([&] {
// This is the only part of finishCurOp we need to do for inserts because they reuse the
// top-level curOp. The rest is handled by the top-level entrypoint.
curOp.done();
Top::get(opCtx->getServiceContext())
.record(opCtx,
wholeOp.getNamespace().ns(),
LogicalOp::opInsert,
Top::LockType::WriteLocked,
durationCount<Microseconds>(curOp.elapsedTimeExcludingPauses()),
curOp.isCommand(),
curOp.getReadWriteType());
});
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
curOp.setNS_inlock(wholeOp.getNamespace().ns());
curOp.setLogicalOp_inlock(LogicalOp::opInsert);
curOp.ensureStarted();
curOp.debug().additiveMetrics.ninserted = 0;
}
uassertStatusOK(userAllowedWriteNS(wholeOp.getNamespace()));
DisableDocumentValidationIfTrue docValidationDisabler(
opCtx, wholeOp.getWriteCommandBase().getBypassDocumentValidation());
LastOpFixer lastOpFixer(opCtx, wholeOp.getNamespace());
WriteResult out;
out.results.reserve(wholeOp.getDocuments().size());
bool containsRetry = false;
ON_BLOCK_EXIT([&] { updateRetryStats(opCtx, containsRetry); });
size_t stmtIdIndex = 0;
size_t bytesInBatch = 0;
std::vector<InsertStatement> batch;
const size_t maxBatchSize = internalInsertMaxBatchSize.load();
const size_t maxBatchBytes = write_ops::insertVectorMaxBytes;
batch.reserve(std::min(wholeOp.getDocuments().size(), maxBatchSize));
for (auto&& doc : wholeOp.getDocuments()) {
const bool isLastDoc = (&doc == &wholeOp.getDocuments().back());
auto fixedDoc = fixDocumentForInsert(opCtx->getServiceContext(), doc);
if (!fixedDoc.isOK()) {
// Handled after we insert anything in the batch to be sure we report errors in the
// correct order. In an ordered insert, if one of the docs ahead of us fails, we should
// behave as-if we never got to this document.
} else {
const auto stmtId = getStmtIdForWriteOp(opCtx, wholeOp, stmtIdIndex++);
if (opCtx->getTxnNumber()) {
if (!opCtx->inMultiDocumentTransaction() &&
txnParticipant.checkStatementExecutedNoOplogEntryFetch(stmtId)) {
containsRetry = true;
RetryableWritesStats::get(opCtx)->incrementRetriedStatementsCount();
out.results.emplace_back(makeWriteResultForInsertOrDeleteRetry());
continue;
}
}
BSONObj toInsert = fixedDoc.getValue().isEmpty() ? doc : std::move(fixedDoc.getValue());
batch.emplace_back(stmtId, toInsert);
bytesInBatch += batch.back().doc.objsize();
if (!isLastDoc && batch.size() < maxBatchSize && bytesInBatch < maxBatchBytes)
continue; // Add more to batch before inserting.
}
bool canContinue =
insertBatchAndHandleErrors(opCtx, wholeOp, batch, &lastOpFixer, &out, fromMigrate);
batch.clear(); // We won't need the current batch any more.
bytesInBatch = 0;
if (canContinue && !fixedDoc.isOK()) {
globalOpCounters.gotInsert();
ServerWriteConcernMetrics::get(opCtx)->recordWriteConcernForInsert(
opCtx->getWriteConcern());
try {
uassertStatusOK(fixedDoc.getStatus());
MONGO_UNREACHABLE;
} catch (const DBException& ex) {
canContinue = handleError(
opCtx, ex, wholeOp.getNamespace(), wholeOp.getWriteCommandBase(), &out);
}
}
if (!canContinue)
break;
}
return out;
}
static SingleWriteResult performSingleUpdateOp(OperationContext* opCtx,
const NamespaceString& ns,
StmtId stmtId,
const UpdateRequest& updateRequest) {
const ExtensionsCallbackReal extensionsCallback(opCtx, &updateRequest.getNamespaceString());
ParsedUpdate parsedUpdate(opCtx, &updateRequest, extensionsCallback);
uassertStatusOK(parsedUpdate.parseRequest());
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangDuringBatchUpdate,
opCtx,
"hangDuringBatchUpdate",
[&ns]() {
LOGV2(20890,
"Batch update - hangDuringBatchUpdate fail point enabled for namespace "
"{namespace}. Blocking until fail point is disabled",
"Batch update - hangDuringBatchUpdate fail point enabled for a namespace. "
"Blocking until fail point is disabled",
"namespace"_attr = ns);
},
false /*checkForInterrupt*/,
ns);
if (MONGO_unlikely(failAllUpdates.shouldFail())) {
uasserted(ErrorCodes::InternalError, "failAllUpdates failpoint active!");
}
boost::optional<AutoGetCollection> collection;
while (true) {
collection.emplace(opCtx, ns, fixLockModeForSystemDotViewsChanges(ns, MODE_IX));
// If this is an upsert, which is an insert, we must have a collection.
// An update on a non-existant collection is okay and handled later.
if (collection->getCollection() || !updateRequest.isUpsert())
break;
collection.reset(); // unlock.
makeCollection(opCtx, ns);
}
if (auto coll = collection->getCollection()) {
// Transactions are not allowed to operate on capped collections.
uassertStatusOK(checkIfTransactionOnCappedColl(opCtx, coll));
}
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangWithLockDuringBatchUpdate, opCtx, "hangWithLockDuringBatchUpdate");
auto& curOp = *CurOp::get(opCtx);
if (collection->getDb()) {
curOp.raiseDbProfileLevel(CollectionCatalog::get(opCtx).getDatabaseProfileLevel(ns.db()));
}
assertCanWrite_inlock(opCtx, ns);
auto exec = uassertStatusOK(getExecutorUpdate(
&curOp.debug(), collection->getCollection(), &parsedUpdate, boost::none /* verbosity */));
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
CurOp::get(opCtx)->setPlanSummary_inlock(Explain::getPlanSummary(exec.get()));
}
exec->executePlan();
PlanSummaryStats summary;
Explain::getSummaryStats(*exec, &summary);
if (auto coll = collection->getCollection()) {
CollectionQueryInfo::get(coll).notifyOfQuery(opCtx, coll, summary);
}
if (curOp.shouldDBProfile()) {
BSONObjBuilder execStatsBob;
Explain::getWinningPlanStats(exec.get(), &execStatsBob);
curOp.debug().execStats = execStatsBob.obj();
}
const UpdateStats* updateStats = UpdateStage::getUpdateStats(exec.get());
UpdateStage::recordUpdateStatsInOpDebug(updateStats, &curOp.debug());
curOp.debug().setPlanSummaryMetrics(summary);
UpdateResult res = UpdateStage::makeUpdateResult(updateStats);
const bool didInsert = !res.upserted.isEmpty();
const long long nMatchedOrInserted = didInsert ? 1 : res.numMatched;
LastError::get(opCtx->getClient()).recordUpdate(res.existing, nMatchedOrInserted, res.upserted);
SingleWriteResult result;
result.setN(nMatchedOrInserted);
result.setNModified(res.numDocsModified);
result.setUpsertedId(res.upserted);
return result;
}
/**
* Performs a single update, retrying failure due to DuplicateKeyError when eligible.
*/
static SingleWriteResult performSingleUpdateOpWithDupKeyRetry(
OperationContext* opCtx,
const NamespaceString& ns,
StmtId stmtId,
const write_ops::UpdateOpEntry& op,
RuntimeConstants runtimeConstants,
const boost::optional<BSONObj>& letParams) {
globalOpCounters.gotUpdate();
ServerWriteConcernMetrics::get(opCtx)->recordWriteConcernForUpdate(opCtx->getWriteConcern());
auto& curOp = *CurOp::get(opCtx);
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
curOp.setNS_inlock(ns.ns());
curOp.setNetworkOp_inlock(dbUpdate);
curOp.setLogicalOp_inlock(LogicalOp::opUpdate);
curOp.setOpDescription_inlock(op.toBSON());
curOp.ensureStarted();
}
uassert(ErrorCodes::InvalidOptions,
"Cannot use (or request) retryable writes with multi=true",
opCtx->inMultiDocumentTransaction() || !opCtx->getTxnNumber() || !op.getMulti());
UpdateRequest request(op);
request.setNamespaceString(ns);
request.setRuntimeConstants(std::move(runtimeConstants));
if (letParams) {
request.setLetParameters(std::move(letParams));
}
request.setStmtId(stmtId);
request.setYieldPolicy(opCtx->inMultiDocumentTransaction() ? PlanExecutor::INTERRUPT_ONLY
: PlanExecutor::YIELD_AUTO);
size_t numAttempts = 0;
while (true) {
++numAttempts;
try {
return performSingleUpdateOp(opCtx, ns, stmtId, request);
} catch (ExceptionFor<ErrorCodes::DuplicateKey>& ex) {
const ExtensionsCallbackReal extensionsCallback(opCtx, &request.getNamespaceString());
ParsedUpdate parsedUpdate(opCtx, &request, extensionsCallback);
uassertStatusOK(parsedUpdate.parseRequest());
if (!parsedUpdate.hasParsedQuery()) {
uassertStatusOK(parsedUpdate.parseQueryToCQ());
}
if (!UpdateStage::shouldRetryDuplicateKeyException(
parsedUpdate, *ex.extraInfo<DuplicateKeyErrorInfo>())) {
throw;
}
logAndBackoff(4640402,
::mongo::logv2::LogComponent::kWrite,
logv2::LogSeverity::Debug(1),
numAttempts,
"Caught DuplicateKey exception during upsert",
"namespace"_attr = ns.ns());
}
}
MONGO_UNREACHABLE;
}
WriteResult performUpdates(OperationContext* opCtx, const write_ops::Update& wholeOp) {
// Update performs its own retries, so we should not be in a WriteUnitOfWork unless run in a
// transaction.
auto txnParticipant = TransactionParticipant::get(opCtx);
invariant(!opCtx->lockState()->inAWriteUnitOfWork() ||
(txnParticipant && opCtx->inMultiDocumentTransaction()));
uassertStatusOK(userAllowedWriteNS(wholeOp.getNamespace()));
DisableDocumentValidationIfTrue docValidationDisabler(
opCtx, wholeOp.getWriteCommandBase().getBypassDocumentValidation());
LastOpFixer lastOpFixer(opCtx, wholeOp.getNamespace());
bool containsRetry = false;
ON_BLOCK_EXIT([&] { updateRetryStats(opCtx, containsRetry); });
size_t stmtIdIndex = 0;
WriteResult out;
out.results.reserve(wholeOp.getUpdates().size());
// If the update command specified runtime constants, we adopt them. Otherwise, we set them to
// the current local and cluster time. These constants are applied to each update in the batch.
const auto& runtimeConstants =
wholeOp.getRuntimeConstants().value_or(Variables::generateRuntimeConstants(opCtx));
for (auto&& singleOp : wholeOp.getUpdates()) {
const auto stmtId = getStmtIdForWriteOp(opCtx, wholeOp, stmtIdIndex++);
if (opCtx->getTxnNumber()) {
if (!opCtx->inMultiDocumentTransaction()) {
if (auto entry = txnParticipant.checkStatementExecuted(opCtx, stmtId)) {
containsRetry = true;
RetryableWritesStats::get(opCtx)->incrementRetriedStatementsCount();
out.results.emplace_back(parseOplogEntryForUpdate(*entry));
continue;
}
}
}
// TODO: don't create nested CurOp for legacy writes.
// Add Command pointer to the nested CurOp.
auto& parentCurOp = *CurOp::get(opCtx);
const Command* cmd = parentCurOp.getCommand();
CurOp curOp(opCtx);
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
curOp.setCommand_inlock(cmd);
}
ON_BLOCK_EXIT([&] { finishCurOp(opCtx, &curOp); });
try {
lastOpFixer.startingOp();
out.results.emplace_back(performSingleUpdateOpWithDupKeyRetry(opCtx,
wholeOp.getNamespace(),
stmtId,
singleOp,
runtimeConstants,
wholeOp.getLet()));
lastOpFixer.finishedOpSuccessfully();
} catch (const DBException& ex) {
const bool canContinue =
handleError(opCtx, ex, wholeOp.getNamespace(), wholeOp.getWriteCommandBase(), &out);
if (!canContinue)
break;
}
}
return out;
}
static SingleWriteResult performSingleDeleteOp(OperationContext* opCtx,
const NamespaceString& ns,
StmtId stmtId,
const write_ops::DeleteOpEntry& op,
const RuntimeConstants& runtimeConstants,
const boost::optional<BSONObj>& letParams) {
uassert(ErrorCodes::InvalidOptions,
"Cannot use (or request) retryable writes with limit=0",
opCtx->inMultiDocumentTransaction() || !opCtx->getTxnNumber() || !op.getMulti());
globalOpCounters.gotDelete();
ServerWriteConcernMetrics::get(opCtx)->recordWriteConcernForDelete(opCtx->getWriteConcern());
auto& curOp = *CurOp::get(opCtx);
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
curOp.setNS_inlock(ns.ns());
curOp.setNetworkOp_inlock(dbDelete);
curOp.setLogicalOp_inlock(LogicalOp::opDelete);
curOp.setOpDescription_inlock(op.toBSON());
curOp.ensureStarted();
}
auto request = DeleteRequest{};
request.setNsString(ns);
request.setRuntimeConstants(runtimeConstants);
if (letParams)
request.setLet(letParams);
request.setQuery(op.getQ());
request.setCollation(write_ops::collationOf(op));
request.setMulti(op.getMulti());
request.setYieldPolicy(opCtx->inMultiDocumentTransaction() ? PlanExecutor::INTERRUPT_ONLY
: PlanExecutor::YIELD_AUTO);
request.setStmtId(stmtId);
request.setHint(op.getHint());
ParsedDelete parsedDelete(opCtx, &request);
uassertStatusOK(parsedDelete.parseRequest());
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangDuringBatchRemove,
opCtx,
"hangDuringBatchRemove",
[]() {
LOGV2(20891,
"Batch remove - hangDuringBatchRemove fail point enabled. Blocking until fail "
"point is disabled");
},
true // Check for interrupt periodically.
);
if (MONGO_unlikely(failAllRemoves.shouldFail())) {
uasserted(ErrorCodes::InternalError, "failAllRemoves failpoint active!");
}
AutoGetCollection collection(opCtx, ns, fixLockModeForSystemDotViewsChanges(ns, MODE_IX));
if (collection.getDb()) {
curOp.raiseDbProfileLevel(CollectionCatalog::get(opCtx).getDatabaseProfileLevel(ns.db()));
}
assertCanWrite_inlock(opCtx, ns);
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangWithLockDuringBatchRemove, opCtx, "hangWithLockDuringBatchRemove");
auto exec = uassertStatusOK(getExecutorDelete(
&curOp.debug(), collection.getCollection(), &parsedDelete, boost::none /* verbosity */));
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
CurOp::get(opCtx)->setPlanSummary_inlock(Explain::getPlanSummary(exec.get()));
}
exec->executePlan();
long long n = DeleteStage::getNumDeleted(*exec);
curOp.debug().additiveMetrics.ndeleted = n;
PlanSummaryStats summary;
Explain::getSummaryStats(*exec, &summary);
if (auto coll = collection.getCollection()) {
CollectionQueryInfo::get(coll).notifyOfQuery(opCtx, coll, summary);
}
curOp.debug().setPlanSummaryMetrics(summary);
if (curOp.shouldDBProfile()) {
BSONObjBuilder execStatsBob;
Explain::getWinningPlanStats(exec.get(), &execStatsBob);
curOp.debug().execStats = execStatsBob.obj();
}
LastError::get(opCtx->getClient()).recordDelete(n);
SingleWriteResult result;
result.setN(n);
return result;
}
WriteResult performDeletes(OperationContext* opCtx, const write_ops::Delete& wholeOp) {
// Delete performs its own retries, so we should not be in a WriteUnitOfWork unless we are in a
// transaction.
auto txnParticipant = TransactionParticipant::get(opCtx);
invariant(!opCtx->lockState()->inAWriteUnitOfWork() ||
(txnParticipant && opCtx->inMultiDocumentTransaction()));
uassertStatusOK(userAllowedWriteNS(wholeOp.getNamespace()));
DisableDocumentValidationIfTrue docValidationDisabler(
opCtx, wholeOp.getWriteCommandBase().getBypassDocumentValidation());
LastOpFixer lastOpFixer(opCtx, wholeOp.getNamespace());
bool containsRetry = false;
ON_BLOCK_EXIT([&] { updateRetryStats(opCtx, containsRetry); });
size_t stmtIdIndex = 0;
WriteResult out;
out.results.reserve(wholeOp.getDeletes().size());
// If the delete command specified runtime constants, we adopt them. Otherwise, we set them to
// the current local and cluster time. These constants are applied to each delete in the batch.
const auto& runtimeConstants =
wholeOp.getRuntimeConstants().value_or(Variables::generateRuntimeConstants(opCtx));
for (auto&& singleOp : wholeOp.getDeletes()) {
const auto stmtId = getStmtIdForWriteOp(opCtx, wholeOp, stmtIdIndex++);
if (opCtx->getTxnNumber()) {
if (!opCtx->inMultiDocumentTransaction() &&
txnParticipant.checkStatementExecutedNoOplogEntryFetch(stmtId)) {
containsRetry = true;
RetryableWritesStats::get(opCtx)->incrementRetriedStatementsCount();
out.results.emplace_back(makeWriteResultForInsertOrDeleteRetry());
continue;
}
}
// TODO: don't create nested CurOp for legacy writes.
// Add Command pointer to the nested CurOp.
auto& parentCurOp = *CurOp::get(opCtx);
const Command* cmd = parentCurOp.getCommand();
CurOp curOp(opCtx);
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
curOp.setCommand_inlock(cmd);
}
ON_BLOCK_EXIT([&] {
if (MONGO_unlikely(hangBeforeChildRemoveOpFinishes.shouldFail())) {
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangBeforeChildRemoveOpFinishes, opCtx, "hangBeforeChildRemoveOpFinishes");
}
finishCurOp(opCtx, &curOp);
if (MONGO_unlikely(hangBeforeChildRemoveOpIsPopped.shouldFail())) {
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangBeforeChildRemoveOpIsPopped, opCtx, "hangBeforeChildRemoveOpIsPopped");
}
});
try {
lastOpFixer.startingOp();
out.results.emplace_back(performSingleDeleteOp(opCtx,
wholeOp.getNamespace(),
stmtId,
singleOp,
runtimeConstants,
wholeOp.getLet()));
lastOpFixer.finishedOpSuccessfully();
} catch (const DBException& ex) {
const bool canContinue =
handleError(opCtx, ex, wholeOp.getNamespace(), wholeOp.getWriteCommandBase(), &out);
if (!canContinue)
break;
}
}
if (MONGO_unlikely(hangAfterAllChildRemoveOpsArePopped.shouldFail())) {
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangAfterAllChildRemoveOpsArePopped, opCtx, "hangAfterAllChildRemoveOpsArePopped");
}
return out;
}
} // namespace mongo
|