create_mirror[_view]

Header File: <Kokkos_Core.hpp>

A common desired use case is to have a memory allocation in GPU memory and an identical memory allocation in CPU memory, such that copying from one to another is straightforward. To satisfy this use case and others, Kokkos has facilities for dealing with “mirrors” of View. A “mirror” of a View type A is loosely defined a View type B such that Views of type B are accessible from the CPU and deep_copy() between Views of type A and B are direct. The most common functions for dealing with mirrors are create_mirror, create_mirror_view and create_mirror_view_and_copy.

Usage

The key difference between create_mirror and create_mirror_view is the following: create_mirror always allocates new memory in the specified space (shown below for host space), while create_mirror_view only allocates memory if the View to be mirrored (a_view) is not already accessible from the specified space, and otherwise simply returns a_view. Use create_mirror_view when the mirror is solely used for providing access in different execution spaces, and use create_mirror if you need the data to be independent, e.g. for having a previous and an updated version of the data.

// Both host_mirror and host_mirror_view have the correct properties for deep_copy from/to a_view
// host_mirror is guaranteed to have separately allocated memory from a_view
auto host_mirror = create_mirror(a_view);
// host_mirror_view may point to the same memory as a_view, if a_view is host-accessible
auto host_mirror_view = create_mirror_view(a_view);

// You can specify the space from which the mirror view must be accessible
auto mirror = create_mirror(memory_space_instance, a_view);
auto mirror_view = create_mirror_view(memory_space_instance, a_view);

Description

template<class ViewType>
typename ViewType::HostMirror create_mirror(ViewType const &src);

Creates a new host accessible View with the same layout and padding as src

• src: a Kokkos::View.

template<class ViewType>
typename ViewType::HostMirror create_mirror(decltype(Kokkos::WithoutInitializing), ViewType const &src);

Creates a new host accessible View with the same layout and padding as src. The new view will have uninitialized data.

• src: a Kokkos::View.

template<class Space, class ViewType>
ImplMirrorType create_mirror(Space const &space, ViewType const &src);

Creates a new View with the same layout and padding as src but with a device type of Space::device_type.

• src: a Kokkos::View.

• Space: a class meeting the requirements of ExecutionSpaceConcept() or MemorySpaceConcept()

• ImplMirrorType: an implementation defined specialization of Kokkos::View.

template<class Space, class ViewType>
ImplMirrorType create_mirror(decltype(Kokkos::WithoutInitializing), Space const &space, ViewType const &src);

Creates a new View with the same layout and padding as src but with a device type of Space::device_type. The new view will have uninitialized data.

• src: a Kokkos::View.

• Space: a class meeting the requirements of ExecutionSpaceConcept() or MemorySpaceConcept()

• ImplMirrorType: an implementation defined specialization of Kokkos::View.

template<class ViewType, class ALLOC_PROP>
auto create_mirror(ALLOC_PROP const &arg_prop, ViewType const &src);

Creates a new View with the same layout and padding as src using the View constructor properties arg_prop, e.g., Kokkos::view_alloc(Kokkos::WithoutInitializing). If arg_prop contains a memory space, a View in that space is created. Otherwise, a View in host-accessible memory is returned.

• src: a Kokkos::View.

• arg_prop: View constructor properties, e.g., Kokkos::view_alloc(Kokkos::WithoutInitializing).

  Important

  arg_prop must not include a pointer to memory, or a label, or allow padding.

template<class ViewType>
typename ViewType::HostMirror create_mirror_view(ViewType const &src);

If src is not host accessible (i.e. if SpaceAccessibility<HostSpace,ViewType::memory_space>::accessible is false) it creates a new host accessible View with the same layout and padding as src. Otherwise returns src.

• src: a Kokkos::View.

template<class ViewType>
typename ViewType::HostMirror create_mirror_view(decltype(Kokkos::WithoutInitializing), ViewType const &src);

If src is not host accessible (i.e. if SpaceAccessibility<HostSpace,ViewType::memory_space>::accessible is false) it creates a new host accessible View with the same layout and padding as src. The new view will have uninitialized data. Otherwise returns src.

• src: a Kokkos::View.

template<class Space, class ViewType>
ImplMirrorType create_mirror_view(Space const &space, ViewType const &src);

If std::is_same<typename Space::memory_space, typename ViewType::memory_space>::value is false, creates a new View with the same layout and padding as src but with a device type of Space::device_type. Otherwise returns src.

• src: a Kokkos::View.

• Space : a class meeting the requirements of ExecutionSpaceConcept() or MemorySpaceConcept()

• ImplMirrorType: an implementation defined specialization of Kokkos::View.

template<class Space, class ViewType>
ImplMirrorType create_mirror_view(decltype(Kokkos::WithoutInitializing), Space const &space, ViewType const &src);

If std::is_same<typename Space::memory_space, typename ViewType::memory_space>::value is false, creates a new View with the same layout and padding as src but with a device type of Space::device_type. The new view will have uninitialized data. Otherwise returns src.

• src: a Kokkos::View.

• Space: a class meeting the requirements of ExecutionSpaceConcept() or MemorySpaceConcept()

• ImplMirrorType: an implementation defined specialization of Kokkos::View.

template<class ViewType, class ALLOC_PROP>
auto create_mirror_view(ALLOC_PROP const &arg_prop, ViewType const &src);

If the View constructor arguments arg_prop (created by a call to Kokkos::view_alloc) include a memory space and the memory space doesn’t match the memory space of src, creates a new View in the specified memory_space. If the arg_prop don’t include a memory space and the memory space of src is not host-accessible, creates a new host-accessible View. Otherwise, src is returned. If a new View is created, the implicitly called constructor respects arg_prop and uses the same layout and padding as src.

• src: a Kokkos::View.

• arg_prop: View constructor properties, e.g., Kokkos::view_alloc(Kokkos::WithoutInitializing).

  Important

  arg_prop must not include a pointer to memory, or a label, or allow padding.

template<class Space, class ViewType>
ImplMirrorType create_mirror_view_and_copy(Space const &space, ViewType const &src);

If std::is_same<typename Space::memory_space, typename ViewType::memory_space>::value is false, creates a new Kokkos::View with the same layout and padding as src but with a device type of Space::device_type and conducts a deep_copy from src to the new view if one was created. Otherwise returns src.

• src: a Kokkos::View.

• Space: a class meeting the requirements of ExecutionSpaceConcept() or MemorySpaceConcept()

• ImplMirrorType: an implementation defined specialization of Kokkos::View.

template<class ViewType, class ALLOC_PROP>
ImplMirrorType create_mirror_view_and_copy(ALLOC_PROP const &arg_prop, ViewType const &src);

If the memory space included in the View constructor arguments arg_prop (created by a call to Kokkos::view_alloc) does not match the memory space of src, creates a new View in the specified memory space using arg_prop and the same layout and padding as src. Additionally, a deep_copy from src to the new view is executed (using the execution space contained in arg_prop if provided). Otherwise returns src.

• src: a Kokkos::View.

• arg_prop: View constructor properties, e.g., Kokkos::view_alloc(Kokkos::HostSpace{}, Kokkos::WithoutInitializing).

  Important

  arg_prop must not include a pointer to memory, or a label, or allow padding and arg_prop must include a memory space.