Make debug_sync regex more robust
#1944
Merged
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
This will allow us to change the module regex match in debug_sync to make it more robust.
On windows the symbol names appear to sometimes be truncated, which causes the symbol name to not include the `::new` at the end. This causes the regex to mis-match and track the wrong location for the mutex construction, leading to bogus lockorder violations. For example, in testing the following symbol name appeared on Windows, without the function name itself: `lightning::debug_sync::RwLock<std::collections::hash::map::HashMap<lightning::chain::transaction::OutPoint,lightning::chain::chainmonitor::MonitorHolder<lightning::util::enforcing_trait_impls::EnforcingSigner>,std::collections::hash::map::RandomState> >::`
TheBlueMatt
force-pushed
the
2022-01-lockorder-windows-robust
branch
from
e65cc30 to
ab46f6b
Compare
Codecov ReportBase: 90.75% // Head: 90.72% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1944 +/- ##
==========================================
- Coverage 90.75% 90.72% -0.03%
==========================================
Files 96 97 +1
Lines 50135 50135
Branches 50135 50135
==========================================
- Hits 45498 45484 -14
- Misses 4637 4651 +14
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
dunxen
approved these changes
Jan 10, 2023
jkczyz
reviewed
Jan 10, 2023
| @@ -77,7 +77,7 @@ fn get_construction_location(backtrace: &Backtrace) -> String { | |||
| // Find the first frame that is after `debug_sync` (or that is in our tests) and use | |||
| // that as the mutex construction site. Note that the first few frames may be in | |||
| // the `backtrace` crate, so we have to ignore those. | |||
| let sync_mutex_constr_regex = regex::Regex::new(r"lightning.*debug_sync.*new").unwrap(); | |||
| let sync_mutex_constr_regex = regex::Regex::new(r"lightning.*debug_sync").unwrap(); | |||
There was a problem hiding this comment.
Do we need a trailing .* to match the locks type (and new when it is not truncated)?
There was a problem hiding this comment.
I don't think so, is_match "Returns true if and only if there is a match for the regex in the string given." ie not if the match is the string but if there is a match in the string.
ViktorTigerstrom
approved these changes
Jan 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
On windows the symbol names appear to sometimes be truncated,
which causes the symbol name to not include the
::newat the end.This causes the regex to mis-match and track the wrong location
for the mutex construction, leading to bogus lockorder violations.
For example, in testing the following symbol name appeared on
Windows, without the function name itself:
lightning::debug_sync::RwLock<std::collections::hash::map::HashMap<lightning::chain::transaction::OutPoint,lightning::chain::chainmonitor::MonitorHolder<lightning::util::enforcing_trait_impls::EnforcingSigner>,std::collections::hash::map::RandomState> >::