Changeset 62915 in vbox for trunk

Timestamp:

Aug 3, 2016 1:59:43 PM (8 years ago)

Author:

vboxsync

Message:

IPRT/test: Added RTTestDisableAssertions and RTTestRestoreAssertions with RTTestI aliases. This simplifies the use of RTAssertSetQuiet/MayPanic by keeping the saved state in the test handle and dealing with nesting, thus reducing the code necessary when testing error paths in APIs which uses assertions.

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (4 diffs)
• include/iprt/test.h (modified) (2 diffs)
• src/VBox/Runtime/r3/test.cpp (modified) (3 diffs)
• src/VBox/Runtime/r3/testi.cpp (modified) (1 diff)

trunk/include/iprt/mangling.h

@@ -1981 +1981 @@
 # define RTTestCreateEx                                 RT_MANGLER(RTTestCreateEx)
 # define RTTestDestroy                                  RT_MANGLER(RTTestDestroy)
+# define RTTestDisableAssertions                        RT_MANGLER(RTTestDisableAssertions)
 # define RTTestErrorCount                               RT_MANGLER(RTTestErrorCount)
 # define RTTestErrorInc                                 RT_MANGLER(RTTestErrorInc)
@@ -1991 +1992 @@
 # define RTTestGuardedAllocTail                         RT_MANGLER(RTTestGuardedAllocTail)
 # define RTTestGuardedFree                              RT_MANGLER(RTTestGuardedFree)
+# define RTTestIDisableAssertions                       RT_MANGLER(RTTestIDisableAssertions)
 # define RTTestIErrorCount                              RT_MANGLER(RTTestIErrorCount)
 # define RTTestIErrorInc                                RT_MANGLER(RTTestIErrorInc)
@@ -2005 +2007 @@
 # define RTTestIPrintf                                  RT_MANGLER(RTTestIPrintf)
 # define RTTestIPrintfV                                 RT_MANGLER(RTTestIPrintfV)
+# define RTTestIRestoreAssertions                       RT_MANGLER(RTTestIRestoreAssertions)
 # define RTTestISub                                     RT_MANGLER(RTTestISub)
 # define RTTestISubDone                                 RT_MANGLER(RTTestISubDone)
@@ -2018 +2021 @@
 # define RTTestPrintfNlV                                RT_MANGLER(RTTestPrintfNlV)
 # define RTTestPrintfV                                  RT_MANGLER(RTTestPrintfV)
+# define RTTestRestoreAssertions                        RT_MANGLER(RTTestRestoreAssertions)
 # define RTTestSetDefault                               RT_MANGLER(RTTestSetDefault)
 # define RTTestSkipAndDestroy                           RT_MANGLER(RTTestSkipAndDestroy)

trunk/include/iprt/test.h

@@ -636 +636 @@
 RTR3DECL(int) RTTestFailureDetails(RTTEST hTest, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3);
 
+/**
+ * Disables and shuts up assertions.
+ *
+ * Max 8 nestings.
+ *
+ * @returns IPRT status code.
+ * @param   hTest       The test handle. If NIL_RTTEST we'll use the one
+ *                      associated with the calling thread.
+ * @sa      RTAssertSetMayPanic, RTAssertSetQuiet.
+ */
+RTR3DECL(int) RTTestDisableAssertions(RTTEST hTest);
+
+/**
+ * Restores the previous call to RTTestDisableAssertions.
+ *
+ * @returns IPRT status code.
+ * @param   hTest       The test handle. If NIL_RTTEST we'll use the one
+ *                      associated with the calling thread.
+ */
+RTR3DECL(int) RTTestRestoreAssertions(RTTEST hTest);
+
 
 /** @def RTTEST_CHECK
@@ -1092 +1113 @@
  */
 RTR3DECL(int) RTTestIFailureDetails(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
+
+/**
+ * Disables and shuts up assertions.
+ *
+ * Max 8 nestings.
+ *
+ * @returns IPRT status code.
+ * @sa      RTAssertSetMayPanic, RTAssertSetQuiet.
+ */
+RTR3DECL(int) RTTestIDisableAssertions(void);
+
+/**
+ * Restores the previous call to RTTestDisableAssertions.
+ *
+ * @returns IPRT status code.
+ */
+RTR3DECL(int) RTTestIRestoreAssertions(void);
 
 

trunk/src/VBox/Runtime/r3/test.cpp

@@ -145 +145 @@
     /** XML element stack. */
     const char         *apszXmlElements[10];
+
+    /** Number of times assertions has been disabled and quieted. */
+    uint32_t volatile   cAssertionsDisabledAndQuieted;
+    /** Saved RTAssertSetQuiet return code. */
+    bool                fAssertSavedQuiet;
+    /** Saved RTAssertSetMayPanic return code. */
+    bool                fAssertSavedMayPanic;
 } RTTESTINT;
 /** Pointer to a test instance. */
@@ -269 +276 @@
     pTest->hXmlFile         = NIL_RTFILE;
     pTest->cXmlElements     = 0;
+    pTest->cAssertionsDisabledAndQuieted = 0;
+    pTest->fAssertSavedMayPanic          = true;
+    pTest->fAssertSavedQuiet             = false;
 
     rc = RTCritSectInit(&pTest->Lock);
@@ -1761 +1771 @@
 }
 
+
+RTR3DECL(int) RTTestDisableAssertions(RTTEST hTest)
+{
+    PRTTESTINT pTest = hTest;
+    RTTEST_GET_VALID_RETURN(pTest);
+
+    uint32_t cTimes = ASMAtomicIncU32(&pTest->cAssertionsDisabledAndQuieted);
+    if (cTimes >= 2 && cTimes <= 8)
+        return VINF_SUCCESS;
+    if (cTimes > 8)
+    {
+        RTAssertSetMayPanic(pTest->fAssertSavedMayPanic);
+        RTAssertSetQuiet(pTest->fAssertSavedQuiet);
+        Assert(cTimes <= 8);
+    }
+    pTest->fAssertSavedMayPanic = RTAssertSetMayPanic(false);
+    pTest->fAssertSavedQuiet    = RTAssertSetQuiet(true);
+    return VINF_SUCCESS;
+}
+
+
+RTR3DECL(int) RTTestRestoreAssertions(RTTEST hTest)
+{
+    PRTTESTINT pTest = hTest;
+    RTTEST_GET_VALID_RETURN(pTest);
+
+    uint32_t cTimes = ASMAtomicDecU32(&pTest->cAssertionsDisabledAndQuieted);
+    if (cTimes == 0)
+    {
+        RTAssertSetMayPanic(pTest->fAssertSavedMayPanic);
+        RTAssertSetQuiet(pTest->fAssertSavedQuiet);
+    }
+    else
+        AssertStmt(cTimes < UINT32_MAX / 2, ASMAtomicIncU32(&pTest->cAssertionsDisabledAndQuieted));
+    return VINF_SUCCESS;
+}
+

trunk/src/VBox/Runtime/r3/testi.cpp

@@ -175 +175 @@
 }
 
+
+RTR3DECL(int) RTTestIDisableAssertions(void)
+{
+    return RTTestDisableAssertions(NIL_RTTEST);
+}
+
+
+RTR3DECL(int) RTTestIRestoreAssertions(void)
+{
+    return RTTestRestoreAssertions(NIL_RTTEST);
+}
+