aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/common/include/WriteCheck.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /APEX_1.4/common/include/WriteCheck.h
downloadphysx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz
physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip
Initial commit:
PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167]
Diffstat (limited to 'APEX_1.4/common/include/WriteCheck.h')
-rw-r--r--APEX_1.4/common/include/WriteCheck.h65
1 files changed, 65 insertions, 0 deletions
diff --git a/APEX_1.4/common/include/WriteCheck.h b/APEX_1.4/common/include/WriteCheck.h
new file mode 100644
index 00000000..23710813
--- /dev/null
+++ b/APEX_1.4/common/include/WriteCheck.h
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2008-2015, NVIDIA CORPORATION. All rights reserved.
+ *
+ * NVIDIA CORPORATION and its licensors retain all intellectual property
+ * and proprietary rights in and to this software, related documentation
+ * and any modifications thereto. Any use, reproduction, disclosure or
+ * distribution of this software and related documentation without an express
+ * license agreement from NVIDIA CORPORATION is strictly prohibited.
+ */
+
+// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+
+
+#ifndef WRITE_CHECK_H
+#define WRITE_CHECK_H
+
+#include "PxSimpleTypes.h"
+#include "ApexUsingNamespace.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+class ApexRWLockable;
+
+// RAII wrapper around the Scene::startWrite() method, note that this
+// object does not acquire any scene locks, it is an error checking only mechanism
+class WriteCheck
+{
+public:
+ WriteCheck(ApexRWLockable* scene, const char* functionName, bool allowReentry=true);
+ ~WriteCheck();
+
+private:
+ ApexRWLockable* mLockable;
+ const char* mName;
+ bool mAllowReentry;
+ uint32_t mErrorCount;
+};
+
+#if PX_DEBUG || PX_CHECKED
+ // Creates a scoped write check object that detects whether appropriate scene locks
+ // have been acquired and checks if reads/writes overlap, this macro should typically
+ // be placed at the beginning of any non-const API methods that are not multi-thread safe.
+ // By default re-entrant write calls by the same thread are allowed, the error conditions
+ // checked can be summarized as:
+
+ // 1. Other threads were already reading, or began reading during the object lifetime
+ // 2. Other threads were already writing, or began writing during the object lifetime
+ #define WRITE_ZONE() WriteCheck __writeCheck(static_cast<ApexRWLockable*>(this), __FUNCTION__);
+
+ // Creates a scoped write check object that disallows re-entrant writes, this is used by
+ // the Scene::simulate method to detect when callbacks make write calls to the API
+ #define WRITE_ZONE_NOREENTRY() WriteCheck __writeCheck(static_cast<ApexRWLockable*>(this), __FUNCTION__, false);
+#else
+ #define WRITE_ZONE()
+ #define WRITE_ZONE_NOREENTRY()
+#endif
+
+}
+}
+
+#endif // WRITE_CHECK_H