Merge pull request #1211 from lukaszstolarczuk/merge-stable-1.13-into-master

Merge stable-1.13 into master

Author: lukaszstolarczuk

.github/workflows/gha.yml

@@ -29,21 +29,20 @@ jobs:
       WORKDIR:         utils/docker
     strategy:
       matrix:
-        CONFIG: ["TYPE=debug OS=fedora OS_VER=32 PUSH_IMAGE=1",
-                 "TYPE=debug OS=fedora OS_VER=34 PUSH_IMAGE=1",
+        CONFIG: ["TYPE=debug OS=fedora OS_VER=34 PUSH_IMAGE=1",
                  "TYPE=debug OS=ubuntu OS_VER=20.04 PUSH_IMAGE=1 CHECK_CPP_STYLE=1",
                  "TYPE=debug OS=ubuntu OS_VER=20.04 COVERAGE=1",
-                 "TYPE=release OS=fedora OS_VER=32",
+                 "TYPE=release OS=fedora OS_VER=34",
                  "TYPE=release OS=ubuntu OS_VER=20.04",
-                 "TYPE=valgrind OS=ubuntu OS_VER=20.04",
-                 "TYPE=memcheck_drd OS=ubuntu OS_VER=20.04",
-                 "TYPE=package OS=fedora OS_VER=32",
+                 "TYPE=valgrind OS=ubuntu OS_VER=20.04 TESTS_VALGRIND_UNWIND=0",
+                 "TYPE=memcheck_drd OS=ubuntu OS_VER=20.04 TESTS_VALGRIND_UNWIND=0",
+                 "TYPE=package OS=fedora OS_VER=34",
                  "TYPE=package OS=ubuntu OS_VER=20.04"]
     steps:
       - name: Get release version
         if: github.event_name == 'release'
         id: get_release_version
-        run: echo ::set-output name=VERSION::$(echo ${{ github.event.release.tag_name }} | grep -E "^[0-9]+.[0-9]+(-rc[0-9]+)?$" | cut -f 1,2 -d . | cut -f 1 -d -)
+        run: echo ::set-output name=VERSION::$(echo ${{ github.event.release.tag_name }} | awk -F '[.-]' '/^[0-9]+.[0-9]+[.0-9]*(-rc[0-9]+)?$/ {print $1 "." $2}')
 
       - name: Set image version and force image action for release
         if: github.event_name == 'release' && steps.get_release_version.outputs.VERSION != ''
@@ -52,9 +51,16 @@ jobs:
           echo "FORCE_IMAGE_ACTION=rebuild" >> $GITHUB_ENV
 
       - name: Set image version and force image action for stable branch
-        if: startsWith(github.ref, 'refs/heads/stable-')
+        # we want to set IMG_VER to e.g. '1.x' for stable branches and PRs against them
+        # for PRs we have to use 'base_ref' - this is the target branch (and we have to check that instead)
+        if:
+          startsWith(github.ref, 'refs/heads/stable-') || startsWith(github.base_ref, 'stable-')
+        # we now know we're on (or against) stable branches, so we just need to pick the version (e.g. the mentioned '1.x')
         run: |
-          echo "IMG_VER=$(echo ${GITHUB_REF#refs/heads/} | cut -d - -f 2)" >> $GITHUB_ENV
+          IMG_VER=$(echo ${GITHUB_BASE_REF} | cut -d - -f 2)
+          [ -z "${IMG_VER}" ] \
+              && echo "IMG_VER=$(echo ${GITHUB_REF#refs/heads/} | cut -d - -f 2)" >> $GITHUB_ENV \
+              || echo "IMG_VER=${IMG_VER}" >> $GITHUB_ENV
           echo "FORCE_IMAGE_ACTION=rebuild" >> $GITHUB_ENV
 
       - name: Clone the git repo
@@ -68,6 +74,7 @@ jobs:
 
       - name: Run the build
         run: cd $WORKDIR && ${{ matrix.CONFIG }} ./build.sh
+
   doc:
     name: build and publish docs
     runs-on: ubuntu-latest
@@ -83,6 +90,12 @@ jobs:
       matrix:
         CONFIG: ["TYPE=doc OS=fedora OS_VER=34"]
     steps:
+      - name: Set image version for stable branch
+        # doc update happens only on stable branch (not on PR), so we check only for heads ref
+        if: startsWith(github.ref, 'refs/heads/stable-')
+        run: |
+          echo "IMG_VER=$(echo ${GITHUB_REF#refs/heads/} | cut -d - -f 2)" >> $GITHUB_ENV
+
       - name: Clone the git repo
         uses: actions/checkout@v2
         with:

.github/workflows/nightly.yml

@@ -33,8 +33,8 @@ jobs:
                  "OS=debian OS_VER=testing",
                  "OS=debian OS_VER=unstable",
                  "OS=debian OS_VER=latest",
+                 "OS=fedora OS_VER=32",
                  "OS=fedora OS_VER=33",
-                 "OS=fedora OS_VER=34",
                  "OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
                  "OS=opensuse-leap OS_VER=latest",
                  "OS=opensuse-tumbleweed OS_VER=latest",

.github/workflows/weekly.yml

@@ -28,8 +28,8 @@ jobs:
                  "TYPE=debug OS=ubuntu OS_VER=20.04 TESTS_UBSAN=1 TESTS_PMREORDER=0",
                  "TYPE=debug OS=fedora OS_VER=rawhide TESTS_ASAN=1 TESTS_PMREORDER=0",
                  "TYPE=debug OS=fedora OS_VER=rawhide TESTS_UBSAN=1 TESTS_PMREORDER=0",
-                 "TYPE=valgrind OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
-                 "TYPE=memcheck_drd OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
+                 "TYPE=valgrind OS=fedora OS_VER=rawhide TESTS_PMREORDER=0 TESTS_VALGRIND_UNWIND=0",
+                 "TYPE=memcheck_drd OS=fedora OS_VER=rawhide TESTS_PMREORDER=0 TESTS_VALGRIND_UNWIND=0",
                  "TYPE=package OS=fedora OS_VER=34",
                  "TYPE=package OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
                  "TYPE=package OS=ubuntu OS_VER=devel"]

