Changeset 90433 in vbox

Timestamp:

Jul 30, 2021 3:48:09 PM (4 years ago)

Author:

vboxsync

Message:

VMM/PDMCritSectEnter: Added macros for correctly asserting on successfull PDMCritSectEnter calls when rcBusy is VINF_SUCCESS or the caller can't return an error. Makes it easier to spot these compared to generic AssertReleaseRC. bugref:6695

Location:

trunk

Files:

• include/VBox/vmm/pdmcritsect.h (modified) (1 diff)
• include/VBox/vmm/pdmdev.h (modified) (1 diff)
• src/VBox/VMM/VMMAll/PDMAllCritSect.cpp (modified) (1 diff)

trunk/include/VBox/vmm/pdmcritsect.h

@@ -99 +99 @@
 #endif
 
+/** @def PDM_CRITSECT_RELEASE_ASSERT_RC
+ * Helper for PDMCritSectEnter w/ rcBusy VINF_SUCCESS when there is no way
+ * to forward failures to the caller. */
+#define PDM_CRITSECT_RELEASE_ASSERT_RC(a_pVM, a_pCritSect, a_rc) \
+    AssertReleaseMsg(RT_SUCCESS(a_rc), ("pVM=%p pCritSect=%p: %Rrc\n", (a_pVM), (a_pCritSect), (a_rc))
+
+/** @def PDM_CRITSECT_RELEASE_ASSERT_RC_DEV
+ * Helper for PDMCritSectEnter w/ rcBusy VINF_SUCCESS when there is no way
+ * to forward failures to the caller, device edition. */
+#define PDM_CRITSECT_RELEASE_ASSERT_RC_DEV(a_pDevIns, a_pCritSect, a_rc) \
+    AssertReleaseMsg(RT_SUCCESS(a_rc), ("pDevIns=%p pCritSect=%p: %Rrc\n", (a_pDevIns), (a_pCritSect), (a_rc))
+
+/** @def PDM_CRITSECT_RELEASE_ASSERT_RC_DRV
+ * Helper for PDMCritSectEnter w/ rcBusy VINF_SUCCESS when there is no way
+ * to forward failures to the caller, driver edition. */
+#define PDM_CRITSECT_RELEASE_ASSERT_RC_DRV(a_pDevIns, a_pCritSect, a_rc) \
+    AssertReleaseMsg(RT_SUCCESS(a_rc), ("pDrvIns=%p pCritSect=%p: %Rrc\n", (a_pDrvIns), (a_pCritSect), (a_rc))
+
+/** @def PDM_CRITSECT_RELEASE_ASSERT_RC_USB
+ * Helper for PDMCritSectEnter w/ rcBusy VINF_SUCCESS when there is no way
+ * to forward failures to the caller, USB device edition. */
+#define PDM_CRITSECT_RELEASE_ASSERT_RC_USB(a_pUsbIns, a_pCritSect, a_rc) \
+    AssertReleaseMsg(RT_SUCCESS(a_rc), ("pUsbIns=%p pCritSect=%p: %Rrc\n", (a_pUsbIns), (a_pCritSect), (a_rc))
+
+
 /** @} */
 

trunk/include/VBox/vmm/pdmdev.h

@@ -7891 +7891 @@
  *
  * @note    Even callers setting @a rcBusy to VINF_SUCCESS must either handle
- *          possible failures in ring-0 or apply an AssertReleaseRC() to the
- *          return value of this function.
+ *          possible failures in ring-0 or at least apply
+ *          PDM_CRITSECT_RELEASE_ASSERT_RC_DEV() to the return value of this
+ *          function.
  *
  * @sa      PDMCritSectEnter

trunk/src/VBox/VMM/VMMAll/PDMAllCritSect.cpp

@@ -518 +518 @@
  *
  * @note    Even callers setting @a rcBusy to VINF_SUCCESS must either handle
- *          possible failures in ring-0 or apply an AssertReleaseRC() to the
- *          return value of this function.
+ *          possible failures in ring-0 or apply
+ *          PDM_CRITSECT_RELEASE_ASSERT_RC(),
+ *          PDM_CRITSECT_RELEASE_ASSERT_RC_DEV(),
+ *          PDM_CRITSECT_RELEASE_ASSERT_RC_DRV() or
+ *          PDM_CRITSECT_RELEASE_ASSERT_RC_USB() to the return value of this
+ *          function.
  */
 VMMDECL(int) PDMCritSectEnter(PVMCC pVM, PPDMCRITSECT pCritSect, int rcBusy)