BufferAllocator.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_BUFFER_ALLOCATOR_HPP
#define GEOSX_BUFFER_ALLOCATOR_HPP

#include "common/GeosxConfig.hpp"

#ifdef GEOSX_USE_CHAI
#include <umpire/ResourceManager.hpp>
#include <umpire/TypedAllocator.hpp>

namespace geosx
{
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( ) )
  {
    auto & rm = umpire::ResourceManager::getInstance();
    if( rm.isAllocator( "PINNED" ) && m_prefer_pinned_l )
      m_alloc = umpire::TypedAllocator< T >( rm.getAllocator( umpire::resource::Pinned ));
  }
  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