summaryrefslogtreecommitdiffstats
path: root/src/H5Fsuper.c
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2007-02-22 02:00:40 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2007-02-22 02:00:40 (GMT)
commit182c05cb95472cae9411169d295a4bcad6f5edd7 (patch)
treefb1adb87d49a83ed0e10a579dded38144b815135 /src/H5Fsuper.c
parent2468b8aa1c8f07211e86f1ec937c4f7f14e3ddbe (diff)
downloadhdf5-182c05cb95472cae9411169d295a4bcad6f5edd7.zip
hdf5-182c05cb95472cae9411169d295a4bcad6f5edd7.tar.gz
hdf5-182c05cb95472cae9411169d295a4bcad6f5edd7.tar.bz2
[svn-r13375] Description:
Straighten out some of the code for handling superblocks, in preparation for revising the format of the latest version of the superblock before the beta release. Tested on: Mac OS X/32 10.4.8 (amazon) FreeBSD/32 6.2 (duty)
Diffstat (limited to 'src/H5Fsuper.c')
-rw-r--r--src/H5Fsuper.c409
1 files changed, 235 insertions, 174 deletions
diff --git a/src/H5Fsuper.c b/src/H5Fsuper.c
index dc31a97..ffb101f 100644
--- a/src/H5Fsuper.c
+++ b/src/H5Fsuper.c
@@ -13,13 +13,19 @@
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+/****************/
+/* Module Setup */
+/****************/
+
#define H5F_PACKAGE /*suppress error about including H5Fpkg */
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5F_init_super_interface
-/* Packages needed by this file... */
+/***********/
+/* Headers */
+/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Fpkg.h" /* File access */
@@ -28,7 +34,92 @@
#include "H5Pprivate.h" /* Property lists */
#include "H5SMprivate.h" /* Shared Object Header Messages */
-/* PRIVATE PROTOTYPES */
+
+/****************/
+/* Local Macros */
+/****************/
+
+/* Superblock sizes for various versions */
+#define H5F_SIZEOF_CHKSUM 4 /* Checksum size in the file */
+
+/* Fixed-size portion at the beginning of all superblocks */
+#define H5F_SUPERBLOCK_FIXED_SIZE ( H5F_SIGNATURE_LEN \
+ + 3 /* superblock, freespace, and root group versions */ \
+ + 1 /* reserved */ \
+ + 3 /* shared header vers, size of address, size of lengths */ \
+ + 1 /* reserved */ \
+ + 4 /* group leaf k, group internal k */ \
+ + 4) /* consistency flags */
+
+/* Macros for computing variable-size superblock size */
+#define H5F_SUPERBLOCK_VARLEN_SIZE_V0(f) \
+ ( H5F_SIZEOF_ADDR(f) /* base address */ \
+ + H5F_SIZEOF_ADDR(f) /* free space address */ \
+ + H5F_SIZEOF_ADDR(f) /* EOF address */ \
+ + H5F_SIZEOF_ADDR(f) /* driver block address */ \
+ + H5G_SIZEOF_ENTRY(f)) /* root group ptr */
+#define H5F_SUPERBLOCK_VARLEN_SIZE_V1(f) \
+ ( 2 /* indexed B-tree internal k */ \
+ + 2 /* reserved */ \
+ + H5F_SIZEOF_ADDR(f) /* base address */ \
+ + H5F_SIZEOF_ADDR(f) /* free space address */ \
+ + H5F_SIZEOF_ADDR(f) /* EOF address */ \
+ + H5F_SIZEOF_ADDR(f) /* driver block address */ \
+ + H5G_SIZEOF_ENTRY(f)) /* root group ptr */
+#define H5F_SUPERBLOCK_VARLEN_SIZE_V2(f) \
+ ( 2 /* indexed B-tree internal k */ \
+ + H5F_SIZEOF_ADDR(f) /* base address */ \
+ + H5F_SIZEOF_ADDR(f) /* free space address */ \
+ + H5F_SIZEOF_ADDR(f) /* EOF address */ \
+ + H5F_SIZEOF_ADDR(f) /* driver block address */ \
+ + H5G_SIZEOF_ENTRY(f) /* root group ptr */ \
+ + H5F_SIZEOF_CHKSUM)
+#define H5F_SUPERBLOCK_VARLEN_SIZE(v, f) ( \
+ (v == 0 ? H5F_SUPERBLOCK_VARLEN_SIZE_V0(f) : 0) \
+ + (v == 1 ? H5F_SUPERBLOCK_VARLEN_SIZE_V1(f) : 0) \
+ + (v == 2 ? H5F_SUPERBLOCK_VARLEN_SIZE_V2(f) : 0))
+
+/* Total size of superblock, depends on superblock version */
+#define H5F_SUPERBLOCK_SIZE(v, f) ( H5F_SUPERBLOCK_FIXED_SIZE \
+ + H5F_SUPERBLOCK_VARLEN_SIZE(v, f))
+
+/* Driver info block macros */
+#define H5F_DRVINFOBLOCK_HDR_SIZE 16
+#define H5F_DRVINFO_CHKSUM(v) (v == 0 ? 0 : H5F_SIZEOF_CHKSUM)
+
+/* Maximum size of super-block buffers */
+#define H5F_MAX_SUPERBLOCK_SIZE 134
+#define H5F_MAX_DRVINFOBLOCK_SIZE 1024
+
+
+/******************/
+/* Local Typedefs */
+/******************/
+
+
+/********************/
+/* Package Typedefs */
+/********************/
+
+
+/********************/
+/* Local Prototypes */
+/********************/
+
+
+/*********************/
+/* Package Variables */
+/*********************/
+
+
+/*****************************/
+/* Library Private Variables */
+/*****************************/
+
+
+/*******************/
+/* Local Variables */
+/*******************/
/*--------------------------------------------------------------------------
@@ -71,7 +162,7 @@ H5F_init_super_interface(void)
*-------------------------------------------------------------------------
*/
herr_t
-H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr, uint8_t *buf, size_t buf_size)
+H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc)
{
haddr_t stored_eoa; /*relative end-of-addr in file */
haddr_t eof; /*end of file address */
@@ -84,16 +175,16 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
H5F_file_t *shared = NULL; /* shared part of `file' */
H5FD_t *lf = NULL; /* file driver part of `shared' */
uint8_t *p; /* Temporary pointer into encoding buffers */
- uint8_t *start_p; /* Start of encoding buffers */
uint32_t read_chksum; /* Checksum read from file */
uint32_t computed_chksum; /* Computed checksum */
size_t driver_size; /* Size of driver info block, in bytes */
char driver_name[9]; /* Name of driver, for driver info block */
- unsigned super_vers; /* Super block version */
+ unsigned super_vers; /* Superblock version */
unsigned freespace_vers; /* Freespace info version */
unsigned obj_dir_vers; /* Object header info version */
unsigned share_head_vers; /* Shared header info version */
uint8_t sbuf[H5F_MAX_SUPERBLOCK_SIZE]; /* Local buffer */
+ size_t buf_size = sizeof(sbuf); /* Size of superblock buffer */
unsigned nindexes; /* Number of shared message indexes */
H5P_genplist_t *c_plist; /* File creation property list */
herr_t ret_value = SUCCEED;
@@ -108,47 +199,39 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
if (NULL == (c_plist = H5I_object(shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't get property list")
- /* Read the superblock if it hasn't been read before. */
- if (addr == HADDR_UNDEF) {
- if (HADDR_UNDEF == (shared->super_addr=H5F_locate_signature(lf,dxpl_id)))
- HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, FAIL, "unable to find file signature")
- } else {
- shared->super_addr = addr;
- }
-
- if (!buf) {
- start_p = p = sbuf;
- buf_size=sizeof(sbuf);
+ /* Read the superblock */
+ if(HADDR_UNDEF == (shared->super_addr = H5F_locate_signature(lf, dxpl_id)))
+ HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, FAIL, "unable to find file signature")
- if (H5FD_set_eoa(lf, H5FD_MEM_SUPER, shared->super_addr + fixed_size) < 0 ||
- H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, shared->super_addr, fixed_size, p) < 0)
- HGOTO_ERROR(H5E_FILE, H5E_READERROR, FAIL, "unable to read superblock")
- } else {
- start_p = p = buf;
- }
+ /* Read fixed-size portion of the superblock */
+ p = sbuf;
+ if(H5FD_set_eoa(lf, H5FD_MEM_SUPER, shared->super_addr + fixed_size) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "set end of space allocation request failed")
+ if(H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, shared->super_addr, fixed_size, p) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_READERROR, FAIL, "unable to read superblock")
/* Signature, already checked */
p += H5F_SIGNATURE_LEN;
/* Superblock version */
super_vers = *p++;
- if (super_vers > HDF5_SUPERBLOCK_VERSION_MAX)
+ if(super_vers > HDF5_SUPERBLOCK_VERSION_MAX)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL, "bad superblock version number")
- if (H5P_set(c_plist, H5F_CRT_SUPER_VERS_NAME, &super_vers) < 0)
+ if(H5P_set(c_plist, H5F_CRT_SUPER_VERS_NAME, &super_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set superblock version")
/* Freespace version */
freespace_vers = *p++;
- if (HDF5_FREESPACE_VERSION != freespace_vers)
+ if(HDF5_FREESPACE_VERSION != freespace_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL, "bad free space version number")
- if (H5P_set(c_plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers) < 0)
+ if(H5P_set(c_plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set free space version")
/* Root group version number */
obj_dir_vers = *p++;
- if (HDF5_OBJECTDIR_VERSION != obj_dir_vers)
+ if(HDF5_OBJECTDIR_VERSION != obj_dir_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL, "bad object directory version number")
- if (H5P_set(c_plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers) < 0)
+ if(H5P_set(c_plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set object directory version")
/* Skip over reserved byte */
@@ -156,26 +239,26 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
/* Shared header version number */
share_head_vers = *p++;
- if (HDF5_SHAREDHEADER_VERSION != share_head_vers)
+ if(HDF5_SHAREDHEADER_VERSION != share_head_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL, "bad shared-header format version number")
- if (H5P_set(c_plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers) < 0)
+ if(H5P_set(c_plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set shared-header format version")
/* Size of file addresses */
sizeof_addr = *p++;
- if (sizeof_addr != 2 && sizeof_addr != 4 &&
+ if(sizeof_addr != 2 && sizeof_addr != 4 &&
sizeof_addr != 8 && sizeof_addr != 16 && sizeof_addr != 32)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL, "bad byte number in an address")
- if (H5P_set(c_plist, H5F_CRT_ADDR_BYTE_NUM_NAME,&sizeof_addr) < 0)
+ if(H5P_set(c_plist, H5F_CRT_ADDR_BYTE_NUM_NAME,&sizeof_addr) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set byte number in an address")
shared->sizeof_addr = sizeof_addr; /* Keep a local copy also */
/* Size of file sizes */
sizeof_size = *p++;
- if (sizeof_size != 2 && sizeof_size != 4 &&
+ if(sizeof_size != 2 && sizeof_size != 4 &&
sizeof_size != 8 && sizeof_size != 16 && sizeof_size != 32)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL, "bad byte number for object size")
- if (H5P_set(c_plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &sizeof_size) < 0)
+ if(H5P_set(c_plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &sizeof_size) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set byte number for object size")
shared->sizeof_size = sizeof_size; /* Keep a local copy also */
@@ -184,17 +267,17 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
/* Various B-tree sizes */
UINT16DECODE(p, sym_leaf_k);
- if (sym_leaf_k == 0)
+ if(sym_leaf_k == 0)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, FAIL, "bad symbol table leaf node 1/2 rank")
- if (H5P_set(c_plist, H5F_CRT_SYM_LEAF_NAME, &sym_leaf_k) < 0)
+ if(H5P_set(c_plist, H5F_CRT_SYM_LEAF_NAME, &sym_leaf_k) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set rank for symbol table leaf nodes")
shared->sym_leaf_k = sym_leaf_k; /* Keep a local copy also */
/* Need 'get' call to set other array values */
- if (H5P_get(c_plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)
+ if(H5P_get(c_plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get rank for btree internal nodes")
UINT16DECODE(p, btree_k[H5B_SNODE_ID]);
- if (btree_k[H5B_SNODE_ID] == 0)
+ if(btree_k[H5B_SNODE_ID] == 0)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, FAIL, "bad 1/2 rank for btree internal nodes")
/*
* Delay setting the value in the property list until we've checked
@@ -203,57 +286,48 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
/* File consistency flags. Not really used yet */
UINT32DECODE(p, shared->consist_flags);
- assert(((size_t)(p - start_p)) == fixed_size);
-
- /* Decode the variable-length part of the superblock... */
- if(super_vers == HDF5_SUPERBLOCK_VERSION_DEF)
- variable_size = H5F_SUPERBLOCK_VARLEN_SIZE_V0(f);
- else if (super_vers == HDF5_SUPERBLOCK_VERSION_1)
- variable_size = H5F_SUPERBLOCK_VARLEN_SIZE_V1(f);
- else
- variable_size = H5F_SUPERBLOCK_VARLEN_SIZE_V2(f);
+ HDassert(((size_t)(p - sbuf)) == fixed_size);
- assert(fixed_size + variable_size <= buf_size);
+ /* Determine the size of the variable-length part of the superblock */
+ variable_size = H5F_SUPERBLOCK_VARLEN_SIZE(super_vers, f);
+ HDassert(variable_size > 0);
+ HDassert(fixed_size + variable_size <= buf_size);
- /* The buffer (buf) is either passed in or the "local_buf" variable now */
- if(!buf) {
- if (H5FD_set_eoa(lf, H5FD_MEM_SUPER, shared->super_addr + fixed_size+variable_size) < 0 ||
- H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, shared->super_addr + fixed_size,
- variable_size, p) < 0)
- HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read superblock")
- } /* end if */
+ /* Read in variable-sized portion of superblock */
+ if(H5FD_set_eoa(lf, H5FD_MEM_SUPER, shared->super_addr + fixed_size + variable_size) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "set end of space allocation request failed")
+ if(H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, shared->super_addr + fixed_size, variable_size, p) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read superblock")
/*
* If the superblock version # is greater than 0, read in the indexed
* storage B-tree internal 'K' value
*/
- if (super_vers > HDF5_SUPERBLOCK_VERSION_DEF) {
+ if(super_vers > HDF5_SUPERBLOCK_VERSION_DEF) {
UINT16DECODE(p, btree_k[H5B_ISTORE_ID]);
/* Reserved bytes are present only in version 1 */
- if(super_vers == HDF5_SUPERBLOCK_VERSION_1) {
+ if(super_vers == HDF5_SUPERBLOCK_VERSION_1)
p += 2; /* reserved */
- }
- }
+ } /* end if */
else
btree_k[H5B_ISTORE_ID] = HDF5_BTREE_ISTORE_IK_DEF;
/* Set the B-tree internal node values, etc */
- if (H5P_set(c_plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)
+ if(H5P_set(c_plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set rank for btree internal nodes")
HDmemcpy(shared->btree_k, btree_k, sizeof(unsigned) * (size_t)H5B_NUM_BTREE_ID); /* Keep a local copy also */
H5F_addr_decode(f, (const uint8_t **)&p, &shared->base_addr/*out*/);
- H5F_addr_decode(f, (const uint8_t **)&p, &(shared->extension_addr)/*out*/);
-
+ H5F_addr_decode(f, (const uint8_t **)&p, &shared->extension_addr/*out*/);
H5F_addr_decode(f, (const uint8_t **)&p, &stored_eoa/*out*/);
H5F_addr_decode(f, (const uint8_t **)&p, &shared->driver_addr/*out*/);
if(H5G_obj_ent_decode(f, (const uint8_t **)&p, root_loc->oloc/*out*/) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read root symbol entry")
- /* Compute super block checksum for versions greater than 1 */
+ /* Compute superblock checksum for versions greater than 1 */
if(super_vers >= HDF5_SUPERBLOCK_VERSION_2) {
computed_chksum = H5_checksum_metadata(sbuf, (unsigned) (p - sbuf), 0);
- /* Read stored super block checksum */
+ /* Read stored superblock checksum */
UINT32DECODE(p, read_chksum);
if(read_chksum != computed_chksum)
@@ -266,9 +340,9 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
* Check if superblock address is different from base address and
* adjust base address and "end of address" address if so.
*/
- if (!H5F_addr_eq(shared->super_addr,shared->base_addr)) {
+ if(!H5F_addr_eq(shared->super_addr, shared->base_addr)) {
/* Check if the superblock moved earlier in the file */
- if (H5F_addr_lt(shared->super_addr, shared->base_addr))
+ if(H5F_addr_lt(shared->super_addr, shared->base_addr))
stored_eoa -= (shared->base_addr - shared->super_addr);
else
/* The superblock moved later in the file */
@@ -286,30 +360,22 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
shared->driver_addr = HADDR_UNDEF;
/* Decode the optional driver information block */
- if (H5F_addr_defined(shared->driver_addr)) {
+ if(H5F_addr_defined(shared->driver_addr)) {
unsigned drv_vers;
haddr_t drv_addr = shared->base_addr + shared->driver_addr;
uint8_t dbuf[H5F_MAX_DRVINFOBLOCK_SIZE]; /* Local buffer */
- size_t dbuf_size; /* Size available for driver info */
- const uint8_t *driver_p; /* Remember beginning of driver info block */
-
+ size_t dbuf_size = sizeof(dbuf); /* Size available for driver info */
- if(!buf) {
- driver_p = p = dbuf;
- dbuf_size=sizeof(dbuf);
-
- if (H5FD_set_eoa(lf, H5FD_MEM_SUPER, drv_addr + H5F_DRVINFOBLOCK_HDR_SIZE) < 0 ||
- H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, drv_addr, (size_t)H5F_DRVINFOBLOCK_HDR_SIZE, p) < 0)
- HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read driver information block")
- } /* end if */
- else {
- driver_p = p;
- dbuf_size=buf_size-(p-start_p);
- } /* end else */
+ /* Read in fixed-sized portion of driver info block */
+ p = dbuf;
+ if(H5FD_set_eoa(lf, H5FD_MEM_SUPER, drv_addr + H5F_DRVINFOBLOCK_HDR_SIZE) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "set end of space allocation request failed")
+ if(H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, drv_addr, (size_t)H5F_DRVINFOBLOCK_HDR_SIZE, p) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read driver information block")
/* Version number */
drv_vers = *p++;
- if (drv_vers > HDF5_DRIVERINFO_VERSION_MAX)
+ if(drv_vers > HDF5_DRIVERINFO_VERSION_MAX)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "bad driver information block version number")
p += 3; /* reserved bytes */
@@ -327,11 +393,11 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
/* Read driver information */
HDassert((driver_size + H5F_DRVINFOBLOCK_HDR_SIZE + H5F_DRVINFO_CHKSUM(drv_vers)) <= dbuf_size);
- if(!buf) {
- if (H5FD_set_eoa(lf, H5FD_MEM_SUPER, drv_addr + H5F_DRVINFOBLOCK_HDR_SIZE + driver_size + H5F_DRVINFO_CHKSUM(drv_vers)) < 0 ||
- H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, drv_addr+H5F_DRVINFOBLOCK_HDR_SIZE, driver_size, p) < 0)
- HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read file driver information")
- } /* end if */
+ /* Read in variable-sized portion of driver info block */
+ if(H5FD_set_eoa(lf, H5FD_MEM_SUPER, drv_addr + H5F_DRVINFOBLOCK_HDR_SIZE + driver_size + H5F_DRVINFO_CHKSUM(drv_vers)) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "set end of space allocation request failed")
+ if(H5FD_read(lf, H5FD_MEM_SUPER, dxpl_id, drv_addr + H5F_DRVINFOBLOCK_HDR_SIZE, driver_size, p) < 0)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to read file driver information")
/* Decode driver information */
/* Check if driver matches driver information saved. Unfortunately, we can't push this
@@ -341,12 +407,13 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
if(!HDstrncmp(driver_name, "NCSAmult", (size_t)8) && HDstrcmp(lf->cls->name, "multi"))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "multi driver should be used")
- if (H5FD_sb_decode(lf, driver_name, p) < 0)
+ /* Decode the driver-specific driver info block information */
+ if(H5FD_sb_decode(lf, driver_name, p) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to decode driver information")
p += driver_size;
- /* Compute checksum for versions > 0*/
+ /* Compute checksum for versions > 0 */
if(drv_vers >= HDF5_DRIVERINFO_VERSION_1) {
computed_chksum = H5_checksum_metadata(dbuf, (H5F_DRVINFOBLOCK_HDR_SIZE + driver_size), 0);
/* Read checksum */
@@ -354,7 +421,7 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
if(read_chksum != computed_chksum)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "bad checksum on driver information block")
- }
+ } /* end if */
HDassert((unsigned) (p - dbuf) == driver_size + H5F_DRVINFOBLOCK_HDR_SIZE + H5F_DRVINFO_CHKSUM(drv_vers));
} /* end if */
@@ -363,25 +430,24 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
* The user-defined data is the area of the file before the base
* address.
*/
- if (H5P_set(c_plist, H5F_CRT_USER_BLOCK_NAME, &shared->base_addr) < 0)
- HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set usr block size")
+ if(H5P_set(c_plist, H5F_CRT_USER_BLOCK_NAME, &shared->base_addr) < 0)
+ HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "unable to set user block size")
/*
* Make sure that the data is not truncated. One case where this is
* possible is if the first file of a family of files was opened
* individually.
*/
- if (HADDR_UNDEF == (eof = H5FD_get_eof(lf)))
+ if(HADDR_UNDEF == (eof = H5FD_get_eof(lf)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to determine file size")
-
- if (eof < stored_eoa)
+ if(eof < stored_eoa)
HGOTO_ERROR(H5E_FILE, H5E_TRUNCATED, FAIL, "truncated file")
/*
* Tell the file driver how much address space has already been
* allocated so that it knows how to allocate additional memory.
*/
- if (H5FD_set_eoa(lf, H5FD_MEM_SUPER, stored_eoa) < 0)
+ if(H5FD_set_eoa(lf, H5FD_MEM_SUPER, stored_eoa) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to set end-of-address marker for file")
/* Read the file's superblock extension, if there is one. */
@@ -415,12 +481,10 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
if(H5O_close(&ext_loc) < 0)
HGOTO_ERROR(H5E_OHDR, H5E_CANTOPENFILE, FAIL, "unable to close superblock extension")
f->nopen_objs--;
- }
+ } /* end if */
- /* Decode shared object header message information and store it in the
- * fcpl */
- if(shared->sohm_addr != HADDR_UNDEF)
- {
+ /* Decode shared object header message information and store it in the FCPL */
+ if(shared->sohm_addr != HADDR_UNDEF) {
unsigned index_flags[H5O_SHMESG_MAX_NINDEXES] = {0};
unsigned minsizes[H5O_SHMESG_MAX_NINDEXES] = {0};
unsigned sohm_l2b; /* SOHM list-to-btree cutoff */
@@ -443,14 +507,13 @@ H5F_read_superblock(H5F_t *f, hid_t dxpl_id, H5G_loc_t *root_loc, haddr_t addr,
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set SOHM cutoff in property list");
if(H5P_set(c_plist, H5F_CRT_SHMSG_BTREE_MIN_NAME, &sohm_b2l) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set SOHM cutoff in property list");
- }
- else
- {
+ } /* end if */
+ else {
/* Shared object header messages are disabled */
nindexes = 0;
if(H5P_set(c_plist, H5F_CRT_SHMSG_NINDEXES_NAME, &nindexes) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set number of SOHM indexes");
- }
+ } /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
@@ -471,26 +534,24 @@ done:
* koziol@ncsa.uiuc.edu
* Sept 15, 2003
*
- * Modifications:
- *
*-------------------------------------------------------------------------
*/
-hsize_t
-H5F_init_superblock(const H5F_t *f, hid_t dxpl_id)
+herr_t
+H5F_init_superblock(H5F_t *f, H5O_loc_t *ext_loc, hid_t dxpl_id)
{
hsize_t userblock_size = 0; /* Size of userblock, in bytes */
size_t superblock_size; /* Size of superblock, in bytes */
size_t driver_size; /* Size of driver info block (bytes)*/
- unsigned super_vers; /* Super block version */
+ unsigned super_vers; /* Superblock version */
haddr_t addr; /* Address of superblock */
H5P_genplist_t *plist; /* Property list */
- hsize_t ret_value;
+ herr_t ret_value = SUCCEED;
- FUNC_ENTER_NOAPI(H5F_init_superblock, UFAIL)
+ FUNC_ENTER_NOAPI(H5F_init_superblock, FAIL)
/* Get the shared file creation property list */
- if (NULL == (plist = H5I_object(f->shared->fcpl_id)))
- HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, UFAIL, "not a property list")
+ if(NULL == (plist = H5I_object(f->shared->fcpl_id)))
+ HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list")
/*
* The superblock starts immediately after the user-defined
@@ -499,36 +560,35 @@ H5F_init_superblock(const H5F_t *f, hid_t dxpl_id)
* now.
*/
if(H5P_get(plist, H5F_CRT_USER_BLOCK_NAME, &userblock_size) < 0)
- HGOTO_ERROR(H5E_FILE, H5E_CANTGET, UFAIL, "unable to get user block size")
+ HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "unable to get user block size")
f->shared->super_addr = userblock_size;
f->shared->base_addr = f->shared->super_addr;
f->shared->consist_flags = 0x03;
/* Grab superblock version from property list */
- if (H5P_get(plist, H5F_CRT_SUPER_VERS_NAME, &super_vers) < 0)
- HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, UFAIL, "unable to get super block version")
+ if(H5P_get(plist, H5F_CRT_SUPER_VERS_NAME, &super_vers) < 0)
+ HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get superblock version")
/* Compute the size of the superblock */
- superblock_size=H5F_SUPERBLOCK_FIXED_SIZE;
-
- if(super_vers==HDF5_SUPERBLOCK_VERSION_DEF)
- superblock_size += H5F_SUPERBLOCK_VARLEN_SIZE_V0(f);
- else if (super_vers == HDF5_SUPERBLOCK_VERSION_1)
- superblock_size += H5F_SUPERBLOCK_VARLEN_SIZE_V1(f);
- else if (super_vers == HDF5_SUPERBLOCK_VERSION_2)
- superblock_size += H5F_SUPERBLOCK_VARLEN_SIZE_V2(f);
+ superblock_size = H5F_SUPERBLOCK_SIZE(super_vers, f);
/* Compute the size of the driver information block. Use driver block
- * version 1 if the superblock is at least version 2 */
+ * version 1 if the superblock is at least version 2
+ */
H5_ASSIGN_OVERFLOW(driver_size, H5FD_sb_size(f->shared->lf), hsize_t, size_t);
- if (driver_size > 0)
- {
+ if(driver_size > 0) {
driver_size += H5F_DRVINFOBLOCK_HDR_SIZE;
if(super_vers > HDF5_SUPERBLOCK_VERSION_1)
driver_size += H5F_DRVINFO_CHKSUM(1);
else
driver_size += H5F_DRVINFO_CHKSUM(0);
- }
+
+ /*
+ * The file driver information block begins immediately after the
+ * superblock.
+ */
+ f->shared->driver_addr = superblock_size;
+ } /* end if */
/*
* Allocate space for the userblock, superblock, driver info
@@ -538,28 +598,34 @@ H5F_init_superblock(const H5F_t *f, hid_t dxpl_id)
* allocation request is required to return memory at format
* address zero.
*/
-
H5_CHECK_OVERFLOW(f->shared->base_addr, haddr_t, hsize_t);
addr = H5FD_alloc(f->shared->lf, H5FD_MEM_SUPER, dxpl_id,
((hsize_t)f->shared->base_addr + superblock_size + driver_size));
-
- if (HADDR_UNDEF == addr)
- HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, UFAIL,
- "unable to allocate file space for userblock and/or superblock")
-
- if (0 != addr)
- HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, UFAIL,
- "file driver failed to allocate userblock and/or superblock at address zero")
-
- /*
- * The file driver information block begins immediately after the
- * superblock.
+ if(HADDR_UNDEF == addr)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to allocate file space for userblock and/or superblock")
+ if(0 != addr)
+ HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "file driver failed to allocate userblock and/or superblock at address zero")
+
+ /* Create the superblock extension for "extra" superblock data, if necessary.
+ * (Currently, the extension is only needed if Shared Object Header
+ * Messages are enabled)
*/
- if (driver_size > 0)
- f->shared->driver_addr = superblock_size;
+ if(f->shared->sohm_nindexes > 0) {
+ /* The superblock extension isn't actually a group, but the
+ * default group creation list should work fine.
+ * If we don't supply a size for the object header, HDF5 will
+ * allocate H5O_MIN_SIZE by default. This is currently
+ * big enough to hold the biggest possible extension, but should
+ * be tuned if more information is added to the superblock
+ * extension.
+ */
+ H5O_loc_reset(ext_loc);
+ if(H5O_create(f, dxpl_id, 0, H5P_GROUP_CREATE_DEFAULT, ext_loc) < 0)
+ HGOTO_ERROR(H5E_OHDR, H5E_CANTCREATE, FAIL, "unable to create superblock extension")
- /* Return the size of the super block+driver info block */
- ret_value=superblock_size+driver_size;
+ /* Record this address */
+ f->shared->extension_addr = ext_loc->addr;
+ } /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
@@ -594,7 +660,7 @@ H5F_write_superblock(H5F_t *f, hid_t dxpl_id)
size_t superblock_size; /* Size of superblock, in bytes */
size_t driver_size; /* Size of driver info block (bytes)*/
char driver_name[9]; /* Name of driver, for driver info block */
- unsigned super_vers; /* Super block version */
+ unsigned super_vers; /* Superblock version */
unsigned freespace_vers; /* Freespace info version */
unsigned obj_dir_vers; /* Object header info version */
unsigned share_head_vers; /* Shared header info version */
@@ -604,20 +670,20 @@ H5F_write_superblock(H5F_t *f, hid_t dxpl_id)
FUNC_ENTER_NOAPI(H5F_write_superblock, FAIL)
/* Get the shared file creation property list */
- if (NULL == (plist = H5I_object(f->shared->fcpl_id)))
+ if(NULL == (plist = H5I_object(f->shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list")
/* Grab values from property list */
- if (H5P_get(plist, H5F_CRT_SUPER_VERS_NAME, &super_vers) < 0)
- HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get super block version")
- if (H5P_get(plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers) < 0)
+ if(H5P_get(plist, H5F_CRT_SUPER_VERS_NAME, &super_vers) < 0)
+ HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get superblock version")
+ if(H5P_get(plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get free space version")
- if (H5P_get(plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers) < 0)
+ if(H5P_get(plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get object directory version")
- if (H5P_get(plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers) < 0)
+ if(H5P_get(plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get shared-header format version")
- /* Encode the file super block */
+ /* Encode the file superblock */
p = sbuf;
HDmemcpy(p, H5F_SIGNATURE, (size_t)H5F_SIGNATURE_LEN);
p += H5F_SIGNATURE_LEN;
@@ -641,27 +707,26 @@ H5F_write_superblock(H5F_t *f, hid_t dxpl_id)
* Versions of the superblock >0 have the indexed storage B-tree
* internal 'K' value stored
*/
- if (super_vers > HDF5_SUPERBLOCK_VERSION_DEF) {
+ if(super_vers > HDF5_SUPERBLOCK_VERSION_DEF) {
UINT16ENCODE(p, f->shared->btree_k[H5B_ISTORE_ID]);
- if (super_vers < HDF5_SUPERBLOCK_VERSION_2) {
+ if(super_vers < HDF5_SUPERBLOCK_VERSION_2) {
*p++ = 0; /*reserved */
*p++ = 0; /*reserved */
- }
- }
+ } /* end if */
+ } /* end if */
H5F_addr_encode(f, &p, f->shared->base_addr);
H5F_addr_encode(f, &p, f->shared->extension_addr);
-
H5F_addr_encode(f, &p, H5FD_get_eoa(f->shared->lf, H5FD_MEM_SUPER));
H5F_addr_encode(f, &p, f->shared->driver_addr);
if(H5G_obj_ent_encode(f, &p, H5G_oloc(f->shared->root_grp))<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to encode root group information")
- /* Compute super block checksum */
+ /* Compute superblock checksum */
if(super_vers >= HDF5_SUPERBLOCK_VERSION_2) {
chksum = H5_checksum_metadata(sbuf, H5F_SUPERBLOCK_SIZE(super_vers, f) - H5F_SIZEOF_CHKSUM, 0);
UINT32ENCODE(p, chksum);
- }
+ } /* end if */
/* Double check we didn't overrun the block (unlikely) */
H5_ASSIGN_OVERFLOW(superblock_size, p - sbuf, int, size_t);
@@ -671,23 +736,19 @@ H5F_write_superblock(H5F_t *f, hid_t dxpl_id)
HDassert(superblock_size == (H5F_SUPERBLOCK_SIZE(super_vers, f)));
/* Write superblock */
- if (H5FD_write(f->shared->lf, H5FD_MEM_SUPER, dxpl_id,
- f->shared->super_addr, superblock_size, sbuf) < 0)
+ if(H5FD_write(f->shared->lf, H5FD_MEM_SUPER, dxpl_id, f->shared->super_addr, superblock_size, sbuf) < 0)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "unable to write superblock")
-
/* Encode the driver information block. */
H5_ASSIGN_OVERFLOW(driver_size, H5FD_sb_size(f->shared->lf), hsize_t, size_t);
-
- if (driver_size > 0) {
+ if(driver_size > 0) {
unsigned driver_vers;
/* Use driver info block version 1 on superblock version >= 2 */
- if(super_vers > HDF5_SUPERBLOCK_VERSION_1) {
+ if(super_vers > HDF5_SUPERBLOCK_VERSION_1)
driver_vers = HDF5_DRIVERINFO_VERSION_1;
- } else {
+ else
driver_vers = HDF5_DRIVERINFO_VERSION_0;
- }
driver_size += H5F_DRVINFOBLOCK_HDR_SIZE + H5F_DRVINFO_CHKSUM(driver_vers);
@@ -706,7 +767,7 @@ H5F_write_superblock(H5F_t *f, hid_t dxpl_id)
UINT32ENCODE(p, driver_size - H5F_DRVINFOBLOCK_HDR_SIZE - H5F_DRVINFO_CHKSUM(driver_vers));
/* Encode driver-specific data */
- if (H5FD_sb_encode(f->shared->lf, driver_name, dbuf + H5F_DRVINFOBLOCK_HDR_SIZE) < 0)
+ if(H5FD_sb_encode(f->shared->lf, driver_name, dbuf + H5F_DRVINFOBLOCK_HDR_SIZE) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to encode driver information")
/* Driver name */
@@ -716,13 +777,13 @@ H5F_write_superblock(H5F_t *f, hid_t dxpl_id)
if(driver_vers > HDF5_DRIVERINFO_VERSION_0) {
chksum = H5_checksum_metadata(dbuf, (driver_size - H5F_SIZEOF_CHKSUM), 0);
UINT32ENCODE(p, chksum);
- }
+ } /* end if */
/* Write driver information block */
- if (H5FD_write(f->shared->lf, H5FD_MEM_SUPER, dxpl_id,
- f->shared->base_addr + f->shared->driver_addr, driver_size, dbuf) < 0)
+ if(H5FD_write(f->shared->lf, H5FD_MEM_SUPER, dxpl_id, f->shared->base_addr + f->shared->driver_addr, driver_size, dbuf) < 0)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "unable to write driver information block")
} /* end if */
+
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_write_superblock() */