driver/rawnetworkinterfacedriver: ethtool get/change settings

Add interface configuration (`ethtool --change`) support to the
RawNetworkInterfaceDriver. This allows configuring the bound interface
(speed, lanes, duplex, port, master-slave, mdix, autoneg, advertise,
phyad, xcvr, wol, sopass, msglvl).

Also add add a `get_settings()` method to query those settings. Note
that ethtool gained the required --json support for the default sub
command in v6.10.

Signed-off-by: Bastian Krause <[email protected]>

Author: Bastian-Krause

helpers/labgrid-raw-interface

@@ -9,6 +9,7 @@
 
 import argparse
 import os
+import string
 import sys
 
 import yaml
@@ -45,7 +46,7 @@ def main(program, options):
     if options.ifname in denylist:
         raise ValueError(f"Interface name '{options.ifname}' is denied in denylist.")
 
-    programs = ["tcpreplay", "tcpdump", "ip"]
+    programs = ["tcpreplay", "tcpdump", "ip", "ethtool"]
     if program not in programs:
         raise ValueError(f"Invalid program {program} called with wrapper, valid programs are: {programs}")
 
@@ -86,6 +87,18 @@ def main(program, options):
         args.append(options.ifname)
         args.append(options.action)
 
+    elif program == "ethtool":
+        allowed_chars = set(string.ascii_letters + string.digits + "-/:")
+
+        if options.subcommand == "change":
+            for arg in options.ethtool_change_args:
+                if arg.startswith("-") or not allowed_chars.issuperset(arg):
+                    raise ValueError(f"ethtool --change arg '{arg}' contains invalid characters")
+
+            args.append("--change")
+            args.append(options.ifname)
+            args.extend(options.ethtool_change_args)
+
     try:
         os.execvp(args[0], args)
     except FileNotFoundError as e:
@@ -114,6 +127,17 @@ if __name__ == "__main__":
     ip_parser.add_argument("ifname", type=str, help="interface name")
     ip_parser.add_argument("action", type=str, choices=["up", "down"], help="action, one of {%(choices)s}")
 
+    # ethtool
+    ethtool_parser = subparsers.add_parser("ethtool")
+    ethtool_subparsers = ethtool_parser.add_subparsers(dest="subcommand")
+
+    # ethtool: change
+    ethtool_change_parser = ethtool_subparsers.add_parser("change")
+    ethtool_change_parser.add_argument("ifname", type=str, help="interface name")
+    ethtool_change_parser.add_argument(
+        "ethtool_change_args", metavar="ARG", nargs=argparse.REMAINDER, help="ethtool --change args"
+    )
+
     args = parser.parse_args()
     try:
         main(args.program, args)

labgrid/driver/rawnetworkinterfacedriver.py

@@ -97,6 +97,28 @@ def wait_state(self, expected_state, timeout=60):
         """Wait until the expected state is reached or the timeout expires."""
         self._wait_state(expected_state, timeout=timeout)
 
+    @Driver.check_active
+    def get_ethtool_settings(self):
+        """
+        Returns settings via ethtool of the bound network interface resource.
+        """
+        cmd = self.iface.command_prefix + ["ethtool", "--json", self.iface.ifname]
+        output = subprocess.check_output(cmd, encoding="utf-8")
+        return json.loads(output)[0]
+
+    @Driver.check_active
+    @step(args=["settings"])
+    def ethtool_configure(self, **settings):
+        """
+        Change settings on interface.
+
+        Supported settings are described in ethtool(8) --change (use "_" instead of "-").
+        """
+        cmd = ["ethtool", "change", self.iface.ifname]
+        cmd += [item.replace("_", "-") for pair in settings.items() for item in pair]
+        cmd = self._wrap_command(cmd)
+        subprocess.check_call(cmd)
+
     def _stop(self, proc, *, timeout=None):
         assert proc is not None