Changeset 103622 in vbox for trunk/src/VBox/VMM/include/IEMN8veRecompiler.h

Timestamp:

Mar 1, 2024 12:42:36 AM (14 months ago)

Author:

vboxsync

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

161981

Message:

VMM/IEM: Obfuscate most variable indexes we pass around in strict builds so we easily catch register/variable index mixups. bugref:10371

File:

• trunk/src/VBox/VMM/include/IEMN8veRecompiler.h (modified) (11 diffs)

trunk/src/VBox/VMM/include/IEMN8veRecompiler.h

@@ -794 +794 @@
     /** The argument number if argument, UINT8_MAX if regular variable. */
     uint8_t             uArgNo;
-    /** If referenced, the index of the variable referencing this one, otherwise
-     *  UINT8_MAX.  A referenced variable must only be placed on the stack and
-     *  must be either kIemNativeVarKind_Stack or kIemNativeVarKind_Immediate. */
+    /** If referenced, the index (unpacked) of the variable referencing this one,
+     * otherwise UINT8_MAX.  A referenced variable must only be placed on the stack
+     * and must be either kIemNativeVarKind_Stack or kIemNativeVarKind_Immediate. */
     uint8_t             idxReferrerVar;
     /** Guest register being shadowed here, kIemNativeGstReg_End(/UINT8_MAX) if not.
@@ -809 +809 @@
         /** kIemNativeVarKind_Immediate: The immediate value. */
         uint64_t            uValue;
-        /** kIemNativeVarKind_VarRef: The index of the variable being referenced. */
+        /** kIemNativeVarKind_VarRef: The index (unpacked) of the variable being referenced. */
         uint8_t             idxRefVar;
         /** kIemNativeVarKind_GstRegRef: The guest register being referrenced. */
@@ -821 +821 @@
     } u;
 } IEMNATIVEVAR;
+/** Pointer to a variable or argument. */
+typedef IEMNATIVEVAR *PIEMNATIVEVAR;
+/** Pointer to a const variable or argument. */
+typedef IEMNATIVEVAR const *PCIEMNATIVEVAR;
 
 /** What is being kept in a host register. */
@@ -878 +882 @@
     /** What is being kept in this register. */
     IEMNATIVEWHAT   enmWhat;
-    /** Variable index if holding a variable, otherwise UINT8_MAX. */
+    /** Variable index (packed) if holding a variable, otherwise UINT8_MAX. */
     uint8_t         idxVar;
     /** Stack slot assigned by iemNativeVarSaveVolatileRegsPreHlpCall and freed
@@ -906 +910 @@
     union
     {
-        /** Index of variable arguments, UINT8_MAX if not valid. */
+        /** Index of variable (unpacked) arguments, UINT8_MAX if not valid. */
         uint8_t                 aidxArgVars[8];
         /** For more efficient resetting. */
@@ -933 +937 @@
 /** Pointer to const core state. */
 typedef IEMNATIVECORESTATE const *PCIEMNATIVECORESTATE;
+
+/** @def IEMNATIVE_VAR_IDX_UNPACK
+ * @returns Index into IEMNATIVECORESTATE::aVars.
+ * @param   a_idxVar    Variable index w/ magic (in strict builds).
+ */
+/** @def IEMNATIVE_VAR_IDX_PACK
+ * @returns Variable index w/ magic (in strict builds).
+ * @param   a_idxVar    Index into IEMNATIVECORESTATE::aVars.
+ */
+#ifdef VBOX_STRICT
+# define IEMNATIVE_VAR_IDX_UNPACK(a_idxVar) ((a_idxVar) & IEMNATIVE_VAR_IDX_MASK)
+# define IEMNATIVE_VAR_IDX_PACK(a_idxVar)   ((a_idxVar) | IEMNATIVE_VAR_IDX_MAGIC)
+# define IEMNATIVE_VAR_IDX_MAGIC            UINT8_C(0xd0)
+# define IEMNATIVE_VAR_IDX_MAGIC_MASK       UINT8_C(0xf0)
+# define IEMNATIVE_VAR_IDX_MASK             UINT8_C(0x0f)
+#else
+# define IEMNATIVE_VAR_IDX_UNPACK(a_idxVar) (a_idxVar)
+# define IEMNATIVE_VAR_IDX_PACK(a_idxVar)   (a_idxVar)
+#endif
 
 
@@ -1181 +1204 @@
                                                                             IEMNATIVEGSTREG enmGstReg);
 
-DECL_HIDDEN_THROW(uint8_t)  iemNativeRegAllocVar(PIEMRECOMPILERSTATE pReNative, uint32_t *poff, uint8_t idxVar);
 DECL_HIDDEN_THROW(uint32_t) iemNativeRegAllocArgs(PIEMRECOMPILERSTATE pReNative, uint32_t off, uint8_t cArgs);
 DECL_HIDDEN_THROW(uint8_t)  iemNativeRegAssignRc(PIEMRECOMPILERSTATE pReNative, uint8_t idxHstReg);
@@ -1260 +1282 @@
  * Checks that a variable index is valid.
  */
