ITimeStats.h

// -*- 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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ITimeStats.h                                                (C) 2000-2025 */
/*                                                                           */
/* Interface managing execution time statistics.                             */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ITIMESTATS_H
#define ARCANE_CORE_ITIMESTATS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class Properties;
class Timer;
class JSONWriter;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ITimeStats
{
 public:
 
  // Releases resources.
  virtual ~ITimeStats() = default;
 
 public:

  virtual void beginGatherStats() = 0;
  virtual void endGatherStats() = 0;
 
 public:
 
  virtual void beginAction(const String& action_name) = 0;
  virtual void endAction(const String& action_name, bool print_time) = 0;
 
  virtual void beginPhase(eTimePhase phase) = 0;
  virtual void endPhase(eTimePhase phase) = 0;
 
 public:

  virtual Real elapsedTime(eTimePhase phase) = 0;

  virtual Real elapsedTime(eTimePhase phase, const String& action) = 0;

  virtual void dumpCurrentStats(const String& name) = 0;
 
 public:

  virtual void dumpStats(std::ostream& ostr, bool is_verbose, Real nb,
                         const String& name, bool use_elapsed_time = false) = 0;

  virtual void dumpTimeAndMemoryUsage(IParallelMng* pm) = 0;

  virtual bool isGathering() const = 0;

  virtual void dumpStatsJSON(JSONWriter& writer) = 0;

  virtual ITimeMetricCollector* metricCollector() = 0;

  virtual void notifyNewIterationLoop() = 0;
  virtual void saveTimeValues(Properties* p) = 0;
  virtual void mergeTimeValues(Properties* p) = 0;
 
  /*
   * \brief Resets the current statistics for an action and its sub-actions
   *
   * Resets the statistics for action \a action_name and its
   * sub-actions. If no action named \a action_name exists, it does nothing.
   *
   * This method is reserved for testing and should not be used
   * outside of this configuration to avoid invalidating the
   * temporal statistics.
   */
  virtual void resetStats(const String& action_name) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif