Netdev List
 help / color / mirror / Atom feed
From: Saeed Mahameed <saeedm@mellanox.com>
To: "David S. Miller" <davem@davemloft.net>
Cc: "netdev@vger.kernel.org" <netdev@vger.kernel.org>,
	Jakub Kicinski <jakub.kicinski@netronome.com>,
	Tariq Toukan <tariqt@mellanox.com>,
	Saeed Mahameed <saeedm@mellanox.com>
Subject: [net 9/9] Documentation: TLS: fix stat counters description
Date: Thu, 25 Jul 2019 20:36:52 +0000	[thread overview]
Message-ID: <20190725203618.11011-10-saeedm@mellanox.com> (raw)
In-Reply-To: <20190725203618.11011-1-saeedm@mellanox.com>

From: Tariq Toukan <tariqt@mellanox.com>

Add missing description of counters.
Split tx_tls_encrypted counter into two, to give packets
and bytes indications.

Fixes: f42c104f2ec9 ("Documentation: add TLS offload documentation")
Suggested-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: Tariq Toukan <tariqt@mellanox.com>
Signed-off-by: Saeed Mahameed <saeedm@mellanox.com>
---
 Documentation/networking/tls-offload.rst | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/Documentation/networking/tls-offload.rst b/Documentation/networking/tls-offload.rst
index 048e5ca44824..b70b70dc4524 100644
--- a/Documentation/networking/tls-offload.rst
+++ b/Documentation/networking/tls-offload.rst
@@ -424,13 +424,24 @@ Statistics
 Following minimum set of TLS-related statistics should be reported
 by the driver:
 
- * ``rx_tls_decrypted`` - number of successfully decrypted TLS segments
- * ``tx_tls_encrypted`` - number of in-order TLS segments passed to device
-   for encryption
+ * ``rx_tls_decrypted_packets`` - number of successfully decrypted RX packets
+   which were part of a TLS stream.
+ * ``rx_tls_decrypted_bytes`` - number of TLS payload bytes in RX packets
+   which were successfully decrypted.
+ * ``tx_tls_encrypted_packets`` - number of TX packets passed to the device
+   for encryption of their TLS payload.
+ * ``tx_tls_encrypted_bytes`` - number of TLS payload bytes in TX packets
+   passed to the device for encryption.
+ * ``tx_tls_ctx`` - number of TLS TX HW offload contexts added to device for
+   encryption.
  * ``tx_tls_ooo`` - number of TX packets which were part of a TLS stream
-   but did not arrive in the expected order
- * ``tx_tls_drop_no_sync_data`` - number of TX packets dropped because
-   they arrived out of order and associated record could not be found
+   but did not arrive in the expected order.
+ * ``tx_tls_drop_no_sync_data`` - number of TX packets which were part of
+   a TLS stream dropped, because they arrived out of order and associated
+   record could not be found.
+ * ``tx_tls_drop_bypass_req`` - number of TX packets which were part of a TLS
+   stream dropped, because they contain both data that has been encrypted by
+   software and data that expects hardware crypto offload.
 
 Notable corner cases, exceptions and additional requirements
 ============================================================
-- 
2.21.0


  parent reply	other threads:[~2019-07-25 20:37 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-25 20:36 [pull request][net 0/9] Mellanox, mlx5 fixes 2019-07-25 Saeed Mahameed
2019-07-25 20:36 ` [net 1/9] net/mlx5: Use reversed order when unregister devices Saeed Mahameed
2019-07-25 20:36 ` [net 2/9] net/mlx5: Add missing RDMA_RX capabilities Saeed Mahameed
2019-07-25 20:36 ` [net 3/9] net/mlx5: Fix modify_cq_in alignment Saeed Mahameed
2019-07-25 20:36 ` [net 4/9] net/mlx5e: Fix wrong max num channels indication Saeed Mahameed
2019-07-25 20:36 ` [net 5/9] net/mlx5e: Fix matching of speed to PRM link modes Saeed Mahameed
2019-07-25 20:36 ` [net 6/9] net/mlx5e: Prevent encap flow counter update async to user query Saeed Mahameed
2019-07-25 20:36 ` [net 7/9] net/mlx5e: kTLS, Call WARN_ONCE on netdev mismatch Saeed Mahameed
2019-07-25 20:48   ` Jakub Kicinski
2019-07-25 20:49   ` Jakub Kicinski
2019-07-26 21:41     ` Saeed Mahameed
2019-07-25 20:36 ` [net 8/9] nfp: tls: rename tls packet counters Saeed Mahameed
2019-07-25 20:50   ` Jakub Kicinski
2019-07-25 20:36 ` Saeed Mahameed [this message]
2019-07-25 20:53   ` [net 9/9] Documentation: TLS: fix stat counters description Jakub Kicinski
2019-07-26 21:34 ` [pull request][net 0/9] Mellanox, mlx5 fixes 2019-07-25 David Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190725203618.11011-10-saeedm@mellanox.com \
    --to=saeedm@mellanox.com \
    --cc=davem@davemloft.net \
    --cc=jakub.kicinski@netronome.com \
    --cc=netdev@vger.kernel.org \
    --cc=tariqt@mellanox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox