# Copyright 1992-2014 Free Software Foundation, Inc. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # This file was written by Fred Fish. (fnf@cygnus.com) # Generic gdb subroutines that should work for any target. If these # need to be modified for any target, it can be done with a variable # or by passing arguments. if {$tool == ""} { # Tests would fail, logs on get_compiler_info() would be missing. send_error "`site.exp' not found, run `make site.exp'!\n" exit 2 } load_lib libgloss.exp load_lib cache.exp global GDB if [info exists TOOL_EXECUTABLE] { set GDB $TOOL_EXECUTABLE } if ![info exists GDB] { if ![is_remote host] { set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]] } else { set GDB [transform gdb] } } verbose "using GDB = $GDB" 2 # GDBFLAGS is available for the user to set on the command line. # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble # Testcases may use it to add additional flags, but they must: # - append new flags, not overwrite # - restore the original value when done global GDBFLAGS if ![info exists GDBFLAGS] { set GDBFLAGS "" } verbose "using GDBFLAGS = $GDBFLAGS" 2 # Make the build data directory available to tests. set BUILD_DATA_DIRECTORY "[pwd]/../data-directory" # INTERNAL_GDBFLAGS contains flags that the testsuite requires. global INTERNAL_GDBFLAGS if ![info exists INTERNAL_GDBFLAGS] { set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY" } # The variable gdb_prompt is a regexp which matches the gdb prompt. # Set it if it is not already set. global gdb_prompt if ![info exists gdb_prompt] then { set gdb_prompt "\[(\]gdb\[)\]" } # The variable fullname_syntax_POSIX is a regexp which matches a POSIX # absolute path ie. /foo/ set fullname_syntax_POSIX {/[^\n]*/} # The variable fullname_syntax_UNC is a regexp which matches a Windows # UNC path ie. \\D\foo\ set fullname_syntax_UNC {\\\\[^\\]+\\[^\n]+\\} # The variable fullname_syntax_DOS_CASE is a regexp which matches a # particular DOS case that GDB most likely will output # ie. \foo\, but don't match \\.*\ set fullname_syntax_DOS_CASE {\\[^\\][^\n]*\\} # The variable fullname_syntax_DOS is a regexp which matches a DOS path # ie. a:\foo\ && a:foo\ set fullname_syntax_DOS {[a-zA-Z]:[^\n]*\\} # The variable fullname_syntax is a regexp which matches what GDB considers # an absolute path. It is currently debatable if the Windows style paths # d:foo and \abc should be considered valid as an absolute path. # Also, the purpse of this regexp is not to recognize a well formed # absolute path, but to say with certainty that a path is absolute. set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)" # Needed for some tests under Cygwin. global EXEEXT global env if ![info exists env(EXEEXT)] { set EXEEXT "" } else { set EXEEXT $env(EXEEXT) } set octal "\[0-7\]+" set inferior_exited_re "(\\\[Inferior \[0-9\]+ \\(.*\\) exited)" ### Only procedures should come after this point. # # gdb_version -- extract and print the version number of GDB # proc default_gdb_version {} { global GDB global INTERNAL_GDBFLAGS GDBFLAGS global gdb_prompt global inotify_pid if {[info exists inotify_pid]} { eval exec kill $inotify_pid } set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"] set tmp [lindex $output 1] set version "" regexp " \[0-9\]\[^ \t\n\r\]+" "$tmp" version if ![is_remote host] { clone_output "[which $GDB] version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n" } else { clone_output "$GDB on remote host version $version $INTERNAL_GDBFLAGS $GDBFLAGS\n" } } proc gdb_version { } { return [default_gdb_version] } # # gdb_unload -- unload a file if one is loaded # Return 0 on success, -1 on error. # proc gdb_unload {} { global verbose global GDB global gdb_prompt send_gdb "file\n" gdb_expect 60 { -re "No executable file now\[^\r\n\]*\[\r\n\]" { exp_continue } -re "No symbol file now\[^\r\n\]*\[\r\n\]" { exp_continue } -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" { send_gdb "y\n" exp_continue } -re "Discard symbol table from .*y or n.*$" { send_gdb "y\n" exp_continue } -re "$gdb_prompt $" {} timeout { perror "couldn't unload file in $GDB (timeout)." return -1 } } return 0 } # Many of the tests depend on setting breakpoints at various places and # running until that breakpoint is reached. At times, we want to start # with a clean-slate with respect to breakpoints, so this utility proc # lets us do this without duplicating this code everywhere. # proc delete_breakpoints {} { global gdb_prompt # we need a larger timeout value here or this thing just confuses # itself. May need a better implementation if possible. - guo # send_gdb "delete breakpoints\n" gdb_expect 100 { -re "Delete all breakpoints.*y or n.*$" { send_gdb "y\n" exp_continue } -re "$gdb_prompt $" { # This happens if there were no breakpoints } timeout { perror "Delete all breakpoints in delete_breakpoints (timeout)" ; return } } send_gdb "info breakpoints\n" gdb_expect 100 { -re "No breakpoints or watchpoints..*$gdb_prompt $" {} -re "$gdb_prompt $" { perror "breakpoints not deleted" ; return } -re "Delete all breakpoints.*or n.*$" { send_gdb "y\n" exp_continue } timeout { perror "info breakpoints (timeout)" ; return } } } # Generic run command. # # The second pattern below matches up to the first newline *only*. # Using ``.*$'' could swallow up output that we attempt to match # elsewhere. # # N.B. This function does not wait for gdb to return to the prompt, # that is the caller's responsibility. proc gdb_run_cmd {args} { global gdb_prompt use_gdb_stub if [target_info exists gdb_init_command] { send_gdb "[target_info gdb_init_command]\n" gdb_expect 30 { -re "$gdb_prompt $" { } default { perror "gdb_init_command for target failed" return } } } if $use_gdb_stub { if [target_info exists gdb,do_reload_on_run] { if { [gdb_reload] != 0 } { return } send_gdb "continue\n" gdb_expect 60 { -re "Continu\[^\r\n\]*\[\r\n\]" {} default {} } return } if [target_info exists gdb,start_symbol] { set start [target_info gdb,start_symbol] } else { set start "start" } send_gdb "jump *$start\n" set start_attempt 1 while { $start_attempt } { # Cap (re)start attempts at three to ensure that this loop # always eventually fails. Don't worry about trying to be # clever and not send a command when it has failed. if [expr $start_attempt > 3] { perror "Jump to start() failed (retry count exceeded)" return } set start_attempt [expr $start_attempt + 1] gdb_expect 30 { -re "Continuing at \[^\r\n\]*\[\r\n\]" { set start_attempt 0 } -re "No symbol \"_start\" in current.*$gdb_prompt $" { perror "Can't find start symbol to run in gdb_run" return } -re "No symbol \"start\" in current.*$gdb_prompt $" { send_gdb "jump *_start\n" } -re "No symbol.*context.*$gdb_prompt $" { set start_attempt 0 } -re "Line.* Jump anyway.*y or n. $" { send_gdb "y\n" } -re "The program is not being run.*$gdb_prompt $" { if { [gdb_reload] != 0 } { return } send_gdb "jump *$start\n" } timeout { perror "Jump to start() failed (timeout)" return } } } return } if [target_info exists gdb,do_reload_on_run] { if { [gdb_reload] != 0 } { return } } send_gdb "run $args\n" # This doesn't work quite right yet. # Use -notransfer here so that test cases (like chng-sym.exp) # may test for additional start-up messages. gdb_expect 60 { -re "The program .* has been started already.*y or n. $" { send_gdb "y\n" exp_continue } -notransfer -re "Starting program: \[^\r\n\]*" {} -notransfer -re "$gdb_prompt $" { # There is no more input expected. } } } # Generic start command. Return 0 if we could start the program, -1 # if we could not. # # N.B. This function does not wait for gdb to return to the prompt, # that is the caller's responsibility. proc gdb_start_cmd {args} { global gdb_prompt use_gdb_stub if [target_info exists gdb_init_command] { send_gdb "[target_info gdb_init_command]\n" gdb_expect 30 { -re "$gdb_prompt $" { } default { perror "gdb_init_command for target failed" return -1 } } } if $use_gdb_stub { return -1 } send_gdb "start $args\n" # Use -notransfer here so that test cases (like chng-sym.exp) # may test for additional start-up messages. gdb_expect 60 { -re "The program .* has been started already.*y or n. $" { send_gdb "y\n" exp_continue } -notransfer -re "Starting program: \[^\r\n\]*" { return 0 } } return -1 } # Set a breakpoint at FUNCTION. If there is an additional argument it is # a list of options; the supported options are allow-pending, temporary, # message, no-message, and passfail. # The result is 1 for success, 0 for failure. # # Note: The handling of message vs no-message is messed up, but it's based # on historical usage. By default this function does not print passes, # only fails. # no-message: turns off printing of fails (and passes, but they're already off) # message: turns on printing of passes (and fails, but they're already on) proc gdb_breakpoint { function args } { global gdb_prompt global decimal set pending_response n if {[lsearch -exact $args allow-pending] != -1} { set pending_response y } set break_command "break" set break_message "Breakpoint" if {[lsearch -exact $args temporary] != -1} { set break_command "tbreak" set break_message "Temporary breakpoint" } set print_pass 0 set print_fail 1 set no_message_loc [lsearch -exact $args no-message] set message_loc [lsearch -exact $args message] # The last one to appear in args wins. if { $no_message_loc > $message_loc } { set print_fail 0 } elseif { $message_loc > $no_message_loc } { set print_pass 1 } set test_name "setting breakpoint at $function" send_gdb "$break_command $function\n" # The first two regexps are what we get with -g, the third is without -g. gdb_expect 30 { -re "$break_message \[0-9\]* at .*: file .*, line $decimal.\r\n$gdb_prompt $" {} -re "$break_message \[0-9\]*: file .*, line $decimal.\r\n$gdb_prompt $" {} -re "$break_message \[0-9\]* at .*$gdb_prompt $" {} -re "$break_message \[0-9\]* \\(.*\\) pending.*$gdb_prompt $" { if {$pending_response == "n"} { if { $print_fail } { fail $test_name } return 0 } } -re "Make breakpoint pending.*y or \\\[n\\\]. $" { send_gdb "$pending_response\n" exp_continue } -re "A problem internal to GDB has been detected" { if { $print_fail } { fail "$test_name (GDB internal error)" } gdb_internal_error_resync return 0 } -re "$gdb_prompt $" { if { $print_fail } { fail $test_name } return 0 } eof { if { $print_fail } { fail "$test_name (eof)" } return 0 } timeout { if { $print_fail } { fail "$test_name (timeout)" } return 0 } } if { $print_pass } { pass $test_name } return 1 } # Set breakpoint at function and run gdb until it breaks there. # Since this is the only breakpoint that will be set, if it stops # at a breakpoint, we will assume it is the one we want. We can't # just compare to "function" because it might be a fully qualified, # single quoted C++ function specifier. # # If there are additional arguments, pass them to gdb_breakpoint. # We recognize no-message/message ourselves. # The default is no-message. # no-message is messed up here, like gdb_breakpoint: to preserve # historical usage fails are always printed by default. # no-message: turns off printing of fails (and passes, but they're already off) # message: turns on printing of passes (and fails, but they're already on) proc runto { function args } { global gdb_prompt global decimal delete_breakpoints # Default to "no-message". set args "no-message $args" set print_pass 0 set print_fail 1 set no_message_loc [lsearch -exact $args no-message] set message_loc [lsearch -exact $args message] # The last one to appear in args wins. if { $no_message_loc > $message_loc } { set print_fail 0 } elseif { $message_loc > $no_message_loc } { set print_pass 1 } set test_name "running to $function in runto" # We need to use eval here to pass our varargs args to gdb_breakpoint # which is also a varargs function. # But we also have to be careful because $function may have multiple # elements, and we don't want Tcl to move the remaining elements after # the first to $args. That is why $function is wrapped in {}. if ![eval gdb_breakpoint {$function} $args] { return 0 } gdb_run_cmd # the "at foo.c:36" output we get with -g. # the "in func" output we get without -g. gdb_expect 30 { -re "Break.* at .*:$decimal.*$gdb_prompt $" { if { $print_pass } { pass $test_name } return 1 } -re "Breakpoint \[0-9\]*, \[0-9xa-f\]* in .*$gdb_prompt $" { if { $print_pass } { pass $test_name } return 1 } -re "The target does not support running in non-stop mode.\r\n$gdb_prompt $" { if { $print_fail } { unsupported "Non-stop mode not supported" } return 0 } -re ".*A problem internal to GDB has been detected" { if { $print_fail } { fail "$test_name (GDB internal error)" } gdb_internal_error_resync return 0 } -re "$gdb_prompt $" { if { $print_fail } { fail $test_name } return 0 } eof { if { $print_fail } { fail "$test_name (eof)" } return 0 } timeout { if { $print_fail } { fail "$test_name (timeout)" } return 0 } } if { $print_pass } { pass $test_name } return 1 } # Ask gdb to run until we hit a breakpoint at main. # # N.B. This function deletes all existing breakpoints. # If you don't want that, use gdb_start_cmd. proc runto_main { } { return [runto main no-message] } ### Continue, and expect to hit a breakpoint. ### Report a pass or fail, depending on whether it seems to have ### worked. Use NAME as part of the test name; each call to ### continue_to_breakpoint should use a NAME which is unique within ### that test file. proc gdb_continue_to_breakpoint {name {location_pattern .*}} { global gdb_prompt set full_name "continue to breakpoint: $name" send_gdb "continue\n" gdb_expect { -re "(?:Breakpoint|Temporary breakpoint) .* (at|in) $location_pattern\r\n$gdb_prompt $" { pass $full_name } -re ".*$gdb_prompt $" { fail $full_name } timeout { fail "$full_name (timeout)" } } } # gdb_internal_error_resync: # # Answer the questions GDB asks after it reports an internal error # until we get back to a GDB prompt. Decline to quit the debugging # session, and decline to create a core file. Return non-zero if the # resync succeeds. # # This procedure just answers whatever questions come up until it sees # a GDB prompt; it doesn't require you to have matched the input up to # any specific point. However, it only answers questions it sees in # the output itself, so if you've matched a question, you had better # answer it yourself before calling this. # # You can use this function thus: # # gdb_expect { # ... # -re ".*A problem internal to GDB has been detected" { # gdb_internal_error_resync # } # ... # } # proc gdb_internal_error_resync {} { global gdb_prompt verbose -log "Resyncing due to internal error." set count 0 while {$count < 10} { gdb_expect { -re "Quit this debugging session\\? \\(y or n\\) $" { send_gdb "n\n" incr count } -re "Create a core file of GDB\\? \\(y or n\\) $" { send_gdb "n\n" incr count } -re "$gdb_prompt $" { # We're resynchronized. return 1 } timeout { perror "Could not resync from internal error (timeout)" return 0 } } } perror "Could not resync from internal error (resync count exceeded)" return 0 } # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS # Send a command to gdb; test the result. # # COMMAND is the command to execute, send to GDB with send_gdb. If # this is the null string no command is sent. # MESSAGE is a message to be printed with the built-in failure patterns # if one of them matches. If MESSAGE is empty COMMAND will be used. # EXPECT_ARGUMENTS will be fed to expect in addition to the standard # patterns. Pattern elements will be evaluated in the caller's # context; action elements will be executed in the caller's context. # Unlike patterns for gdb_test, these patterns should generally include # the final newline and prompt. # # Returns: # 1 if the test failed, according to a built-in failure pattern # 0 if only user-supplied patterns matched # -1 if there was an internal error. # # You can use this function thus: # # gdb_test_multiple "print foo" "test foo" { # -re "expected output 1" { # pass "print foo" # } # -re "expected output 2" { # fail "print foo" # } # } # # The standard patterns, such as "Inferior exited..." and "A problem # ...", all being implicitly appended to that list. # proc gdb_test_multiple { command message user_code } { global verbose use_gdb_stub global gdb_prompt global GDB global inferior_exited_re upvar timeout timeout upvar expect_out expect_out if { $message == "" } { set message $command } if [string match "*\[\r\n\]" $command] { error "Invalid trailing newline in \"$message\" test" } if [string match "*\[\r\n\]*" $message] { error "Invalid newline in \"$message\" test" } if {$use_gdb_stub && [regexp -nocase {^\s*(r|run|star|start|at|att|atta|attac|attach)\M} \ $command]} { error "gdbserver does not support $command without extended-remote" } # TCL/EXPECT WART ALERT # Expect does something very strange when it receives a single braced # argument. It splits it along word separators and performs substitutions. # This means that { "[ab]" } is evaluated as "[ab]", but { "\[ab\]" } is # evaluated as "\[ab\]". But that's not how TCL normally works; inside a # double-quoted list item, "\[ab\]" is just a long way of representing # "[ab]", because the backslashes will be removed by lindex. # Unfortunately, there appears to be no easy way to duplicate the splitting # that expect will do from within TCL. And many places make use of the # "\[0-9\]" construct, so we need to support that; and some places make use # of the "[func]" construct, so we need to support that too. In order to # get this right we have to substitute quoted list elements differently # from braced list elements. # We do this roughly the same way that Expect does it. We have to use two # lists, because if we leave unquoted newlines in the argument to uplevel # they'll be treated as command separators, and if we escape newlines # we mangle newlines inside of command blocks. This assumes that the # input doesn't contain a pattern which contains actual embedded newlines # at this point! regsub -all {\n} ${user_code} { } subst_code set subst_code [uplevel list $subst_code] set processed_code "" set patterns "" set expecting_action 0 set expecting_arg 0 foreach item $user_code subst_item $subst_code { if { $item == "-n" || $item == "-notransfer" || $item == "-nocase" } { lappend processed_code $item continue } if { $item == "-indices" || $item == "-re" || $item == "-ex" } { lappend processed_code $item continue } if { $item == "-timeout" } { set expecting_arg 1 lappend processed_code $item continue } if { $expecting_arg } { set expecting_arg 0 lappend processed_code $item continue } if { $expecting_action } { lappend processed_code "uplevel [list $item]" set expecting_action 0 # Cosmetic, no effect on the list. append processed_code "\n" continue } set expecting_action 1 lappend processed_code $subst_item if {$patterns != ""} { append patterns "; " } append patterns "\"$subst_item\"" } # Also purely cosmetic. regsub -all {\r} $patterns {\\r} patterns regsub -all {\n} $patterns {\\n} patterns if $verbose>2 then { send_user "Sending \"$command\" to gdb\n" send_user "Looking to match \"$patterns\"\n" send_user "Message is \"$message\"\n" } set result -1 set string "${command}\n" if { $command != "" } { set multi_line_re "\[\r\n\] *>" while { "$string" != "" } { set foo [string first "\n" "$string"] set len [string length "$string"] if { $foo < [expr $len - 1] } { set str [string range "$string" 0 $foo] if { [send_gdb "$str"] != "" } { global suppress_flag if { ! $suppress_flag } { perror "Couldn't send $command to GDB." } fail "$message" return $result } # since we're checking if each line of the multi-line # command are 'accepted' by GDB here, # we need to set -notransfer expect option so that # command output is not lost for pattern matching # - guo gdb_expect 2 { -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 } timeout { verbose "partial: timeout" 3 } } set string [string range "$string" [expr $foo + 1] end] set multi_line_re "$multi_line_re.*\[\r\n\] *>" } else { break } } if { "$string" != "" } { if { [send_gdb "$string"] != "" } { global suppress_flag if { ! $suppress_flag } { perror "Couldn't send $command to GDB." } fail "$message" return $result } } } if [target_info exists gdb,timeout] { set tmt [target_info gdb,timeout] } else { if [info exists timeout] { set tmt $timeout } else { global timeout if [info exists timeout] { set tmt $timeout } else { set tmt 60 } } } set code { -re ".*A problem internal to GDB has been detected" { fail "$message (GDB internal error)" gdb_internal_error_resync } -re "\\*\\*\\* DOSEXIT code.*" { if { $message != "" } { fail "$message" } gdb_suppress_entire_file "GDB died" set result -1 } } append code $processed_code append code { -re "Ending remote debugging.*$gdb_prompt $" { if ![isnative] then { warning "Can`t communicate to remote target." } gdb_exit gdb_start set result -1 } -re "Undefined\[a-z\]* command:.*$gdb_prompt $" { perror "Undefined command \"$command\"." fail "$message" set result 1 } -re "Ambiguous command.*$gdb_prompt $" { perror "\"$command\" is not a unique command name." fail "$message" set result 1 } -re "$inferior_exited_re with code \[0-9\]+.*$gdb_prompt $" { if ![string match "" $message] then { set errmsg "$message (the program exited)" } else { set errmsg "$command (the program exited)" } fail "$errmsg" set result -1 } -re "$inferior_exited_re normally.*$gdb_prompt $" { if ![string match "" $message] then { set errmsg "$message (the program exited)" } else { set errmsg "$command (the program exited)" } fail "$errmsg" set result -1 } -re "The program is not being run.*$gdb_prompt $" { if ![string match "" $message] then { set errmsg "$message (the program is no longer running)" } else { set errmsg "$command (the program is no longer running)" } fail "$errmsg" set result -1 } -re "\r\n$gdb_prompt $" { if ![string match "" $message] then { fail "$message" } set result 1 } "" { send_gdb "\n" perror "Window too small." fail "$message" set result -1 } -re "\\((y or n|y or \\\[n\\\]|\\\[y\\\] or n)\\) " { send_gdb "n\n" gdb_expect -re "$gdb_prompt $" fail "$message (got interactive prompt)" set result -1 } -re "\\\[0\\\] cancel\r\n\\\[1\\\] all.*\r\n> $" { send_gdb "0\n" gdb_expect -re "$gdb_prompt $" fail "$message (got breakpoint menu)" set result -1 } eof { perror "Process no longer exists" if { $message != "" } { fail "$message" } return -1 } full_buffer { perror "internal buffer is full." fail "$message" set result -1 } timeout { if ![string match "" $message] then { fail "$message (timeout)" } set result 1 } } set result 0 set code [catch {gdb_expect $tmt $code} string] if {$code == 1} { global errorInfo errorCode return -code error -errorinfo $errorInfo -errorcode $errorCode $string } elseif {$code > 1} { return -code $code $string } return $result } # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE # Send a command to gdb; test the result. # # COMMAND is the command to execute, send to GDB with send_gdb. If # this is the null string no command is sent. # PATTERN is the pattern to match for a PASS, and must NOT include # the \r\n sequence immediately before the gdb prompt. # MESSAGE is an optional message to be printed. If this is # omitted, then the pass/fail messages use the command string as the # message. (If this is the empty string, then sometimes we don't # call pass or fail at all; I don't understand this at all.) # QUESTION is a question GDB may ask in response to COMMAND, like # "are you sure?" # RESPONSE is the response to send if QUESTION appears. # # Returns: # 1 if the test failed, # 0 if the test passes, # -1 if there was an internal error. # proc gdb_test { args } { global verbose global gdb_prompt global GDB upvar timeout timeout if [llength $args]>2 then { set message [lindex $args 2] } else { set message [lindex $args 0] } set command [lindex $args 0] set pattern [lindex $args 1] if [llength $args]==5 { set question_string [lindex $args 3] set response_string [lindex $args 4] } else { set question_string "^FOOBAR$" } return [gdb_test_multiple $command $message { -re "\[\r\n\]*($pattern)\[\r\n\]+$gdb_prompt $" { if ![string match "" $message] then { pass "$message" } } -re "(${question_string})$" { send_gdb "$response_string\n" exp_continue } }] } # gdb_test_no_output COMMAND MESSAGE # Send a command to GDB and verify that this command generated no output. # # See gdb_test_multiple for a description of the COMMAND and MESSAGE # parameters. If MESSAGE is ommitted, then COMMAND will be used as # the message. (If MESSAGE is the empty string, then sometimes we do not # call pass or fail at all; I don't understand this at all.) proc gdb_test_no_output { args } { global gdb_prompt set command [lindex $args 0] if [llength $args]>1 then { set message [lindex $args 1] } else { set message $command } set command_regex [string_to_regexp $command] gdb_test_multiple $command $message { -re "^$command_regex\r\n$gdb_prompt $" { if ![string match "" $message] then { pass "$message" } } } } # Send a command and then wait for a sequence of outputs. # This is useful when the sequence is long and contains ".*", a single # regexp to match the entire output can get a timeout much easier. # # COMMAND is the command to send. # TEST_NAME is passed to pass/fail. COMMAND is used if TEST_NAME is "". # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are # processed in order, and all must be present in the output. # # It is unnecessary to specify ".*" at the beginning or end of any regexp, # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST. # There is also an implicit ".*" between the last regexp and the gdb prompt. # # Like gdb_test and gdb_test_multiple, the output is expected to end with the # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST. # # Returns: # 1 if the test failed, # 0 if the test passes, # -1 if there was an internal error. proc gdb_test_sequence { command test_name expected_output_list } { global gdb_prompt if { $test_name == "" } { set test_name $command } lappend expected_output_list ""; # implicit ".*" before gdb prompt send_gdb "$command\n" return [gdb_expect_list $test_name "$gdb_prompt $" $expected_output_list] } # Test that a command gives an error. For pass or fail, return # a 1 to indicate that more tests can proceed. However a timeout # is a serious error, generates a special fail message, and causes # a 0 to be returned to indicate that more tests are likely to fail # as well. proc test_print_reject { args } { global gdb_prompt global verbose if [llength $args]==2 then { set expectthis [lindex $args 1] } else { set expectthis "should never match this bogus string" } set sendthis [lindex $args 0] if $verbose>2 then { send_user "Sending \"$sendthis\" to gdb\n" send_user "Looking to match \"$expectthis\"\n" } send_gdb "$sendthis\n" #FIXME: Should add timeout as parameter. gdb_expect { -re "A .* in expression.*\\.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "Invalid syntax in expression.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "Junk after end of expression.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "Invalid number.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "Invalid character constant.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "No symbol table is loaded.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "No symbol .* in current context.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "Unmatched single quote.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "A character constant must contain at least one character.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re "$expectthis.*$gdb_prompt $" { pass "reject $sendthis" return 1 } -re ".*$gdb_prompt $" { fail "reject $sendthis" return 1 } default { fail "reject $sendthis (eof or timeout)" return 0 } } } # Given an input string, adds backslashes as needed to create a # regexp that will match the string. proc string_to_regexp {str} { set result $str regsub -all {[]*+.|()^$\[\\]} $str {\\&} result return $result } # Same as gdb_test, but the second parameter is not a regexp, # but a string that must match exactly. proc gdb_test_exact { args } { upvar timeout timeout set command [lindex $args 0] # This applies a special meaning to a null string pattern. Without # this, "$pattern\r\n$gdb_prompt $" will match anything, including error # messages from commands that should have no output except a new # prompt. With this, only results of a null string will match a null # string pattern. set pattern [lindex $args 1] if [string match $pattern ""] { set pattern [string_to_regexp [lindex $args 0]] } else { set pattern [string_to_regexp [lindex $args 1]] } # It is most natural to write the pattern argument with only # embedded \n's, especially if you are trying to avoid Tcl quoting # problems. But gdb_expect really wants to see \r\n in patterns. So # transform the pattern here. First transform \r\n back to \n, in # case some users of gdb_test_exact already do the right thing. regsub -all "\r\n" $pattern "\n" pattern regsub -all "\n" $pattern "\r\n" pattern if [llength $args]==3 then { set message [lindex $args 2] } else { set message $command } return [gdb_test $command $pattern $message] } # Wrapper around gdb_test_multiple that looks for a list of expected # output elements, but which can appear in any order. # CMD is the gdb command. # NAME is the name of the test. # ELM_FIND_REGEXP specifies how to partition the output into elements to # compare. # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare. # RESULT_MATCH_LIST is a list of exact matches for each expected element. # All elements of RESULT_MATCH_LIST must appear for the test to pass. # # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line # of text per element and then strip trailing \r\n's. # Example: # gdb_test_list_exact "foo" "bar" \ # "\[^\r\n\]+\[\r\n\]+" \ # "\[^\r\n\]+" \ # { \ # {expected result 1} \ # {expected result 2} \ # } proc gdb_test_list_exact { cmd name elm_find_regexp elm_extract_regexp result_match_list } { global gdb_prompt set matches [lsort $result_match_list] set seen {} gdb_test_multiple $cmd $name { "$cmd\[\r\n\]" { exp_continue } -re $elm_find_regexp { set str $expect_out(0,string) verbose -log "seen: $str" 3 regexp -- $elm_extract_regexp $str elm_seen verbose -log "extracted: $elm_seen" 3 lappend seen $elm_seen exp_continue } -re "$gdb_prompt $" { set failed "" foreach got [lsort $seen] have $matches { if {![string equal $got $have]} { set failed $have break } } if {[string length $failed] != 0} { fail "$name ($failed not found)" } else { pass $name } } } } proc gdb_reinitialize_dir { subdir } { global gdb_prompt if [is_remote host] { return "" } send_gdb "dir\n" gdb_expect 60 { -re "Reinitialize source path to empty.*y or n. " { send_gdb "y\n" gdb_expect 60 { -re "Source directories searched.*$gdb_prompt $" { send_gdb "dir $subdir\n" gdb_expect 60 { -re "Source directories searched.*$gdb_prompt $" { verbose "Dir set to $subdir" } -re "$gdb_prompt $" { perror "Dir \"$subdir\" failed." } } } -re "$gdb_prompt $" { perror "Dir \"$subdir\" failed." } } } -re "$gdb_prompt $" { perror "Dir \"$subdir\" failed." } } } # # gdb_exit -- exit the GDB, killing the target program if necessary # proc default_gdb_exit {} { global GDB global INTERNAL_GDBFLAGS GDBFLAGS global verbose global gdb_spawn_id global inotify_log_file gdb_stop_suppressing_tests if ![info exists gdb_spawn_id] { return } verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS" if {[info exists inotify_log_file] && [file exists $inotify_log_file]} { set fd [open $inotify_log_file] set data [read -nonewline $fd] close $fd if {[string compare $data ""] != 0} { warning "parallel-unsafe file creations noticed" # Clear the log. set fd [open $inotify_log_file w] close $fd } } if { [is_remote host] && [board_info host exists fileid] } { send_gdb "quit\n" gdb_expect 10 { -re "y or n" { send_gdb "y\n" exp_continue } -re "DOSEXIT code" { } default { } } } if ![is_remote host] { remote_close host } unset gdb_spawn_id } # Load a file into the debugger. # The return value is 0 for success, -1 for failure. # # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO # to one of these values: # # debug file was loaded successfully and has debug information # nodebug file was loaded successfully and has no debug information # lzma file was loaded, .gnu_debugdata found, but no LZMA support # compiled in # fail file was not loaded # # I tried returning this information as part of the return value, # but ran into a mess because of the many re-implementations of # gdb_load in config/*.exp. # # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use # this if they can get more information set. proc gdb_file_cmd { arg } { global gdb_prompt global verbose global GDB global last_loaded_file # Save this for the benefit of gdbserver-support.exp. set last_loaded_file $arg # Set whether debug info was found. # Default to "fail". global gdb_file_cmd_debug_info set gdb_file_cmd_debug_info "fail" if [is_remote host] { set arg [remote_download host $arg] if { $arg == "" } { perror "download failed" return -1 } } # The file command used to kill the remote target. For the benefit # of the testsuite, preserve this behavior. send_gdb "kill\n" gdb_expect 120 { -re "Kill the program being debugged. .y or n. $" { send_gdb "y\n" verbose "\t\tKilling previous program being debugged" exp_continue } -re "$gdb_prompt $" { # OK. } } send_gdb "file $arg\n" gdb_expect 120 { -re "Reading symbols from.*LZMA support was disabled.*done.*$gdb_prompt $" { verbose "\t\tLoaded $arg into $GDB; .gnu_debugdata found but no LZMA available" set gdb_file_cmd_debug_info "lzma" return 0 } -re "Reading symbols from.*no debugging symbols found.*done.*$gdb_prompt $" { verbose "\t\tLoaded $arg into $GDB with no debugging symbols" set gdb_file_cmd_debug_info "nodebug" return 0 } -re "Reading symbols from.*done.*$gdb_prompt $" { verbose "\t\tLoaded $arg into $GDB" set gdb_file_cmd_debug_info "debug" return 0 } -re "Load new symbol table from \".*\".*y or n. $" { send_gdb "y\n" gdb_expect 120 { -re "Reading symbols from.*done.*$gdb_prompt $" { verbose "\t\tLoaded $arg with new symbol table into $GDB" set gdb_file_cmd_debug_info "debug" return 0 } timeout { perror "Couldn't load $arg, other program already loaded (timeout)." return -1 } eof { perror "Couldn't load $arg, other program already loaded (eof)." return -1 } } } -re "No such file or directory.*$gdb_prompt $" { perror "($arg) No such file or directory" return -1 } -re "A problem internal to GDB has been detected" { fail "($arg) (GDB internal error)" gdb_internal_error_resync return -1 } -re "$gdb_prompt $" { perror "Couldn't load $arg into $GDB." return -1 } timeout { perror "Couldn't load $arg into $GDB (timeout)." return -1 } eof { # This is an attempt to detect a core dump, but seems not to # work. Perhaps we need to match .* followed by eof, in which # gdb_expect does not seem to have a way to do that. perror "Couldn't load $arg into $GDB (eof)." return -1 } } } # # start gdb -- start gdb running, default procedure # # When running over NFS, particularly if running many simultaneous # tests on different hosts all using the same server, things can # get really slow. Give gdb at least 3 minutes to start up. # proc default_gdb_start { } { global verbose use_gdb_stub global GDB global INTERNAL_GDBFLAGS GDBFLAGS global gdb_prompt global timeout global gdb_spawn_id gdb_stop_suppressing_tests # Set the default value, it may be overriden later by specific testfile. # # Use `set_board_info use_gdb_stub' for the board file to flag the inferior # is already started after connecting and run/attach are not supported. # This is used for the "remote" protocol. After GDB starts you should # check global $use_gdb_stub instead of the board as the testfile may force # a specific different target protocol itself. set use_gdb_stub [target_info exists use_gdb_stub] verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS" if [info exists gdb_spawn_id] { return 0 } if ![is_remote host] { if { [which $GDB] == 0 } then { perror "$GDB does not exist." exit 1 } } set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"] if { $res < 0 || $res == "" } { perror "Spawning $GDB failed." return 1 } gdb_expect 360 { -re "\[\r\n\]$gdb_prompt $" { verbose "GDB initialized." } -re "$gdb_prompt $" { perror "GDB never initialized." return -1 } timeout { perror "(timeout) GDB never initialized after 10 seconds." remote_close host return -1 } } set gdb_spawn_id -1 # force the height to "unlimited", so no pagers get used send_gdb "set height 0\n" gdb_expect 10 { -re "$gdb_prompt $" { verbose "Setting height to 0." 2 } timeout { warning "Couldn't set the height to 0" } } # force the width to "unlimited", so no wraparound occurs send_gdb "set width 0\n" gdb_expect 10 { -re "$gdb_prompt $" { verbose "Setting width to 0." 2 } timeout { warning "Couldn't set the width to 0." } } return 0 } # Examine the output of compilation to determine whether compilation # failed or not. If it failed determine whether it is due to missing # compiler or due to compiler error. Report pass, fail or unsupported # as appropriate proc gdb_compile_test {src output} { if { $output == "" } { pass "compilation [file tail $src]" } elseif { [regexp {^[a-zA-Z_0-9]+: Can't find [^ ]+\.$} $output] } { unsupported "compilation [file tail $src]" } elseif { [regexp {.*: command not found[\r|\n]*$} $output] } { unsupported "compilation [file tail $src]" } elseif { [regexp {.*: [^\r\n]*compiler not installed[^\r\n]*[\r|\n]*$} $output] } { unsupported "compilation [file tail $src]" } else { verbose -log "compilation failed: $output" 2 fail "compilation [file tail $src]" } } # Return a 1 for configurations for which we don't even want to try to # test C++. proc skip_cplus_tests {} { if { [istarget "h8300-*-*"] } { return 1 } # The C++ IO streams are too large for HC11/HC12 and are thus not # available. The gdb C++ tests use them and don't compile. if { [istarget "m6811-*-*"] } { return 1 } if { [istarget "m6812-*-*"] } { return 1 } return 0 } # Return a 1 for configurations for which don't have both C++ and the STL. proc skip_stl_tests {} { # Symbian supports the C++ language, but the STL is missing # (both headers and libraries). if { [istarget "arm*-*-symbianelf*"] } { return 1 } return [skip_cplus_tests] } # Return a 1 if I don't even want to try to test FORTRAN. proc skip_fortran_tests {} { return 0 } # Return a 1 if I don't even want to try to test ada. proc skip_ada_tests {} { return 0 } # Return a 1 if I don't even want to try to test GO. proc skip_go_tests {} { return 0 } # Return a 1 if I don't even want to try to test java. proc skip_java_tests {} { return 0 } # Return a 1 if I don't even want to try to test D. proc skip_d_tests {} { return 0 } # Return a 1 for configurations that do not support Python scripting. proc skip_python_tests {} { global gdb_prompt global gdb_py_is_py3k global gdb_py_is_py24 gdb_test_multiple "python print ('test')" "verify python support" { -re "not supported.*$gdb_prompt $" { unsupported "Python support is disabled." return 1 } -re "$gdb_prompt $" {} } set gdb_py_is_py24 0 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" { -re "3.*$gdb_prompt $" { set gdb_py_is_py3k 1 } -re ".*$gdb_prompt $" { set gdb_py_is_py3k 0 } } if { $gdb_py_is_py3k == 0 } { gdb_test_multiple "python print (sys.version_info\[1\])" "check if python 2.4" { -re "\[45\].*$gdb_prompt $" { set gdb_py_is_py24 1 } -re ".*$gdb_prompt $" { set gdb_py_is_py24 0 } } } return 0 } # Return a 1 if we should skip shared library tests. proc skip_shlib_tests {} { # Run the shared library tests on native systems. if {[isnative]} { return 0 } # An abbreviated list of remote targets where we should be able to # run shared library tests. if {([istarget *-*-linux*] || [istarget *-*-*bsd*] || [istarget *-*-solaris2*] || [istarget arm*-*-symbianelf*] || [istarget *-*-mingw*] || [istarget *-*-cygwin*] || [istarget *-*-pe*])} { return 0 } return 1 } # Test files shall make sure all the test result lines in gdb.sum are # unique in a test run, so that comparing the gdb.sum files of two # test runs gives correct results. Test files that exercise # variations of the same tests more than once, shall prefix the # different test invocations with different identifying strings in # order to make them unique. # # About test prefixes: # # $pf_prefix is the string that dejagnu prints after the result (FAIL, # PASS, etc.), and before the test message/name in gdb.sum. E.g., the # underlined substring in # # PASS: gdb.base/mytest.exp: some test # ^^^^^^^^^^^^^^^^^^^^ # # is $pf_prefix. # # The easiest way to adjust the test prefix is to append a test # variation prefix to the $pf_prefix, using the with_test_prefix # procedure. E.g., # # proc do_tests {} { # gdb_test ... ... "test foo" # gdb_test ... ... "test bar" # # with_test_prefix "subvariation a" { # gdb_test ... ... "test x" # } # # with_test_prefix "subvariation b" { # gdb_test ... ... "test x" # } # } # # with_test_prefix "variation1" { # ...do setup for variation 1... # do_tests # } # # with_test_prefix "variation2" { # ...do setup for variation 2... # do_tests # } # # Results in: # # PASS: gdb.base/mytest.exp: variation1: test foo # PASS: gdb.base/mytest.exp: variation1: test bar # PASS: gdb.base/mytest.exp: variation1: subvariation a: test x # PASS: gdb.base/mytest.exp: variation1: subvariation b: test x # PASS: gdb.base/mytest.exp: variation2: test foo # PASS: gdb.base/mytest.exp: variation2: test bar # PASS: gdb.base/mytest.exp: variation2: subvariation a: test x # PASS: gdb.base/mytest.exp: variation2: subvariation b: test x # # If for some reason more flexibility is necessary, one can also # manipulate the pf_prefix global directly, treating it as a string. # E.g., # # global pf_prefix # set saved_pf_prefix # append pf_prefix "${foo}: bar" # ... actual tests ... # set pf_prefix $saved_pf_prefix # # Run BODY in the context of the caller, with the current test prefix # (pf_prefix) appended with one space, then PREFIX, and then a colon. # Returns the result of BODY. # proc with_test_prefix { prefix body } { global pf_prefix set saved $pf_prefix append pf_prefix " " $prefix ":" set code [catch {uplevel 1 $body} result] set pf_prefix $saved if {$code == 1} { global errorInfo errorCode return -code $code -errorinfo $errorInfo -errorcode $errorCode $result } else { return -code $code $result } } # Run tests in BODY with GDB prompt and variable $gdb_prompt set to # PROMPT. When BODY is finished, restore GDB prompt and variable # $gdb_prompt. # Returns the result of BODY. proc with_gdb_prompt { prompt body } { global gdb_prompt set saved $gdb_prompt set gdb_prompt $prompt gdb_test_no_output "set prompt $prompt " "" set code [catch {uplevel 1 $body} result] set gdb_prompt $saved gdb_test_no_output "set prompt $saved " "" if {$code == 1} { global errorInfo errorCode return -code $code -errorinfo $errorInfo -errorcode $errorCode $result } else { return -code $code $result } } # Return 1 if _Complex types are supported, otherwise, return 0. gdb_caching_proc support_complex_tests { # Set up, compile, and execute a test program containing _Complex types. # Include the current process ID in the file names to prevent conflicts # with invocations for multiple testsuites. set src [standard_temp_file complex[pid].c] set exe [standard_temp_file complex[pid].x] gdb_produce_source $src { int main() { _Complex float cf; _Complex double cd; _Complex long double cld; return 0; } } verbose "compiling testfile $src" 2 set compile_flags {debug nowarnings quiet} set lines [gdb_compile $src $exe executable $compile_flags] file delete $src file delete $exe if ![string match "" $lines] then { verbose "testfile compilation failed, returning 0" 2 set result 0 } else { set result 1 } return $result } # Return 1 if target hardware or OS supports single stepping to signal # handler, otherwise, return 0. proc can_single_step_to_signal_handler {} { # Targets don't have hardware single step. On these targets, when # a signal is delivered during software single step, gdb is unable # to determine the next instruction addresses, because start of signal # handler is one of them. if { [istarget "arm*-*-*"] || [istarget "mips*-*-*"] || [istarget "tic6x-*-*"] || [istarget "sparc*-*-linux*"] } { return 0 } return 1 } # Return 1 if target supports process record, otherwise return 0. proc supports_process_record {} { if [target_info exists gdb,use_precord] { return [target_info gdb,use_precord] } if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"] } { return 1 } return 0 } # Return 1 if target supports reverse debugging, otherwise return 0. proc supports_reverse {} { if [target_info exists gdb,can_reverse] { return [target_info gdb,can_reverse] } if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"] } { return 1 } return 0 } # Return 1 if target is ELF. gdb_caching_proc is_elf_target { set me "is_elf_target" set src [standard_temp_file is_elf_target[pid].c] set obj [standard_temp_file is_elf_target[pid].o] gdb_produce_source $src { int foo () {return 0;} } verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $obj object {quiet}] file delete $src if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 0" 2 return 0 } set fp_obj [open $obj "r"] fconfigure $fp_obj -translation binary set data [read $fp_obj] close $fp_obj file delete $obj set ELFMAG "\u007FELF" if {[string compare -length 4 $data $ELFMAG] != 0} { verbose "$me: returning 0" 2 return 0 } verbose "$me: returning 1" 2 return 1 } # Produce source file NAME and write SOURCES into it. proc gdb_produce_source { name sources } { set index 0 set f [open $name "w"] puts $f $sources close $f } # Return 1 if target is ILP32. # This cannot be decided simply from looking at the target string, # as it might depend on externally passed compiler options like -m64. gdb_caching_proc is_ilp32_target { set me "is_ilp32_target" set src [standard_temp_file ilp32[pid].c] set obj [standard_temp_file ilp32[pid].o] gdb_produce_source $src { int dummy[sizeof (int) == 4 && sizeof (void *) == 4 && sizeof (long) == 4 ? 1 : -1]; } verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $obj object {quiet}] file delete $src file delete $obj if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 0" 2 return 0 } verbose "$me: returning 1" 2 return 1 } # Return 1 if target is LP64. # This cannot be decided simply from looking at the target string, # as it might depend on externally passed compiler options like -m64. gdb_caching_proc is_lp64_target { set me "is_lp64_target" set src [standard_temp_file lp64[pid].c] set obj [standard_temp_file lp64[pid].o] gdb_produce_source $src { int dummy[sizeof (int) == 4 && sizeof (void *) == 8 && sizeof (long) == 8 ? 1 : -1]; } verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $obj object {quiet}] file delete $src file delete $obj if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 0" 2 return 0 } verbose "$me: returning 1" 2 return 1 } # Return 1 if target has 64 bit addresses. # This cannot be decided simply from looking at the target string, # as it might depend on externally passed compiler options like -m64. gdb_caching_proc is_64_target { set me "is_64_target" set src [standard_temp_file is64[pid].c] set obj [standard_temp_file is64[pid].o] gdb_produce_source $src { int function(void) { return 3; } int dummy[sizeof (&function) == 8 ? 1 : -1]; } verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $obj object {quiet}] file delete $src file delete $obj if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 0" 2 return 0 } verbose "$me: returning 1" 2 return 1 } # Return 1 if target has x86_64 registers - either amd64 or x32. # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined # just from the target string. gdb_caching_proc is_amd64_regs_target { if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} { return 0 } set me "is_amd64_regs_target" set src [standard_temp_file reg64[pid].s] set obj [standard_temp_file reg64[pid].o] set list {} foreach reg \ {rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15} { lappend list "\tincq %$reg" } gdb_produce_source $src [join $list \n] verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $obj object {quiet}] file delete $src file delete $obj if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 0" 2 return 0 } verbose "$me: returning 1" 2 return 1 } # Return 1 if this target is an x86 or x86-64 with -m32. proc is_x86_like_target {} { if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} { return 0 } return [expr [is_ilp32_target] && ![is_amd64_regs_target]] } # Return 1 if displaced stepping is supported on target, otherwise, return 0. proc support_displaced_stepping {} { if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"] || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"] || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"] } { return 1 } return 0 } # Run a test on the target to see if it supports vmx hardware. Return 0 if so, # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite. gdb_caching_proc skip_altivec_tests { global srcdir subdir gdb_prompt inferior_exited_re set me "skip_altivec_tests" # Some simulators are known to not support VMX instructions. if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } { verbose "$me: target known to not support VMX, returning 1" 2 return 1 } # Make sure we have a compiler that understands altivec. set compile_flags {debug nowarnings} if [get_compiler_info] { warning "Could not get compiler info" return 1 } if [test_compiler_info gcc*] { set compile_flags "$compile_flags additional_flags=-maltivec" } elseif [test_compiler_info xlc*] { set compile_flags "$compile_flags additional_flags=-qaltivec" } else { verbose "Could not compile with altivec support, returning 1" 2 return 1 } # Set up, compile, and execute a test program containing VMX instructions. # Include the current process ID in the file names to prevent conflicts # with invocations for multiple testsuites. set src [standard_temp_file vmx[pid].c] set exe [standard_temp_file vmx[pid].x] gdb_produce_source $src { int main() { #ifdef __MACH__ asm volatile ("vor v0,v0,v0"); #else asm volatile ("vor 0,0,0"); #endif return 0; } } verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $exe executable $compile_flags] file delete $src if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 1" 2 return 1 } # No error message, compilation succeeded so now run it via gdb. gdb_exit gdb_start gdb_reinitialize_dir $srcdir/$subdir gdb_load "$exe" gdb_run_cmd gdb_expect { -re ".*Illegal instruction.*${gdb_prompt} $" { verbose -log "\n$me altivec hardware not detected" set skip_vmx_tests 1 } -re ".*$inferior_exited_re normally.*${gdb_prompt} $" { verbose -log "\n$me: altivec hardware detected" set skip_vmx_tests 0 } default { warning "\n$me: default case taken" set skip_vmx_tests 1 } } gdb_exit remote_file build delete $exe verbose "$me: returning $skip_vmx_tests" 2 return $skip_vmx_tests } # Run a test on the target to see if it supports vmx hardware. Return 0 if so, # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite. gdb_caching_proc skip_vsx_tests { global srcdir subdir gdb_prompt inferior_exited_re set me "skip_vsx_tests" # Some simulators are known to not support Altivec instructions, so # they won't support VSX instructions as well. if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } { verbose "$me: target known to not support VSX, returning 1" 2 return 1 } # Make sure we have a compiler that understands altivec. set compile_flags {debug nowarnings quiet} if [get_compiler_info] { warning "Could not get compiler info" return 1 } if [test_compiler_info gcc*] { set compile_flags "$compile_flags additional_flags=-mvsx" } elseif [test_compiler_info xlc*] { set compile_flags "$compile_flags additional_flags=-qasm=gcc" } else { verbose "Could not compile with vsx support, returning 1" 2 return 1 } set src [standard_temp_file vsx[pid].c] set exe [standard_temp_file vsx[pid].x] gdb_produce_source $src { int main() { double a[2] = { 1.0, 2.0 }; #ifdef __MACH__ asm volatile ("lxvd2x v0,v0,%[addr]" : : [addr] "r" (a)); #else asm volatile ("lxvd2x 0,0,%[addr]" : : [addr] "r" (a)); #endif return 0; } } verbose "$me: compiling testfile $src" 2 set lines [gdb_compile $src $exe executable $compile_flags] file delete $src if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 1" 2 return 1 } # No error message, compilation succeeded so now run it via gdb. gdb_exit gdb_start gdb_reinitialize_dir $srcdir/$subdir gdb_load "$exe" gdb_run_cmd gdb_expect { -re ".*Illegal instruction.*${gdb_prompt} $" { verbose -log "\n$me VSX hardware not detected" set skip_vsx_tests 1 } -re ".*$inferior_exited_re normally.*${gdb_prompt} $" { verbose -log "\n$me: VSX hardware detected" set skip_vsx_tests 0 } default { warning "\n$me: default case taken" set skip_vsx_tests 1 } } gdb_exit remote_file build delete $exe verbose "$me: returning $skip_vsx_tests" 2 return $skip_vsx_tests } # Run a test on the target to see if it supports btrace hardware. Return 0 if so, # 1 if it does not. Based on 'check_vmx_hw_available' from the GCC testsuite. gdb_caching_proc skip_btrace_tests { global srcdir subdir gdb_prompt inferior_exited_re set me "skip_btrace_tests" if { ![istarget "i?86-*-*"] && ![istarget "x86_64-*-*"] } { verbose "$me: target does not support btrace, returning 1" 2 return 1 } # Set up, compile, and execute a test program. # Include the current process ID in the file names to prevent conflicts # with invocations for multiple testsuites. set src [standard_temp_file btrace[pid].c] set exe [standard_temp_file btrace[pid].x] gdb_produce_source $src { int main(void) { return 0; } } verbose "$me: compiling testfile $src" 2 set compile_flags {debug nowarnings quiet} set lines [gdb_compile $src $exe executable $compile_flags] if ![string match "" $lines] then { verbose "$me: testfile compilation failed, returning 1" 2 file delete $src return 1 } # No error message, compilation succeeded so now run it via gdb. gdb_exit gdb_start gdb_reinitialize_dir $srcdir/$subdir gdb_load $exe if ![runto_main] { file delete $src return 1 } file delete $src # In case of an unexpected output, we return 2 as a fail value. set skip_btrace_tests 2 gdb_test_multiple "record btrace" "check btrace support" { -re "You can't do that when your target is.*\r\n$gdb_prompt $" { set skip_btrace_tests 1 } -re "Target does not support branch tracing.*\r\n$gdb_prompt $" { set skip_btrace_tests 1 } -re "Could not enable branch tracing.*\r\n$gdb_prompt $" { set skip_btrace_tests 1 } -re "^record btrace\r\n$gdb_prompt $" { set skip_btrace_tests 0 } } gdb_exit remote_file build delete $exe verbose "$me: returning $skip_btrace_tests" 2 return $skip_btrace_tests } # Skip all the tests in the file if you are not on an hppa running # hpux target. proc skip_hp_tests {} { eval set skip_hp [ expr ![isnative] || ![istarget "hppa*-*-hpux*"] ] verbose "Skip hp tests is $skip_hp" return $skip_hp } # Return whether we should skip tests for showing inlined functions in # backtraces. Requires get_compiler_info and get_debug_format. proc skip_inline_frame_tests {} { # GDB only recognizes inlining information in DWARF 2 (DWARF 3). if { ! [test_debug_format "DWARF 2"] } { return 1 } # GCC before 4.1 does not emit DW_AT_call_file / DW_AT_call_line. if { ([test_compiler_info "gcc-2-*"] || [test_compiler_info "gcc-3-*"] || [test_compiler_info "gcc-4-0-*"]) } { return 1 } return 0 } # Return whether we should skip tests for showing variables from # inlined functions. Requires get_compiler_info and get_debug_format. proc skip_inline_var_tests {} { # GDB only recognizes inlining information in DWARF 2 (DWARF 3). if { ! [test_debug_format "DWARF 2"] } { return 1 } return 0 } # Return a 1 if we should skip tests that require hardware breakpoints proc skip_hw_breakpoint_tests {} { # Skip tests if requested by the board (note that no_hardware_watchpoints # disables both watchpoints and breakpoints) if { [target_info exists gdb,no_hardware_watchpoints]} { return 1 } # These targets support hardware breakpoints natively if { [istarget "i?86-*-*"] || [istarget "x86_64-*-*"] || [istarget "ia64-*-*"] || [istarget "arm*-*-*"]} { return 0 } return 1 } # Return a 1 if we should skip tests that require hardware watchpoints proc skip_hw_watchpoint_tests {} { # Skip tests if requested by the board if { [target_info exists gdb,no_hardware_watchpoints]} { return 1 } # These targets support hardware watchpoints natively if { [istarget "i?86-*-*"] || [istarget "x86_64-*-*"] || [istarget "ia64-*-*"] || [istarget "arm*-*-*"] || [istarget "powerpc*-*-linux*"] || [istarget "s390*-*-*"] } { return 0 } return 1 } # Return a 1 if we should skip tests that require *multiple* hardware # watchpoints to be active at the same time proc skip_hw_watchpoint_multi_tests {} { if { [skip_hw_watchpoint_tests] } { return 1 } # These targets support just a single hardware watchpoint if { [istarget "arm*-*-*"] || [istarget "powerpc*-*-linux*"] } { return 1 } return 0 } # Return a 1 if we should skip tests that require read/access watchpoints proc skip_hw_watchpoint_access_tests {} { if { [skip_hw_watchpoint_tests] } { return 1 } # These targets support just write watchpoints if { [istarget "s390*-*-*"] } { return 1 } return 0 } # Return 1 if we should skip tests that require the runtime unwinder # hook. This must be invoked while gdb is running, after shared # libraries have been loaded. This is needed because otherwise a # shared libgcc won't be visible. proc skip_unwinder_tests {} { global gdb_prompt set ok 0 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" { -re "= .*no debug info.*_Unwind_DebugHook.*\r\n$gdb_prompt $" { } -re "= .*_Unwind_DebugHook.*\r\n$gdb_prompt $" { set ok 1 } -re "No symbol .* in current context.\r\n$gdb_prompt $" { } } if {!$ok} { gdb_test_multiple "info probe" "check for stap probe in unwinder" { -re ".*libgcc.*unwind.*\r\n$gdb_prompt $" { set ok 1 } -re "\r\n$gdb_prompt $" { } } } return $ok } # Return 0 if we should skip tests that require the libstdc++ stap # probes. This must be invoked while gdb is running, after shared # libraries have been loaded. proc skip_libstdcxx_probe_tests {} { global gdb_prompt set ok 0 gdb_test_multiple "info probe" "check for stap probe in libstdc++" { -re ".*libstdcxx.*catch.*\r\n$gdb_prompt $" { set ok 1 } -re "\r\n$gdb_prompt $" { } } return $ok } set compiler_info "unknown" set gcc_compiled 0 set hp_cc_compiler 0 set hp_aCC_compiler 0 # Figure out what compiler I am using. # # ARG can be empty or "C++". If empty, "C" is assumed. # # There are several ways to do this, with various problems. # # [ gdb_compile -E $ifile -o $binfile.ci ] # source $binfile.ci # # Single Unix Spec v3 says that "-E -o ..." together are not # specified. And in fact, the native compiler on hp-ux 11 (among # others) does not work with "-E -o ...". Most targets used to do # this, and it mostly worked, because it works with gcc. # # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ] # source $binfile.ci # # This avoids the problem with -E and -o together. This almost works # if the build machine is the same as the host machine, which is # usually true of the targets which are not gcc. But this code does # not figure which compiler to call, and it always ends up using the C # compiler. Not good for setting hp_aCC_compiler. Targets # hppa*-*-hpux* and mips*-*-irix* used to do this. # # [ gdb_compile -E $ifile > $binfile.ci ] # source $binfile.ci # # dejagnu target_compile says that it supports output redirection, # but the code is completely different from the normal path and I # don't want to sweep the mines from that path. So I didn't even try # this. # # set cppout [ gdb_compile $ifile "" preprocess $args quiet ] # eval $cppout # # I actually do this for all targets now. gdb_compile runs the right # compiler, and TCL captures the output, and I eval the output. # # Unfortunately, expect logs the output of the command as it goes by, # and dejagnu helpfully prints a second copy of it right afterwards. # So I turn off expect logging for a moment. # # [ gdb_compile $ifile $ciexe_file executable $args ] # [ remote_exec $ciexe_file ] # [ source $ci_file.out ] # # I could give up on -E and just do this. # I didn't get desperate enough to try this. # # -- chastain 2004-01-06 proc get_compiler_info {{arg ""}} { # For compiler.c and compiler.cc global srcdir # I am going to play with the log to keep noise out. global outdir global tool # These come from compiler.c or compiler.cc global compiler_info # Legacy global data symbols. global gcc_compiled global hp_cc_compiler global hp_aCC_compiler # Choose which file to preprocess. set ifile "${srcdir}/lib/compiler.c" if { $arg == "c++" } { set ifile "${srcdir}/lib/compiler.cc" } # Run $ifile through the right preprocessor. # Toggle gdb.log to keep the compiler output out of the log. set saved_log [log_file -info] log_file if [is_remote host] { # We have to use -E and -o together, despite the comments # above, because of how DejaGnu handles remote host testing. set ppout "$outdir/compiler.i" gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet] set file [open $ppout r] set cppout [read $file] close $file } else { set cppout [ gdb_compile "${ifile}" "" preprocess [list "$arg" quiet] ] } eval log_file $saved_log # Eval the output. set unknown 0 foreach cppline [ split "$cppout" "\n" ] { if { [ regexp "^#" "$cppline" ] } { # line marker } elseif { [ regexp "^\[\n\r\t \]*$" "$cppline" ] } { # blank line } elseif { [ regexp "^\[\n\r\t \]*set\[\n\r\t \]" "$cppline" ] } { # eval this line verbose "get_compiler_info: $cppline" 2 eval "$cppline" } else { # unknown line verbose -log "get_compiler_info: $cppline" set unknown 1 } } # Reset to unknown compiler if any diagnostics happened. if { $unknown } { set compiler_info "unknown" } # Set the legacy symbols. set gcc_compiled 0 set hp_cc_compiler 0 set hp_aCC_compiler 0 if { [regexp "^gcc-1-" "$compiler_info" ] } { set gcc_compiled 1 } if { [regexp "^gcc-2-" "$compiler_info" ] } { set gcc_compiled 2 } if { [regexp "^gcc-3-" "$compiler_info" ] } { set gcc_compiled 3 } if { [regexp "^gcc-4-" "$compiler_info" ] } { set gcc_compiled 4 } if { [regexp "^gcc-5-" "$compiler_info" ] } { set gcc_compiled 5 } if { [regexp "^hpcc-" "$compiler_info" ] } { set hp_cc_compiler 1 } if { [regexp "^hpacc-" "$compiler_info" ] } { set hp_aCC_compiler 1 } # Log what happened. verbose -log "get_compiler_info: $compiler_info" # Most compilers will evaluate comparisons and other boolean # operations to 0 or 1. uplevel \#0 { set true 1 } uplevel \#0 { set false 0 } # Use of aCC results in boolean results being displayed as # "true" or "false" if { $hp_aCC_compiler } { uplevel \#0 { set true true } uplevel \#0 { set false false } } return 0 } proc test_compiler_info { {compiler ""} } { global compiler_info # if no arg, return the compiler_info string if [string match "" $compiler] { if [info exists compiler_info] { return $compiler_info } else { perror "No compiler info found." } } return [string match $compiler $compiler_info] } proc current_target_name { } { global target_info if [info exists target_info(target,name)] { set answer $target_info(target,name) } else { set answer "" } return $answer } set gdb_wrapper_initialized 0 set gdb_wrapper_target "" proc gdb_wrapper_init { args } { global gdb_wrapper_initialized global gdb_wrapper_file global gdb_wrapper_flags global gdb_wrapper_target if { $gdb_wrapper_initialized == 1 } { return; } if {[target_info exists needs_status_wrapper] && \ [target_info needs_status_wrapper] != "0"} { set result [build_wrapper "testglue.o"] if { $result != "" } { set gdb_wrapper_file [lindex $result 0] set gdb_wrapper_flags [lindex $result 1] } else { warning "Status wrapper failed to build." } } set gdb_wrapper_initialized 1 set gdb_wrapper_target [current_target_name] } # Some targets need to always link a special object in. Save its path here. global gdb_saved_set_unbuffered_mode_obj set gdb_saved_set_unbuffered_mode_obj "" proc gdb_compile {source dest type options} { global GDB_TESTCASE_OPTIONS global gdb_wrapper_file global gdb_wrapper_flags global gdb_wrapper_initialized global srcdir global objdir global gdb_saved_set_unbuffered_mode_obj set outdir [file dirname $dest] # Add platform-specific options if a shared library was specified using # "shlib=librarypath" in OPTIONS. set new_options "" set shlib_found 0 set shlib_load 0 foreach opt $options { if [regexp {^shlib=(.*)} $opt dummy_var shlib_name] { if [test_compiler_info "xlc-*"] { # IBM xlc compiler doesn't accept shared library named other # than .so: use "-Wl," to bypass this lappend source "-Wl,$shlib_name" } elseif { ([istarget "*-*-mingw*"] || [istarget *-*-cygwin*] || [istarget *-*-pe*])} { lappend source "${shlib_name}.a" } else { lappend source $shlib_name } if { $shlib_found == 0 } { set shlib_found 1 if { ([istarget "*-*-mingw*"] || [istarget *-*-cygwin*]) } { lappend new_options "additional_flags=-Wl,--enable-auto-import" } } } elseif { $opt == "shlib_load" } { set shlib_load 1 } else { lappend new_options $opt } } # We typically link to shared libraries using an absolute path, and # that's how they are found at runtime. If we are going to # dynamically load one by basename, we must specify rpath. If we # are using a remote host, DejaGNU will link to the shared library # using a relative path, so again we must specify an rpath. if { $shlib_load || ($shlib_found && [is_remote target]) } { if { ([istarget "*-*-mingw*"] || [istarget *-*-cygwin*] || [istarget *-*-pe*] || [istarget hppa*-*-hpux*])} { # Do not need anything. } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } { lappend new_options "ldflags=-Wl,-rpath,${outdir}" } elseif { [istarget arm*-*-symbianelf*] } { if { $shlib_load } { lappend new_options "libs=-ldl" } } else { if { $shlib_load } { lappend new_options "libs=-ldl" } lappend new_options "ldflags=-Wl,-rpath,\\\$ORIGIN" } } set options $new_options if [target_info exists is_vxworks] { set options2 { "additional_flags=-Dvxworks" } set options [concat $options2 $options] } if [info exists GDB_TESTCASE_OPTIONS] { lappend options "additional_flags=$GDB_TESTCASE_OPTIONS" } verbose "options are $options" verbose "source is $source $dest $type $options" if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init } if {[target_info exists needs_status_wrapper] && \ [target_info needs_status_wrapper] != "0" && \ [info exists gdb_wrapper_file]} { lappend options "libs=${gdb_wrapper_file}" lappend options "ldflags=${gdb_wrapper_flags}" } # Replace the "nowarnings" option with the appropriate additional_flags # to disable compiler warnings. set nowarnings [lsearch -exact $options nowarnings] if {$nowarnings != -1} { if [target_info exists gdb,nowarnings_flag] { set flag "additional_flags=[target_info gdb,nowarnings_flag]" } else { set flag "additional_flags=-w" } set options [lreplace $options $nowarnings $nowarnings $flag] } if { $type == "executable" } { if { ([istarget "*-*-mingw*"] || [istarget "*-*-*djgpp"] || [istarget "*-*-cygwin*"])} { # Force output to unbuffered mode, by linking in an object file # with a global contructor that calls setvbuf. # # Compile the special object seperatelly for two reasons: # 1) Insulate it from $options. # 2) Avoid compiling it for every gdb_compile invocation, # which is time consuming, especially if we're remote # host testing. # if { $gdb_saved_set_unbuffered_mode_obj == "" } { verbose "compiling gdb_saved_set_unbuffered_obj" set unbuf_src ${srcdir}/lib/set_unbuffered_mode.c set unbuf_obj ${objdir}/set_unbuffered_mode.o set result [gdb_compile "${unbuf_src}" "${unbuf_obj}" object {nowarnings}] if { $result != "" } { return $result } if {[is_remote host]} { set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o } else { set gdb_saved_set_unbuffered_mode_obj ${objdir}/set_unbuffered_mode_saved.o } # Link a copy of the output object, because the # original may be automatically deleted. remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj } else { verbose "gdb_saved_set_unbuffered_obj already compiled" } # Rely on the internal knowledge that the global ctors are ran in # reverse link order. In that case, we can use ldflags to # avoid copying the object file to the host multiple # times. # This object can only be added if standard libraries are # used. Thus, we need to disable it if -nostdlib option is used if {[lsearch -regexp $options "-nostdlib"] < 0 } { lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj" } } } set result [target_compile $source $dest $type $options] # Prune uninteresting compiler (and linker) output. regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result regsub "\[\r\n\]*$" "$result" "" result regsub "^\[\r\n\]*" "$result" "" result if {[lsearch $options quiet] < 0} { # We shall update this on a per language basis, to avoid # changing the entire testsuite in one go. if {[lsearch $options f77] >= 0} { gdb_compile_test $source $result } elseif { $result != "" } { clone_output "gdb compile failed, $result" } } return $result } # This is just like gdb_compile, above, except that it tries compiling # against several different thread libraries, to see which one this # system has. proc gdb_compile_pthreads {source dest type options} { set built_binfile 0 set why_msg "unrecognized error" foreach lib {-lpthreads -lpthread -lthread ""} { # This kind of wipes out whatever libs the caller may have # set. Or maybe theirs will override ours. How infelicitous. set options_with_lib [concat $options [list libs=$lib quiet]] set ccout [gdb_compile $source $dest $type $options_with_lib] switch -regexp -- $ccout { ".*no posix threads support.*" { set why_msg "missing threads include file" break } ".*cannot open -lpthread.*" { set why_msg "missing runtime threads library" } ".*Can't find library for -lpthread.*" { set why_msg "missing runtime threads library" } {^$} { pass "successfully compiled posix threads test case" set built_binfile 1 break } } } if {!$built_binfile} { unsupported "Couldn't compile $source: ${why_msg}" return -1 } } # Build a shared library from SOURCES. proc gdb_compile_shlib {sources dest options} { set obj_options $options set info_options "" if { [lsearch -exact $options "c++"] >= 0 } { set info_options "c++" } if [get_compiler_info ${info_options}] { return -1 } switch -glob [test_compiler_info] { "xlc-*" { lappend obj_options "additional_flags=-qpic" } "gcc-*" { if { !([istarget "powerpc*-*-aix*"] || [istarget "rs6000*-*-aix*"] || [istarget "*-*-cygwin*"] || [istarget "*-*-mingw*"] || [istarget "*-*-pe*"]) } { lappend obj_options "additional_flags=-fpic" } } default { switch -glob [istarget] { "hppa*-hp-hpux*" { lappend obj_options "additional_flags=+z" } "mips-sgi-irix*" { # Disable SGI compiler's implicit -Dsgi lappend obj_options "additional_flags=-Usgi" } default { # don't know what the compiler is... } } } } set outdir [file dirname $dest] set objects "" foreach source $sources { set sourcebase [file tail $source] if {[gdb_compile $source "${outdir}/${sourcebase}.o" object $obj_options] != ""} { return -1 } lappend objects ${outdir}/${sourcebase}.o } if [istarget "hppa*-*-hpux*"] { remote_exec build "ld -b ${objects} -o ${dest}" } else { set link_options $options if [test_compiler_info "xlc-*"] { lappend link_options "additional_flags=-qmkshrobj" } else { lappend link_options "additional_flags=-shared" if { ([istarget "*-*-mingw*"] || [istarget *-*-cygwin*] || [istarget *-*-pe*]) } { if { [is_remote host] } { set name [file tail ${dest}] } else { set name ${dest} } lappend link_options "additional_flags=-Wl,--out-implib,${name}.a" } elseif [is_remote target] { # By default, we do not set the soname. This causes the linker # on ELF systems to create a DT_NEEDED entry in the executable # refering to the full path name of the library. This is a # problem in remote testing if the library is in a different # directory there. To fix this, we set a soname of just the # base filename for the library, and add an appropriate -rpath # to the main executable (in gdb_compile). set destbase [file tail $dest] lappend link_options "additional_flags=-Wl,-soname,$destbase" } } if {[gdb_compile "${objects}" "${dest}" executable $link_options] != ""} { return -1 } if { [is_remote host] && ([istarget "*-*-mingw*"] || [istarget *-*-cygwin*] || [istarget *-*-pe*]) } { set dest_tail_name [file tail ${dest}] remote_upload host $dest_tail_name.a ${dest}.a remote_file host delete $dest_tail_name.a } } return "" } # This is just like gdb_compile_shlib, above, except that it tries compiling # against several different thread libraries, to see which one this # system has. proc gdb_compile_shlib_pthreads {sources dest options} { set built_binfile 0 set why_msg "unrecognized error" foreach lib {-lpthreads -lpthread -lthread ""} { # This kind of wipes out whatever libs the caller may have # set. Or maybe theirs will override ours. How infelicitous. set options_with_lib [concat $options [list libs=$lib quiet]] set ccout [gdb_compile_shlib $sources $dest $options_with_lib] switch -regexp -- $ccout { ".*no posix threads support.*" { set why_msg "missing threads include file" break } ".*cannot open -lpthread.*" { set why_msg "missing runtime threads library" } ".*Can't find library for -lpthread.*" { set why_msg "missing runtime threads library" } {^$} { pass "successfully compiled posix threads test case" set built_binfile 1 break } } } if {!$built_binfile} { unsupported "Couldn't compile $sources: ${why_msg}" return -1 } } # This is just like gdb_compile_pthreads, above, except that we always add the # objc library for compiling Objective-C programs proc gdb_compile_objc {source dest type options} { set built_binfile 0 set why_msg "unrecognized error" foreach lib {-lobjc -lpthreads -lpthread -lthread solaris} { # This kind of wipes out whatever libs the caller may have # set. Or maybe theirs will override ours. How infelicitous. if { $lib == "solaris" } { set lib "-lpthread -lposix4" } if { $lib != "-lobjc" } { set lib "-lobjc $lib" } set options_with_lib [concat $options [list libs=$lib quiet]] set ccout [gdb_compile $source $dest $type $options_with_lib] switch -regexp -- $ccout { ".*no posix threads support.*" { set why_msg "missing threads include file" break } ".*cannot open -lpthread.*" { set why_msg "missing runtime threads library" } ".*Can't find library for -lpthread.*" { set why_msg "missing runtime threads library" } {^$} { pass "successfully compiled objc with posix threads test case" set built_binfile 1 break } } } if {!$built_binfile} { unsupported "Couldn't compile $source: ${why_msg}" return -1 } } proc send_gdb { string } { global suppress_flag if { $suppress_flag } { return "suppressed" } return [remote_send host "$string"] } # # proc gdb_expect { args } { if { [llength $args] == 2 && [lindex $args 0] != "-re" } { set atimeout [lindex $args 0] set expcode [list [lindex $args 1]] } else { set expcode $args } upvar timeout timeout if [target_info exists gdb,timeout] { if [info exists timeout] { if { $timeout < [target_info gdb,timeout] } { set gtimeout [target_info gdb,timeout] } else { set gtimeout $timeout } } else { set gtimeout [target_info gdb,timeout] } } if ![info exists gtimeout] { global timeout if [info exists timeout] { set gtimeout $timeout } } if [info exists atimeout] { if { ![info exists gtimeout] || $gtimeout < $atimeout } { set gtimeout $atimeout } } else { if ![info exists gtimeout] { # Eeeeew. set gtimeout 60 } } global suppress_flag global remote_suppress_flag if [info exists remote_suppress_flag] { set old_val $remote_suppress_flag } if [info exists suppress_flag] { if { $suppress_flag } { set remote_suppress_flag 1 } } set code [catch \ {uplevel remote_expect host $gtimeout $expcode} string] if [info exists old_val] { set remote_suppress_flag $old_val } else { if [info exists remote_suppress_flag] { unset remote_suppress_flag } } if {$code == 1} { global errorInfo errorCode return -code error -errorinfo $errorInfo -errorcode $errorCode $string } else { return -code $code $string } } # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs # # Check for long sequence of output by parts. # TEST: is the test message to be printed with the test success/fail. # SENTINEL: Is the terminal pattern indicating that output has finished. # LIST: is the sequence of outputs to match. # If the sentinel is recognized early, it is considered an error. # # Returns: # 1 if the test failed, # 0 if the test passes, # -1 if there was an internal error. proc gdb_expect_list {test sentinel list} { global gdb_prompt global suppress_flag set index 0 set ok 1 if { $suppress_flag } { set ok 0 unresolved "${test}" } while { ${index} < [llength ${list}] } { set pattern [lindex ${list} ${index}] set index [expr ${index} + 1] verbose -log "gdb_expect_list pattern: /$pattern/" 2 if { ${index} == [llength ${list}] } { if { ${ok} } { gdb_expect { -re "${pattern}${sentinel}" { # pass "${test}, pattern ${index} + sentinel" } -re "${sentinel}" { fail "${test} (pattern ${index} + sentinel)" set ok 0 } -re ".*A problem internal to GDB has been detected" { fail "${test} (GDB internal error)" set ok 0 gdb_internal_error_resync } timeout { fail "${test} (pattern ${index} + sentinel) (timeout)" set ok 0 } } } else { # unresolved "${test}, pattern ${index} + sentinel" } } else { if { ${ok} } { gdb_expect { -re "${pattern}" { # pass "${test}, pattern ${index}" } -re "${sentinel}" { fail "${test} (pattern ${index})" set ok 0 } -re ".*A problem internal to GDB has been detected" { fail "${test} (GDB internal error)" set ok 0 gdb_internal_error_resync } timeout { fail "${test} (pattern ${index}) (timeout)" set ok 0 } } } else { # unresolved "${test}, pattern ${index}" } } } if { ${ok} } { pass "${test}" return 0 } else { return 1 } } # # proc gdb_suppress_entire_file { reason } { global suppress_flag warning "$reason\n" set suppress_flag -1 } # # Set suppress_flag, which will cause all subsequent calls to send_gdb and # gdb_expect to fail immediately (until the next call to # gdb_stop_suppressing_tests). # proc gdb_suppress_tests { args } { global suppress_flag return; # fnf - disable pending review of results where # testsuite ran better without this incr suppress_flag if { $suppress_flag == 1 } { if { [llength $args] > 0 } { warning "[lindex $args 0]\n" } else { warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n" } } } # # Clear suppress_flag. # proc gdb_stop_suppressing_tests { } { global suppress_flag if [info exists suppress_flag] { if { $suppress_flag > 0 } { set suppress_flag 0 clone_output "Tests restarted.\n" } } else { set suppress_flag 0 } } proc gdb_clear_suppressed { } { global suppress_flag set suppress_flag 0 } proc gdb_start { } { default_gdb_start } proc gdb_exit { } { catch default_gdb_exit } # # gdb_load_cmd -- load a file into the debugger. # ARGS - additional args to load command. # return a -1 if anything goes wrong. # proc gdb_load_cmd { args } { global gdb_prompt if [target_info exists gdb_load_timeout] { set loadtimeout [target_info gdb_load_timeout] } else { set loadtimeout 1600 } send_gdb "load $args\n" verbose "Timeout is now $loadtimeout seconds" 2 gdb_expect $loadtimeout { -re "Loading section\[^\r\]*\r\n" { exp_continue } -re "Start address\[\r\]*\r\n" { exp_continue } -re "Transfer rate\[\r\]*\r\n" { exp_continue } -re "Memory access error\[^\r\]*\r\n" { perror "Failed to load program" return -1 } -re "$gdb_prompt $" { return 0 } -re "(.*)\r\n$gdb_prompt " { perror "Unexpected reponse from 'load' -- $expect_out(1,string)" return -1 } timeout { perror "Timed out trying to load $args." return -1 } } return -1 } # Invoke "gcore". CORE is the name of the core file to write. TEST # is the name of the test case. This will return 1 if the core file # was created, 0 otherwise. If this fails to make a core file because # this configuration of gdb does not support making core files, it # will call "unsupported", not "fail". However, if this fails to make # a core file for some other reason, then it will call "fail". proc gdb_gcore_cmd {core test} { global gdb_prompt set result 0 gdb_test_multiple "gcore $core" $test { -re "Saved corefile .*\[\r\n\]+$gdb_prompt $" { pass $test set result 1 } -re "Undefined command.*$gdb_prompt $" { unsupported $test verbose -log "'gcore' command undefined in gdb_gcore_cmd" } -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" { unsupported $test } } return $result } # Load core file CORE. TEST is the name of the test case. # This will record a pass/fail for loading the core file. # Returns: # 1 - core file is successfully loaded # 0 - core file loaded but has a non fatal error # -1 - core file failed to load proc gdb_core_cmd { core test } { global gdb_prompt gdb_test_multiple "core $core" "$test" { -re "\\\[Thread debugging using \[^ \r\n\]* enabled\\\]\r\n" { exp_continue } -re " is not a core dump:.*\r\n$gdb_prompt $" { fail "$test (bad file format)" return -1 } -re ": No such file or directory.*\r\n$gdb_prompt $" { fail "$test (file not found)" return -1 } -re "Couldn't find .* registers in core file.*\r\n$gdb_prompt $" { fail "$test (incomplete note section)" return 0 } -re "Core was generated by .*\r\n$gdb_prompt $" { pass "$test" return 1 } -re ".*$gdb_prompt $" { fail "$test" return -1 } timeout { fail "$test (timeout)" return -1 } } fail "unsupported output from 'core' command" return -1 } # Return the filename to download to the target and load on the target # for this shared library. Normally just LIBNAME, unless shared libraries # for this target have separate link and load images. proc shlib_target_file { libname } { return $libname } # Return the filename GDB will load symbols from when debugging this # shared library. Normally just LIBNAME, unless shared libraries for # this target have separate link and load images. proc shlib_symbol_file { libname } { return $libname } # Return the filename to download to the target and load for this # executable. Normally just BINFILE unless it is renamed to something # else for this target. proc exec_target_file { binfile } { return $binfile } # Return the filename GDB will load symbols from when debugging this # executable. Normally just BINFILE unless executables for this target # have separate files for symbols. proc exec_symbol_file { binfile } { return $binfile } # Rename the executable file. Normally this is just BINFILE1 being renamed # to BINFILE2, but some targets require multiple binary files. proc gdb_rename_execfile { binfile1 binfile2 } { file rename -force [exec_target_file ${binfile1}] \ [exec_target_file ${binfile2}] if { [exec_target_file ${binfile1}] != [exec_symbol_file ${binfile1}] } { file rename -force [exec_symbol_file ${binfile1}] \ [exec_symbol_file ${binfile2}] } } # "Touch" the executable file to update the date. Normally this is just # BINFILE, but some targets require multiple files. proc gdb_touch_execfile { binfile } { set time [clock seconds] file mtime [exec_target_file ${binfile}] $time if { [exec_target_file ${binfile}] != [exec_symbol_file ${binfile}] } { file mtime [exec_symbol_file ${binfile}] $time } } # Like remote_download but provides a gdb-specific behavior. If DEST # is "host", and the host is not remote, and TOFILE is not specified, # then the [file tail] of FROMFILE is passed through # standard_output_file to compute the destination. proc gdb_remote_download {dest fromfile {tofile {}}} { if {$dest == "host" && ![is_remote host] && $tofile == ""} { set tofile [standard_output_file [file tail $fromfile]] } if { $tofile == "" } { return [remote_download $dest $fromfile] } else { return [remote_download $dest $fromfile $tofile] } } # gdb_download # # Copy a file to the remote target and return its target filename. # Schedule the file to be deleted at the end of this test. proc gdb_download { filename } { global cleanfiles set destname [remote_download target $filename] lappend cleanfiles $destname return $destname } # gdb_load_shlibs LIB... # # Copy the listed libraries to the target. proc gdb_load_shlibs { args } { if {![is_remote target]} { return } foreach file $args { gdb_download [shlib_target_file $file] } # Even if the target supplies full paths for shared libraries, # they may not be paths for this system. gdb_test "set solib-search-path [file dirname [lindex $args 0]]" "" "" } # # gdb_load -- load a file into the debugger. # Many files in config/*.exp override this procedure. # proc gdb_load { arg } { return [gdb_file_cmd $arg] } # gdb_reload -- load a file into the target. Called before "running", # either the first time or after already starting the program once, # for remote targets. Most files that override gdb_load should now # override this instead. proc gdb_reload { } { # For the benefit of existing configurations, default to gdb_load. # Specifying no file defaults to the executable currently being # debugged. return [gdb_load ""] } proc gdb_continue { function } { global decimal return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"] } proc default_gdb_init { args } { global gdb_wrapper_initialized global gdb_wrapper_target global gdb_test_file_name global cleanfiles set cleanfiles {} gdb_clear_suppressed set gdb_test_file_name [file rootname [file tail [lindex $args 0]]] # Make sure that the wrapper is rebuilt # with the appropriate multilib option. if { $gdb_wrapper_target != [current_target_name] } { set gdb_wrapper_initialized 0 } # Unlike most tests, we have a small number of tests that generate # a very large amount of output. We therefore increase the expect # buffer size to be able to contain the entire test output. match_max -d 30000 # Also set this value for the currently running GDB. match_max [match_max -d] # We want to add the name of the TCL testcase to the PASS/FAIL messages. if { [llength $args] > 0 } { global pf_prefix set file [lindex $args 0] set pf_prefix "[file tail [file dirname $file]]/[file tail $file]:" } global gdb_prompt if [target_info exists gdb_prompt] { set gdb_prompt [target_info gdb_prompt] } else { set gdb_prompt "\\(gdb\\)" } global use_gdb_stub if [info exists use_gdb_stub] { unset use_gdb_stub } } # Turn BASENAME into a full file name in the standard output # directory. It is ok if BASENAME is the empty string; in this case # the directory is returned. proc standard_output_file {basename} { global objdir subdir gdb_test_file_name GDB_PARALLEL if {[info exists GDB_PARALLEL]} { set dir [file join $objdir outputs $subdir $gdb_test_file_name] file mkdir $dir return [file join $dir $basename] } else { return [file join $objdir $subdir $basename] } } # Return the name of a file in our standard temporary directory. proc standard_temp_file {basename} { global objdir GDB_PARALLEL if {[info exists GDB_PARALLEL]} { return [file join $objdir temp $basename] } else { return $basename } } # Set 'testfile', 'srcfile', and 'binfile'. # # ARGS is a list of source file specifications. # Without any arguments, the .exp file's base name is used to # compute the source file name. The ".c" extension is added in this case. # If ARGS is not empty, each entry is a source file specification. # If the specification starts with a ".", it is treated as a suffix # to append to the .exp file's base name. # If the specification is the empty string, it is treated as if it # were ".c". # Otherwise it is a file name. # The first file in the list is used to set the 'srcfile' global. # Each subsequent name is used to set 'srcfile2', 'srcfile3', etc. # # Most tests should call this without arguments. # # If a completely different binary file name is needed, then it # should be handled in the .exp file with a suitable comment. proc standard_testfile {args} { global gdb_test_file_name global subdir global gdb_test_file_last_vars # Outputs. global testfile binfile set testfile $gdb_test_file_name set binfile [standard_output_file ${testfile}] if {[llength $args] == 0} { set args .c } # Unset our previous output variables. # This can help catch hidden bugs. if {[info exists gdb_test_file_last_vars]} { foreach varname $gdb_test_file_last_vars { global $varname catch {unset $varname} } } # 'executable' is often set by tests. set gdb_test_file_last_vars {executable} set suffix "" foreach arg $args { set varname srcfile$suffix global $varname # Handle an extension. if {$arg == ""} { set arg $testfile.c } elseif {[string range $arg 0 0] == "."} { set arg $testfile$arg } set $varname $arg lappend gdb_test_file_last_vars $varname if {$suffix == ""} { set suffix 2 } else { incr suffix } } } # The default timeout used when testing GDB commands. We want to use # the same timeout as the default dejagnu timeout, unless the user has # already provided a specific value (probably through a site.exp file). global gdb_test_timeout if ![info exists gdb_test_timeout] { set gdb_test_timeout $timeout } # A list of global variables that GDB testcases should not use. # We try to prevent their use by monitoring write accesses and raising # an error when that happens. set banned_variables { bug_id prms_id } # A list of procedures that GDB testcases should not use. # We try to prevent their use by monitoring invocations and raising # an error when that happens. set banned_procedures { strace } # gdb_init is called by runtest at start, but also by several # tests directly; gdb_finish is only called from within runtest after # each test source execution. # Placing several traces by repetitive calls to gdb_init leads # to problems, as only one trace is removed in gdb_finish. # To overcome this possible problem, we add a variable that records # if the banned variables and procedures are already traced. set banned_traced 0 proc gdb_init { args } { # Reset the timeout value to the default. This way, any testcase # that changes the timeout value without resetting it cannot affect # the timeout used in subsequent testcases. global gdb_test_timeout global timeout set timeout $gdb_test_timeout # If GDB_INOTIFY is given, check for writes to '.'. This is a # debugging tool to help confirm that the test suite is # parallel-safe. You need "inotifywait" from the # inotify-tools package to use this. global GDB_INOTIFY inotify_pid if {[info exists GDB_INOTIFY] && ![info exists inotify_pid]} { global outdir tool inotify_log_file set exclusions {outputs temp gdb[.](log|sum) cache} set exclusion_re ([join $exclusions |]) set inotify_log_file [standard_temp_file inotify.out] set inotify_pid [exec inotifywait -r -m -e move,create,delete . \ --exclude $exclusion_re \ |& tee -a $outdir/$tool.log $inotify_log_file &] # Wait for the watches; hopefully this is long enough. sleep 2 # Clear the log so that we don't emit a warning the first time # we check it. set fd [open $inotify_log_file w] close $fd } # Block writes to all banned variables, and invocation of all # banned procedures... global banned_variables global banned_procedures global banned_traced if (!$banned_traced) { foreach banned_var $banned_variables { global "$banned_var" trace add variable "$banned_var" write error } foreach banned_proc $banned_procedures { global "$banned_proc" trace add execution "$banned_proc" enter error } set banned_traced 1 } # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same # messages as expected. setenv LC_ALL C setenv LC_CTYPE C setenv LANG C # Don't let a .inputrc file or an existing setting of INPUTRC mess up # the test results. Even if /dev/null doesn't exist on the particular # platform, the readline library will use the default setting just by # failing to open the file. OTOH, opening /dev/null successfully will # also result in the default settings being used since nothing will be # read from this file. setenv INPUTRC "/dev/null" # The gdb.base/readline.exp arrow key test relies on the standard VT100 # bindings, so make sure that an appropriate terminal is selected. # The same bug doesn't show up if we use ^P / ^N instead. setenv TERM "vt100" # Some tests (for example gdb.base/maint.exp) shell out from gdb to use # grep. Clear GREP_OPTIONS to make the behavior predictable, # especially having color output turned on can cause tests to fail. setenv GREP_OPTIONS "" # Clear $gdbserver_reconnect_p. global gdbserver_reconnect_p set gdbserver_reconnect_p 1 unset gdbserver_reconnect_p return [eval default_gdb_init $args] } proc gdb_finish { } { global gdbserver_reconnect_p global gdb_prompt global cleanfiles # Give persistent gdbserver a chance to terminate before GDB is killed. if {[info exists gdbserver_reconnect_p] && $gdbserver_reconnect_p && [info exists gdb_spawn_id]} { send_gdb "kill\n"; gdb_expect 10 { -re "y or n" { send_gdb "y\n"; exp_continue; } -re "$gdb_prompt $" { } } } # Exit first, so that the files are no longer in use. gdb_exit if { [llength $cleanfiles] > 0 } { eval remote_file target delete $cleanfiles set cleanfiles {} } # Unblock write access to the banned variables. Dejagnu typically # resets some of them between testcases. global banned_variables global banned_procedures global banned_traced if ($banned_traced) { foreach banned_var $banned_variables { global "$banned_var" trace remove variable "$banned_var" write error } foreach banned_proc $banned_procedures { global "$banned_proc" trace remove execution "$banned_proc" enter error } set banned_traced 0 } } global debug_format set debug_format "unknown" # Run the gdb command "info source" and extract the debugging format # information from the output and save it in debug_format. proc get_debug_format { } { global gdb_prompt global verbose global expect_out global debug_format set debug_format "unknown" send_gdb "info source\n" gdb_expect 10 { -re "Compiled with (.*) debugging format.\r\n.*$gdb_prompt $" { set debug_format $expect_out(1,string) verbose "debug format is $debug_format" return 1 } -re "No current source file.\r\n$gdb_prompt $" { perror "get_debug_format used when no current source file" return 0 } -re "$gdb_prompt $" { warning "couldn't check debug format (no valid response)." return 1 } timeout { warning "couldn't check debug format (timeout)." return 1 } } } # Return true if FORMAT matches the debug format the current test was # compiled with. FORMAT is a shell-style globbing pattern; it can use # `*', `[...]', and so on. # # This function depends on variables set by `get_debug_format', above. proc test_debug_format {format} { global debug_format return [expr [string match $format $debug_format] != 0] } # Like setup_xfail, but takes the name of a debug format (DWARF 1, # COFF, stabs, etc). If that format matches the format that the # current test was compiled with, then the next test is expected to # fail for any target. Returns 1 if the next test or set of tests is # expected to fail, 0 otherwise (or if it is unknown). Must have # previously called get_debug_format. proc setup_xfail_format { format } { set ret [test_debug_format $format] if {$ret} then { setup_xfail "*-*-*" } return $ret } # gdb_get_line_number TEXT [FILE] # # Search the source file FILE, and return the line number of the # first line containing TEXT. If no match is found, an error is thrown. # # TEXT is a string literal, not a regular expression. # # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is # specified, and does not start with "/", then it is assumed to be in # "$srcdir/$subdir". This is awkward, and can be fixed in the future, # by changing the callers and the interface at the same time. # In particular: gdb.base/break.exp, gdb.base/condbreak.exp, # gdb.base/ena-dis-br.exp. # # Use this function to keep your test scripts independent of the # exact line numbering of the source file. Don't write: # # send_gdb "break 20" # # This means that if anyone ever edits your test's source file, # your test could break. Instead, put a comment like this on the # source file line you want to break at: # # /* breakpoint spot: frotz.exp: test name */ # # and then write, in your test script (which we assume is named # frotz.exp): # # send_gdb "break [gdb_get_line_number "frotz.exp: test name"]\n" # # (Yes, Tcl knows how to handle the nested quotes and brackets. # Try this: # $ tclsh # % puts "foo [lindex "bar baz" 1]" # foo baz # % # Tcl is quite clever, for a little stringy language.) # # === # # The previous implementation of this procedure used the gdb search command. # This version is different: # # . It works with MI, and it also works when gdb is not running. # # . It operates on the build machine, not the host machine. # # . For now, this implementation fakes a current directory of # $srcdir/$subdir to be compatible with the old implementation. # This will go away eventually and some callers will need to # be changed. # # . The TEXT argument is literal text and matches literally, # not a regular expression as it was before. # # . State changes in gdb, such as changing the current file # and setting $_, no longer happen. # # After a bit of time we can forget about the differences from the # old implementation. # # --chastain 2004-08-05 proc gdb_get_line_number { text { file "" } } { global srcdir global subdir global srcfile if { "$file" == "" } then { set file "$srcfile" } if { ! [regexp "^/" "$file"] } then { set file "$srcdir/$subdir/$file" } if { [ catch { set fd [open "$file"] } message ] } then { error "$message" } set found -1 for { set line 1 } { 1 } { incr line } { if { [ catch { set nchar [gets "$fd" body] } message ] } then { error "$message" } if { $nchar < 0 } then { break } if { [string first "$text" "$body"] >= 0 } then { set found $line break } } if { [ catch { close "$fd" } message ] } then { error "$message" } if {$found == -1} { error "undefined tag \"$text\"" } return $found } # Continue the program until it ends. # # MSSG is the error message that gets printed. If not given, a # default is used. # COMMAND is the command to invoke. If not given, "continue" is # used. # ALLOW_EXTRA is a flag indicating whether the test should expect # extra output between the "Continuing." line and the program # exiting. By default it is zero; if nonzero, any extra output # is accepted. proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} { global inferior_exited_re use_gdb_stub if {$mssg == ""} { set text "continue until exit" } else { set text "continue until exit at $mssg" } if {$allow_extra} { set extra ".*" } else { set extra "" } # By default, we don't rely on exit() behavior of remote stubs -- # it's common for exit() to be implemented as a simple infinite # loop, or a forced crash/reset. For native targets, by default, we # assume process exit is reported as such. If a non-reliable target # is used, we set a breakpoint at exit, and continue to that. if { [target_info exists exit_is_reliable] } { set exit_is_reliable [target_info exit_is_reliable] } else { set exit_is_reliable [expr ! $use_gdb_stub] } if { ! $exit_is_reliable } { if {![gdb_breakpoint "exit"]} { return 0 } gdb_test $command "Continuing..*Breakpoint .*exit.*" \ $text } else { # Continue until we exit. Should not stop again. # Don't bother to check the output of the program, that may be # extremely tough for some remote systems. gdb_test $command \ "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\ $text } } proc rerun_to_main {} { global gdb_prompt use_gdb_stub if $use_gdb_stub { gdb_run_cmd gdb_expect { -re ".*Breakpoint .*main .*$gdb_prompt $"\ {pass "rerun to main" ; return 0} -re "$gdb_prompt $"\ {fail "rerun to main" ; return 0} timeout {fail "(timeout) rerun to main" ; return 0} } } else { send_gdb "run\n" gdb_expect { -re "The program .* has been started already.*y or n. $" { send_gdb "y\n" exp_continue } -re "Starting program.*$gdb_prompt $"\ {pass "rerun to main" ; return 0} -re "$gdb_prompt $"\ {fail "rerun to main" ; return 0} timeout {fail "(timeout) rerun to main" ; return 0} } } } # Print a message and return true if a test should be skipped # due to lack of floating point suport. proc gdb_skip_float_test { msg } { if [target_info exists gdb,skip_float_tests] { verbose "Skipping test '$msg': no float tests." return 1 } return 0 } # Print a message and return true if a test should be skipped # due to lack of stdio support. proc gdb_skip_stdio_test { msg } { if [target_info exists gdb,noinferiorio] { verbose "Skipping test '$msg': no inferior i/o." return 1 } return 0 } proc gdb_skip_bogus_test { msg } { return 0 } # Return true if a test should be skipped due to lack of XML support # in the host GDB. # NOTE: This must be called while gdb is *not* running. gdb_caching_proc gdb_skip_xml_test { global gdb_prompt global srcdir gdb_start set xml_missing 0 gdb_test_multiple "set tdesc filename ${srcdir}/gdb.xml/trivial.xml" "" { -re ".*XML support was disabled at compile time.*$gdb_prompt $" { set xml_missing 1 } -re ".*$gdb_prompt $" { } } gdb_exit return $xml_missing } # Note: the procedure gdb_gnu_strip_debug will produce an executable called # ${binfile}.dbglnk, which is just like the executable ($binfile) but without # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains # the name of a debuginfo only file. This file will be stored in the same # subdirectory. # Functions for separate debug info testing # starting with an executable: # foo --> original executable # at the end of the process we have: # foo.stripped --> foo w/o debug info # foo.debug --> foo's debug info # foo --> like foo, but with a new .gnu_debuglink section pointing to foo.debug. # Return the build-id hex string (usually 160 bits as 40 hex characters) # converted to the form: .build-id/ab/cdef1234...89.debug # Return "" if no build-id found. proc build_id_debug_filename_get { exec } { set tmp [standard_output_file "${exec}-tmp"] set objcopy_program [gdb_find_objcopy] set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $exec $tmp" output] verbose "result is $result" verbose "output is $output" if {$result == 1} { return "" } set fi [open $tmp] fconfigure $fi -translation binary # Skip the NOTE header. read $fi 16 set data [read $fi] close $fi file delete $tmp if ![string compare $data ""] then { return "" } # Convert it to hex. binary scan $data H* data regsub {^..} $data {\0/} data return ".build-id/${data}.debug" } # Create stripped files for DEST, replacing it. If ARGS is passed, it is a # list of optional flags. The only currently supported flag is no-main, # which removes the symbol entry for main from the separate debug file. # # Function returns zero on success. Function will return non-zero failure code # on some targets not supporting separate debug info (such as i386-msdos). proc gdb_gnu_strip_debug { dest args } { # Use the first separate debug info file location searched by GDB so the # run cannot be broken by some stale file searched with higher precedence. set debug_file "${dest}.debug" set strip_to_file_program [transform strip] set objcopy_program [gdb_find_objcopy] set debug_link [file tail $debug_file] set stripped_file "${dest}.stripped" # Get rid of the debug info, and store result in stripped_file # something like gdb/testsuite/gdb.base/blah.stripped. set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output] verbose "result is $result" verbose "output is $output" if {$result == 1} { return 1 } # Workaround PR binutils/10802: # Preserve the 'x' bit also for PIEs (Position Independent Executables). set perm [file attributes ${dest} -permissions] file attributes ${stripped_file} -permissions $perm # Get rid of everything but the debug info, and store result in debug_file # This will be in the .debug subdirectory, see above. set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output] verbose "result is $result" verbose "output is $output" if {$result == 1} { return 1 } # If no-main is passed, strip the symbol for main from the separate # file. This is to simulate the behavior of elfutils's eu-strip, which # leaves the symtab in the original file only. There's no way to get # objcopy or strip to remove the symbol table without also removing the # debugging sections, so this is as close as we can get. if { [llength $args] == 1 && [lindex $args 0] == "no-main" } { set result [catch "exec $objcopy_program -N main ${debug_file} ${debug_file}-tmp" output] verbose "result is $result" verbose "output is $output" if {$result == 1} { return 1 } file delete "${debug_file}" file rename "${debug_file}-tmp" "${debug_file}" } # Link the two previous output files together, adding the .gnu_debuglink # section to the stripped_file, containing a pointer to the debug_file, # save the new file in dest. # This will be the regular executable filename, in the usual location. set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output] verbose "result is $result" verbose "output is $output" if {$result == 1} { return 1 } # Workaround PR binutils/10802: # Preserve the 'x' bit also for PIEs (Position Independent Executables). set perm [file attributes ${stripped_file} -permissions] file attributes ${dest} -permissions $perm return 0 } # Test the output of GDB_COMMAND matches the pattern obtained # by concatenating all elements of EXPECTED_LINES. This makes # it possible to split otherwise very long string into pieces. # If third argument is not empty, it's used as the name of the # test to be printed on pass/fail. proc help_test_raw { gdb_command expected_lines args } { set message $gdb_command if [llength $args]>0 then { set message [lindex $args 0] } set expected_output [join $expected_lines ""] gdb_test "${gdb_command}" "${expected_output}" $message } # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES # are regular expressions that should match the beginning of output, # before the list of commands in that class. The presence of # command list and standard epilogue will be tested automatically. proc test_class_help { command_class expected_initial_lines args } { set l_stock_body { "List of commands\:.*\[\r\n\]+" "Type \"help\" followed by command name for full documentation\.\[\r\n\]+" "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n\]+" "Command name abbreviations are allowed if unambiguous\." } set l_entire_body [concat $expected_initial_lines $l_stock_body] eval [list help_test_raw "help ${command_class}" $l_entire_body] $args } # COMMAND_LIST should have either one element -- command to test, or # two elements -- abbreviated command to test, and full command the first # element is abbreviation of. # The command must be a prefix command. EXPECTED_INITIAL_LINES # are regular expressions that should match the beginning of output, # before the list of subcommands. The presence of # subcommand list and standard epilogue will be tested automatically. proc test_prefix_command_help { command_list expected_initial_lines args } { set command [lindex $command_list 0] if {[llength $command_list]>1} { set full_command [lindex $command_list 1] } else { set full_command $command } # Use 'list' and not just {} because we want variables to # be expanded in this list. set l_stock_body [list\ "List of $full_command subcommands\:.*\[\r\n\]+"\ "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\ "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\ "Command name abbreviations are allowed if unambiguous\."] set l_entire_body [concat $expected_initial_lines $l_stock_body] if {[llength $args]>0} { help_test_raw "help ${command}" $l_entire_body [lindex $args 0] } else { help_test_raw "help ${command}" $l_entire_body } } # Build executable named EXECUTABLE from specifications that allow # different options to be passed to different sub-compilations. # TESTNAME is the name of the test; this is passed to 'untested' if # something fails. # OPTIONS is passed to the final link, using gdb_compile. If OPTIONS # contains the option "pthreads", then gdb_compile_pthreads is used. # ARGS is a flat list of source specifications, of the form: # { SOURCE1 OPTIONS1 [ SOURCE2 OPTIONS2 ]... } # Each SOURCE is compiled to an object file using its OPTIONS, # using gdb_compile. # Returns 0 on success, -1 on failure. proc build_executable_from_specs {testname executable options args} { global subdir global srcdir set binfile [standard_output_file $executable] set info_options "" if { [lsearch -exact $options "c++"] >= 0 } { set info_options "c++" } if [get_compiler_info ${info_options}] { return -1 } set func gdb_compile set func_index [lsearch -regexp $options {^(pthreads|shlib|shlib_pthreads)$}] if {$func_index != -1} { set func "${func}_[lindex $options $func_index]" } # gdb_compile_shlib and gdb_compile_shlib_pthreads do not use the 3rd # parameter. They also requires $sources while gdb_compile and # gdb_compile_pthreads require $objects. Moreover they ignore any options. if [string match gdb_compile_shlib* $func] { set sources_path {} foreach {s local_options} $args { lappend sources_path "${srcdir}/${subdir}/${s}" } set ret [$func $sources_path "${binfile}" $options] } else { set objects {} set i 0 foreach {s local_options} $args { if { [gdb_compile "${srcdir}/${subdir}/${s}" "${binfile}${i}.o" object $local_options] != "" } { untested $testname return -1 } lappend objects "${binfile}${i}.o" incr i } set ret [$func $objects "${binfile}" executable $options] } if { $ret != "" } { untested $testname return -1 } return 0 } # Build executable named EXECUTABLE, from SOURCES. If SOURCES are not # provided, uses $EXECUTABLE.c. The TESTNAME paramer is the name of test # to pass to untested, if something is wrong. OPTIONS are passed # to gdb_compile directly. proc build_executable { testname executable {sources ""} {options {debug}} } { if {[llength $sources]==0} { set sources ${executable}.c } set arglist [list $testname $executable $options] foreach source $sources { lappend arglist $source $options } return [eval build_executable_from_specs $arglist] } # Starts fresh GDB binary and loads EXECUTABLE into GDB. EXECUTABLE is # the basename of the binary. proc clean_restart { executable } { global srcdir global subdir set binfile [standard_output_file ${executable}] gdb_exit gdb_start gdb_reinitialize_dir $srcdir/$subdir gdb_load ${binfile} } # Prepares for testing by calling build_executable_full, then # clean_restart. # TESTNAME is the name of the test. # Each element in ARGS is a list of the form # { EXECUTABLE OPTIONS SOURCE_SPEC... } # These are passed to build_executable_from_specs, which see. # The last EXECUTABLE is passed to clean_restart. # Returns 0 on success, non-zero on failure. proc prepare_for_testing_full {testname args} { foreach spec $args { if {[eval build_executable_from_specs [list $testname] $spec] == -1} { return -1 } set executable [lindex $spec 0] } clean_restart $executable return 0 } # Prepares for testing, by calling build_executable, and then clean_restart. # Please refer to build_executable for parameter description. proc prepare_for_testing { testname executable {sources ""} {options {debug}}} { if {[build_executable $testname $executable $sources $options] == -1} { return -1 } clean_restart $executable return 0 } proc get_valueof { fmt exp default } { global gdb_prompt set test "get valueof \"${exp}\"" set val ${default} gdb_test_multiple "print${fmt} ${exp}" "$test" { -re "\\$\[0-9\]* = (.*)\[\r\n\]*$gdb_prompt $" { set val $expect_out(1,string) pass "$test ($val)" } timeout { fail "$test (timeout)" } } return ${val} } proc get_integer_valueof { exp default } { global gdb_prompt set test "get integer valueof \"${exp}\"" set val ${default} gdb_test_multiple "print /d ${exp}" "$test" { -re "\\$\[0-9\]* = (\[-\]*\[0-9\]*).*$gdb_prompt $" { set val $expect_out(1,string) pass "$test ($val)" } timeout { fail "$test (timeout)" } } return ${val} } proc get_hexadecimal_valueof { exp default } { global gdb_prompt send_gdb "print /x ${exp}\n" set test "get hexadecimal valueof \"${exp}\"" gdb_expect { -re "\\$\[0-9\]* = (0x\[0-9a-zA-Z\]+).*$gdb_prompt $" { set val $expect_out(1,string) pass "$test" } timeout { set val ${default} fail "$test (timeout)" } } return ${val} } proc get_sizeof { type default } { return [get_integer_valueof "sizeof (${type})" $default] } proc get_target_charset { } { global gdb_prompt gdb_test_multiple "show target-charset" "" { -re "The target character set is \"auto; currently (\[^\"\]*)\".*$gdb_prompt $" { return $expect_out(1,string) } -re "The target character set is \"(\[^\"\]*)\".*$gdb_prompt $" { return $expect_out(1,string) } } # Pick a reasonable default. warning "Unable to read target-charset." return "UTF-8" } # Get the current value for remotetimeout and return it. proc get_remotetimeout { } { global gdb_prompt global decimal gdb_test_multiple "show remotetimeout" "" { -re "Timeout limit to wait for target to respond is ($decimal).*$gdb_prompt $" { return $expect_out(1,string) } } # Pick the default that gdb uses warning "Unable to read remotetimeout" return 300 } # Set the remotetimeout to the specified timeout. Nothing is returned. proc set_remotetimeout { timeout } { global gdb_prompt gdb_test_multiple "set remotetimeout $timeout" "" { -re "$gdb_prompt $" { verbose "Set remotetimeout to $timeout\n" } } } # ROOT and FULL are file names. Returns the relative path from ROOT # to FULL. Note that FULL must be in a subdirectory of ROOT. # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this # will return "ls". proc relative_filename {root full} { set root_split [file split $root] set full_split [file split $full] set len [llength $root_split] if {[eval file join $root_split] != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} { error "$full not a subdir of $root" } return [eval file join [lrange $full_split $len end]] } # Log gdb command line and script if requested. if {[info exists TRANSCRIPT]} { rename send_gdb real_send_gdb rename remote_spawn real_remote_spawn rename remote_close real_remote_close global gdb_transcript set gdb_transcript "" global gdb_trans_count set gdb_trans_count 1 proc remote_spawn {args} { global gdb_transcript gdb_trans_count outdir if {$gdb_transcript != ""} { close $gdb_transcript } set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w] puts $gdb_transcript [lindex $args 1] incr gdb_trans_count return [uplevel real_remote_spawn $args] } proc remote_close {args} { global gdb_transcript if {$gdb_transcript != ""} { close $gdb_transcript set gdb_transcript "" } return [uplevel real_remote_close $args] } proc send_gdb {args} { global gdb_transcript if {$gdb_transcript != ""} { puts -nonewline $gdb_transcript [lindex $args 0] } return [uplevel real_send_gdb $args] } } # If GDB_PARALLEL exists, then set up the parallel-mode directories. if {[info exists GDB_PARALLEL]} { if {[is_remote host]} { unset GDB_PARALLEL } else { file mkdir outputs temp cache } } proc core_find {binfile {deletefiles {}} {arg ""}} { global objdir subdir set destcore "$binfile.core" file delete $destcore # Create a core file named "$destcore" rather than just "core", to # avoid problems with sys admin types that like to regularly prune all # files named "core" from the system. # # Arbitrarily try setting the core size limit to "unlimited" since # this does not hurt on systems where the command does not work and # allows us to generate a core on systems where it does. # # Some systems append "core" to the name of the program; others append # the name of the program to "core"; still others (like Linux, as of # May 2003) create cores named "core.PID". In the latter case, we # could have many core files lying around, and it may be difficult to # tell which one is ours, so let's run the program in a subdirectory. set found 0 set coredir [standard_output_file coredir.[getpid]] file mkdir $coredir catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\"" # remote_exec host "${binfile}" foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" { if [remote_file build exists $i] { remote_exec build "mv $i $destcore" set found 1 } } # Check for "core.PID". if { $found == 0 } { set names [glob -nocomplain -directory $coredir core.*] if {[llength $names] == 1} { set corefile [file join $coredir [lindex $names 0]] remote_exec build "mv $corefile $destcore" set found 1 } } if { $found == 0 } { # The braindamaged HPUX shell quits after the ulimit -c above # without executing ${binfile}. So we try again without the # ulimit here if we didn't find a core file above. # Oh, I should mention that any "braindamaged" non-Unix system has # the same problem. I like the cd bit too, it's really neat'n stuff. catch "system \"(cd ${objdir}/${subdir}; ${binfile}; true) >/dev/null 2>&1\"" foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" { if [remote_file build exists $i] { remote_exec build "mv $i $destcore" set found 1 } } } # Try to clean up after ourselves. foreach deletefile $deletefiles { remote_file build delete [file join $coredir $deletefile] } remote_exec build "rmdir $coredir" if { $found == 0 } { warning "can't generate a core file - core tests suppressed - check ulimit -c" return "" } return $destcore } # gdb_target_symbol_prefix_flags returns a string that can be added # to gdb_compile options to define SYMBOL_PREFIX macro value # symbol_prefix_flags returns a string that can be added # for targets that use underscore as symbol prefix. # TODO: find out automatically if the target needs this. proc gdb_target_symbol_prefix_flags {} { if { [istarget "*-*-cygwin*"] || [istarget "i?86-*-mingw*"] || [istarget "*-*-msdosdjgpp*"] || [istarget "*-*-go32*"] } { return "additional_flags=-DSYMBOL_PREFIX=\"_\"" } else { return "" } } # A wrapper for 'remote_exec host' that passes or fails a test. # Returns 0 if all went well, nonzero on failure. # TEST is the name of the test, other arguments are as for remote_exec. proc run_on_host { test program args } { verbose -log "run_on_host: $program $args" # remote_exec doesn't work properly if the output is set but the # input is the empty string -- so replace an empty input with # /dev/null. if {[llength $args] > 1 && [lindex $args 1] == ""} { set args [lreplace $args 1 1 "/dev/null"] } set result [eval remote_exec host [list $program] $args] verbose "result is $result" set status [lindex $result 0] set output [lindex $result 1] if {$status == 0} { pass $test return 0 } else { verbose -log "run_on_host failed: $output" fail $test return -1 } } # Return non-zero if "board_info debug_flags" mentions Fission. # http://gcc.gnu.org/wiki/DebugFission # Fission doesn't support everything yet. # This supports working around bug 15954. proc using_fission { } { set debug_flags [board_info [target_info name] debug_flags] return [regexp -- "-gsplit-dwarf" $debug_flags] } # Always load compatibility stuff. load_lib future.exp