-#!/bin/bash -exu
+#!/bin/bash
#
-# Copyright (C) 2015 - Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
-# 2016 - Michael Jeanson <mjeanson@efficios.com>
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# SPDX-FileCopyrightText: 2015 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
+# SPDX-FileCopyrightText: 2016-2023 Michael Jeanson <mjeanson@efficios.com>
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+set -exu
# Version compare functions
vercomp () {
return 0
fi
local IFS=.
+ # Ignore the shellcheck warning, we want splitting to happen based on IFS.
+ # shellcheck disable=SC2206
local i ver1=($1) ver2=($2)
# fill empty fields in ver1 with zeros
for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
return 0
}
+# Shellcheck flags the following functions that are unused as "unreachable",
+# ignore that.
+
+# shellcheck disable=SC2317
verlte() {
- vercomp "$1" "$2"; local res="$?"
+ vercomp "$1" "$2"
+ local res="$?"
[ "$res" -eq "0" ] || [ "$res" -eq "2" ]
}
+# shellcheck disable=SC2317
verlt() {
vercomp "$1" "$2"; local res="$?"
[ "$res" -eq "2" ]
}
+# shellcheck disable=SC2317
vergte() {
vercomp "$1" "$2"; local res="$?"
[ "$res" -eq "0" ] || [ "$res" -eq "1" ]
}
+# shellcheck disable=SC2317
vergt() {
vercomp "$1" "$2"; local res="$?"
[ "$res" -eq "1" ]
}
+# shellcheck disable=SC2317
verne() {
vercomp "$1" "$2"; local res="$?"
[ "$res" -ne "0" ]
}
-# Required parameters
-arch=${arch:-}
+print_header() {
+ set +x
+
+ local message=" $1 "
+ local message_len
+ local padding_len
+
+ message_len="${#message}"
+ padding_len=$(( (80 - (message_len)) / 2 ))
+
+ printf '\n'; printf -- '#%.0s' {1..80}; printf '\n'
+ printf -- '-%.0s' {1..80}; printf '\n'
+ printf -- '#%.0s' $(seq 1 $padding_len); printf '%s' "$message"; printf -- '#%.0s' $(seq 1 $padding_len); printf '\n'
+ printf -- '-%.0s' {1..80}; printf '\n'
+ printf -- '#%.0s' {1..80}; printf '\n\n'
+
+ set -x
+}
+
+failed_configure() {
+ # Assume we are in the configured build directory
+ print_header "BEGIN config.log"
+ cat config.log
+ print_header "END config.log"
+ exit 1
+}
+
+print_header "Babeltrace build script starting"
+
+# Required variables
+WORKSPACE=${WORKSPACE:-}
+
+# Axis
+platform=${platform:-}
conf=${conf:-}
build=${build:-}
cc=${cc:-}
-bt2_mode=${bt2_mode:-}
+# Build steps that can be overriden by the environment
+BABELTRACE_MAKE_INSTALL="${BABELTRACE_MAKE_INSTALL:-yes}"
+BABELTRACE_MAKE_CLEAN="${BABELTRACE_MAKE_CLEAN:-yes}"
+BABELTRACE_GEN_COMPILE_COMMANDS="${BABELTRACE_GEN_COMPILE_COMMANDS:-no}"
+BABELTRACE_RUN_TESTS="${BABELTRACE_RUN_TESTS:-yes}"
+BABELTRACE_CLANG_TIDY="${BABELTRACE_CLANG_TIDY:-no}"
SRCDIR="$WORKSPACE/src/babeltrace"
TMPDIR="$WORKSPACE/tmp"
-PREFIX="$WORKSPACE/build"
+PREFIX="/build"
+LIBDIR="lib"
+LIBDIR_ARCH="$LIBDIR"
+
+# RHEL and SLES both use lib64 but don't bother shipping a default autoconf
+# site config that matches this.
+if [[ ( -f /etc/redhat-release || -f /etc/products.d/SLES.prod || -f /etc/yocto-release ) ]]; then
+ # Detect the userspace bitness in a distro agnostic way
+ if file -L /bin/bash | grep '64-bit' >/dev/null 2>&1; then
+ LIBDIR_ARCH="${LIBDIR}64"
+ fi
+fi
-# Create build and tmp directories
-rm -rf "$PREFIX" "$TMPDIR"
-mkdir -p "$PREFIX" "$TMPDIR"
+exit_status=0
+
+# Use bear to generate compile_commands.json when enabled
+BEAR=""
+if [ "$BABELTRACE_GEN_COMPILE_COMMANDS" = "yes" ]; then
+ BEAR="bear"
+fi
+
+# Create tmp directory
+rm -rf "$TMPDIR"
+mkdir -p "$TMPDIR"
export TMPDIR
export CFLAGS="-g -O2"
+export CXXFLAGS="-g -O2"
# Set compiler variables
case "$cc" in
export CC=gcc
export CXX=g++
;;
-gcc-4.8)
- export CC=gcc-4.8
- export CXX=g++-4.8
- ;;
-gcc-5)
- export CC=gcc-5
- export CXX=g++-5
- ;;
-gcc-6)
- export CC=gcc-6
- export CXX=g++-6
- ;;
-gcc-7)
- export CC=gcc-7
- export CXX=g++-7
- ;;
-gcc-8)
- export CC=gcc-8
- export CXX=g++-8
+gcc-*)
+ export CC=gcc-${cc#gcc-}
+ export CXX=g++-${cc#gcc-}
;;
clang)
export CC=clang
export CXX=clang++
;;
-clang-3.9)
- export CC=clang-3.9
- export CXX=clang++-3.9
- ;;
-clang-4.0)
- export CC=clang-4.0
- export CXX=clang++-4.0
- ;;
-clang-5.0)
- export CC=clang-5.0
- export CXX=clang++-5.0
- ;;
-clang-6.0)
- export CC=clang-6.0
- export CXX=clang++-6.0
- ;;
-clang-7)
- export CC=clang-7
- export CXX=clang++-7
+clang-*)
+ export CC=clang-${cc#clang-}
+ export CXX=clang++-${cc#clang-}
;;
*)
if [ "x$cc" != "x" ]; then
- export CC="$cc"
+ echo ""
+ exit 1
fi
;;
esac
-if [ "x${CC:-}" != "x" ]; then
- echo "Selected compiler:"
- "$CC" -v
-fi
-
# Set platform variables
-case "$arch" in
-sol10-i386)
- export MAKE=gmake
- export TAR=gtar
- export NPROC=gnproc
- export BISON=bison
- export YACC="$BISON -y"
- export PATH="/opt/csw/bin:/usr/ccs/bin:$PATH"
- export CPPFLAGS="-I/opt/csw/include"
- export LDFLAGS="-L/opt/csw/lib -R/opt/csw/lib"
- export PKG_CONFIG_PATH="/opt/csw/lib/pkgconfig"
- ;;
-sol11-i386)
- export MAKE=gmake
- export TAR=gtar
- export NPROC=nproc
- export PATH="$PATH:/usr/perl5/bin"
- export LD_ALTEXEC=/usr/bin/gld
- export LD=/usr/bin/gld
- ;;
-macosx)
+case "$platform" in
+macos*)
export MAKE=make
export TAR=tar
export NPROC="getconf _NPROCESSORS_ONLN"
- export BISON="bison"
- export YACC="$BISON -y"
export PATH="/opt/local/bin:/opt/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
- export CFLAGS="$CFLAGS -I/opt/local/include"
+ export CFLAGS="$CFLAGS -Wno-\#pragma-messages" # Fix warnings with clang14
+ export CPPFLAGS="-I/opt/local/include"
export LDFLAGS="-L/opt/local/lib"
+ export PYTHON="python3"
+ export PYTHON_CONFIG="python3-config"
+ ;;
+
+freebsd*)
+ export MAKE=gmake
+ export TAR=tar
+ export NPROC="getconf _NPROCESSORS_ONLN"
+ export CPPFLAGS="-I/usr/local/include"
+ export LDFLAGS="-L/usr/local/lib"
+ export PYTHON="python3"
+ export PYTHON_CONFIG="python3-config"
+
+ # For bt 1.5
+ export YACC="bison -y"
;;
+
*)
export MAKE=make
export TAR=tar
export NPROC=nproc
+ export PYTHON="python3"
+ export PYTHON_CONFIG="python3-config"
;;
esac
+# Some warning flags are very dumb in GCC 4.8 on SLES12 / EL7, disable them
+# even if they are available.
+if [[ $platform = sles12sp5* ]] || [[ $platform = el7* ]]; then
+ CFLAGS="$CFLAGS -Wno-missing-field-initializers -Wno-shadow"
+ CXXFLAGS="$CXXFLAGS -Wno-missing-field-initializers -Wno-shadow"
+fi
+
+# Print build env details
+print_header "Build environment details"
+print_hardware || true
+print_os || true
+print_tooling || true
+
# Enter the source directory
cd "$SRCDIR"
# Run bootstrap in the source directory prior to configure
+print_header "Bootstrap autotools"
./bootstrap
# Get source version from configure script
eval "$(grep '^PACKAGE_VERSION=' ./configure)"
+PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
# Enable dev mode by default for BT 2.0 builds
-case "$bt2_mode" in
-dev)
- echo "Developer mode"
- export BABELTRACE_DEBUG_MODE=1
- export BABELTRACE_DEV_MODE=1
- export BABELTRACE_MINIMAL_LOG_LEVEL=VERBOSE
- ;;
-*)
- echo "Production mode (Default)"
- export BABELTRACE_MINIMAL_LOG_LEVEL=INFO
- ;;
-esac
+export BABELTRACE_DEBUG_MODE=1
+export BABELTRACE_DEV_MODE=1
+export BABELTRACE_MINIMAL_LOG_LEVEL=TRACE
+
+# Set configure options and environment variables for each build
+# configuration.
+CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--disable-maintainer-mode")
+
+# -Werror is enabled by default in stable-2.0 but won't be in 2.1
+# Explicitly disable it for consistency.
+if vergte "$PACKAGE_VERSION" "2.0"; then
+ CONF_OPTS+=("--disable-Werror")
+fi
-# Set configure options for each build configuration
-CONF_OPTS=""
case "$conf" in
static)
- echo "Static build"
- CONF_OPTS="--enable-static --disable-shared"
+ print_header "Conf: Static lib only"
+
+ CONF_OPTS+=("--enable-static" "--disable-shared")
+
if vergte "$PACKAGE_VERSION" "2.0"; then
- CONF_OPTS="${CONF_OPTS} --enable-built-in-plugins"
+ CONF_OPTS+=("--enable-built-in-plugins")
fi
;;
+
python-bindings)
- echo "Build with python bindings"
- # We only support bindings built with Python 3
- export PYTHON="python3"
- export PYTHON_CONFIG="/usr/bin/python3-config"
- CONF_OPTS="--enable-python-bindings"
+ print_header "Conf: Python bindings"
+
+ CONF_OPTS+=("--enable-python-bindings")
if vergte "$PACKAGE_VERSION" "2.0"; then
- CONF_OPTS="${CONF_OPTS} --enable-python-bindings-doc --enable-python-plugins"
+ CONF_OPTS+=("--enable-python-bindings-doc" "--enable-python-plugins")
fi
;;
+
+prod)
+ print_header "Conf: Production"
+
+ # Unset the developper variables
+ unset BABELTRACE_DEBUG_MODE
+ unset BABELTRACE_DEV_MODE
+ unset BABELTRACE_MINIMAL_LOG_LEVEL
+
+ # Enable the python bindings
+ CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
+ ;;
+
+doc)
+ print_header "Conf: Documentation"
+
+ CONF_OPTS+=("--enable-python-bindings" "--enable-python-bindings-doc" "--enable-python-plugins" "--enable-api-doc")
+ ;;
+
+asan)
+ print_header "Conf: Address Sanitizer"
+
+ # --enable-asan was introduced after 2.0 but don't check the version, we
+ # want this configuration to fail if ASAN is unavailable.
+ CONF_OPTS+=("--enable-asan" "--enable-python-bindings" "--enable-python-plugins")
+ ;;
+
+min)
+ print_header "Conf: Minimal"
+ ;;
+
*)
- echo "Standard build"
- CONF_OPTS=""
+ print_header "Conf: Standard"
+
+ # Enable the python bindings / plugins by default with babeltrace2,
+ # the test suite is mostly useless without it.
+ if vergte "$PACKAGE_VERSION" "2.0"; then
+ CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
+ fi
+
+ # Something is broken in docbook-xml on yocto
+ if [[ "$platform" = yocto* ]]; then
+ CONF_OPTS+=("--disable-man-pages")
+ fi
;;
esac
# Build type
-# oot : out-of-tree build
-# dist: build via make dist
-# * : normal tree build
+# oot : out-of-tree build
+# dist : build via make dist
+# oot-dist: build via make dist out-of-tree
+# * : normal tree build
#
-# Make sure to move to the build_path and configure
-# before continuing
-BUILD_PATH="$SRCDIR"
+# Make sure to move to the build directory and run configure
+# before continuing.
case "$build" in
- oot)
- echo "Out of tree build"
- BUILD_PATH="$WORKSPACE/oot"
- mkdir -p "$BUILD_PATH"
- cd "$BUILD_PATH"
- "$SRCDIR/configure" --prefix="$PREFIX" $CONF_OPTS
- ;;
-
- dist)
- echo "Distribution out of tree build"
- BUILD_PATH="$(mktemp -d)"
-
- # Initial configure and generate tarball
- "$SRCDIR/configure"
- $MAKE dist
-
- mkdir -p "$BUILD_PATH"
- cp ./*.tar.* "$BUILD_PATH/"
- cd "$BUILD_PATH"
-
- # Ignore level 1 of tar
- $TAR xvf ./*.tar.* --strip 1
-
- "$BUILD_PATH/configure" --prefix="$PREFIX" $CONF_OPTS
- ;;
-
- *)
- echo "Standard in-tree build"
- "$SRCDIR/configure" --prefix="$PREFIX" $CONF_OPTS
- ;;
+oot)
+ print_header "Build: Out of tree"
+
+ # Create and enter a temporary build directory
+ builddir=$(mktemp -d)
+ cd "$builddir"
+
+ "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
+ ;;
+
+dist)
+ print_header "Build: Distribution In-tree"
+
+ # Run configure and generate the tar file
+ # in the source directory
+ ./configure || failed_configure
+ $MAKE dist
+
+ # Create and enter a temporary build directory
+ builddir=$(mktemp -d)
+ cd "$builddir"
+
+ # Extract the distribution tar in the build directory,
+ # ignore the first directory level
+ $TAR xvf "$SRCDIR"/*.tar.* --strip 1
+
+ # Build in extracted source tree
+ ./configure "${CONF_OPTS[@]}" || failed_configure
+ ;;
+
+oot-dist)
+ print_header "Build: Distribution Out of tree"
+
+ # Create and enter a temporary build directory
+ builddir=$(mktemp -d)
+ cd "$builddir"
+
+ # Run configure out of tree and generate the tar file
+ "$SRCDIR/configure" || failed_configure
+ $MAKE dist
+
+ dist_srcdir="$(mktemp -d)"
+ cd "$dist_srcdir"
+
+ # Extract the distribution tar in the new source directory,
+ # ignore the first directory level
+ $TAR xvf "$builddir"/*.tar.* --strip 1
+
+ # Create and enter a second temporary build directory
+ builddir="$(mktemp -d)"
+ cd "$builddir"
+
+ # Run configure from the extracted distribution tar,
+ # out of the source tree
+ "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
+ ;;
+
+*)
+ print_header "Build: Standard In-tree"
+ ./configure "${CONF_OPTS[@]}" || failed_configure
+ ;;
esac
+# We are now inside a configured build directory
+
# BUILD!
-$MAKE -j "$($NPROC)" V=1
-$MAKE install
+print_header "BUILD!"
+$BEAR ${BEAR:+--} $MAKE -j "$($NPROC)" V=1
-# Run tests
-$MAKE --keep-going check
+# Install in the workspace if enabled
+if [ "$BABELTRACE_MAKE_INSTALL" = "yes" ]; then
+ print_header "Install"
-# Copy tap logs for the jenkins tap parser
-rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$WORKSPACE/tap"
+ $MAKE install V=1 DESTDIR="$WORKSPACE"
-# Clean the build directory
-$MAKE clean
+ # Cleanup rpath in executables and shared libraries
+ find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
+ find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.so" -exec chrpath --delete {} \;
-# Cleanup rpath in executables and shared libraries
-find "$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
-find "$PREFIX/lib" -name "*.so" -exec chrpath --delete {} \;
+ # Remove libtool .la files
+ find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -delete
+fi
+
+# Run clang-tidy on the topmost commit
+if [ "$BABELTRACE_CLANG_TIDY" = "yes" ]; then
+ print_header "Run clang-tidy"
+
+ # This would be better by linting only the lines touched by a patch but it
+ # doesn't seem to work, the lines are always filtered and no error is
+ # reported.
+ #git diff -U0 HEAD^ | clang-tidy-diff -p1 -j "$($NPROC)" -timeout 60 -fix
+
+ # Instead, run clan-tidy on all the files touched by the patch.
+ while read -r filepath; do
+ if [[ "$filepath" =~ (\.cpp|\.hhp|\.c|\.h)$ ]]; then
+ clang-tidy --fix-errors "$(realpath "$filepath")"
+ fi
+ done < <(git diff-tree --no-commit-id --diff-filter=d --name-only -r HEAD)
+
+ # If the tree has local changes, the formatting was incorrect
+ GIT_DIFF_OUTPUT=$(git diff)
+ if [ -n "$GIT_DIFF_OUTPUT" ]; then
+ echo "Saving clang-tidy proposed fixes in clang-tidy-fixes.diff"
+ git diff > "$WORKSPACE/clang-tidy-fixes.diff"
+
+ # Restore the unfixed files so they can be viewed in the warnings web
+ # interface
+ git checkout .
+ exit_status=1
+ fi
+fi
-# Remove libtool .la files
-find "$PREFIX/lib" -name "*.la" -exec rm -f {} \;
+# Run tests if enabled
+if [ "$BABELTRACE_RUN_TESTS" = "yes" ]; then
+ print_header "Run test suite"
-# Clean temp dir for dist build
-if [ "$build" = "dist" ]; then
- cd "$SRCDIR"
- rm -rf "$BUILD_PATH"
+ # Run tests, don't fail now, we want to run the archiving steps
+ $MAKE --keep-going check || exit_status=1
+
+ # Copy tap logs for the jenkins tap parser before cleaning the build dir
+ rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$WORKSPACE/tap"
+
+ # Copy the test suites top-level log which includes all tests failures
+ rsync -a --include 'test-suite.log' --include '*/' --exclude='*' tests/ "$WORKSPACE/log"
fi
+# Clean the build directory
+if [ "$BABELTRACE_MAKE_CLEAN" = "yes" ]; then
+ print_header "Clean"
+ $MAKE clean
+fi
+
+print_header "Babeltrace build script ended with: $(test $exit_status == 0 && echo SUCCESS || echo FAILURE)"
+
+# Exit with failure if any of the tests failed
+exit $exit_status
+
# EOF
+# vim: expandtab tabstop=4 shiftwidth=4
projects / lttng-ci.git / blobdiff