Commit | Line | Data |
---|---|---|
6432ec65 | 1 | #!/usr/bin/env bash |
853254db TT |
2 | # Wrapper around gcc to tweak the output in various ways when running |
3 | # the testsuite. | |
ea65fe05 | 4 | |
b811d2c2 | 5 | # Copyright (C) 2010-2020 Free Software Foundation, Inc. |
ea65fe05 DE |
6 | # This program is free software; you can redistribute it and/or modify |
7 | # it under the terms of the GNU General Public License as published by | |
8 | # the Free Software Foundation; either version 3 of the License, or | |
9 | # (at your option) any later version. | |
10 | # | |
11 | # This program is distributed in the hope that it will be useful, | |
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | # GNU General Public License for more details. | |
15 | # | |
16 | # You should have received a copy of the GNU General Public License | |
17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | ||
19 | # This program requires gdb and objcopy in addition to gcc. | |
0b5574da DE |
20 | # The default values are gdb from the build tree and objcopy from $PATH. |
21 | # They may be overridden by setting environment variables GDB and OBJCOPY | |
63b46266 YPK |
22 | # respectively. Note that GDB should contain the gdb binary as well as the |
23 | # -data-directory flag, e.g., "foo/gdb -data-directory foo/data-directory". | |
ea65fe05 DE |
24 | # We assume the current directory is either $obj/gdb or $obj/gdb/testsuite. |
25 | # | |
26 | # Example usage: | |
27 | # | |
28 | # bash$ cd $objdir/gdb/testsuite | |
29 | # bash$ runtest \ | |
6432ec65 JK |
30 | # CC_FOR_TARGET="/bin/bash $srcdir/gdb/contrib/cc-with-tweaks.sh ARGS gcc" \ |
31 | # CXX_FOR_TARGET="/bin/bash $srcdir/gdb/contrib/cc-with-tweaks.sh ARGS g++" | |
ea65fe05 | 32 | # |
fb8cf7c5 DE |
33 | # For documentation on Fission and dwp files: |
34 | # http://gcc.gnu.org/wiki/DebugFission | |
35 | # http://gcc.gnu.org/wiki/DebugFissionDWP | |
ea65fe05 | 36 | # For documentation on index files: info -f gdb.info -n "Index Files" |
853254db TT |
37 | # For information about 'dwz', see the announcement: |
38 | # http://gcc.gnu.org/ml/gcc/2012-04/msg00686.html | |
39 | # (More documentation is to come.) | |
ea65fe05 | 40 | |
853254db | 41 | # ARGS determine what is done. They can be: |
ea9f10bb | 42 | # -Z invoke objcopy --compress-debug-sections |
853254db TT |
43 | # -z compress using dwz |
44 | # -m compress using dwz -m | |
9d6d4be8 TV |
45 | # -i make an index (.gdb_index) |
46 | # -n make a dwarf5 index (.debug_names) | |
7fb2b84a | 47 | # -p create .dwp files (Fission), you need to also use gcc option -gsplit-dwarf |
853254db TT |
48 | # If nothing is given, no changes are made |
49 | ||
50 | myname=cc-with-tweaks.sh | |
6432ec65 | 51 | mydir=`dirname "$0"` |
ea65fe05 DE |
52 | |
53 | if [ -z "$GDB" ] | |
54 | then | |
55 | if [ -f ./gdb ] | |
56 | then | |
63b46266 | 57 | GDB="./gdb -data-directory data-directory" |
ea65fe05 DE |
58 | elif [ -f ../gdb ] |
59 | then | |
63b46266 | 60 | GDB="../gdb -data-directory ../data-directory" |
b8e9bd6c DE |
61 | elif [ -f ../../gdb ] |
62 | then | |
63b46266 | 63 | GDB="../../gdb -data-directory ../../data-directory" |
ea65fe05 DE |
64 | else |
65 | echo "$myname: unable to find usable gdb" >&2 | |
66 | exit 1 | |
67 | fi | |
68 | fi | |
69 | ||
70 | OBJCOPY=${OBJCOPY:-objcopy} | |
80626a55 | 71 | READELF=${READELF:-readelf} |
ea65fe05 | 72 | |
853254db | 73 | DWZ=${DWZ:-dwz} |
80626a55 | 74 | DWP=${DWP:-dwp} |
853254db | 75 | |
ea65fe05 DE |
76 | have_link=unknown |
77 | next_is_output_file=no | |
00e14314 | 78 | output_file=a.out |
ea65fe05 | 79 | |
853254db | 80 | want_index=false |
9d6d4be8 | 81 | index_options="" |
853254db TT |
82 | want_dwz=false |
83 | want_multi=false | |
80626a55 | 84 | want_dwp=false |
ea9f10bb | 85 | want_objcopy_compress=false |
853254db TT |
86 | |
87 | while [ $# -gt 0 ]; do | |
88 | case "$1" in | |
ea9f10bb | 89 | -Z) want_objcopy_compress=true ;; |
853254db TT |
90 | -z) want_dwz=true ;; |
91 | -i) want_index=true ;; | |
9d6d4be8 | 92 | -n) want_index=true; index_options=-dwarf-5;; |
853254db | 93 | -m) want_multi=true ;; |
80626a55 | 94 | -p) want_dwp=true ;; |
853254db TT |
95 | *) break ;; |
96 | esac | |
97 | shift | |
98 | done | |
99 | ||
6432ec65 JK |
100 | if [ "$want_index" = true ] |
101 | then | |
102 | if [ -z "$GDB_ADD_INDEX" ] | |
103 | then | |
104 | if [ -f $mydir/gdb-add-index.sh ] | |
105 | then | |
106 | GDB_ADD_INDEX="$mydir/gdb-add-index.sh" | |
107 | else | |
108 | echo "$myname: unable to find usable contrib/gdb-add-index.sh" >&2 | |
109 | exit 1 | |
110 | fi | |
111 | fi | |
112 | fi | |
113 | ||
ea65fe05 DE |
114 | for arg in "$@" |
115 | do | |
116 | if [ "$next_is_output_file" = "yes" ] | |
117 | then | |
118 | output_file="$arg" | |
119 | next_is_output_file=no | |
120 | continue | |
121 | fi | |
122 | ||
123 | # Poor man's gcc argument parser. | |
124 | # We don't need to handle all arguments, we just need to know if we're | |
125 | # doing a link and what the output file is. | |
126 | # It's not perfect, but it seems to work well enough for the task at hand. | |
127 | case "$arg" in | |
128 | "-c") have_link=no ;; | |
129 | "-E") have_link=no ;; | |
130 | "-S") have_link=no ;; | |
131 | "-o") next_is_output_file=yes ;; | |
132 | esac | |
133 | done | |
134 | ||
135 | if [ "$next_is_output_file" = "yes" ] | |
136 | then | |
137 | echo "$myname: Unable to find output file" >&2 | |
138 | exit 1 | |
139 | fi | |
140 | ||
141 | if [ "$have_link" = "no" ] | |
142 | then | |
143 | "$@" | |
144 | exit $? | |
145 | fi | |
146 | ||
147 | index_file="${output_file}.gdb-index" | |
853254db | 148 | if [ "$want_index" = true ] && [ -f "$index_file" ] |
ea65fe05 DE |
149 | then |
150 | echo "$myname: Index file $index_file exists, won't clobber." >&2 | |
151 | exit 1 | |
152 | fi | |
153 | ||
154 | output_dir="${output_file%/*}" | |
155 | [ "$output_dir" = "$output_file" ] && output_dir="." | |
156 | ||
157 | "$@" | |
158 | rc=$? | |
159 | [ $rc != 0 ] && exit $rc | |
160 | if [ ! -f "$output_file" ] | |
161 | then | |
162 | echo "$myname: Internal error: $output_file missing." >&2 | |
163 | exit 1 | |
164 | fi | |
165 | ||
0df0352a TV |
166 | get_tmpdir () |
167 | { | |
168 | tmpdir=$(dirname "$output_file")/.tmp | |
169 | mkdir -p "$tmpdir" | |
170 | } | |
171 | ||
ea9f10bb TT |
172 | if [ "$want_objcopy_compress" = true ]; then |
173 | $OBJCOPY --compress-debug-sections "$output_file" | |
174 | rc=$? | |
175 | [ $rc != 0 ] && exit $rc | |
176 | fi | |
177 | ||
853254db | 178 | if [ "$want_index" = true ]; then |
6432ec65 JK |
179 | # Filter out these messages which would stop dejagnu testcase run: |
180 | # echo "$myname: No index was created for $file" 1>&2 | |
181 | # echo "$myname: [Was there no debuginfo? Was there already an index?]" 1>&2 | |
9d6d4be8 TV |
182 | GDB=$GDB $GDB_ADD_INDEX $index_options "$output_file" 2>&1 \ |
183 | | grep -v "^${GDB_ADD_INDEX##*/}: " >&2 | |
6432ec65 | 184 | rc=${PIPESTATUS[0]} |
853254db TT |
185 | [ $rc != 0 ] && exit $rc |
186 | fi | |
187 | ||
188 | if [ "$want_dwz" = true ]; then | |
a9eac7f9 SM |
189 | # Validate dwz's result by checking if the executable was modified. |
190 | cp "$output_file" "${output_file}.copy" | |
191 | $DWZ "$output_file" > /dev/null | |
192 | cmp "$output_file" "$output_file.copy" > /dev/null | |
193 | cmp_rc=$? | |
194 | rm -f "${output_file}.copy" | |
195 | ||
196 | case $cmp_rc in | |
197 | 0) | |
198 | echo "$myname: dwz did not modify ${output_file}." | |
199 | exit 1 | |
200 | ;; | |
201 | 1) | |
202 | # File was modified, great. | |
203 | ;; | |
204 | *) | |
205 | # Other cmp error, it presumably has already printed something on | |
206 | # stderr. | |
207 | exit 1 | |
208 | ;; | |
209 | esac | |
853254db | 210 | elif [ "$want_multi" = true ]; then |
0df0352a TV |
211 | get_tmpdir |
212 | dwz_file=$tmpdir/$(basename "$output_file").dwz | |
a9eac7f9 SM |
213 | # Remove the dwz output file if it exists, so we don't mistake it for a |
214 | # new file in case dwz fails. | |
0df0352a | 215 | rm -f "$dwz_file" |
a9eac7f9 | 216 | |
853254db | 217 | cp $output_file ${output_file}.alt |
0df0352a | 218 | $DWZ -m "$dwz_file" "$output_file" ${output_file}.alt > /dev/null |
6892f601 | 219 | rm -f ${output_file}.alt |
a9eac7f9 SM |
220 | |
221 | # Validate dwz's work by checking if the expected output file exists. | |
0df0352a TV |
222 | if [ ! -f "$dwz_file" ]; then |
223 | echo "$myname: dwz file $dwz_file missing." | |
a9eac7f9 SM |
224 | exit 1 |
225 | fi | |
ea65fe05 DE |
226 | fi |
227 | ||
80626a55 DE |
228 | if [ "$want_dwp" = true ]; then |
229 | dwo_files=$($READELF -wi "${output_file}" | grep _dwo_name | \ | |
230 | sed -e 's/^.*: //' | sort | uniq) | |
20d7f211 DE |
231 | rc=0 |
232 | if [ -n "$dwo_files" ]; then | |
233 | $DWP -o "${output_file}.dwp" ${dwo_files} > /dev/null | |
234 | rc=$? | |
235 | [ $rc != 0 ] && exit $rc | |
236 | rm -f ${dwo_files} | |
237 | fi | |
80626a55 DE |
238 | fi |
239 | ||
ea65fe05 DE |
240 | rm -f "$index_file" |
241 | exit $rc |