-#!/bin/bash -exu
+#!/bin/bash
#
-# Copyright (C) 2015 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
-# 2016-2019 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
[ "$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"
+
+ # End the build with failure
+ exit 1
+}
+
+print_header "LTTng-UST build script starting"
+
+# Required variables
+WORKSPACE=${WORKSPACE:-}
+
+# Axis
+platform=${platform:-}
conf=${conf:-}
build=${build:-}
cc=${cc:-}
+# Build steps that can be overriden by the environment
+LTTNG_UST_MAKE_INSTALL="${LTTNG_UST_MAKE_INSTALL:-yes}"
+LTTNG_UST_MAKE_CLEAN="${LTTNG_UST_MAKE_CLEAN:-yes}"
+LTTNG_UST_GEN_COMPILE_COMMANDS="${LTTNG_UST_GEN_COMPILE_COMMANDS:-no}"
+LTTNG_UST_RUN_TESTS="${LTTNG_UST_RUN_TESTS:-yes}"
+LTTNG_UST_CLANG_TIDY="${LTTNG_UST_CLANG_TIDY:-no}"
+
+SRCDIR="$WORKSPACE/src/lttng-ust"
+TMPDIR="$WORKSPACE/tmp"
+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
DEPS_INC="$WORKSPACE/deps/build/include"
-DEPS_LIB="$WORKSPACE/deps/build/lib"
+DEPS_LIB="$WORKSPACE/deps/build/$LIBDIR_ARCH"
+DEPS_PKGCONFIG="$DEPS_LIB/pkgconfig"
+#DEPS_BIN="$WORKSPACE/deps/build/bin"
+#DEPS_JAVA="$WORKSPACE/deps/build/share/java"
export LD_LIBRARY_PATH="$DEPS_LIB:${LD_LIBRARY_PATH:-}"
+export PKG_CONFIG_PATH="$DEPS_PKGCONFIG"
export CPPFLAGS="-I$DEPS_INC"
export LDFLAGS="-L$DEPS_LIB"
-SRCDIR="$WORKSPACE/src/lttng-ust"
-TMPDIR="$WORKSPACE/tmp"
-PREFIX="/build"
+exit_status=0
+
+# Use bear to generate compile_commands.json when enabled
+BEAR=""
+if [ "$LTTNG_UST_GEN_COMPILE_COMMANDS" = "yes" ]; then
+ BEAR="bear"
+fi
# Create tmp directory
rm -rf "$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
;;
esac
-if [ "x${CC:-}" != "x" ]; then
- echo "Selected compiler:"
- "$CC" -v
-fi
-
# Set platform variables
-case "$arch" in
+case "$platform" in
+freebsd*)
+ export MAKE=gmake
+ export TAR=tar
+ export NPROC="getconf _NPROCESSORS_ONLN"
+ export CPPFLAGS="-I/usr/local/include $CPPFLAGS"
+ export LDFLAGS="-L/usr/local/lib $LDFLAGS"
+ export PYTHON="python3"
+ export PYTHON_CONFIG="python3-config"
+ export CLASSPATH='/usr/local/share/java/classes/*'
+ export JAVA_HOME='/usr/local/openjdk17'
+ ;;
+
*)
export MAKE=make
export TAR=tar
export NPROC=nproc
export PYTHON="python3"
export PYTHON_CONFIG="python3-config"
+ export CLASSPATH='/usr/share/java/log4j-api.jar:/usr/share/java/log4j-core.jar:/usr/share/java/log4j-1.2.jar'
;;
esac
+if [[ -f /etc/products.d/SLES.prod ]] ; then
+ SLES_VERSION="$(grep -E '</version>' /etc/products.d/SLES.prod | grep -E -o '[0-9]+\.[0-9]+')"
+ if vergte "${SLES_VERSION}" "15.5" ; then
+ export CLASSPATH='/usr/share/java/log4j/log4j-api.jar:/usr/share/java/log4j/log4j-core.jar:/usr/share/java/log4j12/log4j-12.jar'
+ fi
+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*/}
# Set configure options and environment variables for each build
# configuration.
-CONF_OPTS=("--prefix=$PREFIX")
+CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--disable-maintainer-mode")
case "$conf" in
static)
- # Unsupported! liblttng-ust can't pull in it's static (.a) dependencies.
- echo "Static lib only configuration"
+ print_header "Conf: Static lib only"
CONF_OPTS+=("--enable-static" "--disable-shared")
+
+ # Unsupported! liblttng-ust can't pull in it's static (.a) dependencies.
+ exit 1
;;
agents)
- echo "Java and Python agents configuration"
+ print_header "Conf: Java and Python agents"
- export CLASSPATH="/usr/share/java/log4j-1.2.jar"
CONF_OPTS+=("--enable-java-agent-all" "--enable-jni-interface" "--enable-python-agent")
+
+ # Explicitly add '--enable-java-agent-log4j2', it's not part of '-all' in stable 2.12/2.13
+ if verlt "$PACKAGE_VERSION" "2.14"; then
+ CONF_OPTS+=("--enable-java-agent-log4j2")
+ fi
;;
debug-rcu)
- echo "Enable RCU sanity checks for debugging"
+ print_header "Conf: Enable RCU sanity checks for debugging"
+
export CPPFLAGS="${CPPFLAGS} -DDEBUG_RCU"
;;
*)
- echo "Standard configuration"
+ print_header "Conf: Standard"
+
+ # Something is broken in docbook-xml on yocto
+ if [[ "$platform" = yocto* ]]; then
+ CONF_OPTS+=("--disable-man-pages")
+ fi
;;
esac
# before continuing.
case "$build" in
oot)
- echo "Out of tree build"
+ print_header "Build: Out of tree"
# Create and enter a temporary build directory
builddir=$(mktemp -d)
cd "$builddir"
- "$SRCDIR/configure" "${CONF_OPTS[@]}"
+ "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
;;
dist)
- echo "Distribution in-tree build"
+ print_header "Build: Distribution In-tree"
# Run configure and generate the tar file
# in the source directory
- ./configure
+ ./configure --enable-jni-interface || failed_configure
$MAKE dist
# Create and enter a temporary build directory
$TAR xvf "$SRCDIR"/*.tar.* --strip 1
# Build in extracted source tree
- ./configure "${CONF_OPTS[@]}"
+ ./configure "${CONF_OPTS[@]}" || failed_configure
;;
oot-dist)
- echo "Distribution out of tree build"
+ 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"
+ "$SRCDIR/configure" --enable-jni-interface || failed_configure
$MAKE dist
dist_srcdir="$(mktemp -d)"
# Run configure from the extracted distribution tar,
# out of the source tree
- "$dist_srcdir/configure" "${CONF_OPTS[@]}"
+ "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
;;
*)
- echo "Standard in-tree build"
- ./configure "${CONF_OPTS[@]}"
+ 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
+print_header "BUILD!"
+$BEAR ${BEAR:+--} $MAKE -j "$($NPROC)" V=1
+
+# Install in the workspace if enabled
+if [ "$LTTNG_UST_MAKE_INSTALL" = "yes" ]; then
+ print_header "Install"
+
+ $MAKE install V=1 DESTDIR="$WORKSPACE"
+
+ # 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 {} \;
+
+ # Remove libtool .la files
+ find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -delete
+fi
-# Install in the workspace
-$MAKE install DESTDIR="$WORKSPACE"
+# Run clang-tidy on the topmost commit
+if [ "$LTTNG_UST_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
# Run tests, don't fail now, we want to run the archiving steps
-set +e
-$MAKE --keep-going check
-ret=$?
-set -e
+if [ "$LTTNG_UST_RUN_TESTS" = "yes" ]; then
+ $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 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
-$MAKE clean
+if [ "$LTTNG_UST_MAKE_CLEAN" = "yes" ]; then
+ print_header "Clean"
-# Cleanup rpath in executables and shared libraries
-find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
-find "$WORKSPACE/$PREFIX/lib" -name "*.so" -exec chrpath --delete {} \;
+ $MAKE clean
+fi
-# Remove libtool .la files
-find "$WORKSPACE/$PREFIX/lib" -name "*.la" -exec rm -f {} \;
+print_header "LTTng-UST build script ended with: $(test $exit_status == 0 && echo SUCCESS || echo FAILURE)"
-# Exit with the return code of the test suite
-exit $ret
+# Exit with failure if any of the tests failed
+exit $exit_status
# EOF
+# vim: expandtab tabstop=4 shiftwidth=4