Teuchos_PerformanceMonitorBase.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_PERFORMANCEMONITORBASE_H
#define TEUCHOS_PERFORMANCEMONITORBASE_H


#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_Comm.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_TableFormat.hpp"
#include <cstdlib> // atexit

namespace Teuchos
{
  enum ECounterSetOp { Intersection, Union };

  void
  mergeCounterNames (const Comm<int>& comm,
                     const Array<std::string>& localNames,
                     Array<std::string>& globalNames,
                     const ECounterSetOp setOp);

  void
  unsortedMergePair(const Array<std::string>& localNames,
                    Array<std::string>& globalNames,
                    const ECounterSetOp setOp);

  template <class T>
  class PerformanceMonitorBase
  {
  public:
    PerformanceMonitorBase(T& counter_in, bool reset=false)
      : counter_(counter_in), isRecursiveCall_(counter_.isRunning())
    {
      (void) reset;  // get rid of "unused parameter" warning
      counter_.incrementNumCalls ();
    }

    PerformanceMonitorBase () = delete;

    virtual ~PerformanceMonitorBase() = default;

    static RCP<T> getNewCounter (const std::string& name);

  private:
    static void freeTableFormat () {
      if (format_ != nullptr) {
        delete format_;
        format_ = nullptr;
      }
    }

    static void freeCounters () {
      if (counters_ != nullptr) {
        delete counters_;
        counters_ = nullptr;
      }
    }

  public:
    static TableFormat& format ()
    {
      if (format_ == nullptr) {
        format_ = new TableFormat ();
        // It _is_ possible for atexit() to fail (e.g., because it ran
        // out of memory for storing callbacks).  We could throw an
        // exception here in that case, but I think it's better just
        // to let the minor memory leak happen.
        static_cast<void>( atexit(freeTableFormat) );
      }
      TEUCHOS_TEST_FOR_EXCEPTION(
        format_ == nullptr, std::logic_error, "Teuchos::PerformanceMonitorBase::"
        "format: Should never get here!  format_ is nullptr.");

      return *format_;
    }

    static RCP<T>
    lookupCounter (const std::string& name);

    static void clearCounters ();

    static TEUCHOS_DEPRECATED void clearTimers ();

    static void clearCounter (const std::string& name);

    static TEUCHOS_DEPRECATED void clearTimer (const std::string& name);

  protected:

    const T& counter() const { return counter_; }

    T& counter() { return counter_; }

    bool isRecursiveCall() const { return isRecursiveCall_; }

    static std::map<std::string, RCP<T> >& counters ()
    {
      if (counters_ == nullptr) {
        counters_ = new std::map<std::string, RCP<T> > ();
        // It _is_ possible for atexit() to fail (e.g., because it ran
        // out of memory for storing callbacks).  We could throw an
        // exception here in that case, but I think it's better just
        // to let the minor memory leak happen.
        static_cast<void>( atexit(freeCounters) );
      }
      TEUCHOS_TEST_FOR_EXCEPTION(
        counters_ == nullptr, std::logic_error, "Teuchos::PerformanceMonitorBase::"
        "counters: Should never get here!  counters_ is nullptr.");

      return *counters_;
    }

  private:
    static TableFormat* format_;

    static std::map<std::string, RCP<T> >* counters_;

    T& counter_;

    bool isRecursiveCall_;
  };

  template<class T>
  TableFormat*
  PerformanceMonitorBase<T>::format_ = nullptr;

  template<class T>
  std::map<std::string, RCP<T> >*
  PerformanceMonitorBase<T>::counters_ = nullptr;

  template<class T>
  RCP<T>
  PerformanceMonitorBase<T>::getNewCounter (const std::string& name)
  {
    typedef std::map<std::string, RCP<T> > map_type;
    typedef typename map_type::iterator iter_type;

    map_type& ctrs = counters ();
    iter_type it = ctrs.find (name);
    RCP<T> newCounter = null;
    if (it == ctrs.end ()) {
      newCounter = rcp (new T (name));
#ifdef HAVE_TEUCHOS_DEBUG
      const bool wasNotThere = ctrs.insert (std::make_pair (name, newCounter)).second;
      TEUCHOS_TEST_FOR_EXCEPTION(
        ! wasNotThere, std::logic_error,
        "getNewCounter: insert() claims that timer \"" << name << "\" was "
        "already there in the map, even though find() claims that it was not.  "
        "Please report this bug to the Teuchos developers.");
#else
      // Use the returned iterator to optimize insertion.
      ctrs.insert (it, std::make_pair (name, newCounter));
#endif // HAVE_TEUCHOS_DEBUG
    } else {
      newCounter = it->second;
#ifdef HAVE_TEUCHOS_DEBUG
      TEUCHOS_TEST_FOR_EXCEPTION(
        it->second.is_null (), std::logic_error,
        "getNewCounter: Timer \"" << name << "\" was already there in the map, "
        "but looking it up by name resulted in a null timer.  "
        "Please report this bug to the Teuchos developers.");
      TEUCHOS_TEST_FOR_EXCEPTION(
        name != it->second->name (), std::logic_error,
        "getNewCounter: Timer \"" << name << "\" was already there in the map, "
        "but looking it up by name resulted in a timer with a different name \""
        << it->second->name () << "\".  Please report this bug to the Teuchos "
        "developers.");
#endif // HAVE_TEUCHOS_DEBUG
    }

#ifdef HAVE_TEUCHOS_DEBUG
    TEUCHOS_TEST_FOR_EXCEPTION(
      newCounter.is_null (), std::logic_error,
      "getNewCounter: At end of method, when creating timer \"" << name
      << "\", newCounter is null.  Please report this bug to the Teuchos "
      "developers.");
#endif // HAVE_TEUCHOS_DEBUG
    return newCounter;
  }

  template<class T>
  RCP<T>
  PerformanceMonitorBase<T>::lookupCounter (const std::string& name)
  {
    typedef std::map<std::string, RCP<T> > map_type;
    typedef typename map_type::iterator iter_type;

    map_type& ctrs = counters ();
    iter_type it = ctrs.find (name);
    if (it == ctrs.end ()) {
      return null;
    } else {
      return it->second;
    }
  }

  template<class T>
  void
  PerformanceMonitorBase<T>::clearCounter (const std::string& name)
  {
    counters ().erase (name);
  }

  template<class T>
  void
  PerformanceMonitorBase<T>::clearTimer (const std::string& name)
  {
    clearCounter (name);
  }

  template<class T>
  void
  PerformanceMonitorBase<T>::clearTimers ()
  {
    clearCounters ();
  }

  template<class T>
  void
  PerformanceMonitorBase<T>::clearCounters ()
  {
    counters ().clear ();
  }

} // namespace Teuchos

#endif // TEUCHOS_PERFORMANCEMONITORBASE_H