Skip to content

Implement UDP transport for air-gap sink #17954

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

Open
Caideyipi wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Implement UDP transport for air-gap sink #17954

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
3144e61
Implement UDP transport for air-gap sink
Caideyipi Jun 16, 2026
50aa7a8
Update IoTDBDataRegionAirGapSinkTest.java
Caideyipi Jun 16, 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
131 changes: 99 additions & 32 deletions .../src/main/java/org/apache/iotdb/db/pipe/receiver/protocol/airgap/IoTDBAirGapReceiver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,14 @@
import org.slf4j.LoggerFactory;

import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.Socket;
import java.net.SocketAddress;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.zip.CRC32;
Expand All @@ -61,6 +65,9 @@
private final IoTDBDataNodeReceiverAgent agent;

private boolean isELanguagePayload;
private OutputStream currentOutputStream;
private DatagramSocket currentDatagramSocket;
private SocketAddress currentRemoteSocketAddress;

public IoTDBAirGapReceiver(final Socket socket, final long receiverId) {
this.socket = socket;
Expand Down Expand Up @@ -101,33 +108,11 @@

try {
final byte[] data = readData(inputStream);
currentOutputStream = socket.getOutputStream();

// If check sum failed, it indicates that the length we read may not be correct.
// Namely, there may be remaining bytes in the socket stream, which will fail any subsequent
// attempts to read from that.
// We directly close the socket here.
if (!checkSum(data)) {
LOGGER.warn(
DataNodePipeMessages.PIPE_AIR_GAP_RECEIVER_CLOSED_BECAUSE_OF, receiverId, socket);
try {
fail();
} finally {
socket.close();
}
return;
if (!receive(data, null)) {
socket.close();
}

// Removed the used checksum
final ByteBuffer byteBuffer = ByteBuffer.wrap(data, LONG_LEN, data.length - LONG_LEN);

// Pseudo request, to reuse logic in IoTDBThriftReceiverAgent
final AirGapPseudoTPipeTransferRequest req =
(AirGapPseudoTPipeTransferRequest)
new AirGapPseudoTPipeTransferRequest()
.setVersion(ReadWriteIOUtils.readByte(byteBuffer))
.setType(ReadWriteIOUtils.readShort(byteBuffer))
.setBody(byteBuffer.slice());
handleReq(req, System.currentTimeMillis());
} catch (final PipeConnectionException e) {
LOGGER.info(
DataNodePipeMessages.PIPE_AIR_GAP_RECEIVER_SOCKET_CLOSED_WHEN,
Expand All @@ -145,9 +130,82 @@
}
}

boolean receive(final byte[] data, final String receiverKey) throws IOException {
try {
// If check sum failed, it indicates that the length we read may not be correct.
// Namely, there may be remaining bytes in the socket stream, which will fail any subsequent
// attempts to read from that.
if (!checkSum(data)) {
LOGGER.warn(
DataNodePipeMessages.PIPE_AIR_GAP_RECEIVER_CLOSED_BECAUSE_OF, receiverId, socket);
fail();
return false;
}

handleReq(toTPipeTransferReq(data), System.currentTimeMillis(), receiverKey);
return true;
} catch (final IOException e) {
throw e;
} catch (final Exception e) {
if (currentDatagramSocket != null) {
fail();
}
throw e;
} finally {
currentOutputStream = null;
currentDatagramSocket = null;
currentRemoteSocketAddress = null;
}
}

void receiveUdp(
final DatagramSocket datagramSocket,
final DatagramPacket packet,
final String receiverKey,
final byte[] buffer)
throws IOException {
isELanguagePayload = false;
currentDatagramSocket = datagramSocket;
currentRemoteSocketAddress = packet.getSocketAddress();
boolean requestHandlingStarted = false;
try {

Check failure on line 171 in iotdb-core/datanode/src/main/java/org/apache/iotdb/db/pipe/receiver/protocol/airgap/IoTDBAirGapReceiver.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Change this "try" to a try-with-resources. 


See more on https://sonarcloud.io/project/issues?id=apache_iotdb&issues=AZ7PhGyCn2LVdY1Jq54q&open=AZ7PhGyCn2LVdY1Jq54q&pullRequest=17954
final byte[] data = readData(new ByteArrayInputStream(buffer, 0, packet.getLength()));
requestHandlingStarted = true;
receive(data, receiverKey);
} catch (final Exception e) {
if (!requestHandlingStarted) {
fail();
}
throw e;
} finally {
currentOutputStream = null;
currentDatagramSocket = null;
currentRemoteSocketAddress = null;
}
}

private AirGapPseudoTPipeTransferRequest toTPipeTransferReq(final byte[] data) {
// Removed the used checksum
final ByteBuffer byteBuffer = ByteBuffer.wrap(data, LONG_LEN, data.length - LONG_LEN);

// Pseudo request, to reuse logic in IoTDBThriftReceiverAgent
return (AirGapPseudoTPipeTransferRequest)
new AirGapPseudoTPipeTransferRequest()
.setVersion(ReadWriteIOUtils.readByte(byteBuffer))
.setType(ReadWriteIOUtils.readShort(byteBuffer))
.setBody(byteBuffer.slice());
}

private void handleReq(final AirGapPseudoTPipeTransferRequest req, final long startTime)

Check warning on line 199 in iotdb-core/datanode/src/main/java/org/apache/iotdb/db/pipe/receiver/protocol/airgap/IoTDBAirGapReceiver.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Remove this unused private "handleReq" method. 


See more on https://sonarcloud.io/project/issues?id=apache_iotdb&issues=AZ7PhGyCn2LVdY1Jq54p&open=AZ7PhGyCn2LVdY1Jq54p&pullRequest=17954
throws IOException {
final TPipeTransferResp resp = agent.receive(req);
handleReq(req, startTime, null);
}

private void handleReq(
final AirGapPseudoTPipeTransferRequest req, final long startTime, final String receiverKey)
throws IOException {
final TPipeTransferResp resp =
receiverKey == null ? agent.receive(req) : agent.receive(receiverKey, req);

final TSStatus status = resp.getStatus();
if (status.getCode() == TSStatusCode.SUCCESS_STATUS.getStatusCode()) {
Expand All @@ -170,7 +228,7 @@
LOGGER.info(DataNodePipeMessages.TEMPORARY_UNAVAILABLE_EXCEPTION_ENCOUNTERED_AT_AIR_GAP);
if (System.currentTimeMillis() - startTime
< PipeConfig.getInstance().getPipeAirGapRetryMaxMs()) {
handleReq(req, startTime);
handleReq(req, startTime, receiverKey);
} else {
LOGGER.warn(
DataNodePipeMessages.PIPE_AIR_GAP_RECEIVER_TEMPORARY_UNAVAILABLE_RETRY, receiverId);
Expand All @@ -187,14 +245,23 @@
}

private void ok() throws IOException {
final OutputStream outputStream = socket.getOutputStream();
outputStream.write(AirGapOneByteResponse.OK);
outputStream.flush();
respond(AirGapOneByteResponse.OK);
}

private void fail() throws IOException {
final OutputStream outputStream = socket.getOutputStream();
outputStream.write(AirGapOneByteResponse.FAIL);
respond(AirGapOneByteResponse.FAIL);
}

private void respond(final byte[] response) throws IOException {
if (currentDatagramSocket != null && currentRemoteSocketAddress != null) {
currentDatagramSocket.send(
new DatagramPacket(response, response.length, currentRemoteSocketAddress));
return;
}

final OutputStream outputStream =
currentOutputStream != null ? currentOutputStream : socket.getOutputStream();
outputStream.write(response);
outputStream.flush();
}

Expand Down
106 changes: 104 additions & 2 deletions ...main/java/org/apache/iotdb/db/pipe/receiver/protocol/airgap/IoTDBAirGapReceiverAgent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,44 @@
import org.apache.iotdb.commons.service.IService;
import org.apache.iotdb.commons.service.ServiceType;
import org.apache.iotdb.db.i18n.DataNodePipeMessages;
import org.apache.iotdb.db.pipe.agent.PipeDataNodeAgent;
import org.apache.iotdb.db.protocol.session.ClientSession;
import org.apache.iotdb.db.protocol.session.SessionManager;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicLong;

public class IoTDBAirGapReceiverAgent implements IService {

private static final Logger LOGGER = LoggerFactory.getLogger(IoTDBAirGapReceiverAgent.class);
private static final int UDP_PACKET_MAX_SIZE_IN_BYTES = 65_507;

private final ExecutorService listenExecutor =
IoTDBThreadPoolFactory.newSingleThreadExecutor(
ThreadName.PIPE_RECEIVER_AIR_GAP_AGENT.getName());
private final ExecutorService udpListenExecutor =
IoTDBThreadPoolFactory.newSingleThreadExecutor(
ThreadName.PIPE_RECEIVER_AIR_GAP_AGENT.getName() + "-UDP");
private final AtomicBoolean allowSubmitListen = new AtomicBoolean(false);

private ServerSocket serverSocket;
private DatagramSocket datagramSocket;

private final AtomicLong receiverId = new AtomicLong(0);
private final Map<String, ClientSession> udpClientSessions = new ConcurrentHashMap<>();

public void listen() {
try {
Expand All @@ -61,40 +75,107 @@ public void listen() {
ThreadName.PIPE_AIR_GAP_RECEIVER.getName() + "-" + airGapReceiverId);
airGapReceiverThread.start();
} catch (final IOException e) {
LOGGER.warn(DataNodePipeMessages.UNHANDLED_EXCEPTION_DURING_PIPE_AIR_GAP_RECEIVER, e);
if (allowSubmitListen.get()) {
LOGGER.warn(DataNodePipeMessages.UNHANDLED_EXCEPTION_DURING_PIPE_AIR_GAP_RECEIVER, e);
}
}

if (allowSubmitListen.get()) {
listenExecutor.submit(this::listen);
}
}

public void listenUdp() {
while (allowSubmitListen.get() && !datagramSocket.isClosed()) {
final byte[] buffer = new byte[UDP_PACKET_MAX_SIZE_IN_BYTES];
final DatagramPacket packet = new DatagramPacket(buffer, buffer.length);
try {
datagramSocket.receive(packet);

final long airGapReceiverId = receiverId.incrementAndGet();
final IoTDBAirGapReceiver receiver =
new IoTDBAirGapReceiver(new Socket(), airGapReceiverId);
final String receiverKey = packet.getSocketAddress().toString();
final boolean registeredSession = registerUdpSessionIfNecessary(packet);
try {
receiver.receiveUdp(datagramSocket, packet, receiverKey, buffer);
} finally {
if (registeredSession) {
SessionManager.getInstance().removeCurrSession();
}
}
} catch (final IOException e) {
if (allowSubmitListen.get()) {
LOGGER.warn(DataNodePipeMessages.UNHANDLED_EXCEPTION_DURING_PIPE_AIR_GAP_RECEIVER, e);
}
} catch (final Exception e) {
LOGGER.warn(DataNodePipeMessages.UNHANDLED_EXCEPTION_DURING_PIPE_AIR_GAP_RECEIVER, e);
}
}
}

private boolean registerUdpSessionIfNecessary(final DatagramPacket packet) {
final String receiverKey = packet.getSocketAddress().toString();
final ClientSession session =
udpClientSessions.computeIfAbsent(
receiverKey,
key ->
new ClientSession(new DatagramClientSocket(packet.getAddress(), packet.getPort())));
return SessionManager.getInstance().registerSession(session);
}

@Override
public void start() throws StartupException {
try {
serverSocket = new ServerSocket(PipeConfig.getInstance().getPipeAirGapReceiverPort());
datagramSocket = new DatagramSocket(PipeConfig.getInstance().getPipeAirGapReceiverPort());
} catch (final IOException e) {
if (Objects.nonNull(serverSocket)) {
try {
serverSocket.close();
} catch (final IOException closeException) {
e.addSuppressed(closeException);
}
}
throw new StartupException(e);
}

allowSubmitListen.set(true);
listenExecutor.submit(this::listen);
udpListenExecutor.submit(this::listenUdp);

LOGGER.info(DataNodePipeMessages.IOTDBAIRGAPRECEIVERAGENT_STARTED, serverSocket);
}

@Override
public void stop() {
allowSubmitListen.set(false);

try {
if (Objects.nonNull(serverSocket)) {
serverSocket.close();
}
if (Objects.nonNull(datagramSocket)) {
datagramSocket.close();
}
} catch (final IOException e) {
LOGGER.warn(DataNodePipeMessages.FAILED_TO_CLOSE_IOTDBAIRGAPRECEIVERAGENT_S_SERVER_SOCKET, e);
}

allowSubmitListen.set(false);
udpClientSessions.forEach(
(key, session) -> {
final boolean registeredSession = SessionManager.getInstance().registerSession(session);
try {
PipeDataNodeAgent.receiver().thrift().handleClientExit(key);
} finally {
if (registeredSession) {
SessionManager.getInstance().removeCurrSession();
}
}
});
udpClientSessions.clear();
listenExecutor.shutdown();
udpListenExecutor.shutdown();

LOGGER.info(DataNodePipeMessages.IOTDBAIRGAPRECEIVERAGENT_STOPPED, serverSocket);
}
Expand All @@ -103,4 +184,25 @@ public void stop() {
public ServiceType getID() {
return ServiceType.AIR_GAP_SERVICE;
}

private static class DatagramClientSocket extends Socket {

private final InetAddress address;
private final int port;

private DatagramClientSocket(final InetAddress address, final int port) {
this.address = address;
this.port = port;
}

@Override
public InetAddress getInetAddress() {
return address;
}

@Override
public int getPort() {
return port;
}
}
}
Loading
Loading