1 /*
   2  * Copyright (c) 1997, 2013, 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 "utilities/globalDefinitions.hpp"
  29 
  30 // Timers for simple measurement.
  31 
  32 class elapsedTimer VALUE_OBJ_CLASS_SPEC {
  33   friend class VMStructs;
  34  private:
  35   jlong _counter;
  36   jlong _start_counter;
  37   bool  _active;
  38  public:
  39   elapsedTimer()             { _active = false; reset(); }
  40   elapsedTimer(jlong time, jlong timeUnitsPerSecond);
  41   void add(elapsedTimer t);
  42   void start();
  43   void stop();
  44   void reset()               { _counter = 0; }
  45   double seconds() const;
  46   jlong milliseconds() const;
  47   jlong ticks() const        { return _counter; }
  48   jlong active_ticks() const;
  49   bool  is_active() const { return _active; }
  50 };
  51 
  52 // TimeStamp is used for recording when an event took place.
  53 class TimeStamp VALUE_OBJ_CLASS_SPEC {
  54  private:
  55   jlong _counter;
  56  public:
  57   TimeStamp()  { _counter = 0; }
  58   void clear() { _counter = 0; }
  59   // has the timestamp been updated since being created or cleared?
  60   bool is_updated() const { return _counter != 0; }
  61   // update to current elapsed time
  62   void update();
  63   // update to given elapsed time
  64   void update_to(jlong ticks);
  65   // returns seconds since updated
  66   // (must not be in a cleared state:  must have been previously updated)
  67   double seconds() const;
  68   jlong milliseconds() const;
  69   // ticks elapsed between VM start and last update
  70   jlong ticks() const { return _counter; }
  71   // ticks elapsed since last update
  72   jlong ticks_since_update() const;
  73 };
  74 
  75 // TraceTime is used for tracing the execution time of a block
  76 // Usage:
  77 //  { TraceTime t("block time")
  78 //    some_code();
  79 //  }
  80 //
  81 
  82 class TraceTime: public StackObj {
  83  private:
  84   bool          _active;    // do timing
  85   bool          _verbose;   // report every timing
  86   elapsedTimer  _t;         // timer
  87   elapsedTimer* _accum;     // accumulator




  88  public:
  89   // Constructors
  90   TraceTime(const char* title,
  91             bool doit = true);

  92   TraceTime(const char* title,
  93             elapsedTimer* accumulator,
  94             bool doit = true,
  95             bool verbose = false);

  96   ~TraceTime();
  97 
  98   // Accessors
  99   void set_verbose(bool verbose)  { _verbose = verbose; }
 100   bool verbose() const            { return _verbose;    }
 101 
 102   // Activation
 103   void suspend()  { if (_active) _t.stop();  }
 104   void resume()   { if (_active) _t.start(); }
 105 };
 106 
 107 class TraceCPUTime: public StackObj {
 108  private:
 109   bool _active;                 // true if times will be measured and printed
 110   bool _print_cr;               // if true print carriage return at end
 111   double _starting_user_time;   // user time at start of measurement
 112   double _starting_system_time; // system time at start of measurement
 113   double _starting_real_time;   // real time at start of measurement
 114   outputStream* _logfile;       // output is printed to this stream
 115   bool _error;                  // true if an error occurred, turns off output
 116 
 117  public:
 118   TraceCPUTime(bool doit = true,
 119                bool print_cr = true,
 120                outputStream *logfile = NULL);
 121   ~TraceCPUTime();
 122 };
 123 
 124 class TimeHelper {
 125  public:
 126   static double counter_to_seconds(jlong counter);
 127   static double counter_to_millis(jlong counter);
 128 };
 129 
 130 #endif // SHARE_VM_RUNTIME_TIMER_HPP
--- EOF ---