CMakeLists.txt

@@ -78,6 +78,7 @@ option(CHECK_CPP_STYLE "check code style of C++ sources" OFF)
 option(TRACE_TESTS "more verbose test outputs" OFF)
 option(USE_ASAN "enable AddressSanitizer (debugging)" OFF)
 option(USE_UBSAN "enable UndefinedBehaviorSanitizer (debugging)" OFF)
+option(USE_LIBUNWIND "use libunwind for more reliable stack traces from tests (if available)" ON)
 option(USE_CCACHE "use ccache if it is available in the system" ON)
 
 option(TESTS_USE_FORCED_PMEM "run tests with PMEM_IS_PMEM_FORCE=1 - it speeds up tests execution on emulated pmem" OFF)

tests/CMakeLists.txt

@@ -81,7 +81,7 @@ include(tbb)
 
 add_library(test_backtrace STATIC test_backtrace.c)
 if(LIBUNWIND_FOUND)
-	target_compile_definitions(test_backtrace PUBLIC USE_LIBUNWIND=1)
+	target_compile_definitions(test_backtrace PUBLIC LIBUNWIND_ENABLED=1)
 endif()
 
 add_library(valgrind_internal STATIC valgrind_internal.cpp)

tests/ctest_helpers.cmake

@@ -34,13 +34,17 @@ function(find_packages)
 		find_package(Curses QUIET)
 	endif()
 
-	if(PKG_CONFIG_FOUND)
-		pkg_check_modules(LIBUNWIND QUIET libunwind)
-	else()
-		find_package(LIBUNWIND QUIET)
-	endif()
-	if(NOT LIBUNWIND_FOUND)
-		message(WARNING "libunwind not found. Stack traces from tests will not be reliable")
+	if (USE_LIBUNWIND)
+		if(PKG_CONFIG_FOUND)
+			pkg_check_modules(LIBUNWIND QUIET libunwind)
+		else()
+			find_package(LIBUNWIND QUIET)
+		endif()
+		if(NOT LIBUNWIND_FOUND)
+			message(WARNING "libunwind not found. Stack traces from tests will not be reliable")
+		else()
+			message(STATUS "Found libunwind: ${LIBUNWIND_LIBDIR} (version: ${LIBUNWIND_VERSION})")
+		endif()
 	endif()
 
 	find_gdb()

tests/test_backtrace.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2015-2019, Intel Corporation */
+/* Copyright 2015-2021, Intel Corporation */
 
 /*
  * backtrace.c -- backtrace reporting routines
@@ -16,7 +16,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-#ifdef USE_LIBUNWIND
+#ifdef LIBUNWIND_ENABLED
 
 #define UNW_LOCAL_ONLY
 #include <dlfcn.h>
@@ -90,7 +90,7 @@ test_dump_backtrace(void)
 				unw_strerror(ret), ret);
 	}
 }
-#else /* USE_LIBUNWIND */
+#else /* LIBUNWIND_ENABLED */
 
 #define BSIZE 100
 
@@ -162,7 +162,7 @@ test_dump_backtrace(void)
 
 #endif /* _WIN32 */
 
