blob: 37455f400a67b20b92b28bca85d7bb63456df3d7 [file] [log] [blame]
John Park33858a32018-09-28 23:05:48 -07001#ifndef AOS_TIME_H_
2#define AOS_TIME_H_
brians343bc112013-02-10 01:53:46 +00003
4#include <stdint.h>
brians57dd5822013-02-27 21:44:15 +00005#include <sys/time.h>
James Kuszmaul651fc3f2019-05-15 21:14:25 -07006#include <time.h>
Brian4a424a22014-04-02 11:52:45 -07007
Austin Schuh793d6b92016-05-01 13:28:14 -07008#include <chrono>
brians343bc112013-02-10 01:53:46 +00009#include <ostream>
James Kuszmaul651fc3f2019-05-15 21:14:25 -070010#include <thread>
11#include <type_traits>
brians343bc112013-02-10 01:53:46 +000012
John Park33858a32018-09-28 23:05:48 -070013#include "aos/macros.h"
James Kuszmaul651fc3f2019-05-15 21:14:25 -070014#include "aos/type_traits/type_traits.h"
brians343bc112013-02-10 01:53:46 +000015
16namespace aos {
Austin Schuh793d6b92016-05-01 13:28:14 -070017
18class monotonic_clock {
19 public:
20 typedef ::std::chrono::nanoseconds::rep rep;
21 typedef ::std::chrono::nanoseconds::period period;
22 typedef ::std::chrono::nanoseconds duration;
23 typedef ::std::chrono::time_point<monotonic_clock> time_point;
24
25 static monotonic_clock::time_point now() noexcept;
Brian Silvermana3688802019-02-16 19:31:26 -080026 // This clock is still subject to rate adjustments based on adjtime, so it is
27 // not steady.
28 static constexpr bool is_steady = false;
29
30 // Returns the epoch (0).
31 static constexpr monotonic_clock::time_point epoch() {
32 return time_point(zero());
33 }
34
35 static constexpr monotonic_clock::duration zero() { return duration(0); }
36
37 static constexpr time_point min_time{
38 time_point(duration(::std::numeric_limits<duration::rep>::min()))};
Brian Silverman94357272019-02-23 21:00:54 -080039 static constexpr time_point max_time{
40 time_point(duration(::std::numeric_limits<duration::rep>::max()))};
Brian Silvermana3688802019-02-16 19:31:26 -080041};
42
43class realtime_clock {
44 public:
45 typedef ::std::chrono::nanoseconds::rep rep;
46 typedef ::std::chrono::nanoseconds::period period;
47 typedef ::std::chrono::nanoseconds duration;
48 typedef ::std::chrono::time_point<monotonic_clock> time_point;
49
50#ifdef __linux__
51 static monotonic_clock::time_point now() noexcept;
52#endif // __linux__
53 static constexpr bool is_steady = false;
Austin Schuh793d6b92016-05-01 13:28:14 -070054
55 // Returns the epoch (0).
56 static constexpr monotonic_clock::time_point epoch() {
Austin Schuh8aec1ed2016-05-01 13:29:20 -070057 return time_point(zero());
Austin Schuh793d6b92016-05-01 13:28:14 -070058 }
Austin Schuh8aec1ed2016-05-01 13:29:20 -070059
60 static constexpr monotonic_clock::duration zero() { return duration(0); }
Austin Schuh858c0212016-11-25 17:23:30 -080061
62 static constexpr time_point min_time{
63 time_point(duration(::std::numeric_limits<duration::rep>::min()))};
Brian Silverman94357272019-02-23 21:00:54 -080064 static constexpr time_point max_time{
65 time_point(duration(::std::numeric_limits<duration::rep>::max()))};
Austin Schuh793d6b92016-05-01 13:28:14 -070066};
67
brians343bc112013-02-10 01:53:46 +000068namespace time {
69
Brian Silvermanc03a30c2019-02-16 18:21:56 -080070#ifdef __linux__
71
Austin Schuhf2a50ba2016-12-24 16:16:26 -080072// Construct a time representing the period of hertz.
73constexpr ::std::chrono::nanoseconds FromRate(int hertz) {
74 return ::std::chrono::duration_cast<::std::chrono::nanoseconds>(
75 ::std::chrono::seconds(1)) /
76 hertz;
77}
78
James Kuszmaul651fc3f2019-05-15 21:14:25 -070079template <typename Scalar>
80constexpr Scalar TypedDurationInSeconds(monotonic_clock::duration dt) {
81 return ::std::chrono::duration_cast<::std::chrono::duration<Scalar>>(dt)
82 .count();
83}
84
85constexpr double DurationInSeconds(monotonic_clock::duration dt) {
86 return TypedDurationInSeconds<double>(dt);
87}
88
Brian Silvermanc03a30c2019-02-16 18:21:56 -080089#endif // __linux__
90
Neil Balch229001a2018-01-07 18:22:52 -080091// Converts a monotonic_clock::duration into a timespec object.
92struct timespec to_timespec(::aos::monotonic_clock::duration duration);
93
94// Converts a monotonic_clock::time_point into a timespec object as time since
95// epoch.
96struct timespec to_timespec(::aos::monotonic_clock::time_point time);
97
Brian Silvermanc03a30c2019-02-16 18:21:56 -080098namespace time_internal {
99
100template <class T>
101struct is_duration : std::false_type {};
102template <class Rep, class Period>
103struct is_duration<std::chrono::duration<Rep, Period>> : std::true_type {};
104
105} // namespace time_internal
106
107// Returns the greatest duration t representable in ToDuration that is less or
108// equal to d.
109// Implementation copied from
110// https://en.cppreference.com/w/cpp/chrono/duration/floor.
111// TODO(Brian): Remove once we have C++17 support.
112template <class To, class Rep, class Period,
113 class = std::enable_if_t<time_internal::is_duration<To>{}>>
114constexpr To floor(const std::chrono::duration<Rep, Period> &d) {
115 To t = std::chrono::duration_cast<To>(d);
116 if (t > d) return t - To{1};
117 return t;
118}
119
120// Returns the value t representable in ToDuration that is the closest to d. If
121// there are two such values, returns the even value (that is, the value t such
122// that t % 2 == 0).
123// Implementation copied from
124// https://en.cppreference.com/w/cpp/chrono/duration/round.
125// TODO(Brian): Remove once we have C++17 support.
126template <class To, class Rep, class Period,
127 class = std::enable_if_t<
128 time_internal::is_duration<To>{} &&
129 !std::chrono::treat_as_floating_point<typename To::rep>{}>>
130constexpr To round(const std::chrono::duration<Rep, Period> &d) {
131 To t0 = aos::time::floor<To>(d);
132 To t1 = t0 + To{1};
133 auto diff0 = d - t0;
134 auto diff1 = t1 - d;
135 if (diff0 == diff1) {
136 if (t0.count() & 1) return t1;
137 return t0;
138 } else if (diff0 < diff1) {
139 return t0;
140 }
141 return t1;
142}
143
144// Returns the nearest time point to tp representable in ToDuration, rounding to
145// even in halfway cases, like std::chrono::round in C++17.
146// Implementation copied from
147// https://en.cppreference.com/w/cpp/chrono/time_point/round.
148// TODO(Brian): Remove once we have C++17 support.
149template <class To, class Clock, class FromDuration,
150 class = std::enable_if_t<
151 time_internal::is_duration<To>{} &&
152 !std::chrono::treat_as_floating_point<typename To::rep>{}>>
153constexpr std::chrono::time_point<Clock, To> round(
154 const std::chrono::time_point<Clock, FromDuration> &tp) {
155 return std::chrono::time_point<Clock, To>{
156 aos::time::round<To>(tp.time_since_epoch())};
157}
158
brians343bc112013-02-10 01:53:46 +0000159} // namespace time
160} // namespace aos
161
Brian Silvermanc03a30c2019-02-16 18:21:56 -0800162#ifdef __linux__
163
Austin Schuh793d6b92016-05-01 13:28:14 -0700164namespace std {
165namespace this_thread {
166// Template specialization for monotonic_clock, since we can use clock_nanosleep
167// with TIMER_ABSTIME and get very precise absolute time sleeps.
168template <>
169void sleep_until(const ::aos::monotonic_clock::time_point &end_time);
170
171} // namespace this_thread
172} // namespace std
173
Brian Silvermanc03a30c2019-02-16 18:21:56 -0800174#endif // __linux__
Austin Schuh793d6b92016-05-01 13:28:14 -0700175
John Park33858a32018-09-28 23:05:48 -0700176#endif // AOS_TIME_H_