[svn-r26655] Purpose: Fixed HDFFV-7947

Description:
    When copy constructor or constructor that takes an existing id is invoked,
    the C ref counter stays the same but there is an extra C++ object which
    later is destroyed and may cause the HDF5 id to be closed prematurely. The
    C++ library needs to increment the ref counter in these situations, so that
    the C library will not close the id when it is still being referenced.

    However, the incrementing of ref count left some objects opened at the end
    of the program, perhaps, due to compiler's optimization on cons/destructors.    The constructor, that takes an existing id, needs to increment the counter
    but it seems that the matching destructor wasn't invoked.  The workaround
    is to have a function for each class that has "id" that only sets the id
    and not increment the ref count for the library to use in these situations.
    These functions are "friend" and not public.

    The friend functions are:
        void f_Attribute_setId(Attribute *, hid_t)
        void f_DataSet_setId(DataSet *, hid_t)
        void f_DataSpace_setId(DataSpace *, hid_t)
        void f_DataType_setId(DataType *, hid_t)
Platforms tested:
    Linux/64 (platypus)
    Linux/32 2.6 (jam gnu and Intel 15.0)
    SunOS 5.11 (emu)

1 files changed, 60 insertions, 15 deletions

diff --git a/c++/src/H5CommonFG.cpp b/c++/src/H5CommonFG.cpp
index 1ef36eb..1547a5b 100644
--- a/c++/src/H5CommonFG.cpp
+++ b/c++/src/H5CommonFG.cpp
@@ -14,6 +14,7 @@
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 #include <string>
+#include <iostream>
 
 #include "H5Include.h"
 #include "H5Exception.h"
@@ -33,9 +34,6 @@
 #include "H5Alltypes.h"
 #include "H5private.h"		// for HDstrcpy
 
-#include <iostream>
-using namespace std;
-
 // There are a few comments that are common to most of the functions
 // defined in this file so they are listed here.
 // - getLocId is called by all functions, that call a C API, to get
@@ -51,6 +49,7 @@ using namespace std;
 
 #ifndef H5_NO_NAMESPACE
 namespace H5 {
+using namespace std;
 #endif
 
 //--------------------------------------------------------------------------
@@ -100,7 +99,9 @@ Group CommonFG::createGroup( const char* name, size_t size_hint ) const
       throwException("createGroup", "H5Gcreate2 failed");
 
    // No failure, create and return the Group object
-   Group group( group_id );
+   Group group;
+    CommonFG *ptr = &group;
+    ptr->p_setId(group_id);
    return( group );
 }
 
@@ -136,7 +137,9 @@ Group CommonFG::openGroup( const char* name ) const
       throwException("openGroup", "H5Gopen2 failed");
 
    // No failure, create and return the Group object
-   Group group( group_id );
+   Group group;
+    CommonFG *ptr = &group;
+    ptr->p_setId(group_id);
    return( group );
 }
 
@@ -178,7 +181,8 @@ DataSet CommonFG::createDataSet( const char* name, const DataType& data_type, co
       throwException("createDataSet", "H5Dcreate2 failed");
 
    // No failure, create and return the DataSet object
-   DataSet dataset( dataset_id );
+   DataSet dataset;
+   f_DataSet_setId(&dataset, dataset_id);
    return( dataset );
 }
 
@@ -213,7 +217,8 @@ DataSet CommonFG::openDataSet( const char* name ) const
       throwException("openDataSet", "H5Dopen2 failed");
 
    // No failure, create and return the DataSet object
-   DataSet dataset( dataset_id );
+   DataSet dataset;
+   f_DataSet_setId(&dataset, dataset_id);
    return( dataset );
 }
 
@@ -576,7 +581,8 @@ DataType CommonFG::openDataType( const char* name ) const
       throwException("openDataType", "H5Topen2 failed");
 
    // No failure, create and return the DataType object
-   DataType data_type(type_id);
+   DataType data_type;
+   f_DataType_setId(&data_type, type_id);
    return(data_type);
 }
 
@@ -611,7 +617,8 @@ ArrayType CommonFG::openArrayType( const char* name ) const
       throwException("openArrayType", "H5Topen2 failed");
 
    // No failure, create and return the ArrayType object
