Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix] fix data race risk of cache_randomness #2927

Merged
merged 3 commits into from
Sep 7, 2023

Conversation

HarborYuan
Copy link
Contributor

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Please describe the motivation of this PR and the goal you want to achieve through this PR.

fix the bug mentioned in #2926

Modification

Please briefly describe what modification is made in this PR.

The bug mentioned in #2926 is caused by the data race of multithreading. I do not think it is a good idea to use a pointer here to point to different instances. This can lead to disaster in concurrent situations. To keep modifications minimal, I implemented a version that creates a new copy every time "cache_randomness" is accessed to avoid data races of multithreading. Since this class "cache_randomness" only contains two pointers, one pointing to the class method (rather than the bound method) and the other to the class, the additional overhead brought here is subtle.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

I do not think it breaks

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

@@ -80,7 +81,7 @@ def __call__(self, *args, **kwargs):

def __get__(self, obj, cls):
self.instance_ref = weakref.ref(obj)
return self
return copy.deepcopy(self)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return copy.deepcopy(self)
return copy.copy(self)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Thanks for your suggestion.

@ly015 ly015 changed the title bugfix #2926 [Fix] fix data race risk of cache_randomness Sep 7, 2023
@ly015 ly015 requested a review from zhouzaida September 7, 2023 07:17
@zhouzaida zhouzaida merged commit 4f65f91 into open-mmlab:main Sep 7, 2023
9 of 10 checks passed
@HarborYuan HarborYuan deleted the fix_cache_randomness branch September 7, 2023 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants