From 064c91a32d772e2cc0bbd8c6134ebec33863080b Mon Sep 17 00:00:00 2001
From: Abtin Keshavarzian <abtink@google.com>
Date: Mon, 10 Jan 2022 13:48:21 -0800
Subject: [PATCH] [time] add constants for one sec, minute, hour, or day
 interval in msec (#7297)

---
 src/core/common/time.hpp           |  5 +++++
 src/core/common/time_ticker.hpp    |  4 ++--
 src/core/common/uptime.cpp         | 10 +++++-----
 src/core/common/uptime.hpp         |  6 +-----
 src/core/net/ip6.hpp               |  2 --
 src/core/utils/history_tracker.cpp | 13 +++++++------
 src/core/utils/history_tracker.hpp |  7 +------
 src/core/utils/jam_detector.cpp    |  4 ++--
 src/core/utils/jam_detector.hpp    |  7 +++----
 9 files changed, 26 insertions(+), 32 deletions(-)

diff --git a/src/core/common/time.hpp b/src/core/common/time.hpp
index 9e8358764..b214cb36b 100644
--- a/src/core/common/time.hpp
+++ b/src/core/common/time.hpp
@@ -60,6 +60,11 @@ namespace ot {
 class Time : public Unequatable<Time>
 {
 public:
+    static constexpr uint32_t kOneSecondInMsec = 1000u;                 ///< One second interval in msec.
+    static constexpr uint32_t kOneMinuteInMsec = kOneSecondInMsec * 60; ///< One minute interval in msec.
+    static constexpr uint32_t kOneHourInMsec   = kOneMinuteInMsec * 60; ///< One hour interval in msec.
+    static constexpr uint32_t kOneDayInMsec    = kOneHourInMsec * 24;   ///< One day interval in msec.
+
     /**
      * This constant defines a maximum time duration ensured to be longer than any other duration.
      *
diff --git a/src/core/common/time_ticker.hpp b/src/core/common/time_ticker.hpp
index 8f5d27201..78860c4d6 100644
--- a/src/core/common/time_ticker.hpp
+++ b/src/core/common/time_ticker.hpp
@@ -109,8 +109,8 @@ public:
     bool IsReceiverRegistered(Receiver aReceiver) const { return (mReceivers & Mask(aReceiver)) != 0; }
 
 private:
-    static constexpr uint32_t kTickInterval  = 1000; // in msec.
-    static constexpr uint32_t kRestartJitter = 4;    // in msec, jitter added when restarting the timer [-4,+4] ms.
+    static constexpr uint32_t kTickInterval  = Time::kOneSecondInMsec;
+    static constexpr uint32_t kRestartJitter = 4; // in msec, jitter added when restarting the timer [-4,+4] ms.
 
     constexpr static uint32_t Mask(Receiver aReceiver) { return static_cast<uint32_t>(1U) << aReceiver; }
 
diff --git a/src/core/common/uptime.cpp b/src/core/common/uptime.cpp
index 9bac0f3b5..1c3c74ca2 100644
--- a/src/core/common/uptime.cpp
+++ b/src/core/common/uptime.cpp
@@ -117,7 +117,7 @@ static uint32_t DivideAndGetRemainder(uint32_t &aDividend, uint32_t aDivisor)
 
 void Uptime::UptimeToString(uint64_t aUptime, StringWriter &aWriter)
 {
-    uint64_t days = aUptime / kOneDayInMsec;
+    uint64_t days = aUptime / Time::kOneDayInMsec;
     uint32_t remainder;
     uint32_t hours;
     uint32_t minutes;
@@ -126,13 +126,13 @@ void Uptime::UptimeToString(uint64_t aUptime, StringWriter &aWriter)
     if (days > 0)
     {
         aWriter.Append("%lud.", days);
-        aUptime -= days * kOneDayInMsec;
+        aUptime -= days * Time::kOneDayInMsec;
     }
 
     remainder = static_cast<uint32_t>(aUptime);
-    hours     = DivideAndGetRemainder(remainder, kOneHourInMsec);
-    minutes   = DivideAndGetRemainder(remainder, kOneMinuteInMsec);
-    seconds   = DivideAndGetRemainder(remainder, kOneSecondInMsec);
+    hours     = DivideAndGetRemainder(remainder, Time::kOneHourInMsec);
+    minutes   = DivideAndGetRemainder(remainder, Time::kOneMinuteInMsec);
+    seconds   = DivideAndGetRemainder(remainder, Time::kOneSecondInMsec);
 
     aWriter.Append("%02u:%02u:%02u.%03u", hours, minutes, seconds, remainder);
 }
diff --git a/src/core/common/uptime.hpp b/src/core/common/uptime.hpp
index 35a5c91a4..f1215bccd 100644
--- a/src/core/common/uptime.hpp
+++ b/src/core/common/uptime.hpp
@@ -99,11 +99,7 @@ public:
     static void UptimeToString(uint64_t aUptime, StringWriter &aWriter);
 
 private:
-    static constexpr uint32_t kTimerInterval   = (1 << 30);
-    static constexpr uint32_t kOneSecondInMsec = 1000;
-    static constexpr uint32_t kOneMinuteInMsec = 60 * kOneSecondInMsec;
-    static constexpr uint32_t kOneHourInMsec   = 60 * kOneMinuteInMsec;
-    static constexpr uint32_t kOneDayInMsec    = 24 * kOneHourInMsec;
+    static constexpr uint32_t kTimerInterval = (1 << 30);
 
     static_assert(static_cast<uint32_t>(4 * kTimerInterval) == 0, "kTimerInterval is not correct");
 
diff --git a/src/core/net/ip6.hpp b/src/core/net/ip6.hpp
index f6903f54c..2a0ce39fe 100644
--- a/src/core/net/ip6.hpp
+++ b/src/core/net/ip6.hpp
@@ -314,8 +314,6 @@ private:
 
     static constexpr uint16_t kMinimalMtu = 1280;
 
-    static constexpr uint32_t kStateUpdatePeriod = 1000;
-
     static void HandleSendQueue(Tasklet &aTasklet);
     void        HandleSendQueue(void);
 
diff --git a/src/core/utils/history_tracker.cpp b/src/core/utils/history_tracker.cpp
index 58266f52a..e43d5bf87 100644
--- a/src/core/utils/history_tracker.cpp
+++ b/src/core/utils/history_tracker.cpp
@@ -323,21 +323,22 @@ void HistoryTracker::EntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_
 
     if (aEntryAge >= kMaxAge)
     {
-        writer.Append("more than %u days", kMaxAge / kOneDayInMsec);
+        writer.Append("more than %u days", kMaxAge / Time::kOneDayInMsec);
     }
     else
     {
-        uint32_t days = aEntryAge / kOneDayInMsec;
+        uint32_t days = aEntryAge / Time::kOneDayInMsec;
 
         if (days > 0)
         {
             writer.Append("%u day%s ", days, (days == 1) ? "" : "s");
-            aEntryAge -= days * kOneDayInMsec;
+            aEntryAge -= days * Time::kOneDayInMsec;
         }
 
-        writer.Append("%02u:%02u:%02u.%03u", (aEntryAge / kOneHourInMsec),
-                      (aEntryAge % kOneHourInMsec) / kOneMinuteInMsec,
-                      (aEntryAge % kOneMinuteInMsec) / kOneSecondInMsec, (aEntryAge % kOneSecondInMsec));
+        writer.Append("%02u:%02u:%02u.%03u", (aEntryAge / Time::kOneHourInMsec),
+                      (aEntryAge % Time::kOneHourInMsec) / Time::kOneMinuteInMsec,
+                      (aEntryAge % Time::kOneMinuteInMsec) / Time::kOneSecondInMsec,
+                      (aEntryAge % Time::kOneSecondInMsec));
     }
 }
 
diff --git a/src/core/utils/history_tracker.hpp b/src/core/utils/history_tracker.hpp
index a2b80c0f0..82270b6ea 100644
--- a/src/core/utils/history_tracker.hpp
+++ b/src/core/utils/history_tracker.hpp
@@ -250,16 +250,11 @@ public:
     static void EntryAgeToString(uint32_t aEntryAge, char *aBuffer, uint16_t aSize);
 
 private:
-    static constexpr uint32_t kOneSecondInMsec = 1000;
-    static constexpr uint32_t kOneMinuteInMsec = 60 * kOneSecondInMsec;
-    static constexpr uint32_t kOneHourInMsec   = 60 * kOneMinuteInMsec;
-    static constexpr uint32_t kOneDayInMsec    = 24 * kOneHourInMsec;
-
     // `Timestamp` uses `uint32_t` value. `2^32` msec is 49 days, 17
     // hours, 2 minutes and 47 seconds and 296 msec. We use 49 days
     // as `kMaxAge` and check for aged entries every 16 hours.
 
-    static constexpr uint32_t kAgeCheckPeriod = 16 * kOneHourInMsec;
+    static constexpr uint32_t kAgeCheckPeriod = 16 * Time::kOneHourInMsec;
 
     static constexpr uint16_t kNetInfoListSize       = OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE;
     static constexpr uint16_t kUnicastAddrListSize   = OPENTHREAD_CONFIG_HISTORY_TRACKER_UNICAST_ADDRESS_LIST_SIZE;
diff --git a/src/core/utils/jam_detector.cpp b/src/core/utils/jam_detector.cpp
index 62843f5a4..44353ee69 100644
--- a/src/core/utils/jam_detector.cpp
+++ b/src/core/utils/jam_detector.cpp
@@ -218,7 +218,7 @@ void JamDetector::UpdateHistory(bool aDidExceedThreshold)
 
     // If we reached end of current one second interval, update the history bitmap
 
-    if (interval >= kOneSecondInterval)
+    if (interval >= Time::kOneSecondInMsec)
     {
         mHistoryBitmap <<= 1;
 
@@ -229,7 +229,7 @@ void JamDetector::UpdateHistory(bool aDidExceedThreshold)
 
         mAlwaysAboveThreshold = true;
 
-        mCurSecondStartTime += (interval / kOneSecondInterval) * kOneSecondInterval;
+        mCurSecondStartTime += (interval / Time::kOneSecondInMsec) * Time::kOneSecondInMsec;
 
         UpdateJamState();
     }
diff --git a/src/core/utils/jam_detector.hpp b/src/core/utils/jam_detector.hpp
index f1e84fc0a..02bb5f279 100644
--- a/src/core/utils/jam_detector.hpp
+++ b/src/core/utils/jam_detector.hpp
@@ -181,10 +181,9 @@ private:
     static constexpr uint8_t kMaxWindow            = 63; // Max window size
     static constexpr int8_t  kDefaultRssiThreshold = 0;
 
-    static constexpr uint16_t kMaxSampleInterval = 256;  // in ms
-    static constexpr uint16_t kMinSampleInterval = 2;    // in ms
-    static constexpr uint32_t kMaxRandomDelay    = 4;    // in ms
-    static constexpr uint32_t kOneSecondInterval = 1000; // in ms
+    static constexpr uint16_t kMaxSampleInterval = 256; // in ms
+    static constexpr uint16_t kMinSampleInterval = 2;   // in ms
+    static constexpr uint32_t kMaxRandomDelay    = 4;   // in ms
 
     void        CheckState(void);
     void        SetJamState(bool aNewState);