Bug 1957326 - Extract NowIncludingSuspendMs() and NowExcludingSuspendMs() into separate .h/.cpp; r=glandium

This patch moves NowIncludingSuspendMs() and NowExcludingSuspendMs() into
dedicated files (Now.h and Now.cpp) to improve discoverability and reusability.

Differential Revision: https://phabricator.services.mozilla.com/D243624

mozglue/misc/Now.cpp

@@ -0,0 +1,114 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "Now.h"
+
+#ifdef XP_WIN
+#  include "mozilla/DynamicallyLinkedFunctionPtr.h"
+#endif  // XP_WIN
+
+#include <stdint.h>
+
+#include "mozilla/TimeStamp.h"
+#include "mozilla/Maybe.h"
+#include "mozilla/Assertions.h"
+
+namespace mozilla {
+
+// Apple things
+#if defined(__APPLE__) && defined(__MACH__)
+#  include <time.h>
+#  include <sys/time.h>
+#  include <sys/types.h>
+#  include <mach/mach_time.h>
+
+static constexpr uint64_t kNSperMS = 1000000;
+
+Maybe<uint64_t> NowExcludingSuspendMs() {
+  return Some(clock_gettime_nsec_np(CLOCK_UPTIME_RAW) / kNSperMS);
+}
+
+Maybe<uint64_t> NowIncludingSuspendMs() {
+  return Some(clock_gettime_nsec_np(CLOCK_MONOTONIC_RAW) / kNSperMS);
+}
+
+#elif defined(XP_WIN)
+
+// Number of hundreds of nanoseconds in a millisecond
+static constexpr uint64_t kHNSperMS = 10000;
+
+Maybe<uint64_t> NowExcludingSuspendMs() {
+  ULONGLONG interrupt_time;
+  if (!QueryUnbiasedInterruptTime(&interrupt_time)) {
+    return Nothing();
+  }
+  return Some(interrupt_time / kHNSperMS);
+}
+
+Maybe<uint64_t> NowIncludingSuspendMs() {
+  static const mozilla::StaticDynamicallyLinkedFunctionPtr<void(WINAPI*)(
+      PULONGLONG)>
+      pQueryInterruptTime(L"KernelBase.dll", "QueryInterruptTime");
+  if (!pQueryInterruptTime) {
+    // On Windows, this does include the time the computer was suspended so it's
+    // an adequate fallback.
+    TimeStamp processCreation = TimeStamp::ProcessCreation();
+    TimeStamp now = TimeStamp::Now();
+    if (!processCreation.IsNull() && !now.IsNull()) {
+      return Some(uint64_t((now - processCreation).ToMilliseconds()));
+    } else {
+      return Nothing();
+    }
+  }
+  ULONGLONG interrupt_time;
+  pQueryInterruptTime(&interrupt_time);
+  return Some(interrupt_time / kHNSperMS);
+}
+
+#elif defined(XP_UNIX)  // including BSDs and Android
+#  include <time.h>
+
+// Number of nanoseconds in a millisecond.
+static constexpr uint64_t kNSperMS = 1000000;
+
+static uint64_t TimespecToMilliseconds(struct timespec aTs) {
+  return aTs.tv_sec * 1000 + aTs.tv_nsec / kNSperMS;
+}
+
+Maybe<uint64_t> NowExcludingSuspendMs() {
+  struct timespec ts = {0};
+
+#  ifdef XP_OPENBSD
+  if (clock_gettime(CLOCK_UPTIME, &ts)) {
+#  else
+  if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
+#  endif
+    return Nothing();
+  }
+  return Some(TimespecToMilliseconds(ts));
+}
+
+Maybe<uint64_t> NowIncludingSuspendMs() {
+#  ifndef CLOCK_BOOTTIME
+  return Nothing();
+#  else
+  struct timespec ts = {0};
+
+  if (clock_gettime(CLOCK_BOOTTIME, &ts)) {
+    return Nothing();
+  }
+  return Some(TimespecToMilliseconds(ts));
+#  endif
+}
+
+#else  // catch all
+
+Maybe<uint64_t> NowExcludingSuspendMs() { return Nothing(); }
+Maybe<uint64_t> NowIncludingSuspendMs() { return Nothing(); }
+
+#endif
+
+}  // namespace mozilla

mozglue/misc/Now.h

@@ -0,0 +1,25 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_Now_h
+#define mozilla_Now_h
+
+#include <stdint.h>
+
+#include "mozilla/Maybe.h"
+
+namespace mozilla {
+
+// Returns monotonic milliseconds elapsed since an arbitrary reference point,
+// excluding time when the system was suspended.
+MFBT_API Maybe<uint64_t> NowExcludingSuspendMs();
+// Returns monotonic milliseconds elapsed since an arbitrary reference point,
+// including time when the system was suspended.
+MFBT_API Maybe<uint64_t> NowIncludingSuspendMs();
+
+};  // namespace mozilla
+
+#endif  // mozilla_Now_h

