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.

Sign up for GitHub

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

Jump to bottom

[Core] Fix Race Conditions in CMsgSubscriber #1324

Merged
merged 3 commits into from
Jan 23, 2024
Merged

[Core] Fix Race Conditions in CMsgSubscriber #1324

merged 3 commits into from
Jan 23, 2024

Conversation

KerstinKeller
Copy link
Contributor

  • Properly implement destructor (in inherited classes)! -> Destroy may not be called in base CMsgSubscriber class as this can lead to stack unwinding (most likely causes an exception in destructor, or leads to already deleted functions of derived class being called when they are already deleted)
  • Correct order of RemReceiveCallback and resetting internal pointer
  • protect function pointer with mutex.
  • Make testcase "harder" to more easily trigger race conditions.

Cherry-pick to

  • 5.11 (old stable)
  • 5.12 (current stable)

@KerstinKeller
[Core] Fix Race Conditions in CMsgSubscriber
c414d52 
- Properly implement destructor (in inherited classes)! -> Destroy may not be called in base CMsgSubscriber class as this can lead to stack unwinding (most likely causes an exception in destructor, or leads to already deleted functions of derived class being called when they are already deleted)
- Correct order of RemReceiveCallback and resetting internal pointer
- protect function pointer with mutex.
- Make testcase "harder" to more easily trigger race conditions.
@KerstinKeller
Call this->destroy()
184af73
github-actions[bot]
github-actions bot reviewed Jan 22, 2024
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

clang-tidy made some suggestions

ecal/core/include/ecal/msg/subscriber.h Outdated
@@ -125,7 +125,8 @@ namespace eCAL
return *this;
}

virtual ~CMsgSubscriber() {}
virtual ~CMsgSubscriber()
Copy link
Contributor

Choose a reason for hiding this comment

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

warning: use '= default' to define a trivial destructor [modernize-use-equals-default]

ecal/core/include/ecal/msg/subscriber.h:128:

-     {}
+     = default;

ecal/core/include/ecal/msg/subscriber.h
@@ -219,9 +223,12 @@ namespace eCAL
**/
bool RemReceiveCallback()
{
bool ret = CSubscriber::RemReceiveCallback();
Copy link
Contributor

Choose a reason for hiding this comment

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

warning: variable 'ret' is not initialized [cppcoreguidelines-init-variables]

Suggested change
bool ret = CSubscriber::RemReceiveCallback();
bool ret = false = CSubscriber::RemReceiveCallback();

ecal/core/include/ecal/msg/subscriber.h Outdated
@@ -245,7 +252,11 @@ namespace eCAL
private:
void ReceiveCallback(const char* topic_name_, const struct eCAL::SReceiveCallbackData* data_)
{
MsgReceiveCallbackT fn_callback(m_cb_callback);
MsgReceiveCallbackT fn_callback;
Copy link
Contributor

Choose a reason for hiding this comment

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

warning: variable 'fn_callback' is not initialized [cppcoreguidelines-init-variables]

Suggested change
MsgReceiveCallbackT fn_callback;
MsgReceiveCallbackT fn_callback = 0;

@KerstinKeller
Copy link
Contributor Author

Fixes #1318

github-actions[bot]
github-actions bot reviewed Jan 22, 2024
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

clang-tidy made some suggestions

ecal/core/include/ecal/msg/subscriber.h
@@ -245,7 +251,11 @@ namespace eCAL
private:
void ReceiveCallback(const char* topic_name_, const struct eCAL::SReceiveCallbackData* data_)
{
MsgReceiveCallbackT fn_callback(m_cb_callback);
MsgReceiveCallbackT fn_callback = nullptr;
Copy link
Contributor

Choose a reason for hiding this comment

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

warning: variable 'fn_callback' is not initialized [cppcoreguidelines-init-variables]

Suggested change
MsgReceiveCallbackT fn_callback = nullptr;
MsgReceiveCallbackT fn_callback = 0 = nullptr;

@FlorianReimold FlorianReimold added this to the eCAL 5.12.2 / 5.11.7 milestone Jan 23, 2024
@FlorianReimold FlorianReimold merged commit 2006200 into master Jan 23, 2024
14 checks passed
KerstinKeller added a commit that referenced this pull request Jan 25, 2024
@KerstinKeller
[Core] Fix Race Conditions in CMsgSubscriber (#1324)
0b43311 
- Properly implement destructor (in inherited classes)! -> Destroy may not be called in base CMsgSubscriber class as this can lead to stack unwinding (most likely causes an exception in destructor, or leads to already deleted functions of derived class being called when they are already deleted)
- Correct order of RemReceiveCallback and resetting internal pointer
- protect function pointer with mutex.
- Make testcase "harder" to more easily trigger race conditions.
KerstinKeller added a commit that referenced this pull request Jan 25, 2024
@KerstinKeller
[Core] Fix Race Conditions in CMsgSubscriber (#1324)
b5666d5 
- Properly implement destructor (in inherited classes)! -> Destroy may not be called in base CMsgSubscriber class as this can lead to stack unwinding (most likely causes an exception in destructor, or leads to already deleted functions of derived class being called when they are already deleted)
- Correct order of RemReceiveCallback and resetting internal pointer
- protect function pointer with mutex.
- Make testcase "harder" to more easily trigger race conditions.
@KerstinKeller KerstinKeller deleted the feature/cmsg-subscriber-race-conditions branch January 25, 2024 18:08
FlorianReimold pushed a commit that referenced this pull request Jan 26, 2024
@KerstinKeller @FlorianReimold
[Core] Fix Race Conditions in CMsgSubscriber (#1324)
3855c37 
- Properly implement destructor (in inherited classes)! -> Destroy may not be called in base CMsgSubscriber class as this can lead to stack unwinding (most likely causes an exception in destructor, or leads to already deleted functions of derived class being called when they are already deleted)
- Correct order of RemReceiveCallback and resetting internal pointer
- protect function pointer with mutex.
- Make testcase "harder" to more easily trigger race conditions.
FlorianReimold pushed a commit that referenced this pull request Jan 26, 2024
@KerstinKeller @FlorianReimold
[Core] Fix Race Conditions in CMsgSubscriber (#1324)
b424699 
- Properly implement destructor (in inherited classes)! -> Destroy may not be called in base CMsgSubscriber class as this can lead to stack unwinding (most likely causes an exception in destructor, or leads to already deleted functions of derived class being called when they are already deleted)
- Correct order of RemReceiveCallback and resetting internal pointer
- protect function pointer with mutex.
- Make testcase "harder" to more easily trigger race conditions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@FlorianReimold FlorianReimold FlorianReimold approved these changes

@rex-schilasky rex-schilasky Awaiting requested review from rex-schilasky

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
eCAL 5.12.2 / 5.11.7
Development

Successfully merging this pull request may close these issues.
2 participants
@KerstinKeller @FlorianReimold