Fix #438, add three PDI deactivation option through CMake

.github/pull_request_template.md

@@ -6,7 +6,8 @@ Before merging your code, please check the following:
 
 * [ ] you have added a line describing your changes to the Changelog;
 * [ ] you have added unit tests for any new or improved feature;
-* [ ] In case you updated dependencies, you have checked pdi/docs/CheckList.md
+* [ ] in case you updated dependencies, you have checked pdi/docs/CheckList.md;
+* [ ] in case of a change in pdi.h, this same change must be reflected in no-pdi/include/pdi.h;
 * you have checked your code format:
   - [ ] you have checked that you respect all conventions specified in CONTRIBUTING.md;
   - [ ] you have checked that the indentation and formatting conforms to the `.clang-format`;

AUTHORS

@@ -7,7 +7,8 @@ each sub-project (including PDI itself) is located in the dedicated sub-project
 AUTHORS file.
 
 Julian Auriac - CEA ([email protected])
-* fix CI bug where tests.xml file could not be written
+* Add pdi deactivation option
+* Fix CI bug where tests.xml file could not be written
 
 Julien Bigot - CEA ([email protected])
 * Maintainer (Dec. 2014 - ...)
@@ -25,7 +26,7 @@ François-Xavier Mordant - CEA ([email protected])
 * Bug fix, JSON plugin
 
 Jacques Morice - CEA ([email protected])
-* fix the directory of hdf5 library for rhel
+* Fix the directory of hdf5 library for rhel
 
 Thomas Padioleau - CEA ([email protected])
 * Added macOS CI

CHANGELOG.md

@@ -11,6 +11,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
 
 ### Added
+* Add "no-pdi", including the header no-pdi/include/pdi.h, which allows to
+  disable PDI effects while keeping code syntax unchanged.
+  [#438](https://github.com/pdidev/pdi/issues/438)
 * Added macOS CI for PDI, decl_hdf5, mpi, serialize, set_value, user_code and
   trace plugins [#556](https://github.com/pdidev/pdi/issues/556)
 

bin/build_and_run_all_tests

@@ -35,18 +35,32 @@ set -xe
 
 # Make our work dirs
 
-SRCDIR="${PWD}"
+# Set SRCDIR only if not provided
+if [[ -z "${SRCDIR:-}" ]]; then
+  SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+  SRCDIR="$(cd "$SCRIPT_DIR/.." && pwd)"
+fi
 
-TEST_DIR="${TEST_DIR:-${PWD}}"
-cd "${TEST_DIR}"
+# Prepare working directories
+TEST_DIR_WITH_PDI="${TEST_DIR_WITH_PDI:-${PWD}}"
+cd "${TEST_DIR_WITH_PDI}"
 cd "$(mktemp -d pdibuild.XXXXX)"
-TEST_DIR="${PWD}"
+TEST_DIR_ROOT="${PWD}"
+
+mkdir no_pdi
+cd no_pdi
+TEST_DIR_NO_PDI="${PWD}"
+
+cd "${TEST_DIR_ROOT}"
+mkdir with_pdi
+cd with_pdi
+TEST_DIR_WITH_PDI="${PWD}"
 
-cd "${SRCDIR}"
-cd "$(dirname "$0")/.."
-SRCDIR="${PWD}"
+cd "${TEST_DIR_ROOT}"
+mkdir api_pdi
+cd api_pdi
+TEST_DIR_API="${PWD}"
 
-cd "${TEST_DIR}"
 
 
 
@@ -122,8 +136,28 @@ fi
 
 
 
-# Configure, build & test
+# Configure, build & test for pdi
 
+cd "${TEST_DIR_WITH_PDI}"
 cmake -DDIST_PROFILE=Devel ${CMAKE_FLAGS} "${SRCDIR}"
 make ${MAKEFLAGS}
 ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} ${EXCLUDED_PDI_TESTS:+-E $EXCLUDED_PDI_TESTS}
+
+RELATIVE_NO_PDI_PATH="no-pdi"
+if ldconfig -p | grep -q libparaconf; then
+	# Configure, build & test for pdi's example with CMAKE_PREFIX_PATH (find_package) for no-pdi, with Paraconf
+
+	cd "${TEST_DIR_NO_PDI}"
+	cmake -DBUILD_FORTRAN=OFF -DBUILD_DECL_HDF5_PLUGIN=OFF -DBUILD_DECL_NETCDF_PLUGIN=OFF -DCMAKE_PREFIX_PATH="${SRCDIR}/${RELATIVE_NO_PDI_PATH}" "${SRCDIR}/example"
+	make ${MAKEFLAGS}
+	ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} -R PDI_example_trace_C
+fi
+
+# Configure, build & test for no-pdi's specific tests with CMAKE_PREFIX_PATH (find_package), with or without Paraconf
+
+cd "${TEST_DIR_API}"
+NO_PDI_TESTS="test_api_C test_api_CXX"
+cmake -DBUILD_DECL_HDF5_PLUGIN=OFF -DBUILD_DECL_NETCDF_PLUGIN=OFF -DCMAKE_PREFIX_PATH="${SRCDIR}/${RELATIVE_NO_PDI_PATH}" "${SRCDIR}/tests"
+make ${MAKEFLAGS}
+ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} -R ${NO_PDI_TESTS}
+rm -rf CMakeCache.txt CMakeFiles/ cmake_install.cmake Makefile

