On Mon, Jul 8, 2024 at 3:19 PM Dean Marx <dm...@iol.unh.edu> wrote:
>
> added set multicast function for changing allmulticast mode within testpmd.
>
> Signed-off-by: Dean Marx <dm...@iol.unh.edu>
> ---
> dts/framework/remote_session/testpmd_shell.py | 46 +++++++++++++++++++
> 1 file changed, 46 insertions(+)
>
> diff --git a/dts/framework/remote_session/testpmd_shell.py
> b/dts/framework/remote_session/testpmd_shell.py
> index ec22f72221..a0be0bd09d 100644
> --- a/dts/framework/remote_session/testpmd_shell.py
> +++ b/dts/framework/remote_session/testpmd_shell.py
> @@ -806,6 +806,52 @@ def show_port_stats(self, port_id: int) ->
> TestPmdPortStats:
>
> return TestPmdPortStats.parse(output)
>
> + def set_promisc(self, port: int, on: bool, verify: bool = True):
This public method seems to be missing the return type, it should
probably specify that it doesn't return anything with a None-type.
> + """Turns promiscuous mode on/off for the specified port.
> +
> + Args:
> + port: Port number to use, should be within 0-32.
> + on: If :data:`True`, turn promisc mode on, otherwise turn off.
> + verify: If :data:`True` an additional command will be sent to
> verify that promisc mode
> + is properly set. Defaults to :data:`True`.
> +
> + Raises:
> + InteractiveCommandExecutionError: If `verify` is :data:`True`
> and promisc mode
> + is not correctly set.
> + """
> + promisc_output = self.send_command(f"set promisc {port} {'on' if on
> else 'off'}")
> + if verify:
> + stats = self.show_port_info(port_id=port)
> + if on ^ stats.is_promiscuous_mode_enabled:
> + self._logger.debug(f"Failed to set promisc mode on port
> {port}: \n{promisc_output}")
> + raise InteractiveCommandExecutionError(
> + f"Testpmd failed to set promisc mode on port {port}."
> + )
> +
> + def set_multicast_all(self, on: bool, verify: bool = True):
This method also should probably have a typehint for the return type.
> + """Turns multicast mode on/off for the specified port.
> +
> + Args:
> + on: If :data:`True`, turns multicast mode on, otherwise turns
> off.
> + verify: If :data:`True` an additional command will be sent to
> verify
> + that multicast mode is properly set. Defaults to :data:`True`.
I'm surprised the formatting script doesn't complain about a
mismatched indent here, I thought it normally did for doc-strings. The
second line of this verify argument should probably be indented just
to better show that it is a continuation of the previous line.
> +
> + Raises:
> + InteractiveCommandExecutionError: If `verify` is :data:`True`
> and multicast
> + mode is not properly set.
> + """
> + multicast_output = self.send_command(f"set allmulti all {'on' if on
> else 'off'}")
> + if verify:
> + stats0 = self.show_port_info(port_id=0)
> + stats1 = self.show_port_info(port_id=1)
Getting the stats for port 0 and port 1 limit this method to only
working when there are exactly 2 ports. Right now in DTS this is a
restriction, but we should be able to make this robust enough to work
with any number of ports using self.show_port_info_all().
> + if on ^ (stats0.is_allmulticast_mode_enabled and
> stats1.is_allmulticast_mode_enabled):
If you used the show port info all command, you could then just
replace this `and` statement with something like this:
all(info.is_allmulticast_mode_enabled for info in all_stats)
if `all_stats` was the name of the list you stored the port stats in.
> + self._logger.debug(
> + f"Failed to set multicast mode on all ports.:
> \n{multicast_output}"
> + )
> + raise InteractiveCommandExecutionError(
> + "Testpmd failed to set multicast mode on all ports."
> + )
> +
> def close(self) -> None:
> """Overrides :meth:`~.interactive_shell.close`."""
> self.send_command("quit", "")
> --
> 2.44.0
>
