Skip to contentSkip to conversation

NFSD: Remove open coding of string copy

PATCH In review Azeem Shaikh 4 participants 6 messages May 15, 2023 – May 16, 2023

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

PATCH v3 1/1 NFSD: Remove open coding of string copy

Instead of open coding a __dynamic_array(), use the __string() and __assign_str() helper macros that exist for this kind of use case.

Part of an effort to remove deprecated strlcpy() [1] completely from the kernel[2].

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

Fixes 3c92fba557c6 ("NFSD: Enhance the nfsd_cb_setup tracepoint")
---
 fs/nfsd/trace.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
fs/nfsd/trace.h +3 -3
index 4183819ea082..72a906a053dc 100644
@@ -1365,19 +1365,19 @@ TRACE_EVENT(nfsd_cb_setup,
 		__field(u32, cl_id)
 		__field(unsigned long, authflavor)
 		__sockaddr(addr, clp->cl_cb_conn.cb_addrlen)
-		__array(unsigned char, netid, 8)
+		__string(netid, netid)
 	),
 	TP_fast_assign(
 		__entry->cl_boot = clp->cl_clientid.cl_boot;
 		__entry->cl_id = clp->cl_clientid.cl_id;
-		strlcpy(__entry->netid, netid, sizeof(__entry->netid));
+		__assign_str(netid, netid);
 		__entry->authflavor = authflavor;
 		__assign_sockaddr(addr, &clp->cl_cb_conn.cb_addr,
 				  clp->cl_cb_conn.cb_addrlen)
 	),
 	TP_printk("addr=%pISpc client %08x:%08x proto=%s flavor=%s",
 		__get_sockaddr(addr), __entry->cl_boot, __entry->cl_id,
-		__entry->netid, show_nfsd_authflavor(__entry->authflavor))
+		__get_str(netid), show_nfsd_authflavor(__entry->authflavor))
 );
 
 TRACE_EVENT(nfsd_cb_setup_err,
Signature · 1 line
2.40.1.606.ga4b1b128d6-goog
maintainer Reviewed-by on v3 1/1
#1 lore raw
Quoted 32 lines · Azeem Shaikh

Instead of open coding a __dynamic_array(), use the __string() and __assign_str() helper macros that exist for this kind of use case.

Part of an effort to remove deprecated strlcpy() [1] completely from the kernel[2].

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

Fixes 3c92fba557c6 ("NFSD: Enhance the nfsd_cb_setup tracepoint")
---
 fs/nfsd/trace.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
fs/nfsd/trace.h +2 -2
index 4183819ea082..72a906a053dc 100644
@@ -1365,19 +1365,19 @@ TRACE_EVENT(nfsd_cb_setup,
 		__field(u32, cl_id)
 		__field(unsigned long, authflavor)
 		__sockaddr(addr, clp->cl_cb_conn.cb_addrlen)
-		__array(unsigned char, netid, 8)
+		__string(netid, netid)
 	),
 	TP_fast_assign(
 		__entry->cl_boot = clp->cl_clientid.cl_boot;
 		__entry->cl_id = clp->cl_clientid.cl_id;
-		strlcpy(__entry->netid, netid, sizeof(__entry->netid));
+		__assign_str(netid, netid);
 		__entry->authflavor = authflavor;

fs/nfsd/trace.h TRACE_EVENT(nfsd_cb_setup, · line 1383

Quoted 10 lines
fs/nfsd/trace.h +1 -1
 		__assign_sockaddr(addr, &clp->cl_cb_conn.cb_addr,
 				  clp->cl_cb_conn.cb_addrlen)
 	),
 	TP_printk("addr=%pISpc client %08x:%08x proto=%s flavor=%s",
 		__get_sockaddr(addr), __entry->cl_boot, __entry->cl_id,
-		__entry->netid, show_nfsd_authflavor(__entry->authflavor))
+		__get_str(netid), show_nfsd_authflavor(__entry->authflavor))
 );
 
 TRACE_EVENT(nfsd_cb_setup_err,
#2 lore raw
Quoted 8 lines · Jeff Layton
Quoted 6 lines · Azeem Shaikh

Instead of open coding a __dynamic_array(), use the __string() and __assign_str() helper macros that exist for this kind of use case.

Part of an effort to remove deprecated strlcpy() [1] completely from the kernel[2].

Quoted 6 lines
Quoted 6 lines

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

Fixes 3c92fba557c6 ("NFSD: Enhance the nfsd_cb_setup tracepoint")

---

v1 and v2 links for posterity.
v1: https://lore.kernel.org/all/[email protected]/
v2: https://lore.kernel.org/all/[email protected]/

Quoted 1 line

Thanks!

#3 lore raw
In reply to Azeem Shaikh

From: Azeem Shaikh

Quoted 4 lines

Sent: 15 May 2023 03:41

Instead of open coding a __dynamic_array(), use the __string() and __assign_str() helper macros that exist for this kind of use case.

Is this actually a dynamic array, or just a char[8] ? On 64 bit copying a short fixed-length string is far better than any kind of dynamic sized allocation.

David

Quoted 41 lines

Part of an effort to remove deprecated strlcpy() [1] completely from the kernel[2].

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

Fixes 3c92fba557c6 ("NFSD: Enhance the nfsd_cb_setup tracepoint")
---
 fs/nfsd/trace.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
fs/nfsd/trace.h +3 -4
index 4183819ea082..72a906a053dc 100644
@@ -1365,19 +1365,19 @@ TRACE_EVENT(nfsd_cb_setup,
 		__field(u32, cl_id)
 		__field(unsigned long, authflavor)
 		__sockaddr(addr, clp->cl_cb_conn.cb_addrlen)
-		__array(unsigned char, netid, 8)
+		__string(netid, netid)
 	),
 	TP_fast_assign(
 		__entry->cl_boot = clp->cl_clientid.cl_boot;
 		__entry->cl_id = clp->cl_clientid.cl_id;
-		strlcpy(__entry->netid, netid, sizeof(__entry->netid));
+		__assign_str(netid, netid);
 		__entry->authflavor = authflavor;
 		__assign_sockaddr(addr, &clp->cl_cb_conn.cb_addr,
 				  clp->cl_cb_conn.cb_addrlen)
 	),
 	TP_printk("addr=%pISpc client %08x:%08x proto=%s flavor=%s",
 		__get_sockaddr(addr), __entry->cl_boot, __entry->cl_id,
-		__entry->netid, show_nfsd_authflavor(__entry->authflavor))
+		__get_str(netid), show_nfsd_authflavor(__entry->authflavor))
 );
 
 TRACE_EVENT(nfsd_cb_setup_err,
--
Quoted 2 lines

2.40.1.606.ga4b1b128d6-goog

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)

