Abolishing a bunch of varieties and reforming the hot variety to run about as fast as white-hot.

See <http://info.ravenbrook.com/mail/2012/08/15/17-43-37/0/>.

Copied from Perforce
 Change: 179153
 ServerID: perforce.ravenbrook.com

5 files changed, 103 insertions, 85 deletions

diff --git a/mps/code/check.h b/mps/code/check.h
index e58a9d04ced..26ce0ea965e 100644
--- a/mps/code/check.h
+++ b/mps/code/check.h
@@ -56,19 +56,32 @@ enum {
 #elif defined(AVER_AND_CHECK)
 
 #define AVER(cond)                  ASSERT(cond, #cond)
-#define AVERT(type, val)            ASSERT(type ## Check(val), \
-                                           "TypeCheck " #type ": " #val)
+
+#define AVERT(type, val) \
+  ASSERT(type ## Check(val), "TypeCheck " #type ": " #val)
+
+#if !defined(AVER_AND_CHECK_ALL)
+
+#define AVER_CRITICAL               DISCARD
+#define AVERT_CRITICAL(type, val)   DISCARD(type ## Check(val))
+
+#else /* AVER_AND_CHECK_ALL  */
+
 #define AVER_CRITICAL(cond) \
   BEGIN \
-    if (CheckLevel != CheckLevelMINIMAL) ASSERT(cond, #cond); \
+    if (CheckLevel != CheckLevelMINIMAL) \
+      ASSERT(cond, #cond); \
   END
+
 #define AVERT_CRITICAL(type, val) \
   BEGIN \
     if (CheckLevel != CheckLevelMINIMAL) \
       ASSERT(type ## Check(val), "TypeCheck " #type ": " #val); \
   END
 
-#else
+#endif /* AVER_AND_CHECK_ALL */
+
+#else /* AVER_AND_CHECK, not */
 
 #error "No checking defined."
 
@@ -115,24 +128,34 @@ enum {
 
 #if defined(AVER_AND_CHECK_NONE)
 
-
-#define CHECKS(type, val) DISCARD(CHECKT(type, val))
-#define CHECKL(cond) DISCARD(cond)
-#define CHECKD(type, val) DISCARD(CHECKT(type, val))
+#define CHECKS(type, val)       DISCARD(CHECKT(type, val))
+#define CHECKL(cond)            DISCARD(cond)
+#define CHECKD(type, val)       DISCARD(CHECKT(type, val))
 #define CHECKD_NOSIG(type, val) DISCARD((val) != NULL)
-#define CHECKU(type, val) DISCARD(CHECKT(type, val))
+#define CHECKU(type, val)       DISCARD(CHECKT(type, val))
 #define CHECKU_NOSIG(type, val) DISCARD((val) != NULL)
 
-
-#else
-
+#else /* AVER_AND_CHECK_NONE, not */
 
 /* CHECKS -- Check Signature */
 /* (if CheckLevel == CheckLevelMINIMAL, this is all we check) */
 
-#define CHECKS(type, val)       ASSERT(CHECKT(type, val), \
-                                       "SigCheck " #type ": " #val)
+#define CHECKS(type, val) \
+  ASSERT(CHECKT(type, val), "SigCheck " #type ": " #val)
 
+#if !defined(AVER_AND_CHECK_ALL)
+
+/* FIXME: This gives comparable performance to white-hot when compiling
+   using mps.c and -O (to get check methods inlined), but is it a bit
+   too minimal?  How much do we rely on check methods? */
+
+#define CHECKL(cond)            DISCARD(cond)
+#define CHECKD(type, val)       DISCARD(CHECKT(type, val))
+#define CHECKD_NOSIG(type, val) DISCARD((val) != NULL)
+#define CHECKU(type, val)       DISCARD(CHECKT(type, val))
+#define CHECKU_NOSIG(type, val) DISCARD((val) != NULL)
+
+#else /* AVER_AND_CHECK_ALL */
 
 /* CHECKL -- Check Local Invariant
  *
@@ -162,12 +185,10 @@ enum {
       NOOP; \
       break; \
     case CheckLevelSHALLOW: \
-      ASSERT(CHECKT(type, val), \
-             "SigCheck " #type ": " #val); \
+      CHECKS(type, val); \
       break; \
     case CheckLevelDEEP: \
-      ASSERT(type ## Check(val), \
-             "TypeCheck " #type ": " #val); \
+      ASSERT(type ## Check(val), "TypeCheck " #type ": " #val); \
       break; \
     } \
   END
@@ -182,12 +203,10 @@ enum {
       NOOP; \
       break; \
     case CheckLevelSHALLOW: \
-      ASSERT((val) != NULL, \
-             "NullCheck " #type ": " #val); \
+      ASSERT((val) != NULL, "NullCheck " #type ": " #val); \
       break; \
     case CheckLevelDEEP: \
-      ASSERT(type ## Check(val), \
-             "TypeCheck " #type ": " #val); \
+      ASSERT(type ## Check(val), "TypeCheck " #type ": " #val); \
       break; \
     } \
   END
@@ -203,8 +222,7 @@ enum {
       break; \
     case CheckLevelSHALLOW: \
     case CheckLevelDEEP: \
-      ASSERT(CHECKT(type, val), \
-             "SigCheck " #type ": " #val); \
+      CHECKS(type, val); \
       break; \
     } \
   END
@@ -220,14 +238,14 @@ enum {
       break; \
     case CheckLevelSHALLOW: \
     case CheckLevelDEEP: \
-      ASSERT((val) != NULL, \
-             "NullCheck " #type ": " #val); \
+      ASSERT((val) != NULL, "NullCheck " #type ": " #val); \
       break; \
     } \
   END
 
+#endif /* AVER_AND_CHECK_ALL */
 
-#endif
+#endif /* AVER_AND_CHECK_NONE */
 
 
 /* CHECKLVALUE &c -- type compatibility checking
diff --git a/mps/code/comm.gmk b/mps/code/comm.gmk
index 9141c34c9cd..1726e451543 100644
--- a/mps/code/comm.gmk
+++ b/mps/code/comm.gmk
@@ -16,8 +16,6 @@
 #                   information, and any optimization possible
 # CFLAGSOPT         a list of flags for compilations with maximum
 #                   optimization, and any debug info possible
-# CFLAGSOPTNODEBUG  a list of flags for compilations with maximum
-#                   optimization, and absolutely no debug info
 # CC                the command for the C compiler
 # LINKFLAGS         a list of flags passed to the linker
 # ARFLAGSPFM        platform-specific flags for ar
@@ -64,9 +62,6 @@ endif
 ifndef CFLAGSOPT
 error "comm.gmk: CFLAGSOPT not defined"
 endif
-ifndef CFLAGSOPTNODEBUG
-error "comm.gmk: CFLAGSOPTNODEBUG not defined"
-endif
 
 #
 # %%PART: Add checks for the parameter with the sources for the new
@@ -122,13 +117,9 @@ CFLAGSCOMMON = $(PFMDEFS) $(CFLAGSTARGET) $(CFLAGSCOMPILER)
 #            variety.
 
 # These flags are added to compilations for the indicated variety.
-CFWE = -DCONFIG_VAR_WE -DNDEBUG $(CFLAGSOPTNODEBUG)
-CFWI = -DCONFIG_VAR_WI -DNDEBUG $(CFLAGSOPT)
-CFHE = -DCONFIG_VAR_HE -DNDEBUG $(CFLAGSOPTNODEBUG)
-CFHI = -DCONFIG_VAR_HI -DNDEBUG $(CFLAGSOPT)
+CFWE = -DCONFIG_VAR_WE -DNDEBUG $(CFLAGSOPT)
+CFHE = -DCONFIG_VAR_HE -DNDEBUG $(CFLAGSOPT)
 CFDI = -DCONFIG_VAR_DI -DNDEBUG $(CFLAGSOPT)
-CFII = -DCONFIG_VAR_II -DNDEBUG $(CFLAGSOPT)
-CFCE = -DCONFIG_VAR_CE          $(CFLAGSOPTNODEBUG)
 CFCI = -DCONFIG_VAR_CI          $(CFLAGSDEBUG)
 CFTI = -DCONFIG_VAR_TI          $(CFLAGSDEBUG)
 
@@ -137,24 +128,12 @@ CFTI = -DCONFIG_VAR_TI          $(CFLAGSDEBUG)
 ifeq ($(VARIETY),we)
 CFLAGS=$(CFLAGSCOMMON) $(CFWE)
 else
-ifeq ($(VARIETY),wi)
-CFLAGS=$(CFLAGSCOMMON) $(CFWI)
-else
 ifeq ($(VARIETY),he)
 CFLAGS=$(CFLAGSCOMMON) $(CFHE)
 else
-ifeq ($(VARIETY),hi)
-CFLAGS=$(CFLAGSCOMMON) $(CFHI)
-else
 ifeq ($(VARIETY),di)
 CFLAGS=$(CFLAGSCOMMON) $(CFDI)
 else
-ifeq ($(VARIETY),ii)
-CFLAGS=$(CFLAGSCOMMON) $(CFII)
-else
-ifeq ($(VARIETY),ce)
-CFLAGS=$(CFLAGSCOMMON) $(CFCE)
-else
 ifeq ($(VARIETY),ci)
 CFLAGS=$(CFLAGSCOMMON) $(CFCI)
 else
@@ -166,10 +145,6 @@ endif
 endif
 endif
 endif
-endif
-endif
-endif
-endif
 
 
 ARFLAGS=rc$(ARFLAGSPFM)
@@ -328,10 +303,8 @@ clean: phony
 ifdef TARGET
 ifndef VARIETY
 target: phony
-        $(MAKE) -f $(PFM).gmk VARIETY=hi variety
+        $(MAKE) -f $(PFM).gmk VARIETY=he variety
         $(MAKE) -f $(PFM).gmk VARIETY=ci variety
-        $(MAKE) -f $(PFM).gmk VARIETY=di variety
-        $(MAKE) -f $(PFM).gmk VARIETY=we variety
 endif
 endif
 
diff --git a/mps/code/config.h b/mps/code/config.h
index 29abad920f7..86b3a22b610 100644
--- a/mps/code/config.h
+++ b/mps/code/config.h
@@ -21,36 +21,46 @@
 
 /* Variety Configuration */
 
-/* First translate GG build directives into better ones.
- */
-
-#ifdef CONFIG_DEBUG
-/* Translate CONFIG_DEBUG to CONFIG_STATS, because that's what it */
-/* means.  It's got nothing to do with debugging!  RHSK 2007-06-29 */
-#define CONFIG_STATS
-#endif
+/* Then deal with CONFIG_VAR_* build directives.  These are translated into
+   the directives CONFIG_ASSERT, CONFIG_STATS, CONFIG_LOG, etc. which control
+   actual compilation features. */
 
-
-/* Then deal with old-style CONFIG_VAR_* build directives.  These
- * must be translated into the new directives CONFIG_ASSERT,
- * CONFIG_STATS, and CONFIG_LOG.
+/* CONFIG_VAR_WE -- the white-hot variety
  *
- * One day the old build system may be converted to use the new
- * directives.
+ * This variety switches off as many features as possible for maximum
+ * performance, but is therefore unsafe and undebuggable.  It is not intended
+ * for use, but for comparison with the hot variety, to check that assertion,
+ * logging, etc. have negligible overhead.
  */
 
-#if defined(CONFIG_VAR_WI) || defined(CONFIG_VAR_WE) /* White-hot varieties */
+#if defined(CONFIG_VAR_WE)      /* White-hot variety */
 /* no asserts */
 /* ... so CHECKLEVEL_INITIAL is irrelevant */
 /* no statistic meters */
 /* no telemetry log events */
 
-#elif defined(CONFIG_VAR_HI) || defined(CONFIG_VAR_HE) /* Hot varieties */
+
+/* CONFIG_VAR_HE -- the hot variety
+ *
+ * This variety is the default variety for distribution in products that use
+ * the MPS.  It has maximum performance while retaining a good level of
+ * consistency checking and allowing some debugging and telemetry features.
+ */
+
+#elif defined(CONFIG_VAR_HE)    /* Hot variety */
 #define CONFIG_ASSERT
 #define CHECKLEVEL_INITIAL CheckLevelMINIMAL
 /* no statistic meters */
 /* no telemetry log events */
 
+
+/* CONFIG_VAR_DI -- diagnostic variety
+ *
+ * Deprecated.  The diagnostic variety prints messages about the internals
+ * of the MPS to an output stream.  This is being replaced by an extended
+ * telemetry system.  RB 2012-08-31
+ */
+
 #elif defined(CONFIG_VAR_DI) /* Diagnostic variety */
 #define CONFIG_ASSERT
 #define CHECKLEVEL_INITIAL CheckLevelMINIMAL
@@ -63,24 +73,38 @@
 /* #define DIAG_WITH_PRINTF */
 /* no telemetry log events */
 
-#elif defined(CONFIG_VAR_CI) || defined(CONFIG_VAR_CE) /* Cool varieties */
+
+/* CONFIG_VAR_CI -- cool variety
+ *
+ * The cool variety is intended for use when developing an integration with
+ * the MPS or debugging memory problems or collecting detailed telemetry
+ * data for performance analysis.  It has more thorough consistency checking
+ * and data collection and output, and full debugging information.
+ */
+
+#elif defined(CONFIG_VAR_CI)    /* Cool variety */
 #define CONFIG_ASSERT
+#define CONFIG_ASSERT_ALL
 /* ... let PRODUCT determine CHECKLEVEL_INITIAL */
 #define CONFIG_STATS
 /* no telemetry log events */
 
+
+/* CONFIG_VAR_TI -- telemetry variety
+ *
+ * Deprecated.  This is the variety with event logging to a telemetry stream.
+ * Currently being reworked to retain event logging with negligible overhead
+ * on all other varieties.  RB 2012-08-31
+ */
+
 #elif defined(CONFIG_VAR_TI)    /* Telemetry, Internal; variety.ti */
 #define CONFIG_ASSERT
+#define CONFIG_ASSERT_ALL
 /* ... let PRODUCT determine CHECKLEVEL_INITIAL */
 #define CONFIG_STATS
 #define CONFIG_LOG
 
-#elif defined(CONFIG_VAR_II)    /* Ice, Internal; variety.ii (HotLog) */
-#define CONFIG_ASSERT
-#define CHECKLEVEL_INITIAL CheckLevelMINIMAL
-/* no statistic meters */
-#define CONFIG_LOG
-#endif
+#endif /* CONFIG_VAR_* */
 
 
 /* Build Features */
@@ -90,8 +114,13 @@
 /* asserts: AVER, AVERT, NOTREACHED, CHECKx */
 /* note: a direct call to ASSERT() will *still* fire */
 #define AVER_AND_CHECK
+#if defined(CONFIG_ASSERT_ALL)
+#define AVER_AND_CHECK_ALL
+#define MPS_ASSERT_STRING "assertastic"
+#else /* CONFIG_ASSERT_ALL, not */
 #define MPS_ASSERT_STRING "asserted"
-#else
+#endif /* CONFIG_ASSERT_ALL */
+#else /* CONFIG_ASSERT, not */
 #define AVER_AND_CHECK_NONE
 #define MPS_ASSERT_STRING "nonasserted"
 #endif
diff --git a/mps/code/gc.gmk b/mps/code/gc.gmk
index 75b83bf8118..2aeb61cdbc1 100644
--- a/mps/code/gc.gmk
+++ b/mps/code/gc.gmk
@@ -13,9 +13,8 @@ CFLAGSCOMPILER := \
         -Wstrict-prototypes -Wmissing-prototypes \
         -Winline -Waggregate-return -Wnested-externs \
         -Wcast-qual -Wshadow
-CFLAGSDEBUG = -g -ggdb3
-CFLAGSOPT = -O -g -ggdb3
-CFLAGSOPTNODEBUG = -O -g0
+CFLAGSDEBUG = -O0 -g
+CFLAGSOPT = -O3 -g
 
 # gcc -MM generates a dependency line of the form:
 #   thing.o : thing.c ...
diff --git a/mps/code/gp.gmk b/mps/code/gp.gmk
index 229064d3055..8e16b524c38 100644
--- a/mps/code/gp.gmk
+++ b/mps/code/gp.gmk
@@ -16,7 +16,6 @@ CFLAGSCOMPILER = \
         -Wcast-qual -Wshadow -pg
 CFLAGSDEBUG = -g -ggdb3
 CFLAGSOPT = -O -g -ggdb3
-CFLAGSOPTNODEBUG = -O -g0
 
 # gcc -MM generates a dependency line of the form:
 #   thing.o : thing.c ...