Skip to contentSkip to conversation

rpcctl: Various Improvements

PATCH Superseded Anna Schumaker 3 participants 14 messages Jan 8, 2025 – Jan 14, 2025

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Anna Schumaker

author maintainer
#0 lore raw

cover rpcctl: Various Improvements

From: Anna Schumaker <[email protected]>

The first several patches in this series fix up several Python style errors found through the flake8 to clean up the tool. The remaining patches update the tool for the xprtsec and add_xprt features added to the NFS / sunrpc client with the companion kernel patches.

Thoughts?
Anna

Anna Schumaker (10):
rpcctl: Fix flake8 whitespace errors
rpcctl: Fix flake8 line-too-long errors
rpcctl: Fix flake8 bare exception error
rpcctl: Fix flake8 ambiguous-variable-name error
rpcctl: Add missing docstrings to the Xprt class
rpcctl: Add missing docstrings to the XprtSwitch class
rpcctl: Add remaining missing docstrings rpcctl.py: Rename {read,write}_addr_file() rpcctl.py: Add support for the xprtsec sysfs attribute
rpcctl: Add support for rpcctl switch add-xprt

 tools/rpcctl/rpcctl.man |   4 ++
 tools/rpcctl/rpcctl.py  | 145 ++++++++++++++++++++++++++++++----------
 2 files changed, 114 insertions(+), 35 deletions(-)
Signature · 1 line
2.47.1
author maintainer
#1 lore raw

PATCH 1/10 rpcctl: Fix flake8 whitespace errors

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 38 ++++++++++++++++++++++----------------
 1 file changed, 22 insertions(+), 16 deletions(-)
tools/rpcctl/rpcctl.py +22 -16
index d2110ad6de93..92a851c2278b 100755
@@ -8,7 +8,7 @@ import socket
 import sys
 
 with open("/proc/mounts", 'r') as f:
-    mount = [ line.split()[1] for line in f if "sysfs" in line ]
+    mount = [line.split()[1] for line in f if "sysfs" in line]
     if len(mount) == 0:
         print("ERROR: sysfs is not mounted")
         sys.exit(1)
@@ -18,6 +18,7 @@ if not sunrpc.is_dir():
     print("ERROR: sysfs does not have sunrpc directory")
     sys.exit(1)
 
+
 def read_addr_file(path):
     try:
         with open(path, 'r') as f:
@@ -25,17 +26,19 @@ def read_addr_file(path):
     except:
         return "(enoent)"
 
+
 def write_addr_file(path, newaddr):
     with open(path, 'w') as f:
         f.write(newaddr)
     return read_addr_file(path)
 
+
 def read_info_file(path):
     res = collections.defaultdict(int)
     try:
         with open(path) as info:
-            lines = [ l.split("=", 1) for l in info if "=" in l ]
-            res.update({ key:int(val.strip()) for (key, val) in lines })
+            lines = [l.split("=", 1) for l in info if "=" in l]
+            res.update({key: int(val.strip()) for (key, val) in lines})
     finally:
         return res
 
@@ -75,7 +78,7 @@ class Xprt:
         if not self.path.exists():
             return f"{self.name}: has been removed"
         return "\n".join([self._xprt(), self._src_reqs(),
-                          self._cong_slots(), self._queues() ])
+                          self._cong_slots(), self._queues()])
 
     def read_state(self):
         if self.path.exists():
@@ -132,7 +135,7 @@ class Xprt:
 
     def get_by_name(name):
         glob = f"**/{name}-*" if name else "**/xprt-*"
-        res = [ Xprt(x) for x in (sunrpc / "xprt-switches").glob(glob) ]
+        res = [Xprt(x) for x in (sunrpc / "xprt-switches").glob(glob)]
         if name and len(res) == 0:
             raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT),
                                     f"{sunrpc / 'xprt-switches' / glob}")
@@ -158,19 +161,19 @@ class XprtSwitch:
         self.path = path
         self.name = path.stem
         self.info = read_info_file(path / "xprt_switch_info")
-        self.xprts = sorted([ Xprt(p) for p in self.path.iterdir() if p.is_dir() ])
+        self.xprts = sorted([Xprt(p) for p in self.path.iterdir() if p.is_dir()])
         self.sep = sep
 
     def __lt__(self, rhs):
         return self.name < rhs.name
 
     def __str__(self):
-        switch =  f"{self.name}{self.sep} " \
-                  f"xprts {self.info['num_xprts']}, " \
-                  f"active {self.info['num_active']}, " \
-                  f"queue {self.info['queue_len']}"
-        xprts = [ f"	{x.small_str()}" for x in self.xprts ]
-        return "\n".join([ switch ] + xprts)
+        switch = f"{self.name}{self.sep} " \
+                 f"xprts {self.info['num_xprts']}, " \
+                 f"active {self.info['num_active']}, " \
+                 f"queue {self.info['queue_len']}"
+        xprts = [f"	{x.small_str()}" for x in self.xprts]
+        return "\n".join([switch] + xprts)
 
     def add_command(subparser):
         parser = subparser.add_parser("switch", help="Commands for xprt switches")
