Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Tpetra_Details_Profiling.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
44 // I don't like including everything, but currently (as of 19 Apr
45 // 2017), Kokkos does not provide a public header file to get just the
46 // Profiling hooks. Users are just supposed to include
47 // Kokkos_Core.hpp.
48 #include "Kokkos_Core.hpp"
49 
50 namespace Tpetra {
51 namespace Details {
52 
53 ProfilingRegion::ProfilingRegion (const char name[]) {
54 #if defined(KOKKOS_ENABLE_PROFILING)
56  ::Kokkos::Profiling::pushRegion(name);
57 #endif
59  tm = Teuchos::rcp(new Teuchos::TimeMonitor(*Teuchos::TimeMonitor::getNewTimer(name)));
60 
61 }
62 
63 ProfilingRegion::ProfilingRegion (const char name[], const char group[]) {
64  const bool timeit = Behavior::timing(group);
65  if (timeit)
66  {
67 #if defined(KOKKOS_ENABLE_PROFILING)
69  ::Kokkos::Profiling::pushRegion(name);
70 #endif
72  tm = Teuchos::rcp(new Teuchos::TimeMonitor(*Teuchos::TimeMonitor::getNewTimer(name)));
73  }
74 }
75 
77 #if defined(KOKKOS_ENABLE_PROFILING)
79  ::Kokkos::Profiling::popRegion();
80 #endif
81 }
82 
83 } // namespace Details
84 } // namespace Tpetra
85 
86 
static bool timing()
Whether Tpetra is in timing mode.
Declaration of Tpetra::Details::Profiling, a scope guard for Kokkos Profiling.
static bool profilingRegionUseTeuchosTimers()
Use Teuchos::Timer in Tpetra::ProfilingRegion.
ProfilingRegion(const char name[])
Open region to profile; name the region name.
static bool profilingRegionUseKokkosProfiling()
Use Kokkos::Profiling in Tpetra::ProfilingRegion.
~ProfilingRegion()
Close region to profile.
Declaration of Tpetra::Details::Behavior, a class that describes Tpetra's behavior.