Teuchos - Trilinos Tools Package Version of the Day
Teuchos_TimeMonitor.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_TIMEMONITOR_HPP
00043 #define TEUCHOS_TIMEMONITOR_HPP
00044 
00045 
00067 #include "Teuchos_PerformanceMonitorBase.hpp"
00068 #include "Teuchos_ParameterList.hpp"
00069 #include "Teuchos_Comm.hpp"
00070 #include "Teuchos_Time.hpp"
00071 
00072 #include "Teuchos_CommandLineProcessor.hpp"
00073 
00075 #define TEUCHOS_TIMER(funcName, strName) \
00076   static Teuchos::Time& funcName() \
00077   {static Teuchos::RCP<Time> rtn = \
00078       Teuchos::TimeMonitor::getNewCounter(strName); return *rtn;}
00079 
00080 
00086 #define TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, DIFF ) \
00087   static Teuchos::RCP<Teuchos::Time> DIFF ## blabla_localTimer; \
00088   if(!DIFF ## blabla_localTimer.get()) { \
00089     std::ostringstream oss; \
00090     oss << FUNCNAME; \
00091     DIFF ## blabla_localTimer = Teuchos::TimeMonitor::getNewCounter(oss.str()); \
00092   } \
00093   Teuchos::TimeMonitor DIFF ## blabla_localTimeMonitor(*DIFF ## blabla_localTimer)
00094 
00095 
00118 #define TEUCHOS_FUNC_TIME_MONITOR( FUNCNAME ) \
00119   TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, main )
00120 
00121 
00122 namespace Teuchos {
00123 
00124 
00136 typedef std::map<std::string, std::vector<std::pair<double, double> > > stat_map_type;
00137 
00164 class TEUCHOSCOMM_LIB_DLL_EXPORT TimeMonitor : public PerformanceMonitorBase<Time>
00165 {
00166 public:
00167 
00170 
00179   TimeMonitor (Time& timer, bool reset=false);
00180 
00182   ~TimeMonitor();
00184 
00193   static RCP<Time> getNewTimer (const std::string& name) {
00194     return getNewCounter (name);
00195   }
00196 
00203   static void zeroOutTimers();
00204 
00319   static void
00320   computeGlobalTimerStatistics (stat_map_type& statData,
00321                                 std::vector<std::string>& statNames,
00322                                 Ptr<const Comm<int> > comm,
00323                                 const ECounterSetOp setOp=Intersection,
00324                                 const std::string& filter="");
00325 
00354   static void
00355   computeGlobalTimerStatistics (stat_map_type& statData,
00356                                 std::vector<std::string>& statNames,
00357                                 const ECounterSetOp setOp=Intersection,
00358                                 const std::string& filter="");
00359 
00422   static void
00423   summarize (Ptr<const Comm<int> > comm,
00424              std::ostream &out=std::cout,
00425              const bool alwaysWriteLocal=false,
00426              const bool writeGlobalStats=true,
00427              const bool writeZeroTimers=true,
00428              const ECounterSetOp setOp=Intersection,
00429              const std::string& filter="");
00430 
00447   static void
00448   summarize (std::ostream& out=std::cout,
00449              const bool alwaysWriteLocal=false,
00450              const bool writeGlobalStats=true,
00451              const bool writeZeroTimers=true,
00452              const ECounterSetOp setOp=Intersection,
00453              const std::string& filter="");
00454 
00534   static void
00535   report (Ptr<const Comm<int> > comm,
00536           std::ostream& out,
00537           const std::string& filter,
00538           const RCP<ParameterList>& params=null);
00539 
00544   static void
00545   report (Ptr<const Comm<int> > comm,
00546           std::ostream& out,
00547           const RCP<ParameterList>& params=null);
00548 
00553   static void
00554   report (std::ostream& out,
00555           const std::string& filter,
00556           const RCP<ParameterList>& params=null);
00557 
00562   static void
00563   report (std::ostream& out,
00564           const RCP<ParameterList>& params=null);
00565 
00567   static RCP<const ParameterList> getValidReportParameters ();
00568 
00569  private:
00574   enum ETimeMonitorReportFormat {
00575     REPORT_FORMAT_YAML,
00576     REPORT_FORMAT_TABLE
00577   };
00578 
00583   enum ETimeMonitorYamlFormat {
00584     YAML_FORMAT_COMPACT,
00585     YAML_FORMAT_SPACIOUS
00586   };
00587 
00602   static void
00603   summarizeToYaml (Ptr<const Comm<int> > comm,
00604                    std::ostream& out,
00605                    const ETimeMonitorYamlFormat yamlStyle,
00606                    const std::string& filter="");
00607 
00612   static void
00613   summarizeToYaml (std::ostream& out,
00614                    const ETimeMonitorYamlFormat yamlStyle,
00615                    const std::string& filter="");
00616 
00621   static void setReportFormatParameter (ParameterList& plist);
00622 
00627   static void setYamlFormatParameter (ParameterList& plist);
00628 
00633   static void setSetOpParameter (ParameterList& plist);
00634 
00649   static void setReportParameters (const RCP<ParameterList>& params);
00650 
00652 
00653 
00655   static ETimeMonitorReportFormat reportFormat_;
00656 
00659   static ETimeMonitorYamlFormat yamlStyle_;
00660 
00662   static ECounterSetOp setOp_;
00663 
00665   static bool alwaysWriteLocal_;
00666 
00669   static bool writeGlobalStats_;
00670 
00672   static bool writeZeroTimers_;
00674 
00679   static bool setParams_;
00680 };
00681 
00682 
00683 } // namespace Teuchos
00684 
00685 
00686 namespace Teuchos {
00687 
00696 class TimeMonitorSurrogateImpl : public CommandLineProcessor::TimeMonitorSurrogate
00697 {
00698   virtual void summarize(std::ostream& out)
00699     {
00700       TimeMonitor::summarize(out);
00701     }
00702 };
00703 
00745 class TimeMonitorSurrogateImplInserter {
00746 public:
00748   TimeMonitorSurrogateImplInserter()
00749     {
00750       if (is_null(CommandLineProcessor::getTimeMonitorSurrogate())) {
00751         CommandLineProcessor::setTimeMonitorSurrogate(
00752           Teuchos::rcp(new TimeMonitorSurrogateImpl));
00753         //std::cout << "\nDEBUG: Injected TimeMonitorSurrogateImpl!\n";
00754       }
00755     }
00756 };
00757 
00758 
00759 } // end namespace Teuchos
00760 
00761 
00762 namespace {
00763 
00764 
00765 // Inject the impl in every translation unit to make sure it is done!
00766 Teuchos::TimeMonitorSurrogateImplInserter timeMonitorSurrogateImplInserter;
00767 
00768 
00769 } // end namespace
00770 
00771 
00772 #endif // TEUCHOS_TIMEMONITOR_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines