Add -RegexBytecodeDebug Flag to display RegExp bytecode's binary layout

Author: dilijev

lib/Common/ConfigFlagsList.h

@@ -509,6 +509,7 @@ PHASE(All)
 #define DEFAULT_CONFIG_RegexTracing         (false)
 #define DEFAULT_CONFIG_RegexProfile         (false)
 #define DEFAULT_CONFIG_RegexDebug           (false)
+#define DEFAULT_CONFIG_RegexBytecodeDebug   (false)
 #define DEFAULT_CONFIG_RegexOptimize        (true)
 #define DEFAULT_CONFIG_DynamicRegexMruListSize (16)
 #define DEFAULT_CONFIG_GoptCleanupThreshold  (25)
@@ -1435,6 +1436,7 @@ FLAGNR(Boolean, ValidateHeapEnum      , "Validate that heap enumeration is repor
 FLAGR (Boolean, RegexTracing          , "Trace all Regex invocations to the output.", DEFAULT_CONFIG_RegexTracing)
 FLAGR (Boolean, RegexProfile          , "Collect usage statistics on all Regex invocations.", DEFAULT_CONFIG_RegexProfile)
 FLAGR (Boolean, RegexDebug            , "Trace compilation of UnifiedRegex expressions.", DEFAULT_CONFIG_RegexDebug)
+FLAGR (Boolean, RegexBytecodeDebug    , "Display layout of UnifiedRegex bytecode (requires -RegexDebug to view).", DEFAULT_CONFIG_RegexBytecodeDebug)
 FLAGR (Boolean, RegexOptimize         , "Optimize regular expressions in the unified Regex system (default: true)", DEFAULT_CONFIG_RegexOptimize)
 FLAGR (Number,  DynamicRegexMruListSize, "Size of the MRU list for dynamic regexes", DEFAULT_CONFIG_DynamicRegexMruListSize)
 #endif

lib/Parser/RegexCompileTime.cpp

@@ -4633,7 +4633,7 @@ namespace UnifiedRegex
 #if ENABLE_REGEX_CONFIG_OPTIONS
         if (w != 0)
         {
-            w->PrintEOL(_u("REGEX PROGRAM /%s/ "), PointerValue(program->source));
+            w->PrintEOL(_u("REGEX PROGRAM /%s/"), PointerValue(program->source));
             program->Print(w);
             w->Flush();
         }

lib/Parser/RegexOpCodes.h

@@ -6,13 +6,16 @@
 //     ClassName == TagName##Inst
 // MTemplate(TagName, TemplateDeclaration, GenericClassName, SpecializedClassName)
 
+// 0x00
+M(Nop) // Opcode byte 0x00 is a NOP (allows for NOP-sleds for alignment if necessary)
 M(Fail)
 M(Succ)
 M(Jump)
 M(JumpIfNotChar)
 M(MatchCharOrJump)
 M(JumpIfNotSet)
 M(MatchSetOrJump)
+// 0x08
 M(Switch10)
 M(Switch20)
 M(SwitchAndConsume10)
@@ -21,6 +24,7 @@ M(BOITest)
 M(EOITest)
 M(BOLTest)
 M(EOLTest)
+// 0x10
 M(WordBoundaryTest)
 M(MatchChar)
 M(MatchChar2)
@@ -29,6 +33,7 @@ M(MatchChar4)
 MTemplate(MatchSet, template<bool IsNegation>, MatchSetInst, MatchSetInst<false>)
 MTemplate(MatchNegatedSet, template<bool IsNegation>, MatchSetInst, MatchSetInst<true>)
 M(MatchLiteral)
+// 0x18
 M(MatchLiteralEquiv)
 M(MatchTrie)
 M(OptMatchChar)
@@ -37,30 +42,35 @@ M(SyncToCharAndContinue)
 M(SyncToChar2SetAndContinue)
 MTemplate(SyncToSetAndContinue, template<bool IsNegation>, SyncToSetAndContinueInst, SyncToSetAndContinueInst<false>)
 MTemplate(SyncToNegatedSetAndContinue, template<bool IsNegation>, SyncToSetAndContinueInst, SyncToSetAndContinueInst<true>)
-M(SyncToChar2LiteralAndContinue)
-M(SyncToLiteralAndContinue)
-M(SyncToLinearLiteralAndContinue)
-M(SyncToLiteralEquivAndContinue)
-M(SyncToLiteralEquivTrivialLastPatCharAndContinue)
+// 0x20
+M(SyncToChar2LiteralAndContinue) // SyncToLiteralAndContinueInstT<Char2LiteralScannerMixin>
+M(SyncToLiteralAndContinue) // SyncToLiteralAndContinueInstT<ScannerMixin>
+M(SyncToLinearLiteralAndContinue) // SyncToLiteralAndContinueInstT<ScannerMixin_WithLinearCharMap>
+M(SyncToLiteralEquivAndContinue) // SyncToLiteralAndContinueInstT<EquivScannerMixin>
+M(SyncToLiteralEquivTrivialLastPatCharAndContinue) // SyncToLiteralAndContinueInstT<EquivTrivialLastPatCharScannerMixin>
 M(SyncToCharAndConsume)
 M(SyncToChar2SetAndConsume)
 MTemplate(SyncToSetAndConsume, template<bool IsNegation>, SyncToSetAndConsumeInst, SyncToSetAndConsumeInst<false>)
+// 0x28
 MTemplate(SyncToNegatedSetAndConsume, template<bool IsNegation>, SyncToSetAndConsumeInst, SyncToSetAndConsumeInst<true>)
-M(SyncToChar2LiteralAndConsume)
-M(SyncToLiteralAndConsume)
-M(SyncToLinearLiteralAndConsume)
-M(SyncToLiteralEquivAndConsume)
-M(SyncToLiteralEquivTrivialLastPatCharAndConsume)
+M(SyncToChar2LiteralAndConsume) // SyncToLiteralAndConsumeInstT<Char2LiteralScannerMixin>
+M(SyncToLiteralAndConsume) // SyncToLiteralAndConsumeInstT<ScannerMixin>
+M(SyncToLinearLiteralAndConsume) // SyncToLiteralAndConsumeInstT<ScannerMixin_WithLinearCharMap>
+M(SyncToLiteralEquivAndConsume) // SyncToLiteralAndConsumeInstT<EquivScannerMixin>
+M(SyncToLiteralEquivTrivialLastPatCharAndConsume) // SyncToLiteralAndConsumeInstT<EquivTrivialLastPatCharScannerMixin>
 M(SyncToCharAndBackup)
+// REVIEW (doilij): why not have a SyncToChar2SetAndBackup ?
 MTemplate(SyncToSetAndBackup, template<bool IsNegation>, SyncToSetAndBackupInst, SyncToSetAndBackupInst<false>)
+// 0x30
 MTemplate(SyncToNegatedSetAndBackup, template<bool IsNegation>, SyncToSetAndBackupInst, SyncToSetAndBackupInst<true>)
-M(SyncToChar2LiteralAndBackup)
-M(SyncToLiteralAndBackup)
-M(SyncToLinearLiteralAndBackup)
-M(SyncToLiteralEquivAndBackup)
-M(SyncToLiteralEquivTrivialLastPatCharAndBackup)
+M(SyncToChar2LiteralAndBackup) // SyncToLiteralAndBackupInstT<Char2LiteralScannerMixin>
+M(SyncToLiteralAndBackup) // SyncToLiteralAndBackupInstT<ScannerMixin>
+M(SyncToLinearLiteralAndBackup) // SyncToLiteralAndBackupInstT<ScannerMixin_WithLinearCharMap>
+M(SyncToLiteralEquivAndBackup) // SyncToLiteralAndBackupInstT<EquivScannerMixin>
+M(SyncToLiteralEquivTrivialLastPatCharAndBackup) // SyncToLiteralAndBackupInstT<EquivTrivialLastPatCharScannerMixin>
 M(SyncToLiteralsAndBackup)
 M(MatchGroup)
+// 0x38
 M(BeginDefineGroup)
 M(EndDefineGroup)
 M(DefineGroupFixed)
@@ -69,6 +79,7 @@ M(RepeatLoop)
 M(BeginLoopIfChar)
 M(BeginLoopIfSet)
 M(RepeatLoopIfChar)
+// 0x40
 M(RepeatLoopIfSet)
 M(BeginLoopFixed)
 M(RepeatLoopFixed)
@@ -77,6 +88,7 @@ M(LoopSetWithFollowFirst)
 M(BeginLoopFixedGroupLastIteration)
 M(RepeatLoopFixedGroupLastIteration)
 M(BeginGreedyLoopNoBacktrack)
+// 0x48
 M(RepeatGreedyLoopNoBacktrack)
 MTemplate(ChompCharStar, template<ChompMode Mode>, ChompCharInst, ChompCharInst<ChompMode::Star>)
 MTemplate(ChompCharPlus, template<ChompMode Mode>, ChompCharInst, ChompCharInst<ChompMode::Plus>)
@@ -85,6 +97,7 @@ MTemplate(ChompSetPlus, template<ChompMode Mode>, ChompSetInst, ChompSetInst<Cho
 MTemplate(ChompCharGroupStar, template<ChompMode Mode>, ChompCharGroupInst, ChompCharGroupInst<ChompMode::Star>)
 MTemplate(ChompCharGroupPlus, template<ChompMode Mode>, ChompCharGroupInst, ChompCharGroupInst<ChompMode::Plus>)
 MTemplate(ChompSetGroupStar, template<ChompMode Mode>, ChompSetGroupInst, ChompSetGroupInst<ChompMode::Star>)
+// 0x50
 MTemplate(ChompSetGroupPlus, template<ChompMode Mode>, ChompSetGroupInst, ChompSetGroupInst<ChompMode::Plus>)
 M(ChompCharBounded)
 M(ChompSetBounded)
@@ -93,6 +106,7 @@ M(Try)
 M(TryIfChar)
 M(TryMatchChar)
 M(TryIfSet)
+// 0x58
 M(TryMatchSet)
 M(BeginAssertion)
 M(EndAssertion)