// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // SPDX-FileCopyrightText: Copyright Contributors to the Kokkos project /// \file Kokkos_DynRankView.hpp /// \brief Declaration and definition of Kokkos::DynRankView. /// /// This header file declares and defines Kokkos::DynRankView and its /// related nonmember functions. #ifndef KOKKOS_DYNRANKVIEW_HPP #define KOKKOS_DYNRANKVIEW_HPP #ifndef KOKKOS_IMPL_PUBLIC_INCLUDE #define KOKKOS_IMPL_PUBLIC_INCLUDE #define KOKKOS_IMPL_PUBLIC_INCLUDE_NOTDEFINED_DYNRANKVIEW #endif #include #ifdef KOKKOS_ENABLE_EXPERIMENTAL_CXX20_MODULES import kokkos.core; import kokkos.core_impl; #else #include #endif #include #include #include namespace Kokkos { template class DynRankView; // forward declare namespace Impl { template struct ViewDataTypeFromRank { using type = typename ViewDataTypeFromRank::type*; }; template struct ViewDataTypeFromRank { using type = T; }; template KOKKOS_FUNCTION View::type, Args...> as_view_of_rank_n(DynRankView v); // TODO: Replace this specialized with a bool template struct DynRankDimTraits { enum : size_t { unspecified = KOKKOS_INVALID_INDEX }; // Compute the rank of the view from the nonzero dimension arguments. KOKKOS_INLINE_FUNCTION static size_t computeRank(const size_t N0, const size_t N1, const size_t N2, const size_t N3, const size_t N4, const size_t N5, const size_t N6, const size_t N7) { return (N0 != unspecified) + (N1 != unspecified) + (N2 != unspecified) + (N3 != unspecified) + (N4 != unspecified) + (N5 != unspecified) + (N6 != unspecified) + (N7 != unspecified); } // Compute the rank of the view from the nonzero layout arguments. template KOKKOS_INLINE_FUNCTION static size_t computeRank(const Layout& layout) { return computeRank(layout.dimension[0], layout.dimension[1], layout.dimension[2], layout.dimension[3], layout.dimension[4], layout.dimension[5], layout.dimension[6], layout.dimension[7]); } // Extra overload to match that for specialize types v2 template KOKKOS_INLINE_FUNCTION static size_t computeRank( const Kokkos::Impl::ViewCtorProp& /* prop */, const Layout& layout) { return computeRank(layout); } // Create the layout for the rank-7 view. // Because the underlying View is rank-7, preserve "unspecified" for // dimension 8. // Non-strided Layout template KOKKOS_INLINE_FUNCTION static std::enable_if_t< (std::is_same_v || std::is_same_v), Layout> createLayout(const Layout& layout, [[maybe_unused]] size_t new_rank = unspecified) { Layout new_layout( layout.dimension[0] != unspecified ? layout.dimension[0] : 1, layout.dimension[1] != unspecified ? layout.dimension[1] : 1, layout.dimension[2] != unspecified ? layout.dimension[2] : 1, layout.dimension[3] != unspecified ? layout.dimension[3] : 1, layout.dimension[4] != unspecified ? layout.dimension[4] : 1, layout.dimension[5] != unspecified ? layout.dimension[5] : 1, layout.dimension[6] != unspecified ? layout.dimension[6] : 1, layout.dimension[7] != unspecified ? layout.dimension[7] : unspecified); // In order to have a valid LayoutRight stride we need to set it to the // dimension[6] for the rank-7 view coming out of here. Only if the original // layout was already rank-7 we can preserve the stride. if constexpr (std::is_same_v) { if (layout.dimension[6] == unspecified) { new_layout.stride = unspecified; } else { new_layout.stride = layout.stride; } } else new_layout.stride = layout.stride; if constexpr (std::is_same_v) { if (new_rank != unspecified && new_rank > 0 && layout.dimension[new_rank - 1] == layout.stride) new_layout.stride = unspecified; } return new_layout; } // LayoutStride template KOKKOS_INLINE_FUNCTION static std::enable_if_t< (std::is_same_v), Layout> createLayout(const Layout& layout, [[maybe_unused]] size_t new_rank = unspecified) { return Layout( layout.dimension[0] != unspecified ? layout.dimension[0] : 1, layout.stride[0], layout.dimension[1] != unspecified ? layout.dimension[1] : 1, layout.stride[1], layout.dimension[2] != unspecified ? layout.dimension[2] : 1, layout.stride[2], layout.dimension[3] != unspecified ? layout.dimension[3] : 1, layout.stride[3], layout.dimension[4] != unspecified ? layout.dimension[4] : 1, layout.stride[4], layout.dimension[5] != unspecified ? layout.dimension[5] : 1, layout.stride[5], layout.dimension[6] != unspecified ? layout.dimension[6] : 1, layout.stride[6], layout.dimension[7] != unspecified ? layout.dimension[7] : unspecified, layout.stride[7]); } // Extra overload to match that for specialize types template KOKKOS_INLINE_FUNCTION static std::enable_if_t< (std::is_same_v || std::is_same_v || std::is_same_v), typename Traits::array_layout> createLayout([[maybe_unused]] const Kokkos::Impl::ViewCtorProp& prop, typename Traits::array_layout layout) { // FIXME_SACADO this is only needed for special extra int treatment if constexpr (Traits::impl_is_customized && !Kokkos::Impl::ViewCtorProp::has_accessor_arg) { auto rank = computeRank(prop, layout) - 1; layout.dimension[rank] = unspecified; } return createLayout(layout); } // Create a view from the given dimension arguments. // This is only necessary because the shmem constructor doesn't take a layout. // NDE shmem View's are not compatible with the added view_alloc value_type // / fad_dim deduction functionality template static ViewType createView(const ViewArg& arg, const size_t N0, const size_t N1, const size_t N2, const size_t N3, const size_t N4, const size_t N5, const size_t N6, const size_t N7) { return ViewType(arg, N0 != unspecified ? N0 : 1, N1 != unspecified ? N1 : 1, N2 != unspecified ? N2 : 1, N3 != unspecified ? N3 : 1, N4 != unspecified ? N4 : 1, N5 != unspecified ? N5 : 1, N6 != unspecified ? N6 : 1, N7 != unspecified ? N7 : 1); } }; // Non-strided Layout template KOKKOS_INLINE_FUNCTION std::enable_if_t< (std::is_same_v || std::is_same_v)&&std::is_integral_v, Layout> reconstructLayout(const Layout& layout, iType dynrank) { return Layout(dynrank > 0 ? layout.dimension[0] : KOKKOS_INVALID_INDEX, dynrank > 1 ? layout.dimension[1] : KOKKOS_INVALID_INDEX, dynrank > 2 ? layout.dimension[2] : KOKKOS_INVALID_INDEX, dynrank > 3 ? layout.dimension[3] : KOKKOS_INVALID_INDEX, dynrank > 4 ? layout.dimension[4] : KOKKOS_INVALID_INDEX, dynrank > 5 ? layout.dimension[5] : KOKKOS_INVALID_INDEX, dynrank > 6 ? layout.dimension[6] : KOKKOS_INVALID_INDEX, dynrank > 7 ? layout.dimension[7] : KOKKOS_INVALID_INDEX); } // LayoutStride template KOKKOS_INLINE_FUNCTION std::enable_if_t< (std::is_same_v)&&std::is_integral_v, Layout> reconstructLayout(const Layout& layout, iType dynrank) { return Layout(dynrank > 0 ? layout.dimension[0] : KOKKOS_INVALID_INDEX, dynrank > 0 ? layout.stride[0] : (0), dynrank > 1 ? layout.dimension[1] : KOKKOS_INVALID_INDEX, dynrank > 1 ? layout.stride[1] : (0), dynrank > 2 ? layout.dimension[2] : KOKKOS_INVALID_INDEX, dynrank > 2 ? layout.stride[2] : (0), dynrank > 3 ? layout.dimension[3] : KOKKOS_INVALID_INDEX, dynrank > 3 ? layout.stride[3] : (0), dynrank > 4 ? layout.dimension[4] : KOKKOS_INVALID_INDEX, dynrank > 4 ? layout.stride[4] : (0), dynrank > 5 ? layout.dimension[5] : KOKKOS_INVALID_INDEX, dynrank > 5 ? layout.stride[5] : (0), dynrank > 6 ? layout.dimension[6] : KOKKOS_INVALID_INDEX, dynrank > 6 ? layout.stride[6] : (0), dynrank > 7 ? layout.dimension[7] : KOKKOS_INVALID_INDEX, dynrank > 7 ? layout.stride[7] : (0)); } /** \brief Debug bounds-checking routines */ // Enhanced debug checking - most infrastructure matches that of functions in // Kokkos_ViewMapping; additional checks for extra arguments beyond rank are 0 template KOKKOS_INLINE_FUNCTION bool dyn_rank_view_verify_operator_bounds( const iType0&, const MapType&) { return true; } template KOKKOS_INLINE_FUNCTION bool dyn_rank_view_verify_operator_bounds( const iType0& rank, const MapType& map, const iType1& i, Args... args) { if (static_cast(R) < rank) { return (size_t(i) < map.extent(R)) && dyn_rank_view_verify_operator_bounds(rank, map, args...); } else if (i != 0) { Kokkos::printf( "DynRankView Debug Bounds Checking Error: at rank %u\n Extra " "arguments beyond the rank must be zero \n", R); return (false) && dyn_rank_view_verify_operator_bounds(rank, map, args...); } else { return (true) && dyn_rank_view_verify_operator_bounds(rank, map, args...); } } template inline void dyn_rank_view_error_operator_bounds(char*, int, const MapType&) {} template inline void dyn_rank_view_error_operator_bounds(char* buf, int len, const MapType& map, const iType& i, Args... args) { const int n = snprintf( buf, len, " %ld < %ld %c", static_cast(i), static_cast(map.extent(R)), (sizeof...(Args) ? ',' : ')')); dyn_rank_view_error_operator_bounds(buf + n, len - n, map, args...); } // op_rank = rank of the operator version that was called template KOKKOS_INLINE_FUNCTION void dyn_rank_view_verify_operator_bounds( const iType0& op_rank, const iType1& rank, const Kokkos::Impl::SharedAllocationTracker& tracker, const MapType& map, Args... args) { if (static_cast(rank) > op_rank) { Kokkos::abort( "DynRankView Bounds Checking Error: Need at least rank arguments to " "the operator()"); } if (!dyn_rank_view_verify_operator_bounds<0>(rank, map, args...)) { KOKKOS_IF_ON_HOST( (enum {LEN = 1024}; char buffer[LEN]; const std::string label = tracker.template get_label(); int n = snprintf(buffer, LEN, "DynRankView bounds error of view %s (", label.c_str()); dyn_rank_view_error_operator_bounds<0>(buffer + n, LEN - n, map, args...); Kokkos::Impl::throw_runtime_exception(std::string(buffer));)) KOKKOS_IF_ON_DEVICE( ((void)tracker; Kokkos::abort("DynRankView bounds error");)) } } /** \brief Assign compatible default mappings */ struct ViewToDynRankViewTag {}; } // namespace Impl /* \class DynRankView * \brief Container that creates a Kokkos view with rank determined at runtime. * Essentially this is a rank 7 view * * Changes from View * 1. The rank of the DynRankView is returned by the method rank() * 2. Max rank of a DynRankView is 7 * 3. subview called with 'subview(...)' or 'subdynrankview(...)' (backward * compatibility) * 4. Every subview is returned with LayoutStride * 5. Copy and Copy-Assign View to DynRankView * 6. deep_copy between Views and DynRankViews * 7. rank( view ); returns the rank of View or DynRankView * */ template struct is_dyn_rank_view : public std::false_type {}; template struct is_dyn_rank_view> : public std::true_type { }; template inline constexpr bool is_dyn_rank_view_v = is_dyn_rank_view::value; // Inherit privately from View, this way we don't import anything funky // for example the rank member vs the rank() function of DynRankView template class DynRankView : private View { static_assert(!std::is_array_v && !std::is_pointer_v, "Cannot template DynRankView with array or pointer datatype - " "must be pod"); private: template friend class DynRankView; size_t m_rank{}; public: using drvtraits = ViewTraits; using view_type = View; private: using drdtraits = Impl::DynRankDimTraits< std::conditional_t>; public: // typedefs from ViewTraits, overriden using data_type = typename drvtraits::data_type; using const_data_type = typename drvtraits::const_data_type; using non_const_data_type = typename drvtraits::non_const_data_type; // typedefs from ViewTraits not overriden using value_type = typename view_type::value_type; using const_value_type = typename view_type::const_value_type; using non_const_value_type = typename view_type::non_const_value_type; using traits = typename view_type::traits; using array_layout = typename view_type::array_layout; using execution_space = typename view_type::execution_space; using memory_space = typename view_type::memory_space; using device_type = typename view_type::device_type; using memory_traits = typename view_type::memory_traits; using host_mirror_space = typename view_type::host_mirror_space; using size_type = typename view_type::size_type; using reference_type = typename view_type::reference_type; using pointer_type = typename view_type::pointer_type; #ifdef KOKKOS_ENABLE_DEPRECATED_CODE_5 using scalar_array_type KOKKOS_DEPRECATED_WITH_COMMENT( "Use data_type instead.") = data_type; using const_scalar_array_type KOKKOS_DEPRECATED_WITH_COMMENT( "Use const_data_type instead.") = const_data_type; using non_const_scalar_array_type KOKKOS_DEPRECATED_WITH_COMMENT( "Use non_const_data_type instead.") = non_const_data_type; #endif // typedefs in View for mdspan compatibility // cause issues with MSVC+CUDA // using layout_type = typename view_type::layout_type; using index_type = typename view_type::index_type; using element_type = typename view_type::element_type; using rank_type = typename view_type::rank_type; using reference = reference_type; using data_handle_type = pointer_type; using accessor_type = typename view_type::accessor_type; using mapping_type = typename view_type::mapping_type; KOKKOS_FUNCTION view_type& DownCast() const { return (view_type&)(*this); } // FIXME: this function make NO sense, the above one already is marked const // Maybe one would want to get back a view of const?? KOKKOS_FUNCTION const view_type& ConstDownCast() const { return (const view_type&)(*this); } // FIXME: deprecate DownCast in favor of to_view // KOKKOS_FUNCTION // view_type to_view() const { return *this; } // Types below - at least host_mirror_type requires the value_type, NOT the // rank 7 data_type of the traits /** \brief Compatible view of array of scalar types */ using type = DynRankView< typename drvtraits::data_type, typename drvtraits::array_layout, typename drvtraits::device_type, typename drvtraits::memory_traits>; #ifdef KOKKOS_ENABLE_DEPRECATED_CODE_5 /** \brief Compatible view of array of scalar types */ using array_type KOKKOS_DEPRECATED_WITH_COMMENT("Use type instead.") = type; #endif /** \brief Compatible view of const data type */ using const_type = DynRankView< typename drvtraits::const_data_type, typename drvtraits::array_layout, typename drvtraits::device_type, typename drvtraits::memory_traits>; /** \brief Compatible view of non-const data type */ using non_const_type = DynRankView< typename drvtraits::non_const_data_type, typename drvtraits::array_layout, typename drvtraits::device_type, typename drvtraits::memory_traits>; /** \brief Compatible host mirror view */ using host_mirror_type = DynRankView; //---------------------------------------- // Domain rank and extents // enum { Rank = map_type::Rank }; //Will be dyn rank of 7 always, keep the // enum? //---------------------------------------- /* Deprecate all 'dimension' functions in favor of * ISO/C++ vocabulary 'extent'. */ //---------------------------------------- private: enum { is_layout_left = std::is_same_v, is_layout_right = std::is_same_v, is_layout_stride = std::is_same_v, is_default_map = (is_layout_left || is_layout_right || is_layout_stride), is_default_access = is_default_map && std::is_same_v }; // Bounds checking macros #if defined(KOKKOS_ENABLE_DEBUG_BOUNDS_CHECK) // rank of the calling operator - included as first argument in ARG #define KOKKOS_IMPL_VIEW_OPERATOR_VERIFY(ARG) \ Kokkos::Impl::runtime_check_memory_access_violation< \ typename traits::memory_space>( \ "Kokkos::DynRankView ERROR: attempt to access inaccessible memory " \ "space"); \ Kokkos::Impl::dyn_rank_view_verify_operator_bounds< \ typename traits::memory_space> \ ARG; #else #define KOKKOS_IMPL_VIEW_OPERATOR_VERIFY(ARG) \ Kokkos::Impl::runtime_check_memory_access_violation< \ typename traits::memory_space>( \ "Kokkos::DynRankView ERROR: attempt to access inaccessible memory " \ "space"); #endif public: KOKKOS_FUNCTION constexpr unsigned rank() const { return m_rank; } using view_type::accessor; // FIXME: not tested using view_type::data; using view_type::extent; using view_type::extent_int; // FIXME: not tested using view_type::extents; using view_type::is_allocated; using view_type::label; using view_type::mapping; // FIXME: not tested using view_type::size; using view_type::span; using view_type::span_is_contiguous; // FIXME: not tested using view_type::stride; // FIXME: not tested using view_type::use_count; #ifdef KOKKOS_ENABLE_CUDA KOKKOS_FUNCTION reference_type operator()(index_type i0 = 0, index_type i1 = 0, index_type i2 = 0, index_type i3 = 0, index_type i4 = 0, index_type i5 = 0, index_type i6 = 0) const { return view_type::operator()(i0, i1, i2, i3, i4, i5, i6); } #else // Adding shortcut operators for rank-0 to rank-3 for default layouts // and access modalities. // This removes performance overhead for always using rank-7 mapping. // See https://github.com/kokkos/kokkos/issues/7604 // When boundschecking is enabled we still go through the underlying // rank-7 View to leverage the error checks there. KOKKOS_FUNCTION reference_type operator()() const { #ifdef KOKKOS_ENABLE_DEBUG if (rank() != 0u) Kokkos::abort( "DynRankView rank 0 operator() called with invalid number of " "arguments."); #endif #ifndef KOKKOS_ENABLE_DEBUG_BOUNDS_CHECK if constexpr (is_default_access) { return view_type::data()[0]; } else #endif { return view_type::operator()(0, 0, 0, 0, 0, 0, 0); } } KOKKOS_FUNCTION reference_type operator()(index_type i0) const { #ifdef KOKKOS_ENABLE_DEBUG // FIXME: Should be equal, only access(...) allows mismatch of rank and // index args if (rank() > 1u) Kokkos::abort( "DynRankView rank 1 operator() called with invalid number of " "arguments."); #endif #ifndef KOKKOS_ENABLE_DEBUG_BOUNDS_CHECK if constexpr (is_default_access) { if constexpr (is_layout_stride) { return view_type::data()[i0 * view_type::stride(0)]; } else { return view_type::data()[i0]; } } else #endif { return view_type::operator()(i0, 0, 0, 0, 0, 0, 0); } } KOKKOS_FUNCTION reference_type operator()(index_type i0, index_type i1) const { #ifdef KOKKOS_ENABLE_DEBUG // FIXME: Should be equal, only access(...) allows mismatch of rank and // index args if (rank() > 2u) Kokkos::abort( "DynRankView rank 2 operator() called with invalid number of " "arguments."); #endif #ifndef KOKKOS_ENABLE_DEBUG_BOUNDS_CHECK if constexpr (is_default_access) { if constexpr (is_layout_left) { return view_type::data()[i0 + i1 * view_type::stride(1)]; } else if constexpr (is_layout_right) { return view_type::data()[i0 * view_type::extent(1) + i1]; } else { return view_type::data()[i0 * view_type::stride(0) + i1 * view_type::stride(1)]; } } else #endif { return view_type::operator()(i0, i1, 0, 0, 0, 0, 0); } } KOKKOS_FUNCTION reference_type operator()(index_type i0, index_type i1, index_type i2) const { #ifdef KOKKOS_ENABLE_DEBUG // FIXME: Should be equal, only access(...) allows mismatch of rank and // index args if (rank() > 3u) Kokkos::abort( "DynRankView rank 3 operator() called with invalid number of " "arguments."); #endif #ifndef KOKKOS_ENABLE_DEBUG_BOUNDS_CHECK if constexpr (is_default_access) { if constexpr (is_layout_left) { return view_type::data()[i0 + view_type::stride(1) * (i1 + i2 * view_type::extent(1))]; } else if constexpr (is_layout_right) { return view_type::data()[(i0 * view_type::extent(1) + i1) * view_type::extent(2) + i2]; } else { return view_type::data()[i0 * view_type::stride(0) + i1 * view_type::stride(1) + i2 * view_type::stride(2)]; } } else #endif { return view_type::operator()(i0, i1, i2, 0, 0, 0, 0); } } KOKKOS_FUNCTION reference_type operator()(index_type i0, index_type i1, index_type i2, index_type i3, index_type i4 = 0, index_type i5 = 0, index_type i6 = 0) const { return view_type::operator()(i0, i1, i2, i3, i4, i5, i6); } #endif KOKKOS_FUNCTION reference_type operator[](index_type i0) const { #ifdef KOKKOS_ENABLE_DEBUG if (rank() != 1u) Kokkos::abort("DynRankView operator[] can only be used for rank-1"); #endif return view_type::operator()(i0, 0, 0, 0, 0, 0, 0); } KOKKOS_FUNCTION reference_type access(index_type i0 = 0, index_type i1 = 0, index_type i2 = 0, index_type i3 = 0, index_type i4 = 0, index_type i5 = 0, index_type i6 = 0) const { return view_type::operator()(i0, i1, i2, i3, i4, i5, i6); } //---------------------------------------- // Standard constructor, destructor, and assignment operators... KOKKOS_DEFAULTED_FUNCTION DynRankView() = default; //---------------------------------------- // Compatible view copy constructor and assignment // may assign unmanaged from managed. // Make this conditionally explicit? template KOKKOS_FUNCTION DynRankView(const DynRankView& rhs) : view_type(rhs), m_rank(rhs.m_rank) {} KOKKOS_INLINE_FUNCTION DynRankView(view_type rhs, size_t new_rank) : view_type(rhs), m_rank(new_rank) { if (new_rank > view_type::rank()) Kokkos::abort( "Attempting to construct DynRankView from View and new rank, with " "the new rank being too large."); bool invalid_extent = false; for (size_t r = new_rank; r < view_type::rank(); r++) if (rhs.extent(r) != 1) invalid_extent = true; if (invalid_extent) Kokkos::abort( "Attempting to construct DynRankView from View with incompatible " "extents. (Extents for dimensions larger than the provided rank are " "not equal to 1)."); } template KOKKOS_FUNCTION DynRankView& operator=(const DynRankView& rhs) { view_type::operator=(rhs); m_rank = rhs.m_rank; return *this; } private: template KOKKOS_FUNCTION typename view_type::extents_type create_rank7_extents( const Ext& ext) { return typename view_type::extents_type( ext.rank() > 0 ? ext.extent(0) : 1, ext.rank() > 1 ? ext.extent(1) : 1, ext.rank() > 2 ? ext.extent(2) : 1, ext.rank() > 3 ? ext.extent(3) : 1, ext.rank() > 4 ? ext.extent(4) : 1, ext.rank() > 5 ? ext.extent(5) : 1, ext.rank() > 6 ? ext.extent(6) : 1); } public: // Copy/Assign View to DynRankView template KOKKOS_INLINE_FUNCTION DynRankView(const View& rhs, size_t new_rank) : view_type(rhs.data_handle(), Impl::mapping_from_array_layout< typename view_type::mdspan_type::mapping_type>( drdtraits::createLayout(rhs.layout(), new_rank)), rhs.accessor()), m_rank(new_rank) { if (new_rank > View::rank()) Kokkos::abort( "Attempting to construct DynRankView from View and new rank, with " "the new rank being too large."); } template KOKKOS_INLINE_FUNCTION DynRankView& operator=(const View& rhs) { view_type::operator=( view_type(rhs.data_handle(), Impl::mapping_from_array_layout< typename view_type::mdspan_type::mapping_type>( drdtraits::createLayout(rhs.layout(), rhs.rank())), rhs.accessor())); m_rank = rhs.rank(); return *this; } template KOKKOS_FUNCTION DynRankView(const View& rhs) : DynRankView(rhs, View::rank()) {} //---------------------------------------- // Allocation tracking properties //---------------------------------------- // Allocation according to allocation properties and array layout // unused arg_layout dimensions must be set to KOKKOS_INVALID_INDEX so that // rank deduction can properly take place // We need two variants to avoid calling host function from host device // function warnings private: // Need a host only and a host/device function to deal with labels. template KOKKOS_FUNCTION auto attach_accessor_arg_if_needed( const Impl::ViewCtorProp& arg_prop, std::enable_if_t<((!std::is_same_v)&&...), const typename traits::array_layout&> layout) { if constexpr (traits::impl_is_customized && !Impl::ViewCtorProp::has_accessor_arg) { int r = 0; while (r < 8 && layout.dimension[r] != KOKKOS_INVALID_INDEX) r++; // Can't use with_properties_if_unset since its a host only function! return view_wrap( static_cast&>(arg_prop).value..., Impl::AccessorArg_t{r > 0 ? size_t(layout.dimension[r - 1]) : 0ul}); } else { return arg_prop; } } template auto attach_accessor_arg_if_needed( const Impl::ViewCtorProp& arg_prop, std::enable_if_t<(std::is_same_v || ...), const typename traits::array_layout&> layout) { if constexpr (traits::impl_is_customized && !Impl::ViewCtorProp::has_accessor_arg) { int r = 0; while (r < 8 && layout.dimension[r] != KOKKOS_INVALID_INDEX) r++; // Could use with_properties_if_unset, but rather keep same as above. return view_alloc( static_cast&>(arg_prop).value..., Impl::AccessorArg_t{r > 0 ? size_t(layout.dimension[r - 1]) : 0ul}); } else { return arg_prop; } } public: template explicit KOKKOS_FUNCTION DynRankView( const Kokkos::Impl::ViewCtorProp& arg_prop, std::enable_if_t::has_pointer, typename traits::array_layout const&> arg_layout) : view_type(attach_accessor_arg_if_needed(arg_prop, arg_layout), drdtraits::template createLayout(arg_prop, arg_layout)), m_rank(drdtraits::computeRank(arg_prop, arg_layout) - (traits::impl_is_customized && !Kokkos::Impl::ViewCtorProp::has_accessor_arg ? 1 : 0)) {} template explicit DynRankView( const Kokkos::Impl::ViewCtorProp& arg_prop, std::enable_if_t::has_pointer, typename traits::array_layout const&> arg_layout) : view_type(attach_accessor_arg_if_needed(arg_prop, arg_layout), drdtraits::template createLayout(arg_prop, arg_layout)), m_rank(drdtraits::computeRank(arg_prop, arg_layout) - (traits::impl_is_customized && !Kokkos::Impl::ViewCtorProp::has_accessor_arg ? 1 : 0)) {} //---------------------------------------- // Constructor(s) // Simple dimension-only layout // We need two variants to avoid calling host function from host device // function warnings template explicit KOKKOS_FUNCTION DynRankView( const Kokkos::Impl::ViewCtorProp& arg_prop, std::enable_if_t::has_pointer, const size_t> arg_N0 = KOKKOS_INVALID_INDEX, const size_t arg_N1 = KOKKOS_INVALID_INDEX, const size_t arg_N2 = KOKKOS_INVALID_INDEX, const size_t arg_N3 = KOKKOS_INVALID_INDEX, const size_t arg_N4 = KOKKOS_INVALID_INDEX, const size_t arg_N5 = KOKKOS_INVALID_INDEX, const size_t arg_N6 = KOKKOS_INVALID_INDEX, const size_t arg_N7 = KOKKOS_INVALID_INDEX) : DynRankView(arg_prop, typename traits::array_layout( arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6, arg_N7)) {} template explicit DynRankView( const Kokkos::Impl::ViewCtorProp& arg_prop, std::enable_if_t::has_pointer, const size_t> arg_N0 = KOKKOS_INVALID_INDEX, const size_t arg_N1 = KOKKOS_INVALID_INDEX, const size_t arg_N2 = KOKKOS_INVALID_INDEX, const size_t arg_N3 = KOKKOS_INVALID_INDEX, const size_t arg_N4 = KOKKOS_INVALID_INDEX, const size_t arg_N5 = KOKKOS_INVALID_INDEX, const size_t arg_N6 = KOKKOS_INVALID_INDEX, const size_t arg_N7 = KOKKOS_INVALID_INDEX) : DynRankView(arg_prop, typename traits::array_layout( arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6, arg_N7)) {} // Allocate with label and layout template explicit inline DynRankView( const Label& arg_label, std::enable_if_t::value, typename traits::array_layout> const& arg_layout) : DynRankView(Kokkos::Impl::ViewCtorProp(arg_label), arg_layout) {} // Allocate label and layout, must disambiguate from subview constructor template explicit inline DynRankView( const Label& arg_label, std::enable_if_t::value, const size_t> arg_N0 = KOKKOS_INVALID_INDEX, const size_t arg_N1 = KOKKOS_INVALID_INDEX, const size_t arg_N2 = KOKKOS_INVALID_INDEX, const size_t arg_N3 = KOKKOS_INVALID_INDEX, const size_t arg_N4 = KOKKOS_INVALID_INDEX, const size_t arg_N5 = KOKKOS_INVALID_INDEX, const size_t arg_N6 = KOKKOS_INVALID_INDEX, const size_t arg_N7 = KOKKOS_INVALID_INDEX) : DynRankView( Kokkos::Impl::ViewCtorProp(arg_label), typename traits::array_layout(arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6, arg_N7)) {} //---------------------------------------- // Memory span required to wrap these dimensions. static constexpr size_t required_allocation_size( const size_t arg_N0 = 1, const size_t arg_N1 = 1, const size_t arg_N2 = 1, const size_t arg_N3 = 1, const size_t arg_N4 = 1, const size_t arg_N5 = 1, const size_t arg_N6 = 1, [[maybe_unused]] const size_t arg_N7 = KOKKOS_INVALID_INDEX) { #if !defined(KOKKOS_ENABLE_DEPRECATED_CODE_5) KOKKOS_ASSERT(arg_N7 == KOKKOS_INVALID_INDEX && "DynRankView: Cannot allocate 8 dimensions!"); #endif return view_type::required_allocation_size(arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6); } explicit KOKKOS_FUNCTION DynRankView( typename view_type::pointer_type arg_ptr, const size_t arg_N0 = KOKKOS_INVALID_INDEX, const size_t arg_N1 = KOKKOS_INVALID_INDEX, const size_t arg_N2 = KOKKOS_INVALID_INDEX, const size_t arg_N3 = KOKKOS_INVALID_INDEX, const size_t arg_N4 = KOKKOS_INVALID_INDEX, const size_t arg_N5 = KOKKOS_INVALID_INDEX, const size_t arg_N6 = KOKKOS_INVALID_INDEX, const size_t arg_N7 = KOKKOS_INVALID_INDEX) : DynRankView( Kokkos::Impl::ViewCtorProp( arg_ptr), arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6, arg_N7) {} explicit KOKKOS_FUNCTION DynRankView( typename view_type::pointer_type arg_ptr, typename traits::array_layout& arg_layout) : DynRankView( Kokkos::Impl::ViewCtorProp( arg_ptr), arg_layout) {} //---------------------------------------- // Shared scratch memory constructor // Note: We must pass 7 valid args since view_type is rank 7 static inline size_t shmem_size( const size_t arg_N0 = 1, const size_t arg_N1 = 1, const size_t arg_N2 = 1, const size_t arg_N3 = 1, const size_t arg_N4 = 1, const size_t arg_N5 = 1, const size_t arg_N6 = 1, const size_t arg_N7 = KOKKOS_INVALID_INDEX) { return view_type::shmem_size(arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6, arg_N7); } explicit KOKKOS_FUNCTION DynRankView( const typename traits::execution_space::scratch_memory_space& arg_space, const typename traits::array_layout& arg_layout) : view_type(arg_space, drdtraits::createLayout(arg_layout)), m_rank(drdtraits::computeRank(arg_layout)) {} explicit KOKKOS_FUNCTION DynRankView( const typename traits::execution_space::scratch_memory_space& arg_space, const size_t arg_N0 = KOKKOS_INVALID_INDEX, const size_t arg_N1 = KOKKOS_INVALID_INDEX, const size_t arg_N2 = KOKKOS_INVALID_INDEX, const size_t arg_N3 = KOKKOS_INVALID_INDEX, const size_t arg_N4 = KOKKOS_INVALID_INDEX, const size_t arg_N5 = KOKKOS_INVALID_INDEX, const size_t arg_N6 = KOKKOS_INVALID_INDEX, const size_t arg_N7 = KOKKOS_INVALID_INDEX) : DynRankView(arg_space, typename traits::array_layout( arg_N0, arg_N1, arg_N2, arg_N3, arg_N4, arg_N5, arg_N6, arg_N7)) {} KOKKOS_FUNCTION constexpr auto layout() const { switch (rank()) { case 0: return Impl::as_view_of_rank_n<0>(*this).layout(); case 1: return Impl::as_view_of_rank_n<1>(*this).layout(); case 2: return Impl::as_view_of_rank_n<2>(*this).layout(); case 3: return Impl::as_view_of_rank_n<3>(*this).layout(); case 4: return Impl::as_view_of_rank_n<4>(*this).layout(); case 5: return Impl::as_view_of_rank_n<5>(*this).layout(); case 6: return Impl::as_view_of_rank_n<6>(*this).layout(); case 7: return Impl::as_view_of_rank_n<7>(*this).layout(); default: KOKKOS_IF_ON_HOST( Kokkos::abort( std::string( "Calling DynRankView::layout on DRV of unexpected rank " + std::to_string(rank())) .c_str());) KOKKOS_IF_ON_DEVICE( Kokkos::abort( "Calling DynRankView::layout on DRV of unexpected rank");) } // control flow should never reach here return view_type::layout(); } }; template KOKKOS_FUNCTION constexpr unsigned rank(const DynRankView& DRV) { return DRV.rank(); } // needed for transition to common constexpr method in view and dynrankview // to return rank template auto subdynrankview(const DynRankView& drv, SubArg0 arg0 = SubArg0{}, SubArg1 arg1 = SubArg1{}, SubArg2 arg2 = SubArg2{}, SubArg3 arg3 = SubArg3{}, SubArg4 arg4 = SubArg4{}, SubArg5 arg5 = SubArg5{}, SubArg6 arg6 = SubArg6{}) { return subdynrankview(drv, Impl::convert_to_kokkos_pair_if_std_pair(arg0), Impl::convert_to_kokkos_pair_if_std_pair(arg1), Impl::convert_to_kokkos_pair_if_std_pair(arg2), Impl::convert_to_kokkos_pair_if_std_pair(arg3), Impl::convert_to_kokkos_pair_if_std_pair(arg4), Impl::convert_to_kokkos_pair_if_std_pair(arg5), Impl::convert_to_kokkos_pair_if_std_pair(arg6)); } // std::pair isn't device-compatible template requires(!Impl::ContainsStdPair) KOKKOS_INLINE_FUNCTION auto subdynrankview( const DynRankView& drv, SubArg0 arg0 = SubArg0{}, SubArg1 arg1 = SubArg1{}, SubArg2 arg2 = SubArg2{}, SubArg3 arg3 = SubArg3{}, SubArg4 arg4 = SubArg4{}, SubArg5 arg5 = SubArg5{}, SubArg6 arg6 = SubArg6{}) { auto sub = subview(drv.DownCast(), arg0, arg1, arg2, arg3, arg4, arg5, arg6); using sub_t = decltype(sub); size_t new_rank = (drv.rank() > 0 && !std::is_integral_v ? 1 : 0) + (drv.rank() > 1 && !std::is_integral_v ? 1 : 0) + (drv.rank() > 2 && !std::is_integral_v ? 1 : 0) + (drv.rank() > 3 && !std::is_integral_v ? 1 : 0) + (drv.rank() > 4 && !std::is_integral_v ? 1 : 0) + (drv.rank() > 5 && !std::is_integral_v ? 1 : 0) + (drv.rank() > 6 && !std::is_integral_v ? 1 : 0); using return_type = DynRankView; return static_cast( DynRankView( sub, new_rank)); } template KOKKOS_INLINE_FUNCTION auto subview( const DynRankView& drv, SubArg0 arg0 = SubArg0{}, SubArg1 arg1 = SubArg1{}, SubArg2 arg2 = SubArg2{}, SubArg3 arg3 = SubArg3{}, SubArg4 arg4 = SubArg4{}, SubArg5 arg5 = SubArg5{}, SubArg6 arg6 = SubArg6{}) { return subdynrankview(drv, arg0, arg1, arg2, arg3, arg4, arg5, arg6); } template using Subdynrankview = decltype(subdynrankview(std::declval(), std::declval()...)); } // namespace Kokkos namespace Kokkos { // overload == and != template KOKKOS_INLINE_FUNCTION bool operator==(const DynRankView& lhs, const DynRankView& rhs) { // Same data, layout, dimensions using lhs_traits = ViewTraits; using rhs_traits = ViewTraits; return std::is_same_v && std::is_same_v && std::is_same_v && lhs.rank() == rhs.rank() && lhs.data() == rhs.data() && lhs.span() == rhs.span() && lhs.extents() == rhs.extents(); } template KOKKOS_INLINE_FUNCTION bool operator!=(const DynRankView& lhs, const DynRankView& rhs) { return !(operator==(lhs, rhs)); } } // namespace Kokkos //---------------------------------------------------------------------------- //---------------------------------------------------------------------------- namespace Kokkos { namespace Impl { template struct DynRankViewRemap { const OutputView output; const InputView input; const size_t n0; const size_t n1; const size_t n2; const size_t n3; const size_t n4; const size_t n5; const size_t n6; DynRankViewRemap(const ExecSpace& exec_space, const OutputView& arg_out, const InputView& arg_in) : output(arg_out), input(arg_in), n0(std::min((size_t)arg_out.extent(0), (size_t)arg_in.extent(0))), n1(std::min((size_t)arg_out.extent(1), (size_t)arg_in.extent(1))), n2(std::min((size_t)arg_out.extent(2), (size_t)arg_in.extent(2))), n3(std::min((size_t)arg_out.extent(3), (size_t)arg_in.extent(3))), n4(std::min((size_t)arg_out.extent(4), (size_t)arg_in.extent(4))), n5(std::min((size_t)arg_out.extent(5), (size_t)arg_in.extent(5))), n6(std::min((size_t)arg_out.extent(6), (size_t)arg_in.extent(6))) { using Policy = Kokkos::RangePolicy; Kokkos::parallel_for("Kokkos::DynRankViewRemap", Policy(exec_space, 0, n0), *this); } DynRankViewRemap(const OutputView& arg_out, const InputView& arg_in) : DynRankViewRemap(ExecSpace{}, arg_out, arg_in) {} KOKKOS_INLINE_FUNCTION void operator()(const size_t i0) const { for (size_t i1 = 0; i1 < n1; ++i1) { for (size_t i2 = 0; i2 < n2; ++i2) { for (size_t i3 = 0; i3 < n3; ++i3) { for (size_t i4 = 0; i4 < n4; ++i4) { for (size_t i5 = 0; i5 < n5; ++i5) { for (size_t i6 = 0; i6 < n6; ++i6) { output.access(i0, i1, i2, i3, i4, i5, i6) = input.access(i0, i1, i2, i3, i4, i5, i6); } } } } } } } }; } /* namespace Impl */ } /* namespace Kokkos */ namespace Kokkos { namespace Impl { /* \brief Returns a View of the requested rank, aliasing the underlying memory, to facilitate implementation of deep_copy() and other routines that are defined on View */ template KOKKOS_FUNCTION View::type, Args...> as_view_of_rank_n(DynRankView v) { if (v.rank() != N) { KOKKOS_IF_ON_HOST( const std::string message = "Converting DynRankView of rank " + std::to_string(v.rank()) + " to a View of mis-matched rank " + std::to_string(N) + "!"; Kokkos::abort(message.c_str());) KOKKOS_IF_ON_DEVICE( Kokkos::abort("Converting DynRankView to a View of mis-matched rank!");) } auto layout = v.DownCast().layout(); if constexpr (std::is_same_v || std::is_same_v || std::is_same_v) { for (int i = N; i < 7; ++i) layout.dimension[i] = KOKKOS_IMPL_CTOR_DEFAULT_ARG; } if constexpr (ViewTraits::impl_is_customized) { return View::type, Args...>( Kokkos::view_wrap( v.data(), Kokkos::Impl::AccessorArg_t{v.accessor().fad_size() + 1}), layout); } else return View::type, Args...>(v.data(), layout); } template struct ApplyToViewOfStaticRank> { template static void apply(Function&& f, DynRankView a) { switch (rank(a)) { case 0: f(as_view_of_rank_n<0>(a)); break; case 1: f(as_view_of_rank_n<1>(a)); break; case 2: f(as_view_of_rank_n<2>(a)); break; case 3: f(as_view_of_rank_n<3>(a)); break; case 4: f(as_view_of_rank_n<4>(a)); break; case 5: f(as_view_of_rank_n<5>(a)); break; case 6: f(as_view_of_rank_n<6>(a)); break; case 7: f(as_view_of_rank_n<7>(a)); break; default: KOKKOS_IF_ON_HOST( Kokkos::abort( std::string( "Trying to apply a function to a view of unexpected rank " + std::to_string(rank(a))) .c_str());) KOKKOS_IF_ON_DEVICE( Kokkos::abort( "Trying to apply a function to a view of unexpected rank");) } } }; } // namespace Impl /** \brief Deep copy a value from Host memory into a view. */ template inline void deep_copy(const ExecSpace& e, const DynRankView& dst, typename ViewTraits::const_value_type& value) { static_assert( std::is_same_v::non_const_value_type, typename ViewTraits::value_type>, "deep_copy requires non-const type"); Impl::ApplyToViewOfStaticRank>::apply( [=](auto view) { deep_copy(e, view, value); }, dst); } template inline void deep_copy(const DynRankView& dst, typename ViewTraits::const_value_type& value) { Impl::ApplyToViewOfStaticRank>::apply( [=](auto view) { deep_copy(view, value); }, dst); } /** \brief Deep copy into a value in Host memory from a view. */ template inline void deep_copy(const ExecSpace& e, typename ViewTraits::non_const_value_type& dst, const DynRankView& src) { deep_copy(e, dst, Impl::as_view_of_rank_n<0>(src)); } template inline void deep_copy(typename ViewTraits::non_const_value_type& dst, const DynRankView& src) { deep_copy(dst, Impl::as_view_of_rank_n<0>(src)); } namespace Impl { template void deep_copy_dynrankview(const ExecSpace& exec_space, const DstType& dst, const SrcType& src) { static_assert(std::is_same_v, "deep_copy requires non-const destination type"); switch (rank(dst)) { case 0: deep_copy(exec_space, Impl::as_view_of_rank_n<0>(dst), Impl::as_view_of_rank_n<0>(src)); break; case 1: deep_copy(exec_space, Impl::as_view_of_rank_n<1>(dst), Impl::as_view_of_rank_n<1>(src)); break; case 2: deep_copy(exec_space, Impl::as_view_of_rank_n<2>(dst), Impl::as_view_of_rank_n<2>(src)); break; case 3: deep_copy(exec_space, Impl::as_view_of_rank_n<3>(dst), Impl::as_view_of_rank_n<3>(src)); break; case 4: deep_copy(exec_space, Impl::as_view_of_rank_n<4>(dst), Impl::as_view_of_rank_n<4>(src)); break; case 5: deep_copy(exec_space, Impl::as_view_of_rank_n<5>(dst), Impl::as_view_of_rank_n<5>(src)); break; case 6: deep_copy(exec_space, Impl::as_view_of_rank_n<6>(dst), Impl::as_view_of_rank_n<6>(src)); break; case 7: deep_copy(exec_space, Impl::as_view_of_rank_n<7>(dst), Impl::as_view_of_rank_n<7>(src)); break; default: Kokkos::Impl::throw_runtime_exception( "Calling DynRankView deep_copy with a view of unexpected rank " + std::to_string(rank(dst))); } } template void deep_copy_dynrankview(const DstType& dst, const SrcType& src) { static_assert(std::is_same_v, "deep_copy requires non-const destination type"); switch (rank(dst)) { case 0: deep_copy(Impl::as_view_of_rank_n<0>(dst), Impl::as_view_of_rank_n<0>(src)); break; case 1: deep_copy(Impl::as_view_of_rank_n<1>(dst), Impl::as_view_of_rank_n<1>(src)); break; case 2: deep_copy(Impl::as_view_of_rank_n<2>(dst), Impl::as_view_of_rank_n<2>(src)); break; case 3: deep_copy(Impl::as_view_of_rank_n<3>(dst), Impl::as_view_of_rank_n<3>(src)); break; case 4: deep_copy(Impl::as_view_of_rank_n<4>(dst), Impl::as_view_of_rank_n<4>(src)); break; case 5: deep_copy(Impl::as_view_of_rank_n<5>(dst), Impl::as_view_of_rank_n<5>(src)); break; case 6: deep_copy(Impl::as_view_of_rank_n<6>(dst), Impl::as_view_of_rank_n<6>(src)); break; case 7: deep_copy(Impl::as_view_of_rank_n<7>(dst), Impl::as_view_of_rank_n<7>(src)); break; default: Kokkos::Impl::throw_runtime_exception( "Calling DynRankView deep_copy with a view of unexpected rank " + std::to_string(rank(dst))); } } } // namespace Impl //---------------------------------------------------------------------------- /** \brief A deep copy between views of the default specialization, compatible * type, same rank, same contiguous layout. * * A rank mismatch will error out in the attempt to convert to a View */ template inline void deep_copy( const ExecSpace& exec_space, const Kokkos::DynRankView& dst, const Kokkos::DynRankView& src) { Impl::deep_copy_dynrankview(exec_space, dst, src); } template inline void deep_copy( const ExecSpace& exec_space, const Kokkos::DynRankView& dst, const Kokkos::View& src) { Impl::deep_copy_dynrankview(exec_space, dst, src); } template inline void deep_copy( const ExecSpace& exec_space, const Kokkos::View& dst, const Kokkos::DynRankView& src) { Impl::deep_copy_dynrankview(exec_space, dst, src); } template inline void deep_copy( const Kokkos::DynRankView& dst, const Kokkos::DynRankView& src) { Impl::deep_copy_dynrankview(dst, src); } template inline void deep_copy( const Kokkos::DynRankView& dst, const Kokkos::View& src) { Impl::deep_copy_dynrankview(dst, src); } template inline void deep_copy( const Kokkos::View& dst, const Kokkos::DynRankView& src) { Impl::deep_copy_dynrankview(dst, src); } } // namespace Kokkos //---------------------------------------------------------------------------- //---------------------------------------------------------------------------- namespace Kokkos { namespace Impl { // Deduce Mirror Types template struct MirrorDRViewType { // The incoming view_type using src_view_type = typename Kokkos::DynRankView; // The memory space for the mirror view using memory_space = typename Space::memory_space; // Check whether it is the same memory space enum { is_same_memspace = std::is_same_v }; // The array_layout using array_layout = typename src_view_type::array_layout; // The data type (we probably want it non-const since otherwise we can't even // deep_copy to it. using data_type = typename src_view_type::non_const_data_type; // The destination view type if it is not the same memory space using dest_view_type = Kokkos::DynRankView; // If it is the same memory_space return the existsing view_type // This will also keep the unmanaged trait if necessary using view_type = std::conditional_t; }; } // namespace Impl namespace Impl { // create a mirror // private interface that accepts arbitrary view constructor args passed by a // view_alloc template inline auto create_mirror(const DynRankView& src, const Impl::ViewCtorProp& arg_prop) { if constexpr (Impl::ViewCtorProp::has_memory_space) { using dst_type = typename Impl::MirrorDRViewType< typename Impl::ViewCtorProp::memory_space, T, P...>::dest_view_type; return dst_type(create_mirror(arg_prop, src.DownCast()), src.rank()); } else { using src_type = DynRankView; using dst_type = typename src_type::host_mirror_type; return dst_type(create_mirror(arg_prop, src.DownCast()), src.rank()); } } } // namespace Impl // public interface template inline auto create_mirror(const DynRankView& src) { return Impl::create_mirror(src, Kokkos::view_alloc()); } // public interface that accepts a without initializing flag template inline auto create_mirror(Kokkos::Impl::WithoutInitializing_t wi, const DynRankView& src) { return Impl::create_mirror(src, Kokkos::view_alloc(wi)); } // public interface that accepts a space template requires Kokkos::is_space::value inline auto create_mirror(const Space&, const Kokkos::DynRankView& src) { return Impl::create_mirror( src, Kokkos::view_alloc(typename Space::memory_space{})); } // public interface that accepts a space and a without initializing flag template requires Kokkos::is_space::value inline auto create_mirror(Kokkos::Impl::WithoutInitializing_t wi, const Space&, const Kokkos::DynRankView& src) { return Impl::create_mirror( src, Kokkos::view_alloc(wi, typename Space::memory_space{})); } // public interface that accepts arbitrary view constructor args passed by a // view_alloc template inline auto create_mirror(const Impl::ViewCtorProp& arg_prop, const DynRankView& src) { return Impl::create_mirror(src, arg_prop); } namespace Impl { // create a mirror view // private interface that accepts arbitrary view constructor args passed by a // view_alloc template inline auto create_mirror_view( const DynRankView& src, [[maybe_unused]] const typename Impl::ViewCtorProp& arg_prop) { if constexpr (!Impl::ViewCtorProp::has_memory_space) { if constexpr (std::is_same_v::memory_space, typename DynRankView:: host_mirror_type::memory_space> && std::is_same_v::data_type, typename DynRankView< T, P...>::host_mirror_type::data_type>) { return typename DynRankView::host_mirror_type(src); } else { return Kokkos::Impl::create_mirror(src, arg_prop); } } else { if constexpr (Impl::MirrorDRViewType::memory_space, T, P...>::is_same_memspace) { return typename Impl::MirrorDRViewType< typename Impl::ViewCtorProp::memory_space, T, P...>::view_type(src); } else { return Kokkos::Impl::create_mirror(src, arg_prop); } } } } // namespace Impl // public interface template inline auto create_mirror_view(const Kokkos::DynRankView& src) { return Impl::create_mirror_view(src, Kokkos::view_alloc()); } // public interface that accepts a without initializing flag template inline auto create_mirror_view(Kokkos::Impl::WithoutInitializing_t wi, const DynRankView& src) { return Impl::create_mirror_view(src, Kokkos::view_alloc(wi)); } // public interface that accepts a space template requires Kokkos::is_space::value inline auto create_mirror_view(const Space&, const Kokkos::DynRankView& src) { return Impl::create_mirror_view( src, Kokkos::view_alloc(typename Space::memory_space())); } // public interface that accepts a space and a without initializing flag template requires Kokkos::is_space::value inline auto create_mirror_view(Kokkos::Impl::WithoutInitializing_t wi, const Space&, const Kokkos::DynRankView& src) { return Impl::create_mirror_view( src, Kokkos::view_alloc(typename Space::memory_space{}, wi)); } // public interface that accepts arbitrary view constructor args passed by a // view_alloc template inline auto create_mirror_view( const typename Impl::ViewCtorProp& arg_prop, const Kokkos::DynRankView& src) { return Impl::create_mirror_view(src, arg_prop); } // create a mirror view and deep copy it // public interface that accepts arbitrary view constructor args passed by a // view_alloc template auto create_mirror_view_and_copy( [[maybe_unused]] const Impl::ViewCtorProp& arg_prop, const Kokkos::DynRankView& src) { using alloc_prop_input = Impl::ViewCtorProp; Impl::check_view_ctor_args_create_mirror_view_and_copy(); if constexpr (Impl::MirrorDRViewType< typename Impl::ViewCtorProp::memory_space, T, P...>::is_same_memspace) { // same behavior as deep_copy(src, src) if constexpr (!alloc_prop_input::has_execution_space) fence( "Kokkos::create_mirror_view_and_copy: fence before returning src " "view"); return src; } else { using Space = typename alloc_prop_input::memory_space; using Mirror = typename Impl::MirrorDRViewType::view_type; auto arg_prop_copy = Impl::with_properties_if_unset( arg_prop, std::string{}, WithoutInitializing, typename Space::execution_space{}); std::string& label = Impl::get_property(arg_prop_copy); if (label.empty()) label = src.label(); auto mirror = typename Mirror::non_const_type{ arg_prop_copy, Impl::reconstructLayout(src.layout(), src.rank())}; if constexpr (alloc_prop_input::has_execution_space) { deep_copy(Impl::get_property(arg_prop_copy), mirror, src); } else deep_copy(mirror, src); return mirror; } } template requires Kokkos::is_space::value auto create_mirror_view_and_copy(const Space&, const Kokkos::DynRankView& src, std::string const& name = "") { return create_mirror_view_and_copy( Kokkos::view_alloc(typename Space::memory_space{}, name), src); } template auto create_mirror_view_and_copy(const Kokkos::DynRankView& src) { return create_mirror_view_and_copy( typename Kokkos::DynRankView::host_mirror_type::memory_space{}, src); } } // namespace Kokkos //---------------------------------------------------------------------------- //---------------------------------------------------------------------------- namespace Kokkos { /** \brief Resize a view with copying old data to new data at the corresponding * indices. */ template inline void impl_resize(const Impl::ViewCtorProp& arg_prop, DynRankView& v, const size_t n0, const size_t n1, const size_t n2, const size_t n3, const size_t n4, const size_t n5, const size_t n6, const size_t n7) { using drview_type = DynRankView; using alloc_prop_input = Impl::ViewCtorProp; static_assert(!Kokkos::ViewTraits::memory_traits::is_unmanaged, "Can only resize managed views"); static_assert(!alloc_prop_input::has_label, "The view constructor arguments passed to Kokkos::resize " "must not include a label!"); static_assert(!alloc_prop_input::has_pointer, "The view constructor arguments passed to Kokkos::resize must " "not include a pointer!"); static_assert(!alloc_prop_input::has_memory_space, "The view constructor arguments passed to Kokkos::resize must " "not include a memory space instance!"); auto prop_copy = Impl::with_properties_if_unset( arg_prop, v.label(), typename drview_type::execution_space{}); drview_type v_resized(prop_copy, n0, n1, n2, n3, n4, n5, n6, n7); if constexpr (alloc_prop_input::has_execution_space) Kokkos::Impl::DynRankViewRemap( Impl::get_property(prop_copy), v_resized, v); else { // NOLINTNEXTLINE(bugprone-unused-raii) Kokkos::Impl::DynRankViewRemap(v_resized, v); Kokkos::fence("Kokkos::resize(DynRankView)"); } v = v_resized; } template inline void resize(DynRankView& v, const size_t n0 = KOKKOS_INVALID_INDEX, const size_t n1 = KOKKOS_INVALID_INDEX, const size_t n2 = KOKKOS_INVALID_INDEX, const size_t n3 = KOKKOS_INVALID_INDEX, const size_t n4 = KOKKOS_INVALID_INDEX, const size_t n5 = KOKKOS_INVALID_INDEX, const size_t n6 = KOKKOS_INVALID_INDEX, const size_t n7 = KOKKOS_INVALID_INDEX) { impl_resize(Impl::ViewCtorProp<>{}, v, n0, n1, n2, n3, n4, n5, n6, n7); } template void resize(const Impl::ViewCtorProp& arg_prop, DynRankView& v, const size_t n0 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n1 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n2 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n3 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n4 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n5 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n6 = KOKKOS_IMPL_CTOR_DEFAULT_ARG, const size_t n7 = KOKKOS_IMPL_CTOR_DEFAULT_ARG) { impl_resize(arg_prop, v, n0, n1, n2, n3, n4, n5, n6, n7); } template inline std::enable_if_t::value> resize( const I& arg_prop, DynRankView& v, const size_t n0 = KOKKOS_INVALID_INDEX, const size_t n1 = KOKKOS_INVALID_INDEX, const size_t n2 = KOKKOS_INVALID_INDEX, const size_t n3 = KOKKOS_INVALID_INDEX, const size_t n4 = KOKKOS_INVALID_INDEX, const size_t n5 = KOKKOS_INVALID_INDEX, const size_t n6 = KOKKOS_INVALID_INDEX, const size_t n7 = KOKKOS_INVALID_INDEX) { impl_resize(Kokkos::view_alloc(arg_prop), v, n0, n1, n2, n3, n4, n5, n6, n7); } /** \brief Resize a view with copying old data to new data at the corresponding * indices. */ template inline void impl_realloc(DynRankView& v, const size_t n0, const size_t n1, const size_t n2, const size_t n3, const size_t n4, const size_t n5, const size_t n6, const size_t n7, const Impl::ViewCtorProp& arg_prop) { using drview_type = DynRankView; using alloc_prop_input = Impl::ViewCtorProp; static_assert(!Kokkos::ViewTraits::memory_traits::is_unmanaged, "Can only realloc managed views"); static_assert(!alloc_prop_input::has_label, "The view constructor arguments passed to Kokkos::realloc must " "not include a label!"); static_assert(!alloc_prop_input::has_pointer, "The view constructor arguments passed to Kokkos::realloc must " "not include a pointer!"); static_assert(!alloc_prop_input::has_memory_space, "The view constructor arguments passed to Kokkos::realloc must " "not include a memory space instance!"); auto arg_prop_copy = Impl::with_properties_if_unset(arg_prop, v.label()); v = drview_type(); // Deallocate first, if the only view to allocation v = drview_type(arg_prop_copy, n0, n1, n2, n3, n4, n5, n6, n7); } template inline void realloc(const Impl::ViewCtorProp& arg_prop, DynRankView& v, const size_t n0 = KOKKOS_INVALID_INDEX, const size_t n1 = KOKKOS_INVALID_INDEX, const size_t n2 = KOKKOS_INVALID_INDEX, const size_t n3 = KOKKOS_INVALID_INDEX, const size_t n4 = KOKKOS_INVALID_INDEX, const size_t n5 = KOKKOS_INVALID_INDEX, const size_t n6 = KOKKOS_INVALID_INDEX, const size_t n7 = KOKKOS_INVALID_INDEX) { impl_realloc(v, n0, n1, n2, n3, n4, n5, n6, n7, arg_prop); } template inline void realloc(DynRankView& v, const size_t n0 = KOKKOS_INVALID_INDEX, const size_t n1 = KOKKOS_INVALID_INDEX, const size_t n2 = KOKKOS_INVALID_INDEX, const size_t n3 = KOKKOS_INVALID_INDEX, const size_t n4 = KOKKOS_INVALID_INDEX, const size_t n5 = KOKKOS_INVALID_INDEX, const size_t n6 = KOKKOS_INVALID_INDEX, const size_t n7 = KOKKOS_INVALID_INDEX) { impl_realloc(v, n0, n1, n2, n3, n4, n5, n6, n7, Impl::ViewCtorProp<>{}); } template inline std::enable_if_t::value> realloc( const I& arg_prop, DynRankView& v, const size_t n0 = KOKKOS_INVALID_INDEX, const size_t n1 = KOKKOS_INVALID_INDEX, const size_t n2 = KOKKOS_INVALID_INDEX, const size_t n3 = KOKKOS_INVALID_INDEX, const size_t n4 = KOKKOS_INVALID_INDEX, const size_t n5 = KOKKOS_INVALID_INDEX, const size_t n6 = KOKKOS_INVALID_INDEX, const size_t n7 = KOKKOS_INVALID_INDEX) { impl_realloc(v, n0, n1, n2, n3, n4, n5, n6, n7, Kokkos::view_alloc(arg_prop)); } namespace Experimental { template struct python_view_type> { using type = Kokkos::Impl::python_view_type_impl_t< typename DynRankView::type>; }; } // namespace Experimental } // namespace Kokkos #ifdef KOKKOS_IMPL_PUBLIC_INCLUDE_NOTDEFINED_DYNRANKVIEW #undef KOKKOS_IMPL_PUBLIC_INCLUDE #undef KOKKOS_IMPL_PUBLIC_INCLUDE_NOTDEFINED_DYNRANKVIEW #endif #endif