mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
7aed6abd52
* Replaced last sprintf with snprintf To have the size of the buffer, it was required to change a function signature, and change all users of it. In most cases, determining the buffer size wasn't trivial and so SIZE_MAX is passed. But at least this improves the infrastructure. Someone can later figure out the correct sizes.
322 lines
12 KiB
C
322 lines
12 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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 COPYING file, which can be found at the root of the source code *
|
|
* distribution tree, or in https://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
*
|
|
* Created: H5Oginfo.c
|
|
*
|
|
* Purpose: Group Information messages
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
|
|
#include "H5Omodule.h" /* This source code file is part of the H5O module */
|
|
|
|
#include "H5private.h" /* Generic Functions */
|
|
#include "H5Eprivate.h" /* Error handling */
|
|
#include "H5FLprivate.h" /* Free lists */
|
|
#include "H5Opkg.h" /* Object headers */
|
|
|
|
/* PRIVATE PROTOTYPES */
|
|
static void *H5O__ginfo_decode(H5F_t *f, H5O_t *open_oh, unsigned mesg_flags, unsigned *ioflags,
|
|
size_t p_size, const uint8_t *p);
|
|
static herr_t H5O__ginfo_encode(H5F_t *f, bool disable_shared, size_t H5_ATTR_UNUSED p_size, uint8_t *p,
|
|
const void *_mesg);
|
|
static void *H5O__ginfo_copy(const void *_mesg, void *_dest);
|
|
static size_t H5O__ginfo_size(const H5F_t *f, bool disable_shared, const void *_mesg);
|
|
static herr_t H5O__ginfo_free(void *_mesg);
|
|
static herr_t H5O__ginfo_debug(H5F_t *f, const void *_mesg, FILE *stream, int indent, int fwidth);
|
|
|
|
/* This message derives from H5O message class */
|
|
const H5O_msg_class_t H5O_MSG_GINFO[1] = {{
|
|
H5O_GINFO_ID, /*message id number */
|
|
"ginfo", /*message name for debugging */
|
|
sizeof(H5O_ginfo_t), /*native message size */
|
|
0, /* messages are shareable? */
|
|
H5O__ginfo_decode, /*decode message */
|
|
H5O__ginfo_encode, /*encode message */
|
|
H5O__ginfo_copy, /*copy the native value */
|
|
H5O__ginfo_size, /*size of symbol table entry */
|
|
NULL, /*default reset method */
|
|
H5O__ginfo_free, /* 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__ginfo_debug /*debug the message */
|
|
}};
|
|
|
|
/* Current version of group info information */
|
|
#define H5O_GINFO_VERSION 0
|
|
|
|
/* Flags for group info flag encoding */
|
|
#define H5O_GINFO_STORE_PHASE_CHANGE 0x01
|
|
#define H5O_GINFO_STORE_EST_ENTRY_INFO 0x02
|
|
#define H5O_GINFO_ALL_FLAGS (H5O_GINFO_STORE_PHASE_CHANGE | H5O_GINFO_STORE_EST_ENTRY_INFO)
|
|
|
|
/* Declare a free list to manage the H5O_ginfo_t struct */
|
|
H5FL_DEFINE_STATIC(H5O_ginfo_t);
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5O__ginfo_decode
|
|
*
|
|
* Purpose: Decode a message and return a pointer to
|
|
* a newly allocated one.
|
|
*
|
|
* Return: Success: Pointer to new message in native order
|
|
* Failure: NULL
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
static void *
|
|
H5O__ginfo_decode(H5F_t H5_ATTR_UNUSED *f, H5O_t H5_ATTR_UNUSED *open_oh, unsigned H5_ATTR_UNUSED mesg_flags,
|
|
unsigned H5_ATTR_UNUSED *ioflags, size_t p_size, const uint8_t *p)
|
|
{
|
|
H5O_ginfo_t *ginfo = NULL; /* Pointer to group information message */
|
|
unsigned char flags; /* Flags for encoding group info */
|
|
const uint8_t *p_end = p + p_size - 1; /* End of the p buffer */
|
|
void *ret_value = NULL;
|
|
|
|
FUNC_ENTER_PACKAGE
|
|
|
|
assert(f);
|
|
assert(p);
|
|
|
|
/* Version of message */
|
|
if (H5_IS_BUFFER_OVERFLOW(p, 1, p_end))
|
|
HGOTO_ERROR(H5E_OHDR, H5E_OVERFLOW, NULL, "ran off end of input buffer while decoding");
|
|
if (*p++ != H5O_GINFO_VERSION)
|
|
HGOTO_ERROR(H5E_OHDR, H5E_CANTLOAD, NULL, "bad version number for message");
|
|
|
|
/* Allocate space for message */
|
|
if (NULL == (ginfo = H5FL_CALLOC(H5O_ginfo_t)))
|
|
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
|
|
|
|
/* Get the flags for the group */
|
|
if (H5_IS_BUFFER_OVERFLOW(p, 1, p_end))
|
|
HGOTO_ERROR(H5E_OHDR, H5E_OVERFLOW, NULL, "ran off end of input buffer while decoding");
|
|
|
|
flags = *p++;
|
|
if (flags & ~H5O_GINFO_ALL_FLAGS)
|
|
HGOTO_ERROR(H5E_OHDR, H5E_CANTLOAD, NULL, "bad flag value for message");
|
|
ginfo->store_link_phase_change = (flags & H5O_GINFO_STORE_PHASE_CHANGE) ? true : false;
|
|
ginfo->store_est_entry_info = (flags & H5O_GINFO_STORE_EST_ENTRY_INFO) ? true : false;
|
|
|
|
/* Get the max. # of links to store compactly & the min. # of links to store densely */
|
|
if (ginfo->store_link_phase_change) {
|
|
if (H5_IS_BUFFER_OVERFLOW(p, 2 * 2, p_end))
|
|
HGOTO_ERROR(H5E_OHDR, H5E_OVERFLOW, NULL, "ran off end of input buffer while decoding");
|
|
UINT16DECODE(p, ginfo->max_compact);
|
|
UINT16DECODE(p, ginfo->min_dense);
|
|
}
|
|
else {
|
|
ginfo->max_compact = H5G_CRT_GINFO_MAX_COMPACT;
|
|
ginfo->min_dense = H5G_CRT_GINFO_MIN_DENSE;
|
|
}
|
|
|
|
/* Get the estimated # of entries & name lengths */
|
|
if (ginfo->store_est_entry_info) {
|
|
if (H5_IS_BUFFER_OVERFLOW(p, 2 * 2, p_end))
|
|
HGOTO_ERROR(H5E_OHDR, H5E_OVERFLOW, NULL, "ran off end of input buffer while decoding");
|
|
UINT16DECODE(p, ginfo->est_num_entries);
|
|
UINT16DECODE(p, ginfo->est_name_len);
|
|
}
|
|
else {
|
|
ginfo->est_num_entries = H5G_CRT_GINFO_EST_NUM_ENTRIES;
|
|
ginfo->est_name_len = H5G_CRT_GINFO_EST_NAME_LEN;
|
|
}
|
|
|
|
/* Set return value */
|
|
ret_value = ginfo;
|
|
|
|
done:
|
|
if (!ret_value && ginfo)
|
|
H5FL_FREE(H5O_ginfo_t, ginfo);
|
|
|
|
FUNC_LEAVE_NOAPI(ret_value)
|
|
} /* end H5O__ginfo_decode() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5O__ginfo_encode
|
|
*
|
|
* Purpose: Encodes a message.
|
|
*
|
|
* Return: Non-negative on success/Negative on failure
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
static herr_t
|
|
H5O__ginfo_encode(H5F_t H5_ATTR_UNUSED *f, bool H5_ATTR_UNUSED disable_shared, size_t H5_ATTR_UNUSED p_size,
|
|
uint8_t *p, const void *_mesg)
|
|
{
|
|
const H5O_ginfo_t *ginfo = (const H5O_ginfo_t *)_mesg;
|
|
unsigned char flags = 0; /* Flags for encoding group info */
|
|
|
|
FUNC_ENTER_PACKAGE_NOERR
|
|
|
|
/* check args */
|
|
assert(p);
|
|
assert(ginfo);
|
|
|
|
/* Message version */
|
|
*p++ = H5O_GINFO_VERSION;
|
|
|
|
/* The flags for the group info */
|
|
flags = (unsigned char)(ginfo->store_link_phase_change ? H5O_GINFO_STORE_PHASE_CHANGE : 0);
|
|
flags = (unsigned char)(flags | (ginfo->store_est_entry_info ? H5O_GINFO_STORE_EST_ENTRY_INFO : 0));
|
|
*p++ = flags;
|
|
|
|
/* Store the max. # of links to store compactly & the min. # of links to store densely */
|
|
if (ginfo->store_link_phase_change) {
|
|
UINT16ENCODE(p, ginfo->max_compact);
|
|
UINT16ENCODE(p, ginfo->min_dense);
|
|
} /* end if */
|
|
|
|
/* Estimated # of entries & name lengths */
|
|
if (ginfo->store_est_entry_info) {
|
|
UINT16ENCODE(p, ginfo->est_num_entries);
|
|
UINT16ENCODE(p, ginfo->est_name_len);
|
|
} /* end if */
|
|
|
|
FUNC_LEAVE_NOAPI(SUCCEED)
|
|
} /* end H5O__ginfo_encode() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5O__ginfo_copy
|
|
*
|
|
* Purpose: Copies a message from _MESG to _DEST, allocating _DEST if
|
|
* necessary.
|
|
*
|
|
* Return: Success: Ptr to _DEST
|
|
*
|
|
* Failure: NULL
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
static void *
|
|
H5O__ginfo_copy(const void *_mesg, void *_dest)
|
|
{
|
|
const H5O_ginfo_t *ginfo = (const H5O_ginfo_t *)_mesg;
|
|
H5O_ginfo_t *dest = (H5O_ginfo_t *)_dest;
|
|
void *ret_value = NULL; /* Return value */
|
|
|
|
FUNC_ENTER_PACKAGE
|
|
|
|
/* check args */
|
|
assert(ginfo);
|
|
if (!dest && NULL == (dest = H5FL_MALLOC(H5O_ginfo_t)))
|
|
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
|
|
|
|
/* copy */
|
|
*dest = *ginfo;
|
|
|
|
/* Set return value */
|
|
ret_value = dest;
|
|
|
|
done:
|
|
FUNC_LEAVE_NOAPI(ret_value)
|
|
} /* end H5O__ginfo_copy() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5O__ginfo_size
|
|
*
|
|
* Purpose: Returns the size of the raw message in bytes not counting
|
|
* the message type or size fields, but only the data fields.
|
|
* This function doesn't take into account alignment.
|
|
*
|
|
* Return: Success: Message data size in bytes without alignment.
|
|
*
|
|
* Failure: zero
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
static size_t
|
|
H5O__ginfo_size(const H5F_t H5_ATTR_UNUSED *f, bool H5_ATTR_UNUSED disable_shared, const void *_mesg)
|
|
{
|
|
const H5O_ginfo_t *ginfo = (const H5O_ginfo_t *)_mesg;
|
|
size_t ret_value = 0; /* Return value */
|
|
|
|
FUNC_ENTER_PACKAGE_NOERR
|
|
|
|
/* Set return value */
|
|
ret_value = 1 + /* Version */
|
|
1 + /* Flags */
|
|
(ginfo->store_link_phase_change ? ((size_t)(2 + /* "Max compact" links */
|
|
2) /* "Min dense" links */
|
|
)
|
|
: 0) + /* "Min dense" links */
|
|
(ginfo->store_est_entry_info ? ((size_t)(2 + /* Estimated # of entries in group */
|
|
2) /* Estimated length of name of entry in group */
|
|
)
|
|
: 0);
|
|
|
|
FUNC_LEAVE_NOAPI(ret_value)
|
|
} /* end H5O__ginfo_size() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5O__ginfo_free
|
|
*
|
|
* Purpose: Frees the message
|
|
*
|
|
* Return: Non-negative on success/Negative on failure
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
static herr_t
|
|
H5O__ginfo_free(void *mesg)
|
|
{
|
|
FUNC_ENTER_PACKAGE_NOERR
|
|
|
|
assert(mesg);
|
|
|
|
mesg = H5FL_FREE(H5O_ginfo_t, mesg);
|
|
|
|
FUNC_LEAVE_NOAPI(SUCCEED)
|
|
} /* end H5O__ginfo_free() */
|
|
|
|
/*-------------------------------------------------------------------------
|
|
* Function: H5O__ginfo_debug
|
|
*
|
|
* Purpose: Prints debugging info for a message.
|
|
*
|
|
* Return: Non-negative on success/Negative on failure
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
static herr_t
|
|
H5O__ginfo_debug(H5F_t H5_ATTR_UNUSED *f, const void *_mesg, FILE *stream, int indent, int fwidth)
|
|
{
|
|
const H5O_ginfo_t *ginfo = (const H5O_ginfo_t *)_mesg;
|
|
|
|
FUNC_ENTER_PACKAGE_NOERR
|
|
|
|
/* check args */
|
|
assert(f);
|
|
assert(ginfo);
|
|
assert(stream);
|
|
assert(indent >= 0);
|
|
assert(fwidth >= 0);
|
|
|
|
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth, "Max. compact links:", ginfo->max_compact);
|
|
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth, "Min. dense links:", ginfo->min_dense);
|
|
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
|
|
"Estimated # of objects in group:", ginfo->est_num_entries);
|
|
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
|
|
"Estimated length of object in group's name:", ginfo->est_name_len);
|
|
|
|
FUNC_LEAVE_NOAPI(SUCCEED)
|
|
} /* end H5O__ginfo_debug() */
|