Skip to contentSkip to conversation

Documentation: Fix sysfs path for the NFSv4 client identifier

PATCH In review Dave Wysochanski 2 participants 7 messages Nov 9, 2022 – Jan 23, 2023

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: Fix sysfs path for the NFSv4 client identifier

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")
---
 Documentation/filesystems/nfs/client-identifier.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +2 -2
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
       via the kernel command line, or when the "nfs" module is
       loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
       This virtual file, available since Linux 5.3, is local to the
       network namespace in which it is accessed and so can provide
       distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might
 be formed at boot using the container's internal identifier:
 
     sha256sum /etc/machine-id | awk '{print $1}' \\
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
 
 Security considerations
 -----------------------
Signature · 1 line
2.31.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 lines · Dave Wysochanski

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Seems like the redundancy has some purpose and is baked-in to the path. I'd rather leave the sleeping dog as it is, enjoying the morning sun.

Quoted 26 lines
Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")

---
Documentation/filesystems/nfs/client-identifier.rst | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +1 -1
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
      via the kernel command line, or when the "nfs" module is
      loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
      This virtual file, available since Linux 5.3, is local to the
      network namespace in which it is accessed and so can provide
      distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might

be formed at boot using the container's internal identifier:

    sha256sum /etc/machine-id | awk '{print $1}' \\
Documentation/filesystems/nfs/client-identifier.rst +1 -1
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
Quoted 5 lines

Security considerations
-----------------------

Signature · 1 line
2.31.1

--
Chuck Lever

#2 lore raw
Quoted 12 lines · Chuck Lever III
Quoted 11 lines · Dave Wysochanski

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Quoted 6 lines

Seems like the redundancy has some purpose and is baked-in to the path. I'd rather leave the sleeping dog as it is, enjoying the morning sun.

Hey Chuck,

I just realized the patch is still outstanding. Now when I re-read your comment, I'm not sure what it means. Your comment sounds like you feel the patch may not be necessary, but then you have a "Reviewed-by". I am not sure if you mean this should be applied or not.

To be clear, the existing sysfs path does not exist, and we got a complaint about this documentation inaccuracy, hence my patch.

Quoted 38 lines
Quoted 27 lines
Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")

---
Documentation/filesystems/nfs/client-identifier.rst | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +1 -1
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
      via the kernel command line, or when the "nfs" module is
      loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
      This virtual file, available since Linux 5.3, is local to the
      network namespace in which it is accessed and so can provide
      distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might

be formed at boot using the container's internal identifier:

    sha256sum /etc/machine-id | awk '{print $1}' \\
Documentation/filesystems/nfs/client-identifier.rst +1 -1
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
Quoted 5 lines

Security considerations
-----------------------
--
2.31.1

--
Chuck Lever

Reviewed-by means "OK to apply". The documentation is incorrect.
#3 lore raw

Hi DW -

Quoted 19 lines · David Wysochanski
Quoted 16 lines · Chuck Lever III
Quoted 11 lines · Dave Wysochanski

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Seems like the redundancy has some purpose and is baked-in to the path. I'd rather leave the sleeping dog as it is, enjoying the morning sun.

Quoted 8 lines
Quoted 2 lines

Hey Chuck,

I just realized the patch is still outstanding. Now when I re-read your comment, I'm not sure what it means. Your comment sounds like you feel the patch may not be necessary, but then you have a "Reviewed-by".

I was responding to Ben's suggestion elsewhere that the pathname had redundant components and should be simplified. After reviewing the code (and your patch) it appears that all the components are necessary to have, so the document change you proposed is appropriate.

Quoted 1 line

I am not sure if you mean this should be applied or not.

Reviewed-by means "OK to apply". The documentation is incorrect.
Quoted 2 lines

To be clear, the existing sysfs path does not exist, and we got a complaint about this documentation inaccuracy, hence my patch.

Can you dig up the complaint bug and suggest a Link: tag to add?

Quoted 26 lines
Quoted 26 lines
Quoted 26 lines
Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")

---
Documentation/filesystems/nfs/client-identifier.rst | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +1 -1
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
     via the kernel command line, or when the "nfs" module is
     loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
     This virtual file, available since Linux 5.3, is local to the
     network namespace in which it is accessed and so can provide
     distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might

be formed at boot using the container's internal identifier:

   sha256sum /etc/machine-id | awk '{print $1}' \\
Documentation/filesystems/nfs/client-identifier.rst +1 -1
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
Quoted 8 lines
Quoted 8 lines
Quoted 5 lines

Security considerations
-----------------------
--
2.31.1

--
Chuck Lever

--
Chuck Lever

#4 lore raw
Quoted 31 lines · Chuck Lever III

Hi DW -

Quoted 19 lines · David Wysochanski
Quoted 16 lines · Chuck Lever III
Quoted 11 lines · Dave Wysochanski

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Seems like the redundancy has some purpose and is baked-in to the path. I'd rather leave the sleeping dog as it is, enjoying the morning sun.

Quoted 8 lines
Quoted 2 lines

Hey Chuck,

I just realized the patch is still outstanding. Now when I re-read your comment, I'm not sure what it means. Your comment sounds like you feel the patch may not be necessary, but then you have a "Reviewed-by".

Quoted 6 lines

I was responding to Ben's suggestion elsewhere that the pathname had redundant components and should be simplified. After reviewing the code (and your patch) it appears that all the components are necessary to have, so the document change you proposed is appropriate.

