Received-SPF: pass (google.com: domain of linux-nfs-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Sender: Anna Schumaker <schumakeranna@gmail.com>
From:   schumaker.anna@gmail.com
To:     steved@redhat.com, linux-nfs@vger.kernel.org
Cc:     Anna.Schumaker@Netapp.com
Subject: [PATCH v3 0/9] Add a tool for using the new sysfs files
Date:   Mon, 30 Aug 2021 11:56:44 -0400
Message-Id: <20210830155653.1386161-1-Anna.Schumaker@Netapp.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

From: Anna Schumaker <Anna.Schumaker@Netapp.com>

These patches implement a tool that can be used to read and write the
sysfs files, with subcommands! They do need my extra patches to add in
srcaddr and dst_port to the xprt_info file. Let me know if I need to
resend adding support for kernels both with and without these patches.

The following subcommands are implemented:
	nfssysfs.py rpc-client
 	nfssysfs.py xprt
 	nfssysfs.py xprt set
 	nfssysfs.py xprt-switch
 	nfssysfs.py xprt-switch set

So you can print out information about every xprt-switch with:
	anna@client ~ % nfssysfs xprt-switch
	switch 0: num_xprts 1, num_active 1, queue_len 0
		xprt 0: local, /var/run/gssproxy.sock [main]
	switch 1: num_xprts 1, num_active 1, queue_len 0
		xprt 1: local, /var/run/rpcbind.sock [main]
	switch 2: num_xprts 1, num_active 1, queue_len 0
		xprt 2: tcp, 192.168.111.1 [main]
	switch 3: num_xprts 4, num_active 4, queue_len 0
		xprt 3: tcp, 192.168.111.188 [main]
		xprt 4: tcp, 192.168.111.188
		xprt 5: tcp, 192.168.111.188
		xprt 6: tcp, 192.168.111.188

And information about each xprt:
	anna@client ~ % nfssysfs xprt       
	xprt 0: local, /var/run/gssproxy.sock, port 0, state <MAIN,CONNECTED,BOUND>
		Source: (einval), port 0, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	xprt 1: local, /var/run/rpcbind.sock, port 0, state <MAIN,CONNECTED,BOUND>
		Source: (einval), port 0, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	xprt 2: tcp, 192.168.111.1, port 2049, state <MAIN,CONNECTED,BOUND>
		Source: 192.168.111.222, port 959, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	xprt 3: tcp, 192.168.111.188, port 2049, state <MAIN,CONNECTED,BOUND>
		Source: 192.168.111.222, port 921, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	xprt 4: tcp, 192.168.111.188, port 2049, state <CONNECTED,BOUND>
		Source: 192.168.111.222, port 726, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	xprt 5: tcp, 192.168.111.188, port 2049, state <CONNECTED,BOUND>
		Source: 192.168.111.222, port 671, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	xprt 6: tcp, 192.168.111.188, port 2049, state <CONNECTED,BOUND>
		Source: 192.168.111.222, port 934, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0

You can use the `set` subcommand to change the dstaddr of individual xprts:
	anna@client ~ % sudo nfssysfs xprt --id 4 
	xprt 4: tcp, 192.168.111.188, port 2049, state <CONNECTED,BOUND>
		Source: 192.168.111.222, port 726, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0
	anna@client ~ % sudo nfssysfs xprt set --id 4 --dstaddr server2.nowheycreamery.com
	xprt 4: tcp, 192.168.111.186, port 2049, state <CONNECTED,BOUND>
		Source: 192.168.111.222, port 726, Requests: 2
		Congestion: cur 0, win 256, Slots: min 2, max 65536
		Queues: binding 0, sending 0, pending 0, backlog 0, tasks 0

Or for changing the dstaddr of all xprts attached to a switch:
	anna@client % ./nfssysfs.py xprt-switch --id 3
	switch 3: num_xprts 4, num_active 4, queue_len 0
		xprt 3: tcp, 192.168.111.188 [main]
		xprt 4: tcp, 192.168.111.188
		xprt 5: tcp, 192.168.111.188
		xprt 6: tcp, 192.168.111.188
	anna@client % sudo ./nfssysfs.py xprt-switch set --id 4 --dstaddr server2.nowheycreamery.vm
	switch 3: num_xprts 4, num_active 4, queue_len 0
		xprt 2: tcp, 192.168.111.186 [main]
		xprt 3: tcp, 192.168.111.186
		xprt 5: tcp, 192.168.111.186
		xprt 6: tcp, 192.168.111.186


One question I have is about the name right now. Is naming it "nfssysfs"
okay, or would it be better to name it "nfs" with "sysfs" as a
subcommand? Going with just "nfs" as the command name would allow us to
add other non-sysfs tools as subcommands in the future (such as `nfs stat`
to call `nfsstat`, or for new commands that would otherwise be prefixed
with "nfs")

Thoughts?
Anna


Anna Schumaker (9):
  nfssysfs: Add a nfssysfs.py tool
  nfssysfs.py: Add a command for printing xprt switch information
  nfssysfs.py: Add a command for printing individual xprts
  nfssysfs.py: Add a command for printing rpc-client information
  nfssysfs.py: Add a command for changing xprt dstaddr
  nfssysfs.py: Add a command for changing xprt-switch dstaddrs
  nfssysfs.py: Add a command for changing xprt state
  nfssysfs: Add a man page
  nfssysfs: Add installation to the Makefile

 .gitignore                  |   2 +
 configure.ac                |   1 +
 tools/Makefile.am           |   2 +-
 tools/nfssysfs/Makefile.am  |  20 +++++++
 tools/nfssysfs/client.py    |  27 ++++++++++
 tools/nfssysfs/nfssysfs     |   5 ++
 tools/nfssysfs/nfssysfs.man |  88 +++++++++++++++++++++++++++++++
 tools/nfssysfs/nfssysfs.py  |  23 ++++++++
 tools/nfssysfs/switch.py    |  51 ++++++++++++++++++
 tools/nfssysfs/sysfs.py     |  29 +++++++++++
 tools/nfssysfs/xprt.py      | 101 ++++++++++++++++++++++++++++++++++++
 11 files changed, 348 insertions(+), 1 deletion(-)
 create mode 100644 tools/nfssysfs/Makefile.am
 create mode 100644 tools/nfssysfs/client.py
 create mode 100644 tools/nfssysfs/nfssysfs
 create mode 100644 tools/nfssysfs/nfssysfs.man
 create mode 100755 tools/nfssysfs/nfssysfs.py
 create mode 100644 tools/nfssysfs/switch.py
 create mode 100644 tools/nfssysfs/sysfs.py
 create mode 100644 tools/nfssysfs/xprt.py

-- 
2.33.0