*/
package org.opendaylight.netconf.nettyutil;
+import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkState;
import static java.util.Objects.requireNonNull;
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import com.google.common.annotations.Beta;
import io.netty.channel.Channel;
-import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.handler.ssl.SslHandler;
import io.netty.util.Timeout;
import io.netty.util.Timer;
-import io.netty.util.concurrent.GenericFutureListener;
+import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.Promise;
-import java.util.Optional;
import java.util.concurrent.TimeUnit;
+import org.checkerframework.checker.index.qual.NonNegative;
import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.checkerframework.checker.lock.qual.Holding;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.netconf.api.CapabilityURN;
+import org.opendaylight.netconf.api.NamespaceURN;
import org.opendaylight.netconf.api.NetconfDocumentedException;
-import org.opendaylight.netconf.api.NetconfMessage;
import org.opendaylight.netconf.api.NetconfSessionListener;
-import org.opendaylight.netconf.api.NetconfSessionPreferences;
-import org.opendaylight.netconf.api.messages.NetconfHelloMessage;
+import org.opendaylight.netconf.api.messages.HelloMessage;
+import org.opendaylight.netconf.api.messages.NetconfMessage;
import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
-import org.opendaylight.netconf.nettyutil.handler.FramingMechanismHandlerFactory;
+import org.opendaylight.netconf.nettyutil.handler.ChunkedFramingMechanismEncoder;
import org.opendaylight.netconf.nettyutil.handler.NetconfChunkAggregator;
import org.opendaylight.netconf.nettyutil.handler.NetconfMessageToXMLEncoder;
import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToHelloMessageDecoder;
import org.opendaylight.netconf.nettyutil.handler.NetconfXMLToMessageDecoder;
-import org.opendaylight.netconf.util.messages.FramingMechanism;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
-public abstract class AbstractNetconfSessionNegotiator<P extends NetconfSessionPreferences,
- S extends AbstractNetconfSession<S, L>, L extends NetconfSessionListener<S>>
+public abstract class AbstractNetconfSessionNegotiator<S extends AbstractNetconfSession<S, L>,
+ L extends NetconfSessionListener<S>>
extends ChannelInboundHandlerAdapter implements NetconfSessionNegotiator<S> {
/**
* Possible states for Finite State Machine.
}
private static final Logger LOG = LoggerFactory.getLogger(AbstractNetconfSessionNegotiator.class);
+ private static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler";
+ private static final String DEFAULT_MAXIMUM_CHUNK_SIZE_PROP = "org.opendaylight.netconf.default.maximum.chunk.size";
+ private static final int DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT = 16 * 1024 * 1024;
- public static final String NAME_OF_EXCEPTION_HANDLER = "lastExceptionHandler";
+ /**
+ * Default upper bound on the size of an individual chunk. This value can be controlled through
+ * {@value #DEFAULT_MAXIMUM_CHUNK_SIZE_PROP} system property and defaults to
+ * {@value #DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT} bytes.
+ */
+ @Beta
+ public static final @NonNegative int DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE;
+
+ static {
+ final int propValue = Integer.getInteger(DEFAULT_MAXIMUM_CHUNK_SIZE_PROP, DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT);
+ if (propValue <= 0) {
+ LOG.warn("Ignoring invalid {} value {}", DEFAULT_MAXIMUM_CHUNK_SIZE_PROP, propValue);
+ DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE = DEFAULT_MAXIMUM_CHUNK_SIZE_DEFAULT;
+ } else {
+ DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE = propValue;
+ }
+ LOG.debug("Default maximum incoming NETCONF chunk size is {} bytes", DEFAULT_MAXIMUM_INCOMING_CHUNK_SIZE);
+ }
- protected final P sessionPreferences;
+ private final @NonNull HelloMessage localHello;
protected final Channel channel;
+ private final @NonNegative int maximumIncomingChunkSize;
private final long connectionTimeoutMillis;
private final Promise<S> promise;
private final L sessionListener;
private final Timer timer;
+ @GuardedBy("this")
private Timeout timeoutTask;
-
@GuardedBy("this")
private State state = State.IDLE;
- protected AbstractNetconfSessionNegotiator(final P sessionPreferences, final Promise<S> promise,
- final Channel channel, final Timer timer,
- final L sessionListener, final long connectionTimeoutMillis) {
- this.channel = requireNonNull(channel);
+ protected AbstractNetconfSessionNegotiator(final HelloMessage hello, final Promise<S> promise,
+ final Channel channel, final Timer timer, final L sessionListener,
+ final long connectionTimeoutMillis,
+ final @NonNegative int maximumIncomingChunkSize) {
+ localHello = requireNonNull(hello);
this.promise = requireNonNull(promise);
- this.sessionPreferences = sessionPreferences;
+ this.channel = requireNonNull(channel);
this.timer = timer;
this.sessionListener = sessionListener;
this.connectionTimeoutMillis = connectionTimeoutMillis;
+ this.maximumIncomingChunkSize = maximumIncomingChunkSize;
+ checkArgument(maximumIncomingChunkSize > 0, "Invalid maximum incoming chunk size %s", maximumIncomingChunkSize);
+ }
+
+ protected final @NonNull HelloMessage localHello() {
+ return localHello;
}
protected final void startNegotiation() {
if (ifNegotiatedAlready()) {
LOG.debug("Negotiation on channel {} already started", channel);
} else {
- final Optional<SslHandler> sslHandler = getSslHandler(channel);
- if (sslHandler.isPresent()) {
- sslHandler.get().handshakeFuture().addListener(future -> {
+ final var sslHandler = getSslHandler(channel);
+ if (sslHandler != null) {
+ sslHandler.handshakeFuture().addListener(future -> {
checkState(future.isSuccess(), "Ssl handshake was not successful");
LOG.debug("Ssl handshake complete");
start();
}
}
- protected final synchronized boolean ifNegotiatedAlready() {
+ protected final boolean ifNegotiatedAlready() {
// Indicates whether negotiation already started
- return this.state != State.IDLE;
+ return state() != State.IDLE;
}
- private static Optional<SslHandler> getSslHandler(final Channel channel) {
- return Optional.ofNullable(channel.pipeline().get(SslHandler.class));
+ private synchronized State state() {
+ return state;
}
- public P getSessionPreferences() {
- return sessionPreferences;
+ private static @Nullable SslHandler getSslHandler(final Channel channel) {
+ return channel.pipeline().get(SslHandler.class);
}
private void start() {
- final NetconfHelloMessage helloMessage = this.sessionPreferences.getHelloMessage();
- LOG.debug("Session negotiation started with hello message {} on channel {}", helloMessage, channel);
+ LOG.debug("Sending negotiation proposal {} on channel {}", localHello, channel);
+
+ // Send the message out, but to not run listeners just yet, as we have some more state transitions to go through
+ final var helloFuture = channel.writeAndFlush(localHello);
+
+ // Quick check: if the future has already failed we call it quits before negotiation even started
+ final var helloCause = helloFuture.cause();
+ if (helloCause != null) {
+ LOG.warn("Failed to send negotiation proposal on channel {}", channel, helloCause);
+ failAndClose();
+ return;
+ }
+
+ // Catch any exceptions from this point on. Use a named class to ease debugging.
+ final class ExceptionHandlingInboundChannelHandler extends ChannelInboundHandlerAdapter {
+ @Override
+ public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
+ LOG.warn("An exception occurred during negotiation with {} on channel {}",
+ channel.remoteAddress(), channel, cause);
+ // FIXME: this is quite suspect as it is competing with timeoutExpired() without synchronization
+ cancelTimeout();
+ negotiationFailed(cause);
+ changeState(State.FAILED);
+ }
+ }
channel.pipeline().addLast(NAME_OF_EXCEPTION_HANDLER, new ExceptionHandlingInboundChannelHandler());
- sendMessage(helloMessage);
+ // Remove special outbound handler for hello message. Insert regular netconf xml message (en|de)coders.
+ replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_ENCODER,
+ new NetconfMessageToXMLEncoder());
+
+ synchronized (this) {
+ lockedChangeState(State.OPEN_WAIT);
- replaceHelloMessageOutboundHandler();
- changeState(State.OPEN_WAIT);
+ // Service the timeout on channel's eventloop, so that we do not get state transition problems
+ timeoutTask = timer.newTimeout(unused -> channel.eventLoop().execute(this::timeoutExpired),
+ connectionTimeoutMillis, TimeUnit.MILLISECONDS);
+ }
+
+ LOG.debug("Session negotiation started on channel {}", channel);
+
+ // State transition completed, now run any additional processing
+ helloFuture.addListener(this::onHelloWriteComplete);
+ }
- timeoutTask = this.timer.newTimeout(this::timeoutExpired, connectionTimeoutMillis, TimeUnit.MILLISECONDS);
+ private void onHelloWriteComplete(final Future<?> future) {
+ final var cause = future.cause();
+ if (cause != null) {
+ LOG.info("Failed to send message {} on channel {}", localHello, channel, cause);
+ negotiationFailed(cause);
+ } else {
+ LOG.trace("Message {} sent to socket on channel {}", localHello, channel);
+ }
}
- private synchronized void timeoutExpired(final Timeout timeout) {
+ private synchronized void timeoutExpired() {
+ if (timeoutTask == null) {
+ // cancelTimeout() between expiry and execution on the loop
+ return;
+ }
+ timeoutTask = null;
+
if (state != State.ESTABLISHED) {
- LOG.debug("Connection timeout after {}, session backed by channel {} is in state {}", timeout, channel,
- state);
+ LOG.debug("Connection timeout after {}ms, session backed by channel {} is in state {}",
+ connectionTimeoutMillis, channel, state);
// Do not fail negotiation if promise is done or canceled
// It would result in setting result of the promise second time and that throws exception
if (!promise.isDone() && !promise.isCancelled()) {
LOG.warn("Netconf session backed by channel {} was not established after {}", channel,
connectionTimeoutMillis);
- changeState(State.FAILED);
-
- channel.close().addListener((GenericFutureListener<ChannelFuture>) future -> {
- if (future.isSuccess()) {
- LOG.debug("Channel {} closed: success", future.channel());
- } else {
- LOG.warn("Channel {} closed: fail", future.channel());
- }
- });
+ failAndClose();
}
} else if (channel.isOpen()) {
channel.pipeline().remove(NAME_OF_EXCEPTION_HANDLER);
}
}
- @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
- justification = "https://github.com/spotbugs/spotbugs/issues/811")
- private void cancelTimeout() {
- if (timeoutTask != null) {
- timeoutTask.cancel();
+ private void failAndClose() {
+ changeState(State.FAILED);
+ channel.close().addListener(this::onChannelClosed);
+ }
+
+ private void onChannelClosed(final Future<?> future) {
+ final var cause = future.cause();
+ if (cause != null) {
+ LOG.warn("Channel {} closed: fail", channel, cause);
+ } else {
+ LOG.debug("Channel {} closed: success", channel);
+ }
+ }
+
+ private synchronized void cancelTimeout() {
+ if (timeoutTask != null && !timeoutTask.cancel()) {
+ // Late-coming cancel: make sure the task does not actually run
+ timeoutTask = null;
}
}
- protected final S getSessionForHelloMessage(final NetconfHelloMessage netconfMessage)
+ protected final S getSessionForHelloMessage(final HelloMessage netconfMessage)
throws NetconfDocumentedException {
final Document doc = netconfMessage.getDocument();
return getSession(sessionListener, channel, netconfMessage);
}
+ protected abstract S getSession(L sessionListener, Channel channel, HelloMessage message)
+ throws NetconfDocumentedException;
+
/**
* Insert chunk framing handlers into the pipeline.
*/
private void insertChunkFramingToPipeline() {
replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_FRAME_ENCODER,
- FramingMechanismHandlerFactory.createHandler(FramingMechanism.CHUNK));
+ new ChunkedFramingMechanismEncoder());
replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_AGGREGATOR,
- new NetconfChunkAggregator());
+ new NetconfChunkAggregator(maximumIncomingChunkSize));
}
private boolean shouldUseChunkFraming(final Document doc) {
- return containsBase11Capability(doc)
- && containsBase11Capability(sessionPreferences.getHelloMessage().getDocument());
+ return containsBase11Capability(doc) && containsBase11Capability(localHello.getDocument());
}
/**
}
}
- /**
- * Remove special outbound handler for hello message. Insert regular netconf xml message (en|de)coders.
- */
- private void replaceHelloMessageOutboundHandler() {
- replaceChannelHandler(channel, AbstractChannelInitializer.NETCONF_MESSAGE_ENCODER,
- new NetconfMessageToXMLEncoder());
- }
-
private static ChannelHandler replaceChannelHandler(final Channel channel, final String handlerKey,
final ChannelHandler decoder) {
return channel.pipeline().replace(handlerKey, handlerKey, decoder);
}
- @SuppressWarnings("checkstyle:hiddenField")
- protected abstract S getSession(L sessionListener, Channel channel, NetconfHelloMessage message)
- throws NetconfDocumentedException;
-
private synchronized void changeState(final State newState) {
+ lockedChangeState(newState);
+ }
+
+ @Holding("this")
+ private void lockedChangeState(final State newState) {
LOG.debug("Changing state from : {} to : {} for channel: {}", state, newState, channel);
checkState(isStateChangePermitted(state, newState),
"Cannot change state from %s to %s for channel %s", state, newState, channel);
- this.state = newState;
+ state = newState;
}
private static boolean containsBase11Capability(final Document doc) {
- final NodeList nList = doc.getElementsByTagNameNS(
- XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0,
- XmlNetconfConstants.CAPABILITY);
+ final NodeList nList = doc.getElementsByTagNameNS(NamespaceURN.BASE, XmlNetconfConstants.CAPABILITY);
for (int i = 0; i < nList.getLength(); i++) {
- if (nList.item(i).getTextContent().contains(XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_BASE_1_1)) {
+ if (nList.item(i).getTextContent().contains(CapabilityURN.BASE_1_1)) {
return true;
}
}
}
private static boolean isStateChangePermitted(final State state, final State newState) {
- if (state == State.IDLE && newState == State.OPEN_WAIT) {
- return true;
- }
- if (state == State.OPEN_WAIT && newState == State.ESTABLISHED) {
+ if (state == State.IDLE && (newState == State.OPEN_WAIT || newState == State.FAILED)) {
return true;
}
- if (state == State.OPEN_WAIT && newState == State.FAILED) {
+ if (state == State.OPEN_WAIT && (newState == State.ESTABLISHED || newState == State.FAILED)) {
return true;
}
LOG.debug("Transition from {} to {} is not allowed", state, newState);
return false;
}
- /**
- * Handler to catch exceptions in pipeline during negotiation.
- */
- private final class ExceptionHandlingInboundChannelHandler extends ChannelInboundHandlerAdapter {
- @Override
- public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) {
- LOG.warn("An exception occurred during negotiation with {} on channel {}",
- channel.remoteAddress(), channel, cause);
- // FIXME: this is quite suspect as it is competing with timeoutExpired() without synchronization
- cancelTimeout();
- negotiationFailed(cause);
- changeState(State.FAILED);
- }
- }
-
protected final void negotiationSuccessful(final S session) {
LOG.debug("Negotiation on channel {} successful with session {}", channel, session);
channel.pipeline().replace(this, "session", session);
promise.setFailure(cause);
}
- /**
- * Send a message to peer and fail negotiation if it does not reach
- * the peer.
- *
- * @param msg Message which should be sent.
- */
- protected final void sendMessage(final NetconfMessage msg) {
- this.channel.writeAndFlush(msg).addListener(f -> {
- if (!f.isSuccess()) {
- LOG.info("Failed to send message {} on channel {}", msg, channel, f.cause());
- negotiationFailed(f.cause());
- } else {
- LOG.trace("Message {} sent to socket on channel {}", msg, channel);
- }
- });
- }
-
@Override
@SuppressWarnings("checkstyle:illegalCatch")
public final void channelActive(final ChannelHandlerContext ctx) {
@Override
@SuppressWarnings("checkstyle:illegalCatch")
public final void channelRead(final ChannelHandlerContext ctx, final Object msg) {
+ if (state() == State.FAILED) {
+ // We have already failed -- do not process any more messages
+ return;
+ }
+
LOG.debug("Negotiation read invoked on channel {}", channel);
try {
- handleMessage((NetconfHelloMessage) msg);
+ handleMessage((HelloMessage) msg);
} catch (final Exception e) {
LOG.debug("Unexpected error while handling negotiation message {} on channel {}", msg, channel, e);
negotiationFailed(e);
negotiationFailed(cause);
}
- protected abstract void handleMessage(NetconfHelloMessage msg) throws Exception;
+ protected abstract void handleMessage(HelloMessage msg) throws Exception;
}
Code Review / netconf.git / blobdiff