mirror of
https://github.com/espressif/openthread.git
synced 2026-06-05 21:14:49 +00:00
[tests] add Nexus test for redundant MLR registrations (#13092)
This commit adds a new Nexus test (`test_mlr_redundant.cpp`) to verify that the MLR manager correctly handles registrations when multiple entities (e.g., a parent router and its children) subscribe to the same multicast address, without sending redundant requests. The test sets up a topology with a Primary Backbone Router, an FTD Router, and three SEDs. The Router and SEDs all subscribe to the same multicast address. The Router then subscribes to 14 additional unique multicast addresses to exceed the single CoAP message payload limit (`kMaxIp6Addresses`). A CoAP interceptor is registered on the Backbone Router to parse incoming `MLR.req` messages and count the number of times the shared multicast address is included in the payload. The test verifies that the shared address is requested exactly once, ensuring that fragmented state tracking does not lead to duplicate registrations.
This commit is contained in:
Abtin Keshavarzian
committed by
GitHub
GitHub
parent
76db9dfec8
commit
f669d82a81
@@ -414,6 +414,7 @@ ot_nexus_test(mac_scan "core;nexus")
|
||||
ot_nexus_test(mle_router_role_allowed "core;nexus")
|
||||
ot_nexus_test(mle_blocking_downgrade "core;nexus")
|
||||
ot_nexus_test(mle_msg_key_seq_jump "core;nexus")
|
||||
ot_nexus_test(mlr_redundant "core;nexus")
|
||||
ot_nexus_test(nat64_translator "core;nexus")
|
||||
ot_nexus_test(netdata_publisher "core;nexus")
|
||||
ot_nexus_test(on_mesh_prefix "core;nexus")
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
/*
|
||||
* Copyright (c) 2026, 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 <stdio.h>
|
||||
|
||||
#include "coap/coap.hpp"
|
||||
#include "coap/coap_message.hpp"
|
||||
#include "platform/nexus_core.hpp"
|
||||
#include "platform/nexus_node.hpp"
|
||||
|
||||
namespace ot {
|
||||
namespace Nexus {
|
||||
|
||||
static constexpr uint32_t kFormNetworkTime = 10 * 1000;
|
||||
static constexpr uint32_t kAttachToRouterTime = 200 * 1000;
|
||||
static constexpr uint32_t kMlrRegistrationTime = 10 * 1000;
|
||||
|
||||
struct Context
|
||||
{
|
||||
Context(void) { mMlrReqCount = 0; }
|
||||
|
||||
uint32_t mMlrReqCount;
|
||||
Ip6::Address mSharedAddress;
|
||||
};
|
||||
|
||||
static Error BrCoapInterceptor(void *aContext, const Coap::Msg &aMsg)
|
||||
{
|
||||
Mlr::AddressArray addresses;
|
||||
Context *context = static_cast<Context *>(aContext);
|
||||
Coap::Message::UriPathStringBuffer uriPath;
|
||||
|
||||
VerifyOrQuit(context != nullptr);
|
||||
|
||||
VerifyOrExit(aMsg.IsPostRequest());
|
||||
|
||||
SuccessOrExit(aMsg.mMessage.ReadUriPathOptions(uriPath));
|
||||
VerifyOrExit(UriFromPath(uriPath) == kUriMlr);
|
||||
|
||||
SuccessOrExit(Ip6AddressesTlv::FindIn(aMsg.mMessage, addresses));
|
||||
|
||||
Log(" Received MLR.req with %u addresses:", addresses.GetLength());
|
||||
|
||||
for (const Ip6::Address &address : addresses)
|
||||
{
|
||||
Log(" - %s", address.ToString().AsCString());
|
||||
}
|
||||
|
||||
if (addresses.Contains(context->mSharedAddress))
|
||||
{
|
||||
context->mMlrReqCount++;
|
||||
}
|
||||
|
||||
exit:
|
||||
return kErrorNone;
|
||||
}
|
||||
|
||||
void TestMlrRedundant(void)
|
||||
{
|
||||
/**
|
||||
* This test verifies that the MLR manager does not send redundant registration
|
||||
* requests when multiple entities (a parent router and its children) subscribe
|
||||
* to the same multicast address. It sets up a scenario where the total number
|
||||
* of subscribed addresses exceeds the capacity of a single MLR.req CoAP message,
|
||||
* ensuring that the state is properly managed and shared addresses are registered
|
||||
* exactly once with the Primary Backbone Router.
|
||||
*/
|
||||
|
||||
Core nexus;
|
||||
Node &br = nexus.CreateNode();
|
||||
Node &router = nexus.CreateNode();
|
||||
Node &sed1 = nexus.CreateNode();
|
||||
Node &sed2 = nexus.CreateNode();
|
||||
Node &sed3 = nexus.CreateNode();
|
||||
Ip6::Address sharedAddress;
|
||||
Context context;
|
||||
|
||||
nexus.AdvanceTime(0);
|
||||
SuccessOrQuit(Instance::SetGlobalLogLevel(kLogLevelNote));
|
||||
|
||||
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
Log("Form topology");
|
||||
|
||||
AllowLinkBetween(br, router);
|
||||
AllowLinkBetween(router, sed1);
|
||||
AllowLinkBetween(router, sed2);
|
||||
AllowLinkBetween(router, sed3);
|
||||
|
||||
br.Form();
|
||||
nexus.AdvanceTime(kFormNetworkTime);
|
||||
VerifyOrQuit(br.Get<Mle::Mle>().IsLeader());
|
||||
|
||||
router.Join(br, Node::kAsFtd);
|
||||
nexus.AdvanceTime(kAttachToRouterTime);
|
||||
VerifyOrQuit(router.Get<Mle::Mle>().IsRouter());
|
||||
|
||||
sed1.Join(router, Node::kAsSed);
|
||||
sed2.Join(router, Node::kAsSed);
|
||||
sed3.Join(router, Node::kAsSed);
|
||||
nexus.AdvanceTime(kAttachToRouterTime);
|
||||
|
||||
VerifyOrQuit(sed1.Get<Mle::Mle>().IsChild());
|
||||
VerifyOrQuit(sed2.Get<Mle::Mle>().IsChild());
|
||||
VerifyOrQuit(sed3.Get<Mle::Mle>().IsChild());
|
||||
|
||||
SuccessOrQuit(sharedAddress.FromString("ff04::1"));
|
||||
context.mSharedAddress = sharedAddress;
|
||||
|
||||
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
Log("Set an interceptor on leader to count incoming MLR.req messages");
|
||||
br.Get<Tmf::Agent>().SetInterceptor(BrCoapInterceptor, &context);
|
||||
|
||||
Log("Router and SEDs subscribe to the same multicast address");
|
||||
SuccessOrQuit(router.Get<Ip6::Netif>().SubscribeExternalMulticast(sharedAddress));
|
||||
SuccessOrQuit(sed1.Get<Ip6::Netif>().SubscribeExternalMulticast(sharedAddress));
|
||||
SuccessOrQuit(sed2.Get<Ip6::Netif>().SubscribeExternalMulticast(sharedAddress));
|
||||
SuccessOrQuit(sed3.Get<Ip6::Netif>().SubscribeExternalMulticast(sharedAddress));
|
||||
|
||||
Log("Router subscribes to 14 more unique multicast addresses to trigger MLR IP6 Addresses TLV limits");
|
||||
|
||||
for (uint8_t i = 2; i <= 15; i++)
|
||||
{
|
||||
Ip6::Address ma;
|
||||
|
||||
ma = sharedAddress;
|
||||
ma.mFields.m8[15] = i;
|
||||
|
||||
SuccessOrQuit(router.Get<Ip6::Netif>().SubscribeExternalMulticast(ma));
|
||||
}
|
||||
|
||||
nexus.AdvanceTime(15 * Time::kOneSecondInMsec);
|
||||
|
||||
Log("Enable BBR on wait for MLR registrations");
|
||||
br.Get<BackboneRouter::Local>().SetEnabled(true);
|
||||
|
||||
nexus.AdvanceTime(kMlrRegistrationTime);
|
||||
|
||||
Log("Verify the shared address was registered exactly once (no redundant registrations)");
|
||||
|
||||
VerifyOrQuit(context.mMlrReqCount == 1);
|
||||
}
|
||||
|
||||
} // namespace Nexus
|
||||
} // namespace ot
|
||||
|
||||
int main(void)
|
||||
{
|
||||
ot::Nexus::TestMlrRedundant();
|
||||
printf("All tests passed\n");
|
||||
return 0;
|
||||
}
|
||||
Reference in New Issue
Block a user