/indra/llcommon/lltimer.h
https://bitbucket.org/lindenlab/viewer-beta/ · C++ Header · 168 lines · 92 code · 30 blank · 46 comment · 9 complexity · ef65eba1aeed8e53c3cc721a93e8db24 MD5 · raw file
- /**
- * @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 || LL_SOLARIS
- #include <sys/time.h>
- #endif
- #include <limits.h>
- #include "stdtypes.h"
- #include <string>
- #include <list>
- // units conversions
- #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() { if (!sTimer) sTimer = new LLTimer; }
- static void cleanupClass() { delete sTimer; sTimer = NULL; }
- // Return a high precision number of seconds since the start of
- // this application instance.
- static F64 getElapsedSeconds()
- {
- return sTimer->getElapsedTimeF64();
- }
- // Return a high precision usec since epoch
- static U64 getTotalTime();
- // Return a high precision seconds since epoch
- static F64 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(F32 expiration);
- BOOL checkExpirationAndReset(F32 expiration);
- BOOL hasExpired() const;
- F32 getElapsedTimeAndResetF32(); // Returns elapsed time in seconds with reset
- F64 getElapsedTimeAndResetF64();
- F32 getRemainingTimeF32() const;
- static BOOL knownBadTimer();
- // ACCESSORS
- F32 getElapsedTimeF32() const; // Returns elapsed time in seconds
- F64 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.
- //
- LL_COMMON_API U64 get_clock_count();
- LL_COMMON_API F64 calc_clock_frequency(U32 msecs);
- LL_COMMON_API void update_clock_frequencies();
- // 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(U64 current_time, std::string& tcstring);
- LL_COMMON_API void secondsToTimecodeString(F32 current_time, std::string& tcstring);
- U64 LL_COMMON_API totalTime(); // Returns current system time in microseconds
- #endif