PerfGraphInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "Moose.h"
#include "PerfGuard.h"

#ifndef MOOSE_NO_PERF_GRAPH
#define TIME_SECTION1(id)                                                                          \
  mooseAssert(!Threads::in_threads, "PerfGraph timing cannot be used within threaded sections");   \
  PerfGuard time_guard(this->_pg_moose_app.perfGraph(), id);
#define CHECK_TIME_SECTION(id, section_name)                                                       \
  mooseAssert(moose::internal::getPerfGraphRegistry().sectionInfo(id)._name ==                     \
                  timedSectionName(section_name),                                                  \
              "PerfGraph section '" + timedSectionName(section_name) +                             \
                  "' is already registered with name '" +                                          \
                  moose::internal::getPerfGraphRegistry().sectionInfo(id)._name + "'");
#else
#define TIME_SECTION1(id)
#define CHECK_TIME_SECTION(id, section_name)
#endif

#define TIME_SECTION2(section_name, level)                                                         \
  const PerfID __perf_id = this->registerTimedSection(section_name, level);                        \
  CHECK_TIME_SECTION(__perf_id, section_name);                                                     \
  TIME_SECTION1(__perf_id);

#define TIME_SECTION3(section_name, level, live_message)                                           \
  const PerfID __perf_id = this->registerTimedSection(section_name, level, live_message);          \
  CHECK_TIME_SECTION(__perf_id, section_name);                                                     \
  TIME_SECTION1(__perf_id);

#define TIME_SECTION4(section_name, level, live_message, print_dots)                               \
  const PerfID __perf_id =                                                                         \
      this->registerTimedSection(section_name, level, live_message, print_dots);                   \
  CHECK_TIME_SECTION(__perf_id, section_name);                                                     \
  TIME_SECTION1(__perf_id);

// Overloading solution from https://stackoverflow.com/a/11763277
#define GET_MACRO(_1, _2, _3, _4, NAME, ...) NAME
#define TIME_SECTION(...)                                                                          \
  GET_MACRO(__VA_ARGS__, TIME_SECTION4, TIME_SECTION3, TIME_SECTION2, TIME_SECTION1, )(__VA_ARGS__)

class MooseApp;
class InputParameters;
class LinearFVGradientInterface;
class MooseObject;

class PerfGraphInterface
{
public:
  static InputParameters validParams();

  PerfGraphInterface(const MooseObject * moose_object);

  PerfGraphInterface(const MooseObject * moose_object, const std::string prefix);

  PerfGraphInterface(PerfGraph & perf_graph, const std::string prefix = "");

  PerfGraphInterface(MooseApp & moose_app, const std::string prefix = "");

#ifdef MOOSE_KOKKOS_ENABLED

  PerfGraphInterface(const PerfGraphInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif

  virtual ~PerfGraphInterface() = default;

  PerfGraph & perfGraph();

  friend class LinearFVGradientInterface;

protected:
  PerfID registerTimedSection(const std::string & section_name, const unsigned int level) const;

  PerfID registerTimedSection(const std::string & section_name,
                              const unsigned int level,
                              const std::string & live_message,
                              const bool print_dots = true) const;

  std::string timedSectionName(const std::string & section_name) const;

  MooseApp & _pg_moose_app;

  const std::string _prefix;
};