summaryrefslogtreecommitdiffstats
path: root/src/H5Odrvinfo.c
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2007-03-01 21:26:31 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2007-03-01 21:26:31 (GMT)
commit2e8b6c0223e6969e3840e2dfefdfa34a223f3e15 (patch)
tree2b2dae6d7e737de43d23ba0f4fb0a07596a21078 /src/H5Odrvinfo.c
parent2618906fee4c3fe20c81c8b2b2d744af4f13e5a7 (diff)
downloadhdf5-2e8b6c0223e6969e3840e2dfefdfa34a223f3e15.zip
hdf5-2e8b6c0223e6969e3840e2dfefdfa34a223f3e15.tar.gz
hdf5-2e8b6c0223e6969e3840e2dfefdfa34a223f3e15.tar.bz2
[svn-r13440] Description:
Revise latest form of superblock format pretty drastically, to eliminate unused fields and move rarely used fields into superblock extension. Finished removing last vestiges of references to (never used) i"shared" object header message ID. Added object header messages for non-default v1 B-tree 'K' values and for driver info. Updated testfiles to reflect size changes, etc. Various minor cleanups, etc. Tested on: FreeBSD/32 6.2 (duty) Mac OS X/32 10.4.8 (amazon)
Diffstat (limited to 'src/H5Odrvinfo.c')
-rw-r--r--src/H5Odrvinfo.c313
1 files changed, 313 insertions, 0 deletions
diff --git a/src/H5Odrvinfo.c b/src/H5Odrvinfo.c
new file mode 100644
index 0000000..7e43d82
--- /dev/null
+++ b/src/H5Odrvinfo.c
@@ -0,0 +1,313 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * 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: Quincey Koziol <koziol@hdfgroup.org>
+ * Thursday, March 1, 2007
+ *
+ * Purpose: A message holding driver info settings
+ * in the superblock extension.
+ */
+
+#define H5O_PACKAGE /*suppress error about including H5Opkg */
+
+#include "H5private.h" /* Generic Functions */
+#include "H5Eprivate.h" /* Error handling */
+#include "H5Opkg.h" /* Object headers */
+#include "H5MMprivate.h" /* Memory management */
+
+static void *H5O_drvinfo_decode(H5F_t *f, hid_t dxpl_id, unsigned mesg_flags, const uint8_t *p);
+static herr_t H5O_drvinfo_encode(H5F_t *f, hbool_t disable_shared, uint8_t *p, const void *_mesg);
+static void *H5O_drvinfo_copy(const void *_mesg, void *_dest);
+static size_t H5O_drvinfo_size(const H5F_t *f, hbool_t disable_shared, const void *_mesg);
+static herr_t H5O_drvinfo_reset(void *_mesg);
+static herr_t H5O_drvinfo_debug(H5F_t *f, hid_t dxpl_id, const void *_mesg, FILE *stream,
+ int indent, int fwidth);
+
+/* This message derives from H5O message class */
+const H5O_msg_class_t H5O_MSG_DRVINFO[1] = {{
+ H5O_DRVINFO_ID, /*message id number */
+ "driver info", /*message name for debugging */
+ sizeof(H5O_drvinfo_t), /*native message size */
+ FALSE, /* messages are sharable? */
+ H5O_drvinfo_decode, /*decode message */
+ H5O_drvinfo_encode, /*encode message */
+ H5O_drvinfo_copy, /*copy the native value */
+ H5O_drvinfo_size, /*raw message size */
+ H5O_drvinfo_reset, /*free internal memory */
+ NULL, /* free method */
+ NULL, /* file delete method */
+ NULL, /* link method */
+ NULL, /* set share method */
+ NULL, /*can share method */
+ NULL, /* pre copy native value to file */
+ NULL, /* copy native value to file */
+ NULL, /* post copy native value to file */
+ NULL, /* get creation index */
+ NULL, /* set creation index */
+ H5O_drvinfo_debug /*debug the message */
+}};
+
+/* Current version of driver info information */
+#define H5O_DRVINFO_VERSION 0
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5O_drvinfo_decode
+ *
+ * Purpose: Decode a shared message table message and return a pointer
+ * to a newly allocated H5O_drvinfo_t struct.
+ *
+ * Return: Success: Ptr to new message in native struct.
+ * Failure: NULL
+ *
+ * Programmer: Quincey Koziol
+ * Mar 1, 2007
+ *
+ *-------------------------------------------------------------------------
+ */
+static void *
+H5O_drvinfo_decode(H5F_t *f, hid_t UNUSED dxpl_id, unsigned UNUSED mesg_flags,
+ const uint8_t *p)
+{
+ H5O_drvinfo_t *mesg; /* Native message */
+ void *ret_value; /* Return value */
+
+ FUNC_ENTER_NOAPI_NOINIT(H5O_drvinfo_decode)
+
+ /* Sanity check */
+ HDassert(f);
+ HDassert(p);
+
+ /* Version of message */
+ if(*p++ != H5O_DRVINFO_VERSION)
+ HGOTO_ERROR(H5E_OHDR, H5E_CANTLOAD, NULL, "bad version number for message")
+
+ /* Allocate space for message */
+ if(NULL == (mesg = H5MM_calloc(sizeof(H5O_drvinfo_t))))
+ HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for driver info message")
+
+ /* Retrieve driver name */
+ HDmemcpy(mesg->name, p, 8);
+ mesg->name[8] = '\0';
+ p += 8;
+
+ /* Decode buffer size */
+ UINT16DECODE(p, mesg->len);
+ HDassert(mesg->len);
+
+ /* Allocate space for buffer */
+ if(NULL == (mesg->buf = H5MM_malloc(mesg->len))) {
+ mesg = H5MM_xfree(mesg);
+ HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for driver info buffer")
+ } /* end if */
+
+ /* Copy encoded driver info into buffer */
+ HDmemcpy(mesg->buf, p, mesg->len);
+
+ /* Set return value */
+ ret_value = (void *)mesg;
+
+done:
+ FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5O_drvinfo_decode() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5O_drvinfo_encode
+ *
+ * Purpose: Encode a v1 B-tree 'K' value message.
+ *
+ * Return: Non-negative on success/Negative on failure
+ *
+ * Programmer: Quincey Koziol
+ * Mar 1, 2007
+ *
+ *-------------------------------------------------------------------------
+ */
+static herr_t
+H5O_drvinfo_encode(H5F_t *f, hbool_t UNUSED disable_shared, uint8_t *p, const void *_mesg)
+{
+ const H5O_drvinfo_t *mesg = (const H5O_drvinfo_t *)_mesg;
+
+ FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_drvinfo_encode)
+
+ /* Sanity check */
+ HDassert(f);
+ HDassert(p);
+ HDassert(mesg);
+
+ /* Store version, driver name, buffer length, & encoded buffer */
+ *p++ = H5O_DRVINFO_VERSION;
+ HDmemcpy(p, mesg->name, 8);
+ p += 8;
+ HDassert(mesg->len <= 65535);
+ UINT16ENCODE(p, mesg->len);
+ HDmemcpy(p, mesg->buf, mesg->len);
+
+ FUNC_LEAVE_NOAPI(SUCCEED)
+} /* end H5O_drvinfo_encode() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5O_drvinfo_copy
+ *
+ * Purpose: Copies a message from _MESG to _DEST, allocating _DEST if
+ * necessary.
+ *
+ * Return: Success: Ptr to _DEST
+ * Failure: NULL
+ *
+ * Programmer: Quincey Koziol
+ * Mar 1, 2007
+ *
+ *-------------------------------------------------------------------------
+ */
+static void *
+H5O_drvinfo_copy(const void *_mesg, void *_dest)
+{
+ const H5O_drvinfo_t *mesg = (const H5O_drvinfo_t *)_mesg;
+ H5O_drvinfo_t *dest = (H5O_drvinfo_t *)_dest;
+ void *ret_value;
+
+ FUNC_ENTER_NOAPI_NOINIT(H5O_drvinfo_copy)
+
+ /* Sanity check */
+ HDassert(mesg);
+
+ if(!dest && NULL == (dest = H5MM_malloc(sizeof(H5O_drvinfo_t))))
+ HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for shared message table message")
+
+ /* Shallow copy the fields */
+ *dest = *mesg;
+
+ /* Copy the buffer */
+ if(NULL == (dest->buf = H5MM_malloc(mesg->len))) {
+ if(dest != _dest)
+ dest = H5MM_xfree(dest);
+ HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
+ } /* end if */
+ HDmemcpy(dest->buf, mesg->buf, mesg->len);
+
+ /* Set return value */
+ ret_value = dest;
+
+done:
+ FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5O_drvinfo_copy() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5O_drvinfo_size
+ *
+ * Purpose: Returns the size of the raw message in bytes not counting the
+ * message type or size fields, but only the data fields.
+ *
+ * Return: Success: Message data size in bytes w/o alignment.
+ * Failure: 0
+ *
+ * Programmer: Quincey Koziol
+ * Mar 1, 2007
+ *
+ *-------------------------------------------------------------------------
+ */
+static size_t
+H5O_drvinfo_size(const H5F_t *f, hbool_t UNUSED disable_shared, const void *_mesg)
+{
+ const H5O_drvinfo_t *mesg = (const H5O_drvinfo_t *)_mesg;
+ size_t ret_value;
+
+ FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_drvinfo_size)
+
+ /* Sanity check */
+ HDassert(f);
+ HDassert(mesg);
+
+ ret_value = 1 + /* Version number */
+ 8 + /* Driver name */
+ 2 + /* Buffer length */
+ mesg->len; /* Buffer */
+
+ FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5O_drvinfo_size() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5O_drvinfo_reset
+ *
+ * Purpose: Frees internal pointers and resets the message to an
+ * initial state.
+ *
+ * Return: Non-negative on success/Negative on failure
+ *
+ * Programmer: Quincey Koziol
+ * koziol@hdfgroup.org
+ * Mar 1 2007
+ *
+ *-------------------------------------------------------------------------
+ */
+static herr_t
+H5O_drvinfo_reset(void *_mesg)
+{
+ H5O_drvinfo_t *mesg = (H5O_drvinfo_t *) _mesg;
+
+ FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_drvinfo_reset)
+
+ /* check args */
+ HDassert(mesg);
+
+ /* reset */
+ mesg->buf = H5MM_xfree(mesg->buf);
+
+ FUNC_LEAVE_NOAPI(SUCCEED)
+} /* end H5O_drvinfo_reset() */
+
+
+/*-------------------------------------------------------------------------
+ * Function: H5O_drvinfo_debug
+ *
+ * Purpose: Prints debugging info for the message.
+ *
+ * Return: Non-negative on success/Negative on failure
+ *
+ * Programmer: Quincey Koziol
+ * Mar 1, 2007
+ *
+ *-------------------------------------------------------------------------
+ */
+static herr_t
+H5O_drvinfo_debug(H5F_t UNUSED *f, hid_t UNUSED dxpl_id, const void *_mesg, FILE *stream,
+ int indent, int fwidth)
+{
+ const H5O_drvinfo_t *mesg = (const H5O_drvinfo_t *)_mesg;
+
+ FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_drvinfo_debug)
+
+ /* Sanity check */
+ HDassert(f);
+ HDassert(mesg);
+ HDassert(stream);
+ HDassert(indent >= 0);
+ HDassert(fwidth >= 0);
+
+ HDfprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
+ "Driver name:", mesg->name);
+ HDfprintf(stream, "%*s%-*s %Zu\n", indent, "", fwidth,
+ "Buffer size:", mesg->len);
+
+ FUNC_LEAVE_NOAPI(SUCCEED)
+} /* end H5O_drvinfo_debug() */
+
+