| blob | 8dea857d5ed390711cdb944ae81e5aee74b8a82a |
4 # it under the terms of the GNU General Public License as published by
7 #
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
20 # or by passing arguments.
24 send_error "`site.exp' not found, run `make site.exp'!\n"
25 exit 2
26 }
28 load_lib libgloss.exp
29 load_lib cache.exp
30 load_lib gdb-utils.exp
31 load_lib memory.exp
33 global GDB
38 # Otherwise, the board may set this to some other spawn ID. E.g.,
41 global inferior_spawn_id
43 if [info exists TOOL_EXECUTABLE] {
44 set GDB $TOOL_EXECUTABLE
45 }
46 if ![info exists GDB] {
47 if ![is_remote host] {
48 set GDB [findfile $base_dir/../../gdb/gdb "$base_dir/../../gdb/gdb" [transform gdb]]
49 } else {
50 set GDB [transform gdb]
51 }
52 }
53 verbose "using GDB = $GDB" 2
55 # GDBFLAGS is available for the user to set on the command line.
56 # E.g. make check RUNTESTFLAGS=GDBFLAGS=mumble
57 # Testcases may use it to add additional flags, but they must:
58 # - append new flags, not overwrite
59 # - restore the original value when done
60 global GDBFLAGS
61 if ![info exists GDBFLAGS] {
62 set GDBFLAGS ""
63 }
64 verbose "using GDBFLAGS = $GDBFLAGS" 2
66 # Make the build data directory available to tests.
67 set BUILD_DATA_DIRECTORY "[pwd]/../data-directory"
69 # INTERNAL_GDBFLAGS contains flags that the testsuite requires.
70 global INTERNAL_GDBFLAGS
71 if ![info exists INTERNAL_GDBFLAGS] {
72 set INTERNAL_GDBFLAGS "-nw -nx -data-directory $BUILD_DATA_DIRECTORY"
73 }
75 # The variable gdb_prompt is a regexp which matches the gdb prompt.
76 # Set it if it is not already set. This is also set by default_gdb_init
79 global gdb_prompt
82 }
84 # A regexp that matches the pagination prompt.
85 set pagination_prompt \
86 "--Type <RET> for more, q to quit, c to continue without paging--"
88 # The variable fullname_syntax_POSIX is a regexp which matches a POSIX
91 # The variable fullname_syntax_UNC is a regexp which matches a Windows
94 # The variable fullname_syntax_DOS_CASE is a regexp which matches a
95 # particular DOS case that GDB most likely will output
98 # The variable fullname_syntax_DOS is a regexp which matches a DOS path
101 # The variable fullname_syntax is a regexp which matches what GDB considers
102 # an absolute path. It is currently debatable if the Windows style paths
104 # Also, the purpse of this regexp is not to recognize a well formed
105 # absolute path, but to say with certainty that a path is absolute.
106 set fullname_syntax "($fullname_syntax_POSIX|$fullname_syntax_UNC|$fullname_syntax_DOS_CASE|$fullname_syntax_DOS)"
108 # Needed for some tests under Cygwin.
109 global EXEEXT
110 global env
112 if ![info exists env(EXEEXT)] {
113 set EXEEXT ""
114 } else {
115 set EXEEXT $env(EXEEXT)
116 }
118 set octal "\[0-7\]+"
122 # A regular expression that matches a value history number.
123 # E.g., $1, $2, etc.
126 ### Only procedures should come after this point.
128 #
129 # gdb_version -- extract and print the version number of GDB
130 #
131 proc default_gdb_version {} {
132 global GDB
133 global INTERNAL_GDBFLAGS GDBFLAGS
134 global gdb_prompt
135 global inotify_pid
137 if {[info exists inotify_pid]} {
138 eval exec kill $inotify_pid
139 }
141 set output [remote_exec host "$GDB $INTERNAL_GDBFLAGS --version"]
142 set tmp [lindex $output 1]
143 set version ""
145 if ![is_remote host] {
147 } else {
149 }
150 }
152 proc gdb_version { } {
153 return [default_gdb_version]
154 }
156 #
157 # gdb_unload -- unload a file if one is loaded
158 # Return 0 on success, -1 on error.
159 #
161 proc gdb_unload {} {
162 global verbose
163 global GDB
164 global gdb_prompt
166 gdb_expect 60 {
169 -re "A program is being debugged already.*Are you sure you want to change the file.*y or n. $" {
171 exp_continue
172 }
173 -re "Discard symbol table from .*y or n.*$" {
175 exp_continue
176 }
177 -re "$gdb_prompt $" {}
178 timeout {
181 }
182 }
184 }
186 # Many of the tests depend on setting breakpoints at various places and
187 # running until that breakpoint is reached. At times, we want to start
189 # lets us do this without duplicating this code everywhere.
190 #
192 proc delete_breakpoints {} {
193 global gdb_prompt
195 # we need a larger timeout value here or this thing just confuses
197 #
202 gdb_test_multiple "delete breakpoints" "$msg" {
204 send_gdb "y\n"
205 exp_continue
206 }
209 }
210 }
213 # Confirm with "info breakpoints".
216 gdb_test_multiple $msg $msg {
219 }
221 }
222 }
223 }
226 perror "breakpoints not deleted"
227 }
228 }
230 # Returns true iff the target supports using the "run" command.
232 proc target_can_use_run_cmd {} {
235 # running.
237 }
239 # Assume yes.
241 }
243 # Generic run command.
244 #
247 # elsewhere.
248 #
250 # that is the caller's responsibility.
252 proc gdb_run_cmd {args} {
253 global gdb_prompt use_gdb_stub
255 foreach command [gdb_init_commands] {
257 gdb_expect 30 {
258 -re "$gdb_prompt $" { }
259 default {
260 perror "gdb_init_command for target failed"
261 return
262 }
263 }
264 }
266 if $use_gdb_stub {
267 if [target_info exists gdb,do_reload_on_run] {
268 if { [gdb_reload] != 0 } {
269 return
270 }
272 gdb_expect 60 {
274 default {}
275 }
276 return
277 }
279 if [target_info exists gdb,start_symbol] {
280 set start [target_info gdb,start_symbol]
281 } else {
282 set start "start"
283 }
285 set start_attempt 1
286 while { $start_attempt } {
287 # Cap (re)start attempts at three to ensure that this loop
288 # always eventually fails. Don't worry about trying to be
289 # clever and not send a command when it has failed.
291 perror "Jump to start() failed (retry count exceeded)"
292 return
293 }
298 }
300 perror "Can't find start symbol to run in gdb_run"
301 return
302 }
304 send_gdb "jump *_start\n"
305 }
308 }
310 send_gdb "y\n"
311 }
314 return
315 }
316 send_gdb "jump *$start\n"
317 }
318 timeout {
319 perror "Jump to start() failed (timeout)"
320 return
321 }
322 }
323 }
324 return
325 }
329 return
330 }
331 }
332 send_gdb "run $args\n"
333 # This doesn't work quite right yet.
334 # Use -notransfer here so that test cases (like chng-sym.exp)
335 # may test for additional start-up messages.
336 gdb_expect 60 {
337 -re "The program .* has been started already.*y or n. $" {
339 exp_continue
340 }
342 -notransfer -re "$gdb_prompt $" {
343 # There is no more input expected.
344 }
345 }
346 }
348 # Generic start command. Return 0 if we could start the program, -1
349 # if we could not.
350 #
351 # N.B. This function does not wait for gdb to return to the prompt,
352 # that is the caller's responsibility.
355 global gdb_prompt use_gdb_stub
358 send_gdb "$command\n"
361 default {
362 perror "gdb_init_command for target failed"
364 }
365 }
366 }
370 }
372 send_gdb "start $args\n"
377 send_gdb "y\n"
378 exp_continue
379 }
382 }
383 }
385 }
388 # if we could not.
389 #
391 # that is the caller's responsibility.
393 proc gdb_starti_cmd {args} {
394 global gdb_prompt use_gdb_stub
396 foreach command [gdb_init_commands] {
398 gdb_expect 30 {
399 -re "$gdb_prompt $" { }
400 default {
401 perror "gdb_init_command for target failed"
402 return -1
403 }
404 }
405 }
407 if $use_gdb_stub {
408 return -1
409 }
412 gdb_expect 60 {
413 -re "The program .* has been started already.*y or n. $" {
415 exp_continue
416 }
418 return 0
419 }
420 }
421 return -1
422 }
424 # Set a breakpoint at FUNCTION. If there is an additional argument it is
425 # a list of options; the supported options are allow-pending, temporary,
426 # message, no-message, passfail and qualified.
427 # The result is 1 for success, 0 for failure.
428 #
429 # Note: The handling of message vs no-message is messed up, but it's based
431 # only fails.
436 global gdb_prompt
437 global decimal
439 set pending_response n
441 set pending_response y
442 }
449 }
452 append break_command " -qualified"
453 }
459 # The last one to appear in args wins.
464 }
468 send_gdb "$break_command $function\n"
477 fail $test_name
478 }
480 }
481 }
483 send_gdb "$pending_response\n"
484 exp_continue
485 }
488 fail "$test_name (GDB internal error)"
489 }
490 gdb_internal_error_resync
492 }
495 fail $test_name
496 }
498 }
499 eof {
501 fail "$test_name (eof)"
502 }
504 }
505 timeout {
507 fail "$test_name (timeout)"
508 }
510 }
511 }
513 pass $test_name
514 }
516 }
518 # Set breakpoint at function and run gdb until it breaks there.
521 # just compare to "function" because it might be a fully qualified,
522 # single quoted C++ function specifier.
523 #
524 # If there are additional arguments, pass them to gdb_breakpoint.
525 # We recognize no-message/message ourselves.
526 # The default is no-message.
527 # no-message is messed up here, like gdb_breakpoint: to preserve
528 # historical usage fails are always printed by default.
532 proc runto { function args } {
533 global gdb_prompt
534 global decimal
536 delete_breakpoints
538 # Default to "no-message".
539 set args "no-message $args"
541 set print_pass 0
542 set print_fail 1
543 set no_message_loc [lsearch -exact $args no-message]
544 set message_loc [lsearch -exact $args message]
545 # The last one to appear in args wins.
546 if { $no_message_loc > $message_loc } {
547 set print_fail 0
548 } elseif { $message_loc > $no_message_loc } {
549 set print_pass 1
550 }
552 set test_name "running to $function in runto"
554 # We need to use eval here to pass our varargs args to gdb_breakpoint
555 # which is also a varargs function.
556 # But we also have to be careful because $function may have multiple
561 }
563 gdb_run_cmd
565 # the "at foo.c:36" output we get with -g.
566 # the "in func" output we get without -g.
570 pass $test_name
571 }
573 }
576 pass $test_name
577 }
579 }
582 unsupported "non-stop mode not supported"
583 }
585 }
588 fail "$test_name (GDB internal error)"
589 }
590 gdb_internal_error_resync
592 }
595 fail $test_name
596 }
598 }
599 eof {
601 fail "$test_name (eof)"
602 }
604 }
605 timeout {
607 fail "$test_name (timeout)"
608 }
610 }
611 }
613 pass $test_name
614 }
616 }
618 # Ask gdb to run until we hit a breakpoint at main.
619 #
620 # N.B. This function deletes all existing breakpoints.
623 proc runto_main { } {
624 return [runto main no-message]
625 }
627 ### Continue, and expect to hit a breakpoint.
628 ### Report a pass or fail, depending on whether it seems to have
629 ### worked. Use NAME as part of the test name; each call to
630 ### continue_to_breakpoint should use a NAME which is unique within
631 ### that test file.
632 proc gdb_continue_to_breakpoint {name {location_pattern .*}} {
633 global gdb_prompt
634 set full_name "continue to breakpoint: $name"
636 gdb_test_multiple "continue" $full_name {
638 pass $full_name
639 }
640 }
641 }
644 # gdb_internal_error_resync:
645 #
646 # Answer the questions GDB asks after it reports an internal error
647 # until we get back to a GDB prompt. Decline to quit the debugging
648 # session, and decline to create a core file. Return non-zero if the
649 # resync succeeds.
650 #
651 # This procedure just answers whatever questions come up until it sees
652 # a GDB prompt; it doesn't require you to have matched the input up to
655 # answer it yourself before calling this.
656 #
657 # You can use this function thus:
658 #
659 # gdb_expect {
660 # ...
661 # -re ".*A problem internal to GDB has been detected" {
662 # gdb_internal_error_resync
663 # }
664 # ...
665 # }
666 #
667 proc gdb_internal_error_resync {} {
668 global gdb_prompt
670 verbose -log "Resyncing due to internal error."
672 set count 0
673 while {$count < 10} {
674 gdb_expect {
677 incr count
678 }
681 incr count
682 }
683 -re "$gdb_prompt $" {
684 # We're resynchronized.
686 }
687 timeout {
688 perror "Could not resync from internal error (timeout)"
690 }
691 }
692 }
693 perror "Could not resync from internal error (resync count exceeded)"
695 }
698 # gdb_test_multiple COMMAND MESSAGE EXPECT_ARGUMENTS
699 # Send a command to gdb; test the result.
700 #
702 # this is the null string no command is sent.
703 # MESSAGE is a message to be printed with the built-in failure patterns
705 # EXPECT_ARGUMENTS will be fed to expect in addition to the standard
706 # patterns. Pattern elements will be evaluated in the caller's
709 # the final newline and prompt.
710 #
711 # Returns:
715 #
716 # You can use this function thus:
717 #
718 # gdb_test_multiple "print foo" "test foo" {
720 # pass "print foo"
721 # }
723 # fail "print foo"
724 # }
725 # }
726 #
727 # Like with "expect", you can also specify the spawn id to match with
731 #
732 # send_inferior "hello\n"
733 # gdb_test_multiple "continue" "test echo" {
735 # pass "got echo"
736 # }
738 # fail "hit breakpoint"
739 # }
740 # }
741 #
743 # ...", all being implicitly appended to that list. These are always
745 # about resetting "-i" back to $gdb_spawn_id explicitly.
746 #
748 global verbose use_gdb_stub
749 global gdb_prompt pagination_prompt
750 global GDB
751 global gdb_spawn_id
752 global inferior_exited_re
753 upvar timeout timeout
754 upvar expect_out expect_out
755 global any_spawn_id
758 set message $command
759 }
762 error "Invalid trailing newline in \"$message\" test"
763 }
766 error "Invalid newline in \"$message\" test"
767 }
771 $command]} {
772 error "gdbserver does not support $command without extended-remote"
773 }
775 # TCL/EXPECT WART ALERT
776 # Expect does something very strange when it receives a single braced
777 # argument. It splits it along word separators and performs substitutions.
779 # evaluated as "\[ab\]". But that's not how TCL normally works; inside a
781 # "[ab]", because the backslashes will be removed by lindex.
783 # Unfortunately, there appears to be no easy way to duplicate the splitting
784 # that expect will do from within TCL. And many places make use of the
785 # "\[0-9\]" construct, so we need to support that; and some places make use
786 # of the "[func]" construct, so we need to support that too. In order to
787 # get this right we have to substitute quoted list elements differently
788 # from braced list elements.
790 # We do this roughly the same way that Expect does it. We have to use two
792 # they'll be treated as command separators, and if we escape newlines
793 # we mangle newlines inside of command blocks. This assumes that the
794 # input doesn't contain a pattern which contains actual embedded newlines
795 # at this point!
804 foreach item $user_code subst_item $subst_code {
806 lappend processed_code $item
807 continue
808 }
810 lappend processed_code $item
811 continue
812 }
815 lappend processed_code $item
816 continue
817 }
820 lappend processed_code $subst_item
821 continue
822 }
824 lappend processed_code "uplevel [list $item]"
827 append processed_code "\n"
828 continue
829 }
831 lappend processed_code $subst_item
833 append patterns "; "
834 }
835 append patterns "\"$subst_item\""
836 }
838 # Also purely cosmetic.
843 send_user "Sending \"$command\" to gdb\n"
844 send_user "Looking to match \"$patterns\"\n"
845 send_user "Message is \"$message\"\n"
846 }
858 global suppress_flag
861 perror "Couldn't send $command to GDB."
862 }
863 fail "$message"
864 return $result
865 }
866 # since we're checking if each line of the multi-line
868 # we need to set -notransfer expect option so that
869 # command output is not lost for pattern matching
870 # - guo
871 gdb_expect 2 {
872 -notransfer -re "$multi_line_re$" { verbose "partial: match" 3 }
873 timeout { verbose "partial: timeout" 3 }
874 }
875 set string [string range "$string" [expr $foo + 1] end]
877 } else {
878 break
879 }
880 }
881 if { "$string" != "" } {
882 if { [send_gdb "$string"] != "" } {
883 global suppress_flag
885 if { ! $suppress_flag } {
887 }
888 fail "$message"
889 return $result
890 }
891 }
892 }
896 fail "$message (GDB internal error)"
897 gdb_internal_error_resync
899 }
902 fail "$message"
903 }
904 gdb_suppress_entire_file "GDB died"
906 }
907 }
908 append code $processed_code
911 append code {
913 }
915 append code {
918 warning "Can`t communicate to remote target."
919 }
920 gdb_exit
921 gdb_start
923 }
925 perror "Undefined command \"$command\"."
926 fail "$message"
928 }
930 perror "\"$command\" is not a unique command name."
931 fail "$message"
933 }
939 }
940 fail "$errmsg"
942 }
948 }
949 fail "$errmsg"
951 }
957 }
958 fail "$errmsg"
960 }
963 fail "$message"
964 }
966 }
968 send_gdb "\n"
969 perror "Window too small."
970 fail "$message"
972 }
974 send_gdb "n\n"
976 fail "$message (got interactive prompt)"
978 }
980 send_gdb "0\n"
982 fail "$message (got breakpoint menu)"
984 }
986 -i $gdb_spawn_id
987 eof {
988 perror "GDB process no longer exists"
992 fail "$message"
993 }
995 }
996 }
998 # Now patterns that apply to any spawn id specified.
999 append code {
1000 -i $any_spawn_id
1001 eof {
1002 perror "Process no longer exists"
1004 fail "$message"
1005 }
1007 }
1008 full_buffer {
1009 perror "internal buffer is full."
1010 fail "$message"
1012 }
1013 timeout {
1015 fail "$message (timeout)"
1016 }
1018 }
1019 }
1023 # want them to get called in that situation. Since the last eof
1024 # section becomes the error section, here we define another eof
1025 # section, but with an empty spawn_id list, so that it won't ever
1026 # match.
1027 append code {
1029 # This comment is here because the eof section must not be
1031 # it exists.
1032 }
1033 }
1035 set result 0
1036 set code [catch {gdb_expect $code} string]
1037 if {$code == 1} {
1038 global errorInfo errorCode
1039 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
1040 } elseif {$code > 1} {
1041 return -code $code $string
1042 }
1043 return $result
1044 }
1046 # gdb_test COMMAND PATTERN MESSAGE QUESTION RESPONSE
1047 # Send a command to gdb; test the result.
1048 #
1049 # COMMAND is the command to execute, send to GDB with send_gdb. If
1050 # this is the null string no command is sent.
1051 # PATTERN is the pattern to match for a PASS, and must NOT include
1053 # may be omitted to just match the prompt, ignoring whatever output
1054 # precedes it.
1055 # MESSAGE is an optional message to be printed. If this is
1056 # omitted, then the pass/fail messages use the command string as the
1057 # message. (If this is the empty string, then sometimes we don't
1059 # QUESTION is a question GDB may ask in response to COMMAND, like
1060 # "are you sure?"
1061 # RESPONSE is the response to send if QUESTION appears.
1062 #
1063 # Returns:
1064 # 1 if the test failed,
1065 # 0 if the test passes,
1066 # -1 if there was an internal error.
1067 #
1068 proc gdb_test { args } {
1069 global gdb_prompt
1070 upvar timeout timeout
1072 if [llength $args]>2 then {
1073 set message [lindex $args 2]
1074 } else {
1075 set message [lindex $args 0]
1076 }
1077 set command [lindex $args 0]
1078 set pattern [lindex $args 1]
1080 if [llength $args]==5 {
1081 set question_string [lindex $args 3]
1082 set response_string [lindex $args 4]
1083 } else {
1084 set question_string "^FOOBAR$"
1085 }
1087 return [gdb_test_multiple $command $message {
1089 if ![string match "" $message] then {
1090 pass "$message"
1091 }
1092 }
1093 -re "(${question_string})$" {
1095 exp_continue
1096 }
1097 }]
1098 }
1100 # gdb_test_no_output COMMAND MESSAGE
1101 # Send a command to GDB and verify that this command generated no output.
1102 #
1103 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1104 # parameters. If MESSAGE is ommitted, then COMMAND will be used as
1105 # the message. (If MESSAGE is the empty string, then sometimes we do not
1109 global gdb_prompt
1114 set message $command
1115 }
1118 gdb_test_multiple $command $message {
1121 pass "$message"
1122 }
1123 }
1124 }
1125 }
1128 # This is useful when the sequence is long and contains ".*", a single
1129 # regexp to match the entire output can get a timeout much easier.
1130 #
1132 # this is the null string no command is sent.
1134 # EXPECTED_OUTPUT_LIST is a list of regexps of expected output, which are
1135 # processed in order, and all must be present in the output.
1136 #
1137 # It is unnecessary to specify ".*" at the beginning or end of any regexp,
1138 # there is an implicit ".*" between each element of EXPECTED_OUTPUT_LIST.
1139 # There is also an implicit ".*" between the last regexp and the gdb prompt.
1140 #
1141 # Like gdb_test and gdb_test_multiple, the output is expected to end with the
1142 # gdb prompt, which must not be specified in EXPECTED_OUTPUT_LIST.
1143 #
1144 # Returns:
1150 global gdb_prompt
1152 set test_name $command
1153 }
1154 lappend expected_output_list ""; # implicit ".*" before gdb prompt
1156 send_gdb "$command\n"
1157 }
1159 }
1161 \f
1163 # a 1 to indicate that more tests can proceed. However a timeout
1165 # a 0 to be returned to indicate that more tests are likely to fail
1166 # as well.
1169 global gdb_prompt
1170 global verbose
1176 }
1179 send_user "Sending \"$sendthis\" to gdb\n"
1180 send_user "Looking to match \"$expectthis\"\n"
1181 }
1182 send_gdb "$sendthis\n"
1183 #FIXME: Should add timeout as parameter.
1184 gdb_expect {
1186 pass "reject $sendthis"
1188 }
1190 pass "reject $sendthis"
1192 }
1194 pass "reject $sendthis"
1196 }
1198 pass "reject $sendthis"
1200 }
1202 pass "reject $sendthis"
1204 }
1206 pass "reject $sendthis"
1208 }
1210 pass "reject $sendthis"
1212 }
1214 pass "reject $sendthis"
1216 }
1218 pass "reject $sendthis"
1220 }
1222 pass "reject $sendthis"
1224 }
1226 fail "reject $sendthis"
1228 }
1229 default {
1230 fail "reject $sendthis (eof or timeout)"
1232 }
1233 }
1234 }
1235 \f
1238 # but a string that must match exactly.
1241 upvar timeout timeout
1245 # This applies a special meaning to a null string pattern. Without
1247 # messages from commands that should have no output except a new
1248 # prompt. With this, only results of a null string will match a null
1249 # string pattern.
1256 }
1258 # It is most natural to write the pattern argument with only
1262 # case some users of gdb_test_exact already do the right thing.
1265 if [llength $args]==3 then {
1266 set message [lindex $args 2]
1267 } else {
1268 set message $command
1269 }
1271 return [gdb_test $command $pattern $message]
1272 }
1274 # Wrapper around gdb_test_multiple that looks for a list of expected
1275 # output elements, but which can appear in any order.
1276 # CMD is the gdb command.
1277 # NAME is the name of the test.
1278 # ELM_FIND_REGEXP specifies how to partition the output into elements to
1279 # compare.
1280 # ELM_EXTRACT_REGEXP specifies the part of ELM_FIND_REGEXP to compare.
1281 # RESULT_MATCH_LIST is a list of exact matches for each expected element.
1282 # All elements of RESULT_MATCH_LIST must appear for the test to pass.
1283 #
1284 # A typical use of ELM_FIND_REGEXP/ELM_EXTRACT_REGEXP is to extract one line
1286 # Example:
1287 # gdb_test_list_exact "foo" "bar" \
1288 # "\[^\r\n\]+\[\r\n\]+" \
1289 # "\[^\r\n\]+" \
1290 # { \
1293 # }
1296 global gdb_prompt
1301 "$cmd\[\r\n\]" { exp_continue }
1305 regexp -- $elm_extract_regexp $str elm_seen
1307 lappend seen $elm_seen
1308 exp_continue
1309 }
1314 set failed $have
1315 break
1316 }
1317 }
1319 fail "$name ($failed not found)"
1321 pass $name
1322 }
1323 }
1324 }
1325 }
1327 # gdb_test_stdio COMMAND INFERIOR_PATTERN GDB_PATTERN MESSAGE
1328 # Send a command to gdb; expect inferior and gdb output.
1329 #
1330 # See gdb_test_multiple for a description of the COMMAND and MESSAGE
1331 # parameters.
1332 #
1333 # INFERIOR_PATTERN is the pattern to match against inferior output.
1334 #
1335 # GDB_PATTERN is the pattern to match against gdb output, and must NOT
1337 # prompt. The default is empty.
1338 #
1339 # Both inferior and gdb patterns must match for a PASS.
1340 #
1342 #
1343 # Returns:
1347 #
1350 global inferior_spawn_id gdb_spawn_id
1351 global gdb_prompt
1354 set message $command
1355 }
1360 # Use an indirect spawn id list, and remove the inferior spawn id
1361 # from the expected output as soon as it matches, in case
1362 # $inferior_pattern happens to be a prefix of the resulting full
1364 global gdb_test_stdio_spawn_id_list
1369 # output.
1375 exp_continue
1376 }
1377 }
1381 exp_continue
1382 }
1383 }
1384 }]
1386 pass $message
1389 }
1390 return $res
1391 }
1393 # get_print_expr_at_depths EXP OUTPUTS
1394 #
1397 # of `n` different patterns to match at each of the depths from 0 to
1399 #
1401 # which is tested against the last pattern in the OUTPUTS list. The
1403 # depth where the whole of EXP is printed with no ellipsis.
1404 #
1413 set depth_string $depth
1414 }
1416 with_test_prefix "exp='$exp': depth=${depth_string}" {
1417 gdb_test_no_output "set print max-depth ${depth_string}"
1418 gdb_test "p $exp" "$expected_result"
1419 }
1420 }
1421 }
1423 \f
1426 # frame returns true, and issue a FAIL and return false otherwise.
1427 # MESSAGE is the pass/fail message to be printed. If MESSAGE is
1428 # omitted or is empty, then the pass/fail messages use the condition
1429 # string as the message.
1431 proc gdb_assert { condition {message ""} } {
1432 if { $message == ""} {
1433 set message $condition
1434 }
1436 set res [uplevel 1 expr $condition]
1437 if {!$res} {
1438 fail $message
1439 } else {
1440 pass $message
1441 }
1442 return $res
1443 }
1445 proc gdb_reinitialize_dir { subdir } {
1446 global gdb_prompt
1448 if [is_remote host] {
1449 return ""
1450 }
1452 gdb_expect 60 {
1453 -re "Reinitialize source path to empty.*y or n. " {
1455 gdb_expect 60 {
1456 -re "Source directories searched.*$gdb_prompt $" {
1458 gdb_expect 60 {
1459 -re "Source directories searched.*$gdb_prompt $" {
1460 verbose "Dir set to $subdir"
1461 }
1462 -re "$gdb_prompt $" {
1464 }
1465 }
1466 }
1467 -re "$gdb_prompt $" {
1469 }
1470 }
1471 }
1472 -re "$gdb_prompt $" {
1474 }
1475 }
1476 }
1478 #
1479 # gdb_exit -- exit the GDB, killing the target program if necessary
1480 #
1481 proc default_gdb_exit {} {
1482 global GDB
1483 global INTERNAL_GDBFLAGS GDBFLAGS
1484 global verbose
1485 global gdb_spawn_id inferior_spawn_id
1486 global inotify_log_file
1488 gdb_stop_suppressing_tests
1490 if ![info exists gdb_spawn_id] {
1491 return
1492 }
1494 verbose "Quitting $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1496 if {[info exists inotify_log_file] && [file exists $inotify_log_file]} {
1497 set fd [open $inotify_log_file]
1498 set data [read -nonewline $fd]
1499 close $fd
1501 if {[string compare $data ""] != 0} {
1502 warning "parallel-unsafe file creations noticed"
1504 # Clear the log.
1505 set fd [open $inotify_log_file w]
1506 close $fd
1507 }
1508 }
1510 if { [is_remote host] && [board_info host exists fileid] } {
1512 gdb_expect 10 {
1513 -re "y or n" {
1515 exp_continue
1516 }
1517 -re "DOSEXIT code" { }
1518 default { }
1519 }
1520 }
1522 if ![is_remote host] {
1523 remote_close host
1524 }
1525 unset gdb_spawn_id
1526 unset inferior_spawn_id
1527 }
1529 # Load a file into the debugger.
1530 # The return value is 0 for success, -1 for failure.
1531 #
1532 # This procedure also set the global variable GDB_FILE_CMD_DEBUG_INFO
1533 # to one of these values:
1534 #
1535 # debug file was loaded successfully and has debug information
1536 # nodebug file was loaded successfully and has no debug information
1537 # lzma file was loaded, .gnu_debugdata found, but no LZMA support
1538 # compiled in
1539 # fail file was not loaded
1540 #
1541 # I tried returning this information as part of the return value,
1542 # but ran into a mess because of the many re-implementations of
1543 # gdb_load in config/*.exp.
1544 #
1545 # TODO: gdb.base/sepdebug.exp and gdb.stabs/weird.exp might be able to use
1546 # this if they can get more information set.
1548 proc gdb_file_cmd { arg } {
1549 global gdb_prompt
1550 global verbose
1551 global GDB
1552 global last_loaded_file
1554 # Save this for the benefit of gdbserver-support.exp.
1555 set last_loaded_file $arg
1557 # Set whether debug info was found.
1558 # Default to "fail".
1559 global gdb_file_cmd_debug_info
1560 set gdb_file_cmd_debug_info "fail"
1562 if [is_remote host] {
1563 set arg [remote_download host $arg]
1564 if { $arg == "" } {
1565 perror "download failed"
1566 return -1
1567 }
1568 }
1570 # The file command used to kill the remote target. For the benefit
1571 # of the testsuite, preserve this behavior.
1573 gdb_expect 120 {
1574 -re "Kill the program being debugged. .y or n. $" {
1577 exp_continue
1578 }
1579 -re "$gdb_prompt $" {
1580 # OK.
1581 }
1582 }
1585 gdb_expect 120 {
1586 -re "Reading symbols from.*LZMA support was disabled.*$gdb_prompt $" {
1588 set gdb_file_cmd_debug_info "lzma"
1589 return 0
1590 }
1591 -re "Reading symbols from.*no debugging symbols found.*$gdb_prompt $" {
1593 set gdb_file_cmd_debug_info "nodebug"
1594 return 0
1595 }
1596 -re "Reading symbols from.*$gdb_prompt $" {
1598 set gdb_file_cmd_debug_info "debug"
1599 return 0
1600 }
1603 gdb_expect 120 {
1604 -re "Reading symbols from.*$gdb_prompt $" {
1606 set gdb_file_cmd_debug_info "debug"
1607 return 0
1608 }
1609 timeout {
1612 }
1613 eof {
1614 perror "Couldn't load $arg, other program already loaded (eof)."
1616 }
1617 }
1618 }
1620 perror "($arg) No such file or directory"
1622 }
1624 fail "($arg) (GDB internal error)"
1625 gdb_internal_error_resync
1627 }
1629 perror "Couldn't load $arg into $GDB."
1631 }
1632 timeout {
1633 perror "Couldn't load $arg into $GDB (timeout)."
1635 }
1636 eof {
1637 # This is an attempt to detect a core dump, but seems not to
1639 # gdb_expect does not seem to have a way to do that.
1640 perror "Couldn't load $arg into $GDB (eof)."
1642 }
1643 }
1644 }
1646 # Default gdb_spawn procedure.
1648 proc default_gdb_spawn { } {
1649 global use_gdb_stub
1650 global GDB
1651 global INTERNAL_GDBFLAGS GDBFLAGS
1652 global gdb_spawn_id
1654 gdb_stop_suppressing_tests
1657 #
1658 # Use `set_board_info use_gdb_stub' for the board file to flag the inferior
1659 # is already started after connecting and run/attach are not supported.
1660 # This is used for the "remote" protocol. After GDB starts you should
1661 # check global $use_gdb_stub instead of the board as the testfile may force
1662 # a specific different target protocol itself.
1663 set use_gdb_stub [target_info exists use_gdb_stub]
1665 verbose "Spawning $GDB $INTERNAL_GDBFLAGS $GDBFLAGS"
1667 if [info exists gdb_spawn_id] {
1668 return 0
1669 }
1671 if ![is_remote host] {
1672 if { [which $GDB] == 0 } then {
1673 perror "$GDB does not exist."
1674 exit 1
1675 }
1676 }
1677 set res [remote_spawn host "$GDB $INTERNAL_GDBFLAGS $GDBFLAGS [host_info gdb_opts]"]
1678 if { $res < 0 || $res == "" } {
1679 perror "Spawning $GDB failed."
1680 return 1
1681 }
1683 set gdb_spawn_id $res
1684 return 0
1685 }
1687 # Default gdb_start procedure.
1689 proc default_gdb_start { } {
1690 global gdb_prompt
1691 global gdb_spawn_id
1692 global inferior_spawn_id
1694 if [info exists gdb_spawn_id] {
1695 return 0
1696 }
1698 set res [gdb_spawn]
1699 if { $res != 0} {
1700 return $res
1701 }
1703 # Default to assuming inferior I/O is done on GDB's terminal.
1705 set inferior_spawn_id $gdb_spawn_id
1706 }
1713 verbose "GDB initialized."
1714 }
1716 perror "GDB never initialized."
1717 unset gdb_spawn_id
1719 }
1720 timeout {
1721 perror "(timeout) GDB never initialized after 10 seconds."
1722 remote_close host
1723 unset gdb_spawn_id
1725 }
1726 }
1728 # force the height to "unlimited", so no pagers get used
1730 send_gdb "set height 0\n"
1733 verbose "Setting height to 0." 2
1734 }
1735 timeout {
1736 warning "Couldn't set the height to 0"
1737 }
1738 }
1739 # force the width to "unlimited", so no wraparound occurs
1740 send_gdb "set width 0\n"
1743 verbose "Setting width to 0." 2
1744 }
1745 timeout {
1746 warning "Couldn't set the width to 0."
1747 }
1748 }
1750 }
1752 # Utility procedure to give user control of the gdb prompt in a script. It is
1754 # test cases code.
1756 proc gdb_interact { } {
1757 global gdb_spawn_id
1758 set spawn_id $gdb_spawn_id
1760 send_user "+------------------------------------------+\n"
1761 send_user "| Script interrupted, you can now interact |\n"
1762 send_user "| with by gdb. Type >>> to continue. |\n"
1763 send_user "+------------------------------------------+\n"
1765 interact {
1766 ">>>" return
1767 }
1768 }
1770 # Examine the output of compilation to determine whether compilation
1771 # failed or not. If it failed determine whether it is due to missing
1773 # as appropriate
1777 pass "compilation [file tail $src]"
1779 unsupported "compilation [file tail $src]"
1781 unsupported "compilation [file tail $src]"
1783 unsupported "compilation [file tail $src]"
1784 } else {
1785 verbose -log "compilation failed: $output" 2
1786 fail "compilation [file tail $src]"
1787 }
1788 }
1790 # Return a 1 for configurations for which we don't even want to try to
1791 # test C++.
1793 proc skip_cplus_tests {} {
1796 }
1800 if { [istarget "m6811-*-*"] } {
1801 return 1
1802 }
1803 if { [istarget "m6812-*-*"] } {
1804 return 1
1805 }
1806 return 0
1807 }
1811 proc skip_stl_tests {} {
1816 }
1819 }
1823 proc skip_fortran_tests {} {
1824 return 0
1825 }
1827 # Return a 1 if I don't even want to try to test ada.
1829 proc skip_ada_tests {} {
1831 }
1835 proc skip_go_tests {} {
1836 return 0
1837 }
1839 # Return a 1 if I don't even want to try to test D.
1841 proc skip_d_tests {} {
1843 }
1846 proc skip_rust_tests {} {
1848 }
1851 # PROMPT_REGEXP is the expected prompt.
1854 global gdb_py_is_py3k
1856 gdb_test_multiple "python print ('test')" "verify python support" {
1858 unsupported "Python support is disabled."
1860 }
1862 }
1864 gdb_test_multiple "python print (sys.version_info\[0\])" "check if python 3" {
1867 }
1870 }
1871 }
1874 }
1877 # Note: This also sets various globals that specify which version of Python
1878 # is in use. See skip_python_tests_prompt.
1880 proc skip_python_tests {} {
1881 global gdb_prompt
1883 }
1887 proc skip_shlib_tests {} {
1888 # Run the shared library tests on native systems.
1891 }
1893 # An abbreviated list of remote targets where we should be able to
1894 # run shared library tests.
1903 }
1906 }
1910 proc skip_tui_tests {} {
1911 global gdb_prompt
1913 gdb_test_multiple "help layout" "verify tui support" {
1916 }
1918 }
1919 }
1922 }
1924 # Test files shall make sure all the test result lines in gdb.sum are
1925 # unique in a test run, so that comparing the gdb.sum files of two
1926 # test runs gives correct results. Test files that exercise
1927 # variations of the same tests more than once, shall prefix the
1928 # different test invocations with different identifying strings in
1929 # order to make them unique.
1930 #
1931 # About test prefixes:
1932 #
1935 # underlined substring in
1936 #
1938 # ^^^^^^^^^^^^^^^^^^^^
1939 #
1940 # is $pf_prefix.
1941 #
1942 # The easiest way to adjust the test prefix is to append a test
1943 # variation prefix to the $pf_prefix, using the with_test_prefix
1944 # procedure. E.g.,
1945 #
1946 # proc do_tests {} {
1947 # gdb_test ... ... "test foo"
1948 # gdb_test ... ... "test bar"
1949 #
1950 # with_test_prefix "subvariation a" {
1951 # gdb_test ... ... "test x"
1952 # }
1953 #
1954 # with_test_prefix "subvariation b" {
1955 # gdb_test ... ... "test x"
1956 # }
1957 # }
1958 #
1959 # with_test_prefix "variation1" {
1961 # do_tests
1962 # }
1963 #
1964 # with_test_prefix "variation2" {
1966 # do_tests
1967 # }
1968 #
1969 # Results in:
1970 #
1979 #
1981 # manipulate the pf_prefix global directly, treating it as a string.
1982 # E.g.,
1983 #
1984 # global pf_prefix
1985 # set saved_pf_prefix
1986 # append pf_prefix "${foo}: bar"
1987 # ... actual tests ...
1988 # set pf_prefix $saved_pf_prefix
1989 #
1993 # Returns the result of BODY.
1994 #
1996 global pf_prefix
1998 set saved $pf_prefix
1999 append pf_prefix " " $prefix ":"
2001 set pf_prefix $saved
2004 global errorInfo errorCode
2008 }
2009 }
2012 # including the iterator's name and current value in the prefix.
2014 proc foreach_with_prefix {var list body} {
2015 upvar 1 $var myvar
2016 foreach myvar $list {
2017 with_test_prefix "$var=$myvar" {
2018 uplevel 1 $body
2019 }
2020 }
2021 }
2024 # within 'with_test_prefix "$proc_name" { ... }'.
2026 # Define the advertised proc.
2028 }
2032 # listed in VARS will be reset to the values they had before BODY was run.
2033 #
2034 # This is useful for providing a scope in which it is safe to temporarily
2035 # modify global variables, e.g.
2036 #
2037 # global INTERNAL_GDBFLAGS
2038 # global env
2039 #
2040 # set foo GDBHISTSIZE
2041 #
2043 # append INTERNAL_GDBFLAGS " -nx"
2045 # gdb_start
2046 # gdb_test ...
2047 # }
2048 #
2050 # modified inside BODY, this proc guarantees that the modifications will be
2051 # undone after BODY finishes executing.
2058 foreach var $vars {
2068 }
2070 lappend unset_vars $var
2071 }
2072 }
2078 }
2083 }
2085 foreach var $unset_vars {
2087 }
2090 global errorInfo errorCode
2094 }
2095 }
2099 # result of BODY.
2100 #
2101 # This procedure doesn't check if DIR is a valid directory, so you
2102 # have to make sure of that.
2104 proc with_cwd { dir body } {
2105 set saved_dir [pwd]
2106 verbose -log "Switching to directory $dir (saved CWD: $saved_dir)."
2107 cd $dir
2109 set code [catch {uplevel 1 $body} result]
2111 verbose -log "Switching back to $saved_dir."
2112 cd $saved_dir
2114 if {$code == 1} {
2115 global errorInfo errorCode
2116 return -code $code -errorinfo $errorInfo -errorcode $errorCode $result
2117 } else {
2118 return -code $code $result
2119 }
2120 }
2122 # Run tests in BODY with GDB prompt and variable $gdb_prompt set to
2123 # PROMPT. When BODY is finished, restore GDB prompt and variable
2124 # $gdb_prompt.
2125 # Returns the result of BODY.
2126 #
2127 # Notes:
2128 #
2129 # 1) If you want to use, for example, "(foo)" as the prompt you must pass it
2131 # TCL). PROMPT is internally converted to a suitable regexp for matching.
2132 # We do the conversion from "(foo)" to "\(foo\)" here for a few reasons:
2138 #
2142 global gdb_prompt
2145 # We don't use string_to_regexp because while it works today it's not
2146 # clear it will work tomorrow: the value we need must work as both a
2148 # we start recording both forms separately instead of just $gdb_prompt.
2149 # The testsuite is pretty-much hardwired to interpret $gdb_prompt as the
2150 # regexp form.
2153 set saved $gdb_prompt
2156 set gdb_prompt $prompt
2157 gdb_test_no_output "set prompt $prompt " ""
2162 set gdb_prompt $saved
2163 gdb_test_no_output "set prompt $saved " ""
2166 global errorInfo errorCode
2170 }
2171 }
2177 global gdb_prompt
2180 gdb_test_multiple "show target-charset" "" {
2183 }
2186 }
2188 fail "get target-charset"
2189 }
2190 }
2192 gdb_test_no_output "set target-charset $target_charset" ""
2196 gdb_test_no_output "set target-charset $saved" ""
2199 global errorInfo errorCode
2203 }
2204 }
2207 # mi_gdb_test etc. default to using it.
2210 global gdb_spawn_id
2211 global board board_info
2213 set gdb_spawn_id $spawn_id
2216 }
2218 # Clear the default spawn id.
2220 proc clear_gdb_spawn_id {} {
2221 global gdb_spawn_id
2222 global board board_info
2224 unset -nocomplain gdb_spawn_id
2227 }
2229 # Run BODY with SPAWN_ID as current spawn id.
2232 global gdb_spawn_id
2235 set saved_spawn_id $gdb_spawn_id
2236 }
2238 switch_gdb_spawn_id $spawn_id
2243 switch_gdb_spawn_id $saved_spawn_id
2245 clear_gdb_spawn_id
2246 }
2249 global errorInfo errorCode
2253 }
2254 }
2261 proc get_largest_timeout {} {
2262 upvar #0 timeout gtimeout
2263 upvar 2 timeout timeout
2267 set tmt $timeout
2268 }
2270 set tmt $gtimeout
2271 }
2275 }
2277 # Eeeeew.
2279 }
2281 return $tmt
2282 }
2284 # Run tests in BODY with timeout increased by factor of FACTOR. When
2285 # BODY is finished, restore timeout.
2288 global timeout
2290 set savedtimeout $timeout
2295 set timeout $savedtimeout
2297 global errorInfo errorCode
2301 }
2302 }
2306 gdb_caching_proc support_complex_tests {
2310 # supported.
2312 }
2318 _Complex float cf;
2319 _Complex double cd;
2320 _Complex long double cld;
2322 }
2324 }
2329 proc supports_get_siginfo_type {} {
2334 }
2335 }
2339 proc can_hardware_single_step {} {
2345 }
2348 }
2353 proc can_single_step_to_signal_handler {} {
2354 # Targets don't have hardware single step. On these targets, when
2355 # a signal is delivered during software single step, gdb is unable
2356 # to determine the next instruction addresses, because start of signal
2357 # handler is one of them.
2358 return [can_hardware_single_step]
2359 }
2361 # Return 1 if target supports process record, otherwise return 0.
2363 proc supports_process_record {} {
2365 if [target_info exists gdb,use_precord] {
2366 return [target_info gdb,use_precord]
2367 }
2369 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2370 || [istarget "i\[34567\]86-*-linux*"]
2371 || [istarget "aarch64*-*-linux*"]
2372 || [istarget "powerpc*-*-linux*"]
2373 || [istarget "s390*-*-linux*"] } {
2374 return 1
2375 }
2377 return 0
2378 }
2380 # Return 1 if target supports reverse debugging, otherwise return 0.
2382 proc supports_reverse {} {
2384 if [target_info exists gdb,can_reverse] {
2385 return [target_info gdb,can_reverse]
2386 }
2388 if { [istarget "arm*-*-linux*"] || [istarget "x86_64-*-linux*"]
2389 || [istarget "i\[34567\]86-*-linux*"]
2390 || [istarget "aarch64*-*-linux*"]
2391 || [istarget "powerpc*-*-linux*"]
2392 || [istarget "s390*-*-linux*"] } {
2393 return 1
2394 }
2396 return 0
2397 }
2399 # Return 1 if readline library is used.
2401 proc readline_is_used { } {
2402 global gdb_prompt
2404 gdb_test_multiple "show editing" "" {
2405 -re ".*Editing of command lines as they are typed is on\..*$gdb_prompt $" {
2406 return 1
2407 }
2408 -re ".*$gdb_prompt $" {
2409 return 0
2410 }
2411 }
2412 }
2414 # Return 1 if target is ELF.
2415 gdb_caching_proc is_elf_target {
2416 set me "is_elf_target"
2418 set src { int foo () {return 0;} }
2419 if {![gdb_simple_compile elf_target $src]} {
2420 return 0
2421 }
2423 set fp_obj [open $obj "r"]
2424 fconfigure $fp_obj -translation binary
2425 set data [read $fp_obj]
2426 close $fp_obj
2428 file delete $obj
2432 if {[string compare -length 4 $data $ELFMAG] != 0} {
2433 verbose "$me: returning 0" 2
2434 return 0
2435 }
2437 verbose "$me: returning 1" 2
2438 return 1
2439 }
2441 # Return 1 if the memory at address zero is readable.
2443 gdb_caching_proc is_address_zero_readable {
2444 global gdb_prompt
2446 set ret 0
2447 gdb_test_multiple "x 0" "" {
2448 -re "Cannot access memory at address 0x0.*$gdb_prompt $" {
2449 set ret 0
2450 }
2451 -re ".*$gdb_prompt $" {
2452 set ret 1
2453 }
2454 }
2456 return $ret
2457 }
2459 # Produce source file NAME and write SOURCES into it.
2461 proc gdb_produce_source { name sources } {
2462 set index 0
2463 set f [open $name "w"]
2465 puts $f $sources
2466 close $f
2467 }
2469 # Return 1 if target is ILP32.
2470 # This cannot be decided simply from looking at the target string,
2471 # as it might depend on externally passed compiler options like -m64.
2472 gdb_caching_proc is_ilp32_target {
2473 return [gdb_can_simple_compile is_ilp32_target {
2474 int dummy[sizeof (int) == 4
2475 && sizeof (void *) == 4
2476 && sizeof (long) == 4 ? 1 : -1];
2477 }]
2478 }
2480 # Return 1 if target is LP64.
2481 # This cannot be decided simply from looking at the target string,
2482 # as it might depend on externally passed compiler options like -m64.
2483 gdb_caching_proc is_lp64_target {
2484 return [gdb_can_simple_compile is_lp64_target {
2485 int dummy[sizeof (int) == 4
2486 && sizeof (void *) == 8
2487 && sizeof (long) == 8 ? 1 : -1];
2488 }]
2489 }
2491 # Return 1 if target has 64 bit addresses.
2492 # This cannot be decided simply from looking at the target string,
2493 # as it might depend on externally passed compiler options like -m64.
2494 gdb_caching_proc is_64_target {
2495 return [gdb_can_simple_compile is_64_target {
2496 int function(void) { return 3; }
2497 int dummy[sizeof (&function) == 8 ? 1 : -1];
2498 }]
2499 }
2501 # Return 1 if target has x86_64 registers - either amd64 or x32.
2502 # x32 target identifies as x86_64-*-linux*, therefore it cannot be determined
2503 # just from the target string.
2504 gdb_caching_proc is_amd64_regs_target {
2505 if {![istarget "x86_64-*-*"] && ![istarget "i?86-*"]} {
2506 return 0
2507 }
2509 return [gdb_can_simple_compile is_amd64_regs_target {
2510 int main (void) {
2511 asm ("incq %rax");
2512 asm ("incq %r15");
2514 return 0;
2515 }
2516 }]
2517 }
2519 # Return 1 if this target is an x86 or x86-64 with -m32.
2520 proc is_x86_like_target {} {
2521 if {![istarget "x86_64-*-*"] && ![istarget i?86-*]} {
2522 return 0
2523 }
2524 return [expr [is_ilp32_target] && ![is_amd64_regs_target]]
2525 }
2527 # Return 1 if this target is an arm or aarch32 on aarch64.
2529 gdb_caching_proc is_aarch32_target {
2530 if { [istarget "arm*-*-*"] } {
2531 return 1
2532 }
2534 if { ![istarget "aarch64*-*-*"] } {
2535 return 0
2536 }
2538 set list {}
2539 foreach reg \
2540 {r0 r1 r2 r3} {
2542 }
2545 }
2547 # Return 1 if this target is an aarch64, either lp64 or ilp32.
2549 proc is_aarch64_target {} {
2550 if { ![istarget "aarch64*-*-*"] } {
2551 return 0
2552 }
2554 return [expr ![is_aarch32_target]]
2555 }
2557 # Return 1 if displaced stepping is supported on target, otherwise, return 0.
2558 proc support_displaced_stepping {} {
2560 if { [istarget "x86_64-*-linux*"] || [istarget "i\[34567\]86-*-linux*"]
2561 || [istarget "arm*-*-linux*"] || [istarget "powerpc-*-linux*"]
2562 || [istarget "powerpc64-*-linux*"] || [istarget "s390*-*-*"]
2563 || [istarget "aarch64*-*-linux*"] } {
2564 return 1
2565 }
2567 return 0
2568 }
2570 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2573 gdb_caching_proc skip_altivec_tests {
2574 global srcdir subdir gdb_prompt inferior_exited_re
2576 set me "skip_altivec_tests"
2578 # Some simulators are known to not support VMX instructions.
2579 if { [istarget powerpc-*-eabi] || [istarget powerpc*-*-eabispe] } {
2580 verbose "$me: target known to not support VMX, returning 1" 2
2581 return 1
2582 }
2584 # Make sure we have a compiler that understands altivec.
2585 if [get_compiler_info] {
2586 warning "Could not get compiler info"
2587 return 1
2588 }
2589 if [test_compiler_info gcc*] {
2590 set compile_flags "additional_flags=-maltivec"
2591 } elseif [test_compiler_info xlc*] {
2592 set compile_flags "additional_flags=-qaltivec"
2593 } else {
2594 verbose "Could not compile with altivec support, returning 1" 2
2595 return 1
2596 }
2598 # Compile a test program containing VMX instructions.
2599 set src {
2600 int main() {
2601 #ifdef __MACH__
2602 asm volatile ("vor v0,v0,v0");
2603 #else
2604 asm volatile ("vor 0,0,0");
2605 #endif
2606 return 0;
2607 }
2608 }
2609 if {![gdb_simple_compile $me $src executable $compile_flags]} {
2610 return 1
2611 }
2613 # Compilation succeeded so now run it via gdb.
2615 gdb_exit
2616 gdb_start
2617 gdb_reinitialize_dir $srcdir/$subdir
2618 gdb_load "$obj"
2619 gdb_run_cmd
2620 gdb_expect {
2621 -re ".*Illegal instruction.*${gdb_prompt} $" {
2623 set skip_vmx_tests 1
2624 }
2625 -re ".*$inferior_exited_re normally.*${gdb_prompt} $" {
2627 set skip_vmx_tests 0
2628 }
2629 default {
2631 set skip_vmx_tests 1
2632 }
2633 }
2634 gdb_exit
2635 remote_file build delete $obj
2637 verbose "$me: returning $skip_vmx_tests" 2
2638 return $skip_vmx_tests
2639 }
2641 # Run a test on the target to see if it supports vmx hardware. Return 0 if so,
2644 gdb_caching_proc skip_vsx_tests {
2645 global srcdir subdir gdb_prompt inferior_exited_re
2647 set me "skip_vsx_tests"
2649 # Some simulators are known to not support Altivec instructions, so
2650 # they won't support VSX instructions as well.
2652 verbose "$me: target known to not support VSX, returning 1" 2
2654 }
2656 # Make sure we have a compiler that understands altivec.
2658 warning "Could not get compiler info"
2660 }
2666 verbose "Could not compile with vsx support, returning 1" 2
2668 }
2674 #ifdef __MACH__
2676 #else
2678 #endif
2680 }
2681 }
2684 }
2686 # No error message, compilation succeeded so now run it via gdb.
2688 gdb_exit
2689 gdb_start
2690 gdb_reinitialize_dir $srcdir/$subdir
2691 gdb_load "$obj"
2692 gdb_run_cmd
2693 gdb_expect {
2697 }
2701 }
2702 default {
2703 warning "\n$me: default case taken"
2705 }
2706 }
2707 gdb_exit
2710 verbose "$me: returning $skip_vsx_tests" 2
2711 return $skip_vsx_tests
2712 }
2717 gdb_caching_proc skip_tsx_tests {
2718 global srcdir subdir gdb_prompt inferior_exited_re
2729 }
2730 }
2733 }
2735 # No error message, compilation succeeded so now run it via gdb.
2737 gdb_exit
2738 gdb_start
2739 gdb_reinitialize_dir $srcdir/$subdir
2740 gdb_load "$obj"
2741 gdb_run_cmd
2742 gdb_expect {
2746 }
2750 }
2751 default {
2752 warning "\n$me: default case taken."
2754 }
2755 }
2756 gdb_exit
2759 verbose "$me: returning $skip_tsx_tests" 2
2760 return $skip_tsx_tests
2761 }
2766 gdb_caching_proc skip_btrace_tests {
2767 global srcdir subdir gdb_prompt inferior_exited_re
2771 verbose "$me: target does not support btrace, returning 1" 2
2773 }
2779 }
2781 # No error message, compilation succeeded so now run it via gdb.
2783 gdb_exit
2784 gdb_start
2785 gdb_reinitialize_dir $srcdir/$subdir
2786 gdb_load $obj
2789 }
2792 gdb_test_multiple "record btrace" "check btrace support" {
2795 }
2798 }
2801 }
2804 }
2805 }
2806 gdb_exit
2809 verbose "$me: returning $skip_btrace_tests" 2
2810 return $skip_btrace_tests
2811 }
2815 # from the GCC testsuite.
2817 gdb_caching_proc skip_btrace_pt_tests {
2818 global srcdir subdir gdb_prompt inferior_exited_re
2822 verbose "$me: target does not support btrace, returning 1" 2
2824 }
2830 }
2832 # No error message, compilation succeeded so now run it via gdb.
2834 gdb_exit
2835 gdb_start
2836 gdb_reinitialize_dir $srcdir/$subdir
2837 gdb_load $obj
2840 }
2843 gdb_test_multiple "record btrace pt" "check btrace pt support" {
2846 }
2849 }
2852 }
2855 }
2858 }
2859 }
2860 gdb_exit
2863 verbose "$me: returning $skip_btrace_tests" 2
2864 return $skip_btrace_tests
2865 }
2870 gdb_caching_proc skip_aarch64_sve_tests {
2871 global srcdir subdir gdb_prompt inferior_exited_re
2877 }
2886 }
2887 }
2890 }
2892 # Compilation succeeded so now run it via gdb.
2893 clean_restart $obj
2894 gdb_run_cmd
2895 gdb_expect {
2899 }
2903 }
2904 default {
2905 warning "\n$me: default case taken"
2907 }
2908 }
2909 gdb_exit
2912 verbose "$me: returning $skip_sve_tests" 2
2913 return $skip_sve_tests
2914 }
2917 # A helper that compiles a test case to see if __int128 is supported.
2920 __int128 x;
2923 }
2926 gdb_caching_proc has_int128_c {
2928 }
2931 gdb_caching_proc has_int128_cxx {
2933 }
2936 gdb_caching_proc skip_ifunc_tests {
2938 extern void f_ ();
2946 }
2947 }
2950 # backtraces. Requires get_compiler_info and get_debug_format.
2952 proc skip_inline_frame_tests {} {
2956 }
2963 }
2966 }
2969 # inlined functions. Requires get_compiler_info and get_debug_format.
2971 proc skip_inline_var_tests {} {
2975 }
2978 }
2982 proc skip_hw_breakpoint_tests {} {
2984 # disables both watchpoints and breakpoints)
2987 }
2989 # These targets support hardware breakpoints natively
2997 }
3000 }
3004 proc skip_hw_watchpoint_tests {} {
3005 # Skip tests if requested by the board
3008 }
3010 # These targets support hardware watchpoints natively
3019 }
3022 }
3025 # watchpoints to be active at the same time
3027 proc skip_hw_watchpoint_multi_tests {} {
3030 }
3032 # These targets support just a single hardware watchpoint
3036 }
3039 }
3043 proc skip_hw_watchpoint_access_tests {} {
3046 }
3048 # These targets support just write watchpoints
3051 }
3054 }
3058 # libraries have been loaded. This is needed because otherwise a
3059 # shared libgcc won't be visible.
3061 proc skip_unwinder_tests {} {
3062 global gdb_prompt
3064 set ok 0
3065 gdb_test_multiple "print _Unwind_DebugHook" "check for unwinder hook" {
3067 }
3069 set ok 1
3070 }
3072 }
3073 }
3074 if {!$ok} {
3075 gdb_test_multiple "info probe" "check for stap probe in unwinder" {
3077 set ok 1
3078 }
3080 }
3081 }
3082 }
3083 return $ok
3084 }
3086 # Return 0 if we should skip tests that require the libstdc++ stap
3087 # probes. This must be invoked while gdb is running, after shared
3088 # libraries have been loaded.
3090 proc skip_libstdcxx_probe_tests {} {
3091 global gdb_prompt
3093 set ok 0
3094 gdb_test_multiple "info probe" "check for stap probe in libstdc++" {
3096 set ok 1
3097 }
3099 }
3100 }
3101 return $ok
3102 }
3104 # Return 1 if we should skip tests of the "compile" feature.
3105 # This must be invoked after the inferior has been started.
3107 proc skip_compile_feature_tests {} {
3108 global gdb_prompt
3110 set result 0
3111 gdb_test_multiple "compile code -- ;" "check for working compile command" {
3113 set result 1
3114 }
3116 set result 1
3117 }
3119 }
3120 }
3121 return $result
3122 }
3124 # Helper for gdb_is_target_* procs. TARGET_NAME is the name of the target
3126 # is a regexp that will match the output of "maint print target-stack" if
3127 # the target in question is currently pushed. PROMPT_REGEXP is a regexp
3128 # matching the expected prompt after the command output.
3132 gdb_test_multiple "maint print target-stack" $test {
3134 pass $test
3136 }
3138 pass $test
3139 }
3140 }
3142 }
3147 return [gdb_is_target_1 "remote" ".*emote serial target in gdb-specific protocol.*" $prompt_regexp]
3148 }
3150 # Check whether we're testing with the remote or extended-remote
3151 # targets.
3153 proc gdb_is_target_remote { } {
3154 global gdb_prompt
3156 return [gdb_is_target_remote_prompt "$gdb_prompt $"]
3157 }
3159 # Check whether we're testing with the native target.
3161 proc gdb_is_target_native { } {
3162 global gdb_prompt
3165 }
3167 # Return the effective value of use_gdb_stub.
3168 #
3171 # property from the board file.
3172 #
3173 # This is the preferred way of checking use_gdb_stub, since it allows to check
3174 # the value before the gdb has been spawned and it will return the correct value
3175 # even when it was overriden by the test.
3177 proc use_gdb_stub {} {
3178 global use_gdb_stub
3181 return $use_gdb_stub
3182 }
3185 }
3190 gdb_caching_proc target_is_gdbserver {
3191 global gdb_prompt
3193 set is_gdbserver -1
3194 set test "probing for GDBserver"
3196 gdb_test_multiple "monitor help" $test {
3197 -re "The following monitor commands are supported.*Quit GDBserver.*$gdb_prompt $" {
3198 set is_gdbserver 1
3199 }
3200 -re "$gdb_prompt $" {
3201 set is_gdbserver 0
3202 }
3203 }
3205 if { $is_gdbserver == -1 } {
3206 verbose -log "Unable to tell whether we are using GDBserver or not."
3207 }
3209 return $is_gdbserver
3210 }
3212 # N.B. compiler_info is intended to be local to this file.
3213 # Call test_compiler_info with no arguments to fetch its value.
3215 # but that's the current API.
3216 if [info exists compiler_info] {
3217 unset compiler_info
3218 }
3220 set gcc_compiled 0
3222 # Figure out what compiler I am using.
3223 # The result is cached so only the first invocation runs the compiler.
3224 #
3225 # ARG can be empty or "C++". If empty, "C" is assumed.
3226 #
3227 # There are several ways to do this, with various problems.
3228 #
3229 # [ gdb_compile -E $ifile -o $binfile.ci ]
3230 # source $binfile.ci
3231 #
3232 # Single Unix Spec v3 says that "-E -o ..." together are not
3233 # specified. And in fact, the native compiler on hp-ux 11 (among
3234 # others) does not work with "-E -o ...". Most targets used to do
3235 # this, and it mostly worked, because it works with gcc.
3236 #
3237 # [ catch "exec $compiler -E $ifile > $binfile.ci" exec_output ]
3238 # source $binfile.ci
3239 #
3240 # This avoids the problem with -E and -o together. This almost works
3241 # if the build machine is the same as the host machine, which is
3242 # usually true of the targets which are not gcc. But this code does
3243 # not figure which compiler to call, and it always ends up using the C
3244 # compiler. Not good for setting hp_aCC_compiler. Target
3245 # hppa*-*-hpux* used to do this.
3246 #
3247 # [ gdb_compile -E $ifile > $binfile.ci ]
3248 # source $binfile.ci
3249 #
3250 # dejagnu target_compile says that it supports output redirection,
3251 # but the code is completely different from the normal path and I
3253 # this.
3254 #
3255 # set cppout [ gdb_compile $ifile "" preprocess $args quiet ]
3256 # eval $cppout
3257 #
3258 # I actually do this for all targets now. gdb_compile runs the right
3259 # compiler, and TCL captures the output, and I eval the output.
3260 #
3261 # Unfortunately, expect logs the output of the command as it goes by,
3262 # and dejagnu helpfully prints a second copy of it right afterwards.
3263 # So I turn off expect logging for a moment.
3264 #
3265 # [ gdb_compile $ifile $ciexe_file executable $args ]
3266 # [ remote_exec $ciexe_file ]
3267 # [ source $ci_file.out ]
3268 #
3269 # I could give up on -E and just do this.
3271 #
3275 # For compiler.c and compiler.cc
3276 global srcdir
3278 # I am going to play with the log to keep noise out.
3279 global outdir
3280 global tool
3282 # These come from compiler.c or compiler.cc
3283 global compiler_info
3285 # Legacy global data symbols.
3286 global gcc_compiled
3289 # Already computed.
3291 }
3293 # Choose which file to preprocess.
3297 }
3299 # Run $ifile through the right preprocessor.
3302 log_file
3305 # above, because of how DejaGnu handles remote host testing.
3307 gdb_compile "${ifile}" "$ppout" preprocess [list "$arg" quiet getting_compiler_info]
3310 close $file
3313 }
3314 eval log_file $saved_log
3316 # Eval the output.
3320 # line marker
3322 # blank line
3324 # eval this line
3325 verbose "get_compiler_info: $cppline" 2
3326 eval "$cppline"
3328 # unknown line
3331 }
3332 }
3335 if ![info exists compiler_info] {
3336 verbose -log "get_compiler_info: compiler_info not provided"
3337 set compiler_info "unknown"
3338 }
3339 # Also set to unknown compiler if any diagnostics happened.
3340 if { $unknown } {
3341 verbose -log "get_compiler_info: got unexpected diagnostics"
3342 set compiler_info "unknown"
3343 }
3345 # Set the legacy symbols.
3346 set gcc_compiled 0
3347 regexp "^gcc-(\[0-9\]+)-" "$compiler_info" matchall gcc_compiled
3349 # Log what happened.
3350 verbose -log "get_compiler_info: $compiler_info"
3352 # Most compilers will evaluate comparisons and other boolean
3353 # operations to 0 or 1.
3354 uplevel \#0 { set true 1 }
3355 uplevel \#0 { set false 0 }
3357 return 0
3358 }
3360 # Return the compiler_info string if no arg is provided.
3361 # Otherwise the argument is a glob-style expression to match against
3362 # compiler_info.
3364 proc test_compiler_info { {compiler ""} } {
3365 global compiler_info
3366 get_compiler_info
3368 # If no arg, return the compiler_info string.
3369 if [string match "" $compiler] {
3370 return $compiler_info
3371 }
3373 return [string match $compiler $compiler_info]
3374 }
3376 proc current_target_name { } {
3377 global target_info
3378 if [info exists target_info(target,name)] {
3379 set answer $target_info(target,name)
3380 } else {
3381 set answer ""
3382 }
3383 return $answer
3384 }
3386 set gdb_wrapper_initialized 0
3387 set gdb_wrapper_target ""
3389 proc gdb_wrapper_init { args } {
3390 global gdb_wrapper_initialized
3391 global gdb_wrapper_file
3392 global gdb_wrapper_flags
3393 global gdb_wrapper_target
3395 if { $gdb_wrapper_initialized == 1 } { return; }
3397 if {[target_info exists needs_status_wrapper] && \
3398 [target_info needs_status_wrapper] != "0"} {
3399 set result [build_wrapper "testglue.o"]
3400 if { $result != "" } {
3401 set gdb_wrapper_file [lindex $result 0]
3402 set gdb_wrapper_flags [lindex $result 1]
3403 } else {
3404 warning "Status wrapper failed to build."
3405 }
3406 }
3407 set gdb_wrapper_initialized 1
3408 set gdb_wrapper_target [current_target_name]
3409 }
3411 # Determine options that we always want to pass to the compiler.
3412 gdb_caching_proc universal_compile_options {
3413 set me "universal_compile_options"
3414 set options {}
3416 set src [standard_temp_file ccopts[pid].c]
3417 set obj [standard_temp_file ccopts[pid].o]
3419 gdb_produce_source $src {
3420 int foo(void) { return 0; }
3421 }
3423 # Try an option for disabling colored diagnostics. Some compilers
3424 # yield colored diagnostics by default (when run from a tty) unless
3425 # such an option is specified.
3426 set opt "additional_flags=-fdiagnostics-color=never"
3427 set lines [target_compile $src $obj object [list "quiet" $opt]]
3428 if [string match "" $lines] then {
3429 # Seems to have worked; use the option.
3430 lappend options $opt
3431 }
3432 file delete $src
3433 file delete $obj
3435 verbose "$me: returning $options" 2
3436 return $options
3437 }
3439 # Compile the code in $code to a file based on $name, using the flags
3440 # $compile_flag as well as debug, nowarning and quiet.
3441 # Return 1 if code can be compiled
3442 # Leave the file name of the resulting object in the upvar object.
3444 proc gdb_simple_compile {name code {type object} {compile_flags {}} {object obj}} {
3445 upvar $object obj
3447 switch -regexp -- $type {
3448 "executable" {
3449 set postfix "x"
3450 }
3451 "object" {
3452 set postfix "o"
3453 }
3454 "preprocess" {
3455 set postfix "i"
3456 }
3457 "assembly" {
3458 set postfix "s"
3459 }
3460 }
3461 set src [standard_temp_file $name-[pid].c]
3462 set obj [standard_temp_file $name-[pid].$postfix]
3463 set compile_flags [concat $compile_flags {debug nowarnings quiet}]
3465 gdb_produce_source $src $code
3467 verbose "$name: compiling testfile $src" 2
3468 set lines [gdb_compile $src $obj $type $compile_flags]
3470 file delete $src
3472 if ![string match "" $lines] then {
3473 verbose "$name: compilation failed, returning 0" 2
3474 return 0
3475 }
3476 return 1
3477 }
3479 # Compile the code in $code to a file based on $name, using the flags
3480 # $compile_flag as well as debug, nowarning and quiet.
3481 # Return 1 if code can be compiled
3482 # Delete all created files and objects.
3484 proc gdb_can_simple_compile {name code {type object} {compile_flags ""}} {
3485 set ret [gdb_simple_compile $name $code $type $compile_flags temp_obj]
3486 file delete $temp_obj
3487 return $ret
3488 }
3490 # Some targets need to always link a special object in. Save its path here.
3491 global gdb_saved_set_unbuffered_mode_obj
3492 set gdb_saved_set_unbuffered_mode_obj ""
3494 # Compile source files specified by SOURCE into a binary of type TYPE at path
3496 # parameter and most options are passed directly to it.
3497 #
3498 # The type can be one of the following:
3499 #
3504 #
3505 # The following options are understood and processed by gdb_compile:
3506 #
3508 # quirks to be able to use shared libraries.
3511 # -ldl so that the test can use dlopen.
3515 #
3516 # And here are some of the not too obscure options understood by DejaGnu that
3517 # influence the compilation:
3518 #
3522 # linker flag.
3523 # - ldflags=flag: Add FLAG to the linker flags.
3524 # - incdir=path: Add PATH to the searched include directories.
3525 # - libdir=path: Add PATH to the linker searched directories.
3526 # - ada, c++, f77: Compile the file as Ada, C++ or Fortran.
3527 # - debug: Build with debug information.
3528 # - optimize: Build with optimization.
3530 proc gdb_compile {source dest type options} {
3531 global GDB_TESTCASE_OPTIONS
3532 global gdb_wrapper_file
3533 global gdb_wrapper_flags
3534 global gdb_wrapper_initialized
3535 global srcdir
3536 global objdir
3537 global gdb_saved_set_unbuffered_mode_obj
3539 set outdir [file dirname $dest]
3541 # Add platform-specific options if a shared library was specified using
3542 # "shlib=librarypath" in OPTIONS.
3543 set new_options {}
3544 if {[lsearch -exact $options rust] != -1} {
3545 # -fdiagnostics-color is not a rustcc option.
3546 } else {
3547 set new_options [universal_compile_options]
3548 }
3549 set shlib_found 0
3550 set shlib_load 0
3551 set getting_compiler_info 0
3552 foreach opt $options {
3553 if {[regexp {^shlib=(.*)} $opt dummy_var shlib_name]
3554 && $type == "executable"} {
3555 if [test_compiler_info "xlc-*"] {
3556 # IBM xlc compiler doesn't accept shared library named other
3558 lappend source "-Wl,$shlib_name"
3562 lappend source "${shlib_name}.a"
3564 lappend source $shlib_name
3565 }
3570 lappend new_options "additional_flags=-Wl,--enable-auto-import"
3571 }
3573 # Undo debian's change in the default.
3574 # Put it at the front to not override any user-provided
3575 # value, and to make sure it appears in front of all the
3576 # shlibs!
3577 lappend new_options "early_flags=-Wl,--no-as-needed"
3578 }
3579 }
3580 } elseif { $opt == "shlib_load" && $type == "executable" } {
3581 set shlib_load 1
3582 } elseif { $opt == "getting_compiler_info" } {
3583 # If this is set, calling test_compiler_info will cause recursion.
3584 set getting_compiler_info 1
3585 } else {
3586 lappend new_options $opt
3587 }
3588 }
3590 # Ensure stack protector is disabled for GCC, as this causes problems with
3591 # DWARF line numbering.
3592 # See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88432
3593 # This option defaults to on for Debian/Ubuntu.
3594 if { $getting_compiler_info == 0
3595 && [test_compiler_info {gcc-*-*}]
3596 && !([test_compiler_info {gcc-[0-3]-*}]
3597 || [test_compiler_info {gcc-4-0-*}])
3598 && [lsearch -exact $options rust] == -1} {
3599 # Put it at the front to not override any user-provided value.
3600 lappend new_options "early_flags=-fno-stack-protector"
3601 }
3603 # Because we link with libraries using their basename, we may need
3604 # (depending on the platform) to set a special rpath value, to allow
3605 # the executable to find the libraries it depends on.
3606 if { $shlib_load || $shlib_found } {
3607 if { ([istarget "*-*-mingw*"]
3608 || [istarget *-*-cygwin*]
3609 || [istarget *-*-pe*]) } {
3610 # Do not need anything.
3611 } elseif { [istarget *-*-freebsd*] || [istarget *-*-openbsd*] } {
3612 lappend new_options "ldflags=-Wl,-rpath,${outdir}"
3613 } elseif { [istarget arm*-*-symbianelf*] } {
3614 if { $shlib_load } {
3615 lappend new_options "libs=-ldl"
3616 }
3617 } else {
3618 if { $shlib_load } {
3619 lappend new_options "libs=-ldl"
3620 }
3622 }
3623 }
3624 set options $new_options
3626 if [info exists GDB_TESTCASE_OPTIONS] {
3627 lappend options "additional_flags=$GDB_TESTCASE_OPTIONS"
3628 }
3629 verbose "options are $options"
3630 verbose "source is $source $dest $type $options"
3632 if { $gdb_wrapper_initialized == 0 } { gdb_wrapper_init }
3634 if {[target_info exists needs_status_wrapper] && \
3635 [target_info needs_status_wrapper] != "0" && \
3636 [info exists gdb_wrapper_file]} {
3637 lappend options "libs=${gdb_wrapper_file}"
3638 lappend options "ldflags=${gdb_wrapper_flags}"
3639 }
3641 # Replace the "nowarnings" option with the appropriate additional_flags
3642 # to disable compiler warnings.
3643 set nowarnings [lsearch -exact $options nowarnings]
3644 if {$nowarnings != -1} {
3645 if [target_info exists gdb,nowarnings_flag] {
3646 set flag "additional_flags=[target_info gdb,nowarnings_flag]"
3647 } else {
3648 set flag "additional_flags=-w"
3649 }
3650 set options [lreplace $options $nowarnings $nowarnings $flag]
3651 }
3653 # Replace the "pie" option with the appropriate compiler and linker flags
3654 # to enable PIE executables.
3655 set pie [lsearch -exact $options pie]
3656 if {$pie != -1} {
3657 if [target_info exists gdb,pie_flag] {
3658 set flag "additional_flags=[target_info gdb,pie_flag]"
3659 } else {
3660 # For safety, use fPIE rather than fpie. On AArch64, m68k, PowerPC
3661 # and SPARC, fpie can cause compile errors due to the GOT exceeding
3662 # a maximum size. On other architectures the two flags are
3663 # identical (see the GCC manual). Note Debian9 and Ubuntu16.10
3664 # onwards default GCC to using fPIE. If you do require fpie, then
3665 # it can be set using the pie_flag.
3666 set flag "additional_flags=-fPIE"
3667 }
3668 set options [lreplace $options $pie $pie $flag]
3670 if [target_info exists gdb,pie_ldflag] {
3671 set flag "ldflags=[target_info gdb,pie_ldflag]"
3672 } else {
3673 set flag "ldflags=-pie"
3674 }
3675 lappend options "$flag"
3676 }
3678 # Replace the "nopie" option with the appropriate linker flag to disable
3679 # PIE executables. There are no compiler flags for this option.
3680 set nopie [lsearch -exact $options nopie]
3681 if {$nopie != -1} {
3682 if [target_info exists gdb,nopie_flag] {
3683 set flag "ldflags=[target_info gdb,nopie_flag]"
3684 } else {
3685 set flag "ldflags=-no-pie"
3686 }
3687 set options [lreplace $options $nopie $nopie $flag]
3688 }
3690 if { $type == "executable" } {
3691 if { ([istarget "*-*-mingw*"]
3692 || [istarget "*-*-*djgpp"]
3693 || [istarget "*-*-cygwin*"])} {
3694 # Force output to unbuffered mode, by linking in an object file
3695 # with a global contructor that calls setvbuf.
3696 #
3697 # Compile the special object seperatelly for two reasons:
3698 # 1) Insulate it from $options.
3699 # 2) Avoid compiling it for every gdb_compile invocation,
3700 # which is time consuming, especially if we're remote
3701 # host testing.
3702 #
3704 verbose "compiling gdb_saved_set_unbuffered_obj"
3710 return $result
3711 }
3713 set gdb_saved_set_unbuffered_mode_obj set_unbuffered_mode_saved.o
3716 }
3717 # Link a copy of the output object, because the
3718 # original may be automatically deleted.
3719 remote_download host $unbuf_obj $gdb_saved_set_unbuffered_mode_obj
3721 verbose "gdb_saved_set_unbuffered_obj already compiled"
3722 }
3724 # Rely on the internal knowledge that the global ctors are ran in
3725 # reverse link order. In that case, we can use ldflags to
3726 # avoid copying the object file to the host multiple
3727 # times.
3728 # This object can only be added if standard libraries are
3731 lappend options "ldflags=$gdb_saved_set_unbuffered_mode_obj"
3732 }
3733 }
3734 }
3739 regsub "Creating library file: \[^\r\n\]*\[\r\n\]+" $result "" result
3741 regsub "\[\r\n\]*$" "$result" "" result
3742 regsub "^\[\r\n\]*" "$result" "" result
3746 # changing the entire testsuite in one go.
3748 gdb_compile_test $source $result
3750 clone_output "gdb compile failed, $result"
3751 }
3752 }
3753 return $result
3754 }
3758 # against several different thread libraries, to see which one this
3759 # system has.
3764 # This kind of wipes out whatever libs the caller may have
3765 # set. Or maybe theirs will override ours. How infelicitous.
3769 ".*no posix threads support.*" {
3771 break
3772 }
3773 ".*cannot open -lpthread.*" {
3775 }
3776 ".*Can't find library for -lpthread.*" {
3778 }
3780 pass "successfully compiled posix threads test case"
3782 break
3783 }
3784 }
3785 }
3787 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3789 }
3790 }
3792 # Build a shared library from SOURCES.
3795 set obj_options $options
3800 }
3803 }
3806 "xlc-*" {
3807 lappend obj_options "additional_flags=-qpic"
3808 }
3809 "clang-*" {
3812 lappend obj_options "additional_flags=-fpic"
3813 }
3814 }
3815 "gcc-*" {
3821 lappend obj_options "additional_flags=-fpic"
3822 }
3823 }
3824 "icc-*" {
3825 lappend obj_options "additional_flags=-fpic"
3826 }
3827 default {
3828 # don't know what the compiler is...
3829 }
3830 }
3832 set outdir [file dirname $dest]
3833 set objects ""
3834 foreach source $sources {
3835 set sourcebase [file tail $source]
3836 if {[file extension $source] == ".o"} {
3837 # Already a .o file.
3838 lappend objects $source
3839 } elseif {[gdb_compile $source "${outdir}/${sourcebase}.o" object \
3840 $obj_options] != ""} {
3841 return -1
3842 } else {
3843 lappend objects ${outdir}/${sourcebase}.o
3844 }
3845 }
3847 set link_options $options
3848 if [test_compiler_info "xlc-*"] {
3849 lappend link_options "additional_flags=-qmkshrobj"
3850 } else {
3851 lappend link_options "additional_flags=-shared"
3853 if { ([istarget "*-*-mingw*"]
3854 || [istarget *-*-cygwin*]
3855 || [istarget *-*-pe*]) } {
3856 if { [is_remote host] } {
3857 set name [file tail ${dest}]
3858 } else {
3859 set name ${dest}
3860 }
3861 lappend link_options "additional_flags=-Wl,--out-implib,${name}.a"
3862 } else {
3863 # Set the soname of the library. This causes the linker on ELF
3864 # systems to create the DT_NEEDED entry in the executable referring
3865 # to the soname of the library, and not its absolute path. This
3866 # (using the absolute path) would be problem when testing on a
3867 # remote target.
3868 #
3869 # In conjunction with setting the soname, we add the special
3870 # rpath=$ORIGIN value when building the executable, so that it's
3871 # able to find the library in its own directory.
3873 lappend link_options "additional_flags=-Wl,-soname,$destbase"
3874 }
3875 }
3878 }
3885 remote_file host delete $dest_tail_name.a
3886 }
3889 }
3892 # against several different thread libraries, to see which one this
3893 # system has.
3898 # This kind of wipes out whatever libs the caller may have
3899 # set. Or maybe theirs will override ours. How infelicitous.
3903 ".*no posix threads support.*" {
3905 break
3906 }
3907 ".*cannot open -lpthread.*" {
3909 }
3910 ".*Can't find library for -lpthread.*" {
3912 }
3914 pass "successfully compiled posix threads test case"
3916 break
3917 }
3918 }
3919 }
3921 unsupported "couldn't compile $sources: ${why_msg}"
3923 }
3924 }
3932 # This kind of wipes out whatever libs the caller may have
3933 # set. Or maybe theirs will override ours. How infelicitous.
3936 }
3939 }
3943 ".*no posix threads support.*" {
3945 break
3946 }
3947 ".*cannot open -lpthread.*" {
3949 }
3950 ".*Can't find library for -lpthread.*" {
3952 }
3954 pass "successfully compiled objc with posix threads test case"
3956 break
3957 }
3958 }
3959 }
3961 unsupported "couldn't compile [file tail $source]: ${why_msg}"
3963 }
3964 }
3967 global suppress_flag
3970 }
3972 }
3974 # Send STRING to the inferior's terminal.
3976 proc send_inferior { string } {
3977 global inferior_spawn_id
3979 if {[catch "send -i $inferior_spawn_id -- \$string" errorInfo]} {
3980 return "$errorInfo"
3981 } else {
3982 return ""
3983 }
3984 }
3986 #
3987 #
3989 proc gdb_expect { args } {
3990 if { [llength $args] == 2 && [lindex $args 0] != "-re" } {
3991 set atimeout [lindex $args 0]
3992 set expcode [list [lindex $args 1]]
3993 } else {
3994 set expcode $args
3995 }
3997 # A timeout argument takes precedence, otherwise of all the timeouts
3998 # select the largest.
3999 if [info exists atimeout] {
4000 set tmt $atimeout
4001 } else {
4002 set tmt [get_largest_timeout]
4003 }
4005 global suppress_flag
4006 global remote_suppress_flag
4007 if [info exists remote_suppress_flag] {
4008 set old_val $remote_suppress_flag
4009 }
4010 if [info exists suppress_flag] {
4011 if { $suppress_flag } {
4012 set remote_suppress_flag 1
4013 }
4014 }
4015 set code [catch \
4016 {uplevel remote_expect host $tmt $expcode} string]
4017 if [info exists old_val] {
4018 set remote_suppress_flag $old_val
4019 } else {
4020 if [info exists remote_suppress_flag] {
4021 unset remote_suppress_flag
4022 }
4023 }
4025 if {$code == 1} {
4026 global errorInfo errorCode
4028 return -code error -errorinfo $errorInfo -errorcode $errorCode $string
4029 } else {
4030 return -code $code $string
4031 }
4032 }
4034 # gdb_expect_list TEST SENTINEL LIST -- expect a sequence of outputs
4035 #
4036 # Check for long sequence of output by parts.
4037 # TEST: is the test message to be printed with the test success/fail.
4038 # SENTINEL: Is the terminal pattern indicating that output has finished.
4039 # LIST: is the sequence of outputs to match.
4040 # If the sentinel is recognized early, it is considered an error.
4041 #
4042 # Returns:
4043 # 1 if the test failed,
4044 # 0 if the test passes,
4045 # -1 if there was an internal error.
4047 proc gdb_expect_list {test sentinel list} {
4048 global gdb_prompt
4049 global suppress_flag
4050 set index 0
4051 set ok 1
4052 if { $suppress_flag } {
4053 set ok 0
4054 unresolved "${test}"
4055 }
4056 while { ${index} < [llength ${list}] } {
4057 set pattern [lindex ${list} ${index}]
4058 set index [expr ${index} + 1]
4059 verbose -log "gdb_expect_list pattern: /$pattern/" 2
4060 if { ${index} == [llength ${list}] } {
4061 if { ${ok} } {
4062 gdb_expect {
4063 -re "${pattern}${sentinel}" {
4064 # pass "${test}, pattern ${index} + sentinel"
4065 }
4066 -re "${sentinel}" {
4067 fail "${test} (pattern ${index} + sentinel)"
4068 set ok 0
4069 }
4070 -re ".*A problem internal to GDB has been detected" {
4071 fail "${test} (GDB internal error)"
4072 set ok 0
4073 gdb_internal_error_resync
4074 }
4075 timeout {
4076 fail "${test} (pattern ${index} + sentinel) (timeout)"
4077 set ok 0
4078 }
4079 }
4080 } else {
4081 # unresolved "${test}, pattern ${index} + sentinel"
4082 }
4083 } else {
4084 if { ${ok} } {
4085 gdb_expect {
4086 -re "${pattern}" {
4087 # pass "${test}, pattern ${index}"
4088 }
4089 -re "${sentinel}" {
4090 fail "${test} (pattern ${index})"
4091 set ok 0
4092 }
4093 -re ".*A problem internal to GDB has been detected" {
4094 fail "${test} (GDB internal error)"
4095 set ok 0
4096 gdb_internal_error_resync
4097 }
4098 timeout {
4099 fail "${test} (pattern ${index}) (timeout)"
4100 set ok 0
4101 }
4102 }
4103 } else {
4104 # unresolved "${test}, pattern ${index}"
4105 }
4106 }
4107 }
4108 if { ${ok} } {
4109 pass "${test}"
4110 return 0
4111 } else {
4112 return 1
4113 }
4114 }
4116 #
4117 #
4118 proc gdb_suppress_entire_file { reason } {
4119 global suppress_flag
4122 set suppress_flag -1
4123 }
4125 #
4126 # Set suppress_flag, which will cause all subsequent calls to send_gdb and
4127 # gdb_expect to fail immediately (until the next call to
4128 # gdb_stop_suppressing_tests).
4129 #
4130 proc gdb_suppress_tests { args } {
4131 global suppress_flag
4133 return; # fnf - disable pending review of results where
4134 # testsuite ran better without this
4135 incr suppress_flag
4137 if { $suppress_flag == 1 } {
4138 if { [llength $args] > 0 } {
4140 } else {
4141 warning "Because of previous failure, all subsequent tests in this group will automatically fail.\n"
4142 }
4143 }
4144 }
4146 #
4147 # Clear suppress_flag.
4148 #
4149 proc gdb_stop_suppressing_tests { } {
4150 global suppress_flag
4152 if [info exists suppress_flag] {
4153 if { $suppress_flag > 0 } {
4154 set suppress_flag 0
4156 }
4157 } else {
4158 set suppress_flag 0
4159 }
4160 }
4162 proc gdb_clear_suppressed { } {
4163 global suppress_flag
4165 set suppress_flag 0
4166 }
4168 # Spawn the gdb process.
4169 #
4171 # leaving those to the caller.
4172 #
4173 # Overridable function -- you can override this function in your
4174 # baseboard file.
4176 proc gdb_spawn { } {
4177 default_gdb_spawn
4178 }
4180 # Spawn GDB with CMDLINE_FLAGS appended to the GDBFLAGS global.
4183 global GDBFLAGS
4185 set saved_gdbflags $GDBFLAGS
4188 append GDBFLAGS " "
4189 }
4190 append GDBFLAGS $cmdline_flags
4194 set GDBFLAGS $saved_gdbflags
4196 return $res
4197 }
4201 # Overridable function -- you can override this function in your
4202 # baseboard file.
4204 proc gdb_start { } {
4205 default_gdb_start
4206 }
4208 proc gdb_exit { } {
4209 catch default_gdb_exit
4210 }
4213 # it.
4215 proc can_spawn_for_attach { } {
4217 # back the pid of the program. On remote boards, that would give
4218 # us instead the PID of e.g., the ssh client, etc.
4219 if [is_remote target] then {
4220 return 0
4221 }
4223 # The "attach" command doesn't make sense when the target is
4225 # initial connection.
4228 }
4230 # Assume yes.
4232 }
4234 # Kill a progress previously started with spawn_wait_for_attach, and
4235 # reap its wait status. PROC_SPAWN_ID is the spawn id associated with
4236 # the process.
4242 remote_exec build "kill -9 ${pid}"
4245 catch "close -i $proc_spawn_id"
4251 # something went wrong.) Passing -nowait makes expect tell Tcl to
4252 # wait for the PID in the background. That's fine because we
4253 # don't care about the exit status. */
4254 wait -nowait -i $proc_spawn_id
4255 }
4257 # Returns the process id corresponding to the given spawn id.
4259 proc spawn_id_get_pid { spawn_id } {
4260 set testpid [exp_pid -i $spawn_id]
4262 if { [istarget "*-*-cygwin*"] } {
4263 # testpid is the Cygwin PID, GDB uses the Windows PID, which
4264 # might be different due to the way fork/exec works.
4265 set testpid [ exec ps -e | gawk "{ if (\$1 == $testpid) print \$4; }" ]
4266 }
4268 return $testpid
4269 }
4271 # Start a set of programs running and then wait for a bit, to be sure
4272 # that they can be attached to. Return a list of processes spawn IDs,
4280 # The caller should have checked can_spawn_for_attach itself
4281 # before getting here.
4282 error "can't spawn for attach with this target/board"
4283 }
4288 # allows killing the process by PID without being subject to
4289 # pid-reuse races.
4291 }
4295 return $spawn_id_list
4296 }
4298 #
4302 #
4304 global gdb_prompt
4310 }
4311 send_gdb "load $args\n"
4312 verbose "Timeout is now $loadtimeout seconds" 2
4313 gdb_expect $loadtimeout {
4315 exp_continue
4316 }
4318 exp_continue
4319 }
4321 exp_continue
4322 }
4324 perror "Failed to load program"
4326 }
4329 }
4331 perror "Unexpected reponse from 'load' -- $expect_out(1,string)"
4333 }
4334 timeout {
4335 perror "Timed out trying to load $args."
4337 }
4338 }
4340 }
4342 # Invoke "gcore". CORE is the name of the core file to write. TEST
4345 # this configuration of gdb does not support making core files, it
4350 global gdb_prompt
4353 gdb_test_multiple "gcore $core" $test {
4355 pass $test
4357 }
4358 -re "(?:Can't create a corefile|Target does not support core file generation\\.)\[\r\n\]+$gdb_prompt $" {
4359 unsupported $test
4360 }
4361 }
4363 return $result
4364 }
4368 # Returns:
4374 global gdb_prompt
4376 gdb_test_multiple "core $core" "$test" {
4378 exp_continue
4379 }
4381 fail "$test (bad file format)"
4383 }
4385 fail "$test (file not found)"
4387 }
4389 fail "$test (incomplete note section)"
4391 }
4393 pass "$test"
4395 }
4397 fail "$test"
4399 }
4400 timeout {
4401 fail "$test (timeout)"
4403 }
4404 }
4405 fail "unsupported output from 'core' command"
4407 }
4414 return $libname
4415 }
4419 # this target have separate link and load images.
4422 return $libname
4423 }
4426 # executable. Normally just BINFILE unless it is renamed to something
4427 # else for this target.
4430 return $binfile
4431 }
4434 # executable. Normally just BINFILE unless executables for this target
4435 # have separate files for symbols.
4438 return $binfile
4439 }
4441 # Rename the executable file. Normally this is just BINFILE1 being renamed
4442 # to BINFILE2, but some targets require multiple binary files.
4449 }
4450 }
4452 # "Touch" the executable file to update the date. Normally this is just
4453 # BINFILE, but some targets require multiple files.
4459 }
4460 }
4462 # Like remote_download but provides a gdb-specific behavior.
4463 #
4465 # usual with remote_download to TOFILE on the remote board. The destination
4466 # filename is added to the CLEANFILES global, so it can be cleaned up at the
4467 # end of the test.
4468 #
4470 # through standard_output_file, and FROMFILE is copied there.
4471 #
4473 # FROMFILE.
4479 }
4482 # When the DEST is remote, we simply send the file to DEST.
4483 global cleanfiles
4486 lappend cleanfiles $destname
4488 return $destname
4491 # the executable is).
4492 #
4493 # Note that we pass TOFILE through standard_output_file, regardless of
4495 # to be able to write outside their standard output directory.
4497 set tofile [standard_output_file $tofile]
4499 file copy -force $fromfile $tofile
4501 return $tofile
4502 }
4503 }
4505 # gdb_load_shlib LIB...
4506 #
4507 # Copy the listed library to the target.
4509 proc gdb_load_shlib { file } {
4510 global gdb_spawn_id
4512 if ![info exists gdb_spawn_id] {
4513 perror "gdb_load_shlib: GDB is not running"
4514 }
4516 set dest [gdb_remote_download target [shlib_target_file $file]]
4518 if {[is_remote target]} {
4519 # If the target is remote, we need to tell gdb where to find the
4520 # libraries.
4521 #
4522 # We could set this even when not testing remotely, but a user
4525 gdb_test "set solib-search-path [file dirname $file]" "" ""
4526 }
4528 return $dest
4529 }
4531 #
4532 # gdb_load -- load a file into the debugger. Specifying no file
4533 # defaults to the executable currently being debugged.
4534 # The return value is 0 for success, -1 for failure.
4535 # Many files in config/*.exp override this procedure.
4536 #
4537 proc gdb_load { arg } {
4538 if { $arg != "" } {
4539 return [gdb_file_cmd $arg]
4540 }
4541 return 0
4542 }
4544 # gdb_reload -- load a file into the target. Called before "running",
4545 # either the first time or after already starting the program once,
4546 # for remote targets. Most files that override gdb_load should now
4547 # override this instead.
4549 proc gdb_reload { } {
4550 # For the benefit of existing configurations, default to gdb_load.
4551 # Specifying no file defaults to the executable currently being
4552 # debugged.
4553 return [gdb_load ""]
4554 }
4556 proc gdb_continue { function } {
4557 global decimal
4559 return [gdb_test "continue" ".*Breakpoint $decimal, $function .*" "continue to $function"]
4560 }
4562 proc default_gdb_init { test_file_name } {
4563 global gdb_wrapper_initialized
4564 global gdb_wrapper_target
4565 global gdb_test_file_name
4566 global cleanfiles
4567 global pf_prefix
4569 set cleanfiles {}
4571 gdb_clear_suppressed
4573 set gdb_test_file_name [file rootname [file tail $test_file_name]]
4575 # Make sure that the wrapper is rebuilt
4576 # with the appropriate multilib option.
4577 if { $gdb_wrapper_target != [current_target_name] } {
4578 set gdb_wrapper_initialized 0
4579 }
4581 # Unlike most tests, we have a small number of tests that generate
4582 # a very large amount of output. We therefore increase the expect
4583 # buffer size to be able to contain the entire test output. This
4584 # is especially needed by gdb.base/info-macros.exp.
4585 match_max -d 65536
4586 # Also set this value for the currently running GDB.
4587 match_max [match_max -d]
4589 # We want to add the name of the TCL testcase to the PASS/FAIL messages.
4590 set pf_prefix "[file tail [file dirname $test_file_name]]/[file tail $test_file_name]:"
4592 global gdb_prompt
4593 if [target_info exists gdb_prompt] {
4594 set gdb_prompt [target_info gdb_prompt]
4595 } else {
4597 }
4598 global use_gdb_stub
4599 if [info exists use_gdb_stub] {
4600 unset use_gdb_stub
4601 }
4602 }
4604 # Return a path using GDB_PARALLEL.
4605 # ARGS is a list of path elements to append to "$objdir/$GDB_PARALLEL".
4606 # GDB_PARALLEL must be defined, the caller must check.
4607 #
4608 # The default value for GDB_PARALLEL is, canonically, ".".
4611 # GDB_PARALLEL is written as "yes" for the default case in Makefile.in to mark
4612 # its special handling.
4615 global GDB_PARALLEL objdir
4618 lappend joiner $GDB_PARALLEL
4619 }
4622 }
4624 # Turn BASENAME into a full file name in the standard output
4626 # the directory is returned.
4629 global objdir subdir gdb_test_file_name
4634 }
4639 # Since a particular runtest invocation is only executing a single test
4641 # path of the temp directory.
4645 }
4648 #
4649 # ARGS is a list of source file specifications.
4651 # compute the source file name. The ".c" extension is added in this case.
4652 # If ARGS is not empty, each entry is a source file specification.
4653 # If the specification starts with a ".", it is treated as a suffix
4656 # were ".c".
4657 # Otherwise it is a file name.
4660 #
4661 # Most tests should call this without arguments.
4662 #
4664 # should be handled in the .exp file with a suitable comment.
4667 global gdb_test_file_name
4668 global subdir
4669 global gdb_test_file_last_vars
4671 # Outputs.
4672 global testfile binfile
4674 set testfile $gdb_test_file_name
4678 set args .c
4679 }
4681 # Unset our previous output variables.
4682 # This can help catch hidden bugs.
4684 foreach varname $gdb_test_file_last_vars {
4685 global $varname
4687 }
4688 }
4694 set varname srcfile$suffix
4695 global $varname
4697 # Handle an extension.
4702 }
4705 lappend gdb_test_file_last_vars $varname
4710 incr suffix
4711 }
4712 }
4713 }
4715 # The default timeout used when testing GDB commands. We want to use
4716 # the same timeout as the default dejagnu timeout, unless the user has
4718 global gdb_test_timeout
4720 set gdb_test_timeout $timeout
4721 }
4723 # A list of global variables that GDB testcases should not use.
4724 # We try to prevent their use by monitoring write accesses and raising
4725 # an error when that happens.
4728 # A list of procedures that GDB testcases should not use.
4729 # We try to prevent their use by monitoring invocations and raising
4730 # an error when that happens.
4733 # gdb_init is called by runtest at start, but also by several
4734 # tests directly; gdb_finish is only called from within runtest after
4735 # each test source execution.
4736 # Placing several traces by repetitive calls to gdb_init leads
4739 # if the banned variables and procedures are already traced.
4744 # that changes the timeout value without resetting it cannot affect
4745 # the timeout used in subsequent testcases.
4746 global gdb_test_timeout
4747 global timeout
4748 set timeout $gdb_test_timeout
4753 }
4756 # debugging tool to help confirm that the test suite is
4758 # inotify-tools package to use this.
4759 global GDB_INOTIFY inotify_pid
4761 global outdir tool inotify_log_file
4768 --exclude $exclusion_re \
4775 # we check it.
4776 set fd [open $inotify_log_file w]
4777 close $fd
4778 }
4780 # Block writes to all banned variables, and invocation of all
4781 # banned procedures...
4782 global banned_variables
4783 global banned_procedures
4784 global banned_traced
4785 if (!$banned_traced) {
4786 foreach banned_var $banned_variables {
4787 global "$banned_var"
4788 trace add variable "$banned_var" write error
4789 }
4790 foreach banned_proc $banned_procedures {
4791 global "$banned_proc"
4792 trace add execution "$banned_proc" enter error
4793 }
4794 set banned_traced 1
4795 }
4797 # We set LC_ALL, LC_CTYPE, and LANG to C so that we get the same
4798 # messages as expected.
4799 setenv LC_ALL C
4800 setenv LC_CTYPE C
4801 setenv LANG C
4803 # Don't let a .inputrc file or an existing setting of INPUTRC mess up
4805 # platform, the readline library will use the default setting just by
4806 # failing to open the file. OTOH, opening /dev/null successfully will
4807 # also result in the default settings being used since nothing will be
4808 # read from this file.
4809 setenv INPUTRC "/dev/null"
4811 # This disables style output, which would interfere with many
4812 # tests.
4813 setenv TERM "dumb"
4816 # during startup. See "man expect" for details about stty_init.
4817 global stty_init
4821 # grep. Clear GREP_OPTIONS to make the behavior predictable,
4822 # especially having color output turned on can cause tests to fail.
4823 setenv GREP_OPTIONS ""
4825 # Clear $gdbserver_reconnect_p.
4826 global gdbserver_reconnect_p
4828 unset gdbserver_reconnect_p
4831 }
4833 proc gdb_finish { } {
4834 global gdbserver_reconnect_p
4835 global gdb_prompt
4836 global cleanfiles
4838 # Exit first, so that the files are no longer in use.
4839 gdb_exit
4842 eval remote_file target delete $cleanfiles
4844 }
4846 # Unblock write access to the banned variables. Dejagnu typically
4847 # resets some of them between testcases.
4848 global banned_variables
4849 global banned_procedures
4850 global banned_traced
4852 foreach banned_var $banned_variables {
4853 global "$banned_var"
4855 }
4856 foreach banned_proc $banned_procedures {
4857 global "$banned_proc"
4859 }
4861 }
4862 }
4864 global debug_format
4867 # Run the gdb command "info source" and extract the debugging format
4868 # information from the output and save it in debug_format.
4870 proc get_debug_format { } {
4871 global gdb_prompt
4872 global verbose
4873 global expect_out
4874 global debug_format
4877 send_gdb "info source\n"
4881 verbose "debug format is $debug_format"
4883 }
4885 perror "get_debug_format used when no current source file"
4887 }
4889 warning "couldn't check debug format (no valid response)."
4891 }
4892 timeout {
4893 warning "couldn't check debug format (timeout)."
4895 }
4896 }
4897 }
4902 #
4905 proc test_debug_format {format} {
4906 global debug_format
4908 return [expr [string match $format $debug_format] != 0]
4909 }
4911 # Like setup_xfail, but takes the name of a debug format (DWARF 1,
4912 # COFF, stabs, etc). If that format matches the format that the
4913 # current test was compiled with, then the next test is expected to
4914 # fail for any target. Returns 1 if the next test or set of tests is
4915 # expected to fail, 0 otherwise (or if it is unknown). Must have
4916 # previously called get_debug_format.
4917 proc setup_xfail_format { format } {
4918 set ret [test_debug_format $format]
4920 if {$ret} then {
4921 setup_xfail "*-*-*"
4922 }
4923 return $ret
4924 }
4926 # gdb_get_line_number TEXT [FILE]
4927 #
4928 # Search the source file FILE, and return the line number of the
4929 # first line containing TEXT. If no match is found, an error is thrown.
4930 #
4931 # TEXT is a string literal, not a regular expression.
4932 #
4933 # The default value of FILE is "$srcdir/$subdir/$srcfile". If FILE is
4934 # specified, and does not start with "/", then it is assumed to be in
4935 # "$srcdir/$subdir". This is awkward, and can be fixed in the future,
4936 # by changing the callers and the interface at the same time.
4937 # In particular: gdb.base/break.exp, gdb.base/condbreak.exp,
4938 # gdb.base/ena-dis-br.exp.
4939 #
4940 # Use this function to keep your test scripts independent of the
4942 #
4943 # send_gdb "break 20"
4944 #
4946 # your test could break. Instead, put a comment like this on the
4947 # source file line you want to break at:
4948 #
4949 # /* breakpoint spot: frotz.exp: test name */
4950 #
4951 # and then write, in your test script (which we assume is named
4952 # frotz.exp):
4953 #
4955 #
4956 # (Yes, Tcl knows how to handle the nested quotes and brackets.
4957 # Try this:
4958 # $ tclsh
4959 # % puts "foo [lindex "bar baz" 1]"
4960 # foo baz
4961 # %
4962 # Tcl is quite clever, for a little stringy language.)
4963 #
4964 # ===
4965 #
4966 # The previous implementation of this procedure used the gdb search command.
4967 # This version is different:
4968 #
4969 # . It works with MI, and it also works when gdb is not running.
4970 #
4971 # . It operates on the build machine, not the host machine.
4972 #
4973 # . For now, this implementation fakes a current directory of
4974 # $srcdir/$subdir to be compatible with the old implementation.
4975 # This will go away eventually and some callers will need to
4976 # be changed.
4977 #
4978 # . The TEXT argument is literal text and matches literally,
4979 # not a regular expression as it was before.
4980 #
4981 # . State changes in gdb, such as changing the current file
4982 # and setting $_, no longer happen.
4983 #
4984 # After a bit of time we can forget about the differences from the
4985 # old implementation.
4986 #
4987 # --chastain 2004-08-05
4989 proc gdb_get_line_number { text { file "" } } {
4990 global srcdir
4991 global subdir
4992 global srcfile
4994 if { "$file" == "" } then {
4995 set file "$srcfile"
4996 }
4997 if { ! [regexp "^/" "$file"] } then {
4998 set file "$srcdir/$subdir/$file"
4999 }
5001 if { [ catch { set fd [open "$file"] } message ] } then {
5002 error "$message"
5003 }
5005 set found -1
5006 for { set line 1 } { 1 } { incr line } {
5007 if { [ catch { set nchar [gets "$fd" body] } message ] } then {
5008 error "$message"
5009 }
5010 if { $nchar < 0 } then {
5011 break
5012 }
5013 if { [string first "$text" "$body"] >= 0 } then {
5014 set found $line
5015 break
5016 }
5017 }
5019 if { [ catch { close "$fd" } message ] } then {
5020 error "$message"
5021 }
5023 if {$found == -1} {
5025 }
5027 return $found
5028 }
5030 # Continue the program until it ends.
5031 #
5032 # MSSG is the error message that gets printed. If not given, a
5033 # default is used.
5034 # COMMAND is the command to invoke. If not given, "continue" is
5035 # used.
5036 # ALLOW_EXTRA is a flag indicating whether the test should expect
5037 # extra output between the "Continuing." line and the program
5038 # exiting. By default it is zero; if nonzero, any extra output
5039 # is accepted.
5041 proc gdb_continue_to_end {{mssg ""} {command continue} {allow_extra 0}} {
5042 global inferior_exited_re use_gdb_stub
5044 if {$mssg == ""} {
5045 set text "continue until exit"
5046 } else {
5047 set text "continue until exit at $mssg"
5048 }
5049 if {$allow_extra} {
5050 set extra ".*"
5051 } else {
5052 set extra ""
5053 }
5056 # it's common for exit() to be implemented as a simple infinite
5057 # loop, or a forced crash/reset. For native targets, by default, we
5058 # assume process exit is reported as such. If a non-reliable target
5059 # is used, we set a breakpoint at exit, and continue to that.
5060 if { [target_info exists exit_is_reliable] } {
5061 set exit_is_reliable [target_info exit_is_reliable]
5062 } else {
5063 set exit_is_reliable [expr ! $use_gdb_stub]
5064 }
5066 if { ! $exit_is_reliable } {
5067 if {![gdb_breakpoint "exit"]} {
5068 return 0
5069 }
5070 gdb_test $command "Continuing..*Breakpoint .*exit.*" \
5071 $text
5072 } else {
5073 # Continue until we exit. Should not stop again.
5075 # extremely tough for some remote systems.
5076 gdb_test $command \
5077 "Continuing.\[\r\n0-9\]+${extra}(... EXIT code 0\[\r\n\]+|$inferior_exited_re normally).*"\
5078 $text
5079 }
5080 }
5082 proc rerun_to_main {} {
5083 global gdb_prompt use_gdb_stub
5086 gdb_run_cmd
5087 gdb_expect {
5093 }
5095 send_gdb "run\n"
5096 gdb_expect {
5098 send_gdb "y\n"
5099 exp_continue
5100 }
5106 }
5107 }
5108 }
5118 }
5120 }
5123 # point support or GDB can't fetch the contents from floating point
5124 # registers.
5126 gdb_caching_proc gdb_skip_float_test {
5127 if [target_info exists gdb,skip_float_tests] {
5128 return 1
5129 }
5131 # There is an ARM kernel ptrace bug that hardware VFP registers
5132 # are not updated after GDB ptrace set VFP registers. The bug
5133 # was introduced by kernel commit 8130b9d7b9d858aa04ce67805e8951e3cb6e9b2f
5134 # in 2012 and is fixed in e2dfb4b880146bfd4b6aa8e138c0205407cebbaf
5135 # in May 2016. In other words, kernels older than 4.6.3, 4.4.14,
5136 # 4.1.27, 3.18.36, and 3.14.73 have this bug.
5137 # This kernel bug is detected by check how does GDB change the
5138 # program result by changing one VFP register.
5139 if { [istarget "arm*-*-linux*"] } {
5141 set compile_flags {debug nowarnings }
5143 # Set up, compile, and execute a test program having VFP
5144 # operations.
5145 set src [standard_temp_file arm_vfp[pid].c]
5146 set exe [standard_temp_file arm_vfp[pid].x]
5148 gdb_produce_source $src {
5149 int main() {
5150 double d = 4.0;
5151 int ret;
5153 asm ("vldr d0, [%0]" : : "r" (&d));
5154 asm ("vldr d1, [%0]" : : "r" (&d));
5156 "break_here:");
5166 /* Return $d0 != $d1. */
5167 return ret;
5168 }
5169 }
5171 verbose "compiling testfile $src" 2
5172 set lines [gdb_compile $src $exe executable $compile_flags]
5173 file delete $src
5175 if ![string match "" $lines] then {
5176 verbose "testfile compilation failed, returning 1" 2
5177 return 0
5178 }
5180 # No error message, compilation succeeded so now run it via gdb.
5181 # Run the test up to 5 times to detect whether ptrace can
5182 # correctly update VFP registers or not.
5183 set skip_vfp_test 0
5184 for {set i 0} {$i < 5} {incr i} {
5185 global gdb_prompt srcdir subdir
5187 gdb_exit
5188 gdb_start
5189 gdb_reinitialize_dir $srcdir/$subdir
5190 gdb_load "$exe"
5192 runto_main
5193 gdb_test "break *break_here"
5194 gdb_continue_to_breakpoint "break_here"
5196 # Modify $d0 to a different value, so the exit code should
5197 # be 1.
5198 gdb_test "set \$d0 = 5.0"
5200 set test "continue to exit"
5201 gdb_test_multiple "continue" "$test" {
5202 -re "exited with code 01.*$gdb_prompt $" {
5203 }
5204 -re "exited normally.*$gdb_prompt $" {
5205 # However, the exit code is 0. That means something
5206 # wrong in setting VFP registers.
5207 set skip_vfp_test 1
5208 break
5209 }
5210 }
5211 }
5213 gdb_exit
5214 remote_file build delete $exe
5216 return $skip_vfp_test
5217 }
5218 return 0
5219 }
5221 # Print a message and return true if a test should be skipped
5222 # due to lack of stdio support.
5224 proc gdb_skip_stdio_test { msg } {
5225 if [target_info exists gdb,noinferiorio] {
5227 return 1
5228 }
5229 return 0
5230 }
5232 proc gdb_skip_bogus_test { msg } {
5233 return 0
5234 }
5236 # Return true if a test should be skipped due to lack of XML support
5237 # in the host GDB.
5238 # NOTE: This must be called while gdb is *not* running.
5240 gdb_caching_proc gdb_skip_xml_test {
5241 global gdb_spawn_id
5242 global gdb_prompt
5243 global srcdir
5245 if { [info exists gdb_spawn_id] } {
5246 error "GDB must not be running in gdb_skip_xml_tests."
5247 }
5249 set xml_file [gdb_remote_download host "${srcdir}/gdb.xml/trivial.xml"]
5251 gdb_start
5252 set xml_missing 0
5253 gdb_test_multiple "set tdesc filename $xml_file" "" {
5254 -re ".*XML support was disabled at compile time.*$gdb_prompt $" {
5255 set xml_missing 1
5256 }
5257 -re ".*$gdb_prompt $" { }
5258 }
5259 gdb_exit
5260 return $xml_missing
5261 }
5263 # Return true if argv[0] is available.
5265 gdb_caching_proc gdb_has_argv0 {
5266 set result 0
5268 # Compile and execute a test program to check whether argv[0] is available.
5269 gdb_simple_compile has_argv0 {
5270 int main (int argc, char **argv) {
5271 return 0;
5272 }
5273 } executable
5276 # Helper proc.
5277 proc gdb_has_argv0_1 { exe } {
5278 global srcdir subdir
5279 global gdb_prompt hex
5281 gdb_exit
5282 gdb_start
5283 gdb_reinitialize_dir $srcdir/$subdir
5284 gdb_load "$exe"
5286 # Set breakpoint on main.
5287 gdb_test_multiple "break main" "break main" {
5288 -re "Breakpoint.*${gdb_prompt} $" {
5289 }
5290 -re "${gdb_prompt} $" {
5291 return 0
5292 }
5293 }
5295 # Run to main.
5296 gdb_run_cmd
5297 gdb_test_multiple "" "run to main" {
5298 -re "Breakpoint.*${gdb_prompt} $" {
5299 }
5300 -re "${gdb_prompt} $" {
5301 return 0
5302 }
5303 }
5305 set old_elements "200"
5306 set test "show print elements"
5307 gdb_test_multiple $test $test {
5309 set old_elements $expect_out(1,string)
5310 }
5311 }
5312 set old_repeats "200"
5313 set test "show print repeats"
5314 gdb_test_multiple $test $test {
5316 set old_repeats $expect_out(1,string)
5317 }
5318 }
5319 gdb_test_no_output "set print elements unlimited" ""
5320 gdb_test_no_output "set print repeats unlimited" ""
5322 set retval 0
5323 # Check whether argc is 1.
5324 gdb_test_multiple "p argc" "p argc" {
5327 gdb_test_multiple "p argv\[0\]" "p argv\[0\]" {
5329 set retval 1
5330 }
5331 -re "${gdb_prompt} $" {
5332 }
5333 }
5334 }
5335 -re "${gdb_prompt} $" {
5336 }
5337 }
5339 gdb_test_no_output "set print elements $old_elements" ""
5340 gdb_test_no_output "set print repeats $old_repeats" ""
5342 return $retval
5343 }
5345 set result [gdb_has_argv0_1 $obj]
5347 gdb_exit
5348 file delete $obj
5350 if { !$result
5351 && ([istarget *-*-linux*]
5352 || [istarget *-*-freebsd*] || [istarget *-*-kfreebsd*]
5353 || [istarget *-*-netbsd*] || [istarget *-*-knetbsd*]
5354 || [istarget *-*-openbsd*]
5355 || [istarget *-*-darwin*]
5356 || [istarget *-*-solaris*]
5357 || [istarget *-*-aix*]
5358 || [istarget *-*-gnu*]
5359 || [istarget *-*-cygwin*] || [istarget *-*-mingw32*]
5360 || [istarget *-*-*djgpp*] || [istarget *-*-go32*]
5361 || [istarget *-wince-pe] || [istarget *-*-mingw32ce*]
5362 || [istarget *-*-symbianelf*]
5363 || [istarget *-*-osf*]
5364 || [istarget *-*-dicos*]
5365 || [istarget *-*-nto*]
5366 || [istarget *-*-*vms*]
5367 || [istarget *-*-lynx*178]) } {
5368 fail "argv\[0\] should be available on this target"
5369 }
5371 return $result
5372 }
5374 # Note: the procedure gdb_gnu_strip_debug will produce an executable called
5375 # ${binfile}.dbglnk, which is just like the executable ($binfile) but without
5376 # the debuginfo. Instead $binfile has a .gnu_debuglink section which contains
5377 # the name of a debuginfo only file. This file will be stored in the same
5378 # subdirectory.
5380 # Functions for separate debug info testing
5382 # starting with an executable:
5383 # foo --> original executable
5385 # at the end of the process we have:
5386 # foo.stripped --> foo w/o debug info
5390 # Fetch the build id from the file.
5391 # Returns "" if there is none.
5397 set result [catch {set data [exec $objdump_program -p $filename | grep signature | cut "-d " -f4]} output]
5398 verbose "result is $result"
5399 verbose "output is $output"
5402 }
5403 return $data
5407 set result [catch "exec $objcopy_program -j .note.gnu.build-id -O binary $filename $tmp" output]
5408 verbose "result is $result"
5409 verbose "output is $output"
5412 }
5414 fconfigure $fi -translation binary
5415 # Skip the NOTE header.
5416 read $fi 16
5418 close $fi
5419 file delete $tmp
5422 }
5423 # Convert it to hex.
5424 binary scan $data H* data
5425 return $data
5426 }
5427 }
5436 }
5439 }
5443 # which removes the symbol entry for main from the separate debug file.
5444 #
5450 # Use the first separate debug info file location searched by GDB so the
5451 # run cannot be broken by some stale file searched with higher precedence.
5462 set result [catch "exec $strip_to_file_program --strip-debug ${dest} -o ${stripped_file}" output]
5463 verbose "result is $result"
5464 verbose "output is $output"
5467 }
5475 # This will be in the .debug subdirectory, see above.
5476 set result [catch "exec $strip_to_file_program --only-keep-debug ${dest} -o ${debug_file}" output]
5477 verbose "result is $result"
5478 verbose "output is $output"
5481 }
5484 # file. This is to simulate the behavior of elfutils's eu-strip, which
5486 # objcopy or strip to remove the symbol table without also removing the
5490 verbose "result is $result"
5491 verbose "output is $output"
5494 }
5497 }
5499 # Link the two previous output files together, adding the .gnu_debuglink
5501 # save the new file in dest.
5502 # This will be the regular executable filename, in the usual location.
5503 set result [catch "exec $objcopy_program --add-gnu-debuglink=${debug_file} ${stripped_file} ${dest}" output]
5504 verbose "result is $result"
5505 verbose "output is $output"
5508 }
5516 }
5518 # Test the output of GDB_COMMAND matches the pattern obtained
5519 # by concatenating all elements of EXPECTED_LINES. This makes
5520 # it possible to split otherwise very long string into pieces.
5522 # test to be printed on pass/fail.
5523 proc help_test_raw { gdb_command expected_lines args } {
5524 set message $gdb_command
5525 if [llength $args]>0 then {
5526 set message [lindex $args 0]
5527 }
5528 set expected_output [join $expected_lines ""]
5529 gdb_test "${gdb_command}" "${expected_output}" $message
5530 }
5532 # Test the output of "help COMMAND_CLASS". EXPECTED_INITIAL_LINES
5533 # are regular expressions that should match the beginning of output,
5534 # before the list of commands in that class. The presence of
5535 # command list and standard epilogue will be tested automatically.
5537 # wrapped in {} braces.
5540 "List of commands\:.*[\r\n]+"
5541 "Type \"help\" followed by command name for full documentation\.[\r\n]+"
5542 "Type \"apropos word\" to search for commands related to \"word\"\.[\r\n]+"
5543 "Command name abbreviations are allowed if unambiguous\."
5544 }
5548 }
5552 # element is abbreviation of.
5553 # The command must be a prefix command. EXPECTED_INITIAL_LINES
5554 # are regular expressions that should match the beginning of output,
5555 # before the list of subcommands. The presence of
5556 # subcommand list and standard epilogue will be tested automatically.
5562 set full_command $command
5563 }
5565 # be expanded in this list.
5567 "List of $full_command subcommands\:.*\[\r\n\]+"\
5568 "Type \"help $full_command\" followed by $full_command subcommand name for full documentation\.\[\r\n\]+"\
5569 "Type \"apropos word\" to search for commands related to \"word\"\.\[\r\n\]+"\
5570 "Command name abbreviations are allowed if unambiguous\."]
5573 help_test_raw "help ${command}" $l_entire_body [lindex $args 0]
5575 help_test_raw "help ${command}" $l_entire_body
5576 }
5577 }
5579 # Build executable named EXECUTABLE from specifications that allow
5580 # different options to be passed to different sub-compilations.
5582 # something fails.
5584 # contains the option "pthreads", then gdb_compile_pthreads is used.
5587 # Each SOURCE is compiled to an object file using its OPTIONS,
5588 # using gdb_compile.
5591 global subdir
5592 global srcdir
5599 }
5602 }
5604 set func gdb_compile
5608 }
5611 # parameter. They also requires $sources while gdb_compile and
5612 # gdb_compile_pthreads require $objects. Moreover they ignore any options.
5617 lappend sources_path "$s"
5619 lappend sources_path "$srcdir/$subdir/$s"
5620 }
5621 }
5627 lappend sources_path "$s"
5629 lappend sources_path "$srcdir/$subdir/$s"
5630 }
5631 }
5639 }
5641 untested $testname
5643 }
5644 lappend objects "${binfile}${i}.o"
5645 incr i
5646 }
5648 }
5650 untested $testname
5652 }
5655 }
5660 # to gdb_compile directly.
5664 }
5667 foreach source $sources {
5668 lappend arglist $source $options
5669 }
5672 }
5674 # Starts fresh GDB binary and loads an optional executable into GDB.
5676 # EXECUTABLE is the basename of the binary.
5679 global srcdir
5680 global subdir
5683 error "bad number of args: [llength $args]"
5684 }
5686 gdb_exit
5687 gdb_start
5688 gdb_reinitialize_dir $srcdir/$subdir
5694 }
5695 }
5698 # clean_restart.
5699 # TESTNAME is the name of the test.
5700 # Each element in ARGS is a list of the form
5702 # These are passed to build_executable_from_specs, which see.
5703 # The last EXECUTABLE is passed to clean_restart.
5709 }
5711 }
5712 clean_restart $executable
5714 }
5717 # Please refer to build_executable for parameter description.
5722 }
5723 clean_restart $executable
5726 }
5730 # print fails. TEST is the test message to use. It can be omitted,
5731 # in which case a test message is built from EXP.
5734 global gdb_prompt
5738 }
5741 gdb_test_multiple "print${fmt} ${exp}" "$test" {
5744 pass "$test"
5745 }
5746 timeout {
5747 fail "$test (timeout)"
5748 }
5749 }
5751 }
5755 # TEST is the test message to use. It can be omitted, in which case
5756 # a test message is built from EXP.
5759 global gdb_prompt
5763 }
5766 gdb_test_multiple "print /d ${exp}" "$test" {
5769 pass "$test"
5770 }
5771 timeout {
5772 fail "$test (timeout)"
5773 }
5774 }
5776 }
5780 # TEST is the test message to use. It can be omitted, in which case
5781 # a test message is built from EXP.
5784 global gdb_prompt
5788 }
5791 gdb_test_multiple "print /x ${exp}" $test {
5794 pass "$test"
5795 }
5796 }
5798 }
5801 # is used as fallback if print fails. TEST is the test message to use.
5806 }
5808 proc get_target_charset { } {
5809 global gdb_prompt
5811 gdb_test_multiple "show target-charset" "" {
5814 }
5817 }
5818 }
5820 # Pick a reasonable default.
5821 warning "Unable to read target-charset."
5823 }
5825 # Get the address of VAR.
5828 global gdb_prompt hex
5830 # Match output like:
5835 gdb_test_multiple "print &${var}" "get address of ${var}" {
5837 {
5838 pass "get address of ${var}"
5843 }
5844 }
5845 }
5847 }
5851 global gdb_prompt
5855 }
5857 gdb_test_multiple "frame" $test_name {
5860 }
5861 }
5862 return $frame_num
5863 }
5866 proc get_remotetimeout { } {
5867 global gdb_prompt
5868 global decimal
5870 gdb_test_multiple "show remotetimeout" "" {
5873 }
5874 }
5876 # Pick the default that gdb uses
5877 warning "Unable to read remotetimeout"
5879 }
5881 # Set the remotetimeout to the specified timeout. Nothing is returned.
5883 global gdb_prompt
5885 gdb_test_multiple "set remotetimeout $timeout" "" {
5887 verbose "Set remotetimeout to $timeout\n"
5888 }
5889 }
5890 }
5893 proc get_endianness { } {
5894 global gdb_prompt
5896 gdb_test_multiple "show endian" "determine endianness" {
5898 # Pass silently.
5899 return $expect_out(1,string)
5900 }
5901 }
5902 return "little"
5903 }
5905 # ROOT and FULL are file names. Returns the relative path from ROOT
5906 # to FULL. Note that FULL must be in a subdirectory of ROOT.
5907 # For example, given ROOT = /usr/bin and FULL = /usr/bin/ls, this
5908 # will return "ls".
5910 proc relative_filename {root full} {
5911 set root_split [file split $root]
5912 set full_split [file split $full]
5914 set len [llength $root_split]
5916 if {[eval file join $root_split]
5917 != [eval file join [lrange $full_split 0 [expr {$len - 1}]]]} {
5918 error "$full not a subdir of $root"
5919 }
5921 return [eval file join [lrange $full_split $len end]]
5922 }
5924 # Log gdb command line and script if requested.
5925 if {[info exists TRANSCRIPT]} {
5926 rename send_gdb real_send_gdb
5927 rename remote_spawn real_remote_spawn
5928 rename remote_close real_remote_close
5930 global gdb_transcript
5931 set gdb_transcript ""
5933 global gdb_trans_count
5934 set gdb_trans_count 1
5936 proc remote_spawn {args} {
5937 global gdb_transcript gdb_trans_count outdir
5939 if {$gdb_transcript != ""} {
5940 close $gdb_transcript
5941 }
5942 set gdb_transcript [open [file join $outdir transcript.$gdb_trans_count] w]
5943 puts $gdb_transcript [lindex $args 1]
5944 incr gdb_trans_count
5946 return [uplevel real_remote_spawn $args]
5947 }
5949 proc remote_close {args} {
5950 global gdb_transcript
5952 if {$gdb_transcript != ""} {
5953 close $gdb_transcript
5954 set gdb_transcript ""
5955 }
5957 return [uplevel real_remote_close $args]
5958 }
5960 proc send_gdb {args} {
5961 global gdb_transcript
5963 if {$gdb_transcript != ""} {
5964 puts -nonewline $gdb_transcript [lindex $args 0]
5965 }
5967 return [uplevel real_send_gdb $args]
5968 }
5969 }
5971 # If GDB_PARALLEL exists, then set up the parallel-mode directories.
5972 if {[info exists GDB_PARALLEL]} {
5973 if {[is_remote host]} {
5974 unset GDB_PARALLEL
5975 } else {
5976 file mkdir \
5977 [make_gdb_parallel_path outputs] \
5978 [make_gdb_parallel_path temp] \
5979 [make_gdb_parallel_path cache]
5980 }
5981 }
5983 proc core_find {binfile {deletefiles {}} {arg ""}} {
5984 global objdir subdir
5986 set destcore "$binfile.core"
5987 file delete $destcore
5989 # Create a core file named "$destcore" rather than just "core", to
5990 # avoid problems with sys admin types that like to regularly prune all
5991 # files named "core" from the system.
5992 #
5993 # Arbitrarily try setting the core size limit to "unlimited" since
5994 # this does not hurt on systems where the command does not work and
5995 # allows us to generate a core on systems where it does.
5996 #
5997 # Some systems append "core" to the name of the program; others append
5998 # the name of the program to "core"; still others (like Linux, as of
5999 # May 2003) create cores named "core.PID". In the latter case, we
6000 # could have many core files lying around, and it may be difficult to
6004 file mkdir $coredir
6005 catch "system \"(cd ${coredir}; ulimit -c unlimited; ${binfile} ${arg}; true) >/dev/null 2>&1\""
6006 # remote_exec host "${binfile}"
6007 foreach i "${coredir}/core ${coredir}/core.coremaker.c ${binfile}.core" {
6009 remote_exec build "mv $i $destcore"
6011 }
6012 }
6018 remote_exec build "mv $corefile $destcore"
6020 }
6021 }
6026 # Oh, I should mention that any "braindamaged" non-Unix system has
6029 foreach i "${objdir}/${subdir}/core ${objdir}/${subdir}/core.coremaker.c ${binfile}.core" {
6030 if [remote_file build exists $i] {
6031 remote_exec build "mv $i $destcore"
6032 set found 1
6033 }
6034 }
6035 }
6037 # Try to clean up after ourselves.
6038 foreach deletefile $deletefiles {
6039 remote_file build delete [file join $coredir $deletefile]
6040 }
6041 remote_exec build "rmdir $coredir"
6043 if { $found == 0 } {
6046 }
6047 return $destcore
6048 }
6052 # for linker symbol prefixes.
6054 gdb_caching_proc gdb_target_symbol_prefix {
6059 }
6069 verbose "gdb_target_symbol_prefix: Could not find main in objdump output; returning null prefix" 2
6070 }
6074 return $prefix
6075 }
6079 gdb_caching_proc target_supports_scheduler_locking {
6080 global gdb_prompt
6087 }
6089 clean_restart $obj
6092 }
6098 gdb_test_multiple "show scheduler-locking" $test {
6101 }
6104 }
6105 timeout {
6107 }
6108 }
6112 gdb_test_multiple "set scheduler-locking $current_schedule_locking_mode" $test {
6115 }
6118 }
6119 timeout {
6121 }
6122 }
6123 }
6127 }
6129 gdb_exit
6131 verbose "$me: returning $supports_schedule_locking" 2
6132 return $supports_schedule_locking
6133 }
6135 # gdb_target_symbol returns the provided symbol with the correct prefix
6141 }
6143 # gdb_target_symbol_prefix_flags_asm returns a string that can be
6145 # SYMBOL_PREFIX with a value that can be prepended to symbols
6147 #
6149 # surrounding the prefix. It is used to define the macro
6152 #
6157 #
6158 # It's possible to use this version (_asm) for C/C++ source files too,
6159 # but a string is usually required in such files; providing a version
6160 # (no _asm) which encloses the prefix with double quotes makes it
6161 # somewhat easier to define the supporting macros in the test case.
6163 proc gdb_target_symbol_prefix_flags_asm {} {
6164 set prefix [gdb_target_symbol_prefix]
6165 if {$prefix ne ""} {
6166 return "additional_flags=-DSYMBOL_PREFIX=$prefix"
6167 } else {
6168 return "";
6169 }
6170 }
6172 # gdb_target_symbol_prefix_flags returns the same string as
6173 # gdb_target_symbol_prefix_flags_asm, above, but with the prefix
6174 # enclosed in double quotes if there is a prefix.
6175 #
6176 # See the comment for gdb_target_symbol_prefix_flags_asm for an
6177 # extended discussion.
6179 proc gdb_target_symbol_prefix_flags {} {
6180 set prefix [gdb_target_symbol_prefix]
6181 if {$prefix ne ""} {
6183 } else {
6184 return "";
6185 }
6186 }
6189 # Returns 0 if all went well, nonzero on failure.
6190 # TEST is the name of the test, other arguments are as for remote_exec.
6192 proc run_on_host { test program args } {
6193 verbose -log "run_on_host: $program $args"
6195 # input is the empty string -- so replace an empty input with
6199 }
6201 verbose "result is $result"
6205 pass $test
6209 fail $test
6211 }
6212 }
6216 # Fission doesn't support everything yet.
6217 # This supports working around bug 15954.
6219 proc using_fission { } {
6220 set debug_flags [board_info [target_info name] debug_flags]
6221 return [regexp -- "-gsplit-dwarf" $debug_flags]
6222 }
6225 # valid options described by ARGSET.
6226 #
6229 #
6230 # If only one element is given to describe an option, it the value is
6232 # it is.
6233 #
6236 #
6238 # any optional components.
6240 # Example:
6241 # proc myproc {foo args} {
6242 # parse_args {{bar} {baz "abc"} {qux}}
6243 # # ...
6244 # }
6245 # myproc ABC -bar -baz DEF peanut butter
6246 # will define the following variables in myproc:
6247 # foo (=ABC), bar (=1), baz (=DEF), and qux (=0)
6248 # args will be the list {peanut butter}
6250 proc parse_args { argset } {
6251 upvar args args
6253 foreach argument $argset {
6254 if {[llength $argument] == 1} {
6255 # No default specified, so we assume that we should set
6256 # the value to 1 if the arg is present and 0 if it's not.
6257 # It is assumed that no value is given with the argument.
6264 }
6266 # There are two items in the argument. The second is a
6267 # default value to use if the item is not present.
6269 # after the item in the args.
6277 }
6279 error "Badly formatted argument \"$argument\" in argument set"
6280 }
6281 }
6283 # The remaining args should be checked to see that they match the
6284 # number of items expected to be passed into the procedure...
6285 }
6288 # return that string.
6291 global gdb_prompt
6292 global expect_out
6295 gdb_test_multiple "$command" "capture_command_output for $command" {
6298 }
6299 }
6300 return $output_string
6301 }
6303 # A convenience function that joins all the arguments together, with a
6304 # regexp that matches exactly one end of line in between each argument.
6305 # This function is ideal to write the expected output of a GDB command
6306 # that generates more than a couple of lines, as this allows us to write
6307 # each line as a separate string, which is easier to read by a human
6308 # being.
6312 }
6315 # match GDB output, this one is meant to be used to build strings to
6316 # send as GDB input.
6320 }
6322 # Return the version of the DejaGnu framework.
6323 #
6327 #
6332 proc dejagnu_version { } {
6334 global frame_version
6343 lappend dg_ver 0
6344 }
6346 return $dg_ver
6347 }
6350 # command's definition. The terminating "end" is added automatically.
6352 proc gdb_define_cmd {command command_list} {
6353 global gdb_prompt
6355 set input [multi_line_input {*}$command_list "end"]
6356 set test "define $command"
6358 gdb_test_multiple "define $command" $test {
6359 -re "End with" {
6360 gdb_test_multiple $input $test {
6362 }
6363 }
6364 }
6365 }
6366 }
6369 # log file keeps pointing at the same file. We need this because
6370 # unfortunately the path to the log file is recorded using an
6371 # relative path name, and, we sometimes need to close/reopen the log
6372 # after changing the current directory. See get_compiler_info.
6374 rename cd builtin_cd
6376 proc cd { dir } {
6378 # Get the existing log file flags.
6379 set log_file_info [log_file -info]
6381 # Split the flags into args and file name.
6382 set log_file_flags ""
6383 set log_file_file ""
6384 foreach arg [ split "$log_file_info" " "] {
6385 if [string match "-*" $arg] {
6386 lappend log_file_flags $arg
6387 } else {
6388 lappend log_file_file $arg
6389 }
6390 }
6392 # If there was an existing file, ensure it is an absolute path, and then
6393 # reset logging.
6394 if { $log_file_file != "" } {
6395 set log_file_file [file normalize $log_file_file]
6396 log_file
6397 log_file $log_file_flags "$log_file_file"
6398 }
6400 # Call the builtin version of cd.
6401 builtin_cd $dir
6402 }
6404 # Return a list of all languages supported by GDB, suitable for use in
6406 # 'auto' keywords.
6407 proc gdb_supported_languages {} {
6409 opencl rust minimal ada]
6410 }
6414 proc gdbserver_debug_enabled { } {
6415 # Always disabled for GDB only setups.
6417 }
6419 # Always load compatibility stuff.
6420 load_lib future.exp