@@ -194,8 +197,8 @@ class XprtSwitch:
     def get_by_name(name):
         xprt_switches = sunrpc / "xprt-switches"
         if name:
-            return [ XprtSwitch(xprt_switches / name) ]
-        return [ XprtSwitch(f) for f in sorted(xprt_switches.iterdir()) ]
+            return [XprtSwitch(xprt_switches / name)]
+        return [XprtSwitch(f) for f in sorted(xprt_switches.iterdir())]
 
     def show(args):
         for switch in XprtSwitch.get_by_name(args.switch):
@@ -234,8 +237,8 @@ class RpcClient:
     def get_by_name(name):
         rpc_clients = sunrpc / "rpc-clients"
         if name:
-            return [ RpcClient(rpc_clients / name) ]
-        return [ RpcClient(f) for f in sorted(rpc_clients.iterdir()) ]
+            return [RpcClient(rpc_clients / name)]
+        return [RpcClient(f) for f in sorted(rpc_clients.iterdir())]
 
     def show(args):
         for client in RpcClient.get_by_name(args.client):
@@ -244,9 +247,12 @@ class RpcClient:
 
 parser = argparse.ArgumentParser()
 
+
 def show_small_help(args):
     parser.print_usage()
     print("sunrpc dir:", sunrpc)
+
+
 parser.set_defaults(func=show_small_help)
 
 subparser = parser.add_subparsers(title="commands")
Signature · 1 line
2.47.1
author maintainer
#2 lore raw

PATCH 2/10 rpcctl: Fix flake8 line-too-long errors

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)
tools/rpcctl/rpcctl.py +22 -11
index 92a851c2278b..ec43d12afc41 100755
@@ -66,13 +66,17 @@ class Xprt:
                f"Requests: {self.info['num_reqs']}"
 
     def _cong_slots(self):
-        return f"	Congestion: cur {self.info['cur_cong']}, win {self.info['cong_win']}, " \
-               f"Slots: min {self.info['min_num_slots']}, max {self.info['max_num_slots']}"
+        return f"	Congestion: cur {self.info['cur_cong']}, " \
+               f"win {self.info['cong_win']}, " \
+               f"Slots: min {self.info['min_num_slots']}, " \
+               f"max {self.info['max_num_slots']}"
 
     def _queues(self):
         return f"	Queues: binding {self.info['binding_q_len']}, " \
-               f"sending {self.info['sending_q_len']}, pending {self.info['pending_q_len']}, " \
-               f"backlog {self.info['backlog_q_len']}, tasks {self.info['tasks_queuelen']}"
+               f"sending {self.info['sending_q_len']}, " \
+               f"pending {self.info['pending_q_len']}, " \
+               f"backlog {self.info['backlog_q_len']}, " \
+               f"tasks {self.info['tasks_queuelen']}"
 
     def __str__(self):
         if not self.path.exists():
@@ -106,7 +110,8 @@ class Xprt:
         self.set_state("remove")
 
     def add_command(subparser):
-        parser = subparser.add_parser("xprt", help="Commands for individual xprts")
+        parser = subparser.add_parser("xprt",
+                                      help="Commands for individual xprts")
         parser.set_defaults(func=Xprt.show, xprt=None)
         subparser = parser.add_subparsers()
 
@@ -128,7 +133,8 @@ class Xprt:
         online.set_defaults(func=Xprt.set_property, property="online")
         offline = subparser.add_parser("offline", help="Set an xprt offline")
         offline.set_defaults(func=Xprt.set_property, property="offline")
-        dstaddr = subparser.add_parser("dstaddr", help="Change an xprt's dstaddr")
+        dstaddr = subparser.add_parser("dstaddr",
+                                       help="Change an xprt's dstaddr")
         dstaddr.add_argument("newaddr", metavar="NEWADDR", nargs=1,
                              help="The new address for the xprt")
         dstaddr.set_defaults(func=Xprt.set_property, property="dstaddr")
@@ -161,7 +167,8 @@ class XprtSwitch:
         self.path = path
         self.name = path.stem
         self.info = read_info_file(path / "xprt_switch_info")
-        self.xprts = sorted([Xprt(p) for p in self.path.iterdir() if p.is_dir()])
+        self.xprts = sorted([Xprt(p) for p in self.path.iterdir()
+                             if p.is_dir()])
         self.sep = sep
 
     def __lt__(self, rhs):
@@ -176,7 +183,8 @@ class XprtSwitch:
         return "\n".join([switch] + xprts)
 
     def add_command(subparser):
-        parser = subparser.add_parser("switch", help="Commands for xprt switches")
+        parser = subparser.add_parser("switch",
+                                      help="Commands for xprt switches")
         parser.set_defaults(func=XprtSwitch.show, switch=None)
         subparser = parser.add_subparsers()
 
