Changeset 81590 in vbox for trunk/include

Timestamp:

Oct 30, 2019 2:13:37 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

134345

Message:

pdmdev.h: Adding type-safer PDMDEVINS_2_DATA and PDMDEVINS_2_DATA_CC macros that replaces PDMINS_2_DATA and PDMINS_2_DATA_CC for device instances. On modern compilers these macros will check the size type against the size in the device registration structure, though only in strict builds of course. bugref:9218

Location:

trunk/include/VBox/vmm

Files:

• pdmdev.h (modified) (1 diff)
• pdmins.h (modified) (2 diffs)

trunk/include/VBox/vmm/pdmdev.h

@@ -5725 +5725 @@
 
 
+/** @def PDMDEVINS_2_DATA
+ * This is a safer edition of PDMINS_2_DATA that checks that the size of the
+ * target type is same as PDMDEVREG::cbInstanceShared in strict builds.
+ *
+ * @note Do no use this macro in common code working on a core structure which
+ *       device specific code has expanded.
+ */
+#if defined(VBOX_STRICT) && defined(RT_COMPILER_SUPPORTS_LAMBDA)
+# define PDMDEVINS_2_DATA(a_pDevIns, a_PtrType)  \
+    ([](PPDMDEVINS a_pLambdaDevIns) -> a_PtrType \
+    { \
+        a_PtrType pLambdaRet = (a_PtrType)(a_pLambdaDevIns)->CTX_SUFF(pvInstanceData); \
+        Assert(sizeof(*pLambdaRet) == a_pLambdaDevIns->pReg->cbInstanceShared); \
+        return pLambdaRet; \
+    }(a_pDevIns))
+#else
+# define PDMDEVINS_2_DATA(a_pDevIns, a_PtrType)  ( (a_PtrType)(a_pDevIns)->CTX_SUFF(pvInstanceData) )
+#endif
+
+/** @def PDMDEVINS_2_DATA_CC
+ * This is a safer edition of PDMINS_2_DATA_CC that checks that the size of the
+ * target type is same as PDMDEVREG::cbInstanceCC in strict builds.
+ *
+ * @note Do no use this macro in common code working on a core structure which
+ *       device specific code has expanded.
+ */
+#if defined(VBOX_STRICT) && defined(RT_COMPILER_SUPPORTS_LAMBDA)
+# define PDMDEVINS_2_DATA_CC(a_pDevIns, a_PtrType)  \
+    ([](PPDMDEVINS a_pLambdaDevIns) -> a_PtrType \
+    { \
+        a_PtrType pLambdaRet = (a_PtrType)&(a_pLambdaDevIns)->achInstanceData[0]; \
+        Assert(sizeof(*pLambdaRet) == a_pLambdaDevIns->pReg->cbInstanceCC); \
+        return pLambdaRet; \
+    }(a_pDevIns))
+#else
+# define PDMDEVINS_2_DATA_CC(a_pDevIns, a_PtrType)  ( (a_PtrType)(void *)&(a_pDevIns)->achInstanceData[0] )
+#endif
+
+
 #ifdef IN_RING3
 

trunk/include/VBox/vmm/pdmins.h

@@ -51 +51 @@
 /** @def PDMINS_2_DATA
  * Gets the shared instance data for a PDM device, USB device, or driver instance.
+ * @note For devices using PDMDEVINS_2_DATA is highly recommended.
  */
 #define PDMINS_2_DATA(pIns, type)       ( (type)(pIns)->CTX_SUFF(pvInstanceData) )
@@ -56 +57 @@
 /** @def PDMINS_2_DATA_CC
  * Gets the current context instance data for a PDM device, USB device, or driver instance.
+ * @note For devices using PDMDEVINS_2_DATA_CC is highly recommended.
  */
 #define PDMINS_2_DATA_CC(pIns, type)    ( (type)(void *)&(pIns)->achInstanceData[0] )