Fixes for deferred initialization (#1777)

* Fixes for deferred initialization

* Turn gcc9 run into a Debug build

Author: franzpoeschel

.github/workflows/linux.yml

@@ -266,12 +266,15 @@ jobs:
       env: {CXXFLAGS: -Werror, PKG_CONFIG_PATH: /usr/lib/x86_64-linux-gnu/pkgconfig}
       run: |
         share/openPMD/download_samples.sh build
+        # Run a debug build,
+        # Pybind has some builtin checks only activated in debug mode.
         cmake -S . -B build                  \
           -DopenPMD_USE_PYTHON=ON            \
           -DopenPMD_USE_MPI=ON               \
           -DopenPMD_USE_HDF5=ON              \
           -DopenPMD_USE_FILESYSTEM_HEADER=ON \
-          -DopenPMD_USE_INVASIVE_TESTS=ON
+          -DopenPMD_USE_INVASIVE_TESTS=ON \
+          -DCMAKE_BUILD_TYPE=Debug
         cmake --build build --parallel 4
         ctest --test-dir build --output-on-failure
 

include/openPMD/snapshots/ContainerImpls.hpp

@@ -34,12 +34,14 @@ class StatefulSnapshotsContainer : public AbstractSnapshotsContainer
          * make_reading_stateful_iterator.
          * The iterator is resolved upon calling get() below.
          */
-        std::function<StatefulIterator *()> m_begin;
-        std::optional<StatefulIterator *> m_bufferedIterator = std::nullopt;
+        std::variant<std::function<StatefulIterator *()>, StatefulIterator *>
+            m_bufferedIterator;
     };
     Members members;
 
-    StatefulSnapshotsContainer(std::function<StatefulIterator *()> begin);
+    StatefulSnapshotsContainer(
+        std::variant<std::function<StatefulIterator *()>, StatefulIterator *>
+            begin);
 
     auto get() -> StatefulIterator *;
     auto get() const -> StatefulIterator const *;
@@ -64,6 +66,7 @@ class StatefulSnapshotsContainer : public AbstractSnapshotsContainer
 
     using AbstractSnapshotsContainer::currentIteration;
     auto currentIteration() const -> std::optional<value_type const *> override;
+    auto currentIteration() -> std::optional<value_type *> override;
 
     auto begin() -> iterator override;
     auto end() -> iterator override;

src/Series.cpp

@@ -3194,20 +3194,24 @@ namespace
 {
     auto make_writing_stateful_iterator(
         Series const &copied_series, internal::SeriesData &series)
-        -> std::function<StatefulIterator *()>
+        -> StatefulIterator *
     {
         if (!series.m_sharedStatefulIterator)
         {
             series.m_sharedStatefulIterator =
                 std::make_unique<StatefulIterator>(
                     StatefulIterator::tag_write, copied_series);
         }
-        return [ptr = series.m_sharedStatefulIterator.get()]() { return ptr; };
+        return series.m_sharedStatefulIterator.get();
     }
     auto make_reading_stateful_iterator(
         Series copied_series, internal::SeriesData &series)
-        -> std::function<StatefulIterator *()>
+        -> std::variant<std::function<StatefulIterator *()>, StatefulIterator *>
     {
+        if (series.m_sharedStatefulIterator)
+        {
+            return series.m_sharedStatefulIterator.get();
+        }
         return [s = std::move(copied_series), &series]() mutable {
             if (!series.m_sharedStatefulIterator)
             {
@@ -3317,7 +3321,7 @@ Snapshots Series::makeSynchronousSnapshots()
             internal::default_or_explicit::default_);
     }
 
-    std::function<StatefulIterator *()> begin;
+    std::variant<std::function<StatefulIterator *()>, StatefulIterator *> begin;
 
     if (access::write(IOHandler()->m_frontendAccess))
     {

src/snapshots/ContainerImpls.cpp

@@ -1,6 +1,7 @@
 #include "openPMD/snapshots/ContainerImpls.hpp"
 #include "openPMD/Error.hpp"
 #include "openPMD/IO/Access.hpp"
+#include "openPMD/auxiliary/Variant.hpp"
 #include "openPMD/snapshots/ContainerTraits.hpp"
 #include "openPMD/snapshots/IteratorHelpers.hpp"
 #include "openPMD/snapshots/RandomAccessIterator.hpp"
@@ -12,7 +13,7 @@
 namespace openPMD
 {
 StatefulSnapshotsContainer::StatefulSnapshotsContainer(
-    std::function<StatefulIterator *()> begin)
+    std::variant<std::function<StatefulIterator *()>, StatefulIterator *> begin)
     : members{std::move(begin)}
 {}
 
@@ -30,15 +31,34 @@ operator=(StatefulSnapshotsContainer &&other) noexcept(noexcept(
 
 auto StatefulSnapshotsContainer::get() -> StatefulIterator *
 {
-    if (!members.m_bufferedIterator.has_value())
-    {
-        members.m_bufferedIterator = members.m_begin();
-    }
-    return *members.m_bufferedIterator;
+    return std::visit(
+        auxiliary::overloaded{
+            [this](
+                std::function<StatefulIterator *()> &deferred_initialization) {
+                auto it = deferred_initialization();
+                this->members.m_bufferedIterator = it;
+                return it;
+            },
+            [](StatefulIterator *it) { return it; }},
+        members.m_bufferedIterator);
 }
+
+void breakpoint()
+{}
 auto StatefulSnapshotsContainer::get() const -> StatefulIterator const *
 {
-    return members.m_bufferedIterator.value_or(nullptr);
+    return std::visit(
+        auxiliary::overloaded{
+            [](std::function<StatefulIterator *()> const &)
+                -> StatefulIterator const * {
+                breakpoint();
+                throw std::runtime_error(
+                    "[StatefulSnapshotscontainer] Initialization has been "
+                    "deferred, but container is accessed as const, so cannot "
+                    "initialize.");
+            },
+            [](StatefulIterator const *it) { return it; }},
+        members.m_bufferedIterator);
 }
 
 auto StatefulSnapshotsContainer::stateful_to_opaque(StatefulIterator const &it)
@@ -60,6 +80,19 @@ auto StatefulSnapshotsContainer::currentIteration() const
     }
 }
 
+auto StatefulSnapshotsContainer::currentIteration()
+    -> std::optional<value_type *>
+{
+    if (auto it = get(); it)
+    {
+        return it->peekCurrentlyOpenIteration();
+    }
+    else
+    {
+        return std::nullopt;
+    }
+}
+
 StatefulSnapshotsContainer::~StatefulSnapshotsContainer() = default;
 
 auto StatefulSnapshotsContainer::begin() -> iterator