*/
package org.opendaylight.netconf.sal.connect.netconf.listener;
-import com.google.common.base.Optional;
import com.google.common.base.Strings;
-import com.google.common.collect.Lists;
-import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import io.netty.util.concurrent.Future;
-import io.netty.util.concurrent.FutureListener;
-import io.netty.util.concurrent.GenericFutureListener;
+import java.io.EOFException;
import java.util.ArrayDeque;
+import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.Semaphore;
+import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
-import org.opendaylight.controller.config.util.xml.XmlElement;
-import org.opendaylight.controller.config.util.xml.XmlUtil;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.netconf.api.FailedNetconfMessage;
import org.opendaylight.netconf.api.NetconfDocumentedException;
import org.opendaylight.netconf.api.NetconfMessage;
import org.opendaylight.netconf.api.NetconfTerminationReason;
+import org.opendaylight.netconf.api.xml.XmlElement;
import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
+import org.opendaylight.netconf.api.xml.XmlUtil;
import org.opendaylight.netconf.client.NetconfClientDispatcher;
import org.opendaylight.netconf.client.NetconfClientSession;
import org.opendaylight.netconf.client.NetconfClientSessionListener;
import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
+import org.opendaylight.netconf.sal.connect.api.RemoteDeviceId;
import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
-import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
+import org.opendaylight.yangtools.util.concurrent.FluentFutures;
+import org.opendaylight.yangtools.yang.common.Empty;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.common.RpcError;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class NetconfDeviceCommunicator implements NetconfClientSessionListener, RemoteDeviceCommunicator<NetconfMessage> {
-
+public class NetconfDeviceCommunicator implements NetconfClientSessionListener, RemoteDeviceCommunicator {
private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceCommunicator.class);
- protected final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice;
- private final Optional<UserPreferences> overrideNetconfCapabilities;
+ protected final RemoteDevice<NetconfDeviceCommunicator> remoteDevice;
+ private final @Nullable UserPreferences overrideNetconfCapabilities;
protected final RemoteDeviceId id;
private final Lock sessionLock = new ReentrantLock();
private final int concurentRpcMsgs;
private final Queue<Request> requests = new ArrayDeque<>();
- private NetconfClientSession session;
-
- private Future<?> initFuture;
- private SettableFuture<NetconfDeviceCapabilities> firstConnectionFuture;
-
- public NetconfDeviceCommunicator(final RemoteDeviceId id, final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice,
- final UserPreferences NetconfSessionPreferences, final int rpcMessageLimit) {
- this(id, remoteDevice, Optional.of(NetconfSessionPreferences), rpcMessageLimit);
+ private NetconfClientSession currentSession;
+
+ private final SettableFuture<Empty> firstConnectionFuture = SettableFuture.create();
+ private Future<?> taskFuture;
+
+ // isSessionClosing indicates a close operation on the session is issued and
+ // tearDown will surely be called later to finish the close.
+ // Used to allow only one thread to enter tearDown and other threads should
+ // NOT enter it simultaneously and should end its close operation without
+ // calling tearDown to release the locks they hold to avoid deadlock.
+ private static final AtomicIntegerFieldUpdater<NetconfDeviceCommunicator> CLOSING_UPDATER =
+ AtomicIntegerFieldUpdater.newUpdater(NetconfDeviceCommunicator.class, "closing");
+ private volatile int closing;
+
+ public boolean isSessionClosing() {
+ return closing != 0;
}
public NetconfDeviceCommunicator(final RemoteDeviceId id,
- final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice,
- final int rpcMessageLimit) {
- this(id, remoteDevice, Optional.<UserPreferences>absent(), rpcMessageLimit);
+ final RemoteDevice<NetconfDeviceCommunicator> remoteDevice, final int rpcMessageLimit) {
+ this(id, remoteDevice, rpcMessageLimit, null);
}
- private NetconfDeviceCommunicator(final RemoteDeviceId id, final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice,
- final Optional<UserPreferences> overrideNetconfCapabilities, final int rpcMessageLimit) {
- this.concurentRpcMsgs = rpcMessageLimit;
+ public NetconfDeviceCommunicator(final RemoteDeviceId id,
+ final RemoteDevice<NetconfDeviceCommunicator> remoteDevice, final int rpcMessageLimit,
+ final @Nullable UserPreferences overrideNetconfCapabilities) {
+ concurentRpcMsgs = rpcMessageLimit;
this.id = id;
this.remoteDevice = remoteDevice;
this.overrideNetconfCapabilities = overrideNetconfCapabilities;
- this.firstConnectionFuture = SettableFuture.create();
- this.semaphore = rpcMessageLimit > 0 ? new Semaphore(rpcMessageLimit) : null;
+ semaphore = rpcMessageLimit > 0 ? new Semaphore(rpcMessageLimit) : null;
}
@Override
sessionLock.lock();
try {
LOG.debug("{}: Session established", id);
- this.session = session;
-
- NetconfSessionPreferences netconfSessionPreferences =
- NetconfSessionPreferences.fromNetconfSession(session);
- LOG.trace("{}: Session advertised capabilities: {}", id,
- netconfSessionPreferences);
-
- if(overrideNetconfCapabilities.isPresent()) {
- netconfSessionPreferences = overrideNetconfCapabilities.get().isOverride() ?
- netconfSessionPreferences.replaceModuleCaps(overrideNetconfCapabilities.get().getSessionPreferences()) :
- netconfSessionPreferences.addModuleCaps(overrideNetconfCapabilities.get().getSessionPreferences());
- LOG.debug(
- "{}: Session capabilities overridden, capabilities that will be used: {}",
- id, netconfSessionPreferences);
+ currentSession = session;
+
+ var netconfSessionPreferences = NetconfSessionPreferences.fromNetconfSession(session);
+ LOG.trace("{}: Session advertised capabilities: {}", id, netconfSessionPreferences);
+
+ final var localOverride = overrideNetconfCapabilities;
+ if (localOverride != null) {
+ final var sessionPreferences = localOverride.sessionPreferences();
+ netconfSessionPreferences = localOverride.overrideModuleCapabilities()
+ ? netconfSessionPreferences.replaceModuleCaps(sessionPreferences)
+ : netconfSessionPreferences.addModuleCaps(sessionPreferences);
+
+ netconfSessionPreferences = localOverride.overrideNonModuleCapabilities()
+ ? netconfSessionPreferences.replaceNonModuleCaps(sessionPreferences)
+ : netconfSessionPreferences.addNonModuleCaps(sessionPreferences);
+ LOG.debug("{}: Session capabilities overridden, capabilities that will be used: {}", id,
+ netconfSessionPreferences);
}
-
remoteDevice.onRemoteSessionUp(netconfSessionPreferences, this);
- if (!firstConnectionFuture.isDone()) {
- firstConnectionFuture.set(netconfSessionPreferences.getNetconfDeviceCapabilities());
- }
- }
- finally {
+ } finally {
sessionLock.unlock();
}
+
+ // FIXME: right, except ... this does not include the device schema setup, so is it really useful?
+ if (!firstConnectionFuture.set(Empty.value())) {
+ LOG.trace("{}: First connection already completed", id);
+ }
}
/**
+ * Initialize remote connection.
*
- * @param dispatcher
- * @param config
- * @return future that returns succes on first succesfull connection and failure when the underlying
- * reconnecting strategy runs out of reconnection attempts
+ * @param dispatcher {@code NetconfCLientDispatcher}
+ * @param config {@code NetconfClientConfiguration}
+ * @return a ListenableFuture that returns success on first successful connection and failure when the underlying
+ * reconnecting strategy runs out of reconnection attempts
*/
- public ListenableFuture<NetconfDeviceCapabilities> initializeRemoteConnection(final NetconfClientDispatcher dispatcher, final NetconfClientConfiguration config) {
- if(config instanceof NetconfReconnectingClientConfiguration) {
- initFuture = dispatcher.createReconnectingClient((NetconfReconnectingClientConfiguration) config);
+ public ListenableFuture<Empty> initializeRemoteConnection(final NetconfClientDispatcher dispatcher,
+ final NetconfClientConfiguration config) {
+
+ final Future<?> connectFuture;
+ if (config instanceof NetconfReconnectingClientConfiguration) {
+ // FIXME: This is weird. If I understand it correctly we want to know about the first connection so as to
+ // forward error state. Analyze the call graph to understand what is going on here. We really want
+ // to move reconnection away from the socket layer, so that it can properly interface with sessions
+ // and generally has some event-driven state (as all good network glue does). There is a second story
+ // which is we want to avoid duplicate code, so it depends on other users as well.
+ final var future = dispatcher.createReconnectingClient((NetconfReconnectingClientConfiguration) config);
+ taskFuture = future;
+ connectFuture = future.firstSessionFuture();
} else {
- initFuture = dispatcher.createClient(config);
+ taskFuture = connectFuture = dispatcher.createClient(config);
}
-
- initFuture.addListener(new GenericFutureListener<Future<Object>>(){
-
- @Override
- public void operationComplete(Future<Object> future) throws Exception {
- if (!future.isSuccess() && !future.isCancelled()) {
- LOG.debug("{}: Connection failed", id, future.cause());
- NetconfDeviceCommunicator.this.remoteDevice.onRemoteSessionFailed(future.cause());
- if (firstConnectionFuture.isDone()) {
- firstConnectionFuture.setException(future.cause());
- }
+ connectFuture.addListener(future -> {
+ if (!future.isSuccess() && !future.isCancelled()) {
+ LOG.debug("{}: Connection failed", id, future.cause());
+ remoteDevice.onRemoteSessionFailed(future.cause());
+ if (!firstConnectionFuture.isDone()) {
+ firstConnectionFuture.setException(future.cause());
}
}
});
}
public void disconnect() {
- if(session != null) {
- session.close();
+ // If session is already in closing, no need to close it again
+ if (currentSession != null && startClosing() && currentSession.isUp()) {
+ currentSession.close();
}
}
- private void tearDown( String reason ) {
+ private void tearDown(final String reason) {
+ if (!isSessionClosing()) {
+ LOG.warn("It's curious that no one to close the session but tearDown is called!");
+ }
LOG.debug("Tearing down {}", reason);
- List<UncancellableFuture<RpcResult<NetconfMessage>>> futuresToCancel = Lists.newArrayList();
+ final List<UncancellableFuture<RpcResult<NetconfMessage>>> futuresToCancel = new ArrayList<>();
sessionLock.lock();
try {
- if( session != null ) {
- session = null;
-
+ if (currentSession != null) {
+ currentSession = null;
/*
* Walk all requests, check if they have been executing
* or cancelled and remove them from the queue.
while (it.hasNext()) {
final Request r = it.next();
if (r.future.isUncancellable()) {
- futuresToCancel.add( r.future );
+ futuresToCancel.add(r.future);
it.remove();
} else if (r.future.isCancelled()) {
// This just does some house-cleaning
remoteDevice.onRemoteSessionDown();
}
- }
- finally {
+ } finally {
sessionLock.unlock();
}
// Notify pending request futures outside of the sessionLock to avoid unnecessarily
// blocking the caller.
- for( UncancellableFuture<RpcResult<NetconfMessage>> future: futuresToCancel ) {
- if( Strings.isNullOrEmpty( reason ) ) {
- future.set( createSessionDownRpcResult() );
+ for (final UncancellableFuture<RpcResult<NetconfMessage>> future : futuresToCancel) {
+ if (Strings.isNullOrEmpty(reason)) {
+ future.set(createSessionDownRpcResult());
} else {
- future.set( createErrorRpcResult( RpcError.ErrorType.TRANSPORT, reason ) );
+ future.set(createErrorRpcResult(ErrorType.TRANSPORT, reason));
}
}
+
+ closing = 0;
}
private RpcResult<NetconfMessage> createSessionDownRpcResult() {
- return createErrorRpcResult( RpcError.ErrorType.TRANSPORT,
- String.format( "The netconf session to %1$s is disconnected", id.getName() ) );
+ return createErrorRpcResult(ErrorType.TRANSPORT,
+ String.format("The netconf session to %1$s is disconnected", id.name()));
}
- private RpcResult<NetconfMessage> createErrorRpcResult( RpcError.ErrorType errorType, String message ) {
+ private static RpcResult<NetconfMessage> createErrorRpcResult(final ErrorType errorType, final String message) {
return RpcResultBuilder.<NetconfMessage>failed()
- .withError(errorType, NetconfDocumentedException.ErrorTag.operation_failed.getTagValue(), message).build();
+ .withError(errorType, ErrorTag.OPERATION_FAILED, message).build();
}
@Override
- public void onSessionDown(final NetconfClientSession session, final Exception e) {
- LOG.warn("{}: Session went down", id, e);
- tearDown( null );
+ public void onSessionDown(final NetconfClientSession session, final Exception exception) {
+ // If session is already in closing, no need to call tearDown again.
+ if (startClosing()) {
+ if (exception instanceof EOFException) {
+ LOG.info("{}: Session went down: {}", id, exception.getMessage());
+ } else {
+ LOG.warn("{}: Session went down", id, exception);
+ }
+ tearDown(null);
+ }
}
@Override
public void onSessionTerminated(final NetconfClientSession session, final NetconfTerminationReason reason) {
+ // onSessionTerminated is called directly by disconnect, no need to compare and set isSessionClosing.
LOG.warn("{}: Session terminated {}", id, reason);
- tearDown( reason.getErrorMessage() );
+ tearDown(reason.getErrorMessage());
}
@Override
public void close() {
// Cancel reconnect if in progress
- if(initFuture != null) {
- initFuture.cancel(false);
+ if (taskFuture != null) {
+ taskFuture.cancel(false);
}
// Disconnect from device
- if(session != null) {
- session.close();
- // tear down not necessary, called indirectly by above close
- }
+ // tear down not necessary, called indirectly by the close in disconnect()
+ disconnect();
}
@Override
try {
request = requests.peek();
if (request != null && request.future.isUncancellable()) {
- requests.poll();
+ request = requests.poll();
// we have just removed one request from the queue
// we can also release one permit
- if(semaphore != null) {
+ if (semaphore != null) {
semaphore.release();
}
} else {
LOG.warn("{}: Ignoring unsolicited message {}", id,
msgToS(message));
}
- }
- finally {
+ } finally {
sessionLock.unlock();
}
- if( request != null ) {
-
- LOG.debug("{}: Message received {}", id, message);
+ if (request == null) {
+ // No matching request, bail out
+ return;
+ }
- if(LOG.isTraceEnabled()) {
- LOG.trace( "{}: Matched request: {} to response: {}", id, msgToS( request.request ), msgToS( message ) );
- }
- try {
- NetconfMessageTransformUtil.checkValidReply( request.request, message );
- } catch (final NetconfDocumentedException e) {
- LOG.warn(
- "{}: Invalid request-reply match, reply message contains different message-id, request: {}, response: {}",
- id, msgToS(request.request), msgToS(message), e);
+ if (message instanceof FailedNetconfMessage) {
+ request.future.set(NetconfMessageTransformUtil.toRpcResult((FailedNetconfMessage) message));
+ return;
+ }
- request.future.set( RpcResultBuilder.<NetconfMessage>failed()
- .withRpcError( NetconfMessageTransformUtil.toRpcError( e ) ).build() );
+ LOG.debug("{}: Message received {}", id, message);
- //recursively processing message to eventually find matching request
- processMessage(message);
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("{}: Matched request: {} to response: {}", id, msgToS(request.request), msgToS(message));
+ }
- return;
- }
+ try {
+ NetconfMessageTransformUtil.checkValidReply(request.request, message);
+ } catch (final NetconfDocumentedException e) {
+ LOG.warn("{}: Invalid request-reply match, reply message contains different message-id, "
+ + "request: {}, response: {}", id, msgToS(request.request), msgToS(message), e);
- try {
- NetconfMessageTransformUtil.checkSuccessReply(message);
- } catch(final NetconfDocumentedException e) {
- LOG.warn(
- "{}: Error reply from remote device, request: {}, response: {}",
- id, msgToS(request.request), msgToS(message), e);
+ request.future.set(RpcResultBuilder.<NetconfMessage>failed()
+ .withRpcError(NetconfMessageTransformUtil.toRpcError(e))
+ .build());
- request.future.set( RpcResultBuilder.<NetconfMessage>failed()
- .withRpcError( NetconfMessageTransformUtil.toRpcError( e ) ).build() );
- return;
- }
+ //recursively processing message to eventually find matching request
+ processMessage(message);
+ return;
+ }
- request.future.set( RpcResultBuilder.success( message ).build() );
+ try {
+ NetconfMessageTransformUtil.checkSuccessReply(message);
+ } catch (final NetconfDocumentedException e) {
+ LOG.warn("{}: Error reply from remote device, request: {}, response: {}",
+ id, msgToS(request.request), msgToS(message), e);
+
+ request.future.set(RpcResultBuilder.<NetconfMessage>failed()
+ .withRpcError(NetconfMessageTransformUtil.toRpcError(e))
+ .build());
+ return;
}
+
+ request.future.set(RpcResultBuilder.success(message).build());
}
private static String msgToS(final NetconfMessage msg) {
@Override
public ListenableFuture<RpcResult<NetconfMessage>> sendRequest(final NetconfMessage message, final QName rpc) {
sessionLock.lock();
-
- if (semaphore != null && !semaphore.tryAcquire()) {
- LOG.warn("Limit of concurrent rpc messages was reached (limit :" +
- concurentRpcMsgs + "). Rpc reply message is needed. Discarding request of Netconf device with id" + id.getName());
- sessionLock.unlock();
- return Futures.immediateFailedFuture(new NetconfDocumentedException("Limit of rpc messages was reached (Limit :" +
- concurentRpcMsgs + ") waiting for emptying the queue of Netconf device with id" + id.getName()));
- }
-
try {
+ if (semaphore != null && !semaphore.tryAcquire()) {
+ LOG.warn("Limit of concurrent rpc messages was reached (limit: {}). Rpc reply message is needed. "
+ + "Discarding request of Netconf device with id: {}", concurentRpcMsgs, id.name());
+ return FluentFutures.immediateFailedFluentFuture(new NetconfDocumentedException(
+ "Limit of rpc messages was reached (Limit :" + concurentRpcMsgs
+ + ") waiting for emptying the queue of Netconf device with id: " + id.name()));
+ }
+
return sendRequestWithLock(message, rpc);
} finally {
sessionLock.unlock();
}
}
- private ListenableFuture<RpcResult<NetconfMessage>> sendRequestWithLock(
- final NetconfMessage message, final QName rpc) {
- if(LOG.isTraceEnabled()) {
+ private ListenableFuture<RpcResult<NetconfMessage>> sendRequestWithLock(final NetconfMessage message,
+ final QName rpc) {
+ if (LOG.isTraceEnabled()) {
LOG.trace("{}: Sending message {}", id, msgToS(message));
}
- if (session == null) {
+ if (currentSession == null) {
LOG.warn("{}: Session is disconnected, failing RPC request {}",
id, message);
- return Futures.immediateFuture( createSessionDownRpcResult() );
+ return FluentFutures.immediateFluentFuture(createSessionDownRpcResult());
}
- final Request req = new Request( new UncancellableFuture<RpcResult<NetconfMessage>>(true),
- message );
+ final Request req = new Request(new UncancellableFuture<>(true), message);
requests.add(req);
- session.sendMessage(req.request).addListener(new FutureListener<Void>() {
- @Override
- public void operationComplete(final Future<Void> future) throws Exception {
- if( !future.isSuccess() ) {
- // We expect that a session down will occur at this point
- LOG.debug("{}: Failed to send request {}", id,
- XmlUtil.toString(req.request.getDocument()),
- future.cause());
-
- if( future.cause() != null ) {
- req.future.set( createErrorRpcResult( RpcError.ErrorType.TRANSPORT,
- future.cause().getLocalizedMessage() ) );
- } else {
- req.future.set( createSessionDownRpcResult() ); // assume session is down
- }
- req.future.setException( future.cause() );
- }
- else {
- LOG.trace("Finished sending request {}", req.request);
+ currentSession.sendMessage(req.request).addListener(future -> {
+ if (!future.isSuccess()) {
+ // We expect that a session down will occur at this point
+ LOG.debug("{}: Failed to send request {}", id,
+ XmlUtil.toString(req.request.getDocument()),
+ future.cause());
+
+ if (future.cause() != null) {
+ req.future.set(createErrorRpcResult(ErrorType.TRANSPORT, future.cause().getLocalizedMessage()));
+ } else {
+ req.future.set(createSessionDownRpcResult()); // assume session is down
}
+ req.future.setException(future.cause());
+ } else {
+ LOG.trace("Finished sending request {}", req.request);
}
});
}
private void processNotification(final NetconfMessage notification) {
- if(LOG.isTraceEnabled()) {
+ if (LOG.isTraceEnabled()) {
LOG.trace("{}: Notification received: {}", id, notification);
}
}
private static boolean isNotification(final NetconfMessage message) {
+ if (message.getDocument() == null) {
+ // We have no message, which mean we have a FailedNetconfMessage
+ return false;
+ }
final XmlElement xmle = XmlElement.fromDomDocument(message.getDocument());
return XmlNetconfConstants.NOTIFICATION_ELEMENT_NAME.equals(xmle.getName()) ;
}
this.request = request;
}
}
+
+ private boolean startClosing() {
+ return CLOSING_UPDATER.compareAndSet(this, 0, 1);
+ }
}