-#!/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/>.
-
-# Required parameters
-arch=${arch:-}
+# 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 () {
+ set +u
+ if [[ "$1" == "$2" ]]; then
+ 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
+ ver1[i]=0
+ done
+ for ((i=0; i<${#ver1[@]}; i++)); do
+ if [[ -z ${ver2[i]} ]]; then
+ # fill empty fields in ver2 with zeros
+ ver2[i]=0
+ fi
+ if ((10#${ver1[i]} > 10#${ver2[i]})); then
+ return 1
+ fi
+ if ((10#${ver1[i]} < 10#${ver2[i]})); then
+ return 2
+ fi
+ done
+ set -u
+ return 0
+}
+
+verlte() {
+ vercomp "$1" "$2"; local res="$?"
+ [ "$res" -eq "0" ] || [ "$res" -eq "2" ]
+}
+
+verlt() {
+ vercomp "$1" "$2"; local res="$?"
+ [ "$res" -eq "2" ]
+}
+
+vergte() {
+ vercomp "$1" "$2"; local res="$?"
+ [ "$res" -eq "0" ] || [ "$res" -eq "1" ]
+}
+
+vergt() {
+ vercomp "$1" "$2"; local res="$?"
+ [ "$res" -eq "1" ]
+}
+
+verne() {
+ vercomp "$1" "$2"; local res="$?"
+ [ "$res" -ne "0" ]
+}
+
+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:-}
-
-# liburcu
-URCU_INCS="$WORKSPACE/deps/liburcu/build/include/"
-URCU_LIBS="$WORKSPACE/deps/liburcu/build/lib/"
+# 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="$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
+
+DEPS_INC="$WORKSPACE/deps/build/include"
+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"
-# 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 [ "$LTTNG_UST_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
+gcc)
+ export CC=gcc
+ export CXX=g++
+ ;;
+gcc-*)
+ export CC=gcc-${cc#gcc-}
+ export CXX=g++-${cc#gcc-}
+ ;;
+clang)
+ export CC=clang
+ export CXX=clang++
+ ;;
+clang-*)
+ export CC=clang-${cc#clang-}
+ export CXX=clang++-${cc#clang-}
+ ;;
+*)
+ if [ "x$cc" != "x" ]; then
+ export CC="$cc"
+ fi
+ ;;
+esac
# 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'
+ ;;
+
*)
- MAKE=make
- TAR=tar
- NPROC=nproc
- #BISON="bison"
- #YACC="$BISON -y"
- #CFLAGS=""
- ;;
+ 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
-# Export build flags
-export CPPFLAGS="-I$URCU_INCS"
-export LDFLAGS="-L$URCU_LIBS"
-export LD_LIBRARY_PATH="$URCU_LIBS:${LD_LIBRARY_PATH:-}"
+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 for each build configuration
-CONF_OPTS=""
+# Set configure options and environment variables for each build
+# configuration.
+CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--disable-maintainer-mode")
case "$conf" in
static)
+ print_header "Conf: Static lib only"
+
+ CONF_OPTS+=("--enable-static" "--disable-shared")
+
# Unsupported! liblttng-ust can't pull in it's static (.a) dependencies.
- echo "Static build"
- CONF_OPTS="--enable-static --disable-shared"
+ exit 1
;;
agents)
- echo "Enable Java agent build"
- export CLASSPATH="/usr/share/java/log4j-1.2.jar"
- CONF_OPTS+=" --enable-java-agent-all --enable-jni-interface"
+ print_header "Conf: Java and Python agents"
- echo "Enable Python agent build"
- CONF_OPTS+=" --enable-python-agent"
- ;;
+ CONF_OPTS+=("--enable-java-agent-all" "--enable-jni-interface" "--enable-python-agent")
-*)
- echo "Standard build"
- CONF_OPTS=""
+ # 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
;;
-esac
-# Enter the source directory
-cd "$SRCDIR"
+debug-rcu)
+ print_header "Conf: Enable RCU sanity checks for debugging"
-# Run bootstrap in the source directory prior to configure
-./bootstrap
+ export CPPFLAGS="${CPPFLAGS} -DDEBUG_RCU"
+ ;;
+*)
+ print_header "Conf: Standard"
+
+ # 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
# 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
+ print_header "Build: Out of tree"
- mkdir -p "$BUILD_PATH"
- cd "$BUILD_PATH"
+ # Create and enter a temporary build directory
+ builddir=$(mktemp -d)
+ cd "$builddir"
- "$SRCDIR/configure" --prefix="$PREFIX" $CONF_OPTS
+ "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
;;
dist)
- echo "Distribution tarball in-tree build"
+ print_header "Build: Distribution In-tree"
- # Initial configure and generate tarball
- "$SRCDIR/configure"
+ # Run configure and generate the tar file
+ # in the source directory
+ ./configure --enable-jni-interface || failed_configure
$MAKE dist
- BUILD_PATH="$(mktemp -d)"
- cp ./*.tar.* "$BUILD_PATH/"
- cd "$BUILD_PATH"
+ # Create and enter a temporary build directory
+ builddir=$(mktemp -d)
+ cd "$builddir"
- # Ignore level 1 of tar
- $TAR xvf ./*.tar.* --strip 1
+ # Extract the distribution tar in the build directory,
+ # ignore the first directory level
+ $TAR xvf "$SRCDIR"/*.tar.* --strip 1
# Build in extracted source tree
- "$BUILD_PATH/configure" --prefix="$PREFIX" $CONF_OPTS
+ ./configure "${CONF_OPTS[@]}" || failed_configure
;;
oot-dist)
- echo "Distribution tarball out of tree build"
- BUILD_PATH="$(mktemp -d)"
- cd "$BUILD_PATH"
+ print_header "Build: Distribution Out of tree"
- # Initial configure and generate tarball
- "$SRCDIR/configure"
+ # Create and enter a temporary build directory
+ builddir=$(mktemp -d)
+ cd "$builddir"
+
+ # Run configure out of tree and generate the tar file
+ "$SRCDIR/configure" --enable-jni-interface || failed_configure
$MAKE dist
- NEWSRC_PATH="$(mktemp -d)"
- cp ./*.tar.* "$NEWSRC_PATH/"
- cd "$NEWSRC_PATH"
+ dist_srcdir="$(mktemp -d)"
+ cd "$dist_srcdir"
- # Ignore level 1 of tar
- $TAR xvf ./*.tar.* --strip 1
+ # Extract the distribution tar in the new source directory,
+ # ignore the first directory level
+ $TAR xvf "$builddir"/*.tar.* --strip 1
- BUILD_PATH="$(mktemp -d)"
- cd "$BUILD_PATH"
+ # Create and enter a second temporary build directory
+ builddir="$(mktemp -d)"
+ cd "$builddir"
- # Build oot from extracted sources
- "$NEWSRC_PATH/configure" --prefix="$PREFIX" $CONF_OPTS
+ # Run configure from the extracted distribution tar,
+ # out of the source tree
+ "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
;;
*)
- echo "Standard in-tree build"
- "$BUILD_PATH/configure" --prefix="$PREFIX" $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
-$MAKE install
+print_header "BUILD!"
+$BEAR ${BEAR:+--} $MAKE -j "$($NPROC)" V=1
-# Run tests
-$MAKE check
+# Install in the workspace if enabled
+if [ "$LTTNG_UST_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 {} \;
+
+ # Remove libtool .la files
+ find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -delete
+fi
+
+# 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
-# Cleanup rpath in executables and shared libraries
-find "$PREFIX/lib" -name "*.so" -exec chrpath --delete {} \;
+# Run tests, don't fail now, we want to run the archiving steps
+if [ "$LTTNG_UST_RUN_TESTS" = "yes" ]; then
+ $MAKE --keep-going check || exit_status=1
-# Remove libtool .la files
-find "$PREFIX/lib" -name "*.la" -exec rm -f {} \;
+ # 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"
-# Clean temp dir for dist build
-if [ "$build" = "dist" ]; then
- cd "$SRCDIR"
- rm -rf "$BUILD_PATH"
+ # 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 [ "$LTTNG_UST_MAKE_CLEAN" = "yes" ]; then
+ print_header "Clean"
+
+ $MAKE clean
+fi
+
+print_header "LTTng-UST 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