X-Git-Url: http://drtracing.org/?a=blobdiff_plain;f=gdb%2Ftestsuite%2Flib%2Fmi-support.exp;h=f62c2402c96aa17fd1f5d4ac8f9c95de2448b5b3;hb=c86cf029308edd78d12d1bb67a1d4ae1c14a9155;hp=44679f0a00426267ff419cc0aa9fa8158c696711;hpb=1902c51fa6c7592a74d1006067ab61aabef4ac33;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/testsuite/lib/mi-support.exp b/gdb/testsuite/lib/mi-support.exp index 44679f0a00..f62c2402c9 100644 --- a/gdb/testsuite/lib/mi-support.exp +++ b/gdb/testsuite/lib/mi-support.exp @@ -1,21 +1,18 @@ -# Copyright 1999, 2000 Free Software Foundation, Inc. +# Copyright 1999, 2000, 2002, 2003, 2004, 2005, 2007, 2008, 2009 +# Free Software Foundation, Inc. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or +# the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. -# +# # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. -# +# # You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - -# Please email any bugs, comments, and/or additions to this file to: -# bug-gdb@prep.ai.mit.edu +# along with this program. If not, see . # This file was based on a file written by Fred Fish. (fnf@cygnus.com) @@ -28,8 +25,14 @@ if ![info exists mi_gdb_prompt] then { set mi_gdb_prompt "\[(\]gdb\[)\] \r\n" } +global mi_inferior_spawn_id +global mi_inferior_tty_name + set MIFLAGS "-i=mi" +set thread_selected_re "=thread-selected,id=\"\[0-9+\]\"\r\n" +set library_loaded_re "=library-loaded\[^\n\]+\"\r\n" + # # mi_gdb_exit -- exit the GDB, killing the target program if necessary # @@ -39,7 +42,7 @@ proc mi_gdb_exit {} { proc mi_uncatched_gdb_exit {} { global GDB - global GDBFLAGS + global INTERNAL_GDBFLAGS GDBFLAGS global verbose global gdb_spawn_id; global gdb_prompt @@ -56,7 +59,7 @@ proc mi_uncatched_gdb_exit {} { return; } - verbose "Quitting $GDB $GDBFLAGS $MIFLAGS" + verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS" if { [is_remote host] && [board_info host exists fileid] } { send_gdb "999-gdb-exit\n"; @@ -81,16 +84,20 @@ proc mi_uncatched_gdb_exit {} { } # -# start gdb -- start gdb running, default procedure +# default_mi_gdb_start [INFERIOR_PTY] -- start gdb running, default procedure +# +# INFERIOR_PTY should be set to separate-inferior-tty to have the inferior work +# with it's own PTY. If set to same-inferior-tty, the inferior shares GDB's PTY. +# The default value is same-inferior-tty. # # When running over NFS, particularly if running many simultaneous # tests on different hosts all using the same server, things can # get really slow. Give gdb at least 3 minutes to start up. # -proc mi_gdb_start { } { +proc default_mi_gdb_start { args } { global verbose global GDB - global GDBFLAGS + global INTERNAL_GDBFLAGS GDBFLAGS global gdb_prompt global mi_gdb_prompt global timeout @@ -98,6 +105,13 @@ proc mi_gdb_start { } { global MIFLAGS gdb_stop_suppressing_tests; + set inferior_pty no-tty + + if { [llength $args] == 1} { + set inferior_pty [lindex $args 0] + } + + set separate_inferior_pty [string match $inferior_pty separate-inferior-tty] # Start SID. if { [info procs sid_start] != "" } { @@ -105,7 +119,7 @@ proc mi_gdb_start { } { sid_start } - verbose "Spawning $GDB -nw $GDBFLAGS $MIFLAGS" + verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS" if [info exists gdb_spawn_id] { return 0; @@ -117,19 +131,43 @@ proc mi_gdb_start { } { exit 1 } } - set res [remote_spawn host "$GDB -nw $GDBFLAGS $MIFLAGS [host_info gdb_opts]"]; + + # Create the new PTY for the inferior process. + if { $separate_inferior_pty } { + spawn -pty + global mi_inferior_spawn_id + global mi_inferior_tty_name + set mi_inferior_spawn_id $spawn_id + set mi_inferior_tty_name $spawn_out(slave,name) + } + + set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS [host_info gdb_opts]"]; if { $res < 0 || $res == "" } { perror "Spawning $GDB failed." return 1; } gdb_expect { - -re ".*$mi_gdb_prompt$" { + -re "~\"GNU.*\r\n~\".*$mi_gdb_prompt$" { + # We have a new format mi startup prompt. If we are + # running mi1, then this is an error as we should be + # using the old-style prompt. + if { $MIFLAGS == "-i=mi1" } { + perror "(mi startup) Got unexpected new mi prompt." + remote_close host; + return -1; + } verbose "GDB initialized." } - -re ".*$gdb_prompt $" { - untested "Skip mi tests (got non-mi prompt)." - remote_close host; - return -1; + -re "\[^~\].*$mi_gdb_prompt$" { + # We have an old format mi startup prompt. If we are + # not running mi1, then this is an error as we should be + # using the new-style prompt. + if { $MIFLAGS != "-i=mi1" } { + perror "(mi startup) Got unexpected old mi prompt." + remote_close host; + return -1; + } + verbose "GDB initialized." } -re ".*unrecognized option.*for a complete list of options." { untested "Skip mi tests (not compiled with mi support)." @@ -170,10 +208,33 @@ proc mi_gdb_start { } { warning "Couldn't set the width to 0." } } + # If allowing the inferior to have its own PTY then assign the inferior + # its own terminal device here. + if { $separate_inferior_pty } { + send_gdb "102-inferior-tty-set $mi_inferior_tty_name\n" + gdb_expect 10 { + -re ".*102\\\^done\r\n$mi_gdb_prompt$" { + verbose "redirect inferior output to new terminal device." + } + timeout { + warning "Couldn't redirect inferior output." 2 + } + } + } + + detect_async return 0; } +# +# Overridable function. You can override this function in your +# baseboard file. +# +proc mi_gdb_start { args } { + return [default_mi_gdb_start $args] +} + # Many of the tests depend on setting breakpoints at various places and # running until that breakpoint is reached. At times, we want to start # with a clean-slate with respect to breakpoints, so this utility proc @@ -190,10 +251,10 @@ proc mi_delete_breakpoints {} { send_gdb "y\n"; exp_continue } - -re ".*102-break-delete\r\n102\\\^done\r\n$mi_gdb_prompt$" { + -re "102-break-delete\r\n102\\\^done\r\n$mi_gdb_prompt$" { # This happens if there were no breakpoints } - timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return } + timeout { perror "Delete all breakpoints in mi_delete_breakpoints (timeout)" ; return } } # The correct output is not "No breakpoints or watchpoints." but an @@ -201,7 +262,7 @@ proc mi_delete_breakpoints {} { send_gdb "103-break-list\n" gdb_expect 30 { -re "103-break-list\r\n103\\\^done,BreakpointTable=\{\}\r\n$mi_gdb_prompt$" {} - -re "103-break-list\r\n103\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[\\\]\}" {} + -re "103-break-list\r\n103\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[\\\]\}\r\n$mi_gdb_prompt$" {} -re "103-break-list\r\n103\\\^doneNo breakpoints or watchpoints.\r\n\r\n$mi_gdb_prompt$" {warning "Unexpected console text received"} -re "$mi_gdb_prompt$" { perror "Breakpoints not deleted" ; return } -re "Delete all breakpoints.*or n.*$" { @@ -215,6 +276,7 @@ proc mi_delete_breakpoints {} { proc mi_gdb_reinitialize_dir { subdir } { global mi_gdb_prompt + global MIFLAGS global suppress_flag if { $suppress_flag } { @@ -225,8 +287,9 @@ proc mi_gdb_reinitialize_dir { subdir } { return ""; } - send_gdb "104-environment-directory\n" - gdb_expect 60 { + if { $MIFLAGS == "-i=mi1" } { + send_gdb "104-environment-directory\n" + gdb_expect 60 { -re ".*Reinitialize source path to empty.*y or n. " { warning "Got confirmation prompt for dir reinitialization." send_gdb "y\n" @@ -237,6 +300,14 @@ proc mi_gdb_reinitialize_dir { subdir } { } -re "$mi_gdb_prompt$" {} timeout {error "Dir reinitialization failed (timeout)"} + } + } else { + send_gdb "104-environment-directory -r\n" + gdb_expect 60 { + -re "104\\\^done,source-path=.*\r\n$mi_gdb_prompt$" {} + -re "$mi_gdb_prompt$" {} + timeout {error "Dir reinitialization failed (timeout)"} + } } send_gdb "105-environment-directory $subdir\n" @@ -244,7 +315,7 @@ proc mi_gdb_reinitialize_dir { subdir } { -re "Source directories searched.*$mi_gdb_prompt$" { verbose "Dir set to $subdir" } - -re "105\\\^done\r\n$mi_gdb_prompt$" { + -re "105\\\^done.*\r\n$mi_gdb_prompt$" { # FIXME: We return just the prompt for now. verbose "Dir set to $subdir" # perror "Dir \"$subdir\" failed." @@ -252,38 +323,95 @@ proc mi_gdb_reinitialize_dir { subdir } { } } +# Send GDB the "target" command. +# FIXME: Some of these patterns are not appropriate for MI. Based on +# config/monitor.exp:gdb_target_command. +proc mi_gdb_target_cmd { targetname serialport } { + global mi_gdb_prompt + + set serialport_re [string_to_regexp $serialport] + for {set i 1} {$i <= 3} {incr i} { + send_gdb "47-target-select $targetname $serialport\n" + gdb_expect 60 { + -re "47\\^connected.*$mi_gdb_prompt$" { + verbose "Set target to $targetname"; + return 0; + } + -re "unknown host.*$mi_gdb_prompt" { + verbose "Couldn't look up $serialport" + } + -re "Couldn't establish connection to remote.*$mi_gdb_prompt$" { + verbose "Connection failed"; + } + -re "Remote MIPS debugging.*$mi_gdb_prompt$" { + verbose "Set target to $targetname"; + return 0; + } + -re "Remote debugging using .*$serialport_re.*$mi_gdb_prompt$" { + verbose "Set target to $targetname"; + return 0; + } + -re "Remote target $targetname connected to.*$mi_gdb_prompt$" { + verbose "Set target to $targetname"; + return 0; + } + -re "Connected to.*$mi_gdb_prompt$" { + verbose "Set target to $targetname"; + return 0; + } + -re "Ending remote.*$mi_gdb_prompt$" { } + -re "Connection refused.*$mi_gdb_prompt$" { + verbose "Connection refused by remote target. Pausing, and trying again." + sleep 5 + continue + } + -re "Timeout reading from remote system.*$mi_gdb_prompt$" { + verbose "Got timeout error from gdb."; + } + timeout { + send_gdb ""; + break + } + } + } + return 1 +} + # -# load a file into the debugger. +# load a file into the debugger (file command only). # return a -1 if anything goes wrong. # -proc mi_gdb_load { arg } { +proc mi_gdb_file_cmd { arg } { global verbose global loadpath global loadfile global GDB global mi_gdb_prompt + global last_loaded_file upvar timeout timeout - # ``gdb_unload'' + set last_loaded_file $arg + + if [is_remote host] { + set arg [remote_download host $arg]; + if { $arg == "" } { + error "download failed" + return -1; + } + } - # ``gdb_file_cmd'' # FIXME: Several of these patterns are only acceptable for console # output. Queries are an error for mi. send_gdb "105-file-exec-and-symbols $arg\n" gdb_expect 120 { -re "Reading symbols from.*done.*$mi_gdb_prompt$" { verbose "\t\tLoaded $arg into the $GDB" - # All OK + return 0 } -re "has no symbol-table.*$mi_gdb_prompt$" { perror "$arg wasn't compiled with \"-g\"" return -1 } - -re "A program is being debugged already.*Kill it.*y or n. $" { - send_gdb "y\n" - verbose "\t\tKilling previous program being debugged" - exp_continue - } -re "Load new symbol table from \".*\".*y or n. $" { send_gdb "y\n" gdb_expect 120 { @@ -302,14 +430,15 @@ proc mi_gdb_load { arg } { return -1 } -re "105-file-exec-and-symbols .*\r\n105\\\^done\r\n$mi_gdb_prompt$" { - # We are just giving the prompt back for now - # All OK - } + # We (MI) are just giving the prompt back for now, instead of giving + # some acknowledgement. + return 0 + } timeout { perror "couldn't load $arg into $GDB (timed out)." return -1 } - eof { + eof { # This is an attempt to detect a core dump, but seems not to # work. Perhaps we need to match .* followed by eof, in which # gdb_expect does not seem to have a way to do that. @@ -317,13 +446,38 @@ proc mi_gdb_load { arg } { return -1 } } - - # ``load'' - if { [info procs send_target_sid] != "" } { +} + +# +# connect to the target and download a file, if necessary. +# return a -1 if anything goes wrong. +# +proc mi_gdb_target_load { } { + global verbose + global loadpath + global loadfile + global GDB + global mi_gdb_prompt + upvar timeout timeout + + if { [info procs gdbserver_gdb_load] != "" } { + mi_gdb_test "kill" ".*" "" + set res [gdbserver_gdb_load] + set protocol [lindex $res 0] + set gdbport [lindex $res 1] + + if { [mi_gdb_target_cmd $protocol $gdbport] != 0 } { + return -1 + } + } elseif { [info procs send_target_sid] != "" } { # For SID, things get complex + send_gdb "kill\n" + gdb_expect 10 { + -re ".*$mi_gdb_prompt$" + } send_target_sid gdb_expect 60 { - -re "\\^done,.*$mi_gdb_prompt$" { + -re "\\^done.*$mi_gdb_prompt$" { } timeout { perror "Unable to connect to SID target" @@ -359,20 +513,49 @@ proc mi_gdb_load { arg } { return -1 } } + } elseif { [target_info gdb_protocol] == "remote" } { + # remote targets + if { [mi_gdb_target_cmd "remote" [target_info netport]] != 0 } { + perror "Unable to connect to remote target" + return -1 + } + send_gdb "48-target-download\n" + gdb_expect 10 { + -re "48\\^done.*$mi_gdb_prompt$" { + } + timeout { + perror "Unable to download to remote target" + return -1 + } + } } return 0 } -# mi_gdb_test COMMAND PATTERN MESSAGE -- send a command to gdb; test the result. +# +# load a file into the debugger. +# return a -1 if anything goes wrong. +# +proc mi_gdb_load { arg } { + if { $arg != "" } { + return [mi_gdb_file_cmd $arg] + } + return 0 +} + +# mi_gdb_test COMMAND PATTERN MESSAGE [IPATTERN] -- send a command to gdb; +# test the result. # # COMMAND is the command to execute, send to GDB with send_gdb. If # this is the null string no command is sent. # PATTERN is the pattern to match for a PASS, and must NOT include # the \r\n sequence immediately before the gdb prompt. -# MESSAGE is an optional message to be printed. If this is -# omitted, then the pass/fail messages use the command string as the -# message. (If this is the empty string, then sometimes we don't -# call pass or fail at all; I don't understand this at all.) +# MESSAGE is the message to be printed. (If this is the empty string, +# then sometimes we don't call pass or fail at all; I don't +# understand this at all.) +# IPATTERN is the pattern to match for the inferior's output. This parameter +# is optional. If present, it will produce a PASS if the match is +# successful, and a FAIL if unsuccessful. # # Returns: # 1 if the test failed, @@ -382,16 +565,16 @@ proc mi_gdb_load { arg } { proc mi_gdb_test { args } { global verbose global mi_gdb_prompt - global GDB + global GDB expect_out upvar timeout timeout - if [llength $args]>2 then { - set message [lindex $args 2] - } else { - set message [lindex $args 0] - } set command [lindex $args 0] set pattern [lindex $args 1] + set message [lindex $args 2] + + if [llength $args]==4 { + set ipattern [lindex $args 3] + } if [llength $args]==5 { set question_string [lindex $args 3]; @@ -408,6 +591,8 @@ proc mi_gdb_test { args } { set result -1 set string "${command}\n"; + set string_regex [string_to_regexp $command] + if { $command != "" } { while { "$string" != "" } { set foo [string first "\n" "$string"]; @@ -455,6 +640,7 @@ proc mi_gdb_test { args } { set tmt 60; } } + verbose -log "Expecting: ^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)" gdb_expect $tmt { -re "\\*\\*\\* DOSEXIT code.*" { if { $message != "" } { @@ -470,6 +656,24 @@ proc mi_gdb_test { args } { gdb_exit gdb_start set result -1 + } + -re "^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)" { + # At this point, $expect_out(1,string) is the MI input command. + # and $expect_out(2,string) is the MI output command. + # If $expect_out(1,string) is "", then there was no MI input command here. + + # NOTE, there is no trailing anchor because with GDB/MI, + # asynchronous responses can happen at any point, causing more + # data to be available. Normally an anchor is used to make + # sure the end of the output is matched, however, $mi_gdb_prompt + # is just as good of an anchor since mi_gdb_test is meant to + # match a single mi output command. If a second GDB/MI output + # response is sent, it will be in the buffer for the next + # time mi_gdb_test is called. + if ![string match "" $message] then { + pass "$message" + } + set result 0 } -re "(${question_string})$" { send_gdb "$response_string\n"; @@ -484,27 +688,21 @@ proc mi_gdb_test { args } { perror "\"$command\" is not a unique command name." fail "$message" set result 1 - } - -re "\[\r\n\]*($pattern)\[\r\n\]+$mi_gdb_prompt\[ \]*$" { - if ![string match "" $message] then { - pass "$message" - } - set result 0 } -re "Program exited with code \[0-9\]+.*$mi_gdb_prompt\[ \]*$" { if ![string match "" $message] then { - set errmsg "$message: the program exited" + set errmsg "$message (the program exited)" } else { - set errmsg "$command: the program exited" + set errmsg "$command (the program exited)" } fail "$errmsg" return -1 } -re "The program is not being run.*$mi_gdb_prompt\[ \]*$" { if ![string match "" $message] then { - set errmsg "$message: the program is no longer running" + set errmsg "$message (the program is no longer running)" } else { - set errmsg "$command: the program is no longer running" + set errmsg "$command (the program is no longer running)" } fail "$errmsg" return -1 @@ -543,6 +741,27 @@ proc mi_gdb_test { args } { set result 1 } } + + # If the GDB output matched, compare the inferior output. + if { $result == 0 } { + if [ info exists ipattern ] { + if { ![target_info exists gdb,noinferiorio] } { + global mi_inferior_spawn_id + expect { + -i $mi_inferior_spawn_id -re "$ipattern" { + pass "$message inferior output" + } + timeout { + fail "$message inferior output (timeout)" + set result 1 + } + } + } else { + unsupported "$message inferior output" + } + } + } + return $result } @@ -559,6 +778,8 @@ proc mi_run_cmd {args} { return -1 } global mi_gdb_prompt + global thread_selected_re + global library_loaded_re if [target_info exists gdb_init_command] { send_gdb "[target_info gdb_init_command]\n"; @@ -571,16 +792,15 @@ proc mi_run_cmd {args} { } } + if { [mi_gdb_target_load] < 0 } { + return + } + if [target_info exists use_gdb_stub] { if [target_info exists gdb,do_reload_on_run] { - # Specifying no file, defaults to the executable - # currently being debugged. - if { [mi_gdb_load ""] < 0 } { - return; - } - send_gdb "000-exec-continue\n"; + send_gdb "220-exec-continue\n"; gdb_expect 60 { - -re "Continu\[^\r\n\]*\[\r\n\]" {} + -re "220\\^running\[\r\n\]+\\*running,thread-id=\"\[^\"\]+\"\r\n$mi_gdb_prompt" {} default {} } return; @@ -599,16 +819,16 @@ proc mi_run_cmd {args} { return } - send_gdb "000-exec-run $args\n" + send_gdb "220-exec-run $args\n" gdb_expect { - -re "000\\^running\r\n${mi_gdb_prompt}" { + -re "220\\^running\r\n(\\*running,thread-id=\"\[^\"\]+\"\r\n|=thread-created,id=\"1\",group-id=\"\[0-9\]+\"\r\n)*(${library_loaded_re})*(${thread_selected_re})?${mi_gdb_prompt}" { } timeout { perror "Unable to start target" return } } - # NOTE: Shortly after this there will be a ``000*stopping,...(gdb)'' + # NOTE: Shortly after this there will be a ``000*stopped,...(gdb)'' } # @@ -621,78 +841,239 @@ proc mi_run_to_main { } { return -1 } - global mi_gdb_prompt - global hex - global decimal global srcdir global subdir global binfile global srcfile - set test "mi run-to-main" mi_delete_breakpoints mi_gdb_reinitialize_dir $srcdir/$subdir mi_gdb_load ${binfile} - mi_gdb_test "200-break-insert main" \ - "200\\^done,bkpt=\{number=\"1\",type=\"breakpoint\",disp=\"keep\",enabled=\"y\",addr=\"$hex\",func=\"main\",file=\".*\",line=\"\[0-9\]*\",times=\"0\"\}" \ - "breakpoint at main" + mi_runto main +} - mi_run_cmd - gdb_expect { - -re "000\\*stopped,reason=\"breakpoint-hit\",bkptno=\"1\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\"main\",args=\(\\\[\\\]\|\{\}\),file=\".*\",line=\"\[0-9\]*\"\}\r\n$mi_gdb_prompt$" { - pass "$test" - return 0 - } - -re ".*$mi_gdb_prompt$" { - fail "$test (2)" - } - timeout { - fail "$test (timeout)" - return -1 - } - } + +# Just like gdb's "runto" proc, it will run the target to a given +# function. The big difference here between mi_runto and mi_execute_to +# is that mi_execute_to must have the inferior running already. This +# proc will (like gdb's runto) (re)start the inferior, too. +# +# FUNC is the linespec of the place to stop (it inserts a breakpoint here). +# It returns: +# -1 if test suppressed, failed, timedout +# 0 if test passed + +proc mi_runto_helper {func run_or_continue} { + global suppress_flag + if { $suppress_flag } { + return -1 + } + + global mi_gdb_prompt expect_out + global hex decimal fullname_syntax + + set test "mi runto $func" + mi_gdb_test "200-break-insert -t $func" \ + "200\\^done,bkpt=\{number=\"\[0-9\]+\",type=\"breakpoint\",disp=\"del\",enabled=\"y\",addr=\"$hex\",func=\"$func\(\\\(.*\\\)\)?\",file=\".*\",line=\"\[0-9\]*\",times=\"0\",original-location=\".*\"\}" \ + "breakpoint at $func" + + if {![regexp {number="[0-9]+"} $expect_out(buffer) str] + || ![scan $str {number="%d"} bkptno]} { + set bkptno {[0-9]+} + } + + if {$run_or_continue == "run"} { + mi_run_cmd + } else { + mi_send_resuming_command "exec-continue" "$test" + } + + mi_expect_stop "breakpoint-hit" $func ".*" ".*" "\[0-9\]+" { "" "disp=\"del\"" } $test } +proc mi_runto {func} { + mi_runto_helper $func "run" +} # Next to the next statement +# For return values, see mi_execute_to_helper proc mi_next { test } { - global suppress_flag - if { $suppress_flag } { - return -1 + return [mi_next_to {.*} {.*} {.*} {.*} $test] +} + + +# Step to the next statement +# For return values, see mi_execute_to_helper + +proc mi_step { test } { + return [mi_step_to {.*} {.*} {.*} {.*} $test] +} + +set async "unknown" + +proc detect_async {} { + global async + global mi_gdb_prompt + + send_gdb "show target-async\n" + + gdb_expect { + -re ".*Controlling the inferior in asynchronous mode is on...*$mi_gdb_prompt$" { + set async 1 + } + -re ".*$mi_gdb_prompt$" { + set async 0 + } + timeout { + set async 0 + } } + return $async +} + +# Wait for MI *stopped notification to appear. +# The REASON, FUNC, ARGS, FILE and LINE are regular expressions +# to match against whatever is output in *stopped. ARGS should +# not include [] the list of argument is enclosed in, and other +# regular expressions should not include quotes. +# If EXTRA is a list of one element, it's the regular expression +# for output expected right after *stopped, and before GDB prompt. +# If EXTRA is a list of two elements, the first element is for +# output right after *stopped, and the second element is output +# right after reason field. The regex after reason should not include +# the comma separating it from the following fields. +# +# When we fail to match output at all, -1 is returned. Otherwise, +# the line at which we stop is returned. This is useful when exact +# line is not possible to specify for some reason -- one can pass +# the .* or "\[0-9\]*" regexps for line, and then check the line +# programmatically. +# +# Do not pass .* for any argument if you are expecting more than one stop. +proc mi_expect_stop { reason func args file line extra test } { + global mi_gdb_prompt - send_gdb "220-exec-next\n" + global hex + global decimal + global fullname_syntax + global async + global thread_selected_re + + set after_stopped "" + set after_reason "" + if { [llength $extra] == 2 } { + set after_stopped [lindex $extra 0] + set after_reason [lindex $extra 1] + set after_reason "${after_reason}," + } elseif { [llength $extra] == 1 } { + set after_stopped [lindex $extra 0] + } + + if {$async} { + set prompt_re "" + } else { + set prompt_re "$mi_gdb_prompt$" + } + + if { $reason == "really-no-reason" } { + gdb_expect { + -re "\\*stopped\r\n$prompt_re" { + pass "$test" + } + timeout { + fail "$test (unknown output after running)" + } + } + return + } + + if { $reason == "exited-normally" } { + + gdb_expect { + -re "\\*stopped,reason=\"exited-normally\"\r\n$prompt_re" { + pass "$test" + } + -re ".*$mi_gdb_prompt$" {fail "continue to end (2)"} + timeout { + fail "$test (unknown output after running)" + } + } + return + } + + set args "\\\[$args\\\]" + + set bn "" + if { $reason == "breakpoint-hit" } { + set bn {bkptno="[0-9]+",} + } + + set r "" + if { $reason != "" } { + set r "reason=\"$reason\"," + } + + + set a $after_reason + + set any "\[^\n\]*" + + verbose -log "mi_expect_stop: expecting: \\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$func\",args=$args,file=\"$any$file\",fullname=\"${fullname_syntax}$file\",line=\"$line\"\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re)?$prompt_re" gdb_expect { - -re "220\\^running\r\n${mi_gdb_prompt}220\\*stopped,reason=\"end-stepping-range\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\".*\",args=\[\\\[\{].*[\\\]\}\],file=\".*\",line=\"\[0-9\]*\"\}\r\n$mi_gdb_prompt$" { + -re "\\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$func\",args=$args,file=\"$any$file\",fullname=\"${fullname_syntax}$file\",line=\"($line)\"\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re)?$prompt_re" { pass "$test" - return 0 + return $expect_out(2,string) + } + -re "\\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$any\",args=\[\\\[\{\]$any\[\\\]\}\],file=\"$any\",fullname=\"${fullname_syntax}$any\",line=\"\[0-9\]*\"\}thread-id=\"$decimal\",stopped-threads=$any\r\n$prompt_re" { + verbose -log "got $expect_out(buffer)" + fail "$test (stopped at wrong place)" + return -1 + } + -re ".*\r\n$mi_gdb_prompt$" { + verbose -log "got $expect_out(buffer)" + fail "$test (unknown output after running)" + return -1 } timeout { - fail "$test" + fail "$test (timeout)" return -1 } - } + } } +# Wait for MI *stopped notification related to an interrupt request to +# appear. +proc mi_expect_interrupt { test } { + global mi_gdb_prompt + global decimal + global async -# Step to the next statement - -proc mi_step { test } { - global suppress_flag - if { $suppress_flag } { - return -1 + if {$async} { + set prompt_re "" + } else { + set prompt_re "$mi_gdb_prompt$" } - global mi_gdb_prompt - send_gdb "220-exec-step\n" + + set r "reason=\"signal-received\",signal-name=\"0\",signal-meaning=\"Signal 0\"" + + set any "\[^\n\]*" + + # A signal can land anywhere, just ignore the location + verbose -log "mi_expect_interrupt: expecting: \\*stopped,${r}$any\r\n$prompt_re" gdb_expect { - -re "220\\^running\r\n${mi_gdb_prompt}220\\*stopped,reason=\"end-stepping-range\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\".*\",args=\[\\\[\{\].*\[\\\]\}\],file=\".*\",line=\"\[0-9\]*\"\}\r\n$mi_gdb_prompt$" { + -re "\\*stopped,${r}$any\r\n$prompt_re" { pass "$test" - return 0 + return 0; + } + -re ".*\r\n$mi_gdb_prompt$" { + verbose -log "got $expect_out(buffer)" + fail "$test (unknown output after running)" + return -1 } timeout { - fail "$test" + fail "$test (timeout)" return -1 } } @@ -704,85 +1085,688 @@ proc mi_step { test } { # Can not match -re ".*\r\n${mi_gdb_prompt}", because of false positives # after the first prompt is printed. -proc mi_run_to_helper { cmd reason func args file line extra test } { +proc mi_execute_to { cmd reason func args file line extra test } { global suppress_flag if { $suppress_flag } { return -1 } - global mi_gdb_prompt - global hex - global decimal - send_gdb "220-$cmd\n" - gdb_expect { - -re "220\\^running\r\n${mi_gdb_prompt}220\\*stopped,reason=\"$reason\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\"$func\",args=$args,file=\".*$file\",line=\"$line\"\}$extra\r\n$mi_gdb_prompt$" { - pass "$test" - return 0 - } - -re "220\\^running\r\n${mi_gdb_prompt}220\\*stopped,reason=\"$reason\",thread-id=\"$decimal\",frame=\{addr=\"$hex\",func=\".*\",args=\[\\\[\{\].*\[\\\]\}\],file=\".*\",line=\"\[0-9\]*\"\}.*\r\n$mi_gdb_prompt$" { - fail "$test (stopped at wrong place)" - return -1 - } - -re "220\\^running\r\n${mi_gdb_prompt}.*\r\n${mi_gdb_prompt}$" { - fail "$test (unknown output after running)" - return -1 - } - timeout { - fail "$test (timeout)" - return -1 - } - } -} -proc mi_run_to { cmd reason func args file line extra test } { - mi_run_to_helper "$cmd" "$reason" "$func" "\\\[$args\\\]" \ - "$file" "$line" "$extra" "$test" + mi_send_resuming_command "$cmd" "$test" + set r [mi_expect_stop $reason $func $args $file $line $extra $test] + return $r } proc mi_next_to { func args file line test } { - mi_run_to "exec-next" "end-stepping-range" "$func" "$args" \ + mi_execute_to "exec-next" "end-stepping-range" "$func" "$args" \ "$file" "$line" "" "$test" } proc mi_step_to { func args file line test } { - mi_run_to "exec-step" "end-stepping-range" "$func" "$args" \ + mi_execute_to "exec-step" "end-stepping-range" "$func" "$args" \ "$file" "$line" "" "$test" } proc mi_finish_to { func args file line result ret test } { - mi_run_to "exec-finish" "function-finished" "$func" "$args" \ + mi_execute_to "exec-finish" "function-finished" "$func" "$args" \ "$file" "$line" \ ",gdb-result-var=\"$result\",return-value=\"$ret\"" \ "$test" } -proc mi_continue_to { bkptno func args file line test } { - mi_run_to "exec-continue" "breakpoint-hit\",bkptno=\"$bkptno" \ - "$func" "$args" "$file" "$line" "" "$test" +proc mi_continue_to {func} { + mi_runto_helper $func "continue" } -proc mi0_run_to { cmd reason func args file line extra test } { - mi_run_to_helper "$cmd" "$reason" "$func" "\{$args\}" \ +proc mi0_execute_to { cmd reason func args file line extra test } { + mi_execute_to_helper "$cmd" "$reason" "$func" "\{$args\}" \ "$file" "$line" "$extra" "$test" } proc mi0_next_to { func args file line test } { - mi0_run_to "exec-next" "end-stepping-range" "$func" "$args" \ + mi0_execute_to "exec-next" "end-stepping-range" "$func" "$args" \ "$file" "$line" "" "$test" } proc mi0_step_to { func args file line test } { - mi0_run_to "exec-step" "end-stepping-range" "$func" "$args" \ + mi0_execute_to "exec-step" "end-stepping-range" "$func" "$args" \ "$file" "$line" "" "$test" } proc mi0_finish_to { func args file line result ret test } { - mi0_run_to "exec-finish" "function-finished" "$func" "$args" \ + mi0_execute_to "exec-finish" "function-finished" "$func" "$args" \ "$file" "$line" \ ",gdb-result-var=\"$result\",return-value=\"$ret\"" \ "$test" } proc mi0_continue_to { bkptno func args file line test } { - mi0_run_to "exec-continue" "breakpoint-hit\",bkptno=\"$bkptno" \ + mi0_execute_to "exec-continue" "breakpoint-hit\",bkptno=\"$bkptno" \ "$func" "$args" "$file" "$line" "" "$test" } + +# Creates a breakpoint and checks the reported fields are as expected +proc mi_create_breakpoint { location number disp func file line address test } { + verbose -log "Expecting: 222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",times=\"0\",original-location=\".*\"\}" + mi_gdb_test "222-break-insert $location" \ + "222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",times=\"0\",original-location=\".*\"\}" \ + $test +} + +proc mi_list_breakpoints { expected test } { + set fullname ".*" + + set body "" + set first 1 + + foreach item $children { + if {$first == 0} { + set body "$body," + } + set number disp func file line address + set number [lindex $item 0] + set disp [lindex $item 1] + set func [lindex $item 2] + set line [lindex $item 3] + set address [lindex $item 4] + set body "$body,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",${fullname},line=\"$line\",times=\"0\",original-location=\".*\"\}" + set first 0 + } + + verbose -log "Expecint: 666\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[$body\\\]\}" \ + mi_gdb_test "666-break-list" \ + "666\\\^done,BreakpointTable=\{nr_rows=\".\",nr_cols=\".\",hdr=\\\[\{width=\".*\",alignment=\".*\",col_name=\"number\",colhdr=\"Num\"\}.*colhdr=\"Type\".*colhdr=\"Disp\".*colhdr=\"Enb\".*colhdr=\"Address\".*colhdr=\"What\".*\\\],body=\\\[$body\\\]\}" \ + $test +} + +# Creates varobj named NAME for EXPRESSION. +# Name cannot be "-". +proc mi_create_varobj { name expression testname } { + mi_gdb_test "-var-create $name * $expression" \ + "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=.*" \ + $testname +} + +proc mi_create_floating_varobj { name expression testname } { + mi_gdb_test "-var-create $name @ $expression" \ + "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=.*" \ + $testname +} + + +# Same as mi_create_varobj, but also checks the reported type +# of the varobj. +proc mi_create_varobj_checked { name expression type testname } { + mi_gdb_test "-var-create $name * $expression" \ + "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=\"$type\".*" \ + $testname +} + +# Deletes the specified NAME. +proc mi_delete_varobj { name testname } { + mi_gdb_test "-var-delete $name" \ + "\\^done,ndeleted=.*" \ + $testname +} + +# Updates varobj named NAME and checks that all varobjs in EXPECTED +# are reported as updated, and no other varobj is updated. +# Assumes that no varobj is out of scope and that no varobj changes +# types. +proc mi_varobj_update { name expected testname } { + set er "\\^done,changelist=\\\[" + set first 1 + foreach item $expected { + set v "{name=\"$item\",in_scope=\"true\",type_changed=\"false\"}" + if {$first == 1} { + set er "$er$v" + set first 0 + } else { + set er "$er,$v" + } + } + set er "$er\\\]" + + verbose -log "Expecting: $er" 2 + mi_gdb_test "-var-update $name" $er $testname +} + +proc mi_varobj_update_with_type_change { name new_type new_children testname } { + set v "{name=\"$name\",in_scope=\"true\",type_changed=\"true\",new_type=\"$new_type\",new_num_children=\"$new_children\"}" + set er "\\^done,changelist=\\\[$v\\\]" + verbose -log "Expecting: $er" + mi_gdb_test "-var-update $name" $er $testname +} + +proc mi_check_varobj_value { name value testname } { + + mi_gdb_test "-var-evaluate-expression $name" \ + "\\^done,value=\"$value\"" \ + $testname +} + +# Check the results of the: +# +# -var-list-children VARNAME +# +# command. The CHILDREN parement should be a list of lists. +# Each inner list can have either 3 or 4 elements, describing +# fields that gdb is expected to report for child variable object, +# in the following order +# +# - Name +# - Expression +# - Number of children +# - Type +# +# If inner list has 3 elements, the gdb is expected to output no +# type for a child and no value. +# +# If the inner list has 4 elements, gdb output is expected to +# have no value. +# +proc mi_list_varobj_children { varname children testname } { + + set options "" + if {[llength $varname] == 2} { + set options [lindex $varname 1] + set varname [lindex $varname 0] + } + + set numchildren [llength $children] + set children_exp {} + set whatever "\"\[^\"\]+\"" + + foreach item $children { + + set name [lindex $item 0] + set exp [lindex $item 1] + set numchild [lindex $item 2] + if {[llength $item] == 5} { + set type [lindex $item 3] + set value [lindex $item 4] + + lappend children_exp\ + "child={name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",value=\"$value\",type=\"$type\"\(,thread-id=\"\[0-9\]+\")?}" + } elseif {[llength $item] == 4} { + set type [lindex $item 3] + + lappend children_exp\ + "child={name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",type=\"$type\"\(,thread-id=\"\[0-9\]+\")?}" + } else { + lappend children_exp\ + "child={name=\"$name\",exp=\"$exp\",numchild=\"$numchild\"(,thread-id=\"\[0-9\]+\")?}" + } + } + set children_exp_j [join $children_exp ","] + if {$numchildren} { + set expected "\\^done,numchild=\".*\",children=\\\[$children_exp_j.*\\\]" + } { + set expected "\\^done,numchild=\"0\"" + } + + verbose -log "Expecting: $expected" + + mi_gdb_test "-var-list-children $options $varname" $expected $testname +} + +# Verifies that variable object VARNAME has NUMBER children, +# where each one is named $VARNAME. and has type TYPE. +proc mi_list_array_varobj_children { varname number type testname } { + set t {} + for {set i 0} {$i < $number} {incr i} { + lappend t [list $varname.$i $i 0 $type] + } + mi_list_varobj_children $varname $t $testname +} + +# A list of two-element lists. First element of each list is +# a Tcl statement, and the second element is the line +# number of source C file where the statement originates. +set mi_autotest_data "" +# The name of the source file for autotesting. +set mi_autotest_source "" + +proc count_newlines { string } { + return [regexp -all "\n" $string] +} + +# Prepares for running inline tests in FILENAME. +# See comments for mi_run_inline_test for detailed +# explanation of the idea and syntax. +proc mi_prepare_inline_tests { filename } { + + global srcdir + global subdir + global mi_autotest_source + global mi_autotest_data + + set mi_autotest_data {} + + set mi_autotest_source $filename + + if { ! [regexp "^/" "$filename"] } then { + set filename "$srcdir/$subdir/$filename" + } + + set chan [open $filename] + set content [read $chan] + set line_number 1 + while {1} { + set start [string first "/*:" $content] + if {$start != -1} { + set end [string first ":*/" $content] + if {$end == -1} { + error "Unterminated special comment in $filename" + } + + set prefix [string range $content 0 $start] + set prefix_newlines [count_newlines $prefix] + + set line_number [expr $line_number+$prefix_newlines] + set comment_line $line_number + + set comment [string range $content [expr $start+3] [expr $end-1]] + + set comment_newlines [count_newlines $comment] + set line_number [expr $line_number+$comment_newlines] + + set comment [string trim $comment] + set content [string range $content [expr $end+3] \ + [string length $content]] + lappend mi_autotest_data [list $comment $comment_line] + } else { + break + } + } + close $chan +} + +# Helper to mi_run_inline_test below. +# Return the list of all (statement,line_number) lists +# that comprise TESTCASE. The begin and end markers +# are not included. +proc mi_get_inline_test {testcase} { + + global mi_gdb_prompt + global mi_autotest_data + global mi_autotest_source + + set result {} + + set seen_begin 0 + set seen_end 0 + foreach l $mi_autotest_data { + + set comment [lindex $l 0] + + if {$comment == "BEGIN: $testcase"} { + set seen_begin 1 + } elseif {$comment == "END: $testcase"} { + set seen_end 1 + break + } elseif {$seen_begin==1} { + lappend result $l + } + } + + if {$seen_begin == 0} { + error "Autotest $testcase not found" + } + + if {$seen_begin == 1 && $seen_end == 0} { + error "Missing end marker for test $testcase" + } + + return $result +} + +# Sets temporary breakpoint at LOCATION. +proc mi_tbreak {location} { + + global mi_gdb_prompt + + mi_gdb_test "-break-insert -t $location" \ + {\^done,bkpt=.*} \ + "run to $location (set breakpoint)" +} + +# Send COMMAND that must be a command that resumes +# the inferiour (run/continue/next/etc) and consumes +# the "^running" output from it. +proc mi_send_resuming_command_raw {command test} { + + global mi_gdb_prompt + global thread_selected_re + global library_loaded_re + + send_gdb "$command\n" + gdb_expect { + -re "\\^running\r\n\\*running,thread-id=\"\[^\"\]+\"\r\n($library_loaded_re)*($thread_selected_re)?${mi_gdb_prompt}" { + # Note that lack of 'pass' call here -- this works around limitation + # in DejaGNU xfail mechanism. mi-until.exp has this: + # + # setup_kfail gdb/2104 "*-*-*" + # mi_execute_to ... + # + # and mi_execute_to uses mi_send_resuming_command. If we use 'pass' here, + # it will reset kfail, so when the actual test fails, it will be flagged + # as real failure. + return 0 + } + -re ".*${mi_gdb_prompt}" { + fail "$test (failed to resume)" + return -1 + } + -re "\\^error,msg=.*" { + fail "$test (MI error)" + return -1 + } + timeout { + fail "$test" + return -1 + } + } +} + +proc mi_send_resuming_command {command test} { + mi_send_resuming_command_raw -$command $test +} + +# Helper to mi_run_inline_test below. +# Sets a temporary breakpoint at LOCATION and runs +# the program using COMMAND. When the program is stopped +# returns the line at which it. Returns -1 if line cannot +# be determined. +# Does not check that the line is the same as requested. +# The caller can check itself if required. +proc mi_continue_to_line {location test} { + + mi_tbreak $location + mi_send_resuming_command "exec-continue" "run to $location (exec-continue)" + return [mi_get_stop_line $test] +} + +# Wait until gdb prints the current line. +proc mi_get_stop_line {test} { + + global mi_gdb_prompt + global async + + if {$async} { + set prompt_re "" + } else { + set prompt_re "$mi_gdb_prompt$" + } + + gdb_expect { + -re ".*line=\"(\[0-9\]*)\".*\r\n$prompt_re" { + return $expect_out(1,string) + } + -re ".*$mi_gdb_prompt" { + fail "wait for stop ($test)" + } + timeout { + fail "wait for stop ($test)" + } + } +} + +# Run a MI test embedded in comments in a C file. +# The C file should contain special comments in the following +# three forms: +# +# /*: BEGIN: testname :*/ +# /*: :*/ +# /*: END: testname :*/ +# +# This procedure find the begin and end marker for the requested +# test. Then, a temporary breakpoint is set at the begin +# marker and the program is run (from start). +# +# After that, for each special comment between the begin and end +# marker, the Tcl statements are executed. It is assumed that +# for each comment, the immediately preceding line is executable +# C statement. Then, gdb will be single-stepped until that +# preceding C statement is executed, and after that the +# Tcl statements in the comment will be executed. +# +# For example: +# +# /*: BEGIN: assignment-test :*/ +# v = 10; +# /*: 0} { + fail "MI and console have same threads ($name)" + + # Send a list of failures to the log + send_log "Console has thread ids: $console_thread_list\n" + send_log "MI has thread ids: $mi_thread_list\n" + } else { + pass "MI and console have same threads ($name)" + } + } + } + } +} + +proc mi_load_shlibs { args } { + if {![is_remote target]} { + return + } + + foreach file $args { + gdb_download $file + } + + # Even if the target supplies full paths for shared libraries, + # they may not be paths for this system. + mi_gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "\^done" "" +} + +proc mi_reverse_list { list } { + if { [llength $list] <= 1 } { + return $list + } + set tail [lrange $list 1 [llength $list]] + set rtail [mi_reverse_list $tail] + lappend rtail [lindex $list 0] + return $rtail +} + +proc mi_check_thread_states { xstates test } { + global expect_out + set states [mi_reverse_list $xstates] + set pattern "\\^done,threads=\\\[" + foreach s $states { + set pattern "${pattern}(.*)state=\"$s\"" + } + set pattern "$pattern\\\}\\\].*" + + verbose -log "expecting: $pattern" + mi_gdb_test "-thread-info" $pattern $test +}