Fixed deadlock between AsyncSshHandlerReader and AsyncSshHandler
[netconf.git] / netconf / netconf-netty-util / src / main / java / org / opendaylight / netconf / nettyutil / handler / ssh / client / AsyncSshHandler.java
index 8f6e2baa6304583b456901717bf48e4ec3988e7e..15882ded63ec8d1acfdf09f0f9284e5d59a65f8e 100644 (file)
@@ -9,7 +9,6 @@
 package org.opendaylight.netconf.nettyutil.handler.ssh.client;
 
 import com.google.common.base.Preconditions;
-import io.netty.buffer.ByteBuf;
 import io.netty.channel.ChannelHandlerContext;
 import io.netty.channel.ChannelOutboundHandlerAdapter;
 import io.netty.channel.ChannelPromise;
@@ -17,16 +16,12 @@ import io.netty.util.concurrent.Future;
 import io.netty.util.concurrent.GenericFutureListener;
 import java.io.IOException;
 import java.net.SocketAddress;
-import java.util.HashMap;
-import java.util.Map;
-import org.apache.sshd.ClientChannel;
-import org.apache.sshd.ClientSession;
-import org.apache.sshd.SshClient;
+import java.util.concurrent.atomic.AtomicBoolean;
+import org.apache.sshd.client.SshClient;
+import org.apache.sshd.client.channel.ClientChannel;
 import org.apache.sshd.client.future.AuthFuture;
 import org.apache.sshd.client.future.ConnectFuture;
-import org.apache.sshd.client.future.OpenFuture;
-import org.apache.sshd.common.future.CloseFuture;
-import org.apache.sshd.common.future.SshFutureListener;
+import org.apache.sshd.client.session.ClientSession;
 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -46,13 +41,10 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
     public static final SshClient DEFAULT_CLIENT;
 
     static {
-        final Map<String, String> props = new HashMap<>();
-        props.put(SshClient.AUTH_TIMEOUT, Long.toString(DEFAULT_TIMEOUT));
-        props.put(SshClient.IDLE_TIMEOUT, Long.toString(DEFAULT_TIMEOUT));
-
         final SshClient c = SshClient.setUpDefaultClient();
+        c.getProperties().put(SshClient.AUTH_TIMEOUT, Long.toString(DEFAULT_TIMEOUT));
+        c.getProperties().put(SshClient.IDLE_TIMEOUT, Long.toString(DEFAULT_TIMEOUT));
 
-        c.setProperties(props);
         // TODO make configurable, or somehow reuse netty threadpool
         c.setNioWorkers(SSH_DEFAULT_NIO_WORKERS);
         c.start();
@@ -61,6 +53,7 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
 
     private final AuthenticationHandler authenticationHandler;
     private final SshClient sshClient;
+    private final AtomicBoolean isDisconnected = new AtomicBoolean();
     private Future<?> negotiationFuture;
 
     private AsyncSshHandlerReader sshReadAsyncListener;
@@ -72,7 +65,7 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
     private GenericFutureListener negotiationFutureListener;
 
     public AsyncSshHandler(final AuthenticationHandler authenticationHandler, final SshClient sshClient,
-            final Future<?> negotiationFuture) throws IOException {
+            final Future<?> negotiationFuture) {
         this(authenticationHandler, sshClient);
         this.negotiationFuture = negotiationFuture;
     }
@@ -82,16 +75,14 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
      *
      * @param authenticationHandler authentication handler
      * @param sshClient             started SshClient
-     * @throws IOException          if the I/O operation fails
      */
     public AsyncSshHandler(final AuthenticationHandler authenticationHandler,
-                           final SshClient sshClient) throws IOException {
+                           final SshClient sshClient) {
         this.authenticationHandler = Preconditions.checkNotNull(authenticationHandler);
         this.sshClient = Preconditions.checkNotNull(sshClient);
     }
 
-    public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler)
-            throws IOException {
+    public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler) {
         return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT);
     }
 
@@ -102,25 +93,21 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
      * @param authenticationHandler authentication handler
      * @param negotiationFuture     negotiation future
      * @return                      {@code AsyncSshHandler}
-     * @throws IOException          if the I/O operation fails
      */
     public static AsyncSshHandler createForNetconfSubsystem(final AuthenticationHandler authenticationHandler,
-            final Future<?> negotiationFuture) throws IOException {
+            final Future<?> negotiationFuture) {
         return new AsyncSshHandler(authenticationHandler, DEFAULT_CLIENT, negotiationFuture);
     }
 
