Skip to contentSkip to conversation

bnxt_en: address string truncation

PATCH Applied Simon Horman 3 participants 6 messages Aug 13, 2024 – Aug 15, 2024

Subsystems (3)
lore
Share & tools
lore

Simon Horman

author reviewer
#0 lore raw

v2 cover bnxt_en: address string truncation

Hi,

This series addresses several string truncation issues that are flagged by gcc-14. I do not have any reason to believe these are bugs, so I am targeting this at net-next and have not provided Fixes tags.

---
Changes in v2:
- Added patch:
+ bnxt_en: Extend maximum length of version string by 1 byte
- Dropped the following patches.
- bnxt_en: check for irq name truncation
- bnxt_en: check for fw_ver_str truncation
+ The approach I had taken was to return error on truncation, but the feedback I received was that it would be better to replace the last three bytes with "..." or some other similar scheme. While simple enough to implement, it does add some complexity, and I have so far been unable to convince myself that it is warranted. So I have decided to drop these patches for now.
- Link to v1: https://lore.kernel.org/r/[email protected]

---
Simon Horman (2):
bnxt_en: Extend maximum length of version string by 1 byte
bnxt_en: avoid truncation of per rx run debugfs filename

 drivers/net/ethernet/broadcom/bnxt/bnxt_debugfs.c | 4 ++--
 drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

base-commit: dd1bf9f9df156b43e5122f90d97ac3f59a1a5621

author reviewer
#1 lore raw

PATCH v2 1/2 bnxt_en: Extend maximum length of version string by 1 byte

This corrects an out-by-one error in the maximum length of the package version string. The size argument of snprintf includes space for the trailing '\0' byte, so there is no need to allow extra space for it by reducing the value of the size argument by 1.

Found by inspection.
Compile tested only.

---
v2: New patch

---
 drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/ethernet/broadcom/bnxt/bnxt_ethtool.c +1 -1
index 61d6afc3cacb..39eed5831e3a 100644
@@ -4161,7 +4161,7 @@ static void bnxt_get_pkgver(struct net_device *dev)
 
 	if (!bnxt_get_pkginfo(dev, buf, sizeof(buf))) {
 		len = strlen(bp->fw_ver_str);
-		snprintf(bp->fw_ver_str + len, FW_VER_STR_LEN - len - 1,
+		snprintf(bp->fw_ver_str + len, FW_VER_STR_LEN - len,
 			 "/pkg %s", buf);
 	}
 }
Signature · 1 line
2.43.0
maintainer Reviewed-by on v2 1/2
#2 lore raw

Re: [PATCH net-next v2 1/2] bnxt_en: Extend maximum length of version string by 1 byte

Quoted 10 lines · Simon Horman

This corrects an out-by-one error in the maximum length of the package version string. The size argument of snprintf includes space for the trailing '\0' byte, so there is no need to allow extra space for it by reducing the value of the size argument by 1.

Found by inspection.
Compile tested only.

Thanks.

author reviewer
#3 lore raw

PATCH v2 2/2 bnxt_en: avoid truncation of per rx run debugfs filename

In reply to Simon Horman

Although it seems unlikely in practice - there would need to be rx ring indexes greater than 10^10 - it is theoretically possible for the filename of per rx ring debugfs files to be truncated.

This is because although a 16 byte buffer is provided, the length of the filename is restricted to 10 bytes. Remove this restriction and allow the entire buffer to be used.

Also reduce the buffer to 12 bytes, which is sufficient.

Given that the range of rx ring indexes likely much smaller than the maximum range of a 32-bit signed integer, a smaller buffer could be used, with some further changes. But this change seems simple, robust, and has minimal stack overhead.

Flagged by gcc-14:

