gdb/testsuite/lib/gdb.exp

   1 # Copyright (C) 1992, 1994, 1995, 1997 Free Software Foundation, Inc.
   2
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 2 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # Please email any bugs, comments, and/or additions to this file to:
  18 # bug-gdb@prep.ai.mit.edu
  19
  20 # This file was written by Fred Fish. (fnf@cygnus.com)
  21
  22 # Generic gdb subroutines that should work for any target.  If these
  23 # need to be modified for any target, it can be done with a variable
  24 # or by passing arguments.
  25
  26 load_lib libgloss.exp
  27
  28 global GDB
  29 global CHILL_LIB
  30 global CHILL_RT0
  31
  32 if ![info exists CHILL_LIB] {
  33     set CHILL_LIB [findfile $base_dir/../../gcc/ch/runtime/libchill.a "$base_dir/../../gcc/ch/runtime/libchill.a" [transform -lchill]]
  34 }
  35 verbose "using CHILL_LIB = $CHILL_LIB" 2
  36 if ![info exists CHILL_RT0] {
  37     set CHILL_RT0 [findfile $base_dir/../../gcc/ch/runtime/chillrt0.o "$base_dir/../../gcc/ch/runtime/chillrt0.o" ""]
  38 }
  39 verbose "using CHILL_RT0 = $CHILL_RT0" 2
  40
  41 if [info exists TOOL_EXECUTABLE] {
  42     set GDB $TOOL_EXECUTABLE;
  43 }
  44 if ![info exists GDB] {
  45     if ![is_remote host] {
  46         set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
  47     } else {
  48         set GDB [transform gdb];
  49     }
  50 }
  51 verbose "using GDB = $GDB" 2
  52
  53 global GDBFLAGS
  54 if ![info exists GDBFLAGS] {
  55     set GDBFLAGS "-nx"
  56 }
  57 verbose "using GDBFLAGS = $GDBFLAGS" 2
  58
  59 # The variable prompt is a regexp which matches the gdb prompt.  Set it if it
  60 # is not already set.
  61 global gdb_prompt
  62 if ![info exists prompt] then {
  63     set gdb_prompt "\[(\]gdb\[)\]"
  64 }
  65
  66 #
  67 # gdb_version -- extract and print the version number of GDB
  68 #
  69 proc default_gdb_version {} {
  70     global GDB
  71     global GDBFLAGS
  72     global gdb_prompt
  73     set fileid [open "gdb_cmd" w];
  74     puts $fileid "q";
  75     close $fileid;
  76     set cmdfile [remote_download host "gdb_cmd"];
  77     set output [remote_exec host "$GDB -nw --command $cmdfile"]
  78     remote_file build delete "gdb_cmd";
  79     remote_file host delete "$cmdfile";
  80     set tmp [lindex $output 1];
  81     set version ""
  82     regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version
  83     if ![is_remote host] {
  84         clone_output "[which $GDB] version $version $GDBFLAGS\n"
  85     } else {
  86         clone_output "$GDB on remote host version $version $GDBFLAGS\n"
  87     }
  88 }
  89
  90 proc gdb_version { } {
  91     return [default_gdb_version];
  92 }
  93
  94 #
  95 # gdb_unload -- unload a file if one is loaded
  96 #
  97
  98 proc gdb_unload {} {
  99     global verbose
 100     global GDB
 101     global gdb_prompt
 102     send_gdb "file\n"
 103     gdb_expect 60 {
 104         -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue }
 105         -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue }
 106         -re "A program is being debugged already..*Kill it.*y or n. $"\
 107             { send_gdb "y\n"
 108                 verbose "\t\tKilling previous program being debugged"
 109             exp_continue
 110         }
 111         -re "Discard symbol table from .*y or n.*$" {
 112             send_gdb "y\n"
 113             exp_continue
 114         }
 115         -re "$gdb_prompt $" {}
 116         timeout {
 117             perror "couldn't unload file in $GDB (timed out)."
 118             return -1
 119         }
 120     }
 121 }
 122
 123 # Many of the tests depend on setting breakpoints at various places and
 124 # running until that breakpoint is reached.  At times, we want to start
 125 # with a clean-slate with respect to breakpoints, so this utility proc
 126 # lets us do this without duplicating this code everywhere.
 127 #
 128
 129 proc delete_breakpoints {} {
 130     global gdb_prompt
 131
 132     send_gdb "delete breakpoints\n"
 133     gdb_expect 30 {
 134          -re "Delete all breakpoints.*y or n.*$" {
 135             send_gdb "y\n";
 136             exp_continue
 137         }
 138          -re "$gdb_prompt $" { # This happens if there were no breakpoints
 139             }
 140          timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
 141     }
 142     send_gdb "info breakpoints\n"
 143     gdb_expect 30 {
 144          -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
 145          -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
 146          -re "Delete all breakpoints.*or n.*$" {
 147             send_gdb "y\n";
 148             exp_continue
 149         }
 150          timeout { perror "info breakpoints (timeout)" ; return }
 151     }
 152 }
 153
 154
 155 #
 156 # Generic run command.
 157 #
 158 # The second pattern below matches up to the first newline *only*.
 159 # Using ``.*$'' could swallow up output that we attempt to match
 160 # elsewhere.
 161 #
 162 proc gdb_run_cmd {args} {
 163     global gdb_prompt
 164
 165     if [target_info exists gdb_init_command] {
 166         send_gdb "[target_info gdb_init_command]\n";
 167         gdb_expect 30 {
 168             -re "$gdb_prompt $" { }
 169             default {
 170                 perror "gdb_init_command for target failed";
 171                 return;
 172             }
 173         }
 174     }
 175
 176     if [target_info exists use_gdb_stub] {
 177         if [target_info exists gdb,do_reload_on_run] {
 178             # According to Stu, this will always work.
 179             gdb_load "";
 180             send_gdb "continue\n";
 181             gdb_expect 60 {
 182                 -re "Continu\[^\r\n\]*\[\r\n\]" {}
 183                 default {}
 184             }
 185             return;
 186         }
 187
 188         if [target_info exists gdb,start_symbol] {
 189             set start [target_info gdb,start_symbol];
 190         } else {
 191             set start "start";
 192         }
 193         send_gdb  "jump *$start\n"
 194         gdb_expect 30 {
 195             -re "Continuing at \[^\r\n\]*\[\r\n\]" {
 196                 if ![target_info exists gdb_stub] {
 197                     return;
 198                 }
 199             }
 200             -re "No symbol \"start\" in current.*$gdb_prompt $" {
 201                 send_gdb "jump *_start\n";
 202                 exp_continue;
 203             }
 204             -re "No symbol \"_start\" in current.*$gdb_prompt $" {
 205                 perror "Can't find start symbol to run in gdb_run";
 206                 return;
 207             }
 208             -re "Line.* Jump anyway.*y or n. $" {
 209                 send_gdb "y\n"
 210                 exp_continue;
 211             }
 212             -re "No symbol.*context.*$gdb_prompt $" {}
 213             -re "The program is not being run.*$gdb_prompt $" {
 214                 gdb_load "";
 215                 send_gdb "jump *$start\n";
 216                 exp_continue;
 217             }
 218             timeout { perror "Jump to start() failed (timeout)"; return }
 219         }
 220         if [target_info exists gdb_stub] {
 221             gdb_expect 60 {
 222                 -re "$gdb_prompt $" {
 223                     send_gdb "continue\n"
 224                 }
 225             }
 226         }
 227         return
 228     }
 229     send_gdb "run $args\n"
 230 # This doesn't work quite right yet.
 231     gdb_expect 60 {
 232         -re "The program .* has been started already.*y or n. $" {
 233             send_gdb "y\n"
 234             exp_continue
 235         }
 236         -re "Starting program: \[^\r\n\]*" {}
 237     }
 238 }
 239
 240 proc gdb_breakpoint { function } {
 241     global gdb_prompt
 242     global decimal
 243
 244     send_gdb "break $function\n"
 245     # The first two regexps are what we get with -g, the third is without -g.
 246     gdb_expect 30 {
 247         -re "Breakpoint \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 248         -re "Breakpoint \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 249         -re "Breakpoint \[0-9\]* at .*$gdb_prompt $" {}
 250         -re "$gdb_prompt $" { fail "setting breakpoint at $function" ; return 0 }
 251         timeout { fail "setting breakpoint at $function (timeout)" ; return 0 }
 252     }
 253     return 1;
 254 }
 255
 256 # Set breakpoint at function and run gdb until it breaks there.
 257 # Since this is the only breakpoint that will be set, if it stops
 258 # at a breakpoint, we will assume it is the one we want.  We can't
 259 # just compare to "function" because it might be a fully qualified,
 260 # single quoted C++ function specifier.
 261
 262 proc runto { function } {
 263     global gdb_prompt
 264     global decimal
 265
 266     delete_breakpoints
 267
 268     if ![gdb_breakpoint $function] {
 269         return 0;
 270     }
 271
 272     gdb_run_cmd
 273
 274     # the "at foo.c:36" output we get with -g.
 275     # the "in func" output we get without -g.
 276     gdb_expect 30 {
 277         -re "Break.* at .*:$decimal.*$gdb_prompt $" {
 278             return 1
 279         }
 280         -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
 281             return 1
 282         }
 283         -re "$gdb_prompt $" {
 284             fail "running to $function in runto"
 285             return 0
 286         }
 287         timeout {
 288             fail "running to $function in runto (timeout)"
 289             return 0
 290         }
 291     }
 292     return 1
 293 }
 294
 295 #
 296 # runto_main -- ask gdb to run until we hit a breakpoint at main.
 297 #               The case where the target uses stubs has to be handled
 298 #               specially--if it uses stubs, assuming we hit
 299 #               breakpoint() and just step out of the function.
 300 #
 301 proc runto_main { } {
 302     global gdb_prompt
 303     global decimal
 304
 305     if ![target_info exists gdb_stub] {
 306         return [runto main]
 307     }
 308
 309     delete_breakpoints
 310
 311     gdb_step_for_stub;
 312
 313     return 1
 314 }
 315
 316 # gdb_test COMMAND PATTERN MESSAGE -- send a command to gdb; test the result.
 317 #
 318 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 319 #   this is the null string no command is sent.
 320 # PATTERN is the pattern to match for a PASS, and must NOT include
 321 #   the \r\n sequence immediately before the gdb prompt.
 322 # MESSAGE is an optional message to be printed.  If this is
 323 #   omitted, then the pass/fail messages use the command string as the
 324 #   message.  (If this is the empty string, then sometimes we don't
 325 #   call pass or fail at all; I don't understand this at all.)
 326 #
 327 # Returns:
 328 #    1 if the test failed,
 329 #    0 if the test passes,
 330 #   -1 if there was an internal error.
 331 #
 332 proc gdb_test { args } {
 333     global verbose
 334     global gdb_prompt
 335     global GDB
 336     upvar timeout timeout
 337
 338     if [llength $args]>2 then {
 339         set message [lindex $args 2]
 340     } else {
 341         set message [lindex $args 0]
 342     }
 343     set command [lindex $args 0]
 344     set pattern [lindex $args 1]
 345
 346     if [llength $args]==5 {
 347         set question_string [lindex $args 3];
 348         set response_string [lindex $args 4];
 349     } else {
 350         set question_string "^FOOBAR$"
 351     }
 352
 353     if $verbose>2 then {
 354         send_user "Sending \"$command\" to gdb\n"
 355         send_user "Looking to match \"$pattern\"\n"
 356         send_user "Message is \"$message\"\n"
 357     }
 358
 359     set result -1
 360     set string "${command}\n";
 361     if { $command != "" } {
 362         while { "$string" != "" } {
 363             set foo [string first "\n" "$string"];
 364             set len [string length "$string"];
 365             if { $foo < [expr $len - 1] } {
 366                 set str [string range "$string" 0 $foo];
 367                 if { [send_gdb "$str"] != "" } {
 368                     global suppress_flag;
 369
 370                     if { ! $suppress_flag } {
 371                         perror "Couldn't send $command to GDB.";
 372                     }
 373                     fail "$message";
 374                     return $result;
 375                 }
 376                 gdb_expect 2 {
 377                     -re "\[\r\n\]" { }
 378                     timeout { }
 379                 }
 380                 set string [string range "$string" [expr $foo + 1] end];
 381             } else {
 382                 break;
 383             }
 384         }
 385         if { "$string" != "" } {
 386             if { [send_gdb "$string"] != "" } {
 387                 global suppress_flag;
 388
 389                 if { ! $suppress_flag } {
 390                     perror "Couldn't send $command to GDB.";
 391                 }
 392                 fail "$message";
 393                 return $result;
 394             }
 395         }
 396     }
 397
 398     if [info exists timeout] {
 399         set tmt $timeout;
 400     } else {
 401         global timeout;
 402         if [info exists timeout] {
 403             set tmt $timeout;
 404         } else {
 405             set tmt 60;
 406         }
 407     }
 408     gdb_expect $tmt {
 409          -re "\\*\\*\\* DOSEXIT code.*" {
 410              if { $message != "" } {
 411                  fail "$message";
 412              }
 413              gdb_suppress_entire_file "GDB died";
 414              return -1;
 415          }
 416          -re "Ending remote debugging.*$gdb_prompt$" {
 417             if ![isnative] then {
 418                 warning "Can`t communicate to remote target."
 419             }
 420             gdb_exit
 421             gdb_start
 422             set result -1
 423         }
 424          -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
 425             if ![string match "" $message] then {
 426                 pass "$message"
 427             }
 428             set result 0
 429         }
 430          -re "(${question_string})$" {
 431             send_gdb "$response_string\n";
 432             exp_continue;
 433         }
 434          -re "Undefined command:.*$gdb_prompt" {
 435             perror "Undefined command \"$command\"."
 436             set result 1
 437         }
 438          -re "Ambiguous command.*$gdb_prompt $" {
 439             perror "\"$command\" is not a unique command name."
 440             set result 1
 441         }
 442          -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
 443             if ![string match "" $message] then {
 444                 set errmsg "$message: the program exited"
 445             } else {
 446                 set errmsg "$command: the program exited"
 447             }
 448             fail "$errmsg"
 449             return -1
 450         }
 451          -re "The program is not being run.*$gdb_prompt $" {
 452             if ![string match "" $message] then {
 453                 set errmsg "$message: the program is no longer running"
 454             } else {
 455                 set errmsg "$command: the program is no longer running"
 456             }
 457             fail "$errmsg"
 458             return -1
 459         }
 460          -re ".*$gdb_prompt $" {
 461             if ![string match "" $message] then {
 462                 fail "$message"
 463             }
 464             set result 1
 465         }
 466          "<return>" {
 467             send_gdb "\n"
 468             perror "Window too small."
 469         }
 470          -re "\\(y or n\\) " {
 471             send_gdb "n\n"
 472             perror "Got interactive prompt."
 473         }
 474          eof {
 475              perror "Process no longer exists"
 476              if { $message != "" } {
 477                  fail "$message"
 478              }
 479              return -1
 480         }
 481          full_buffer {
 482             perror "internal buffer is full."
 483         }
 484         timeout {
 485             if ![string match "" $message] then {
 486                 fail "$message (timeout)"
 487             }
 488             set result 1
 489         }
 490     }
 491     return $result
 492 }
 493 \f
 494 # Test that a command gives an error.  For pass or fail, return
 495 # a 1 to indicate that more tests can proceed.  However a timeout
 496 # is a serious error, generates a special fail message, and causes
 497 # a 0 to be returned to indicate that more tests are likely to fail
 498 # as well.
 499
 500 proc test_print_reject { args } {
 501     global gdb_prompt
 502     global verbose
 503
 504     if [llength $args]==2 then {
 505         set expectthis [lindex $args 1]
 506     } else {
 507         set expectthis "should never match this bogus string"
 508     }
 509     set sendthis [lindex $args 0]
 510     if $verbose>2 then {
 511         send_user "Sending \"$sendthis\" to gdb\n"
 512         send_user "Looking to match \"$expectthis\"\n"
 513     }
 514     send_gdb "$sendthis\n"
 515     #FIXME: Should add timeout as parameter.
 516     gdb_expect {
 517         -re "A .* in expression.*\\.*$gdb_prompt $" {
 518             pass "reject $sendthis"
 519             return 1
 520         }
 521         -re "Invalid syntax in expression.*$gdb_prompt $" {
 522             pass "reject $sendthis"
 523             return 1
 524         }
 525         -re "Junk after end of expression.*$gdb_prompt $" {
 526             pass "reject $sendthis"
 527             return 1
 528         }
 529         -re "Invalid number.*$gdb_prompt $" {
 530             pass "reject $sendthis"
 531             return 1
 532         }
 533         -re "Invalid character constant.*$gdb_prompt $" {
 534             pass "reject $sendthis"
 535             return 1
 536         }
 537         -re "No symbol table is loaded.*$gdb_prompt $" {
 538             pass "reject $sendthis"
 539             return 1
 540         }
 541         -re "No symbol .* in current context.*$gdb_prompt $" {
 542             pass "reject $sendthis"
 543             return 1
 544         }
 545         -re "$expectthis.*$gdb_prompt $" {
 546             pass "reject $sendthis"
 547             return 1
 548         }
 549         -re ".*$gdb_prompt $" {
 550             fail "reject $sendthis"
 551             return 1
 552         }
 553         default {
 554             fail "reject $sendthis (eof or timeout)"
 555             return 0
 556         }
 557     }
 558 }
 559 \f
 560 # Given an input string, adds backslashes as needed to create a
 561 # regexp that will match the string.
 562
 563 proc string_to_regexp {str} {
 564     set result $str
 565     regsub -all {[]*+.|()^$\[]} $str {\\&} result
 566     return $result
 567 }
 568
 569 # Same as gdb_test, but the second parameter is not a regexp,
 570 # but a string that must match exactly.
 571
 572 proc gdb_test_exact { args } {
 573     upvar timeout timeout
 574
 575     set command [lindex $args 0]
 576
 577     # This applies a special meaning to a null string pattern.  Without
 578     # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
 579     # messages from commands that should have no output except a new
 580     # prompt.  With this, only results of a null string will match a null
 581     # string pattern.
 582
 583     set pattern [lindex $args 1]
 584     if [string match $pattern ""] {
 585         set pattern [string_to_regexp [lindex $args 0]]
 586     } else {
 587         set pattern [string_to_regexp [lindex $args 1]]
 588     }
 589
 590     # It is most natural to write the pattern argument with only
 591     # embedded \n's, especially if you are trying to avoid Tcl quoting
 592     # problems.  But gdb_expect really wants to see \r\n in patterns.  So
 593     # transform the pattern here.  First transform \r\n back to \n, in
 594     # case some users of gdb_test_exact already do the right thing.
 595     regsub -all "\r\n" $pattern "\n" pattern
 596     regsub -all "\n" $pattern "\r\n" pattern
 597     if [llength $args]==3 then {
 598         set message [lindex $args 2]
 599     } else {
 600         set message $command
 601     }
 602
 603     return [gdb_test $command $pattern $message]
 604 }
 605 \f
 606 proc gdb_reinitialize_dir { subdir } {
 607     global gdb_prompt
 608
 609     if [is_remote host] {
 610         return "";
 611     }
 612     send_gdb "dir\n"
 613     gdb_expect 60 {
 614         -re "Reinitialize source path to empty.*y or n. " {
 615             send_gdb "y\n"
 616             gdb_expect 60 {
 617                 -re "Source directories searched.*$gdb_prompt $" {
 618                     send_gdb "dir $subdir\n"
 619                     gdb_expect 60 {
 620                         -re "Source directories searched.*$gdb_prompt $" {
 621                             verbose "Dir set to $subdir"
 622                         }
 623                         -re "$gdb_prompt $" {
 624                             perror "Dir \"$subdir\" failed."
 625                         }
 626                     }
 627                 }
 628                 -re "$gdb_prompt $" {
 629                     perror "Dir \"$subdir\" failed."
 630                 }
 631             }
 632         }
 633         -re "$gdb_prompt $" {
 634             perror "Dir \"$subdir\" failed."
 635         }
 636     }
 637 }
 638
 639 #
 640 # gdb_exit -- exit the GDB, killing the target program if necessary
 641 #
 642 proc default_gdb_exit {} {
 643     global GDB
 644     global GDBFLAGS
 645     global verbose
 646     global gdb_spawn_id;
 647
 648     gdb_stop_suppressing_tests;
 649
 650     if ![info exists gdb_spawn_id] {
 651         return;
 652     }
 653
 654     verbose "Quitting $GDB $GDBFLAGS"
 655
 656     if { [is_remote host] && [board_info host exists fileid] } {
 657         send_gdb "quit\n";
 658         gdb_expect 10 {
 659             -re "y or n" {
 660                 send_gdb "y\n";
 661                 exp_continue;
 662             }
 663             -re "DOSEXIT code" { }
 664             default { }
 665         }
 666     }
 667
 668     if ![is_remote host] {
 669         remote_close host;
 670     }
 671     unset gdb_spawn_id
 672 }
 673
 674 #
 675 # load a file into the debugger.
 676 # return a -1 if anything goes wrong.
 677 #
 678 proc gdb_file_cmd { arg } {
 679     global verbose
 680     global loadpath
 681     global loadfile
 682     global GDB
 683     global gdb_prompt
 684     upvar timeout timeout
 685
 686     if [is_remote host] {
 687         set arg [remote_download host $arg];
 688         if { $arg == "" } {
 689             error "download failed"
 690             return -1;
 691         }
 692     }
 693
 694     send_gdb "file $arg\n"
 695     gdb_expect 120 {
 696         -re "Reading symbols from.*done.*$gdb_prompt $" {
 697             verbose "\t\tLoaded $arg into the $GDB"
 698             return 0
 699         }
 700         -re "has no symbol-table.*$gdb_prompt $" {
 701             perror "$arg wasn't compiled with \"-g\""
 702             return -1
 703         }
 704         -re "A program is being debugged already.*Kill it.*y or n. $" {
 705             send_gdb "y\n"
 706                 verbose "\t\tKilling previous program being debugged"
 707             exp_continue
 708         }
 709         -re "Load new symbol table from \".*\".*y or n. $" {
 710             send_gdb "y\n"
 711             gdb_expect 120 {
 712                 -re "Reading symbols from.*done.*$gdb_prompt $" {
 713                     verbose "\t\tLoaded $arg with new symbol table into $GDB"
 714                     return 0
 715                 }
 716                 timeout {
 717                     perror "(timeout) Couldn't load $arg, other program already loaded."
 718                     return -1
 719                 }
 720             }
 721         }
 722         -re "No such file or directory.*$gdb_prompt $" {
 723             perror "($arg) No such file or directory\n"
 724             return -1
 725         }
 726         -re "$gdb_prompt $" {
 727             perror "couldn't load $arg into $GDB."
 728             return -1
 729             }
 730         timeout {
 731             perror "couldn't load $arg into $GDB (timed out)."
 732             return -1
 733         }
 734         eof {
 735             # This is an attempt to detect a core dump, but seems not to
 736             # work.  Perhaps we need to match .* followed by eof, in which
 737             # gdb_expect does not seem to have a way to do that.
 738             perror "couldn't load $arg into $GDB (end of file)."
 739             return -1
 740         }
 741     }
 742 }
 743
 744 #
 745 # start gdb -- start gdb running, default procedure
 746 #
 747 # When running over NFS, particularly if running many simultaneous
 748 # tests on different hosts all using the same server, things can
 749 # get really slow.  Give gdb at least 3 minutes to start up.
 750 #
 751 proc default_gdb_start { } {
 752     global verbose
 753     global GDB
 754     global GDBFLAGS
 755     global gdb_prompt
 756     global timeout
 757     global gdb_spawn_id;
 758
 759     gdb_stop_suppressing_tests;
 760
 761     verbose "Spawning $GDB -nw $GDBFLAGS"
 762
 763     if [info exists gdb_spawn_id] {
 764         return 0;
 765     }
 766
 767     if ![is_remote host] {
 768         if { [which $GDB] == 0 } then {
 769             perror "$GDB does not exist."
 770             exit 1
 771         }
 772     }
 773     set res [remote_spawn host "$GDB -nw $GDBFLAGS [host_info gdb_opts]"];
 774     if { $res < 0 || $res == "" } {
 775         perror "Spawning $GDB failed."
 776         return 1;
 777     }
 778     gdb_expect 360 {
 779         -re "\[\r\n\]$gdb_prompt $" {
 780             verbose "GDB initialized."
 781         }
 782         -re "$gdb_prompt $"     {
 783             perror "GDB never initialized."
 784             return -1
 785         }
 786         timeout {
 787             perror "(timeout) GDB never initialized after 10 seconds."
 788             remote_close host;
 789             return -1
 790         }
 791     }
 792     set gdb_spawn_id -1;
 793     # force the height to "unlimited", so no pagers get used
 794
 795     send_gdb "set height 0\n"
 796     gdb_expect 10 {
 797         -re "$gdb_prompt $" {
 798             verbose "Setting height to 0." 2
 799         }
 800         timeout {
 801             warning "Couldn't set the height to 0"
 802         }
 803     }
 804     # force the width to "unlimited", so no wraparound occurs
 805     send_gdb "set width 0\n"
 806     gdb_expect 10 {
 807         -re "$gdb_prompt $" {
 808             verbose "Setting width to 0." 2
 809         }
 810         timeout {
 811             warning "Couldn't set the width to 0."
 812         }
 813     }
 814     return 0;
 815 }
 816
 817 # * For crosses, the CHILL runtime doesn't build because it can't find
 818 # setjmp.h, stdio.h, etc.
 819 # * For AIX (as of 16 Mar 95), (a) there is no language code for
 820 # CHILL in output_epilog in gcc/config/rs6000/rs6000.c, (b) collect2
 821 # does not get along with AIX's too-clever linker.
 822 # * On Irix5, there is a bug whereby set of bool, etc., don't get
 823 # TYPE_LOW_BOUND for the bool right because force_to_range_type doesn't
 824 # work with stub types.
 825 # Lots of things seem to fail on the PA, and since it's not a supported
 826 # chill target at the moment, don't run the chill tests.
 827
 828 proc skip_chill_tests {} {
 829     if ![info exists do_chill_tests] {
 830         return 1;
 831     }
 832     eval set skip_chill [expr ![isnative] || [istarget "*-*-aix*"] || [istarget "*-*-irix5*"] || [istarget "*-*-irix6*"] || [istarget "alpha-*-osf*"] || [istarget "hppa*-*-*"]]
 833     verbose "Skip chill tests is $skip_chill"
 834     return $skip_chill
 835 }
 836
 837 # skip all the tests in the file if you are not on an hppa running hpux target.
 838 # and you compiled with gcc
 839 proc skip_hp_tests {gcc_used} {
 840   #  if ![info exists do_hp_tests] {
 841   #     return 1;
 842   #  }
 843     eval set skip_hp [expr ![isnative] || ![istarget "hppa*-*-hpux*"] || $gcc_used!=0 ]
 844     verbose "Skip hp tests is $skip_hp"
 845     return $skip_hp
 846 }
 847
 848 proc get_compiler_info {binfile args} {
 849     # Create and source the file that provides information about the compiler
 850     # used to compile the test case.
 851     # Compiler_type can be null or c++. If null we assume c.
 852     global srcdir
 853     global subdir
 854     # These two come from compiler.c.
 855     global signed_keyword_not_used
 856     global gcc_compiled
 857
 858     if {![istarget "hppa*-*-hpux*"]} {
 859         if { [llength $args] > 0 } {
 860             if {$args == "c++"} {
 861         if { [gdb_compile "${srcdir}/${subdir}/compiler.cc" "${binfile}.ci" preprocess {}] != "" } {
 862                     perror "Couldn't make ${binfile}.ci file"
 863                     return 1;
 864                 }
 865             }
 866         } else {
 867             if { [gdb_compile "${srcdir}/${subdir}/compiler.c" "${binfile}.ci" preprocess {}] != "" } {
 868                 perror "Couldn't make ${binfile}.ci file"
 869                 return 1;
 870             }
 871         }
 872     } else {
 873         if { [llength $args] > 0 } {
 874             if {$args == "c++"} {
 875                 if { [eval gdb_preprocess \
 876                         [list "${srcdir}/${subdir}/compiler.cc" "${binfile}.ci"] \
 877                         $args] != "" } {
 878                     perror "Couldn't make ${binfile}.ci file"
 879                     return 1;
 880                 }
 881             }
 882         } else {
 883             if { [eval gdb_preprocess \
 884                     [list "${srcdir}/${subdir}/compiler.c" "${binfile}.ci"] \
 885                     $args] != "" } {
 886                 perror "Couldn't make ${binfile}.ci file"
 887                 return 1;
 888             }
 889         }
 890     }
 891
 892     source ${binfile}.ci
 893     return 0;
 894 }
 895
 896 proc gdb_preprocess {source dest args} {
 897     global CC_FOR_TARGET
 898     global CXX_FOR_TARGET
 899
 900     if { [llength $args] == 0 } {
 901         set which_compiler "c"
 902     } else {
 903         if { $args =="c++" } {
 904             set which_compiler "c++"
 905         } else {
 906             perror "Unknown compiler type supplied to gdb_preprocess"
 907             return 1;
 908         }
 909     }
 910
 911     if [info exists CC_FOR_TARGET] {
 912         if { $which_compiler == "c"} {
 913             set compiler $CC_FOR_TARGET;
 914         }
 915     }
 916
 917     if [info exists CXX_FOR_TARGET] {
 918         if { $which_compiler == "c++"} {
 919             set compiler $CXX_FOR_TARGET;
 920         }
 921     }
 922
 923     if { ![info exists compiler] } {
 924         if { $which_compiler == "c" } {
 925             if {[info exists CC]} {
 926                 set compiler $CC;
 927             }
 928         }
 929         if { $which_compiler == "c++" } {
 930             if {[info exists CXX]} {
 931                 set compiler $CXX;
 932             }
 933         }
 934         if {![info exists compiler]} {
 935             set compiler [board_info [target_info name] compiler];
 936             if { $compiler == "" } {
 937                 puts "default_target_compile: No compiler to compile with";
 938                 return "default_target_compile: No compiler to compile with";
 939             }
 940         }
 941     }
 942
 943     set cmdline "$compiler -E $source > $dest"
 944
 945     verbose "Invoking $compiler -E $source > $dest"
 946     verbose -log "Executing on local host: $cmdline" 2
 947     set status [catch "exec ${cmdline}" exec_output]
 948
 949     set result [prune_warnings $exec_output]
 950     regsub "\[\r\n\]*$" "$result" "" result;
 951     regsub "^\[\r\n\]*" "$result" "" result;
 952     if { $result != "" } {
 953         clone_output "gdb compile failed, $result"
 954     }
 955     return $result;
 956 }
 957
 958 proc gdb_compile {source dest type options} {
 959     global GDB_TESTCASE_OPTIONS;
 960
 961     if [target_info exists gdb_stub] {
 962         set options2 { "additional_flags=-Dusestubs" }
 963         lappend options "libs=[target_info gdb_stub]";
 964         set options [concat $options2 $options]
 965     }
 966     if [target_info exists is_vxworks] {
 967         set options2 { "additional_flags=-Dvxworks" }
 968         lappend options "libs=[target_info gdb_stub]";
 969         set options [concat $options2 $options]
 970     }
 971     if [info exists GDB_TESTCASE_OPTIONS] {
 972         lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
 973     }
 974     verbose "options are $options"
 975     verbose "source is $source $dest $type $options"
 976
 977     set result [target_compile $source $dest $type $options];
 978     regsub "\[\r\n\]*$" "$result" "" result;
 979     regsub "^\[\r\n\]*" "$result" "" result;
 980     if { $result != "" } {
 981         clone_output "gdb compile failed, $result"
 982     }
 983     return $result;
 984 }
 985
 986 proc send_gdb { string } {
 987     global suppress_flag;
 988     if { $suppress_flag } {
 989         return "suppressed";
 990     }
 991     return [remote_send host "$string"];
 992 }
 993
 994 #
 995 #
 996
 997 proc gdb_expect { args } {
 998     if { [llength $args] == 2  && [lindex $args 0] != "-re" } {
 999         set gtimeout [lindex $args 0];
1000         set expcode [list [lindex $args 1]];
1001     } else {
1002         upvar timeout timeout;
1003
1004         set expcode $args;
1005         if [target_info exists gdb,timeout] {
1006             if [info exists timeout] {
1007                 if { $timeout < [target_info gdb,timeout] } {
1008                     set gtimeout [target_info gdb,timeout];
1009                 } else {
1010                     set gtimeout $timeout;
1011                 }
1012             } else {
1013                 set gtimeout [target_info gdb,timeout];
1014             }
1015         }
1016
1017         if ![info exists gtimeout] {
1018             global timeout;
1019             if [info exists timeout] {
1020                 set gtimeout $timeout;
1021             } else {
1022                 # Eeeeew.
1023                 set gtimeout 60;
1024             }
1025         }
1026     }
1027     global suppress_flag;
1028     global remote_suppress_flag;
1029     if [info exists remote_suppress_flag] {
1030         set old_val $remote_suppress_flag;
1031     }
1032     if [info exists suppress_flag] {
1033         if { $suppress_flag } {
1034             set remote_suppress_flag 1;
1035         }
1036     }
1037     set code [catch {uplevel remote_expect host $gtimeout $expcode} string];
1038     if [info exists old_val] {
1039         set remote_suppress_flag $old_val;
1040     } else {
1041         if [info exists remote_suppress_flag] {
1042             unset remote_suppress_flag;
1043         }
1044     }
1045
1046     if {$code == 1} {
1047         global errorInfo errorCode;
1048
1049         return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1050     } elseif {$code == 2} {
1051         return -code return $string
1052     } elseif {$code == 3} {
1053         return
1054     } elseif {$code > 4} {
1055         return -code $code $string
1056     }
1057 }
1058
1059 proc gdb_suppress_entire_file { reason } {
1060     global suppress_flag;
1061
1062     warning "$reason\n";
1063     set suppress_flag -1;
1064 }
1065
1066 #
1067 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
1068 # gdb_expect to fail immediately (until the next call to
1069 # gdb_stop_suppressing_tests).
1070 #
1071 proc gdb_suppress_tests { args } {
1072     global suppress_flag;
1073
1074     return;  # fnf - disable pending review of results where
1075              # testsuite ran better without this
1076     incr suppress_flag;
1077
1078     if { $suppress_flag == 1 } {
1079         if { [llength $args] > 0 } {
1080             warning "[lindex $args 0]\n";
1081         } else {
1082             warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
1083         }
1084     }
1085 }
1086
1087 #
1088 # Clear suppress_flag.
1089 #
1090 proc gdb_stop_suppressing_tests { } {
1091     global suppress_flag;
1092
1093     if [info exists suppress_flag] {
1094         if { $suppress_flag > 0 } {
1095             set suppress_flag 0;
1096             clone_output "Tests restarted.\n";
1097         }
1098     } else {
1099         set suppress_flag 0;
1100     }
1101 }
1102
1103 proc gdb_clear_suppressed { } {
1104     global suppress_flag;
1105
1106     set suppress_flag 0;
1107 }
1108
1109 proc gdb_start { } {
1110     default_gdb_start
1111 }
1112
1113 proc gdb_exit { } {
1114     catch default_gdb_exit
1115 }
1116
1117 #
1118 # gdb_load -- load a file into the debugger.
1119 #             return a -1 if anything goes wrong.
1120 #
1121 proc gdb_load { arg } {
1122     return [gdb_file_cmd $arg]
1123 }
1124
1125 proc gdb_continue { function } {
1126     global decimal
1127
1128     return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
1129 }
1130
1131 proc default_gdb_init { args } {
1132     gdb_clear_suppressed;
1133
1134     # Uh, this is lame. Really, really, really lame. But there's this *one*
1135     # testcase that will fail in random places if we don't increase this.
1136     match_max -d 20000
1137
1138     # We want to add the name of the TCL testcase to the PASS/FAIL messages.
1139     if { [llength $args] > 0 } {
1140         global pf_prefix
1141
1142         set file [lindex $args 0];
1143
1144         set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
1145     }
1146     global gdb_prompt;
1147     if [target_info exists gdb_prompt] {
1148         set gdb_prompt [target_info gdb_prompt];
1149     } else {
1150         set gdb_prompt "\\(gdb\\)"
1151     }
1152 }
1153
1154 proc gdb_init { args } {
1155     return [eval default_gdb_init $args];
1156 }
1157
1158 proc gdb_finish { } {
1159     gdb_exit;
1160 }
1161
1162 global debug_format
1163
1164 # Run the gdb command "info source" and extract the debugging format
1165 # information from the output and save it in debug_format.
1166
1167 proc get_debug_format { } {
1168     global gdb_prompt
1169     global verbose
1170     global expect_out
1171     global debug_format
1172
1173     set debug_format "unknown"
1174     send_gdb "info source\n"
1175     gdb_expect 10 {
1176         -re "Compiled with (.*) debugging format.\r\n$gdb_prompt $" {
1177             set debug_format $expect_out(1,string)
1178             verbose "debug format is $debug_format"
1179             return 1;
1180         }
1181         -re "No current source file.\r\n$gdb_prompt $" {
1182             perror "get_debug_format used when no current source file"
1183             return 0;
1184         }
1185         -re "$gdb_prompt $" {
1186             warning "couldn't check debug format (no valid response)."
1187             return 1;
1188         }
1189         timeout {
1190             warning "couldn't check debug format (timed out)."
1191             return 1;
1192         }
1193     }
1194 }
1195
1196 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
1197 # COFF, stabs, etc).  If that format matches the format that the
1198 # current test was compiled with, then the next test is expected to
1199 # fail for any target.  Returns 1 if the next test or set of tests is
1200 # expected to fail, 0 otherwise (or if it is unknown).  Must have
1201 # previously called get_debug_format.
1202
1203 proc setup_xfail_format { format } {
1204     global debug_format
1205
1206     if [string match $debug_format $format] then {
1207         setup_xfail "*-*-*"
1208         return 1;
1209     }
1210     return 0
1211 }
1212
1213 proc gdb_step_for_stub { } {
1214     global gdb_prompt;
1215
1216     if ![target_info exists gdb,use_breakpoint_for_stub] {
1217         if [target_info exists gdb_stub_step_command] {
1218             set command [target_info gdb_stub_step_command];
1219         } else {
1220             set command "step";
1221         }
1222         send_gdb "${command}\n";
1223         set tries 0;
1224         gdb_expect 60 {
1225             -re "(main.* at |.*in .*start).*$gdb_prompt" {
1226                 return;
1227             }
1228             -re ".*$gdb_prompt" {
1229                 incr tries;
1230                 if { $tries == 5 } {
1231                     fail "stepping out of breakpoint function";
1232                     return;
1233                 }
1234                 send_gdb "${command}\n";
1235                 exp_continue;
1236             }
1237             default {
1238                 fail "stepping out of breakpoint function";
1239                 return;
1240             }
1241         }
1242     }
1243     send_gdb "where\n";
1244     gdb_expect {
1245         -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
1246             set file $expect_out(1,string);
1247             set linenum [expr $expect_out(2,string) + 1];
1248             set breakplace "${file}:${linenum}";
1249         }
1250         default {}
1251     }
1252     send_gdb "break ${breakplace}\n";
1253     gdb_expect 60 {
1254         -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
1255             set breakpoint $expect_out(1,string);
1256         }
1257         -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
1258             set breakpoint $expect_out(1,string);
1259         }
1260         default {}
1261     }
1262     send_gdb "continue\n";
1263     gdb_expect 60 {
1264         -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
1265             gdb_test "delete $breakpoint" ".*" "";
1266             return;
1267         }
1268         default {}
1269     }
1270 }
1271
1272 ### gdb_get_line_number TEXT [FILE]
1273 ###
1274 ### Search the source file FILE, and return the line number of a line
1275 ### containing TEXT.  Use this function instead of hard-coding line
1276 ### numbers into your test script.
1277 ###
1278 ### Specifically, this function uses GDB's "search" command to search
1279 ### FILE for the first line containing TEXT, and returns its line
1280 ### number.  Thus, FILE must be a source file, compiled into the
1281 ### executable you are running.  If omitted, FILE defaults to the
1282 ### value of the global variable `srcfile'; most test scripts set
1283 ### `srcfile' appropriately at the top anyway.
1284 ###
1285 ### Use this function to keep your test scripts independent of the
1286 ### exact line numbering of the source file.  Don't write:
1287 ###
1288 ###   send_gdb "break 20"
1289 ###
1290 ### This means that if anyone ever edits your test's source file,
1291 ### your test could break.  Instead, put a comment like this on the
1292 ### source file line you want to break at:
1293 ###
1294 ###   /* breakpoint spot: frotz.exp: test name */
1295 ###
1296 ### and then write, in your test script (which we assume is named
1297 ### frotz.exp):
1298 ###
1299 ###   send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
1300 ###
1301 ### (Yes, Tcl knows how to handle the nested quotes and brackets.
1302 ### Try this:
1303 ###     $ tclsh
1304 ###     % puts "foo [lindex "bar baz" 1]"
1305 ###     foo baz
1306 ###     %
1307 ### Tcl is quite clever, for a little stringy language.)
1308
1309 proc gdb_get_line_number {text {file /omitted/}} {
1310     global gdb_prompt;
1311     global srcfile;
1312
1313     if {! [string compare $file /omitted/]} {
1314         set file $srcfile
1315     }
1316
1317     set result -1;
1318     gdb_test "list ${file}:1,1" ".*" ""
1319     send_gdb "search ${text}\n"
1320     gdb_expect {
1321         -re "\[\r\n\]+(\[0-9\]+)\[ \t\].*${text}.*$gdb_prompt $" {
1322             set result $expect_out(1,string)
1323         }
1324         -re ".*$gdb_prompt $" {
1325             fail "find line number containing \"${text}\""
1326         }
1327         timeout {
1328             fail "find line number containing \"${text}\" (timeout)"
1329         }
1330     }
1331     return $result;
1332 }
1333
1334