espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-15 07:07:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[time] update DistantFuture/Past() to exclude value half range apart (#9263)

Browse Source 
This commit changes the `Time::GetDistantFuture/Past()` methods to
exclude the ambiguous time value which is half range `(1 << 31)`
apart. The returned value is now `(1 << 31) - 1` apart. This ensures
that `Min(now.GetDistantFuture(), now)` is well-defined and the same
as `Min(now, now.GetDistantFuture())`. This commit also updates
`test_timer` to validate this.
This commit is contained in:
Abtin Keshavarzian
2023-07-10 09:27:33 -07:00
committed by GitHub
parent ad6545a5de
commit 5fc78a94cb
2 changed files with 22 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/common/time.hpp
+11 -9
View File
@@ -217,26 +217,28 @@ public:
/**
* Returns a new `Time` instance which is in distant future relative to current `Time` object.
*
* The returned distance future `Time` is guaranteed to be equal or after (as defined by comparison operator `<=`)
* any other `Time` which is after this `Time` object, i.e., for any `t` for which we have `*this <= t`, it is
* ensured that `t <= this->GetGetDistantFuture()`.
* The distant future is the largest time that is ahead of `Time`. For any time `t`, if `(*this <= t)`, then
* `t <= this->GetGetDistantFuture()`, except for the ambiguous `t` value which is half range `(1 << 31)` apart.
*
* When comparing `GetDistantFuture()` with a time `t` the caller must ensure that `t` is already ahead of `*this`.
*
* @returns A new `Time` in distance future relative to current `Time` object.
*
*/
Time GetDistantFuture(void) const { return Time(mValue + kDistantFuture); }
Time GetDistantFuture(void) const { return Time(mValue + kDistantInterval); }
/**
* Returns a new `Time` instance which is in distant past relative to current `Time` object.
*
* The returned distance past `Time` is guaranteed to be equal or before (as defined by comparison operator `>=`)
* any other `Time` which is before this `Time` object, i.e., for any `t` for which we have `*this >= t`, it is
* ensured that `t >= this->GetDistantPast()`.
* The distant past is the smallest time that is before `Time`. For any time `t`, if `(t <= *this )`, then
* `this->GetGetDistantPast() <= t`, except for the ambiguous `t` value which is half range `(1 << 31)` apart.
*
* When comparing `GetDistantPast()` with a time `t` the caller must ensure that the `t` is already before `*this`.
*
* @returns A new `Time` in distance past relative to current `Time` object.
*
*/
Time GetDistantPast(void) const { return Time(mValue - kDistantFuture); }
Time GetDistantPast(void) const { return Time(mValue - kDistantInterval); }
/**
* Converts a given number of seconds to milliseconds.
@@ -259,7 +261,7 @@ public:
static uint32_t constexpr MsecToSec(uint32_t aMilliseconds) { return aMilliseconds / 1000u; }
private:
static constexpr uint32_t kDistantFuture = (1UL << 31);
static constexpr uint32_t kDistantInterval = (1UL << 31) - 1;
uint32_t mValue;
};
tests/unit/test_timer.cpp
+11 -4
View File
@@ -32,6 +32,7 @@
#include "common/code_utils.hpp"
#include "common/debug.hpp"
#include "common/instance.hpp"
#include "common/num_utils.hpp"
#include "common/timer.hpp"
enum
@@ -650,14 +651,20 @@ int TestTimerTime(void)
VerifyOrQuit(t1 - t2 == duration, "Time difference failed");
t2 = t1.GetDistantFuture();
VerifyOrQuit((t1 < t2), "GetDistanceFuture() failed");
VerifyOrQuit((t1 < t2) && !(t1 > t2), "GetDistanceFuture() failed");
t2 += 1;
VerifyOrQuit(!(t1 < t2), "GetDistanceFuture() failed");
VerifyOrQuit(!(t1 < t2) || (t1 > t2), "GetDistanceFuture() failed");
t2 = t1.GetDistantPast();
VerifyOrQuit((t1 > t2), "GetDistantPast() failed");
VerifyOrQuit((t1 > t2) && !(t1 < t2), "GetDistantPast() failed");
t2 -= 1;
VerifyOrQuit(!(t1 > t2), "GetDistantPast() failed");
VerifyOrQuit(!(t1 > t2) || (t1 < t2), "GetDistantPast() failed");
VerifyOrQuit(Min(t1, t1.GetDistantFuture()) == t1);
VerifyOrQuit(Min(t1.GetDistantFuture(), t1) == t1);
VerifyOrQuit(Max(t1, t1.GetDistantPast()) == t1);
VerifyOrQuit(Max(t1.GetDistantPast(), t1) == t1);
printf("--> PASSED\n");
}