1 # Copyright 1998-2019 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # This file was written by Elena Zannoni (ezannoni@cygnus.com)
18 # this file tests maintenance commands and help on those.
20 # source file used is break.c
23 #maintenance check-psymtabs -- Check consistency of psymtabs vs symtabs
24 #maintenance check-symtabs -- Check consistency of symtabs
25 #maintenance expand-symtabs -- Expand symtabs matching a file regexp
26 #maintenance set -- Set GDB internal variables used by the GDB maintainer
27 #maintenance show -- Show GDB internal variables used by the GDB maintainer
28 #maintenance dump-me -- Get fatal error; make debugger dump its core
29 #maintenance print -- Maintenance command for printing GDB internal state
30 #maintenance info -- Commands for showing internal info about the program being debugged
31 #maintenance internal-error -- Give GDB an internal error.
33 #maintenance print dummy-frames -- Print the dummy frame stack
34 #maintenance print statistics -- Print statistics about internal gdb state
35 #maintenance print objfiles -- Print dump of current object file definitions
36 #maintenance print psymbols -- Print dump of current partial symbol definitions
37 #maintenance print msymbols -- Print dump of current minimal symbol definitions
38 #maintenance print symbols -- Print dump of current symbol definitions
39 #maintenance print type -- Print a type chain for a given symbol
40 #maintenance print unwind -- Print unwind table entry at given address
43 #maintenance info sections -- List the BFD sections of the exec and core files
44 #maintenance info breakpoints -- Status of all breakpoints
49 standard_testfile break.c break1.c
51 if {[prepare_for_testing "failed to prepare" $testfile \
52 [list $srcfile $srcfile2] {debug nowarnings}]} {
56 # The commands we test here produce many lines of output; disable "press
57 # <return> to continue" prompts.
58 gdb_test_no_output "set height 0"
60 # Tests that require that no program is running
62 gdb_file_cmd ${binfile}
64 # Test for a regression where this command would internal-error if the
65 # program wasn't running. If there's a lot of registers then this
66 # might overflow expect's buffers, so process the output line at a
70 set test "maint print registers"
71 gdb_test_multiple $test $test {
72 -re "\[^\r\n\]+Name\[^\r\n\]+Nr\[^\r\n\]+Rel\[^\r\n\]+Offset\[^\r\n\]+Size\[^\r\n\]+Type\[^\r\n\]+\[\r\n\]+" {
76 -re "^\[^\r\n\]+\[0-9\]+\[^\r\n\]+\[0-9\]+\[^\r\n\]+\[0-9\]+\[^\r\n\]+\[0-9\]+\[^\r\n\]+\[\r\n\]+" {
80 -re "^\\*\[0-9\]+\[^\r\n\]+\[\r\n\]+" {
84 gdb_assert { $saw_registers && $saw_headers } $test
88 # Test "mt expand-symtabs" here as it's easier to verify before we
90 gdb_test_no_output "mt set per on" "mt set per on for expand-symtabs"
91 gdb_test_multiple "mt expand-symtabs $subdir/break\[.\]c$" \
93 -re "#compunits: (1|2) \\(\[+\](0|1|2)\\),.*$gdb_prompt $" {
94 # This should expand at most two primary symtabs.
95 # "Normally" it will not expand any, because the symtab
96 # holding "main" will already have been expanded, but if the
97 # file is compiled with -fdebug-types-section then a second primary
98 # symtab for break.c will be created for any types.
99 pass "mt expand-symtabs"
102 gdb_test "mt set per off" ".*" "mt set per off for expand-symtabs"
104 # Tests that can or should be done with a running program
108 if ![runto_main] then {
109 perror "tests suppressed"
112 # If we're using .gdb_index or .debug_names there will be no psymtabs.
114 gdb_test_multiple "maint info sections .gdb_index .debug_names" "check for .gdb_index" {
115 -re ": \\.gdb_index .*\r\n$gdb_prompt $" {
118 -re ": \\.debug_names .*\r\n$gdb_prompt $" {
121 -re ".*$gdb_prompt $" {
122 ;# Nothing to do, present to avoid a FAIL.
126 # There also won't be any psymtabs if we read the index from the index cache.
127 # We can detect this by looking if the index-cache is enabled and if the number
128 # of cache misses is 0.
129 set index_cache_misses -1
130 gdb_test_multiple "show index-cache stats" "check index cache stats" {
131 -re ".*Cache misses \\(this session\\): (\\d+)\r\n.*$gdb_prompt $" {
132 set index_cache_misses $expect_out(1,string)
136 set using_index_cache 0
137 gdb_test_multiple "show index-cache" "check index cache status" {
138 -re ".*is currently disabled.\r\n$gdb_prompt $" {
139 set using_index_cache 0
141 -re ".*is currently enabled.\r\n$gdb_prompt $" {
142 set using_index_cache 1
146 if { $index_cache_misses == 0 && $using_index_cache } {
151 # this command does not produce any output
152 # unless there is some problem with the symtabs and psymtabs
153 # so that branch will really never be covered in this tests here!!
156 # guo: on linux this command output is huge. for some reason splitting up
157 # the regexp checks works.
159 send_gdb "maint check-psymtabs\n"
161 -re "^maint check-psymtabs" {
163 -re "$gdb_prompt $" {
164 pass "maint check-psymtabs"
166 timeout { fail "(timeout) maint check-psymtabs" }
169 -re ".*$gdb_prompt $" { fail "maint check-psymtabs" }
170 timeout { fail "(timeout) maint check-psymtabs" }
173 # This command does not produce any output unless there is some problem
174 # with the symtabs, so that branch will really never be covered in the
176 gdb_test_no_output "maint check-symtabs"
178 # Test per-command stats.
179 gdb_test_no_output "maint set per-command on"
180 set decimal "\[0-9\]+"
181 set time_fmt "${decimal}-${decimal}-${decimal} ${decimal}:${decimal}:${decimal}\\.${decimal}"
183 "${time_fmt} - command started\r\n.*\r\n${time_fmt} - command finished\r\nCommand execution time: \[0-9.\]+ \\(cpu\\), \[0-9.\]+ \\(wall\\)\[\r\n\]+Space used: $decimal \\(\\+$decimal for this command\\)\[\r\n\]+#symtabs: $decimal \\(\\+$decimal\\), #compunits: $decimal \\(\\+$decimal\\), #blocks: $decimal \\(\\+$decimal\\)"
184 gdb_test "maint set per-command off" \
185 "${time_fmt} - command started"
187 # The timeout value is raised, because printing all the symbols and
188 # statistical information about Cygwin and Windows libraries takes a lot
190 if [istarget "*-*-cygwin*"] {
191 set oldtimeout $timeout
192 set timeout [expr $timeout + 500]
195 send_gdb "maint print statistics\n"
197 -re "Statistics for\[^\n\r\]*maint\[^\n\r\]*:\r\n Number of \"minimal\" symbols read: $decimal\r\n( Number of \"partial\" symbols read: $decimal\r\n)? Number of \"full\" symbols read: $decimal\r\n Number of \"types\" defined: $decimal\r\n( Number of psym tables \\(not yet expanded\\): $decimal\r\n)?( Number of read CUs: $decimal\r\n Number of unread CUs: $decimal\r\n)? Number of symbol tables: $decimal\r\n Number of symbol tables with line tables: $decimal\r\n Number of symbol tables with blockvectors: $decimal\r\n Total memory used for objfile obstack: $decimal\r\n Total memory used for BFD obstack: $decimal\r\n Total memory used for psymbol cache: $decimal\r\n Total memory used for macro cache: $decimal\r\n Total memory used for file name cache: $decimal\r\n" {
199 -re "$gdb_prompt $" {
200 pass "maint print statistics"
202 timeout { fail "(timeout) maint print statistics" }
205 -re ".*$gdb_prompt $" { fail "maint print statistics" }
206 timeout { fail "(timeout) maint print statistics" }
209 # There aren't any ...
210 gdb_test_no_output "maint print dummy-frames"
212 send_gdb "maint print objfiles\n"
214 # To avoid timeouts, we avoid expects with many .* patterns that match
215 # many lines. Instead, we keep track of which milestones we've seen
216 # in the output, and stop when we've seen all of them.
223 while {$keep_looking} {
227 set output $expect_out(buffer)
228 if {[regexp ".*Object file.*maint($EXEEXT)?: Objfile at ${hex}" $output]} {
231 if {[regexp ".*Psymtabs:\[\r\t \]+\n" $output]} {
234 if {[regexp ".*Symtabs:\[\r\t \]+\n" $output]} {
239 -re ".*$gdb_prompt $" {
243 fail "(timeout) maint print objfiles"
249 proc maint_pass_if {val name} {
250 if $val { pass $name } else { fail $name }
253 maint_pass_if $header "maint print objfiles: header"
254 if { ! $have_gdb_index } {
255 maint_pass_if $psymtabs "maint print objfiles: psymtabs"
257 maint_pass_if $symtabs "maint print objfiles: symtabs"
259 if { ! $have_gdb_index } {
260 set psymbols_output [standard_output_file psymbols_output]
261 set psymbols_output_re [string_to_regexp $psymbols_output]
262 set test_list [list \
263 "maint print psymbols -source" \
264 "maint print psymbols -source ${srcdir}/${subdir}/${srcfile} $psymbols_output" \
265 "maint print psymbols -pc" \
266 "maint print psymbols -pc main $psymbols_output"]
267 foreach { test_name command } $test_list {
268 send_gdb "$command\n"
270 -re "^maint print psymbols \[^\n\]*\r\n$gdb_prompt $" {
271 send_gdb "shell ls $psymbols_output\n"
273 -re "$psymbols_output_re\r\n$gdb_prompt $" {
274 # We want this grep to be as specific as possible,
275 # so it's less likely to match symbol file names in
276 # psymbols_output. Yes, this actually happened;
277 # poor expect got tons of output, and timed out
278 # trying to match it. --- Jim Blandy <jimb@cygnus.com>
279 send_gdb "shell grep 'main.*function' $psymbols_output\n"
281 -re ".main., function, $hex.*$gdb_prompt $" {
284 -re ".*main. .., function, $hex.*$gdb_prompt $" {
287 -re ".*$gdb_prompt $" { fail "$test_name" }
288 timeout { fail "$test_name (timeout)" }
290 gdb_test "shell rm -f $psymbols_output" ".*" \
291 "${test_name}: shell rm -f psymbols_output"
293 -re ".*$gdb_prompt $" { fail "$test_name" }
294 timeout { fail "$test_name (timeout)" }
297 -re ".*$gdb_prompt $" { fail "$test_name" }
298 timeout { fail "$test_name (timeout)" }
304 set msymbols_output [standard_output_file msymbols_output]
305 set msymbols_output_re [string_to_regexp $msymbols_output]
306 send_gdb "maint print msymbols -objfile ${binfile} $msymbols_output\n"
308 -re "^maint print msymbols \[^\n\]*\r\n$gdb_prompt $" {
309 send_gdb "shell ls $msymbols_output\n"
311 -re "$msymbols_output_re\r\n$gdb_prompt $" {
312 gdb_test "shell grep factorial $msymbols_output" \
313 "\\\[ *$decimal\\\] \[tT\]\[ \t\]+$hex \\.?factorial.*" \
314 "maint print msymbols, absolute pathname"
315 gdb_test "shell rm -f $msymbols_output" ".*" \
316 "shell rm -f msymbols_output"
318 -re ".*$gdb_prompt $" { fail "maint print msymbols" }
319 timeout { fail "maint print msymbols (timeout)" }
322 -re ".*$gdb_prompt $" { fail "maint print msymbols" }
323 timeout { fail "maint print msymbols (timeout)" }
326 # Check that maint print msymbols allows relative pathnames
328 gdb_test "cd [standard_output_file {}]" \
329 "Working directory .*\..*" \
332 gdb_test_multiple "maint print msymbols -objfile ${testfile} msymbols_output2" "maint print msymbols" {
333 -re "^maint print msymbols \[^\n\]*\r\n$gdb_prompt $" {
334 gdb_test_multiple "shell ls msymbols_output2" "maint print msymbols" {
335 -re "msymbols_output2\r\n$gdb_prompt $" {
336 gdb_test "shell grep factorial msymbols_output2" \
337 "\\\[ *$decimal\\\] \[tT\]\[ \t\]+$hex \\.?factorial.*" \
338 "maint print msymbols, relative pathname"
339 gdb_test "shell rm -f msymbols_output2" ".*"
344 gdb_test "cd ${mydir}" \
345 "Working directory [string_to_regexp ${mydir}]\..*" \
349 # Request symbols for one particular source file so that we don't try to
350 # dump the symbol information for the entire C library - over 500MB nowadays
353 set symbols_output [standard_output_file symbols_output]
354 set symbols_output_re [string_to_regexp $symbols_output]
355 set test_list [list \
356 "maint print symbols -source" \
357 "maint print symbols -source ${srcdir}/${subdir}/${srcfile} $symbols_output" \
358 "maint print symbols -pc" \
359 "maint print symbols -pc main $symbols_output"]
360 foreach { test_name command } $test_list {
361 send_gdb "$command\n"
363 -re "^maint print symbols \[^\n\]*\r\n$gdb_prompt $" {
364 send_gdb "shell ls $symbols_output\n"
366 -re "$symbols_output_re\r\n$gdb_prompt $" {
367 # See comments for `maint print psymbols'.
368 send_gdb "shell grep 'main(.*block' $symbols_output\n"
370 -re "int main\\(int, char \\*\\*, char \\*\\*\\); block.*$gdb_prompt $" {
373 -re ".*$gdb_prompt $" { fail "$test_name" }
374 timeout { fail "$test_name (timeout)" }
376 gdb_test "shell rm -f $symbols_output" ".*" \
377 "$test_name: shell rm -f symbols_output"
379 -re ".*$gdb_prompt $" { fail "$test_name" }
380 timeout { fail "$test_name (timeout)" }
383 -re ".*$gdb_prompt $" { fail "$test_name" }
384 timeout { fail "$test_name (timeout)" }
388 set msg "maint print type"
389 gdb_test_multiple "maint print type argc" $msg {
390 -re "type node $hex\r\nname .int. \\($hex\\)\r\ncode $hex \\(TYPE_CODE_INT\\)\r\nlength \[24\]\r\nobjfile $hex\r\ntarget_type $hex\r\npointer_type $hex\r\nreference_type $hex\r\ntype_chain $hex\r\ninstance_flags $hex\r\nflags\r\nnfields 0 $hex\r\n$gdb_prompt $" {
395 if [istarget "hppa*-*-11*"] {
396 setup_xfail hppa*-*-*11* CLLbs14860
397 gdb_test_multiple "maint print unwind &main" "maint print unwind" {
398 -re ".*unwind_table_entry \\($hex\\):\r\n\tregion_start = $hex <main>\r\n\tregion_end = $hex <main\\+\[0-9\]*>\r\n\tflags = Args_stored Save_RP\r\n\tRegion_description = $hex\r\n\tEntry_FR = $hex\r\n\tEntry_GR = $hex\r\n\tTotal_frame_size = $hex\r\n$gdb_prompt $" {
399 pass "maint print unwind"
401 -re ".*unwind_table_entry \\($hex\\):\r\n\tregion_start = $hex <main>\r\n\tregion_end = $hex <main\\+\[0-9\]*>\r\n\tflags = Args_stored Save_RP\r\n\tFLD = $hex\r\n\tFLD = $hex\r\n\tFLD = $hex\r\n\tFLD = $hex\r\n$gdb_prompt $" {
402 xfail "maint print unwind"
407 set oldtimeout $timeout
408 set timeout [expr $timeout + 300]
410 # It'd be nice to check for every possible section. However, that's
411 # problematic, since the relative ordering wanders from release to
412 # release of the compilers. Instead, we'll just check for two
413 # sections which appear to always come out in the same relative
414 # order. (If that changes, then we should just check for one
417 # And by the way: This testpoint will break for PA64, where a.out's
420 # Standard GNU names.
421 set text_section ".text"
422 set data_section ".data"
424 gdb_test_multiple "maint info sections" "maint info sections" {
425 -re "Exec file:\r\n.*maint($EXEEXT)?., file type.*ER_RO.*$gdb_prompt $" {
426 # Looks like RealView which uses different section names.
427 set text_section ER_RO
428 set data_section ER_RW
429 pass "maint info sections"
431 -re "Exec file:\r\n.*maint($EXEEXT)?., file type.*neardata.*$gdb_prompt $" {
432 # c6x doesn't have .data section. It has .neardata and .fardata section.
433 set data_section ".neardata"
434 pass "maint info sections"
436 -re "Exec file:\r\n.*maint($EXEEXT)?., file type.*$gdb_prompt $" {
437 pass "maint info sections"
441 # Test for new option: maint info sections <section name>
442 # If you don't have a .text section, this will require tweaking.
444 gdb_test_multiple "maint info sections $text_section" \
445 "maint info sections .text" {
446 -re ".* \\.bss .*$gdb_prompt $" {
447 fail "maint info sections .text"
449 -re ".* $data_section .*$gdb_prompt $" {
450 fail "maint info sections .text"
452 -re ".* $text_section .*$gdb_prompt $" {
453 pass "maint info sections .text"
457 # Test for new option: CODE section flag
458 # If your data section is tagged CODE, xfail this test.
460 gdb_test_multiple "maint info sections CODE" "maint info sections CODE" {
461 -re ".* $data_section .*$gdb_prompt $" { fail "maint info sections CODE" }
462 -re ".* $text_section .*$gdb_prompt $" { pass "maint info sections CODE" }
465 # Test for new option: DATA section flag
466 # If your text section is tagged DATA, xfail this test.
468 # The "maint info sections DATA" test is marked for XFAIL on Windows,
469 # because Windows has text sections marked DATA.
470 setup_xfail "*-*-*cygwin*"
471 setup_xfail "*-*-*mingw*"
473 gdb_test_multiple "maint info sections DATA" "maint info sections DATA" {
474 -re ".* $text_section .*$gdb_prompt $" { fail "maint info sections DATA" }
475 -re ".* $data_section .*$gdb_prompt $" { pass "maint info sections DATA" }
476 -re ".* .rodata .*$gdb_prompt $" { pass "maint info sections DATA" }
479 set bp_location6 [gdb_get_line_number "set breakpoint 6 here"]
481 gdb_test_multiple "maint info breakpoints" "maint info breakpoints" {
482 -re "Num\[ \t\]+Type\[ \t\]+Disp\[ \t\]+Enb\[ \t\]+Address\[ \t\]+What\r\n1\[ \t\]+breakpoint\[ \t\]+keep\[ \t\]+y\[ \t\]+$hex\[ \t\]+in main at.*break.c:$bp_location6 inf 1\r\n\[ \t\]+breakpoint already hit 1 time\r\n.*$gdb_prompt $" {
483 pass "maint info breakpoints"
485 -re "Num\[ \t\]+Type\[ \t\]+Disp\[ \t\]+Enb\[ \t\]+Address\[ \t\]+What\r\n1\[ \t\]+breakpoint\[ \t\]+keep\[ \t\]+y\[ \t\]+$hex in main at.*break.c:$bp_location6 sspace 1\r\n\[ \t\]+breakpoint already hit 1 time\r\n-1\[ \t\]+shlib events\[ \t\]+keep\[ \t\]+y\[ \t\]+$hex.*breakpoint already hit.*$gdb_prompt $" {
486 pass "maint info breakpoints (with shlib events)"
490 gdb_test "maint print" \
491 "\"maintenance print\" must be followed by the name of a print command\\.\r\nList.*unambiguous\\..*" \
492 "maint print w/o args"
494 gdb_test "maint info" \
495 "\"maintenance info\" must be followed by the name of an info command\\.\r\nList.*unambiguous\\..*" \
496 "maint info w/o args"
499 "\"maintenance\" must be followed by the name of a maintenance command\\.\r\nList.*unambiguous\\..*" \
502 # Test that "main info line-table" w/o a file name shows the symtab for
505 set test "maint info line-table w/o a file name"
506 gdb_test_multiple "maint info line-table" $test {
507 -re "symtab: \[^\n\r\]+${srcfile} \\(\\(struct symtab \\*\\) $hex\\)\r\nlinetable: \\(\\(struct linetable \\*\\) $hex\\):\r\nINDEX\[ \t\]+LINE\[ \t\]+ADDRESS" {
511 -re "symtab: \[^\n\r\]+ \\(\\(struct symtab \\*\\) $hex\\)\r\nlinetable: \\(\\(struct linetable \\*\\) $hex\\):\r\nINDEX\[ \t\]+LINE\[ \t\]+ADDRESS" {
512 # Match each symtab to avoid overflowing expect's buffer.
515 -re "$decimal\[ \t\]+$decimal\[ \t\]+$hex\r\n" {
516 # Line table entries can be long too:
519 # 0 29 0x00000000004006f6
520 # 1 30 0x00000000004006fa
521 # 2 31 0x0000000000400704
522 # 3 42 0x0000000000400706
523 # 4 43 0x0000000000400719
524 # 5 44 0x0000000000400722
525 # 6 45 0x0000000000400740
527 # 454 129 0x00007ffff7df1d28
528 # 455 0 0x00007ffff7df1d3f
530 # Match each line to avoid overflowing expect's buffer.
533 -re "$gdb_prompt $" {
534 gdb_assert $saw_srcfile $test
538 gdb_test "maint info line-table ${srcfile}" \
539 "symtab: \[^\n\r\]+${srcfile}.*INDEX.*LINE.*ADDRESS.*" \
540 "maint info line-table with filename of current symtab"
542 gdb_test_no_output "maint info line-table ${srcfile2}" \
543 "maint info line-table with filename of symtab that is not currently expanded"
545 gdb_test_no_output "maint expand-symtabs"
547 gdb_test "maint info line-table ${srcfile2}" \
548 "symtab: \[^\n\r\]+${srcfile2}.*INDEX.*LINE.*ADDRESS.*" \
549 "maint info line-table with filename of symtab that is not current"
551 gdb_test_no_output "maint info line-table xxx.c" \
552 "maint info line-table with invalid filename"
554 set timeout $oldtimeout
556 # Just check that the DWARF unwinders control flag is visible.
557 gdb_test "maint show dwarf unwinders" \
558 "The DWARF stack unwinders are currently (on|off)\\."
560 #============test help on maint commands
562 test_prefix_command_help {"maint info" "maintenance info"} {
563 "Commands for showing internal info about the program being debugged\\.\[\r\n\]+"
566 test_prefix_command_help {"maint print" "maintenance print"} {
567 "Maintenance command for printing GDB internal state\\.\[\r\n\]+"
570 test_prefix_command_help {"maint" "maintenance"} {
571 "Commands for use by GDB maintainers\\.\[\r\n\]+"
572 "Includes commands to dump specific internal GDB structures in\[\r\n\]+"
573 "a human readable form, to cause GDB to deliberately dump core, etc\\.\[\r\n\]+"
576 #set oldtimeout $timeout
577 #set timeout [expr $timeout + 300]
579 gdb_test_multiple "maint dump-me" "maint dump-me" {
580 -re "Should GDB dump core.*\\(y or n\\) $" {
581 gdb_test "n" ".*" "maint dump-me"
583 -re "Undefined maintenance command: .*$gdb_prompt $" {
584 # Command 'maint dump-me' is registered on non-win32 host.
585 unsupported "maint dump-me"
589 send_gdb "maint internal-error\n"
591 -re "A problem internal to GDB has been detected" {
592 pass "maint internal-error"
593 if [gdb_internal_error_resync] {
594 pass "internal-error resync"
596 fail "internal-error resync"
599 -re ".*$gdb_prompt $" {
600 fail "maint internal-error"
601 untested "internal-error resync"
604 fail "maint internal-error (timeout)"
605 untested "internal-error resync"
609 #set timeout $oldtimeout
611 # Test that the commands work without an argument. For this test, we
612 # don't need an inferior loaded/running. See PR gdb/21164.
615 gdb_test_no_output "maint print symbols"
616 gdb_test_no_output "maint print msymbols"
617 gdb_test_no_output "maint print psymbols"