Check for extent consistency, fill in undefined extents

Author: franzpoeschel

include/openPMD/RecordComponent.hpp

@@ -118,6 +118,9 @@ namespace internal
         std::deque<RecordComponent> without_extent;
         std::optional<Extent> retrieved_extent;
 
+        static constexpr char const *env_var_check_dataset_consistency =
+            "OPENPMD_VERIFY_HOMOGENEOUS_EXTENTS";
+
         void check_extent(Attributable const &callsite, RecordComponent &);
         auto merge(Attributable const &callsite, HomogenizeExtents)
             -> HomogenizeExtents &;

src/RecordComponent.cpp

@@ -24,7 +24,9 @@
 #include "openPMD/Error.hpp"
 #include "openPMD/IO/Format.hpp"
 #include "openPMD/Series.hpp"
+#include "openPMD/auxiliary/Environment.hpp"
 #include "openPMD/auxiliary/Memory.hpp"
+#include "openPMD/auxiliary/StringManip.hpp"
 #include "openPMD/backend/Attributable.hpp"
 #include "openPMD/backend/BaseRecord.hpp"
 
@@ -66,14 +68,21 @@ namespace internal
         }
         else if (retrieved_extent.has_value())
         {
-            if (extent != *retrieved_extent)
+            if (extent != *retrieved_extent &&
+                auxiliary::getEnvNum(env_var_check_dataset_consistency, 1) != 0)
             {
+                std::stringstream error_msg;
+                error_msg << "Inconsistent extents found for Record '"
+                          << callsite.myPath().openPMDPath() << "': Component '"
+                          << rc.myPath().openPMDPath() << "' has extent";
+                auxiliary::write_vec_to_stream(error_msg, extent) << ", but ";
+                auxiliary::write_vec_to_stream(error_msg, *retrieved_extent)
+                    << " was found previously.";
                 throw error::ReadError(
                     error::AffectedObject::Group,
                     error::Reason::UnexpectedContent,
                     std::nullopt,
-                    "Inconsistent extents found for Record '" +
-                        callsite.myPath().openPMDPath() + "'.");
+                    error_msg.str());
             }
         }
         else
@@ -88,14 +97,22 @@ namespace internal
     {
         if (retrieved_extent.has_value() && other.retrieved_extent.has_value())
         {
-            if (*retrieved_extent != *other.retrieved_extent)
+            if (*retrieved_extent != *other.retrieved_extent &&
+                auxiliary::getEnvNum(env_var_check_dataset_consistency, 1) != 0)
             {
+                std::stringstream error_msg;
+                error_msg << "Inconsistent extents found for Record '"
+                          << callsite.myPath().openPMDPath() << "': ";
+                auxiliary::write_vec_to_stream(error_msg, *retrieved_extent)
+                    << " vs. ";
+                auxiliary::write_vec_to_stream(
+                    error_msg, *other.retrieved_extent)
+                    << ".";
                 throw error::ReadError(
                     error::AffectedObject::Group,
                     error::Reason::UnexpectedContent,
                     std::nullopt,
-                    "Inconsistent extents found for Record '" +
-                        callsite.myPath().openPMDPath() + "'.");
+                    error_msg.str());
             }
         }
         else if (!retrieved_extent.has_value())
@@ -114,12 +131,19 @@ namespace internal
     {
         if (!retrieved_extent.has_value())
         {
-            throw error::ReadError(
-                error::AffectedObject::Group,
-                error::Reason::UnexpectedContent,
-                std::nullopt,
-                "No extent found for any component contained in '" +
-                    callsite.myPath().openPMDPath() + "'.");
+            if (auxiliary::getEnvNum(env_var_check_dataset_consistency, 1) != 0)
+            {
+                throw error::ReadError(
+                    error::AffectedObject::Group,
+                    error::Reason::UnexpectedContent,
+                    std::nullopt,
+                    "No extent found for any component contained in '" +
+                        callsite.myPath().openPMDPath() + "'.");
+            }
+            else
+            {
+                return;
+            }
         }
         auto &ext = *retrieved_extent;
         for (auto &rc : without_extent)