Add InitAPI call count to workaround multiple init mis-use #2710
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
SergeyRyabinin
commented
Oct 11, 2023
| if(s_initCount != 1) | ||
| { | ||
| if(!s_initCount) { | ||
| AWS_LOGSTREAM_ERROR(ALLOCATION_TAG, "Unable to ShutdownAPI of AWS-SDK-CPP: the SDK was not initialized."); |
There was a problem hiding this comment.
I have no idea how this one is going to be actually traced (without an initialized logger)
I don't want to add an assert here though.
sbiscigl
approved these changes
Oct 12, 2023
| void InitAPI(const SDKOptions &options) | ||
| { | ||
| std::unique_lock<std::mutex> lock(s_initShutdownMutex); | ||
| s_initCount += 1; | ||
| if(s_initCount != 1) |
There was a problem hiding this comment.
could we use an atomic int instead of a mutex?
There was a problem hiding this comment.
I also wanted to prevent simultaneous Init/Shutdown calls.
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.
Issue #, if available:
This is a workaround for issues where customer is not able to control underlying libraries using the C++ SDK, such as #2699
Description of changes:
Add reference count on and blocking on mutex on InitAPI-ShutdownAPI methods.
This does not really fix the root architectural issue, but at least it provides a some level of workaround.
All consequent calls to InitAPI only increases the SDK usage count,
optionsargument is completely ignored on any subsequent call, and only the last ShutdownAPI will actually shut down the library.Check all that applies:
Check which platforms you have built SDK on to verify the correctness of this PR.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.