Merge pull request #1273 from lukaszstolarczuk/merge-stable-1.9-into-stable-1.10

Merge stable-1.9 into stable-1.10

Author: lukaszstolarczuk

.github/workflows/gha.yml

@@ -14,7 +14,7 @@ jobs:
     env:
       DOCKERHUB_USER:          ${{ secrets.DOCKERHUB_USER }}
       DOCKERHUB_PASSWORD:      ${{ secrets.DOCKERHUB_PASSWORD }}
-      GITHUB_TOKEN:   ${{ secrets.DOC_UPDATE_GITHUB_TOKEN }}
+      DOC_UPDATE_GITHUB_TOKEN:   ${{ secrets.DOC_UPDATE_GITHUB_TOKEN }}
       HOST_WORKDIR:   /home/runner/work/libpmemobj-cpp/libpmemobj-cpp
       WORKDIR:        utils/docker
     strategy:
@@ -46,7 +46,8 @@ jobs:
 
   windows:
     name: Windows
-    runs-on: windows-latest
+    runs-on: windows-2019
+
     env:
       platform: x64
       VCPKG_DEFAULT_TRIPLET: x64-windows
@@ -55,14 +56,14 @@ jobs:
       PMDK_VERSION: "1.8"
       CMAKE_TOOLCHAIN_FILE: "C:\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake"
       CMAKE_INSTALL_PREFIX: "C:\\install\\libpmemobj-cpp"
-      WORKDIR:  "D:\\a\\libpmemobj-cpp\\libpmemobj-cpp\\"
-      MSBUILD:  "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Enterprise\\MSBuild\\Current\\Bin"
     strategy:
       matrix:
         CONFIG: [Debug, Release]
     steps:
-       - name: Update PATH
-         run: echo "${env:MSBUILD}" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+       - name: Setup MSBuild.exe
+         uses: microsoft/[email protected]
+         with:
+            msbuild-architecture: ${env:ARCH}
 
        - name: Cache vcpkg packages
          uses: actions/cache@v1

CMakeLists.txt

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2021, Intel Corporation
+# Copyright 2018-2022, Intel Corporation
 
 cmake_minimum_required(VERSION 3.3)
 project(libpmemobj-cpp C CXX)
@@ -9,10 +9,7 @@ set(VERSION_MINOR 10)
 set(VERSION_PATCH 0)
 #set(VERSION_PRERELEASE rc2)
 
