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.ExecutorService;
12 import java.util.concurrent.Executors;
13 import java.util.concurrent.Future;
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.core.session.OFSessionUtil;
19 import org.opendaylight.openflowplugin.openflow.md.core.session.PortFeaturesUtil;
20 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
21 import org.opendaylight.openflowplugin.openflow.md.core.session.SessionManager;
22 import org.opendaylight.openflowplugin.openflow.md.queue.QueueKeeper;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoInputBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoOutput;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInputBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Port;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatus;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCaseBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCaseBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCaseBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCaseBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
49 import org.opendaylight.yangtools.yang.binding.DataObject;
50 import org.opendaylight.yangtools.yang.common.RpcError;
51 import org.opendaylight.yangtools.yang.common.RpcResult;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
55 import com.google.common.util.concurrent.Futures;
60 public class ConnectionConductorImpl implements OpenflowProtocolListener,
61 SystemNotificationsListener, ConnectionConductor, ConnectionReadyListener, HandshakeListener {
63 protected static final Logger LOG = LoggerFactory
64 .getLogger(ConnectionConductorImpl.class);
66 /* variable to make BitMap-based negotiation enabled / disabled.
67 * it will help while testing and isolating issues related to processing of
68 * BitMaps from switches.
70 private boolean isBitmapNegotiationEnable = true;
71 protected ErrorHandler errorHandler;
73 private final ConnectionAdapter connectionAdapter;
74 private ConnectionConductor.CONDUCTOR_STATE conductorState;
75 private Short version;
77 private SwitchConnectionDistinguisher auxiliaryKey;
79 private SessionContext sessionContext;
81 private QueueKeeper<OfHeader, DataObject> queueKeeper;
82 private ExecutorService hsPool;
83 private HandshakeManager handshakeManager;
85 private boolean firstHelloProcessed;
87 private PortFeaturesUtil portFeaturesUtils;
90 * @param connectionAdapter
92 public ConnectionConductorImpl(ConnectionAdapter connectionAdapter) {
93 this.connectionAdapter = connectionAdapter;
94 conductorState = CONDUCTOR_STATE.HANDSHAKING;
95 hsPool = Executors.newFixedThreadPool(1);
96 firstHelloProcessed = false;
97 handshakeManager = new HandshakeManagerImpl(connectionAdapter,
98 ConnectionConductor.versionOrder.get(0), ConnectionConductor.versionOrder);
99 handshakeManager.setUseVersionBitmap(isBitmapNegotiationEnable);
100 handshakeManager.setHandshakeListener(this);
101 portFeaturesUtils = PortFeaturesUtil.getInstance();
106 connectionAdapter.setMessageListener(this);
107 connectionAdapter.setSystemListener(this);
108 connectionAdapter.setConnectionReadyListener(this);
112 public void setQueueKeeper(QueueKeeper<OfHeader, DataObject> queueKeeper) {
113 this.queueKeeper = queueKeeper;
117 * @param errorHandler the errorHandler to set
120 public void setErrorHandler(ErrorHandler errorHandler) {
121 this.errorHandler = errorHandler;
122 handshakeManager.setErrorHandler(errorHandler);
126 public void onEchoRequestMessage(final EchoRequestMessage echoRequestMessage) {
127 new Thread(new Runnable() {
130 LOG.debug("echo request received: " + echoRequestMessage.getXid());
131 EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
132 builder.setVersion(echoRequestMessage.getVersion());
133 builder.setXid(echoRequestMessage.getXid());
134 builder.setData(echoRequestMessage.getData());
136 getConnectionAdapter().echoReply(builder.build());
142 public void onErrorMessage(ErrorMessage errorMessage) {
143 queueKeeper.push(errorMessage, this);
147 public void onExperimenterMessage(ExperimenterMessage experimenterMessage) {
148 queueKeeper.push(experimenterMessage, this);
152 public void onFlowRemovedMessage(FlowRemovedMessage message) {
153 queueKeeper.push(message, this);
158 * version negotiation happened as per following steps:
159 * 1. If HelloMessage version field has same version, continue connection processing.
160 * If HelloMessage version is lower than supported versions, just disconnect.
161 * 2. If HelloMessage contains bitmap and common version found in bitmap
162 * then continue connection processing. if no common version found, just disconnect.
163 * 3. If HelloMessage version is not supported, send HelloMessage with lower supported version.
164 * 4. If Hello message received again with not supported version, just disconnect.
166 * TODO: Better to handle handshake into a maintainable innerclass which uses State-Pattern.
169 public synchronized void onHelloMessage(final HelloMessage hello) {
170 LOG.debug("processing HELLO.xid: {}", hello.getXid());
171 firstHelloProcessed = true;
172 checkState(CONDUCTOR_STATE.HANDSHAKING);
173 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
174 hello, handshakeManager, connectionAdapter);
175 hsPool.execute(handshakeStepWrapper);
179 * @return rpc-response timeout in [ms]
181 protected long getMaxTimeout() {
182 // TODO:: get from configuration
187 * @return milliseconds
189 protected TimeUnit getMaxTimeoutUnit() {
190 // TODO:: get from configuration
191 return TimeUnit.MILLISECONDS;
195 public void onMultipartReplyMessage(MultipartReplyMessage message) {
196 queueKeeper.push(message, this);
200 public void onPacketInMessage(PacketInMessage message) {
201 queueKeeper.push(message, this);
205 public void onPortStatusMessage(PortStatusMessage message) {
206 processPortStatusMsg(message);
207 queueKeeper.push(message, this);
210 protected void processPortStatusMsg(PortStatus msg) {
211 if (msg.getReason().getIntValue() == 2) {
213 } else if (msg.getReason().getIntValue() == 0) {
215 } else if (msg.getReason().getIntValue() == 1) {
220 protected void updatePort(PortStatus msg) {
221 Long portNumber = msg.getPortNo();
222 Boolean portBandwidth = portFeaturesUtils.getPortBandwidth(msg);
224 if(portBandwidth == null) {
225 LOG.warn("can't get bandwidth info from port: {}, aborting port update", msg.toString());
227 this.getSessionContext().getPhysicalPorts().put(portNumber, msg);
228 this.getSessionContext().getPortsBandwidth().put(portNumber, portBandwidth);
232 protected void deletePort(Port port) {
233 Long portNumber = port.getPortNo();
235 this.getSessionContext().getPhysicalPorts().remove(portNumber);
236 this.getSessionContext().getPortsBandwidth().remove(portNumber);
240 public void onSwitchIdleEvent(SwitchIdleEvent notification) {
241 new Thread(new Runnable() {
244 if (!CONDUCTOR_STATE.WORKING.equals(getConductorState())) {
245 // idle state in any other conductorState than WORKING means real
246 // problem and wont be handled by echoReply, but disconnection
248 OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
250 LOG.debug("first idle state occured");
251 EchoInputBuilder builder = new EchoInputBuilder();
252 builder.setVersion(getVersion());
253 builder.setXid(getSessionContext().getNextXid());
255 Future<RpcResult<EchoOutput>> echoReplyFuture = getConnectionAdapter()
256 .echo(builder.build());
259 RpcResult<EchoOutput> echoReplyValue = echoReplyFuture.get(getMaxTimeout(),
260 getMaxTimeoutUnit());
261 if (echoReplyValue.isSuccessful()) {
262 setConductorState(CONDUCTOR_STATE.WORKING);
264 for (RpcError replyError : echoReplyValue.getErrors()) {
265 Throwable cause = replyError.getCause();
267 "while receiving echoReply in TIMEOUTING state: "
268 + cause.getMessage(), cause);
270 //switch issue occurred
271 throw new Exception("switch issue occurred");
273 } catch (Exception e) {
274 LOG.error("while waiting for echoReply in TIMEOUTING state: "
276 errorHandler.handleException(e, sessionContext);
277 //switch is not responding
279 OFSessionUtil.getSessionManager().invalidateOnDisconnect(ConnectionConductorImpl.this);
288 * @param conductorState
289 * the connectionState to set
292 public void setConductorState(CONDUCTOR_STATE conductorState) {
293 this.conductorState = conductorState;
297 public CONDUCTOR_STATE getConductorState() {
298 return conductorState;
304 protected void checkState(CONDUCTOR_STATE expectedState) {
305 if (!conductorState.equals(expectedState)) {
306 throw new IllegalStateException("Expected state: " + expectedState
307 + ", actual state:" + conductorState);
312 public void onDisconnectEvent(DisconnectEvent arg0) {
313 SessionManager sessionManager = OFSessionUtil.getSessionManager();
314 sessionManager.invalidateOnDisconnect(this);
318 public Short getVersion() {
323 public Future<Boolean> disconnect() {
324 LOG.info("disconnecting: sessionCtx="+sessionContext+"|auxId="+auxiliaryKey);
326 Future<Boolean> result = null;
327 if (connectionAdapter.isAlive()) {
328 result = connectionAdapter.disconnect();
330 LOG.debug("connection already disconnected");
331 result = Futures.immediateFuture(true);
338 public void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey) {
339 this.auxiliaryKey = auxiliaryKey;
343 public void setSessionContext(SessionContext sessionContext) {
344 this.sessionContext = sessionContext;
348 public SwitchConnectionDistinguisher getAuxiliaryKey() {
353 public SessionContext getSessionContext() {
354 return sessionContext;
358 public ConnectionAdapter getConnectionAdapter() {
359 return connectionAdapter;
363 public synchronized void onConnectionReady() {
364 LOG.debug("connection is ready-to-use");
365 if (! firstHelloProcessed) {
366 HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
367 null, handshakeManager, connectionAdapter);
368 hsPool.execute(handshakeStepWrapper);
369 firstHelloProcessed = true;
371 LOG.debug("already touched by hello message");
376 public void onHandshakeSuccessfull(GetFeaturesOutput featureOutput,
377 Short negotiatedVersion) {
378 version = negotiatedVersion;
379 conductorState = CONDUCTOR_STATE.WORKING;
380 OFSessionUtil.registerSession(this, featureOutput, negotiatedVersion);
383 requestGroupFeatures();
384 requestMeterFeatures();
388 * Send an OFPMP_DESC request message to the switch
391 private void requestDesc() {
392 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
393 builder.setType(MultipartType.OFPMPDESC);
394 builder.setVersion(getVersion());
395 builder.setFlags(new MultipartRequestFlags(false));
396 builder.setMultipartRequestBody(new MultipartRequestDescCaseBuilder().build());
397 builder.setXid(getSessionContext().getNextXid());
398 getConnectionAdapter().multipartRequest(builder.build());
401 private void requestPorts() {
402 MultipartRequestInputBuilder builder = new MultipartRequestInputBuilder();
403 builder.setType(MultipartType.OFPMPPORTDESC);
404 builder.setVersion(getVersion());
405 builder.setFlags(new MultipartRequestFlags(false));
406 builder.setMultipartRequestBody(new MultipartRequestPortDescCaseBuilder().build());
407 builder.setXid(getSessionContext().getNextXid());
408 getConnectionAdapter().multipartRequest(builder.build());
410 private void requestGroupFeatures(){
411 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
412 mprInput.setType(MultipartType.OFPMPGROUPFEATURES);
413 mprInput.setVersion(getVersion());
414 mprInput.setFlags(new MultipartRequestFlags(false));
415 mprInput.setXid(getSessionContext().getNextXid());
417 MultipartRequestGroupFeaturesCaseBuilder mprGroupFeaturesBuild =
418 new MultipartRequestGroupFeaturesCaseBuilder();
419 mprInput.setMultipartRequestBody(mprGroupFeaturesBuild.build());
421 LOG.debug("Send group features statistics request :{}",mprGroupFeaturesBuild);
422 getConnectionAdapter().multipartRequest(mprInput.build());
425 private void requestMeterFeatures(){
426 MultipartRequestInputBuilder mprInput = new MultipartRequestInputBuilder();
427 mprInput.setType(MultipartType.OFPMPMETERFEATURES);
428 mprInput.setVersion(getVersion());
429 mprInput.setFlags(new MultipartRequestFlags(false));
430 mprInput.setXid(getSessionContext().getNextXid());
432 MultipartRequestMeterFeaturesCaseBuilder mprMeterFeaturesBuild =
433 new MultipartRequestMeterFeaturesCaseBuilder();
434 mprInput.setMultipartRequestBody(mprMeterFeaturesBuild.build());
436 LOG.debug("Send meter features statistics request :{}",mprMeterFeaturesBuild);
437 getConnectionAdapter().multipartRequest(mprInput.build());
441 * @param isBitmapNegotiationEnable the isBitmapNegotiationEnable to set
443 public void setBitmapNegotiationEnable(
444 boolean isBitmapNegotiationEnable) {
445 this.isBitmapNegotiationEnable = isBitmapNegotiationEnable;
448 protected void shutdownPool() {
449 hsPool.shutdownNow();
450 LOG.debug("pool is terminated: {}", hsPool.isTerminated());