Documentation: TLS: fix stat counters description

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

Fixes: f42c104f2e ("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>
This commit is contained in:
Tariq Toukan 2019-07-22 13:43:03 +03:00 committed by Saeed Mahameed
parent 4ea52e2508
commit 280c089916

View file

@ -424,13 +424,24 @@ Statistics
Following minimum set of TLS-related statistics should be reported Following minimum set of TLS-related statistics should be reported
by the driver: by the driver:
* ``rx_tls_decrypted`` - number of successfully decrypted TLS segments * ``rx_tls_decrypted_packets`` - number of successfully decrypted RX packets
* ``tx_tls_encrypted`` - number of in-order TLS segments passed to device which were part of a TLS stream.
for encryption * ``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 * ``tx_tls_ooo`` - number of TX packets which were part of a TLS stream
but did not arrive in the expected order but did not arrive in the expected order.
* ``tx_tls_drop_no_sync_data`` - number of TX packets dropped because * ``tx_tls_drop_no_sync_data`` - number of TX packets which were part of
they arrived out of order and associated record could not be found 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 Notable corner cases, exceptions and additional requirements
============================================================ ============================================================