2 * Copyright (c) 2013 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 java.util.concurrent.Future;
12 import java.util.concurrent.LinkedBlockingQueue;
13 import java.util.concurrent.ThreadPoolExecutor;
14 import java.util.concurrent.TimeUnit;
16 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
17 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionReadyListener;
18 import org.opendaylight.openflowplugin.openflow.md.OFConstants;
19 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
20 import org.opendaylight.openflowplugin.openflow.md.core.session.PortFeaturesUtil;
21 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
22 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionManager;
23 import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeper;
24 import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeper.QueueType;
25 import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeperFactory;
26 import org.opendaylight.openflowplugin.openflow.md.queue.QueueProcessor;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.SwitchConfigFlag;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoInputBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInputBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigInput;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetConfigInputBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInput;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInputBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCaseBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
58 import org.opendaylight.yangtools.yang.binding.DataObject;
59 import org.opendaylight.yangtools.yang.common.RpcError;
60 import org.opendaylight.yangtools.yang.common.RpcResult;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
64 import com.google.common.util.concurrent.Futures;
69 public class ConnectionConductorImpl implements OpenflowProtocolListener,
70 SystemNotificationsListener, ConnectionConductor, ConnectionReadyListener, HandshakeListener {
72 /** ingress queue limit */
73 private static final int INGRESS_QUEUE_MAX_SIZE = 200;
75 protected static final Logger LOG = LoggerFactory
76 .getLogger(ConnectionConductorImpl.class);
78 /* variable to make BitMap-based negotiation enabled / disabled.
79 * it will help while testing and isolating issues related to processing of
80 * BitMaps from switches.
82 private boolean isBitmapNegotiationEnable = true;
83 protected ErrorHandler errorHandler;
85 private final ConnectionAdapter connectionAdapter;
86 private ConnectionConductor.CONDUCTOR_STATE conductorState;
87 private Short version;
89 protected SwitchConnectionDistinguisher auxiliaryKey;
91 protected SessionContext sessionContext;
93 private QueueProcessor<OfHeader, DataObject> queueProcessor;
94 private QueueKeeper<OfHeader> queue;
95 private ThreadPoolExecutor hsPool;
96 private HandshakeManager handshakeManager;
98 private boolean firstHelloProcessed;
100 private PortFeaturesUtil portFeaturesUtils;
102 private int conductorId;
104 private int ingressMaxQueueSize;
108 * @param connectionAdapter
110 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
111 this(connectionAdapter, INGRESS_QUEUE_MAX_SIZE);
115 * @param connectionAdapter
116 * @param ingressMaxQueueSize ingress queue limit (blocking)
118 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter, int ingressMaxQueueSize) {
119 this.connectionAdapter = connectionAdapter;
120 this.ingressMaxQueueSize = ingressMaxQueueSize;
121 conductorState = CONDUCTOR_STATE.HANDSHAKING;
122 firstHelloProcessed = false;
123 handshakeManager = new HandshakeManagerImpl(connectionAdapter,
124 ConnectionConductor.versionOrder.get(0), ConnectionConductor.versionOrder);
125 handshakeManager.setUseVersionBitmap(isBitmapNegotiationEnable);
126 handshakeManager.setHandshakeListener(this);
127 portFeaturesUtils = PortFeaturesUtil.getInstance();
132 int handshakeThreadLimit = 1;
133 hsPool = new ThreadPoolLoggingExecutor(handshakeThreadLimit , handshakeThreadLimit, 0L,
134 TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
135 "OFHandshake-"+conductorId);
137 connectionAdapter.setMessageListener(this);
138 connectionAdapter.setSystemListener(this);
139 connectionAdapter.setConnectionReadyListener(this);
140 queue = QueueKeeperFactory.createFairQueueKeeper(queueProcessor, ingressMaxQueueSize);
144 public void setQueueProcessor(QueueProcessor<OfHeader, DataObject> queueProcessor) {
145 this.queueProcessor = queueProcessor;
149 * @param errorHandler the errorHandler to set
152 public void setErrorHandler(ErrorHandler errorHandler) {
153 this.errorHandler = errorHandler;
154 handshakeManager.setErrorHandler(errorHandler);
158 public void onEchoRequestMessage(final EchoRequestMessage echoRequestMessage) {
159 new Thread(new Runnable() {
162 LOG.debug("echo request received: " + echoRequestMessage.getXid());
163 EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
164 builder.setVersion(echoRequestMessage.getVersion());
165 builder.setXid(echoRequestMessage.getXid());
166 builder.setData(echoRequestMessage.getData());
168 getConnectionAdapter().echoReply(builder.build());
174 public void onErrorMessage(ErrorMessage errorMessage) {
175 enqueueMessage(errorMessage);
182 private void enqueueMessage(OfHeader message) {
183 enqueueMessage(message, QueueType.DEFAULT);
188 * @param queueType enqueue type
190 private void enqueueMessage(OfHeader message, QueueType queueType) {
191 queue.push(message, this, queueType);
195 public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
196 enqueueMessage(experimenterMessage);
200 public void onFlowRemovedMessage(FlowRemovedMessage message) {
201 enqueueMessage(message);
206 * version negotiation happened as per following steps:
207 * 1. If HelloMessage version field has same version, continue connection processing.
208 * If HelloMessage version is lower than supported versions, just disconnect.
209 * 2. If HelloMessage contains bitmap and common version found in bitmap
210 * then continue connection processing. if no common version found, just disconnect.
211 * 3. If HelloMessage version is not supported, send HelloMessage with lower supported version.
212 * 4. If Hello message received again with not supported version, just disconnect.
215 public void onHelloMessage(final HelloMessage hello) {
216 LOG.debug("processing HELLO.xid: {}", hello.getXid());
217 firstHelloProcessed = true;
218 checkState(CONDUCTOR_STATE.HANDSHAKING);
219 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
220 hello, handshakeManager, connectionAdapter);
221 hsPool.submit(handshakeStepWrapper);
225 * @return rpc-response timeout in [ms]
227 protected long getMaxTimeout() {
228 // TODO:: get from configuration
233 * @return milliseconds
235 protected TimeUnit getMaxTimeoutUnit() {
236 // TODO:: get from configuration
237 return TimeUnit.MILLISECONDS;
241 public void onMultipartReplyMessage(MultipartReplyMessage message) {
242 enqueueMessage(message);
246 public void onPacketInMessage(PacketInMessage message) {
247 enqueueMessage(message, QueueKeeper.QueueType.UNORDERED);
251 public void onPortStatusMessage(PortStatusMessage message) {
252 processPortStatusMsg(message);
253 enqueueMessage(message);
256 protected void processPortStatusMsg(PortStatus msg) {
257 if (msg.getReason().getIntValue() == 2) {
259 } else if (msg.getReason().getIntValue() == 0) {
261 } else if (msg.getReason().getIntValue() == 1) {
266 protected void updatePort(PortStatus msg) {
267 Long portNumber = msg.getPortNo();
268 Boolean portBandwidth = portFeaturesUtils.getPortBandwidth(msg);
270 if(portBandwidth == null) {
271 LOG.debug("can't get bandwidth info from port: {}, aborting port update", msg.toString());
273 this.getSessionContext().getPhysicalPorts().put(portNumber, msg);
274 this.getSessionContext().getPortsBandwidth().put(portNumber, portBandwidth);
278 protected void deletePort(PortGrouping port) {
279 Long portNumber = port.getPortNo();
281 this.getSessionContext().getPhysicalPorts().remove(portNumber);
282 this.getSessionContext().getPortsBandwidth().remove(portNumber);
286 public void onSwitchIdleEvent(SwitchIdleEvent notification) {
287 new Thread(new Runnable() {
290 if (!CONDUCTOR_STATE.WORKING.equals(getConductorState())) {
291 // idle state in any other conductorState than WORKING means real
292 // problem and wont be handled by echoReply, but disconnection
294 OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
296 LOG.debug("first idle state occured, sessionCtx={}|auxId={}", sessionContext, auxiliaryKey);
297 EchoInputBuilder builder = new EchoInputBuilder();
298 builder.setVersion(getVersion());
299 builder.setXid(getSessionContext().getNextXid());
301 Future<RpcResult<EchoOutput>> echoReplyFuture = getConnectionAdapter()
302 .echo(builder.build());
305 RpcResult<EchoOutput> echoReplyValue = echoReplyFuture.get(getMaxTimeout(),
306 getMaxTimeoutUnit());
307 if (echoReplyValue.isSuccessful()) {
308 setConductorState(CONDUCTOR_STATE.WORKING);
310 for (RpcError replyError : echoReplyValue.getErrors()) {
311 Throwable cause = replyError.getCause();
313 "while receiving echoReply in TIMEOUTING state: "
314 + cause.getMessage(), cause);
316 //switch issue occurred
317 throw new Exception("switch issue occurred");
319 } catch (Exception e) {
320 LOG.error("while waiting for echoReply in TIMEOUTING state: "
322 errorHandler.handleException(e, sessionContext);
323 //switch is not responding
325 OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
334 * @param conductorState
335 * the connectionState to set
338 public void setConductorState(CONDUCTOR_STATE conductorState) {
339 this.conductorState = conductorState;
343 public CONDUCTOR_STATE getConductorState() {
344 return conductorState;
348 * @param expectedState
350 protected void checkState(CONDUCTOR_STATE expectedState) {
351 if (!conductorState.equals(expectedState)) {
352 throw new IllegalStateException("Expected state: " + expectedState
353 + ", actual state:" + conductorState);
358 public void onDisconnectEvent(DisconnectEvent arg0) {
359 SessionManager sessionManager = OFSessionUtil.getSessionManager();
360 sessionManager.invalidateOnDisconnect(this);
364 public Short getVersion() {
369 public Future<Boolean> disconnect() {
370 LOG.trace("disconnecting: sessionCtx={}|auxId={}", sessionContext, auxiliaryKey);
372 Future<Boolean> result = null;
373 if (connectionAdapter.isAlive()) {
374 result = connectionAdapter.disconnect();
376 LOG.debug("connection already disconnected");
377 result = Futures.immediateFuture(true);
384 public void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey) {
385 this.auxiliaryKey = auxiliaryKey;
389 public void setSessionContext(SessionContext sessionContext) {
390 this.sessionContext = sessionContext;
394 public SwitchConnectionDistinguisher getAuxiliaryKey() {
399 public SessionContext getSessionContext() {
400 return sessionContext;
404 public ConnectionAdapter getConnectionAdapter() {
405 return connectionAdapter;
409 public void onConnectionReady() {
410 LOG.debug("connection is ready-to-use");
411 if (! firstHelloProcessed) {
412 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
413 null, handshakeManager, connectionAdapter);
414 hsPool.execute(handshakeStepWrapper);
415 firstHelloProcessed = true;
417 LOG.debug("already touched by hello message");
422 public void onHandshakeSuccessfull(GetFeaturesOutput featureOutput,
423 Short negotiatedVersion) {
424 postHandshakeBasic(featureOutput, negotiatedVersion);
426 // post-handshake actions
427 if(version == OFConstants.OFP_VERSION_1_3){
430 requestGroupFeatures();
431 requestMeterFeatures();
432 } else if (version == OFConstants.OFP_VERSION_1_0) {
433 // Because the GetFeaturesOutput contains information about the port
434 // in OF1.0 (that we would otherwise get from the PortDesc) we have to pass
435 // it up for parsing to convert into a NodeConnectorUpdate
436 enqueueMessage(featureOutput);
444 * @param featureOutput
445 * @param negotiatedVersion
447 protected void postHandshakeBasic(GetFeaturesOutput featureOutput,
448 Short negotiatedVersion) {
449 version = negotiatedVersion;
450 conductorState = CONDUCTOR_STATE.WORKING;
451 OFSessionUtil.registerSession(this, featureOutput, negotiatedVersion);
456 private void setDefaultConfig(){
457 SetConfigInputBuilder builder = new SetConfigInputBuilder();
458 builder.setVersion(getVersion());
459 builder.setXid(getSessionContext().getNextXid());
460 SwitchConfigFlag flag = SwitchConfigFlag.FRAGNORMAL;
461 builder.setFlags(flag);
462 builder.setMissSendLen(OFConstants.OFPCML_NO_BUFFER);
463 getConnectionAdapter().setConfig(builder.build());
467 * Send an OFPMP_DESC request message to the switch
469 private void requestDesc() {
470 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
471 builder.setType(MultipartType.OFPMPDESC);
472 builder.setVersion(getVersion());
473 builder.setFlags(new MultipartRequestFlags(false));
474 builder.setMultipartRequestBody(new MultipartRequestDescCaseBuilder().build());
475 builder.setXid(getSessionContext().getNextXid());
476 getConnectionAdapter().multipartRequest(builder.build());
479 private void requestPorts() {
480 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
481 builder.setType(MultipartType.OFPMPPORTDESC);
482 builder.setVersion(getVersion());
483 builder.setFlags(new MultipartRequestFlags(false));
484 builder.setMultipartRequestBody(new MultipartRequestPortDescCaseBuilder().build());
485 builder.setXid(getSessionContext().getNextXid());
486 getConnectionAdapter().multipartRequest(builder.build());
488 private void requestGroupFeatures(){
489 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
490 mprInput.setType(MultipartType.OFPMPGROUPFEATURES);
491 mprInput.setVersion(getVersion());
492 mprInput.setFlags(new MultipartRequestFlags(false));
493 mprInput.setXid(getSessionContext().getNextXid());
495 MultipartRequestGroupFeaturesCaseBuilder mprGroupFeaturesBuild =
496 new MultipartRequestGroupFeaturesCaseBuilder();
497 mprInput.setMultipartRequestBody(mprGroupFeaturesBuild.build());
499 LOG.debug("Send group features statistics request :{}",mprGroupFeaturesBuild);
500 getConnectionAdapter().multipartRequest(mprInput.build());
503 private void requestMeterFeatures(){
504 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
505 mprInput.setType(MultipartType.OFPMPMETERFEATURES);
506 mprInput.setVersion(getVersion());
507 mprInput.setFlags(new MultipartRequestFlags(false));
508 mprInput.setXid(getSessionContext().getNextXid());
510 MultipartRequestMeterFeaturesCaseBuilder mprMeterFeaturesBuild =
511 new MultipartRequestMeterFeaturesCaseBuilder();
512 mprInput.setMultipartRequestBody(mprMeterFeaturesBuild.build());
514 LOG.debug("Send meter features statistics request :{}",mprMeterFeaturesBuild);
515 getConnectionAdapter().multipartRequest(mprInput.build());
519 * @param isBitmapNegotiationEnable the isBitmapNegotiationEnable to set
521 public void setBitmapNegotiationEnable(
522 boolean isBitmapNegotiationEnable) {
523 this.isBitmapNegotiationEnable = isBitmapNegotiationEnable;
526 protected void shutdownPool() {
527 hsPool.shutdownNow();
528 LOG.debug("pool is terminated: {}", hsPool.isTerminated());
532 public void setId(int conductorId) {
533 this.conductorId = conductorId;