scripts/babeltrace/build.sh

   1 #!/bin/bash
   2 #
   3 # SPDX-FileCopyrightText: 2015 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
   4 # SPDX-FileCopyrightText: 2016-2023 Michael Jeanson <mjeanson@efficios.com>
   5 # SPDX-License-Identifier: GPL-2.0-or-later
   6
   7 set -exu
   8
   9 # Version compare functions
  10 vercomp () {
  11     set +u
  12     if [[ "$1" == "$2" ]]; then
  13         return 0
  14     fi
  15     local IFS=.
  16     # Ignore the shellcheck warning, we want splitting to happen based on IFS.
  17     # shellcheck disable=SC2206
  18     local i ver1=($1) ver2=($2)
  19     # fill empty fields in ver1 with zeros
  20     for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
  21         ver1[i]=0
  22     done
  23     for ((i=0; i<${#ver1[@]}; i++)); do
  24         if [[ -z ${ver2[i]} ]]; then
  25             # fill empty fields in ver2 with zeros
  26             ver2[i]=0
  27         fi
  28         if ((10#${ver1[i]} > 10#${ver2[i]})); then
  29             return 1
  30         fi
  31         if ((10#${ver1[i]} < 10#${ver2[i]})); then
  32             return 2
  33         fi
  34     done
  35     set -u
  36     return 0
  37 }
  38
  39 # Shellcheck flags the following functions that are unused as "unreachable",
  40 # ignore that.
  41
  42 # shellcheck disable=SC2317
  43 verlte() {
  44     vercomp "$1" "$2"
  45     local res="$?"
  46     [ "$res" -eq "0" ] || [ "$res" -eq "2" ]
  47 }
  48
  49 # shellcheck disable=SC2317
  50 verlt() {
  51     vercomp "$1" "$2"; local res="$?"
  52     [ "$res" -eq "2" ]
  53 }
  54
  55 # shellcheck disable=SC2317
  56 vergte() {
  57     vercomp "$1" "$2"; local res="$?"
  58     [ "$res" -eq "0" ] || [ "$res" -eq "1" ]
  59 }
  60
  61 # shellcheck disable=SC2317
  62 vergt() {
  63     vercomp "$1" "$2"; local res="$?"
  64     [ "$res" -eq "1" ]
  65 }
  66
  67 # shellcheck disable=SC2317
  68 verne() {
  69     vercomp "$1" "$2"; local res="$?"
  70     [ "$res" -ne "0" ]
  71 }
  72
  73 print_header() {
  74     set +x
  75
  76     local message=" $1 "
  77     local message_len
  78     local padding_len
  79
  80     message_len="${#message}"
  81     padding_len=$(( (80 - (message_len)) / 2 ))
  82
  83     printf '\n'; printf -- '#%.0s' {1..80}; printf '\n'
  84     printf -- '-%.0s' {1..80}; printf '\n'
  85     printf -- '#%.0s' $(seq 1 $padding_len); printf '%s' "$message"; printf -- '#%.0s' $(seq 1 $padding_len); printf '\n'
  86     printf -- '-%.0s' {1..80}; printf '\n'
  87     printf -- '#%.0s' {1..80}; printf '\n\n'
  88
  89     set -x
  90 }
  91
  92 failed_configure() {
  93     # Assume we are in the configured build directory
  94     print_header "BEGIN config.log"
  95     cat config.log
  96     print_header "END config.log"
  97     exit 1
  98 }
  99
 100 print_header "Babeltrace build script starting"
 101
 102 # Required variables
 103 WORKSPACE=${WORKSPACE:-}
 104
 105 # Axis
 106 platform=${platform:-}
 107 conf=${conf:-}
 108 build=${build:-}
 109 cc=${cc:-}
 110
 111 # Build steps that can be overriden by the environment
 112 BABELTRACE_MAKE_INSTALL="${BABELTRACE_MAKE_INSTALL:-yes}"
 113 BABELTRACE_MAKE_CLEAN="${BABELTRACE_MAKE_CLEAN:-yes}"
 114 BABELTRACE_GEN_COMPILE_COMMANDS="${BABELTRACE_GEN_COMPILE_COMMANDS:-no}"
 115 BABELTRACE_RUN_TESTS="${BABELTRACE_RUN_TESTS:-yes}"
 116 BABELTRACE_CLANG_TIDY="${BABELTRACE_CLANG_TIDY:-no}"
 117
 118 SRCDIR="$WORKSPACE/src/babeltrace"
 119 TMPDIR="$WORKSPACE/tmp"
 120 PREFIX="/build"
 121 LIBDIR="lib"
 122 LIBDIR_ARCH="$LIBDIR"
 123
 124 # RHEL and SLES both use lib64 but don't bother shipping a default autoconf
 125 # site config that matches this.
 126 if [[ ( -f /etc/redhat-release || -f /etc/products.d/SLES.prod || -f /etc/yocto-release ) ]]; then
 127     # Detect the userspace bitness in a distro agnostic way
 128     if file -L /bin/bash | grep '64-bit' >/dev/null 2>&1; then
 129         LIBDIR_ARCH="${LIBDIR}64"
 130     fi
 131 fi
 132
 133 exit_status=0
 134
 135 # Use bear to generate compile_commands.json when enabled
 136 BEAR=""
 137 if [ "$BABELTRACE_GEN_COMPILE_COMMANDS" = "yes" ]; then
 138         BEAR="bear"
 139 fi
 140
 141 # Create tmp directory
 142 rm -rf "$TMPDIR"
 143 mkdir -p "$TMPDIR"
 144
 145 export TMPDIR
 146 export CFLAGS="-g -O2"
 147 export CXXFLAGS="-g -O2"
 148
 149 # Set compiler variables
 150 case "$cc" in
 151 gcc)
 152     export CC=gcc
 153     export CXX=g++
 154     ;;
 155 gcc-*)
 156     export CC=gcc-${cc#gcc-}
 157     export CXX=g++-${cc#gcc-}
 158     ;;
 159 clang)
 160     export CC=clang
 161     export CXX=clang++
 162     ;;
 163 clang-*)
 164     export CC=clang-${cc#clang-}
 165     export CXX=clang++-${cc#clang-}
 166     ;;
 167 *)
 168     if [ "x$cc" != "x" ]; then
 169         echo ""
 170         exit 1
 171     fi
 172     ;;
 173 esac
 174
 175 # Set platform variables
 176 case "$platform" in
 177 macos*)
 178     export MAKE=make
 179     export TAR=tar
 180     export NPROC="getconf _NPROCESSORS_ONLN"
 181     export PATH="/opt/local/bin:/opt/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
 182     export CFLAGS="$CFLAGS -Wno-\#pragma-messages" # Fix warnings with clang14
 183     export CPPFLAGS="-I/opt/local/include"
 184     export LDFLAGS="-L/opt/local/lib"
 185     export PYTHON="python3"
 186     export PYTHON_CONFIG="python3-config"
 187     ;;
 188
 189 freebsd*)
 190     export MAKE=gmake
 191     export TAR=tar
 192     export NPROC="getconf _NPROCESSORS_ONLN"
 193     export CPPFLAGS="-I/usr/local/include"
 194     export LDFLAGS="-L/usr/local/lib"
 195     export PYTHON="python3"
 196     export PYTHON_CONFIG="python3-config"
 197
 198     # For bt 1.5
 199     export YACC="bison -y"
 200     ;;
 201
 202 *)
 203     export MAKE=make
 204     export TAR=tar
 205     export NPROC=nproc
 206     export PYTHON="python3"
 207     export PYTHON_CONFIG="python3-config"
 208     ;;
 209 esac
 210
 211 # Print build env details
 212 print_header "Build environment details"
 213 print_hardware || true
 214 print_os || true
 215 print_tooling || true
 216
 217 # Enter the source directory
 218 cd "$SRCDIR"
 219
 220 # Run bootstrap in the source directory prior to configure
 221 print_header "Bootstrap autotools"
 222 ./bootstrap
 223
 224 # Get source version from configure script
 225 eval "$(grep '^PACKAGE_VERSION=' ./configure)"
 226 PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
 227
 228 # Enable dev mode by default for BT 2.0 builds
 229 export BABELTRACE_DEBUG_MODE=1
 230 export BABELTRACE_DEV_MODE=1
 231 export BABELTRACE_MINIMAL_LOG_LEVEL=TRACE
 232
 233 # Set configure options and environment variables for each build
 234 # configuration.
 235 CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--disable-maintainer-mode")
 236
 237 # -Werror is enabled by default in stable-2.0 but won't be in 2.1
 238 # Explicitly disable it for consistency.
 239 if vergte "$PACKAGE_VERSION" "2.0"; then
 240     CONF_OPTS+=("--disable-Werror")
 241 fi
 242
 243 case "$conf" in
 244 static)
 245     print_header "Conf: Static lib only"
 246
 247     CONF_OPTS+=("--enable-static" "--disable-shared")
 248
 249     if vergte "$PACKAGE_VERSION" "2.0"; then
 250         CONF_OPTS+=("--enable-built-in-plugins")
 251     fi
 252     ;;
 253
 254 python-bindings)
 255     print_header "Conf: Python bindings"
 256
 257     CONF_OPTS+=("--enable-python-bindings")
 258
 259     if vergte "$PACKAGE_VERSION" "2.0"; then
 260         CONF_OPTS+=("--enable-python-bindings-doc" "--enable-python-plugins")
 261     fi
 262     ;;
 263
 264 prod)
 265     print_header "Conf: Production"
 266
 267     # Unset the developper variables
 268     unset BABELTRACE_DEBUG_MODE
 269     unset BABELTRACE_DEV_MODE
 270     unset BABELTRACE_MINIMAL_LOG_LEVEL
 271
 272     # Enable the python bindings
 273     CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
 274     ;;
 275
 276 doc)
 277     print_header "Conf: Documentation"
 278
 279     CONF_OPTS+=("--enable-python-bindings" "--enable-python-bindings-doc" "--enable-python-plugins" "--enable-api-doc")
 280     ;;
 281
 282 asan)
 283     print_header "Conf: Address Sanitizer"
 284
 285     # --enable-asan was introduced after 2.0 but don't check the version, we
 286     # want this configuration to fail if ASAN is unavailable.
 287     CONF_OPTS+=("--enable-asan" "--enable-python-bindings" "--enable-python-plugins")
 288     ;;
 289
 290 min)
 291     print_header "Conf: Minimal"
 292     ;;
 293
 294 *)
 295     print_header "Conf: Standard"
 296
 297     # Enable the python bindings / plugins by default with babeltrace2,
 298     # the test suite is mostly useless without it.
 299     if vergte "$PACKAGE_VERSION" "2.0"; then
 300         CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
 301     fi
 302
 303     # Something is broken in docbook-xml on yocto
 304     if [[ "$platform" = yocto* ]]; then
 305         CONF_OPTS+=("--disable-man-pages")
 306     fi
 307     ;;
 308 esac
 309
 310 # Build type
 311 # oot     : out-of-tree build
 312 # dist    : build via make dist
 313 # oot-dist: build via make dist out-of-tree
 314 # *       : normal tree build
 315 #
 316 # Make sure to move to the build directory and run configure
 317 # before continuing.
 318 case "$build" in
 319 oot)
 320     print_header "Build: Out of tree"
 321
 322     # Create and enter a temporary build directory
 323     builddir=$(mktemp -d)
 324     cd "$builddir"
 325
 326     "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
 327     ;;
 328
 329 dist)
 330     print_header "Build: Distribution In-tree"
 331
 332     # Run configure and generate the tar file
 333     # in the source directory
 334     ./configure || failed_configure
 335     $MAKE dist
 336
 337     # Create and enter a temporary build directory
 338     builddir=$(mktemp -d)
 339     cd "$builddir"
 340
 341     # Extract the distribution tar in the build directory,
 342     # ignore the first directory level
 343     $TAR xvf "$SRCDIR"/*.tar.* --strip 1
 344
 345     # Build in extracted source tree
 346     ./configure "${CONF_OPTS[@]}" || failed_configure
 347     ;;
 348
 349 oot-dist)
 350     print_header "Build: Distribution Out of tree"
 351
 352     # Create and enter a temporary build directory
 353     builddir=$(mktemp -d)
 354     cd "$builddir"
 355
 356     # Run configure out of tree and generate the tar file
 357     "$SRCDIR/configure" || failed_configure
 358     $MAKE dist
 359
 360     dist_srcdir="$(mktemp -d)"
 361     cd "$dist_srcdir"
 362
 363     # Extract the distribution tar in the new source directory,
 364     # ignore the first directory level
 365     $TAR xvf "$builddir"/*.tar.* --strip 1
 366
 367     # Create and enter a second temporary build directory
 368     builddir="$(mktemp -d)"
 369     cd "$builddir"
 370
 371     # Run configure from the extracted distribution tar,
 372     # out of the source tree
 373     "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
 374     ;;
 375
 376 *)
 377     print_header "Build: Standard In-tree"
 378     ./configure "${CONF_OPTS[@]}" || failed_configure
 379     ;;
 380 esac
 381
 382 # We are now inside a configured build directory
 383
 384 # BUILD!
 385 print_header "BUILD!"
 386 $BEAR ${BEAR:+--} $MAKE -j "$($NPROC)" V=1
 387
 388 # Install in the workspace if enabled
 389 if [ "$BABELTRACE_MAKE_INSTALL" = "yes" ]; then
 390     print_header "Install"
 391
 392     $MAKE install V=1 DESTDIR="$WORKSPACE"
 393
 394     # Cleanup rpath in executables and shared libraries
 395     find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
 396     find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.so" -exec chrpath --delete {} \;
 397
 398     # Remove libtool .la files
 399     find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -delete
 400 fi
 401
 402 # Run clang-tidy on the topmost commit
 403 if [ "$BABELTRACE_CLANG_TIDY" = "yes" ]; then
 404     print_header "Run clang-tidy"
 405
 406     # This would be better by linting only the lines touched by a patch but it
 407     # doesn't seem to work, the lines are always filtered and no error is
 408     # reported.
 409     #git diff -U0 HEAD^ | clang-tidy-diff -p1 -j "$($NPROC)" -timeout 60 -fix
 410
 411     # Instead, run clan-tidy on all the files touched by the patch.
 412     while read -r filepath; do
 413         if [[ "$filepath" =~ (\.cpp|\.hhp|\.c|\.h)$ ]]; then
 414             clang-tidy --fix-errors "$(realpath "$filepath")"
 415         fi
 416     done < <(git diff-tree --no-commit-id --diff-filter=d --name-only -r HEAD)
 417
 418     # If the tree has local changes, the formatting was incorrect
 419     GIT_DIFF_OUTPUT=$(git diff)
 420     if [ -n "$GIT_DIFF_OUTPUT" ]; then
 421         echo "Saving clang-tidy proposed fixes in clang-tidy-fixes.diff"
 422         git diff > "$WORKSPACE/clang-tidy-fixes.diff"
 423
 424         # Restore the unfixed files so they can be viewed in the warnings web
 425         # interface
 426         git checkout .
 427         exit_status=1
 428     fi
 429 fi
 430
 431 # Run tests if enabled
 432 if [ "$BABELTRACE_RUN_TESTS" = "yes" ]; then
 433     print_header "Run test suite"
 434
 435     # Run tests, don't fail now, we want to run the archiving steps
 436     $MAKE --keep-going check || exit_status=1
 437
 438     # Copy tap logs for the jenkins tap parser before cleaning the build dir
 439     rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$WORKSPACE/tap"
 440
 441     # Copy the test suites top-level log which includes all tests failures
 442     rsync -a --include 'test-suite.log' --include '*/' --exclude='*' tests/ "$WORKSPACE/log"
 443 fi
 444
 445 # Clean the build directory
 446 if [ "$BABELTRACE_MAKE_CLEAN" = "yes" ]; then
 447     print_header "Clean"
 448     $MAKE clean
 449 fi
 450
 451 print_header "Babeltrace build script ended with: $(test $exit_status == 0 && echo SUCCESS || echo FAILURE)"
 452
 453 # Exit with failure if any of the tests failed
 454 exit $exit_status
 455
 456 # EOF
 457 # vim: expandtab tabstop=4 shiftwidth=4