2 #find-debuginfo.sh - automagically generate debug info and file list
3 #for inclusion in an rpm spec file.
5 # Usage: find-debuginfo.sh [--strict-build-id] [--strip-disable] [--strip-option] [-g] [-r]
7 # [[-l filelist]... [-p 'pattern'] -o debuginfo.list]
10 # The -g flag says to use strip -g instead of full strip on DSOs.
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.
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 $).
23 # All file names in switches are relative to builddir (. if not given).
26 # With -g arg, pass it to strip on libraries.
29 # with -r arg, pass --reloc-debug-sections to eu-strip.
32 # Barf on missing build IDs.
35 # With --strip-disable arg, no strip
38 # With --strip-option arg, this will be used as arg. of eu-strip
41 # With --strip-option arg for ko file, this will be used as arg. of eu-strip
47 while [ $# -gt 0 ]; do
56 strip_option=$(echo $1 | sed 's/--strip-option=//')
59 strip_ko_option=$(echo $1 | sed 's/--strip-ko-option=//')
65 if [ -z "${lists[$nout]}" -a -z "${ptns[$nout]}" ]; then
74 lists[$nout]="${lists[$nout]} $2"
94 while ((i < nout)); do
95 outs[$i]="$BUILDDIR/${outs[$i]}"
97 for f in ${lists[$i]}; do
104 LISTFILE="$BUILDDIR/$out"
105 SOURCEFILE="$BUILDDIR/debugsources.list"
106 LINKSFILE="$BUILDDIR/debuglinks.list"
112 debugdir="${RPM_BUILD_ROOT}/usr/lib/debug"
113 tooldir=$(rpm --eval %{_rpmconfigdir})
120 if test "$strip_disable" = true ; then
124 $strip_r && r=--reloc-debug-sections
125 $strip_g && case "$(file -bi "$2")" in
126 application/x-sharedlib*) g=-g ;;
131 # don't attempt to create a minimal backtrace binary for
132 # kernel modules as this just causes the stripping process
133 # to be skipped entirely
134 eu-strip --remove-comment $r $strip_ko_option -f "$1" "$2" || exit
137 # Support an alternative way to choose between strip (binutils) and
138 # eu-strip (elfutils) to handle a large shared object (e.g. chromium)
139 if [ "$STRIP_DEFAULT_PACKAGE" != "binutils" ]; then
140 eu-strip --remove-comment $g $strip_option -f "$1" "$2" || exit
143 strip --remove-section=.comment $g $strip_option "$2" || exit
144 objcopy --add-gnu-debuglink="$1" "$2" || exit
147 chmod 444 "$1" || exit
150 # Make a relative symlink to $1 called $3$2
154 local t="$1" f="$2" pfx="$3"
155 local fn="${f#/}" tn="${t#/}"
158 while fd="${fn%%/*}"; td="${tn%%/*}"; [ "$fd" = "$td" ]; do
164 if [ "$d" != "$fn" ]; then
165 d="${d//+([!\/])/..}"
169 mkdir -p "$(dirname "$pfx$f")" && ln -snf "$tn" "$pfx$f"
172 # Make a symlink in /usr/lib/debug/$2 to $1
175 local l="/usr/lib/debug$2"
177 echo >> "$LINKSFILE" "$l $t"
179 # this should correspond to what brp-symlink is doing
182 link_relative "$t" "$l" "$RPM_BUILD_ROOT"
186 link_relative "$t" "$l" "$RPM_BUILD_ROOT"
188 mkdir -p "$(dirname "$RPM_BUILD_ROOT$l")" && \
189 ln -snf "$t" "$RPM_BUILD_ROOT$l"
195 # Provide .2, .3, ... symlinks to all filename instances of this build-id.
198 # See https://bugzilla.redhat.com/show_bug.cgi?id=641377 for the reasoning,
199 # but it has seveal drawbacks as we would need to split the .1 suffixes into
200 # different subpackages and it's about impossible to predict the number
203 local id="$1" file="$2" idfile
207 idfile=".build-id/${id:0:2}/${id:2}.$n"
208 [ $# -eq 3 ] && idfile="${idfile}$3"
209 if [ ! -L "$RPM_BUILD_ROOT/usr/lib/debug/$idfile" ]; then
214 debug_link "$file" "/$idfile"
217 # Compare two binaries but ignore the .note.gnu.build-id section
220 local tmp1=$(mktemp -t ${1##*/}.XXXXXX)
221 local tmp2=$(mktemp -t ${2##*/}.XXXXXX)
223 objcopy -R .note.gnu.build-id -R .gnu_debuglink $1 $tmp1
224 objcopy -R .note.gnu.build-id -R .gnu_debuglink $2 $tmp2
231 # Make a build-id symlink for id $1 with suffix $3 to file $2.
234 local id="$1" file="$2"
235 local idfile=".build-id/${id:0:2}/${id:2}"
236 [ $# -eq 3 ] && idfile="${idfile}$3"
237 local root_idfile="$RPM_BUILD_ROOT/usr/lib/debug/$idfile"
239 if [ ! -L "$root_idfile" ]; then
240 debug_link "$file" "/$idfile"
244 make_id_dup_link "$@"
246 [ $# -eq 3 ] && return 0
248 local other=$(readlink -m "$root_idfile")
249 other=${other#$RPM_BUILD_ROOT}
250 if cmp -s "$RPM_BUILD_ROOT$other" "$RPM_BUILD_ROOT$file" ||
251 elfcmp "$RPM_BUILD_ROOT$other" "$RPM_BUILD_ROOT$file" ; then
252 # Two copies. Maybe one has to be setuid or something.
253 echo >&2 "*** WARNING: identical binaries are copied, not linked:"
255 echo >&2 " and $other"
257 # This is pathological, break the build.
258 echo >&2 "*** ERROR: same build ID in nonidentical files!"
260 echo >&2 " and $other"
267 dn=$(dirname "${1#$RPM_BUILD_ROOT}")
268 # Do not strip existing .debug suffixes
269 bn=$(basename "$1").debug
271 debugdn=${debugdir}${dn}
272 debugfn=${debugdn}/${bn}
278 $strict || strict_error=WARNING
280 # Strip ELF binaries (and no static libraries)
281 find $RPM_BUILD_ROOT ! -path "${debugdir}/*.debug" -type f \( -perm /111 -or -name "*.so*" -or -name "*.ko" \) ! -name "*.a" -print0 | sort -z |
282 xargs --no-run-if-empty -0 stat -c '%h %D_%i %n' |
283 while read nlinks inum f; do
284 case $(objdump -h $f 2>/dev/null | egrep -o '(debug[\.a-z_]*|gnu.version)') in
285 *debuglink*) continue ;;
288 echo "WARNING: "`echo $f | sed -e "s,^$RPM_BUILD_ROOT/*,/,"`" is already stripped!"
294 [ -f "${debugfn}" ] && continue
296 # If this file has multiple links, keep track and make
297 # the corresponding .debug files all links to one file too.
298 if [ $nlinks -gt 1 ]; then
299 eval linked=\$linked_$inum
300 if [ -n "$linked" ]; then
301 eval id=\$linkedid_$inum
302 make_id_dup_link "$id" "$dn/$(basename $f)"
303 make_id_dup_link "$id" "/usr/lib/debug$dn/$bn" .debug
305 get_debugfn "$linked"
306 echo "hard linked $link to $debugfn"
307 mkdir -p "$(dirname "$link")" && ln -nf "$debugfn" "$link"
310 eval linked_$inum=\$f
311 echo "file $f has $[$nlinks - 1] other hard links"
315 echo "extracting debug info from $f"
316 id=$($(DEBUGEDIT=$(which debugedit 2>/dev/null); \
317 echo ${DEBUGEDIT:-${tooldir}/debugedit}) -b "$RPM_BUILD_DIR" \
318 -d /usr/src/debug -i -l "$SOURCEFILE" "$f") || exit
319 if [ $nlinks -gt 1 ]; then
320 eval linkedid_$inum=\$id
322 if [ -z "$id" ]; then
323 echo >&2 "*** ${strict_error}: No build ID note found in $f"
327 [ -x /usr/bin/gdb-add-index ] && /usr/bin/gdb-add-index "$f" > /dev/null 2>&1
329 # A binary already copied into /usr/lib/debug doesn't get stripped,
330 # just has its file names collected and adjusted.
333 [ -z "$id" ] || make_id_link "$id" "$dn/$(basename $f)"
337 mkdir -p "${debugdn}"
338 if [ -e "${BUILDDIR}/Kconfig" ] ; then
339 mode=$(stat -c %a "$f")
341 objcopy --only-keep-debug $f $debugfn || :
344 strip_option="--strip-all"
347 strip_option="--strip-debug" ;;
348 *$STRIP_KEEP_SYMTAB*)
349 if test -n "$STRIP_KEEP_SYMTAB"; then
350 strip_option="--strip-debug"
354 if test "$NO_DEBUGINFO_STRIP_DEBUG" = true ; then
357 if test "$strip_disable" = true ; then
360 objcopy --add-gnu-debuglink=$debugfn -R .comment -R .GCC.command.line $strip_option $f
364 if test -w "$f"; then
365 strip_to_debug "${debugfn}" "$f"
368 strip_to_debug "${debugfn}" "$f"
373 if [ -n "$id" ]; then
374 make_id_link "$id" "$dn/$(basename $f)"
375 make_id_link "$id" "/usr/lib/debug$dn/$bn" .debug
379 # We used to make a .debug symlink for each symlink whose target
380 # has a .debug file to that file. This is not necessary because
381 # the debuglink section contains only the destination of those links.
382 # Creating those links anyway results in debuginfo packages for
383 # devel packages just because of the .so symlinks in them.
385 if [ -s "$SOURCEFILE" ]; then
386 mkdir -p "${RPM_BUILD_ROOT}/usr/src/debug"
387 LC_ALL=C sort -z -u "$SOURCEFILE" | grep -E -v -z '(<internal>|<built-in>)$' |
388 (cd "$RPM_BUILD_DIR"; cpio -pd0mL "${RPM_BUILD_ROOT}/usr/src/debug")
389 # stupid cpio creates new directories in mode 0700, fixup
390 find "${RPM_BUILD_ROOT}/usr/src/debug" -type d -print0 |
391 xargs --no-run-if-empty -0 chmod a+rx
392 find "${RPM_BUILD_ROOT}/usr/src/debug" -type f -print0 |
393 xargs --no-run-if-empty -0 chmod a+r
396 if [ -d "${RPM_BUILD_ROOT}/usr/lib" -o -d "${RPM_BUILD_ROOT}/usr/src" ]; then
398 test ! -d "${RPM_BUILD_ROOT}/usr/lib" ||
399 (cd "${RPM_BUILD_ROOT}/usr/lib"; test ! -d debug || find debug -type d) |
400 sed 's,^,%dir /usr/lib/,' >> "$LISTFILE"
402 (cd "${RPM_BUILD_ROOT}/usr"
403 test ! -d lib/debug || find lib/debug ! -type d
404 ) | sed 's,^,/usr/,' >> "$LISTFILE"
408 if [ -d "${RPM_BUILD_ROOT}/usr/src" ]; then
409 (cd "${RPM_BUILD_ROOT}/usr"
410 test ! -d src/debug || find src/debug -mindepth 1 -maxdepth 1
411 ) | sed 's,^,/usr/,' >> "$SOURCEFILE"
414 # Append to $1 only the lines from stdin not already in the file.
417 grep -F -f "$1" -x -v >> "$1"
420 # Helper to generate list of corresponding .debug files from a file list.
421 filelist_debugfiles()
425 sed 's/^%[a-z0-9_][a-z0-9_]*([^)]*) *//
426 s/^%[a-z0-9_][a-z0-9_]* *//
431 # Write an output debuginfo file list based on given input file lists.
436 test $# -gt 0 || return
437 grep -F -f <(filelist_debugfiles 's,^.*$,/usr/lib/debug&.debug,' "$@") \
439 sed -n -f <(filelist_debugfiles 's/[\\.*+#]/\\&/g
443 s,^.*$,s# /usr/lib/debug&.debug$##p,p
444 ' "$@") "$LINKSFILE" | append_uniq "$out"
447 # Write an output debuginfo file list based on an grep -E -style regexp.
450 local out="$1" ptn="$2"
451 test -n "$ptn" || return
452 grep -E -x -e "$ptn" "$LISTFILE" >> "$out"
453 sed -n -r "\#^$ptn #s/ .*\$//p" "$LINKSFILE" | append_uniq "$out"
457 # When given multiple -o switches, split up the output as directed.
460 while ((i < nout)); do
462 filtered_list ${outs[$i]} ${lists[$i]}
463 pattern_list ${outs[$i]} "${ptns[$i]}"
464 grep -Fvx -f ${outs[$i]} "$LISTFILE" > "${LISTFILE}.new"
465 mv "${LISTFILE}.new" "$LISTFILE"
468 if ((nout > 0)); then
469 # Now add the right %dir lines to each output list.
470 (cd "${RPM_BUILD_ROOT}"; find usr/lib/debug -type d) |
471 sed 's#^.*$#\\@^/&/@{h;s@^.*$@%dir /&@p;g;}#' |
472 LC_ALL=C sort -ur > "${LISTFILE}.dirs.sed"
474 while ((i < nout)); do
475 sed -n -f "${LISTFILE}.dirs.sed" "${outs[$i]}" | sort -u > "${outs[$i]}.new"
476 cat "${outs[$i]}" >> "${outs[$i]}.new"
477 mv -f "${outs[$i]}.new" "${outs[$i]}"
480 sed -n -f "${LISTFILE}.dirs.sed" "${LISTFILE}" | sort -u > "${LISTFILE}.new"
481 cat "$LISTFILE" >> "${LISTFILE}.new"
482 mv "${LISTFILE}.new" "$LISTFILE"