@@ -185,11 +193,13 @@ class XprtSwitch:
                           help="Name of a specific switch to show")
         show.set_defaults(func=XprtSwitch.show)
 
-        set = subparser.add_parser("set", help="Change an xprt switch property")
+        set = subparser.add_parser("set",
+                                   help="Change an xprt switch property")
         set.add_argument("switch", metavar="SWITCH", nargs=1,
                          help="Name of a specific xprt switch to modify")
         subparser = set.add_subparsers(required=True)
-        dstaddr = subparser.add_parser("dstaddr", help="Change an xprt switch's dstaddr")
+        dstaddr = subparser.add_parser("dstaddr",
+                                       help="Change an xprt switch's dstaddr")
         dstaddr.add_argument("newaddr", metavar="NEWADDR", nargs=1,
                              help="The new address for the xprt switch")
         dstaddr.set_defaults(func=XprtSwitch.set_property, property="dstaddr")
@@ -225,7 +235,8 @@ class RpcClient:
         return f"{self.name}: {self.switch}"
 
     def add_command(subparser):
-        parser = subparser.add_parser("client", help="Commands for rpc clients")
+        parser = subparser.add_parser("client",
+                                      help="Commands for rpc clients")
         parser.set_defaults(func=RpcClient.show, client=None)
         subparser = parser.add_subparsers()
 
Signature · 1 line
2.47.1
author maintainer
#3 lore raw

PATCH 3/10 rpcctl: Fix flake8 bare exception error

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/rpcctl/rpcctl.py +1 -1
index ec43d12afc41..c6e73aad8bb9 100755
@@ -23,7 +23,7 @@ def read_addr_file(path):
     try:
         with open(path, 'r') as f:
             return f.readline().strip()
-    except:
+    except FileNotFoundError:
         return "(enoent)"
 
 
Signature · 1 line
2.47.1
author maintainer
#4 lore raw

PATCH 4/10 rpcctl: Fix flake8 ambiguous-variable-name error

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/rpcctl/rpcctl.py +1 -1
index c6e73aad8bb9..435f4be6623a 100755
@@ -37,7 +37,7 @@ def read_info_file(path):
     res = collections.defaultdict(int)
     try:
         with open(path) as info:
-            lines = [l.split("=", 1) for l in info if "=" in l]
+            lines = [line.split("=", 1) for line in info if "=" in line]
             res.update({key: int(val.strip()) for (key, val) in lines})
     finally:
         return res
Signature · 1 line
2.47.1
author maintainer
#5 lore raw

PATCH 5/10 rpcctl: Add missing docstrings to the Xprt class

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
tools/rpcctl/rpcctl.py +14 -0
index 435f4be6623a..b8808787b51d 100755
@@ -44,7 +44,10 @@ def read_info_file(path):
 
 
 class Xprt:
+    """Represents a single sunrpc connection."""
+
     def __init__(self, path):
+        """Read in xprt information from sysfs."""
         self.path = path
         self.name = path.stem.rsplit("-", 1)[0]
         self.type = path.stem.split("-")[2]
@@ -54,6 +57,7 @@ class Xprt:
         self.read_state()
 
     def __lt__(self, rhs):
+        """Compare the names of two xprt instances."""
         return self.name < rhs.name
 
     def _xprt(self):
@@ -79,24 +83,29 @@ class Xprt:
                f"tasks {self.info['tasks_queuelen']}"
 
     def __str__(self):
+        """Return a string representation of an xprt."""
         if not self.path.exists():
             return f"{self.name}: has been removed"
         return "\n".join([self._xprt(), self._src_reqs(),
                           self._cong_slots(), self._queues()])
 
     def read_state(self):
+        """Read in the xprt_state file."""
         if self.path.exists():
             with open(self.path / "xprt_state") as f:
                 self.state = ','.join(f.readline().split()[1:])
 
     def small_str(self):
+        """Return a short string summary of an xprt."""
         main = " [main]" if self.info.get("main_xprt") else ""
         return f"{self.name}: {self.type}, {self.dstaddr}{main}"
 
     def set_dstaddr(self, newaddr):
+        """Change the dstaddr of an xprt."""
         self.dstaddr = write_addr_file(self.path / "dstaddr", newaddr)
 
     def set_state(self, state):
+        """Change the state of an xprt."""
         if self.info.get("main_xprt"):
             raise Exception(f"Main xprts cannot be set {state}")
         with open(self.path / "xprt_state", 'w') as f:
@@ -104,12 +113,14 @@ class Xprt:
         self.read_state()
 
     def remove(self):
+        """Remove an xprt."""
         if self.info.get("main_xprt"):
             raise Exception("Main xprts cannot be removed")
         self.set_state("offline")
         self.set_state("remove")
 
     def add_command(subparser):
+        """Add parser options for the `rpcctl xprt` command."""
         parser = subparser.add_parser("xprt",
                                       help="Commands for individual xprts")
         parser.set_defaults(func=Xprt.show, xprt=None)
