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.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @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_StandardParameterEntryValidators.hpp"
#include "Teuchos_TableFormat.hpp"

namespace Teuchos
{
  enum ECounterSetOp { Intersection, Union };

  void
  mergeCounterNames (const Comm<int>& comm,
                     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();
    }

    virtual ~PerformanceMonitorBase() {}

    static RCP<T> getNewCounter(const std::string& name)
    {
      RCP<T> rtn = rcp(new T(name), true);
      counters().append(rtn);
      return rtn;
    }

    static TableFormat& format()
    {
      // WARNING This is not thread safe!  In particular, if multiple
      // threads call this method for the "first time" at the same
      // time, the RCP may be initialized incorrectly.
      static RCP<TableFormat> rtn=rcp(new TableFormat());
      return *rtn;
    }

    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 Array<RCP<T> >& counters()
    {
      // Use the "Meyers Trick" to create static data safely.
      //
      // WARNING This is not thread safe!  In particular, if multiple
      // threads call counters() for the "first time" at the same
      // time, the array may be initialized incorrectly.
      static Array<RCP<T> > rtn;
      return rtn;
    }

  private:

    T& counter_;

    bool isRecursiveCall_;
  };


  template<class T>
  RCP<T>
  PerformanceMonitorBase<T>::lookupCounter (const std::string& name)
  {
    Array<RCP<T> >& ctrs = counters();

    // This will have to change if we change how we store the
    // counters.
    for (typename Array<RCP<T> >::const_iterator it = ctrs.begin();
         it != ctrs.end(); ++it)
      if ((*it)->name() == name)
        return *it;

    return null;
  }

  template<class T>
  void
  PerformanceMonitorBase<T>::clearCounter (const std::string& name)
  {
    Array<RCP<T> > newCounters;
    // Only fill newCounters with counters whose name is not the given
    // name to clear.  Then, swap newCounters with the old list of
    // counters.
    typedef typename Array<RCP<T> >::const_iterator iter_t;
    for (iter_t it = counters().begin(); it != counters().end(); ++it)
      {
        // The variable 'it' is an Array iterator; '*it' is a 'const
        // RCP<T>&'.  We want the latter.
        if ((*it)->name() != name)
          newCounters.push_back (*it);
      }
    counters().swap (newCounters);
  }

  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 ()
  {
    // Just resizing an Array to have length zero may not necessarily
    // free its storage.  The standard idiom is to swap with an empty
    // array.
    Array<RCP<T> > newCounters;
    counters().swap (newCounters);
  }

} // namespace Teuchos

#endif // TEUCHOS_PERFORMANCEMONITORBASE_H