scripts/lttng-tools/build.sh

   1 #!/bin/bash -exu
   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 # Version compare functions
  21 vercomp () {
  22     set +u
  23     if [[ "$1" == "$2" ]]; then
  24         return 0
  25     fi
  26     local IFS=.
  27     local i ver1=($1) ver2=($2)
  28     # fill empty fields in ver1 with zeros
  29     for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
  30         ver1[i]=0
  31     done
  32     for ((i=0; i<${#ver1[@]}; i++)); do
  33         if [[ -z ${ver2[i]} ]]; then
  34             # fill empty fields in ver2 with zeros
  35             ver2[i]=0
  36         fi
  37         if ((10#${ver1[i]} > 10#${ver2[i]})); then
  38             return 1
  39         fi
  40         if ((10#${ver1[i]} < 10#${ver2[i]})); then
  41             return 2
  42         fi
  43     done
  44     set -u
  45     return 0
  46 }
  47
  48 verlte() {
  49     vercomp "$1" "$2"; local res="$?"
  50     [ "$res" -eq "0" ] || [ "$res" -eq "2" ]
  51 }
  52
  53 verlt() {
  54     vercomp "$1" "$2"; local res="$?"
  55     [ "$res" -eq "2" ]
  56 }
  57
  58 vergte() {
  59     vercomp "$1" "$2"; local res="$?"
  60     [ "$res" -eq "0" ] || [ "$res" -eq "1" ]
  61 }
  62
  63 vergt() {
  64     vercomp "$1" "$2"; local res="$?"
  65     [ "$res" -eq "1" ]
  66 }
  67
  68 verne() {
  69     vercomp "$1" "$2"; local res="$?"
  70     [ "$res" -ne "0" ]
  71 }
  72
  73 # Required variables
  74 WORKSPACE=${WORKSPACE:-}
  75
  76 arch=${arch:-}
  77 conf=${conf:-}
  78 build=${build:-}
  79 cc=${cc:-}
  80 test_type=${test_type:-}
  81
  82 DEPS_INC="$WORKSPACE/deps/build/include"
  83 DEPS_LIB="$WORKSPACE/deps/build/lib"
  84 DEPS_PKGCONFIG="$DEPS_LIB/pkgconfig"
  85 DEPS_BIN="$WORKSPACE/deps/build/bin"
  86 DEPS_JAVA="$WORKSPACE/deps/build/share/java"
  87
  88 export PATH="$DEPS_BIN:$PATH"
  89 export LD_LIBRARY_PATH="$DEPS_LIB:${LD_LIBRARY_PATH:-}"
  90 export PKG_CONFIG_PATH="$DEPS_PKGCONFIG"
  91 export CPPFLAGS="-I$DEPS_INC"
  92 export LDFLAGS="-L$DEPS_LIB"
  93
  94 SRCDIR="$WORKSPACE/src/lttng-tools"
  95 TAPDIR="$WORKSPACE/tap"
  96 PREFIX="/build"
  97
  98
  99 # Create tmp directory
 100 TMPDIR="$WORKSPACE/tmp"
 101 mkdir -p "$TMPDIR"
 102
 103 # Use a symlink in /tmp to point to the the tmp directory
 104 # inside the workspace, this is to work around the path length
 105 # limit of unix sockets which are created by the test suite.
 106 tmpdir="$(mktemp)"
 107 ln -sf "$TMPDIR" "$tmpdir"
 108 export TMPDIR="$tmpdir"
 109
 110 # Create a symlink to "babeltrace" when the "babeltrace2" executable is found.
 111 # This is a temporary workaround until lttng-tools either allows the override of
 112 # the trace reader in its test suite or that we move to only supporting
 113 # babeltrace2
 114 if [ -x "$DEPS_BIN/babeltrace2" ]; then
 115         ln -s "$DEPS_BIN/babeltrace2" "$DEPS_BIN/babeltrace"
 116 fi
 117
 118 # When using babeltrace2 make sure that it finds its plugins and
 119 # plugin-providers.
 120 export BABELTRACE_PLUGIN_PATH="$DEPS_LIB/babeltrace2/plugins/"
 121 export LIBBABELTRACE2_PLUGIN_PROVIDER_DIR="$DEPS_LIB/babeltrace2/plugin-providers/"
 122
 123 export CFLAGS="-g -O2"
 124
 125 # Set compiler variables
 126 case "$cc" in
 127 gcc)
 128     export CC=gcc
 129     export CXX=g++
 130     ;;
 131 gcc-4.8)
 132     export CC=gcc-4.8
 133     export CXX=g++-4.8
 134     ;;
 135 gcc-5)
 136     export CC=gcc-5
 137     export CXX=g++-5
 138     ;;
 139 gcc-6)
 140     export CC=gcc-6
 141     export CXX=g++-6
 142     ;;
 143 gcc-7)
 144     export CC=gcc-7
 145     export CXX=g++-7
 146     ;;
 147 gcc-8)
 148     export CC=gcc-8
 149     export CXX=g++-8
 150     ;;
 151 clang)
 152     export CC=clang
 153     export CXX=clang++
 154     ;;
 155 clang-3.9)
 156     export CC=clang-3.9
 157     export CXX=clang++-3.9
 158     ;;
 159 clang-4.0)
 160     export CC=clang-4.0
 161     export CXX=clang++-4.0
 162     ;;
 163 clang-5.0)
 164     export CC=clang-5.0
 165     export CXX=clang++-5.0
 166     ;;
 167 clang-6.0)
 168     export CC=clang-6.0
 169     export CXX=clang++-6.0
 170     ;;
 171 clang-7)
 172     export CC=clang-7
 173     export CXX=clang++-7
 174     ;;
 175 *)
 176     if [ "x$cc" != "x" ]; then
 177             export CC="$cc"
 178     fi
 179     ;;
 180 esac
 181
 182 if [ "x${CC:-}" != "x" ]; then
 183     echo "Selected compiler:"
 184     "$CC" -v
 185 fi
 186
 187 # Set platform variables
 188 case "$arch" in
 189 sol10-i386)
 190     export MAKE=gmake
 191     export TAR=gtar
 192     export NPROC=gnproc
 193     export PATH="/opt/csw/bin:/usr/ccs/bin:$PATH"
 194     export CPPFLAGS="-I/opt/csw/include -D_XOPEN_SOURCE=500 $CPPFLAGS"
 195     export LDFLAGS="-L/opt/csw/lib -R/opt/csw/lib $LDFLAGS"
 196     export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/opt/csw/lib/pkgconfig"
 197     export PYTHON="python3"
 198     export PYTHON_CONFIG="python3-config"
 199
 200     RUN_TESTS="no"
 201     ;;
 202
 203 sol11-i386)
 204     export MAKE=gmake
 205     export TAR=gtar
 206     export NPROC=nproc
 207     export PATH="/opt/csw/bin:$PATH:/usr/perl5/bin"
 208     export CPPFLAGS="-D_XOPEN_SOURCE=500 $CPPFLAGS"
 209     export PYTHON="python3"
 210     export PYTHON_CONFIG="python3-config"
 211     export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/lib/pkgconfig"
 212
 213     RUN_TESTS="no"
 214     ;;
 215
 216 macosx)
 217     export MAKE=make
 218     export TAR=tar
 219     export NPROC="getconf _NPROCESSORS_ONLN"
 220     export PATH="/opt/local/bin:/opt/local/sbin:$PATH"
 221     export CPPFLAGS="-I/opt/local/include $CPPFLAGS"
 222     export LDFLAGS="-L/opt/local/lib $LDFLAGS"
 223     export PYTHON="python3"
 224     export PYTHON_CONFIG="python3-config"
 225
 226     RUN_TESTS="no"
 227     ;;
 228
 229 cygwin|cygwin64|msys32|msys64)
 230     export MAKE=make
 231     export TAR=tar
 232     export NPROC=nproc
 233
 234     RUN_TESTS="no"
 235     ;;
 236
 237 *)
 238     export MAKE=make
 239     export TAR=tar
 240     export NPROC=nproc
 241
 242     RUN_TESTS="yes"
 243
 244     PYTHON2=python2
 245     PYTHON3=python3
 246
 247     P2_VERSION=$($PYTHON2 -c "import sys;print(sys.version[:3])")
 248     P3_VERSION=$($PYTHON3 -c "import sys;print(sys.version[:3])")
 249
 250     DEPS_PYTHON2="$WORKSPACE/deps/build/lib/python$P2_VERSION/site-packages"
 251     DEPS_PYTHON3="$WORKSPACE/deps/build/lib/python$P3_VERSION/site-packages"
 252     ;;
 253 esac
 254
 255 case "$test_type" in
 256 full)
 257     RUN_TESTS_LONG_REGRESSION="yes"
 258     ;;
 259 *)
 260     RUN_TESTS_LONG_REGRESSION="no"
 261     ;;
 262 esac
 263
 264 # If we have modules, build them
 265 if [ -d "$WORKSPACE/src/lttng-modules" ]; then
 266     cd "$WORKSPACE/src/lttng-modules"
 267     $MAKE -j"$($NPROC)" V=1
 268     $MAKE modules_install V=1
 269     depmod
 270 fi
 271
 272 # Enter the source directory
 273 cd "$SRCDIR"
 274
 275 # Run bootstrap in the source directory prior to configure
 276 ./bootstrap
 277
 278 # Get source version from configure script
 279 eval "$(grep '^PACKAGE_VERSION=' ./configure)"
 280 PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
 281
 282
 283 # The switch to build without UST changed in 2.8
 284 if vergte "$PACKAGE_VERSION" "2.8"; then
 285     NO_UST="--without-lttng-ust"
 286 else
 287     NO_UST="--disable-lttng-ust"
 288 fi
 289
 290 # Most build configs require the python bindings
 291 CONF_OPTS=("--prefix=$PREFIX" "--enable-python-bindings")
 292
 293 DIST_CONF_OPTS=()
 294
 295 # Set configure options and environment variables for each build
 296 # configuration.
 297 case "$conf" in
 298 static)
 299     echo "Static lib only configuration"
 300
 301     CONF_OPTS+=("--enable-static" "--disable-shared")
 302     ;;
 303
 304 no-ust)
 305     echo "Build without UST support"
 306     CONF_OPTS+=("$NO_UST")
 307     DIST_CONF_OPTS+=("$NO_UST")
 308     ;;
 309
 310 agents)
 311     echo "Java and Python agents configuration"
 312
 313     export JAVA_HOME="/usr/lib/jvm/default-java"
 314     export CLASSPATH="$DEPS_JAVA/*:/usr/share/java/*"
 315     export PYTHONPATH="$DEPS_PYTHON2:$DEPS_PYTHON3"
 316
 317     CONF_OPTS+=("--enable-test-java-agent-all" "--enable-test-python-agent-all")
 318     ;;
 319
 320 relayd-only)
 321     echo "Relayd only configuration"
 322
 323     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")
 324     ;;
 325
 326 debug-rcu)
 327     echo "Enable RCU sanity checks for debugging"
 328
 329     export CPPFLAGS="$CPPFLAGS -DDEBUG_RCU"
 330     ;;
 331
 332 *)
 333     echo "Standard configuration"
 334     ;;
 335 esac
 336
 337 # Build type
 338 # oot     : out-of-tree build
 339 # dist    : build via make dist
 340 # oot-dist: build via make dist out-of-tree
 341 # *       : normal tree build
 342 #
 343 # Make sure to move to the build directory and run configure
 344 # before continuing.
 345 case "$build" in
 346 oot)
 347     echo "Out of tree build"
 348
 349     # Create and enter a temporary build directory
 350     builddir=$(mktemp -d)
 351     cd "$builddir"
 352
 353     "$SRCDIR/configure" "${CONF_OPTS[@]}"
 354     ;;
 355
 356 dist)
 357     echo "Distribution in-tree build"
 358
 359     # Run configure and generate the tar file
 360     # in the source directory
 361     ./configure "${DIST_CONF_OPTS[@]}"
 362     $MAKE dist
 363
 364     # Create and enter a temporary build directory
 365     builddir=$(mktemp -d)
 366     cd "$builddir"
 367
 368     # Extract the distribution tar in the build directory,
 369     # ignore the first directory level
 370     $TAR xvf "$SRCDIR"/*.tar.* --strip 1
 371
 372     # Build in extracted source tree
 373     ./configure "${CONF_OPTS[@]}"
 374     ;;
 375
 376 oot-dist)
 377     echo "Distribution out of tree build"
 378
 379     # Create and enter a temporary build directory
 380     builddir=$(mktemp -d)
 381     cd "$builddir"
 382
 383     # Run configure out of tree and generate the tar file
 384     "$SRCDIR/configure" "${DIST_CONF_OPTS[@]}"
 385     $MAKE dist
 386
 387     dist_srcdir="$(mktemp -d)"
 388     cd "$dist_srcdir"
 389
 390     # Extract the distribution tar in the new source directory,
 391     # ignore the first directory level
 392     $TAR xvf "$builddir"/*.tar.* --strip 1
 393
 394     # Create and enter a second temporary build directory
 395     builddir="$(mktemp -d)"
 396     cd "$builddir"
 397
 398     # Run configure from the extracted distribution tar,
 399     # out of the source tree
 400     "$dist_srcdir/configure" "${CONF_OPTS[@]}"
 401     ;;
 402
 403 *)
 404     echo "Standard in-tree build"
 405     ./configure "${CONF_OPTS[@]}"
 406     ;;
 407 esac
 408
 409 # We are now inside a configured build directory
 410
 411 # BUILD!
 412 $MAKE -j "$($NPROC)" V=1
 413
 414 # Install in the workspace
 415 $MAKE install DESTDIR="$WORKSPACE"
 416
 417 # Run tests for all configs except 'no-ust'
 418 failed_tests=0
 419 if [ "$RUN_TESTS" = "yes" ] && [ "$conf" != "no-ust" ]; then
 420     # Allow core dumps
 421     ulimit -c unlimited
 422
 423     # Force the lttng-sessiond path to /bin/true to prevent the spawing of a
 424     # lttng-sessiond --daemonize on "lttng create"
 425     export LTTNG_SESSIOND_PATH="/bin/true"
 426
 427     # Run 'unit_tests', 2.8 and up has a new test suite
 428     if vergte "$PACKAGE_VERSION" "2.8"; then
 429         make --keep-going check || failed_tests=1
 430         rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$TAPDIR"
 431     else
 432         cd tests
 433         mkdir -p "$TAPDIR/unit"
 434         mkdir -p "$TAPDIR/fast_regression"
 435         mkdir -p "$TAPDIR/with_bindings_regression"
 436         prove --merge -v --exec '' - < unit_tests --archive "$TAPDIR/unit/" || failed_tests=1
 437         prove --merge -v --exec '' - < fast_regression --archive "$TAPDIR/fast_regression/" || failed_tests=1
 438         prove --merge -v --exec '' - < with_bindings_regression --archive "$TAPDIR/with_bindings_regression/" || failed_tests=1
 439         cd ..
 440     fi
 441
 442     if [ "$RUN_TESTS_LONG_REGRESSION" = "yes" ]; then
 443         cd tests
 444         mkdir -p "$TAPDIR/long_regression"
 445         prove --merge -v --exec '' - < long_regression --archive "$TAPDIR/long_regression/" || failed_tests=1
 446         cd ..
 447     fi
 448
 449     # TAP plugin is having a hard time with .yml files.
 450     find "$TAPDIR" -name "meta.yml" -exec rm -f {} \;
 451 else
 452     # The TAP plugin will fail the job if no test logs are present
 453     mkdir -p "$TAPDIR/no-tests"
 454     echo "1..1" > "$TAPDIR/no-tests/tests.log"
 455     echo "ok 1 - Test suite disabled" >> "$TAPDIR/no-tests/tests.log"
 456 fi
 457
 458 # Clean the build directory
 459 $MAKE clean
 460
 461 # Cleanup rpath in executables and shared libraries
 462 find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
 463 find "$WORKSPACE/$PREFIX/lib" -name "*.so" -exec chrpath --delete {} \;
 464
 465 # Remove libtool .la files
 466 find "$WORKSPACE/$PREFIX/lib" -name "*.la" -exec rm -f {} \;
 467
 468 # Exit with failure if any of the tests failed
 469 exit $failed_tests
 470
 471 # EOF