summaryrefslogtreecommitdiffstats
path: root/src/H5VLdummy.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5VLdummy.c')
-rw-r--r--src/H5VLdummy.c301
1 files changed, 301 insertions, 0 deletions
diff --git a/src/H5VLdummy.c b/src/H5VLdummy.c
new file mode 100644
index 0000000..bec0aa3
--- /dev/null
+++ b/src/H5VLdummy.c
@@ -0,0 +1,301 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group. *
+ * Copyright by the Board of Trustees of the University of Illinois. *
+ * All rights reserved. *
+ * *
+ * This file is part of HDF5. The full HDF5 copyright notice, including *
+ * terms governing use, modification, and redistribution, is contained in *
+ * the files COPYING and Copyright.html. COPYING can be found at the root *
+ * of the source code distribution tree; Copyright.html can be found at the *
+ * root level of an installed copy of the electronic HDF5 document set and *
+ * is linked from the top-level documents page. It can also be found at *
+ * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
+ * access to either file, you may request a copy from help@hdfgroup.org. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * Programmer: Mohamad Chaarawi <chaarawi@hdfgroup.gov>
+ * January, 2012
+ *
+ * Purpose: The dummy VOL plugin where access is to a single HDF5 file
+ * using HDF5 VFDs.
+ */
+
+#define H5D_PACKAGE /*suppress error about including H5Dpkg */
+#define H5F_PACKAGE /*suppress error about including H5Fpkg */
+#define H5G_PACKAGE /*suppress error about including H5Gpkg */
+#define H5O_PACKAGE /*suppress error about including H5Opkg */
+#define H5T_PACKAGE /*suppress error about including H5Tpkg */
+
+/* Interface initialization */
+#define H5_INTERFACE_INIT_FUNC H5VL_dummy_init_interface
+
+
+#include "H5private.h" /* Generic Functions */
+#include "H5Aprivate.h" /* Attributes */
+#include "H5Dpkg.h" /* Dataset pkg */
+#include "H5Dprivate.h" /* Datasets */
+#include "H5Eprivate.h" /* Error handling */
+#include "H5Fprivate.h" /* File access */
+#include "H5Fpkg.h" /* File pkg */
+#include "H5FLprivate.h" /* Free lists */
+#include "H5Gpkg.h" /* Groups */
+#include "H5Iprivate.h" /* IDs */
+#include "H5MFprivate.h" /* File memory management */
+#include "H5MMprivate.h" /* Memory management */
+#include "H5Opkg.h" /* Object headers */
+#include "H5Pprivate.h" /* Property lists */
+#include "H5SMprivate.h" /* Shared Object Header Messages */
+#include "H5Tpkg.h" /* Datatypes */
+#include "H5VLprivate.h" /* VOL plugins */
+#include "H5VLdummy.h" /* Dummy VOL plugin */
+
+/* The driver identification number, initialized at runtime */
+static hid_t H5VL_DUMMY_g = 0;
+
+/* Prototypes */
+static herr_t H5VL_dummy_term(void);
+static hid_t H5VL_dummy_file_open(const char *name, unsigned flags, hid_t fapl_id, hid_t req);
+static herr_t H5VL_dummy_file_close(hid_t fid, hid_t req);
+static hid_t H5VL_dummy_file_create(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t req);
+
+H5VL_class_t H5VL_dummy_g = {
+ DUMMY,
+ "dummy", /* name */
+ NULL,
+ H5VL_dummy_term, /*terminate */
+ { /* attribute_cls */
+ NULL, /* create */
+ NULL, /* open */
+ NULL, /* read */
+ NULL, /* write */
+ NULL, /* get */
+ NULL, /* delete */
+ NULL /* close */
+ },
+ { /* datatype_cls */
+ NULL, /* commit */
+ NULL, /* open */
+ NULL /* close */
+ },
+ { /* dataset_cls */
+ NULL, /* create */
+ NULL, /* open */
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL
+ },
+ { /* file_cls */
+ H5VL_dummy_file_create, /* create */
+ H5VL_dummy_file_open, /* open */
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ H5VL_dummy_file_close /* close */
+ },
+ { /* group_cls */
+ NULL,
+ NULL,
+ NULL,
+ NULL
+ },
+ { /* link_cls */
+ NULL, /* create */
+ NULL, /* delete */
+ NULL, /* move */
+ NULL,
+ NULL
+ },
+ { /* object_cls */
+ NULL,
+ NULL, /* copy */
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL
+ }
+};
+
+
+/*--------------------------------------------------------------------------
+NAME
+ H5VL_dummy_init_interface -- Initialize interface-specific information
+USAGE
+ herr_t H5VL_dummy_init_interface()
+
+RETURNS
+ Non-negative on success/Negative on failure
+DESCRIPTION
+ Initializes any interface-specific data or routines. (Just calls
+ H5VL_dummy_init currently).
+
+--------------------------------------------------------------------------*/
+static herr_t
+H5VL_dummy_init_interface(void)
+{
+ FUNC_ENTER_NOAPI_NOINIT_NOERR
+
+ FUNC_LEAVE_NOAPI(SUCCEED)
+} /* H5VL_dummy_init_interface() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5VL_dummy_init
+ *
+ * Purpose: Initialize this vol plugin by registering the driver with the
+ * library.
+ *
+ * Return: Success: The ID for the dummy plugin.
+ * Failure: Negative.
+ *
+ * Programmer: Mohamad Chaarawi
+ * January, 2012
+ *
+ *-------------------------------------------------------------------------
+ */
+H5VL_class_t *
+H5VL_dummy_init(void)
+{
+ H5VL_class_t *ret_value = NULL; /* Return value */
+
+ FUNC_ENTER_NOAPI_NOINIT_NOERR
+
+ /* Set return value */
+ ret_value = &H5VL_dummy_g;
+
+ FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5VL_dummy_init() */
+
+
+/*---------------------------------------------------------------------------
+ * Function: H5VL_dummy_term
+ *
+ * Purpose: Shut down the VOL plugin
+ *
+ * Returns: Non-negative on success or negative on failure
+ *
+ * Programmer: Mohamad Chaarawi
+ * January, 2012
+ *
+ *---------------------------------------------------------------------------
+ */
+static herr_t
+H5VL_dummy_term(void)
+{
+ FUNC_ENTER_NOAPI_NOINIT_NOERR
+
+ /* Reset VOL ID */
+ H5VL_DUMMY_g = 0;
+
+ FUNC_LEAVE_NOAPI(SUCCEED)
+} /* end H5VL_dummy_term() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5Pset_fapl_dummy
+ *
+ * Purpose: Modify the file access property list to use the H5VL_DUMMY
+ * plugin defined in this source file.
+ *
+ * Return: Non-negative on success/Negative on failure
+ *
+ * Programmer: Mohamad Chaarawi
+ * January, 2012
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5Pset_fapl_dummy(hid_t fapl_id)
+{
+ H5P_genplist_t *plist; /* Property list pointer */
+ herr_t ret_value;
+
+ FUNC_ENTER_API(FAIL)
+ H5TRACE1("e", "i", fapl_id);
+
+ if(NULL == (plist = H5P_object_verify(fapl_id, H5P_FILE_ACCESS)))
+ HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list")
+
+ ret_value = H5P_set_vol(plist, &H5VL_dummy_g, NULL);
+
+done:
+ FUNC_LEAVE_API(ret_value)
+} /* end H5Pset_fapl_dummy() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5VL_dummy_open
+ *
+ * Purpose: Opens a file as a dummy HDF5 file.
+ *
+ * Return: Success: A pointer to a new file data structure.
+ * Failure: NULL
+ *
+ * Programmer: Mohamad Chaarawi
+ * January, 2012
+ *
+ *-------------------------------------------------------------------------
+ */
+static hid_t
+H5VL_dummy_file_open(const char *name, unsigned flags, hid_t fapl_id, hid_t req)
+{
+ FUNC_ENTER_NOAPI_NOINIT_NOERR
+
+ printf ("DUMMY OPEN\n");
+
+ FUNC_LEAVE_NOAPI(1)
+} /* end H5VL_dummy_open() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5VL_dummy_create
+ *
+ * Purpose: Creates a file as a dummy HDF5 file.
+ *
+ * Return: Success: A pointer to a new file data structure.
+ * Failure: NULL
+ *
+ * Programmer: Mohamad Chaarawi
+ * January, 2012
+ *
+ *-------------------------------------------------------------------------
+ */
+static hid_t
+H5VL_dummy_file_create(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t req)
+{
+ FUNC_ENTER_NOAPI_NOINIT_NOERR
+
+ printf ("DUMMY CREATE\n");
+
+ FUNC_LEAVE_NOAPI(2)
+} /* end H5VL_dummy_create() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5VL_dummy_close
+ *
+ * Purpose: Closes a file.
+ *
+ * Return: Success: 0
+ * Failure: -1, file not closed.
+ *
+ * Programmer: Mohamad Chaarawi
+ * January, 2012
+ *
+ *-------------------------------------------------------------------------
+ */
+static herr_t
+H5VL_dummy_file_close(hid_t file_id, hid_t req)
+{
+ FUNC_ENTER_NOAPI_NOINIT_NOERR
+
+ printf ("DUMMY CLOSE\n");
+
+ FUNC_LEAVE_NOAPI(1)
+} /* end H5VL_dummy_close() */
generated by cgit v0.12 at 2024-11-03 04:21:21 (GMT)