#4 lore raw
Quoted 13 lines · David Laight

From: Azeem Shaikh

Quoted 4 lines

Sent: 15 May 2023 03:41

Instead of open coding a __dynamic_array(), use the __string() and __assign_str() helper macros that exist for this kind of use case.

Is this actually a dynamic array, or just a char[8] ? On 64 bit copying a short fixed-length string is far better than any kind of dynamic sized allocation.

I'd prefer to use a string helper, since the netid is a string, and this documents the data type better and it is not subject to sudden breakage if someone creates a standard netid longer than 8 characters.

The nfsd_cb_setup tracepoint is not in a performance-sensitive path.

In addition, trace consumers should be able to count on the string helpers to perform memory copies without overrunning either the source or destination buffers... one less source of error.

Quoted 41 lines

David

Quoted 39 lines

Part of an effort to remove deprecated strlcpy() [1] completely from the kernel[2].

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

Fixes 3c92fba557c6 ("NFSD: Enhance the nfsd_cb_setup tracepoint")

---
fs/nfsd/trace.h | 6 +++---

1 file changed, 3 insertions(+), 3 deletions(-)
fs/nfsd/trace.h +1 -1
index 4183819ea082..72a906a053dc 100644
@@ -1365,19 +1365,19 @@ TRACE_EVENT(nfsd_cb_setup,
 __field(u32, cl_id)
 __field(unsigned long, authflavor)
 __sockaddr(addr, clp->cl_cb_conn.cb_addrlen)
- __array(unsigned char, netid, 8)
+ __string(netid, netid)
 ),

TP_fast_assign(
__entry->cl_boot = clp->cl_clientid.cl_boot; __entry->cl_id = clp->cl_clientid.cl_id;
- strlcpy(__entry->netid, netid, sizeof(__entry->netid));
+ __assign_str(netid, netid);
__entry->authflavor = authflavor; __assign_sockaddr(addr, &clp->cl_cb_conn.cb_addr,
clp->cl_cb_conn.cb_addrlen)
),
TP_printk("addr=%pISpc client %08x:%08x proto=%s flavor=%s", __get_sockaddr(addr), __entry->cl_boot, __entry->cl_id,
- __entry->netid, show_nfsd_authflavor(__entry->authflavor))
+ __get_str(netid), show_nfsd_authflavor(__entry->authflavor)) );

Quoted 8 lines
Quoted 4 lines

TRACE_EVENT(nfsd_cb_setup_err,
--
2.40.1.606.ga4b1b128d6-goog

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)

--
Chuck Lever

#5 lore raw

From: Chuck Lever III

Quoted 19 lines

Sent: 16 May 2023 15:11

Quoted 11 lines · David Laight

From: Azeem Shaikh

Quoted 4 lines

Sent: 15 May 2023 03:41

Instead of open coding a __dynamic_array(), use the __string() and __assign_str() helper macros that exist for this kind of use case.

Is this actually a dynamic array, or just a char[8] ? On 64 bit copying a short fixed-length string is far better than any kind of dynamic sized allocation.

I'd prefer to use a string helper, since the netid is a string, and this documents the data type better and it is not subject to sudden breakage if someone creates a standard netid longer than 8 characters.

Quoted 7 lines

The nfsd_cb_setup tracepoint is not in a performance-sensitive path.

In addition, trace consumers should be able to count on the string helpers to perform memory copies without overrunning either the source or destination buffers... one less source of error.

That is an entirely different justification :-)

David

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)