Tpetra_Details_Profiling.cpp

// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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

#include "Tpetra_Details_Profiling.hpp"
#include "Tpetra_Details_Behavior.hpp"
// I don't like including everything, but currently (as of 19 Apr
// 2017), Kokkos does not provide a public header file to get just the
// Profiling hooks.  Users are just supposed to include
// Kokkos_Core.hpp.
#include "Kokkos_Core.hpp"

namespace Tpetra {
namespace Details {

ProfilingRegion::ProfilingRegion ():
  kokkos_region_active_(false)
{

}

ProfilingRegion::ProfilingRegion (const char name[]) {
  kokkos_region_active_ = false;
  if(Behavior::profilingRegionUseKokkosProfiling()){
    kokkos_region_active_ = true;
    ::Kokkos::Profiling::pushRegion(name);
  }
  if(Behavior::profilingRegionUseTeuchosTimers())
    tm = Teuchos::rcp(new Teuchos::TimeMonitor(*Teuchos::TimeMonitor::getNewTimer(name)));

}

ProfilingRegion::ProfilingRegion (const char name[], const char group[]) {
  kokkos_region_active_ = false;
  const bool timeit = Behavior::timing(group);
  if (timeit)
  {
    if(Behavior::profilingRegionUseKokkosProfiling()){
      kokkos_region_active_ = true;
      ::Kokkos::Profiling::pushRegion(name);
    }
    if(Behavior::profilingRegionUseTeuchosTimers())
      tm = Teuchos::rcp(new Teuchos::TimeMonitor(*Teuchos::TimeMonitor::getNewTimer(name)));
  }
}

ProfilingRegion::~ProfilingRegion () {
  if(Behavior::profilingRegionUseKokkosProfiling() && kokkos_region_active_){
    ::Kokkos::Profiling::popRegion();
  }
}

} // namespace Details
} // namespace Tpetra