Ah ok yes I remember now, thanks for explaining.

Quoted 5 lines
Quoted 2 lines

I am not sure if you mean this should be applied or not.

Reviewed-by means "OK to apply". The documentation is incorrect.

Ok.

Quoted 6 lines
Quoted 3 lines

To be clear, the existing sysfs path does not exist, and we got a complaint about this documentation inaccuracy, hence my patch.

Can you dig up the complaint bug and suggest a Link: tag to add?

It was such a small issue I was not planning to create a separate bug, but I can do so easily if you would like that.

The comment was a private comment that came later on in this bug, which you commented on a while back when there was discussion on how to generate a unique id.
https://bugzilla.redhat.com/show_bug.cgi?id=1801326#c45
The bug was repurposed to documentation only.

Quoted 41 lines
Quoted 27 lines
Quoted 27 lines
Quoted 27 lines
Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")

---
Documentation/filesystems/nfs/client-identifier.rst | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +1 -1
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
     via the kernel command line, or when the "nfs" module is
     loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
     This virtual file, available since Linux 5.3, is local to the
     network namespace in which it is accessed and so can provide
     distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might

be formed at boot using the container's internal identifier:

   sha256sum /etc/machine-id | awk '{print $1}' \\
Documentation/filesystems/nfs/client-identifier.rst +1 -1
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
Quoted 8 lines
Quoted 8 lines
Quoted 5 lines

Security considerations
-----------------------
--
2.31.1

--
Chuck Lever

--
Chuck Lever

#5 lore raw
Quoted 57 lines · David Wysochanski
Quoted 31 lines · Chuck Lever III

Hi DW -

Quoted 19 lines · David Wysochanski
Quoted 16 lines · Chuck Lever III
Quoted 11 lines · Dave Wysochanski

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Seems like the redundancy has some purpose and is baked-in to the path. I'd rather leave the sleeping dog as it is, enjoying the morning sun.

Quoted 8 lines
Quoted 2 lines

Hey Chuck,

I just realized the patch is still outstanding. Now when I re-read your comment, I'm not sure what it means. Your comment sounds like you feel the patch may not be necessary, but then you have a "Reviewed-by".

Quoted 6 lines

I was responding to Ben's suggestion elsewhere that the pathname had redundant components and should be simplified. After reviewing the code (and your patch) it appears that all the components are necessary to have, so the document change you proposed is appropriate.

Ah ok yes I remember now, thanks for explaining.

Quoted 5 lines
Quoted 2 lines

I am not sure if you mean this should be applied or not.

Reviewed-by means "OK to apply". The documentation is incorrect.

Ok.

Quoted 6 lines
Quoted 3 lines

To be clear, the existing sysfs path does not exist, and we got a complaint about this documentation inaccuracy, hence my patch.

Can you dig up the complaint bug and suggest a Link: tag to add?

Quoted 8 lines

It was such a small issue I was not planning to create a separate bug, but I can do so easily if you would like that.

The comment was a private comment that came later on in this bug, which you commented on a while back when there was discussion on how to generate a unique id.
https://bugzilla.redhat.com/show_bug.cgi?id=1801326#c45
The bug was repurposed to documentation only.

seems appropriate to me.

Quoted 35 lines
Quoted 35 lines
Quoted 34 lines
Quoted 34 lines
Quoted 26 lines
Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")

---
Documentation/filesystems/nfs/client-identifier.rst | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +1 -1
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
    via the kernel command line, or when the "nfs" module is
    loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
    This virtual file, available since Linux 5.3, is local to the
    network namespace in which it is accessed and so can provide
    distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might

be formed at boot using the container's internal identifier:

  sha256sum /etc/machine-id | awk '{print $1}' \\
Documentation/filesystems/nfs/client-identifier.rst +1 -1
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
Quoted 5 lines

Security considerations
-----------------------
--
2.31.1

--
Chuck Lever

Quoted 2 lines
Quoted 2 lines

--
Chuck Lever

--
Chuck Lever

#6 lore raw

PATCH 1/1 Documentation: Fix sysfs path for the NFSv4 client identifier

The sysfs path for the NFS4 client identfier should start with the path component of 'nfs' for the kset, and then the 'net' path component for the netns object, followed by the 'nfs_client' path component for the NFS client kobject, and ending with 'identifier' for the netns_client_id kobj_attribute.

Fixes a28faaddb2be ("Documentation: Add an explanation of NFSv4 client identifiers")
---
 Documentation/filesystems/nfs/client-identifier.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/filesystems/nfs/client-identifier.rst +2 -2
index 5147e15815a1..a94c7a9748d7 100644
@@ -152,7 +152,7 @@ string:
       via the kernel command line, or when the "nfs" module is
       loaded.
 
-    /sys/fs/nfs/client/net/identifier
+    /sys/fs/nfs/net/nfs_client/identifier
       This virtual file, available since Linux 5.3, is local to the
       network namespace in which it is accessed and so can provide
       distinction between network namespaces (containers) when the
@@ -164,7 +164,7 @@ then that uniquifier can be used. For example, a uniquifier might
 be formed at boot using the container's internal identifier:
 
     sha256sum /etc/machine-id | awk '{print $1}' \\
-        > /sys/fs/nfs/client/net/identifier
+        > /sys/fs/nfs/net/nfs_client/identifier
 
 Security considerations
 -----------------------
Signature · 1 line
2.31.1