Changeset 107102 in vbox for trunk/src/VBox/ValidationKit

Timestamp:

Nov 22, 2024 7:57:01 AM (8 weeks ago)

Author:

vboxsync

Message:

ValidationKit/bootsectors: Implement BS3_ASSERT() to actually do something useful; bugref:9898; bugref:10658; jiraref:VBP-1207

Image size note: this increases image sizes (about +15KB total between
bs3-cpu-instr-{2,3,4}). I've committed changes to make all of the
ValidatonKit/bootsectors images still fit within their constraints.
Some further work may be warranted to either eliminate unneeded asserts;
or wrap them in runtime `if's to shrink and/or coalesce failure strings.

Performance note: completion times for bs3-cpu-instr-{2,3,4} with this
fully disabled vs. are within 2% of each other -- not significant.

Location:

trunk/src/VBox/ValidationKit/bootsectors/bs3kit

Files:

• Makefile.kmk (modified) (1 diff)
• bs3-cmn-Assert.c (added)
• bs3kit-autostubs.kmk (modified) (1 diff)
• bs3kit-mangling-code-define.h (modified) (1 diff)
• bs3kit-mangling-code-undef.h (modified) (1 diff)
• bs3kit.h (modified) (1 diff)

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/Makefile.kmk

@@ -73 +73 @@
         bs3-cmn-A20Disable.asm \
         bs3-cmn-A20Enable.asm \
+        bs3-cmn-Assert.c \
         bs3-cmn-GetCpuVendor.c \
         bs3-cmn-GetModeName.c \

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit-autostubs.kmk

@@ -52 +52 @@
 $(call BS3KIT_FN_GEN_CMN_FARSTUB,bs3kit-common-16,Bs3SelFar32ToFlat32NoClobber,6)
 $(call BS3KIT_FN_GEN_CMN_FARSTUB,bs3kit-common-16,Bs3RegCtxSaveEx,8)
+$(call BS3KIT_FN_GEN_CMN_NEARSTUB,bs3kit-common-16,Bs3Assert)
 $(call BS3KIT_FN_GEN_CMN_NEARSTUB,bs3kit-common-16,Bs3ExtCtxSetAbridgedFtw)
 $(call BS3KIT_FN_GEN_CMN_NEARSTUB,bs3kit-common-16,Bs3ExtCtxSetMm)

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit-mangling-code-define.h

@@ -41 +41 @@
 #define Bs3A20EnableViaKbd BS3_CMN_MANGLER(Bs3A20EnableViaKbd)
 #define Bs3A20EnableViaPortA BS3_CMN_MANGLER(Bs3A20EnableViaPortA)
+#define Bs3Assert BS3_CMN_MANGLER(Bs3Assert)
 #define Bs3ExtCtxAlloc BS3_CMN_MANGLER(Bs3ExtCtxAlloc)
 #define Bs3ExtCtxCopy BS3_CMN_MANGLER(Bs3ExtCtxCopy)

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit-mangling-code-undef.h

@@ -41 +41 @@
 #undef Bs3A20EnableViaKbd
 #undef Bs3A20EnableViaPortA
+#undef Bs3Assert
 #undef Bs3ExtCtxAlloc
 #undef Bs3ExtCtxCopy

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit.h

@@ -1584 +1584 @@
  * Assert that an expression is true.
  *
- * Calls Bs3Panic if false and it's a strict build.  Does nothing in
- * non-strict builds.  */
-#ifdef BS3_STRICT
-# define BS3_ASSERT(a_Expr) do { if (!!(a_Expr)) { /* likely */ } else { Bs3Panic(); } } while (0) /**< @todo later */
+ * @param   a_Expr      The expression to assert.
+ *
+ * If the expression is false, prints a message and calls Bs3Panic.
+ *
+ * This can be controlled with two defines:
+ *
+ * - BS3_ASSERT_IGNORE disables it entirely.
+ *
+ * - BS3_ASSERT_FILE prints filenames rather than function names.  This
+ *   is disabled by default, as it consumes noticeably more image space.
+ *   Function name + line number are generally enough to find an issue.
+ *
+ * The expression string also consumes space.  If necessary, reduce that
+ * by using a simpler ASSERT() inside more a complicated `if'.
+ */
+BS3_CMN_PROTO_STUB(DECL_NO_RETURN(void), Bs3Assert,(const char BS3_FAR *pszExpr, const char BS3_FAR *pszFileOrFunc, const unsigned uLine));
+#define BS3_ASSERT_IGNORE
+#if defined(BS3_ASSERT_IGNORE)
+# define BS3_ASSERT(a_Expr) do { } while (0)
+#elif defined(BS3_ASSERT_FILE)
+# define BS3_ASSERT(a_Expr) do { if (!!(a_Expr)) { /* likely */ } else { Bs3Assert(#a_Expr, __FILE__, __LINE__); } } while (0)
 #else
-# define BS3_ASSERT(a_Expr) do { } while (0)
+# define BS3_ASSERT(a_Expr) do { if (!!(a_Expr)) { /* likely */ } else { Bs3Assert(#a_Expr, __func__, __LINE__); } } while (0)
 #endif