Changeset 99896 in vbox

Timestamp:

May 22, 2023 11:41:57 AM (2 years ago)

Author:

vboxsync

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

157539

Message:

VMM/SSM: Added SSM_GET_STD_ENUM32_RET for automatically validating enum range using the standard INVALID and END values. bugref:10369

File:

• trunk/include/VBox/vmm/ssm.h (modified) (1 diff)

trunk/include/VBox/vmm/ssm.h ¶

@@ -1341 +1341 @@
     } while (0)
 
+/** Wrapper around SSMR3GetU32 for simplifying getting standard conforming enum
+ * values saved as uint32_t.  (The valid ragne is between the _INVALID and
+ * _END values.) */ 
+# define SSM_GET_STD_ENUM32_RET(a_pSSM, a_enmDst, a_EnumType) \
+    do { \
+        uint32_t u32GetEnumTmp = 0; \
+        int rcGetEnum32Tmp = SSMR3GetU32((a_pSSM), &u32GetEnumTmp); \
+        AssertRCReturn(rcGetEnum32Tmp, rcGetEnum32Tmp); \
+        a_EnumType enmTmp = (a_EnumType)u32GetEnumTmp; \
+        AssertCompile(sizeof(a_EnumType) == sizeof(u32GetEnumTmp)); \
+        if (RT_LIKELY(enmTmp > RT_CONCAT(a_EnumType,_INVALID) && enmTmp < RT_CONCAT(a_EnumType,_END))) \
+            (a_enmDst) = (a_EnumType)u32GetEnumTmp; \
+        else \
+            return SSMR3SetLoadError(a_pSSM, VERR_SSM_ENUM_VALUE_OUT_OF_RANGE, RT_SRC_POS, \
+                                     "The value for '%s' is out of range: %d (" #a_EnumType "_INVALID=%d, " #a_EnumType "_END=%d)", \
+                                     #a_enmDst, u32GetEnumTmp, RT_CONCAT(a_EnumType,_INVALID), RT_CONCAT(a_EnumType,_END)); \
+    } while (0)
+
 /** @} */