[svn-r12615] Description:

    Add checksum to v2 B-tree metadata.

Tested On:
    Linux/32 2.6 (chicago)
    Linux/64 2.6 (chicago2)

3 files changed, 81 insertions, 16 deletions

diff --git a/src/H5B2cache.c b/src/H5B2cache.c
index 1a531ce..ee359aa 100644
--- a/src/H5B2cache.c
+++ b/src/H5B2cache.c
@@ -145,6 +145,8 @@ H5B2_cache_hdr_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_type, vo
     unsigned split_percent, merge_percent;      /* Split & merge info for B-tree */
     H5B2_t		*bt2 = NULL;    /* B-tree info */
     size_t		size;           /* Header size */
+    uint32_t            stored_chksum;  /* Stored metadata checksum value */
+    uint32_t            computed_chksum; /* Computed metadata checksum value */
     uint8_t		*buf = NULL;    /* Temporary buffer */
     uint8_t		*p;             /* Pointer into raw data buffer */
     H5B2_t		*ret_value;     /* Return value */
@@ -183,8 +185,6 @@ H5B2_cache_hdr_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_type, vo
     if(*p++ != H5B2_HDR_VERSION)
 	HGOTO_ERROR(H5E_BTREE, H5E_CANTLOAD, NULL, "wrong B-tree header version")
 
-/* XXX: Add metadata flags & checksum to v2 B-tree metadata (like fractal heap) */
-
     /* B-tree type */
     if(*p++ != (uint8_t)type->id)
 	HGOTO_ERROR(H5E_BTREE, H5E_CANTLOAD, NULL, "incorrect B-tree type")
@@ -207,8 +207,20 @@ H5B2_cache_hdr_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_type, vo
     UINT16DECODE(p, bt2->root.node_nrec);
     H5F_DECODE_LENGTH(f, p, bt2->root.all_nrec);
 
-    /* Initialize shared B-tree info */
+    /* Metadata checksum */
+    UINT32DECODE(p, stored_chksum);
+
+    /* Sanity check */
     HDassert((size_t)(p - buf) == size);
+
+    /* Compute checksum on entire header */
+    computed_chksum = H5_checksum_metadata(buf, (size - H5B2_SIZEOF_CHKSUM));
+
+    /* Verify checksum */
+    if(stored_chksum != computed_chksum)
+	HGOTO_ERROR(H5E_BTREE, H5E_BADVALUE, NULL, "incorrect metadata checksum for v2 B-tree header")
+
+    /* Initialize shared B-tree info */
     if(H5B2_shared_init(f, bt2, type, node_size, rrec_size, split_percent, merge_percent) < 0)
 	HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "can't create shared B-tree info")
 
@@ -255,6 +267,7 @@ H5B2_cache_hdr_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr, H5B
         uint8_t	*buf;           /* Temporary raw data buffer */
         uint8_t *p;             /* Pointer into raw data buffer */
         size_t	size;           /* Header size on disk */
+        uint32_t metadata_chksum; /* Computed metadata checksum value */
 
         /* Get the pointer to the shared B-tree info */
         shared = H5RC_GET_OBJ(bt2->shared);
@@ -297,6 +310,12 @@ H5B2_cache_hdr_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr, H5B
         UINT16ENCODE(p, bt2->root.node_nrec);
         H5F_ENCODE_LENGTH(f, p, bt2->root.all_nrec);
 
+        /* Compute metadata checksum */
+        metadata_chksum = H5_checksum_metadata(buf, (size - H5B2_SIZEOF_CHKSUM));
+
+        /* Metadata checksum */
+        UINT32ENCODE(p, metadata_chksum);
+
 	/* Write the B-tree header. */
         HDassert((size_t)(p - buf) == size);
 	if(H5F_block_write(f, H5FD_MEM_BTREE, addr, size, dxpl_id, buf) < 0)
@@ -444,6 +463,8 @@ H5B2_cache_internal_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nre
     uint8_t		*p;             /* Pointer into raw data buffer */
     uint8_t		*native;        /* Pointer to native record info */
     H5B2_node_ptr_t	*int_node_ptr;  /* Pointer to node pointer info */
+    uint32_t            stored_chksum;  /* Stored metadata checksum value */
+    uint32_t            computed_chksum; /* Computed metadata checksum value */
     unsigned		u;              /* Local index variable */
     H5B2_internal_t	*ret_value;     /* Return value */
 
@@ -481,8 +502,6 @@ H5B2_cache_internal_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nre
     if(*p++ != H5B2_INT_VERSION)
 	HGOTO_ERROR(H5E_BTREE, H5E_CANTLOAD, NULL, "wrong B-tree internal node version")
 