@@ -140,6 +151,7 @@ class Xprt:
         dstaddr.set_defaults(func=Xprt.set_property, property="dstaddr")
 
     def get_by_name(name):
+        """Find a (sorted) list of Xprts matching the given name."""
         glob = f"**/{name}-*" if name else "**/xprt-*"
         res = [Xprt(x) for x in (sunrpc / "xprt-switches").glob(glob)]
         if name and len(res) == 0:
@@ -148,10 +160,12 @@ class Xprt:
         return sorted(res)
 
     def show(args):
+        """Handle the `rpcctl xprt show` command."""
         for xprt in Xprt.get_by_name(args.xprt):
             print(xprt)
 
     def set_property(args):
+        """Handle the `rpcctl xprt set` command."""
         for xprt in Xprt.get_by_name(args.xprt[0]):
             if args.property == "dstaddr":
                 xprt.set_dstaddr(socket.gethostbyname(args.newaddr[0]))
Signature · 1 line
2.47.1
author maintainer
#6 lore raw

PATCH 6/10 rpcctl: Add missing docstrings to the XprtSwitch class

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 9 +++++++++
 1 file changed, 9 insertions(+)
tools/rpcctl/rpcctl.py +9 -0
index b8808787b51d..adeb26d51f0e 100755
@@ -177,7 +177,10 @@ class Xprt:
 
 
 class XprtSwitch:
+    """Represents a group of xprt connections."""
+
     def __init__(self, path, sep=":"):
+        """Read in xprt switch information from sysfs."""
         self.path = path
         self.name = path.stem
         self.info = read_info_file(path / "xprt_switch_info")
@@ -186,9 +189,11 @@ class XprtSwitch:
         self.sep = sep
 
     def __lt__(self, rhs):
+        """Compare the name of two xprt switch instances."""
         return self.name < rhs.name
 
     def __str__(self):
+        """Return a string representation of an xprt switch."""
         switch = f"{self.name}{self.sep} " \
                  f"xprts {self.info['num_xprts']}, " \
                  f"active {self.info['num_active']}, " \
@@ -197,6 +202,7 @@ class XprtSwitch:
         return "\n".join([switch] + xprts)
 
     def add_command(subparser):
+        """Add parser options for the `rpcctl switch` command."""
         parser = subparser.add_parser("switch",
                                       help="Commands for xprt switches")
         parser.set_defaults(func=XprtSwitch.show, switch=None)
@@ -219,16 +225,19 @@ class XprtSwitch:
         dstaddr.set_defaults(func=XprtSwitch.set_property, property="dstaddr")
 
     def get_by_name(name):
+        """Find a (sorted) list of XprtSwitches matching the given name."""
         xprt_switches = sunrpc / "xprt-switches"
         if name:
             return [XprtSwitch(xprt_switches / name)]
         return [XprtSwitch(f) for f in sorted(xprt_switches.iterdir())]
 
     def show(args):
+        """Handle the `rpcctl switch show` command."""
         for switch in XprtSwitch.get_by_name(args.switch):
             print(switch)
 
     def set_property(args):
+        """Handle the `rpcctl switch set` command."""
         for switch in XprtSwitch.get_by_name(args.switch[0]):
             resolved = socket.gethostbyname(args.newaddr[0])
             for xprt in switch.xprts:
Signature · 1 line
2.47.1
author maintainer
#7 lore raw

PATCH 7/10 rpcctl: Add remaining missing docstrings

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

---
 tools/rpcctl/rpcctl.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)
tools/rpcctl/rpcctl.py +13 -0
index adeb26d51f0e..0221fbb68be1 100755
@@ -1,4 +1,5 @@
 #!/usr/bin/python3
+"""Utility for working with the sunrpc sysfs files."""
 import argparse
 import collections
 import errno
@@ -20,6 +21,7 @@ if not sunrpc.is_dir():
 
 
 def read_addr_file(path):
+    """Read an xprt address file."""
     try:
         with open(path, 'r') as f:
             return f.readline().strip()
@@ -28,12 +30,14 @@ def read_addr_file(path):
 
 
 def write_addr_file(path, newaddr):
+    """Write a new address to an xprt address file."""
     with open(path, 'w') as f:
         f.write(newaddr)
     return read_addr_file(path)
 
 
 def read_info_file(path):
+    """Read an xprt or xprt switch information file."""
     res = collections.defaultdict(int)
     try:
         with open(path) as info:
@@ -246,18 +250,24 @@ class XprtSwitch:
 
 
 class RpcClient:
+    """Represents an rpc client instance."""
+
     def __init__(self, path):
+        """Read in rpc client information from sysfs."""
         self.path = path
         self.name = path.stem
         self.switch = XprtSwitch(path / (path / "switch").readlink(), sep=",")
 
     def __lt__(self, rhs):
+        """Compare the name of two rpc client instances."""
         return self.name < rhs.name
 
     def __str__(self):
