blob: 3cc0c2a8c8a19f2172bd78cae3bb844fae723ee4 [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
Austin Schuhde8a8ff2019-11-30 15:25:36 -080068void PrintTo(const monotonic_clock::time_point t, std::ostream *os);
69
brians343bc112013-02-10 01:53:46 +000070namespace time {
71
Brian Silvermanc03a30c2019-02-16 18:21:56 -080072#ifdef __linux__
73
Austin Schuhf2a50ba2016-12-24 16:16:26 -080074// Construct a time representing the period of hertz.
75constexpr ::std::chrono::nanoseconds FromRate(int hertz) {
76 return ::std::chrono::duration_cast<::std::chrono::nanoseconds>(
77 ::std::chrono::seconds(1)) /
78 hertz;
79}
80
James Kuszmaul651fc3f2019-05-15 21:14:25 -070081template <typename Scalar>
82constexpr Scalar TypedDurationInSeconds(monotonic_clock::duration dt) {
83 return ::std::chrono::duration_cast<::std::chrono::duration<Scalar>>(dt)
84 .count();
85}
86
87constexpr double DurationInSeconds(monotonic_clock::duration dt) {
88 return TypedDurationInSeconds<double>(dt);
89}
90
Brian Silvermanc03a30c2019-02-16 18:21:56 -080091#endif // __linux__
92
Neil Balch229001a2018-01-07 18:22:52 -080093// Converts a monotonic_clock::duration into a timespec object.
94struct timespec to_timespec(::aos::monotonic_clock::duration duration);
95
96// Converts a monotonic_clock::time_point into a timespec object as time since
97// epoch.
98struct timespec to_timespec(::aos::monotonic_clock::time_point time);
99
Brian Silvermanc03a30c2019-02-16 18:21:56 -0800100namespace time_internal {
101
102template <class T>
103struct is_duration : std::false_type {};
104template <class Rep, class Period>
105struct is_duration<std::chrono::duration<Rep, Period>> : std::true_type {};
106
107} // namespace time_internal
108
109// Returns the greatest duration t representable in ToDuration that is less or
110// equal to d.
111// Implementation copied from
112// https://en.cppreference.com/w/cpp/chrono/duration/floor.
113// TODO(Brian): Remove once we have C++17 support.
114template <class To, class Rep, class Period,
115 class = std::enable_if_t<time_internal::is_duration<To>{}>>
116constexpr To floor(const std::chrono::duration<Rep, Period> &d) {
117 To t = std::chrono::duration_cast<To>(d);
118 if (t > d) return t - To{1};
119 return t;
120}
121
122// Returns the value t representable in ToDuration that is the closest to d. If
123// there are two such values, returns the even value (that is, the value t such
124// that t % 2 == 0).
125// Implementation copied from
126// https://en.cppreference.com/w/cpp/chrono/duration/round.
127// TODO(Brian): Remove once we have C++17 support.
128template <class To, class Rep, class Period,
129 class = std::enable_if_t<
130 time_internal::is_duration<To>{} &&
131 !std::chrono::treat_as_floating_point<typename To::rep>{}>>
132constexpr To round(const std::chrono::duration<Rep, Period> &d) {
133 To t0 = aos::time::floor<To>(d);
134 To t1 = t0 + To{1};
135 auto diff0 = d - t0;
136 auto diff1 = t1 - d;
137 if (diff0 == diff1) {
138 if (t0.count() & 1) return t1;
139 return t0;
140 } else if (diff0 < diff1) {
141 return t0;
142 }
143 return t1;
144}
145
146// Returns the nearest time point to tp representable in ToDuration, rounding to
147// even in halfway cases, like std::chrono::round in C++17.
148// Implementation copied from
149// https://en.cppreference.com/w/cpp/chrono/time_point/round.
150// TODO(Brian): Remove once we have C++17 support.
151template <class To, class Clock, class FromDuration,
152 class = std::enable_if_t<
153 time_internal::is_duration<To>{} &&
154 !std::chrono::treat_as_floating_point<typename To::rep>{}>>
155constexpr std::chrono::time_point<Clock, To> round(
156 const std::chrono::time_point<Clock, FromDuration> &tp) {
157 return std::chrono::time_point<Clock, To>{
158 aos::time::round<To>(tp.time_since_epoch())};
159}
160
brians343bc112013-02-10 01:53:46 +0000161} // namespace time
162} // namespace aos
163
Brian Silvermanc03a30c2019-02-16 18:21:56 -0800164#ifdef __linux__
165
Austin Schuh793d6b92016-05-01 13:28:14 -0700166namespace std {
167namespace this_thread {
168// Template specialization for monotonic_clock, since we can use clock_nanosleep
169// with TIMER_ABSTIME and get very precise absolute time sleeps.
170template <>
171void sleep_until(const ::aos::monotonic_clock::time_point &end_time);
172
173} // namespace this_thread
174} // namespace std
175
Brian Silvermanc03a30c2019-02-16 18:21:56 -0800176#endif // __linux__
Austin Schuh793d6b92016-05-01 13:28:14 -0700177
John Park33858a32018-09-28 23:05:48 -0700178#endif // AOS_TIME_H_