Ready for PR, Fix #438, include unit test for PDI C deactivation, to do : Fortran equivalent

Author: JAuriac

AUTHORS

@@ -6,6 +6,8 @@ Please note this is the list for the distribution mechanism of PDI. The list for
 each sub-project (including PDI itself) is located in the dedicated sub-project
 AUTHORS file.
 
+Julian Auriac - CEA ([email protected])
+* Maintainer (Nov. 2024 - ...)
 
 Julien Bigot - CEA ([email protected])
 * Maintainer (Dec. 2014 - ...)
@@ -36,6 +38,3 @@ project co-financed by Polish Ministry of Science and Higher Education.
 
 Yushan Wang - CEA ([email protected])
 * Maintainer (Sept. 2023 - ...)
-
-Julian Auriac - CEA ([email protected])
-* Maintainer (Nov. 2024 - ...)

pdi/docs/Using_PDI.md

@@ -36,6 +36,7 @@ variables set up.
 
 If source files (of application that uses %PDI) and specification tree file are ready, the compilation step can be made.
 For C make sure that source files that use %PDI API are including `pdi.h` header file.
+%PDI can be disabled by using `pdi_deactivation.h` instead of `pdi.h`, and re-enabled by doing the opposite.
 For Fortran make sure that source files that use %PDI API are using `%PDI` module file (`USE %PDI`).
 
 ### Compiling by hand {#compiling_by_hand}
@@ -92,4 +93,4 @@ plugins in 4 steps (it will use the first plugin found):
 1. `PDI_PLUGIN_PATH` environment variable that is colon separated list with paths,
 2. `plugin_path` subtree in specification tree: \ref plugin_path_map_node,
 3. Relative path of used %PDI shared object `libpdi.so`,
-4. `LD_LIBRARY_PATH` environment variable that is colon separated list.
+4. `LD_LIBRARY_PATH` environment variable that is colon separated list.

pdi/include/pdi_deactivation.h

@@ -52,7 +52,6 @@
  * 
  */
 
-#ifdef PDI_H_
 #define PDI_H_
 
 #include <paraconf.h>
