[flang] Add POSIX implementation for SYSTEM_CLOCK

[rovka]

Summary

This is very similar to CPU_TIME, except that we return nanoseconds
rather than seconds. This means we're potentially dealing with rather
large numbers, so we'll have to wrap around to avoid overflows.

[klausler]

flang/runtime/time-intrinsic.cpp

115

Please use modern braced initializers in the runtime; they're safer.

140

Can be constexpr.

Since count_t is a 64-bit signed integer, max_secs is going to be ca. 8e9, or roughly 300 years. That might make it hard to test your overflow cases.

[rovka]

flang/runtime/time-intrinsic.cpp

140

Well, the POSIX epoch ought to be set to 1970, and most code survives longer than people expect it to, so I'm sure it will be relevant :P
Anyway, on a serious note, are you saying we should skip the wrapping altogether and just return tv_nsec + tv_sec * NSECS_PER_SEC?

[klausler]

flang/runtime/time-intrinsic.cpp

140

No, I was pointing out that the overflow path isn't tested. Not a big deal.

[rovka]

Address review comments.

[jeanPerier]

LGTM and thanks !

flang/runtime/time-intrinsic.cpp

count_t GetSystemClockCountMax(fallback_implementation) {
   static constexpr auto max_clock_t = std::numeric_limits<std::clock_t>::max();
   static constexpr auto max_count_t = std::numeric_limits<count_t>::max();
   if constexpr (max_clock_t < max_count_t) {
     return static_cast<count_t>(max_clock_t);
   } else {
     return max_count_t;
   }
 }
+
+constexpr count_t NSECS_PER_SEC{1'000'000'000};
+
+// POSIX implementation using clock_gettime. This is only enabled if
+// clock_gettime is available.
+template <typename T = int, typename U = struct timespec>
+count_t GetSystemClockCount(preferred_implementation,
+    // We need some dummy parameters to pass to decltype(clock_gettime).
+    T ClockId = 0, U *Timespec = nullptr,
+    decltype(clock_gettime(ClockId, Timespec)) *Enabled = nullptr) {
+#if defined CLOCK_THREAD_CPUTIME_ID
+#define CLOCKID CLOCK_THREAD_CPUTIME_ID
+#elif defined CLOCK_PROCESS_CPUTIME_ID
+#define CLOCKID CLOCK_PROCESS_CPUTIME_ID
+#elif defined CLOCK_MONOTONIC
+#define CLOCKID CLOCK_MONOTONIC
+#else
+#define CLOCKID CLOCK_REALTIME
+#endif
+  struct timespec tspec;
+  if (clock_gettime(CLOCKID, &tspec) != 0) {
+    // Return -HUGE() to represent failure.
+    return -std::numeric_limits<count_t>::max();
+  }
+
+  // Wrap around to avoid overflows.
+  constexpr count_t max_secs{
+      std::numeric_limits<count_t>::max() / NSECS_PER_SEC};
+  count_t wrapped_secs{tspec.tv_sec % max_secs};
+
+  // At this point, wrapped_secs < max_secs, and max_secs has already been
+  // truncated by the division. Therefore, we should still have enough room to
+  // add tv_nsec, since it is < NSECS_PER_SEC.
+  return tspec.tv_nsec + wrapped_secs * NSECS_PER_SEC;
+}
+
+template <typename T = int, typename U = struct timespec>
+count_t GetSystemClockCountRate(preferred_implementation,
+    // We need some dummy parameters to pass to decltype(clock_gettime).
+    T ClockId = 0, U *Timespec = nullptr,
+    decltype(clock_gettime(ClockId, Timespec)) *Enabled = nullptr) {
+  return NSECS_PER_SEC;
+}
+
+template <typename T = int, typename U = struct timespec>
+count_t GetSystemClockCountMax(preferred_implementation,
+    // We need some dummy parameters to pass to decltype(clock_gettime).
+    T ClockId = 0, U *Timespec = nullptr,
+    decltype(clock_gettime(ClockId, Timespec)) *Enabled = nullptr) {
+  count_t max_secs{std::numeric_limits<count_t>::max() / NSECS_PER_SEC};
+  return max_secs * NSECS_PER_SEC - 1;
+}
 } // anonymous namespace
 
 namespace Fortran::runtime {
 extern "C" {
 
 double RTNAME(CpuTime)() { return GetCpuTime(0); }
 
 CppTypeFor<TypeCategory::Integer, 8> RTNAME(SystemClockCount)() {