-   ArrayType array_type (type_id);
+   ArrayType array_type;
+   f_DataType_setId(&array_type, type_id);
    return(array_type);
 }
 
@@ -646,7 +653,8 @@ CompType CommonFG::openCompType( const char* name ) const
       throwException("openCompType", "H5Topen2 failed");
 
    // No failure, create and return the CompType object
-   CompType comp_type(type_id);
+   CompType comp_type;
+   f_DataType_setId(&comp_type, type_id);
    return(comp_type);
 }
 
@@ -681,7 +689,8 @@ EnumType CommonFG::openEnumType( const char* name ) const
       throwException("openEnumType", "H5Topen2 failed");
 
    // No failure, create and return the EnumType object
-   EnumType enum_type(type_id);
+   EnumType enum_type;
+   f_DataType_setId(&enum_type, type_id);
    return(enum_type);
 }
 
@@ -716,7 +725,8 @@ IntType CommonFG::openIntType( const char* name ) const
       throwException("openIntType", "H5Topen2 failed");
 
    // No failure, create and return the IntType object
-   IntType int_type(type_id);
+   IntType int_type;
+   f_DataType_setId(&int_type, type_id);
    return(int_type);
 }
 
@@ -751,7 +761,8 @@ FloatType CommonFG::openFloatType( const char* name ) const
       throwException("openFloatType", "H5Topen2 failed");
 
    // No failure, create and return the FloatType object
-   FloatType float_type(type_id);
+   FloatType float_type;
+   f_DataType_setId(&float_type, type_id);
    return(float_type);
 }
 
@@ -786,7 +797,8 @@ StrType CommonFG::openStrType( const char* name ) const
       throwException("openStrType", "H5Topen2 failed");
 
    // No failure, create and return the StrType object
-   StrType str_type(type_id);
+   StrType str_type;
+   f_DataType_setId(&str_type, type_id);
    return(str_type);
 }
 
@@ -821,7 +833,8 @@ VarLenType CommonFG::openVarLenType( const char* name ) const
       throwException("openVarLenType", "H5Topen2 failed");
 
    // No failure, create and return the VarLenType object
-   VarLenType varlen_type(type_id);
+   VarLenType varlen_type;
+   f_DataType_setId(&varlen_type, type_id);
    return(varlen_type);
 }
 
@@ -1224,6 +1237,7 @@ H5G_obj_t CommonFG::getObjTypeByIdx(hsize_t idx, H5std_string& type_name) const
    }
    return (obj_type);
 }
+
 #endif // DOXYGEN_SHOULD_SKIP_THIS
 #endif /* H5_NO_DEPRECATED_SYMBOLS */
 
@@ -1241,6 +1255,37 @@ CommonFG::CommonFG() {}
 // Programmer	Binh-Minh Ribler - 2000
 //--------------------------------------------------------------------------
 CommonFG::~CommonFG() {}
+
+//--------------------------------------------------------------------------
+// Function:	f_DataType_setId - friend
+// Purpose:	This function is friend to class H5::DataType so that it
+//		can set DataType::id in order to work around a problem
+//		described in the JIRA issue HDFFV-7947.
+//		Applications shouldn't need to use it.
+// param        dtype   - IN/OUT: DataType object to be changed
+// param        new_id - IN: New id to set
+// Programmer	Binh-Minh Ribler - 2015
+//--------------------------------------------------------------------------
+void f_DataType_setId(DataType* dtype, hid_t new_id)
+{
+    dtype->id = new_id;
+}
+
+//--------------------------------------------------------------------------
+// Function:	f_DataSet_setId - friend
+// Purpose:	This function is friend to class H5::DataSet so that it
+//		can set DataSet::id in order to work around a problem
+//		described in the JIRA issue HDFFV-7947.
+//		Applications shouldn't need to use it.
+// param        dset   - IN/OUT: DataSet object to be changed
+// param        new_id - IN: New id to set
+// Programmer	Binh-Minh Ribler - 2015
+//--------------------------------------------------------------------------
+void f_DataSet_setId(DataSet* dset, hid_t new_id)
+{
+    dset->id = new_id;
+}
+
 #endif // DOXYGEN_SHOULD_SKIP_THIS
 
 #ifndef H5_NO_NAMESPACE