@@ -64,9 +63,68 @@
 extern "C" {
 #endif
 
-// /** \addtogroup error
-//  * \{
-//  */
+/** \addtogroup error
+ * \{
+ */
+
+/** Error codes of PDI
+ */
+typedef enum PDI_status_e {
+	/// everything went well
+	PDI_OK = 0,
+	/// on an input call, no such data is available
+	PDI_UNAVAILABLE,
+	/// The configuration file is invalid
+	PDI_ERR_CONFIG,
+	/// A value expression is invalid
+	PDI_ERR_VALUE,
+	/// Tried to load a non-existing plugin
+	PDI_ERR_PLUGIN,
+	/// Implementation limitation (typically an unimplemented feature)
+	PDI_ERR_IMPL,
+	/// A system error occured (OS, etc.)
+	PDI_ERR_SYSTEM,
+	/** A call to a function has been made at a wrong time (e.g. closing an
+	 *  unopened transaction)
+	 */
+	PDI_ERR_STATE,
+	/// A conflict of onwership over a content has been raised
+	PDI_ERR_RIGHT,
+	/// Invalid type error
+	PDI_ERR_TYPE
+
+} PDI_status_t;
+
+/** Type of a callback function used when an error occurs
+ * \param status the error code
+ * \param message the human-readable error message
+ * \param context a user-provided context
+ */
+typedef void (*PDI_errfunc_f)(PDI_status_t status, const char* message, void* context);
+
+/** Definition of an error handler
+ */
+typedef struct PDI_errhandler_s {
+	/// The function to handle the error (none if NULL)
+	PDI_errfunc_f func;
+
+	/// the context that will be provided to the function
+	void* context;
+
+} PDI_errhandler_t;
+
+/** Prints the error message and aborts if the status is invalid
+ */
+extern const PDI_errhandler_t PDI_EXPORT PDI_ASSERT_HANDLER;
+
+/** Prints the error message and continue if the status is invalid
+ */
+extern const PDI_errhandler_t PDI_EXPORT PDI_WARN_HANDLER;
+
+/** Does nothing
+ */
+extern const PDI_errhandler_t PDI_EXPORT PDI_NULL_HANDLER;
+
 
 /** Return a human-readabe message describing the last error that occured in PDI
  */
@@ -116,6 +174,21 @@ PDI_status_t PDI_EXPORT PDI_version(unsigned long* provided, unsigned long expec
  * \{
  */
 
+/**
+ * Access directions
+ */
+typedef enum PDI_inout_e {
+	/// No data transfert
+	PDI_NONE = 0,
+	/// data tranfer from PDI to the main code
+	PDI_IN = 1,
+	/// data transfer from the main code to PDI
+	PDI_OUT = 2,
+	/// data transfer in both direction
+	PDI_INOUT = 3
+
+} PDI_inout_t;
+
 /** Shares some data with PDI. The user code should not modify it before
  * a call to either PDI_release or PDI_reclaim.
  * \param[in] name the data name
@@ -229,6 +302,3 @@ PDI_status_t PDI_DEPRECATED_EXPORT PDI_transaction_end(void){};
 #ifdef __cplusplus
 } // extern C
 #endif
-
-
-#endif // PDI_H_

tests/AUTHORS

@@ -2,6 +2,8 @@ Multiple people have contributed to the PDI tests. To show our appreciation for
 their public spirit, we list here in alphabetical order a condensed list of
 their contributions.
 
+Julian Auriac - CEA ([email protected])
+* Maintainer (Nov. 2024 - ...)
 
 Julien Bigot - CEA ([email protected])
 * Initial buildsystem
@@ -15,4 +17,4 @@ project co-financed by Polish Ministry of Science and Higher Education.
 * Tests inspired by Parflow that combine Serialize & Decl'HDF5
 
 Yushan Wang - CEA ([email protected])
-* Maintainer (Sept. 2023 - ...)
+* Maintainer (Sept. 2023 - ...)

tests/CMakeLists.txt

@@ -56,6 +56,10 @@ add_executable(test_04_C test_04.c)
 target_link_libraries(test_04_C PDI::PDI_C)
 add_test(NAME test_04_C COMMAND "$<TARGET_FILE:test_04_C>" "${CMAKE_CURRENT_SOURCE_DIR}/test_04.yml")
 
+add_executable(test_06_C test_06.c)
+target_link_libraries(test_06_C PDI::PDI_C)
+add_test(NAME test_06_C COMMAND "$<TARGET_FILE:test_06_C>" "${CMAKE_CURRENT_SOURCE_DIR}/test_06.yml")
+
 endif("${BUILD_DECL_HDF5_PLUGIN}" AND "${BUILD_SERIALIZE_PLUGIN}")
 if("${BUILD_DECL_NETCDF_PLUGIN}" AND "${BUILD_SERIALIZE_PLUGIN}")
 

tests/test_06.c

@@ -0,0 +1,52 @@
+/*******************************************************************************
+ * Copyright (C) 2024 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 name of CEA nor the names of its contributors may be used to
+ *   endorse or promote products derived from this software without specific
+ *   prior written permission.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ ******************************************************************************/
+
+#include <assert.h>
+// #include <pdi.h>
+#include <pdi_deactivation.h>
+#include <stdio.h>
+
+
+int main(int argc, char* argv[])
+{
+    PC_tree_t conf = PC_parse_path(argv[1]);
+
+    PDI_init(PC_get(conf, ".pdi"));
+    printf("%s",argv[1]);
+
+    long longval;
+
+    int global_size[2];
+    PC_int(PC_get(conf, ".global_size.height"), &longval); global_size[0] = longval;
+    PC_int(PC_get(conf, ".global_size.width"), &longval); global_size[1] = longval;
+
+    // # As the value is shared with pdi.h, it can be reclaimed in a second time.
+    // # In the case of pdi_deactivation.h, the value is never shared, hence the reclaim operation fails.
+	// PDI_share("global_size",    global_size,    PDI_OUT) == NULL;
+	PDI_reclaim("global_size");
+
+	PDI_finalize();
+	return 0;
+}

tests/test_06.yml

@@ -0,0 +1,6 @@
+global_size: { height: 60, width: 12 }
+
+pdi:
+  plugins:
+    trace:
+      logging: { pattern: '[PDI][%n-plugin] *** %l: %v' }