Skip to content

HDDS-17441. Interrupted short-circuit GetBlock fails with NPE and leaves the received block file stream open in XceiverClientShortCircuit #11835

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.

Sign up for GitHub

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

Merged
Gargi-jais11 merged 2 commits into from
Oct 30, 2026
Merged

HDDS-17441. Interrupted short-circuit GetBlock fails with NPE and leaves the received block file stream open in XceiverClientShortCircuit #11835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0524751
release scr streams of abandoned requests and fallback to grpc for In…
Gargi-jais11 Oct 28, 2026
0732d55
Merge branch 'master' of github.com:apache/ozone into HDDS-17441
Gargi-jais11 Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions hadoop-hdds/client/src/main/java/org/apache/hadoop/hdds/scm/XceiverClientShortCircuit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
import org.apache.hadoop.hdds.scm.storage.DomainSocketFactory;
import org.apache.hadoop.hdds.security.exception.SCMSecurityException;
import org.apache.hadoop.hdds.tracing.TracingUtil;
import org.apache.hadoop.hdds.utils.IOUtils;
import org.apache.hadoop.net.NetUtils;
import org.apache.hadoop.net.unix.DomainSocket;
import org.apache.hadoop.ozone.OzoneConfigKeys;
Expand Down Expand Up @@ -246,6 +247,7 @@ private XceiverClientReply sendCommandWithTraceID(
ContainerCommandResponseProto responseProto = null;
IOException ioException = null;
XceiverClientReply reply = new XceiverClientReply(null);
CompletableFuture<ContainerCommandResponseProto> future = null;

if (request.getCmdType() != ContainerProtos.Type.GetBlock &&
request.getCmdType() != ContainerProtos.Type.Echo) {
Expand All @@ -258,7 +260,8 @@ private XceiverClientReply sendCommandWithTraceID(
LOG.debug("Executing command {} on datanode {}", request, dn);
}
reply.addDatanode(dn);
responseProto = sendCommandInternal(finalPayload).getResponse().get();
future = sendCommandInternal(finalPayload).getResponse();
responseProto = future.get();
if (validators != null && !validators.isEmpty()) {
for (Validator validator : validators) {
validator.accept(request, responseProto);
Expand Down Expand Up @@ -287,13 +290,22 @@ private XceiverClientReply sendCommandWithTraceID(
} catch (InterruptedException e) {
LOG.error("Command execution was interrupted ", e);
Thread.currentThread().interrupt();
ioException = (IOException) new InterruptedIOException(
"Command " + processForDebug(request) + " was interrupted.").initCause(e);
}

if (responseProto != null) {
reply.setResponse(CompletableFuture.completedFuture(responseProto));
return reply;
} else {
Objects.requireNonNull(ioException);
if (future != null && request.getCmdType() == ContainerProtos.Type.GetBlock) {
// Complete the future before looking in the cache. If the stream has already arrived it is closed here;
// if it arrives later, the receiver thread finds the future completed and closes the stream itself.
future.completeExceptionally(ioException);
IOUtils.closeQuietly(getFileInputStream(finalPayload.getCallId(),
finalPayload.getGetBlock().getBlockID().getLocalID()));
}
String message = "Failed to execute command {}";
if (LOG.isDebugEnabled()) {
LOG.debug(message + " on the datanode {} {}.", request, dn, domainSocket, ioException);
Expand Down Expand Up @@ -473,6 +485,7 @@ public void run() {
long processStartTime = System.nanoTime();
ContainerProtos.Result result = responseProto.getResult();
if (result == ContainerProtos.Result.SUCCESS) {
BlockStreamKey streamKey = null;
if (type == ContainerProtos.Type.GetBlock) {
try {
ContainerProtos.GetBlockResponseProto getBlockResponse = responseProto.getGetBlock();
Expand All @@ -496,7 +509,8 @@ public void run() {
DATA_TRANSFER_MAGIC_CODE + ", Received: " + buf[0] + ")");
}
DatanodeBlockID blockID = getBlockResponse.getBlockData().getBlockID();
blockStreamCache.put(new BlockStreamKey(responseProto.getCallId(), blockID.getLocalID()), fis[0]);
streamKey = new BlockStreamKey(responseProto.getCallId(), blockID.getLocalID());
blockStreamCache.put(streamKey, fis[0]);
} catch (IOException e) {
LOG.warn("Failed to handle short-circuit information exchange", e);
// disable docket socket for a while
Expand All @@ -505,7 +519,10 @@ public void run() {
continue;
}
}
entry.getFuture().complete(responseProto);
if (!entry.getFuture().complete(responseProto) && streamKey != null) {
// the caller already gave up on this request, so nobody will claim the stream from the cache
IOUtils.closeQuietly(blockStreamCache.remove(streamKey));
}
} else {
// response result is not SUCCESS
entry.getFuture().complete(responseProto);
Expand Down
82 changes: 82 additions & 0 deletions .../integration-test/src/test/java/org/apache/hadoop/hdds/TestXceiverServerDomainSocket.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import static org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos.Type.ReadChunk;
import static org.apache.hadoop.hdds.scm.XceiverClientShortCircuit.vintPrefixed;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
Expand All @@ -38,6 +39,7 @@
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.ConnectException;
import java.net.InetSocketAddress;
import java.net.SocketException;
Expand All @@ -46,25 +48,30 @@
import java.nio.channels.FileChannel;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.RandomStringUtils;
import org.apache.commons.lang3.reflect.FieldUtils;
import org.apache.hadoop.hdds.client.BlockID;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.protocol.DatanodeDetails;
import org.apache.hadoop.hdds.protocol.MockDatanodeDetails;
import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos;
import org.apache.hadoop.hdds.scm.OzoneClientConfig;
import org.apache.hadoop.hdds.scm.ScmConfigKeys;
import org.apache.hadoop.hdds.scm.XceiverClientShortCircuit;
import org.apache.hadoop.hdds.scm.pipeline.MockPipeline;
import org.apache.hadoop.hdds.scm.pipeline.Pipeline;
import org.apache.hadoop.hdds.scm.storage.DomainSocketFactory;
import org.apache.hadoop.metrics2.lib.DefaultMetricsSystem;
import org.apache.hadoop.net.unix.DomainSocket;
import org.apache.hadoop.ozone.OzoneConfigKeys;
import org.apache.hadoop.ozone.common.Checksum;
Expand Down Expand Up @@ -130,6 +137,7 @@ public static void setup() {
clientConfig.setShortCircuitReadDisableInterval(1000);
DomainSocket.disableBindPathValidation();
conf.setFromObject(clientConfig);
DefaultMetricsSystem.setMiniClusterMode(true);
metrics = ContainerMetrics.create(conf);
readTimeout = 5 * 1000;
writeTimeout = 5 * 1000;
Expand Down Expand Up @@ -772,6 +780,76 @@ public void testGetBlockWithoutShortCircuitAccess() throws IOException {
}
}

/**
* The short-circuit client closes the block file stream of a GetBlock that its caller gave up on,
* whether the caller stops waiting before the response arrives or rejects the response after it arrived.
*/
@Test
public void testClientReleasesStreamOfAbandonedRequest() throws Exception {
conf.set(OzoneClientConfig.OZONE_DOMAIN_SOCKET_PATH, new File(dir, "ozone-socket").getAbsolutePath());
DomainSocketFactory factory = DomainSocketFactory.getInstance(conf);
XceiverServerDomainSocket server = new XceiverServerDomainSocket(MockDatanodeDetails.randomDatanodeDetails(),
conf, null, readExecutors, metrics, factory);
XceiverClientShortCircuit client = null;
try {
server.setContainerDispatcher(createDispatcherAndPrepareData(new File(dir, "dn-volume"), server, metrics));
server.start();
XceiverClientShortCircuit c = new XceiverClientShortCircuit(MockPipeline.createSingleNodePipeline(), conf,
MockDatanodeDetails.randomDatanodeDetails());
List<FileInputStream> received = Collections.synchronizedList(new ArrayList<>());
FieldUtils.writeField(c, "blockStreamCache", new ConcurrentHashMap<Object, FileInputStream>() {
@Override
public FileInputStream put(Object key, FileInputStream value) {
received.add(value);
return super.put(key, value);
}
}, true);
c.connect();
// close() fails on a client that never connected, so only a connected client is closed in finally
client = c;

// the server answers in order on its single read thread, so this delays the responses of the next requests
client.sendCommandInternal(getEchoRequest().toBuilder()
.setClientId(client.getClientId())
.setCallId(client.getCallId())
.setEcho(ContainerProtos.EchoRequestProto.newBuilder().setSleepTimeMs(500))
.build());

// the caller stops waiting before the response arrives
ContainerProtos.ContainerCommandRequestProto interrupted = getBlockRequestFor(client);
Thread.currentThread().interrupt();
assertThatThrownBy(() -> c.sendCommand(interrupted, null)).isInstanceOf(InterruptedIOException.class);
assertThat(Thread.interrupted()).isTrue();

// the caller rejects the response after it arrived
ContainerProtos.ContainerCommandRequestProto rejected = getBlockRequestFor(client);
assertThatThrownBy(() -> c.sendCommand(rejected, Collections.singletonList((request, response) -> {
throw new IOException("rejected");
}))).isInstanceOf(IOException.class).hasMessage("rejected");

// responses arrive in order, so the ones above are handled once this one returns
ContainerProtos.ContainerCommandRequestProto claimed = getBlockRequestFor(client);
assertThat(client.sendCommand(claimed, null).getResult()).isEqualTo(ContainerProtos.Result.SUCCESS);
assertThat(received).hasSize(3);
long localID = claimed.getGetBlock().getBlockID().getLocalID();
try (FileInputStream in = client.getFileInputStream(claimed.getCallId(), localID)) {
assertThat(in).isSameAs(received.get(2));
assertThat(in.getFD().valid()).isTrue();
}
assertThat(client.getFileInputStream(interrupted.getCallId(), localID)).isNull();
assertThat(client.getFileInputStream(rejected.getCallId(), localID)).isNull();
assertThat(received.get(0).getFD().valid()).isFalse();
assertThat(received.get(1).getFD().valid()).isFalse();
} finally {
Thread.interrupted();
if (client != null) {
client.close();
}
factory.close();
server.stop();
}
}

private static void sendRequest(DataOutputStream outputStream, ContainerProtos.ContainerCommandRequestProto request)
throws IOException {
outputStream.writeShort(OzoneClientConfig.DATA_TRANSFER_VERSION);
Expand Down Expand Up @@ -811,6 +889,10 @@ private ContainerProtos.ContainerCommandRequestProto getBlockRequest() {
return getBlockRequest(1, true);
}

private ContainerProtos.ContainerCommandRequestProto getBlockRequestFor(XceiverClientShortCircuit client) {
return getBlockRequest().toBuilder().setClientId(client.getClientId()).setCallId(client.getCallId()).build();
}

private ContainerProtos.ContainerCommandRequestProto getBlockRequest(long localID, boolean shortCircuit) {
long value = 1;
String datanodeUUID = UUID.randomUUID().toString();
Expand Down
Loading