bin/check-elf-dynamic-objects

   1 #!/bin/bash
   2 #
   3 # This file is part of the LibreOffice project.
   4 #
   5 # This Source Code Form is subject to the terms of the Mozilla Public
   6 # License, v. 2.0. If a copy of the MPL was not distributed with this
   7 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8 #
   9
  10 # verify that ELF NEEDED entries are known-good so hopefully builds run on
  11 # lots of different GNU/Linux distributions
  12
  13 set -euo pipefail
  14
  15 PARA=1
  16 check_path="${INSTDIR:-.}"
  17
  18 help()
  19 {
  20     cat << "EOF"
  21     -d <dir>  directory to check
  22     -p        run unbound parallel checks
  23     -h        help
  24 EOF
  25     [ -z "${1:-}" ] && exit 0
  26 }
  27
  28 die()
  29 {
  30     echo "$1"
  31     echo
  32     help 1
  33     exit 1
  34 }
  35
  36 while [ "${1:-}" != "" ]; do
  37     parm=${1%%=*}
  38     arg=${1#*=}
  39     has_arg=
  40     if [ "${1}" != "${parm?}" ] ; then
  41         has_arg=1
  42     else
  43         arg=""
  44     fi
  45
  46     case "${parm}" in
  47         --dir|-d)
  48             if [ "$has_arg" ] ; then
  49                 check_path="$arg"
  50             else
  51                 shift
  52                 check_path="$1"
  53             fi
  54             if [ ! -d "$check_path" ]; then
  55                 die "Invalid directory '$check_path'"
  56             fi
  57             ;;
  58         -h)
  59             help
  60             ;;
  61         -p)
  62             # this sounds counter intuitive but the idea
  63             # is to possibly support -p <n>
  64             # in the meantime: 0 = nolimit and -p 1 would mean
  65             # the current default: serialize
  66             PARA=0
  67             ;;
  68         -*)
  69             die "Invalid option $1"
  70             ;;
  71         *)
  72             if [ "$DO_NEW" = 1 ] ; then
  73                 REPO="$1"
  74             else
  75                 die "Invalid argument $1"
  76             fi
  77             ;;
  78     esac
  79     shift
  80 done
  81
  82
  83 files=$(find "${check_path}/program" "${check_path}/sdk/bin" -type f)
  84 # all RPATHs should point to ${INSTDIR}/program so that's the files they find
  85 programfiles=$(echo ${files} | grep -o '/program/[^/]* ' | xargs -n 1 basename)
  86
  87 # whitelists should contain only system libraries that have a good reputation
  88 # of maintaining ABI stability
  89 # allow extending the whitelist using the environment variable to be able to work
  90 # on the installer stuff without the need for a baseline setup
  91 globalwhitelist="ld-linux-x86-64.so.2 ld-linux.so.2 libc.so.6 libm.so.6 libdl.so.2 libpthread.so.0 librt.so.1 libutil.so.1 libnsl.so.1 libcrypt.so.1 libgcc_s.so.1 libstdc++.so.6 libz.so.1 libfontconfig.so.1 libfreetype.so.6 libxml2.so.2 libxslt.so.1 libexslt.so.0 ${LO_ELFCHECK_WHITELIST-}"
  92 x11whitelist="libX11.so.6 libXext.so.6 libSM.so.6 libICE.so.6 libXinerama.so.1 libXrender.so.1 libXrandr.so.2 libcairo.so.2"
  93 openglwhitelist="libGL.so.1"
  94 giowhitelist="libgio-2.0.so.0 libgobject-2.0.so.0 libgmodule-2.0.so.0 libgthread-2.0.so.0 libglib-2.0.so.0 libdbus-glib-1.so.2 libdbus-1.so.3"
  95 gstreamerwhitelist="libgstaudio-1.0.so.0 libgstpbutils-1.0.so.0 libgstvideo-1.0.so.0 libgstbase-1.0.so.0 libgstreamer-1.0.so.0"
  96 gtk3whitelist="libgtk-3.so.0 libgdk-3.so.0 libcairo-gobject.so.2 libpangocairo-1.0.so.0 libfribidi.so.0 libatk-1.0.so.0 libcairo.so.2 libgio-2.0.so.0 libpangoft2-1.0.so.0 libpango-1.0.so.0 libfontconfig.so.1 libfreetype.so.6 libgdk_pixbuf-2.0.so.0 libgobject-2.0.so.0 libglib-2.0.so.0 libgmodule-2.0.so.0 libgthread-2.0.so.0 libdbus-glib-1.so.2 libdbus-1.so.3 libharfbuzz.so.0"
  97 qt5whitelist="libQt5Core.so.5 libQt5Gui.so.5 libQt5Network.so.5 libQt5Widgets.so.5 libQt5X11Extras.so.5 libcairo.so.2 libglib-2.0.so.0 libgobject-2.0.so.0 libxcb.so.1 libxcb-icccm.so.4"
  98 kf5whitelist="libKF5ConfigCore.so.5 libKF5CoreAddons.so.5 libKF5I18n.so.5 libKF5KIOCore.so.5 libKF5KIOFileWidgets.so.5 libKF5KIOWidgets.so.5 libKF5WindowSystem.so.5"
  99 avahiwhitelist="libdbus-glib-1.so.2 libdbus-1.so.3 libgobject-2.0.so.0 libgmodule-2.0.so.0 libgthread-2.0.so.0 libglib-2.0.so.0 libavahi-common.so.3 libavahi-client.so.3"
 100 kerberoswhitelist="libgssapi_krb5.so.2 libcom_err.so.2 libkrb5.so.3"
 101 dconfwhitelist="libdconf.so.1 libgio-2.0.so.0 libglib-2.0.so.0 libgobject-2.0.so.0"
 102
 103 check_one_file()
 104 {
 105 local file="$1"
 106
 107     skip=0
 108     whitelist="${globalwhitelist}"
 109     case "${file}" in
 110         */sdk/docs/*)
 111             # skip the majority of files, no ELF binaries here
 112             skip=1
 113         ;;
 114         */_uuid.cpython-*.so)
 115             whitelist="${whitelist} libuuid.so.1"
 116         ;;
 117         */libcairo.so.2)
 118             whitelist="${whitelist} ${x11whitelist} libxcb-shm.so.0 libxcb.so.1 libxcb-render.so.0"
 119         ;;
 120         */libcairocanvaslo.so)
 121             whitelist="${whitelist} libcairo.so.2"
 122         ;;
 123         */libucpgio1lo.so|*/liblosessioninstalllo.so|*/libevoablo.so)
 124             whitelist="${whitelist} ${giowhitelist}"
 125         ;;
 126         */libavmediagst.so)
 127             whitelist="${whitelist} ${gtk3whitelist} ${gstreamerwhitelist}"
 128         ;;
 129         */libvclplug_kf5lo.so|*/libkf5be1lo.so)
 130             if [ "$ENABLE_KF5" = TRUE ]; then
 131                 whitelist="${whitelist} ${qt5whitelist} ${kf5whitelist}"
 132             fi
 133         ;;
 134         */libvclplug_gtk3lo.so|*/updater)
 135             whitelist="${whitelist} ${x11whitelist} ${gtk3whitelist}"
 136         ;;
 137         */libvclplug_qt5lo.so)
 138             if [ "$ENABLE_QT5" = TRUE ]; then
 139                 whitelist="${whitelist} ${qt5whitelist}"
 140             fi
 141         ;;
 142         */libvclplug_gtk3_kde5lo.so)
 143             if [ "$ENABLE_GTK3_KDE5" = TRUE ]; then
 144                 whitelist="${whitelist} ${x11whitelist} ${gtk3whitelist} ${qt5whitelist} ${kf5whitelist}"
 145             fi
 146         ;;
 147         */lo_kde5filepicker)
 148             if [ "$ENABLE_GTK3_KDE5" = TRUE ]; then
 149                 whitelist="${whitelist} ${x11whitelist} ${gtk3whitelist} ${qt5whitelist} \
 150                     ${kf5whitelist}"
 151             fi
 152         ;;
 153         */libdesktop_detectorlo.so|*/ui-previewer|*/oosplash|*/gengal.bin)
 154             whitelist="${whitelist} ${x11whitelist}"
 155         ;;
 156         */libvclplug_genlo.so|*/libchartcorelo.so|*/libavmediaogl.so|*/libOGLTranslo.so|*/liboglcanvaslo.so)
 157             whitelist="${whitelist} ${x11whitelist} ${openglwhitelist}"
 158         ;;
 159         */libvcllo.so)
 160             whitelist="${whitelist} ${x11whitelist} ${openglwhitelist} ${giowhitelist} libcups.so.2"
 161         ;;
 162         */libsofficeapp.so)
 163             whitelist="${whitelist} ${x11whitelist} ${openglwhitelist} ${giowhitelist} libcups.so.2"
 164         ;;
 165         */liblibreofficekitgtk.so)
 166             whitelist="${whitelist} ${gtk3whitelist}"
 167         ;;
 168         */libsdlo.so)
 169             whitelist="${whitelist} ${avahiwhitelist}"
 170         ;;
 171         */libofficebean.so)
 172             whitelist="${whitelist} libjawt.so"
 173         ;;
 174         */libpostgresql-sdbc-impllo.so)
 175             whitelist="${whitelist} ${kerberoswhitelist}"
 176         ;;
 177         */libconfigmgrlo.so)
 178             if [ "$ENABLE_DCONF" = TRUE ]; then
 179                 whitelist="${whitelist} ${dconfwhitelist}"
 180             fi
 181         ;;
 182         */libmergedlo.so)
 183             whitelist="${whitelist} ${x11whitelist} ${openglwhitelist} ${giowhitelist} libcups.so.2 libcairo.so.2"
 184         ;;
 185     esac
 186     if test "${skip}" = 0 && readelf -d "${file}" &> /dev/null ; then
 187         rpath=$(readelf -d "${file}" | grep '(\(RPATH\|RUNPATH\))' || true)
 188         neededs=$(readelf -d "${file}" | grep '(NEEDED)' | sed -e 's/.*\[\(.*\)\]$/\1/')
 189         neededsinternal=
 190         for needed in ${neededs}
 191         do
 192             if ! echo ${whitelist} | grep -q -w "${needed}" ; then
 193                 neededsinternal="${neededsinternal} ${needed}"
 194                 if ! echo ${programfiles} | grep -q -w "${needed}" ; then
 195                     echo "${file}" has suspicious NEEDED: "${needed}"
 196                     status=1
 197                 fi
 198             fi
 199         done
 200         if test -z "${rpath}" ; then
 201             case "${file}" in
 202                 */python-core-*/lib/lib-dynload/*)
 203                     # python modules don't have RPATH
 204                 ;;
 205                 */share/extensions/*)
 206                     # extension libraries don't have RPATH
 207                 ;;
 208                 *)
 209                     # no NEEDED from instdir, no RPATH needed
 210                     if test -n "${neededsinternal}" ; then
 211                         echo "${file}" has no RPATH
 212                         status=1
 213                     fi
 214                 ;;
 215             esac
 216         else
 217             case "$file" in
 218                 */sdk/bin/*)
 219                     if echo "${rpath}" | grep -q -v '\[\$ORIGIN/../../program\]$' ; then
 220                         echo "${file}" has unexpected RPATH "${rpath}"
 221                         status=1
 222                     fi
 223                 ;;
 224                 *)
 225                     if echo "${rpath}" | grep -q -v '\[\$ORIGIN\]$' ; then
 226                         echo "${file}" has unexpected RPATH "${rpath}"
 227                         status=1
 228                     fi
 229                 ;;
 230             esac
 231         fi
 232     fi
 233 }
 234 status=0
 235
 236 if [ "$PARA" = "1" ] ; then
 237     for file in ${files}
 238     do
 239         check_one_file $file
 240     done
 241 else
 242     rm -f check_elf.out
 243     for file in ${files}
 244     do
 245         (
 246         check_one_file $file
 247         )>> check_elf.out &
 248     done
 249
 250     wait
 251
 252     if [ -s check_elf.out ] ; then
 253         cat check_elf.out
 254         status=1
 255     fi
 256     rm check_elf.out
 257 fi
 258 exit ${status}
 259