Skip to content

Commit

Permalink
[mlr-manager] define AddressArray which uses Array<Ip6::Address> (#…
Browse files Browse the repository at this point in the history 
…9633)
  • Loading branch information
@abtink
abtink authored Nov 24, 2023
1 parent bcdd5b0 commit 0044def
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 96 deletions.
110 changes: 31 additions & 79 deletions src/core/thread/mlr_manager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,7 @@ void MlrManager::SendMulticastListenerRegistration(void)
{
Error error;
Mle::MleRouter &mle = Get<Mle::MleRouter>();
Ip6::Address addresses[Ip6AddressesTlv::kMaxAddresses];
uint8_t addressesNum = 0;
AddressArray addresses;

VerifyOrExit(!mMlrPending, error = kErrorBusy);
VerifyOrExit(mle.IsAttached(), error = kErrorInvalidState);
Expand All @@ -227,14 +226,14 @@ void MlrManager::SendMulticastListenerRegistration(void)
for (Ip6::Netif::ExternalMulticastAddress &addr :
Get<ThreadNetif>().IterateExternalMulticastAddresses(Ip6::Address::kTypeMulticastLargerThanRealmLocal))
{
if (addressesNum >= Ip6AddressesTlv::kMaxAddresses)
if (addresses.IsFull())
{
break;
}

if (addr.GetMlrState() == kMlrStateToRegister)
{
AppendToUniqueAddressList(addresses, addressesNum, addr.GetAddress());
addresses.AddUnique(addr.GetAddress());
addr.SetMlrState(kMlrStateRegistering);
}
}
Expand All @@ -244,7 +243,7 @@ void MlrManager::SendMulticastListenerRegistration(void)
// Append Child multicast addresses
for (Child &child : Get<ChildTable>().Iterate(Child::kInStateValid))
{
if (addressesNum >= Ip6AddressesTlv::kMaxAddresses)
if (addresses.IsFull())
{
break;
}
Expand All @@ -256,24 +255,24 @@ void MlrManager::SendMulticastListenerRegistration(void)

for (const Ip6::Address &address : child.IterateIp6Addresses(Ip6::Address::kTypeMulticastLargerThanRealmLocal))
{
if (addressesNum >= Ip6AddressesTlv::kMaxAddresses)
if (addresses.IsFull())
{
break;
}

if (child.GetAddressMlrState(address) == kMlrStateToRegister)
{
AppendToUniqueAddressList(addresses, addressesNum, address);
addresses.AddUnique(address);
child.SetAddressMlrState(address, kMlrStateRegistering);
}
}
}
#endif

VerifyOrExit(addressesNum > 0, error = kErrorNotFound);
SuccessOrExit(
error = SendMulticastListenerRegistrationMessage(
addresses, addressesNum, nullptr, &MlrManager::HandleMulticastListenerRegistrationResponse, this));
VerifyOrExit(!addresses.IsEmpty(), error = kErrorNotFound);
SuccessOrExit(error = SendMulticastListenerRegistrationMessage(
addresses.GetArrayBuffer(), addresses.GetLength(), nullptr,
&MlrManager::HandleMulticastListenerRegistrationResponse, this));

mMlrPending = true;

Expand Down Expand Up @@ -351,17 +350,15 @@ void MlrManager::HandleRegisterMulticastListenersResponse(otMessage *a

uint8_t status;
Error error;
Ip6::Address failedAddresses[Ip6AddressesTlv::kMaxAddresses]{};
uint8_t failedAddressNum = 0;
Callback<otIp6RegisterMulticastListenersCallback> callbackCopy = mRegisterMulticastListenersCallback;
AddressArray failedAddresses;
Callback<otIp6RegisterMulticastListenersCallback> callbackCopy = mRegisterMulticastListenersCallback;

mRegisterMulticastListenersPending = false;
mRegisterMulticastListenersCallback.Clear();

error = ParseMulticastListenerRegistrationResponse(aResult, AsCoapMessagePtr(aMessage), status, failedAddresses,
failedAddressNum);
error = ParseMulticastListenerRegistrationResponse(aResult, AsCoapMessagePtr(aMessage), status, failedAddresses);

callbackCopy.InvokeIfSet(error, status, failedAddresses, failedAddressNum);
callbackCopy.InvokeIfSet(error, status, failedAddresses.GetArrayBuffer(), failedAddresses.GetLength());
}

#endif // (OPENTHREAD_FTD && OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE) && OPENTHREAD_CONFIG_COMMISSIONER_ENABLE
Expand Down Expand Up @@ -447,13 +444,12 @@ void MlrManager::HandleMulticastListenerRegistrationResponse(Coap::Message

uint8_t status;
Error error;
Ip6::Address failedAddresses[Ip6AddressesTlv::kMaxAddresses]{};
uint8_t failedAddressNum = 0;
AddressArray failedAddresses;

error = ParseMulticastListenerRegistrationResponse(aResult, aMessage, status, failedAddresses, failedAddressNum);
error = ParseMulticastListenerRegistrationResponse(aResult, aMessage, status, failedAddresses);

FinishMulticastListenerRegistration(error == kErrorNone && status == ThreadStatusTlv::MlrStatus::kMlrSuccess,
failedAddresses, failedAddressNum);
failedAddresses);

if (error == kErrorNone && status == ThreadStatusTlv::MlrStatus::kMlrSuccess)
{
Expand Down Expand Up @@ -481,8 +477,7 @@ void MlrManager::HandleMulticastListenerRegistrationResponse(Coap::Message
Error MlrManager::ParseMulticastListenerRegistrationResponse(Error aResult,
Coap::Message *aMessage,
uint8_t &aStatus,
Ip6::Address *aFailedAddresses,
uint8_t &aFailedAddressNum)
AddressArray &aFailedAddresses)
{
Error error;
uint16_t addressesOffset, addressesLength;
Expand All @@ -502,15 +497,14 @@ Error MlrManager::ParseMulticastListenerRegistrationResponse(Error aRes

for (uint16_t offset = 0; offset < addressesLength; offset += sizeof(Ip6::Address))
{
IgnoreError(aMessage->Read(addressesOffset + offset, aFailedAddresses[aFailedAddressNum]));
aFailedAddressNum++;
IgnoreError(aMessage->Read(addressesOffset + offset, *aFailedAddresses.PushBack()));
}
}

VerifyOrExit(aFailedAddressNum == 0 || aStatus != ThreadStatusTlv::MlrStatus::kMlrSuccess, error = kErrorParse);
VerifyOrExit(aFailedAddresses.IsEmpty() || aStatus != ThreadStatusTlv::MlrStatus::kMlrSuccess, error = kErrorParse);

exit:
LogMlrResponse(aResult, error, aStatus, aFailedAddresses, aFailedAddressNum);
LogMlrResponse(aResult, error, aStatus, aFailedAddresses);
return aResult != kErrorNone ? aResult : error;
}

Expand Down Expand Up @@ -540,9 +534,7 @@ void MlrManager::SetMulticastAddressMlrState(MlrState aFromState, MlrState aToSt
#endif
}

void MlrManager::FinishMulticastListenerRegistration(bool aSuccess,
const Ip6::Address *aFailedAddresses,
uint8_t aFailedAddressNum)
void MlrManager::FinishMulticastListenerRegistration(bool aSuccess, const AddressArray &aFailedAddresses)
{
OT_ASSERT(mMlrPending);

Expand All @@ -554,7 +546,7 @@ void MlrManager::FinishMulticastListenerRegistration(bool aSucces
{
if (addr.GetMlrState() == kMlrStateRegistering)
{
bool success = aSuccess || !AddressListContains(aFailedAddresses, aFailedAddressNum, addr.GetAddress());
bool success = aSuccess || !aFailedAddresses.IsEmptyOrContains(addr.GetAddress());

addr.SetMlrState(success ? kMlrStateRegistered : kMlrStateToRegister);
}
Expand All @@ -567,7 +559,7 @@ void MlrManager::FinishMulticastListenerRegistration(bool aSucces
{
if (child.GetAddressMlrState(address) == kMlrStateRegistering)
{
bool success = aSuccess || !AddressListContains(aFailedAddresses, aFailedAddressNum, address);
bool success = aSuccess || !aFailedAddresses.IsEmptyOrContains(address);

child.SetAddressMlrState(address, success ? kMlrStateRegistered : kMlrStateToRegister);
}
Expand Down Expand Up @@ -678,60 +670,20 @@ void MlrManager::LogMulticastAddresses(void)
#endif // OT_SHOULD_LOG_AT(OT_LOG_LEVEL_DEBG)
}

void MlrManager::AppendToUniqueAddressList(Ip6::Address (&aAddresses)[Ip6AddressesTlv::kMaxAddresses],
uint8_t &aAddressNum,
const Ip6::Address &aAddress)
{
#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE
for (uint8_t i = 0; i < aAddressNum; i++)
{
if (aAddresses[i] == aAddress)
{
ExitNow();
}
}
#endif

aAddresses[aAddressNum++] = aAddress;

#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE
exit:
#endif
return;
}

bool MlrManager::AddressListContains(const Ip6::Address *aAddressList,
uint8_t aAddressListSize,
const Ip6::Address &aAddress)
void MlrManager::AddressArray::AddUnique(const Ip6::Address &aAddress)
{
bool contains = false;

// An empty address list is treated as if it contains all failed addresses.
VerifyOrExit(aAddressListSize > 0, contains = true);

for (uint8_t i = 0; i < aAddressListSize; i++)
if (!Contains(aAddress))
{
if (aAddressList[i] == aAddress)
{
ExitNow(contains = true);
}
IgnoreError(PushBack(aAddress));
}

exit:
return contains;
}

void MlrManager::LogMlrResponse(Error aResult,
Error aError,
uint8_t aStatus,
const Ip6::Address *aFailedAddresses,
uint8_t aFailedAddressNum)
void MlrManager::LogMlrResponse(Error aResult, Error aError, uint8_t aStatus, const AddressArray &aFailedAddresses)
{
OT_UNUSED_VARIABLE(aResult);
OT_UNUSED_VARIABLE(aError);
OT_UNUSED_VARIABLE(aStatus);
OT_UNUSED_VARIABLE(aFailedAddresses);
OT_UNUSED_VARIABLE(aFailedAddressNum);

#if OT_SHOULD_LOG_AT(OT_LOG_LEVEL_WARN)
if (aResult == kErrorNone && aError == kErrorNone && aStatus == ThreadStatusTlv::MlrStatus::kMlrSuccess)
Expand All @@ -741,11 +693,11 @@ void MlrManager::LogMlrResponse(Error aResult,
else
{
LogWarn("Receive MLR.rsp: result=%s, error=%s, status=%d, failedAddressNum=%d", ErrorToString(aResult),
ErrorToString(aError), aStatus, aFailedAddressNum);
ErrorToString(aError), aStatus, aFailedAddresses.GetLength());

for (uint8_t i = 0; i < aFailedAddressNum; i++)
for (const Ip6::Address &address : aFailedAddresses)
{
LogWarn("MA failed: %s", aFailedAddresses[i].ToString().AsCString());
LogWarn("MA failed: %s", address.ToString().AsCString());
}
}
#endif
Expand Down
28 changes: 11 additions & 17 deletions src/core/thread/mlr_manager.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@

#include "backbone_router/bbr_leader.hpp"
#include "coap/coap_message.hpp"
#include "common/array.hpp"
#include "common/callback.hpp"
#include "common/locator.hpp"
#include "common/non_copyable.hpp"
Expand Down Expand Up @@ -143,6 +144,13 @@ class MlrManager : public InstanceLocator, private NonCopyable
#endif

private:
class AddressArray : public Array<Ip6::Address, Ip6AddressesTlv::kMaxAddresses>
{
public:
bool IsEmptyOrContains(const Ip6::Address &aAddress) const { return IsEmpty() || Contains(aAddress); }
void AddUnique(const Ip6::Address &aAddress);
};

void HandleNotifierEvents(Events aEvents);

void SendMulticastListenerRegistration(void);
Expand All @@ -162,8 +170,7 @@ class MlrManager : public InstanceLocator, private NonCopyable
static Error ParseMulticastListenerRegistrationResponse(Error aResult,
Coap::Message *aMessage,
uint8_t &aStatus,
Ip6::Address *aFailedAddresses,
uint8_t &aFailedAddressNum);
AddressArray &aFailedAddresses);

#if OPENTHREAD_FTD && OPENTHREAD_CONFIG_COMMISSIONER_ENABLE
static void HandleRegisterMulticastListenersResponse(void *aContext,
Expand All @@ -189,16 +196,7 @@ class MlrManager : public InstanceLocator, private NonCopyable
#endif

void SetMulticastAddressMlrState(MlrState aFromState, MlrState aToState);
void FinishMulticastListenerRegistration(bool aSuccess,
const Ip6::Address *aFailedAddresses,
uint8_t aFailedAddressNum);

void AppendToUniqueAddressList(Ip6::Address (&aAddresses)[Ip6AddressesTlv::kMaxAddresses],
uint8_t &aAddressNum,
const Ip6::Address &aAddress);
static bool AddressListContains(const Ip6::Address *aAddressList,
uint8_t aAddressListSize,
const Ip6::Address &aAddress);
void FinishMulticastListenerRegistration(bool aSuccess, const AddressArray &aFailedAddresses);

void ScheduleSend(uint16_t aDelay);
void UpdateTimeTickerRegistration(void);
Expand All @@ -208,11 +206,7 @@ class MlrManager : public InstanceLocator, private NonCopyable

void LogMulticastAddresses(void);
void CheckInvariants(void) const;
static void LogMlrResponse(Error aResult,
Error aError,
uint8_t aStatus,
const Ip6::Address *aFailedAddresses,
uint8_t aFailedAddressNum);
static void LogMlrResponse(Error aResult, Error aError, uint8_t aStatus, const AddressArray &aFailedAddresses);

#if (OPENTHREAD_FTD && OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE) && OPENTHREAD_CONFIG_COMMISSIONER_ENABLE
Callback<otIp6RegisterMulticastListenersCallback> mRegisterMulticastListenersCallback;
Expand Down

0 comments on commit 0044def

Please sign in to comment.