1 /*
   2  * Copyright (c) 1997, 2006, 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 // Timers for simple measurement.
  26 
  27 class elapsedTimer VALUE_OBJ_CLASS_SPEC {
  28   friend class VMStructs;
  29  private:
  30   jlong _counter;
  31   jlong _start_counter;
  32   bool  _active;
  33  public:
  34   elapsedTimer()             { _active = false; reset(); }
  35   void add(elapsedTimer t);
  36   void start();
  37   void stop();
  38   void reset()               { _counter = 0; }
  39   double seconds() const;
  40   jlong milliseconds() const;
  41   jlong ticks() const        { return _counter; }
  42   jlong active_ticks() const;
  43   bool  is_active() const { return _active; }
  44 };
  45 
  46 // TimeStamp is used for recording when an event took place.
  47 class TimeStamp VALUE_OBJ_CLASS_SPEC {
  48  private:
  49   jlong _counter;
  50  public:
  51   TimeStamp()  { _counter = 0; }
  52   void clear() { _counter = 0; }
  53   // has the timestamp been updated since being created or cleared?
  54   bool is_updated() const { return _counter != 0; }
  55   // update to current elapsed time
  56   void update();
  57   // update to given elapsed time
  58   void update_to(jlong ticks);
  59   // returns seconds since updated
  60   // (must not be in a cleared state:  must have been previously updated)
  61   double seconds() const;
  62   jlong milliseconds() const;
  63   // ticks elapsed between VM start and last update
  64   jlong ticks() const { return _counter; }
  65   // ticks elapsed since last update
  66   jlong ticks_since_update() const;
  67 };
  68 
  69 // TraceTime is used for tracing the execution time of a block
  70 // Usage:
  71 //  { TraceTime t("block time")
  72 //    some_code();
  73 //  }
  74 //
  75 
  76 class TraceTime: public StackObj {
  77  private:
  78   bool          _active;    // do timing
  79   bool          _verbose;   // report every timing
  80   bool          _print_cr;  // add a CR to the end of the timer report
  81   elapsedTimer  _t;         // timer
  82   elapsedTimer* _accum;     // accumulator
  83   outputStream* _logfile;   // output log file
  84  public:
  85   // Constuctors
  86   TraceTime(const char* title,
  87             bool doit = true,
  88             bool print_cr = true,
  89             outputStream *logfile = NULL);
  90   TraceTime(const char* title,
  91             elapsedTimer* accumulator,
  92             bool doit = true,
  93             bool verbose = false,
  94             outputStream *logfile = NULL );
  95   ~TraceTime();
  96 
  97   // Accessors
  98   void set_verbose(bool verbose)  { _verbose = verbose; }
  99   bool verbose() const            { return _verbose;    }
 100 
 101   // Activation
 102   void suspend()  { if (_active) _t.stop();  }
 103   void resume()   { if (_active) _t.start(); }
 104 };
 105 
 106 class TraceCPUTime: public StackObj {
 107  private:
 108   bool _active;                 // true if times will be measured and printed
 109   bool _print_cr;               // if true print carriage return at end
 110   double _starting_user_time;   // user time at start of measurement
 111   double _starting_system_time; // system time at start of measurement
 112   double _starting_real_time;   // real time at start of measurement
 113   outputStream* _logfile;       // output is printed to this stream
 114   bool _error;                  // true if an error occurred, turns off output
 115 
 116  public:
 117   TraceCPUTime(bool doit = true,
 118                bool print_cr = true,
 119                outputStream *logfile = NULL);
 120   ~TraceCPUTime();
 121 };