Kokkos Core Kernels Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Kokkos_MemoryTraits.hpp
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Kokkos v. 2.0
6 // Copyright (2014) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Christian R. Trott (crtrott@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 */
43 
44 #ifndef KOKKOS_MEMORYTRAITS_HPP
45 #define KOKKOS_MEMORYTRAITS_HPP
46 
47 #include <impl/Kokkos_Traits.hpp>
48 #include <impl/Kokkos_Tags.hpp>
49 
50 //----------------------------------------------------------------------------
51 
52 namespace Kokkos {
53 
63  { Unmanaged = 0x01
64  , RandomAccess = 0x02
65  , Atomic = 0x04
66  , Restrict = 0x08
67  , Aligned = 0x10
68  };
69 
70 template < unsigned T >
71 struct MemoryTraits {
73  typedef MemoryTraits memory_traits ;
74 
75  enum : bool { Unmanaged = (unsigned(0) != (T & unsigned(Kokkos::Unmanaged))) };
76  enum : bool { RandomAccess = (unsigned(0) != (T & unsigned(Kokkos::RandomAccess))) };
77  enum : bool { Atomic = (unsigned(0) != (T & unsigned(Kokkos::Atomic))) };
78  enum : bool { Restrict = (unsigned(0) != (T & unsigned(Kokkos::Restrict))) };
79  enum : bool { Aligned = (unsigned(0) != (T & unsigned(Kokkos::Aligned))) };
80 
81 };
82 
83 } // namespace Kokkos
84 
85 //----------------------------------------------------------------------------
86 
87 namespace Kokkos {
88 
89 typedef Kokkos::MemoryTraits<0> MemoryManaged ;
90 typedef Kokkos::MemoryTraits< Kokkos::Unmanaged > MemoryUnmanaged ;
91 typedef Kokkos::MemoryTraits< Kokkos::Unmanaged | Kokkos::RandomAccess > MemoryRandomAccess ;
92 
93 } // namespace Kokkos
94 
95 //----------------------------------------------------------------------------
96 
97 namespace Kokkos {
98 namespace Impl {
99 
100 static_assert(
101  ( 0 < int(KOKKOS_MEMORY_ALIGNMENT) ) &&
102  ( 0 == ( int(KOKKOS_MEMORY_ALIGNMENT) & (int(KOKKOS_MEMORY_ALIGNMENT)-1))) ,
103  "KOKKOS_MEMORY_ALIGNMENT must be a power of two" );
104 
111 enum : unsigned
112  { MEMORY_ALIGNMENT = KOKKOS_MEMORY_ALIGNMENT
113  , MEMORY_ALIGNMENT_THRESHOLD = KOKKOS_MEMORY_ALIGNMENT_THRESHOLD
114  };
115 
116 } //namespace Impl
117 } // namespace Kokkos
118 
119 #endif /* #ifndef KOKKOS_MEMORYTRAITS_HPP */
120 
MemoryTraitsFlags
Memory access traits for views, an extension point.