Skip to content

Commit

Permalink
Some cleanup needed, but change class structure
Browse files Browse the repository at this point in the history
  • Loading branch information
@franzpoeschel
franzpoeschel committed Jul 19, 2024
1 parent f23ae2a commit c7dad14
Show file tree
Hide file tree
Showing 4 changed files with 210 additions and 186 deletions.
188 changes: 99 additions & 89 deletions include/openPMD/LoadStoreChunk.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace openPMD
{
class RecordComponent;
template <typename Ptr_Type, typename ChildClass>
template <typename Ptr_Type>
class ConfigureStoreChunkFromBuffer;
template <typename Ptr_Type>
class ConfigureLoadStoreFromBuffer;
Expand Down Expand Up @@ -41,6 +41,15 @@ namespace auxiliary::detail
map_variant<as_shared_pointer, dataset_types>::type;
} // namespace auxiliary::detail

namespace auxiliary
{
template <typename possibly_void, typename alternative>
using non_void_or = std::conditional_t<
!std::is_void_v<possibly_void>,
/*then*/ possibly_void,
/*else*/ alternative>;
} // namespace auxiliary

enum class EnqueuePolicy
{
Defer,
Expand Down Expand Up @@ -84,8 +93,7 @@ struct ConfigureLoadStoreCore
template <typename T>
struct shared_ptr_return_type_impl<T const>
{
using type =
ConfigureStoreChunkFromBuffer<std::shared_ptr<T const>, void>;
using type = ConfigureStoreChunkFromBuffer<std::shared_ptr<T const>>;
};

template <typename T>
Expand All @@ -98,8 +106,7 @@ struct ConfigureLoadStoreCore
*/
template <typename T>
using unique_ptr_return_type = ConfigureStoreChunkFromBuffer<
UniquePtrWithLambda<std::remove_extent_t<T>>,
void>;
UniquePtrWithLambda<std::remove_extent_t<T>>>;

// @todo rvalue references..?
template <typename T>
Expand Down Expand Up @@ -133,77 +140,17 @@ struct ConfigureLoadStoreCore
-> std::future<auxiliary::detail::future_to_shared_ptr_dataset_types>;
};

/** Basic configuration for a Load/Store operation.
*
* @tparam ChildClass CRT pattern.
* The purpose is that in child classes `return *this` should return
* an instance of the child class, not of ConfigureLoadStore.
* Instantiate with void when using without subclass.
*/
template <typename ChildClass = void>
class ConfigureLoadStore : public ConfigureLoadStoreCore
{
friend class RecordComponent;
friend struct ConfigureLoadStoreCore;

protected:
ConfigureLoadStore(RecordComponent &rc);
ConfigureLoadStore(ConfigureLoadStoreCore &&);

public:
using return_type = std::conditional_t<
std::is_void_v<ChildClass>,
/*then*/ ConfigureLoadStore<void>,
/*else*/ ChildClass>;

auto offset(Offset) -> return_type &;
auto extent(Extent) -> return_type &;
};

/** Configuration for a Store operation with a buffer type.
*
* This class does intentionally not support Load operations since there are
* pointer types (const pointers, unique pointers) where Load operations make no
* sense. See the \ref ConfigureLoadStoreFromBuffer class template for both
* Load/Store operations.
*
* @tparam Ptr_Type The type of pointer used internally.
* @tparam ChildClass CRT pattern.
* The purpose is that in child classes `return *this` should return
* an instance of the child class, not of ConfigureStoreChunkFromBuffer.
* Instantiate with void when using without subclass.
*/
template <typename Ptr_Type, typename ChildClass = void>
class ConfigureStoreChunkFromBuffer
: public ConfigureLoadStore<std::conditional_t<
std::is_void_v<ChildClass>,
/*then*/ ConfigureStoreChunkFromBuffer<Ptr_Type, void>,
/*else*/ ChildClass>>
template <typename Ptr_Type>
class ConfigureStoreChunkFromBufferCore : public ConfigureLoadStoreCore
{
public:
using return_type = std::conditional_t<
std::is_void_v<ChildClass>,
/*then*/ ConfigureStoreChunkFromBuffer<Ptr_Type, void>,
/*else*/ ChildClass>;
using parent_t = ConfigureLoadStore<return_type>;

protected:
friend struct ConfigureLoadStoreCore;

Ptr_Type m_buffer;
std::optional<MemorySelection> m_mem_select;

auto storeChunkConfig() -> internal::LoadStoreConfigWithBuffer;

protected:
ConfigureStoreChunkFromBuffer(Ptr_Type buffer, parent_t &&);
ConfigureStoreChunkFromBufferCore(
Ptr_Type buffer, ConfigureLoadStoreCore &&);

public:
auto memorySelection(MemorySelection) -> return_type &;

auto as_parent() && -> parent_t &&;
auto as_parent() & -> parent_t &;
auto as_parent() const & -> parent_t const &;
auto storeChunkConfig() -> internal::LoadStoreConfigWithBuffer;

auto enqueueStore() -> void;

Expand All @@ -222,32 +169,95 @@ class ConfigureStoreChunkFromBuffer
}
};

