docs: tls: Enhance TLS resync async process documentation
Subsystems (4)
PATCH v2 1/1 docs: tls: Enhance TLS resync async process documentation
From: Shahar Shitrit <[email protected]>
Expand the tls-offload.rst documentation to provide a more detailed explanation of the asynchronous resync process, including the role of struct tls_offload_resync_async in managing resync requests on the kernel side.
Also, add documentation for helper functions tls_offload_rx_resync_async_request_start/ _end/ _cancel.
--- Documentation/networking/tls-offload.rst | 30 ++++++++++++++++++++++++ 1 file changed, 30 insertions(+)
V2:
- Fix style issues.
Documentation/networking/tls-offload.rst +30 -0
@@ -318,6 +318,36 @@ is restarted. When the header is matched the device sends a confirmation request to the kernel, asking if the guessed location is correct (if a TLS record really starts there), and which record sequence number the given header had. + +The asynchronous resync process is coordinated on the kernel side using +struct tls_offload_resync_async, which tracks and manages the resync request. + +Helper functions to manage struct tls_offload_resync_async: + +``tls_offload_rx_resync_async_request_start()`` +Initializes an asynchronous resync attempt by specifying the sequence range to +monitor and resetting internal state in the struct. + +``tls_offload_rx_resync_async_request_end()`` +Retains the device's guessed TCP sequence number for comparison with current or +future logged ones. It also clears the RESYNC_REQ_ASYNC flag from the resync +request, indicating that the device has submitted its guessed sequence number. + +``tls_offload_rx_resync_async_request_cancel()`` +Cancels any in-progress resync attempt, clearing the request state. + +When the kernel processes an RX segment that begins a new TLS record, it +examines the current status of the asynchronous resynchronization request. + +If the device is still waiting to provide its guessed TCP sequence number +(the async state), the kernel records the sequence number of this segment so +that it can later be compared once the device's guess becomes available. + +If the device has already submitted its guessed sequence number (the non-async +state), the kernel now tries to match that guess against the sequence numbers of +all TLS record headers that have been logged since the resync request +started. + The kernel confirms the guessed location was correct and tells the device the record sequence number. Meanwhile, the device had been parsing and counting all records since the just-confirmed one, it adds the number
base-commit: cbe8e6bef6a3b4b895b47ea56f5952f1936aacb6
Signature · 1 line
2.31.1
Quoted 10 lines · Tariq Toukan
From: Shahar Shitrit <[email protected]>
Expand the
tls-offload.rstdocumentation to provide a more detailed explanation of the asynchronous resync process, including the role of structtls_offload_resync_asyncin managing resync requests on the kernel side.Also, add documentation for helper functions tls_offload_rx_resync_async_request_start/ _end/
_cancel.
Quoted 8 lines
Signed-off-by Shahar Shitrit <[email protected]>Signed-off-by Tariq Toukan <[email protected]>--- Documentation/networking/tls-offload.rst | 30 ++++++++++++++++++++++++ 1 file changed, 30 insertions(+)V2:
- Fix style issues.
Thanks for the update.
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 8 lines · On Tue, 13 Jan 2026 12:08:03 +0200 you wrote:
From: Shahar Shitrit <[email protected]>
Expand the
tls-offload.rstdocumentation to provide a more detailed explanation of the asynchronous resync process, including the role of structtls_offload_resync_asyncin managing resync requests on the kernel side.[...]
Here is the summary with links:
- [net-next,V2] docs: tls: Enhance TLS resync async process documentation
https://git.kernel.org/netdev/net-next/c/8fc807104125
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html