dep/ACE_wrappers/ace/Profile_Timer.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    Profile_Timer.h
   6  *
   7  *  $Id: Profile_Timer.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
  10  */
  11 //==========================================================================
  12
  13
  14 #ifndef ACE_PROFILE_TIMER_H
  15 #define ACE_PROFILE_TIMER_H
  16 #include /**/ "ace/pre.h"
  17
  18 #include /**/ "ace/config-all.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #include "ace/High_Res_Timer.h"
  25
  26 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  27
  28 /**
  29  * @class ACE_Profile_Timer
  30  *
  31  * @brief This class provides both a timing mechanism and a mechanism
  32  * for reporting the resource usage of a process.
  33  */
  34 class ACE_Export ACE_Profile_Timer
  35 {
  36 public:
  37
  38   /**
  39    * @class ACE_Elapsed_Time
  40    *
  41    * @brief Keeps track of the various user, system, and elapsed (real)
  42    * times.
  43    */
  44   class ACE_Elapsed_Time
  45   {
  46   public:
  47     /// Elapsed wall clock time.
  48     ACE_timer_t real_time;
  49
  50     /// CPU time spent in user space.
  51     ACE_timer_t user_time;
  52
  53     /// CPU time spent in system space.
  54     ACE_timer_t system_time;
  55   };
  56
  57   typedef ACE_Rusage Rusage;
  58
  59   // = Initialization and termination methods.
  60   /// Default constructor. Clears all time values to 0.
  61   ACE_Profile_Timer (void);
  62
  63   /// Shutdown the timer.
  64   ~ACE_Profile_Timer (void);
  65
  66   // = Timer methods.
  67   /// Activate the timer.
  68   int start (void);
  69
  70   /// Stop the timer.
  71   int stop (void);
  72
  73   // = Resource utilization methods.
  74   /// Compute the time elapsed between calls to @c start() and @c stop().
  75   int elapsed_time (ACE_Elapsed_Time &et);
  76
  77   /// Compute the amount of resource utilization between calls to @c start()
  78   /// and @c stop().
  79   void elapsed_rusage (ACE_Profile_Timer::Rusage &rusage);
  80
  81   /// Return the resource utilization (don't recompute it).
  82   void get_rusage (ACE_Profile_Timer::Rusage &rusage);
  83
  84   /// Dump the state of an object.
  85   void dump (void) const;
  86
  87   /// Declare the dynamic allocation hooks.
  88   ACE_ALLOC_HOOK_DECLARE;
  89
  90 private:
  91   /// Compute how much time has elapsed.
  92   void compute_times (ACE_Elapsed_Time &et);
  93
  94   /// Keep track of the starting resource utilization.
  95   ACE_Profile_Timer::Rusage begin_usage_;
  96
  97   /// Keep track of the ending resource utilization.
  98   ACE_Profile_Timer::Rusage end_usage_;
  99
 100   /// Keep track of the last rusage for incremental timing.
 101   ACE_Profile_Timer::Rusage last_usage_;
 102
 103 #if defined (ACE_HAS_PRUSAGE_T)
 104   /// Substract two timestructs and store their difference.
 105   void subtract (timespec_t &tdiff, timespec_t &t0, timespec_t &t1);
 106
 107   /// I/O handle for /proc file system.
 108   ACE_HANDLE proc_handle_;
 109
 110 #elif defined (ACE_HAS_GETRUSAGE)
 111   /// Substract two timestructs and store their difference.
 112   void subtract (timeval &tdiff,
 113                  timeval &t0,
 114                  timeval &t1);
 115
 116   /// Keep track of the beginning time.
 117   timeval begin_time_;
 118
 119   /// Keep track of the ending time.
 120   timeval end_time_;
 121
 122   /// Keep track of the last time for incremental timing.
 123   timeval last_time_;
 124 #endif /* ACE_HAS_PRUSAGE_T */
 125
 126 #if defined (ACE_WIN32) || (!defined (ACE_HAS_PRUSAGE_T) && !defined (ACE_HAS_GETRUSAGE))
 127   /// The high resolution timer
 128   ACE_High_Res_Timer timer_;
 129 #endif /* ACE_WIN32 || !ACE_HAS_PRUSAGE_T && !ACE_HAS_GETRUSAGE */
 130 };
 131
 132 ACE_END_VERSIONED_NAMESPACE_DECL
 133
 134 #if defined (__ACE_INLINE__)
 135 # include "ace/Profile_Timer.inl"
 136 #endif /* __ACE_INLINE__ */
 137
 138 #include /**/ "ace/post.h"
 139 #endif /* ACE_PROFILE_TIMER_H */