Update copyright to LGPL on all files
[dyninst.git] / common / h / timing.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 #ifndef __TIMING_H
33 #define __TIMING_H
34
35 #include "common/h/Types.h"  // for getCurrentTimeRaw()
36 #include "common/h/Time.h"   // for getCurrentTime(), ...
37
38
39 /* Function for general time retrieval.  Use in dyninst, front-end; don't use
40    in daemon when desire high res timer level if exists instead (see
41    getWallTime in init.h) */
42 COMMON_EXPORT timeStamp getCurrentTime();
43
44 /* returns primitive wall time in microsecond units since 1970, 
45    (eg. gettimeofday) used by getCurrentTime() */
46 COMMON_EXPORT int64_t getRawTime1970();
47
48 /* Calculates the cpu cycle rate value.  Needs to be called once,
49    before any getCyclesPerSecond() call */
50 COMMON_EXPORT void initCyclesPerSecond();
51
52 /* Returns the cpu cycle rate.  Timeunits represented as units
53    (ie. cycles) per nanosecond */
54 COMMON_EXPORT timeUnit getCyclesPerSecond();
55
56 /* Platform dependent, used by initCyclesPerSecond(). */
57 COMMON_EXPORT double calcCyclesPerSecondOS();
58
59 enum { cpsMethodNotAvailable = -1 };
60
61 /* A default stab at getting the cycle rate.  Used by calcCyclesPerSecondOS
62    if a method which gets a more precise value isn't available. */
63 COMMON_EXPORT double calcCyclesPerSecond_default();
64
65
66 #endif
67
68
69