/**
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ * Copyright (c) 2013-2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
package org.opendaylight.openflowplugin.openflow.md.core;
-import java.math.BigInteger;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
import java.util.concurrent.Future;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
-import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
import org.opendaylight.openflowjava.protocol.api.connection.ConnectionReadyListener;
+import org.opendaylight.openflowplugin.api.OFConstants;
+import org.opendaylight.openflowplugin.api.openflow.md.core.ConnectionConductor;
+import org.opendaylight.openflowplugin.api.openflow.md.core.ErrorHandler;
+import org.opendaylight.openflowplugin.api.openflow.md.core.HandshakeListener;
+import org.opendaylight.openflowplugin.api.openflow.md.core.NotificationEnqueuer;
+import org.opendaylight.openflowplugin.api.openflow.md.core.NotificationQueueWrapper;
+import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
+import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionContext;
+import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionManager;
+import org.opendaylight.openflowplugin.api.openflow.md.queue.QueueKeeper;
+import org.opendaylight.openflowplugin.api.openflow.md.queue.QueueKeeper.QueueType;
+import org.opendaylight.openflowplugin.api.openflow.md.queue.QueueProcessor;
+import org.opendaylight.openflowplugin.api.openflow.md.queue.WaterMarkListener;
+import org.opendaylight.openflowplugin.api.openflow.md.queue.WaterMarkListenerImpl;
import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
-import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
-import org.opendaylight.openflowplugin.openflow.md.core.session.SessionManager;
-import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeper;
-import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdated;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdatedBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder;
+import org.opendaylight.openflowplugin.openflow.md.core.session.PortFeaturesUtil;
+import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeperFactory;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoInputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDesc;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCaseBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
* @author mirehak
*/
public class ConnectionConductorImpl implements OpenflowProtocolListener,
- SystemNotificationsListener, ConnectionConductor, ConnectionReadyListener, HandshakeListener {
+ SystemNotificationsListener, ConnectionConductor,
+ ConnectionReadyListener, HandshakeListener, NotificationEnqueuer,
+ AutoCloseable {
+
+ /**
+ * ingress queue limit
+ */
+ private static final int INGRESS_QUEUE_MAX_SIZE = 200;
protected static final Logger LOG = LoggerFactory
.getLogger(ConnectionConductorImpl.class);
- /* variable to make BitMap-based negotiation enabled / disabled.
- * it will help while testing and isolating issues related to processing of
- * BitMaps from switches.
+ /*
+ * variable to make BitMap-based negotiation enabled / disabled. it will
+ * help while testing and isolating issues related to processing of BitMaps
+ * from switches.
*/
- protected boolean isBitmapNegotiationEnable = true;
+ private boolean isBitmapNegotiationEnable = true;
protected ErrorHandler errorHandler;
private final ConnectionAdapter connectionAdapter;
private ConnectionConductor.CONDUCTOR_STATE conductorState;
private Short version;
- private SwitchConnectionDistinguisher auxiliaryKey;
-
- private SessionContext sessionContext;
+ protected SwitchConnectionDistinguisher auxiliaryKey;
- protected boolean isFirstHelloNegotiation = true;
- protected Short lastProposedVersion = null;
+ protected SessionContext sessionContext;
- private QueueKeeper<OfHeader, DataObject> queueKeeper;
- private ExecutorService hsPool;
+ private QueueProcessor<OfHeader, DataObject> queueProcessor;
+ private QueueKeeper<OfHeader> queue;
+ private ThreadPoolExecutor hsPool;
private HandshakeManager handshakeManager;
+ private boolean firstHelloProcessed;
+
+ private PortFeaturesUtil portFeaturesUtils;
+
+ private int conductorId;
+
+ private int ingressMaxQueueSize;
+
/**
* @param connectionAdapter
*/
public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
+ this(connectionAdapter, INGRESS_QUEUE_MAX_SIZE);
+ }
+
+ /**
+ * @param connectionAdapter
+ * @param ingressMaxQueueSize
+ * ingress queue limit (blocking)
+ */
+ public ConnectionConductorImpl(ConnectionAdapter connectionAdapter,
+ int ingressMaxQueueSize) {
this.connectionAdapter = connectionAdapter;
+ this.ingressMaxQueueSize = ingressMaxQueueSize;
conductorState = CONDUCTOR_STATE.HANDSHAKING;
- hsPool = Executors.newFixedThreadPool(1);
+ firstHelloProcessed = false;
handshakeManager = new HandshakeManagerImpl(connectionAdapter,
- ConnectionConductor.versionOrder.get(0), ConnectionConductor.versionOrder);
+ ConnectionConductor.versionOrder.get(0),
+ ConnectionConductor.versionOrder);
handshakeManager.setUseVersionBitmap(isBitmapNegotiationEnable);
handshakeManager.setHandshakeListener(this);
+ portFeaturesUtils = PortFeaturesUtil.getInstance();
}
@Override
public void init() {
+ int handshakeThreadLimit = 1;
+ hsPool = new ThreadPoolLoggingExecutor(handshakeThreadLimit,
+ handshakeThreadLimit, 0L, TimeUnit.MILLISECONDS,
+ new LinkedBlockingQueue<Runnable>(), "OFHandshake-"
+ + conductorId);
+
connectionAdapter.setMessageListener(this);
connectionAdapter.setSystemListener(this);
connectionAdapter.setConnectionReadyListener(this);
+ WaterMarkListener waterMarkListener = new WaterMarkListenerImpl(
+ connectionAdapter);
+ queue = QueueKeeperFactory.createFairQueueKeeper(queueProcessor,
+ ingressMaxQueueSize, waterMarkListener);
}
@Override
- public void setQueueKeeper(QueueKeeper<OfHeader, DataObject> queueKeeper) {
- this.queueKeeper = queueKeeper;
+ public void setQueueProcessor(
+ QueueProcessor<OfHeader, DataObject> queueProcessor) {
+ this.queueProcessor = queueProcessor;
}
/**
- * @param errorHandler the errorHandler to set
+ * @param errorHandler
+ * the errorHandler to set
*/
@Override
public void setErrorHandler(ErrorHandler errorHandler) {
new Thread(new Runnable() {
@Override
public void run() {
- LOG.debug("echo request received: " + echoRequestMessage.getXid());
+ LOG.debug("echo request received: "
+ + echoRequestMessage.getXid());
EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
builder.setVersion(echoRequestMessage.getVersion());
builder.setXid(echoRequestMessage.getXid());
@Override
public void onErrorMessage(ErrorMessage errorMessage) {
- queueKeeper.push(errorMessage, this);
+ enqueueMessage(errorMessage);
+ }
+
+ /**
+ * @param message
+ */
+ private void enqueueMessage(OfHeader message) {
+ enqueueMessage(message, QueueType.DEFAULT);
+ }
+
+ @Override
+ public void enqueueNotification(NotificationQueueWrapper notification) {
+ enqueueMessage(notification);
+ }
+
+ /**
+ * @param message
+ * @param queueType
+ * enqueue type
+ */
+ private void enqueueMessage(OfHeader message, QueueType queueType) {
+ queue.push(message, this, queueType);
}
@Override
public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
- queueKeeper.push(experimenterMessage, this);
+ enqueueMessage(experimenterMessage);
}
@Override
public void onFlowRemovedMessage(FlowRemovedMessage message) {
- queueKeeper.push(message, this);
+ enqueueMessage(message);
}
-
/**
- * version negotiation happened as per following steps:
- * 1. If HelloMessage version field has same version, continue connection processing.
- * If HelloMessage version is lower than supported versions, just disconnect.
+ * version negotiation happened as per following steps: 1. If HelloMessage
+ * version field has same version, continue connection processing. If
+ * HelloMessage version is lower than supported versions, just disconnect.
* 2. If HelloMessage contains bitmap and common version found in bitmap
- * then continue connection processing. if no common version found, just disconnect.
- * 3. If HelloMessage version is not supported, send HelloMessage with lower supported version.
- * 4. If Hello message received again with not supported version, just disconnect.
- *
- * TODO: Better to handle handshake into a maintainable innerclass which uses State-Pattern.
+ * then continue connection processing. if no common version found, just
+ * disconnect. 3. If HelloMessage version is not supported, send
+ * HelloMessage with lower supported version. 4. If Hello message received
+ * again with not supported version, just disconnect.
*/
@Override
- public synchronized void onHelloMessage(final HelloMessage hello) {
- LOG.debug("processing HELLO.xid{}", hello.getXid());
+ public void onHelloMessage(final HelloMessage hello) {
+ LOG.debug("processing HELLO.xid: {}", hello.getXid());
+ firstHelloProcessed = true;
checkState(CONDUCTOR_STATE.HANDSHAKING);
- handshakeManager.setReceivedHello(hello);
- hsPool.execute(handshakeManager);
+ HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
+ hello, handshakeManager, connectionAdapter);
+ hsPool.submit(handshakeStepWrapper);
}
/**
@Override
public void onMultipartReplyMessage(MultipartReplyMessage message) {
- queueKeeper.push(message, this);
+ enqueueMessage(message);
}
@Override
public void onPacketInMessage(PacketInMessage message) {
- queueKeeper.push(message, this);
+ enqueueMessage(message, QueueKeeper.QueueType.UNORDERED);
}
@Override
public void onPortStatusMessage(PortStatusMessage message) {
- this.getSessionContext().processPortStatusMsg(message);
- queueKeeper.push(message, this);
+ processPortStatusMsg(message);
+ enqueueMessage(message);
+ }
+
+ protected void processPortStatusMsg(PortStatus msg) {
+ if (msg.getReason().getIntValue() == 2) {
+ updatePort(msg);
+ } else if (msg.getReason().getIntValue() == 0) {
+ updatePort(msg);
+ } else if (msg.getReason().getIntValue() == 1) {
+ deletePort(msg);
+ }
+ }
+
+ protected void updatePort(PortStatus msg) {
+ Long portNumber = msg.getPortNo();
+ Boolean portBandwidth = portFeaturesUtils.getPortBandwidth(msg);
+
+ if (portBandwidth == null) {
+ LOG.debug(
+ "can't get bandwidth info from port: {}, aborting port update",
+ msg.toString());
+ } else {
+ this.getSessionContext().getPhysicalPorts().put(portNumber, msg);
+ this.getSessionContext().getPortsBandwidth()
+ .put(portNumber, portBandwidth);
+ }
+ }
+
+ protected void deletePort(PortGrouping port) {
+ Long portNumber = port.getPortNo();
+
+ this.getSessionContext().getPhysicalPorts().remove(portNumber);
+ this.getSessionContext().getPortsBandwidth().remove(portNumber);
}
@Override
@Override
public void run() {
if (!CONDUCTOR_STATE.WORKING.equals(getConductorState())) {
- // idle state in any other conductorState than WORKING means real
- // problem and wont be handled by echoReply, but disconnection
+ // idle state in any other conductorState than WORKING means
+ // real
+ // problem and wont be handled by echoReply, but
+ // disconnection
disconnect();
- OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
+ OFSessionUtil.getSessionManager().invalidateOnDisconnect(
+ ConnectionConductorImpl.this);
} else {
- LOG.debug("first idle state occured");
+ LOG.debug(
+ "first idle state occured, sessionCtx={}|auxId={}",
+ sessionContext, auxiliaryKey);
EchoInputBuilder builder = new EchoInputBuilder();
builder.setVersion(getVersion());
builder.setXid(getSessionContext().getNextXid());
.echo(builder.build());
try {
- RpcResult<EchoOutput> echoReplyValue = echoReplyFuture.get(getMaxTimeout(),
- getMaxTimeoutUnit());
+ RpcResult<EchoOutput> echoReplyValue = echoReplyFuture
+ .get(getMaxTimeout(), getMaxTimeoutUnit());
if (echoReplyValue.isSuccessful()) {
setConductorState(CONDUCTOR_STATE.WORKING);
} else {
- for (RpcError replyError : echoReplyValue.getErrors()) {
+ for (RpcError replyError : echoReplyValue
+ .getErrors()) {
Throwable cause = replyError.getCause();
LOG.error(
"while receiving echoReply in TIMEOUTING state: "
+ cause.getMessage(), cause);
}
- //switch issue occurred
+ // switch issue occurred
throw new Exception("switch issue occurred");
}
} catch (Exception e) {
LOG.error("while waiting for echoReply in TIMEOUTING state: "
- + e.getMessage(), e);
- //switch is not responding
+ + e.getMessage());
+ errorHandler.handleException(e, sessionContext);
+ // switch is not responding
disconnect();
- OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
+ OFSessionUtil.getSessionManager()
+ .invalidateOnDisconnect(
+ ConnectionConductorImpl.this);
}
}
}
}
/**
- * @param handshaking
+ * @param expectedState
*/
protected void checkState(CONDUCTOR_STATE expectedState) {
if (!conductorState.equals(expectedState)) {
public void onDisconnectEvent(DisconnectEvent arg0) {
SessionManager sessionManager = OFSessionUtil.getSessionManager();
sessionManager.invalidateOnDisconnect(this);
+ close();
}
@Override
@Override
public Future<Boolean> disconnect() {
- LOG.info("disconnecting: sessionCtx="+sessionContext+"|auxId="+auxiliaryKey);
+ LOG.trace("disconnecting: sessionCtx={}|auxId={}", sessionContext,
+ auxiliaryKey);
Future<Boolean> result = null;
if (connectionAdapter.isAlive()) {
LOG.debug("connection already disconnected");
result = Futures.immediateFuture(true);
}
-
+ close();
return result;
}
@Override
public void onConnectionReady() {
LOG.debug("connection is ready-to-use");
- hsPool.execute(handshakeManager);
+ if (!firstHelloProcessed) {
+ HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
+ null, handshakeManager, connectionAdapter);
+ hsPool.execute(handshakeStepWrapper);
+ firstHelloProcessed = true;
+ } else {
+ LOG.debug("already touched by hello message");
+ }
}
@Override
public void onHandshakeSuccessfull(GetFeaturesOutput featureOutput,
Short negotiatedVersion) {
+ postHandshakeBasic(featureOutput, negotiatedVersion);
+
+ // post-handshake actions
+ if (version == OFConstants.OFP_VERSION_1_3) {
+ requestPorts();
+ requestGroupFeatures();
+ requestMeterFeatures();
+ }
+
+ requestDesc();
+ }
+
+ @Override
+ public void onHandshakeFailure() {
+ LOG.info("OF handshake failed, doing cleanup.");
+ close();
+ }
+
+ /**
+ * used by tests
+ *
+ * @param featureOutput
+ * @param negotiatedVersion
+ */
+ protected void postHandshakeBasic(GetFeaturesOutput featureOutput,
+ Short negotiatedVersion) {
version = negotiatedVersion;
- conductorState = CONDUCTOR_STATE.WORKING;
+ if (version == OFConstants.OFP_VERSION_1_0) {
+ // Because the GetFeaturesOutput contains information about the port
+ // in OF1.0 (that we would otherwise get from the PortDesc) we have
+ // to pass
+ // it up for parsing to convert into a NodeConnectorUpdate
+ //
+ // BUG-1988 - this must be the first item in queue in order not to
+ // get behind link-up message
+ enqueueMessage(featureOutput);
+ }
+
OFSessionUtil.registerSession(this, featureOutput, negotiatedVersion);
- requestDesc();
+ hsPool.shutdown();
+ hsPool.purge();
+ conductorState = CONDUCTOR_STATE.WORKING;
+ QueueKeeperFactory.plugQueue(queueProcessor, queue);
}
/*
- * Send an OFPMP_DESC request message to the switch
+ * Send an OFPMP_DESC request message to the switch
*/
-
private void requestDesc() {
MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
builder.setType(MultipartType.OFPMPDESC);
builder.setVersion(getVersion());
builder.setFlags(new MultipartRequestFlags(false));
- builder.setMultipartRequestBody(new MultipartRequestDescBuilder().build());
+ builder.setMultipartRequestBody(new MultipartRequestDescCaseBuilder()
+ .build());
builder.setXid(getSessionContext().getNextXid());
getConnectionAdapter().multipartRequest(builder.build());
}
+ private void requestPorts() {
+ MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
+ builder.setType(MultipartType.OFPMPPORTDESC);
+ builder.setVersion(getVersion());
+ builder.setFlags(new MultipartRequestFlags(false));
+ builder.setMultipartRequestBody(new MultipartRequestPortDescCaseBuilder()
+ .build());
+ builder.setXid(getSessionContext().getNextXid());
+ getConnectionAdapter().multipartRequest(builder.build());
+ }
+
+ private void requestGroupFeatures() {
+ MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
+ mprInput.setType(MultipartType.OFPMPGROUPFEATURES);
+ mprInput.setVersion(getVersion());
+ mprInput.setFlags(new MultipartRequestFlags(false));
+ mprInput.setXid(getSessionContext().getNextXid());
+
+ MultipartRequestGroupFeaturesCaseBuilder mprGroupFeaturesBuild = new MultipartRequestGroupFeaturesCaseBuilder();
+ mprInput.setMultipartRequestBody(mprGroupFeaturesBuild.build());
+
+ LOG.debug("Send group features statistics request :{}",
+ mprGroupFeaturesBuild);
+ getConnectionAdapter().multipartRequest(mprInput.build());
+
+ }
+
+ private void requestMeterFeatures() {
+ MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
+ mprInput.setType(MultipartType.OFPMPMETERFEATURES);
+ mprInput.setVersion(getVersion());
+ mprInput.setFlags(new MultipartRequestFlags(false));
+ mprInput.setXid(getSessionContext().getNextXid());
+
+ MultipartRequestMeterFeaturesCaseBuilder mprMeterFeaturesBuild = new MultipartRequestMeterFeaturesCaseBuilder();
+ mprInput.setMultipartRequestBody(mprMeterFeaturesBuild.build());
+
+ LOG.debug("Send meter features statistics request :{}",
+ mprMeterFeaturesBuild);
+ getConnectionAdapter().multipartRequest(mprInput.build());
+
+ }
+
/**
- * @param isBitmapNegotiationEnable the isBitmapNegotiationEnable to set
+ * @param isBitmapNegotiationEnable
+ * the isBitmapNegotiationEnable to set
*/
- public void setBitmapNegotiationEnable(
- boolean isBitmapNegotiationEnable) {
+ public void setBitmapNegotiationEnable(boolean isBitmapNegotiationEnable) {
this.isBitmapNegotiationEnable = isBitmapNegotiationEnable;
}
hsPool.shutdownNow();
LOG.debug("pool is terminated: {}", hsPool.isTerminated());
}
+
+ protected void shutdownPoolPolitely() {
+ hsPool.shutdown();
+ try {
+ hsPool.awaitTermination(1, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {
+ LOG.info("Error while awaiting termination on pool. Will use shutdownNow method.");
+ shutdownPool();
+ }
+ hsPool.purge();
+ LOG.debug("pool is terminated: {}", hsPool.isTerminated());
+ }
+
+ @Override
+ public void setId(int conductorId) {
+ this.conductorId = conductorId;
+ }
+
+ @Override
+ public void close() {
+ shutdownPoolPolitely();
+ conductorState = CONDUCTOR_STATE.RIP;
+ }
}
Code Review / openflowplugin.git / blobdiff