Add new FileIo CRT bindings #6439
+325
−4
There are no files selected for viewing
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
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,170 @@ | ||||||
| /* | ||||||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||||||
| * | ||||||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||||||
| * You may not use this file except in compliance with the License. | ||||||
| * A copy of the License is located at | ||||||
| * | ||||||
| * http://aws.amazon.com/apache2.0 | ||||||
| * | ||||||
| * or in the "license" file accompanying this file. This file is distributed | ||||||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||||||
| * express or implied. See the License for the specific language governing | ||||||
| * permissions and limitations under the License. | ||||||
| */ | ||||||
|
|
||||||
| package software.amazon.awssdk.services.s3.crt; | ||||||
|
|
||||||
| import java.util.Objects; | ||||||
| import software.amazon.awssdk.annotations.Immutable; | ||||||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||||||
| import software.amazon.awssdk.annotations.ThreadSafe; | ||||||
| import software.amazon.awssdk.core.client.config.SdkAdvancedAsyncClientOption; | ||||||
| import software.amazon.awssdk.utils.builder.CopyableBuilder; | ||||||
| import software.amazon.awssdk.utils.builder.ToCopyableBuilder; | ||||||
|
|
||||||
| /** | ||||||
| * Configuration options which controls how client performs file I/O operations. Only applies to file-based workloads. | ||||||
| */ | ||||||
| @SdkPublicApi | ||||||
| @Immutable | ||||||
| @ThreadSafe | ||||||
| public final class S3CrtFileIoConfiguration | ||||||
| implements ToCopyableBuilder<S3CrtFileIoConfiguration.Builder, S3CrtFileIoConfiguration> { | ||||||
| private final Boolean uploadBufferDisabled; | ||||||
| private final Double diskThroughputGbps; | ||||||
|
|
||||||
| private S3CrtFileIoConfiguration(DefaultBuilder builder) { | ||||||
| this.uploadBufferDisabled = builder.uploadBufferDisabled; | ||||||
| this.diskThroughputGbps = builder.diskThroughputGbps; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Creates a default builder for {@link S3CrtFileIoConfiguration}. | ||||||
| */ | ||||||
| public static Builder builder() { | ||||||
| return new DefaultBuilder(); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Skip buffering the part in memory before sending the request. When set to true, the file content will not be buffered | ||||||
| * in memory and instead streamed to the http request. | ||||||
| * <p> | ||||||
| * Note: If upload buffering is still enabled, the CRT client will buffer <em>full parts</em> in | ||||||
| * memory, which could lead to out-of-memory for large files when the application does not have enough memory to fully | ||||||
| * buffer those parts in memory. | ||||||
| * <p> | ||||||
| * If set to true, also set the {@code diskThroughputGbps} to reasonably align with the available disk throughput. | ||||||
| * Otherwise, the transfer may fail with connection starvation. | ||||||
| * Defaults to false. | ||||||
| * @see SdkAdvancedAsyncClientOption#CRT_UPLOAD_FILE_DIRECT_IO | ||||||
| * @return if client should skip buffering in memory before sending the request. | ||||||
| */ | ||||||
| public Boolean uploadBufferDisabled() { | ||||||
| return uploadBufferDisabled; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * The estimated disk throughput in gigabits per second (Gbps). | ||||||
| * Only applied when {@code shouldStream} is true. | ||||||
|
There was a problem hiding this comment. Looks like typo and should be {@code uploadBufferDisabled} |
||||||
| * | ||||||
| * When doing upload with streaming, it's important to set the disk throughput to prevent connection starvation. | ||||||
| * Note: There are possibilities that cannot reach all available disk throughput: | ||||||
| * 1. Disk is busy with other applications | ||||||
| * 2. OS Cache may cap the throughput, use {@code directIo} to get around this. | ||||||
| * | ||||||
| * @return disk throughput value in Gpbs. | ||||||
| */ | ||||||
| public Double diskThroughputGbps() { | ||||||
| return diskThroughputGbps; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public boolean equals(Object o) { | ||||||
| if (this == o) { | ||||||
| return true; | ||||||
| } | ||||||
| if (o == null || getClass() != o.getClass()) { | ||||||
| return false; | ||||||
| } | ||||||
|
|
||||||
| S3CrtFileIoConfiguration that = (S3CrtFileIoConfiguration) o; | ||||||
|
|
||||||
| if (!Objects.equals(uploadBufferDisabled, that.uploadBufferDisabled)) { | ||||||
| return false; | ||||||
| } | ||||||
| return Objects.equals(diskThroughputGbps, that.diskThroughputGbps); | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public int hashCode() { | ||||||
| int result = uploadBufferDisabled != null ? uploadBufferDisabled.hashCode() : 0; | ||||||
| result = 31 * result + (diskThroughputGbps != null ? diskThroughputGbps.hashCode() : 0); | ||||||
| return result; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public Builder toBuilder() { | ||||||
| return new DefaultBuilder(this); | ||||||
| } | ||||||
|
|
||||||
| public interface Builder extends CopyableBuilder<Builder, S3CrtFileIoConfiguration> { | ||||||
| /** | ||||||
| * Skip buffering the part in memory before sending the request. | ||||||
| * If set, set the {@code diskThroughputGbps} to reasonably align with the available disk throughput. | ||||||
| * Otherwise, the transfer may fail with connection starvation. | ||||||
| * Defaults to false. | ||||||
| * | ||||||
| * @param shouldStream whether to stream the file | ||||||
| * @return The builder for method chaining. | ||||||
| */ | ||||||
| Builder uploadBufferDisabled(Boolean shouldStream); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| /** | ||||||
| * The estimated disk throughput in gigabits per second (Gbps). | ||||||
| * Only applied when {@code shouldStream} is true. | ||||||
|
There was a problem hiding this comment. Can we also mention in Java doc why shouldStream is referenced as uploadBufferDisabled in Java client? |
||||||
| * | ||||||
| * When doing upload with streaming, it's important to set the disk throughput to prevent connection starvation. | ||||||
| * Note: There are possibilities that cannot reach all available disk throughput: | ||||||
| * 1. Disk is busy with other applications | ||||||
| * 2. OS Cache may cap the throughput, use {@code directIo} to get around this. | ||||||
| * | ||||||
| * @param diskThroughputGbps the disk throughput in Gbps | ||||||
| * @return The builder for method chaining. | ||||||
| */ | ||||||
| Builder diskThroughputGbps(Double diskThroughputGbps); | ||||||
|
|
||||||
| @Override | ||||||
| S3CrtFileIoConfiguration build(); | ||||||
| } | ||||||
|
|
||||||
| private static final class DefaultBuilder implements Builder { | ||||||
| private Boolean uploadBufferDisabled; | ||||||
| private Double diskThroughputGbps; | ||||||
|
|
||||||
| private DefaultBuilder() { | ||||||
| } | ||||||
|
|
||||||
| private DefaultBuilder(S3CrtFileIoConfiguration fileIoOptions) { | ||||||
| this.uploadBufferDisabled = fileIoOptions.uploadBufferDisabled; | ||||||
| this.diskThroughputGbps = fileIoOptions.diskThroughputGbps; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public Builder uploadBufferDisabled(Boolean shouldStream) { | ||||||
| this.uploadBufferDisabled = shouldStream; | ||||||
| return this; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public Builder diskThroughputGbps(Double diskThroughputGbps) { | ||||||
| this.diskThroughputGbps = diskThroughputGbps; | ||||||
| return this; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public S3CrtFileIoConfiguration build() { | ||||||
| return new S3CrtFileIoConfiguration(this); | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
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.
Is there a way we default it to fault if user sets this for non linux ?