Fix folder_change_reader_state destructor hang. (#386)

* Fix folder_change_reader_state destructor hang. If there is no pending operation, CancelIoEx returns an error and GetOverlappedResult hangs. * fix indentation. * Added test to demonstrate fixing the hang issue. Delete the monitored directory during the notification. * rewrote tests. add a small delay to better control the bug timing. * code review changes --------- Co-authored-by: Razvan Pricope <rpricope@bitdefender.com>
microsoft · Dec 8, 2023 · 0fdb072 · 0fdb072
1 parent 5cbb589
commit 0fdb072
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 4 deletions.
diff --git a/include/wil/filesystem.h b/include/wil/filesystem.h
@@ -624,10 +624,15 @@ namespace wil
 
                     if (m_folderHandle)
                     {
-                        CancelIoEx(m_folderHandle.get(), &m_overlapped);
+                        BOOL cancelRes = CancelIoEx(m_folderHandle.get(), &m_overlapped);
 
-                        DWORD bytesTransferredIgnored = 0;
-                        GetOverlappedResult(m_folderHandle.get(), &m_overlapped, &bytesTransferredIgnored, TRUE);
+                        // no pending operation to cancel. Maybe StartIo returned 
+                        // an error?
+                        if (!(cancelRes == FALSE && ::GetLastError() == ERROR_NOT_FOUND)) 
+                        {
+                            DWORD bytesTransferredIgnored = 0;
+                            GetOverlappedResult(m_folderHandle.get(), &m_overlapped, &bytesTransferredIgnored, TRUE);
+                        }
                     }
 
                     // Wait for callbacks to complete.

diff --git a/tests/FileSystemTests.cpp b/tests/FileSystemTests.cpp
@@ -5,6 +5,7 @@
 #include <wil/common.h>
 #ifdef WIL_ENABLE_EXCEPTIONS
 #include <string>
+#include <thread>
 #endif
 
 // TODO: str_raw_ptr is not two-phase name lookup clean (https://github.com/Microsoft/wil/issues/8)
@@ -16,6 +17,7 @@ namespace wil
 #endif
 }
 
+#include <wil/resource.h>
 #include <wil/filesystem.h>
 
 #ifdef WIL_ENABLE_EXCEPTIONS
@@ -772,7 +774,61 @@ TEST_CASE("FileSystemTests::CreateFileW helpers", "[filesystem]")
     }
 }
 
-#endif
+TEST_CASE("FileSystemTest::FolderChangeReader destructor does not hang", "[filesystem]")
+{
+    wil::unique_cotaskmem_string testRootTmp;
+    REQUIRE_SUCCEEDED(wil::ExpandEnvironmentStringsW(L"%TEMP%\\wil_test_filesystem", testRootTmp));
+    std::wstring testRootDir = testRootTmp.get();
+    std::wstring testFile = testRootDir + L"\\test.dat";
+    bool deleteDir = false;
+    wil::unique_event opCompletedEv(wil::EventOptions::None);
+    wil::unique_event readerDestructNotify(wil::EventOptions::ManualReset);
+    HANDLE readerDestructNotifyRaw = readerDestructNotify.get();
+
+    REQUIRE_FALSE(DirectoryExists(testRootDir.c_str()));
+    REQUIRE_SUCCEEDED(wil::CreateDirectoryDeepNoThrow(testRootDir.c_str()));
+    REQUIRE(DirectoryExists(testRootDir.c_str()));
+
+    /**
+     * Move the operation to a new thread. 
+     * The destructor of unique_folder_change_reader might hang. If this happens, 
+     * we want to report an test error instead of hanging forever. 
+     * Initialize the reader in current thread to make sure there is no race condition with test 
+     * creating files
+     */
+    auto reader = wil::make_folder_change_reader_nothrow(testRootDir.c_str(), false, wil::FolderChangeEvents::All,
+    [&](wil::FolderChangeEvent, PCWSTR)
+    {
+        if (deleteDir)
+            RemoveDirectoryW(testRootDir.c_str());
 
+        opCompletedEv.SetEvent();
+    });
+    auto readerThread = std::thread([rdn = std::move(readerDestructNotify), r = std::move(reader)]() mutable {
+        rdn.wait(INFINITE);
+    });
+
+    wil::unique_hfile testFileOut(::CreateFileW(testFile.c_str(), GENERIC_ALL,
+        FILE_SHARE_READ, nullptr, CREATE_ALWAYS, 0, nullptr));
+    REQUIRE(testFileOut);
+    testFileOut.reset();
+    opCompletedEv.wait(INFINITE);
+
+    deleteDir = true;
+    REQUIRE(DeleteFileW(testFile.c_str()));
+    opCompletedEv.wait(INFINITE);
+    std::this_thread::sleep_for(std::chrono::seconds(1)); //enough time for the StartIO call to fail
+
+    SetEvent(readerDestructNotifyRaw);
+    DWORD waitResult = WaitForSingleObject(readerThread.native_handle(), 30 * 1000);
+    if (waitResult != WAIT_OBJECT_0)
+        readerThread.detach();
+    else
+        readerThread.join();
+
+    REQUIRE(waitResult == WAIT_OBJECT_0);
+}
+
+#endif
 
 #endif // WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)