Report more specific errors for unknown constants #714
Conversation
This file contains 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
In case someone encounters some DWARF containing a constant value not known to gimli, let's ensure that the error has the actual constant available in it. These values are not visible in `Error::description` or the various other error-reporting functions which use it, such as the `Display` implementation. I think it would be good to improve that too, but wanted to keep this PR relatively small.
philipc
requested changes
May 23, 2024
| @@ -1048,7 +1048,7 @@ impl<R: Reader> DwarfPackage<R> { | |||
| SectionId::DebugMacro | SectionId::DebugMacinfo => { | |||
| // These are valid but we can't parse these yet. | |||
| } | |||
| _ => return Err(Error::UnknownIndexSection), | |||
| _ => return Err(Error::UnknownSection(section.section)), | |||
There was a problem hiding this comment.
This is fine, I don't think there's a better option, but it feels a bit dirty to add an error variant for a code path that will only occur due to a bug in gimli.
There was a problem hiding this comment.
Would it be better to introduce a new enum IndexSectionId which has only the kinds that are allowed in a UnitIndex?
There was a problem hiding this comment.
Maybe. It would avoid this possibility, and most consumers won't be directly using this section id so it won't affect them. Something for another PR though. I'd probably call it DwoSectionId.
jameysharp
added a commit
to jameysharp/gimli
that referenced
this pull request
May 24, 2024
Keeping this type distinct from the `SectionId` enum ensures that the compiler will report an error if someone adds incomplete support for new separate-debug sections. As discussed in: gimli-rs#714 (comment) The existing `SectionId::dwo_name` method did not match the list of sections actually supported elsewhere in gimli. I've added the one section ID that was missing (`.debug_macinfo.dwo`), but I have not removed the section IDs which are only present there: `.debug_str.dwo`, `.debug_cu_index`, and `.debug_tu_index`.
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.
In case someone encounters some DWARF containing a constant value not known to gimli, let's ensure that the error has the actual constant available in it.
These values are not visible in
Error::descriptionor the various other error-reporting functions which use it, such as theDisplayimplementation. I think it would be good to improve that too, but wanted to keep this PR relatively small.