scripted-diff: Replace MilliSleep with UninterruptibleSleep

MarcoFalke · MarcoFalke · commit fa9af06d91e9 · 2020-02-21T10:06:21.000-08:00
This is safe because MilliSleep is never executed in a boost::thread,
the only type of thread that is interruptible.

* The RPC server uses std::thread
* The wallet is either executed in an RPC thread or the main thread
* bitcoin-cli, benchmarks and tests are only one thread (the main thread)

-BEGIN VERIFY SCRIPT-
sed -i --regexp-extended -e 's/MilliSleep$(\S+)$;/UninterruptibleSleep(std::chrono::milliseconds{\1});/g' $(git grep -l MilliSleep)
-END VERIFY SCRIPT-
diff --git a/src/bench/examples.cpp b/src/bench/examples.cpp
@@ -10,7 +10,7 @@
 static void Sleep100ms(benchmark::State& state)
 {
     while (state.KeepRunning()) {
-        MilliSleep(100);
+        UninterruptibleSleep(std::chrono::milliseconds{100});
     }
 }
 
diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp
@@ -524,7 +524,7 @@ static int CommandLineRPC(int argc, char *argv[])
             }
             catch (const CConnectionFailed&) {
                 if (fWait)
-                    MilliSleep(1000);
+                    UninterruptibleSleep(std::chrono::milliseconds{1000});
                 else
                     throw;
             }
diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp
@@ -29,7 +29,7 @@ static void WaitForShutdown(NodeContext& node)
 {
     while (!ShutdownRequested())
     {
-        MilliSleep(200);
+        UninterruptibleSleep(std::chrono::milliseconds{200});
     }
     Interrupt(node);
 }
diff --git a/src/httprpc.cpp b/src/httprpc.cpp
@@ -174,7 +174,7 @@ static bool HTTPReq_JSONRPC(HTTPRequest* req, const std::string &)
         /* Deter brute-forcing
            If this results in a DoS the user really
            shouldn't have their RPC port exposed. */
-        MilliSleep(250);
+        UninterruptibleSleep(std::chrono::milliseconds{250});
 
         req->WriteHeader("WWW-Authenticate", WWW_AUTH_HEADER_DATA);
         req->WriteReply(HTTP_UNAUTHORIZED);
diff --git a/src/rpc/server.cpp b/src/rpc/server.cpp
@@ -169,7 +169,7 @@ UniValue stop(const JSONRPCRequest& jsonRequest)
     // this reply will get back to the client.
     StartShutdown();
     if (jsonRequest.params[0].isNum()) {
-        MilliSleep(jsonRequest.params[0].get_int());
+        UninterruptibleSleep(std::chrono::milliseconds{jsonRequest.params[0].get_int()});
     }
     return PACKAGE_NAME " stopping";
 }
diff --git a/src/test/blockfilter_index_tests.cpp b/src/test/blockfilter_index_tests.cpp
@@ -138,7 +138,7 @@ BOOST_FIXTURE_TEST_CASE(blockfilter_index_initial_sync, BuildChainTestingSetup)
     int64_t time_start = GetTimeMillis();
     while (!filter_index.BlockUntilSyncedToCurrentChain()) {
         BOOST_REQUIRE(time_start + timeout_ms > GetTimeMillis());
-        MilliSleep(100);
+        UninterruptibleSleep(std::chrono::milliseconds{100});
     }
 
     // Check that filter index has all blocks that were in the chain before it started.
diff --git a/src/test/checkqueue_tests.cpp b/src/test/checkqueue_tests.cpp
@@ -393,7 +393,7 @@ BOOST_AUTO_TEST_CASE(test_CheckQueueControl_Locks)
                     CCheckQueueControl<FakeCheck> control(queue.get());
                     // While sleeping, no other thread should execute to this point
                     auto observed = ++nThreads;
-                    MilliSleep(10);
+                    UninterruptibleSleep(std::chrono::milliseconds{10});
                     fails += observed  != nThreads;
                     });
         }
diff --git a/src/test/txindex_tests.cpp b/src/test/txindex_tests.cpp
@@ -34,7 +34,7 @@ BOOST_FIXTURE_TEST_CASE(txindex_initial_sync, TestChain100Setup)
     int64_t time_start = GetTimeMillis();
     while (!txindex.BlockUntilSyncedToCurrentChain()) {
         BOOST_REQUIRE(time_start + timeout_ms > GetTimeMillis());
-        MilliSleep(100);
+        UninterruptibleSleep(std::chrono::milliseconds{100});
     }
 
     // Check that txindex excludes genesis block transactions.
diff --git a/src/test/util_tests.cpp b/src/test/util_tests.cpp
@@ -1322,7 +1322,7 @@ BOOST_AUTO_TEST_CASE(util_time_GetTime)
     SetMockTime(111);
     // Check that mock time does not change after a sleep
     for (const auto& num_sleep : {0, 1}) {
-        MilliSleep(num_sleep);
+        UninterruptibleSleep(std::chrono::milliseconds{num_sleep});
         BOOST_CHECK_EQUAL(111, GetTime()); // Deprecated time getter
         BOOST_CHECK_EQUAL(111, GetTime<std::chrono::seconds>().count());
         BOOST_CHECK_EQUAL(111000, GetTime<std::chrono::milliseconds>().count());
@@ -1333,7 +1333,7 @@ BOOST_AUTO_TEST_CASE(util_time_GetTime)
     // Check that system time changes after a sleep
     const auto ms_0 = GetTime<std::chrono::milliseconds>();
     const auto us_0 = GetTime<std::chrono::microseconds>();
-    MilliSleep(1);
+    UninterruptibleSleep(std::chrono::milliseconds{1});
     BOOST_CHECK(ms_0 < GetTime<std::chrono::milliseconds>());
     BOOST_CHECK(us_0 < GetTime<std::chrono::microseconds>());
 }
