MemoryTracer.cc

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MemoryTracer.cc                                             (C) 2000-2026 */
/*                                                                           */
/* Utilities for tracing memory accesses between the accelerator and the     */
/* host.                                                                     */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/common/accelerator/internal/MemoryTracer.h"
 
#include "arccore/base/PlatformUtils.h"
#include "arccore/base/ArrayView.h"
#include "arccore/base/String.h"
 
#include "arccore/common/AllocatedMemoryInfo.h"
#include "arccore/common/IMemoryAllocator.h"
 
#include <map>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Accelerator::Impl
{
 
class MemoryTracerMng
{
  struct Info
  {
    Int64 length;
    String name;
    String stack;
  };
 
 public:
 
  void add(Span<const std::byte> bytes, const String& name, const String& stack_trace, [[maybe_unused]] Int64 timestamp)
  {
    const void* ptr = bytes.data();
    m_infos_map.insert(std::make_pair(ptr, Info{ bytes.size(), name, stack_trace }));
  }
 
  void remove(void* ptr, [[maybe_unused]] const String& name, [[maybe_unused]] const String& stack_trace, [[maybe_unused]] Int64 timestamp)
  {
    auto x = m_infos_map.find(ptr);
    if (x != m_infos_map.end())
      m_infos_map.erase(x);
  }
 
  std::pair<String, String> find(const void* ptr)
  {
    auto x = m_infos_map.lower_bound(ptr);
    if (x != m_infos_map.end())
      return std::make_pair(x->second.name, x->second.stack);
    return {};
  }
 
 private:
 
  std::map<const void*, Info> m_infos_map;
};
 
namespace
{
  MemoryTracerMng m_memory_tracer_mng;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void MemoryTracer::
notifyMemoryAllocation(Span<const std::byte> bytes, const String& name,
                       const String& stack_trace, Int64 timestamp)
{
  // TODO: make thread-safe
  m_memory_tracer_mng.add(bytes, name, stack_trace, timestamp);
}
 
void MemoryTracer::
notifyMemoryFree(void* ptr, const String& name, const String& stack_trace, Int64 timestamp)
{
  // TODO: make thread-safe
  m_memory_tracer_mng.remove(ptr, name, stack_trace, timestamp);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
std::pair<String, String> MemoryTracer::
findMemory(const void* ptr)
{
  return m_memory_tracer_mng.find(ptr);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
MemoryTracerWrapper::
MemoryTracerWrapper()
{
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void MemoryTracerWrapper::
traceDeallocate(const AllocatedMemoryInfo& mem_info, const MemoryAllocationArgs& args)
{
  if (!isActive())
    return;
 
  void* ptr = mem_info.baseAddress();
  // Uses a specific stream to ensure that outputs are not mixed
  // in case of multi-threading
  std::ostringstream ostr;
  if (m_trace_level >= 2)
    ostr << "FREE_MANAGED=" << ptr << " size=" << mem_info.capacity() << " name=" << args.arrayName();
  String s;
  if (m_trace_level >= 3) {
    s = platform::getStackTrace();
    if (m_trace_level >= 4) {
      ostr << " stack=" << s;
    }
  }
  MemoryTracer::notifyMemoryFree(ptr, args.arrayName(), s, 0);
  if (m_trace_level >= 2) {
    ostr << "\n";
    std::cout << ostr.str();
  }
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void MemoryTracerWrapper::
traceAllocate(void* p, size_t new_size, MemoryAllocationArgs args)
{
  if (!isActive())
    return;
 
  // Uses a specific stream to ensure that outputs are not mixed
  // in case of multi-threading
  std::ostringstream ostr;
  if (m_trace_level >= 2)
    ostr << "MALLOC_MANAGED=" << p << " size=" << new_size << " name=" << args.arrayName();
  String s;
  if (m_trace_level >= 3) {
    s = platform::getStackTrace();
    if (m_trace_level >= 4) {
      ostr << " stack=" << s;
    }
  }
  Span<const std::byte> bytes(reinterpret_cast<std::byte*>(p), new_size);
  MemoryTracer::notifyMemoryAllocation(bytes, args.arrayName(), s, 0);
  if (m_trace_level >= 2) {
    ostr << "\n";
    std::cout << ostr.str();
  }
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane::Accelerator::Impl
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/