3 # SPDX-FileCopyrightText: 2016 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
4 # SPDX-FileCopyrightText: 2016-2023 Michael Jeanson <mjeanson@efficios.com>
5 # SPDX-License-Identifier: GPL-2.0-or-later
7 # shellcheck disable=SC2103
11 # Version compare functions
14 if [[ "$1" == "$2" ]]; then
18 # Ignore the shellcheck warning, we want splitting to happen based on IFS.
19 # shellcheck disable=SC2206
20 local i ver1
=($1) ver2
=($2)
21 # fill empty fields in ver1 with zeros
22 for ((i
=${#ver1[@]}; i
<${#ver2[@]}; i
++)); do
25 for ((i
=0; i
<${#ver1[@]}; i
++)); do
26 if [[ -z ${ver2[i]} ]]; then
27 # fill empty fields in ver2 with zeros
30 if ((10#${ver1[i]} > 10#${ver2[i]})); then
33 if ((10#${ver1[i]} < 10#${ver2[i]})); then
42 vercomp
"$1" "$2"; local res
="$?"
43 [ "$res" -eq "0" ] ||
[ "$res" -eq "2" ]
47 vercomp
"$1" "$2"; local res
="$?"
52 vercomp
"$1" "$2"; local res
="$?"
53 [ "$res" -eq "0" ] ||
[ "$res" -eq "1" ]
57 vercomp
"$1" "$2"; local res
="$?"
62 vercomp
"$1" "$2"; local res
="$?"
73 message_len
="${#message}"
74 padding_len
=$
(( (80 - (message_len
)) / 2 ))
77 printf '\n'; printf -- '#%.0s' {1.
.80}; printf '\n'
78 printf -- '-%.0s' {1.
.80}; printf '\n'
79 printf -- '#%.0s' $
(seq 1 $padding_len); printf '%s' "$message"; printf -- '#%.0s' $
(seq 1 $padding_len); printf '\n'
80 printf -- '-%.0s' {1.
.80}; printf '\n'
81 printf -- '#%.0s' {1.
.80}; printf '\n\n'
87 # Assume we are in the configured build directory
88 print_header
"BEGIN config.log"
90 print_header
"END config.log"
92 # End the build with failure
96 set_execute_traversal_bit
()
101 if [ ! -d "$path" ]; then
102 fail
"Path is not a directory"
104 while level
="$(dirname "$level")"
106 if [ "$level" = / ]; then
114 print_header
"LTTng-tools build script starting"
117 WORKSPACE
=${WORKSPACE:-}
120 platform
=${platform:-}
125 # Build steps that can be overriden by the environment
126 LTTNG_TOOLS_MAKE_INSTALL
="${LTTNG_TOOLS_MAKE_INSTALL:-yes}"
127 LTTNG_TOOLS_MAKE_CLEAN
="${LTTNG_TOOLS_MAKE_CLEAN:-yes}"
128 LTTNG_TOOLS_GEN_COMPILE_COMMANDS
="${LTTNG_TOOLS_GEN_COMPILE_COMMANDS:-no}"
129 LTTNG_TOOLS_RUN_TESTS
="${LTTNG_TOOLS_RUN_TESTS:-yes}"
130 LTTNG_TOOLS_RUN_TESTS_LONG_REGRESSION
="${LTTNG_TOOLS_RUN_TESTS_LONG_REGRESSION:-no}"
131 LTTNG_TOOLS_CLANG_TIDY
="${LTTNG_TOOLS_CLANG_TIDY:-no}"
133 SRCDIR
="$WORKSPACE/src/lttng-tools"
134 TAPDIR
="$WORKSPACE/tap"
137 LIBDIR_ARCH
="$LIBDIR"
139 # RHEL and SLES both use lib64 but don't bother shipping a default autoconf
140 # site config that matches this.
141 if [[ ( -f /etc
/redhat-release ||
-f /etc
/products.d
/SLES.prod ||
-f /etc
/yocto-release
) ]]; then
142 # Detect the userspace bitness in a distro agnostic way
143 if file -L /bin
/bash |
grep '64-bit' >/dev
/null
2>&1; then
144 LIBDIR_ARCH
="${LIBDIR}64"
148 DEPS_INC
="$WORKSPACE/deps/build/include"
149 DEPS_LIB
="$WORKSPACE/deps/build/$LIBDIR_ARCH"
150 DEPS_PKGCONFIG
="$DEPS_LIB/pkgconfig"
151 DEPS_BIN
="$WORKSPACE/deps/build/bin"
152 DEPS_JAVA
="$WORKSPACE/deps/build/share/java"
154 export PATH
="$DEPS_BIN:$PATH"
155 export LD_LIBRARY_PATH
="$DEPS_LIB:${LD_LIBRARY_PATH:-}"
156 export PKG_CONFIG_PATH
="$DEPS_PKGCONFIG"
157 export CPPFLAGS
="-I$DEPS_INC"
158 export LDFLAGS
="-L$DEPS_LIB"
162 # Use bear to generate compile_commands.json when enabled
164 if [ "$LTTNG_TOOLS_GEN_COMPILE_COMMANDS" = "yes" ]; then
168 # Create tmp directory
169 TMPDIR
="$WORKSPACE/tmp"
172 # Use a symlink in /tmp to point to the the tmp directory
173 # inside the workspace, this is to work around the path length
174 # limit of unix sockets which are created by the test suite.
176 ln -sf "$TMPDIR" "$tmpdir"
177 export TMPDIR
="$tmpdir"
179 # Create a symlink to "babeltrace" when the "babeltrace2" executable is found.
180 # This is a temporary workaround until lttng-tools either allows the override of
181 # the trace reader in its test suite or that we move to only supporting
183 if [ -x "$DEPS_BIN/babeltrace2" ]; then
184 ln -s "$DEPS_BIN/babeltrace2" "$DEPS_BIN/babeltrace"
187 # When using babeltrace2 make sure that it finds its plugins and
189 export BABELTRACE_PLUGIN_PATH
="$DEPS_LIB/babeltrace2/plugins/"
190 export LIBBABELTRACE2_PLUGIN_PROVIDER_DIR
="$DEPS_LIB/babeltrace2/plugin-providers/"
192 export CFLAGS
="-g -O2"
193 export CXXFLAGS
="-g -O2"
195 # Set compiler variables
202 export CC
=gcc-
${cc#gcc-}
203 export CXX
=g
++-${cc#gcc-}
210 export CC
=clang-
${cc#clang-}
211 export CXX
=clang
++-${cc#clang-}
214 if [ "x$cc" != "x" ]; then
220 # Set platform variables
225 export NPROC
="getconf _NPROCESSORS_ONLN"
226 export PATH
="/opt/local/bin:/opt/local/sbin:$PATH"
227 export CPPFLAGS
="-I/opt/local/include $CPPFLAGS"
228 export LDFLAGS
="-L/opt/local/lib $LDFLAGS"
229 export PYTHON
="python3"
230 export PYTHON_CONFIG
="python3-config"
233 cygwin|cygwin64|msys32|msys64
)
247 if command -v $PYTHON2 >/dev
/null
2>&1; then
248 P2_VERSION
=$
($PYTHON2 -c 'import sys;v = sys.version.split()[0].split("."); print("{}.{}".format(v[0], v[1]))')
249 DEPS_PYTHON2
="$WORKSPACE/deps/build/$LIBDIR/python$P2_VERSION/site-packages"
250 if [ "$LIBDIR" != "$LIBDIR_ARCH" ]; then
251 DEPS_PYTHON2
="$DEPS_PYTHON2:$WORKSPACE/deps/build/$LIBDIR_ARCH/python$P2_VERSION/site-packages"
255 P3_VERSION
=$
($PYTHON3 -c 'import sys;v = sys.version.split()[0].split("."); print("{}.{}".format(v[0], v[1]))')
257 # Temporary fix for an issue on debian python >= 3.10, add the 'local' prefix
258 DEPS_PYTHON3
="$WORKSPACE/deps/build/$LIBDIR/python$P3_VERSION/site-packages:$WORKSPACE/deps/build/local/$LIBDIR/python$P3_VERSION/dist-packages"
259 if [ "$LIBDIR" != "$LIBDIR_ARCH" ]; then
260 DEPS_PYTHON3
="$DEPS_PYTHON3:$WORKSPACE/deps/build/$LIBDIR_ARCH/python$P3_VERSION/site-packages"
263 # Most build configs require access to the babeltrace 2 python bindings.
264 # This also makes the lttngust python agent available for `agents` builds.
265 export PYTHONPATH
="${DEPS_PYTHON2:-}${DEPS_PYTHON2:+:}$DEPS_PYTHON3"
269 # Some warning flags are very dumb in GCC 4.8 on SLES12 / EL7, disable them
270 # even if they are available.
271 if [[ $platform = sles12sp5
* ]] ||
[[ $platform = el7
* ]]; then
272 CFLAGS
="$CFLAGS -Wno-missing-field-initializers -Wno-shadow"
273 CXXFLAGS
="$CXXFLAGS -Wno-missing-field-initializers -Wno-shadow"
276 # If we have modules, build them
277 if [ -d "$WORKSPACE/src/lttng-modules" ]; then
278 print_header
"Build and install LTTng-modules"
279 cd "$WORKSPACE/src/lttng-modules"
280 $MAKE -j"$($NPROC)" V
=1
281 $MAKE modules_install V
=1
285 # Print build env details
286 print_header
"Build environment details"
288 print_tooling || true
290 # Enter the source directory
293 # Run bootstrap in the source directory prior to configure
294 print_header
"Bootstrap autotools"
297 # Get source version from configure script
298 eval "$(grep '^PACKAGE_VERSION=' ./configure)"
299 PACKAGE_VERSION
=${PACKAGE_VERSION//\-pre*/}
301 CONF_OPTS
=("--prefix=$PREFIX" "--libdir=$PREFIX/$LIBDIR_ARCH" "--disable-maintainer-mode")
302 DIST_CONF_OPTS
=("--disable-maintainer-mode")
304 # Set configure options and environment variables for each build
308 print_header
"Conf: Static lib only"
310 CONF_OPTS
+=("--enable-static" "--disable-shared" "--enable-python-bindings")
314 print_header
"Conf: Without UST support"
316 CONF_OPTS
+=("--without-lttng-ust")
317 DIST_CONF_OPTS
+=("--without-lttng-ust")
321 print_header
"Conf: Java and Python agents"
323 export JAVA_HOME
="/usr/lib/jvm/default-java"
324 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"
326 CONF_OPTS
+=("--enable-python-bindings" "--enable-test-java-agent-all")
328 # Explicitly add '--enable-test-java-agent-log4j2', it's not part of '-all' in stable 2.12/2.13
329 if verlt
"$PACKAGE_VERSION" "2.14"; then
330 CONF_OPTS
+=("--enable-test-java-agent-log4j2")
333 # Some distros don't ship python2 anymore
334 if command -v $PYTHON2 >/dev
/null
2>&1; then
335 CONF_OPTS
+=("--enable-test-python-agent-all")
337 CONF_OPTS
+=("--enable-test-python3-agent")
342 print_header
"Conf: Relayd only"
344 CONF_OPTS
+=("--disable-bin-lttng" "--disable-bin-lttng-consumerd" "--disable-bin-lttng-crash" "--disable-bin-lttng-sessiond" "--disable-extras" "--disable-man-pages" "--without-lttng-ust")
348 print_header
"Conf: RCU sanity checks for debugging"
350 CONF_OPTS
+=("--enable-python-bindings")
352 export CPPFLAGS
="$CPPFLAGS -DDEBUG_RCU"
356 print_header
"Conf: Standard"
358 CONF_OPTS
+=("--enable-python-bindings")
360 # Something is broken in docbook-xml on yocto
361 if [[ "$platform" = yocto
* ]]; then
362 CONF_OPTS
+=("--disable-man-pages")
368 # oot : out-of-tree build
369 # dist : build via make dist
370 # oot-dist: build via make dist out-of-tree
371 # * : normal tree build
373 # Make sure to move to the build directory and run configure
377 print_header
"Build: Out of tree"
379 # Create and enter a temporary build directory
380 builddir
=$
(mktemp
-d)
383 "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
387 print_header
"Build: Distribution in-tree"
389 # Run configure and generate the tar file
390 # in the source directory
392 .
/configure
"${DIST_CONF_OPTS[@]}" || failed_configure
395 # Create and enter a temporary build directory
396 builddir
=$
(mktemp
-d)
399 # Extract the distribution tar in the build directory,
400 # ignore the first directory level
401 $TAR xvf
"$SRCDIR"/*.
tar.
* --strip 1
403 # Build in extracted source tree
404 .
/configure
"${CONF_OPTS[@]}" || failed_configure
408 print_header
"Build: Distribution Out of tree"
410 # Create and enter a temporary build directory
411 builddir
=$
(mktemp
-d)
414 # Run configure out of tree and generate the tar file
415 "$SRCDIR/configure" "${DIST_CONF_OPTS[@]}" || failed_configure
418 dist_srcdir
="$(mktemp -d)"
421 # Extract the distribution tar in the new source directory,
422 # ignore the first directory level
423 $TAR xvf
"$builddir"/*.
tar.
* --strip 1
425 # Create and enter a second temporary build directory
426 builddir
="$(mktemp -d)"
429 # Run configure from the extracted distribution tar,
430 # out of the source tree
431 "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
435 print_header
"Build: Standard In-tree"
436 .
/configure
"${CONF_OPTS[@]}" || failed_configure
440 # We are now inside a configured build directory
443 print_header
"BUILD!"
444 $BEAR ${BEAR:+--} $MAKE -j "$($NPROC)" V
=1
446 # Install in the workspace if enabled
447 if [ "$LTTNG_TOOLS_MAKE_INSTALL" = "yes" ]; then
448 print_header
"Install"
450 $MAKE install V
=1 DESTDIR
="$WORKSPACE"
452 # Cleanup rpath in executables
453 find "$WORKSPACE/$PREFIX/bin" -type f
-perm -0500 -exec chrpath
--delete {} \
;
455 # Some configs don't build liblttng-ctl
456 if [ -d "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" ]; then
457 # Cleanup rpath in shared libraries
458 find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.so" -exec chrpath
--delete {} \
;
459 # Remove libtool .la files
460 find "$WORKSPACE/$PREFIX/$LIBDIR_ARCH" -name "*.la" -delete
464 # Run clang-tidy on the topmost commit
465 if [ "$LTTNG_TOOLS_CLANG_TIDY" = "yes" ]; then
466 print_header
"Run clang-tidy"
468 # This would be better by linting only the lines touched by a patch but it
469 # doesn't seem to work, the lines are always filtered and no error is
471 #git diff -U0 HEAD^ | clang-tidy-diff -p1 -j "$($NPROC)" -timeout 60 -fix
473 # Instead, run clan-tidy on all the files touched by the patch.
474 while read -r filepath
; do
475 if [[ "$filepath" =~
(\.cpp|\.hhp|\.c|\.h
)$
]]; then
476 clang-tidy
--fix-errors "$(realpath "$filepath")"
478 done < <(git diff-tree
--no-commit-id --diff-filter=d
--name-only -r HEAD
)
480 # If the tree has local changes, the formatting was incorrect
481 GIT_DIFF_OUTPUT
=$
(git
diff)
482 if [ -n "$GIT_DIFF_OUTPUT" ]; then
483 echo "Saving clang-tidy proposed fixes in clang-tidy-fixes.diff"
484 git
diff > "$WORKSPACE/clang-tidy-fixes.diff"
486 # Restore the unfixed files so they can be viewed in the warnings web
493 # Run tests for all configs except 'no-ust' / 'relayd-only'
494 if [ "$LTTNG_TOOLS_RUN_TESTS" = "yes" ] && [[ ! "$conf" =~
(no-ust|relayd-only
) ]]; then
495 print_header
"Run test suite"
500 # Force the lttng-sessiond path to /bin/true to prevent the spawing of a
501 # lttng-sessiond --daemonize on "lttng create"
502 export LTTNG_SESSIOND_PATH
="/bin/true"
504 # It is implied that tests depending on LTTNG_ENABLE_DESTRUCTIVE_TESTS
505 # only run for the root user. Note that here `destructive` means that
506 # operations are performed at the host level (add user etc.) that
507 # effectively modify the host. Running those tests are acceptable on our
508 # CI and root jobs since we always run root tests against a `snapshot`
510 if [ "$(id -u)" == "0" ]; then
511 # Allow the traversal of all directories leading to the
512 # DEPS_LIBS directory to enable test app run by temp users to
514 set_execute_traversal_bit
"$DEPS_LIB"
515 # Allow `all` to interact with all deps libs.
516 chmod a
+rwx
-R "$DEPS_LIB"
518 export LTTNG_ENABLE_DESTRUCTIVE_TESTS
="will-break-my-system"
520 # Some destructive tests play with the system clock, disable timesyncd
521 systemctl stop systemd-timesyncd.service || true
524 make --keep-going check || exit_status
=1
526 # Copy tap logs for the jenkins tap parser before cleaning the build dir
527 rsync
-a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests
/ "$TAPDIR"
529 # Copy the test suites top-level log which includes all tests failures
530 rsync
-a --include 'test-suite.log' --include '*/' --exclude='*' tests
/ "$WORKSPACE/log"
532 if [ "$LTTNG_TOOLS_RUN_TESTS_LONG_REGRESSION" = "yes" ]; then
533 print_header
"Run long regression tests"
535 mkdir
-p "$TAPDIR/long_regression"
536 prove
--merge -v --exec '' - < long_regression
--archive "$TAPDIR/long_regression/" || exit_status
=1
541 if [ "$LTTNG_TOOLS_RUN_TESTS" = "yes" ] && [[ "$conf" =~
(no-ust|relayd-only
) ]]; then
542 # The TAP plugin will fail the job if no test logs are present
543 mkdir
-p "$TAPDIR/no-tests"
544 echo "1..1" > "$TAPDIR/no-tests/tests.log"
545 echo "ok 1 - Test suite disabled" >> "$TAPDIR/no-tests/tests.log"
548 # Clean the build directory
549 if [ "$LTTNG_TOOLS_MAKE_CLEAN" = "yes" ]; then
554 print_header
"LTTng-tools build script ended with: $(test $exit_status == 0 && echo SUCCESS || echo FAILURE)"
556 # Exit with failure if any of the tests failed
560 # vim: expandtab tabstop=4 shiftwidth=4