-/* XXX: Add metadata flags & checksum to v2 B-tree metadata (like fractal heap) */
-
     /* B-tree type */
     if (*p++ != (uint8_t)shared->type->id)
 	HGOTO_ERROR(H5E_BTREE, H5E_CANTLOAD, NULL, "incorrect B-tree type")
@@ -503,7 +522,7 @@ H5B2_cache_internal_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nre
     for(u = 0; u < internal->nrec; u++) {
         /* Decode record */
         if((shared->type->decode)(f, p, native) < 0)
-            HGOTO_ERROR(H5E_BTREE, H5E_CANTENCODE, NULL, "unable to decode B-tree record")
+            HGOTO_ERROR(H5E_BTREE, H5E_CANTDECODE, NULL, "unable to decode B-tree record")
 
         /* Move to next record */
         p += shared->rrec_size;
@@ -522,9 +541,19 @@ H5B2_cache_internal_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nre
         int_node_ptr++;
     } /* end for */
 
+    /* Compute checksum on internal node */
+    computed_chksum = H5_checksum_metadata(shared->page, (size_t)(p - shared->page));
+
+    /* Metadata checksum */
+    UINT32DECODE(p, stored_chksum);
+
     /* Sanity check parsing */
     HDassert((size_t)(p - shared->page) <= shared->node_size);
 
+    /* Verify checksum */
+    if(stored_chksum != computed_chksum)
+	HGOTO_ERROR(H5E_BTREE, H5E_BADVALUE, NULL, "incorrect metadata checksum for v2 internal node")
+
     /* Set return value */
     ret_value = internal;
 
@@ -565,6 +594,7 @@ H5B2_cache_internal_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr
         uint8_t *p;             /* Pointer into raw data buffer */
         uint8_t *native;        /* Pointer to native record info */
         H5B2_node_ptr_t *int_node_ptr;      /* Pointer to node pointer info */
+        uint32_t metadata_chksum; /* Computed metadata checksum value */
         unsigned u;             /* Local index variable */
 
         /* Get the pointer to the shared B-tree info */
@@ -607,6 +637,12 @@ H5B2_cache_internal_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr
             int_node_ptr++;
         } /* end for */
 
+        /* Compute metadata checksum */
+        metadata_chksum = H5_checksum_metadata(shared->page, (size_t)(p - shared->page));
+
+        /* Metadata checksum */
+        UINT32ENCODE(p, metadata_chksum);
+
 	/* Write the B-tree internal node */
         HDassert((size_t)(p - shared->page) <= shared->node_size);
 	if(H5F_block_write(f, H5FD_MEM_BTREE, addr, shared->node_size, dxpl_id, shared->page) < 0)
@@ -771,6 +807,8 @@ H5B2_cache_leaf_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nrec, v
     H5B2_leaf_t		*leaf = NULL;   /* Pointer to lead node loaded */
     uint8_t		*p;             /* Pointer into raw data buffer */
     uint8_t		*native;        /* Pointer to native keys */
+    uint32_t            stored_chksum;  /* Stored metadata checksum value */
+    uint32_t            computed_chksum; /* Computed metadata checksum value */
     unsigned		u;              /* Local index variable */
     H5B2_leaf_t		*ret_value;     /* Return value */
 
@@ -808,8 +846,6 @@ H5B2_cache_leaf_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nrec, v
     if(*p++ != H5B2_LEAF_VERSION)
 	HGOTO_ERROR(H5E_BTREE, H5E_CANTLOAD, NULL, "wrong B-tree leaf node version")
 
-/* XXX: Add metadata flags & checksum to v2 B-tree metadata (like fractal heap) */
-
     /* B-tree type */
     if(*p++ != (uint8_t)shared->type->id)
 	HGOTO_ERROR(H5E_BTREE, H5E_CANTLOAD, NULL, "incorrect B-tree type")
@@ -833,9 +869,19 @@ H5B2_cache_leaf_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *_nrec, v
         native += shared->type->nrec_size;
     } /* end for */
 
+    /* Compute checksum on internal node */
+    computed_chksum = H5_checksum_metadata(shared->page, (size_t)(p - shared->page));
+
+    /* Metadata checksum */
+    UINT32DECODE(p, stored_chksum);
+
     /* Sanity check parsing */
     HDassert((size_t)(p - shared->page) <= shared->node_size);
 
+    /* Verify checksum */
+    if(stored_chksum != computed_chksum)
+	HGOTO_ERROR(H5E_BTREE, H5E_BADVALUE, NULL, "incorrect metadata checksum for v2 leaf node")
+
     /* Set return value */
     ret_value = leaf;
 
