BufferAllocator.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_BUFFERALLOCATOR_HPP
#define GEOS_COMMON_BUFFERALLOCATOR_HPP
 
#include "common/GeosxConfig.hpp"
 
#ifdef GEOS_USE_CHAI
#include <umpire/ResourceManager.hpp>
#include <umpire/TypedAllocator.hpp>
 
namespace geos
{
void setPreferPinned( bool p );
 
bool getPreferPinned( );
 
template< typename T >
class BufferAllocator
{
public:
  // The type used to instantiate the class, and the underlying umpire allocator.
  using value_type = T;
private:
  // An umpire allocator allocating the type for which this class is instantiated.
  umpire::TypedAllocator< value_type > m_alloc;
  bool m_prefer_pinned_l;
public:
 
  BufferAllocator()
    : m_alloc( umpire::TypedAllocator< T >( umpire::ResourceManager::getInstance().getAllocator( umpire::resource::Host ) ) )
    , m_prefer_pinned_l( getPreferPinned( ) )
  {
  #if defined(UMPIRE_ENABLE_PINNED)
    if( m_prefer_pinned_l )
    {
      m_alloc = umpire::TypedAllocator< T >( umpire::ResourceManager::getInstance().getAllocator( umpire::resource::Pinned ) );
    }
  #endif
  }
 
  value_type * allocate( size_t sz )
  {
    return m_alloc.allocate( sz );
  }
 
  void deallocate( value_type * buffer, size_t sz )
  {
    if( buffer != nullptr )
      m_alloc.deallocate( buffer, sz );
  }
 
  bool operator!=( const BufferAllocator & )
  {
    return false;
  }
 
  bool operator==( const BufferAllocator & other )
  {
    return !operator!=( other );
  }
};
 
}
#endif
 
#endif