File: Timing.inl

package info (click to toggle)
yaha 0.1.83-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 117,148 kB
  • sloc: ansic: 3,816; cpp: 1,742; makefile: 44
file content (190 lines) | stat: -rw-r--r-- 7,489 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/* -*- Mode: C ; indent-tabs-mode: nil ; c-file-style: "stroustrup" ; column-number-mode: t -*-

    Project: YAHA, DNA alignment tool designed to find optimal split-read mappings on single-end queries.
    Author:  Greg Faust (gf4ea@virginia.edu)

    File:    Timing.inl      Contains inline functions and macros for timing of code sections.
                             This has proved invaluable for tuning the algorithms.

    License Information:

    Copyright 2009-2015 Gregory G. Faust

    Licensed under the MIT license (the "License");
    You may not use this file except in compliance with the License.
    You may obtain a copy of the License at http://opensource.org/licenses/MIT

*/

#include <sys/times.h>
#include <sys/resource.h>
#include <time.h>

// This controls output of timing information
// #define TIMING

// We need this to allow this file to be included in both C and C++ code.

#ifdef __cplusplus
#define STATIC_DECL
#else
#define STATIC_DECL static
#endif

// Calculate the different between two timevals
STATIC_DECL inline UINT64 diffTVs (struct timeval * startTV, struct timeval * endTV)
{
    return (((endTV->tv_sec - startTV->tv_sec) * 1000000) + (endTV->tv_usec - startTV->tv_usec));
}

// Convert the timevalue to seconds.
STATIC_DECL inline UINT64 tv2usec (struct timeval * TV)
{
    return (TV->tv_sec * 1000000) + TV->tv_usec;
}

#ifdef TIMING
// Output timer
STATIC_DECL inline void fprintTimer(FILE * out, const char * string, UINT64 timer)
{
    fprintf(out, "%s", string);
    fprintTimeMicroSeconds(out, timer, 3);
    fprintf(out, " User CPU time.\n");
}

// Also include the percent of total time.
STATIC_DECL inline void fprintTimerWithTotalPercent(FILE * out, const char * string, UINT64 timer, UINT64 fullTimer)
{
    fprintf(out, "%s", string);
    fprintTimeMicroSeconds(out, timer, 3);
    fprintf(out, " User CPU time (%.2f%%).\n", ((double)100.0 * timer / fullTimer));
}

// Define a new timer.
// Note that this won't work at file scope with threads.
// But still works fine inside a function.
#define defineTimer(timer) static UINT64 timer = 0

#define resetTimer(timer)                       \
    timer = 0;

// Controls whether we use the more accurate resource usage numbers or just the clock.
#define USE_RUSAGE_FOR_TIMERS

#ifdef USE_RUSAGE_FOR_TIMERS
#define setupTimers()                                                   \
    static struct rusage __usagebuf;                                    \
    static struct timeval __firstTV = {0, 0};                           \
    static struct timeval __lastTV = {0,0};                             \
    static struct timeval __startTV = {0, 0};                           \
    static struct timeval __endTV = {0, 0};                             \
    static BOOL __started = FALSE;                                      \
    // static UINT64 timerCount = 0;

#define getUTime(timebuf) timebuf.ru_utime

#define startTime()                                    \
    if (! __started)                                   \
    {                                                  \
        getrusage(RUSAGE_SELF, &__usagebuf);           \
        __firstTV = getUTime(__usagebuf);              \
        __startTV = __firstTV;                         \
    }                                                  \
    __started = TRUE;

#define endTime(timer)                                                  \
    getrusage(RUSAGE_SELF, &__usagebuf);                                \
    __lastTV = getUTime(__usagebuf);                                    \
    timer = diffTVs(&__firstTV, &__lastTV);                             \
    // fprintf(stderr, "AddToTimer called %zd times.\n", timerCount);

#define addToTimer(timer)                                               \
    getrusage(RUSAGE_SELF, &__usagebuf);                                \
    __endTV = getUTime(__usagebuf);                                     \
    timer += diffTVs(&__startTV, &__endTV);                             \
    __startTV = __endTV;                                                \
    // timerCount += 1;

#else // USE_RUSAGE_FOR_TIMERS

// We'll be using clock() to keep time.
#define setupTimers()                                                   \
    static clock_t __firstTV = 0;                                       \
    static clock_t __lastTV = 0;                                        \
    static clock_t __startTV = 0;                                       \
    static clock_t __endTV = 0;                                         \
    static BOOL __started = FALSE;                                      \
    // static UINT64 timerCount = 0;

#define startTime()                                    \
    if (! __started)                                   \
    {                                                  \
        __firstTV = clock();                           \
        __startTV = __firstTV;                         \
    }                                                  \
    __started = TRUE;

#define endTime(timer)                                                  \
    __lastTV = clock();                                                 \
    timer = __lastTV -  __firstTV;                                      \
    // fprintf(stderr, "AddToTimer called %zd times.\n", timerCount);

#define addToTimer(timer)                                               \
    __endTV = clock();                                                  \
    timer += __endTV - __startTV;                                       \
    __startTV = __endTV;                                                \
    // timerCount += 1;

#endif //USE_RUSAGE_FOR_TIMERS

#else // TIMING

// We want to make this null to avoid overhead when not timing.

#define fprintTimer(a, b, c) ;
#define fprintTimerWithTotalPercent(a, b, c, d) ;

#define setupTimers() ;
#define defineTimer(timer) ;
#define startTime() ;
#define endTime(timer) ;
#define addToTimer(timer) ;
#define resetTimer(timer) ;

#endif //TIMING

#ifdef NOTNOW
// This let's us estimate the cost of the timers themselves!
static void timeTimers()
{
    struct rusage usagebuf;
    getrusage(RUSAGE_SELF, &usagebuf);
    clock_t clocktime = 0;
    struct timeval startuserTV = usagebuf.ru_utime;
    struct timeval startsysTV = usagebuf.ru_stime;
    int iterCount = 10000000;
    for (int i=0; i<iterCount; i++) clocktime += clock();
    getrusage(RUSAGE_SELF, &usagebuf);
    struct timeval enduserTV = usagebuf.ru_utime;
    struct timeval endsysTV = usagebuf.ru_stime;
    fprintf(stderr, "%d calls to clock took ", iterCount);
    fprintTimeMicroSeconds(stderr, diffTVs(&startuserTV, &enduserTV), 4);
    fprintf(stderr, " user time, and ");
    fprintTimeMicroSeconds(stderr, diffTVs(&startsysTV, &endsysTV), 4);
    fprintf(stderr, " system time, and clock sum of ");
    fprintf(stderr, "%.4lf\n", ((double)(clocktime))/CLOCKS_PER_SEC);

    getrusage(RUSAGE_SELF, &usagebuf);
    startuserTV = usagebuf.ru_utime;
    startsysTV = usagebuf.ru_stime;
    for (int i=0; i<iterCount; i++) getrusage(RUSAGE_SELF, &usagebuf);
    getrusage(RUSAGE_SELF, &usagebuf);
    enduserTV = usagebuf.ru_utime;
    endsysTV = usagebuf.ru_stime;
    fprintf(stderr, "%d calls to rusage took ", iterCount);
    fprintTimeMicroSeconds(stderr, diffTVs(&startuserTV, &enduserTV), 4);
    fprintf(stderr, " user time, and ");
    fprintTimeMicroSeconds(stderr, diffTVs(&startsysTV, &endsysTV), 4);
    fprintf(stderr, " system time.\n");
}
#endif