summaryrefslogtreecommitdiff
path: root/indra/llcommon/lltimer.h
blob: d79f2505856c458e13ac9f2b3482fc1e31e0d6c3 (plain)
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
/**
 * @file lltimer.h
 * @brief Cross-platform objects for doing timing
 *
 * $LicenseInfo:firstyear=2000&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_TIMER_H
#define LL_TIMER_H

#if LL_LINUX || LL_DARWIN
#include <sys/time.h>
#endif
#include <limits.h>

#include "stdtypes.h"

#include <string>
#include <list>
// units conversions
#include "llunits.h"
#ifndef USEC_PER_SEC
    const U32   USEC_PER_SEC    = 1000000;
#endif
const U32   SEC_PER_MIN     = 60;
const U32   MIN_PER_HOUR    = 60;
const U32   USEC_PER_MIN    = USEC_PER_SEC * SEC_PER_MIN;
const U32   USEC_PER_HOUR   = USEC_PER_MIN * MIN_PER_HOUR;
const U32   SEC_PER_HOUR    = SEC_PER_MIN * MIN_PER_HOUR;
const F64   SEC_PER_USEC    = 1.0 / (F64) USEC_PER_SEC;

class LL_COMMON_API LLTimer
{
public:
    static LLTimer *sTimer;             // global timer

protected:
    U64 mLastClockCount;
    U64 mExpirationTicks;
    bool mStarted;

public:
    LLTimer();
    ~LLTimer();

    static void initClass();
    static void cleanupClass();

    // Return a high precision number of seconds since the start of
    // this application instance.
    static F64SecondsImplicit getElapsedSeconds()
    {
        if (sTimer)
    {
        return sTimer->getElapsedTimeF64();
    }
        else
        {
            return 0;
        }
    }

    // Return a high precision usec since epoch
    static U64MicrosecondsImplicit getTotalTime();

    // Return a high precision seconds since epoch
    static F64SecondsImplicit getTotalSeconds();


    // MANIPULATORS
    void start() { reset(); mStarted = true; }
    void stop() { mStarted = false; }
    void reset();                               // Resets the timer
    void setLastClockCount(U64 current_count);      // Sets the timer so that the next elapsed call will be relative to this time
    void setTimerExpirySec(F32SecondsImplicit expiration);
    bool checkExpirationAndReset(F32 expiration);
    bool hasExpired() const;
    F32SecondsImplicit getElapsedTimeAndResetF32(); // Returns elapsed time in seconds with reset
    F64SecondsImplicit getElapsedTimeAndResetF64();

    F32SecondsImplicit getRemainingTimeF32() const;

    static bool knownBadTimer();

    // ACCESSORS
    F32SecondsImplicit getElapsedTimeF32() const;           // Returns elapsed time in seconds
    F64SecondsImplicit getElapsedTimeF64() const;           // Returns elapsed time in seconds

    bool getStarted() const { return mStarted; }


    static U64 getCurrentClockCount();      // Returns the raw clockticks
};

//
// Various functions for initializing/accessing clock and timing stuff.  Don't use these without REALLY knowing how they work.
//
struct TimerInfo
{
    TimerInfo();
    void update();

    F64HertzImplicit        mClockFrequency;
    F64SecondsImplicit      mClockFrequencyInv;
    F64MicrosecondsImplicit mClocksToMicroseconds;
    U64                     mTotalTimeClockCount;
    U64                     mLastTotalTimeClockCount;
};

TimerInfo& get_timer_info();

LL_COMMON_API U64 get_clock_count();

// Sleep for milliseconds
LL_COMMON_API void ms_sleep(U32 ms);
LL_COMMON_API U32 micro_sleep(U64 us, U32 max_yields = 0xFFFFFFFF);

// Returns the correct UTC time in seconds, like time(NULL).
// Useful on the viewer, which may have its local clock set wrong.
LL_COMMON_API time_t time_corrected();

static inline time_t time_min()
{
    if (sizeof(time_t) == 4)
    {
        return (time_t) INT_MIN;
    } else {
#ifdef LLONG_MIN
        return (time_t) LLONG_MIN;
#else
        return (time_t) LONG_MIN;
#endif
    }
}

static inline time_t time_max()
{
    if (sizeof(time_t) == 4)
    {
        return (time_t) INT_MAX;
    } else {
#ifdef LLONG_MAX
        return (time_t) LLONG_MAX;
#else
        return (time_t) LONG_MAX;
#endif
    }
}

// Correction factor used by time_corrected() above.
extern LL_COMMON_API S32 gUTCOffset;

// Is the current computer (in its current time zone)
// observing daylight savings time?
LL_COMMON_API bool is_daylight_savings();

// Converts internal "struct tm" time buffer to Pacific Standard/Daylight Time
// Usage:
// S32 utc_time;
// utc_time = time_corrected();
// struct tm* internal_time = utc_to_pacific_time(utc_time, gDaylight);
LL_COMMON_API struct tm* utc_to_pacific_time(time_t utc_time, bool pacific_daylight_time);

LL_COMMON_API void microsecondsToTimecodeString(U64MicrosecondsImplicit current_time, std::string& tcstring);
LL_COMMON_API void secondsToTimecodeString(F32SecondsImplicit current_time, std::string& tcstring);

U64MicrosecondsImplicit LL_COMMON_API totalTime();                  // Returns current system time in microseconds

#endif