17522e038f67e857df245b64aa34d18f90706f86
[rpm.git] / scripts / find-debuginfo.sh
1 #!/bin/bash
2 #find-debuginfo.sh - automagically generate debug info and file list
3 #for inclusion in an rpm spec file.
4 #
5 # Usage: find-debuginfo.sh [--strict-build-id] [-g] [-r]
6 #                          [-o debugfiles.list]
7 #                          [[-l filelist]... [-p 'pattern'] -o debuginfo.list]
8 #                          [builddir]
9 #
10 # The -g flag says to use strip -g instead of full strip on DSOs or EXEs.
11 # The --strict-build-id flag says to exit with failure status if
12 # any ELF binary processed fails to contain a build-id note.
13 # The -r flag says to use eu-strip --reloc-debug-sections.
14 #
15 # A single -o switch before any -l or -p switches simply renames
16 # the primary output file from debugfiles.list to something else.
17 # A -o switch that follows a -p switch or some -l switches produces
18 # an additional output file with the debuginfo for the files in
19 # the -l filelist file, or whose names match the -p pattern.
20 # The -p argument is an grep -E -style regexp matching the a file name,
21 # and must not use anchors (^ or $).
22 #
23 # All file names in switches are relative to builddir (. if not given).
24 #
25
26 # With -g arg, pass it to strip on libraries or executables.
27 strip_g=false
28
29 # with -r arg, pass --reloc-debug-sections to eu-strip.
30 strip_r=false
31
32 # Barf on missing build IDs.
33 strict=false
34
35 BUILDDIR=.
36 out=debugfiles.list
37 nout=0
38 while [ $# -gt 0 ]; do
39   case "$1" in
40   --strict-build-id)
41     strict=true
42     ;;
43   -g)
44     strip_g=true
45     ;;
46   -o)
47     if [ -z "${lists[$nout]}" -a -z "${ptns[$nout]}" ]; then
48       out=$2
49     else
50       outs[$nout]=$2
51       ((nout++))
52     fi
53     shift
54     ;;
55   -l)
56     lists[$nout]="${lists[$nout]} $2"
57     shift
58     ;;
59   -p)
60     ptns[$nout]=$2
61     shift
62     ;;
63   -r)
64     strip_r=true
65     ;;
66   *)
67     BUILDDIR=$1
68     shift
69     break
70     ;;
71   esac
72   shift
73 done
74
75 i=0
76 while ((i < nout)); do
77   outs[$i]="$BUILDDIR/${outs[$i]}"
78   l=''
79   for f in ${lists[$i]}; do
80     l="$l $BUILDDIR/$f"
81   done
82   lists[$i]=$l
83   ((++i))
84 done
85
86 LISTFILE="$BUILDDIR/$out"
87 SOURCEFILE="$BUILDDIR/debugsources.list"
88 LINKSFILE="$BUILDDIR/debuglinks.list"
89
90 > "$SOURCEFILE"
91 > "$LISTFILE"
92 > "$LINKSFILE"
93
94 debugdir="${RPM_BUILD_ROOT}/usr/lib/debug"
95
96 strip_to_debug()
97 {
98   local g=
99   local r=
100   $strip_r && r=--reloc-debug-sections
101   $strip_g && case "$(file -bi "$2")" in
102   application/x-sharedlib*) g=-g ;;
103   application/x-executable*) g=-g ;;
104   esac
105   eu-strip --remove-comment $r $g -f "$1" "$2" || exit
106   chmod 444 "$1" || exit
107 }
108
109 # Make a relative symlink to $1 called $3$2
110 shopt -s extglob
111 link_relative()
112 {
113   local t="$1" f="$2" pfx="$3"
114   local fn="${f#/}" tn="${t#/}"
115   local fd td d
116
117   while fd="${fn%%/*}"; td="${tn%%/*}"; [ "$fd" = "$td" ]; do
118     fn="${fn#*/}"
119     tn="${tn#*/}"
120   done
121
122   d="${fn%/*}"
123   if [ "$d" != "$fn" ]; then
124     d="${d//+([!\/])/..}"
125     tn="${d}/${tn}"
126   fi
127
128   mkdir -p "$(dirname "$pfx$f")" && ln -snf "$tn" "$pfx$f"
129 }
130
131 # Make a symlink in /usr/lib/debug/$2 to $1
132 debug_link()
133 {
134   local l="/usr/lib/debug$2"
135   local t="$1"
136   echo >> "$LINKSFILE" "$l $t"
137   link_relative "$t" "$l" "$RPM_BUILD_ROOT"
138 }
139
140 # Provide .2, .3, ... symlinks to all filename instances of this build-id.
141 make_id_dup_link()
142 {
143   local id="$1" file="$2" idfile
144
145   local n=1
146   while true; do
147     idfile=".build-id/${id:0:2}/${id:2}.$n"
148     [ $# -eq 3 ] && idfile="${idfile}$3"
149     if [ ! -L "$RPM_BUILD_ROOT/usr/lib/debug/$idfile" ]; then
150       break
151     fi
152     n=$[$n+1]
153   done
154   debug_link "$file" "/$idfile"
155 }
156
157 # Make a build-id symlink for id $1 with suffix $3 to file $2.
158 make_id_link()
159 {
160   local id="$1" file="$2"
161   local idfile=".build-id/${id:0:2}/${id:2}"
162   [ $# -eq 3 ] && idfile="${idfile}$3"
163   local root_idfile="$RPM_BUILD_ROOT/usr/lib/debug/$idfile"
164
165   if [ ! -L "$root_idfile" ]; then
166     debug_link "$file" "/$idfile"
167     return
168   fi
169
170   make_id_dup_link "$@"
171
172   [ $# -eq 3 ] && return 0
173
174   local other=$(readlink -m "$root_idfile")
175   other=${other#$RPM_BUILD_ROOT}
176   if cmp -s "$root_idfile" "$RPM_BUILD_ROOT$file" ||
177      eu-elfcmp -q "$root_idfile" "$RPM_BUILD_ROOT$file" 2> /dev/null; then
178     # Two copies.  Maybe one has to be setuid or something.
179     echo >&2 "*** WARNING: identical binaries are copied, not linked:"
180     echo >&2 "        $file"
181     echo >&2 "   and  $other"
182   else
183     # This is pathological, break the build.
184     echo >&2 "*** ERROR: same build ID in nonidentical files!"
185     echo >&2 "        $file"
186     echo >&2 "   and  $other"
187     exit 2
188   fi
189 }
190
191 get_debugfn()
192 {
193   dn=$(dirname "${1#$RPM_BUILD_ROOT}")
194   bn=$(basename "$1" .debug).debug
195
196   debugdn=${debugdir}${dn}
197   debugfn=${debugdn}/${bn}
198 }
199
200 set -o pipefail
201
202 strict_error=ERROR
203 $strict || strict_error=WARNING
204
205 # Strip ELF binaries
206 find "$RPM_BUILD_ROOT" ! -path "${debugdir}/*.debug" -type f \
207                      \( -perm -0100 -or -perm -0010 -or -perm -0001 \) \
208                      -print |
209 file -N -f - | sed -n -e 's/^\(.*\):[   ]*.*ELF.*, not stripped.*/\1/p' |
210 xargs --no-run-if-empty stat -c '%h %D_%i %n' |
211 while read nlinks inum f; do
212   get_debugfn "$f"
213   [ -f "${debugfn}" ] && continue
214
215   # If this file has multiple links, keep track and make
216   # the corresponding .debug files all links to one file too.
217   if [ $nlinks -gt 1 ]; then
218     eval linked=\$linked_$inum
219     if [ -n "$linked" ]; then
220       eval id=\$linkedid_$inum
221       make_id_dup_link "$id" "$dn/$(basename $f)"
222       make_id_dup_link "$id" "/usr/lib/debug$dn/$bn" .debug
223       link=$debugfn
224       get_debugfn "$linked"
225       echo "hard linked $link to $debugfn"
226       mkdir -p "$(dirname "$link")" && ln -nf "$debugfn" "$link"
227       continue
228     else
229       eval linked_$inum=\$f
230       echo "file $f has $[$nlinks - 1] other hard links"
231     fi
232   fi
233
234   echo "extracting debug info from $f"
235   id=$(/usr/lib/rpm/debugedit -b "$RPM_BUILD_DIR" -d /usr/src/debug \
236                               -i -l "$SOURCEFILE" "$f") || exit
237   if [ $nlinks -gt 1 ]; then
238     eval linkedid_$inum=\$id
239   fi
240   if [ -z "$id" ]; then
241     echo >&2 "*** ${strict_error}: No build ID note found in $f"
242     $strict && exit 2
243   fi
244
245   [ -x /usr/bin/gdb-add-index ] && /usr/bin/gdb-add-index "$f" > /dev/null 2>&1
246
247   # A binary already copied into /usr/lib/debug doesn't get stripped,
248   # just has its file names collected and adjusted.
249   case "$dn" in
250   /usr/lib/debug/*)
251     [ -z "$id" ] || make_id_link "$id" "$dn/$(basename $f)"
252     continue ;;
253   esac
254
255   mkdir -p "${debugdn}"
256   if test -w "$f"; then
257     strip_to_debug "${debugfn}" "$f"
258   else
259     chmod u+w "$f"
260     strip_to_debug "${debugfn}" "$f"
261     chmod u-w "$f"
262   fi
263
264   if [ -n "$id" ]; then
265     make_id_link "$id" "$dn/$(basename $f)"
266     make_id_link "$id" "/usr/lib/debug$dn/$bn" .debug
267   fi
268 done || exit
269
270 # For each symlink whose target has a .debug file,
271 # make a .debug symlink to that file.
272 find "$RPM_BUILD_ROOT" ! -path "${debugdir}/*" -type l -print |
273 while read f
274 do
275   t=$(readlink -m "$f").debug
276   f=${f#$RPM_BUILD_ROOT}
277   t=${t#$RPM_BUILD_ROOT}
278   if [ -f "$debugdir$t" ]; then
279     echo "symlinked /usr/lib/debug$t to /usr/lib/debug${f}.debug"
280     debug_link "/usr/lib/debug$t" "${f}.debug"
281   fi
282 done
283
284 if [ -s "$SOURCEFILE" ]; then
285   mkdir -p "${RPM_BUILD_ROOT}/usr/src/debug"
286   LC_ALL=C sort -z -u "$SOURCEFILE" | grep -E -v -z '(<internal>|<built-in>)$' |
287   (cd "$RPM_BUILD_DIR"; cpio -pd0mL "${RPM_BUILD_ROOT}/usr/src/debug")
288   # stupid cpio creates new directories in mode 0700, fixup
289   find "${RPM_BUILD_ROOT}/usr/src/debug" -type d -print0 |
290   xargs --no-run-if-empty -0 chmod a+rx
291 fi
292
293 if [ -d "${RPM_BUILD_ROOT}/usr/lib" -o -d "${RPM_BUILD_ROOT}/usr/src" ]; then
294   ((nout > 0)) ||
295   test ! -d "${RPM_BUILD_ROOT}/usr/lib" ||
296   (cd "${RPM_BUILD_ROOT}/usr/lib"; find debug -type d) |
297   sed 's,^,%dir /usr/lib/,' >> "$LISTFILE"
298
299   (cd "${RPM_BUILD_ROOT}/usr"
300    test ! -d lib/debug || find lib/debug ! -type d
301    test ! -d src/debug || find src/debug -mindepth 1 -maxdepth 1
302   ) | sed 's,^,/usr/,' >> "$LISTFILE"
303 fi
304
305 # Append to $1 only the lines from stdin not already in the file.
306 append_uniq()
307 {
308   grep -F -f "$1" -x -v >> "$1"
309 }
310
311 # Helper to generate list of corresponding .debug files from a file list.
312 filelist_debugfiles()
313 {
314   local extra="$1"
315   shift
316   sed 's/^%[a-z0-9_][a-z0-9_]*([^)]*) *//
317 s/^%[a-z0-9_][a-z0-9_]* *//
318 /^$/d
319 '"$extra" "$@"
320 }
321
322 # Write an output debuginfo file list based on given input file lists.
323 filtered_list()
324 {
325   local out="$1"
326   shift
327   test $# -gt 0 || return
328   grep -F -f <(filelist_debugfiles 's,^.*$,/usr/lib/debug&.debug,' "$@") \
329         -x $LISTFILE >> $out
330   sed -n -f <(filelist_debugfiles 's/[\\.*+#]/\\&/g
331 h
332 s,^.*$,s# &$##p,p
333 g
334 s,^.*$,s# /usr/lib/debug&.debug$##p,p
335 ' "$@") "$LINKSFILE" | append_uniq "$out"
336 }
337
338 # Write an output debuginfo file list based on an grep -E -style regexp.
339 pattern_list()
340 {
341   local out="$1" ptn="$2"
342   test -n "$ptn" || return
343   grep -E -x -e "$ptn" "$LISTFILE" >> "$out"
344   sed -n -r "\#^$ptn #s/ .*\$//p" "$LINKSFILE" | append_uniq "$out"
345 }
346
347 #
348 # When given multiple -o switches, split up the output as directed.
349 #
350 i=0
351 while ((i < nout)); do
352   > ${outs[$i]}
353   filtered_list ${outs[$i]} ${lists[$i]}
354   pattern_list ${outs[$i]} "${ptns[$i]}"
355   grep -Fvx -f ${outs[$i]} "$LISTFILE" > "${LISTFILE}.new"
356   mv "${LISTFILE}.new" "$LISTFILE"
357   ((++i))
358 done
359 if ((nout > 0)); then
360   # Now add the right %dir lines to each output list.
361   (cd "${RPM_BUILD_ROOT}"; find usr/lib/debug -type d) |
362   sed 's#^.*$#\\@^/&/@{h;s@^.*$@%dir /&@p;g;}#' |
363   LC_ALL=C sort -ur > "${LISTFILE}.dirs.sed"
364   i=0
365   while ((i < nout)); do
366     sed -n -f "${LISTFILE}.dirs.sed" "${outs[$i]}" | sort -u > "${outs[$i]}.new"
367     cat "${outs[$i]}" >> "${outs[$i]}.new"
368     mv -f "${outs[$i]}.new" "${outs[$i]}"
369     ((++i))
370   done
371   sed -n -f "${LISTFILE}.dirs.sed" "${LISTFILE}" | sort -u > "${LISTFILE}.new"
372   cat "$LISTFILE" >> "${LISTFILE}.new"
373   mv "${LISTFILE}.new" "$LISTFILE"
374 fi