1 /*
   2  * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_RUNTIME_TIMER_HPP
  26 #define SHARE_VM_RUNTIME_TIMER_HPP
  27 
  28 #include "logging/logTag.hpp"
  29 #include "utilities/globalDefinitions.hpp"
  30 
  31 // Timers for simple measurement.
  32 
  33 class elapsedTimer VALUE_OBJ_CLASS_SPEC {
  34   friend class VMStructs;
  35  private:
  36   jlong _counter;
  37   jlong _start_counter;
  38   bool  _active;
  39  public:
  40   elapsedTimer()             { _active = false; reset(); }
  41   elapsedTimer(jlong time, jlong timeUnitsPerSecond);
  42   void add(elapsedTimer t);
  43   void start();
  44   void stop();
  45   void reset()               { _counter = 0; }
  46   double seconds() const;
  47   jlong milliseconds() const;
  48   jlong ticks() const        { return _counter; }
  49   jlong active_ticks() const;
  50   bool  is_active() const { return _active; }
  51 };
  52 
  53 // TimeStamp is used for recording when an event took place.
  54 class TimeStamp VALUE_OBJ_CLASS_SPEC {
  55  private:
  56   jlong _counter;
  57  public:
  58   TimeStamp()  { _counter = 0; }
  59   void clear() { _counter = 0; }
  60   // has the timestamp been updated since being created or cleared?
  61   bool is_updated() const { return _counter != 0; }
  62   // update to current elapsed time
  63   void update();
  64   // update to given elapsed time
  65   void update_to(jlong ticks);
  66   // returns seconds since updated
  67   // (must not be in a cleared state:  must have been previously updated)
  68   double seconds() const;
  69   jlong milliseconds() const;
  70   // ticks elapsed between VM start and last update
  71   jlong ticks() const { return _counter; }
  72   // ticks elapsed since last update
  73   jlong ticks_since_update() const;
  74 };
  75 
  76 // TraceTime is used for tracing the execution time of a block
  77 // Usage:
  78 //  { TraceTime t("block time")
  79 //    some_code();
  80 //  }
  81 //
  82 
  83 class TraceTime: public StackObj {
  84  private:
  85   bool          _active;    // do timing
  86   bool          _verbose;   // report every timing
  87   elapsedTimer  _t;         // timer
  88   elapsedTimer* _accum;     // accumulator
  89   LogTagType    _tag;       // stream to print to
  90   const char*   _title;     // name of timer
  91   
  92   outputStream* getStream();
  93  public:
  94   // Constructors
  95   TraceTime(const char* title,
  96             bool doit = true,
  97             LogTagType tag = LogTag::__NO_TAG);
  98   TraceTime(const char* title,
  99             elapsedTimer* accumulator,
 100             bool doit = true,
 101             bool verbose = false,
 102             LogTagType tag = LogTag::__NO_TAG);
 103   ~TraceTime();
 104 
 105   // Accessors
 106   void set_verbose(bool verbose)  { _verbose = verbose; }
 107   bool verbose() const            { return _verbose;    }
 108 
 109   // Activation
 110   void suspend()  { if (_active) _t.stop();  }
 111   void resume()   { if (_active) _t.start(); }
 112 };
 113 
 114 class TraceCPUTime: public StackObj {
 115  private:
 116   bool _active;                 // true if times will be measured and printed
 117   bool _print_cr;               // if true print carriage return at end
 118   double _starting_user_time;   // user time at start of measurement
 119   double _starting_system_time; // system time at start of measurement
 120   double _starting_real_time;   // real time at start of measurement
 121   outputStream* _logfile;       // output is printed to this stream
 122   bool _error;                  // true if an error occurred, turns off output
 123 
 124  public:
 125   TraceCPUTime(bool doit = true,
 126                bool print_cr = true,
 127                outputStream *logfile = NULL);
 128   ~TraceCPUTime();
 129 };
 130 
 131 class TimeHelper {
 132  public:
 133   static double counter_to_seconds(jlong counter);
 134   static double counter_to_millis(jlong counter);
 135 };
 136 
 137 #endif // SHARE_VM_RUNTIME_TIMER_HPP
--- EOF ---