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

[common] add SerialNumber::Is{Greater/Less}>() (#7334)

Browse Source 
This commit adds `SerialNumber` class which provides `static` methods
`IsGeater<UintType>()` and `IsLess<UintType()` to compare two serial
numbers, taking into account the wrapping of serial number values
(similar to RFC-1982). This is then used in `MleRouter` and other
modules. This helps us avoid casting of `uint` to `int` for the
comparison (such a casting is undefined behavior in C++11 though
toolchains often implement it as expected). This commit also adds a
unit test `test_serial_number` to validate the new methods.
This commit is contained in:
Abtin Keshavarzian
2022-01-20 16:54:46 -08:00
committed by GitHub
parent 72676c542e
commit e04c8e3307
12 changed files with 230 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/BUILD.gn
+1
View File
@@ -422,6 +422,7 @@ openthread_core_files = [
"common/random_manager.cpp",
"common/random_manager.hpp",
"common/retain_ptr.hpp",
"common/serial_number.hpp",
"common/settings.cpp",
"common/settings.hpp",
"common/settings_driver.hpp",
src/core/Makefile.am
+1
View File
@@ -455,6 +455,7 @@ HEADERS_COMMON = \
common/random.hpp \
common/random_manager.hpp \
common/retain_ptr.hpp \
common/serial_number.hpp \
common/settings.hpp \
common/settings_driver.hpp \
common/string.hpp \
src/core/common/serial_number.hpp
+100
View File
@@ -0,0 +1,100 @@
/*
* Copyright (c) 2022, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file includes definitions for serial number comparison similar to RFC-1982.
*/
#ifndef SERIAL_NUMBER_HPP_
#define SERIAL_NUMBER_HPP_
#include "openthread-core-config.h"
#include <stdint.h>
#include "common/numeric_limits.hpp"
#include "common/type_traits.hpp"
namespace ot {
class SerialNumber
{
public:
/**
* This static method indicates whether or not a first serial number is strictly less than a second serial number.
*
* The comparison takes into account the wrapping of serial number values (similar to RFC-1982). It is semantically
* equivalent to `aFirst < aSecond`.
*
* @tparam UintType The unsigned integer type.
*
* @param[in] aFirst The first serial number.
* @param[in] aSecond The second serial number.
*
* @retval TRUE If @p aFirst is less than @p aSecond.
* @retval FALSE If @p aFirst is not less than @p aSecond.
*
*/
template <typename UintType> static bool IsLess(UintType aFirst, UintType aSecond)
{
static_assert(TypeTraits::IsSame<UintType, uint8_t>::kValue || TypeTraits::IsSame<UintType, uint16_t>::kValue ||
TypeTraits::IsSame<UintType, uint32_t>::kValue ||
TypeTraits::IsSame<UintType, uint64_t>::kValue,
"UintType MUST be an 8, 16, 32, or 64 bit `uint` type");
static constexpr UintType kNegativeMask = (NumericLimits<UintType>::kMax >> 1) + 1;
return ((aFirst - aSecond) & kNegativeMask) != 0;
}
/**
* This static method indicates whether or not a first serial number is strictly greater than a second serial
* number.
*
* The comparison takes into account the wrapping of serial number values (similar to RFC-1982). It is semantically
* equivalent to `aFirst > aSecond`.
*
* @tparam UintType The unsigned integer type.
*
* @param[in] aFirst The first serial number.
* @param[in] aSecond The second serial number.
*
* @retval TRUE If @p aFirst is greater than @p aSecond.
* @retval FALSE If @p aFirst is not greater than @p aSecond.
*
*/
template <typename UintType> static bool IsGreater(UintType aFirst, UintType aSecond)
{
return IsLess(aSecond, aFirst);
}
};
} // namespace ot
#endif // SERIAL_NUMBER_HPP_
src/core/common/time.hpp
+2 -1
View File
@@ -40,6 +40,7 @@
#include <stdint.h>
#include "common/equatable.hpp"
#include "common/serial_number.hpp"
namespace ot {
@@ -178,7 +179,7 @@ public:
* @retval FALSE This `Time` instance is not strictly before @p aOther.
*
*/
bool operator<(const Time &aOther) const { return ((mValue - aOther.mValue) & (1UL << 31)) != 0; }
bool operator<(const Time &aOther) const { return SerialNumber::IsLess(mValue, aOther.mValue); }
/**
* This method indicates whether this `Time` instance is after or equal to another one.
src/core/net/ip6_mpl.cpp
+3 -4
View File
@@ -38,6 +38,7 @@
#include "common/locator_getters.hpp"
#include "common/message.hpp"
#include "common/random.hpp"
#include "common/serial_number.hpp"
#include "net/ip6.hpp"
namespace ot {
@@ -187,14 +188,12 @@ Error Mpl::UpdateSeedSet(uint16_t aSeedId, uint8_t aSequence)
{
// have existing entries for aSeedId
int8_t diff = static_cast<int8_t>(aSequence - mSeedSet[i].mSequence);
if (diff == 0)
if (aSequence == mSeedSet[i].mSequence)
{
// already received, drop message
ExitNow(error = kErrorDrop);
}
else if (insert == nullptr && diff < 0)
else if (insert == nullptr && SerialNumber::IsLess(aSequence, mSeedSet[i].mSequence))
{
// insert in order of sequence
insert = &mSeedSet[i];
src/core/thread/mle.cpp
+11 -11
View File
@@ -44,6 +44,7 @@
#include "common/locator_getters.hpp"
#include "common/logging.hpp"
#include "common/random.hpp"
#include "common/serial_number.hpp"
#include "common/settings.hpp"
#include "crypto/aes_ccm.hpp"
#include "meshcop/meshcop.hpp"
@@ -3140,10 +3141,8 @@ exit:
bool Mle::IsNetworkDataNewer(const LeaderData &aLeaderData)
{
int8_t diff = static_cast<int8_t>(aLeaderData.GetDataVersion(GetNetworkDataType()) -
Get<NetworkData::Leader>().GetVersion(GetNetworkDataType()));
return (diff > 0);
return SerialNumber::IsGreater(aLeaderData.GetDataVersion(GetNetworkDataType()),
Get<NetworkData::Leader>().GetVersion(GetNetworkDataType()));
}
Error Mle::HandleLeaderData(const Message &aMessage, const Ip6::MessageInfo &aMessageInfo)
@@ -3495,27 +3494,28 @@ void Mle::HandleParentResponse(const Message &aMessage, const Ip6::MessageInfo &
#if OPENTHREAD_FTD
if (IsFullThreadDevice() && !IsDetached())
{
int8_t diff = static_cast<int8_t>(connectivity.GetIdSequence() - Get<RouterTable>().GetRouterIdSequence());
bool isPartitionIdSame = (leaderData.GetPartitionId() == mLeaderData.GetPartitionId());
bool isIdSequenceSame = (connectivity.GetIdSequence() == Get<RouterTable>().GetRouterIdSequence());
bool isIdSequenceGreater =
SerialNumber::IsGreater(connectivity.GetIdSequence(), Get<RouterTable>().GetRouterIdSequence());
switch (mParentRequestMode)
{
case kAttachAny:
VerifyOrExit(leaderData.GetPartitionId() != mLeaderData.GetPartitionId() || diff > 0);
VerifyOrExit(!isPartitionIdSame || isIdSequenceGreater);
break;
case kAttachSame1:
case kAttachSame2:
VerifyOrExit(leaderData.GetPartitionId() == mLeaderData.GetPartitionId());
VerifyOrExit(diff > 0);
VerifyOrExit(isPartitionIdSame && isIdSequenceGreater);
break;
case kAttachSameDowngrade:
VerifyOrExit(leaderData.GetPartitionId() == mLeaderData.GetPartitionId());
VerifyOrExit(diff >= 0);
VerifyOrExit(isPartitionIdSame && (isIdSequenceSame || isIdSequenceGreater));
break;
case kAttachBetter:
VerifyOrExit(leaderData.GetPartitionId() != mLeaderData.GetPartitionId());
VerifyOrExit(!isPartitionIdSame);
VerifyOrExit(MleRouter::ComparePartitions(connectivity.GetActiveRouters() <= 1, leaderData,
Get<MleRouter>().IsSingleton(), mLeaderData) > 0);
src/core/thread/mle_router.cpp
+5 -4
View File
@@ -42,6 +42,7 @@
#include "common/locator_getters.hpp"
#include "common/logging.hpp"
#include "common/random.hpp"
#include "common/serial_number.hpp"
#include "common/settings.hpp"
#include "mac/mac_types.hpp"
#include "meshcop/meshcop.hpp"
@@ -965,8 +966,8 @@ Error MleRouter::HandleLinkAccept(const Message & aMessage,
VerifyOrExit(leaderData.GetPartitionId() == mLeaderData.GetPartitionId());
if (mRetrieveNewNetworkData ||
(static_cast<int8_t>(leaderData.GetDataVersion(NetworkData::kFullSet) -
Get<NetworkData::Leader>().GetVersion(NetworkData::kFullSet)) > 0))
SerialNumber::IsGreater(leaderData.GetDataVersion(NetworkData::kFullSet),
Get<NetworkData::Leader>().GetVersion(NetworkData::kFullSet)))
{
IgnoreError(SendDataRequest(aMessageInfo.GetPeerAddr(), dataRequestTlvs, sizeof(dataRequestTlvs), 0));
}
@@ -1218,7 +1219,7 @@ Error MleRouter::HandleAdvertisement(const Message &aMessage, const Ip6::Message
if (route.IsValid() && IsFullThreadDevice() && (mPreviousPartitionIdTimeout > 0) &&
(partitionId == mPreviousPartitionId))
{
VerifyOrExit((static_cast<int8_t>(route.GetRouterIdSequence() - mPreviousPartitionRouterIdSequence) > 0),
VerifyOrExit(SerialNumber::IsGreater(route.GetRouterIdSequence(), mPreviousPartitionRouterIdSequence),
error = kErrorDrop);
}
@@ -1262,7 +1263,7 @@ Error MleRouter::HandleAdvertisement(const Message &aMessage, const Ip6::Message
if (IsFullThreadDevice() && (aNeighbor && aNeighbor->IsStateValid()) &&
((mRouterTable.GetActiveRouterCount() == 0) ||
(static_cast<int8_t>(route.GetRouterIdSequence() - mRouterTable.GetRouterIdSequence()) > 0)))
SerialNumber::IsGreater(route.GetRouterIdSequence(), mRouterTable.GetRouterIdSequence())))
{
bool processRouteTlv = false;
src/core/thread/network_data_service.hpp
+2 -1
View File
@@ -42,6 +42,7 @@
#include "common/encoding.hpp"
#include "common/locator.hpp"
#include "common/non_copyable.hpp"
#include "common/serial_number.hpp"
#include "net/socket.hpp"
#include "thread/network_data_tlvs.hpp"
@@ -189,7 +190,7 @@ public:
*/
bool IsSequenceNumberAheadOf(const Info &aOther) const
{
return (((aOther.mSequenceNumber - mSequenceNumber) & (1U << 7)) != 0);
return SerialNumber::IsGreater(mSequenceNumber, aOther.mSequenceNumber);
}
Ip6::Address mAnycastAddress; ///< The anycast address associated with the DNS/SRP servers.
src/core/thread/topology.hpp
+2 -1
View File
@@ -45,6 +45,7 @@
#include "common/locator.hpp"
#include "common/message.hpp"
#include "common/random.hpp"
#include "common/serial_number.hpp"
#include "common/timer.hpp"
#include "mac/mac_types.hpp"
#include "net/ip6.hpp"
@@ -546,7 +547,7 @@ public:
* before @p aTag.
*
*/
bool IsLastRxFragmentTagAfter(uint16_t aTag) const { return ((aTag - mLastRxFragmentTag) & (1U << 15)) != 0; }
bool IsLastRxFragmentTagAfter(uint16_t aTag) const { return SerialNumber::IsGreater(mLastRxFragmentTag, aTag); }
#endif // OPENTHREAD_CONFIG_MULTI_RADIO
tests/unit/CMakeLists.txt
+21
View File
@@ -769,6 +769,27 @@ target_link_libraries(ot-test-meshcop
add_test(NAME ot-test-meshcop COMMAND ot-test-meshcop)
add_executable(ot-test-serial-number
test_serial_number.cpp
)
target_include_directories(ot-test-serial-number
PRIVATE
${COMMON_INCLUDES}
)
target_compile_options(ot-test-serial-number
PRIVATE
${COMMON_COMPILE_OPTIONS}
)
target_link_libraries(ot-test-serial-number
PRIVATE
${COMMON_LIBS}
)
add_test(NAME ot-test-serial-number COMMAND ot-test-serial-number)
add_executable(ot-test-string
test_string.cpp
)
tests/unit/Makefile.am
+4
View File
@@ -140,6 +140,7 @@ check_PROGRAMS += \
ot-test-pool \
ot-test-priority-queue \
ot-test-pskc \
ot-test-serial-number \
ot-test-smart-ptrs \
ot-test-string \
ot-test-timer \
@@ -288,6 +289,9 @@ ot_test_smart_ptrs_SOURCES = $(COMMON_SOURCES) test_smart_ptrs.cpp
ot_test_meshcop_LDADD = $(COMMON_LDADD)
ot_test_meshcop_SOURCES = $(COMMON_SOURCES) test_meshcop.cpp
ot_test_serial_number_LDADD = $(COMMON_LDADD)
ot_test_serial_number_SOURCES = $(COMMON_SOURCES) test_serial_number.cpp
ot_test_string_LDADD = $(COMMON_LDADD)
ot_test_string_SOURCES = $(COMMON_SOURCES) test_string.cpp
tests/unit/test_serial_number.cpp
+78
View File
@@ -0,0 +1,78 @@
/*
* Copyright (c) 2022, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include "test_platform.h"
#include <openthread/config.h>
#include "test_util.h"
#include "common/code_utils.hpp"
#include "common/numeric_limits.hpp"
#include "common/serial_number.hpp"
namespace ot {
template <typename UintType> void TestSerialNumber(const char *aName)
{
static constexpr UintType kMax = NumericLimits<UintType>::kMax;
static constexpr UintType kMid = kMax / 2;
static const UintType kNumbers[] = {0, 1, 20, kMid - 1, kMid, kMid + 1, kMax - 20, kMax - 1, kMax};
for (UintType number : kNumbers)
{
VerifyOrQuit(!SerialNumber::IsGreater<UintType>(number, number));
VerifyOrQuit(!SerialNumber::IsLess<UintType>(number, number));
VerifyOrQuit(SerialNumber::IsGreater<UintType>(number + 1, number));
VerifyOrQuit(SerialNumber::IsGreater<UintType>(number + kMid - 1, number));
VerifyOrQuit(SerialNumber::IsGreater<UintType>(number + kMid, number));
VerifyOrQuit(!SerialNumber::IsGreater<UintType>(number + kMid + 2, number));
VerifyOrQuit(!SerialNumber::IsGreater<UintType>(number + kMax - 1, number));
VerifyOrQuit(SerialNumber::IsLess<UintType>(number - 1, number));
VerifyOrQuit(SerialNumber::IsLess<UintType>(number - kMid + 1, number));
VerifyOrQuit(SerialNumber::IsLess<UintType>(number - kMid, number));
VerifyOrQuit(!SerialNumber::IsLess<UintType>(number - kMid - 2, number));
VerifyOrQuit(!SerialNumber::IsLess<UintType>(number - kMax + 1, number));
}
printf("TestSerialNumber<%s>() passed\n", aName);
}
} // namespace ot
int main(void)
{
ot::TestSerialNumber<uint8_t>("uint8_t");
ot::TestSerialNumber<uint16_t>("uint16_t");
ot::TestSerialNumber<uint32_t>("uint32_t");
ot::TestSerialNumber<uint64_t>("uint64_t");
printf("\nAll tests passed.\n");
return 0;
}