gdb/testsuite/lib/gdb.exp

   1 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
   2 # 2003, 2004, 2005, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   3
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 # This file was written by Fred Fish. (fnf@cygnus.com)
  18
  19 # Generic gdb subroutines that should work for any target.  If these
  20 # need to be modified for any target, it can be done with a variable
  21 # or by passing arguments.
  22
  23 if {$tool == ""} {
  24     # Tests would fail, logs on get_compiler_info() would be missing.
  25     send_error "`site.exp' not found, run `make site.exp'!\n"
  26     exit 2
  27 }
  28
  29 load_lib libgloss.exp
  30
  31 global GDB
  32
  33 if [info exists TOOL_EXECUTABLE] {
  34     set GDB $TOOL_EXECUTABLE;
  35 }
  36 if ![info exists GDB] {
  37     if ![is_remote host] {
  38         set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
  39     } else {
  40         set GDB [transform gdb];
  41     }
  42 }
  43 verbose "using GDB = $GDB" 2
  44
  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
  50 global GDBFLAGS
  51 if ![info exists GDBFLAGS] {
  52     set GDBFLAGS ""
  53 }
  54 verbose "using GDBFLAGS = $GDBFLAGS" 2
  55
  56 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
  57 global INTERNAL_GDBFLAGS
  58 if ![info exists INTERNAL_GDBFLAGS] {
  59     set INTERNAL_GDBFLAGS "-nw -nx"
  60 }
  61
  62 # The variable gdb_prompt is a regexp which matches the gdb prompt.
  63 # Set it if it is not already set.
  64 global gdb_prompt
  65 if ![info exists gdb_prompt] then {
  66     set gdb_prompt "\[(\]gdb\[)\]"
  67 }
  68
  69 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
  70 # absolute path ie. /foo/
  71 set fullname_syntax_POSIX {/[^\n]*/}
  72 # The variable fullname_syntax_UNC is a regexp which matches a Windows
  73 # UNC path ie. \\D\foo\
  74 set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\}
  75 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
  76 # particular DOS case that GDB most likely will output
  77 # ie. \foo\, but don't match \\.*\
  78 set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\}
  79 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
  80 # ie. a:\foo\ && a:foo\
  81 set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\}
  82 # The variable fullname_syntax is a regexp which matches what GDB considers
  83 # an absolute path. It is currently debatable if the Windows style paths
  84 # d:foo and \abc should be considered valid as an absolute path.
  85 # Also, the purpse of this regexp is not to recognize a well formed
  86 # absolute path, but to say with certainty that a path is absolute.
  87 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
  88
  89 # Needed for some tests under Cygwin.
  90 global EXEEXT
  91 global env
  92
  93 if ![info exists env(EXEEXT)] {
  94     set EXEEXT ""
  95 } else {
  96     set EXEEXT $env(EXEEXT)
  97 }
  98
  99 set octal "\[0-7\]+"
 100
 101 ### Only procedures should come after this point.
 102
 103 #
 104 # gdb_version -- extract and print the version number of GDB
 105 #
 106 proc default_gdb_version {} {
 107     global GDB
 108     global INTERNAL_GDBFLAGS GDBFLAGS
 109     global gdb_prompt
 110     set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
 111     set tmp [lindex $output 1];
 112     set version ""
 113     regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
 114     if ![is_remote host] {
 115         clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
 116     } else {
 117         clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n"
 118     }
 119 }
 120
 121 proc gdb_version { } {
 122     return [default_gdb_version];
 123 }
 124
 125 #
 126 # gdb_unload -- unload a file if one is loaded
 127 #
 128
 129 proc gdb_unload {} {
 130     global verbose
 131     global GDB
 132     global gdb_prompt
 133     send_gdb "file\n"
 134     gdb_expect 60 {
 135         -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
 136         -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
 137         -re "A program is being debugged already..*Kill it.*y or n. $"\
 138             { send_gdb "y\n"
 139                 verbose "\t\tKilling previous program being debugged"
 140             exp_continue
 141         }
 142         -re "Discard symbol table from .*y or n.*$" {
 143             send_gdb "y\n"
 144             exp_continue
 145         }
 146         -re "$gdb_prompt $" {}
 147         timeout {
 148             perror "couldn't unload file in $GDB (timed out)."
 149             return -1
 150         }
 151     }
 152 }
 153
 154 # Many of the tests depend on setting breakpoints at various places and
 155 # running until that breakpoint is reached.  At times, we want to start
 156 # with a clean-slate with respect to breakpoints, so this utility proc
 157 # lets us do this without duplicating this code everywhere.
 158 #
 159
 160 proc delete_breakpoints {} {
 161     global gdb_prompt
 162
 163     # we need a larger timeout value here or this thing just confuses
 164     # itself.  May need a better implementation if possible. - guo
 165     #
 166     send_gdb "delete breakpoints\n"
 167     gdb_expect 100 {
 168          -re "Delete all breakpoints.*y or n.*$" {
 169             send_gdb "y\n";
 170             exp_continue
 171         }
 172          -re "$gdb_prompt $" { # This happens if there were no breakpoints
 173             }
 174          timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
 175     }
 176     send_gdb "info breakpoints\n"
 177     gdb_expect 100 {
 178          -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
 179          -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
 180          -re "Delete all breakpoints.*or n.*$" {
 181             send_gdb "y\n";
 182             exp_continue
 183         }
 184          timeout { perror "info breakpoints (timeout)" ; return }
 185     }
 186 }
 187
 188
 189 #
 190 # Generic run command.
 191 #
 192 # The second pattern below matches up to the first newline *only*.
 193 # Using ``.*$'' could swallow up output that we attempt to match
 194 # elsewhere.
 195 #
 196 proc gdb_run_cmd {args} {
 197     global gdb_prompt
 198
 199     if [target_info exists gdb_init_command] {
 200         send_gdb "[target_info gdb_init_command]\n";
 201         gdb_expect 30 {
 202             -re "$gdb_prompt $" { }
 203             default {
 204                 perror "gdb_init_command for target failed";
 205                 return;
 206             }
 207         }
 208     }
 209
 210     if [target_info exists use_gdb_stub] {
 211         if [target_info exists gdb,do_reload_on_run] {
 212             if { [gdb_reload] != 0 } {
 213                 return;
 214             }
 215             send_gdb "continue\n";
 216             gdb_expect 60 {
 217                 -re "Continu\[^\r\n\]*\[\r\n\]" {}
 218                 default {}
 219             }
 220             return;
 221         }
 222
 223         if [target_info exists gdb,start_symbol] {
 224             set start [target_info gdb,start_symbol];
 225         } else {
 226             set start "start";
 227         }
 228         send_gdb  "jump *$start\n"
 229         set start_attempt 1;
 230         while { $start_attempt } {
 231             # Cap (re)start attempts at three to ensure that this loop
 232             # always eventually fails.  Don't worry about trying to be
 233             # clever and not send a command when it has failed.
 234             if [expr $start_attempt > 3] {
 235                 perror "Jump to start() failed (retry count exceeded)";
 236                 return;
 237             }
 238             set start_attempt [expr $start_attempt + 1];
 239             gdb_expect 30 {
 240                 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
 241                     set start_attempt 0;
 242                 }
 243                 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
 244                     perror "Can't find start symbol to run in gdb_run";
 245                     return;
 246                 }
 247                 -re "No symbol \"start\" in current.*$gdb_prompt $" {
 248                     send_gdb "jump *_start\n";
 249                 }
 250                 -re "No symbol.*context.*$gdb_prompt $" {
 251                     set start_attempt 0;
 252                 }
 253                 -re "Line.* Jump anyway.*y or n. $" {
 254                     send_gdb "y\n"
 255                 }
 256                 -re "The program is not being run.*$gdb_prompt $" {
 257                     if { [gdb_reload] != 0 } {
 258                         return;
 259                     }
 260                     send_gdb "jump *$start\n";
 261                 }
 262                 timeout {
 263                     perror "Jump to start() failed (timeout)";
 264                     return
 265                 }
 266             }
 267         }
 268         if [target_info exists gdb_stub] {
 269             gdb_expect 60 {
 270                 -re "$gdb_prompt $" {
 271                     send_gdb "continue\n"
 272                 }
 273             }
 274         }
 275         return
 276     }
 277
 278     if [target_info exists gdb,do_reload_on_run] {
 279         if { [gdb_reload] != 0 } {
 280             return;
 281         }
 282     }
 283     send_gdb "run $args\n"
 284 # This doesn't work quite right yet.
 285 # Use -notransfer here so that test cases (like chng-sym.exp)
 286 # may test for additional start-up messages.
 287    gdb_expect 60 {
 288         -re "The program .* has been started already.*y or n. $" {
 289             send_gdb "y\n"
 290             exp_continue
 291         }
 292         -notransfer -re "Starting program: \[^\r\n\]*" {}
 293         -notransfer -re "$gdb_prompt $" {
 294             # There is no more input expected.
 295         }
 296     }
 297 }
 298
 299 # Generic start command.  Return 0 if we could start the program, -1
 300 # if we could not.
 301
 302 proc gdb_start_cmd {args} {
 303     global gdb_prompt
 304
 305     if [target_info exists gdb_init_command] {
 306         send_gdb "[target_info gdb_init_command]\n";
 307         gdb_expect 30 {
 308             -re "$gdb_prompt $" { }
 309             default {
 310                 perror "gdb_init_command for target failed";
 311                 return;
 312             }
 313         }
 314     }
 315
 316     if [target_info exists use_gdb_stub] {
 317         return -1
 318     }
 319
 320     send_gdb "start $args\n"
 321     # Use -notransfer here so that test cases (like chng-sym.exp)
 322     # may test for additional start-up messages.
 323     gdb_expect 60 {
 324         -re "The program .* has been started already.*y or n. $" {
 325             send_gdb "y\n"
 326             exp_continue
 327         }
 328         -notransfer -re "Starting program: \[^\r\n\]*" {
 329             return 0
 330         }
 331     }
 332     return -1
 333 }
 334
 335 # Set a breakpoint at FUNCTION.  If there is an additional argument it is
 336 # a list of options; the supported options are allow-pending, temporary,
 337 # and no-message.
 338
 339 proc gdb_breakpoint { function args } {
 340     global gdb_prompt
 341     global decimal
 342
 343     set pending_response n
 344     if {[lsearch -exact [lindex $args 0] allow-pending] != -1} {
 345         set pending_response y
 346     }
 347
 348     set break_command "break"
 349     set break_message "Breakpoint"
 350     if {[lsearch -exact [lindex $args 0] temporary] != -1} {
 351         set break_command "tbreak"
 352         set break_message "Temporary breakpoint"
 353     }
 354
 355     set no_message 0
 356     if {[lsearch -exact [lindex $args 0] no-message] != -1} {
 357         set no_message 1
 358     }
 359
 360     send_gdb "$break_command $function\n"
 361     # The first two regexps are what we get with -g, the third is without -g.
 362     gdb_expect 30 {
 363         -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 364         -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 365         -re "$break_message \[0-9\]* at .*$gdb_prompt $" {}
 366         -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
 367                 if {$pending_response == "n"} {
 368                         if { $no_message == 0 } {
 369                                 fail "setting breakpoint at $function"
 370                         }
 371                         return 0
 372                 }
 373         }
 374         -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
 375                 send_gdb "$pending_response\n"
 376                 exp_continue
 377         }
 378         -re "$gdb_prompt $" {
 379                 if { $no_message == 0 } {
 380                         fail "setting breakpoint at $function"
 381                 }
 382                 return 0
 383         }
 384         timeout {
 385                 if { $no_message == 0 } {
 386                         fail "setting breakpoint at $function (timeout)"
 387                 }
 388                 return 0
 389         }
 390     }
 391     return 1;
 392 }
 393
 394 # Set breakpoint at function and run gdb until it breaks there.
 395 # Since this is the only breakpoint that will be set, if it stops
 396 # at a breakpoint, we will assume it is the one we want.  We can't
 397 # just compare to "function" because it might be a fully qualified,
 398 # single quoted C++ function specifier.  If there's an additional argument,
 399 # pass it to gdb_breakpoint.
 400
 401 proc runto { function args } {
 402     global gdb_prompt
 403     global decimal
 404
 405     delete_breakpoints
 406
 407     if ![gdb_breakpoint $function [lindex $args 0]] {
 408         return 0;
 409     }
 410
 411     gdb_run_cmd
 412
 413     # the "at foo.c:36" output we get with -g.
 414     # the "in func" output we get without -g.
 415     gdb_expect 30 {
 416         -re "Break.* at .*:$decimal.*$gdb_prompt $" {
 417             return 1
 418         }
 419         -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
 420             return 1
 421         }
 422         -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" {
 423             unsupported "Non-stop mode not supported"
 424             return 0
 425         }
 426         -re ".*A problem internal to GDB has been detected" {
 427             fail "running to $function in runto (GDB internal error)"
 428             gdb_internal_error_resync
 429             return 0
 430         }
 431         -re "$gdb_prompt $" {
 432             fail "running to $function in runto"
 433             return 0
 434         }
 435         eof {
 436             fail "running to $function in runto (end of file)"
 437             return 0
 438         }
 439         timeout {
 440             fail "running to $function in runto (timeout)"
 441             return 0
 442         }
 443     }
 444     return 1
 445 }
 446
 447 #
 448 # runto_main -- ask gdb to run until we hit a breakpoint at main.
 449 #               The case where the target uses stubs has to be handled
 450 #               specially--if it uses stubs, assuming we hit
 451 #               breakpoint() and just step out of the function.
 452 #
 453 proc runto_main { } {
 454     global gdb_prompt
 455     global decimal
 456
 457     if ![target_info exists gdb_stub] {
 458         return [runto main]
 459     }
 460
 461     delete_breakpoints
 462
 463     gdb_step_for_stub;
 464
 465     return 1
 466 }
 467
 468
 469 ### Continue, and expect to hit a breakpoint.
 470 ### Report a pass or fail, depending on whether it seems to have
 471 ### worked.  Use NAME as part of the test name; each call to
 472 ### continue_to_breakpoint should use a NAME which is unique within
 473 ### that test file.
 474 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
 475     global gdb_prompt
 476     set full_name "continue to breakpoint: $name"
 477
 478     send_gdb "continue\n"
 479     gdb_expect {
 480         -re "Breakpoint .* (at|in) $location_pattern\r\n$gdb_prompt $" {
 481             pass $full_name
 482         }
 483         -re ".*$gdb_prompt $" {
 484             fail $full_name
 485         }
 486         timeout {
 487             fail "$full_name (timeout)"
 488         }
 489     }
 490 }
 491
 492
 493 # gdb_internal_error_resync:
 494 #
 495 # Answer the questions GDB asks after it reports an internal error
 496 # until we get back to a GDB prompt.  Decline to quit the debugging
 497 # session, and decline to create a core file.  Return non-zero if the
 498 # resync succeeds.
 499 #
 500 # This procedure just answers whatever questions come up until it sees
 501 # a GDB prompt; it doesn't require you to have matched the input up to
 502 # any specific point.  However, it only answers questions it sees in
 503 # the output itself, so if you've matched a question, you had better
 504 # answer it yourself before calling this.
 505 #
 506 # You can use this function thus:
 507 #
 508 # gdb_expect {
 509 #     ...
 510 #     -re ".*A problem internal to GDB has been detected" {
 511 #         gdb_internal_error_resync
 512 #     }
 513 #     ...
 514 # }
 515 #
 516 proc gdb_internal_error_resync {} {
 517     global gdb_prompt
 518
 519     set count 0
 520     while {$count < 10} {
 521         gdb_expect {
 522             -re "Quit this debugging session\\? \\(y or n\\) $" {
 523                 send_gdb "n\n"
 524                 incr count
 525             }
 526             -re "Create a core file of GDB\\? \\(y or n\\) $" {
 527                 send_gdb "n\n"
 528                 incr count
 529             }
 530             -re "$gdb_prompt $" {
 531                 # We're resynchronized.
 532                 return 1
 533             }
 534             timeout {
 535                 perror "Could not resync from internal error (timeout)"
 536                 return 0
 537             }
 538         }
 539     }
 540     perror "Could not resync from internal error (resync count exceeded)"
 541     return 0
 542 }
 543
 544
 545 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
 546 # Send a command to gdb; test the result.
 547 #
 548 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 549 #   this is the null string no command is sent.
 550 # MESSAGE is a message to be printed with the built-in failure patterns
 551 #   if one of them matches.  If MESSAGE is empty COMMAND will be used.
 552 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
 553 #   patterns.  Pattern elements will be evaluated in the caller's
 554 #   context; action elements will be executed in the caller's context.
 555 #   Unlike patterns for gdb_test, these patterns should generally include
 556 #   the final newline and prompt.
 557 #
 558 # Returns:
 559 #    1 if the test failed, according to a built-in failure pattern
 560 #    0 if only user-supplied patterns matched
 561 #   -1 if there was an internal error.
 562 #
 563 # You can use this function thus:
 564 #
 565 # gdb_test_multiple "print foo" "test foo" {
 566 #    -re "expected output 1" {
 567 #        pass "print foo"
 568 #    }
 569 #    -re "expected output 2" {
 570 #        fail "print foo"
 571 #    }
 572 # }
 573 #
 574 # The standard patterns, such as "Program exited..." and "A problem
 575 # ...", all being implicitly appended to that list.
 576 #
 577 proc gdb_test_multiple { command message user_code } {
 578     global verbose
 579     global gdb_prompt
 580     global GDB
 581     upvar timeout timeout
 582     upvar expect_out expect_out
 583
 584     if { $message == "" } {
 585         set message $command
 586     }
 587
 588     if [string match "*\[\r\n\]" $command] {
 589         error "Invalid trailing newline in \"$message\" test"
 590     }
 591
 592     # TCL/EXPECT WART ALERT
 593     # Expect does something very strange when it receives a single braced
 594     # argument.  It splits it along word separators and performs substitutions.
 595     # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
 596     # evaluated as "\[ab\]".  But that's not how TCL normally works; inside a
 597     # double-quoted list item, "\[ab\]" is just a long way of representing
 598     # "[ab]", because the backslashes will be removed by lindex.
 599
 600     # Unfortunately, there appears to be no easy way to duplicate the splitting
 601     # that expect will do from within TCL.  And many places make use of the
 602     # "\[0-9\]" construct, so we need to support that; and some places make use
 603     # of the "[func]" construct, so we need to support that too.  In order to
 604     # get this right we have to substitute quoted list elements differently
 605     # from braced list elements.
 606
 607     # We do this roughly the same way that Expect does it.  We have to use two
 608     # lists, because if we leave unquoted newlines in the argument to uplevel
 609     # they'll be treated as command separators, and if we escape newlines
 610     # we mangle newlines inside of command blocks.  This assumes that the
 611     # input doesn't contain a pattern which contains actual embedded newlines
 612     # at this point!
 613
 614     regsub -all {\n} ${user_code} { } subst_code
 615     set subst_code [uplevel list $subst_code]
 616
 617     set processed_code ""
 618     set patterns ""
 619     set expecting_action 0
 620     set expecting_arg 0
 621     foreach item $user_code subst_item $subst_code {
 622         if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
 623             lappend processed_code $item
 624             continue
 625         }
 626         if { $item == "-indices" || $item == "-re" || $item == "-ex" } {
 627             lappend processed_code $item
 628             continue
 629         }
 630         if { $item == "-timeout" } {
 631             set expecting_arg 1
 632             lappend processed_code $item
 633             continue
 634         }
 635         if { $expecting_arg } {
 636             set expecting_arg 0
 637             lappend processed_code $item
 638             continue
 639         }
 640         if { $expecting_action } {
 641             lappend processed_code "uplevel [list $item]"
 642             set expecting_action 0
 643             # Cosmetic, no effect on the list.
 644             append processed_code "\n"
 645             continue
 646         }
 647         set expecting_action 1
 648         lappend processed_code $subst_item
 649         if {$patterns != ""} {
 650             append patterns "; "
 651         }
 652         append patterns "\"$subst_item\""
 653     }
 654
 655     # Also purely cosmetic.
 656     regsub -all {\r} $patterns {\\r} patterns
 657     regsub -all {\n} $patterns {\\n} patterns
 658
 659     if $verbose>2 then {
 660         send_user "Sending \"$command\" to gdb\n"
 661         send_user "Looking to match \"$patterns\"\n"
 662         send_user "Message is \"$message\"\n"
 663     }
 664
 665     set result -1
 666     set string "${command}\n";
 667     if { $command != "" } {
 668         while { "$string" != "" } {
 669             set foo [string first "\n" "$string"];
 670             set len [string length "$string"];
 671             if { $foo < [expr $len - 1] } {
 672                 set str [string range "$string" 0 $foo];
 673                 if { [send_gdb "$str"] != "" } {
 674                     global suppress_flag;
 675
 676                     if { ! $suppress_flag } {
 677                         perror "Couldn't send $command to GDB.";
 678                     }
 679                     fail "$message";
 680                     return $result;
 681                 }
 682                 # since we're checking if each line of the multi-line
 683                 # command are 'accepted' by GDB here,
 684                 # we need to set -notransfer expect option so that
 685                 # command output is not lost for pattern matching
 686                 # - guo
 687                 gdb_expect 2 {
 688                     -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
 689                     timeout { verbose "partial: timeout" 3 }
 690                 }
 691                 set string [string range "$string" [expr $foo + 1] end];
 692             } else {
 693                 break;
 694             }
 695         }
 696         if { "$string" != "" } {
 697             if { [send_gdb "$string"] != "" } {
 698                 global suppress_flag;
 699
 700                 if { ! $suppress_flag } {
 701                     perror "Couldn't send $command to GDB.";
 702                 }
 703                 fail "$message";
 704                 return $result;
 705             }
 706         }
 707     }
 708
 709     if [target_info exists gdb,timeout] {
 710         set tmt [target_info gdb,timeout];
 711     } else {
 712         if [info exists timeout] {
 713             set tmt $timeout;
 714         } else {
 715             global timeout;
 716             if [info exists timeout] {
 717                 set tmt $timeout;
 718             } else {
 719                 set tmt 60;
 720             }
 721         }
 722     }
 723
 724     set code {
 725          -re ".*A problem internal to GDB has been detected" {
 726              fail "$message (GDB internal error)"
 727              gdb_internal_error_resync
 728          }
 729          -re "\\*\\*\\* DOSEXIT code.*" {
 730              if { $message != "" } {
 731                  fail "$message";
 732              }
 733              gdb_suppress_entire_file "GDB died";
 734              set result -1;
 735          }
 736     }
 737     append code $processed_code
 738     append code {
 739          -re "Ending remote debugging.*$gdb_prompt $" {
 740             if ![isnative] then {
 741                 warning "Can`t communicate to remote target."
 742             }
 743             gdb_exit
 744             gdb_start
 745             set result -1
 746         }
 747          -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
 748             perror "Undefined command \"$command\"."
 749             fail "$message"
 750             set result 1
 751         }
 752          -re "Ambiguous command.*$gdb_prompt $" {
 753             perror "\"$command\" is not a unique command name."
 754             fail "$message"
 755             set result 1
 756         }
 757          -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
 758             if ![string match "" $message] then {
 759                 set errmsg "$message (the program exited)"
 760             } else {
 761                 set errmsg "$command (the program exited)"
 762             }
 763             fail "$errmsg"
 764             set result -1
 765         }
 766          -re "Program exited normally.*$gdb_prompt $" {
 767             if ![string match "" $message] then {
 768                 set errmsg "$message (the program exited)"
 769             } else {
 770                 set errmsg "$command (the program exited)"
 771             }
 772             fail "$errmsg"
 773             set result -1
 774         }
 775          -re "The program is not being run.*$gdb_prompt $" {
 776             if ![string match "" $message] then {
 777                 set errmsg "$message (the program is no longer running)"
 778             } else {
 779                 set errmsg "$command (the program is no longer running)"
 780             }
 781             fail "$errmsg"
 782             set result -1
 783         }
 784          -re "\r\n$gdb_prompt $" {
 785             if ![string match "" $message] then {
 786                 fail "$message"
 787             }
 788             set result 1
 789         }
 790          "<return>" {
 791             send_gdb "\n"
 792             perror "Window too small."
 793             fail "$message"
 794             set result -1
 795         }
 796         -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " {
 797             send_gdb "n\n"
 798             gdb_expect -re "$gdb_prompt $"
 799             fail "$message (got interactive prompt)"
 800             set result -1
 801         }
 802         -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" {
 803             send_gdb "0\n"
 804             gdb_expect -re "$gdb_prompt $"
 805             fail "$message (got breakpoint menu)"
 806             set result -1
 807         }
 808          eof {
 809              perror "Process no longer exists"
 810              if { $message != "" } {
 811                  fail "$message"
 812              }
 813              return -1
 814         }
 815          full_buffer {
 816             perror "internal buffer is full."
 817             fail "$message"
 818             set result -1
 819         }
 820         timeout {
 821             if ![string match "" $message] then {
 822                 fail "$message (timeout)"
 823             }
 824             set result 1
 825         }
 826     }
 827
 828     set result 0
 829     set code [catch {gdb_expect $tmt $code} string]
 830     if {$code == 1} {
 831         global errorInfo errorCode;
 832         return -code error -errorinfo $errorInfo -errorcode $errorCode $string
 833     } elseif {$code == 2} {
 834         return -code return $string
 835     } elseif {$code == 3} {
 836         return
 837     } elseif {$code > 4} {
 838         return -code $code $string
 839     }
 840     return $result
 841 }
 842
 843 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
 844 # Send a command to gdb; test the result.
 845 #
 846 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 847 #   this is the null string no command is sent.
 848 # PATTERN is the pattern to match for a PASS, and must NOT include
 849 #   the \r\n sequence immediately before the gdb prompt.
 850 # MESSAGE is an optional message to be printed.  If this is
 851 #   omitted, then the pass/fail messages use the command string as the
 852 #   message.  (If this is the empty string, then sometimes we don't
 853 #   call pass or fail at all; I don't understand this at all.)
 854 # QUESTION is a question GDB may ask in response to COMMAND, like
 855 #   "are you sure?"
 856 # RESPONSE is the response to send if QUESTION appears.
 857 #
 858 # Returns:
 859 #    1 if the test failed,
 860 #    0 if the test passes,
 861 #   -1 if there was an internal error.
 862 #
 863 proc gdb_test { args } {
 864     global verbose
 865     global gdb_prompt
 866     global GDB
 867     upvar timeout timeout
 868
 869     if [llength $args]>2 then {
 870         set message [lindex $args 2]
 871     } else {
 872         set message [lindex $args 0]
 873     }
 874     set command [lindex $args 0]
 875     set pattern [lindex $args 1]
 876
 877     if [llength $args]==5 {
 878         set question_string [lindex $args 3];
 879         set response_string [lindex $args 4];
 880     } else {
 881         set question_string "^FOOBAR$"
 882     }
 883
 884     return [gdb_test_multiple $command $message {
 885         -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
 886             if ![string match "" $message] then {
 887                 pass "$message"
 888             }
 889         }
 890         -re "(${question_string})$" {
 891             send_gdb "$response_string\n";
 892             exp_continue;
 893         }
 894      }]
 895 }
 896
 897 # gdb_test_no_output COMMAND MESSAGE
 898 # Send a command to GDB and verify that this command generated no output.
 899 #
 900 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
 901 # parameters.  If MESSAGE is ommitted, then COMMAND will be used as
 902 # the message.  (If MESSAGE is the empty string, then sometimes we do not
 903 # call pass or fail at all; I don't understand this at all.)
 904
 905 proc gdb_test_no_output { args } {
 906     global gdb_prompt
 907     set command [lindex $args 0]
 908     if [llength $args]>1 then {
 909         set message [lindex $args 1]
 910     } else {
 911         set message $command
 912     }
 913
 914     set command_regex [string_to_regexp $command]
 915     gdb_test_multiple $command $message {
 916         -re "^$command_regex\r\n$gdb_prompt $" {
 917             if ![string match "" $message] then {
 918                 pass "$message"
 919             }
 920         }
 921     }
 922 }
 923
 924 # Send a command and then wait for a sequence of outputs.
 925 # This is useful when the sequence is long and contains ".*", a single
 926 # regexp to match the entire output can get a timeout much easier.
 927 #
 928 # COMMAND is the command to send.
 929 # TEST_NAME is passed to pass/fail.  COMMAND is used if TEST_NAME is "".
 930 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
 931 # processed in order, and all must be present in the output.
 932 #
 933 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
 934 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
 935 # There is also an implicit ".*" between the last regexp and the gdb prompt.
 936 #
 937 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
 938 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
 939
 940 proc gdb_test_sequence { command test_name expected_output_list } {
 941     global gdb_prompt
 942     if { $test_name == "" } {
 943         set test_name $command
 944     }
 945     lappend expected_output_list ""; # implicit ".*" before gdb prompt
 946     send_gdb "$command\n"
 947     gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list
 948 }
 949
 950 \f
 951 # Test that a command gives an error.  For pass or fail, return
 952 # a 1 to indicate that more tests can proceed.  However a timeout
 953 # is a serious error, generates a special fail message, and causes
 954 # a 0 to be returned to indicate that more tests are likely to fail
 955 # as well.
 956
 957 proc test_print_reject { args } {
 958     global gdb_prompt
 959     global verbose
 960
 961     if [llength $args]==2 then {
 962         set expectthis [lindex $args 1]
 963     } else {
 964         set expectthis "should never match this bogus string"
 965     }
 966     set sendthis [lindex $args 0]
 967     if $verbose>2 then {
 968         send_user "Sending \"$sendthis\" to gdb\n"
 969         send_user "Looking to match \"$expectthis\"\n"
 970     }
 971     send_gdb "$sendthis\n"
 972     #FIXME: Should add timeout as parameter.
 973     gdb_expect {
 974         -re "A .* in expression.*\\.*$gdb_prompt $" {
 975             pass "reject $sendthis"
 976             return 1
 977         }
 978         -re "Invalid syntax in expression.*$gdb_prompt $" {
 979             pass "reject $sendthis"
 980             return 1
 981         }
 982         -re "Junk after end of expression.*$gdb_prompt $" {
 983             pass "reject $sendthis"
 984             return 1
 985         }
 986         -re "Invalid number.*$gdb_prompt $" {
 987             pass "reject $sendthis"
 988             return 1
 989         }
 990         -re "Invalid character constant.*$gdb_prompt $" {
 991             pass "reject $sendthis"
 992             return 1
 993         }
 994         -re "No symbol table is loaded.*$gdb_prompt $" {
 995             pass "reject $sendthis"
 996             return 1
 997         }
 998         -re "No symbol .* in current context.*$gdb_prompt $" {
 999             pass "reject $sendthis"
1000             return 1
1001         }
1002         -re "Unmatched single quote.*$gdb_prompt $" {
1003             pass "reject $sendthis"
1004             return 1
1005         }
1006         -re "A character constant must contain at least one character.*$gdb_prompt $" {
1007             pass "reject $sendthis"
1008             return 1
1009         }
1010         -re "$expectthis.*$gdb_prompt $" {
1011             pass "reject $sendthis"
1012             return 1
1013         }
1014         -re ".*$gdb_prompt $" {
1015             fail "reject $sendthis"
1016             return 1
1017         }
1018         default {
1019             fail "reject $sendthis (eof or timeout)"
1020             return 0
1021         }
1022     }
1023 }
1024 \f
1025 # Given an input string, adds backslashes as needed to create a
1026 # regexp that will match the string.
1027
1028 proc string_to_regexp {str} {
1029     set result $str
1030     regsub -all {[]*+.|()^$\[\\]} $str {\\&} result
1031     return $result
1032 }
1033
1034 # Same as gdb_test, but the second parameter is not a regexp,
1035 # but a string that must match exactly.
1036
1037 proc gdb_test_exact { args } {
1038     upvar timeout timeout
1039
1040     set command [lindex $args 0]
1041
1042     # This applies a special meaning to a null string pattern.  Without
1043     # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
1044     # messages from commands that should have no output except a new
1045     # prompt.  With this, only results of a null string will match a null
1046     # string pattern.
1047
1048     set pattern [lindex $args 1]
1049     if [string match $pattern ""] {
1050         set pattern [string_to_regexp [lindex $args 0]]
1051     } else {
1052         set pattern [string_to_regexp [lindex $args 1]]
1053     }
1054
1055     # It is most natural to write the pattern argument with only
1056     # embedded \n's, especially if you are trying to avoid Tcl quoting
1057     # problems.  But gdb_expect really wants to see \r\n in patterns.  So
1058     # transform the pattern here.  First transform \r\n back to \n, in
1059     # case some users of gdb_test_exact already do the right thing.
1060     regsub -all "\r\n" $pattern "\n" pattern
1061     regsub -all "\n" $pattern "\r\n" pattern
1062     if [llength $args]==3 then {
1063         set message [lindex $args 2]
1064     } else {
1065         set message $command
1066     }
1067
1068     return [gdb_test $command $pattern $message]
1069 }
1070
1071 # Wrapper around gdb_test_multiple that looks for a list of expected
1072 # output elements, but which can appear in any order.
1073 # CMD is the gdb command.
1074 # NAME is the name of the test.
1075 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1076 # compare.
1077 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1078 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1079 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1080 #
1081 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1082 # of text per element and then strip trailing \r\n's.
1083 # Example:
1084 # gdb_test_list_exact "foo" "bar" \
1085 #     {[^\r\n]+[\r\n]+} \
1086 #     {[^\r\n]+} \
1087 #     { \
1088 #       {expected result 1} \
1089 #       {expected result 2} \
1090 #     }
1091
1092 proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } {
1093     global gdb_prompt
1094
1095     set matches [lsort $result_match_list]
1096     set seen {}
1097     gdb_test_multiple $cmd $name {
1098         "$cmd\[\r\n\]" { exp_continue }
1099         -re $elm_find_regexp {
1100             set str $expect_out(0,string)
1101             verbose -log "seen: $str" 3
1102             regexp -- $elm_extract_regexp $str elm_seen
1103             verbose -log "extracted: $elm_seen" 3
1104             lappend seen $elm_seen
1105             exp_continue
1106         }
1107         -re "$gdb_prompt $" {
1108             set failed ""
1109             foreach got [lsort $seen] have $matches {
1110                 if {![string equal $got $have]} {
1111                     set failed $have
1112                     break
1113                 }
1114             }
1115             if {[string length $failed] != 0} {
1116                 fail "$name ($failed not found)"
1117             } else {
1118                 pass $name
1119             }
1120         }
1121     }
1122 }
1123 \f
1124 proc gdb_reinitialize_dir { subdir } {
1125     global gdb_prompt
1126
1127     if [is_remote host] {
1128         return "";
1129     }
1130     send_gdb "dir\n"
1131     gdb_expect 60 {
1132         -re "Reinitialize source path to empty.*y or n. " {
1133             send_gdb "y\n"
1134             gdb_expect 60 {
1135                 -re "Source directories searched.*$gdb_prompt $" {
1136                     send_gdb "dir $subdir\n"
1137                     gdb_expect 60 {
1138                         -re "Source directories searched.*$gdb_prompt $" {
1139                             verbose "Dir set to $subdir"
1140                         }
1141                         -re "$gdb_prompt $" {
1142                             perror "Dir \"$subdir\" failed."
1143                         }
1144                     }
1145                 }
1146                 -re "$gdb_prompt $" {
1147                     perror "Dir \"$subdir\" failed."
1148                 }
1149             }
1150         }
1151         -re "$gdb_prompt $" {
1152             perror "Dir \"$subdir\" failed."
1153         }
1154     }
1155 }
1156
1157 #
1158 # gdb_exit -- exit the GDB, killing the target program if necessary
1159 #
1160 proc default_gdb_exit {} {
1161     global GDB
1162     global INTERNAL_GDBFLAGS GDBFLAGS
1163     global verbose
1164     global gdb_spawn_id;
1165
1166     gdb_stop_suppressing_tests;
1167
1168     if ![info exists gdb_spawn_id] {
1169         return;
1170     }
1171
1172     verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1173
1174     if { [is_remote host] && [board_info host exists fileid] } {
1175         send_gdb "quit\n";
1176         gdb_expect 10 {
1177             -re "y or n" {
1178                 send_gdb "y\n";
1179                 exp_continue;
1180             }
1181             -re "DOSEXIT code" { }
1182             default { }
1183         }
1184     }
1185
1186     if ![is_remote host] {
1187         remote_close host;
1188     }
1189     unset gdb_spawn_id
1190 }
1191
1192 # Load a file into the debugger.
1193 # The return value is 0 for success, -1 for failure.
1194 #
1195 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1196 # to one of these values:
1197 #
1198 #   debug    file was loaded successfully and has debug information
1199 #   nodebug  file was loaded successfully and has no debug information
1200 #   fail     file was not loaded
1201 #
1202 # I tried returning this information as part of the return value,
1203 # but ran into a mess because of the many re-implementations of
1204 # gdb_load in config/*.exp.
1205 #
1206 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1207 # this if they can get more information set.
1208
1209 proc gdb_file_cmd { arg } {
1210     global gdb_prompt
1211     global verbose
1212     global GDB
1213     global last_loaded_file
1214
1215     set last_loaded_file $arg
1216
1217     # Set whether debug info was found.
1218     # Default to "fail".
1219     global gdb_file_cmd_debug_info
1220     set gdb_file_cmd_debug_info "fail"
1221
1222     if [is_remote host] {
1223         set arg [remote_download host $arg]
1224         if { $arg == "" } {
1225             perror "download failed"
1226             return -1
1227         }
1228     }
1229
1230     # The file command used to kill the remote target.  For the benefit
1231     # of the testsuite, preserve this behavior.
1232     send_gdb "kill\n"
1233     gdb_expect 120 {
1234         -re "Kill the program being debugged. .y or n. $" {
1235             send_gdb "y\n"
1236             verbose "\t\tKilling previous program being debugged"
1237             exp_continue
1238         }
1239         -re "$gdb_prompt $" {
1240             # OK.
1241         }
1242     }
1243
1244     send_gdb "file $arg\n"
1245     gdb_expect 120 {
1246         -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
1247             verbose "\t\tLoaded $arg into the $GDB with no debugging symbols"
1248             set gdb_file_cmd_debug_info "nodebug"
1249             return 0
1250         }
1251         -re "Reading symbols from.*done.*$gdb_prompt $" {
1252             verbose "\t\tLoaded $arg into the $GDB"
1253             set gdb_file_cmd_debug_info "debug"
1254             return 0
1255         }
1256         -re "Load new symbol table from \".*\".*y or n. $" {
1257             send_gdb "y\n"
1258             gdb_expect 120 {
1259                 -re "Reading symbols from.*done.*$gdb_prompt $" {
1260                     verbose "\t\tLoaded $arg with new symbol table into $GDB"
1261                     set gdb_file_cmd_debug_info "debug"
1262                     return 0
1263                 }
1264                 timeout {
1265                     perror "(timeout) Couldn't load $arg, other program already loaded."
1266                     return -1
1267                 }
1268             }
1269         }
1270         -re "No such file or directory.*$gdb_prompt $" {
1271             perror "($arg) No such file or directory"
1272             return -1
1273         }
1274         -re "$gdb_prompt $" {
1275             perror "couldn't load $arg into $GDB."
1276             return -1
1277             }
1278         timeout {
1279             perror "couldn't load $arg into $GDB (timed out)."
1280             return -1
1281         }
1282         eof {
1283             # This is an attempt to detect a core dump, but seems not to
1284             # work.  Perhaps we need to match .* followed by eof, in which
1285             # gdb_expect does not seem to have a way to do that.
1286             perror "couldn't load $arg into $GDB (end of file)."
1287             return -1
1288         }
1289     }
1290 }
1291
1292 #
1293 # start gdb -- start gdb running, default procedure
1294 #
1295 # When running over NFS, particularly if running many simultaneous
1296 # tests on different hosts all using the same server, things can
1297 # get really slow.  Give gdb at least 3 minutes to start up.
1298 #
1299 proc default_gdb_start { } {
1300     global verbose
1301     global GDB
1302     global INTERNAL_GDBFLAGS GDBFLAGS
1303     global gdb_prompt
1304     global timeout
1305     global gdb_spawn_id;
1306     global env
1307
1308     gdb_stop_suppressing_tests;
1309
1310     set env(LC_CTYPE) C
1311
1312     # Don't let a .inputrc file or an existing setting of INPUTRC mess up
1313     # the test results.  Even if /dev/null doesn't exist on the particular
1314     # platform, the readline library will use the default setting just by
1315     # failing to open the file.  OTOH, opening /dev/null successfully will
1316     # also result in the default settings being used since nothing will be
1317     # read from this file.
1318     set env(INPUTRC) "/dev/null"
1319
1320     # The gdb.base/readline.exp arrow key test relies on the standard VT100
1321     # bindings, so make sure that an appropriate terminal is selected.
1322     # The same bug doesn't show up if we use ^P / ^N instead.
1323     set env(TERM) "vt100"
1324
1325     verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1326
1327     if [info exists gdb_spawn_id] {
1328         return 0;
1329     }
1330
1331     if ![is_remote host] {
1332         if { [which $GDB] == 0 } then {
1333             perror "$GDB does not exist."
1334             exit 1
1335         }
1336     }
1337     set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"];
1338     if { $res < 0 || $res == "" } {
1339         perror "Spawning $GDB failed."
1340         return 1;
1341     }
1342     gdb_expect 360 {
1343         -re "\[\r\n\]$gdb_prompt $" {
1344             verbose "GDB initialized."
1345         }
1346         -re "$gdb_prompt $"     {
1347             perror "GDB never initialized."
1348             return -1
1349         }
1350         timeout {
1351             perror "(timeout) GDB never initialized after 10 seconds."
1352             remote_close host;
1353             return -1
1354         }
1355     }
1356     set gdb_spawn_id -1;
1357     # force the height to "unlimited", so no pagers get used
1358
1359     send_gdb "set height 0\n"
1360     gdb_expect 10 {
1361         -re "$gdb_prompt $" {
1362             verbose "Setting height to 0." 2
1363         }
1364         timeout {
1365             warning "Couldn't set the height to 0"
1366         }
1367     }
1368     # force the width to "unlimited", so no wraparound occurs
1369     send_gdb "set width 0\n"
1370     gdb_expect 10 {
1371         -re "$gdb_prompt $" {
1372             verbose "Setting width to 0." 2
1373         }
1374         timeout {
1375             warning "Couldn't set the width to 0."
1376         }
1377     }
1378     return 0;
1379 }
1380
1381 # Examine the output of compilation to determine whether compilation
1382 # failed or not.  If it failed determine whether it is due to missing
1383 # compiler or due to compiler error.  Report pass, fail or unsupported
1384 # as appropriate
1385
1386 proc gdb_compile_test {src output} {
1387     if { $output == "" } {
1388         pass "compilation [file tail $src]"
1389     } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } {
1390         unsupported "compilation [file tail $src]"
1391     } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } {
1392         unsupported "compilation [file tail $src]"
1393     } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } {
1394         unsupported "compilation [file tail $src]"
1395     } else {
1396         verbose -log "compilation failed: $output" 2
1397         fail "compilation [file tail $src]"
1398     }
1399 }
1400
1401 # Return a 1 for configurations for which we don't even want to try to
1402 # test C++.
1403
1404 proc skip_cplus_tests {} {
1405     if { [istarget "h8300-*-*"] } {
1406         return 1
1407     }
1408
1409     # The C++ IO streams are too large for HC11/HC12 and are thus not
1410     # available.  The gdb C++ tests use them and don't compile.
1411     if { [istarget "m6811-*-*"] } {
1412         return 1
1413     }
1414     if { [istarget "m6812-*-*"] } {
1415         return 1
1416     }
1417     return 0
1418 }
1419
1420 # Return a 1 for configurations for which don't have both C++ and the STL.
1421
1422 proc skip_stl_tests {} {
1423     # Symbian supports the C++ language, but the STL is missing
1424     # (both headers and libraries).
1425     if { [istarget "arm*-*-symbianelf*"] } {
1426         return 1
1427     }
1428
1429     return [skip_cplus_tests]
1430 }
1431
1432 # Return a 1 if I don't even want to try to test FORTRAN.
1433
1434 proc skip_fortran_tests {} {
1435     return 0
1436 }
1437
1438 # Return a 1 if I don't even want to try to test ada.
1439
1440 proc skip_ada_tests {} {
1441     return 0
1442 }
1443
1444 # Return a 1 if I don't even want to try to test java.
1445
1446 proc skip_java_tests {} {
1447     return 0
1448 }
1449
1450 # Return a 1 for configurations that do not support Python scripting.
1451
1452 proc skip_python_tests {} {
1453     global gdb_prompt
1454     gdb_test_multiple "python print 'test'" "verify python support" {
1455         -re "not supported.*$gdb_prompt $"      {
1456             unsupported "Python support is disabled."
1457             return 1
1458         }
1459         -re "$gdb_prompt $"     {}
1460     }
1461
1462     return 0
1463 }
1464
1465 # Return a 1 if we should skip shared library tests.
1466
1467 proc skip_shlib_tests {} {
1468     # Run the shared library tests on native systems.
1469     if {[isnative]} {
1470         return 0
1471     }
1472
1473     # An abbreviated list of remote targets where we should be able to
1474     # run shared library tests.
1475     if {([istarget *-*-linux*]
1476          || [istarget *-*-*bsd*]
1477          || [istarget *-*-solaris2*]
1478          || [istarget arm*-*-symbianelf*]
1479          || [istarget *-*-mingw*]
1480          || [istarget *-*-cygwin*]
1481          || [istarget *-*-pe*])} {
1482         return 0
1483     }
1484
1485     return 1
1486 }
1487
1488 # Return 1 if target is ILP32.
1489 # This cannot be decided simply from looking at the target string,
1490 # as it might depend on externally passed compiler options like -m64.
1491 proc is_ilp32_target {} {
1492     global is_ilp32_target_saved
1493
1494     # Use the cached value, if it exists.  Cache value per "board" to handle
1495     # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1496     set me "is_ilp32_target"
1497     set board [target_info name]
1498     if [info exists is_ilp32_target_saved($board)] {
1499         verbose "$me:  returning saved $is_ilp32_target_saved($board)" 2
1500         return $is_ilp32_target_saved($board)
1501     }
1502
1503
1504     set src ilp32[pid].c
1505     set obj ilp32[pid].o
1506
1507     set f [open $src "w"]
1508     puts $f "int dummy\[sizeof (int) == 4"
1509     puts $f "           && sizeof (void *) == 4"
1510     puts $f "           && sizeof (long) == 4 ? 1 : -1\];"
1511     close $f
1512
1513     verbose "$me:  compiling testfile $src" 2
1514     set lines [gdb_compile $src $obj object {quiet}]
1515     file delete $src
1516     file delete $obj
1517
1518     if ![string match "" $lines] then {
1519         verbose "$me:  testfile compilation failed, returning 0" 2
1520         return [set is_ilp32_target_saved($board) 0]
1521     }
1522
1523     verbose "$me:  returning 1" 2
1524     return [set is_ilp32_target_saved($board) 1]
1525 }
1526
1527 # Return 1 if target is LP64.
1528 # This cannot be decided simply from looking at the target string,
1529 # as it might depend on externally passed compiler options like -m64.
1530 proc is_lp64_target {} {
1531     global is_lp64_target_saved
1532
1533     # Use the cached value, if it exists.  Cache value per "board" to handle
1534     # runs with multiple options (e.g. unix/{-m32,-64}) correctly.
1535     set me "is_lp64_target"
1536     set board [target_info name]
1537     if [info exists is_lp64_target_saved($board)] {
1538         verbose "$me:  returning saved $is_lp64_target_saved($board)" 2
1539         return $is_lp64_target_saved($board)
1540     }
1541
1542     set src lp64[pid].c
1543     set obj lp64[pid].o
1544
1545     set f [open $src "w"]
1546     puts $f "int dummy\[sizeof (int) == 4"
1547     puts $f "           && sizeof (void *) == 8"
1548     puts $f "           && sizeof (long) == 8 ? 1 : -1\];"
1549     close $f
1550
1551     verbose "$me:  compiling testfile $src" 2
1552     set lines [gdb_compile $src $obj object {quiet}]
1553     file delete $src
1554     file delete $obj
1555
1556     if ![string match "" $lines] then {
1557         verbose "$me:  testfile compilation failed, returning 0" 2
1558         return [set is_lp64_target_saved($board) 0]
1559     }
1560
1561     verbose "$me:  returning 1" 2
1562     return [set is_lp64_target_saved($board) 1]
1563 }
1564
1565 # Run a test on the target to see if it supports vmx hardware.  Return 0 if so,
1566 # 1 if it does not.  Based on 'check_vmx_hw_available' from the GCC testsuite.
1567
1568 proc skip_altivec_tests {} {
1569     global skip_vmx_tests_saved
1570     global srcdir subdir gdb_prompt
1571
1572     # Use the cached value, if it exists.
1573     set me "skip_altivec_tests"
1574     if [info exists skip_vmx_tests_saved] {
1575         verbose "$me:  returning saved $skip_vmx_tests_saved" 2
1576         return $skip_vmx_tests_saved
1577     }
1578
1579     # Some simulators are known to not support VMX instructions.
1580     if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1581         verbose "$me:  target known to not support VMX, returning 1" 2
1582         return [set skip_vmx_tests_saved 1]
1583     }
1584
1585     # Make sure we have a compiler that understands altivec.
1586     set compile_flags {debug nowarnings}
1587     if [get_compiler_info not-used] {
1588        warning "Could not get compiler info"
1589        return 1
1590     }
1591     if [test_compiler_info gcc*] {
1592         set compile_flags "$compile_flags additional_flags=-maltivec"
1593     } elseif [test_compiler_info xlc*] {
1594         set compile_flags "$compile_flags additional_flags=-qaltivec"
1595     } else {
1596         verbose "Could not compile with altivec support, returning 1" 2
1597         return 1
1598     }
1599
1600     # Set up, compile, and execute a test program containing VMX instructions.
1601     # Include the current process ID in the file names to prevent conflicts
1602     # with invocations for multiple testsuites.
1603     set src vmx[pid].c
1604     set exe vmx[pid].x
1605
1606     set f [open $src "w"]
1607     puts $f "int main() {"
1608     puts $f "#ifdef __MACH__"
1609     puts $f "  asm volatile (\"vor v0,v0,v0\");"
1610     puts $f "#else"
1611     puts $f "  asm volatile (\"vor 0,0,0\");"
1612     puts $f "#endif"
1613     puts $f "  return 0; }"
1614     close $f
1615
1616     verbose "$me:  compiling testfile $src" 2
1617     set lines [gdb_compile $src $exe executable $compile_flags]
1618     file delete $src
1619
1620     if ![string match "" $lines] then {
1621         verbose "$me:  testfile compilation failed, returning 1" 2
1622         return [set skip_vmx_tests_saved 1]
1623     }
1624
1625     # No error message, compilation succeeded so now run it via gdb.
1626
1627     gdb_exit
1628     gdb_start
1629     gdb_reinitialize_dir $srcdir/$subdir
1630     gdb_load "$exe"
1631     gdb_run_cmd
1632     gdb_expect {
1633         -re ".*Illegal instruction.*${gdb_prompt} $" {
1634             verbose -log "\n$me altivec hardware not detected"
1635             set skip_vmx_tests_saved 1
1636         }
1637         -re ".*Program exited normally.*${gdb_prompt} $" {
1638             verbose -log "\n$me: altivec hardware detected"
1639             set skip_vmx_tests_saved 0
1640         }
1641         default {
1642           warning "\n$me: default case taken"
1643             set skip_vmx_tests_saved 1
1644         }
1645     }
1646     gdb_exit
1647     remote_file build delete $exe
1648
1649     verbose "$me:  returning $skip_vmx_tests_saved" 2
1650     return $skip_vmx_tests_saved
1651 }
1652
1653 # Run a test on the target to see if it supports vmx hardware.  Return 0 if so,
1654 # 1 if it does not.  Based on 'check_vmx_hw_available' from the GCC testsuite.
1655
1656 proc skip_vsx_tests {} {
1657     global skip_vsx_tests_saved
1658     global srcdir subdir gdb_prompt
1659
1660     # Use the cached value, if it exists.
1661     set me "skip_vsx_tests"
1662     if [info exists skip_vsx_tests_saved] {
1663         verbose "$me:  returning saved $skip_vsx_tests_saved" 2
1664         return $skip_vsx_tests_saved
1665     }
1666
1667     # Some simulators are known to not support Altivec instructions, so
1668     # they won't support VSX instructions as well.
1669     if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1670         verbose "$me:  target known to not support VSX, returning 1" 2
1671         return [set skip_vsx_tests_saved 1]
1672     }
1673
1674     # Make sure we have a compiler that understands altivec.
1675     set compile_flags {debug nowarnings quiet}
1676     if [get_compiler_info not-used] {
1677        warning "Could not get compiler info"
1678        return 1
1679     }
1680     if [test_compiler_info gcc*] {
1681         set compile_flags "$compile_flags additional_flags=-mvsx"
1682     } elseif [test_compiler_info xlc*] {
1683         set compile_flags "$compile_flags additional_flags=-qvsx"
1684     } else {
1685         verbose "Could not compile with vsx support, returning 1" 2
1686         return 1
1687     }
1688
1689     set src vsx[pid].c
1690     set exe vsx[pid].x
1691
1692     set f [open $src "w"]
1693     puts $f "int main() {"
1694     puts $f "#ifdef __MACH__"
1695     puts $f "  asm volatile (\"lxvd2x v0,v0,v0\");"
1696     puts $f "#else"
1697     puts $f "  asm volatile (\"lxvd2x 0,0,0\");"
1698     puts $f "#endif"
1699     puts $f "  return 0; }"
1700     close $f
1701
1702     verbose "$me:  compiling testfile $src" 2
1703     set lines [gdb_compile $src $exe executable $compile_flags]
1704     file delete $src
1705
1706     if ![string match "" $lines] then {
1707         verbose "$me:  testfile compilation failed, returning 1" 2
1708         return [set skip_vsx_tests_saved 1]
1709     }
1710
1711     # No error message, compilation succeeded so now run it via gdb.
1712
1713     gdb_exit
1714     gdb_start
1715     gdb_reinitialize_dir $srcdir/$subdir
1716     gdb_load "$exe"
1717     gdb_run_cmd
1718     gdb_expect {
1719         -re ".*Illegal instruction.*${gdb_prompt} $" {
1720             verbose -log "\n$me VSX hardware not detected"
1721             set skip_vsx_tests_saved 1
1722         }
1723         -re ".*Program exited normally.*${gdb_prompt} $" {
1724             verbose -log "\n$me: VSX hardware detected"
1725             set skip_vsx_tests_saved 0
1726         }
1727         default {
1728           warning "\n$me: default case taken"
1729             set skip_vsx_tests_saved 1
1730         }
1731     }
1732     gdb_exit
1733     remote_file build delete $exe
1734
1735     verbose "$me:  returning $skip_vsx_tests_saved" 2
1736     return $skip_vsx_tests_saved
1737 }
1738
1739 # Skip all the tests in the file if you are not on an hppa running
1740 # hpux target.
1741
1742 proc skip_hp_tests {} {
1743     eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
1744     verbose "Skip hp tests is $skip_hp"
1745     return $skip_hp
1746 }
1747
1748 # Return whether we should skip tests for showing inlined functions in
1749 # backtraces.  Requires get_compiler_info and get_debug_format.
1750
1751 proc skip_inline_frame_tests {} {
1752     # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
1753     if { ! [test_debug_format "DWARF 2"] } {
1754         return 1
1755     }
1756
1757     # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line.
1758     if { ([test_compiler_info "gcc-2-*"]
1759           || [test_compiler_info "gcc-3-*"]
1760           || [test_compiler_info "gcc-4-0-*"]) } {
1761         return 1
1762     }
1763
1764     return 0
1765 }
1766
1767 # Return whether we should skip tests for showing variables from
1768 # inlined functions.  Requires get_compiler_info and get_debug_format.
1769
1770 proc skip_inline_var_tests {} {
1771     # GDB only recognizes inlining information in DWARF 2 (DWARF 3).
1772     if { ! [test_debug_format "DWARF 2"] } {
1773         return 1
1774     }
1775
1776     return 0
1777 }
1778
1779 set compiler_info               "unknown"
1780 set gcc_compiled                0
1781 set hp_cc_compiler              0
1782 set hp_aCC_compiler             0
1783
1784 # Figure out what compiler I am using.
1785 #
1786 # BINFILE is a "compiler information" output file.  This implementation
1787 # does not use BINFILE.
1788 #
1789 # ARGS can be empty or "C++".  If empty, "C" is assumed.
1790 #
1791 # There are several ways to do this, with various problems.
1792 #
1793 # [ gdb_compile -E $ifile -o $binfile.ci ]
1794 # source $binfile.ci
1795 #
1796 #   Single Unix Spec v3 says that "-E -o ..." together are not
1797 #   specified.  And in fact, the native compiler on hp-ux 11 (among
1798 #   others) does not work with "-E -o ...".  Most targets used to do
1799 #   this, and it mostly worked, because it works with gcc.
1800 #
1801 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
1802 # source $binfile.ci
1803 #
1804 #   This avoids the problem with -E and -o together.  This almost works
1805 #   if the build machine is the same as the host machine, which is
1806 #   usually true of the targets which are not gcc.  But this code does
1807 #   not figure which compiler to call, and it always ends up using the C
1808 #   compiler.  Not good for setting hp_aCC_compiler.  Targets
1809 #   hppa*-*-hpux* and mips*-*-irix* used to do this.
1810 #
1811 # [ gdb_compile -E $ifile > $binfile.ci ]
1812 # source $binfile.ci
1813 #
1814 #   dejagnu target_compile says that it supports output redirection,
1815 #   but the code is completely different from the normal path and I
1816 #   don't want to sweep the mines from that path.  So I didn't even try
1817 #   this.
1818 #
1819 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
1820 # eval $cppout
1821 #
1822 #   I actually do this for all targets now.  gdb_compile runs the right
1823 #   compiler, and TCL captures the output, and I eval the output.
1824 #
1825 #   Unfortunately, expect logs the output of the command as it goes by,
1826 #   and dejagnu helpfully prints a second copy of it right afterwards.
1827 #   So I turn off expect logging for a moment.
1828 #
1829 # [ gdb_compile $ifile $ciexe_file executable $args ]
1830 # [ remote_exec $ciexe_file ]
1831 # [ source $ci_file.out ]
1832 #
1833 #   I could give up on -E and just do this.
1834 #   I didn't get desperate enough to try this.
1835 #
1836 # -- chastain 2004-01-06
1837
1838 proc get_compiler_info {binfile args} {
1839     # For compiler.c and compiler.cc
1840     global srcdir
1841
1842     # I am going to play with the log to keep noise out.
1843     global outdir
1844     global tool
1845
1846     # These come from compiler.c or compiler.cc
1847     global compiler_info
1848
1849     # Legacy global data symbols.
1850     global gcc_compiled
1851     global hp_cc_compiler
1852     global hp_aCC_compiler
1853
1854     # Choose which file to preprocess.
1855     set ifile "${srcdir}/lib/compiler.c"
1856     if { [llength $args] > 0 && [lindex $args 0] == "c++" } {
1857         set ifile "${srcdir}/lib/compiler.cc"
1858     }
1859
1860     # Run $ifile through the right preprocessor.
1861     # Toggle gdb.log to keep the compiler output out of the log.
1862     log_file
1863     if [is_remote host] {
1864         # We have to use -E and -o together, despite the comments
1865         # above, because of how DejaGnu handles remote host testing.
1866         set ppout "$outdir/compiler.i"
1867         gdb_compile "${ifile}" "$ppout" preprocess [list "$args" quiet]
1868         set file [open $ppout r]
1869         set cppout [read $file]
1870         close $file
1871     } else {
1872         set cppout [ gdb_compile "${ifile}" "" preprocess [list "$args" quiet] ]
1873     }
1874     log_file -a "$outdir/$tool.log"
1875
1876     # Eval the output.
1877     set unknown 0
1878     foreach cppline [ split "$cppout" "\n" ] {
1879         if { [ regexp "^#" "$cppline" ] } {
1880             # line marker
1881         } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
1882             # blank line
1883         } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
1884             # eval this line
1885             verbose "get_compiler_info: $cppline" 2
1886             eval "$cppline"
1887         } else {
1888             # unknown line
1889             verbose -log "get_compiler_info: $cppline"
1890             set unknown 1
1891         }
1892     }
1893
1894     # Reset to unknown compiler if any diagnostics happened.
1895     if { $unknown } {
1896         set compiler_info "unknown"
1897     }
1898
1899     # Set the legacy symbols.
1900     set gcc_compiled     0
1901     set hp_cc_compiler   0
1902     set hp_aCC_compiler  0
1903     if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
1904     if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
1905     if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
1906     if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
1907     if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
1908     if { [regexp "^hpcc-"  "$compiler_info" ] } { set hp_cc_compiler 1 }
1909     if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
1910
1911     # Log what happened.
1912     verbose -log "get_compiler_info: $compiler_info"
1913
1914     # Most compilers will evaluate comparisons and other boolean
1915     # operations to 0 or 1.
1916     uplevel \#0 { set true 1 }
1917     uplevel \#0 { set false 0 }
1918
1919     # Use of aCC results in boolean results being displayed as
1920     # "true" or "false"
1921     if { $hp_aCC_compiler } {
1922       uplevel \#0 { set true true }
1923       uplevel \#0 { set false false }
1924     }
1925
1926     return 0;
1927 }
1928
1929 proc test_compiler_info { {compiler ""} } {
1930     global compiler_info
1931
1932      # if no arg, return the compiler_info string
1933
1934      if [string match "" $compiler] {
1935          if [info exists compiler_info] {
1936              return $compiler_info
1937          } else {
1938              perror "No compiler info found."
1939          }
1940      }
1941
1942     return [string match $compiler $compiler_info]
1943 }
1944
1945 proc current_target_name { } {
1946     global target_info
1947     if [info exists target_info(target,name)] {
1948         set answer $target_info(target,name)
1949     } else {
1950         set answer ""
1951     }
1952     return $answer
1953 }
1954
1955 set gdb_wrapper_initialized 0
1956 set gdb_wrapper_target ""
1957
1958 proc gdb_wrapper_init { args } {
1959     global gdb_wrapper_initialized;
1960     global gdb_wrapper_file;
1961     global gdb_wrapper_flags;
1962     global gdb_wrapper_target
1963
1964     if { $gdb_wrapper_initialized == 1 } { return; }
1965
1966     if {[target_info exists needs_status_wrapper] && \
1967             [target_info needs_status_wrapper] != "0"} {
1968         set result [build_wrapper "testglue.o"];
1969         if { $result != "" } {
1970             set gdb_wrapper_file [lindex $result 0];
1971             set gdb_wrapper_flags [lindex $result 1];
1972         } else {
1973             warning "Status wrapper failed to build."
1974         }
1975     }
1976     set gdb_wrapper_initialized 1
1977     set gdb_wrapper_target [current_target_name]
1978 }
1979
1980 # Some targets need to always link a special object in.  Save its path here.
1981 global gdb_saved_set_unbuffered_mode_obj
1982 set gdb_saved_set_unbuffered_mode_obj ""
1983
1984 proc gdb_compile {source dest type options} {
1985     global GDB_TESTCASE_OPTIONS;
1986     global gdb_wrapper_file;
1987     global gdb_wrapper_flags;
1988     global gdb_wrapper_initialized;
1989     global srcdir
1990     global objdir
1991     global gdb_saved_set_unbuffered_mode_obj
1992
1993     set outdir [file dirname $dest]
1994
1995     # Add platform-specific options if a shared library was specified using
1996     # "shlib=librarypath" in OPTIONS.
1997     set new_options ""
1998     set shlib_found 0
1999     set shlib_load 0
2000     foreach opt $options {
2001         if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
2002             if [test_compiler_info "xlc-*"] {
2003                 # IBM xlc compiler doesn't accept shared library named other
2004                 # than .so: use "-Wl," to bypass this
2005                 lappend source "-Wl,$shlib_name"
2006             } elseif { ([istarget "*-*-mingw*"]
2007                         || [istarget *-*-cygwin*]
2008                         || [istarget *-*-pe*])} {
2009                 lappend source "${shlib_name}.a"
2010             } else {
2011                lappend source $shlib_name
2012             }
2013             if { $shlib_found == 0 } {
2014                 set shlib_found 1
2015                 if { ([istarget "*-*-mingw*"]
2016                       || [istarget *-*-cygwin*]) } {
2017                     lappend new_options "additional_flags=-Wl,--enable-auto-import"
2018                 }
2019             }
2020         } elseif { $opt == "shlib_load" } {
2021             set shlib_load 1
2022         } else {
2023             lappend new_options $opt
2024         }
2025     }
2026
2027     # We typically link to shared libraries using an absolute path, and
2028     # that's how they are found at runtime.  If we are going to
2029     # dynamically load one by basename, we must specify rpath.  If we
2030     # are using a remote host, DejaGNU will link to the shared library
2031     # using a relative path, so again we must specify an rpath.
2032     if { $shlib_load || ($shlib_found && [is_remote host]) } {
2033         if { ([istarget "*-*-mingw*"]
2034               || [istarget *-*-cygwin*]
2035               || [istarget *-*-pe*]
2036               || [istarget hppa*-*-hpux*])} {
2037             # Do not need anything.
2038         } elseif { [istarget *-*-openbsd*] } {
2039             lappend new_options "ldflags=-Wl,-rpath,${outdir}"
2040         } elseif { [istarget arm*-*-symbianelf*] } {
2041             if { $shlib_load } {
2042                 lappend new_options "libs=-ldl"
2043             }
2044         } else {
2045             if { $shlib_load } {
2046                 lappend new_options "libs=-ldl"
2047             }
2048             lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN"
2049         }
2050     }
2051     set options $new_options
2052
2053     if [target_info exists gdb_stub] {
2054         set options2 { "additional_flags=-Dusestubs" }
2055         lappend options "libs=[target_info gdb_stub]";
2056         set options [concat $options2 $options]
2057     }
2058     if [target_info exists is_vxworks] {
2059         set options2 { "additional_flags=-Dvxworks" }
2060         lappend options "libs=[target_info gdb_stub]";
2061         set options [concat $options2 $options]
2062     }
2063     if [info exists GDB_TESTCASE_OPTIONS] {
2064         lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
2065     }
2066     verbose "options are $options"
2067     verbose "source is $source $dest $type $options"
2068
2069     if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
2070
2071     if {[target_info exists needs_status_wrapper] && \
2072             [target_info needs_status_wrapper] != "0" && \
2073             [info exists gdb_wrapper_file]} {
2074         lappend options "libs=${gdb_wrapper_file}"
2075         lappend options "ldflags=${gdb_wrapper_flags}"
2076     }
2077
2078     # Replace the "nowarnings" option with the appropriate additional_flags
2079     # to disable compiler warnings.
2080     set nowarnings [lsearch -exact $options nowarnings]
2081     if {$nowarnings != -1} {
2082         if [target_info exists gdb,nowarnings_flag] {
2083             set flag "additional_flags=[target_info gdb,nowarnings_flag]"
2084         } else {
2085             set flag "additional_flags=-w"
2086         }
2087         set options [lreplace $options $nowarnings $nowarnings $flag]
2088     }
2089
2090     if { $type == "executable" } {
2091         if { ([istarget "*-*-mingw*"]
2092               || [istarget "*-*-*djgpp"]
2093               || [istarget "*-*-cygwin*"])} {
2094             # Force output to unbuffered mode, by linking in an object file
2095             # with a global contructor that calls setvbuf.
2096             #
2097             # Compile the special object seperatelly for two reasons:
2098             #  1) Insulate it from $options.
2099             #  2) Avoid compiling it for every gdb_compile invocation,
2100             #  which is time consuming, especially if we're remote
2101             #  host testing.
2102             #
2103             if { $gdb_saved_set_unbuffered_mode_obj == "" } {
2104                 verbose "compiling gdb_saved_set_unbuffered_obj"
2105                 set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c
2106                 set unbuf_obj ${objdir}/set_unbuffered_mode.o
2107
2108                 set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}]
2109                 if { $result != "" } {
2110                     return $result
2111                 }
2112
2113                 set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o
2114                 # Link a copy of the output object, because the
2115                 # original may be automatically deleted.
2116                 remote_exec host "cp -f $unbuf_obj $gdb_saved_set_unbuffered_mode_obj"
2117             } else {
2118                 verbose "gdb_saved_set_unbuffered_obj already compiled"
2119             }
2120
2121             # Rely on the internal knowledge that the global ctors are ran in
2122             # reverse link order.  In that case, we can use ldflags to
2123             # avoid copying the object file to the host multiple
2124             # times.
2125             # This object can only be added if standard libraries are
2126             # used. Thus, we need to disable it if -nostdlib option is used
2127             if {[lsearch -regexp $options "-nostdlib"] < 0 } {
2128                 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
2129             }
2130         }
2131     }
2132
2133     set result [target_compile $source $dest $type $options];
2134
2135     # Prune uninteresting compiler (and linker) output.
2136     regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
2137
2138     regsub "\[\r\n\]*$" "$result" "" result;
2139     regsub "^\[\r\n\]*" "$result" "" result;
2140
2141     if {[lsearch $options quiet] < 0} {
2142         # We shall update this on a per language basis, to avoid
2143         # changing the entire testsuite in one go.
2144         if {[lsearch $options f77] >= 0} {
2145             gdb_compile_test $source $result
2146         } elseif { $result != "" } {
2147             clone_output "gdb compile failed, $result"
2148         }
2149     }
2150     return $result;
2151 }
2152
2153
2154 # This is just like gdb_compile, above, except that it tries compiling
2155 # against several different thread libraries, to see which one this
2156 # system has.
2157 proc gdb_compile_pthreads {source dest type options} {
2158     set built_binfile 0
2159     set why_msg "unrecognized error"
2160     foreach lib {-lpthreads -lpthread -lthread ""} {
2161         # This kind of wipes out whatever libs the caller may have
2162         # set.  Or maybe theirs will override ours.  How infelicitous.
2163         set options_with_lib [concat $options [list libs=$lib quiet]]
2164         set ccout [gdb_compile $source $dest $type $options_with_lib]
2165         switch -regexp -- $ccout {
2166             ".*no posix threads support.*" {
2167                 set why_msg "missing threads include file"
2168                 break
2169             }
2170             ".*cannot open -lpthread.*" {
2171                 set why_msg "missing runtime threads library"
2172             }
2173             ".*Can't find library for -lpthread.*" {
2174                 set why_msg "missing runtime threads library"
2175             }
2176             {^$} {
2177                 pass "successfully compiled posix threads test case"
2178                 set built_binfile 1
2179                 break
2180             }
2181         }
2182     }
2183     if {!$built_binfile} {
2184         unsupported "Couldn't compile $source: ${why_msg}"
2185         return -1
2186     }
2187 }
2188
2189 # Build a shared library from SOURCES.  You must use get_compiler_info
2190 # first.
2191
2192 proc gdb_compile_shlib {sources dest options} {
2193     set obj_options $options
2194
2195     switch -glob [test_compiler_info] {
2196         "xlc-*" {
2197             lappend obj_options "additional_flags=-qpic"
2198         }
2199         "gcc-*" {
2200             if { !([istarget "powerpc*-*-aix*"]
2201                    || [istarget "rs6000*-*-aix*"]
2202                    || [istarget "*-*-cygwin*"]
2203                    || [istarget "*-*-mingw*"]
2204                    || [istarget "*-*-pe*"]) } {
2205                 lappend obj_options "additional_flags=-fpic"
2206             }
2207         }
2208         default {
2209             switch -glob [istarget] {
2210                 "hppa*-hp-hpux*" {
2211                     lappend obj_options "additional_flags=+z"
2212                 }
2213                 "mips-sgi-irix*" {
2214                     # Disable SGI compiler's implicit -Dsgi
2215                     lappend obj_options "additional_flags=-Usgi"
2216                 }
2217                 default {
2218                     # don't know what the compiler is...
2219                 }
2220             }
2221         }
2222     }
2223
2224     set outdir [file dirname $dest]
2225     set objects ""
2226     foreach source $sources {
2227        set sourcebase [file tail $source]
2228        if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
2229            return -1
2230        }
2231        lappend objects ${outdir}/${sourcebase}.o
2232     }
2233
2234     if [istarget "hppa*-*-hpux*"] {
2235        remote_exec build "ld -b ${objects} -o ${dest}"
2236     } else {
2237        set link_options $options
2238        if [test_compiler_info "xlc-*"] {
2239           lappend link_options "additional_flags=-qmkshrobj"
2240        } else {
2241           lappend link_options "additional_flags=-shared"
2242
2243            if { ([istarget "*-*-mingw*"]
2244                  || [istarget *-*-cygwin*]
2245                  || [istarget *-*-pe*])} {
2246                lappend link_options "additional_flags=-Wl,--out-implib,${dest}.a"
2247            }
2248        }
2249        if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
2250            return -1
2251        }
2252     }
2253 }
2254
2255 # This is just like gdb_compile_pthreads, above, except that we always add the
2256 # objc library for compiling Objective-C programs
2257 proc gdb_compile_objc {source dest type options} {
2258     set built_binfile 0
2259     set why_msg "unrecognized error"
2260     foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
2261         # This kind of wipes out whatever libs the caller may have
2262         # set.  Or maybe theirs will override ours.  How infelicitous.
2263         if { $lib == "solaris" } {
2264             set lib "-lpthread -lposix4"
2265         }
2266         if { $lib != "-lobjc" } {
2267           set lib "-lobjc $lib"
2268         }
2269         set options_with_lib [concat $options [list libs=$lib quiet]]
2270         set ccout [gdb_compile $source $dest $type $options_with_lib]
2271         switch -regexp -- $ccout {
2272             ".*no posix threads support.*" {
2273                 set why_msg "missing threads include file"
2274                 break
2275             }
2276             ".*cannot open -lpthread.*" {
2277                 set why_msg "missing runtime threads library"
2278             }
2279             ".*Can't find library for -lpthread.*" {
2280                 set why_msg "missing runtime threads library"
2281             }
2282             {^$} {
2283                 pass "successfully compiled objc with posix threads test case"
2284                 set built_binfile 1
2285                 break
2286             }
2287         }
2288     }
2289     if {!$built_binfile} {
2290         unsupported "Couldn't compile $source: ${why_msg}"
2291         return -1
2292     }
2293 }
2294
2295 proc send_gdb { string } {
2296     global suppress_flag;
2297     if { $suppress_flag } {
2298         return "suppressed";
2299     }
2300     return [remote_send host "$string"];
2301 }
2302
2303 #
2304 #
2305
2306 proc gdb_expect { args } {
2307     if { [llength $args] == 2  && [lindex $args 0] != "-re" } {
2308         set atimeout [lindex $args 0];
2309         set expcode [list [lindex $args 1]];
2310     } else {
2311         set expcode $args;
2312     }
2313
2314     upvar timeout timeout;
2315
2316     if [target_info exists gdb,timeout] {
2317         if [info exists timeout] {
2318             if { $timeout < [target_info gdb,timeout] } {
2319                 set gtimeout [target_info gdb,timeout];
2320             } else {
2321                 set gtimeout $timeout;
2322             }
2323         } else {
2324             set gtimeout [target_info gdb,timeout];
2325         }
2326     }
2327
2328     if ![info exists gtimeout] {
2329         global timeout;
2330         if [info exists timeout] {
2331             set gtimeout $timeout;
2332         }
2333     }
2334
2335     if [info exists atimeout] {
2336         if { ![info exists gtimeout] || $gtimeout < $atimeout } {
2337             set gtimeout $atimeout;
2338         }
2339     } else {
2340         if ![info exists gtimeout] {
2341             # Eeeeew.
2342             set gtimeout 60;
2343         }
2344     }
2345
2346     global suppress_flag;
2347     global remote_suppress_flag;
2348     if [info exists remote_suppress_flag] {
2349         set old_val $remote_suppress_flag;
2350     }
2351     if [info exists suppress_flag] {
2352         if { $suppress_flag } {
2353             set remote_suppress_flag 1;
2354         }
2355     }
2356     set code [catch \
2357         {uplevel remote_expect host $gtimeout $expcode} string];
2358     if [info exists old_val] {
2359         set remote_suppress_flag $old_val;
2360     } else {
2361         if [info exists remote_suppress_flag] {
2362             unset remote_suppress_flag;
2363         }
2364     }
2365
2366     if {$code == 1} {
2367         global errorInfo errorCode;
2368
2369         return -code error -errorinfo $errorInfo -errorcode $errorCode $string
2370     } elseif {$code == 2} {
2371         return -code return $string
2372     } elseif {$code == 3} {
2373         return
2374     } elseif {$code > 4} {
2375         return -code $code $string
2376     }
2377 }
2378
2379 # gdb_expect_list MESSAGE SENTINEL LIST -- expect a sequence of outputs
2380 #
2381 # Check for long sequence of output by parts.
2382 # MESSAGE: is the test message to be printed with the test success/fail.
2383 # SENTINEL: Is the terminal pattern indicating that output has finished.
2384 # LIST: is the sequence of outputs to match.
2385 # If the sentinel is recognized early, it is considered an error.
2386 #
2387 # Returns:
2388 #    1 if the test failed,
2389 #    0 if the test passes,
2390 #   -1 if there was an internal error.
2391 #
2392 proc gdb_expect_list {test sentinel list} {
2393     global gdb_prompt
2394     global suppress_flag
2395     set index 0
2396     set ok 1
2397     if { $suppress_flag } {
2398         set ok 0
2399         unresolved "${test}"
2400     }
2401     while { ${index} < [llength ${list}] } {
2402         set pattern [lindex ${list} ${index}]
2403         set index [expr ${index} + 1]
2404         verbose -log "gdb_expect_list pattern: /$pattern/" 2
2405         if { ${index} == [llength ${list}] } {
2406             if { ${ok} } {
2407                 gdb_expect {
2408                     -re "${pattern}${sentinel}" {
2409                         # pass "${test}, pattern ${index} + sentinel"
2410                     }
2411                     -re "${sentinel}" {
2412                         fail "${test} (pattern ${index} + sentinel)"
2413                         set ok 0
2414                     }
2415                     -re ".*A problem internal to GDB has been detected" {
2416                         fail "${test} (GDB internal error)"
2417                         set ok 0
2418                         gdb_internal_error_resync
2419                     }
2420                     timeout {
2421                         fail "${test} (pattern ${index} + sentinel) (timeout)"
2422                         set ok 0
2423                     }
2424                 }
2425             } else {
2426                 # unresolved "${test}, pattern ${index} + sentinel"
2427             }
2428         } else {
2429             if { ${ok} } {
2430                 gdb_expect {
2431                     -re "${pattern}" {
2432                         # pass "${test}, pattern ${index}"
2433                     }
2434                     -re "${sentinel}" {
2435                         fail "${test} (pattern ${index})"
2436                         set ok 0
2437                     }
2438                     -re ".*A problem internal to GDB has been detected" {
2439                         fail "${test} (GDB internal error)"
2440                         set ok 0
2441                         gdb_internal_error_resync
2442                     }
2443                     timeout {
2444                         fail "${test} (pattern ${index}) (timeout)"
2445                         set ok 0
2446                     }
2447                 }
2448             } else {
2449                 # unresolved "${test}, pattern ${index}"
2450             }
2451         }
2452     }
2453     if { ${ok} } {
2454         pass "${test}"
2455         return 0
2456     } else {
2457         return 1
2458     }
2459 }
2460
2461 #
2462 #
2463 proc gdb_suppress_entire_file { reason } {
2464     global suppress_flag;
2465
2466     warning "$reason\n";
2467     set suppress_flag -1;
2468 }
2469
2470 #
2471 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
2472 # gdb_expect to fail immediately (until the next call to
2473 # gdb_stop_suppressing_tests).
2474 #
2475 proc gdb_suppress_tests { args } {
2476     global suppress_flag;
2477
2478     return;  # fnf - disable pending review of results where
2479              # testsuite ran better without this
2480     incr suppress_flag;
2481
2482     if { $suppress_flag == 1 } {
2483         if { [llength $args] > 0 } {
2484             warning "[lindex $args 0]\n";
2485         } else {
2486             warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
2487         }
2488     }
2489 }
2490
2491 #
2492 # Clear suppress_flag.
2493 #
2494 proc gdb_stop_suppressing_tests { } {
2495     global suppress_flag;
2496
2497     if [info exists suppress_flag] {
2498         if { $suppress_flag > 0 } {
2499             set suppress_flag 0;
2500             clone_output "Tests restarted.\n";
2501         }
2502     } else {
2503         set suppress_flag 0;
2504     }
2505 }
2506
2507 proc gdb_clear_suppressed { } {
2508     global suppress_flag;
2509
2510     set suppress_flag 0;
2511 }
2512
2513 proc gdb_start { } {
2514     default_gdb_start
2515 }
2516
2517 proc gdb_exit { } {
2518     catch default_gdb_exit
2519 }
2520
2521 #
2522 # gdb_load_cmd -- load a file into the debugger.
2523 #                 ARGS - additional args to load command.
2524 #                 return a -1 if anything goes wrong.
2525 #
2526 proc gdb_load_cmd { args } {
2527     global gdb_prompt
2528
2529     if [target_info exists gdb_load_timeout] {
2530         set loadtimeout [target_info gdb_load_timeout]
2531     } else {
2532         set loadtimeout 1600
2533     }
2534     send_gdb "load $args\n"
2535     verbose "Timeout is now $loadtimeout seconds" 2
2536     gdb_expect $loadtimeout {
2537         -re "Loading section\[^\r\]*\r\n" {
2538             exp_continue
2539         }
2540         -re "Start address\[\r\]*\r\n" {
2541             exp_continue
2542         }
2543         -re "Transfer rate\[\r\]*\r\n" {
2544             exp_continue
2545         }
2546         -re "Memory access error\[^\r\]*\r\n" {
2547             perror "Failed to load program"
2548             return -1
2549         }
2550         -re "$gdb_prompt $" {
2551             return 0
2552         }
2553         -re "(.*)\r\n$gdb_prompt " {
2554             perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
2555             return -1
2556         }
2557         timeout {
2558             perror "Timed out trying to load $args."
2559             return -1
2560         }
2561     }
2562     return -1
2563 }
2564
2565 # Return the filename to download to the target and load on the target
2566 # for this shared library.  Normally just LIBNAME, unless shared libraries
2567 # for this target have separate link and load images.
2568
2569 proc shlib_target_file { libname } {
2570     return $libname
2571 }
2572
2573 # Return the filename GDB will load symbols from when debugging this
2574 # shared library.  Normally just LIBNAME, unless shared libraries for
2575 # this target have separate link and load images.
2576
2577 proc shlib_symbol_file { libname } {
2578     return $libname
2579 }
2580
2581 # gdb_download
2582 #
2583 # Copy a file to the remote target and return its target filename.
2584 # Schedule the file to be deleted at the end of this test.
2585
2586 proc gdb_download { filename } {
2587     global cleanfiles
2588
2589     set destname [remote_download target $filename]
2590     lappend cleanfiles $destname
2591     return $destname
2592 }
2593
2594 # gdb_load_shlibs LIB...
2595 #
2596 # Copy the listed libraries to the target.
2597
2598 proc gdb_load_shlibs { args } {
2599     if {![is_remote target]} {
2600         return
2601     }
2602
2603     foreach file $args {
2604         gdb_download [shlib_target_file $file]
2605     }
2606
2607     # Even if the target supplies full paths for shared libraries,
2608     # they may not be paths for this system.
2609     gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" ""
2610 }
2611
2612 #
2613 # gdb_load -- load a file into the debugger.
2614 # Many files in config/*.exp override this procedure.
2615 #
2616 proc gdb_load { arg } {
2617     return [gdb_file_cmd $arg]
2618 }
2619
2620 # gdb_reload -- load a file into the target.  Called before "running",
2621 # either the first time or after already starting the program once,
2622 # for remote targets.  Most files that override gdb_load should now
2623 # override this instead.
2624
2625 proc gdb_reload { } {
2626     # For the benefit of existing configurations, default to gdb_load.
2627     # Specifying no file defaults to the executable currently being
2628     # debugged.
2629     return [gdb_load ""]
2630 }
2631
2632 proc gdb_continue { function } {
2633     global decimal
2634
2635     return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
2636 }
2637
2638 proc default_gdb_init { args } {
2639     global gdb_wrapper_initialized
2640     global gdb_wrapper_target
2641     global cleanfiles
2642
2643     set cleanfiles {}
2644
2645     gdb_clear_suppressed;
2646
2647     # Make sure that the wrapper is rebuilt
2648     # with the appropriate multilib option.
2649     if { $gdb_wrapper_target != [current_target_name] } {
2650         set gdb_wrapper_initialized 0
2651     }
2652
2653     # Unlike most tests, we have a small number of tests that generate
2654     # a very large amount of output.  We therefore increase the expect
2655     # buffer size to be able to contain the entire test output.
2656     match_max -d 30000
2657     # Also set this value for the currently running GDB.
2658     match_max [match_max -d]
2659
2660     # We want to add the name of the TCL testcase to the PASS/FAIL messages.
2661     if { [llength $args] > 0 } {
2662         global pf_prefix
2663
2664         set file [lindex $args 0];
2665
2666         set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
2667     }
2668     global gdb_prompt;
2669     if [target_info exists gdb_prompt] {
2670         set gdb_prompt [target_info gdb_prompt];
2671     } else {
2672         set gdb_prompt "\\(gdb\\)"
2673     }
2674 }
2675
2676 # The default timeout used when testing GDB commands.  We want to use
2677 # the same timeout as the default dejagnu timeout, unless the user has
2678 # already provided a specific value (probably through a site.exp file).
2679 global gdb_test_timeout
2680 if ![info exists gdb_test_timeout] {
2681     set gdb_test_timeout $timeout
2682 }
2683
2684 # A list of global variables that GDB testcases should not use.
2685 # We try to prevent their use by monitoring write accesses and raising
2686 # an error when that happens.
2687 set banned_variables { bug_id prms_id }
2688
2689 # gdb_init is called by runtest at start, but also by several
2690 # tests directly; gdb_finish is only called from within runtest after
2691 # each test source execution.
2692 # Placing several traces by repetitive calls to gdb_init leads
2693 # to problems, as only one trace is removed in gdb_finish.
2694 # To overcome this possible problem, we add a variable that records
2695 # if the banned variables are traced.
2696 set banned_variables_traced 0
2697
2698 proc gdb_init { args } {
2699     # Reset the timeout value to the default.  This way, any testcase
2700     # that changes the timeout value without resetting it cannot affect
2701     # the timeout used in subsequent testcases.
2702     global gdb_test_timeout
2703     global timeout
2704     set timeout $gdb_test_timeout
2705
2706     # Block writes to all banned variables...
2707     global banned_variables
2708     global banned_variables_traced
2709     if (!$banned_variables_traced) {
2710         foreach banned_var $banned_variables {
2711             global "$banned_var"
2712             trace add variable "$banned_var" write error
2713         }
2714         set banned_variables_traced 1
2715     }
2716
2717     # We set LC_ALL and LANG to C so that we get the same messages as
2718     # expected.
2719     setenv LC_ALL C
2720     setenv LANG C
2721
2722     return [eval default_gdb_init $args];
2723 }
2724
2725 proc gdb_finish { } {
2726     global cleanfiles
2727
2728     # Exit first, so that the files are no longer in use.
2729     gdb_exit
2730
2731     if { [llength $cleanfiles] > 0 } {
2732         eval remote_file target delete $cleanfiles
2733         set cleanfiles {}
2734     }
2735
2736     # Unblock write access to the banned variables.  Dejagnu typically
2737     # resets some of them between testcases.
2738     global banned_variables
2739     global banned_variables_traced
2740     if ($banned_variables_traced) {
2741         foreach banned_var $banned_variables {
2742             global "$banned_var"
2743             trace remove variable "$banned_var" write error
2744         }
2745         set banned_variables_traced 0
2746     }
2747 }
2748
2749 global debug_format
2750 set debug_format "unknown"
2751
2752 # Run the gdb command "info source" and extract the debugging format
2753 # information from the output and save it in debug_format.
2754
2755 proc get_debug_format { } {
2756     global gdb_prompt
2757     global verbose
2758     global expect_out
2759     global debug_format
2760
2761     set debug_format "unknown"
2762     send_gdb "info source\n"
2763     gdb_expect 10 {
2764         -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
2765             set debug_format $expect_out(1,string)
2766             verbose "debug format is $debug_format"
2767             return 1;
2768         }
2769         -re "No current source file.\r\n$gdb_prompt $" {
2770             perror "get_debug_format used when no current source file"
2771             return 0;
2772         }
2773         -re "$gdb_prompt $" {
2774             warning "couldn't check debug format (no valid response)."
2775             return 1;
2776         }
2777         timeout {
2778             warning "couldn't check debug format (timed out)."
2779             return 1;
2780         }
2781     }
2782 }
2783
2784 # Return true if FORMAT matches the debug format the current test was
2785 # compiled with.  FORMAT is a shell-style globbing pattern; it can use
2786 # `*', `[...]', and so on.
2787 #
2788 # This function depends on variables set by `get_debug_format', above.
2789
2790 proc test_debug_format {format} {
2791     global debug_format
2792
2793     return [expr [string match $format $debug_format] != 0]
2794 }
2795
2796 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
2797 # COFF, stabs, etc).  If that format matches the format that the
2798 # current test was compiled with, then the next test is expected to
2799 # fail for any target.  Returns 1 if the next test or set of tests is
2800 # expected to fail, 0 otherwise (or if it is unknown).  Must have
2801 # previously called get_debug_format.
2802 proc setup_xfail_format { format } {
2803     set ret [test_debug_format $format];
2804
2805     if {$ret} then {
2806         setup_xfail "*-*-*"
2807     }
2808     return $ret;
2809 }
2810
2811 proc gdb_step_for_stub { } {
2812     global gdb_prompt;
2813
2814     if ![target_info exists gdb,use_breakpoint_for_stub] {
2815         if [target_info exists gdb_stub_step_command] {
2816             set command [target_info gdb_stub_step_command];
2817         } else {
2818             set command "step";
2819         }
2820         send_gdb "${command}\n";
2821         set tries 0;
2822         gdb_expect 60 {
2823             -re "(main.* at |.*in .*start).*$gdb_prompt" {
2824                 return;
2825             }
2826             -re ".*$gdb_prompt" {
2827                 incr tries;
2828                 if { $tries == 5 } {
2829                     fail "stepping out of breakpoint function";
2830                     return;
2831                 }
2832                 send_gdb "${command}\n";
2833                 exp_continue;
2834             }
2835             default {
2836                 fail "stepping out of breakpoint function";
2837                 return;
2838             }
2839         }
2840     }
2841     send_gdb "where\n";
2842     gdb_expect {
2843         -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
2844             set file $expect_out(1,string);
2845             set linenum [expr $expect_out(2,string) + 1];
2846             set breakplace "${file}:${linenum}";
2847         }
2848         default {}
2849     }
2850     send_gdb "break ${breakplace}\n";
2851     gdb_expect 60 {
2852         -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
2853             set breakpoint $expect_out(1,string);
2854         }
2855         -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
2856             set breakpoint $expect_out(1,string);
2857         }
2858         default {}
2859     }
2860     send_gdb "continue\n";
2861     gdb_expect 60 {
2862         -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
2863             gdb_test "delete $breakpoint" ".*" "";
2864             return;
2865         }
2866         default {}
2867     }
2868 }
2869
2870 # gdb_get_line_number TEXT [FILE]
2871 #
2872 # Search the source file FILE, and return the line number of the
2873 # first line containing TEXT.  If no match is found, return -1.
2874 #
2875 # TEXT is a string literal, not a regular expression.
2876 #
2877 # The default value of FILE is "$srcdir/$subdir/$srcfile".  If FILE is
2878 # specified, and does not start with "/", then it is assumed to be in
2879 # "$srcdir/$subdir".  This is awkward, and can be fixed in the future,
2880 # by changing the callers and the interface at the same time.
2881 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
2882 # gdb.base/ena-dis-br.exp.
2883 #
2884 # Use this function to keep your test scripts independent of the
2885 # exact line numbering of the source file.  Don't write:
2886 #
2887 #   send_gdb "break 20"
2888 #
2889 # This means that if anyone ever edits your test's source file,
2890 # your test could break.  Instead, put a comment like this on the
2891 # source file line you want to break at:
2892 #
2893 #   /* breakpoint spot: frotz.exp: test name */
2894 #
2895 # and then write, in your test script (which we assume is named
2896 # frotz.exp):
2897 #
2898 #   send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
2899 #
2900 # (Yes, Tcl knows how to handle the nested quotes and brackets.
2901 # Try this:
2902 #       $ tclsh
2903 #       % puts "foo [lindex "bar baz" 1]"
2904 #       foo baz
2905 #       %
2906 # Tcl is quite clever, for a little stringy language.)
2907 #
2908 # ===
2909 #
2910 # The previous implementation of this procedure used the gdb search command.
2911 # This version is different:
2912 #
2913 #   . It works with MI, and it also works when gdb is not running.
2914 #
2915 #   . It operates on the build machine, not the host machine.
2916 #
2917 #   . For now, this implementation fakes a current directory of
2918 #     $srcdir/$subdir to be compatible with the old implementation.
2919 #     This will go away eventually and some callers will need to
2920 #     be changed.
2921 #
2922 #   . The TEXT argument is literal text and matches literally,
2923 #     not a regular expression as it was before.
2924 #
2925 #   . State changes in gdb, such as changing the current file
2926 #     and setting $_, no longer happen.
2927 #
2928 # After a bit of time we can forget about the differences from the
2929 # old implementation.
2930 #
2931 # --chastain 2004-08-05
2932
2933 proc gdb_get_line_number { text { file "" } } {
2934     global srcdir
2935     global subdir
2936     global srcfile
2937
2938     if { "$file" == "" } then {
2939         set file "$srcfile"
2940     }
2941     if { ! [regexp "^/" "$file"] } then {
2942         set file "$srcdir/$subdir/$file"
2943     }
2944
2945     if { [ catch { set fd [open "$file"] } message ] } then {
2946         perror "$message"
2947         return -1
2948     }
2949
2950     set found -1
2951     for { set line 1 } { 1 } { incr line } {
2952         if { [ catch { set nchar [gets "$fd" body] } message ] } then {
2953             perror "$message"
2954             return -1
2955         }
2956         if { $nchar < 0 } then {
2957             break
2958         }
2959         if { [string first "$text" "$body"] >= 0 } then {
2960             set found $line
2961             break
2962         }
2963     }
2964
2965     if { [ catch { close "$fd" } message ] } then {
2966         perror "$message"
2967         return -1
2968     }
2969
2970     return $found
2971 }
2972
2973 # gdb_continue_to_end:
2974 #       The case where the target uses stubs has to be handled specially. If a
2975 #       stub is used, we set a breakpoint at exit because we cannot rely on
2976 #       exit() behavior of a remote target.
2977 #
2978 # mssg is the error message that gets printed.
2979
2980 proc gdb_continue_to_end {mssg} {
2981   if [target_info exists use_gdb_stub] {
2982     if {![gdb_breakpoint "exit"]} {
2983       return 0
2984     }
2985     gdb_test "continue" "Continuing..*Breakpoint .*exit.*" \
2986       "continue until exit at $mssg"
2987   } else {
2988     # Continue until we exit.  Should not stop again.
2989     # Don't bother to check the output of the program, that may be
2990     # extremely tough for some remote systems.
2991     gdb_test "continue"\
2992       "Continuing.\[\r\n0-9\]+(... EXIT code 0\[\r\n\]+|Program exited normally\\.).*"\
2993       "continue until exit at $mssg"
2994   }
2995 }
2996
2997 proc rerun_to_main {} {
2998   global gdb_prompt
2999
3000   if [target_info exists use_gdb_stub] {
3001     gdb_run_cmd
3002     gdb_expect {
3003       -re ".*Breakpoint .*main .*$gdb_prompt $"\
3004               {pass "rerun to main" ; return 0}
3005       -re "$gdb_prompt $"\
3006               {fail "rerun to main" ; return 0}
3007       timeout {fail "(timeout) rerun to main" ; return 0}
3008     }
3009   } else {
3010     send_gdb "run\n"
3011     gdb_expect {
3012       -re "The program .* has been started already.*y or n. $" {
3013           send_gdb "y\n"
3014           exp_continue
3015       }
3016       -re "Starting program.*$gdb_prompt $"\
3017               {pass "rerun to main" ; return 0}
3018       -re "$gdb_prompt $"\
3019               {fail "rerun to main" ; return 0}
3020       timeout {fail "(timeout) rerun to main" ; return 0}
3021     }
3022   }
3023 }
3024
3025 # Print a message and return true if a test should be skipped
3026 # due to lack of floating point suport.
3027
3028 proc gdb_skip_float_test { msg } {
3029     if [target_info exists gdb,skip_float_tests] {
3030         verbose "Skipping test '$msg': no float tests.";
3031         return 1;
3032     }
3033     return 0;
3034 }
3035
3036 # Print a message and return true if a test should be skipped
3037 # due to lack of stdio support.
3038
3039 proc gdb_skip_stdio_test { msg } {
3040     if [target_info exists gdb,noinferiorio] {
3041         verbose "Skipping test '$msg': no inferior i/o.";
3042         return 1;
3043     }
3044     return 0;
3045 }
3046
3047 proc gdb_skip_bogus_test { msg } {
3048     return 0;
3049 }
3050
3051 # Return true if a test should be skipped due to lack of XML support
3052 # in the host GDB.
3053 # NOTE: This must be called while gdb is *not* running.
3054
3055 proc gdb_skip_xml_test { } {
3056     global gdb_prompt
3057     global srcdir
3058     global xml_missing_cached
3059
3060     if {[info exists xml_missing_cached]} {
3061         return $xml_missing_cached
3062     }
3063
3064     gdb_start
3065     set xml_missing_cached 0
3066     gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" {
3067         -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
3068             set xml_missing_cached 1
3069         }
3070         -re ".*$gdb_prompt $" { }
3071     }
3072     gdb_exit
3073     return $xml_missing_cached
3074 }
3075
3076 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
3077 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
3078 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
3079 # the name of a debuginfo only file. This file will be stored in the same
3080 # subdirectory.
3081
3082 # Functions for separate debug info testing
3083
3084 # starting with an executable:
3085 # foo --> original executable
3086
3087 # at the end of the process we have:
3088 # foo.stripped --> foo w/o debug info
3089 # foo.debug --> foo's debug info
3090 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
3091
3092 # Return the build-id hex string (usually 160 bits as 40 hex characters)
3093 # converted to the form: .build-id/ab/cdef1234...89.debug
3094 # Return "" if no build-id found.
3095 proc build_id_debug_filename_get { exec } {
3096     set tmp "${exec}-tmp"
3097     set objcopy_program [transform objcopy]
3098
3099     set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output]
3100     verbose "result is $result"
3101     verbose "output is $output"
3102     if {$result == 1} {
3103         return ""
3104     }
3105     set fi [open $tmp]
3106     fconfigure $fi -translation binary
3107     # Skip the NOTE header.
3108     read $fi 16
3109     set data [read $fi]
3110     close $fi
3111     file delete $tmp
3112     if ![string compare $data ""] then {
3113         return ""
3114     }
3115     # Convert it to hex.
3116     binary scan $data H* data
3117     regsub {^..} $data {\0/} data
3118     return ".build-id/${data}.debug";
3119 }
3120
3121 # Create stripped files for DEST, replacing it.  If ARGS is passed, it is a
3122 # list of optional flags.  The only currently supported flag is no-main,
3123 # which removes the symbol entry for main from the separate debug file.
3124 #
3125 # Function returns zero on success.  Function will return non-zero failure code
3126 # on some targets not supporting separate debug info (such as i386-msdos).
3127
3128 proc gdb_gnu_strip_debug { dest args } {
3129
3130     # Use the first separate debug info file location searched by GDB so the
3131     # run cannot be broken by some stale file searched with higher precedence.
3132     set debug_file "${dest}.debug"
3133
3134     set strip_to_file_program [transform strip]
3135     set objcopy_program [transform objcopy]
3136
3137     set debug_link [file tail $debug_file]
3138     set stripped_file "${dest}.stripped"
3139
3140     # Get rid of the debug info, and store result in stripped_file
3141     # something like gdb/testsuite/gdb.base/blah.stripped.
3142     set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
3143     verbose "result is $result"
3144     verbose "output is $output"
3145     if {$result == 1} {
3146       return 1
3147     }
3148
3149     # Workaround PR binutils/10802:
3150     # Preserve the 'x' bit also for PIEs (Position Independent Executables).
3151     set perm [file attributes ${dest} -permissions]
3152     file attributes ${stripped_file} -permissions $perm
3153
3154     # Get rid of everything but the debug info, and store result in debug_file
3155     # This will be in the .debug subdirectory, see above.
3156     set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
3157     verbose "result is $result"
3158     verbose "output is $output"
3159     if {$result == 1} {
3160       return 1
3161     }
3162
3163     # If no-main is passed, strip the symbol for main from the separate
3164     # file.  This is to simulate the behavior of elfutils's eu-strip, which
3165     # leaves the symtab in the original file only.  There's no way to get
3166     # objcopy or strip to remove the symbol table without also removing the
3167     # debugging sections, so this is as close as we can get.
3168     if { [llength $args] == 1 && [lindex $args 0] == "no-main" } {
3169         set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output]
3170         verbose "result is $result"
3171         verbose "output is $output"
3172         if {$result == 1} {
3173             return 1
3174         }
3175         file delete "${debug_file}"
3176         file rename "${debug_file}-tmp" "${debug_file}"
3177     }
3178
3179     # Link the two previous output files together, adding the .gnu_debuglink
3180     # section to the stripped_file, containing a pointer to the debug_file,
3181     # save the new file in dest.
3182     # This will be the regular executable filename, in the usual location.
3183     set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
3184     verbose "result is $result"
3185     verbose "output is $output"
3186     if {$result == 1} {
3187       return 1
3188     }
3189
3190     # Workaround PR binutils/10802:
3191     # Preserve the 'x' bit also for PIEs (Position Independent Executables).
3192     set perm [file attributes ${stripped_file} -permissions]
3193     file attributes ${dest} -permissions $perm
3194
3195     return 0
3196 }
3197
3198 # Test the output of GDB_COMMAND matches the pattern obtained
3199 # by concatenating all elements of EXPECTED_LINES.  This makes
3200 # it possible to split otherwise very long string into pieces.
3201 # If third argument is not empty, it's used as the name of the
3202 # test to be printed on pass/fail.
3203 proc help_test_raw { gdb_command expected_lines args } {
3204     set message $gdb_command
3205     if [llength $args]>0 then {
3206         set message [lindex $args 0]
3207     }
3208     set expected_output [join $expected_lines ""]
3209     gdb_test "${gdb_command}" "${expected_output}" $message
3210 }
3211
3212 # Test the output of "help COMMNAD_CLASS". EXPECTED_INITIAL_LINES
3213 # are regular expressions that should match the beginning of output,
3214 # before the list of commands in that class.  The presence of
3215 # command list and standard epilogue will be tested automatically.
3216 proc test_class_help { command_class expected_initial_lines args } {
3217     set l_stock_body {
3218         "List of commands\:.*\[\r\n\]+"
3219         "Type \"help\" followed by command name for full documentation\.\[\r\n\]+"
3220         "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+"
3221         "Command name abbreviations are allowed if unambiguous\."
3222     }
3223     set l_entire_body [concat $expected_initial_lines $l_stock_body]
3224
3225     eval [list help_test_raw "help ${command_class}" $l_entire_body] $args
3226 }
3227
3228 # COMMAND_LIST should have either one element -- command to test, or
3229 # two elements -- abbreviated command to test, and full command the first
3230 # element is abbreviation of.
3231 # The command must be a prefix command.  EXPECTED_INITIAL_LINES
3232 # are regular expressions that should match the beginning of output,
3233 # before the list of subcommands.  The presence of
3234 # subcommand list and standard epilogue will be tested automatically.
3235 proc test_prefix_command_help { command_list expected_initial_lines args } {
3236     set command [lindex $command_list 0]
3237     if {[llength $command_list]>1} {
3238         set full_command [lindex $command_list 1]
3239     } else {
3240         set full_command $command
3241     }
3242     # Use 'list' and not just {} because we want variables to
3243     # be expanded in this list.
3244     set l_stock_body [list\
3245          "List of $full_command subcommands\:.*\[\r\n\]+"\
3246          "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
3247          "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
3248          "Command name abbreviations are allowed if unambiguous\."]
3249     set l_entire_body [concat $expected_initial_lines $l_stock_body]
3250     if {[llength $args]>0} {
3251         help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
3252     } else {
3253         help_test_raw "help ${command}" $l_entire_body
3254     }
3255 }
3256
3257 # Build executable named EXECUTABLE, from SOURCES.  If SOURCES are not
3258 # provided, uses $EXECUTABLE.c.  The TESTNAME paramer is the name of test
3259 # to pass to untested, if something is wrong.  OPTIONS are passed
3260 # to gdb_compile directly.
3261 proc build_executable { testname executable {sources ""} {options {debug}} } {
3262
3263     global objdir
3264     global subdir
3265     global srcdir
3266     if {[llength $sources]==0} {
3267         set sources ${executable}.c
3268     }
3269
3270     set binfile ${objdir}/${subdir}/${executable}
3271
3272     set objects {}
3273     for {set i 0} "\$i<[llength $sources]" {incr i} {
3274         set s [lindex $sources $i]
3275         if  { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $options] != "" } {
3276             untested $testname
3277             return -1
3278         }
3279         lappend objects "${binfile}${i}.o"
3280     }
3281
3282     if  { [gdb_compile $objects "${binfile}" executable $options] != "" } {
3283         untested $testname
3284         return -1
3285     }
3286
3287     set info_options ""
3288     if { [lsearch -exact $options "c++"] >= 0 } {
3289         set info_options "c++"
3290     }
3291     if [get_compiler_info ${binfile} ${info_options}] {
3292         return -1
3293     }
3294     return 0
3295 }
3296
3297 # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is
3298 # the name of binary in ${objdir}/${subdir}.
3299 proc clean_restart { executable } {
3300     global srcdir
3301     global objdir
3302     global subdir
3303     set binfile ${objdir}/${subdir}/${executable}
3304
3305     gdb_exit
3306     gdb_start
3307     gdb_reinitialize_dir $srcdir/$subdir
3308     gdb_load ${binfile}
3309
3310     if [target_info exists gdb_stub] {
3311         gdb_step_for_stub;
3312     }
3313 }
3314
3315 # Prepares for testing, by calling build_executable, and then clean_restart.
3316 # Please refer to build_executable for parameter description.
3317 proc prepare_for_testing { testname executable {sources ""} {options {debug}}} {
3318
3319     if {[build_executable $testname $executable $sources $options] == -1} {
3320         return -1
3321     }
3322     clean_restart $executable
3323
3324     return 0
3325 }
3326
3327 proc get_valueof { fmt exp default } {
3328     global gdb_prompt
3329
3330     set test "get valueof \"${exp}\""
3331     set val ${default}
3332     gdb_test_multiple "print${fmt} ${exp}" "$test" {
3333         -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" {
3334             set val $expect_out(1,string)
3335             pass "$test ($val)"
3336         }
3337         timeout {
3338             fail "$test (timeout)"
3339         }
3340     }
3341     return ${val}
3342 }
3343
3344 proc get_integer_valueof { exp default } {
3345     global gdb_prompt
3346
3347     set test "get integer valueof \"${exp}\""
3348     set val ${default}
3349     gdb_test_multiple "print /d ${exp}" "$test" {
3350         -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" {
3351             set val $expect_out(1,string)
3352             pass "$test ($val)"
3353         }
3354         timeout {
3355             fail "$test (timeout)"
3356         }
3357     }
3358     return ${val}
3359 }
3360
3361 proc get_hexadecimal_valueof { exp default } {
3362     global gdb_prompt
3363     send_gdb "print /x ${exp}\n"
3364     set test "get hexadecimal valueof \"${exp}\""
3365     gdb_expect {
3366         -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" {
3367             set val $expect_out(1,string)
3368             pass "$test"
3369         }
3370         timeout {
3371             set val ${default}
3372             fail "$test (timeout)"
3373         }
3374     }
3375     return ${val}
3376 }
3377
3378 proc get_sizeof { type default } {
3379     return [get_integer_valueof "sizeof (${type})" $default]
3380 }
3381
3382 # Log gdb command line and script if requested.
3383 if {[info exists TRANSCRIPT]} {
3384   rename send_gdb real_send_gdb
3385   rename remote_spawn real_remote_spawn
3386   rename remote_close real_remote_close
3387
3388   global gdb_transcript
3389   set gdb_transcript ""
3390
3391   global gdb_trans_count
3392   set gdb_trans_count 1
3393
3394   proc remote_spawn {args} {
3395     global gdb_transcript gdb_trans_count outdir
3396
3397     if {$gdb_transcript != ""} {
3398       close $gdb_transcript
3399     }
3400     set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
3401     puts $gdb_transcript [lindex $args 1]
3402     incr gdb_trans_count
3403
3404     return [uplevel real_remote_spawn $args]
3405   }
3406
3407   proc remote_close {args} {
3408     global gdb_transcript
3409
3410     if {$gdb_transcript != ""} {
3411       close $gdb_transcript
3412       set gdb_transcript ""
3413     }
3414
3415     return [uplevel real_remote_close $args]
3416   }
3417
3418   proc send_gdb {args} {
3419     global gdb_transcript
3420
3421     if {$gdb_transcript != ""} {
3422       puts -nonewline $gdb_transcript [lindex $args 0]
3423     }
3424
3425     return [uplevel real_send_gdb $args]
3426   }
3427 }
3428
3429 proc core_find {binfile {deletefiles {}} {arg ""}} {
3430     global objdir subdir
3431
3432     set destcore "$binfile.core"
3433     file delete $destcore
3434
3435     # Create a core file named "$destcore" rather than just "core", to
3436     # avoid problems with sys admin types that like to regularly prune all
3437     # files named "core" from the system.
3438     #
3439     # Arbitrarily try setting the core size limit to "unlimited" since
3440     # this does not hurt on systems where the command does not work and
3441     # allows us to generate a core on systems where it does.
3442     #
3443     # Some systems append "core" to the name of the program; others append
3444     # the name of the program to "core"; still others (like Linux, as of
3445     # May 2003) create cores named "core.PID".  In the latter case, we
3446     # could have many core files lying around, and it may be difficult to
3447     # tell which one is ours, so let's run the program in a subdirectory.
3448     set found 0
3449     set coredir "${objdir}/${subdir}/coredir.[getpid]"
3450     file mkdir $coredir
3451     catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
3452     #      remote_exec host "${binfile}"
3453     foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
3454         if [remote_file build exists $i] {
3455             remote_exec build "mv $i $destcore"
3456             set found 1
3457         }
3458     }
3459     # Check for "core.PID".
3460     if { $found == 0 } {
3461         set names [glob -nocomplain -directory $coredir core.*]
3462         if {[llength $names] == 1} {
3463             set corefile [file join $coredir [lindex $names 0]]
3464             remote_exec build "mv $corefile $destcore"
3465             set found 1
3466         }
3467     }
3468     if { $found == 0 } {
3469         # The braindamaged HPUX shell quits after the ulimit -c above
3470         # without executing ${binfile}.  So we try again without the
3471         # ulimit here if we didn't find a core file above.
3472         # Oh, I should mention that any "braindamaged" non-Unix system has
3473         # the same problem. I like the cd bit too, it's really neat'n stuff.
3474         catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\""
3475         foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
3476             if [remote_file build exists $i] {
3477                 remote_exec build "mv $i $destcore"
3478                 set found 1
3479             }
3480         }
3481     }
3482
3483     # Try to clean up after ourselves.
3484     foreach deletefile $deletefiles {
3485         remote_file build delete [file join $coredir $deletefile]
3486     }
3487     remote_exec build "rmdir $coredir"
3488
3489     if { $found == 0  } {
3490         warning "can't generate a core file - core tests suppressed - check ulimit -c"
3491         return ""
3492     }
3493     return $destcore
3494 }