+        """Return a string representation of an rpc client."""
         return f"{self.name}: {self.switch}"
 
     def add_command(subparser):
+        """Add parser options for the `rpcctl client` command."""
         parser = subparser.add_parser("client",
                                       help="Commands for rpc clients")
         parser.set_defaults(func=RpcClient.show, client=None)
@@ -269,12 +279,14 @@ class RpcClient:
         parser.set_defaults(func=RpcClient.show)
 
     def get_by_name(name):
+        """Find a (sorted) list of RpcClients matching the given name."""
         rpc_clients = sunrpc / "rpc-clients"
         if name:
             return [RpcClient(rpc_clients / name)]
         return [RpcClient(f) for f in sorted(rpc_clients.iterdir())]
 
     def show(args):
+        """Handle the `rpcctl client show` command."""
         for client in RpcClient.get_by_name(args.client):
             print(client)
 
@@ -283,6 +295,7 @@ parser = argparse.ArgumentParser()
 
 
 def show_small_help(args):
+    """Show a one-line usage summary if no subcommand is given."""
     parser.print_usage()
     print("sunrpc dir:", sunrpc)
 
Signature · 1 line
2.47.1
author maintainer
#8 lore raw

PATCH 8/10 rpcctl.py: Rename {read,write}_addr_file()

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

There is nothing address specific about these functions, so name them something more generic so they can be reused.

---
 tools/rpcctl/rpcctl.py | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
tools/rpcctl/rpcctl.py +9 -9
index 0221fbb68be1..654b2f60a894 100755
@@ -20,8 +20,8 @@ if not sunrpc.is_dir():
     sys.exit(1)
 
 
-def read_addr_file(path):
-    """Read an xprt address file."""
+def read_sysfs_file(path):
+    """Read a sysfs file."""
     try:
         with open(path, 'r') as f:
             return f.readline().strip()
@@ -29,11 +29,11 @@ def read_addr_file(path):
         return "(enoent)"
 
 
-def write_addr_file(path, newaddr):
-    """Write a new address to an xprt address file."""
+def write_sysfs_file(path, input):
+    """Write 'input' to a sysfs file."""
     with open(path, 'w') as f:
-        f.write(newaddr)
-    return read_addr_file(path)
+        f.write(input)
+    return read_sysfs_file(path)
 
 
 def read_info_file(path):
@@ -56,8 +56,8 @@ class Xprt:
         self.name = path.stem.rsplit("-", 1)[0]
         self.type = path.stem.split("-")[2]
         self.info = read_info_file(path / "xprt_info")
-        self.dstaddr = read_addr_file(path / "dstaddr")
-        self.srcaddr = read_addr_file(path / "srcaddr")
+        self.dstaddr = read_sysfs_file(path / "dstaddr")
+        self.srcaddr = read_sysfs_file(path / "srcaddr")
         self.read_state()
 
     def __lt__(self, rhs):
@@ -106,7 +106,7 @@ class Xprt:
 
     def set_dstaddr(self, newaddr):
         """Change the dstaddr of an xprt."""
-        self.dstaddr = write_addr_file(self.path / "dstaddr", newaddr)
+        self.dstaddr = write_sysfs_file(self.path / "dstaddr", newaddr)
 
     def set_state(self, state):
         """Change the state of an xprt."""
Signature · 1 line
2.47.1
author maintainer
#9 lore raw

PATCH 9/10 rpcctl.py: Add support for the xprtsec sysfs attribute

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

This was recently added to the Linux kernel, so running rpcctl on kernels that don't have this attribute will print out "unknown" in its place instead.

---
 tools/rpcctl/rpcctl.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
tools/rpcctl/rpcctl.py +12 -1
index 654b2f60a894..20f90d6ca796 100755
@@ -36,6 +36,15 @@ def write_sysfs_file(path, input):
     return read_sysfs_file(path)
 
 
+def read_xprtsec_file(path):
+    """Read an xprtsec file."""
+    try:
+        with open(path, 'r') as f:
+            return f.readline().strip()
+    except FileNotFoundError:
+        return "(unknown)"
+
+
 def read_info_file(path):
     """Read an xprt or xprt switch information file."""
     res = collections.defaultdict(int)
@@ -58,6 +67,7 @@ class Xprt:
         self.info = read_info_file(path / "xprt_info")
         self.dstaddr = read_sysfs_file(path / "dstaddr")
         self.srcaddr = read_sysfs_file(path / "srcaddr")
+        self.xprtsec = read_xprtsec_file(path / "xprtsec")
         self.read_state()
 
     def __lt__(self, rhs):
@@ -67,7 +77,8 @@ class Xprt:
     def _xprt(self):
         main = ", main" if self.info.get("main_xprt") else ""
         return f"{self.name}: {self.type}, {self.dstaddr}, " \
-               f"port {self.info['dst_port']}, state <{self.state}>{main}"
+               f"port {self.info['dst_port']}, sec {self.xprtsec}, " \
+               f"state <{self.state}>{main}"
 
     def _src_reqs(self):
         return f"	Source: {self.srcaddr}, port {self.info['src_port']}, " \
