[mac] add "Radio Filter" mechanism (#7156)

This commit implements new radio filter mechanism in OpenThread. The
radio filter is mainly intended for testing. It can be used to
temporarily block all tx/rx on the IEEE 802.15.4 radio. When radio
filter is enabled, radio is put to sleep instead of receive (to
ensure that the device does not receive any frame and/or potentially
send ack). Also the frame transmission requests return immediately
without sending the frame over the air (return "no ack" error if ack
is requested, otherwise return success). This commit also add CLI
command `radiofilter` for this feature. It also adds test-case
`test_radio_filter` to validate the behavior of the new feature.
This feature requires `OPENTHREAD_CONFIG_MAC_FILTER_ENABLE`.
This commit is contained in:
Abtin Keshavarzian
2021-11-29 12:45:11 -08:00
committed by GitHub
parent e4da1f6c71
commit 912eca181d
13 changed files with 404 additions and 14 deletions
+2
View File
@@ -179,6 +179,7 @@ EXTRA_DIST = \
test_on_mesh_prefix.py \
test_pbbr_aloc.py \
test_ping.py \
test_radio_filter.py \
test_reed_address_solicit_rejected.py \
test_reset.py \
test_route_table.py \
@@ -252,6 +253,7 @@ check_SCRIPTS = \
test_on_mesh_prefix.py \
test_pbbr_aloc.py \
test_ping.py \
test_radio_filter.py \
test_reed_address_solicit_rejected.py \
test_reset.py \
test_route_table.py \
+27
View File
@@ -839,6 +839,21 @@ class NodeImpl:
self.send_command(cmd)
self._expect_done()
def radiofilter_is_enabled(self) -> bool:
states = [r'Disabled', r'Enabled']
self.send_command('radiofilter')
return self._expect_result(states) == 'Enabled'
def radiofilter_enable(self):
cmd = 'radiofilter enable'
self.send_command(cmd)
self._expect_done()
def radiofilter_disable(self):
cmd = 'radiofilter disable'
self.send_command(cmd)
self._expect_done()
def get_bbr_registration_jitter(self):
self.send_command('bbr jitter')
return int(self._expect_result(r'\d+'))
@@ -2000,6 +2015,18 @@ class NodeImpl:
})
return networks
def scan_energy(self, timeout=10):
self.send_command('scan energy')
self.simulator.go(timeout)
rssi_list = []
for line in self._expect_command_output()[2:]:
_, channel, rssi, _ = line.split('|')
rssi_list.append({
'channel': int(channel.strip()),
'rssi': int(rssi.strip()),
})
return rssi_list
def ping(self, ipaddr, num_responses=1, size=8, timeout=5, count=1, interval=1, hoplimit=64, interface=None):
args = f'{ipaddr} {size} {count} {interval} {hoplimit} {timeout}'
if interface is not None:
+151
View File
@@ -0,0 +1,151 @@
#!/usr/bin/env python3
#
# Copyright (c) 2021, 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.
#
import ipaddress
import unittest
import config
import command
import thread_cert
# Test description:
#
# This test verifies the radio filter mechanism.
#
# Topology:
#
# Leader -- Router
# |
# |
# Child
#
#
LEADER = 1
ROUTER = 2
SED = 3
WAIT_TIME = 5
class RadioFilter(thread_cert.TestCase):
USE_MESSAGE_FACTORY = False
SUPPORT_NCP = False
TOPOLOGY = {
LEADER: {
'mode': 'rdn',
'allowlist': [ROUTER, SED]
},
ROUTER: {
'mode': 'rdn',
'allowlist': [LEADER]
},
SED: {
'is_mtd': True,
'mode': '-',
'timeout': config.DEFAULT_CHILD_TIMEOUT,
'allowlist': [LEADER]
},
}
def test(self):
leader = self.nodes[LEADER]
router = self.nodes[ROUTER]
sed = self.nodes[SED]
nodes = [leader, router, sed]
leader.start()
self.simulator.go(WAIT_TIME)
self.assertEqual(leader.get_state(), 'leader')
router.start()
self.simulator.go(WAIT_TIME)
self.assertEqual(router.get_state(), 'router')
sed.start()
sed.set_pollperiod(40)
self.simulator.go(WAIT_TIME)
self.assertEqual(sed.get_state(), 'child')
# Validate initial state of `radiofilter` upon start
for node in nodes:
self.assertFalse(node.radiofilter_is_enabled())
leader_mleid = leader.get_mleid()
router_mleid = router.get_mleid()
sed_mleid = sed.get_mleid()
# Validate connections by pinging from leader, SED, and router
self.assertTrue(leader.ping(router_mleid))
self.assertTrue(sed.ping(leader_mleid))
self.assertTrue(router.ping(leader_mleid))
# Validate behavior when `radiofilter` is enabled on router
router.radiofilter_enable()
self.assertTrue(router.radiofilter_is_enabled())
self.assertFalse(leader.ping(router_mleid))
self.assertFalse(router.ping(leader_mleid))
# Validate behavior when `radiofilter` is disabled on router
router.radiofilter_disable()
self.assertFalse(router.radiofilter_is_enabled())
self.assertTrue(leader.ping(router_mleid))
self.assertTrue(router.ping(leader_mleid))
# Validate `radiofilter` behavior on sed.
self.assertTrue(sed.ping(leader_mleid))
sed.radiofilter_enable()
self.assertTrue(sed.radiofilter_is_enabled())
self.assertFalse(sed.ping(leader_mleid))
self.assertTrue(sed.radiofilter_is_enabled())
self.assertEqual(sed.get_state(), 'detached')
sed.radiofilter_disable()
self.assertFalse(sed.radiofilter_is_enabled())
self.simulator.go(WAIT_TIME)
self.assertEqual(sed.get_state(), 'child')
self.assertTrue(leader.ping(sed_mleid))
self.assertTrue(sed.ping(leader_mleid))
# Validate energy scan when `radiofilter` is enabled
scan_result = leader.scan_energy()
self.assertTrue(len(scan_result) > 0)
leader.radiofilter_enable()
self.assertTrue(leader.radiofilter_is_enabled())
scan_result = leader.scan_energy()
self.assertTrue(len(scan_result) == 0)
if __name__ == '__main__':
unittest.main()