Commit 6b4756be authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'ethtool_puts' 

Justin Stitt says:

====================
ethtool: Add ethtool_puts()

This series aims to implement ethtool_puts() and send out a wave 1 of
conversions from ethtool_sprintf(). There's also a checkpatch patch
included to check for the cases listed below.

This was sparked from recent discussion here [1]

The conversions are used in cases where ethtool_sprintf() was being used
with just two arguments:
|       ethtool_sprintf(&data, buffer[i].name);
or when it's used with format string: "%s"
|       ethtool_sprintf(&data, "%s", buffer[i].name);
which both now become:
|       ethtool_puts(&data, buffer[i].name);

The first case commonly triggers a -Wformat-security warning with Clang
due to potential problems with format flags present in the strings [3].

The second is just a bit weird with a plain-ol' "%s".

Changes found with Cocci [4] and grep [5].

[1]: https://lore.kernel.org/all/202310141935.B326C9E@keescook/
[2]: https://lore.kernel.org/all/?q=dfb%3Aethtool_sprintf+AND+f%3Ajustinstitt
[3]: https://lore.kernel.org/all/202310101528.9496539BE@keescook/


[4]: (script authored by Kees w/ modifications from Joe)
@replace_2_args@
expression BUF;
expression VAR;
@@

-       ethtool_sprintf(BUF, VAR)
+       ethtool_puts(BUF, VAR)

@replace_3_args@
expression BUF;
expression VAR;
@@

-       ethtool_sprintf(BUF, "%s", VAR)
+       ethtool_puts(BUF, VAR)

-       ethtool_sprintf(&BUF, "%s", VAR)
+       ethtool_puts(&BUF, VAR)

[5]: $ rg "ethtool_sprintf\(\s*[^,)]+\s*,\s*[^,)]+\s*\)"

Signed-off-by: default avatarJustin Stitt <justinstitt@google.com>
---
Changes in v5:
- updated documentation to include info about the lack of a trailing newline
  (Thanks Russell)
- rebased onto mainline
- Link to v4: https://lore.kernel.org/r/20231102-ethtool_puts_impl-v4-0-14e1e9278496@google.com

Changes in v4:
- update documentation to match:
  https://lore.kernel.org/all/20231028192511.100001-1-andrew@lunn.ch/

- Link to v3: https://lore.kernel.org/r/20231027-ethtool_puts_impl-v3-0-3466ac679304@google.com

Changes in v3:
- fix force_speed_maps merge conflict + formatting (thanks Vladimir)
- rebase onto net-next (thanks Andrew, Vladimir)
- change subject (thanks Vladimir)
- fix checkpatch formatting + implementation (thanks Joe)
- Link to v2: https://lore.kernel.org/r/20231026-ethtool_puts_impl-v2-0-0d67cbdd0538@google.com

Changes in v2:
- wrap lines better in replacement (thanks Joe, Kees)
- add --fix to checkpatch (thanks Joe)
- clean up checkpatch formatting (thanks Joe, et al.)
- rebase against next
- Link to v1: https://lore.kernel.org/r/20231025-ethtool_puts_impl-v1-0-6a53a93d3b72@google.com


====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 09b48947 e403cfff

drivers/net/dsa/lantiq_gswip.c

+1 −1
Original line number Diff line number Diff line
@@ -1759,7 +1759,7 @@ static void gswip_get_strings(struct dsa_switch *ds, int port, u32 stringset, 
		return;



	for (i = 0; i < ARRAY_SIZE(gswip_rmon_cnt); i++)

		ethtool_sprintf(&data, "%s", gswip_rmon_cnt[i].name);

		ethtool_puts(&data, gswip_rmon_cnt[i].name);

}



static u32 gswip_bcm_ram_entry_read(struct gswip_priv *priv, u32 table,

drivers/net/dsa/mt7530.c

+1 −1
Original line number Diff line number Diff line
@@ -836,7 +836,7 @@ mt7530_get_strings(struct dsa_switch *ds, int port, u32 stringset, 
		return;



	for (i = 0; i < ARRAY_SIZE(mt7530_mib); i++)

		ethtool_sprintf(&data, "%s", mt7530_mib[i].name);

		ethtool_puts(&data, mt7530_mib[i].name);

}



static void

drivers/net/dsa/qca/qca8k-common.c

+1 −1
Original line number Diff line number Diff line
@@ -487,7 +487,7 @@ void qca8k_get_strings(struct dsa_switch *ds, int port, u32 stringset, 
		return;



	for (i = 0; i < priv->info->mib_count; i++)

		ethtool_sprintf(&data, "%s", ar8327_mib[i].name);

		ethtool_puts(&data, ar8327_mib[i].name);

}



void qca8k_get_ethtool_stats(struct dsa_switch *ds, int port,

drivers/net/dsa/realtek/rtl8365mb.c

+1 −1
Original line number Diff line number Diff line
@@ -1303,7 +1303,7 @@ static void rtl8365mb_get_strings(struct dsa_switch *ds, int port, u32 stringset 


	for (i = 0; i < RTL8365MB_MIB_END; i++) {

		struct rtl8365mb_mib_counter *mib = &rtl8365mb_mib_counters[i];

		ethtool_sprintf(&data, "%s", mib->name);

		ethtool_puts(&data, mib->name);

	}

}

drivers/net/dsa/realtek/rtl8366-core.c

+1 −1
Original line number Diff line number Diff line
@@ -401,7 +401,7 @@ void rtl8366_get_strings(struct dsa_switch *ds, int port, u32 stringset, 
		return;



	for (i = 0; i < priv->num_mib_counters; i++)

		ethtool_sprintf(&data, "%s", priv->mib_counters[i].name);

		ethtool_puts(&data, priv->mib_counters[i].name);

}

EXPORT_SYMBOL_GPL(rtl8366_get_strings);