Reduce a chance to have a deadlock in the AsyncNavMeshUpdater

* Do not fail tile generation if debug mesh writing fails.
* Mark some functions as noexcept to better crash than have a deadlock.
* Unlock tile and remove job if there on exception while processing it.

apps/components_tests/detournavigator/asyncnavmeshupdater.cpp

@@ -5,7 +5,9 @@
 #include <components/detournavigator/makenavmesh.hpp>
 #include <components/detournavigator/navmeshdbutils.hpp>
 #include <components/detournavigator/serialization.hpp>
+#include <components/files/conversion.hpp>
 #include <components/loadinglistener/loadinglistener.hpp>
+#include <components/testing/util.hpp>
 
 #include <BulletCollision/CollisionShapes/btBoxShape.h>
 
@@ -372,6 +374,106 @@ namespace
         }
     }
 
+    TEST_F(DetourNavigatorAsyncNavMeshUpdaterTest, should_write_debug_recast_mesh)
+    {
+        mRecastMeshManager.setWorldspace(mWorldspace, nullptr);
+        addHeightFieldPlane(mRecastMeshManager);
+        mSettings.mEnableWriteRecastMeshToFile = true;
+        const std::filesystem::path dir = TestingOpenMW::outputDirPath("DetourNavigatorAsyncNavMeshUpdaterTest");
+        mSettings.mRecastMeshPathPrefix = Files::pathToUnicodeString(dir) + "/";
+        Log(Debug::Verbose) << mSettings.mRecastMeshPathPrefix;
+        AsyncNavMeshUpdater updater(mSettings, mRecastMeshManager, mOffMeshConnectionsManager, nullptr);
+        const auto navMeshCacheItem = std::make_shared<GuardedNavMeshCacheItem>(1, mSettings);
+        const std::map<TilePosition, ChangeType> changedTiles{ { TilePosition{ 0, 0 }, ChangeType::add } };
+        updater.post(mAgentBounds, navMeshCacheItem, mPlayerTile, mWorldspace, changedTiles);
+        updater.wait(WaitConditionType::allJobsDone, &mListener);
+        EXPECT_TRUE(std::filesystem::exists(dir / "0.0.recastmesh.obj"));
+    }
+
+    TEST_F(DetourNavigatorAsyncNavMeshUpdaterTest, should_write_debug_recast_mesh_with_revision)
+    {
+        mRecastMeshManager.setWorldspace(mWorldspace, nullptr);
+        addHeightFieldPlane(mRecastMeshManager);
+        mSettings.mEnableWriteRecastMeshToFile = true;
+        mSettings.mEnableRecastMeshFileNameRevision = true;
+        const std::filesystem::path dir = TestingOpenMW::outputDirPath("DetourNavigatorAsyncNavMeshUpdaterTest");
+        mSettings.mRecastMeshPathPrefix = Files::pathToUnicodeString(dir) + "/";
+        Log(Debug::Verbose) << mSettings.mRecastMeshPathPrefix;
+        AsyncNavMeshUpdater updater(mSettings, mRecastMeshManager, mOffMeshConnectionsManager, nullptr);
+        const auto navMeshCacheItem = std::make_shared<GuardedNavMeshCacheItem>(1, mSettings);
+        const std::map<TilePosition, ChangeType> changedTiles{ { TilePosition{ 0, 0 }, ChangeType::add } };
+        updater.post(mAgentBounds, navMeshCacheItem, mPlayerTile, mWorldspace, changedTiles);
+        updater.wait(WaitConditionType::allJobsDone, &mListener);
+        EXPECT_TRUE(std::filesystem::exists(dir / "0.0.recastmesh.1.2.obj"));
+    }
+
+    TEST_F(DetourNavigatorAsyncNavMeshUpdaterTest, writing_recast_mesh_to_absent_file_should_not_fail_tile_generation)
+    {
+        mRecastMeshManager.setWorldspace(mWorldspace, nullptr);
+        addHeightFieldPlane(mRecastMeshManager);
+        mSettings.mEnableWriteRecastMeshToFile = true;
+        const std::filesystem::path dir = TestingOpenMW::outputDir() / "absent";
+        mSettings.mRecastMeshPathPrefix = Files::pathToUnicodeString(dir) + "/";
+        Log(Debug::Verbose) << mSettings.mRecastMeshPathPrefix;
+        AsyncNavMeshUpdater updater(mSettings, mRecastMeshManager, mOffMeshConnectionsManager, nullptr);
+        const auto navMeshCacheItem = std::make_shared<GuardedNavMeshCacheItem>(1, mSettings);
+        const std::map<TilePosition, ChangeType> changedTiles{ { TilePosition{ 0, 0 }, ChangeType::add } };
+        updater.post(mAgentBounds, navMeshCacheItem, mPlayerTile, mWorldspace, changedTiles);
+        updater.wait(WaitConditionType::allJobsDone, &mListener);
+        EXPECT_NE(navMeshCacheItem->lockConst()->getImpl().getTileRefAt(0, 0, 0), 0u);
+        EXPECT_FALSE(std::filesystem::exists(dir));
+    }
+
+    TEST_F(DetourNavigatorAsyncNavMeshUpdaterTest, should_write_debug_navmesh)
+    {
+        mRecastMeshManager.setWorldspace(mWorldspace, nullptr);
+        addHeightFieldPlane(mRecastMeshManager);
+        mSettings.mEnableWriteNavMeshToFile = true;
+        const std::filesystem::path dir = TestingOpenMW::outputDirPath("DetourNavigatorAsyncNavMeshUpdaterTest");
+        mSettings.mNavMeshPathPrefix = Files::pathToUnicodeString(dir) + "/";
+        Log(Debug::Verbose) << mSettings.mRecastMeshPathPrefix;
+        AsyncNavMeshUpdater updater(mSettings, mRecastMeshManager, mOffMeshConnectionsManager, nullptr);
+        const auto navMeshCacheItem = std::make_shared<GuardedNavMeshCacheItem>(1, mSettings);
+        const std::map<TilePosition, ChangeType> changedTiles{ { TilePosition{ 0, 0 }, ChangeType::add } };
+        updater.post(mAgentBounds, navMeshCacheItem, mPlayerTile, mWorldspace, changedTiles);
+        updater.wait(WaitConditionType::allJobsDone, &mListener);
+        EXPECT_TRUE(std::filesystem::exists(dir / "all_tiles_navmesh.bin"));
+    }
+
+    TEST_F(DetourNavigatorAsyncNavMeshUpdaterTest, should_write_debug_navmesh_with_revision)
+    {
+        mRecastMeshManager.setWorldspace(mWorldspace, nullptr);
+        addHeightFieldPlane(mRecastMeshManager);
+        mSettings.mEnableWriteNavMeshToFile = true;
+        mSettings.mEnableNavMeshFileNameRevision = true;
+        const std::filesystem::path dir = TestingOpenMW::outputDirPath("DetourNavigatorAsyncNavMeshUpdaterTest");
+        mSettings.mNavMeshPathPrefix = Files::pathToUnicodeString(dir) + "/";
+        Log(Debug::Verbose) << mSettings.mRecastMeshPathPrefix;
+        AsyncNavMeshUpdater updater(mSettings, mRecastMeshManager, mOffMeshConnectionsManager, nullptr);
+        const auto navMeshCacheItem = std::make_shared<GuardedNavMeshCacheItem>(1, mSettings);
+        const std::map<TilePosition, ChangeType> changedTiles{ { TilePosition{ 0, 0 }, ChangeType::add } };
+        updater.post(mAgentBounds, navMeshCacheItem, mPlayerTile, mWorldspace, changedTiles);
+        updater.wait(WaitConditionType::allJobsDone, &mListener);
+        EXPECT_TRUE(std::filesystem::exists(dir / "all_tiles_navmesh.1.1.bin"));
+    }
+
+    TEST_F(DetourNavigatorAsyncNavMeshUpdaterTest, writing_navmesh_to_absent_file_should_not_fail_tile_generation)
+    {
+        mRecastMeshManager.setWorldspace(mWorldspace, nullptr);
+        addHeightFieldPlane(mRecastMeshManager);
+        mSettings.mEnableWriteNavMeshToFile = true;
+        const std::filesystem::path dir = TestingOpenMW::outputDir() / "absent";
+        mSettings.mNavMeshPathPrefix = Files::pathToUnicodeString(dir) + "/";
+        Log(Debug::Verbose) << mSettings.mRecastMeshPathPrefix;
+        AsyncNavMeshUpdater updater(mSettings, mRecastMeshManager, mOffMeshConnectionsManager, nullptr);
+        const auto navMeshCacheItem = std::make_shared<GuardedNavMeshCacheItem>(1, mSettings);
+        const std::map<TilePosition, ChangeType> changedTiles{ { TilePosition{ 0, 0 }, ChangeType::add } };
+        updater.post(mAgentBounds, navMeshCacheItem, mPlayerTile, mWorldspace, changedTiles);
+        updater.wait(WaitConditionType::allJobsDone, &mListener);
+        EXPECT_NE(navMeshCacheItem->lockConst()->getImpl().getTileRefAt(0, 0, 0), 0u);
+        EXPECT_FALSE(std::filesystem::exists(dir));
+    }
+
     struct DetourNavigatorSpatialJobQueueTest : Test
     {
         const AgentBounds mAgentBounds{ CollisionShapeType::Aabb, osg::Vec3f(1, 1, 1) };

components/detournavigator/asyncnavmeshupdater.cpp

@@ -452,10 +452,10 @@ namespace DetourNavigator
         Log(Debug::Debug) << "Start process navigator jobs by thread=" << std::this_thread::get_id();
         Misc::setCurrentThreadIdlePriority();
         while (!mShouldStop)
-        {
-            try
         {
             if (JobIt job = getNextJob(); job != mJobs.end())
+            {
+                try
                 {
                     const JobStatus status = processJob(*job);
                     Log(Debug::Debug) << "Processed job " << job->mId << " with status=" << status
@@ -480,12 +480,20 @@ namespace DetourNavigator
                         }
                     }
                 }
-                else
-                    cleanupLastUpdates();
-            }
                 catch (const std::exception& e)
                 {
-                Log(Debug::Error) << "AsyncNavMeshUpdater::process exception: " << e.what();
+                    Log(Debug::Warning) << "Failed to process navmesh job " << job->mId
+                                        << " for worldspace=" << job->mWorldspace << " agent=" << job->mAgentBounds
+                                        << " changedTile=(" << job->mChangedTile << ")"
+                                        << " changeType=" << job->mChangeType
+                                        << " by thread=" << std::this_thread::get_id() << ": " << e.what();
+                    unlockTile(job->mId, job->mAgentBounds, job->mChangedTile);
+                    removeJob(job);
+                }
+            }
+            else
+            {
+                cleanupLastUpdates();
             }
         }
         Log(Debug::Debug) << "Stop navigator jobs processing by thread=" << std::this_thread::get_id();
