Add Guile as an extension language.
[deliverable/binutils-gdb.git] / gdb / testsuite / lib / gdb.exp
CommitLineData
ecd75fc8 1# Copyright 1992-2014 Free Software Foundation, Inc.
c906108c
SS
2
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
e22f8b7c 5# the Free Software Foundation; either version 3 of the License, or
c906108c 6# (at your option) any later version.
e22f8b7c 7#
c906108c
SS
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.
e22f8b7c 12#
c906108c 13# You should have received a copy of the GNU General Public License
e22f8b7c 14# along with this program. If not, see <http://www.gnu.org/licenses/>.
c906108c 15
c906108c
SS
16# This file was written by Fred Fish. (fnf@cygnus.com)
17
18# Generic gdb subroutines that should work for any target. If these
19# need to be modified for any target, it can be done with a variable
20# or by passing arguments.
21
97c3f1f3
JK
22if {$tool == ""} {
23 # Tests would fail, logs on get_compiler_info() would be missing.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
25 exit 2
26}
27
c906108c 28load_lib libgloss.exp
17e1c970 29load_lib cache.exp
c906108c
SS
30
31global GDB
c906108c
SS
32
33if [info exists TOOL_EXECUTABLE] {
4ec70201 34 set GDB $TOOL_EXECUTABLE
c906108c
SS
35}
36if ![info exists GDB] {
37 if ![is_remote host] {
38 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
39 } else {
4ec70201 40 set GDB [transform gdb]
c906108c
SS
41 }
42}
43verbose "using GDB = $GDB" 2
44
6b8ce727
DE
45# GDBFLAGS is available for the user to set on the command line.
46# E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
47# Testcases may use it to add additional flags, but they must:
48# - append new flags, not overwrite
49# - restore the original value when done
c906108c
SS
50global GDBFLAGS
51if ![info exists GDBFLAGS] {
6b8ce727 52 set GDBFLAGS ""
c906108c
SS
53}
54verbose "using GDBFLAGS = $GDBFLAGS" 2
55
2f4e0a80
DE
56# Make the build data directory available to tests.
57set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
58
6b8ce727 59# INTERNAL_GDBFLAGS contains flags that the testsuite requires.
1be00882
DE
60global INTERNAL_GDBFLAGS
61if ![info exists INTERNAL_GDBFLAGS] {
2f4e0a80 62 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
1be00882 63}
6b8ce727 64
9e0b60a8
JM
65# The variable gdb_prompt is a regexp which matches the gdb prompt.
66# Set it if it is not already set.
c906108c 67global gdb_prompt
9e0b60a8 68if ![info exists gdb_prompt] then {
c906108c
SS
69 set gdb_prompt "\[(\]gdb\[)\]"
70}
71
6006a3a1
BR
72# The variable fullname_syntax_POSIX is a regexp which matches a POSIX
73# absolute path ie. /foo/
d0b76dc6 74set fullname_syntax_POSIX {/[^\n]*/}
6006a3a1
BR
75# The variable fullname_syntax_UNC is a regexp which matches a Windows
76# UNC path ie. \\D\foo\
d0b76dc6 77set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
6006a3a1
BR
78# The variable fullname_syntax_DOS_CASE is a regexp which matches a
79# particular DOS case that GDB most likely will output
80# ie. \foo\, but don't match \\.*\
d0b76dc6 81set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
6006a3a1
BR
82# The variable fullname_syntax_DOS is a regexp which matches a DOS path
83# ie. a:\foo\ && a:foo\
d0b76dc6 84set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
6006a3a1
BR
85# The variable fullname_syntax is a regexp which matches what GDB considers
86# an absolute path. It is currently debatable if the Windows style paths
87# d:foo and \abc should be considered valid as an absolute path.
88# Also, the purpse of this regexp is not to recognize a well formed
89# absolute path, but to say with certainty that a path is absolute.
90set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
91
93076499
ND
92# Needed for some tests under Cygwin.
93global EXEEXT
94global env
95
96if ![info exists env(EXEEXT)] {
97 set EXEEXT ""
98} else {
99 set EXEEXT $env(EXEEXT)
100}
101
bb2bed55
NR
102set octal "\[0-7\]+"
103
eceb0c5f 104set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)"
fda326dd 105
085dd6e6
JM
106### Only procedures should come after this point.
107
c906108c
SS
108#
109# gdb_version -- extract and print the version number of GDB
110#
111proc default_gdb_version {} {
112 global GDB
6b8ce727 113 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c 114 global gdb_prompt
5e92f71a
TT
115 global inotify_pid
116
117 if {[info exists inotify_pid]} {
118 eval exec kill $inotify_pid
119 }
120
fa335448 121 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
4ec70201 122 set tmp [lindex $output 1]
c906108c
SS
123 set version ""
124 regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
125 if ![is_remote host] {
6b8ce727 126 clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
c906108c 127 } else {
6b8ce727 128 clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
c906108c
SS
129 }
130}
131
132proc gdb_version { } {
ae59b1da 133 return [default_gdb_version]
c906108c
SS
134}
135
136#
137# gdb_unload -- unload a file if one is loaded
608e2dbb 138# Return 0 on success, -1 on error.
c906108c
SS
139#
140
141proc gdb_unload {} {
142 global verbose
143 global GDB
144 global gdb_prompt
145 send_gdb "file\n"
146 gdb_expect 60 {
147 -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
148 -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
959e7469
PM
149 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
150 send_gdb "y\n"
c906108c
SS
151 exp_continue
152 }
153 -re "Discard symbol table from .*y or n.*$" {
154 send_gdb "y\n"
155 exp_continue
156 }
157 -re "$gdb_prompt $" {}
158 timeout {
975531db 159 perror "couldn't unload file in $GDB (timeout)."
c906108c
SS
160 return -1
161 }
162 }
608e2dbb 163 return 0
c906108c
SS
164}
165
166# Many of the tests depend on setting breakpoints at various places and
167# running until that breakpoint is reached. At times, we want to start
168# with a clean-slate with respect to breakpoints, so this utility proc
169# lets us do this without duplicating this code everywhere.
170#
171
172proc delete_breakpoints {} {
173 global gdb_prompt
174
a0b3c4fd
JM
175 # we need a larger timeout value here or this thing just confuses
176 # itself. May need a better implementation if possible. - guo
177 #
c906108c 178 send_gdb "delete breakpoints\n"
a0b3c4fd 179 gdb_expect 100 {
c906108c 180 -re "Delete all breakpoints.*y or n.*$" {
4ec70201 181 send_gdb "y\n"
c906108c
SS
182 exp_continue
183 }
184 -re "$gdb_prompt $" { # This happens if there were no breakpoints
185 }
186 timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
187 }
188 send_gdb "info breakpoints\n"
a0b3c4fd 189 gdb_expect 100 {
c906108c
SS
190 -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
191 -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
192 -re "Delete all breakpoints.*or n.*$" {
4ec70201 193 send_gdb "y\n"
c906108c
SS
194 exp_continue
195 }
196 timeout { perror "info breakpoints (timeout)" ; return }
197 }
198}
199
c906108c
SS
200# Generic run command.
201#
202# The second pattern below matches up to the first newline *only*.
203# Using ``.*$'' could swallow up output that we attempt to match
204# elsewhere.
205#
1d41d75c
DE
206# N.B. This function does not wait for gdb to return to the prompt,
207# that is the caller's responsibility.
208
c906108c 209proc gdb_run_cmd {args} {
e11ac3a3 210 global gdb_prompt use_gdb_stub
c906108c
SS
211
212 if [target_info exists gdb_init_command] {
4ec70201 213 send_gdb "[target_info gdb_init_command]\n"
c906108c
SS
214 gdb_expect 30 {
215 -re "$gdb_prompt $" { }
216 default {
4ec70201
PA
217 perror "gdb_init_command for target failed"
218 return
c906108c
SS
219 }
220 }
221 }
222
e11ac3a3 223 if $use_gdb_stub {
c906108c 224 if [target_info exists gdb,do_reload_on_run] {
b741e217 225 if { [gdb_reload] != 0 } {
4ec70201 226 return
917317f4 227 }
4ec70201 228 send_gdb "continue\n"
c906108c
SS
229 gdb_expect 60 {
230 -re "Continu\[^\r\n\]*\[\r\n\]" {}
231 default {}
232 }
4ec70201 233 return
c906108c
SS
234 }
235
236 if [target_info exists gdb,start_symbol] {
4ec70201 237 set start [target_info gdb,start_symbol]
c906108c 238 } else {
4ec70201 239 set start "start"
c906108c
SS
240 }
241 send_gdb "jump *$start\n"
4ec70201 242 set start_attempt 1
917317f4
JM
243 while { $start_attempt } {
244 # Cap (re)start attempts at three to ensure that this loop
245 # always eventually fails. Don't worry about trying to be
246 # clever and not send a command when it has failed.
247 if [expr $start_attempt > 3] {
4ec70201
PA
248 perror "Jump to start() failed (retry count exceeded)"
249 return
c906108c 250 }
4ec70201 251 set start_attempt [expr $start_attempt + 1]
917317f4
JM
252 gdb_expect 30 {
253 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
4ec70201 254 set start_attempt 0
917317f4
JM
255 }
256 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
4ec70201
PA
257 perror "Can't find start symbol to run in gdb_run"
258 return
917317f4
JM
259 }
260 -re "No symbol \"start\" in current.*$gdb_prompt $" {
4ec70201 261 send_gdb "jump *_start\n"
917317f4
JM
262 }
263 -re "No symbol.*context.*$gdb_prompt $" {
4ec70201 264 set start_attempt 0
917317f4
JM
265 }
266 -re "Line.* Jump anyway.*y or n. $" {
267 send_gdb "y\n"
268 }
269 -re "The program is not being run.*$gdb_prompt $" {
b741e217 270 if { [gdb_reload] != 0 } {
4ec70201 271 return
917317f4 272 }
4ec70201 273 send_gdb "jump *$start\n"
917317f4
JM
274 }
275 timeout {
4ec70201 276 perror "Jump to start() failed (timeout)"
917317f4
JM
277 return
278 }
c906108c 279 }
c906108c 280 }
c906108c
SS
281 return
282 }
83f66e8f
DJ
283
284 if [target_info exists gdb,do_reload_on_run] {
b741e217 285 if { [gdb_reload] != 0 } {
4ec70201 286 return
83f66e8f
DJ
287 }
288 }
c906108c
SS
289 send_gdb "run $args\n"
290# This doesn't work quite right yet.
5aa7ddc2
PM
291# Use -notransfer here so that test cases (like chng-sym.exp)
292# may test for additional start-up messages.
293 gdb_expect 60 {
c906108c
SS
294 -re "The program .* has been started already.*y or n. $" {
295 send_gdb "y\n"
296 exp_continue
297 }
bbb88ebf 298 -notransfer -re "Starting program: \[^\r\n\]*" {}
8e46892c
JK
299 -notransfer -re "$gdb_prompt $" {
300 # There is no more input expected.
301 }
c906108c
SS
302 }
303}
304
b741e217
DJ
305# Generic start command. Return 0 if we could start the program, -1
306# if we could not.
1d41d75c
DE
307#
308# N.B. This function does not wait for gdb to return to the prompt,
309# that is the caller's responsibility.
b741e217
DJ
310
311proc gdb_start_cmd {args} {
e11ac3a3 312 global gdb_prompt use_gdb_stub
b741e217
DJ
313
314 if [target_info exists gdb_init_command] {
4ec70201 315 send_gdb "[target_info gdb_init_command]\n"
b741e217
DJ
316 gdb_expect 30 {
317 -re "$gdb_prompt $" { }
318 default {
4ec70201 319 perror "gdb_init_command for target failed"
ae59b1da 320 return -1
b741e217
DJ
321 }
322 }
323 }
324
e11ac3a3 325 if $use_gdb_stub {
b741e217
DJ
326 return -1
327 }
328
329 send_gdb "start $args\n"
2de75e71
JB
330 # Use -notransfer here so that test cases (like chng-sym.exp)
331 # may test for additional start-up messages.
b741e217
DJ
332 gdb_expect 60 {
333 -re "The program .* has been started already.*y or n. $" {
334 send_gdb "y\n"
335 exp_continue
336 }
b741e217
DJ
337 -notransfer -re "Starting program: \[^\r\n\]*" {
338 return 0
339 }
340 }
341 return -1
342}
343
78a1a894 344# Set a breakpoint at FUNCTION. If there is an additional argument it is
55cd6f92 345# a list of options; the supported options are allow-pending, temporary,
5b7d0050
DE
346# message, no-message, and passfail.
347# The result is 1 for success, 0 for failure.
348#
349# Note: The handling of message vs no-message is messed up, but it's based
350# on historical usage. By default this function does not print passes,
351# only fails.
352# no-message: turns off printing of fails (and passes, but they're already off)
353# message: turns on printing of passes (and fails, but they're already on)
78a1a894
DJ
354
355proc gdb_breakpoint { function args } {
c906108c
SS
356 global gdb_prompt
357 global decimal
358
78a1a894 359 set pending_response n
5b7d0050 360 if {[lsearch -exact $args allow-pending] != -1} {
78a1a894
DJ
361 set pending_response y
362 }
363
e48883f7 364 set break_command "break"
18ac113b 365 set break_message "Breakpoint"
5b7d0050 366 if {[lsearch -exact $args temporary] != -1} {
e48883f7 367 set break_command "tbreak"
18ac113b 368 set break_message "Temporary breakpoint"
e48883f7
DJ
369 }
370
5b7d0050
DE
371 set print_pass 0
372 set print_fail 1
373 set no_message_loc [lsearch -exact $args no-message]
374 set message_loc [lsearch -exact $args message]
375 # The last one to appear in args wins.
376 if { $no_message_loc > $message_loc } {
377 set print_fail 0
378 } elseif { $message_loc > $no_message_loc } {
379 set print_pass 1
55cd6f92
DJ
380 }
381
5b7d0050
DE
382 set test_name "setting breakpoint at $function"
383
e48883f7 384 send_gdb "$break_command $function\n"
c906108c
SS
385 # The first two regexps are what we get with -g, the third is without -g.
386 gdb_expect 30 {
18ac113b
AR
387 -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
388 -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
389 -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
390 -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
78a1a894 391 if {$pending_response == "n"} {
5b7d0050
DE
392 if { $print_fail } {
393 fail $test_name
55cd6f92 394 }
78a1a894
DJ
395 return 0
396 }
397 }
9f27c604 398 -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
78a1a894 399 send_gdb "$pending_response\n"
14b1a056 400 exp_continue
18fe2033 401 }
28781456 402 -re "A problem internal to GDB has been detected" {
5b7d0050
DE
403 if { $print_fail } {
404 fail "$test_name (GDB internal error)"
405 }
28781456
JK
406 gdb_internal_error_resync
407 return 0
408 }
55cd6f92 409 -re "$gdb_prompt $" {
5b7d0050
DE
410 if { $print_fail } {
411 fail $test_name
412 }
413 return 0
414 }
415 eof {
416 if { $print_fail } {
417 fail "$test_name (eof)"
55cd6f92
DJ
418 }
419 return 0
420 }
421 timeout {
5b7d0050
DE
422 if { $print_fail } {
423 fail "$test_name (timeout)"
55cd6f92
DJ
424 }
425 return 0
426 }
c906108c 427 }
5b7d0050
DE
428 if { $print_pass } {
429 pass $test_name
430 }
ae59b1da 431 return 1
c906108c
SS
432}
433
434# Set breakpoint at function and run gdb until it breaks there.
435# Since this is the only breakpoint that will be set, if it stops
436# at a breakpoint, we will assume it is the one we want. We can't
437# just compare to "function" because it might be a fully qualified,
5b7d0050
DE
438# single quoted C++ function specifier.
439#
440# If there are additional arguments, pass them to gdb_breakpoint.
441# We recognize no-message/message ourselves.
442# The default is no-message.
443# no-message is messed up here, like gdb_breakpoint: to preserve
444# historical usage fails are always printed by default.
445# no-message: turns off printing of fails (and passes, but they're already off)
446# message: turns on printing of passes (and fails, but they're already on)
c906108c 447
78a1a894 448proc runto { function args } {
c906108c
SS
449 global gdb_prompt
450 global decimal
451
452 delete_breakpoints
453
5b7d0050
DE
454 # Default to "no-message".
455 set args "no-message $args"
456
457 set print_pass 0
458 set print_fail 1
459 set no_message_loc [lsearch -exact $args no-message]
460 set message_loc [lsearch -exact $args message]
461 # The last one to appear in args wins.
462 if { $no_message_loc > $message_loc } {
463 set print_fail 0
464 } elseif { $message_loc > $no_message_loc } {
465 set print_pass 1
466 }
467
468 set test_name "running to $function in runto"
469
470 # We need to use eval here to pass our varargs args to gdb_breakpoint
471 # which is also a varargs function.
2c47921e
DE
472 # But we also have to be careful because $function may have multiple
473 # elements, and we don't want Tcl to move the remaining elements after
474 # the first to $args. That is why $function is wrapped in {}.
475 if ![eval gdb_breakpoint {$function} $args] {
ae59b1da 476 return 0
c906108c
SS
477 }
478
479 gdb_run_cmd
480
481 # the "at foo.c:36" output we get with -g.
482 # the "in func" output we get without -g.
483 gdb_expect 30 {
484 -re "Break.* at .*:$decimal.*$gdb_prompt $" {
5b7d0050
DE
485 if { $print_pass } {
486 pass $test_name
487 }
c906108c
SS
488 return 1
489 }
490 -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
5b7d0050
DE
491 if { $print_pass } {
492 pass $test_name
493 }
c906108c
SS
494 return 1
495 }
8e46892c 496 -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
5b7d0050
DE
497 if { $print_fail } {
498 unsupported "Non-stop mode not supported"
499 }
8e46892c
JK
500 return 0
501 }
569b05a5 502 -re ".*A problem internal to GDB has been detected" {
5b7d0050
DE
503 if { $print_fail } {
504 fail "$test_name (GDB internal error)"
505 }
569b05a5
JK
506 gdb_internal_error_resync
507 return 0
508 }
c906108c 509 -re "$gdb_prompt $" {
5b7d0050
DE
510 if { $print_fail } {
511 fail $test_name
512 }
c906108c
SS
513 return 0
514 }
72c63395 515 eof {
5b7d0050
DE
516 if { $print_fail } {
517 fail "$test_name (eof)"
518 }
72c63395
JK
519 return 0
520 }
c906108c 521 timeout {
5b7d0050
DE
522 if { $print_fail } {
523 fail "$test_name (timeout)"
524 }
c906108c
SS
525 return 0
526 }
527 }
5b7d0050
DE
528 if { $print_pass } {
529 pass $test_name
530 }
c906108c
SS
531 return 1
532}
533
1d41d75c 534# Ask gdb to run until we hit a breakpoint at main.
c906108c 535#
1d41d75c
DE
536# N.B. This function deletes all existing breakpoints.
537# If you don't want that, use gdb_start_cmd.
538
c906108c 539proc runto_main { } {
5b7d0050 540 return [runto main no-message]
c906108c
SS
541}
542
4ce44c66
JM
543### Continue, and expect to hit a breakpoint.
544### Report a pass or fail, depending on whether it seems to have
545### worked. Use NAME as part of the test name; each call to
546### continue_to_breakpoint should use a NAME which is unique within
547### that test file.
74960c60 548proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
4ce44c66
JM
549 global gdb_prompt
550 set full_name "continue to breakpoint: $name"
551
552 send_gdb "continue\n"
553 gdb_expect {
a1624241 554 -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" {
4ce44c66
JM
555 pass $full_name
556 }
557 -re ".*$gdb_prompt $" {
558 fail $full_name
559 }
560 timeout {
561 fail "$full_name (timeout)"
562 }
563 }
564}
565
566
039cf96d
AC
567# gdb_internal_error_resync:
568#
569# Answer the questions GDB asks after it reports an internal error
570# until we get back to a GDB prompt. Decline to quit the debugging
571# session, and decline to create a core file. Return non-zero if the
572# resync succeeds.
573#
574# This procedure just answers whatever questions come up until it sees
575# a GDB prompt; it doesn't require you to have matched the input up to
576# any specific point. However, it only answers questions it sees in
577# the output itself, so if you've matched a question, you had better
578# answer it yourself before calling this.
579#
580# You can use this function thus:
581#
582# gdb_expect {
583# ...
584# -re ".*A problem internal to GDB has been detected" {
585# gdb_internal_error_resync
586# }
587# ...
588# }
589#
590proc gdb_internal_error_resync {} {
591 global gdb_prompt
592
5b7d0050
DE
593 verbose -log "Resyncing due to internal error."
594
039cf96d
AC
595 set count 0
596 while {$count < 10} {
597 gdb_expect {
598 -re "Quit this debugging session\\? \\(y or n\\) $" {
599 send_gdb "n\n"
600 incr count
601 }
602 -re "Create a core file of GDB\\? \\(y or n\\) $" {
603 send_gdb "n\n"
604 incr count
605 }
606 -re "$gdb_prompt $" {
607 # We're resynchronized.
608 return 1
609 }
610 timeout {
611 perror "Could not resync from internal error (timeout)"
612 return 0
613 }
614 }
615 }
2b211c59
AC
616 perror "Could not resync from internal error (resync count exceeded)"
617 return 0
039cf96d
AC
618}
619
4ce44c66 620
2307bd6a 621# gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
8dbfb380 622# Send a command to gdb; test the result.
c906108c
SS
623#
624# COMMAND is the command to execute, send to GDB with send_gdb. If
625# this is the null string no command is sent.
2307bd6a
DJ
626# MESSAGE is a message to be printed with the built-in failure patterns
627# if one of them matches. If MESSAGE is empty COMMAND will be used.
628# EXPECT_ARGUMENTS will be fed to expect in addition to the standard
629# patterns. Pattern elements will be evaluated in the caller's
630# context; action elements will be executed in the caller's context.
631# Unlike patterns for gdb_test, these patterns should generally include
632# the final newline and prompt.
c906108c
SS
633#
634# Returns:
2307bd6a
DJ
635# 1 if the test failed, according to a built-in failure pattern
636# 0 if only user-supplied patterns matched
c906108c
SS
637# -1 if there was an internal error.
638#
d422fe19
AC
639# You can use this function thus:
640#
641# gdb_test_multiple "print foo" "test foo" {
642# -re "expected output 1" {
643# pass "print foo"
644# }
645# -re "expected output 2" {
646# fail "print foo"
647# }
648# }
649#
fda326dd 650# The standard patterns, such as "Inferior exited..." and "A problem
d422fe19
AC
651# ...", all being implicitly appended to that list.
652#
2307bd6a 653proc gdb_test_multiple { command message user_code } {
e11ac3a3 654 global verbose use_gdb_stub
c906108c
SS
655 global gdb_prompt
656 global GDB
fda326dd 657 global inferior_exited_re
c906108c 658 upvar timeout timeout
c47cebdb 659 upvar expect_out expect_out
c906108c 660
2307bd6a
DJ
661 if { $message == "" } {
662 set message $command
c906108c 663 }
c906108c 664
824cc8dd
JK
665 if [string match "*\[\r\n\]" $command] {
666 error "Invalid trailing newline in \"$message\" test"
667 }
668
8344e389
JK
669 if [string match "*\[\r\n\]*" $message] {
670 error "Invalid newline in \"$message\" test"
671 }
672
e11ac3a3 673 if {$use_gdb_stub
9bfee719 674 && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \
e11ac3a3
JK
675 $command]} {
676 error "gdbserver does not support $command without extended-remote"
677 }
678
2307bd6a
DJ
679 # TCL/EXPECT WART ALERT
680 # Expect does something very strange when it receives a single braced
681 # argument. It splits it along word separators and performs substitutions.
682 # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
683 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
684 # double-quoted list item, "\[ab\]" is just a long way of representing
685 # "[ab]", because the backslashes will be removed by lindex.
686
687 # Unfortunately, there appears to be no easy way to duplicate the splitting
688 # that expect will do from within TCL. And many places make use of the
689 # "\[0-9\]" construct, so we need to support that; and some places make use
690 # of the "[func]" construct, so we need to support that too. In order to
691 # get this right we have to substitute quoted list elements differently
692 # from braced list elements.
693
694 # We do this roughly the same way that Expect does it. We have to use two
695 # lists, because if we leave unquoted newlines in the argument to uplevel
696 # they'll be treated as command separators, and if we escape newlines
697 # we mangle newlines inside of command blocks. This assumes that the
698 # input doesn't contain a pattern which contains actual embedded newlines
699 # at this point!
700
701 regsub -all {\n} ${user_code} { } subst_code
702 set subst_code [uplevel list $subst_code]
703
704 set processed_code ""
705 set patterns ""
706 set expecting_action 0
21e24d21 707 set expecting_arg 0
2307bd6a
DJ
708 foreach item $user_code subst_item $subst_code {
709 if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
710 lappend processed_code $item
711 continue
712 }
21e24d21
PA
713 if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
714 lappend processed_code $item
715 continue
716 }
717 if { $item == "-timeout" } {
718 set expecting_arg 1
719 lappend processed_code $item
720 continue
721 }
722 if { $expecting_arg } {
723 set expecting_arg 0
2307bd6a
DJ
724 lappend processed_code $item
725 continue
726 }
727 if { $expecting_action } {
728 lappend processed_code "uplevel [list $item]"
729 set expecting_action 0
730 # Cosmetic, no effect on the list.
731 append processed_code "\n"
732 continue
733 }
734 set expecting_action 1
735 lappend processed_code $subst_item
736 if {$patterns != ""} {
737 append patterns "; "
738 }
739 append patterns "\"$subst_item\""
c906108c
SS
740 }
741
2307bd6a
DJ
742 # Also purely cosmetic.
743 regsub -all {\r} $patterns {\\r} patterns
744 regsub -all {\n} $patterns {\\n} patterns
745
c906108c
SS
746 if $verbose>2 then {
747 send_user "Sending \"$command\" to gdb\n"
2307bd6a 748 send_user "Looking to match \"$patterns\"\n"
c906108c
SS
749 send_user "Message is \"$message\"\n"
750 }
751
752 set result -1
4ec70201 753 set string "${command}\n"
c906108c 754 if { $command != "" } {
543a9323 755 set multi_line_re "\[\r\n\] *>"
c906108c 756 while { "$string" != "" } {
4ec70201
PA
757 set foo [string first "\n" "$string"]
758 set len [string length "$string"]
c906108c 759 if { $foo < [expr $len - 1] } {
4ec70201 760 set str [string range "$string" 0 $foo]
c906108c 761 if { [send_gdb "$str"] != "" } {
4ec70201 762 global suppress_flag
c906108c
SS
763
764 if { ! $suppress_flag } {
4ec70201 765 perror "Couldn't send $command to GDB."
c906108c 766 }
4ec70201 767 fail "$message"
ae59b1da 768 return $result
c906108c 769 }
a0b3c4fd
JM
770 # since we're checking if each line of the multi-line
771 # command are 'accepted' by GDB here,
772 # we need to set -notransfer expect option so that
773 # command output is not lost for pattern matching
774 # - guo
5f279fa6 775 gdb_expect 2 {
543a9323 776 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
5f279fa6 777 timeout { verbose "partial: timeout" 3 }
c906108c 778 }
4ec70201 779 set string [string range "$string" [expr $foo + 1] end]
543a9323 780 set multi_line_re "$multi_line_re.*\[\r\n\] *>"
c906108c 781 } else {
4ec70201 782 break
c906108c
SS
783 }
784 }
785 if { "$string" != "" } {
786 if { [send_gdb "$string"] != "" } {
4ec70201 787 global suppress_flag
c906108c
SS
788
789 if { ! $suppress_flag } {
4ec70201 790 perror "Couldn't send $command to GDB."
c906108c 791 }
4ec70201 792 fail "$message"
ae59b1da 793 return $result
c906108c
SS
794 }
795 }
796 }
797
9d2e1bab 798 if [target_info exists gdb,timeout] {
4ec70201 799 set tmt [target_info gdb,timeout]
c906108c 800 } else {
c906108c 801 if [info exists timeout] {
4ec70201 802 set tmt $timeout
c906108c 803 } else {
4ec70201 804 global timeout
9d2e1bab 805 if [info exists timeout] {
4ec70201 806 set tmt $timeout
9d2e1bab 807 } else {
4ec70201 808 set tmt 60
9d2e1bab 809 }
c906108c
SS
810 }
811 }
2307bd6a
DJ
812
813 set code {
9bfee719
MR
814 -re ".*A problem internal to GDB has been detected" {
815 fail "$message (GDB internal error)"
816 gdb_internal_error_resync
817 }
818 -re "\\*\\*\\* DOSEXIT code.*" {
819 if { $message != "" } {
4ec70201 820 fail "$message"
9bfee719 821 }
4ec70201
PA
822 gdb_suppress_entire_file "GDB died"
823 set result -1
9bfee719 824 }
b0f4b84b
DJ
825 }
826 append code $processed_code
827 append code {
9bfee719 828 -re "Ending remote debugging.*$gdb_prompt $" {
c906108c
SS
829 if ![isnative] then {
830 warning "Can`t communicate to remote target."
831 }
832 gdb_exit
833 gdb_start
834 set result -1
835 }
9bfee719 836 -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
c906108c 837 perror "Undefined command \"$command\"."
9bfee719 838 fail "$message"
c906108c
SS
839 set result 1
840 }
9bfee719 841 -re "Ambiguous command.*$gdb_prompt $" {
c906108c 842 perror "\"$command\" is not a unique command name."
9bfee719 843 fail "$message"
c906108c
SS
844 set result 1
845 }
9bfee719 846 -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" {
c906108c 847 if ![string match "" $message] then {
ed4c619a 848 set errmsg "$message (the program exited)"
c906108c 849 } else {
ed4c619a 850 set errmsg "$command (the program exited)"
c906108c
SS
851 }
852 fail "$errmsg"
2307bd6a 853 set result -1
cb9a9d3e 854 }
9bfee719 855 -re "$inferior_exited_re normally.*$gdb_prompt $" {
cb9a9d3e 856 if ![string match "" $message] then {
ed4c619a 857 set errmsg "$message (the program exited)"
cb9a9d3e 858 } else {
ed4c619a 859 set errmsg "$command (the program exited)"
cb9a9d3e
MS
860 }
861 fail "$errmsg"
2307bd6a 862 set result -1
c906108c 863 }
9bfee719 864 -re "The program is not being run.*$gdb_prompt $" {
c906108c 865 if ![string match "" $message] then {
ed4c619a 866 set errmsg "$message (the program is no longer running)"
c906108c 867 } else {
ed4c619a 868 set errmsg "$command (the program is no longer running)"
c906108c
SS
869 }
870 fail "$errmsg"
2307bd6a 871 set result -1
c906108c 872 }
9bfee719 873 -re "\r\n$gdb_prompt $" {
c906108c
SS
874 if ![string match "" $message] then {
875 fail "$message"
876 }
877 set result 1
878 }
9bfee719 879 "<return>" {
c906108c
SS
880 send_gdb "\n"
881 perror "Window too small."
9bfee719 882 fail "$message"
2307bd6a 883 set result -1
c906108c 884 }
b598bfda 885 -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
c906108c 886 send_gdb "n\n"
b598bfda
DJ
887 gdb_expect -re "$gdb_prompt $"
888 fail "$message (got interactive prompt)"
889 set result -1
890 }
891 -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
892 send_gdb "0\n"
893 gdb_expect -re "$gdb_prompt $"
894 fail "$message (got breakpoint menu)"
2307bd6a 895 set result -1
c906108c 896 }
9bfee719
MR
897 eof {
898 perror "Process no longer exists"
899 if { $message != "" } {
900 fail "$message"
901 }
902 return -1
c906108c 903 }
9bfee719 904 full_buffer {
c906108c 905 perror "internal buffer is full."
9bfee719 906 fail "$message"
2307bd6a 907 set result -1
c906108c
SS
908 }
909 timeout {
910 if ![string match "" $message] then {
911 fail "$message (timeout)"
912 }
913 set result 1
914 }
915 }
2307bd6a
DJ
916
917 set result 0
04f6ecf2
DJ
918 set code [catch {gdb_expect $tmt $code} string]
919 if {$code == 1} {
4ec70201 920 global errorInfo errorCode
04f6ecf2 921 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
d6d7a51a 922 } elseif {$code > 1} {
04f6ecf2
DJ
923 return -code $code $string
924 }
c906108c
SS
925 return $result
926}
2307bd6a
DJ
927
928# gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
929# Send a command to gdb; test the result.
930#
931# COMMAND is the command to execute, send to GDB with send_gdb. If
932# this is the null string no command is sent.
933# PATTERN is the pattern to match for a PASS, and must NOT include
934# the \r\n sequence immediately before the gdb prompt.
935# MESSAGE is an optional message to be printed. If this is
936# omitted, then the pass/fail messages use the command string as the
937# message. (If this is the empty string, then sometimes we don't
938# call pass or fail at all; I don't understand this at all.)
939# QUESTION is a question GDB may ask in response to COMMAND, like
940# "are you sure?"
941# RESPONSE is the response to send if QUESTION appears.
942#
943# Returns:
944# 1 if the test failed,
945# 0 if the test passes,
946# -1 if there was an internal error.
947#
948proc gdb_test { args } {
949 global verbose
950 global gdb_prompt
951 global GDB
952 upvar timeout timeout
953
954 if [llength $args]>2 then {
955 set message [lindex $args 2]
956 } else {
957 set message [lindex $args 0]
958 }
959 set command [lindex $args 0]
960 set pattern [lindex $args 1]
961
962 if [llength $args]==5 {
4ec70201
PA
963 set question_string [lindex $args 3]
964 set response_string [lindex $args 4]
2307bd6a
DJ
965 } else {
966 set question_string "^FOOBAR$"
967 }
968
969 return [gdb_test_multiple $command $message {
970 -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
971 if ![string match "" $message] then {
972 pass "$message"
973 }
974 }
975 -re "(${question_string})$" {
4ec70201
PA
976 send_gdb "$response_string\n"
977 exp_continue
2307bd6a
DJ
978 }
979 }]
980}
a7b75dfd
JB
981
982# gdb_test_no_output COMMAND MESSAGE
983# Send a command to GDB and verify that this command generated no output.
984#
985# See gdb_test_multiple for a description of the COMMAND and MESSAGE
986# parameters. If MESSAGE is ommitted, then COMMAND will be used as
c22decce
JB
987# the message. (If MESSAGE is the empty string, then sometimes we do not
988# call pass or fail at all; I don't understand this at all.)
a7b75dfd
JB
989
990proc gdb_test_no_output { args } {
991 global gdb_prompt
992 set command [lindex $args 0]
993 if [llength $args]>1 then {
994 set message [lindex $args 1]
995 } else {
996 set message $command
997 }
998
999 set command_regex [string_to_regexp $command]
1000 gdb_test_multiple $command $message {
1001 -re "^$command_regex\r\n$gdb_prompt $" {
c22decce
JB
1002 if ![string match "" $message] then {
1003 pass "$message"
1004 }
a7b75dfd
JB
1005 }
1006 }
1007}
1008
6b0ecdc2
DE
1009# Send a command and then wait for a sequence of outputs.
1010# This is useful when the sequence is long and contains ".*", a single
1011# regexp to match the entire output can get a timeout much easier.
1012#
1013# COMMAND is the command to send.
1014# TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "".
1015# EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1016# processed in order, and all must be present in the output.
1017#
1018# It is unnecessary to specify ".*" at the beginning or end of any regexp,
1019# there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1020# There is also an implicit ".*" between the last regexp and the gdb prompt.
1021#
1022# Like gdb_test and gdb_test_multiple, the output is expected to end with the
1023# gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
5fa290c1
DE
1024#
1025# Returns:
1026# 1 if the test failed,
1027# 0 if the test passes,
1028# -1 if there was an internal error.
6b0ecdc2
DE
1029
1030proc gdb_test_sequence { command test_name expected_output_list } {
1031 global gdb_prompt
1032 if { $test_name == "" } {
1033 set test_name $command
1034 }
1035 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1036 send_gdb "$command\n"
5fa290c1 1037 return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list]
6b0ecdc2
DE
1038}
1039
c906108c
SS
1040\f
1041# Test that a command gives an error. For pass or fail, return
1042# a 1 to indicate that more tests can proceed. However a timeout
1043# is a serious error, generates a special fail message, and causes
1044# a 0 to be returned to indicate that more tests are likely to fail
1045# as well.
1046
1047proc test_print_reject { args } {
1048 global gdb_prompt
1049 global verbose
1050
1051 if [llength $args]==2 then {
1052 set expectthis [lindex $args 1]
1053 } else {
1054 set expectthis "should never match this bogus string"
1055 }
1056 set sendthis [lindex $args 0]
1057 if $verbose>2 then {
1058 send_user "Sending \"$sendthis\" to gdb\n"
1059 send_user "Looking to match \"$expectthis\"\n"
1060 }
1061 send_gdb "$sendthis\n"
1062 #FIXME: Should add timeout as parameter.
1063 gdb_expect {
1064 -re "A .* in expression.*\\.*$gdb_prompt $" {
1065 pass "reject $sendthis"
1066 return 1
1067 }
1068 -re "Invalid syntax in expression.*$gdb_prompt $" {
1069 pass "reject $sendthis"
1070 return 1
1071 }
1072 -re "Junk after end of expression.*$gdb_prompt $" {
1073 pass "reject $sendthis"
1074 return 1
1075 }
1076 -re "Invalid number.*$gdb_prompt $" {
1077 pass "reject $sendthis"
1078 return 1
1079 }
1080 -re "Invalid character constant.*$gdb_prompt $" {
1081 pass "reject $sendthis"
1082 return 1
1083 }
1084 -re "No symbol table is loaded.*$gdb_prompt $" {
1085 pass "reject $sendthis"
1086 return 1
1087 }
1088 -re "No symbol .* in current context.*$gdb_prompt $" {
1089 pass "reject $sendthis"
1090 return 1
1091 }
c4b7bc2b
JB
1092 -re "Unmatched single quote.*$gdb_prompt $" {
1093 pass "reject $sendthis"
1094 return 1
1095 }
1096 -re "A character constant must contain at least one character.*$gdb_prompt $" {
1097 pass "reject $sendthis"
1098 return 1
1099 }
c906108c
SS
1100 -re "$expectthis.*$gdb_prompt $" {
1101 pass "reject $sendthis"
1102 return 1
1103 }
1104 -re ".*$gdb_prompt $" {
1105 fail "reject $sendthis"
1106 return 1
1107 }
1108 default {
1109 fail "reject $sendthis (eof or timeout)"
1110 return 0
1111 }
1112 }
1113}
1114\f
1115# Given an input string, adds backslashes as needed to create a
1116# regexp that will match the string.
1117
1118proc string_to_regexp {str} {
1119 set result $str
39fb8e9e 1120 regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
c906108c
SS
1121 return $result
1122}
1123
1124# Same as gdb_test, but the second parameter is not a regexp,
1125# but a string that must match exactly.
1126
1127proc gdb_test_exact { args } {
1128 upvar timeout timeout
1129
1130 set command [lindex $args 0]
1131
1132 # This applies a special meaning to a null string pattern. Without
1133 # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1134 # messages from commands that should have no output except a new
1135 # prompt. With this, only results of a null string will match a null
1136 # string pattern.
1137
1138 set pattern [lindex $args 1]
1139 if [string match $pattern ""] {
1140 set pattern [string_to_regexp [lindex $args 0]]
1141 } else {
1142 set pattern [string_to_regexp [lindex $args 1]]
1143 }
1144
1145 # It is most natural to write the pattern argument with only
1146 # embedded \n's, especially if you are trying to avoid Tcl quoting
1147 # problems. But gdb_expect really wants to see \r\n in patterns. So
1148 # transform the pattern here. First transform \r\n back to \n, in
1149 # case some users of gdb_test_exact already do the right thing.
1150 regsub -all "\r\n" $pattern "\n" pattern
1151 regsub -all "\n" $pattern "\r\n" pattern
1152 if [llength $args]==3 then {
1153 set message [lindex $args 2]
1154 } else {
1155 set message $command
1156 }
1157
1158 return [gdb_test $command $pattern $message]
1159}
2dfb8c17
DE
1160
1161# Wrapper around gdb_test_multiple that looks for a list of expected
1162# output elements, but which can appear in any order.
1163# CMD is the gdb command.
1164# NAME is the name of the test.
1165# ELM_FIND_REGEXP specifies how to partition the output into elements to
1166# compare.
1167# ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1168# RESULT_MATCH_LIST is a list of exact matches for each expected element.
1169# All elements of RESULT_MATCH_LIST must appear for the test to pass.
1170#
1171# A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1172# of text per element and then strip trailing \r\n's.
1173# Example:
1174# gdb_test_list_exact "foo" "bar" \
eec52c44
PM
1175# "\[^\r\n\]+\[\r\n\]+" \
1176# "\[^\r\n\]+" \
2dfb8c17
DE
1177# { \
1178# {expected result 1} \
1179# {expected result 2} \
1180# }
1181
1182proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1183 global gdb_prompt
1184
1185 set matches [lsort $result_match_list]
1186 set seen {}
1187 gdb_test_multiple $cmd $name {
1188 "$cmd\[\r\n\]" { exp_continue }
1189 -re $elm_find_regexp {
1190 set str $expect_out(0,string)
1191 verbose -log "seen: $str" 3
1192 regexp -- $elm_extract_regexp $str elm_seen
1193 verbose -log "extracted: $elm_seen" 3
1194 lappend seen $elm_seen
1195 exp_continue
1196 }
1197 -re "$gdb_prompt $" {
1198 set failed ""
1199 foreach got [lsort $seen] have $matches {
1200 if {![string equal $got $have]} {
1201 set failed $have
1202 break
1203 }
1204 }
1205 if {[string length $failed] != 0} {
1206 fail "$name ($failed not found)"
1207 } else {
1208 pass $name
1209 }
1210 }
1211 }
1212}
c906108c
SS
1213\f
1214proc gdb_reinitialize_dir { subdir } {
1215 global gdb_prompt
1216
1217 if [is_remote host] {
ae59b1da 1218 return ""
c906108c
SS
1219 }
1220 send_gdb "dir\n"
1221 gdb_expect 60 {
1222 -re "Reinitialize source path to empty.*y or n. " {
1223 send_gdb "y\n"
1224 gdb_expect 60 {
1225 -re "Source directories searched.*$gdb_prompt $" {
1226 send_gdb "dir $subdir\n"
1227 gdb_expect 60 {
1228 -re "Source directories searched.*$gdb_prompt $" {
1229 verbose "Dir set to $subdir"
1230 }
1231 -re "$gdb_prompt $" {
1232 perror "Dir \"$subdir\" failed."
1233 }
1234 }
1235 }
1236 -re "$gdb_prompt $" {
1237 perror "Dir \"$subdir\" failed."
1238 }
1239 }
1240 }
1241 -re "$gdb_prompt $" {
1242 perror "Dir \"$subdir\" failed."
1243 }
1244 }
1245}
1246
1247#
1248# gdb_exit -- exit the GDB, killing the target program if necessary
1249#
1250proc default_gdb_exit {} {
1251 global GDB
6b8ce727 1252 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c 1253 global verbose
4ec70201 1254 global gdb_spawn_id
5e92f71a 1255 global inotify_log_file
c906108c 1256
4ec70201 1257 gdb_stop_suppressing_tests
c906108c
SS
1258
1259 if ![info exists gdb_spawn_id] {
4ec70201 1260 return
c906108c
SS
1261 }
1262
6b8ce727 1263 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
c906108c 1264
5e92f71a
TT
1265 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1266 set fd [open $inotify_log_file]
1267 set data [read -nonewline $fd]
1268 close $fd
1269
1270 if {[string compare $data ""] != 0} {
1271 warning "parallel-unsafe file creations noticed"
1272
1273 # Clear the log.
1274 set fd [open $inotify_log_file w]
1275 close $fd
1276 }
1277 }
1278
c906108c 1279 if { [is_remote host] && [board_info host exists fileid] } {
4ec70201 1280 send_gdb "quit\n"
c906108c
SS
1281 gdb_expect 10 {
1282 -re "y or n" {
4ec70201
PA
1283 send_gdb "y\n"
1284 exp_continue
c906108c
SS
1285 }
1286 -re "DOSEXIT code" { }
1287 default { }
1288 }
1289 }
1290
1291 if ![is_remote host] {
4ec70201 1292 remote_close host
c906108c
SS
1293 }
1294 unset gdb_spawn_id
1295}
1296
3e3ffd2b 1297# Load a file into the debugger.
2db8e78e 1298# The return value is 0 for success, -1 for failure.
c906108c 1299#
2db8e78e
MC
1300# This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1301# to one of these values:
3e3ffd2b 1302#
2db8e78e
MC
1303# debug file was loaded successfully and has debug information
1304# nodebug file was loaded successfully and has no debug information
608e2dbb
TT
1305# lzma file was loaded, .gnu_debugdata found, but no LZMA support
1306# compiled in
2db8e78e 1307# fail file was not loaded
c906108c 1308#
2db8e78e
MC
1309# I tried returning this information as part of the return value,
1310# but ran into a mess because of the many re-implementations of
1311# gdb_load in config/*.exp.
3e3ffd2b 1312#
2db8e78e
MC
1313# TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1314# this if they can get more information set.
3e3ffd2b 1315
c906108c 1316proc gdb_file_cmd { arg } {
3e3ffd2b 1317 global gdb_prompt
c906108c 1318 global verbose
c906108c 1319 global GDB
b741e217
DJ
1320 global last_loaded_file
1321
975531db 1322 # Save this for the benefit of gdbserver-support.exp.
b741e217 1323 set last_loaded_file $arg
c906108c 1324
2db8e78e
MC
1325 # Set whether debug info was found.
1326 # Default to "fail".
1327 global gdb_file_cmd_debug_info
1328 set gdb_file_cmd_debug_info "fail"
1329
c906108c 1330 if [is_remote host] {
3e3ffd2b 1331 set arg [remote_download host $arg]
c906108c 1332 if { $arg == "" } {
2db8e78e
MC
1333 perror "download failed"
1334 return -1
c906108c
SS
1335 }
1336 }
1337
4c42eaff
DJ
1338 # The file command used to kill the remote target. For the benefit
1339 # of the testsuite, preserve this behavior.
1340 send_gdb "kill\n"
1341 gdb_expect 120 {
1342 -re "Kill the program being debugged. .y or n. $" {
1343 send_gdb "y\n"
1344 verbose "\t\tKilling previous program being debugged"
1345 exp_continue
1346 }
1347 -re "$gdb_prompt $" {
1348 # OK.
1349 }
1350 }
1351
c906108c
SS
1352 send_gdb "file $arg\n"
1353 gdb_expect 120 {
608e2dbb
TT
1354 -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" {
1355 verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available"
1356 set gdb_file_cmd_debug_info "lzma"
1357 return 0
1358 }
3e3ffd2b 1359 -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
975531db 1360 verbose "\t\tLoaded $arg into $GDB with no debugging symbols"
2db8e78e
MC
1361 set gdb_file_cmd_debug_info "nodebug"
1362 return 0
3e3ffd2b 1363 }
c906108c 1364 -re "Reading symbols from.*done.*$gdb_prompt $" {
975531db 1365 verbose "\t\tLoaded $arg into $GDB"
2db8e78e
MC
1366 set gdb_file_cmd_debug_info "debug"
1367 return 0
c906108c 1368 }
c906108c
SS
1369 -re "Load new symbol table from \".*\".*y or n. $" {
1370 send_gdb "y\n"
1371 gdb_expect 120 {
1372 -re "Reading symbols from.*done.*$gdb_prompt $" {
1373 verbose "\t\tLoaded $arg with new symbol table into $GDB"
2db8e78e
MC
1374 set gdb_file_cmd_debug_info "debug"
1375 return 0
c906108c
SS
1376 }
1377 timeout {
975531db 1378 perror "Couldn't load $arg, other program already loaded (timeout)."
2db8e78e 1379 return -1
c906108c 1380 }
975531db
DE
1381 eof {
1382 perror "Couldn't load $arg, other program already loaded (eof)."
1383 return -1
1384 }
c906108c
SS
1385 }
1386 }
1387 -re "No such file or directory.*$gdb_prompt $" {
2db8e78e
MC
1388 perror "($arg) No such file or directory"
1389 return -1
c906108c 1390 }
04e7407c 1391 -re "A problem internal to GDB has been detected" {
5b7d0050 1392 fail "($arg) (GDB internal error)"
04e7407c
JK
1393 gdb_internal_error_resync
1394 return -1
1395 }
c906108c 1396 -re "$gdb_prompt $" {
975531db 1397 perror "Couldn't load $arg into $GDB."
2db8e78e 1398 return -1
c906108c
SS
1399 }
1400 timeout {
975531db 1401 perror "Couldn't load $arg into $GDB (timeout)."
2db8e78e 1402 return -1
c906108c
SS
1403 }
1404 eof {
1405 # This is an attempt to detect a core dump, but seems not to
1406 # work. Perhaps we need to match .* followed by eof, in which
1407 # gdb_expect does not seem to have a way to do that.
975531db 1408 perror "Couldn't load $arg into $GDB (eof)."
2db8e78e 1409 return -1
c906108c
SS
1410 }
1411 }
1412}
1413
1414#
1415# start gdb -- start gdb running, default procedure
1416#
1417# When running over NFS, particularly if running many simultaneous
1418# tests on different hosts all using the same server, things can
1419# get really slow. Give gdb at least 3 minutes to start up.
1420#
1421proc default_gdb_start { } {
e11ac3a3 1422 global verbose use_gdb_stub
c906108c 1423 global GDB
6b8ce727 1424 global INTERNAL_GDBFLAGS GDBFLAGS
c906108c
SS
1425 global gdb_prompt
1426 global timeout
4ec70201 1427 global gdb_spawn_id
c906108c 1428
4ec70201 1429 gdb_stop_suppressing_tests
c906108c 1430
e11ac3a3
JK
1431 # Set the default value, it may be overriden later by specific testfile.
1432 #
1433 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1434 # is already started after connecting and run/attach are not supported.
1435 # This is used for the "remote" protocol. After GDB starts you should
1436 # check global $use_gdb_stub instead of the board as the testfile may force
1437 # a specific different target protocol itself.
1438 set use_gdb_stub [target_info exists use_gdb_stub]
1439
6b8ce727 1440 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
c906108c
SS
1441
1442 if [info exists gdb_spawn_id] {
ae59b1da 1443 return 0
c906108c
SS
1444 }
1445
1446 if ![is_remote host] {
1447 if { [which $GDB] == 0 } then {
1448 perror "$GDB does not exist."
1449 exit 1
1450 }
1451 }
4ec70201 1452 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
c906108c
SS
1453 if { $res < 0 || $res == "" } {
1454 perror "Spawning $GDB failed."
ae59b1da 1455 return 1
c906108c
SS
1456 }
1457 gdb_expect 360 {
1458 -re "\[\r\n\]$gdb_prompt $" {
1459 verbose "GDB initialized."
1460 }
1461 -re "$gdb_prompt $" {
1462 perror "GDB never initialized."
1463 return -1
1464 }
1465 timeout {
1466 perror "(timeout) GDB never initialized after 10 seconds."
4ec70201 1467 remote_close host
c906108c
SS
1468 return -1
1469 }
1470 }
4ec70201 1471 set gdb_spawn_id -1
c906108c
SS
1472 # force the height to "unlimited", so no pagers get used
1473
1474 send_gdb "set height 0\n"
1475 gdb_expect 10 {
1476 -re "$gdb_prompt $" {
1477 verbose "Setting height to 0." 2
1478 }
1479 timeout {
1480 warning "Couldn't set the height to 0"
1481 }
1482 }
1483 # force the width to "unlimited", so no wraparound occurs
1484 send_gdb "set width 0\n"
1485 gdb_expect 10 {
1486 -re "$gdb_prompt $" {
1487 verbose "Setting width to 0." 2
1488 }
1489 timeout {
1490 warning "Couldn't set the width to 0."
1491 }
1492 }
ae59b1da 1493 return 0
c906108c
SS
1494}
1495
ec3c07fc
NS
1496# Examine the output of compilation to determine whether compilation
1497# failed or not. If it failed determine whether it is due to missing
1498# compiler or due to compiler error. Report pass, fail or unsupported
1499# as appropriate
1500
1501proc gdb_compile_test {src output} {
1502 if { $output == "" } {
1503 pass "compilation [file tail $src]"
1504 } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1505 unsupported "compilation [file tail $src]"
1506 } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1507 unsupported "compilation [file tail $src]"
6bb85cd1
DE
1508 } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1509 unsupported "compilation [file tail $src]"
ec3c07fc
NS
1510 } else {
1511 verbose -log "compilation failed: $output" 2
1512 fail "compilation [file tail $src]"
1513 }
1514}
1515
d4f3574e
SS
1516# Return a 1 for configurations for which we don't even want to try to
1517# test C++.
1518
1519proc skip_cplus_tests {} {
d4f3574e
SS
1520 if { [istarget "h8300-*-*"] } {
1521 return 1
1522 }
81d2cbae 1523
1146c7f1
SC
1524 # The C++ IO streams are too large for HC11/HC12 and are thus not
1525 # available. The gdb C++ tests use them and don't compile.
1526 if { [istarget "m6811-*-*"] } {
1527 return 1
1528 }
1529 if { [istarget "m6812-*-*"] } {
1530 return 1
1531 }
d4f3574e
SS
1532 return 0
1533}
1534
759f0f0b
PA
1535# Return a 1 for configurations for which don't have both C++ and the STL.
1536
1537proc skip_stl_tests {} {
1538 # Symbian supports the C++ language, but the STL is missing
1539 # (both headers and libraries).
1540 if { [istarget "arm*-*-symbianelf*"] } {
1541 return 1
1542 }
1543
1544 return [skip_cplus_tests]
1545}
1546
89a237cb
MC
1547# Return a 1 if I don't even want to try to test FORTRAN.
1548
1549proc skip_fortran_tests {} {
1550 return 0
1551}
1552
ec3c07fc
NS
1553# Return a 1 if I don't even want to try to test ada.
1554
1555proc skip_ada_tests {} {
1556 return 0
1557}
1558
a766d390
DE
1559# Return a 1 if I don't even want to try to test GO.
1560
1561proc skip_go_tests {} {
1562 return 0
1563}
1564
ec3c07fc
NS
1565# Return a 1 if I don't even want to try to test java.
1566
1567proc skip_java_tests {} {
1568 return 0
1569}
1570
7f420862
IB
1571# Return a 1 if I don't even want to try to test D.
1572
1573proc skip_d_tests {} {
1574 return 0
1575}
1576
f6bbabf0
PM
1577# Return a 1 for configurations that do not support Python scripting.
1578
1579proc skip_python_tests {} {
1580 global gdb_prompt
9325cb04
PK
1581 global gdb_py_is_py3k
1582 global gdb_py_is_py24
1583
1584 gdb_test_multiple "python print ('test')" "verify python support" {
f6bbabf0
PM
1585 -re "not supported.*$gdb_prompt $" {
1586 unsupported "Python support is disabled."
1587 return 1
1588 }
1589 -re "$gdb_prompt $" {}
1590 }
1591
9325cb04
PK
1592 set gdb_py_is_py24 0
1593 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1594 -re "3.*$gdb_prompt $" {
1595 set gdb_py_is_py3k 1
1596 }
1597 -re ".*$gdb_prompt $" {
1598 set gdb_py_is_py3k 0
1599 }
1600 }
1601 if { $gdb_py_is_py3k == 0 } {
1602 gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" {
1603 -re "\[45\].*$gdb_prompt $" {
1604 set gdb_py_is_py24 1
1605 }
1606 -re ".*$gdb_prompt $" {
1607 set gdb_py_is_py24 0
1608 }
1609 }
1610 }
1611
f6bbabf0
PM
1612 return 0
1613}
1614
93f02886
DJ
1615# Return a 1 if we should skip shared library tests.
1616
1617proc skip_shlib_tests {} {
1618 # Run the shared library tests on native systems.
1619 if {[isnative]} {
1620 return 0
1621 }
1622
1623 # An abbreviated list of remote targets where we should be able to
1624 # run shared library tests.
1625 if {([istarget *-*-linux*]
1626 || [istarget *-*-*bsd*]
1627 || [istarget *-*-solaris2*]
1628 || [istarget arm*-*-symbianelf*]
1629 || [istarget *-*-mingw*]
1630 || [istarget *-*-cygwin*]
1631 || [istarget *-*-pe*])} {
1632 return 0
1633 }
1634
1635 return 1
1636}
1637
6a5870ce
PA
1638# Test files shall make sure all the test result lines in gdb.sum are
1639# unique in a test run, so that comparing the gdb.sum files of two
1640# test runs gives correct results. Test files that exercise
1641# variations of the same tests more than once, shall prefix the
1642# different test invocations with different identifying strings in
1643# order to make them unique.
1644#
1645# About test prefixes:
1646#
1647# $pf_prefix is the string that dejagnu prints after the result (FAIL,
1648# PASS, etc.), and before the test message/name in gdb.sum. E.g., the
1649# underlined substring in
1650#
1651# PASS: gdb.base/mytest.exp: some test
1652# ^^^^^^^^^^^^^^^^^^^^
1653#
1654# is $pf_prefix.
1655#
1656# The easiest way to adjust the test prefix is to append a test
1657# variation prefix to the $pf_prefix, using the with_test_prefix
1658# procedure. E.g.,
1659#
1660# proc do_tests {} {
1661# gdb_test ... ... "test foo"
1662# gdb_test ... ... "test bar"
1663#
0f4d39d5 1664# with_test_prefix "subvariation a" {
6a5870ce
PA
1665# gdb_test ... ... "test x"
1666# }
1667#
0f4d39d5 1668# with_test_prefix "subvariation b" {
6a5870ce
PA
1669# gdb_test ... ... "test x"
1670# }
1671# }
1672#
0f4d39d5 1673# with_test_prefix "variation1" {
6a5870ce
PA
1674# ...do setup for variation 1...
1675# do_tests
1676# }
1677#
0f4d39d5 1678# with_test_prefix "variation2" {
6a5870ce
PA
1679# ...do setup for variation 2...
1680# do_tests
1681# }
1682#
1683# Results in:
1684#
1685# PASS: gdb.base/mytest.exp: variation1: test foo
1686# PASS: gdb.base/mytest.exp: variation1: test bar
1687# PASS: gdb.base/mytest.exp: variation1: subvariation a: test x
1688# PASS: gdb.base/mytest.exp: variation1: subvariation b: test x
1689# PASS: gdb.base/mytest.exp: variation2: test foo
1690# PASS: gdb.base/mytest.exp: variation2: test bar
1691# PASS: gdb.base/mytest.exp: variation2: subvariation a: test x
1692# PASS: gdb.base/mytest.exp: variation2: subvariation b: test x
1693#
1694# If for some reason more flexibility is necessary, one can also
1695# manipulate the pf_prefix global directly, treating it as a string.
1696# E.g.,
1697#
1698# global pf_prefix
1699# set saved_pf_prefix
0f4d39d5 1700# append pf_prefix "${foo}: bar"
6a5870ce
PA
1701# ... actual tests ...
1702# set pf_prefix $saved_pf_prefix
1703#
1704
1705# Run BODY in the context of the caller, with the current test prefix
0f4d39d5
PA
1706# (pf_prefix) appended with one space, then PREFIX, and then a colon.
1707# Returns the result of BODY.
6a5870ce
PA
1708#
1709proc with_test_prefix { prefix body } {
1710 global pf_prefix
1711
1712 set saved $pf_prefix
0f4d39d5 1713 append pf_prefix " " $prefix ":"
6a5870ce
PA
1714 set code [catch {uplevel 1 $body} result]
1715 set pf_prefix $saved
1716
1717 if {$code == 1} {
1718 global errorInfo errorCode
1719 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1720 } else {
1721 return -code $code $result
1722 }
1723}
1724
8b5e6dc2
YQ
1725# Run tests in BODY with GDB prompt and variable $gdb_prompt set to
1726# PROMPT. When BODY is finished, restore GDB prompt and variable
1727# $gdb_prompt.
1728# Returns the result of BODY.
1729
1730proc with_gdb_prompt { prompt body } {
1731 global gdb_prompt
1732
1733 set saved $gdb_prompt
1734
1735 set gdb_prompt $prompt
1736 gdb_test_no_output "set prompt $prompt " ""
1737
1738 set code [catch {uplevel 1 $body} result]
1739
1740 set gdb_prompt $saved
1741 gdb_test_no_output "set prompt $saved " ""
1742
1743 if {$code == 1} {
1744 global errorInfo errorCode
1745 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
1746 } else {
1747 return -code $code $result
1748 }
1749}
1750
e43ec454
YQ
1751# Return 1 if _Complex types are supported, otherwise, return 0.
1752
17e1c970 1753gdb_caching_proc support_complex_tests {
e43ec454
YQ
1754 # Set up, compile, and execute a test program containing _Complex types.
1755 # Include the current process ID in the file names to prevent conflicts
1756 # with invocations for multiple testsuites.
4e234898
TT
1757 set src [standard_temp_file complex[pid].c]
1758 set exe [standard_temp_file complex[pid].x]
e43ec454 1759
11ec5965
YQ
1760 gdb_produce_source $src {
1761 int main() {
1762 _Complex float cf;
1763 _Complex double cd;
1764 _Complex long double cld;
1765 return 0;
1766 }
1767 }
e43ec454
YQ
1768
1769 verbose "compiling testfile $src" 2
1770 set compile_flags {debug nowarnings quiet}
1771 set lines [gdb_compile $src $exe executable $compile_flags]
1772 file delete $src
1773 file delete $exe
1774
1775 if ![string match "" $lines] then {
1776 verbose "testfile compilation failed, returning 0" 2
17e1c970 1777 set result 0
e43ec454 1778 } else {
17e1c970 1779 set result 1
e43ec454
YQ
1780 }
1781
17e1c970 1782 return $result
e43ec454
YQ
1783}
1784
ab254057
YQ
1785# Return 1 if target hardware or OS supports single stepping to signal
1786# handler, otherwise, return 0.
1787
1788proc can_single_step_to_signal_handler {} {
1789
1790 # Targets don't have hardware single step. On these targets, when
1791 # a signal is delivered during software single step, gdb is unable
1792 # to determine the next instruction addresses, because start of signal
1793 # handler is one of them.
b0221781 1794 if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"]
73cd8ab1 1795 || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"] } {
ab254057
YQ
1796 return 0
1797 }
1798
1799 return 1
1800}
1801
d3895d7d
YQ
1802# Return 1 if target supports process record, otherwise return 0.
1803
1804proc supports_process_record {} {
1805
1806 if [target_info exists gdb,use_precord] {
1807 return [target_info gdb,use_precord]
1808 }
1809
596662fa
OJ
1810 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
1811 || [istarget "i\[34567\]86-*-linux*"] } {
d3895d7d
YQ
1812 return 1
1813 }
1814
1815 return 0
1816}
1817
1818# Return 1 if target supports reverse debugging, otherwise return 0.
1819
1820proc supports_reverse {} {
1821
1822 if [target_info exists gdb,can_reverse] {
1823 return [target_info gdb,can_reverse]
1824 }
1825
596662fa
OJ
1826 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
1827 || [istarget "i\[34567\]86-*-linux*"] } {
d3895d7d
YQ
1828 return 1
1829 }
1830
1831 return 0
1832}
1833
e9f0e62e
NB
1834# Return 1 if target is ELF.
1835gdb_caching_proc is_elf_target {
1836 set me "is_elf_target"
1837
1838 set src [standard_temp_file is_elf_target[pid].c]
1839 set obj [standard_temp_file is_elf_target[pid].o]
1840
11ec5965
YQ
1841 gdb_produce_source $src {
1842 int foo () {return 0;}
1843 }
e9f0e62e
NB
1844
1845 verbose "$me: compiling testfile $src" 2
1846 set lines [gdb_compile $src $obj object {quiet}]
1847
1848 file delete $src
1849
1850 if ![string match "" $lines] then {
1851 verbose "$me: testfile compilation failed, returning 0" 2
1852 return 0
1853 }
1854
1855 set fp_obj [open $obj "r"]
1856 fconfigure $fp_obj -translation binary
1857 set data [read $fp_obj]
1858 close $fp_obj
1859
1860 file delete $obj
1861
1862 set ELFMAG "\u007FELF"
1863
1864 if {[string compare -length 4 $data $ELFMAG] != 0} {
1865 verbose "$me: returning 0" 2
1866 return 0
1867 }
1868
1869 verbose "$me: returning 1" 2
1870 return 1
1871}
1872
6dbb6798
YQ
1873# Produce source file NAME and write SOURCES into it.
1874
1875proc gdb_produce_source { name sources } {
1876 set index 0
1877 set f [open $name "w"]
1878
1879 puts $f $sources
1880 close $f
1881}
1882
add265ae
L
1883# Return 1 if target is ILP32.
1884# This cannot be decided simply from looking at the target string,
1885# as it might depend on externally passed compiler options like -m64.
17e1c970 1886gdb_caching_proc is_ilp32_target {
add265ae 1887 set me "is_ilp32_target"
add265ae 1888
4e234898
TT
1889 set src [standard_temp_file ilp32[pid].c]
1890 set obj [standard_temp_file ilp32[pid].o]
add265ae 1891
11ec5965
YQ
1892 gdb_produce_source $src {
1893 int dummy[sizeof (int) == 4
1894 && sizeof (void *) == 4
1895 && sizeof (long) == 4 ? 1 : -1];
1896 }
add265ae
L
1897
1898 verbose "$me: compiling testfile $src" 2
1899 set lines [gdb_compile $src $obj object {quiet}]
1900 file delete $src
1901 file delete $obj
1902
1903 if ![string match "" $lines] then {
1904 verbose "$me: testfile compilation failed, returning 0" 2
17e1c970 1905 return 0
add265ae
L
1906 }
1907
1908 verbose "$me: returning 1" 2
17e1c970 1909 return 1
add265ae
L
1910}
1911
1912# Return 1 if target is LP64.
1913# This cannot be decided simply from looking at the target string,
1914# as it might depend on externally passed compiler options like -m64.
17e1c970 1915gdb_caching_proc is_lp64_target {
add265ae 1916 set me "is_lp64_target"
add265ae 1917
4e234898
TT
1918 set src [standard_temp_file lp64[pid].c]
1919 set obj [standard_temp_file lp64[pid].o]
add265ae 1920
11ec5965
YQ
1921 gdb_produce_source $src {
1922 int dummy[sizeof (int) == 4
1923 && sizeof (void *) == 8
1924 && sizeof (long) == 8 ? 1 : -1];
1925 }
add265ae
L
1926
1927 verbose "$me: compiling testfile $src" 2
1928 set lines [gdb_compile $src $obj object {quiet}]
1929 file delete $src
1930 file delete $obj
1931
1932 if ![string match "" $lines] then {
1933 verbose "$me: testfile compilation failed, returning 0" 2
17e1c970 1934 return 0
add265ae
L
1935 }
1936
1937 verbose "$me: returning 1" 2
17e1c970 1938 return 1
add265ae
L
1939}
1940
e630b974
TT
1941# Return 1 if target has 64 bit addresses.
1942# This cannot be decided simply from looking at the target string,
1943# as it might depend on externally passed compiler options like -m64.
1944gdb_caching_proc is_64_target {
1945 set me "is_64_target"
1946
1947 set src [standard_temp_file is64[pid].c]
1948 set obj [standard_temp_file is64[pid].o]
1949
11ec5965
YQ
1950 gdb_produce_source $src {
1951 int function(void) { return 3; }
1952 int dummy[sizeof (&function) == 8 ? 1 : -1];
1953 }
e630b974
TT
1954
1955 verbose "$me: compiling testfile $src" 2
1956 set lines [gdb_compile $src $obj object {quiet}]
1957 file delete $src
1958 file delete $obj
1959
1960 if ![string match "" $lines] then {
1961 verbose "$me: testfile compilation failed, returning 0" 2
1962 return 0
1963 }
1964
1965 verbose "$me: returning 1" 2
1966 return 1
1967}
1968
7f062217
JK
1969# Return 1 if target has x86_64 registers - either amd64 or x32.
1970# x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
1971# just from the target string.
17e1c970 1972gdb_caching_proc is_amd64_regs_target {
68fb0ec0 1973 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
7f062217
JK
1974 return 0
1975 }
1976
7f062217 1977 set me "is_amd64_regs_target"
7f062217 1978
4e234898
TT
1979 set src [standard_temp_file reg64[pid].s]
1980 set obj [standard_temp_file reg64[pid].o]
7f062217 1981
11ec5965 1982 set list {}
7f062217 1983 foreach reg \
11ec5965
YQ
1984 {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} {
1985 lappend list "\tincq %$reg"
1986 }
1987 gdb_produce_source $src [join $list \n]
7f062217
JK
1988
1989 verbose "$me: compiling testfile $src" 2
1990 set lines [gdb_compile $src $obj object {quiet}]
1991 file delete $src
1992 file delete $obj
1993
1994 if ![string match "" $lines] then {
1995 verbose "$me: testfile compilation failed, returning 0" 2
17e1c970 1996 return 0
7f062217
JK
1997 }
1998
1999 verbose "$me: returning 1" 2
17e1c970 2000 return 1
7f062217
JK
2001}
2002
6edba76f
TT
2003# Return 1 if this target is an x86 or x86-64 with -m32.
2004proc is_x86_like_target {} {
68fb0ec0 2005 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
6edba76f
TT
2006 return 0
2007 }
7f062217 2008 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
6edba76f
TT
2009}
2010
be777e08
YQ
2011# Return 1 if displaced stepping is supported on target, otherwise, return 0.
2012proc support_displaced_stepping {} {
2013
2014 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2015 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2016 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } {
2017 return 1
2018 }
2019
2020 return 0
2021}
2022
3c95e6af
PG
2023# Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2024# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2025
17e1c970 2026gdb_caching_proc skip_altivec_tests {
fda326dd 2027 global srcdir subdir gdb_prompt inferior_exited_re
3c95e6af 2028
3c95e6af 2029 set me "skip_altivec_tests"
3c95e6af
PG
2030
2031 # Some simulators are known to not support VMX instructions.
2032 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2033 verbose "$me: target known to not support VMX, returning 1" 2
17e1c970 2034 return 1
3c95e6af
PG
2035 }
2036
2037 # Make sure we have a compiler that understands altivec.
fc91c6c2 2038 set compile_flags {debug nowarnings}
4c93b1db 2039 if [get_compiler_info] {
3c95e6af
PG
2040 warning "Could not get compiler info"
2041 return 1
2042 }
2043 if [test_compiler_info gcc*] {
2044 set compile_flags "$compile_flags additional_flags=-maltivec"
2045 } elseif [test_compiler_info xlc*] {
2046 set compile_flags "$compile_flags additional_flags=-qaltivec"
2047 } else {
2048 verbose "Could not compile with altivec support, returning 1" 2
2049 return 1
2050 }
2051
2052 # Set up, compile, and execute a test program containing VMX instructions.
2053 # Include the current process ID in the file names to prevent conflicts
2054 # with invocations for multiple testsuites.
4e234898
TT
2055 set src [standard_temp_file vmx[pid].c]
2056 set exe [standard_temp_file vmx[pid].x]
3c95e6af 2057
11ec5965
YQ
2058 gdb_produce_source $src {
2059 int main() {
2060 #ifdef __MACH__
2061 asm volatile ("vor v0,v0,v0");
2062 #else
2063 asm volatile ("vor 0,0,0");
2064 #endif
2065 return 0;
2066 }
2067 }
3c95e6af
PG
2068
2069 verbose "$me: compiling testfile $src" 2
2070 set lines [gdb_compile $src $exe executable $compile_flags]
2071 file delete $src
2072
2073 if ![string match "" $lines] then {
2074 verbose "$me: testfile compilation failed, returning 1" 2
17e1c970 2075 return 1
3c95e6af
PG
2076 }
2077
2078 # No error message, compilation succeeded so now run it via gdb.
2079
2080 gdb_exit
2081 gdb_start
2082 gdb_reinitialize_dir $srcdir/$subdir
2083 gdb_load "$exe"
2084 gdb_run_cmd
2085 gdb_expect {
2086 -re ".*Illegal instruction.*${gdb_prompt} $" {
2087 verbose -log "\n$me altivec hardware not detected"
17e1c970 2088 set skip_vmx_tests 1
3c95e6af 2089 }
fda326dd 2090 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
3c95e6af 2091 verbose -log "\n$me: altivec hardware detected"
17e1c970 2092 set skip_vmx_tests 0
3c95e6af
PG
2093 }
2094 default {
2095 warning "\n$me: default case taken"
17e1c970 2096 set skip_vmx_tests 1
3c95e6af
PG
2097 }
2098 }
2099 gdb_exit
2100 remote_file build delete $exe
2101
17e1c970
TT
2102 verbose "$me: returning $skip_vmx_tests" 2
2103 return $skip_vmx_tests
3c95e6af
PG
2104}
2105
604c2f83
LM
2106# Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2107# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2108
17e1c970 2109gdb_caching_proc skip_vsx_tests {
fda326dd 2110 global srcdir subdir gdb_prompt inferior_exited_re
604c2f83 2111
604c2f83 2112 set me "skip_vsx_tests"
604c2f83
LM
2113
2114 # Some simulators are known to not support Altivec instructions, so
2115 # they won't support VSX instructions as well.
2116 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2117 verbose "$me: target known to not support VSX, returning 1" 2
17e1c970 2118 return 1
604c2f83
LM
2119 }
2120
2121 # Make sure we have a compiler that understands altivec.
2122 set compile_flags {debug nowarnings quiet}
4c93b1db 2123 if [get_compiler_info] {
604c2f83
LM
2124 warning "Could not get compiler info"
2125 return 1
2126 }
2127 if [test_compiler_info gcc*] {
2128 set compile_flags "$compile_flags additional_flags=-mvsx"
2129 } elseif [test_compiler_info xlc*] {
d9492458 2130 set compile_flags "$compile_flags additional_flags=-qasm=gcc"
604c2f83
LM
2131 } else {
2132 verbose "Could not compile with vsx support, returning 1" 2
2133 return 1
2134 }
2135
4e234898
TT
2136 set src [standard_temp_file vsx[pid].c]
2137 set exe [standard_temp_file vsx[pid].x]
604c2f83 2138
11ec5965
YQ
2139 gdb_produce_source $src {
2140 int main() {
2141 double a[2] = { 1.0, 2.0 };
2142 #ifdef __MACH__
2143 asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a));
2144 #else
2145 asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a));
2146 #endif
2147 return 0;
2148 }
2149 }
604c2f83
LM
2150
2151 verbose "$me: compiling testfile $src" 2
2152 set lines [gdb_compile $src $exe executable $compile_flags]
2153 file delete $src
2154
2155 if ![string match "" $lines] then {
2156 verbose "$me: testfile compilation failed, returning 1" 2
17e1c970 2157 return 1
604c2f83
LM
2158 }
2159
2160 # No error message, compilation succeeded so now run it via gdb.
2161
2162 gdb_exit
2163 gdb_start
2164 gdb_reinitialize_dir $srcdir/$subdir
2165 gdb_load "$exe"
2166 gdb_run_cmd
2167 gdb_expect {
2168 -re ".*Illegal instruction.*${gdb_prompt} $" {
2169 verbose -log "\n$me VSX hardware not detected"
17e1c970 2170 set skip_vsx_tests 1
604c2f83 2171 }
fda326dd 2172 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
604c2f83 2173 verbose -log "\n$me: VSX hardware detected"
17e1c970 2174 set skip_vsx_tests 0
604c2f83
LM
2175 }
2176 default {
2177 warning "\n$me: default case taken"
17e1c970 2178 set skip_vsx_tests 1
604c2f83
LM
2179 }
2180 }
2181 gdb_exit
2182 remote_file build delete $exe
2183
17e1c970
TT
2184 verbose "$me: returning $skip_vsx_tests" 2
2185 return $skip_vsx_tests
604c2f83
LM
2186}
2187
2f1d9bdd
MM
2188# Run a test on the target to see if it supports btrace hardware. Return 0 if so,
2189# 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite.
2190
f3a76454 2191gdb_caching_proc skip_btrace_tests {
2f1d9bdd
MM
2192 global srcdir subdir gdb_prompt inferior_exited_re
2193
2f1d9bdd 2194 set me "skip_btrace_tests"
2f1d9bdd
MM
2195 if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } {
2196 verbose "$me: target does not support btrace, returning 1" 2
f3a76454 2197 return 1
2f1d9bdd
MM
2198 }
2199
2200 # Set up, compile, and execute a test program.
2201 # Include the current process ID in the file names to prevent conflicts
2202 # with invocations for multiple testsuites.
f3a76454
TT
2203 set src [standard_temp_file btrace[pid].c]
2204 set exe [standard_temp_file btrace[pid].x]
2f1d9bdd 2205
11ec5965
YQ
2206 gdb_produce_source $src {
2207 int main(void) { return 0; }
2208 }
2f1d9bdd
MM
2209
2210 verbose "$me: compiling testfile $src" 2
2211 set compile_flags {debug nowarnings quiet}
2212 set lines [gdb_compile $src $exe executable $compile_flags]
2f1d9bdd
MM
2213
2214 if ![string match "" $lines] then {
2215 verbose "$me: testfile compilation failed, returning 1" 2
4043f22b 2216 file delete $src
f3a76454 2217 return 1
2f1d9bdd
MM
2218 }
2219
2220 # No error message, compilation succeeded so now run it via gdb.
2221
f3a76454
TT
2222 gdb_exit
2223 gdb_start
2224 gdb_reinitialize_dir $srcdir/$subdir
2225 gdb_load $exe
2f1d9bdd 2226 if ![runto_main] {
4043f22b 2227 file delete $src
f3a76454 2228 return 1
2f1d9bdd 2229 }
4043f22b 2230 file delete $src
2f1d9bdd 2231 # In case of an unexpected output, we return 2 as a fail value.
f3a76454 2232 set skip_btrace_tests 2
2f1d9bdd
MM
2233 gdb_test_multiple "record btrace" "check btrace support" {
2234 -re "You can't do that when your target is.*\r\n$gdb_prompt $" {
f3a76454 2235 set skip_btrace_tests 1
2f1d9bdd
MM
2236 }
2237 -re "Target does not support branch tracing.*\r\n$gdb_prompt $" {
f3a76454 2238 set skip_btrace_tests 1
2f1d9bdd
MM
2239 }
2240 -re "Could not enable branch tracing.*\r\n$gdb_prompt $" {
f3a76454 2241 set skip_btrace_tests 1
2f1d9bdd
MM
2242 }
2243 -re "^record btrace\r\n$gdb_prompt $" {
f3a76454 2244 set skip_btrace_tests 0
2f1d9bdd
MM
2245 }
2246 }
2247 gdb_exit
2248 remote_file build delete $exe
2249
f3a76454
TT
2250 verbose "$me: returning $skip_btrace_tests" 2
2251 return $skip_btrace_tests
2f1d9bdd
MM
2252}
2253
7a292a7a
SS
2254# Skip all the tests in the file if you are not on an hppa running
2255# hpux target.
2256
2257proc skip_hp_tests {} {
2258 eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
c906108c
SS
2259 verbose "Skip hp tests is $skip_hp"
2260 return $skip_hp
2261}
2262
edb3359d
DJ
2263# Return whether we should skip tests for showing inlined functions in
2264# backtraces. Requires get_compiler_info and get_debug_format.
2265
2266proc skip_inline_frame_tests {} {
2267 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2268 if { ! [test_debug_format "DWARF 2"] } {
2269 return 1
2270 }
2271
2272 # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
2273 if { ([test_compiler_info "gcc-2-*"]
2274 || [test_compiler_info "gcc-3-*"]
2275 || [test_compiler_info "gcc-4-0-*"]) } {
2276 return 1
2277 }
2278
2279 return 0
2280}
2281
2282# Return whether we should skip tests for showing variables from
2283# inlined functions. Requires get_compiler_info and get_debug_format.
2284
2285proc skip_inline_var_tests {} {
2286 # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
2287 if { ! [test_debug_format "DWARF 2"] } {
2288 return 1
2289 }
2290
2291 return 0
2292}
2293
b800ec70
UW
2294# Return a 1 if we should skip tests that require hardware breakpoints
2295
2296proc skip_hw_breakpoint_tests {} {
2297 # Skip tests if requested by the board (note that no_hardware_watchpoints
2298 # disables both watchpoints and breakpoints)
2299 if { [target_info exists gdb,no_hardware_watchpoints]} {
2300 return 1
2301 }
2302
2303 # These targets support hardware breakpoints natively
2304 if { [istarget "i?86-*-*"]
2305 || [istarget "x86_64-*-*"]
e3039479
UW
2306 || [istarget "ia64-*-*"]
2307 || [istarget "arm*-*-*"]} {
b800ec70
UW
2308 return 0
2309 }
2310
2311 return 1
2312}
2313
2314# Return a 1 if we should skip tests that require hardware watchpoints
2315
2316proc skip_hw_watchpoint_tests {} {
2317 # Skip tests if requested by the board
2318 if { [target_info exists gdb,no_hardware_watchpoints]} {
2319 return 1
2320 }
2321
2322 # These targets support hardware watchpoints natively
2323 if { [istarget "i?86-*-*"]
2324 || [istarget "x86_64-*-*"]
2325 || [istarget "ia64-*-*"]
e3039479 2326 || [istarget "arm*-*-*"]
b800ec70
UW
2327 || [istarget "powerpc*-*-linux*"]
2328 || [istarget "s390*-*-*"] } {
2329 return 0
2330 }
2331
2332 return 1
2333}
2334
2335# Return a 1 if we should skip tests that require *multiple* hardware
2336# watchpoints to be active at the same time
2337
2338proc skip_hw_watchpoint_multi_tests {} {
2339 if { [skip_hw_watchpoint_tests] } {
2340 return 1
2341 }
2342
2343 # These targets support just a single hardware watchpoint
e3039479
UW
2344 if { [istarget "arm*-*-*"]
2345 || [istarget "powerpc*-*-linux*"] } {
b800ec70
UW
2346 return 1
2347 }
2348
2349 return 0
2350}
2351
2352# Return a 1 if we should skip tests that require read/access watchpoints
2353
2354proc skip_hw_watchpoint_access_tests {} {
2355 if { [skip_hw_watchpoint_tests] } {
2356 return 1
2357 }
2358
2359 # These targets support just write watchpoints
2360 if { [istarget "s390*-*-*"] } {
2361 return 1
2362 }
2363
2364 return 0
2365}
2366
b4893d48
TT
2367# Return 1 if we should skip tests that require the runtime unwinder
2368# hook. This must be invoked while gdb is running, after shared
2369# libraries have been loaded. This is needed because otherwise a
2370# shared libgcc won't be visible.
2371
2372proc skip_unwinder_tests {} {
2373 global gdb_prompt
2374
4442ada7 2375 set ok 0
b4893d48
TT
2376 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
2377 -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
b4893d48
TT
2378 }
2379 -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" {
4442ada7 2380 set ok 1
b4893d48
TT
2381 }
2382 -re "No symbol .* in current context.\r\n$gdb_prompt $" {
b4893d48
TT
2383 }
2384 }
2385 if {!$ok} {
2386 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
2387 -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" {
b4893d48
TT
2388 set ok 1
2389 }
2390 -re "\r\n$gdb_prompt $" {
2391 }
2392 }
2393 }
2394 return $ok
2395}
2396
72f1fe8a
TT
2397# Return 0 if we should skip tests that require the libstdc++ stap
2398# probes. This must be invoked while gdb is running, after shared
2399# libraries have been loaded.
2400
2401proc skip_libstdcxx_probe_tests {} {
2402 global gdb_prompt
2403
2404 set ok 0
2405 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
2406 -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" {
2407 set ok 1
2408 }
2409 -re "\r\n$gdb_prompt $" {
2410 }
2411 }
2412 return $ok
2413}
2414
94b8e876
MC
2415set compiler_info "unknown"
2416set gcc_compiled 0
2417set hp_cc_compiler 0
2418set hp_aCC_compiler 0
94b8e876
MC
2419
2420# Figure out what compiler I am using.
2421#
4c93b1db 2422# ARG can be empty or "C++". If empty, "C" is assumed.
94b8e876
MC
2423#
2424# There are several ways to do this, with various problems.
2425#
2426# [ gdb_compile -E $ifile -o $binfile.ci ]
2427# source $binfile.ci
2428#
2429# Single Unix Spec v3 says that "-E -o ..." together are not
2430# specified. And in fact, the native compiler on hp-ux 11 (among
2431# others) does not work with "-E -o ...". Most targets used to do
2432# this, and it mostly worked, because it works with gcc.
2433#
2434# [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
2435# source $binfile.ci
2436#
2437# This avoids the problem with -E and -o together. This almost works
2438# if the build machine is the same as the host machine, which is
2439# usually true of the targets which are not gcc. But this code does
2440# not figure which compiler to call, and it always ends up using the C
2441# compiler. Not good for setting hp_aCC_compiler. Targets
2442# hppa*-*-hpux* and mips*-*-irix* used to do this.
2443#
2444# [ gdb_compile -E $ifile > $binfile.ci ]
2445# source $binfile.ci
2446#
2447# dejagnu target_compile says that it supports output redirection,
2448# but the code is completely different from the normal path and I
2449# don't want to sweep the mines from that path. So I didn't even try
2450# this.
2451#
2452# set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
2453# eval $cppout
2454#
2455# I actually do this for all targets now. gdb_compile runs the right
2456# compiler, and TCL captures the output, and I eval the output.
2457#
2458# Unfortunately, expect logs the output of the command as it goes by,
2459# and dejagnu helpfully prints a second copy of it right afterwards.
2460# So I turn off expect logging for a moment.
2461#
2462# [ gdb_compile $ifile $ciexe_file executable $args ]
2463# [ remote_exec $ciexe_file ]
2464# [ source $ci_file.out ]
2465#
2466# I could give up on -E and just do this.
2467# I didn't get desperate enough to try this.
2468#
2469# -- chastain 2004-01-06
853d6e5b 2470
4c93b1db 2471proc get_compiler_info {{arg ""}} {
94b8e876 2472 # For compiler.c and compiler.cc
c906108c 2473 global srcdir
94b8e876
MC
2474
2475 # I am going to play with the log to keep noise out.
2476 global outdir
2477 global tool
2478
2479 # These come from compiler.c or compiler.cc
853d6e5b 2480 global compiler_info
4f70a4c9
MC
2481
2482 # Legacy global data symbols.
94b8e876
MC
2483 global gcc_compiled
2484 global hp_cc_compiler
2485 global hp_aCC_compiler
c906108c 2486
94b8e876
MC
2487 # Choose which file to preprocess.
2488 set ifile "${srcdir}/lib/compiler.c"
4c93b1db 2489 if { $arg == "c++" } {
94b8e876 2490 set ifile "${srcdir}/lib/compiler.cc"
c906108c 2491 }
085dd6e6 2492
94b8e876
MC
2493 # Run $ifile through the right preprocessor.
2494 # Toggle gdb.log to keep the compiler output out of the log.
95d7853e 2495 set saved_log [log_file -info]
94b8e876 2496 log_file
e7f86de9
JM
2497 if [is_remote host] {
2498 # We have to use -E and -o together, despite the comments
2499 # above, because of how DejaGnu handles remote host testing.
2500 set ppout "$outdir/compiler.i"
4c93b1db 2501 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet]
e7f86de9
JM
2502 set file [open $ppout r]
2503 set cppout [read $file]
2504 close $file
2505 } else {
4c93b1db 2506 set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ]
e7f86de9 2507 }
95d7853e 2508 eval log_file $saved_log
94b8e876 2509
4f70a4c9
MC
2510 # Eval the output.
2511 set unknown 0
94b8e876 2512 foreach cppline [ split "$cppout" "\n" ] {
4f70a4c9
MC
2513 if { [ regexp "^#" "$cppline" ] } {
2514 # line marker
2515 } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
2516 # blank line
2517 } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
2518 # eval this line
2519 verbose "get_compiler_info: $cppline" 2
2520 eval "$cppline"
2521 } else {
2522 # unknown line
2523 verbose -log "get_compiler_info: $cppline"
2524 set unknown 1
94b8e876 2525 }
085dd6e6 2526 }
4f70a4c9
MC
2527
2528 # Reset to unknown compiler if any diagnostics happened.
2529 if { $unknown } {
2530 set compiler_info "unknown"
4f70a4c9
MC
2531 }
2532
2533 # Set the legacy symbols.
2534 set gcc_compiled 0
2535 set hp_cc_compiler 0
2536 set hp_aCC_compiler 0
2537 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
2538 if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
2539 if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
2540 if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
2541 if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
2542 if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 }
2543 if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
2544
2545 # Log what happened.
94b8e876 2546 verbose -log "get_compiler_info: $compiler_info"
085dd6e6
JM
2547
2548 # Most compilers will evaluate comparisons and other boolean
2549 # operations to 0 or 1.
2550 uplevel \#0 { set true 1 }
2551 uplevel \#0 { set false 0 }
2552
94b8e876
MC
2553 # Use of aCC results in boolean results being displayed as
2554 # "true" or "false"
2555 if { $hp_aCC_compiler } {
2556 uplevel \#0 { set true true }
2557 uplevel \#0 { set false false }
085dd6e6
JM
2558 }
2559
ae59b1da 2560 return 0
c906108c
SS
2561}
2562
9b593790 2563proc test_compiler_info { {compiler ""} } {
853d6e5b 2564 global compiler_info
6e87504d
PG
2565
2566 # if no arg, return the compiler_info string
2567
2568 if [string match "" $compiler] {
2569 if [info exists compiler_info] {
2570 return $compiler_info
2571 } else {
2572 perror "No compiler info found."
2573 }
2574 }
2575
853d6e5b
AC
2576 return [string match $compiler $compiler_info]
2577}
2578
f6838f81
DJ
2579proc current_target_name { } {
2580 global target_info
2581 if [info exists target_info(target,name)] {
2582 set answer $target_info(target,name)
2583 } else {
2584 set answer ""
2585 }
2586 return $answer
2587}
2588
f1c47eb2 2589set gdb_wrapper_initialized 0
f6838f81 2590set gdb_wrapper_target ""
f1c47eb2
MS
2591
2592proc gdb_wrapper_init { args } {
4ec70201
PA
2593 global gdb_wrapper_initialized
2594 global gdb_wrapper_file
2595 global gdb_wrapper_flags
f6838f81 2596 global gdb_wrapper_target
f1c47eb2
MS
2597
2598 if { $gdb_wrapper_initialized == 1 } { return; }
2599
2600 if {[target_info exists needs_status_wrapper] && \
277254ba 2601 [target_info needs_status_wrapper] != "0"} {
4ec70201 2602 set result [build_wrapper "testglue.o"]
f1c47eb2 2603 if { $result != "" } {
4ec70201
PA
2604 set gdb_wrapper_file [lindex $result 0]
2605 set gdb_wrapper_flags [lindex $result 1]
f1c47eb2
MS
2606 } else {
2607 warning "Status wrapper failed to build."
2608 }
2609 }
2610 set gdb_wrapper_initialized 1
f6838f81 2611 set gdb_wrapper_target [current_target_name]
f1c47eb2
MS
2612}
2613
f747e0ce
PA
2614# Some targets need to always link a special object in. Save its path here.
2615global gdb_saved_set_unbuffered_mode_obj
2616set gdb_saved_set_unbuffered_mode_obj ""
2617
c906108c 2618proc gdb_compile {source dest type options} {
4ec70201
PA
2619 global GDB_TESTCASE_OPTIONS
2620 global gdb_wrapper_file
2621 global gdb_wrapper_flags
2622 global gdb_wrapper_initialized
f747e0ce
PA
2623 global srcdir
2624 global objdir
2625 global gdb_saved_set_unbuffered_mode_obj
c906108c 2626
695e2681
MK
2627 set outdir [file dirname $dest]
2628
2629 # Add platform-specific options if a shared library was specified using
2630 # "shlib=librarypath" in OPTIONS.
2631 set new_options ""
2632 set shlib_found 0
bdf7534a 2633 set shlib_load 0
695e2681 2634 foreach opt $options {
57bf0e56
DJ
2635 if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2636 if [test_compiler_info "xlc-*"] {
93f02886
DJ
2637 # IBM xlc compiler doesn't accept shared library named other
2638 # than .so: use "-Wl," to bypass this
2639 lappend source "-Wl,$shlib_name"
2640 } elseif { ([istarget "*-*-mingw*"]
2641 || [istarget *-*-cygwin*]
2642 || [istarget *-*-pe*])} {
2643 lappend source "${shlib_name}.a"
57bf0e56
DJ
2644 } else {
2645 lappend source $shlib_name
2646 }
0413d738 2647 if { $shlib_found == 0 } {
57bf0e56 2648 set shlib_found 1
0413d738
PA
2649 if { ([istarget "*-*-mingw*"]
2650 || [istarget *-*-cygwin*]) } {
bb61102d 2651 lappend new_options "additional_flags=-Wl,--enable-auto-import"
0413d738 2652 }
57bf0e56 2653 }
b0f4b84b 2654 } elseif { $opt == "shlib_load" } {
bdf7534a 2655 set shlib_load 1
57bf0e56
DJ
2656 } else {
2657 lappend new_options $opt
2658 }
695e2681 2659 }
bdf7534a
NF
2660
2661 # We typically link to shared libraries using an absolute path, and
2662 # that's how they are found at runtime. If we are going to
2663 # dynamically load one by basename, we must specify rpath. If we
2664 # are using a remote host, DejaGNU will link to the shared library
2665 # using a relative path, so again we must specify an rpath.
31f83dc5 2666 if { $shlib_load || ($shlib_found && [is_remote target]) } {
bdf7534a
NF
2667 if { ([istarget "*-*-mingw*"]
2668 || [istarget *-*-cygwin*]
2669 || [istarget *-*-pe*]
bdf7534a
NF
2670 || [istarget hppa*-*-hpux*])} {
2671 # Do not need anything.
b2a6bdeb 2672 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
d8b34041 2673 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
759f0f0b
PA
2674 } elseif { [istarget arm*-*-symbianelf*] } {
2675 if { $shlib_load } {
2676 lappend new_options "libs=-ldl"
2677 }
bdf7534a
NF
2678 } else {
2679 if { $shlib_load } {
2680 lappend new_options "libs=-ldl"
2681 }
d8b34041 2682 lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
bdf7534a
NF
2683 }
2684 }
695e2681 2685 set options $new_options
57bf0e56 2686
c906108c
SS
2687 if [target_info exists is_vxworks] {
2688 set options2 { "additional_flags=-Dvxworks" }
c906108c
SS
2689 set options [concat $options2 $options]
2690 }
2691 if [info exists GDB_TESTCASE_OPTIONS] {
4ec70201 2692 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
c906108c
SS
2693 }
2694 verbose "options are $options"
2695 verbose "source is $source $dest $type $options"
2696
f1c47eb2
MS
2697 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
2698
2699 if {[target_info exists needs_status_wrapper] && \
2700 [target_info needs_status_wrapper] != "0" && \
2701 [info exists gdb_wrapper_file]} {
2702 lappend options "libs=${gdb_wrapper_file}"
2703 lappend options "ldflags=${gdb_wrapper_flags}"
2704 }
2705
fc91c6c2
PB
2706 # Replace the "nowarnings" option with the appropriate additional_flags
2707 # to disable compiler warnings.
2708 set nowarnings [lsearch -exact $options nowarnings]
2709 if {$nowarnings != -1} {
2710 if [target_info exists gdb,nowarnings_flag] {
2711 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
2712 } else {
2713 set flag "additional_flags=-w"
2714 }
2715 set options [lreplace $options $nowarnings $nowarnings $flag]
2716 }
2717
f747e0ce
PA
2718 if { $type == "executable" } {
2719 if { ([istarget "*-*-mingw*"]
56643c5e 2720 || [istarget "*-*-*djgpp"]
f747e0ce
PA
2721 || [istarget "*-*-cygwin*"])} {
2722 # Force output to unbuffered mode, by linking in an object file
2723 # with a global contructor that calls setvbuf.
2724 #
2725 # Compile the special object seperatelly for two reasons:
2726 # 1) Insulate it from $options.
2727 # 2) Avoid compiling it for every gdb_compile invocation,
2728 # which is time consuming, especially if we're remote
2729 # host testing.
2730 #
2731 if { $gdb_saved_set_unbuffered_mode_obj == "" } {
2732 verbose "compiling gdb_saved_set_unbuffered_obj"
2733 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
2734 set unbuf_obj ${objdir}/set_unbuffered_mode.o
2735
2736 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
2737 if { $result != "" } {
2738 return $result
2739 }
f6dc277e
YQ
2740 if {[is_remote host]} {
2741 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
2742 } else {
2743 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
2744 }
f747e0ce
PA
2745 # Link a copy of the output object, because the
2746 # original may be automatically deleted.
f6dc277e 2747 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
f747e0ce
PA
2748 } else {
2749 verbose "gdb_saved_set_unbuffered_obj already compiled"
2750 }
2751
2752 # Rely on the internal knowledge that the global ctors are ran in
2753 # reverse link order. In that case, we can use ldflags to
2754 # avoid copying the object file to the host multiple
2755 # times.
ace5c364
PM
2756 # This object can only be added if standard libraries are
2757 # used. Thus, we need to disable it if -nostdlib option is used
2758 if {[lsearch -regexp $options "-nostdlib"] < 0 } {
2759 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
2760 }
f747e0ce
PA
2761 }
2762 }
2763
4ec70201 2764 set result [target_compile $source $dest $type $options]
93f02886
DJ
2765
2766 # Prune uninteresting compiler (and linker) output.
2767 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
2768
4ec70201
PA
2769 regsub "\[\r\n\]*$" "$result" "" result
2770 regsub "^\[\r\n\]*" "$result" "" result
ec3c07fc
NS
2771
2772 if {[lsearch $options quiet] < 0} {
2773 # We shall update this on a per language basis, to avoid
2774 # changing the entire testsuite in one go.
2775 if {[lsearch $options f77] >= 0} {
2776 gdb_compile_test $source $result
2777 } elseif { $result != "" } {
2778 clone_output "gdb compile failed, $result"
2779 }
c906108c 2780 }
ae59b1da 2781 return $result
c906108c
SS
2782}
2783
b6ff0e81
JB
2784
2785# This is just like gdb_compile, above, except that it tries compiling
2786# against several different thread libraries, to see which one this
2787# system has.
2788proc gdb_compile_pthreads {source dest type options} {
0ae67eb3 2789 set built_binfile 0
b6ff0e81 2790 set why_msg "unrecognized error"
24486cb7 2791 foreach lib {-lpthreads -lpthread -lthread ""} {
b6ff0e81
JB
2792 # This kind of wipes out whatever libs the caller may have
2793 # set. Or maybe theirs will override ours. How infelicitous.
b5ab8ff3 2794 set options_with_lib [concat $options [list libs=$lib quiet]]
b6ff0e81
JB
2795 set ccout [gdb_compile $source $dest $type $options_with_lib]
2796 switch -regexp -- $ccout {
2797 ".*no posix threads support.*" {
2798 set why_msg "missing threads include file"
2799 break
2800 }
2801 ".*cannot open -lpthread.*" {
2802 set why_msg "missing runtime threads library"
2803 }
2804 ".*Can't find library for -lpthread.*" {
2805 set why_msg "missing runtime threads library"
2806 }
2807 {^$} {
2808 pass "successfully compiled posix threads test case"
2809 set built_binfile 1
2810 break
2811 }
2812 }
2813 }
0ae67eb3 2814 if {!$built_binfile} {
b6ff0e81
JB
2815 unsupported "Couldn't compile $source: ${why_msg}"
2816 return -1
2817 }
57bf0e56
DJ
2818}
2819
409d8f48 2820# Build a shared library from SOURCES.
57bf0e56
DJ
2821
2822proc gdb_compile_shlib {sources dest options} {
2823 set obj_options $options
2824
409d8f48
AB
2825 set info_options ""
2826 if { [lsearch -exact $options "c++"] >= 0 } {
2827 set info_options "c++"
2828 }
2829 if [get_compiler_info ${info_options}] {
2830 return -1
2831 }
2832
57bf0e56
DJ
2833 switch -glob [test_compiler_info] {
2834 "xlc-*" {
2835 lappend obj_options "additional_flags=-qpic"
2836 }
2837 "gcc-*" {
2838 if { !([istarget "powerpc*-*-aix*"]
227c54da
DJ
2839 || [istarget "rs6000*-*-aix*"]
2840 || [istarget "*-*-cygwin*"]
2841 || [istarget "*-*-mingw*"]
2842 || [istarget "*-*-pe*"]) } {
57bf0e56
DJ
2843 lappend obj_options "additional_flags=-fpic"
2844 }
2845 }
2846 default {
2847 switch -glob [istarget] {
2848 "hppa*-hp-hpux*" {
2849 lappend obj_options "additional_flags=+z"
2850 }
2851 "mips-sgi-irix*" {
2852 # Disable SGI compiler's implicit -Dsgi
2853 lappend obj_options "additional_flags=-Usgi"
2854 }
2855 default {
2856 # don't know what the compiler is...
2857 }
2858 }
2859 }
2860 }
2861
2862 set outdir [file dirname $dest]
2863 set objects ""
2864 foreach source $sources {
2865 set sourcebase [file tail $source]
2866 if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
2867 return -1
2868 }
2869 lappend objects ${outdir}/${sourcebase}.o
2870 }
2871
2872 if [istarget "hppa*-*-hpux*"] {
2873 remote_exec build "ld -b ${objects} -o ${dest}"
2874 } else {
2875 set link_options $options
2876 if [test_compiler_info "xlc-*"] {
2877 lappend link_options "additional_flags=-qmkshrobj"
2878 } else {
2879 lappend link_options "additional_flags=-shared"
93f02886
DJ
2880
2881 if { ([istarget "*-*-mingw*"]
2882 || [istarget *-*-cygwin*]
a075c3e5
YQ
2883 || [istarget *-*-pe*]) } {
2884 if { [is_remote host] } {
2885 set name [file tail ${dest}]
2886 } else {
2887 set name ${dest}
2888 }
2889 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
31f83dc5
UW
2890 } elseif [is_remote target] {
2891 # By default, we do not set the soname. This causes the linker
2892 # on ELF systems to create a DT_NEEDED entry in the executable
2893 # refering to the full path name of the library. This is a
2894 # problem in remote testing if the library is in a different
2895 # directory there. To fix this, we set a soname of just the
2896 # base filename for the library, and add an appropriate -rpath
2897 # to the main executable (in gdb_compile).
2898 set destbase [file tail $dest]
2899 lappend link_options "additional_flags=-Wl,-soname,$destbase"
2900 }
57bf0e56
DJ
2901 }
2902 if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
2903 return -1
2904 }
a075c3e5
YQ
2905 if { [is_remote host]
2906 && ([istarget "*-*-mingw*"]
2907 || [istarget *-*-cygwin*]
2908 || [istarget *-*-pe*]) } {
2909 set dest_tail_name [file tail ${dest}]
2910 remote_upload host $dest_tail_name.a ${dest}.a
2911 remote_file host delete $dest_tail_name.a
2912 }
57bf0e56 2913 }
a075c3e5 2914 return ""
b6ff0e81
JB
2915}
2916
756d88a7
UW
2917# This is just like gdb_compile_shlib, above, except that it tries compiling
2918# against several different thread libraries, to see which one this
2919# system has.
2920proc gdb_compile_shlib_pthreads {sources dest options} {
2921 set built_binfile 0
2922 set why_msg "unrecognized error"
2923 foreach lib {-lpthreads -lpthread -lthread ""} {
2924 # This kind of wipes out whatever libs the caller may have
2925 # set. Or maybe theirs will override ours. How infelicitous.
2926 set options_with_lib [concat $options [list libs=$lib quiet]]
2927 set ccout [gdb_compile_shlib $sources $dest $options_with_lib]
2928 switch -regexp -- $ccout {
2929 ".*no posix threads support.*" {
2930 set why_msg "missing threads include file"
2931 break
2932 }
2933 ".*cannot open -lpthread.*" {
2934 set why_msg "missing runtime threads library"
2935 }
2936 ".*Can't find library for -lpthread.*" {
2937 set why_msg "missing runtime threads library"
2938 }
2939 {^$} {
2940 pass "successfully compiled posix threads test case"
2941 set built_binfile 1
2942 break
2943 }
2944 }
2945 }
2946 if {!$built_binfile} {
2947 unsupported "Couldn't compile $sources: ${why_msg}"
2948 return -1
2949 }
2950}
2951
130cacce
AF
2952# This is just like gdb_compile_pthreads, above, except that we always add the
2953# objc library for compiling Objective-C programs
2954proc gdb_compile_objc {source dest type options} {
2955 set built_binfile 0
2956 set why_msg "unrecognized error"
2957 foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
2958 # This kind of wipes out whatever libs the caller may have
2959 # set. Or maybe theirs will override ours. How infelicitous.
2960 if { $lib == "solaris" } {
2961 set lib "-lpthread -lposix4"
2962 }
2963 if { $lib != "-lobjc" } {
2964 set lib "-lobjc $lib"
2965 }
2966 set options_with_lib [concat $options [list libs=$lib quiet]]
2967 set ccout [gdb_compile $source $dest $type $options_with_lib]
2968 switch -regexp -- $ccout {
2969 ".*no posix threads support.*" {
2970 set why_msg "missing threads include file"
2971 break
2972 }
2973 ".*cannot open -lpthread.*" {
2974 set why_msg "missing runtime threads library"
2975 }
2976 ".*Can't find library for -lpthread.*" {
2977 set why_msg "missing runtime threads library"
2978 }
2979 {^$} {
2980 pass "successfully compiled objc with posix threads test case"
2981 set built_binfile 1
2982 break
2983 }
2984 }
2985 }
2986 if {!$built_binfile} {
2987 unsupported "Couldn't compile $source: ${why_msg}"
2988 return -1
2989 }
2990}
2991
c906108c 2992proc send_gdb { string } {
4ec70201 2993 global suppress_flag
c906108c 2994 if { $suppress_flag } {
ae59b1da 2995 return "suppressed"
c906108c 2996 }
ae59b1da 2997 return [remote_send host "$string"]
c906108c
SS
2998}
2999
3000#
3001#
3002
3003proc gdb_expect { args } {
3004 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
4ec70201
PA
3005 set atimeout [lindex $args 0]
3006 set expcode [list [lindex $args 1]]
c906108c 3007 } else {
4ec70201 3008 set expcode $args
2f34202f
MR
3009 }
3010
4ec70201 3011 upvar timeout timeout
2f34202f
MR
3012
3013 if [target_info exists gdb,timeout] {
3014 if [info exists timeout] {
3015 if { $timeout < [target_info gdb,timeout] } {
4ec70201 3016 set gtimeout [target_info gdb,timeout]
2f34202f 3017 } else {
4ec70201 3018 set gtimeout $timeout
c906108c 3019 }
2f34202f 3020 } else {
4ec70201 3021 set gtimeout [target_info gdb,timeout]
c906108c 3022 }
2f34202f 3023 }
c906108c 3024
2f34202f 3025 if ![info exists gtimeout] {
4ec70201 3026 global timeout
2f34202f 3027 if [info exists timeout] {
4ec70201 3028 set gtimeout $timeout
2f34202f
MR
3029 }
3030 }
3031
3032 if [info exists atimeout] {
3033 if { ![info exists gtimeout] || $gtimeout < $atimeout } {
4ec70201 3034 set gtimeout $atimeout
2f34202f
MR
3035 }
3036 } else {
c906108c 3037 if ![info exists gtimeout] {
2f34202f 3038 # Eeeeew.
4ec70201 3039 set gtimeout 60
c906108c
SS
3040 }
3041 }
2f34202f 3042
4ec70201
PA
3043 global suppress_flag
3044 global remote_suppress_flag
c906108c 3045 if [info exists remote_suppress_flag] {
4ec70201 3046 set old_val $remote_suppress_flag
c906108c
SS
3047 }
3048 if [info exists suppress_flag] {
3049 if { $suppress_flag } {
4ec70201 3050 set remote_suppress_flag 1
c906108c
SS
3051 }
3052 }
a0b3c4fd 3053 set code [catch \
4ec70201 3054 {uplevel remote_expect host $gtimeout $expcode} string]
c906108c 3055 if [info exists old_val] {
4ec70201 3056 set remote_suppress_flag $old_val
c906108c
SS
3057 } else {
3058 if [info exists remote_suppress_flag] {
4ec70201 3059 unset remote_suppress_flag
c906108c
SS
3060 }
3061 }
3062
3063 if {$code == 1} {
4ec70201 3064 global errorInfo errorCode
c906108c
SS
3065
3066 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
d6d7a51a 3067 } else {
c906108c
SS
3068 return -code $code $string
3069 }
3070}
3071
5fa290c1 3072# gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
085dd6e6
JM
3073#
3074# Check for long sequence of output by parts.
5fa290c1 3075# TEST: is the test message to be printed with the test success/fail.
085dd6e6
JM
3076# SENTINEL: Is the terminal pattern indicating that output has finished.
3077# LIST: is the sequence of outputs to match.
3078# If the sentinel is recognized early, it is considered an error.
3079#
11cf8741
JM
3080# Returns:
3081# 1 if the test failed,
3082# 0 if the test passes,
3083# -1 if there was an internal error.
5fa290c1 3084
c2d11a7d 3085proc gdb_expect_list {test sentinel list} {
085dd6e6 3086 global gdb_prompt
11cf8741 3087 global suppress_flag
085dd6e6 3088 set index 0
43ff13b4 3089 set ok 1
11cf8741
JM
3090 if { $suppress_flag } {
3091 set ok 0
a20ce2c3 3092 unresolved "${test}"
11cf8741 3093 }
43ff13b4 3094 while { ${index} < [llength ${list}] } {
085dd6e6
JM
3095 set pattern [lindex ${list} ${index}]
3096 set index [expr ${index} + 1]
6b0ecdc2 3097 verbose -log "gdb_expect_list pattern: /$pattern/" 2
085dd6e6 3098 if { ${index} == [llength ${list}] } {
43ff13b4
JM
3099 if { ${ok} } {
3100 gdb_expect {
c2d11a7d 3101 -re "${pattern}${sentinel}" {
a20ce2c3 3102 # pass "${test}, pattern ${index} + sentinel"
c2d11a7d
JM
3103 }
3104 -re "${sentinel}" {
a20ce2c3 3105 fail "${test} (pattern ${index} + sentinel)"
c2d11a7d 3106 set ok 0
43ff13b4 3107 }
5c5455dc
AC
3108 -re ".*A problem internal to GDB has been detected" {
3109 fail "${test} (GDB internal error)"
3110 set ok 0
3111 gdb_internal_error_resync
3112 }
43ff13b4 3113 timeout {
a20ce2c3 3114 fail "${test} (pattern ${index} + sentinel) (timeout)"
43ff13b4
JM
3115 set ok 0
3116 }
085dd6e6 3117 }
43ff13b4 3118 } else {
a20ce2c3 3119 # unresolved "${test}, pattern ${index} + sentinel"
085dd6e6
JM
3120 }
3121 } else {
43ff13b4
JM
3122 if { ${ok} } {
3123 gdb_expect {
3124 -re "${pattern}" {
a20ce2c3 3125 # pass "${test}, pattern ${index}"
43ff13b4 3126 }
c2d11a7d 3127 -re "${sentinel}" {
a20ce2c3 3128 fail "${test} (pattern ${index})"
43ff13b4
JM
3129 set ok 0
3130 }
5c5455dc
AC
3131 -re ".*A problem internal to GDB has been detected" {
3132 fail "${test} (GDB internal error)"
3133 set ok 0
3134 gdb_internal_error_resync
3135 }
43ff13b4 3136 timeout {
a20ce2c3 3137 fail "${test} (pattern ${index}) (timeout)"
43ff13b4
JM
3138 set ok 0
3139 }
085dd6e6 3140 }
43ff13b4 3141 } else {
a20ce2c3 3142 # unresolved "${test}, pattern ${index}"
085dd6e6
JM
3143 }
3144 }
3145 }
11cf8741 3146 if { ${ok} } {
a20ce2c3 3147 pass "${test}"
11cf8741
JM
3148 return 0
3149 } else {
3150 return 1
3151 }
085dd6e6
JM
3152}
3153
3154#
3155#
c906108c 3156proc gdb_suppress_entire_file { reason } {
4ec70201 3157 global suppress_flag
c906108c 3158
4ec70201
PA
3159 warning "$reason\n"
3160 set suppress_flag -1
c906108c
SS
3161}
3162
3163#
3164# Set suppress_flag, which will cause all subsequent calls to send_gdb and
3165# gdb_expect to fail immediately (until the next call to
3166# gdb_stop_suppressing_tests).
3167#
3168proc gdb_suppress_tests { args } {
4ec70201 3169 global suppress_flag
c906108c
SS
3170
3171 return; # fnf - disable pending review of results where
3172 # testsuite ran better without this
4ec70201 3173 incr suppress_flag
c906108c
SS
3174
3175 if { $suppress_flag == 1 } {
3176 if { [llength $args] > 0 } {
4ec70201 3177 warning "[lindex $args 0]\n"
c906108c 3178 } else {
4ec70201 3179 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
c906108c
SS
3180 }
3181 }
3182}
3183
3184#
3185# Clear suppress_flag.
3186#
3187proc gdb_stop_suppressing_tests { } {
4ec70201 3188 global suppress_flag
c906108c
SS
3189
3190 if [info exists suppress_flag] {
3191 if { $suppress_flag > 0 } {
4ec70201
PA
3192 set suppress_flag 0
3193 clone_output "Tests restarted.\n"
c906108c
SS
3194 }
3195 } else {
4ec70201 3196 set suppress_flag 0
c906108c
SS
3197 }
3198}
3199
3200proc gdb_clear_suppressed { } {
4ec70201 3201 global suppress_flag
c906108c 3202
4ec70201 3203 set suppress_flag 0
c906108c
SS
3204}
3205
3206proc gdb_start { } {
3207 default_gdb_start
3208}
3209
3210proc gdb_exit { } {
3211 catch default_gdb_exit
3212}
3213
e63b55d1
NS
3214#
3215# gdb_load_cmd -- load a file into the debugger.
3216# ARGS - additional args to load command.
3217# return a -1 if anything goes wrong.
3218#
3219proc gdb_load_cmd { args } {
3220 global gdb_prompt
3221
3222 if [target_info exists gdb_load_timeout] {
3223 set loadtimeout [target_info gdb_load_timeout]
3224 } else {
3225 set loadtimeout 1600
3226 }
3227 send_gdb "load $args\n"
e91528f0 3228 verbose "Timeout is now $loadtimeout seconds" 2
e63b55d1
NS
3229 gdb_expect $loadtimeout {
3230 -re "Loading section\[^\r\]*\r\n" {
3231 exp_continue
3232 }
3233 -re "Start address\[\r\]*\r\n" {
3234 exp_continue
3235 }
3236 -re "Transfer rate\[\r\]*\r\n" {
3237 exp_continue
3238 }
3239 -re "Memory access error\[^\r\]*\r\n" {
3240 perror "Failed to load program"
3241 return -1
3242 }
3243 -re "$gdb_prompt $" {
3244 return 0
3245 }
3246 -re "(.*)\r\n$gdb_prompt " {
3247 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
3248 return -1
3249 }
3250 timeout {
c4b347c7 3251 perror "Timed out trying to load $args."
e63b55d1
NS
3252 return -1
3253 }
3254 }
3255 return -1
3256}
3257
2d338fa9
TT
3258# Invoke "gcore". CORE is the name of the core file to write. TEST
3259# is the name of the test case. This will return 1 if the core file
3260# was created, 0 otherwise. If this fails to make a core file because
3261# this configuration of gdb does not support making core files, it
3262# will call "unsupported", not "fail". However, if this fails to make
3263# a core file for some other reason, then it will call "fail".
3264
3265proc gdb_gcore_cmd {core test} {
3266 global gdb_prompt
3267
3268 set result 0
3269 gdb_test_multiple "gcore $core" $test {
3270 -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" {
3271 pass $test
3272 set result 1
3273 }
3274
3275 -re "Undefined command.*$gdb_prompt $" {
3276 unsupported $test
3277 verbose -log "'gcore' command undefined in gdb_gcore_cmd"
3278 }
3279
bbe769cc 3280 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
2d338fa9
TT
3281 unsupported $test
3282 }
3283 }
3284
3285 return $result
3286}
3287
fac51dd9
DE
3288# Load core file CORE. TEST is the name of the test case.
3289# This will record a pass/fail for loading the core file.
3290# Returns:
3291# 1 - core file is successfully loaded
3292# 0 - core file loaded but has a non fatal error
3293# -1 - core file failed to load
3294
3295proc gdb_core_cmd { core test } {
3296 global gdb_prompt
3297
4f424bb1 3298 gdb_test_multiple "core $core" "$test" {
fac51dd9
DE
3299 -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" {
3300 exp_continue
3301 }
3302 -re " is not a core dump:.*\r\n$gdb_prompt $" {
4f424bb1 3303 fail "$test (bad file format)"
fac51dd9
DE
3304 return -1
3305 }
3306 -re ": No such file or directory.*\r\n$gdb_prompt $" {
4f424bb1 3307 fail "$test (file not found)"
fac51dd9
DE
3308 return -1
3309 }
3310 -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" {
4f424bb1 3311 fail "$test (incomplete note section)"
fac51dd9
DE
3312 return 0
3313 }
3314 -re "Core was generated by .*\r\n$gdb_prompt $" {
4f424bb1 3315 pass "$test"
fac51dd9
DE
3316 return 1
3317 }
3318 -re ".*$gdb_prompt $" {
4f424bb1 3319 fail "$test"
fac51dd9
DE
3320 return -1
3321 }
3322 timeout {
4f424bb1 3323 fail "$test (timeout)"
fac51dd9
DE
3324 return -1
3325 }
3326 }
3327 fail "unsupported output from 'core' command"
3328 return -1
3329}
3330
759f0f0b
PA
3331# Return the filename to download to the target and load on the target
3332# for this shared library. Normally just LIBNAME, unless shared libraries
3333# for this target have separate link and load images.
3334
3335proc shlib_target_file { libname } {
3336 return $libname
3337}
3338
3339# Return the filename GDB will load symbols from when debugging this
3340# shared library. Normally just LIBNAME, unless shared libraries for
3341# this target have separate link and load images.
3342
3343proc shlib_symbol_file { libname } {
3344 return $libname
3345}
3346
56744f0a
JJ
3347# Return the filename to download to the target and load for this
3348# executable. Normally just BINFILE unless it is renamed to something
3349# else for this target.
3350
3351proc exec_target_file { binfile } {
3352 return $binfile
3353}
3354
3355# Return the filename GDB will load symbols from when debugging this
3356# executable. Normally just BINFILE unless executables for this target
3357# have separate files for symbols.
3358
3359proc exec_symbol_file { binfile } {
3360 return $binfile
3361}
3362
3363# Rename the executable file. Normally this is just BINFILE1 being renamed
3364# to BINFILE2, but some targets require multiple binary files.
3365proc gdb_rename_execfile { binfile1 binfile2 } {
faf067f1
JK
3366 file rename -force [exec_target_file ${binfile1}] \
3367 [exec_target_file ${binfile2}]
56744f0a 3368 if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } {
faf067f1
JK
3369 file rename -force [exec_symbol_file ${binfile1}] \
3370 [exec_symbol_file ${binfile2}]
56744f0a
JJ
3371 }
3372}
3373
3374# "Touch" the executable file to update the date. Normally this is just
3375# BINFILE, but some targets require multiple files.
3376proc gdb_touch_execfile { binfile } {
faf067f1
JK
3377 set time [clock seconds]
3378 file mtime [exec_target_file ${binfile}] $time
56744f0a 3379 if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } {
faf067f1 3380 file mtime [exec_symbol_file ${binfile}] $time
56744f0a
JJ
3381 }
3382}
3383
44ee8174
TT
3384# Like remote_download but provides a gdb-specific behavior. If DEST
3385# is "host", and the host is not remote, and TOFILE is not specified,
3386# then the [file tail] of FROMFILE is passed through
3387# standard_output_file to compute the destination.
3388
3389proc gdb_remote_download {dest fromfile {tofile {}}} {
3390 if {$dest == "host" && ![is_remote host] && $tofile == ""} {
3391 set tofile [standard_output_file [file tail $fromfile]]
3392 }
ce4ea2bb
YQ
3393
3394 if { $tofile == "" } {
3395 return [remote_download $dest $fromfile]
3396 } else {
3397 return [remote_download $dest $fromfile $tofile]
3398 }
44ee8174
TT
3399}
3400
93f02886
DJ
3401# gdb_download
3402#
3403# Copy a file to the remote target and return its target filename.
3404# Schedule the file to be deleted at the end of this test.
3405
3406proc gdb_download { filename } {
3407 global cleanfiles
3408
3409 set destname [remote_download target $filename]
3410 lappend cleanfiles $destname
3411 return $destname
3412}
3413
3414# gdb_load_shlibs LIB...
3415#
3416# Copy the listed libraries to the target.
3417
3418proc gdb_load_shlibs { args } {
3419 if {![is_remote target]} {
3420 return
3421 }
3422
3423 foreach file $args {
759f0f0b 3424 gdb_download [shlib_target_file $file]
93f02886
DJ
3425 }
3426
3427 # Even if the target supplies full paths for shared libraries,
3428 # they may not be paths for this system.
3429 gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
3430}
3431
c906108c
SS
3432#
3433# gdb_load -- load a file into the debugger.
2db8e78e 3434# Many files in config/*.exp override this procedure.
c906108c
SS
3435#
3436proc gdb_load { arg } {
3437 return [gdb_file_cmd $arg]
3438}
3439
b741e217
DJ
3440# gdb_reload -- load a file into the target. Called before "running",
3441# either the first time or after already starting the program once,
3442# for remote targets. Most files that override gdb_load should now
3443# override this instead.
3444
3445proc gdb_reload { } {
3446 # For the benefit of existing configurations, default to gdb_load.
3447 # Specifying no file defaults to the executable currently being
3448 # debugged.
3449 return [gdb_load ""]
3450}
3451
c906108c
SS
3452proc gdb_continue { function } {
3453 global decimal
3454
ae59b1da 3455 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
c906108c
SS
3456}
3457
3458proc default_gdb_init { args } {
277254ba 3459 global gdb_wrapper_initialized
f6838f81 3460 global gdb_wrapper_target
0a6d0306 3461 global gdb_test_file_name
93f02886 3462 global cleanfiles
277254ba 3463
93f02886
DJ
3464 set cleanfiles {}
3465
4ec70201 3466 gdb_clear_suppressed
c906108c 3467
0a6d0306
TT
3468 set gdb_test_file_name [file rootname [file tail [lindex $args 0]]]
3469
277254ba
MS
3470 # Make sure that the wrapper is rebuilt
3471 # with the appropriate multilib option.
f6838f81
DJ
3472 if { $gdb_wrapper_target != [current_target_name] } {
3473 set gdb_wrapper_initialized 0
3474 }
277254ba 3475
7b433602
JB
3476 # Unlike most tests, we have a small number of tests that generate
3477 # a very large amount of output. We therefore increase the expect
3478 # buffer size to be able to contain the entire test output.
3479 match_max -d 30000
8d417781
PM
3480 # Also set this value for the currently running GDB.
3481 match_max [match_max -d]
c906108c
SS
3482
3483 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
3484 if { [llength $args] > 0 } {
3485 global pf_prefix
3486
4ec70201 3487 set file [lindex $args 0]
c906108c 3488
4ec70201 3489 set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:"
c906108c 3490 }
4ec70201 3491 global gdb_prompt
c906108c 3492 if [target_info exists gdb_prompt] {
4ec70201 3493 set gdb_prompt [target_info gdb_prompt]
c906108c
SS
3494 } else {
3495 set gdb_prompt "\\(gdb\\)"
3496 }
e11ac3a3
JK
3497 global use_gdb_stub
3498 if [info exists use_gdb_stub] {
3499 unset use_gdb_stub
3500 }
c906108c
SS
3501}
3502
0a6d0306 3503# Turn BASENAME into a full file name in the standard output
8a3e1f8d
TT
3504# directory. It is ok if BASENAME is the empty string; in this case
3505# the directory is returned.
0a6d0306
TT
3506
3507proc standard_output_file {basename} {
5e92f71a 3508 global objdir subdir gdb_test_file_name GDB_PARALLEL
0a6d0306 3509
5e92f71a
TT
3510 if {[info exists GDB_PARALLEL]} {
3511 set dir [file join $objdir outputs $subdir $gdb_test_file_name]
3512 file mkdir $dir
3513 return [file join $dir $basename]
3514 } else {
3515 return [file join $objdir $subdir $basename]
3516 }
0a6d0306
TT
3517}
3518
4e234898
TT
3519# Return the name of a file in our standard temporary directory.
3520
3521proc standard_temp_file {basename} {
5e92f71a
TT
3522 global objdir GDB_PARALLEL
3523
3524 if {[info exists GDB_PARALLEL]} {
3525 return [file join $objdir temp $basename]
3526 } else {
3527 return $basename
3528 }
4e234898
TT
3529}
3530
0a6d0306
TT
3531# Set 'testfile', 'srcfile', and 'binfile'.
3532#
3533# ARGS is a list of source file specifications.
3534# Without any arguments, the .exp file's base name is used to
3535# compute the source file name. The ".c" extension is added in this case.
3536# If ARGS is not empty, each entry is a source file specification.
3537# If the specification starts with a ".", it is treated as a suffix
3538# to append to the .exp file's base name.
3539# If the specification is the empty string, it is treated as if it
3540# were ".c".
3541# Otherwise it is a file name.
3542# The first file in the list is used to set the 'srcfile' global.
3543# Each subsequent name is used to set 'srcfile2', 'srcfile3', etc.
3544#
3545# Most tests should call this without arguments.
3546#
3547# If a completely different binary file name is needed, then it
3548# should be handled in the .exp file with a suitable comment.
3549
3550proc standard_testfile {args} {
3551 global gdb_test_file_name
93c0ef37 3552 global subdir
686f09d0 3553 global gdb_test_file_last_vars
0a6d0306
TT
3554
3555 # Outputs.
3556 global testfile binfile
3557
3558 set testfile $gdb_test_file_name
3559 set binfile [standard_output_file ${testfile}]
3560
3561 if {[llength $args] == 0} {
3562 set args .c
3563 }
3564
686f09d0
TT
3565 # Unset our previous output variables.
3566 # This can help catch hidden bugs.
3567 if {[info exists gdb_test_file_last_vars]} {
3568 foreach varname $gdb_test_file_last_vars {
3569 global $varname
3570 catch {unset $varname}
3571 }
3572 }
3573 # 'executable' is often set by tests.
3574 set gdb_test_file_last_vars {executable}
3575
0a6d0306
TT
3576 set suffix ""
3577 foreach arg $args {
3578 set varname srcfile$suffix
3579 global $varname
3580
3581 # Handle an extension.
3582 if {$arg == ""} {
3583 set arg $testfile.c
3584 } elseif {[string range $arg 0 0] == "."} {
3585 set arg $testfile$arg
3586 }
3587
3588 set $varname $arg
686f09d0 3589 lappend gdb_test_file_last_vars $varname
0a6d0306
TT
3590
3591 if {$suffix == ""} {
3592 set suffix 2
3593 } else {
3594 incr suffix
3595 }
3596 }
3597}
3598
7b356089
JB
3599# The default timeout used when testing GDB commands. We want to use
3600# the same timeout as the default dejagnu timeout, unless the user has
3601# already provided a specific value (probably through a site.exp file).
3602global gdb_test_timeout
3603if ![info exists gdb_test_timeout] {
3604 set gdb_test_timeout $timeout
3605}
3606
47050449
JB
3607# A list of global variables that GDB testcases should not use.
3608# We try to prevent their use by monitoring write accesses and raising
3609# an error when that happens.
3610set banned_variables { bug_id prms_id }
3611
abcc4978
PA
3612# A list of procedures that GDB testcases should not use.
3613# We try to prevent their use by monitoring invocations and raising
3614# an error when that happens.
3615set banned_procedures { strace }
3616
41b2c92d
PM
3617# gdb_init is called by runtest at start, but also by several
3618# tests directly; gdb_finish is only called from within runtest after
3619# each test source execution.
3620# Placing several traces by repetitive calls to gdb_init leads
3621# to problems, as only one trace is removed in gdb_finish.
3622# To overcome this possible problem, we add a variable that records
abcc4978
PA
3623# if the banned variables and procedures are already traced.
3624set banned_traced 0
41b2c92d 3625
c906108c 3626proc gdb_init { args } {
7b356089
JB
3627 # Reset the timeout value to the default. This way, any testcase
3628 # that changes the timeout value without resetting it cannot affect
3629 # the timeout used in subsequent testcases.
3630 global gdb_test_timeout
3631 global timeout
3632 set timeout $gdb_test_timeout
3633
5e92f71a
TT
3634 # If GDB_INOTIFY is given, check for writes to '.'. This is a
3635 # debugging tool to help confirm that the test suite is
3636 # parallel-safe. You need "inotifywait" from the
3637 # inotify-tools package to use this.
3638 global GDB_INOTIFY inotify_pid
3639 if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} {
3640 global outdir tool inotify_log_file
3641
3642 set exclusions {outputs temp gdb[.](log|sum) cache}
3643 set exclusion_re ([join $exclusions |])
3644
3645 set inotify_log_file [standard_temp_file inotify.out]
3646 set inotify_pid [exec inotifywait -r -m -e move,create,delete . \
3647 --exclude $exclusion_re \
3648 |& tee -a $outdir/$tool.log $inotify_log_file &]
3649
3650 # Wait for the watches; hopefully this is long enough.
3651 sleep 2
3652
3653 # Clear the log so that we don't emit a warning the first time
3654 # we check it.
3655 set fd [open $inotify_log_file w]
3656 close $fd
3657 }
3658
abcc4978
PA
3659 # Block writes to all banned variables, and invocation of all
3660 # banned procedures...
47050449 3661 global banned_variables
abcc4978
PA
3662 global banned_procedures
3663 global banned_traced
3664 if (!$banned_traced) {
41b2c92d
PM
3665 foreach banned_var $banned_variables {
3666 global "$banned_var"
3667 trace add variable "$banned_var" write error
3668 }
abcc4978
PA
3669 foreach banned_proc $banned_procedures {
3670 global "$banned_proc"
3671 trace add execution "$banned_proc" enter error
3672 }
3673 set banned_traced 1
47050449
JB
3674 }
3675
e7ab5e63
AB
3676 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
3677 # messages as expected.
c6f2ac43 3678 setenv LC_ALL C
e7ab5e63 3679 setenv LC_CTYPE C
c6f2ac43
PA
3680 setenv LANG C
3681
e7ab5e63
AB
3682 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
3683 # the test results. Even if /dev/null doesn't exist on the particular
3684 # platform, the readline library will use the default setting just by
3685 # failing to open the file. OTOH, opening /dev/null successfully will
3686 # also result in the default settings being used since nothing will be
3687 # read from this file.
3688 setenv INPUTRC "/dev/null"
3689
3690 # The gdb.base/readline.exp arrow key test relies on the standard VT100
3691 # bindings, so make sure that an appropriate terminal is selected.
3692 # The same bug doesn't show up if we use ^P / ^N instead.
3693 setenv TERM "vt100"
3694
3695 # Some tests (for example gdb.base/maint.exp) shell out from gdb to use
e4b8388f 3696 # grep. Clear GREP_OPTIONS to make the behavior predictable,
e7ab5e63
AB
3697 # especially having color output turned on can cause tests to fail.
3698 setenv GREP_OPTIONS ""
3699
03f2bd59
JK
3700 # Clear $gdbserver_reconnect_p.
3701 global gdbserver_reconnect_p
3702 set gdbserver_reconnect_p 1
3703 unset gdbserver_reconnect_p
3704
ae59b1da 3705 return [eval default_gdb_init $args]
c906108c
SS
3706}
3707
3708proc gdb_finish { } {
a35cfb40
MR
3709 global gdbserver_reconnect_p
3710 global gdb_prompt
93f02886
DJ
3711 global cleanfiles
3712
a35cfb40
MR
3713 # Give persistent gdbserver a chance to terminate before GDB is killed.
3714 if {[info exists gdbserver_reconnect_p] && $gdbserver_reconnect_p} {
3715 send_gdb "kill\n";
3716 gdb_expect 10 {
3717 -re "y or n" {
3718 send_gdb "y\n";
3719 exp_continue;
3720 }
3721 -re "$gdb_prompt $" {
3722 }
3723 }
3724 }
3725
93f02886
DJ
3726 # Exit first, so that the files are no longer in use.
3727 gdb_exit
3728
3729 if { [llength $cleanfiles] > 0 } {
3730 eval remote_file target delete $cleanfiles
3731 set cleanfiles {}
3732 }
47050449
JB
3733
3734 # Unblock write access to the banned variables. Dejagnu typically
3735 # resets some of them between testcases.
3736 global banned_variables
abcc4978
PA
3737 global banned_procedures
3738 global banned_traced
3739 if ($banned_traced) {
41b2c92d
PM
3740 foreach banned_var $banned_variables {
3741 global "$banned_var"
3742 trace remove variable "$banned_var" write error
3743 }
abcc4978
PA
3744 foreach banned_proc $banned_procedures {
3745 global "$banned_proc"
3746 trace remove execution "$banned_proc" enter error
3747 }
3748 set banned_traced 0
47050449 3749 }
c906108c
SS
3750}
3751
3752global debug_format
7a292a7a 3753set debug_format "unknown"
c906108c
SS
3754
3755# Run the gdb command "info source" and extract the debugging format
3756# information from the output and save it in debug_format.
3757
3758proc get_debug_format { } {
3759 global gdb_prompt
3760 global verbose
3761 global expect_out
3762 global debug_format
3763
3764 set debug_format "unknown"
3765 send_gdb "info source\n"
3766 gdb_expect 10 {
919d772c 3767 -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
c906108c
SS
3768 set debug_format $expect_out(1,string)
3769 verbose "debug format is $debug_format"
ae59b1da 3770 return 1
c906108c
SS
3771 }
3772 -re "No current source file.\r\n$gdb_prompt $" {
3773 perror "get_debug_format used when no current source file"
ae59b1da 3774 return 0
c906108c
SS
3775 }
3776 -re "$gdb_prompt $" {
3777 warning "couldn't check debug format (no valid response)."
ae59b1da 3778 return 1
c906108c
SS
3779 }
3780 timeout {
975531db 3781 warning "couldn't check debug format (timeout)."
ae59b1da 3782 return 1
c906108c
SS
3783 }
3784 }
3785}
3786
838ae6c4
JB
3787# Return true if FORMAT matches the debug format the current test was
3788# compiled with. FORMAT is a shell-style globbing pattern; it can use
3789# `*', `[...]', and so on.
3790#
3791# This function depends on variables set by `get_debug_format', above.
3792
3793proc test_debug_format {format} {
3794 global debug_format
3795
3796 return [expr [string match $format $debug_format] != 0]
3797}
3798
c906108c
SS
3799# Like setup_xfail, but takes the name of a debug format (DWARF 1,
3800# COFF, stabs, etc). If that format matches the format that the
3801# current test was compiled with, then the next test is expected to
3802# fail for any target. Returns 1 if the next test or set of tests is
3803# expected to fail, 0 otherwise (or if it is unknown). Must have
3804# previously called get_debug_format.
b55a4771 3805proc setup_xfail_format { format } {
4ec70201 3806 set ret [test_debug_format $format]
b55a4771 3807
838ae6c4 3808 if {$ret} then {
b55a4771
MS
3809 setup_xfail "*-*-*"
3810 }
ae59b1da 3811 return $ret
b55a4771 3812}
c906108c 3813
c6fee705
MC
3814# gdb_get_line_number TEXT [FILE]
3815#
3816# Search the source file FILE, and return the line number of the
0d7941a9 3817# first line containing TEXT. If no match is found, an error is thrown.
c6fee705
MC
3818#
3819# TEXT is a string literal, not a regular expression.
3820#
3821# The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
3822# specified, and does not start with "/", then it is assumed to be in
3823# "$srcdir/$subdir". This is awkward, and can be fixed in the future,
3824# by changing the callers and the interface at the same time.
3825# In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
3826# gdb.base/ena-dis-br.exp.
3827#
3828# Use this function to keep your test scripts independent of the
3829# exact line numbering of the source file. Don't write:
3830#
3831# send_gdb "break 20"
3832#
3833# This means that if anyone ever edits your test's source file,
3834# your test could break. Instead, put a comment like this on the
3835# source file line you want to break at:
3836#
3837# /* breakpoint spot: frotz.exp: test name */
3838#
3839# and then write, in your test script (which we assume is named
3840# frotz.exp):
3841#
3842# send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
3843#
3844# (Yes, Tcl knows how to handle the nested quotes and brackets.
3845# Try this:
3846# $ tclsh
3847# % puts "foo [lindex "bar baz" 1]"
3848# foo baz
3849# %
3850# Tcl is quite clever, for a little stringy language.)
3851#
3852# ===
3853#
3854# The previous implementation of this procedure used the gdb search command.
3855# This version is different:
3856#
3857# . It works with MI, and it also works when gdb is not running.
3858#
3859# . It operates on the build machine, not the host machine.
3860#
3861# . For now, this implementation fakes a current directory of
3862# $srcdir/$subdir to be compatible with the old implementation.
3863# This will go away eventually and some callers will need to
3864# be changed.
3865#
3866# . The TEXT argument is literal text and matches literally,
3867# not a regular expression as it was before.
3868#
3869# . State changes in gdb, such as changing the current file
3870# and setting $_, no longer happen.
3871#
3872# After a bit of time we can forget about the differences from the
3873# old implementation.
3874#
3875# --chastain 2004-08-05
3876
3877proc gdb_get_line_number { text { file "" } } {
3878 global srcdir
3879 global subdir
3880 global srcfile
c906108c 3881
c6fee705
MC
3882 if { "$file" == "" } then {
3883 set file "$srcfile"
3884 }
3885 if { ! [regexp "^/" "$file"] } then {
3886 set file "$srcdir/$subdir/$file"
c906108c
SS
3887 }
3888
c6fee705 3889 if { [ catch { set fd [open "$file"] } message ] } then {
0d7941a9 3890 error "$message"
c906108c 3891 }
c6fee705
MC
3892
3893 set found -1
3894 for { set line 1 } { 1 } { incr line } {
3895 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
0d7941a9 3896 error "$message"
c6fee705
MC
3897 }
3898 if { $nchar < 0 } then {
3899 break
3900 }
3901 if { [string first "$text" "$body"] >= 0 } then {
3902 set found $line
3903 break
3904 }
3905 }
3906
3907 if { [ catch { close "$fd" } message ] } then {
0d7941a9
KS
3908 error "$message"
3909 }
3910
3911 if {$found == -1} {
3912 error "undefined tag \"$text\""
c6fee705
MC
3913 }
3914
3915 return $found
c906108c
SS
3916}
3917
b477a5e6
PA
3918# Continue the program until it ends.
3919#
fda326dd
TT
3920# MSSG is the error message that gets printed. If not given, a
3921# default is used.
3922# COMMAND is the command to invoke. If not given, "continue" is
3923# used.
eceb0c5f
TT
3924# ALLOW_EXTRA is a flag indicating whether the test should expect
3925# extra output between the "Continuing." line and the program
3926# exiting. By default it is zero; if nonzero, any extra output
3927# is accepted.
fda326dd 3928
eceb0c5f 3929proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
e11ac3a3 3930 global inferior_exited_re use_gdb_stub
7a292a7a 3931
fda326dd
TT
3932 if {$mssg == ""} {
3933 set text "continue until exit"
3934 } else {
3935 set text "continue until exit at $mssg"
3936 }
eceb0c5f
TT
3937 if {$allow_extra} {
3938 set extra ".*"
3939 } else {
3940 set extra ""
3941 }
b477a5e6
PA
3942
3943 # By default, we don't rely on exit() behavior of remote stubs --
3944 # it's common for exit() to be implemented as a simple infinite
3945 # loop, or a forced crash/reset. For native targets, by default, we
3946 # assume process exit is reported as such. If a non-reliable target
3947 # is used, we set a breakpoint at exit, and continue to that.
3948 if { [target_info exists exit_is_reliable] } {
3949 set exit_is_reliable [target_info exit_is_reliable]
3950 } else {
3951 set exit_is_reliable [expr ! $use_gdb_stub]
3952 }
3953
3954 if { ! $exit_is_reliable } {
7a292a7a
SS
3955 if {![gdb_breakpoint "exit"]} {
3956 return 0
3957 }
eceb0c5f 3958 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
fda326dd 3959 $text
7a292a7a
SS
3960 } else {
3961 # Continue until we exit. Should not stop again.
3962 # Don't bother to check the output of the program, that may be
3963 # extremely tough for some remote systems.
eceb0c5f
TT
3964 gdb_test $command \
3965 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
fda326dd 3966 $text
7a292a7a
SS
3967 }
3968}
3969
3970proc rerun_to_main {} {
e11ac3a3 3971 global gdb_prompt use_gdb_stub
7a292a7a 3972
e11ac3a3 3973 if $use_gdb_stub {
7a292a7a
SS
3974 gdb_run_cmd
3975 gdb_expect {
3976 -re ".*Breakpoint .*main .*$gdb_prompt $"\
3977 {pass "rerun to main" ; return 0}
3978 -re "$gdb_prompt $"\
3979 {fail "rerun to main" ; return 0}
3980 timeout {fail "(timeout) rerun to main" ; return 0}
3981 }
3982 } else {
3983 send_gdb "run\n"
3984 gdb_expect {
11350d2a
CV
3985 -re "The program .* has been started already.*y or n. $" {
3986 send_gdb "y\n"
3987 exp_continue
3988 }
7a292a7a
SS
3989 -re "Starting program.*$gdb_prompt $"\
3990 {pass "rerun to main" ; return 0}
3991 -re "$gdb_prompt $"\
3992 {fail "rerun to main" ; return 0}
3993 timeout {fail "(timeout) rerun to main" ; return 0}
3994 }
3995 }
3996}
c906108c 3997
13a5e3b8
MS
3998# Print a message and return true if a test should be skipped
3999# due to lack of floating point suport.
4000
4001proc gdb_skip_float_test { msg } {
4002 if [target_info exists gdb,skip_float_tests] {
4ec70201 4003 verbose "Skipping test '$msg': no float tests."
ae59b1da 4004 return 1
13a5e3b8 4005 }
ae59b1da 4006 return 0
13a5e3b8
MS
4007}
4008
4009# Print a message and return true if a test should be skipped
4010# due to lack of stdio support.
4011
4012proc gdb_skip_stdio_test { msg } {
4013 if [target_info exists gdb,noinferiorio] {
4ec70201 4014 verbose "Skipping test '$msg': no inferior i/o."
ae59b1da 4015 return 1
13a5e3b8 4016 }
ae59b1da 4017 return 0
13a5e3b8
MS
4018}
4019
4020proc gdb_skip_bogus_test { msg } {
ae59b1da 4021 return 0
13a5e3b8
MS
4022}
4023
e515b470
DJ
4024# Return true if a test should be skipped due to lack of XML support
4025# in the host GDB.
d0ef5df8 4026# NOTE: This must be called while gdb is *not* running.
e515b470 4027
17e1c970 4028gdb_caching_proc gdb_skip_xml_test {
e515b470
DJ
4029 global gdb_prompt
4030 global srcdir
e515b470
DJ
4031
4032 gdb_start
17e1c970 4033 set xml_missing 0
e515b470
DJ
4034 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
4035 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
17e1c970 4036 set xml_missing 1
e515b470
DJ
4037 }
4038 -re ".*$gdb_prompt $" { }
4039 }
4040 gdb_exit
17e1c970 4041 return $xml_missing
e515b470 4042}
1f8a6abb
EZ
4043
4044# Note: the procedure gdb_gnu_strip_debug will produce an executable called
4045# ${binfile}.dbglnk, which is just like the executable ($binfile) but without
4046# the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
8e1d0c49
JK
4047# the name of a debuginfo only file. This file will be stored in the same
4048# subdirectory.
1f8a6abb
EZ
4049
4050# Functions for separate debug info testing
4051
4052# starting with an executable:
4053# foo --> original executable
4054
4055# at the end of the process we have:
4056# foo.stripped --> foo w/o debug info
8e1d0c49 4057# foo.debug --> foo's debug info
1f8a6abb
EZ
4058# foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
4059
4935890f
JK
4060# Return the build-id hex string (usually 160 bits as 40 hex characters)
4061# converted to the form: .build-id/ab/cdef1234...89.debug
4062# Return "" if no build-id found.
4063proc build_id_debug_filename_get { exec } {
53e981d9 4064 set tmp [standard_output_file "${exec}-tmp"]
4fa7d390 4065 set objcopy_program [gdb_find_objcopy]
8b3fc8d8
MK
4066
4067 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output]
4068 verbose "result is $result"
4069 verbose "output is $output"
4070 if {$result == 1} {
4071 return ""
4072 }
4935890f 4073 set fi [open $tmp]
b7fca990 4074 fconfigure $fi -translation binary
4935890f
JK
4075 # Skip the NOTE header.
4076 read $fi 16
4077 set data [read $fi]
4078 close $fi
4079 file delete $tmp
7020f05c 4080 if ![string compare $data ""] then {
4935890f
JK
4081 return ""
4082 }
4083 # Convert it to hex.
4084 binary scan $data H* data
061b5285 4085 regsub {^..} $data {\0/} data
ae59b1da 4086 return ".build-id/${data}.debug"
4935890f
JK
4087}
4088
94277a38
DJ
4089# Create stripped files for DEST, replacing it. If ARGS is passed, it is a
4090# list of optional flags. The only currently supported flag is no-main,
4091# which removes the symbol entry for main from the separate debug file.
c0201579
JK
4092#
4093# Function returns zero on success. Function will return non-zero failure code
4094# on some targets not supporting separate debug info (such as i386-msdos).
1f8a6abb 4095
94277a38
DJ
4096proc gdb_gnu_strip_debug { dest args } {
4097
8e1d0c49
JK
4098 # Use the first separate debug info file location searched by GDB so the
4099 # run cannot be broken by some stale file searched with higher precedence.
4100 set debug_file "${dest}.debug"
4101
b741e217 4102 set strip_to_file_program [transform strip]
4fa7d390 4103 set objcopy_program [gdb_find_objcopy]
1f8a6abb 4104
1f8a6abb
EZ
4105 set debug_link [file tail $debug_file]
4106 set stripped_file "${dest}.stripped"
4107
4108 # Get rid of the debug info, and store result in stripped_file
4109 # something like gdb/testsuite/gdb.base/blah.stripped.
4110 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
4111 verbose "result is $result"
4112 verbose "output is $output"
4113 if {$result == 1} {
4114 return 1
4115 }
4116
d521f563
JK
4117 # Workaround PR binutils/10802:
4118 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4119 set perm [file attributes ${dest} -permissions]
4120 file attributes ${stripped_file} -permissions $perm
4121
1f8a6abb
EZ
4122 # Get rid of everything but the debug info, and store result in debug_file
4123 # This will be in the .debug subdirectory, see above.
4124 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
4125 verbose "result is $result"
4126 verbose "output is $output"
4127 if {$result == 1} {
4128 return 1
4129 }
4130
94277a38
DJ
4131 # If no-main is passed, strip the symbol for main from the separate
4132 # file. This is to simulate the behavior of elfutils's eu-strip, which
4133 # leaves the symtab in the original file only. There's no way to get
4134 # objcopy or strip to remove the symbol table without also removing the
4135 # debugging sections, so this is as close as we can get.
4136 if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
4137 set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
4138 verbose "result is $result"
4139 verbose "output is $output"
4140 if {$result == 1} {
4141 return 1
4142 }
4143 file delete "${debug_file}"
4144 file rename "${debug_file}-tmp" "${debug_file}"
4145 }
4146
1f8a6abb
EZ
4147 # Link the two previous output files together, adding the .gnu_debuglink
4148 # section to the stripped_file, containing a pointer to the debug_file,
4149 # save the new file in dest.
4150 # This will be the regular executable filename, in the usual location.
4151 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
4152 verbose "result is $result"
4153 verbose "output is $output"
4154 if {$result == 1} {
4155 return 1
4156 }
4157
d521f563
JK
4158 # Workaround PR binutils/10802:
4159 # Preserve the 'x' bit also for PIEs (Position Independent Executables).
4160 set perm [file attributes ${stripped_file} -permissions]
4161 file attributes ${dest} -permissions $perm
4162
4163 return 0
1f8a6abb
EZ
4164}
4165
d8295fe9
VP
4166# Test the output of GDB_COMMAND matches the pattern obtained
4167# by concatenating all elements of EXPECTED_LINES. This makes
4168# it possible to split otherwise very long string into pieces.
4169# If third argument is not empty, it's used as the name of the
4170# test to be printed on pass/fail.
4171proc help_test_raw { gdb_command expected_lines args } {
4172 set message $gdb_command
4173 if [llength $args]>0 then {
4174 set message [lindex $args 0]
4175 }
4176 set expected_output [join $expected_lines ""]
4177 gdb_test "${gdb_command}" "${expected_output}" $message
4178}
4179
6aee0d90 4180# Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
d8295fe9
VP
4181# are regular expressions that should match the beginning of output,
4182# before the list of commands in that class. The presence of
4183# command list and standard epilogue will be tested automatically.
4184proc test_class_help { command_class expected_initial_lines args } {
4185 set l_stock_body {
4186 "List of commands\:.*\[\r\n\]+"
4187 "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
4188 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
4189 "Command name abbreviations are allowed if unambiguous\."
4190 }
4191 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4192
4193 eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
4194}
4195
4196# COMMAND_LIST should have either one element -- command to test, or
4197# two elements -- abbreviated command to test, and full command the first
4198# element is abbreviation of.
4199# The command must be a prefix command. EXPECTED_INITIAL_LINES
4200# are regular expressions that should match the beginning of output,
4201# before the list of subcommands. The presence of
4202# subcommand list and standard epilogue will be tested automatically.
4203proc test_prefix_command_help { command_list expected_initial_lines args } {
4204 set command [lindex $command_list 0]
4205 if {[llength $command_list]>1} {
4206 set full_command [lindex $command_list 1]
4207 } else {
4208 set full_command $command
4209 }
4210 # Use 'list' and not just {} because we want variables to
4211 # be expanded in this list.
4212 set l_stock_body [list\
4213 "List of $full_command subcommands\:.*\[\r\n\]+"\
4214 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
4215 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
4216 "Command name abbreviations are allowed if unambiguous\."]
4217 set l_entire_body [concat $expected_initial_lines $l_stock_body]
4218 if {[llength $args]>0} {
4219 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
4220 } else {
4221 help_test_raw "help ${command}" $l_entire_body
4222 }
4223}
dbc52822 4224
85b4440a
TT
4225# Build executable named EXECUTABLE from specifications that allow
4226# different options to be passed to different sub-compilations.
4227# TESTNAME is the name of the test; this is passed to 'untested' if
4228# something fails.
a0d3f2f5
SCR
4229# OPTIONS is passed to the final link, using gdb_compile. If OPTIONS
4230# contains the option "pthreads", then gdb_compile_pthreads is used.
85b4440a
TT
4231# ARGS is a flat list of source specifications, of the form:
4232# { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... }
4233# Each SOURCE is compiled to an object file using its OPTIONS,
4234# using gdb_compile.
4235# Returns 0 on success, -1 on failure.
4236proc build_executable_from_specs {testname executable options args} {
dbc52822
VP
4237 global subdir
4238 global srcdir
dbc52822 4239
0a6d0306 4240 set binfile [standard_output_file $executable]
dbc52822 4241
fd961404
DE
4242 set info_options ""
4243 if { [lsearch -exact $options "c++"] >= 0 } {
4244 set info_options "c++"
4245 }
4c93b1db 4246 if [get_compiler_info ${info_options}] {
dbc52822
VP
4247 return -1
4248 }
a29a3fb7 4249
a29a3fb7
GB
4250 set func gdb_compile
4251 set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}]
4252 if {$func_index != -1} {
4253 set func "${func}_[lindex $options $func_index]"
4254 }
4255
4256 # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd
4257 # parameter. They also requires $sources while gdb_compile and
4258 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
4259 if [string match gdb_compile_shlib* $func] {
4260 set sources_path {}
4261 foreach {s local_options} $args {
4262 lappend sources_path "${srcdir}/${subdir}/${s}"
4263 }
4264 set ret [$func $sources_path "${binfile}" $options]
4265 } else {
4266 set objects {}
4267 set i 0
4268 foreach {s local_options} $args {
4269 if { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $local_options] != "" } {
4270 untested $testname
4271 return -1
4272 }
4273 lappend objects "${binfile}${i}.o"
4274 incr i
4275 }
4276 set ret [$func $objects "${binfile}" executable $options]
4277 }
4278 if { $ret != "" } {
4279 untested $testname
4280 return -1
4281 }
4282
dbc52822
VP
4283 return 0
4284}
4285
85b4440a
TT
4286# Build executable named EXECUTABLE, from SOURCES. If SOURCES are not
4287# provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test
4288# to pass to untested, if something is wrong. OPTIONS are passed
4289# to gdb_compile directly.
4290proc build_executable { testname executable {sources ""} {options {debug}} } {
4291 if {[llength $sources]==0} {
4292 set sources ${executable}.c
4293 }
4294
4295 set arglist [list $testname $executable $options]
4296 foreach source $sources {
4297 lappend arglist $source $options
4298 }
4299
4300 return [eval build_executable_from_specs $arglist]
4301}
4302
dbc52822 4303# Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
0a6d0306 4304# the basename of the binary.
dbc52822
VP
4305proc clean_restart { executable } {
4306 global srcdir
dbc52822 4307 global subdir
0a6d0306 4308 set binfile [standard_output_file ${executable}]
dbc52822
VP
4309
4310 gdb_exit
4311 gdb_start
4312 gdb_reinitialize_dir $srcdir/$subdir
4313 gdb_load ${binfile}
dbc52822
VP
4314}
4315
85b4440a
TT
4316# Prepares for testing by calling build_executable_full, then
4317# clean_restart.
4318# TESTNAME is the name of the test.
4319# Each element in ARGS is a list of the form
4320# { EXECUTABLE OPTIONS SOURCE_SPEC... }
4321# These are passed to build_executable_from_specs, which see.
4322# The last EXECUTABLE is passed to clean_restart.
4323# Returns 0 on success, non-zero on failure.
4324proc prepare_for_testing_full {testname args} {
4325 foreach spec $args {
4326 if {[eval build_executable_from_specs [list $testname] $spec] == -1} {
4327 return -1
4328 }
4329 set executable [lindex $spec 0]
4330 }
4331 clean_restart $executable
4332 return 0
4333}
4334
dbc52822
VP
4335# Prepares for testing, by calling build_executable, and then clean_restart.
4336# Please refer to build_executable for parameter description.
4337proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
4338
734a5c36 4339 if {[build_executable $testname $executable $sources $options] == -1} {
dbc52822
VP
4340 return -1
4341 }
4342 clean_restart $executable
4343
4344 return 0
4345}
7065b901
TT
4346
4347proc get_valueof { fmt exp default } {
4348 global gdb_prompt
4349
4350 set test "get valueof \"${exp}\""
4351 set val ${default}
4352 gdb_test_multiple "print${fmt} ${exp}" "$test" {
417e16e2
PM
4353 -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
4354 set val $expect_out(1,string)
4355 pass "$test ($val)"
4356 }
4357 timeout {
4358 fail "$test (timeout)"
4359 }
4360 }
4361 return ${val}
4362}
4363
4364proc get_integer_valueof { exp default } {
4365 global gdb_prompt
4366
4367 set test "get integer valueof \"${exp}\""
4368 set val ${default}
4369 gdb_test_multiple "print /d ${exp}" "$test" {
7065b901
TT
4370 -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
4371 set val $expect_out(1,string)
4372 pass "$test ($val)"
4373 }
4374 timeout {
417e16e2 4375 fail "$test (timeout)"
7065b901
TT
4376 }
4377 }
4378 return ${val}
4379}
4380
faafb047
PM
4381proc get_hexadecimal_valueof { exp default } {
4382 global gdb_prompt
4383 send_gdb "print /x ${exp}\n"
4384 set test "get hexadecimal valueof \"${exp}\""
4385 gdb_expect {
4386 -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
4387 set val $expect_out(1,string)
4388 pass "$test"
4389 }
4390 timeout {
4391 set val ${default}
4392 fail "$test (timeout)"
4393 }
4394 }
4395 return ${val}
4396}
417e16e2 4397
7065b901 4398proc get_sizeof { type default } {
417e16e2 4399 return [get_integer_valueof "sizeof (${type})" $default]
7065b901
TT
4400}
4401
ed3ef339
DE
4402proc get_target_charset { } {
4403 global gdb_prompt
4404
4405 gdb_test_multiple "show target-charset" "" {
4406 -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" {
4407 return $expect_out(1,string)
4408 }
4409 -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" {
4410 return $expect_out(1,string)
4411 }
4412 }
4413
4414 # Pick a reasonable default.
4415 warning "Unable to read target-charset."
4416 return "UTF-8"
4417}
4418
db863c42
MF
4419# Get the current value for remotetimeout and return it.
4420proc get_remotetimeout { } {
4421 global gdb_prompt
4422 global decimal
4423
4424 gdb_test_multiple "show remotetimeout" "" {
4425 -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" {
ae59b1da 4426 return $expect_out(1,string)
db863c42
MF
4427 }
4428 }
4429
4430 # Pick the default that gdb uses
4431 warning "Unable to read remotetimeout"
4432 return 300
4433}
4434
4435# Set the remotetimeout to the specified timeout. Nothing is returned.
4436proc set_remotetimeout { timeout } {
4437 global gdb_prompt
4438
4439 gdb_test_multiple "set remotetimeout $timeout" "" {
4440 -re "$gdb_prompt $" {
4441 verbose "Set remotetimeout to $timeout\n"
4442 }
4443 }
4444}
4445
1e537771
TT
4446# ROOT and FULL are file names. Returns the relative path from ROOT
4447# to FULL. Note that FULL must be in a subdirectory of ROOT.
4448# For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
4449# will return "ls".
4450
4451proc relative_filename {root full} {
4452 set root_split [file split $root]
4453 set full_split [file split $full]
4454
4455 set len [llength $root_split]
4456
4457 if {[eval file join $root_split]
4458 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
4459 error "$full not a subdir of $root"
4460 }
4461
4462 return [eval file join [lrange $full_split $len end]]
4463}
4464
812f7342
TT
4465# Log gdb command line and script if requested.
4466if {[info exists TRANSCRIPT]} {
4467 rename send_gdb real_send_gdb
4468 rename remote_spawn real_remote_spawn
4469 rename remote_close real_remote_close
4470
4471 global gdb_transcript
4472 set gdb_transcript ""
4473
4474 global gdb_trans_count
4475 set gdb_trans_count 1
4476
4477 proc remote_spawn {args} {
4478 global gdb_transcript gdb_trans_count outdir
4479
4480 if {$gdb_transcript != ""} {
4481 close $gdb_transcript
4482 }
4483 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
4484 puts $gdb_transcript [lindex $args 1]
4485 incr gdb_trans_count
4486
4487 return [uplevel real_remote_spawn $args]
4488 }
4489
4490 proc remote_close {args} {
4491 global gdb_transcript
4492
4493 if {$gdb_transcript != ""} {
4494 close $gdb_transcript
4495 set gdb_transcript ""
4496 }
4497
4498 return [uplevel real_remote_close $args]
4499 }
4500
4501 proc send_gdb {args} {
4502 global gdb_transcript
4503
4504 if {$gdb_transcript != ""} {
4505 puts -nonewline $gdb_transcript [lindex $args 0]
4506 }
4507
4508 return [uplevel real_send_gdb $args]
4509 }
4510}
37aeb5df 4511
5e92f71a
TT
4512# If GDB_PARALLEL exists, then set up the parallel-mode directories.
4513if {[info exists GDB_PARALLEL]} {
4514 if {[is_remote host]} {
4515 unset GDB_PARALLEL
4516 } else {
4517 file mkdir outputs temp cache
4518 }
4519}
4520
bbfba9ed 4521proc core_find {binfile {deletefiles {}} {arg ""}} {
37aeb5df
JK
4522 global objdir subdir
4523
4524 set destcore "$binfile.core"
4525 file delete $destcore
4526
4527 # Create a core file named "$destcore" rather than just "core", to
4528 # avoid problems with sys admin types that like to regularly prune all
4529 # files named "core" from the system.
4530 #
4531 # Arbitrarily try setting the core size limit to "unlimited" since
4532 # this does not hurt on systems where the command does not work and
4533 # allows us to generate a core on systems where it does.
4534 #
4535 # Some systems append "core" to the name of the program; others append
4536 # the name of the program to "core"; still others (like Linux, as of
4537 # May 2003) create cores named "core.PID". In the latter case, we
4538 # could have many core files lying around, and it may be difficult to
4539 # tell which one is ours, so let's run the program in a subdirectory.
4540 set found 0
93c0ef37 4541 set coredir [standard_output_file coredir.[getpid]]
37aeb5df 4542 file mkdir $coredir
bbfba9ed 4543 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
37aeb5df
JK
4544 # remote_exec host "${binfile}"
4545 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
4546 if [remote_file build exists $i] {
4547 remote_exec build "mv $i $destcore"
4548 set found 1
4549 }
4550 }
4551 # Check for "core.PID".
4552 if { $found == 0 } {
4553 set names [glob -nocomplain -directory $coredir core.*]
4554 if {[llength $names] == 1} {
4555 set corefile [file join $coredir [lindex $names 0]]
4556 remote_exec build "mv $corefile $destcore"
4557 set found 1
4558 }
4559 }
4560 if { $found == 0 } {
4561 # The braindamaged HPUX shell quits after the ulimit -c above
4562 # without executing ${binfile}. So we try again without the
4563 # ulimit here if we didn't find a core file above.
4564 # Oh, I should mention that any "braindamaged" non-Unix system has
4565 # the same problem. I like the cd bit too, it's really neat'n stuff.
4566 catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
4567 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
4568 if [remote_file build exists $i] {
4569 remote_exec build "mv $i $destcore"
4570 set found 1
4571 }
4572 }
4573 }
4574
4575 # Try to clean up after ourselves.
4576 foreach deletefile $deletefiles {
4577 remote_file build delete [file join $coredir $deletefile]
4578 }
4579 remote_exec build "rmdir $coredir"
4580
4581 if { $found == 0 } {
4582 warning "can't generate a core file - core tests suppressed - check ulimit -c"
4583 return ""
4584 }
4585 return $destcore
4586}
ee5683ab
PM
4587
4588# gdb_target_symbol_prefix_flags returns a string that can be added
4589# to gdb_compile options to define SYMBOL_PREFIX macro value
4590# symbol_prefix_flags returns a string that can be added
4591# for targets that use underscore as symbol prefix.
4592# TODO: find out automatically if the target needs this.
4593
4594proc gdb_target_symbol_prefix_flags {} {
4595 if { [istarget "*-*-cygwin*"] || [istarget "i?86-*-mingw*"]
4596 || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } {
4597 return "additional_flags=-DSYMBOL_PREFIX=\"_\""
4598 } else {
4599 return ""
4600 }
4601}
4602
6e45f158
DE
4603# A wrapper for 'remote_exec host' that passes or fails a test.
4604# Returns 0 if all went well, nonzero on failure.
4605# TEST is the name of the test, other arguments are as for remote_exec.
4606
4607proc run_on_host { test program args } {
4608 verbose -log "run_on_host: $program $args"
4609 # remote_exec doesn't work properly if the output is set but the
4610 # input is the empty string -- so replace an empty input with
4611 # /dev/null.
4612 if {[llength $args] > 1 && [lindex $args 1] == ""} {
4613 set args [lreplace $args 1 1 "/dev/null"]
4614 }
4615 set result [eval remote_exec host [list $program] $args]
4616 verbose "result is $result"
4617 set status [lindex $result 0]
4618 set output [lindex $result 1]
4619 if {$status == 0} {
4620 pass $test
4621 return 0
4622 } else {
4623 fail $test
4624 return -1
4625 }
4626}
4627
a587b477
DE
4628# Return non-zero if "board_info debug_flags" mentions Fission.
4629# http://gcc.gnu.org/wiki/DebugFission
4630# Fission doesn't support everything yet.
4631# This supports working around bug 15954.
4632
4633proc using_fission { } {
4634 set debug_flags [board_info [target_info name] debug_flags]
4635 return [regexp -- "-gsplit-dwarf" $debug_flags]
4636}
4637
42159ca5
TT
4638# Always load compatibility stuff.
4639load_lib future.exp
This page took 1.781932 seconds and 4 git commands to generate.