Update copyright to LGPL on all files
[dyninst.git] / common / h / Timer.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 /************************************************************************
33  * Timer.h: timer functions (for posix systems).
34 ************************************************************************/
35
36
37 #if !defined(_Timer_h_)
38 #define _Timer_h_
39
40
41 /************************************************************************
42  * header files.
43 ************************************************************************/
44 #include "common/h/headers.h"
45 #include "common/h/std_namesp.h"
46
47
48 /************************************************************************
49  * class timer
50 ************************************************************************/
51
52 class COMMON_EXPORT timer {
53 public:
54      timer ();
55      timer (const timer &);
56     ~timer ();
57
58     timer&     operator= (const timer &);
59     timer&    operator+= (const timer &);
60     timer      operator+ (const timer &)                const;
61
62     void           clear ();
63     void           start ();
64     void            stop ();
65
66     double         usecs ()                             const;
67     double         ssecs ()                             const;
68     double         wsecs ()                             const;
69
70     bool      is_running ()                             const;
71
72     double CYCLES_PER_SEC() const { return CYCLES_PER_SEC_;}
73     double NANOSECS_PER_SEC() const { return NANOSECS_PER_SEC_;}
74     double MICROSECS_PER_SEC() const { return MICROSECS_PER_SEC_;}
75
76      // friend
77      // ostream&  operator<< (ostream &os, const timer &t) {
78      // t.print(os); return os;}
79
80 private:
81      // void           print (ostream &);
82
83     static
84     void     get_current (double &, double &, double &);
85
86     double      usecs_, ssecs_, wsecs_;
87     double      cu_, cs_, cw_;
88     unsigned activation_count_;
89
90      const double CYCLES_PER_SEC_;
91      const double MICROSECS_PER_SEC_;
92      const double NANOSECS_PER_SEC_;
93 };
94
95 #endif /* !defined(_Timer_h_) */