Signature · 1 line
2.47.1
author maintainer
#10 lore raw

PATCH 10/10 rpcctl: Add support for `rpcctl switch add-xprt`

In reply to Anna Schumaker

From: Anna Schumaker <[email protected]>

This is used to add an xprt to the switch at runtime.

---
 tools/rpcctl/rpcctl.man |  4 ++++
 tools/rpcctl/rpcctl.py  | 11 +++++++++++
 2 files changed, 15 insertions(+)
tools/rpcctl/rpcctl.man +4 -0
index b87ba0df41c0..2ee168c8f3c5 100644
@@ -12,6 +12,7 @@ rpcctl \- Displays SunRPC connection information
 .BR "rpcctl client show " "\fR[ \fB\-h \f| \fB\-\-help \fR] [ \fIXPRT \fR]"
 .P
 .BR "rpcctl switch" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBset \fR| \fBshow \fR}"
+.BR "rpcctl switch add-xprt" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]"
 .BR "rpcctl switch set" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fISWITCH \fBdstaddr \fINEWADDR"
 .BR "rpcctl switch show" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]"
 .P
@@ -29,6 +30,9 @@ Show detailed information about the RPC clients on this system.
 If \fICLIENT \fRwas provided, then only show information about a single RPC client.
 .P
 .SS rpcctl switch \fR- \fBCommands operating on groups of transports
+.IP "\fBadd-xprt \fISWITCH"
+Add an aditional transport to the \fISWITCH\fR.
+Note that the new transport will take its values from the "main" transport.
 .IP "\fBset \fISWITCH \fBdstaddr \fINEWADDR"
 Change the destination address of all transports in the \fISWITCH \fRto \fINEWADDR\fR.
 \fINEWADDR \fRcan be an IP address, DNS name, or anything else resolvable by \fBgethostbyname\fR(3).
tools/rpcctl/rpcctl.py +11 -0
index 20f90d6ca796..8722c259e909 100755
@@ -223,6 +223,12 @@ class XprtSwitch:
         parser.set_defaults(func=XprtSwitch.show, switch=None)
         subparser = parser.add_subparsers()
 
+        add = subparser.add_parser("add-xprt",
+                                   help="Add an xprt to the switch")
+        add.add_argument("switch", metavar="SWITCH", nargs=1,
+                         help="Name of a specific xprt switch to modify")
+        add.set_defaults(func=XprtSwitch.add_xprt)
+
         show = subparser.add_parser("show", help="Show xprt switches")
         show.add_argument("switch", metavar="SWITCH", nargs='?',
                           help="Name of a specific switch to show")
@@ -246,6 +252,11 @@ class XprtSwitch:
             return [XprtSwitch(xprt_switches / name)]
         return [XprtSwitch(f) for f in sorted(xprt_switches.iterdir())]
 
+    def add_xprt(args):
+        """Handle the `rpcctl switch add-xprt` command."""
+        for switch in XprtSwitch.get_by_name(args.switch[0]):
+            write_sysfs_file(switch.path / "xprt_switch_add_xprt", "1")
+
     def show(args):
         """Handle the `rpcctl switch show` command."""
         for switch in XprtSwitch.get_by_name(args.switch):
Signature · 1 line
2.47.1
#11 lore raw

Re: [PATCH NFS-UTILS 10/10] rpcctl: Add support for `rpcctl switch add-xprt`

Hey Anna,

Quoted 51 lines · Anna Schumaker

From: Anna Schumaker <[email protected]>

This is used to add an xprt to the switch at runtime.

---
  tools/rpcctl/rpcctl.man |  4 ++++
  tools/rpcctl/rpcctl.py  | 11 +++++++++++
  2 files changed, 15 insertions(+)
tools/rpcctl/rpcctl.man +4 -0
index b87ba0df41c0..2ee168c8f3c5 100644
@@ -12,6 +12,7 @@ rpcctl \- Displays SunRPC connection information
  .BR "rpcctl client show " "\fR[ \fB\-h \f| \fB\-\-help \fR] [ \fIXPRT \fR]"
  .P
  .BR "rpcctl switch" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBset \fR| \fBshow \fR}"
+.BR "rpcctl switch add-xprt" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]"
  .BR "rpcctl switch set" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fISWITCH \fBdstaddr \fINEWADDR"
  .BR "rpcctl switch show" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]"
  .P
@@ -29,6 +30,9 @@ Show detailed information about the RPC clients on this system.
  If \fICLIENT \fRwas provided, then only show information about a single RPC client.
  .P
  .SS rpcctl switch \fR- \fBCommands operating on groups of transports
