-
Notifications
You must be signed in to change notification settings - Fork 168
Enhance DWARF memory reader with bounds checking and exception handli… #1167
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
Open
Sasinkas
wants to merge
4
commits into
main
Choose a base branch
from
dev/sraroseck/dwarf-memory-reader-exception-handeling
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+207
−18
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ed31aef
Enhance DWARF memory reader with bounds checking and exception handli…
Sasinkas bafb5e2
Refactor DwarfMemoryReaderTests: Remove unnecessary whitespace and cl…
Sasinkas 7a74391
Introduce DwarfBufferOverreadException for improved error handling in…
Sasinkas 7fd02a4
update dotnet format
Sasinkas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
36 changes: 36 additions & 0 deletions
36
src/BinaryParsers/ElfBinary/Dwarf/DwarfBufferOverreadException.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using System; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.BinaryParsers.Dwarf | ||
| { | ||
| /// <summary> | ||
| /// Exception thrown when an attempt is made to read past the end of a DWARF data buffer. | ||
| /// </summary> | ||
| public class DwarfBufferOverreadException : InvalidOperationException | ||
| { | ||
| public DwarfBufferOverreadException(uint position, uint requestedBytes, int bufferLength) | ||
| : base("Attempted to read past end of DWARF data buffer.") | ||
| { | ||
| Position = position; | ||
| RequestedBytes = requestedBytes; | ||
| BufferLength = bufferLength; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the position in the buffer at which the over-read was detected. | ||
| /// </summary> | ||
| public uint Position { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets the number of bytes that were requested. | ||
| /// </summary> | ||
| public uint RequestedBytes { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets the total length of the underlying buffer. | ||
| /// </summary> | ||
| public int BufferLength { get; } | ||
| } | ||
| } |
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 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 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First part in front of || seems redundant (it's equivalent of second part, with Position = 0)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even if Position is 0, there might be a scenario where we want to read more bytes than length (Data.Length = 4 and bytesToRead = 8 -> that is the kind of scenario where first part is necessary