core/cib: Add a prominent warning about thread safety #21401
Merged
Conversation
This file contains hidden or 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
Users of CIB may easily be mislead to believing that it is generally thread safe, or at least thread safe as long as there is a single consumer and producer. Neither is the case, which now is clearly communicated in the API doc. Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de>
683dc98 to
dcd3ee7
Compare
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.
Contribution description
Users of CIB may easily be mislead to believing that it is generally thread safe, or at least thread safe as long as there is a single consumer and producer. Neither is the case, which now is clearly communicated in the API doc.
Testing procedure
The generated API should now make it clear that CIB is not thread safe. It should especially be clear that thread safety cannot even be assumed in special cases (such as single consumer, single producer, inherently atomic access to
unsigned int), but requires the caller to ensure exclusive access tocib_tunder any circumstances.Issues/PRs references
See e.g. #21400 for an example where the calling side got their feet shot.