mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 13:23:51 +00:00
7811cc4b1e
Many of the fancy `ArrayHandle`s are read-only and therefore connot really create write portals. Likewise, many `ArrayHandle`s (both read- only and read/write) have no way to resize themselves. In this case, implementing the `CreateWritePortal` and `ResizeBuffers` methods in the `Storage` class was troublesome. Mostly they just threw an exception, but they also sometimes had to deal with cases where the behavior was allowed. To simplify code for developers, this introduces a pair of macros: `VTKM_STORAGE_NO_RESIZE` and `VTKM_STORAGE_NO_WRITE_PORTAL`. These can be declared in a `Storage` implementation when the storage has no viable way to resize itself and create a write portal, respectively. Having boilerplate code for these methods also helps work around expected behavior for `ResizeBuffers`. `ResizeBuffers` should silently work when resizing to the same size. Also `ResizeBuffers` should behave well when resizing to 0 as that is what `ReleaseResources` does.
229 lines
8.7 KiB
C++
229 lines
8.7 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//============================================================================
|
|
#ifndef vtk_m_cont_Storage_h
|
|
#define vtk_m_cont_Storage_h
|
|
|
|
#define VTKM_STORAGE_ERROR -2
|
|
#define VTKM_STORAGE_UNDEFINED -1
|
|
#define VTKM_STORAGE_BASIC 1
|
|
|
|
#ifndef VTKM_STORAGE
|
|
#define VTKM_STORAGE VTKM_STORAGE_BASIC
|
|
#endif
|
|
|
|
#include <vtkm/Flags.h>
|
|
#include <vtkm/StaticAssert.h>
|
|
|
|
#include <vtkm/internal/ArrayPortalDummy.h>
|
|
|
|
#include <vtkm/cont/ErrorBadAllocation.h>
|
|
#include <vtkm/cont/Logging.h>
|
|
#include <vtkm/cont/Token.h>
|
|
|
|
#include <vtkm/cont/internal/Buffer.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
#ifdef VTKM_DOXYGEN_ONLY
|
|
/// \brief A tag specifying client memory allocation.
|
|
///
|
|
/// A Storage tag specifies how an ArrayHandle allocates and frees memory. The
|
|
/// tag StorageTag___ does not actually exist. Rather, this documentation is
|
|
/// provided to describe how array storage objects are specified. Loading the
|
|
/// vtkm/cont/Storage.h header will set a default array storage. You can
|
|
/// specify the default storage by first setting the VTKM_STORAGE macro.
|
|
/// Currently it can only be set to VTKM_STORAGE_BASIC.
|
|
///
|
|
/// User code external to VTK-m is free to make its own StorageTag. This is a
|
|
/// good way to get VTK-m to read data directly in and out of arrays from other
|
|
/// libraries. However, care should be taken when creating a Storage. One
|
|
/// particular problem that is likely is a storage that "constructs" all the
|
|
/// items in the array. If done incorrectly, then memory of the array can be
|
|
/// incorrectly bound to the wrong processor. If you do provide your own
|
|
/// StorageTag, please be diligent in comparing its performance to the
|
|
/// StorageTagBasic.
|
|
///
|
|
/// To implement your own StorageTag, you first must create a tag class (an
|
|
/// empty struct) defining your tag (i.e. struct VTKM_ALWAYS_EXPORT StorageTagMyAlloc { };). Then
|
|
/// provide a partial template specialization of vtkm::cont::internal::Storage
|
|
/// for your new tag. Note that because the StorageTag is being used for
|
|
/// template specialization, storage tags cannot use inheritance (or, rather,
|
|
/// inheritance won't have any effect). You can, however, have a partial template
|
|
/// specialization of vtkm::cont::internal::Storage inherit from a different
|
|
/// specialization. So, for example, you could not have StorageTagFoo inherit from
|
|
/// StorageTagBase, but you could have vtkm::cont::internal::Storage<T, StorageTagFoo>
|
|
/// inherit from vtkm::cont::internal::Storage<T, StorageTagBase>.
|
|
///
|
|
struct VTKM_ALWAYS_EXPORT StorageTag___
|
|
{
|
|
};
|
|
#endif // VTKM_DOXYGEN_ONLY
|
|
|
|
namespace internal
|
|
{
|
|
|
|
struct UndefinedStorage
|
|
{
|
|
};
|
|
|
|
namespace detail
|
|
{
|
|
|
|
// This class should never be used. It is used as a placeholder for undefined
|
|
// Storage objects. If you get a compiler error involving this object, then it
|
|
// probably comes from trying to use an ArrayHandle with bad template
|
|
// arguments.
|
|
template <typename T>
|
|
struct UndefinedArrayPortal
|
|
{
|
|
VTKM_STATIC_ASSERT(sizeof(T) == static_cast<size_t>(-1));
|
|
};
|
|
|
|
} // namespace detail
|
|
|
|
/// This templated class must be partially specialized for each StorageTag
|
|
/// created, which will define the implementation for that tag.
|
|
///
|
|
template <typename T, class StorageTag>
|
|
class Storage
|
|
#ifndef VTKM_DOXYGEN_ONLY
|
|
: public vtkm::cont::internal::UndefinedStorage
|
|
{
|
|
public:
|
|
// TODO: Deprecate these
|
|
using PortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
|
|
using PortalConstType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
|
|
|
|
using ReadPortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
|
|
using WritePortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
|
|
};
|
|
#else //VTKM_DOXYGEN_ONLY
|
|
{
|
|
public:
|
|
/// The type of each item in the array.
|
|
///
|
|
using ValueType = T;
|
|
|
|
/// \brief The type of portal objects for the array.
|
|
///
|
|
/// The actual portal object can take any form. This is a simple example of a
|
|
/// portal to a C array.
|
|
///
|
|
using PortalType = ::vtkm::cont::internal::ArrayPortalFromIterators<ValueType*>;
|
|
|
|
/// \brief The type of portal objects (const version) for the array.
|
|
///
|
|
/// The actual portal object can take any form. This is a simple example of a
|
|
/// portal to a C array.
|
|
///
|
|
using PortalConstType = ::vtkm::cont::internal::ArrayPortalFromIterators<const ValueType*>;
|
|
|
|
VTKM_CONT Storage(const Storage& src);
|
|
VTKM_CONT Storage(Storage&& src) noexcept;
|
|
VTKM_CONT Storage& operator=(const Storage& src);
|
|
VTKM_CONT Storage& operator=(Storage&& src);
|
|
|
|
/// Returns a portal to the array.
|
|
///
|
|
VTKM_CONT
|
|
PortalType GetPortal();
|
|
|
|
/// Returns a portal to the array with immutable values.
|
|
///
|
|
VTKM_CONT
|
|
PortalConstType GetPortalConst() const;
|
|
|
|
/// Returns the number of entries allocated in the array.
|
|
VTKM_CONT
|
|
vtkm::Id GetNumberOfValues() const;
|
|
|
|
/// \brief Allocates an array large enough to hold the given number of values.
|
|
///
|
|
/// The allocation may be done on an already existing array, but can wipe out
|
|
/// any data already in the array. This method can throw
|
|
/// ErrorBadAllocation if the array cannot be allocated or
|
|
/// ErrorBadValue if the allocation is not feasible (for example, the
|
|
/// array storage is read-only).
|
|
///
|
|
VTKM_CONT
|
|
void Allocate(vtkm::Id numberOfValues);
|
|
|
|
/// \brief Reduces the size of the array without changing its values.
|
|
///
|
|
/// This method allows you to resize the array without reallocating it. The
|
|
/// number of entries in the array is changed to \c numberOfValues. The data
|
|
/// in the array (from indices 0 to \c numberOfValues - 1) are the same, but
|
|
/// \c numberOfValues must be equal or less than the preexisting size
|
|
/// (returned from GetNumberOfValues). That is, this method can only be used
|
|
/// to shorten the array, not lengthen.
|
|
VTKM_CONT
|
|
void Shrink(vtkm::Id numberOfValues);
|
|
|
|
/// \brief Frees any resources (i.e. memory) stored in this array.
|
|
///
|
|
/// After calling this method GetNumberOfValues will return 0. The
|
|
/// resources should also be released when the Storage class is
|
|
/// destroyed.
|
|
VTKM_CONT
|
|
void ReleaseResources();
|
|
};
|
|
#endif // VTKM_DOXYGEN_ONLY
|
|
|
|
namespace detail
|
|
{
|
|
|
|
VTKM_CONT_EXPORT void StorageNoResizeImpl(vtkm::Id currentNumValues,
|
|
vtkm::Id requestedNumValues,
|
|
std::string storageTagName);
|
|
|
|
} // namespace detail
|
|
|
|
template <typename StorageType>
|
|
struct StorageTraits;
|
|
|
|
template <typename T, typename S>
|
|
struct StorageTraits<vtkm::cont::internal::Storage<T, S>>
|
|
{
|
|
using ValueType = T;
|
|
using Tag = S;
|
|
};
|
|
|
|
#define VTKM_STORAGE_NO_RESIZE \
|
|
VTKM_CONT static void ResizeBuffers( \
|
|
vtkm::Id numValues, vtkm::cont::internal::Buffer* buffers, vtkm::CopyFlag, vtkm::cont::Token&) \
|
|
{ \
|
|
vtkm::cont::internal::detail::StorageNoResizeImpl( \
|
|
GetNumberOfValues(buffers), \
|
|
numValues, \
|
|
vtkm::cont::TypeToString<typename vtkm::cont::internal::StorageTraits<Storage>::Tag>()); \
|
|
} \
|
|
using ResizeBuffersEatComma = void
|
|
|
|
#define VTKM_STORAGE_NO_WRITE_PORTAL \
|
|
using WritePortalType = vtkm::internal::ArrayPortalDummy< \
|
|
typename vtkm::cont::internal::StorageTraits<Storage>::ValueType>; \
|
|
VTKM_CONT static WritePortalType CreateWritePortal( \
|
|
vtkm::cont::internal::Buffer*, vtkm::cont::DeviceAdapterId, vtkm::cont::Token&) \
|
|
{ \
|
|
throw vtkm::cont::ErrorBadAllocation( \
|
|
"Cannot write to arrays with storage type of " + \
|
|
vtkm::cont::TypeToString<typename vtkm::cont::internal::StorageTraits<Storage>::Tag>()); \
|
|
} \
|
|
using CreateWritePortalEatComma = void
|
|
|
|
} // namespace internal
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_Storage_h
|