mirror of
https://github.com/espressif/openthread.git
synced 2026-09-18 07:00:08 +00:00
Abtin Keshavarzian
c13fcc62c8
This commit implements "Periodic Parent Search" mechanism for FED/REED devices (FTD children). This enhances and builds upon the existing parent search feature, which is mainly intended for MTD children. An FTD child receives and processes MLE Advertisements from neighboring routers. The child uses this information to track the one-way link quality to each router, which is later used to compare and select potential new parents. Every "parent search check interval", the FTD child checks to see if it can select a better parent by evaluating all neighboring routers based on their link quality information. A router is considered a suitable parent candidate only if its average RSS exceeds the current parent's RSS by a margin (`PARENT_SEARCH_RSS_MARGIN`). Once a candidate is selected, the FTD child sends unicast MLE Parent Requests to both the candidate and its current parent. This ensures updated connectivity information is obtained from both before making a decision. The same set of criteria used to compare candidates during initial attach are applied during parent switch. If the attach attempt to the selected candidate fails (e.g., the router already has the maximum number of children it can support), the FTD child ensures not to select the same router again until a "reselect timeout" expires. This commit also adds the `test-025-fed-parent-search.py test`, which validates the newly added FTD parent search behavior, including the mechanisms to attach to a selected router and the reselect timeout.
173 lines
6.1 KiB
Python
Executable File
173 lines
6.1 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Copyright (c) 2024, 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.
|
|
|
|
from cli import verify
|
|
from cli import verify_within
|
|
import cli
|
|
import time
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Test description:
|
|
#
|
|
# Validate parent search on FTD child (FED/REED).
|
|
#
|
|
# Topology:
|
|
#
|
|
# The link between `r1` and `fed` is configured to be poor, ensuring
|
|
# `fed` will search for a new parent. `r2` is configured with
|
|
# `set_child_max(1)`, allowing only one child. `c2` is already
|
|
# attached to `r2`, preventing `r2` from accepting `fed` as a child.
|
|
# Later, `r3` is added to the network, and the test validates that
|
|
# `fed` successfully switches to `r3` as its parent.
|
|
#
|
|
#
|
|
# r1 ---- r2 r3 -- r1 -- r2
|
|
# . | \ |
|
|
# . | ==> \ |
|
|
# fed c2 fed c2
|
|
|
|
test_name = __file__[:-3] if __file__.endswith('.py') else __file__
|
|
print('-' * 120)
|
|
print('Starting \'{}\''.format(test_name))
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Creating `cli.Node` instances
|
|
|
|
speedup = 40
|
|
cli.Node.set_time_speedup_factor(speedup)
|
|
|
|
fed = cli.Node()
|
|
r1 = cli.Node()
|
|
r2 = cli.Node()
|
|
c2 = cli.Node()
|
|
r3 = cli.Node()
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Test Implementation
|
|
|
|
r1.set_macfilter_lqi_to_node(fed, 1)
|
|
fed.set_macfilter_lqi_to_node(r1, 1)
|
|
|
|
r1.allowlist_node(fed)
|
|
r1.allowlist_node(r2)
|
|
r1.allowlist_node(r3)
|
|
|
|
r2.allowlist_node(fed)
|
|
r2.allowlist_node(r1)
|
|
r2.allowlist_node(c2)
|
|
r2.allowlist_node(r3)
|
|
|
|
c2.allowlist_node(r2)
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# `r2` is allowed to have one child only (`c2`)
|
|
|
|
r2.set_child_max(1)
|
|
verify(int(r2.get_child_max()) == 1)
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# Form the network.
|
|
|
|
r1.form('fed-prnt-srch')
|
|
fed.join(r1, cli.JOIN_TYPE_REED)
|
|
r2.join(r1)
|
|
c2.join(r2, cli.JOIN_TYPE_END_DEVICE)
|
|
|
|
verify(r1.get_state() == 'leader')
|
|
verify(fed.get_state() == 'child')
|
|
verify(r2.get_state() == 'router')
|
|
verify(c2.get_state() == 'child')
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# Check that `c2` is attached to `r2`.
|
|
|
|
info = c2.get_parent_info()
|
|
verify(int(info['Rloc'], 16) == int(r2.get_rloc16(), 16))
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# Check that `fed` is attached to `r1` and has poor link quality.
|
|
|
|
info = fed.get_parent_info()
|
|
verify(int(info['Rloc'], 16) == int(r1.get_rloc16(), 16))
|
|
verify(int(info['Link Quality In']) == 1)
|
|
verify(int(info['Link Quality Out']) == 1)
|
|
|
|
verify(int(cli.Node.parse_list(fed.get_mle_counter())['Better Parent Attach Attempts']) == 0)
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# The `toranj` config sets `PARENT_SEARCH_CHECK_INTERVAL` to 120 seconds.
|
|
|
|
time.sleep(130 / speedup)
|
|
|
|
# Verify that parent search mechanism did trigger an attach attempt on
|
|
# `fed`.
|
|
|
|
verify(int(cli.Node.parse_list(fed.get_mle_counter())['Better Parent Attach Attempts']) == 1)
|
|
|
|
# Since `r2` can have one child only and already has `c2`, the attach
|
|
# attempt should fail and `fed` should still have `r1` as its
|
|
# parent.
|
|
|
|
info = fed.get_parent_info()
|
|
verify(int(info['Rloc'], 16) == int(r1.get_rloc16(), 16))
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# Ensure that `fed` does not initiate any further attach attempts, as
|
|
# the only available parent (`r2`) should be in the "reselect timeout"
|
|
# period. This should prevent `fed` from attempting to attach to `r2`.
|
|
|
|
time.sleep(150 / speedup)
|
|
|
|
verify(int(cli.Node.parse_list(fed.get_mle_counter())['Better Parent Attach Attempts']) == 1)
|
|
|
|
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
# Add `r3` to the network and wait for `PARENT_SEARCH_CHECK_INTERVAL`.
|
|
# This should trigger a parent search on `fed`. Validate that
|
|
# `fed` successfully switches to `r3` as its new parent.
|
|
|
|
r3.join(r1)
|
|
verify(r3.get_state() == 'router')
|
|
|
|
time.sleep(130 / speedup)
|
|
|
|
counters = cli.Node.parse_list(fed.get_mle_counter())
|
|
verify(int(counters['Better Parent Attach Attempts']) == 2)
|
|
verify(int(counters['Parent Changes']) == 1)
|
|
|
|
info = fed.get_parent_info()
|
|
verify(int(info['Rloc'], 16) == int(r3.get_rloc16(), 16))
|
|
verify(int(info['Link Quality In']) == 3)
|
|
verify(int(info['Link Quality Out']) == 3)
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Test finished
|
|
|
|
cli.Node.finalize_all_nodes()
|
|
|
|
print('\'{}\' passed.'.format(test_name))
|