-#endif /* USE_LIBUNWIND */
+#endif /* LIBUNWIND_ENABLED */
 
 /*
  * test_sighandler -- fatal signal handler

utils/docker/build.sh

@@ -139,6 +139,7 @@ docker run --privileged=true --name=${CONTAINER_NAME} -i \
 	--env TESTS_PACKAGES=${TESTS_PACKAGES:-ON} \
 	--env TESTS_ASAN=${TESTS_ASAN:-OFF} \
 	--env TESTS_UBSAN=${TESTS_UBSAN:-OFF} \
+	--env TESTS_VALGRIND_UNWIND=${TESTS_VALGRIND_UNWIND:-OFF} \
 	--env TEST_TIMEOUT=${TEST_TIMEOUT} \
 	--env TZ='Europe/Warsaw' \
 	--shm-size=4G \

utils/docker/images/install-valgrind.sh

@@ -1,9 +1,9 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2016-2020, Intel Corporation
+# Copyright 2016-2021, Intel Corporation
 
 #
-# install-valgrind.sh - installs valgrind for persistent memory
+# install-valgrind.sh - installs valgrind with pmemcheck
 #
 
 set -e
@@ -13,10 +13,10 @@ if [ "${SKIP_VALGRIND_BUILD}" ]; then
 	exit
 fi
 
-git clone --recursive https://github.com/pmem/valgrind.git
+git clone https://github.com/pmem/valgrind.git
 cd valgrind
-# pmem-3.15: Merge pull request #81 from marcinslusarz/pmem-3.15
-git checkout 09f75f69683d862f8456f75484fcdc0dc5508900
+# pmem-3.17: Merge pull request #85 from lukaszstolarczuk/pmem-3.17; 16.08.2021
+git checkout ff6f0f125f8e1b1a2a8615f2b14efeaf135ad01b
 
 ./autogen.sh
 ./configure --prefix=/usr

utils/docker/run-build.sh

@@ -23,6 +23,7 @@ TESTS_PACKAGES=${TESTS_PACKAGES:-ON}
 TESTS_USE_FORCED_PMEM=${TESTS_USE_FORCED_PMEM:-ON}
 TESTS_ASAN=${TESTS_ASAN:-OFF}
 TESTS_UBSAN=${TESTS_UBSAN:-OFF}
+TESTS_VALGRIND_UNWIND=${TESTS_VALGRIND_UNWIND:-OFF}
 TEST_TIMEOUT=${TEST_TIMEOUT:-600}
 
 export PMREORDER_STACKTRACE_DEPTH=20
@@ -106,6 +107,7 @@ function tests_clang_release_cpp11_no_valgrind() {
 # BUILD build_gcc_debug_cpp14 (no tests)
 ###############################################################################
 function build_gcc_debug_cpp14() {
+	VALGRIND_UNWIND=${1:-ON}
 	mkdir build
 	cd build
 
@@ -128,7 +130,8 @@ function build_gcc_debug_cpp14() {
 		-DTESTS_COMPATIBILITY=1 \
 		-DTESTS_CONCURRENT_GDB=1 \
 		-DUSE_ASAN=${TESTS_ASAN} \
-		-DUSE_UBSAN=${TESTS_UBSAN}
+		-DUSE_UBSAN=${TESTS_UBSAN} \
+		-DUSE_LIBUNWIND=${VALGRIND_UNWIND}
 
 	make -j$(nproc)
 }
@@ -152,7 +155,7 @@ function tests_gcc_debug_cpp14_no_valgrind() {
 ###############################################################################
 function tests_gcc_debug_cpp14_valgrind_memcheck_drd() {
 	printf "\n$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} START$(tput sgr 0)\n"
-	build_gcc_debug_cpp14
+	build_gcc_debug_cpp14 ${TESTS_VALGRIND_UNWIND}
 	ctest -R "_memcheck|_drd" --timeout ${TEST_TIMEOUT} --output-on-failure
 	workspace_cleanup
 	printf "$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} END$(tput sgr 0)\n\n"
@@ -163,7 +166,7 @@ function tests_gcc_debug_cpp14_valgrind_memcheck_drd() {
 ###############################################################################
 function tests_gcc_debug_cpp14_valgrind_other() {
 	printf "\n$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} START$(tput sgr 0)\n"
-	build_gcc_debug_cpp14
+	build_gcc_debug_cpp14 ${TESTS_VALGRIND_UNWIND}
 	ctest -E "_none|_memcheck|_drd" --timeout ${TEST_TIMEOUT} --output-on-failure
 	ctest -R "_pmreorder" --timeout ${TEST_TIMEOUT} --output-on-failure
 	workspace_cleanup
@@ -210,7 +213,6 @@ function tests_gcc_release_cpp17_no_valgrind() {
 ###############################################################################
 # BUILD tests_clang_release_cpp20_no_valgrind llvm
 ###############################################################################
-
 function tests_clang_release_cpp20_no_valgrind() {
 	printf "\n$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} START$(tput sgr 0)\n"