mozglue/misc/Uptime.cpp

@@ -6,118 +6,15 @@
 
 #include "Uptime.h"
 
-#ifdef XP_WIN
-#  include "mozilla/DynamicallyLinkedFunctionPtr.h"
-#endif  // XP_WIN
-
-#include <stdint.h>
-
-#include "mozilla/TimeStamp.h"
-#include "mozilla/Maybe.h"
-#include "mozilla/Assertions.h"
+#include "mozilla/Now.h"
 
 using namespace mozilla;
 
 namespace {
 
-Maybe<uint64_t> NowIncludingSuspendMs();
-Maybe<uint64_t> NowExcludingSuspendMs();
 static Maybe<uint64_t> mStartExcludingSuspendMs;
 static Maybe<uint64_t> mStartIncludingSuspendMs;
 
-// Apple things
-#if defined(__APPLE__) && defined(__MACH__)
-#  include <time.h>
-#  include <sys/time.h>
-#  include <sys/types.h>
-#  include <mach/mach_time.h>
-
-const uint64_t kNSperMS = 1000000;
-
-Maybe<uint64_t> NowExcludingSuspendMs() {
-  return Some(clock_gettime_nsec_np(CLOCK_UPTIME_RAW) / kNSperMS);
-}
-
-Maybe<uint64_t> NowIncludingSuspendMs() {
-  return Some(clock_gettime_nsec_np(CLOCK_MONOTONIC_RAW) / kNSperMS);
-}
-
-#elif defined(XP_WIN)
-
-// Number of hundreds of nanoseconds in a millisecond
-static constexpr uint64_t kHNSperMS = 10000;
-
-Maybe<uint64_t> NowExcludingSuspendMs() {
-  ULONGLONG interrupt_time;
-  if (!QueryUnbiasedInterruptTime(&interrupt_time)) {
-    return Nothing();
-  }
-  return Some(interrupt_time / kHNSperMS);
-}
-
-Maybe<uint64_t> NowIncludingSuspendMs() {
-  static const mozilla::StaticDynamicallyLinkedFunctionPtr<void(WINAPI*)(
-      PULONGLONG)>
-      pQueryInterruptTime(L"KernelBase.dll", "QueryInterruptTime");
-  if (!pQueryInterruptTime) {
-    // On Windows, this does include the time the computer was suspended so it's
-    // an adequate fallback.
-    TimeStamp processCreation = TimeStamp::ProcessCreation();
-    TimeStamp now = TimeStamp::Now();
-    if (!processCreation.IsNull() && !now.IsNull()) {
-      return Some(uint64_t((now - processCreation).ToMilliseconds()));
-    } else {
-      return Nothing();
-    }
-  }
-  ULONGLONG interrupt_time;
-  pQueryInterruptTime(&interrupt_time);
-  return Some(interrupt_time / kHNSperMS);
-}
-
-#elif defined(XP_UNIX)  // including BSDs and Android
-#  include <time.h>
-
-// Number of nanoseconds in a millisecond.
-static constexpr uint64_t kNSperMS = 1000000;
-
-uint64_t TimespecToMilliseconds(struct timespec aTs) {
-  return aTs.tv_sec * 1000 + aTs.tv_nsec / kNSperMS;
-}
-
-Maybe<uint64_t> NowExcludingSuspendMs() {
-  struct timespec ts = {0};
-
-#  ifdef XP_OPENBSD
-  if (clock_gettime(CLOCK_UPTIME, &ts)) {
-#  else
-  if (clock_gettime(CLOCK_MONOTONIC, &ts)) {
-#  endif
-    return Nothing();
-  }
-  return Some(TimespecToMilliseconds(ts));
-}
-
-Maybe<uint64_t> NowIncludingSuspendMs() {
-#  ifndef CLOCK_BOOTTIME
-  return Nothing();
-#  else
-  struct timespec ts = {0};
-
-  if (clock_gettime(CLOCK_BOOTTIME, &ts)) {
-    return Nothing();
-  }
-  return Some(TimespecToMilliseconds(ts));
-#  endif
-}
-
-#else  // catch all
-
-Maybe<uint64_t> NowExcludingSuspendMs() { return Nothing(); }
-Maybe<uint64_t> NowIncludingSuspendMs() { return Nothing(); }
-
-#endif
-
 };  // anonymous namespace
 
 namespace mozilla {

mozglue/misc/moz.build

@@ -14,6 +14,7 @@ EXPORTS.mozilla += [
     "IntegerPrintfMacros.h",
     "LoggingCore.h",
     "MmapFaultHandler.h",
+    "Now.h",
     "PlatformConditionVariable.h",
     "PlatformMutex.h",
     "PlatformRWLock.h",
@@ -47,6 +48,7 @@ SOURCES += [
     "Debug.cpp",
     "LoggingCore.cpp",
     "MmapFaultHandler.cpp",
+    "Now.cpp",
     "Printf.cpp",
     "SIMD.cpp",
     "StackWalk.cpp",