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 CPPFLAGS="-I/opt/local/include"
 183     export LDFLAGS="-L/opt/local/lib"
 184     export PYTHON="python3"
 185     export PYTHON_CONFIG="python3-config"
 186     ;;
 187
 188 freebsd*)
 189     export MAKE=gmake
 190     export TAR=tar
 191     export NPROC="getconf _NPROCESSORS_ONLN"
 192     export CPPFLAGS="-I/usr/local/include"
 193     export LDFLAGS="-L/usr/local/lib"
 194     export PYTHON="python3"
 195     export PYTHON_CONFIG="python3-config"
 196
 197     # For bt 1.5
 198     export YACC="bison -y"
 199     ;;
 200
 201 *)
 202     export MAKE=make
 203     export TAR=tar
 204     export NPROC=nproc
 205     export PYTHON="python3"
 206     export PYTHON_CONFIG="python3-config"
 207     ;;
 208 esac
 209
 210 # Print build env details
 211 print_header "Build environment details"
 212 print_os || true
 213 print_tooling || true
 214
 215 # Enter the source directory
 216 cd "$SRCDIR"
 217
 218 # Run bootstrap in the source directory prior to configure
 219 print_header "Bootstrap autotools"
 220 ./bootstrap
 221
 222 # Get source version from configure script
 223 eval "$(grep '^PACKAGE_VERSION=' ./configure)"
 224 PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
 225
 226 # Enable dev mode by default for BT 2.0 builds
 227 export BABELTRACE_DEBUG_MODE=1
 228 export BABELTRACE_DEV_MODE=1
 229 export BABELTRACE_MINIMAL_LOG_LEVEL=TRACE
 230
 231 # Set configure options and environment variables for each build
 232 # configuration.
 233 CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--disable-maintainer-mode")
 234
 235 # -Werror is enabled by default in stable-2.0 but won't be in 2.1
 236 # Explicitly disable it for consistency.
 237 if vergte "$PACKAGE_VERSION" "2.0"; then
 238     CONF_OPTS+=("--disable-Werror")
 239 fi
 240
 241 case "$conf" in
 242 static)
 243     print_header "Conf: Static lib only"
 244
 245     CONF_OPTS+=("--enable-static" "--disable-shared")
 246
 247     if vergte "$PACKAGE_VERSION" "2.0"; then
 248         CONF_OPTS+=("--enable-built-in-plugins")
 249     fi
 250     ;;
 251
 252 python-bindings)
 253     print_header "Conf: Python bindings"
 254
 255     CONF_OPTS+=("--enable-python-bindings")
 256
 257     if vergte "$PACKAGE_VERSION" "2.0"; then
 258         CONF_OPTS+=("--enable-python-bindings-doc" "--enable-python-plugins")
 259     fi
 260     ;;
 261
 262 prod)
 263     print_header "Conf: Production"
 264
 265     # Unset the developper variables
 266     unset BABELTRACE_DEBUG_MODE
 267     unset BABELTRACE_DEV_MODE
 268     unset BABELTRACE_MINIMAL_LOG_LEVEL
 269
 270     # Enable the python bindings
 271     CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
 272     ;;
 273
 274 doc)
 275     print_header "Conf: Documentation"
 276
 277     CONF_OPTS+=("--enable-python-bindings" "--enable-python-bindings-doc" "--enable-python-plugins" "--enable-api-doc")
 278     ;;
 279
 280 asan)
 281     print_header "Conf: Address Sanitizer"
 282
 283     # --enable-asan was introduced after 2.0 but don't check the version, we
 284     # want this configuration to fail if ASAN is unavailable.
 285     CONF_OPTS+=("--enable-asan" "--enable-python-bindings" "--enable-python-plugins")
 286     ;;
 287
 288 min)
 289     print_header "Conf: Minimal"
 290     ;;
 291
 292 *)
 293     print_header "Conf: Standard"
 294
 295     # Enable the python bindings / plugins by default with babeltrace2,
 296     # the test suite is mostly useless without it.
 297     if vergte "$PACKAGE_VERSION" "2.0"; then
 298         CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
 299     fi
 300
 301     # Something is broken in docbook-xml on yocto
 302     if [[ "$platform" = yocto* ]]; then
 303         CONF_OPTS+=("--disable-man-pages")
 304     fi
 305     ;;
 306 esac
 307
 308 # Build type
 309 # oot     : out-of-tree build
 310 # dist    : build via make dist
 311 # oot-dist: build via make dist out-of-tree
 312 # *       : normal tree build
 313 #
 314 # Make sure to move to the build directory and run configure
 315 # before continuing.
 316 case "$build" in
 317 oot)
 318     print_header "Build: Out of tree"
 319
 320     # Create and enter a temporary build directory
 321     builddir=$(mktemp -d)
 322     cd "$builddir"
 323
 324     "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
 325     ;;
 326
 327 dist)
 328     print_header "Build: Distribution In-tree"
 329
 330     # Run configure and generate the tar file
 331     # in the source directory
 332     ./configure || failed_configure
 333     $MAKE dist
 334
 335     # Create and enter a temporary build directory
 336     builddir=$(mktemp -d)
 337     cd "$builddir"
 338
 339     # Extract the distribution tar in the build directory,
 340     # ignore the first directory level
 341     $TAR xvf "$SRCDIR"/*.tar.* --strip 1
 342
 343     # Build in extracted source tree
 344     ./configure "${CONF_OPTS[@]}" || failed_configure
 345     ;;
 346
 347 oot-dist)
 348     print_header "Build: Distribution Out of tree"
 349
 350     # Create and enter a temporary build directory
 351     builddir=$(mktemp -d)
 352     cd "$builddir"
 353
 354     # Run configure out of tree and generate the tar file
 355     "$SRCDIR/configure" || failed_configure
 356     $MAKE dist
 357
 358     dist_srcdir="$(mktemp -d)"
 359     cd "$dist_srcdir"
 360
 361     # Extract the distribution tar in the new source directory,
 362     # ignore the first directory level
 363     $TAR xvf "$builddir"/*.tar.* --strip 1
 364
 365     # Create and enter a second temporary build directory
 366     builddir="$(mktemp -d)"
 367     cd "$builddir"
 368
 369     # Run configure from the extracted distribution tar,
 370     # out of the source tree
 371     "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
 372     ;;
 373
 374 *)
 375     print_header "Build: Standard In-tree"
 376     ./configure "${CONF_OPTS[@]}" || failed_configure
 377     ;;
 378 esac
 379
 380 # We are now inside a configured build directory
 381
 382 # BUILD!
 383 print_header "BUILD!"
 384 $BEAR ${BEAR:+--} $MAKE -j "$($NPROC)" V=1
 385
 386 # Install in the workspace if enabled
 387 if [ "$BABELTRACE_MAKE_INSTALL" = "yes" ]; then
 388     print_header "Install"
 389
 390     $MAKE install V=1 DESTDIR="$WORKSPACE"
 391
 392     # Cleanup rpath in executables and shared libraries
 393     find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
 394     find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.so" -exec chrpath --delete {} \;
 395
 396     # Remove libtool .la files
 397     find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -delete
 398 fi
 399
 400 # Run clang-tidy on the topmost commit
 401 if [ "$BABELTRACE_CLANG_TIDY" = "yes" ]; then
 402     print_header "Run clang-tidy"
 403
 404     # This would be better by linting only the lines touched by a patch but it
 405     # doesn't seem to work, the lines are always filtered and no error is
 406     # reported.
 407     #git diff -U0 HEAD^ | clang-tidy-diff -p1 -j "$($NPROC)" -timeout 60 -fix
 408
 409     # Instead, run clan-tidy on all the files touched by the patch.
 410     while read -r filepath; do
 411         if [[ "$filepath" =~ (\.cpp|\.hhp|\.c|\.h)$ ]]; then
 412             clang-tidy --fix-errors "$(realpath "$filepath")"
 413         fi
 414     done < <(git diff-tree --no-commit-id --diff-filter=d --name-only -r HEAD)
 415
 416     # If the tree has local changes, the formatting was incorrect
 417     GIT_DIFF_OUTPUT=$(git diff)
 418     if [ -n "$GIT_DIFF_OUTPUT" ]; then
 419         echo "Saving clang-tidy proposed fixes in clang-tidy-fixes.diff"
 420         git diff > "$WORKSPACE/clang-tidy-fixes.diff"
 421
 422         # Restore the unfixed files so they can be viewed in the warnings web
 423         # interface
 424         git checkout .
 425         exit_status=1
 426     fi
 427 fi
 428
 429 # Run tests if enabled
 430 if [ "$BABELTRACE_RUN_TESTS" = "yes" ]; then
 431     print_header "Run test suite"
 432
 433     # Run tests, don't fail now, we want to run the archiving steps
 434     $MAKE --keep-going check || exit_status=1
 435
 436     # Copy tap logs for the jenkins tap parser before cleaning the build dir
 437     rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$WORKSPACE/tap"
 438
 439     # Copy the test suites top-level log which includes all tests failures
 440     rsync -a --include 'test-suite.log' --include '*/' --exclude='*' tests/ "$WORKSPACE/log"
 441 fi
 442
 443 # Clean the build directory
 444 if [ "$BABELTRACE_MAKE_CLEAN" = "yes" ]; then
 445     print_header "Clean"
 446     $MAKE clean
 447 fi
 448
 449 print_header "Babeltrace build script ended with: $(test $exit_status == 0 && echo SUCCESS || echo FAILURE)"
 450
 451 # Exit with failure if any of the tests failed
 452 exit $exit_status
 453
 454 # EOF
 455 # vim: expandtab tabstop=4 shiftwidth=4