Kokkos Core Kernels Package  Version of the Day
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 H. Carter Edwards (hcedwar@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  };
67 
68 template < unsigned T >
69 struct MemoryTraits {
71  typedef MemoryTraits memory_traits ;
72 
73  enum { Unmanaged = T & unsigned(Kokkos::Unmanaged) };
74  enum { RandomAccess = T & unsigned(Kokkos::RandomAccess) };
75  enum { Atomic = T & unsigned(Kokkos::Atomic) };
76 
77 };
78 
79 } // namespace Kokkos
80 
81 //----------------------------------------------------------------------------
82 
83 namespace Kokkos {
84 
85 typedef Kokkos::MemoryTraits<0> MemoryManaged ;
86 typedef Kokkos::MemoryTraits< Kokkos::Unmanaged > MemoryUnmanaged ;
87 typedef Kokkos::MemoryTraits< Kokkos::Unmanaged | Kokkos::RandomAccess > MemoryRandomAccess ;
88 
89 } // namespace Kokkos
90 
91 //----------------------------------------------------------------------------
92 
93 namespace Kokkos {
94 namespace Impl {
95 
102 enum { MEMORY_ALIGNMENT =
103 #if defined( KOKKOS_MEMORY_ALIGNMENT )
104  ( 1 << Kokkos::Impl::integral_power_of_two( KOKKOS_MEMORY_ALIGNMENT ) )
105 #else
106  ( 1 << Kokkos::Impl::integral_power_of_two( 128 ) )
107 #endif
108  , MEMORY_ALIGNMENT_THRESHOLD = 4
109  };
110 
111 
112 } //namespace Impl
113 } // namespace Kokkos
114 
115 #endif /* #ifndef KOKKOS_MEMORYTRAITS_HPP */
116 
MemoryTraitsFlags
Memory access traits for views, an extension point.