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

Avoid processing log statement if logger has been destructed #2833

Merged
merged 1 commit into from
Jan 31, 2024

Conversation

SergeyRyabinin
Copy link
Contributor

in the middle of logging

Issue #, if available:

in case of heavy mis-use of basic-use such as in

TEST(AwsMemoryManagementTest, MultiInitParallel)

the logger may perform

m_syncData.m_queuedLogMessages.emplace_back(std::move(statement));

on already destructed self.
With custom memory management enabled, it will result in UB.

Description of changes:

Check all that applies:

  • Did a review by yourself.
  • Added proper tests to cover this PR. (If tests are not applicable, explain.)
  • Checked if this PR is a breaking (APIs have been changed) change.
  • Checked if this PR will not introduce cross-platform inconsistent behavior.
  • Checked if this PR would require a ReadMe/Wiki update.

Check which platforms you have built SDK on to verify the correctness of this PR.

  • Linux
  • Windows
  • Android
  • MacOS
  • IOS
  • Other Platforms

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@@ -63,7 +63,8 @@ namespace Aws
std::mutex m_logQueueMutex;
std::condition_variable m_queueSignal;
Aws::Vector<Aws::String> m_queuedLogMessages;
bool m_stopLogging;
bool m_stopLogging = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

This is redundant to the constructor at line 61.

@@ -63,7 +63,8 @@ namespace Aws
std::mutex m_logQueueMutex;
std::condition_variable m_queueSignal;
Aws::Vector<Aws::String> m_queuedLogMessages;
bool m_stopLogging;
bool m_stopLogging = false;
bool m_loggingThreadStopped = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be initialized in the constructor instead?

// explicitly wait for logging thread to finish
{
std::unique_lock<std::mutex> locker(m_syncData.m_logQueueMutex);
if (!m_syncData.m_loggingThreadStopped)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be "while" instead of "if" and not use a conditional wait_for? It is not safe to leave the destructor until we know the thread is gone.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

there is .join for the thread later.
I just did not want to block user code if the boolean is never set.

@SergeyRyabinin SergeyRyabinin merged commit 706ab12 into main Jan 31, 2024
4 checks passed
@SergeyRyabinin SergeyRyabinin deleted the sr/loggerFix branch January 31, 2024 18:58
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