bhattmanish98 commented on code in PR #7272: URL: https://github.com/apache/hadoop/pull/7272#discussion_r1908409767
########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDfsToBlobIngressFallbackHandler.java: ########## @@ -0,0 +1,259 @@ +/** + * 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 java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.classification.VisibleForTesting; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.AbfsRestOperationException; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.AzureBlobFileSystemException; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.InvalidIngressServiceException; +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +/** + * Handles the fallback mechanism for Azure Blob Ingress operations. + */ +public class AzureDfsToBlobIngressFallbackHandler extends AzureDFSIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private final AzureBlobBlockManager blobBlockManager; + + private String eTag; + + private final Lock lock = new ReentrantLock(); + + /** + * Constructs an AzureDfsToBlobIngressFallbackHandler. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + * @throws AzureBlobFileSystemException if an error occurs. + */ + public AzureDfsToBlobIngressFallbackHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) throws AzureBlobFileSystemException { + super(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.blobBlockManager = new AzureBlobBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new BlobFallbackIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return super.bufferData(block, data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + AbfsRestOperation op; + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); Review Comment: Same as above. ########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDfsToBlobIngressFallbackHandler.java: ########## @@ -0,0 +1,259 @@ +/** + * 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 java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.classification.VisibleForTesting; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.AbfsRestOperationException; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.AzureBlobFileSystemException; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.InvalidIngressServiceException; +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +/** + * Handles the fallback mechanism for Azure Blob Ingress operations. + */ +public class AzureDfsToBlobIngressFallbackHandler extends AzureDFSIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private final AzureBlobBlockManager blobBlockManager; + + private String eTag; + + private final Lock lock = new ReentrantLock(); + + /** + * Constructs an AzureDfsToBlobIngressFallbackHandler. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + * @throws AzureBlobFileSystemException if an error occurs. + */ + public AzureDfsToBlobIngressFallbackHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) throws AzureBlobFileSystemException { + super(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.blobBlockManager = new AzureBlobBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new BlobFallbackIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return super.bufferData(block, data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + AbfsRestOperation op; + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); + tracingContextAppend.setIngressHandler("FBAppend T " + threadIdStr); + tracingContextAppend.setPosition(String.valueOf(blockToUpload.getOffset())); + try { + op = super.remoteWrite(blockToUpload, uploadData, reqParams, + tracingContextAppend); + blobBlockManager.updateEntry(blockToUpload); + } catch (AbfsRestOperationException ex) { + if (shouldIngressHandlerBeSwitched(ex)) { + LOG.error("Error in remote write requiring handler switch for path {}", abfsOutputStream.getPath(), ex); + throw getIngressHandlerSwitchException(ex); + } + LOG.error("Error in remote write for path {} and offset {}", abfsOutputStream.getPath(), + blockToUpload.getOffset(), ex); + throw ex; + } + return op; + } + + /** + * Flushes data to the remote store. + * + * @param offset the offset to flush. + * @param retainUncommitedData whether to retain uncommitted data. + * @param isClose whether this is a close operation. + * @param leaseId the lease ID. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected synchronized AbfsRestOperation remoteFlush(final long offset, + final boolean retainUncommitedData, + final boolean isClose, + final String leaseId, + TracingContext tracingContext) throws IOException { + AbfsRestOperation op; + if (!blobBlockManager.hasListToCommit()) { + return null; + } + try { + TracingContext tracingContextFlush = new TracingContext(tracingContext); + tracingContextFlush.setIngressHandler("FBFlush"); + tracingContextFlush.setPosition(String.valueOf(offset)); + op = super.remoteFlush(offset, retainUncommitedData, isClose, leaseId, + tracingContextFlush); + } catch (AbfsRestOperationException ex) { + if (shouldIngressHandlerBeSwitched(ex)) { + LOG.error("Error in remote flush requiring handler switch for path {}", abfsOutputStream.getPath(), ex); + throw getIngressHandlerSwitchException(ex); + } + LOG.error("Error in remote flush for path {} and offset {}", abfsOutputStream.getPath(), offset, ex); + throw ex; + } + return op; + } + + /** + * Gets the block manager. + * + * @return the block manager. + */ + @Override + public AzureBlockManager getBlockManager() { + return blobBlockManager; + } + + /** + * Gets the eTag value of the blob. + * + * @return the eTag. + */ + @VisibleForTesting + public String getETag() { + lock.lock(); + try { + return eTag; + } finally { + lock.unlock(); + } + } + + /** + * Appending the current active data block to the service. Clearing the active + * data block and releasing all buffered data. + * + * @throws IOException if there is any failure while starting an upload for + * the data block or while closing the BlockUploadData. + */ + @Override + protected void writeAppendBlobCurrentBufferToService() throws IOException { + AbfsBlock activeBlock = blobBlockManager.getActiveBlock(); + + // No data, return immediately. + if (!abfsOutputStream.hasActiveBlockDataToUpload()) { + return; + } + + // Prepare data for upload. + final int bytesLength = activeBlock.dataSize(); + DataBlocks.BlockUploadData uploadData = activeBlock.startUpload(); + + // Clear active block and update statistics. + blobBlockManager.clearActiveBlock(); + abfsOutputStream.getOutputStreamStatistics().writeCurrentBuffer(); + abfsOutputStream.getOutputStreamStatistics().bytesToUpload(bytesLength); + + // Update the stream position. + final long offset = abfsOutputStream.getPosition(); + abfsOutputStream.setPosition(offset + bytesLength); + + // Perform the upload within a performance tracking context. + try (AbfsPerfInfo perfInfo = new AbfsPerfInfo( + getClient().getAbfsPerfTracker(), + "writeCurrentBufferToService", "append")) { Review Comment: Same as above, constant for append. ########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDFSIngressHandler.java: ########## @@ -0,0 +1,275 @@ +/** + * 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.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +import static org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.EMPTY_STRING; + +/** + * The BlobFsOutputStream for Rest AbfsClient. + */ +public class AzureDFSIngressHandler extends AzureIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private AzureDFSBlockManager dfsBlockManager; + + private final AbfsDfsClient dfsClient; + + private String eTag; + + /** + * Constructs an AzureDFSIngressHandler. + * + * @param abfsOutputStream the AbfsOutputStream instance. + * @param clientHandler the AbfsClientHandler instance. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + AbfsClientHandler clientHandler) { + super(abfsOutputStream); + this.dfsClient = clientHandler.getDfsClient(); + } + + /** + * Constructs an AzureDFSIngressHandler with specified parameters. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) { + this(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.dfsBlockManager = new AzureDFSBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new DFSIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) + throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return block.write(data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); Review Comment: Same as above, if threadIf is getting used at only one place, can we keep it inplace? ########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDfsToBlobIngressFallbackHandler.java: ########## @@ -0,0 +1,259 @@ +/** + * 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 java.util.concurrent.locks.Lock; +import java.util.concurrent.locks.ReentrantLock; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.classification.VisibleForTesting; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.AbfsRestOperationException; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.AzureBlobFileSystemException; +import org.apache.hadoop.fs.azurebfs.contracts.exceptions.InvalidIngressServiceException; +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +/** + * Handles the fallback mechanism for Azure Blob Ingress operations. + */ +public class AzureDfsToBlobIngressFallbackHandler extends AzureDFSIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private final AzureBlobBlockManager blobBlockManager; + + private String eTag; + + private final Lock lock = new ReentrantLock(); + + /** + * Constructs an AzureDfsToBlobIngressFallbackHandler. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + * @throws AzureBlobFileSystemException if an error occurs. + */ + public AzureDfsToBlobIngressFallbackHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) throws AzureBlobFileSystemException { + super(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.blobBlockManager = new AzureBlobBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new BlobFallbackIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return super.bufferData(block, data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + AbfsRestOperation op; + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); + tracingContextAppend.setIngressHandler("FBAppend T " + threadIdStr); + tracingContextAppend.setPosition(String.valueOf(blockToUpload.getOffset())); + try { + op = super.remoteWrite(blockToUpload, uploadData, reqParams, + tracingContextAppend); + blobBlockManager.updateEntry(blockToUpload); + } catch (AbfsRestOperationException ex) { + if (shouldIngressHandlerBeSwitched(ex)) { + LOG.error("Error in remote write requiring handler switch for path {}", abfsOutputStream.getPath(), ex); + throw getIngressHandlerSwitchException(ex); + } + LOG.error("Error in remote write for path {} and offset {}", abfsOutputStream.getPath(), + blockToUpload.getOffset(), ex); + throw ex; + } + return op; + } + + /** + * Flushes data to the remote store. + * + * @param offset the offset to flush. + * @param retainUncommitedData whether to retain uncommitted data. + * @param isClose whether this is a close operation. + * @param leaseId the lease ID. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected synchronized AbfsRestOperation remoteFlush(final long offset, + final boolean retainUncommitedData, + final boolean isClose, + final String leaseId, + TracingContext tracingContext) throws IOException { + AbfsRestOperation op; + if (!blobBlockManager.hasListToCommit()) { + return null; + } + try { + TracingContext tracingContextFlush = new TracingContext(tracingContext); + tracingContextFlush.setIngressHandler("FBFlush"); Review Comment: Same as above, constant for FBFlush ########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDFSIngressHandler.java: ########## @@ -0,0 +1,275 @@ +/** + * 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.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +import static org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.EMPTY_STRING; + +/** + * The BlobFsOutputStream for Rest AbfsClient. + */ +public class AzureDFSIngressHandler extends AzureIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private AzureDFSBlockManager dfsBlockManager; + + private final AbfsDfsClient dfsClient; + + private String eTag; + + /** + * Constructs an AzureDFSIngressHandler. + * + * @param abfsOutputStream the AbfsOutputStream instance. + * @param clientHandler the AbfsClientHandler instance. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + AbfsClientHandler clientHandler) { + super(abfsOutputStream); + this.dfsClient = clientHandler.getDfsClient(); + } + + /** + * Constructs an AzureDFSIngressHandler with specified parameters. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) { + this(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.dfsBlockManager = new AzureDFSBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new DFSIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) + throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return block.write(data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); + if (tracingContextAppend.getIngressHandler().equals(EMPTY_STRING)) { + tracingContextAppend.setIngressHandler("DAppend T " + threadIdStr); + tracingContextAppend.setPosition( + String.valueOf(blockToUpload.getOffset())); + } + LOG.trace("Starting remote write for block with offset {} and path {}", blockToUpload.getOffset(), abfsOutputStream.getPath()); + return getClient().append(abfsOutputStream.getPath(), + uploadData.toByteArray(), reqParams, + abfsOutputStream.getCachedSasTokenString(), + abfsOutputStream.getContextEncryptionAdapter(), + tracingContextAppend); + } + + /** + * Method to perform a remote write operation for appending data to an append blob in Azure Blob Storage. + * + * <p>This method is intended to be implemented by subclasses to handle the specific + * case of appending data to an append blob. It takes in the path of the append blob, + * the data to be uploaded, the block of data, and additional parameters required for + * the append operation.</p> + * + * @param path The path of the append blob to which data is to be appended. + * @param uploadData The data to be uploaded as part of the append operation. + * @param block The block of data to append. + * @param reqParams The additional parameters required for the append operation. + * @param tracingContext The tracing context for the operation. + * @return An {@link AbfsRestOperation} object representing the remote write operation. + * @throws IOException If an I/O error occurs during the append operation. + */ + @Override + protected AbfsRestOperation remoteAppendBlobWrite(String path, DataBlocks.BlockUploadData uploadData, + AbfsBlock block, AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + return remoteWrite(block, uploadData, reqParams, tracingContext); + } + + /** + * Flushes data to the remote store. + * + * @param offset the offset to flush. + * @param retainUncommitedData whether to retain uncommitted data. + * @param isClose whether this is a close operation. + * @param leaseId the lease ID. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected synchronized AbfsRestOperation remoteFlush(final long offset, + final boolean retainUncommitedData, + final boolean isClose, + final String leaseId, + TracingContext tracingContext) + throws IOException { + TracingContext tracingContextFlush = new TracingContext(tracingContext); + if (tracingContextFlush.getIngressHandler().equals(EMPTY_STRING)) { + tracingContextFlush.setIngressHandler("DFlush"); + tracingContextFlush.setPosition(String.valueOf(offset)); + } + LOG.trace("Flushing data at offset {} and path {}", offset, abfsOutputStream.getPath()); + return getClient() + .flush(abfsOutputStream.getPath(), offset, retainUncommitedData, + isClose, + abfsOutputStream.getCachedSasTokenString(), leaseId, + abfsOutputStream.getContextEncryptionAdapter(), + tracingContextFlush); + } + + /** + * Appending the current active data block to the service. Clearing the active + * data block and releasing all buffered data. + * + * @throws IOException if there is any failure while starting an upload for + * the data block or while closing the BlockUploadData. + */ + @Override + protected void writeAppendBlobCurrentBufferToService() throws IOException { + AbfsBlock activeBlock = dfsBlockManager.getActiveBlock(); + + // No data, return immediately. + if (!abfsOutputStream.hasActiveBlockDataToUpload()) { + return; + } + + // Prepare data for upload. + final int bytesLength = activeBlock.dataSize(); + DataBlocks.BlockUploadData uploadData = activeBlock.startUpload(); + + // Clear active block and update statistics. + dfsBlockManager.clearActiveBlock(); + abfsOutputStream.getOutputStreamStatistics().writeCurrentBuffer(); + abfsOutputStream.getOutputStreamStatistics().bytesToUpload(bytesLength); + + // Update the stream position. + final long offset = abfsOutputStream.getPosition(); + abfsOutputStream.setPosition(offset + bytesLength); + + // Perform the upload within a performance tracking context. + try (AbfsPerfInfo perfInfo = new AbfsPerfInfo( + dfsClient.getAbfsPerfTracker(), + "writeCurrentBufferToService", "append")) { + LOG.trace("Writing current buffer to service at offset {} and path {}", offset, abfsOutputStream.getPath()); + AppendRequestParameters reqParams = new AppendRequestParameters( + offset, 0, bytesLength, AppendRequestParameters.Mode.APPEND_MODE, + true, abfsOutputStream.getLeaseId(), abfsOutputStream.isExpectHeaderEnabled()); + + // Perform the remote write operation. + AbfsRestOperation op = remoteWrite(activeBlock, uploadData, reqParams, + new TracingContext(abfsOutputStream.getTracingContext())); + + // Update the SAS token and log the successful upload. + abfsOutputStream.getCachedSasToken().update(op.getSasToken()); + abfsOutputStream.getOutputStreamStatistics().uploadSuccessful(bytesLength); + + // Register performance information. + perfInfo.registerResult(op.getResult()); + perfInfo.registerSuccess(true); + } catch (Exception ex) { + LOG.error("Failed to upload current buffer of length {} and path {}", bytesLength, abfsOutputStream.getPath(), ex); + abfsOutputStream.getOutputStreamStatistics().uploadFailed(bytesLength); + abfsOutputStream.failureWhileSubmit(ex); + } finally { + // Ensure the upload data stream is closed. + IOUtils.closeStreams(uploadData, activeBlock); + } + } + Review Comment: Please remove 1 extra empty line. ########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDFSIngressHandler.java: ########## @@ -0,0 +1,275 @@ +/** + * 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.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +import static org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.EMPTY_STRING; + +/** + * The BlobFsOutputStream for Rest AbfsClient. + */ +public class AzureDFSIngressHandler extends AzureIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private AzureDFSBlockManager dfsBlockManager; + + private final AbfsDfsClient dfsClient; + + private String eTag; + + /** + * Constructs an AzureDFSIngressHandler. + * + * @param abfsOutputStream the AbfsOutputStream instance. + * @param clientHandler the AbfsClientHandler instance. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + AbfsClientHandler clientHandler) { + super(abfsOutputStream); + this.dfsClient = clientHandler.getDfsClient(); + } + + /** + * Constructs an AzureDFSIngressHandler with specified parameters. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) { + this(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.dfsBlockManager = new AzureDFSBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new DFSIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) + throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return block.write(data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); + if (tracingContextAppend.getIngressHandler().equals(EMPTY_STRING)) { + tracingContextAppend.setIngressHandler("DAppend T " + threadIdStr); + tracingContextAppend.setPosition( + String.valueOf(blockToUpload.getOffset())); + } + LOG.trace("Starting remote write for block with offset {} and path {}", blockToUpload.getOffset(), abfsOutputStream.getPath()); + return getClient().append(abfsOutputStream.getPath(), + uploadData.toByteArray(), reqParams, + abfsOutputStream.getCachedSasTokenString(), + abfsOutputStream.getContextEncryptionAdapter(), + tracingContextAppend); + } + + /** + * Method to perform a remote write operation for appending data to an append blob in Azure Blob Storage. + * + * <p>This method is intended to be implemented by subclasses to handle the specific + * case of appending data to an append blob. It takes in the path of the append blob, + * the data to be uploaded, the block of data, and additional parameters required for + * the append operation.</p> + * + * @param path The path of the append blob to which data is to be appended. + * @param uploadData The data to be uploaded as part of the append operation. + * @param block The block of data to append. + * @param reqParams The additional parameters required for the append operation. + * @param tracingContext The tracing context for the operation. + * @return An {@link AbfsRestOperation} object representing the remote write operation. + * @throws IOException If an I/O error occurs during the append operation. + */ + @Override + protected AbfsRestOperation remoteAppendBlobWrite(String path, DataBlocks.BlockUploadData uploadData, + AbfsBlock block, AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + return remoteWrite(block, uploadData, reqParams, tracingContext); + } + + /** + * Flushes data to the remote store. + * + * @param offset the offset to flush. + * @param retainUncommitedData whether to retain uncommitted data. + * @param isClose whether this is a close operation. + * @param leaseId the lease ID. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected synchronized AbfsRestOperation remoteFlush(final long offset, + final boolean retainUncommitedData, + final boolean isClose, + final String leaseId, + TracingContext tracingContext) + throws IOException { + TracingContext tracingContextFlush = new TracingContext(tracingContext); + if (tracingContextFlush.getIngressHandler().equals(EMPTY_STRING)) { + tracingContextFlush.setIngressHandler("DFlush"); Review Comment: Can we create constant for DFlush and use it whereever required? ########## hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/services/AzureDFSIngressHandler.java: ########## @@ -0,0 +1,275 @@ +/** + * 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.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.fs.azurebfs.contracts.services.AppendRequestParameters; +import org.apache.hadoop.fs.azurebfs.utils.TracingContext; +import org.apache.hadoop.fs.store.DataBlocks; +import org.apache.hadoop.io.IOUtils; + +import static org.apache.hadoop.fs.azurebfs.constants.AbfsHttpConstants.EMPTY_STRING; + +/** + * The BlobFsOutputStream for Rest AbfsClient. + */ +public class AzureDFSIngressHandler extends AzureIngressHandler { + + private static final Logger LOG = LoggerFactory.getLogger( + AbfsOutputStream.class); + + private AzureDFSBlockManager dfsBlockManager; + + private final AbfsDfsClient dfsClient; + + private String eTag; + + /** + * Constructs an AzureDFSIngressHandler. + * + * @param abfsOutputStream the AbfsOutputStream instance. + * @param clientHandler the AbfsClientHandler instance. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + AbfsClientHandler clientHandler) { + super(abfsOutputStream); + this.dfsClient = clientHandler.getDfsClient(); + } + + /** + * Constructs an AzureDFSIngressHandler with specified parameters. + * + * @param abfsOutputStream the AbfsOutputStream. + * @param blockFactory the block factory. + * @param bufferSize the buffer size. + * @param eTag the eTag. + * @param clientHandler the client handler. + */ + public AzureDFSIngressHandler(AbfsOutputStream abfsOutputStream, + DataBlocks.BlockFactory blockFactory, + int bufferSize, String eTag, AbfsClientHandler clientHandler) { + this(abfsOutputStream, clientHandler); + this.eTag = eTag; + this.dfsBlockManager = new AzureDFSBlockManager(this.abfsOutputStream, + blockFactory, bufferSize); + LOG.trace( + "Created a new DFSIngress Handler for AbfsOutputStream instance {} for path {}", + abfsOutputStream.getStreamID(), abfsOutputStream.getPath()); + } + + /** + * Buffers data into the specified block. + * + * @param block the block to buffer data into. + * @param data the data to be buffered. + * @param off the start offset in the data. + * @param length the number of bytes to buffer. + * @return the number of bytes buffered. + * @throws IOException if an I/O error occurs. + */ + @Override + public int bufferData(AbfsBlock block, + final byte[] data, + final int off, + final int length) + throws IOException { + LOG.trace("Buffering data of length {} to block at offset {}", length, off); + return block.write(data, off, length); + } + + /** + * Performs a remote write operation. + * + * @param blockToUpload the block to upload. + * @param uploadData the data to upload. + * @param reqParams the request parameters. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected AbfsRestOperation remoteWrite(AbfsBlock blockToUpload, + DataBlocks.BlockUploadData uploadData, + AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + TracingContext tracingContextAppend = new TracingContext(tracingContext); + long threadId = Thread.currentThread().getId(); + String threadIdStr = String.valueOf(threadId); + if (tracingContextAppend.getIngressHandler().equals(EMPTY_STRING)) { + tracingContextAppend.setIngressHandler("DAppend T " + threadIdStr); + tracingContextAppend.setPosition( + String.valueOf(blockToUpload.getOffset())); + } + LOG.trace("Starting remote write for block with offset {} and path {}", blockToUpload.getOffset(), abfsOutputStream.getPath()); + return getClient().append(abfsOutputStream.getPath(), + uploadData.toByteArray(), reqParams, + abfsOutputStream.getCachedSasTokenString(), + abfsOutputStream.getContextEncryptionAdapter(), + tracingContextAppend); + } + + /** + * Method to perform a remote write operation for appending data to an append blob in Azure Blob Storage. + * + * <p>This method is intended to be implemented by subclasses to handle the specific + * case of appending data to an append blob. It takes in the path of the append blob, + * the data to be uploaded, the block of data, and additional parameters required for + * the append operation.</p> + * + * @param path The path of the append blob to which data is to be appended. + * @param uploadData The data to be uploaded as part of the append operation. + * @param block The block of data to append. + * @param reqParams The additional parameters required for the append operation. + * @param tracingContext The tracing context for the operation. + * @return An {@link AbfsRestOperation} object representing the remote write operation. + * @throws IOException If an I/O error occurs during the append operation. + */ + @Override + protected AbfsRestOperation remoteAppendBlobWrite(String path, DataBlocks.BlockUploadData uploadData, + AbfsBlock block, AppendRequestParameters reqParams, + TracingContext tracingContext) throws IOException { + return remoteWrite(block, uploadData, reqParams, tracingContext); + } + + /** + * Flushes data to the remote store. + * + * @param offset the offset to flush. + * @param retainUncommitedData whether to retain uncommitted data. + * @param isClose whether this is a close operation. + * @param leaseId the lease ID. + * @param tracingContext the tracing context. + * @return the resulting AbfsRestOperation. + * @throws IOException if an I/O error occurs. + */ + @Override + protected synchronized AbfsRestOperation remoteFlush(final long offset, + final boolean retainUncommitedData, + final boolean isClose, + final String leaseId, + TracingContext tracingContext) + throws IOException { + TracingContext tracingContextFlush = new TracingContext(tracingContext); + if (tracingContextFlush.getIngressHandler().equals(EMPTY_STRING)) { + tracingContextFlush.setIngressHandler("DFlush"); + tracingContextFlush.setPosition(String.valueOf(offset)); + } + LOG.trace("Flushing data at offset {} and path {}", offset, abfsOutputStream.getPath()); + return getClient() + .flush(abfsOutputStream.getPath(), offset, retainUncommitedData, + isClose, + abfsOutputStream.getCachedSasTokenString(), leaseId, + abfsOutputStream.getContextEncryptionAdapter(), + tracingContextFlush); + } + + /** + * Appending the current active data block to the service. Clearing the active + * data block and releasing all buffered data. + * + * @throws IOException if there is any failure while starting an upload for + * the data block or while closing the BlockUploadData. + */ + @Override + protected void writeAppendBlobCurrentBufferToService() throws IOException { + AbfsBlock activeBlock = dfsBlockManager.getActiveBlock(); + + // No data, return immediately. + if (!abfsOutputStream.hasActiveBlockDataToUpload()) { + return; + } + + // Prepare data for upload. + final int bytesLength = activeBlock.dataSize(); + DataBlocks.BlockUploadData uploadData = activeBlock.startUpload(); + + // Clear active block and update statistics. + dfsBlockManager.clearActiveBlock(); + abfsOutputStream.getOutputStreamStatistics().writeCurrentBuffer(); + abfsOutputStream.getOutputStreamStatistics().bytesToUpload(bytesLength); + + // Update the stream position. + final long offset = abfsOutputStream.getPosition(); + abfsOutputStream.setPosition(offset + bytesLength); + + // Perform the upload within a performance tracking context. + try (AbfsPerfInfo perfInfo = new AbfsPerfInfo( + dfsClient.getAbfsPerfTracker(), + "writeCurrentBufferToService", "append")) { Review Comment: can we create constant for append? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
