1 // Copyright 2017 The Abseil Authors.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #include "absl/time/clock.h"
16
17 #include "absl/base/attributes.h"
18 #include "absl/base/optimization.h"
19
20 #ifdef _WIN32
21 #include <windows.h>
22 #endif
23
24 #include <algorithm>
25 #include <atomic>
26 #include <cerrno>
27 #include <cstdint>
28 #include <ctime>
29 #include <limits>
30
31 #include "absl/base/internal/spinlock.h"
32 #include "absl/base/internal/unscaledcycleclock.h"
33 #include "absl/base/macros.h"
34 #include "absl/base/port.h"
35 #include "absl/base/thread_annotations.h"
36
37 namespace absl {
38 ABSL_NAMESPACE_BEGIN
Now()39 Time Now() {
40 // TODO(bww): Get a timespec instead so we don't have to divide.
41 int64_t n = absl::GetCurrentTimeNanos();
42 if (n >= 0) {
43 return time_internal::FromUnixDuration(
44 time_internal::MakeDuration(n / 1000000000, n % 1000000000 * 4));
45 }
46 return time_internal::FromUnixDuration(absl::Nanoseconds(n));
47 }
48 ABSL_NAMESPACE_END
49 } // namespace absl
50
51 // Decide if we should use the fast GetCurrentTimeNanos() algorithm
52 // based on the cyclecounter, otherwise just get the time directly
53 // from the OS on every call. This can be chosen at compile-time via
54 // -DABSL_USE_CYCLECLOCK_FOR_GET_CURRENT_TIME_NANOS=[0|1]
55 #ifndef ABSL_USE_CYCLECLOCK_FOR_GET_CURRENT_TIME_NANOS
56 #if ABSL_USE_UNSCALED_CYCLECLOCK
57 #define ABSL_USE_CYCLECLOCK_FOR_GET_CURRENT_TIME_NANOS 1
58 #else
59 #define ABSL_USE_CYCLECLOCK_FOR_GET_CURRENT_TIME_NANOS 0
60 #endif
61 #endif
62
63 #if defined(__APPLE__) || defined(_WIN32)
64 #include "absl/time/internal/get_current_time_chrono.inc"
65 #else
66 #include "absl/time/internal/get_current_time_posix.inc"
67 #endif
68
69 // Allows override by test.
70 #ifndef GET_CURRENT_TIME_NANOS_FROM_SYSTEM
71 #define GET_CURRENT_TIME_NANOS_FROM_SYSTEM() \
72 ::absl::time_internal::GetCurrentTimeNanosFromSystem()
73 #endif
74
75 #if !ABSL_USE_CYCLECLOCK_FOR_GET_CURRENT_TIME_NANOS
76 namespace absl {
77 ABSL_NAMESPACE_BEGIN
GetCurrentTimeNanos()78 int64_t GetCurrentTimeNanos() { return GET_CURRENT_TIME_NANOS_FROM_SYSTEM(); }
79 ABSL_NAMESPACE_END
80 } // namespace absl
81 #else // Use the cyclecounter-based implementation below.
82
83 // Allows override by test.
84 #ifndef GET_CURRENT_TIME_NANOS_CYCLECLOCK_NOW
85 #define GET_CURRENT_TIME_NANOS_CYCLECLOCK_NOW() \
86 ::absl::time_internal::UnscaledCycleClockWrapperForGetCurrentTime::Now()
87 #endif
88
89 namespace absl {
90 ABSL_NAMESPACE_BEGIN
91 namespace time_internal {
92 // This is a friend wrapper around UnscaledCycleClock::Now()
93 // (needed to access UnscaledCycleClock).
94 class UnscaledCycleClockWrapperForGetCurrentTime {
95 public:
Now()96 static int64_t Now() { return base_internal::UnscaledCycleClock::Now(); }
97 };
98 } // namespace time_internal
99
100 // uint64_t is used in this module to provide an extra bit in multiplications
101
102 // ---------------------------------------------------------------------
103 // An implementation of reader-write locks that use no atomic ops in the read
104 // case. This is a generalization of Lamport's method for reading a multiword
105 // clock. Increment a word on each write acquisition, using the low-order bit
106 // as a spinlock; the word is the high word of the "clock". Readers read the
107 // high word, then all other data, then the high word again, and repeat the
108 // read if the reads of the high words yields different answers, or an odd
109 // value (either case suggests possible interference from a writer).
110 // Here we use a spinlock to ensure only one writer at a time, rather than
111 // spinning on the bottom bit of the word to benefit from SpinLock
112 // spin-delay tuning.
113
114 // Acquire seqlock (*seq) and return the value to be written to unlock.
SeqAcquire(std::atomic<uint64_t> * seq)115 static inline uint64_t SeqAcquire(std::atomic<uint64_t> *seq) {
116 uint64_t x = seq->fetch_add(1, std::memory_order_relaxed);
117
118 // We put a release fence between update to *seq and writes to shared data.
119 // Thus all stores to shared data are effectively release operations and
120 // update to *seq above cannot be re-ordered past any of them. Note that
121 // this barrier is not for the fetch_add above. A release barrier for the
122 // fetch_add would be before it, not after.
123 std::atomic_thread_fence(std::memory_order_release);
124
125 return x + 2; // original word plus 2
126 }
127
128 // Release seqlock (*seq) by writing x to it---a value previously returned by
129 // SeqAcquire.
SeqRelease(std::atomic<uint64_t> * seq,uint64_t x)130 static inline void SeqRelease(std::atomic<uint64_t> *seq, uint64_t x) {
131 // The unlock store to *seq must have release ordering so that all
132 // updates to shared data must finish before this store.
133 seq->store(x, std::memory_order_release); // release lock for readers
134 }
135
136 // ---------------------------------------------------------------------
137
138 // "nsscaled" is unit of time equal to a (2**kScale)th of a nanosecond.
139 enum { kScale = 30 };
140
141 // The minimum interval between samples of the time base.
142 // We pick enough time to amortize the cost of the sample,
143 // to get a reasonably accurate cycle counter rate reading,
144 // and not so much that calculations will overflow 64-bits.
145 static const uint64_t kMinNSBetweenSamples = 2000 << 20;
146
147 // We require that kMinNSBetweenSamples shifted by kScale
148 // have at least a bit left over for 64-bit calculations.
149 static_assert(((kMinNSBetweenSamples << (kScale + 1)) >> (kScale + 1)) ==
150 kMinNSBetweenSamples,
151 "cannot represent kMaxBetweenSamplesNSScaled");
152
153 // data from a sample of the kernel's time value
154 struct TimeSampleAtomic {
155 std::atomic<uint64_t> raw_ns{0}; // raw kernel time
156 std::atomic<uint64_t> base_ns{0}; // our estimate of time
157 std::atomic<uint64_t> base_cycles{0}; // cycle counter reading
158 std::atomic<uint64_t> nsscaled_per_cycle{0}; // cycle period
159 // cycles before we'll sample again (a scaled reciprocal of the period,
160 // to avoid a division on the fast path).
161 std::atomic<uint64_t> min_cycles_per_sample{0};
162 };
163 // Same again, but with non-atomic types
164 struct TimeSample {
165 uint64_t raw_ns = 0; // raw kernel time
166 uint64_t base_ns = 0; // our estimate of time
167 uint64_t base_cycles = 0; // cycle counter reading
168 uint64_t nsscaled_per_cycle = 0; // cycle period
169 uint64_t min_cycles_per_sample = 0; // approx cycles before next sample
170 };
171
172 struct ABSL_CACHELINE_ALIGNED TimeState {
173 std::atomic<uint64_t> seq{0};
174 TimeSampleAtomic last_sample; // the last sample; under seq
175
176 // The following counters are used only by the test code.
177 int64_t stats_initializations{0};
178 int64_t stats_reinitializations{0};
179 int64_t stats_calibrations{0};
180 int64_t stats_slow_paths{0};
181 int64_t stats_fast_slow_paths{0};
182
ABSL_GUARDED_BYabsl::TimeState183 uint64_t last_now_cycles ABSL_GUARDED_BY(lock){0};
184
185 // Used by GetCurrentTimeNanosFromKernel().
186 // We try to read clock values at about the same time as the kernel clock.
187 // This value gets adjusted up or down as estimate of how long that should
188 // take, so we can reject attempts that take unusually long.
189 std::atomic<uint64_t> approx_syscall_time_in_cycles{10 * 1000};
190 // Number of times in a row we've seen a kernel time call take substantially
191 // less than approx_syscall_time_in_cycles.
192 std::atomic<uint32_t> kernel_time_seen_smaller{0};
193
194 // A reader-writer lock protecting the static locations below.
195 // See SeqAcquire() and SeqRelease() above.
196 absl::base_internal::SpinLock lock{absl::kConstInit,
197 base_internal::SCHEDULE_KERNEL_ONLY};
198 };
199 ABSL_CONST_INIT static TimeState time_state;
200
201 // Return the time in ns as told by the kernel interface. Place in *cycleclock
202 // the value of the cycleclock at about the time of the syscall.
203 // This call represents the time base that this module synchronizes to.
204 // Ensures that *cycleclock does not step back by up to (1 << 16) from
205 // last_cycleclock, to discard small backward counter steps. (Larger steps are
206 // assumed to be complete resyncs, which shouldn't happen. If they do, a full
207 // reinitialization of the outer algorithm should occur.)
GetCurrentTimeNanosFromKernel(uint64_t last_cycleclock,uint64_t * cycleclock)208 static int64_t GetCurrentTimeNanosFromKernel(uint64_t last_cycleclock,
209 uint64_t *cycleclock)
210 ABSL_EXCLUSIVE_LOCKS_REQUIRED(time_state.lock) {
211 uint64_t local_approx_syscall_time_in_cycles = // local copy
212 time_state.approx_syscall_time_in_cycles.load(std::memory_order_relaxed);
213
214 int64_t current_time_nanos_from_system;
215 uint64_t before_cycles;
216 uint64_t after_cycles;
217 uint64_t elapsed_cycles;
218 int loops = 0;
219 do {
220 before_cycles =
221 static_cast<uint64_t>(GET_CURRENT_TIME_NANOS_CYCLECLOCK_NOW());
222 current_time_nanos_from_system = GET_CURRENT_TIME_NANOS_FROM_SYSTEM();
223 after_cycles =
224 static_cast<uint64_t>(GET_CURRENT_TIME_NANOS_CYCLECLOCK_NOW());
225 // elapsed_cycles is unsigned, so is large on overflow
226 elapsed_cycles = after_cycles - before_cycles;
227 if (elapsed_cycles >= local_approx_syscall_time_in_cycles &&
228 ++loops == 20) { // clock changed frequencies? Back off.
229 loops = 0;
230 if (local_approx_syscall_time_in_cycles < 1000 * 1000) {
231 local_approx_syscall_time_in_cycles =
232 (local_approx_syscall_time_in_cycles + 1) << 1;
233 }
234 time_state.approx_syscall_time_in_cycles.store(
235 local_approx_syscall_time_in_cycles, std::memory_order_relaxed);
236 }
237 } while (elapsed_cycles >= local_approx_syscall_time_in_cycles ||
238 last_cycleclock - after_cycles < (static_cast<uint64_t>(1) << 16));
239
240 // Adjust approx_syscall_time_in_cycles to be within a factor of 2
241 // of the typical time to execute one iteration of the loop above.
242 if ((local_approx_syscall_time_in_cycles >> 1) < elapsed_cycles) {
243 // measured time is no smaller than half current approximation
244 time_state.kernel_time_seen_smaller.store(0, std::memory_order_relaxed);
245 } else if (time_state.kernel_time_seen_smaller.fetch_add(
246 1, std::memory_order_relaxed) >= 3) {
247 // smaller delays several times in a row; reduce approximation by 12.5%
248 const uint64_t new_approximation =
249 local_approx_syscall_time_in_cycles -
250 (local_approx_syscall_time_in_cycles >> 3);
251 time_state.approx_syscall_time_in_cycles.store(new_approximation,
252 std::memory_order_relaxed);
253 time_state.kernel_time_seen_smaller.store(0, std::memory_order_relaxed);
254 }
255
256 *cycleclock = after_cycles;
257 return current_time_nanos_from_system;
258 }
259
260 static int64_t GetCurrentTimeNanosSlowPath() ABSL_ATTRIBUTE_COLD;
261
262 // Read the contents of *atomic into *sample.
263 // Each field is read atomically, but to maintain atomicity between fields,
264 // the access must be done under a lock.
ReadTimeSampleAtomic(const struct TimeSampleAtomic * atomic,struct TimeSample * sample)265 static void ReadTimeSampleAtomic(const struct TimeSampleAtomic *atomic,
266 struct TimeSample *sample) {
267 sample->base_ns = atomic->base_ns.load(std::memory_order_relaxed);
268 sample->base_cycles = atomic->base_cycles.load(std::memory_order_relaxed);
269 sample->nsscaled_per_cycle =
270 atomic->nsscaled_per_cycle.load(std::memory_order_relaxed);
271 sample->min_cycles_per_sample =
272 atomic->min_cycles_per_sample.load(std::memory_order_relaxed);
273 sample->raw_ns = atomic->raw_ns.load(std::memory_order_relaxed);
274 }
275
276 // Public routine.
277 // Algorithm: We wish to compute real time from a cycle counter. In normal
278 // operation, we construct a piecewise linear approximation to the kernel time
279 // source, using the cycle counter value. The start of each line segment is at
280 // the same point as the end of the last, but may have a different slope (that
281 // is, a different idea of the cycle counter frequency). Every couple of
282 // seconds, the kernel time source is sampled and compared with the current
283 // approximation. A new slope is chosen that, if followed for another couple
284 // of seconds, will correct the error at the current position. The information
285 // for a sample is in the "last_sample" struct. The linear approximation is
286 // estimated_time = last_sample.base_ns +
287 // last_sample.ns_per_cycle * (counter_reading - last_sample.base_cycles)
288 // (ns_per_cycle is actually stored in different units and scaled, to avoid
289 // overflow). The base_ns of the next linear approximation is the
290 // estimated_time using the last approximation; the base_cycles is the cycle
291 // counter value at that time; the ns_per_cycle is the number of ns per cycle
292 // measured since the last sample, but adjusted so that most of the difference
293 // between the estimated_time and the kernel time will be corrected by the
294 // estimated time to the next sample. In normal operation, this algorithm
295 // relies on:
296 // - the cycle counter and kernel time rates not changing a lot in a few
297 // seconds.
298 // - the client calling into the code often compared to a couple of seconds, so
299 // the time to the next correction can be estimated.
300 // Any time ns_per_cycle is not known, a major error is detected, or the
301 // assumption about frequent calls is violated, the implementation returns the
302 // kernel time. It records sufficient data that a linear approximation can
303 // resume a little later.
304
GetCurrentTimeNanos()305 int64_t GetCurrentTimeNanos() {
306 // read the data from the "last_sample" struct (but don't need raw_ns yet)
307 // The reads of "seq" and test of the values emulate a reader lock.
308 uint64_t base_ns;
309 uint64_t base_cycles;
310 uint64_t nsscaled_per_cycle;
311 uint64_t min_cycles_per_sample;
312 uint64_t seq_read0;
313 uint64_t seq_read1;
314
315 // If we have enough information to interpolate, the value returned will be
316 // derived from this cycleclock-derived time estimate. On some platforms
317 // (POWER) the function to retrieve this value has enough complexity to
318 // contribute to register pressure - reading it early before initializing
319 // the other pieces of the calculation minimizes spill/restore instructions,
320 // minimizing icache cost.
321 uint64_t now_cycles =
322 static_cast<uint64_t>(GET_CURRENT_TIME_NANOS_CYCLECLOCK_NOW());
323
324 // Acquire pairs with the barrier in SeqRelease - if this load sees that
325 // store, the shared-data reads necessarily see that SeqRelease's updates
326 // to the same shared data.
327 seq_read0 = time_state.seq.load(std::memory_order_acquire);
328
329 base_ns = time_state.last_sample.base_ns.load(std::memory_order_relaxed);
330 base_cycles =
331 time_state.last_sample.base_cycles.load(std::memory_order_relaxed);
332 nsscaled_per_cycle =
333 time_state.last_sample.nsscaled_per_cycle.load(std::memory_order_relaxed);
334 min_cycles_per_sample = time_state.last_sample.min_cycles_per_sample.load(
335 std::memory_order_relaxed);
336
337 // This acquire fence pairs with the release fence in SeqAcquire. Since it
338 // is sequenced between reads of shared data and seq_read1, the reads of
339 // shared data are effectively acquiring.
340 std::atomic_thread_fence(std::memory_order_acquire);
341
342 // The shared-data reads are effectively acquire ordered, and the
343 // shared-data writes are effectively release ordered. Therefore if our
344 // shared-data reads see any of a particular update's shared-data writes,
345 // seq_read1 is guaranteed to see that update's SeqAcquire.
346 seq_read1 = time_state.seq.load(std::memory_order_relaxed);
347
348 // Fast path. Return if min_cycles_per_sample has not yet elapsed since the
349 // last sample, and we read a consistent sample. The fast path activates
350 // only when min_cycles_per_sample is non-zero, which happens when we get an
351 // estimate for the cycle time. The predicate will fail if now_cycles <
352 // base_cycles, or if some other thread is in the slow path.
353 //
354 // Since we now read now_cycles before base_ns, it is possible for now_cycles
355 // to be less than base_cycles (if we were interrupted between those loads and
356 // last_sample was updated). This is harmless, because delta_cycles will wrap
357 // and report a time much much bigger than min_cycles_per_sample. In that case
358 // we will take the slow path.
359 uint64_t delta_cycles;
360 if (seq_read0 == seq_read1 && (seq_read0 & 1) == 0 &&
361 (delta_cycles = now_cycles - base_cycles) < min_cycles_per_sample) {
362 return static_cast<int64_t>(
363 base_ns + ((delta_cycles * nsscaled_per_cycle) >> kScale));
364 }
365 return GetCurrentTimeNanosSlowPath();
366 }
367
368 // Return (a << kScale)/b.
369 // Zero is returned if b==0. Scaling is performed internally to
370 // preserve precision without overflow.
SafeDivideAndScale(uint64_t a,uint64_t b)371 static uint64_t SafeDivideAndScale(uint64_t a, uint64_t b) {
372 // Find maximum safe_shift so that
373 // 0 <= safe_shift <= kScale and (a << safe_shift) does not overflow.
374 int safe_shift = kScale;
375 while (((a << safe_shift) >> safe_shift) != a) {
376 safe_shift--;
377 }
378 uint64_t scaled_b = b >> (kScale - safe_shift);
379 uint64_t quotient = 0;
380 if (scaled_b != 0) {
381 quotient = (a << safe_shift) / scaled_b;
382 }
383 return quotient;
384 }
385
386 static uint64_t UpdateLastSample(
387 uint64_t now_cycles, uint64_t now_ns, uint64_t delta_cycles,
388 const struct TimeSample *sample) ABSL_ATTRIBUTE_COLD;
389
390 // The slow path of GetCurrentTimeNanos(). This is taken while gathering
391 // initial samples, when enough time has elapsed since the last sample, and if
392 // any other thread is writing to last_sample.
393 //
394 // Manually mark this 'noinline' to minimize stack frame size of the fast
395 // path. Without this, sometimes a compiler may inline this big block of code
396 // into the fast path. That causes lots of register spills and reloads that
397 // are unnecessary unless the slow path is taken.
398 //
399 // TODO(absl-team): Remove this attribute when our compiler is smart enough
400 // to do the right thing.
401 ABSL_ATTRIBUTE_NOINLINE
GetCurrentTimeNanosSlowPath()402 static int64_t GetCurrentTimeNanosSlowPath()
403 ABSL_LOCKS_EXCLUDED(time_state.lock) {
404 // Serialize access to slow-path. Fast-path readers are not blocked yet, and
405 // code below must not modify last_sample until the seqlock is acquired.
406 time_state.lock.Lock();
407
408 // Sample the kernel time base. This is the definition of
409 // "now" if we take the slow path.
410 uint64_t now_cycles;
411 uint64_t now_ns = static_cast<uint64_t>(
412 GetCurrentTimeNanosFromKernel(time_state.last_now_cycles, &now_cycles));
413 time_state.last_now_cycles = now_cycles;
414
415 uint64_t estimated_base_ns;
416
417 // ----------
418 // Read the "last_sample" values again; this time holding the write lock.
419 struct TimeSample sample;
420 ReadTimeSampleAtomic(&time_state.last_sample, &sample);
421
422 // ----------
423 // Try running the fast path again; another thread may have updated the
424 // sample between our run of the fast path and the sample we just read.
425 uint64_t delta_cycles = now_cycles - sample.base_cycles;
426 if (delta_cycles < sample.min_cycles_per_sample) {
427 // Another thread updated the sample. This path does not take the seqlock
428 // so that blocked readers can make progress without blocking new readers.
429 estimated_base_ns = sample.base_ns +
430 ((delta_cycles * sample.nsscaled_per_cycle) >> kScale);
431 time_state.stats_fast_slow_paths++;
432 } else {
433 estimated_base_ns =
434 UpdateLastSample(now_cycles, now_ns, delta_cycles, &sample);
435 }
436
437 time_state.lock.Unlock();
438
439 return static_cast<int64_t>(estimated_base_ns);
440 }
441
442 // Main part of the algorithm. Locks out readers, updates the approximation
443 // using the new sample from the kernel, and stores the result in last_sample
444 // for readers. Returns the new estimated time.
UpdateLastSample(uint64_t now_cycles,uint64_t now_ns,uint64_t delta_cycles,const struct TimeSample * sample)445 static uint64_t UpdateLastSample(uint64_t now_cycles, uint64_t now_ns,
446 uint64_t delta_cycles,
447 const struct TimeSample *sample)
448 ABSL_EXCLUSIVE_LOCKS_REQUIRED(time_state.lock) {
449 uint64_t estimated_base_ns = now_ns;
450 uint64_t lock_value =
451 SeqAcquire(&time_state.seq); // acquire seqlock to block readers
452
453 // The 5s in the next if-statement limits the time for which we will trust
454 // the cycle counter and our last sample to give a reasonable result.
455 // Errors in the rate of the source clock can be multiplied by the ratio
456 // between this limit and kMinNSBetweenSamples.
457 if (sample->raw_ns == 0 || // no recent sample, or clock went backwards
458 sample->raw_ns + static_cast<uint64_t>(5) * 1000 * 1000 * 1000 < now_ns ||
459 now_ns < sample->raw_ns || now_cycles < sample->base_cycles) {
460 // record this sample, and forget any previously known slope.
461 time_state.last_sample.raw_ns.store(now_ns, std::memory_order_relaxed);
462 time_state.last_sample.base_ns.store(estimated_base_ns,
463 std::memory_order_relaxed);
464 time_state.last_sample.base_cycles.store(now_cycles,
465 std::memory_order_relaxed);
466 time_state.last_sample.nsscaled_per_cycle.store(0,
467 std::memory_order_relaxed);
468 time_state.last_sample.min_cycles_per_sample.store(
469 0, std::memory_order_relaxed);
470 time_state.stats_initializations++;
471 } else if (sample->raw_ns + 500 * 1000 * 1000 < now_ns &&
472 sample->base_cycles + 50 < now_cycles) {
473 // Enough time has passed to compute the cycle time.
474 if (sample->nsscaled_per_cycle != 0) { // Have a cycle time estimate.
475 // Compute time from counter reading, but avoiding overflow
476 // delta_cycles may be larger than on the fast path.
477 uint64_t estimated_scaled_ns;
478 int s = -1;
479 do {
480 s++;
481 estimated_scaled_ns = (delta_cycles >> s) * sample->nsscaled_per_cycle;
482 } while (estimated_scaled_ns / sample->nsscaled_per_cycle !=
483 (delta_cycles >> s));
484 estimated_base_ns = sample->base_ns +
485 (estimated_scaled_ns >> (kScale - s));
486 }
487
488 // Compute the assumed cycle time kMinNSBetweenSamples ns into the future
489 // assuming the cycle counter rate stays the same as the last interval.
490 uint64_t ns = now_ns - sample->raw_ns;
491 uint64_t measured_nsscaled_per_cycle = SafeDivideAndScale(ns, delta_cycles);
492
493 uint64_t assumed_next_sample_delta_cycles =
494 SafeDivideAndScale(kMinNSBetweenSamples, measured_nsscaled_per_cycle);
495
496 // Estimate low by this much.
497 int64_t diff_ns = static_cast<int64_t>(now_ns - estimated_base_ns);
498
499 // We want to set nsscaled_per_cycle so that our estimate of the ns time
500 // at the assumed cycle time is the assumed ns time.
501 // That is, we want to set nsscaled_per_cycle so:
502 // kMinNSBetweenSamples + diff_ns ==
503 // (assumed_next_sample_delta_cycles * nsscaled_per_cycle) >> kScale
504 // But we wish to damp oscillations, so instead correct only most
505 // of our current error, by solving:
506 // kMinNSBetweenSamples + diff_ns - (diff_ns / 16) ==
507 // (assumed_next_sample_delta_cycles * nsscaled_per_cycle) >> kScale
508 ns = static_cast<uint64_t>(static_cast<int64_t>(kMinNSBetweenSamples) +
509 diff_ns - (diff_ns / 16));
510 uint64_t new_nsscaled_per_cycle =
511 SafeDivideAndScale(ns, assumed_next_sample_delta_cycles);
512 if (new_nsscaled_per_cycle != 0 &&
513 diff_ns < 100 * 1000 * 1000 && -diff_ns < 100 * 1000 * 1000) {
514 // record the cycle time measurement
515 time_state.last_sample.nsscaled_per_cycle.store(
516 new_nsscaled_per_cycle, std::memory_order_relaxed);
517 uint64_t new_min_cycles_per_sample =
518 SafeDivideAndScale(kMinNSBetweenSamples, new_nsscaled_per_cycle);
519 time_state.last_sample.min_cycles_per_sample.store(
520 new_min_cycles_per_sample, std::memory_order_relaxed);
521 time_state.stats_calibrations++;
522 } else { // something went wrong; forget the slope
523 time_state.last_sample.nsscaled_per_cycle.store(
524 0, std::memory_order_relaxed);
525 time_state.last_sample.min_cycles_per_sample.store(
526 0, std::memory_order_relaxed);
527 estimated_base_ns = now_ns;
528 time_state.stats_reinitializations++;
529 }
530 time_state.last_sample.raw_ns.store(now_ns, std::memory_order_relaxed);
531 time_state.last_sample.base_ns.store(estimated_base_ns,
532 std::memory_order_relaxed);
533 time_state.last_sample.base_cycles.store(now_cycles,
534 std::memory_order_relaxed);
535 } else {
536 // have a sample, but no slope; waiting for enough time for a calibration
537 time_state.stats_slow_paths++;
538 }
539
540 SeqRelease(&time_state.seq, lock_value); // release the readers
541
542 return estimated_base_ns;
543 }
544 ABSL_NAMESPACE_END
545 } // namespace absl
546 #endif // ABSL_USE_CYCLECLOCK_FOR_GET_CURRENT_TIME_NANOS
547
548 namespace absl {
549 ABSL_NAMESPACE_BEGIN
550 namespace {
551
552 // Returns the maximum duration that SleepOnce() can sleep for.
MaxSleep()553 constexpr absl::Duration MaxSleep() {
554 #ifdef _WIN32
555 // Windows Sleep() takes unsigned long argument in milliseconds.
556 return absl::Milliseconds(
557 std::numeric_limits<unsigned long>::max()); // NOLINT(runtime/int)
558 #else
559 return absl::Seconds(std::numeric_limits<time_t>::max());
560 #endif
561 }
562
563 // Sleeps for the given duration.
564 // REQUIRES: to_sleep <= MaxSleep().
SleepOnce(absl::Duration to_sleep)565 void SleepOnce(absl::Duration to_sleep) {
566 #ifdef _WIN32
567 Sleep(static_cast<DWORD>(to_sleep / absl::Milliseconds(1)));
568 #else
569 struct timespec sleep_time = absl::ToTimespec(to_sleep);
570 while (nanosleep(&sleep_time, &sleep_time) != 0 && errno == EINTR) {
571 // Ignore signals and wait for the full interval to elapse.
572 }
573 #endif
574 }
575
576 } // namespace
577 ABSL_NAMESPACE_END
578 } // namespace absl
579
580 extern "C" {
581
ABSL_INTERNAL_C_SYMBOL(AbslInternalSleepFor)582 ABSL_ATTRIBUTE_WEAK void ABSL_INTERNAL_C_SYMBOL(AbslInternalSleepFor)(
583 absl::Duration duration) {
584 while (duration > absl::ZeroDuration()) {
585 absl::Duration to_sleep = std::min(duration, absl::MaxSleep());
586 absl::SleepOnce(to_sleep);
587 duration -= to_sleep;
588 }
589 }
590
591 } // extern "C"
592