1 /*
2  * Copyright (c) 1997, 2018, 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 {
33   friend class VMStructs;
34  private:
35   jlong _counter;
36   jlong _start_counter;
37   bool  _active;
38  public:
elapsedTimer()39   elapsedTimer()             { _active = false; reset(); }
40   elapsedTimer(jlong time, jlong timeUnitsPerSecond);
41   void add(elapsedTimer t);
42   void start();
43   void stop();
reset()44   void reset()               { _counter = 0; }
45   double seconds() const;
46   jlong milliseconds() const;
ticks() const47   jlong ticks() const        { return _counter; }
48   jlong active_ticks() const;
is_active() const49   bool  is_active() const { return _active; }
50 };
51 
52 // TimeStamp is used for recording when an event took place.
53 class TimeStamp {
54  private:
55   jlong _counter;
56  public:
TimeStamp()57   TimeStamp()  { _counter = 0; }
clear()58   void clear() { _counter = 0; }
59   // has the timestamp been updated since being created or cleared?
is_updated() const60   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
ticks() const70   jlong ticks() const { return _counter; }
71   // ticks elapsed since last update
72   jlong ticks_since_update() const;
73 };
74 
75 class TraceCPUTime: public StackObj {
76  private:
77   bool _active;                 // true if times will be measured and printed
78   bool _print_cr;               // if true print carriage return at end
79   double _starting_user_time;   // user time at start of measurement
80   double _starting_system_time; // system time at start of measurement
81   double _starting_real_time;   // real time at start of measurement
82   outputStream* _logfile;       // output is printed to this stream
83   bool _error;                  // true if an error occurred, turns off output
84 
85  public:
86   TraceCPUTime(bool doit = true,
87                bool print_cr = true,
88                outputStream *logfile = NULL);
89   ~TraceCPUTime();
90 };
91 
92 class TimeHelper {
93  public:
94   static double counter_to_seconds(jlong counter);
95   static double counter_to_millis(jlong counter);
96   static jlong millis_to_counter(jlong millis);
97 };
98 
99 #endif // SHARE_VM_RUNTIME_TIMER_HPP
100