blob: 2d5f172aff7ff9942c21bbb80540e1962d37d0f4 [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001//===------------------------- chrono.cpp ---------------------------------===//
2//
Chandler Carruthd2012102019-01-19 10:56:40 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Howard Hinnantc51e1022010-05-11 19:42:16 +00006//
7//===----------------------------------------------------------------------===//
Eric Fiselierfc779202016-07-01 23:31:55 +00008
Howard Hinnantc51e1022010-05-11 19:42:16 +00009#include "chrono"
Marshall Clowccb92572015-06-23 14:45:02 +000010#include "cerrno" // errno
11#include "system_error" // __throw_system_error
12#include <time.h> // clock_gettime, CLOCK_MONOTONIC and CLOCK_REALTIME
Eric Fiselier7eba47e2018-07-25 20:51:49 +000013#include "include/apple_availability.h"
Ed Schoutenf7805c32015-05-14 20:54:18 +000014
Eric Fiselier7eba47e2018-07-25 20:51:49 +000015#if !defined(__APPLE__)
16#define _LIBCPP_USE_CLOCK_GETTIME
Bruno Cardoso Lopesd0027142017-01-09 19:21:48 +000017#endif // __APPLE__
18
Saleem Abdulrasoolee302e42017-01-03 21:53:51 +000019#if defined(_LIBCPP_WIN32API)
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000020#define WIN32_LEAN_AND_MEAN
21#define VC_EXTRA_LEAN
Eric Fiselierbb999f92017-05-31 22:14:05 +000022#include <windows.h>
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000023#if _WIN32_WINNT >= _WIN32_WINNT_WIN8
24#include <winapifamily.h>
25#endif
26#else
Eric Fiselier7eba47e2018-07-25 20:51:49 +000027#if !defined(CLOCK_REALTIME) || !defined(_LIBCPP_USE_CLOCK_GETTIME)
Ed Schoutenf7805c32015-05-14 20:54:18 +000028#include <sys/time.h> // for gettimeofday and timeval
Saleem Abdulrasoolee302e42017-01-03 21:53:51 +000029#endif // !defined(CLOCK_REALTIME)
30#endif // defined(_LIBCPP_WIN32API)
Ed Schoutenf7805c32015-05-14 20:54:18 +000031
Saleem Abdulrasoolae249922017-01-01 20:20:43 +000032#if !defined(_LIBCPP_HAS_NO_MONOTONIC_CLOCK)
Ed Schoutenf7805c32015-05-14 20:54:18 +000033#if __APPLE__
34#include <mach/mach_time.h> // mach_absolute_time, mach_timebase_info_data_t
Saleem Abdulrasoolee302e42017-01-03 21:53:51 +000035#elif !defined(_LIBCPP_WIN32API) && !defined(CLOCK_MONOTONIC)
Ed Schoutenf7805c32015-05-14 20:54:18 +000036#error "Monotonic clock not implemented"
37#endif
38#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000039
Michał Górny8d676fb2019-12-02 11:49:20 +010040#if defined(__ELF__) && defined(_LIBCPP_LINK_RT_LIB)
Petr Hosek99575aa2019-05-30 01:34:41 +000041#pragma comment(lib, "rt")
42#endif
43
Howard Hinnantc51e1022010-05-11 19:42:16 +000044_LIBCPP_BEGIN_NAMESPACE_STD
45
46namespace chrono
47{
48
49// system_clock
50
Howard Hinnant2c45cb42012-12-12 21:14:28 +000051const bool system_clock::is_steady;
52
Howard Hinnantc51e1022010-05-11 19:42:16 +000053system_clock::time_point
Howard Hinnantaa54ac42011-05-28 18:34:36 +000054system_clock::now() _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +000055{
Saleem Abdulrasoolee302e42017-01-03 21:53:51 +000056#if defined(_LIBCPP_WIN32API)
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000057 // FILETIME is in 100ns units
58 using filetime_duration =
59 _VSTD::chrono::duration<__int64,
60 _VSTD::ratio_multiply<_VSTD::ratio<100, 1>,
61 nanoseconds::period>>;
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000062
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000063 // The Windows epoch is Jan 1 1601, the Unix epoch Jan 1 1970.
Saleem Abdulrasool25c0d402017-01-02 18:41:50 +000064 static _LIBCPP_CONSTEXPR const seconds nt_to_unix_epoch{11644473600};
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000065
66 FILETIME ft;
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000067#if _WIN32_WINNT >= _WIN32_WINNT_WIN8
68#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000069 GetSystemTimePreciseAsFileTime(&ft);
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000070#else
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000071 GetSystemTimeAsFileTime(&ft);
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000072#endif
73#else
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000074 GetSystemTimeAsFileTime(&ft);
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000075#endif
Saleem Abdulrasool9e367702017-01-01 22:04:38 +000076
77 filetime_duration d{(static_cast<__int64>(ft.dwHighDateTime) << 32) |
78 static_cast<__int64>(ft.dwLowDateTime)};
79 return time_point(duration_cast<duration>(d - nt_to_unix_epoch));
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000080#else
Eric Fiselier7eba47e2018-07-25 20:51:49 +000081#if defined(_LIBCPP_USE_CLOCK_GETTIME) && defined(CLOCK_REALTIME)
82 struct timespec tp;
83 if (0 != clock_gettime(CLOCK_REALTIME, &tp))
84 __throw_system_error(errno, "clock_gettime(CLOCK_REALTIME) failed");
85 return time_point(seconds(tp.tv_sec) + microseconds(tp.tv_nsec / 1000));
Bruno Cardoso Lopesd0027142017-01-09 19:21:48 +000086#else
Howard Hinnantc51e1022010-05-11 19:42:16 +000087 timeval tv;
88 gettimeofday(&tv, 0);
89 return time_point(seconds(tv.tv_sec) + microseconds(tv.tv_usec));
Eric Fiselier7eba47e2018-07-25 20:51:49 +000090#endif // _LIBCPP_USE_CLOCK_GETTIME && CLOCK_REALTIME
Saleem Abdulrasool594b0422017-01-01 20:20:41 +000091#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000092}
93
94time_t
Howard Hinnantaa54ac42011-05-28 18:34:36 +000095system_clock::to_time_t(const time_point& t) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +000096{
97 return time_t(duration_cast<seconds>(t.time_since_epoch()).count());
98}
99
100system_clock::time_point
Howard Hinnantaa54ac42011-05-28 18:34:36 +0000101system_clock::from_time_t(time_t t) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000102{
103 return system_clock::time_point(seconds(t));
104}
105
Jonathan Roelofscce96eb2014-09-02 21:14:38 +0000106#ifndef _LIBCPP_HAS_NO_MONOTONIC_CLOCK
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000107// steady_clock
Ed Schoutenf7805c32015-05-14 20:54:18 +0000108//
109// Warning: If this is not truly steady, then it is non-conforming. It is
110// better for it to not exist and have the rest of libc++ use system_clock
111// instead.
Howard Hinnantc51e1022010-05-11 19:42:16 +0000112
Howard Hinnant2c45cb42012-12-12 21:14:28 +0000113const bool steady_clock::is_steady;
114
Saleem Abdulrasoolae249922017-01-01 20:20:43 +0000115#if defined(__APPLE__)
Ed Schoutenf7805c32015-05-14 20:54:18 +0000116
Louis Dionnea2dac172020-02-10 18:30:43 +0100117// Darwin libc versions >= 1133 provide ns precision via CLOCK_MONOTONIC_RAW
118#if defined(_LIBCPP_USE_CLOCK_GETTIME) && defined(CLOCK_MONOTONIC_RAW)
Bruno Cardoso Lopesd0027142017-01-09 19:21:48 +0000119steady_clock::time_point
120steady_clock::now() _NOEXCEPT
121{
122 struct timespec tp;
Louis Dionnea2dac172020-02-10 18:30:43 +0100123 if (0 != clock_gettime(CLOCK_MONOTONIC_RAW, &tp))
124 __throw_system_error(errno, "clock_gettime(CLOCK_MONOTONIC_RAW) failed");
Bruno Cardoso Lopesd0027142017-01-09 19:21:48 +0000125 return time_point(seconds(tp.tv_sec) + nanoseconds(tp.tv_nsec));
126}
127
128#else
Howard Hinnantc51e1022010-05-11 19:42:16 +0000129// mach_absolute_time() * MachInfo.numer / MachInfo.denom is the number of
130// nanoseconds since the computer booted up. MachInfo.numer and MachInfo.denom
131// are run time constants supplied by the OS. This clock has no relationship
132// to the Gregorian calendar. It's main use is as a high resolution timer.
133
134// MachInfo.numer / MachInfo.denom is often 1 on the latest equipment. Specialize
135// for that case as an optimization.
136
Howard Hinnantc51e1022010-05-11 19:42:16 +0000137static
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000138steady_clock::rep
139steady_simplified()
Howard Hinnantc51e1022010-05-11 19:42:16 +0000140{
Howard Hinnant28b24882011-12-01 20:21:04 +0000141 return static_cast<steady_clock::rep>(mach_absolute_time());
Howard Hinnantc51e1022010-05-11 19:42:16 +0000142}
143
144static
145double
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000146compute_steady_factor()
Howard Hinnantc51e1022010-05-11 19:42:16 +0000147{
148 mach_timebase_info_data_t MachInfo;
149 mach_timebase_info(&MachInfo);
150 return static_cast<double>(MachInfo.numer) / MachInfo.denom;
151}
152
153static
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000154steady_clock::rep
155steady_full()
Howard Hinnantc51e1022010-05-11 19:42:16 +0000156{
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000157 static const double factor = compute_steady_factor();
158 return static_cast<steady_clock::rep>(mach_absolute_time() * factor);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000159}
160
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000161typedef steady_clock::rep (*FP)();
Howard Hinnantc51e1022010-05-11 19:42:16 +0000162
163static
164FP
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000165init_steady_clock()
Howard Hinnantc51e1022010-05-11 19:42:16 +0000166{
167 mach_timebase_info_data_t MachInfo;
168 mach_timebase_info(&MachInfo);
169 if (MachInfo.numer == MachInfo.denom)
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000170 return &steady_simplified;
171 return &steady_full;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000172}
173
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000174steady_clock::time_point
Howard Hinnantaa54ac42011-05-28 18:34:36 +0000175steady_clock::now() _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000176{
Howard Hinnantc8dbd222010-11-20 19:16:30 +0000177 static FP fp = init_steady_clock();
Howard Hinnantc51e1022010-05-11 19:42:16 +0000178 return time_point(duration(fp()));
179}
Louis Dionnea2dac172020-02-10 18:30:43 +0100180#endif // defined(_LIBCPP_USE_CLOCK_GETTIME) && defined(CLOCK_MONOTONIC_RAW)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000181
Saleem Abdulrasoolee302e42017-01-03 21:53:51 +0000182#elif defined(_LIBCPP_WIN32API)
Saleem Abdulrasoolae249922017-01-01 20:20:43 +0000183
Marshall Clow132ccac2019-04-01 17:23:30 +0000184// https://msdn.microsoft.com/en-us/library/windows/desktop/ms644905(v=vs.85).aspx says:
185// If the function fails, the return value is zero. <snip>
Stephan T. Lavavejfb39ad72019-10-23 11:45:36 -0700186// On systems that run Windows XP or later, the function will always succeed
Marshall Clow132ccac2019-04-01 17:23:30 +0000187// and will thus never return zero.
188
189static LARGE_INTEGER
190__QueryPerformanceFrequency()
191{
192 LARGE_INTEGER val;
193 (void) QueryPerformanceFrequency(&val);
194 return val;
195}
196
Saleem Abdulrasoolae249922017-01-01 20:20:43 +0000197steady_clock::time_point
198steady_clock::now() _NOEXCEPT
199{
Marshall Clow132ccac2019-04-01 17:23:30 +0000200 static const LARGE_INTEGER freq = __QueryPerformanceFrequency();
Saleem Abdulrasoolae249922017-01-01 20:20:43 +0000201
Marshall Clow5dbb0d22019-04-02 14:00:36 +0000202 LARGE_INTEGER counter;
203 (void) QueryPerformanceCounter(&counter);
Saleem Abdulrasool91e1d612017-01-01 22:04:36 +0000204 return time_point(duration(counter.QuadPart * nano::den / freq.QuadPart));
Saleem Abdulrasoolae249922017-01-01 20:20:43 +0000205}
206
207#elif defined(CLOCK_MONOTONIC)
208
Louis Dionnea2dac172020-02-10 18:30:43 +0100209// On Apple platforms only CLOCK_UPTIME_RAW, CLOCK_MONOTONIC_RAW or
210// mach_absolute_time are able to time functions in the nanosecond range.
211// Thus, they are the only acceptable implementations of steady_clock.
Bruno Cardoso Lopesd0027142017-01-09 19:21:48 +0000212#ifdef __APPLE__
213#error "Never use CLOCK_MONOTONIC for steady_clock::now on Apple platforms"
214#endif
215
Saleem Abdulrasoolae249922017-01-01 20:20:43 +0000216steady_clock::time_point
217steady_clock::now() _NOEXCEPT
218{
219 struct timespec tp;
220 if (0 != clock_gettime(CLOCK_MONOTONIC, &tp))
221 __throw_system_error(errno, "clock_gettime(CLOCK_MONOTONIC) failed");
222 return time_point(seconds(tp.tv_sec) + nanoseconds(tp.tv_nsec));
223}
224
Ed Schoutenf7805c32015-05-14 20:54:18 +0000225#else
226#error "Monotonic clock not implemented"
227#endif
Howard Hinnant155c2af2010-05-24 17:49:41 +0000228
Jonathan Roelofscce96eb2014-09-02 21:14:38 +0000229#endif // !_LIBCPP_HAS_NO_MONOTONIC_CLOCK
230
Howard Hinnantc51e1022010-05-11 19:42:16 +0000231}
232
233_LIBCPP_END_NAMESPACE_STD