e312c54356
`UnknownArrayHandle` compares `std::type_index` objects to check whether a requested type is the same as that held in the array handle. However, it is possible that different translation units can create different but equivalent `std::type_info`/`std::type_index` objects. In this case, the `==` operator might return false for two equivalent types. This can happen on OSX. To get around this problem, `UnknownArrayHandle` now does a more extensive check for `std::type_info` object. It first uses the `==` operator to compare them (as before), which usually works but can possibly return `false` when the correct result is `true`. To check for this case, it then compares the name for the two types and returns `true` iff the two names are the same.
493 lines
14 KiB
C++
493 lines
14 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.
|
|
//============================================================================
|
|
|
|
#include <vtkm/cont/UnknownArrayHandle.h>
|
|
|
|
#include <vtkm/cont/ArrayHandleBasic.h>
|
|
#include <vtkm/cont/ArrayHandleCartesianProduct.h>
|
|
#include <vtkm/cont/ArrayHandleConstant.h>
|
|
#include <vtkm/cont/ArrayHandleCounting.h>
|
|
#include <vtkm/cont/ArrayHandleGroupVec.h>
|
|
#include <vtkm/cont/ArrayHandleIndex.h>
|
|
#include <vtkm/cont/ArrayHandlePermutation.h>
|
|
#include <vtkm/cont/ArrayHandleReverse.h>
|
|
#include <vtkm/cont/ArrayHandleSOA.h>
|
|
#include <vtkm/cont/ArrayHandleUniformPointCoordinates.h>
|
|
#include <vtkm/cont/ErrorBadType.h>
|
|
#include <vtkm/cont/ErrorInternal.h>
|
|
#include <vtkm/cont/UncertainArrayHandle.h>
|
|
|
|
#include <vtkm/cont/internal/ArrayCopyUnknown.h>
|
|
|
|
#include <cstring>
|
|
#include <sstream>
|
|
|
|
namespace
|
|
{
|
|
|
|
template <vtkm::IdComponent N, typename ScalarList>
|
|
struct AllVecImpl;
|
|
template <vtkm::IdComponent N, typename... Scalars>
|
|
struct AllVecImpl<N, vtkm::List<Scalars...>>
|
|
{
|
|
using type = vtkm::List<vtkm::Vec<Scalars, N>...>;
|
|
};
|
|
|
|
// Normally I would implement this with vtkm::ListTransform, but that is causing an ICE in GCC 4.8.
|
|
// This implementation is not much different.
|
|
template <vtkm::IdComponent N>
|
|
using AllVec = typename AllVecImpl<N, vtkm::TypeListBaseC>::type;
|
|
|
|
using UnknownSerializationTypes =
|
|
vtkm::ListAppend<vtkm::TypeListBaseC, AllVec<2>, AllVec<3>, AllVec<4>>;
|
|
using UnknownSerializationStorage =
|
|
vtkm::ListAppend<VTKM_DEFAULT_STORAGE_LIST,
|
|
vtkm::List<vtkm::cont::StorageTagBasic,
|
|
vtkm::cont::StorageTagCartesianProduct<vtkm::cont::StorageTagBasic,
|
|
vtkm::cont::StorageTagBasic,
|
|
vtkm::cont::StorageTagBasic>,
|
|
vtkm::cont::StorageTagConstant,
|
|
vtkm::cont::StorageTagCounting,
|
|
vtkm::cont::StorageTagIndex,
|
|
vtkm::cont::StorageTagGroupVec<vtkm::cont::StorageTagBasic, 2>,
|
|
vtkm::cont::StorageTagGroupVec<vtkm::cont::StorageTagBasic, 3>,
|
|
vtkm::cont::StorageTagGroupVec<vtkm::cont::StorageTagBasic, 4>,
|
|
vtkm::cont::StorageTagPermutation<vtkm::cont::StorageTagBasic,
|
|
vtkm::cont::StorageTagBasic>,
|
|
vtkm::cont::StorageTagReverse<vtkm::cont::StorageTagBasic>,
|
|
vtkm::cont::StorageTagSOA,
|
|
vtkm::cont::StorageTagUniformPoints>>;
|
|
|
|
} // anonymous namespace
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
namespace detail
|
|
{
|
|
|
|
std::shared_ptr<UnknownAHContainer> UnknownAHContainer::MakeNewInstance() const
|
|
{
|
|
// Start by doing an invalid copy to create a new container, then swap out the pointer
|
|
// to the array handle to make sure that each object will delete its own ArrayHandle
|
|
// when they get destroyed.
|
|
std::shared_ptr<UnknownAHContainer> newContainer(new UnknownAHContainer(*this));
|
|
newContainer->ArrayHandlePointer = this->NewInstance();
|
|
return newContainer;
|
|
}
|
|
|
|
bool UnknownAHComponentInfo::operator==(const UnknownAHComponentInfo& rhs)
|
|
{
|
|
if (this->IsIntegral || this->IsFloat)
|
|
{
|
|
return ((this->IsIntegral == rhs.IsIntegral) && (this->IsFloat == rhs.IsFloat) &&
|
|
(this->IsSigned == rhs.IsSigned) && (this->Size == rhs.Size));
|
|
}
|
|
else
|
|
{
|
|
// Needs optimization based on platform. OSX cannot compare typeid across translation units?
|
|
return this->Type == rhs.Type;
|
|
}
|
|
}
|
|
|
|
} // namespace detail
|
|
|
|
VTKM_CONT bool UnknownArrayHandle::IsValueTypeImpl(std::type_index type) const
|
|
{
|
|
if (!this->Container)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Needs optimization based on platform. OSX cannot compare typeid across translation units?
|
|
bool typesEqual = (this->Container->ValueType == type);
|
|
|
|
// Could use optimization based on platform. OSX cannot compare typeid across translation
|
|
// units, so we have to also check the names. (Why doesn't the == operator above do that?)
|
|
// Are there other platforms that behave similarly?
|
|
if (!typesEqual)
|
|
{
|
|
typesEqual = (std::strcmp(this->Container->ValueType.name(), type.name()) == 0);
|
|
}
|
|
|
|
return typesEqual;
|
|
}
|
|
|
|
VTKM_CONT bool UnknownArrayHandle::IsStorageTypeImpl(std::type_index type) const
|
|
{
|
|
if (!this->Container)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Needs optimization based on platform. OSX cannot compare typeid across translation units?
|
|
bool typesEqual = (this->Container->StorageType == type);
|
|
|
|
// Could use optimization based on platform. OSX cannot compare typeid across translation
|
|
// units, so we have to also check the names. (Why doesn't the == operator above do that?)
|
|
// Are there other platforms that behave similarly?
|
|
if (!typesEqual)
|
|
{
|
|
typesEqual = (std::strcmp(this->Container->StorageType.name(), type.name()) == 0);
|
|
}
|
|
|
|
return typesEqual;
|
|
}
|
|
|
|
VTKM_CONT bool UnknownArrayHandle::IsBaseComponentTypeImpl(
|
|
const detail::UnknownAHComponentInfo& type) const
|
|
{
|
|
if (!this->Container)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Needs optimization based on platform. OSX cannot compare typeid across translation units?
|
|
return this->Container->BaseComponentType == type;
|
|
}
|
|
|
|
VTKM_CONT bool UnknownArrayHandle::IsValid() const
|
|
{
|
|
return static_cast<bool>(this->Container);
|
|
}
|
|
|
|
VTKM_CONT UnknownArrayHandle UnknownArrayHandle::NewInstance() const
|
|
{
|
|
UnknownArrayHandle newArray;
|
|
if (this->Container)
|
|
{
|
|
newArray.Container = this->Container->MakeNewInstance();
|
|
}
|
|
return newArray;
|
|
}
|
|
|
|
VTKM_CONT UnknownArrayHandle UnknownArrayHandle::NewInstanceBasic() const
|
|
{
|
|
UnknownArrayHandle newArray;
|
|
if (this->Container)
|
|
{
|
|
newArray.Container = this->Container->NewInstanceBasic();
|
|
}
|
|
return newArray;
|
|
}
|
|
|
|
VTKM_CONT UnknownArrayHandle UnknownArrayHandle::NewInstanceFloatBasic() const
|
|
{
|
|
UnknownArrayHandle newArray;
|
|
if (this->Container)
|
|
{
|
|
newArray.Container = this->Container->NewInstanceFloatBasic();
|
|
}
|
|
return newArray;
|
|
}
|
|
|
|
VTKM_CONT std::string UnknownArrayHandle::GetValueTypeName() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return vtkm::cont::TypeToString(this->Container->ValueType);
|
|
}
|
|
else
|
|
{
|
|
return "";
|
|
}
|
|
}
|
|
|
|
VTKM_CONT std::string UnknownArrayHandle::GetBaseComponentTypeName() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return vtkm::cont::TypeToString(this->Container->BaseComponentType);
|
|
}
|
|
else
|
|
{
|
|
return "";
|
|
}
|
|
}
|
|
|
|
VTKM_CONT std::string UnknownArrayHandle::GetStorageTypeName() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return vtkm::cont::TypeToString(this->Container->StorageType);
|
|
}
|
|
else
|
|
{
|
|
return "";
|
|
}
|
|
}
|
|
|
|
VTKM_CONT std::string UnknownArrayHandle::GetArrayTypeName() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return "vtkm::cont::ArrayHandle<" + this->GetValueTypeName() + ", " +
|
|
this->GetStorageTypeName() + ">";
|
|
}
|
|
else
|
|
{
|
|
return "";
|
|
}
|
|
}
|
|
|
|
VTKM_CONT vtkm::Id UnknownArrayHandle::GetNumberOfValues() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return this->Container->NumberOfValues(this->Container->ArrayHandlePointer);
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
vtkm::IdComponent UnknownArrayHandle::GetNumberOfComponents() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return this->Container->NumberOfComponents();
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
VTKM_CONT vtkm::IdComponent UnknownArrayHandle::GetNumberOfComponentsFlat() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
return this->Container->NumberOfComponentsFlat();
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::Allocate(vtkm::Id numValues,
|
|
vtkm::CopyFlag preserve,
|
|
vtkm::cont::Token& token) const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
this->Container->Allocate(this->Container->ArrayHandlePointer, numValues, preserve, token);
|
|
}
|
|
else
|
|
{
|
|
throw vtkm::cont::ErrorBadAllocation(
|
|
"Cannot allocate UnknownArrayHandle that does not contain an array.");
|
|
}
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::Allocate(vtkm::Id numValues, vtkm::CopyFlag preserve) const
|
|
{
|
|
vtkm::cont::Token token;
|
|
this->Allocate(numValues, preserve, token);
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::DeepCopyFrom(const vtkm::cont::UnknownArrayHandle& source)
|
|
{
|
|
if (!this->IsValid())
|
|
{
|
|
*this = source.NewInstance();
|
|
}
|
|
|
|
const_cast<const UnknownArrayHandle*>(this)->DeepCopyFrom(source);
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::DeepCopyFrom(const vtkm::cont::UnknownArrayHandle& source) const
|
|
{
|
|
if (!this->IsValid())
|
|
{
|
|
throw vtkm::cont::ErrorBadValue(
|
|
"Attempty to copy to a constant UnknownArrayHandle with no valid array.");
|
|
}
|
|
|
|
if (source.IsValueTypeImpl(this->Container->ValueType) &&
|
|
source.IsStorageTypeImpl(this->Container->StorageType))
|
|
{
|
|
this->Container->DeepCopy(source.Container->ArrayHandlePointer,
|
|
this->Container->ArrayHandlePointer);
|
|
}
|
|
else
|
|
{
|
|
vtkm::cont::internal::ArrayCopyUnknown(source, *this);
|
|
}
|
|
}
|
|
|
|
VTKM_CONT
|
|
void UnknownArrayHandle::CopyShallowIfPossible(const vtkm::cont::UnknownArrayHandle& source)
|
|
{
|
|
if (!this->IsValid())
|
|
{
|
|
*this = source;
|
|
}
|
|
else
|
|
{
|
|
const_cast<const UnknownArrayHandle*>(this)->CopyShallowIfPossible(source);
|
|
}
|
|
}
|
|
|
|
VTKM_CONT
|
|
void UnknownArrayHandle::CopyShallowIfPossible(const vtkm::cont::UnknownArrayHandle& source) const
|
|
{
|
|
if (!this->IsValid())
|
|
{
|
|
throw vtkm::cont::ErrorBadValue(
|
|
"Attempty to copy to a constant UnknownArrayHandle with no valid array.");
|
|
}
|
|
|
|
if (source.IsValueTypeImpl(this->Container->ValueType) &&
|
|
source.IsStorageTypeImpl(this->Container->StorageType))
|
|
{
|
|
this->Container->ShallowCopy(source.Container->ArrayHandlePointer,
|
|
this->Container->ArrayHandlePointer);
|
|
}
|
|
else
|
|
{
|
|
vtkm::cont::internal::ArrayCopyUnknown(source, *this);
|
|
}
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::ReleaseResourcesExecution() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
this->Container->ReleaseResourcesExecution(this->Container->ArrayHandlePointer);
|
|
}
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::ReleaseResources() const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
this->Container->ReleaseResources(this->Container->ArrayHandlePointer);
|
|
}
|
|
}
|
|
|
|
VTKM_CONT void UnknownArrayHandle::PrintSummary(std::ostream& out, bool full) const
|
|
{
|
|
if (this->Container)
|
|
{
|
|
this->Container->PrintSummary(this->Container->ArrayHandlePointer, out, full);
|
|
}
|
|
else
|
|
{
|
|
out << "null UnknownArrayHandle" << std::endl;
|
|
}
|
|
}
|
|
|
|
namespace internal
|
|
{
|
|
|
|
VTKM_CONT_EXPORT void ThrowCastAndCallException(const vtkm::cont::UnknownArrayHandle& ref,
|
|
const std::type_info& type)
|
|
{
|
|
std::ostringstream out;
|
|
out << "Could not find appropriate cast for array in CastAndCall.\n"
|
|
"Array: ";
|
|
ref.PrintSummary(out);
|
|
out << "TypeList: " << vtkm::cont::TypeToString(type) << "\n";
|
|
throw vtkm::cont::ErrorBadType(out.str());
|
|
}
|
|
|
|
} // namespace internal
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
|
|
//=============================================================================
|
|
// Specializations of serialization related classes
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
std::string SerializableTypeString<vtkm::cont::UnknownArrayHandle>::Get()
|
|
{
|
|
return "UnknownAH";
|
|
}
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
namespace mangled_diy_namespace
|
|
{
|
|
|
|
void Serialization<vtkm::cont::UnknownArrayHandle>::save(BinaryBuffer& bb,
|
|
const vtkm::cont::UnknownArrayHandle& obj)
|
|
{
|
|
vtkm::IdComponent numComponents = obj.GetNumberOfComponents();
|
|
switch (numComponents)
|
|
{
|
|
case 1:
|
|
vtkmdiy::save(bb, numComponents);
|
|
vtkmdiy::save(bb, obj.ResetTypes<vtkm::TypeListBaseC, UnknownSerializationStorage>());
|
|
break;
|
|
case 2:
|
|
vtkmdiy::save(bb, numComponents);
|
|
vtkmdiy::save(bb, obj.ResetTypes<AllVec<2>, UnknownSerializationStorage>());
|
|
break;
|
|
case 3:
|
|
vtkmdiy::save(bb, numComponents);
|
|
vtkmdiy::save(bb, obj.ResetTypes<AllVec<3>, UnknownSerializationStorage>());
|
|
break;
|
|
case 4:
|
|
vtkmdiy::save(bb, numComponents);
|
|
vtkmdiy::save(bb, obj.ResetTypes<AllVec<4>, UnknownSerializationStorage>());
|
|
break;
|
|
default:
|
|
throw vtkm::cont::ErrorBadType(
|
|
"Vectors of size " + std::to_string(numComponents) +
|
|
" are not supported for serialization from UnknownArrayHandle. "
|
|
"Try narrowing down possible types with UncertainArrayHandle.");
|
|
}
|
|
}
|
|
|
|
void Serialization<vtkm::cont::UnknownArrayHandle>::load(BinaryBuffer& bb,
|
|
vtkm::cont::UnknownArrayHandle& obj)
|
|
{
|
|
vtkm::IdComponent numComponents;
|
|
vtkmdiy::load(bb, numComponents);
|
|
|
|
vtkm::cont::UncertainArrayHandle<vtkm::TypeListBaseC, UnknownSerializationStorage> array1;
|
|
vtkm::cont::UncertainArrayHandle<AllVec<2>, UnknownSerializationStorage> array2;
|
|
vtkm::cont::UncertainArrayHandle<AllVec<3>, UnknownSerializationStorage> array3;
|
|
vtkm::cont::UncertainArrayHandle<AllVec<4>, UnknownSerializationStorage> array4;
|
|
|
|
switch (numComponents)
|
|
{
|
|
case 1:
|
|
vtkmdiy::load(bb, array1);
|
|
obj = array1;
|
|
break;
|
|
case 2:
|
|
vtkmdiy::load(bb, array2);
|
|
obj = array2;
|
|
break;
|
|
case 3:
|
|
vtkmdiy::load(bb, array3);
|
|
obj = array3;
|
|
break;
|
|
case 4:
|
|
vtkmdiy::load(bb, array4);
|
|
obj = array4;
|
|
break;
|
|
default:
|
|
throw vtkm::cont::ErrorInternal("Unexpected component size when loading UnknownArrayHandle.");
|
|
}
|
|
}
|
|
|
|
} // namespace mangled_diy_namespace
|