1 /* 2 //@HEADER 3 // ************************************************************************ 4 // 5 // Kokkos v. 3.0 6 // Copyright (2020) National Technology & Engineering 7 // Solutions of Sandia, LLC (NTESS). 8 // 9 // Under the terms of Contract DE-NA0003525 with NTESS, 10 // the U.S. Government retains certain rights in this software. 11 // 12 // Redistribution and use in source and binary forms, with or without 13 // modification, are permitted provided that the following conditions are 14 // met: 15 // 16 // 1. Redistributions of source code must retain the above copyright 17 // notice, this list of conditions and the following disclaimer. 18 // 19 // 2. Redistributions in binary form must reproduce the above copyright 20 // notice, this list of conditions and the following disclaimer in the 21 // documentation and/or other materials provided with the distribution. 22 // 23 // 3. Neither the name of the Corporation nor the names of the 24 // contributors may be used to endorse or promote products derived from 25 // this software without specific prior written permission. 26 // 27 // THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY 28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE 31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 38 // 39 // Questions? Contact Christian R. Trott (crtrott@sandia.gov) 40 // 41 // ************************************************************************ 42 //@HEADER 43 */ 44 45 #ifndef KOKKOS_KOKKOS_WORKTAGTRAIT_HPP 46 #define KOKKOS_KOKKOS_WORKTAGTRAIT_HPP 47 48 #include <Kokkos_Macros.hpp> 49 #include <Kokkos_Concepts.hpp> // is_execution_space 50 #include <traits/Kokkos_PolicyTraitAdaptor.hpp> 51 #include <traits/Kokkos_Traits_fwd.hpp> 52 53 namespace Kokkos { 54 namespace Impl { 55 56 //============================================================================== 57 // <editor-fold desc="trait specification"> {{{1 58 59 struct WorkTagTrait : TraitSpecificationBase<WorkTagTrait> { 60 struct base_traits { 61 using work_tag = void; 62 }; 63 }; 64 65 // </editor-fold> end trait specification }}}1 66 //============================================================================== 67 68 //============================================================================== 69 // <editor-fold desc="AnalyzeExecPolicy specializations"> {{{1 70 71 // Since we don't have subsumption in pre-C++20, we need to have the work tag 72 // "trait" handling code be unspecialized, so we handle it instead in a class 73 // with a different name. 74 template <class... Traits> 75 struct AnalyzeExecPolicyHandleWorkTag : AnalyzeExecPolicy<void, Traits...> { 76 using base_t = AnalyzeExecPolicy<void, Traits...>; 77 using base_t::base_t; 78 }; 79 80 template <class WorkTag, class... Traits> 81 struct AnalyzeExecPolicyHandleWorkTag<WorkTag, Traits...> 82 : AnalyzeExecPolicy<void, Traits...> { 83 using base_t = AnalyzeExecPolicy<void, Traits...>; 84 using base_t::base_t; 85 static_assert(std::is_void<typename base_t::work_tag>::value, 86 "Kokkos Error: More than one work tag given"); 87 using work_tag = WorkTag; 88 }; 89 90 // This only works if this is not a partial specialization, so we have to 91 // do the partial specialization elsewhere 92 template <class Enable, class... Traits> 93 struct AnalyzeExecPolicy : AnalyzeExecPolicyHandleWorkTag<Traits...> { 94 using base_t = AnalyzeExecPolicyHandleWorkTag<Traits...>; 95 using base_t::base_t; 96 }; 97 98 // </editor-fold> end AnalyzeExecPolicy specializations }}}1 99 //============================================================================== 100 101 //============================================================================== 102 // <editor-fold desc="PolicyTraitMatcher specializations"> {{{1 103 104 // In order to match the work tag trait the work tag "matcher" needs to be 105 // unspecialized and the logic needs to be handled in a differently-named class, 106 // just like above. 107 template <class TraitSpec, class Trait> 108 struct PolicyTraitMatcherHandleWorkTag : std::false_type {}; 109 110 template <class Trait> 111 struct PolicyTraitMatcherHandleWorkTag<WorkTagTrait, Trait> 112 : std::integral_constant<bool, !std::is_void<Trait>::value> {}; 113 114 template <class TraitSpec, class Trait, class Enable> 115 struct PolicyTraitMatcher /* unspecialized! */ 116 : PolicyTraitMatcherHandleWorkTag<TraitSpec, Trait> {}; 117 118 // </editor-fold> end PolicyTraitMatcher specializations }}}1 119 //============================================================================== 120 121 } // end namespace Impl 122 } // end namespace Kokkos 123 124 #endif // KOKKOS_KOKKOS_WORKTAGTRAIT_HPP 125