[binutils-gdb] [gdb/testsuite] Add -early pattern flag for gdb_test_multiple

[binutils-gdb] [gdb/testsuite] Add -early pattern flag for gdb_test_multiple

[Tom de Vries]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=60b6ede84503a340cbb3d4f76e874e702d69812f

commit 60b6ede84503a340cbb3d4f76e874e702d69812f
Author: Tom de Vries <tdevries@suse.de>
Date:   Wed Oct 30 17:41:03 2019 +0100

    [gdb/testsuite] Add -early pattern flag for gdb_test_multiple
    
    Proc gdb_test_multiple builds up and executes a gdb_expect expression with
    pattern/action clauses.  The clauses are either implicit (added by
    gdb_test_multiple) or explicit (passed via the gdb_test_multiple parameter
    user_code).
    
    However, there are a few implicit clauses which are inserted before the
    explicit ones, making sure those take precedence.
    
    Add an -early pattern flag for a gdb_test_multiple user_code clause to specify
    that the clause needs to be inserted before any implicit clause.
    
    Using this pattern flag, we can f.i. setup a kfail for an assertion failure
    <assert> during gdb_continue_to_breakpoint by the rewrite:
    ...
    gdb_continue_to_breakpoint <msg> <pattern>
    ...
    into:
    ...
    set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
    gdb_test_multiple "continue" "continue to breakpoint: <msg>"  {
       -early -re "internal-error: <assert>" {
           setup_kfail gdb/nnnnn "*-*-*"
           exp_continue
       }
       -re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
           pass $gdb_test_name
       }
    }
    
    Tested on x86_64-linux.
    
    gdb/testsuite/ChangeLog:
    
    2019-10-30  Tom de Vries  <tdevries@suse.de>
    
    	* lib/gdb.exp (gdb_test_multiple): Handle -early pattern flag.
    
    Change-Id: I376c636b0812be52e7137634b1a4f50bf2b999b6

Diff:
---
 gdb/testsuite/ChangeLog   |  4 ++++
 gdb/testsuite/lib/gdb.exp | 46 +++++++++++++++++++++++++++++++++++++---------
 2 files changed, 41 insertions(+), 9 deletions(-)

diff --git a/gdb/testsuite/ChangeLog b/gdb/testsuite/ChangeLog
index 417c289..baa0553 100644
--- a/gdb/testsuite/ChangeLog
+++ b/gdb/testsuite/ChangeLog
@@ -1,3 +1,7 @@
+2019-10-30  Tom de Vries  <tdevries@suse.de>
+
+	* lib/gdb.exp (gdb_test_multiple): Handle -early pattern flag.
+
 2019-10-26  Tom de Vries  <tdevries@suse.de>
 
 	* gdb.base/bigcore.c: Fix typos in comments.
diff --git a/gdb/testsuite/lib/gdb.exp b/gdb/testsuite/lib/gdb.exp
index 6770741..599bf0f 100644
--- a/gdb/testsuite/lib/gdb.exp
+++ b/gdb/testsuite/lib/gdb.exp
@@ -775,6 +775,23 @@ proc gdb_internal_error_resync {} {
 #       }
 #   }
 #
+# In EXPECT_ARGUMENTS, a pattern flag -early can be used.  It makes sure the
+# pattern is inserted before any implicit pattern added by gdb_test_multiple.
+# Using this pattern flag, we can f.i. setup a kfail for an assertion failure
+# <assert> during gdb_continue_to_breakpoint by the rewrite:
+#   gdb_continue_to_breakpoint <msg> <pattern>
+# into:
+#   set breakpoint_pattern "(?:Breakpoint|Temporary breakpoint) .* (at|in)"
+#   gdb_test_multiple "continue" "continue to breakpoint: <msg>"  {
+#	-early -re "internal-error: <assert>" {
+#	    setup_kfail gdb/nnnnn "*-*-*"
+#	    exp_continue
+#	}
+#	-re "$breakpoint_pattern <pattern>\r\n$gdb_prompt $" {
+#	    pass $gdb_test_name
+#	}
+#    }
+#
 proc gdb_test_multiple { command message user_code { prompt_regexp "" } } {
     global verbose use_gdb_stub
     global gdb_prompt pagination_prompt
@@ -833,22 +850,30 @@ proc gdb_test_multiple { command message user_code { prompt_regexp "" } } {
     set subst_code [uplevel list $subst_code]
 
     set processed_code ""
+    set early_processed_code ""
+    # The variable current_list holds the name of the currently processed
+    # list, either processed_code or early_processed_code.
+    set current_list "processed_code"
     set patterns ""
     set expecting_action 0
     set expecting_arg 0
     set wrap_pattern 0
     foreach item $user_code subst_item $subst_code {
 	if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
-	    lappend processed_code $item
+	    lappend $current_list $item
 	    continue
 	}
 	if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
-	    lappend processed_code $item
+	    lappend $current_list $item
+	    continue
+	}
+	if { $item == "-early" } {
+	    set current_list "early_processed_code"
 	    continue
 	}
 	if { $item == "-timeout" || $item == "-i" } {
 	    set expecting_arg 1
-	    lappend processed_code $item
+	    lappend $current_list $item
 	    continue
 	}
 	if { $item == "-wrap" } {
@@ -857,24 +882,26 @@ proc gdb_test_multiple { command message user_code { prompt_regexp "" } } {
 	}
 	if { $expecting_arg } {
 	    set expecting_arg 0
-	    lappend processed_code $subst_item
+	    lappend $current_list $subst_item
 	    continue
 	}
 	if { $expecting_action } {
-	    lappend processed_code "uplevel [list $item]"
+	    lappend $current_list "uplevel [list $item]"
 	    set expecting_action 0
 	    # Cosmetic, no effect on the list.
-	    append processed_code "\n"
+	    append $current_list "\n"
+	    # End the effect of -early, it only applies to one action.
+	    set current_list "processed_code"
 	    continue
 	}
 	set expecting_action 1
 	if { $wrap_pattern } {
 	    # Wrap subst_item as is done for the gdb_test PATTERN argument.
-	    lappend processed_code \
+	    lappend $current_list \
 		"\[\r\n\]*(?:$subst_item)\[\r\n\]+$gdb_prompt $"
 	    set wrap_pattern 0
 	} else {
-	    lappend processed_code $subst_item
+	    lappend $current_list $subst_item
 	}
 	if {$patterns != ""} {
 	    append patterns "; "
@@ -938,7 +965,8 @@ proc gdb_test_multiple { command message user_code { prompt_regexp "" } } {
 	}
     }
 
-    set code {
+    set code $early_processed_code
+    append code {
 	-re ".*A problem internal to GDB has been detected" {
 	    fail "$message (GDB internal error)"
 	    gdb_internal_error_resync