Merge branch 'develop' of https://bitbucket.hdfgroup.org/scm/hdffv/hdf5 into merge_func_enter_vol

Plus initial steps toward merging API context push into FUNC_ENTER_API* macros

1 files changed, 157 insertions, 99 deletions

diff --git a/src/H5Ofill.c b/src/H5Ofill.c
index 445a655..932241f 100644
--- a/src/H5Ofill.c
+++ b/src/H5Ofill.c
@@ -21,28 +21,30 @@
 #include "H5Omodule.h"          /* This source code file is part of the H5O module */
 
 
-#include "H5private.h"		/* Generic Functions			*/
-#include "H5Dprivate.h"		/* Datasets				*/
-#include "H5Eprivate.h"		/* Error handling		  	*/
-#include "H5FLprivate.h"	/* Free Lists				*/
-#include "H5Iprivate.h"		/* IDs			  		*/
-#include "H5MMprivate.h"	/* Memory management			*/
-#include "H5Opkg.h"             /* Object headers			*/
-#include "H5Pprivate.h"		/* Property lists			*/
-#include "H5Sprivate.h"		/* Dataspaces				*/
+#include "H5private.h"      /* Generic Functions    */
+#include "H5Dprivate.h"     /* Datasets	            */
+#include "H5Eprivate.h"     /* Error handling       */
+#include "H5FLprivate.h"    /* Free Lists           */
+#include "H5Iprivate.h"     /* IDs                  */
+#include "H5MMprivate.h"    /* Memory management    */
+#include "H5Opkg.h"         /* Object headers       */
+#include "H5Pprivate.h"     /* Property lists       */
+#include "H5Sprivate.h"     /* Dataspaces           */
 
 
 static void  *H5O_fill_old_decode(H5F_t *f, H5O_t *open_oh, unsigned mesg_flags,
-    unsigned *ioflags, const uint8_t *p);
+    unsigned *ioflags, size_t p_size, const uint8_t *p);
 static herr_t H5O_fill_old_encode(H5F_t *f, uint8_t *p, const void *_mesg);
 static size_t H5O_fill_old_size(const H5F_t *f, const void *_mesg);
 static void  *H5O_fill_new_decode(H5F_t *f, H5O_t *open_oh, unsigned mesg_flags,
-    unsigned *ioflags, const uint8_t *p);
+    unsigned *ioflags, size_t p_size, const uint8_t *p);
 static herr_t H5O_fill_new_encode(H5F_t *f, uint8_t *p, const void *_mesg);
 static size_t H5O_fill_new_size(const H5F_t *f, const void *_mesg);
 static void  *H5O_fill_copy(const void *_mesg, void *_dest);
 static herr_t H5O__fill_reset(void *_mesg);
 static herr_t H5O__fill_free(void *_mesg);
+static herr_t H5O__fill_pre_copy_file(H5F_t *file_src, const void *mesg_src,
+    hbool_t *deleted, const H5O_copy_t *cpy_info, void *udata);
 static herr_t H5O__fill_debug(H5F_t *f, const void *_mesg, FILE *stream,
     int indent, int fwidth);
 
