vtkDeviceDataArray.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkDeviceDataArray_h
#define vtkDeviceDataArray_h
 
#include "vtkAOSDataArrayTemplate.h" // For NewInstance
#include "vtkCommonCoreModule.h"     // For export macro
#include "vtkGenericDataArray.h"
#include "vtkMemoryDescriptor.h" // For the held descriptor
#include "vtkSmartPointer.h"     // For the held descriptor
 
#include <atomic>      // For the host copy's state
#include <mutex>       // For the host copy
#include <type_traits> // For std::is_arithmetic
#include <typeinfo>    // For the type macro
#include <vector>      // For the host copy
 
VTK_ABI_NAMESPACE_BEGIN
template <typename ValueTypeT>
class vtkDeviceDataArray
  : public vtkGenericDataArray<vtkDeviceDataArray<ValueTypeT>, ValueTypeT,
      vtkArrayTypes::VTK_DEVICE_DATA_ARRAY>
{
  static_assert(std::is_arithmetic<ValueTypeT>::value, "ValueTypeT must be a number");
 
  using GenericDataArrayType = vtkGenericDataArray<vtkDeviceDataArray<ValueTypeT>, ValueTypeT,
    vtkArrayTypes::VTK_DEVICE_DATA_ARRAY>;
 
public:
  using SelfType = vtkDeviceDataArray<ValueTypeT>;
  // NewInstance() makes a host array: see the class description.
  vtkAbstractTypeMacroWithNewInstanceType(
    SelfType, GenericDataArrayType, vtkAOSDataArrayTemplate<ValueTypeT>, typeid(SelfType).name());
  using typename Superclass::ValueType;
 
  static vtkDeviceDataArray* New();

  bool SetDescriptor(
    vtkMemoryDescriptor* descriptor, vtkIdType numberOfTuples, int numberOfComponents);


  vtkDataArray::MemorySpace GetMemorySpace() override;
  void* GetDeviceVoidPointer(vtkIdType valueIdx) override;
  VTK_NEWINSTANCE
  vtkCollection* NewMemoryDescriptors() override;

  void* GetVoidPointer(vtkIdType valueIdx) override;

  void ShallowCopy(vtkDataArray* other) override;
  using vtkAbstractArray::ShallowCopy;

  vtkTypeBool ReserveTuples(vtkIdType numTuples) override;

  void Modified() override;
  void DataChanged() override;


  ValueType GetValue(vtkIdType valueIdx) const { return this->HostValues()[valueIdx]; }
  void SetValue(vtkIdType valueIdx, ValueType value);
  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const;
  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple);
  ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const
  {
    return this->HostValues()[tupleIdx * this->NumberOfComponents + compIdx];
  }
  void SetTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType value);
 
protected:
  vtkDeviceDataArray();
  ~vtkDeviceDataArray() override;
 
  vtkObjectBase* NewInstanceInternal() const override
  {
    return vtkAOSDataArrayTemplate<ValueTypeT>::New();
  }


  bool AllocateTuples(vtkIdType numTuples);
  bool ReallocateTuples(vtkIdType numTuples);
 
private:
  friend class vtkGenericDataArray<SelfType, ValueType, vtkArrayTypes::VTK_DEVICE_DATA_ARRAY>;
 
  // The host copy, made (again) if it is missing or stale.
  const ValueType* HostValues() const;
  // Report a refused write, once per array.
  void RefuseWrite();
 
  vtkSmartPointer<vtkMemoryDescriptor> Descriptor;
  vtkDataArray::MemorySpace Space = vtkDataArray::HostMemory;
  vtkIdType DeviceValues = 0; // how many values the device memory holds
 
  mutable std::vector<ValueType> Host;
  mutable std::atomic<bool> HostCurrent{ false };
  mutable std::mutex HostMutex;
  std::atomic<bool> WriteRefused{ false };
 
  vtkDeviceDataArray(const vtkDeviceDataArray&) = delete;
  void operator=(const vtkDeviceDataArray&) = delete;
};
 
// Declare vtkArrayDownCast implementations for vtkDeviceDataArray:
vtkArrayDownCast_TemplateFastCastMacro(vtkDeviceDataArray);
 
#ifndef vtkDeviceDataArray_cxx
#ifdef _MSC_VER
#pragma warning(push)
// Needed when vtkDeviceDataArray is used from another class in vtkCommonCore.
#pragma warning(disable : 4910) // extern and dllexport incompatible
#endif
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<char>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<double>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<float>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<int>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<long>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<long long>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<short>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<signed char>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<unsigned char>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<unsigned int>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<unsigned long>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<unsigned long long>;
extern template class VTKCOMMONCORE_EXPORT vtkDeviceDataArray<unsigned short>;
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#endif
 
VTK_ABI_NAMESPACE_END
#endif // vtkDeviceDataArray_h
// VTK-HeaderTest-Exclude: vtkDeviceDataArray.h