Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-10-05 09:59:12 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity
e1557f080b
vtk-m/vtkm/cont/testing/UnitTestTransportArrayInOut.cxx

101 lines
2.9 KiB
C++
Raw Normal View History

Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
//============================================================================
// Copyright (c) Kitware, Inc.
// All rights reserved.
// See LICENSE.txt for details.
conslidate the license statement
2019-04-15 23:24:21 +00:00
//
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
// 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/arg/TransportTagArrayInOut.h>
#include <vtkm/exec/FunctorBase.h>
#include <vtkm/cont/ArrayHandle.h>
#include <vtkm/cont/DeviceAdapter.h>
Compile transport on device Now that it is easier to select which unit tests should be compiled by a device compiler (and run on a device), allow the transport classes to be tested on actual devices rather than just the serial device.
2022-07-13 20:04:08 +00:00
#include <vtkm/cont/TryExecute.h>
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
#include <vtkm/cont/testing/Testing.h>
clang-format: apply to the entire tree
2017-05-18 14:29:41 +00:00
namespace
{
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
Switch over from static const to static constexpr where possible.
2018-02-27 14:25:25 +00:00
static constexpr vtkm::Id ARRAY_SIZE = 10;
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
clang-format: apply to the entire tree
2017-05-18 14:29:41 +00:00
template <typename PortalType>
Add TaskTiling1D/3D which use faux virtuals to reduce binary size. Redesigns the TBB and Serial backends and the vtkm::exec::Task concept so that we can re-use the same launching logic for all Worklets, instead of generating per worlet code. To keep the performance the same the TilingTask now is past a range of indices to work on, rather than a single index. Binary size reduction: WorkletTests_SERIAL old - 19MB WorkletTests_SERIAL new - 18MB WorkletTests_TBB old - 39MB WorkletTests_TBB new - 18MB libvtkAcceleratorsVTKm old - 48MB libvtkAcceleratorsVTKm new - 19MB
2016-09-12 14:30:03 +00:00
struct TestKernelInOut : public vtkm::exec::FunctorBase
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
{
PortalType Portal;
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_EXEC
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
void operator()(vtkm::Id index) const
{
Convert VTK-m over to use 'using' instead of 'typedef'
2017-06-23 18:50:34 +00:00
using ValueType = typename PortalType::ValueType;
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
ValueType inValue = this->Portal.Get(index);
this->Portal.Set(index, inValue + inValue);
}
};
clang-format: apply to the entire tree
2017-05-18 14:29:41 +00:00
template <typename Device>
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
struct TryArrayInOutType
{
clang-format: apply to the entire tree
2017-05-18 14:29:41 +00:00
template <typename T>
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
void operator()(T) const
{
T array[ARRAY_SIZE];
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
{
array[index] = TestValue(index, T());
}
Convert VTK-m over to use 'using' instead of 'typedef'
2017-06-23 18:50:34 +00:00
using ArrayHandleType = vtkm::cont::ArrayHandle<T>;
Improvements to moving data into ArrayHandle We have made several improvements to adding data into an `ArrayHandle`. ## Moving data from an `std::vector` For numerous reasons, it is convenient to define data in a `std::vector` and then wrap that into an `ArrayHandle`. It is often the case that an `std::vector` is filled and then becomes unused once it is converted to an `ArrayHandle`. In this case, what we really want is to pass the data off to the `ArrayHandle` so that the `ArrayHandle` is now managing the data and not the `std::vector`. C++11 has a mechanism to do this: move semantics. You can now pass variables to functions as an "rvalue" (right-hand value). When something is passed as an rvalue, it can pull state out of that variable and move it somewhere else. `std::vector` implements this movement so that an rvalue can be moved to another `std::vector` without actually copying the data. `make_ArrayHandle` now also takes advantage of this feature to move rvalue `std::vector`s. There is a special form of `make_ArrayHandle` named `make_ArrayHandleMove` that takes an rvalue. There is also a special overload of `make_ArrayHandle` itself that handles an rvalue `vector`. (However, using the explicit move version is better if you want to make sure the data is actually moved.) ## Make `ArrayHandle` from initalizer list A common use case for using `std::vector` (particularly in our unit tests) is to quickly add an initalizer list into an `ArrayHandle`. Now you can by simply passing an initializer list to `make_ArrayHandle`. ## Deprecated `make_ArrayHandle` with default shallow copy For historical reasons, passing an `std::vector` or a pointer to `make_ArrayHandle` does a shallow copy (i.e. `CopyFlag` defaults to `Off`). Although more efficient, this mode is inherintly unsafe, and making it the default is asking for trouble. To combat this, calling `make_ArrayHandle` without a copy flag is deprecated. In this way, if you wish to do the faster but more unsafe creation of an `ArrayHandle` you should explicitly express that. This requried quite a few changes through the VTK-m source (particularly in the tests). ## Similar changes to `Field` `vtkm::cont::Field` has a `make_Field` helper function that is similar to `make_ArrayHandle`. It also features the ability to create fields from `std::vector`s and C arrays. It also likewise had the same unsafe behavior by default of not copying from the source of the arrays. That behavior has similarly been depreciated. You now have to specify a copy flag. The ability to construct a `Field` from an initializer list of values has also been added.
2020-07-16 16:32:32 +00:00
ArrayHandleType handle = vtkm::cont::make_ArrayHandle(array, ARRAY_SIZE, vtkm::CopyFlag::Off);
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
Deprecate ArrayHandle::ExecutionTypes The newer version of `ArrayHandle` no longer supports different types of portals for different devices. Thus, the `ReadPortalType` and `WritePortalType` are sufficient for all types of portals across all devices. This significantly simplifies supporting execution objects on devices, and thus this change also includes many changes to various execution objects to remove their dependence on the device adapter tag.
2021-02-01 15:03:11 +00:00
using PortalType = typename ArrayHandleType::WritePortalType;
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
clang-format: apply to the entire tree
2017-05-18 14:29:41 +00:00
vtkm::cont::arg::Transport<vtkm::cont::arg::TransportTagArrayInOut, ArrayHandleType, Device>
transport;
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
Support using Token calling PrepareForExecution in ExecutionObject The old version of ExecutionObject (that only takes a device) is still supported, but you will get a deprecated warning if that is what is defined. Supporing this also included sending vtkm::cont::Token through the vtkm::cont::arg::Transport mechanism, which was a change that propogated through a lot of code.
2020-01-19 06:36:14 +00:00
vtkm::cont::Token token;
Add TaskTiling1D/3D which use faux virtuals to reduce binary size. Redesigns the TBB and Serial backends and the vtkm::exec::Task concept so that we can re-use the same launching logic for all Worklets, instead of generating per worlet code. To keep the performance the same the TilingTask now is past a range of indices to work on, rather than a single index. Binary size reduction: WorkletTests_SERIAL old - 19MB WorkletTests_SERIAL new - 18MB WorkletTests_TBB old - 39MB WorkletTests_TBB new - 18MB libvtkAcceleratorsVTKm old - 48MB libvtkAcceleratorsVTKm new - 19MB
2016-09-12 14:30:03 +00:00
TestKernelInOut<PortalType> kernel;
Support using Token calling PrepareForExecution in ExecutionObject The old version of ExecutionObject (that only takes a device) is still supported, but you will get a deprecated warning if that is what is defined. Supporing this also included sending vtkm::cont::Token through the vtkm::cont::arg::Transport mechanism, which was a change that propogated through a lot of code.
2020-01-19 06:36:14 +00:00
kernel.Portal = transport(handle, handle, ARRAY_SIZE, ARRAY_SIZE, token);
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
vtkm::cont::DeviceAdapterAlgorithm<Device>::Schedule(kernel, ARRAY_SIZE);
Allow a token to attach to an ArrayHandle multiple times When a single `ArrayHandle` is given to multiple arguments of a worklet dispatch, the `PrepareFor*` methods will be called multiple times with the same token. If one of them is a `PrepareForInPlace` or `PrepareForOutput`, then the two requests will deadlock. To prevent this, allow the `PrepareFor*` to happen if the same token was used previously.
2020-01-19 22:50:48 +00:00
token.DetachFromAll();
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
Use new ways to get array portal in control environment Also fix deadlocks that occur when portals are not destroyed in time.
2020-01-28 19:14:32 +00:00
typename ArrayHandleType::ReadPortalType portal = handle.ReadPortal();
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
VTKM_TEST_ASSERT(portal.GetNumberOfValues() == ARRAY_SIZE,
"Portal has wrong number of values.");
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
{
T expectedValue = TestValue(index, T()) + TestValue(index, T());
T retrievedValue = portal.Get(index);
VTKM_TEST_ASSERT(test_equal(expectedValue, retrievedValue),
"Functor did not modify in place.");
}
}
};
clang-format: apply to the entire tree
2017-05-18 14:29:41 +00:00
template <typename Device>
Compile transport on device Now that it is easier to select which unit tests should be compiled by a device compiler (and run on a device), allow the transport classes to be tested on actual devices rather than just the serial device.
2022-07-13 20:04:08 +00:00
bool TryArrayInOutTransport(Device device)
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
{
Compile transport on device Now that it is easier to select which unit tests should be compiled by a device compiler (and run on a device), allow the transport classes to be tested on actual devices rather than just the serial device.
2022-07-13 20:04:08 +00:00
std::cout << "Trying ArrayInOut transport with " << device.GetName() << std::endl;
Update lists in TypeListTag.h A new header named TypeList.h and the type lists have been redefined in this new file. All the types have been renamed from `TypeListTag*` to `TypeList*`. TypeListTag.h has been gutted to provide deprecated versions of the old type list names. There were also some other type lists that were changed from using the old `ListTagBase` to the new `List`.
2019-12-05 17:55:57 +00:00
vtkm::testing::Testing::TryTypes(TryArrayInOutType<Device>(), vtkm::TypeListCommon());
Compile transport on device Now that it is easier to select which unit tests should be compiled by a device compiler (and run on a device), allow the transport classes to be tested on actual devices rather than just the serial device.
2022-07-13 20:04:08 +00:00
return true;
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
}
void TestArrayInOutTransport()
{
Compile transport on device Now that it is easier to select which unit tests should be compiled by a device compiler (and run on a device), allow the transport classes to be tested on actual devices rather than just the serial device.
2022-07-13 20:04:08 +00:00
VTKM_TEST_ASSERT(
vtkm::cont::TryExecute([](auto device) { return TryArrayInOutTransport(device); }));
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
}
} // anonymous namespace
Testing run methods now take argc/argv to init logging/runtime device `vtkm::cont::testing` now initializes with logging enabled and support for device being passed on the command line, `vtkm::testing` only enables logging.
2019-01-01 22:19:02 +00:00
int UnitTestTransportArrayInOut(int argc, char* argv[])
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
{
Testing run methods now take argc/argv to init logging/runtime device `vtkm::cont::testing` now initializes with logging enabled and support for device being passed on the command line, `vtkm::testing` only enables logging.
2019-01-01 22:19:02 +00:00
return vtkm::cont::testing::Testing::Run(TestArrayInOutTransport, argc, argv);
Add in-place (in-out) arrays to worklets. Previously, all arrays passed to worklets were designated as either input or output. No in-place operation was permitted. This change adds the FieldInOut tag for ControlSignature in both WorkletMapField and WorkletMapTopology that allows you to read and write from the same array.
2015-08-12 18:58:53 +00:00
}
Reference in New Issue Copy Permalink