* lib/mi-support.exp (mi_load_shlibs): New.
[deliverable/binutils-gdb.git] / gdb / testsuite / lib / mi-support.exp
CommitLineData
9b254dd1 1# Copyright 1999, 2000, 2002, 2003, 2004, 2005, 2007, 2008
6aba47ca 2# Free Software Foundation, Inc.
fb40c209
AC
3
4# This program is free software; you can redistribute it and/or modify
5# it under the terms of the GNU General Public License as published by
e22f8b7c 6# the Free Software Foundation; either version 3 of the License, or
fb40c209 7# (at your option) any later version.
e22f8b7c 8#
fb40c209
AC
9# This program is distributed in the hope that it will be useful,
10# but WITHOUT ANY WARRANTY; without even the implied warranty of
11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12# GNU General Public License for more details.
e22f8b7c 13#
fb40c209 14# You should have received a copy of the GNU General Public License
e22f8b7c 15# along with this program. If not, see <http://www.gnu.org/licenses/>.
fb40c209
AC
16
17# Please email any bugs, comments, and/or additions to this file to:
18# bug-gdb@prep.ai.mit.edu
19
20# This file was based on a file written by Fred Fish. (fnf@cygnus.com)
21
22# Test setup routines that work with the MI interpreter.
23
24# The variable mi_gdb_prompt is a regexp which matches the gdb mi prompt.
25# Set it if it is not already set.
26global mi_gdb_prompt
27if ![info exists mi_gdb_prompt] then {
28 set mi_gdb_prompt "\[(\]gdb\[)\] \r\n"
29}
30
ecd3fd0f
BR
31global mi_inferior_spawn_id
32global mi_inferior_tty_name
33
fb40c209
AC
34set MIFLAGS "-i=mi"
35
36#
37# mi_gdb_exit -- exit the GDB, killing the target program if necessary
38#
39proc mi_gdb_exit {} {
40 catch mi_uncatched_gdb_exit
41}
42
43proc mi_uncatched_gdb_exit {} {
44 global GDB
45 global GDBFLAGS
46 global verbose
47 global gdb_spawn_id;
48 global gdb_prompt
49 global mi_gdb_prompt
50 global MIFLAGS
51
52 gdb_stop_suppressing_tests;
53
54 if { [info procs sid_exit] != "" } {
55 sid_exit
56 }
57
58 if ![info exists gdb_spawn_id] {
59 return;
60 }
61
62 verbose "Quitting $GDB $GDBFLAGS $MIFLAGS"
63
64 if { [is_remote host] && [board_info host exists fileid] } {
65 send_gdb "999-gdb-exit\n";
66 gdb_expect 10 {
67 -re "y or n" {
68 send_gdb "y\n";
69 exp_continue;
70 }
71 -re "Undefined command.*$gdb_prompt $" {
72 send_gdb "quit\n"
73 exp_continue;
74 }
75 -re "DOSEXIT code" { }
76 default { }
77 }
78 }
79
80 if ![is_remote host] {
81 remote_close host;
82 }
83 unset gdb_spawn_id
84}
85
86#
79732189 87# default_mi_gdb_start [INFERIOR_PTY] -- start gdb running, default procedure
ecd3fd0f
BR
88#
89# INFERIOR_PTY should be set to separate-inferior-tty to have the inferior work
90# with it's own PTY. If set to same-inferior-tty, the inferior shares GDB's PTY.
91# The default value is same-inferior-tty.
fb40c209
AC
92#
93# When running over NFS, particularly if running many simultaneous
94# tests on different hosts all using the same server, things can
95# get really slow. Give gdb at least 3 minutes to start up.
96#
79732189 97proc default_mi_gdb_start { args } {
fb40c209
AC
98 global verbose
99 global GDB
100 global GDBFLAGS
101 global gdb_prompt
102 global mi_gdb_prompt
103 global timeout
104 global gdb_spawn_id;
105 global MIFLAGS
106
107 gdb_stop_suppressing_tests;
ecd3fd0f
BR
108 set inferior_pty no-tty
109
110 if { [llength $args] == 1} {
111 set inferior_pty [lindex $args 0]
112 }
113
114 set separate_inferior_pty [string match $inferior_pty separate-inferior-tty]
fb40c209 115
1759b3c3
AC
116 # Start SID.
117 if { [info procs sid_start] != "" } {
118 verbose "Spawning SID"
119 sid_start
120 }
121
fb40c209
AC
122 verbose "Spawning $GDB -nw $GDBFLAGS $MIFLAGS"
123
124 if [info exists gdb_spawn_id] {
125 return 0;
126 }
127
128 if ![is_remote host] {
129 if { [which $GDB] == 0 } then {
130 perror "$GDB does not exist."
131 exit 1
132 }
133 }
ecd3fd0f
BR
134
135 # Create the new PTY for the inferior process.
136 if { $separate_inferior_pty } {
137 spawn -pty
138 global mi_inferior_spawn_id
139 global mi_inferior_tty_name
140 set mi_inferior_spawn_id $spawn_id
141 set mi_inferior_tty_name $spawn_out(slave,name)
142 }
143
fb40c209
AC
144 set res [remote_spawn host "$GDB -nw $GDBFLAGS $MIFLAGS [host_info gdb_opts]"];
145 if { $res < 0 || $res == "" } {
146 perror "Spawning $GDB failed."
147 return 1;
148 }
149 gdb_expect {
1f312e79
JJ
150 -re "~\"GNU.*\r\n~\".*$mi_gdb_prompt$" {
151 # We have a new format mi startup prompt. If we are
152 # running mi1, then this is an error as we should be
153 # using the old-style prompt.
154 if { $MIFLAGS == "-i=mi1" } {
155 perror "(mi startup) Got unexpected new mi prompt."
156 remote_close host;
157 return -1;
158 }
159 verbose "GDB initialized."
160 }
161 -re "\[^~\].*$mi_gdb_prompt$" {
162 # We have an old format mi startup prompt. If we are
163 # not running mi1, then this is an error as we should be
164 # using the new-style prompt.
165 if { $MIFLAGS != "-i=mi1" } {
166 perror "(mi startup) Got unexpected old mi prompt."
167 remote_close host;
168 return -1;
169 }
d20bf2e8 170 verbose "GDB initialized."
fb40c209 171 }
76c520e0
AC
172 -re ".*unrecognized option.*for a complete list of options." {
173 untested "Skip mi tests (not compiled with mi support)."
174 remote_close host;
175 return -1;
176 }
7d76bd60
MK
177 -re ".*Interpreter `mi' unrecognized." {
178 untested "Skip mi tests (not compiled with mi support)."
179 remote_close host;
180 return -1;
181 }
fb40c209
AC
182 timeout {
183 perror "(timeout) GDB never initialized after 10 seconds."
184 remote_close host;
185 return -1
186 }
187 }
188 set gdb_spawn_id -1;
189
190 # FIXME: mi output does not go through pagers, so these can be removed.
191 # force the height to "unlimited", so no pagers get used
192 send_gdb "100-gdb-set height 0\n"
193 gdb_expect 10 {
194 -re ".*100-gdb-set height 0\r\n100\\\^done\r\n$mi_gdb_prompt$" {
195 verbose "Setting height to 0." 2
196 }
197 timeout {
198 warning "Couldn't set the height to 0"
199 }
200 }
201 # force the width to "unlimited", so no wraparound occurs
202 send_gdb "101-gdb-set width 0\n"
203 gdb_expect 10 {
204 -re ".*101-gdb-set width 0\r\n101\\\^done\r\n$mi_gdb_prompt$" {
205 verbose "Setting width to 0." 2
206 }
207 timeout {
208 warning "Couldn't set the width to 0."
209 }
210 }
ecd3fd0f
BR
211 # If allowing the inferior to have its own PTY then assign the inferior
212 # its own terminal device here.
213 if { $separate_inferior_pty } {
214 send_gdb "102-inferior-tty-set $mi_inferior_tty_name\n"
215 gdb_expect 10 {
216 -re ".*102\\\^done\r\n$mi_gdb_prompt$" {
217 verbose "redirect inferior output to new terminal device."
218 }
219 timeout {
220 warning "Couldn't redirect inferior output." 2
221 }
222 }
223 }
fb40c209 224
f7f9a841
VP
225 detect_async
226
fb40c209
AC
227 return 0;
228}
229
79732189
AR
230#
231# Overridable function. You can override this function in your
232# baseboard file.
233#
234proc mi_gdb_start { args } {
235 return [default_mi_gdb_start $args]
236}
237
fb40c209
AC
238# Many of the tests depend on setting breakpoints at various places and
239# running until that breakpoint is reached. At times, we want to start
240# with a clean-slate with respect to breakpoints, so this utility proc
241# lets us do this without duplicating this code everywhere.
242#
243
244proc mi_delete_breakpoints {} {
245 global mi_gdb_prompt
246
247# FIXME: The mi operation won't accept a prompt back and will use the 'all' arg
248 send_gdb "102-break-delete\n"
249 gdb_expect 30 {
250 -re "Delete all breakpoints.*y or n.*$" {
251 send_gdb "y\n";
252 exp_continue
253 }
39fb8e9e 254 -re "102-break-delete\r\n102\\\^done\r\n$mi_gdb_prompt$" {
fb40c209
AC
255 # This happens if there were no breakpoints
256 }
f1c8a949 257 timeout { perror "Delete all breakpoints in mi_delete_breakpoints (timeout)" ; return }
fb40c209
AC
258 }
259
260# The correct output is not "No breakpoints or watchpoints." but an
261# empty BreakpointTable. Also, a query is not acceptable with mi.
262 send_gdb "103-break-list\n"
263 gdb_expect 30 {
264 -re "103-break-list\r\n103\\\^done,BreakpointTable=\{\}\r\n$mi_gdb_prompt$" {}
6f3f3097 265 -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$" {}
fb40c209
AC
266 -re "103-break-list\r\n103\\\^doneNo breakpoints or watchpoints.\r\n\r\n$mi_gdb_prompt$" {warning "Unexpected console text received"}
267 -re "$mi_gdb_prompt$" { perror "Breakpoints not deleted" ; return }
268 -re "Delete all breakpoints.*or n.*$" {
269 warning "Unexpected prompt for breakpoints deletion";
270 send_gdb "y\n";
271 exp_continue
272 }
273 timeout { perror "-break-list (timeout)" ; return }
274 }
275}
276
277proc mi_gdb_reinitialize_dir { subdir } {
278 global mi_gdb_prompt
da81390b 279 global MIFLAGS
fb40c209
AC
280
281 global suppress_flag
282 if { $suppress_flag } {
283 return
284 }
285
286 if [is_remote host] {
287 return "";
288 }
289
da81390b
JJ
290 if { $MIFLAGS == "-i=mi1" } {
291 send_gdb "104-environment-directory\n"
292 gdb_expect 60 {
fb40c209
AC
293 -re ".*Reinitialize source path to empty.*y or n. " {
294 warning "Got confirmation prompt for dir reinitialization."
295 send_gdb "y\n"
296 gdb_expect 60 {
297 -re "$mi_gdb_prompt$" {}
298 timeout {error "Dir reinitialization failed (timeout)"}
299 }
300 }
301 -re "$mi_gdb_prompt$" {}
302 timeout {error "Dir reinitialization failed (timeout)"}
da81390b
JJ
303 }
304 } else {
305 send_gdb "104-environment-directory -r\n"
306 gdb_expect 60 {
307 -re "104\\\^done,source-path=.*\r\n$mi_gdb_prompt$" {}
308 -re "$mi_gdb_prompt$" {}
309 timeout {error "Dir reinitialization failed (timeout)"}
310 }
fb40c209
AC
311 }
312
313 send_gdb "105-environment-directory $subdir\n"
314 gdb_expect 60 {
315 -re "Source directories searched.*$mi_gdb_prompt$" {
316 verbose "Dir set to $subdir"
317 }
da81390b 318 -re "105\\\^done.*\r\n$mi_gdb_prompt$" {
fb40c209
AC
319 # FIXME: We return just the prompt for now.
320 verbose "Dir set to $subdir"
321 # perror "Dir \"$subdir\" failed."
322 }
323 }
324}
325
da6012e5
DJ
326# Send GDB the "target" command.
327# FIXME: Some of these patterns are not appropriate for MI. Based on
328# config/monitor.exp:gdb_target_command.
329proc mi_gdb_target_cmd { targetname serialport } {
330 global mi_gdb_prompt
331
ef783a7d 332 set serialport_re [string_to_regexp $serialport]
da6012e5
DJ
333 for {set i 1} {$i <= 3} {incr i} {
334 send_gdb "47-target-select $targetname $serialport\n"
335 gdb_expect 60 {
336 -re "47\\^connected.*$mi_gdb_prompt$" {
337 verbose "Set target to $targetname";
338 return 0;
339 }
401ea829
JB
340 -re "unknown host.*$mi_gdb_prompt" {
341 verbose "Couldn't look up $serialport"
342 }
da6012e5
DJ
343 -re "Couldn't establish connection to remote.*$mi_gdb_prompt$" {
344 verbose "Connection failed";
345 }
346 -re "Remote MIPS debugging.*$mi_gdb_prompt$" {
347 verbose "Set target to $targetname";
348 return 0;
349 }
ef783a7d 350 -re "Remote debugging using .*$serialport_re.*$mi_gdb_prompt$" {
da6012e5
DJ
351 verbose "Set target to $targetname";
352 return 0;
353 }
354 -re "Remote target $targetname connected to.*$mi_gdb_prompt$" {
355 verbose "Set target to $targetname";
356 return 0;
357 }
358 -re "Connected to.*$mi_gdb_prompt$" {
359 verbose "Set target to $targetname";
360 return 0;
361 }
362 -re "Ending remote.*$mi_gdb_prompt$" { }
363 -re "Connection refused.*$mi_gdb_prompt$" {
364 verbose "Connection refused by remote target. Pausing, and trying again."
365 sleep 5
366 continue
367 }
368 -re "Timeout reading from remote system.*$mi_gdb_prompt$" {
369 verbose "Got timeout error from gdb.";
370 }
371 timeout {
372 send_gdb "\ 3";
373 break
374 }
375 }
376 }
377 return 1
378}
379
fb40c209 380#
da6012e5 381# load a file into the debugger (file command only).
fb40c209
AC
382# return a -1 if anything goes wrong.
383#
da6012e5 384proc mi_gdb_file_cmd { arg } {
fb40c209
AC
385 global verbose
386 global loadpath
387 global loadfile
388 global GDB
389 global mi_gdb_prompt
b741e217 390 global last_loaded_file
fb40c209
AC
391 upvar timeout timeout
392
b741e217 393 set last_loaded_file $arg
b53f9b27 394
da6012e5
DJ
395 if [is_remote host] {
396 set arg [remote_download host $arg];
397 if { $arg == "" } {
398 error "download failed"
399 return -1;
400 }
401 }
fb40c209 402
fb40c209
AC
403# FIXME: Several of these patterns are only acceptable for console
404# output. Queries are an error for mi.
405 send_gdb "105-file-exec-and-symbols $arg\n"
406 gdb_expect 120 {
407 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
408 verbose "\t\tLoaded $arg into the $GDB"
da6012e5 409 return 0
fb40c209
AC
410 }
411 -re "has no symbol-table.*$mi_gdb_prompt$" {
412 perror "$arg wasn't compiled with \"-g\""
413 return -1
414 }
fb40c209
AC
415 -re "Load new symbol table from \".*\".*y or n. $" {
416 send_gdb "y\n"
417 gdb_expect 120 {
418 -re "Reading symbols from.*done.*$mi_gdb_prompt$" {
419 verbose "\t\tLoaded $arg with new symbol table into $GDB"
420 # All OK
421 }
422 timeout {
423 perror "(timeout) Couldn't load $arg, other program already loaded."
424 return -1
425 }
426 }
427 }
428 -re "No such file or directory.*$mi_gdb_prompt$" {
429 perror "($arg) No such file or directory\n"
430 return -1
431 }
432 -re "105-file-exec-and-symbols .*\r\n105\\\^done\r\n$mi_gdb_prompt$" {
da6012e5
DJ
433 # We (MI) are just giving the prompt back for now, instead of giving
434 # some acknowledgement.
435 return 0
436 }
fb40c209
AC
437 timeout {
438 perror "couldn't load $arg into $GDB (timed out)."
439 return -1
440 }
da6012e5 441 eof {
fb40c209
AC
442 # This is an attempt to detect a core dump, but seems not to
443 # work. Perhaps we need to match .* followed by eof, in which
444 # gdb_expect does not seem to have a way to do that.
445 perror "couldn't load $arg into $GDB (end of file)."
446 return -1
447 }
448 }
da6012e5
DJ
449}
450
451#
b741e217 452# connect to the target and download a file, if necessary.
da6012e5
DJ
453# return a -1 if anything goes wrong.
454#
b741e217 455proc mi_gdb_target_load { } {
da6012e5
DJ
456 global verbose
457 global loadpath
458 global loadfile
459 global GDB
460 global mi_gdb_prompt
461 upvar timeout timeout
462
da6012e5 463 if { [info procs gdbserver_gdb_load] != "" } {
2226f861 464 mi_gdb_test "kill" ".*" ""
b741e217 465 set res [gdbserver_gdb_load]
da6012e5
DJ
466 set protocol [lindex $res 0]
467 set gdbport [lindex $res 1]
468
469 if { [mi_gdb_target_cmd $protocol $gdbport] != 0 } {
470 return -1
471 }
472 } elseif { [info procs send_target_sid] != "" } {
fb40c209 473 # For SID, things get complex
2b97317d
KB
474 send_gdb "kill\n"
475 gdb_expect 10 {
476 -re ".*$mi_gdb_prompt$"
477 }
fb40c209
AC
478 send_target_sid
479 gdb_expect 60 {
2f168eed 480 -re "\\^done.*$mi_gdb_prompt$" {
fb40c209
AC
481 }
482 timeout {
483 perror "Unable to connect to SID target"
484 return -1
485 }
486 }
487 send_gdb "48-target-download\n"
488 gdb_expect 10 {
489 -re "48\\^done.*$mi_gdb_prompt$" {
490 }
491 timeout {
492 perror "Unable to download to SID target"
493 return -1
494 }
495 }
496 } elseif { [target_info protocol] == "sim" } {
497 # For the simulator, just connect to it directly.
498 send_gdb "47-target-select sim\n"
499 gdb_expect 10 {
500 -re "47\\^connected.*$mi_gdb_prompt$" {
501 }
502 timeout {
503 perror "Unable to select sim target"
504 return -1
505 }
506 }
507 send_gdb "48-target-download\n"
508 gdb_expect 10 {
509 -re "48\\^done.*$mi_gdb_prompt$" {
510 }
511 timeout {
512 perror "Unable to download to sim target"
513 return -1
514 }
515 }
b53f9b27
MS
516 } elseif { [target_info gdb_protocol] == "remote" } {
517 # remote targets
8e3049aa
PB
518 if { [mi_gdb_target_cmd "remote" [target_info netport]] != 0 } {
519 perror "Unable to connect to remote target"
520 return -1
b53f9b27
MS
521 }
522 send_gdb "48-target-download\n"
523 gdb_expect 10 {
524 -re "48\\^done.*$mi_gdb_prompt$" {
525 }
526 timeout {
527 perror "Unable to download to remote target"
528 return -1
529 }
530 }
fb40c209
AC
531 }
532 return 0
533}
534
b741e217
DJ
535#
536# load a file into the debugger.
537# return a -1 if anything goes wrong.
538#
539proc mi_gdb_load { arg } {
540 if { $arg != "" } {
541 return [mi_gdb_file_cmd $arg]
542 }
543 return 0
544}
545
ecd3fd0f
BR
546# mi_gdb_test COMMAND PATTERN MESSAGE [IPATTERN] -- send a command to gdb;
547# test the result.
fb40c209
AC
548#
549# COMMAND is the command to execute, send to GDB with send_gdb. If
550# this is the null string no command is sent.
551# PATTERN is the pattern to match for a PASS, and must NOT include
552# the \r\n sequence immediately before the gdb prompt.
f1ea48cb
BR
553# MESSAGE is the message to be printed. (If this is the empty string,
554# then sometimes we don't call pass or fail at all; I don't
555# understand this at all.)
ecd3fd0f
BR
556# IPATTERN is the pattern to match for the inferior's output. This parameter
557# is optional. If present, it will produce a PASS if the match is
558# successful, and a FAIL if unsuccessful.
fb40c209
AC
559#
560# Returns:
561# 1 if the test failed,
562# 0 if the test passes,
563# -1 if there was an internal error.
564#
565proc mi_gdb_test { args } {
566 global verbose
567 global mi_gdb_prompt
07c98896 568 global GDB expect_out
fb40c209
AC
569 upvar timeout timeout
570
fb40c209
AC
571 set command [lindex $args 0]
572 set pattern [lindex $args 1]
f1ea48cb 573 set message [lindex $args 2]
fb40c209 574
ecd3fd0f
BR
575 if [llength $args]==4 {
576 set ipattern [lindex $args 3]
577 }
578
fb40c209
AC
579 if [llength $args]==5 {
580 set question_string [lindex $args 3];
581 set response_string [lindex $args 4];
582 } else {
583 set question_string "^FOOBAR$"
584 }
585
586 if $verbose>2 then {
587 send_user "Sending \"$command\" to gdb\n"
588 send_user "Looking to match \"$pattern\"\n"
589 send_user "Message is \"$message\"\n"
590 }
591
592 set result -1
593 set string "${command}\n";
39fb8e9e
BR
594 set string_regex [string_to_regexp $command]
595
fb40c209
AC
596 if { $command != "" } {
597 while { "$string" != "" } {
598 set foo [string first "\n" "$string"];
599 set len [string length "$string"];
600 if { $foo < [expr $len - 1] } {
601 set str [string range "$string" 0 $foo];
602 if { [send_gdb "$str"] != "" } {
603 global suppress_flag;
604
605 if { ! $suppress_flag } {
606 perror "Couldn't send $command to GDB.";
607 }
608 fail "$message";
609 return $result;
610 }
611 gdb_expect 2 {
612 -re "\[\r\n\]" { }
613 timeout { }
614 }
615 set string [string range "$string" [expr $foo + 1] end];
616 } else {
617 break;
618 }
619 }
620 if { "$string" != "" } {
621 if { [send_gdb "$string"] != "" } {
622 global suppress_flag;
623
624 if { ! $suppress_flag } {
625 perror "Couldn't send $command to GDB.";
626 }
627 fail "$message";
628 return $result;
629 }
630 }
631 }
632
633 if [info exists timeout] {
634 set tmt $timeout;
635 } else {
636 global timeout;
637 if [info exists timeout] {
638 set tmt $timeout;
639 } else {
640 set tmt 60;
641 }
642 }
9d81d21b 643 verbose -log "Expecting: ^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)"
fb40c209
AC
644 gdb_expect $tmt {
645 -re "\\*\\*\\* DOSEXIT code.*" {
646 if { $message != "" } {
647 fail "$message";
648 }
649 gdb_suppress_entire_file "GDB died";
650 return -1;
651 }
652 -re "Ending remote debugging.*$mi_gdb_prompt\[ \]*$" {
653 if ![isnative] then {
654 warning "Can`t communicate to remote target."
655 }
656 gdb_exit
657 gdb_start
658 set result -1
7ddebc7e 659 }
39fb8e9e
BR
660 -re "^($string_regex\[\r\n\]+)?($pattern\[\r\n\]+$mi_gdb_prompt\[ \]*)" {
661 # At this point, $expect_out(1,string) is the MI input command.
662 # and $expect_out(2,string) is the MI output command.
663 # If $expect_out(1,string) is "", then there was no MI input command here.
664
40e55bef
BR
665 # NOTE, there is no trailing anchor because with GDB/MI,
666 # asynchronous responses can happen at any point, causing more
667 # data to be available. Normally an anchor is used to make
668 # sure the end of the output is matched, however, $mi_gdb_prompt
669 # is just as good of an anchor since mi_gdb_test is meant to
670 # match a single mi output command. If a second GDB/MI output
671 # response is sent, it will be in the buffer for the next
672 # time mi_gdb_test is called.
7ddebc7e
KS
673 if ![string match "" $message] then {
674 pass "$message"
675 }
676 set result 0
fb40c209
AC
677 }
678 -re "(${question_string})$" {
679 send_gdb "$response_string\n";
680 exp_continue;
681 }
682 -re "Undefined.* command:.*$mi_gdb_prompt\[ \]*$" {
683 perror "Undefined command \"$command\"."
684 fail "$message"
685 set result 1
686 }
687 -re "Ambiguous command.*$mi_gdb_prompt\[ \]*$" {
688 perror "\"$command\" is not a unique command name."
689 fail "$message"
690 set result 1
fb40c209
AC
691 }
692 -re "Program exited with code \[0-9\]+.*$mi_gdb_prompt\[ \]*$" {
693 if ![string match "" $message] then {
ed4c619a 694 set errmsg "$message (the program exited)"
fb40c209 695 } else {
ed4c619a 696 set errmsg "$command (the program exited)"
fb40c209
AC
697 }
698 fail "$errmsg"
699 return -1
700 }
701 -re "The program is not being run.*$mi_gdb_prompt\[ \]*$" {
702 if ![string match "" $message] then {
ed4c619a 703 set errmsg "$message (the program is no longer running)"
fb40c209 704 } else {
ed4c619a 705 set errmsg "$command (the program is no longer running)"
fb40c209
AC
706 }
707 fail "$errmsg"
708 return -1
709 }
710 -re ".*$mi_gdb_prompt\[ \]*$" {
711 if ![string match "" $message] then {
712 fail "$message"
713 }
714 set result 1
715 }
716 "<return>" {
717 send_gdb "\n"
718 perror "Window too small."
719 fail "$message"
720 }
721 -re "\\(y or n\\) " {
722 send_gdb "n\n"
723 perror "Got interactive prompt."
724 fail "$message"
725 }
726 eof {
727 perror "Process no longer exists"
728 if { $message != "" } {
729 fail "$message"
730 }
731 return -1
732 }
733 full_buffer {
734 perror "internal buffer is full."
735 fail "$message"
736 }
737 timeout {
738 if ![string match "" $message] then {
739 fail "$message (timeout)"
740 }
741 set result 1
742 }
743 }
ecd3fd0f
BR
744
745 # If the GDB output matched, compare the inferior output.
746 if { $result == 0 } {
747 if [ info exists ipattern ] {
d084b331
DJ
748 if { ![target_info exists gdb,noinferiorio] } {
749 global mi_inferior_spawn_id
750 expect {
751 -i $mi_inferior_spawn_id -re "$ipattern" {
752 pass "$message inferior output"
753 }
754 timeout {
755 fail "$message inferior output (timeout)"
756 set result 1
757 }
ecd3fd0f 758 }
d084b331
DJ
759 } else {
760 unsupported "$message inferior output"
ecd3fd0f
BR
761 }
762 }
763 }
764
fb40c209
AC
765 return $result
766}
767
768#
769# MI run command. (A modified version of gdb_run_cmd)
770#
771
772# In patterns, the newline sequence ``\r\n'' is matched explicitly as
773# ``.*$'' could swallow up output that we attempt to match elsewhere.
774
775proc mi_run_cmd {args} {
776 global suppress_flag
777 if { $suppress_flag } {
778 return -1
779 }
780 global mi_gdb_prompt
781
782 if [target_info exists gdb_init_command] {
783 send_gdb "[target_info gdb_init_command]\n";
784 gdb_expect 30 {
785 -re "$mi_gdb_prompt$" { }
786 default {
787 perror "gdb_init_command for target failed";
788 return;
789 }
790 }
791 }
792
b741e217
DJ
793 if { [mi_gdb_target_load] < 0 } {
794 return
795 }
796
fb40c209
AC
797 if [target_info exists use_gdb_stub] {
798 if [target_info exists gdb,do_reload_on_run] {
bb378428 799 send_gdb "220-exec-continue\n";
fb40c209 800 gdb_expect 60 {
a2840c35 801 -re "220\\^running\[\r\n\]+\\*running,thread-id=\"\[^\"\]+\"\r\n$mi_gdb_prompt$" {}
fb40c209
AC
802 default {}
803 }
804 return;
805 }
6a90e1d0
AC
806
807 if [target_info exists gdb,start_symbol] {
808 set start [target_info gdb,start_symbol];
809 } else {
810 set start "start";
811 }
812
813 # HACK: Should either use 000-jump or fix the target code
814 # to better handle RUN.
815 send_gdb "jump *$start\n"
816 warning "Using CLI jump command, expect run-to-main FAIL"
817 return
fb40c209
AC
818 }
819
bb378428 820 send_gdb "220-exec-run $args\n"
fb40c209 821 gdb_expect {
e1ac3328 822 -re "220\\^running\r\n(\\*running,thread-id=\"\[^\"\]+\"\r\n|=thread-created,id=\"1\"\r\n)*${mi_gdb_prompt}" {
fb40c209
AC
823 }
824 timeout {
825 perror "Unable to start target"
826 return
827 }
828 }
2d0720d9 829 # NOTE: Shortly after this there will be a ``000*stopped,...(gdb)''
fb40c209
AC
830}
831
832#
833# Just like run-to-main but works with the MI interface
834#
835
836proc mi_run_to_main { } {
837 global suppress_flag
838 if { $suppress_flag } {
839 return -1
840 }
841
fb40c209
AC
842 global srcdir
843 global subdir
844 global binfile
845 global srcfile
846
fb40c209
AC
847 mi_delete_breakpoints
848 mi_gdb_reinitialize_dir $srcdir/$subdir
849 mi_gdb_load ${binfile}
850
08b468e0
KS
851 mi_runto main
852}
fb40c209 853
08b468e0
KS
854
855# Just like gdb's "runto" proc, it will run the target to a given
856# function. The big difference here between mi_runto and mi_execute_to
857# is that mi_execute_to must have the inferior running already. This
858# proc will (like gdb's runto) (re)start the inferior, too.
859#
860# FUNC is the linespec of the place to stop (it inserts a breakpoint here).
861# It returns:
862# -1 if test suppressed, failed, timedout
863# 0 if test passed
864
f7e97bb3 865proc mi_runto_helper {func run_or_continue} {
08b468e0
KS
866 global suppress_flag
867 if { $suppress_flag } {
868 return -1
869 }
870
871 global mi_gdb_prompt expect_out
76ff342d 872 global hex decimal fullname_syntax
08b468e0
KS
873
874 set test "mi runto $func"
038224f6 875 mi_gdb_test "200-break-insert -t $func" \
d24317b4 876 "200\\^done,bkpt=\{number=\"\[0-9\]+\",type=\"breakpoint\",disp=\"del\",enabled=\"y\",addr=\"$hex\",func=\"$func\(\\\(.*\\\)\)?\",file=\".*\",line=\"\[0-9\]*\",times=\"0\",original-location=\".*\"\}" \
08b468e0
KS
877 "breakpoint at $func"
878
879 if {![regexp {number="[0-9]+"} $expect_out(buffer) str]
880 || ![scan $str {number="%d"} bkptno]} {
881 set bkptno {[0-9]+}
882 }
883
f7e97bb3
VP
884 if {$run_or_continue == "run"} {
885 mi_run_cmd
886 } else {
bb378428 887 mi_send_resuming_command "exec-continue" "$test"
f7e97bb3 888 }
74a44383 889
18ac113b 890 mi_expect_stop "breakpoint-hit" $func ".*" ".*" "\[0-9\]+" { "" "disp=\"del\"" } $test
fb40c209
AC
891}
892
f7e97bb3
VP
893proc mi_runto {func} {
894 mi_runto_helper $func "run"
895}
fb40c209
AC
896
897# Next to the next statement
08b468e0 898# For return values, see mi_execute_to_helper
fb40c209
AC
899
900proc mi_next { test } {
dc360f58 901 return [mi_next_to {.*} {.*} {.*} {.*} $test]
fb40c209
AC
902}
903
904
905# Step to the next statement
08b468e0 906# For return values, see mi_execute_to_helper
fb40c209
AC
907
908proc mi_step { test } {
dc360f58 909 return [mi_step_to {.*} {.*} {.*} {.*} $test]
fb40c209 910}
dcf95b47 911
f7f9a841
VP
912set async "unknown"
913
914proc detect_async {} {
915 global async
916 global mi_gdb_prompt
917
a2840c35 918 send_gdb "maint show linux-async\n"
f7f9a841 919
a2840c35
VP
920 gdb_expect {
921 -re ".*Controlling the GNU/Linux inferior in asynchronous mode is on...*$mi_gdb_prompt$" {
922 set async 1
923 }
924 -re ".*$mi_gdb_prompt$" {
925 set async 0
926 }
927 timeout {
928 set async 0
f7f9a841
VP
929 }
930 }
931 return $async
932}
933
bb378428
VP
934# Wait for MI *stopped notification to appear.
935# The REASON, FUNC, ARGS, FILE and LINE are regular expressions
936# to match against whatever is output in *stopped. ARGS should
937# not include [] the list of argument is enclosed in, and other
938# regular expressions should not include quotes.
939# If EXTRA is a list of one element, it's the regular expression
940# for output expected right after *stopped, and before GDB prompt.
941# If EXTRA is a list of two elements, the first element is for
942# output right after *stopped, and the second element is output
943# right after reason field. The regex after reason should not include
944# the comma separating it from the following fields.
945#
946# When we fail to match output at all, -1 is returned. Otherwise,
947# the line at which we stop is returned. This is useful when exact
948# line is not possible to specify for some reason -- one can pass
949# the .* regexp for line, and then check the line programmatically.
950proc mi_expect_stop { reason func args file line extra test } {
1902c51f 951
dcf95b47
DJ
952 global mi_gdb_prompt
953 global hex
954 global decimal
76ff342d 955 global fullname_syntax
f7f9a841 956 global async
bb378428
VP
957
958 set after_stopped ""
959 set after_reason ""
960 if { [llength $extra] == 2 } {
961 set after_stopped [lindex $extra 0]
962 set after_reason [lindex $extra 1]
963 set after_reason "${after_reason},"
964 } elseif { [llength $extra] == 1 } {
965 set after_stopped [lindex $extra 0]
966 }
967
f7f9a841
VP
968 if {$async} {
969 set prompt_re ""
970 } else {
971 set prompt_re "$mi_gdb_prompt"
972 }
973
974 if { $reason == "really-no-reason" } {
975 gdb_expect {
976 -re "\\*stopped\r\n$prompt_re$" {
977 pass "$test"
978 }
979 timeout {
980 fail "$test (unknown output after running)"
981 }
982 }
983 return
984 }
985
bb378428
VP
986 if { $reason == "exited-normally" } {
987
988 gdb_expect {
f7f9a841 989 -re "\\*stopped,reason=\"exited-normally\"\r\n$prompt_re$" {
bb378428
VP
990 pass "$test"
991 }
992 -re ".*$mi_gdb_prompt$" {fail "continue to end (2)"}
993 timeout {
994 fail "$test (unknown output after running)"
995 }
996 }
997 return
998 }
999
1000 set args "\\\[$args\\\]"
1001
1002 set bn ""
1003 if { $reason == "breakpoint-hit" } {
1004 set bn {bkptno="[0-9]+",}
1005 }
1006
1007 set r ""
1008 if { $reason != "" } {
1009 set r "reason=\"$reason\","
1010 }
1011
18ac113b
AR
1012
1013 set a $after_reason
1014
b1a268e5 1015 verbose -log "mi_expect_stop: expecting: \\*stopped,${r}${a}${bn}thread-id=\"$decimal\",stopped-threads=.*,frame=\{addr=\"$hex\",func=\"$func\",args=$args,file=\".*$file\",fullname=\"${fullname_syntax}$file\",line=\"$line\"\}$after_stopped\r\n$prompt_re$"
dcf95b47 1016 gdb_expect {
b1a268e5 1017 -re "\\*stopped,${r}${a}${bn}thread-id=\"$decimal\",stopped-threads=.*,frame=\{addr=\"$hex\",func=\"$func\",args=$args,file=\".*$file\",fullname=\"${fullname_syntax}$file\",line=\"($line)\"\}$after_stopped\r\n$prompt_re$" {
dcf95b47 1018 pass "$test"
bb378428 1019 return $expect_out(2,string)
dcf95b47 1020 }
b1a268e5 1021 -re "\\*stopped,${r}${a}${bn}thread-id=\"$decimal\",stopped-threads=.*,frame=\{addr=\"$hex\",func=\".*\",args=\[\\\[\{\].*\[\\\]\}\],file=\".*\",fullname=\"${fullname_syntax}.*\",line=\"\[0-9\]*\"\}.*\r\n$prompt_re$" {
dcf95b47
DJ
1022 fail "$test (stopped at wrong place)"
1023 return -1
1024 }
f7f9a841 1025 -re ".*\r\n$mi_gdb_prompt$" {
dcf95b47
DJ
1026 fail "$test (unknown output after running)"
1027 return -1
1028 }
dcf95b47
DJ
1029 timeout {
1030 fail "$test (timeout)"
1031 return -1
1032 }
bb378428 1033 }
dcf95b47
DJ
1034}
1035
bb378428
VP
1036# cmd should not include the number or newline (i.e. "exec-step 3", not
1037# "220-exec-step 3\n"
1038
1039# Can not match -re ".*\r\n${mi_gdb_prompt}", because of false positives
1040# after the first prompt is printed.
1041
08b468e0 1042proc mi_execute_to { cmd reason func args file line extra test } {
bb378428
VP
1043 global suppress_flag
1044 if { $suppress_flag } {
1045 return -1
1046 }
1047
1048 mi_send_resuming_command "$cmd" "$test"
1049 set r [mi_expect_stop $reason $func $args $file $line $extra $test]
1050 return $r
dcf95b47
DJ
1051}
1052
1053proc mi_next_to { func args file line test } {
08b468e0 1054 mi_execute_to "exec-next" "end-stepping-range" "$func" "$args" \
dcf95b47
DJ
1055 "$file" "$line" "" "$test"
1056}
1057
1058proc mi_step_to { func args file line test } {
08b468e0 1059 mi_execute_to "exec-step" "end-stepping-range" "$func" "$args" \
dcf95b47
DJ
1060 "$file" "$line" "" "$test"
1061}
1062
1063proc mi_finish_to { func args file line result ret test } {
08b468e0 1064 mi_execute_to "exec-finish" "function-finished" "$func" "$args" \
dcf95b47
DJ
1065 "$file" "$line" \
1066 ",gdb-result-var=\"$result\",return-value=\"$ret\"" \
1067 "$test"
1068}
1069
f7e97bb3
VP
1070proc mi_continue_to {func} {
1071 mi_runto_helper $func "continue"
dcf95b47
DJ
1072}
1073
08b468e0
KS
1074proc mi0_execute_to { cmd reason func args file line extra test } {
1075 mi_execute_to_helper "$cmd" "$reason" "$func" "\{$args\}" \
dcf95b47
DJ
1076 "$file" "$line" "$extra" "$test"
1077}
1078
1079proc mi0_next_to { func args file line test } {
08b468e0 1080 mi0_execute_to "exec-next" "end-stepping-range" "$func" "$args" \
dcf95b47
DJ
1081 "$file" "$line" "" "$test"
1082}
1083
1084proc mi0_step_to { func args file line test } {
08b468e0 1085 mi0_execute_to "exec-step" "end-stepping-range" "$func" "$args" \
dcf95b47
DJ
1086 "$file" "$line" "" "$test"
1087}
1088
1089proc mi0_finish_to { func args file line result ret test } {
08b468e0 1090 mi0_execute_to "exec-finish" "function-finished" "$func" "$args" \
dcf95b47
DJ
1091 "$file" "$line" \
1092 ",gdb-result-var=\"$result\",return-value=\"$ret\"" \
1093 "$test"
1094}
1095
1096proc mi0_continue_to { bkptno func args file line test } {
08b468e0 1097 mi0_execute_to "exec-continue" "breakpoint-hit\",bkptno=\"$bkptno" \
dcf95b47
DJ
1098 "$func" "$args" "$file" "$line" "" "$test"
1099}
b26ed50d 1100
d24317b4
VP
1101# Creates a breakpoint and checks the reported fields are as expected
1102proc mi_create_breakpoint { location number disp func file line address test } {
1103 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=\".*\"\}"
1104 mi_gdb_test "222-break-insert $location" \
1105 "222\\^done,bkpt=\{number=\"$number\",type=\"breakpoint\",disp=\"$disp\",enabled=\"y\",addr=\"$address\",func=\"$func\",file=\"$file\",fullname=\".*\",line=\"$line\",times=\"0\",original-location=\".*\"\}" \
1106 $test
1107}
1108
1109proc mi_list_breakpoints { expected test } {
1110 set fullname ".*"
1111
1112 set body ""
1113 set first 1
1114
1115 foreach item $children {
1116 if {$first == 0} {
1117 set body "$body,"
1118 }
1119 set number disp func file line address
1120 set number [lindex $item 0]
1121 set disp [lindex $item 1]
1122 set func [lindex $item 2]
1123 set line [lindex $item 3]
1124 set address [lindex $item 4]
1125 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=\".*\"\}"
1126 set first 0
1127 }
1128
1129 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\\\]\}" \
1130 mi_gdb_test "666-break-list" \
1131 "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\\\]\}" \
1132 $test
1133}
1134
b26ed50d
VP
1135# Creates varobj named NAME for EXPRESSION.
1136# Name cannot be "-".
1137proc mi_create_varobj { name expression testname } {
1138 mi_gdb_test "-var-create $name * $expression" \
983c9c8f 1139 "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=.*" \
b26ed50d
VP
1140 $testname
1141}
1142
fcacd99f
VP
1143proc mi_create_floating_varobj { name expression testname } {
1144 mi_gdb_test "-var-create $name @ $expression" \
1145 "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=.*" \
1146 $testname
1147}
1148
1149
9e8e3afe
VP
1150# Same as mi_create_varobj, but also checks the reported type
1151# of the varobj.
1152proc mi_create_varobj_checked { name expression type testname } {
1153 mi_gdb_test "-var-create $name * $expression" \
1154 "\\^done,name=\"$name\",numchild=\"\[0-9\]+\",value=\".*\",type=\"$type\".*" \
1155 $testname
1156}
1157
6e2a9270
VP
1158# Deletes the specified NAME.
1159proc mi_delete_varobj { name testname } {
1160 mi_gdb_test "-var-delete $name" \
1161 "\\^done,ndeleted=.*" \
1162 $testname
1163}
1164
b26ed50d
VP
1165# Updates varobj named NAME and checks that all varobjs in EXPECTED
1166# are reported as updated, and no other varobj is updated.
1167# Assumes that no varobj is out of scope and that no varobj changes
1168# types.
1169proc mi_varobj_update { name expected testname } {
1170 set er "\\^done,changelist=\\\["
1171 set first 1
1172 foreach item $expected {
1173 set v "{name=\"$item\",in_scope=\"true\",type_changed=\"false\"}"
25d5ea92 1174 if {$first == 1} {
b26ed50d 1175 set er "$er$v"
25d5ea92 1176 set first 0
b26ed50d
VP
1177 } else {
1178 set er "$er,$v"
1179 }
1180 }
1181 set er "$er\\\]"
1182
1183 verbose -log "Expecting: $er" 2
1184 mi_gdb_test "-var-update $name" $er $testname
1185}
1186
fcacd99f
VP
1187proc mi_varobj_update_with_type_change { name new_type new_children testname } {
1188 set v "{name=\"$name\",in_scope=\"true\",type_changed=\"true\",new_type=\"$new_type\",new_num_children=\"$new_children\"}"
1189 set er "\\^done,changelist=\\\[$v\\\]"
1190 verbose -log "Expecting: $er"
1191 mi_gdb_test "-var-update $name" $er $testname
1192}
1193
b26ed50d
VP
1194proc mi_check_varobj_value { name value testname } {
1195
1196 mi_gdb_test "-var-evaluate-expression $name" \
1197 "\\^done,value=\"$value\"" \
1198 $testname
1199}
038224f6
VP
1200
1201# Check the results of the:
1202#
1203# -var-list-children VARNAME
1204#
1205# command. The CHILDREN parement should be a list of lists.
1206# Each inner list can have either 3 or 4 elements, describing
1207# fields that gdb is expected to report for child variable object,
1208# in the following order
1209#
1210# - Name
1211# - Expression
1212# - Number of children
1213# - Type
1214#
1215# If inner list has 3 elements, the gdb is expected to output no
9e8e3afe
VP
1216# type for a child and no value.
1217#
1218# If the inner list has 4 elements, gdb output is expected to
1219# have no value.
038224f6
VP
1220#
1221proc mi_list_varobj_children { varname children testname } {
1222
9e8e3afe
VP
1223 set options ""
1224 if {[llength $varname] == 2} {
1225 set options [lindex $varname 1]
1226 set varname [lindex $varname 0]
1227 }
1228
038224f6
VP
1229 set numchildren [llength $children]
1230 set children_exp {}
1231 set whatever "\"\[^\"\]+\""
1232
1233 foreach item $children {
1234
1235 set name [lindex $item 0]
1236 set exp [lindex $item 1]
1237 set numchild [lindex $item 2]
9e8e3afe 1238 if {[llength $item] == 5} {
038224f6 1239 set type [lindex $item 3]
9e8e3afe 1240 set value [lindex $item 4]
038224f6
VP
1241
1242 lappend children_exp\
9e8e3afe
VP
1243 "child={name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",value=\"$value\",type=\"$type\"\(,thread-id=\"\[0-9\]+\")?}"
1244 } elseif {[llength $item] == 4} {
1245 set type [lindex $item 3]
1246
1247 lappend children_exp\
1248 "child={name=\"$name\",exp=\"$exp\",numchild=\"$numchild\",type=\"$type\"\(,thread-id=\"\[0-9\]+\")?}"
038224f6
VP
1249 } else {
1250 lappend children_exp\
9e8e3afe 1251 "child={name=\"$name\",exp=\"$exp\",numchild=\"$numchild\"(,thread-id=\"\[0-9\]+\")?}"
038224f6
VP
1252 }
1253 }
1254 set children_exp_j [join $children_exp ","]
9e8e3afe
VP
1255 if {$numchildren} {
1256 set expected "\\^done,numchild=\".*\",children=\\\[$children_exp_j.*\\\]"
1257 } {
1258 set expected "\\^done,numchild=\"0\""
1259 }
038224f6
VP
1260
1261 verbose -log "Expecting: $expected"
1262
9e8e3afe
VP
1263 mi_gdb_test "-var-list-children $options $varname" $expected $testname
1264}
1265
1266# Verifies that variable object VARNAME has NUMBER children,
1267# where each one is named $VARNAME.<index-of-child> and has type TYPE.
1268proc mi_list_array_varobj_children { varname number type testname } {
1269 set t {}
1270 for {set i 0} {$i < $number} {incr i} {
1271 lappend t [list $varname.$i $i 0 $type]
1272 }
1273 mi_list_varobj_children $varname $t $testname
038224f6 1274}
2d0720d9
VP
1275
1276# A list of two-element lists. First element of each list is
1277# a Tcl statement, and the second element is the line
1278# number of source C file where the statement originates.
1279set mi_autotest_data ""
1280# The name of the source file for autotesting.
1281set mi_autotest_source ""
1282
1283proc count_newlines { string } {
1284 return [regexp -all "\n" $string]
1285}
1286
1287# Prepares for running inline tests in FILENAME.
1288# See comments for mi_run_inline_test for detailed
1289# explanation of the idea and syntax.
1290proc mi_prepare_inline_tests { filename } {
1291
1292 global srcdir
1293 global subdir
1294 global mi_autotest_source
1295 global mi_autotest_data
1296
1297 set mi_autotest_data {}
1298
1299 set mi_autotest_source $filename
1300
1301 if { ! [regexp "^/" "$filename"] } then {
1302 set filename "$srcdir/$subdir/$filename"
1303 }
1304
1305 set chan [open $filename]
1306 set content [read $chan]
1307 set line_number 1
1308 while {1} {
1309 set start [string first "/*:" $content]
1310 if {$start != -1} {
1311 set end [string first ":*/" $content]
1312 if {$end == -1} {
1313 error "Unterminated special comment in $filename"
1314 }
1315
1316 set prefix [string range $content 0 $start]
1317 set prefix_newlines [count_newlines $prefix]
1318
1319 set line_number [expr $line_number+$prefix_newlines]
1320 set comment_line $line_number
1321
1322 set comment [string range $content [expr $start+3] [expr $end-1]]
1323
1324 set comment_newlines [count_newlines $comment]
1325 set line_number [expr $line_number+$comment_newlines]
1326
1327 set comment [string trim $comment]
1328 set content [string range $content [expr $end+3] \
1329 [string length $content]]
1330 lappend mi_autotest_data [list $comment $comment_line]
1331 } else {
1332 break
1333 }
1334 }
1335 close $chan
1336}
1337
1338# Helper to mi_run_inline_test below.
1339# Return the list of all (statement,line_number) lists
1340# that comprise TESTCASE. The begin and end markers
1341# are not included.
1342proc mi_get_inline_test {testcase} {
1343
1344 global mi_gdb_prompt
1345 global mi_autotest_data
1346 global mi_autotest_source
1347
1348 set result {}
1349
1350 set seen_begin 0
1351 set seen_end 0
1352 foreach l $mi_autotest_data {
1353
1354 set comment [lindex $l 0]
1355
1356 if {$comment == "BEGIN: $testcase"} {
1357 set seen_begin 1
1358 } elseif {$comment == "END: $testcase"} {
1359 set seen_end 1
1360 break
1361 } elseif {$seen_begin==1} {
1362 lappend result $l
1363 }
1364 }
1365
1366 if {$seen_begin == 0} {
1367 error "Autotest $testcase not found"
1368 }
1369
1370 if {$seen_begin == 1 && $seen_end == 0} {
1371 error "Missing end marker for test $testcase"
1372 }
1373
1374 return $result
1375}
1376
1377# Sets temporary breakpoint at LOCATION.
1378proc mi_tbreak {location} {
1379
1380 global mi_gdb_prompt
1381
1382 mi_gdb_test "-break-insert -t $location" \
1383 {\^done,bkpt=.*} \
1384 "run to $location (set breakpoint)"
1385}
1386
1387# Send COMMAND that must be a command that resumes
1388# the inferiour (run/continue/next/etc) and consumes
1389# the "^running" output from it.
a2840c35 1390proc mi_send_resuming_command_raw {command test} {
2d0720d9
VP
1391
1392 global mi_gdb_prompt
1393
a2840c35 1394 send_gdb "$command\n"
2d0720d9 1395 gdb_expect {
a2840c35 1396 -re "\\^running\r\n\\*running,thread-id=\"\[^\"\]+\"\r\n${mi_gdb_prompt}" {
7ebd49dc
VP
1397 # Note that lack of 'pass' call here -- this works around limitation
1398 # in DejaGNU xfail mechanism. mi-until.exp has this:
1399 #
1400 # setup_kfail gdb/2104 "*-*-*"
1401 # mi_execute_to ...
1402 #
1403 # and mi_execute_to uses mi_send_resuming_command. If we use 'pass' here,
1404 # it will reset kfail, so when the actual test fails, it will be flagged
1405 # as real failure.
2d0720d9 1406 }
bb378428
VP
1407 -re ".*${mi_gdb_prompt}" {
1408 fail "$test (failed to resume)"
1409 }
a2840c35 1410 -re "\\^error,msg=.*" {
bb378428
VP
1411 fail "$test (MI error)"
1412 return -1
1413 }
2d0720d9 1414 timeout {
bb378428
VP
1415 fail "$test"
1416 return -1
2d0720d9
VP
1417 }
1418 }
1419}
1420
a2840c35
VP
1421proc mi_send_resuming_command {command test} {
1422 mi_send_resuming_command_raw -$command $test
1423}
1424
2d0720d9
VP
1425# Helper to mi_run_inline_test below.
1426# Sets a temporary breakpoint at LOCATION and runs
1427# the program using COMMAND. When the program is stopped
1428# returns the line at which it. Returns -1 if line cannot
1429# be determined.
1430# Does not check that the line is the same as requested.
1431# The caller can check itself if required.
a73bafbc 1432proc mi_continue_to_line {location test} {
2d0720d9
VP
1433
1434 mi_tbreak $location
1435 mi_send_resuming_command "exec-continue" "run to $location (exec-continue)"
bb378428 1436 return [mi_get_stop_line $test]
2d0720d9
VP
1437}
1438
1439# Wait until gdb prints the current line.
bb378428 1440proc mi_get_stop_line {test} {
2d0720d9
VP
1441
1442 global mi_gdb_prompt
f7f9a841
VP
1443 global async
1444
1445 if {$async} {
1446 set prompt_re ""
1447 } else {
1448 set prompt_re "$mi_gdb_prompt"
1449 }
2d0720d9
VP
1450
1451 gdb_expect {
f7f9a841 1452 -re ".*line=\"(.*)\".*\r\n$prompt_re$" {
2d0720d9
VP
1453 return $expect_out(1,string)
1454 }
1455 -re ".*$mi_gdb_prompt$" {
1456 fail "wait for stop ($test)"
1457 }
1458 timeout {
1459 fail "wait for stop ($test)"
1460 }
1461 }
1462}
1463
1464# Run a MI test embedded in comments in a C file.
1465# The C file should contain special comments in the following
1466# three forms:
1467#
1468# /*: BEGIN: testname :*/
1469# /*: <Tcl statements> :*/
1470# /*: END: testname :*/
1471#
1472# This procedure find the begin and end marker for the requested
1473# test. Then, a temporary breakpoint is set at the begin
1474# marker and the program is run (from start).
1475#
1476# After that, for each special comment between the begin and end
1477# marker, the Tcl statements are executed. It is assumed that
1478# for each comment, the immediately preceding line is executable
1479# C statement. Then, gdb will be single-stepped until that
1480# preceding C statement is executed, and after that the
1481# Tcl statements in the comment will be executed.
1482#
1483# For example:
1484#
1485# /*: BEGIN: assignment-test :*/
1486# v = 10;
1487# /*: <Tcl code to check that 'v' is indeed 10 :*/
1488# /*: END: assignment-test :*/
1489#
1490# The mi_prepare_inline_tests function should be called before
1491# calling this function. A given C file can contain several
1492# inline tests. The names of the tests must be unique within one
1493# C file.
1494#
1495proc mi_run_inline_test { testcase } {
1496
1497 global mi_gdb_prompt
1498 global hex
1499 global decimal
1500 global fullname_syntax
1501 global mi_autotest_source
1502
1503 set commands [mi_get_inline_test $testcase]
1504
1505 set first 1
1506 set line_now 1
1507
1508 foreach c $commands {
1509 set statements [lindex $c 0]
1510 set line [lindex $c 1]
1511 set line [expr $line-1]
1512
1513 # We want gdb to be stopped at the expression immediately
1514 # before the comment. If this is the first comment, the
1515 # program is either not started yet or is in some random place,
1516 # so we run it. For further comments, we might be already
1517 # standing at the right line. If not continue till the
1518 # right line.
1519
1520 if {$first==1} {
1521 # Start the program afresh.
1522 mi_tbreak "$mi_autotest_source:$line"
1523 mi_run_cmd
bb378428 1524 set line_now [mi_get_stop_line "$testcase: step to $line"]
2d0720d9
VP
1525 set first 0
1526 } elseif {$line_now!=$line} {
25d5ea92 1527 set line_now [mi_continue_to_line "$mi_autotest_source:$line" "continue to $line"]
2d0720d9
VP
1528 }
1529
1530 if {$line_now!=$line} {
1531 fail "$testcase: go to line $line"
1532 }
1533
1534 # We're not at the statement right above the comment.
1535 # Execute that statement so that the comment can test
1536 # the state after the statement is executed.
1537
1538 # Single-step past the line.
1539 mi_send_resuming_command "exec-next" "$testcase: step over $line"
bb378428 1540 set line_now [mi_get_stop_line "$testcase: step over $line"]
2d0720d9
VP
1541
1542 # We probably want to use 'uplevel' so that statements
1543 # have direct access to global variables that the
1544 # main 'exp' file has set up. But it's not yet clear,
1545 # will need more experience to be sure.
1546 eval $statements
1547 }
1548}
9d81d21b
VP
1549
1550proc get_mi_thread_list {name} {
1551 global expect_out
1552
1553 # MI will return a list of thread ids:
1554 #
1555 # -thread-list-ids
1556 # ^done,thread-ids=[thread-id="1",thread-id="2",...],number-of-threads="N"
1557 # (gdb)
1558 mi_gdb_test "-thread-list-ids" \
1559 {.*\^done,thread-ids={(thread-id="[0-9]+"(,)?)+},number-of-threads="[0-9]+"} \
1560 "-thread_list_ids ($name)"
1561
1562 set output {}
1563 if {[info exists expect_out(buffer)]} {
1564 set output $expect_out(buffer)
1565 }
1566
1567 set thread_list {}
1568 if {![regexp {thread-ids=\{(thread-id="[0-9]+"(,)?)*\}} $output threads]} {
1569 fail "finding threads in MI output ($name)"
1570 } else {
1571 pass "finding threads in MI output ($name)"
1572
1573 # Make list of console threads
1574 set start [expr {[string first \{ $threads] + 1}]
1575 set end [expr {[string first \} $threads] - 1}]
1576 set threads [string range $threads $start $end]
1577 foreach thread [split $threads ,] {
1578 if {[scan $thread {thread-id="%d"} num]} {
1579 lappend thread_list $num
1580 }
1581 }
1582 }
1583
1584 return $thread_list
1585}
1586
1587# Check that MI and the console know of the same threads.
1588# Appends NAME to all test names.
1589proc check_mi_and_console_threads {name} {
1590 global expect_out
1591
1592 mi_gdb_test "-thread-list-ids" \
1593 {.*\^done,thread-ids={(thread-id="[0-9]+"(,)*)+},number-of-threads="[0-9]+"} \
1594 "-thread-list-ids ($name)"
1595 set mi_output {}
1596 if {[info exists expect_out(buffer)]} {
1597 set mi_output $expect_out(buffer)
1598 }
1599
1600 # GDB will return a list of thread ids and some more info:
1601 #
1602 # (gdb)
1603 # -interpreter-exec console "info threads"
1604 # ~" 4 Thread 2051 (LWP 7734) 0x401166b1 in __libc_nanosleep () at __libc_nanosleep:-1"
1605 # ~" 3 Thread 1026 (LWP 7733) () at __libc_nanosleep:-1"
1606 # ~" 2 Thread 2049 (LWP 7732) 0x401411f8 in __poll (fds=0x804bb24, nfds=1, timeout=2000) at ../sysdeps/unix/sysv/linux/poll.c:63"
1607 # ~"* 1 Thread 1024 (LWP 7731) main (argc=1, argv=0xbfffdd94) at ../../../src/gdb/testsuite/gdb.mi/pthreads.c:160"
1608 # FIXME: kseitz/2002-09-05: Don't use the hack-cli method.
1609 mi_gdb_test "info threads" \
1610 {.*(~".*"[\r\n]*)+.*} \
1611 "info threads ($name)"
1612 set console_output {}
1613 if {[info exists expect_out(buffer)]} {
1614 set console_output $expect_out(buffer)
1615 }
1616
1617 # Make a list of all known threads to console (gdb's thread IDs)
1618 set console_thread_list {}
1619 foreach line [split $console_output \n] {
1620 if {[string index $line 0] == "~"} {
1621 # This is a line from the console; trim off "~", " ", "*", and "\""
1622 set line [string trim $line ~\ \"\*]
1623 if {[scan $line "%d" id] == 1} {
1624 lappend console_thread_list $id
1625 }
1626 }
1627 }
1628
1629 # Now find the result string from MI
1630 set mi_result ""
1631 foreach line [split $mi_output \n] {
1632 if {[string range $line 0 4] == "^done"} {
1633 set mi_result $line
1634 }
1635 }
1636 if {$mi_result == ""} {
1637 fail "finding MI result string ($name)"
1638 } else {
1639 pass "finding MI result string ($name)"
1640 }
1641
1642 # Finally, extract the thread ids and compare them to the console
1643 set num_mi_threads_str ""
1644 if {![regexp {number-of-threads="[0-9]+"} $mi_result num_mi_threads_str]} {
1645 fail "finding number of threads in MI output ($name)"
1646 } else {
1647 pass "finding number of threads in MI output ($name)"
1648
1649 # Extract the number of threads from the MI result
1650 if {![scan $num_mi_threads_str {number-of-threads="%d"} num_mi_threads]} {
1651 fail "got number of threads from MI ($name)"
1652 } else {
1653 pass "got number of threads from MI ($name)"
1654
1655 # Check if MI and console have same number of threads
1656 if {$num_mi_threads != [llength $console_thread_list]} {
1657 fail "console and MI have same number of threads ($name)"
1658 } else {
1659 pass "console and MI have same number of threads ($name)"
1660
1661 # Get MI thread list
1662 set mi_thread_list [get_mi_thread_list $name]
1663
1664 # Check if MI and console have the same threads
1665 set fails 0
1666 foreach ct [lsort $console_thread_list] mt [lsort $mi_thread_list] {
1667 if {$ct != $mt} {
1668 incr fails
1669 }
1670 }
1671 if {$fails > 0} {
1672 fail "MI and console have same threads ($name)"
1673
1674 # Send a list of failures to the log
1675 send_log "Console has thread ids: $console_thread_list\n"
1676 send_log "MI has thread ids: $mi_thread_list\n"
1677 } else {
1678 pass "MI and console have same threads ($name)"
1679 }
1680 }
1681 }
1682 }
1683}
5e06a3d1
VP
1684
1685proc mi_load_shlibs { args } {
1686 if {![is_remote target]} {
1687 return
1688 }
1689
1690 foreach file $args {
1691 gdb_download $file
1692 }
1693
1694 # Even if the target supplies full paths for shared libraries,
1695 # they may not be paths for this system.
1696 mi_gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "\^done" ""
1697}
1698
This page took 0.85534 seconds and 4 git commands to generate.