-    private void startSsh(final ChannelHandlerContext ctx, final SocketAddress address) {
+    private void startSsh(final ChannelHandlerContext ctx, final SocketAddress address) throws IOException {
         LOG.debug("Starting SSH to {} on channel: {}", address, ctx.channel());
 
         final ConnectFuture sshConnectionFuture = sshClient.connect(authenticationHandler.getUsername(), address);
-        sshConnectionFuture.addListener(new SshFutureListener<ConnectFuture>() {
-            @Override
-            public void operationComplete(final ConnectFuture future) {
-                if (future.isConnected()) {
-                    handleSshSessionCreated(future, ctx);
-                } else {
-                    handleSshSetupFailure(ctx, future.getException());
-                }
+        sshConnectionFuture.addListener(future -> {
+            if (future.isConnected()) {
+                handleSshSessionCreated(future, ctx);
+            } else {
+                handleSshSetupFailure(ctx, future.getException());
             }
         });
     }
@@ -131,17 +118,15 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
 
             session = future.getSession();
             final AuthFuture authenticateFuture = authenticationHandler.authenticate(session);
-            authenticateFuture.addListener(new SshFutureListener<AuthFuture>() {
-                @Override
-                public void operationComplete(final AuthFuture future) {
-                    if (future.isSuccess()) {
-                        handleSshAuthenticated(session, ctx);
-                    } else {
-                        // Exception does not have to be set in the future, add simple exception in such case
-                        final Throwable exception = future.getException() == null
-                                ? new IllegalStateException("Authentication failed") : future.getException();
-                        handleSshSetupFailure(ctx, exception);
-                    }
+            final ClientSession localSession = session;
+            authenticateFuture.addListener(future1 -> {
+                if (future1.isSuccess()) {
+                    handleSshAuthenticated(localSession, ctx);
+                } else {
+                    // Exception does not have to be set in the future, add simple exception in such case
+                    final Throwable exception = future1.getException() == null
+                            ? new IllegalStateException("Authentication failed") : future1.getException();
+                    handleSshSetupFailure(ctx, exception);
                 }
             });
         } catch (final IOException e) {
@@ -149,21 +134,18 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
         }
     }
 
-    private synchronized void handleSshAuthenticated(final ClientSession session, final ChannelHandlerContext ctx) {
+    private synchronized void handleSshAuthenticated(final ClientSession newSession, final ChannelHandlerContext ctx) {
         try {
             LOG.debug("SSH session authenticated on channel: {}, server version: {}", ctx.channel(),
-                    session.getServerVersion());
+                    newSession.getServerVersion());
 
-            channel = session.createSubsystemChannel(SUBSYSTEM);
+            channel = newSession.createSubsystemChannel(SUBSYSTEM);
             channel.setStreaming(ClientChannel.Streaming.Async);
-            channel.open().addListener(new SshFutureListener<OpenFuture>() {
-                @Override
-                public void operationComplete(final OpenFuture future) {
-                    if (future.isOpened()) {
-                        handleSshChanelOpened(ctx);
-                    } else {
-                        handleSshSetupFailure(ctx, future.getException());
-                    }
+            channel.open().addListener(future -> {
+                if (future.isOpened()) {
+                    handleSshChanelOpened(ctx);
+                } else {
+                    handleSshSetupFailure(ctx, future.getException());
                 }
             });
 
@@ -182,17 +164,9 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
 
         // TODO we should also read from error stream and at least log from that
 
-        sshReadAsyncListener = new AsyncSshHandlerReader(new AutoCloseable() {
-            @Override
-            public void close() throws Exception {
-                AsyncSshHandler.this.disconnect(ctx, ctx.newPromise());
-            }
-        }, new AsyncSshHandlerReader.ReadMsgHandler() {
-            @Override
-            public void onMessageRead(final ByteBuf msg) {
-                ctx.fireChannelRead(msg);
-            }
-        }, channel.toString(), channel.getAsyncOut());
+        ClientChannel localChannel = channel;
+        sshReadAsyncListener = new AsyncSshHandlerReader(() -> AsyncSshHandler.this.disconnect(ctx, ctx.newPromise()),
+            ctx::fireChannelRead, localChannel.toString(), localChannel.getAsyncOut());
 
         // if readAsyncListener receives immediate close,
         // it will close this handler and closing this handler sets channel variable to null
@@ -225,13 +199,9 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
         this.connectPromise = promise;
 
         if (negotiationFuture != null) {
-
-            negotiationFutureListener = new GenericFutureListener<Future<?>>() {
-                @Override
-                public void operationComplete(final Future<?> future) {
-                    if (future.isSuccess()) {
-                        connectPromise.setSuccess();
-                    }
+            negotiationFutureListener = future -> {
+                if (future.isSuccess()) {
+                    promise.setSuccess();
                 }
             };
             //complete connection promise with netconf negotiation future
@@ -241,15 +211,21 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
     }
 
     @Override
-    public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) throws Exception {
+    public void close(final ChannelHandlerContext ctx, final ChannelPromise promise) {
         disconnect(ctx, promise);
     }
 
-    @SuppressWarnings("checkstyle:IllegalCatch")
     @Override
-    public synchronized void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) {
+    public void disconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) {
+        if (isDisconnected.compareAndSet(false, true)) {
+            safelyDisconnect(ctx, promise);
+        }
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    private synchronized void safelyDisconnect(final ChannelHandlerContext ctx, final ChannelPromise promise) {
         LOG.trace("Closing SSH session on channel: {} with connect promise in state: {}",
-                ctx.channel(),connectPromise);
+                ctx.channel(), connectPromise);
 
         // If we have already succeeded and the session was dropped after,
         // we need to fire inactive to notify reconnect logic
@@ -278,10 +254,9 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
         }
 
         if (session != null && !session.isClosed() && !session.isClosing()) {
-            session.close(false).addListener(new SshFutureListener<CloseFuture>() {
-                @Override
-                public void operationComplete(final CloseFuture future) {
-                    if (future.isClosed() == false) {
+            session.close(false).addListener(future -> {
+                synchronized (this) {
+                    if (!future.isClosed()) {
                         session.close(true);
                     }
                     session = null;
@@ -305,5 +280,4 @@ public class AsyncSshHandler extends ChannelOutboundHandlerAdapter {
         promise.setSuccess();
         LOG.debug("SSH session closed on channel: {}", ctx.channel());
     }
-
 }