ATOM-15358 : Culling concurrency checker fails in AtomSampleViewer (merge from 1.0->main)

Inserting, updating, and removing entries from a VisibilityScene was made thread safe in a previous change, and now both the MeshFeatureProcessor and DiffuseProbeGridFeatureProcessor update entries at the same time from multiple threads. This leads to an assert in the Culling concurrency_checker, even though this is now valid behavior. However, we still don't want to be adding, removing, or updating cullables between BeginCulling and EndCulling, which could cause a mismatch between the result of OctreeScene::GetEntryCount and the actual number of cullables in the scene. -Added soft_lock_shared/soft_unlock_shared to the concurrency checker to allow multiple threads to acquire a lock when that is the desired behavior, while still asserting that nothing tries to acquire a shared lock when the concurrency checker is already locked. -Update Culling.cpp to use the new soft_lock_shared when adding, updating, or removing cullables -Added unit tests for the concurrency_checker -Updated ArrayView unit test to use AZ_TEST_START_TRACE_SUPPRESSION instead of manually checking the assertion count, so that test now passes in release builds which do not assert.
2021-05-18 10:53:41 -07:00
parent 343fc1999f
commit d0810892f1
4 changed files with 125 additions and 7 deletions
@@ -0,0 +1,100 @@
+/*
+* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+* its licensors.
+*
+* For complete copyright and license terms please see the LICENSE at the root of this
+* distribution (the "License"). All use of this software is governed by the License,
+* or, if provided, by the license below or the license accompanying this file. Do not
+* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*
+*/
+
+#include <AtomCore/std/parallel/concurrency_checker.h>
+
+#include <AzCore/UnitTest/TestTypes.h>
+
+using namespace AZStd;
+
+namespace UnitTest
+{
+    class ConcurrencyCheckerTestFixture
+        : public AllocatorsTestFixture
+    {
+
+        void SetUp() override
+        {
+            AllocatorsFixture::SetUp();
+        }
+    };
+
+    TEST_F(AllocatorsTestFixture, SoftLock_NoContention_NoAsserts)
+    {
+        concurrency_checker concurrencyChecker;
+        concurrencyChecker.soft_lock();
+        concurrencyChecker.soft_unlock();
+        concurrencyChecker.soft_lock();
+        concurrencyChecker.soft_unlock();
+    }
+
+    TEST_F(AllocatorsTestFixture, SoftLock_AlreadyLocked_Assert)
+    {
+        concurrency_checker concurrencyChecker;
+        concurrencyChecker.soft_lock();
+        AZ_TEST_START_TRACE_SUPPRESSION;
+        concurrencyChecker.soft_lock();
+        AZ_TEST_STOP_TRACE_SUPPRESSION(1);
+    }
+
+    TEST_F(AllocatorsTestFixture, SoftUnlock_NotAlreadyLocked_Assert)
+    {
+        concurrency_checker concurrencyChecker;
+        concurrencyChecker.soft_lock();
+        concurrencyChecker.soft_unlock();
+        AZ_TEST_START_TRACE_SUPPRESSION;
+        concurrencyChecker.soft_unlock();
+        AZ_TEST_STOP_TRACE_SUPPRESSION(1);
+    }
+
+    TEST_F(AllocatorsTestFixture, SoftLockShared_NoContention_NoAsserts)
+    {
+        concurrency_checker concurrencyChecker;
+        // Multiple shared locks can be made at once,
+        // as long as they are all unlocked before the next soft_lock
+        concurrencyChecker.soft_lock_shared();
+        concurrencyChecker.soft_lock_shared();
+        concurrencyChecker.soft_unlock_shared();
+        concurrencyChecker.soft_unlock_shared();
+
+        concurrencyChecker.soft_lock();
+        concurrencyChecker.soft_unlock();
+
+        concurrencyChecker.soft_lock_shared();
+        concurrencyChecker.soft_lock_shared();
+        concurrencyChecker.soft_unlock_shared();
+        concurrencyChecker.soft_unlock_shared();
+
+        concurrencyChecker.soft_lock();
+        concurrencyChecker.soft_unlock();
+    }
+
+    TEST_F(AllocatorsTestFixture, SoftLockShared_SharedLockAfterSoftLock_Assert)
+    {
+        concurrency_checker concurrencyChecker;
+
+        concurrencyChecker.soft_lock();
+        AZ_TEST_START_TRACE_SUPPRESSION;
+        concurrencyChecker.soft_lock_shared();
+        AZ_TEST_STOP_TRACE_SUPPRESSION(1);
+    }
+
+    TEST_F(AllocatorsTestFixture, SoftUnlockShared_NotAlreadyLocked_Assert)
+    {
+        concurrency_checker concurrencyChecker;
+        concurrencyChecker.soft_lock_shared();
+        concurrencyChecker.soft_unlock_shared();
+        AZ_TEST_START_TRACE_SUPPRESSION;
+        concurrencyChecker.soft_unlock_shared();
+        AZ_TEST_STOP_TRACE_SUPPRESSION(1);
+    }
+}