1 # Copyright 1999-2013 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was based on a file written by Fred Fish. (fnf@cygnus.com)
18 # Test setup routines that work with the MI interpreter.
20 # The variable mi_gdb_prompt is a regexp which matches the gdb mi prompt.
21 # Set it if it is not already set.
23 if ![info exists mi_gdb_prompt] then {
24 set mi_gdb_prompt "\[(\]gdb\[)\] \r\n"
27 global mi_inferior_spawn_id
28 global mi_inferior_tty_name
32 set thread_selected_re "=thread-selected,id=\"\[0-9\]+\"\r\n"
33 set gdbindex_warning_re "&\"warning: Skipping \[^\r\n\]+ \.gdb_index section in \[^\r\n\]+\"\r\n(?:&\"\\\\n\"\r\n)?"
34 set library_loaded_re "=library-loaded\[^\n\]+\"\r\n(?:$gdbindex_warning_re)?"
35 set breakpoint_re "=(?:breakpoint-created|breakpoint-deleted)\[^\n\]+\"\r\n"
38 # mi_gdb_exit -- exit the GDB, killing the target program if necessary
41 catch mi_uncatched_gdb_exit
44 proc mi_uncatched_gdb_exit {} {
46 global INTERNAL_GDBFLAGS GDBFLAGS
53 gdb_stop_suppressing_tests
55 if { [info procs sid_exit] != "" } {
59 if ![info exists gdb_spawn_id] {
63 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS"
65 if { [is_remote host] && [board_info host exists fileid] } {
66 send_gdb "999-gdb-exit\n"
72 -re "Undefined command.*$gdb_prompt $" {
76 -re "DOSEXIT code" { }
81 if ![is_remote host] {
88 # default_mi_gdb_start [INFERIOR_PTY] -- start gdb running, default procedure
90 # INFERIOR_PTY should be set to separate-inferior-tty to have the inferior work
91 # with it's own PTY. If set to same-inferior-tty, the inferior shares GDB's PTY.
92 # The default value is same-inferior-tty.
94 # When running over NFS, particularly if running many simultaneous
95 # tests on different hosts all using the same server, things can
96 # get really slow. Give gdb at least 3 minutes to start up.
98 proc default_mi_gdb_start { args } {
99 global verbose use_gdb_stub
101 global INTERNAL_GDBFLAGS GDBFLAGS
108 gdb_stop_suppressing_tests
109 set inferior_pty no-tty
111 # Set the default value, it may be overriden later by specific testfile.
112 set use_gdb_stub [target_info exists use_gdb_stub]
114 if { [llength $args] == 1} {
115 set inferior_pty [lindex $args 0]
118 set separate_inferior_pty [string match $inferior_pty separate-inferior-tty]
121 if { [info procs sid_start] != "" } {
122 verbose "Spawning SID"
126 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS"
128 if [info exists gdb_spawn_id] {
132 if ![is_remote host] {
133 if { [which $GDB] == 0 } then {
134 perror "$GDB does not exist."
139 # Create the new PTY for the inferior process.
140 if { $separate_inferior_pty } {
142 global mi_inferior_spawn_id
143 global mi_inferior_tty_name
144 set mi_inferior_spawn_id $spawn_id
145 set mi_inferior_tty_name $spawn_out(slave,name)
148 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS $MIFLAGS [host_info gdb_opts]"]
149 if { $res < 0 || $res == "" } {
150 perror "Spawning $GDB failed."
154 -re "~\"GNU.*\r\n~\".*$mi_gdb_prompt$" {
155 # We have a new format mi startup prompt. If we are
156 # running mi1, then this is an error as we should be
157 # using the old-style prompt.
158 if { $MIFLAGS == "-i=mi1" } {
159 perror "(mi startup) Got unexpected new mi prompt."
163 verbose "GDB initialized."
165 -re "\[^~\].*$mi_gdb_prompt$" {
166 # We have an old format mi startup prompt. If we are
167 # not running mi1, then this is an error as we should be
168 # using the new-style prompt.
169 if { $MIFLAGS != "-i=mi1" } {
170 perror "(mi startup) Got unexpected old mi prompt."
174 verbose "GDB initialized."
176 -re ".*unrecognized option.*for a complete list of options." {
177 untested "Skip mi tests (not compiled with mi support)."
181 -re ".*Interpreter `mi' unrecognized." {
182 untested "Skip mi tests (not compiled with mi support)."
187 perror "(timeout) GDB never initialized after 10 seconds."
194 # FIXME: mi output does not go through pagers, so these can be removed.
195 # force the height to "unlimited", so no pagers get used
196 send_gdb "100-gdb-set height 0\n"
198 -re ".*100-gdb-set height 0\r\n100\\\^done\r\n$mi_gdb_prompt$" {
199 verbose "Setting height to 0." 2
202 warning "Couldn't set the height to 0"
205 # force the width to "unlimited", so no wraparound occurs
206 send_gdb "101-gdb-set width 0\n"
208 -re ".*101-gdb-set width 0\r\n101\\\^done\r\n$mi_gdb_prompt$" {
209 verbose "Setting width to 0." 2
212 warning "Couldn't set the width to 0."
215 # If allowing the inferior to have its own PTY then assign the inferior
216 # its own terminal device here.
217 if { $separate_inferior_pty } {
218 send_gdb "102-inferior-tty-set $mi_inferior_tty_name\n"
220 -re ".*102\\\^done\r\n$mi_gdb_prompt$" {
221 verbose "redirect inferior output to new terminal device."
224 warning "Couldn't redirect inferior output." 2
235 # Overridable function. You can override this function in your
238 proc mi_gdb_start { args } {
239 return [default_mi_gdb_start $args]
242 # Many of the tests depend on setting breakpoints at various places and
243 # running until that breakpoint is reached. At times, we want to start
244 # with a clean-slate with respect to breakpoints, so this utility proc
245 # lets us do this without duplicating this code everywhere.
248 proc mi_delete_breakpoints {} {
251 # FIXME: The mi operation won't accept a prompt back and will use the 'all' arg
252 send_gdb "102-break-delete\n"
254 -re "Delete all breakpoints.*y or n.*$" {
258 -re "102-break-delete\r\n102\\\^done\r\n$mi_gdb_prompt$" {
259 # This happens if there were no breakpoints
261 timeout { perror "Delete all breakpoints in mi_delete_breakpoints (timeout)" ; return }
264 # The correct output is not "No breakpoints or watchpoints." but an
265 # empty BreakpointTable. Also, a query is not acceptable with mi.
266 send_gdb "103-break-list\n"
268 -re "103-break-list\r\n103\\\^done,BreakpointTable=\{\}\r\n$mi_gdb_prompt$" {}
269 -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$" {}
270 -re "103-break-list\r\n103\\\^doneNo breakpoints or watchpoints.\r\n\r\n$mi_gdb_prompt$" {warning "Unexpected console text received"}
271 -re "$mi_gdb_prompt$" { perror "Breakpoints not deleted" ; return }
272 -re "Delete all breakpoints.*or n.*$" {
273 warning "Unexpected prompt for breakpoints deletion"
277 timeout { perror "-break-list (timeout)" ; return }
281 proc mi_gdb_reinitialize_dir { subdir } {
286 if { $suppress_flag } {
290 if [is_remote host] {
294 if { $MIFLAGS == "-i=mi1" } {
295 send_gdb "104-environment-directory\n"
297 -re ".*Reinitialize source path to empty.*y or n. " {
298 warning "Got confirmation prompt for dir reinitialization."
301 -re "$mi_gdb_prompt$" {}
302 timeout {error "Dir reinitialization failed (timeout)"}
305 -re "$mi_gdb_prompt$" {}
306 timeout {error "Dir reinitialization failed (timeout)"}
309 send_gdb "104-environment-directory -r\n"
311 -re "104\\\^done,source-path=.*\r\n$mi_gdb_prompt$" {}
312 -re "$mi_gdb_prompt$" {}
313 timeout {error "Dir reinitialization failed (timeout)"}
317 send_gdb "105-environment-directory $subdir\n"
319 -re "Source directories searched.*$mi_gdb_prompt$" {
320 verbose "Dir set to $subdir"
322 -re "105\\\^done.*\r\n$mi_gdb_prompt$" {
323 # FIXME: We return just the prompt for now.
324 verbose "Dir set to $subdir"
325 # perror "Dir \"$subdir\" failed."
330 # Send GDB the "target" command.
331 # FIXME: Some of these patterns are not appropriate for MI. Based on
332 # config/monitor.exp:gdb_target_command.
333 proc mi_gdb_target_cmd { targetname serialport } {
336 set serialport_re [string_to_regexp $serialport]
337 for {set i 1} {$i <= 3} {incr i} {
338 send_gdb "47-target-select $targetname $serialport\n"
340 -re "47\\^connected.*$mi_gdb_prompt" {
341 verbose "Set target to $targetname"
344 -re "unknown host.*$mi_gdb_prompt" {
345 verbose "Couldn't look up $serialport"
347 -re "Couldn't establish connection to remote.*$mi_gdb_prompt$" {
348 verbose "Connection failed"
350 -re "Remote MIPS debugging.*$mi_gdb_prompt$" {
351 verbose "Set target to $targetname"
354 -re "Remote debugging using .*$serialport_re.*$mi_gdb_prompt$" {
355 verbose "Set target to $targetname"
358 -re "Remote target $targetname connected to.*$mi_gdb_prompt$" {
359 verbose "Set target to $targetname"
362 -re "Connected to.*$mi_gdb_prompt$" {
363 verbose "Set target to $targetname"
366 -re "Ending remote.*$mi_gdb_prompt$" { }
367 -re "Connection refused.*$mi_gdb_prompt$" {
368 verbose "Connection refused by remote target. Pausing, and trying again."
372 -re "Non-stop mode requested, but remote does not support non-stop.*$mi_gdb_prompt" {
373 unsupported "Non-stop mode not supported"
376 -re "Timeout reading from remote system.*$mi_gdb_prompt$" {
377 verbose "Got timeout error from gdb."
389 # load a file into the debugger (file command only).
390 # return a -1 if anything goes wrong.
392 proc mi_gdb_file_cmd { arg } {
398 global last_loaded_file
399 upvar timeout timeout
401 set last_loaded_file $arg
403 if [is_remote host] {
404 set arg [remote_download host $arg]
406 error "download failed"
411 # FIXME: Several of these patterns are only acceptable for console
412 # output. Queries are an error for mi.
413 send_gdb "105-file-exec-and-symbols $arg\n"
415 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
416 verbose "\t\tLoaded $arg into the $GDB"
419 -re "has no symbol-table.*$mi_gdb_prompt$" {
420 perror "$arg wasn't compiled with \"-g\""
423 -re "Load new symbol table from \".*\".*y or n. $" {
426 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
427 verbose "\t\tLoaded $arg with new symbol table into $GDB"
431 perror "(timeout) Couldn't load $arg, other program already loaded."
436 -re "No such file or directory.*$mi_gdb_prompt$" {
437 perror "($arg) No such file or directory\n"
440 -re "105-file-exec-and-symbols .*\r\n105\\\^done\r\n$mi_gdb_prompt$" {
441 # We (MI) are just giving the prompt back for now, instead of giving
442 # some acknowledgement.
446 perror "couldn't load $arg into $GDB (timed out)."
450 # This is an attempt to detect a core dump, but seems not to
451 # work. Perhaps we need to match .* followed by eof, in which
452 # gdb_expect does not seem to have a way to do that.
453 perror "couldn't load $arg into $GDB (end of file)."
460 # connect to the target and download a file, if necessary.
461 # return a -1 if anything goes wrong.
463 proc mi_gdb_target_load { } {
470 if [target_info exists gdb_load_timeout] {
471 set loadtimeout [target_info gdb_load_timeout]
476 if { [info procs gdbserver_gdb_load] != "" } {
477 mi_gdb_test "kill" ".*" ""
478 set res [gdbserver_gdb_load]
479 set protocol [lindex $res 0]
480 set gdbport [lindex $res 1]
482 if { [mi_gdb_target_cmd $protocol $gdbport] != 0 } {
485 } elseif { [info procs send_target_sid] != "" } {
486 # For SID, things get complex
489 -re ".*$mi_gdb_prompt$"
492 gdb_expect $loadtimeout {
493 -re "\\^done.*$mi_gdb_prompt$" {
496 perror "Unable to connect to SID target (timeout)"
500 send_gdb "48-target-download\n"
501 gdb_expect $loadtimeout {
502 -re "48\\^done.*$mi_gdb_prompt$" {
505 perror "Unable to download to SID target (timeout)"
509 } elseif { [target_info protocol] == "sim" } {
510 # For the simulator, just connect to it directly.
511 send_gdb "47-target-select sim\n"
512 gdb_expect $loadtimeout {
513 -re "47\\^connected.*$mi_gdb_prompt$" {
516 perror "Unable to select sim target (timeout)"
520 send_gdb "48-target-download\n"
521 gdb_expect $loadtimeout {
522 -re "48\\^done.*$mi_gdb_prompt$" {
525 perror "Unable to download to sim target (timeout)"
529 } elseif { [target_info gdb_protocol] == "remote" } {
531 if { [mi_gdb_target_cmd "remote" [target_info netport]] != 0 } {
532 perror "Unable to connect to remote target"
535 send_gdb "48-target-download\n"
536 gdb_expect $loadtimeout {
537 -re "48\\^done.*$mi_gdb_prompt$" {
540 perror "Unable to download to remote target (timeout)"
549 # load a file into the debugger.
550 # return a -1 if anything goes wrong.
552 proc mi_gdb_load { arg } {
554 return [mi_gdb_file_cmd $arg]
559 # mi_gdb_test COMMAND PATTERN MESSAGE [IPATTERN] -- send a command to gdb;
562 # COMMAND is the command to execute, send to GDB with send_gdb. If
563 # this is the null string no command is sent.
564 # PATTERN is the pattern to match for a PASS, and must NOT include
565 # the \r\n sequence immediately before the gdb prompt.
566 # MESSAGE is the message to be printed. (If this is the empty string,
567 # then sometimes we don't call pass or fail at all; I don't
568 # understand this at all.)
569 # IPATTERN is the pattern to match for the inferior's output. This parameter
570 # is optional. If present, it will produce a PASS if the match is
571 # successful, and a FAIL if unsuccessful.
574 # 1 if the test failed,
575 # 0 if the test passes,
576 # -1 if there was an internal error.
578 proc mi_gdb_test { args } {
581 global GDB expect_out
582 global inferior_exited_re async
583 upvar timeout timeout
585 set command [lindex $args 0]
586 set pattern [lindex $args 1]
587 set message [lindex $args 2]
589 if [llength $args]==4 {
590 set ipattern [lindex $args 3]
593 if [llength $args]==5 {
594 set question_string [lindex $args 3]
595 set response_string [lindex $args 4]
597 set question_string "^FOOBAR$"
601 send_user "Sending \"$command\" to gdb\n"
602 send_user "Looking to match \"$pattern\"\n"
603 send_user "Message is \"$message\"\n"
607 set string "${command}\n"
608 set string_regex [string_to_regexp $command]
610 if { $command != "" } {
611 while { "$string" != "" } {
612 set foo [string first "\n" "$string"]
613 set len [string length "$string"]
614 if { $foo < [expr $len - 1] } {
615 set str [string range "$string" 0 $foo]
616 if { [send_gdb "$str"] != "" } {
619 if { ! $suppress_flag } {
620 perror "Couldn't send $command to GDB."
629 set string [string range "$string" [expr $foo + 1] end]
634 if { "$string" != "" } {
635 if { [send_gdb "$string"] != "" } {
638 if { ! $suppress_flag } {
639 perror "Couldn't send $command to GDB."
647 if [info exists timeout] {
651 if [info exists timeout] {
658 # With $prompt_re "" there may come arbitrary asynchronous response
659 # from the previous command, before or after $string_regex.
660 set string_regex ".*"
662 verbose -log "Expecting: ^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)"
664 -re "\\*\\*\\* DOSEXIT code.*" {
665 if { $message != "" } {
668 gdb_suppress_entire_file "GDB died"
671 -re "Ending remote debugging.*$mi_gdb_prompt\[ \]*$" {
672 if ![isnative] then {
673 warning "Can`t communicate to remote target."
679 -re "^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)" {
680 # At this point, $expect_out(1,string) is the MI input command.
681 # and $expect_out(2,string) is the MI output command.
682 # If $expect_out(1,string) is "", then there was no MI input command here.
684 # NOTE, there is no trailing anchor because with GDB/MI,
685 # asynchronous responses can happen at any point, causing more
686 # data to be available. Normally an anchor is used to make
687 # sure the end of the output is matched, however, $mi_gdb_prompt
688 # is just as good of an anchor since mi_gdb_test is meant to
689 # match a single mi output command. If a second GDB/MI output
690 # response is sent, it will be in the buffer for the next
691 # time mi_gdb_test is called.
692 if ![string match "" $message] then {
697 -re "(${question_string})$" {
698 send_gdb "$response_string\n"
701 -re "Undefined.* command:.*$mi_gdb_prompt\[ \]*$" {
702 perror "Undefined command \"$command\"."
706 -re "Ambiguous command.*$mi_gdb_prompt\[ \]*$" {
707 perror "\"$command\" is not a unique command name."
711 -re "$inferior_exited_re with code \[0-9\]+.*$mi_gdb_prompt\[ \]*$" {
712 if ![string match "" $message] then {
713 set errmsg "$message (the program exited)"
715 set errmsg "$command (the program exited)"
720 -re "The program is not being run.*$mi_gdb_prompt\[ \]*$" {
721 if ![string match "" $message] then {
722 set errmsg "$message (the program is no longer running)"
724 set errmsg "$command (the program is no longer running)"
729 -re ".*$mi_gdb_prompt\[ \]*$" {
730 if ![string match "" $message] then {
737 perror "Window too small."
740 -re "\\(y or n\\) " {
742 perror "Got interactive prompt."
746 perror "Process no longer exists"
747 if { $message != "" } {
753 perror "internal buffer is full."
757 if ![string match "" $message] then {
758 fail "$message (timeout)"
764 # If the GDB output matched, compare the inferior output.
765 if { $result == 0 } {
766 if [ info exists ipattern ] {
767 if { ![target_info exists gdb,noinferiorio] } {
768 global mi_inferior_spawn_id
770 -i $mi_inferior_spawn_id -re "$ipattern" {
771 pass "$message inferior output"
774 fail "$message inferior output (timeout)"
779 unsupported "$message inferior output"
788 # MI run command. (A modified version of gdb_run_cmd)
791 # In patterns, the newline sequence ``\r\n'' is matched explicitly as
792 # ``.*$'' could swallow up output that we attempt to match elsewhere.
794 proc mi_run_cmd_full {use_mi_command args} {
796 if { $suppress_flag } {
799 global mi_gdb_prompt use_gdb_stub
800 global thread_selected_re
801 global library_loaded_re
803 if {$use_mi_command} {
804 set run_prefix "220-exec-"
811 if [target_info exists gdb_init_command] {
812 send_gdb "[target_info gdb_init_command]\n"
814 -re "$mi_gdb_prompt$" { }
816 perror "gdb_init_command for target failed"
822 if { [mi_gdb_target_load] < 0 } {
827 if [target_info exists gdb,do_reload_on_run] {
828 send_gdb "${run_prefix}continue\n"
830 -re "${run_match}\\^running\[\r\n\]+\\*running,thread-id=\"\[^\"\]+\"\r\n$mi_gdb_prompt" {}
836 if [target_info exists gdb,start_symbol] {
837 set start [target_info gdb,start_symbol]
842 # HACK: Should either use 000-jump or fix the target code
843 # to better handle RUN.
844 send_gdb "jump *$start\n"
845 warning "Using CLI jump command, expect run-to-main FAIL"
849 send_gdb "${run_prefix}run $args\n"
851 -re "${run_match}\\^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}" {
853 -re "\\^error,msg=\"The target does not support running in non-stop mode.\"" {
854 unsupported "Non-stop mode not supported"
858 perror "Unable to start target"
862 # NOTE: Shortly after this there will be a ``000*stopped,...(gdb)''
867 # A wrapper for mi_run_cmd_full which uses -exec-run and
868 # -exec-continue, as appropriate. ARGS are passed verbatim to
870 proc mi_run_cmd {args} {
871 return [eval mi_run_cmd_full 1 $args]
874 # A wrapper for mi_run_cmd_full which uses the CLI commands 'run' and
875 # 'continue', as appropriate. ARGS are passed verbatim to
877 proc mi_run_with_cli {args} {
878 return [eval mi_run_cmd_full 0 $args]
882 # Just like run-to-main but works with the MI interface
885 proc mi_run_to_main { } {
887 if { $suppress_flag } {
896 mi_delete_breakpoints
897 mi_gdb_reinitialize_dir $srcdir/$subdir
898 mi_gdb_load ${binfile}
904 # Just like gdb's "runto" proc, it will run the target to a given
905 # function. The big difference here between mi_runto and mi_execute_to
906 # is that mi_execute_to must have the inferior running already. This
907 # proc will (like gdb's runto) (re)start the inferior, too.
909 # FUNC is the linespec of the place to stop (it inserts a breakpoint here).
911 # -1 if test suppressed, failed, timedout
914 proc mi_runto_helper {func run_or_continue} {
916 if { $suppress_flag } {
920 global mi_gdb_prompt expect_out
921 global hex decimal fullname_syntax
923 set test "mi runto $func"
924 mi_gdb_test "200-break-insert -t $func" \
925 "200\\^done,bkpt=\{number=\"\[0-9\]+\",type=\"breakpoint\",disp=\"del\",enabled=\"y\",addr=\"$hex\",func=\"$func\(\\\(.*\\\)\)?\",file=\".*\",line=\"\[0-9\]*\",thread-groups=\\\[\"i1\"\\\],times=\"0\",original-location=\".*\"\}" \
926 "breakpoint at $func"
928 if {![regexp {number="[0-9]+"} $expect_out(buffer) str]
929 || ![scan $str {number="%d"} bkptno]} {
933 if {$run_or_continue == "run"} {
934 if { [mi_run_cmd] < 0 } {
938 mi_send_resuming_command "exec-continue" "$test"
941 mi_expect_stop "breakpoint-hit" $func ".*" ".*" "\[0-9\]+" { "" "disp=\"del\"" } $test
944 proc mi_runto {func} {
945 return [mi_runto_helper $func "run"]
948 # Next to the next statement
949 # For return values, see mi_execute_to_helper
951 proc mi_next { test } {
952 return [mi_next_to {.*} {.*} {.*} {.*} $test]
956 # Step to the next statement
957 # For return values, see mi_execute_to_helper
959 proc mi_step { test } {
960 return [mi_step_to {.*} {.*} {.*} {.*} $test]
965 proc mi_detect_async {} {
969 send_gdb "show target-async\n"
972 -re ".*Controlling the inferior in asynchronous mode is on...*$mi_gdb_prompt$" {
975 -re ".*$mi_gdb_prompt$" {
985 # Wait for MI *stopped notification to appear.
986 # The REASON, FUNC, ARGS, FILE and LINE are regular expressions
987 # to match against whatever is output in *stopped. FILE may also match
988 # filename of a file without debug info. ARGS should not include [] the
989 # list of argument is enclosed in, and other regular expressions should
990 # not include quotes.
991 # If EXTRA is a list of one element, it's the regular expression
992 # for output expected right after *stopped, and before GDB prompt.
993 # If EXTRA is a list of two elements, the first element is for
994 # output right after *stopped, and the second element is output
995 # right after reason field. The regex after reason should not include
996 # the comma separating it from the following fields.
998 # When we fail to match output at all, -1 is returned. If FILE does
999 # match and the target system has no debug info for FILE return 0.
1000 # Otherwise, the line at which we stop is returned. This is useful when
1001 # exact line is not possible to specify for some reason -- one can pass
1002 # the .* or "\[0-9\]*" regexps for line, and then check the line
1005 # Do not pass .* for any argument if you are expecting more than one stop.
1006 proc mi_expect_stop { reason func args file line extra test } {
1008 global mi_gdb_prompt
1011 global fullname_syntax
1013 global thread_selected_re
1014 global breakpoint_re
1016 set after_stopped ""
1018 if { [llength $extra] == 2 } {
1019 set after_stopped [lindex $extra 0]
1020 set after_reason [lindex $extra 1]
1021 set after_reason "${after_reason},"
1022 } elseif { [llength $extra] == 1 } {
1023 set after_stopped [lindex $extra 0]
1029 set prompt_re "$mi_gdb_prompt$"
1032 if { $reason == "really-no-reason" } {
1034 -re "\\*stopped\r\n$prompt_re" {
1038 fail "$test (unknown output after running)"
1044 if { $reason == "exited-normally" } {
1047 -re "\\*stopped,reason=\"exited-normally\"\r\n$prompt_re" {
1050 -re ".*$mi_gdb_prompt$" {fail "continue to end (2)"}
1052 fail "$test (unknown output after running)"
1058 set args "\\\[$args\\\]"
1061 if { $reason == "breakpoint-hit" } {
1062 set bn {bkptno="[0-9]+",}
1063 } elseif { $reason == "solib-event" } {
1068 if { $reason != "" } {
1069 set r "reason=\"$reason\","
1077 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\"|from=\"$file\")\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re|$breakpoint_re)*$prompt_re"
1079 -re "\\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$func\",args=$args,(?:file=\"$any$file\",fullname=\"${fullname_syntax}$file\",line=\"($line)\"|from=\"$file\")\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re|$breakpoint_re)*$prompt_re" {
1081 if {[array names expect_out "2,string"] != ""} {
1082 return $expect_out(2,string)
1084 # No debug info available but $file does match.
1087 -re "\\*stopped,${r}${a}${bn}frame=\{addr=\"$hex\",func=\"$any\",args=\[\\\[\{\]$any\[\\\]\}\],file=\"$any\",fullname=\"${fullname_syntax}$any\",line=\"\[0-9\]*\"\}$after_stopped,thread-id=\"$decimal\",stopped-threads=$any\r\n($thread_selected_re|$breakpoint_re)*$prompt_re" {
1088 verbose -log "got $expect_out(buffer)"
1089 fail "$test (stopped at wrong place)"
1092 -re ".*\r\n$mi_gdb_prompt$" {
1093 verbose -log "got $expect_out(buffer)"
1094 fail "$test (unknown output after running)"
1098 fail "$test (timeout)"
1104 # Wait for MI *stopped notification related to an interrupt request to
1106 proc mi_expect_interrupt { test } {
1107 global mi_gdb_prompt
1114 set prompt_re "$mi_gdb_prompt$"
1117 set r "reason=\"signal-received\",signal-name=\"0\",signal-meaning=\"Signal 0\""
1121 # A signal can land anywhere, just ignore the location
1122 verbose -log "mi_expect_interrupt: expecting: \\*stopped,${r}$any\r\n$prompt_re"
1124 -re "\\*stopped,${r}$any\r\n$prompt_re" {
1128 -re ".*\r\n$mi_gdb_prompt$" {
1129 verbose -log "got $expect_out(buffer)"
1130 fail "$test (unknown output after running)"
1134 fail "$test (timeout)"
1140 # cmd should not include the number or newline (i.e. "exec-step 3", not
1141 # "220-exec-step 3\n"
1143 # Can not match -re ".*\r\n${mi_gdb_prompt}", because of false positives
1144 # after the first prompt is printed.
1146 proc mi_execute_to { cmd reason func args file line extra test } {
1147 global suppress_flag
1148 if { $suppress_flag } {
1152 mi_send_resuming_command "$cmd" "$test"
1153 set r [mi_expect_stop $reason $func $args $file $line $extra $test]
1157 proc mi_next_to { func args file line test } {
1158 mi_execute_to "exec-next" "end-stepping-range" "$func" "$args" \
1159 "$file" "$line" "" "$test"
1162 proc mi_step_to { func args file line test } {
1163 mi_execute_to "exec-step" "end-stepping-range" "$func" "$args" \
1164 "$file" "$line" "" "$test"
1167 proc mi_finish_to { func args file line result ret test } {
1168 mi_execute_to "exec-finish" "function-finished" "$func" "$args" \
1170 ",gdb-result-var=\"$result\",return-value=\"$ret\"" \
1174 proc mi_continue_to {func} {
1175 mi_runto_helper $func "continue"
1178 proc mi0_execute_to { cmd reason func args file line extra test } {
1179 mi_execute_to_helper "$cmd" "$reason" "$func" "\{$args\}" \
1180 "$file" "$line" "$extra" "$test"
1183 proc mi0_next_to { func args file line test } {
1184 mi0_execute_to "exec-next" "end-stepping-range" "$func" "$args" \
1185 "$file" "$line" "" "$test"
1188 proc mi0_step_to { func args file line test } {
1189 mi0_execute_to "exec-step" "end-stepping-range" "$func" "$args" \
1190 "$file" "$line" "" "$test"
1193 proc mi0_finish_to { func args file line result ret test } {
1194 mi0_execute_to "exec-finish" "function-finished" "$func" "$args" \
1196 ",gdb-result-var=\"$result\",return-value=\"$ret\"" \
1200 proc mi0_continue_to { bkptno func args file line test } {
1201 mi0_execute_to "exec-continue" "breakpoint-hit\",bkptno=\"$bkptno" \
1202 "$func" "$args" "$file" "$line" "" "$test"
1205 # Creates a breakpoint and checks the reported fields are as expected
1206 proc mi_create_breakpoint { location number disp func file line address test } {
1207 verbose -log "Expecting: 222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",thread-groups=\\\[\".*\"\\\],times=\"0\",original-location=\".*\"\}"
1208 mi_gdb_test "222-break-insert $location" \
1209 "222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",thread-groups=\\\[\".*\"\\\],times=\"0\",original-location=\".*\"\}" \
1213 proc mi_list_breakpoints { expected test } {
1219 foreach item $expected {
1224 set number [lindex $item 0]
1225 set disp [lindex $item 1]
1226 set func [lindex $item 2]
1227 set file [lindex $item 3]
1228 set line [lindex $item 4]
1229 set address [lindex $item 5]
1230 set body "${body}bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\".*$file\",${fullname},line=\"$line\",thread-groups=\\\[\"i1\"\\\],times=\"0\",original-location=\".*\"\}"
1234 verbose -log "Expecting: 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\\\]\}"
1235 mi_gdb_test "666-break-list" \
1236 "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\\\]\}" \
1240 # Creates varobj named NAME for EXPRESSION.
1241 # Name cannot be "-".
1242 proc mi_create_varobj { name expression testname } {
1243 mi_gdb_test "-var-create $name * $expression" \
1244 "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=.*,has_more=\"0\"" \
1248 proc mi_create_floating_varobj { name expression testname } {
1249 mi_gdb_test "-var-create $name @ $expression" \
1250 "\\^done,name=\"$name\",numchild=\"\(-1\|\[0-9\]+\)\",value=\".*\",type=.*" \
1255 # Same as mi_create_varobj, but also checks the reported type
1257 proc mi_create_varobj_checked { name expression type testname } {
1258 mi_gdb_test "-var-create $name * $expression" \
1259 "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=\"$type\".*" \
1263 # Same as mi_create_floating_varobj, but assumes the test is creating
1264 # a dynamic varobj that has children, so the value must be "{...}".
1265 proc mi_create_dynamic_varobj {name expression testname} {
1266 mi_gdb_test "-var-create $name @ $expression" \
1267 "\\^done,name=\"$name\",numchild=\"\(-1\|\[0-9\]+\)\",value=\"{\\.\\.\\.}\",type=.*" \
1271 # Deletes the specified NAME.
1272 proc mi_delete_varobj { name testname } {
1273 mi_gdb_test "-var-delete $name" \
1274 "\\^done,ndeleted=.*" \
1278 # Updates varobj named NAME and checks that all varobjs in EXPECTED
1279 # are reported as updated, and no other varobj is updated.
1280 # Assumes that no varobj is out of scope and that no varobj changes
1282 proc mi_varobj_update { name expected testname } {
1283 set er "\\^done,changelist=\\\["
1285 foreach item $expected {
1286 set v "{name=\"$item\",in_scope=\"true\",type_changed=\"false\",has_more=\".\"}"
1296 verbose -log "Expecting: $er" 2
1297 mi_gdb_test "-var-update $name" $er $testname
1300 proc mi_varobj_update_with_child_type_change { name child_name new_type new_children testname } {
1301 set v "{name=\"$child_name\",in_scope=\"true\",type_changed=\"true\",new_type=\"$new_type\",new_num_children=\"$new_children\",has_more=\".\"}"
1302 set er "\\^done,changelist=\\\[$v\\\]"
1303 verbose -log "Expecting: $er"
1304 mi_gdb_test "-var-update $name" $er $testname
1307 proc mi_varobj_update_with_type_change { name new_type new_children testname } {
1308 mi_varobj_update_with_child_type_change $name $name $new_type $new_children $testname
1311 # A helper that turns a key/value list into a regular expression
1312 # matching some MI output.
1313 proc mi_varobj_update_kv_helper {list} {
1316 foreach {key value} $list {
1321 if {$key == "new_children"} {
1322 append rx "$key=\\\[$value\\\]"
1324 append rx "$key=\"$value\""
1330 # A helper for mi_varobj_update_dynamic that computes a match
1331 # expression given a child list.
1332 proc mi_varobj_update_dynamic_helper {children} {
1336 foreach child $children {
1342 append crx [mi_varobj_update_kv_helper $child]
1349 # Update a dynamic varobj named NAME. CHILDREN is a list of children
1350 # that have been updated; NEW_CHILDREN is a list of children that were
1351 # added to the primary varobj. Each child is a list of key/value
1352 # pairs that are expected. SELF is a key/value list holding
1353 # information about the varobj itself. TESTNAME is the name of the
1355 proc mi_varobj_update_dynamic {name testname self children new_children} {
1356 if {[llength $new_children]} {
1357 set newrx [mi_varobj_update_dynamic_helper $new_children]
1358 lappend self new_children $newrx
1360 set selfrx [mi_varobj_update_kv_helper $self]
1361 set crx [mi_varobj_update_dynamic_helper $children]
1363 set er "\\^done,changelist=\\\[\{name=\"$name\",in_scope=\"true\""
1364 append er ",$selfrx\}"
1370 verbose -log "Expecting: $er"
1371 mi_gdb_test "-var-update $name" $er $testname
1374 proc mi_check_varobj_value { name value testname } {
1376 mi_gdb_test "-var-evaluate-expression $name" \
1377 "\\^done,value=\"$value\"" \
1381 # Helper proc which constructs a child regexp for
1382 # mi_list_varobj_children and mi_varobj_update_dynamic.
1383 proc mi_child_regexp {children add_child} {
1385 set whatever "\"\[^\"\]+\""
1393 foreach item $children {
1395 set name [lindex $item 0]
1396 set exp [lindex $item 1]
1397 set numchild [lindex $item 2]
1398 if {[llength $item] == 5} {
1399 set type [lindex $item 3]
1400 set value [lindex $item 4]
1402 lappend children_exp\
1403 "$pre{name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",value=\"$value\",type=\"$type\"\(,thread-id=\"\[0-9\]+\")?}"
1404 } elseif {[llength $item] == 4} {
1405 set type [lindex $item 3]
1407 lappend children_exp\
1408 "$pre{name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",type=\"$type\"\(,thread-id=\"\[0-9\]+\")?}"
1410 lappend children_exp\
1411 "$pre{name=\"$name\",exp=\"$exp\",numchild=\"$numchild\"(,thread-id=\"\[0-9\]+\")?}"
1414 return [join $children_exp ","]
1417 # Check the results of the:
1419 # -var-list-children VARNAME
1421 # command. The CHILDREN parement should be a list of lists.
1422 # Each inner list can have either 3 or 4 elements, describing
1423 # fields that gdb is expected to report for child variable object,
1424 # in the following order
1428 # - Number of children
1431 # If inner list has 3 elements, the gdb is expected to output no
1432 # type for a child and no value.
1434 # If the inner list has 4 elements, gdb output is expected to
1437 proc mi_list_varobj_children { varname children testname } {
1438 mi_list_varobj_children_range $varname "" "" [llength $children] $children \
1442 # Like mi_list_varobj_children, but sets a subrange. NUMCHILDREN is
1443 # the total number of children.
1444 proc mi_list_varobj_children_range {varname from to numchildren children testname} {
1446 if {[llength $varname] == 2} {
1447 set options [lindex $varname 1]
1448 set varname [lindex $varname 0]
1451 set whatever "\"\[^\"\]+\""
1453 set children_exp_j [mi_child_regexp $children 1]
1455 set expected "\\^done,numchild=\".*\",children=\\\[$children_exp_j.*\\\]"
1457 set expected "\\^done,numchild=\"0\""
1461 append expected ",has_more=\"0\""
1462 } elseif {$to >= 0 && $numchildren > $to} {
1463 append expected ",has_more=\"1\""
1465 append expected ",has_more=\"0\""
1468 verbose -log "Expecting: $expected"
1470 mi_gdb_test "-var-list-children $options $varname $from $to" \
1474 # Verifies that variable object VARNAME has NUMBER children,
1475 # where each one is named $VARNAME.<index-of-child> and has type TYPE.
1476 proc mi_list_array_varobj_children { varname number type testname } {
1478 for {set i 0} {$i < $number} {incr i} {
1479 lappend t [list $varname.$i $i 0 $type]
1481 mi_list_varobj_children $varname $t $testname
1484 # A list of two-element lists. First element of each list is
1485 # a Tcl statement, and the second element is the line
1486 # number of source C file where the statement originates.
1487 set mi_autotest_data ""
1488 # The name of the source file for autotesting.
1489 set mi_autotest_source ""
1491 proc count_newlines { string } {
1492 return [regexp -all "\n" $string]
1495 # Prepares for running inline tests in FILENAME.
1496 # See comments for mi_run_inline_test for detailed
1497 # explanation of the idea and syntax.
1498 proc mi_prepare_inline_tests { filename } {
1502 global mi_autotest_source
1503 global mi_autotest_data
1505 set mi_autotest_data {}
1507 set mi_autotest_source $filename
1509 if { ! [regexp "^/" "$filename"] } then {
1510 set filename "$srcdir/$subdir/$filename"
1513 set chan [open $filename]
1514 set content [read $chan]
1517 set start [string first "/*:" $content]
1519 set end [string first ":*/" $content]
1521 error "Unterminated special comment in $filename"
1524 set prefix [string range $content 0 $start]
1525 set prefix_newlines [count_newlines $prefix]
1527 set line_number [expr $line_number+$prefix_newlines]
1528 set comment_line $line_number
1530 set comment [string range $content [expr $start+3] [expr $end-1]]
1532 set comment_newlines [count_newlines $comment]
1533 set line_number [expr $line_number+$comment_newlines]
1535 set comment [string trim $comment]
1536 set content [string range $content [expr $end+3] \
1537 [string length $content]]
1538 lappend mi_autotest_data [list $comment $comment_line]
1546 # Helper to mi_run_inline_test below.
1547 # Return the list of all (statement,line_number) lists
1548 # that comprise TESTCASE. The begin and end markers
1550 proc mi_get_inline_test {testcase} {
1552 global mi_gdb_prompt
1553 global mi_autotest_data
1554 global mi_autotest_source
1560 foreach l $mi_autotest_data {
1562 set comment [lindex $l 0]
1564 if {$comment == "BEGIN: $testcase"} {
1566 } elseif {$comment == "END: $testcase"} {
1569 } elseif {$seen_begin==1} {
1574 if {$seen_begin == 0} {
1575 error "Autotest $testcase not found"
1578 if {$seen_begin == 1 && $seen_end == 0} {
1579 error "Missing end marker for test $testcase"
1585 # Sets temporary breakpoint at LOCATION.
1586 proc mi_tbreak {location} {
1588 global mi_gdb_prompt
1590 mi_gdb_test "-break-insert -t $location" \
1592 "run to $location (set breakpoint)"
1595 # Send COMMAND that must be a command that resumes
1596 # the inferior (run/continue/next/etc) and consumes
1597 # the "^running" output from it.
1598 proc mi_send_resuming_command_raw {command test} {
1600 global mi_gdb_prompt
1601 global thread_selected_re
1602 global library_loaded_re
1604 send_gdb "$command\n"
1606 -re "\\^running\r\n\\*running,thread-id=\"\[^\"\]+\"\r\n($library_loaded_re)*($thread_selected_re)?${mi_gdb_prompt}" {
1607 # Note that lack of 'pass' call here -- this works around limitation
1608 # in DejaGNU xfail mechanism. mi-until.exp has this:
1610 # setup_kfail gdb/2104 "*-*-*"
1613 # and mi_execute_to uses mi_send_resuming_command. If we use 'pass' here,
1614 # it will reset kfail, so when the actual test fails, it will be flagged
1618 -re "\\^error,msg=\"Displaced stepping is only supported in ARM mode\".*" {
1619 unsupported "$test (Thumb mode)"
1622 -re "\\^error,msg=.*" {
1623 fail "$test (MI error)"
1626 -re ".*${mi_gdb_prompt}" {
1627 fail "$test (failed to resume)"
1637 proc mi_send_resuming_command {command test} {
1638 mi_send_resuming_command_raw -$command $test
1641 # Helper to mi_run_inline_test below.
1642 # Sets a temporary breakpoint at LOCATION and runs
1643 # the program using COMMAND. When the program is stopped
1644 # returns the line at which it. Returns -1 if line cannot
1646 # Does not check that the line is the same as requested.
1647 # The caller can check itself if required.
1648 proc mi_continue_to_line {location test} {
1651 mi_send_resuming_command "exec-continue" "run to $location (exec-continue)"
1652 return [mi_get_stop_line $test]
1655 # Wait until gdb prints the current line.
1656 proc mi_get_stop_line {test} {
1658 global mi_gdb_prompt
1664 set prompt_re "$mi_gdb_prompt$"
1668 -re ".*line=\"(\[0-9\]*)\".*\r\n$prompt_re" {
1669 return $expect_out(1,string)
1671 -re ".*$mi_gdb_prompt" {
1672 fail "wait for stop ($test)"
1675 fail "wait for stop ($test)"
1680 # Run a MI test embedded in comments in a C file.
1681 # The C file should contain special comments in the following
1684 # /*: BEGIN: testname :*/
1685 # /*: <Tcl statements> :*/
1686 # /*: END: testname :*/
1688 # This procedure find the begin and end marker for the requested
1689 # test. Then, a temporary breakpoint is set at the begin
1690 # marker and the program is run (from start).
1692 # After that, for each special comment between the begin and end
1693 # marker, the Tcl statements are executed. It is assumed that
1694 # for each comment, the immediately preceding line is executable
1695 # C statement. Then, gdb will be single-stepped until that
1696 # preceding C statement is executed, and after that the
1697 # Tcl statements in the comment will be executed.
1701 # /*: BEGIN: assignment-test :*/
1703 # /*: <Tcl code to check that 'v' is indeed 10 :*/
1704 # /*: END: assignment-test :*/
1706 # The mi_prepare_inline_tests function should be called before
1707 # calling this function. A given C file can contain several
1708 # inline tests. The names of the tests must be unique within one
1711 proc mi_run_inline_test { testcase } {
1713 global mi_gdb_prompt
1716 global fullname_syntax
1717 global mi_autotest_source
1719 set commands [mi_get_inline_test $testcase]
1724 foreach c $commands {
1725 set statements [lindex $c 0]
1726 set line [lindex $c 1]
1727 set line [expr $line-1]
1729 # We want gdb to be stopped at the expression immediately
1730 # before the comment. If this is the first comment, the
1731 # program is either not started yet or is in some random place,
1732 # so we run it. For further comments, we might be already
1733 # standing at the right line. If not continue till the
1737 # Start the program afresh.
1738 mi_tbreak "$mi_autotest_source:$line"
1740 set line_now [mi_get_stop_line "$testcase: step to $line"]
1742 } elseif {$line_now!=$line} {
1743 set line_now [mi_continue_to_line "$mi_autotest_source:$line" "continue to $line"]
1746 if {$line_now!=$line} {
1747 fail "$testcase: go to line $line"
1750 # We're not at the statement right above the comment.
1751 # Execute that statement so that the comment can test
1752 # the state after the statement is executed.
1754 # Single-step past the line.
1755 if { [mi_send_resuming_command "exec-next" "$testcase: step over $line"] != 0 } {
1758 set line_now [mi_get_stop_line "$testcase: step over $line"]
1760 # We probably want to use 'uplevel' so that statements
1761 # have direct access to global variables that the
1762 # main 'exp' file has set up. But it's not yet clear,
1763 # will need more experience to be sure.
1768 proc get_mi_thread_list {name} {
1771 # MI will return a list of thread ids:
1774 # ^done,thread-ids=[thread-id="1",thread-id="2",...],number-of-threads="N"
1776 mi_gdb_test "-thread-list-ids" \
1777 {.*\^done,thread-ids={(thread-id="[0-9]+"(,)?)+},current-thread-id="[0-9]+",number-of-threads="[0-9]+"} \
1778 "-thread_list_ids ($name)"
1781 if {[info exists expect_out(buffer)]} {
1782 set output $expect_out(buffer)
1786 if {![regexp {thread-ids=\{(thread-id="[0-9]+"(,)?)*\}} $output threads]} {
1787 fail "finding threads in MI output ($name)"
1789 pass "finding threads in MI output ($name)"
1791 # Make list of console threads
1792 set start [expr {[string first \{ $threads] + 1}]
1793 set end [expr {[string first \} $threads] - 1}]
1794 set threads [string range $threads $start $end]
1795 foreach thread [split $threads ,] {
1796 if {[scan $thread {thread-id="%d"} num]} {
1797 lappend thread_list $num
1805 # Check that MI and the console know of the same threads.
1806 # Appends NAME to all test names.
1807 proc check_mi_and_console_threads {name} {
1810 mi_gdb_test "-thread-list-ids" \
1811 {.*\^done,thread-ids={(thread-id="[0-9]+"(,)*)+},current-thread-id="[0-9]+",number-of-threads="[0-9]+"} \
1812 "-thread-list-ids ($name)"
1814 if {[info exists expect_out(buffer)]} {
1815 set mi_output $expect_out(buffer)
1818 # GDB will return a list of thread ids and some more info:
1821 # -interpreter-exec console "info threads"
1822 # ~" 4 Thread 2051 (LWP 7734) 0x401166b1 in __libc_nanosleep () at __libc_nanosleep:-1"
1823 # ~" 3 Thread 1026 (LWP 7733) () at __libc_nanosleep:-1"
1824 # ~" 2 Thread 2049 (LWP 7732) 0x401411f8 in __poll (fds=0x804bb24, nfds=1, timeout=2000) at ../sysdeps/unix/sysv/linux/poll.c:63"
1825 # ~"* 1 Thread 1024 (LWP 7731) main (argc=1, argv=0xbfffdd94) at ../../../src/gdb/testsuite/gdb.mi/pthreads.c:160"
1826 # FIXME: kseitz/2002-09-05: Don't use the hack-cli method.
1827 mi_gdb_test "info threads" \
1828 {.*(~".*"[\r\n]*)+.*} \
1829 "info threads ($name)"
1830 set console_output {}
1831 if {[info exists expect_out(buffer)]} {
1832 set console_output $expect_out(buffer)
1835 # Make a list of all known threads to console (gdb's thread IDs)
1836 set console_thread_list {}
1837 foreach line [split $console_output \n] {
1838 if {[string index $line 0] == "~"} {
1839 # This is a line from the console; trim off "~", " ", "*", and "\""
1840 set line [string trim $line ~\ \"\*]
1841 if {[scan $line "%d" id] == 1} {
1842 lappend console_thread_list $id
1847 # Now find the result string from MI
1849 foreach line [split $mi_output \n] {
1850 if {[string range $line 0 4] == "^done"} {
1854 if {$mi_result == ""} {
1855 fail "finding MI result string ($name)"
1857 pass "finding MI result string ($name)"
1860 # Finally, extract the thread ids and compare them to the console
1861 set num_mi_threads_str ""
1862 if {![regexp {number-of-threads="[0-9]+"} $mi_result num_mi_threads_str]} {
1863 fail "finding number of threads in MI output ($name)"
1865 pass "finding number of threads in MI output ($name)"
1867 # Extract the number of threads from the MI result
1868 if {![scan $num_mi_threads_str {number-of-threads="%d"} num_mi_threads]} {
1869 fail "got number of threads from MI ($name)"
1871 pass "got number of threads from MI ($name)"
1873 # Check if MI and console have same number of threads
1874 if {$num_mi_threads != [llength $console_thread_list]} {
1875 fail "console and MI have same number of threads ($name)"
1877 pass "console and MI have same number of threads ($name)"
1879 # Get MI thread list
1880 set mi_thread_list [get_mi_thread_list $name]
1882 # Check if MI and console have the same threads
1884 foreach ct [lsort $console_thread_list] mt [lsort $mi_thread_list] {
1890 fail "MI and console have same threads ($name)"
1892 # Send a list of failures to the log
1893 send_log "Console has thread ids: $console_thread_list\n"
1894 send_log "MI has thread ids: $mi_thread_list\n"
1896 pass "MI and console have same threads ($name)"
1903 # Download shared libraries to the target.
1904 proc mi_load_shlibs { args } {
1905 if {![is_remote target]} {
1909 foreach file $args {
1910 gdb_download [shlib_target_file $file]
1913 # Even if the target supplies full paths for shared libraries,
1914 # they may not be paths for this system.
1915 mi_gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "\^done" ""
1918 proc mi_reverse_list { list } {
1919 if { [llength $list] <= 1 } {
1922 set tail [lrange $list 1 [llength $list]]
1923 set rtail [mi_reverse_list $tail]
1924 lappend rtail [lindex $list 0]
1928 proc mi_check_thread_states { xstates test } {
1930 set states [mi_reverse_list $xstates]
1931 set pattern ".*\\^done,threads=\\\["
1933 set pattern "${pattern}(.*)state=\"$s\""
1935 set pattern "${pattern}(,core=\"\[0-9\]*\")?\\\}\\\].*"
1937 verbose -log "expecting: $pattern"
1938 mi_gdb_test "-thread-info" $pattern $test
1941 # Return a list of MI features supported by this gdb.
1942 proc mi_get_features {} {
1943 global expect_out mi_gdb_prompt
1945 send_gdb "-list-features\n"
1948 -re "\\^done,features=\\\[(.*)\\\]\r\n$mi_gdb_prompt$" {
1949 regsub -all -- \" $expect_out(1,string) "" features
1950 return [split $features ,]
1952 -re ".*\r\n$mi_gdb_prompt$" {
1953 verbose -log "got $expect_out(buffer)"
1957 verbose -log "timeout in mi_gdb_prompt"
1963 # Variable Object Trees
1965 # Yet another way to check varobjs. Pass mi_walk_varobj_tree a "list" of
1966 # variables (not unlike the actual source code definition), and it will
1967 # automagically test the children for you (by default).
1989 # foo *f = new foo (); <-- break here
1991 # We want to check all the children of "f".
1993 # Translate the above structures into the following tree:
1999 # anonymous struct {
2010 # {const int *} iPtr {
2011 # {const int} {*iPtr} {}
2021 # mi_walk_varobj_tree c++ $tree
2023 # If you'd prefer to walk the tree using your own callback,
2024 # simply pass the name of the callback to mi_walk_varobj_tree.
2026 # This callback should take one argument, the name of the variable
2027 # to process. This name is the name of a global array holding the
2028 # variable's properties (object name, type, etc).
2030 # An example callback:
2032 # proc my_callback {var} {
2033 # upvar #0 $var varobj
2035 # puts "my_callback: called on varobj $varobj(obj_name)"
2038 # The arrays created for each variable object contain the following
2041 # obj_name - the object name for accessing this variable via MI
2042 # display_name - the display name for this variable (exp="display_name" in
2043 # the output of -var-list-children)
2044 # type - the type of this variable (type="type" in the output
2045 # of -var-list-children, or the special tag "anonymous"
2046 # path_expr - the "-var-info-path-expression" for this variable
2047 # NOTE: This member cannot be used reliably with typedefs.
2049 # See notes inside get_path_expr for more.
2050 # parent - the variable name of the parent varobj
2051 # children - a list of children variable names (which are the
2052 # names Tcl arrays, not object names)
2054 # For each variable object, an array containing the above fields will
2055 # be created under the root node (conveniently called, "root"). For example,
2056 # a variable object with handle "OBJ.public.0_anonymous.a" will have
2057 # a corresponding global Tcl variable named "root.OBJ.public.0_anonymous.a".
2059 # Note that right now, this mechanism cannot be used for recursive data
2060 # structures like linked lists.
2062 namespace eval ::varobj_tree {
2063 # An index which is appended to root varobjs to ensure uniqueness.
2064 variable _root_idx 0
2066 # A procedure to help with debuggging varobj trees.
2067 # VARIABLE_NAME is the name of the variable to dump.
2068 # CMD, if present, is the name of the callback to output the contstructed
2069 # strings. By default, it uses expect's "send_log" command.
2070 # TERM, if present, is a terminating character. By default it is the newline.
2072 # To output to the terminal (not the expect log), use
2073 # mi_varobj_tree_dump_variable my_variable puts ""
2075 proc mi_varobj_tree_dump_variable {variable_name {cmd send_log} {term "\n"}} {
2076 upvar #0 $variable_name varobj
2078 eval "$cmd \"VAR = $variable_name$term\""
2080 # Explicitly encode the array indices, since outputting them
2081 # in some logical order is better than what "array names" might
2083 foreach idx {obj_name parent display_name type path_expr} {
2084 eval "$cmd \"\t$idx = $varobj($idx)$term\""
2088 set num [llength $varobj(children)]
2089 eval "$cmd \"\tnum_children = $num$term\""
2091 eval "$cmd \"\tchildren = $varobj(children)$term\""
2095 # The default callback used by mi_walk_varobj_tree. This callback
2096 # simply checks all of VAR's children. It specifically does not test
2097 # path expressions, since that is very problematic.
2099 # This procedure may be used in custom callbacks.
2100 proc test_children_callback {variable_name} {
2101 upvar #0 $variable_name varobj
2103 if {[llength $varobj(children)] > 0} {
2104 # Construct the list of children the way mi_list_varobj_children
2105 # expects to get it:
2106 # { {obj_name display_name num_children type} ... }
2107 set children_list {}
2108 foreach child $varobj(children) {
2110 set clist [list [string_to_regexp $c(obj_name)] \
2111 [string_to_regexp $c(display_name)] \
2112 [llength $c(children)]]
2113 if {[string length $c(type)] > 0} {
2114 lappend clist [string_to_regexp $c(type)]
2116 lappend children_list $clist
2119 mi_list_varobj_children $varobj(obj_name) $children_list \
2120 "VT: list children of $varobj(obj_name)"
2124 # Set the properties of the varobj represented by
2125 # PARENT_VARIABLE - the name of the parent's variable
2126 # OBJNAME - the MI object name of this variable
2127 # DISP_NAME - the display name of this variable
2128 # TYPE - the type of this variable
2129 # PATH - the path expression for this variable
2130 # CHILDREN - a list of the variable's children
2131 proc create_varobj {parent_variable objname disp_name \
2132 type path children} {
2133 upvar #0 $parent_variable parent
2135 set var_name "root.$objname"
2137 array set $var_name [list obj_name $objname]
2138 array set $var_name [list display_name $disp_name]
2139 array set $var_name [list type $type]
2140 array set $var_name [list path_expr $path]
2141 array set $var_name [list parent "$parent_variable"]
2142 array set $var_name [list children \
2143 [get_tree_children $var_name $children]]
2147 # Should VARIABLE be used in path expressions? The CPLUS_FAKE_CHILD
2148 # varobjs and anonymous structs/unions are not used for path expressions.
2149 proc is_path_expr_parent {variable} {
2150 upvar #0 $variable varobj
2152 # If the varobj's type is "", it is a CPLUS_FAKE_CHILD.
2153 # If the tail of the varobj's object name is "%d_anonymous",
2154 # then it represents an anonymous struct or union.
2155 if {[string length $varobj(type)] == 0 \
2156 || [regexp {[0-9]+_anonymous$} $varobj(obj_name)]} {
2163 # Return the path expression for the variable named NAME in
2164 # parent varobj whose variable name is given by PARENT_VARIABLE.
2165 proc get_path_expr {parent_variable name type} {
2166 upvar #0 $parent_variable parent
2167 upvar #0 $parent_variable path_parent
2169 # If TYPE is "", this is one of the CPLUS_FAKE_CHILD varobjs,
2170 # which has no path expression. Likewsise for anonymous structs
2172 if {[string length $type] == 0 \
2173 || [string compare $type "anonymous"] == 0} {
2177 # Find the path parent variable.
2178 while {![is_path_expr_parent $parent_variable]} {
2179 set parent_variable $path_parent(parent)
2180 upvar #0 $parent_variable path_parent
2183 # This is where things get difficult. We do not actually know
2184 # the real type for variables defined via typedefs, so we don't actually
2185 # know whether the parent is a structure/union or not.
2187 # So we assume everything that isn't a simple type is a compound type.
2189 regexp {\*+} $parent(type) stars
2191 if {[string index $name 0] == "*"} {
2195 if {[string index $parent(type) end] == "\]"} {
2196 # Parent is an array.
2197 return "($path_parent(path_expr))\[$name\]"
2198 } elseif {$is_compound} {
2199 # Parent is a structure or union or a pointer to one.
2200 if {[string length $stars]} {
2208 # To make matters even more hideous, varobj.c has slightly different
2209 # path expressions for C and C++.
2210 set path_expr "($path_parent(path_expr))$join$name"
2211 if {[string compare -nocase $root(language) "c"] == 0} {
2214 return "($path_expr)"
2217 # Parent is a pointer.
2218 return "*($path_parent(path_expr))"
2222 # Process the CHILDREN (a list of varobj_tree elements) of the variable
2223 # given by PARENT_VARIABLE. Returns a list of children variables.
2224 proc get_tree_children {parent_variable children} {
2225 upvar #0 $parent_variable parent
2228 set children_list {}
2229 foreach {type name children} $children {
2230 if {[string compare $parent_variable "root"] == 0} {
2234 set objname "$name$_root_idx"
2235 set disp_name "$name"
2236 set path_expr "$name"
2237 } elseif {[string compare $type "anonymous"] == 0} {
2238 # Special case: anonymous types. In this case, NAME will either be
2239 # "struct" or "union".
2240 set objname "$parent(obj_name).${field_idx}_anonymous"
2241 set disp_name "<anonymous $name>"
2243 set type "$name {...}"
2245 set objname "$parent(obj_name).$name"
2247 set path_expr [get_path_expr $parent_variable $name $type]
2250 lappend children_list [create_varobj $parent_variable $objname \
2251 $disp_name $type $path_expr $children]
2255 return $children_list
2258 # The main procedure to call the given CALLBACK on the elements of the
2259 # given varobj TREE. See detailed explanation above.
2260 proc walk_tree {language tree callback} {
2263 if {[llength $tree] < 3} {
2264 error "tree does not contain enough elements"
2267 # Create root node and process the tree.
2268 array set root [list language $language]
2269 array set root [list obj_name "root"]
2270 array set root [list display_name "root"]
2271 array set root [list type "root"]
2272 array set root [list path_expr "root"]
2273 array set root [list parent "root"]
2274 array set root [list children [get_tree_children root $tree]]
2277 set all_nodes $root(children); # a stack of nodes
2278 while {[llength $all_nodes] > 0} {
2279 # "Pop" the name of the global variable containing this varobj's
2280 # information from the stack of nodes.
2281 set var_name [lindex $all_nodes 0]
2282 set all_nodes [lreplace $all_nodes 0 0]
2284 # Bring the global named in VAR_NAME into scope as the local variable
2286 upvar #0 $var_name varobj
2288 # Append any children of VAROBJ to the list of nodes to walk.
2289 if {[llength $varobj(children)] > 0} {
2290 set all_nodes [concat $all_nodes $varobj(children)]
2293 # If this is a root variable, create the variable object for it.
2294 if {[string compare $varobj(parent) "root"] == 0} {
2295 mi_create_varobj $varobj(obj_name) $varobj(display_name) \
2296 "VT: create root varobj for $varobj(display_name)"
2299 # Now call the callback for VAROBJ.
2300 uplevel #0 $callback $var_name
2305 # The default varobj tree callback, which simply tests -var-list-children.
2306 proc mi_varobj_tree_test_children_callback {variable} {
2307 ::varobj_tree::test_children_callback $variable
2310 # Walk the variable object tree given by TREE, calling the specified
2311 # CALLBACK. By default this uses mi_varobj_tree_test_children_callback.
2312 proc mi_walk_varobj_tree {language tree \
2314 mi_varobj_tree_test_children_callback}} {
2315 ::varobj_tree::walk_tree $language $tree $callback