gdb/testsuite/lib/gdb.exp

   1 # Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
   2 # 2002, 2003, 2004
   3 # Free Software Foundation, Inc.
   4
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19 # This file was written by Fred Fish. (fnf@cygnus.com)
  20
  21 # Generic gdb subroutines that should work for any target.  If these
  22 # need to be modified for any target, it can be done with a variable
  23 # or by passing arguments.
  24
  25 load_lib libgloss.exp
  26
  27 global GDB
  28
  29 if [info exists TOOL_EXECUTABLE] {
  30     set GDB $TOOL_EXECUTABLE;
  31 }
  32 if ![info exists GDB] {
  33     if ![is_remote host] {
  34         set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
  35     } else {
  36         set GDB [transform gdb];
  37     }
  38 }
  39 verbose "using GDB = $GDB" 2
  40
  41 global GDBFLAGS
  42 if ![info exists GDBFLAGS] {
  43     set GDBFLAGS "-nx"
  44 }
  45 verbose "using GDBFLAGS = $GDBFLAGS" 2
  46
  47 # The variable gdb_prompt is a regexp which matches the gdb prompt.
  48 # Set it if it is not already set.
  49 global gdb_prompt
  50 if ![info exists gdb_prompt] then {
  51     set gdb_prompt "\[(\]gdb\[)\]"
  52 }
  53
  54 # Needed for some tests under Cygwin.
  55 global EXEEXT
  56 global env
  57
  58 if ![info exists env(EXEEXT)] {
  59     set EXEEXT ""
  60 } else {
  61     set EXEEXT $env(EXEEXT)
  62 }
  63
  64 ### Only procedures should come after this point.
  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     # we need a larger timeout value here or this thing just confuses
 133     # itself.  May need a better implementation if possible. - guo
 134     #
 135     send_gdb "delete breakpoints\n"
 136     gdb_expect 100 {
 137          -re "Delete all breakpoints.*y or n.*$" {
 138             send_gdb "y\n";
 139             exp_continue
 140         }
 141          -re "$gdb_prompt $" { # This happens if there were no breakpoints
 142             }
 143          timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return }
 144     }
 145     send_gdb "info breakpoints\n"
 146     gdb_expect 100 {
 147          -re "No breakpoints or watchpoints..*$gdb_prompt $" {}
 148          -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return }
 149          -re "Delete all breakpoints.*or n.*$" {
 150             send_gdb "y\n";
 151             exp_continue
 152         }
 153          timeout { perror "info breakpoints (timeout)" ; return }
 154     }
 155 }
 156
 157
 158 #
 159 # Generic run command.
 160 #
 161 # The second pattern below matches up to the first newline *only*.
 162 # Using ``.*$'' could swallow up output that we attempt to match
 163 # elsewhere.
 164 #
 165 proc gdb_run_cmd {args} {
 166     global gdb_prompt
 167
 168     if [target_info exists gdb_init_command] {
 169         send_gdb "[target_info gdb_init_command]\n";
 170         gdb_expect 30 {
 171             -re "$gdb_prompt $" { }
 172             default {
 173                 perror "gdb_init_command for target failed";
 174                 return;
 175             }
 176         }
 177     }
 178
 179     if [target_info exists use_gdb_stub] {
 180         if [target_info exists gdb,do_reload_on_run] {
 181             # Specifying no file, defaults to the executable
 182             # currently being debugged.
 183             if { [gdb_load ""] != 0 } {
 184                 return;
 185             }
 186             send_gdb "continue\n";
 187             gdb_expect 60 {
 188                 -re "Continu\[^\r\n\]*\[\r\n\]" {}
 189                 default {}
 190             }
 191             return;
 192         }
 193
 194         if [target_info exists gdb,start_symbol] {
 195             set start [target_info gdb,start_symbol];
 196         } else {
 197             set start "start";
 198         }
 199         send_gdb  "jump *$start\n"
 200         set start_attempt 1;
 201         while { $start_attempt } {
 202             # Cap (re)start attempts at three to ensure that this loop
 203             # always eventually fails.  Don't worry about trying to be
 204             # clever and not send a command when it has failed.
 205             if [expr $start_attempt > 3] {
 206                 perror "Jump to start() failed (retry count exceeded)";
 207                 return;
 208             }
 209             set start_attempt [expr $start_attempt + 1];
 210             gdb_expect 30 {
 211                 -re "Continuing at \[^\r\n\]*\[\r\n\]" {
 212                     set start_attempt 0;
 213                 }
 214                 -re "No symbol \"_start\" in current.*$gdb_prompt $" {
 215                     perror "Can't find start symbol to run in gdb_run";
 216                     return;
 217                 }
 218                 -re "No symbol \"start\" in current.*$gdb_prompt $" {
 219                     send_gdb "jump *_start\n";
 220                 }
 221                 -re "No symbol.*context.*$gdb_prompt $" {
 222                     set start_attempt 0;
 223                 }
 224                 -re "Line.* Jump anyway.*y or n. $" {
 225                     send_gdb "y\n"
 226                 }
 227                 -re "The program is not being run.*$gdb_prompt $" {
 228                     if { [gdb_load ""] != 0 } {
 229                         return;
 230                     }
 231                     send_gdb "jump *$start\n";
 232                 }
 233                 timeout {
 234                     perror "Jump to start() failed (timeout)";
 235                     return
 236                 }
 237             }
 238         }
 239         if [target_info exists gdb_stub] {
 240             gdb_expect 60 {
 241                 -re "$gdb_prompt $" {
 242                     send_gdb "continue\n"
 243                 }
 244             }
 245         }
 246         return
 247     }
 248
 249     if [target_info exists gdb,do_reload_on_run] {
 250         if { [gdb_load ""] != 0 } {
 251             return;
 252         }
 253     }
 254     send_gdb "run $args\n"
 255 # This doesn't work quite right yet.
 256     gdb_expect 60 {
 257         -re "The program .* has been started already.*y or n. $" {
 258             send_gdb "y\n"
 259             exp_continue
 260         }
 261         -re "Starting program: \[^\r\n\]*" {}
 262     }
 263 }
 264
 265 # Set a breakpoint at FUNCTION.  If there is an additional argument it is
 266 # a list of options; the only currently supported option is allow-pending.
 267
 268 proc gdb_breakpoint { function args } {
 269     global gdb_prompt
 270     global decimal
 271
 272     set pending_response n
 273     if {[lsearch -exact [lindex $args 0] allow-pending] != -1} {
 274         set pending_response y
 275     }
 276
 277     send_gdb "break $function\n"
 278     # The first two regexps are what we get with -g, the third is without -g.
 279     gdb_expect 30 {
 280         -re "Breakpoint \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 281         -re "Breakpoint \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {}
 282         -re "Breakpoint \[0-9\]* at .*$gdb_prompt $" {}
 283         -re "Breakpoint \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" {
 284                 if {$pending_response == "n"} {
 285                         fail "setting breakpoint at $function"
 286                         return 0
 287                 }
 288         }
 289         -re "Make breakpoint pending.*y or \\\[n\\\]. $" {
 290                 send_gdb "$pending_response\n"
 291                 exp_continue
 292         }
 293         -re "$gdb_prompt $" { fail "setting breakpoint at $function" ; return 0 }
 294         timeout { fail "setting breakpoint at $function (timeout)" ; return 0 }
 295     }
 296     return 1;
 297 }
 298
 299 # Set breakpoint at function and run gdb until it breaks there.
 300 # Since this is the only breakpoint that will be set, if it stops
 301 # at a breakpoint, we will assume it is the one we want.  We can't
 302 # just compare to "function" because it might be a fully qualified,
 303 # single quoted C++ function specifier.  If there's an additional argument,
 304 # pass it to gdb_breakpoint.
 305
 306 proc runto { function args } {
 307     global gdb_prompt
 308     global decimal
 309
 310     delete_breakpoints
 311
 312     if ![gdb_breakpoint $function [lindex $args 0]] {
 313         return 0;
 314     }
 315
 316     gdb_run_cmd
 317
 318     # the "at foo.c:36" output we get with -g.
 319     # the "in func" output we get without -g.
 320     gdb_expect 30 {
 321         -re "Break.* at .*:$decimal.*$gdb_prompt $" {
 322             return 1
 323         }
 324         -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" {
 325             return 1
 326         }
 327         -re "$gdb_prompt $" {
 328             fail "running to $function in runto"
 329             return 0
 330         }
 331         timeout {
 332             fail "running to $function in runto (timeout)"
 333             return 0
 334         }
 335     }
 336     return 1
 337 }
 338
 339 #
 340 # runto_main -- ask gdb to run until we hit a breakpoint at main.
 341 #               The case where the target uses stubs has to be handled
 342 #               specially--if it uses stubs, assuming we hit
 343 #               breakpoint() and just step out of the function.
 344 #
 345 proc runto_main { } {
 346     global gdb_prompt
 347     global decimal
 348
 349     if ![target_info exists gdb_stub] {
 350         return [runto main]
 351     }
 352
 353     delete_breakpoints
 354
 355     gdb_step_for_stub;
 356
 357     return 1
 358 }
 359
 360
 361 ### Continue, and expect to hit a breakpoint.
 362 ### Report a pass or fail, depending on whether it seems to have
 363 ### worked.  Use NAME as part of the test name; each call to
 364 ### continue_to_breakpoint should use a NAME which is unique within
 365 ### that test file.
 366 proc gdb_continue_to_breakpoint {name} {
 367     global gdb_prompt
 368     set full_name "continue to breakpoint: $name"
 369
 370     send_gdb "continue\n"
 371     gdb_expect {
 372         -re "Breakpoint .* at .*\r\n$gdb_prompt $" {
 373             pass $full_name
 374         }
 375         -re ".*$gdb_prompt $" {
 376             fail $full_name
 377         }
 378         timeout {
 379             fail "$full_name (timeout)"
 380         }
 381     }
 382 }
 383
 384
 385 # gdb_internal_error_resync:
 386 #
 387 # Answer the questions GDB asks after it reports an internal error
 388 # until we get back to a GDB prompt.  Decline to quit the debugging
 389 # session, and decline to create a core file.  Return non-zero if the
 390 # resync succeeds.
 391 #
 392 # This procedure just answers whatever questions come up until it sees
 393 # a GDB prompt; it doesn't require you to have matched the input up to
 394 # any specific point.  However, it only answers questions it sees in
 395 # the output itself, so if you've matched a question, you had better
 396 # answer it yourself before calling this.
 397 #
 398 # You can use this function thus:
 399 #
 400 # gdb_expect {
 401 #     ...
 402 #     -re ".*A problem internal to GDB has been detected" {
 403 #         gdb_internal_error_resync
 404 #     }
 405 #     ...
 406 # }
 407 #
 408 proc gdb_internal_error_resync {} {
 409     global gdb_prompt
 410
 411     set count 0
 412     while {$count < 10} {
 413         gdb_expect {
 414             -re "Quit this debugging session\\? \\(y or n\\) $" {
 415                 send_gdb "n\n"
 416                 incr count
 417             }
 418             -re "Create a core file of GDB\\? \\(y or n\\) $" {
 419                 send_gdb "n\n"
 420                 incr count
 421             }
 422             -re "$gdb_prompt $" {
 423                 # We're resynchronized.
 424                 return 1
 425             }
 426             timeout {
 427                 perror "Could not resync from internal error (timeout)"
 428                 return 0
 429             }
 430         }
 431     }
 432     perror "Could not resync from internal error (resync count exceeded)"
 433     return 0
 434 }
 435
 436
 437 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
 438 # Send a command to gdb; test the result.
 439 #
 440 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 441 #   this is the null string no command is sent.
 442 # MESSAGE is a message to be printed with the built-in failure patterns
 443 #   if one of them matches.  If MESSAGE is empty COMMAND will be used.
 444 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
 445 #   patterns.  Pattern elements will be evaluated in the caller's
 446 #   context; action elements will be executed in the caller's context.
 447 #   Unlike patterns for gdb_test, these patterns should generally include
 448 #   the final newline and prompt.
 449 #
 450 # Returns:
 451 #    1 if the test failed, according to a built-in failure pattern
 452 #    0 if only user-supplied patterns matched
 453 #   -1 if there was an internal error.
 454 #
 455 # You can use this function thus:
 456 #
 457 # gdb_test_multiple "print foo" "test foo" {
 458 #    -re "expected output 1" {
 459 #        pass "print foo"
 460 #    }
 461 #    -re "expected output 2" {
 462 #        fail "print foo"
 463 #    }
 464 # }
 465 #
 466 # The standard patterns, such as "Program exited..." and "A problem
 467 # ...", all being implicitly appended to that list.
 468 #
 469 proc gdb_test_multiple { command message user_code } {
 470     global verbose
 471     global gdb_prompt
 472     global GDB
 473     upvar timeout timeout
 474     upvar expect_out expect_out
 475
 476     if { $message == "" } {
 477         set message $command
 478     }
 479
 480     # TCL/EXPECT WART ALERT
 481     # Expect does something very strange when it receives a single braced
 482     # argument.  It splits it along word separators and performs substitutions.
 483     # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is
 484     # evaluated as "\[ab\]".  But that's not how TCL normally works; inside a
 485     # double-quoted list item, "\[ab\]" is just a long way of representing
 486     # "[ab]", because the backslashes will be removed by lindex.
 487
 488     # Unfortunately, there appears to be no easy way to duplicate the splitting
 489     # that expect will do from within TCL.  And many places make use of the
 490     # "\[0-9\]" construct, so we need to support that; and some places make use
 491     # of the "[func]" construct, so we need to support that too.  In order to
 492     # get this right we have to substitute quoted list elements differently
 493     # from braced list elements.
 494
 495     # We do this roughly the same way that Expect does it.  We have to use two
 496     # lists, because if we leave unquoted newlines in the argument to uplevel
 497     # they'll be treated as command separators, and if we escape newlines
 498     # we mangle newlines inside of command blocks.  This assumes that the
 499     # input doesn't contain a pattern which contains actual embedded newlines
 500     # at this point!
 501
 502     regsub -all {\n} ${user_code} { } subst_code
 503     set subst_code [uplevel list $subst_code]
 504
 505     set processed_code ""
 506     set patterns ""
 507     set expecting_action 0
 508     foreach item $user_code subst_item $subst_code {
 509         if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } {
 510             lappend processed_code $item
 511             continue
 512         }
 513         if {$item == "-indices" || $item == "-re" || $item == "-ex"} {
 514             lappend processed_code $item
 515             continue
 516         }
 517         if { $expecting_action } {
 518             lappend processed_code "uplevel [list $item]"
 519             set expecting_action 0
 520             # Cosmetic, no effect on the list.
 521             append processed_code "\n"
 522             continue
 523         }
 524         set expecting_action 1
 525         lappend processed_code $subst_item
 526         if {$patterns != ""} {
 527             append patterns "; "
 528         }
 529         append patterns "\"$subst_item\""
 530     }
 531
 532     # Also purely cosmetic.
 533     regsub -all {\r} $patterns {\\r} patterns
 534     regsub -all {\n} $patterns {\\n} patterns
 535
 536     if $verbose>2 then {
 537         send_user "Sending \"$command\" to gdb\n"
 538         send_user "Looking to match \"$patterns\"\n"
 539         send_user "Message is \"$message\"\n"
 540     }
 541
 542     set result -1
 543     set string "${command}\n";
 544     if { $command != "" } {
 545         while { "$string" != "" } {
 546             set foo [string first "\n" "$string"];
 547             set len [string length "$string"];
 548             if { $foo < [expr $len - 1] } {
 549                 set str [string range "$string" 0 $foo];
 550                 if { [send_gdb "$str"] != "" } {
 551                     global suppress_flag;
 552
 553                     if { ! $suppress_flag } {
 554                         perror "Couldn't send $command to GDB.";
 555                     }
 556                     fail "$message";
 557                     return $result;
 558                 }
 559                 # since we're checking if each line of the multi-line
 560                 # command are 'accepted' by GDB here,
 561                 # we need to set -notransfer expect option so that
 562                 # command output is not lost for pattern matching
 563                 # - guo
 564                 gdb_expect 2 {
 565                     -notransfer -re "\[\r\n\]" { verbose "partial: match" 3 }
 566                     timeout { verbose "partial: timeout" 3 }
 567                 }
 568                 set string [string range "$string" [expr $foo + 1] end];
 569             } else {
 570                 break;
 571             }
 572         }
 573         if { "$string" != "" } {
 574             if { [send_gdb "$string"] != "" } {
 575                 global suppress_flag;
 576
 577                 if { ! $suppress_flag } {
 578                     perror "Couldn't send $command to GDB.";
 579                 }
 580                 fail "$message";
 581                 return $result;
 582             }
 583         }
 584     }
 585
 586     if [target_info exists gdb,timeout] {
 587         set tmt [target_info gdb,timeout];
 588     } else {
 589         if [info exists timeout] {
 590             set tmt $timeout;
 591         } else {
 592             global timeout;
 593             if [info exists timeout] {
 594                 set tmt $timeout;
 595             } else {
 596                 set tmt 60;
 597             }
 598         }
 599     }
 600
 601     set code {
 602          -re ".*A problem internal to GDB has been detected" {
 603              fail "$message (GDB internal error)"
 604              gdb_internal_error_resync
 605          }
 606          -re "\\*\\*\\* DOSEXIT code.*" {
 607              if { $message != "" } {
 608                  fail "$message";
 609              }
 610              gdb_suppress_entire_file "GDB died";
 611              set result -1;
 612          }
 613          -re "Ending remote debugging.*$gdb_prompt $" {
 614             if ![isnative] then {
 615                 warning "Can`t communicate to remote target."
 616             }
 617             gdb_exit
 618             gdb_start
 619             set result -1
 620         }
 621     }
 622     append code $processed_code
 623     append code {
 624          -re "Undefined\[a-z\]* command:.*$gdb_prompt $" {
 625             perror "Undefined command \"$command\"."
 626             fail "$message"
 627             set result 1
 628         }
 629          -re "Ambiguous command.*$gdb_prompt $" {
 630             perror "\"$command\" is not a unique command name."
 631             fail "$message"
 632             set result 1
 633         }
 634          -re "Program exited with code \[0-9\]+.*$gdb_prompt $" {
 635             if ![string match "" $message] then {
 636                 set errmsg "$message (the program exited)"
 637             } else {
 638                 set errmsg "$command (the program exited)"
 639             }
 640             fail "$errmsg"
 641             set result -1
 642         }
 643          -re "EXIT code \[0-9\r\n\]+Program exited normally.*$gdb_prompt $" {
 644             if ![string match "" $message] then {
 645                 set errmsg "$message (the program exited)"
 646             } else {
 647                 set errmsg "$command (the program exited)"
 648             }
 649             fail "$errmsg"
 650             set result -1
 651         }
 652          -re "The program is not being run.*$gdb_prompt $" {
 653             if ![string match "" $message] then {
 654                 set errmsg "$message (the program is no longer running)"
 655             } else {
 656                 set errmsg "$command (the program is no longer running)"
 657             }
 658             fail "$errmsg"
 659             set result -1
 660         }
 661          -re "\r\n$gdb_prompt $" {
 662             if ![string match "" $message] then {
 663                 fail "$message"
 664             }
 665             set result 1
 666         }
 667          "<return>" {
 668             send_gdb "\n"
 669             perror "Window too small."
 670             fail "$message"
 671             set result -1
 672         }
 673          -re "\\(y or n\\) " {
 674             send_gdb "n\n"
 675             perror "Got interactive prompt."
 676             fail "$message"
 677             set result -1
 678         }
 679          eof {
 680              perror "Process no longer exists"
 681              if { $message != "" } {
 682                  fail "$message"
 683              }
 684              return -1
 685         }
 686          full_buffer {
 687             perror "internal buffer is full."
 688             fail "$message"
 689             set result -1
 690         }
 691         timeout {
 692             if ![string match "" $message] then {
 693                 fail "$message (timeout)"
 694             }
 695             set result 1
 696         }
 697     }
 698
 699     set result 0
 700     set code [catch {gdb_expect $tmt $code} string]
 701     if {$code == 1} {
 702         global errorInfo errorCode;
 703         return -code error -errorinfo $errorInfo -errorcode $errorCode $string
 704     } elseif {$code == 2} {
 705         return -code return $string
 706     } elseif {$code == 3} {
 707         return
 708     } elseif {$code > 4} {
 709         return -code $code $string
 710     }
 711     return $result
 712 }
 713
 714 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
 715 # Send a command to gdb; test the result.
 716 #
 717 # COMMAND is the command to execute, send to GDB with send_gdb.  If
 718 #   this is the null string no command is sent.
 719 # PATTERN is the pattern to match for a PASS, and must NOT include
 720 #   the \r\n sequence immediately before the gdb prompt.
 721 # MESSAGE is an optional message to be printed.  If this is
 722 #   omitted, then the pass/fail messages use the command string as the
 723 #   message.  (If this is the empty string, then sometimes we don't
 724 #   call pass or fail at all; I don't understand this at all.)
 725 # QUESTION is a question GDB may ask in response to COMMAND, like
 726 #   "are you sure?"
 727 # RESPONSE is the response to send if QUESTION appears.
 728 #
 729 # Returns:
 730 #    1 if the test failed,
 731 #    0 if the test passes,
 732 #   -1 if there was an internal error.
 733 #
 734 proc gdb_test { args } {
 735     global verbose
 736     global gdb_prompt
 737     global GDB
 738     upvar timeout timeout
 739
 740     if [llength $args]>2 then {
 741         set message [lindex $args 2]
 742     } else {
 743         set message [lindex $args 0]
 744     }
 745     set command [lindex $args 0]
 746     set pattern [lindex $args 1]
 747
 748     if [llength $args]==5 {
 749         set question_string [lindex $args 3];
 750         set response_string [lindex $args 4];
 751     } else {
 752         set question_string "^FOOBAR$"
 753     }
 754
 755     return [gdb_test_multiple $command $message {
 756         -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" {
 757             if ![string match "" $message] then {
 758                 pass "$message"
 759             }
 760         }
 761         -re "(${question_string})$" {
 762             send_gdb "$response_string\n";
 763             exp_continue;
 764         }
 765      }]
 766 }
 767 \f
 768 # Test that a command gives an error.  For pass or fail, return
 769 # a 1 to indicate that more tests can proceed.  However a timeout
 770 # is a serious error, generates a special fail message, and causes
 771 # a 0 to be returned to indicate that more tests are likely to fail
 772 # as well.
 773
 774 proc test_print_reject { args } {
 775     global gdb_prompt
 776     global verbose
 777
 778     if [llength $args]==2 then {
 779         set expectthis [lindex $args 1]
 780     } else {
 781         set expectthis "should never match this bogus string"
 782     }
 783     set sendthis [lindex $args 0]
 784     if $verbose>2 then {
 785         send_user "Sending \"$sendthis\" to gdb\n"
 786         send_user "Looking to match \"$expectthis\"\n"
 787     }
 788     send_gdb "$sendthis\n"
 789     #FIXME: Should add timeout as parameter.
 790     gdb_expect {
 791         -re "A .* in expression.*\\.*$gdb_prompt $" {
 792             pass "reject $sendthis"
 793             return 1
 794         }
 795         -re "Invalid syntax in expression.*$gdb_prompt $" {
 796             pass "reject $sendthis"
 797             return 1
 798         }
 799         -re "Junk after end of expression.*$gdb_prompt $" {
 800             pass "reject $sendthis"
 801             return 1
 802         }
 803         -re "Invalid number.*$gdb_prompt $" {
 804             pass "reject $sendthis"
 805             return 1
 806         }
 807         -re "Invalid character constant.*$gdb_prompt $" {
 808             pass "reject $sendthis"
 809             return 1
 810         }
 811         -re "No symbol table is loaded.*$gdb_prompt $" {
 812             pass "reject $sendthis"
 813             return 1
 814         }
 815         -re "No symbol .* in current context.*$gdb_prompt $" {
 816             pass "reject $sendthis"
 817             return 1
 818         }
 819         -re "Unmatched single quote.*$gdb_prompt $" {
 820             pass "reject $sendthis"
 821             return 1
 822         }
 823         -re "A character constant must contain at least one character.*$gdb_prompt $" {
 824             pass "reject $sendthis"
 825             return 1
 826         }
 827         -re "$expectthis.*$gdb_prompt $" {
 828             pass "reject $sendthis"
 829             return 1
 830         }
 831         -re ".*$gdb_prompt $" {
 832             fail "reject $sendthis"
 833             return 1
 834         }
 835         default {
 836             fail "reject $sendthis (eof or timeout)"
 837             return 0
 838         }
 839     }
 840 }
 841 \f
 842 # Given an input string, adds backslashes as needed to create a
 843 # regexp that will match the string.
 844
 845 proc string_to_regexp {str} {
 846     set result $str
 847     regsub -all {[]*+.|()^$\[]} $str {\\&} result
 848     return $result
 849 }
 850
 851 # Same as gdb_test, but the second parameter is not a regexp,
 852 # but a string that must match exactly.
 853
 854 proc gdb_test_exact { args } {
 855     upvar timeout timeout
 856
 857     set command [lindex $args 0]
 858
 859     # This applies a special meaning to a null string pattern.  Without
 860     # this, "$pattern\r\n$gdb_prompt $" will match anything, including error
 861     # messages from commands that should have no output except a new
 862     # prompt.  With this, only results of a null string will match a null
 863     # string pattern.
 864
 865     set pattern [lindex $args 1]
 866     if [string match $pattern ""] {
 867         set pattern [string_to_regexp [lindex $args 0]]
 868     } else {
 869         set pattern [string_to_regexp [lindex $args 1]]
 870     }
 871
 872     # It is most natural to write the pattern argument with only
 873     # embedded \n's, especially if you are trying to avoid Tcl quoting
 874     # problems.  But gdb_expect really wants to see \r\n in patterns.  So
 875     # transform the pattern here.  First transform \r\n back to \n, in
 876     # case some users of gdb_test_exact already do the right thing.
 877     regsub -all "\r\n" $pattern "\n" pattern
 878     regsub -all "\n" $pattern "\r\n" pattern
 879     if [llength $args]==3 then {
 880         set message [lindex $args 2]
 881     } else {
 882         set message $command
 883     }
 884
 885     return [gdb_test $command $pattern $message]
 886 }
 887 \f
 888 proc gdb_reinitialize_dir { subdir } {
 889     global gdb_prompt
 890
 891     if [is_remote host] {
 892         return "";
 893     }
 894     send_gdb "dir\n"
 895     gdb_expect 60 {
 896         -re "Reinitialize source path to empty.*y or n. " {
 897             send_gdb "y\n"
 898             gdb_expect 60 {
 899                 -re "Source directories searched.*$gdb_prompt $" {
 900                     send_gdb "dir $subdir\n"
 901                     gdb_expect 60 {
 902                         -re "Source directories searched.*$gdb_prompt $" {
 903                             verbose "Dir set to $subdir"
 904                         }
 905                         -re "$gdb_prompt $" {
 906                             perror "Dir \"$subdir\" failed."
 907                         }
 908                     }
 909                 }
 910                 -re "$gdb_prompt $" {
 911                     perror "Dir \"$subdir\" failed."
 912                 }
 913             }
 914         }
 915         -re "$gdb_prompt $" {
 916             perror "Dir \"$subdir\" failed."
 917         }
 918     }
 919 }
 920
 921 #
 922 # gdb_exit -- exit the GDB, killing the target program if necessary
 923 #
 924 proc default_gdb_exit {} {
 925     global GDB
 926     global GDBFLAGS
 927     global verbose
 928     global gdb_spawn_id;
 929
 930     gdb_stop_suppressing_tests;
 931
 932     if ![info exists gdb_spawn_id] {
 933         return;
 934     }
 935
 936     verbose "Quitting $GDB $GDBFLAGS"
 937
 938     if { [is_remote host] && [board_info host exists fileid] } {
 939         send_gdb "quit\n";
 940         gdb_expect 10 {
 941             -re "y or n" {
 942                 send_gdb "y\n";
 943                 exp_continue;
 944             }
 945             -re "DOSEXIT code" { }
 946             default { }
 947         }
 948     }
 949
 950     if ![is_remote host] {
 951         remote_close host;
 952     }
 953     unset gdb_spawn_id
 954 }
 955
 956 # Load a file into the debugger.
 957 # The return value is 0 for success, -1 for failure.
 958 #
 959 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
 960 # to one of these values:
 961 #
 962 #   debug    file was loaded successfully and has debug information
 963 #   nodebug  file was loaded successfully and has no debug information
 964 #   fail     file was not loaded
 965 #
 966 # I tried returning this information as part of the return value,
 967 # but ran into a mess because of the many re-implementations of
 968 # gdb_load in config/*.exp.
 969 #
 970 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
 971 # this if they can get more information set.
 972
 973 proc gdb_file_cmd { arg } {
 974     global gdb_prompt
 975     global verbose
 976     global GDB
 977
 978     # Set whether debug info was found.
 979     # Default to "fail".
 980     global gdb_file_cmd_debug_info
 981     set gdb_file_cmd_debug_info "fail"
 982
 983     if [is_remote host] {
 984         set arg [remote_download host $arg]
 985         if { $arg == "" } {
 986             perror "download failed"
 987             return -1
 988         }
 989     }
 990
 991     send_gdb "file $arg\n"
 992     gdb_expect 120 {
 993         -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" {
 994             verbose "\t\tLoaded $arg into the $GDB with no debugging symbols"
 995             set gdb_file_cmd_debug_info "nodebug"
 996             return 0
 997         }
 998         -re "Reading symbols from.*done.*$gdb_prompt $" {
 999             verbose "\t\tLoaded $arg into the $GDB"
1000             set gdb_file_cmd_debug_info "debug"
1001             return 0
1002         }
1003         -re "A program is being debugged already.*Kill it.*y or n. $" {
1004             send_gdb "y\n"
1005             verbose "\t\tKilling previous program being debugged"
1006             exp_continue
1007         }
1008         -re "Load new symbol table from \".*\".*y or n. $" {
1009             send_gdb "y\n"
1010             gdb_expect 120 {
1011                 -re "Reading symbols from.*done.*$gdb_prompt $" {
1012                     verbose "\t\tLoaded $arg with new symbol table into $GDB"
1013                     set gdb_file_cmd_debug_info "debug"
1014                     return 0
1015                 }
1016                 timeout {
1017                     perror "(timeout) Couldn't load $arg, other program already loaded."
1018                     return -1
1019                 }
1020             }
1021         }
1022         -re "No such file or directory.*$gdb_prompt $" {
1023             perror "($arg) No such file or directory"
1024             return -1
1025         }
1026         -re "$gdb_prompt $" {
1027             perror "couldn't load $arg into $GDB."
1028             return -1
1029             }
1030         timeout {
1031             perror "couldn't load $arg into $GDB (timed out)."
1032             return -1
1033         }
1034         eof {
1035             # This is an attempt to detect a core dump, but seems not to
1036             # work.  Perhaps we need to match .* followed by eof, in which
1037             # gdb_expect does not seem to have a way to do that.
1038             perror "couldn't load $arg into $GDB (end of file)."
1039             return -1
1040         }
1041     }
1042 }
1043
1044 #
1045 # start gdb -- start gdb running, default procedure
1046 #
1047 # When running over NFS, particularly if running many simultaneous
1048 # tests on different hosts all using the same server, things can
1049 # get really slow.  Give gdb at least 3 minutes to start up.
1050 #
1051 proc default_gdb_start { } {
1052     global verbose
1053     global GDB
1054     global GDBFLAGS
1055     global gdb_prompt
1056     global timeout
1057     global gdb_spawn_id;
1058
1059     gdb_stop_suppressing_tests;
1060
1061     verbose "Spawning $GDB -nw $GDBFLAGS"
1062
1063     if [info exists gdb_spawn_id] {
1064         return 0;
1065     }
1066
1067     if ![is_remote host] {
1068         if { [which $GDB] == 0 } then {
1069             perror "$GDB does not exist."
1070             exit 1
1071         }
1072     }
1073     set res [remote_spawn host "$GDB -nw $GDBFLAGS [host_info gdb_opts]"];
1074     if { $res < 0 || $res == "" } {
1075         perror "Spawning $GDB failed."
1076         return 1;
1077     }
1078     gdb_expect 360 {
1079         -re "\[\r\n\]$gdb_prompt $" {
1080             verbose "GDB initialized."
1081         }
1082         -re "$gdb_prompt $"     {
1083             perror "GDB never initialized."
1084             return -1
1085         }
1086         timeout {
1087             perror "(timeout) GDB never initialized after 10 seconds."
1088             remote_close host;
1089             return -1
1090         }
1091     }
1092     set gdb_spawn_id -1;
1093     # force the height to "unlimited", so no pagers get used
1094
1095     send_gdb "set height 0\n"
1096     gdb_expect 10 {
1097         -re "$gdb_prompt $" {
1098             verbose "Setting height to 0." 2
1099         }
1100         timeout {
1101             warning "Couldn't set the height to 0"
1102         }
1103     }
1104     # force the width to "unlimited", so no wraparound occurs
1105     send_gdb "set width 0\n"
1106     gdb_expect 10 {
1107         -re "$gdb_prompt $" {
1108             verbose "Setting width to 0." 2
1109         }
1110         timeout {
1111             warning "Couldn't set the width to 0."
1112         }
1113     }
1114     return 0;
1115 }
1116
1117 # Return a 1 for configurations for which we don't even want to try to
1118 # test C++.
1119
1120 proc skip_cplus_tests {} {
1121     if { [istarget "d10v-*-*"] } {
1122         return 1
1123     }
1124     if { [istarget "h8300-*-*"] } {
1125         return 1
1126     }
1127
1128     # The C++ IO streams are too large for HC11/HC12 and are thus not
1129     # available.  The gdb C++ tests use them and don't compile.
1130     if { [istarget "m6811-*-*"] } {
1131         return 1
1132     }
1133     if { [istarget "m6812-*-*"] } {
1134         return 1
1135     }
1136     return 0
1137 }
1138
1139 # Return a 1 if I don't even want to try to test FORTRAN.
1140
1141 proc skip_fortran_tests {} {
1142     return 0
1143 }
1144
1145 # Run a test on the target to see if it supports vmx hardware.  Return 0 if so,
1146 # 1 if it does not.  Based on 'check_vmx_hw_available' from the GCC testsuite.
1147
1148 proc skip_altivec_tests {} {
1149     global skip_vmx_tests_saved
1150     global srcdir subdir gdb_prompt
1151
1152     # Use the cached value, if it exists.
1153     set me "skip_altivec_tests"
1154     if [info exists skip_vmx_tests_saved] {
1155         verbose "$me:  returning saved $skip_vmx_tests_saved" 2
1156         return $skip_vmx_tests_saved
1157     }
1158
1159     # Some simulators are known to not support VMX instructions.
1160     if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
1161         verbose "$me:  target known to not support VMX, returning 1" 2
1162         return [set $skip_vmx_tests_saved 1]
1163     }
1164
1165     # Make sure we have a compiler that understands altivec.
1166     set compile_flags {debug additional_flags=-w}
1167     if [get_compiler_info not-used] {
1168        warning "Could not get compiler info"
1169        return 1
1170     }
1171     if [test_compiler_info gcc*] {
1172         set compile_flags "$compile_flags additional_flags=-maltivec"
1173     } elseif [test_compiler_info xlc*] {
1174         set compile_flags "$compile_flags additional_flags=-qaltivec"
1175     } else {
1176         verbose "Could not compile with altivec support, returning 1" 2
1177         return 1
1178     }
1179
1180     # Set up, compile, and execute a test program containing VMX instructions.
1181     # Include the current process ID in the file names to prevent conflicts
1182     # with invocations for multiple testsuites.
1183     set src vmx[pid].c
1184     set exe vmx[pid].x
1185
1186     set f [open $src "w"]
1187     puts $f "int main() {"
1188     puts $f "#ifdef __MACH__"
1189     puts $f "  asm volatile (\"vor v0,v0,v0\");"
1190     puts $f "#else"
1191     puts $f "  asm volatile (\"vor 0,0,0\");"
1192     puts $f "#endif"
1193     puts $f "  return 0; }"
1194     close $f
1195
1196     verbose "$me:  compiling testfile $src" 2
1197     set lines [gdb_compile $src $exe executable $compile_flags]
1198     file delete $src
1199
1200     if ![string match "" $lines] then {
1201         verbose "$me:  testfile compilation failed, returning 1" 2
1202         return [set skip_vmx_tests_saved 1]
1203     }
1204
1205     # No error message, compilation succeeded so now run it via gdb.
1206
1207     gdb_exit
1208     gdb_start
1209     gdb_reinitialize_dir $srcdir/$subdir
1210     gdb_load "$exe"
1211     gdb_run_cmd
1212     gdb_expect {
1213         -re ".*Illegal instruction.*${gdb_prompt} $" {
1214             verbose -log "\n$me altivec hardware not detected"
1215             set skip_vmx_tests_saved 1
1216         }
1217         -re ".*Program exited normally.*${gdb_prompt} $" {
1218             verbose -log "\n$me: altivec hardware detected"
1219             set skip_vmx_tests_saved 0
1220         }
1221         default {
1222           warning "\n$me: default case taken"
1223             set skip_vmx_tests_saved 1
1224         }
1225     }
1226     gdb_exit
1227     remote_file build delete $exe
1228
1229     verbose "$me:  returning $skip_vmx_tests_saved" 2
1230     return $skip_vmx_tests_saved
1231 }
1232
1233 # Skip all the tests in the file if you are not on an hppa running
1234 # hpux target.
1235
1236 proc skip_hp_tests {} {
1237     eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ]
1238     verbose "Skip hp tests is $skip_hp"
1239     return $skip_hp
1240 }
1241
1242 set compiler_info               "unknown"
1243 set gcc_compiled                0
1244 set hp_cc_compiler              0
1245 set hp_aCC_compiler             0
1246
1247 # Figure out what compiler I am using.
1248 #
1249 # BINFILE is a "compiler information" output file.  This implementation
1250 # does not use BINFILE.
1251 #
1252 # ARGS can be empty or "C++".  If empty, "C" is assumed.
1253 #
1254 # There are several ways to do this, with various problems.
1255 #
1256 # [ gdb_compile -E $ifile -o $binfile.ci ]
1257 # source $binfile.ci
1258 #
1259 #   Single Unix Spec v3 says that "-E -o ..." together are not
1260 #   specified.  And in fact, the native compiler on hp-ux 11 (among
1261 #   others) does not work with "-E -o ...".  Most targets used to do
1262 #   this, and it mostly worked, because it works with gcc.
1263 #
1264 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
1265 # source $binfile.ci
1266 #
1267 #   This avoids the problem with -E and -o together.  This almost works
1268 #   if the build machine is the same as the host machine, which is
1269 #   usually true of the targets which are not gcc.  But this code does
1270 #   not figure which compiler to call, and it always ends up using the C
1271 #   compiler.  Not good for setting hp_aCC_compiler.  Targets
1272 #   hppa*-*-hpux* and mips*-*-irix* used to do this.
1273 #
1274 # [ gdb_compile -E $ifile > $binfile.ci ]
1275 # source $binfile.ci
1276 #
1277 #   dejagnu target_compile says that it supports output redirection,
1278 #   but the code is completely different from the normal path and I
1279 #   don't want to sweep the mines from that path.  So I didn't even try
1280 #   this.
1281 #
1282 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
1283 # eval $cppout
1284 #
1285 #   I actually do this for all targets now.  gdb_compile runs the right
1286 #   compiler, and TCL captures the output, and I eval the output.
1287 #
1288 #   Unfortunately, expect logs the output of the command as it goes by,
1289 #   and dejagnu helpfully prints a second copy of it right afterwards.
1290 #   So I turn off expect logging for a moment.
1291 #
1292 # [ gdb_compile $ifile $ciexe_file executable $args ]
1293 # [ remote_exec $ciexe_file ]
1294 # [ source $ci_file.out ]
1295 #
1296 #   I could give up on -E and just do this.
1297 #   I didn't get desperate enough to try this.
1298 #
1299 # -- chastain 2004-01-06
1300
1301 proc get_compiler_info {binfile args} {
1302     # For compiler.c and compiler.cc
1303     global srcdir
1304
1305     # I am going to play with the log to keep noise out.
1306     global outdir
1307     global tool
1308
1309     # These come from compiler.c or compiler.cc
1310     global compiler_info
1311
1312     # Legacy global data symbols.
1313     global gcc_compiled
1314     global hp_cc_compiler
1315     global hp_aCC_compiler
1316
1317     # Choose which file to preprocess.
1318     set ifile "${srcdir}/lib/compiler.c"
1319     if { [llength $args] > 0 && [lindex $args 0] == "c++" } {
1320         set ifile "${srcdir}/lib/compiler.cc"
1321     }
1322
1323     # Run $ifile through the right preprocessor.
1324     # Toggle gdb.log to keep the compiler output out of the log.
1325     log_file
1326     set cppout [ gdb_compile "${ifile}" "" preprocess [list "$args" quiet] ]
1327     log_file -a "$outdir/$tool.log"
1328
1329     # Eval the output.
1330     set unknown 0
1331     foreach cppline [ split "$cppout" "\n" ] {
1332         if { [ regexp "^#" "$cppline" ] } {
1333             # line marker
1334         } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } {
1335             # blank line
1336         } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } {
1337             # eval this line
1338             verbose "get_compiler_info: $cppline" 2
1339             eval "$cppline"
1340         } else {
1341             # unknown line
1342             verbose -log "get_compiler_info: $cppline"
1343             set unknown 1
1344         }
1345     }
1346
1347     # Reset to unknown compiler if any diagnostics happened.
1348     if { $unknown } {
1349         set compiler_info "unknown"
1350     }
1351
1352     # Set the legacy symbols.
1353     set gcc_compiled     0
1354     set hp_cc_compiler   0
1355     set hp_aCC_compiler  0
1356     if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 }
1357     if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 }
1358     if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 }
1359     if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 }
1360     if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 }
1361     if { [regexp "^hpcc-"  "$compiler_info" ] } { set hp_cc_compiler 1 }
1362     if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 }
1363
1364     # Log what happened.
1365     verbose -log "get_compiler_info: $compiler_info"
1366
1367     # Most compilers will evaluate comparisons and other boolean
1368     # operations to 0 or 1.
1369     uplevel \#0 { set true 1 }
1370     uplevel \#0 { set false 0 }
1371
1372     # Use of aCC results in boolean results being displayed as
1373     # "true" or "false"
1374     if { $hp_aCC_compiler } {
1375       uplevel \#0 { set true true }
1376       uplevel \#0 { set false false }
1377     }
1378
1379     return 0;
1380 }
1381
1382 proc test_compiler_info { {compiler ""} } {
1383     global compiler_info
1384
1385      # if no arg, return the compiler_info string
1386
1387      if [string match "" $compiler] {
1388          if [info exists compiler_info] {
1389              return $compiler_info
1390          } else {
1391              perror "No compiler info found."
1392          }
1393      }
1394
1395     return [string match $compiler $compiler_info]
1396 }
1397
1398 set gdb_wrapper_initialized 0
1399
1400 proc gdb_wrapper_init { args } {
1401     global gdb_wrapper_initialized;
1402     global gdb_wrapper_file;
1403     global gdb_wrapper_flags;
1404
1405     if { $gdb_wrapper_initialized == 1 } { return; }
1406
1407     if {[target_info exists needs_status_wrapper] && \
1408             [target_info needs_status_wrapper] != "0"} {
1409         set result [build_wrapper "testglue.o"];
1410         if { $result != "" } {
1411             set gdb_wrapper_file [lindex $result 0];
1412             set gdb_wrapper_flags [lindex $result 1];
1413         } else {
1414             warning "Status wrapper failed to build."
1415         }
1416     }
1417     set gdb_wrapper_initialized 1
1418 }
1419
1420 proc gdb_compile {source dest type options} {
1421     global GDB_TESTCASE_OPTIONS;
1422     global gdb_wrapper_file;
1423     global gdb_wrapper_flags;
1424     global gdb_wrapper_initialized;
1425
1426      # Add platform-specific options if a shared library was specified using
1427      # "shlib=librarypath" in OPTIONS.
1428      set new_options ""
1429      set shlib_found 0
1430      foreach opt $options {
1431         if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] {
1432             if [test_compiler_info "xlc-*"] {
1433                # IBM xlc compiler doesn't accept shared library named other
1434                # than .so: use "-Wl," to bypass this
1435                lappend source "-Wl,$shlib_name"
1436             } else {
1437                lappend source $shlib_name
1438             }
1439             if {$shlib_found == 0} {
1440                 set shlib_found 1
1441                 if { ([test_compiler_info "gcc-*"]
1442                       &&  ([istarget "powerpc*-*-aix*"]
1443                         || [istarget "rs6000*-*-aix*"] )) } {
1444                     lappend options "additional_flags=-L${objdir}/${subdir}"
1445                 } elseif { [istarget "mips-sgi-irix*"] } {
1446                     lappend options "additional_flags=-rpath ${objdir}/${subdir}"
1447                 }
1448             }
1449         } else {
1450             lappend new_options $opt
1451         }
1452      }
1453      set options $new_options
1454
1455     if [target_info exists gdb_stub] {
1456         set options2 { "additional_flags=-Dusestubs" }
1457         lappend options "libs=[target_info gdb_stub]";
1458         set options [concat $options2 $options]
1459     }
1460     if [target_info exists is_vxworks] {
1461         set options2 { "additional_flags=-Dvxworks" }
1462         lappend options "libs=[target_info gdb_stub]";
1463         set options [concat $options2 $options]
1464     }
1465     if [info exists GDB_TESTCASE_OPTIONS] {
1466         lappend options "additional_flags=$GDB_TESTCASE_OPTIONS";
1467     }
1468     verbose "options are $options"
1469     verbose "source is $source $dest $type $options"
1470
1471     if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
1472
1473     if {[target_info exists needs_status_wrapper] && \
1474             [target_info needs_status_wrapper] != "0" && \
1475             [info exists gdb_wrapper_file]} {
1476         lappend options "libs=${gdb_wrapper_file}"
1477         lappend options "ldflags=${gdb_wrapper_flags}"
1478     }
1479
1480     set result [target_compile $source $dest $type $options];
1481     regsub "\[\r\n\]*$" "$result" "" result;
1482     regsub "^\[\r\n\]*" "$result" "" result;
1483     if { $result != "" && [lsearch $options quiet] == -1} {
1484         clone_output "gdb compile failed, $result"
1485     }
1486     return $result;
1487 }
1488
1489
1490 # This is just like gdb_compile, above, except that it tries compiling
1491 # against several different thread libraries, to see which one this
1492 # system has.
1493 proc gdb_compile_pthreads {source dest type options} {
1494     set built_binfile 0
1495     set why_msg "unrecognized error"
1496     foreach lib {-lpthreads -lpthread -lthread} {
1497         # This kind of wipes out whatever libs the caller may have
1498         # set.  Or maybe theirs will override ours.  How infelicitous.
1499         set options_with_lib [concat $options [list libs=$lib quiet]]
1500         set ccout [gdb_compile $source $dest $type $options_with_lib]
1501         switch -regexp -- $ccout {
1502             ".*no posix threads support.*" {
1503                 set why_msg "missing threads include file"
1504                 break
1505             }
1506             ".*cannot open -lpthread.*" {
1507                 set why_msg "missing runtime threads library"
1508             }
1509             ".*Can't find library for -lpthread.*" {
1510                 set why_msg "missing runtime threads library"
1511             }
1512             {^$} {
1513                 pass "successfully compiled posix threads test case"
1514                 set built_binfile 1
1515                 break
1516             }
1517         }
1518     }
1519     if {!$built_binfile} {
1520         unsupported "Couldn't compile $source: ${why_msg}"
1521         return -1
1522     }
1523 }
1524
1525 # Build a shared library from SOURCES.  You must use get_compiler_info
1526 # first.
1527
1528 proc gdb_compile_shlib {sources dest options} {
1529     set obj_options $options
1530
1531     switch -glob [test_compiler_info] {
1532         "xlc-*" {
1533             lappend obj_options "additional_flags=-qpic"
1534         }
1535         "gcc-*" {
1536             if { !([istarget "powerpc*-*-aix*"]
1537                    || [istarget "rs6000*-*-aix*"]) } {
1538                 lappend obj_options "additional_flags=-fpic"
1539             }
1540         }
1541         default {
1542             switch -glob [istarget] {
1543                 "hppa*-hp-hpux*" {
1544                     lappend obj_options "additional_flags=+z"
1545                 }
1546                 "mips-sgi-irix*" {
1547                     # Disable SGI compiler's implicit -Dsgi
1548                     lappend obj_options "additional_flags=-Usgi"
1549                 }
1550                 default {
1551                     # don't know what the compiler is...
1552                 }
1553             }
1554         }
1555     }
1556
1557     set outdir [file dirname $dest]
1558     set objects ""
1559     foreach source $sources {
1560        set sourcebase [file tail $source]
1561        if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} {
1562            return -1
1563        }
1564        lappend objects ${outdir}/${sourcebase}.o
1565     }
1566
1567     if [istarget "hppa*-*-hpux*"] {
1568        remote_exec build "ld -b ${objects} -o ${dest}"
1569     } else {
1570        set link_options $options
1571        if [test_compiler_info "xlc-*"] {
1572           lappend link_options "additional_flags=-qmkshrobj"
1573        } else {
1574           lappend link_options "additional_flags=-shared"
1575        }
1576        if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} {
1577            return -1
1578        }
1579     }
1580 }
1581
1582 # This is just like gdb_compile_pthreads, above, except that we always add the
1583 # objc library for compiling Objective-C programs
1584 proc gdb_compile_objc {source dest type options} {
1585     set built_binfile 0
1586     set why_msg "unrecognized error"
1587     foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} {
1588         # This kind of wipes out whatever libs the caller may have
1589         # set.  Or maybe theirs will override ours.  How infelicitous.
1590         if { $lib == "solaris" } {
1591             set lib "-lpthread -lposix4"
1592         }
1593         if { $lib != "-lobjc" } {
1594           set lib "-lobjc $lib"
1595         }
1596         set options_with_lib [concat $options [list libs=$lib quiet]]
1597         set ccout [gdb_compile $source $dest $type $options_with_lib]
1598         switch -regexp -- $ccout {
1599             ".*no posix threads support.*" {
1600                 set why_msg "missing threads include file"
1601                 break
1602             }
1603             ".*cannot open -lpthread.*" {
1604                 set why_msg "missing runtime threads library"
1605             }
1606             ".*Can't find library for -lpthread.*" {
1607                 set why_msg "missing runtime threads library"
1608             }
1609             {^$} {
1610                 pass "successfully compiled objc with posix threads test case"
1611                 set built_binfile 1
1612                 break
1613             }
1614         }
1615     }
1616     if {!$built_binfile} {
1617         unsupported "Couldn't compile $source: ${why_msg}"
1618         return -1
1619     }
1620 }
1621
1622 proc send_gdb { string } {
1623     global suppress_flag;
1624     if { $suppress_flag } {
1625         return "suppressed";
1626     }
1627     return [remote_send host "$string"];
1628 }
1629
1630 #
1631 #
1632
1633 proc gdb_expect { args } {
1634     if { [llength $args] == 2  && [lindex $args 0] != "-re" } {
1635         set gtimeout [lindex $args 0];
1636         set expcode [list [lindex $args 1]];
1637     } else {
1638         upvar timeout timeout;
1639
1640         set expcode $args;
1641         if [target_info exists gdb,timeout] {
1642             if [info exists timeout] {
1643                 if { $timeout < [target_info gdb,timeout] } {
1644                     set gtimeout [target_info gdb,timeout];
1645                 } else {
1646                     set gtimeout $timeout;
1647                 }
1648             } else {
1649                 set gtimeout [target_info gdb,timeout];
1650             }
1651         }
1652
1653         if ![info exists gtimeout] {
1654             global timeout;
1655             if [info exists timeout] {
1656                 set gtimeout $timeout;
1657             } else {
1658                 # Eeeeew.
1659                 set gtimeout 60;
1660             }
1661         }
1662     }
1663     global suppress_flag;
1664     global remote_suppress_flag;
1665     if [info exists remote_suppress_flag] {
1666         set old_val $remote_suppress_flag;
1667     }
1668     if [info exists suppress_flag] {
1669         if { $suppress_flag } {
1670             set remote_suppress_flag 1;
1671         }
1672     }
1673     set code [catch \
1674         {uplevel remote_expect host $gtimeout $expcode} string];
1675     if [info exists old_val] {
1676         set remote_suppress_flag $old_val;
1677     } else {
1678         if [info exists remote_suppress_flag] {
1679             unset remote_suppress_flag;
1680         }
1681     }
1682
1683     if {$code == 1} {
1684         global errorInfo errorCode;
1685
1686         return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1687     } elseif {$code == 2} {
1688         return -code return $string
1689     } elseif {$code == 3} {
1690         return
1691     } elseif {$code > 4} {
1692         return -code $code $string
1693     }
1694 }
1695
1696 # gdb_expect_list MESSAGE SENTINEL LIST -- expect a sequence of outputs
1697 #
1698 # Check for long sequence of output by parts.
1699 # MESSAGE: is the test message to be printed with the test success/fail.
1700 # SENTINEL: Is the terminal pattern indicating that output has finished.
1701 # LIST: is the sequence of outputs to match.
1702 # If the sentinel is recognized early, it is considered an error.
1703 #
1704 # Returns:
1705 #    1 if the test failed,
1706 #    0 if the test passes,
1707 #   -1 if there was an internal error.
1708 #
1709 proc gdb_expect_list {test sentinel list} {
1710     global gdb_prompt
1711     global suppress_flag
1712     set index 0
1713     set ok 1
1714     if { $suppress_flag } {
1715         set ok 0
1716         unresolved "${test}"
1717     }
1718     while { ${index} < [llength ${list}] } {
1719         set pattern [lindex ${list} ${index}]
1720         set index [expr ${index} + 1]
1721         if { ${index} == [llength ${list}] } {
1722             if { ${ok} } {
1723                 gdb_expect {
1724                     -re "${pattern}${sentinel}" {
1725                         # pass "${test}, pattern ${index} + sentinel"
1726                     }
1727                     -re "${sentinel}" {
1728                         fail "${test} (pattern ${index} + sentinel)"
1729                         set ok 0
1730                     }
1731                     -re ".*A problem internal to GDB has been detected" {
1732                         fail "${test} (GDB internal error)"
1733                         set ok 0
1734                         gdb_internal_error_resync
1735                     }
1736                     timeout {
1737                         fail "${test} (pattern ${index} + sentinel) (timeout)"
1738                         set ok 0
1739                     }
1740                 }
1741             } else {
1742                 # unresolved "${test}, pattern ${index} + sentinel"
1743             }
1744         } else {
1745             if { ${ok} } {
1746                 gdb_expect {
1747                     -re "${pattern}" {
1748                         # pass "${test}, pattern ${index}"
1749                     }
1750                     -re "${sentinel}" {
1751                         fail "${test} (pattern ${index})"
1752                         set ok 0
1753                     }
1754                     -re ".*A problem internal to GDB has been detected" {
1755                         fail "${test} (GDB internal error)"
1756                         set ok 0
1757                         gdb_internal_error_resync
1758                     }
1759                     timeout {
1760                         fail "${test} (pattern ${index}) (timeout)"
1761                         set ok 0
1762                     }
1763                 }
1764             } else {
1765                 # unresolved "${test}, pattern ${index}"
1766             }
1767         }
1768     }
1769     if { ${ok} } {
1770         pass "${test}"
1771         return 0
1772     } else {
1773         return 1
1774     }
1775 }
1776
1777 #
1778 #
1779 proc gdb_suppress_entire_file { reason } {
1780     global suppress_flag;
1781
1782     warning "$reason\n";
1783     set suppress_flag -1;
1784 }
1785
1786 #
1787 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
1788 # gdb_expect to fail immediately (until the next call to
1789 # gdb_stop_suppressing_tests).
1790 #
1791 proc gdb_suppress_tests { args } {
1792     global suppress_flag;
1793
1794     return;  # fnf - disable pending review of results where
1795              # testsuite ran better without this
1796     incr suppress_flag;
1797
1798     if { $suppress_flag == 1 } {
1799         if { [llength $args] > 0 } {
1800             warning "[lindex $args 0]\n";
1801         } else {
1802             warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n";
1803         }
1804     }
1805 }
1806
1807 #
1808 # Clear suppress_flag.
1809 #
1810 proc gdb_stop_suppressing_tests { } {
1811     global suppress_flag;
1812
1813     if [info exists suppress_flag] {
1814         if { $suppress_flag > 0 } {
1815             set suppress_flag 0;
1816             clone_output "Tests restarted.\n";
1817         }
1818     } else {
1819         set suppress_flag 0;
1820     }
1821 }
1822
1823 proc gdb_clear_suppressed { } {
1824     global suppress_flag;
1825
1826     set suppress_flag 0;
1827 }
1828
1829 proc gdb_start { } {
1830     default_gdb_start
1831 }
1832
1833 proc gdb_exit { } {
1834     catch default_gdb_exit
1835 }
1836
1837 #
1838 # gdb_load -- load a file into the debugger.
1839 # Many files in config/*.exp override this procedure.
1840 #
1841 proc gdb_load { arg } {
1842     return [gdb_file_cmd $arg]
1843 }
1844
1845 proc gdb_continue { function } {
1846     global decimal
1847
1848     return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"];
1849 }
1850
1851 proc default_gdb_init { args } {
1852     global gdb_wrapper_initialized
1853
1854     gdb_clear_suppressed;
1855
1856     # Make sure that the wrapper is rebuilt
1857     # with the appropriate multilib option.
1858     set gdb_wrapper_initialized 0
1859
1860     # Uh, this is lame. Really, really, really lame. But there's this *one*
1861     # testcase that will fail in random places if we don't increase this.
1862     match_max -d 20000
1863
1864     # We want to add the name of the TCL testcase to the PASS/FAIL messages.
1865     if { [llength $args] > 0 } {
1866         global pf_prefix
1867
1868         set file [lindex $args 0];
1869
1870         set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:";
1871     }
1872     global gdb_prompt;
1873     if [target_info exists gdb_prompt] {
1874         set gdb_prompt [target_info gdb_prompt];
1875     } else {
1876         set gdb_prompt "\\(gdb\\)"
1877     }
1878 }
1879
1880 proc gdb_init { args } {
1881     return [eval default_gdb_init $args];
1882 }
1883
1884 proc gdb_finish { } {
1885     gdb_exit;
1886 }
1887
1888 global debug_format
1889 set debug_format "unknown"
1890
1891 # Run the gdb command "info source" and extract the debugging format
1892 # information from the output and save it in debug_format.
1893
1894 proc get_debug_format { } {
1895     global gdb_prompt
1896     global verbose
1897     global expect_out
1898     global debug_format
1899
1900     set debug_format "unknown"
1901     send_gdb "info source\n"
1902     gdb_expect 10 {
1903         -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" {
1904             set debug_format $expect_out(1,string)
1905             verbose "debug format is $debug_format"
1906             return 1;
1907         }
1908         -re "No current source file.\r\n$gdb_prompt $" {
1909             perror "get_debug_format used when no current source file"
1910             return 0;
1911         }
1912         -re "$gdb_prompt $" {
1913             warning "couldn't check debug format (no valid response)."
1914             return 1;
1915         }
1916         timeout {
1917             warning "couldn't check debug format (timed out)."
1918             return 1;
1919         }
1920     }
1921 }
1922
1923 # Return true if FORMAT matches the debug format the current test was
1924 # compiled with.  FORMAT is a shell-style globbing pattern; it can use
1925 # `*', `[...]', and so on.
1926 #
1927 # This function depends on variables set by `get_debug_format', above.
1928
1929 proc test_debug_format {format} {
1930     global debug_format
1931
1932     return [expr [string match $format $debug_format] != 0]
1933 }
1934
1935 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
1936 # COFF, stabs, etc).  If that format matches the format that the
1937 # current test was compiled with, then the next test is expected to
1938 # fail for any target.  Returns 1 if the next test or set of tests is
1939 # expected to fail, 0 otherwise (or if it is unknown).  Must have
1940 # previously called get_debug_format.
1941 proc setup_xfail_format { format } {
1942     set ret [test_debug_format $format];
1943
1944     if {$ret} then {
1945         setup_xfail "*-*-*"
1946     }
1947     return $ret;
1948 }
1949
1950 proc gdb_step_for_stub { } {
1951     global gdb_prompt;
1952
1953     if ![target_info exists gdb,use_breakpoint_for_stub] {
1954         if [target_info exists gdb_stub_step_command] {
1955             set command [target_info gdb_stub_step_command];
1956         } else {
1957             set command "step";
1958         }
1959         send_gdb "${command}\n";
1960         set tries 0;
1961         gdb_expect 60 {
1962             -re "(main.* at |.*in .*start).*$gdb_prompt" {
1963                 return;
1964             }
1965             -re ".*$gdb_prompt" {
1966                 incr tries;
1967                 if { $tries == 5 } {
1968                     fail "stepping out of breakpoint function";
1969                     return;
1970                 }
1971                 send_gdb "${command}\n";
1972                 exp_continue;
1973             }
1974             default {
1975                 fail "stepping out of breakpoint function";
1976                 return;
1977             }
1978         }
1979     }
1980     send_gdb "where\n";
1981     gdb_expect {
1982         -re "main\[^\r\n\]*at \(\[^:]+\):\(\[0-9\]+\)" {
1983             set file $expect_out(1,string);
1984             set linenum [expr $expect_out(2,string) + 1];
1985             set breakplace "${file}:${linenum}";
1986         }
1987         default {}
1988     }
1989     send_gdb "break ${breakplace}\n";
1990     gdb_expect 60 {
1991         -re "Breakpoint (\[0-9\]+) at.*$gdb_prompt" {
1992             set breakpoint $expect_out(1,string);
1993         }
1994         -re "Breakpoint (\[0-9\]+): file.*$gdb_prompt" {
1995             set breakpoint $expect_out(1,string);
1996         }
1997         default {}
1998     }
1999     send_gdb "continue\n";
2000     gdb_expect 60 {
2001         -re "Breakpoint ${breakpoint},.*$gdb_prompt" {
2002             gdb_test "delete $breakpoint" ".*" "";
2003             return;
2004         }
2005         default {}
2006     }
2007 }
2008
2009 # gdb_get_line_number TEXT [FILE]
2010 #
2011 # Search the source file FILE, and return the line number of the
2012 # first line containing TEXT.  If no match is found, return -1.
2013 #
2014 # TEXT is a string literal, not a regular expression.
2015 #
2016 # The default value of FILE is "$srcdir/$subdir/$srcfile".  If FILE is
2017 # specified, and does not start with "/", then it is assumed to be in
2018 # "$srcdir/$subdir".  This is awkward, and can be fixed in the future,
2019 # by changing the callers and the interface at the same time.
2020 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
2021 # gdb.base/ena-dis-br.exp.
2022 #
2023 # Use this function to keep your test scripts independent of the
2024 # exact line numbering of the source file.  Don't write:
2025 #
2026 #   send_gdb "break 20"
2027 #
2028 # This means that if anyone ever edits your test's source file,
2029 # your test could break.  Instead, put a comment like this on the
2030 # source file line you want to break at:
2031 #
2032 #   /* breakpoint spot: frotz.exp: test name */
2033 #
2034 # and then write, in your test script (which we assume is named
2035 # frotz.exp):
2036 #
2037 #   send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n"
2038 #
2039 # (Yes, Tcl knows how to handle the nested quotes and brackets.
2040 # Try this:
2041 #       $ tclsh
2042 #       % puts "foo [lindex "bar baz" 1]"
2043 #       foo baz
2044 #       %
2045 # Tcl is quite clever, for a little stringy language.)
2046 #
2047 # ===
2048 #
2049 # The previous implementation of this procedure used the gdb search command.
2050 # This version is different:
2051 #
2052 #   . It works with MI, and it also works when gdb is not running.
2053 #
2054 #   . It operates on the build machine, not the host machine.
2055 #
2056 #   . For now, this implementation fakes a current directory of
2057 #     $srcdir/$subdir to be compatible with the old implementation.
2058 #     This will go away eventually and some callers will need to
2059 #     be changed.
2060 #
2061 #   . The TEXT argument is literal text and matches literally,
2062 #     not a regular expression as it was before.
2063 #
2064 #   . State changes in gdb, such as changing the current file
2065 #     and setting $_, no longer happen.
2066 #
2067 # After a bit of time we can forget about the differences from the
2068 # old implementation.
2069 #
2070 # --chastain 2004-08-05
2071
2072 proc gdb_get_line_number { text { file "" } } {
2073     global srcdir
2074     global subdir
2075     global srcfile
2076
2077     if { "$file" == "" } then {
2078         set file "$srcfile"
2079     }
2080     if { ! [regexp "^/" "$file"] } then {
2081         set file "$srcdir/$subdir/$file"
2082     }
2083
2084     if { [ catch { set fd [open "$file"] } message ] } then {
2085         perror "$message"
2086         return -1
2087     }
2088
2089     set found -1
2090     for { set line 1 } { 1 } { incr line } {
2091         if { [ catch { set nchar [gets "$fd" body] } message ] } then {
2092             perror "$message"
2093             return -1
2094         }
2095         if { $nchar < 0 } then {
2096             break
2097         }
2098         if { [string first "$text" "$body"] >= 0 } then {
2099             set found $line
2100             break
2101         }
2102     }
2103
2104     if { [ catch { close "$fd" } message ] } then {
2105         perror "$message"
2106         return -1
2107     }
2108
2109     return $found
2110 }
2111
2112 # gdb_continue_to_end:
2113 #       The case where the target uses stubs has to be handled specially. If a
2114 #       stub is used, we set a breakpoint at exit because we cannot rely on
2115 #       exit() behavior of a remote target.
2116 #
2117 # mssg is the error message that gets printed.
2118
2119 proc gdb_continue_to_end {mssg} {
2120   if [target_info exists use_gdb_stub] {
2121     if {![gdb_breakpoint "exit"]} {
2122       return 0
2123     }
2124     gdb_test "continue" "Continuing..*Breakpoint .*exit.*" \
2125       "continue until exit at $mssg"
2126   } else {
2127     # Continue until we exit.  Should not stop again.
2128     # Don't bother to check the output of the program, that may be
2129     # extremely tough for some remote systems.
2130     gdb_test "continue"\
2131       "Continuing.\[\r\n0-9\]+(... EXIT code 0\[\r\n\]+|Program exited normally\\.).*"\
2132       "continue until exit at $mssg"
2133   }
2134 }
2135
2136 proc rerun_to_main {} {
2137   global gdb_prompt
2138
2139   if [target_info exists use_gdb_stub] {
2140     gdb_run_cmd
2141     gdb_expect {
2142       -re ".*Breakpoint .*main .*$gdb_prompt $"\
2143               {pass "rerun to main" ; return 0}
2144       -re "$gdb_prompt $"\
2145               {fail "rerun to main" ; return 0}
2146       timeout {fail "(timeout) rerun to main" ; return 0}
2147     }
2148   } else {
2149     send_gdb "run\n"
2150     gdb_expect {
2151       -re "The program .* has been started already.*y or n. $" {
2152           send_gdb "y\n"
2153           exp_continue
2154       }
2155       -re "Starting program.*$gdb_prompt $"\
2156               {pass "rerun to main" ; return 0}
2157       -re "$gdb_prompt $"\
2158               {fail "rerun to main" ; return 0}
2159       timeout {fail "(timeout) rerun to main" ; return 0}
2160     }
2161   }
2162 }
2163
2164 # Print a message and return true if a test should be skipped
2165 # due to lack of floating point suport.
2166
2167 proc gdb_skip_float_test { msg } {
2168     if [target_info exists gdb,skip_float_tests] {
2169         verbose "Skipping test '$msg': no float tests.";
2170         return 1;
2171     }
2172     return 0;
2173 }
2174
2175 # Print a message and return true if a test should be skipped
2176 # due to lack of stdio support.
2177
2178 proc gdb_skip_stdio_test { msg } {
2179     if [target_info exists gdb,noinferiorio] {
2180         verbose "Skipping test '$msg': no inferior i/o.";
2181         return 1;
2182     }
2183     return 0;
2184 }
2185
2186 proc gdb_skip_bogus_test { msg } {
2187     return 0;
2188 }
2189
2190
2191 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
2192 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
2193 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
2194 # the name of a idebuginfo only file. This file will be stored in the
2195 # gdb.base/.debug subdirectory.
2196
2197 # Functions for separate debug info testing
2198
2199 # starting with an executable:
2200 # foo --> original executable
2201
2202 # at the end of the process we have:
2203 # foo.stripped --> foo w/o debug info
2204 # .debug/foo.debug --> foo's debug info
2205 # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug.
2206
2207 # Return the name of the file in which we should stor EXEC's separated
2208 # debug info. EXEC contains the full path.
2209 proc separate_debug_filename { exec } {
2210
2211     # In a .debug subdirectory off the same directory where the testcase
2212     # executable is going to be. Something like:
2213     # <your-path>/gdb/testsuite/gdb.base/.debug/blah.debug.
2214     # This is the default location where gdb expects to findi
2215     # the debug info file.
2216
2217     set exec_dir [file dirname $exec]
2218     set exec_file [file tail $exec]
2219     set debug_dir [file join $exec_dir ".debug"]
2220     set debug_file [file join $debug_dir "${exec_file}.debug"]
2221
2222     return $debug_file
2223 }
2224
2225
2226 proc gdb_gnu_strip_debug { dest } {
2227
2228     set debug_file [separate_debug_filename $dest]
2229     set strip_to_file_program strip
2230     set objcopy_program objcopy
2231
2232     # Make sure the directory that will hold the separated debug
2233     # info actually exists.
2234     set debug_dir [file dirname $debug_file]
2235     if {! [file isdirectory $debug_dir]} {
2236         file mkdir $debug_dir
2237     }
2238
2239     set debug_link [file tail $debug_file]
2240     set stripped_file "${dest}.stripped"
2241
2242     # Get rid of the debug info, and store result in stripped_file
2243     # something like gdb/testsuite/gdb.base/blah.stripped.
2244     set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
2245     verbose "result is $result"
2246     verbose "output is $output"
2247     if {$result == 1} {
2248       return 1
2249     }
2250
2251     # Get rid of everything but the debug info, and store result in debug_file
2252     # This will be in the .debug subdirectory, see above.
2253     set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
2254     verbose "result is $result"
2255     verbose "output is $output"
2256     if {$result == 1} {
2257       return 1
2258     }
2259
2260     # Link the two previous output files together, adding the .gnu_debuglink
2261     # section to the stripped_file, containing a pointer to the debug_file,
2262     # save the new file in dest.
2263     # This will be the regular executable filename, in the usual location.
2264     set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
2265     verbose "result is $result"
2266     verbose "output is $output"
2267     if {$result == 1} {
2268       return 1
2269     }
2270
2271    return 0
2272 }
2273