Write index for dwz -m file
[external/binutils.git] / gdb / testsuite / gdb.dwarf2 / gdb-index.exp
1 # Copyright 2013-2019 Free Software Foundation, Inc.
2
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
15
16 load_lib dwarf.exp
17
18 # This test can only be run on targets which support DWARF-2.
19 if {![dwarf2_support]} {
20     return 0
21 }
22
23 standard_testfile main.c
24
25 if { [prepare_for_testing "failed to prepare" "${testfile}" \
26           [list ${srcfile}]] } {
27     return -1
28 }
29
30 # Add a .gdb_index section to PROGRAM.
31 # PROGRAM is assumed to be the output of standard_output_file.
32 # Returns the path of the program or "" if there is a failure.
33 # If there is a failure it will have already been logged.
34
35 proc add_gdb_index { program } {
36     set index_file ${program}.gdb-index
37     set dwz ${program}.dwz
38     set dwz_index_file ${dwz}.gdb-index
39     verbose -log "index_file: ${index_file}"
40     remote_file host delete ${index_file}
41     remote_file host delete ${dwz_index_file}
42     gdb_test_no_output "save gdb-index [file dirname ${index_file}]" \
43         "save gdb-index for file [file tail ${program}]"
44
45     # No point in continuing if generating the index failed.
46     # N.B.: There are times when gdb won't create an index, and it's not a
47     # failure.  However, in our case we need an index.  So if you find one
48     # not being generated, you'll either have to tweak the .c file or maybe
49     # add a flag to force an index to be generated.
50     if { [remote_file host exists ${index_file}] } {
51         pass "gdb-index file created"
52     } else {
53         fail "gdb-index file created"
54         return ""
55     }
56
57     set program_with_index ${program}.with-index
58     if {[run_on_host "objcopy" [gdb_find_objcopy] "--remove-section .gdb_index --add-section .gdb_index=$index_file --set-section-flags .gdb_index=readonly ${program} ${program_with_index}"]} {
59         return ""
60     }
61
62     if { [remote_file host exists ${dwz_index_file}] } {
63         # We're modifying $dwz in place, otherwise we'd have to update
64         # .gnu_debugaltlink in $program.
65         set args [join [list "--remove-section .gdb_index" \
66                             " --add-section .gdb_index=$dwz_index_file" \
67                             " --set-section-flags .gdb_index=readonly $dwz"]]
68         if {[run_on_host "objcopy" [gdb_find_objcopy] "$args"]} {
69             return ""
70         }
71     }
72
73     return ${program_with_index}
74 }
75
76 # Build a copy of the program with an index (.gdb_index/.debug_names).
77 # But only if the toolchain didn't already create one: gdb doesn't support
78 # building an index from a program already using one.
79
80 set test "check if index present"
81 gdb_test_multiple "mt print objfiles ${testfile}" $test {
82     -re "gdb_index.*${gdb_prompt} $" {
83         set binfile_with_index $binfile
84     }
85     -re "debug_names.*${gdb_prompt} $" {
86         set binfile_with_index $binfile
87     }
88     -re "Psymtabs.*${gdb_prompt} $" {
89         set binfile_with_index [add_gdb_index $binfile]
90         if { ${binfile_with_index} == "" } {
91             return -1
92         }
93     }
94 }
95
96 # Ok, we have a copy of $binfile with an index.
97 # Restart gdb and verify the index was used.
98
99 clean_restart ${binfile_with_index}
100 gdb_test "mt print objfiles ${testfile}" \
101     "(gdb_index|debug_names).*" \
102     "index used"
103
104 # Make gdb re-read symbols and see if .gdb_index/.debug_names still
105 # gets used.  symtab/15885
106
107 # There is gdb_touch_execfile, but it doesn't handle remote hosts.
108 # Is touch portable enough?
109 # First make sure enough time has passed, file mtime resolution is seconds.
110 gdb_test_no_output "shell sleep 1"
111 if {[run_on_host "touch binary" touch ${binfile_with_index}]} {
112     return -1
113 }
114
115 if ![runto_main] {
116     return -1
117 }
118 gdb_test "mt print objfiles ${testfile}" \
119     "(gdb_index|debug_names).*" \
120     "index used after symbol reloading"