MemoryAllocator.cc

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MemoryAllocator.cc                                          (C) 2000-2023 */
/*                                                                           */
/* Allocateurs mémoires.                                                     */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ArgumentException.h"
#include "arccore/base/NotSupportedException.h"
#include "arccore/base/NotImplementedException.h"
#include "arccore/base/TraceInfo.h"
 
#include "arccore/collections/IMemoryAllocator.h"
 
#include <cstdlib>
#include <cstring>
#include <errno.h>
 
#if defined(ARCCORE_OS_WIN32)
#include <malloc.h>
#endif
 
#include <iostream>
 
#if defined(ARCCORE_OS_LINUX) || defined(ARCCORE_OS_MACOS)
#define ARCCORE_USE_POSIX_MEMALIGN
#endif
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arccore
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
DefaultMemoryAllocator3 DefaultMemoryAllocator3::shared_null_instance;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void IMemoryAllocator::
notifyMemoryArgsChanged(MemoryAllocationArgs, MemoryAllocationArgs, AllocatedMemoryInfo)
{
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void IMemoryAllocator::
copyMemory([[maybe_unused]] MemoryAllocationArgs args, AllocatedMemoryInfo destination,
           AllocatedMemoryInfo source)
{
  std::memcpy(destination.baseAddress(), source.baseAddress(), source.size());
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
bool DefaultMemoryAllocator::
hasRealloc() const
{
  return true;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void* DefaultMemoryAllocator::
allocate(size_t new_size)
{
  return ::malloc(new_size);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void* DefaultMemoryAllocator::
reallocate(void* current_ptr, size_t new_size)
{
  return ::realloc(current_ptr, new_size);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void DefaultMemoryAllocator::
deallocate(void* ptr)
{
  ::free(ptr);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
size_t DefaultMemoryAllocator::
adjustCapacity(size_t wanted_capacity, size_t)
{
  return wanted_capacity;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
bool DefaultMemoryAllocator3::
hasRealloc(MemoryAllocationArgs) const
{
  return true;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
AllocatedMemoryInfo DefaultMemoryAllocator3::
allocate(MemoryAllocationArgs, Int64 new_size)
{
  return { ::malloc(new_size), new_size };
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
AllocatedMemoryInfo DefaultMemoryAllocator3::
reallocate(MemoryAllocationArgs, AllocatedMemoryInfo current_ptr, Int64 new_size)
{
  return { ::realloc(current_ptr.baseAddress(), new_size), new_size };
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void DefaultMemoryAllocator3::
deallocate(MemoryAllocationArgs,AllocatedMemoryInfo ptr)
{
  ::free(ptr.baseAddress());
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
Int64 DefaultMemoryAllocator3::
adjustedCapacity(MemoryAllocationArgs, Int64 wanted_capacity, Int64 ) const
{
  return wanted_capacity;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
AlignedMemoryAllocator AlignedMemoryAllocator::
SimdAllocator(AlignedMemoryAllocator::simdAlignment());
 
AlignedMemoryAllocator AlignedMemoryAllocator::
CacheLineAllocator(AlignedMemoryAllocator::cacheLineAlignment());
 
AlignedMemoryAllocator3 AlignedMemoryAllocator3::
SimdAllocator(AlignedMemoryAllocator3::simdAlignment());
 
AlignedMemoryAllocator3 AlignedMemoryAllocator3::
CacheLineAllocator(AlignedMemoryAllocator::cacheLineAlignment());
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * NOTE: Normalement les fonctions _mm_alloc() et _mm_free() permettent
 * d'allouer de la mémoire alignée. Il faudrait vérifier si elles sont
 * disponibles partout.
 */
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
bool AlignedMemoryAllocator::
hasRealloc() const
{
  return false;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void* AlignedMemoryAllocator::
allocate(size_t new_size)
{
#if defined(ARCCORE_USE_POSIX_MEMALIGN)
  void* ptr = nullptr;
  int e = ::posix_memalign(&ptr, m_alignment, new_size);
  if (e == EINVAL)
    throw ArgumentException(A_FUNCINFO, "Invalid argument to posix_memalign");
  if (e == ENOMEM)
    return nullptr;
  return ptr;
#elif defined(ARCCORE_OS_WIN32)
  return _aligned_malloc(new_size, m_alignment);
#else
  throw NotImplementedException(A_FUNCINFO);
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
AllocatedMemoryInfo AlignedMemoryAllocator3::
allocate([[maybe_unused]] MemoryAllocationArgs args, Int64 new_size)
{
#if defined(ARCCORE_USE_POSIX_MEMALIGN)
  void* ptr = nullptr;
  int e = ::posix_memalign(&ptr, m_alignment, new_size);
  if (e == EINVAL)
    throw ArgumentException(A_FUNCINFO, "Invalid argument to posix_memalign");
  if (e == ENOMEM)
    return AllocatedMemoryInfo(nullptr);
  return AllocatedMemoryInfo(ptr, new_size);
#elif defined(ARCCORE_OS_WIN32)
  return AllocatedMemoryInfo(_aligned_malloc(new_size, m_alignment), new_size);
#else
  throw NotImplementedException(A_FUNCINFO);
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void* AlignedMemoryAllocator::
reallocate(void* current_ptr, size_t new_size)
{
#if defined(ARCCORE_USE_POSIX_MEMALIGN)
  ARCCORE_UNUSED(current_ptr);
  ARCCORE_UNUSED(new_size);
  throw NotSupportedException(A_FUNCINFO);
#elif defined(ARCCORE_OS_WIN32)
  return _aligned_realloc(current_ptr, new_size, m_alignment);
#else
  throw NotImplementedException(A_FUNCINFO);
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
AllocatedMemoryInfo AlignedMemoryAllocator3::
reallocate([[maybe_unused]] MemoryAllocationArgs args, AllocatedMemoryInfo current_ptr, Int64 new_size)
{
#if defined(ARCCORE_USE_POSIX_MEMALIGN)
  ARCCORE_UNUSED(current_ptr);
  ARCCORE_UNUSED(new_size);
  throw NotSupportedException(A_FUNCINFO);
#elif defined(ARCCORE_OS_WIN32)
  return AllocatedMemoryInfo(_aligned_realloc(current_ptr.baseAddress(), new_size, m_alignment), new_size);
#else
  throw NotImplementedException(A_FUNCINFO);
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void AlignedMemoryAllocator::
deallocate(void* ptr)
{
#if defined(ARCCORE_USE_POSIX_MEMALIGN)
  ::free(ptr);
#elif defined(ARCCORE_OS_WIN32)
  return _aligned_free(ptr);
#else
  throw NotImplementedException(A_FUNCINFO);
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void AlignedMemoryAllocator3::
deallocate([[maybe_unused]] MemoryAllocationArgs args, AllocatedMemoryInfo ptr)
{
#if defined(ARCCORE_USE_POSIX_MEMALIGN)
  ::free(ptr.baseAddress());
#elif defined(ARCCORE_OS_WIN32)
  return _aligned_free(ptr.baseAddress());
#else
  throw NotImplementedException(A_FUNCINFO);
#endif
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace
{
  bool is_verbose = false;
}
 
size_t
adjustMemoryCapacity(size_t wanted_capacity, size_t element_size, size_t alignment)
{
  if (element_size == 0)
    return wanted_capacity;
  // Si \a element_size est plus petit que \a m_alignment, considère que
  // la mémoire allouée doit être un multiple de l'alignement.
  // (On pourrait être plus restrictif suivant les types mais ce n'est en
  // général pas utile).
  size_t block_size = alignment / element_size;
  if (block_size <= 1)
    return wanted_capacity;
 
  // Si l'alignement n'est pas un multiple de la taille d'un élément,
  // cela signifie que l'élément ne sera pas utilisé pour la vectorisation.
  // Il n'est donc pas nécessaire dans ce cas de modifier la capacité.
  size_t nb_element = alignment % element_size;
  if (nb_element != 0)
    return wanted_capacity;
 
  if (is_verbose)
    std::cout << " wanted_capacity=" << wanted_capacity
              << " element_size=" << element_size
              << " block_size=" << block_size << '\n';
 
  // Ajoute à la capacité ce qu'il faut pour que le module soit 0.
  size_t modulo = wanted_capacity % block_size;
  if (modulo != 0)
    wanted_capacity += (block_size - modulo);
  if (is_verbose)
    std::cout << " final_wanted_capacity=" << wanted_capacity
              << " modulo=" << modulo << '\n';
  ARCCORE_ASSERT(((wanted_capacity % block_size) == 0), ("Bad capacity"));
  return wanted_capacity;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
size_t AlignedMemoryAllocator::
adjustCapacity(size_t wanted_capacity, size_t element_size)
{
  return adjustMemoryCapacity(wanted_capacity, element_size, m_alignment);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
Int64 AlignedMemoryAllocator3::
adjustedCapacity([[maybe_unused]] MemoryAllocationArgs args, Int64 wanted_capacity, Int64 element_size) const
{
  return adjustMemoryCapacity(wanted_capacity, element_size, m_alignment);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void* PrintableMemoryAllocator::
allocate(size_t new_size)
{
  void* ptr = Base::allocate(new_size);
  std::cout << "DEF_ARRAY_ALLOCATE new_size=" << new_size << " ptr=" << ptr << '\n';
  return ptr;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void* PrintableMemoryAllocator::
reallocate(void* current_ptr, size_t new_size)
{
  void* ptr = Base::reallocate(current_ptr, new_size);
  std::cout << "DEF_ARRAY_REALLOCATE new_size=" << new_size
            << " current_ptr=" << current_ptr
            << " new_ptr=" << ptr << '\n';
  return ptr;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void PrintableMemoryAllocator::
deallocate(void* ptr)
{
  std::cout << "DEF_ARRAY_DEALLOCATE ptr=" << ptr << '\n';
  Base::deallocate(ptr);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
bool IMemoryAllocator::
hasRealloc(MemoryAllocationArgs) const
{
  return hasRealloc();
}
 
AllocatedMemoryInfo IMemoryAllocator::
allocate(MemoryAllocationArgs, Int64 new_size)
{
  return AllocatedMemoryInfo(this->allocate(new_size));
}
 
AllocatedMemoryInfo IMemoryAllocator::
reallocate(MemoryAllocationArgs, AllocatedMemoryInfo current_ptr, Int64 new_size)
{
  return AllocatedMemoryInfo(this->reallocate(current_ptr.baseAddress(), new_size));
}
 
void IMemoryAllocator::
deallocate(MemoryAllocationArgs, AllocatedMemoryInfo ptr)
{
  return deallocate(ptr.baseAddress());
}
 
Int64 IMemoryAllocator::
adjustedCapacity(MemoryAllocationArgs, Int64 wanted_capacity, Int64 element_size) const
{
  auto* x = const_cast<IMemoryAllocator*>(this);
  return x->adjustCapacity(wanted_capacity, element_size);
}
 
size_t IMemoryAllocator::
guarantedAlignment(MemoryAllocationArgs) const
{
  auto* x = const_cast<IMemoryAllocator*>(this);
  return x->guarantedAlignment();
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
bool IMemoryAllocator3::
hasRealloc() const
{
  return hasRealloc(MemoryAllocationArgs{});
}
void* IMemoryAllocator3::
allocate(size_t new_size)
{
  return allocate(MemoryAllocationArgs{}, new_size).baseAddress();
}
void* IMemoryAllocator3::
reallocate(void* current_ptr, size_t new_size)
{
  return reallocate(MemoryAllocationArgs{},AllocatedMemoryInfo(current_ptr), new_size).baseAddress();
}
void IMemoryAllocator3::
deallocate(void* ptr)
{
  deallocate(MemoryAllocationArgs{},AllocatedMemoryInfo(ptr));
}
size_t IMemoryAllocator3::
adjustCapacity(size_t wanted_capacity, size_t element_size)
{
  return adjustedCapacity(MemoryAllocationArgs{},wanted_capacity, element_size);
}
size_t IMemoryAllocator3::
guarantedAlignment()
{
  return guarantedAlignment(MemoryAllocationArgs{});
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arccore
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/