2 * Copyright (c) 2013-2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowplugin.openflow.md.core;
11 import com.google.common.annotations.VisibleForTesting;
12 import com.google.common.util.concurrent.Futures;
13 import java.util.concurrent.Future;
14 import java.util.concurrent.LinkedBlockingQueue;
15 import java.util.concurrent.ThreadPoolExecutor;
16 import java.util.concurrent.TimeUnit;
17 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
18 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionReadyListener;
19 import org.opendaylight.openflowplugin.api.OFConstants;
20 import org.opendaylight.openflowplugin.api.openflow.connection.HandshakeContext;
21 import org.opendaylight.openflowplugin.api.openflow.md.core.ConnectionConductor;
22 import org.opendaylight.openflowplugin.api.openflow.md.core.ErrorHandler;
23 import org.opendaylight.openflowplugin.api.openflow.md.core.HandshakeListener;
24 import org.opendaylight.openflowplugin.api.openflow.md.core.HandshakeManager;
25 import org.opendaylight.openflowplugin.api.openflow.md.core.NotificationEnqueuer;
26 import org.opendaylight.openflowplugin.api.openflow.md.core.NotificationQueueWrapper;
27 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
28 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionContext;
29 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionManager;
30 import org.opendaylight.openflowplugin.api.openflow.md.queue.QueueKeeper;
31 import org.opendaylight.openflowplugin.api.openflow.md.queue.QueueKeeper.QueueType;
32 import org.opendaylight.openflowplugin.api.openflow.md.queue.QueueProcessor;
33 import org.opendaylight.openflowplugin.api.openflow.md.queue.WaterMarkListener;
34 import org.opendaylight.openflowplugin.api.openflow.md.queue.WaterMarkListenerImpl;
35 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
36 import org.opendaylight.openflowplugin.openflow.md.core.session.PortFeaturesUtil;
37 import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeperFactory;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoInputBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInputBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCaseBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
64 import org.opendaylight.yangtools.yang.binding.DataObject;
65 import org.opendaylight.yangtools.yang.common.RpcError;
66 import org.opendaylight.yangtools.yang.common.RpcResult;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
73 public class ConnectionConductorImpl implements OpenflowProtocolListener,
74 SystemNotificationsListener, ConnectionConductor,
75 ConnectionReadyListener, HandshakeListener, NotificationEnqueuer,
81 private static final int INGRESS_QUEUE_MAX_SIZE = 200;
83 protected static final Logger LOG = LoggerFactory
84 .getLogger(ConnectionConductorImpl.class);
87 * variable to make BitMap-based negotiation enabled / disabled. it will
88 * help while testing and isolating issues related to processing of BitMaps
91 private boolean isBitmapNegotiationEnable = true;
92 protected ErrorHandler errorHandler;
94 private final ConnectionAdapter connectionAdapter;
95 private ConnectionConductor.CONDUCTOR_STATE conductorState;
96 private Short version;
98 protected SwitchConnectionDistinguisher auxiliaryKey;
100 protected SessionContext sessionContext;
102 private QueueProcessor<OfHeader, DataObject> queueProcessor;
103 private QueueKeeper<OfHeader> queue;
104 private ThreadPoolExecutor hsPool;
105 private HandshakeManager handshakeManager;
107 private boolean firstHelloProcessed;
109 private PortFeaturesUtil portFeaturesUtils;
111 private int conductorId;
113 private int ingressMaxQueueSize;
114 private HandshakeContext handshakeContext;
117 * @param connectionAdapter
119 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
120 this(connectionAdapter, INGRESS_QUEUE_MAX_SIZE);
124 * @param connectionAdapter
125 * @param ingressMaxQueueSize
126 * ingress queue limit (blocking)
128 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter,
129 int ingressMaxQueueSize) {
130 this.connectionAdapter = connectionAdapter;
131 this.ingressMaxQueueSize = ingressMaxQueueSize;
132 conductorState = CONDUCTOR_STATE.HANDSHAKING;
133 firstHelloProcessed = false;
134 handshakeManager = new HandshakeManagerImpl(connectionAdapter,
135 ConnectionConductor.versionOrder.get(0),
136 ConnectionConductor.versionOrder);
137 handshakeManager.setUseVersionBitmap(isBitmapNegotiationEnable);
138 handshakeManager.setHandshakeListener(this);
139 portFeaturesUtils = PortFeaturesUtil.getInstance();
144 int handshakeThreadLimit = 1;
145 hsPool = new ThreadPoolLoggingExecutor(handshakeThreadLimit,
146 handshakeThreadLimit, 0L, TimeUnit.MILLISECONDS,
147 new LinkedBlockingQueue<Runnable>(), "OFHandshake-"
150 connectionAdapter.setMessageListener(this);
151 connectionAdapter.setSystemListener(this);
152 connectionAdapter.setConnectionReadyListener(this);
153 WaterMarkListener waterMarkListener = new WaterMarkListenerImpl(
155 queue = QueueKeeperFactory.createFairQueueKeeper(queueProcessor,
156 ingressMaxQueueSize, waterMarkListener);
160 public void setQueueProcessor(
161 QueueProcessor<OfHeader, DataObject> queueProcessor) {
162 this.queueProcessor = queueProcessor;
166 * @param errorHandler
167 * the errorHandler to set
170 public void setErrorHandler(ErrorHandler errorHandler) {
171 this.errorHandler = errorHandler;
172 handshakeManager.setErrorHandler(errorHandler);
176 public void onEchoRequestMessage(final EchoRequestMessage echoRequestMessage) {
177 new Thread(new Runnable() {
180 LOG.debug("echo request received: "
181 + echoRequestMessage.getXid());
182 EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
183 builder.setVersion(echoRequestMessage.getVersion());
184 builder.setXid(echoRequestMessage.getXid());
185 builder.setData(echoRequestMessage.getData());
187 getConnectionAdapter().echoReply(builder.build());
193 public void onErrorMessage(ErrorMessage errorMessage) {
194 enqueueMessage(errorMessage);
200 private void enqueueMessage(OfHeader message) {
201 enqueueMessage(message, QueueType.DEFAULT);
205 public void enqueueNotification(NotificationQueueWrapper notification) {
206 enqueueMessage(notification);
214 private void enqueueMessage(OfHeader message, QueueType queueType) {
215 queue.push(message, this, queueType);
219 public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
220 enqueueMessage(experimenterMessage);
224 public void onFlowRemovedMessage(FlowRemovedMessage message) {
225 enqueueMessage(message);
229 * version negotiation happened as per following steps: 1. If HelloMessage
230 * version field has same version, continue connection processing. If
231 * HelloMessage version is lower than supported versions, just disconnect.
232 * 2. If HelloMessage contains bitmap and common version found in bitmap
233 * then continue connection processing. if no common version found, just
234 * disconnect. 3. If HelloMessage version is not supported, send
235 * HelloMessage with lower supported version. 4. If Hello message received
236 * again with not supported version, just disconnect.
239 public void onHelloMessage(final HelloMessage hello) {
240 LOG.debug("processing HELLO.xid: {}", hello.getXid());
241 firstHelloProcessed = true;
242 checkState(CONDUCTOR_STATE.HANDSHAKING);
243 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
244 hello, handshakeManager, connectionAdapter);
245 hsPool.submit(handshakeStepWrapper);
249 * @return rpc-response timeout in [ms]
251 protected long getMaxTimeout() {
252 // TODO:: get from configuration
257 * @return milliseconds
259 protected TimeUnit getMaxTimeoutUnit() {
260 // TODO:: get from configuration
261 return TimeUnit.MILLISECONDS;
265 public void onMultipartReplyMessage(MultipartReplyMessage message) {
266 enqueueMessage(message);
270 public void onPacketInMessage(PacketInMessage message) {
271 enqueueMessage(message, QueueKeeper.QueueType.UNORDERED);
275 public void onPortStatusMessage(PortStatusMessage message) {
276 processPortStatusMsg(message);
277 enqueueMessage(message);
280 protected void processPortStatusMsg(PortStatus msg) {
281 if (msg.getReason().getIntValue() == 2) {
283 } else if (msg.getReason().getIntValue() == 0) {
285 } else if (msg.getReason().getIntValue() == 1) {
290 protected void updatePort(PortStatus msg) {
291 Long portNumber = msg.getPortNo();
292 Boolean portBandwidth = portFeaturesUtils.getPortBandwidth(msg);
294 if (portBandwidth == null) {
296 "can't get bandwidth info from port: {}, aborting port update",
299 this.getSessionContext().getPhysicalPorts().put(portNumber, msg);
300 this.getSessionContext().getPortsBandwidth()
301 .put(portNumber, portBandwidth);
305 protected void deletePort(PortGrouping port) {
306 Long portNumber = port.getPortNo();
308 this.getSessionContext().getPhysicalPorts().remove(portNumber);
309 this.getSessionContext().getPortsBandwidth().remove(portNumber);
313 public void onSwitchIdleEvent(SwitchIdleEvent notification) {
314 new Thread(new Runnable() {
317 if (!CONDUCTOR_STATE.WORKING.equals(getConductorState())) {
318 // idle state in any other conductorState than WORKING means
320 // problem and wont be handled by echoReply, but
323 OFSessionUtil.getSessionManager().invalidateOnDisconnect(
324 ConnectionConductorImpl.this);
327 "first idle state occured, sessionCtx={}|auxId={}",
328 sessionContext, auxiliaryKey);
329 EchoInputBuilder builder = new EchoInputBuilder();
330 builder.setVersion(getVersion());
331 builder.setXid(getSessionContext().getNextXid());
333 Future<RpcResult<EchoOutput>> echoReplyFuture = getConnectionAdapter()
334 .echo(builder.build());
337 RpcResult<EchoOutput> echoReplyValue = echoReplyFuture
338 .get(getMaxTimeout(), getMaxTimeoutUnit());
339 if (echoReplyValue.isSuccessful()) {
340 setConductorState(CONDUCTOR_STATE.WORKING);
342 for (RpcError replyError : echoReplyValue
344 Throwable cause = replyError.getCause();
346 "while receiving echoReply in TIMEOUTING state: "
347 + cause.getMessage(), cause);
349 // switch issue occurred
350 throw new Exception("switch issue occurred");
352 } catch (Exception e) {
353 LOG.error("while waiting for echoReply in TIMEOUTING state: "
355 errorHandler.handleException(e, sessionContext);
356 // switch is not responding
358 OFSessionUtil.getSessionManager()
359 .invalidateOnDisconnect(
360 ConnectionConductorImpl.this);
369 * @param conductorState
370 * the connectionState to set
373 public void setConductorState(CONDUCTOR_STATE conductorState) {
374 this.conductorState = conductorState;
378 public CONDUCTOR_STATE getConductorState() {
379 return conductorState;
383 * @param expectedState
385 protected void checkState(CONDUCTOR_STATE expectedState) {
386 if (!conductorState.equals(expectedState)) {
387 throw new IllegalStateException("Expected state: " + expectedState
388 + ", actual state:" + conductorState);
393 public void onDisconnectEvent(DisconnectEvent arg0) {
394 SessionManager sessionManager = OFSessionUtil.getSessionManager();
395 sessionManager.invalidateOnDisconnect(this);
400 public Short getVersion() {
405 public Future<Boolean> disconnect() {
406 LOG.trace("disconnecting: sessionCtx={}|auxId={}", sessionContext,
409 Future<Boolean> result = null;
410 if (connectionAdapter.isAlive()) {
411 result = connectionAdapter.disconnect();
413 LOG.debug("connection already disconnected");
414 result = Futures.immediateFuture(true);
421 public void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey) {
422 this.auxiliaryKey = auxiliaryKey;
426 public void setSessionContext(SessionContext sessionContext) {
427 this.sessionContext = sessionContext;
431 public SwitchConnectionDistinguisher getAuxiliaryKey() {
436 public SessionContext getSessionContext() {
437 return sessionContext;
441 public ConnectionAdapter getConnectionAdapter() {
442 return connectionAdapter;
446 public void onConnectionReady() {
447 LOG.debug("connection is ready-to-use");
448 if (!firstHelloProcessed) {
449 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
450 null, handshakeManager, connectionAdapter);
451 hsPool.execute(handshakeStepWrapper);
452 firstHelloProcessed = true;
454 LOG.debug("already touched by hello message");
459 public void onHandshakeSuccessfull(GetFeaturesOutput featureOutput,
460 Short negotiatedVersion) {
461 postHandshakeBasic(featureOutput, negotiatedVersion);
463 // post-handshake actions
464 if (version == OFConstants.OFP_VERSION_1_3) {
466 requestGroupFeatures();
467 requestMeterFeatures();
474 public void onHandshakeFailure() {
475 LOG.info("OF handshake failed, doing cleanup.");
482 * @param featureOutput
483 * @param negotiatedVersion
485 protected void postHandshakeBasic(GetFeaturesOutput featureOutput,
486 Short negotiatedVersion) {
487 version = negotiatedVersion;
488 if (version == OFConstants.OFP_VERSION_1_0) {
489 // Because the GetFeaturesOutput contains information about the port
490 // in OF1.0 (that we would otherwise get from the PortDesc) we have
492 // it up for parsing to convert into a NodeConnectorUpdate
494 // BUG-1988 - this must be the first item in queue in order not to
495 // get behind link-up message
496 enqueueMessage(featureOutput);
499 OFSessionUtil.registerSession(this, featureOutput, negotiatedVersion);
502 conductorState = CONDUCTOR_STATE.WORKING;
503 QueueKeeperFactory.plugQueue(queueProcessor, queue);
507 * Send an OFPMP_DESC request message to the switch
509 private void requestDesc() {
510 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
511 builder.setType(MultipartType.OFPMPDESC);
512 builder.setVersion(getVersion());
513 builder.setFlags(new MultipartRequestFlags(false));
514 builder.setMultipartRequestBody(new MultipartRequestDescCaseBuilder()
516 builder.setXid(getSessionContext().getNextXid());
517 getConnectionAdapter().multipartRequest(builder.build());
520 private void requestPorts() {
521 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
522 builder.setType(MultipartType.OFPMPPORTDESC);
523 builder.setVersion(getVersion());
524 builder.setFlags(new MultipartRequestFlags(false));
525 builder.setMultipartRequestBody(new MultipartRequestPortDescCaseBuilder()
527 builder.setXid(getSessionContext().getNextXid());
528 getConnectionAdapter().multipartRequest(builder.build());
531 private void requestGroupFeatures() {
532 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
533 mprInput.setType(MultipartType.OFPMPGROUPFEATURES);
534 mprInput.setVersion(getVersion());
535 mprInput.setFlags(new MultipartRequestFlags(false));
536 mprInput.setXid(getSessionContext().getNextXid());
538 MultipartRequestGroupFeaturesCaseBuilder mprGroupFeaturesBuild = new MultipartRequestGroupFeaturesCaseBuilder();
539 mprInput.setMultipartRequestBody(mprGroupFeaturesBuild.build());
541 LOG.debug("Send group features statistics request :{}",
542 mprGroupFeaturesBuild);
543 getConnectionAdapter().multipartRequest(mprInput.build());
547 private void requestMeterFeatures() {
548 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
549 mprInput.setType(MultipartType.OFPMPMETERFEATURES);
550 mprInput.setVersion(getVersion());
551 mprInput.setFlags(new MultipartRequestFlags(false));
552 mprInput.setXid(getSessionContext().getNextXid());
554 MultipartRequestMeterFeaturesCaseBuilder mprMeterFeaturesBuild = new MultipartRequestMeterFeaturesCaseBuilder();
555 mprInput.setMultipartRequestBody(mprMeterFeaturesBuild.build());
557 LOG.debug("Send meter features statistics request :{}",
558 mprMeterFeaturesBuild);
559 getConnectionAdapter().multipartRequest(mprInput.build());
564 * @param isBitmapNegotiationEnable
565 * the isBitmapNegotiationEnable to set
567 public void setBitmapNegotiationEnable(boolean isBitmapNegotiationEnable) {
568 this.isBitmapNegotiationEnable = isBitmapNegotiationEnable;
572 public void setId(int conductorId) {
573 this.conductorId = conductorId;
577 public void close() {
578 conductorState = CONDUCTOR_STATE.RIP;
580 handshakeContext.close();
581 } catch (Exception e) {
582 LOG.warn("Closing handshake context failed: {}", e.getMessage());
583 LOG.debug("Detail in hanshake context close:", e);
588 public void setHandshakeContext(HandshakeContext handshakeContext) {
589 this.handshakeContext = handshakeContext;
593 ThreadPoolExecutor getHsPool() {