-
Notifications
You must be signed in to change notification settings - Fork 655
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
byte-buffer: use malloc_good_size
on Darwin to allocate memory
#3066
Open
natikgadzhi
wants to merge
3
commits into
apple:main
Choose a base branch
from
natikgadzhi:byte-buffer/storage/malloc-good-size
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.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the SwiftNIO open source project | ||
// | ||
// Copyright (c) 2025 Apple Inc. and the SwiftNIO project authors | ||
// Licensed under Apache License v2.0 | ||
// | ||
// See LICENSE.txt for license information | ||
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
import XCTest | ||
|
||
@testable import NIOCore | ||
|
||
/// Returns the malloc size that we expect to be allocated for a given requested capacity size. | ||
/// On Darwin, we want to use `malloc_good_size` to get the optimal size, but on all other platforms | ||
/// we use the next power of 2, clamped. | ||
private func expectedMallocSize(_ size: Int) -> Int { | ||
#if canImport(Darwin) | ||
return Darwin.malloc_good_size(size) | ||
#else | ||
return UInt32(size).nextPowerOf2ClampedToMax() | ||
#endif | ||
} | ||
|
||
// Tests that ByteBuffer allocates memory in an optimal way depending on the host platform. | ||
|
||
final class ByteBufferStorageMallocTest: XCTestCase { | ||
|
||
func testInitialAllocationUsesGoodSize() { | ||
let allocator = ByteBufferAllocator() | ||
let requestedCapacity = 1000 | ||
let expectedCapacity = expectedMallocSize(requestedCapacity) | ||
|
||
let buffer = allocator.buffer(capacity: requestedCapacity) | ||
XCTAssertEqual(Int(buffer._storage.capacity), expectedCapacity) | ||
} | ||
|
||
func testReallocationUsesGoodSize() { | ||
let allocator = ByteBufferAllocator() | ||
var buffer = allocator.buffer(capacity: 16) | ||
let initialCapacity = buffer.capacity | ||
|
||
// Write more bytes than the current capacity to trigger reallocation | ||
let newSize = initialCapacity + 100 | ||
let expectedCapacity = expectedMallocSize(Int(newSize)) | ||
|
||
// This will trigger reallocation | ||
buffer.writeBytes(Array(repeating: UInt8(0), count: Int(newSize))) | ||
|
||
XCTAssertEqual(Int(buffer._storage.capacity), expectedCapacity) | ||
} | ||
|
||
func testZeroCapacity() { | ||
let allocator = ByteBufferAllocator() | ||
let buffer = allocator.buffer(capacity: 0) | ||
XCTAssertEqual(buffer.capacity, 0) | ||
} | ||
|
||
} |
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.
Why are we asking for capacity differently here than in the rest of the tests?
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.
Same approach as the rest of the tests would be fine, BUT zero being explicit feels nice.
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.
I think it might be nice to keep the tests discussing capacity the same way.