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.api.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.GetFeaturesOutput;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortGrouping;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.SetConfigInputBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCaseBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
55 import org.opendaylight.yangtools.yang.binding.DataObject;
56 import org.opendaylight.yangtools.yang.common.RpcError;
57 import org.opendaylight.yangtools.yang.common.RpcResult;
58 import org.slf4j.Logger;
59 import org.slf4j.LoggerFactory;
61 import com.google.common.util.concurrent.Futures;
66 public class ConnectionConductorImpl implements OpenflowProtocolListener,
67 SystemNotificationsListener, ConnectionConductor, ConnectionReadyListener, HandshakeListener {
69 /** ingress queue limit */
70 private static final int INGRESS_QUEUE_MAX_SIZE = 200;
72 protected static final Logger LOG = LoggerFactory
73 .getLogger(ConnectionConductorImpl.class);
75 /* variable to make BitMap-based negotiation enabled / disabled.
76 * it will help while testing and isolating issues related to processing of
77 * BitMaps from switches.
79 private boolean isBitmapNegotiationEnable = true;
80 protected ErrorHandler errorHandler;
82 private final ConnectionAdapter connectionAdapter;
83 private ConnectionConductor.CONDUCTOR_STATE conductorState;
84 private Short version;
86 protected SwitchConnectionDistinguisher auxiliaryKey;
88 protected SessionContext sessionContext;
90 private QueueProcessor<OfHeader, DataObject> queueProcessor;
91 private QueueKeeper<OfHeader> queue;
92 private ThreadPoolExecutor hsPool;
93 private HandshakeManager handshakeManager;
95 private boolean firstHelloProcessed;
97 private PortFeaturesUtil portFeaturesUtils;
99 private int conductorId;
101 private int ingressMaxQueueSize;
105 * @param connectionAdapter
107 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
108 this(connectionAdapter, INGRESS_QUEUE_MAX_SIZE);
112 * @param connectionAdapter
113 * @param ingressMaxQueueSize ingress queue limit (blocking)
115 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter, int ingressMaxQueueSize) {
116 this.connectionAdapter = connectionAdapter;
117 this.ingressMaxQueueSize = ingressMaxQueueSize;
118 conductorState = CONDUCTOR_STATE.HANDSHAKING;
119 firstHelloProcessed = false;
120 handshakeManager = new HandshakeManagerImpl(connectionAdapter,
121 ConnectionConductor.versionOrder.get(0), ConnectionConductor.versionOrder);
122 handshakeManager.setUseVersionBitmap(isBitmapNegotiationEnable);
123 handshakeManager.setHandshakeListener(this);
124 portFeaturesUtils = PortFeaturesUtil.getInstance();
129 int handshakeThreadLimit = 1;
130 hsPool = new ThreadPoolLoggingExecutor(handshakeThreadLimit , handshakeThreadLimit, 0L,
131 TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(),
132 "OFHandshake-"+conductorId);
134 connectionAdapter.setMessageListener(this);
135 connectionAdapter.setSystemListener(this);
136 connectionAdapter.setConnectionReadyListener(this);
137 queue = QueueKeeperFactory.createFairQueueKeeper(queueProcessor, ingressMaxQueueSize);
141 public void setQueueProcessor(QueueProcessor<OfHeader, DataObject> queueProcessor) {
142 this.queueProcessor = queueProcessor;
146 * @param errorHandler the errorHandler to set
149 public void setErrorHandler(ErrorHandler errorHandler) {
150 this.errorHandler = errorHandler;
151 handshakeManager.setErrorHandler(errorHandler);
155 public void onEchoRequestMessage(final EchoRequestMessage echoRequestMessage) {
156 new Thread(new Runnable() {
159 LOG.debug("echo request received: " + echoRequestMessage.getXid());
160 EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
161 builder.setVersion(echoRequestMessage.getVersion());
162 builder.setXid(echoRequestMessage.getXid());
163 builder.setData(echoRequestMessage.getData());
165 getConnectionAdapter().echoReply(builder.build());
171 public void onErrorMessage(ErrorMessage errorMessage) {
172 enqueueMessage(errorMessage);
179 private void enqueueMessage(OfHeader message) {
180 enqueueMessage(message, QueueType.DEFAULT);
185 * @param queueType enqueue type
187 private void enqueueMessage(OfHeader message, QueueType queueType) {
188 queue.push(message, this, queueType);
192 public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
193 enqueueMessage(experimenterMessage);
197 public void onFlowRemovedMessage(FlowRemovedMessage message) {
198 enqueueMessage(message);
203 * version negotiation happened as per following steps:
204 * 1. If HelloMessage version field has same version, continue connection processing.
205 * If HelloMessage version is lower than supported versions, just disconnect.
206 * 2. If HelloMessage contains bitmap and common version found in bitmap
207 * then continue connection processing. if no common version found, just disconnect.
208 * 3. If HelloMessage version is not supported, send HelloMessage with lower supported version.
209 * 4. If Hello message received again with not supported version, just disconnect.
212 public void onHelloMessage(final HelloMessage hello) {
213 LOG.debug("processing HELLO.xid: {}", hello.getXid());
214 firstHelloProcessed = true;
215 checkState(CONDUCTOR_STATE.HANDSHAKING);
216 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
217 hello, handshakeManager, connectionAdapter);
218 hsPool.submit(handshakeStepWrapper);
222 * @return rpc-response timeout in [ms]
224 protected long getMaxTimeout() {
225 // TODO:: get from configuration
230 * @return milliseconds
232 protected TimeUnit getMaxTimeoutUnit() {
233 // TODO:: get from configuration
234 return TimeUnit.MILLISECONDS;
238 public void onMultipartReplyMessage(MultipartReplyMessage message) {
239 enqueueMessage(message);
243 public void onPacketInMessage(PacketInMessage message) {
244 enqueueMessage(message, QueueKeeper.QueueType.UNORDERED);
248 public void onPortStatusMessage(PortStatusMessage message) {
249 processPortStatusMsg(message);
250 enqueueMessage(message);
253 protected void processPortStatusMsg(PortStatus msg) {
254 if (msg.getReason().getIntValue() == 2) {
256 } else if (msg.getReason().getIntValue() == 0) {
258 } else if (msg.getReason().getIntValue() == 1) {
263 protected void updatePort(PortStatus msg) {
264 Long portNumber = msg.getPortNo();
265 Boolean portBandwidth = portFeaturesUtils.getPortBandwidth(msg);
267 if(portBandwidth == null) {
268 LOG.debug("can't get bandwidth info from port: {}, aborting port update", msg.toString());
270 this.getSessionContext().getPhysicalPorts().put(portNumber, msg);
271 this.getSessionContext().getPortsBandwidth().put(portNumber, portBandwidth);
275 protected void deletePort(PortGrouping port) {
276 Long portNumber = port.getPortNo();
278 this.getSessionContext().getPhysicalPorts().remove(portNumber);
279 this.getSessionContext().getPortsBandwidth().remove(portNumber);
283 public void onSwitchIdleEvent(SwitchIdleEvent notification) {
284 new Thread(new Runnable() {
287 if (!CONDUCTOR_STATE.WORKING.equals(getConductorState())) {
288 // idle state in any other conductorState than WORKING means real
289 // problem and wont be handled by echoReply, but disconnection
291 OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
293 LOG.debug("first idle state occured, sessionCtx={}|auxId={}", sessionContext, auxiliaryKey);
294 EchoInputBuilder builder = new EchoInputBuilder();
295 builder.setVersion(getVersion());
296 builder.setXid(getSessionContext().getNextXid());
298 Future<RpcResult<EchoOutput>> echoReplyFuture = getConnectionAdapter()
299 .echo(builder.build());
302 RpcResult<EchoOutput> echoReplyValue = echoReplyFuture.get(getMaxTimeout(),
303 getMaxTimeoutUnit());
304 if (echoReplyValue.isSuccessful()) {
305 setConductorState(CONDUCTOR_STATE.WORKING);
307 for (RpcError replyError : echoReplyValue.getErrors()) {
308 Throwable cause = replyError.getCause();
310 "while receiving echoReply in TIMEOUTING state: "
311 + cause.getMessage(), cause);
313 //switch issue occurred
314 throw new Exception("switch issue occurred");
316 } catch (Exception e) {
317 LOG.error("while waiting for echoReply in TIMEOUTING state: "
319 errorHandler.handleException(e, sessionContext);
320 //switch is not responding
322 OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
331 * @param conductorState
332 * the connectionState to set
335 public void setConductorState(CONDUCTOR_STATE conductorState) {
336 this.conductorState = conductorState;
340 public CONDUCTOR_STATE getConductorState() {
341 return conductorState;
345 * @param expectedState
347 protected void checkState(CONDUCTOR_STATE expectedState) {
348 if (!conductorState.equals(expectedState)) {
349 throw new IllegalStateException("Expected state: " + expectedState
350 + ", actual state:" + conductorState);
355 public void onDisconnectEvent(DisconnectEvent arg0) {
356 SessionManager sessionManager = OFSessionUtil.getSessionManager();
357 sessionManager.invalidateOnDisconnect(this);
361 public Short getVersion() {
366 public Future<Boolean> disconnect() {
367 LOG.trace("disconnecting: sessionCtx={}|auxId={}", sessionContext, auxiliaryKey);
369 Future<Boolean> result = null;
370 if (connectionAdapter.isAlive()) {
371 result = connectionAdapter.disconnect();
373 LOG.debug("connection already disconnected");
374 result = Futures.immediateFuture(true);
381 public void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey) {
382 this.auxiliaryKey = auxiliaryKey;
386 public void setSessionContext(SessionContext sessionContext) {
387 this.sessionContext = sessionContext;
391 public SwitchConnectionDistinguisher getAuxiliaryKey() {
396 public SessionContext getSessionContext() {
397 return sessionContext;
401 public ConnectionAdapter getConnectionAdapter() {
402 return connectionAdapter;
406 public void onConnectionReady() {
407 LOG.debug("connection is ready-to-use");
408 if (! firstHelloProcessed) {
409 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
410 null, handshakeManager, connectionAdapter);
411 hsPool.execute(handshakeStepWrapper);
412 firstHelloProcessed = true;
414 LOG.debug("already touched by hello message");
419 public void onHandshakeSuccessfull(GetFeaturesOutput featureOutput,
420 Short negotiatedVersion) {
421 postHandshakeBasic(featureOutput, negotiatedVersion);
423 // post-handshake actions
424 if(version == OFConstants.OFP_VERSION_1_3){
427 requestGroupFeatures();
428 requestMeterFeatures();
429 } else if (version == OFConstants.OFP_VERSION_1_0) {
430 // Because the GetFeaturesOutput contains information about the port
431 // in OF1.0 (that we would otherwise get from the PortDesc) we have to pass
432 // it up for parsing to convert into a NodeConnectorUpdate
433 enqueueMessage(featureOutput);
441 * @param featureOutput
442 * @param negotiatedVersion
444 protected void postHandshakeBasic(GetFeaturesOutput featureOutput,
445 Short negotiatedVersion) {
446 version = negotiatedVersion;
447 conductorState = CONDUCTOR_STATE.WORKING;
448 OFSessionUtil.registerSession(this, featureOutput, negotiatedVersion);
453 private void setDefaultConfig(){
454 SetConfigInputBuilder builder = new SetConfigInputBuilder();
455 builder.setVersion(getVersion());
456 builder.setXid(getSessionContext().getNextXid());
457 SwitchConfigFlag flag = SwitchConfigFlag.FRAGNORMAL;
458 builder.setFlags(flag);
459 builder.setMissSendLen(OFConstants.OFPCML_NO_BUFFER);
460 getConnectionAdapter().setConfig(builder.build());
464 * Send an OFPMP_DESC request message to the switch
466 private void requestDesc() {
467 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
468 builder.setType(MultipartType.OFPMPDESC);
469 builder.setVersion(getVersion());
470 builder.setFlags(new MultipartRequestFlags(false));
471 builder.setMultipartRequestBody(new MultipartRequestDescCaseBuilder().build());
472 builder.setXid(getSessionContext().getNextXid());
473 getConnectionAdapter().multipartRequest(builder.build());
476 private void requestPorts() {
477 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
478 builder.setType(MultipartType.OFPMPPORTDESC);
479 builder.setVersion(getVersion());
480 builder.setFlags(new MultipartRequestFlags(false));
481 builder.setMultipartRequestBody(new MultipartRequestPortDescCaseBuilder().build());
482 builder.setXid(getSessionContext().getNextXid());
483 getConnectionAdapter().multipartRequest(builder.build());
485 private void requestGroupFeatures(){
486 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
487 mprInput.setType(MultipartType.OFPMPGROUPFEATURES);
488 mprInput.setVersion(getVersion());
489 mprInput.setFlags(new MultipartRequestFlags(false));
490 mprInput.setXid(getSessionContext().getNextXid());
492 MultipartRequestGroupFeaturesCaseBuilder mprGroupFeaturesBuild =
493 new MultipartRequestGroupFeaturesCaseBuilder();
494 mprInput.setMultipartRequestBody(mprGroupFeaturesBuild.build());
496 LOG.debug("Send group features statistics request :{}",mprGroupFeaturesBuild);
497 getConnectionAdapter().multipartRequest(mprInput.build());
500 private void requestMeterFeatures(){
501 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
502 mprInput.setType(MultipartType.OFPMPMETERFEATURES);
503 mprInput.setVersion(getVersion());
504 mprInput.setFlags(new MultipartRequestFlags(false));
505 mprInput.setXid(getSessionContext().getNextXid());
507 MultipartRequestMeterFeaturesCaseBuilder mprMeterFeaturesBuild =
508 new MultipartRequestMeterFeaturesCaseBuilder();
509 mprInput.setMultipartRequestBody(mprMeterFeaturesBuild.build());
511 LOG.debug("Send meter features statistics request :{}",mprMeterFeaturesBuild);
512 getConnectionAdapter().multipartRequest(mprInput.build());
516 * @param isBitmapNegotiationEnable the isBitmapNegotiationEnable to set
518 public void setBitmapNegotiationEnable(
519 boolean isBitmapNegotiationEnable) {
520 this.isBitmapNegotiationEnable = isBitmapNegotiationEnable;
523 protected void shutdownPool() {
524 hsPool.shutdownNow();
525 LOG.debug("pool is terminated: {}", hsPool.isTerminated());
529 public void setId(int conductorId) {
530 this.conductorId = conductorId;