netdev - Re: [PATCH v12 04/26] Documentation: document netlink ULP_DDP

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Sat, 15 Jul 2023 11:17:55 +0100
From: Simon Horman <simon.horman@...igine.com>
To: Aurelien Aptel <aaptel@...dia.com>
Cc: linux-nvme@...ts.infradead.org, netdev@...r.kernel.org,
	sagi@...mberg.me, hch@....de, kbusch@...nel.org, axboe@...com,
	chaitanyak@...dia.com, davem@...emloft.net, kuba@...nel.org,
	aurelien.aptel@...il.com, smalin@...dia.com, malin1024@...il.com,
	ogerlitz@...dia.com, yorayz@...dia.com, borisp@...dia.com,
	galshalom@...dia.com, mgurtovoy@...dia.com
Subject: Re: [PATCH v12 04/26] Documentation: document netlink
 ULP_DDP_GET/SET messages

On Wed, Jul 12, 2023 at 04:14:51PM +0000, Aurelien Aptel wrote:
> Add detailed documentation about:
> - ETHTOOL_MSG_ULP_DDP_GET and ETHTOOL_MSG_ULP_DDP_SET netlink messages
> - ETH_SS_ULP_DDP_CAPS and ETH_SS_ULP_DDP_STATS stringsets
> 
> ETHTOOL_MSG_ULP_DDP_GET/SET messages are used to configure ULP DDP
> capabilities and retrieve ULP DDP statistics.
> 
> Both statistics and capabilities names can be retrieved dynamically
> from the kernel via string sets (no need to hardcode them and keep
> them in sync in ethtool).
> 
> Signed-off-by: Shai Malin <smalin@...dia.com>
> Signed-off-by: Aurelien Aptel <aaptel@...dia.com>

...

> diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
> index 2540c70952ff..8ffca8ae9bbd 100644
> --- a/Documentation/networking/ethtool-netlink.rst
> +++ b/Documentation/networking/ethtool-netlink.rst

...

> +ULP DDP statistics content:
> +
> +  =====================================================  ===  ===============
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_SK_ADD``         u64  sockets successfully prepared for offloading
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_SK_ADD_FAIL``    u64  sockets that failed to be prepared for offloading
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_SK_DEL``         u64  sockets where offloading has been removed
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_DDP_SETUP``      u64  PDUs successfully prepared for Direct Data Placement
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_DDP_SETUP_FAIL`` u64  PDUs that failed DDP preparation
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_DDP_TEARDOWN``   u64  PDUs done with DDP
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_DROP``           u64  PDUs dropped
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_RESYNC``         u64  resync
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_PACKETS``        u64  offloaded PDUs
> +  ``ETHTOOL_A_ULP_DDP_STATS_RX_NVMEOTCP_BYTES``          u64  offloaded bytes
> +  =====================================================  ===  ===============
> +
> +The names of each statistics are global. They can be retrieved via the
> +``ETH_SS_ULP_DDP_STATS`` string set.

'make htmldocs' seems a bit unhappy about the table above.

  .../ethtool-netlink.rst:2038: WARNING: Malformed table.
  Text in column margin in table line 6.