gdb/testsuite/lib/gdb.exp

   1 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000
   2 # 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 2 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, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18 # Please email any bugs, comments, and/or additions to this file to:
  19 # bug-gdb@prep.ai.mit.edu
  20
  21 # This file was written by Fred Fish. (fnf@cygnus.com)
  22
  23 # Generic gdb subroutines that should work for any target.  If these
  24 # need to be modified for any target, it can be done with a variable
  25 # or by passing arguments.
  26
  27 load_lib libgloss.exp
  28
  29 global GDB
  30 # OBSOLETE global CHILL_LIB
  31 # OBSOLETE global CHILL_RT0
  32
  33 # OBSOLETE if ![info exists CHILL_LIB] {
  34 # OBSOLETE     set CHILL_LIB [findfile $base_dir/../../gcc/ch/runtime/libchill.a "$base_dir/../../gcc/ch/runtime/libchill.a" [transform -lchill]]
  35 # OBSOLETE }
  36 # OBSOLETE verbose "using CHILL_LIB = $CHILL_LIB" 2
  37 # OBSOLETE if ![info exists CHILL_RT0] {
  38 # OBSOLETE     set CHILL_RT0 [findfile $base_dir/../../gcc/ch/runtime/chillrt0.o "$base_dir/../../gcc/ch/runtime/chillrt0.o" ""]
  39 # OBSOLETE }
  40 # OBSOLETE verbose "using CHILL_RT0 = $CHILL_RT0" 2
  41
  42 if [info exists TOOL_EXECUTABLE] {
  43     set GDB $TOOL_EXECUTABLE;
  44 }
  45 if ![info exists GDB] {
  46     if ![is_remote host] {
  47         set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
  48     } else {
  49         set GDB [transform gdb];
  50     }
  51 }
  52 verbose "using GDB = $GDB" 2
  53
  54 global GDBFLAGS
  55 if ![info exists GDBFLAGS] {
  56     set GDBFLAGS "-nx"
  57 }
  58 verbose "using GDBFLAGS = $GDBFLAGS" 2
  59
  60 # The variable gdb_prompt is a regexp which matches the gdb prompt.
  61 # Set it if it is not already set.
  62 global gdb_prompt
  63 if ![info exists gdb_prompt] then {
  64     set gdb_prompt "\[(\]gdb\[)\]"
  65 }
  66
  67 # Needed for some tests under Cygwin.
  68 global EXEEXT
  69 global env
  70
  71 if ![info exists env(EXEEXT)] {
  72     set EXEEXT ""
  73 } else {
  74     set EXEEXT $env(EXEEXT)
  75 }
  76
  77 ### Only procedures should come after this point.
  78
  79 #
  80 # gdb_version -- extract and print the version number of GDB
  81 #
  82 proc default_gdb_version {} {
  83     global GDB
  84     global GDBFLAGS
  85     global gdb_prompt
  86     set fileid [open "gdb_cmd" w];
  87     puts $fileid "q";
  88     close $fileid;
  89     set cmdfile [remote_download host "gdb_cmd"];
  90     set output [remote_exec host "$GDB -nw --command $cmdfile"]
  91     remote_file build delete "gdb_cmd";
  92     remote_file host delete "$cmdfile";
  93     set tmp [lindex $output 1];
  94     set version ""
  95     regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
  96     if ![is_remote host] {
  97         clone_output "[which $GDB] version $version $GDBFLAGS\n"
  98     } else {
  99         clone_output "$GDB on remote host version $version $GDBFLAGS\n"
 100     }
 101 }
 102
 103 proc gdb_version { } {
 104     return [default_gdb_version];
 105 }
 106
 107 #
 108 # gdb_unload -- unload a file if one is loaded
 109 #
 110
 111 proc gdb_unload {} {
 112     global verbose
 113     global GDB
 114     global gdb_prompt
 115     send_gdb "file\n"
 116     gdb_expect 60 {
 117         -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
 118         -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
 119         -re "A program is being debugged already..*Kill it.*y or n. $"\
 120             { send_gdb "y\n"
 121                 verbose "\t\tKilling previous program being debugged"
 122             exp_continue
 123         }
 124         -re "Discard symbol table from .*y or n.*$" {
 125             send_gdb "y\n"
 126             exp_continue
 127         }
 128         -re "$gdb_prompt $" {}
 129         timeout {
 130             perror "couldn't unload file in $GDB (timed out)."
 131             return -1
 132         }
 133     }
 134 }
 135
 136 # Many of the tests depend on setting breakpoints at various places and
 137 # running until that breakpoint is reached.  At times, we want to start
 138 # with a clean-slate with respect to breakpoints, so this utility proc
 139 # lets us do this without duplicating this code everywhere.
 140 #
 141
 142 proc delete_breakpoints {} {
 143     global gdb_prompt
 144
 145     # we need a larger timeout value here or this thing just confuses
 146     # itself.  May need a better implementation if possible. - guo
 147     #
 148     send_gdb "delete breakpoints\n"
 149     gdb_expect 100 {
 150          -re "Delete all breakpoints.*y or n.*$" {
 151             send_gdb "y\n";
 152             exp_continue
 153         }
 154          -re "$gdb_prompt $" { # This happens if there were no breakpoints
 155             }
 156          timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
 157     }
 158     send_gdb "info breakpoints\n"
 159     gdb_expect 100 {
 160          -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
 161          -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
 162          -re "Delete all breakpoints.*or n.*$" {
 163             send_gdb "y\n";
 164             exp_continue
 165         }
 166          timeout { perror "info breakpoints (timeout)" ; return }
 167     }
 168 }
 169
 170
 171 #
 172 # Generic run command.
 173 #
 174 # The second pattern below matches up to the first newline *only*.
 175 # Using ``.*$'' could swallow up output that we attempt to match
 176 # elsewhere.
 177 #
 178 proc gdb_run_cmd {args} {
 179     global gdb_prompt
 180
 181     if [target_info exists gdb_init_command] {
 182         send_gdb "[target_info gdb_init_command]\n";
 183         gdb_expect 30 {
 184             -re "$gdb_prompt $" { }
 185             default {
 186                 perror "gdb_init_command for target failed";
 187                 return;
 188             }
 189         }
 190     }
 191
 192     if [target_info exists use_gdb_stub] {
 193         if [target_info exists gdb,do_reload_on_run] {
 194             # Specifying no file, defaults to the executable
 195             # currently being debugged.
 196             if { [gdb_load ""] < 0 } {
 197                 return;
 198             }
 199             send_gdb "continue\n";
 200             gdb_expect 60 {
 201                 -re "Continu\[^\r\n\]*\[\r\n\]" {}
 202                 default {}
 203             }
 204             return;
 205         }
 206
 207         if [target_info exists gdb,start_symbol] {
 208             set start [target_info gdb,start_symbol];
 209         } else {
 210             set start "start";
 211         }
 212         send_gdb  "jump *$start\n"
 213         set start_attempt 1;
 214         while { $start_attempt } {
 215             # Cap (re)start attempts at three to ensure that this loop
 216             # always eventually fails.  Don't worry about trying to be
 217             # clever and not send a command when it has failed.
 218             if [expr $start_attempt > 3] {
 219                 perror "Jump to start() failed (retry count exceeded)";
 220                 return;
 221             }
 222             set start_attempt [expr $start_attempt + 1];
 223             gdb_expect 30 {
 224                 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
 225                     set start_attempt 0;
 226                 }
 227                 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
 228                     perror "Can't find start symbol to run in gdb_run";
 229                     return;
 230                 }
 231                 -re "No symbol \"start\" in current.*$gdb_prompt $" {
 232                     send_gdb "jump *_start\n";
 233                 }
 234                 -re "No symbol.*context.*$gdb_prompt $" {
 235                     set start_attempt 0;
 236                 }
 237                 -re "Line.* Jump anyway.*y or n. $" {
 238                     send_gdb "y\n"
 239                 }
 240                 -re "The program is not being run.*$gdb_prompt $" {
 241                     if { [gdb_load ""] < 0 } {
 242                         return;
 243                     }
 244                     send_gdb "jump *$start\n";
 245                 }
 246                 timeout {
 247                     perror "Jump to start() failed (timeout)";
 248                     return
 249                 }
 250             }
 251         }
 252         if [target_info exists gdb_stub] {
 253             gdb_expect 60 {
 254                 -re "$gdb_prompt $" {
 255                     send_gdb "continue\n"
 256                 }
 257             }
 258         }
 259         return
 260     }
 261     send_gdb "run $args\n"
 262 # This doesn't work quite right yet.
 263     gdb_expect 60 {
 264         -re "The program .* has been started already.*y or n. $" {
 265             send_gdb "y\n"
 266             exp_continue
 267         }
 268         -re "Starting program: \[^\r\n\]*" {}
 269     }
 270 }
 271
 272 proc gdb_breakpoint { function } {
 273     global gdb_prompt
 274     global decimal
 275
 276     send_gdb "break $function\n"
 277     # The first two regexps are what we get with -g, the third is without -g.
 278     gdb_expect 30 {
 279         -re "Breakpoint \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 280         -re "Breakpoint \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 281         -re "Breakpoint \[0-9\]* at .*$gdb_prompt $" {}
 282         -re "$gdb_prompt $" { fail "setting breakpoint at $function" ; return 0 }
 283         timeout { fail "setting breakpoint at $function (timeout)" ; return 0 }
 284     }
 285     return 1;
 286 }
 287
 288 # Set breakpoint at function and run gdb until it breaks there.
 289 # Since this is the only breakpoint that will be set, if it stops
 290 # at a breakpoint, we will assume it is the one we want.  We can't
 291 # just compare to "function" because it might be a fully qualified,
 292 # single quoted C++ function specifier.
 293
 294 proc runto { function } {
 295     global gdb_prompt
 296     global decimal
 297
 298     delete_breakpoints
 299
 300     if ![gdb_breakpoint $function] {
 301         return 0;
 302     }
 303
 304     gdb_run_cmd
 305
 306     # the "at foo.c:36" output we get with -g.
 307     # the "in func" output we get without -g.
 308     gdb_expect 30 {
 309         -re "Break.* at .*:$decimal.*$gdb_prompt $" {
 310             return 1
 311         }
 312         -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
 313             return 1
 314         }
 315         -re "$gdb_prompt $" {
 316             fail "running to $function in runto"
 317             return 0
 318         }
 319         timeout {
 320             fail "running to $function in runto (timeout)"
 321             return 0
 322         }
 323     }
 324     return 1
 325 }
 326
 327 #
 328 # runto_main -- ask gdb to run until we hit a breakpoint at main.
 329 #               The case where the target uses stubs has to be handled
 330 #               specially--if it uses stubs, assuming we hit
 331 #               breakpoint() and just step out of the function.
 332 #
 333 proc runto_main { } {
 334     global gdb_prompt
 335     global decimal
 336
 337     if ![target_info exists gdb_stub] {
 338         return [runto main]
 339     }
 340
 341     delete_breakpoints
 342
 343     gdb_step_for_stub;
 344
 345     return 1
 346 }
 347
 348
 349 ### Continue, and expect to hit a breakpoint.
 350 ### Report a pass or fail, depending on whether it seems to have
 351 ### worked.  Use NAME as part of the test name; each call to
 352 ### continue_to_breakpoint should use a NAME which is unique within
 353 ### that test file.
 354 proc gdb_continue_to_breakpoint {name} {
 355     global gdb_prompt
 356     set full_name "continue to breakpoint: $name"
 357
 358     send_gdb "continue\n"
 359     gdb_expect {
 360         -re "Breakpoint .* at .*\r\n$gdb_prompt $" {
 361             pass $full_name
 362         }
 363         -re ".*$gdb_prompt $" {
 364             fail $full_name
 365         }
 366         timeout {
 367             fail "$full_name (timeout)"
 368         }
 369     }
 370 }
 371
 372
 373
 374 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
 375 # Send a command to gdb; test the result.
 376 #
 377 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 378 #   this is the null string no command is sent.
 379 # PATTERN is the pattern to match for a PASS, and must NOT include
 380 #   the \r\n sequence immediately before the gdb prompt.
 381 # MESSAGE is an optional message to be printed.  If this is
 382 #   omitted, then the pass/fail messages use the command string as the
 383 #   message.  (If this is the empty string, then sometimes we don't
 384 #   call pass or fail at all; I don't understand this at all.)
 385 # QUESTION is a question GDB may ask in response to COMMAND, like
 386 #   "are you sure?"
 387 # RESPONSE is the response to send if QUESTION appears.
 388 #
 389 # Returns:
 390 #    1 if the test failed,
 391 #    0 if the test passes,
 392 #   -1 if there was an internal error.
 393 #
 394 proc gdb_test { args } {
 395     global verbose
 396     global gdb_prompt
 397     global GDB
 398     upvar timeout timeout
 399
 400     if [llength $args]>2 then {
 401         set message [lindex $args 2]
 402     } else {
 403         set message [lindex $args 0]
 404     }
 405     set command [lindex $args 0]
 406     set pattern [lindex $args 1]
 407
 408     if [llength $args]==5 {
 409         set question_string [lindex $args 3];
 410         set response_string [lindex $args 4];
 411     } else {
 412         set question_string "^FOOBAR$"
 413     }
 414
 415     if $verbose>2 then {
 416         send_user "Sending \"$command\" to gdb\n"
 417         send_user "Looking to match \"$pattern\"\n"
 418         send_user "Message is \"$message\"\n"
 419     }
 420
 421     set result -1
 422     set string "${command}\n";
 423     if { $command != "" } {
 424         while { "$string" != "" } {
 425             set foo [string first "\n" "$string"];
 426             set len [string length "$string"];
 427             if { $foo < [expr $len - 1] } {
 428                 set str [string range "$string" 0 $foo];
 429                 if { [send_gdb "$str"] != "" } {
 430                     global suppress_flag;
 431
 432                     if { ! $suppress_flag } {
 433                         perror "Couldn't send $command to GDB.";
 434                     }
 435                     fail "$message";
 436                     return $result;
 437                 }
 438                 # since we're checking if each line of the multi-line
 439                 # command are 'accepted' by GDB here,
 440                 # we need to set -notransfer expect option so that
 441                 # command output is not lost for pattern matching
 442                 # - guo
 443                 gdb_expect 2 {
 444                     -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
 445                     timeout { verbose "partial: timeout" 3 }
 446                 }
 447                 set string [string range "$string" [expr $foo + 1] end];
 448             } else {
 449                 break;
 450             }
 451         }
 452         if { "$string" != "" } {
 453             if { [send_gdb "$string"] != "" } {
 454                 global suppress_flag;
 455
 456                 if { ! $suppress_flag } {
 457                     perror "Couldn't send $command to GDB.";
 458                 }
 459                 fail "$message";
 460                 return $result;
 461             }
 462         }
 463     }
 464
 465     if [target_info exists gdb,timeout] {
 466         set tmt [target_info gdb,timeout];
 467     } else {
 468         if [info exists timeout] {
 469             set tmt $timeout;
 470         } else {
 471             global timeout;
 472             if [info exists timeout] {
 473                 set tmt $timeout;
 474             } else {
 475                 set tmt 60;
 476             }
 477         }
 478     }
 479     gdb_expect $tmt {
 480          -re "\\*\\*\\* DOSEXIT code.*" {
 481              if { $message != "" } {
 482                  fail "$message";
 483              }
 484              gdb_suppress_entire_file "GDB died";
 485              return -1;
 486          }
 487          -re "Ending remote debugging.*$gdb_prompt $" {
 488             if ![isnative] then {
 489                 warning "Can`t communicate to remote target."
 490             }
 491             gdb_exit
 492             gdb_start
 493             set result -1
 494         }
 495          -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
 496             if ![string match "" $message] then {
 497                 pass "$message"
 498             }
 499             set result 0
 500         }
 501          -re "(${question_string})$" {
 502             send_gdb "$response_string\n";
 503             exp_continue;
 504         }
 505          -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
 506             perror "Undefined command \"$command\"."
 507             fail "$message"
 508             set result 1
 509         }
 510          -re "Ambiguous command.*$gdb_prompt $" {
 511             perror "\"$command\" is not a unique command name."
 512             fail "$message"
 513             set result 1
 514         }
 515          -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
 516             if ![string match "" $message] then {
 517                 set errmsg "$message: the program exited"
 518             } else {
 519                 set errmsg "$command: the program exited"
 520             }
 521             fail "$errmsg"
 522             return -1
 523         }
 524          -re "EXIT code \[0-9\r\n\]+Program exited normally.*$gdb_prompt $" {
 525             if ![string match "" $message] then {
 526                 set errmsg "$message: the program exited"
 527             } else {
 528                 set errmsg "$command: the program exited"
 529             }
 530             fail "$errmsg"
 531             return -1
 532         }
 533          -re "The program is not being run.*$gdb_prompt $" {
 534             if ![string match "" $message] then {
 535                 set errmsg "$message: the program is no longer running"
 536             } else {
 537                 set errmsg "$command: the program is no longer running"
 538             }
 539             fail "$errmsg"
 540             return -1
 541         }
 542          -re ".*$gdb_prompt $" {
 543             if ![string match "" $message] then {
 544                 fail "$message"
 545             }
 546             set result 1
 547         }
 548          "<return>" {
 549             send_gdb "\n"
 550             perror "Window too small."
 551             fail "$message"
 552         }
 553          -re "\\(y or n\\) " {
 554             send_gdb "n\n"
 555             perror "Got interactive prompt."
 556             fail "$message"
 557         }
 558          eof {
 559              perror "Process no longer exists"
 560              if { $message != "" } {
 561                  fail "$message"
 562              }
 563              return -1
 564         }
 565          full_buffer {
 566             perror "internal buffer is full."
 567             fail "$message"
 568         }
 569         timeout {
 570             if ![string match "" $message] then {
 571                 fail "$message (timeout)"
 572             }
 573             set result 1
 574         }
 575     }
 576     return $result
 577 }
 578 \f
 579 # Test that a command gives an error.  For pass or fail, return
 580 # a 1 to indicate that more tests can proceed.  However a timeout
 581 # is a serious error, generates a special fail message, and causes
 582 # a 0 to be returned to indicate that more tests are likely to fail
 583 # as well.
 584
 585 proc test_print_reject { args } {
 586     global gdb_prompt
 587     global verbose
 588
 589     if [llength $args]==2 then {
 590         set expectthis [lindex $args 1]
 591     } else {
 592         set expectthis "should never match this bogus string"
 593     }
 594     set sendthis [lindex $args 0]
 595     if $verbose>2 then {
 596         send_user "Sending \"$sendthis\" to gdb\n"
 597         send_user "Looking to match \"$expectthis\"\n"
 598     }
 599     send_gdb "$sendthis\n"
 600     #FIXME: Should add timeout as parameter.
 601     gdb_expect {
 602         -re "A .* in expression.*\\.*$gdb_prompt $" {
 603             pass "reject $sendthis"
 604             return 1
 605         }
 606         -re "Invalid syntax in expression.*$gdb_prompt $" {
 607             pass "reject $sendthis"
 608             return 1
 609         }
 610         -re "Junk after end of expression.*$gdb_prompt $" {
 611             pass "reject $sendthis"
 612             return 1
 613         }
 614         -re "Invalid number.*$gdb_prompt $" {
 615             pass "reject $sendthis"
 616             return 1
 617         }
 618         -re "Invalid character constant.*$gdb_prompt $" {
 619             pass "reject $sendthis"
 620             return 1
 621         }
 622         -re "No symbol table is loaded.*$gdb_prompt $" {
 623             pass "reject $sendthis"
 624             return 1
 625         }
 626         -re "No symbol .* in current context.*$gdb_prompt $" {
 627             pass "reject $sendthis"
 628             return 1
 629         }
 630         -re "Unmatched single quote.*$gdb_prompt $" {
 631             pass "reject $sendthis"
 632             return 1
 633         }
 634         -re "A character constant must contain at least one character.*$gdb_prompt $" {
 635             pass "reject $sendthis"
 636             return 1
 637         }
 638         -re "$expectthis.*$gdb_prompt $" {
 639             pass "reject $sendthis"
 640             return 1
 641         }
 642         -re ".*$gdb_prompt $" {
 643             fail "reject $sendthis"
 644             return 1
 645         }
 646         default {
 647             fail "reject $sendthis (eof or timeout)"
 648             return 0
 649         }
 650     }
 651 }
 652 \f
 653 # Given an input string, adds backslashes as needed to create a
 654 # regexp that will match the string.
 655
 656 proc string_to_regexp {str} {
 657     set result $str
 658     regsub -all {[]*+.|()^$\[]} $str {\\&} result
 659     return $result
 660 }
 661
 662 # Same as gdb_test, but the second parameter is not a regexp,
 663 # but a string that must match exactly.
 664
 665 proc gdb_test_exact { args } {
 666     upvar timeout timeout
 667
 668     set command [lindex $args 0]
 669
 670     # This applies a special meaning to a null string pattern.  Without
 671     # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
 672     # messages from commands that should have no output except a new
 673     # prompt.  With this, only results of a null string will match a null
 674     # string pattern.
 675
 676     set pattern [lindex $args 1]
 677     if [string match $pattern ""] {
 678         set pattern [string_to_regexp [lindex $args 0]]
 679     } else {
 680         set pattern [string_to_regexp [lindex $args 1]]
 681     }
 682
 683     # It is most natural to write the pattern argument with only
 684     # embedded \n's, especially if you are trying to avoid Tcl quoting
 685     # problems.  But gdb_expect really wants to see \r\n in patterns.  So
 686     # transform the pattern here.  First transform \r\n back to \n, in
 687     # case some users of gdb_test_exact already do the right thing.
 688     regsub -all "\r\n" $pattern "\n" pattern
 689     regsub -all "\n" $pattern "\r\n" pattern
 690     if [llength $args]==3 then {
 691         set message [lindex $args 2]
 692     } else {
 693         set message $command
 694     }
 695
 696     return [gdb_test $command $pattern $message]
 697 }
 698 \f
 699 proc gdb_reinitialize_dir { subdir } {
 700     global gdb_prompt
 701
 702     if [is_remote host] {
 703         return "";
 704     }
 705     send_gdb "dir\n"
 706     gdb_expect 60 {
 707         -re "Reinitialize source path to empty.*y or n. " {
 708             send_gdb "y\n"
 709             gdb_expect 60 {
 710                 -re "Source directories searched.*$gdb_prompt $" {
 711                     send_gdb "dir $subdir\n"
 712                     gdb_expect 60 {
 713                         -re "Source directories searched.*$gdb_prompt $" {
 714                             verbose "Dir set to $subdir"
 715                         }
 716                         -re "$gdb_prompt $" {
 717                             perror "Dir \"$subdir\" failed."
 718                         }
 719                     }
 720                 }
 721                 -re "$gdb_prompt $" {
 722                     perror "Dir \"$subdir\" failed."
 723                 }
 724             }
 725         }
 726         -re "$gdb_prompt $" {
 727             perror "Dir \"$subdir\" failed."
 728         }
 729     }
 730 }
 731
 732 #
 733 # gdb_exit -- exit the GDB, killing the target program if necessary
 734 #
 735 proc default_gdb_exit {} {
 736     global GDB
 737     global GDBFLAGS
 738     global verbose
 739     global gdb_spawn_id;
 740
 741     gdb_stop_suppressing_tests;
 742
 743     if ![info exists gdb_spawn_id] {
 744         return;
 745     }
 746
 747     verbose "Quitting $GDB $GDBFLAGS"
 748
 749     if { [is_remote host] && [board_info host exists fileid] } {
 750         send_gdb "quit\n";
 751         gdb_expect 10 {
 752             -re "y or n" {
 753                 send_gdb "y\n";
 754                 exp_continue;
 755             }
 756             -re "DOSEXIT code" { }
 757             default { }
 758         }
 759     }
 760
 761     if ![is_remote host] {
 762         remote_close host;
 763     }
 764     unset gdb_spawn_id
 765 }
 766
 767 #
 768 # load a file into the debugger.
 769 # return a -1 if anything goes wrong.
 770 #
 771 proc gdb_file_cmd { arg } {
 772     global verbose
 773     global loadpath
 774     global loadfile
 775     global GDB
 776     global gdb_prompt
 777     upvar timeout timeout
 778
 779     if [is_remote host] {
 780         set arg [remote_download host $arg];
 781         if { $arg == "" } {
 782             error "download failed"
 783             return -1;
 784         }
 785     }
 786
 787     send_gdb "file $arg\n"
 788     gdb_expect 120 {
 789         -re "Reading symbols from.*done.*$gdb_prompt $" {
 790             verbose "\t\tLoaded $arg into the $GDB"
 791             return 0
 792         }
 793         -re "has no symbol-table.*$gdb_prompt $" {
 794             perror "$arg wasn't compiled with \"-g\""
 795             return -1
 796         }
 797         -re "A program is being debugged already.*Kill it.*y or n. $" {
 798             send_gdb "y\n"
 799                 verbose "\t\tKilling previous program being debugged"
 800             exp_continue
 801         }
 802         -re "Load new symbol table from \".*\".*y or n. $" {
 803             send_gdb "y\n"
 804             gdb_expect 120 {
 805                 -re "Reading symbols from.*done.*$gdb_prompt $" {
 806                     verbose "\t\tLoaded $arg with new symbol table into $GDB"
 807                     return 0
 808                 }
 809                 timeout {
 810                     perror "(timeout) Couldn't load $arg, other program already loaded."
 811                     return -1
 812                 }
 813             }
 814         }
 815         -re "No such file or directory.*$gdb_prompt $" {
 816             perror "($arg) No such file or directory\n"
 817             return -1
 818         }
 819         -re "$gdb_prompt $" {
 820             perror "couldn't load $arg into $GDB."
 821             return -1
 822             }
 823         timeout {
 824             perror "couldn't load $arg into $GDB (timed out)."
 825             return -1
 826         }
 827         eof {
 828             # This is an attempt to detect a core dump, but seems not to
 829             # work.  Perhaps we need to match .* followed by eof, in which
 830             # gdb_expect does not seem to have a way to do that.
 831             perror "couldn't load $arg into $GDB (end of file)."
 832             return -1
 833         }
 834     }
 835 }
 836
 837 #
 838 # start gdb -- start gdb running, default procedure
 839 #
 840 # When running over NFS, particularly if running many simultaneous
 841 # tests on different hosts all using the same server, things can
 842 # get really slow.  Give gdb at least 3 minutes to start up.
 843 #
 844 proc default_gdb_start { } {
 845     global verbose
 846     global GDB
 847     global GDBFLAGS
 848     global gdb_prompt
 849     global timeout
 850     global gdb_spawn_id;
 851
 852     gdb_stop_suppressing_tests;
 853
 854     verbose "Spawning $GDB -nw $GDBFLAGS"
 855
 856     if [info exists gdb_spawn_id] {
 857         return 0;
 858     }
 859
 860     if ![is_remote host] {
 861         if { [which $GDB] == 0 } then {
 862             perror "$GDB does not exist."
 863             exit 1
 864         }
 865     }
 866     set res [remote_spawn host "$GDB -nw $GDBFLAGS [host_info gdb_opts]"];
 867     if { $res < 0 || $res == "" } {
 868         perror "Spawning $GDB failed."
 869         return 1;
 870     }
 871     gdb_expect 360 {
 872         -re "\[\r\n\]$gdb_prompt $" {
 873             verbose "GDB initialized."
 874         }
 875         -re "$gdb_prompt $"     {
 876             perror "GDB never initialized."
 877             return -1
 878         }
 879         timeout {
 880             perror "(timeout) GDB never initialized after 10 seconds."
 881             remote_close host;
 882             return -1
 883         }
 884     }
 885     set gdb_spawn_id -1;
 886     # force the height to "unlimited", so no pagers get used
 887
 888     send_gdb "set height 0\n"
 889     gdb_expect 10 {
 890         -re "$gdb_prompt $" {
 891             verbose "Setting height to 0." 2
 892         }
 893         timeout {
 894             warning "Couldn't set the height to 0"
 895         }
 896     }
 897     # force the width to "unlimited", so no wraparound occurs
 898     send_gdb "set width 0\n"
 899     gdb_expect 10 {
 900         -re "$gdb_prompt $" {
 901             verbose "Setting width to 0." 2
 902         }
 903         timeout {
 904             warning "Couldn't set the width to 0."
 905         }
 906     }
 907     return 0;
 908 }
 909
 910 # Return a 1 for configurations for which we don't even want to try to
 911 # test C++.
 912
 913 proc skip_cplus_tests {} {
 914     if { [istarget "d10v-*-*"] } {
 915         return 1
 916     }
 917     if { [istarget "h8300-*-*"] } {
 918         return 1
 919     }
 920     return 0
 921 }
 922
 923 # OBSOLETE # * For crosses, the CHILL runtime doesn't build because it
 924 # OBSOLETE # can't find setjmp.h, stdio.h, etc.
 925 # OBSOLETE # * For AIX (as of 16 Mar 95), (a) there is no language code for
 926 # OBSOLETE # CHILL in output_epilog in gcc/config/rs6000/rs6000.c, (b) collect2
 927 # OBSOLETE # does not get along with AIX's too-clever linker.
 928 # OBSOLETE # * On Irix5, there is a bug whereby set of bool, etc., don't get
 929 # OBSOLETE # TYPE_LOW_BOUND for the bool right because force_to_range_type doesn't
 930 # OBSOLETE # work with stub types.
 931 # OBSOLETE # Lots of things seem to fail on the PA, and since it's not a supported
 932 # OBSOLETE # chill target at the moment, don't run the chill tests.
 933
 934 # OBSOLETE proc skip_chill_tests {} {
 935 # OBSOLETE     if ![info exists do_chill_tests] {
 936 # OBSOLETE      return 1;
 937 # OBSOLETE     }
 938 # OBSOLETE     eval set skip_chill [expr ![isnative] || [istarget "*-*-aix*"] || [istarget "*-*-irix5*"] || [istarget "*-*-irix6*"] || [istarget "alpha-*-osf*"] || [istarget "hppa*-*-*"]]
 939 # OBSOLETE     verbose "Skip chill tests is $skip_chill"
 940 # OBSOLETE     return $skip_chill
 941 # OBSOLETE }
 942
 943 # Skip all the tests in the file if you are not on an hppa running
 944 # hpux target.
 945
 946 proc skip_hp_tests {} {
 947     eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
 948     verbose "Skip hp tests is $skip_hp"
 949     return $skip_hp
 950 }
 951
 952 proc get_compiler_info {binfile args} {
 953     # Create and source the file that provides information about the compiler
 954     # used to compile the test case.
 955     # Compiler_type can be null or c++. If null we assume c.
 956     global srcdir
 957     global subdir
 958     # These two come from compiler.c.
 959     global signed_keyword_not_used
 960     global gcc_compiled
 961
 962     if {![istarget "hppa*-*-hpux*"] && ![istarget "mips*-*-irix*"]} {
 963         if { [llength $args] > 0 } {
 964             if {$args == "c++"} {
 965                 if { [gdb_compile "${srcdir}/lib/compiler.cc" "${binfile}.ci" preprocess {}] != "" } {
 966                     perror "Couldn't make ${binfile}.ci file"
 967                     return 1;
 968                 }
 969             }
 970         } else {
 971             if { [gdb_compile "${srcdir}/lib/compiler.c" "${binfile}.ci" preprocess {}] != "" } {
 972                 perror "Couldn't make ${binfile}.ci file"
 973                 return 1;
 974             }
 975         }
 976     } else {
 977         if { [llength $args] > 0 } {
 978             if {$args == "c++"} {
 979                 if { [eval gdb_preprocess \
 980                         [list "${srcdir}/lib/compiler.cc" "${binfile}.ci"] \
 981                         $args] != "" } {
 982                     perror "Couldn't make ${binfile}.ci file"
 983                     return 1;
 984                 }
 985             }
 986         } elseif { $args != "f77" } {
 987             if { [eval gdb_preprocess \
 988                     [list "${srcdir}/lib/compiler.c" "${binfile}.ci"] \
 989                     $args] != "" } {
 990                 perror "Couldn't make ${binfile}.ci file"
 991                 return 1;
 992             }
 993         }
 994     }
 995
 996     uplevel \#0 { set gcc_compiled 0 }
 997
 998     if { [llength $args] == 0 || $args != "f77" } {
 999         source ${binfile}.ci
1000     }
1001
1002     # Most compilers will evaluate comparisons and other boolean
1003     # operations to 0 or 1.
1004     uplevel \#0 { set true 1 }
1005     uplevel \#0 { set false 0 }
1006
1007     uplevel \#0 { set hp_cc_compiler 0 }
1008     uplevel \#0 { set hp_aCC_compiler 0 }
1009     uplevel \#0 { set hp_f77_compiler 0 }
1010     uplevel \#0 { set hp_f90_compiler 0 }
1011     if { !$gcc_compiled && [istarget "hppa*-*-hpux*"] } {
1012         # Check for the HP compilers
1013         set compiler [lindex [split [get_compiler $args] " "] 0]
1014         catch "exec what $compiler" output
1015         if [regexp ".*HP aC\\+\\+.*" $output] {
1016             uplevel \#0 { set hp_aCC_compiler 1 }
1017             # Use of aCC results in boolean results being displayed as
1018             # "true" or "false"
1019             uplevel \#0 { set true true }
1020             uplevel \#0 { set false false }
1021         } elseif [regexp ".*HP C Compiler.*" $output] {
1022             uplevel \#0 { set hp_cc_compiler 1 }
1023         } elseif [regexp ".*HP-UX f77.*" $output] {
1024             uplevel \#0 { set hp_f77_compiler 1 }
1025         } elseif [regexp ".*HP-UX f90.*" $output] {
1026             uplevel \#0 { set hp_f90_compiler 1 }
1027         }
1028     }
1029
1030     return 0;
1031 }
1032
1033 proc get_compiler {args} {
1034     global CC CC_FOR_TARGET CXX CXX_FOR_TARGET F77_FOR_TARGET
1035
1036     if { [llength $args] == 0
1037          || ([llength $args] == 1 && [lindex $args 0] == "") } {
1038         set which_compiler "c"
1039     } else {
1040         if { $args =="c++" } {
1041             set which_compiler "c++"
1042         } elseif { $args =="f77" } {
1043             set which_compiler "f77"
1044         } else {
1045             perror "Unknown compiler type supplied to gdb_preprocess"
1046             return ""
1047         }
1048     }
1049
1050     if [info exists CC_FOR_TARGET] {
1051         if {$which_compiler == "c"} {
1052             set compiler $CC_FOR_TARGET
1053         }
1054     }
1055
1056     if [info exists CXX_FOR_TARGET] {
1057         if {$which_compiler == "c++"} {
1058             set compiler $CXX_FOR_TARGET
1059         }
1060     }
1061
1062     if [info exists F77_FOR_TARGET] {
1063         if {$which_compiler == "f77"} {
1064             set compiler $F77_FOR_TARGET
1065         }
1066     }
1067
1068     if { ![info exists compiler] } {
1069         if { $which_compiler == "c" } {
1070             if {[info exists CC]} {
1071                 set compiler $CC
1072             }
1073         }
1074         if { $which_compiler == "c++" } {
1075             if {[info exists CXX]} {
1076                 set compiler $CXX
1077             }
1078         }
1079         if {![info exists compiler]} {
1080             set compiler [board_info [target_info name] compiler];
1081             if { $compiler == "" } {
1082                 perror "get_compiler: No compiler found"
1083                 return ""
1084             }
1085         }
1086     }
1087
1088     return $compiler
1089 }
1090
1091 proc gdb_preprocess {source dest args} {
1092     set compiler [get_compiler "$args"]
1093     if { $compiler == "" } {
1094         return 1
1095     }
1096
1097     set cmdline "$compiler -E $source > $dest"
1098
1099     verbose "Invoking $compiler -E $source > $dest"
1100     verbose -log "Executing on local host: $cmdline" 2
1101     set status [catch "exec ${cmdline}" exec_output]
1102
1103     set result [prune_warnings $exec_output]
1104     regsub "\[\r\n\]*$" "$result" "" result;
1105     regsub "^\[\r\n\]*" "$result" "" result;
1106     if { $result != "" } {
1107         clone_output "gdb compile failed, $result"
1108     }
1109     return $result;
1110 }
1111
1112 set gdb_wrapper_initialized 0
1113
1114 proc gdb_wrapper_init { args } {
1115     global gdb_wrapper_initialized;
1116     global gdb_wrapper_file;
1117     global gdb_wrapper_flags;
1118
1119     if { $gdb_wrapper_initialized == 1 } { return; }
1120
1121     if {[target_info exists needs_status_wrapper] && \
1122             [target_info needs_status_wrapper] != "0"} {
1123         set result [build_wrapper "testglue.o"];
1124         if { $result != "" } {
1125             set gdb_wrapper_file [lindex $result 0];
1126             set gdb_wrapper_flags [lindex $result 1];
1127         } else {
1128             warning "Status wrapper failed to build."
1129         }
1130     }
1131     set gdb_wrapper_initialized 1
1132 }
1133
1134 proc gdb_compile {source dest type options} {
1135     global GDB_TESTCASE_OPTIONS;
1136     global gdb_wrapper_file;
1137     global gdb_wrapper_flags;
1138     global gdb_wrapper_initialized;
1139
1140     if [target_info exists gdb_stub] {
1141         set options2 { "additional_flags=-Dusestubs" }
1142         lappend options "libs=[target_info gdb_stub]";
1143         set options [concat $options2 $options]
1144     }
1145     if [target_info exists is_vxworks] {
1146         set options2 { "additional_flags=-Dvxworks" }
1147         lappend options "libs=[target_info gdb_stub]";
1148         set options [concat $options2 $options]
1149     }
1150     if [info exists GDB_TESTCASE_OPTIONS] {
1151         lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
1152     }
1153     verbose "options are $options"
1154     verbose "source is $source $dest $type $options"
1155
1156     if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
1157
1158     if {[target_info exists needs_status_wrapper] && \
1159             [target_info needs_status_wrapper] != "0" && \
1160             [info exists gdb_wrapper_file]} {
1161         lappend options "libs=${gdb_wrapper_file}"
1162         lappend options "ldflags=${gdb_wrapper_flags}"
1163     }
1164
1165     set result [target_compile $source $dest $type $options];
1166     regsub "\[\r\n\]*$" "$result" "" result;
1167     regsub "^\[\r\n\]*" "$result" "" result;
1168     if { $result != "" } {
1169         clone_output "gdb compile failed, $result"
1170     }
1171     return $result;
1172 }
1173
1174 proc send_gdb { string } {
1175     global suppress_flag;
1176     if { $suppress_flag } {
1177         return "suppressed";
1178     }
1179     return [remote_send host "$string"];
1180 }
1181
1182 #
1183 #
1184
1185 proc gdb_expect { args } {
1186     if { [llength $args] == 2  && [lindex $args 0] != "-re" } {
1187         set gtimeout [lindex $args 0];
1188         set expcode [list [lindex $args 1]];
1189     } else {
1190         upvar timeout timeout;
1191
1192         set expcode $args;
1193         if [target_info exists gdb,timeout] {
1194             if [info exists timeout] {
1195                 if { $timeout < [target_info gdb,timeout] } {
1196                     set gtimeout [target_info gdb,timeout];
1197                 } else {
1198                     set gtimeout $timeout;
1199                 }
1200             } else {
1201                 set gtimeout [target_info gdb,timeout];
1202             }
1203         }
1204
1205         if ![info exists gtimeout] {
1206             global timeout;
1207             if [info exists timeout] {
1208                 set gtimeout $timeout;
1209             } else {
1210                 # Eeeeew.
1211                 set gtimeout 60;
1212             }
1213         }
1214     }
1215     global suppress_flag;
1216     global remote_suppress_flag;
1217     if [info exists remote_suppress_flag] {
1218         set old_val $remote_suppress_flag;
1219     }
1220     if [info exists suppress_flag] {
1221         if { $suppress_flag } {
1222             set remote_suppress_flag 1;
1223         }
1224     }
1225     set code [catch \
1226         {uplevel remote_expect host $gtimeout $expcode} string];
1227     if [info exists old_val] {
1228         set remote_suppress_flag $old_val;
1229     } else {
1230         if [info exists remote_suppress_flag] {
1231             unset remote_suppress_flag;
1232         }
1233     }
1234
1235     if {$code == 1} {
1236         global errorInfo errorCode;
1237
1238         return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1239     } elseif {$code == 2} {
1240         return -code return $string
1241     } elseif {$code == 3} {
1242         return
1243     } elseif {$code > 4} {
1244         return -code $code $string
1245     }
1246 }
1247
1248 # gdb_expect_list MESSAGE SENTINEL LIST -- expect a sequence of outputs
1249 #
1250 # Check for long sequence of output by parts.
1251 # MESSAGE: is the test message to be printed with the test success/fail.
1252 # SENTINEL: Is the terminal pattern indicating that output has finished.
1253 # LIST: is the sequence of outputs to match.
1254 # If the sentinel is recognized early, it is considered an error.
1255 #
1256 # Returns:
1257 #    1 if the test failed,
1258 #    0 if the test passes,
1259 #   -1 if there was an internal error.
1260 #
1261 proc gdb_expect_list {test sentinel list} {
1262     global gdb_prompt
1263     global suppress_flag
1264     set index 0
1265     set ok 1
1266     if { $suppress_flag } {
1267         set ok 0
1268     }
1269     while { ${index} < [llength ${list}] } {
1270         set pattern [lindex ${list} ${index}]
1271         set index [expr ${index} + 1]
1272         if { ${index} == [llength ${list}] } {
1273             if { ${ok} } {
1274                 gdb_expect {
1275                     -re "${pattern}${sentinel}" {
1276                         pass "${test}, pattern ${index} + sentinel"
1277                     }
1278                     -re "${sentinel}" {
1279                         fail "${test}, pattern ${index} + sentinel"
1280                         set ok 0
1281                     }
1282                     timeout {
1283                         fail "${test}, pattern ${index} + sentinel (timeout)"
1284                         set ok 0
1285                     }
1286                 }
1287             } else {
1288                 unresolved "${test}, pattern ${index} + sentinel"
1289             }
1290         } else {
1291             if { ${ok} } {
1292                 gdb_expect {
1293                     -re "${pattern}" {
1294                         pass "${test}, pattern ${index}"
1295                     }
1296                     -re "${sentinel}" {
1297                         fail "${test}, pattern ${index}"
1298                         set ok 0
1299                     }
1300                     timeout {
1301                         fail "${test}, pattern ${index} (timeout)"
1302                         set ok 0
1303                     }
1304                 }
1305             } else {
1306                 unresolved "${test}, pattern ${index}"
1307             }
1308         }
1309     }
1310     if { ${ok} } {
1311         return 0
1312     } else {
1313         return 1
1314     }
1315 }
1316
1317 #
1318 #
1319 proc gdb_suppress_entire_file { reason } {
1320     global suppress_flag;
1321
1322     warning "$reason\n";
1323     set suppress_flag -1;
1324 }
1325
1326 #
1327 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
1328 # gdb_expect to fail immediately (until the next call to
1329 # gdb_stop_suppressing_tests).
1330 #
1331 proc gdb_suppress_tests { args } {
1332     global suppress_flag;
1333
1334     return;  # fnf - disable pending review of results where
1335              # testsuite ran better without this
1336     incr suppress_flag;
1337
1338     if { $suppress_flag == 1 } {
1339         if { [llength $args] > 0 } {
1340             warning "[lindex $args 0]\n";
1341         } else {
1342             warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
1343         }
1344     }
1345 }
1346
1347 #
1348 # Clear suppress_flag.
1349 #
1350 proc gdb_stop_suppressing_tests { } {
1351     global suppress_flag;
1352
1353     if [info exists suppress_flag] {
1354         if { $suppress_flag > 0 } {
1355             set suppress_flag 0;
1356             clone_output "Tests restarted.\n";
1357         }
1358     } else {
1359         set suppress_flag 0;
1360     }
1361 }
1362
1363 proc gdb_clear_suppressed { } {
1364     global suppress_flag;
1365
1366     set suppress_flag 0;
1367 }
1368
1369 proc gdb_start { } {
1370     default_gdb_start
1371 }
1372
1373 proc gdb_exit { } {
1374     catch default_gdb_exit
1375 }
1376
1377 #
1378 # gdb_load -- load a file into the debugger.
1379 #             return a -1 if anything goes wrong.
1380 #
1381 proc gdb_load { arg } {
1382     return [gdb_file_cmd $arg]
1383 }
1384
1385 proc gdb_continue { function } {
1386     global decimal
1387
1388     return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
1389 }
1390
1391 proc default_gdb_init { args } {
1392     global gdb_wrapper_initialized
1393
1394     gdb_clear_suppressed;
1395
1396     # Make sure that the wrapper is rebuilt
1397     # with the appropriate multilib option.
1398     set gdb_wrapper_initialized 0
1399
1400     # Uh, this is lame. Really, really, really lame. But there's this *one*
1401     # testcase that will fail in random places if we don't increase this.
1402     match_max -d 20000
1403
1404     # We want to add the name of the TCL testcase to the PASS/FAIL messages.
1405     if { [llength $args] > 0 } {
1406         global pf_prefix
1407
1408         set file [lindex $args 0];
1409
1410         set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
1411     }
1412     global gdb_prompt;
1413     if [target_info exists gdb_prompt] {
1414         set gdb_prompt [target_info gdb_prompt];
1415     } else {
1416         set gdb_prompt "\\(gdb\\)"
1417     }
1418 }
1419
1420 proc gdb_init { args } {
1421     return [eval default_gdb_init $args];
1422 }
1423
1424 proc gdb_finish { } {
1425     gdb_exit;
1426 }
1427
1428 global debug_format
1429 set debug_format "unknown"
1430
1431 # Run the gdb command "info source" and extract the debugging format
1432 # information from the output and save it in debug_format.
1433
1434 proc get_debug_format { } {
1435     global gdb_prompt
1436     global verbose
1437     global expect_out
1438     global debug_format
1439
1440     set debug_format "unknown"
1441     send_gdb "info source\n"
1442     gdb_expect 10 {
1443         -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
1444             set debug_format $expect_out(1,string)
1445             verbose "debug format is $debug_format"
1446             return 1;
1447         }
1448         -re "No current source file.\r\n$gdb_prompt $" {
1449             perror "get_debug_format used when no current source file"
1450             return 0;
1451         }
1452         -re "$gdb_prompt $" {
1453             warning "couldn't check debug format (no valid response)."
1454             return 1;
1455         }
1456         timeout {
1457             warning "couldn't check debug format (timed out)."
1458             return 1;
1459         }
1460     }
1461 }
1462
1463 # Return true if FORMAT matches the debug format the current test was
1464 # compiled with.  FORMAT is a shell-style globbing pattern; it can use
1465 # `*', `[...]', and so on.
1466 #
1467 # This function depends on variables set by `get_debug_format', above.
1468
1469 proc test_debug_format {format} {
1470     global debug_format
1471
1472     return [expr [string match $format $debug_format] != 0]
1473 }
1474
1475 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
1476 # COFF, stabs, etc).  If that format matches the format that the
1477 # current test was compiled with, then the next test is expected to
1478 # fail for any target.  Returns 1 if the next test or set of tests is
1479 # expected to fail, 0 otherwise (or if it is unknown).  Must have
1480 # previously called get_debug_format.
1481 proc setup_xfail_format { format } {
1482     set ret [test_debug_format $format];
1483
1484     if {$ret} then {
1485         setup_xfail "*-*-*"
1486     }
1487     return $ret;
1488 }
1489
1490 proc gdb_step_for_stub { } {
1491     global gdb_prompt;
1492
1493     if ![target_info exists gdb,use_breakpoint_for_stub] {
1494         if [target_info exists gdb_stub_step_command] {
1495             set command [target_info gdb_stub_step_command];
1496         } else {
1497             set command "step";
1498         }
1499         send_gdb "${command}\n";
1500         set tries 0;
1501         gdb_expect 60 {
1502             -re "(main.* at |.*in .*start).*$gdb_prompt" {
1503                 return;
1504             }
1505             -re ".*$gdb_prompt" {
1506                 incr tries;
1507                 if { $tries == 5 } {
1508                     fail "stepping out of breakpoint function";
1509                     return;
1510                 }
1511                 send_gdb "${command}\n";
1512                 exp_continue;
1513             }
1514             default {
1515                 fail "stepping out of breakpoint function";
1516                 return;
1517             }
1518         }
1519     }
1520     send_gdb "where\n";
1521     gdb_expect {
1522         -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
1523             set file $expect_out(1,string);
1524             set linenum [expr $expect_out(2,string) + 1];
1525             set breakplace "${file}:${linenum}";
1526         }
1527         default {}
1528     }
1529     send_gdb "break ${breakplace}\n";
1530     gdb_expect 60 {
1531         -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
1532             set breakpoint $expect_out(1,string);
1533         }
1534         -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
1535             set breakpoint $expect_out(1,string);
1536         }
1537         default {}
1538     }
1539     send_gdb "continue\n";
1540     gdb_expect 60 {
1541         -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
1542             gdb_test "delete $breakpoint" ".*" "";
1543             return;
1544         }
1545         default {}
1546     }
1547 }
1548
1549 ### gdb_get_line_number TEXT [FILE]
1550 ###
1551 ### Search the source file FILE, and return the line number of a line
1552 ### containing TEXT.  Use this function instead of hard-coding line
1553 ### numbers into your test script.
1554 ###
1555 ### Specifically, this function uses GDB's "search" command to search
1556 ### FILE for the first line containing TEXT, and returns its line
1557 ### number.  Thus, FILE must be a source file, compiled into the
1558 ### executable you are running.  If omitted, FILE defaults to the
1559 ### value of the global variable `srcfile'; most test scripts set
1560 ### `srcfile' appropriately at the top anyway.
1561 ###
1562 ### Use this function to keep your test scripts independent of the
1563 ### exact line numbering of the source file.  Don't write:
1564 ###
1565 ###   send_gdb "break 20"
1566 ###
1567 ### This means that if anyone ever edits your test's source file,
1568 ### your test could break.  Instead, put a comment like this on the
1569 ### source file line you want to break at:
1570 ###
1571 ###   /* breakpoint spot: frotz.exp: test name */
1572 ###
1573 ### and then write, in your test script (which we assume is named
1574 ### frotz.exp):
1575 ###
1576 ###   send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
1577 ###
1578 ### (Yes, Tcl knows how to handle the nested quotes and brackets.
1579 ### Try this:
1580 ###     $ tclsh
1581 ###     % puts "foo [lindex "bar baz" 1]"
1582 ###     foo baz
1583 ###     %
1584 ### Tcl is quite clever, for a little stringy language.)
1585
1586 proc gdb_get_line_number {text {file /omitted/}} {
1587     global gdb_prompt;
1588     global srcfile;
1589
1590     if {! [string compare $file /omitted/]} {
1591         set file $srcfile
1592     }
1593
1594     set result -1;
1595     gdb_test "list ${file}:1,1" ".*" ""
1596     send_gdb "search ${text}\n"
1597     gdb_expect {
1598         -re "\[\r\n\]+(\[0-9\]+)\[ \t\].*${text}.*$gdb_prompt $" {
1599             set result $expect_out(1,string)
1600         }
1601         -re ".*$gdb_prompt $" {
1602             fail "find line number containing \"${text}\""
1603         }
1604         timeout {
1605             fail "find line number containing \"${text}\" (timeout)"
1606         }
1607     }
1608     return $result;
1609 }
1610
1611 # gdb_continue_to_end:
1612 #       The case where the target uses stubs has to be handled specially. If a
1613 #       stub is used, we set a breakpoint at exit because we cannot rely on
1614 #       exit() behavior of a remote target.
1615 #
1616 # mssg is the error message that gets printed.
1617
1618 proc gdb_continue_to_end {mssg} {
1619   if [target_info exists use_gdb_stub] {
1620     if {![gdb_breakpoint "exit"]} {
1621       return 0
1622     }
1623     gdb_test "continue" "Continuing..*Breakpoint .*exit.*" \
1624       "continue until exit at $mssg"
1625   } else {
1626     # Continue until we exit.  Should not stop again.
1627     # Don't bother to check the output of the program, that may be
1628     # extremely tough for some remote systems.
1629     gdb_test "continue"\
1630       "Continuing.\[\r\n0-9\]+(... EXIT code 0\[\r\n\]+|)Program exited normally\\..*"\
1631       "continue until exit at $mssg"
1632   }
1633 }
1634
1635 proc rerun_to_main {} {
1636   global gdb_prompt
1637
1638   if [target_info exists use_gdb_stub] {
1639     gdb_run_cmd
1640     gdb_expect {
1641       -re ".*Breakpoint .*main .*$gdb_prompt $"\
1642               {pass "rerun to main" ; return 0}
1643       -re "$gdb_prompt $"\
1644               {fail "rerun to main" ; return 0}
1645       timeout {fail "(timeout) rerun to main" ; return 0}
1646     }
1647   } else {
1648     send_gdb "run\n"
1649     gdb_expect {
1650       -re "Starting program.*$gdb_prompt $"\
1651               {pass "rerun to main" ; return 0}
1652       -re "$gdb_prompt $"\
1653               {fail "rerun to main" ; return 0}
1654       timeout {fail "(timeout) rerun to main" ; return 0}
1655     }
1656   }
1657 }
1658
1659 # Print a message and return true if a test should be skipped
1660 # due to lack of floating point suport.
1661
1662 proc gdb_skip_float_test { msg } {
1663     if [target_info exists gdb,skip_float_tests] {
1664         verbose "Skipping test '$msg': no float tests.";
1665         return 1;
1666     }
1667     return 0;
1668 }
1669
1670 # Print a message and return true if a test should be skipped
1671 # due to lack of stdio support.
1672
1673 proc gdb_skip_stdio_test { msg } {
1674     if [target_info exists gdb,noinferiorio] {
1675         verbose "Skipping test '$msg': no inferior i/o.";
1676         return 1;
1677     }
1678     return 0;
1679 }
1680
1681 proc gdb_skip_bogus_test { msg } {
1682     return 0;
1683 }
1684