@@ -875,6 +921,7 @@ H5B2_cache_leaf_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr, H5
         H5B2_shared_t *shared;  /* Shared B-tree information */
         uint8_t *p;             /* Pointer into raw data buffer */
         uint8_t *native;        /* Pointer to native keys */
+        uint32_t metadata_chksum; /* Computed metadata checksum value */
         unsigned u;             /* Local index variable */
 
         /* Get the pointer to the shared B-tree info */
@@ -905,6 +952,12 @@ H5B2_cache_leaf_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr, H5
             native += shared->type->nrec_size;
         } /* end for */
 
+        /* Compute metadata checksum */
+        metadata_chksum = H5_checksum_metadata(shared->page, (size_t)(p - shared->page));
+
+        /* Metadata checksum */
+        UINT32ENCODE(p, metadata_chksum);
+
 	/* Write the B-tree leaf node */
         HDassert((size_t)(p - shared->page) <= shared->node_size);
 	if(H5F_block_write(f, H5FD_MEM_BTREE, addr, shared->node_size, dxpl_id, shared->page) < 0)
diff --git a/src/H5B2int.c b/src/H5B2int.c
index 16e87a6..98e9f3b 100644
--- a/src/H5B2int.c
+++ b/src/H5B2int.c
@@ -41,14 +41,13 @@
 /* Local Macros */
 /****************/
 
-/* Format overhead for each node (on disk) */
-#define H5B2_OVERHEAD_SIZE              (H5B2_SIZEOF_MAGIC+1)   /* Signature + version # */
-
 /* Number of records that fit into internal node */
-#define H5B2_NUM_INT_REC(f,n,r)         (((n)-(H5B2_OVERHEAD_SIZE+H5B2_NODE_POINTER_SIZE(f)))/((r)+H5B2_NODE_POINTER_SIZE(f)))
+#define H5B2_NUM_INT_REC(f, n, r) \
+    (((n) - (H5B2_METADATA_PREFIX_SIZE + H5B2_NODE_POINTER_SIZE(f))) / ((r) + H5B2_NODE_POINTER_SIZE(f)))
 
 /* Number of records that fit into leaf node */
-#define H5B2_NUM_LEAF_REC(n,r)          (((n)-H5B2_OVERHEAD_SIZE)/(r))
+#define H5B2_NUM_LEAF_REC(n, r) \
+    (((n) - H5B2_METADATA_PREFIX_SIZE) / (r))
 
 /* Uncomment this macro to enable extra sanity checking */
 /* #define H5B2_DEBUG */
diff --git a/src/H5B2pkg.h b/src/H5B2pkg.h
index 5a27494..1ab7129 100644
--- a/src/H5B2pkg.h
+++ b/src/H5B2pkg.h
@@ -53,17 +53,30 @@
 /* Size of a "node pointer" (on disk) */
 #define H5B2_NODE_POINTER_SIZE(f)       (H5F_SIZEOF_ADDR(f)+H5B2_SIZEOF_RECORDS_PER_NODE+H5F_SIZEOF_SIZE(f))
 
+/* Size of checksum information (on disk) */
+#define H5B2_SIZEOF_CHKSUM      4
+
+/* Format overhead for all v2 B-tree metadata in the file */
+#define H5B2_METADATA_PREFIX_SIZE (                                           \
+    H5B2_SIZEOF_MAGIC   /* Signature */                                       \
+    + 1 /* Version */                                                         \
+    + H5B2_SIZEOF_CHKSUM /* Metadata checksum */                              \
+    )
+
 /* Size of the B-tree header on disk */
 #define H5B2_HEADER_SIZE(f)     (                                             \
-    4   /* Signature */                                                       \
-    + 1 /* Version */                                                         \
+    /* General metadata fields */                                             \
+    H5B2_METADATA_PREFIX_SIZE                                                 \
+                                                                              \
+    /* Header specific fields */                                              \
     + 1 /* Tree type */                                                       \
     + 4 /* Node size, in bytes */                                             \
     + 2 /* Key size, in bytes */                                              \
     + 2 /* Depth of tree */                                                   \
     + 2 /* Split % of full (as integer, ie. "98" means 98%) */                \
     + 2 /* Merge % of full (as integer, ie. "98" means 98%) */                \
-    + H5B2_NODE_POINTER_SIZE(f))  /* Node pointer to root node in tree */
+    + H5B2_NODE_POINTER_SIZE(f)  /* Node pointer to root node in tree */      \
+    )
 
 /* Macro to retrieve pointer to i'th native record for native record buffer */
 #define H5B2_NAT_NREC(b,shared,idx)  (b+(shared)->nat_off[(idx)])