@@ -105,52 +107,59 @@ static herr_t H5O__fill_debug(H5F_t *f, const void *_mesg, FILE *stream,
 
 /* This message derives from H5O message class, for old fill value before version 1.5 */
 const H5O_msg_class_t H5O_MSG_FILL[1] = {{
-    H5O_FILL_ID,                /*message id number                     */
-    "fill",                     /*message name for debugging            */
-    sizeof(H5O_fill_t),		/*native message size                   */
-    H5O_SHARE_IS_SHARABLE|H5O_SHARE_IN_OHDR,	/* messages are sharable?       */
-    H5O_fill_shared_decode,	/*decode message                        */
-    H5O_fill_shared_encode,	/*encode message                        */
-    H5O_fill_copy,		/*copy the native value                 */
-    H5O_fill_shared_size,	/*raw message size			*/
-    H5O__fill_reset,		/*free internal memory			*/
-    H5O__fill_free,		/* free method				*/
-    H5O__fill_shared_delete,	/* file delete method			*/
-    H5O__fill_shared_link,	/* link method				*/
-    NULL,			/* set share method			*/
-    NULL,		    	/*can share method		*/
-    NULL,			/* pre copy native value to file	*/
-    H5O__fill_shared_copy_file,	/* copy native value to file		*/
-    H5O_fill_shared_post_copy_file,	/* post copy native value to file	*/
-    NULL,			/* get creation index		*/
-    NULL,			/* set creation index		*/
-    H5O_fill_shared_debug       /*debug the message			*/
+    H5O_FILL_ID,                /*message id number                         */
+    "fill",                     /*message name for debugging                */
+    sizeof(H5O_fill_t),         /*native message size                       */
+    H5O_SHARE_IS_SHARABLE|H5O_SHARE_IN_OHDR,    /* messages are sharable?   */
+    H5O_fill_shared_decode,     /*decode message                            */
+    H5O_fill_shared_encode,     /*encode message                            */
+    H5O_fill_copy,              /*copy the native value                     */
+    H5O_fill_shared_size,       /*raw message size                          */
+    H5O__fill_reset,            /*free internal memory                      */
+    H5O__fill_free,             /* free method                              */
+    H5O__fill_shared_delete,    /* file delete method                       */
+    H5O__fill_shared_link,      /* link method                              */
+    NULL,                       /* set share method                         */
+    NULL,                       /*can share method                          */
+    H5O__fill_pre_copy_file,    /* pre copy native value to file            */
+    H5O__fill_shared_copy_file, /* copy native value to file                */
+    H5O_fill_shared_post_copy_file, /* post copy native value to file       */
+    NULL,                       /* get creation index                       */
+    NULL,                       /* set creation index                       */
+    H5O_fill_shared_debug       /*debug the message                         */
 }};
 
 /* This message derives from H5O message class, for new fill value after version 1.4  */
 const H5O_msg_class_t H5O_MSG_FILL_NEW[1] = {{
-    H5O_FILL_NEW_ID,		/*message id number			*/
-    "fill_new", 		/*message name for debugging		*/
-    sizeof(H5O_fill_t),		/*native message size			*/
-    H5O_SHARE_IS_SHARABLE|H5O_SHARE_IN_OHDR,	/* messages are sharable?       */
-    H5O_fill_new_shared_decode,	/*decode message			*/
-    H5O_fill_new_shared_encode,	/*encode message			*/
-    H5O_fill_copy,		/*copy the native value			*/
-    H5O_fill_new_shared_size,	/*raw message size			*/
-    H5O__fill_reset,		/*free internal memory			*/
-    H5O__fill_free,		/* free method				*/
-    H5O__fill_new_shared_delete,/* file delete method			*/
-    H5O__fill_new_shared_link,	/* link method				*/
-    NULL,			/* set share method			*/
-    NULL,		    	/*can share method		*/
-    NULL,			/* pre copy native value to file	*/
-    H5O__fill_new_shared_copy_file, /* copy native value to file		*/
-    H5O_fill_new_shared_post_copy_file,	/* post copy native value to file	*/
-    NULL,			/* get creation index		*/
-    NULL,			/* set creation index		*/
-    H5O_fill_new_shared_debug	/*debug the message			*/
+    H5O_FILL_NEW_ID,                    /*message id number                 */
+    "fill_new",                         /*message name for debugging        */
+    sizeof(H5O_fill_t),                 /*native message size               */
+    H5O_SHARE_IS_SHARABLE|H5O_SHARE_IN_OHDR,    /* messages are sharable?   */
+    H5O_fill_new_shared_decode,         /*decode message                    */
+    H5O_fill_new_shared_encode,         /*encode message                    */
+    H5O_fill_copy,                      /*copy the native value             */
+    H5O_fill_new_shared_size,           /*raw message size                  */
+    H5O__fill_reset,                    /*free internal memory              */
+    H5O__fill_free,                     /* free method                      */
+    H5O__fill_new_shared_delete,        /* file delete method               */
+    H5O__fill_new_shared_link,          /* link method                      */
+    NULL,                               /* set share method                 */
+    NULL,                               /*can share method                  */
+    H5O__fill_pre_copy_file,            /* pre copy native value to file    */
+    H5O__fill_new_shared_copy_file,      /* copy native value to file        */
+    H5O_fill_new_shared_post_copy_file, /* post copy native value to file   */
+    NULL,                               /* get creation index               */
+    NULL,                               /* set creation index               */
+    H5O_fill_new_shared_debug           /*debug the message	                */
 }};
 
+/* Format version bounds for fill value */
+const unsigned H5O_fill_ver_bounds[] = {
+    H5O_FILL_VERSION_1,     /* H5F_LIBVER_EARLIEST */
+    H5O_FILL_VERSION_2,     /* H5F_LIBVER_V18 */
+    H5O_FILL_VERSION_LATEST /* H5F_LIBVER_LATEST */
+};
+
 /* Masks, shift values & flags for fill value message */
 #define H5O_FILL_MASK_ALLOC_TIME        0x03
 #define H5O_FILL_SHIFT_ALLOC_TIME       0
@@ -171,11 +180,11 @@ H5FL_BLK_EXTERN(type_conv);
  * Function:	H5O_fill_new_decode
  *
  * Purpose:	Decode a new fill value message.  The new fill value
- * 		message is fill value plus space allocation time and
- * 		fill value writing time and whether fill value is defined.
+ *          message is fill value plus space allocation time and
+ *          fill value writing time and whether fill value is defined.
  *
- * Return:	Success:	Ptr to new message in native struct.
- *		Failure:	NULL
+ * Return:	Success:    Ptr to new message in native struct.
+ *          Failure:    NULL
  *
  * Programmer:  Raymond Lu
  *              Feb 26, 2002
@@ -184,7 +193,8 @@ H5FL_BLK_EXTERN(type_conv);
  */
 static void *
 H5O_fill_new_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, const uint8_t *p)