diff --git a/src/test/validation_block_tests.cpp b/src/test/validation_block_tests.cpp
@@ -205,7 +205,7 @@ BOOST_AUTO_TEST_CASE(processnewblock_signals_ordering)
         t.join();
     }
     while (GetMainSignals().CallbacksPending() > 0) {
-        MilliSleep(100);
+        UninterruptibleSleep(std::chrono::milliseconds{100});
     }
 
     UnregisterValidationInterface(&sub);
diff --git a/src/wallet/db.cpp b/src/wallet/db.cpp
@@ -756,7 +756,7 @@ bool BerkeleyBatch::Rewrite(BerkeleyDatabase& database, const char* pszSkip)
                 return fSuccess;
             }
         }
-        MilliSleep(100);
+        UninterruptibleSleep(std::chrono::milliseconds{100});
     }
 }
 
@@ -887,7 +887,7 @@ bool BerkeleyDatabase::Backup(const std::string& strDest)
                 }
             }
         }
-        MilliSleep(100);
+        UninterruptibleSleep(std::chrono::milliseconds{100});
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`static void Sleep100ms(benchmark::State& state)`
`11`	`11`	`{`
`12`	`12`	`while (state.KeepRunning()) {`
`13`		`- MilliSleep(100);`
	`13`	`+ UninterruptibleSleep(std::chrono::milliseconds{100});`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -524,7 +524,7 @@ static int CommandLineRPC(int argc, char *argv[])`
`524`	`524`	`}`
`525`	`525`	`catch (const CConnectionFailed&) {`
`526`	`526`	`if (fWait)`
`527`		`- MilliSleep(1000);`
	`527`	`+ UninterruptibleSleep(std::chrono::milliseconds{1000});`
`528`	`528`	`else`
`529`	`529`	`throw;`
`530`	`530`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ static void WaitForShutdown(NodeContext& node)`
`29`	`29`	`{`
`30`	`30`	`while (!ShutdownRequested())`
`31`	`31`	`{`
`32`		`- MilliSleep(200);`
	`32`	`+ UninterruptibleSleep(std::chrono::milliseconds{200});`
`33`	`33`	`}`
`34`	`34`	`Interrupt(node);`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ UniValue stop(const JSONRPCRequest& jsonRequest)`
`169`	`169`	`// this reply will get back to the client.`
`170`	`170`	`StartShutdown();`
`171`	`171`	`if (jsonRequest.params[0].isNum()) {`
`172`		`- MilliSleep(jsonRequest.params[0].get_int());`
	`172`	`+ UninterruptibleSleep(std::chrono::milliseconds{jsonRequest.params[0].get_int()});`
`173`	`173`	`}`
`174`	`174`	`return PACKAGE_NAME " stopping";`
`175`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ BOOST_FIXTURE_TEST_CASE(blockfilter_index_initial_sync, BuildChainTestingSetup)`
`138`	`138`	`int64_t time_start = GetTimeMillis();`
`139`	`139`	`while (!filter_index.BlockUntilSyncedToCurrentChain()) {`
`140`	`140`	`BOOST_REQUIRE(time_start + timeout_ms > GetTimeMillis());`
`141`		`- MilliSleep(100);`
	`141`	`+ UninterruptibleSleep(std::chrono::milliseconds{100});`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`// Check that filter index has all blocks that were in the chain before it started.`
Original file line number	Diff line number	Diff line change
`@@ -393,7 +393,7 @@ BOOST_AUTO_TEST_CASE(test_CheckQueueControl_Locks)`
`393`	`393`	`CCheckQueueControl<FakeCheck> control(queue.get());`
`394`	`394`	`// While sleeping, no other thread should execute to this point`
`395`	`395`	`auto observed = ++nThreads;`
`396`		`- MilliSleep(10);`
	`396`	`+ UninterruptibleSleep(std::chrono::milliseconds{10});`
`397`	`397`	`fails += observed != nThreads;`
`398`	`398`	`});`
`399`	`399`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ BOOST_FIXTURE_TEST_CASE(txindex_initial_sync, TestChain100Setup)`
`34`	`34`	`int64_t time_start = GetTimeMillis();`
`35`	`35`	`while (!txindex.BlockUntilSyncedToCurrentChain()) {`
`36`	`36`	`BOOST_REQUIRE(time_start + timeout_ms > GetTimeMillis());`
`37`		`- MilliSleep(100);`
	`37`	`+ UninterruptibleSleep(std::chrono::milliseconds{100});`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`// Check that txindex excludes genesis block transactions.`
Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ BOOST_AUTO_TEST_CASE(processnewblock_signals_ordering)`
`205`	`205`	`t.join();`
`206`	`206`	`}`
`207`	`207`	`while (GetMainSignals().CallbacksPending() > 0) {`
`208`		`- MilliSleep(100);`
	`208`	`+ UninterruptibleSleep(std::chrono::milliseconds{100});`
`209`	`209`	`}`
`210`	`210`
`211`	`211`	`UnregisterValidationInterface(&sub);`