diff mbox series

[v9,02/25] net/ethtool: add new stringset ETH_SS_ULP_DDP_{CAPS,STATS}

Message ID 20230117153535.1945554-3-aaptel@nvidia.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series nvme-tcp receive offloads | expand

Checks

Context Check Description
netdev/tree_selection success Guessed tree name to be net-next, async
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Series has a cover letter
netdev/patch_count fail Series longer than 15 patches (and no cover letter)
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 1887 this patch: 1887
netdev/cc_maintainers warning 10 maintainers not CCed: mailhol.vincent@wanadoo.fr edumazet@google.com linux@rempel-privat.de gal@nvidia.com andrew@lunn.ch johannes@sipsolutions.net pabeni@redhat.com lkp@intel.com gustavoars@kernel.org bagasdotme@gmail.com
netdev/build_clang success Errors and warnings before: 580 this patch: 580
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 1994 this patch: 1994
netdev/checkpatch warning CHECK: Please use a blank line after function/struct/union/enum declarations WARNING: line length of 82 exceeds 80 columns WARNING: line length of 84 exceeds 80 columns WARNING: line length of 85 exceeds 80 columns WARNING: line length of 87 exceeds 80 columns WARNING: line length of 89 exceeds 80 columns WARNING: line length of 97 exceeds 80 columns
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Aurelien Aptel Jan. 17, 2023, 3:35 p.m. UTC 
This commit exposes ULP DDP capability and statistics names to
userspace via netlink.

In order to support future ULP DDP capabilities and statistics without
having to change the netlink protocol (and userspace ethtool) we add
new string sets to let userspace dynamically fetch what the kernel
supports. This also allows drivers to return their own statistics.

* ETH_SS_ULP_DDP_CAPS stores names of ULP DDP capabilities
* ETH_SS_ULP_DDP_STATS stores names of ULP DDP statistics.

These stringsets will be used in later commits when implementing the
new ULP DDP GET/SET netlink messages.

We keep the convention of strset.c of having the static_assert()
right after the array declaration, despite the checkpatch warning.

Signed-off-by: Shai Malin <smalin@nvidia.com>
Signed-off-by: Aurelien Aptel <aaptel@nvidia.com>
---
 include/linux/ethtool.h      | 43 ++++++++++++++++++++++++++++++++++++
 include/uapi/linux/ethtool.h |  4 ++++
 net/ethtool/common.c         | 21 ++++++++++++++++++
 net/ethtool/common.h         |  2 ++
 net/ethtool/strset.c         | 11 +++++++++
 5 files changed, 81 insertions(+)

Comments

Jakub Kicinski Jan. 20, 2023, 2:36 a.m. UTC | #1 
On Tue, 17 Jan 2023 17:35:12 +0200 Aurelien Aptel wrote:
> +enum {
> +	ETH_ULP_DDP_RX_NVMEOTCP_SK_ADD,
> +	ETH_ULP_DDP_RX_NVMEOTCP_SK_ADD_FAIL,
> +	ETH_ULP_DDP_RX_NVMEOTCP_SK_DEL,
> +	ETH_ULP_DDP_RX_NVMEOTCP_DDP_SETUP,
> +	ETH_ULP_DDP_RX_NVMEOTCP_DDP_SETUP_FAIL,
> +	ETH_ULP_DDP_RX_NVMEOTCP_DDP_TEARDOWN,
> +	ETH_ULP_DDP_RX_NVMEOTCP_DROP,
> +	ETH_ULP_DDP_RX_NVMEOTCP_RESYNC,
> +	ETH_ULP_DDP_RX_NVMEOTCP_PACKETS,
> +	ETH_ULP_DDP_RX_NVMEOTCP_BYTES,
> +
> +	__ETH_ULP_DDP_STATS_CNT,
> +};

This should be in uAPI and used as attribute IDs.
Aurelien Aptel Jan. 23, 2023, 6:31 p.m. UTC | #2 
Jakub Kicinski <kuba@kernel.org> writes:
> This should be in uAPI and used as attribute IDs.

