feat: Adds cleanup_final #4853
Merged
feat: Adds cleanup_final #4853
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
goatgoose
reviewed
Oct 22, 2024
api/s2n.h
Outdated
Comment on lines
247
to
248
| * The difference between this API and s2n_cleanup is that s2n_cleanup may not fully clean up | ||
| * the library if it is called on a thread that did not initialize s2n-tls. |
There was a problem hiding this comment.
I'm not sure it's clear when this API should be used vs s2n_cleanup. It sounds like this API should maybe always be used instead of s2n_cleanup? If so, should we say something in s2n_cleanup to use this instead?
There was a problem hiding this comment.
Basically, s2n_cleanup_final doesn't really have a usecase unless you disable the atexit handler. If the atexit handler is on, you don't need cleanup_final. And we are planning on turning off the atexit handler soon, just not in this specific PR. I just don't want to write docs that I'm going to have to rewrite in this PR #4846.
lrstewart
reviewed
Oct 23, 2024
lrstewart
approved these changes
Oct 23, 2024
goatgoose
approved these changes
Oct 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolved issues:
N/A
Description of changes:
Adds the s2n_cleanup_final() function to our API list. This is the counterpart to s2n_cleanup_thread. You can see that if I cherry-pick this API in this PR it passes our CI (except for our flaky tests and current known CI failures): #4846. The only test it does not pass is build_aws_crt_cpp.sh. This is the CRT's test suite and they need to use s2n_cleanup_final API in those tests first.
Call-outs:
I don't see any reason why we would make this API unstable. There is no reason why we would delete it once we have it. 😢
Testing:
Includes unit test.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.