+    unsigned H5_ATTR_UNUSED mesg_flags, unsigned H5_ATTR_UNUSED *ioflags,
+    size_t H5_ATTR_UNUSED p_size, const uint8_t *p)
 {
     H5O_fill_t	*fill = NULL;
     void *ret_value = NULL;     /* Return value */
@@ -195,7 +205,7 @@ H5O_fill_new_decode(H5F_t H5_ATTR_UNUSED *f, H5O_t H5_ATTR_UNUSED *open_oh,
     HDassert(p);
 
     if(NULL == (fill = H5FL_CALLOC(H5O_fill_t)))
-	HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for fill value message")
+        HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for fill value message")
 
     /* Version */
     fill->version = *p++;
@@ -276,7 +286,7 @@ done:
     if(!ret_value && fill) {
         if(fill->buf)
             H5MM_xfree(fill->buf);
-	fill = H5FL_FREE(H5O_fill_t, fill);
+        fill = H5FL_FREE(H5O_fill_t, fill);
     } /* end if */
 
     FUNC_LEAVE_NOAPI(ret_value)
@@ -298,7 +308,8 @@ done:
  */
 static void *
 H5O_fill_old_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, const uint8_t *p)
+    unsigned H5_ATTR_UNUSED mesg_flags, unsigned H5_ATTR_UNUSED *ioflags,
+    size_t H5_ATTR_UNUSED p_size, const uint8_t *p)
 {
     H5O_fill_t *fill = NULL;	/* Decoded fill value message */
     void *ret_value = NULL;     /* Return value */
@@ -336,7 +347,7 @@ done:
     if(!ret_value && fill) {
         if(fill->buf)
             H5MM_xfree(fill->buf);
-	fill = H5FL_FREE(H5O_fill_t, fill);
+        fill = H5FL_FREE(H5O_fill_t, fill);
     } /* end if */
 
     FUNC_LEAVE_NOAPI(ret_value)
@@ -347,8 +358,8 @@ done:
  * Function:	H5O_fill_new_encode
  *
  * Purpose:	Encode a new fill value message.  The new fill value
- *              message is fill value plus space allocation time and
- *              fill value writing time and whether fill value is defined.
+ *          message is fill value plus space allocation time and
+ *          fill value writing time and whether fill value is defined.
  *
  * Return:	Non-negative on success/Negative on failure
  *
@@ -481,7 +492,7 @@ H5O_fill_old_encode(H5F_t H5_ATTR_UNUSED *f, uint8_t *p, const void *_fill)
  *		whether fill value is defined.
  *
  * Return:	Success:	Ptr to _DEST
- *		Failure:	NULL
+ *		    Failure:	NULL
  *
  * Programmer:  Raymond Lu
  *              Feb 26, 2002
@@ -491,16 +502,16 @@ H5O_fill_old_encode(H5F_t H5_ATTR_UNUSED *f, uint8_t *p, const void *_fill)
 static void *
 H5O_fill_copy(const void *_src, void *_dst)
 {
-    const H5O_fill_t	*src = (const H5O_fill_t *)_src;
-    H5O_fill_t		*dst = (H5O_fill_t *)_dst;
-    void		*ret_value = NULL;      /* Return value */
+    const H5O_fill_t    *src = (const H5O_fill_t *)_src;
+    H5O_fill_t          *dst = (H5O_fill_t *)_dst;
+    void                *ret_value = NULL;      /* Return value */
 
     FUNC_ENTER_NOAPI_NOINIT
 
     HDassert(src);
 
     if(!dst && NULL == (dst = H5FL_MALLOC(H5O_fill_t)))
-	HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for fill message")
+        HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for fill message")
 
     /* Shallow copy basic fields */
     *dst = *src;
@@ -516,9 +527,9 @@ H5O_fill_copy(const void *_src, void *_dst)
     /* Copy fill value and its size */
     if(src->buf) {
         H5_CHECK_OVERFLOW(src->size, ssize_t, size_t);
-	if(NULL == (dst->buf = H5MM_malloc((size_t)src->size)))
-	    HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for fill value")
-	HDmemcpy(dst->buf, src->buf, (size_t)src->size);
+        if(NULL == (dst->buf = H5MM_malloc((size_t)src->size)))
+            HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for fill value")
+        HDmemcpy(dst->buf, src->buf, (size_t)src->size);
 
         /* Check for needing to convert/copy fill value */
         if(src->type) {
@@ -579,9 +590,9 @@ done:
     if(!ret_value && dst) {
         if(dst->buf)
             H5MM_xfree(dst->buf);
-	if(dst->type)
+        if(dst->type)
             (void)H5T_close_real(dst->type);
-	if(!_dst)
+        if(!_dst)
             dst = H5FL_FREE(H5O_fill_t, dst);
     } /* end if */
 
@@ -593,13 +604,13 @@ done:
  * Function:	H5O_fill_new_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.  The new fill
- *		value message is fill value plus space allocation time and
- *              fill value writing time and whether fill value is defined.
+ *          message type or size fields, but only the data fields.  This
+ *          function doesn't take into account alignment.  The new fill
+ *          value message is fill value plus space allocation time and
+ *          fill value writing time and whether fill value is defined.
  *
  * Return:	Success:	Message data size in bytes w/o alignment.
- *		Failure:	0
+ *          Failure:	0
  *
  * Programmer:  Raymond Lu
  *              Feb 26, 2002
@@ -609,8 +620,8 @@ done:
 static size_t
 H5O_fill_new_size(const H5F_t H5_ATTR_UNUSED *f, const void *_fill)
 {
-    const H5O_fill_t	*fill = (const H5O_fill_t *)_fill;
-    size_t		ret_value = 0;          /* Return value */
+    const H5O_fill_t    *fill = (const H5O_fill_t *)_fill;
+    size_t              ret_value = 0;          /* Return value */
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
@@ -792,6 +803,42 @@ H5O__fill_free(void *fill)
 
 
 /*-------------------------------------------------------------------------
+ * Function:    H5O__fill_pre_copy_file
+ *
+ * Purpose:     Perform any necessary actions before copying message between
+ *              files.
+ *
+ * Return:      Success:        Non-negative
+ *              Failure:        Negative
+ *
+ * Programmer:  Vailin Choi; Dec 2017
+ *
+ *-------------------------------------------------------------------------
+ */
+static herr_t
+H5O__fill_pre_copy_file(H5F_t H5_ATTR_UNUSED *file_src, const void *mesg_src,
+    hbool_t H5_ATTR_UNUSED *deleted, const H5O_copy_t *cpy_info, void H5_ATTR_UNUSED *udata)
+{
+    const H5O_fill_t	*fill_src = (const H5O_fill_t *)mesg_src;   /* Source fill value */
+    herr_t ret_value = SUCCEED;   /* Return value */
+
+    FUNC_ENTER_STATIC
+
+    /* check args */
+    HDassert(cpy_info);
+    HDassert(cpy_info->file_dst);
+
+    /* Check to ensure that the version of the message to be copied does not exceed
+       the message version allowed by the destination file's high bound */
+    if(fill_src->version > H5O_fill_ver_bounds[H5F_HIGH_BOUND(cpy_info->file_dst)])
+        HGOTO_ERROR(H5E_OHDR, H5E_BADRANGE, FAIL, "fill value message version out of bounds")
+
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5O__fill_pre_copy_file() */
+
+
+/*-------------------------------------------------------------------------
  * Function:	H5O__fill_debug
  *
  * Purpose:	Prints debugging info for the message.
@@ -883,11 +930,11 @@ H5O__fill_debug(H5F_t H5_ATTR_UNUSED *f, const void *_fill, FILE *stream,
 	      "Size:", fill->size);
     HDfprintf(stream, "%*s%-*s ", indent, "", fwidth, "Data type:");
     if(fill->type) {
-	H5T_debug(fill->type, stream);
-	fprintf(stream, "\n");
+        H5T_debug(fill->type, stream);
+        HDfprintf(stream, "\n");
     } /* end if */
     else
-	fprintf(stream, "<dataset type>\n");
+        HDfprintf(stream, "<dataset type>\n");
 
     FUNC_LEAVE_NOAPI(SUCCEED)
 } /* end H5O__fill_debug() */
@@ -897,9 +944,9 @@ H5O__fill_debug(H5F_t H5_ATTR_UNUSED *f, const void *_fill, FILE *stream,
  * Function:	H5O_fill_convert
  *
  * Purpose:	Convert a fill value from whatever data type it currently has
- *		to the specified dataset type.  The `type' field of the fill
- *		value struct will be set to NULL to indicate that it has the
- *		same type as the dataset.
+ *          to the specified dataset type.  The `type' field of the fill
+ *          value struct will be set to NULL to indicate that it has the
+ *          same type as the dataset.
  *
  * Return:	Non-negative on success/Negative on failure
  *
@@ -925,14 +972,14 @@ H5O_fill_convert(H5O_fill_t *fill, H5T_t *dset_type, hbool_t *fill_changed)
     /* No-op cases */
     if(!fill->buf || !fill->type || 0 == H5T_cmp(fill->type, dset_type, FALSE)) {
         /* Don't need datatype for fill value */
-	if(fill->type)
+        if(fill->type)
             (void)H5T_close_real(fill->type);
-	fill->type = NULL;
+        fill->type = NULL;
 
         /* Note that the fill value info has changed */
         *fill_changed = TRUE;
 
-	HGOTO_DONE(SUCCEED);
+        HGOTO_DONE(SUCCEED);
     } /* end if */
 
     /*
@@ -997,28 +1044,39 @@ done:
 
 
 /*-------------------------------------------------------------------------
- * Function:    H5O_fill_set_latest_version
+ * Function:    H5O_fill_set_version
  *
- * Purpose:     Set the encoding for a fill value to the latest version.
+ * Purpose:     Set the version to encode a fill value with.
  *
- * Return:	Non-negative on success/Negative on failure
+ * Return:      Non-negative on success/Negative on failure
  *
- * Programmer:  Quincey Koziol
- *              Tuesday, July 24, 2007
+ * Programmer:  Vailin Choi; December 2017
  *
  *-------------------------------------------------------------------------
  */
 herr_t
-H5O_fill_set_latest_version(H5O_fill_t *fill)
+H5O_fill_set_version(H5F_t *f, H5O_fill_t *fill)
 {
-    FUNC_ENTER_NOAPI_NOINIT_NOERR
+    unsigned version;           /* Message version */
+    herr_t ret_value = SUCCEED; /* Return value */
+
+    FUNC_ENTER_NOAPI(FAIL)
 
     /* Sanity check */
+    HDassert(f);
     HDassert(fill);
 
-    /* Set encoding of fill value to latest version */
-    fill->version = H5O_FILL_VERSION_LATEST;
+    /* Upgrade to the version indicated by the file's low bound if higher */
+    version = MAX(fill->version, H5O_fill_ver_bounds[H5F_LOW_BOUND(f)]);
 
-    FUNC_LEAVE_NOAPI(SUCCEED)
-} /* end H5O_fill_set_latest_version() */
+    /* Version bounds check */
+    if(version > H5O_fill_ver_bounds[H5F_HIGH_BOUND(f)])
+        HGOTO_ERROR(H5E_OHDR, H5E_BADRANGE, FAIL, "Filter pipeline version out of bounds")
+
+    /* Set the message version */
+    fill->version = version;
+
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5O_fill_set_version() */