Program Listing for File HipMallocManagedAllocator.hpp

↰ Return to documentation for file (umpire/alloc/HipMallocManagedAllocator.hpp)

//////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2016-20, Lawrence Livermore National Security, LLC and Umpire
// project contributors. See the COPYRIGHT file for details.
//
// SPDX-License-Identifier: (MIT)
//////////////////////////////////////////////////////////////////////////////
#ifndef UMPIRE_HipMallocManagedAllocator_HPP
#define UMPIRE_HipMallocManagedAllocator_HPP

#include "hip/hip_runtime_api.h"

#include "umpire/util/Macros.hpp"

namespace umpire {
namespace alloc {

/*!
 * \brief Uses hipMallocManaged and hipFree to allocate and deallocate
 *        unified memory on AMD GPUs.
 */
struct HipMallocManagedAllocator {
  /*!
   * \brief Allocate bytes of memory using hipMallocManaged.
   *
   * \param bytes Number of bytes to allocate.
   *
   * \return Pointer to start of the allocation.
   *
   * \throws umpire::util::Exception if memory cannot be allocated.
   */
  void* allocate(std::size_t bytes)
  {
    void* ptr = nullptr;
    hipError_t error = ::hipMallocManaged(&ptr, bytes);
    UMPIRE_LOG(Debug, "(bytes=" << bytes << ") returning " << ptr);
    if (error != hipSuccess) {
      UMPIRE_ERROR("hipMallocManaged( bytes = " << bytes
                                                 << " ) failed with error: "
                                                 << hipGetErrorString(error));
    } else {
      return ptr;
    }
  }

  /*!
   * \brief Deallocate memory using hipFree.
   *
   * \param ptr Address to deallocate.
   *
   * \throws umpire::util::Exception if memory be free'd.
   */
  void deallocate(void* ptr)
  {
    UMPIRE_LOG(Debug, "(ptr=" << ptr << ")");

    hipError_t error = ::hipFree(ptr);
    if (error != hipSuccess) {
      UMPIRE_ERROR("hipFree( ptr = " << ptr << " ) failed with error: "
                                      << hipGetErrorString(error));
    }
  }

  bool isAccessible(Platform p)
  {
    if(p == Platform::hip || p == Platform::host)
      return true;
    else
      return false;
  }
};

} // end of namespace alloc
} // end of namespace umpire

#endif // UMPIRE_hipMallocManagedAllocator_HPP