espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-16 06:00:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

[mle] add ParentCandidate class (#8069)

Browse Source 
This commit adds `ParentCandidate` in `Mle` class (as a sub-class of
`Parent`) and moves all member properties related to parent candidate
to this new class.
This commit is contained in:
Abtin Keshavarzian
2022-08-24 10:46:14 -07:00
committed by GitHub
parent 9699d319af
commit e51941177f
3 changed files with 74 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/thread/mle.cpp
+43 -30
View File
@@ -84,20 +84,12 @@ Mle::Mle(Instance &aInstance)
, mDelayedResponseTimer(aInstance, Mle::HandleDelayedResponseTimer)
, mMessageTransmissionTimer(aInstance, Mle::HandleMessageTransmissionTimer)
, mAttachMode(kAnyPartition)
, mParentPriority(0)
, mParentLinkQuality3(0)
, mParentLinkQuality2(0)
, mParentLinkQuality1(0)
, mParentSedBufferSize(0)
, mParentSedDatagramCount(0)
, mChildUpdateAttempts(0)
, mChildUpdateRequestState(kChildUpdateRequestNone)
, mDataRequestAttempts(0)
, mDataRequestState(kDataRequestNone)
, mAddressRegistrationMode(kAppendAllAddresses)
, mHasRestored(false)
, mParentLinkMargin(0)
, mParentIsSingleton(false)
, mReceivedResponseFromParent(false)
, mSocket(aInstance)
, mTimeout(kMleEndDeviceTimeout)
@@ -122,7 +114,6 @@ Mle::Mle(Instance &aInstance)
mParentCandidate.Init(aInstance);
mLeaderData.Clear();
mParentLeaderData.Clear();
mParent.Clear();
mParentCandidate.Clear();
ResetCounters();
@@ -1763,7 +1754,7 @@ Error Mle::SendChildIdRequest(void)
}
VerifyOrExit((message = NewMleMessage(kCommandChildIdRequest)) != nullptr, error = kErrorNoBufs);
SuccessOrExit(error = message->AppendResponseTlv(mParentCandidateChallenge));
SuccessOrExit(error = message->AppendResponseTlv(mParentCandidate.mChallenge));
SuccessOrExit(error = message->AppendLinkFrameCounterTlv());
SuccessOrExit(error = message->AppendMleFrameCounterTlv());
SuccessOrExit(error = message->AppendModeTlv(mDeviceMode));
@@ -2998,11 +2989,11 @@ bool Mle::IsBetterParent(uint16_t aRloc16,
rval = ThreeWayCompare(IsActiveRouter(aRloc16), IsActiveRouter(mParentCandidate.GetRloc16()));
VerifyOrExit(rval == 0);
rval = ThreeWayCompare(aConnectivityTlv.GetParentPriority(), mParentPriority);
rval = ThreeWayCompare(aConnectivityTlv.GetParentPriority(), mParentCandidate.mPriority);
VerifyOrExit(rval == 0);
// Prefer the parent with highest quality links (Link Quality 3 field in Connectivity TLV) to neighbors
rval = ThreeWayCompare(aConnectivityTlv.GetLinkQuality3(), mParentLinkQuality3);
rval = ThreeWayCompare(aConnectivityTlv.GetLinkQuality3(), mParentCandidate.mLinkQuality3);
VerifyOrExit(rval == 0);
// Thread 1.2 Specification 4.5.2.1.2 Child Impacting Criteria
@@ -3010,17 +3001,17 @@ bool Mle::IsBetterParent(uint16_t aRloc16,
rval = ThreeWayCompare(aVersion, mParentCandidate.GetVersion());
VerifyOrExit(rval == 0);
rval = ThreeWayCompare(aConnectivityTlv.GetSedBufferSize(), mParentSedBufferSize);
rval = ThreeWayCompare(aConnectivityTlv.GetSedBufferSize(), mParentCandidate.mSedBufferSize);
VerifyOrExit(rval == 0);
rval = ThreeWayCompare(aConnectivityTlv.GetSedDatagramCount(), mParentSedDatagramCount);
rval = ThreeWayCompare(aConnectivityTlv.GetSedDatagramCount(), mParentCandidate.mSedDatagramCount);
VerifyOrExit(rval == 0);
// Extra rules
rval = ThreeWayCompare(aConnectivityTlv.GetLinkQuality2(), mParentLinkQuality2);
rval = ThreeWayCompare(aConnectivityTlv.GetLinkQuality2(), mParentCandidate.mLinkQuality2);
VerifyOrExit(rval == 0);
rval = ThreeWayCompare(aConnectivityTlv.GetLinkQuality1(), mParentLinkQuality1);
rval = ThreeWayCompare(aConnectivityTlv.GetLinkQuality1(), mParentCandidate.mLinkQuality1);
VerifyOrExit(rval == 0);
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
@@ -3038,7 +3029,7 @@ bool Mle::IsBetterParent(uint16_t aRloc16,
OT_UNUSED_VARIABLE(aCslAccuracy);
#endif
rval = ThreeWayCompare(aLinkMargin, mParentLinkMargin);
rval = ThreeWayCompare(aLinkMargin, mParentCandidate.mLinkMargin);
exit:
return (rval > 0);
@@ -3184,8 +3175,8 @@ void Mle::HandleParentResponse(RxInfo &aRxInfo)
#if OPENTHREAD_FTD
if (IsFullThreadDevice())
{
compare = MleRouter::ComparePartitions(connectivity.GetActiveRouters() <= 1, leaderData, mParentIsSingleton,
mParentLeaderData);
compare = MleRouter::ComparePartitions(connectivity.GetActiveRouters() <= 1, leaderData,
mParentCandidate.mIsSingleton, mParentCandidate.mLeaderData);
}
// only consider partitions that are the same or better
@@ -3224,7 +3215,7 @@ void Mle::HandleParentResponse(RxInfo &aRxInfo)
#endif // OPENTHREAD_CONFIG_TIME_SYNC_ENABLE
// Challenge
SuccessOrExit(error = aRxInfo.mMessage.ReadChallengeTlv(mParentCandidateChallenge));
SuccessOrExit(error = aRxInfo.mMessage.ReadChallengeTlv(mParentCandidate.mChallenge));
mParentCandidate.SetExtAddress(extAddress);
mParentCandidate.SetRloc16(sourceAddress);
@@ -3245,15 +3236,15 @@ void Mle::HandleParentResponse(RxInfo &aRxInfo)
mParentCandidate.SetCslAccuracy(cslAccuracy);
#endif
mParentPriority = connectivity.GetParentPriority();
mParentLinkQuality3 = connectivity.GetLinkQuality3();
mParentLinkQuality2 = connectivity.GetLinkQuality2();
mParentLinkQuality1 = connectivity.GetLinkQuality1();
mParentSedBufferSize = connectivity.GetSedBufferSize();
mParentSedDatagramCount = connectivity.GetSedDatagramCount();
mParentLeaderData = leaderData;
mParentIsSingleton = connectivity.GetActiveRouters() <= 1;
mParentLinkMargin = linkMargin;
mParentCandidate.mPriority = connectivity.GetParentPriority();
mParentCandidate.mLinkQuality3 = connectivity.GetLinkQuality3();
mParentCandidate.mLinkQuality2 = connectivity.GetLinkQuality2();
mParentCandidate.mLinkQuality1 = connectivity.GetLinkQuality1();
mParentCandidate.mSedBufferSize = connectivity.GetSedBufferSize();
mParentCandidate.mSedDatagramCount = connectivity.GetSedDatagramCount();
mParentCandidate.mLeaderData = leaderData;
mParentCandidate.mIsSingleton = connectivity.GetActiveRouters() <= 1;
mParentCandidate.mLinkMargin = linkMargin;
exit:
LogProcessError(kTypeParentResponse, error);
@@ -3364,7 +3355,7 @@ void Mle::HandleChildIdResponse(RxInfo &aRxInfo)
}
#endif
mParent = mParentCandidate;
mParentCandidate.CopyTo(mParent);
mParentCandidate.Clear();
#if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE
@@ -5063,5 +5054,27 @@ exit:
}
#endif
//---------------------------------------------------------------------------------------------------------------------
// ParentCandidate
void Mle::ParentCandidate::Clear(void)
{
Instance &instance = GetInstance();
memset(reinterpret_cast<void *>(this), 0, sizeof(ParentCandidate));
Init(instance);
}
void Mle::ParentCandidate::CopyTo(Parent &aParent) const
{
// We use an intermediate pointer to copy `ParentCandidate`
// to silence code checker's warning about object slicing
// (assigning a sub-class to base class instance).
const Parent *candidateAsParent = this;
aParent = *candidateAsParent;
}
} // namespace Mle
} // namespace ot
src/core/thread/mle.hpp
+29 -15
View File
@@ -1419,6 +1419,12 @@ protected:
*/
void SetAttachState(AttachState aState);
/**
* This method clears the parent candidate.
*
*/
void ClearParentCandidate(void) { mParentCandidate.Clear(); }
/**
* This method checks if the destination is reachable.
*
@@ -1676,7 +1682,6 @@ protected:
bool mRetrieveNewNetworkData; ///< Indicating new Network Data is needed if set.
DeviceRole mRole; ///< Current Thread role.
Parent mParent; ///< Parent information.
Parent mParentCandidate; ///< Parent candidate information.
NeighborTable mNeighborTable; ///< The neighbor table.
DeviceMode mDeviceMode; ///< Device mode setting.
AttachState mAttachState; ///< The attach state.
@@ -1794,6 +1799,25 @@ private:
uint8_t mKeyIndex;
} OT_TOOL_PACKED_END;
class ParentCandidate : public Parent
{
public:
void Init(Instance &aInstance) { Parent::Init(aInstance); }
void Clear(void);
void CopyTo(Parent &aParent) const;
Challenge mChallenge;
int8_t mPriority;
uint8_t mLinkQuality3;
uint8_t mLinkQuality2;
uint8_t mLinkQuality1;
uint16_t mSedBufferSize;
uint8_t mSedDatagramCount;
uint8_t mLinkMargin;
LeaderData mLeaderData;
bool mIsSingleton;
};
#if OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE
class ServiceAloc : public Ip6::Netif::UnicastAddress
{
@@ -1944,13 +1968,8 @@ private:
Challenge mParentRequestChallenge;
AttachMode mAttachMode;
int8_t mParentPriority;
uint8_t mParentLinkQuality3;
uint8_t mParentLinkQuality2;
uint8_t mParentLinkQuality1;
uint16_t mParentSedBufferSize;
uint8_t mParentSedDatagramCount;
AttachMode mAttachMode;
ParentCandidate mParentCandidate;
uint8_t mChildUpdateAttempts;
ChildUpdateRequestState mChildUpdateRequestState;
@@ -1959,13 +1978,8 @@ private:
AddressRegistrationMode mAddressRegistrationMode;
bool mHasRestored;
uint8_t mParentLinkMargin;
bool mParentIsSingleton;
bool mReceivedResponseFromParent;
LeaderData mParentLeaderData;
Challenge mParentCandidateChallenge;
bool mHasRestored;
bool mReceivedResponseFromParent;
Ip6::Udp::Socket mSocket;
uint32_t mTimeout;
src/core/thread/mle_router.cpp
+2 -2
View File
@@ -3523,9 +3523,9 @@ void MleRouter::RemoveNeighbor(Neighbor &aNeighbor)
IgnoreError(BecomeDetached());
}
}
else if (&aNeighbor == &mParentCandidate)
else if (&aNeighbor == &GetParentCandidate())
{
mParentCandidate.Clear();
ClearParentCandidate();
}
else if (!IsActiveRouter(aNeighbor.GetRloc16()))
{