HADOOP-19767: [ABFS] Introduce Abfs Input Policy for detecting read patterns #8153
+901
−123
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,7 @@ | |
| import org.apache.hadoop.classification.InterfaceAudience; | ||
| import org.apache.hadoop.classification.InterfaceStability; | ||
| import org.apache.hadoop.fs.FileSystem; | ||
| import org.apache.hadoop.fs.Options; | ||
|
|
||
| import static org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.DOT; | ||
|
|
||
|
|
@@ -215,6 +216,12 @@ public final class ConfigurationKeys { | |
| public static final String FS_AZURE_READ_AHEAD_QUEUE_DEPTH = "fs.azure.readaheadqueue.depth"; | ||
| public static final String FS_AZURE_ALWAYS_READ_BUFFER_SIZE = "fs.azure.read.alwaysReadBufferSize"; | ||
| public static final String FS_AZURE_READ_AHEAD_BLOCK_SIZE = "fs.azure.read.readahead.blocksize"; | ||
| /** | ||
| * Provides hint for the read workload pattern. | ||
| * Possible Values Exposed in {@link Options.OpenFileOptions} | ||
|
||
| */ | ||
| public static final String FS_AZURE_READ_POLICY = "fs.azure.read.policy"; | ||
|
|
||
| /** Provides a config control to enable or disable ABFS Flush operations - | ||
| * HFlush and HSync. Default is true. **/ | ||
| public static final String FS_AZURE_ENABLE_FLUSH = "fs.azure.enable.flush"; | ||
|
|
||
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,109 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License 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 org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import org.apache.hadoop.fs.FileSystem; | ||
| import org.apache.hadoop.fs.azurebfs.constants.ReadType; | ||
| import org.apache.hadoop.fs.azurebfs.utils.TracingContext; | ||
|
|
||
| import static java.lang.Math.max; | ||
|
|
||
| /** | ||
| * Input stream implementation optimized for adaptive read patterns. | ||
| * This is the default implementation used for cases where user does not specify any input policy. | ||
| * It switches between sequential and random read optimizations based on the detected read pattern. | ||
| * It also keeps footer read and small file optimizations enabled. | ||
| */ | ||
| public class AbfsAdaptiveInputStream extends AbfsInputStream { | ||
|
|
||
| public AbfsAdaptiveInputStream( | ||
|
Check failure on line 37 in hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AbfsAdaptiveInputStream.java
|
||
anujmodi2021 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| final AbfsClient client, | ||
| final FileSystem.Statistics statistics, | ||
| final String path, | ||
| final long contentLength, | ||
| final AbfsInputStreamContext abfsInputStreamContext, | ||
| final String eTag, | ||
| TracingContext tracingContext) { | ||
| super(client, statistics, path, contentLength, | ||
| abfsInputStreamContext, eTag, tracingContext); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| protected int readOneBlock(final byte[] b, final int off, final int len) throws IOException { | ||
| if (len == 0) { | ||
| return 0; | ||
| } | ||
| if (!validate(b, off, len)) { | ||
| return -1; | ||
| } | ||
| //If buffer is empty, then fill the buffer. | ||
|
||
| if (bCursor == limit) { | ||
| //If EOF, then return -1 | ||
|
||
| if (fCursor >= contentLength) { | ||
| return -1; | ||
| } | ||
|
|
||
| long bytesRead = 0; | ||
| //reset buffer to initial state - i.e., throw away existing data | ||
|
||
| bCursor = 0; | ||
| limit = 0; | ||
| if (buffer == null) { | ||
| LOG.debug("created new buffer size {}", bufferSize); | ||
| buffer = new byte[bufferSize]; | ||
| } | ||
|
|
||
| // Reset Read Type back to normal and set again based on code flow. | ||
| tracingContext.setReadType(ReadType.NORMAL_READ); | ||
| if (alwaysReadBufferSize) { | ||
| bytesRead = readInternal(fCursor, buffer, 0, bufferSize, false); | ||
| } else { | ||
| // Enable readAhead when reading sequentially | ||
| if (-1 == fCursorAfterLastRead || fCursorAfterLastRead == fCursor || b.length >= bufferSize) { | ||
| LOG.debug("Sequential read with read ahead size of {}", bufferSize); | ||
| bytesRead = readInternal(fCursor, buffer, 0, bufferSize, false); | ||
| } else { | ||
| /* | ||
| * Disable queuing prefetches when random read pattern detected. | ||
| * Instead, read ahead only for readAheadRange above what is asked by caller. | ||
| */ | ||
| tracingContext.setReadType(ReadType.RANDOM_READ); | ||
| int lengthWithReadAhead = Math.min(b.length + readAheadRange, bufferSize); | ||
| LOG.debug("Random read with read ahead size of {}", lengthWithReadAhead); | ||
| bytesRead = readInternal(fCursor, buffer, 0, lengthWithReadAhead, true); | ||
| } | ||
| } | ||
| if (firstRead) { | ||
| firstRead = false; | ||
| } | ||
| if (bytesRead == -1) { | ||
| return -1; | ||
| } | ||
|
|
||
| limit += bytesRead; | ||
| fCursor += bytesRead; | ||
| fCursorAfterLastRead = fCursor; | ||
| } | ||
| return copyToUserBuffer(b, off, len); | ||
| } | ||
| } | ||
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,78 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License 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 org.apache.hadoop.fs.azurebfs.services; | ||
|
|
||
| import java.util.Locale; | ||
|
|
||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_ADAPTIVE; | ||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_COLUMNAR; | ||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_ORC; | ||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_PARQUET; | ||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_RANDOM; | ||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_SEQUENTIAL; | ||
| import static org.apache.hadoop.fs.Options.OpenFileOptions.FS_OPTION_OPENFILE_READ_POLICY_WHOLE_FILE; | ||
|
|
||
| /** | ||
| * Enum for ABFS Input Policies. | ||
| * Each policy maps to a particular implementation of {@link AbfsInputStream} | ||
| */ | ||
| public enum AbfsInputPolicy { | ||
|
||
|
|
||
| SEQUENTIAL(FS_OPTION_OPENFILE_READ_POLICY_SEQUENTIAL), | ||
| RANDOM(FS_OPTION_OPENFILE_READ_POLICY_RANDOM), | ||
| ADAPTIVE(FS_OPTION_OPENFILE_READ_POLICY_ADAPTIVE); | ||
|
|
||
| private final String policy; | ||
|
||
|
|
||
| AbfsInputPolicy(String policy) { | ||
| this.policy = policy; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return policy; | ||
| } | ||
|
|
||
| /** | ||
| * Get the enum constant from the string name. | ||
| * @param name policy name as configured by user | ||
| * @return the corresponding AbsInputPolicy to be used | ||
| */ | ||
| public static AbfsInputPolicy getPolicy(String name) { | ||
| String trimmed = name.trim().toLowerCase(Locale.ENGLISH); | ||
| switch (trimmed) { | ||
| // all these options currently map to random IO. | ||
| case FS_OPTION_OPENFILE_READ_POLICY_RANDOM: | ||
| case FS_OPTION_OPENFILE_READ_POLICY_COLUMNAR: | ||
| case FS_OPTION_OPENFILE_READ_POLICY_ORC: | ||
| case FS_OPTION_OPENFILE_READ_POLICY_PARQUET: | ||
| return RANDOM; | ||
|
|
||
| // handle the sequential formats. | ||
| case FS_OPTION_OPENFILE_READ_POLICY_SEQUENTIAL: | ||
| case FS_OPTION_OPENFILE_READ_POLICY_WHOLE_FILE: | ||
| return SEQUENTIAL; | ||
|
|
||
| // Everything else including ABFS Default Policy maps to Adaptive | ||
| case FS_OPTION_OPENFILE_READ_POLICY_ADAPTIVE: | ||
| default: | ||
| return ADAPTIVE; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
instead of importing entire Options class, we can just import OpenFileOptions class and directly mention OpenFileOptions class below in comments.
import org.apache.hadoop.fs.Options.OpenFileOptions;
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.
Taken