-#define IEMNATIVE_ASSERT_VAR_IDX(a_pReNative, a_idxVar) \
+#ifdef IEMNATIVE_VAR_IDX_MAGIC
+# define IEMNATIVE_ASSERT_VAR_IDX(a_pReNative, a_idxVar) \
+    AssertMsg(   ((a_idxVar) & IEMNATIVE_VAR_IDX_MAGIC_MASK) == IEMNATIVE_VAR_IDX_MAGIC \
+              && (unsigned)IEMNATIVE_VAR_IDX_UNPACK(a_idxVar) < RT_ELEMENTS((a_pReNative)->Core.aVars) \
+              && ((a_pReNative)->Core.bmVars & RT_BIT_32(IEMNATIVE_VAR_IDX_UNPACK(a_idxVar))), \
+              ("%s=%#x\n", #a_idxVar, a_idxVar))
+#else
+# define IEMNATIVE_ASSERT_VAR_IDX(a_pReNative, a_idxVar) \
     AssertMsg(   (unsigned)(a_idxVar) < RT_ELEMENTS((a_pReNative)->Core.aVars) \
               && ((a_pReNative)->Core.bmVars & RT_BIT_32(a_idxVar)), ("%s=%d\n", #a_idxVar, a_idxVar))
+#endif
 
 /**
@@ -1269 +1299 @@
  * This also adds a RT_NOREF of a_idxVar.
  */
-#define IEMNATIVE_ASSERT_ARG_VAR_IDX(a_pReNative, a_idxVar, a_uArgNo) do { \
+#ifdef IEMNATIVE_VAR_IDX_MAGIC
+# define IEMNATIVE_ASSERT_ARG_VAR_IDX(a_pReNative, a_idxVar, a_uArgNo) do { \
+        RT_NOREF_PV(a_idxVar); \
+        AssertMsg(   ((a_idxVar) & IEMNATIVE_VAR_IDX_MAGIC_MASK) == IEMNATIVE_VAR_IDX_MAGIC \
+                  && (unsigned)IEMNATIVE_VAR_IDX_UNPACK(a_idxVar) < RT_ELEMENTS((a_pReNative)->Core.aVars) \
+                  && ((a_pReNative)->Core.bmVars & RT_BIT_32(IEMNATIVE_VAR_IDX_UNPACK(a_idxVar))) \
+                  && (a_pReNative)->Core.aVars[IEMNATIVE_VAR_IDX_UNPACK(a_idxVar)].uArgNo == (a_uArgNo), \
+                  ("%s=%d; uArgNo=%d, expected %u\n", #a_idxVar, a_idxVar, \
+                   (a_pReNative)->Core.aVars[RT_MIN(IEMNATIVE_VAR_IDX_UNPACK(a_idxVar), \
+                                                    RT_ELEMENTS((a_pReNative)->Core.aVars)) - 1].uArgNo, \
+                   a_uArgNo)); \
+    } while (0)
+#else
+# define IEMNATIVE_ASSERT_ARG_VAR_IDX(a_pReNative, a_idxVar, a_uArgNo) do { \
         RT_NOREF_PV(a_idxVar); \
         AssertMsg(   (unsigned)(a_idxVar) < RT_ELEMENTS((a_pReNative)->Core.aVars) \
@@ -1275 +1318 @@
                   && (a_pReNative)->Core.aVars[a_idxVar].uArgNo == (a_uArgNo) \
                   , ("%s=%d; uArgNo=%d, expected %u\n", #a_idxVar, a_idxVar, \
-                     (a_pReNative)->Core.aVars[RT_MAX(a_idxVar, RT_ELEMENTS((a_pReNative)->Core.aVars)) - 1].uArgNo, a_uArgNo)); \
+                     (a_pReNative)->Core.aVars[RT_MIN(a_idxVar, RT_ELEMENTS((a_pReNative)->Core.aVars)) - 1].uArgNo, a_uArgNo)); \
     } while (0)
+#endif
+
+
+/**
+ * Checks that a variable has the expected size.
+ */
+#define IEMNATIVE_ASSERT_VAR_SIZE(a_pReNative, a_idxVar, a_cbVar) \
+    AssertMsg((a_pReNative)->Core.aVars[IEMNATIVE_VAR_IDX_UNPACK(a_idxVar)].cbVar == (a_cbVar), \
+              ("%s=%#x: cbVar=%#x, expected %#x!\n", #a_idxVar, a_idxVar, \
+              (a_pReNative)->Core.aVars[IEMNATIVE_VAR_IDX_UNPACK(a_idxVar)].cbVar == (a_cbVar)))
+
 
 /**
@@ -1299 +1353 @@
 {
     IEMNATIVE_ASSERT_VAR_IDX(pReNative, idxVar);
-    Assert(pReNative->Core.aVars[idxVar].fRegAcquired);
-    pReNative->Core.aVars[idxVar].fRegAcquired = false;
+    Assert(pReNative->Core.aVars[IEMNATIVE_VAR_IDX_UNPACK(idxVar)].fRegAcquired);
+    pReNative->Core.aVars[IEMNATIVE_VAR_IDX_UNPACK(idxVar)].fRegAcquired = false;
 }