Received-SPF: pass (google.com: domain of linux-nfs-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <ed02b06f96eeeca4d499583f2bdf31a433921aa1.camel@kernel.org>
Subject: Re: [PATCH] NFSD: add version field to nfsd_rpc_status_show handler
From:   Jeff Layton <jlayton@kernel.org>
To:     Chuck Lever <chuck.lever@oracle.com>
Cc:     NeilBrown <neilb@suse.de>, Lorenzo Bianconi <lorenzo@kernel.org>,
        linux-nfs@vger.kernel.org, lorenzo.bianconi@redhat.com
Date:   Tue, 08 Aug 2023 10:20:44 -0400
In-Reply-To: <ZNJLQIxweTaEsu16@tissot.1015granger.net>
References: <6431d0ea2295a1e128f83cd76a419dee161e4c44.1691482815.git.lorenzo@kernel.org>
         <169149440399.32308.1010201101079709026@noble.neil.brown.name>
         <ZNJCIRjI64YIY+I0@tissot.1015granger.net>
         <ea598236b2da9f1aa9b587ca797afaa9de5545c7.camel@kernel.org>
         <ZNJLQIxweTaEsu16@tissot.1015granger.net>
Content-Type: text/plain; charset="ISO-8859-15"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.48.4 (3.48.4-1.fc38) 
MIME-Version: 1.0
Precedence: bulk

On Tue, 2023-08-08 at 10:03 -0400, Chuck Lever wrote:
> On Tue, Aug 08, 2023 at 09:48:42AM -0400, Jeff Layton wrote:
> > On Tue, 2023-08-08 at 09:24 -0400, Chuck Lever wrote:
> > > On Tue, Aug 08, 2023 at 09:33:23PM +1000, NeilBrown wrote:
> > > > On Tue, 08 Aug 2023, Lorenzo Bianconi wrote:
> > > > > Introduce version field to nfsd_rpc_status handler in order to he=
lp
> > > > > the user to maintain backward compatibility.
> > > >=20
> > > > I wonder if this really helps.  What do I do if I see a version tha=
t I
> > > > don't understand?  Ignore the whole file?  That doesn't make for a =
good
> > > > user experience.
> > >=20
> > > There is no UX consideration here. A user browsing the file directly
> > > will not care about the version.
> > >=20
> > > This file is intended to be parsable by scripts and they have to
> > > keep up with the occasional changes in format. Scripts can handle an
> > > unrecogized version however they like.
> > >=20
> > > This is what we typically get with a made-up format that isn't .ini
> > > or JSON or XML. The file format isn't self-documenting. The final
> > > field on each row is a variable number of tokens, so it will be
> > > nearly impossible to simply add another field without breaking
> > > something.
> > >=20
> >=20
> > It shouldn't be a variable number of tokens per line.
>=20
> That's how NFSv4 COMPOUND operations are displayed. For example:
>=20
> 0x5d58666f 0x000000d1 0x000186a3 NFSv4 COMPOUND 0000062034739371 192.168.=
103.67 0 192.168.103.56 20049 OP_SEQUENCE OP_PUTFH OP_READ
>=20
> The list of operations in the displayed compound are currently
> blank-separated tokens at the end of each row.
>=20

Oh! That's a bug in missed in my latest review then. The operations
field was delimited by ':' chars at one point. Lorenzo, did you mean to
change that?

IMO, the list of operations should be one field, separated by a distinct
delimiter (like ':').

>=20
> > If there is, then that's a bug, IMO. We do want it to be simple to
> > just add a new field, published version info notwithstanding.
>=20
> They could be wrapped in curly braces, or separated by commas, to
> make them all one token.
>=20
> I haven't looked at NFSv3 output yet, but I expect those extra
> tokens won't even be there in that case.
>=20

That's probably another bug. Anything not a v4 COMPOUND should have
something as a placeholder. It could just be a single '-' character.

> JSON, yaml, or xml would all address the extensibility problem, just
> as an alternative thought.
>=20

It would probably be fairly simple to output well-formed yaml instead.
JSON and XML are a bit more of a pain.

For now, we can change the output. We do need to have this settled
before this goes to Linus' tree though.
--=20
Jeff Layton <jlayton@kernel.org>