MemoryInfos.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_MEMORYINFO_HPP_
#define GEOS_COMMON_MEMORYINFO_HPP_
 
#include "umpire/util/MemoryResourceTraits.hpp"
#include "common/DataTypes.hpp"
#include "common/logger/Logger.hpp"
#include "format/table/TableFormatter.hpp"
#include <unistd.h>
#include <iostream>
#if defined( GEOS_USE_CUDA )
#include <cuda.h>
#endif
 
namespace geos
{
 
class MemoryInfos
{
public:
 
  MemoryInfos( umpire::MemoryResourceTraits::resource_type resourceType );
 
  size_t getTotalMemory() const;
 
  size_t getAvailableMemory() const;
 
  bool isPhysicalMemoryHandled() const;
private:
 
  size_t m_totalMemory;
  size_t m_availableMemory;
  bool m_physicalMemoryHandled;
};
 
class MemoryLogging
{
public:
 
  static MemoryLogging & getInstance();
 
  bool isUmpireStatsLogOutputEnabled() const
  { return m_umpireStatsLogReport; }
 
  bool isUmpireStatsCsvOutputEnabled() const
  { return m_umpireStatsCsvReport; }
 
  integer getCurrentCycle() const
  { return m_currentCycle; }
 
  void enableUmpireStatsLogReport( bool enable )
  { m_umpireStatsLogReport = enable; }
 
  void enableUmpireStatsCsvReport( bool enable, string_view filename = "" );
 
  void setCurrentCycle( integer currentCycle )
  { m_currentCycle = currentCycle; }
 
  void setCurrentTime( real64 currentTime )
  { m_currentTime = currentTime; }
 
  void memoryStatsReport() const;
 
private:
 
  std::unique_ptr< TableTextFormatter > m_memoryStatLogFormatter;
 
  std::unique_ptr< TableCSVFormatter > m_memoryStatCsvFormatter;
 
  bool m_umpireStatsLogReport;
 
  bool m_umpireStatsCsvReport;
 
  string m_umpireStatsCsvReportFilename;
 
  integer m_currentCycle;
 
  real64 m_currentTime;
 
 
  MemoryLogging();
 
};
 
}
 
#endif