scripts/babeltrace/build.sh

   1 #!/bin/bash
   2 #
   3 # Copyright (C) 2015 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
   4 # Copyright (C) 2016-2020 Michael Jeanson <mjeanson@efficios.com>
   5 #
   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 set -exu
  20
  21 # Version compare functions
  22 vercomp () {
  23     set +u
  24     if [[ "$1" == "$2" ]]; then
  25         return 0
  26     fi
  27     local IFS=.
  28     # Ignore the shellcheck warning, we want splitting to happen based on IFS.
  29     # shellcheck disable=SC2206
  30     local i ver1=($1) ver2=($2)
  31     # fill empty fields in ver1 with zeros
  32     for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
  33         ver1[i]=0
  34     done
  35     for ((i=0; i<${#ver1[@]}; i++)); do
  36         if [[ -z ${ver2[i]} ]]; then
  37             # fill empty fields in ver2 with zeros
  38             ver2[i]=0
  39         fi
  40         if ((10#${ver1[i]} > 10#${ver2[i]})); then
  41             return 1
  42         fi
  43         if ((10#${ver1[i]} < 10#${ver2[i]})); then
  44             return 2
  45         fi
  46     done
  47     set -u
  48     return 0
  49 }
  50
  51 # Shellcheck flags the following functions that are unused as "unreachable",
  52 # ignore that.
  53
  54 # shellcheck disable=SC2317
  55 verlte() {
  56     vercomp "$1" "$2"
  57     local res="$?"
  58     [ "$res" -eq "0" ] || [ "$res" -eq "2" ]
  59 }
  60
  61 # shellcheck disable=SC2317
  62 verlt() {
  63     vercomp "$1" "$2"; local res="$?"
  64     [ "$res" -eq "2" ]
  65 }
  66
  67 # shellcheck disable=SC2317
  68 vergte() {
  69     vercomp "$1" "$2"; local res="$?"
  70     [ "$res" -eq "0" ] || [ "$res" -eq "1" ]
  71 }
  72
  73 # shellcheck disable=SC2317
  74 vergt() {
  75     vercomp "$1" "$2"; local res="$?"
  76     [ "$res" -eq "1" ]
  77 }
  78
  79 # shellcheck disable=SC2317
  80 verne() {
  81     vercomp "$1" "$2"; local res="$?"
  82     [ "$res" -ne "0" ]
  83 }
  84
  85 failed_configure() {
  86     # Assume we are in the configured build directory
  87     echo "#################### BEGIN config.log ####################"
  88     cat config.log
  89     echo "#################### END config.log ####################"
  90     exit 1
  91 }
  92
  93
  94 # Required variables
  95 WORKSPACE=${WORKSPACE:-}
  96
  97 platform=${platform:-}
  98 conf=${conf:-}
  99 build=${build:-}
 100 cc=${cc:-}
 101
 102 # Controls if the tests are run
 103 BABELTRACE_RUN_TESTS="${BABELTRACE_RUN_TESTS:=yes}"
 104
 105 SRCDIR="$WORKSPACE/src/babeltrace"
 106 TMPDIR="$WORKSPACE/tmp"
 107 PREFIX="/build"
 108 LIBDIR="lib"
 109
 110 # RHEL and SLES both use lib64 but don't bother shipping a default autoconf
 111 # site config that matches this.
 112 if [[ ( -f /etc/redhat-release || -f /etc/SuSE-release ) && ( "$(uname -m)" == "x86_64" ) ]]; then
 113     LIBDIR_ARCH="${LIBDIR}64"
 114 else
 115     LIBDIR_ARCH="$LIBDIR"
 116 fi
 117
 118 # Create tmp directory
 119 rm -rf "$TMPDIR"
 120 mkdir -p "$TMPDIR"
 121
 122 export TMPDIR
 123 export CFLAGS="-g -O2"
 124
 125 # Set compiler variables
 126 case "$cc" in
 127 gcc)
 128     export CC=gcc
 129     export CXX=g++
 130     ;;
 131 gcc-*)
 132     export CC=gcc-${cc#gcc-}
 133     export CXX=g++-${cc#gcc-}
 134     ;;
 135 clang)
 136     export CC=clang
 137     export CXX=clang++
 138     ;;
 139 clang-*)
 140     export CC=clang-${cc#clang-}
 141     export CXX=clang++-${cc#clang-}
 142     ;;
 143 *)
 144     if [ "x$cc" != "x" ]; then
 145             export CC="$cc"
 146     fi
 147     ;;
 148 esac
 149
 150 if [ "x${CC:-}" != "x" ]; then
 151     echo "Selected compiler:"
 152     "$CC" -v
 153 fi
 154
 155 # Set platform variables
 156 case "$platform" in
 157 macos*)
 158     export MAKE=make
 159     export TAR=tar
 160     export NPROC="getconf _NPROCESSORS_ONLN"
 161     export PATH="/opt/local/bin:/opt/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
 162     export CPPFLAGS="-I/opt/local/include"
 163     export LDFLAGS="-L/opt/local/lib"
 164     export PYTHON="python3"
 165     export PYTHON_CONFIG="python3-config"
 166     ;;
 167
 168 freebsd*)
 169     export MAKE=gmake
 170     export TAR=tar
 171     export NPROC="getconf _NPROCESSORS_ONLN"
 172     export CPPFLAGS="-I/usr/local/include"
 173     export LDFLAGS="-L/usr/local/lib"
 174     export PYTHON="python3"
 175     export PYTHON_CONFIG="python3-config"
 176
 177     # For bt 1.5
 178     export YACC="bison -y"
 179     ;;
 180
 181 *)
 182     export MAKE=make
 183     export TAR=tar
 184     export NPROC=nproc
 185     export PYTHON="python3"
 186     export PYTHON_CONFIG="python3-config"
 187     ;;
 188 esac
 189
 190 # Print build env details
 191 print_os || true
 192 print_tooling || true
 193
 194 # Enter the source directory
 195 cd "$SRCDIR"
 196
 197 # Run bootstrap in the source directory prior to configure
 198 ./bootstrap
 199
 200 # Get source version from configure script
 201 eval "$(grep '^PACKAGE_VERSION=' ./configure)"
 202 PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
 203
 204 # Enable dev mode by default for BT 2.0 builds
 205 export BABELTRACE_DEBUG_MODE=1
 206 export BABELTRACE_DEV_MODE=1
 207 export BABELTRACE_MINIMAL_LOG_LEVEL=TRACE
 208
 209 # Set configure options and environment variables for each build
 210 # configuration.
 211 CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH")
 212
 213 # -Werror is enabled by default in stable-2.0 but won't be in 2.1
 214 # Explicitly disable it for consistency.
 215 if vergte "$PACKAGE_VERSION" "2.0"; then
 216         CONF_OPTS+=("--disable-Werror")
 217 fi
 218
 219 case "$conf" in
 220 static)
 221     echo "Static lib only configuration"
 222
 223     CONF_OPTS+=("--enable-static" "--disable-shared")
 224
 225     if vergte "$PACKAGE_VERSION" "2.0"; then
 226         CONF_OPTS+=("--enable-built-in-plugins")
 227     fi
 228     ;;
 229
 230 python-bindings)
 231     echo "Python bindings configuration"
 232
 233     CONF_OPTS+=("--enable-python-bindings")
 234
 235     if vergte "$PACKAGE_VERSION" "2.0"; then
 236         CONF_OPTS+=("--enable-python-bindings-doc" "--enable-python-plugins")
 237     fi
 238     ;;
 239
 240 prod)
 241     echo "Production configuration"
 242
 243     # Unset the developper variables
 244     unset BABELTRACE_DEBUG_MODE
 245     unset BABELTRACE_DEV_MODE
 246     unset BABELTRACE_MINIMAL_LOG_LEVEL
 247
 248     # Enable the python bindings
 249     CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
 250     ;;
 251
 252 doc)
 253     echo "Documentation configuration"
 254
 255     CONF_OPTS+=("--enable-python-bindings" "--enable-python-bindings-doc" "--enable-python-plugins" "--enable-api-doc")
 256     ;;
 257
 258 asan)
 259     echo "Address Sanitizer configuration"
 260
 261     # --enable-asan was introduced after 2.0 but don't check the version, we
 262     # want this configuration to fail if ASAN is unavailable.
 263     CONF_OPTS+=("--enable-asan" "--enable-python-bindings" "--enable-python-plugins")
 264     ;;
 265
 266 min)
 267     echo "Minimal configuration"
 268     ;;
 269
 270 *)
 271     echo "Standard configuration"
 272
 273     # Enable the python bindings / plugins by default with babeltrace2,
 274     # the test suite is mostly useless without it.
 275     if vergte "$PACKAGE_VERSION" "2.0"; then
 276         CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
 277     fi
 278     ;;
 279 esac
 280
 281 # Build type
 282 # oot     : out-of-tree build
 283 # dist    : build via make dist
 284 # oot-dist: build via make dist out-of-tree
 285 # *       : normal tree build
 286 #
 287 # Make sure to move to the build directory and run configure
 288 # before continuing.
 289 case "$build" in
 290 oot)
 291     echo "Out of tree build"
 292
 293     # Create and enter a temporary build directory
 294     builddir=$(mktemp -d)
 295     cd "$builddir"
 296
 297     "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
 298     ;;
 299
 300 dist)
 301     echo "Distribution in-tree build"
 302
 303     # Run configure and generate the tar file
 304     # in the source directory
 305     ./configure || failed_configure
 306     $MAKE dist
 307
 308     # Create and enter a temporary build directory
 309     builddir=$(mktemp -d)
 310     cd "$builddir"
 311
 312     # Extract the distribution tar in the build directory,
 313     # ignore the first directory level
 314     $TAR xvf "$SRCDIR"/*.tar.* --strip 1
 315
 316     # Build in extracted source tree
 317     ./configure "${CONF_OPTS[@]}" || failed_configure
 318     ;;
 319
 320 oot-dist)
 321     echo "Distribution out of tree build"
 322
 323     # Create and enter a temporary build directory
 324     builddir=$(mktemp -d)
 325     cd "$builddir"
 326
 327     # Run configure out of tree and generate the tar file
 328     "$SRCDIR/configure" || failed_configure
 329     $MAKE dist
 330
 331     dist_srcdir="$(mktemp -d)"
 332     cd "$dist_srcdir"
 333
 334     # Extract the distribution tar in the new source directory,
 335     # ignore the first directory level
 336     $TAR xvf "$builddir"/*.tar.* --strip 1
 337
 338     # Create and enter a second temporary build directory
 339     builddir="$(mktemp -d)"
 340     cd "$builddir"
 341
 342     # Run configure from the extracted distribution tar,
 343     # out of the source tree
 344     "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
 345     ;;
 346
 347 *)
 348     echo "Standard in-tree build"
 349     ./configure "${CONF_OPTS[@]}" || failed_configure
 350     ;;
 351 esac
 352
 353 # We are now inside a configured build directory
 354
 355 # BUILD!
 356 $MAKE -j "$($NPROC)" V=1
 357
 358 # Install in the workspace
 359 $MAKE install DESTDIR="$WORKSPACE"
 360
 361 # Run tests, don't fail now, we want to run the archiving steps
 362 failed_tests=0
 363 if [ "$BABELTRACE_RUN_TESTS" = "yes" ]; then
 364         $MAKE --keep-going check || failed_tests=1
 365
 366         # Copy tap logs for the jenkins tap parser before cleaning the build dir
 367         rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$WORKSPACE/tap"
 368
 369         # The test suite prior to 1.5 did not produce TAP logs
 370         if verlt "$PACKAGE_VERSION" "1.5"; then
 371             mkdir -p "$WORKSPACE/tap/no-log"
 372             echo "1..1" > "$WORKSPACE/tap/no-log/tests.log"
 373             echo "ok 1 - Test suite doesn't support logging" >> "$WORKSPACE/tap/no-log/tests.log"
 374         fi
 375 fi
 376
 377 # Clean the build directory
 378 $MAKE clean
 379
 380 # Cleanup rpath in executables and shared libraries
 381 find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
 382 find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.so" -exec chrpath --delete {} \;
 383
 384 # Remove libtool .la files
 385 find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -exec rm -f {} \;
 386
 387 # Exit with failure if any of the tests failed
 388 exit $failed_tests
 389
 390 # EOF