+.IP "\fBadd-xprt \fISWITCH"
+Add an aditional transport to the \fISWITCH\fR.
+Note that the new transport will take its values from the "main" transport.
  .IP "\fBset \fISWITCH \fBdstaddr \fINEWADDR"
  Change the destination address of all transports in the \fISWITCH \fRto \fINEWADDR\fR.
  \fINEWADDR \fRcan be an IP address, DNS name, or anything else resolvable by \fBgethostbyname\fR(3).
tools/rpcctl/rpcctl.py +6 -0
index 20f90d6ca796..8722c259e909 100755
@@ -223,6 +223,12 @@ class XprtSwitch:
          parser.set_defaults(func=XprtSwitch.show, switch=None)
          subparser = parser.add_subparsers()
 
+        add = subparser.add_parser("add-xprt",
+                                   help="Add an xprt to the switch")
+        add.add_argument("switch", metavar="SWITCH", nargs=1,
+                         help="Name of a specific xprt switch to modify")
+        add.set_defaults(func=XprtSwitch.add_xprt)
+
          show = subparser.add_parser("show", help="Show xprt switches")
          show.add_argument("switch", metavar="SWITCH", nargs='?',
                            help="Name of a specific switch to show")
@@ -246,6 +252,11 @@ class XprtSwitch:
              return [XprtSwitch(xprt_switches / name)]

tools/rpcctl/rpcctl.py class XprtSwitch: · line 262

Quoted 10 lines
tools/rpcctl/rpcctl.py +5 -0
          return [XprtSwitch(f) for f in sorted(xprt_switches.iterdir())]
 
+    def add_xprt(args):
+        """Handle the `rpcctl switch add-xprt` command."""
+        for switch in XprtSwitch.get_by_name(args.switch[0]):
+            write_sysfs_file(switch.path / "xprt_switch_add_xprt", "1")
+
      def show(args):
          """Handle the `rpcctl switch show` command."""
          for switch in XprtSwitch.get_by_name(args.switch):

Quick Question... Is this patch dependent on the previous posted kernel patches (aka NFS & SUNRPC Sysfs Improvements)

steved.

#12 lore raw

Re: [PATCH NFS-UTILS 10/10] rpcctl: Add support for `rpcctl switch add-xprt`

Hi Steve,

Quoted 57 lines · Steve Dickson

Hey Anna,

Quoted 54 lines · Anna Schumaker

From: Anna Schumaker <[email protected]>

This is used to add an xprt to the switch at runtime.

---
  tools/rpcctl/rpcctl.man |  4 ++++
  tools/rpcctl/rpcctl.py  | 11 +++++++++++

  2 files changed, 15 insertions(+)
tools/rpcctl/rpcctl.man +0 -0
index b87ba0df41c0..2ee168c8f3c5 100644
@@ -12,6 +12,7 @@ rpcctl \- Displays SunRPC connection information

  .BR "rpcctl client show " "\fR[ \fB\-h \f| \fB\-\-help \fR] [ \fIXPRT \fR]" .P
  .BR "rpcctl switch" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBset \fR| \fBshow \fR}" +.BR "rpcctl switch add-xprt" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]" .BR "rpcctl switch set" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fISWITCH \fBdstaddr \fINEWADDR" .BR "rpcctl switch show" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]" .P

tools/rpcctl/rpcctl.man +0 -0
@@ -29,6 +30,9 @@ Show detailed information about the RPC clients on this system.

  If \fICLIENT \fRwas provided, then only show information about a single RPC client. .P
  .SS rpcctl switch \fR- \fBCommands operating on groups of transports +.IP "\fBadd-xprt \fISWITCH"

tools/rpcctl/rpcctl.man +2 -0
+Add an aditional transport to the \fISWITCH\fR.
+Note that the new transport will take its values from the "main" transport.

  .IP "\fBset \fISWITCH \fBdstaddr \fINEWADDR"
  Change the destination address of all transports in the \fISWITCH \fRto \fINEWADDR\fR. \fINEWADDR \fRcan be an IP address, DNS name, or anything else resolvable by \fBgethostbyname\fR(3).

tools/rpcctl/rpcctl.py +5 -0
index 20f90d6ca796..8722c259e909 100755
@@ -223,6 +223,12 @@ class XprtSwitch:
           parser.set_defaults(func=XprtSwitch.show, switch=None)
           subparser = parser.add_subparsers()
   +        add = subparser.add_parser("add-xprt",
+                                   help="Add an xprt to the switch")
+        add.add_argument("switch", metavar="SWITCH", nargs=1,
+                         help="Name of a specific xprt switch to modify")
+        add.set_defaults(func=XprtSwitch.add_xprt)
+
           show = subparser.add_parser("show", help="Show xprt switches")
           show.add_argument("switch", metavar="SWITCH", nargs='?',
                             help="Name of a specific switch to show")
@@ -246,6 +252,11 @@ class XprtSwitch:

              return [XprtSwitch(xprt_switches / name)] return [XprtSwitch(f) for f in sorted(xprt_switches.iterdir())] +    def add_xprt(args):
+        """Handle the rpcctl switch add-xprt command."""
+        for switch in XprtSwitch.get_by_name(args.switch[0]):

