CD_ParticleMemory.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_PARTICLEMEMORY_H
#define CD_PARTICLEMEMORY_H
 
// Std includes
#include <atomic>
#include <cstddef>
 
// Chombo includes
#include <memtrack.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
namespace ParticleMemory {
 
enum class Kind
{
  Container = 0, 
  Buffer    = 1, 
  NumKinds  = 2  
};
 
#ifdef CH_USE_MEMORY_TRACKING
 
inline std::atomic<std::size_t> s_bytes[static_cast<int>(Kind::NumKinds)]{};
 
inline std::atomic<std::size_t> s_peak[static_cast<int>(Kind::NumKinds)]{};
 
inline std::atomic<std::size_t> s_totalBytes{0};
 
inline std::atomic<std::size_t> s_totalPeak{0};
 
#endif
 
inline void
raisePeak([[maybe_unused]] std::atomic<std::size_t>& a_mark, [[maybe_unused]] const std::size_t a_value) noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  std::size_t seen = a_mark.load(std::memory_order_relaxed);
 
  while (a_value > seen && !a_mark.compare_exchange_weak(seen, a_value, std::memory_order_relaxed)) {
  }
#endif
}
 
inline void
addBytes([[maybe_unused]] const Kind a_kind, [[maybe_unused]] const std::size_t a_bytes) noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  const int k = static_cast<int>(a_kind);
 
  raisePeak(s_peak[k], s_bytes[k].fetch_add(a_bytes, std::memory_order_relaxed) + a_bytes);
  raisePeak(s_totalPeak, s_totalBytes.fetch_add(a_bytes, std::memory_order_relaxed) + a_bytes);
#endif
}
 
inline void
removeBytes([[maybe_unused]] const Kind a_kind, [[maybe_unused]] const std::size_t a_bytes) noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  s_bytes[static_cast<int>(a_kind)].fetch_sub(a_bytes, std::memory_order_relaxed);
  s_totalBytes.fetch_sub(a_bytes, std::memory_order_relaxed);
#endif
}
 
inline std::size_t
getBytes([[maybe_unused]] const Kind a_kind) noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  return s_bytes[static_cast<int>(a_kind)].load(std::memory_order_relaxed);
#else
  return 0;
#endif
}
 
inline std::size_t
getPeak([[maybe_unused]] const Kind a_kind) noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  return s_peak[static_cast<int>(a_kind)].load(std::memory_order_relaxed);
#else
  return 0;
#endif
}
 
inline std::size_t
getAllocatedBytes() noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  return s_totalBytes.load(std::memory_order_relaxed);
#else
  return 0;
#endif
}
 
inline std::size_t
getPeakBytes() noexcept
{
#ifdef CH_USE_MEMORY_TRACKING
  return s_totalPeak.load(std::memory_order_relaxed);
#else
  return 0;
#endif
}
} // namespace ParticleMemory
 
#include <CD_NamespaceFooter.H>
 
#endif