example/CMakeLists.txt

@@ -1,5 +1,5 @@
 #=============================================================================
-# Copyright (C) 2015-2024 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+# Copyright (C) 2015-2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
 # Copyright (C) 2020 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
 # All rights reserved.
 #
@@ -32,6 +32,7 @@ project(pdi_examples LANGUAGES C)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
 set(MPI_COMPONENTS C)
+set(paraconf_COMPONENTS C)
 set(PDI_COMPONENTS C)
 
 if("${BUILD_FORTRAN}")
@@ -48,6 +49,7 @@ endif()
 # Includes
 include(CTest)
 find_package(MPI REQUIRED COMPONENTS ${MPI_COMPONENTS})
+find_package(paraconf REQUIRED COMPONENTS ${paraconf_COMPONENTS})
 find_package(PDI REQUIRED COMPONENTS ${PDI_COMPONENTS})
 find_library(LIB_M m DOC "The math library")
 
@@ -77,7 +79,8 @@ endif()
 
 
 add_executable(PDI_example_C example.c)
-target_link_libraries(PDI_example_C PDI::PDI_C MPI::MPI_C m)
+target_link_libraries(PDI_example_C paraconf::paraconf PDI::PDI_C MPI::MPI_C m)
+
 
 if("${BUILD_FORTRAN}")
 add_executable(PDI_example_F example.F90)

example/README.md

@@ -117,3 +117,10 @@ Above instruction will share `iter` and `main_field`, call `newiter` event and t
 This is the place when plugins will read/write our data.
 
 We have covered the logic behind the %PDI example. Now you can start the \ref Hands_on.
+
+## PDI deactivation {#pdi_deactivation}
+
+Use `no-pdi` instead of `pdi` when building with:
+```bash
+cmake -DCMAKE_MODULE_PATH=<ABSOLUTE_PATH_TO>/no-pdi/cmake ..
+```

no-pdi/CMakeLists.txt

@@ -0,0 +1,33 @@
+#=============================================================================
+# Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the names of CEA, nor the names of the contributors may be used to
+#   endorse or promote products derived from this software without specific
+#   prior written  permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+cmake_minimum_required(VERSION 3.16...3.29)
+project(PDI LANGUAGES C CXX)
+
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/PDIConfig.cmake")

no-pdi/cmake/PDIConfig.cmake

@@ -0,0 +1,42 @@
+#=============================================================================
+# Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the names of CEA, nor the names of the contributors may be used to
+#   endorse or promote products derived from this software without specific
+#   prior written  permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+add_library(PDI_C INTERFACE)
+add_library(PDI::pdi   ALIAS PDI_C)
+add_library(PDI::PDI_C ALIAS PDI_C)
+
+set_target_properties(PDI_C PROPERTIES
+    INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_LIST_DIR}/../include"
+)
+
+find_package(paraconf 1.0.0 COMPONENTS C)
+
+if(paraconf_FOUND)
+	add_compile_definitions(PARACONF_FOUND)
+endif()

no-pdi/cmake/PDIConfigVersion.cmake

@@ -0,0 +1,30 @@
+#=============================================================================
+# Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the names of CEA, nor the names of the contributors may be used to
+#   endorse or promote products derived from this software without specific
+#   prior written  permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+set(PDI_VERSION "1.9.2")