Merge pull request #522 from danrbailey/OVDB-120

OVDB-120: OpenVDB 6.2.1 release

Author: danrbailey

CHANGES

@@ -1,6 +1,16 @@
 OpenVDB Version History
 =======================
 
+Version 6.2.1 - September 30, 2019
+
+    Bug fixes:
+    - Fix a crash that arose from an inadvertent ABI change of an IO class with
+      the 6.2.0 release. This crash occurs attempting to write out a VDB Points
+      grid using an IO routine from a different version of the core library
+      than the core library version in which the grid was authored and when one
+      of these core library versions is 6.2.0.
+
+
 Version 6.2.0 - September 18, 2019
 
     New features:

doc/changes.txt

@@ -2,6 +2,19 @@
 
 @page changes Release Notes
 
+@htmlonly <a name="v6_2_1_changes"></a>@endhtmlonly
+@par
+<B>Version 6.2.1</B> - <I>September 30, 2019</I>
+
+@par
+Bug fixes:
+- Fix a crash that arose from an inadvertent ABI change of an IO class with
+  the 6.2.0 release. This crash occurs attempting to write out a VDB Points
+  grid using an IO routine from a different version of the core library
+  than the core library version in which the grid was authored and when one
+  of these core library versions is 6.2.0.
+
+
 @htmlonly <a name="v6_2_0_changes"></a>@endhtmlonly
 @par
 <B>Version 6.2.0</B> - <I>September 18, 2019</I>

doc/doxygen-config

@@ -38,7 +38,7 @@ PROJECT_NAME           = "OpenVDB"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 6.2.0
+PROJECT_NUMBER         = 6.2.1
 
 PREDEFINED             = OPENVDB_VERSION_NAME=v6_2
 PREDEFINED            += OPENVDB_ABI_VERSION_NUMBER=6

openvdb/io/Archive.cc

@@ -105,6 +105,11 @@ struct StreamState
     StreamState();
     ~StreamState();
 
+    // Important:  The size and order of these member variables must *only* change when
+    //             OpenVDB ABI changes to avoid potential segfaults when performing I/O
+    //             across two different versions of the library. Adding new member
+    //             variables to the end of the struct is allowed provided that they
+    //             are only accessed from within an appropriate ABI guard.
     int magicNumber;
     int fileVersion;
     int libraryMajorVersion;
@@ -203,6 +208,12 @@ StreamState::~StreamState()
 
 struct StreamMetadata::Impl
 {
+    // Important:  The size and order of these member variables must *only* change when
+    //             OpenVDB ABI changes to avoid potential segfaults when performing I/O
+    //             across two different versions of the library. Adding new member
+    //             variables to the end of the struct is allowed provided that they
+    //             are only accessed from within an appropriate ABI guard.
+
     uint32_t mFileVersion = OPENVDB_FILE_VERSION;
     VersionId mLibraryVersion = { OPENVDB_LIBRARY_MAJOR_VERSION, OPENVDB_LIBRARY_MINOR_VERSION };
     uint32_t mCompression = COMPRESS_NONE;
@@ -211,12 +222,12 @@ struct StreamMetadata::Impl
     bool mHalfFloat = false;
     bool mWriteGridStats = false;
     bool mSeekable = false;
-    bool mDelayedLoadMeta = DelayedLoadMetadata::isRegisteredType();
     bool mCountingPasses = false;
     uint32_t mPass = 0;
-    uint64_t mLeaf = 0;
     MetaMap mGridMetadata;
     AuxDataMap mAuxData;
+    bool mDelayedLoadMeta = DelayedLoadMetadata::isRegisteredType();
+    uint64_t mLeaf = 0;
     uint32_t mTest = 0; // for testing only
 }; // struct StreamMetadata
 

openvdb/version.h

@@ -75,7 +75,7 @@
 // Library major, minor and patch version numbers
 #define OPENVDB_LIBRARY_MAJOR_VERSION_NUMBER 6
 #define OPENVDB_LIBRARY_MINOR_VERSION_NUMBER 2
-#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER 0
+#define OPENVDB_LIBRARY_PATCH_VERSION_NUMBER 1
 
 // If OPENVDB_ABI_VERSION_NUMBER is already defined (e.g., via -DOPENVDB_ABI_VERSION_NUMBER=N)
 // use that ABI version.  Otherwise, use this library version's default ABI.