.../bnxt_debugfs.c: In function 'bnxt_debug_dev_init':
drivers/net/ethernet/broadcom/bnxt/bnxt_debugfs.c:69:30: warning: '%d' directive output may be truncated writing between 1 and 11 bytes into a region of size 10 [-Wformat-truncation=]

     69 |         snprintf(qname, 10, "%d", ring_idx);
        |                              ^~
  In function 'debugfs_dim_ring_init',
      inlined from 'bnxt_debug_dev_init' at .../bnxt_debugfs.c:87:4:
  .../bnxt_debugfs.c:69:29: note: directive argument in the range [-2147483643, 2147483646]
     69 |         snprintf(qname, 10, "%d", ring_idx);
        |                             ^~~~
  .../bnxt_debugfs.c:69:9: note: 'snprintf' output between 2 and 12 bytes into a destination of size 10
     69 |         snprintf(qname, 10, "%d", ring_idx);
        |         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Compile tested only

---
v2: No change

---
 drivers/net/ethernet/broadcom/bnxt/bnxt_debugfs.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/net/ethernet/broadcom/bnxt/bnxt_debugfs.c +2 -2
index 156c2404854f..127b7015f676 100644
@@ -64,9 +64,9 @@ static const struct file_operations debugfs_dim_fops = {
 static void debugfs_dim_ring_init(struct dim *dim, int ring_idx,
 				  struct dentry *dd)
 {
-	static char qname[16];
+	static char qname[12];
 
-	snprintf(qname, 10, "%d", ring_idx);
+	snprintf(qname, sizeof(qname), "%d", ring_idx);
 	debugfs_create_file(qname, 0600, dd, dim, &debugfs_dim_fops);
 }
 
Signature · 1 line
2.43.0
maintainer Reviewed-by on v2 2/2
#4 lore raw

Re: [PATCH net-next v2 2/2] bnxt_en: avoid truncation of per rx run debugfs filename

Quoted 31 lines · Simon Horman

Although it seems unlikely in practice - there would need to be rx ring indexes greater than 10^10 - it is theoretically possible for the filename of per rx ring debugfs files to be truncated.

This is because although a 16 byte buffer is provided, the length of the filename is restricted to 10 bytes. Remove this restriction and allow the entire buffer to be used.

Also reduce the buffer to 12 bytes, which is sufficient.

Given that the range of rx ring indexes likely much smaller than the maximum range of a 32-bit signed integer, a smaller buffer could be used, with some further changes. But this change seems simple, robust, and has minimal stack overhead.

Flagged by gcc-14:

.../bnxt_debugfs.c: In function 'bnxt_debug_dev_init':
drivers/net/ethernet/broadcom/bnxt/bnxt_debugfs.c:69:30: warning: '%d' directive output may be truncated writing between 1 and 11 bytes into a region of size 10 [-Wformat-truncation=]

     69 |         snprintf(qname, 10, "%d", ring_idx);
        |                              ^~
  In function 'debugfs_dim_ring_init',
      inlined from 'bnxt_debug_dev_init' at .../bnxt_debugfs.c:87:4:
  .../bnxt_debugfs.c:69:29: note: directive argument in the range [-2147483643, 2147483646]
     69 |         snprintf(qname, 10, "%d", ring_idx);
        |                             ^~~~
  .../bnxt_debugfs.c:69:9: note: 'snprintf' output between 2 and 12 bytes into a destination of size 10
     69 |         snprintf(qname, 10, "%d", ring_idx);
        |         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Quoted 3 lines

Compile tested only

Thanks.

#5 lore raw
In reply to Simon Horman
This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Hello:

This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Quoted 8 lines · On Tue, 13 Aug 2024 15:32:54 +0100 you wrote:

Hi,

This series addresses several string truncation issues that are flagged by gcc-14. I do not have any reason to believe these are bugs, so I am targeting this at net-next and have not provided Fixes tags.

[...]

Here is the summary with links:
- [net-next,v2,1/2] bnxt_en: Extend maximum length of version string by 1 byte

    https://git.kernel.org/netdev/net-next/c/ffff7ee843c3
  - [net-next,v2,2/2] bnxt_en: avoid truncation of per rx run debugfs filename
    https://git.kernel.org/netdev/net-next/c/1418e9ab3e2e

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html