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
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
|
/**
* 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_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kCommand
#include "mongo/platform/basic.h"
#include "mongo/db/service_entry_point_common.h"
#include "mongo/base/checked_cast.h"
#include "mongo/bson/mutable/document.h"
#include "mongo/bson/util/bson_extract.h"
#include "mongo/db/audit.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/auth/impersonation_session.h"
#include "mongo/db/client.h"
#include "mongo/db/command_can_run_here.h"
#include "mongo/db/commands.h"
#include "mongo/db/commands/test_commands_enabled.h"
#include "mongo/db/commands/txn_cmds_gen.h"
#include "mongo/db/curop.h"
#include "mongo/db/curop_failpoint_helpers.h"
#include "mongo/db/curop_metrics.h"
#include "mongo/db/cursor_manager.h"
#include "mongo/db/dbdirectclient.h"
#include "mongo/db/handle_request_response.h"
#include "mongo/db/initialize_operation_session_info.h"
#include "mongo/db/introspect.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/lasterror.h"
#include "mongo/db/logical_clock.h"
#include "mongo/db/logical_session_id.h"
#include "mongo/db/logical_session_id_helpers.h"
#include "mongo/db/logical_time_validator.h"
#include "mongo/db/ops/write_ops.h"
#include "mongo/db/ops/write_ops_exec.h"
#include "mongo/db/query/find.h"
#include "mongo/db/read_concern.h"
#include "mongo/db/repl/optime.h"
#include "mongo/db/repl/read_concern_args.h"
#include "mongo/db/repl/repl_client_info.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/repl/speculative_majority_read_info.h"
#include "mongo/db/run_op_kill_cursors.h"
#include "mongo/db/s/operation_sharding_state.h"
#include "mongo/db/s/sharded_connection_info.h"
#include "mongo/db/s/sharding_state.h"
#include "mongo/db/s/transaction_coordinator_factory.h"
#include "mongo/db/service_entry_point_common.h"
#include "mongo/db/session_catalog_mongod.h"
#include "mongo/db/snapshot_window_util.h"
#include "mongo/db/stats/counters.h"
#include "mongo/db/stats/server_read_concern_metrics.h"
#include "mongo/db/stats/top.h"
#include "mongo/db/transaction_participant.h"
#include "mongo/db/transaction_validation.h"
#include "mongo/rpc/factory.h"
#include "mongo/rpc/get_status_from_command_result.h"
#include "mongo/rpc/message.h"
#include "mongo/rpc/metadata.h"
#include "mongo/rpc/metadata/logical_time_metadata.h"
#include "mongo/rpc/metadata/oplog_query_metadata.h"
#include "mongo/rpc/metadata/repl_set_metadata.h"
#include "mongo/rpc/metadata/tracking_metadata.h"
#include "mongo/rpc/op_msg.h"
#include "mongo/rpc/reply_builder_interface.h"
#include "mongo/util/fail_point_service.h"
#include "mongo/util/log.h"
#include "mongo/util/scopeguard.h"
namespace mongo {
MONGO_FAIL_POINT_DEFINE(rsStopGetMore);
MONGO_FAIL_POINT_DEFINE(respondWithNotPrimaryInCommandDispatch);
MONGO_FAIL_POINT_DEFINE(skipCheckingForNotMasterInCommandDispatch);
MONGO_FAIL_POINT_DEFINE(sleepMillisAfterCommandExecutionBegins);
MONGO_FAIL_POINT_DEFINE(waitAfterNewStatementBlocksBehindPrepare);
MONGO_FAIL_POINT_DEFINE(waitAfterCommandFinishesExecution);
// Tracks the number of times a legacy unacknowledged write failed due to
// not master error resulted in network disconnection.
Counter64 notMasterLegacyUnackWrites;
ServerStatusMetricField<Counter64> displayNotMasterLegacyUnackWrites(
"repl.network.notMasterLegacyUnacknowledgedWrites", ¬MasterLegacyUnackWrites);
// Tracks the number of times an unacknowledged write failed due to not master error
// resulted in network disconnection.
Counter64 notMasterUnackWrites;
ServerStatusMetricField<Counter64> displayNotMasterUnackWrites(
"repl.network.notMasterUnacknowledgedWrites", ¬MasterUnackWrites);
namespace {
using logger::LogComponent;
void generateLegacyQueryErrorResponse(const AssertionException& exception,
const QueryMessage& queryMessage,
CurOp* curop,
Message* response) {
curop->debug().errInfo = exception.toStatus();
log(LogComponent::kQuery) << "assertion " << exception.toString() << " ns:" << queryMessage.ns
<< " query:"
<< (queryMessage.query.valid(BSONVersion::kLatest)
? redact(queryMessage.query)
: "query object is corrupt");
if (queryMessage.ntoskip || queryMessage.ntoreturn) {
log(LogComponent::kQuery) << " ntoskip:" << queryMessage.ntoskip
<< " ntoreturn:" << queryMessage.ntoreturn;
}
BSONObjBuilder err;
err.append("$err", exception.reason());
err.append("code", exception.code());
err.append("ok", 0.0);
auto const extraInfo = exception.extraInfo();
if (extraInfo) {
extraInfo->serialize(&err);
}
BSONObj errObj = err.done();
const bool isStaleConfig = exception.code() == ErrorCodes::StaleConfig;
if (isStaleConfig) {
log(LogComponent::kQuery) << "stale version detected during query over " << queryMessage.ns
<< " : " << errObj;
}
BufBuilder bb;
bb.skip(sizeof(QueryResult::Value));
bb.appendBuf((void*)errObj.objdata(), errObj.objsize());
// TODO: call replyToQuery() from here instead of this!!! see dbmessage.h
QueryResult::View msgdata = bb.buf();
QueryResult::View qr = msgdata;
qr.setResultFlags(ResultFlag_ErrSet);
if (isStaleConfig) {
qr.setResultFlags(qr.getResultFlags() | ResultFlag_ShardConfigStale);
}
qr.msgdata().setLen(bb.len());
qr.msgdata().setOperation(opReply);
qr.setCursorId(0);
qr.setStartingFrom(0);
qr.setNReturned(1);
response->setData(bb.release());
}
void registerError(OperationContext* opCtx, const DBException& exception) {
LastError::get(opCtx->getClient()).setLastError(exception.code(), exception.reason());
CurOp::get(opCtx)->debug().errInfo = exception.toStatus();
}
void generateErrorResponse(OperationContext* opCtx,
rpc::ReplyBuilderInterface* replyBuilder,
const DBException& exception,
const BSONObj& replyMetadata,
BSONObj extraFields = {}) {
registerError(opCtx, exception);
// We could have thrown an exception after setting fields in the builder,
// so we need to reset it to a clean state just to be sure.
replyBuilder->reset();
replyBuilder->setCommandReply(exception.toStatus(), extraFields);
replyBuilder->getBodyBuilder().appendElements(replyMetadata);
}
/**
* Guard object for making a good-faith effort to enter maintenance mode and leave it when it
* goes out of scope.
*
* Sometimes we cannot set maintenance mode, in which case the call to setMaintenanceMode will
* return a non-OK status. This class does not treat that case as an error which means that
* anybody using it is assuming it is ok to continue execution without maintenance mode.
*
* TODO: This assumption needs to be audited and documented, or this behavior should be moved
* elsewhere.
*/
class MaintenanceModeSetter {
MaintenanceModeSetter(const MaintenanceModeSetter&) = delete;
MaintenanceModeSetter& operator=(const MaintenanceModeSetter&) = delete;
public:
MaintenanceModeSetter(OperationContext* opCtx)
: _opCtx(opCtx),
_maintenanceModeSet(
repl::ReplicationCoordinator::get(_opCtx)->setMaintenanceMode(true).isOK()) {}
~MaintenanceModeSetter() {
if (_maintenanceModeSet) {
repl::ReplicationCoordinator::get(_opCtx)
->setMaintenanceMode(false)
.transitional_ignore();
}
}
private:
OperationContext* const _opCtx;
const bool _maintenanceModeSet;
};
/**
* Given the specified command, returns an effective read concern which should be used or an error
* if the read concern is not valid for the command.
*/
StatusWith<repl::ReadConcernArgs> _extractReadConcern(const CommandInvocation* invocation,
const BSONObj& cmdObj,
bool startTransaction) {
repl::ReadConcernArgs readConcernArgs;
auto readConcernParseStatus = readConcernArgs.initialize(cmdObj);
if (!readConcernParseStatus.isOK()) {
return readConcernParseStatus;
}
auto readConcernLevel = readConcernArgs.getLevel();
if (startTransaction && readConcernLevel != repl::ReadConcernLevel::kSnapshotReadConcern &&
readConcernLevel != repl::ReadConcernLevel::kMajorityReadConcern &&
readConcernLevel != repl::ReadConcernLevel::kLocalReadConcern) {
return Status(
ErrorCodes::InvalidOptions,
"The readConcern level must be either 'local' (default), 'majority' or 'snapshot' in "
"order to run in a transaction");
}
if (startTransaction && readConcernArgs.getArgsOpTime()) {
return Status(ErrorCodes::InvalidOptions,
str::stream()
<< "The readConcern cannot specify '"
<< repl::ReadConcernArgs::kAfterOpTimeFieldName << "' in a transaction");
}
// There is no need to check if the command supports the read concern while in a transaction
// because all commands that are allowed to run in a transaction must support all the read
// concerns that can be used with a transaction.
if (!startTransaction && !invocation->supportsReadConcern(readConcernLevel)) {
return {ErrorCodes::InvalidOptions,
str::stream() << "Command does not support read concern "
<< readConcernArgs.toString()};
}
// If this command invocation asked for 'majority' read concern, supports blocking majority
// reads, and storage engine support for majority reads is disabled, then we set the majority
// read mechanism appropriately i.e. we utilize "speculative" read behavior.
if (readConcernArgs.getLevel() == repl::ReadConcernLevel::kMajorityReadConcern &&
invocation->allowsSpeculativeMajorityReads() &&
!serverGlobalParams.enableMajorityReadConcern) {
readConcernArgs.setMajorityReadMechanism(
repl::ReadConcernArgs::MajorityReadMechanism::kSpeculative);
}
return readConcernArgs;
}
/**
* For replica set members it returns the last known op time from opCtx. Otherwise will return
* uninitialized cluster time.
*/
LogicalTime getClientOperationTime(OperationContext* opCtx) {
auto const replCoord = repl::ReplicationCoordinator::get(opCtx);
const bool isReplSet =
replCoord->getReplicationMode() == repl::ReplicationCoordinator::modeReplSet;
if (!isReplSet) {
return LogicalTime();
}
return LogicalTime(
repl::ReplClientInfo::forClient(opCtx->getClient()).getLastOp().getTimestamp());
}
/**
* Returns the proper operationTime for a command. To construct the operationTime for replica set
* members, it uses the last optime in the oplog for writes, last committed optime for majority
* reads, and the last applied optime for every other read. An uninitialized cluster time is
* returned for non replica set members.
*
* The latest in-memory clusterTime is returned if the start operationTime is uninitialized.
*/
LogicalTime computeOperationTime(OperationContext* opCtx, LogicalTime startOperationTime) {
auto const replCoord = repl::ReplicationCoordinator::get(opCtx);
const bool isReplSet =
replCoord->getReplicationMode() == repl::ReplicationCoordinator::modeReplSet;
invariant(isReplSet);
if (startOperationTime == LogicalTime::kUninitialized) {
LOG(5) << "startOperationTime is uninitialized";
return LogicalTime(replCoord->getMyLastAppliedOpTime().getTimestamp());
}
auto operationTime = getClientOperationTime(opCtx);
invariant(operationTime >= startOperationTime);
// If the last operationTime has not changed, consider this command a read, and, for replica set
// members, construct the operationTime with the proper optime for its read concern level.
if (operationTime == startOperationTime) {
auto& readConcernArgs = repl::ReadConcernArgs::get(opCtx);
// Note: ReadConcernArgs::getLevel returns kLocal if none was set.
if (readConcernArgs.getLevel() == repl::ReadConcernLevel::kMajorityReadConcern) {
operationTime = LogicalTime(replCoord->getLastCommittedOpTime().getTimestamp());
} else {
operationTime = LogicalTime(replCoord->getMyLastAppliedOpTime().getTimestamp());
}
}
return operationTime;
}
/**
* Computes the proper $clusterTime and operationTime values to include in the command response and
* appends them to it. $clusterTime is added as metadata and operationTime as a command body field.
*
* The command body BSONObjBuilder is either the builder for the command body itself, or a builder
* for extra fields to be added to the reply when generating an error response.
*/
void appendClusterAndOperationTime(OperationContext* opCtx,
BSONObjBuilder* commandBodyFieldsBob,
BSONObjBuilder* metadataBob,
LogicalTime startTime) {
if (repl::ReplicationCoordinator::get(opCtx)->getReplicationMode() !=
repl::ReplicationCoordinator::modeReplSet ||
!LogicalClock::get(opCtx)->isEnabled()) {
return;
}
// Authorized clients always receive operationTime and dummy signed $clusterTime.
if (LogicalTimeValidator::isAuthorizedToAdvanceClock(opCtx)) {
auto operationTime = computeOperationTime(opCtx, startTime);
auto signedTime = SignedLogicalTime(
LogicalClock::get(opCtx)->getClusterTime(), TimeProofService::TimeProof(), 0);
dassert(signedTime.getTime() >= operationTime);
rpc::LogicalTimeMetadata(signedTime).writeToMetadata(metadataBob);
LOG(5) << "Appending operationTime to cmd response for authorized client: "
<< operationTime;
operationTime.appendAsOperationTime(commandBodyFieldsBob);
return;
}
// Servers without validators (e.g. a shard server not yet added to a cluster) do not return
// logical times to unauthorized clients.
auto validator = LogicalTimeValidator::get(opCtx);
if (!validator) {
return;
}
auto operationTime = computeOperationTime(opCtx, startTime);
auto signedTime = validator->trySignLogicalTime(LogicalClock::get(opCtx)->getClusterTime());
// If there were no keys, do not return $clusterTime or operationTime to unauthorized clients.
if (signedTime.getKeyId() == 0) {
return;
}
dassert(signedTime.getTime() >= operationTime);
rpc::LogicalTimeMetadata(signedTime).writeToMetadata(metadataBob);
LOG(5) << "Appending operationTime to cmd response: " << operationTime;
operationTime.appendAsOperationTime(commandBodyFieldsBob);
}
namespace {
void _abortUnpreparedOrStashPreparedTransaction(
OperationContext* opCtx, TransactionParticipant::Participant* txnParticipant) {
const bool isPrepared = txnParticipant->transactionIsPrepared();
try {
if (isPrepared)
txnParticipant->stashTransactionResources(opCtx);
else if (txnParticipant->transactionIsOpen())
txnParticipant->abortTransaction(opCtx);
} catch (...) {
// It is illegal for this to throw so we catch and log this here for diagnosability.
severe() << "Caught exception during transaction " << opCtx->getTxnNumber()
<< (isPrepared ? " stash " : " abort ") << opCtx->getLogicalSessionId()->toBSON()
<< ": " << exceptionToStatus();
std::terminate();
}
}
} // namespace
void invokeWithSessionCheckedOut(OperationContext* opCtx,
CommandInvocation* invocation,
const OperationSessionInfoFromClient& sessionOptions,
rpc::ReplyBuilderInterface* replyBuilder) {
// This constructor will check out the session. It handles the appropriate state management
// for both multi-statement transactions and retryable writes. Currently, only requests with
// a transaction number will check out the session.
MongoDOperationContextSession sessionTxnState(opCtx);
auto txnParticipant = TransactionParticipant::get(opCtx);
if (!opCtx->getClient()->isInDirectClient()) {
bool beganOrContinuedTxn{false};
// This loop allows new transactions on a session to block behind a previous prepared
// transaction on that session.
while (!beganOrContinuedTxn) {
try {
txnParticipant.beginOrContinue(opCtx,
*sessionOptions.getTxnNumber(),
sessionOptions.getAutocommit(),
sessionOptions.getStartTransaction());
beganOrContinuedTxn = true;
} catch (const ExceptionFor<ErrorCodes::PreparedTransactionInProgress>&) {
auto prepareCompleted = txnParticipant.onExitPrepare();
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&waitAfterNewStatementBlocksBehindPrepare,
opCtx,
"waitAfterNewStatementBlocksBehindPrepare");
// Check the session back in and wait for ongoing prepared transaction to complete.
MongoDOperationContextSession::checkIn(opCtx);
prepareCompleted.wait(opCtx);
MongoDOperationContextSession::checkOut(opCtx);
}
}
// Create coordinator if needed. If "startTransaction" is present, it must be true.
if (sessionOptions.getStartTransaction()) {
// If this shard has been selected as the coordinator, set up the coordinator state
// to be ready to receive votes.
if (sessionOptions.getCoordinator() == boost::optional<bool>(true)) {
createTransactionCoordinator(opCtx, *sessionOptions.getTxnNumber());
}
} else if (txnParticipant.transactionIsOpen()) {
const auto& readConcernArgs = repl::ReadConcernArgs::get(opCtx);
uassert(ErrorCodes::InvalidOptions,
"Only the first command in a transaction may specify a readConcern",
readConcernArgs.isEmpty());
}
// Release the transaction lock resources and abort storage transaction for unprepared
// transactions on failure to unstash the transaction resources to opCtx. We don't want to
// have this error guard for beginOrContinue as it can abort the transaction for any
// accidental invalid statements in the transaction.
auto abortOnError = makeGuard([&txnParticipant, opCtx] {
if (txnParticipant.transactionIsInProgress()) {
txnParticipant.abortTransaction(opCtx);
}
});
txnParticipant.unstashTransactionResources(opCtx, invocation->definition()->getName());
// Unstash success.
abortOnError.dismiss();
}
auto guard = makeGuard([opCtx, &txnParticipant] {
_abortUnpreparedOrStashPreparedTransaction(opCtx, &txnParticipant);
});
try {
invocation->run(opCtx, replyBuilder);
} catch (const ExceptionFor<ErrorCodes::CommandOnShardedViewNotSupportedOnMongod>&) {
// Exceptions are used to resolve views in a sharded cluster, so they should be handled
// specially to avoid unnecessary aborts.
// If "startTransaction" is present, it must be true.
if (sessionOptions.getStartTransaction()) {
// If the first command a shard receives in a transactions fails with this code, the
// shard may not be included in the final participant list if the router's retry after
// resolving the view does not re-target it, which is possible if the underlying
// collection is sharded. The shard's transaction should be preemptively aborted to
// avoid leaving it orphaned in this case, which is fine even if it is re-targeted
// because the retry will include "startTransaction" again and "restart" a transaction
// at the active txnNumber.
throw;
}
// If this shard has completed an earlier statement for this transaction, it must already be
// in the transaction's participant list, so it is guaranteed to learn its outcome.
txnParticipant.stashTransactionResources(opCtx);
guard.dismiss();
throw;
} catch (const ExceptionFor<ErrorCodes::WouldChangeOwningShard>&) {
txnParticipant.stashTransactionResources(opCtx);
txnParticipant.resetRetryableWriteState(opCtx);
guard.dismiss();
throw;
}
if (auto okField = replyBuilder->getBodyBuilder().asTempObj()["ok"]) {
// If ok is present, use its truthiness.
if (!okField.trueValue()) {
return;
}
}
// Stash or commit the transaction when the command succeeds.
txnParticipant.stashTransactionResources(opCtx);
guard.dismiss();
if (serverGlobalParams.clusterRole == ClusterRole::ShardServer ||
serverGlobalParams.clusterRole == ClusterRole::ConfigServer) {
auto txnResponseMetadata = txnParticipant.getResponseMetadata();
auto bodyBuilder = replyBuilder->getBodyBuilder();
txnResponseMetadata.serialize(&bodyBuilder);
}
}
bool runCommandImpl(OperationContext* opCtx,
CommandInvocation* invocation,
const OpMsgRequest& request,
rpc::ReplyBuilderInterface* replyBuilder,
LogicalTime startOperationTime,
const ServiceEntryPointCommon::Hooks& behaviors,
BSONObjBuilder* extraFieldsBuilder,
const OperationSessionInfoFromClient& sessionOptions) {
const Command* command = invocation->definition();
auto bytesToReserve = command->reserveBytesForReply();
// SERVER-22100: In Windows DEBUG builds, the CRT heap debugging overhead, in conjunction with the
// additional memory pressure introduced by reply buffer pre-allocation, causes the concurrency
// suite to run extremely slowly. As a workaround we do not pre-allocate in Windows DEBUG builds.
#ifdef _WIN32
if (kDebugBuild)
bytesToReserve = 0;
#endif
replyBuilder->reserveBytes(bytesToReserve);
const bool shouldCheckOutSession =
sessionOptions.getTxnNumber() && !shouldCommandSkipSessionCheckout(command->getName());
// getMore operations inherit a WriteConcern from their originating cursor. For example, if the
// originating command was an aggregate with a $out and batchSize: 0. Note that if the command
// only performed reads then we will not need to wait at all.
const bool shouldWaitForWriteConcern =
invocation->supportsWriteConcern() || command->getLogicalOp() == LogicalOp::opGetMore;
if (shouldWaitForWriteConcern) {
auto lastOpBeforeRun = repl::ReplClientInfo::forClient(opCtx->getClient()).getLastOp();
// Change the write concern while running the command.
const auto oldWC = opCtx->getWriteConcern();
ON_BLOCK_EXIT([&] { opCtx->setWriteConcern(oldWC); });
boost::optional<WriteConcernOptions> extractedWriteConcern;
if (command->getLogicalOp() == LogicalOp::opGetMore) {
// WriteConcern will be set up during command processing, it must not be specified on
// the command body.
behaviors.uassertCommandDoesNotSpecifyWriteConcern(request.body);
} else {
extractedWriteConcern.emplace(
uassertStatusOK(extractWriteConcern(opCtx, request.body)));
if (sessionOptions.getAutocommit()) {
validateWriteConcernForTransaction(*extractedWriteConcern,
invocation->definition()->getName());
}
opCtx->setWriteConcern(*extractedWriteConcern);
}
auto waitForWriteConcern = [&](auto&& bb) {
bool reallyWait = true;
failCommand.executeIf(
[&](const BSONObj& data) {
bb.append(data["writeConcernError"]);
reallyWait = false;
},
[&](const BSONObj& data) {
return CommandHelpers::shouldActivateFailCommandFailPoint(
data,
request.getCommandName(),
opCtx->getClient(),
invocation->ns()) &&
data.hasField("writeConcernError");
});
if (reallyWait) {
behaviors.waitForWriteConcern(opCtx, invocation, lastOpBeforeRun, bb);
}
};
try {
if (shouldCheckOutSession) {
invokeWithSessionCheckedOut(opCtx, invocation, sessionOptions, replyBuilder);
} else {
invocation->run(opCtx, replyBuilder);
}
} catch (const DBException& ex) {
// Do no-op write before returning NoSuchTransaction if command has writeConcern.
if (ex.toStatus().code() == ErrorCodes::NoSuchTransaction &&
!opCtx->getWriteConcern().usedDefault) {
TransactionParticipant::performNoopWrite(opCtx, "NoSuchTransaction error");
}
waitForWriteConcern(*extraFieldsBuilder);
throw;
}
waitForWriteConcern(replyBuilder->getBodyBuilder());
// With the exception of getMores inheriting the WriteConcern from the originating command,
// nothing in run() should change the writeConcern.
dassert(command->getLogicalOp() == LogicalOp::opGetMore
? !extractedWriteConcern
: (extractedWriteConcern &&
SimpleBSONObjComparator::kInstance.evaluate(
opCtx->getWriteConcern().toBSON() == extractedWriteConcern->toBSON())));
} else {
behaviors.uassertCommandDoesNotSpecifyWriteConcern(request.body);
if (shouldCheckOutSession) {
invokeWithSessionCheckedOut(opCtx, invocation, sessionOptions, replyBuilder);
} else {
invocation->run(opCtx, replyBuilder);
}
}
// This fail point blocks all commands which are running on the specified namespace, or which
// are present in the given list of commands.If no namespace or command list are provided,then
// the failpoint will block all commands.
waitAfterCommandFinishesExecution.execute([&](const BSONObj& data) {
auto ns = data["ns"].valueStringDataSafe();
auto commands =
data.hasField("commands") ? data["commands"].Array() : std::vector<BSONElement>();
// If 'ns' or 'commands' is not set, block for all the namespaces or commands respectively.
if ((ns.empty() || invocation->ns().ns() == ns) &&
(commands.empty() ||
std::any_of(commands.begin(), commands.end(), [&request](auto& element) {
return element.valueStringDataSafe() == request.getCommandName();
}))) {
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&waitAfterCommandFinishesExecution, opCtx, "waitAfterCommandFinishesExecution");
}
});
behaviors.waitForLinearizableReadConcern(opCtx);
// Wait for data to satisfy the read concern level, if necessary.
behaviors.waitForSpeculativeMajorityReadConcern(opCtx);
const bool ok = [&] {
auto body = replyBuilder->getBodyBuilder();
return CommandHelpers::extractOrAppendOk(body);
}();
behaviors.attachCurOpErrInfo(opCtx, replyBuilder->getBodyBuilder().asTempObj());
if (!ok) {
auto response = replyBuilder->getBodyBuilder().asTempObj();
auto codeField = response["code"];
const auto hasWriteConcern = response.hasField("writeConcernError");
if (codeField.isNumber()) {
auto code = ErrorCodes::Error(codeField.numberInt());
// Append the error labels for transient transaction errors.
auto errorLabels =
getErrorLabels(sessionOptions, command->getName(), code, hasWriteConcern);
replyBuilder->getBodyBuilder().appendElements(errorLabels);
}
}
auto commandBodyBob = replyBuilder->getBodyBuilder();
behaviors.appendReplyMetadata(opCtx, request, &commandBodyBob);
appendClusterAndOperationTime(opCtx, &commandBodyBob, &commandBodyBob, startOperationTime);
return ok;
}
/**
* Executes a command after stripping metadata, performing authorization checks,
* handling audit impersonation, and (potentially) setting maintenance mode. This method
* also checks that the command is permissible to run on the node given its current
* replication state. All the logic here is independent of any particular command; any
* functionality relevant to a specific command should be confined to its run() method.
*/
void execCommandDatabase(OperationContext* opCtx,
Command* command,
const OpMsgRequest& request,
rpc::ReplyBuilderInterface* replyBuilder,
const ServiceEntryPointCommon::Hooks& behaviors) {
CommandHelpers::uassertShouldAttemptParse(opCtx, command, request);
BSONObjBuilder extraFieldsBuilder;
auto startOperationTime = getClientOperationTime(opCtx);
auto invocation = command->parse(opCtx, request);
OperationSessionInfoFromClient sessionOptions;
try {
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
CurOp::get(opCtx)->setCommand_inlock(command);
}
sleepMillisAfterCommandExecutionBegins.execute([&](const BSONObj& data) {
auto numMillis = data["millis"].numberInt();
auto commands = data["commands"].Obj().getFieldNames<std::set<std::string>>();
// Only sleep for one of the specified commands.
if (commands.find(command->getName()) != commands.end()) {
mongo::sleepmillis(numMillis);
}
});
// TODO: move this back to runCommands when mongos supports OperationContext
// see SERVER-18515 for details.
rpc::readRequestMetadata(opCtx, request.body, command->requiresAuth());
rpc::TrackingMetadata::get(opCtx).initWithOperName(command->getName());
auto const replCoord = repl::ReplicationCoordinator::get(opCtx);
sessionOptions = initializeOperationSessionInfo(
opCtx,
request.body,
command->requiresAuth(),
command->attachLogicalSessionsToOpCtx(),
replCoord->getReplicationMode() == repl::ReplicationCoordinator::modeReplSet,
opCtx->getServiceContext()->getStorageEngine()->supportsDocLocking());
CommandHelpers::evaluateFailCommandFailPoint(opCtx, command->getName(), invocation->ns());
const auto dbname = request.getDatabase().toString();
uassert(
ErrorCodes::InvalidNamespace,
str::stream() << "Invalid database name: '" << dbname << "'",
NamespaceString::validDBName(dbname, NamespaceString::DollarInDbNameBehavior::Allow));
const auto allowTransactionsOnConfigDatabase =
(serverGlobalParams.clusterRole == ClusterRole::ConfigServer ||
serverGlobalParams.clusterRole == ClusterRole::ShardServer);
validateSessionOptions(sessionOptions,
command->getName(),
invocation->ns(),
allowTransactionsOnConfigDatabase);
std::unique_ptr<MaintenanceModeSetter> mmSetter;
BSONElement cmdOptionMaxTimeMSField;
BSONElement allowImplicitCollectionCreationField;
BSONElement helpField;
StringMap<int> topLevelFields;
for (auto&& element : request.body) {
StringData fieldName = element.fieldNameStringData();
if (fieldName == QueryRequest::cmdOptionMaxTimeMS) {
cmdOptionMaxTimeMSField = element;
} else if (fieldName == "allowImplicitCollectionCreation") {
allowImplicitCollectionCreationField = element;
} else if (fieldName == CommandHelpers::kHelpFieldName) {
helpField = element;
} else if (fieldName == "comment") {
opCtx->setComment(element.wrap());
} else if (fieldName == QueryRequest::queryOptionMaxTimeMS) {
uasserted(ErrorCodes::InvalidOptions,
"no such command option $maxTimeMs; use maxTimeMS instead");
}
uassert(ErrorCodes::FailedToParse,
str::stream() << "Parsed command object contains duplicate top level key: "
<< fieldName,
topLevelFields[fieldName]++ == 0);
}
if (CommandHelpers::isHelpRequest(helpField)) {
CurOp::get(opCtx)->ensureStarted();
// We disable last-error for help requests due to SERVER-11492, because config servers
// use help requests to determine which commands are database writes, and so must be
// forwarded to all config servers.
LastError::get(opCtx->getClient()).disable();
Command::generateHelpResponse(opCtx, replyBuilder, *command);
return;
}
ImpersonationSessionGuard guard(opCtx);
invocation->checkAuthorization(opCtx, request);
const bool iAmPrimary = replCoord->canAcceptWritesForDatabase_UNSAFE(opCtx, dbname);
if (!opCtx->getClient()->isInDirectClient() &&
!MONGO_unlikely(skipCheckingForNotMasterInCommandDispatch.shouldFail())) {
const bool inMultiDocumentTransaction = (sessionOptions.getAutocommit() == false);
auto allowed = command->secondaryAllowed(opCtx->getServiceContext());
bool alwaysAllowed = allowed == Command::AllowedOnSecondary::kAlways;
bool couldHaveOptedIn =
allowed == Command::AllowedOnSecondary::kOptIn && !inMultiDocumentTransaction;
bool optedIn =
couldHaveOptedIn && ReadPreferenceSetting::get(opCtx).canRunOnSecondary();
bool canRunHere = commandCanRunHere(opCtx, dbname, command, inMultiDocumentTransaction);
if (!canRunHere && couldHaveOptedIn) {
uasserted(ErrorCodes::NotMasterNoSlaveOk, "not master and slaveOk=false");
}
if (MONGO_unlikely(respondWithNotPrimaryInCommandDispatch.shouldFail())) {
uassert(ErrorCodes::NotMaster, "not primary", canRunHere);
} else {
uassert(ErrorCodes::NotMaster, "not master", canRunHere);
}
if (!command->maintenanceOk() &&
replCoord->getReplicationMode() == repl::ReplicationCoordinator::modeReplSet &&
!replCoord->canAcceptWritesForDatabase_UNSAFE(opCtx, dbname) &&
!replCoord->getMemberState().secondary()) {
uassert(ErrorCodes::NotMasterOrSecondary,
"node is recovering",
!replCoord->getMemberState().recovering());
uassert(ErrorCodes::NotMasterOrSecondary,
"node is not in primary or recovering state",
replCoord->getMemberState().primary());
// Check ticket SERVER-21432, slaveOk commands are allowed in drain mode
uassert(ErrorCodes::NotMasterOrSecondary,
"node is in drain mode",
optedIn || alwaysAllowed);
}
}
if (command->adminOnly()) {
LOG(2) << "command: " << request.getCommandName();
}
if (command->maintenanceMode()) {
mmSetter.reset(new MaintenanceModeSetter(opCtx));
}
if (command->shouldAffectCommandCounter()) {
OpCounters* opCounters = &globalOpCounters;
opCounters->gotCommand();
}
// Parse the 'maxTimeMS' command option, and use it to set a deadline for the operation on
// the OperationContext. The 'maxTimeMS' option unfortunately has a different meaning for a
// getMore command, where it is used to communicate the maximum time to wait for new inserts
// on tailable cursors, not as a deadline for the operation.
// TODO SERVER-34277 Remove the special handling for maxTimeMS for getMores. This will
// require introducing a new 'max await time' parameter for getMore, and eventually banning
// maxTimeMS altogether on a getMore command.
const int maxTimeMS =
uassertStatusOK(QueryRequest::parseMaxTimeMS(cmdOptionMaxTimeMSField));
if (maxTimeMS > 0 && command->getLogicalOp() != LogicalOp::opGetMore) {
uassert(40119,
"Illegal attempt to set operation deadline within DBDirectClient",
!opCtx->getClient()->isInDirectClient());
opCtx->setDeadlineAfterNowBy(Milliseconds{maxTimeMS}, ErrorCodes::MaxTimeMSExpired);
}
auto& readConcernArgs = repl::ReadConcernArgs::get(opCtx);
// If the parent operation runs in a transaction, we don't override the read concern.
auto skipReadConcern =
opCtx->getClient()->isInDirectClient() && opCtx->inMultiDocumentTransaction();
bool startTransaction = static_cast<bool>(sessionOptions.getStartTransaction());
if (!skipReadConcern) {
auto newReadConcernArgs = uassertStatusOK(
_extractReadConcern(invocation.get(), request.body, startTransaction));
{
// We must obtain the client lock to set the ReadConcernArgs on the operation
// context as it may be concurrently read by CurrentOp.
stdx::lock_guard<Client> lk(*opCtx->getClient());
readConcernArgs = std::move(newReadConcernArgs);
}
}
uassert(ErrorCodes::InvalidOptions,
"read concern level snapshot is only valid in a transaction",
opCtx->inMultiDocumentTransaction() ||
readConcernArgs.getLevel() != repl::ReadConcernLevel::kSnapshotReadConcern);
if (startTransaction) {
opCtx->lockState()->setSharedLocksShouldTwoPhaseLock(true);
opCtx->lockState()->setShouldConflictWithSecondaryBatchApplication(false);
}
auto& oss = OperationShardingState::get(opCtx);
if (!opCtx->getClient()->isInDirectClient() &&
readConcernArgs.getLevel() != repl::ReadConcernLevel::kAvailableReadConcern &&
(iAmPrimary ||
(readConcernArgs.hasLevel() || readConcernArgs.getArgsAfterClusterTime()))) {
oss.initializeClientRoutingVersions(invocation->ns(), request.body);
auto const shardingState = ShardingState::get(opCtx);
if (oss.hasShardVersion() || oss.hasDbVersion()) {
uassertStatusOK(shardingState->canAcceptShardedCommands());
}
behaviors.advanceConfigOpTimeFromRequestMetadata(opCtx);
}
oss.setAllowImplicitCollectionCreation(allowImplicitCollectionCreationField);
auto scoped = behaviors.scopedOperationCompletionShardingActions(opCtx);
// This may trigger the maxTimeAlwaysTimeOut failpoint.
auto status = opCtx->checkForInterruptNoAssert();
// We still proceed if the primary stepped down, but accept other kinds of interruptions.
// We defer to individual commands to allow themselves to be interruptible by stepdowns,
// since commands like 'voteRequest' should conversely continue executing.
if (status != ErrorCodes::PrimarySteppedDown &&
status != ErrorCodes::InterruptedDueToReplStateChange) {
uassertStatusOK(status);
}
CurOp::get(opCtx)->ensureStarted();
command->incrementCommandsExecuted();
if (logger::globalLogDomain()->shouldLog(logger::LogComponent::kTracking,
logger::LogSeverity::Debug(1)) &&
rpc::TrackingMetadata::get(opCtx).getParentOperId()) {
MONGO_LOG_COMPONENT(1, logger::LogComponent::kTracking)
<< rpc::TrackingMetadata::get(opCtx).toString();
rpc::TrackingMetadata::get(opCtx).setIsLogged(true);
}
behaviors.waitForReadConcern(opCtx, invocation.get(), request);
behaviors.setPrepareConflictBehaviorForReadConcern(opCtx, invocation.get());
try {
if (!runCommandImpl(opCtx,
invocation.get(),
request,
replyBuilder,
startOperationTime,
behaviors,
&extraFieldsBuilder,
sessionOptions)) {
command->incrementCommandsFailed();
}
} catch (const DBException& e) {
command->incrementCommandsFailed();
if (e.code() == ErrorCodes::Unauthorized) {
CommandHelpers::auditLogAuthEvent(opCtx, invocation.get(), request, e.code());
}
throw;
}
} catch (const DBException& e) {
if (e.code() == ErrorCodes::SnapshotTooOld) {
// SnapshotTooOld errors should never be thrown unless we are using a storage engine
// that supports snapshot read concern.
auto engine = opCtx->getServiceContext()->getStorageEngine();
invariant(engine && engine->supportsReadConcernSnapshot());
// SnapshotTooOld errors indicate that PIT ops are failing to find an available snapshot
// at their specified atClusterTime. Therefore, we'll try to increase the snapshot
// history window that the storage engine maintains in order to increase the likelihood
// of successful future PIT atClusterTime requests.
SnapshotWindowUtil::incrementSnapshotTooOldErrorCount();
SnapshotWindowUtil::increaseTargetSnapshotWindowSize(opCtx);
} else {
behaviors.handleException(e, opCtx);
}
// Append the error labels for transient transaction errors.
auto response = extraFieldsBuilder.asTempObj();
auto hasWriteConcern = response.hasField("writeConcernError");
auto errorLabels =
getErrorLabels(sessionOptions, command->getName(), e.code(), hasWriteConcern);
extraFieldsBuilder.appendElements(errorLabels);
BSONObjBuilder metadataBob;
behaviors.appendReplyMetadata(opCtx, request, &metadataBob);
// The read concern may not have yet been placed on the operation context, so attempt to
// parse it here, so if it is valid it can be used to compute the proper operationTime.
auto& readConcernArgs = repl::ReadConcernArgs::get(opCtx);
if (readConcernArgs.isEmpty()) {
auto readConcernArgsStatus = _extractReadConcern(invocation.get(), request.body, false);
if (readConcernArgsStatus.isOK()) {
// We must obtain the client lock to set the ReadConcernArgs on the operation
// context as it may be concurrently read by CurrentOp.
stdx::lock_guard<Client> lk(*opCtx->getClient());
readConcernArgs = readConcernArgsStatus.getValue();
}
}
appendClusterAndOperationTime(opCtx, &extraFieldsBuilder, &metadataBob, startOperationTime);
LOG(1) << "assertion while executing command '" << request.getCommandName() << "' "
<< "on database '" << request.getDatabase() << "' "
<< "with arguments '"
<< redact(ServiceEntryPointCommon::getRedactedCopyForLogging(command, request.body))
<< "': " << redact(e.toString());
generateErrorResponse(opCtx, replyBuilder, e, metadataBob.obj(), extraFieldsBuilder.obj());
}
}
/**
* Fills out CurOp / OpDebug with basic command info.
*/
void curOpCommandSetup(OperationContext* opCtx, const OpMsgRequest& request) {
auto curop = CurOp::get(opCtx);
curop->debug().iscommand = true;
// We construct a legacy $cmd namespace so we can fill in curOp using
// the existing logic that existed for OP_QUERY commands
NamespaceString nss(request.getDatabase(), "$cmd");
stdx::lock_guard<Client> lk(*opCtx->getClient());
curop->setOpDescription_inlock(request.body);
curop->markCommand_inlock();
curop->setNS_inlock(nss.ns());
}
DbResponse receivedCommands(OperationContext* opCtx,
const Message& message,
const ServiceEntryPointCommon::Hooks& behaviors) {
auto replyBuilder = rpc::makeReplyBuilder(rpc::protocolForMessage(message));
OpMsgRequest request;
[&] {
try { // Parse.
request = rpc::opMsgRequestFromAnyProtocol(message);
} catch (const DBException& ex) {
// If this error needs to fail the connection, propagate it out.
if (ErrorCodes::isConnectionFatalMessageParseError(ex.code()))
throw;
BSONObjBuilder metadataBob;
behaviors.appendReplyMetadataOnError(opCtx, &metadataBob);
BSONObjBuilder extraFieldsBuilder;
appendClusterAndOperationTime(
opCtx, &extraFieldsBuilder, &metadataBob, LogicalTime::kUninitialized);
// Otherwise, reply with the parse error. This is useful for cases where parsing fails
// due to user-supplied input, such as the document too deep error. Since we failed
// during parsing, we can't log anything about the command.
LOG(1) << "assertion while parsing command: " << ex.toString();
generateErrorResponse(
opCtx, replyBuilder.get(), ex, metadataBob.obj(), extraFieldsBuilder.obj());
return; // From lambda. Don't try executing if parsing failed.
}
try { // Execute.
curOpCommandSetup(opCtx, request);
Command* c = nullptr;
// In the absence of a Command object, no redaction is possible. Therefore
// to avoid displaying potentially sensitive information in the logs,
// we restrict the log message to the name of the unrecognized command.
// However, the complete command object will still be echoed to the client.
if (!(c = CommandHelpers::findCommand(request.getCommandName()))) {
globalCommandRegistry()->incrementUnknownCommands();
std::string msg = str::stream()
<< "no such command: '" << request.getCommandName() << "'";
LOG(2) << msg;
uasserted(ErrorCodes::CommandNotFound, str::stream() << msg);
}
LOG(2) << "run command " << request.getDatabase() << ".$cmd" << ' '
<< redact(ServiceEntryPointCommon::getRedactedCopyForLogging(c, request.body));
{
// Try to set this as early as possible, as soon as we have figured out the command.
stdx::lock_guard<Client> lk(*opCtx->getClient());
CurOp::get(opCtx)->setLogicalOp_inlock(c->getLogicalOp());
}
execCommandDatabase(opCtx, c, request, replyBuilder.get(), behaviors);
} catch (const DBException& ex) {
BSONObjBuilder metadataBob;
behaviors.appendReplyMetadataOnError(opCtx, &metadataBob);
BSONObjBuilder extraFieldsBuilder;
appendClusterAndOperationTime(
opCtx, &extraFieldsBuilder, &metadataBob, LogicalTime::kUninitialized);
LOG(1) << "assertion while executing command '" << request.getCommandName() << "' "
<< "on database '" << request.getDatabase() << "': " << ex.toString();
generateErrorResponse(
opCtx, replyBuilder.get(), ex, metadataBob.obj(), extraFieldsBuilder.obj());
}
}();
if (OpMsg::isFlagSet(message, OpMsg::kMoreToCome)) {
// Close the connection to get client to go through server selection again.
if (LastError::get(opCtx->getClient()).hadNotMasterError()) {
notMasterUnackWrites.increment();
uasserted(ErrorCodes::NotMaster,
str::stream()
<< "Not-master error while processing '" << request.getCommandName()
<< "' operation on '" << request.getDatabase() << "' database via "
<< "fire-and-forget command execution.");
}
return {}; // Don't reply.
}
DbResponse dbResponse;
if (OpMsg::isFlagSet(message, OpMsg::kExhaustSupported)) {
auto responseObj = replyBuilder->getBodyBuilder().asTempObj();
auto cursorObj = responseObj.getObjectField("cursor");
if (responseObj.getField("ok").trueValue() && !cursorObj.isEmpty()) {
dbResponse.exhaustNS = cursorObj.getField("ns").String();
dbResponse.exhaustCursorId = cursorObj.getField("id").numberLong();
}
}
dbResponse.response = replyBuilder->done();
CurOp::get(opCtx)->debug().responseLength = dbResponse.response.header().dataLen();
return dbResponse;
}
DbResponse receivedQuery(OperationContext* opCtx,
const NamespaceString& nss,
Client& c,
const Message& m,
const ServiceEntryPointCommon::Hooks& behaviors) {
invariant(!nss.isCommand());
globalOpCounters.gotQuery();
ServerReadConcernMetrics::get(opCtx)->recordReadConcern(repl::ReadConcernArgs::get(opCtx));
DbMessage d(m);
QueryMessage q(d);
CurOp& op = *CurOp::get(opCtx);
DbResponse dbResponse;
try {
Client* client = opCtx->getClient();
Status status = AuthorizationSession::get(client)->checkAuthForFind(nss, false);
audit::logQueryAuthzCheck(client, nss, q.query, status.code());
uassertStatusOK(status);
dbResponse.exhaustNS = runQuery(opCtx, q, nss, dbResponse.response);
} catch (const AssertionException& e) {
behaviors.handleException(e, opCtx);
dbResponse.response.reset();
generateLegacyQueryErrorResponse(e, q, &op, &dbResponse.response);
}
op.debug().responseLength = dbResponse.response.header().dataLen();
return dbResponse;
}
void receivedKillCursors(OperationContext* opCtx, const Message& m) {
LastError::get(opCtx->getClient()).disable();
DbMessage dbmessage(m);
int n = dbmessage.pullInt();
if (n > 2000) {
(n < 30000 ? warning() : error()) << "receivedKillCursors, n=" << n;
uassert(51250, "must kill fewer than 30000 cursors", n < 30000);
}
uassert(31289, str::stream() << "must kill at least 1 cursor, n=" << n, n >= 1);
massert(13658,
str::stream() << "bad kill cursors size: " << m.dataSize(),
m.dataSize() == 8 + (8 * n));
const char* cursorArray = dbmessage.getArray(n);
int found = runOpKillCursors(opCtx, static_cast<size_t>(n), cursorArray);
if (shouldLog(logger::LogSeverity::Debug(1)) || found != n) {
LOG(found == n ? 1 : 0) << "killcursors: found " << found << " of " << n;
}
}
void receivedInsert(OperationContext* opCtx, const NamespaceString& nsString, const Message& m) {
auto insertOp = InsertOp::parseLegacy(m);
invariant(insertOp.getNamespace() == nsString);
for (const auto& obj : insertOp.getDocuments()) {
Status status =
AuthorizationSession::get(opCtx->getClient())->checkAuthForInsert(opCtx, nsString);
audit::logInsertAuthzCheck(opCtx->getClient(), nsString, obj, status.code());
uassertStatusOK(status);
}
performInserts(opCtx, insertOp);
}
void receivedUpdate(OperationContext* opCtx, const NamespaceString& nsString, const Message& m) {
auto updateOp = UpdateOp::parseLegacy(m);
auto& singleUpdate = updateOp.getUpdates()[0];
invariant(updateOp.getNamespace() == nsString);
Status status = AuthorizationSession::get(opCtx->getClient())
->checkAuthForUpdate(opCtx,
nsString,
singleUpdate.getQ(),
singleUpdate.getU(),
singleUpdate.getUpsert());
audit::logUpdateAuthzCheck(opCtx->getClient(),
nsString,
singleUpdate.getQ(),
singleUpdate.getU(),
singleUpdate.getUpsert(),
singleUpdate.getMulti(),
status.code());
uassertStatusOK(status);
performUpdates(opCtx, updateOp);
}
void receivedDelete(OperationContext* opCtx, const NamespaceString& nsString, const Message& m) {
auto deleteOp = DeleteOp::parseLegacy(m);
auto& singleDelete = deleteOp.getDeletes()[0];
invariant(deleteOp.getNamespace() == nsString);
Status status = AuthorizationSession::get(opCtx->getClient())
->checkAuthForDelete(opCtx, nsString, singleDelete.getQ());
audit::logDeleteAuthzCheck(opCtx->getClient(), nsString, singleDelete.getQ(), status.code());
uassertStatusOK(status);
performDeletes(opCtx, deleteOp);
}
DbResponse receivedGetMore(OperationContext* opCtx,
const Message& m,
CurOp& curop,
bool* shouldLogOpDebug) {
globalOpCounters.gotGetMore();
DbMessage d(m);
const char* ns = d.getns();
int ntoreturn = d.pullInt();
uassert(
34419, str::stream() << "Invalid ntoreturn for OP_GET_MORE: " << ntoreturn, ntoreturn >= 0);
long long cursorid = d.pullInt64();
curop.debug().ntoreturn = ntoreturn;
curop.debug().cursorid = cursorid;
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
CurOp::get(opCtx)->setNS_inlock(ns);
}
bool exhaust = false;
bool isCursorAuthorized = false;
DbResponse dbresponse;
try {
const NamespaceString nsString(ns);
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Invalid ns [" << ns << "]",
nsString.isValid());
Status status = AuthorizationSession::get(opCtx->getClient())
->checkAuthForGetMore(nsString, cursorid, false);
audit::logGetMoreAuthzCheck(opCtx->getClient(), nsString, cursorid, status.code());
uassertStatusOK(status);
while (MONGO_unlikely(rsStopGetMore.shouldFail())) {
sleepmillis(0);
}
dbresponse.response =
getMore(opCtx, ns, ntoreturn, cursorid, &exhaust, &isCursorAuthorized);
} catch (AssertionException& e) {
if (isCursorAuthorized) {
// Make sure that killCursorGlobal does not throw an exception if it is interrupted.
UninterruptibleLockGuard noInterrupt(opCtx->lockState());
// If an error was thrown prior to auth checks, then the cursor should remain alive in
// order to prevent an unauthorized user from resulting in the death of a cursor. In
// other error cases, the cursor is dead and should be cleaned up.
//
// If killing the cursor fails, ignore the error and don't try again. The cursor should
// be reaped by the client cursor timeout thread.
CursorManager::get(opCtx)
->killCursor(opCtx, cursorid, false /* shouldAudit */)
.ignore();
}
BSONObjBuilder err;
err.append("$err", e.reason());
err.append("code", e.code());
BSONObj errObj = err.obj();
curop.debug().errInfo = e.toStatus();
dbresponse = replyToQuery(errObj, ResultFlag_ErrSet);
curop.debug().responseLength = dbresponse.response.header().dataLen();
curop.debug().nreturned = 1;
*shouldLogOpDebug = true;
return dbresponse;
}
curop.debug().responseLength = dbresponse.response.header().dataLen();
auto queryResult = QueryResult::ConstView(dbresponse.response.buf());
curop.debug().nreturned = queryResult.getNReturned();
if (exhaust) {
curop.debug().exhaust = true;
dbresponse.exhaustNS = ns;
}
return dbresponse;
}
} // namespace
BSONObj ServiceEntryPointCommon::getRedactedCopyForLogging(const Command* command,
const BSONObj& cmdObj) {
mutablebson::Document cmdToLog(cmdObj, mutablebson::Document::kInPlaceDisabled);
command->snipForLogging(&cmdToLog);
BSONObjBuilder bob;
cmdToLog.writeTo(&bob);
return bob.obj();
}
DbResponse ServiceEntryPointCommon::handleRequest(OperationContext* opCtx,
const Message& m,
const Hooks& behaviors) {
// before we lock...
NetworkOp op = m.operation();
bool isCommand = false;
DbMessage dbmsg(m);
Client& c = *opCtx->getClient();
if (c.isInDirectClient()) {
if (!opCtx->getLogicalSessionId() || !opCtx->getTxnNumber()) {
invariant(!opCtx->inMultiDocumentTransaction() &&
!opCtx->lockState()->inAWriteUnitOfWork());
}
} else {
LastError::get(c).startRequest();
AuthorizationSession::get(c)->startRequest(opCtx);
// We should not be holding any locks at this point
invariant(!opCtx->lockState()->isLocked());
}
const char* ns = dbmsg.messageShouldHaveNs() ? dbmsg.getns() : nullptr;
const NamespaceString nsString = ns ? NamespaceString(ns) : NamespaceString();
if (op == dbQuery) {
if (nsString.isCommand()) {
isCommand = true;
}
} else if (op == dbMsg) {
isCommand = true;
}
CurOp& currentOp = *CurOp::get(opCtx);
{
stdx::lock_guard<Client> lk(*opCtx->getClient());
// Commands handling code will reset this if the operation is a command
// which is logically a basic CRUD operation like query, insert, etc.
currentOp.setNetworkOp_inlock(op);
currentOp.setLogicalOp_inlock(networkOpToLogicalOp(op));
}
OpDebug& debug = currentOp.debug();
boost::optional<long long> slowMsOverride;
bool forceLog = false;
DbResponse dbresponse;
if (op == dbMsg || (op == dbQuery && isCommand)) {
dbresponse = receivedCommands(opCtx, m, behaviors);
} else if (op == dbQuery) {
invariant(!isCommand);
opCtx->markKillOnClientDisconnect();
dbresponse = receivedQuery(opCtx, nsString, c, m, behaviors);
} else if (op == dbGetMore) {
dbresponse = receivedGetMore(opCtx, m, currentOp, &forceLog);
} else {
// The remaining operations do not return any response. They are fire-and-forget.
try {
if (op == dbKillCursors) {
currentOp.ensureStarted();
slowMsOverride = 10;
receivedKillCursors(opCtx, m);
} else if (op != dbInsert && op != dbUpdate && op != dbDelete) {
log() << " operation isn't supported: " << static_cast<int>(op);
currentOp.done();
forceLog = true;
} else {
if (!opCtx->getClient()->isInDirectClient()) {
uassert(18663,
str::stream() << "legacy writeOps not longer supported for "
<< "versioned connections, ns: " << nsString.ns()
<< ", op: " << networkOpToString(op),
!ShardedConnectionInfo::get(&c, false));
}
if (!nsString.isValid()) {
uassert(16257, str::stream() << "Invalid ns [" << ns << "]", false);
} else if (op == dbInsert) {
receivedInsert(opCtx, nsString, m);
} else if (op == dbUpdate) {
receivedUpdate(opCtx, nsString, m);
} else if (op == dbDelete) {
receivedDelete(opCtx, nsString, m);
} else {
MONGO_UNREACHABLE;
}
}
} catch (const AssertionException& ue) {
LastError::get(c).setLastError(ue.code(), ue.reason());
LOG(3) << " Caught Assertion in " << networkOpToString(op) << ", continuing "
<< redact(ue);
debug.errInfo = ue.toStatus();
}
// A NotMaster error can be set either within receivedInsert/receivedUpdate/receivedDelete
// or within the AssertionException handler above. Either way, we want to throw an
// exception here, which will cause the client to be disconnected.
if (LastError::get(opCtx->getClient()).hadNotMasterError()) {
notMasterLegacyUnackWrites.increment();
uasserted(ErrorCodes::NotMaster,
str::stream()
<< "Not-master error while processing '" << networkOpToString(op)
<< "' operation on '" << nsString << "' namespace via legacy "
<< "fire-and-forget command execution.");
}
}
// 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 = currentOp.completeAndLogOperation(
opCtx, MONGO_LOG_DEFAULT_COMPONENT, dbresponse.response.size(), slowMsOverride, forceLog);
Top::get(opCtx->getServiceContext())
.incrementGlobalLatencyStats(
opCtx,
durationCount<Microseconds>(currentOp.elapsedTimeExcludingPauses()),
currentOp.getReadWriteType());
if (currentOp.shouldDBProfile(shouldSample)) {
// Performance profiling is on
if (opCtx->lockState()->isReadLocked()) {
LOG(1) << "note: not profiling because recursive read lock";
} else if (c.isInDirectClient()) {
LOG(1) << "note: not profiling because we are in DBDirectClient";
} else if (behaviors.lockedForWriting()) {
// TODO SERVER-26825: Fix race condition where fsyncLock is acquired post
// lockedForWriting() call but prior to profile collection lock acquisition.
LOG(1) << "note: not profiling because doing fsync+lock";
} else if (storageGlobalParams.readOnly) {
LOG(1) << "note: not profiling because server is read-only";
} else {
invariant(!opCtx->lockState()->inAWriteUnitOfWork());
profile(opCtx, op);
}
}
recordCurOpMetrics(opCtx);
return dbresponse;
}
ServiceEntryPointCommon::Hooks::~Hooks() = default;
} // namespace mongo
|