Quoted 8 lines
Quoted 5 lines

+            write_sysfs_file(switch.path / "xprt_switch_add_xprt", "1") +
      def show(args):
          """Handle the rpcctl switch show command."""
          for switch in XprtSwitch.get_by_name(args.switch):

Quick Question... Is this patch dependent on the previous posted kernel patches (aka NFS & SUNRPC Sysfs Improvements)

Thanks for checking! Yes, these patches (especially the last two) are dependent on the kernel patches. I'm in the process of updating these for a v2 with the kernel stuff. If you would rather me split this up into cleanup patches and then new feature patches, I can definitely do that!

Thanks,
Anna

Quoted 3 lines

steved.

#13 lore raw

Re: [PATCH NFS-UTILS 10/10] rpcctl: Add support for `rpcctl switch add-xprt`

Quoted 69 lines · Anna Schumaker

Hi Steve,

Quoted 57 lines · Steve Dickson

Hey Anna,

Quoted 54 lines · Anna Schumaker

From: Anna Schumaker <[email protected]>

This is used to add an xprt to the switch at runtime.

---
   tools/rpcctl/rpcctl.man |  4 ++++
   tools/rpcctl/rpcctl.py  | 11 +++++++++++
   2 files changed, 15 insertions(+)
tools/rpcctl/rpcctl.man +4 -0
index b87ba0df41c0..2ee168c8f3c5 100644
@@ -12,6 +12,7 @@ rpcctl \- Displays SunRPC connection information
   .BR "rpcctl client show " "\fR[ \fB\-h \f| \fB\-\-help \fR] [ \fIXPRT \fR]"
   .P
   .BR "rpcctl switch" " \fR[ \fB\-h \fR| \fB\-\-help \fR] { \fBset \fR| \fBshow \fR}"
+.BR "rpcctl switch add-xprt" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]"
   .BR "rpcctl switch set" " \fR[ \fB\-h \fR| \fB\-\-help \fR] \fISWITCH \fBdstaddr \fINEWADDR"
   .BR "rpcctl switch show" " \fR[ \fB\-h \fR| \fB\-\-help \fR] [ \fISWITCH \fR]"
   .P
@@ -29,6 +30,9 @@ Show detailed information about the RPC clients on this system.
   If \fICLIENT \fRwas provided, then only show information about a single RPC client.
   .P
   .SS rpcctl switch \fR- \fBCommands operating on groups of transports
+.IP "\fBadd-xprt \fISWITCH"
+Add an aditional transport to the \fISWITCH\fR.
+Note that the new transport will take its values from the "main" transport.
   .IP "\fBset \fISWITCH \fBdstaddr \fINEWADDR"
   Change the destination address of all transports in the \fISWITCH \fRto \fINEWADDR\fR.
   \fINEWADDR \fRcan be an IP address, DNS name, or anything else resolvable by \fBgethostbyname\fR(3).
tools/rpcctl/rpcctl.py +7 -0
index 20f90d6ca796..8722c259e909 100755
@@ -223,6 +223,12 @@ class XprtSwitch:
           parser.set_defaults(func=XprtSwitch.show, switch=None)
           subparser = parser.add_subparsers()
   +        add = subparser.add_parser("add-xprt",
+                                   help="Add an xprt to the switch")
+        add.add_argument("switch", metavar="SWITCH", nargs=1,
+                         help="Name of a specific xprt switch to modify")
+        add.set_defaults(func=XprtSwitch.add_xprt)
+
           show = subparser.add_parser("show", help="Show xprt switches")
           show.add_argument("switch", metavar="SWITCH", nargs='?',
                             help="Name of a specific switch to show")
@@ -246,6 +252,11 @@ class XprtSwitch:
               return [XprtSwitch(xprt_switches / name)]
           return [XprtSwitch(f) for f in sorted(xprt_switches.iterdir())]
   +    def add_xprt(args):
+        """Handle the `rpcctl switch add-xprt` command."""
+        for switch in XprtSwitch.get_by_name(args.switch[0]):
Quoted 8 lines

tools/rpcctl/rpcctl.py class XprtSwitch: · line 262

Quoted 5 lines
tools/rpcctl/rpcctl.py +2 -0
+            write_sysfs_file(switch.path / "xprt_switch_add_xprt", "1")
+
       def show(args):
           """Handle the `rpcctl switch show` command."""
           for switch in XprtSwitch.get_by_name(args.switch):

Quick Question... Is this patch dependent on the previous posted kernel patches (aka NFS & SUNRPC Sysfs Improvements)

Quoted 1 line

Thanks for checking! Yes, these patches (especially the last two) are dependent on the kernel patches. I'm in the process of updating these for a v2 with the kernel stuff. If you would rather me split this up into cleanup patches and then new feature patches, I can definitely do that!

Please do! Thanks!!

steved.

Quoted 8 lines

Thanks,
Anna

Quoted 3 lines

steved.