@@ -493,7 +501,8 @@ namespace DetourNavigator
 
     JobStatus AsyncNavMeshUpdater::processJob(Job& job)
     {
-        Log(Debug::Debug) << "Processing job " << job.mId << " for agent=(" << job.mAgentBounds << ")"
+        Log(Debug::Debug) << "Processing job " << job.mId << "  for worldspace=" << job.mWorldspace
+                          << " agent=" << job.mAgentBounds << ""
                           << " changedTile=(" << job.mChangedTile << ")"
                           << " changeType=" << job.mChangeType << " by thread=" << std::this_thread::get_id();
 
@@ -543,7 +552,14 @@ namespace DetourNavigator
             return JobStatus::Done;
         }
 
+        try
+        {
             writeDebugRecastMesh(mSettings, job.mChangedTile, *recastMesh);
+        }
+        catch (const std::exception& e)
+        {
+            Log(Debug::Warning) << "Failed to write debug recast mesh: " << e.what();
+        }
 
         NavMeshTilesCache::Value cachedNavMeshData
             = mNavMeshTilesCache.get(job.mAgentBounds, job.mChangedTile, *recastMesh);
@@ -666,12 +682,19 @@ namespace DetourNavigator
             mPresentTiles.insert(std::make_tuple(job.mAgentBounds, job.mChangedTile));
         }
 
