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