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
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
|
/**
* 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::kStorage
#include "mongo/platform/basic.h"
#include "mongo/db/index_builds_coordinator.h"
#include "mongo/db/catalog/collection_catalog.h"
#include "mongo/db/catalog/commit_quorum_options.h"
#include "mongo/db/catalog/database_holder.h"
#include "mongo/db/catalog/index_build_entry_gen.h"
#include "mongo/db/catalog/index_timestamp_helper.h"
#include "mongo/db/catalog/uncommitted_collections.h"
#include "mongo/db/catalog_raii.h"
#include "mongo/db/concurrency/locker.h"
#include "mongo/db/concurrency/replication_state_transition_lock_guard.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/curop.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/index_build_entry_helpers.h"
#include "mongo/db/op_observer.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/repl/member_state.h"
#include "mongo/db/repl/replication_coordinator.h"
#include "mongo/db/repl/timestamp_block.h"
#include "mongo/db/s/collection_sharding_state.h"
#include "mongo/db/s/database_sharding_state.h"
#include "mongo/db/server_options.h"
#include "mongo/db/server_recovery.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/durable_catalog.h"
#include "mongo/logv2/log.h"
#include "mongo/s/shard_key_pattern.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/str.h"
namespace mongo {
MONGO_FAIL_POINT_DEFINE(hangAfterIndexBuildFirstDrain);
MONGO_FAIL_POINT_DEFINE(hangAfterIndexBuildSecondDrain);
MONGO_FAIL_POINT_DEFINE(hangAfterIndexBuildDumpsInsertsFromBulk);
MONGO_FAIL_POINT_DEFINE(hangAfterInitializingIndexBuild);
MONGO_FAIL_POINT_DEFINE(failIndexBuildOnCommit);
namespace {
constexpr StringData kCreateIndexesFieldName = "createIndexes"_sd;
constexpr StringData kCommitIndexBuildFieldName = "commitIndexBuild"_sd;
constexpr StringData kAbortIndexBuildFieldName = "abortIndexBuild"_sd;
constexpr StringData kIndexesFieldName = "indexes"_sd;
constexpr StringData kKeyFieldName = "key"_sd;
constexpr StringData kUniqueFieldName = "unique"_sd;
/**
* Checks if unique index specification is compatible with sharding configuration.
*/
void checkShardKeyRestrictions(OperationContext* opCtx,
const NamespaceString& nss,
const BSONObj& newIdxKey) {
UncommittedCollections::get(opCtx).invariantHasExclusiveAccessToCollection(opCtx, nss);
const auto collDesc = CollectionShardingState::get(opCtx, nss)->getCollectionDescription();
if (!collDesc.isSharded())
return;
const ShardKeyPattern shardKeyPattern(collDesc.getKeyPattern());
uassert(ErrorCodes::CannotCreateIndex,
str::stream() << "cannot create unique index over " << newIdxKey
<< " with shard key pattern " << shardKeyPattern.toBSON(),
shardKeyPattern.isUniqueIndexCompatible(newIdxKey));
}
/**
* Returns true if we should build the indexes an empty collection using the IndexCatalog and
* bypass the index build registration.
*/
bool shouldBuildIndexesOnEmptyCollectionSinglePhased(OperationContext* opCtx,
Collection* collection,
IndexBuildProtocol protocol) {
const auto& nss = collection->ns();
invariant(opCtx->lockState()->isCollectionLockedForMode(nss, MODE_X), str::stream() << nss);
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
// Check whether the replica set member's config has {buildIndexes:false} set, which means
// we are not allowed to build non-_id indexes on this server.
if (!replCoord->buildsIndexes()) {
return false;
}
// Secondaries should not bypass index build registration (and _runIndexBuild()) for two phase
// index builds because they need to report index build progress to the primary per commit
// quorum.
if (IndexBuildProtocol::kTwoPhase == protocol && replCoord->getSettings().usingReplSets() &&
!replCoord->canAcceptWritesFor(opCtx, nss)) {
return false;
}
// We use the fast count information, through Collection::numRecords(), to determine if the
// collection is empty. However, this information is either unavailable or inaccurate when the
// node is in certain replication states, such as recovery or rollback. In these cases, we
// have to build the index by scanning the collection.
auto memberState = replCoord->getMemberState();
if (memberState.rollback()) {
return false;
}
if (inReplicationRecovery(opCtx->getServiceContext())) {
return false;
}
// Now, it's fine to trust Collection::isEmpty().
// Fast counts are prone to both false positives and false negatives on unclean shutdowns. False
// negatives can cause to skip index building. And, false positives can cause mismatch in number
// of index entries among the nodes in the replica set. So, verify the collection is really
// empty by opening the WT cursor and reading the first document.
return collection->isEmpty(opCtx);
}
/*
* Determines whether to skip the index build state transition check.
* Index builder not using ReplIndexBuildState::waitForNextAction to signal primary and secondaries
* to commit or abort signal will violate index build state transition. So, we should skip state
* transition verification. Otherwise, we would invariant.
*/
bool shouldSkipIndexBuildStateTransitionCheck(OperationContext* opCtx,
IndexBuildProtocol protocol) {
const auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (replCoord->getSettings().usingReplSets() && protocol == IndexBuildProtocol::kTwoPhase) {
return false;
}
return true;
}
/**
* Removes the index build from the config.system.indexBuilds collection after the primary has
* written the commitIndexBuild or abortIndexBuild oplog entry.
*/
void removeIndexBuildEntryAfterCommitOrAbort(OperationContext* opCtx,
const NamespaceStringOrUUID& dbAndUUID,
const ReplIndexBuildState& replState) {
if (IndexBuildProtocol::kSinglePhase == replState.protocol) {
return;
}
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (!replCoord->canAcceptWritesFor(opCtx, dbAndUUID)) {
return;
}
auto status = indexbuildentryhelpers::removeIndexBuildEntry(opCtx, replState.buildUUID);
// If we fail to remove the document from config.system.indexBuilds, it is because the document
// or collection is missing. In any case, we do not need to fail the commit or abort operation.
// TODO(SERVER-47323): Do not ignore removeIndexBuildEntry() errors. Convert to fatal assertion.
if (!status.isOK()) {
LOGV2(4763501,
"Unable to remove index build from system collection. Ignoring error",
"buildUUID"_attr = replState.buildUUID,
"collectionUUID"_attr = replState.collectionUUID,
"status"_attr = status);
}
}
/**
* Replicates a commitIndexBuild oplog entry for two-phase builds, which signals downstream
* secondary nodes to commit the index build.
*/
void onCommitIndexBuild(OperationContext* opCtx,
const NamespaceString& nss,
std::shared_ptr<ReplIndexBuildState> replState) {
const auto& buildUUID = replState->buildUUID;
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
opCtx->recoveryUnit()->onCommit([replState, skipCheck](boost::optional<Timestamp> commitTime) {
stdx::unique_lock<Latch> lk(replState->mutex);
replState->indexBuildState.setState(IndexBuildState::kCommitted, skipCheck);
});
if (IndexBuildProtocol::kSinglePhase == replState->protocol) {
return;
}
invariant(IndexBuildProtocol::kTwoPhase == replState->protocol,
str::stream() << "onCommitIndexBuild: " << buildUUID);
invariant(opCtx->lockState()->isWriteLocked(),
str::stream() << "onCommitIndexBuild: " << buildUUID);
auto opObserver = opCtx->getServiceContext()->getOpObserver();
const auto& collUUID = replState->collectionUUID;
const auto& indexSpecs = replState->indexSpecs;
auto fromMigrate = false;
// Since two phase index builds are allowed to survive replication state transitions, we should
// check if the node is currently a primary before attempting to write to the oplog.
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (!replCoord->canAcceptWritesFor(opCtx, nss)) {
invariant(!opCtx->recoveryUnit()->getCommitTimestamp().isNull(),
str::stream() << "commitIndexBuild: " << buildUUID);
return;
}
opObserver->onCommitIndexBuild(opCtx, nss, collUUID, buildUUID, indexSpecs, fromMigrate);
}
/**
* Replicates an abortIndexBuild oplog entry for two-phase builds, which signals downstream
* secondary nodes to abort the index build.
*/
void onAbortIndexBuild(OperationContext* opCtx,
const NamespaceString& nss,
ReplIndexBuildState& replState,
const Status& cause) {
if (IndexBuildProtocol::kTwoPhase != replState.protocol) {
return;
}
invariant(opCtx->lockState()->isWriteLocked(), replState.buildUUID.toString());
auto opObserver = opCtx->getServiceContext()->getOpObserver();
auto collUUID = replState.collectionUUID;
auto fromMigrate = false;
opObserver->onAbortIndexBuild(
opCtx, nss, collUUID, replState.buildUUID, replState.indexSpecs, cause, fromMigrate);
}
/**
* We do not need synchronization with step up and step down. Dropping the RSTL is important because
* otherwise if we held the RSTL it would create deadlocks with prepared transactions on step up and
* step down. A deadlock could result if the index build was attempting to acquire a Collection S
* or X lock while a prepared transaction held a Collection IX lock, and a step down was waiting to
* acquire the RSTL in mode X.
*/
void unlockRSTL(OperationContext* opCtx) {
invariant(opCtx->lockState()->unlockRSTLforPrepare());
invariant(!opCtx->lockState()->isRSTLLocked());
}
/**
* Logs the index build failure error in a standard format.
*/
void logFailure(Status status,
const NamespaceString& nss,
std::shared_ptr<ReplIndexBuildState> replState) {
LOGV2(20649,
"Index build failed",
"buildUUID"_attr = replState->buildUUID,
"collection"_attr = nss,
"collectionUUID"_attr = replState->collectionUUID,
"status"_attr = status);
}
/**
* Iterates over index builds with the provided function.
*/
void forEachIndexBuild(
const std::vector<std::shared_ptr<ReplIndexBuildState>>& indexBuilds,
StringData logPrefix,
std::function<void(std::shared_ptr<ReplIndexBuildState> replState)> onIndexBuild) {
if (indexBuilds.empty()) {
return;
}
LOGV2(20650,
"{logPrefix}active index builds: {indexBuilds_size}",
"logPrefix"_attr = logPrefix,
"indexBuilds_size"_attr = indexBuilds.size());
for (auto replState : indexBuilds) {
std::string indexNamesStr;
str::joinStringDelim(replState->indexNames, &indexNamesStr, ',');
LOGV2(20651,
"{logPrefix}{replState_buildUUID}: collection: {replState_collectionUUID}; indexes: "
"{replState_indexNames_size} [{indexNamesStr}]; method: "
"{IndexBuildProtocol_kTwoPhase_replState_protocol_two_phase_single_phase}",
"logPrefix"_attr = logPrefix,
"replState_buildUUID"_attr = replState->buildUUID,
"replState_collectionUUID"_attr = replState->collectionUUID,
"replState_indexNames_size"_attr = replState->indexNames.size(),
"indexNamesStr"_attr = indexNamesStr,
"IndexBuildProtocol_kTwoPhase_replState_protocol_two_phase_single_phase"_attr =
(IndexBuildProtocol::kTwoPhase == replState->protocol ? "two phase"
: "single phase"));
onIndexBuild(replState);
}
}
/**
* Updates currentOp for commitIndexBuild or abortIndexBuild.
*/
void updateCurOpForCommitOrAbort(OperationContext* opCtx, StringData fieldName, UUID buildUUID) {
BSONObjBuilder builder;
buildUUID.appendToBuilder(&builder, fieldName);
stdx::unique_lock<Client> lk(*opCtx->getClient());
auto curOp = CurOp::get(opCtx);
builder.appendElementsUnique(curOp->opDescription());
auto opDescObj = builder.obj();
curOp->setLogicalOp_inlock(LogicalOp::opCommand);
curOp->setOpDescription_inlock(opDescObj);
curOp->ensureStarted();
}
} // namespace
const auto getIndexBuildsCoord =
ServiceContext::declareDecoration<std::unique_ptr<IndexBuildsCoordinator>>();
void IndexBuildsCoordinator::set(ServiceContext* serviceContext,
std::unique_ptr<IndexBuildsCoordinator> ibc) {
auto& indexBuildsCoordinator = getIndexBuildsCoord(serviceContext);
invariant(!indexBuildsCoordinator);
indexBuildsCoordinator = std::move(ibc);
}
IndexBuildsCoordinator* IndexBuildsCoordinator::get(ServiceContext* serviceContext) {
auto& indexBuildsCoordinator = getIndexBuildsCoord(serviceContext);
invariant(indexBuildsCoordinator);
return indexBuildsCoordinator.get();
}
IndexBuildsCoordinator* IndexBuildsCoordinator::get(OperationContext* OperationContext) {
return get(OperationContext->getServiceContext());
}
IndexBuildsCoordinator::~IndexBuildsCoordinator() {
invariant(_allIndexBuilds.empty());
}
bool IndexBuildsCoordinator::supportsTwoPhaseIndexBuild() {
auto storageEngine = getGlobalServiceContext()->getStorageEngine();
return storageEngine->supportsTwoPhaseIndexBuild();
}
std::vector<std::string> IndexBuildsCoordinator::extractIndexNames(
const std::vector<BSONObj>& specs) {
std::vector<std::string> indexNames;
for (const auto& spec : specs) {
std::string name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
invariant(!name.empty(),
str::stream() << "Bad spec passed into ReplIndexBuildState constructor, missing '"
<< IndexDescriptor::kIndexNameFieldName << "' field: " << spec);
indexNames.push_back(name);
}
return indexNames;
}
StatusWith<std::pair<long long, long long>> IndexBuildsCoordinator::rebuildIndexesForRecovery(
OperationContext* opCtx,
const NamespaceString& nss,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
RepairData repair) {
const auto protocol = IndexBuildProtocol::kSinglePhase;
auto status = _startIndexBuildForRecovery(opCtx, nss, specs, buildUUID, protocol);
if (!status.isOK()) {
return status;
}
auto& collectionCatalog = CollectionCatalog::get(getGlobalServiceContext());
Collection* collection = collectionCatalog.lookupCollectionByNamespace(opCtx, nss);
// Complete the index build.
return _runIndexRebuildForRecovery(opCtx, collection, buildUUID, repair);
}
Status IndexBuildsCoordinator::_startIndexBuildForRecovery(OperationContext* opCtx,
const NamespaceString& nss,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
IndexBuildProtocol protocol) {
invariant(opCtx->lockState()->isCollectionLockedForMode(nss, MODE_X));
std::vector<std::string> indexNames;
for (auto& spec : specs) {
std::string name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
if (name.empty()) {
return Status(ErrorCodes::CannotCreateIndex,
str::stream()
<< "Cannot create an index for a spec '" << spec
<< "' without a non-empty string value for the 'name' field");
}
indexNames.push_back(name);
}
auto& collectionCatalog = CollectionCatalog::get(getGlobalServiceContext());
Collection* collection = collectionCatalog.lookupCollectionByNamespace(opCtx, nss);
auto indexCatalog = collection->getIndexCatalog();
{
// These steps are combined into a single WUOW to ensure there are no commits without
// the indexes.
// 1) Drop all unfinished indexes.
// 2) Start, but do not complete the index build process.
WriteUnitOfWork wuow(opCtx);
for (size_t i = 0; i < indexNames.size(); i++) {
bool includeUnfinished = false;
auto descriptor =
indexCatalog->findIndexByName(opCtx, indexNames[i], includeUnfinished);
if (descriptor) {
Status s = indexCatalog->dropIndex(opCtx, descriptor);
if (!s.isOK()) {
return s;
}
continue;
}
// If the index is not present in the catalog, then we are trying to drop an already
// aborted index. This may happen when rollback-via-refetch restarts an index build
// after an abort has been rolled back.
if (!DurableCatalog::get(opCtx)->isIndexPresent(
opCtx, collection->getCatalogId(), indexNames[i])) {
LOGV2(20652,
"The index for build {buildUUID} was not found while trying to drop the "
"index during recovery: {indexNames_i}",
"buildUUID"_attr = buildUUID,
"indexNames_i"_attr = indexNames[i]);
continue;
}
const auto durableBuildUUID = DurableCatalog::get(opCtx)->getIndexBuildUUID(
opCtx, collection->getCatalogId(), indexNames[i]);
// A build UUID is present if and only if we are rebuilding a two-phase build.
invariant((protocol == IndexBuildProtocol::kTwoPhase) ==
durableBuildUUID.is_initialized());
// When a buildUUID is present, it must match the build UUID parameter to this
// function.
invariant(!durableBuildUUID || *durableBuildUUID == buildUUID,
str::stream() << "durable build UUID: " << durableBuildUUID
<< "buildUUID: " << buildUUID);
// If the unfinished index is in the IndexCatalog, drop it through there, otherwise drop
// it from the DurableCatalog. Rollback-via-refetch does not clear any in-memory state,
// so we should do it manually here.
includeUnfinished = true;
descriptor = indexCatalog->findIndexByName(opCtx, indexNames[i], includeUnfinished);
if (descriptor) {
Status s = indexCatalog->dropUnfinishedIndex(opCtx, descriptor);
if (!s.isOK()) {
return s;
}
} else {
Status status = DurableCatalog::get(opCtx)->removeIndex(
opCtx, collection->getCatalogId(), indexNames[i]);
if (!status.isOK()) {
return status;
}
}
}
// We need to initialize the collection to rebuild the indexes. The collection may already
// be initialized when rebuilding indexes with rollback-via-refetch.
if (!collection->isInitialized()) {
collection->init(opCtx);
}
auto dbName = nss.db().toString();
auto replIndexBuildState = std::make_shared<ReplIndexBuildState>(
buildUUID, collection->uuid(), dbName, specs, protocol);
Status status = [&]() {
stdx::unique_lock<Latch> lk(_mutex);
return _registerIndexBuild(lk, replIndexBuildState);
}();
if (!status.isOK()) {
return status;
}
IndexBuildsManager::SetupOptions options;
options.protocol = protocol;
status = _indexBuildsManager.setUpIndexBuild(
opCtx, collection, specs, buildUUID, MultiIndexBlock::kNoopOnInitFn, options);
if (!status.isOK()) {
// An index build failure during recovery is fatal.
logFailure(status, nss, replIndexBuildState);
fassertNoTrace(51086, status);
}
wuow.commit();
}
return Status::OK();
}
std::string IndexBuildsCoordinator::_indexBuildActionToString(IndexBuildAction action) {
if (action == IndexBuildAction::kNoAction) {
return "No action";
} else if (action == IndexBuildAction::kOplogCommit) {
return "Oplog commit";
} else if (action == IndexBuildAction::kOplogAbort) {
return "Oplog abort";
} else if (action == IndexBuildAction::kInitialSyncAbort) {
return "Initial sync abort";
} else if (action == IndexBuildAction::kRollbackAbort) {
return "Rollback abort";
} else if (action == IndexBuildAction::kPrimaryAbort) {
return "Primary abort";
} else if (action == IndexBuildAction::kSinglePhaseCommit) {
return "Single-phase commit";
} else if (action == IndexBuildAction::kCommitQuorumSatisfied) {
return "Commit quorum Satisfied";
}
MONGO_UNREACHABLE;
}
void IndexBuildsCoordinator::waitForAllIndexBuildsToStopForShutdown(OperationContext* opCtx) {
stdx::unique_lock<Latch> lk(_mutex);
// All index builds should have been signaled to stop via the ServiceContext.
if (_allIndexBuilds.empty()) {
return;
}
LOGV2(4725201,
"Waiting until the following index builds are finished:",
"numIndexBuilds"_attr = _allIndexBuilds.size());
for (const auto& indexBuild : _allIndexBuilds) {
LOGV2(4725202, " Index build with UUID", "indexBuild_first"_attr = indexBuild.first);
}
// Wait for all the index builds to stop.
auto pred = [this]() { return _allIndexBuilds.empty(); };
_indexBuildsCondVar.wait(lk, pred);
}
std::vector<UUID> IndexBuildsCoordinator::abortCollectionIndexBuilds(
OperationContext* opCtx,
const NamespaceString collectionNss,
const UUID collectionUUID,
const std::string& reason) {
LOGV2(23879,
"About to abort all index builders on collection",
"collection"_attr = collectionNss,
"collectionUUID"_attr = collectionUUID,
"reason"_attr = reason);
auto collIndexBuilds = [&]() -> std::vector<std::shared_ptr<ReplIndexBuildState>> {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [=](const auto& replState) {
return collectionUUID == replState.collectionUUID;
};
return _filterIndexBuilds_inlock(lk, indexBuildFilter);
}();
std::vector<UUID> buildUUIDs;
for (auto replState : collIndexBuilds) {
if (abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kPrimaryAbort, reason)) {
buildUUIDs.push_back(replState->buildUUID);
}
}
return buildUUIDs;
}
void IndexBuildsCoordinator::_awaitNoBgOpInProgForDb(stdx::unique_lock<Latch>& lk,
OperationContext* opCtx,
StringData db) {
auto indexBuildFilter = [db](const auto& replState) { return db == replState.dbName; };
auto pred = [&, this]() {
auto dbIndexBuilds = _filterIndexBuilds_inlock(lk, indexBuildFilter);
return dbIndexBuilds.empty();
};
_indexBuildsCondVar.wait(lk, pred);
}
void IndexBuildsCoordinator::abortDatabaseIndexBuilds(OperationContext* opCtx,
StringData db,
const std::string& reason) {
LOGV2(4612302,
"About to abort all index builders running for collections in the given database",
"database"_attr = db,
"reason"_attr = reason);
auto builds = [&]() -> std::vector<std::shared_ptr<ReplIndexBuildState>> {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [=](const auto& replState) { return db == replState.dbName; };
return _filterIndexBuilds_inlock(lk, indexBuildFilter);
}();
for (auto replState : builds) {
abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kPrimaryAbort, reason);
}
}
namespace {
NamespaceString getNsFromUUID(OperationContext* opCtx, const UUID& uuid) {
auto& catalog = CollectionCatalog::get(opCtx);
auto nss = catalog.lookupNSSByUUID(opCtx, uuid);
uassert(ErrorCodes::NamespaceNotFound, "No namespace with UUID " + uuid.toString(), nss);
return *nss;
}
} // namespace
void IndexBuildsCoordinator::applyStartIndexBuild(OperationContext* opCtx,
ApplicationMode applicationMode,
const IndexBuildOplogEntry& oplogEntry) {
const auto collUUID = oplogEntry.collUUID;
const auto nss = getNsFromUUID(opCtx, collUUID);
IndexBuildsCoordinator::IndexBuildOptions indexBuildOptions;
indexBuildOptions.replSetAndNotPrimaryAtStart = true;
indexBuildOptions.applicationMode = applicationMode;
// If this is an initial syncing node, drop any conflicting ready index specs prior to
// proceeding with building them.
if (indexBuildOptions.applicationMode == ApplicationMode::kInitialSync) {
auto dbAndUUID = NamespaceStringOrUUID(nss.db().toString(), collUUID);
writeConflictRetry(opCtx, "IndexBuildsCoordinator::applyStartIndexBuild", nss.ns(), [&] {
WriteUnitOfWork wuow(opCtx);
AutoGetCollection autoColl(opCtx, dbAndUUID, MODE_X);
auto coll = autoColl.getCollection();
invariant(coll,
str::stream() << "Collection with UUID " << collUUID << " was dropped.");
IndexCatalog* indexCatalog = coll->getIndexCatalog();
const bool includeUnfinished = false;
for (const auto& spec : oplogEntry.indexSpecs) {
std::string name = spec.getStringField(IndexDescriptor::kIndexNameFieldName);
uassert(ErrorCodes::BadValue,
str::stream() << "Index spec is missing the 'name' field " << spec,
!name.empty());
if (auto desc = indexCatalog->findIndexByName(opCtx, name, includeUnfinished)) {
uassertStatusOK(indexCatalog->dropIndex(opCtx, desc));
}
}
wuow.commit();
});
}
auto indexBuildsCoord = IndexBuildsCoordinator::get(opCtx);
uassertStatusOK(
indexBuildsCoord
->startIndexBuild(opCtx,
nss.db().toString(),
collUUID,
oplogEntry.indexSpecs,
oplogEntry.buildUUID,
/* This oplog entry is only replicated for two-phase index builds */
IndexBuildProtocol::kTwoPhase,
indexBuildOptions)
.getStatus());
}
void IndexBuildsCoordinator::applyCommitIndexBuild(OperationContext* opCtx,
const IndexBuildOplogEntry& oplogEntry) {
const auto collUUID = oplogEntry.collUUID;
const auto nss = getNsFromUUID(opCtx, collUUID);
const auto& buildUUID = oplogEntry.buildUUID;
updateCurOpForCommitOrAbort(opCtx, kCommitIndexBuildFieldName, buildUUID);
uassert(31417,
str::stream()
<< "No commit timestamp set while applying commitIndexBuild operation. Build UUID: "
<< buildUUID,
!opCtx->recoveryUnit()->getCommitTimestamp().isNull());
// There is a possibility that we cannot find an active index build with the given build UUID.
// This can be the case when the index already exists or was dropped on the sync source before
// the collection was cloned during initial sync. The oplog code will ignore the NoSuchKey
// error code.
//
// Case 1: Index already exists:
// +-----------------------------------------+--------------------------------+
// | Sync Target | Sync Source |
// +-----------------------------------------+--------------------------------+
// | | startIndexBuild 'x' at TS: 1. |
// | Start oplog fetcher at TS: 2. | |
// | | commitIndexBuild 'x' at TS: 2. |
// | Begin cloning the collection. | |
// | Index 'x' is listed as ready, build it. | |
// | Finish cloning the collection. | |
// | Start the oplog replay phase. | |
// | Apply commitIndexBuild 'x'. | |
// | --- Index build not found --- | |
// +-----------------------------------------+--------------------------------+
//
// Case 2: Sync source dropped the index:
// +--------------------------------+--------------------------------+
// | Sync Target | Sync Source |
// +--------------------------------+--------------------------------+
// | | startIndexBuild 'x' at TS: 1. |
// | Start oplog fetcher at TS: 2. | |
// | | commitIndexBuild 'x' at TS: 2. |
// | | dropIndex 'x' at TS: 3. |
// | Begin cloning the collection. | |
// | No user indexes to build. | |
// | Finish cloning the collection. | |
// | Start the oplog replay phase. | |
// | Apply commitIndexBuild 'x'. | |
// | --- Index build not found --- | |
// +--------------------------------+--------------------------------+
auto replState = uassertStatusOK(_getIndexBuild(buildUUID));
// Retry until we are able to put the index build in the kPrepareCommit state. None of the
// conditions for retrying are common or expected to be long-lived, so we believe this to be
// safe to poll at this frequency.
while (!_tryCommit(opCtx, replState)) {
opCtx->sleepFor(Milliseconds(100));
}
auto fut = replState->sharedPromise.getFuture();
LOGV2(20654,
"Index build joined after commit",
"buildUUID"_attr = buildUUID,
"result"_attr = fut.waitNoThrow(opCtx));
// Throws if there was an error building the index.
fut.get();
}
bool IndexBuildsCoordinator::_tryCommit(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState) {
stdx::unique_lock<Latch> lk(replState->mutex);
if (replState->indexBuildState.isSettingUp()) {
// It's possible that the index build thread has not reached the point where it can be
// committed yet.
return false;
}
if (replState->waitForNextAction->getFuture().isReady()) {
// If the future wait were uninterruptible, then shutdown could hang. If the
// IndexBuildsCoordinator thread gets interrupted on shutdown, the oplog applier will hang
// waiting for the promise applying the commitIndexBuild oplog entry.
const auto nextAction = replState->waitForNextAction->getFuture().get(opCtx);
invariant(nextAction == IndexBuildAction::kCommitQuorumSatisfied);
// Retry until the current promise result is consumed by the index builder thread and
// a new empty promise got created by the indexBuildscoordinator thread.
return false;
}
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
replState->indexBuildState.setState(
IndexBuildState::kPrepareCommit, skipCheck, opCtx->recoveryUnit()->getCommitTimestamp());
// Promise can be set only once.
// We can't skip signaling here if a signal is already set because the previous commit or
// abort signal might have been sent to handle for primary case.
setSignalAndCancelVoteRequestCbkIfActive(lk, opCtx, replState, IndexBuildAction::kOplogCommit);
return true;
}
void IndexBuildsCoordinator::applyAbortIndexBuild(OperationContext* opCtx,
const IndexBuildOplogEntry& oplogEntry) {
const auto collUUID = oplogEntry.collUUID;
const auto nss = getNsFromUUID(opCtx, collUUID);
const auto& buildUUID = oplogEntry.buildUUID;
updateCurOpForCommitOrAbort(opCtx, kCommitIndexBuildFieldName, buildUUID);
invariant(oplogEntry.cause);
uassert(31420,
str::stream()
<< "No commit timestamp set while applying abortIndexBuild operation. Build UUID: "
<< buildUUID,
!opCtx->recoveryUnit()->getCommitTimestamp().isNull());
std::string abortReason(str::stream()
<< "abortIndexBuild oplog entry encountered: " << *oplogEntry.cause);
auto indexBuildsCoord = IndexBuildsCoordinator::get(opCtx);
indexBuildsCoord->abortIndexBuildByBuildUUID(
opCtx, buildUUID, IndexBuildAction::kOplogAbort, abortReason);
}
boost::optional<UUID> IndexBuildsCoordinator::abortIndexBuildByIndexNames(
OperationContext* opCtx,
const UUID& collectionUUID,
const std::vector<std::string>& indexNames,
std::string reason) {
boost::optional<UUID> buildUUID;
auto indexBuilds = _getIndexBuilds();
auto onIndexBuild = [&](std::shared_ptr<ReplIndexBuildState> replState) {
if (replState->collectionUUID != collectionUUID) {
return;
}
bool matchedBuilder = std::is_permutation(indexNames.begin(),
indexNames.end(),
replState->indexNames.begin(),
replState->indexNames.end());
if (!matchedBuilder) {
return;
}
LOGV2(23880,
"About to abort index builder: {replState_buildUUID} on collection: "
"{collectionUUID}. First index: {replState_indexNames_front}",
"replState_buildUUID"_attr = replState->buildUUID,
"collectionUUID"_attr = collectionUUID,
"replState_indexNames_front"_attr = replState->indexNames.front());
if (abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kPrimaryAbort, reason)) {
buildUUID = replState->buildUUID;
}
};
forEachIndexBuild(
indexBuilds, "IndexBuildsCoordinator::abortIndexBuildByIndexNames - "_sd, onIndexBuild);
return buildUUID;
}
bool IndexBuildsCoordinator::hasIndexBuilder(OperationContext* opCtx,
const UUID& collectionUUID,
const std::vector<std::string>& indexNames) const {
bool foundIndexBuilder = false;
boost::optional<UUID> buildUUID;
auto indexBuilds = _getIndexBuilds();
auto onIndexBuild = [&](std::shared_ptr<ReplIndexBuildState> replState) {
if (replState->collectionUUID != collectionUUID) {
return;
}
bool matchedBuilder = std::is_permutation(indexNames.begin(),
indexNames.end(),
replState->indexNames.begin(),
replState->indexNames.end());
if (!matchedBuilder) {
return;
}
foundIndexBuilder = true;
};
forEachIndexBuild(indexBuilds, "IndexBuildsCoordinator::hasIndexBuilder - "_sd, onIndexBuild);
return foundIndexBuilder;
}
IndexBuildsCoordinator::TryAbortResult IndexBuildsCoordinator::_tryAbort(
OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
IndexBuildAction signalAction,
std::string reason) {
{
stdx::unique_lock<Latch> lk(replState->mutex);
// Wait until the build is done setting up. This indicates that all required state is
// initialized to attempt an abort.
if (replState->indexBuildState.isSettingUp()) {
LOGV2_DEBUG(465605,
2,
"waiting until index build is done setting up before attempting to abort",
"buildUUID"_attr = replState->buildUUID);
return TryAbortResult::kRetry;
}
if (replState->waitForNextAction->getFuture().isReady()) {
const auto nextAction = replState->waitForNextAction->getFuture().get(opCtx);
invariant(nextAction == IndexBuildAction::kSinglePhaseCommit ||
nextAction == IndexBuildAction::kCommitQuorumSatisfied ||
nextAction == IndexBuildAction::kPrimaryAbort);
// Index build coordinator already received a signal to commit or abort. So, it's ok
// to return and wait for the index build to complete if we are trying to signal
// 'kPrimaryAbort'. The index build coordinator will not perform the signaled action
// (i.e, will not commit or abort the index build) only when the node steps down.
// When the node steps down, the caller of this function, dropIndexes/createIndexes
// command (user operation) will also get interrupted. So, we no longer need to
// abort the index build on step down.
if (signalAction == IndexBuildAction::kPrimaryAbort) {
// Indicate if the index build is already being committed or aborted.
if (nextAction == IndexBuildAction::kPrimaryAbort) {
return TryAbortResult::kAlreadyAborted;
} else {
return TryAbortResult::kNotAborted;
}
}
// Retry until the current promise result is consumed by the index builder thread
// and a new empty promise got created by the indexBuildscoordinator thread. Or,
// until the index build got torn down after index build commit.
return TryAbortResult::kRetry;
}
LOGV2(4656003,
"Aborting index build",
"buildUUID"_attr = replState->buildUUID,
"reason"_attr = reason);
// Set the state on replState. Once set, the calling thread must complete the abort process.
auto abortTimestamp =
boost::make_optional<Timestamp>(!opCtx->recoveryUnit()->getCommitTimestamp().isNull(),
opCtx->recoveryUnit()->getCommitTimestamp());
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
replState->indexBuildState.setState(
IndexBuildState::kAborted, skipCheck, abortTimestamp, reason);
// Interrupt the builder thread so that it can no longer acquire locks or make progress.
auto serviceContext = opCtx->getServiceContext();
auto target = serviceContext->getLockedClient(replState->opId);
if (!target) {
LOGV2_FATAL(4656001,
"Index builder thread did not appear to be running while aborting",
"buildUUID"_attr = replState->buildUUID,
"opId"_attr = replState->opId);
}
serviceContext->killOperation(
target, target->getOperationContext(), ErrorCodes::IndexBuildAborted);
// Set the signal. Because we have already interrupted the index build, it will not observe
// this signal. We do this so that other observers do not also try to abort the index build.
setSignalAndCancelVoteRequestCbkIfActive(lk, opCtx, replState, signalAction);
}
return TryAbortResult::kContinueAbort;
}
bool IndexBuildsCoordinator::abortIndexBuildByBuildUUID(OperationContext* opCtx,
const UUID& buildUUID,
IndexBuildAction signalAction,
std::string reason) {
std::shared_ptr<ReplIndexBuildState> replState;
bool retry = false;
while (true) {
// Retry until we are able to put the index build into the kAborted state. None of the
// conditions for retrying are common or expected to be long-lived, so we believe this to be
// safe to poll at this frequency.
if (retry) {
opCtx->sleepFor(Milliseconds(1000));
retry = false;
}
// It is possible to receive an abort for a non-existent index build. Abort should always
// succeed, so suppress the error.
auto replStateResult = _getIndexBuild(buildUUID);
if (!replStateResult.isOK()) {
LOGV2(20656,
"ignoring error while aborting index build {buildUUID}: "
"{replStateResult_getStatus}",
"buildUUID"_attr = buildUUID,
"replStateResult_getStatus"_attr = replStateResult.getStatus());
return false;
}
replState = replStateResult.getValue();
LOGV2(4656010, "attempting to abort index build", "buildUUID"_attr = replState->buildUUID);
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
Lock::DBLock dbLock(opCtx, replState->dbName, MODE_IX);
if (IndexBuildProtocol::kSinglePhase == replState->protocol) {
// Unlock RSTL to avoid deadlocks with prepare conflicts and state transitions caused by
// taking a strong collection lock. See SERVER-42621.
unlockRSTL(opCtx);
}
Lock::CollectionLock collLock(opCtx, dbAndUUID, MODE_X);
// If we are using two-phase index builds and are no longer primary after receiving an
// abort, we cannot replicate an abortIndexBuild oplog entry. Continue holding the RSTL to
// check the replication state and to prevent any state transitions from happening while
// aborting the index build. Once an index build is put into kAborted, the index builder
// thread will be torn down, and an oplog entry must be replicated. Single-phase builds do
// not have this restriction and may be aborted after a stepDown. Initial syncing nodes need
// to be able to abort two phase index builds during the oplog replay phase.
if (IndexBuildProtocol::kTwoPhase == replState->protocol) {
// The DBLock helper takes the RSTL implicitly.
invariant(opCtx->lockState()->isRSTLLocked());
// Override the 'signalAction' as this is an initial syncing node.
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (replCoord->getMemberState().startup2()) {
LOGV2_DEBUG(4665902,
1,
"Overriding abort 'signalAction' for initial sync",
"from"_attr = signalAction,
"to"_attr = IndexBuildAction::kInitialSyncAbort);
signalAction = IndexBuildAction::kInitialSyncAbort;
}
if (IndexBuildAction::kPrimaryAbort == signalAction &&
!replCoord->canAcceptWritesFor(opCtx, dbAndUUID)) {
uassertStatusOK({ErrorCodes::NotMaster,
str::stream()
<< "Unable to abort index build because we are not primary: "
<< buildUUID});
}
}
auto tryAbortResult = _tryAbort(opCtx, replState, signalAction, reason);
switch (tryAbortResult) {
case TryAbortResult::kNotAborted:
return false;
case TryAbortResult::kAlreadyAborted:
return true;
case TryAbortResult::kRetry:
case TryAbortResult::kContinueAbort:
break;
}
if (TryAbortResult::kRetry == tryAbortResult) {
retry = true;
continue;
}
invariant(TryAbortResult::kContinueAbort == tryAbortResult);
// At this point we must continue aborting the index build.
try {
_completeAbort(opCtx, replState, signalAction, {ErrorCodes::IndexBuildAborted, reason});
} catch (const DBException& e) {
LOGV2_FATAL(
4656011,
"Failed to abort index build after partially tearing-down index build state",
"buildUUID"_attr = replState->buildUUID,
"reason"_attr = e.toString());
}
// Wait for the builder thread to receive the signal before unregistering. Don't release the
// Collection lock until this happens, guaranteeing the thread has stopped making progress
// and has exited.
auto fut = replState->sharedPromise.getFuture();
LOGV2(20655,
"Index build thread exited",
"buildUUID"_attr = buildUUID,
"status"_attr = fut.waitNoThrow());
{
// Unregister last once we guarantee all other state has been cleaned up.
stdx::unique_lock<Latch> lk(_mutex);
_unregisterIndexBuild(lk, replState);
}
break;
}
return true;
}
void IndexBuildsCoordinator::_completeAbort(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
IndexBuildAction signalAction,
Status reason) {
auto coll =
CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, replState->collectionUUID);
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
auto nss = coll->ns();
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
switch (signalAction) {
// Replicates an abortIndexBuild oplog entry and deletes the index from the durable catalog.
case IndexBuildAction::kPrimaryAbort: {
// Single-phase builds are aborted on step-down, so it's possible to no longer be
// primary after we process an abort. We must continue with the abort, but since
// single-phase builds do not replicate abort oplog entries, this write will use a ghost
// timestamp.
bool isPrimaryOrSinglePhase = replState->protocol == IndexBuildProtocol::kSinglePhase ||
replCoord->canAcceptWritesFor(opCtx, nss);
invariant(isPrimaryOrSinglePhase,
str::stream() << "singlePhase: "
<< (IndexBuildProtocol::kSinglePhase == replState->protocol));
auto onCleanUpFn = [&] { onAbortIndexBuild(opCtx, coll->ns(), *replState, reason); };
_indexBuildsManager.abortIndexBuild(opCtx, coll, replState->buildUUID, onCleanUpFn);
removeIndexBuildEntryAfterCommitOrAbort(opCtx, dbAndUUID, *replState);
break;
}
// Deletes the index from the durable catalog.
case IndexBuildAction::kInitialSyncAbort: {
invariant(replState->protocol == IndexBuildProtocol::kTwoPhase);
invariant(replCoord->getMemberState().startup2());
bool isMaster = replCoord->canAcceptWritesFor(opCtx, nss);
invariant(!isMaster, str::stream() << "Index build: " << replState->buildUUID);
invariant(replState->indexBuildState.isAborted(),
str::stream()
<< "Index build: " << replState->buildUUID
<< ", index build state: " << replState->indexBuildState.toString());
invariant(replState->indexBuildState.getAbortReason(), replState->buildUUID.toString());
LOGV2(4665903,
"Aborting index build during initial sync",
"buildUUID"_attr = replState->buildUUID,
"abortReason"_attr = replState->indexBuildState.getAbortReason().get(),
"collectionUUID"_attr = replState->collectionUUID);
_indexBuildsManager.abortIndexBuild(
opCtx, coll, replState->buildUUID, MultiIndexBlock::kNoopOnCleanUpFn);
break;
}
// Deletes the index from the durable catalog.
case IndexBuildAction::kOplogAbort: {
invariant(IndexBuildProtocol::kTwoPhase == replState->protocol);
// This signal can be received during primary (drain phase), secondary,
// startup (startup recovery) and startup2 (initial sync).
bool isMaster = replCoord->canAcceptWritesFor(opCtx, nss);
invariant(!isMaster, str::stream() << "Index build: " << replState->buildUUID);
invariant(replState->indexBuildState.isAborted(),
str::stream()
<< "Index build: " << replState->buildUUID
<< ", index build state: " << replState->indexBuildState.toString());
invariant(replState->indexBuildState.getTimestamp() &&
replState->indexBuildState.getAbortReason(),
replState->buildUUID.toString());
LOGV2(3856206,
"Aborting index build from oplog entry",
"buildUUID"_attr = replState->buildUUID,
"abortTimestamp"_attr = replState->indexBuildState.getTimestamp().get(),
"abortReason"_attr = replState->indexBuildState.getAbortReason().get(),
"collectionUUID"_attr = replState->collectionUUID);
_indexBuildsManager.abortIndexBuild(
opCtx, coll, replState->buildUUID, MultiIndexBlock::kNoopOnCleanUpFn);
break;
}
// No locks are required when aborting due to rollback. This performs no storage engine
// writes, only cleans up the remaining in-memory state.
case IndexBuildAction::kRollbackAbort: {
invariant(replState->protocol == IndexBuildProtocol::kTwoPhase);
invariant(replCoord->getMemberState().rollback());
_indexBuildsManager.abortIndexBuildWithoutCleanup(
opCtx, coll, replState->buildUUID, reason.reason());
break;
}
case IndexBuildAction::kNoAction:
case IndexBuildAction::kCommitQuorumSatisfied:
case IndexBuildAction::kOplogCommit:
case IndexBuildAction::kSinglePhaseCommit:
MONGO_UNREACHABLE;
}
LOGV2(465611, "Cleaned up index build after abort. ", "buildUUID"_attr = replState->buildUUID);
}
void IndexBuildsCoordinator::_completeSelfAbort(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
Status reason) {
_completeAbort(opCtx, replState, IndexBuildAction::kPrimaryAbort, reason);
{
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
stdx::unique_lock<Latch> lk(replState->mutex);
replState->indexBuildState.setState(IndexBuildState::kAborted, skipCheck);
}
{
stdx::unique_lock<Latch> lk(_mutex);
_unregisterIndexBuild(lk, replState);
}
}
void IndexBuildsCoordinator::_completeAbortForShutdown(
OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
Collection* collection) {
// Leave it as-if kill -9 happened. Startup recovery will restart the index build.
_indexBuildsManager.abortIndexBuildWithoutCleanup(
opCtx, collection, replState->buildUUID, "shutting down");
{
// Promise should be set at least once before it's getting destroyed.
stdx::unique_lock<Latch> lk(replState->mutex);
if (!replState->waitForNextAction->getFuture().isReady()) {
replState->waitForNextAction->emplaceValue(IndexBuildAction::kNoAction);
}
auto skipCheck = shouldSkipIndexBuildStateTransitionCheck(opCtx, replState->protocol);
replState->indexBuildState.setState(IndexBuildState::kAborted, skipCheck);
}
{
// This allows the builder thread to exit.
stdx::unique_lock<Latch> lk(_mutex);
_unregisterIndexBuild(lk, replState);
}
}
std::size_t IndexBuildsCoordinator::getActiveIndexBuildCount(OperationContext* opCtx) {
auto indexBuilds = _getIndexBuilds();
// We use forEachIndexBuild() to log basic details on the current index builds and don't intend
// to modify any of the index builds, hence the no-op.
auto onIndexBuild = [](std::shared_ptr<ReplIndexBuildState> replState) {};
forEachIndexBuild(indexBuilds, "index build still running: "_sd, onIndexBuild);
return indexBuilds.size();
}
void IndexBuildsCoordinator::onStepUp(OperationContext* opCtx) {
LOGV2(20657, "IndexBuildsCoordinator::onStepUp - this node is stepping up to primary");
// This would create an empty table even for FCV 4.2 to handle case where a primary node started
// with FCV 4.2, and then upgraded FCV 4.4.
indexbuildentryhelpers::ensureIndexBuildEntriesNamespaceExists(opCtx);
auto indexBuilds = _getIndexBuilds();
auto onIndexBuild = [this, opCtx](std::shared_ptr<ReplIndexBuildState> replState) {
if (IndexBuildProtocol::kTwoPhase != replState->protocol) {
return;
}
if (!_signalIfCommitQuorumNotEnabled(opCtx, replState)) {
// This reads from system.indexBuilds collection to see if commit quorum got satisfied.
try {
_signalIfCommitQuorumIsSatisfied(opCtx, replState);
} catch (DBException& ex) {
fassert(31440, ex.toStatus());
}
}
};
forEachIndexBuild(indexBuilds, "IndexBuildsCoordinator::onStepUp - "_sd, onIndexBuild);
}
IndexBuilds IndexBuildsCoordinator::stopIndexBuildsForRollback(OperationContext* opCtx) {
LOGV2(20658, "stopping index builds before rollback");
IndexBuilds buildsStopped;
auto indexBuilds = _getIndexBuilds();
auto onIndexBuild = [&](std::shared_ptr<ReplIndexBuildState> replState) {
if (IndexBuildProtocol::kSinglePhase == replState->protocol) {
LOGV2(20659,
"not stopping single phase index build",
"buildUUID"_attr = replState->buildUUID);
return;
}
const std::string reason = "rollback";
IndexBuildDetails aborted{replState->collectionUUID};
// Record the index builds aborted due to rollback. This allows any rollback algorithm
// to efficiently restart all unfinished index builds without having to scan all indexes
// in all collections.
for (auto spec : replState->indexSpecs) {
aborted.indexSpecs.emplace_back(spec.getOwned());
}
buildsStopped.insert({replState->buildUUID, aborted});
// This will unblock the index build and allow it to complete without cleaning up.
// Subsequently, the rollback algorithm can decide how to undo the index build depending on
// the state of the oplog. Signals the kRollbackAbort and then waits for the thread to join.
abortIndexBuildByBuildUUID(
opCtx, replState->buildUUID, IndexBuildAction::kRollbackAbort, reason);
};
forEachIndexBuild(
indexBuilds, "IndexBuildsCoordinator::stopIndexBuildsForRollback - "_sd, onIndexBuild);
return buildsStopped;
}
void IndexBuildsCoordinator::restartIndexBuildsForRecovery(OperationContext* opCtx,
const IndexBuilds& buildsToRestart) {
for (auto& [buildUUID, build] : buildsToRestart) {
boost::optional<NamespaceString> nss =
CollectionCatalog::get(opCtx).lookupNSSByUUID(opCtx, build.collUUID);
invariant(nss);
LOGV2(20660,
"Restarting index build",
"collection"_attr = nss,
"collectionUUID"_attr = build.collUUID,
"buildUUID"_attr = buildUUID);
IndexBuildsCoordinator::IndexBuildOptions indexBuildOptions;
// Start the index build as if in secondary oplog application.
indexBuildOptions.replSetAndNotPrimaryAtStart = true;
// Indicate that the initialization should not generate oplog entries or timestamps for the
// first catalog write, and that the original durable catalog entries should be dropped and
// replaced.
indexBuildOptions.applicationMode = ApplicationMode::kStartupRepair;
// This spawns a new thread and returns immediately. These index builds will start and wait
// for a commit or abort to be replicated.
MONGO_COMPILER_VARIABLE_UNUSED auto fut =
uassertStatusOK(startIndexBuild(opCtx,
nss->db().toString(),
build.collUUID,
build.indexSpecs,
buildUUID,
IndexBuildProtocol::kTwoPhase,
indexBuildOptions));
}
}
int IndexBuildsCoordinator::numInProgForDb(StringData db) const {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [db](const auto& replState) { return db == replState.dbName; };
auto dbIndexBuilds = _filterIndexBuilds_inlock(lk, indexBuildFilter);
return int(dbIndexBuilds.size());
}
bool IndexBuildsCoordinator::inProgForCollection(const UUID& collectionUUID,
IndexBuildProtocol protocol) const {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuildFilter = [=](const auto& replState) {
return collectionUUID == replState.collectionUUID && protocol == replState.protocol;
};
auto indexBuilds = _filterIndexBuilds_inlock(lk, indexBuildFilter);
return !indexBuilds.empty();
}
bool IndexBuildsCoordinator::inProgForCollection(const UUID& collectionUUID) const {
stdx::unique_lock<Latch> lk(_mutex);
auto indexBuilds = _filterIndexBuilds_inlock(
lk, [=](const auto& replState) { return collectionUUID == replState.collectionUUID; });
return !indexBuilds.empty();
}
bool IndexBuildsCoordinator::inProgForDb(StringData db) const {
return numInProgForDb(db) > 0;
}
void IndexBuildsCoordinator::assertNoIndexBuildInProgress() const {
stdx::unique_lock<Latch> lk(_mutex);
uassert(ErrorCodes::BackgroundOperationInProgressForDatabase,
str::stream() << "cannot perform operation: there are currently "
<< _allIndexBuilds.size() << " index builds running.",
_allIndexBuilds.size() == 0);
}
void IndexBuildsCoordinator::assertNoIndexBuildInProgForCollection(
const UUID& collectionUUID) const {
uassert(ErrorCodes::BackgroundOperationInProgressForNamespace,
str::stream() << "cannot perform operation: an index build is currently running for "
"collection with UUID: "
<< collectionUUID,
!inProgForCollection(collectionUUID));
}
void IndexBuildsCoordinator::assertNoBgOpInProgForDb(StringData db) const {
uassert(ErrorCodes::BackgroundOperationInProgressForDatabase,
str::stream() << "cannot perform operation: an index build is currently running for "
"database "
<< db,
!inProgForDb(db));
}
void IndexBuildsCoordinator::awaitIndexBuildFinished(OperationContext* opCtx,
const UUID& buildUUID) {
stdx::unique_lock<Latch> lk(_mutex);
auto pred = [&, this]() { return _allIndexBuilds.end() == _allIndexBuilds.find(buildUUID); };
_indexBuildsCondVar.wait(lk, pred);
}
void IndexBuildsCoordinator::awaitNoIndexBuildInProgressForCollection(OperationContext* opCtx,
const UUID& collectionUUID,
IndexBuildProtocol protocol) {
stdx::unique_lock<Latch> lk(_mutex);
auto noIndexBuildsPred = [&, this]() {
auto indexBuilds = _filterIndexBuilds_inlock(lk, [&](const auto& replState) {
return collectionUUID == replState.collectionUUID && protocol == replState.protocol;
});
return indexBuilds.empty();
};
opCtx->waitForConditionOrInterrupt(_indexBuildsCondVar, lk, noIndexBuildsPred);
}
void IndexBuildsCoordinator::awaitNoIndexBuildInProgressForCollection(OperationContext* opCtx,
const UUID& collectionUUID) {
stdx::unique_lock<Latch> lk(_mutex);
auto pred = [&, this]() {
auto indexBuilds = _filterIndexBuilds_inlock(
lk, [&](const auto& replState) { return collectionUUID == replState.collectionUUID; });
return indexBuilds.empty();
};
_indexBuildsCondVar.wait(lk, pred);
}
void IndexBuildsCoordinator::awaitNoBgOpInProgForDb(OperationContext* opCtx, StringData db) {
stdx::unique_lock<Latch> lk(_mutex);
_awaitNoBgOpInProgForDb(lk, opCtx, db);
}
void IndexBuildsCoordinator::onReplicaSetReconfig() {
// TODO: not yet implemented.
}
void IndexBuildsCoordinator::createIndexes(OperationContext* opCtx,
UUID collectionUUID,
const std::vector<BSONObj>& specs,
IndexBuildsManager::IndexConstraints indexConstraints,
bool fromMigrate) {
auto collection = CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, collectionUUID);
invariant(collection,
str::stream() << "IndexBuildsCoordinator::createIndexes: " << collectionUUID);
auto nss = collection->ns();
invariant(opCtx->lockState()->isCollectionLockedForMode(nss, MODE_X),
str::stream() << "IndexBuildsCoordinator::createIndexes: " << collectionUUID);
auto buildUUID = UUID::gen();
// Rest of this function can throw, so ensure the build cleanup occurs.
ON_BLOCK_EXIT([&] { _indexBuildsManager.unregisterIndexBuild(buildUUID); });
auto onInitFn = MultiIndexBlock::makeTimestampedIndexOnInitFn(opCtx, collection);
IndexBuildsManager::SetupOptions options;
options.indexConstraints = indexConstraints;
uassertStatusOK(_indexBuildsManager.setUpIndexBuild(
opCtx, collection, specs, buildUUID, onInitFn, options));
auto abortOnExit = makeGuard([&] {
_indexBuildsManager.abortIndexBuild(
opCtx, collection, buildUUID, MultiIndexBlock::kNoopOnCleanUpFn);
});
uassertStatusOK(_indexBuildsManager.startBuildingIndex(opCtx, collection, buildUUID));
uassertStatusOK(_indexBuildsManager.retrySkippedRecords(opCtx, buildUUID, collection));
uassertStatusOK(_indexBuildsManager.checkIndexConstraintViolations(opCtx, buildUUID));
auto opObserver = opCtx->getServiceContext()->getOpObserver();
auto onCreateEachFn = [&](const BSONObj& spec) {
opObserver->onCreateIndex(opCtx, collection->ns(), collectionUUID, spec, fromMigrate);
};
auto onCommitFn = MultiIndexBlock::kNoopOnCommitFn;
uassertStatusOK(_indexBuildsManager.commitIndexBuild(
opCtx, collection, nss, buildUUID, onCreateEachFn, onCommitFn));
abortOnExit.dismiss();
}
void IndexBuildsCoordinator::createIndexesOnEmptyCollection(OperationContext* opCtx,
UUID collectionUUID,
const std::vector<BSONObj>& specs,
bool fromMigrate) {
auto collection = CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, collectionUUID);
invariant(collection, str::stream() << collectionUUID);
invariant(collection->isEmpty(opCtx), str::stream() << collectionUUID);
invariant(!specs.empty(), str::stream() << collectionUUID);
auto nss = collection->ns();
UncommittedCollections::get(opCtx).invariantHasExclusiveAccessToCollection(opCtx,
collection->ns());
auto opObserver = opCtx->getServiceContext()->getOpObserver();
auto indexCatalog = collection->getIndexCatalog();
// Always run single phase index build for empty collection. And, will be coordinated using
// createIndexes oplog entry.
for (const auto& spec : specs) {
// Each index will be added to the mdb catalog using the preceding createIndexes
// timestamp.
opObserver->onCreateIndex(opCtx, nss, collectionUUID, spec, fromMigrate);
uassertStatusOK(indexCatalog->createIndexOnEmptyCollection(opCtx, spec));
}
}
void IndexBuildsCoordinator::sleepIndexBuilds_forTestOnly(bool sleep) {
stdx::unique_lock<Latch> lk(_mutex);
_sleepForTest = sleep;
}
void IndexBuildsCoordinator::verifyNoIndexBuilds_forTestOnly() {
stdx::unique_lock<Latch> lk(_mutex);
invariant(_allIndexBuilds.empty());
}
// static
void IndexBuildsCoordinator::updateCurOpOpDescription(OperationContext* opCtx,
const NamespaceString& nss,
const std::vector<BSONObj>& indexSpecs) {
BSONObjBuilder builder;
// If the collection namespace is provided, add a 'createIndexes' field with the collection name
// to allow tests to identify this op as an index build.
if (!nss.isEmpty()) {
builder.append(kCreateIndexesFieldName, nss.coll());
}
// If index specs are provided, add them under the 'indexes' field.
if (!indexSpecs.empty()) {
BSONArrayBuilder indexesBuilder;
for (const auto& spec : indexSpecs) {
indexesBuilder.append(spec);
}
builder.append(kIndexesFieldName, indexesBuilder.arr());
}
stdx::unique_lock<Client> lk(*opCtx->getClient());
auto curOp = CurOp::get(opCtx);
builder.appendElementsUnique(curOp->opDescription());
auto opDescObj = builder.obj();
curOp->setLogicalOp_inlock(LogicalOp::opCommand);
curOp->setOpDescription_inlock(opDescObj);
curOp->setNS_inlock(nss.ns());
curOp->ensureStarted();
}
Status IndexBuildsCoordinator::_registerIndexBuild(
WithLock lk, std::shared_ptr<ReplIndexBuildState> replIndexBuildState) {
// Check whether any indexes are already being built with the same index name(s). (Duplicate
// specs will be discovered by the index builder.)
auto pred = [&](const auto& replState) {
return replIndexBuildState->collectionUUID == replState.collectionUUID;
};
auto collIndexBuilds = _filterIndexBuilds_inlock(lk, pred);
for (auto existingIndexBuild : collIndexBuilds) {
for (const auto& name : replIndexBuildState->indexNames) {
if (existingIndexBuild->indexNames.end() !=
std::find(existingIndexBuild->indexNames.begin(),
existingIndexBuild->indexNames.end(),
name)) {
str::stream ss;
ss << "Index build conflict: " << replIndexBuildState->buildUUID
<< ": There's already an index with name '" << name
<< "' being built on the collection "
<< " ( " << replIndexBuildState->collectionUUID
<< " ) under an existing index build: " << existingIndexBuild->buildUUID;
auto aborted = false;
{
// We have to lock the mutex in order to read the committed/aborted state.
stdx::unique_lock<Latch> lk(existingIndexBuild->mutex);
ss << " index build state: " << existingIndexBuild->indexBuildState.toString();
if (auto ts = existingIndexBuild->indexBuildState.getTimestamp()) {
ss << ", timestamp: " << ts->toString();
}
if (existingIndexBuild->indexBuildState.isAborted()) {
if (auto abortReason =
existingIndexBuild->indexBuildState.getAbortReason()) {
ss << ", abort reason: " << abortReason.get();
}
aborted = true;
}
}
std::string msg = ss;
LOGV2(20661, "{msg}", "msg"_attr = msg);
if (aborted) {
return {ErrorCodes::IndexBuildAborted, msg};
}
return Status(ErrorCodes::IndexBuildAlreadyInProgress, msg);
}
}
}
invariant(_allIndexBuilds.emplace(replIndexBuildState->buildUUID, replIndexBuildState).second);
_indexBuildsCondVar.notify_all();
return Status::OK();
}
void IndexBuildsCoordinator::_unregisterIndexBuild(
WithLock lk, std::shared_ptr<ReplIndexBuildState> replIndexBuildState) {
invariant(_allIndexBuilds.erase(replIndexBuildState->buildUUID));
LOGV2(4656004, "Unregistering index build", "buildUUID"_attr = replIndexBuildState->buildUUID);
_indexBuildsManager.unregisterIndexBuild(replIndexBuildState->buildUUID);
_indexBuildsCondVar.notify_all();
}
Status IndexBuildsCoordinator::_setUpIndexBuildForTwoPhaseRecovery(
OperationContext* opCtx,
StringData dbName,
CollectionUUID collectionUUID,
const std::vector<BSONObj>& specs,
const UUID& buildUUID) {
NamespaceStringOrUUID nssOrUuid{dbName.toString(), collectionUUID};
// Don't use the AutoGet helpers because they require an open database, which may not be the
// case when an index builds is restarted during recovery.
Lock::DBLock dbLock(opCtx, dbName, MODE_IX);
Lock::CollectionLock collLock(opCtx, nssOrUuid, MODE_X);
auto collection = CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, collectionUUID);
invariant(collection);
const auto& nss = collection->ns();
const auto protocol = IndexBuildProtocol::kTwoPhase;
return _startIndexBuildForRecovery(opCtx, nss, specs, buildUUID, protocol);
}
StatusWith<boost::optional<SharedSemiFuture<ReplIndexBuildState::IndexCatalogStats>>>
IndexBuildsCoordinator::_filterSpecsAndRegisterBuild(OperationContext* opCtx,
StringData dbName,
CollectionUUID collectionUUID,
const std::vector<BSONObj>& specs,
const UUID& buildUUID,
IndexBuildProtocol protocol) {
// AutoGetCollection throws an exception if it is unable to look up the collection by UUID.
NamespaceStringOrUUID nssOrUuid{dbName.toString(), collectionUUID};
AutoGetCollection autoColl(opCtx, nssOrUuid, MODE_X);
auto collection = autoColl.getCollection();
const auto& nss = collection->ns();
// Disallow index builds on drop-pending namespaces (system.drop.*) if we are primary.
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (replCoord->getSettings().usingReplSets() &&
replCoord->canAcceptWritesFor(opCtx, nssOrUuid)) {
uassert(ErrorCodes::NamespaceNotFound,
str::stream() << "drop-pending collection: " << nss,
!nss.isDropPendingNamespace());
}
// This check is for optimization purposes only as since this lock is released after this,
// and is acquired again when we build the index in _setUpIndexBuild.
auto status = CollectionShardingState::get(opCtx, nss)->checkShardVersionNoThrow(opCtx);
if (!status.isOK()) {
return status;
}
// Lock from when we ascertain what indexes to build through to when the build is registered
// on the Coordinator and persistedly set up in the catalog. This serializes setting up an
// index build so that no attempts are made to register the same build twice.
stdx::unique_lock<Latch> lk(_mutex);
std::vector<BSONObj> filteredSpecs;
try {
filteredSpecs = prepareSpecListForCreate(opCtx, collection, nss, specs);
} catch (const DBException& ex) {
return ex.toStatus();
}
if (filteredSpecs.size() == 0) {
// The requested index (specs) are already built or are being built. Return success
// early (this is v4.0 behavior compatible).
ReplIndexBuildState::IndexCatalogStats indexCatalogStats;
int numIndexes = getNumIndexesTotal(opCtx, collection);
indexCatalogStats.numIndexesBefore = numIndexes;
indexCatalogStats.numIndexesAfter = numIndexes;
return SharedSemiFuture(indexCatalogStats);
}
// Bypass the thread pool if we are building indexes on an empty collection.
if (shouldBuildIndexesOnEmptyCollectionSinglePhased(opCtx, collection, protocol)) {
ReplIndexBuildState::IndexCatalogStats indexCatalogStats;
indexCatalogStats.numIndexesBefore = getNumIndexesTotal(opCtx, collection);
try {
// Replicate this index build using the old-style createIndexes oplog entry to avoid
// timestamping issues that would result from this empty collection optimization on a
// secondary. If we tried to generate two phase index build startIndexBuild and
// commitIndexBuild oplog entries, this optimization will fail to accurately timestamp
// the catalog update when it uses the timestamp from the startIndexBuild, rather than
// the commitIndexBuild, oplog entry.
writeConflictRetry(
opCtx, "IndexBuildsCoordinator::_filterSpecsAndRegisterBuild", nss.ns(), [&] {
WriteUnitOfWork wuow(opCtx);
createIndexesOnEmptyCollection(opCtx, collection->uuid(), filteredSpecs, false);
wuow.commit();
});
} catch (DBException& ex) {
ex.addContext(str::stream() << "index build on empty collection failed: " << buildUUID);
return ex.toStatus();
}
indexCatalogStats.numIndexesAfter = getNumIndexesTotal(opCtx, collection);
return SharedSemiFuture(indexCatalogStats);
}
auto replIndexBuildState = std::make_shared<ReplIndexBuildState>(
buildUUID, collectionUUID, dbName.toString(), filteredSpecs, protocol);
replIndexBuildState->stats.numIndexesBefore = getNumIndexesTotal(opCtx, collection);
status = _registerIndexBuild(lk, replIndexBuildState);
if (!status.isOK()) {
return status;
}
// The index has been registered on the Coordinator in an unstarted state. Return an
// uninitialized Future so that the caller can set up the index build by calling
// _setUpIndexBuild(). The completion of the index build will be communicated via a Future
// obtained from 'replIndexBuildState->sharedPromise'.
return boost::none;
}
IndexBuildsCoordinator::PostSetupAction IndexBuildsCoordinator::_setUpIndexBuildInner(
OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
Timestamp startTimestamp,
const IndexBuildOptions& indexBuildOptions) {
const NamespaceStringOrUUID nssOrUuid{replState->dbName, replState->collectionUUID};
AutoGetCollection autoColl(opCtx, nssOrUuid, MODE_X);
auto collection = autoColl.getCollection();
const auto& nss = collection->ns();
CollectionShardingState::get(opCtx, nss)->checkShardVersionOrThrow(opCtx);
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
const bool replSetAndNotPrimary =
replCoord->getSettings().usingReplSets() && !replCoord->canAcceptWritesFor(opCtx, nss);
// We will not have a start timestamp if we are newly a secondary (i.e. we started as
// primary but there was a stepdown). We will be unable to timestamp the initial catalog write,
// so we must fail the index build. During initial sync, there is no commit timestamp set.
if (replSetAndNotPrimary &&
indexBuildOptions.applicationMode != ApplicationMode::kInitialSync) {
uassert(ErrorCodes::NotMaster,
str::stream() << "Replication state changed while setting up the index build: "
<< replState->buildUUID,
!startTimestamp.isNull());
}
MultiIndexBlock::OnInitFn onInitFn;
if (IndexBuildProtocol::kTwoPhase == replState->protocol) {
// Change the startIndexBuild Oplog entry.
// Two-phase index builds write a different oplog entry than the default behavior which
// writes a no-op just to generate an optime.
onInitFn = [&](std::vector<BSONObj>& specs) {
if (!(replCoord->getSettings().usingReplSets() &&
replCoord->canAcceptWritesFor(opCtx, nss))) {
// Not primary.
return Status::OK();
}
// Two phase index builds should have commit quorum set.
invariant(indexBuildOptions.commitQuorum,
str::stream()
<< "Commit quorum required for two phase index build, buildUUID: "
<< replState->buildUUID
<< " collectionUUID: " << replState->collectionUUID);
// Persist the commit quorum value in the config.system.indexBuilds collection.
IndexBuildEntry indexBuildEntry(replState->buildUUID,
replState->collectionUUID,
indexBuildOptions.commitQuorum.get(),
replState->indexNames);
uassertStatusOK(indexbuildentryhelpers::addIndexBuildEntry(opCtx, indexBuildEntry));
opCtx->getServiceContext()->getOpObserver()->onStartIndexBuild(
opCtx,
nss,
replState->collectionUUID,
replState->buildUUID,
replState->indexSpecs,
false /* fromMigrate */);
return Status::OK();
};
} else {
onInitFn = MultiIndexBlock::makeTimestampedIndexOnInitFn(opCtx, collection);
}
IndexBuildsManager::SetupOptions options;
options.indexConstraints =
repl::ReplicationCoordinator::get(opCtx)->shouldRelaxIndexConstraints(opCtx, nss)
? IndexBuildsManager::IndexConstraints::kRelax
: IndexBuildsManager::IndexConstraints::kEnforce;
options.protocol = replState->protocol;
try {
if (!replSetAndNotPrimary) {
// On standalones and primaries, call setUpIndexBuild(), which makes the initial catalog
// write. On primaries, this replicates the startIndexBuild oplog entry.
uassertStatusOK(_indexBuildsManager.setUpIndexBuild(
opCtx, collection, replState->indexSpecs, replState->buildUUID, onInitFn, options));
} else {
// If we are starting the index build as a secondary, we must suppress calls to write
// our initial oplog entry in setUpIndexBuild().
repl::UnreplicatedWritesBlock uwb(opCtx);
boost::optional<TimestampBlock> tsBlock;
if (indexBuildOptions.applicationMode != ApplicationMode::kInitialSync) {
// Use the provided timestamp to write the initial catalog entry. Initial sync does
// not set a commit timestamp.
invariant(!startTimestamp.isNull());
tsBlock.emplace(opCtx, startTimestamp);
}
uassertStatusOK(_indexBuildsManager.setUpIndexBuild(
opCtx, collection, replState->indexSpecs, replState->buildUUID, onInitFn, options));
}
} catch (DBException& ex) {
_indexBuildsManager.abortIndexBuild(
opCtx, collection, replState->buildUUID, MultiIndexBlock::kNoopOnCleanUpFn);
const auto& status = ex.toStatus();
if (status == ErrorCodes::IndexAlreadyExists ||
((status == ErrorCodes::IndexOptionsConflict ||
status == ErrorCodes::IndexKeySpecsConflict) &&
options.indexConstraints == IndexBuildsManager::IndexConstraints::kRelax)) {
LOGV2_DEBUG(
20662, 1, "Ignoring indexing error: {status}", "status"_attr = redact(status));
return PostSetupAction::kCompleteIndexBuildEarly;
}
throw;
}
return PostSetupAction::kContinueIndexBuild;
}
Status IndexBuildsCoordinator::_setUpIndexBuild(OperationContext* opCtx,
const UUID& buildUUID,
Timestamp startTimestamp,
const IndexBuildOptions& indexBuildOptions) {
auto replState = invariant(_getIndexBuild(buildUUID));
auto postSetupAction = PostSetupAction::kContinueIndexBuild;
try {
postSetupAction =
_setUpIndexBuildInner(opCtx, replState, startTimestamp, indexBuildOptions);
} catch (const DBException& ex) {
stdx::unique_lock<Latch> lk(_mutex);
_unregisterIndexBuild(lk, replState);
return ex.toStatus();
}
// The indexes are in the durable catalog in an unfinished state. Return an OK status so
// that the caller can continue building the indexes by calling _runIndexBuild().
if (PostSetupAction::kContinueIndexBuild == postSetupAction) {
return Status::OK();
}
// Unregister the index build before setting the promise, so callers do not see the build again.
{
stdx::unique_lock<Latch> lk(_mutex);
_unregisterIndexBuild(lk, replState);
}
// The requested index (specs) are already built or are being built. Return success
// early (this is v4.0 behavior compatible).
invariant(PostSetupAction::kCompleteIndexBuildEarly == postSetupAction,
str::stream() << "failed to set up index build " << buildUUID
<< " with start timestamp " << startTimestamp.toString());
ReplIndexBuildState::IndexCatalogStats indexCatalogStats;
int numIndexes = replState->stats.numIndexesBefore;
indexCatalogStats.numIndexesBefore = numIndexes;
indexCatalogStats.numIndexesAfter = numIndexes;
replState->sharedPromise.emplaceValue(indexCatalogStats);
return Status::OK();
}
void IndexBuildsCoordinator::_runIndexBuild(OperationContext* opCtx,
const UUID& buildUUID,
const IndexBuildOptions& indexBuildOptions) noexcept {
{
stdx::unique_lock<Latch> lk(_mutex);
while (_sleepForTest) {
lk.unlock();
sleepmillis(100);
lk.lock();
}
}
// If the index build does not exist, do not continue building the index. This may happen if an
// ignorable indexing error occurred during setup. The promise will have been fulfilled, but the
// build has already been unregistered.
auto swReplState = _getIndexBuild(buildUUID);
if (swReplState.getStatus() == ErrorCodes::NoSuchKey) {
return;
}
auto replState = invariant(swReplState);
{
// The index build is now past the setup stage and in progress. This makes it eligible to be
// aborted. Use the current OperationContext's opId as the means for interrupting the index
// build.
stdx::unique_lock<Latch> lk(replState->mutex);
replState->opId = opCtx->getOpID();
replState->indexBuildState.setState(IndexBuildState::kInProgress, false /* skipCheck */);
}
// Add build UUID to lock manager diagnostic output.
auto locker = opCtx->lockState();
auto oldLockerDebugInfo = locker->getDebugInfo();
{
str::stream ss;
ss << "index build: " << replState->buildUUID;
if (!oldLockerDebugInfo.empty()) {
ss << "; " << oldLockerDebugInfo;
}
locker->setDebugInfo(ss);
}
auto status = [&]() {
try {
_runIndexBuildInner(opCtx, replState, indexBuildOptions);
} catch (const DBException& ex) {
return ex.toStatus();
}
return Status::OK();
}();
locker->setDebugInfo(oldLockerDebugInfo);
// Ensure the index build is unregistered from the Coordinator and the Promise is set with
// the build's result so that callers are notified of the outcome.
if (status.isOK()) {
stdx::unique_lock<Latch> lk(_mutex);
// Unregister first so that when we fulfill the future, the build is not observed as active.
_unregisterIndexBuild(lk, replState);
replState->sharedPromise.emplaceValue(replState->stats);
return;
}
// During a failure, unregistering is handled by either the caller or the current thread,
// depending on where the error originated. Signal to any waiters that an error occurred.
replState->sharedPromise.setError(status);
}
namespace {
template <typename Func>
void runOnAlternateContext(OperationContext* opCtx, std::string name, Func func) {
auto newClient = opCtx->getServiceContext()->makeClient(name);
AlternativeClientRegion acr(newClient);
const auto newCtx = cc().makeOperationContext();
func(newCtx.get());
}
} // namespace
void IndexBuildsCoordinator::_cleanUpSinglePhaseAfterFailure(
OperationContext* opCtx,
Collection* collection,
std::shared_ptr<ReplIndexBuildState> replState,
const IndexBuildOptions& indexBuildOptions,
const Status& status) {
if (status.isA<ErrorCategory::ShutdownError>()) {
_completeAbortForShutdown(opCtx, replState, collection);
return;
}
if (indexBuildOptions.replSetAndNotPrimaryAtStart) {
// This build started and failed as a secondary. Single-phase index builds started on
// secondaries may not fail. Do not clean up the index build. It must remain unfinished
// until it is successfully rebuilt on startup.
fassert(31354,
status.withContext(str::stream() << "Index build: " << replState->buildUUID
<< "; Database: " << replState->dbName));
}
// The index builder thread can abort on its own if it is interrupted by a user killop. This
// would prevent us from taking locks. Use a new OperationContext to abort the index build.
runOnAlternateContext(
opCtx, "self-abort", [this, replState, status](OperationContext* abortCtx) {
ShouldNotConflictWithSecondaryBatchApplicationBlock noConflict(abortCtx->lockState());
Lock::DBLock dbLock(abortCtx, replState->dbName, MODE_IX);
// Unlock RSTL to avoid deadlocks with prepare conflicts and state transitions caused by
// taking a strong collection lock. See SERVER-42621.
unlockRSTL(abortCtx);
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
Lock::CollectionLock collLock(abortCtx, dbAndUUID, MODE_X);
_completeSelfAbort(abortCtx, replState, status);
});
}
void IndexBuildsCoordinator::_cleanUpTwoPhaseAfterFailure(
OperationContext* opCtx,
Collection* collection,
std::shared_ptr<ReplIndexBuildState> replState,
const IndexBuildOptions& indexBuildOptions,
const Status& status) {
if (status.isA<ErrorCategory::ShutdownError>()) {
_completeAbortForShutdown(opCtx, replState, collection);
return;
}
// The index builder thread can abort on its own if it is interrupted by a user killop. This
// would prevent us from taking locks. Use a new OperationContext to abort the index build.
runOnAlternateContext(
opCtx, "self-abort", [this, replState, status](OperationContext* abortCtx) {
ShouldNotConflictWithSecondaryBatchApplicationBlock noConflict(abortCtx->lockState());
// Take RSTL (implicitly by DBLock) to observe and prevent replication state from
// changing.
Lock::DBLock dbLock(abortCtx, replState->dbName, MODE_IX);
// Index builds may not fail on secondaries. If a primary replicated an abortIndexBuild
// oplog entry, then this index build would have received an IndexBuildAborted error
// code.
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
auto replCoord = repl::ReplicationCoordinator::get(abortCtx);
if (replCoord->getSettings().usingReplSets() &&
!replCoord->canAcceptWritesFor(abortCtx, dbAndUUID)) {
fassert(51101,
status.withContext(str::stream() << "Index build: " << replState->buildUUID
<< "; Database: " << replState->dbName));
}
Lock::CollectionLock collLock(abortCtx, dbAndUUID, MODE_X);
_completeSelfAbort(abortCtx, replState, status);
});
}
void IndexBuildsCoordinator::_runIndexBuildInner(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
const IndexBuildOptions& indexBuildOptions) {
// This Status stays unchanged unless we catch an exception in the following try-catch block.
auto status = Status::OK();
try {
while (MONGO_unlikely(hangAfterInitializingIndexBuild.shouldFail())) {
hangAfterInitializingIndexBuild.pauseWhileSet(opCtx);
}
_buildIndex(opCtx, replState, indexBuildOptions);
} catch (const DBException& ex) {
status = ex.toStatus();
}
if (status.isOK()) {
return;
}
{
// If the index build has already been cleaned-up because it encountered an error at
// commit-time, there is no work to do. This is the most routine case, since index
// constraint checking happens at commit-time for index builds.
stdx::unique_lock<Latch> lk(replState->mutex);
if (replState->indexBuildState.isAborted()) {
uassertStatusOK(status);
}
}
// We do not hold a collection lock here, but we are protected against the collection being
// dropped while the index build is still registered for the collection -- until abortIndexBuild
// is called. The collection can be renamed, but it is OK for the name to be stale just for
// logging purposes.
auto collection =
CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, replState->collectionUUID);
invariant(collection,
str::stream() << "Collection with UUID " << replState->collectionUUID
<< " should exist because an index build is in progress: "
<< replState->buildUUID);
NamespaceString nss = collection->ns();
logFailure(status, nss, replState);
// If we received an external abort, the caller should have already set our state to kAborted.
invariant(status.code() != ErrorCodes::IndexBuildAborted);
// Index builds only check index constraints when committing. If an error occurs at that point,
// then the build is cleaned up while still holding the appropriate locks. The only errors that
// we cannot anticipate are user interrupts and shutdown errors.
invariant(status.isA<ErrorCategory::Interruption>() ||
status.isA<ErrorCategory::ShutdownError>(),
str::stream() << "Unnexpected error code during index build cleanup: " << status);
if (IndexBuildProtocol::kSinglePhase == replState->protocol) {
_cleanUpSinglePhaseAfterFailure(opCtx, collection, replState, indexBuildOptions, status);
} else {
invariant(IndexBuildProtocol::kTwoPhase == replState->protocol,
str::stream() << replState->buildUUID);
_cleanUpTwoPhaseAfterFailure(opCtx, collection, replState, indexBuildOptions, status);
}
// Any error that escapes at this point is not fatal and can be handled by the caller.
uassertStatusOK(status);
}
void IndexBuildsCoordinator::_buildIndex(OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
const IndexBuildOptions& indexBuildOptions) {
_scanCollectionAndInsertKeysIntoSorter(opCtx, replState);
_insertKeysFromSideTablesWithoutBlockingWrites(opCtx, replState);
_signalPrimaryForCommitReadiness(opCtx, replState);
_insertKeysFromSideTablesBlockingWrites(opCtx, replState, indexBuildOptions);
_waitForNextIndexBuildActionAndCommit(opCtx, replState, indexBuildOptions);
}
void IndexBuildsCoordinator::_scanCollectionAndInsertKeysIntoSorter(
OperationContext* opCtx, std::shared_ptr<ReplIndexBuildState> replState) {
// Collection scan and insert into index.
{
AutoGetDb autoDb(opCtx, replState->dbName, MODE_IX);
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
Lock::CollectionLock collLock(opCtx, dbAndUUID, MODE_IX);
// Rebuilding system indexes during startup using the IndexBuildsCoordinator is done by all
// storage engines if they're missing.
invariant(_indexBuildsManager.isBackgroundBuilding(replState->buildUUID));
auto nss = CollectionCatalog::get(opCtx).lookupNSSByUUID(opCtx, replState->collectionUUID);
invariant(nss);
// Set up the thread's currentOp information to display createIndexes cmd information.
updateCurOpOpDescription(opCtx, *nss, replState->indexSpecs);
// Index builds can safely ignore prepare conflicts and perform writes. On secondaries,
// prepare operations wait for index builds to complete.
opCtx->recoveryUnit()->setPrepareConflictBehavior(
PrepareConflictBehavior::kIgnoreConflictsAllowWrites);
// The collection object should always exist while an index build is registered.
auto collection =
CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, replState->collectionUUID);
invariant(collection);
uassertStatusOK(
_indexBuildsManager.startBuildingIndex(opCtx, collection, replState->buildUUID));
}
if (MONGO_unlikely(hangAfterIndexBuildDumpsInsertsFromBulk.shouldFail())) {
LOGV2(20665, "Hanging after dumping inserts from bulk builder");
hangAfterIndexBuildDumpsInsertsFromBulk.pauseWhileSet();
}
}
/**
* Second phase is extracting the sorted keys and writing them into the new index table.
*/
void IndexBuildsCoordinator::_insertKeysFromSideTablesWithoutBlockingWrites(
OperationContext* opCtx, std::shared_ptr<ReplIndexBuildState> replState) {
// Perform the first drain while holding an intent lock.
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
{
AutoGetDb autoDb(opCtx, replState->dbName, MODE_IX);
Lock::CollectionLock collLock(opCtx, dbAndUUID, MODE_IX);
uassertStatusOK(_indexBuildsManager.drainBackgroundWrites(
opCtx,
replState->buildUUID,
RecoveryUnit::ReadSource::kUnset,
IndexBuildInterceptor::DrainYieldPolicy::kYield));
}
if (MONGO_unlikely(hangAfterIndexBuildFirstDrain.shouldFail())) {
LOGV2(20666, "Hanging after index build first drain");
hangAfterIndexBuildFirstDrain.pauseWhileSet();
}
}
void IndexBuildsCoordinator::_insertKeysFromSideTablesBlockingWrites(
OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
const IndexBuildOptions& indexBuildOptions) {
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
// Perform the second drain while stopping writes on the collection.
{
AutoGetDb autoDb(opCtx, replState->dbName, MODE_IX);
// Unlock RSTL to avoid deadlocks with prepare conflicts and state transitions. See
// SERVER-42621.
unlockRSTL(opCtx);
Lock::CollectionLock collLock(opCtx, dbAndUUID, MODE_S);
uassertStatusOK(_indexBuildsManager.drainBackgroundWrites(
opCtx,
replState->buildUUID,
RecoveryUnit::ReadSource::kUnset,
IndexBuildInterceptor::DrainYieldPolicy::kNoYield));
}
if (MONGO_unlikely(hangAfterIndexBuildSecondDrain.shouldFail())) {
LOGV2(20667, "Hanging after index build second drain");
hangAfterIndexBuildSecondDrain.pauseWhileSet();
}
}
/**
* Third phase is catching up on all the writes that occurred during the first two phases.
* Accepts a commit timestamp for the index (null if not available).
*/
IndexBuildsCoordinator::CommitResult IndexBuildsCoordinator::_insertKeysFromSideTablesAndCommit(
OperationContext* opCtx,
std::shared_ptr<ReplIndexBuildState> replState,
IndexBuildAction action,
const IndexBuildOptions& indexBuildOptions,
const Timestamp& commitIndexBuildTimestamp) {
AutoGetDb autoDb(opCtx, replState->dbName, MODE_IX);
// Unlock RSTL to avoid deadlocks with prepare conflicts and state transitions caused by waiting
// for a a strong collection lock. See SERVER-42621.
unlockRSTL(opCtx);
// Need to return the collection lock back to exclusive mode to complete the index build.
const NamespaceStringOrUUID dbAndUUID(replState->dbName, replState->collectionUUID);
Lock::CollectionLock collLock(opCtx, dbAndUUID, MODE_X);
// If we can't acquire the RSTL within a given time period, there is an active state transition
// and we should release our locks and try again. We would otherwise introduce a deadlock with
// step-up by holding the Collection lock in exclusive mode. After it has enqueued its RSTL X
// lock, step-up tries to reacquire the Collection locks for prepared transactions, which will
// conflict with the X lock we currently hold.
repl::ReplicationStateTransitionLockGuard rstl(
opCtx, MODE_IX, repl::ReplicationStateTransitionLockGuard::EnqueueOnly());
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
try {
// Since this thread is not killable by state transitions, this deadline is effectively the
// longest period of time we can block a step-up. State transitions are infrequent, but
// need to happen quickly. It should be okay to set this to a low value because the RSTL is
// rarely contended, and if this times out, we will retry and reacquire the RSTL again
// without a deadline at the beginning of this function.
auto deadline = Date_t::now() + Milliseconds(10);
rstl.waitForLockUntil(deadline);
} catch (const ExceptionFor<ErrorCodes::LockTimeout>&) {
return CommitResult::kLockTimeout;
}
// If we are no longer primary after receiving a commit quorum, we must restart and wait for a
// new signal from a new primary because we cannot commit. Note that two-phase index builds can
// retry because a new signal should be received. Single-phase builds will be unable to commit
// and will self-abort.
bool isMaster = replCoord->canAcceptWritesFor(opCtx, dbAndUUID);
if (!isMaster && IndexBuildAction::kCommitQuorumSatisfied == action) {
return CommitResult::kNoLongerPrimary;
}
if (IndexBuildAction::kOplogCommit == action) {
// This signal can be received during primary (drain phase), secondary, startup (startup
// recovery) and startup2 (initial sync).
invariant(!isMaster && replState->indexBuildState.isCommitPrepared(),
str::stream() << "Index build: " << replState->buildUUID
<< ", index build state: "
<< replState->indexBuildState.toString());
}
// The collection object should always exist while an index build is registered.
auto collection =
CollectionCatalog::get(opCtx).lookupCollectionByUUID(opCtx, replState->collectionUUID);
invariant(collection,
str::stream() << "Collection not found after relocking. Index build: "
<< replState->buildUUID
<< ", collection UUID: " << replState->collectionUUID);
// Perform the third and final drain after releasing a shared lock and reacquiring an
// exclusive lock on the database.
uassertStatusOK(_indexBuildsManager.drainBackgroundWrites(
opCtx,
replState->buildUUID,
RecoveryUnit::ReadSource::kUnset,
IndexBuildInterceptor::DrainYieldPolicy::kNoYield));
try {
failIndexBuildOnCommit.execute(
[](const BSONObj&) { uasserted(4698903, "index build aborted due to failpoint"); });
{
auto dss = DatabaseShardingState::get(opCtx, replState->dbName);
auto dssLock = DatabaseShardingState::DSSLock::lockShared(opCtx, dss);
dss->checkDbVersion(opCtx, dssLock);
}
// If we are no longer primary and a single phase index build started as primary attempts to
// commit, trigger a self-abort.
if (!isMaster && IndexBuildAction::kSinglePhaseCommit == action &&
!indexBuildOptions.replSetAndNotPrimaryAtStart) {
uassertStatusOK(
{ErrorCodes::NotMaster,
str::stream() << "Unable to commit index build because we are no longer primary: "
<< replState->buildUUID});
}
// Retry indexing records that failed key generation, but only if we are primary.
// Secondaries rely on the primary's decision to commit as assurance that it has checked all
// key generation errors on its behalf.
if (isMaster) {
uassertStatusOK(
_indexBuildsManager.retrySkippedRecords(opCtx, replState->buildUUID, collection));
}
// Duplicate key constraint checking phase. Duplicate key errors are tracked for
// single-phase builds on primaries and two-phase builds in all replication states.
// Single-phase builds on secondaries don't track duplicates so this call is a no-op. This
// can be called for two-phase builds in all replication states except during initial sync
// when this node is not guaranteed to be consistent.
bool twoPhaseAndNotInitialSyncing = IndexBuildProtocol::kTwoPhase == replState->protocol &&
!replCoord->getMemberState().startup2();
if (IndexBuildProtocol::kSinglePhase == replState->protocol ||
twoPhaseAndNotInitialSyncing) {
uassertStatusOK(
_indexBuildsManager.checkIndexConstraintViolations(opCtx, replState->buildUUID));
}
} catch (const ExceptionForCat<ErrorCategory::ShutdownError>& e) {
logFailure(e.toStatus(), collection->ns(), replState);
_completeAbortForShutdown(opCtx, replState, collection);
throw;
} catch (const DBException& e) {
auto status = e.toStatus();
logFailure(status, collection->ns(), replState);
// It is illegal to abort the index build at this point. Note that Interruption exceptions
// are allowed because we cannot control them as they bypass the routine abort machinery.
invariant(e.code() != ErrorCodes::IndexBuildAborted);
// Index build commit may not fail on secondaries because it implies diverenge with data on
// the primary. The only exception is single-phase builds started on primaries, which may
// fail after a state transition. In this case, we have not replicated anything to
// roll-back. With two-phase index builds, if a primary replicated an abortIndexBuild oplog
// entry, then this index build should have been interrupted before committing with an
// IndexBuildAborted error code.
const bool twoPhaseAndNotPrimary =
IndexBuildProtocol::kTwoPhase == replState->protocol && !isMaster;
const bool singlePhaseAndNotPrimaryAtStart =
IndexBuildProtocol::kSinglePhase == replState->protocol &&
indexBuildOptions.replSetAndNotPrimaryAtStart;
if (twoPhaseAndNotPrimary || singlePhaseAndNotPrimaryAtStart) {
LOGV2_FATAL(4698902,
"Index build failed while not primary",
"buildUUID"_attr = replState->buildUUID,
"collectionUUID"_attr = replState->collectionUUID,
"db"_attr = replState->dbName,
"reason"_attr = status);
}
// This index build failed due to an indexing error in normal circumstances. Abort while
// still holding the RSTL and collection locks.
_completeSelfAbort(opCtx, replState, status);
throw;
}
// If two phase index builds is enabled, index build will be coordinated using
// startIndexBuild and commitIndexBuild oplog entries.
auto onCommitFn = [&] { onCommitIndexBuild(opCtx, collection->ns(), replState); };
auto onCreateEachFn = [&](const BSONObj& spec) {
if (IndexBuildProtocol::kTwoPhase == replState->protocol) {
return;
}
if (indexBuildOptions.replSetAndNotPrimaryAtStart) {
LOGV2_DEBUG(20671,
1,
"Skipping createIndexes oplog entry for index build: {replState_buildUUID}",
"replState_buildUUID"_attr = replState->buildUUID);
// Get a timestamp to complete the index build in the absence of a createIndexBuild
// oplog entry.
repl::UnreplicatedWritesBlock uwb(opCtx);
if (!IndexTimestampHelper::setGhostCommitTimestampForCatalogWrite(opCtx,
collection->ns())) {
LOGV2(20672, "Did not timestamp index commit write.");
}
return;
}
auto opObserver = opCtx->getServiceContext()->getOpObserver();
auto fromMigrate = false;
opObserver->onCreateIndex(
opCtx, collection->ns(), replState->collectionUUID, spec, fromMigrate);
};
// Commit index build.
TimestampBlock tsBlock(opCtx, commitIndexBuildTimestamp);
uassertStatusOK(_indexBuildsManager.commitIndexBuild(
opCtx, collection, collection->ns(), replState->buildUUID, onCreateEachFn, onCommitFn));
removeIndexBuildEntryAfterCommitOrAbort(opCtx, dbAndUUID, *replState);
replState->stats.numIndexesAfter = getNumIndexesTotal(opCtx, collection);
LOGV2(20663,
"Index build completed successfully",
"buildUUID"_attr = replState->buildUUID,
"collection"_attr = collection->ns(),
"collectionUUID"_attr = replState->collectionUUID,
"indexesBuilt"_attr = replState->indexSpecs.size(),
"numIndexesBefore"_attr = replState->stats.numIndexesBefore,
"numIndexesAfter"_attr = replState->stats.numIndexesAfter);
return CommitResult::kSuccess;
}
StatusWith<std::pair<long long, long long>> IndexBuildsCoordinator::_runIndexRebuildForRecovery(
OperationContext* opCtx,
Collection* collection,
const UUID& buildUUID,
RepairData repair) noexcept {
invariant(opCtx->lockState()->isCollectionLockedForMode(collection->ns(), MODE_X));
auto replState = invariant(_getIndexBuild(buildUUID));
// We rely on 'collection' for any collection information because no databases are open during
// recovery.
NamespaceString nss = collection->ns();
invariant(!nss.isEmpty());
auto status = Status::OK();
long long numRecords = 0;
long long dataSize = 0;
ReplIndexBuildState::IndexCatalogStats indexCatalogStats;
indexCatalogStats.numIndexesBefore = getNumIndexesTotal(opCtx, collection);
try {
LOGV2(20673,
"Index builds manager starting: {buildUUID}: {nss}",
"buildUUID"_attr = buildUUID,
"nss"_attr = nss);
std::tie(numRecords, dataSize) =
uassertStatusOK(_indexBuildsManager.startBuildingIndexForRecovery(
opCtx, collection->ns(), buildUUID, repair));
uassertStatusOK(
_indexBuildsManager.checkIndexConstraintViolations(opCtx, replState->buildUUID));
// Commit the index build.
uassertStatusOK(_indexBuildsManager.commitIndexBuild(opCtx,
collection,
nss,
buildUUID,
MultiIndexBlock::kNoopOnCreateEachFn,
MultiIndexBlock::kNoopOnCommitFn));
indexCatalogStats.numIndexesAfter = getNumIndexesTotal(opCtx, collection);
LOGV2(20674,
"Index builds manager completed successfully: {buildUUID}: {nss}. Index specs "
"requested: {replState_indexSpecs_size}. Indexes in catalog before build: "
"{indexCatalogStats_numIndexesBefore}. Indexes in catalog after build: "
"{indexCatalogStats_numIndexesAfter}",
"buildUUID"_attr = buildUUID,
"nss"_attr = nss,
"replState_indexSpecs_size"_attr = replState->indexSpecs.size(),
"indexCatalogStats_numIndexesBefore"_attr = indexCatalogStats.numIndexesBefore,
"indexCatalogStats_numIndexesAfter"_attr = indexCatalogStats.numIndexesAfter);
} catch (const DBException& ex) {
status = ex.toStatus();
invariant(status != ErrorCodes::IndexAlreadyExists);
LOGV2(20675,
"Index builds manager failed: {buildUUID}: {nss}: {status}",
"buildUUID"_attr = buildUUID,
"nss"_attr = nss,
"status"_attr = status);
}
// Index build is registered in manager regardless of IndexBuildsManager::setUpIndexBuild()
// result.
if (!status.isOK()) {
// An index build failure during recovery is fatal.
logFailure(status, nss, replState);
fassertNoTrace(51076, status);
}
// 'numIndexesBefore' was before we cleared any unfinished indexes, so it must be the same
// as 'numIndexesAfter', since we're going to be building any unfinished indexes too.
invariant(indexCatalogStats.numIndexesBefore == indexCatalogStats.numIndexesAfter);
{
stdx::unique_lock<Latch> lk(_mutex);
_unregisterIndexBuild(lk, replState);
}
if (status.isOK()) {
return std::make_pair(numRecords, dataSize);
}
return status;
}
StatusWith<std::shared_ptr<ReplIndexBuildState>> IndexBuildsCoordinator::_getIndexBuild(
const UUID& buildUUID) const {
stdx::unique_lock<Latch> lk(_mutex);
auto it = _allIndexBuilds.find(buildUUID);
if (it == _allIndexBuilds.end()) {
return {ErrorCodes::NoSuchKey, str::stream() << "No index build with UUID: " << buildUUID};
}
return it->second;
}
std::vector<std::shared_ptr<ReplIndexBuildState>> IndexBuildsCoordinator::_getIndexBuilds() const {
stdx::unique_lock<Latch> lk(_mutex);
auto filter = [](const auto& replState) { return true; };
return _filterIndexBuilds_inlock(lk, filter);
}
std::vector<std::shared_ptr<ReplIndexBuildState>> IndexBuildsCoordinator::_filterIndexBuilds_inlock(
WithLock lk, IndexBuildFilterFn indexBuildFilter) const {
std::vector<std::shared_ptr<ReplIndexBuildState>> indexBuilds;
for (auto pair : _allIndexBuilds) {
auto replState = pair.second;
if (!indexBuildFilter(*replState)) {
continue;
}
indexBuilds.push_back(replState);
}
return indexBuilds;
}
int IndexBuildsCoordinator::getNumIndexesTotal(OperationContext* opCtx, Collection* collection) {
invariant(collection);
const auto& nss = collection->ns();
invariant(opCtx->lockState()->isLocked(),
str::stream() << "Unable to get index count because collection was not locked"
<< nss);
auto indexCatalog = collection->getIndexCatalog();
invariant(indexCatalog, str::stream() << "Collection is missing index catalog: " << nss);
return indexCatalog->numIndexesTotal(opCtx);
}
std::vector<BSONObj> IndexBuildsCoordinator::prepareSpecListForCreate(
OperationContext* opCtx,
Collection* collection,
const NamespaceString& nss,
const std::vector<BSONObj>& indexSpecs) {
UncommittedCollections::get(opCtx).invariantHasExclusiveAccessToCollection(opCtx,
collection->ns());
invariant(collection);
// During secondary oplog application, the index specs have already been normalized in the
// oplog entries read from the primary. We should not be modifying the specs any further.
auto replCoord = repl::ReplicationCoordinator::get(opCtx);
if (replCoord->getSettings().usingReplSets() && !replCoord->canAcceptWritesFor(opCtx, nss)) {
return indexSpecs;
}
auto specsWithCollationDefaults =
uassertStatusOK(collection->addCollationDefaultsToIndexSpecsForCreate(opCtx, indexSpecs));
auto indexCatalog = collection->getIndexCatalog();
std::vector<BSONObj> resultSpecs;
resultSpecs = indexCatalog->removeExistingIndexes(
opCtx, specsWithCollationDefaults, true /*removeIndexBuildsToo*/);
for (const BSONObj& spec : resultSpecs) {
if (spec[kUniqueFieldName].trueValue()) {
checkShardKeyRestrictions(opCtx, nss, spec[kKeyFieldName].Obj());
}
}
return resultSpecs;
}
} // namespace mongo
|