xref: /aosp_15_r20/external/tensorflow/tensorflow/core/profiler/utils/time_utils.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2019 The TensorFlow Authors. All Rights Reserved.
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     http://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 
16 #ifndef TENSORFLOW_CORE_PROFILER_UTILS_TIME_UTILS_H_
17 #define TENSORFLOW_CORE_PROFILER_UTILS_TIME_UTILS_H_
18 
19 #include <cstdint>
20 
21 #include "tensorflow/core/profiler/utils/math_utils.h"
22 
23 namespace tensorflow {
24 namespace profiler {
25 
26 // Returns the current CPU wallclock time in nanoseconds.
27 int64_t GetCurrentTimeNanos();
28 
29 // Sleeps for the specified duration.
30 void SleepForNanos(int64_t ns);
SleepForMicros(int64_t us)31 inline void SleepForMicros(int64_t us) { SleepForNanos(MicroToNano(us)); }
SleepForMillis(int64_t ms)32 inline void SleepForMillis(int64_t ms) { SleepForNanos(MilliToNano(ms)); }
SleepForSeconds(int64_t s)33 inline void SleepForSeconds(int64_t s) { SleepForNanos(UniToNano(s)); }
34 
35 // Spins to simulate doing some work instead of sleeping, because sleep
36 // precision is poor. For testing only.
37 void SpinForNanos(int64_t ns);
SpinForMicros(int64_t us)38 inline void SpinForMicros(int64_t us) { SpinForNanos(us * 1000); }
39 
40 }  // namespace profiler
41 }  // namespace tensorflow
42 
43 #endif  // TENSORFLOW_CORE_PROFILER_UTILS_TIME_UTILS_H_
44