Following the discussion from [1] ("you can add the dynamic string set
if you like.") we deliberately did not expose the enum to userspace so
that ethtool doesn't have to be updated or recompiled to list newer
kernel ULP DDP statistics.

Should we change this approach?

1: https://lore.kernel.org/netdev/20230111204644.040d0a9d@kernel.org/
Jakub Kicinski Jan. 23, 2023, 10:32 p.m. UTC | #3 
On Mon, 23 Jan 2023 20:31:10 +0200 Aurelien Aptel wrote:
> Jakub Kicinski <kuba@kernel.org> writes:
> > This should be in uAPI and used as attribute IDs.  
> 
> Following the discussion from [1] ("you can add the dynamic string set
> if you like.") we deliberately did not expose the enum to userspace so
> that ethtool doesn't have to be updated or recompiled to list newer
> kernel ULP DDP statistics.
> 
> Should we change this approach?
> 
> 1: https://lore.kernel.org/netdev/20230111204644.040d0a9d@kernel.org/

Not at all, but the names are really mostly for human consumption.
If any programmer wants to use the stats (and assuming they use C/C++)
it will be more convenient for them to use attribute ids from the enum.
Without having to resolve them using stat names.

This is how other stats are implemented in ethtool-netlink.
Aurelien Aptel Jan. 24, 2023, 12:04 p.m. UTC | #4 
Jakub Kicinski <kuba@kernel.org> writes:
> Not at all, but the names are really mostly for human consumption.
> If any programmer wants to use the stats (and assuming they use C/C++)
> it will be more convenient for them to use attribute ids from the enum.
> Without having to resolve them using stat names.
>
> This is how other stats are implemented in ethtool-netlink.

Ok, we will expose the enum to uAPI.

Thanks
diff mbox series

Patch

diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h
index 20d197693d34..1783a4402686 100644
--- a/include/linux/ethtool.h
+++ b/include/linux/ethtool.h
@@ -477,6 +477,49 @@  struct ethtool_module_power_mode_params {
 	enum ethtool_module_power_mode mode;
 };
 
+/**
+ * struct ethtool_ulp_ddp_stats - ULP DDP offload statistics
+ * @rx_nvmeotcp_sk_add: number of sockets successfully prepared for offloading.
+ * @rx_nvmeotcp_sk_add_fail: number of sockets that failed to be prepared for offloading.
+ * @rx_nvmeotcp_sk_del: number of sockets where offloading has been removed.
+ * @rx_nvmeotcp_ddp_setup: number of NVMeTCP PDU successfully prepared for Direct Data Placement.
+ * @rx_nvmeotcp_ddp_setup_fail: number of PDUs that failed DDP preparation.
+ * @rx_nvmeotcp_ddp_teardown: number of PDUs done with DDP.
+ * @rx_nvmeotcp_drop: number of PDUs dropped.
+ * @rx_nvmeotcp_resync: number of resync.
+ * @rx_nvmeotcp_packets: number of offloaded PDUs.
+ * @rx_nvmeotcp_bytes: number of offloaded bytes.
+ */
+struct ethtool_ulp_ddp_stats {
+	u64 rx_nvmeotcp_sk_add;
+	u64 rx_nvmeotcp_sk_add_fail;
+	u64 rx_nvmeotcp_sk_del;
+	u64 rx_nvmeotcp_ddp_setup;
+	u64 rx_nvmeotcp_ddp_setup_fail;
+	u64 rx_nvmeotcp_ddp_teardown;
+	u64 rx_nvmeotcp_drop;
+	u64 rx_nvmeotcp_resync;
+	u64 rx_nvmeotcp_packets;
+	u64 rx_nvmeotcp_bytes;
+
+	/* Remember to update the enum below when changing this struct */
+};
+
+enum {
+	ETH_ULP_DDP_RX_NVMEOTCP_SK_ADD,
+	ETH_ULP_DDP_RX_NVMEOTCP_SK_ADD_FAIL,
+	ETH_ULP_DDP_RX_NVMEOTCP_SK_DEL,
+	ETH_ULP_DDP_RX_NVMEOTCP_DDP_SETUP,
+	ETH_ULP_DDP_RX_NVMEOTCP_DDP_SETUP_FAIL,
+	ETH_ULP_DDP_RX_NVMEOTCP_DDP_TEARDOWN,
+	ETH_ULP_DDP_RX_NVMEOTCP_DROP,
+	ETH_ULP_DDP_RX_NVMEOTCP_RESYNC,
+	ETH_ULP_DDP_RX_NVMEOTCP_PACKETS,
+	ETH_ULP_DDP_RX_NVMEOTCP_BYTES,
+
+	__ETH_ULP_DDP_STATS_CNT,
+};
+
 /**
  * struct ethtool_ops - optional netdev operations
  * @cap_link_lanes_supported: indicates if the driver supports lanes
diff --git a/include/uapi/linux/ethtool.h b/include/uapi/linux/ethtool.h
index 6389953c32cf..cf26c082b1fc 100644
--- a/include/uapi/linux/ethtool.h
+++ b/include/uapi/linux/ethtool.h
@@ -681,6 +681,8 @@  enum ethtool_link_ext_substate_module {
  * @ETH_SS_STATS_ETH_MAC: names of IEEE 802.3 MAC statistics
  * @ETH_SS_STATS_ETH_CTRL: names of IEEE 802.3 MAC Control statistics
  * @ETH_SS_STATS_RMON: names of RMON statistics
+ * @ETH_SS_ULP_DDP_CAPS: names of ULP DDP capabilities
+ * @ETH_SS_ULP_DDP_STATS: per-device names of ULP DDP statistics
  *
  * @ETH_SS_COUNT: number of defined string sets
  */
@@ -706,6 +708,8 @@  enum ethtool_stringset {
 	ETH_SS_STATS_ETH_MAC,
 	ETH_SS_STATS_ETH_CTRL,
 	ETH_SS_STATS_RMON,
+	ETH_SS_ULP_DDP_CAPS,
+	ETH_SS_ULP_DDP_STATS,
 
 	/* add new constants above here */
 	ETH_SS_COUNT
diff --git a/net/ethtool/common.c b/net/ethtool/common.c
index 5fb19050991e..f79e510d671e 100644
--- a/net/ethtool/common.c
+++ b/net/ethtool/common.c
@@ -5,6 +5,7 @@ 
 #include <linux/phy.h>
 #include <linux/rtnetlink.h>
 #include <linux/ptp_clock_kernel.h>
+#include <net/ulp_ddp_caps.h>
 
 #include "common.h"
 
@@ -465,6 +466,26 @@  const char udp_tunnel_type_names[][ETH_GSTRING_LEN] = {
 static_assert(ARRAY_SIZE(udp_tunnel_type_names) ==
 	      __ETHTOOL_UDP_TUNNEL_TYPE_CNT);
 
+const char ulp_ddp_caps_names[][ETH_GSTRING_LEN] = {
+	[ULP_DDP_C_NVME_TCP_BIT]		= "nvme-tcp-ddp",
+	[ULP_DDP_C_NVME_TCP_DDGST_RX_BIT]	= "nvme-tcp-ddgst-rx-offload",
+};
+static_assert(ARRAY_SIZE(ulp_ddp_caps_names) == ULP_DDP_C_COUNT);
+
+const char ulp_ddp_stats_names[][ETH_GSTRING_LEN] = {
+	[ETH_ULP_DDP_RX_NVMEOTCP_SK_ADD]		= "rx_nvmeotcp_sk_add",
+	[ETH_ULP_DDP_RX_NVMEOTCP_SK_ADD_FAIL]		= "rx_nvmeotcp_sk_add_fail",
+	[ETH_ULP_DDP_RX_NVMEOTCP_SK_DEL]		= "rx_nvmeotcp_sk_del",
+	[ETH_ULP_DDP_RX_NVMEOTCP_DDP_SETUP]		= "rx_nvmeotcp_ddp_setup",
+	[ETH_ULP_DDP_RX_NVMEOTCP_DDP_SETUP_FAIL]	= "rx_nvmeotcp_ddp_setup_fail",
+	[ETH_ULP_DDP_RX_NVMEOTCP_DDP_TEARDOWN]		= "rx_nvmeotcp_ddp_teardown",
+	[ETH_ULP_DDP_RX_NVMEOTCP_DROP]			= "rx_nvmeotcp_drop",
+	[ETH_ULP_DDP_RX_NVMEOTCP_RESYNC]		= "rx_nvmeotcp_resync",
+	[ETH_ULP_DDP_RX_NVMEOTCP_PACKETS]		= "rx_nvmeotcp_packets",
+	[ETH_ULP_DDP_RX_NVMEOTCP_BYTES]			= "rx_nvmeotcp_bytes",
+};
+static_assert(ARRAY_SIZE(ulp_ddp_stats_names) == __ETH_ULP_DDP_STATS_CNT);
+
 /* return false if legacy contained non-0 deprecated fields
  * maxtxpkt/maxrxpkt. rest of ksettings always updated
  */
diff --git a/net/ethtool/common.h b/net/ethtool/common.h
index b1b9db810eca..6f71ee24c786 100644
--- a/net/ethtool/common.h
+++ b/net/ethtool/common.h
@@ -36,6 +36,8 @@  extern const char sof_timestamping_names[][ETH_GSTRING_LEN];
 extern const char ts_tx_type_names[][ETH_GSTRING_LEN];
 extern const char ts_rx_filter_names[][ETH_GSTRING_LEN];
 extern const char udp_tunnel_type_names[][ETH_GSTRING_LEN];
+extern const char ulp_ddp_caps_names[][ETH_GSTRING_LEN];
+extern const char ulp_ddp_stats_names[][ETH_GSTRING_LEN];
 
 int __ethtool_get_link(struct net_device *dev);
 
diff --git a/net/ethtool/strset.c b/net/ethtool/strset.c
index 3f7de54d85fb..2818e1f0687c 100644
--- a/net/ethtool/strset.c
+++ b/net/ethtool/strset.c
@@ -2,6 +2,7 @@ 
 
 #include <linux/ethtool.h>
 #include <linux/phy.h>
+#include <net/ulp_ddp_caps.h>
 #include "netlink.h"
 #include "common.h"
 
@@ -105,6 +106,16 @@  static const struct strset_info info_template[] = {
 		.count		= __ETHTOOL_A_STATS_RMON_CNT,
 		.strings	= stats_rmon_names,
 	},
+	[ETH_SS_ULP_DDP_CAPS] = {
+		.per_dev	= false,
+		.count		= ULP_DDP_C_COUNT,
+		.strings	= ulp_ddp_caps_names,
+	},
+	[ETH_SS_ULP_DDP_STATS] = {
+		.per_dev	= false,
+		.count		= __ETH_ULP_DDP_STATS_CNT,
+		.strings	= ulp_ddp_stats_names,
+	},
 };
 
 struct strset_req_info {