utl: ensure exception-safe file closure in stream and file handlers #9256
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
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request effectively addresses the risk of exceptions being thrown from destructors in file handling classes by introducing explicit close() methods and ensuring destructors are exception-safe. This improves robustness and provides users a way to handle file closure errors explicitly. My review includes one high-severity suggestion for FileHandler::close() to ensure it properly reports errors instead of failing silently, which aligns with the overall goal of this pull request.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Addresses an issue where utl::OutStreamHandler could cause a crash (std::terminate) if a file flush or rename failed during destruction (e.g., due to ENOSPC). - Added explicit close() methods to OutStreamHandler, InStreamHandler, and FileHandler to allow users to handle closure errors explicitly. - Updated destructors to be exception-safe by catching potential errors during implicit closure. - Added diagnostic logging to std::cerr in destructors to report closure failures that would otherwise be suppressed. Fixes The-OpenROAD-Project#9252 Signed-off-by: Matt Liberty <mliberty@precisioninno.com>
openroad-ci
force-pushed
the
utl-file-dtor-catch
branch
from
a737407 to
f76c87a
Compare
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
maliberty
approved these changes
Jan 14, 2026
oharboe
reviewed
Jan 14, 2026
Collaborator
oharboe
left a comment
oharboe
left a comment
There was a problem hiding this comment.
Nice! Ideally the close() is called from user-code so that the exception is propagated from user-code and not logged and silenced.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Addresses an issue where utl::OutStreamHandler could cause a crash (std::terminate) if a file flush or rename failed during destruction (e.g., due to ENOSPC).
Fixes #9252