-set(VERSION ${VERSION_MAJOR}.${VERSION_MINOR})
-if (VERSION_PATCH GREATER 0)
-	set(VERSION ${VERSION}.${VERSION_PATCH})
-endif()
+set(VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
 if (VERSION_PRERELEASE)
 	set(VERSION ${VERSION}-${VERSION_PRERELEASE})
 endif()

ChangeLog

@@ -1,3 +1,40 @@
+Mon Aug 08 2022 Łukasz Stolarczuk <[email protected]>
+
+	* Version 1.9.1
+
+	This release fixes minor bugs.
+
+	Notable changes:
+	- concurrent_hash_map: fix free_data()
+	- concurrent_hash_map: make double to size_t cast explicit in defragment()
+	- peristent_ptr: add missing offset calculation
+
+Mon Aug 01 2022 Łukasz Stolarczuk <[email protected]>
+
+	* Version 1.8.2
+
+	This release fixes minor bugs.
+
+	This is the last patch release for libpmemobj-cpp 1.8 version.
+	Maintenance of this version is no longer supported.
+
+	Notable changes:
+	- vector: fix referencing empty array
+	- vector: Fix undefined behaviour on realloc
+
+Fri Jul 29 2022 Łukasz Stolarczuk <[email protected]>
+
+	* Version 1.7.1
+
+	This release fixes minor bugs.
+
+	This is the last patch release for libpmemobj-cpp 1.7 version.
+	Maintenance of this version is no longer supported.
+
+	Notable changes:
+	- Properly install pkg-config file for all configurations
+	- Fix void_t declaration and API usage for concurrent hashmap test
+
 Tue Jul 06 2021 Łukasz Stolarczuk <[email protected]>
 
 	* Version 1.6.1

include/libpmemobj++/persistent_ptr.hpp

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2015-2020, Intel Corporation */
+/* Copyright 2015-2021, Intel Corporation */
 
 /**
  * @file
@@ -607,7 +607,10 @@ class persistent_ptr : public persistent_ptr_base {
 	inline ptrdiff_t
 	calculate_offset() const
 	{
-		static const ptrdiff_t ptr_offset_magic = 0xDEADBEEF;
+		static const ptrdiff_t ptr_offset_magic = 0xF00000000000000;
+
+		static_assert(ptr_offset_magic % alignof(U) == 0, "");
+		static_assert(ptr_offset_magic % alignof(T) == 0, "");
 
 		U *tmp{reinterpret_cast<U *>(ptr_offset_magic)};
 		T *diff = static_cast<T *>(tmp);

include/libpmemobj++/pexceptions.hpp

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2016-2020, Intel Corporation */
+/* Copyright 2016-2022, Intel Corporation */
 
 /**
  * @file
@@ -39,8 +39,10 @@ errormsg(void)
 /**
  * Custom pool error class.
  *
- * Thrown when there is a runtime problem with some action on the
- * pool.
+ * Thrown when there is a runtime problem with some action on the pool,
+ * e.g., when cannot open or create a pool, the wrong handle to pool
+ * was passed to some function, or a referenced object is not stored
+ * on persistent memory.
  */
 class pool_error : public std::runtime_error {
 public:
@@ -114,7 +116,10 @@ class transaction_alloc_error : public transaction_error {
 /**
  * Custom out of memory error class.
  *
- * Thrown when there is out of memory error inside of transaction.
+ * Thrown when there is out of memory error inside of a transaction.
+ * It may occur when you run out of space on persistent memory:
+ * too many objects or too big object was allocated (current limit for
+ * a single element is ~16GB). Bigger pool or smaller object is required.
  */
 class transaction_out_of_memory : public transaction_alloc_error,
 				  public std::bad_alloc {

utils/docker/build.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2017-2020, Intel Corporation
+# Copyright 2017-2022, Intel Corporation
 
 #
 # build-local.sh - runs a Docker container from a Docker image with environment
@@ -125,7 +125,7 @@ docker run --privileged=true --name=$containerName -i $TTY \
 	--env CI_REPO_SLUG=$CI_REPO_SLUG \
 	--env CI_BRANCH=$CI_BRANCH \
 	--env CI_EVENT_TYPE=$CI_EVENT_TYPE \
-	--env GITHUB_TOKEN=$GITHUB_TOKEN \
+	--env DOC_UPDATE_GITHUB_TOKEN=${DOC_UPDATE_GITHUB_TOKEN} \
 	--env COVERITY_SCAN_TOKEN=$COVERITY_SCAN_TOKEN \
 	--env COVERITY_SCAN_NOTIFICATION_EMAIL=$COVERITY_SCAN_NOTIFICATION_EMAIL \
 	--env CHECK_CPP_STYLE=${CHECK_CPP_STYLE:-OFF} \

utils/docker/run-build.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2016-2020, Intel Corporation
+# Copyright 2016-2022, Intel Corporation
 
 #
 # run-build.sh - is called inside a Docker container; prepares the environment
@@ -60,6 +60,10 @@ function sudo_password() {
 	echo $USERPASS | sudo -Sk $*
 }
 
+if [ "$CI_RUN" == "YES" ]; then
+	sudo_password chown -R $(id -u).$(id -g) $WORKDIR
+fi || true
+
 sudo_password mkdir /mnt/pmem
 sudo_password chmod 0777 /mnt/pmem
 sudo_password mount -o size=2G -t tmpfs none /mnt/pmem

utils/docker/run-doc-update.sh

@@ -1,68 +1,85 @@
 #!/usr/bin/env bash
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2018-2020, Intel Corporation
+# Copyright 2018-2022, Intel Corporation
 
 set -e
 
 source `dirname $0`/valid-branches.sh
 
-BOT_NAME="pmem-bot"
-USER_NAME="pmem"
-REPO_NAME="libpmemobj-cpp"
-
-ORIGIN="https://${GITHUB_TOKEN}@github.com/${BOT_NAME}/${REPO_NAME}"
-UPSTREAM="https://github.com/pmem/${REPO_NAME}"
-# master or stable-* branch
-TARGET_BRANCH=${CI_BRANCH}
-VERSION=${TARGET_BRANCHES[$TARGET_BRANCH]}
-
-if [ -z $VERSION ]; then
-	echo "Target location for branch $TARGET_BRANCH is not defined."
+if [[ -z "${DOC_UPDATE_GITHUB_TOKEN}" ]]; then
+	echo "To build documentation and upload it as a Github pull request, variable " \
+		"'DOC_UPDATE_GITHUB_TOKEN' has to be provided."
 	exit 1
 fi
 
-# Clone repo
-git clone ${ORIGIN}
-cd ${REPO_NAME}
-git remote add upstream ${UPSTREAM}
+if [[ -z "${WORKDIR}" ]]; then
+	echo "ERROR: The variable WORKDIR has to contain a path to the root " \
+		"of this project - 'build' sub-directory may be created there."
+	exit 1
+fi
 
-git config --local user.name ${BOT_NAME}
-git config --local user.email "${BOT_NAME}@intel.com"
+BOT_NAME=${DOC_UPDATE_BOT_NAME:-"pmem-bot"}
+DOC_REPO_OWNER=${DOC_REPO_OWNER:-"pmem"}
+DOC_REPO_NAME=${DOC_REPO_NAME:-"${DOC_REPO_OWNER}.github.io"}
+export GITHUB_TOKEN=${DOC_UPDATE_GITHUB_TOKEN} # export for hub command
+DOC_REPO_DIR=$(mktemp -d -t pmem_io-XXX)
+ARTIFACTS_DIR=$(mktemp -d -t ARTIFACTS-XXX)
+
+# Determine docs location directory, based on the branch (for CI builds: 'master' or 'vX.Y')
+if [[ ${CI_BRANCH} == stable-* ]]; then
+	DOCS_TARGET_DIR=$(echo ${CI_BRANCH} | awk -F 'stable-' '/stable-/{printf "v"} {print $(NF)}')
+else
+	DOCS_TARGET_DIR=${CI_BRANCH}
+fi
 
-git remote update
-git checkout -B ${TARGET_BRANCH} upstream/${TARGET_BRANCH}
+ORIGIN="https://${GITHUB_TOKEN}@github.com/${BOT_NAME}/${DOC_REPO_NAME}"
+UPSTREAM="https://github.com/${DOC_REPO_OWNER}/${DOC_REPO_NAME}"
 
-# Build docs
-mkdir build
-cd build
+echo "Build docs"
+pushd ${WORKDIR}
+mkdir -p build
+pushd build
 
-cmake -DBUILD_TESTS=OFF -DBUILD_EXAMPLES=OFF -DBUILD_BENCHMARKS=OFF ..
+cmake -DBUILD_TESTS=OFF -DBUILD_EXAMPLES=OFF -DBUILD_BENCHMARKS=OFF -DBUILD_DOC=ON ..
 make -j$(nproc) doc
-cp -R doc/cpp_html ../..
+cp -R doc/cpp_html ${ARTIFACTS_DIR}
+popd
+popd
+
+echo "Clone pmem.io repo (with web content and our docs):"
+git clone --depth=1 ${ORIGIN} ${DOC_REPO_DIR}
+pushd ${DOC_REPO_DIR}
+git remote add upstream ${UPSTREAM}
+git fetch upstream
 
-cd ..
+git config --local user.name ${BOT_NAME}
+git config --local user.email "${BOT_NAME}@intel.com"
+hub config --global hub.protocol https
 
-# Checkout gh-pages and copy docs
-GH_PAGES_NAME="gh-pages-for-${TARGET_BRANCH}"
-git checkout -B $GH_PAGES_NAME upstream/gh-pages
+echo "Checkout new branch (based on 'main') for PR"
+DOCS_BRANCH_NAME="libpmemobj-cpp-${DOCS_TARGET_DIR}-docs-update"
+git checkout -B ${DOCS_BRANCH_NAME} upstream/main
 git clean -dfx
 
-# Clean old content, since some files might have been deleted
-rm -rf ./$VERSION
-mkdir -p ./$VERSION/doxygen/
+DOCS_CONTENT_DIR="./content/libpmemobj-cpp/${DOCS_TARGET_DIR}/"
+echo "Clean old content, since some files might have been deleted"
+rm -rf ${DOCS_CONTENT_DIR}
+mkdir -p ${DOCS_CONTENT_DIR}/doxygen/
 
-cp -r ../cpp_html/* ./$VERSION/doxygen/
+echo "Copy all content"
+cp -r ${ARTIFACTS_DIR}/cpp_html/* ${DOCS_CONTENT_DIR}/doxygen/
 
-# Add and push changes.
+echo "Add and push changes"
 # git commit command may fail if there is nothing to commit.
 # In that case we want to force push anyway (there might be open pull request with
 # changes which were reverted).
 git add -A
-git commit -m "doc: automatic gh-pages docs update" && true
-git push -f ${ORIGIN} $GH_PAGES_NAME
+git commit -m "libpmemobj-cpp: automatic docs update for '${CI_BRANCH}'" && true
+git push -f ${ORIGIN} ${DOCS_BRANCH_NAME}
 
-# Makes pull request.
+echo "Make a Pull Request"
 # When there is already an open PR or there are no changes an error is thrown, which we ignore.
-hub pull-request -f -b ${USER_NAME}:gh-pages -h ${BOT_NAME}:${GH_PAGES_NAME} -m "doc: automatic gh-pages docs update" && true
+hub pull-request -f -b ${DOC_REPO_OWNER}:main -h ${BOT_NAME}:${DOCS_BRANCH_NAME} \
+	-m "libpmemobj-cpp: automatic docs update for '${CI_BRANCH}'" && true
 
-exit 0
+popd