+        try
+        {
             writeDebugNavMesh(mSettings, navMeshCacheItem, navMeshVersion);
+        }
+        catch (const std::exception& e)
+        {
+            Log(Debug::Warning) << "Failed to write debug navmesh: " << e.what();
+        }
 
         return isSuccess(status) ? JobStatus::Done : JobStatus::Fail;
     }
 
-    JobIt AsyncNavMeshUpdater::getNextJob()
+    JobIt AsyncNavMeshUpdater::getNextJob() noexcept
     {
         std::unique_lock<std::mutex> lock(mMutex);
 
@@ -746,7 +769,7 @@ namespace DetourNavigator
         return mJobs.size();
     }
 
-    void AsyncNavMeshUpdater::cleanupLastUpdates()
+    void AsyncNavMeshUpdater::cleanupLastUpdates() noexcept
     {
         const auto now = std::chrono::steady_clock::now();
 

components/detournavigator/asyncnavmeshupdater.hpp

@@ -244,7 +244,7 @@ namespace DetourNavigator
         inline JobStatus handleUpdateNavMeshStatus(UpdateNavMeshStatus status, const Job& job,
             const GuardedNavMeshCacheItem& navMeshCacheItem, const RecastMesh& recastMesh);
 
-        JobIt getNextJob();
+        inline JobIt getNextJob() noexcept;
 
         void postThreadJob(JobIt job, std::deque<JobIt>& queue);
 
@@ -254,7 +254,7 @@ namespace DetourNavigator
 
         inline std::size_t getTotalJobs() const;
 
-        void cleanupLastUpdates();
+        inline void cleanupLastUpdates() noexcept;
 
         inline void waitUntilJobsDoneForNotPresentTiles(Loading::Listener* listener);