PerfGraphRegistry.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 "GeneralRegistry.h"
#include "MooseTypes.h"

#include <mutex>

// Forward Declarations
class PerfGraph;
class PerfGraphLivePrint;
class PerfNode;
void dataStore(std::ostream &, PerfGraph &, void *);

namespace moose
{
namespace internal
{
class PerfGraphRegistry;
class PerfGraphSectionInfo;
}
}

namespace moose
{
namespace internal
{

class PerfGraphSectionInfo
{
public:
  PerfGraphSectionInfo() = default;
  PerfGraphSectionInfo(const PerfID id,
                       const std::string & name,
                       const unsigned int level,
                       const std::string & live_message,
                       const bool print_dots)
    : _id(id), _name(name), _level(level), _live_message(live_message), _print_dots(print_dots)
  {
  }

  PerfID _id;

  std::string _name;

  unsigned int _level;

  std::string _live_message;

  bool _print_dots;
};

PerfGraphRegistry & getPerfGraphRegistry();

class PerfGraphRegistry : private GeneralRegistry<std::string, PerfGraphSectionInfo>
{
public:
  PerfID registerSection(const std::string & section_name, const unsigned int level);

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

  PerfID sectionID(const std::string & section_name) const { return id(section_name); }

  const PerfGraphSectionInfo & sectionInfo(const PerfID section_id) const
  {
    return item(section_id);
  }

  bool sectionExists(const std::string & section_name) const { return keyExists(section_name); }

  bool sectionExists(const PerfID section_id) const { return idExists(section_id); }

  std::size_t numSections() const { return size(); }

private:
  PerfGraphRegistry();

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

  const PerfGraphSectionInfo & readSectionInfo(PerfID section_id) const
  {
    return itemNonLocking(section_id);
  };

  friend PerfGraphRegistry & getPerfGraphRegistry();
  friend PerfGraph;
  // For accessing _id_to_section_info when storing the PerfGraph
  friend void ::dataStore(std::ostream &, PerfGraph &, void *);
};

}
}

void dataStore(std::ostream & stream, moose::internal::PerfGraphSectionInfo & info, void * context);
void dataLoad(std::istream & stream, moose::internal::PerfGraphSectionInfo & info, void * context);