Throw error when the max read amount is greater than ByteBuffer can tolerate
#2911
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
Motivation: As described in issue [apple#2878](apple#2878), NIOFileSystem crashes when reading more than `ByteBuffer` capacity. Modifications: - Add a new static property, `byteBufferCapacity`, to `ByteCount` representing the maximum amount of bytes that can be written to `ByteBuffer`. - Throw a `FileSystemError` in `ReadableFileHandleProtocol.readToEnd(fromAbsoluteOffset:maximumSizeAllowed:)` when `maximumSizeAllowed` is more than `ByteCount.byteBufferCapacity`. Result: NIOFileSystem will `throw` instead of crashing.
glbrntt
reviewed
Oct 10, 2024
Comment on lines
84
to
90
| #if arch(arm) || arch(i386) || arch(arm64_32) | ||
| // on 32-bit platforms we can't make use of a whole UInt32.max (as it doesn't fit in an Int) | ||
| private static let byteBufferMaxIndex = UInt32(Int.max) | ||
| #else | ||
| // on 64-bit platforms we're good | ||
| private static let byteBufferMaxIndex = UInt32.max | ||
| #endif |
There was a problem hiding this comment.
Do we actually need these static lets or should we just do this within the body of static var byteBufferCapacity: ByteCount { ... }?
Comment on lines
349
to
351
| The maximum size allowed (\(maximumSizeAllowed)) is more than the maximum \ | ||
| amount of bytes that can be written to ByteBuffer \ | ||
| (\(ByteCount.byteBufferCapacity)). |
There was a problem hiding this comment.
Suggested change
| The maximum size allowed (\(maximumSizeAllowed)) is more than the maximum \ | |
| amount of bytes that can be written to ByteBuffer \ | |
| (\(ByteCount.byteBufferCapacity)). | |
| The maximum size allowed (\(maximumSizeAllowed)) is more than the maximum \ | |
| amount of bytes that can be written to ByteBuffer \ | |
| (\(ByteCount.byteBufferCapacity)). You can read the file in smaller chunks by \ | |
| calling readChunks(). |
Comment on lines
325
to
327
| /// an offset other than zero is passed. Also, it will throw | ||
| /// ``FileSystemError/Code-swift.struct/resourceExhausted`` if `maximumSizeAllowed` is more than can be | ||
| /// written to `ByteBuffer`. |
There was a problem hiding this comment.
This past should go in the Throws: section below
glbrntt
approved these changes
Oct 10, 2024
glbrntt
changed the title
ByteBuffer capacityByteBuffer can tolerate
clintonpi
deleted the
avoid-file-system-crash-when-reading-more-than-byte-buffer-capacity
branch
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.
Motivation:
As described in issue #2878, NIOFileSystem crashes when reading more than
ByteBuffercapacity.Modifications:
byteBufferCapacity, toByteCountrepresenting the maximum amount of bytes that can be written toByteBuffer.FileSystemErrorinReadableFileHandleProtocol.readToEnd(fromAbsoluteOffset:maximumSizeAllowed:)whenmaximumSizeAllowedis more thanByteCount.byteBufferCapacity.Result:
NIOFileSystem will
throwinstead of crashing.