/** Configuration for a Load/Store operation with a buffer type.
*
* Only instantiated for pointer types where Load operations make sense (e.g. no
* const pointers and no unique pointers).
* \ref ConfigureStoreChunkFromBuffer is used otherwise.
*
* @tparam Ptr_Type The type of pointer used internally.
*/
template <typename Ptr_Type>
class ConfigureLoadStoreFromBuffer
: public ConfigureStoreChunkFromBuffer<
Ptr_Type,
ConfigureLoadStoreFromBuffer<Ptr_Type>>
class ConfigureLoadStoreFromBufferCore
: public ConfigureStoreChunkFromBufferCore<Ptr_Type>
{
using parent_t = ConfigureStoreChunkFromBuffer<
Ptr_Type,
ConfigureLoadStoreFromBuffer<Ptr_Type>>;
friend struct ConfigureLoadStoreCore;
ConfigureLoadStoreFromBuffer(
Ptr_Type buffer, typename parent_t::parent_t &&);

public:
using ConfigureStoreChunkFromBufferCore<
Ptr_Type>::ConfigureStoreChunkFromBufferCore;

auto enqueueLoad() -> void;

auto load(EnqueuePolicy) -> void;
};

namespace compose
{
/** Basic configuration for a Load/Store operation.
*
* @tparam ChildClass CRT pattern.
* The purpose is that in child classes `return *this` should return
* an instance of the child class, not of ConfigureLoadStore.
* Instantiate with void when using without subclass.
*/
template <typename ChildClass>
class ConfigureLoadStore
{
public:
auto offset(Offset) -> ChildClass &;
auto extent(Extent) -> ChildClass &;
};

/** Configuration for a Store operation with a buffer type.
*
* This class does intentionally not support Load operations since there are
* pointer types (const pointers, unique pointers) where Load operations
* make no sense. See the \ref ConfigureLoadStoreFromBuffer class template
* for both Load/Store operations.
*
* @tparam Ptr_Type The type of pointer used internally.
* @tparam ChildClass CRT pattern.
* The purpose is that in child classes `return *this` should return
* an instance of the child class, not of
* ConfigureStoreChunkFromBuffer. Instantiate with void when using without
* subclass.
*/
template <typename ChildClass = void>
class ConfigureStoreChunkFromBuffer
{
public:
auto memorySelection(MemorySelection) -> ChildClass &;
};
} // namespace compose

class ConfigureLoadStore
: public ConfigureLoadStoreCore
, public compose::ConfigureLoadStore<ConfigureLoadStore>
{
friend class RecordComponent;
friend struct ConfigureLoadStoreCore;

ConfigureLoadStore(RecordComponent &rc);
ConfigureLoadStore(ConfigureLoadStoreCore &&);
};

template <typename Ptr_Type>
class ConfigureStoreChunkFromBuffer
: public ConfigureStoreChunkFromBufferCore<Ptr_Type>
, public compose::ConfigureLoadStore<
ConfigureStoreChunkFromBuffer<Ptr_Type>>
, public compose::ConfigureStoreChunkFromBuffer<
ConfigureStoreChunkFromBuffer<Ptr_Type>>
{
friend struct ConfigureLoadStoreCore;

using ConfigureStoreChunkFromBufferCore<
Ptr_Type>::ConfigureStoreChunkFromBufferCore;
};

template <typename Ptr_Type>
class ConfigureLoadStoreFromBuffer
: public ConfigureLoadStoreFromBufferCore<Ptr_Type>
, public compose::ConfigureLoadStore<ConfigureLoadStoreFromBuffer<Ptr_Type>>
, public compose::ConfigureStoreChunkFromBuffer<
ConfigureLoadStoreFromBuffer<Ptr_Type>>
{
friend struct ConfigureLoadStoreCore;

using ConfigureLoadStoreFromBufferCore<
Ptr_Type>::ConfigureLoadStoreFromBufferCore;
};
} // namespace openPMD

#include "openPMD/LoadStoreChunk.tpp"
10 changes: 4 additions & 6 deletions include/openPMD/RecordComponent.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,10 @@ class RecordComponent : public BaseRecordComponent
friend class internal::RecordComponentData;
friend class MeshRecordComponent;
friend struct ConfigureLoadStoreCore;
template <typename ChildClass>
friend class ConfigureLoadStore;
template <typename Ptr_Type, typename ChildClass>
friend class ConfigureStoreChunkFromBuffer;
template <typename>
friend class ConfigureLoadStoreFromBuffer;
friend class ConfigureLoadStoreFromBufferCore;
template <typename>
friend class ConfigureStoreChunkFromBufferCore;
friend struct VisitorEnqueueLoadVariant;

public:
Expand Down Expand Up @@ -292,7 +290,7 @@ class RecordComponent : public BaseRecordComponent
template <typename T>
void loadChunkRaw(T *data, Offset offset, Extent extent);

ConfigureLoadStore<void> prepareLoadStore();
ConfigureLoadStore prepareLoadStore();

/** Store a chunk of data from a chunk of memory.
*
Expand Down
Loading

0 comments on commit c7dad14

Please sign in to comment.