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 crash in install_bad_alloc_error_handler #83160

Merged
merged 3 commits into from
Mar 1, 2024

Conversation

fabianbs96
Copy link
Contributor

Fixes #83040

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot
Copy link
Collaborator

llvmbot commented Feb 27, 2024

@llvm/pr-subscribers-llvm-support

Author: Fabian Schiebel (fabianbs96)

Changes

Fixes #83040


Full diff: https://github.com/llvm/llvm-project/pull/83160.diff

1 Files Affected:

  • (modified) llvm/lib/Support/ErrorHandling.cpp (+2-1)
diff --git a/llvm/lib/Support/ErrorHandling.cpp b/llvm/lib/Support/ErrorHandling.cpp
index b8b3b7424ac6b1..d2d3dcc2f478c5 100644
--- a/llvm/lib/Support/ErrorHandling.cpp
+++ b/llvm/lib/Support/ErrorHandling.cpp
@@ -130,7 +130,8 @@ void llvm::install_bad_alloc_error_handler(fatal_error_handler_t handler,
 #if LLVM_ENABLE_THREADS == 1
   std::lock_guard<std::mutex> Lock(BadAllocErrorHandlerMutex);
 #endif
-  assert(!ErrorHandler && "Bad alloc error handler already registered!\n");
+  assert(!BadAllocErrorHandler &&
+         "Bad alloc error handler already registered!\n");
   BadAllocErrorHandler = handler;
   BadAllocErrorHandlerUserData = user_data;
 }

@aganea
Copy link
Member

aganea commented Feb 27, 2024

Thanks for the PR! Do you think you can craft a minimal unit test (the one provided in the issue)? You could probably add that to one of the Support unit tests.

@fabianbs96
Copy link
Contributor Author

Sure!
Do you have any recommendations on how to best "assert" no crash? It seems weird adding unittests without any assertions inside.

Copy link
Member

@aganea aganea left a comment

Choose a reason for hiding this comment

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

Sure! Do you have any recommendations on how to best "assert" no crash? It seems weird adding unittests without any assertions inside.

If you revert locally your fix in ErrorHandling.cpp a crash should fail the test. That is enough I think to cover the issue (along with an explanation like suggested below).

TEST(Error, FatalBadAllocErrorHandlersInteraction) {
auto ErrorHandler = [](void *Data, const char *, bool) {};
install_fatal_error_handler(ErrorHandler, nullptr);
// The following call should not crash
Copy link
Member

Choose a reason for hiding this comment

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

I think you should expand just a little more your comment, just to explain we're doing this sequence of calls because of a bug that happened previously inside install_bad_alloc_error_handler.

// The following call should not crash
install_bad_alloc_error_handler(ErrorHandler, nullptr);

// Don't interfere with other tests:
Copy link
Member

Choose a reason for hiding this comment

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

Remove : and finish with a full stop (.)

Copy link
Member

@aganea aganea left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for making the changes!

@aganea aganea merged commit 1685e7f into llvm:main Mar 1, 2024
3 of 4 checks passed
Copy link

github-actions bot commented Mar 1, 2024

@fabianbs96 Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested
by our build bots. If there is a problem with a build, you may recieve a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as
the builds can include changes from many authors. It is not uncommon for your
change to be included in a build that fails due to someone else's changes, or
infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself.
This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Crash in install_bad_alloc_error_handler
3 participants