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] [--strip-disable] [--strip-option] [-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.
  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.
  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 # With --strip-disable arg, no strip
  36 strip_disable=false
  37
  38 # With --strip-option arg, this will be used as arg. of eu-strip
  39 strip_option=
  40
  41 # With --strip-option arg for ko file, this will be used as arg. of eu-strip
  42 strip_ko_option=
  43
  44 BUILDDIR=.
  45 out=debugfiles.list
  46 nout=0
  47 while [ $# -gt 0 ]; do
  48   case "$1" in
  49   --strict-build-id)
  50     strict=true
  51     ;;
  52   --strip-disable)
  53     strip_disable=true
  54     ;;
  55   *--strip-option*)
  56     strip_option=$(echo $1 | sed 's/--strip-option=//')
  57     ;;
  58   *--strip-ko-option*)
  59     strip_ko_option=$(echo $1 | sed 's/--strip-ko-option=//')
  60    ;;
  61   -g)
  62     strip_g=true
  63     ;;
  64   -o)
  65     if [ -z "${lists[$nout]}" -a -z "${ptns[$nout]}" ]; then
  66       out=$2
  67     else
  68       outs[$nout]=$2
  69       ((nout++))
  70     fi
  71     shift
  72     ;;
  73   -l)
  74     lists[$nout]="${lists[$nout]} $2"
  75     shift
  76     ;;
  77   -p)
  78     ptns[$nout]=$2
  79     shift
  80     ;;
  81   -r)
  82     strip_r=true
  83     ;;
  84   *)
  85     BUILDDIR=$1
  86     shift
  87     break
  88     ;;
  89   esac
  90   shift
  91 done
  92
  93 i=0
  94 while ((i < nout)); do
  95   outs[$i]="$BUILDDIR/${outs[$i]}"
  96   l=''
  97   for f in ${lists[$i]}; do
  98     l="$l $BUILDDIR/$f"
  99   done
 100   lists[$i]=$l
 101   ((++i))
 102 done
 103
 104 LISTFILE="$BUILDDIR/$out"
 105 SOURCEFILE="$BUILDDIR/debugsources.list"
 106 LINKSFILE="$BUILDDIR/debuglinks.list"
 107
 108 > "$SOURCEFILE"
 109 > "$LISTFILE"
 110 > "$LINKSFILE"
 111
 112 debugdir="${RPM_BUILD_ROOT}/usr/lib/debug"
 113 tooldir=$(rpm --eval %{_rpmconfigdir})
 114
 115 strip_to_debug()
 116 {
 117   local g=
 118   local r=
 119
 120   if test "$strip_disable" = true ; then
 121       exit
 122   fi
 123
 124   $strip_r && r=--reloc-debug-sections
 125   $strip_g && case "$(file -bi "$2")" in
 126   application/x-sharedlib*) g=-g ;;
 127   esac
 128
 129   case $2 in
 130       *.ko)
 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
 135           ;;
 136       *)
 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
 141           else
 142               mv $2 $1
 143               strip --remove-section=.comment $g $strip_option -o "$2" "$1" || exit
 144           fi
 145   esac
 146   chmod 444 "$1" || exit
 147 }
 148
 149 # Make a relative symlink to $1 called $3$2
 150 shopt -s extglob
 151 link_relative()
 152 {
 153   local t="$1" f="$2" pfx="$3"
 154   local fn="${f#/}" tn="${t#/}"
 155   local fd td d
 156
 157   while fd="${fn%%/*}"; td="${tn%%/*}"; [ "$fd" = "$td" ]; do
 158     fn="${fn#*/}"
 159     tn="${tn#*/}"
 160   done
 161
 162   d="${fn%/*}"
 163   if [ "$d" != "$fn" ]; then
 164     d="${d//+([!\/])/..}"
 165     tn="${d}/${tn}"
 166   fi
 167
 168   mkdir -p "$(dirname "$pfx$f")" && ln -snf "$tn" "$pfx$f"
 169 }
 170
 171 # Make a symlink in /usr/lib/debug/$2 to $1
 172 debug_link()
 173 {
 174   local l="/usr/lib/debug$2"
 175   local t="$1"
 176   echo >> "$LINKSFILE" "$l $t"
 177
 178   # this should correspond to what brp-symlink is doing
 179   case $t in
 180       /usr*)
 181           link_relative "$t" "$l" "$RPM_BUILD_ROOT"
 182           ;;
 183       *)
 184           if [ ! -e $t ]; then
 185               link_relative "$t" "$l" "$RPM_BUILD_ROOT"
 186           else
 187               mkdir -p "$(dirname "$RPM_BUILD_ROOT$l")" && \
 188                   ln -snf "$t" "$RPM_BUILD_ROOT$l"
 189           fi
 190           ;;
 191   esac
 192 }
 193
 194 # Provide .2, .3, ... symlinks to all filename instances of this build-id.
 195 make_id_dup_link()
 196 {
 197   # See https://bugzilla.redhat.com/show_bug.cgi?id=641377 for the reasoning,
 198   # but it has seveal drawbacks as we would need to split the .1 suffixes into
 199   # different subpackages and it's about impossible to predict the number
 200   # -> perhaps later
 201   return
 202   local id="$1" file="$2" idfile
 203
 204   local n=1
 205   while true; do
 206     idfile=".build-id/${id:0:2}/${id:2}.$n"
 207     [ $# -eq 3 ] && idfile="${idfile}$3"
 208     if [ ! -L "$RPM_BUILD_ROOT/usr/lib/debug/$idfile" ]; then
 209       break
 210     fi
 211     n=$[$n+1]
 212   done
 213   debug_link "$file" "/$idfile"
 214 }
 215
 216 # Compare two binaries but ignore the .note.gnu.build-id section
 217 elfcmp()
 218 {
 219   local tmp1=$(mktemp -t ${1##*/}.XXXXXX)
 220   local tmp2=$(mktemp -t ${2##*/}.XXXXXX)
 221
 222   objcopy -R .note.gnu.build-id -R .gnu_debuglink $1 $tmp1
 223   objcopy -R .note.gnu.build-id -R .gnu_debuglink $2 $tmp2
 224   cmp -s $tmp1 $tmp2
 225   local res=$?
 226   rm -f $tmp1 $tmp2
 227   return $res
 228 }
 229
 230 # Make a build-id symlink for id $1 with suffix $3 to file $2.
 231 make_id_link()
 232 {
 233   local id="$1" file="$2"
 234   local idfile=".build-id/${id:0:2}/${id:2}"
 235   [ $# -eq 3 ] && idfile="${idfile}$3"
 236   local root_idfile="$RPM_BUILD_ROOT/usr/lib/debug/$idfile"
 237
 238   if [ ! -L "$root_idfile" ]; then
 239     debug_link "$file" "/$idfile"
 240     return
 241   fi
 242
 243   make_id_dup_link "$@"
 244
 245   [ $# -eq 3 ] && return 0
 246
 247   local other=$(readlink -m "$root_idfile")
 248   other=${other#$RPM_BUILD_ROOT}
 249   if cmp -s "$RPM_BUILD_ROOT$other" "$RPM_BUILD_ROOT$file" ||
 250      elfcmp "$RPM_BUILD_ROOT$other" "$RPM_BUILD_ROOT$file" ; then
 251     # Two copies.  Maybe one has to be setuid or something.
 252     echo >&2 "*** WARNING: identical binaries are copied, not linked:"
 253     echo >&2 "        $file"
 254     echo >&2 "   and  $other"
 255   else
 256     # This is pathological, break the build.
 257     echo >&2 "*** ERROR: same build ID in nonidentical files!"
 258     echo >&2 "        $file"
 259     echo >&2 "   and  $other"
 260     exit 2
 261   fi
 262 }
 263
 264 get_debugfn()
 265 {
 266   dn=$(dirname "${1#$RPM_BUILD_ROOT}")
 267 # Do not strip existing .debug suffixes
 268   bn=$(basename "$1").debug
 269
 270   debugdn=${debugdir}${dn}
 271   debugfn=${debugdn}/${bn}
 272 }
 273
 274 set -o pipefail
 275
 276 strict_error=ERROR
 277 $strict || strict_error=WARNING
 278
 279 # Strip ELF binaries (and no static libraries)
 280 find $RPM_BUILD_ROOT ! -path "${debugdir}/*.debug" -type f \( -perm /111 -or -name "*.so*" -or -name "*.ko" \) ! -name "*.a" -print0 | sort -z |
 281 xargs --no-run-if-empty -0 stat -c '%h %D_%i %n' |
 282 while read nlinks inum f; do
 283   case $(objdump -h $f 2>/dev/null | egrep -o '(debug[\.a-z_]*|gnu.version)') in
 284     *debuglink*) continue ;;
 285     *debug*) ;;
 286     *gnu.version*)
 287         echo "WARNING: "`echo $f | sed -e "s,^$RPM_BUILD_ROOT/*,/,"`" is already stripped!"
 288         continue
 289         ;;
 290     *) continue ;;
 291   esac
 292   get_debugfn "$f"
 293   [ -f "${debugfn}" ] && continue
 294
 295   # If this file has multiple links, keep track and make
 296   # the corresponding .debug files all links to one file too.
 297   if [ $nlinks -gt 1 ]; then
 298     eval linked=\$linked_$inum
 299     if [ -n "$linked" ]; then
 300       eval id=\$linkedid_$inum
 301       make_id_dup_link "$id" "$dn/$(basename $f)"
 302       make_id_dup_link "$id" "/usr/lib/debug$dn/$bn" .debug
 303       link=$debugfn
 304       get_debugfn "$linked"
 305       echo "hard linked $link to $debugfn"
 306       mkdir -p "$(dirname "$link")" && ln -nf "$debugfn" "$link"
 307       continue
 308     else
 309       eval linked_$inum=\$f
 310       echo "file $f has $[$nlinks - 1] other hard links"
 311     fi
 312   fi
 313
 314   echo "extracting debug info from $f"
 315   id=$($(DEBUGEDIT=$(which debugedit 2>/dev/null); \
 316       echo ${DEBUGEDIT:-${tooldir}/debugedit}) -b "$RPM_BUILD_DIR" \
 317       -d /usr/src/debug -i -l "$SOURCEFILE" "$f") || exit
 318   if [ $nlinks -gt 1 ]; then
 319     eval linkedid_$inum=\$id
 320   fi
 321   if [ -z "$id" ]; then
 322     echo >&2 "*** ${strict_error}: No build ID note found in $f"
 323     $strict && exit 2
 324   fi
 325
 326   [ -x /usr/bin/gdb-add-index ] && /usr/bin/gdb-add-index "$f" > /dev/null 2>&1
 327
 328   # A binary already copied into /usr/lib/debug doesn't get stripped,
 329   # just has its file names collected and adjusted.
 330   case "$dn" in
 331   /usr/lib/debug/*)
 332     [ -z "$id" ] || make_id_link "$id" "$dn/$(basename $f)"
 333     continue ;;
 334   esac
 335
 336   mkdir -p "${debugdn}"
 337   if [ -e "${BUILDDIR}/Kconfig" ] ; then
 338       mode=$(stat -c %a "$f")
 339       chmod +w "$f"
 340       objcopy --only-keep-debug $f $debugfn || :
 341       (
 342           shopt -s extglob
 343           strip_option="--strip-all"
 344           case "$f" in
 345               *.ko)
 346                   strip_option="--strip-debug" ;;
 347               *$STRIP_KEEP_SYMTAB*)
 348                   if test -n "$STRIP_KEEP_SYMTAB"; then
 349                       strip_option="--strip-debug"
 350                   fi
 351                   ;;
 352           esac
 353           if test "$NO_DEBUGINFO_STRIP_DEBUG" = true ; then
 354               strip_option=
 355           fi
 356           if test "$strip_disable" = true ; then
 357               strip_option=
 358           fi
 359           objcopy --add-gnu-debuglink=$debugfn -R .comment -R .GCC.command.line $strip_option $f
 360           chmod $mode $f
 361       ) || :
 362   else
 363       if test -w "$f"; then
 364           strip_to_debug "${debugfn}" "$f"
 365       else
 366           chmod u+w "$f"
 367           strip_to_debug "${debugfn}" "$f"
 368           chmod u-w "$f"
 369       fi
 370   fi
 371
 372   if [ -n "$id" ]; then
 373     make_id_link "$id" "$dn/$(basename $f)"
 374     make_id_link "$id" "/usr/lib/debug$dn/$bn" .debug
 375   fi
 376 done || exit
 377
 378 # We used to make a .debug symlink for each symlink whose target
 379 # has a .debug file to that file.  This is not necessary because
 380 # the debuglink section contains only the destination of those links.
 381 # Creating those links anyway results in debuginfo packages for
 382 # devel packages just because of the .so symlinks in them.
 383
 384 if [ -s "$SOURCEFILE" ]; then
 385   mkdir -p "${RPM_BUILD_ROOT}/usr/src/debug"
 386   LC_ALL=C sort -z -u "$SOURCEFILE" | grep -E -v -z '(<internal>|<built-in>)$' |
 387   (cd "$RPM_BUILD_DIR"; cpio -pd0mL "${RPM_BUILD_ROOT}/usr/src/debug")
 388   # stupid cpio creates new directories in mode 0700, fixup
 389   find "${RPM_BUILD_ROOT}/usr/src/debug" -type d -print0 |
 390   xargs --no-run-if-empty -0 chmod a+rx
 391   find "${RPM_BUILD_ROOT}/usr/src/debug" -type f -print0 |
 392   xargs --no-run-if-empty -0 chmod a+r
 393 fi
 394
 395 if [ -d "${RPM_BUILD_ROOT}/usr/lib" -o -d "${RPM_BUILD_ROOT}/usr/src" ]; then
 396   ((nout > 0)) ||
 397   test ! -d "${RPM_BUILD_ROOT}/usr/lib" ||
 398   (cd "${RPM_BUILD_ROOT}/usr/lib"; test ! -d debug || find debug -type d) |
 399   sed 's,^,%dir /usr/lib/,' >> "$LISTFILE"
 400
 401   (cd "${RPM_BUILD_ROOT}/usr"
 402    test ! -d lib/debug || find lib/debug ! -type d
 403   ) | sed 's,^,/usr/,' >> "$LISTFILE"
 404 fi
 405
 406 : > "$SOURCEFILE"
 407 if [ -d "${RPM_BUILD_ROOT}/usr/src" ]; then
 408   (cd "${RPM_BUILD_ROOT}/usr"
 409    test ! -d src/debug || find src/debug -mindepth 1 -maxdepth 1
 410   ) | sed 's,^,/usr/,' >> "$SOURCEFILE"
 411 fi
 412
 413 # Append to $1 only the lines from stdin not already in the file.
 414 append_uniq()
 415 {
 416   grep -F -f "$1" -x -v >> "$1"
 417 }
 418
 419 # Helper to generate list of corresponding .debug files from a file list.
 420 filelist_debugfiles()
 421 {
 422   local extra="$1"
 423   shift
 424   sed 's/^%[a-z0-9_][a-z0-9_]*([^)]*) *//
 425 s/^%[a-z0-9_][a-z0-9_]* *//
 426 /^$/d
 427 '"$extra" "$@"
 428 }
 429
 430 # Write an output debuginfo file list based on given input file lists.
 431 filtered_list()
 432 {
 433   local out="$1"
 434   shift
 435   test $# -gt 0 || return
 436   grep -F -f <(filelist_debugfiles 's,^.*$,/usr/lib/debug&.debug,' "$@") \
 437         -x $LISTFILE >> $out
 438   sed -n -f <(filelist_debugfiles 's/[\\.*+#]/\\&/g
 439 h
 440 s,^.*$,s# &$##p,p
 441 g
 442 s,^.*$,s# /usr/lib/debug&.debug$##p,p
 443 ' "$@") "$LINKSFILE" | append_uniq "$out"
 444 }
 445
 446 # Write an output debuginfo file list based on an grep -E -style regexp.
 447 pattern_list()
 448 {
 449   local out="$1" ptn="$2"
 450   test -n "$ptn" || return
 451   grep -E -x -e "$ptn" "$LISTFILE" >> "$out"
 452   sed -n -r "\#^$ptn #s/ .*\$//p" "$LINKSFILE" | append_uniq "$out"
 453 }
 454
 455 #
 456 # When given multiple -o switches, split up the output as directed.
 457 #
 458 i=0
 459 while ((i < nout)); do
 460   > ${outs[$i]}
 461   filtered_list ${outs[$i]} ${lists[$i]}
 462   pattern_list ${outs[$i]} "${ptns[$i]}"
 463   grep -Fvx -f ${outs[$i]} "$LISTFILE" > "${LISTFILE}.new"
 464   mv "${LISTFILE}.new" "$LISTFILE"
 465   ((++i))
 466 done
 467 if ((nout > 0)); then
 468   # Now add the right %dir lines to each output list.
 469   (cd "${RPM_BUILD_ROOT}"; find usr/lib/debug -type d) |
 470   sed 's#^.*$#\\@^/&/@{h;s@^.*$@%dir /&@p;g;}#' |
 471   LC_ALL=C sort -ur > "${LISTFILE}.dirs.sed"
 472   i=0
 473   while ((i < nout)); do
 474     sed -n -f "${LISTFILE}.dirs.sed" "${outs[$i]}" | sort -u > "${outs[$i]}.new"
 475     cat "${outs[$i]}" >> "${outs[$i]}.new"
 476     mv -f "${outs[$i]}.new" "${outs[$i]}"
 477     ((++i))
 478   done
 479   sed -n -f "${LISTFILE}.dirs.sed" "${LISTFILE}" | sort -u > "${LISTFILE}.new"
 480   cat "$LISTFILE" >> "${LISTFILE}.new"
 481   mv "${LISTFILE}.new" "$LISTFILE"
 482 fi