Kokkos Core Kernels Package  Version of the Day
Kokkos_HBWSpace.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_HBWSPACE_HPP
45 #define KOKKOS_HBWSPACE_HPP
46 
47 
48 #include <Kokkos_HostSpace.hpp>
49 
50 /*--------------------------------------------------------------------------*/
51 #ifdef KOKKOS_HAVE_HBWSPACE
52 
53 namespace Kokkos {
54 namespace Experimental {
55 namespace Impl {
56 
63 void init_lock_array_hbw_space();
64 
70 bool lock_address_hbw_space(void* ptr);
71 
78 void unlock_address_hbw_space(void* ptr);
79 
80 } // namespace Impl
81 } // neamspace Experimental
82 } // namespace Kokkos
83 
84 namespace Kokkos {
85 namespace Experimental {
86 
92 class HBWSpace {
93 public:
94 
96  typedef HBWSpace memory_space ;
97  typedef size_t size_type ;
98 
105 #if defined( KOKKOS_HAVE_DEFAULT_DEVICE_TYPE_OPENMP )
106  typedef Kokkos::OpenMP execution_space ;
107 #elif defined( KOKKOS_HAVE_DEFAULT_DEVICE_TYPE_THREADS )
108  typedef Kokkos::Threads execution_space ;
109 #elif defined( KOKKOS_HAVE_OPENMP )
110  typedef Kokkos::OpenMP execution_space ;
111 #elif defined( KOKKOS_HAVE_PTHREAD )
112  typedef Kokkos::Threads execution_space ;
113 #elif defined( KOKKOS_HAVE_SERIAL )
114  typedef Kokkos::Serial execution_space ;
115 #else
116 # error "At least one of the following host execution spaces must be defined: Kokkos::OpenMP, Kokkos::Serial, or Kokkos::Threads. You might be seeing this message if you disabled the Kokkos::Serial device explicitly using the Kokkos_ENABLE_Serial:BOOL=OFF CMake option, but did not enable any of the other host execution space devices."
117 #endif
118 
121 
122  /*--------------------------------*/
123  /* Functions unique to the HBWSpace */
124  static int in_parallel();
125 
126  static void register_in_parallel( int (*)() );
127 
128  /*--------------------------------*/
129 
131  HBWSpace();
132  HBWSpace( const HBWSpace & rhs ) = default ;
133  HBWSpace & operator = ( const HBWSpace & ) = default ;
134  ~HBWSpace() = default ;
135 
138  enum AllocationMechanism { STD_MALLOC , POSIX_MEMALIGN , POSIX_MMAP , INTEL_MM_ALLOC };
139 
140  explicit
141  HBWSpace( const AllocationMechanism & );
142 
144  void * allocate( const size_t arg_alloc_size ) const ;
145 
147  void deallocate( void * const arg_alloc_ptr
148  , const size_t arg_alloc_size ) const ;
149 
150 private:
151 
152  AllocationMechanism m_alloc_mech ;
153 
154  friend class Kokkos::Impl::SharedAllocationRecord< Kokkos::Experimental::HBWSpace , void > ;
155 };
156 
157 } // namespace Experimental
158 } // namespace Kokkos
159 
160 //----------------------------------------------------------------------------
161 //----------------------------------------------------------------------------
162 
163 namespace Kokkos {
164 namespace Impl {
165 
166 template<>
167 class SharedAllocationRecord< Kokkos::Experimental::HBWSpace , void >
168  : public SharedAllocationRecord< void , void >
169 {
170 private:
171 
172  friend Kokkos::Experimental::HBWSpace ;
173 
174  typedef SharedAllocationRecord< void , void > RecordBase ;
175 
176  SharedAllocationRecord( const SharedAllocationRecord & ) = delete ;
177  SharedAllocationRecord & operator = ( const SharedAllocationRecord & ) = delete ;
178 
179  static void deallocate( RecordBase * );
180 
182  static RecordBase s_root_record ;
183 
184  const Kokkos::Experimental::HBWSpace m_space ;
185 
186 protected:
187 
188  ~SharedAllocationRecord();
189  SharedAllocationRecord() = default ;
190 
191  SharedAllocationRecord( const Kokkos::Experimental::HBWSpace & arg_space
192  , const std::string & arg_label
193  , const size_t arg_alloc_size
194  , const RecordBase::function_type arg_dealloc = & deallocate
195  );
196 
197 public:
198 
199  inline
200  std::string get_label() const
201  {
202  return std::string( RecordBase::head()->m_label );
203  }
204 
205  KOKKOS_INLINE_FUNCTION static
206  SharedAllocationRecord * allocate( const Kokkos::Experimental::HBWSpace & arg_space
207  , const std::string & arg_label
208  , const size_t arg_alloc_size
209  )
210  {
211 #if defined( KOKKOS_ACTIVE_EXECUTION_MEMORY_SPACE_HOST )
212  return new SharedAllocationRecord( arg_space , arg_label , arg_alloc_size );
213 #else
214  return (SharedAllocationRecord *) 0 ;
215 #endif
216  }
217 
219  static
220  void * allocate_tracked( const Kokkos::Experimental::HBWSpace & arg_space
221  , const std::string & arg_label
222  , const size_t arg_alloc_size );
223 
225  static
226  void * reallocate_tracked( void * const arg_alloc_ptr
227  , const size_t arg_alloc_size );
228 
230  static
231  void deallocate_tracked( void * const arg_alloc_ptr );
232 
233 
234  static SharedAllocationRecord * get_record( void * arg_alloc_ptr );
235 
236  static void print_records( std::ostream & , const Kokkos::Experimental::HBWSpace & , bool detail = false );
237 };
238 
239 } // namespace Impl
240 } // namespace Kokkos
241 
242 //----------------------------------------------------------------------------
243 //----------------------------------------------------------------------------
244 
245 namespace Kokkos {
246 namespace Impl {
247 
248 
249 template<class ExecutionSpace>
250 struct DeepCopy<Experimental::HBWSpace,Experimental::HBWSpace,ExecutionSpace> {
251  DeepCopy( void * dst , const void * src , size_t n ) {
252  memcpy( dst , src , n );
253  }
254  DeepCopy( const ExecutionSpace& exec, void * dst , const void * src , size_t n ) {
255  exec.fence();
256  memcpy( dst , src , n );
257  }
258 };
259 
260 template<class ExecutionSpace>
261 struct DeepCopy<HostSpace,Experimental::HBWSpace,ExecutionSpace> {
262  DeepCopy( void * dst , const void * src , size_t n ) {
263  memcpy( dst , src , n );
264  }
265  DeepCopy( const ExecutionSpace& exec, void * dst , const void * src , size_t n ) {
266  exec.fence();
267  memcpy( dst , src , n );
268  }
269 };
270 
271 template<class ExecutionSpace>
272 struct DeepCopy<Experimental::HBWSpace,HostSpace,ExecutionSpace> {
273  DeepCopy( void * dst , const void * src , size_t n ) {
274  memcpy( dst , src , n );
275  }
276  DeepCopy( const ExecutionSpace& exec, void * dst , const void * src , size_t n ) {
277  exec.fence();
278  memcpy( dst , src , n );
279  }
280 };
281 
282 } // namespace Impl
283 } // namespace Kokkos
284 
285 namespace Kokkos {
286 namespace Impl {
287 
288 template<>
289 struct VerifyExecutionCanAccessMemorySpace< Kokkos::HostSpace , Kokkos::Experimental::HBWSpace >
290 {
291  enum { value = true };
292  inline static void verify( void ) { }
293  inline static void verify( const void * ) { }
294 };
295 
296 template<>
297 struct VerifyExecutionCanAccessMemorySpace< Kokkos::Experimental::HBWSpace , Kokkos::HostSpace >
298 {
299  enum { value = true };
300  inline static void verify( void ) { }
301  inline static void verify( const void * ) { }
302 };
303 
304 } // namespace Impl
305 } // namespace Kokkos
306 
307 #endif
308 #endif /* #define KOKKOS_HBWSPACE_HPP */
309 
Memory space for main process and CPU execution spaces.
Memory management for host memory.