scripts/lttng-tools/build.sh

   1 #!/bin/bash
   2 # shellcheck disable=SC2103
   3 #
   4 # Copyright (C) 2016 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
   5 # Copyright (C) 2016-2020 Michael Jeanson <mjeanson@efficios.com>
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 set -exu
  21
  22 # Version compare functions
  23 vercomp () {
  24     set +u
  25     if [[ "$1" == "$2" ]]; then
  26         return 0
  27     fi
  28     local IFS=.
  29     # Ignore the shellcheck warning, we want splitting to happen based on IFS.
  30     # shellcheck disable=SC2206
  31     local i ver1=($1) ver2=($2)
  32     # fill empty fields in ver1 with zeros
  33     for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
  34         ver1[i]=0
  35     done
  36     for ((i=0; i<${#ver1[@]}; i++)); do
  37         if [[ -z ${ver2[i]} ]]; then
  38             # fill empty fields in ver2 with zeros
  39             ver2[i]=0
  40         fi
  41         if ((10#${ver1[i]} > 10#${ver2[i]})); then
  42             return 1
  43         fi
  44         if ((10#${ver1[i]} < 10#${ver2[i]})); then
  45             return 2
  46         fi
  47     done
  48     set -u
  49     return 0
  50 }
  51
  52 verlte() {
  53     vercomp "$1" "$2"; local res="$?"
  54     [ "$res" -eq "0" ] || [ "$res" -eq "2" ]
  55 }
  56
  57 verlt() {
  58     vercomp "$1" "$2"; local res="$?"
  59     [ "$res" -eq "2" ]
  60 }
  61
  62 vergte() {
  63     vercomp "$1" "$2"; local res="$?"
  64     [ "$res" -eq "0" ] || [ "$res" -eq "1" ]
  65 }
  66
  67 vergt() {
  68     vercomp "$1" "$2"; local res="$?"
  69     [ "$res" -eq "1" ]
  70 }
  71
  72 verne() {
  73     vercomp "$1" "$2"; local res="$?"
  74     [ "$res" -ne "0" ]
  75 }
  76
  77 failed_configure() {
  78     # Assume we are in the configured build directory
  79     echo "#################### BEGIN config.log ####################"
  80     cat config.log
  81     echo "#################### END config.log ####################"
  82
  83     # End the build with failure
  84     exit 1
  85 }
  86
  87 set_execute_traversal_bit()
  88 {
  89     path=$1
  90
  91     level="$path"
  92     if [ ! -d "$path" ]; then
  93         fail "Path is not a directory"
  94     fi
  95     while level="$(dirname "$level")"
  96     do
  97         if [ "$level" = / ]; then
  98             break
  99         fi
 100         chmod a+x "$level"
 101     done
 102     chmod a+x "$path"
 103 }
 104
 105 # Required variables
 106 WORKSPACE=${WORKSPACE:-}
 107
 108 platform=${platform:-}
 109 conf=${conf:-}
 110 build=${build:-}
 111 cc=${cc:-}
 112 test_type=${test_type:-}
 113
 114 SRCDIR="$WORKSPACE/src/lttng-tools"
 115 TAPDIR="$WORKSPACE/tap"
 116 PREFIX="/build"
 117 LIBDIR="lib"
 118
 119 # RHEL and SLES both use lib64 but don't bother shipping a default autoconf
 120 # site config that matches this.
 121 if [[ ( -f /etc/redhat-release || -f /etc/SuSE-release ) && ( "$(uname -m)" == "x86_64" ) ]]; then
 122     LIBDIR_ARCH="${LIBDIR}64"
 123 else
 124     LIBDIR_ARCH="$LIBDIR"
 125 fi
 126
 127 DEPS_INC="$WORKSPACE/deps/build/include"
 128 DEPS_LIB="$WORKSPACE/deps/build/$LIBDIR_ARCH"
 129 DEPS_PKGCONFIG="$DEPS_LIB/pkgconfig"
 130 DEPS_BIN="$WORKSPACE/deps/build/bin"
 131 DEPS_JAVA="$WORKSPACE/deps/build/share/java"
 132
 133 export PATH="$DEPS_BIN:$PATH"
 134 export LD_LIBRARY_PATH="$DEPS_LIB:${LD_LIBRARY_PATH:-}"
 135 export PKG_CONFIG_PATH="$DEPS_PKGCONFIG"
 136 export CPPFLAGS="-I$DEPS_INC"
 137 export LDFLAGS="-L$DEPS_LIB"
 138
 139
 140 # Create tmp directory
 141 TMPDIR="$WORKSPACE/tmp"
 142 mkdir -p "$TMPDIR"
 143
 144 # Use a symlink in /tmp to point to the the tmp directory
 145 # inside the workspace, this is to work around the path length
 146 # limit of unix sockets which are created by the test suite.
 147 tmpdir="$(mktemp)"
 148 ln -sf "$TMPDIR" "$tmpdir"
 149 export TMPDIR="$tmpdir"
 150
 151 # Create a symlink to "babeltrace" when the "babeltrace2" executable is found.
 152 # This is a temporary workaround until lttng-tools either allows the override of
 153 # the trace reader in its test suite or that we move to only supporting
 154 # babeltrace2
 155 if [ -x "$DEPS_BIN/babeltrace2" ]; then
 156     ln -s "$DEPS_BIN/babeltrace2" "$DEPS_BIN/babeltrace"
 157 fi
 158
 159 # When using babeltrace2 make sure that it finds its plugins and
 160 # plugin-providers.
 161 export BABELTRACE_PLUGIN_PATH="$DEPS_LIB/babeltrace2/plugins/"
 162 export LIBBABELTRACE2_PLUGIN_PROVIDER_DIR="$DEPS_LIB/babeltrace2/plugin-providers/"
 163
 164 export CFLAGS="-g -O2"
 165 export CXXFLAGS="-g -O2"
 166
 167 # Set compiler variables
 168 case "$cc" in
 169 gcc)
 170     export CC=gcc
 171     export CXX=g++
 172     ;;
 173 gcc-4.8)
 174     export CC=gcc-4.8
 175     export CXX=g++-4.8
 176     ;;
 177 gcc-5)
 178     export CC=gcc-5
 179     export CXX=g++-5
 180     ;;
 181 gcc-6)
 182     export CC=gcc-6
 183     export CXX=g++-6
 184     ;;
 185 gcc-7)
 186     export CC=gcc-7
 187     export CXX=g++-7
 188     ;;
 189 gcc-8)
 190     export CC=gcc-8
 191     export CXX=g++-8
 192     ;;
 193 clang)
 194     export CC=clang
 195     export CXX=clang++
 196     ;;
 197 clang-3.9)
 198     export CC=clang-3.9
 199     export CXX=clang++-3.9
 200     ;;
 201 clang-4.0)
 202     export CC=clang-4.0
 203     export CXX=clang++-4.0
 204     ;;
 205 clang-5.0)
 206     export CC=clang-5.0
 207     export CXX=clang++-5.0
 208     ;;
 209 clang-6.0)
 210     export CC=clang-6.0
 211     export CXX=clang++-6.0
 212     ;;
 213 clang-7)
 214     export CC=clang-7
 215     export CXX=clang++-7
 216     ;;
 217 *)
 218     if [ "x$cc" != "x" ]; then
 219         export CC="$cc"
 220     fi
 221     ;;
 222 esac
 223
 224 if [ "x${CC:-}" != "x" ]; then
 225     echo "Selected compiler:"
 226     "$CC" -v
 227 fi
 228
 229 # Set platform variables
 230 case "$platform" in
 231 macos*)
 232     export MAKE=make
 233     export TAR=tar
 234     export NPROC="getconf _NPROCESSORS_ONLN"
 235     export PATH="/opt/local/bin:/opt/local/sbin:$PATH"
 236     export CPPFLAGS="-I/opt/local/include $CPPFLAGS"
 237     export LDFLAGS="-L/opt/local/lib $LDFLAGS"
 238     export PYTHON="python3"
 239     export PYTHON_CONFIG="python3-config"
 240
 241     LTTNG_TOOLS_RUN_TESTS="no"
 242     ;;
 243
 244 cygwin|cygwin64|msys32|msys64)
 245     export MAKE=make
 246     export TAR=tar
 247     export NPROC=nproc
 248
 249     LTTNG_TOOLS_RUN_TESTS="no"
 250     ;;
 251
 252 *)
 253     export MAKE=make
 254     export TAR=tar
 255     export NPROC=nproc
 256
 257     LTTNG_TOOLS_RUN_TESTS="yes"
 258
 259     PYTHON2=python2
 260     PYTHON3=python3
 261
 262     if command -v $PYTHON2 >/dev/null 2>&1; then
 263         P2_VERSION=$($PYTHON2 -c 'import sys;v = sys.version.split()[0].split("."); print("{}.{}".format(v[0], v[1]))')
 264         DEPS_PYTHON2="$WORKSPACE/deps/build/$LIBDIR/python$P2_VERSION/site-packages"
 265         if [ "$LIBDIR" != "$LIBDIR_ARCH" ]; then
 266             DEPS_PYTHON2="$DEPS_PYTHON2:$WORKSPACE/deps/build/$LIBDIR_ARCH/python$P2_VERSION/site-packages"
 267         fi
 268     fi
 269
 270     P3_VERSION=$($PYTHON3 -c 'import sys;v = sys.version.split()[0].split("."); print("{}.{}".format(v[0], v[1]))')
 271     DEPS_PYTHON3="$WORKSPACE/deps/build/$LIBDIR/python$P3_VERSION/site-packages"
 272     if [ "$LIBDIR" != "$LIBDIR_ARCH" ]; then
 273         DEPS_PYTHON3="$DEPS_PYTHON3:$WORKSPACE/deps/build/$LIBDIR_ARCH/python$P3_VERSION/site-packages"
 274     fi
 275
 276     # Most build configs require access to the babeltrace 2 python bindings.
 277     # This also makes the lttngust python agent available for `agents` builds.
 278     export PYTHONPATH="${DEPS_PYTHON2:-}${DEPS_PYTHON2:+:}$DEPS_PYTHON3"
 279     ;;
 280 esac
 281
 282 # The missing-field-initializers warning code is very dumb in GCC 4.8 on
 283 # SLES12, disable it even if it's available.
 284 if [[ $platform = sles12sp5* ]]; then
 285     CFLAGS="$CFLAGS -Wno-missing-field-initializers"
 286     CXXFLAGS="$CXXFLAGS -Wno-missing-field-initializers"
 287 fi
 288
 289 case "$test_type" in
 290 full)
 291     LTTNG_TOOLS_RUN_TESTS_LONG_REGRESSION="yes"
 292     ;;
 293 *)
 294     LTTNG_TOOLS_RUN_TESTS_LONG_REGRESSION="no"
 295     ;;
 296 esac
 297
 298 # If we have modules, build them
 299 if [ -d "$WORKSPACE/src/lttng-modules" ]; then
 300     cd "$WORKSPACE/src/lttng-modules"
 301     $MAKE -j"$($NPROC)" V=1
 302     $MAKE modules_install V=1
 303     depmod
 304 fi
 305
 306 # Print build env details
 307 print_os || true
 308 print_tooling || true
 309
 310 # Enter the source directory
 311 cd "$SRCDIR"
 312
 313 # Run bootstrap in the source directory prior to configure
 314 ./bootstrap
 315
 316 # Get source version from configure script
 317 eval "$(grep '^PACKAGE_VERSION=' ./configure)"
 318 PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
 319
 320
 321 # The switch to build without UST changed in 2.8
 322 if vergte "$PACKAGE_VERSION" "2.8"; then
 323     NO_UST="--without-lttng-ust"
 324 else
 325     NO_UST="--disable-lttng-ust"
 326 fi
 327
 328 # Most build configs require the python bindings
 329 CONF_OPTS=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--enable-python-bindings")
 330
 331 DIST_CONF_OPTS=()
 332
 333 # Set configure options and environment variables for each build
 334 # configuration.
 335 case "$conf" in
 336 static)
 337     echo "Static lib only configuration"
 338
 339     CONF_OPTS+=("--enable-static" "--disable-shared")
 340     ;;
 341
 342 no-ust)
 343     echo "Build without UST support"
 344     CONF_OPTS+=("$NO_UST")
 345     DIST_CONF_OPTS+=("$NO_UST")
 346     ;;
 347
 348 agents)
 349     echo "Java and Python agents configuration"
 350
 351     export JAVA_HOME="/usr/lib/jvm/default-java"
 352     export CLASSPATH="$DEPS_JAVA/lttng-ust-agent-all.jar:/usr/share/java/log4j-api.jar:/usr/share/java/log4j-core.jar:/usr/share/java/log4j-1.2.jar"
 353
 354     CONF_OPTS+=("--enable-test-java-agent-all" "--enable-test-python-agent-all")
 355
 356     # Explicitly add '--enable-test-java-agent-log4j2', it's not part of '-all' in stable 2.12/2.13
 357     if verlt "$PACKAGE_VERSION" "2.14"; then
 358         CONF_OPTS+=("--enable-test-java-agent-log4j2")
 359     fi
 360     ;;
 361
 362 relayd-only)
 363     echo "Relayd only configuration"
 364
 365     CONF_OPTS=("--prefix=$PREFIX" "--disable-bin-lttng" "--disable-bin-lttng-consumerd" "--disable-bin-lttng-crash" "--disable-bin-lttng-sessiond" "--disable-extras" "--disable-man-pages" "$NO_UST")
 366     ;;
 367
 368 debug-rcu)
 369     echo "Enable RCU sanity checks for debugging"
 370
 371     export CPPFLAGS="$CPPFLAGS -DDEBUG_RCU"
 372     ;;
 373
 374 *)
 375     echo "Standard configuration"
 376
 377     # Something is broken in docbook-xml on yocto
 378     if [[ "$platform" = yocto* ]]; then
 379         CONF_OPTS+=("--disable-man-pages")
 380     fi
 381     ;;
 382 esac
 383
 384 # Build type
 385 # oot     : out-of-tree build
 386 # dist    : build via make dist
 387 # oot-dist: build via make dist out-of-tree
 388 # *       : normal tree build
 389 #
 390 # Make sure to move to the build directory and run configure
 391 # before continuing.
 392 case "$build" in
 393 oot)
 394     echo "Out of tree build"
 395
 396     # Create and enter a temporary build directory
 397     builddir=$(mktemp -d)
 398     cd "$builddir"
 399
 400     "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
 401     ;;
 402
 403 dist)
 404     echo "Distribution in-tree build"
 405
 406     # Run configure and generate the tar file
 407     # in the source directory
 408     ./configure "${DIST_CONF_OPTS[@]}" || failed_configure
 409     $MAKE dist
 410
 411     # Create and enter a temporary build directory
 412     builddir=$(mktemp -d)
 413     cd "$builddir"
 414
 415     # Extract the distribution tar in the build directory,
 416     # ignore the first directory level
 417     $TAR xvf "$SRCDIR"/*.tar.* --strip 1
 418
 419     # Build in extracted source tree
 420     ./configure "${CONF_OPTS[@]}" || failed_configure
 421     ;;
 422
 423 oot-dist)
 424     echo "Distribution out of tree build"
 425
 426     # Create and enter a temporary build directory
 427     builddir=$(mktemp -d)
 428     cd "$builddir"
 429
 430     # Run configure out of tree and generate the tar file
 431     "$SRCDIR/configure" "${DIST_CONF_OPTS[@]}" || failed_configure
 432     $MAKE dist
 433
 434     dist_srcdir="$(mktemp -d)"
 435     cd "$dist_srcdir"
 436
 437     # Extract the distribution tar in the new source directory,
 438     # ignore the first directory level
 439     $TAR xvf "$builddir"/*.tar.* --strip 1
 440
 441     # Create and enter a second temporary build directory
 442     builddir="$(mktemp -d)"
 443     cd "$builddir"
 444
 445     # Run configure from the extracted distribution tar,
 446     # out of the source tree
 447     "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
 448     ;;
 449
 450 *)
 451     echo "Standard in-tree build"
 452     ./configure "${CONF_OPTS[@]}" || failed_configure
 453     ;;
 454 esac
 455
 456 # We are now inside a configured build directory
 457
 458 # BUILD!
 459 $MAKE -j "$($NPROC)" V=1
 460
 461 # Install in the workspace
 462 $MAKE install DESTDIR="$WORKSPACE"
 463
 464 # Run tests for all configs except 'no-ust'
 465 failed_tests=0
 466 if [ "$LTTNG_TOOLS_RUN_TESTS" = "yes" ] && [ "$conf" != "no-ust" ]; then
 467     # Allow core dumps
 468     ulimit -c unlimited
 469
 470     # Force the lttng-sessiond path to /bin/true to prevent the spawing of a
 471     # lttng-sessiond --daemonize on "lttng create"
 472     export LTTNG_SESSIOND_PATH="/bin/true"
 473
 474     # Run 'unit_tests', 2.8 and up has a new test suite
 475     if vergte "$PACKAGE_VERSION" "2.8"; then
 476         # It is implied that tests depending on LTTNG_ENABLE_DESTRUCTIVE_TESTS
 477         # only run for the root user. Note that here `destructive` means that
 478         # operations are performed at the host level (add user etc.) that
 479         # effectively modify the host. Running those tests are acceptable on our
 480         # CI and root jobs since we always run root tests against a `snapshot`
 481         # of the host.
 482         if [ "$(id -u)" == "0" ]; then
 483             # Allow the traversal of all directories leading to the
 484             # DEPS_LIBS directory to enable test app run by temp users to
 485             # access lttng-ust.
 486             set_execute_traversal_bit "$DEPS_LIB"
 487             # Allow `all` to interact with all deps libs.
 488             chmod a+rwx -R "$DEPS_LIB"
 489
 490             export LTTNG_ENABLE_DESTRUCTIVE_TESTS="will-break-my-system"
 491
 492             # Some destructive tests play with the system clock, disable timesyncd
 493             systemctl stop systemd-timesyncd.service || true
 494         fi
 495
 496         make --keep-going check || failed_tests=1
 497         rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$TAPDIR"
 498     else
 499         cd tests
 500         mkdir -p "$TAPDIR/unit"
 501         mkdir -p "$TAPDIR/fast_regression"
 502         mkdir -p "$TAPDIR/with_bindings_regression"
 503         prove --merge -v --exec '' - < unit_tests --archive "$TAPDIR/unit/" || failed_tests=1
 504         prove --merge -v --exec '' - < fast_regression --archive "$TAPDIR/fast_regression/" || failed_tests=1
 505         prove --merge -v --exec '' - < with_bindings_regression --archive "$TAPDIR/with_bindings_regression/" || failed_tests=1
 506         cd ..
 507     fi
 508
 509     if [ "$LTTNG_TOOLS_RUN_TESTS_LONG_REGRESSION" = "yes" ]; then
 510         cd tests
 511         mkdir -p "$TAPDIR/long_regression"
 512         prove --merge -v --exec '' - < long_regression --archive "$TAPDIR/long_regression/" || failed_tests=1
 513         cd ..
 514     fi
 515
 516     # TAP plugin is having a hard time with .yml files.
 517     find "$TAPDIR" -name "meta.yml" -exec rm -f {} \;
 518 else
 519     # The TAP plugin will fail the job if no test logs are present
 520     mkdir -p "$TAPDIR/no-tests"
 521     echo "1..1" > "$TAPDIR/no-tests/tests.log"
 522     echo "ok 1 - Test suite disabled" >> "$TAPDIR/no-tests/tests.log"
 523 fi
 524
 525 # Clean the build directory
 526 $MAKE clean
 527
 528 # Cleanup rpath in executables
 529 find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
 530
 531 # Some configs don't build liblttng-ctl
 532 if [ -d "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" ]; then
 533     # Cleanup rpath in shared libraries
 534     find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.so" -exec chrpath --delete {} \;
 535     # Remove libtool .la files
 536     find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -exec rm -f {} \;
 537 fi
 538
 539 # Exit with failure if any of the tests failed
 540 exit $failed_tests
 541
 542 # EOF